1 // Copyright 2012 The Chromium Authors 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef BASE_APPLE_OSSTATUS_LOGGING_H_ 6 #define BASE_APPLE_OSSTATUS_LOGGING_H_ 7 8 #include <string> 9 10 #include "base/base_export.h" 11 #include "base/logging.h" 12 #include "build/build_config.h" 13 14 #if BUILDFLAG(IS_IOS) 15 #include <MacTypes.h> 16 #else 17 #include <libkern/OSTypes.h> 18 #endif 19 20 // Use the OSSTATUS_LOG family to log messages related to errors in macOS/iOS 21 // system routines that report status via an OSStatus or OSErr value. It is 22 // similar to the PLOG family which operates on errno, but because there is no 23 // global (or thread-local) OSStatus or OSErr value, the specific error must 24 // be supplied as an argument to the OSSTATUS_LOG macro. The message logged 25 // will contain the symbolic constant name corresponding to the status value, 26 // along with the value itself. 27 // 28 // OSErr is just an older 16-bit form of the newer 32-bit OSStatus. Despite 29 // the name, OSSTATUS_LOG can be used equally well for OSStatus and OSErr. 30 31 namespace logging { 32 33 // Returns a UTF8 description from an OSStatus/OSErr value. 34 BASE_EXPORT std::string DescriptionFromOSStatus(OSStatus err); 35 36 class BASE_EXPORT OSStatusLogMessage : public logging::LogMessage { 37 public: 38 OSStatusLogMessage(const char* file_path, 39 int line, 40 LogSeverity severity, 41 OSStatus status); 42 43 OSStatusLogMessage(const OSStatusLogMessage&) = delete; 44 OSStatusLogMessage& operator=(const OSStatusLogMessage&) = delete; 45 46 ~OSStatusLogMessage() override; 47 48 protected: 49 void AppendError(); 50 51 private: 52 OSStatus status_; 53 }; 54 55 class BASE_EXPORT OSStatusLogMessageFatal final : public OSStatusLogMessage { 56 public: 57 using OSStatusLogMessage::OSStatusLogMessage; 58 [[noreturn]] ~OSStatusLogMessageFatal() override; 59 }; 60 61 } // namespace logging 62 63 #if DCHECK_IS_ON() 64 #define MAC_DVLOG_IS_ON(verbose_level) VLOG_IS_ON(verbose_level) 65 #else 66 #define MAC_DVLOG_IS_ON(verbose_level) 0 67 #endif 68 69 #define OSSTATUS_LOG_STREAM(severity, status) \ 70 COMPACT_GOOGLE_LOG_EX_##severity(OSStatusLogMessage, status).stream() 71 #define OSSTATUS_VLOG_STREAM(verbose_level, status) \ 72 logging::OSStatusLogMessage(__FILE__, __LINE__, -verbose_level, status) \ 73 .stream() 74 75 #define OSSTATUS_LOG(severity, status) \ 76 LAZY_STREAM(OSSTATUS_LOG_STREAM(severity, status), LOG_IS_ON(severity)) 77 #define OSSTATUS_LOG_IF(severity, condition, status) \ 78 LAZY_STREAM(OSSTATUS_LOG_STREAM(severity, status), \ 79 LOG_IS_ON(severity) && (condition)) 80 81 #define OSSTATUS_VLOG(verbose_level, status) \ 82 LAZY_STREAM(OSSTATUS_VLOG_STREAM(verbose_level, status), \ 83 VLOG_IS_ON(verbose_level)) 84 #define OSSTATUS_VLOG_IF(verbose_level, condition, status) \ 85 LAZY_STREAM(OSSTATUS_VLOG_STREAM(verbose_level, status), \ 86 VLOG_IS_ON(verbose_level) && (condition)) 87 88 #define OSSTATUS_CHECK(condition, status) \ 89 LAZY_STREAM(OSSTATUS_LOG_STREAM(FATAL, status), !(condition)) \ 90 << "Check failed: " #condition << ". " 91 92 #define OSSTATUS_DLOG(severity, status) \ 93 LAZY_STREAM(OSSTATUS_LOG_STREAM(severity, status), DLOG_IS_ON(severity)) 94 #define OSSTATUS_DLOG_IF(severity, condition, status) \ 95 LAZY_STREAM(OSSTATUS_LOG_STREAM(severity, status), \ 96 DLOG_IS_ON(severity) && (condition)) 97 98 #define OSSTATUS_DVLOG(verbose_level, status) \ 99 LAZY_STREAM(OSSTATUS_VLOG_STREAM(verbose_level, status), \ 100 MAC_DVLOG_IS_ON(verbose_level)) 101 #define OSSTATUS_DVLOG_IF(verbose_level, condition, status) \ 102 LAZY_STREAM(OSSTATUS_VLOG_STREAM(verbose_level, status), \ 103 MAC_DVLOG_IS_ON(verbose_level) && (condition)) 104 105 #define OSSTATUS_DCHECK(condition, status) \ 106 LAZY_STREAM(OSSTATUS_LOG_STREAM(FATAL, status), \ 107 DCHECK_IS_ON() && !(condition)) \ 108 << "Check failed: " #condition << ". " 109 110 #endif // BASE_APPLE_OSSTATUS_LOGGING_H_ 111