Documentation/translations/zh_TW/dev-tools/gdb-kernel-debugging.rst

   1 .. highlight:: none
   2
   3 .. include:: ../disclaimer-zh_TW.rst
   4
   5 :Original: Documentation/dev-tools/gdb-kernel-debugging.rst
   6 :Translator: 高超 gao chao <gaochao49@huawei.com>
   7
   8 通過gdb調試內核和模塊
   9 =====================
  10
  11 Kgdb內核調試器、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 - 啓用QEMU/KVM的gdb stub，可以通過如下方式實現
  38
  39     - 在VM啓動時，通過在QEMU命令行中添加“-s”參數
  40
  41   或
  42
  43     - 在運行時通過從QEMU監視控制檯發送“gdbserver”
  44
  45 - 切換到/path/to/linux-build(內核源碼編譯)目錄
  46
  47 - 啓動gdb：gdb vmlinux
  48
  49   注意：某些發行版可能會將gdb腳本的自動加載限制在已知的安全目錄中。
  50   如果gdb報告拒絕加載vmlinux-gdb.py（相關命令找不到），請將::
  51
  52     add-auto-load-safe-path /path/to/linux-build
  53
  54   添加到~/.gdbinit。更多詳細信息，請參閱gdb幫助信息。
  55
  56 - 連接到已啓動的guest環境::
  57
  58     (gdb) target remote :1234
  59
  60
  61 使用Linux提供的gdb腳本的示例
  62 ----------------------------
  63
  64 - 加載模塊（以及主內核）符號::
  65
  66     (gdb) lx-symbols
  67     loading vmlinux
  68     scanning for modules in /home/user/linux/build
  69     loading @0xffffffffa0020000: /home/user/linux/build/net/netfilter/xt_tcpudp.ko
  70     loading @0xffffffffa0016000: /home/user/linux/build/net/netfilter/xt_pkttype.ko
  71     loading @0xffffffffa0002000: /home/user/linux/build/net/netfilter/xt_limit.ko
  72     loading @0xffffffffa00ca000: /home/user/linux/build/net/packet/af_packet.ko
  73     loading @0xffffffffa003c000: /home/user/linux/build/fs/fuse/fuse.ko
  74     ...
  75     loading @0xffffffffa0000000: /home/user/linux/build/drivers/ata/ata_generic.ko
  76
  77 - 對一些尚未加載的模塊中的函數函數設置斷點，例如::
  78
  79     (gdb) b btrfs_init_sysfs
  80     Function "btrfs_init_sysfs" not defined.
  81     Make breakpoint pending on future shared library load? (y or [n]) y
  82     Breakpoint 1 (btrfs_init_sysfs) pending.
  83
  84 - 繼續執行::
  85
  86     (gdb) c
  87
  88 - 加載模塊並且能觀察到正在加載的符號以及斷點命中::
  89
  90     loading @0xffffffffa0034000: /home/user/linux/build/lib/libcrc32c.ko
  91     loading @0xffffffffa0050000: /home/user/linux/build/lib/lzo/lzo_compress.ko
  92     loading @0xffffffffa006e000: /home/user/linux/build/lib/zlib_deflate/zlib_deflate.ko
  93     loading @0xffffffffa01b1000: /home/user/linux/build/fs/btrfs/btrfs.ko
  94
  95     Breakpoint 1, btrfs_init_sysfs () at /home/user/linux/fs/btrfs/sysfs.c:36
  96     36              btrfs_kset = kset_create_and_add("btrfs", NULL, fs_kobj);
  97
  98 - 查看內核的日誌緩衝區::
  99
 100     (gdb) lx-dmesg
 101     [     0.000000] Initializing cgroup subsys cpuset
 102     [     0.000000] Initializing cgroup subsys cpu
 103     [     0.000000] Linux version 3.8.0-rc4-dbg+ (...
 104     [     0.000000] Command line: root=/dev/sda2 resume=/dev/sda1 vga=0x314
 105     [     0.000000] e820: BIOS-provided physical RAM map:
 106     [     0.000000] BIOS-e820: [mem 0x0000000000000000-0x000000000009fbff] usable
 107     [     0.000000] BIOS-e820: [mem 0x000000000009fc00-0x000000000009ffff] reserved
 108     ....
 109
 110 - 查看當前task struct結構體的字段（僅x86和arm64支持）::
 111
 112     (gdb) p $lx_current().pid
 113     $1 = 4998
 114     (gdb) p $lx_current().comm
 115     $2 = "modprobe\000\000\000\000\000\000\000"
 116
 117 - 對當前或指定的CPU使用per-cpu函數::
 118
 119     (gdb) p $lx_per_cpu("runqueues").nr_running
 120     $3 = 1
 121     (gdb) p $lx_per_cpu("runqueues", 2).nr_running
 122     $4 = 0
 123
 124 - 使用container_of查看更多hrtimers信息::
 125
 126     (gdb) set $next = $lx_per_cpu("hrtimer_bases").clock_base[0].active.next
 127     (gdb) p *$container_of($next, "struct hrtimer", "node")
 128     $5 = {
 129       node = {
 130         node = {
 131           __rb_parent_color = 18446612133355256072,
 132           rb_right = 0x0 <irq_stack_union>,
 133           rb_left = 0x0 <irq_stack_union>
 134         },
 135         expires = {
 136           tv64 = 1835268000000
 137         }
 138       },
 139       _softexpires = {
 140         tv64 = 1835268000000
 141       },
 142       function = 0xffffffff81078232 <tick_sched_timer>,
 143       base = 0xffff88003fd0d6f0,
 144       state = 1,
 145       start_pid = 0,
 146       start_site = 0xffffffff81055c1f <hrtimer_start_range_ns+20>,
 147       start_comm = "swapper/2\000\000\000\000\000\000"
 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