mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-07-30 12:49:19 +00:00
c1eb744ff0
Make sure that userspace is always referencing "system" headers in a way that would build on target :). This means removing the explicit include_directories of Libraries/LibC in favor of having it export its headers as SYSTEM. Also remove a redundant include_directories of Libraries in the 'serenity build' part of the build script. It's already set at the top. This causes issues for the Kernel, and for crt0.o. These special cases are handled individually.
290 lines
10 KiB
C++
290 lines
10 KiB
C++
/*
|
|
* Copyright (c) 2020, Itamar S. <itamar8910@gmail.com>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include <AK/Assertions.h>
|
|
#include <AK/ByteBuffer.h>
|
|
#include <AK/Demangle.h>
|
|
#include <AK/LogStream.h>
|
|
#include <AK/StringBuilder.h>
|
|
#include <AK/kmalloc.h>
|
|
#include <LibCore/File.h>
|
|
#include <LibDebug/DebugInfo.h>
|
|
#include <LibDebug/DebugSession.h>
|
|
#include <LibLine/Editor.h>
|
|
#include <LibX86/Disassembler.h>
|
|
#include <LibX86/Instruction.h>
|
|
#include <signal.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <sys/arch/i386/regs.h>
|
|
#include <unistd.h>
|
|
|
|
static Line::Editor editor {};
|
|
|
|
static int usage()
|
|
{
|
|
printf("usage: sdb [command...]\n");
|
|
return 1;
|
|
}
|
|
|
|
OwnPtr<DebugSession> g_debug_session;
|
|
|
|
static void handle_sigint(int)
|
|
{
|
|
printf("Debugger: SIGINT\n");
|
|
|
|
// The destructor of DebugSession takes care of detaching
|
|
g_debug_session = nullptr;
|
|
}
|
|
|
|
void handle_print_registers(const PtraceRegisters& regs)
|
|
{
|
|
printf("eax: 0x%x\n", regs.eax);
|
|
printf("ecx: 0x%x\n", regs.ecx);
|
|
printf("edx: 0x%x\n", regs.edx);
|
|
printf("ebx: 0x%x\n", regs.ebx);
|
|
printf("esp: 0x%x\n", regs.esp);
|
|
printf("ebp: 0x%x\n", regs.ebp);
|
|
printf("esi: 0x%x\n", regs.esi);
|
|
printf("edi: 0x%x\n", regs.edi);
|
|
printf("eip: 0x%x\n", regs.eip);
|
|
printf("eflags: 0x%x\n", regs.eflags);
|
|
}
|
|
|
|
bool handle_disassemble_command(const String& command, void* first_instruction)
|
|
{
|
|
(void)demangle("foo");
|
|
auto parts = command.split(' ');
|
|
size_t number_of_instructions_to_disassemble = 5;
|
|
if (parts.size() == 2) {
|
|
bool ok;
|
|
number_of_instructions_to_disassemble = parts[1].to_uint(ok);
|
|
if (!ok)
|
|
return false;
|
|
}
|
|
|
|
// FIXME: Instead of using a fixed "dump_size",
|
|
// we can feed instructions to the disassembler one by one
|
|
constexpr size_t dump_size = 0x100;
|
|
ByteBuffer code;
|
|
for (size_t i = 0; i < dump_size / sizeof(u32); ++i) {
|
|
auto value = g_debug_session->peek(reinterpret_cast<u32*>(first_instruction) + i);
|
|
if (!value.has_value())
|
|
break;
|
|
code.append(&value, sizeof(u32));
|
|
}
|
|
|
|
X86::SimpleInstructionStream stream(code.data(), code.size());
|
|
X86::Disassembler disassembler(stream);
|
|
|
|
for (size_t i = 0; i < number_of_instructions_to_disassemble; ++i) {
|
|
auto offset = stream.offset();
|
|
auto insn = disassembler.next();
|
|
if (!insn.has_value())
|
|
break;
|
|
|
|
printf(String::format(" %08x ", offset + reinterpret_cast<size_t>(first_instruction)).characters());
|
|
printf("<+%lu>:\t", reinterpret_cast<size_t>(offset));
|
|
printf("%s\n", insn.value().to_string(offset).characters());
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool handle_breakpoint_command(const String& command)
|
|
{
|
|
auto parts = command.split(' ');
|
|
if (parts.size() != 2)
|
|
return false;
|
|
|
|
auto argument = parts[1];
|
|
if (argument.is_empty())
|
|
return false;
|
|
|
|
u32 breakpoint_address = 0;
|
|
|
|
if (argument.contains(":")) {
|
|
auto source_arguments = argument.split(':');
|
|
if (source_arguments.size() != 2)
|
|
return false;
|
|
bool ok = false;
|
|
size_t line = source_arguments[1].to_uint(ok);
|
|
if (!ok)
|
|
return false;
|
|
auto file = source_arguments[0];
|
|
if (!file.contains("/"))
|
|
file = String::format("./%s", file.characters());
|
|
auto result = g_debug_session->debug_info().get_instruction_from_source(file, line);
|
|
if (!result.has_value()) {
|
|
printf("No matching instruction found\n");
|
|
return false;
|
|
}
|
|
breakpoint_address = result.value();
|
|
} else if ((argument[0] >= '0' && argument[0] <= '9')) {
|
|
breakpoint_address = strtoul(argument.characters(), nullptr, 16);
|
|
} else {
|
|
auto symbol = g_debug_session->elf().find_demangled_function(argument);
|
|
if (!symbol.has_value()) {
|
|
printf("symbol %s not found\n", parts[1].characters());
|
|
return false;
|
|
}
|
|
breakpoint_address = reinterpret_cast<u32>(symbol.value().value());
|
|
}
|
|
|
|
bool success = g_debug_session->insert_breakpoint(reinterpret_cast<void*>(breakpoint_address));
|
|
if (!success) {
|
|
fprintf(stderr, "coult not insert breakpoint at: %08x\n", breakpoint_address);
|
|
return false;
|
|
}
|
|
printf("breakpoint insterted at: %08x\n", breakpoint_address);
|
|
return true;
|
|
}
|
|
|
|
void print_help()
|
|
{
|
|
printf("Options:\n"
|
|
"cont - Continue execution\n"
|
|
"si - step to the next instruction\n"
|
|
"sl - step to the next source line\n"
|
|
"line - show the position of the current instruction in the source code\n"
|
|
"regs - Print registers\n"
|
|
"dis [number of instructions] - Print disassembly\n"
|
|
"bp <address/symbol/file:line> - Insert a breakpoint\n");
|
|
}
|
|
|
|
int main(int argc, char** argv)
|
|
{
|
|
if (pledge("stdio proc exec rpath tty", nullptr) < 0) {
|
|
perror("pledge");
|
|
return 1;
|
|
}
|
|
|
|
if (argc == 1)
|
|
return usage();
|
|
|
|
StringBuilder command;
|
|
command.append(argv[1]);
|
|
for (int i = 2; i < argc; ++i) {
|
|
command.appendf("%s ", argv[i]);
|
|
}
|
|
|
|
auto result = DebugSession::exec_and_attach(command.to_string());
|
|
if (!result) {
|
|
fprintf(stderr, "Failed to start debugging session for: \"%s\"\n", command.to_string().characters());
|
|
exit(1);
|
|
}
|
|
g_debug_session = result.release_nonnull();
|
|
|
|
struct sigaction sa;
|
|
memset(&sa, 0, sizeof(struct sigaction));
|
|
sa.sa_handler = handle_sigint;
|
|
sigaction(SIGINT, &sa, nullptr);
|
|
|
|
bool rc = g_debug_session->insert_breakpoint(g_debug_session->elf().entry().as_ptr());
|
|
ASSERT(rc);
|
|
|
|
DebugInfo::SourcePosition previous_source_position;
|
|
bool in_step_line = false;
|
|
|
|
g_debug_session->run([&](DebugSession::DebugBreakReason reason, Optional<PtraceRegisters> optional_regs) {
|
|
if (reason == DebugSession::DebugBreakReason::Exited) {
|
|
printf("Program exited.\n");
|
|
return DebugSession::DebugDecision::Detach;
|
|
}
|
|
|
|
ASSERT(optional_regs.has_value());
|
|
const PtraceRegisters& regs = optional_regs.value();
|
|
|
|
auto symbol_at_ip = g_debug_session->elf().symbolicate(regs.eip);
|
|
auto source_position = g_debug_session->debug_info().get_source_position(regs.eip);
|
|
|
|
if (in_step_line) {
|
|
bool no_source_info = !source_position.has_value();
|
|
if (no_source_info || source_position.value() != previous_source_position) {
|
|
if (no_source_info)
|
|
printf("No source information for current instruction! stoppoing.\n");
|
|
in_step_line = false;
|
|
} else {
|
|
return DebugSession::DebugDecision::SingleStep;
|
|
}
|
|
}
|
|
|
|
printf("Program is stopped at: 0x%x (%s)\n", regs.eip, symbol_at_ip.characters());
|
|
|
|
if (source_position.has_value()) {
|
|
previous_source_position = source_position.value();
|
|
printf("Source location: %s:%lu\n", source_position.value().file_path.characters(), source_position.value().line_number);
|
|
} else {
|
|
printf("(No source location information for the current instruction)\n");
|
|
}
|
|
|
|
for (;;) {
|
|
auto command = editor.get_line("(sdb) ");
|
|
bool success = false;
|
|
Optional<DebugSession::DebugDecision> decision;
|
|
|
|
if (command.is_empty() && !editor.history().is_empty()) {
|
|
command = editor.history().last();
|
|
}
|
|
if (command == "cont") {
|
|
decision = DebugSession::DebugDecision::Continue;
|
|
success = true;
|
|
} else if (command == "si") {
|
|
decision = DebugSession::DebugDecision::SingleStep;
|
|
success = true;
|
|
} else if (command == "sl") {
|
|
if (source_position.has_value()) {
|
|
decision = DebugSession::DebugDecision::SingleStep;
|
|
in_step_line = true;
|
|
success = true;
|
|
} else {
|
|
printf("No source location information for the current instruction\n");
|
|
}
|
|
} else if (command == "regs") {
|
|
handle_print_registers(regs);
|
|
success = true;
|
|
|
|
} else if (command.starts_with("dis")) {
|
|
success = handle_disassemble_command(command, reinterpret_cast<void*>(regs.eip));
|
|
|
|
} else if (command.starts_with("bp")) {
|
|
success = handle_breakpoint_command(command);
|
|
}
|
|
|
|
if (success && !command.is_empty()) {
|
|
// Don't add repeated commands to history
|
|
if (editor.history().is_empty() || editor.history().last() != command)
|
|
editor.add_to_history(command);
|
|
}
|
|
if (!success) {
|
|
print_help();
|
|
}
|
|
if (decision.has_value())
|
|
return decision.value();
|
|
}
|
|
});
|
|
}
|