Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

papi_get_multiplex(3) [centos man page]

PAPI_get_multiplex(3)						       PAPI						     PAPI_get_multiplex(3)

NAME

       PAPI_get_multiplex -

       Get the multiplexing status of specified event set.

SYNOPSIS

Detailed Description
       C Interface:
	   #include <papi.h>
	    int PAPI_get_multiplex( int  EventSet );

       Fortran Interface:
	   #include fpapi.h
	    PAPIF_get_multiplex( C_INT	EventSet,  C_INT  check )

       Parameters:
	   EventSet an integer handle for a PAPI event set as created by PAPI_create_eventset

       Return values:
	   PAPI_OK
	   PAPI_EINVAL One or more of the arguments is invalid, or the EventSet is already multiplexed.
	   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_get_multiplex tests the state of the PAPI_MULTIPLEXING flag in the specified event set, returning TRUE if a PAPI event set is
       multiplexed, or FALSE if not.

       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.")
	   *   if (ret == FALSE) printf("This event set is not enabled for multiplexing.")
	   *   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 enabled0);
	   *   else if (ret != PAPI_OK) handle_error(ret);
	   *

       See Also:
	   PAPI_multiplex_init

	   PAPI_set_opt

	   PAPI_create_eventset

Author
       Generated automatically by Doxygen for PAPI from the source code.

Version 5.2.0.0 						  Tue Jun 17 2014					     PAPI_get_multiplex(3)

Check Out this Related Man Page

PAPI_start(3)							       PAPI							     PAPI_start(3)

NAME

       PAPI_start -

       Start counting hardware events in an event set.

SYNOPSIS

Detailed Description
       C Interface:
	   #include <papi.h>
	    int PAPI_start( int  EventSet );

       Parameters:
	   EventSet -- an integer handle for a PAPI event set as created by PAPI_create_eventset

       Return values:
	   PAPI_OK
	   PAPI_EINVAL -- One or more of the arguments is invalid.
	   PAPI_ESYS -- A system or C library call failed inside PAPI, see the errno variable.
	   PAPI_ENOEVST -- The EventSet specified does not exist.
	   PAPI_EISRUN -- The EventSet is currently counting events.
	   PAPI_ECNFLCT -- The underlying counter hardware can not count this event and other events in the EventSet simultaneously.
	   PAPI_ENOEVNT -- The PAPI preset is not available on the underlying hardware.

       PAPI_start starts counting all of the hardware events contained in the previously defined EventSet. All counters are implicitly set to zero
       before counting. Assumes an initialized PAPI library and a properly added event set.

       Example:

	   *  int EventSet = PAPI_NULL;
	   *  long long values[2];
	   *  int ret;
	   *
	   *  ret = PAPI_create_eventset(&EventSet);
	   *  if (ret != PAPI_OK) handle_error(ret);
	   *
	   *  // Add Total Instructions Executed to our EventSet
	   *  ret = PAPI_add_event(EventSet, PAPI_TOT_INS);
	   *  if (ret != PAPI_OK) handle_error(ret);
	   *
	   *  // Start counting
	   *  ret = PAPI_start(EventSet);
	   *  if (ret != PAPI_OK) handle_error(ret);
	   *  poorly_tuned_function();
	   *  ret = PAPI_stop(EventSet, values);
	   *  if (ret != PAPI_OK) handle_error(ret);
	   *  printf("%lld
",values[0]);
	   *

       See Also:
	   PAPI_create_eventset PAPI_add_event PAPI_stop

Author
       Generated automatically by Doxygen for PAPI from the source code.

Version 5.2.0.0 						  Tue Jun 17 2014						     PAPI_start(3)
Man Page