UTDebugSymbolInfoCache.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_DEBUG_SYMBOL_INFO_CACHE_H_
#define _UT_DEBUG_SYMBOL_INFO_CACHE_H_

// \cond DOXYGEN_DOCUMENT_NEVER


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTMutex.h"
#include "UTLists.h"
#include "UTPath.h"
#include "UTDebugSymbolInfo.h"


//==================================================================================================
class DebugSymbolInfoCacheEntry_t
//==================================================================================================
: public BTreeNode_t< DebugSymbolInfoCacheEntry_t, const void* >
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                    DebugSymbolInfoCacheEntry_t(    const void* address,
                                                    const String_t* function_name,
                                                    uint offset_into_function,
                                                    uint line_number,
                                                    const Path_t* file_name );

    void            SetAddr(    DebugSymbolInfo_t* debug_symbol_info,
                                bool collect_file_name,
                                bool file_leaf_name_only );
    inline int      Compare(const void* address) const;
    inline          operator const void*() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    const void*     m_address;
    const String_t* m_function_name;
    uint            m_offset_into_function;
    uint            m_line_number;
    const Path_t*   m_file_name;
};


//==================================================================================================
class DebugSymbolFunctionName_t
//==================================================================================================
:   public String_t,
    public BTreeNode_t< DebugSymbolFunctionName_t, const utf8* >
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline      DebugSymbolFunctionName_t(const utf8* name);
};


//==================================================================================================
class DebugSymbolFileName_t
//==================================================================================================
:   public Path_t,
    public BTreeNode_t< DebugSymbolFileName_t, const utf8* >
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline      DebugSymbolFileName_t(const utf8* name);
};


//==================================================================================================
class DebugSymbolInfoCache_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                DebugSymbolInfoCache_t();
                ~DebugSymbolInfoCache_t();

    inline void Lock();
    inline void Unlock();
    bool        SetAddr(    DebugSymbolInfo_t* debug_symbol_info,
                            const void* address,
                            bool collect_file_name,
                            bool file_leaf_name_only );
    void        SetAddr(    const void* address,
                            const utf8* function_name,
                            uint offset_into_function,
                            uint line_number,
                            const utf8* file_name );

    void        ReleaseAll();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    Mutex_t                                                     m_mutex;
    OwnedBTree_t< DebugSymbolInfoCacheEntry_t, const void* >    m_symbols;
    OwnedBTree_t< DebugSymbolFunctionName_t, const utf8* >      m_function_names;
    OwnedBTree_t< DebugSymbolFileName_t, const utf8* >          m_file_names;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class DebugSymbolInfoCache_t
//===
//==================================================================================================
//==================================================================================================
inline void
DebugSymbolInfoCache_t::Lock()
{
    m_mutex.Lock();
}


inline void
DebugSymbolInfoCache_t::Unlock()
{
    m_mutex.Unlock();
}




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class DebugSymbolInfoCacheEntry_t
//===
//==================================================================================================
//==================================================================================================
inline int
DebugSymbolInfoCacheEntry_t::Compare(const void* address) const
{
    if(m_address < address)
        return -1;
    if(m_address > address)
        return 1;
    return 0;
}


inline
DebugSymbolInfoCacheEntry_t::operator const void*() const
{
    return m_address;
}




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class DebugSymbolFunctionName_t
//===
//==================================================================================================
//==================================================================================================
inline
DebugSymbolFunctionName_t::DebugSymbolFunctionName_t(const utf8* name)
: String_t(name)
{ }




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class DebugSymbolFileName_t
//===
//==================================================================================================
//==================================================================================================
inline
DebugSymbolFileName_t::DebugSymbolFileName_t(const utf8* name)
: Path_t(name)
{ }


// \endcond

#endif // _UT_DEBUG_SYMBOL_INFO_CACHE_H_