1/*
2 * Copyright (c) 2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: 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 copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 */
30
31#ifndef __ARCH_ARM_STACKTRACE_HH__
32#define __ARCH_ARM_STACKTRACE_HH__
33
34#include "base/trace.hh"
35#include "cpu/static_inst.hh"
36#include "debug/Stack.hh"
37
38class ThreadContext;
39namespace ArmISA
40{
41
42class StackTrace;
43
44class ProcessInfo
45{
46  private:
47    ThreadContext *tc;
48
49    int thread_info_size;
50    int task_struct_size;
51    int task_off;
52    int pid_off;
53    int name_off;
54
55  public:
56    ProcessInfo(ThreadContext *_tc);
57
58    Addr task(Addr ksp) const;
59    int pid(Addr ksp) const;
60    std::string name(Addr ksp) const;
61};
62
63class StackTrace
64{
65  protected:
66    typedef ArmISA::MachInst MachInst;
67  private:
68    ThreadContext *tc;
69    std::vector<Addr> stack;
70
71  private:
72    bool isEntry(Addr addr);
73    bool decodePrologue(Addr sp, Addr callpc, Addr func, int &size, Addr &ra);
74    bool decodeSave(MachInst inst, int &reg, int &disp);
75    bool decodeStack(MachInst inst, int &disp);
76
77    void trace(ThreadContext *tc, bool is_call);
78
79  public:
80    StackTrace();
81    StackTrace(ThreadContext *tc, const StaticInstPtr &inst);
82    ~StackTrace();
83
84    void clear()
85    {
86        tc = 0;
87        stack.clear();
88    }
89
90    bool valid() const { return tc != NULL; }
91    bool trace(ThreadContext *tc, const StaticInstPtr &inst);
92
93  public:
94    const std::vector<Addr> &getstack() const { return stack; }
95
96#if TRACING_ON
97  private:
98    void dump();
99
100  public:
101    void dprintf() { if (DTRACE(Stack)) dump(); }
102#else
103  public:
104    void dprintf() {}
105#endif
106};
107
108inline bool
109StackTrace::trace(ThreadContext *tc, const StaticInstPtr &inst)
110{
111    if (!inst->isCall() && !inst->isReturn())
112        return false;
113
114    if (valid())
115        clear();
116
117    trace(tc, !inst->isReturn());
118    return true;
119}
120
121} // Namespace ArmISA
122
123#endif // __ARCH_ARM_STACKTRACE_HH__
124