Log.h

//
// Copyright (c) 2014-present, Facebook, Inc.
// All rights reserved.
//
// This source code is licensed under the University of Illinois/NCSA Open
// Source License found in the LICENSE file in the root directory of this
// source tree. An additional grant of patent rights can be found in the
// PATENTS file in the same directory.
//
 
#pragma once
 
#include "DebugServer2/Base.h"
#include "DebugServer2/Utils/CompilerSupport.h"
 
#include <cinttypes>
#include <cstdarg>
#include <cstdint>
#include <cstdio>
#include <cstdlib>
 
namespace ds2 {
 
// Log Level
enum LogLevel {
  kLogLevelPacket,
  kLogLevelDebug,
  kLogLevelInfo,
  kLogLevelWarning,
  kLogLevelError,
  kLogLevelFatal,
};
 
LogLevel GetLogLevel();
void SetLogLevel(LogLevel level);
void SetLogColorsEnabled(bool enabled);
std::string const &GetLogOutputFilename();
void SetLogOutputFilename(std::string const &filename);
void SetLogOutputStream(FILE *stream);
 
void Log(int level, char const *classname, char const *funcname,
         char const *format, ...) DS2_ATTRIBUTE_PRINTF(4, 5);
 
// Field width is 2 * sizeof(void *) + 2. We need to add 2 because of the `0x`
// prefix.
#if defined(BITSIZE_32)
#define PRI_PTR "#010" PRIxPTR
#elif defined(BITSIZE_64)
#define PRI_PTR "#018" PRIxPTR
#elif defined(BITSIZE_128)
#define PRI_PTR "#034" PRIxPTR
#endif
 
#define PRI_PTR_CAST(VAL) ((uintptr_t)(VAL))
 
#if defined(COMPILER_MSVC)
#define FUNCTION_NAME __FUNCTION__
#elif defined(COMPILER_CLANG) || defined(COMPILER_GCC)
#define FUNCTION_NAME __PRETTY_FUNCTION__
#else
#error "Compiler not supported."
#endif
 
#define DS2LOG(LVL, ...)                                                       \
  ds2::Log(ds2::kLogLevel##LVL, nullptr, FUNCTION_NAME, __VA_ARGS__)
 
#if !defined(NDEBUG)
#define DS2ASSERT(COND)                                                        \
  do {                                                                         \
    if (!(COND)) {                                                             \
      DS2LOG(Fatal, "assertion `%s' failed at %s:%d", #COND, __FILE__,         \
             __LINE__);                                                        \
      DS2_UNREACHABLE();                                                       \
    }                                                                          \
  } while (0)
#else
#define DS2ASSERT(COND)                                                        \
  do {                                                                         \
    if (!(COND))                                                               \
      DS2_UNREACHABLE();                                                       \
  } while (0)
#endif
 
#if defined(COMPILER_CLANG) || defined(COMPILER_GCC)
#define DS2BUG(MESSAGE, ...)                                                   \
  do {                                                                         \
    DS2LOG(Fatal, "bug at %s:%d: " MESSAGE, __FILE__, __LINE__,                \
           ##__VA_ARGS__);                                                     \
    DS2_UNREACHABLE();                                                         \
  } while (0)
#elif defined(COMPILER_MSVC)
#define DS2BUG(MESSAGE, ...)                                                   \
  do {                                                                         \
    DS2LOG(Fatal, "bug at %s:%d: " MESSAGE, __FILE__, __LINE__, __VA_ARGS__);  \
    DS2_UNREACHABLE();                                                         \
  } while (0)
#else
#error "Compiler not supported."
#endif
} // namespace ds2