Add a feature named enable-console-log.

This feature can be enable to print log messages to console in addition to storing them in the log buffer. Enable this feature by default for debug builds. Signed-off-by: Vasant Karasulli <[email protected]>
coconut-svsm · Jul 11, 2023 · 5af0ce1 · 5af0ce1
1 parent 7218638
commit 5af0ce1
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 7 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -31,7 +31,7 @@ jobs:
       # ld to work, so build all the objects without performing the
       # final linking step.
       - name: Build
-        run: make FEATURES="default,enable-gdb" stage1/stage1.o stage1/reset.o
+        run: make FEATURES="default-debug,enable-gdb" stage1/stage1.o stage1/reset.o
 
       - name: Run tests
         run: make test

diff --git a/Cargo.toml b/Cargo.toml
@@ -27,6 +27,8 @@ packit = { git = "https://github.com/coconut-svsm/packit", version = "0.1.0" }
 [build-dependencies]
 
 [features]
-default = ["enable-stacktrace"]
+default-release = ["enable-stacktrace"]
+default-debug = ["enable-stacktrace", "enable-console-log"]
 enable-stacktrace = []
 enable-gdb = ["dep:gdbstub", "dep:gdbstub_arch"]
+enable-console-log = []
diff --git a/Makefile b/Makefile
@@ -1,11 +1,12 @@
-FEATURES ?= "default"
-CARGO_ARGS = --features ${FEATURES}
-
 ifdef RELEASE
 TARGET_PATH="release"
+FEATURES ?= "default-release"
+CARGO_ARGS = --features ${FEATURES}
 CARGO_ARGS += --release
 else
 TARGET_PATH="debug"
+FEATURES ?= "default-debug"
+CARGO_ARGS = --features ${FEATURES}
 endif
 
 

diff --git a/src/cpu/line_buffer.rs b/src/cpu/line_buffer.rs
@@ -3,6 +3,8 @@
 // Copyright (c) 2022-2023 SUSE LLC
 //
 // Author: Vasant Karasulli <[email protected]>
+#[cfg(feature = "enable-console-log")]
+use crate::console::_print;
 
 use crate::cpu::percpu::this_cpu_mut;
 use crate::log_buffer::LB;
@@ -74,18 +76,30 @@ impl log::Log for BufferLogger {
                 line_buf
                     .write_fmt(format_args!("[{}] {}: {}\n", comp, lvl, rec_args))
                     .unwrap();
+                #[cfg(feature = "enable-console-log")]
+                {
+                    _print(format_args!("[{}] {}: {}\n", comp, lvl, rec_args));
+                }
             }
 
             log::Level::Info => {
                 line_buf
                     .write_fmt(format_args!("[{}] {}\n", comp, rec_args))
                     .unwrap();
+                #[cfg(feature = "enable-console-log")]
+                {
+                    _print(format_args!("[{}] {}\n", comp, rec_args));
+                }
             }
 
             log::Level::Debug | log::Level::Trace => {
                 line_buf
                     .write_fmt(format_args!("[{}/{}] {} {}\n", comp, target, lvl, rec_args))
                     .unwrap();
+                #[cfg(feature = "enable-console-log")]
+                {
+                    _print(format_args!("[{}/{}] {} {}\n", comp, target, lvl, rec_args));
+                }
             }
         }
     }

diff --git a/src/stage2.rs b/src/stage2.rs
@@ -105,7 +105,10 @@ fn setup_env() {
         WRITER.lock().set(&mut CONSOLE_SERIAL);
     }
 
-    init_console();
+    #[cfg(feature = "enable-console-log")]
+    {
+        init_console();
+    }
 
     install_buffer_logger("Stage2");
 

diff --git a/src/svsm.rs b/src/svsm.rs
@@ -388,7 +388,11 @@ pub extern "C" fn svsm_start(li: &KernelLaunchInfo, mi: &MigrateInfo) {
         WRITER.lock().set(&mut CONSOLE_SERIAL);
     }
 
-    init_console();
+    #[cfg(feature = "enable-console-log")]
+    {
+        init_console();
+    }
+
     install_buffer_logger("SVSM");
 
     log::info!("COCONUT Secure Virtual Machine Service Module (SVSM)");