SkyPat-3.1.1/lib/skypat.cpp

//===- skypat.cpp ---------------------------------------------------------===//
//
//                     The SkyPat Team
//
// This file is distributed under the New BSD License.
// See LICENSE for details.
//
//===----------------------------------------------------------------------===//
#include <skypat/skypat.h>
#include <skypat/Support/Timer.h>
#include <skypat/Support/Perf.h>
#include <skypat/Support/ManagedStatic.h>
#include <skypat/Support/OStrStream.h>
#include <vector>
#include <cassert>
#include <cstdlib>
#include <ios>
#include <ostream>
#include <iostream>
#include <stdint.h>
#include <algorithm>
#include <cstdio>
#include <time.h>

#include <skypat/Config/Config.h>

using namespace skypat;

/* Define the numebr of iteration of performance loop */
#define SKYPAT_PERFORM_LOOP_TIMES 1

namespace skypat{
/* Establish perf event string array */
char const *Perf_event_name[] = {
  "CPU CYCLES", "INST   NUM",
  "CACHE  REF", "CACHE MISS",
  "BR    INST", "BR  MISSES",
  "BUS CYCLES", "STALLFRONT",
  "STALL BACK", "REF CYCLES",
  "CPU  CLOCK", "TASK CLOCK",
  "PAGEFAULTS", "CTX SWITCH",
  "CPUMIGRATE", "PG FAULT m",
  "PG FAULT M", "ALIGNFAULT",
  "EMU  FAULT", "D U M M Y "
};
} // namespace of skypat

//===----------------------------------------------------------------------===//
// Non-member function
//===----------------------------------------------------------------------===//
testing::TestInfo*
testing::MakeAndRegisterTestInfo(const char* pCaseName, const char* pTestName,
                                 testing::TestFactoryBase* pFactory)
{
  return testing::UnitTest::self()->addTestInfo(pCaseName, pTestName, *pFactory);
}

std::string testing::GetBoolAssertionFailureMessage(
    const skypat::testing::AssertionResult& pAssertionResult,
    const char* pExpressionText,
    const char* pActualPredicateValue,
    const char* pExpectedPredicateValue)
{
  std::string result;
  OStrStream OS(result);
  OS << "Value of: " << pExpressionText
     << "\n  Actual:   " << pActualPredicateValue;
  if (pAssertionResult.hasMessage())
    OS << "(" << pAssertionResult.message() << ")";
  OS << "\n  Expected: " << pExpectedPredicateValue;
  return result;
}

//===----------------------------------------------------------------------===//
// PerfIterator
//===----------------------------------------------------------------------===//
testing::PerfIterator::PerfIterator(const char* pFile, int pLine)
  : m_Counter(0),
    m_pTimer(new internal::Timer()),
    m_pPerf(new internal::Perf()),
    m_pPerfResult(testing::UnitTest::self()->addPerfPartResult(pFile, pLine)) {

  m_pTimer->start();
  m_pPerf->start();
}

testing::PerfIterator::PerfIterator(const char* pFile, int pLine,\
									enum PerfEvent pEvent)
  : m_Counter(0),
    m_pTimer(new internal::Timer()),
    m_pPerf(new internal::Perf(pEvent)),
    m_pPerfResult(testing::UnitTest::self()->addPerfPartResult(pFile, pLine)) {

  m_pTimer->start();
  m_pPerf->start();
}

testing::PerfIterator::~PerfIterator()
{
  delete m_pTimer;
  delete m_pPerf;
}

bool testing::PerfIterator::hasNext() const
{
  if (m_Counter < SKYPAT_PERFORM_LOOP_TIMES)
    return true;

  m_pTimer->stop();
  m_pPerf->stop();

  m_pPerfResult->setTimerNum(m_pTimer->interval());
  m_pPerfResult->setPerfEventNum(m_pPerf->interval());
  m_pPerfResult->setPerfEventType(m_pPerf->eventType());
  return false;
}

testing::PerfIterator& testing::PerfIterator::next()
{
  ++m_Counter;
  return *this;
}

//===----------------------------------------------------------------------===//
// PartResult
//===----------------------------------------------------------------------===//
testing::PartResult::PartResult(const std::string& pFileName, int pLoC)
  : m_FileName(pFileName), m_LoC(pLoC), m_Message() {
}

testing::PartResult::PartResult(const std::string& pFileName,
                                int pLoC,
                                const std::string& pMessage)
  : m_FileName(pFileName), m_LoC(pLoC), m_Message(pMessage) {
}

//===----------------------------------------------------------------------===//
// TestPartResult
//===----------------------------------------------------------------------===//
testing::TestPartResult::TestPartResult(Type pType,
                                        const std::string& pFileName,
                                        int pLoC,
                                        const std::string& pMessage)
  : PartResult(pFileName, pLoC, pMessage), m_Type(pType) {
}

testing::TestPartResult&
testing::TestPartResult::appendUserMessage(const std::string& pMessage)
{
  if (!pMessage.empty())
    update_message(message() + "\n" + pMessage);
  return *this;
}

//===----------------------------------------------------------------------===//
// PerfPartResult
//===----------------------------------------------------------------------===//
testing::PerfPartResult::PerfPartResult(const std::string& pFileName,
                                        int pLoC)
  : PartResult(pFileName, pLoC) {
}

testing::Interval testing::PerfPartResult::getTimerNum() const
{
  return m_PerfTimerNum;
}

testing::Interval testing::PerfPartResult::getPerfEventNum() const
{
  return m_PerfEventNum;
}

testing::Interval testing::PerfPartResult::getPerfEventType() const
{
  return m_PerfEventType;
}

void testing::PerfPartResult::setTimerNum(testing::Interval pTimerNum)
{
  m_PerfTimerNum = pTimerNum;
  OStrStream os(m_Message);
  os << pTimerNum << " ns;";
}

void testing::PerfPartResult::setPerfEventNum(testing::Interval pEventNum)
{
  m_PerfEventNum = pEventNum;
}

void testing::PerfPartResult::setPerfEventType(testing::Interval pEventType)
{
  m_PerfEventType = pEventType;
}

//===----------------------------------------------------------------------===//
// TestResult
//===----------------------------------------------------------------------===//
testing::TestResult::TestResult(const TestInfo& pInfo)
  : m_Info(pInfo), m_Conclusion(kNotTested) {
}

testing::TestResult::~TestResult()
{
}

bool testing::TestResult::isPassed() const
{
  return (kPassed == m_Conclusion);
}

bool testing::TestResult::isFailed() const
{
  return (kFailed == m_Conclusion);
}

const testing::TestResult::Reliability& testing::TestResult::reliability() const
{
  return m_Info.getTestResults();
}

const testing::TestResult::Performance& testing::TestResult::performance() const
{
  return m_Info.getPerfResults();
}

//===----------------------------------------------------------------------===//
// TestCase
//===----------------------------------------------------------------------===//
testing::TestCase::TestCase(const std::string& pCaseName)
  : m_CaseName(pCaseName)
{
}

testing::TestCase::~TestCase()
{
  InfoList::iterator info, iEnd = m_InfoList.end();
  for (info = m_InfoList.begin(); info != iEnd; ++info) {
    delete (*info);
  }
}

testing::TestInfo*
testing::TestCase::addTestInfo(const std::string& pTestName,
                               testing::TestFactoryBase& pFactory)
{
  testing::TestInfo* info = new testing::TestInfo(this, pTestName, pFactory);
  m_InfoList.push_back(info);
  return info;
}

//===----------------------------------------------------------------------===//
// TestInfo
//===----------------------------------------------------------------------===//
testing::TestInfo::TestInfo(TestCase* pTestCase,
                            const std::string& pTestName,
                            testing::TestFactoryBase& pFactory)
  : m_pTestCase(pTestCase),
    m_TestName(pTestName),
    m_Result(*this),
    m_pFactory(&pFactory) {
}

testing::TestInfo::~TestInfo()
{
  delete m_pFactory;
  TestPartResultList::iterator tt, tEnd = m_TestResultList.end();
  for (tt = m_TestResultList.begin(); tt != tEnd; ++tt) {
    delete (*tt);
  }
  PerfPartResultList::iterator pt, pEnd = m_PerfResultList.end();
  for (pt = m_PerfResultList.begin(); pt != pEnd; ++pt) {
    delete (*pt);
  }
}

void testing::TestInfo::run()
{
  UnitTest& unittest = *UnitTest::self();
  Repeater& repeater = unittest.repeater();
  skypat::Test* test = m_pFactory->CreateTest();
  if (NULL != test) {
    repeater.OnSetUpStart(unittest);
    test->SetUp();
    repeater.OnSetUpEnd(unittest);

    repeater.OnTestStart(*this);
    test->run();
    repeater.OnTestEnd(*this);

    repeater.OnTearDownStart(unittest);
    test->TearDown();
    repeater.OnTearDownEnd(unittest);
  }
  delete test;
}

void testing::TestInfo::addTestPartResult(const TestPartResult& pResult)
{
  if (m_TestResultList.empty()) {
    m_Result.setConclusion(testing::TestResult::kPassed);
  }

  if (testing::TestPartResult::kSuccess != pResult.type()) {
    m_Result.setConclusion(testing::TestResult::kFailed);
    m_TestResultList.push_back(new TestPartResult(pResult));
  }
}

testing::PerfPartResult*
testing::TestInfo::addPerfPartResult(const char* pFile, int pLine)
{
  PerfPartResult* perf_pr = new PerfPartResult(pFile, pLine);
  m_PerfResultList.push_back(perf_pr);
  return perf_pr;
}

//===----------------------------------------------------------------------===//
// AssertionResult
//===----------------------------------------------------------------------===//
skypat::testing::AssertionResult::AssertionResult(const AssertionResult& pOther)
  : m_bSuccess(pOther.m_bSuccess), m_Message(pOther.m_Message) {
}

skypat::testing::AssertionResult::AssertionResult(bool pSuccess)
  : m_bSuccess(pSuccess) {
}

skypat::testing::AssertionResult
skypat::testing::AssertionResult::operator!() const
{
  AssertionResult negative(!m_bSuccess);
  negative << m_Message;
  return negative;
}

template <typename T> skypat::testing::AssertionResult&
skypat::testing::AssertionResult::operator<<(const T& pValue)
{
  skypat::OStrStream OS(m_Message);
  OS << pValue;
  return *this;
}

skypat::testing::AssertionResult&
skypat::testing::AssertionResult::operator<<(
                  ::std::ostream& (*basic_manipulator)(::std::ostream& stream))
{
  skypat::OStrStream OS(m_Message);
  OS << basic_manipulator;
  return *this;
}

//===----------------------------------------------------------------------===//
// Message
//===----------------------------------------------------------------------===//
skypat::testing::Message::Message()
  : m_Message(), m_OSS(m_Message) {
}

//===----------------------------------------------------------------------===//
// AssertHelper
//===----------------------------------------------------------------------===//
skypat::testing::AssertHelper::AssertHelper(TestPartResult::Type pType,
                                         const std::string& pFile,
                                         int pLineOfCode,
                                         const std::string& pMessage)
  : m_Result(pType, pFile, pLineOfCode, pMessage) {
  // m_Result is a TestPartResult
}

// Store a run-time result
void skypat::testing::AssertHelper::operator=(const Message& pMesg)
{
  m_Result.appendUserMessage(pMesg.str());
  UnitTest::self()->addTestPartResult(m_Result);
}

//===----------------------------------------------------------------------===//
// Log
//===----------------------------------------------------------------------===//
testing::Log::Log(Severity pSeverity,
                  const std::string& pFileName,
                  int pLoC)
  : m_Severity(pSeverity) {
  const char* const mesg =
    kInfo    == pSeverity ? "[  INFO ]" :
    kWarning == pSeverity ? "[WARNING]" :
    kError   == pSeverity ? "[ ERROR ]" : "[ FATAL ]";

  getOStream() << std::endl << mesg << FormatFileLocation(pFileName, pLoC)
               << ": ";
}

testing::Log::~Log()
{
  getOStream() << std::endl;
  if (kFatal == m_Severity) {
    shutdown();
    fflush(stderr);
    exit(1);
  }
}

::std::ostream& testing::Log::getOStream()
{
  return ::std::cerr;
}

std::string
testing::Log::FormatFileLocation(const std::string& pFileName, int pLoC)
{
  std::string result;
  OStrStream OS(result);
  if (pFileName.empty())
    OS << "(unknown file)";
  else
    OS << pFileName;

  if (pLoC < 0) {
    OS << ":";
    return result;
  }
#ifdef _MSC_VER
  OS << "(" << pLoC << "):";
#else
  OS << ":" << pLoC << ":";
#endif  // _MSC_VER
  return result;
}