Lint 静态源码检查工具

baqiao

注：一直不知道原来还有工具来静态检查程序的正确与否，转载过来以备参考。

LINT工具是一种软件质量保证工具，许多国外的大型专业软件公司，如微软公司，都把它作为程序检查工具，在程序合入正试版本或交付测试之前一定要保证通过了LINT检查，他们要求软件工程师在使用LINT时要打开所有的编译开关，如果一定要关闭某些开关，那么要给出关闭这些开关的正当理由。
, `3 q1 O" \) f- v! G4 B$ A, S! E' k　　可想而知，如果从我们编码后第一次编译程序时就使用LINT来检查程序，并且保证消除所有的LINT告警，我们就不会遇到象今天这么多的告警信息。即使在今天，我们如果能抽出一定的精力来消除程序中的LINT告警，以后再维持这种无告警状态就是很容易的了。我们程序质量的提高也是不言而喻的。
+ ~+ M; D4 v2 C2 k9 }1 m　　PC-LINT是GIMPEL SOFTWARE公司的产品，其中的内容是非常广泛的，光是选项就有300多个，涉及到程序编译及语法使用中的方方面面。本篇培训材料旨在引导读者入门，学会PC-LINT的基本使用方法，起抛砖引玉的作用，能让读者从这里起步继续去研究如何娴熟地使用PC-LINT的各种选项，能让它充分为我们的开发工作服务。
$ o3 F0 }- z. ^+ a" c2 [1.概述
　　如果要给LINT工具下一个形象点的定义，那就是：一种更加严格的编译器。它不仅可以象普通编译器那样检查出一般的语法错误，还可以检查出那些虽然完全合乎语法要求，但很可能是潜在的、不易发现的错误。请看下面的例子：
) S/ D! ^% r( I$ _$ d; R1：
/ F8 o- }# p9 W2：char *report( int m, int n, char *p )
; c9 B, z6 f3 `3：{
4： int result;
5： char *temp;
1 ?. W* Y% j5 h) y: }. d4 |4 c6： long nm;
3 X& I, |* Y; ?" U7 ^, t. O7： int i, k, kk;
  c: s( R. b& u3 F0 J3 J7 t/ H8： char name[11] = "Joe Jakeson";
9：
5 E. @) _  |4 o$ I7 j10： nm = n * m;
( H/ u5 R! U: |; Z1 t& O  t: \11： temp = p == "" ? "null" : p;
% Z: D* d, {3 B% ?4 b" R9 T  U12： for( i = 0; i 13： {
5 y( U* U8 A3 H8 _14： k++;
15： kk = i;
16： }
/ ?' k# @$ E: U; ^6 J6 y7 x17：
/ i& d# W  O6 |, q+ y) D) _+ H* K18： if( k== 1 ) result = nm;
% e* N1 V+ V% I19： else if( kk > 0 ) result = 1;
20： else if( kk < 0 ) result = -1;
; h( p% T, |  ^+ Q; {  R21：
/ ?2 o0 k7 N8 T0 x  Z22： if( m == result ) return( temp );
6 ~9 Z4 B9 F# w3 [$ b) L* {/ H23： else return( name );
24：}
) O' S+ K; `: t6 @6 l　　上面的代码用一般的编译器编译是一段有效的代码，但是用PC-LINT编译就会有几个告警。首先第8行向name数组赋值时丢掉了nul字符，第10行的乘法精度会失准，第11行的比较有问题，第14行的变量k没有初始化，第15行的kk可能没有被初始化，第22行的result也有可能没有被初始化，第23行返回的是一个局部对象的地址。这段代码在大部分编译器下是可以顺利编译通过的，继续查找其中的错误就要靠人工调试程序，如果程序很大，这将是一项烦琐的工作，没有人可以保证能找出所有的这类问题，但PC-LINT只通过一次简单的编译就可做到，显然为我们节省了大量的开发时间。
　　下面就让我们看看如何安装使用PC-LINT。
2.如何安装PC-LINT
　　PC-LINT的软件的安装过程比较复杂，选项较多，下面根据安装过程，逐条说明每一步的含义。
8 W; L7 c8 Q: ^5 Q7 a& U0）如果是zip文件，将ZIP安装文件展开到目录C:\lint.ins下，进入COMMAND PROMPT，先进行目录映射 subst g: c:\lint.ins，然后转到G: , 执行install。其他步骤和下面的从软盘安装是一样的。
1）在A:驱插入PC-LINT安装盘，输入A:\>install命令，进入开始安装栏，按任意键继续，进入PC-LINT介绍栏，再按任意键继续。
2 X  N( y) U4 Z$ S6 v- d* N2）进入环境选择栏，这一栏中有三个选项：
Windows NT/Windows 95
MS-DOS（DOS extended）
OS/2（32bit）
如果计算机安装了WIN95、WIN97、WIN98或WINNT要选择Windows NT/Windows 95，如果
% V- w4 B  w8 g) X; a只有DOS则选择DOS。
3）进入安装目录选择栏，它推荐的是C:\>LINT，如不想安装在这个目录下，可输入自己想要安装的目录，然后按回车确认，如果要安装的目录不存在，它会提示为你建立这个目录。我们这里选C:\>LINT
; [$ t# A2 @( H4）选择安装盘所在的磁盘驱动器，我们这里选A:
5）判断是否要选择多种编译器或编译库的配置，如果要对不同编译环境下的程序进行L
INT，则选YES，否则选NO。然后回车确认。
# U* R8 [6 x  n; O/ ]6）这时看到一个编译器列表，在这个表中选择自己使用的编译器，如果表中没有自己使用的编译器，可选择通用编译器：Generic Compilers。按回车确认。这个选项会体现在co-xxx.lnt文件中。
4 q6 c! g; k! g5 K7）接着安装程序会让你选择一个的内存模型，可以根据自己程序区和数据区的实际大小选择一个恰当的内存模型。如果CPU为32位68K系列，则要选择：32-bit Flat Module。
内存模型的选项会体现在STD.LNT文件中。
8）选完内存模型后，会看到一个库类型的列表，在这里选择一个或多个编译时使用的库。这个选项会体现在LIB-xxx.LNT文件中。
$ I- @5 O6 D' F. ?' s3 ~9）接着是让你选择为使用C++编程提出过重要建议的作者，选择的某作者后，他提出的编程建议方面的选项将被打开。与作者选择有关的选项会体现在AU-xxx.LNT文件中。
  Z9 `3 y/ w& i10）下一步是设置包含文件目录。有两种选项，第一种是使用环境变量INCLUDE，环境变量在批处理文件中设置，环境变量后每个目录用分号隔开，例如可设成“INCLUDE=C:\MRI\MCC68K;D:\LAP\SRC\INC”。第二种选项是使用-i选项，-i选项体现在STD.LNT文件中，每个目录前以-I引导，目录间以空格分隔，例如可设成“-IC:\MRI\MCC68K -ID:\LAP\SRC\INC”。如果选择使用-I选项，安装程序会接着让你输入包含文件所在的目录。
% j8 `% e# U  ?11） 如果前面选择了使用多个编译环境，这里将会问你是否选择更多的编译环境，如果选YES，将会从第6步开使重复。如果选NO则会结束编译器选择。
12）接下来将会准备产生一个 反映全局编译信息显示情况的选项文件OPTIONS.LNT，该文件的产生方式有两种，一种是安装程序对几个核心选项逐一解释并提问你是否取消该选项，如果你选择取消，则会体现在OPTIONS.LNT文件中，具体体现方式是在该类信息编码前加-e，后面第13~18步是逐一选择核心选项的过程。如果选择第二种选择方式，安装文件会先生成一个空的OPTIONS.LNT文件，等你以后在实际应用时加入必要的选项。
+ B* X- {7 Q2 l7 M13）是否关闭赋值时的布尔测试告警，如：if(a=f()){...
14）是否关闭赋值时的有符号量和无符号量间的不匹配告警，通常情况下，这种赋值不会带来问题，选择关闭该告警信息的同时，其他类型的有符号量和无符号量间混合操作的告警仍然是打开的。
15）当把一个整形量赋值给一个比它短的量时，后者会丢失精度，例如把一个INT量赋值给给一个CHAR量。本步是让你选择是否关闭该类告警。
; ], C6 |3 w7 b5 A2 x; b+ i16）是否关闭左移带符号量的告警。通常PC-LINT会对所有带符号量的移动产生告警，但右移一般是由不同的CPU来确定是否将符号位移入，左移一般是不会产生什么问题的，所以可以选择关闭该告警。
17）在一个C函数被定义或声明前调用它，并不总是会产生错误，在这里可以选择是否关闭该告警选项。该选项对C++程序不起作用。
  f5 B6 p, Y, D* _+ k18）是否关闭“调用不存在的函数原型”告警。有些程序员不愿遵守严格的函数原形定义约定，但PC-LINT会在调用一个没有定义的函数原型时产生一个告警，在这里可以选择关闭该告警。
" [) q; [- j3 _: n0 O1 n. F: d19）通过上面的步骤确定OPTIONS.LNT文件的形式后，接着是选择编译环境。PC-LINT提供了集成在多种开发环境中工作的功能，例如可集成在VC、BC、Source Insight中。假如我们在这里选择Source Insight。选择后安装程序会继续问你是否还选择其它的环境，可根据自己应用的实际情况选择一种或多种开发环境。开发环境的选择情况记录在env-xxx.lnt文件中。
20）安装程序会生成一个LIN.BAT文件，该文件是运行PC-LINT的批处理文件，为了使该文件能在任何路径下运行，安装程序提供了两种方法供你选择。第一种方法是让你选择把LIN.BAT拷贝到任何一个PATH目录下，在安装结束运行LCOPY.BAT文件时，会把LIN.BAT拷贝到你指定的目录。第二种方法是生成一个LSET.BAT文件，在每次使用PC-LINT前先运行它来设置路径，或者把LSET.BAT文件的内容拷贝到AUTOEXEC.BAT文件中。
+ I" N3 P4 u% y, o7 J. w. n21）在安装程序执行完后第一件事是在你安装的目录下执行LCOPY.BAT文件。它会从安装盘拷贝将一些文件拷贝到安装目录下，并根据你在安装过程中的选择来设置文件中的参数。
0 h& N& m' a; Z4 I- C3.LINT 一个C文件
3.1用命令行方式进行LINT
如果使用LIN.BAT批处理文件进行LINT，在LINT前要先看一下该批处理文件中的内容，里面包含了LINT-NT命令和命令选项，可以根据自己的要求来修改、增减选项。我们看到，在这个批命令中嵌套了一个std.lnt文件，在std.lnt文件中还嵌套了co.lnt、options.lnt和lib-stl.lnt文件，原则上*.lnt文件是可以无限制嵌套，该类文件中一般都是了LINT的选项，可通过修改这些文件来修改LINT选项，选项是按照从左到右的顺序执行的。可执行下面命令行：
. k) N) l, h* L1 k; I: R& @2 MC:\abc\src>lin alpha.c beta.c gamma.c
; E8 X* I" W/ p& o5 h7 u通常对于由多个C模块组成的程序，最好先分别对每个C模块单元进行LINT检查，做单元LINT时可如下运行：
7 I& l! L( ?( J5 `9 o7 g# X! nC:\abs\src>lin -u alpha.c
其中-u是单元选项，使用-u后可以关闭一些检查多模块时会产生的告警，例如“函数未被使用”或“函数没有定义”等。
也可以不使用LIN.BAT批处理文件，而直接使用LINT命令。在DOS环境下LINT命令为LINT.EXE，在Windows95/NT环境下为LINT-NT.EXE，在OS2环境下为LINT-OS2.EXE。直接使用LINT命令要注意的一点是要在使用前预先设置LINT目录所在路径，最好的方法是把该路径加在AUTOEXEC.BAT文件中。其它的使用方法与使用批处理文件相同。例如：
C:\abs\src>lint-nt -ic:\lint\ std.lnt -os(_lint.tmp) *.c
3.2用开发环境进行LINT
也可以使用开发环境来执行LINT操作，一般开发环境都支持运行可执行文件，但不一定支持运行批处理文件，下面用Source Insight , Ultra Edit, MSVC 6.0 来举例说明如何在开发环境下进行LINT。
( U3 Y9 ^  ^9 b' ]3.2.1 在Source Insight中集成
如果你在安装过程中选定了使用某个开发环境，安装程序会在你安装的目录下生成一个env-xxx.lnt的文件，例如选择了Source Insight就会有一个env-si.lnt文件。用编辑器打开该文件，在该文件开始的注释中说明了如何将PC-LINT功能集成在开发环境中，集成在Source Insight中的过程如下：
1）从Options菜单中选择“Custom Commands”命令项。
! p* K. N: D8 ^4 O2）在Name栏中输入“PC-lint ”，原则上这个名称可以随便起，只要你能搞清楚它的含义就可以了。
/ ]7 F, A& _- R9 c  w0 L8 j  B# v2 n3）在Run栏中输入“c:\lint\lint-nt -u -ic:\lint std env-si %f”其中c:\lint是你PC-LINT的安装目录。
3 d% T: {# V9 @9 R6 ?3 {1 V4）在Output栏中选择“Iconic Window”、“Capture Output”。
5）在Control栏中选择“Save Files First”。
5 o' n% ]& n; w# j6）在Source Links in Output栏中选择“Parse Links in Output”、“File，then Line”。
7）在Pattern栏中输入“^\([^ ]*\) \([0-9]+\)”。
8）点Add键加入该命令。如下图：
9）使用时，在Source Insight下打开要LINT的文件，打开Options菜单中的“Custom Commands”命令项，在“Command”栏中选择“PC-lint unit check”命令运行即可。
注意到我的Run一栏的参数和上面的提示不一样，其实我的其他古怪参数都放到c:\lint\std.lnt中了。请注意，不论你怎样配置参数一定不要忘记了将si-env.lnt包含在你的配置文件里，否则就无法进行错误信息和程序的自动对应了。
0 `# o4 w, [- M. @4 |为了使用方便，你还可以配置一下Menu按钮，将它加到系统菜0单里，这属于一般性的
Source Insight应用，笔者就不在此赘述了。
2 h5 @9 R$ K( r* Z第二笔者在NT中使用Source Insight时，好象集成不了，原因暂时不明了。上面的例子在WIN 95下测试成功。
如果要修改LINT选项，可直接在Run栏中修改，也可专门编辑一个*.lnt文件放在c:\lint目录下，并将该文件名加入Run栏中，和命令行方式是一样的。
3.2.2在Ultra Editor中集成
* p3 i/ M, g( I5 ?2 t选取 Menu | Advanced | Tool Configuration ... ， 显示如下图：
1）点按“Insert",
5 K  ~% Q, E# I+ P4 C7 v2）在command line:中填写：c:\lint\lint-nt c:\lint\std.lnt %f
, U" o5 S6 H' H" V6 c: ?3）在Menu Item中填写：PC-LINT
4）在Command Output中选择： (x) Output to List Box 和 (x) Capture Output
5）点按"OK"
如图所示的配置笔者在UE6.0 / NT 4.0 下测试成功。
: K+ i( j( r( e3.2.3 在MSVC 6.0中集成
# ^% @, s* b& Z1 U基本原理是一样的：
1）选取 menu | tools | customize.....
4 b0 B/ u' t) v, ~1 M/ H+ J2 d2）选取 Tools Tab:
3）点按主对话框上方的虚线小方框 New a tool item
$ B* I& X# p$ b  D$ b4）输入 name: PC-LINT
5）输入 Command: c:\lint\lint-nt.exe
0 x8 K9 {- B* m1 X, ~  s6）输入 Arguments: c:\lint\std.lnt $(FilePath)
7) 选择 (x) Use Output Window
8）Close
9 \  p- h9 |% Q. g3 C( T- j完成后，在tools菜单下就会有一项PC-LINT选项。
0 m* e4 M& m: ]. t& j下面是笔者在VC6 / Win NT 4.0 的情况下的TOOL配置图：
4 a2 V, u1 w9 ^- {3.3LINT选项
. H! Y( ]: i: _LINT选项可以放在注释中，例如：
/*lint option1 option2 ... optional commentary */
6 I6 s& u3 L9 ?7 G//lint option1 option2 ... optional commentary
9 _  d7 Y- s6 D6 H; E选项间要以空格分开，lint命令一定要小写，并且紧跟在/*或//后面，不能有空格。如果选项由类似于操作符和操作数的部分组成，例如-esym(534, printf, scanf, operat　or new)，其中最后一个选项是operator new，那么在operator和new中间只能有一个空
格。
- p, \# t) l, s1 B8 x选项还可以放在宏定义中，例如：
0 \4 i6 @: Y; }$ x7 M' }#define DIVZERO(x) /*lint -save -e54 */ ((x) /o) /*lint -restore */
# V+ c3 J# V+ N1 W* l4 Z' e+ X3 V: KLINT的选项很多共有300多种，大体可分为以下几类：
1）错误信息禁止选项
该类选项是用于禁止生成某类错误信息的选项，最常用的是-e和+e，-e是禁止生成某类错误信息，+e是恢复生成某类错误信息。运行lint目录下的msg.exe可以得到msg.txt文件，这个长达5000行的文件包含了所有的错误信息号和解释。
2 |, C& i" L8 t" t' e* k, d( [-w 对于所有大于级别的告警信息都不显示。
-wlib()对于所有大于级别的关于库函数数的告警信息都不显示。我们可以用-wlib(0)来屏蔽所有的库函数的告警信息，-wlib(1)只显示库函数中的句法错误。
-esym(#,) 可以屏蔽对于特定符号的某告警信息。
2）变量类型大小选项
# M4 R) G. g0 D$ \4 _2 D不同的目标机、编译系统变量类型的的大小（如短整形变量、整形变量等）会有所不同，该类选项用于为目标机设置变量类型的大小。由于默认的设置与大部分的编译器是匹配的，这些专门的设置通常情况下是不需要的，只在特别的目标机结构中才用。例如一个M68000目标机，它的int类型和指针类型通常是32bit的，这时你应该使用选项：-si4
-sp4。这些尺寸参数的当前值可以通过help屏来获得，例如可以输入以下命令行：
9 [+ R6 A9 H1 d0 f- c$ M( Rlin -si4 -sp4 ？
; t) n/ l0 b4 A9 l1 n2 u3）冗长信息选项
冗长信息指的是LINT过程中产生的一些与编译过程有关的信息，而不是真正的告警信息、错误信息等。是否生成这些信息可以通过-v和+v选项来决定。+v是生成这些信息，-v是关闭这些信息，这组选项中除+v外，其它所有选项都可以关闭+v选项。
9 B' V( d6 r- T6 Q9 q1 n4）标记选项
以+f、++f、-f和--f开头的选项是标记选项。他们的逻辑含义分别如下：
+f...：通过把标志置为1而把它置为ON
-f...：通过把标志置为0而把它置为OFF
; t+ z) U0 `& [& ]) |++f...：标志增1
--f...：标志减1
7 x+ X' [3 y7 t8 s后面两个用于你想在局部把一个标志置为ON的情况，而不影响全局设置。例如你可以这样使用：
/*lint ++flb */
int printf( );
+ `) r9 ^" f- L- Y6 l/*lint --flb */
标记选项的种类很多，基本含义是用于打开或关闭某类语法情况使用，例如允许使用缩写结构体名称，允许使用无名联合体，把所有模块当作C++编译等。
5）消息显示选项
" X+ C3 E9 Z4 c7 Y' b0 j消息显示选项用于定义消息输出格式。主要有消息高度选项、消息宽度选项、消息格式选项等。
6）其它选项
其它选项中的种类很多，各种类间差异很大，在这里就不一一介绍了，建议大家看一看《PC-LINT》一书，第五章有对每种选项的详细说明。lint本身也有一些说明信息， lint-nt 2> lint.txt 然后狂按几个回车就可以生成一个lint选项的说明文件。
4.LINT一个工程下的多个C文件
1 x4 A  X/ {- b' ]4.1为何要LINT多个C文件
在程序编码初期，我们关心的可能只是单个C模块种中的语法问题，等到编程后期，对于由多个C模块组成的程序，我们希望了解当把多个模块连接在一起后是否还有存在于模块间的语法问题。这时编译器虽然能给出一些告警，但PC-LINT的连接能给出更多的告警。还有当我们能保证其中的几个模块相对稳定，而另外几个模块仍有问题时可以先将几个稳定的模块编译连接成一个目标文件，文件每次修改完成后先单独编译，然后连接入总的目标文件。
4.2如何LINT一个工程下的多个C文件
; D/ n: o, ?0 I% t6 ^象我们平时使用的编译工具一样，PC-LINT在编译连接多个C文件时也会先把每个C文件编译生成中间的目标文件*.lob，然后再将所有的LOB文件连接在一起。LOB是Lint Object Module的缩写。这个文件中包含了一个C或C++模块的所有外部信息。生成LOB文件时有三种选项要注意：第一种是-u，如果要LINT生成LOB文件，就一定要加-u选项；第二种是-zero或-zero(500)选项，为了保证LOB文件在模块存在错误的情况下也能生成，就一定要加这个选项；第三种是-oo[(filename)]，filename是生成的LOB文件的名称，在-oo后面，可加，也可不加，如不加，则LOB文件名与原C模块的名称相同，例如：
lint -u alpha.c -oo(a1)
! e9 [* y( G9 R, r+ d生成的LOB文件名为：a1.lob
lint -u alpha.c -oo
. N2 [% x/ T( y" i$ M5 j; H2 E生成的LOB文件名为：alpha.lob
LINT一个工程下的多个C模块，在用户的源程序目录下一般需要三个文件： 一个选项文件（*.lnt）、一个批处理文件（*.bat）和一个MAKEFILE文件（*.mak）。下面一一讲述如何制作这些文件。
) h' t5 b" D$ I, w: y3 p- j1）选项文件（*.lnt）
5 H9 t1 @$ L' m+ D选项文件在前面也提到过，你可以把你LINT每个C文件时时用到的所有公共选项罗列在该文件中，选项生效的顺序按照从左到右，从上到下的原则。该类文件可以层层嵌套，嵌套的层数没有限制。例如make.lnt文件：
( E! `# F- w3 S, `- n; H: Y-iC:\lint
std.lnt
+os(temp)
-e46
1 M0 e- x( c- m+vm
-zero
2）批处理文件（*.bat）
, D, o( d1 c, L, V5 b$ g, o( V制作批处理文件时要注意要在该文件中调用TCMAKE.EXE文件和MAKEFILE文件，例如lintmake.mak文件：
@Echo Lint Making ‘makelap‘:
tcmake -flintmake.mak
@echo End of making
3）MAKEFILE文件（*.mak）
( O; m7 @4 t# |: J: N% b! j0 @MAKEFILE使用的TCMAKE的语法，和我们平时开发编译时使用的MAKEFILE文件语法格式一样，例如下面的lintmake.mak文件：
MCCPATH = c:\mcc68k
OPTION = -u make.lnt -oo
GLOBLE = os.h l2lap.h
mail_depend = $(GLOBLE) q931.h mail.h
8 h0 K: m- e3 y+ Hlapmain_depend = $(GLOBLE) l1pubdef.h q931.h mail.h
lapos_depend = $(GLOBLE)
fhdlc1_depend = $(GLOBLE) cpuhdlc.h bd_prar.h q931.h
OBJ = mail.lob lapmain.lob lapos.lob fhdlc1.lob
project.lob : $(OBJ)
4 k2 T) u7 f% z' R- ilint-nt make.lnt -e768 -e769 *.lob
mail.lob: mail.c $(mail_depend)
lint-nt $(OPTION) mail.c
lapmain.lob: lapmain.c $(lapmain_depend)
lint-nt $(OPTION) lapmain.c
* t# u' _7 {( L. p9 \) A2 ^* nlapos.lob: lapos.c $(lapos_depend)
( m) W9 Y' ^5 p) N7 e; _* Plint-nt $(OPTION) lapos.c
fhdlc1.lob: fhdlc1.c $(fhdlc1_depend)
lint-nt $(OPTION) fhdlc1.c
4.3简单的LINT多个文件
# L7 N& k, H6 w假设我们的工程不复杂，我们可以负担起每次都将所有的文件都lint一遍的开销，也可以不使用上面的正规用法。笔者在实践中发现，将所有的*.c文件放在一个lint命令中，同样能完成lint整个工程的目的。
如：
# G( H6 u6 g: C- U: \7 blint-nt c:\lint\std.lnt AllMySource.lnt
在AllMySource.lnt中包括你的工程中的所有源文件：
a1.c
a2.c
& s  r. S' k: Ea3.c
' w  n. Y0 [  F9 d+ W3 @需要注意的是，在std.lnt文件中就不需要-u选项了。

5 \3 o! U* F  J- Z% I1 R- I

NingW

Lint 静态源码检查工具