amrex::TinyProfiler Class Reference

A simple profiler that returns basic performance information (e.g. min, max, and average running time) More...

#include <AMReX_BLProfiler.H>

Public Member Functions
	TinyProfiler (std::string funcname) noexcept
	TinyProfiler (std::string funcname, bool start_) noexcept
	TinyProfiler (std::string funcname, bool start_, bool gpu_sync_) noexcept
	TinyProfiler (const char *funcname) noexcept
	TinyProfiler (const char *funcname, bool start_) noexcept
	TinyProfiler (const char *funcname, bool start_, bool gpu_sync_) noexcept
	~TinyProfiler ()
	TinyProfiler (TinyProfiler const &)=delete
	TinyProfiler (TinyProfiler &&)=delete
TinyProfiler &	operator= (TinyProfiler const &)=delete
TinyProfiler &	operator= (TinyProfiler &&)=delete
void	start ()
void	stop ()
void	memory_start () const noexcept
void	memory_stop () const noexcept

Static Public Member Functions
static const char *	CurrentName () noexcept
	Without the tiny profiler, there is no active profiler.
static MemStat *	memory_alloc (std::size_t nbytes, std::map< std::string, MemStat > &memstats) noexcept
static void	memory_free (std::size_t nbytes, MemStat *stat) noexcept
static void	Initialize ()
static void	Finalize (bool bFlushing=false)
static void	MemoryInitialize ()
static void	MemoryFinalize (bool bFlushing=false)
static bool	RegisterArena (const std::string &memory_name, std::map< std::string, MemStat > &memstats) noexcept
static void	DeregisterArena (std::map< std::string, MemStat > &memstats) noexcept
static void	StartRegion (std::string regname) noexcept
static void	StartRegion (std::string regname, bool gpu_sync) noexcept
static void	StopRegion (const std::string &regname) noexcept
static void	PrintCallStack (std::ostream &os)
static const char *	CurrentName () noexcept
	Name of the innermost active profiler, or nullptr if there is none.
static void	PrintMemoryUsage (std::ostream *os, bool only_local) noexcept

Detailed Description

A simple profiler that returns basic performance information (e.g. min, max, and average running time)

Constructor & Destructor Documentation

TinyProfiler() [1/8]

amrex::TinyProfiler::TinyProfiler ( std::string  funcname )

explicitnoexcept

TinyProfiler() [2/8]

amrex::TinyProfiler::TinyProfiler ( std::string  funcname, bool  start_  )

noexcept

TinyProfiler() [3/8]

amrex::TinyProfiler::TinyProfiler ( std::string  funcname, bool  start_, bool  gpu_sync_  )

noexcept

TinyProfiler() [4/8]

amrex::TinyProfiler::TinyProfiler ( const char *  funcname )

explicitnoexcept

TinyProfiler() [5/8]

amrex::TinyProfiler::TinyProfiler ( const char *  funcname, bool  start_  )

noexcept

TinyProfiler() [6/8]

amrex::TinyProfiler::TinyProfiler ( const char *  funcname, bool  start_, bool  gpu_sync_  )

noexcept

~TinyProfiler()

amrex::TinyProfiler::~TinyProfiler

(

)

TinyProfiler() [7/8]

amrex::TinyProfiler::TinyProfiler ( TinyProfiler const &  )

delete

TinyProfiler() [8/8]

amrex::TinyProfiler::TinyProfiler ( TinyProfiler &&  )

delete

Member Function Documentation

CurrentName() [1/2]

const char * amrex::TinyProfiler::CurrentName ( )

inlinestaticnoexcept

Without the tiny profiler, there is no active profiler.

CurrentName() [2/2]

static const char * amrex::TinyProfiler::CurrentName ( )

staticnoexcept

Name of the innermost active profiler, or nullptr if there is none.

Unlike PrintCallStack, this can be called from any thread while the profiled code is running, e.g., from a watchdog or status reporting thread, and it is async-signal-safe. Profilers started by threads other than the OpenMP master thread are not tracked.

The returned string stays valid until amrex::Finalize. Do not call this concurrently with amrex::Finalize.

DeregisterArena()

void amrex::TinyProfiler::DeregisterArena ( std::map< std::string, MemStat > &  memstats )

staticnoexcept

Finalize()

void amrex::TinyProfiler::Finalize ( bool  bFlushing = false )

static

Initialize()

void amrex::TinyProfiler::Initialize ( )

static

memory_alloc()

MemStat * amrex::TinyProfiler::memory_alloc ( std::size_t  nbytes, std::map< std::string, MemStat > &  memstats  )

staticnoexcept

memory_free()

void amrex::TinyProfiler::memory_free ( std::size_t  nbytes, MemStat *  stat  )

staticnoexcept

memory_start()

void amrex::TinyProfiler::memory_start ( ) const

noexcept

memory_stop()

void amrex::TinyProfiler::memory_stop ( ) const

noexcept

MemoryFinalize()

void amrex::TinyProfiler::MemoryFinalize ( bool  bFlushing = false )

static

MemoryInitialize()

void amrex::TinyProfiler::MemoryInitialize ( )

static

operator=() [1/2]

TinyProfiler & amrex::TinyProfiler::operator= ( TinyProfiler &&  )

delete

operator=() [2/2]

TinyProfiler & amrex::TinyProfiler::operator= ( TinyProfiler const &  )

delete

PrintCallStack()

void amrex::TinyProfiler::PrintCallStack ( std::ostream &  os )

static

PrintMemoryUsage()

void amrex::TinyProfiler::PrintMemoryUsage ( std::ostream *  os, bool  only_local  )

staticnoexcept

RegisterArena()

bool amrex::TinyProfiler::RegisterArena ( const std::string &  memory_name, std::map< std::string, MemStat > &  memstats  )

staticnoexcept

start()

void amrex::TinyProfiler::start

(

)

StartRegion() [1/2]

void amrex::TinyProfiler::StartRegion ( std::string  regname )

staticnoexcept

StartRegion() [2/2]

void amrex::TinyProfiler::StartRegion ( std::string  regname, bool  gpu_sync  )

staticnoexcept

stop()

void amrex::TinyProfiler::stop

(

)

StopRegion()

void amrex::TinyProfiler::StopRegion ( const std::string &  regname )

staticnoexcept

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_BLProfiler.H
• /home/runner/work/amrex/amrex/Src/Base/AMReX_TinyProfiler.H
• /home/runner/work/amrex/amrex/Src/Base/AMReX_TinyProfiler.cpp