Namespaces
	anonymous_namespace{nvtx_helpers.cpp}

Classes
struct	CategoryInfo

Enumerations
enum	Category { Category::kNone, Category::kDebugTimer, Category::kQueryStateTimer, Category::kRenderLogger }

Functions
void	init ()

void	shutdown ()

const nvtxDomainHandle_t	get_omnisci_domain ()

void	omnisci_range_push (Category c, const char name, const char file)

void	omnisci_range_pop ()

nvtxRangeId_t	omnisci_range_start (Category c, const char *name)

void	omnisci_range_end (nvtxRangeId_t r)

void	omnisci_set_mark (Category c, const char *name)

void	name_current_thread (const char *name)

void	name_category (uint32_t category, const char *name)

void	name_domain_category (nvtxDomainHandle_t domain, uint32_t category, const char *name)

void	set_mark (const char *)

void	range_push (const char *)

void	range_pop ()

nvtxRangeId_t	range_start (const char *)

nvtxRangeId_t	range_start (const char *, uint32_t, uint32_t)

void	range_end (nvtxRangeId_t)

nvtxDomainHandle_t	create_domain (const char *)

void	destroy_domain (nvtxDomainHandle_t)

void	set_domain_mark (nvtxDomainHandle_t, const char *, uint32_t)

void	domain_range_push (nvtxDomainHandle_t, const char *, uint32_t, uint32_t)

void	domain_range_pop (nvtxDomainHandle_t)

Variables
static std::array < CategoryInfo, NUM_CATEGORIES >	g_category_infos = {}

static nvtxDomainHandle_t	g_omnisci_domain = nullptr

Enumeration Type Documentation

enum nvtx_helpers::Category

strong

Enumerator
kNone
kDebugTimer
kQueryStateTimer
kRenderLogger

Definition at line 38 of file nvtx_helpers.h.

38 { kNone, kDebugTimer, kQueryStateTimer, kRenderLogger };

nvtx_helpers::Category::kQueryStateTimer

nvtx_helpers::Category::kRenderLogger

nvtx_helpers::Category::kDebugTimer

import_export::RasterPointType::kNone

Function Documentation

nvtxDomainHandle_t nvtx_helpers::create_domain ( const char * )

inline

Definition at line 255 of file nvtx_helpers.h.

                                                      {
   return nullptr;
 }

void nvtx_helpers::destroy_domain ( nvtxDomainHandle_t )

inline

Definition at line 258 of file nvtx_helpers.h.

258 {}

void nvtx_helpers::domain_range_pop ( nvtxDomainHandle_t )

inline

Definition at line 261 of file nvtx_helpers.h.

261 {}

void nvtx_helpers::domain_range_push	(	nvtxDomainHandle_t	,
		const char *	,
		uint32_t	,
		uint32_t
	)

inline

Definition at line 260 of file nvtx_helpers.h.

260 {}

const nvtxDomainHandle_t nvtx_helpers::get_omnisci_domain ( )

Definition at line 73 of file nvtx_helpers.cpp.

References g_omnisci_domain.

                                               {
   return g_omnisci_domain;
 }

void nvtx_helpers::init ( )

inline

Definition at line 48 of file nvtx_helpers.cpp.

References CHECK_LT, g_category_infos, g_omnisci_domain, kDebugTimer, kQueryStateTimer, kRenderLogger, setup::name, and NUM_CATEGORIES.

Referenced by logger::init().

             {
   // The domain will be null if NVTX profiling is not enabled by the nsys launcher
   g_omnisci_domain = nvtxDomainCreateA("Omnisci");
   if (g_omnisci_domain) {
     auto create_category = [](Category c, const char* name, uint32_t color) {
       auto category_index = static_cast<uint32_t>(c);
       CHECK_LT(category_index, NUM_CATEGORIES);
       g_category_infos[category_index] = {category_index, color};
       nvtxDomainNameCategoryA(g_omnisci_domain, category_index, name);
     };
     // skip category 0 (none), as trying to modify it triggers errors during nsight
     // analysis
     create_category(Category::kDebugTimer, "DebugTimer", 0xFFB0E0E6);
     create_category(Category::kQueryStateTimer, "QueryStateTimer", 0xFF98FB98);
     create_category(Category::kRenderLogger, "RenderLogger", 0xFFEE8AA);
   }
 }

Here is the caller graph for this function:

void nvtx_helpers::name_category	(	uint32_t	category,
		const char *	name
	)

inline

Definition at line 239 of file nvtx_helpers.h.

239 {}

void nvtx_helpers::name_current_thread ( const char * name )

inline

Definition at line 147 of file nvtx_helpers.cpp.

References logger::thread_id().

                                            {
 #ifdef _WIN32
   uint32_t thread_id = GetCurrentThreadId();
 #else
 #ifdef SYS_gettid
   uint32_t thread_id = static_cast<uint32_t>(syscall(SYS_gettid));
 #else  // SYS_gettid
 #error "SYS_gettid unavailable on this system"
 #endif  // SYS_gettid
 #endif  // _WIN32
   nvtxNameOsThreadA(thread_id, name);
 }

Here is the call graph for this function:

void nvtx_helpers::name_domain_category	(	nvtxDomainHandle_t	domain,
		uint32_t	category,
		const char *	name
	)

inline

Definition at line 240 of file nvtx_helpers.h.

242 {}

void nvtx_helpers::omnisci_range_end ( nvtxRangeId_t r )

inline

Definition at line 134 of file nvtx_helpers.cpp.

References g_omnisci_domain.

                                         {
   if (g_omnisci_domain) {
     nvtxDomainRangeEnd(g_omnisci_domain, r);
   }
 }

void nvtx_helpers::omnisci_range_pop ( )

inline

Definition at line 119 of file nvtx_helpers.cpp.

References g_omnisci_domain.

Referenced by logger::DebugTimer::~DebugTimer(), and query_state::Timer::~Timer().

                          {
   if (g_omnisci_domain) {
     nvtxDomainRangePop(g_omnisci_domain);
   }
 }

Here is the caller graph for this function:

void nvtx_helpers::omnisci_range_push	(	Category	c,
		const char *	name,
		const char *	file
	)

inline

Definition at line 103 of file nvtx_helpers.cpp.

References nvtx_helpers::anonymous_namespace{nvtx_helpers.cpp}::filename(), g_omnisci_domain, nvtx_helpers::anonymous_namespace{nvtx_helpers.cpp}::make_omnisci_event(), and setup::name.

Referenced by query_state::Timer::Timer().

                                                                         {
   if (g_omnisci_domain) {
     if (file) {
       std::stringstream ss;
       ss << name;
       ss << " | " << filename(file);
       auto str = ss.str();
       auto event = make_omnisci_event(c, str.c_str());
       nvtxDomainRangePushEx(g_omnisci_domain, &event);
     } else {
       auto event = make_omnisci_event(c, name);
       nvtxDomainRangePushEx(g_omnisci_domain, &event);
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

nvtxRangeId_t nvtx_helpers::omnisci_range_start	(	Category	c,
		const char *	name
	)

inline

Definition at line 125 of file nvtx_helpers.cpp.

References g_omnisci_domain, and nvtx_helpers::anonymous_namespace{nvtx_helpers.cpp}::make_omnisci_event().

                                                                 {
   if (g_omnisci_domain) {
     auto event = make_omnisci_event(c, name);
     return nvtxDomainRangeStartEx(g_omnisci_domain, &event);
   } else {
     return nvtxRangeId_t{};
   }
 }

Here is the call graph for this function:

void nvtx_helpers::omnisci_set_mark	(	Category	c,
		const char *	name
	)

inline

Definition at line 140 of file nvtx_helpers.cpp.

References g_omnisci_domain, and nvtx_helpers::anonymous_namespace{nvtx_helpers.cpp}::make_omnisci_event().

                                                     {
   if (g_omnisci_domain) {
     auto event = make_omnisci_event(c, name);
     nvtxDomainMarkEx(g_omnisci_domain, &event);
   }
 }

Here is the call graph for this function:

void nvtx_helpers::range_end ( nvtxRangeId_t )

inline

Definition at line 253 of file nvtx_helpers.h.

Referenced by StringDictionaryProxy::TranslationMap< Datum >::setRangeEnd().

253 {}

Here is the caller graph for this function:

void nvtx_helpers::range_pop ( )

inline

Definition at line 246 of file nvtx_helpers.h.

246 {}

void nvtx_helpers::range_push ( const char * )

inline

Definition at line 245 of file nvtx_helpers.h.

245 {}

nvtxRangeId_t nvtx_helpers::range_start ( const char * )

inline

Definition at line 247 of file nvtx_helpers.h.

Referenced by StringDictionaryProxy::TranslationMap< Datum >::setRangeStart().

                                               {
   return nvtxRangeId_t{};
 }

Here is the caller graph for this function:

nvtxRangeId_t nvtx_helpers::range_start	(	const char *	,
		uint32_t	,
		uint32_t
	)

inline

Definition at line 250 of file nvtx_helpers.h.

                                                                   {
   return nvtxRangeId_t{};
 }

void nvtx_helpers::set_domain_mark	(	nvtxDomainHandle_t	,
		const char *	,
		uint32_t
	)

inline

Definition at line 259 of file nvtx_helpers.h.

259 {}

void nvtx_helpers::set_mark ( const char * )

inline

Definition at line 244 of file nvtx_helpers.h.

244 {}

void nvtx_helpers::shutdown ( )

inline

Definition at line 66 of file nvtx_helpers.cpp.

References g_omnisci_domain.

Referenced by logger::shutdown().

                 {
   if (g_omnisci_domain) {
     nvtxDomainDestroy(g_omnisci_domain);
     g_omnisci_domain = nullptr;
   }
 }

Here is the caller graph for this function:

Variable Documentation

std::array<CategoryInfo, NUM_CATEGORIES> nvtx_helpers::g_category_infos = {}

static

Definition at line 40 of file nvtx_helpers.cpp.

Referenced by init(), and nvtx_helpers::anonymous_namespace{nvtx_helpers.cpp}::make_omnisci_event().

nvtxDomainHandle_t nvtx_helpers::g_omnisci_domain = nullptr

static

Definition at line 41 of file nvtx_helpers.cpp.

Referenced by get_omnisci_domain(), init(), omnisci_range_end(), omnisci_range_pop(), omnisci_range_push(), omnisci_range_start(), omnisci_set_mark(), and shutdown().

Namespaces

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

Function Documentation

Variable Documentation