From 9b7dbb3e5c131d84730b88c4fc493665c74613fd Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Wed, 25 Mar 2026 08:31:45 +0100 Subject: [FEAT] Refactor DebuggerKit design (BREAKING API CHANGES) Signed-off-by: Amlal El Mahrouss --- src/DebuggerKit/src/Mach+CLI.cpp | 96 ++++++++++++++++++++++++++++ src/DebuggerKit/src/Mach.cpp | 97 ++++++++++++++++++++++++++++ src/DebuggerKit/src/MachContract.cpp | 97 ---------------------------- src/DebuggerKit/src/MachContractCLI.cpp | 96 ---------------------------- src/DebuggerKit/src/NeKernelContract.cpp | 87 ------------------------- src/DebuggerKit/src/NeKernelContractCLI.cpp | 99 ----------------------------- src/DebuggerKit/src/NeSystem+CLI.cpp | 98 ++++++++++++++++++++++++++++ src/DebuggerKit/src/NeSystem.cpp | 87 +++++++++++++++++++++++++ src/DebuggerKit/src/POSIX+CLI.cpp | 94 +++++++++++++++++++++++++++ src/DebuggerKit/src/POSIXContractCLI.cpp | 94 --------------------------- 10 files changed, 472 insertions(+), 473 deletions(-) create mode 100644 src/DebuggerKit/src/Mach+CLI.cpp create mode 100644 src/DebuggerKit/src/Mach.cpp delete mode 100644 src/DebuggerKit/src/MachContract.cpp delete mode 100644 src/DebuggerKit/src/MachContractCLI.cpp delete mode 100644 src/DebuggerKit/src/NeKernelContract.cpp delete mode 100644 src/DebuggerKit/src/NeKernelContractCLI.cpp create mode 100644 src/DebuggerKit/src/NeSystem+CLI.cpp create mode 100644 src/DebuggerKit/src/NeSystem.cpp create mode 100644 src/DebuggerKit/src/POSIX+CLI.cpp delete mode 100644 src/DebuggerKit/src/POSIXContractCLI.cpp (limited to 'src/DebuggerKit') diff --git a/src/DebuggerKit/src/Mach+CLI.cpp b/src/DebuggerKit/src/Mach+CLI.cpp new file mode 100644 index 0000000..69000c9 --- /dev/null +++ b/src/DebuggerKit/src/Mach+CLI.cpp @@ -0,0 +1,96 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) +// Licensed under the Apache License, Version 2.0 (See accompanying +// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) +// Official repository: https://github.com/ne-foss-org/nectar + +#ifdef DK_MACH_DEBUGGER + +#include +#include + +#ifdef DK_MACH_DEBUGGER +#include + +/// @internal +/// @brief Handles CTRL-C signal on debugger. +static Void dbgi_ctrlc_handler(std::int32_t _) { + if (!kPID) { + return; + } + + kUserDebugger.Break(); + + pfd::notify("Debugger Event", "Breakpoint hit!"); + + kKeepRunning = false; +} + +NECTAR_MODULE(DebuggerMach) { + pfd::notify( + "Debugger Event", + "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); + + if (argc >= 3 && std::string(argv[1]) == "-p" && argv[2] != nullptr) { + kPath = argv[2]; + kUserDebugger.SetPath(kPath); + + kStdOut << "[+] Image set to: " << kPath << "\n"; + } else { + kStdOut << "usage: " << argv[0] << " -p \n"; + kStdOut << "example: " << argv[0] << " -p \n"; + + return EXIT_FAILURE; + } + + CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); + + while (YES) { + if (kKeepRunning) { + continue; + } + + CompilerKit::STLString cmd{}; + + if (!std::getline(std::cin, cmd)) break; + + if (cmd == "c" || cmd == "cont" || cmd == "continue") { + if (kUserDebugger.Continue()) { + kKeepRunning = true; + + kStdOut << "[+] Continuing...\n"; + pfd::notify("Debugger Event", "Continuing..."); + } + } + + if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); + + if (cmd == "start") { + kStdOut << "[?] Enter a argument to use: "; + std::getline(std::cin, cmd); + + kUserDebugger.Attach(kPath, cmd, kPID); + } + + if (cmd == "exit") { + if (kPID > 0) kUserDebugger.Detach(); + + break; + } + + if (cmd == "break" || cmd == "b") { + kStdOut << "[?] Enter a symbol to break on: "; + + std::getline(std::cin, cmd); + + if (kUserDebugger.BreakAt(cmd)) { + pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); + } + } + } + + return EXIT_SUCCESS; +} +#endif + +#endif diff --git a/src/DebuggerKit/src/Mach.cpp b/src/DebuggerKit/src/Mach.cpp new file mode 100644 index 0000000..31ae544 --- /dev/null +++ b/src/DebuggerKit/src/Mach.cpp @@ -0,0 +1,97 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) +// Licensed under the Apache License, Version 2.0 (See accompanying +// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) +// Official repository: https://github.com/ne-foss-org/nectar + +#ifdef DK_MACH_DEBUGGER + +#include +#include + +/// @brief a terrible way to import globals. +#include + +/// @internal +/// @brief Handles CTRL-C signal on debugger. +static Void dbgi_ctrlc_handler(std::int32_t _) { + if (!kPID) { + return; + } + + kUserDebugger.Break(); + + pfd::notify("Debugger Event", "Breakpoint hit!"); + + kKeepRunning = false; +} + +NECTAR_MODULE(DebuggerMachPOSIX) { + pfd::notify( + "Debugger Event", + "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); + + constexpr auto kMaxArgs = 3; + + if (argc >= kMaxArgs && std::string(argv[1]) == "-p" && argv[2] != nullptr) { + kPath = argv[2]; + kUserDebugger.SetPath(kPath); + + kStdOut << "[+] Set image to: " << kPath << "\n"; + } else { + kStdOut << "usage: " << argv[0] << " -p \n"; + kStdOut << "example: " << argv[0] << " -p \n"; + + return EXIT_FAILURE; + } + + CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); + + while (YES) { + if (kKeepRunning) { + continue; + } + + std::string cmd; + if (!std::getline(std::cin, cmd)) break; + + if (cmd == "c" || cmd == "cont" || cmd == "continue") { + if (kUserDebugger.Continue()) { + kKeepRunning = true; + + kStdOut << "[+] Continuing...\n"; + + pfd::notify("Debugger Event", "Continuing..."); + } + } + + if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); + + if (cmd == "start") { + kStdOut << "[?] Enter a argument to use: "; + std::getline(std::cin, cmd); + + kUserDebugger.Attach(kPath, cmd, kPID); + } + + if (cmd == "exit") { + if (kPID > 0) kUserDebugger.Detach(); + + break; + } + + if (cmd == "break" || cmd == "b") { + kStdOut << "[?] Enter a symbol to break on: "; + + std::getline(std::cin, cmd); + + if (kUserDebugger.BreakAt(cmd)) { + pfd::notify("Debugger Event", "Add BreakAt at: " + cmd); + } + } + } + + return EXIT_SUCCESS; +} + +#endif diff --git a/src/DebuggerKit/src/MachContract.cpp b/src/DebuggerKit/src/MachContract.cpp deleted file mode 100644 index 518f61a..0000000 --- a/src/DebuggerKit/src/MachContract.cpp +++ /dev/null @@ -1,97 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) -// Licensed under the Apache License, Version 2.0 (See accompanying -// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) -// Official repository: https://github.com/ne-foss-org/nectar - -#ifdef DK_MACH_DEBUGGER - -#include -#include - -/// @brief a terrible way to import globals. -#include - -/// @internal -/// @brief Handles CTRL-C signal on debugger. -static Void dbgi_ctrlc_handler(std::int32_t _) { - if (!kPID) { - return; - } - - kUserDebugger.Break(); - - pfd::notify("Debugger Event", "Breakpoint hit!"); - - kKeepRunning = false; -} - -NECTAR_MODULE(DebuggerMachPOSIX) { - pfd::notify( - "Debugger Event", - "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); - - constexpr auto kMaxArgs = 3; - - if (argc >= kMaxArgs && std::string(argv[1]) == "-p" && argv[2] != nullptr) { - kPath = argv[2]; - kUserDebugger.SetPath(kPath); - - kStdOut << "[+] Set image to: " << kPath << "\n"; - } else { - kStdOut << "usage: " << argv[0] << " -p \n"; - kStdOut << "example: " << argv[0] << " -p \n"; - - return EXIT_FAILURE; - } - - CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); - - while (YES) { - if (kKeepRunning) { - continue; - } - - std::string cmd; - if (!std::getline(std::cin, cmd)) break; - - if (cmd == "c" || cmd == "cont" || cmd == "continue") { - if (kUserDebugger.Continue()) { - kKeepRunning = true; - - kStdOut << "[+] Continuing...\n"; - - pfd::notify("Debugger Event", "Continuing..."); - } - } - - if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); - - if (cmd == "start") { - kStdOut << "[?] Enter a argument to use: "; - std::getline(std::cin, cmd); - - kUserDebugger.Attach(kPath, cmd, kPID); - } - - if (cmd == "exit") { - if (kPID > 0) kUserDebugger.Detach(); - - break; - } - - if (cmd == "break" || cmd == "b") { - kStdOut << "[?] Enter a symbol to break on: "; - - std::getline(std::cin, cmd); - - if (kUserDebugger.BreakAt(cmd)) { - pfd::notify("Debugger Event", "Add BreakAt at: " + cmd); - } - } - } - - return EXIT_SUCCESS; -} - -#endif diff --git a/src/DebuggerKit/src/MachContractCLI.cpp b/src/DebuggerKit/src/MachContractCLI.cpp deleted file mode 100644 index 9bdb5b1..0000000 --- a/src/DebuggerKit/src/MachContractCLI.cpp +++ /dev/null @@ -1,96 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) -// Licensed under the Apache License, Version 2.0 (See accompanying -// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) -// Official repository: https://github.com/ne-foss-org/nectar - -#ifdef DK_MACH_DEBUGGER - -#include -#include - -#ifdef DK_MACH_DEBUGGER -#include - -/// @internal -/// @brief Handles CTRL-C signal on debugger. -static Void dbgi_ctrlc_handler(std::int32_t _) { - if (!kPID) { - return; - } - - kUserDebugger.Break(); - - pfd::notify("Debugger Event", "Breakpoint hit!"); - - kKeepRunning = false; -} - -NECTAR_MODULE(DebuggerMach) { - pfd::notify( - "Debugger Event", - "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); - - if (argc >= 3 && std::string(argv[1]) == "-p" && argv[2] != nullptr) { - kPath = argv[2]; - kUserDebugger.SetPath(kPath); - - kStdOut << "[+] Image set to: " << kPath << "\n"; - } else { - kStdOut << "usage: " << argv[0] << " -p \n"; - kStdOut << "example: " << argv[0] << " -p \n"; - - return EXIT_FAILURE; - } - - CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); - - while (YES) { - if (kKeepRunning) { - continue; - } - - CompilerKit::STLString cmd{}; - - if (!std::getline(std::cin, cmd)) break; - - if (cmd == "c" || cmd == "cont" || cmd == "continue") { - if (kUserDebugger.Continue()) { - kKeepRunning = true; - - kStdOut << "[+] Continuing...\n"; - pfd::notify("Debugger Event", "Continuing..."); - } - } - - if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); - - if (cmd == "start") { - kStdOut << "[?] Enter a argument to use: "; - std::getline(std::cin, cmd); - - kUserDebugger.Attach(kPath, cmd, kPID); - } - - if (cmd == "exit") { - if (kPID > 0) kUserDebugger.Detach(); - - break; - } - - if (cmd == "break" || cmd == "b") { - kStdOut << "[?] Enter a symbol to break on: "; - - std::getline(std::cin, cmd); - - if (kUserDebugger.BreakAt(cmd)) { - pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); - } - } - } - - return EXIT_SUCCESS; -} -#endif - -#endif diff --git a/src/DebuggerKit/src/NeKernelContract.cpp b/src/DebuggerKit/src/NeKernelContract.cpp deleted file mode 100644 index 5e7fb5e..0000000 --- a/src/DebuggerKit/src/NeKernelContract.cpp +++ /dev/null @@ -1,87 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) -// Licensed under the Apache License, Version 2.0 (See accompanying -// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) -// Official repository: https://github.com/ne-foss-org/nectar - -#ifdef DK_NEKERNEL_DEBUGGER - -/// @author Amlal El Mahrouss -/// @brief Kernel Debugger Protocol - -#include -#include - -using namespace DebuggerKit::Detail; -using namespace DebuggerKit::NeKernel; - -NeKernelContract::NeKernelContract() = default; -NeKernelContract::~NeKernelContract() = default; - -bool NeKernelContract::Attach(CompilerKit::STLString path, CompilerKit::STLString argv, - ProcessID& pid) noexcept { - if (path.empty() || argv.empty()) return NO; - - m_socket = ::socket(AF_INET, SOCK_STREAM, 0); - - if (m_socket == -1) return NO; - - struct sockaddr_in server_addr; - - server_addr.sin_family = AF_INET; - server_addr.sin_port = htons(kDebugPort); - - if (::inet_pton(AF_INET, argv.c_str(), &server_addr.sin_addr) <= 0) return NO; - - auto ret = (::connect(m_socket, (struct sockaddr*) &server_addr, sizeof(server_addr)) == -1); - - if (ret) return NO; - - CompilerKit::STLString pkt = Detail::kDebugMagic; - pkt += ";\r"; - - ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; - return ret; -} - -bool NeKernelContract::BreakAt(CompilerKit::STLString symbol) noexcept { - CompilerKit::STLString pkt = Detail::kDebugMagic; - pkt += ";SYM=\""; - pkt += symbol; - pkt += "\";\r"; - - if (pkt.size() > kDebugCmdLen) return NO; - - auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; - return ret; -} - -bool NeKernelContract::Break() noexcept { - CompilerKit::STLString pkt = Detail::kDebugMagic; - pkt += ";BRK=1;\r"; - - auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; - return ret; -} - -bool NeKernelContract::Continue() noexcept { - CompilerKit::STLString pkt = Detail::kDebugMagic; - pkt += ";CONT=1;\r"; - - auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; - return ret; - return NO; -} - -bool NeKernelContract::Detach() noexcept { - CompilerKit::STLString pkt = Detail::kDebugMagic; - pkt += ";DTCH=1;\r"; - - auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; - - if (ret) ::close(m_socket); - - return ret; -} - -#endif // DK_NEKERNEL_DEBUGGER diff --git a/src/DebuggerKit/src/NeKernelContractCLI.cpp b/src/DebuggerKit/src/NeKernelContractCLI.cpp deleted file mode 100644 index 13144eb..0000000 --- a/src/DebuggerKit/src/NeKernelContractCLI.cpp +++ /dev/null @@ -1,99 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) -// Licensed under the Apache License, Version 2.0 (See accompanying -// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) -// Official repository: https://github.com/ne-foss-org/nectar - -#ifdef DK_NEKERNEL_DEBUGGER - -#include -#include -#include - -#include - -using namespace DebuggerKit::NeKernel; - -static void dbgi_ctrlc_handler(std::int32_t _) { - if (!kPID || kPath.empty()) { - return; - } - - kKernelDebugger.Break(); - - pfd::notify("Debugger Event", "Breakpoint hit!"); - - kKeepRunning = false; -} - -NECTAR_MODULE(DebuggerNeKernel) { - pfd::notify("Debugger Event", - "Nectar Debugger\n(C) 2025 Amlal El Mahrouss and NeKernel.org contributors, all " - "rights reserved."); - - if (argc >= 5 && std::string(argv[1]) == "-k" && argv[2] != nullptr && - std::string(argv[3]) == "-ip" && argv[4] != nullptr) { - kPath = argv[2]; - kPath += ":"; - kPath += argv[4]; - - kStdOut << "[+] KIP (Kernel:IP) set to: " << kPath << "\n"; - - CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); - - kKernelDebugger.Attach(kPath, argv[4], kPID); - - while (YES) { - if (kKeepRunning) { - continue; - } - - std::string cmd; - if (!std::getline(std::cin, cmd)) break; - - if (cmd == "c" || cmd == "cont" || cmd == "continue") { - if (kKernelDebugger.Continue()) { - kKeepRunning = true; - - kStdOut << "[+] Continuing...\n"; - - pfd::notify("Debugger Event", "Continuing..."); - } - } - - if (cmd == "d" || cmd == "detach") kKernelDebugger.Detach(); - - if (cmd == "start") { - kStdOut << "[?] Enter a argument to use: "; - std::getline(std::cin, cmd); - - kKernelDebugger.Attach(kPath, cmd, kPID); - } - - if (cmd == "exit") { - if (kPID > 0) kKernelDebugger.Detach(); - - break; - } - - if (cmd == "break" || cmd == "b") { - kStdOut << "[?] Enter a symbol to break on: "; - - std::getline(std::cin, cmd); - - if (kKernelDebugger.BreakAt(cmd)) { - pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); - } - } - } - - return EXIT_SUCCESS; - } - - kStdOut << "usage: " << argv[0] << " -k -ip \n"; - kStdOut << "example: " << argv[0] << " -k /path/to/ne_kernel -ip 127.0.0.1\n"; - - return EXIT_FAILURE; -} - -#endif // DK_NEKERNEL_DEBUGGER diff --git a/src/DebuggerKit/src/NeSystem+CLI.cpp b/src/DebuggerKit/src/NeSystem+CLI.cpp new file mode 100644 index 0000000..39271b1 --- /dev/null +++ b/src/DebuggerKit/src/NeSystem+CLI.cpp @@ -0,0 +1,98 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) +// Licensed under the Apache License, Version 2.0 (See accompanying +// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) +// Official repository: https://github.com/ne-foss-org/nectar + +#ifdef DK_NEKERNEL_DEBUGGER + +#include +#include + +#include + +using namespace DebuggerKit::NeKernel; + +static void dbgi_ctrlc_handler(std::int32_t _) { + if (!kPID || kPath.empty()) { + return; + } + + kKernelDebugger.Break(); + + pfd::notify("Debugger Event", "Breakpoint hit!"); + + kKeepRunning = false; +} + +NECTAR_MODULE(DebuggerNeKernel) { + pfd::notify("Debugger Event", + "Nectar Debugger\n(C) 2025 Amlal El Mahrouss and NeKernel.org contributors, all " + "rights reserved."); + + if (argc >= 5 && std::string(argv[1]) == "-k" && argv[2] != nullptr && + std::string(argv[3]) == "-ip" && argv[4] != nullptr) { + kPath = argv[2]; + kPath += ":"; + kPath += argv[4]; + + kStdOut << "[+] KIP (Kernel:IP) set to: " << kPath << "\n"; + + CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); + + kKernelDebugger.Attach(kPath, argv[4], kPID); + + while (YES) { + if (kKeepRunning) { + continue; + } + + std::string cmd; + if (!std::getline(std::cin, cmd)) break; + + if (cmd == "c" || cmd == "cont" || cmd == "continue") { + if (kKernelDebugger.Continue()) { + kKeepRunning = true; + + kStdOut << "[+] Continuing...\n"; + + pfd::notify("Debugger Event", "Continuing..."); + } + } + + if (cmd == "d" || cmd == "detach") kKernelDebugger.Detach(); + + if (cmd == "start") { + kStdOut << "[?] Enter a argument to use: "; + std::getline(std::cin, cmd); + + kKernelDebugger.Attach(kPath, cmd, kPID); + } + + if (cmd == "exit") { + if (kPID > 0) kKernelDebugger.Detach(); + + break; + } + + if (cmd == "break" || cmd == "b") { + kStdOut << "[?] Enter a symbol to break on: "; + + std::getline(std::cin, cmd); + + if (kKernelDebugger.BreakAt(cmd)) { + pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); + } + } + } + + return EXIT_SUCCESS; + } + + kStdOut << "usage: " << argv[0] << " -k -ip \n"; + kStdOut << "example: " << argv[0] << " -k /path/to/ne_kernel -ip 127.0.0.1\n"; + + return EXIT_FAILURE; +} + +#endif // DK_NEKERNEL_DEBUGGER diff --git a/src/DebuggerKit/src/NeSystem.cpp b/src/DebuggerKit/src/NeSystem.cpp new file mode 100644 index 0000000..ea3beb4 --- /dev/null +++ b/src/DebuggerKit/src/NeSystem.cpp @@ -0,0 +1,87 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) +// Licensed under the Apache License, Version 2.0 (See accompanying +// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) +// Official repository: https://github.com/ne-foss-org/nectar + +#ifdef DK_NEKERNEL_DEBUGGER + +/// @author Amlal El Mahrouss +/// @brief Kernel Debugger Protocol + +#include +#include + +using namespace DebuggerKit::Detail; +using namespace DebuggerKit::NeKernel; + +NeSystemDebugger::NeSystemDebugger() = default; +NeSystemDebugger::~NeSystemDebugger() = default; + +bool NeSystemDebugger::Attach(CompilerKit::STLString path, CompilerKit::STLString argv, + ProcessID& pid) noexcept { + if (path.empty() || argv.empty()) return NO; + + m_socket = ::socket(AF_INET, SOCK_STREAM, 0); + + if (m_socket == -1) return NO; + + struct sockaddr_in server_addr; + + server_addr.sin_family = AF_INET; + server_addr.sin_port = htons(kDebugPort); + + if (::inet_pton(AF_INET, argv.c_str(), &server_addr.sin_addr) <= 0) return NO; + + auto ret = (::connect(m_socket, (struct sockaddr*) &server_addr, sizeof(server_addr)) == -1); + + if (ret) return NO; + + CompilerKit::STLString pkt = Detail::kDebugMagic; + pkt += ";\r"; + + ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; + return ret; +} + +bool NeSystemDebugger::BreakAt(CompilerKit::STLString symbol) noexcept { + CompilerKit::STLString pkt = Detail::kDebugMagic; + pkt += ";SYM=\""; + pkt += symbol; + pkt += "\";\r"; + + if (pkt.size() > kDebugCmdLen) return NO; + + auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; + return ret; +} + +bool NeSystemDebugger::Break() noexcept { + CompilerKit::STLString pkt = Detail::kDebugMagic; + pkt += ";BRK=1;\r"; + + auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; + return ret; +} + +bool NeSystemDebugger::Continue() noexcept { + CompilerKit::STLString pkt = Detail::kDebugMagic; + pkt += ";CONT=1;\r"; + + auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; + return ret; + return NO; +} + +bool NeSystemDebugger::Detach() noexcept { + CompilerKit::STLString pkt = Detail::kDebugMagic; + pkt += ";DTCH=1;\r"; + + auto ret = ::send(m_socket, pkt.data(), pkt.size(), 0) > 0; + + if (ret) ::close(m_socket); + + return ret; +} + +#endif // DK_NEKERNEL_DEBUGGER diff --git a/src/DebuggerKit/src/POSIX+CLI.cpp b/src/DebuggerKit/src/POSIX+CLI.cpp new file mode 100644 index 0000000..30dbe26 --- /dev/null +++ b/src/DebuggerKit/src/POSIX+CLI.cpp @@ -0,0 +1,94 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) +// Licensed under the Apache License, Version 2.0 (See accompanying +// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) +// Official repository: https://github.com/ne-foss-org/nectar + +#ifdef DK_POSIX_DEBUGGER + +#include +#include + +#include + +/// @internal +/// @brief Handles CTRL-C signal on debugger. +static Void dbgi_ctrlc_handler(std::int32_t _) { + if (!kPID) { + return; + } + + kUserDebugger.Break(); + + pfd::notify("Debugger Event", "Breakpoint hit!"); + + kKeepRunning = false; +} + +NECTAR_MODULE(DebuggerPOSIX) { + pfd::notify( + "Debugger Event", + "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); + + if (argc >= 3 && std::string(argv[1]) == "-p" && argv[2] != nullptr) { + kPath = argv[2]; + kUserDebugger.SetPath(kPath); + + kStdOut << "[+] Image set to: " << kPath << "\n"; + } else { + kStdOut << "usage: " << argv[0] << " -p \n"; + kStdOut << "example: " << argv[0] << " -p \n"; + + return EXIT_FAILURE; + } + + CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); + + while (YES) { + if (kKeepRunning) { + continue; + } + + CompilerKit::STLString cmd{}; + + if (!std::getline(std::cin, cmd)) break; + + if (cmd == "c" || cmd == "cont" || cmd == "continue") { + if (kUserDebugger.Continue()) { + kKeepRunning = true; + + kStdOut << "[+] Continuing...\n"; + pfd::notify("Debugger Event", "Continuing..."); + } + } + + if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); + + if (cmd == "start") { + kStdOut << "[?] Enter a argument to use: "; + std::getline(std::cin, cmd); + + kUserDebugger.Attach(kPath, cmd, kPID); + } + + if (cmd == "exit") { + if (kPID > 0) kUserDebugger.Detach(); + + break; + } + + if (cmd == "break" || cmd == "b") { + kStdOut << "[?] Enter a symbol to break on: "; + + std::getline(std::cin, cmd); + + if (kUserDebugger.BreakAt(cmd)) { + pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); + } + } + } + + return EXIT_SUCCESS; +} + +#endif diff --git a/src/DebuggerKit/src/POSIXContractCLI.cpp b/src/DebuggerKit/src/POSIXContractCLI.cpp deleted file mode 100644 index 58aa4a1..0000000 --- a/src/DebuggerKit/src/POSIXContractCLI.cpp +++ /dev/null @@ -1,94 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// Copyright 2024-2026, Amlal El Mahrouss (amlal@nekernel.org) -// Licensed under the Apache License, Version 2.0 (See accompanying -// file LICENSE or copy at http://www.apache.org/licenses/LICENSE-2.0) -// Official repository: https://github.com/ne-foss-org/nectar - -#ifdef DK_POSIX_DEBUGGER - -#include -#include - -#include - -/// @internal -/// @brief Handles CTRL-C signal on debugger. -static Void dbgi_ctrlc_handler(std::int32_t _) { - if (!kPID) { - return; - } - - kUserDebugger.Break(); - - pfd::notify("Debugger Event", "Breakpoint hit!"); - - kKeepRunning = false; -} - -NECTAR_MODULE(DebuggerPOSIX) { - pfd::notify( - "Debugger Event", - "Userland Debugger\n(C) 2025 Amlal El Mahrouss, licensed under the Apache 2.0 license."); - - if (argc >= 3 && std::string(argv[1]) == "-p" && argv[2] != nullptr) { - kPath = argv[2]; - kUserDebugger.SetPath(kPath); - - kStdOut << "[+] Image set to: " << kPath << "\n"; - } else { - kStdOut << "usage: " << argv[0] << " -p \n"; - kStdOut << "example: " << argv[0] << " -p \n"; - - return EXIT_FAILURE; - } - - CompilerKit::install_signal(SIGINT, dbgi_ctrlc_handler); - - while (YES) { - if (kKeepRunning) { - continue; - } - - CompilerKit::STLString cmd{}; - - if (!std::getline(std::cin, cmd)) break; - - if (cmd == "c" || cmd == "cont" || cmd == "continue") { - if (kUserDebugger.Continue()) { - kKeepRunning = true; - - kStdOut << "[+] Continuing...\n"; - pfd::notify("Debugger Event", "Continuing..."); - } - } - - if (cmd == "d" || cmd == "detach") kUserDebugger.Detach(); - - if (cmd == "start") { - kStdOut << "[?] Enter a argument to use: "; - std::getline(std::cin, cmd); - - kUserDebugger.Attach(kPath, cmd, kPID); - } - - if (cmd == "exit") { - if (kPID > 0) kUserDebugger.Detach(); - - break; - } - - if (cmd == "break" || cmd == "b") { - kStdOut << "[?] Enter a symbol to break on: "; - - std::getline(std::cin, cmd); - - if (kUserDebugger.BreakAt(cmd)) { - pfd::notify("Debugger Event", "Add breakpoint at: " + cmd); - } - } - } - - return EXIT_SUCCESS; -} - -#endif -- cgit v1.2.3