util: Add a "call_type" unit test to the m5 utility.
[gem5.git] / util / m5 / src / call_type / inst.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
34 namespace
35 {
36
37 DispatchTable inst_dispatch = {
38 #define M5OP(name, func) .name = &::name,
39 M5OP_FOREACH
40 #undef M5OP
41 };
42
43 class InstCallType : public CallType
44 {
45 public:
46 bool isDefault() const override { return CALL_TYPE_IS_DEFAULT; }
47 const DispatchTable &getDispatch() const override { return inst_dispatch; }
48
49 bool
50 checkArgs(Args &args) override
51 {
52 if (args.size() && args[0] == "--inst") {
53 args.pop();
54 return true;
55 }
56 return false;
57 }
58
59 void printBrief(std::ostream &os) const override { os << "--inst"; }
60 void
61 printDesc(std::ostream &os) const override
62 {
63 os << "Use the instruction based invocation method.";
64 }
65 } inst_call_type;
66
67 } // anonymous namespace