C++編碼中減少內(nèi)存缺陷的方法和工具
程振林,方金云,唐志敏
(中國(guó)科學(xué)院計(jì)算技術(shù)研究所,北京 100080)
摘 要:基于C++的軟件的缺陷和錯(cuò)誤大部分都和內(nèi)存相關(guān),預(yù)防、發(fā)現(xiàn)、消除代碼中和內(nèi)存相關(guān)的缺陷,成為程序員編寫(xiě)、調(diào)試、維護(hù)代碼時(shí)的重要任務(wù)。該文基于“面向網(wǎng)絡(luò)海量空間信息的大型GIS”課題的工程實(shí)踐,提出和總結(jié)了如何使用C++語(yǔ)言機(jī)制、開(kāi)發(fā)環(huán)境和相關(guān)質(zhì)量保證工具來(lái)預(yù)防、發(fā)現(xiàn)各種編譯期、運(yùn)行期內(nèi)存缺陷的方法和工具。
關(guān)鍵詞:C++;內(nèi)存錯(cuò)誤;內(nèi)存泄漏;質(zhì)量保證
Techniques and Tools of Defending Memory-related Defects in Software Coded in C++
CHENG Zhenlin, FANG Jinyun, TANG Zhimin
(Institute of Computing Technology, Chinese Academy of Sciences, Beijing 100080)
【Abstract】Most of the defects and errors in the software coded in C++ are memory-related. Based on the practice in the "network, large volumespatial information oriented GIS" project, this paper presentsthe techniques and tools to find and fix the memory problems during the coding,debugging and production release phase with the support of the C++ language mechanism, development environment and related quality-assurancetools.
【Key words】C++; Memory errors; Memory leak; Quality assurance
C++語(yǔ)言是桌面系統(tǒng),尤其是系統(tǒng)軟件、大型應(yīng)用軟件的主流開(kāi)發(fā)語(yǔ)言。C++語(yǔ)言以其靈活性著稱,同時(shí)也更復(fù)雜。利用C++編寫(xiě)健壯的代碼,更具有挑戰(zhàn)性。C++允許動(dòng)態(tài)內(nèi)存管理, 同時(shí)也容易導(dǎo)致更多和內(nèi)存相關(guān)的問(wèn)題。一般而言, 除了系統(tǒng)設(shè)計(jì)上的缺陷, 基于C++的軟件的缺陷和錯(cuò)誤大部分都和內(nèi)存缺陷(主要包括內(nèi)存訪問(wèn)錯(cuò)誤和內(nèi)存泄漏兩類)相關(guān)。 所以,消除代碼中的內(nèi)存相關(guān)缺陷,成為程序員編寫(xiě)、調(diào)試、維護(hù)代碼中的任務(wù),也是保證軟件質(zhì)量的關(guān)鍵。
本文的工作基于“863”計(jì)劃項(xiàng)目“面向網(wǎng)絡(luò)海量空間信息的大型GIS”課題。該系統(tǒng)是基于C++/MFC編寫(xiě),開(kāi)發(fā)環(huán)境是Visual Studio .net 2003。本文基于此項(xiàng)目的工程實(shí)踐,總結(jié)了如何使用C++語(yǔ)言機(jī)制、開(kāi)發(fā)環(huán)境和相關(guān)質(zhì)量保證工具來(lái)預(yù)防、發(fā)現(xiàn)各種編譯期、運(yùn)行期和內(nèi)存相關(guān)的缺陷的方法和工具。
1 遵循C++相關(guān)的編碼規(guī)范和慣用法,預(yù)防缺陷
編碼規(guī)范是語(yǔ)言相關(guān)的規(guī)則,是經(jīng)過(guò)實(shí)踐總結(jié)出來(lái)的經(jīng)驗(yàn)。良好的編程標(biāo)準(zhǔn)將有效地幫助開(kāi)發(fā)人員避免開(kāi)發(fā)有潛在危險(xiǎn)的代碼。一般來(lái)說(shuō),為了減少內(nèi)存缺陷,應(yīng)該遵循下列編碼規(guī)則[1]:
(1)基類或者帶有虛函數(shù)的類應(yīng)該將其析構(gòu)函數(shù)聲明為虛函數(shù)。
(2)在構(gòu)造函數(shù)中防止內(nèi)存泄漏,在析構(gòu)函數(shù)中不要拋出異常。
(3)使用對(duì)應(yīng)形式的new和delete。即:用delete來(lái)釋放new申請(qǐng)的內(nèi)存,delete[]釋放new[]申請(qǐng)的內(nèi)存。
(4)指針在使用前必須初始化,指向動(dòng)態(tài)內(nèi)存的指針在釋放后應(yīng)立即置為空。
(5)如果類構(gòu)造函數(shù)中分配了資源,那么需要顯式提供拷貝構(gòu)造函數(shù)和賦值操作符,并且在析構(gòu)函數(shù)中釋放資源。
值得重視的是C++中的慣用法RAII。RAII核心思想是利用對(duì)象來(lái)管理資源,在對(duì)象的構(gòu)造函數(shù)中獲取資源,在其析構(gòu)函數(shù)中釋放資源[2]。為了保證動(dòng)態(tài)申請(qǐng)的內(nèi)存能在即使出現(xiàn)異常的情況下仍能釋放,比較理想的方法是使用局部變量來(lái)管理動(dòng)態(tài)內(nèi)存的所有權(quán)(ownership),就是所謂的智能指針。STL中的auto_ptr就是為解決資源所有權(quán)問(wèn)題設(shè)計(jì)的,但是缺少對(duì)引用數(shù)和數(shù)組的支持并且不能用在STL容器中。Boost庫(kù)[3]提供的智能指針相對(duì)成熟,實(shí)用價(jià)值高。其中,shared_ptr線程安全并且可以用在STL容器中。具體示例參考文獻(xiàn)[3]。
1.1 編碼規(guī)范檢查工具 CodeWizard
CodeWizard能夠?qū)υ闯绦蛑苯舆M(jìn)行自動(dòng)掃描、分析和檢查。一旦發(fā)現(xiàn)違例,產(chǎn)生信息告知與哪條規(guī)則不符并作出解釋。以CodeWizard 4.3 為例,其中內(nèi)置了超過(guò)500條編碼標(biāo)準(zhǔn)。CodeWizard可以選擇對(duì)于當(dāng)前的工程執(zhí)行哪些編碼標(biāo)準(zhǔn)。CodeWizard可以和VC++緊密集成,安裝完畢以后,VC++中有CodeWizard工具條。
1.2 代碼檢查工具 PC-Lint
PC-Lint可檢查編譯器不易發(fā)現(xiàn)的錯(cuò)誤。PC-Lint可對(duì)100多個(gè)C庫(kù)函數(shù)進(jìn)行檢查,可以發(fā)現(xiàn)標(biāo)準(zhǔn)C/C++代碼中的1 000多個(gè)常見(jiàn)錯(cuò)誤。要把PC-lint和Visual Studio集成在一起,需要自己配置。Jon Zyzyck提供了一個(gè)報(bào)告生成器,可以幫助完成這個(gè)工作??稍趆ttp://www.ddj.com下載。文獻(xiàn)[4]說(shuō)明了如何在VC++環(huán)境中集成PC-Lint。
2 利用語(yǔ)言機(jī)制、開(kāi)發(fā)環(huán)境和相關(guān)工具以預(yù)防和發(fā)現(xiàn)內(nèi)存缺陷
發(fā)現(xiàn)問(wèn)題是解決問(wèn)題的前提。相對(duì)于修復(fù)內(nèi)存缺陷,發(fā)現(xiàn)內(nèi)存缺陷并準(zhǔn)確定位導(dǎo)致缺陷的代碼更為費(fèi)時(shí)費(fèi)力。及早準(zhǔn)確地發(fā)現(xiàn)內(nèi)存缺陷,對(duì)于提高開(kāi)發(fā)效率非常重要。
2.1 利用斷言及早暴露內(nèi)存缺陷
斷言是布爾調(diào)試語(yǔ)句,用來(lái)檢測(cè)在程序運(yùn)行的時(shí)候某一條件的值是否總為真。斷言經(jīng)常用來(lái)確認(rèn)函數(shù)的輸入、輸出,檢查對(duì)象的當(dāng)前狀態(tài)是否合法等。 在以下的場(chǎng)景使用斷言可以幫助發(fā)現(xiàn)和內(nèi)存非法訪問(wèn)相關(guān)的錯(cuò)誤:
(1)驗(yàn)證指針是否可讀/寫(xiě)。在函數(shù)的入口處,經(jīng)常需要驗(yàn)證指針?biāo)赶虻膬?nèi)容區(qū)域是否可讀/寫(xiě)。 通常采用assert(p!= NULL)的檢測(cè)形式。 但是,指針的值不為空并不代表指針指向了合法可讀/寫(xiě)內(nèi)存。Win32 API提供了函數(shù)IsBadReadPtr、IsBadWritePtr、IsBadStringPtr、IsBadCodePtr用來(lái)檢測(cè)指針指向的內(nèi)存區(qū)域是否可讀/寫(xiě)。C運(yùn)行時(shí)庫(kù)提供了_CrtIs ValidPointer、_CrtIsValidHeapPointer等函數(shù),MFC庫(kù)提供了AfxIsValidAddress、AfxIsValidString函數(shù)來(lái)完成類似功能。
(2)對(duì)基于MFC的程序,ASSERT_VALID宏通過(guò)調(diào)用重載的AssertValid函數(shù)來(lái)確定指向CObject派生類對(duì)象的指針是否有效。ASSERT_VALID宏主要調(diào)用了AfxIsValidAddress函數(shù)和CObject派生類對(duì)象的AssertValid函數(shù)(參考MFC源代碼afx.h、objcore.cpp)。
2.2 利用C運(yùn)行時(shí)刻庫(kù)檢查內(nèi)存泄漏
VC++的C運(yùn)行庫(kù)(CRT)提供了廣泛的功能,幫助用戶檢測(cè)內(nèi)存泄漏。CRT提供了_CrtMemCheckPoint、_CrtDump MemoryLeaks、_CrtSetDbgFlag等函數(shù)來(lái)幫助調(diào)試內(nèi)存泄漏。
對(duì)于非MFC的工程, 要開(kāi)啟有效的內(nèi)存泄漏報(bào)告功能, 需要進(jìn)行如下設(shè)置:
(1)在StdAfx.h的頭部添加如下代碼并開(kāi)啟編譯器/Yu 選項(xiàng):
#define _CRTDBG_MAP_ALLOC #include <stdlib.h> #include <crtdbg.h> #define DEBUG_NEW new(_NORMAL_BLOCK, THIS_FILE, __LINE__)
#include "stdafx.h" #ifdef _DEBUG #define new DEBUG_NEW #undef THIS_FILE static char THIS_FILE[] = __FILE__; #endif
聯(lián)系客服