michael@0: // Copyright (c) 2010 Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // stackwalker_amd64.h: amd64-specific stackwalker.
michael@0: //
michael@0: // Provides stack frames given amd64 register context and a memory region
michael@0: // corresponding to a amd64 stack.
michael@0: //
michael@0: // Author: Mark Mentovai, Ted Mielczarek
michael@0: 
michael@0: 
michael@0: #ifndef PROCESSOR_STACKWALKER_AMD64_H__
michael@0: #define PROCESSOR_STACKWALKER_AMD64_H__
michael@0: 
michael@0: #include <vector>
michael@0: 
michael@0: #include "google_breakpad/common/breakpad_types.h"
michael@0: #include "google_breakpad/common/minidump_format.h"
michael@0: #include "google_breakpad/processor/stackwalker.h"
michael@0: #include "google_breakpad/processor/stack_frame_cpu.h"
michael@0: #include "processor/cfi_frame_info.h"
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: class CodeModules;
michael@0: 
michael@0: class StackwalkerAMD64 : public Stackwalker {
michael@0:  public:
michael@0:   // context is a amd64 context object that gives access to amd64-specific
michael@0:   // register state corresponding to the innermost called frame to be
michael@0:   // included in the stack.  The other arguments are passed directly through
michael@0:   // to the base Stackwalker constructor.
michael@0:   StackwalkerAMD64(const SystemInfo* system_info,
michael@0:                    const MDRawContextAMD64* context,
michael@0:                    MemoryRegion* memory,
michael@0:                    const CodeModules* modules,
michael@0:                    StackFrameSymbolizer* frame_symbolizer);
michael@0: 
michael@0:  private:
michael@0:   // A STACK CFI-driven frame walker for the AMD64
michael@0:   typedef SimpleCFIWalker<uint64_t, MDRawContextAMD64> CFIWalker;
michael@0: 
michael@0:   // Implementation of Stackwalker, using amd64 context (stack pointer in %rsp,
michael@0:   // stack base in %rbp) and stack conventions (saved stack pointer at 0(%rbp))
michael@0:   virtual StackFrame* GetContextFrame();
michael@0:   virtual StackFrame* GetCallerFrame(const CallStack* stack,
michael@0:                                      bool stack_scan_allowed);
michael@0: 
michael@0:   // Use cfi_frame_info (derived from STACK CFI records) to construct
michael@0:   // the frame that called frames.back(). The caller takes ownership
michael@0:   // of the returned frame. Return NULL on failure.
michael@0:   StackFrameAMD64* GetCallerByCFIFrameInfo(const vector<StackFrame*> &frames,
michael@0:                                            CFIFrameInfo* cfi_frame_info);
michael@0: 
michael@0:   // Scan the stack for plausible return addresses. The caller takes ownership
michael@0:   // of the returned frame. Return NULL on failure.
michael@0:   StackFrameAMD64* GetCallerByStackScan(const vector<StackFrame*> &frames);
michael@0: 
michael@0:   // Stores the CPU context corresponding to the innermost stack frame to
michael@0:   // be returned by GetContextFrame.
michael@0:   const MDRawContextAMD64* context_;
michael@0: 
michael@0:   // Our register map, for cfi_walker_.
michael@0:   static const CFIWalker::RegisterSet cfi_register_map_[];
michael@0: 
michael@0:   // Our CFI frame walker.
michael@0:   const CFIWalker cfi_walker_;
michael@0: };
michael@0: 
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: 
michael@0: #endif  // PROCESSOR_STACKWALKER_AMD64_H__