1/*
2 * Copyright (c) 2002-2005 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: Steve Reinhardt
29 */
30
31#include "arch/utility.hh"
32#include "cpu/exetrace.hh"
33#include "cpu/simple/atomic.hh"
34#include "mem/packet_impl.hh"
35#include "sim/builder.hh"
36#include "sim/system.hh"
37
38using namespace std;
39using namespace TheISA;
40
41AtomicSimpleCPU::TickEvent::TickEvent(AtomicSimpleCPU *c)
42 : Event(&mainEventQueue, CPU_Tick_Pri), cpu(c)
43{
44}
45
46
47void
48AtomicSimpleCPU::TickEvent::process()
49{
50 cpu->tick();
51}
52
53const char *
54AtomicSimpleCPU::TickEvent::description()
55{
56 return "AtomicSimpleCPU tick event";
57}
58
59Port *
60AtomicSimpleCPU::getPort(const std::string &if_name, int idx)
61{
62 if (if_name == "dcache_port")
63 return &dcachePort;
64 else if (if_name == "icache_port")
65 return &icachePort;
66 else
67 panic("No Such Port\n");
68}
69
70void
71AtomicSimpleCPU::init()
72{
73 //Create Memory Ports (conect them up)
74// Port *mem_dport = mem->getPort("");
75// dcachePort.setPeer(mem_dport);
76// mem_dport->setPeer(&dcachePort);
77
78// Port *mem_iport = mem->getPort("");
79// icachePort.setPeer(mem_iport);
80// mem_iport->setPeer(&icachePort);
81
82 BaseCPU::init();
83#if FULL_SYSTEM
84 for (int i = 0; i < threadContexts.size(); ++i) {
85 ThreadContext *tc = threadContexts[i];
86
87 // initialize CPU, including PC
88 TheISA::initCPU(tc, tc->readCpuId());
89 }
90#endif
91}
92
93bool
94AtomicSimpleCPU::CpuPort::recvTiming(Packet *pkt)
95{
96 panic("AtomicSimpleCPU doesn't expect recvAtomic callback!");
97 return true;
98}
99
100Tick
101AtomicSimpleCPU::CpuPort::recvAtomic(Packet *pkt)
102{
103 panic("AtomicSimpleCPU doesn't expect recvAtomic callback!");
104 return curTick;
105}
106
107void
108AtomicSimpleCPU::CpuPort::recvFunctional(Packet *pkt)
109{
110 panic("AtomicSimpleCPU doesn't expect recvFunctional callback!");
111}
112
113void
114AtomicSimpleCPU::CpuPort::recvStatusChange(Status status)
115{
116 if (status == RangeChange)
117 return;
118
119 panic("AtomicSimpleCPU doesn't expect recvStatusChange callback!");
120}
121
122void
123AtomicSimpleCPU::CpuPort::recvRetry()
124{
125 panic("AtomicSimpleCPU doesn't expect recvRetry callback!");
126}
127
128
129AtomicSimpleCPU::AtomicSimpleCPU(Params *p)
130 : BaseSimpleCPU(p), tickEvent(this),
131 width(p->width), simulate_stalls(p->simulate_stalls),
132 icachePort(name() + "-iport", this), dcachePort(name() + "-iport", this)
133{
134 _status = Idle;
135
136 // @todo fix me and get the real cpu id & thread number!!!
137 ifetch_req = new Request();
138 ifetch_req->setThreadContext(0,0); //Need CPU/Thread IDS HERE
139 ifetch_pkt = new Packet(ifetch_req, Packet::ReadReq, Packet::Broadcast);
140 ifetch_pkt->dataStatic(&inst);
141
142 data_read_req = new Request();
143 data_read_req->setThreadContext(0,0); //Need CPU/Thread IDS HERE
144 data_read_pkt = new Packet(data_read_req, Packet::ReadReq,
145 Packet::Broadcast);
146 data_read_pkt->dataStatic(&dataReg);
147
148 data_write_req = new Request();
149 data_write_req->setThreadContext(0,0); //Need CPU/Thread IDS HERE
150 data_write_pkt = new Packet(data_write_req, Packet::WriteReq,
151 Packet::Broadcast);
152}
153
154
155AtomicSimpleCPU::~AtomicSimpleCPU()
156{
157}
158
159void
160AtomicSimpleCPU::serialize(ostream &os)
161{
162 SERIALIZE_ENUM(_status);
163 BaseSimpleCPU::serialize(os);
164 nameOut(os, csprintf("%s.tickEvent", name()));
165 tickEvent.serialize(os);
166}
167
168void
169AtomicSimpleCPU::unserialize(Checkpoint *cp, const string &section)
170{
171 UNSERIALIZE_ENUM(_status);
172 BaseSimpleCPU::unserialize(cp, section);
173 tickEvent.unserialize(cp, csprintf("%s.tickEvent", section));
174}
175
176void
177AtomicSimpleCPU::resume()
178{
179 assert(system->getMemoryMode() == System::Atomic);
180 changeState(SimObject::Running);
181}
182
183void
184AtomicSimpleCPU::switchOut()
185{
186 assert(status() == Running || status() == Idle);
187 _status = SwitchedOut;
188
189 tickEvent.squash();
190}
191
192
193void
194AtomicSimpleCPU::takeOverFrom(BaseCPU *oldCPU)
195{
196 BaseCPU::takeOverFrom(oldCPU);
197
198 assert(!tickEvent.scheduled());
199
200 // if any of this CPU's ThreadContexts are active, mark the CPU as
201 // running and schedule its tick event.
202 for (int i = 0; i < threadContexts.size(); ++i) {
203 ThreadContext *tc = threadContexts[i];
204 if (tc->status() == ThreadContext::Active && _status != Running) {
205 _status = Running;
206 tickEvent.schedule(curTick);
207 break;
208 }
209 }
210}
211
212
213void
214AtomicSimpleCPU::activateContext(int thread_num, int delay)
215{
216 assert(thread_num == 0);
217 assert(thread);
218
219 assert(_status == Idle);
220 assert(!tickEvent.scheduled());
221
222 notIdleFraction++;
223 tickEvent.schedule(curTick + cycles(delay));
224 _status = Running;
225}
226
227
228void
229AtomicSimpleCPU::suspendContext(int thread_num)
230{
231 assert(thread_num == 0);
232 assert(thread);
233
234 assert(_status == Running);
235
236 // tick event may not be scheduled if this gets called from inside
237 // an instruction's execution, e.g. "quiesce"
238 if (tickEvent.scheduled())
239 tickEvent.deschedule();
240
241 notIdleFraction--;
242 _status = Idle;
243}
244
245
246template <class T>
247Fault
248AtomicSimpleCPU::read(Addr addr, T &data, unsigned flags)
249{
250 data_read_req->setVirt(0, addr, sizeof(T), flags, thread->readPC());
251
252 if (traceData) {
253 traceData->setAddr(addr);
254 }
255
256 // translate to physical address
257 Fault fault = thread->translateDataReadReq(data_read_req);
258
259 // Now do the access.
260 if (fault == NoFault) {
261 data_read_pkt->reinitFromRequest();
262
263 dcache_latency = dcachePort.sendAtomic(data_read_pkt);
264 dcache_access = true;
265
266 assert(data_read_pkt->result == Packet::Success);
267 data = data_read_pkt->get<T>();
268
269 }
270
271 // This will need a new way to tell if it has a dcache attached.
272 if (data_read_req->getFlags() & UNCACHEABLE)
273 recordEvent("Uncached Read");
274
275 return fault;
276}
277
278#ifndef DOXYGEN_SHOULD_SKIP_THIS
279
280template
281Fault
282AtomicSimpleCPU::read(Addr addr, uint64_t &data, unsigned flags);
283
284template
285Fault
286AtomicSimpleCPU::read(Addr addr, uint32_t &data, unsigned flags);
287
288template
289Fault
290AtomicSimpleCPU::read(Addr addr, uint16_t &data, unsigned flags);
291
292template
293Fault
294AtomicSimpleCPU::read(Addr addr, uint8_t &data, unsigned flags);
295
296#endif //DOXYGEN_SHOULD_SKIP_THIS
297
298template<>
299Fault
300AtomicSimpleCPU::read(Addr addr, double &data, unsigned flags)
301{
302 return read(addr, *(uint64_t*)&data, flags);
303}
304
305template<>
306Fault
307AtomicSimpleCPU::read(Addr addr, float &data, unsigned flags)
308{
309 return read(addr, *(uint32_t*)&data, flags);
310}
311
312
313template<>
314Fault
315AtomicSimpleCPU::read(Addr addr, int32_t &data, unsigned flags)
316{
317 return read(addr, (uint32_t&)data, flags);
318}
319
320
321template <class T>
322Fault
323AtomicSimpleCPU::write(T data, Addr addr, unsigned flags, uint64_t *res)
324{
325 data_write_req->setVirt(0, addr, sizeof(T), flags, thread->readPC());
326
327 if (traceData) {
328 traceData->setAddr(addr);
329 }
330
331 // translate to physical address
332 Fault fault = thread->translateDataWriteReq(data_write_req);
333
334 // Now do the access.
335 if (fault == NoFault) {
336 data = htog(data);
337 data_write_pkt->reinitFromRequest();
338 data_write_pkt->dataStatic(&data);
339
340 dcache_latency = dcachePort.sendAtomic(data_write_pkt);
341 dcache_access = true;
342
343 assert(data_write_pkt->result == Packet::Success);
344
345 if (res && data_write_req->getFlags() & LOCKED) {
346 *res = data_write_req->getScResult();
347 }
348 }
349
350 // This will need a new way to tell if it's hooked up to a cache or not.
351 if (data_write_req->getFlags() & UNCACHEABLE)
352 recordEvent("Uncached Write");
353
354 // If the write needs to have a fault on the access, consider calling
355 // changeStatus() and changing it to "bad addr write" or something.
356 return fault;
357}
358
359
360#ifndef DOXYGEN_SHOULD_SKIP_THIS
361template
362Fault
363AtomicSimpleCPU::write(uint64_t data, Addr addr,
364 unsigned flags, uint64_t *res);
365
366template
367Fault
368AtomicSimpleCPU::write(uint32_t data, Addr addr,
369 unsigned flags, uint64_t *res);
370
371template
372Fault
373AtomicSimpleCPU::write(uint16_t data, Addr addr,
374 unsigned flags, uint64_t *res);
375
376template
377Fault
378AtomicSimpleCPU::write(uint8_t data, Addr addr,
379 unsigned flags, uint64_t *res);
380
381#endif //DOXYGEN_SHOULD_SKIP_THIS
382
383template<>
384Fault
385AtomicSimpleCPU::write(double data, Addr addr, unsigned flags, uint64_t *res)
386{
387 return write(*(uint64_t*)&data, addr, flags, res);
388}
389
390template<>
391Fault
392AtomicSimpleCPU::write(float data, Addr addr, unsigned flags, uint64_t *res)
393{
394 return write(*(uint32_t*)&data, addr, flags, res);
395}
396
397
398template<>
399Fault
400AtomicSimpleCPU::write(int32_t data, Addr addr, unsigned flags, uint64_t *res)
401{
402 return write((uint32_t)data, addr, flags, res);
403}
404
405
406void
407AtomicSimpleCPU::tick()
408{
409 Tick latency = cycles(1); // instruction takes one cycle by default
410
411 for (int i = 0; i < width; ++i) {
412 numCycles++;
413
414 checkForInterrupts();
415
416 Fault fault = setupFetchRequest(ifetch_req);
417
418 if (fault == NoFault) {
419 ifetch_pkt->reinitFromRequest();
420
421 Tick icache_latency = icachePort.sendAtomic(ifetch_pkt);
422 // ifetch_req is initialized to read the instruction directly
423 // into the CPU object's inst field.
424
425 dcache_access = false; // assume no dcache access
426 preExecute();
427 fault = curStaticInst->execute(this, traceData);
428 postExecute();
429
430 if (simulate_stalls) {
431 Tick icache_stall = icache_latency - cycles(1);
432 Tick dcache_stall =
433 dcache_access ? dcache_latency - cycles(1) : 0;
434 Tick stall_cycles = (icache_stall + dcache_stall) / cycles(1);
435 if (cycles(stall_cycles) < (icache_stall + dcache_stall))
436 latency += cycles(stall_cycles+1);
437 else
438 latency += cycles(stall_cycles);
439 }
440
441 }
442
443 advancePC(fault);
444 }
445
446 if (_status != Idle)
447 tickEvent.schedule(curTick + latency);
448}
449
450
451////////////////////////////////////////////////////////////////////////
452//
453// AtomicSimpleCPU Simulation Object
454//
455BEGIN_DECLARE_SIM_OBJECT_PARAMS(AtomicSimpleCPU)
456
457 Param<Counter> max_insts_any_thread;
458 Param<Counter> max_insts_all_threads;
459 Param<Counter> max_loads_any_thread;
460 Param<Counter> max_loads_all_threads;
461 SimObjectParam<MemObject *> mem;
462 SimObjectParam<System *> system;
463
464#if FULL_SYSTEM
465 SimObjectParam<AlphaITB *> itb;
466 SimObjectParam<AlphaDTB *> dtb;
467 Param<int> cpu_id;
468 Param<Tick> profile;
469#else
470 SimObjectParam<Process *> workload;
471#endif // FULL_SYSTEM
472
473 Param<int> clock;
474
475 Param<bool> defer_registration;
476 Param<int> width;
477 Param<bool> function_trace;
478 Param<Tick> function_trace_start;
479 Param<bool> simulate_stalls;
480
481END_DECLARE_SIM_OBJECT_PARAMS(AtomicSimpleCPU)
482
483BEGIN_INIT_SIM_OBJECT_PARAMS(AtomicSimpleCPU)
484
485 INIT_PARAM(max_insts_any_thread,
486 "terminate when any thread reaches this inst count"),
487 INIT_PARAM(max_insts_all_threads,
488 "terminate when all threads have reached this inst count"),
489 INIT_PARAM(max_loads_any_thread,
490 "terminate when any thread reaches this load count"),
491 INIT_PARAM(max_loads_all_threads,
492 "terminate when all threads have reached this load count"),
493 INIT_PARAM(mem, "memory"),
494 INIT_PARAM(system, "system object"),
495
496#if FULL_SYSTEM
497 INIT_PARAM(itb, "Instruction TLB"),
498 INIT_PARAM(dtb, "Data TLB"),
499 INIT_PARAM(cpu_id, "processor ID"),
500 INIT_PARAM(profile, ""),
501#else
502 INIT_PARAM(workload, "processes to run"),
503#endif // FULL_SYSTEM
504
505 INIT_PARAM(clock, "clock speed"),
506 INIT_PARAM(defer_registration, "defer system registration (for sampling)"),
507 INIT_PARAM(width, "cpu width"),
508 INIT_PARAM(function_trace, "Enable function trace"),
509 INIT_PARAM(function_trace_start, "Cycle to start function trace"),
510 INIT_PARAM(simulate_stalls, "Simulate cache stall cycles")
511
512END_INIT_SIM_OBJECT_PARAMS(AtomicSimpleCPU)
513
514
515CREATE_SIM_OBJECT(AtomicSimpleCPU)
516{
517 AtomicSimpleCPU::Params *params = new AtomicSimpleCPU::Params();
518 params->name = getInstanceName();
519 params->numberOfThreads = 1;
520 params->max_insts_any_thread = max_insts_any_thread;
521 params->max_insts_all_threads = max_insts_all_threads;
522 params->max_loads_any_thread = max_loads_any_thread;
523 params->max_loads_all_threads = max_loads_all_threads;
524 params->deferRegistration = defer_registration;
525 params->clock = clock;
526 params->functionTrace = function_trace;
527 params->functionTraceStart = function_trace_start;
528 params->width = width;
529 params->simulate_stalls = simulate_stalls;
530 params->mem = mem;
531 params->system = system;
532
533#if FULL_SYSTEM
534 params->itb = itb;
535 params->dtb = dtb;
536 params->cpu_id = cpu_id;
537 params->profile = profile;
538#else
539 params->process = workload;
540#endif
541
542 AtomicSimpleCPU *cpu = new AtomicSimpleCPU(params);
543 return cpu;
544}
545
546REGISTER_SIM_OBJECT("AtomicSimpleCPU", AtomicSimpleCPU)
547