base.cc revision 4495 
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 *          Nathan Binkert
30 */
31
32#include <iostream>
33#include <string>
34#include <sstream>
35
36#include "base/cprintf.hh"
37#include "base/loader/symtab.hh"
38#include "base/misc.hh"
39#include "base/output.hh"
40#include "cpu/base.hh"
41#include "cpu/cpuevent.hh"
42#include "cpu/thread_context.hh"
43#include "cpu/profile.hh"
44#include "sim/sim_exit.hh"
45#include "sim/param.hh"
46#include "sim/process.hh"
47#include "sim/sim_events.hh"
48#include "sim/system.hh"
49
50#include "base/trace.hh"
51
52// Hack
53#include "sim/stat_control.hh"
54
55using namespace std;
56
57vector<BaseCPU *> BaseCPU::cpuList;
58
59// This variable reflects the max number of threads in any CPU.  Be
60// careful to only use it once all the CPUs that you care about have
61// been initialized
62int maxThreadsPerCPU = 1;
63
64CPUProgressEvent::CPUProgressEvent(EventQueue *q, Tick ival,
65                                   BaseCPU *_cpu)
66    : Event(q, Event::Progress_Event_Pri), interval(ival),
67      lastNumInst(0), cpu(_cpu)
68{
69    if (interval)
70        schedule(curTick + interval);
71}
72
73void
74CPUProgressEvent::process()
75{
76    Counter temp = cpu->totalInstructions();
77#ifndef NDEBUG
78    double ipc = double(temp - lastNumInst) / (interval / cpu->cycles(1));
79
80    DPRINTFN("%s progress event, instructions committed: %lli, IPC: %0.8d\n",
81             cpu->name(), temp - lastNumInst, ipc);
82    ipc = 0.0;
83#else
84    cprintf("%lli: %s progress event, instructions committed: %lli\n",
85            curTick, cpu->name(), temp - lastNumInst);
86#endif
87    lastNumInst = temp;
88    schedule(curTick + interval);
89}
90
91const char *
92CPUProgressEvent::description()
93{
94    return "CPU Progress event";
95}
96
97#if FULL_SYSTEM
98BaseCPU::BaseCPU(Params *p)
99    : MemObject(p->name), clock(p->clock), instCnt(0),
100      params(p), number_of_threads(p->numberOfThreads), system(p->system),
101      phase(p->phase)
102#else
103BaseCPU::BaseCPU(Params *p)
104    : MemObject(p->name), clock(p->clock), params(p),
105      number_of_threads(p->numberOfThreads), system(p->system),
106      phase(p->phase)
107#endif
108{
109//    currentTick = curTick;
110    DPRINTF(FullCPU, "BaseCPU: Creating object, mem address %#x.\n", this);
111
112    // add self to global list of CPUs
113    cpuList.push_back(this);
114
115    DPRINTF(FullCPU, "BaseCPU: CPU added to cpuList, mem address %#x.\n",
116            this);
117
118    if (number_of_threads > maxThreadsPerCPU)
119        maxThreadsPerCPU = number_of_threads;
120
121    // allocate per-thread instruction-based event queues
122    comInstEventQueue = new EventQueue *[number_of_threads];
123    for (int i = 0; i < number_of_threads; ++i)
124        comInstEventQueue[i] = new EventQueue("instruction-based event queue");
125
126    //
127    // set up instruction-count-based termination events, if any
128    //
129    if (p->max_insts_any_thread != 0)
130        for (int i = 0; i < number_of_threads; ++i)
131            schedExitSimLoop("a thread reached the max instruction count",
132                             p->max_insts_any_thread, 0,
133                             comInstEventQueue[i]);
134
135    if (p->max_insts_all_threads != 0) {
136        // allocate & initialize shared downcounter: each event will
137        // decrement this when triggered; simulation will terminate
138        // when counter reaches 0
139        int *counter = new int;
140        *counter = number_of_threads;
141        for (int i = 0; i < number_of_threads; ++i)
142            new CountedExitEvent(comInstEventQueue[i],
143                "all threads reached the max instruction count",
144                p->max_insts_all_threads, *counter);
145    }
146
147    // allocate per-thread load-based event queues
148    comLoadEventQueue = new EventQueue *[number_of_threads];
149    for (int i = 0; i < number_of_threads; ++i)
150        comLoadEventQueue[i] = new EventQueue("load-based event queue");
151
152    //
153    // set up instruction-count-based termination events, if any
154    //
155    if (p->max_loads_any_thread != 0)
156        for (int i = 0; i < number_of_threads; ++i)
157            schedExitSimLoop("a thread reached the max load count",
158                             p->max_loads_any_thread, 0,
159                             comLoadEventQueue[i]);
160
161    if (p->max_loads_all_threads != 0) {
162        // allocate & initialize shared downcounter: each event will
163        // decrement this when triggered; simulation will terminate
164        // when counter reaches 0
165        int *counter = new int;
166        *counter = number_of_threads;
167        for (int i = 0; i < number_of_threads; ++i)
168            new CountedExitEvent(comLoadEventQueue[i],
169                "all threads reached the max load count",
170                p->max_loads_all_threads, *counter);
171    }
172
173    functionTracingEnabled = false;
174    if (p->functionTrace) {
175        functionTraceStream = simout.find(csprintf("ftrace.%s", name()));
176        currentFunctionStart = currentFunctionEnd = 0;
177        functionEntryTick = p->functionTraceStart;
178
179        if (p->functionTraceStart == 0) {
180            functionTracingEnabled = true;
181        } else {
182            new EventWrapper<BaseCPU, &BaseCPU::enableFunctionTrace>(this,
183                                                                     p->functionTraceStart,
184                                                                     true);
185        }
186    }
187#if FULL_SYSTEM
188    profileEvent = NULL;
189    if (params->profile)
190        profileEvent = new ProfileEvent(this, params->profile);
191#endif
192}
193
194BaseCPU::Params::Params()
195{
196#if FULL_SYSTEM
197    profile = false;
198#endif
199    checker = NULL;
200}
201
202void
203BaseCPU::enableFunctionTrace()
204{
205    functionTracingEnabled = true;
206}
207
208BaseCPU::~BaseCPU()
209{
210}
211
212void
213BaseCPU::init()
214{
215    if (!params->deferRegistration)
216        registerThreadContexts();
217}
218
219void
220BaseCPU::startup()
221{
222#if FULL_SYSTEM
223    if (!params->deferRegistration && profileEvent)
224        profileEvent->schedule(curTick);
225#endif
226
227    if (params->progress_interval) {
228        new CPUProgressEvent(&mainEventQueue,
229                             cycles(params->progress_interval),
230                             this);
231    }
232}
233
234
235void
236BaseCPU::regStats()
237{
238    using namespace Stats;
239
240    numCycles
241        .name(name() + ".numCycles")
242        .desc("number of cpu cycles simulated")
243        ;
244
245    int size = threadContexts.size();
246    if (size > 1) {
247        for (int i = 0; i < size; ++i) {
248            stringstream namestr;
249            ccprintf(namestr, "%s.ctx%d", name(), i);
250            threadContexts[i]->regStats(namestr.str());
251        }
252    } else if (size == 1)
253        threadContexts[0]->regStats(name());
254
255#if FULL_SYSTEM
256#endif
257}
258
259Tick
260BaseCPU::nextCycle()
261{
262    Tick next_tick = curTick - phase + clock - 1;
263    next_tick -= (next_tick % clock);
264    next_tick += phase;
265    return next_tick;
266}
267
268Tick
269BaseCPU::nextCycle(Tick begin_tick)
270{
271    Tick next_tick = begin_tick;
272    next_tick -= (next_tick % clock);
273    next_tick += phase;
274
275    while (next_tick < curTick)
276        next_tick += clock;
277
278    assert(next_tick >= curTick);
279    return next_tick;
280}
281
282void
283BaseCPU::registerThreadContexts()
284{
285    for (int i = 0; i < threadContexts.size(); ++i) {
286        ThreadContext *tc = threadContexts[i];
287
288#if FULL_SYSTEM
289        int id = params->cpu_id;
290        if (id != -1)
291            id += i;
292
293        tc->setCpuId(system->registerThreadContext(tc, id));
294#else
295        tc->setCpuId(tc->getProcessPtr()->registerThreadContext(tc));
296#endif
297    }
298}
299
300
301int
302BaseCPU::findContext(ThreadContext *tc)
303{
304    for (int i = 0; i < threadContexts.size(); ++i) {
305        if (tc == threadContexts[i])
306            return i;
307    }
308    return 0;
309}
310
311void
312BaseCPU::switchOut()
313{
314//    panic("This CPU doesn't support sampling!");
315#if FULL_SYSTEM
316    if (profileEvent && profileEvent->scheduled())
317        profileEvent->deschedule();
318#endif
319}
320
321void
322BaseCPU::takeOverFrom(BaseCPU *oldCPU, Port *ic, Port *dc)
323{
324    assert(threadContexts.size() == oldCPU->threadContexts.size());
325
326    for (int i = 0; i < threadContexts.size(); ++i) {
327        ThreadContext *newTC = threadContexts[i];
328        ThreadContext *oldTC = oldCPU->threadContexts[i];
329
330        newTC->takeOverFrom(oldTC);
331
332        CpuEvent::replaceThreadContext(oldTC, newTC);
333
334        assert(newTC->readCpuId() == oldTC->readCpuId());
335#if FULL_SYSTEM
336        system->replaceThreadContext(newTC, newTC->readCpuId());
337#else
338        assert(newTC->getProcessPtr() == oldTC->getProcessPtr());
339        newTC->getProcessPtr()->replaceThreadContext(newTC, newTC->readCpuId());
340#endif
341
342//    TheISA::compareXCs(oldXC, newXC);
343    }
344
345#if FULL_SYSTEM
346    interrupts = oldCPU->interrupts;
347
348    for (int i = 0; i < threadContexts.size(); ++i)
349        threadContexts[i]->profileClear();
350
351    // The Sampler must take care of this!
352//    if (profileEvent)
353//        profileEvent->schedule(curTick);
354#endif
355
356    // Connect new CPU to old CPU's memory only if new CPU isn't
357    // connected to anything.  Also connect old CPU's memory to new
358    // CPU.
359    Port *peer;
360    if (ic->getPeer() == NULL) {
361        peer = oldCPU->getPort("icache_port")->getPeer();
362        ic->setPeer(peer);
363    } else {
364        peer = ic->getPeer();
365    }
366    peer->setPeer(ic);
367
368    if (dc->getPeer() == NULL) {
369        peer = oldCPU->getPort("dcache_port")->getPeer();
370        dc->setPeer(peer);
371    } else {
372        peer = dc->getPeer();
373    }
374    peer->setPeer(dc);
375}
376
377
378#if FULL_SYSTEM
379BaseCPU::ProfileEvent::ProfileEvent(BaseCPU *_cpu, int _interval)
380    : Event(&mainEventQueue), cpu(_cpu), interval(_interval)
381{ }
382
383void
384BaseCPU::ProfileEvent::process()
385{
386    for (int i = 0, size = cpu->threadContexts.size(); i < size; ++i) {
387        ThreadContext *tc = cpu->threadContexts[i];
388        tc->profileSample();
389    }
390
391    schedule(curTick + interval);
392}
393
394void
395BaseCPU::post_interrupt(int int_num, int index)
396{
397    interrupts.post(int_num, index);
398}
399
400void
401BaseCPU::clear_interrupt(int int_num, int index)
402{
403    interrupts.clear(int_num, index);
404}
405
406void
407BaseCPU::clear_interrupts()
408{
409    interrupts.clear_all();
410}
411
412uint64_t
413BaseCPU::get_interrupts(int int_num)
414{
415    return interrupts.get_vec(int_num);
416}
417
418void
419BaseCPU::serialize(std::ostream &os)
420{
421    SERIALIZE_SCALAR(instCnt);
422    interrupts.serialize(os);
423}
424
425void
426BaseCPU::unserialize(Checkpoint *cp, const std::string &section)
427{
428    UNSERIALIZE_SCALAR(instCnt);
429    interrupts.unserialize(cp, section);
430}
431
432#endif // FULL_SYSTEM
433
434void
435BaseCPU::traceFunctionsInternal(Addr pc)
436{
437    if (!debugSymbolTable)
438        return;
439
440    // if pc enters different function, print new function symbol and
441    // update saved range.  Otherwise do nothing.
442    if (pc < currentFunctionStart || pc >= currentFunctionEnd) {
443        string sym_str;
444        bool found = debugSymbolTable->findNearestSymbol(pc, sym_str,
445                                                         currentFunctionStart,
446                                                         currentFunctionEnd);
447
448        if (!found) {
449            // no symbol found: use addr as label
450            sym_str = csprintf("0x%x", pc);
451            currentFunctionStart = pc;
452            currentFunctionEnd = pc + 1;
453        }
454
455        ccprintf(*functionTraceStream, " (%d)\n%d: %s",
456                 curTick - functionEntryTick, curTick, sym_str);
457        functionEntryTick = curTick;
458    }
459}
460
461
462DEFINE_SIM_OBJECT_CLASS_NAME("BaseCPU", BaseCPU)
463