sim: Deschedule existing events when destructing an event queue.
[gem5.git] / util / m5 / m5.c
index 193c0e32921cfc4622cd3b9b1c64a3c444bb63f8..48b8ed9b772d1018a03d232ba9f7de12669ce99c 100644 (file)
@@ -1,4 +1,16 @@
 /*
+ * Copyright (c) 2011, 2017 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
  * Copyright (c) 2003-2005 The Regents of The University of Michigan
  * All rights reserved.
  *
  * Authors: Nathan Binkert
  */
 
+#ifdef linux
+#define _GNU_SOURCE
+#include <sched.h>
+
+#endif
+
+#include <err.h>
+#include <fcntl.h>
 #include <inttypes.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <sys/types.h>
 #include <unistd.h>
 
-#include "m5op.h"
+#include <gem5/m5ops.h>
+#include "m5_mmap.h"
 
 char *progname;
+char *command = "unspecified";
+void usage();
 
 void
-usage()
+parse_int_args(int argc, char *argv[], uint64_t ints[], int len)
 {
-    printf("usage: m5 ivlb <interval>\n"
-           "       m5 ivle <interval>\n"
-           "       m5 initparam\n"
-           "       m5 sw99param\n"
-           "       m5 exit [delay]\n"
-           "       m5 resetstats [delay [period]]\n"
-           "       m5 dumpstats [delay [period]]\n"
-           "       m5 dumpresetstats [delay [period]]\n"
-           "       m5 checkpoint [delay [period]]\n"
-           "       m5 readfile\n"
-           "\n"
-           "All times in nanoseconds!\n");
-    exit(1);
-}
+    if (argc > len)
+        usage();
 
-#define COMPARE(X) (strcmp(X, command) == 0)
+// On 32 bit platforms we need to use strtoull to do the conversion
+#ifdef __LP64__
+#define strto64 strtoul
+#else
+#define strto64 strtoull
+#endif
+    int i;
+    for (i = 0; i < len; ++i)
+        ints[i] = (i < argc) ? strto64(argv[i], NULL, 0) : 0;
+
+#undef strto64
+}
 
-int
-main(int argc, char *argv[])
+void
+parse_str_args_to_regs(int argc, char *argv[], uint64_t regs[], int len)
 {
-    char *command;
-    uint64_t param;
-    uint64_t arg1 = 0;
-    uint64_t arg2 = 0;
-
-    progname = argv[0];
-    if (argc < 2)
+    if (argc > 1 || (argc > 0 && strlen(argv[0]) > len * sizeof(uint64_t)))
         usage();
 
-    command = argv[1];
+    int i;
+    for (i = 0; i < len; i++)
+        regs[i] = 0;
 
-    if (COMPARE("ivlb")) {
-        if (argc != 3)
-            usage();
+    if (argc == 0)
+        return;
 
-        arg1 = strtoul(argv[2], NULL, 0);
-        m5_ivlb(arg1);
-        return 0;
+    int n;
+    for (n = 0, i = 0; i < len && n < strlen(argv[0]); n++) {
+        *((char *)(&regs[i]) + (n % 8)) = argv[0][n];
+        if ((n % 8) == 7)
+            i++;
     }
+}
 
-    if (COMPARE("ivle")) {
-        if (argc != 3)
-            usage();
+int
+read_file(int dest_fid)
+{
+    uint8_t buf[256*1024];
+    int offset = 0;
+    int len, ret;
+
+    // Touch all buffer pages to ensure they are mapped in the
+    // page table. This is required in the case of X86_FS, where
+    // Linux does demand paging.
+    memset(buf, 0, sizeof(buf));
+
+    while ((len = m5_read_file(buf, sizeof(buf), offset)) > 0) {
+        uint8_t *base = buf;
+        offset += len;
+        do {
+            ret = write(dest_fid, base, len);
+            if (ret < 0) {
+                perror("Failed to write file");
+                exit(2);
+            } else if (ret == 0) {
+                fprintf(stderr, "Failed to write file: "
+                        "Unhandled short write\n");
+                exit(2);
+            }
 
-        arg1 = strtoul(argv[2], NULL, 0);
-        m5_ivle(arg1);
-        return 0;
+            base += ret;
+            len -= ret;
+        } while (len);
     }
 
-    if (COMPARE("initparam")) {
-        if (argc != 2)
-            usage();
+    return offset;
+}
+
+void
+write_file(const char *filename, const char *host_filename)
+{
+    fprintf(stderr, "opening %s\n", filename);
+    int src_fid = open(filename, O_RDONLY);
 
-        printf("%ld", m5_initparam());
-        return 0;
+    if (src_fid < 0) {
+        fprintf(stderr, "error opening %s\n", filename);
+        return;
     }
 
-    if (COMPARE("sw99param")) {
-        if (argc != 2)
-            usage();
+    char buf[256*1024];
+    int offset = 0;
+    int len;
+    int bytes = 0;
 
-        param = m5_initparam();
-        // run-time, rampup-time, rampdown-time, warmup-time, connections
-        printf("%d %d %d %d %d", (param >> 48) & 0xfff,
-               (param >> 36) & 0xfff, (param >> 24) & 0xfff,
-               (param >> 12) & 0xfff, (param >> 0) & 0xfff);
+    memset(buf, 0, sizeof(buf));
 
-        return 0;
+    while ((len = read(src_fid, buf, sizeof(buf))) > 0) {
+        bytes += m5_write_file(buf, len, offset, host_filename);
+        offset += len;
     }
+    fprintf(stderr, "written %d bytes\n", bytes);
 
-    if (COMPARE("exit")) {
-        switch (argc) {
-          case 3:
-            arg1 = strtoul(argv[2], NULL, 0);
-          case 2:
-            m5_exit(arg1);
-            return 0;
-
-          default:
-            usage();
-        }
-    }
+    close(src_fid);
+}
 
-    if (COMPARE("resetstats")) {
-        switch (argc) {
-          case 4:
-            arg2 = strtoul(argv[3], NULL, 0);
-          case 3:
-            arg1 = strtoul(argv[2], NULL, 0);
-          case 2:
-            m5_reset_stats(arg1, arg2);
-            return 0;
-
-          default:
-            usage();
-        }
-    }
+void
+do_exit(int argc, char *argv[])
+{
+    if (argc > 1)
+        usage();
+
+    uint64_t ints[1];
+    parse_int_args(argc, argv, ints, 1);
+    m5_exit(ints[0]);
+}
+
+void
+do_fail(int argc, char *argv[])
+{
+    if (argc < 1 || argc > 2)
+        usage();
+
+    uint64_t ints[2] = {0,0};
+    parse_int_args(argc, argv, ints, argc);
+    m5_fail(ints[1], ints[0]);
+}
+
+void
+do_reset_stats(int argc, char *argv[])
+{
+    uint64_t ints[2];
+    parse_int_args(argc, argv, ints, 2);
+    m5_reset_stats(ints[0], ints[1]);
+}
+
+void
+do_dump_stats(int argc, char *argv[])
+{
+    uint64_t ints[2];
+    parse_int_args(argc, argv, ints, 2);
+    m5_dump_stats(ints[0], ints[1]);
+}
+
+void
+do_dump_reset_stats(int argc, char *argv[])
+{
+    uint64_t ints[2];
+    parse_int_args(argc, argv, ints, 2);
+    m5_dump_reset_stats(ints[0], ints[1]);
+}
+
+void
+do_read_file(int argc, char *argv[])
+{
+    if (argc > 0)
+        usage();
+
+    read_file(STDOUT_FILENO);
+}
+
+void
+do_write_file(int argc, char *argv[])
+{
+    if (argc != 1 && argc != 2)
+        usage();
+
+    const char *filename = argv[0];
+    const char *host_filename = (argc == 2) ? argv[1] : argv[0];
+
+    write_file(filename, host_filename);
+}
 
-    if (COMPARE("dumpstats")) {
-        switch (argc) {
-          case 4:
-            arg2 = strtoul(argv[3], NULL, 0);
-          case 3:
-            arg1 = strtoul(argv[2], NULL, 0);
-          case 2:
-            m5_dump_stats(arg1, arg2);
-            return 0;
-
-          default:
-            usage();
-        }
+void
+do_exec_file(int argc, char *argv[])
+{
+    if (argc > 0)
+        usage();
+
+    const char *destname = "/tmp/execfile";
+
+    int fid = open(destname, O_WRONLY, 0777);
+    int len = read_file(fid);
+    close(fid);
+    if (len > 0) {
+        execl(destname, "execfile", NULL);
+        err(1, "execl failed!");
     }
+}
+
+void
+do_checkpoint(int argc, char *argv[])
+{
+    uint64_t ints[2];
+    parse_int_args(argc, argv, ints, 2);
+    m5_checkpoint(ints[0], ints[1]);
+}
+
+void
+do_addsymbol(int argc, char *argv[])
+{
+    if (argc != 2)
+        usage();
+
+    uint64_t addr = strtoul(argv[0], NULL, 0);
+    char *symbol = argv[1];
+    m5_add_symbol(addr, symbol);
+}
 
-    if (COMPARE("dumpresetstats")) {
-        switch (argc) {
-          case 4:
-            arg2 = strtoul(argv[3], NULL, 0);
-          case 3:
-            arg1 = strtoul(argv[2], NULL, 0);
-          case 2:
-            m5_dumpreset_stats(arg1, arg2);
-            return 0;
-
-          default:
-            usage();
-        }
+
+void
+do_loadsymbol(int argc, char *argv[])
+{
+    if (argc > 0)
+        usage();
+
+    m5_load_symbol();
+}
+
+void
+do_initparam(int argc, char *argv[])
+{
+    if (argc > 1)
+        usage();
+
+    uint64_t key_str[2];
+    parse_str_args_to_regs(argc, argv, key_str, 2);
+    uint64_t val = m5_init_param(key_str[0], key_str[1]);
+    printf("%"PRIu64, val);
+}
+
+void
+do_sw99param(int argc, char *argv[])
+{
+    if (argc != 0)
+        usage();
+
+    uint64_t param = m5_init_param(0, 0);
+
+    // run-time, rampup-time, rampdown-time, warmup-time, connections
+    printf("%"PRId64" %"PRId64" %"PRId64" %"PRId64" %"PRId64,
+           (param >> 48) & 0xfff,
+           (param >> 36) & 0xfff, (param >> 24) & 0xfff,
+           (param >> 12) & 0xfff, (param >> 0) & 0xfff);
+}
+
+#ifdef linux
+void
+do_pin(int argc, char *argv[])
+{
+    if (argc < 2)
+        usage();
+
+    cpu_set_t mask;
+    CPU_ZERO(&mask);
+
+    const char *sep = ",";
+    char *target = strtok(argv[0], sep);
+    while (target) {
+        CPU_SET(atoi(target), &mask);
+        target = strtok(NULL, sep);
     }
 
-    if (COMPARE("checkpoint")) {
-        switch (argc) {
-          case 4:
-            arg2 = strtoul(argv[3], NULL, 0);
-          case 3:
-            arg1 = strtoul(argv[2], NULL, 0);
-          case 2:
-            m5_checkpoint(arg1, arg2);
-            return 0;
-
-          default:
-            usage();
-        }
-
-        return 0;
+    if (sched_setaffinity(0, sizeof(cpu_set_t), &mask) < 0)
+        err(1, "setaffinity");
+
+    execvp(argv[1], &argv[1]);
+    err(1, "execvp failed!");
+}
+#endif
+
+struct MainFunc
+{
+    char *name;
+    void (*func)(int argc, char *argv[]);
+    char *usage;
+};
+
+struct MainFunc mainfuncs[] = {
+    { "exit",           do_exit,             "[delay]" },
+    { "fail",           do_fail,             "<code> [delay]" },
+    { "resetstats",     do_reset_stats,      "[delay [period]]" },
+    { "dumpstats",      do_dump_stats,       "[delay [period]]" },
+    { "dumpresetstats", do_dump_reset_stats, "[delay [period]]" },
+    { "readfile",       do_read_file,        "" },
+    { "writefile",      do_write_file,       "<filename> [host filename]" },
+    { "execfile",       do_exec_file,        "" },
+    { "checkpoint",     do_checkpoint,       "[delay [period]]" },
+    { "addsymbol",      do_addsymbol,        "<address> <symbol>" },
+    { "loadsymbol",     do_loadsymbol,       "" },
+    { "initparam",      do_initparam,        "[key] // key must be shorter"
+                                             " than 16 chars" },
+    { "sw99param",      do_sw99param,        "" },
+#ifdef linux
+    { "pin",            do_pin,              "<cpu> <program> [args ...]" }
+#endif
+};
+int numfuncs = sizeof(mainfuncs) / sizeof(mainfuncs[0]);
+
+void
+usage()
+{
+    int i;
+
+    for (i = 0; i < numfuncs; ++i) {
+        char *header = i ? "" : "usage:";
+        fprintf(stderr, "%-6s %s %s %s\n",
+                header, progname, mainfuncs[i].name, mainfuncs[i].usage);
     }
+    fprintf(stderr, "\n");
+    fprintf(stderr, "All times in nanoseconds!\n");
 
-    if (COMPARE("readfile")) {
-            char buf[256*1024];
-            int offset = 0;
-            int len;
+    exit(1);
+}
 
-            if (argc != 2)
-                    usage();
+int
+main(int argc, char *argv[])
+{
+    progname = argv[0];
+    if (argc < 2)
+        usage(1);
 
-            while ((len = m5_readfile(buf, sizeof(buf), offset)) > 0) {
-                    write(STDOUT_FILENO, buf, len);
-                    offset += len;
-            }
+    map_m5_mem();
+
+    command = argv[1];
+
+    argv += 2;
+    argc -= 2;
+
+    int i;
+    for (i = 0; i < numfuncs; ++i) {
+        if (strcmp(command, mainfuncs[i].name) != 0)
+            continue;
 
-            return 0;
+        mainfuncs[i].func(argc, argv);
+        exit(0);
     }
 
-    usage();
+    usage(1);
 }