2 * Copyright (c) 2011-2013 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * Copyright (c) 2011 Regents of the University of California
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * Authors: Steve Reinhardt
46 #ifndef __CPU_BASE_HH__
47 #define __CPU_BASE_HH__
51 // Before we do anything else, check if this build is the NULL ISA,
52 // and if so stop here
53 #include "config/the_isa.hh"
54 #if THE_ISA == NULL_ISA
55 #include "arch/null/cpu_dummy.hh"
57 #include "arch/interrupts.hh"
58 #include "arch/isa_traits.hh"
59 #include "arch/microcode_rom.hh"
60 #include "base/statistics.hh"
61 #include "mem/mem_object.hh"
62 #include "sim/eventq.hh"
63 #include "sim/full_system.hh"
64 #include "sim/insttracer.hh"
65 #include "sim/probe/pmu.hh"
66 #include "sim/system.hh"
67 #include "debug/Mwait.hh"
77 bool doMonitor(PacketPtr pkt);
83 bool waiting; // 0=normal, 1=mwaiting
87 class CPUProgressEvent : public Event
96 CPUProgressEvent(BaseCPU *_cpu, Tick ival = 0);
100 void interval(Tick ival) { _interval = ival; }
101 Tick interval() { return _interval; }
103 void repeatEvent(bool repeat) { _repeatEvent = repeat; }
105 virtual const char *description() const;
108 class BaseCPU : public MemObject
112 /// Instruction count used for SPARC misc register
113 /// @todo unify this with the counters that cpus individually keep
116 // every cpu has an id, put it in the base cpu
117 // Set at initialization, only time a cpuId might change is during a
118 // takeover (which should be done from within the BaseCPU anyway,
119 // therefore no setCpuId() method is provided
122 /** Each cpu will have a socket ID that corresponds to its physical location
123 * in the system. This is usually used to bucket cpu cores under single DVFS
124 * domain. This information may also be required by the OS to identify the
125 * cpu core grouping (as in the case of ARM via MPIDR register)
127 const uint32_t _socketId;
129 /** instruction side request id that must be placed in all requests */
130 MasterID _instMasterId;
132 /** data side request id that must be placed in all requests */
133 MasterID _dataMasterId;
135 /** An intrenal representation of a task identifier within gem5. This is
136 * used so the CPU can add which taskId (which is an internal representation
137 * of the OS process ID) to each request so components in the memory system
138 * can track which process IDs are ultimately interacting with them
142 /** The current OS process ID that is executing on this processor. This is
143 * used to generate a taskId */
146 /** Is the CPU switched out or active? */
149 /** Cache the cache line size that we get from the system */
150 const unsigned int _cacheLineSize;
155 * Purely virtual method that returns a reference to the data
156 * port. All subclasses must implement this method.
158 * @return a reference to the data port
160 virtual MasterPort &getDataPort() = 0;
163 * Purely virtual method that returns a reference to the instruction
164 * port. All subclasses must implement this method.
166 * @return a reference to the instruction port
168 virtual MasterPort &getInstPort() = 0;
170 /** Reads this CPU's ID. */
171 int cpuId() const { return _cpuId; }
173 /** Reads this CPU's Socket ID. */
174 uint32_t socketId() const { return _socketId; }
176 /** Reads this CPU's unique data requestor ID */
177 MasterID dataMasterId() { return _dataMasterId; }
178 /** Reads this CPU's unique instruction requestor ID */
179 MasterID instMasterId() { return _instMasterId; }
182 * Get a master port on this CPU. All CPUs have a data and
183 * instruction port, and this method uses getDataPort and
184 * getInstPort of the subclasses to resolve the two ports.
186 * @param if_name the port name
187 * @param idx ignored index
189 * @return a reference to the port with the given name
191 BaseMasterPort &getMasterPort(const std::string &if_name,
192 PortID idx = InvalidPortID) override;
194 /** Get cpu task id */
195 uint32_t taskId() const { return _taskId; }
196 /** Set cpu task id */
197 void taskId(uint32_t id) { _taskId = id; }
199 uint32_t getPid() const { return _pid; }
200 void setPid(uint32_t pid) { _pid = pid; }
202 inline void workItemBegin() { numWorkItemsStarted++; }
203 inline void workItemEnd() { numWorkItemsCompleted++; }
204 // @todo remove me after debugging with legion done
205 Tick instCount() { return instCnt; }
207 TheISA::MicrocodeRom microcodeRom;
210 std::vector<TheISA::Interrupts*> interrupts;
214 getInterruptController(ThreadID tid)
216 if (interrupts.empty())
219 assert(interrupts.size() > tid);
220 return interrupts[tid];
223 virtual void wakeup(ThreadID tid) = 0;
226 postInterrupt(ThreadID tid, int int_num, int index)
228 interrupts[tid]->post(int_num, index);
234 clearInterrupt(ThreadID tid, int int_num, int index)
236 interrupts[tid]->clear(int_num, index);
240 clearInterrupts(ThreadID tid)
242 interrupts[tid]->clearAll();
246 checkInterrupts(ThreadContext *tc) const
248 return FullSystem && interrupts[tc->threadId()]->checkInterrupts(tc);
251 class ProfileEvent : public Event
258 ProfileEvent(BaseCPU *cpu, Tick interval);
261 ProfileEvent *profileEvent;
264 std::vector<ThreadContext *> threadContexts;
266 Trace::InstTracer * tracer;
271 /** Invalid or unknown Pid. Possible when operating system is not present
272 * or has not assigned a pid yet */
273 static const uint32_t invldPid = std::numeric_limits<uint32_t>::max();
275 // Mask to align PCs to MachInst sized boundaries
276 static const Addr PCMask = ~((Addr)sizeof(TheISA::MachInst) - 1);
278 /// Provide access to the tracer pointer
279 Trace::InstTracer * getTracer() { return tracer; }
281 /// Notify the CPU that the indicated context is now active.
282 virtual void activateContext(ThreadID thread_num);
284 /// Notify the CPU that the indicated context is now suspended.
285 /// Check if possible to enter a lower power state
286 virtual void suspendContext(ThreadID thread_num);
288 /// Notify the CPU that the indicated context is now halted.
289 virtual void haltContext(ThreadID thread_num) {}
291 /// Given a Thread Context pointer return the thread num
292 int findContext(ThreadContext *tc);
294 /// Given a thread num get tho thread context for it
295 virtual ThreadContext *getContext(int tn) { return threadContexts[tn]; }
297 /// Get the number of thread contexts available
298 unsigned numContexts() { return threadContexts.size(); }
300 /// Convert ContextID to threadID
301 ThreadID contextToThread(ContextID cid)
302 { return static_cast<ThreadID>(cid - threadContexts[0]->contextId()); }
305 typedef BaseCPUParams Params;
306 const Params *params() const
307 { return reinterpret_cast<const Params *>(_params); }
308 BaseCPU(Params *params, bool is_checker = false);
311 void init() override;
312 void startup() override;
313 void regStats() override;
315 void regProbePoints() override;
317 void registerThreadContexts();
320 * Prepare for another CPU to take over execution.
322 * When this method exits, all internal state should have been
323 * flushed. After the method returns, the simulator calls
324 * takeOverFrom() on the new CPU with this CPU as its parameter.
326 virtual void switchOut();
329 * Load the state of a CPU from the previous CPU object, invoked
330 * on all new CPUs that are about to be switched in.
332 * A CPU model implementing this method is expected to initialize
333 * its state from the old CPU and connect its memory (unless they
334 * are already connected) to the memories connected to the old
337 * @param cpu CPU to initialize read state from.
339 virtual void takeOverFrom(BaseCPU *cpu);
342 * Flush all TLBs in the CPU.
344 * This method is mainly used to flush stale translations when
345 * switching CPUs. It is also exported to the Python world to
346 * allow it to request a TLB flush after draining the CPU to make
347 * it easier to compare traces when debugging
348 * handover/checkpointing.
353 * Determine if the CPU is switched out.
355 * @return True if the CPU is switched out, false otherwise.
357 bool switchedOut() const { return _switchedOut; }
360 * Verify that the system is in a memory mode supported by the
363 * Implementations are expected to query the system for the
364 * current memory mode and ensure that it is what the CPU model
365 * expects. If the check fails, the implementation should
366 * terminate the simulation using fatal().
368 virtual void verifyMemoryMode() const { };
371 * Number of threads we're actually simulating (<= SMT_MAX_THREADS).
372 * This is a constant for the duration of the simulation.
377 * Vector of per-thread instruction-based event queues. Used for
378 * scheduling events based on number of instructions committed by
379 * a particular thread.
381 EventQueue **comInstEventQueue;
384 * Vector of per-thread load-based event queues. Used for
385 * scheduling events based on number of loads committed by
386 *a particular thread.
388 EventQueue **comLoadEventQueue;
393 * Get the cache line size of the system.
395 inline unsigned int cacheLineSize() const { return _cacheLineSize; }
398 * Serialize this object to the given output stream.
400 * @note CPU models should normally overload the serializeThread()
401 * method instead of the serialize() method as this provides a
402 * uniform data format for all CPU models and promotes better code
405 * @param os The stream to serialize to.
407 void serialize(CheckpointOut &cp) const override;
410 * Reconstruct the state of this object from a checkpoint.
412 * @note CPU models should normally overload the
413 * unserializeThread() method instead of the unserialize() method
414 * as this provides a uniform data format for all CPU models and
415 * promotes better code reuse.
417 * @param cp The checkpoint use.
418 * @param section The section name of this object.
420 void unserialize(CheckpointIn &cp) override;
423 * Serialize a single thread.
425 * @param os The stream to serialize to.
426 * @param tid ID of the current thread.
428 virtual void serializeThread(CheckpointOut &cp, ThreadID tid) const {};
431 * Unserialize one thread.
433 * @param cp The checkpoint use.
434 * @param section The section name of this thread.
435 * @param tid ID of the current thread.
437 virtual void unserializeThread(CheckpointIn &cp, ThreadID tid) {};
439 virtual Counter totalInsts() const = 0;
441 virtual Counter totalOps() const = 0;
444 * Schedule an event that exits the simulation loops after a
445 * predefined number of instructions.
447 * This method is usually called from the configuration script to
448 * get an exit event some time in the future. It is typically used
449 * when the script wants to simulate for a specific number of
450 * instructions rather than ticks.
452 * @param tid Thread monitor.
453 * @param insts Number of instructions into the future.
454 * @param cause Cause to signal in the exit event.
456 void scheduleInstStop(ThreadID tid, Counter insts, const char *cause);
459 * Schedule an event that exits the simulation loops after a
460 * predefined number of load operations.
462 * This method is usually called from the configuration script to
463 * get an exit event some time in the future. It is typically used
464 * when the script wants to simulate for a specific number of
465 * loads rather than ticks.
467 * @param tid Thread monitor.
468 * @param loads Number of load instructions into the future.
469 * @param cause Cause to signal in the exit event.
471 void scheduleLoadStop(ThreadID tid, Counter loads, const char *cause);
474 * Get the number of instructions executed by the specified thread
475 * on this CPU. Used by Python to control simulation.
477 * @param tid Thread monitor
478 * @return Number of instructions executed
480 uint64_t getCurrentInstCount(ThreadID tid);
485 * @name PMU Probe points.
489 * Helper method to trigger PMU probes for a committed
492 * @param inst Instruction that just committed
494 virtual void probeInstCommit(const StaticInstPtr &inst);
497 * Helper method to instantiate probe points belonging to this
500 * @param name Name of the probe point.
501 * @return A unique_ptr to the new probe point.
503 ProbePoints::PMUUPtr pmuProbePoint(const char *name);
505 /** CPU cycle counter */
506 ProbePoints::PMUUPtr ppCycles;
509 * Instruction commit probe point.
511 * This probe point is triggered whenever one or more instructions
512 * are committed. It is normally triggered once for every
513 * instruction. However, CPU models committing bundles of
514 * instructions may call notify once for the entire bundle.
516 ProbePoints::PMUUPtr ppRetiredInsts;
518 /** Retired load instructions */
519 ProbePoints::PMUUPtr ppRetiredLoads;
520 /** Retired store instructions */
521 ProbePoints::PMUUPtr ppRetiredStores;
523 /** Retired branches (any type) */
524 ProbePoints::PMUUPtr ppRetiredBranches;
532 bool functionTracingEnabled;
533 std::ostream *functionTraceStream;
534 Addr currentFunctionStart;
535 Addr currentFunctionEnd;
536 Tick functionEntryTick;
537 void enableFunctionTrace();
538 void traceFunctionsInternal(Addr pc);
541 static std::vector<BaseCPU *> cpuList; //!< Static global cpu list
544 void traceFunctions(Addr pc)
546 if (functionTracingEnabled)
547 traceFunctionsInternal(pc);
550 static int numSimulatedCPUs() { return cpuList.size(); }
551 static Counter numSimulatedInsts()
555 int size = cpuList.size();
556 for (int i = 0; i < size; ++i)
557 total += cpuList[i]->totalInsts();
562 static Counter numSimulatedOps()
566 int size = cpuList.size();
567 for (int i = 0; i < size; ++i)
568 total += cpuList[i]->totalOps();
574 // Number of CPU cycles simulated
575 Stats::Scalar numCycles;
576 Stats::Scalar numWorkItemsStarted;
577 Stats::Scalar numWorkItemsCompleted;
580 std::vector<AddressMonitor> addressMonitor;
583 void armMonitor(ThreadID tid, Addr address);
584 bool mwait(ThreadID tid, PacketPtr pkt);
585 void mwaitAtomic(ThreadID tid, ThreadContext *tc, TheISA::TLB *dtb);
586 AddressMonitor *getCpuAddrMonitor(ThreadID tid)
588 assert(tid < numThreads);
589 return &addressMonitor[tid];
592 Cycles syscallRetryLatency;
595 #endif // THE_ISA == NULL_ISA
597 #endif // __CPU_BASE_HH__