thread_context.hh revision 3453
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_THREAD_CONTEXT_HH__ 32#define __CPU_THREAD_CONTEXT_HH__ 33 34#include "arch/regfile.hh" 35#include "arch/syscallreturn.hh" 36#include "arch/types.hh" 37#include "config/full_system.hh" 38#include "mem/request.hh" 39#include "sim/faults.hh" 40#include "sim/host.hh" 41#include "sim/serialize.hh" 42#include "sim/byteswap.hh" 43 44// @todo: Figure out a more architecture independent way to obtain the ITB and 45// DTB pointers. 46namespace TheISA 47{ 48 class DTB; 49 class ITB; 50} 51class BaseCPU; 52class EndQuiesceEvent; 53class Event; 54class TranslatingPort; 55class FunctionalPort; 56class VirtualPort; 57class Process; 58class System; 59namespace Kernel { 60 class Statistics; 61}; 62 63/** 64 * ThreadContext is the external interface to all thread state for 65 * anything outside of the CPU. It provides all accessor methods to 66 * state that might be needed by external objects, ranging from 67 * register values to things such as kernel stats. It is an abstract 68 * base class; the CPU can create its own ThreadContext by either 69 * deriving from it, or using the templated ProxyThreadContext. 70 * 71 * The ThreadContext is slightly different than the ExecContext. The 72 * ThreadContext provides access to an individual thread's state; an 73 * ExecContext provides ISA access to the CPU (meaning it is 74 * implicitly multithreaded on SMT systems). Additionally the 75 * ThreadState is an abstract class that exactly defines the 76 * interface; the ExecContext is a more implicit interface that must 77 * be implemented so that the ISA can access whatever state it needs. 78 */ 79class ThreadContext 80{ 81 protected: 82 typedef TheISA::RegFile RegFile; 83 typedef TheISA::MachInst MachInst; 84 typedef TheISA::IntReg IntReg; 85 typedef TheISA::FloatReg FloatReg; 86 typedef TheISA::FloatRegBits FloatRegBits; 87 typedef TheISA::MiscRegFile MiscRegFile; 88 typedef TheISA::MiscReg MiscReg; 89 public: 90 enum Status 91 { 92 /// Initialized but not running yet. All CPUs start in 93 /// this state, but most transition to Active on cycle 1. 94 /// In MP or SMT systems, non-primary contexts will stay 95 /// in this state until a thread is assigned to them. 96 Unallocated, 97 98 /// Running. Instructions should be executed only when 99 /// the context is in this state. 100 Active, 101 102 /// Temporarily inactive. Entered while waiting for 103 /// synchronization, etc. 104 Suspended, 105 106 /// Permanently shut down. Entered when target executes 107 /// m5exit pseudo-instruction. When all contexts enter 108 /// this state, the simulation will terminate. 109 Halted 110 }; 111 112 virtual ~ThreadContext() { }; 113 114 virtual BaseCPU *getCpuPtr() = 0; 115 116 virtual void setCpuId(int id) = 0; 117 118 virtual int readCpuId() = 0; 119 120#if FULL_SYSTEM 121 virtual System *getSystemPtr() = 0; 122 123 virtual TheISA::ITB *getITBPtr() = 0; 124 125 virtual TheISA::DTB *getDTBPtr() = 0; 126 127 virtual Kernel::Statistics *getKernelStats() = 0; 128 129 virtual FunctionalPort *getPhysPort() = 0; 130 131 virtual VirtualPort *getVirtPort(ThreadContext *tc = NULL) = 0; 132 133 virtual void delVirtPort(VirtualPort *vp) = 0; 134#else 135 virtual TranslatingPort *getMemPort() = 0; 136 137 virtual Process *getProcessPtr() = 0; 138#endif 139 140 virtual Status status() const = 0; 141 142 virtual void setStatus(Status new_status) = 0; 143 144 /// Set the status to Active. Optional delay indicates number of 145 /// cycles to wait before beginning execution. 146 virtual void activate(int delay = 1) = 0; 147 148 /// Set the status to Suspended. 149 virtual void suspend() = 0; 150 151 /// Set the status to Unallocated. 152 virtual void deallocate(int delay = 0) = 0; 153 154 /// Set the status to Halted. 155 virtual void halt() = 0; 156 157#if FULL_SYSTEM 158 virtual void dumpFuncProfile() = 0; 159#endif 160 161 virtual void takeOverFrom(ThreadContext *old_context) = 0; 162 163 virtual void regStats(const std::string &name) = 0; 164 165 virtual void serialize(std::ostream &os) = 0; 166 virtual void unserialize(Checkpoint *cp, const std::string §ion) = 0; 167 168#if FULL_SYSTEM 169 virtual EndQuiesceEvent *getQuiesceEvent() = 0; 170 171 // Not necessarily the best location for these... 172 // Having an extra function just to read these is obnoxious 173 virtual Tick readLastActivate() = 0; 174 virtual Tick readLastSuspend() = 0; 175 176 virtual void profileClear() = 0; 177 virtual void profileSample() = 0; 178#endif 179 180 virtual int getThreadNum() = 0; 181 182 // Also somewhat obnoxious. Really only used for the TLB fault. 183 // However, may be quite useful in SPARC. 184 virtual TheISA::MachInst getInst() = 0; 185 186 virtual void copyArchRegs(ThreadContext *tc) = 0; 187 188 virtual void clearArchRegs() = 0; 189 190 // 191 // New accessors for new decoder. 192 // 193 virtual uint64_t readIntReg(int reg_idx) = 0; 194 195 virtual FloatReg readFloatReg(int reg_idx, int width) = 0; 196 197 virtual FloatReg readFloatReg(int reg_idx) = 0; 198 199 virtual FloatRegBits readFloatRegBits(int reg_idx, int width) = 0; 200 201 virtual FloatRegBits readFloatRegBits(int reg_idx) = 0; 202 203 virtual void setIntReg(int reg_idx, uint64_t val) = 0; 204 205 virtual void setFloatReg(int reg_idx, FloatReg val, int width) = 0; 206 207 virtual void setFloatReg(int reg_idx, FloatReg val) = 0; 208 209 virtual void setFloatRegBits(int reg_idx, FloatRegBits val) = 0; 210 211 virtual void setFloatRegBits(int reg_idx, FloatRegBits val, int width) = 0; 212 213 virtual uint64_t readPC() = 0; 214 215 virtual void setPC(uint64_t val) = 0; 216 217 virtual uint64_t readNextPC() = 0; 218 219 virtual void setNextPC(uint64_t val) = 0; 220 221 virtual uint64_t readNextNPC() = 0; 222 223 virtual void setNextNPC(uint64_t val) = 0; 224 225 virtual MiscReg readMiscReg(int misc_reg) = 0; 226 227 virtual MiscReg readMiscRegWithEffect(int misc_reg, Fault &fault) = 0; 228 229 virtual Fault setMiscReg(int misc_reg, const MiscReg &val) = 0; 230 231 virtual Fault setMiscRegWithEffect(int misc_reg, const MiscReg &val) = 0; 232 233 // Also not necessarily the best location for these two. Hopefully will go 234 // away once we decide upon where st cond failures goes. 235 virtual unsigned readStCondFailures() = 0; 236 237 virtual void setStCondFailures(unsigned sc_failures) = 0; 238 239#if FULL_SYSTEM 240 virtual bool inPalMode() = 0; 241#endif 242 243 // Only really makes sense for old CPU model. Still could be useful though. 244 virtual bool misspeculating() = 0; 245 246#if !FULL_SYSTEM 247 virtual IntReg getSyscallArg(int i) = 0; 248 249 // used to shift args for indirect syscall 250 virtual void setSyscallArg(int i, IntReg val) = 0; 251 252 virtual void setSyscallReturn(SyscallReturn return_value) = 0; 253 254 // Same with st cond failures. 255 virtual Counter readFuncExeInst() = 0; 256 257 // This function exits the thread context in the CPU and returns 258 // 1 if the CPU has no more active threads (meaning it's OK to exit); 259 // Used in syscall-emulation mode when a thread calls the exit syscall. 260 virtual int exit() { return 1; }; 261#endif 262 263 virtual void changeRegFileContext(TheISA::RegContextParam param, 264 TheISA::RegContextVal val) = 0; 265}; 266 267/** 268 * ProxyThreadContext class that provides a way to implement a 269 * ThreadContext without having to derive from it. ThreadContext is an 270 * abstract class, so anything that derives from it and uses its 271 * interface will pay the overhead of virtual function calls. This 272 * class is created to enable a user-defined Thread object to be used 273 * wherever ThreadContexts are used, without paying the overhead of 274 * virtual function calls when it is used by itself. See 275 * simple_thread.hh for an example of this. 276 */ 277template <class TC> 278class ProxyThreadContext : public ThreadContext 279{ 280 public: 281 ProxyThreadContext(TC *actual_tc) 282 { actualTC = actual_tc; } 283 284 private: 285 TC *actualTC; 286 287 public: 288 289 BaseCPU *getCpuPtr() { return actualTC->getCpuPtr(); } 290 291 void setCpuId(int id) { actualTC->setCpuId(id); } 292 293 int readCpuId() { return actualTC->readCpuId(); } 294 295#if FULL_SYSTEM 296 System *getSystemPtr() { return actualTC->getSystemPtr(); } 297 298 TheISA::ITB *getITBPtr() { return actualTC->getITBPtr(); } 299 300 TheISA::DTB *getDTBPtr() { return actualTC->getDTBPtr(); } 301 302 Kernel::Statistics *getKernelStats() { return actualTC->getKernelStats(); } 303 304 FunctionalPort *getPhysPort() { return actualTC->getPhysPort(); } 305 306 VirtualPort *getVirtPort(ThreadContext *tc = NULL) { return actualTC->getVirtPort(tc); } 307 308 void delVirtPort(VirtualPort *vp) { return actualTC->delVirtPort(vp); } 309#else 310 TranslatingPort *getMemPort() { return actualTC->getMemPort(); } 311 312 Process *getProcessPtr() { return actualTC->getProcessPtr(); } 313#endif 314 315 Status status() const { return actualTC->status(); } 316 317 void setStatus(Status new_status) { actualTC->setStatus(new_status); } 318 319 /// Set the status to Active. Optional delay indicates number of 320 /// cycles to wait before beginning execution. 321 void activate(int delay = 1) { actualTC->activate(delay); } 322 323 /// Set the status to Suspended. 324 void suspend() { actualTC->suspend(); } 325 326 /// Set the status to Unallocated. 327 void deallocate(int delay = 0) { actualTC->deallocate(); } 328 329 /// Set the status to Halted. 330 void halt() { actualTC->halt(); } 331 332#if FULL_SYSTEM 333 void dumpFuncProfile() { actualTC->dumpFuncProfile(); } 334#endif 335 336 void takeOverFrom(ThreadContext *oldContext) 337 { actualTC->takeOverFrom(oldContext); } 338 339 void regStats(const std::string &name) { actualTC->regStats(name); } 340 341 void serialize(std::ostream &os) { actualTC->serialize(os); } 342 void unserialize(Checkpoint *cp, const std::string §ion) 343 { actualTC->unserialize(cp, section); } 344 345#if FULL_SYSTEM 346 EndQuiesceEvent *getQuiesceEvent() { return actualTC->getQuiesceEvent(); } 347 348 Tick readLastActivate() { return actualTC->readLastActivate(); } 349 Tick readLastSuspend() { return actualTC->readLastSuspend(); } 350 351 void profileClear() { return actualTC->profileClear(); } 352 void profileSample() { return actualTC->profileSample(); } 353#endif 354 355 int getThreadNum() { return actualTC->getThreadNum(); } 356 357 // @todo: Do I need this? 358 MachInst getInst() { return actualTC->getInst(); } 359 360 // @todo: Do I need this? 361 void copyArchRegs(ThreadContext *tc) { actualTC->copyArchRegs(tc); } 362 363 void clearArchRegs() { actualTC->clearArchRegs(); } 364 365 // 366 // New accessors for new decoder. 367 // 368 uint64_t readIntReg(int reg_idx) 369 { return actualTC->readIntReg(reg_idx); } 370 371 FloatReg readFloatReg(int reg_idx, int width) 372 { return actualTC->readFloatReg(reg_idx, width); } 373 374 FloatReg readFloatReg(int reg_idx) 375 { return actualTC->readFloatReg(reg_idx); } 376 377 FloatRegBits readFloatRegBits(int reg_idx, int width) 378 { return actualTC->readFloatRegBits(reg_idx, width); } 379 380 FloatRegBits readFloatRegBits(int reg_idx) 381 { return actualTC->readFloatRegBits(reg_idx); } 382 383 void setIntReg(int reg_idx, uint64_t val) 384 { actualTC->setIntReg(reg_idx, val); } 385 386 void setFloatReg(int reg_idx, FloatReg val, int width) 387 { actualTC->setFloatReg(reg_idx, val, width); } 388 389 void setFloatReg(int reg_idx, FloatReg val) 390 { actualTC->setFloatReg(reg_idx, val); } 391 392 void setFloatRegBits(int reg_idx, FloatRegBits val, int width) 393 { actualTC->setFloatRegBits(reg_idx, val, width); } 394 395 void setFloatRegBits(int reg_idx, FloatRegBits val) 396 { actualTC->setFloatRegBits(reg_idx, val); } 397 398 uint64_t readPC() { return actualTC->readPC(); } 399 400 void setPC(uint64_t val) { actualTC->setPC(val); } 401 402 uint64_t readNextPC() { return actualTC->readNextPC(); } 403 404 void setNextPC(uint64_t val) { actualTC->setNextPC(val); } 405 406 uint64_t readNextNPC() { return actualTC->readNextNPC(); } 407 408 void setNextNPC(uint64_t val) { actualTC->setNextNPC(val); } 409 410 MiscReg readMiscReg(int misc_reg) 411 { return actualTC->readMiscReg(misc_reg); } 412 413 MiscReg readMiscRegWithEffect(int misc_reg, Fault &fault) 414 { return actualTC->readMiscRegWithEffect(misc_reg, fault); } 415 416 Fault setMiscReg(int misc_reg, const MiscReg &val) 417 { return actualTC->setMiscReg(misc_reg, val); } 418 419 Fault setMiscRegWithEffect(int misc_reg, const MiscReg &val) 420 { return actualTC->setMiscRegWithEffect(misc_reg, val); } 421 422 unsigned readStCondFailures() 423 { return actualTC->readStCondFailures(); } 424 425 void setStCondFailures(unsigned sc_failures) 426 { actualTC->setStCondFailures(sc_failures); } 427#if FULL_SYSTEM 428 bool inPalMode() { return actualTC->inPalMode(); } 429#endif 430 431 // @todo: Fix this! 432 bool misspeculating() { return actualTC->misspeculating(); } 433 434#if !FULL_SYSTEM 435 IntReg getSyscallArg(int i) { return actualTC->getSyscallArg(i); } 436 437 // used to shift args for indirect syscall 438 void setSyscallArg(int i, IntReg val) 439 { actualTC->setSyscallArg(i, val); } 440 441 void setSyscallReturn(SyscallReturn return_value) 442 { actualTC->setSyscallReturn(return_value); } 443 444 Counter readFuncExeInst() { return actualTC->readFuncExeInst(); } 445#endif 446 447 void changeRegFileContext(TheISA::RegContextParam param, 448 TheISA::RegContextVal val) 449 { 450 actualTC->changeRegFileContext(param, val); 451 } 452}; 453 454#endif 455