This is the code repository for Linux Kernel Debugging, published by Packt.
Leverage proven tools and advanced techniques to effectively debug Linux kernels and kernel modules
Linux Kernel Debugging is a comprehensive guide to learning all about advanced kernel debugging. This book covers many areas in depth, such as instrumentation-based debugging techniques (printk and the dynamic debug framework), and shows you how to use Kprobes. Memory-related bugs tend to be a nightmare – two chapters are packed with tools and techniques devoted to debugging them. When the kernel gifts you an Oops, how exactly do you interpret it to be able to debug the underlying issue? We’ve got you covered. Concurrency tends to be an inherently complex topic, so a chapter on lock debugging will help you to learn precisely what data races are, including using KCSAN to detect them. Some thorny issues, both debug- and performance-wise, require detailed kernel-level tracing; you’ll learn to wield the impressive power of Ftrace and its frontends. You’ll also discover how to handle kernel lockups, hangs, and the dreaded kernel panic, as well as leverage the venerable GDB tool within the kernel (KGDB), along with much more.
This book covers the following exciting features:
- Explore instrumentation-based printk along with the powerful dynamic debug framework
- Use static and dynamic Kprobes to trap into kernel/module functions
- Catch kernel memory defects with KASAN, UBSAN, SLUB debug, and kmemleak
- Understand data races and use KCSAN to catch evasive concurrency defects
- Leverage Ftrace and trace-cmd to trace the kernel flow in great detail
- Use KGDB to single-step and debug kernel/module source code
If you feel this book is for you, get your copy today!
All of the code is organized into folders. For example, ch5.
The code will look like the following:
static int handler_pre(struct kprobe *p, struct pt_regs *regs)
{
PRINT_CTX(); // uses pr_debug()
spin_lock(&lock);
tm_start = ktime_get_real_ns();
spin_unlock(&lock);
return 0;
}
Following is what you need for this book: This book is for Linux kernel developers, module/driver authors, and testers interested in debugging and enhancing their Linux systems at the level of the kernel. System administrators who want to understand and debug the internal infrastructure of their Linux kernels will also find this book useful. A good grasp on C programming and the Linux command line is necessary. Some experience with kernel (module) development will help you follow along.
With the following software and hardware list you can run all code files present in the book (Chapter 1-12).
| Chapter | Software required | OS required |
|---|---|---|
| 1-12 | Oracle VirtualBox | Windows, Mac OS X, and Linux (Any) |
| 1-12 | Ubuntu 21.04 or 21.10 LTS | Windows, Mac OS X, and Linux (Any) |
| 1-12 | Visual Studio Code | Windows, Mac OS X, and Linux (Any) |
We also provide a PDF file that has color images of the screenshots/diagrams used in this book. Click here to download it.
-
PDF pg 74: "For the size_t and ssize_t typedefs (which represent signed and unsigned integers respectively)..." should be: "For the size_t and ssize_t typedefs (which represent unsigned and signed integers respectively)..."
-
PDF pg 127: It says: "... We need to interpret the PINT_CTX() macro's output."
It should be: "... We need to interpret the PRINT_CTX() macro's output."
- PDF pg 137: The URL https://elixir.bootlin.com/linux/v5.10.60/source/arch/arm/include/asm/ptrace.h#L135
should be https://elixir.bootlin.com/linux/v5.10.60/source/arch/arm/include/asm/ptrace.h#L15
(same goes for the code comments)
-
PDF pg 235: Broken link: fixed updated link is: https://www.kernel.org/doc/html/latest/mm/slub.html
-
PDF pg 236: Broken link: fixed updated link is: https://www.kernel.org/doc/html/latest/mm/slub.html#emergency-operations
-
PDF pg 262: Broken link: fixed updated link is: https://elixir.bootlin.com/linux/v5.10.60/source/drivers/net/ethernet/cadence/macb_main.c#L3578
-
PDF pg 283: Broken link: fixed updated link is: https://lore.kernel.org/lkml/[email protected]/
-
PDF pg 287: Broken link: fixed updated link is: https://docs.kernel.org/mm/slub.html#short-users-guide-for-slub
-
PDF pg 384: Broken link: fixed updated link is: https://www.mail-archive.com/[email protected]/msg18392.html (removed the incorrect mailto: prefix)
-
PDF pg 509: It says: "... In other words, automatically." It should say: "... In other words, atomically."
-
(PDF) pg 585 (as well as other pages): We refer to "syzkaller" and "syzbot" as the same thing. A reader, Javier Carrasco Cruz, points out that they aren't the same: "... syzbot is a higher-level automation on top of syzkaller that runs multiple instances of syzkaller, keeps bug tracking, and provides a webUI... The link https://groups.google.com/g/syzkaller/c/O9rWGc824eU/m/2DKWhBLkCgAJ goes into more details." Many thanks to you Javier for pointing this out!
-
PDF pg 43: An update to the Ch 01, Further Reading section: One more good article on the Boeing 737 MAX disaster: The Boeing 737 MAX Saga: Lessons for Software Organizations, PHILLIP JOHNSTON AND ROZI HARRIS, Embedded Artistry, 2019
-
PDF pg 126:
As of now (early 2023), attempting to trace file open's via the do_sys_open() doesn't seem to cut it...
I find that instead using the do_sys_openat2() works!
So, substitute this function in place of the do_sys_open() being used and you may get better results...
(In fact, our Figure 4.13 shows the do_sys_openat2() being invoked!).
Kaiwan N Billimoria He taught himself programming on his dad's PC in 1983. By the early 90s, he had discovered the joys of programming on Unix, and by 1997, on Linux! Kaiwan has worked on many aspects of the Linux system programming stack, including Bash, system programming in C, kernel internals, device drivers, and embedded Linux. He has actively worked on commercial/FOSS projects. His contributions include drivers for the mainline Linux OS and many smaller projects hosted on GitHub. His Linux passion feeds well into his passion for teaching these topics to engineers, which he has done for close to three decades now. He's the author of Hands-On System Programming with Linux and Linux Kernel Programming. He is a recreational ultrarunner too.
If you have already purchased a print or Kindle version of this book, you can get a DRM-free PDF version at no cost.
Simply click on the link to claim your free PDF.