pm_disable_bhrb Subroutine

Purpose

Disables all Branch History Rolling Buffer (BHRB) related instructions such as clrbhrb and mfbhrb in problem state.

Note: The pm_disable_bhrb subroutine can only be called when the thread mode is 1:1 and when counting for the thread is not started.

Library

Performance Monitor APIs Library (libpmapi.a)

Syntax

#include <pmapi.h>
int pm_disable_bhrb (void)

Description

The pm_disable_bhrb subroutine disables the BHRB instructions like clrbhrb and mfbhrb in problem state.

If the BHRB instructions are disabled in the problem state, the Facility Unavailable interrupt is generated when these instructions are used in the problem state.

Return Values

If unsuccessful, a value other than zero is returned and a positive error code is set. If successful, a value of zero is returned.

Error Codes

The subroutine is unsuccessful if the following is true:

Item Description
Pmapi_NoInit The pm_initialize subroutine is not called.
Pmapi_NoSetProg The pm_set_program subroutine is not called.
Other non-zero error codes Returned by the pmsvcs subroutine.

Files

The pmapi.h file defines standard macros, data types, and subroutines.