PAPI_ipc(3)

1PAPI_ipc(3)                          PAPI                          PAPI_ipc(3)
2
3
4

NAME

6       PAPI_ipc  -  PAPI  High  level: Simplified call to get instructions per
7       cycle, real and processor time
8
9

SYNOPSIS

11       C Interface
12       #include <papi.h>
13       int PAPI_ipc (float *rtime, float *ptime, long_long *ins, float *ipc);
14       Fortran Interface
15       #include fpapi.h
16       PAPIF_ipc(C_FLOAT real_time, C_FLOAT proc_time, C_LONG_LONG ins, C_FLOAT ipc, C_INT check)
17
18

DESCRIPTION

20       The first call to PAPI_ipc() will initialize the PAPI High Level inter‐
21       face,  set  up  the  counters  to monitor PAPI_TOT_INS and PAPI_TOT_CYC
22       events and start the counters.  Subsequent calls will read the counters
23       and  return  total  real  time,  total process time, total instructions
24       since the start of the measurement and the instructions per cycle  rate
25       since  latest  call to PAPI_ipc().  A call to PAPI_stop_counters() will
26       stop the counters from running and then calls such as  PAPI_start_coun‐
27       ters() can safely be used.
28
29
30

ARGUMENTS

32       *rtime -- total realtime since the first PAPI_ipc() call
33
34       *ptime -- total process time since the first PAPI_ipc() call
35
36       *ins -- total instructions since the first call
37
38       *ipc -- instructions per cycle achieved since the previous call
39
40

RETURN VALUES

42       On success, this function returns PAPI_OK.
43        On error, a non-zero error code is returned.
44
45

ERRORS

47        In  addition  to  the possible errors returned by the various PAPI low
48       level calls, the following errors could also be returned:
49
50       PAPI_EINVAL
51              The counters were  already  started  by  something  other  than:
52              PAPI_ipc()
53
54       PAPI_ENOEVNT
55              The total instructions or total cycles event does not exist.
56
57       PAPI_ENOMEM
58              Insufficient memory to complete the operation.
59
60              PAPI_ipc()  may  be  called  by:            the user application
61              program
62
63
64       PAPI_ipc() contains calls to:
65
66            PAPI_perror()
67            PAPI_library_init()
68            PAPI_get_hardware_info()
69            PAPI_create_eventset()
70            PAPI_add_event()
71            PAPI_start()
72            PAPI_get_real_usec()
73            PAPI_accum()
74            PAPI_shutdown()
75
76

BUGS

78       This function has no known bugs.
79
80