add some comments to avoid that someone breaks the MC with a 'trivial cleanup'

[simgrid.git] / src / smpi / smpi_base.c

diff --git a/src/smpi/smpi_base.c b/src/smpi/smpi_base.c
index 6aeceb5..eed7b81 100644 (file)
--- a/src/smpi/smpi_base.c
+++ b/src/smpi/smpi_base.c
@@ -285,7 +285,7 @@ static void smpi_mpi_request_free_voidp(void* request)
 MPI_Request smpi_mpi_send_init(void *buf, int count, MPI_Datatype datatype,
                                int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                           comm, PERSISTENT | SEND | PREPARED);
   request->refcount++;
@@ -295,7 +295,7 @@ MPI_Request smpi_mpi_send_init(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_mpi_ssend_init(void *buf, int count, MPI_Datatype datatype,
                                int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                           comm, PERSISTENT | SSEND | SEND | PREPARED);
   request->refcount++;
@@ -305,7 +305,7 @@ MPI_Request smpi_mpi_ssend_init(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_mpi_recv_init(void *buf, int count, MPI_Datatype datatype,
                                int src, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, src == MPI_ANY_SOURCE ? MPI_ANY_SOURCE : smpi_group_index(smpi_comm_group(comm), src), smpi_process_index(), tag,
                           comm, PERSISTENT | RECV | PREPARED);
   request->refcount++;
@@ -442,7 +442,7 @@ void smpi_mpi_request_free(MPI_Request * request)
 MPI_Request smpi_isend_init(void *buf, int count, MPI_Datatype datatype,
                             int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf , count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                           comm, NON_PERSISTENT | ISEND | SEND | PREPARED);
   return request;
@@ -451,7 +451,7 @@ MPI_Request smpi_isend_init(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_mpi_isend(void *buf, int count, MPI_Datatype datatype,
                            int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request =  build_request(buf==MPI_BOTTOM?(void*)0:buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                            comm, NON_PERSISTENT | ISEND | SEND);
   smpi_mpi_start(request);
@@ -461,7 +461,7 @@ MPI_Request smpi_mpi_isend(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_mpi_issend(void *buf, int count, MPI_Datatype datatype,
                            int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                           comm, NON_PERSISTENT | ISEND | SSEND | SEND);
   smpi_mpi_start(request);
@@ -473,7 +473,7 @@ MPI_Request smpi_mpi_issend(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_irecv_init(void *buf, int count, MPI_Datatype datatype,
                             int src, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, src == MPI_ANY_SOURCE ? MPI_ANY_SOURCE : smpi_group_index(smpi_comm_group(comm), src), smpi_process_index(), tag,
                           comm, NON_PERSISTENT | RECV | PREPARED);
   return request;
@@ -482,7 +482,7 @@ MPI_Request smpi_irecv_init(void *buf, int count, MPI_Datatype datatype,
 MPI_Request smpi_mpi_irecv(void *buf, int count, MPI_Datatype datatype,
                            int src, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, src == MPI_ANY_SOURCE ? MPI_ANY_SOURCE : smpi_group_index(smpi_comm_group(comm), src), smpi_process_index(), tag,
                           comm, NON_PERSISTENT | RECV);
   smpi_mpi_start(request);
@@ -492,7 +492,7 @@ MPI_Request smpi_mpi_irecv(void *buf, int count, MPI_Datatype datatype,
 void smpi_mpi_recv(void *buf, int count, MPI_Datatype datatype, int src,
                    int tag, MPI_Comm comm, MPI_Status * status)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = smpi_mpi_irecv(buf, count, datatype, src, tag, comm);
   smpi_mpi_wait(&request, status);
   request = NULL;
@@ -503,7 +503,7 @@ void smpi_mpi_recv(void *buf, int count, MPI_Datatype datatype, int src,
 void smpi_mpi_send(void *buf, int count, MPI_Datatype datatype, int dst,
                    int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                           comm, NON_PERSISTENT | SEND);
 
@@ -515,7 +515,7 @@ void smpi_mpi_send(void *buf, int count, MPI_Datatype datatype, int dst,
 void smpi_mpi_ssend(void *buf, int count, MPI_Datatype datatype,
                            int dst, int tag, MPI_Comm comm)
 {
-  MPI_Request request = NULL;
+  MPI_Request request = NULL; /* MC needs the comm to be set to NULL during the call */
   request = build_request(buf==MPI_BOTTOM ? (void*)0 : buf, count, datatype, smpi_process_index(), smpi_group_index(smpi_comm_group(comm), dst), tag,
                 comm, NON_PERSISTENT | SSEND | SEND);