1.. highlight:: none 2 3.. include:: ../disclaimer-zh_CN.rst 4 5:Original: Documentation/dev-tools/gdb-kernel-debugging.rst 6:Translator: 高超 gao chao <gaochao49@huawei.com> 7 8通过gdb调试内核和模块 9===================== 10 11Kgdb内核调试器、QEMU等虚拟机管理程序或基于JTAG的硬件接口，支持在运行时使用gdb 12调试Linux内核及其模块。Gdb提供了一个强大的python脚本接口，内核也提供了一套 13辅助脚本以简化典型的内核调试步骤。本文档为如何启用和使用这些脚本提供了一个简要的教程。 14此教程基于QEMU/KVM虚拟机，但文中示例也适用于其他gdb stub。 15 16 17环境配置要求 18------------ 19 20- gdb 7.2+ (推荐版本: 7.4+) 且开启python支持 (通常发行版上都已支持) 21 22设置 23---- 24 25- 创建一个QEMU/KVM的linux虚拟机（详情请参考 www.linux-kvm.org 和 www.qemu.org ）。 26 对于交叉开发，https://landley.net/aboriginal/bin 提供了一些镜像和工具链， 27 可以帮助搭建交叉开发环境。 28 29- 编译内核时开启CONFIG_GDB_SCRIPTS，关闭CONFIG_DEBUG_INFO_REDUCED。 30 如果架构支持CONFIG_FRAME_POINTER，请保持开启。 31 32- 在guest环境上安装该内核。如有必要，通过在内核command line中添加“nokaslr”来关闭KASLR。 33 此外，QEMU允许通过-kernel、-append、-initrd这些命令行选项直接启动内核。 34 但这通常仅在不依赖内核模块时才有效。有关此模式的更多详细信息，请参阅QEMU文档。 35 在这种情况下，如果架构支持KASLR，应该在禁用CONFIG_RANDOMIZE_BASE的情况下构建内核。 36 37- 构建gdb脚本（适用于内核v5.1版本及以上） 38 39 make scripts_gdb 40 41- 启用QEMU/KVM的gdb stub，可以通过如下方式实现 42 43 - 在VM启动时，通过在QEMU命令行中添加“-s”参数 44 45 或 46 47 - 在运行时通过从QEMU监视控制台发送“gdbserver” 48 49- 切换到/path/to/linux-build(内核源码编译)目录 50 51- 启动gdb：gdb vmlinux 52 53 注意：某些发行版可能会将gdb脚本的自动加载限制在已知的安全目录中。 54 如果gdb报告拒绝加载vmlinux-gdb.py（相关命令找不到），请将:: 55 56 add-auto-load-safe-path /path/to/linux-build 57 58 添加到~/.gdbinit。更多详细信息，请参阅gdb帮助信息。 59 60- 连接到已启动的guest环境:: 61 62 (gdb) target remote :1234 63 64 65使用Linux提供的gdb脚本的示例 66---------------------------- 67 68- 加载模块（以及主内核）符号:: 69 70 (gdb) lx-symbols 71 loading vmlinux 72 scanning for modules in /home/user/linux/build 73 loading @0xffffffffa0020000: /home/user/linux/build/net/netfilter/xt_tcpudp.ko 74 loading @0xffffffffa0016000: /home/user/linux/build/net/netfilter/xt_pkttype.ko 75 loading @0xffffffffa0002000: /home/user/linux/build/net/netfilter/xt_limit.ko 76 loading @0xffffffffa00ca000: /home/user/linux/build/net/packet/af_packet.ko 77 loading @0xffffffffa003c000: /home/user/linux/build/fs/fuse/fuse.ko 78 ... 79 loading @0xffffffffa0000000: /home/user/linux/build/drivers/ata/ata_generic.ko 80 81- 对一些尚未加载的模块中的函数函数设置断点，例如:: 82 83 (gdb) b btrfs_init_sysfs 84 Function "btrfs_init_sysfs" not defined. 85 Make breakpoint pending on future shared library load? (y or [n]) y 86 Breakpoint 1 (btrfs_init_sysfs) pending. 87 88- 继续执行:: 89 90 (gdb) c 91 92- 加载模块并且能观察到正在加载的符号以及断点命中:: 93 94 loading @0xffffffffa0034000: /home/user/linux/build/lib/libcrc32c.ko 95 loading @0xffffffffa0050000: /home/user/linux/build/lib/lzo/lzo_compress.ko 96 loading @0xffffffffa006e000: /home/user/linux/build/lib/zlib_deflate/zlib_deflate.ko 97 loading @0xffffffffa01b1000: /home/user/linux/build/fs/btrfs/btrfs.ko 98 99 Breakpoint 1, btrfs_init_sysfs () at /home/user/linux/fs/btrfs/sysfs.c:36 100 36 btrfs_kset = kset_create_and_add("btrfs", NULL, fs_kobj); 101 102- 查看内核的日志缓冲区:: 103 104 (gdb) lx-dmesg 105 [ 0.000000] Initializing cgroup subsys cpuset 106 [ 0.000000] Initializing cgroup subsys cpu 107 [ 0.000000] Linux version 3.8.0-rc4-dbg+ (... 108 [ 0.000000] Command line: root=/dev/sda2 resume=/dev/sda1 vga=0x314 109 [ 0.000000] e820: BIOS-provided physical RAM map: 110 [ 0.000000] BIOS-e820: [mem 0x0000000000000000-0x000000000009fbff] usable 111 [ 0.000000] BIOS-e820: [mem 0x000000000009fc00-0x000000000009ffff] reserved 112 .... 113 114- 查看当前task struct结构体的字段（仅x86和arm64支持）:: 115 116 (gdb) p $lx_current().pid 117 $1 = 4998 118 (gdb) p $lx_current().comm 119 $2 = "modprobe\000\000\000\000\000\000\000" 120 121- 对当前或指定的CPU使用per-cpu函数:: 122 123 (gdb) p $lx_per_cpu(runqueues).nr_running 124 $3 = 1 125 (gdb) p $lx_per_cpu(runqueues, 2).nr_running 126 $4 = 0 127 128- 使用container_of查看更多hrtimers信息:: 129 130 (gdb) set $leftmost = $lx_per_cpu(hrtimer_bases).clock_base[0].active.rb_root.rb_leftmost 131 (gdb) p *$container_of($leftmost, "struct hrtimer", "node") 132 $5 = { 133 node = { 134 node = { 135 __rb_parent_color = 18446612686384860673, 136 rb_right = 0xffff888231da8b00, 137 rb_left = 0x0 138 }, 139 expires = 1228461000000 140 }, 141 _softexpires = 1228461000000, 142 function = 0xffffffff8137ab20 <tick_nohz_handler>, 143 base = 0xffff888231d9b4c0, 144 state = 1 '\001', 145 is_rel = 0 '\000', 146 is_soft = 0 '\000', 147 is_hard = 1 '\001' 148 } 149 150 151命令和辅助调试功能列表 152---------------------- 153 154命令和辅助调试功能可能会随着时间的推移而改进，此文显示的是初始版本的部分示例:: 155 156 (gdb) apropos lx 157 function lx_current -- Return current task 158 function lx_module -- Find module by name and return the module variable 159 function lx_per_cpu -- Return per-cpu variable 160 function lx_task_by_pid -- Find Linux task by PID and return the task_struct variable 161 function lx_thread_info -- Calculate Linux thread_info from task variable 162 lx-dmesg -- Print Linux kernel log buffer 163 lx-lsmod -- List currently loaded modules 164 lx-symbols -- (Re-)load symbols of Linux kernel and currently loaded modules 165 166可以通过“help <command-name>”或“help function <function-name>”命令 167获取指定命令或指定调试功能的更多详细信息。 168