From 33d88529c6c6668f7b6973a3a93635909a0e5622 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Fri, 14 Dec 2018 22:53:42 +0100 Subject: [PATCH] Simplify logging tags This was roop's initial idea, and it turns out to be the better one, now that we can pass cstrings more easily. --- WireGuard/Shared/Logging/Logger.swift | 36 +++++++++++-------- WireGuard/Shared/Logging/ringlogger.c | 9 +++-- WireGuard/Shared/Logging/ringlogger.h | 2 +- WireGuard/WireGuard/UI/iOS/AppDelegate.swift | 2 +- .../SettingsTableViewController.swift | 2 +- .../PacketTunnelProvider.swift | 2 +- 6 files changed, 31 insertions(+), 22 deletions(-) diff --git a/WireGuard/Shared/Logging/Logger.swift b/WireGuard/Shared/Logging/Logger.swift index b8dbdfd..10b90d8 100644 --- a/WireGuard/Shared/Logging/Logger.swift +++ b/WireGuard/Shared/Logging/Logger.swift @@ -5,33 +5,34 @@ import Foundation import os.log public class Logger { + enum LoggerError: Error { + case openFailure + } static var global: Logger? - var log: OpaquePointer? - var tag: String + var log: OpaquePointer - init(withFilePath filePath: String, withTag tag: String) { - self.tag = tag - self.log = open_log(filePath) - if self.log == nil { - os_log("Cannot open log file for writing. Log will not be saved to file.", log: OSLog.default, type: .error) - } + init(withFilePath filePath: String) throws { + guard let log = open_log(filePath) else { throw LoggerError.openFailure } + self.log = log + } + + deinit { + close_log(self.log) } func log(message: String) { - guard let log = log else { return } - write_msg_to_log(log, String(format: "[%@] %@", tag, message.trimmingCharacters(in: .newlines))) + write_msg_to_log(log, message.trimmingCharacters(in: .newlines)) } - func writeLog(mergedWith otherLogFile: String, to targetFile: String) -> Bool { - guard let log = log else { return false } + func writeLog(called ourTag: String, mergedWith otherLogFile: String, called otherTag: String, to targetFile: String) -> Bool { guard let other = open_log(otherLogFile) else { return false } - let ret = write_logs_to_file(targetFile, log, other) + let ret = write_logs_to_file(targetFile, log, ourTag, other, otherTag) close_log(other) return ret == 0 } - static func configureGlobal(withFilePath filePath: String?, withTag tag: String) { + static func configureGlobal(withFilePath filePath: String?) { if Logger.global != nil { return } @@ -39,7 +40,12 @@ public class Logger { os_log("Unable to determine log destination path. Log will not be saved to file.", log: OSLog.default, type: .error) return } - Logger.global = Logger(withFilePath: filePath, withTag: tag) + do { + try Logger.global = Logger(withFilePath: filePath) + } catch { + os_log("Unable to open log file for writing. Log will not be saved to file.", log: OSLog.default, type: .error) + return + } var appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "Unknown version" if let appBuild = Bundle.main.infoDictionary?["CFBundleVersion"] as? String { appVersion += " (\(appBuild))" diff --git a/WireGuard/Shared/Logging/ringlogger.c b/WireGuard/Shared/Logging/ringlogger.c index e3dfe1a..a30b381 100644 --- a/WireGuard/Shared/Logging/ringlogger.c +++ b/WireGuard/Shared/Logging/ringlogger.c @@ -19,7 +19,7 @@ enum { MAX_LOG_LINE_LENGTH = 512, MAX_LINES = 1024, - MAGIC = 0xdeadbeefU + MAGIC = 0xbeefbabeU }; struct log_line { @@ -59,7 +59,7 @@ static bool first_before_second(const struct log_line *line1, const struct log_l return false; } -int write_logs_to_file(const char *file_name, const struct log *log1, const struct log *log2) +int write_logs_to_file(const char *file_name, const struct log *log1, const char *tag1, const struct log *log2, const char *tag2) { uint32_t i1, i2, len1 = log1->header.len, len2 = log2->header.len; char buf[MAX_LOG_LINE_LENGTH]; @@ -78,19 +78,22 @@ int write_logs_to_file(const char *file_name, const struct log *log1, const stru const struct log_line *line1 = &log1->lines[(log1->header.first + i1) % MAX_LINES]; const struct log_line *line2 = &log2->lines[(log2->header.first + i2) % MAX_LINES]; const struct log_line *line; + const char *tag; if (i1 < len1 && (i2 >= len2 || first_before_second(line1, line2))) { line = line1; + tag = tag1; ++i1; } else if (i2 < len2 && (i1 >= len1 || first_before_second(line2, line1))) { line = line2; + tag = tag2; ++i2; } else { break; } memcpy(buf, line->line, MAX_LOG_LINE_LENGTH); buf[MAX_LOG_LINE_LENGTH - 1] = '\0'; - if (fprintf(file, "%lu.%06d: %s\n", line->tv.tv_sec, line->tv.tv_usec, buf) < 0) { + if (fprintf(file, "%lu.%06d: [%s] %s\n", line->tv.tv_sec, line->tv.tv_usec, tag, buf) < 0) { int ret = -errno; fclose(file); return ret; diff --git a/WireGuard/Shared/Logging/ringlogger.h b/WireGuard/Shared/Logging/ringlogger.h index ad58fb8..ca097b2 100644 --- a/WireGuard/Shared/Logging/ringlogger.h +++ b/WireGuard/Shared/Logging/ringlogger.h @@ -8,7 +8,7 @@ struct log; void write_msg_to_log(struct log *log, const char *msg); -int write_logs_to_file(const char *file_name, const struct log *log1, const struct log *log2); +int write_logs_to_file(const char *file_name, const struct log *log1, const char *tag1, const struct log *log2, const char *tag2); struct log *open_log(const char *file_name); void close_log(struct log *log); diff --git a/WireGuard/WireGuard/UI/iOS/AppDelegate.swift b/WireGuard/WireGuard/UI/iOS/AppDelegate.swift index 32c1286..3146346 100644 --- a/WireGuard/WireGuard/UI/iOS/AppDelegate.swift +++ b/WireGuard/WireGuard/UI/iOS/AppDelegate.swift @@ -12,7 +12,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate { func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { - Logger.configureGlobal(withFilePath: FileManager.appLogFileURL?.path, withTag: "APP") + Logger.configureGlobal(withFilePath: FileManager.appLogFileURL?.path) let window = UIWindow(frame: UIScreen.main.bounds) window.backgroundColor = UIColor.white diff --git a/WireGuard/WireGuard/UI/iOS/Settings/SettingsTableViewController.swift b/WireGuard/WireGuard/UI/iOS/Settings/SettingsTableViewController.swift index c87d452..5e8aee6 100644 --- a/WireGuard/WireGuard/UI/iOS/Settings/SettingsTableViewController.swift +++ b/WireGuard/WireGuard/UI/iOS/Settings/SettingsTableViewController.swift @@ -119,7 +119,7 @@ class SettingsTableViewController: UITableViewController { return } - let isWritten = Logger.global?.writeLog(mergedWith: networkExtensionLogFilePath, to: destinationURL.path) ?? false + let isWritten = Logger.global?.writeLog(called: "APP", mergedWith: networkExtensionLogFilePath, called: "NET", to: destinationURL.path) ?? false guard isWritten else { ErrorPresenter.showErrorAlert(title: "Log export failed", message: "Unable to write logs to file", from: self) return diff --git a/WireGuard/WireGuardNetworkExtension/PacketTunnelProvider.swift b/WireGuard/WireGuardNetworkExtension/PacketTunnelProvider.swift index 559c7c2..e2588f8 100644 --- a/WireGuard/WireGuardNetworkExtension/PacketTunnelProvider.swift +++ b/WireGuard/WireGuardNetworkExtension/PacketTunnelProvider.swift @@ -140,7 +140,7 @@ class PacketTunnelProvider: NEPacketTunnelProvider { } private func configureLogger() { - Logger.configureGlobal(withFilePath: FileManager.networkExtensionLogFileURL?.path, withTag: "EXT") + Logger.configureGlobal(withFilePath: FileManager.networkExtensionLogFileURL?.path) wgSetLogger { level, msgC in guard let msgC = msgC else { return } let logType: OSLogType