toolkit/crashreporter/google-breakpad/src/processor/stackwalker_x86.h@b8a032363ba2 (annotated)
toolkit/crashreporter/google-breakpad/src/processor/stackwalker_x86.h
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | // -*- mode: c++ -*- |
| michael@0 | 2 | |
| michael@0 | 3 | // Copyright (c) 2010 Google Inc. |
| michael@0 | 4 | // All rights reserved. |
| michael@0 | 5 | // |
| michael@0 | 6 | // Redistribution and use in source and binary forms, with or without |
| michael@0 | 7 | // modification, are permitted provided that the following conditions are |
| michael@0 | 8 | // met: |
| michael@0 | 9 | // |
| michael@0 | 10 | // * Redistributions of source code must retain the above copyright |
| michael@0 | 11 | // notice, this list of conditions and the following disclaimer. |
| michael@0 | 12 | // * Redistributions in binary form must reproduce the above |
| michael@0 | 13 | // copyright notice, this list of conditions and the following disclaimer |
| michael@0 | 14 | // in the documentation and/or other materials provided with the |
| michael@0 | 15 | // distribution. |
| michael@0 | 16 | // * Neither the name of Google Inc. nor the names of its |
| michael@0 | 17 | // contributors may be used to endorse or promote products derived from |
| michael@0 | 18 | // this software without specific prior written permission. |
| michael@0 | 19 | // |
| michael@0 | 20 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| michael@0 | 24 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 25 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@0 | 26 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| michael@0 | 27 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| michael@0 | 28 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| michael@0 | 29 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| michael@0 | 30 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | |
| michael@0 | 32 | // stackwalker_x86.h: x86-specific stackwalker. |
| michael@0 | 33 | // |
| michael@0 | 34 | // Provides stack frames given x86 register context and a memory region |
| michael@0 | 35 | // corresponding to an x86 stack. |
| michael@0 | 36 | // |
| michael@0 | 37 | // Author: Mark Mentovai |
| michael@0 | 38 | |
| michael@0 | 39 | |
| michael@0 | 40 | #ifndef PROCESSOR_STACKWALKER_X86_H__ |
| michael@0 | 41 | #define PROCESSOR_STACKWALKER_X86_H__ |
| michael@0 | 42 | |
| michael@0 | 43 | #include <vector> |
| michael@0 | 44 | |
| michael@0 | 45 | #include "google_breakpad/common/breakpad_types.h" |
| michael@0 | 46 | #include "google_breakpad/common/minidump_format.h" |
| michael@0 | 47 | #include "google_breakpad/processor/stackwalker.h" |
| michael@0 | 48 | #include "google_breakpad/processor/stack_frame_cpu.h" |
| michael@0 | 49 | #include "processor/cfi_frame_info.h" |
| michael@0 | 50 | |
| michael@0 | 51 | namespace google_breakpad { |
| michael@0 | 52 | |
| michael@0 | 53 | class CodeModules; |
| michael@0 | 54 | |
| michael@0 | 55 | |
| michael@0 | 56 | class StackwalkerX86 : public Stackwalker { |
| michael@0 | 57 | public: |
| michael@0 | 58 | // context is an x86 context object that gives access to x86-specific |
| michael@0 | 59 | // register state corresponding to the innermost called frame to be |
| michael@0 | 60 | // included in the stack. The other arguments are passed directly through |
| michael@0 | 61 | // to the base Stackwalker constructor. |
| michael@0 | 62 | StackwalkerX86(const SystemInfo* system_info, |
| michael@0 | 63 | const MDRawContextX86* context, |
| michael@0 | 64 | MemoryRegion* memory, |
| michael@0 | 65 | const CodeModules* modules, |
| michael@0 | 66 | StackFrameSymbolizer* frame_symbolizer); |
| michael@0 | 67 | |
| michael@0 | 68 | private: |
| michael@0 | 69 | // A STACK CFI-driven frame walker for the X86. |
| michael@0 | 70 | typedef SimpleCFIWalker<uint32_t, MDRawContextX86> CFIWalker; |
| michael@0 | 71 | |
| michael@0 | 72 | // Implementation of Stackwalker, using x86 context (%ebp, %esp, %eip) and |
| michael@0 | 73 | // stack conventions (saved %ebp at [%ebp], saved %eip at 4[%ebp], or |
| michael@0 | 74 | // alternate conventions as guided by any WindowsFrameInfo available for the |
| michael@0 | 75 | // code in question.). |
| michael@0 | 76 | virtual StackFrame* GetContextFrame(); |
| michael@0 | 77 | virtual StackFrame* GetCallerFrame(const CallStack* stack, |
| michael@0 | 78 | bool stack_scan_allowed); |
| michael@0 | 79 | |
| michael@0 | 80 | // Use windows_frame_info (derived from STACK WIN and FUNC records) |
| michael@0 | 81 | // to construct the frame that called frames.back(). The caller |
| michael@0 | 82 | // takes ownership of the returned frame. Return NULL on failure. |
| michael@0 | 83 | StackFrameX86* GetCallerByWindowsFrameInfo( |
| michael@0 | 84 | const vector<StackFrame*> &frames, |
| michael@0 | 85 | WindowsFrameInfo* windows_frame_info, |
| michael@0 | 86 | bool stack_scan_allowed); |
| michael@0 | 87 | |
| michael@0 | 88 | // Use cfi_frame_info (derived from STACK CFI records) to construct |
| michael@0 | 89 | // the frame that called frames.back(). The caller takes ownership |
| michael@0 | 90 | // of the returned frame. Return NULL on failure. |
| michael@0 | 91 | StackFrameX86* GetCallerByCFIFrameInfo(const vector<StackFrame*> &frames, |
| michael@0 | 92 | CFIFrameInfo* cfi_frame_info); |
| michael@0 | 93 | |
| michael@0 | 94 | // Assuming a traditional frame layout --- where the caller's %ebp |
| michael@0 | 95 | // has been pushed just after the return address and the callee's |
| michael@0 | 96 | // %ebp points to the saved %ebp --- construct the frame that called |
| michael@0 | 97 | // frames.back(). The caller takes ownership of the returned frame. |
| michael@0 | 98 | // Return NULL on failure. |
| michael@0 | 99 | StackFrameX86* GetCallerByEBPAtBase(const vector<StackFrame*> &frames, |
| michael@0 | 100 | bool stack_scan_allowed); |
| michael@0 | 101 | |
| michael@0 | 102 | // Stores the CPU context corresponding to the innermost stack frame to |
| michael@0 | 103 | // be returned by GetContextFrame. |
| michael@0 | 104 | const MDRawContextX86* context_; |
| michael@0 | 105 | |
| michael@0 | 106 | // Our register map, for cfi_walker_. |
| michael@0 | 107 | static const CFIWalker::RegisterSet cfi_register_map_[]; |
| michael@0 | 108 | |
| michael@0 | 109 | // Our CFI frame walker. |
| michael@0 | 110 | const CFIWalker cfi_walker_; |
| michael@0 | 111 | }; |
| michael@0 | 112 | |
| michael@0 | 113 | |
| michael@0 | 114 | } // namespace google_breakpad |
| michael@0 | 115 | |
| michael@0 | 116 | |
| michael@0 | 117 | #endif // PROCESSOR_STACKWALKER_X86_H__ |
