chainhelen / golang-debugger-book

let's develop a debugger from scratch

How to develop a (golang) debugger

Introduction

This project aims to introduce how to develop a (golang) debugger, including Operating System's support, how to coordinate work between compiler, linker and debugger, debugging information standard, mapping between machine instruction and source code, etc.

Thanks to delve and the author derek parker and other contributors. I learned a lot from them. I want to share the knowledge to develop a (golang) debugger. I hope this project can be useful for developers interested in debugging topic.

To develop a symbolic debugger need to combine the knowledge of CPU instruction (like instruction patching), Operating System (like linux ptrace and OS scheduler), compilers, linkers, loaders, debuggers (how to coordinate the work between them), executable file format (how to store debugging information), debugging information format (how to describe source code, how to map between instruction and source, vice versa), and features of different programming languages (like goroutine concept), so I think it's also a good chance to improve the understanding of computer technology.

I think it's very helpful, So I am really excited to write this documents.

Read the Book

1. clone the repository

git clone https://github.com/hitzhangjie/golang-debugger-book

2. install gitbook or gitbook-cli

# macOS
brew install gitbook-cli

# linux
yum install gitbook-cli
apt install gitbook-cli

# windows
...

3. build the book

cd golang-debugger-book/book

# initialize gitbook plugins
make init 

# build English version
make english

# build Chinese version
make chinese

4. clean tmpfiles

make clean

NOTE: please use Node v10.x.

If you really want to use higher version of Node, please pay attention:

1. if you run gitbook serve has error and your gitbook-cli is installed globally. Find the NPM global installation directory and into dir node_modules/gitbook-cli/node_modules/npm/node_modules, run command npm install graceful-fs@latest --save
2. if you run gitbook install has error, go to user directory and into dir .gitbook/versions/3.2.3/node_modules/npm, run command npm install graceful-fs@latest --save

Contact

This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.

Please email me [e-mail], I will respond as soon as possible.