src/arch/power/stacktrace.hh

   1 /*
   2  * Copyright (c) 2005 The Regents of The University of Michigan
   3  * Copyright (c) 2007-2008 The Florida State University
   4  * Copyright (c) 2009 The University of Edinburgh
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are
   9  * met: redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer;
  11  * redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution;
  14  * neither the name of the copyright holders 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  * Authors: Ali Saidi
  31  *          Stephen Hines
  32  *          Timothy M. Jones
  33  */
  34
  35 #ifndef __ARCH_POWER_STACKTRACE_HH__
  36 #define __ARCH_POWER_STACKTRACE_HH__
  37
  38 #include "base/trace.hh"
  39 #include "cpu/static_inst.hh"
  40 #include "debug/Stack.hh"
  41
  42 class ThreadContext;
  43 class StackTrace;
  44
  45 namespace PowerISA
  46 {
  47
  48 class ProcessInfo
  49 {
  50   private:
  51     ThreadContext *tc;
  52
  53     int thread_info_size;
  54     int task_struct_size;
  55     int task_off;
  56     int pid_off;
  57     int name_off;
  58
  59   public:
  60     ProcessInfo(ThreadContext *_tc);
  61
  62     Addr task(Addr ksp) const;
  63     int pid(Addr ksp) const;
  64     std::string name(Addr ksp) const;
  65 };
  66
  67 class StackTrace
  68 {
  69   protected:
  70     typedef TheISA::MachInst MachInst;
  71   private:
  72     ThreadContext *tc;
  73     std::vector<Addr> stack;
  74
  75   private:
  76     bool isEntry(Addr addr);
  77     bool decodePrologue(Addr sp, Addr callpc, Addr func, int &size, Addr &ra);
  78     bool decodeSave(MachInst inst, int &reg, int &disp);
  79     bool decodeStack(MachInst inst, int &disp);
  80
  81     void trace(ThreadContext *tc, bool is_call);
  82
  83   public:
  84     StackTrace();
  85     StackTrace(ThreadContext *tc, StaticInstPtr inst);
  86     ~StackTrace();
  87
  88     void
  89     clear()
  90     {
  91         tc = 0;
  92         stack.clear();
  93     }
  94
  95     bool
  96     valid() const
  97     {
  98         return tc != NULL;
  99     }
 100
 101     bool trace(ThreadContext *tc, StaticInstPtr inst);
 102
 103   public:
 104     const std::vector<Addr> &
 105     getstack() const
 106     {
 107         return stack;
 108     }
 109
 110     static const int user = 1;
 111     static const int console = 2;
 112     static const int unknown = 3;
 113
 114 #if TRACING_ON
 115   private:
 116     void dump();
 117
 118   public:
 119     void
 120     dprintf()
 121     {
 122         if (DTRACE(Stack))
 123             dump();
 124     }
 125 #else
 126   public:
 127     void
 128     dprintf()
 129     {
 130     }
 131 #endif
 132 };
 133
 134 inline bool
 135 StackTrace::trace(ThreadContext *tc, StaticInstPtr inst)
 136 {
 137     if (!inst->isCall() && !inst->isReturn())
 138         return false;
 139
 140     if (valid())
 141         clear();
 142
 143     trace(tc, !inst->isReturn());
 144     return true;
 145 }
 146
 147 } // namespace PowerISA
 148
 149 #endif // __ARCH_POWER_STACKTRACE_HH__