kernel.c

Go to the documentation of this file.

/*
 * PROJECT:      MatanelOS Kernel
 * LICENSE:      GPLv3
 * PURPOSE:      Core Kernel Entry Point for MatanelOS.
 */
 
#include "kernel.h"
#ifndef _MSC_VER
_Static_assert(sizeof(void*) == 8, "This Kernel is 64 bit only! The 32bit version is deprecated.");
#endif

 
/*
Kernel Specific
*/
bool isBugChecking = false;
bool allApsInitialized = false;
PROCESSOR cpu0; // In UP Mode - Will be the place the CPU struct lives permanently, however in SMP mode, the struct transfers to cpus[my_id] after initializing SMP.
 
/*
Boot Parameters
*/
GOP_PARAMS gop_local;
BOOT_INFO boot_info_local;
 
/*
AHCI Specifications
*/
#define MAX_AHCI_CONTROLLERS 32
uint64_t ahci_bases_local[MAX_AHCI_CONTROLLERS];
 

 
 
#define MAX_MEMORY_MAP_SIZE 0x8000  // 32 KB, enough for ~512 descriptors (this shouldn't be used, since we init the PFN db with the ptr from original UEFI, but eh, whatevs)
 
static EFI_MEMORY_DESCRIPTOR memory_map_copy[MAX_MEMORY_MAP_SIZE / sizeof(EFI_MEMORY_DESCRIPTOR)];
 
void copy_memory_map(BOOT_INFO* boot_info) {
    if (!boot_info || !boot_info->MemoryMap) return;
    if (boot_info->MapSize > MAX_MEMORY_MAP_SIZE) {
        // handle error, memory map too big
        MeBugCheck(MEMORY_MAP_SIZE_OVERRUN);
    }
 
    // Copy the entire memory map into the static buffer
    kmemcpy(memory_map_copy, boot_info->MemoryMap, boot_info->MapSize);
 
    boot_info_local.MemoryMap = memory_map_copy;
    boot_info_local.MapSize = boot_info->MapSize;
    boot_info_local.DescriptorSize = boot_info->DescriptorSize;
    boot_info_local.DescriptorVersion = boot_info->DescriptorVersion;
}
 
void copy_gop(BOOT_INFO* boot_info) {
    if (!boot_info || !boot_info->Gop.FrameBufferBase) return;
 
    // Copy the GOP data to a local global variable
    gop_local = (boot_info->Gop);
 
    // Update all relevant pointers to point to the local copy
    boot_info_local.Gop = gop_local;
}
 
 
void init_boot_info(BOOT_INFO* boot_info) {
    if (!boot_info) return;
 
    copy_memory_map(boot_info);
    copy_gop(boot_info);
    if (boot_info->AhciCount > MAX_AHCI_CONTROLLERS) {
        MeBugCheck(BAD_AHCI_COUNT);
    }
    for (uint32_t i = 0; i < boot_info->AhciCount; i++) {
        ahci_bases_local[i] = boot_info->AhciBarBases[i];
    }
    // Copy the local array into local boot info.
    kmemcpy(boot_info_local.AhciBarBases, ahci_bases_local, sizeof(ahci_bases_local));
    boot_info_local.AhciCount = boot_info->AhciCount;
    boot_info_local.KernelStackTop = boot_info->KernelStackTop;
    boot_info_local.Pml4Phys = boot_info->Pml4Phys;
    boot_info_local.AcpiRsdpPhys = boot_info->AcpiRsdpPhys;
}
 
static inline bool interrupts_enabled(void) {
    unsigned long flags;
    __asm__ __volatile__("pushfq; popq %0"
        : "=r"(flags)
        :
        : "memory", "cc");
    return (flags & (1UL << 9)) != 0; // IF is bit 9
}
 
void kernel_idle_checks(void) {
    gop_printf(0xFF000FF0, "Reached the idle thread!\n");
    // Reaching the idle thread with interrupts off means something did not have the RFLAGS IF Bit set.
    if (!interrupts_enabled()) {
        gop_printf(COLOR_RED, "**Interrupts aren't enabled..\n Stack Trace:\n");
        FREEZE();
    }
    while (1) {
        if (MeGetCurrentProcessor()->ZombieThread) {
            // Delete the last thread.
            Schedule();
        }
        __hlt();
        //Schedule();
    }
}
 
static void test(MUTEX* mut) {
    PETHREAD currentThread = PsGetCurrentThread();
    gop_printf_forced(0xFF00FF00, "Hit Test! test thread ptr: %p\n", currentThread);
    gop_printf(COLOR_GREEN, "(test) Acquiring Mutex Object: %p\n", mut);
    MsAcquireMutexObject(mut);
    volatile uint64_t z = 0;
#ifdef GDB
    for (uint64_t i = 0; i < 0xA; i++) {
#else
    for (uint64_t i = 0; i < 0xFFFFFFF; i++) {
#endif
        z++;
    }
    gop_printf(COLOR_GREEN, "(test) Releasing Mutex Object: %p\n", mut);
    MsReleaseMutexObject(mut);
    gop_printf_forced(0xFFA020F0, "**Ended Test.**\n");
}
 
static void MeCreateInitialUserModeProcess(void) {
    gop_printf(COLOR_OLIVE, "Starting initial user mode process.\n");
    HANDLE hProcess;
    PsCreateProcess("terminateMyself.mtexe", &hProcess, MT_PROCESS_ALL_ACCESS, 0);
    // Always free handles, important.
    MTSTATUS st = HtClose(hProcess);
    assert(MT_SUCCEEDED(st));
    UNREFERENCED_PARAMETER(hProcess);
}
 
// All CPUs
uint8_t apic_list[MAX_CPUS];
uint32_t cpu_count = 0;
uint32_t lapicAddress;
bool smpInitialized;

#ifdef DEBUG
// Stack Canary GCC
volatile uintptr_t __stack_chk_guard;
 
__attribute__((noreturn))
void __stack_chk_fail(void) {
    __cli();
    MeBugCheckEx(KERNEL_STACK_OVERFLOWN, (void*)__builtin_return_address(0), NULL, NULL, NULL);
}
#endif
 
// TODO allocate dynamically (use PsCreateProcess)
EPROCESS PsInitialSystemProcess;
 
static void InitSystemProcess(void) {
    // TODO Setup system process like PsCreateProcess, and modify the func.
    kmemset(&PsInitialSystemProcess, 0, sizeof(EPROCESS));
    PsInitialSystemProcess.PID = 4; // Initial PID, reserved.
    PsInitialSystemProcess.ParentProcess = 0; // No creator process
    kstrncpy(PsInitialSystemProcess.ImageName, "mtoskrnl.mtexe", sizeof(PsInitialSystemProcess.ImageName)); // Name for the process
    PsInitialSystemProcess.priority = 0; // TODO
    PsInitialSystemProcess.InternalProcess.PageDirectoryPhysical = __read_cr3(); // The PML4 of the system process, is our kernel PML4.
    PsInitialSystemProcess.CreationTime = MeGetEpoch();
    PsInitialSystemProcess.MainThread = MeGetCurrentProcessor()->idleThread; // The main thread for the SYSTEM process is the BSP's idle thread.
    InitializeListHead(&PsInitialSystemProcess.AllThreads);
    PsInitialSystemProcess.ObjectTable = HtCreateHandleTable(&PsInitialSystemProcess);
    PsInitialSystemProcess.Flags |= ProcessBreakOnTermination;
}
 
extern uint8_t bss_start;
extern uint8_t bss_end;

__attribute__((noreturn))
void kernel_main(BOOT_INFO* boot_info) {
    // 1. CORE SYSTEM INITIALIZATION
    __writemsr(IA32_GS_BASE, (uint64_t)&cpu0);
    __cli();
    // Zero the BSS.
    size_t len = &bss_end - &bss_start;
    RtlZeroMemory(&bss_start, len);
    // Create the local boot struct.
    init_boot_info(boot_info);
    gop_clear_screen(&gop_local, 0); // 0 is just black. (0x0000000)
    // Initialize the global CPU struct.
    MeInitializeProcessor(&cpu0, false, false);
    // Initialize interrupts & exceptions.
    init_interrupts();
    // Initialize the memory manager
    MmInitSystem(SYSTEM_PHASE_INITIALIZE_ALL, boot_info);
 
    // Initialize the TSS & GDT & New IDT with TSS
    MeInitializeProcessor(&cpu0, true, false);
    // Initialize ACPI after initializing Mm (since page faults will happen on pfn db if not).
    MTSTATUS st = MhInitializeACPI();
    if (MT_FAILURE(st)) {
        gop_printf(COLOR_RED, "InitializeACPI Failure: %x\n", st);
        __hlt();
    }
 
    // Move all UEFI Pointers to kernel higher half (after physical memory offset)
    // To allow copying PML4 of kernel to processes.
    MiMoveUefiDataToHigherHalf(boot_info);
 
    // Initialize the object manager subsystem.
    ObInitialize();
 
    // Initialize Ps subsystem.
    st = PsInitializeSystem(PS_PHASE_INITIALIZE_SYSTEM);
    if (MT_FAILURE(st)) {
        MeBugCheckEx(PSMGR_INIT_FAILED, (void*)(uintptr_t)st, NULL, NULL, NULL);
    }
 
    // Initiate section type initializer (must be called after Ob)
    st = MmInitSections();
    if (MT_FAILURE(st)) {
        MeBugCheckEx(
            MANUALLY_INITIATED_CRASH2,
            (void*)(uintptr_t)st,
            NULL,
            NULL,
            NULL
        );
    }
 
    // And, initialize our system process.
    InitSystemProcess();
    _MeSetIrql(PASSIVE_LEVEL);
 
#ifdef DEBUG
    {
        uint64_t temp_canary = 0;
        bool rdrand_ok = false;
        for (int n = 0; n < 64; n++) {
            if (__rdrand64(&temp_canary)) {
                rdrand_ok = true;
                break;
            }
        }
 
        if (rdrand_ok) {
            __stack_chk_guard = temp_canary;
        }
        else {
            // rdrand didnt give a value, use timestamp of CPU cycles.
            __stack_chk_guard = __rdtsc();
        }
 
        // The canary should never be zero.
        if (__stack_chk_guard == 0) {
            __stack_chk_guard = 0xDEADC0DEDEADC0DE; // fallback
        }
    }
#endif
 
    /* Initiate Scheduler */
    InitScheduler();
 
    uint64_t rip;
    __asm__ volatile (
        "lea 1f(%%rip), %0\n\t"  // Calculate the address of label 1 relative to RIP
        "1:"                     // The label whose address we want
        : "=r"(rip)              // Output to the 'rip' variable
        );
 
    gop_printf_forced(0xFFFFFF00, "Current RIP: %p\n", (void*)(uintptr_t)rip);
 
    if (rip >= KernelVaStart) {
        gop_printf_forced(0x00FF00FF, "**[+] Running in higher-half**\n");
    }
    else {
        gop_printf_forced(0xFF0000FF, "[-] Still identity-mapped\n");
    }
 
    // Initialize worker threads. (all thread creation must be after sched init)
    PsInitializeSystem(PS_PHASE_INITIALIZE_WORKER_THREADS);
 
    MTSTATUS status = FsInitialize();
    if (MT_FAILURE(status)) {
        MeBugCheck(FILESYSTEM_PANIC);
    }
 
    /* SYSTEM IS FULLY INITIALIZED. (except SMP and APIC) */
 
    void* buf = MmAllocatePoolWithTag(NonPagedPool, 64, 'buf1');
    gop_printf_forced(0xFFFFFF00, "buf addr: %p\n", buf);
    void* buf2 = MmAllocatePoolWithTag(NonPagedPool, 128, 'buf2');
    gop_printf_forced(0xFFFFFF00, "buf2 addr: %p\n", buf2);
    MmFreePool(buf2);
    void* buf3 = MmAllocatePoolWithTag(NonPagedPool, 128, 'buf3');
    gop_printf_forced(0xFFFFFF00, "buf3 addr (should be same as buf2): %p\n", buf3);
    void* buf4 = MmAllocatePoolWithTag(NonPagedPool, 2048, 'buf4');
    gop_printf_forced(0xFF964B00, "buf4 addr (should reside after buf3, allocated 2048 bytes): %p\n", buf4);
    void* buf5 = MmAllocatePoolWithTag(NonPagedPool, 64, 'buf5');
    gop_printf_forced(0xFF964B00, "buf5 addr (should be a larger addr): %p\n", buf5);
    void* buf6 = MmAllocatePoolWithTag(NonPagedPool, 5000, 'buf6');
    gop_printf_forced(0xFFFFFF00, "buf6 addr (should use dynamic memory): %p\n", buf6);
    void* buf7 = MmAllocatePoolWithTag(NonPagedPool, 10000, 'buf7');
    gop_printf_forced(0xFFFFFF00, "buf7 addr (should use dynamic memory, extremely larger): %p\n", buf7);
 
    if (checkcpuid()) {
        char str[256];
        getCpuName(str);
        gop_printf(COLOR_GREEN, "CPU Identified: %s\n", str);
    }
 
    TIME_ENTRY currTime = get_time();
#define ISRAEL_UTC_OFFSET 3
    gop_printf(COLOR_GREEN, "Current Time: (YY:MM:DD:hh:mm:ss) %d/%d/%d | %d:%d:%d\n", currTime.year, currTime.month, currTime.day, currTime.hour + ISRAEL_UTC_OFFSET, currTime.minute, currTime.second);
    MUTEX* sharedMutex = MmAllocatePoolWithTag(NonPagedPool, sizeof(MUTEX), ' TUM');
    if (!sharedMutex) { gop_printf(COLOR_RED, "It's null\n"); __hlt(); }
    status = MsInitializeMutexObject(sharedMutex);
    PsCreateSystemThread((ThreadEntry)test, sharedMutex, DEFAULT_TIMESLICE_TICKS, NULL);
    PsCreateSystemThread((ThreadEntry)MeCreateInitialUserModeProcess, NULL, DEFAULT_TIMESLICE_TICKS, NULL); // I have tested 5+ threads, works perfectly as it should. ( SMP UPDATED - Tested with 4 threads, MUTEX and scheduling works perfectly :) )
    /* Enable LAPIC & SMP Now. */
    lapic_init_cpu();
    lapic_enable(); // call again.
    lapic_timer_calibrate();
    init_lapic_timer(100); // 10ms, must be called before other APs
#ifndef MT_UP
    /* Enable SMP */
    status = MhParseLAPICs((uint8_t*)apic_list, MAX_CPUS, &cpu_count, &lapicAddress);
    if (MT_FAILURE(status)) {
        gop_printf(COLOR_RED, "**[MTSTATUS-FAILURE]** ParseLAPICs status returned: %x, continuing in UP mode.\n", status);
    }
    else {
        MhInitializeSMP(apic_list, 4, lapicAddress);
        IPI_PARAMS dummy = { 0 }; // zero-initialize the struct
        MhSendActionToCpusAndWait(CPU_ACTION_PRINT_ID, dummy);
        allApsInitialized = true; // Toggle this flag after all CPUs printed their ID, since thats when it marks that all CPUs in the apic list have initialized fully.
    }
#else
    gop_printf(COLOR_RED, "System configured to run in UP mode.\n");
#endif
    // __sti(); STI Call commented out, this is what caused the scheduler assertion to fail, and guess how much time it took to debug? 2 days
    // Thread creations (including idle threads) must come with the IF flag set.
    Schedule();
    UNREACHABLE_CODE();
}