|
1 // -*- mode: c++ -*- |
|
2 |
|
3 // Copyright (c) 2011, Google Inc. |
|
4 // All rights reserved. |
|
5 // |
|
6 // Redistribution and use in source and binary forms, with or without |
|
7 // modification, are permitted provided that the following conditions are |
|
8 // met: |
|
9 // |
|
10 // * Redistributions of source code must retain the above copyright |
|
11 // notice, this list of conditions and the following disclaimer. |
|
12 // * Redistributions in binary form must reproduce the above |
|
13 // copyright notice, this list of conditions and the following disclaimer |
|
14 // in the documentation and/or other materials provided with the |
|
15 // distribution. |
|
16 // * Neither the name of Google Inc. nor the names of its |
|
17 // contributors may be used to endorse or promote products derived from |
|
18 // this software without specific prior written permission. |
|
19 // |
|
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
31 |
|
32 // dump_symbols.h: Read debugging information from an ELF file, and write |
|
33 // it out as a Breakpad symbol file. |
|
34 |
|
35 #ifndef COMMON_LINUX_DUMP_SYMBOLS_H__ |
|
36 #define COMMON_LINUX_DUMP_SYMBOLS_H__ |
|
37 |
|
38 #include <iostream> |
|
39 #include <string> |
|
40 #include <vector> |
|
41 |
|
42 #include "common/symbol_data.h" |
|
43 #include "common/using_std_string.h" |
|
44 #include "google_breakpad/common/breakpad_types.h" |
|
45 |
|
46 namespace google_breakpad { |
|
47 |
|
48 class Module; |
|
49 |
|
50 // Find all the debugging information in OBJ_FILE, an ELF executable |
|
51 // or shared library, and write it to SYM_STREAM in the Breakpad symbol |
|
52 // file format. |
|
53 // If OBJ_FILE has been stripped but contains a .gnu_debuglink section, |
|
54 // then look for the debug file in DEBUG_DIRS. |
|
55 // SYMBOL_DATA allows limiting the type of symbol data written. |
|
56 bool WriteSymbolFile(const string &obj_file, |
|
57 const std::vector<string>& debug_dirs, |
|
58 SymbolData symbol_data, |
|
59 std::ostream &sym_stream); |
|
60 |
|
61 // As above, but simply return the debugging information in MODULE |
|
62 // instead of writing it to a stream. The caller owns the resulting |
|
63 // Module object and must delete it when finished. |
|
64 bool ReadSymbolData(const string& obj_file, |
|
65 const std::vector<string>& debug_dirs, |
|
66 SymbolData symbol_data, |
|
67 Module** module); |
|
68 |
|
69 // Same as ReadSymbolData, except don't try to open the file; instead |
|
70 // just use the in-memory data (mapped image of it) located at OBJ_FILE. |
|
71 bool ReadSymbolDataInternal(const uint8_t* obj_file, |
|
72 const string& obj_filename, |
|
73 const std::vector<string>& debug_dirs, |
|
74 SymbolData symbol_data, |
|
75 Module** module); |
|
76 |
|
77 } // namespace google_breakpad |
|
78 |
|
79 #endif // COMMON_LINUX_DUMP_SYMBOLS_H__ |