util/m5/src/args.hh

   1 /*
   2  * Copyright (c) 2011, 2017 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) 2003-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 __ARGS_HH__
  42 #define __ARGS_HH__
  43
  44 #include <cstdint>
  45 #include <initializer_list>
  46 #include <stdexcept>
  47 #include <string>
  48 #include <vector>
  49
  50 class Args
  51 {
  52   private:
  53     std::vector<std::string> args;
  54     size_t offset = 0;
  55
  56   public:
  57     Args(int argc, const char **argv)
  58     {
  59         for (int i = 0; i < argc; i++)
  60             args.push_back(argv[i]);
  61     }
  62     Args(std::initializer_list<std::string> strings) : args(strings) {}
  63
  64     /*
  65      * Attempt to convert str into an integer.
  66      *
  67      * Return whether that succeeded.
  68      */
  69     static bool
  70     stoi(const std::string &str, uint64_t &val)
  71     {
  72         try {
  73             val = std::stoi(str, nullptr, 0);
  74             return true;
  75         } catch (const std::invalid_argument &e) {
  76             return false;
  77         } catch (const std::out_of_range &e) {
  78             return false;
  79         }
  80     }
  81
  82     /*
  83      * Attempt to convert str into an integer.
  84      *
  85      * Return whether that suceeded. If not, val will be set to def.
  86      */
  87     static bool
  88     stoi(const std::string &str, uint64_t &val, uint64_t def)
  89     {
  90         val = def;
  91         return stoi(str, val);
  92     }
  93
  94     /*
  95      * Attempt to pack str as a sequence of bytes in to regs in little endian
  96      * byte order.
  97      *
  98      * Return whether that succeeded.
  99      */
 100     static bool pack(const std::string &str, uint64_t regs[], int num_regs);
 101
 102     /*
 103      * If there are any arguments in the list, remove and return the first
 104      * one. If not, return def instead.
 105      */
 106     const std::string &
 107     pop(const std::string &def = "")
 108     {
 109         if (!size())
 110             return def;
 111         return args[offset++];
 112     }
 113
 114     /*
 115      * If there are any arguments in the list, attempt to convert the first
 116      * one to an integer. If successful, remove it and store its value in val.
 117      *
 118      * Return whether that succeeded.
 119      */
 120     bool
 121     pop(uint64_t &val)
 122     {
 123         if (!size() || !stoi(args[offset], val)) {
 124             return false;
 125         } else {
 126             offset++;
 127             return true;
 128         }
 129     }
 130
 131     /*
 132      * If there are any arguments in the list, attempt to convert the first
 133      * one to an integer. If successful, remove it and store its value in val.
 134      * If there are no arguments or the conversion failed, set val to def.
 135      *
 136      * Return true if there were no arguments, or there were and the conversion
 137      * succeeded.
 138      */
 139     bool
 140     pop(uint64_t &val, uint64_t def)
 141     {
 142         val = def;
 143         if (!size())
 144             return true;
 145         if (stoi(args[offset], val)) {
 146             offset++;
 147             return true;
 148         }
 149         return false;
 150     }
 151
 152     /*
 153      * If there are any arguments in the list, attempt to pack the first one
 154      * as a sequence of bytes into the integers in regs in little endian byte
 155      * order.
 156      *
 157      * Return whether that succeeded.
 158      */
 159     bool
 160     pop(uint64_t regs[], int num_regs)
 161     {
 162         if (!size() || !pack(args[offset], regs, num_regs)) {
 163             return false;
 164         } else {
 165             offset++;
 166             return true;
 167         }
 168     }
 169
 170     size_t size() { return args.size() - offset; }
 171
 172     const std::string &operator [] (size_t idx) { return args[offset + idx]; }
 173 };
 174
 175 #endif // __ARGS_HH__