util/m5/src/call_type/addr.cc

   1 /*
   2  * Copyright 2020 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 #include <cstring>
  29
  30 #include "call_type.hh"
  31 #include "m5_mmap.h"
  32 #include "usage.hh"
  33
  34 extern "C"
  35 {
  36 #define M5OP(name, func) __typeof__(name) M5OP_MERGE_TOKENS(name, _addr);
  37 M5OP_FOREACH
  38 #undef M5OP
  39 }
  40
  41 namespace
  42 {
  43
  44 DispatchTable addr_dispatch = {
  45 #define M5OP(name, func) .name = &::M5OP_MERGE_TOKENS(name, _addr),
  46 M5OP_FOREACH
  47 #undef M5OP
  48 };
  49
  50 #if defined(M5OP_ADDR)
  51 const bool DefaultAddrDefined = true;
  52 constexpr uint64_t DefaultAddress = M5OP_ADDR;
  53 #else
  54 const bool DefaultAddrDefined = false;
  55 constexpr uint64_t DefaultAddress = 0;
  56 #endif
  57
  58 class AddrCallType : public CallType
  59 {
  60   private:
  61   public:
  62     bool isDefault() const override { return CALL_TYPE_IS_DEFAULT; }
  63     const DispatchTable &getDispatch() const override { return addr_dispatch; }
  64
  65     void
  66     printBrief(std::ostream &os) const override
  67     {
  68         os << "--addr " << (DefaultAddrDefined ? "[address override]" :
  69                                                  "<address override>");
  70     }
  71
  72     void
  73     printDesc(std::ostream &os) const override
  74     {
  75         os << "Use the address based invocation method.";
  76         if (DefaultAddrDefined) {
  77             os << " The default address is 0x" <<
  78                 std::hex << DefaultAddress << std::dec << ".";
  79         }
  80     }
  81
  82     bool
  83     checkArgs(Args &args) override
  84     {
  85         static const std::string prefix = "--addr";
  86         uint64_t addr_override;
  87
  88         // If the first argument doesn't start with --addr...
  89         if (!args.size() || args[0].substr(0, prefix.size()) != prefix)
  90             return false;
  91
  92         const std::string &arg = args.pop().substr(prefix.size());
  93
  94         // If there's more text in this argument...
  95         if (arg.size()) {
  96             // If it doesn't start with '=', it's malformed.
  97             if (arg[0] != '=')
  98                 usage();
  99             // Attempt to extract an address after the '='.
 100             if (!args.stoi(arg.substr(1), addr_override))
 101                 usage();
 102             // If we found an address, use it to override m5op_addr.
 103             m5op_addr = addr_override;
 104             return true;
 105         }
 106         // If an address override wasn't part of the first argument, check if
 107         // it's the second argument. If not, then there's no override.
 108         if (args.pop(addr_override)) {
 109             m5op_addr = addr_override;
 110             return true;
 111         }
 112         // If the default address was not defined, an override is required.
 113         if (!DefaultAddrDefined)
 114             usage();
 115
 116         return true;
 117     }
 118
 119     void init() override { map_m5_mem(); }
 120 } addr_call_type;
 121
 122 } // anonymous namespace