src/cpu/o3/thread_state.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  * Authors: Kevin Lim
  29  */
  30
  31 #ifndef __CPU_O3_THREAD_STATE_HH__
  32 #define __CPU_O3_THREAD_STATE_HH__
  33
  34 #include "base/callback.hh"
  35 #include "base/output.hh"
  36 #include "cpu/thread_context.hh"
  37 #include "cpu/thread_state.hh"
  38 #include "sim/full_system.hh"
  39 #include "sim/sim_exit.hh"
  40
  41 class EndQuiesceEvent;
  42 class Event;
  43 class FunctionalMemory;
  44 class FunctionProfile;
  45 class Process;
  46 class ProfileNode;
  47
  48 /**
  49  * Class that has various thread state, such as the status, the
  50  * current instruction being processed, whether or not the thread has
  51  * a trap pending or is being externally updated, the ThreadContext
  52  * pointer, etc.  It also handles anything related to a specific
  53  * thread's process, such as syscalls and checking valid addresses.
  54  */
  55 template <class Impl>
  56 struct O3ThreadState : public ThreadState {
  57     typedef ThreadContext::Status Status;
  58     typedef typename Impl::O3CPU O3CPU;
  59
  60   private:
  61     /** Pointer to the CPU. */
  62     O3CPU *cpu;
  63   public:
  64     /** Whether or not the thread is currently in syscall mode, and
  65      * thus able to be externally updated without squashing.
  66      */
  67     bool inSyscall;
  68
  69     /** Whether or not the thread is currently waiting on a trap, and
  70      * thus able to be externally updated without squashing.
  71      */
  72     bool trapPending;
  73
  74     O3ThreadState(O3CPU *_cpu, int _thread_num, Process *_process)
  75         : ThreadState(_cpu, _thread_num, _process),
  76           cpu(_cpu), inSyscall(0), trapPending(0)
  77     {
  78         if (FullSystem) {
  79             if (cpu->params()->profile) {
  80                 profile = new FunctionProfile(
  81                         cpu->params()->system->kernelSymtab);
  82                 Callback *cb =
  83                     new MakeCallback<O3ThreadState,
  84                     &O3ThreadState::dumpFuncProfile>(this);
  85                 registerExitCallback(cb);
  86             }
  87
  88             // let's fill with a dummy node for now so we don't get a segfault
  89             // on the first cycle when there's no node available.
  90             static ProfileNode dummyNode;
  91             profileNode = &dummyNode;
  92             profilePC = 3;
  93         }
  94     }
  95
  96     /** Pointer to the ThreadContext of this thread. */
  97     ThreadContext *tc;
  98
  99     /** Returns a pointer to the TC of this thread. */
 100     ThreadContext *getTC() { return tc; }
 101
 102     /** Handles the syscall. */
 103     void syscall(int64_t callnum) { process->syscall(callnum, tc); }
 104
 105     void dumpFuncProfile()
 106     {
 107         std::ostream *os = simout.create(csprintf("profile.%s.dat", cpu->name()));
 108         profile->dump(tc, *os);
 109     }
 110 };
 111
 112 #endif // __CPU_O3_THREAD_STATE_HH__