11# vim : set ft=c:
22
33MPIX_Stream_create :
4+ .desc : Create a new stream object
45 info : INFO , [info argument ]
56 stream : STREAM , direction = out , [stream object created ]
67
78MPIX_Stream_free :
9+ .desc : Free a stream object
810 stream : STREAM , direction = inout , [stream object ]
911
1012MPIX_Stream_comm_create :
13+ .desc : Create a new communicator with local stream attached
1114 comm : COMMUNICATOR , [communicator ]
1215 stream : STREAM , [stream object ]
1316 newcomm : COMMUNICATOR , direction = out , [new stream - associated communicator ]
1417
1518MPIX_Stream_comm_create_multiplex :
19+ .desc : Create a new communicator with multiple local streams attached
1620 comm : COMMUNICATOR , [communicator ]
1721 count : ARRAY_LENGTH_NNI , [list length ]
1822 array_of_streams : STREAM , length = count , [stream object array ]
1923 newcomm : COMMUNICATOR , direction = out , [new stream - associated communicator ]
2024
2125MPIX_Comm_get_stream :
26+ .desc : Get the stream object that is attached to the communicator
2227 comm : COMMUNICATOR , [communicator ]
2328 idx : INDEX
2429 stream : STREAM , direction = out , [stream object ]
2530
2631MPIX_Stream_progress :
2732 stream : STREAM , [stream object ]
33+ .desc : Invoke progress on the given stream
2834 .impl : mpid
2935
3036MPIX_Start_progress_thread :
37+ .desc : Start a progress thread that will poll progress on the given stream
3138 stream : STREAM , [stream object ]
3239
3340MPIX_Stop_progress_thread :
41+ .desc : Stop the progress thread that polls progress on the given stream
3442 stream : STREAM , [stream object ]
3543
3644MPIX_Stream_send :
45+ .desc : Send message from a specific local stream to a specific destination stream
3746 buf : BUFFER , constant = True , [initial address of send buffer ]
3847 count : POLYXFER_NUM_ELEM_NNI , [number of elements in send buffer ]
3948 datatype : DATATYPE , [datatype of each send buffer element ]
@@ -67,6 +76,7 @@ MPIX_Stream_send:
6776}
6877
6978MPIX_Stream_isend :
79+ .desc : Start a nonblocking send from a specific local stream to a specific remote stream
7080 buf : BUFFER , asynchronous = True , constant = True , [initial address of send buffer ]
7181 count : POLYXFER_NUM_ELEM_NNI , [number of elements in send buffer ]
7282 datatype : DATATYPE , [datatype of each send buffer element ]
@@ -98,6 +108,7 @@ MPIX_Stream_isend:
98108}
99109
100110MPIX_Stream_recv :
111+ .desc : Receive a message from a specific source stream to a specific local stream
101112 buf : BUFFER , direction = out , [initial address of receive buffer ]
102113 count : POLYXFER_NUM_ELEM_NNI , [number of elements in receive buffer ]
103114 datatype : DATATYPE , [datatype of each receive buffer element ]
@@ -134,6 +145,7 @@ MPIX_Stream_recv:
134145}
135146
136147MPIX_Stream_irecv :
148+ .desc : Start a nonblocking receive from a specific source stream to a specific local stream
137149 buf : BUFFER , direction = out , asynchronous = True , suppress = f08_intent , [initial address of receive buffer ]
138150 count : POLYXFER_NUM_ELEM_NNI , [number of elements in receive buffer ]
139151 datatype : DATATYPE , [datatype of each receive buffer element ]
@@ -159,6 +171,7 @@ MPIX_Stream_irecv:
159171}
160172
161173MPIX_Send_enqueue :
174+ .desc : Enqueue a send operation to a GPU stream that is associated with the local stream
162175 buf : BUFFER , constant = True , [initial address of send buffer ]
163176 count : POLYXFER_NUM_ELEM_NNI , [number of elements in send buffer ]
164177 datatype : DATATYPE , [datatype of each send buffer element ]
@@ -169,6 +182,7 @@ MPIX_Send_enqueue:
169182 .decl : MPIR_Send_enqueue_impl
170183
171184MPIX_Recv_enqueue :
185+ .desc : Enqueue a receive operation to a GPU stream that is associated with the local stream
172186 buf : BUFFER , direction = out , [initial address of receive buffer ]
173187 count : POLYXFER_NUM_ELEM_NNI , [number of elements in receive buffer ]
174188 datatype : DATATYPE , [datatype of each receive buffer element ]
@@ -180,6 +194,7 @@ MPIX_Recv_enqueue:
180194 .decl : MPIR_Recv_enqueue_impl
181195
182196MPIX_Isend_enqueue :
197+ .desc : Enqueue a nonblocking send operation to a GPU stream that is associated with the local stream
183198 buf : BUFFER , constant = True , [initial address of send buffer ]
184199 count : POLYXFER_NUM_ELEM_NNI , [number of elements in send buffer ]
185200 datatype : DATATYPE , [datatype of each send buffer element ]
@@ -191,6 +206,7 @@ MPIX_Isend_enqueue:
191206 .decl : MPIR_Isend_enqueue_impl
192207
193208MPIX_Irecv_enqueue :
209+ .desc : Enqueue a nonblocking receive operation to a GPU stream that is associated with the local stream
194210 buf : BUFFER , direction = out , [initial address of receive buffer ]
195211 count : POLYXFER_NUM_ELEM_NNI , [number of elements in receive buffer ]
196212 datatype : DATATYPE , [datatype of each receive buffer element ]
@@ -202,12 +218,14 @@ MPIX_Irecv_enqueue:
202218 .decl : MPIR_Irecv_enqueue_impl
203219
204220MPIX_Wait_enqueue :
221+ .desc : Enqueue a wait operation to a GPU stream that is associated with the local stream
205222 request : REQUEST , direction = inout , [request ]
206223 status : STATUS , direction = out
207224 .impl : mpid
208225 .decl : MPIR_Wait_enqueue_impl
209226
210227MPIX_Waitall_enqueue :
228+ .desc : Enqueue a waitall operation to a GPU stream that is associated with the local stream
211229 count : ARRAY_LENGTH_NNI , [lists length ]
212230 array_of_requests : REQUEST , direction = inout , length = count , [array of requests ]
213231 array_of_statuses : STATUS , direction = out , length = * , pointer = False , [array of status objects ]
@@ -220,6 +238,7 @@ MPIX_Waitall_enqueue:
220238}
221239
222240MPIX_Allreduce_enqueue :
241+ .desc : Enqueue an allreduce operation to a GPU stream that is associated with the local stream
223242 sendbuf : BUFFER , constant = True , [starting address of send buffer ]
224243 recvbuf : BUFFER , direction = out , [starting address of receive buffer ]
225244 count : POLYXFER_NUM_ELEM_NNI , [number of elements in send buffer ]
0 commit comments