src/cpu/o3/thread_context.hh - testing/jenkins-gem5-prod - Git at Google

 /*
  * Copyright (c) 2004-2006 The Regents of The University of Michigan
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met: redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer;
  * redistributions in binary form must reproduce the above copyright
  * notice, this list of conditions and the following disclaimer in the
  * documentation and/or other materials provided with the distribution;
  * neither the name of the copyright holders nor the names of its
  * contributors may be used to endorse or promote products derived from
  * this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  * Authors: Kevin Lim
  */

 #ifndef __CPU_O3_THREAD_CONTEXT_HH__
 #define __CPU_O3_THREAD_CONTEXT_HH__

 #include "cpu/thread_context.hh"
 #include "cpu/o3/isa_specific.hh"

 class EndQuiesceEvent;
 namespace Kernel {
     class Statistics;
 };

 class TranslatingPort;

 /**
  * Derived ThreadContext class for use with the O3CPU.  It
  * provides the interface for any external objects to access a
  * single thread's state and some general CPU state.  Any time
  * external objects try to update state through this interface,
  * the CPU will create an event to squash all in-flight
  * instructions in order to ensure state is maintained correctly.
  * It must be defined specifically for the O3CPU because
  * not all architectural state is located within the O3ThreadState
  * (such as the commit PC, and registers), and specific actions
  * must be taken when using this interface (such as squashing all
  * in-flight instructions when doing a write to this interface).
  */
 template <class Impl>
 class O3ThreadContext : public ThreadContext
 {
   public:
     typedef typename Impl::O3CPU O3CPU;

    /** Pointer to the CPU. */
     O3CPU *cpu;

     /** Pointer to the thread state that this TC corrseponds to. */
     O3ThreadState<Impl> *thread;

     /** Returns a pointer to the ITB. */
     TheISA::TLB *getITBPtr() { return cpu->itb; }

     /** Returns a pointer to the DTB. */
     TheISA::TLB *getDTBPtr() { return cpu->dtb; }

     /** Returns a pointer to this CPU. */
     virtual BaseCPU *getCpuPtr() { return cpu; }

     /** Reads this CPU's ID. */
     virtual int cpuId() { return cpu->cpuId(); }

     virtual int contextId() { return thread->contextId(); }

     virtual void setContextId(int id) { thread->setContextId(id); }

     /** Returns this thread's ID number. */
     virtual int threadId() { return thread->threadId(); }
     virtual void setThreadId(int id) { return thread->setThreadId(id); }

     /** Returns a pointer to the system. */
     virtual System *getSystemPtr() { return cpu->system; }

 #if FULL_SYSTEM
     /** Returns a pointer to physical memory. */
     virtual PhysicalMemory *getPhysMemPtr() { return cpu->physmem; }

     /** Returns a pointer to this thread's kernel statistics. */
     virtual TheISA::Kernel::Statistics *getKernelStats()
     { return thread->kernelStats; }

     virtual FunctionalPort *getPhysPort() { return thread->getPhysPort(); }

     virtual VirtualPort *getVirtPort();

     virtual void connectMemPorts(ThreadContext *tc) { thread->connectMemPorts(tc); }
 #else
     virtual TranslatingPort *getMemPort() { return thread->getMemPort(); }

     /** Returns a pointer to this thread's process. */
     virtual Process *getProcessPtr() { return thread->getProcessPtr(); }
 #endif
     /** Returns this thread's status. */
     virtual Status status() const { return thread->status(); }

     /** Sets this thread's status. */
     virtual void setStatus(Status new_status)
     { thread->setStatus(new_status); }

     /** Set the status to Active.  Optional delay indicates number of
      * cycles to wait before beginning execution. */
     virtual void activate(int delay = 1);

     /** Set the status to Suspended. */
     virtual void suspend(int delay = 0);

     /** Set the status to Halted. */
     virtual void halt(int delay = 0);

 #if FULL_SYSTEM
     /** Dumps the function profiling information.
      * @todo: Implement.
      */
     virtual void dumpFuncProfile();
 #endif
     /** Takes over execution of a thread from another CPU. */
     virtual void takeOverFrom(ThreadContext *old_context);

     /** Registers statistics associated with this TC. */
     virtual void regStats(const std::string &name);

     /** Serializes state. */
     virtual void serialize(std::ostream &os);
     /** Unserializes state. */
     virtual void unserialize(Checkpoint *cp, const std::string &section);

 #if FULL_SYSTEM
     /** Reads the last tick that this thread was activated on. */
     virtual Tick readLastActivate();
     /** Reads the last tick that this thread was suspended on. */
     virtual Tick readLastSuspend();

     /** Clears the function profiling information. */
     virtual void profileClear();
     /** Samples the function profiling information. */
     virtual void profileSample();
 #endif
     /** Returns the instruction this thread is currently committing.
      *  Only used when an instruction faults.
      */
     virtual TheISA::MachInst getInst();

     /** Copies the architectural registers from another TC into this TC. */
     virtual void copyArchRegs(ThreadContext *tc);

     /** Resets all architectural registers to 0. */
     virtual void clearArchRegs();

     /** Reads an integer register. */
     virtual uint64_t readIntReg(int reg_idx);

     virtual FloatReg readFloatReg(int reg_idx);

     virtual FloatRegBits readFloatRegBits(int reg_idx);

     /** Sets an integer register to a value. */
     virtual void setIntReg(int reg_idx, uint64_t val);

     virtual void setFloatReg(int reg_idx, FloatReg val);

     virtual void setFloatRegBits(int reg_idx, FloatRegBits val);

     /** Reads this thread's PC. */
     virtual uint64_t readPC()
     { return cpu->readPC(thread->threadId()); }

     /** Sets this thread's PC. */
     virtual void setPC(uint64_t val);

     /** Reads this thread's next PC. */
     virtual uint64_t readNextPC()
     { return cpu->readNextPC(thread->threadId()); }

     /** Sets this thread's next PC. */
     virtual void setNextPC(uint64_t val);

     virtual uint64_t readMicroPC()
     { return cpu->readMicroPC(thread->threadId()); }

     virtual void setMicroPC(uint64_t val);

     virtual uint64_t readNextMicroPC()
     { return cpu->readNextMicroPC(thread->threadId()); }

     virtual void setNextMicroPC(uint64_t val);

     /** Reads a miscellaneous register. */
     virtual MiscReg readMiscRegNoEffect(int misc_reg)
     { return cpu->readMiscRegNoEffect(misc_reg, thread->threadId()); }

     /** Reads a misc. register, including any side-effects the
      * read might have as defined by the architecture. */
     virtual MiscReg readMiscReg(int misc_reg)
     { return cpu->readMiscReg(misc_reg, thread->threadId()); }

     /** Sets a misc. register. */
     virtual void setMiscRegNoEffect(int misc_reg, const MiscReg &val);

     /** Sets a misc. register, including any side-effects the
      * write might have as defined by the architecture. */
     virtual void setMiscReg(int misc_reg, const MiscReg &val);

     virtual int flattenIntIndex(int reg);
     virtual int flattenFloatIndex(int reg);

     /** Returns the number of consecutive store conditional failures. */
     // @todo: Figure out where these store cond failures should go.
     virtual unsigned readStCondFailures()
     { return thread->storeCondFailures; }

     /** Sets the number of consecutive store conditional failures. */
     virtual void setStCondFailures(unsigned sc_failures)
     { thread->storeCondFailures = sc_failures; }

     // Only really makes sense for old CPU model.  Lots of code
     // outside the CPU still checks this function, so it will
     // always return false to keep everything working.
     /** Checks if the thread is misspeculating.  Because it is
      * very difficult to determine if the thread is
      * misspeculating, this is set as false. */
     virtual bool misspeculating() { return false; }

 #if !FULL_SYSTEM
     /** Executes a syscall in SE mode. */
     virtual void syscall(int64_t callnum)
     { return cpu->syscall(callnum, thread->threadId()); }

     /** Reads the funcExeInst counter. */
     virtual Counter readFuncExeInst() { return thread->funcExeInst; }
 #else
     /** Returns pointer to the quiesce event. */
     virtual EndQuiesceEvent *getQuiesceEvent()
     {
         return this->thread->quiesceEvent;
     }
 #endif

     virtual uint64_t readNextNPC()
     {
         return this->cpu->readNextNPC(this->thread->threadId());
     }

     virtual void setNextNPC(uint64_t val)
     {
         this->cpu->setNextNPC(val, this->thread->threadId());
     }
 };

 #endif
	/*
	* Copyright (c) 2004-2006 The Regents of The University of Michigan
	* All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions are
	* met: redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer;
	* redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution;
	* neither the name of the copyright holders nor the names of its
	* contributors may be used to endorse or promote products derived from
	* this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*
	* Authors: Kevin Lim
	*/

	#ifndef __CPU_O3_THREAD_CONTEXT_HH__
	#define __CPU_O3_THREAD_CONTEXT_HH__

	#include "cpu/thread_context.hh"
	#include "cpu/o3/isa_specific.hh"

	class EndQuiesceEvent;
	namespace Kernel {
	class Statistics;
	};

	class TranslatingPort;

	/**
	* Derived ThreadContext class for use with the O3CPU. It
	* provides the interface for any external objects to access a
	* single thread's state and some general CPU state. Any time
	* external objects try to update state through this interface,
	* the CPU will create an event to squash all in-flight
	* instructions in order to ensure state is maintained correctly.
	* It must be defined specifically for the O3CPU because
	* not all architectural state is located within the O3ThreadState
	* (such as the commit PC, and registers), and specific actions
	* must be taken when using this interface (such as squashing all
	* in-flight instructions when doing a write to this interface).
	*/
	template <class Impl>
	class O3ThreadContext : public ThreadContext
	{
	public:
	typedef typename Impl::O3CPU O3CPU;

	/** Pointer to the CPU. */
	O3CPU *cpu;

	/** Pointer to the thread state that this TC corrseponds to. */
	O3ThreadState<Impl> *thread;

	/** Returns a pointer to the ITB. */
	TheISA::TLB *getITBPtr() { return cpu->itb; }

	/** Returns a pointer to the DTB. */
	TheISA::TLB *getDTBPtr() { return cpu->dtb; }

	/** Returns a pointer to this CPU. */
	virtual BaseCPU *getCpuPtr() { return cpu; }

	/** Reads this CPU's ID. */
	virtual int cpuId() { return cpu->cpuId(); }

	virtual int contextId() { return thread->contextId(); }

	virtual void setContextId(int id) { thread->setContextId(id); }

	/** Returns this thread's ID number. */
	virtual int threadId() { return thread->threadId(); }
	virtual void setThreadId(int id) { return thread->setThreadId(id); }

	/** Returns a pointer to the system. */
	virtual System *getSystemPtr() { return cpu->system; }

	#if FULL_SYSTEM
	/** Returns a pointer to physical memory. */
	virtual PhysicalMemory *getPhysMemPtr() { return cpu->physmem; }

	/** Returns a pointer to this thread's kernel statistics. */
	virtual TheISA::Kernel::Statistics *getKernelStats()
	{ return thread->kernelStats; }

	virtual FunctionalPort *getPhysPort() { return thread->getPhysPort(); }

	virtual VirtualPort *getVirtPort();

	virtual void connectMemPorts(ThreadContext *tc) { thread->connectMemPorts(tc); }
	#else
	virtual TranslatingPort *getMemPort() { return thread->getMemPort(); }

	/** Returns a pointer to this thread's process. */
	virtual Process *getProcessPtr() { return thread->getProcessPtr(); }
	#endif
	/** Returns this thread's status. */
	virtual Status status() const { return thread->status(); }

	/** Sets this thread's status. */
	virtual void setStatus(Status new_status)
	{ thread->setStatus(new_status); }

	/** Set the status to Active. Optional delay indicates number of
	* cycles to wait before beginning execution. */
	virtual void activate(int delay = 1);

	/** Set the status to Suspended. */
	virtual void suspend(int delay = 0);

	/** Set the status to Halted. */
	virtual void halt(int delay = 0);

	#if FULL_SYSTEM
	/** Dumps the function profiling information.
	* @todo: Implement.
	*/
	virtual void dumpFuncProfile();
	#endif
	/** Takes over execution of a thread from another CPU. */
	virtual void takeOverFrom(ThreadContext *old_context);

	/** Registers statistics associated with this TC. */
	virtual void regStats(const std::string &name);

	/** Serializes state. */
	virtual void serialize(std::ostream &os);
	/** Unserializes state. */
	virtual void unserialize(Checkpoint *cp, const std::string &section);

	#if FULL_SYSTEM
	/** Reads the last tick that this thread was activated on. */
	virtual Tick readLastActivate();
	/** Reads the last tick that this thread was suspended on. */
	virtual Tick readLastSuspend();

	/** Clears the function profiling information. */
	virtual void profileClear();
	/** Samples the function profiling information. */
	virtual void profileSample();
	#endif
	/** Returns the instruction this thread is currently committing.
	* Only used when an instruction faults.
	*/
	virtual TheISA::MachInst getInst();

	/** Copies the architectural registers from another TC into this TC. */
	virtual void copyArchRegs(ThreadContext *tc);

	/** Resets all architectural registers to 0. */
	virtual void clearArchRegs();

	/** Reads an integer register. */
	virtual uint64_t readIntReg(int reg_idx);

	virtual FloatReg readFloatReg(int reg_idx);

	virtual FloatRegBits readFloatRegBits(int reg_idx);

	/** Sets an integer register to a value. */
	virtual void setIntReg(int reg_idx, uint64_t val);

	virtual void setFloatReg(int reg_idx, FloatReg val);

	virtual void setFloatRegBits(int reg_idx, FloatRegBits val);

	/** Reads this thread's PC. */
	virtual uint64_t readPC()
	{ return cpu->readPC(thread->threadId()); }

	/** Sets this thread's PC. */
	virtual void setPC(uint64_t val);

	/** Reads this thread's next PC. */
	virtual uint64_t readNextPC()
	{ return cpu->readNextPC(thread->threadId()); }

	/** Sets this thread's next PC. */
	virtual void setNextPC(uint64_t val);

	virtual uint64_t readMicroPC()
	{ return cpu->readMicroPC(thread->threadId()); }

	virtual void setMicroPC(uint64_t val);

	virtual uint64_t readNextMicroPC()
	{ return cpu->readNextMicroPC(thread->threadId()); }

	virtual void setNextMicroPC(uint64_t val);

	/** Reads a miscellaneous register. */
	virtual MiscReg readMiscRegNoEffect(int misc_reg)
	{ return cpu->readMiscRegNoEffect(misc_reg, thread->threadId()); }

	/** Reads a misc. register, including any side-effects the
	* read might have as defined by the architecture. */
	virtual MiscReg readMiscReg(int misc_reg)
	{ return cpu->readMiscReg(misc_reg, thread->threadId()); }

	/** Sets a misc. register. */
	virtual void setMiscRegNoEffect(int misc_reg, const MiscReg &val);

	/** Sets a misc. register, including any side-effects the
	* write might have as defined by the architecture. */
	virtual void setMiscReg(int misc_reg, const MiscReg &val);

	virtual int flattenIntIndex(int reg);
	virtual int flattenFloatIndex(int reg);

	/** Returns the number of consecutive store conditional failures. */
	// @todo: Figure out where these store cond failures should go.
	virtual unsigned readStCondFailures()
	{ return thread->storeCondFailures; }

	/** Sets the number of consecutive store conditional failures. */
	virtual void setStCondFailures(unsigned sc_failures)
	{ thread->storeCondFailures = sc_failures; }

	// Only really makes sense for old CPU model. Lots of code
	// outside the CPU still checks this function, so it will
	// always return false to keep everything working.
	/** Checks if the thread is misspeculating. Because it is
	* very difficult to determine if the thread is
	* misspeculating, this is set as false. */
	virtual bool misspeculating() { return false; }

	#if !FULL_SYSTEM
	/** Executes a syscall in SE mode. */
	virtual void syscall(int64_t callnum)
	{ return cpu->syscall(callnum, thread->threadId()); }

	/** Reads the funcExeInst counter. */
	virtual Counter readFuncExeInst() { return thread->funcExeInst; }
	#else
	/** Returns pointer to the quiesce event. */
	virtual EndQuiesceEvent *getQuiesceEvent()
	{
	return this->thread->quiesceEvent;
	}
	#endif

	virtual uint64_t readNextNPC()
	{
	return this->cpu->readNextNPC(this->thread->threadId());
	}

	virtual void setNextNPC(uint64_t val)
	{
	this->cpu->setNextNPC(val, this->thread->threadId());
	}
	};

	#endif