File: MPI_T_pvar_get_info.3

package info (click to toggle)
mpich 3.3-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 131,836 kB
  • sloc: ansic: 975,868; cpp: 57,437; f90: 53,762; perl: 19,562; xml: 12,464; sh: 12,303; fortran: 7,875; makefile: 7,078; ruby: 126; java: 100; python: 98; lisp: 19; php: 8; sed: 4
file content (133 lines) | stat: -rw-r--r-- 3,275 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.TH MPI_T_pvar_get_info 3 "11/21/2018" " " "MPI"
.SH NAME
MPI_T_pvar_get_info \-  Get the inforamtion about a performance variable 
.SH SYNOPSIS
.nf
int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity,
                        int *var_class, MPI_Datatype * datatype, MPI_T_enum * enumtype, char *desc,
                        int *desc_len, int *binding, int *readonly, int *continuous, int *atomic)
.fi
.SH INPUT/OUTPUT PARAMETERS
.PD 0
.TP
.B name_len 
- length of the string and/or buffer for name (integer)
.PD 1
.PD 0
.TP
.B desc_len 
- length of the string and/or buffer for desc (integer)
.PD 1

.SH INPUT PARAMETERS
.PD 0
.TP
.B pvar_index 
- index of the performance variable to be queried between 0 and num_pvar-1 (integer)
.PD 1

.SH OUTPUT PARAMETERS
.PD 0
.TP
.B name 
- buffer to return the string containing the name of the performance variable (string)
.PD 1
.PD 0
.TP
.B verbosity 
- verbosity level of this variable (integer)
.PD 1
.PD 0
.TP
.B var_class 
- class of performance variable (integer)
.PD 1
.PD 0
.TP
.B datatype 
- MPI type of the information stored in the performance variable (handle)
.PD 1
.PD 0
.TP
.B enumtype 
- optional descriptor for enumeration information (handle)
.PD 1
.PD 0
.TP
.B desc 
- buffer to return the string containing a description of the performance variable (string)
.PD 1
.PD 0
.TP
.B binding 
- type of MPI object to which this variable must be bound (integer)
.PD 1
.PD 0
.TP
.B readonly 
- flag indicating whether the variable can be written/reset (integer)
.PD 1
.PD 0
.TP
.B continuous 
- flag indicating whether the variable can be started and stopped or is continuously active (integer)
.PD 1
.PD 0
.TP
.B atomic 
- flag indicating whether the variable can be atomically read and reset (integer)
.PD 1

.SH THREAD AND INTERRUPT SAFETY

This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as 
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.

.SH ERRORS

All MPI routines (except 
.I MPI_Wtime
and 
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument.  Before the value is returned, the current MPI error handler is
called.  By default, this error handler aborts the MPI job.  The error handler
may be changed with 
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and 
.I MPI_Win_set_errhandler
(for
RMA windows).  The MPI-1 routine 
.I MPI_Errhandler_set
may be used but
its use is deprecated.  The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does 
.B not
guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.

.PD 0
.TP
.B MPI_SUCCESS 
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_T_ERR_NOT_INITIALIZED 
- The MPI tool information interface is not initialized.
.PD 1
.PD 0
.TP
.B MPI_T_ERR_INVALID_INDEX 
- Index is invalid or has been deleted.
.PD 1