CN103645985B - 一种源代码宏配对检测方法 - Google Patents

Abstract

本发明公开了一种源代码宏配对检测方法，包括接收待检测的源代码程序包；判断源代码程序包是否为强制提交文件；若是，则将所述源代码程序包直接提交至所述代码库服务器；若否，则查询所述源代码程序包中的文件列表，对所述源代码程序包中的源代码文件进行过滤，获得新增或修改的源代码文件；对所述新增或修改的源代码文件逐一进行宏配对检测，并在所有新增或修改的源代码文件的宏配对检测无误时，将所述源代码程序包提交至所述代码库服务器。本发明提供的源代码宏配对检测方法能够实时、准确地检测出源代码文件中的宏配对情况，将宏配对错误的源代码及时拦截于代码库服务器之外，提高源代码的可靠性和复用性。

Description

一种源代码宏配对检测方法

技术领域

本发明涉及软件源代码检测技术，尤其涉及一种源代码宏配对检测方法。

背景技术

在大型软件系统中，系统架构的设计直接决定系统的质量和可持续开发能力。源代码缺陷检测工具是相当复杂的系统，现有的一些开源检测工具，虽然可以实现一定功能的代码缺陷检测，但是，目前大多数的检测工具都将语法处理、检测和错误报告等功能混合在一起，虽然在开发时难度较低，但可扩展性和可维护性较差，且状态过多容易导致存储爆炸的问题。

在C/C++语言中，宏的判断是实现其条件编译的重要语法。其中，在C语言中主要使用“#if、#ifdef、#ifndef、#elif、#else、#endif”几个宏关键字完成条件编译，其中“#if…/#endif”是需要成对出现的。在软件系统较为简单的情况下，程序员可以很好的解决宏配对的问题，但在较复杂的宏逻辑中，或者对两套源代码进行合并时，则会常常出现宏不配对的情况，而源代码编译器在发生“#endif”等宏不匹配的情况时却不报告错误。

为解决这个问题，现有的解决方案是在提交源代码至代码库服务器之前/后，由人工对源代码进行审核；或者，采用一些自动构建的方法，以固定周期自动更新代码、编译和测试，出现问题后发出警报。在上述的两个解决方案中，人工的源代码审核会消耗大量的人力，而人为审核常常会有疲倦带来的疏忽，人工审核的可靠性非常低；自动构建是源代码上传至服务器后的一个检查工作，有一定的滞后性，同时如果代码编译器对宏不配对情况没有报告错误时，也无法解决“#if与#endif”等宏匹配问题。

宏的不匹配是代码安全的一大隐患。在后续的代码维护中，宏失配会因为对源代码的一个小修改而造成严重错误，或是经过很长时间后才发现宏失配，也要花很长时间来查阅源代码，重新理解各部分源代码的工作原理，再分析在源代码的宏失配的具体位置，以补全这个宏。因此有必要将代码中宏匹配情况及时有效的检测出来，或将不合格的代码拦截在代码库之外，防止错误扩散。

发明内容

本发明所要解决的技术问题是，提供一种源代码宏配对检测方法，实现对源代码程序包中的宏的配对情况进行自动检测，并只有在宏配对检测无误时才将所述源代码程序包提交至代码库服务器，防止错误代码的扩散，提高源代码的可靠性和复用性。

为解决以上技术问题，本发明实施例提供一种源代码宏配对检测方法，应用于将源代码提交至代码库服务器之前进行宏配对检测，所述方法包括：

接收待检测的源代码程序包；所述源代码程序包包括多个源代码文件；

判断所述源代码程序包是否为强制提交文件；若是，则将所述源代码程序包直接提交至所述代码库服务器；若否，则查询所述源代码程序包中的文件列表，对所述源代码程序包中的源代码文件进行过滤，获得新增或修改的源代码文件；调用宏配对检测算法对所述新增或修改的源代码文件逐一进行宏配对检测，并在所有新增或修改的源代码文件的宏配对检测无误时，将所述源代码程序包提交至所述代码库服务器；

所述宏配对检测算法，具体为：

统计待检测源代码文件的错误宏计数值；

其中，当所述错误宏计数值为零时，判定所述待检测源代码文件的宏配对检测无误。

进一步地，所述对所述新增或修改的源代码文件逐一进行宏配对检测，包括：

逐一读取所述新增或修改的源代码文件；

调用宏配对检测算法对每一个所述新增或修改的源代码文件进行宏配对检测，统计每一个所述新增或修改的源代码文件的错误宏计数值；

统计所有新增或修改的源代码文件的错误宏总计数值；

判断所述错误宏总计数值是否为零；当所述错误宏总计数值为零时，则返回提交成功标识，并将所述源代码程序包提交至所述代码库服务器；当所述错误宏总计数值为非零时，则返回提交失败标识，中止提交所述源代码程序包。

作为一种可实现方式，所述宏配对检测算法，具体为：

对任一待检测源代码文件进行预处理；

搜索预处理后的待检测源代码文件中的宏关键字；

对所述宏关键字进行计数，以判断所述宏关键字是否一一匹配，并统计获得所述错误宏计数值；

返回所述待检测源代码文件的错误宏计数值。

进一步地，所述对源代码文件进行预处理，包括：

还原所述源代码文件中的续行符和去除所述源代码文件中的代码注释。

所述对所述宏关键字进行计数，以判断所述宏关键字是否一一匹配，并统计获得所述错误宏计数值，包括：

搜索所述待检测源代码文件的所有宏关键字；所述宏关键字包括多对一一匹配的起始关键字和结束关键字；

对所述宏关键字进行计数，包括：

当检测到任意一个起始关键字时，对所述宏关键字的计数值“加一”处理；当检测到任意一个结束关键字时，对所述宏关键字的计数值“减一”处理；所述宏关键字的计数值的初始值为零；

对所述待检测源代码文件的错误宏计数值进行统计，包括：对所述宏关键字的计数值进行实时监测；

当监测到所述宏关键字的当前计数值为负值时，对所述错误宏计数值“加一”处理；

当监测到所述宏关键字的当前计数值为零，且检测所述待检测源代码文件存在代码“#elif”或“#else”时，对所述错误宏计数值“加一”处理；

当所述待检测源代码文件被扫描完成后，所述宏关键字的当前计数值为非零值时，对所述错误宏计数值“加一”处理；

统计并提交所述错误宏计数值。

本发明实施例提供的源代码宏配对检测方法，通过在将源代码程序包提交至代码库服务器之前，执行宏配对检测，根据检测结果决定是否将该源代码程序包提交至所述代码库服务器，从而及时有效地将源代码程序包中的各个源代码文件的宏匹配情况检测出来，将不合格的源代码拦截在代码库服务器之外，防止错误扩散，保证代码库服务器中的源代码文件的可靠性。

附图说明

图1是本发明提供的源代码宏配对检测方法的一个实施例的流程示意图；

图2是本发明实施例提供的代码库服务器与用户的结构关系图；

图3是本发明实施例提供的对所述新增或修改的源代码文件逐一进行宏配对检测的流程示意图；

图4是本发明实施例提供的宏配对检测算法的一种实现方式流程示意图；

图5是本发明实施例提供的统计错误宏计数值的一种实现方式流程示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述。

参见图1，是本发明提供的源代码宏配对检测方法的一个实施例的结构示意图。

在本实施例中，所述的源代码宏配对检测方法，应用于将源代码提交至代码库服务器之前进行宏配对检测，所述方法包括以下步骤：

步骤S101：接收待检测的源代码程序包；所述源代码程序包包括多个源代码文件；

步骤S102：判断所述源代码程序包是否为强制提交文件；若是，则执行步骤S103；若否，则执行步骤S104～步骤S105；

步骤S103：将所述源代码程序包直接提交至所述代码库服务器。在程序执行过程中，首先对提交的源代码程序进行扫描，为强制提交留下后门，跳过宏配对检测，以应对实际应用中的某些特殊需求。

步骤S104：查询所述源代码程序包中的文件列表，对所述源代码程序包中的源代码文件进行过滤，获得新增或修改的源代码文件；

步骤S105：对所述新增或修改的源代码文件逐一进行宏配对检测，并在所有新增或修改的源代码文件的宏配对检测无误时，将所述源代码程序包提交至所述代码库服务器。具体地，为了节约中央处理器CPU时间，所述步骤S105中并非中把整个项目的源代码程序包的源代码文件进行宏配对检测，而是只针对本次源代码程序包的提交过程中，对更新过的(新增或修改的源代码文件)做宏配对检测。因而通过过滤操作去除不必检测的源代码文件，再开始轮询检测每个新增或修改过的源代码文件的宏配对情况，并对检查到的错误进行累加统计。轮询检测结束后按照错误宏计数的值返回成功或失败标识。

具体实施时，在软件工程开发过程中，一个系统/项目的所有源代码都由一个中心代码库服务器集中存储。用户可以从代码库服务器下载源代码，对下载的源代码根据实际需要进行处理(新增、修改或测试等)后，然后将处理更新后的源代码重新提交至代码库服务器进行存储。

参看图2，是本发明实施例提供的代码库服务器与用户的结构关系图。

如图2所示，在具体实现过程中，多个用户(用户1～用户N)可从代码库服务器200中下载所需要的源代码程序包或具体的源代码文件，并根据工程项目实施的需要对下载的源代码进行修改或补充，以获得功能改进或新功能的系统功能；在对源代码进行更新后重新上传至代码库服务器200进行存储，以便于其他用户的调用，提高源代码的复用性。但是，若重新提交至代码库服务器200中的源代码文件不经检测便存储，则在其他用户调用该更新后的源代码文件以实现某一系统功能时，若该源代码文件存在宏失配的情况，则有可能产生灾难性的后果，因此，在本实施例中，需要对源代码进行宏配对检测。

优选地，在所述步骤S105中，所述对所述新增或修改的源代码文件逐一进行宏配对检测时，可根据每一个新增或修改的源代码文件中的宏配对的统计情况，判断是否可提交至代码库服务器。

参看图3，是本发明实施例提供的对所述新增或修改的源代码文件逐一进行宏配对检测的流程示意图。

具体地，对待提交至代码库服务器200中的源代码程序包中的每一个新增或修改的源代码文件执行宏配对检测时，包括以下步骤：

步骤S301：逐一读取所述新增或修改的源代码文件；

步骤S302：调用宏配对检测算法对每一个所述新增或修改的源代码文件进行宏配对检测，统计每一个所述新增或修改的源代码文件的错误宏计数值；其中，所述错误宏计数值的初始值为零；

步骤S303：统计所有新增或修改的源代码文件的错误宏总计数值；对每一个新增或修改的源代码文件的错误宏计数值进行叠加，以获得所述错误宏总计数值，即获得了待提交至代码库服务器200的源代码程序包的错误宏总计数值。

步骤S304：判断所述错误宏总计数值是否为零；当所述错误宏总计数值为零时，则执行步骤S305；当所述错误宏总计数值为非零时，则执行步骤S306。

步骤S305：返回提交成功标识，并将所述源代码程序包提交至所述代码库服务器；

步骤S306：返回提交失败标识，中止提交所述源代码程序包。

具体地实施时，通过执行步骤S301～步骤S306所述的方法步骤，等价于在将源代码程序包上传至代码库服务器200之前，首先执行一个“钩子(Hook)”程序；该Hook程序在返回正常值(即本发明中的“提交成功标识”)，则继续执行提交操作，返回错误值(即本发明中的“提交失败标识”)，则中止提交操作并返回错误。

钩子(Hook)程序，是应用程序中消息处理的一种机制，它允许外部程序来处理本应用程序中特定的消息事件。具体地，本发明在接收到源代码程序包提交请求时，在目标处理函数(即源代码提交至代码库服务器200)之前先处理该钩子程序。钩子(Hook)机制允许应用程序截获处理源代码程序包提交请求消息或其它特定事件。

更进一步地，本发明利用该Hook程序，来调用宏配对检测算法。

参见图4，是本发明实施例提供的宏配对检测算法的一种实现方式流程示意图。

如图4所示，在本实施例提供的源代码宏配对检测方法中，所述宏配对检测算法，具体为：

步骤S401：对任一待检测源代码文件进行预处理；优选地，所述步骤S401包括：还原所述源代码文件中的续行符和去除所述待检测源代码文件中的代码注释。

步骤S402：搜索预处理后的待检测源代码文件中的宏关键字。

步骤S403：对所述宏关键字进行计数，以判断所述宏关键字是否一一匹配，并统计获得所述错误宏计数值。

步骤S404：返回所述待检测源代码文件的错误宏计数值。

参见图5，是本发明实施例提供的统计错误宏计数值的一种实现方式流程示意图。

具体地，所述步骤S403包括：

步骤S501：搜索所述待检测源文件的所有宏关键字；所述宏关键字包括多对一一匹配的起始关键字和结束关键字。

步骤S502：判断所述宏关键字的类型，实现对所述宏关键字进行计数；当检测到任意一个起始关键字时，执行步骤S503；当检测到任意一个结束关键字时，执行步骤S504；

步骤S503：对所述宏关键字的计数值“加一”处理；

步骤S504：对所述宏关键字的计数值“减一”处理。其中，所述宏关键字的计数值的初始值为零；

步骤S505：根据所述宏关键字的当前计数值，对所述待检测源文件的错误宏计数值进行统计，包括：对所述宏关键字的计数值进行实时监测；具体地，当监测到发生以下三种情况时，对所述错误宏计数值“加一”处理，包括：

(1)所述宏关键字的当前计数值为负值；

(2)所述宏关键字的当前计数值为零且检测所述待检测源文件存在代码“#elif”或“#else”；

(3)在所述待检测源文件被扫描完成后，所述宏关键字的当前计数值为非零值。

步骤S506：在所述源代码文件扫描完成后，统计并提交所述错误宏计数值。

具体地，在C语言源代码文件中，其条件编译的“宏”都是以行为单位的，因此其源代码分析也就要按行来分析。在分析前，需要整理代码以防误判断。例如注释行中行首含有“#if…/#endif”之类的字符串。具体地，源代码的预处理包括但不限于去除代码注释和还原续行符。其中，还原续行符就是把行尾字符为“\”的行，与下一行连接成一行，中间用空格隔开；去除代码注释包括单行注释“//”及多行注释“/**/”，即将源代码中的注释部分删除。

在本实施例中，可通过设置宏关键字计数器对宏关键字进行搜索和统计；具体地，该宏关键字计数器的初始值为零；当搜索到起始关键字，如“#if”、“#ifdef”、“#ifndef”，宏关键字计数器的计数值加“1”；当搜索到结束关键字，如“#endif”，宏关键字计数器的计数值减“1”；由于正常的源代码文件中的“宏”都是起始关键字与结束关键字一一配对的，因此，在宏配对检测的任一时刻中，若所述宏关键字的计数值为负值时，则说明该源代码文件中当前已经出现了宏失配；而当该源代码文件被扫描完成后，其宏关键字的计数值的统计结果不为零时，也说明了该源代码文件出现了宏失配。特别地，在宏配对检测的任一时刻中，若所述宏关键字的计数值为零值但监测到该源代码文件中还存在着代码“#elif”或“#else”，说明该源代码文件中缺少了对代码“#elif”或“#else”相配对的宏关键字，因此此时也出现了宏失配，即在宏关键字计数器的计算值为零的状态下检测到“#elif”、“#else”。因此，对以上三种出现宏失配的情况进行了统计，将所述错误宏计数值加1，以反映该源代码文件中的错误宏的数量。

当统计完所有新增或修改的源代码文件的宏关键字的情况后，对所得到的所有错误宏的数量进行叠加，以得到待提交至代码库服务器200中的源代码程序包的错误宏总计数值。在正常情况下，所述错误宏总计数值应为零值；若该错误宏总计数值为非零值，则中止宏失配的源代码程序包被提交至代码库服务器200中。

本发明提供的源代码宏配对检测方法，通过在提交更新后的源代码程序包至代码库服务器之前，判断所述源代码程序包是否为强制提交文件，以满足具体实施时的特殊需要；并在需要查询宏匹配状态的情况下，对所述源代码程序包中的源代码文件进行过滤，获得新增或修改的源代码文件；对所述新增或修改的源代码文件逐一进行宏配对检测，并在所有新增或修改的源代码文件的宏配对检测无误时，将所述源代码程序包提交至所述代码库服务器，减轻了CPU的检测时间和提高检测的效率。实施本发明提供的源代码宏配对检测方法，能够实时、准确地检测出源代码文件中的宏配对情况，将宏配对错误的代码及时地拦截于代码库服务器之外，提高源代码的可靠性和复用性。

以上所述是本发明的优选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也视为本发明的保护范围。

Claims (3)

1.一种源代码宏配对检测方法，其特征在于，应用于将源代码提交至代码库服务器之前进行宏配对检测，所述方法包括：

接收待检测的源代码程序包；所述源代码程序包包括多个源代码文件；

判断所述源代码程序包是否为强制提交文件；若是，则将所述源代码程序包直接提交至所述代码库服务器；若否，则查询所述源代码程序包中的文件列表，对所述源代码程序包中的源代码文件进行过滤，获得新增或修改的源代码文件；对所述新增或修改的源代码文件逐一进行宏配对检测，并在所有新增或修改的源代码文件的宏配对检测无误时，将所述源代码程序包提交至所述代码库服务器；

其中，

所述对所述新增或修改的源代码文件逐一进行宏配对检测，包括：

逐一读取所述新增或修改的源代码文件；

调用宏配对检测算法对每一个所述新增或修改的源代码文件进行宏配对检测，统计每一个所述新增或修改的源代码文件的错误宏计数值；所述错误宏计数值的初始值为零；

统计所有新增或修改的源代码文件的错误宏总计数值；

判断所述错误宏总计数值是否为零；当所述错误宏总计数值为零时，则返回提交成功标识，并将所述源代码程序包提交至所述代码库服务器；当所述错误宏总计数值为非零时，则返回提交失败标识，中止提交所述源代码程序包；

所述宏配对检测算法，具体为：

对任一待检测源代码文件进行预处理；

搜索预处理后的待检测源代码文件中的宏关键字；

对所述宏关键字进行计数，以判断所述宏关键字是否一一匹配，并统计获得所述错误宏计数值；

返回所述待检测源代码文件的错误宏计数值；

对所述待检测源代码文件的错误宏计数值进行统计，包括：

对所述宏关键字的计数值进行实时监测；

当监测到所述宏关键字的当前计数值为负值时，对所述错误宏计数值“加一”处理；

当监测到所述宏关键字的当前计数值为零，并检测到所述待检测源代码文件存在代码“#elif”或“#else”，且缺少与检测到的代码“#elif”或“#else”相配对的宏关键字时，对所述错误宏计数值“加一”处理；

当所述待检测源代码文件被扫描完成后，所述宏关键字的当前计数值为非零值时，对所述错误宏计数值“加一”处理；

统计并提交所述错误宏计数值。

2.如权利要求1所述的源代码宏配对检测方法，其特征在于，所述对任一待检测源代码文件进行预处理，包括：

还原所述待检测源代码文件中的续行符和去除所述待检测源代码文件中的代码注释。

3.如权利要求1所述的源代码宏配对检测方法，其特征在于，所述对所述宏关键字进行计数，以判断所述宏关键字是否一一匹配，并统计获得所述错误宏计数值，包括：

搜索所述待检测源代码文件的所有宏关键字；所述宏关键字包括多对一一匹配的起始关键字和结束关键字；

对所述宏关键字进行计数，包括：

当检测到任意一个起始关键字时，对所述宏关键字的计数值“加一”处理；当检测到任意一个结束关键字时，对所述宏关键字的计数值“减一”处理；所述宏关键字的计数值的初始值为零。