PAPIC:PAPI assign eventset component.3
From PAPIDocs
Jump to: navigation, search


NAME

  • PAPI_assign_eventset_component - assign a component index to an existing but empty EventSet

Synopsis

C Interface

#include <papi.h>
PAPI_assign_eventset_component (int EventSet, int cidx);

Description

PAPI_assign_eventset_component() assigns a specific component index, as specified by cidx, to a new EventSet identified by EventSet, as obtained from PAPI_create_eventset (3). EventSets are ordinarily automatically bound to components when the first event is added. This routine is useful to explicitly bind an EventSet to a component before setting component related options.

Arguments

EventSet -- An integer identifier for an existing EventSet cidx -- An integer identifier for a component. By convention, component 0 is always the cpu component.

Errors

PAPI_ENOCMP The argument cidx is not a valid component.

PAPI_ENOEVST The EventSet doesn't exist.

PAPI_ENOMEM Insufficient memory to complete the operation.

Examples

int EventSet = PAPI_NULL;
if (PAPI_create_eventset(&EventSet) != PAPI_OK)
handle_error(1);
/* Bind our EventSet to the cpu component */
if (PAPI_assign_eventset_component(EventSet, 0) != PAPI_OK)
handle_error(1);
/* Convert our EventSet to multiplexing */
if (PAPI_set_multiplex(EventSet) != PAPI_OK)
handle_error(1);

Bugs

This function has no known bugs.

See Also

PAPI_set_opt(3), PAPI_create_eventset(3), PAPI_add_events(3), PAPI_set_multiplex(3)