静态代码检查工具PC-Lint(一)

一 引言

二 PC-Lint介绍

三 PC-Lint的代码检查功能

以C语言为例，其中的编号1-199指的是一般编译器也会产生的语法错误；编号200-299是PC-Lint程序内部的错误，这类错误不会出现在代码中的；编号300-399指的是由于内存限制等导致的系统致命错误。编号400-999中出现的提示信息，是根据隐藏代码问题的可能性进行分类的：其中编号400-699指的是被检查代码中很可能存在问题而产生的告警信息；编号700-899中出现的信息，产生错误的可能性相比告警信息来说级别要低，但仍然可能是因为代码问题导致的问题。编号900-999是可选信息，他们不会被默认检查，除非你在选项中指定检查他们。
    PC-Lint/FelexLint提供了和许多编译器类似的告警级别设置选项-wLevel，它的告警级别分为以下几个级别，缺省告警级别为3级：
-w0 不产生信息（除了遇到致命的错误）
-w1 只生成错误信息 -- 没有告警信息和其它提示信息
-w2 只有错误和告警信息
-w3 生成错误、告警和其它提示信息（这是默认设置）
-w4 生成所有信息
PC-Lint/FelexLint还提供了用于处理函数库的头文件的告警级别设置选项-wlib(Level)，这个选项不会影响处理C/C++源代码模块的告警级别。它有和-wLevel相同的告警级别，缺省告警级别为3级：
-wlib(0) 不生成任何库信息
-wlib(1) 只生成错误信息（当处理库的源代码时）
-wlib(2) 生成错误和告警信息
-wlib(3) 生成错误、告警和其它信息（这是默认设置）
-wlib(4) 产生所有信息
    PC-Lint的检查分很多种类，有强类型检查、变量值跟踪、语义信息、赋值顺序检查、弱定义检查、格式检查、缩进检查、const变量检查和volatile变量检查等等。对每一种检查类型，PC-Lint都有很多详细的选项，用以控制PC-Lint的检查效果。PC-Lint的选项有300多种，这些选项可以放在注释中（以注释的形式插入代码中），例如：
/*lint option1 option2 ... optional commentary */     选项可以有多行
//lint option1 option2 ... optional commentary        选项仅为一行（适用于C++）
选项间要以空格分开，lint命令一定要小写，并且紧跟在/*或//后面，不能有空格。如果选项由类似于操作符和操作数的部分组成，例如-esym(534, printf, scanf, operator new)，其中最后一个选项是operator new，那么在operator和new中间只能有一个空格。PC-Lint的选项还可以放在宏定义中，当宏被展开时选项才生效。例如：
#define DIVZERO(x) /*lint -save -e54 */ ((x) /0) /*lint -restore */ 允许除数为0而不告警
    下面将分别介绍PC-Lint常用的，也是比较重要的代码检查类型，并举例介绍了各个检查类型下可能出现的告警信息以及常用选项的用法：

3.1 强类型检查

    强类型检查选项“-strong”和它的辅助（补充）选项“-index”可以对typedef定义的数据类型进行强类型检查，以保证只有相同类型之间的变量才能互相赋值，强类型检查选项strong的用法是：
-strong( flags[, name] ... )
strong选项必须在typedef定义类型之前打开，否则PC-Lint就不能识别typedef定义的数据类型，类型检查就会失效。flags参数可以是A、J、X、B、b、l和f，相应的解释和弱化字符在表 2 中列出：

    这些选项字符的顺序对功能没有影响。但是A和J选项的弱化字符必须紧跟在它们之后。B选项和b选项不能同时使用，f选项必须搭配B选项或b选项使用，如果不指定这些选项，-strong的作用就是仅仅声明type为强类型而不作任何检查。下面用一段代码演示-strong选项的用法：

//lint -strong(Ab,Bool) <选项是以注释的形式插入代码中>
typedef int Bool;
Bool gt(int a, b)
{
  if(a) return a > b; // OK
  else return 0; // Warning
}
例子代码中Bool被声明成强类型，如果没有指定b选项，第一个return语句中的比较操作就会被认为与函数类型不匹配。第二个return语句导致告警是因为0不是各Bool类型，如果添加c选项，例如-strong(Acb,Bool)，这个告警就会被抑制。再看一个例子：
/*lint -strong( AJXl, STRING ) */
typedef char *STRING;
STRING s;
...
s = malloc(20);
strcpy( s, "abc" );

由于malloc和strcpy是库函数，将malloc的返回值赋给强类型变量s或将强类型变量s传递给strcpy时会产生强类型冲突，不过l选项抑制了这个告警。
    强类型也可用于位域，出于强类型检查的目的，先假定位域中最长的一个字段是优势Boolean类型，如果没有优势Boolean或位域中没有哪个字段比其它字段长，这个类型从位域被切开的位置开始成为“散”类型，例如：
//lint -strong( AJXb, Bool )
//lint -strong( AJX, BitField )
typedef int Bool;
typedef unsigned BitField;
struct foo
{
unsigned a:1, b:2;
BitField c:1, d:2, e:3;
} x;
void f()
{
x.a = (Bool) 1; // OK
x.b = (Bool) 0; // strong type violation
x.a = 0; // strong type violation
x.b = 2; // OK
x.c = x.a; // OK
118
x.e = 1; // strong type violation
x.e = x.d; // OK
}

上面例子中，成员a和c是强类型Bool，成员d和e是BitField类型，b不是强类型。为了避免将只有一位的位域假设成Boolean类型，需要在声明Boolean的-strong中使用f选项，上面的例子就应该改成这样：-strong(AJXbf,Bool)。

    另一个强类型检查选项是index，index的用法是：
-index( flags, ixtype, sitype [, sitype] ... )
这个选项是对strong选项的补充，它可以和strong选项一起使用。这个选项指定ixtype是一个排除索引类型，它可以和Strongly Indexed类型sitype的数组（或指针）一起使用，ixtype和sitype被假设是使用typedef声明的类型名称。flags可以是c或d，c允许将ixtype和常量作为索引使用，而d允许在不使用ixtype的情况下指定数组的长度（Dimensions）。下面是一个使用index的例子：
//lint -strong( AzJX, Count, Temperature )
//lint -index( d, Count, Temperature )
// Only Count can index a Temperature
typedef float Temperature;
typedef int Count;
Temperature t[100]; // OK because of d flag
Temperature *pt = t; // pointers are also checked
// ... within a function
Count i;
t[0] = t[1]; // Warnings, no c flag
for( i = 0; i < 100; i++ )
t[i] = 0.0; // OK, i is a Count
119
pt[1] = 2.0; // Warning
i = pt - t; // OK, pt-t is a Count

上面的例子中，Temperature是被强索引类型，Count是强索引类型。如果没有使用d选项，数组的长度将被映射成固有的类型：
Temperature t[ (Count) 100 ];
但是，这是个小麻烦，像下面那样将数组长度定义成常量更好一些：
#define MAX_T (Count) 100
Temperature t[MAX_T];

这样做还有一个好处就是同样的MAX_T还可以用在for语句中，用于限制for语句的范围。需要注意的是，指向强被索引类型的指针（例如上面的pt）如果用在[]符号（数组符号）中也会被检查类型。其实，无论何时，只要将一个值加到一个指向强被索引类型的指针时，这个值就会被检查以确认它是一个强索引类型。此外，强被索引指针如果减去一个值，其结果被认为是平常的强索引，所以下面的例子就不会产生告警：
i = pt - t;

3.2 变量值跟踪

3.2.1 变量值初始化跟踪

    早期的变量值跟踪技术主要是对变量值的初始化进行跟踪，和变量初始化相关的LINT消息主要是644, 645 ("变量可能没有初始化"), 771, 772 ("不可靠的初始化"), 530 ("未初始化的"), and 1401 - 1403 ("成员 ... 未初始化")。以下面的代码为例：
if( a ) b = 6;
else c = b;    // 530 message
a = c;        // 645 message

假设b和c在之前都没有初始化，PC-Lint就会报告b没有初始化（在给c赋值的时候）和c可能没有被初始化（在给a赋值的时候）的消息。而while和for循环语句和上面的if语句稍微有所不同，比较下面的代码：
while ( n-- )
{
b = 6;
...
}
c = b;  //772 message

假设b在使用之前没有被初始化，这里会报告b可能没有初始化的消息（当给c赋值时）。之所以会有这样的区别，是因为程序设计者可能知道这样的循环体总是会被至少执行一次。相反，前面的if语句，对于程序设计者来说比较难以确定if语句是否总会被执行，因为如果是这样的话，这样的if语句就是多余的，应该被去掉。While语句和if比较相似，看下面的例子：
switch ( k )
{
case 1: b = 2; break;
case 2: b = 3;
/* Fall Through */
case 3: a = 4; break;
default: error();
}
c = b;   //645 message

尽管b在两个不同的地方被赋值，但是仍然存在b没有被初始化的可能。因此，当b赋值给c的时候，就会产生可能没有初始化的消息。为了解决这个问题，你可以在switch语句之前给b赋一个默认值。这样PC-Lint就不会产生告警消息，但是我们也失去了让PC-Lint检查后续的代码修改引起的变量初始化问题的机会。更好的方法是修改没有给b赋值的case语句。
    如果error()语句代表那些“不可能发生”的事情发生了，那么我们可以让PC-Lint知道这一段其实是不可能执行的，下面的代码表明了这一点：
switch ( k )
{
case 1: b = 2; break;
case 2:
case 3: b = 3; a = 4; break;
default: error();
/*lint -unreachable */
}
c = b;
注意：这里的-unreachable应该放在error()后面，break的前面。另外一个产生”没有初始化”告警的方式是传递一个指针给free（或者采用相似的方法）。比如：
if( n ) free( p );
...
p->value = 3;
在访问p的时候会产生p可能没有被初始化的消息。对于goto语句，前向的goto可能产生没有初始化消息，而向后的goto 会被忽略掉这种检查。
if ( a ) goto label;
b = 0;
label: c = b;
当在一个大的项目中使用未初始化变量检查时，可能会产生一些错误的报告。这种报告的产生，很大一部分来自于不好的程序设计风格，或者包括下面的结构：
if( x ) initialize y
...
if( x ) use y
当出现这种情况时，可以采用给y赋初始值的方式，或者利用选项-esym(644,y)关掉变量y上面的初始化检查。

3.2.2 变量值跟踪

    变量值跟踪技术从赋值语句、初始化和条件语句中收集信息，而函数的参数被默认为在正确的范围内，只有在从函数中可以收集到的信息与此不符的情况下才产生告警。与变量值跟踪相关的消息有：
(1) 访问地址越界消息（消息415，661，796）
(2) 被0除消息（54，414，795）
(3) NULL指针的错误使用（413，613，794）
(4) 非法指针的创建错误（416，662，797）
(5) 冗余的布尔值测试（774）

    看下面的例子：
int a[10];
int f()
{
int k;
k = 10;
return a[k]; // Warning 415
}
这个语句会产生警告415（通过 '[' 访问越界的指针），因为PC-Lint保存了赋给k的值，然后在使用k的时候进行了判断。如果我们把上面的例子稍加修改：
int a[10];
int f( int n )
{
int k;
if ( n ) k = 10;
else k = 0;
return a[k]; // Warning 661
}
这样就会产生告警 661 (可能访问越界指针)。 使用“可能”是因为不是所有的路径都会把10赋值给k。PC-Lint不仅收集赋值语句和初始化，还从条件语句中收集值的信息。比如下面的例子：
int a[10];
int f( int k, int n )
{
if ( k >= 10 ) a[0] = n;
return a[k]; // Warning 661 -- k could be 10
}
这里仍然产生661告警，因为PC-Lint检测到，在使用k的时候，k的值>=10。另外，对于函数来说，它总是假设K是正确的，程序使用者知道他们要做些什么，所以下面的语句不会产生告警：
int a[10];
int f( int k, int n )
{ return a[k+n]; } // no warning
和检查变量没有初始化一样，还可以检查变量的值是否正确。比如，如果下面例子中的循环一次都没有运行，k可能会超出范围。这时候会产生消息796 (可预见的地址访问越界).
int a[10];
int f(int n, int k)
{
int m = 2;
if( k >= 10 ) m++; // Hmm -- So k could be 10, eh?
while( n-- )
{ m++; k = 0; }
return a[k]; // Info 796 - - k could still be 10
}
下面的例子演示了可能使用NULL指针的问题：
int *f( int *p )
{
if ( p ) printf( "\n" ); // So -- p could be NULL
printf( "%d", *p ); // Warning
return p + 2; // Warning
}
这里会产生两个告警，因为可能使用了NULL指针，很明显，这两个语句应该在if语句的范围内。为了使你的程序更加健壮，你可能需要打开Pointer-parameter-may-be-NULL这个开关（+fpn）。这个选项假设所有传递到函数中的指针都有可能是NULL的。数组边界值在高位被检测，也就是说
int a[10]; ... a[10] = 0;
被检测了，而a[-1]却检测不到。PC-Lint中有两个消息是和指针的越界检查有关的，一个是越界指针的创建，另外一个是越界指针的访问，也就是通过越界指针获取值。在ANSI C([1]3.3.6)中，允许创建指向超过数组末尾一个单元的指针，比如：
int a[10];
f( a + 10 ); // OK
f( a + 11 ); // error
但是上面创建的两个指针，都是不能访问的，比如：
int a[10], *p, *q;
p = a + 10; // OK
*p = 0; // Warning (access error)
p[-1] = 0; // No Warning
q = p + 1; // Warning (creation error)
q[0] = 0; // Warning (access error)
布尔条件检查不象指针检查那么严格，但是它会对恒真的布尔条件产生告警，比如：
if ( n > 0 ) n = 0;
else if ( n <= 0 ) n = -1; // Info 774
上面的代码会产生告警（774），因为第二个条件检查是恒真的，可以忽略。这种冗余代码不会导致问题，但它的产生通常是因为逻辑错误或一种错误可能发生的征兆，需要详细的检查。

3.2.3 使用assert（断言）进行补救

    在某些情况下，虽然根据代码我们可以知道确切的值，但是PC-Lint却无法获取所有情况下变量的值的范围，这时候会产生一些错误的告警信息，我们可以使用assert语句增加变量取值范围信息的方法，来抑制这些错误的告警信息的产生。下面举例来说明：
char buf[4];
char *p;
strcpy( buf, "a" );
p = buf + strlen( buf ); // p is 'possibly' (buf+3)
p++; // p is 'possibly' (buf+4)
*p = 'a'; // Warning 661 - possible out-of-bounds reference
PC-Lint无法知道在所有情况下变量的值是多少。在上面的例子中，产生告警的语句其实并不会带来什么危害。我们可以直接使用
*p = 'a'; //lint !e661
来抑制告警。另外，我们还可以使用assert工具来修正这个问题：
#include <assert.h>
...
char buf[4];
char *p;
strcpy( buf, "a" );
p = buf + strlen( buf );
assert( p < buf + 3 ); // p is 'possibly' (buf+2)
p++; // p is 'possibly' (buf+3)
*p = 'a'; // no problem
由于assert在NDEBUG被定义时是一个空操作，所以要保证Lint进行的时候这个宏没有被定义。

    为了使assert()和你的编译器自带的assert.h一起产生上面的效果，你需要在编译选项文件中添加一个选项。例如，假设assert 是通过以下的编译器宏定义实现的：
#define assert(p) ((p) ? (void)0 : __A(...))
考虑到__A()会弹出一个消息并且不会返回，所以这个需要添加的选项就是：
-function( exit, __A )
这个选项将exit函数的一些非返回特征传递给__A函数。做为选择结果，编译器可能将assert实现成一个函数，例如：
#define assert(k) _Assert(k,...)
为了让PC-lint知道_Assert是一个assert函数，你需要使用-function( __assert, _Assert )选项或-function( __assert(1), _Assert(1) )选项复制__assert()函数的语义
许多编译器的编译选项文件中已经存在这些选项了，如果没有的话，你可以复制一个assert.h文件到PC-lint目录下（这个目录由于使用了-i选项，文件搜索的顺序优先于编译器的头文件目录）。

3.2.4 函数内变量跟踪

    PC-Lint的函数值跟踪功能会跟踪那些将要传递给函数（作为函数参数）变量值，当发生函数调用时，这些值被用来初始化函数参数。这种跟踪功能被用来测定返回值，记录额外的函数调用，当然还可以用来侦测错误。考察下面的例子代码：
t1.cpp:
1 int f(int);
2 int g()
3 { return f(0); }
4 int f( int n )
5 { return 10 / n; }
在这个例子中，f()被调用的时候使用0作为参数，这将导致原本没有问题的10/n语句产生被0除错误，使用命令lin -u t1.cpp可以得到以下输出：
--- Module: t1.cpp
During Specific Walk:
File t1.cpp line 3: f(0)
t1.cpp 5 Warning 414: Possible division by 0 [Reference:File t1.cpp: line 3]
你第一个注意到的事情是短语“During Specific Walk”，紧接着是函数调用发生的位置，函数名称以及参数，再下来就是错误信息。如果错误信息中缺少了错误再现时的错误行和用来标记错误位置的指示信息，这是因为检查到错误的时候代码（被调用函数的代码）已经走过了。如果像下面一样调换一下两个函数的位置：
t2.cpp:
1 int f( int n )
2 { return 10 / n; }
3 int g()
4 { return f(0); }
这种情况下就不会出现被0除的告警，因为此时f(0)在第四行，函数f()的代码已经过了，在这种情况下就需要引入multi-pass选项。如果在刚才的例子中使用lin -u -passes(2) t2.cpp命令，那么输出就变成：
--- Module: t2.cpp
/// Start of Pass 2 ///
--- Module: t2.cpp
During Specific Walk:
File t2.cpp line 4: f(0)
t2.cpp 2 Warning 414: Possible division by 0 [Reference:File t2.cpp: line 4]

使用-passes(2)选项将会检查代码两遍，一些操作系统不支持在命令行中使用-passes(2)，对于这样的系统，可以使用-passes=2 或 -passes[2]代替。通过冗长的信息可以看出来，以pass 2开始表示第一次检查没有产生告警信息。这一次得到的错误信息和前一次不同，在某种情况下我们可以推断出指定函数调用的返回值，至少可以得到一些返回值的属性。以下面的模块为例：
t3.cpp:
1 int f( int n )
2 { return n - 1; }
3 int g( int n )
4 { return n / f(1); }
使用命令 lin -u -passes(2) t3.cpp，可以得到以下输出信息：
--- Module: t3.cpp
/// Start of Pass 2 ///
--- Module: t3.cpp

{ return n / f(1); }
t3.cpp 4 Warning 414: Possible division by 0 [Reference:File t3.cpp: lines 2, 4]

第一遍检查我们知道调用函数f()传递的参数是1，第二遍检查先处理了函数f()，我们推断出这个参数将导致返回结果是0，当第二遍检查开始处理函数g()的时候，产生了被0除错误。应该注意到这个信息并不是在短语“During Specific Walk”之前出现的，这是因为错误是在对函数g()进行正常的处理过程中检测到的，此时并没有使用为函数g()的参数指定的值。指定的函数调用能够产生附加的函数调用，如果我们pass足够多的检测次数，这个过程可能会重复发生，参考下面的代码：
t4.cpp:
1 int f(int);
2 int g( int n )
3 { return f(2); }
4 int f( int n )
5 { return n / f(n - 1); }
第五行的分母f(n-1)并不会引起怀疑，直到我们意识到f(2)调用将导致f(1)调用，最终会调用f(0)，迫使最终的返回值是0。使用下面的命令行：
lin -u -passes(3) t4.cpp，
输出结果如下：
--- Module: t4.cpp
{ return f(2); }
t4.cpp 3 Info 715: Symbol 'n' (line 2) not referenced
/// Start of Pass 2 ///
--- Module: t4.cpp
/// Start of Pass 3 ///
--- Module: t4.cpp
During Specific Walk:
File t4.cpp line 3: f(2)
File t4.cpp line 5: f(1)
t4.cpp 5 Warning 414: Possible division by 0 [Reference:File t4.cpp: lines 3, 5]
到这里已经处理了三遍才检测到可能的被0除错误，想了解为什么需要处理三遍可以看看这个选项-specific_wlimit(n)。需要注意的是，指定的调用序列，f(2)，f(2)，是作为告警信息的序言出现的。

3.3 赋值顺序检查

    当一个表达式的值依赖于赋值的顺序的时候，会产生告警564。这是C/C++语言中非常普遍的一个问题，但是很少有编译器会分析这种情况。比如
n++ + n
这个语句是有歧义的，当左边的+操作先执行的话，它的值会比右边的先执行的值大一，更普遍的例子是这样的：
a[i] = i++;
f( i++, n + i );
第一个例子，看起来好像自加操作应该在数组索引计算以后执行，但是如果右边的赋值操作是在左边赋值操作之前执行的话，那么自加一操作就会在数组索引计算之前执行。虽然，赋值操作看起来应该指明一种操作顺序，但实际上是没有的。第二个例子是有歧义的，是因为函数的参数值的计算顺序也是没有保证的。能保证赋值顺序的操作符是布尔与（&&）或（||）和条件赋值（? :）以及逗号(,)，因此：
if( (n = f()) && n > 10 ) ...
这条语句是正确的，而：
if( (n = f()) & n > 10 ) ...
将产生一条告警。

3.4 弱定义检查

    这里的弱定义包含是以下内容：宏定义、typedef名字、声明、结构、联合和枚举类型。因为这些东西可能在模块中被过多定义且不被使用，PC-Lint有很多消息用来检查这些问题。PC-Lint的消息749-769 和1749-1769都是保留用来作为弱定义提示的。
 (1) 当一个文件#include的头文件中没有任何引用被该文件使用，PC-Lint会发出766告警。
 (2) 为了避免一个头文件变得过于大而臃肿，防止其中存在冗余的声明，当一个头文件中的对象声明没有被外部模块引用到时，PC-Lint会发出759告警。
 (3) 当变量或者函数只在模块内部使用的时候，PC-Lint会产生765告警，来提示该变量或者函数应该被声明为static。
    如果你想用PC-Lint检查以前没有检查过的代码，你可能更想将这些告警信息关闭，当然，如果你只想查看头文件的异常，可以试试这个命令：
lint -w1 +e749 +e?75? +e?76? ...