serenity/Kernel/KSyms.h

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/Forward.h>

namespace Kernel {

struct KernelSymbol {
    FlatPtr address;
    char const* name;
};

enum class PrintToScreen {
    No,
    Yes,
};

FlatPtr address_for_kernel_symbol(StringView name);
KernelSymbol const* symbolicate_kernel_address(FlatPtr);
void load_kernel_symbol_table();

extern bool g_kernel_symbols_available;
extern FlatPtr g_lowest_kernel_symbol_address;
extern FlatPtr g_highest_kernel_symbol_address;

void dump_backtrace(PrintToScreen print_to_screen = PrintToScreen::No);
void dump_backtrace_from_base_pointer(FlatPtr base_pointer);

}
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 08:38:21 +00:00			`/*`
			`* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 08:24:48 +00:00			`* SPDX-License-Identifier: BSD-2-Clause`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 08:38:21 +00:00			`*/`

Move kernel symbolication code out of init.cpp and into its own KSym files. Also use a simple array of { dword, const char* } for the KSyms and put the whole shebang in kmalloc_eternal() memory. This was a fugly source of kmalloc perma-frag. 2018-12-24 21:59:10 +00:00			`#pragma once`

Kernel: Update cryptically-named functions related to symbolication 2020-04-08 11:30:50 +00:00			`#include <AK/Forward.h>`
Move kernel symbolication code out of init.cpp and into its own KSym files. Also use a simple array of { dword, const char* } for the KSyms and put the whole shebang in kmalloc_eternal() memory. This was a fugly source of kmalloc perma-frag. 2018-12-24 21:59:10 +00:00
Kernel: Move all code into the Kernel namespace 2020-02-16 00:27:42 +00:00			`namespace Kernel {`

Kernel: Update cryptically-named functions related to symbolication 2020-04-08 11:30:50 +00:00			`struct KernelSymbol {`
Kernel: Take some baby steps towards x86_64 Make more of the kernel compile in 64-bit mode, and make some things pointer-size-agnostic (by using FlatPtr.) There's a lot of work to do here before the kernel will even compile. 2021-02-25 15:18:36 +00:00			`FlatPtr address;`
Everywhere: Run clang-format 2022-04-01 17:58:27 +00:00			`char const* name;`
Move kernel symbolication code out of init.cpp and into its own KSym files. Also use a simple array of { dword, const char* } for the KSyms and put the whole shebang in kmalloc_eternal() memory. This was a fugly source of kmalloc perma-frag. 2018-12-24 21:59:10 +00:00			`};`

Kernel: Print panic backtrace to both the screen and serial Previously it would only print the backtrace to serial, which would be inaccessible if you don't have serial setup. 2021-08-04 15:52:14 +00:00			`enum class PrintToScreen {`
			`No,`
			`Yes,`
			`};`

Everywhere: Pass AK::StringView by value 2021-11-10 23:55:02 +00:00			`FlatPtr address_for_kernel_symbol(StringView name);`
Everywhere: Run clang-format 2022-04-01 17:58:27 +00:00			`KernelSymbol const* symbolicate_kernel_address(FlatPtr);`
Kernel: Update cryptically-named functions related to symbolication 2020-04-08 11:30:50 +00:00			`void load_kernel_symbol_table();`
Move kernel symbolication code out of init.cpp and into its own KSym files. Also use a simple array of { dword, const char* } for the KSyms and put the whole shebang in kmalloc_eternal() memory. This was a fugly source of kmalloc perma-frag. 2018-12-24 21:59:10 +00:00
Kernel: Update cryptically-named functions related to symbolication 2020-04-08 11:30:50 +00:00			`extern bool g_kernel_symbols_available;`
			`extern FlatPtr g_lowest_kernel_symbol_address;`
			`extern FlatPtr g_highest_kernel_symbol_address;`
Kernel: Make dump_backtrace() kinda sorta work. 2019-02-24 13:51:48 +00:00
Kernel: Print panic backtrace to both the screen and serial Previously it would only print the backtrace to serial, which would be inaccessible if you don't have serial setup. 2021-08-04 15:52:14 +00:00			`void dump_backtrace(PrintToScreen print_to_screen = PrintToScreen::No);`
Kernel: Add ability to dump backtrace from provided frame pointer When an exception happens it is sometimes hard to figure out where exactly the exception happened, so use the frame pointer of the trap frame to print a backtrace. 2022-09-21 12:33:39 +00:00			`void dump_backtrace_from_base_pointer(FlatPtr base_pointer);`
Kernel: Move all code into the Kernel namespace 2020-02-16 00:27:42 +00:00
			`}`