MFC中一个危险的Bug

Jakcie — Fri, 26 Mar 2010 14:15:00 GMT

上次说日本�v啸警报的时候，�E�序出错。在解析代码的时候，发现了MFC中的一个Bug�?/p>

一。问题的产生�?/p>

�q�个�E�序�Q�用来处理日本各�U�天气预报数据，包括灑֮�的预报。如果地震，台风之类的自然灾宛_��来，�E�序会把预报数据�q�行处理�Q�生成相应的警报信息�Q��ƈ在电视上面显�C�滚动的字幕来提�C�。程序本�w�，是几�q�前公司的其他�h写的。里面有涉及到文件读写的地方�Q�有很多地方�Q�用了MFC中自带的文�g��d��c�CStdioFile�?/p>

CStdioFile�q�个文�g��d��c�，估计大家都不陌生。这个类的父�c�，是CFile�c�R��CStdioFile�c�L��w�的功能也很��单。CStdioFile�c�L��一个成员函数是ReadString�Q�函数的定义如下�Q?/p>

    virtual LPTSTR ReadString(__out_ecount_z(nMax) LPTSTR lpsz, __in UINT nMax);
    virtual BOOL ReadString(CString& rString);

MSDN定义如下http://msdn.microsoft.com/library/x5t0zfyf(VS.80).aspx�Q?pre style="border-bottom: #cecece 1px solid; border-left: #cecece 1px solid; padding-bottom: 5px; background-color: #fbfbfb; min-height: 40px; padding-left: 5px; width: 650px; padding-right: 5px; height: 118px; overflow: auto; border-top: #cecece 1px solid; border-right: #cecece 1px solid; padding-top: 5px">

BOOL ReadString(CString& rString);

throw( CFileException );

Return Value

A pointer to the buffer containing the text data. NULL if end-of-file was reached without reading any data; or if boolean, FALSE if end-of-file was reached without reading any data.

ReadString函数能直接读取文本中的一行数据到CString中，很方�ѝ��读到文件结��，没有��d��M��数据的时候，�q�回FALSE。很��单的函数�Q�但恰恰是这个函数有Bug�?/p>

�E�序在处理数据的时候，会生成一些��时文�Ӟ��然后会读取这些��时文件中的数据，��d��操作�Q�正是用的CStdioFile的ReadString函数。读取流�E�很��单：

while(dFile.ReadString(Str_temp))
{
    doSomething();
}

当时的现象�ؓ�Q�读取到最后一行，��L��直接�q�回FALSE�Q�怎么也读不出最后一行来。看了看文�

二。发现问题所�?/p>

军_��看看MFC的代码再说。做了个��单的��试�E�序�Q�跟到MFC代码里一看，果然是MFC的问题！

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
可以看到�Q�ReadString的底层，是用fgets来读取文件的。在内部�Q�每�ơ读�?28个字�W�到CString中，然后 �q�里���q��出问题所在了�Q?176个字�W�，正好�?28�?7倍！也就是说�Q?font color="#ff0000">只

g的最后一行，包含2176个字�W�的数据�Q�没有换行符。没有�Q何异常啊。当时没惛_��是MFC的Bug�Q�因��Z��前有�q�样那样的毛病，多数是预报数据本�w�有问题�Q�所以这�ơ也是先分析数据了。分析来分析去，没发现这�ơ的数据有什么异常。后来发现如果最后一行的文�g不是2176个字�W�，���p��正常��d��来。奇了怪了�Q?176也不是什么特�D�长度啊。实验了几次后，觉的是在不对劌Ӏ�莫非是MFC的Bug�Q?/p> ���试代码如下�Q?/p>
    CStdioFile  dFile; dFile.Open("text.txt",CFile::modeRead); CString str; while (dFile.ReadString(str) != FALSE ) { printf("%s", str); } dFile.Close(); 12px">
 据的问题，���是MFC代码本��n的Bug�?/p> 1px solid; padding-bottom: 5px; background-color: #fbfbfb; min-height: 40px; padding-left: 5px; width: 650px; padding-right: 5px; overflow: auto; border-top: #cecece 1px solid; border-right: #cecece 1px solid; padding-top: 5px">BOOL CStdioFile::ReadString(CString& rString) 12px">{ ASSERT_VALID(this); 12px">
    rString = &afxChNil;    // empty string without deallocating const int nMaxSize = 128;  //临时字符串的长度 LPTSTR lpsz = rString.GetBuffer(nMaxSize);  //保存每次��d��到的字符串到CString�?/span> LPTSTR lpszResult;  //指向每次��d��的字�W�串 int nLen = 0; for (;;) { lpszResult = _fgetts(lpsz, nMaxSize+1, m_pStream); //��d��操作 rString.ReleaseBuffer(); 12px">
        // handle error/eof case if (lpszResult == NULL && !feof(m_pStream)) { clearerr(m_pStream); AfxThrowFileException(CFileException::generic, _doserrno, m_strFileName); } 12px">
        // if string is read completely or EOF if (lpszResult == NULL || (nLen = lstrlen(lpsz)) < nMaxSize || lpsz[nLen-1] == '\n') break; 12px">
        nLen = rString.GetLength(); lpsz = rString.GetBuffer(nMaxSize + nLen) + nLen; //位置后移 } 12px">
    // remove '\n' from end of string if present lpsz = rString.GetBuffer(0); nLen = rString.GetLength(); if (nLen != 0 && lpsz[nLen-1] == '\n') // 最后结果中�Q�去掉回车符 rString.GetBufferSetLength(nLen-1); 12px">
    return lpszResult != NULL;  // �q�里���是Bug的关键。返回��g��对！ 12px">}
 位置后移�Q�反复读�?28个字�W�，直到遇到回�R�W�或者文件结束。最后把回�R�W�去掉，�q�回一个CString。其中，lpszResult也指向每�ơ读出的字符丌Ӏ?/p> 要文�g最后一行是128倍数个字�W�，��׃��定会�q�回FALSE�?/strong>
��Z��么会�q�样呢，因�ؓReadString在每�ơ读�?28个字�W�的时候，用lpszResult指向��d��到的字符丌Ӏ�如果读满了128个字�W�，���q���l�读�Q�如果读到的字符不够128个，那么���q��束读取�?/font>

当一行数据正好�ؓ128的倍数�Q�又没有回�R�W�的时候，会发生什么呢�Q�比如最后一行数据是128个，那么�Q�读一��?28个字�W�，会���l�读下一�ơ，但是下一�ơ的��d���Q�什么也没有��d���Q�lpszResult���指向NULL�Q�最后的�q�回��|��是return lpszResult != NULL; 所以返回FALSE�?/font>

但之前读到的128个字�W�，已经在CString里面了�?/font>也就是说实际上读取已�l�成功了�Q�但�q�是�q�回了FALSE。返回��g��恰当�Q?/font>

Bug的描�q�ͼ�当文件的最后一行数据，正好�?28的倍数个字�W�的时候，�?/font>ReadString��d���Q�一定会�q�回FALSE。但实际上读取是成功的，�q�回的CString中的数据是正���的�Q�（VC6.0中存在这个Bug�Q�VS2005中，没有�q�个Bug�Q?/font>

�q�个Bug�Q�只会媄响到最后一行数据。因为如果有换行�W�的存在�Q�lpszResult��׃��会�ؓNULL�?/font>

三。解��x���?/font>

要解册���个问题，也简单，修改一下判断ReadString成功与否的语句：
while (dFile.ReadString(str) != FALSE || str.GetLength() != 0)
在返回FALSE的情况下�Q�CString的长度不�?�Q�就不算��d����p�|。或者这�?
if(!dFile.ReadString(str) && str.GetLength() == 0)
在返回FALSE�q�且CString的长度�ؓ0�Q�则���读取失败，否则���是��d��成功�?/p>
�q�个�E�序�Q�是用VC6.0做的�Q�我有看了看VC2005中的代码�Q�发现这个Bug被修复了�Q�代码如下：
BOOL CStdioFile::ReadString(CString& rString)
{
    ASSERT_VALID(this);
    rString = _T("");    // empty string without deallocating
    const int nMaxSize = 128;
    LPTSTR lpsz = rString.GetBuffer(nMaxSize);
    LPTSTR lpszResult;
    int nLen = 0;
    for (;;)
    {
        lpszResult = _fgetts(lpsz, nMaxSize+1, m_pStream);
        rString.ReleaseBuffer();
        // handle error/eof case
        if (lpszResult == NULL && !feof(m_pStream))
        {
            Afx_clearerr_s(m_pStream);
            AfxThrowFileException(CFileException::genericException, _doserrno,
                m_strFileName);
        }
        // if string is read completely or EOF
        if (lpszResult == NULL ||
            (nLen = (int)lstrlen(lpsz)) < nMaxSize ||
            lpsz[nLen-1] == '\n')
            break;
        nLen = rString.GetLength();
        lpsz = rString.GetBuffer(nMaxSize + nLen) + nLen;
    }
    // remove '\n' from end of string if present
    lpsz = rString.GetBuffer(0);
    nLen = rString.GetLength();
    if (nLen != 0 && lpsz[nLen-1] == '\n')
        rString.GetBufferSetLength(nLen-1);
    return nLen != 0; //�q�回值变了！
}
我们看到�Q�VC2005中，��d��部分的代码与VC6.0中的代码完全一栗���不一��L��地方只是�q�回值的部分。VC2005的ReadString中，�q�回��gؓ
return nLen != 0;
也就是说�Q�只要读出的CString的长度不�?��׃ؓ��d��成功。与我修改后的方法完全一致。就�q�样向客戯���释，然后修改了。悲剧的是，几年前所有程序中所有��用ReadString函数的地方，都要�q�行修改。。�?/p>
MFC的这个Bug比较隐蔽�Q���^�怸��Ҏ��发现�Q�但一旦遇到特�D�长度的数据�Q�就会表现异常。所以，在用VC6.0开发的时候，���量避免使用ReadString�Q�或者在使用中，多判断一步读取出来的CString长度。避开�q�个Bug�?/p>

Jakcie 2010-03-26 22:15 发表评论

国产亚洲日本欧美韩国,亚洲一区二区免费,国产一区二区三区在线观看视频

MFC中一个危险的Bug