CodeClean 使用说明
1. 说明
工程中有许多垃圾代码,CodeClean能识别的垃圾代码指从入口不可达的垃圾函数和全局变量。CodeClean 可以扫描出所有这类代码,从扫描垃圾的角度,未对函数和全局变量未做区别。
有很多函数和全局变量被其它的函数或全局变量引用到,但引用它的函数(或全局变量)从入口是不可达的,这样的函数(或全局变量)称它为 Island。
本程序仅扫描C语言(不包括C++)的垃圾代码。本程序不对C语言程序进行预处理(忽略了“#”开头的行),对宏调用不做特别处理,将它看作是一个普通的函数调用。
对于已知的未使用的变量,或函数(如这些变量或函数在汇编语言程序中使用)。为防止他们被清除掉,可以定义一个哑宏,如:
#define DUMMY_REFER(X)
在某个(已知的)从入口可达的函数(非垃圾函数)中引用该变量(或函数)即可。如:
Void main()
{
…..
DUMMY_REFER(MyPredefinedFunction);
…..
}
2. 命令行
CodeClean options
options: /Fxxx option default is output file name
island object is an object which is not reachable by 'main',
but was refered by another object.
/Fmake [make file name(input file, list of input source file names)]
/Fgarbage [garbage object list file name]
/Fisland [island object file name]
/Ferror [error message output file name]
/Fcall [call graph file name]
/Dcall [max call graph depth (default is 32)]
/Ncall [max callees number each object's call graph (default is 32)]
/Fcaller [caller graph file name]
/Dcaller [max caller graph depth (default is 32)]
/entry [entry point name (default is 'main')]
/allcaller (list all callers of each object, in spite of found 'main' or not)
/cleancode (generate clean code)
/onlyzero (only list zero refered object to garbage object file)
/tomain (list any callers of each object until found 'main' function)
/entrystop (same as 'tomain')
/? or /H or /h (show this help message)
3. 命令行详解
以 [ ] 括起来的地方,表示这里必须要有一个参数――如果有前面的 /xxxx 选项。
/Fmake [输入文件名,其中包含 *.C文件名列表,每行一个文件]
/Fgarbage [输出文件名,扫描出的垃圾对象列表]
/Fisland [输出文件名,扫描出的“island”对象列表]
/Ferror [输出文件名,扫描过程中的显示信息,默认是Consol屏幕]
/Fcall [对象调用图(从上往下)]
/Dcall [每个对象调用图的最大深度(默认是 32)]
/Ncall [每个对象调用图的最多只列出的调用对象的数目,默认列出全部]
/Fcaller [对象被调图(从下往上)]
/Dcaller [每个对象被调图的最大深度(默认是 32)]
/entry [入口函数的名字,默认是”main”]
/allcaller (列出每个对象的所有调用者,不管是否搜索已到入口)
/cleancode (生成干净代码,生成的干净代码与原代码在同一目录下,以 .cxx 为后缀名)
/onlyzero (仅列出未被使用的对象,不列出 “island”对象)
/tomain (被调图碰到入口函数就停止)
/entrystop (与'tomain'相同)
/? or /H or /h (显示这个帮助信息)
例:
CodeClean /tomain /entry MyMain /Fmake make.mak /Fgarbage garbage.txt /Fcaller caller.txt /Fcall call.txt
生成垃圾对象列表和被调图及调用图,其中 ‘MyMain’ 是入口函数名, make.mak 是输入文件名,其中包含要扫描的文件名列表...
一个可能的 Mak 文件内容如下:
kernel\oss\kernel.c
kernel\oss\osinit.c
kernel\oss\os_err.c
kernel\oss\os_msg.c
kernel\oss\os_oem.c
kernel\oss\os_stat.c
kernel\oss\os_synch.c
kernel\oss\schtmr.c
4. 程序
如果您的VC(或其它编译环境)安装了STLPort,您可以定义__USE_HASP_MAP宏以便编译出最快的代码。
使用__USE_HASP_MAP,在Windows2000,P42.8,512M内存环境下,扫描2M代码只需要5秒!如果再生成去除垃圾后的干净代码,也只需要10秒钟。连我自己都对这个速度感到惊异!
程序下载(该程序未使用__USE_HASP_MAP,速度不是最快)