LogManager: implement system module, client api, logging api (Atmosph…

…ere-NX#1617)

Some notes:

* Unless `atmosphere!enable_log_manager` is true, Nintendo's log manager will be used instead.
  * This prevents paying memory costs for LM when not enabling logging.
  * To facilitate this, Atmosphere's log manager has a different program id from Nintendo's.
  * `atmosphere!enable_htc` implies `atmosphere!enable_log_manager`.
* LogManager logs to tma, and the SD card (if `lm!enable_sd_card_logging` is true, which it is by default).
* Binary logs are saved to `lm!sd_card_log_output_directory`, which is `atmosphere/binlogs` by default.

Makefile

@@ -110,6 +110,7 @@ dist-no-debug: all
 	mkdir -p atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000037
 	mkdir -p atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/010000000000003C
 	mkdir -p atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000042
+	mkdir -p atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000420
 	cp stratosphere/boot2/boot2.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000008/exefs.nsp
 	cp stratosphere/dmnt/dmnt.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/010000000000000D/exefs.nsp
 	cp stratosphere/erpt/erpt.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/010000000000002B/exefs.nsp
@@ -119,6 +120,7 @@ dist-no-debug: all
 	cp stratosphere/ro/ro.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000037/exefs.nsp
 	cp stratosphere/jpegdec/jpegdec.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/010000000000003C/exefs.nsp
 	cp stratosphere/pgl/pgl.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000042/exefs.nsp
+	cp stratosphere/LogManager/LogManager.nsp atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000420/exefs.nsp
 	@build_romfs atmosphere-$(AMSVER)/stratosphere_romfs atmosphere-$(AMSVER)/atmosphere/stratosphere.romfs
 	rm -r atmosphere-$(AMSVER)/stratosphere_romfs
 	cp troposphere/reboot_to_payload/reboot_to_payload.nro atmosphere-$(AMSVER)/switch/reboot_to_payload.nro

config_templates/system_settings.ini

@@ -9,6 +9,13 @@
 ; Control whether RO should ease its validation of NROs.
 ; (note: this is normally not necessary, and ips patches can be used.)
 ; ease_nro_restriction = u8!0x1
+[lm]
+; Control whether lm should log to the SD card.
+; Note that this setting does nothing when log manager is not enabled.
+; enable_sd_card_logging = u8!0x1
+; Control the output directory for SD card logs.
+; Note that this setting does nothing when log manager is not enabled/sd card logging is not enabled.
+; sd_card_log_output_directory = str!atmosphere/binlogs
 ; Atmosphere custom settings
 [atmosphere]
 ; Reboot from fatal automatically after some number of milliseconds.
@@ -53,6 +60,10 @@
 ; Controls whether htc is enabled
 ; 0 = Disabled, 1 = Enabled
 ; enable_htc = u8!0x0
+; Controls whether atmosphere's log manager is enabled
+; Note that this setting is ignored (and treated as 1) when htc is enabled.
+; 0 = Disabled, 1 = Enabled
+; enable_log_manager = u8!0x0
 [hbloader]
 ; Controls the size of the homebrew heap when running as applet.
 ; If set to zero, all available applet memory is used as heap.

libraries/libstratosphere/include/stratosphere.hpp

@@ -19,6 +19,9 @@
 /* libvapours (pulls in util, svc, results). */
 #include <vapours.hpp>
 
+/* Libstratosphere diagnostics. */
+#include <stratosphere/diag.hpp>
+
 /* Libstratosphere definitions. */
 #include <stratosphere/ams/impl/ams_system_thread_definitions.hpp>
 
@@ -62,6 +65,7 @@
 #include <stratosphere/kvdb.hpp>
 #include <stratosphere/ldr.hpp>
 #include <stratosphere/lr.hpp>
+#include <stratosphere/lm.hpp>
 #include <stratosphere/map.hpp>
 #include <stratosphere/ncm.hpp>
 #include <stratosphere/nim.hpp>

libraries/libstratosphere/include/stratosphere/ams/impl/ams_system_thread_definitions.hpp

@@ -24,7 +24,7 @@ namespace ams::impl {
     };
 
     #define AMS_DEFINE_SYSTEM_THREAD(__AMS_THREAD_PRIORITY__, __AMS_MODULE__, __AMS_THREAD_NAME__) \
-        constexpr inline const ::ams::impl::SystemThreadDefinition SystemThreadDefinition##__AMS_MODULE__##__AMS_THREAD_NAME__ = { __AMS_THREAD_PRIORITY__, "ams." # __AMS_MODULE__ "." #__AMS_THREAD_NAME__ }
+        constexpr inline const ::ams::impl::SystemThreadDefinition SystemThreadDefinition_##__AMS_MODULE__##_##__AMS_THREAD_NAME__ = { __AMS_THREAD_PRIORITY__, "ams." # __AMS_MODULE__ "." #__AMS_THREAD_NAME__ }
 
     /* sm. */
     AMS_DEFINE_SYSTEM_THREAD(-1, sm, Main);
@@ -69,6 +69,12 @@ namespace ams::impl {
     /* boot2. */
     AMS_DEFINE_SYSTEM_THREAD(20, boot2, Main);
 
+    /* LogManager. */
+    AMS_DEFINE_SYSTEM_THREAD(10, LogManager, MainThread);
+    AMS_DEFINE_SYSTEM_THREAD(10, lm, IpcServer);
+    AMS_DEFINE_SYSTEM_THREAD(10, lm, Flush);
+    AMS_DEFINE_SYSTEM_THREAD(10, lm, HtcsConnection);
+
     /* dmnt. */
     AMS_DEFINE_SYSTEM_THREAD(-3, dmnt, MultiCoreEventManager);
     AMS_DEFINE_SYSTEM_THREAD(-1, dmnt, CheatDebugEvents);
@@ -167,5 +173,5 @@ namespace ams::impl {
 
 }
 
-#define AMS_GET_SYSTEM_THREAD_PRIORITY(__AMS_MODULE__, __AMS_THREAD_NAME__) ::ams::impl::SystemThreadDefinition##__AMS_MODULE__##__AMS_THREAD_NAME__.priority
-#define AMS_GET_SYSTEM_THREAD_NAME(__AMS_MODULE__, __AMS_THREAD_NAME__)     ::ams::impl::SystemThreadDefinition##__AMS_MODULE__##__AMS_THREAD_NAME__.name
+#define AMS_GET_SYSTEM_THREAD_PRIORITY(__AMS_MODULE__, __AMS_THREAD_NAME__) ::ams::impl::SystemThreadDefinition_##__AMS_MODULE__##_##__AMS_THREAD_NAME__.priority
+#define AMS_GET_SYSTEM_THREAD_NAME(__AMS_MODULE__, __AMS_THREAD_NAME__)     ::ams::impl::SystemThreadDefinition_##__AMS_MODULE__##_##__AMS_THREAD_NAME__.name

libraries/libstratosphere/include/stratosphere/diag.hpp

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include <stratosphere/diag/diag_log_types.hpp>
+#include <stratosphere/diag/diag_log_observer.hpp>
+#include <stratosphere/diag/impl/diag_impl_log.hpp>
+#include <stratosphere/diag/diag_log.hpp>
+#include <stratosphere/diag/diag_sdk_log.hpp>
+
+#include <stratosphere/diag/impl/diag_utf8_util.hpp>
+

libraries/libstratosphere/include/stratosphere/diag/diag_log.hpp

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+#include <stratosphere/diag/impl/diag_impl_structured_log.hpp>
+
+#if defined(AMS_IMPL_ENABLE_LOG)
+
+#define AMS_LOG(...)          AMS_IMPL_STRUCTURED_LOG_IMPL("", ::ams::diag::LogSeverity_Info, 0, __VA_ARGS__)
+#define AMS_VLOG(_FMT_, _VL_) AMS_IMPL_STRUCTURED_VLOG_IMPL("", ::ams::diag::LogSeverity_Info, 0, _FMT_, _VL_)
+#define AMS_PUT(_MSG_, _ML_)  AMS_IMPL_STRUCTURED_PUT_IMPL("", ::ams::diag::LogSeverity_Info, 0, _MSG_, _ML_)
+
+#define AMS_STRUCTURED_LOG(_MOD_, _SEV_, _VER_, ...)          AMS_IMPL_STRUCTURED_LOG_IMPL(_MOD_, _SEV_, _VER_, __VA_ARGS__)
+#define AMS_STRUCTURED_VLOG(_MOD_, _SEV_, _VER_, _FMT_, _VL_) AMS_IMPL_STRUCTURED_VLOG_IMPL(_MOD_, _SEV_, _VER_, _FMT_, _VL_)
+#define AMS_STRUCTURED_PUT(_MOD_, _SEV_, _VER_, _MSG_, _ML_)  AMS_IMPL_STRUCTURED_PUT_IMPL(_MOD_, _SEV_, _VER_, _MSG_, _ML_)
+
+#else
+
+#define AMS_LOG(...)          do { /* ... */ } while (false)
+#define AMS_VLOG(_FMT_, _VL_) do { /* ... */ } while (false)
+#define AMS_PUT(_MSG_, _ML_)  do { /* ... */ } while (false)
+
+#define AMS_STRUCTURED_LOG(_MOD_, _SEV_, _VER_, ...)          do { /* ... */ } while (false)
+#define AMS_STRUCTURED_VLOG(_MOD_, _SEV_, _VER_, _FMT_, _VL_) do { /* ... */ } while (false)
+#define AMS_STRUCTURED_PUT(_MOD_, _SEV_, _VER_, _MSG_, _ML_)  do { /* ... */ } while (false)
+
+#endif

libraries/libstratosphere/include/stratosphere/diag/diag_log_observer.hpp

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+#include <stratosphere/diag/diag_log_types.hpp>
+
+namespace ams::diag {
+
+    using LogObserver = void (*)(const LogMetaData &meta, const LogBody &body, void *arg);
+
+    struct LogObserverHolder {
+        LogObserver log_observer;
+        LogObserverHolder *next;
+        bool is_registered;
+        void *arg;
+    };
+
+    constexpr inline void InitializeLogObserverHolder(LogObserverHolder *holder, LogObserver observer, void *arg) {
+        holder->log_observer  = observer;
+        holder->next          = nullptr;
+        holder->is_registered = false;
+        holder->arg           = arg;
+    }
+
+    void RegisterLogObserver(LogObserverHolder *holder);
+    void UnregisterLogObserver(LogObserverHolder *holder);
+
+}

libraries/libstratosphere/include/stratosphere/diag/diag_log_types.hpp

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+
+namespace ams::diag {
+
+    enum LogSeverity {
+        LogSeverity_Trace = 0,
+        LogSeverity_Info  = 1,
+        LogSeverity_Warn  = 2,
+        LogSeverity_Error = 3,
+        LogSeverity_Fatal = 4,
+    };
+
+    struct SourceInfo {
+        int line_number;
+        const char *file_name;
+        const char *function_name;
+    };
+
+    struct LogMetaData {
+        SourceInfo source_info;
+        const char *module_name;
+        LogSeverity severity;
+        int verbosity;
+        bool use_default_locale_charset;
+        void *additional_data;
+        size_t additional_data_size;
+    };
+
+    struct LogBody {
+        const char *message;
+        size_t message_size;
+        bool is_head;
+        bool is_tail;
+    };
+
+    struct LogMessage {
+        const char *fmt;
+        std::va_list *vl;
+    };
+
+}

libraries/libstratosphere/include/stratosphere/diag/diag_sdk_log.hpp

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+#include <stratosphere/diag/impl/diag_impl_structured_log.hpp>
+
+#if defined(AMS_IMPL_ENABLE_SDK_LOG)
+
+#define AMS_SDK_LOG(...)          AMS_IMPL_STRUCTURED_LOG_IMPL("$", ::ams::diag::LogSeverity_Info, 0, __VA_ARGS__)
+#define AMS_SDK_VLOG(_FMT_, _VL_) AMS_IMPL_STRUCTURED_VLOG_IMPL("$", ::ams::diag::LogSeverity_Info, 0, _FMT_, _VL_)
+#define AMS_SDK_PUT(_MSG_, _ML_)  AMS_IMPL_STRUCTURED_PUT_IMPL("$", ::ams::diag::LogSeverity_Info, 0, _MSG_, _ML_)
+
+#else
+
+#define AMS_SDK_LOG(...)          do { /* ... */ } while (false)
+#define AMS_SDK_VLOG(_FMT_, _VL_) do { /* ... */ } while (false)
+#define AMS_SDK_PUT(_MSG_, _ML_)  do { /* ... */ } while (false)
+
+#endif

libraries/libstratosphere/include/stratosphere/diag/impl/diag_impl_build_config.hpp

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+
+#if defined(AMS_BUILD_FOR_DEBUGGING) || defined(AMS_BUILD_FOR_AUDITING)
+    #define AMS_IMPL_ENABLE_SDK_LOG
+#else
+    //#define AMS_IMPL_ENABLE_SDK_LOG
+#endif
+
+#if defined(AMS_ENABLE_LOG)
+    #define AMS_IMPL_ENABLE_LOG
+
+    #if defined(AMS_DISABLE_LOG)
+        #error "Incoherent log configuration"
+    #endif
+#elif defined(AMS_DISABLE_LOG)
+
+#elif defined(AMS_BUILD_FOR_DEBUGGING) || defined(AMS_BUILD_FOR_AUDITING)
+    #define AMS_IMPL_ENABLE_LOG
+#else
+    //#define AMS_IMPL_ENABLE_LOG
+#endif

libraries/libstratosphere/include/stratosphere/diag/impl/diag_impl_log.hpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2018-2020 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+#include <vapours.hpp>
+#include <stratosphere/diag/diag_log_types.hpp>
+
+namespace ams::diag::impl {
+
+    void LogImpl(const LogMetaData &meta, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
+    void VLogImpl(const LogMetaData &meta, const char *fmt, std::va_list vl);
+    void PutImpl(const LogMetaData &meta, const char *msg, size_t msg_size);
+
+}