Tue, 17 Jan 2012 13:08:52 -0500
7071311: Decoder enhancement
Summary: Made decoder thread-safe
Reviewed-by: coleenp, kamg
1 /*
2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #ifndef SHARE_VM_UTILITIES_ELF_FILE_HPP
26 #define SHARE_VM_UTILITIES_ELF_FILE_HPP
28 #if !defined(_WINDOWS) && !defined(__APPLE__)
30 #if defined(__OpenBSD__)
31 #include <sys/exec_elf.h>
32 #else
33 #include <elf.h>
34 #endif
35 #include <stdio.h>
37 #ifdef _LP64
39 typedef Elf64_Half Elf_Half;
40 typedef Elf64_Word Elf_Word;
41 typedef Elf64_Off Elf_Off;
42 typedef Elf64_Addr Elf_Addr;
44 typedef Elf64_Ehdr Elf_Ehdr;
45 typedef Elf64_Shdr Elf_Shdr;
46 typedef Elf64_Sym Elf_Sym;
48 #if !defined(_ALLBSD_SOURCE) || defined(__APPLE__)
49 #define ELF_ST_TYPE ELF64_ST_TYPE
50 #endif
52 #else
54 typedef Elf32_Half Elf_Half;
55 typedef Elf32_Word Elf_Word;
56 typedef Elf32_Off Elf_Off;
57 typedef Elf32_Addr Elf_Addr;
60 typedef Elf32_Ehdr Elf_Ehdr;
61 typedef Elf32_Shdr Elf_Shdr;
62 typedef Elf32_Sym Elf_Sym;
64 #if !defined(_ALLBSD_SOURCE) || defined(__APPLE__)
65 #define ELF_ST_TYPE ELF32_ST_TYPE
66 #endif
67 #endif
69 #include "globalDefinitions.hpp"
70 #include "memory/allocation.hpp"
71 #include "utilities/decoder.hpp"
74 class ElfStringTable;
75 class ElfSymbolTable;
78 // On Solaris/Linux platforms, libjvm.so does contain all private symbols.
79 // ElfFile is basically an elf file parser, which can lookup the symbol
80 // that is the nearest to the given address.
81 // Beware, this code is called from vm error reporting code, when vm is already
82 // in "error" state, so there are scenarios, lookup will fail. We want this
83 // part of code to be very defensive, and bait out if anything went wrong.
85 class ElfFile: public CHeapObj {
86 friend class ElfDecoder;
87 public:
88 ElfFile(const char* filepath);
89 ~ElfFile();
91 bool decode(address addr, char* buf, int buflen, int* offset);
92 const char* filepath() {
93 return m_filepath;
94 }
96 bool same_elf_file(const char* filepath) {
97 assert(filepath, "null file path");
98 assert(m_filepath, "already out of memory");
99 return (m_filepath && !strcmp(filepath, m_filepath));
100 }
102 NullDecoder::decoder_status get_status() {
103 return m_status;
104 }
106 private:
107 // sanity check, if the file is a real elf file
108 bool is_elf_file(Elf_Ehdr&);
110 // load string tables from the elf file
111 bool load_tables();
113 // string tables are stored in a linked list
114 void add_string_table(ElfStringTable* table);
116 // symbol tables are stored in a linked list
117 void add_symbol_table(ElfSymbolTable* table);
119 // return a string table at specified section index
120 ElfStringTable* get_string_table(int index);
122 protected:
123 ElfFile* next() const { return m_next; }
124 void set_next(ElfFile* file) { m_next = file; }
126 protected:
127 ElfFile* m_next;
129 private:
130 // file
131 const char* m_filepath;
132 FILE* m_file;
134 // Elf header
135 Elf_Ehdr m_elfHdr;
137 // symbol tables
138 ElfSymbolTable* m_symbol_tables;
140 // string tables
141 ElfStringTable* m_string_tables;
143 NullDecoder::decoder_status m_status;
144 };
146 #endif // _WINDOWS
148 #endif // SHARE_VM_UTILITIES_ELF_FILE_HPP