15449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// -*- mode: C++ -*- 25449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 35449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Copyright (c) 2012 Google Inc. 45449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// All rights reserved. 55449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 65449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Redistribution and use in source and binary forms, with or without 75449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// modification, are permitted provided that the following conditions are 85449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// met: 95449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 105449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Redistributions of source code must retain the above copyright 115449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// notice, this list of conditions and the following disclaimer. 125449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Redistributions in binary form must reproduce the above 135449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// copyright notice, this list of conditions and the following disclaimer 145449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// in the documentation and/or other materials provided with the 155449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// distribution. 165449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// * Neither the name of Google Inc. nor the names of its 175449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// contributors may be used to endorse or promote products derived from 185449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// this software without specific prior written permission. 195449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// 205449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 215449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 225449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 235449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 245449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 255449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 265449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 275449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 285449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 295449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 305449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 315449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 325449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// Helper class that encapsulates the logic of how symbol supplier interacts 335449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com// with source line resolver to fill stack frame information. 345449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 355449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#ifndef GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__ 365449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#define GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__ 375449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 385449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include <set> 395449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include <string> 405449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 415449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "common/using_std_string.h" 425449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/common/breakpad_types.h" 435449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#include "google_breakpad/processor/code_module.h" 445449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 455449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comnamespace google_breakpad { 465449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comclass CFIFrameInfo; 475449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comclass CodeModules; 485449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comclass SymbolSupplier; 495449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comclass SourceLineResolverInterface; 505449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comstruct StackFrame; 515449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comstruct SystemInfo; 525449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comstruct WindowsFrameInfo; 535449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 545449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.comclass StackFrameSymbolizer { 555449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com public: 565449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com enum SymbolizerResult { 575449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Symbol data was found and successfully loaded in resolver. 585449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // This does NOT guarantee source line info is found within symbol file. 59df4ee8ca5e8dbd4051883967191e0015b0f5d951ted.mielczarek@gmail.com kNoError, 605449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // This indicates non-critical error, such as, no code module found for 615449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // frame's instruction, no symbol file, or resolver failed to load symbol. 62df4ee8ca5e8dbd4051883967191e0015b0f5d951ted.mielczarek@gmail.com kError, 635449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // This indicates error for which stack walk should be interrupted 645449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // and retried in future. 652d460c37d16a99fd4bcdac045298e87b6b5735b0ivan.penkov@gmail.com kInterrupt, 662d460c37d16a99fd4bcdac045298e87b6b5735b0ivan.penkov@gmail.com // Symbol data was found and loaded in resolver however some corruptions 672d460c37d16a99fd4bcdac045298e87b6b5735b0ivan.penkov@gmail.com // were detected. 682d460c37d16a99fd4bcdac045298e87b6b5735b0ivan.penkov@gmail.com kWarningCorruptSymbols, 695449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com }; 705449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 715449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com StackFrameSymbolizer(SymbolSupplier* supplier, 725449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SourceLineResolverInterface* resolver); 735449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 745449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual ~StackFrameSymbolizer() { } 755449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 765449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Encapsulate the step of resolving source line info for a stack frame. 775449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // "frame" must not be NULL. 785449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual SymbolizerResult FillSourceLineInfo(const CodeModules* modules, 795449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com const SystemInfo* system_info, 805449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com StackFrame* stack_frame); 815449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 825449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual WindowsFrameInfo* FindWindowsFrameInfo(const StackFrame* frame); 835449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 845449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual CFIFrameInfo* FindCFIFrameInfo(const StackFrame* frame); 855449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 865449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Reset internal (locally owned) data as if the helper is re-instantiated. 875449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // A typical case is to call Reset() after processing an individual report 885449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // before start to process next one, in order to reset internal information 895449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // about missing symbols found so far. 905449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual void Reset() { no_symbol_modules_.clear(); } 915449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 925449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // Returns true if there is valid implementation for stack symbolization. 935449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com virtual bool HasImplementation() { return resolver_ && supplier_; } 945449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 955449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SourceLineResolverInterface* resolver() { return resolver_; } 965449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SymbolSupplier* supplier() { return supplier_; } 975449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 985449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com protected: 995449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SymbolSupplier* supplier_; 1005449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com SourceLineResolverInterface* resolver_; 1015449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // A list of modules known to have symbols missing. This helps avoid 1025449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com // repeated lookups for the missing symbols within one minidump. 1035449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com std::set<string> no_symbol_modules_; 1045449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com}; 1055449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1065449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com} // namespace google_breakpad 1075449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com 1085449f746be3dc8578934a859a6a51a555fd88b49SiyangXie@gmail.com#endif // GOOGLE_BREAKPAD_PROCESSOR_STACK_FRAME_SYMBOLIZER_H__ 109