util/m5/src/usage.cc

   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 #include <cinttypes>
  42 #include <cstdio>
  43 #include <cstdlib>
  44
  45 #include "commands.hh"
  46 #include "usage.hh"
  47
  48 const char *progname = "{progname}";
  49
  50 void
  51 usage()
  52 {
  53     fprintf(stderr, "Usage: %s [call type] <command> [arguments]\n", progname);
  54     fprintf(stderr, "\n");
  55     fprintf(stderr, "Call types:\n");
  56 #   if ENABLE_CT_addr
  57     fprintf(stderr, "    --addr %s%s\n",
  58 #   if defined(M5OP_ADDR)
  59             "[address override]",
  60 #   else
  61             "<address override>",
  62 #   endif
  63             DEFAULT_CT_addr ? " (default)" : "");
  64     fprintf(stderr, "        Use the address based invocation method.\n");
  65 #   if defined(M5OP_ADDR)
  66     fprintf(stderr, "        The default address is %#" PRIx64 ".\n",
  67             (uint64_t)M5OP_ADDR);
  68 #   endif
  69 #   endif
  70 #   if ENABLE_CT_inst
  71     fprintf(stderr, "    --inst%s\n", DEFAULT_CT_inst ? " (default)" : "");
  72     fprintf(stderr, "        Use the instruction based invocation method.\n");
  73 #   endif
  74 #   if ENABLE_CT_semi
  75     fprintf(stderr, "    --semi%s\n", DEFAULT_CT_semi ? " (default)" : "");
  76     fprintf(stderr, "        Use the semi-hosting based invocation method.\n");
  77 #   endif
  78     fprintf(stderr, "\n");
  79     fprintf(stderr, "Commands:\n");
  80     for (int i = 0; i < num_commands; ++i) {
  81         fprintf(stderr, "    %s %s\n",
  82                 command_table[i].name, command_table[i].usage);
  83     }
  84     fprintf(stderr, "\n");
  85     fprintf(stderr, "All times in nanoseconds!\n");
  86
  87     exit(1);
  88 }