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 · Jun 19, 2024 · dddab64 · dddab64
1 parent 453f8c9
commit dddab64
Show file tree

Hide file tree

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

diff --git a/Makefile b/Makefile
@@ -1,16 +1,19 @@
-FEATURES ?= "default"
-SVSM_ARGS = --features ${FEATURES}
-
 SVSM_ARGS_TEST = --no-default-features
 ifdef FEATURES_TEST
 	SVSM_ARGS_TEST += --features ${FEATURES_TEST}
 endif
 
 ifdef RELEASE
 TARGET_PATH=release
+FEATURES ?= "default"
+SVSM_ARGS = --features ${FEATURES}
 CARGO_ARGS += --release
+STAGE2_ARGS =
 else
 TARGET_PATH=debug
+FEATURES ?= "default-debug"
+SVSM_ARGS = --features ${FEATURES}
+STAGE2_ARGS = --features  "enable-console-log"
 endif
 
 ifdef OFFLINE
@@ -111,7 +114,7 @@ bin/meta.bin: utils/gen_meta utils/print-meta
 	./utils/gen_meta $@
 
 bin/stage2.bin: bin
-	cargo build --manifest-path kernel/Cargo.toml ${CARGO_ARGS} --no-default-features --bin stage2
+	cargo build --manifest-path kernel/Cargo.toml ${CARGO_ARGS} ${STAGE2_ARGS} --no-default-features --bin stage2
 	objcopy -O binary ${STAGE2_ELF} $@
 
 bin/svsm-kernel.elf: bin

diff --git a/kernel/Cargo.toml b/kernel/Cargo.toml
@@ -39,8 +39,10 @@ test.workspace = true
 
 [features]
 default = ["mstpm"]
+default-debug = ["enable-console-log", "mstpm"]
 enable-gdb = ["dep:gdbstub", "dep:gdbstub_arch"]
 mstpm = ["dep:libmstpm"]
+enable-console-log = []
 
 [dev-dependencies]
 

diff --git a/kernel/src/cpu/line_buffer.rs b/kernel/src/cpu/line_buffer.rs
@@ -78,18 +78,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));
+                }
             }
         }
     }