Posts Tagged ‘cscope’

使用Cscope阅读大型工程Linux内核的源代码教程

Cscope是一个非常有用的工具,可以用来方便地阅读很大型工程的源代码。较之使用传统的Unix工具grep,使用Cscope可以省下你一大笔时间,大大提高阅读代码的效率。

 

通过本教程,我会教给你如何使用Cscope阅读Linux内核的源代码。毫无疑问,你可以举一反三,用同样的方法阅读其它的大型工程的源代码,不仅仅是C语言写的工程,也可以是Java或者C++或者C#开发的工程。

 

STEP 1 获得源代码:

去到Linux内核的网站http://www.kernel.org下载随便一个版本的Linux内核源代码压缩包。然后解压缩,把源代码释放到某个目录。本文假设你把源代码释放到 /home/code/linux-2.6.26。

 

STEP 2 选择一个目录存放Cscope所需要的数据库文件。

本文假设选择用/home/cscope目录存放cscope的数据库文件和其它一些相关文件。

 

STEP 3 生成文件 cscope.files

在最简单的情况下,工程目录下的所有源代码都是我要关心的,于是可以跳过下面所述,简单地在工程的根目录下运行'cscope -R'命令,这样Cscope就会在工程目录下所有源代码中处理相关工作。

但是你关心的代码并必工程目录下所有的代码,你还需要排除很多目录下的大量代码该如何做呢?在这种情况下,你需要生成一个文件cscope.files,这个文件包含 了所有cscope将要扫描的文件的文件名,每个名字占一行。最好使用绝对路径,这样你就可以在其它目录下,而不是现在创建cscope.files文件的目录下使用这个刚创建的数据库。下面的代码将完成这个任务(假设我要所有的java文件):

$ cd /   

$ find /my/project/dir -name "*.java" > /my/cscope/dir/cscope.files

对于Linux内核来讲,情况还要稍微复杂一点。因为我们还要排除好些文件夹,这些文件夹有存放文档的文件夹,存放脚本的文件夹,与处理器架构相关的汇编代码的目录夹,与处理器架构相关的C代码除了x86(大多数人已经仅仅对x86感兴趣),另外还会排除所有的驱动文件目录夹,因为驱动占了内核很大一部分,但驱动代码通常不是我们要关心的。如果不排除这些目录的话,cscope当然也能工作,但是却给我们增加了麻烦,因为大大增加了重复的定义出现的概率。下面看我怎么做:

 

    $ LNX=/home/linux-2.6.26

    $ cd /    

    $ find  $LNX                                                                \

    -path "$LNX/arch/*" ! -path "$LNX/arch/i386*" -prune -o               \

    -path "$LNX/include/asm-*" ! -path "$LNX/include/asm-i386*" -prune -o \

    -path "$LNX/tmp*" -prune -o                                           \

    -path "$LNX/Documentation*" -prune -o                                 \

    -path "$LNX/scripts*" -prune -o                                       \

    -path "$LNX/drivers*" -prune -o                                       \

    -name "*.[chxsS]" -print >/home/jru/cscope/cscope.files

如果对Unix常用工具find熟悉的话,看懂上面的这个复杂命令应该不是问题。但是我想有必要稍微说明一下。

比如 -path "$LNX/include/asm-*" ! -path "$LNX/include/asm-i386*" -prune -o \  表示排除 $LNX/include/asm-目录下的所有但是又不排该目录下的 asm-i386 目录。

-prune是排除的意思。那 -o 又是什么呢? -o表示逻辑或,如果逻辑或前面的表达式为真(即文件满足被排除的条件),根据or表达式的”短路语法“,-o后面的命令就不会再执行。如果文件名不满足-o前面的排除条件就会再应用-o后面的条件。我们可以看来后面用好几个 -o 把好几个排除条件连在一起。如果你不需要排除其它某些文件,就可以把相应的行去掉。题外话,古老的Unix工具链虽然看上去晦涩难懂,但是一但掌握却是可以受益终生。你想想那么多常用的Unix工具自从70年代发明后就一直广泛使用。已经快40年了!仍然在开源世界广泛使用,想想微软的技术,刚开完发布的新闻发布会,马上又宣布将废除使用了。这方面的思想可以参见《unix编程艺术》一书相关部分的阐述。

STEP 4 下面生成cscope的数据库文件。

$ cd /home/cscope    #上一步生成的 cscope.files放在这个目录夹下面.

$ cscope -b -q -k

-b 选项告诉cscope仅仅创建数据库文件,不要在之后启动cscope的介面。 -q选项使得生成数据库的时间增加,但是明显降低之后使用数据库文件时的搜索速度。对于大型工程建议使用这个选项,对于小工程则可不必。-k选项使得cscope不会去/usr/include中处理你的源代码中#include的文件。

STEP 5 

到此,就可以执行cscope了。如:

$ cscope -d

注意 -d 选项。加上这个选项则cscope不会在启动时重新检查所有有没有文件更新,有更新还会重建数据库,即使没有更新对于大型工程也要花费一些时间。如果有文件更改,你又想反映这个变化,那就不能加上-d选项。如果有新的文件加入,则需要从STEP 3重新开始,或者手动把增加的文件加入 escope.files,每个文件一行!如果你喜欢cscope,那么再参看man page,多多学习吧!

 

总结,Linux下的很多开发工具和成熟的GUI丰富的商业开发环境比较起来真的非常不方便呀。打字辛苦,转载请注明出处 blog.ykyi.net  !谢谢~

 

Be the first to comment - What do you think?  Posted by zausiu - June 12, 2012 at 19:45

Categories: Tech Articles, Unix / Linux   Tags: , ,