Scroll to navigation

MPI_T_PVAR_SESSION_FREE(3) Open MPI MPI_T_PVAR_SESSION_FREE(3)


MPI_T_pvar_session_create <#mpi-t-pvar-session-create>, MPI_T_pvar_session_free - Create/free performance variable session

SYNTAX

C Syntax

#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

MPI_T_pvar_session_create <#mpi-t-pvar-session-create> creates a session for accessing performance variables. The new session is returned in the session parameter.

MPI_T_pvar_session_free releases a session allocated by MPI_T_pvar_session_create <#mpi-t-pvar-session-create> and sets the session parameter to MPI_T_PVAR_SESSION_NULL.

ERRORS

MPI_T_pvar_session_create <#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

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

Copyright

2003-2025, The Open MPI Community

November 12, 2025