stackwalker_mips.h

Enable keyboard shortcuts

// Copyright (c) 2013 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_mips.h: MIPS-specific stackwalker.

//

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

// corresponding to a MIPSstack.

//

// Author: Tata Elxsi

#ifndef PROCESSOR_STACKWALKER_MIPS_H__

#define PROCESSOR_STACKWALKER_MIPS_H__

#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 StackwalkerMIPS : public Stackwalker {

 public:

  // Context is a MIPS context object that gives access to mips-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.

  StackwalkerMIPS(const SystemInfo* system_info,

                  const MDRawContextMIPS* context,

                  MemoryRegion* memory,

                  const CodeModules* modules,

                  StackFrameSymbolizer* frame_symbolizer);

 private:

  // Implementation of Stackwalker, using mips context and stack conventions.

  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.

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

                                          CFIFrameInfo* cfi_frame_info);

  // Scan the stack for plausible return address and frame pointer pair.

  // The caller takes ownership of the returned frame. Return NULL on failure.

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

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

  // be returned by GetContextFrame.

  const MDRawContextMIPS* context_;

};

}  // namespace google_breakpad

#endif  // PROCESSOR_STACKWALKER_MIPS_H__