src/cpu/base.cc

   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
  29 #include <iostream>
  30 #include <string>
  31 #include <sstream>
  32
  33 #include "base/cprintf.hh"
  34 #include "base/loader/symtab.hh"
  35 #include "base/misc.hh"
  36 #include "base/output.hh"
  37 #include "cpu/base.hh"
  38 #include "cpu/exec_context.hh"
  39 #include "cpu/profile.hh"
  40 #include "cpu/sampler/sampler.hh"
  41 #include "sim/param.hh"
  42 #include "sim/process.hh"
  43 #include "sim/sim_events.hh"
  44 #include "sim/system.hh"
  45
  46 #include "base/trace.hh"
  47
  48 #if FULL_SYSTEM
  49 #include "kern/kernel_stats.hh"
  50 #endif
  51
  52 using namespace std;
  53
  54 vector<BaseCPU *> BaseCPU::cpuList;
  55
  56 // This variable reflects the max number of threads in any CPU.  Be
  57 // careful to only use it once all the CPUs that you care about have
  58 // been initialized
  59 int maxThreadsPerCPU = 1;
  60
  61 #if FULL_SYSTEM
  62 BaseCPU::BaseCPU(Params *p)
  63     : SimObject(p->name), clock(p->clock), checkInterrupts(true),
  64       params(p), number_of_threads(p->numberOfThreads), system(p->system)
  65 #else
  66 BaseCPU::BaseCPU(Params *p)
  67     : SimObject(p->name), clock(p->clock), params(p),
  68       number_of_threads(p->numberOfThreads), system(p->system)
  69 #endif
  70 {
  71     DPRINTF(FullCPU, "BaseCPU: Creating object, mem address %#x.\n", this);
  72
  73     // add self to global list of CPUs
  74     cpuList.push_back(this);
  75
  76     DPRINTF(FullCPU, "BaseCPU: CPU added to cpuList, mem address %#x.\n",
  77             this);
  78
  79     if (number_of_threads > maxThreadsPerCPU)
  80         maxThreadsPerCPU = number_of_threads;
  81
  82     // allocate per-thread instruction-based event queues
  83     comInstEventQueue = new EventQueue *[number_of_threads];
  84     for (int i = 0; i < number_of_threads; ++i)
  85         comInstEventQueue[i] = new EventQueue("instruction-based event queue");
  86
  87     //
  88     // set up instruction-count-based termination events, if any
  89     //
  90     if (p->max_insts_any_thread != 0)
  91         for (int i = 0; i < number_of_threads; ++i)
  92             new SimExitEvent(comInstEventQueue[i], p->max_insts_any_thread,
  93                 "a thread reached the max instruction count");
  94
  95     if (p->max_insts_all_threads != 0) {
  96         // allocate & initialize shared downcounter: each event will
  97         // decrement this when triggered; simulation will terminate
  98         // when counter reaches 0
  99         int *counter = new int;
 100         *counter = number_of_threads;
 101         for (int i = 0; i < number_of_threads; ++i)
 102             new CountedExitEvent(comInstEventQueue[i],
 103                 "all threads reached the max instruction count",
 104                 p->max_insts_all_threads, *counter);
 105     }
 106
 107     // allocate per-thread load-based event queues
 108     comLoadEventQueue = new EventQueue *[number_of_threads];
 109     for (int i = 0; i < number_of_threads; ++i)
 110         comLoadEventQueue[i] = new EventQueue("load-based event queue");
 111
 112     //
 113     // set up instruction-count-based termination events, if any
 114     //
 115     if (p->max_loads_any_thread != 0)
 116         for (int i = 0; i < number_of_threads; ++i)
 117             new SimExitEvent(comLoadEventQueue[i], p->max_loads_any_thread,
 118                 "a thread reached the max load count");
 119
 120     if (p->max_loads_all_threads != 0) {
 121         // allocate & initialize shared downcounter: each event will
 122         // decrement this when triggered; simulation will terminate
 123         // when counter reaches 0
 124         int *counter = new int;
 125         *counter = number_of_threads;
 126         for (int i = 0; i < number_of_threads; ++i)
 127             new CountedExitEvent(comLoadEventQueue[i],
 128                 "all threads reached the max load count",
 129                 p->max_loads_all_threads, *counter);
 130     }
 131
 132 #if FULL_SYSTEM
 133     memset(interrupts, 0, sizeof(interrupts));
 134     intstatus = 0;
 135 #endif
 136
 137     functionTracingEnabled = false;
 138     if (p->functionTrace) {
 139         functionTraceStream = simout.find(csprintf("ftrace.%s", name()));
 140         currentFunctionStart = currentFunctionEnd = 0;
 141         functionEntryTick = p->functionTraceStart;
 142
 143         if (p->functionTraceStart == 0) {
 144             functionTracingEnabled = true;
 145         } else {
 146             Event *e =
 147                 new EventWrapper<BaseCPU, &BaseCPU::enableFunctionTrace>(this,
 148                                                                          true);
 149             e->schedule(p->functionTraceStart);
 150         }
 151     }
 152 #if FULL_SYSTEM
 153     profileEvent = NULL;
 154     if (params->profile)
 155         profileEvent = new ProfileEvent(this, params->profile);
 156
 157     kernelStats = new Kernel::Statistics(system);
 158 #endif
 159
 160 }
 161
 162 BaseCPU::Params::Params()
 163 {
 164 #if FULL_SYSTEM
 165     profile = false;
 166 #endif
 167 }
 168
 169 void
 170 BaseCPU::enableFunctionTrace()
 171 {
 172     functionTracingEnabled = true;
 173 }
 174
 175 BaseCPU::~BaseCPU()
 176 {
 177 #if FULL_SYSTEM
 178     if (kernelStats)
 179         delete kernelStats;
 180 #endif
 181 }
 182
 183 void
 184 BaseCPU::init()
 185 {
 186     if (!params->deferRegistration)
 187         registerExecContexts();
 188 }
 189
 190 void
 191 BaseCPU::startup()
 192 {
 193 #if FULL_SYSTEM
 194     if (!params->deferRegistration && profileEvent)
 195         profileEvent->schedule(curTick);
 196 #endif
 197 }
 198
 199
 200 void
 201 BaseCPU::regStats()
 202 {
 203     using namespace Stats;
 204
 205     numCycles
 206         .name(name() + ".numCycles")
 207         .desc("number of cpu cycles simulated")
 208         ;
 209
 210     int size = execContexts.size();
 211     if (size > 1) {
 212         for (int i = 0; i < size; ++i) {
 213             stringstream namestr;
 214             ccprintf(namestr, "%s.ctx%d", name(), i);
 215             execContexts[i]->regStats(namestr.str());
 216         }
 217     } else if (size == 1)
 218         execContexts[0]->regStats(name());
 219
 220 #if FULL_SYSTEM
 221     if (kernelStats)
 222         kernelStats->regStats(name() + ".kern");
 223 #endif
 224 }
 225
 226
 227 void
 228 BaseCPU::registerExecContexts()
 229 {
 230     for (int i = 0; i < execContexts.size(); ++i) {
 231         ExecContext *xc = execContexts[i];
 232
 233 #if FULL_SYSTEM
 234         int id = params->cpu_id;
 235         if (id != -1)
 236             id += i;
 237
 238         xc->setCpuId(system->registerExecContext(xc, id));
 239 #else
 240         xc->setCpuId(xc->getProcessPtr()->registerExecContext(xc));
 241 #endif
 242     }
 243 }
 244
 245
 246 void
 247 BaseCPU::switchOut(Sampler *sampler)
 248 {
 249     panic("This CPU doesn't support sampling!");
 250 }
 251
 252 void
 253 BaseCPU::takeOverFrom(BaseCPU *oldCPU)
 254 {
 255     assert(execContexts.size() == oldCPU->execContexts.size());
 256
 257     for (int i = 0; i < execContexts.size(); ++i) {
 258         ExecContext *newXC = execContexts[i];
 259         ExecContext *oldXC = oldCPU->execContexts[i];
 260
 261         newXC->takeOverFrom(oldXC);
 262         assert(newXC->readCpuId() == oldXC->readCpuId());
 263 #if FULL_SYSTEM
 264         system->replaceExecContext(newXC, newXC->readCpuId());
 265 #else
 266         assert(newXC->getProcessPtr() == oldXC->getProcessPtr());
 267         newXC->getProcessPtr()->replaceExecContext(newXC, newXC->readCpuId());
 268 #endif
 269     }
 270
 271 #if FULL_SYSTEM
 272     for (int i = 0; i < TheISA::NumInterruptLevels; ++i)
 273         interrupts[i] = oldCPU->interrupts[i];
 274     intstatus = oldCPU->intstatus;
 275
 276     for (int i = 0; i < execContexts.size(); ++i)
 277         execContexts[i]->profileClear();
 278
 279     if (profileEvent)
 280         profileEvent->schedule(curTick);
 281 #endif
 282 }
 283
 284
 285 #if FULL_SYSTEM
 286 BaseCPU::ProfileEvent::ProfileEvent(BaseCPU *_cpu, int _interval)
 287     : Event(&mainEventQueue), cpu(_cpu), interval(_interval)
 288 { }
 289
 290 void
 291 BaseCPU::ProfileEvent::process()
 292 {
 293     for (int i = 0, size = cpu->execContexts.size(); i < size; ++i) {
 294         ExecContext *xc = cpu->execContexts[i];
 295         xc->profileSample();
 296     }
 297
 298     schedule(curTick + interval);
 299 }
 300
 301 void
 302 BaseCPU::post_interrupt(int int_num, int index)
 303 {
 304     DPRINTF(Interrupt, "Interrupt %d:%d posted\n", int_num, index);
 305
 306     if (int_num < 0 || int_num >= TheISA::NumInterruptLevels)
 307         panic("int_num out of bounds\n");
 308
 309     if (index < 0 || index >= sizeof(uint64_t) * 8)
 310         panic("int_num out of bounds\n");
 311
 312     checkInterrupts = true;
 313     interrupts[int_num] |= 1 << index;
 314     intstatus |= (ULL(1) << int_num);
 315 }
 316
 317 void
 318 BaseCPU::clear_interrupt(int int_num, int index)
 319 {
 320     DPRINTF(Interrupt, "Interrupt %d:%d cleared\n", int_num, index);
 321
 322     if (int_num < 0 || int_num >= TheISA::NumInterruptLevels)
 323         panic("int_num out of bounds\n");
 324
 325     if (index < 0 || index >= sizeof(uint64_t) * 8)
 326         panic("int_num out of bounds\n");
 327
 328     interrupts[int_num] &= ~(1 << index);
 329     if (interrupts[int_num] == 0)
 330         intstatus &= ~(ULL(1) << int_num);
 331 }
 332
 333 void
 334 BaseCPU::clear_interrupts()
 335 {
 336     DPRINTF(Interrupt, "Interrupts all cleared\n");
 337
 338     memset(interrupts, 0, sizeof(interrupts));
 339     intstatus = 0;
 340 }
 341
 342
 343 void
 344 BaseCPU::serialize(std::ostream &os)
 345 {
 346     SERIALIZE_ARRAY(interrupts, TheISA::NumInterruptLevels);
 347     SERIALIZE_SCALAR(intstatus);
 348
 349 #if FULL_SYSTEM
 350     if (kernelStats)
 351         kernelStats->serialize(os);
 352 #endif
 353
 354 }
 355
 356 void
 357 BaseCPU::unserialize(Checkpoint *cp, const std::string &section)
 358 {
 359     UNSERIALIZE_ARRAY(interrupts, TheISA::NumInterruptLevels);
 360     UNSERIALIZE_SCALAR(intstatus);
 361
 362 #if FULL_SYSTEM
 363     if (kernelStats)
 364         kernelStats->unserialize(cp, section);
 365 #endif
 366 }
 367
 368 #endif // FULL_SYSTEM
 369
 370 void
 371 BaseCPU::traceFunctionsInternal(Addr pc)
 372 {
 373     if (!debugSymbolTable)
 374         return;
 375
 376     // if pc enters different function, print new function symbol and
 377     // update saved range.  Otherwise do nothing.
 378     if (pc < currentFunctionStart || pc >= currentFunctionEnd) {
 379         string sym_str;
 380         bool found = debugSymbolTable->findNearestSymbol(pc, sym_str,
 381                                                          currentFunctionStart,
 382                                                          currentFunctionEnd);
 383
 384         if (!found) {
 385             // no symbol found: use addr as label
 386             sym_str = csprintf("0x%x", pc);
 387             currentFunctionStart = pc;
 388             currentFunctionEnd = pc + 1;
 389         }
 390
 391         ccprintf(*functionTraceStream, " (%d)\n%d: %s",
 392                  curTick - functionEntryTick, curTick, sym_str);
 393         functionEntryTick = curTick;
 394     }
 395 }
 396
 397
 398 DEFINE_SIM_OBJECT_CLASS_NAME("BaseCPU", BaseCPU)