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
|
.. _mpi_t_pvar_session_create:
MPI_T_pvar_session_create
=========================
.. include_body
:ref:`MPI_T_pvar_session_create`, :ref:`MPI_T_pvar_session_free` - Create/free
performance variable session
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_T_pvar_session_create(MPI_T_pvar_session *session)
int MPI_T_pvar_session_free(MPI_T_pvar_session *session)
DESCRIPTION
-----------
:ref:`MPI_T_pvar_session_create` creates a session for accessing performance
variables. The new session is returned in the *session* parameter.
:ref:`MPI_T_pvar_session_free` releases a session allocated by
:ref:`MPI_T_pvar_session_create` and sets the *session* parameter to
MPI_T_PVAR_SESSION_NULL.
ERRORS
------
:ref:`MPI_T_pvar_session_create` will fail if:
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
* ``MPI_T_ERR_MEMORY``: Out of memory
* ``MPI_T_ERR_OUT_OF_SESSIONS``: No more sessions available
:ref:`MPI_T_pvar_session_free` will fail if:
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
* ``MPI_T_ERR_INVALID_SESSION``: The session parameter is not a valid session
|
