为bash添加内置命令(built-in)的方法

2008-02-10

在bash命令行工作中,为常用的操作编写一个脚本或外部命令是很容易的。事实上自己添加一条内置命令(built-in)也并不难。内置命令比脚本和外部命令的执行效率更高,还可以访问脚本和外部命令无法深入的bash内部,只是可移植性下降了。

GNU bash的源代码结构较为清晰。源代码目录(记为$(srcdir))下的builtins目录存储的是各个内置命令的源代码预定义文件(*.def)。在make的过程中,由mkbuiltins工具将它们预编译为源程序(*.c),进而编译为目标文件(*.o)。mkbuiltins工具是由同一目录下的mkbuiltins.c编译生成的,它在处理*.def文件的同时,还会生成builtins.cbuiltext.h两个文件,用做bash主程序调用内置命令的接口以及各个内置命令的索引。

要添加一条新内置命令,只需参考原有命令的存在形式即可,步骤如下:

1、新建预定义文件:$(srcdir)/builtins/[命令名].def。可复制已有命令的预定义文件,修改其中的$PRODUCES$BUILTIN$FUNCTION$SHORT_DOC等定义,使之与命令名相符。

2、在预定义文件中建立命令处理函数,原型参考已有命令的处理函数,函数名与$FUNCTION的定义一致。参数为WORD_LIST *list,该结构的定义在$(srcdir)/command.h中。处理参数的具体方法同样可参考已有的命令(如echo)的处理函数。

3、修改$(srcdir)/builtins/Makefile.in,参照已有的命令,分别在DEFSRCOFILES添加对[命令名].def[命令名].o的定义;添加[命令名].o[命令名].def以及其它头文件的依赖关系。

4、回到$(srcdir)下,对源代码进行configure、make,如果一切顺利的话,此时生成的bash程序将包含新添加的内置命令。

(在GNU bash 3.2下试验通过)

本例中添加的命令处理函数为:

int linjian_builtin (list)
    WORD_LIST *list;
{
  printf ("This is a built-in for test by Lin Jian.\n");
  if (list)
    printf("Parameter: %s\n", list->word->word);
  return (EXECUTION_SUCCESS);
}

编译后试验结果如下:

lj@lj-laptop:~/bash-3.2$ ./bash
lj@lj-laptop:~/bash-3.2$ ps
  PID TTY          TIME CMD
6212 pts/2    00:00:00 bash
9904 pts/2    00:00:00 bash
9922 pts/2    00:00:00 ps
lj@lj-laptop:~/bash-3.2$ linjian hello!
This is a built-in for test by Lin Jian.
Parameter: hello!
lj@lj-laptop:~/bash-3.2$ type linjian
linjian is a shell builtin