代码走查工具-PCLint.ppt

代码走查工具PCLint,目录,PC-Lint简介PC-Lint基本使用方法PC-Lint常用选项PC-Lint在各种环境中的集成PC-Lint常见告警分析及解决措施,PC-Lint简介,PC-Lint是GimpelSoftware公司开发的一个一个C/C+静态语法检查工具，它不是一个Free软件。一般来说，软件在编译连接通过后就可以使用PC-Lint做静态检查。PC-Lint是一个命令行工具，在8.0版本里提供了300多个选项，1000多个告警。本篇培训材料旨在引导读者入门，学会PC-LINT的基本使用方法，一些常见选项的使用，常见告警的分析及规避措施，希望可以起抛砖引玉的作用，为读者深入掌握PC-Lint的使用打下基础。本篇材料主要是以PC-Lint8.0在Windows上的使用为基础来做的。,PC-Lint基本使用方法,PC-Lint8.0主要由以下一些文件组成：Lint-nt.exeWindows下的执行文件Msg.txt全部选项帮助说明文件PC-Lint.pdfPC-Lint的帮助文件Config.exe配置程序Std.lnt标准配置文件Options.lnt选项配置文件.Lnt子目录下的各种开发编译环境的配置文件其他一些文件,PC-Lint基本使用方法,PC-Lint是一个命令行工具，因此使用方式是命令行带参数方式使用。一般的使用格式为：lint-nt.exeOptionfile1file2如：lint-nt.exe-u-id:lintstd.lntsample.c在这里-u表示只对本单元进行检查-id:lint是表示会在d:lint目录下搜索文件std.lnt是表示要使用的配置文件sample.c表示要检查的源文件,PC-Lint基本使用方法,检查一个目录下的所有源文件可以使用以下方法：如：lint-nt.exe-u-id:lintstd.lntd:ospvos*.cpp跟前面不同的是这里将sample.c变成了d:ospvos*.cpp，使用*.cpp的意思是它会检查d:ospvos目录下的所有.cpp文件，但是它不能检查子目录下的文件,PC-Lint基本使用方法,要检查所有包括子目录的文件可以使用以下方法：lint-nt-id:lintstd.lntAllSource.lnt在AllSource.lnt文件中可以放置如下：Moudule1-Dir*.cppMoudule2-Dir*.cppMoudule3-Dir*.cpp.当检查所有文件时不需要使用-u选项,PC-Lint基本使用方法,PC-Lint配置文件介绍PC-Lint使用那个配置文件是由命令行参数决定的，一般地都使用std.lnt文件，std.lnt文件中可以包含各种配置选项，还可以包含其他的配置文件，有点类似C的头文件，里面可以include许多其他头文件，不过PC-Lint配置文件包含其他配置文件不需要写include,直接写文件名就可以了。每个配置文件里都可以包含配置选项，这些配置选项也可以放在命令行中，一般为使用方便，命令行中不要放很多选项，尽量都将选项放到配置文件中,PC-Lint基本使用方法,以下是VC下的配置文件样例/Microtec32-bit,-si4-sp4,lib-w32.lnt/Standardlintoptionsco-msc60.lnt/PC-Lint提供的对VC6的告警屏蔽文件lib-w32.lnt/PC-Lint提供的对VC6库头文件的告警屏蔽文件options.lnt-si4-sp4/用户自定义的选项文件env-vc6.lnt/用户用来设置编辑环境的配置文件-id:vc6vc98include/include目录-id:vc6vc98mfcinclude/include目录,PC-Lint基本使用方法,一般来说，PC-Lint经常会有一些误报，为了消除这些误报，不得不将程序风格改动来规避，但有时候怎么改写程序都有告警，比如说你定义了两个宏，前面那个宏里有一半大括号,后面那个宏里有另一半大括号,这时候一定会有告警，你不得不使用一些PC-Lint选项来屏蔽这些告警。一般情况下，我们都将自己要写的选项放在Options.lnt文件中,PC-Lint基本使用方法,另外还有关于编辑环境的问题，如果把PC-Lint集成到某个编辑环境中，那么他输入的格式必须和对应环境吻合才能保证在鼠标点击(或双击)错误消息条目时可以自动定位到对应源代码行，一般来说这类配置都放置在env-xxx.lnt文件中，如VC6的时env-vc6.lnt,SourceInsight的是env-si.lntPC-Lint本身提供了对各种编译器及对应库头文件的告警屏蔽文件，如co-msc60.lnt是对vc6的，lib-w32.lnt是对Win32库头文件告警的屏蔽配置文件,PC-Lint常用选项,-i选项这个选项主要是用来设置include路径的如：-iD:VC6VC98Include-e#选项这个选项主要是用来屏蔽告警号为#的告警如：-e818表示不显示告警号为818的告警-esym(#,符号名)选项这个选项主要是用来屏蔽告警号为#的某个符号的告警，如-esym(39,std)-emacro(#,宏名称)选项这个选项主要是用来屏蔽告警号为#的某个宏的告警,PC-Lint常用选项,-dname=value这个选项主要是用来定义一个宏的如：-dWIN32,-dalpha=0-sp#表示指针的尺寸大小是#字节如：-sp4表示指针是4个字节大小-si#表示int的尺寸大小是字节如：-si4表示int型是4个字节大小-t#设置Tab键的大小为#个空格，缺省是8,PC-Lint常用选项,-sem选项这个选项主要是用来消除一些语义上的告警比如说在一个函数A里面分配了内存，这时调用了另一个函数AddNode将分配的内存保存起来了，因此在函数A里面没有释放内存，如果使用PC-Lint检查会有内存泄漏方面的告警，因为PC-Lint不知道函数AddNode将分配的内存保存起来了，要消除这个告警就要用到-sem选项了。假设AddNode的第2个参数是用来保存分配内存，用法如下-sem(AddNode,custodial(2)这里custodial关键字是表示保存的意思，2是表示第2个参数。-sem选项还有些其他用法，大家可以看PC-Lint自带的pc-lint.pdf文件，里面有详细的解析,PC-Lint常用选项,-function(function0,function1,)选项这个选项一般情况下主要是用来表示function1及后面省略掉的函数和function0有类似的行为。如：-function(malloc,mymalloc1,mymalloc2)表示mymalloc1,mymalloc2和malloc有类似的行为，因为malloc是用来分配内存的，所以pc-lint在检查mymalloc1和mymalloc2时也会想检查malloc一样看是否有释放掉象上一页里已经定义了AddNode为保存内存的函数，如果碰到还有一个函数AddEvent也是有保存内存的功能，我们除了可以使用-sem(AddEvent,custodial(2)外，也可以使用-function(AddNode,AddEvent),效果是一样的。不过要注意的是AddEvent保存内存的参数也要和AddNode一样是第2个。,PC-Lint常用选项,-format选项这个选项主要是用来设置输出告警消息格式的，以便于可以和编辑环境格式一样，便于自动定位到告警对应的源代码如对SourceInsight,-format选项的使用如下：-format=%f%l%t%n:%m“这里%f表示文件名%l表示代码行号%t表示告警类型，如warning,error等%n表示PC-Lint的告警号%m表示PC-Lint输出的告警文本信息,PC-Lint常用选项,-fallthrough这个选项主要是用在switchcase中没有使用break的情况可以在代码中使用/lintfallthrough来消除没有使用break的告警-save保存错误抑制状态如：在代码中使用/lintsavee429则表示从这行开始之后的代码抑制429告警的出现，直到使用/lintrestore来进行恢复后才会重新出现429告警-restore重新设置错误抑制状态，使用-save选项抑制的告警将重新恢复，在使用了-save选项后一定要记住使用-restore进行恢复，否则可能有许多告警就被屏蔽调不出现了。,PC-Lint常用选项,其他一些常用选项还有-elib抑制库头文件的告警-elibsym抑制库头文件中某个符号的告警-wlevel设置告警级别-efile用来抑制一个或多个文件里的告警-efunc用来抑制一个或多个函数里的告警+rw设置保留关键字等等。象-efile,-wlevel这些告警不要轻易使用这些选项的具体用法请看pc-lint.pdf文件,PC-Lint在各种环境中的集成,PC-Lint在各种环境中的集成方法原理都是一样的，只要掌握前面讲的基本用法，知道如何用命令行来检测单个文件，一个目录下的所有文件，许多目录下的所有文件等，然后再结合各种环境的具体设置，就可以很方便地将PC-Lint集成到各种应用环境中了。下面将以VC6,SourceInsight,UltraEdit,Tornado四种环境为例讲述如何集成PC-Lint,PC-Lint在各种环境中的集成,在vc环境中集成在VC的Tools菜单中,按Customize会出现下一页出现的对话框先在上面的列表框里增加一个条目，里面填上PC-Lint80,文本内容可以是其他的，由你自己决定。然后在Command:这一栏中输入PC-Lint的执行文件名，要带上目录再在Arguments:一栏里填上-u-iC:Lintstd.lnt$(FileName)这里$(FileName)表示VC窗口里当前打开的文件名你也可以将它改成$(FileDir)*.cpp表示检查当前打开文件同一目录下的所有.cpp文件，通常用于检查一个模块还可以改成AllSource.lnt,象前面讲过的一样，AllSource.lnt是一个放置有所有文件的配置文件，这时要将-u去掉。,PC-Lint在各种环境中的集成,PC-Lint在各种环境中的集成,再在InitialDirectory一栏里填上$(FileDir)最后再将useoutputwindow打上勾就完成了将PC-Lint集成到VC环境中,PC-Lint在各种环境中的集成,在SourceInsight3.1中的集成在SourceInsight3.1中集成PC-Lint过程如下：1）从Options菜单中选择“CustomCommands”命令项。2）点Add键会出现下面的AddNewCustomCommand对话框在Newcommandname：栏中输入“PC-lint80”，原则上这个名称可以随便起，只要你能搞清楚它的含义就可以了，然后按OK按钮。,PC-Lint在各种环境中的集成,3）在Run栏中输入“d:lintlint-nt-u-ic:lintstd.lntenv-si%f”其中d:lint是你PC-LINT的安装目录,%f是表示当前打开的文件。如果要Lint多个文件则需要使用配置文件，在配置文件里包含多个文件，将%f改成你自己的配置文件即可。4）在Output栏中选择“IconicWindow”、“CaptureOutput”。5）在Control栏中选择“SaveFilesFirst”、将缺省打了勾选上的“PauseWhenDone”改成不选择。6）在SourceLinksinOutput栏中选择“ParseLinksinOutput”、“File，thenLine”。7）在Pattern栏中将缺省设置改成(*)(0-9+)就大功告成了。8）如果需要Lint当前打开文件的同一目录下所有文件，可以将%f改成%d*.cpp如下图：,PC-Lint在各种环境中的集成,PC-Lint在各种环境中的集成,在Tornado2.0环境中集成在Tornado2.0的Tools菜单中点Customize后会出现如下一页的对话框。先在对话框中按Add按钮在MenuText一栏中输入PC-Lint80在ToolCommand:一栏中输入D:LINTlint-nt.exe-iD:Lintstd.lnt$filename你也可以象前面讲过VC中集成一样，将$filename改成$filedir*.cpp或AllSource.lnt在Working一栏中输入$filedir再将RedirecttoChildWind选上，按OK就可以了,PC-Lint在各种环境中的集成,PC-Lint在各种环境中的集成,在UltraEdit环境中集成在Advanced菜单中选ToolConfiguration.，显示图如下一页所示在commandline:中填写：d:lintlint-ntiD:Lintstd.lnt%F在MenuItem中填写：PC-Lint80在CommandOutput中选择：(x)OutputtoListBox和(x)CaptureOutput5）按Insert按钮再按OK按钮就可以了,PC-Lint在各种环境中的集成,PC-Lint常见告警分析及解决措施,PC-Lint的告警级别定义如下：,PC-Lint常见告警分析及解决措施,PC-Lint告警分为04级，其中0级是内部错误或致命错误，1级告警是句法错误，2级告警是警告，3级是信息，4级是可选的，4级缺省是不打开的。0级告警是不允许出现的，1级告警一般也是不允许出现的，如果出现，说明可能PC-Lint配置上可能有问题，或者程序根本编译不过，2级告警一般也是不能屏蔽的，2级告警很多是内存资源没有释放，指针越界一类的警告，会产生严重问题，3级告警有些告警也是非常重要的，会引起严重问题，有些告警属于提示信息，问题不是很大，所以3级告警里要分情况对待。02级告警都不能使用-e选项进行屏蔽，只能使用-esym，-emacro，-sem之类的选项进行屏蔽；3级告警要根据具体情况，有些可以使用-e选项进行屏蔽，有些不可以。下面就对经常遇到的一些告警进行详细的分析及讨论解决措施。,PC-Lint常见告警分析及解决措施,告警号：39告警等级：1告警消息样例：stl_type_traits.h(279):error39:(Error-Redefinitionofsymbol_type_traitsconflictswithline271)分析及解决措施：可以使用-esym(39,符号名)来消除此告警，在这里可以使用-esym(39,_type_traits,PC-Lint常见告警分析及解决措施,告警号：402告警等级：2告警消息样例：XXX.cpp(77):error402:(Warning-staticfunctionVOS_GetFixedStackDepth(void)(line77)分析及解决措施：主要是函数原型申明为静态的，但函数实体确漏写了static造成,PC-Lint常见告警分析及解决措施,告警号：413告警等级：2告警消息样例：xxx.cpp(1118):error413:(Warning-Likelyuseofnullpointerunknown-nameinargumenttooperatorunary*分析及解决措施：指针未校验引起，如果确认指针可以由外部保证则可以使用ASSERT来消除此告警,PC-Lint常见告警分析及解决措施,告警号：429告警等级：2告警消息样例：XXX.cpp(2474):error429:(Warning-CustodialpointerpEvent(line2459)hasnotbeenfreedorreturned)分析及解决措施：AddEvent将指针pEvent保存起来，解决办法是使用-sem(ISystem:AddEvent,1p,custodial(1)来屏蔽此告警，这里1p是表示第1个参数，custodial(1)是表示第1个参数被保留起来了。另外还有函数递归调用时，如果递归调用时使用的参数和函数参数同名也会出现此告警，递归调用时必须将参数改名。还有一种情况是在父函数里分配了内存，传递到子函数后，由于子函数里有return语句有时也会产生429告警，这种行为非常奇怪，目前没有找到好的消除办法，尽量将程序结构改成把return语句去掉就没有这个告警了。,PC-Lint常见告警分析及解决措施,告警号：522告警等级：2告警消息样例：error522:(Warning-Expectedvoidtype,assignment,incrementordecrement)分析及解决措施：单独的*p+型可以改写成(*p)+可以避免此告警,如果是*(p+)就没有必要了，直接写成p+就可以了。*p+型作为右值的话一般不会有此告警，另外函数返回值未处理有时也有此告警,PC-Lint常见告警分析及解决措施,告警号：525告警等级：2告警消息样例：Warning525:Negativeindentationfromline312分析及解决措施：如果确定程序没有问题的话，可以检查告警525的产生是否由于程序中有Tab键或者程序排版没有对齐造成的，将Tab删掉，改成空格，将排版格式对齐就可以了,PC-Lint常见告警分析及解决措施,告警号：534告警等级：2告警消息样例：xxx.cpp(1694):error534:(Warning-IgnoringreturnvalueoffunctionYYY(unsignedlong)(comparewithline180分析及解决措施：一般都是由于没有处理函数返回值造成，如果确信函数返回值可以不处理的话，只要在不需要处理函数返回值的函数前加上(void)就可以了。,PC-Lint常见告警分析及解决措施,告警号：539告警等级：2告警消息样例：Warning539:Didnotexpectpositiveindentationfromline210分析及解决措施：除了左边所说的问题外，如果程序中有TAB键，且不是8个空格的话，有时也会引起告警539的产生，如果消除掉左边所说的问题还有539告警的话，则估计是由于程序中有Tab键造成的，将Tab删掉，改成空格，并且排版格式要对齐就可以了。,PC-Lint常见告警分析及解决措施,告警号：613告警等级：2告警消息样例：XXX.cpp(374):error613:(Warning-Possibleuseofnullpointermatrixinleftargumenttooperatorptr+int分析及解决措施：通常是由于指针和整数相加造成的问题bool*matrix=(bool*)newbool(size_t)(len*len);bool*dep=matrix+row*len;可以改写成先将地址转换成整数形式，再相加后，再将整数形式的地址转换为指针可以消除此告警。另外还有指针在其他函数校验了，但在本函数内没有校验也会有此告警,象组建中，因为有Initialize()函数里保证那些组件指针的合法性，因此在其他函数里不再需要对这些指针做校验，此种情况可以使用ASSERT()来消除此告警，其他情况请使用指针校验来消除此告警。,PC-Lint常见告警分析及解决措施,告警号：616告警等级：2告警消息样例：XXX.cpp(162):error616:(Warning-controlflowsintocase/default)分析及解决措施：case没有break;语句的问题，使用/lint-fallthrough来屏蔽,PC-Lint常见告警分析及解决措施,告警号：661告警等级：2告警消息样例：XXX.cpp(2560):error661:(Warning-Possibleaccessofout-of-boundspointer(1beyondendofdata)byoperatorunary*分析及解决措施：内存越界问题，如果由调用方保证，可以使用ASSERT来消除此告警，否则应该对输入参数进行校验,PC-Lint常见告警分析及解决措施,告警号：668告警等级：2告警消息样例：XXX.cpp(1211):error668:(Warning-Possiblypassinganullpointertofunctionmemset(void*,int,unsignedint),arg.no.1分析及解决措施：指针可能为null，一般都是由于没有进行校验引起，如果指针由外部可以保证的话，可以使用ASSERT消除这个告警,PC-Lint常见告警分析及解决措施,告警号：672告警等级：2告警消息样例：XXX.cpp(353):error672:(Warning-PossiblememoryleakinassignmenttopointercmpFactory:m_pLibrary)分析及解决措施：一个函数中申请了内存在本函数中没有释放，在其他函数中释放会引起这个告警可以使用-esym或-sem来消除,PC-Lint常见告警分析及解决措施,告警号：685告警等级：2告警消息样例：XXX.cpp(2346):error685:(Warning-RelationaloperatorBufSize-VOS_PT_BUF_TAIL_LEN);实际上是将CHAR*转换为DWORD*造成的。可以在本行前使用注释/*lint-save-e826*/屏蔽，在本行后再使用/*lint-restore*/恢复的办法,PC-Lint常见告警分析及解决措施,告警号：834告警等级：3告警消息样例：intx=(rect.Width()-cxIcon+1)/2;XXX.cpp(178):Info834:Operator-followedbyoperator+isconfusing.Useparentheses.分析及解决措施：这个告警很简单，主要是需要使用括号将表达式按运算优先顺序括起来以方便阅读,PC-Lint常见告警分析及解决措施,告警号：1065告警等级：3告警消息样例：XXX.cpp(657):error1065:(Error-SymbolVOS_TerminateHandle(void)notdeclaredasCconflictswithline510)分析及解决措施：在头文件里被申明为externC，但在cpp文件里函数前没有加上externC关键字造成,PC-Lint常见告警分析及解决措施,告警号：1540告警等级：3告警消息样例：XXX.cpp(495):error1540:(Warning-PointermemberCXXXObject:m_pCrc4Fecses(line76,XXXP.h,moduleYYY.cpp)neitherfreednorzeroedbydestructor)分析及解决措施：析构函数中没有对成员指针变量进行内存释放或清零操作，修改代码即可,PC-Lint常见告警分析及解决措施,告警号：1732告警等级：3告警消息样例：XXX.cpp(48):error1732:(Info-newinconstructorforclassFEC_CURRENT_DATAwhichhasnoassignmentoperator)分析及解决措施：在构造函数中调用new造成，所以在构造函数中尽量不要分配内存,PC-Lint常见告警分析及解决措施,告警号：1733告警等级：3告警消息样例：XXX.cpp(11):error1733:(Info-newinconstructorforclassABXErrorwhichhasnocopyconstructor)分析及解决措施：在构造函数中使用了new函数，但没有拷贝构造函数有时会出现这个告警,PC-Lint常见告警分析及解决措施,告警号：1735告警等级：3告警消息样例：Info1735:VirtualfunctionCXXXTest:Set(constchar*)hasdefaultparameter分析及解决措施：这个问题产生主要是因为虚函数有缺省参数可以使用/*lint-save-e1735*/和/*lint-restore*/来屏蔽,PC-Lint常见告警分析及解决措施,告警号：1740告警等级：3告警消息样例：XXX.cpp(101):error1740:(Info-pointermemberCXXXManager:m_pCpuChArr(line184,fileYYY.h)notdirectlyfreedorzeroedbydestructor)分析及解决措施：调用了VOS_Free造成，可以使用/*lint-save-e1740*/和/*lint-restore*/来屏蔽，有时候定义了一个类的成员指针变量，析构函数没有释放或将指针赋空的话也会有此告警，只要在析构函数中将指针赋成0即可消除此告警。这个告警在平台中也是出现非常多的，即使使用-e1740也屏蔽不了。,PC-Lint常见告警分析及解决措施,告警号：1762告警等级：3告警消息样例：XXX.cpp(265):error1762:(Info-MemberfunctionCXXXManager:GetXXXInfo(unsignedchar&,structXXX_INFO*&)couldbemadeconst)分析及解决措施：函数可以申明为const类型，通常都是一些没有修改成员变量的函数会有这类告警,PC-Lint常见告警分析及解决措施,告警号：1774告警等级：3告警消息样例：XXX.cpp(188):error1774:(Info-Couldusedynamic_casttodowncastpolymorphictypeIBase)分析及解决措施：在这里主要是LoadPlugin()函数本来返回值类型是IBase*,但把它转换成IPlugin*后是使用强制转换，没有使用dynamic_cast转换,PC-Lint常见告警分析及解决措施,告警号：1776告警等级：3告警消息样例：XXX.cpp(198):error1776:(Info-Convertingastringliteraltosignedchar*isnotconstsafe(arg.no.4)#._Malloc,(constchar*)_FILE_,_LINE_)分析及解决措施：主要是参数可以申明为const造成，象_FILE_前可以加(constchar*)进行转换，并且对应的VOS_Malloc()函数定义时需要将参数定义为constchar*类型,