src/sim/pseudo_inst.cc

   1 /*
   2  * Copyright (c) 2003-2006 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: Nathan Binkert
  29  */
  30
  31 #include <errno.h>
  32 #include <fcntl.h>
  33 #include <unistd.h>
  34
  35 #include <string>
  36
  37 #include "sim/pseudo_inst.hh"
  38 #include "arch/vtophys.hh"
  39 #include "base/annotate.hh"
  40 #include "cpu/base.hh"
  41 #include "cpu/thread_context.hh"
  42 #include "cpu/quiesce_event.hh"
  43 #include "kern/kernel_stats.hh"
  44 #include "sim/param.hh"
  45 #include "sim/serialize.hh"
  46 #include "sim/sim_exit.hh"
  47 #include "sim/stat_control.hh"
  48 #include "sim/stats.hh"
  49 #include "sim/system.hh"
  50 #include "sim/debug.hh"
  51 #include "sim/vptr.hh"
  52
  53 using namespace std;
  54
  55 using namespace Stats;
  56 using namespace TheISA;
  57
  58 namespace AlphaPseudo
  59 {
  60     bool doStatisticsInsts;
  61     bool doCheckpointInsts;
  62     bool doQuiesce;
  63
  64     void
  65     arm(ThreadContext *tc)
  66     {
  67         if (tc->getKernelStats())
  68             tc->getKernelStats()->arm();
  69     }
  70
  71     void
  72     quiesce(ThreadContext *tc)
  73     {
  74         if (!doQuiesce)
  75             return;
  76
  77         tc->suspend();
  78         if (tc->getKernelStats())
  79             tc->getKernelStats()->quiesce();
  80     }
  81
  82     void
  83     quiesceNs(ThreadContext *tc, uint64_t ns)
  84     {
  85         if (!doQuiesce || ns == 0)
  86             return;
  87
  88         EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
  89
  90         if (quiesceEvent->scheduled())
  91             quiesceEvent->reschedule(curTick + Clock::Int::ns * ns);
  92         else
  93             quiesceEvent->schedule(curTick + Clock::Int::ns * ns);
  94
  95         tc->suspend();
  96         if (tc->getKernelStats())
  97             tc->getKernelStats()->quiesce();
  98     }
  99
 100     void
 101     quiesceCycles(ThreadContext *tc, uint64_t cycles)
 102     {
 103         if (!doQuiesce || cycles == 0)
 104             return;
 105
 106         EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
 107
 108         if (quiesceEvent->scheduled())
 109             quiesceEvent->reschedule(curTick +
 110                                      tc->getCpuPtr()->cycles(cycles));
 111         else
 112             quiesceEvent->schedule(curTick +
 113                                    tc->getCpuPtr()->cycles(cycles));
 114
 115         tc->suspend();
 116         if (tc->getKernelStats())
 117             tc->getKernelStats()->quiesce();
 118     }
 119
 120     uint64_t
 121     quiesceTime(ThreadContext *tc)
 122     {
 123         return (tc->readLastActivate() - tc->readLastSuspend()) / Clock::Int::ns;
 124     }
 125
 126     void
 127     ivlb(ThreadContext *tc)
 128     {
 129         if (tc->getKernelStats())
 130             tc->getKernelStats()->ivlb();
 131     }
 132
 133     void
 134     ivle(ThreadContext *tc)
 135     {
 136     }
 137
 138     void
 139     m5exit_old(ThreadContext *tc)
 140     {
 141         exitSimLoop(curTick, "m5_exit_old instruction encountered");
 142     }
 143
 144     void
 145     m5exit(ThreadContext *tc, Tick delay)
 146     {
 147         Tick when = curTick + delay * Clock::Int::ns;
 148         exitSimLoop(when, "m5_exit instruction encountered");
 149     }
 150
 151     void
 152     loadsymbol(ExecContext *xc)
 153     {
 154         const string &filename = xc->getCpuPtr()->system->params()->symbolfile;
 155         if (filename.empty()) {
 156             return;
 157         }
 158
 159         std::string buffer;
 160         ifstream file(filename.c_str());
 161
 162         if (!file)
 163             fatal("file error: Can't open symbol table file %s\n", filename);
 164
 165         while (!file.eof()) {
 166             getline(file, buffer);
 167
 168             if (buffer.empty())
 169                 continue;
 170
 171             int idx = buffer.find(' ');
 172             if (idx == string::npos)
 173                 continue;
 174
 175             string address = "0x" + buffer.substr(0, idx);
 176             eat_white(address);
 177             if (address.empty())
 178                 continue;
 179
 180             // Skip over letter and space
 181             string symbol = buffer.substr(idx + 3);
 182             eat_white(symbol);
 183             if (symbol.empty())
 184                 continue;
 185
 186             Addr addr;
 187             if (!to_number(address, addr))
 188                 continue;
 189
 190             if (!xc->getSystemPtr()->kernelSymtab->insert(addr, symbol))
 191                 continue;
 192
 193
 194             DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
 195         }
 196         file.close();
 197     }
 198
 199     void
 200     resetstats(ThreadContext *tc, Tick delay, Tick period)
 201     {
 202         if (!doStatisticsInsts)
 203             return;
 204
 205
 206         Tick when = curTick + delay * Clock::Int::ns;
 207         Tick repeat = period * Clock::Int::ns;
 208
 209         using namespace Stats;
 210         SetupEvent(Reset, when, repeat);
 211     }
 212
 213     void
 214     dumpstats(ThreadContext *tc, Tick delay, Tick period)
 215     {
 216         if (!doStatisticsInsts)
 217             return;
 218
 219
 220         Tick when = curTick + delay * Clock::Int::ns;
 221         Tick repeat = period * Clock::Int::ns;
 222
 223         using namespace Stats;
 224         SetupEvent(Dump, when, repeat);
 225     }
 226
 227     void
 228     addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr)
 229     {
 230         char symb[100];
 231         CopyStringOut(tc, symb, symbolAddr, 100);
 232         std::string symbol(symb);
 233
 234         DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
 235
 236         tc->getSystemPtr()->kernelSymtab->insert(addr,symbol);
 237     }
 238
 239     void
 240     anBegin(ThreadContext *tc, uint64_t cur)
 241     {
 242         Annotate::annotations.add(tc->getSystemPtr(), 0, cur >> 32, cur &
 243                 0xFFFFFFFF, 0,0);
 244     }
 245
 246     void
 247     anWait(ThreadContext *tc, uint64_t cur, uint64_t wait)
 248     {
 249         Annotate::annotations.add(tc->getSystemPtr(), 0, cur >> 32, cur &
 250                 0xFFFFFFFF, wait >> 32, wait & 0xFFFFFFFF);
 251     }
 252
 253
 254     void
 255     dumpresetstats(ThreadContext *tc, Tick delay, Tick period)
 256     {
 257         if (!doStatisticsInsts)
 258             return;
 259
 260
 261         Tick when = curTick + delay * Clock::Int::ns;
 262         Tick repeat = period * Clock::Int::ns;
 263
 264         using namespace Stats;
 265         SetupEvent(Dump|Reset, when, repeat);
 266     }
 267
 268     void
 269     m5checkpoint(ThreadContext *tc, Tick delay, Tick period)
 270     {
 271         if (!doCheckpointInsts)
 272             return;
 273         exitSimLoop("checkpoint");
 274     }
 275
 276     uint64_t
 277     readfile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset)
 278     {
 279         const string &file = tc->getCpuPtr()->system->params()->readfile;
 280         if (file.empty()) {
 281             return ULL(0);
 282         }
 283
 284         uint64_t result = 0;
 285
 286         int fd = ::open(file.c_str(), O_RDONLY, 0);
 287         if (fd < 0)
 288             panic("could not open file %s\n", file);
 289
 290         if (::lseek(fd, offset, SEEK_SET) < 0)
 291             panic("could not seek: %s", strerror(errno));
 292
 293         char *buf = new char[len];
 294         char *p = buf;
 295         while (len > 0) {
 296             int bytes = ::read(fd, p, len);
 297             if (bytes <= 0)
 298                 break;
 299
 300             p += bytes;
 301             result += bytes;
 302             len -= bytes;
 303         }
 304
 305         close(fd);
 306         CopyIn(tc, vaddr, buf, result);
 307         delete [] buf;
 308         return result;
 309     }
 310
 311     class Context : public ParamContext
 312     {
 313       public:
 314         Context(const string &section) : ParamContext(section) {}
 315         void checkParams();
 316     };
 317
 318     Context context("pseudo_inst");
 319
 320     Param<bool> __quiesce(&context, "quiesce",
 321                           "enable quiesce instructions",
 322                           true);
 323     Param<bool> __statistics(&context, "statistics",
 324                              "enable statistics pseudo instructions",
 325                              true);
 326     Param<bool> __checkpoint(&context, "checkpoint",
 327                              "enable checkpoint pseudo instructions",
 328                              true);
 329
 330     void
 331     Context::checkParams()
 332     {
 333         doQuiesce = __quiesce;
 334         doStatisticsInsts = __statistics;
 335         doCheckpointInsts = __checkpoint;
 336     }
 337
 338     void debugbreak(ThreadContext *tc)
 339     {
 340         debug_break();
 341     }
 342
 343     void switchcpu(ThreadContext *tc)
 344     {
 345         exitSimLoop("switchcpu");
 346     }
 347 }