自己动手编写一个Linux调试器系列之1 准备工作 by lantie@15PB
我想每个人都会编写不止一个 hello world 程序, 并且使用调试器来调试这些程序（如果你没有，那放下你手上的活儿，来学习使用调试器吧）。然而，尽管调试器使用如此广泛，但却没有很多资料可以告诉我们它的工作原理，以及如何编写一个调试器。特别是与编程时的其他工具技术(如编译器)比起来。在这个系列的文章中，我们将会学习调试器的原理并编写一个调试器去调试Linux程序。
我们将支持以下功能：
- 启动、停止并继续执行
- 设置各种断点
- 内存地址
- 源代码行
- 函数入口处
- 读取和写入寄存器和内存
- 单步跟踪
- 指令
- 单步步入
- 单步跳过
- 单步步过
- 打印当前源码位置
- 打印栈回溯信息
- 打印简单的值信息
最后我还会概述如何将以下功能添加到编写的调试器中：
- 远程调试
- 共享库和动态加载的支持
- 表达式求值
- 多线程调试的支持
我将使用C和C++来编写这个项目，但这个项目同样也适用于编译成机器代码和输出标准的DWARF调试信息的编程语言。(如果你不知道这是什么，不要担心，马上就会清楚了)
此外， 我们的主要目的是在大多数情况下，使程序都能正常运行，因此健壮的错误处理会使编写变得更简单。
系列索引
- 准备工作
- 断点
- 寄存器和内存
- ELF文件和调试信息
- 源码和信号
- 源码级单步
- 源码级断点
- 堆栈解除
- 处理变量
- 高级主题
开始设置
在我们开始讨论之前，让我们先建立环境。在本教程中，我们将使用两个依赖项：
-
Linenoise用于处理我们的命令行输入 -
libelfin用于解析调试信息。
你可以使用比较传统的libdwarf而不是libelfin，但是其接口远没有那么好，libelfin还提供了一个基本完整的DWARF表达式求值工具，如果您想要读取变量的话，这将节省您很多时间。请务必您使用我的libelfin的fbreg分支，因为它为x86上的读取变量提供了一些额外的支持。
一旦你在系统中安装了这些工具，或者在你的系统上编译了相关的依赖项，就可以开始了。我只是将它们与我的CMake文件中的其他代码一起编译。
启动程序
在我们调试一个程序时，首先我们需要先系统一个要调试的程序。我们可以使用经典的 fork/exec 模式。
int main(int argc, char* argv[]) {
if (argc < 2) {
std::cerr << "Program name not specified";
return -1;
}
auto prog = argv[1];
auto pid = fork();
if (pid == 0) {
// 我们在子进程中
// 执行要调试的程序
}
else if (pid >= 1) {
// 我们在父进程中
// 执行调试器
}
我们调用fork会使我们的程序分为两个进程，如果我们在子进程中fork返回0，如果我们在父进程中，则返回子进程的进程ID。
如果我们在子进程中，我们想用我们要调试的程序替换当前正在执行的程序，从而达到调试程序的目的。
ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
execl(prog, prog, nullptr);
这里我们第一次使用ptrace，它将在编写调试器时成为我们最好的朋友。ptrace允许我们通过读取寄存器，读取内存，单步执行等来观察和控制另一个进程的执行。
这个API非常难看，它是一个单一的函数，其中提了一些枚举值可以使用，还有一些参数可以根据你提供的值使用或是忽略。函数的签名如下所示：
long ptrace(enum __ptrace_request request, pid_t pid,
void *addr, void *data);
-
request是我们对想要去跟踪的进程能做什么。 -
pid是跟踪进程的进程id。 -
addr是内存地址，这是用在跟踪时一些调用指定地址。 -
data是某些请求特定的资源。 - 返回值通常会提供错误信息，因此需要在编写代码时对返回值进行检查，更多信息可以查阅man手册。
在上面的代码中 request的值是PTRACE_TRACEME时 表面这个进程应该允许其父进程跟踪它，所有其他参数可以被忽略，因为API设计的参数就不太重要。
下一步，我们调用 execl，这是许多 exec的类似函数的其中一个。我们执行给定的程序，通过它的名称作为命令行参数和一个nullptr终止参数列表。如果你愿意，你可以将nullptr替换为你的程序所需的任何其他参数。
在我们完成这项工作之后，我们完成了子进程，我们将让它继续运行，直到我们完成它为止。
添加调试器循环
现在我们已经启动了子进程，我们希望能够与它进行交互。 为此，我们将创建一个debugger类，为其提供一个用于监听用户输入的循环，并从我们的main函数中父进程的fork之后开始。
else if (pid >= 1) {
//parent
debugger dbg{prog, pid};
dbg.run();
}
class debugger {
public:
debugger (std::string prog_name, pid_t pid)
: m_prog_name{std::move(prog_name)}, m_pid{pid} {}
void run();
private:
std::string m_prog_name;
pid_t m_pid;
};
在我们的run函数中，我们需要等待子进程完成启动，然后继续从linenoise获取输入，直到得到一个EOF（ctrl + d）。
void debugger::run() {
int wait_status;
auto options = 0;
waitpid(m_pid, &wait_status, options);
char* line = nullptr;
while((line = linenoise("minidbg> ")) != nullptr) {
handle_command(line);
linenoiseHistoryAdd(line);
linenoiseFree(line);
}
}
当跟踪进程启动时，将发送一个SIGTRAP信号，它是一个跟踪或断点陷阱。 我们可以等到这个信号使用 waitpid 函数发送。
在我们知道这个进程已经准备好进行调试之后，我们会监听用户的输入。linenoise 函数自动显示和处理用户输入的提示。 这意味着我们得到一个很好的命令行与历史和导航命令，而不需要做太多的工作。 当我们得到输入时，我们给一个handle_command函数给出这个命令，我们将很快写入，然后我们将这个命令添加到linenoise历史中并释放资源。
处理输入
我们的命令将遵循与gdb和lldb类似的格式。 要继续该程序，用户将键入continue或cont或甚至c。 如果他们想在地址上设置一个断点，它们会写入break 0xDEADBEEF，其中0xDEADBEEF是十六进制格式的所需地址。 我们添加对这些命令的支持。
void debugger::handle_command(const std::string& line) {
auto args = split(line,' ');
auto command = args[0];
if (is_prefix(command, "continue")) {
continue_execution();
}
else {
std::cerr << "Unknown command\n";
}
}
split和is_prefix是一些小的帮助函数：
std::vector<std::string> split(const std::string &s, char delimiter) {
std::vector<std::string> out{};
std::stringstream ss {s};
std::string item;
while (std::getline(ss,item,delimiter)) {
out.push_back(item);
}
return out;
}
bool is_prefix(const std::string& s, const std::string& of) {
if (s.size() > of.size()) return false;
return std::equal(s.begin(), s.end(), of.begin());
}
我们将在debugger类中添加continue_execution。
void debugger::continue_execution() {
ptrace(PTRACE_CONT, m_pid, nullptr, nullptr);
int wait_status;
auto options = 0;
waitpid(m_pid, &wait_status, options);
}
现在我们的continue_execution函数只是使用ptrace来告诉进程继续，然后调用waitpid直到它发出信号。
完成准备工作
现在，你应该可以编译一些C或C++程序，通过自己写的调试器运行它，看到它停止输入，并能够从调试器继续执行。 在下一部分中，我们将学习如何让我们的调试器设置断点。 如果遇到任何问题，请在评论中通知我！
你可以在这里找到这篇文章的代码。
说明
原文来自：https://blog.tartanllama.xyz/writing-a-linux-debugger-setup/
翻译来自：lantie@15PB, 15PB信息安全教育，主页：http://www.15pb.com.cn
运行截图
使用Clion编写的代码，在控制台中的运行结果
