1// Copyright (c) 2013 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_mips.h: MIPS-specific stackwalker.
31//
32// Provides stack frames given MIPS register context and a memory region
33// corresponding to a MIPSstack.
34//
35// Author: Tata Elxsi
36
37#ifndef PROCESSOR_STACKWALKER_MIPS_H__
38#define PROCESSOR_STACKWALKER_MIPS_H__
39
40#include "google_breakpad/common/breakpad_types.h"
41#include "google_breakpad/common/minidump_format.h"
42#include "google_breakpad/processor/stackwalker.h"
43#include "google_breakpad/processor/stack_frame_cpu.h"
44#include "processor/cfi_frame_info.h"
45
46namespace google_breakpad {
47
48class CodeModules;
49
50class StackwalkerMIPS : public Stackwalker {
51 public:
52 // Context is a MIPS context object that gives access to mips-specific
53 // register state corresponding to the innermost called frame to be
54 // included in the stack. The other arguments are passed directly
55 // through to the base Stackwalker constructor.
56 StackwalkerMIPS(const SystemInfo* system_info,
57 const MDRawContextMIPS* context,
58 MemoryRegion* memory,
59 const CodeModules* modules,
60 StackFrameSymbolizer* frame_symbolizer);
61
62 private:
63 // Implementation of Stackwalker, using mips context and stack conventions.
64 virtual StackFrame* GetContextFrame();
65 virtual StackFrame* GetCallerFrame(const CallStack* stack,
66 bool stack_scan_allowed);
67
68 // Use cfi_frame_info (derived from STACK CFI records) to construct
69 // the frame that called frames.back(). The caller takes ownership
70 // of the returned frame. Return NULL on failure.
71 StackFrameMIPS* GetCallerByCFIFrameInfo(const vector<StackFrame*>& frames,
72 CFIFrameInfo* cfi_frame_info);
73
74 // Scan the stack for plausible return address and frame pointer pair.
75 // The caller takes ownership of the returned frame. Return NULL on failure.
76 StackFrameMIPS* GetCallerByStackScan(const vector<StackFrame*>& frames);
77
78 // Stores the CPU context corresponding to the innermost stack frame to
79 // be returned by GetContextFrame.
80 const MDRawContextMIPS* context_;
81};
82
83} // namespace google_breakpad
84
85#endif // PROCESSOR_STACKWALKER_MIPS_H__
86