intel-seapi 0.3.1

Mid-level wrapper for Intel Single Event API (SEAPI) and ittnotify, as used by Intel VTune
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

// This file is part of intel-seapi. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/intel-seapi/master/COPYRIGHT. No part of intel-seapi, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2018 The developers of intel-seapi. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/intel-seapi/master/COPYRIGHT.


/// Represents a 'Domain'.
///
/// Can never be destroyed or free'd.
///
/// Available to any thread, irrespective of which thread created it.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Domain(NonNull<__itt_domain>);

impl<'a> From<&'a str> for Domain
{
	#[inline(always)]
	fn from(name: &'a str) -> Self
	{
		Self::new(name)
	}
}

impl Domain
{
	/// Name can be almost anything (although it must not contain ASCII NUL), but a URI or Java-like style of `com.my_company.my_application` is recommended by Intel.
	///
	/// Call is thread-safe.
	#[cfg(unix)]
	#[inline(always)]
	pub fn new(name: &str) -> Self
	{
		let name = CString::new(name).unwrap();
		let inner = unsafe { __itt_domain_create(name.as_ptr()) };
		assert!(!inner.is_null());
		Domain(unsafe { NonNull::new_unchecked(inner)})
	}

	/// Name can be almost anything (although it must not contain ASCII NUL), but a URI or Java-like style of `com.my_company.my_application` is recommended by Intel.
	///
	/// Call is thread-safe.
	#[cfg(windows)]
	#[inline(always)]
	pub fn new(name: &str) -> Result<Self, ()>
	{
		let name = CString::new(name).unwrap();
		let inner = unsafe { __itt_domain_createA(name.as_ptr()) };
		if inner.is_null()
		{
			Err(())
		}
		else
		{
			Ok(Domain(unsafe { NonNull::new_unchecked(inner)}))
		}
	}

	/// Begins a task.
	#[inline(always)]
	pub fn begin_task<'a, 'b, 's>(&'a self, name: &'s StringHandle, parent: Option<IdentifierInstance<'b>>) -> Task<'a>
	{
		Task::begin(self, name, parent)
	}

	/// Begins a frame instance.
	#[inline(always)]
	pub fn begin_frame<'a>(&'a self) -> Frame<'a>
	{
		Frame::begin(Left(self))
	}

	/// Is collection of any statistics associated with this domain enabled?
	#[inline(always)]
	pub fn is_enabled(&self) -> bool
	{
		(unsafe { read_volatile(&self.0.as_ref().flags) }) == 1
	}

	/// Is collection of any statistics associated with this domain disabled?
	#[inline(always)]
	pub fn is_disabled(&self) -> bool
	{
		(unsafe { read_volatile(&self.0.as_ref().flags) }) == 0
	}

	/// Disable collection of any statistics associated with this domain.
	#[inline(always)]
	pub fn disable(&mut self)
	{
		unsafe { write_volatile(&mut self.0.as_mut().flags, 0) }
	}

	/// Enable collection of any statistics associated with this domain.
	///
	/// Domains, when created using `new()`, are already enabled.
	#[inline(always)]
	pub fn enable(&mut self)
	{
		unsafe { write_volatile(&mut self.0.as_mut().flags, 1) }
	}

	#[inline(always)]
	fn constant_pointer(&self) -> *const __itt_domain
	{
		self.0.as_ptr() as *const _
	}
}