|
Packit Service |
c5cf8c |
.TH MPI_T_pvar_get_info 3 "11/12/2019" " " "MPI"
|
|
Packit Service |
c5cf8c |
.SH NAME
|
|
Packit Service |
c5cf8c |
MPI_T_pvar_get_info \- Get the inforamtion about a performance variable
|
|
Packit Service |
c5cf8c |
.SH SYNOPSIS
|
|
Packit Service |
c5cf8c |
.nf
|
|
Packit Service |
c5cf8c |
int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity,
|
|
Packit Service |
c5cf8c |
int *var_class, MPI_Datatype * datatype, MPI_T_enum * enumtype, char *desc,
|
|
Packit Service |
c5cf8c |
int *desc_len, int *binding, int *readonly, int *continuous, int *atomic)
|
|
Packit Service |
c5cf8c |
.fi
|
|
Packit Service |
c5cf8c |
.SH INPUT/OUTPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B name_len
|
|
Packit Service |
c5cf8c |
- length of the string and/or buffer for name (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B desc_len
|
|
Packit Service |
c5cf8c |
- length of the string and/or buffer for desc (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH INPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B pvar_index
|
|
Packit Service |
c5cf8c |
- index of the performance variable to be queried between 0 and num_pvar-1 (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH OUTPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B name
|
|
Packit Service |
c5cf8c |
- buffer to return the string containing the name of the performance variable (string)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B verbosity
|
|
Packit Service |
c5cf8c |
- verbosity level of this variable (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B var_class
|
|
Packit Service |
c5cf8c |
- class of performance variable (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B datatype
|
|
Packit Service |
c5cf8c |
- MPI type of the information stored in the performance variable (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B enumtype
|
|
Packit Service |
c5cf8c |
- optional descriptor for enumeration information (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B desc
|
|
Packit Service |
c5cf8c |
- buffer to return the string containing a description of the performance variable (string)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B binding
|
|
Packit Service |
c5cf8c |
- type of MPI object to which this variable must be bound (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B readonly
|
|
Packit Service |
c5cf8c |
- flag indicating whether the variable can be written/reset (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B continuous
|
|
Packit Service |
c5cf8c |
- flag indicating whether the variable can be started and stopped or is continuously active (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B atomic
|
|
Packit Service |
c5cf8c |
- flag indicating whether the variable can be atomically read and reset (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH THREAD AND INTERRUPT SAFETY
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as
|
|
Packit Service |
c5cf8c |
.I malloc
|
|
Packit Service |
c5cf8c |
or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH ERRORS
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except
|
|
Packit Service |
c5cf8c |
.I MPI_Wtime
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Wtick
|
|
Packit Service |
c5cf8c |
) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_errhandler
|
|
Packit Service |
c5cf8c |
(for communicators),
|
|
Packit Service |
c5cf8c |
.I MPI_File_set_errhandler
|
|
Packit Service |
c5cf8c |
(for files), and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_set_errhandler
|
|
Packit Service |
c5cf8c |
(for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine
|
|
Packit Service |
c5cf8c |
.I MPI_Errhandler_set
|
|
Packit Service |
c5cf8c |
may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
.I MPI_ERRORS_RETURN
|
|
Packit Service |
c5cf8c |
may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_SUCCESS
|
|
Packit Service |
c5cf8c |
- No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_T_ERR_NOT_INITIALIZED
|
|
Packit Service |
c5cf8c |
- The MPI tool information interface is not initialized.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_T_ERR_INVALID_INDEX
|
|
Packit Service |
c5cf8c |
- Index is invalid or has been deleted.
|
|
Packit Service |
c5cf8c |
.PD 1
|