Merge ktlim@zizzer:/bk/newmem
[gem5.git] / 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 "arch/faults.hh"
35 #include "arch/isa_traits.hh"
36 #include "cpu/thread_context.hh"
37 #include "cpu/thread_state.hh"
38
39 class Event;
40 class Process;
41
42 #if FULL_SYSTEM
43 class EndQuiesceEvent;
44 class FunctionProfile;
45 class ProfileNode;
46 #else
47 class FunctionalMemory;
48 class Process;
49 #endif
50
51 /**
52 * Class that has various thread state, such as the status, the
53 * current instruction being processed, whether or not the thread has
54 * a trap pending or is being externally updated, the ThreadContext
55 * pointer, etc. It also handles anything related to a specific
56 * thread's process, such as syscalls and checking valid addresses.
57 */
58 template <class Impl>
59 struct O3ThreadState : public ThreadState {
60 typedef ThreadContext::Status Status;
61 typedef typename Impl::FullCPU FullCPU;
62
63 private:
64 /** Pointer to the CPU. */
65 FullCPU *cpu;
66 public:
67 /** Whether or not the thread is currently in syscall mode, and
68 * thus able to be externally updated without squashing.
69 */
70 bool inSyscall;
71
72 /** Whether or not the thread is currently waiting on a trap, and
73 * thus able to be externally updated without squashing.
74 */
75 bool trapPending;
76
77 #if FULL_SYSTEM
78 O3ThreadState(FullCPU *_cpu, int _thread_num)
79 : ThreadState(-1, _thread_num),
80 inSyscall(0), trapPending(0)
81 { }
82 #else
83 O3ThreadState(FullCPU *_cpu, int _thread_num, Process *_process, int _asid,
84 MemObject *mem)
85 : ThreadState(-1, _thread_num, mem, _process, _asid),
86 cpu(_cpu), inSyscall(0), trapPending(0)
87 { }
88 #endif
89
90 /** Pointer to the ThreadContext of this thread. */
91 ThreadContext *tc;
92
93 /** Returns a pointer to the TC of this thread. */
94 ThreadContext *getTC() { return tc; }
95
96 #if !FULL_SYSTEM
97 /** Handles the syscall. */
98 void syscall(int64_t callnum) { process->syscall(callnum, tc); }
99 #endif
100 };
101
102 #endif // __CPU_O3_THREAD_STATE_HH__