1  // Copyright 2013 Google LLC
 2  //
 3  // Redistribution and use in source and binary forms, with or without
 4  // modification, are permitted provided that the following conditions are
 5  // met:
 6  //
 7  //     * Redistributions of source code must retain the above copyright
 8  // notice, this list of conditions and the following disclaimer.
 9  //     * Redistributions in binary form must reproduce the above
10  // copyright notice, this list of conditions and the following disclaimer
11  // in the documentation and/or other materials provided with the
12  // distribution.
13  //     * Neither the name of Google LLC nor the names of its
14  // contributors may be used to endorse or promote products derived from
15  // this software without specific prior written permission.
16  //
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  
29  // stackwalker_mips.h: MIPS-specific stackwalker.
30  //
31  // Provides stack frames given MIPS register context and a memory region
32  // corresponding to a MIPSstack.
33  //
34  // Author: Tata Elxsi
35  
36  #ifndef PROCESSOR_STACKWALKER_MIPS_H__
37  #define PROCESSOR_STACKWALKER_MIPS_H__
38  
39  #include "google_breakpad/common/breakpad_types.h"
40  #include "google_breakpad/common/minidump_format.h"
41  #include "google_breakpad/processor/stackwalker.h"
42  #include "google_breakpad/processor/stack_frame_cpu.h"
43  #include "processor/cfi_frame_info.h"
44  
45  namespace google_breakpad {
46  
47  class CodeModules;
48  
49  class StackwalkerMIPS : public Stackwalker {
50   public:
51    // Context is a MIPS context object that gives access to mips-specific
52    // register state corresponding to the innermost called frame to be
53    // included in the stack.  The other arguments are passed directly
54    // through to the base Stackwalker constructor.
55    StackwalkerMIPS(const SystemInfo* system_info,
56                    const MDRawContextMIPS* context,
57                    MemoryRegion* memory,
58                    const CodeModules* modules,
59                    StackFrameSymbolizer* frame_symbolizer);
60  
61   private:
62    // Implementation of Stackwalker, using mips context and stack conventions.
63    virtual StackFrame* GetContextFrame();
64    virtual StackFrame* GetCallerFrame(const CallStack* stack,
65                                       bool stack_scan_allowed);
66  
67    // Use cfi_frame_info (derived from STACK CFI records) to construct
68    // the frame that called frames.back(). The caller takes ownership
69    // of the returned frame. Return NULL on failure.
70    StackFrameMIPS* GetCallerByCFIFrameInfo(const vector<StackFrame*>& frames,
71                                            CFIFrameInfo* cfi_frame_info);
72  
73    // Scan the stack for plausible return address and frame pointer pair. 
74    // The caller takes ownership of the returned frame. Return NULL on failure.
75    StackFrameMIPS* GetCallerByStackScan(const vector<StackFrame*>& frames);
76  
77    // Stores the CPU context corresponding to the innermost stack frame to
78    // be returned by GetContextFrame.
79    const MDRawContextMIPS* context_;
80  };
81  
82  }  // namespace google_breakpad
83  
84  #endif  // PROCESSOR_STACKWALKER_MIPS_H__