src/arch/arm/linux/fs_workload.hh

   1 /*
   2  * Copyright (c) 2010-2013 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 2002-2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 #ifndef __ARCH_ARM_LINUX_FS_WORKLOAD_HH__
  42 #define __ARCH_ARM_LINUX_FS_WORKLOAD_HH__
  43
  44 #include <cstdio>
  45 #include <map>
  46 #include <string>
  47
  48 #include "arch/arm/aapcs32.hh"
  49 #include "arch/arm/aapcs64.hh"
  50 #include "arch/arm/fs_workload.hh"
  51 #include "arch/arm/system.hh"
  52 #include "base/output.hh"
  53 #include "kern/linux/events.hh"
  54 #include "params/ArmFsLinux.hh"
  55 #include "sim/core.hh"
  56
  57 namespace ArmISA
  58 {
  59
  60 class SkipFuncLinux32 : public SkipFunc
  61 {
  62   public:
  63     using SkipFunc::SkipFunc;
  64     using ABI = Aapcs32Vfp;
  65 };
  66
  67 class SkipFuncLinux64 : public SkipFunc
  68 {
  69   public:
  70     using SkipFunc::SkipFunc;
  71     using ABI = Aapcs64;
  72 };
  73
  74 class FsLinux : public ArmISA::FsWorkload
  75 {
  76   protected:
  77     /**
  78      * PC based event to skip the dprink() call and emulate its
  79      * functionality
  80      */
  81     PCEvent *debugPrintk = nullptr;
  82
  83     PCEvent *dumpStats = nullptr;
  84
  85   public:
  86     /** Boilerplate params code */
  87     typedef ArmFsLinuxParams Params;
  88     const Params &
  89     params() const
  90     {
  91         return dynamic_cast<const Params &>(_params);
  92     }
  93
  94     /** When enabled, dump stats/task info on context switches for
  95      *  Streamline and per-thread cache occupancy studies, etc. */
  96     bool enableContextSwitchStatsDump;
  97
  98     /** This map stores a mapping of OS process IDs to internal Task IDs. The
  99      * mapping is done because the stats system doesn't tend to like vectors
 100      * that are much greater than 1000 items and the entire process space is
 101      * 65K. */
 102     std::map<uint32_t, uint32_t> taskMap;
 103
 104     /** This is a file that is placed in the run directory that prints out
 105      * mappings between taskIds and OS process IDs */
 106     OutputStream *taskFile = nullptr;
 107
 108     FsLinux(const Params &p);
 109     ~FsLinux();
 110
 111     void initState() override;
 112
 113     void startup() override;
 114
 115     /** This function creates a new task Id for the given pid.
 116      * @param tc thread context that is currentyl executing  */
 117     void mapPid(ThreadContext* tc, uint32_t pid);
 118
 119   public: // Exported Python methods
 120     /**
 121      * Dump the kernel's dmesg buffer to stdout
 122      */
 123     void dumpDmesg();
 124
 125   private:
 126     /** Event to halt the simulator if the kernel calls panic()  */
 127     PCEvent *kernelPanic = nullptr;
 128
 129     /** Event to halt the simulator if the kernel calls oopses  */
 130     PCEvent *kernelOops = nullptr;
 131
 132     /**
 133      * PC based event to skip udelay(<time>) calls and quiesce the
 134      * processor for the appropriate amount of time. This is not functionally
 135      * required but does speed up simulation.
 136      */
 137     PCEvent *skipUDelay = nullptr;
 138
 139     /** Another PC based skip event for const_udelay(). Similar to the udelay
 140      * skip, but this function precomputes the first multiply that is done
 141      * in the generic case since the parameter is known at compile time.
 142      * Thus we need to do some division to get back to us.
 143      */
 144     PCEvent *skipConstUDelay = nullptr;
 145 };
 146
 147 class DumpStats : public PCEvent
 148 {
 149   public:
 150     DumpStats(PCEventScope *s, const std::string &desc, Addr addr)
 151         : PCEvent(s, desc, addr)
 152     {}
 153
 154     void process(ThreadContext* tc) override;
 155   protected:
 156     virtual void getTaskDetails(ThreadContext *tc, uint32_t &pid,
 157             uint32_t &tgid, std::string &next_task_str, int32_t &mm);
 158
 159 };
 160
 161 class DumpStats64 : public DumpStats
 162 {
 163   public:
 164     using DumpStats::DumpStats;
 165
 166   private:
 167     void getTaskDetails(ThreadContext *tc, uint32_t &pid, uint32_t &tgid,
 168                         std::string &next_task_str, int32_t &mm) override;
 169 };
 170
 171 } // namespace ArmISA
 172
 173 #endif // __ARCH_ARM_LINUX_FS_WORKLOAD_HH__
 174