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
45namespace google_breakpad {
46
47class Module;
48
49struct DumpOptions {
50 DumpOptions(SymbolData symbol_data, bool handle_inter_cu_refs)
51 : symbol_data(symbol_data),
52 handle_inter_cu_refs(handle_inter_cu_refs) {
53 }
54
55 SymbolData symbol_data;
56 bool handle_inter_cu_refs;
57};
58
59// Find all the debugging information in OBJ_FILE, an ELF executable
60// or shared library, and write it to SYM_STREAM in the Breakpad symbol
61// file format.
62// If OBJ_FILE has been stripped but contains a .gnu_debuglink section,
63// then look for the debug file in DEBUG_DIRS.
64// SYMBOL_DATA allows limiting the type of symbol data written.
65bool WriteSymbolFile(const string& load_path,
66 const string& obj_file,
67 const string& obj_os,
68 const std::vector<string>& debug_dirs,
69 const DumpOptions& options,
70 std::ostream& sym_stream);
71
72// Read the selected object file's debugging information, and write out the
73// header only to |stream|. Return true on success; if an error occurs, report
74// it and return false. |obj_file| becomes the MODULE file name and |obj_os|
75// becomes the MODULE operating system.
76bool WriteSymbolFileHeader(const string& load_path,
77 const string& obj_file,
78 const string& obj_os,
79 std::ostream& sym_stream);
80
81// As above, but simply return the debugging information in MODULE
82// instead of writing it to a stream. The caller owns the resulting
83// Module object and must delete it when finished.
84bool ReadSymbolData(const string& load_path,
85 const string& obj_file,
86 const string& obj_os,
87 const std::vector<string>& debug_dirs,
88 const DumpOptions& options,
89 Module** module);
90
91} // namespace google_breakpad
92
93#endif // COMMON_LINUX_DUMP_SYMBOLS_H__
94