src/base/gtest/logging.cc

   1 /*
   2  * Copyright 2017 Google Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met: redistributions of source code must retain the above copyright
   7  * notice, this list of conditions and the following disclaimer;
   8  * redistributions in binary form must reproduce the above copyright
   9  * notice, this list of conditions and the following disclaimer in the
  10  * documentation and/or other materials provided with the distribution;
  11  * neither the name of the copyright holders nor the names of its
  12  * contributors may be used to endorse or promote products derived from
  13  * this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <gtest/gtest.h>
  29
  30 #include <array>
  31 #include <string>
  32
  33 #include "base/cprintf.hh"
  34 #include "base/logging.hh"
  35
  36 namespace {
  37
  38 // This custom exception type will help prevent fatal exceptions from being
  39 // caught by other code in gem5 and let them escape to the gtest framework.
  40 // Unfortunately that results in a somewhat confusing message about an unknown
  41 // exception being thrown after the panic/fatal message has been printed, but
  42 // there will at least be some indication what went wrong.
  43 struct GTestException
  44 {};
  45
  46 class GTestLogger : public Logger
  47 {
  48   public:
  49     using Logger::Logger;
  50
  51   protected:
  52     void log(const Loc &loc, std::string s) override { SUCCEED() << s; }
  53 };
  54
  55 class GTestExitLogger : public Logger
  56 {
  57   public:
  58     using Logger::Logger;
  59
  60   protected:
  61     void
  62     log(const Loc &loc, std::string s) override
  63     {
  64         std::cerr << loc.file << ":" << loc.line << ": " << s;
  65     }
  66     // Throw an exception to escape down to the gtest framework.
  67     void exit() override { throw GTestException(); }
  68 };
  69
  70 GTestExitLogger panicLogger("panic: ");
  71 GTestExitLogger fatalLogger("fatal: ");
  72 GTestLogger warnLogger("warn: ");
  73 GTestLogger infoLogger("info: ");
  74 GTestLogger hackLogger("hack: ");
  75
  76 } // anonymous namespace
  77
  78 Logger &Logger::getPanic() { return panicLogger; }
  79 Logger &Logger::getFatal() { return fatalLogger; }
  80 Logger &Logger::getWarn() { return warnLogger; }
  81 Logger &Logger::getInfo() { return infoLogger; }
  82 Logger &Logger::getHack() { return hackLogger; }