pm_stop_group and pm_tstop_group Subroutine

Purpose

Stops Performance Monitor counting for the group to which a target thread belongs.

Library

Performance Monitor APIs Library (libpmapi.a)

Syntax

#include <pmapi.h>

int pm_stop_group ( pid,  tid)
pid_t pid;
tid_t tid;

int pm_tstop_group ( pid,  tid, *time )
pid_t pid;
tid_t tid;
timebasestruct_t *time;

Description

This subroutine supports only the 1:1 threading model. It has been superseded by the pm_stop_pgroup subroutine, which supports both the 1:1 and the M:N threading models. A call to this subroutine is equivalent to a call to the pm_stop_pgroup subroutine with a ptid parameter equal to 0.

The pm_stop_group subroutine stops Performance Monitor counting for a target kernel thread, the counting group to which it belongs, and all the other thread members of the same group. Counting stops immediately for all the threads in the counting group. The target thread must be stopped and must be part of a debuggee process, under control of the calling process.

The pm_tstop_group subroutine stops Performance Monitor counting for a target kernel thread, the counting group to which it belongs, and all the other thread members of the same group, and returns a timestamp indicating when the counting was stopped.

Parameters

Item Description
pid Process ID of target thread. Target process must be a debuggee of the caller process.
tid Thread ID of target thread.
*time Pointer to a structure containing the timebase value when the counting was stopped. This can be converted to time using the time_base_to_time subroutine.

Return Values

Item Description
0 Operation completed successfully.
Positive error code Refer to the pm_error Subroutine to decode the error code.

Error Codes

Refer to the pm_error Subroutine.

Files

Item Description
/usr/include/pmapi.h Defines standard macros, data types, and subroutines.