src/arch/arm/fs_workload.hh

   1 /*
   2  * Copyright (c) 2010, 2012-2013, 2015-2019 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_FS_WORKLOAD_HH__
  42 #define __ARCH_ARM_FS_WORKLOAD_HH__
  43
  44 #include <memory>
  45 #include <vector>
  46
  47 #include "kern/linux/events.hh"
  48 #include "params/ArmFsWorkload.hh"
  49 #include "sim/kernel_workload.hh"
  50 #include "sim/sim_object.hh"
  51
  52 namespace ArmISA
  53 {
  54
  55 class SkipFunc : public SkipFuncBase
  56 {
  57   public:
  58     using SkipFuncBase::SkipFuncBase;
  59     void returnFromFuncIn(ThreadContext *tc) override;
  60 };
  61
  62 class FsWorkload : public KernelWorkload
  63 {
  64   protected:
  65     /** Bootloaders */
  66     std::vector<std::unique_ptr<Loader::ObjectFile>> bootLoaders;
  67
  68     /**
  69      * Pointer to the bootloader object
  70      */
  71     Loader::ObjectFile *bootldr = nullptr;
  72
  73     /**
  74      * This differs from entry since it takes into account where
  75      * the kernel is loaded in memory (with loadAddrMask and
  76      * loadAddrOffset).
  77      */
  78     Addr kernelEntry = 0;
  79
  80     /**
  81      * Get a boot loader that matches the kernel.
  82      *
  83      * @param obj Kernel binary
  84      * @return Pointer to boot loader ObjectFile or nullptr if there
  85      *         is no matching boot loader.
  86      */
  87     Loader::ObjectFile *getBootLoader(Loader::ObjectFile *const obj);
  88
  89   public:
  90     typedef ArmFsWorkloadParams Params;
  91     const Params *
  92     params() const
  93     {
  94         return dynamic_cast<const Params *>(&_params);
  95     }
  96
  97     Addr
  98     getEntry() const override
  99     {
 100         if (bootldr)
 101             return bootldr->entryPoint();
 102         else
 103             return kernelEntry;
 104     }
 105
 106     Loader::Arch
 107     getArch() const override
 108     {
 109         if (bootldr)
 110             return bootldr->getArch();
 111         else if (kernelObj)
 112             return kernelObj->getArch();
 113         else
 114             return Loader::Arm64;
 115     }
 116
 117     FsWorkload(Params *p);
 118
 119     void initState() override;
 120
 121     Addr
 122     fixFuncEventAddr(Addr addr) const override
 123     {
 124         // Remove the low bit that thumb symbols have set
 125         // but that aren't actually odd aligned
 126         return addr & ~1;
 127     }
 128 };
 129
 130 } // namespace ArmISA
 131
 132 #endif // __ARCH_ARM_FS_WORKLOAD_HH__