log4cplus-master and log4cplus-1.2.x When calling a static library, will crash.

[CruiseYoung]

log4cplusS.lib
log4cplusSD.lib
log4cplusSU.lib
log4cplusSUD.lib

project use any one of those static library, it will crash.

crash address:
file: log4cplus-1.2.x\src\loglevel.cxx line48

line45-63

#define DEF_LL_STRING(_logLevel)                                        \
static tstring const & _logLevel ## _STRING ()                          \
{                                                                       \
    static tstring const str (LOG4CPLUS_TEXT (#_logLevel));             \
    return str;                                                         \
}

DEF_LL_STRING (OFF)
DEF_LL_STRING (FATAL)
DEF_LL_STRING (ERROR)
DEF_LL_STRING (WARN)
DEF_LL_STRING (INFO)
DEF_LL_STRING (DEBUG)
DEF_LL_STRING (TRACE)
DEF_LL_STRING (ALL)
DEF_LL_STRING (NOTSET)
DEF_LL_STRING (UNKNOWN)

#undef DEF_LL_STRING

line117-129

void
initializeLogLevelStrings ()
{
    OFF_STRING();
    FATAL_STRING();
    ERROR_STRING();
    WARN_STRING();
    INFO_STRING();
    DEBUG_STRING();
    TRACE_STRING();
    ALL_STRING();
    NOTSET_STRING();
}

[wilx]

Are you trying to log anything before main() starts? What is the failure call stack? What variable and/or member is not valid that it crashes?

[CruiseYoung]

The reason:
file: log4cplus-1.2.x\src\loglevel.cxx line48

line45-63

#define DEF_LL_STRING(_logLevel)                                        \
static tstring const & _logLevel ## _STRING ()                          \
{                                                                       \
    static tstring const str (LOG4CPLUS_TEXT (#_logLevel));             \
    return str;                                                         \
}

DEF_LL_STRING (OFF)
DEF_LL_STRING (FATAL)
DEF_LL_STRING (ERROR)
DEF_LL_STRING (WARN)
DEF_LL_STRING (INFO)
DEF_LL_STRING (DEBUG)
DEF_LL_STRING (TRACE)
DEF_LL_STRING (ALL)
DEF_LL_STRING (NOTSET)
DEF_LL_STRING (UNKNOWN)

#undef DEF_LL_STRING

<====>

static tstring const & OFF_STRING () { static tstring const str ("OFF"); return str; }
static tstring const & FATAL_STRING () { static tstring const str ("FATAL"); return str; }
static tstring const & ERROR_STRING () { static tstring const str ("ERROR"); return str; }
static tstring const & WARN_STRING () { static tstring const str ("WARN"); return str; }
static tstring const & INFO_STRING () { static tstring const str ("INFO"); return str; }
static tstring const & DEBUG_STRING () { static tstring const str ("DEBUG"); return str; }
static tstring const & TRACE_STRING () { static tstring const str ("TRACE"); return str; }
static tstring const & ALL_STRING () { static tstring const str ("ALL"); return str; }
static tstring const & NOTSET_STRING () { static tstring const str ("NOTSET"); return str; }
static tstring const & UNKNOWN_STRING () { static tstring const str ("UNKNOWN"); return str; }

Expression: _CrtIsValidHeapPointer(pUserData)

(MSDN):
The _CrtIsValidHeapPointer function is used to ensure that a specific memory address is within the 
local heap. The “local” heap refers to the heap created and managed by a particular instance of the 
C run-time library. If a dynamically linked library (DLL) contains a static link to the run-time library, 
then it has its own instance of the run-time heap, and therefore its own heap, independent of the 
application’s local heap. When _DEBUG is not defined, calls to _CrtIsValidHeapPointer are removed 
during preprocessing.

fix method 1:

Project:log4cplusS -->Properties-->Configuration Properties-->C++-->Code Generation
-->Runtime Library: 
Multi-threaded Debug DLL (/MDd)     change to Multi-threaded Debug (/MTd)
Multi-threaded DLL (/MD)        change to Multi-threaded (/MT)

or fix method 2:

#define DEF_LL_STRING(_logLevel)                                        \
static tstring const & _logLevel ## _STRING ()                          \
{                                                                       \
    static tstring const str (LOG4CPLUS_TEXT (#_logLevel));             \
    return str;                                                         \
}

change to

#define DEF_LL_STRING(_logLevel)                                        \
     static tstring const gs_str ## _logLevel (LOG4CPLUS_TEXT (#_logLevel));             \
static tstring const & _logLevel ## _STRING ()                          \
{                                                                       \
    return gs_str ## _logLevel;                                                         \
}

[wilx]

OK, I can reproduce it. Your second fix method is basically reverting to the prior state which was problematic because of globals initialization order fiasco issues. Your first option is undesirable because we rely on APC being called to initialize log4cplus outside loader lock which works only if the C run time library is a DLL and not statically linked in.

TBH, I do not get why the debugger triggers at all.

[wilx]

OK, a heap corruption error. But that does not make much sense either.

[snikulov]

Same issue is relevant for 1.1.x branch.
Example project https://github.com/snikulov/boost.app.cmake \src\server_app.cpp
Visual Studio 2012 64 bit target

[wilx]

I have thought about this and I could not come up with any kind of solution that would reliably work. I am inclined to just document that using log4cplus before main() is not support and be done with that.

[snikulov]

Actually log4cplus called inside main() in my case. Do you document that static library should not be used at all?

[wilx]

Actually log4cplus called inside main() in my case. Do you document that static library should not be used at all?

I misunderstood. I guess I could revert 439414a to see if it fixes at least your issue.

[snikulov]

Yes, checkout to 3ed66ea will solve the issue.

[wilx]

I have reverted most of 439414a in 4574f0c on master. It does fix the problem for me when I test with thread_testS.

[wilx]

It should be fixed on 1.2.x branch by cc04567.

[wilx]

I have made the change for 1.1.x as well in 758a4b2.