src/sim/initparam_keys.hh

   1 /*
   2  * Copyright (c) 2015 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  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * Authors: Gabor Dozsa
  38  */
  39
  40 /* @file
  41  * Magic key definitions for the InitParam pseudo inst
  42  */
  43 #ifndef ___SIM_INITPARAM_KEYS_HH__
  44 #define ___SIM_INITPARAM_KEYS_HH__
  45
  46 namespace PseudoInst {
  47 /**
  48  * Unique keys to retrieve various params by the initParam pseudo inst.
  49  *
  50  * @note Each key must be shorter than 16 characters (because we use
  51  * two 64-bit registers two pass in the key to the initparam function)
  52  */
  53 struct InitParamKey
  54 {
  55     /**
  56      *  The default key (empty string)
  57      */
  58     static constexpr const char *DEFAULT = "";
  59     /**
  60      *  Unique key for "rank" param (distributed gem5 runs)
  61      */
  62     static constexpr const char *DIST_RANK = "dist-rank";
  63     /**
  64      *  Unique key for "size" param (distributed gem5 runs)
  65      */
  66     static constexpr const char *DIST_SIZE = "dist-size";
  67 };
  68 } // namespace PseudoInst
  69
  70 #endif