From 8aa2adf99fd4fcc4b47c534d2fed5ec7ed6ea334 Mon Sep 17 00:00:00 2001 From: Amlal Date: Mon, 27 Jan 2025 21:49:14 +0100 Subject: ADD: LibDebugger C++ library and improved `dbg` tool. ADD: New manual files `dbg` and `ld64` Signed-off-by: Amlal --- dev/LibDebugger/Debugger.h | 102 +++++++++++++++++++++++++++++++++++++ dev/LibIDE/TerminalEmulator.h | 7 ++- man/dbg.7 | 67 ++++++++++++++++++++++++ man/ld64.7 | 63 +++++++++++++++++++++++ tools/dbg.cc | 116 ++++-------------------------------------- tools/dbg.sh | 2 +- 6 files changed, 247 insertions(+), 110 deletions(-) create mode 100644 dev/LibDebugger/Debugger.h create mode 100644 man/dbg.7 create mode 100644 man/ld64.7 diff --git a/dev/LibDebugger/Debugger.h b/dev/LibDebugger/Debugger.h new file mode 100644 index 0000000..af3217c --- /dev/null +++ b/dev/LibDebugger/Debugger.h @@ -0,0 +1,102 @@ +/*** + (C) 2025 Amlal El Mahrouss + */ + +#include +#include + +#include +#include +#include +#include +#include +#include + +namespace LibDebugger +{ + /// \brief Debug IDebugger class in C++ + /// \author Amlal El Mahrouss + class IDebugger final + { + public: + IDebugger() = default; + ~IDebugger() = default; + + IDebugger& operator=(const IDebugger&) = default; + IDebugger(const IDebugger&) = default; + + public: + void Attach(pid_t pid) + { + this->m_pid = pid; + + if (ptrace(PTRACE_ATTACH, this->m_pid, nullptr, nullptr) == -1) + { + perror("dbg: Attach"); + exit(1); + } + + waitpid(m_pid, nullptr, 0); + + std::cout << "[+] Attached to process: " << m_pid << std::endl; + } + + void SetBreakpoint(void* addr) + { + long original_data = ptrace(PTRACE_PEEKTEXT, m_pid, addr, nullptr); + if (original_data == -1) + { + perror("dbg: Peek"); + exit(1); + } + + long data_with_int3 = (original_data & ~0xFF) | 0xCC; // Insert INT3 (0xCC) + if (ptrace(PTRACE_POKETEXT, m_pid, addr, data_with_int3) == -1) + { + perror("dbg: Poke"); + exit(1); + } + + std::cout << "[+] Breakpoint set at: " << addr << std::endl; + + m_breakpoints[reinterpret_cast(addr)] = original_data; // Store original data + } + + void ContinueExecution() + { + if (ptrace(PTRACE_CONT, m_pid, nullptr, nullptr) == -1) + { + perror("dbg: Cont"); + exit(1); + } + + int status; + waitpid(m_pid, &status, 0); + + if (WIFSTOPPED(status) && WSTOPSIG(status) == SIGTRAP) + { + std::cout << "[!] Breakpoint hit." << std::endl; + } + } + + void Detach() + { + if (ptrace(PTRACE_DETACH, m_pid, nullptr, nullptr) == -1) + { + perror("dbg: Detach"); + exit(1); + } + + std::cout << "[-] Detached from process: " << m_pid << std::endl; + } + + std::unordered_map& Breakpoints() + { + return m_breakpoints; + } + + private: + pid_t m_pid; + std::unordered_map m_breakpoints; + }; +} // namespace LibDebugger diff --git a/dev/LibIDE/TerminalEmulator.h b/dev/LibIDE/TerminalEmulator.h index a155e53..fb8b901 100644 --- a/dev/LibIDE/TerminalEmulator.h +++ b/dev/LibIDE/TerminalEmulator.h @@ -6,5 +6,8 @@ #pragma once -class ITerminalEmulator; -class iTerminalEscapeCode; +namespace LibIDE +{ + class Terminal; + class BuildSystem; +} diff --git a/man/dbg.7 b/man/dbg.7 new file mode 100644 index 0000000..a198885 --- /dev/null +++ b/man/dbg.7 @@ -0,0 +1,67 @@ +.TH DBG 1 "NeKernel Internal Kit" "January 2025" "NeKernel Manual" +.SH NAME +.B dbg +\- NeKernel internal debugger + +.SH SYNOPSIS +.B dbg +[␌IOPTIONS␌R] [␌ICOMMAND␌R] + +.SH DESCRIPTION +.B dbg +is the internal debugging tool for NeKernel. It provides a low-level +interface for inspecting and manipulating running processes, +memory, and kernel state. + +.SH OPTIONS +.TP +.B -p +Attach to a process by its PID. +.TP +.B -s +Start a new debugging session. +.TP +.B -m +Enable memory inspection mode. +.TP +.B -r +Display register values. +.TP +.B -b +Set a breakpoint at a function or address. +.TP +.B -c +Continue execution after a breakpoint. +.TP +.B -h +Display help information. + +.SH USAGE EXAMPLES +.TP +.B Start a new debugging session: +.B dbg -s +.TP +.B Attach to a running process (PID 1234): +.B dbg -p 1234 +.TP +.B Inspect memory at address 0x1000: +.B dbg -m 0x1000 +.TP +.B Set a breakpoint at function "main": +.B dbg -b main +.TP +.B Display register values: +.B dbg -r + +.SH EXIT STATUS +.TP +0 Successful execution. +.TP +1 Error occurred during debugging. + +.SH SEE ALSO +.BR nekernel (7), gdb (1) + +.SH AUTHOR +NeKernel Development Team + diff --git a/man/ld64.7 b/man/ld64.7 new file mode 100644 index 0000000..388a887 --- /dev/null +++ b/man/ld64.7 @@ -0,0 +1,63 @@ +.TH LD64 1 "NeKernel Internal Kit" "January 2025" "NeKernel Manual" +.SH NAME +.B ld64 +\- PEF binary format linker for NeKernel + +.SH SYNOPSIS +.B ld64 +[␌IOPTIONS␌R] [␌IINPUT_FILES␌R] -o ␌IOUTPUT_FILE␌R + +.SH DESCRIPTION +.B ld64 +is the dedicated linker for the Preferred Executable Format (PEF) used by NeKernel. +It links object files into a PEF executable suitable for execution within the NeKernel environment. + +.SH OPTIONS +.TP +.B -o +Specify the output file. +.TP +.B -L +Add a library search path. +.TP +.B -l +Link against the specified library. +.TP +.B -T