src/arch/x86/stacktrace.hh

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