PAPI_set_multiplex(3)

πŸŽ€ NAME πŸŽ€

okay so bestie, welcome to the PAPI manual (section 3, iykyk) β€” this page is all about PAPI_set_multiplex, and it does exactly one iconic thing: it converts a standard event set to a multiplexed event set. periodt πŸ’…βœ¨


✨ SYNOPSIS ✨

πŸ’« Detailed Description πŸ’«

πŸŽ€ C Interface πŸŽ€

#include <papi.h>
 int PAPI_set_multiplex( int EventSet );

🫢 Parameters 🫢

  • EventSet β€” an integer handle for a PAPI event set as created by PAPI_create_eventset 🫢

πŸ’– Return values πŸ’–

  • PAPI_OK β€” ✨ the happy path ✨
  • PAPI_EINVAL β€” one or more of the arguments is invalid, or the EventSet is already multiplexed. 😭
  • PAPI_ENOCMP β€” the EventSet specified is not yet bound to a component.
  • PAPI_ENOEVST β€” the EventSet specified does not exist.
  • PAPI_EISRUN β€” the EventSet is currently counting events.
  • PAPI_ENOMEM β€” insufficient memory to complete the operation. πŸ’€

PAPI_set_multiplex converts a standard PAPI event set created by a call to PAPI_create_eventset into an event set capable of handling multiplexed events. The way that works is: you gotta do this after calling PAPI_multiplex_init, and either PAPI_add_event or PAPI_assign_eventset_component, but prior to calling PAPI_start(). no cap πŸ¦‹

Events can be added to an event set either before or after converting it into a multiplexed set, but the conversion must be done prior to using it as a multiplexed set. literally the glow-up has to happen before the main character moment, bestie πŸ’–

Note πŸŽ€ Multiplexing can't be enabled until PAPI knows which component is targeted. Due to the late binding nature of PAPI event sets, this only happens after adding an event to an event set or explicitly binding the component with a call to PAPI_assign_eventset_component. so yeah, PAPI needs the deets first πŸ”₯

πŸ§ͺ Example πŸ§ͺ

int EventSet = PAPI_NULL;
int ret;

// Create an empty EventSet
ret = PAPI_create_eventset(&EventSet);
if (ret != PAPI_OK) handle_error(ret);

// Bind it to the CPU component
ret = PAPI_assign_eventset_component(EventSet, 0);
if (ret != PAPI_OK) handle_error(ret);

// Check  current multiplex status
ret = PAPI_get_multiplex(EventSet);
if (ret == TRUE) printf("This event set is ready for multiplexing\n.")
if (ret == FALSE) printf("This event set is not enabled for multiplexing\n.")
if (ret < 0) handle_error(ret);

// Turn on multiplexing
ret = PAPI_set_multiplex(EventSet);
if ((ret == PAPI_EINVAL) && (PAPI_get_multiplex(EventSet) == TRUE))
  printf("This event set already has multiplexing enabled\n");
else if (ret != PAPI_OK) handle_error(ret);

πŸ‘€ See also πŸ‘€

  • PAPI_multiplex_init
  • PAPI_get_multiplex
  • PAPI_set_opt
  • PAPI_create_eventset

✍️ Author ✍️

ngl, the author line is literally: Generated automatically by Doxygen for PAPI from the source code. 🫢


xoxo, this was PAPI_set_multiplex(3) from PAPI, version 7.2.0.0, dated Wed Jun 25 2025 19:30:49 β€” slay and stay multiplexed, bestie πŸ’–πŸ¦‹πŸŒˆ