ncbi_safe_static.cpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/*  $Id: ncbi_safe_static.cpp 86668 2019-06-04 16:08:30Z sadyrovr $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:   Aleksey Grichenko
 *
 * File Description:
 *   Static variables safety - create on demand, destroy on termination
 *
 *   CSafeStaticGuard::      -- guarantee for CSafePtr<> and CSafeRef<>
 *                              destruction and cleanup
 *
 */
 
 
#include <ncbi_pch.hpp>
#include <corelib/ncbi_safe_static.hpp>
#include <corelib/ncbistd.hpp>
#include <corelib/ncbithr.hpp>
#include <corelib/ncbimtx.hpp>
#include <corelib/error_codes.hpp>
#include <memory>
#include <assert.h>
 
 
#define NCBI_USE_ERRCODE_X   Corelib_Static
 
 
BEGIN_NCBI_SCOPE
 
 
CSafeStaticLifeSpan::CSafeStaticLifeSpan(ELifeSpan span, int adjust)
    : CSafeStaticLifeSpan(eLifeLevel_Default, span, adjust)
{
}
 
CSafeStaticLifeSpan::CSafeStaticLifeSpan(ELifeLevel level, ELifeSpan span, int adjust)
    : m_LifeLevel(level),
      m_LifeSpan(int(span) + adjust)
{
    if (span == eLifeSpan_Min) {
        m_LifeSpan = int(span); // ignore adjustments
        adjust = 0;
    }
    if (adjust >= 5000  ||  adjust <= -5000) {
        ERR_POST_X(1, Warning
            << "CSafeStaticLifeSpan level adjustment out of range: "
            << adjust);
    }
    _ASSERT(adjust > -5000  &&  adjust < 5000);
}
 
 
CSafeStaticLifeSpan& CSafeStaticLifeSpan::GetDefault(void)
{
    static CSafeStaticLifeSpan s_DefaultSpan(eLifeSpan_Min);
    return s_DefaultSpan;
}
 
 
/////////////////////////////////////////////////////////////////////////////
//
//  CSafeStaticPtr_Base::
//
 
// Protective mutex and the owner thread ID to avoid
// multiple initializations and deadlocks
DEFINE_CLASS_STATIC_MUTEX(CSafeStaticPtr_Base::sm_ClassMutex);
 
 
int CSafeStaticPtr_Base::x_GetCreationOrder(void)
{
    static CAtomicCounter s_CreationOrder;
    return int(s_CreationOrder.Add(1));
}
 
 
CSafeStaticPtr_Base::~CSafeStaticPtr_Base(void)
{
    if ( x_IsStdStatic() ) {
        x_Cleanup();
    }
}
 
 
/////////////////////////////////////////////////////////////////////////////
//
//  CSafeStaticGuard::
//
 
// CSafeStaticGuard reference counter
int CSafeStaticGuard::sm_RefCount;
 
 
// CSafeStaticGuard reference counter
// On MSWin threads are killed before destruction of static objects in DLLs, so in
// most cases this check is useless.
#if defined(NCBI_WIN32_THREADS)
bool CSafeStaticGuard::sm_ChildThreadsCheck = false;
#else
bool CSafeStaticGuard::sm_ChildThreadsCheck = true;
#endif
 
 
CSafeStaticGuard::CSafeStaticGuard(void)
{
    // Initialize the guard only once
    if (sm_RefCount == 0) {
        x_GetStack(CSafeStaticLifeSpan::eLifeLevel_Default) = new CSafeStaticGuard::TStack;
        x_GetStack(CSafeStaticLifeSpan::eLifeLevel_AppMain) = new CSafeStaticGuard::TStack;
    }
 
    sm_RefCount++;
}
 
 
void CSafeStaticGuard::DisableChildThreadsCheck()
{
    sm_ChildThreadsCheck = false;
}
 
 
void CSafeStaticGuard::Destroy(CSafeStaticLifeSpan::ELifeLevel level)
{
    CMutexGuard guard(CSafeStaticPtr_Base::sm_ClassMutex);
 
    // AppMain level variables are always destroyed before default level ones
    x_Cleanup(guard, x_GetStack(CSafeStaticLifeSpan::eLifeLevel_AppMain));
 
    if (level == CSafeStaticLifeSpan::eLifeLevel_Default) {
        x_Cleanup(guard, x_GetStack(CSafeStaticLifeSpan::eLifeLevel_Default));
    }
}
 
 
static CSafeStaticGuard* sh_CleanupGuard;
 
 
 
CSafeStaticGuard::~CSafeStaticGuard(void)
{
    CMutexGuard guard(CSafeStaticPtr_Base::sm_ClassMutex);
 
    // Protect CSafeStaticGuard destruction
    if ( sh_CleanupGuard ) {
        CSafeStaticGuard* tmp = sh_CleanupGuard;
        sh_CleanupGuard = 0;
        delete tmp;
    }
    // If this is not the last reference, then do not destroy stack
    if (--sm_RefCount > 0) {
        return;
    }
    assert(sm_RefCount == 0);
 
    if (sm_ChildThreadsCheck) {
        if (const auto tc = CThread::GetThreadsCount()) {
            string msg = "On static data destruction, child thread(s) still running: " + to_string(tc);
            ERR_POST_X(1, Error << msg);
            _ASSERT(CThread::GetThreadsCount() == 0);
        }
    }
 
    x_Cleanup(guard, x_GetStack(CSafeStaticLifeSpan::eLifeLevel_AppMain));
    x_Cleanup(guard, x_GetStack(CSafeStaticLifeSpan::eLifeLevel_Default));
}
 
 
void CSafeStaticGuard::x_Cleanup(CMutexGuard& guard, TStack*& stack)
{
    if (!stack) return;
 
    for ( int pass = 0; pass < 3; ++pass ) {
        // Call Cleanup() for all variables registered
        TStack cur_Stack;
        swap(cur_Stack, *stack);
        guard.Release();
        NON_CONST_ITERATE(TStack, it, cur_Stack) {
            (*it)->x_Cleanup();
        }
        guard.Guard(CSafeStaticPtr_Base::sm_ClassMutex);
    }
 
    delete stack;
    stack = nullptr;
}
 
 
// Global guard - to prevent premature destruction by e.g. GNU compiler
// (it destroys all local static variables before any global one)
static CSafeStaticGuard sg_CleanupGuard;
 
 
// Initialization of the guard
CSafeStaticGuard* CSafeStaticGuard::x_Get(void)
{
    // Local static variable - to initialize the guard
    // as soon as the function is called (global static
    // variable may be still uninitialized at this moment)
    static CSafeStaticGuard sl_CleanupGuard;
    if ( !sh_CleanupGuard )
        sh_CleanupGuard = new CSafeStaticGuard;
    return &sl_CleanupGuard;
}
 
 
END_NCBI_SCOPE