stack_frame_symbolizer.cc revision bc76f34e15569a891c2f3e43435d7837813c0be9
15449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Copyright (c) 2012 Google Inc. 25449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// All rights reserved. 35449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 45449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Redistribution and use in source and binary forms, with or without 55449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// modification, are permitted provided that the following conditions are 65449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// met: 75449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 85449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Redistributions of source code must retain the above copyright 95449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// notice, this list of conditions and the following disclaimer. 105449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Redistributions in binary form must reproduce the above 115449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// copyright notice, this list of conditions and the following disclaimer 125449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// in the documentation and/or other materials provided with the 135449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// distribution. 145449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Neither the name of Google Inc. nor the names of its 155449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// contributors may be used to endorse or promote products derived from 165449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// this software without specific prior written permission. 175449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 185449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 305449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Implementation of StackFrameSymbolizer, which encapsulates the logic of how 315449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// SourceLineResolverInterface interacts with SymbolSupplier to fill source 325449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// line information in a stack frame, and also looks up WindowsFrameInfo or 335449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// CFIFrameInfo for a stack frame. 345449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 355449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/stack_frame_symbolizer.h" 365449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 375449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include <assert.h> 385449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 395449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/code_module.h" 405449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/code_modules.h" 415449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/source_line_resolver_interface.h" 425449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/stack_frame.h" 435449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/symbol_supplier.h" 445449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/system_info.h" 455449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "processor/linked_ptr.h" 465449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "processor/logging.h" 475449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "processor/scoped_ptr.h" 485449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 495449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comnamespace google_breakpad { 505449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 515449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comStackFrameSymbolizer::StackFrameSymbolizer( 525449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SymbolSupplier* supplier, 535449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SourceLineResolverInterface* resolver) : supplier_(supplier), 545449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com resolver_(resolver) { } 555449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 565449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comStackFrameSymbolizer::SymbolizerResult StackFrameSymbolizer::FillSourceLineInfo( 575449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const CodeModules* modules, 585449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const SystemInfo* system_info, 595449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com StackFrame* frame) { 605449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com assert(frame); 615449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 625449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (!modules) return ERROR; 635449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const CodeModule* module = modules->GetModuleForAddress(frame->instruction); 645449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (!module) return ERROR; 655449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com frame->module = module; 665449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 675449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (!resolver_) return ERROR; // no resolver. 685449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // If module is known to have missing symbol file, return. 695449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (no_symbol_modules_.find(module->code_file()) != 705449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com no_symbol_modules_.end()) { 715449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return ERROR; 725449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 735449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 745449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // If module is already loaded, go ahead to fill source line info and return. 755449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (resolver_->HasModule(frame->module)) { 765449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com resolver_->FillSourceLineInfo(frame); 775449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return NO_ERROR; 785449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 795449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 805449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Module needs to fetch symbol file. First check to see if supplier exists. 815449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (!supplier_) { 825449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return ERROR; 835449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 845449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 855449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Start fetching symbol from supplier. 865449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com string symbol_file; 875449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com char* symbol_data = NULL; 885449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SymbolSupplier::SymbolResult symbol_result = supplier_->GetCStringSymbolData( 895449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com module, system_info, &symbol_file, &symbol_data); 905449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 915449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com switch (symbol_result) { 925449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com case SymbolSupplier::FOUND: { 935449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com bool load_success = resolver_->LoadModuleUsingMemoryBuffer(frame->module, 945449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com symbol_data); 955449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (resolver_->ShouldDeleteMemoryBufferAfterLoadModule()) { 965449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com supplier_->FreeSymbolData(module); 975449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 985449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 995449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com if (load_success) { 1005449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com resolver_->FillSourceLineInfo(frame); 1015449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return NO_ERROR; 1025449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } else { 1035449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com BPLOG(ERROR) << "Failed to load symbol file in resolver."; 1045449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com no_symbol_modules_.insert(module->code_file()); 1055449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return ERROR; 1065449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 1075449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 1085449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1095449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com case SymbolSupplier::NOT_FOUND: 1105449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com no_symbol_modules_.insert(module->code_file()); 1115449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return ERROR; 1125449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1135449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com case SymbolSupplier::INTERRUPT: 1145449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return INTERRUPT; 115bc76f34e15569a891c2f3e43435d7837813c0be9SiyangXie@gmail.com 116bc76f34e15569a891c2f3e43435d7837813c0be9SiyangXie@gmail.com default: 117bc76f34e15569a891c2f3e43435d7837813c0be9SiyangXie@gmail.com BPLOG(ERROR) << "Unknown SymbolResult enum: " << symbol_result; 118bc76f34e15569a891c2f3e43435d7837813c0be9SiyangXie@gmail.com return ERROR; 1195449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com } 1205449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com} 1215449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1225449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comWindowsFrameInfo* StackFrameSymbolizer::FindWindowsFrameInfo( 1235449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const StackFrame* frame) { 1245449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return resolver_ ? resolver_->FindWindowsFrameInfo(frame) : NULL; 1255449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com} 1265449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1275449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comCFIFrameInfo* StackFrameSymbolizer::FindCFIFrameInfo( 1285449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const StackFrame* frame) { 1295449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com return resolver_ ? resolver_->FindCFIFrameInfo(frame) : NULL; 1305449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com} 1315449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1325449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com} // namespace google_breakpad 133