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