pm_set_program_mygroup_mx and pm_set_program_mygroup_mm Subroutines

Purpose

Sets Performance Monitor programmation in counter multiplexing mode and multi-mode for the calling thread and creates a counting group.

Library

Performance Monitor APIs Library (libpmapi.a)

Syntax

#include <pmapi.h>

int pm_set_program_mygroup_mx ( *prog)
pm_prog_mx_t *prog;


int pm_set_program_mygroup_mm (*prog_mm)
pm_prog_mm_t *prog_mm;

Description

The pm_set_program_mygroup_mx and pm_set_program_mygroup_mmsubroutines set the Performance Monitor programmation respectively in counter multiplexing mode or in multi-mode for the calling kernel thread.

The pm_set_program_mygroup_mx subroutine setting includes the list of event arrays to be counted and a mode in which to count. The mode is global to all of the event lists. The events to count are in an array of list of event identifiers.

The pm_set_program_mygroup_mm subroutine setting includes the list of the event arrays to be counted, and the mode in which to count each event array. A counting mode is defined for each event array.

The identifiers must be selected from the lists returned by the pm_initialize subroutine.

Both subroutines create a counting group, which includes the calling thread and any thread which it, or any of its descendants, will create in the future. Optionally, the group can be defined as also containing all the existing and future threads belonging to the calling process.

The counting mode for both subroutines includes the User Mode or the Kernel Mode, or both of them; the Initial Counting State. The defaults are set to Off for User Mode and Kernel Mode, and the initial default state is set to delay counting until the pm_start_mygroup subroutine is called.

When you use the pm_set_program_mygroup_mm subroutine for multi-mode counting, the Process Tree Mode and the Start Counting Mode are fixed by their values defined in the first programming set.

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

Parameters

Item Description
*prog Specifies the events and modes to use in Performance Monitor setup. The prog parameter supports the following modes:
PM_USER
Counts processes running in User Mode (default is set to Off).
PM_KERNEL
Counts processes running in Kernel Mode (default is set to Off).
PM_COUNT
Starts counting immediately (default is set to Not to Start Counting).
PM_PROCESS
Creates a process-level counting group.
*prog_mm Specifies the events and the associated modes to use in the Performance Monitor setup. The prog_mm parameter supports the following modes:
PM_USER
Counts processes running in the User Mode (default is set to Off).
PM_KERNEL
Counts processes running in the Kernel Mode (default is set to Off).
PM_COUNT
Starts counting immediately (default is set to Not to start counting).
PM_PROCTREE
Sets counting to On only for the calling process and its descendants (default is set to Off).

The PM_PROCTREE mode and the PM_COUNT mode defined in the first setting fix the value for the counting.

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.