stackwalker_x86.h revision 8d70618ffc6f87bfd3d7bfd05c87c35ec3179a7a 
1// Copyright (c) 2006, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// stackwalker_x86.h: x86-specific stackwalker.
31//
32// Provides stack frames given x86 register context and a memory region
33// corresponding to an x86 stack.
34//
35// Author: Mark Mentovai
36
37
38#ifndef PROCESSOR_STACKWALKER_X86_H__
39#define PROCESSOR_STACKWALKER_X86_H__
40
41
42#include "google_breakpad/common/breakpad_types.h"
43#include "google_breakpad/common/minidump_format.h"
44#include "google_breakpad/processor/stackwalker.h"
45
46namespace google_breakpad {
47
48class CodeModules;
49
50
51class StackwalkerX86 : public Stackwalker {
52 public:
53  // context is an x86 context object that gives access to x86-specific
54  // register state corresponding to the innermost called frame to be
55  // included in the stack.  The other arguments are passed directly through
56  // to the base Stackwalker constructor.
57  StackwalkerX86(const SystemInfo *system_info,
58                 const MDRawContextX86 *context,
59                 MemoryRegion *memory,
60                 const CodeModules *modules,
61                 SymbolSupplier *supplier,
62                 SourceLineResolverInterface *resolver);
63
64 private:
65  // Implementation of Stackwalker, using x86 context (%ebp, %esp, %eip) and
66  // stack conventions (saved %ebp at [%ebp], saved %eip at 4[%ebp], or
67  // alternate conventions as guided by stack_frame_info_).
68  virtual StackFrame* GetContextFrame();
69  virtual StackFrame* GetCallerFrame(
70      const CallStack *stack,
71      const vector< linked_ptr<StackFrameInfo> > &stack_frame_info);
72
73  // Scan the stack starting at location_start, looking for an address
74  // that looks like a valid instruction pointer. Addresses must
75  // 1) be contained in the current stack memory
76  // 2) pass the checks in Stackwalker::InstructionAddressSeemsValid
77  //
78  // Returns true if a valid-looking instruction pointer was found.
79  // When returning true, sets location_found to the address at which
80  // the value was found, and eip_found to the value contained at that
81  // location in memory.
82  bool ScanForReturnAddress(u_int32_t location_start,
83                            u_int32_t &location_found,
84                            u_int32_t &eip_found);
85
86  // Stores the CPU context corresponding to the innermost stack frame to
87  // be returned by GetContextFrame.
88  const MDRawContextX86 *context_;
89};
90
91
92}  // namespace google_breakpad
93
94
95#endif  // PROCESSOR_STACKWALKER_X86_H__
96