From b2bb7687ad2f12b7bd7e53370f544f43dc6f475c Mon Sep 17 00:00:00 2001
From: Seiya Nuta <nuta@seiya.me>
Date: Mon, 8 Nov 2021 22:53:06 +0900
Subject: [PATCH] Implement boot time profiling (#67)

---
 kernel/arch/x64/mod.rs     |  2 ++
 kernel/arch/x64/profile.rs |  3 +++
 kernel/boot.rs             | 21 +++++++++++++++++++++
 kernel/main.rs             |  1 +
 kernel/profile.rs          | 18 ++++++++++++++++++
 5 files changed, 45 insertions(+)
 create mode 100644 kernel/arch/x64/profile.rs
 create mode 100644 kernel/profile.rs

diff --git a/kernel/arch/x64/mod.rs b/kernel/arch/x64/mod.rs
index 0cca241a..ca7ac5f5 100644
--- a/kernel/arch/x64/mod.rs
+++ b/kernel/arch/x64/mod.rs
@@ -19,6 +19,7 @@ mod lock;
 mod page_table;
 mod pit;
 mod process;
+mod profile;
 mod semihosting;
 mod serial;
 mod syscall;
@@ -41,6 +42,7 @@ pub use ioapic::enable_irq;
 pub use lock::{SpinLock, SpinLockGuard};
 pub use page_table::{PageFaultReason, PageTable};
 pub use process::{switch_thread, Process};
+pub use profile::read_clock_counter;
 #[cfg(test)]
 pub use semihosting::{semihosting_halt, ExitStatus};
 pub use serial::{print_str, printchar};
diff --git a/kernel/arch/x64/profile.rs b/kernel/arch/x64/profile.rs
new file mode 100644
index 00000000..c9b99c63
--- /dev/null
+++ b/kernel/arch/x64/profile.rs
@@ -0,0 +1,3 @@
+pub fn read_clock_counter() -> u64 {
+    unsafe { x86::time::rdtscp() }
+}
diff --git a/kernel/boot.rs b/kernel/boot.rs
index 59ccd659..c060fb65 100644
--- a/kernel/boot.rs
+++ b/kernel/boot.rs
@@ -15,6 +15,7 @@ use crate::{
     net, pipe, poll,
     printk::PrintkLogger,
     process::{self, switch, Process},
+    profile::StopWatch,
 };
 use alloc::sync::Arc;
 use kerla_utils::once::Once;
@@ -62,11 +63,15 @@ pub static INITIAL_ROOT_FS: Once<Arc<SpinLock<RootFs>>> = Once::new();
 
 pub fn boot_kernel(bootinfo: &BootInfo) -> ! {
     info!("Booting Kerla...");
+    let mut profiler = StopWatch::start();
 
     // Initialize memory allocators first.
     page_allocator::init(&bootinfo.ram_areas);
+    profiler.lap_time("page allocator init");
     global_allocator::init();
+    profiler.lap_time("global allocator init");
     interrupt::init();
+    profiler.lap_time("global interrupt init");
 
     #[cfg(test)]
     {
@@ -76,22 +81,32 @@ pub fn boot_kernel(bootinfo: &BootInfo) -> ! {
 
     // Initialize kernel subsystems.
     arch::init();
+    profiler.lap_time("arch init");
     pipe::init();
+    profiler.lap_time("pipe init");
     poll::init();
+    profiler.lap_time("poll init");
     devfs::init();
+    profiler.lap_time("devfs init");
     tmpfs::init();
+    profiler.lap_time("tmpfs init");
     initramfs::init();
+    profiler.lap_time("initramfs init");
     drivers::init();
+    profiler.lap_time("drivers init");
 
     if bootinfo.pci_enabled {
         drivers::pci::init();
+        profiler.lap_time("pci init");
     }
 
     if !bootinfo.virtio_mmio_devices.is_empty() {
         drivers::virtio::init(&bootinfo.virtio_mmio_devices);
+        profiler.lap_time("virtio init");
     }
 
     net::init();
+    profiler.lap_time("net init");
 
     // Prepare the root file system.
     let mut root_fs = RootFs::new(INITRAM_FS.clone()).unwrap();
@@ -125,7 +140,11 @@ pub fn boot_kernel(bootinfo: &BootInfo) -> ! {
 
     // We cannot initialize the process subsystem until INITIAL_ROOT_FS is initialized.
     INITIAL_ROOT_FS.init(|| Arc::new(SpinLock::new(root_fs)));
+
+    profiler.lap_time("root fs init");
+
     process::init();
+    profiler.lap_time("process init");
 
     // Create the init process.
     if let Some(script) = option_env!("INIT_SCRIPT") {
@@ -144,6 +163,8 @@ pub fn boot_kernel(bootinfo: &BootInfo) -> ! {
         .expect("failed to execute /sbin/init");
     }
 
+    profiler.lap_time("first process init");
+
     if bootinfo.omikuji {
         // "Chosen by fair dice roll. Guaranteed to be random."
         // https://xkcd.com/221/
diff --git a/kernel/main.rs b/kernel/main.rs
index e49af6a0..09297bb7 100644
--- a/kernel/main.rs
+++ b/kernel/main.rs
@@ -38,6 +38,7 @@ mod pipe;
 mod poll;
 mod prelude;
 mod process;
+mod profile;
 mod random;
 mod syscalls;
 mod test_runner;
diff --git a/kernel/profile.rs b/kernel/profile.rs
new file mode 100644
index 00000000..f68484e6
--- /dev/null
+++ b/kernel/profile.rs
@@ -0,0 +1,18 @@
+use crate::arch::read_clock_counter;
+
+pub struct StopWatch {
+    current: u64,
+}
+
+impl StopWatch {
+    pub fn start() -> StopWatch {
+        let current = read_clock_counter();
+        StopWatch { current }
+    }
+
+    pub fn lap_time(&mut self, title: &'static str) {
+        let current = read_clock_counter();
+        trace!("profiler: {} counts ({})", current - self.current, title,);
+        self.current = current;
+    }
+}