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