misc: Rename misc.(hh|cc) to logging.(hh|cc)

These files aren't a collection of miscellaneous stuff, they're the
definition of the Logger interface, and a few utility macros for
calling into that interface (panic, warn, etc.).

Change-Id: I84267ac3f45896a83c0ef027f8f19c5e9a5667d1
Reviewed-on: https://gem5-review.googlesource.com/6226
Reviewed-by: Brandon Potter <Brandon.Potter@amd.com>
Maintainer: Gabe Black <gabeblack@google.com>

1 files changed, 122 insertions, 0 deletions

diff --git a/src/base/logging.cc b/src/base/logging.cc
new file mode 100644
index 000000000..cec9c8360
--- /dev/null
+++ b/src/base/logging.cc
@@ -0,0 +1,122 @@
+/*
+ * Copyright (c) 2014, 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) 2002-2005 The Regents of The University of Michigan
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Nathan Binkert
+ *          Andreas Sandberg
+ */
+
+#include "base/logging.hh"
+
+#include <array>
+
+#include "base/hostinfo.hh"
+#include "base/output.hh"
+#include "base/trace.hh"
+#include "base/types.hh"
+#include "sim/core.hh"
+
+void
+Logger::setLevel(LogLevel ll)
+{
+    for (int i = 0; i < NUM_LOG_LEVELS; ++i)
+        get(LogLevel(i)).enabled = (i <= ll);
+}
+
+static void
+newline_if_needed(std::ostream &stream, const char *format)
+{
+    const size_t format_len(strlen(format));
+
+    switch (format_len ? format[format_len - 1] : '\0') {
+      case '\n':
+      case '\r':
+        break;
+      default:
+        stream << std::endl;
+    }
+}
+
+Logger::Logger(std::ostream &_stream, const char *_prefix)
+    : enabled(true), verbose(false), stream(_stream), prefix(_prefix)
+{
+}
+
+void
+Logger::printEpilogue(const char *func, const char *file, int line,
+                        const char *format)
+{
+    newline_if_needed(stream, format);
+
+    if (verbose) {
+        ccprintf(stream, " @ tick %d\n[%s:%s, line %d]\n",
+                 curTick(), func, file, line);
+    }
+}
+
+class ExitLogger : public Logger
+{
+  public:
+    using Logger::Logger;
+
+    void printEpilogue(const char *func, const char *file, int line,
+                       const char *format) override;
+};
+
+void
+ExitLogger::printEpilogue(const char *func, const char *file, int line,
+                            const char *format)
+{
+    Logger::printEpilogue(func, file, line, format);
+
+    ccprintf(stream, "Memory Usage: %ld KBytes\n", memUsage());
+}
+
+Logger &
+Logger::get(LogLevel ll)
+{
+    static std::array<Logger *, NUM_LOG_LEVELS> loggers{{
+        new ExitLogger(std::cerr, "panic"),
+        new ExitLogger(std::cerr, "fatal"),
+        new Logger(std::cerr, "warn"),
+        new Logger(std::cerr, "info"),
+        new Logger(std::cerr, "hack"),
+    }};
+
+    return *loggers[ll];
+}