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

// 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.


/// API for controlling overall statistics collection.
///
/// NOTE: Do not call `pause()` and `resume()` close together; for small workloads, use frames.
pub struct StatisticCollectionControl;

impl StatisticCollectionControl
{
	/// Pauses collection of statistics.
	#[inline(always)]
	pub fn pause()
	{
		unsafe { __itt_pause() }
	}

	/// Resumes collection of statistics after pause (or after application started running).
	#[inline(always)]
	pub fn resume()
	{
		unsafe { __itt_resume() }
	}

	/// Permanently stops collection of statistics.
	#[inline(always)]
	pub fn detach()
	{
		unsafe { __itt_detach() }
	}

	/// No statistics will be collected for the current thread.
	#[inline(always)]
	pub fn ignore_current_thread()
	{
		unsafe { __itt_thread_ignore() }
	}

	/// Applies a name to the current thread.
	///
	/// Must not contain ASCII NUL.
	#[cfg(unix)]
	#[inline(always)]
	pub fn name_current_thread(name: &str)
	{
		let name = CString::new(name).unwrap();
		unsafe { __itt_thread_set_name(name.as_ptr()) }
	}

	/// Applies a name to the current thread.
	///
	/// Must not contain ASCII NUL.
	#[cfg(windows)]
	#[inline(always)]
	pub fn name_current_thread(name: &str)
	{
		let name = CString::new(name).unwrap();
		unsafe { __itt_thread_set_nameA(name.as_ptr()) }
	}
}