mallocTag.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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 <atomic>
#include <cstdlib>
#include <cstdint>
#include <iosfwd>
#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;          
        };

        // Note: enum below must be kept in sync with tfmodule/mallocCallTree.h

        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;

        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 + _PushImpl(std::forward<Strs>(nameN)...)
                     : 0) {}

        inline void Release() {
            while (_nTags--) {
                TfMallocTag::_End(_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(); }
        
        template <class Str, class... Strs>
        int _PushImpl(Str &&tag, Strs &&... rest) {
            TfMallocTag::_Begin(_CStr(std::forward<Str>(tag)), _threadData);
            return 1 + _PushImpl(std::forward<Strs>(rest)...);
        }

        int _PushImpl() {
            // Recursion termination base-case.
            return 0;
        }
        
        _ThreadData* _threadData;
        int _nTags;

        friend class TfMallocTag;
    };

    // A 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;

    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(_ThreadData *threadData = nullptr);

    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 */                                            \
    inline void* operator new(::std::size_t, void* ptr) {                     \
        return ptr;                                                           \
    }                                                                         \
                                                                              \
    inline void* operator new(::std::size_t s) {                              \
        PXR_NS::TfAutoMallocTag tag(name1, name2);                            \
        return malloc(s);                                                     \
    }                                                                         \
                                                                              \
    inline void* operator new[](::std::size_t s) {                            \
        PXR_NS::TfAutoMallocTag tag(name1, name2);                            \
        return malloc(s);                                                     \
    }                                                                         \
                                                                              \
    /* Required due to the placement-new override above. */                   \
    inline void operator delete(void* ptr, void* place) {}                    \
                                                                              \
    inline void operator delete(void* ptr, size_t) {                          \
        free(ptr);                                                            \
    }                                                                         \
                                                                              \
    inline void operator delete[] (void* ptr, size_t) {                       \
        free(ptr);                                                            \
    }                                                                         \

#endif