NewMadeleine

Documentation

« back to PM2 home.
nm_sendrecv_interface.h
Go to the documentation of this file.
1/*
2 * NewMadeleine
3 * Copyright (C) 2006-2024 (see AUTHORS file)
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or (at
8 * your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 */
15
16#ifndef NM_SENDRECV_INTERFACE_H
17#define NM_SENDRECV_INTERFACE_H
18
28#include <nm_public.h>
29#include <nm_session_interface.h>
30#include <nm_core_interface.h>
31#include <sys/uio.h>
32#include <limits.h>
33
56
58typedef struct nm_sr_request_s nm_sr_request_t;
59
61typedef union
62{
63 struct
64 {
65 nm_gate_t p_gate;
66 nm_tag_t tag;
67 nm_len_t len;
68 nm_session_t p_session;
69 const struct nm_core_event_s*p_core_event;
70 } recv_unexpected;
71 struct
72 {
73 nm_sr_request_t*p_request;
74 } req;
75} nm_sr_event_info_t;
76
79typedef void (*nm_sr_event_notifier_t)(nm_sr_event_t event, const nm_sr_event_info_t*event_info, void*ref);
80
91
92/* ** Operations on requests (send or recv) **************** */
93
95extern int nm_sr_request_monitor(nm_session_t p_session, nm_sr_request_t*p_request,
96 nm_sr_event_t mask, nm_sr_event_notifier_t notifier);
97
99extern int nm_sr_request_set_completion_queue(nm_session_t p_session, nm_sr_request_t*p_request);
100
104extern int nm_sr_request_unset_completion_queue(nm_session_t p_session, nm_sr_request_t*p_request);
105
107static inline int nm_sr_request_isnull(nm_sr_request_t*p_request);
108
110static inline int nm_sr_request_set_ref(nm_sr_request_t*p_request, void*ref);
111
113static inline void*nm_sr_request_get_ref(nm_sr_request_t*p_request);
114
116static inline nm_tag_t nm_sr_request_get_tag(nm_sr_request_t*p_request);
117
119static inline int nm_sr_request_get_size(nm_sr_request_t *request, nm_len_t*size);
120
122static inline int nm_sr_request_get_expected_size(nm_sr_request_t *request, nm_len_t*size);
123
124static inline nm_gate_t nm_sr_request_get_gate(nm_sr_request_t*p_request);
125
127static inline nm_session_t nm_sr_request_get_session(nm_sr_request_t*p_request);
128
130extern int nm_sr_request_wait(nm_sr_request_t*p_request);
131
133static inline void nm_sr_request_wait_all(nm_sr_request_t**p_requests, int n);
134
136static inline int nm_sr_request_test(nm_sr_request_t*p_request, nm_status_t status);
137
139static inline int nm_sr_request_get_error(nm_sr_request_t*p_request);
140
143extern int nm_sr_flush(struct nm_session_s*p_session);
144
145
146/* ** Building blocks for send ***************************** */
147
148/* Rationale for the send interface:
149 * either use the high-level interface (nm_sr_isend() et al., see below
150 * or the low-level building blocks
151 * Sequence for a send with the low-level building blocks:
152 * 1. nm_sr_send_init() init request
153 * 2. nm_sr_send_pack_*() pack data into request
154 * 3. nm_sr_send_isend|issend|rsend() to send data
155 * alternative:
156 * 3.1 nm_sr_send_dest() set destination of message
157 * 3.2 nm_sr_send_header() set data header size
158 * 3.3 nm_sr_send_submit() submit send request to nmad
159 */
160
162static inline void nm_sr_send_init(nm_session_t p_session, nm_sr_request_t*p_request);
164static inline void nm_sr_send_pack_contiguous(nm_session_t p_session, nm_sr_request_t*p_request,
165 const void*, nm_len_t len);
167static inline void nm_sr_send_pack_iov(nm_session_t p_session, nm_sr_request_t*p_request,
168 const struct iovec*iov, int num_entries);
170static inline void nm_sr_send_pack_data(nm_session_t p_session, nm_sr_request_t*p_request,
171 const struct nm_data_s*p_data);
173static inline int nm_sr_send_isend(nm_session_t p_session, nm_sr_request_t*p_request,
174 nm_gate_t p_gate, nm_tag_t tag);
176static inline int nm_sr_send_issend(nm_session_t p_session, nm_sr_request_t*p_request,
177 nm_gate_t p_gate, nm_tag_t tag);
179static inline int nm_sr_send_rsend(nm_session_t p_session, nm_sr_request_t*p_request,
180 nm_gate_t p_gate, nm_tag_t tag);
182static inline int nm_sr_send_dest(nm_session_t p_session, nm_sr_request_t*p_request,
183 nm_gate_t p_gate, nm_tag_t tag);
186static inline int nm_sr_send_header(nm_session_t p_session, nm_sr_request_t*p_request, nm_len_t hlen);
188static inline int nm_sr_send_submit(nm_session_t p_session, nm_sr_request_t*p_request);
193static inline int nm_sr_send_submit_chunks(nm_session_t p_session, nm_sr_request_t*p_request,
194 int n, const struct nm_chunk_s*p_chunks);
198static inline void nm_sr_send_set_priority(nm_session_t p_session, nm_sr_request_t*p_request, nm_prio_t priority);
199
200
204#define NM_SR_PRIORITY_MIN INT_MIN
205
207#define NM_SR_PRIORITY_MAX INT_MAX
208
209/* ** Building blocks for recv ***************************** */
210
211static inline void nm_sr_recv_init(nm_session_t p_session, nm_sr_request_t*p_request);
212static inline void nm_sr_recv_unpack_contiguous(nm_session_t p_session, nm_sr_request_t*p_request,
213 void*ptr, nm_len_t len);
214static inline void nm_sr_recv_unpack_iov(nm_session_t p_session, nm_sr_request_t*p_request,
215 const struct iovec*iov, int num_entry);
216static inline void nm_sr_recv_unpack_data(nm_session_t p_session, nm_sr_request_t*p_request,
217 const struct nm_data_s*p_data);
218static inline int nm_sr_recv_irecv(nm_session_t p_session, nm_sr_request_t*p_request,
219 nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask);
221static inline void nm_sr_recv_match(nm_session_t p_session, nm_sr_request_t*p_request,
222 nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask);
224static inline void nm_sr_recv_match_event(nm_session_t p_session, nm_sr_request_t*p_request,
225 const nm_sr_event_info_t*p_event);
227static inline int nm_sr_recv_peek(nm_session_t p_session, nm_sr_request_t*p_request,
228 const struct nm_data_s*p_data);
229
231static inline int nm_sr_recv_peek_offset(nm_session_t p_session, nm_sr_request_t*p_request,
232 const struct nm_data_s*p_data, nm_len_t peek_offset, nm_len_t peek_len);
233
235static inline void nm_sr_recv_offset(nm_session_t p_session, nm_sr_request_t*p_request, nm_len_t offset);
236
238static inline int nm_sr_recv_iprobe(nm_session_t p_session, nm_sr_request_t*p_request);
239
241static inline void nm_sr_recv_data_wait(nm_session_t p_session, nm_sr_request_t*p_request);
242
244static inline void nm_sr_recv_data_size_wait(nm_session_t p_session, nm_sr_request_t*p_request);
245
247static inline int nm_sr_recv_data_test(nm_session_t p_session, nm_sr_request_t*p_request);
248
250static inline int nm_sr_recv_post(nm_session_t p_session, nm_sr_request_t*p_request);
251
252/* ** High level / legacy send ***************************** */
253
255static inline int nm_sr_issend(nm_session_t p_session,
256 nm_gate_t p_gate, nm_tag_t tag,
257 const void *data, nm_len_t len,
258 nm_sr_request_t *p_request)
259{
260 nm_sr_send_init(p_session, p_request);
261 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
262 const int err = nm_sr_send_issend(p_session, p_request, p_gate, tag);
263 return err;
264}
265
275static inline int nm_sr_isend(nm_session_t p_session,
276 nm_gate_t p_gate, nm_tag_t tag,
277 const void *data, nm_len_t len,
278 nm_sr_request_t *p_request)
279{
280 nm_sr_send_init(p_session, p_request);
281 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
282 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
283 return err;
284}
285
286static inline int nm_sr_isend_with_ref(nm_session_t p_session,
287 nm_gate_t p_gate, nm_tag_t tag,
288 const void *data, nm_len_t len,
289 nm_sr_request_t *p_request,
290 void*ref)
291{
292 nm_sr_send_init(p_session, p_request);
293 nm_sr_request_set_ref(p_request, ref);
294 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
295 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
296 return err;
297}
298
309static inline int nm_sr_rsend(nm_session_t p_session,
310 nm_gate_t p_gate, nm_tag_t tag,
311 const void *data, nm_len_t len,
312 nm_sr_request_t *p_request)
313{
314 nm_sr_send_init(p_session, p_request);
315 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
316 const int err = nm_sr_send_rsend(p_session, p_request, p_gate, tag);
317 return err;
318}
319
329static inline int nm_sr_isend_iov(nm_session_t p_session,
330 nm_gate_t p_gate, nm_tag_t tag,
331 const struct iovec *iov, int num_entries,
332 nm_sr_request_t *p_request)
333{
334 nm_sr_send_init(p_session, p_request);
335 nm_sr_send_pack_iov(p_session, p_request, iov, num_entries);
336 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
337 return err;
338}
339
340static inline int nm_sr_isend_iov_with_ref(nm_session_t p_session,
341 nm_gate_t p_gate, nm_tag_t tag,
342 const struct iovec *iov, int num_entries,
343 nm_sr_request_t *p_request,
344 void*ref)
345{
346 nm_sr_send_init(p_session, p_request);
347 nm_sr_request_set_ref(p_request, ref);
348 nm_sr_send_pack_iov(p_session, p_request, iov, num_entries);
349 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
350 return err;
351}
352
353static inline int nm_sr_isend_data(nm_session_t p_session,
354 nm_gate_t p_gate, nm_tag_t tag,
355 struct nm_data_s*p_data,
356 nm_sr_request_t*p_request)
357{
358 nm_sr_send_init(p_session, p_request);
359 nm_sr_send_pack_data(p_session, p_request, p_data);
360 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
361 return err;
362}
363
364
370extern int nm_sr_stest(nm_session_t p_session,
371 nm_sr_request_t *p_request);
372
377extern int nm_sr_progress(nm_session_t p_session);
378
384static inline int nm_sr_swait(nm_session_t p_session, nm_sr_request_t*p_request);
385
391extern int nm_sr_scancel(nm_session_t p_session,
392 nm_sr_request_t *p_request);
393
394
404static inline int nm_sr_irecv(nm_session_t p_session,
405 nm_gate_t p_gate, nm_tag_t tag,
406 void *data, nm_len_t len,
407 nm_sr_request_t *p_request)
408{
409 nm_sr_recv_init(p_session, p_request);
410 nm_sr_recv_unpack_contiguous(p_session, p_request, data, len);
411 nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
412 return NM_ESUCCESS;
413}
414
425static inline int nm_sr_irecv_with_ref(nm_session_t p_session,
426 nm_gate_t p_gate, nm_tag_t tag,
427 void *data, nm_len_t len,
428 nm_sr_request_t *p_request,
429 void *ref)
430{
431 nm_sr_recv_init(p_session, p_request);
432 nm_sr_request_set_ref(p_request, ref);
433 nm_sr_recv_unpack_contiguous(p_session, p_request, data, len);
434 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
435}
436
437static inline int nm_sr_irecv_iov(nm_session_t p_session,
438 nm_gate_t p_gate, nm_tag_t tag,
439 struct iovec *iov, int num_entries,
440 nm_sr_request_t *p_request)
441{
442 nm_sr_recv_init(p_session, p_request);
443 nm_sr_recv_unpack_iov(p_session, p_request, iov, num_entries);
444 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
445}
446
447static inline int nm_sr_irecv_iov_with_ref(nm_session_t p_session,
448 nm_gate_t p_gate, nm_tag_t tag,
449 struct iovec *iov, int num_entries,
450 nm_sr_request_t *p_request, void *ref)
451{
452 nm_sr_recv_init(p_session, p_request);
453 nm_sr_request_set_ref(p_request, ref);
454 nm_sr_recv_unpack_iov(p_session, p_request, iov, num_entries);
455 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
456}
457
458static inline int nm_sr_irecv_data(nm_session_t p_session,
459 nm_gate_t p_gate, nm_tag_t tag,
460 struct nm_data_s*p_data,
461 nm_sr_request_t *p_request)
462{
463 nm_sr_recv_init(p_session, p_request);
464 nm_sr_recv_unpack_data(p_session, p_request, p_data);
465 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
466}
467
468
474extern int nm_sr_rtest(nm_session_t p_session, nm_sr_request_t *p_request);
475
476
482static inline int nm_sr_rwait(nm_session_t p_session, nm_sr_request_t*p_request);
483
491static inline int nm_sr_rwait_data(nm_session_t p_session, nm_sr_request_t*p_request);
492
498extern int nm_sr_rcancel(nm_session_t p_session, nm_sr_request_t *p_request);
499
506extern int nm_sr_recv_source(nm_session_t p_session,
507 nm_sr_request_t *p_request, nm_gate_t *p_gate);
508
520extern int nm_sr_probe(nm_session_t p_session,
521 nm_gate_t p_gate, nm_gate_t *p_out_gate,
522 nm_tag_t tag, nm_tag_t tag_mask, nm_tag_t*p_out_tag,
523 nm_len_t*p_out_len);
524
526extern int nm_sr_monitor(nm_session_t p_session, nm_sr_event_t mask, nm_sr_event_notifier_t notifier);
527
529int nm_sr_session_monitor_set(nm_session_t p_session, const struct nm_sr_monitor_s*p_monitor);
530
532int nm_sr_session_monitor_remove(nm_session_t p_session, const struct nm_sr_monitor_s*p_monitor);
533
537extern int nm_sr_recv_success(nm_session_t p_session, nm_sr_request_t **out_req);
538
542extern int nm_sr_send_success(nm_session_t p_session, nm_sr_request_t **out_req);
543
544
545
546#include <nm_sendrecv_private.h> /* private header included for inlining */
547
549static inline int nm_sr_send(nm_session_t p_session,
550 nm_gate_t p_gate, nm_tag_t tag,
551 const void *data, nm_len_t len)
552{
553 nm_sr_request_t request;
554 int rc = nm_sr_isend(p_session, p_gate, tag, data, len, &request);
555 if(rc == NM_ESUCCESS)
556 {
557 rc = nm_sr_swait(p_session, &request);
558 }
559 return rc;
560}
561
563static inline int nm_sr_recv(nm_session_t p_session,
564 nm_gate_t p_gate, nm_tag_t tag,
565 void *data, nm_len_t len)
566{
567 nm_sr_request_t request;
568 int rc = nm_sr_irecv(p_session, p_gate, tag, data, len, &request);
569 if(rc == NM_ESUCCESS)
570 {
571 rc = nm_sr_rwait(p_session, &request);
572 }
573 return rc;
574}
575
576#endif /* NM_SENDRECV_INTERFACE_H */
NM_ESUCCESS
@ NM_ESUCCESS
successful operation
Definition nm_errno.h:36
NM_STATUS_UNPACK_CANCELLED
#define NM_STATUS_UNPACK_CANCELLED
unpack operation has been cancelled
Definition nm_core_interface.h:173
NM_STATUS_FINALIZED
#define NM_STATUS_FINALIZED
request is finalized, may be freed
Definition nm_core_interface.h:185
NM_STATUS_UNEXPECTED
#define NM_STATUS_UNEXPECTED
data or rdv has arrived, with no matching unpack
Definition nm_core_interface.h:171
NM_STATUS_UNPACK_DATA0
#define NM_STATUS_UNPACK_DATA0
first byte of data arrived, not unpacked yet- event triggered only if unpack is posted without data s...
Definition nm_core_interface.h:181
nm_status_t
uint32_t nm_status_t
status bits of pack/unpack requests
Definition nm_core_interface.h:153
NM_STATUS_PACK_COMPLETED
#define NM_STATUS_PACK_COMPLETED
sending operation has completed
Definition nm_core_interface.h:167
NM_STATUS_UNPACK_COMPLETED
#define NM_STATUS_UNPACK_COMPLETED
unpack operation has completed
Definition nm_core_interface.h:169
nm_sr_request_monitor
int nm_sr_request_monitor(nm_session_t p_session, nm_sr_request_t *p_request, nm_sr_event_t mask, nm_sr_event_notifier_t notifier)
Set a notification function called upon request completion.
nm_sr_send_submit_chunks
static int nm_sr_send_submit_chunks(nm_session_t p_session, nm_sr_request_t *p_request, int n, const struct nm_chunk_s *p_chunks)
submit partial chunks of a request.
nm_sr_event_notifier_t
void(* nm_sr_event_notifier_t)(nm_sr_event_t event, const nm_sr_event_info_t *event_info, void *ref)
notification function for sendrecv events.
Definition nm_sendrecv_interface.h:79
nm_sr_request_get_gate
static nm_gate_t nm_sr_request_get_gate(nm_sr_request_t *p_request)
nm_sr_send_set_priority
static void nm_sr_send_set_priority(nm_session_t p_session, nm_sr_request_t *p_request, nm_prio_t priority)
attach the given priority to the request.
nm_sr_send_dest
static int nm_sr_send_dest(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag)
set destination to a request, but do not send it immediately
nm_sr_request_get_error
static int nm_sr_request_get_error(nm_sr_request_t *p_request)
Get the error status of the request.
nm_sr_request_get_size
static int nm_sr_request_get_size(nm_sr_request_t *request, nm_len_t *size)
Returns the actual received or sent size of the message with the specified request.
nm_sr_request_get_tag
static nm_tag_t nm_sr_request_get_tag(nm_sr_request_t *p_request)
Retrieve the tag from a sendrecv request.
nm_sr_send_rsend
static int nm_sr_send_rsend(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag)
send a built request in ready mode
nm_sr_send_header
static int nm_sr_send_header(nm_session_t p_session, nm_sr_request_t *p_request, nm_len_t hlen)
nm_sr_request_isnull
static int nm_sr_request_isnull(nm_sr_request_t *p_request)
tests whether a request is NULL
nm_sr_send_init
static void nm_sr_send_init(nm_session_t p_session, nm_sr_request_t *p_request)
Init a send request.
nm_sr_send_isend
static int nm_sr_send_isend(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag)
send a built request to given gate & tag
nm_sr_send_issend
static int nm_sr_send_issend(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag)
send a built request in synchronous mode
nm_sr_request_wait_all
static void nm_sr_request_wait_all(nm_sr_request_t **p_requests, int n)
wait for completion of an array of requests
nm_sr_event_t
nm_sr_event_t
events for nm_sr_monitor()
Definition nm_sendrecv_interface.h:40
nm_sr_request_wait
int nm_sr_request_wait(nm_sr_request_t *p_request)
Wait for request completion (or cancelation)
nm_sr_flush
int nm_sr_flush(struct nm_session_s *p_session)
Flush all pending requests (force submission to the core) and all pending events.
nm_sr_request_unset_completion_queue
int nm_sr_request_unset_completion_queue(nm_session_t p_session, nm_sr_request_t *p_request)
Ask to not enqueue the request in the completion queue upon completion.
nm_sr_request_set_completion_queue
int nm_sr_request_set_completion_queue(nm_session_t p_session, nm_sr_request_t *p_request)
Ask to enqueue the request in the completion queue upon completion.
nm_sr_request_get_expected_size
static int nm_sr_request_get_expected_size(nm_sr_request_t *request, nm_len_t *size)
Returns the expected size (to be received or to be sent) of the message with the specified request.
nm_sr_send_pack_iov
static void nm_sr_send_pack_iov(nm_session_t p_session, nm_sr_request_t *p_request, const struct iovec *iov, int num_entries)
Pack data described through iovec into the given request.
nm_sr_request_get_session
static nm_session_t nm_sr_request_get_session(nm_sr_request_t *p_request)
Returns the session this request belongs to.
nm_sr_send_pack_data
static void nm_sr_send_pack_data(nm_session_t p_session, nm_sr_request_t *p_request, const struct nm_data_s *p_data)
Pack data described through an iterator into the given request.
nm_sr_send_submit
static int nm_sr_send_submit(nm_session_t p_session, nm_sr_request_t *p_request)
submit the request once it is built
nm_sr_request_get_ref
static void * nm_sr_request_get_ref(nm_sr_request_t *p_request)
Retrieve the 'ref' from a sendrecv request.
nm_sr_request_set_ref
static int nm_sr_request_set_ref(nm_sr_request_t *p_request, void *ref)
Add a user reference to a request.
nm_sr_request_test
static int nm_sr_request_test(nm_sr_request_t *p_request, nm_status_t status)
Tests whether the given status bits are set in request.
nm_sr_send_pack_contiguous
static void nm_sr_send_pack_contiguous(nm_session_t p_session, nm_sr_request_t *p_request, const void *, nm_len_t len)
Pack contiguous data into the given request.
NM_SR_EVENT_NONE
@ NM_SR_EVENT_NONE
no event
Definition nm_sendrecv_interface.h:42
NM_SR_EVENT_RECV_DATA
@ NM_SR_EVENT_RECV_DATA
some data has arrived on a req posted without data spec
Definition nm_sendrecv_interface.h:50
NM_SR_EVENT_SEND_COMPLETED
@ NM_SR_EVENT_SEND_COMPLETED
a posted send has completed
Definition nm_sendrecv_interface.h:48
NM_SR_EVENT_RECV_CANCELLED
@ NM_SR_EVENT_RECV_CANCELLED
recv operation was canceled
Definition nm_sendrecv_interface.h:52
NM_SR_EVENT_FINALIZED
@ NM_SR_EVENT_FINALIZED
request finalized, may be freed by user
Definition nm_sendrecv_interface.h:54
NM_SR_EVENT_RECV_UNEXPECTED
@ NM_SR_EVENT_RECV_UNEXPECTED
an unexpected packet has arrived.
Definition nm_sendrecv_interface.h:44
NM_SR_EVENT_RECV_COMPLETED
@ NM_SR_EVENT_RECV_COMPLETED
a posted recv has completed
Definition nm_sendrecv_interface.h:46
nm_core_interface.h
tag
nm_tag_t tag
the user-supplied tag
Definition nm_core_interface.h:0
p_session
static nm_session_t p_session
Definition nm_examples_helper.h:25
p_gate
static nm_gate_t p_gate
Definition nm_examples_helper.h:26
priority
nm_prio_t priority
Definition nm_headers.h:6
hlen
uint16_t hlen
length in header (header + data in header)
Definition nm_headers.h:5
req
uint64_t req
a type of debug request; unused for now
Definition nm_headers.h:1
len
uint16_t len
chunk len
Definition nm_headers.h:0
status
nm_mpi_status_t status
status of request
Definition nm_mpi_private.h:7
size
nm_len_t size
size of the onsided data (not incuding target-side completion)
Definition nm_onesided_private.h:1
nm_public.h
This is the common public header for NewMad.
nm_sr_recv_unpack_data
static void nm_sr_recv_unpack_data(nm_session_t p_session, nm_sr_request_t *p_request, const struct nm_data_s *p_data)
nm_sr_recv_init
static void nm_sr_recv_init(nm_session_t p_session, nm_sr_request_t *p_request)
nm_sr_rtest
int nm_sr_rtest(nm_session_t p_session, nm_sr_request_t *p_request)
Test for the completion of a non blocking receive request.
nm_sr_recv_peek
static int nm_sr_recv_peek(nm_session_t p_session, nm_sr_request_t *p_request, const struct nm_data_s *p_data)
peek for already received (unexpected) data
nm_sr_stest
int nm_sr_stest(nm_session_t p_session, nm_sr_request_t *p_request)
Test for the completion of a non blocking send request.
nm_sr_isend_data
static int nm_sr_isend_data(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, struct nm_data_s *p_data, nm_sr_request_t *p_request)
Definition nm_sendrecv_interface.h:353
nm_sr_swait
static int nm_sr_swait(nm_session_t p_session, nm_sr_request_t *p_request)
Wait for the completion of a non blocking send request.
nm_sr_recv_data_wait
static void nm_sr_recv_data_wait(nm_session_t p_session, nm_sr_request_t *p_request)
waits for first byte of data to be available, for a request posted without data descriptor
nm_sr_session_monitor_set
int nm_sr_session_monitor_set(nm_session_t p_session, const struct nm_sr_monitor_s *p_monitor)
set a monitor for events on the session
nm_sr_irecv_with_ref
static int nm_sr_irecv_with_ref(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, void *data, nm_len_t len, nm_sr_request_t *p_request, void *ref)
Test for the completion of a non blocking receive request.
Definition nm_sendrecv_interface.h:425
nm_sr_rwait
static int nm_sr_rwait(nm_session_t p_session, nm_sr_request_t *p_request)
Wait for the completion of a non blocking receive request.
nm_sr_recv_unpack_iov
static void nm_sr_recv_unpack_iov(nm_session_t p_session, nm_sr_request_t *p_request, const struct iovec *iov, int num_entry)
nm_sr_recv_post
static int nm_sr_recv_post(nm_session_t p_session, nm_sr_request_t *p_request)
posts the receive request to the scheduler
nm_sr_session_monitor_remove
int nm_sr_session_monitor_remove(nm_session_t p_session, const struct nm_sr_monitor_s *p_monitor)
remove the event monitor from the session
nm_sr_rwait_data
static int nm_sr_rwait_data(nm_session_t p_session, nm_sr_request_t *p_request)
Wait for data to be available from a non blocking receive request.
nm_sr_recv_success
int nm_sr_recv_success(nm_session_t p_session, nm_sr_request_t **out_req)
Poll for any completed recv request (any source, any tag).
nm_sr_recv
static int nm_sr_recv(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, void *data, nm_len_t len)
blocking recv
Definition nm_sendrecv_interface.h:563
nm_sr_recv_match_event
static void nm_sr_recv_match_event(nm_session_t p_session, nm_sr_request_t *p_request, const nm_sr_event_info_t *p_event)
match the request with event
nm_sr_isend_with_ref
static int nm_sr_isend_with_ref(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const void *data, nm_len_t len, nm_sr_request_t *p_request, void *ref)
Definition nm_sendrecv_interface.h:286
nm_sr_isend_iov
static int nm_sr_isend_iov(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const struct iovec *iov, int num_entries, nm_sr_request_t *p_request)
Test for the completion of a non blocking send request.
Definition nm_sendrecv_interface.h:329
nm_sr_progress
int nm_sr_progress(nm_session_t p_session)
Calls the scheduler.
nm_sr_issend
static int nm_sr_issend(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const void *data, nm_len_t len, nm_sr_request_t *p_request)
Synchronous send.
Definition nm_sendrecv_interface.h:255
nm_sr_rcancel
int nm_sr_rcancel(nm_session_t p_session, nm_sr_request_t *p_request)
Cancel a reception request.
nm_sr_recv_data_test
static int nm_sr_recv_data_test(nm_session_t p_session, nm_sr_request_t *p_request)
checks whether data is available, for a request posted without data descriptor
nm_sr_recv_offset
static void nm_sr_recv_offset(nm_session_t p_session, nm_sr_request_t *p_request, nm_len_t offset)
set offset of data to receive; data before offset will be discarded
nm_sr_recv_peek_offset
static int nm_sr_recv_peek_offset(nm_session_t p_session, nm_sr_request_t *p_request, const struct nm_data_s *p_data, nm_len_t peek_offset, nm_len_t peek_len)
peek for already received (unexpected) data, with offset and explicit len
nm_sr_recv_match
static void nm_sr_recv_match(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask)
match the request with given gate/tag/mask
nm_sr_irecv_data
static int nm_sr_irecv_data(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, struct nm_data_s *p_data, nm_sr_request_t *p_request)
Definition nm_sendrecv_interface.h:458
nm_sr_irecv_iov
static int nm_sr_irecv_iov(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, struct iovec *iov, int num_entries, nm_sr_request_t *p_request)
Definition nm_sendrecv_interface.h:437
nm_sr_recv_source
int nm_sr_recv_source(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t *p_gate)
Retrieve the pkt source of a complete any source receive request.
nm_sr_isend_iov_with_ref
static int nm_sr_isend_iov_with_ref(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const struct iovec *iov, int num_entries, nm_sr_request_t *p_request, void *ref)
Definition nm_sendrecv_interface.h:340
nm_sr_recv_unpack_contiguous
static void nm_sr_recv_unpack_contiguous(nm_session_t p_session, nm_sr_request_t *p_request, void *ptr, nm_len_t len)
nm_sr_send
static int nm_sr_send(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const void *data, nm_len_t len)
blocking send
Definition nm_sendrecv_interface.h:549
nm_sr_recv_irecv
static int nm_sr_recv_irecv(nm_session_t p_session, nm_sr_request_t *p_request, nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask)
nm_sr_send_success
int nm_sr_send_success(nm_session_t p_session, nm_sr_request_t **out_req)
Poll for any completed send request.
nm_sr_probe
int nm_sr_probe(nm_session_t p_session, nm_gate_t p_gate, nm_gate_t *p_out_gate, nm_tag_t tag, nm_tag_t tag_mask, nm_tag_t *p_out_tag, nm_len_t *p_out_len)
Unblockingly check if a packet is available for extraction on the (gate,tag) pair .
nm_sr_rsend
static int nm_sr_rsend(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const void *data, nm_len_t len, nm_sr_request_t *p_request)
Post a ready send request, i.e.
Definition nm_sendrecv_interface.h:309
nm_sr_irecv
static int nm_sr_irecv(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, void *data, nm_len_t len, nm_sr_request_t *p_request)
Post a non blocking receive request.
Definition nm_sendrecv_interface.h:404
nm_sr_irecv_iov_with_ref
static int nm_sr_irecv_iov_with_ref(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, struct iovec *iov, int num_entries, nm_sr_request_t *p_request, void *ref)
Definition nm_sendrecv_interface.h:447
nm_sr_recv_iprobe
static int nm_sr_recv_iprobe(nm_session_t p_session, nm_sr_request_t *p_request)
probes whether an incoming packet matched this non-posted request
nm_sr_monitor
int nm_sr_monitor(nm_session_t p_session, nm_sr_event_t mask, nm_sr_event_notifier_t notifier)
monitors sendrecv events globally
nm_sr_scancel
int nm_sr_scancel(nm_session_t p_session, nm_sr_request_t *p_request)
Cancel a emission request.
nm_sr_isend
static int nm_sr_isend(nm_session_t p_session, nm_gate_t p_gate, nm_tag_t tag, const void *data, nm_len_t len, nm_sr_request_t *p_request)
Post a non blocking send request.
Definition nm_sendrecv_interface.h:275
nm_sr_recv_data_size_wait
static void nm_sr_recv_data_size_wait(nm_session_t p_session, nm_sr_request_t *p_request)
waits for data size to be available, for a request posted without data descriptor
nm_sendrecv_private.h
This file contains private bits of the sendrecv interface.
nm_session_interface.h
nm_prio_t
int32_t nm_prio_t
message priority
Definition nm_types.h:78
nm_tag_t
uint64_t nm_tag_t
user tags, 64 bits, contained in indirect hashtable
Definition nm_types.h:56
nm_len_t
uint64_t nm_len_t
data length used by nmad
Definition nm_types.h:68
NM_TAG_MASK_FULL
#define NM_TAG_MASK_FULL
tag mask that matches all bits
Definition nm_types.h:61
nm_chunk_s
Definition nm_core_interface.h:454
nm_core_event_s
An event, generated by the NewMad core.
Definition nm_core_interface.h:302
nm_data_s
a data descriptor, used to pack/unpack data from app layout to/from contiguous buffers
Definition nm_data.h:196
nm_gate_s
Connection to another process.
Definition nm_gate.h:104
nm_session_s
Definition nm_session_private.h:24
nm_sr_monitor_s
a global monitor to listen to events on the full session
Definition nm_sendrecv_interface.h:83
nm_sr_monitor_s::tag
nm_tag_t tag
tag value for event filter
Definition nm_sendrecv_interface.h:87
nm_sr_monitor_s::p_notifier
nm_sr_event_notifier_t p_notifier
the function to call when a matching event happen
Definition nm_sendrecv_interface.h:84
nm_sr_monitor_s::tag_mask
nm_tag_t tag_mask
tag mask for event filter- fire event when event.tag & monitor.tag_mask == monitor....
Definition nm_sendrecv_interface.h:88
nm_sr_monitor_s::ref
void * ref
reference for user
Definition nm_sendrecv_interface.h:89
nm_sr_monitor_s::event_mask
nm_sr_event_t event_mask
a bitmask containing events kinds to listen to
Definition nm_sendrecv_interface.h:85
nm_sr_monitor_s::p_gate
nm_gate_t p_gate
listen for events on given gate; NM_ANY_GATE for any
Definition nm_sendrecv_interface.h:86
nm_sr_request_s
internal defintion of the sendrecv request
Definition nm_sendrecv_private.h:53
nm_sr_event_info_t
information field for sendrecv events
Definition nm_sendrecv_interface.h:62
nm_sr_event_info_t::p_core_event
const struct nm_core_event_s * p_core_event
Definition nm_sendrecv_interface.h:69
nm_sr_event_info_t::p_request
nm_sr_request_t * p_request
the request on which the event happened
Definition nm_sendrecv_interface.h:73
nm_sr_event_info_t::p_session
nm_session_t p_session
session where the unexpected packet arrived
Definition nm_sendrecv_interface.h:68
nm_sr_event_info_t::tag
nm_tag_t tag
tag of the unexpected received packet
Definition nm_sendrecv_interface.h:66
nm_sr_event_info_t::p_gate
nm_gate_t p_gate
gate from where the unexpected packet arrived
Definition nm_sendrecv_interface.h:65
nm_sr_event_info_t::len
nm_len_t len
length of unexpected data
Definition nm_sendrecv_interface.h:67