pm_get_program_mythread_mx and pm_get_program_mythread_mm Subroutines

Purpose

Retrieves the Performance Monitor settings in counter multiplexing mode and multi-mode for the calling thread.

Library

Performance Monitor APIs Library (libpmapi.a)

Syntax

#include <pmapi.h>

int pm_get_program_mythread_mx (*prog)
pm_prog_mx_t *prog;

int pm_get_program_mythread_mm (*prog_mm)
pm_prog_mm_t *prog_mm;

Description

The pm_get_program_mythread_mx and the pm_get_program_mythread_mm subroutines retrieve the Performance Monitor settings for the calling kernel thread. This includes mode information and the events being counted, which are in an array of lists of event identifiers. The event identifiers come from the lists returned by the pm_initialize subroutine.

When counting in multiplexing mode, the mode is global to all of the events lists. When counting in multi-mode, a mode is associated with each event list.

Counting mode includes the user mode, the kernel mode, and the current counting state.

If the list includes an event that can be used with a threshold (as indicated by the pm_init subroutine), a threshold value is also returned.

The user application must free the allocated array to store the event lists ( the events_set field in the prog parameter).

Parameters

Item	Description
*prog	Returns which Performance Monitor events and modes are set. It supports the following modes: PM_USER Counting processes running in User Mode. PM_KERNEL Counting processes running in Kernel Mode. PM_COUNT Counting is On.
*prog_mm	Returns which Performance Monitor events and associated modes are set. It supports the following modes: PM_USER Counting processes running in User Mode. PM_KERNEL Counting processes running in Kernel Mode. PM_COUNT Counting is On. PM_PROCTREE Counting that applies only to the calling processes and its descendants. The PM_PROCTREE mode and the PM_COUNT mode are common to all modes set.

Item

Description

*prog

Returns which Performance Monitor events and modes are set. It supports the following modes:

PM_USER: Counting processes running in User Mode.
PM_KERNEL: Counting processes running in Kernel Mode.
PM_COUNT: Counting is On.

*prog_mm

Returns which Performance Monitor events and associated modes are set. It supports the following modes:

PM_USER: Counting processes running in User Mode.
PM_KERNEL: Counting processes running in Kernel Mode.
PM_COUNT: Counting is On.
PM_PROCTREE: Counting that applies only to the calling processes and its descendants.

The PM_PROCTREE mode and the PM_COUNT mode are common to all modes set.

Return Values

Item	Description
0	No errors occurred.
Positive error code	See the pm_error Subroutine to decode the error code.

Error Codes

See the pm_error Subroutine.

Files

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