Check-in stack_frame_symbolizer.[h|cc] that were missing in r1068.

http://breakpad.appspot.com/484002/


git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@1069 4c0a9323-5329-0410-9bdc-e9ce6186880e
This commit is contained in:
SiyangXie@gmail.com 2012-10-11 17:58:37 +00:00
parent bab770045b
commit ff8cad8ae6
2 changed files with 233 additions and 0 deletions
src
google_breakpad/processor
processor

View File

@ -0,0 +1,105 @@
// -*- mode: C++ -*-
// Copyright (c) 2012 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// Helper class that encapsulates the logic of how symbol supplier interacts
// with source line resolver to fill stack frame information.
#ifndef GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__
#define GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__
#include <set>
#include <string>
#include "common/using_std_string.h"
#include "google_breakpad/common/breakpad_types.h"
#include "google_breakpad/processor/code_module.h"
namespace google_breakpad {
class CFIFrameInfo;
class CodeModules;
class SymbolSupplier;
class SourceLineResolverInterface;
struct StackFrame;
struct SystemInfo;
struct WindowsFrameInfo;
class StackFrameSymbolizer {
public:
enum SymbolizerResult {
// Symbol data was found and successfully loaded in resolver.
// This does NOT guarantee source line info is found within symbol file.
NO_ERROR,
// This indicates non-critical error, such as, no code module found for
// frame's instruction, no symbol file, or resolver failed to load symbol.
ERROR,
// This indicates error for which stack walk should be interrupted
// and retried in future.
INTERRUPT,
};
StackFrameSymbolizer(SymbolSupplier* supplier,
SourceLineResolverInterface* resolver);
virtual ~StackFrameSymbolizer() { }
// Encapsulate the step of resolving source line info for a stack frame.
// "frame" must not be NULL.
virtual SymbolizerResult FillSourceLineInfo(const CodeModules* modules,
const SystemInfo* system_info,
StackFrame* stack_frame);
virtual WindowsFrameInfo* FindWindowsFrameInfo(const StackFrame* frame);
virtual CFIFrameInfo* FindCFIFrameInfo(const StackFrame* frame);
// Reset internal (locally owned) data as if the helper is re-instantiated.
// A typical case is to call Reset() after processing an individual report
// before start to process next one, in order to reset internal information
// about missing symbols found so far.
virtual void Reset() { no_symbol_modules_.clear(); }
// Returns true if there is valid implementation for stack symbolization.
virtual bool HasImplementation() { return resolver_ && supplier_; }
SourceLineResolverInterface* resolver() { return resolver_; }
SymbolSupplier* supplier() { return supplier_; }
protected:
SymbolSupplier* supplier_;
SourceLineResolverInterface* resolver_;
// A list of modules known to have symbols missing. This helps avoid
// repeated lookups for the missing symbols within one minidump.
std::set<string> no_symbol_modules_;
};
} // namespace google_breakpad
#endif // GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__

View File

@ -0,0 +1,128 @@
// Copyright (c) 2012 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// Implementation of StackFrameSymbolizer, which encapsulates the logic of how
// SourceLineResolverInterface interacts with SymbolSupplier to fill source
// line information in a stack frame, and also looks up WindowsFrameInfo or
// CFIFrameInfo for a stack frame.
#include "google_breakpad/processor/stack_frame_symbolizer.h"
#include <assert.h>
#include "google_breakpad/processor/code_module.h"
#include "google_breakpad/processor/code_modules.h"
#include "google_breakpad/processor/source_line_resolver_interface.h"
#include "google_breakpad/processor/stack_frame.h"
#include "google_breakpad/processor/symbol_supplier.h"
#include "google_breakpad/processor/system_info.h"
#include "processor/linked_ptr.h"
#include "processor/logging.h"
#include "processor/scoped_ptr.h"
namespace google_breakpad {
StackFrameSymbolizer::StackFrameSymbolizer(
SymbolSupplier* supplier,
SourceLineResolverInterface* resolver) : supplier_(supplier),
resolver_(resolver) { }
StackFrameSymbolizer::SymbolizerResult StackFrameSymbolizer::FillSourceLineInfo(
const CodeModules* modules,
const SystemInfo* system_info,
StackFrame* frame) {
assert(frame);
if (!modules) return ERROR;
const CodeModule* module = modules->GetModuleForAddress(frame->instruction);
if (!module) return ERROR;
frame->module = module;
if (!resolver_) return ERROR; // no resolver.
// If module is known to have missing symbol file, return.
if (no_symbol_modules_.find(module->code_file()) !=
no_symbol_modules_.end()) {
return ERROR;
}
// If module is already loaded, go ahead to fill source line info and return.
if (resolver_->HasModule(frame->module)) {
resolver_->FillSourceLineInfo(frame);
return NO_ERROR;
}
// Module needs to fetch symbol file. First check to see if supplier exists.
if (!supplier_) {
return ERROR;
}
// Start fetching symbol from supplier.
string symbol_file;
char* symbol_data = NULL;
SymbolSupplier::SymbolResult symbol_result = supplier_->GetCStringSymbolData(
module, system_info, &symbol_file, &symbol_data);
switch (symbol_result) {
case SymbolSupplier::FOUND: {
bool load_success = resolver_->LoadModuleUsingMemoryBuffer(frame->module,
symbol_data);
if (resolver_->ShouldDeleteMemoryBufferAfterLoadModule()) {
supplier_->FreeSymbolData(module);
}
if (load_success) {
resolver_->FillSourceLineInfo(frame);
return NO_ERROR;
} else {
BPLOG(ERROR) << "Failed to load symbol file in resolver.";
no_symbol_modules_.insert(module->code_file());
return ERROR;
}
}
case SymbolSupplier::NOT_FOUND:
no_symbol_modules_.insert(module->code_file());
return ERROR;
case SymbolSupplier::INTERRUPT:
return INTERRUPT;
}
}
WindowsFrameInfo* StackFrameSymbolizer::FindWindowsFrameInfo(
const StackFrame* frame) {
return resolver_ ? resolver_->FindWindowsFrameInfo(frame) : NULL;
}
CFIFrameInfo* StackFrameSymbolizer::FindCFIFrameInfo(
const StackFrame* frame) {
return resolver_ ? resolver_->FindCFIFrameInfo(frame) : NULL;
}
} // namespace google_breakpad