thread_state.hh revision 2348 
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 __CPU_O3_THREAD_STATE_HH__
30#define __CPU_O3_THREAD_STATE_HH__
31
32#include "arch/faults.hh"
33#include "arch/isa_traits.hh"
34#include "cpu/exec_context.hh"
35#include "cpu/thread_state.hh"
36
37class Event;
38class Process;
39
40#if FULL_SYSTEM
41class EndQuiesceEvent;
42class FunctionProfile;
43class ProfileNode;
44#else
45class FunctionalMemory;
46class Process;
47#endif
48
49/**
50 * Class that has various thread state, such as the status, the
51 * current instruction being processed, whether or not the thread has
52 * a trap pending or is being externally updated, the ExecContext
53 * proxy pointer, etc.  It also handles anything related to a specific
54 * thread's process, such as syscalls and checking valid addresses.
55 */
56template <class Impl>
57struct O3ThreadState : public ThreadState {
58    typedef ExecContext::Status Status;
59    typedef typename Impl::FullCPU FullCPU;
60
61    /** Current status of the thread. */
62    Status _status;
63
64    /** Current instruction the thread is committing.  Only set and
65     * used for DTB faults currently.
66     */
67    TheISA::MachInst inst;
68
69  private:
70    /** Pointer to the CPU. */
71    FullCPU *cpu;
72  public:
73    /** Whether or not the thread is currently in syscall mode, and
74     * thus able to be externally updated without squashing.
75     */
76    bool inSyscall;
77
78    /** Whether or not the thread is currently waiting on a trap, and
79     * thus able to be externally updated without squashing.
80     */
81    bool trapPending;
82
83#if FULL_SYSTEM
84    O3ThreadState(FullCPU *_cpu, int _thread_num, FunctionalMemory *_mem)
85        : ThreadState(-1, _thread_num, _mem),
86          inSyscall(0), trapPending(0)
87    { }
88#else
89    O3ThreadState(FullCPU *_cpu, int _thread_num, Process *_process, int _asid)
90        : ThreadState(-1, _thread_num, _process->getMemory(), _process, _asid),
91          cpu(_cpu), inSyscall(0), trapPending(0)
92    { }
93
94    O3ThreadState(FullCPU *_cpu, int _thread_num, FunctionalMemory *_mem,
95                  int _asid)
96        : ThreadState(-1, _thread_num, _mem, NULL, _asid),
97          cpu(_cpu), inSyscall(0), trapPending(0)
98    { }
99#endif
100
101    /** Pointer to the ExecContext of this thread.  @todo: Don't call
102     this a proxy.*/
103    ExecContext *xcProxy;
104
105    /** Returns a pointer to the XC of this thread. */
106    ExecContext *getXCProxy() { return xcProxy; }
107
108    /** Returns the status of this thread. */
109    Status status() const { return _status; }
110
111    /** Sets the status of this thread. */
112    void setStatus(Status new_status) { _status = new_status; }
113
114#if !FULL_SYSTEM
115    /** Returns if this address is a valid instruction address. */
116    bool validInstAddr(Addr addr)
117    { return process->validInstAddr(addr); }
118
119    /** Returns if this address is a valid data address. */
120    bool validDataAddr(Addr addr)
121    { return process->validDataAddr(addr); }
122#endif
123
124    /** Sets the current instruction being committed. */
125    void setInst(TheISA::MachInst _inst) { inst = _inst; }
126
127    /** Reads the number of instructions functionally executed and
128     * committed.
129     */
130    Counter readFuncExeInst() { return funcExeInst; }
131
132    /** Sets the total number of instructions functionally executed
133     * and committed.
134     */
135    void setFuncExeInst(Counter new_val) { funcExeInst = new_val; }
136
137#if !FULL_SYSTEM
138    /** Handles the syscall. */
139    void syscall() { process->syscall(xcProxy); }
140#endif
141};
142
143#endif // __CPU_O3_THREAD_STATE_HH__
144