Technical Reference: Base Operating System and Extensions, Volume 1

pm_get_data_group and pm_get_tdata_group Subroutine

Purpose

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

Library

Performance Monitor APIs Library (libpmapi.a)

Syntax

#include <pmapi.h>

int pm_get_data_group (pid,  tid,  *pmdata)
pid_t pid;
tid_t tid;
pm_data_t *pmdata;

int pm_get_tdata_group (pid, tid, *pmdata, *time)
pm_data_t *pmdata;
pid_t pid;
tid_t tid;
timebasestruct_t *time;

Description

The pm_get_data_group subroutine retrieves the current Performance Monitor data for the counting group to which a target kernel thread belongs. The thread must be stopped and must be part of a debuggee process under the control of the calling process.

The pm_get_tdata_group subroutine retrieves the current Performance Monitor data for the counting group to which a target thread belongs, and a timestamp indicating the last time the hardware counters were read.

The Performance Monitor data is always a set (one per hardware counter on the machine used) of 64-bit values. The information returned also includes the characteristics of the group, such as the number of its members, if it is a process level group, and if its counters are consistent with the sum of the counters for all of the threads in the group.

Parameters

pid	Process identifier of a target thread. The target process must be an argument of a debug process.
tid	Thread identifier of a target thread.
*pmdata	Pointer to a structure to return the Performance Monitor data for the group to which the target thread belongs.
*time	Pointer to a structure containing the timebase value the last time the hardware Performance Monitoring counters were read. This can be converted to time using the time_base_to_time subroutine.

Return Values

0	No errors occurred.
Positive error code	Refer to the pm_error (pm_error Subroutine) subroutine to decode the error code.

Error Codes

Refer to the pm_error (pm_error Subroutine) subroutine.

Files

/usr/include/pmapi.h

Defines standard macros, data types, and subroutines.

Related Information

The pm_init (pm_init Subroutine) subroutine, pm_error (pm_error Subroutine) subroutine, pm_set_program_group (pm_set_program_group Subroutine) subroutine, pm_get_program_group (pm_get_program_group Subroutine) subroutine, pm_get_data_group (pm_get_data_group and pm_get_tdata_group Subroutine) subroutine, pm_start_group (pm_start_group Subroutine) subroutine, pm_stop_group (pm_stop_group Subroutine) subroutine, pm_reset_data_group (pm_reset_data_group Subroutine) subroutine.

read_real_time or time_base_to_time Subroutine in AIX 5L Version 5.2 Technical Reference: Base Operating System and Extensions Volume 2.

Performance Monitor API Programming Concepts in AIX 5L Version 5.2 Performance Tools Guide and Reference.