1/*
2 * Copyright (c) 2006 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_X86_STACKTRACE_HH__
32#define __ARCH_X86_STACKTRACE_HH__
33
34#include "base/trace.hh"
35#include "cpu/static_inst.hh"
36#include "debug/Stack.hh"
37
38class ThreadContext;
39namespace X86ISA
40{
41    class StackTrace;
42
43    class ProcessInfo
44    {
45      private:
46        ThreadContext *tc;
47
48        int thread_info_size;
49        int task_struct_size;
50        int task_off;
51        int pid_off;
52        int name_off;
53
54      public:
55        ProcessInfo(ThreadContext *_tc);
56
57        Addr task(Addr ksp) const;
58        int pid(Addr ksp) const;
59        std::string name(Addr ksp) const;
60    };
61
62    class StackTrace
63    {
64      private:
65        ThreadContext *tc;
66        std::vector<Addr> stack;
67
68      private:
69        bool isEntry(Addr addr);
70        bool decodePrologue(Addr sp, Addr callpc, Addr func, int &size, Addr &ra);
71        bool decodeSave(MachInst inst, int &reg, int &disp);
72        bool decodeStack(MachInst inst, int &disp);
73
74        void trace(ThreadContext *tc, bool is_call);
75
76      public:
77        StackTrace();
78        StackTrace(ThreadContext *tc, const StaticInstPtr &inst);
79        ~StackTrace();
80
81        void clear()
82        {
83            tc = 0;
84            stack.clear();
85        }
86
87        bool valid() const { return tc != NULL; }
88        bool trace(ThreadContext *tc, const StaticInstPtr &inst);
89
90      public:
91        const std::vector<Addr> &getstack() const { return stack; }
92
93        static const int user = 1;
94        static const int console = 2;
95        static const int unknown = 3;
96
97#if TRACING_ON
98      private:
99        void dump();
100
101      public:
102        void dprintf() { if (DTRACE(Stack)) dump(); }
103#else
104      public:
105        void dprintf() {}
106#endif
107    };
108
109    inline bool
110    StackTrace::trace(ThreadContext *tc, const StaticInstPtr &inst)
111    {
112        if (!inst->isCall() && !inst->isReturn())
113            return false;
114
115        if (valid())
116            clear();
117
118        trace(tc, !inst->isReturn());
119        return true;
120    }
121}
122
123#endif // __ARCH_X86_STACKTRACE_HH__
124