我的日志模块线程安全吗?

Is my logging-module thread safe?

本文关键字:安全 线程 日志 模块 我的      更新时间:2023-10-16

伙计们,我是一个线程和日志的初学者。顺便说一句,我的母语不是英语,所以如果我的英语有任何错误,请原谅我。

我创建了一个多线程软件,其中每个线程使用日志模块,如下所示:每个线程使用不同的日志文件,所以我认为发生数据冲突的几率是0。
__inline void print_logW(int _level,const wchar_t *domain,const wchar_t *msg)
{
    wchar_t mess[200] = _T("");
    if(_level<=traceLevel)
    {
        __time64_t timer;
        struct tm t_st;
        _time64(&timer);
        localtime_s(&t_st,&timer);
        if (domain == NULL)
        {
            domain = _T("");
        }
        if (msg != NULL)
        {
            if (showTimeStampFlag == true)
            {
                swprintf_s(mess,200,_T("%s : %ld"),msg,GetTickCount());
            }
            else
            {
                wcscpy_s(mess,200,msg);
            }
        }
        if(oldTime.tm_year != t_st.tm_year || oldTime.tm_mon != t_st.tm_mon || oldTime.tm_mday != t_st.tm_mday) 
        {
            oldTime = t_st;
            print_log_preparebyDateW();
        }

        FILE* fp;
        errno_t err = _wfopen_s(&fp, this->m_pathW, _T("at+, ccs=UTF-8"));
        if (err != 0)
        {
            // error
            return;
        }
        fwprintf_s(fp, m_logFormatW,
            _level,
            1900 + t_st.tm_year, t_st.tm_mon + 1, t_st.tm_mday,
            t_st.tm_hour, t_st.tm_min, t_st.tm_sec,
            domain, mess
            );
        fflush(fp);
        fclose(fp);
    }
}

当我看到我所做的软件的日志时,我发现了一个问题,有时线程进程变得如此缓慢(通常只需要16 ms max的进程(例如获取图像的指针),将需要0.2秒或更多时间来完成)。我还在调查这个问题的原因,但首先,我想知道日志模块是否已经是线程安全的。

顺便说一下,对于参数,
"_level"是打印或取消打印进程细节的日志级别
我使用"domain"来显示执行日志记录的类
"msg"为日志内容,如:"进程1已启动")

m_logFormatW
m_logFormatW = _T("[%.2d][%.4d-%.2d-%.2dT%.2d:%.2d:%.2d][%s] %sn");

如有任何问题或不清楚之处,请提出来。

只要你链接到多线程运行时库和oldTime不是一个全局或静态变量,你的日志函数将是线程安全的。如果oldTime是全局变量或静态变量,则在访问或修改它时需要序列化对它的访问,否则可能会出现竞争条件。可能不是线程安全的唯一其他事情是print_log_preparebyDateW,但很难说,因为您还没有包含它的代码。只要oldTime不是全局的或静态的,并且你使用的所有运行时库函数都被标记为线程安全的,或者是MSDN中标记为线程安全的库的一部分,你就可以了。

我能看到的唯一的其他问题是当你打开文件。如果文件已经打开,而另一个线程试图记录信息,则打开调用将失败,导致信息丢失。这是因为_wfopen_s在没有任何共享模式的情况下打开文件。您可以通过使用std::mutex并在文件打开时锁定它并在文件关闭后解锁它来修复此问题。

您的工作线程执行时间比预期长一个可能的原因是打开日志文件、写入信息、刷新文件和关闭它可能会花费一些额外的时间。这种情况在文件I/O发生的任何时候都可能发生,即使涉及到缓存。通常,您可以通过打开日志文件一次,然后在应用程序终止时关闭它来减少时间。

减少工作线程执行时间的另一个可能的解决方案是使用管道。在这个场景中,您将日志文本写入管道,并有一个额外的线程从管道中读取并写入日志文件。这将消除工作线程记录信息时可能发生的任何磁盘I/O。在某些情况下,如果管道已满,日志记录可能会花费一些额外的时间,但这种情况不会经常发生。

您的方法适用于单线程应用程序,但不适用于多线程环境,因为您没有序列化日志消息请求。

你最好看看一些开源的写得很好的日志类,比如

a) AsynchronousAndSynchronouslogger - http://www.codeproject.com/Articles/288827/g2log-An-efficient-asynchronous-logger-using-Cplus

b) Simplethreadsafe - http://cpplogging.codeplex.com/

c) Log4Cpp - http://log4cpp.sourceforge.net/