src/sim/workload.hh

   1 /*
   2  * Copyright 2019 Google Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met: redistributions of source code must retain the above copyright
   7  * notice, this list of conditions and the following disclaimer;
   8  * redistributions in binary form must reproduce the above copyright
   9  * notice, this list of conditions and the following disclaimer in the
  10  * documentation and/or other materials provided with the distribution;
  11  * neither the name of the copyright holders nor the names of its
  12  * contributors may be used to endorse or promote products derived from
  13  * this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef __SIM_WORKLOAD_HH__
  29 #define __SIM_WORKLOAD_HH__
  30
  31 #include "base/loader/object_file.hh"
  32 #include "base/loader/symtab.hh"
  33 #include "params/Workload.hh"
  34 #include "sim/sim_object.hh"
  35 #include "sim/stats.hh"
  36
  37 class System;
  38 class ThreadContext;
  39
  40 class Workload : public SimObject
  41 {
  42   protected:
  43     virtual Addr fixFuncEventAddr(Addr addr) const { return addr; }
  44
  45     struct WorkloadStats : public Stats::Group
  46     {
  47         struct InstStats: public Stats::Group
  48         {
  49             Stats::Scalar arm;
  50             Stats::Scalar quiesce;
  51
  52             InstStats(Stats::Group *parent) : Stats::Group(parent, "inst"),
  53                 ADD_STAT(arm, "number of arm instructions executed"),
  54                 ADD_STAT(quiesce, "number of quiesce instructions executed")
  55             {}
  56
  57         } instStats;
  58
  59         WorkloadStats(Workload *workload) : Stats::Group(workload),
  60             instStats(workload)
  61         {}
  62     } stats;
  63
  64   public:
  65     Workload(const WorkloadParams &_params) : SimObject(_params), stats(this)
  66     {}
  67
  68     void recordQuiesce() { stats.instStats.quiesce++; }
  69     void recordArm() { stats.instStats.arm++; }
  70
  71     System *system = nullptr;
  72
  73     virtual Addr getEntry() const = 0;
  74     virtual Loader::Arch getArch() const = 0;
  75
  76     virtual const Loader::SymbolTable &symtab(ThreadContext *tc) = 0;
  77     virtual bool insertSymbol(const Loader::Symbol &symbol) = 0;
  78
  79     virtual void
  80     syscall(ThreadContext *tc)
  81     {
  82         panic("syscall() not implemented.");
  83     }
  84
  85     virtual void
  86     event(ThreadContext *tc)
  87     {
  88         warn("Unhandled workload event.");
  89     }
  90
  91     /** @{ */
  92     /**
  93      * Add a function-based event to the given function, to be looked
  94      * up in the specified symbol table.
  95      *
  96      * The ...OrPanic flavor of the method causes the simulator to
  97      * panic if the symbol can't be found.
  98      *
  99      * @param symtab Symbol table to use for look up.
 100      * @param lbl Function to hook the event to.
 101      * @param desc Description to be passed to the event.
 102      * @param args Arguments to be forwarded to the event constructor.
 103      */
 104     template <class T, typename... Args>
 105     T *
 106     addFuncEvent(const Loader::SymbolTable &symtab, const char *lbl,
 107                  const std::string &desc, Args... args)
 108     {
 109         auto it = symtab.find(lbl);
 110         if (it == symtab.end())
 111             return nullptr;
 112
 113         return new T(system, desc, fixFuncEventAddr(it->address),
 114                       std::forward<Args>(args)...);
 115     }
 116
 117     template <class T>
 118     T *
 119     addFuncEvent(const Loader::SymbolTable &symtab, const char *lbl)
 120     {
 121         return addFuncEvent<T>(symtab, lbl, lbl);
 122     }
 123
 124     template <class T, typename... Args>
 125     T *
 126     addFuncEventOrPanic(const Loader::SymbolTable &symtab, const char *lbl,
 127                         Args... args)
 128     {
 129         T *e = addFuncEvent<T>(symtab, lbl, std::forward<Args>(args)...);
 130         panic_if(!e, "Failed to find symbol '%s'", lbl);
 131         return e;
 132     }
 133     /** @} */
 134 };
 135
 136 #endif // __SIM_WORKLOAD_HH__