#ifndef OT_UTILITY_LOGGER_HPP_ #define OT_UTILITY_LOGGER_HPP_ #include #include #include #include #include #include #include #include #include #include #include #include namespace ot { // Enum: LogType enum class LogType { DEBUG = 0, INFO = 1, WARNING = 2, ERROR = 3, FATAL = 4 }; // Class: Logger class Logger { public: static constexpr const char* ERROR_COLOR {"\033[1;31m"}; static constexpr const char* FATAL_COLOR {"\033[1;31m"}; static constexpr const char* DEBUG_COLOR {"\033[1;36m"}; static constexpr const char* WARNING_COLOR {"\033[1;33m"}; static constexpr const char* RESET_COLOR {"\033[0m" }; Logger() = default; inline Logger(const std::string&); inline ~Logger(); template void raw(ArgsT&&...); template void debug(const char*, const int, ArgsT&&...); template void info(const char*, const int, ArgsT&&...); template void warning(const char*, const int, ArgsT&&...); template void error(const char*, const int, ArgsT&&...); template void fatal(const char*, const int, ArgsT&&...); inline void redir(const std::string&); private: mutable std::mutex _mutex; FILE* _handle {stderr}; bool _is_tty {::isatty(::fileno(_handle)) == 1}; constexpr const char* _strend(const char*) const; constexpr const char* _basename(const char*, const char*) const; constexpr const char* _basename(const char*) const; inline pid_t _gettid(); template void _write(const char*, const int, ArgsT&&...); }; // Constructor. inline Logger::Logger(const std::string& fpath) { redir(fpath); } // Destructor. inline Logger::~Logger() { if(_handle != stderr) { std::fclose(_handle); } } // Function: _gettid // Adoped from google's open-source library glog. inline pid_t Logger::_gettid() { // On Linux and MacOSX, we try to use gettid(). #if defined OS_LINUX || defined OS_MACOSX #ifndef __NR_gettid #ifdef OS_MACOSX #define __NR_gettid SYS_gettid #elif ! defined __i386__ #error "Must define __NR_gettid for non-x86 platforms" #else #define __NR_gettid 224 #endif #endif static bool lacks_gettid = false; if (!lacks_gettid) { pid_t tid = syscall(__NR_gettid); if (tid != -1) { return tid; } // Technically, this variable has to be volatile, but there is a small // performance penalty in accessing volatile variables and there should // not be any serious adverse effect if a thread does not immediately see // the value change to "true". lacks_gettid = true; } #endif // OS_LINUX || OS_MACOSX // If gettid() could not be used, we use one of the following. #if defined OS_LINUX return getpid(); // Linux: getpid returns thread ID when gettid is absent #elif defined OS_WINDOWS || defined OS_CYGWIN return GetCurrentThreadId(); #else // If none of the techniques above worked, we use pthread_self(). return (pid_t)(uintptr_t)pthread_self(); #endif } // Function: _strend // Compile-time finding of the end of a string. constexpr const char* Logger::_strend(const char* str) const { return *str ? _strend(str + 1) : str; } // Function: _basename // Compile-time finding of a file name. constexpr const char* Logger::_basename(const char* beg, const char* end) const { return (end >= beg && *end != '/') ? _basename(beg, end - 1) : (end + 1); } // Function: _basename // Compile-time finding of a file name. constexpr const char* Logger::_basename(const char* fpath) const { return _basename(fpath, _strend(fpath)); } // Procedure: redir inline void Logger::redir(const std::string& fpath) { if(fpath.empty()) { return; } int fd = ::open(fpath.c_str(), O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR); if (fd == -1) { return; } // Mark the file close-on-exec. ::fcntl(fd, F_SETFD, FD_CLOEXEC); if(_handle = ::fdopen(fd, "w"); _handle == nullptr) { ::close(fd); ::unlink(fpath.c_str()); _handle = stderr; } _is_tty = ::isatty(::fileno(_handle)); } // Procedure: write template void Logger::_write(const char* fpath, const int line, ArgsT&&... args) { // ------------------------ // Message header // ------------------------ std::ostringstream oss; if constexpr(severity == LogType::DEBUG) { if(_is_tty) oss << DEBUG_COLOR; oss << "D "; } else if constexpr(severity == LogType::WARNING) { if(_is_tty) oss << WARNING_COLOR; oss << "W "; } else if constexpr(severity == LogType::ERROR) { if(_is_tty) oss << ERROR_COLOR; oss << "E "; } else if constexpr(severity == LogType::FATAL) { if(_is_tty) oss << FATAL_COLOR; oss << "F "; } else { oss << "I "; } // Append the thread id. oss << std::setw(5) << static_cast(_gettid()) << ' '; // Insert timeinfo auto rt = std::time(nullptr); auto lt = *std::localtime(&rt); oss << std::put_time(<, "%y-%m-%d %T "); oss << _basename(fpath) << ":" << line << "] "; // ------------------------ // Message body // ------------------------ //_write(oss, std::forward(args)...); (oss << ... << args); // ---- Message tail ---- if constexpr(severity != LogType::INFO) { if(_is_tty) oss << RESET_COLOR; } const std::string& message = oss.str(); // ------------------------ // Write to the device. // ------------------------ std::scoped_lock lock(_mutex); std::fwrite(message.data(), 1, message.length(), _handle); std::fflush(_handle); if constexpr(severity == LogType::FATAL) { std::abort(); } } // Procedure: raw template void Logger::raw(ArgsT&&... args) { std::ostringstream oss; (oss << ... << args); const std::string& message = oss.str(); std::scoped_lock lock(_mutex); std::fwrite(message.data(), 1, message.length(), _handle); std::fflush(_handle); } // Procedure: debug template void Logger::debug(const char* fpath, const int line, ArgsT&&... args) { _write(fpath, line, std::forward(args)...); } // Procedure: info template void Logger::info(const char* fpath, const int line, ArgsT&&... args) { _write(fpath, line, std::forward(args)...); } // Procedure: warning template void Logger::warning(const char* fpath, const int line, ArgsT&&... args) { _write(fpath, line, std::forward(args)...); } // Procedure: error template void Logger::error(const char* fpath, const int line, ArgsT&&... args) { _write(fpath, line, std::forward(args)...); } // Procedure: fatal // Log a fatal message and generate the backtrace symbols. template void Logger::fatal(const char* fpath, const int line, ArgsT&&... args) { _write(fpath, line, std::forward(args)...); } }; // end of namespace ot. ----------------------------------------------------------------------- #endif