/*============================================================================== Copyright(c) 2017 Intel Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and / or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ============================================================================*/ #include "GmmLog.h" #if GMM_LOG_AVAILABLE #include "Internal/Common/GmmLibInc.h" #include "Internal/Common/GmmLogger.h" #if _WIN32 #include #include #else #include #include #include #include #include #endif /// Logger instance shared by all of GmmLib within a process #if(_DEBUG || _RELEASE_INTERNAL) GmmLib::Logger &GmmLoggerPerProc = GmmLib::Logger::CreateGmmLogSingleton(); #endif #if _WIN32 namespace spdlog { namespace sinks { ///////////////////////////////////////////////////////////////////////////////////// /// class defines a sink which prints the messages to the debugger ///////////////////////////////////////////////////////////////////////////////////// class Debugger : public sink { void log(const details::log_msg &msg) override { OutputDebugString(GMM_PREFIX_STR); OutputDebugString(msg.formatted.str().c_str()); } void flush() { } }; } } #endif ///////////////////////////////////////////////////////////////////////////////////// /// Initializes Gmm Logger /// /// @return true if initialized successfully. false otherwise ///////////////////////////////////////////////////////////////////////////////////// bool GmmLib::Logger::GmmLogInit() { std::string LogFilePath; std::string ProcPath; std::string ProcName; int Pid = 0; // Get logging method #if _WIN32 uint32_t regkeyVal = 0; if(Utility::GmmUMDReadRegistryFullPath(GMM_LOG_REG_KEY_SUB_PATH, GMM_LOG_TO_FILE, ®keyVal)) { LogMethod = regkeyVal ? ToFile : ToOSLog; } if(Utility::GmmUMDReadRegistryFullPath(GMM_LOG_REG_KEY_SUB_PATH, GMM_LOG_LEVEL_REGKEY, ®keyVal)) { switch(static_cast(regkeyVal)) { case Off: LogLevel = spdlog::level::off; break; case Trace: LogLevel = spdlog::level::trace; break; case Info: LogLevel = spdlog::level::info; break; case Error: LogLevel = spdlog::level::err; break; case Critical: LogLevel = spdlog::level::critical; } } #endif try { if(LogMethod == ToFile) { // Get process name #if _WIN32 TCHAR ProcPathTChar[MAX_PATH]; GetModuleFileName(NULL, ProcPathTChar, MAX_PATH); ProcPath = std::string(ProcPathTChar); size_t PosOfLastSlash = ProcPath.find_last_of("\\") + 1; size_t PosOfLastDot = ProcPath.find_last_of("."); if(PosOfLastDot <= PosOfLastSlash || PosOfLastDot >= ProcPath.length() || PosOfLastSlash >= ProcPath.length()) { ProcName = GMM_UNKNOWN_PROCESS; } else { ProcName = ProcPath.substr(PosOfLastSlash, PosOfLastDot - PosOfLastSlash); } #else ProcPath = "Unknown_Proc_Path"; ProcName = GMM_UNKNOWN_PROCESS; std::ifstream file; file.open("/proc/self/cmdline"); if(file.is_open()) { // Get process name getline(file, ProcPath); size_t PosOfLastSlash = ProcPath.find_last_of("/") + 1; if(PosOfLastSlash >= ProcPath.length()) { ProcName = GMM_UNKNOWN_PROCESS; } else { // "length-1" to remove null character ProcName = ProcPath.substr(PosOfLastSlash, ProcPath.length() - 1); } file.close(); } #endif // Get process ID #if _WIN32 Pid = _getpid(); #else Pid = getpid(); #endif std::string PidStr = std::to_string(Pid); // TODO: Multiple GmmLib instance can be running in the same process. In that case, the file name will be // the same for two instances. Figure out a way to differentiate between the two instances. #if _WIN32 LogFilePath = std::string("c:\\") + std::string(GMM_LOG_FILENAME) + "_" + ProcName + "_" + PidStr; #else LogFilePath = std::string(".//") + std::string(GMM_LOG_FILENAME) + "" + ProcName + "_" + PidStr; #endif // Create logger SpdLogger = spdlog::rotating_logger_mt(GMM_LOGGER_NAME, LogFilePath, GMM_LOG_FILE_SIZE, GMM_ROTATE_FILE_NUMBER); // Log process path SpdLogger->set_pattern("Process path: %v"); SpdLogger->info(ProcPath.c_str()); } else { #if defined(_WIN32) // Log to debugger auto debugger_sink = std::make_shared(); SpdLogger = std::make_shared(GMM_LOGGER_NAME, debugger_sink); #elif defined(__ANDROID__) // Log to logcat SpdLogger = spdlog::android_logger(GMM_LOGGER_NAME, GMM_LOG_TAG); #elif defined(__linux__) // Log to syslog SpdLogger = spdlog::syslog_logger(GMM_LOGGER_NAME, GMM_LOG_TAG, 1 /*Log Pid*/); #else __GMM_ASSERT(0); return false; #endif } } catch(const spdlog::spdlog_ex &ex) { __GMM_ASSERT(0); return false; } // Set log level SpdLogger->set_level(LogLevel); // Set log pattern SpdLogger->set_pattern("[%T.%e] [Thread %t] [%l] %v"); // [Time] [Thread id] [Log Level] [Text to Log] return true; } ///////////////////////////////////////////////////////////////////////////////////// /// Gmm Logger constructor ///////////////////////////////////////////////////////////////////////////////////// GmmLib::Logger::Logger() : LogMethod(ToOSLog), LogLevel(spdlog::level::err) { if(!GmmLogInit()) { spdlog::set_level(spdlog::level::off); } } ///////////////////////////////////////////////////////////////////////////////////// /// Gmm Logger Destructor ///////////////////////////////////////////////////////////////////////////////////// GmmLib::Logger::~Logger() { if(SpdLogger) { SpdLogger->flush(); } } ///////////////////////////////////////////////////////////////////////////////////// /// Gmm Logger C wrappers ///////////////////////////////////////////////////////////////////////////////////// #if !_WIN32 // Linux/Android replacement for MS version of _vscprintf inline int vscprintf_lin(const char *msg, va_list args) { char c; va_list args_cpy; // Copy `args' to prevent internal pointer modification from vsnprintf va_copy(args_cpy, args); int len = vsnprintf(&c, 1, msg, args_cpy); va_end(args_cpy); return len; } #endif ///////////////////////////////////////////////////////////////////////////////////// /// Gmm Logger C wrapper for GMM_LOG_* Macros ///////////////////////////////////////////////////////////////////////////////////// extern "C" void GMM_STDCALL GmmLibLogging(GmmLogLevel Level, const char *str, ...) { va_list args; va_start(args, str); #if _WIN32 const size_t length = _vscprintf(str, args); #else const size_t length = vscprintf_lin(str, args); #endif char *temp = new char[length + 1]; if(temp) { #if _WIN32 vsprintf_s(temp, length + 1, str, args); #else vsnprintf(temp, length + 1, str, args); #endif if(GmmLoggerPerProc.SpdLogger) { switch(Level) { case Trace: // Set log level to trace if we want trace msges to be printed //GmmLoggerPerProc.SpdLogger->set_level(spdlog::level::trace); GmmLoggerPerProc.SpdLogger->trace(temp); break; case Info: // Set log level to info if we want info msges to be printed //GmmLoggerPerProc.SpdLogger->set_level(spdlog::level::info); GmmLoggerPerProc.SpdLogger->info(temp); break; case Error: GmmLoggerPerProc.SpdLogger->critical(temp); break; default: break; } } delete[] temp; } va_end(args); } #endif //#if GMM_LOG_AVAILABLE