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