base.cc revision 8793 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * Copyright (c) 2011 Regents of the University of California
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Steve Reinhardt
30 *          Nathan Binkert
31 *          Rick Strong
32 */
33
34#include <iostream>
35#include <sstream>
36#include <string>
37
38#include "arch/tlb.hh"
39#include "base/loader/symtab.hh"
40#include "base/cprintf.hh"
41#include "base/misc.hh"
42#include "base/output.hh"
43#include "base/trace.hh"
44#include "cpu/base.hh"
45#include "cpu/cpuevent.hh"
46#include "cpu/profile.hh"
47#include "cpu/thread_context.hh"
48#include "debug/SyscallVerbose.hh"
49#include "params/BaseCPU.hh"
50#include "sim/full_system.hh"
51#include "sim/process.hh"
52#include "sim/sim_events.hh"
53#include "sim/sim_exit.hh"
54#include "sim/system.hh"
55
56// Hack
57#include "sim/stat_control.hh"
58
59using namespace std;
60
61vector<BaseCPU *> BaseCPU::cpuList;
62
63// This variable reflects the max number of threads in any CPU.  Be
64// careful to only use it once all the CPUs that you care about have
65// been initialized
66int maxThreadsPerCPU = 1;
67
68CPUProgressEvent::CPUProgressEvent(BaseCPU *_cpu, Tick ival)
69    : Event(Event::Progress_Event_Pri), _interval(ival), lastNumInst(0),
70      cpu(_cpu), _repeatEvent(true)
71{
72    if (_interval)
73        cpu->schedule(this, curTick() + _interval);
74}
75
76void
77CPUProgressEvent::process()
78{
79    Counter temp = cpu->totalInstructions();
80#ifndef NDEBUG
81    double ipc = double(temp - lastNumInst) / (_interval / cpu->ticks(1));
82
83    DPRINTFN("%s progress event, total committed:%i, progress insts committed: "
84             "%lli, IPC: %0.8d\n", cpu->name(), temp, temp - lastNumInst,
85             ipc);
86    ipc = 0.0;
87#else
88    cprintf("%lli: %s progress event, total committed:%i, progress insts "
89            "committed: %lli\n", curTick(), cpu->name(), temp,
90            temp - lastNumInst);
91#endif
92    lastNumInst = temp;
93
94    if (_repeatEvent)
95        cpu->schedule(this, curTick() + _interval);
96}
97
98const char *
99CPUProgressEvent::description() const
100{
101    return "CPU Progress";
102}
103
104BaseCPU::BaseCPU(Params *p)
105    : MemObject(p), clock(p->clock), instCnt(0), _cpuId(p->cpu_id),
106      interrupts(p->interrupts),
107      numThreads(p->numThreads), system(p->system),
108      phase(p->phase)
109{
110//    currentTick = curTick();
111
112    // if Python did not provide a valid ID, do it here
113    if (_cpuId == -1 ) {
114        _cpuId = cpuList.size();
115    }
116
117    // add self to global list of CPUs
118    cpuList.push_back(this);
119
120    DPRINTF(SyscallVerbose, "Constructing CPU with id %d\n", _cpuId);
121
122    if (numThreads > maxThreadsPerCPU)
123        maxThreadsPerCPU = numThreads;
124
125    // allocate per-thread instruction-based event queues
126    comInstEventQueue = new EventQueue *[numThreads];
127    for (ThreadID tid = 0; tid < numThreads; ++tid)
128        comInstEventQueue[tid] =
129            new EventQueue("instruction-based event queue");
130
131    //
132    // set up instruction-count-based termination events, if any
133    //
134    if (p->max_insts_any_thread != 0) {
135        const char *cause = "a thread reached the max instruction count";
136        for (ThreadID tid = 0; tid < numThreads; ++tid) {
137            Event *event = new SimLoopExitEvent(cause, 0);
138            comInstEventQueue[tid]->schedule(event, p->max_insts_any_thread);
139        }
140    }
141
142    if (p->max_insts_all_threads != 0) {
143        const char *cause = "all threads reached the max instruction count";
144
145        // allocate & initialize shared downcounter: each event will
146        // decrement this when triggered; simulation will terminate
147        // when counter reaches 0
148        int *counter = new int;
149        *counter = numThreads;
150        for (ThreadID tid = 0; tid < numThreads; ++tid) {
151            Event *event = new CountedExitEvent(cause, *counter);
152            comInstEventQueue[tid]->schedule(event, p->max_insts_all_threads);
153        }
154    }
155
156    // allocate per-thread load-based event queues
157    comLoadEventQueue = new EventQueue *[numThreads];
158    for (ThreadID tid = 0; tid < numThreads; ++tid)
159        comLoadEventQueue[tid] = new EventQueue("load-based event queue");
160
161    //
162    // set up instruction-count-based termination events, if any
163    //
164    if (p->max_loads_any_thread != 0) {
165        const char *cause = "a thread reached the max load count";
166        for (ThreadID tid = 0; tid < numThreads; ++tid) {
167            Event *event = new SimLoopExitEvent(cause, 0);
168            comLoadEventQueue[tid]->schedule(event, p->max_loads_any_thread);
169        }
170    }
171
172    if (p->max_loads_all_threads != 0) {
173        const char *cause = "all threads reached the max load count";
174        // allocate & initialize shared downcounter: each event will
175        // decrement this when triggered; simulation will terminate
176        // when counter reaches 0
177        int *counter = new int;
178        *counter = numThreads;
179        for (ThreadID tid = 0; tid < numThreads; ++tid) {
180            Event *event = new CountedExitEvent(cause, *counter);
181            comLoadEventQueue[tid]->schedule(event, p->max_loads_all_threads);
182        }
183    }
184
185    functionTracingEnabled = false;
186    if (p->function_trace) {
187        functionTraceStream = simout.find(csprintf("ftrace.%s", name()));
188        currentFunctionStart = currentFunctionEnd = 0;
189        functionEntryTick = p->function_trace_start;
190
191        if (p->function_trace_start == 0) {
192            functionTracingEnabled = true;
193        } else {
194            typedef EventWrapper<BaseCPU, &BaseCPU::enableFunctionTrace> wrap;
195            Event *event = new wrap(this, true);
196            schedule(event, p->function_trace_start);
197        }
198    }
199    interrupts->setCPU(this);
200
201    if (FullSystem) {
202        profileEvent = NULL;
203        if (params()->profile)
204            profileEvent = new ProfileEvent(this, params()->profile);
205    }
206    tracer = params()->tracer;
207}
208
209void
210BaseCPU::enableFunctionTrace()
211{
212    functionTracingEnabled = true;
213}
214
215BaseCPU::~BaseCPU()
216{
217}
218
219void
220BaseCPU::init()
221{
222    if (!params()->defer_registration)
223        registerThreadContexts();
224}
225
226void
227BaseCPU::startup()
228{
229    if (FullSystem) {
230        if (!params()->defer_registration && profileEvent)
231            schedule(profileEvent, curTick());
232    }
233
234    if (params()->progress_interval) {
235        Tick num_ticks = ticks(params()->progress_interval);
236
237        Event *event;
238        event = new CPUProgressEvent(this, num_ticks);
239    }
240}
241
242
243void
244BaseCPU::regStats()
245{
246    using namespace Stats;
247
248    numCycles
249        .name(name() + ".numCycles")
250        .desc("number of cpu cycles simulated")
251        ;
252
253    numWorkItemsStarted
254        .name(name() + ".numWorkItemsStarted")
255        .desc("number of work items this cpu started")
256        ;
257
258    numWorkItemsCompleted
259        .name(name() + ".numWorkItemsCompleted")
260        .desc("number of work items this cpu completed")
261        ;
262
263    int size = threadContexts.size();
264    if (size > 1) {
265        for (int i = 0; i < size; ++i) {
266            stringstream namestr;
267            ccprintf(namestr, "%s.ctx%d", name(), i);
268            threadContexts[i]->regStats(namestr.str());
269        }
270    } else if (size == 1)
271        threadContexts[0]->regStats(name());
272}
273
274Tick
275BaseCPU::nextCycle()
276{
277    Tick next_tick = curTick() - phase + clock - 1;
278    next_tick -= (next_tick % clock);
279    next_tick += phase;
280    return next_tick;
281}
282
283Tick
284BaseCPU::nextCycle(Tick begin_tick)
285{
286    Tick next_tick = begin_tick;
287    if (next_tick % clock != 0)
288        next_tick = next_tick - (next_tick % clock) + clock;
289    next_tick += phase;
290
291    assert(next_tick >= curTick());
292    return next_tick;
293}
294
295void
296BaseCPU::registerThreadContexts()
297{
298    ThreadID size = threadContexts.size();
299    for (ThreadID tid = 0; tid < size; ++tid) {
300        ThreadContext *tc = threadContexts[tid];
301
302        /** This is so that contextId and cpuId match where there is a
303         * 1cpu:1context relationship.  Otherwise, the order of registration
304         * could affect the assignment and cpu 1 could have context id 3, for
305         * example.  We may even want to do something like this for SMT so that
306         * cpu 0 has the lowest thread contexts and cpu N has the highest, but
307         * I'll just do this for now
308         */
309        if (numThreads == 1)
310            tc->setContextId(system->registerThreadContext(tc, _cpuId));
311        else
312            tc->setContextId(system->registerThreadContext(tc));
313
314        if (!FullSystem)
315            tc->getProcessPtr()->assignThreadContext(tc->contextId());
316    }
317}
318
319
320int
321BaseCPU::findContext(ThreadContext *tc)
322{
323    ThreadID size = threadContexts.size();
324    for (ThreadID tid = 0; tid < size; ++tid) {
325        if (tc == threadContexts[tid])
326            return tid;
327    }
328    return 0;
329}
330
331void
332BaseCPU::switchOut()
333{
334    if (profileEvent && profileEvent->scheduled())
335        deschedule(profileEvent);
336}
337
338void
339BaseCPU::takeOverFrom(BaseCPU *oldCPU, Port *ic, Port *dc)
340{
341    assert(threadContexts.size() == oldCPU->threadContexts.size());
342
343    _cpuId = oldCPU->cpuId();
344
345    ThreadID size = threadContexts.size();
346    for (ThreadID i = 0; i < size; ++i) {
347        ThreadContext *newTC = threadContexts[i];
348        ThreadContext *oldTC = oldCPU->threadContexts[i];
349
350        newTC->takeOverFrom(oldTC);
351
352        CpuEvent::replaceThreadContext(oldTC, newTC);
353
354        assert(newTC->contextId() == oldTC->contextId());
355        assert(newTC->threadId() == oldTC->threadId());
356        system->replaceThreadContext(newTC, newTC->contextId());
357
358        /* This code no longer works since the zero register (e.g.,
359         * r31 on Alpha) doesn't necessarily contain zero at this
360         * point.
361           if (DTRACE(Context))
362            ThreadContext::compare(oldTC, newTC);
363        */
364
365        Port  *old_itb_port, *old_dtb_port, *new_itb_port, *new_dtb_port;
366        old_itb_port = oldTC->getITBPtr()->getPort();
367        old_dtb_port = oldTC->getDTBPtr()->getPort();
368        new_itb_port = newTC->getITBPtr()->getPort();
369        new_dtb_port = newTC->getDTBPtr()->getPort();
370
371        // Move over any table walker ports if they exist
372        if (new_itb_port && !new_itb_port->isConnected()) {
373            assert(old_itb_port);
374            Port *peer = old_itb_port->getPeer();;
375            new_itb_port->setPeer(peer);
376            peer->setPeer(new_itb_port);
377        }
378        if (new_dtb_port && !new_dtb_port->isConnected()) {
379            assert(old_dtb_port);
380            Port *peer = old_dtb_port->getPeer();;
381            new_dtb_port->setPeer(peer);
382            peer->setPeer(new_dtb_port);
383        }
384    }
385
386    interrupts = oldCPU->interrupts;
387    interrupts->setCPU(this);
388
389    if (FullSystem) {
390        for (ThreadID i = 0; i < size; ++i)
391            threadContexts[i]->profileClear();
392
393        if (profileEvent)
394            schedule(profileEvent, curTick());
395    }
396
397    // Connect new CPU to old CPU's memory only if new CPU isn't
398    // connected to anything.  Also connect old CPU's memory to new
399    // CPU.
400    if (!ic->isConnected()) {
401        Port *peer = oldCPU->getPort("icache_port")->getPeer();
402        ic->setPeer(peer);
403        peer->setPeer(ic);
404    }
405
406    if (!dc->isConnected()) {
407        Port *peer = oldCPU->getPort("dcache_port")->getPeer();
408        dc->setPeer(peer);
409        peer->setPeer(dc);
410    }
411}
412
413
414BaseCPU::ProfileEvent::ProfileEvent(BaseCPU *_cpu, Tick _interval)
415    : cpu(_cpu), interval(_interval)
416{ }
417
418void
419BaseCPU::ProfileEvent::process()
420{
421    ThreadID size = cpu->threadContexts.size();
422    for (ThreadID i = 0; i < size; ++i) {
423        ThreadContext *tc = cpu->threadContexts[i];
424        tc->profileSample();
425    }
426
427    cpu->schedule(this, curTick() + interval);
428}
429
430void
431BaseCPU::serialize(std::ostream &os)
432{
433    SERIALIZE_SCALAR(instCnt);
434    interrupts->serialize(os);
435}
436
437void
438BaseCPU::unserialize(Checkpoint *cp, const std::string &section)
439{
440    UNSERIALIZE_SCALAR(instCnt);
441    interrupts->unserialize(cp, section);
442}
443
444void
445BaseCPU::traceFunctionsInternal(Addr pc)
446{
447    if (!debugSymbolTable)
448        return;
449
450    // if pc enters different function, print new function symbol and
451    // update saved range.  Otherwise do nothing.
452    if (pc < currentFunctionStart || pc >= currentFunctionEnd) {
453        string sym_str;
454        bool found = debugSymbolTable->findNearestSymbol(pc, sym_str,
455                                                         currentFunctionStart,
456                                                         currentFunctionEnd);
457
458        if (!found) {
459            // no symbol found: use addr as label
460            sym_str = csprintf("0x%x", pc);
461            currentFunctionStart = pc;
462            currentFunctionEnd = pc + 1;
463        }
464
465        ccprintf(*functionTraceStream, " (%d)\n%d: %s",
466                 curTick() - functionEntryTick, curTick(), sym_str);
467        functionEntryTick = curTick();
468    }
469}
470