基于日志的代码缺陷自动定位小工具

A log-based tool for software fault locating

 

王树钿

wangshudian#gmail.com，2011-4-2

 

关键字：状态机；日志分析；代码缺陷

 

1 引言

 

    吃喝总要拉撒，做软件总要定位Bug。定位问题的方法很多，其中有一种是分析系统日志。通常我们分析日志靠的是人工走读，追踪变化流程来找问题根源。往往日志信息量是比较大的，分析起来费时费力。本文借鉴文献[1]的思路，开发了一个基于状态转换表进行日志分析自动定位代码缺陷的小工具。

 

 

2 功能简述

根据用户定义的状态转换规则，对事件日志进行分析，检查程序运行过程是否存在异常状态转换，并输出缺陷告警信息。

 

 

3 工具使用说明

3.1 第一步，对象及其状态分析

（1）确定检查对象

（2）确定对象状态机

（3）编辑对象状态转换配置文件

给例：

[STATESET]S0=state0S1=state1S2=state2[INITSTATE]S0[ENDSTATE]S0[EVENTSET]E0=event0E1=event1E2=event2E3=event3[EXCEPTIONSET]S-1="error: info1..."S-2="error: info2..."S-3="error: info3..."S-4="error: info4..."S-5="error: info5..."S-6="error: info6..."S-7="error: info7..."S-8="error: info8: not expected endstate"[TRANSITION]FROM=S0,ON=E0,TO=S1FROM=S0,ON=E1,TO=S-1FROM=S0,ON=E2,TO=S-2FROM=S0,ON=E3,TO=S-3FROM=S1,ON=E0,TO=S-4FROM=S1,ON=E1,TO=S2FROM=S1,ON=E2,TO=S-5FROM=S1,ON=E3,TO=S0FROM=S2,ON=E0,TO=S-6FROM=S2,ON=E1,TO=S-7FROM=S2,ON=E2,TO=S1FROM=S2,ON=E3,TO=S0

 

3.2 第二步，记录事件日志

 

 

 

因为不同产品代码日志形态各异，本工具解析规定了格式：

 

FILE:文件名,LINE:行号,SM:对象名,OBJID:对象ID,EVENT:事件

 

注意：本工具约束对象名必须和第一步的ini文件名一致。

 

可参考以下方案记录日志：

 

方案1，Hook方式。适用于不动原代码的情况。

方案2，宏方式。

 

给例：

 FILE:example.cpp,LINE:40,SM:statemachine_example,OBJID:0x477e22,EVENT:event0FILE:example.cpp,LINE:40,SM:statemachine_example,OBJID:0x477e22,EVENT:event1FILE:example.cpp,LINE:40,SM:statemachine_example,OBJID:0x477e22,EVENT:event1

3.3 第三步，运行分析工具

     可直接点击LogFAT.exe运行，默认参数是LogFile.txt和ReportFile.txt.

     也可在命令行执行，并指定日志文件名和输出报告名。

 

3.4 第四步，查看分析结果

  打开ReportFile.txt查看。

  给例：

 ./gtest_LogFileAnalysisTool.cpp(40): Exception 7: (error: info7...)./gtest_LogFileAnalysisTool.cpp(40): Exception 8: (error: info8: not expected endstate)

 

 

参考文献

【1】James H. Andrews, Theory and Practice of Log File Analysis, 1998

 

 

 注：

 

CSDN博客好似不能上载附件，我把该工具Demo版放到的我发布的下载资源里面了。链接：

 

 http://download.csdn.net/source/3155673

 

欢迎大家反馈改进建议：）