util/systemc/gem5_within_systemc/sc_logger.cc

   1 /*
   2  * Copyright (c) 2014, 2019 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: Andrew Bardsley
  38  */
  39
  40 /**
  41  * @file
  42  *
  43  * A logger to allow SystemC to capture DPRINTF messages (and similar things)
  44  * using sc_report
  45  */
  46
  47 #include <cstdlib>
  48 #include <cstring>
  49 #include <sstream>
  50
  51 #include "sc_logger.hh"
  52
  53 namespace Gem5SystemC
  54 {
  55
  56 /** Class to act as a streambuf for std::ostream which cuts output strings
  57  *  into lines and offers them to a logger */
  58 class CuttingStreambuf : public std::streambuf
  59 {
  60   public:
  61     /** Accumulate line so far */
  62     std::ostringstream line;
  63
  64     /** Logger to send complete lines to */
  65     Trace::Logger *logger;
  66
  67     CuttingStreambuf(Trace::Logger *logger_) : logger(logger_)
  68     { }
  69
  70     /** Accumulate to line up to \n and then emit */
  71     int overflow(int i);
  72     int sync();
  73
  74     /** Push a line out to the logger */
  75     void outputLine();
  76
  77     ~CuttingStreambuf();
  78 };
  79
  80 void CuttingStreambuf::outputLine()
  81 {
  82     logger->logMessage((Tick)-1, "gem5", "", line.str());
  83     line.clear();
  84     line.str("");
  85 }
  86
  87 /** This is pretty much the least efficient way of doing this, but it has the
  88  *  advantage of having very few corners to get wrong.
  89  *
  90  *  A newly allocated streambuf will have no buffer to serve to its
  91  *  [oi]stream.  It will, therefore, call overflow for every character it
  92  *  wants to insert into the output stream.  Those characters are captured one
  93  *  by one here and added to this->line. */
  94 int
  95 CuttingStreambuf::overflow(int chr)
  96 {
  97     if (chr == '\n')
  98         outputLine();
  99     else if (chr != EOF)
 100         line << (char) chr;
 101
 102     /* Always succeeds */
 103     return 0;
 104 }
 105
 106 int
 107 CuttingStreambuf::sync()
 108 {
 109     if (!line.str().empty())
 110         outputLine();
 111
 112     /* Always succeeds */
 113     return 0;
 114 }
 115
 116 CuttingStreambuf::~CuttingStreambuf()
 117 {
 118     sync();
 119 }
 120
 121 Logger::Logger() :
 122     cuttingStreambuf(new CuttingStreambuf(this)),
 123     stream(cuttingStreambuf)
 124 {
 125 }
 126
 127 Logger::~Logger()
 128 {
 129     stream.flush();
 130     delete cuttingStreambuf;
 131 }
 132
 133 /** Log a single message as a single sc_report call */
 134 void
 135 Logger::logMessage(Tick when, const std::string &name,
 136     const std::string &flag, const std::string &message)
 137 {
 138     /* Need to chop the newline off the message */
 139     std::string message_without_nl = message;
 140     message_without_nl.erase(
 141         message_without_nl.find_last_not_of(" \n\r") + 1);
 142
 143     SC_REPORT_INFO(name.c_str(), message_without_nl.c_str());
 144 }
 145
 146 std::ostream &
 147 Logger::getOstream()
 148 {
 149     return stream;
 150 }
 151
 152 }