stackwalker_amd64.h

Enable keyboard shortcuts

// Copyright (c) 2010 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.

// stackwalker_amd64.h: amd64-specific stackwalker.

//

// Provides stack frames given amd64 register context and a memory region

// corresponding to a amd64 stack.

//

// Author: Mark Mentovai, Ted Mielczarek

#ifndef PROCESSOR_STACKWALKER_AMD64_H__

#define PROCESSOR_STACKWALKER_AMD64_H__

#include <vector>

#include "google_breakpad/common/breakpad_types.h"

#include "google_breakpad/common/minidump_format.h"

#include "google_breakpad/processor/stackwalker.h"

#include "google_breakpad/processor/stack_frame_cpu.h"

#include "processor/cfi_frame_info.h"

namespace google_breakpad {

class CodeModules;

class StackwalkerAMD64 : public Stackwalker {

 public:

  // context is a amd64 context object that gives access to amd64-specific

  // register state corresponding to the innermost called frame to be

  // included in the stack.  The other arguments are passed directly through

  // to the base Stackwalker constructor.

  StackwalkerAMD64(const SystemInfo* system_info,

                   const MDRawContextAMD64* context,

                   MemoryRegion* memory,

                   const CodeModules* modules,

                   StackFrameSymbolizer* frame_symbolizer);

 private:

  // A STACK CFI-driven frame walker for the AMD64

  typedef SimpleCFIWalker<uint64_t, MDRawContextAMD64> CFIWalker;

  // Implementation of Stackwalker, using amd64 context (stack pointer in %rsp,

  // stack base in %rbp) and stack conventions (saved stack pointer at 0(%rbp))

  virtual StackFrame* GetContextFrame();

  virtual StackFrame* GetCallerFrame(const CallStack* stack,

                                     bool stack_scan_allowed);

  // Use cfi_frame_info (derived from STACK CFI records) to construct

  // the frame that called frames.back(). The caller takes ownership

  // of the returned frame. Return NULL on failure.

  StackFrameAMD64* GetCallerByCFIFrameInfo(const vector<StackFrame*> &frames,

                                           CFIFrameInfo* cfi_frame_info);

  // Assumes a traditional frame layout where the frame pointer has not been

  // omitted. The expectation is that caller's %rbp is pushed to the stack

  // after the return address of the callee, and that the callee's %rsp can

  // be used to find the pushed %rbp.

  // Caller owns the returned frame object. Returns NULL on failure.

  StackFrameAMD64* GetCallerByFramePointerRecovery(

      const vector<StackFrame*>& frames);

  // Scan the stack for plausible return addresses. The caller takes ownership

  // of the returned frame. Return NULL on failure.

  StackFrameAMD64* GetCallerByStackScan(const vector<StackFrame*> &frames);

  // Stores the CPU context corresponding to the innermost stack frame to

  // be returned by GetContextFrame.

  const MDRawContextAMD64* context_;

  // Our register map, for cfi_walker_.

  static const CFIWalker::RegisterSet cfi_register_map_[];

  // Our CFI frame walker.

  const CFIWalker cfi_walker_;

};

}  // namespace google_breakpad

#endif  // PROCESSOR_STACKWALKER_AMD64_H__