util: Make dot_writer ignore NULL simobjects.
[gem5.git] / src / base / misc.cc
1 /*
2 * Copyright (c) 2014, 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) 2002-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 * Authors: Nathan Binkert
41 * Andreas Sandberg
42 */
43
44 #include "base/misc.hh"
45
46 #include <array>
47
48 #include "base/hostinfo.hh"
49 #include "base/output.hh"
50 #include "base/trace.hh"
51 #include "base/types.hh"
52 #include "sim/core.hh"
53
54
55 Logger &
56 Logger::get(LogLevel ll)
57 {
58 static std::array<Logger *, NUM_LOG_LEVELS> loggers{{
59 new ExitLogger(std::cerr, "panic"),
60 new ExitLogger(std::cerr, "fatal"),
61 new Logger(std::cerr, "warn"),
62 new Logger(std::cerr, "info"),
63 new Logger(std::cerr, "hack"),
64 }};
65
66 return *loggers[ll];
67 }
68
69 void
70 Logger::setLevel(LogLevel ll)
71 {
72 for (int i = 0; i < NUM_LOG_LEVELS; ++i)
73 get(LogLevel(i)).enabled = (i <= ll);
74 }
75
76 static void
77 newline_if_needed(std::ostream &stream, const char *format)
78 {
79 const size_t format_len(strlen(format));
80
81 switch (format_len ? format[format_len - 1] : '\0') {
82 case '\n':
83 case '\r':
84 break;
85 default:
86 stream << std::endl;
87 }
88 }
89
90 Logger::Logger(std::ostream &_stream, const char *_prefix)
91 : enabled(true), verbose(false), stream(_stream), prefix(_prefix)
92 {
93 }
94
95 void
96 Logger::printEpilogue(const char *func, const char *file, int line,
97 const char *format)
98 {
99 newline_if_needed(stream, format);
100
101 if (verbose) {
102 ccprintf(stream, " @ tick %d\n[%s:%s, line %d]\n",
103 curTick(), func, file, line);
104 }
105 }
106
107 void
108 ExitLogger::printEpilogue(const char *func, const char *file, int line,
109 const char *format)
110 {
111 Logger::printEpilogue(func, file, line, format);
112
113 ccprintf(stream, "Memory Usage: %ld KBytes\n", memUsage());
114 }