作者： Solrex

为 GDB 添加新的目标机 (1)

工作基本结束，留下些文字，希望能对别人有些用处。本文遵从 GNU Free Documentation License (see http://www.gnu.org/copyleft/fdl.html )，并特别对 冒充另类(TeaWater) 的《移植GDB》一文表示感谢 (see http://teawater.spaces.live.com/ )。由于大体和细节的东西在《GDB Internal》和《移植 GDB》一文中已经有了很多描述，所以本文的目的在于 Howto，step by step 地描述如何为 GDB 添加新的目标机，并对某些以上两文中阐释不清的地方做出自己的解释。

为 GDB 添加新的目标机的意思就是让 GDB 支持一个新的 CPU 体系架构。这点从 GDB 的编译选项中可以看出来，在./configure 命令后有一个 --target= 的选项，这个等号后面就是 GDB 调试的二进制文件应该在什么目标机上运行，可以是: mips-elf，arm-elf 等等，在 config.sub 文件中你可以看到这些选项是如何工作的。

下面我们假设要添加的新 target 为 solrex-elf。

1.如何配置编译环境

当你为一个 GDB 添加 target solrex-elf 的时候，至少需要让 GDB 在 configure 为 solrex-elf 时候能够编译通过，为此你需要添加和修改一些文件。

GDB 其实由很多部分共同组成，GDB 源文件目录下有几个目录，bfd 目录下是 LIB BFD (Binary File Descriptor Library)，opcodes 目录下是 opcode library，这两个 library 都是跟随 binutils 分发的； libiberty 目录下是 libiberty library，它给许多 GNU 软件提供一些通用的子程序，好像是跟随 gcc 分发的；readline 目录下是 readline library，提供一些命令行功能，比如<tab>补全，它好像是独立分发的；最关键的 gdb 目录，这个下面才是 GDB 的主体。

是想让 GDB 编译通过，不能只修改 gdb 的东西。要调试程序，必须要有先编译出来二进制代码，所以对 BFD 和 opcodes 的修改应该是最早的，binutils 依赖这些库来编译出来二进制工具，比如ar, as, ld, objdump, readelf 等，然后 gcc 利用这些二进制工具把它编译出来的汇编码最终组合成目标文件和可执行文件。

但是，在某些阶段，比如编译器尚未完善之际，可以先 cheating GDB，就是拿来一个已有 target 的 BFD lib 和 opcode lib，修改成自己的 target。

下面是要编译 target=solrex-elf 需要修改的文件：

Key source files:
gdb
* gdb/config/solrex/tm-solrex.h: New file.
* gdb/solrex-tdep.h: New file.
* gdb/solrex-tdep.c: New file.
bfd
* include/elf/solrex.h: New file.
* bfd/cpu-solrex.c: New file.
* bfd/elf32-solrex.c: New file.
* bfd/archures.c: New arch.
* bfd/bfd-in2.h: New arch.
* bfd/targets.c: New target.
opcodes
* opcodes/solrex-dis.c: New file.
* include/dis-asm.h (print_insn_solrex): New function.
* opcodes/disassemble.c (ARCH_solrex): New arch.
Config files:
gdb
* gdb/config/solrex/solrex.mt: New file.
* gdb/Makefile.in (solrex-tdep*): New target.
* gdb/configure.host (solrex*, solrex*-*-elf*): New target.
* gdb/configure.tgt (solrex*, solrex*-*-elf*): New target.
bfd
* bfd/config.bfd: New target.
* bfd/configure.in: New target.
* bfd/Makefile.am: New target.
opcodes
* opcodes/configure.in (bfd_solrex_arch): New target.
* opcodes/Makefile.am (solrex-dis*): New target.
general
* configure.in (solrex*-*-elf*): New target.
* config.sub (solrex, solrex*-*): New target.
* readline/support/config.sub (solrex, solrex*-*): New target.
Auto Generated files:
* configure (solrex*-*-elf*): New.
* bfd/configure: New.
* bfd/Makefile.in: New.
* bfd/doc/bfd.info: New.
* opcodes/configure (bfd_solrex_arch): New.
* opcodes/Makefile.in (solrex-dis*): New.

上面列出的是想成功编译出 solrex-elf target 需要修改的最少的文件。至于如何修改 config 和 makefile 文件，只需要查看一下某个特定的 target，比如：mips，或者简单点的 xtensa，就知道该怎样改了。

在 bfd 和 opcodes 里的文件不是这篇文章中讲的重点，想 cheat GDB 最简单的办法就是把另外一个 target 的名字，比如：mips, xtensa 全部换成 solrex 就行了，使用另一种 target 的 binary file descriptor 会影响 GDB 的某些功能而不是全部。

本文遵从 GNU Free Documentation License (see http://www.gnu.org/copyleft/fdl.html )，并特别对 冒充另类(TeaWater) 的《移植GDB》一文表示感谢 (see http://teawater.spaces.live.com )。由于大体和细节的东西在《GDB Internal》和《移植 GDB》两文中已经有了很多描述，所以本文的目的在于 Howto，step by step 地描述如何为 GDB 添加新的目标机，并对某些以上两文中阐释不清的地方做出自己的解释。

2.对所需添加进 gdb 目录的文件的功能介绍

这部分和 《GDB Internal》中的 9.12 Adding a New Target 一部分是重合的，不过我添加一些实例和自己的介绍。

’gdb/config/solrex/solrex.mt’：这个文件里的东西会添加到 Makefile 里面，很简单，给个例子：

$ cat gdb/config/solrex/solrex.mt
TDEPFILES= solrex-tdep.o
DEPRECATED_TM_FILE= tm-solrex.h

第一个就是要编译 solrex 的 target 需要的文件，solrex-tdep.o 是下面要讲的 solrex-tdep.c 的目标文件，还可以加一个 TDEPLIBS= ，意思是需要的 lib。 DEPRECATED_TM_FILE= tm-solrex.h 的意思这种做法已经 deprecated 了，但是我们仍然可以使用，是 target 所需要的头文件，下面会讲到这个文件，但是这个文件如果没有的话可以不要。

’gdb/config/solrex/tm-solrex.h’：这个文件里可以定义一些通用的宏，给个例子：

$ cat gdb/config/solrex/tm-solrex.h
#define GDBINIT_FILENAME ".solrex-gdbinit"
#define DEFAULT_PROMPT "(gdb-solrex) "

第一个是 GDB 启动时候的默认读取文件名，第二个就是 GDB 的缺省 prompt。这个头文件会变成编译时候的 tm.h 文件，这些宏定义会覆盖 GDB 的本身设定，当然，如果你不需要这些宏完全可以不要此文件。

’gdb/solrex-tdep.h’ && ’gdb/solrex-tdep.c’：这两个文件是最重要的文件，也是 GDB 能够识别 solrex-elf 这个 target 的根据，这两个文件中定义了很多 solrex arch 特定的东西，比如：target 是 big-endian 还是 little-endian 的？target 的 registers map；target 的字长，register 的类型，返回值的存放，等等等等，这些后面的文章都会仔细介绍，也是主要介绍的部分。

最近好累，没完没了的调试，对GDB做了几遍 checking test，好多 fail 。只能 一个一个去找，却发现基本上是在给 compiler 做测试，基本都是因为 debugging information 的不完全还有 compiler 的优化。因为都是底层问题，只能 dump 出 来 assembly code 和 debugging information，一点一点的去找，看得我视力急剧下降。

工作是基本熟悉了，只是发现自己的很多问题又浮现出来。在保送研究生之前的大学生活大部是一段焦虑期，那种对未来的不可知和眼界的狭小让自己很惶恐。保完研，顺利找到实习以后基本上算进入了一个安静期，如果不算情感上波动的话。很欣欣自得于自己的状况，学业暂时无忧，经济暂时独立，工作也算理想，于是乎毫无念想去考虑其它。

现在应该是大四下学期了，前日系里开班会，我也没打听消息，无外乎是毕业论文和学期安排，大概还有毕业委员会的事情吧。这个世界离了谁都转，我这个小年级长在不在也没所谓。只是想到毕业论文，才觉得自己浪费的时间不少了。上个学期曾兴致冲冲地去找吴朝阳老师要求跟他作毕业论文，老师也给我指了两个方向。可惜的是，我把论文看得太轻了，只顾花费时间在一些别的事情上，告诉自己，还有时间，还有时间。

其实现在来说，我也不担心论文通不过的问题，本科论文也不会有太大意思。我是在怀疑自己有没有研究能力，独立思考的能力，到底适合不适合做科研。我丝毫不怀疑自己的行动力，但是我知道自己有很大缺点在意志力和创造力上。从小到大的人云亦云，从小到大的好学生，我对自己所学过的东西一片茫然，对自己要做的事情也无甚了解，我实在不知道自己选择学术这条路是对还是错。读研，我能读出来什么吗？

我不知道自己这种对能力的怀疑是暂时的还是永久的。不过我想这种情况也应该不只在我身上出现，地质大师许靖华在自己的自传中也写到在刚到美国开始自己的学术生涯时候也是不知所措，谁知道未来是怎样呢？我只是觉得自己对数学的兴趣不大，对计算机的兴趣也是一般，严格的来说，我没觉得什么学科对我来说有很大吸引力。高中的时候，倒是挺喜欢生物的，现在来说也了了了。一个对学术没有极大热情的人去从事它，会变得喜欢上吗？

其实说到了，可能还是功利心太强了，但是，这个世界允许我没有功利心吗？我没有那个条件去淡泊名利。

如何为 DejaGnu 添加新特性

DejaGnu 是一个非常好的开源的测试工具，尤其是做 GNU 开源工具链的软件开发，更离不开 DejaGnu 的支持，因为 binutils, gcc, gdb 自带的测试用例都是使用 DejaGnu 进行测试的。但是，DejaGnu 也有一些不足之处。因为它是开源的，我们可以修改它来满足我们的需求。

DejaGnu is a very good open-source testing framework, expecially in GNU development tool-chain developing. Because binutils, gcc, gdb use DejaGnu to test themselves. However, DejaGnu can not cover all aspects. Luckily it is open-sourced, so we can modify it to meet our demand.

我曾经想把下面代码提交到 DejaGnu，但是很遗憾，它的维护者似乎并不希望添加这些特性。所以我只好写在这里，希望能对某些人有所帮助。

I have tried to commit the fellowing code to DejaGnu, but unfortunately its maintainers did not want these features. So I write them down, in the hope that them will be useful.

1. DejaGnu 的官方介绍
1. Introduction From DejaGNU’s website

DejaGnu is a framework for testing other programs. Its purpose is to provide a single front end for all tests. Think of it as a custom library of Tcl procedures crafted to support writing a test harness. A test harness is the testing infrastructure that is created to support a specific program or tool. Each program can have multiple testsuites, all supported by a single test harness. DejaGnu is written in Expect, which in turn uses Tcl -- Tool command language.

2. 怎样给 runtest 命令添加新的选项
2. How to add new options to runtest command

runtest 有很多选项，可以通过 runtest --help 查看。下面是向 runtest 添加两个选项的代码，"--pr"是带优先权的测试，通过在 site.exp 或者 unix.exp 等其它设置文件中添加 pre_test_list 变量（list类型）来实现优先测试 pre_test_list 中的测试用例；"--sm"是 smoking test，意思是可以在抽一支烟的时间内测完的用例列表，也是通过在设置文件中添加 smoking_test_list 变量（list类型）来实现。

"runtest" command has many options, you can use command "runtest --help" to get more information. The following code adds two options to runtest. "--pr" is for test with priority on some testcases, via setting a list variable "pre_test_list" in configure files like site.exp and unix.exp. "--sm" is for smoking test, set a list variable "smoking_test_list" in the same place as --pr.

在 dejagnu/runtest.exp 中，添加下面的代码：
Adds the following code to dejagnu/runtest.exp:

/* 在最后一个 switch -glob -- $option 的 swith 体中，添加：*/
/* Find the last "switch -glob -- $option", adds the fellowing to it’s switch body:*/
# Options handler.
"--pr*" { # (--priority) run preferential tests first, then others
if {[info exists pre_test_list]} {
set SOLREX_testlist $pre_test_list
# Flag to control priority and smoking test.
# 0: run before whole test
# 1: run only listed test
set SOLREX_flag 0
verbose "Running preferential tests $SOLREX_testlist"
continue
} else {
warning "Variable pre_test_list is null. runtest as default."
continue
}
}

"--sm*" { # (--smoking) run smoking tests
if {[info exists smoking_test_list]} {
if { $smoking_test_list != ""} {
set SOLREX_testlist $smoking_test_list
set SOLREX_flag 1
verbose "Running smoking tests $SOLREX_testlist"
continue
} else {
warning "Variable smoking_test_list is null."
exit 0
}
} else {
warning "Variable smoking_test_list is not defined. "
exit 1
}
}

/* 在最后一个 set testlist 的循环语句后，添加下面代码： */
/* Find the last "set testlist " statement, jump out of the foreach loop, adds: */
# Exe code for --pr and --sm.
# If SOLREX_testlist is defined, run these *.exp files listed in it first.
# code in foreach loop bellow is copied from above.
if {[info exists SOLREX_testlist] } {
foreach x $SOLREX_testlist {
verbose "trying to glob ${srcdir}/${x}" 2
set s [glob -nocomplain ${srcdir}/$x]
if { $s != "" } {
lappend testlist $s
} else {
set f [exec find $srcdir -name "$x"]
set f [split $f "
"]
set f [lindex $f 0]
set s [glob -nocomplain ${srcdir}/$f]
if { $s!= "" } {
lappend testlist $s
}
}
}
if { $SOLREX_flag == 0 } {
foreach test_name $testlist {
if { ${ignoretests} != "" } {
if { 0 <= [lsearch ${ignoretests} [file tail ${test_name}]]} {
continue
}
}
set subdir [file dirname $test_name]
set p [expr {[string length $srcdir] - 1}]
while {0 < $p && [string index $srcdir $p] == "/"} {
incr p -1
}
if {[string range $subdir 0 $p] == $srcdir} {
set subdir [string range $subdir [expr {$p + 1}] end]
regsub "^/" $subdir "" subdir
}
set runtests [list [file tail $test_name] ""]
runtest $test_name
lappend ignoretests [file tail $test_name]
}
set testlist ""
}
}

/* 在 usage 函数中，添加下面两句：*/
/* Find "proc usage", adds following two lines in it: */
# Help information.
send_user " --priority (-pr) Run tests in ’pre_test_list’ first and orderly, defined in ’site.exp’
"
send_user " --smoking (-sm) Run tests in ’smoking_test_list’ only, defined in ’site.exp’
"

3. 怎样给 DejaGnu 添加新的开发板描述文件
3. How to Add Board Description File to DejaGnu

DejaGnu 在baseboards目录下内建了很多开发板描述文件，例如：arm-sim.exp, mips-sim.exp，可以在这个目录下新建或修改原有文件来为你的开发板配置一个正确的环境。

DejaGnu have many board description files in directory dejagnu/baseboards, i.e. arm-sim.exp, mips-sim.exp. You can add or modify file to get a right configuration for your board.

开发板描述文件示例：
Example board description file :

$cat dejagnu/baseboards/gdbserver-sample.exp
......ignored headers......
# gdbserver running over ssh.
/* 加载 tool-and-target-specific interface 配置文件，这个文件应该在当前测试环境的 config 目录下，可以在它里重写很多库函数。*/
/* Load tool-and-target-specific interface file, it should be in your testhome’s config dir. You can overwrite library functions in this file. */
load_generic_config "gdbserver"

/* 下面都是很明了的了，但是需要说明的一点是 board_info 并不是一个 struct, 可以自定义很多内容。比如 GDB 就定义了许多变量，例如：gdb_prompt, mathlib 等等。 你也可以为自己定义一些变量，只需要在这里 set_board_info xxxx yyyy, 当你要使用时，先测试它是否存在：[target_info exists xxxx]，然后取得它的值：set YYYY [target_info xxxx]。*/
/* The following is self-explained. But maybe you are glad to know that "board_info" is not a struct, you can define variables in it. For example, GDB defines many variables, i.e. gdb_prompt, mathlib. Of course you can define youself some variables for configuration use. Put "set_board_info xxxx yyyy" here first. When you want to use xxxx, you test if it exits: "[target_info exists xxxx]", then get xxxx’s value: "set YYYY [target_info xxxx]" */

process_multilib_options ""

# The default compiler for this target.
set_board_info compiler "[find_gcc]"

#set_board_info compiler "/opt/src/gcc/install-30/bin/gcc"
#set_board_info c++compiler "/opt/src/gcc/install-30/bin/g++"

set_board_info rsh_prog /usr/bin/ssh
set_board_info rcp_prog /usr/bin/scp
set_board_info protocol standard
set_board_info hostname voltaire.debian.org
set_board_info username dan
set_board_info gdb_server_prog /home/dan/gdb/mv/obj/gdb/gdbserver/gdbserver

# We will be using the standard GDB remote protocol
set_board_info gdb_protocol "remote"

# Path to the gdbserver executable, if required.
set_board_info gdb_server_prog "../gdbserver/gdbserver"

# Name of the computer whose socket will be used, if required.
set_board_info sockethost "voltaire:"

# Port ID to use for socket connection
# set_board_info gdb,socketport "4004"

# Use techniques appropriate to a stub
set_board_info use_gdb_stub 1

# This gdbserver can only run a process once per session.
set_board_info gdb,do_reload_on_run 1

# There’s no support for argument-passing (yet).
set_board_info noargs 1

# Can’t do input (or output) in the current gdbserver.
set_board_info gdb,noinferiorio 1

# Can’t do hardware watchpoints, in general
set_board_info gdb,no_hardware_watchpoints 1