PerfMon::MemStats Struct Reference

placeholder for the stats More...

#include <MemStatsHooks.h>

Collaboration diagram for PerfMon::MemStats:

Static Public Member Functions
static bool	enable (const bool flag)
	switch to enable or disable the global malloc hooks More...
static void	installHooks ()
	install our hooks More...
static void	uninstallHooks ()
	uninstall our hooks More...
static void	saveHooks ()
	save current hooks More...
static bool	enabled ()
	return the current flag value More...
static unsigned long long	nbytes ()
	return the number of bytes allocated so far More...
static unsigned long long	nmallocs ()
	return the number of times malloc has been called so far More...
static unsigned long long	nfrees ()
	return the number of times free has been called so far More...
static void	start ()
	initialize library More...
static void	stop ()
	finalize library More...

Static Public Attributes
static std::atomic< bool >	m_enabled = false
	flag disabling or enabling the global malloc hooks More...
static unsigned long long m_nbytes	ATLAS_THREAD_SAFE
	number of bytes allocated so far More...
static unsigned long long m_nmallocs	ATLAS_THREAD_SAFE
	number of times malloc has been called so far More...
static unsigned long long m_nfrees	ATLAS_THREAD_SAFE
	number of times free has been called so far More...

Detailed Description

placeholder for the stats

Definition at line 32 of file MemStatsHooks.h.

Member Function Documentation

enable()

static bool PerfMon::MemStats::enable ( const bool  flag )

inlinestatic

switch to enable or disable the global malloc hooks

Returns

the old value of the flag

Definition at line 48 of file MemStatsHooks.h.

  {
    bool old_value = m_enabled;
    m_enabled = flag;
    return old_value;
  }

enabled()

static bool PerfMon::MemStats::enabled ( )

inlinestatic

return the current flag value

Definition at line 65 of file MemStatsHooks.h.

{ return m_enabled; }

installHooks()

void PerfMon::MemStats::installHooks ( )

static

install our hooks

Definition at line 100 of file MemStatsHooks.cxx.

{
#if HAVE_MALLOC_HOOKS
  __free_hook    = pmon_mem_free;
  __realloc_hook = pmon_mem_realloc;
  __malloc_hook  = pmon_mem_malloc;
#endif
  pthread_mutex_unlock(&pmon_mem_lock);
}

nbytes()

static unsigned long long PerfMon::MemStats::nbytes ( )

inlinestatic

return the number of bytes allocated so far

Definition at line 67 of file MemStatsHooks.h.

{ return m_nbytes; }

nfrees()

static unsigned long long PerfMon::MemStats::nfrees ( )

inlinestatic

return the number of times free has been called so far

Definition at line 71 of file MemStatsHooks.h.

{ return m_nfrees; }

nmallocs()

static unsigned long long PerfMon::MemStats::nmallocs ( )

inlinestatic

return the number of times malloc has been called so far

Definition at line 69 of file MemStatsHooks.h.

{ return m_nmallocs; }

saveHooks()

void PerfMon::MemStats::saveHooks ( )

static

save current hooks

Definition at line 120 of file MemStatsHooks.cxx.

{
#if HAVE_MALLOC_HOOKS
  // store old hooks in buffer for reset later
  // prevent storing ourselves in case of a double-call by user
  if ( __malloc_hook != pmon_mem_malloc ) {
    orig_malloc = __malloc_hook;
  }
 
  if ( __realloc_hook != pmon_mem_realloc ) {
    orig_realloc = __realloc_hook;
  }
 
  if ( __free_hook != pmon_mem_free ) { 
    orig_free = __free_hook;
  }
#endif
 
  return;
}

start()

void PerfMon::MemStats::start ( )

static

initialize library

Definition at line 70 of file MemStatsHooks.cxx.

{
  if (0 != pthread_mutex_init(&pmon_mem_lock, NULL)) {
    throw std::runtime_error("perfmon: could not initialize pthread mutex");
  }
  pthread_mutex_lock(&pmon_mem_lock);
  saveHooks();
  if (PerfMon::MemStats::m_enabled) {
    installHooks();
  } else {
    // installHooks unlocks the mutex...
    pthread_mutex_unlock(&pmon_mem_lock);
  }
}

stop()

void PerfMon::MemStats::stop ( )

static

finalize library

Definition at line 85 of file MemStatsHooks.cxx.

{
  // we actually don't want to ever un-install the hooks as
  // this might break daisy chains of hooks: if our hooks were installed first
  // uninstalling them will put the NULL ones back in, and won't give a chance
  // for later-registered hooks to do their properly afterwards.
 
  // if (PerfMon::MemStats::m_enabled) {
  //   uninstallHooks();
  // }
  if (0 != pthread_mutex_destroy(&pmon_mem_lock)) {
    throw std::runtime_error("perfmon: could not destroy pthread mutex");
  }
}

uninstallHooks()

void PerfMon::MemStats::uninstallHooks ( )

static

uninstall our hooks

Definition at line 110 of file MemStatsHooks.cxx.

{
  pthread_mutex_lock(&pmon_mem_lock);
#if HAVE_MALLOC_HOOKS
  __free_hook    = orig_free;
  __realloc_hook = orig_realloc;
  __malloc_hook  = orig_malloc;
#endif
}

Member Data Documentation

ATLAS_THREAD_SAFE [1/3]

unsigned long long m_nbytes PerfMon::MemStats::ATLAS_THREAD_SAFE

static

number of bytes allocated so far

Definition at line 38 of file MemStatsHooks.h.

ATLAS_THREAD_SAFE [2/3]

unsigned long long m_nmallocs PerfMon::MemStats::ATLAS_THREAD_SAFE

static

number of times malloc has been called so far

Definition at line 41 of file MemStatsHooks.h.

ATLAS_THREAD_SAFE [3/3]

unsigned long long m_nfrees PerfMon::MemStats::ATLAS_THREAD_SAFE

static

number of times free has been called so far

Definition at line 44 of file MemStatsHooks.h.

m_enabled

std::atomic< bool > PerfMon::MemStats::m_enabled = false

static

flag disabling or enabling the global malloc hooks

Definition at line 35 of file MemStatsHooks.h.

---

The documentation for this struct was generated from the following files:

• MemStatsHooks.h
• MemStatsHooks.cxx