michael@0: // -*- mode: c++ -*-
michael@0: 
michael@0: // Copyright (c) 2011, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // dump_symbols.h: Read debugging information from an ELF file, and write
michael@0: // it out as a Breakpad symbol file.
michael@0: 
michael@0: #ifndef COMMON_LINUX_DUMP_SYMBOLS_H__
michael@0: #define COMMON_LINUX_DUMP_SYMBOLS_H__
michael@0: 
michael@0: #include <iostream>
michael@0: #include <string>
michael@0: #include <vector>
michael@0: 
michael@0: #include "common/symbol_data.h"
michael@0: #include "common/using_std_string.h"
michael@0: #include "google_breakpad/common/breakpad_types.h"
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: class Module;
michael@0: 
michael@0: // Find all the debugging information in OBJ_FILE, an ELF executable
michael@0: // or shared library, and write it to SYM_STREAM in the Breakpad symbol
michael@0: // file format.
michael@0: // If OBJ_FILE has been stripped but contains a .gnu_debuglink section,
michael@0: // then look for the debug file in DEBUG_DIRS.
michael@0: // SYMBOL_DATA allows limiting the type of symbol data written.
michael@0: bool WriteSymbolFile(const string &obj_file,
michael@0:                      const std::vector<string>& debug_dirs,
michael@0:                      SymbolData symbol_data,
michael@0:                      std::ostream &sym_stream);
michael@0: 
michael@0: // As above, but simply return the debugging information in MODULE
michael@0: // instead of writing it to a stream. The caller owns the resulting
michael@0: // Module object and must delete it when finished.
michael@0: bool ReadSymbolData(const string& obj_file,
michael@0:                     const std::vector<string>& debug_dirs,
michael@0:                     SymbolData symbol_data,
michael@0:                     Module** module);
michael@0: 
michael@0: // Same as ReadSymbolData, except don't try to open the file; instead
michael@0: // just use the in-memory data (mapped image of it) located at OBJ_FILE.
michael@0: bool ReadSymbolDataInternal(const uint8_t* obj_file,
michael@0:                             const string& obj_filename,
michael@0:                             const std::vector<string>& debug_dirs,
michael@0:                             SymbolData symbol_data,
michael@0:                             Module** module);
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: #endif  // COMMON_LINUX_DUMP_SYMBOLS_H__