mallocTag.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_MALLOC_TAG_H
#define PXR_BASE_TF_MALLOC_TAG_H
 
#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"
#include "pxr/base/arch/hints.h"
 
#include <atomic>
#include <cstdlib>
#include <cstdint>
#include <iosfwd>
#include <new>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
struct Tf_MallocPathNode;
 
class TfMallocTag {
public:
    struct CallStackInfo;
 
    struct CallTree {
        struct PathNode {
            size_t nBytes,        
                   nBytesDirect;  
            size_t nAllocations;  
            std::string siteName; 
            std::vector<PathNode>
                        children; 
        };
 
        struct CallSite {
            std::string name;       
            size_t nBytes;          
        };
 
        enum PrintSetting {
            TREE = 0,                   
            CALLSITES,                  
            BOTH                        
        };
 
 
 
        TF_API
        std::string GetPrettyPrintString(PrintSetting setting = BOTH,
                                         size_t maxPrintedNodes = 100000) const;
 
        TF_API
        void Report(
            std::ostream &out,
            const std::string &rootName) const;
 
        TF_API
        void Report(
            std::ostream &out) const;
 
        TF_API
        bool LoadReport(
            std::istream &in);
 
 
 
        std::vector<CallSite> callSites;
 
        PathNode root;
 
        std::vector<CallStackInfo> capturedCallStacks;
    };
 
    struct CallStackInfo
    {
        std::vector<uintptr_t> stack;
 
        size_t size;
 
        size_t numAllocations;
    };
 
    TF_API static bool Initialize(std::string* errMsg);
 
    static bool IsInitialized() {
        return TfMallocTag::_isInitialized;
    }
 
    TF_API static size_t GetTotalBytes();
 
    TF_API static size_t GetMaxTotalBytes();
 
    TF_API static bool GetCallTree(CallTree* tree, bool skipRepeated = true);
 
private:
 
    struct _ThreadData;
 
public:
 
    class Auto {
    public:
        Auto(const Auto &) = delete;
        Auto& operator=(const Auto &) = delete;
 
        Auto(Auto &&) = delete;
        Auto& operator=(Auto &&) = delete;
 
        template <class Str, class... Strs>
        explicit Auto(Str &&name1, Strs &&... nameN)
            : _threadData(TfMallocTag::_Push(_CStr(std::forward<Str>(name1))))
            , _nTags(_threadData ? 1 + sizeof...(Strs) : 0) {
            if (_threadData) {
                (..., TfMallocTag::_Begin(
                    _CStr(std::forward<Strs>(nameN)), _threadData));
            }
        }
 
        inline void Release() {
            if (_threadData) {
                TfMallocTag::_End(_nTags, _threadData);
                _threadData = nullptr;
            }
        }
 
        inline ~Auto() {
            Release();
        }
 
    private:
 
        char const *_CStr(char const *cstr) const { return cstr; }
        char const *_CStr(std::string const &str) const { return str.c_str(); }
 
        _ThreadData* _threadData;
        int _nTags;
 
        friend class TfMallocTag;
    };
 
    // An historical compatibility: before Auto could accept only one argument,
    // so Auto2 existed to handle two arguments.  Now Auto can accept any number
    // of arguments, so Auto2 is just an alias for Auto.
    using Auto2 = Auto;
 
    // fwd for friendship.
    class StackOverride;
 
    class StackState {
    public:
        StackState() = default;
 
    private:
        explicit StackState(Tf_MallocPathNode *top) : _top(top) {}
 
        Tf_MallocPathNode *_top = nullptr;
 
        friend class TfMallocTag;
        friend class StackOverride;
    };
 
    class StackOverride {
    public:
        explicit StackOverride(StackState state)
            : _state(state)
            , _tls(state._top ? _Push() : nullptr) {}
 
        // Noncopyable, nonmovable.
        StackOverride(const StackOverride &) = delete;
        StackOverride &operator=(const StackOverride &) = delete;
 
        ~StackOverride() {
            if (ARCH_UNLIKELY(_tls)) {
                _Pop();
            }
        }
        
    private:
        TF_API _ThreadData *_Push() const;
        TF_API void _Pop() const;
    
        const StackState _state;
        _ThreadData *_tls;
    
        friend class TfMallocTag;
    };
 
    static StackState GetCurrentStackState() {
        return ARCH_UNLIKELY(TfMallocTag::_isInitialized)
            ? _GetCurrentStackState() : StackState {};
    }
 
    static void Push(const std::string& name) {
        _Push(name.c_str());
    }
 
    static void Push(const char* name) {
        _Push(name);
    }
 
    static void Pop() {
        if (TfMallocTag::_isInitialized) {
            _End();
        }
    }
 
    TF_API static void SetDebugMatchList(const std::string& matchList);
 
    TF_API static void
    SetCapturedMallocStacksMatchList(const std::string& matchList);
 
    TF_API static std::vector<std::vector<uintptr_t> > GetCapturedMallocStacks();
 
private:
    friend struct _TemporaryDisabler;
 
    friend struct Tf_MallocGlobalData;
 
    static bool _Initialize(std::string* errMsg);
 
    static inline _ThreadData *_Push(char const *name) {
        if (TfMallocTag::_isInitialized) {
            return _Begin(name);
        }
        return nullptr;
    }
 
    TF_API static _ThreadData *_Begin(char const *name,
                                      _ThreadData *threadData = nullptr);
    TF_API static void _End(int nTags = 1, _ThreadData *threadData = nullptr);
 
    TF_API static StackState _GetCurrentStackState();
    
    static void* _MallocWrapper(size_t, const void*);
    static void* _ReallocWrapper(void*, size_t, const void*);
    static void* _MemalignWrapper(size_t, size_t, const void*);
    static void  _FreeWrapper(void*, const void*);
 
    friend class TfMallocTag::Auto;
    class Tls;
    friend class TfMallocTag::Tls;
    TF_API static std::atomic<bool> _isInitialized;
};
 
using TfAutoMallocTag = TfMallocTag::Auto;
 
using TfAutoMallocTag2 = TfMallocTag::Auto;
 
//
PXR_NAMESPACE_CLOSE_SCOPE                                                 
 
#define TF_MALLOC_TAG_NEW(name1, name2)                                       \
    /* this is for STL purposes */                                            \
    ARCH_ALWAYS_INLINE inline void* operator new(::std::size_t, void* ptr) {  \
        return ptr;                                                           \
    }                                                                         \
                                                                              \
    ARCH_ALWAYS_INLINE inline void* operator new(::std::size_t s) {           \
        PXR_NS::TfAutoMallocTag tag(name1, name2);                            \
        return ::operator new(s, std::nothrow);                               \
    }                                                                         \
                                                                              \
    ARCH_ALWAYS_INLINE inline void* operator new[](::std::size_t s) {         \
        PXR_NS::TfAutoMallocTag tag(name1, name2);                            \
        return ::operator new[](s, std::nothrow);                             \
    }                                                                         \
                                                                              \
    /* Required due to the placement-new override above. */                   \
    ARCH_ALWAYS_INLINE inline void operator delete(void* ptr, void* place) {} \
                                                                              \
    ARCH_ALWAYS_INLINE inline void operator delete(void* ptr, size_t) {       \
        ::operator delete(ptr, std::nothrow);                                 \
    }                                                                         \
                                                                              \
    ARCH_ALWAYS_INLINE inline void operator delete[] (void* ptr, size_t) {    \
        ::operator delete[](ptr, std::nothrow);                               \
    }                                                                         \
 
#endif