1 /*
2 * Copyright (C) by Argonne National Laboratory
3 * See COPYRIGHT in top-level directory
4 */
5
6 #include "mpiimpl.h"
7 #include "utlist.h"
8
9 /* -- Begin Profiling Symbol Block for routine MPI_T_pvar_session_free */
10 #if defined(HAVE_PRAGMA_WEAK)
11 #pragma weak MPI_T_pvar_session_free = PMPI_T_pvar_session_free
12 #elif defined(HAVE_PRAGMA_HP_SEC_DEF)
13 #pragma _HP_SECONDARY_DEF PMPI_T_pvar_session_free MPI_T_pvar_session_free
14 #elif defined(HAVE_PRAGMA_CRI_DUP)
15 #pragma _CRI duplicate MPI_T_pvar_session_free as PMPI_T_pvar_session_free
16 #elif defined(HAVE_WEAK_ATTRIBUTE)
17 int MPI_T_pvar_session_free(MPI_T_pvar_session * session)
18 __attribute__ ((weak, alias("PMPI_T_pvar_session_free")));
19 #endif
20 /* -- End Profiling Symbol Block */
21
22 /* Define MPICH_MPI_FROM_PMPI if weak symbols are not supported to build
23 the MPI routines */
24 #ifndef MPICH_MPI_FROM_PMPI
25 #undef MPI_T_pvar_session_free
26 #define MPI_T_pvar_session_free PMPI_T_pvar_session_free
27
28 /* any non-MPI functions go here, especially non-static ones */
29
MPIR_T_pvar_session_free_impl(MPI_T_pvar_session * session)30 int MPIR_T_pvar_session_free_impl(MPI_T_pvar_session * session)
31 {
32 int mpi_errno = MPI_SUCCESS;
33 MPIR_T_pvar_handle_t *hnd, *tmp;
34
35 /* The draft standard is a bit unclear about the behavior of this function
36 * w.r.t. outstanding pvar handles. A conservative (from the implementors
37 * viewpoint) interpretation implies that this routine should free all
38 * outstanding handles attached to this session. A more relaxed
39 * interpretation puts that burden on the user. We choose the conservative
40 * view.*/
41 DL_FOREACH_SAFE((*session)->hlist, hnd, tmp) {
42 DL_DELETE((*session)->hlist, hnd);
43 MPL_free(hnd);
44 }
45 MPL_free(*session);
46 *session = MPI_T_PVAR_SESSION_NULL;
47
48 return mpi_errno;
49 }
50
51 #endif /* MPICH_MPI_FROM_PMPI */
52
53 /*@
54 MPI_T_pvar_session_free - Free an existing performance variable session
55
56 Input/Output Parameters:
57 . session - identifier of performance experiment session (handle)
58
59 Notes:
60 Calls to the MPI tool information interface can no longer be made
61 within the context of a session after it is freed. On a successful
62 return, MPI sets the session identifier to MPI_T_PVAR_SESSION_NULL.
63
64 .N ThreadSafe
65
66 .N Errors
67 .N MPI_SUCCESS
68 .N MPI_T_ERR_NOT_INITIALIZED
69 .N MPI_T_ERR_INVALID_SESSION
70 @*/
MPI_T_pvar_session_free(MPI_T_pvar_session * session)71 int MPI_T_pvar_session_free(MPI_T_pvar_session * session)
72 {
73 int mpi_errno = MPI_SUCCESS;
74
75 MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPI_T_PVAR_SESSION_FREE);
76 MPIR_ERRTEST_MPIT_INITIALIZED(mpi_errno);
77 MPIR_T_THREAD_CS_ENTER();
78 MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPI_T_PVAR_SESSION_FREE);
79
80 /* Validate parameters, especially handles needing to be converted */
81 #ifdef HAVE_ERROR_CHECKING
82 {
83 MPID_BEGIN_ERROR_CHECKS;
84 {
85 MPIR_ERRTEST_ARGNULL(session, "session", mpi_errno);
86 }
87 MPID_END_ERROR_CHECKS;
88 }
89 #endif /* HAVE_ERROR_CHECKING */
90
91 /* ... body of routine ... */
92
93 mpi_errno = MPIR_T_pvar_session_free_impl(session);
94 if (mpi_errno != MPI_SUCCESS)
95 goto fn_fail;
96
97 /* ... end of body of routine ... */
98
99 fn_exit:
100 MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPI_T_PVAR_SESSION_FREE);
101 MPIR_T_THREAD_CS_EXIT();
102 return mpi_errno;
103
104 fn_fail:
105 /* --BEGIN ERROR HANDLING-- */
106 #ifdef HAVE_ERROR_CHECKING
107 {
108 mpi_errno =
109 MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE, __func__, __LINE__, MPI_ERR_OTHER,
110 "**mpi_t_pvar_session_free", "**mpi_t_pvar_session_free %p",
111 session);
112 }
113 #endif
114 mpi_errno = MPIR_Err_return_comm(NULL, __func__, mpi_errno);
115 goto fn_exit;
116 /* --END ERROR HANDLING-- */
117 }
118