UT_ArenaInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_ArenaInfo.h
 *
 * COMMENTS:
 *      This is a simple interface to mallinfo or some alternative
 *      if this is not available.
 */

#ifndef __UT_ArenaInfo__
#define __UT_ArenaInfo__

#include "UT_API.h"

#include <SYS/SYS_Allocator.h>

#include <stddef.h>
#include <iosfwd>

class UT_StringHolder;
class UT_WorkBuffer;

class UT_API UT_ArenaInfo
{
public:
    // Arena size is a bit old school.  Just use totalInUse.
    static size_t       arenaSize();
    static size_t       totalInUse();

    /// Print memory/arena usage to the stream (with a terminating new line)
    static void         outputUsage(std::ostream &os, const bool output_in_bytes=false,
                                    const bool debug=false);

    /// Print memory usage into a work buffer (without terminating new line)
    static void         outputUsage(UT_WorkBuffer &wbuf, const bool in_bytes=false,
                                    const bool debug=false);

    static bool         usingCustomAllocator();
    static UT_StringHolder
                        customAllocatorName();

    static void         configureCustomAllocator();

    static bool         customAllocatorTestDisabled();

    static UT_StringHolder
                        customAllocatorTestDisabledMessage();

    static void         setThreadIdle();
    static void         setThreadBusy();

    static void         releaseAllUnusedMemory();

private:
#if defined(SYS_ALLOCATOR_TCMALLOC)
    /// Returns true if the current session has successfully bound tcmalloc.
    static bool usingTCMalloc();

    /// Set our config options for tcmalloc. Note that this should be (re)done
    /// after forking since some options may be reset.
    static void configureTCMalloc();
#elif defined(SYS_ALLOCATOR_MIMALLOC)
    /// Returns true if the current session has successfully bound mimalloc.
    static bool usingMIMalloc();

    /// Set our config options for mimalloc. Note that this should be (re)done
    /// after forking since some options may be reset.
    static void configureMIMalloc();
#else
    /// Returns true if the current session has successfully bound
    /// JE Malloc.
    static bool usingJEMalloc();

    /// Set our config options for jemalloc. Note that this should be (re)done
    /// after forking since some options may be reset.
    static void configureJEMalloc();
#endif
};

#endif /* __UT_ArenaInfo__ */