Move OSStatus logging to base/apple

Bug: 1444927
Change-Id: I7e2df7c3e235711071050f1663127eb12439535c
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4780399
Reviewed-by: Mark Mentovai <[email protected]>
Auto-Submit: Avi Drissman <[email protected]>
Owners-Override: Avi Drissman <[email protected]>
Commit-Queue: Avi Drissman <[email protected]>
Cr-Commit-Position: refs/heads/main@{#1184197}

Author: Avi Drissman

base/BUILD.gn

@@ -1953,6 +1953,8 @@ component("base") {
       "apple/call_with_eh_frame_asm.S",
       "apple/dispatch_source_mach.cc",
       "apple/dispatch_source_mach.h",
+      "apple/osstatus_logging.h",
+      "apple/osstatus_logging.mm",
       "apple/owned_objc.h",
       "apple/owned_objc.mm",
       "apple/scoped_cffiledescriptorref.h",
@@ -1964,8 +1966,6 @@ component("base") {
       "files/file_util_apple.mm",
       "mac/foundation_util.h",
       "mac/foundation_util.mm",
-      "mac/mac_logging.h",
-      "mac/mac_logging.mm",
       "mac/mach_logging.cc",
       "mac/mach_logging.h",
       "mac/scoped_mach_port.cc",

base/mac/mac_logging.h renamed to base/apple/osstatus_logging.h

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef BASE_MAC_MAC_LOGGING_H_
-#define BASE_MAC_MAC_LOGGING_H_
+#ifndef BASE_APPLE_OSSTATUS_LOGGING_H_
+#define BASE_APPLE_OSSTATUS_LOGGING_H_
 
 #include <string>
 
@@ -17,7 +17,7 @@
 #include <libkern/OSTypes.h>
 #endif
 
-// Use the OSSTATUS_LOG family to log messages related to errors in Mac OS X
+// 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
@@ -30,7 +30,7 @@
 
 namespace logging {
 
-// Returns a UTF8 description from an OS X Status error.
+// Returns a UTF8 description from an OSStatus/OSErr value.
 BASE_EXPORT std::string DescriptionFromOSStatus(OSStatus err);
 
 class BASE_EXPORT OSStatusLogMessage : public logging::LogMessage {
@@ -58,44 +58,44 @@ class BASE_EXPORT OSStatusLogMessage : public logging::LogMessage {
 #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()
+  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))
+  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))
+  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(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))
+  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_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))
+  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))
+  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(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))
+  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_MAC_MAC_LOGGING_H_
+#endif  // BASE_APPLE_OSSTATUS_LOGGING_H_

base/mac/mac_logging.mm renamed to base/apple/osstatus_logging.mm

@@ -2,46 +2,30 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "base/mac/mac_logging.h"
+#include "base/apple/osstatus_logging.h"
 
 #import <Foundation/Foundation.h>
 
 #include <iomanip>
 
-#include "build/build_config.h"
-
-#if !BUILDFLAG(IS_IOS)
-#include <CoreServices/CoreServices.h>
-#endif
-
 namespace logging {
 
 std::string DescriptionFromOSStatus(OSStatus err) {
-  NSError* error =
-      [NSError errorWithDomain:NSOSStatusErrorDomain code:err userInfo:nil];
+  NSError* error = [NSError errorWithDomain:NSOSStatusErrorDomain
+                                       code:err
+                                   userInfo:nil];
   return error.description.UTF8String;
 }
 
 OSStatusLogMessage::OSStatusLogMessage(const char* file_path,
                                        int line,
                                        LogSeverity severity,
                                        OSStatus status)
-    : LogMessage(file_path, line, severity),
-      status_(status) {
-}
+    : LogMessage(file_path, line, severity), status_(status) {}
 
 OSStatusLogMessage::~OSStatusLogMessage() {
-#if BUILDFLAG(IS_IOS)
-  // TODO(crbug.com/546375): Consider using NSError with NSOSStatusErrorDomain
-  // to try to get a description of the failure.
-  stream() << ": " << status_;
-#else
-  stream() << ": "
-           << DescriptionFromOSStatus(status_)
-           << " ("
-           << status_
+  stream() << ": " << DescriptionFromOSStatus(status_) << " (" << status_
            << ")";
-#endif
 }
 
 }  // namespace logging

base/mac/authorization_util.mm

@@ -11,9 +11,9 @@
 #include <string>
 
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/logging.h"
 #include "base/mac/foundation_util.h"
-#include "base/mac/mac_logging.h"
 #include "base/mac/scoped_authorizationref.h"
 #include "base/posix/eintr_wrapper.h"
 #include "base/strings/string_number_conversions.h"

base/mac/foundation_util.mm

@@ -11,10 +11,10 @@
 #include <vector>
 
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/containers/adapters.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
-#include "base/mac/mac_logging.h"
 #include "base/notreached.h"
 #include "base/numerics/checked_math.h"
 #include "base/numerics/safe_conversions.h"

base/mac/mac_util.mm

@@ -17,10 +17,10 @@
 
 #include "base/apple/bridging.h"
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/mac/foundation_util.h"
-#include "base/mac/mac_logging.h"
 #include "base/mac/scoped_aedesc.h"
 #include "base/mac/scoped_cftyperef.h"
 #include "base/mac/scoped_ioobject.h"

chrome/app_shim/chrome_main_app_mode_mac.mm

@@ -13,6 +13,7 @@
 
 #include "base/allocator/early_zone_registration_apple.h"
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/at_exit.h"
 #include "base/base_switches.h"
 #include "base/check.h"
@@ -21,7 +22,6 @@
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/functional/bind.h"
-#include "base/mac/mac_logging.h"
 #include "base/message_loop/message_pump_type.h"
 #include "base/run_loop.h"
 #include "base/strings/sys_string_conversions.h"

chrome/browser/apps/app_shim/app_shim_manager_mac.cc

@@ -12,6 +12,7 @@
 
 #include "apps/app_lifetime_monitor_factory.h"
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/barrier_closure.h"
 #include "base/debug/dump_without_crashing.h"
 #include "base/feature_list.h"
@@ -22,7 +23,6 @@
 #include "base/hash/sha1.h"
 #include "base/logging.h"
 #include "base/mac/foundation_util.h"
-#include "base/mac/mac_logging.h"
 #include "base/memory/raw_ptr.h"
 #include "base/no_destructor.h"
 #include "base/strings/stringprintf.h"

chrome/browser/mac/install_from_dmg.mm

@@ -21,13 +21,13 @@
 
 #include "base/apple/bridging.h"
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/mac/authorization_util.h"
 #include "base/mac/foundation_util.h"
-#include "base/mac/mac_logging.h"
 #include "base/mac/mac_util.h"
 #include "base/mac/mach_logging.h"
 #include "base/mac/scoped_authorizationref.h"

chrome/browser/mac/keystone_glue.mm

@@ -13,13 +13,13 @@
 
 #include "base/apple/bridging.h"
 #include "base/apple/bundle_locations.h"
+#include "base/apple/osstatus_logging.h"
 #include "base/file_version_info.h"
 #include "base/functional/bind.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/mac/authorization_util.h"
 #include "base/mac/foundation_util.h"
-#include "base/mac/mac_logging.h"
 #include "base/memory/ref_counted.h"
 #include "base/no_destructor.h"
 #include "base/strings/string_number_conversions.h"