IsTprofSupported

Returns whether or not time-based TProf is supported.

Syntax

int IsTprofSupported(void);

Parameters

None

Return Values

Zero

Time-based TProf is not supported.

Non-zero

Time-based TProf is supported.

Remarks

None

IsEventTprofSupported

Returns whether or not event-based TProf is supported.

Syntax

int IsEventTprofSupported(void);

Parameters

None

Return Values

Zero

Event-based TProf is not supported.

Non-zero

Event-based TProf is supported.

Remarks

None

IsTprofActive

Returns whether or not TProf (event or time-based) is currently active/in use.

Syntax

int IsTprofActive(void);

Parameters

None

Return Values

Zero

TProf is not active.

Non-zero

TProf is active.

Remarks

None

IsItraceSupported

Returns whether or not ITrace (Instruction Tracing) is supported.

Syntax

int IsItraceSupported(void);

Parameters

None

Return Values

Zero

ITrace is not supported.

Non-zero

ITrace is supported.

Remarks

None

IsRmssSupported

Returns whether or not RMSS (Reduced Memory Set Simulator) is supported.

Syntax

int IsRmssSupported(void);

Parameters

None

Return Values

Zero

RMSS is not supported.

Non-zero

RMSS is supported.

Remarks

None

IsAiSupported

Returns whether or not AI (Above Idle/CPU Utilization) measurement is supported.

Syntax

int IsAiSupported(void);

Parameters

None

Return Values

Zero

CPU Utilization measurement is not supported.

Non-zero

CPU Utilization measurement is supported.

Remarks

None

IsAiActive

Returns whether or not AI (Above Idle/CPU Utilization) measurement is currently active/in use.

Syntax

int IsAiActive(void);

Parameters

None

Return Values

Zero

CPU Utilization measurement is not active.

Non-zero

CPU Utilization measurement is active.

Remarks

None

IsCpiSupported

Returns whether or not CPI (Cycles Per Instruction) measurement is supported.

Syntax

int IsCpiSupported(void);

Parameters

None

Return Values

Zero

CPI measurement is not supported.

Non-zero

CPI measurement is active.

Remarks

None

IsPttSupported

Returns whether or not PTT (Per-Thread Time) measurement is supported.

Syntax

int IsPttSupported(void);

Parameters

None

Return Values

Zero

PTT measurement is not supported.

Non-zero

PTT measurement is supported.

Remarks

None

IsPttActive

Returns whether or not PTT (Per-Thread Time) measurement is currently active/in use.

Syntax

int IsPttActive(void);

Parameters

None

Return Values

Zero

PTT measurement is not active.

Non-zero

PTT measurement is active.

Remarks

None

IsPttActiveForCurrentProcess

Returns whether or not PTT (Per-Thread Time) measurement is currently active/in use for the current process.

Syntax

int IsPttActiveForCurrentProcess(void);

Parameters

None

Return Values

Zero

PTT measurement is not active for the current process.

Non-zero

PTT measurement is active for the current process.

Remarks

None

IsPttActiveForProcess

Returns whether or not PTT (Per-Thread Time) measurement is currently active/in use for the requested process (identified by its process id).

Syntax

int IsPttActiveForProcess(UINT32 pid);

Parameters

pid

Process id of requested process.

Return Values

Zero

PTT measurement is not active for the requested process.

Non-zero

PTT measurement is active for the requested process.

Remarks

None

IsCallstackSamplingSupported

Returns whether or not time-based Java Callstack Sampling is supported.

Syntax

int IsCallstackSamplingSupported(void);

Parameters

None

Return Values

Zero

Time-based callstack sampling is not supported.

Non-zero

Time-based callstack sampling is supported.

Remarks

None

IsEventCallstackSamplingSupported

Returns whether or not event-based Java Callstack Sampling is supported.

Syntax

int IsEventCallstackSamplingSupported(void);

Parameters

None

Return Values

Zero

Event-based callstack sampling is not supported.

Non-zero

Event-based callstack sampling is supported.

Remarks

None

IsCallstackSamplingActive

Returns whether or not Java Callstack Sampling (event or time-based) is currently active/in use.

Syntax

int IsCallstackSamplingActive(void);

Parameters

None

Return Values

Zero

Callstack sampling is not active.

Non-zero

Callstack sampling is active.

Remarks

None

IsCallstackSamplingActiveForProcess

Returns whether or not Java Callstack Sampling (event or time-based) is currently active/in use for the requested process (identified by its process id).

Syntax

int IsCallstackSamplingActiveForProcess(UINT32 pid);

Parameters

pid

Process id of requested process.

Return Values

Zero

Callstack sampling is not active for the requested process.

Non-zero

Callstack sampling is active for the requested process.

Remarks

None

IsPerfCtrAccessSupported

Returns whether or not access to the hardware Performance Counters is supported.

Syntax

int IsPerfCtrAccessSupported(void);

Parameters

None

Return Values

Zero

Performance counter access is not supported.

Non-zero

Performance counter access is supported.

Remarks

None

IsPerfCtrEventAccessSupported

Returns whether or not access to the hardware Performance Counter Event is supported. Events are completely managed by PerfUtil thus removing the need for the user to know the details necessary to configure the performance counter controls.

Syntax

int IsPerfCtrEventAccessSupported(void);

Parameters

None

Return Values

Zero

Performance counter event access is not supported.

Non-zero

Performance counter event access is supported.

Remarks

None

AreInterruptHooksSupported

Returns whether or not the driver supports hooking hardware interrupts.

Syntax

int AreInterruptHooksSupported(void);

Parameters

None

Return Values

Zero

Interrupt hooking is not supported.

Non-zero

Interrupt hooking is supported.

Remarks

None

AreInterruptsHooked

Returns whether or not the driver has inserted the hardware interrupt hooks.

Syntax

int AreInterruptsHooked(void);

Parameters

None

Return Values

Zero

Interrupts are not currently hooked.

Non-zero

Interrupts are currently hooked.

Remarks

None

IsDispatchHookSupported

Returns whether or not the driver supports hooking the OS dispatcher/scheduler.

Syntax

int IsDispatchHookSupported(void);

Parameters

None

Return Values

Zero

Dispatcher hooking is not supported.

Non-zero

Dispatcher hooking is supported.

Remarks

None

IsDispatcherHooked

Returns whether or not the driver has inserted the dispatcher hook.

Syntax

int IsDispatcherHooked(void);

Parameters

None

Return Values

Zero

Dispatcher is not currently hooked.

Non-zero

Dispatcher is currently hooked.

Remarks

None

IsVirtualMachine    [Windows]

Returns whether or not the driver thinks the OS is running in a virtual machine.

Syntax

int IsVirtualMachine(void);

Parameters

None

Return Values

Zero

Not running in a virtual machine.

Non-zero

Running in a virtual machine.

Remarks

Certain hardware facilities are not virtualized by the VMM thus not allowing the tools to provide full functionality. For example, hardware performance counters are not virtualized. As such, when running in a virtual machine the tools will not be able to count events. The host OS exposes the counter values as zero so any attempt to read a counter always returns zero as the counter value. Tools that rely on counter values (event-based TProf, PTT, etc.) will not function correctly.

GetSystemAddressRangeStart    [Windows]

Returns the address of the beginning of the system (OS) address space. User-mode applications cannot access memory in the system address space.

Syntax

void * GetSystemAddressRangeStart(void);

Parameters

None

Return Values

NULL

Error. Unable to determine system address space start address.

Non-NULL

Address of the beginning of the system address space.

Remarks

None