Merge pull request #2283 from alfreb/fieldmedic

Revive Fieldmedic plugin, add early kernel diagnostic hooks

Author: alfreb

api/info

@@ -21,19 +21,21 @@
 
 #define LINEWIDTH 80
 
+#include <kprint>
+
 // Informational prints
 #ifndef NO_INFO
-#define INFO(FROM, TEXT, ...) printf("%13s ] " TEXT "\n", "[ " FROM, ##__VA_ARGS__)
-#define INFO2(TEXT, ...) printf("%16s" TEXT "\n"," ", ##__VA_ARGS__)
-#define CENTER(TEXT) printf("%*s%*s\n",LINEWIDTH/2 + (int)strlen(TEXT)/2,TEXT,LINEWIDTH/2-(int)strlen(TEXT)/2,"")
+#define INFO(FROM, TEXT, ...) kprintf("%13s ] " TEXT "\n", "[ " FROM, ##__VA_ARGS__)
+#define INFO2(TEXT, ...) kprintf("%16s" TEXT "\n"," ", ##__VA_ARGS__)
+#define CENTER(TEXT) kprintf("%*s%*s\n",LINEWIDTH/2 + (int)strlen(TEXT)/2,TEXT,LINEWIDTH/2-(int)strlen(TEXT)/2,"")
 #include <string>
-#define FILLINE(CHAR) printf("%s\n",std::string(LINEWIDTH,CHAR).c_str())
-#define CAPTION(TEXT) FILLINE('='); printf("\n"); CENTER(TEXT); printf("\n"); FILLINE('=')
+#define FILLINE(CHAR) kprintf("%s\n",std::pmr::string(LINEWIDTH,CHAR).c_str())
+#define CAPTION(TEXT) FILLINE('='); kprintf("\n"); CENTER(TEXT); kprintf("\n"); FILLINE('=')
 
 // Checkboxes - for initialization output and testing
-#define CHECK(TEST, TEXT, ...) printf("%16s[%s] " TEXT "\n","", TEST ? "x" : " ",  ##__VA_ARGS__)
+#define CHECK(TEST, TEXT, ...) kprintf("%16s[%s] " TEXT "\n","", TEST ? "x" : " ",  ##__VA_ARGS__)
 #define CHECKSERT(TEST, TEXT, ...) CHECK(TEST, TEXT, ##__VA_ARGS__), assert(TEST)
-#define FAIL(TEXT, ...)  printf("FAIL: " TEXT "\n", ##__VA_ARGS__); os::panic("FAIL")
+#define FAIL(TEXT, ...)  kprintf("FAIL: " TEXT "\n", ##__VA_ARGS__); os::panic("FAIL")
 
 // Undefine
 #else

api/kernel/diag.hpp

@@ -0,0 +1,23 @@
+#ifndef KERNEL_DIAG_HOOKS_HPP
+#define KERNEL_DIAG_HOOKS_HPP
+#define RUN_DIAG_HOOKS true
+
+constexpr bool run_diag_hooks = RUN_DIAG_HOOKS;
+
+namespace kernel::diag {
+  void post_bss() noexcept;
+  void post_machine_init() noexcept;
+  void post_init_libc() noexcept;
+  void post_service() noexcept;
+
+  void default_post_init_libc() noexcept;
+
+  template <auto Func>
+  void hook() {
+    if constexpr (run_diag_hooks) {
+      Func();
+    }
+  }
+}
+
+#endif

src/kernel/kernel.cpp

@@ -18,6 +18,7 @@
 #include <os.hpp>
 #include <kernel.hpp>
 #include <kernel/cpuid.hpp>
+#include <kernel/diag.hpp>
 #include <kernel/rng.hpp>
 #include <service>
 #include <cstdio>
@@ -168,6 +169,7 @@ void kernel::post_start()
 
   // service program start
   Service::start();
+  kernel::diag::hook<kernel::diag::post_service>();
 }
 
 void os::add_stdout(os::print_func func)
@@ -227,3 +229,5 @@ void os::print_timestamps(const bool enabled)
 {
   kernel::state().timestamps = enabled;
 }
+
+void __attribute__((weak)) kernel::diag::post_service() noexcept {}

src/kernel/syscalls.cpp

@@ -252,7 +252,7 @@ void kernel::default_exit() {
 }
 
 extern "C"
-void _init_syscalls()
+void __init_crash_contexts()
 {
   // make sure each buffer is zero length so it won't always show up in crashes
   for (auto& ctx : contexts)

src/platform/aarch64_vm/kernel_start.cpp

@@ -129,14 +129,14 @@ extern "C" {/*
   uintptr_t _move_symbols(uintptr_t loc);
 //  void _init_bss();
   void _init_heap(uintptr_t);
-  void _init_syscalls();
+  void __init_crash_contexts();
 */
   void __init_sanity_checks();
   void kernel_sanity_checks();
   void _init_bss();
   uintptr_t _move_symbols(uintptr_t loc);
   void _init_elf_parser();
-  void _init_syscalls();
+  void __init_crash_contexts();
   void __elf_validate_section(const void*);
 }
 
@@ -241,7 +241,7 @@ void kernel_start(uintptr_t magic, uintptr_t addrin)
   __machine->init();
 
   // Initialize system calls
-  _init_syscalls();
+  __init_crash_contexts();
 
   //probably not very sane!
   cpu_debug_enable();

src/platform/x86_nano/kernel_start.cpp

@@ -27,7 +27,7 @@ extern "C" {
   uintptr_t _move_symbols(uintptr_t loc);
   void _init_heap(uintptr_t);
   void _init_elf_parser();
-  void _init_syscalls();
+  void __init_crash_contexts();
 }
 
 uintptr_t _multiboot_free_begin(uintptr_t boot_addr);
@@ -61,7 +61,7 @@ void kernel_start(uintptr_t magic, uintptr_t addr)
   _init_elf_parser();
 
   // Initialize system calls
-  _init_syscalls();
+  __init_crash_contexts();
 
   // Initialize stdout handlers
   if (os_default_stdout)

src/platform/x86_pc/init_libc.cpp

@@ -4,6 +4,7 @@
 #include <kernel.hpp>
 #include <kernel/auxvec.h>
 #include <kernel/cpuid.hpp>
+#include <kernel/diag.hpp>
 #include <kernel/rng.hpp>
 #include <kernel/service.hpp>
 #include <util/elf_binary.hpp>
@@ -12,9 +13,9 @@
 
 //#define KERN_DEBUG 1
 #ifdef KERN_DEBUG
-#define PRATTLE(fmt, ...) kprintf(fmt, ##__VA_ARGS__)
+#define KDEBUG(fmt, ...) kprintf(fmt, ##__VA_ARGS__)
 #else
-#define PRATTLE(fmt, ...) /* fmt */
+#define KDEBUG(fmt, ...) /* fmt */
 #endif
 
 extern char _ELF_START_;
@@ -31,17 +32,24 @@ static void global_ctor_test(){
   global_ctors_ok = 42;
 }
 
+namespace kernel::diag {
+  void default_post_init_libc() noexcept {
+    Expects(global_ctors_ok == 42 && "Global constructors functional");
+    Elf_binary<Elf64> elf{{(char*)&_ELF_START_, static_cast<size_t>(&_ELF_END_ - &_ELF_START_)}};
+    Expects(elf.is_ELF() && "ELF header intact");
+  }
+  void __attribute__((weak)) post_init_libc() noexcept {
+    default_post_init_libc();
+  }
+}
+
 extern "C"
 int kernel_main(int, char * *, char * *)
 {
-  PRATTLE("<kernel_main> libc initialization complete \n");
-  LL_ASSERT(global_ctors_ok == 42);
+  KDEBUG("<kernel_main> libc initialization complete \n");
   kernel::state().libc_initialized = true;
-
-  Elf_binary<Elf64> elf{{(char*)&_ELF_START_, static_cast<size_t>(&_ELF_END_ - &_ELF_START_)}};
-  LL_ASSERT(elf.is_ELF() && "ELF header intact");
-
-  PRATTLE("<kernel_main> OS start \n");
+  kernel::diag::hook<kernel::diag::post_init_libc>();
+  KDEBUG("<kernel_main> OS start \n");
 
   // Initialize early OS, platform and devices
 #if defined(PLATFORM_x86_pc)
@@ -57,7 +65,7 @@ int kernel_main(int, char * *, char * *)
   // NOTE: because of page protection we can choose to stop checking here
   kernel_sanity_checks();
 
-  PRATTLE("<kernel_main> post start \n");
+  KDEBUG("<kernel_main> post start \n");
   // Initialize common subsystems and call Service::start
   kernel::post_start();
 
@@ -77,7 +85,7 @@ namespace x86
     grub_magic = magic;
     grub_addr  = addr;
 
-    PRATTLE("* Elf start: %p\n", &_ELF_START_);
+    KDEBUG("* Elf start: %p\n", &_ELF_START_);
     auto* ehdr = (Elf64_Ehdr*)&_ELF_START_;
     auto* phdr = (Elf64_Phdr*)((char*)ehdr + ehdr->e_phoff);
     LL_ASSERT(phdr);
@@ -86,12 +94,12 @@ namespace x86
     LL_ASSERT(phdr[0].p_type == PT_LOAD);
 
   #ifdef KERN_DEBUG
-    PRATTLE("* Elf ident: %s, program headers: %p\n", ehdr->e_ident, ehdr);
+    KDEBUG("* Elf ident: %s, program headers: %p\n", ehdr->e_ident, ehdr);
     size_t size =  &_ELF_END_ - &_ELF_START_;
-    PRATTLE("\tElf size: %zu \n", size);
+    KDEBUG("\tElf size: %zu \n", size);
     for (int i = 0; i < ehdr->e_phnum; i++)
     {
-      PRATTLE("\tPhdr %i @ %p, va_addr: 0x%lx \n", i, &phdr[i], phdr[i].p_vaddr);
+      KDEBUG("\tPhdr %i @ %p, va_addr: 0x%lx \n", i, &phdr[i], phdr[i].p_vaddr);
     }
   #endif
 
@@ -110,7 +118,7 @@ namespace x86
 
     // auxiliary vector
     auxv_t* aux = (auxv_t*) &argv[6];
-    PRATTLE("* Initializing aux-vector @ %p\n", aux);
+    KDEBUG("* Initializing aux-vector @ %p\n", aux);
 
     int i = 0;
     aux[i++].set_long(AT_PAGESZ, 4096);
@@ -147,20 +155,20 @@ namespace x86
 #ifdef PLATFORM_x86_pc
     // SYSCALL instruction
   #if defined(__x86_64__)
-    PRATTLE("* Initialize syscall MSR (64-bit)\n");
+    KDEBUG("* Initialize syscall MSR (64-bit)\n");
     uint64_t star_kernel_cs = 8ull << 32;
     uint64_t star_user_cs   = 8ull << 48;
     uint64_t star = star_kernel_cs | star_user_cs;
     x86::CPU::write_msr(IA32_STAR, star);
     x86::CPU::write_msr(IA32_LSTAR, (uintptr_t)&__syscall_entry);
   #elif defined(__i386__)
-    PRATTLE("Initialize syscall intr (32-bit)\n");
+    KDEBUG("Initialize syscall intr (32-bit)\n");
     #warning Classical syscall interface missing for 32-bit
   #endif
 #endif
 
     // GDB_ENTRY;
-    PRATTLE("* Starting libc initialization\n");
+    KDEBUG("* Starting libc initialization\n");
     kernel::state().allow_syscalls = true;
     __libc_start_main(kernel_main, argc, argv.data());
   }

src/platform/x86_pc/kernel_start.cpp

@@ -16,6 +16,7 @@
 
 #include <kernel.hpp>
 #include <kernel/rng.hpp>
+#include <kernel/diag.hpp>
 #include <os.hpp>
 #include <boot/multiboot.h>
 #include <kprint>
@@ -26,9 +27,9 @@
 
 //#define KERN_DEBUG 1
 #ifdef KERN_DEBUG
-#define PRATTLE(fmt, ...) kprintf(fmt, ##__VA_ARGS__)
+#define KDEBUG(fmt, ...) kprintf(fmt, ##__VA_ARGS__)
 #else
-#define PRATTLE(fmt, ...) /* fmt */
+#define KDEBUG(fmt, ...) /* fmt */
 #endif
 
 extern "C" {
@@ -37,10 +38,15 @@ extern "C" {
   void _init_bss();
   uintptr_t _move_symbols(uintptr_t loc);
   void _init_elf_parser();
-  void _init_syscalls();
+  void __init_crash_contexts();
   void __elf_validate_section(const void*);
 }
 
+namespace kernel::diag {
+  void __attribute__((weak)) post_bss() noexcept {}
+  void __attribute__((weak)) post_machine_init() noexcept {}
+}
+
 uintptr_t _multiboot_free_begin(uintptr_t bootinfo);
 uintptr_t _multiboot_memory_end(uintptr_t bootinfo);
 
@@ -57,18 +63,22 @@ os::Machine& os::machine() noexcept {
   return *__machine;
 }
 
+const char* os::Machine::name() noexcept {
+  return "x86 PC";
+}
+
 // x86 kernel start
 extern "C"
 __attribute__((no_sanitize("all")))
 void kernel_start(uint32_t magic, uint32_t addr)
 {
-  PRATTLE("\n//////////////////  IncludeOS kernel start ////////////////// \n");
-  PRATTLE("* Booted with magic 0x%x, grub @ 0x%x \n",
+  KDEBUG("\n//////////////////  IncludeOS kernel start ////////////////// \n");
+  KDEBUG("* Booted with magic 0x%x, grub @ 0x%x \n",
           magic, addr);
   // generate checksums of read-only areas etc.
   __init_sanity_checks();
 
-  PRATTLE("* Grub magic: 0x%x, grub info @ 0x%x\n", magic, addr);
+  KDEBUG("* Grub magic: 0x%x, grub info @ 0x%x\n", magic, addr);
 
   // Determine where free memory starts
   extern char _end;
@@ -83,34 +93,36 @@ void kernel_start(uint32_t magic, uint32_t addr)
   {
     memory_end = kernel::softreset_memory_end(addr);
   }
-  PRATTLE("* Free mem begin: 0x%zx, memory end: 0x%zx \n",
+  KDEBUG("* Free mem begin: 0x%zx, memory end: 0x%zx \n",
           free_mem_begin, memory_end);
 
-  PRATTLE("* Moving symbols. \n");
+  KDEBUG("* Moving symbols. \n");
   // Preserve symbols from the ELF binary
   free_mem_begin += _move_symbols(free_mem_begin);
-  PRATTLE("* Free mem moved to: %p \n", (void*) free_mem_begin);
+  KDEBUG("* Free mem moved to: %p \n", (void*) free_mem_begin);
 
-  PRATTLE("* Init .bss\n");
+  KDEBUG("* Init .bss\n");
   _init_bss();
+  kernel::diag::hook<kernel::diag::post_bss>();
 
   // Instantiate machine
   size_t memsize = memory_end - free_mem_begin;
   __machine = os::Machine::create((void*)free_mem_begin, memsize);
 
-  PRATTLE("* Init ELF parser\n");
+  KDEBUG("* Init ELF parser\n");
   _init_elf_parser();
 
   // Begin portable HAL initialization
   __machine->init();
+  kernel::diag::hook<kernel::diag::post_machine_init>();
 
   // TODO: Move more stuff into Machine::init
   RNG::init();
 
-  PRATTLE("* Init syscalls\n");
-  _init_syscalls();
+  KDEBUG("* Init per CPU crash contexts\n");
+  __init_crash_contexts();
 
-  PRATTLE("* Init CPU exceptions\n");
+  KDEBUG("* Init CPU exceptions\n");
   x86::idt_initialize_for_cpu(0);
 
   x86::init_libc(magic, addr);

src/platform/x86_solo5/kernel_start.cpp

@@ -10,7 +10,7 @@ extern "C" {
 extern "C" {
   void __init_sanity_checks();
   uintptr_t _move_symbols(uintptr_t loc);
-  void _init_syscalls();
+  void __init_crash_contexts();
   void _init_elf_parser();
 }
 
@@ -59,7 +59,7 @@ void kernel_start()
   __machine->init();
 
   // Initialize system calls
-  _init_syscalls();
+  __init_crash_contexts();
 
   x86::init_libc((uint32_t) (uintptr_t) temp_cmdline, 0);
 }