NewMadeleine

Documentation

nm_sendrecv_interface.h
Go to the documentation of this file.
1/*
2 * NewMadeleine
3 * Copyright (C) 2006-2023 (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
39typedef enum
40 {
42 NM_SR_EVENT_RECV_UNEXPECTED = NM_STATUS_UNEXPECTED,
44 NM_SR_EVENT_RECV_COMPLETED = NM_STATUS_UNPACK_COMPLETED,
46 NM_SR_EVENT_SEND_COMPLETED = NM_STATUS_PACK_COMPLETED,
48 NM_SR_EVENT_RECV_DATA = NM_STATUS_UNPACK_DATA0,
50 NM_SR_EVENT_RECV_CANCELLED = NM_STATUS_UNPACK_CANCELLED,
52 NM_SR_EVENT_FINALIZED = NM_STATUS_FINALIZED
53 } nm_sr_event_t;
54
56typedef struct nm_sr_request_s nm_sr_request_t;
57
59typedef union
60{
61 struct
62 {
63 nm_gate_t p_gate;
64 nm_tag_t tag;
65 nm_len_t len;
66 nm_session_t p_session;
67 const struct nm_core_event_s*p_core_event;
68 } recv_unexpected;
69 struct
70 {
71 nm_sr_request_t*p_request;
72 } req;
73} nm_sr_event_info_t;
74
77typedef void (*nm_sr_event_notifier_t)(nm_sr_event_t event, const nm_sr_event_info_t*event_info, void*ref);
78
80struct nm_sr_monitor_s
81{
82 nm_sr_event_notifier_t p_notifier;
83 nm_sr_event_t event_mask;
84 nm_gate_t p_gate;
85 nm_tag_t tag;
86 nm_tag_t tag_mask;
87 void*ref;
88};
89
90/* ** Operations on requests (send or recv) **************** */
91
93extern int nm_sr_request_monitor(nm_session_t p_session, nm_sr_request_t*p_request,
94 nm_sr_event_t mask, nm_sr_event_notifier_t notifier);
95
97extern int nm_sr_request_set_completion_queue(nm_session_t p_session, nm_sr_request_t*p_request);
98
102extern int nm_sr_request_unset_completion_queue(nm_session_t p_session, nm_sr_request_t*p_request);
103
105static inline int nm_sr_request_isnull(nm_sr_request_t*p_request);
106
108static inline int nm_sr_request_set_ref(nm_sr_request_t*p_request, void*ref);
109
111static inline void*nm_sr_request_get_ref(nm_sr_request_t*p_request);
112
114static inline nm_tag_t nm_sr_request_get_tag(nm_sr_request_t*p_request);
115
117static inline int nm_sr_request_get_size(nm_sr_request_t *request, nm_len_t*size);
118
120static inline int nm_sr_request_get_expected_size(nm_sr_request_t *request, nm_len_t*size);
121
122static inline nm_gate_t nm_sr_request_get_gate(nm_sr_request_t*p_request);
123
125static inline nm_session_t nm_sr_request_get_session(nm_sr_request_t*p_request);
126
128extern int nm_sr_request_wait(nm_sr_request_t*p_request);
129
131static inline void nm_sr_request_wait_all(nm_sr_request_t**p_requests, int n);
132
134static inline int nm_sr_request_test(nm_sr_request_t*p_request, nm_status_t status);
135
137static inline int nm_sr_request_get_error(nm_sr_request_t*p_request);
138
141extern int nm_sr_flush(struct nm_session_s*p_session);
142
143
144/* ** Building blocks for send ***************************** */
145
146/* Rationale for the send interface:
147 * either use the high-level interface (nm_sr_isend() et al., see below
148 * or the low-level building blocks
149 * Sequence for a send with the low-level building blocks:
150 * 1. nm_sr_send_init() init request
151 * 2. nm_sr_send_pack_*() pack data into request
152 * 3. nm_sr_send_isend|issend|rsend() to send data
153 * alternative:
154 * 3.1 nm_sr_send_dest() set destination of message
155 * 3.2 nm_sr_send_header() set data header size
156 * 3.3 nm_sr_send_submit() submit send request to nmad
157 */
158
160static inline void nm_sr_send_init(nm_session_t p_session, nm_sr_request_t*p_request);
162static inline void nm_sr_send_pack_contiguous(nm_session_t p_session, nm_sr_request_t*p_request,
163 const void*, nm_len_t len);
165static inline void nm_sr_send_pack_iov(nm_session_t p_session, nm_sr_request_t*p_request,
166 const struct iovec*iov, int num_entries);
168static inline void nm_sr_send_pack_data(nm_session_t p_session, nm_sr_request_t*p_request,
169 const struct nm_data_s*p_data);
171static inline int nm_sr_send_isend(nm_session_t p_session, nm_sr_request_t*p_request,
172 nm_gate_t p_gate, nm_tag_t tag);
174static inline int nm_sr_send_issend(nm_session_t p_session, nm_sr_request_t*p_request,
175 nm_gate_t p_gate, nm_tag_t tag);
177static inline int nm_sr_send_rsend(nm_session_t p_session, nm_sr_request_t*p_request,
178 nm_gate_t p_gate, nm_tag_t tag);
180static inline int nm_sr_send_dest(nm_session_t p_session, nm_sr_request_t*p_request,
181 nm_gate_t p_gate, nm_tag_t tag);
184static inline int nm_sr_send_header(nm_session_t p_session, nm_sr_request_t*p_request, nm_len_t hlen);
186static inline int nm_sr_send_submit(nm_session_t p_session, nm_sr_request_t*p_request);
191static inline int nm_sr_send_submit_chunks(nm_session_t p_session, nm_sr_request_t*p_request,
192 int n, const struct nm_chunk_s*p_chunks);
196static inline void nm_sr_send_set_priority(nm_session_t p_session, nm_sr_request_t*p_request, nm_prio_t priority);
197
198
202#define NM_SR_PRIORITY_MIN INT_MIN
203
205#define NM_SR_PRIORITY_MAX INT_MAX
206
207/* ** Building blocks for recv ***************************** */
208
209static inline void nm_sr_recv_init(nm_session_t p_session, nm_sr_request_t*p_request);
210static inline void nm_sr_recv_unpack_contiguous(nm_session_t p_session, nm_sr_request_t*p_request,
211 void*ptr, nm_len_t len);
212static inline void nm_sr_recv_unpack_iov(nm_session_t p_session, nm_sr_request_t*p_request,
213 const struct iovec*iov, int num_entry);
214static inline void nm_sr_recv_unpack_data(nm_session_t p_session, nm_sr_request_t*p_request,
215 const struct nm_data_s*p_data);
216static inline int nm_sr_recv_irecv(nm_session_t p_session, nm_sr_request_t*p_request,
217 nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask);
219static inline void nm_sr_recv_match(nm_session_t p_session, nm_sr_request_t*p_request,
220 nm_gate_t p_gate, nm_tag_t tag, nm_tag_t mask);
222static inline void nm_sr_recv_match_event(nm_session_t p_session, nm_sr_request_t*p_request,
223 const nm_sr_event_info_t*p_event);
225static inline int nm_sr_recv_peek(nm_session_t p_session, nm_sr_request_t*p_request,
226 const struct nm_data_s*p_data);
227
229static inline int nm_sr_recv_peek_offset(nm_session_t p_session, nm_sr_request_t*p_request,
230 const struct nm_data_s*p_data, nm_len_t peek_offset, nm_len_t peek_len);
231
233static inline void nm_sr_recv_offset(nm_session_t p_session, nm_sr_request_t*p_request, nm_len_t offset);
234
236static inline int nm_sr_recv_iprobe(nm_session_t p_session, nm_sr_request_t*p_request);
237
239static inline void nm_sr_recv_data_wait(nm_session_t p_session, nm_sr_request_t*p_request);
240
242static inline void nm_sr_recv_data_size_wait(nm_session_t p_session, nm_sr_request_t*p_request);
243
245static inline int nm_sr_recv_data_test(nm_session_t p_session, nm_sr_request_t*p_request);
246
248static inline int nm_sr_recv_post(nm_session_t p_session, nm_sr_request_t*p_request);
249
250/* ** High level / legacy send ***************************** */
251
253static inline int nm_sr_issend(nm_session_t p_session,
254 nm_gate_t p_gate, nm_tag_t tag,
255 const void *data, nm_len_t len,
256 nm_sr_request_t *p_request)
257{
258 nm_sr_send_init(p_session, p_request);
259 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
260 const int err = nm_sr_send_issend(p_session, p_request, p_gate, tag);
261 return err;
262}
263
273static inline int nm_sr_isend(nm_session_t p_session,
274 nm_gate_t p_gate, nm_tag_t tag,
275 const void *data, nm_len_t len,
276 nm_sr_request_t *p_request)
277{
278 nm_sr_send_init(p_session, p_request);
279 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
280 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
281 return err;
282}
283
284static inline int nm_sr_isend_with_ref(nm_session_t p_session,
285 nm_gate_t p_gate, nm_tag_t tag,
286 const void *data, nm_len_t len,
287 nm_sr_request_t *p_request,
288 void*ref)
289{
290 nm_sr_send_init(p_session, p_request);
291 nm_sr_request_set_ref(p_request, ref);
292 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
293 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
294 return err;
295}
296
307static inline int nm_sr_rsend(nm_session_t p_session,
308 nm_gate_t p_gate, nm_tag_t tag,
309 const void *data, nm_len_t len,
310 nm_sr_request_t *p_request)
311{
312 nm_sr_send_init(p_session, p_request);
313 nm_sr_send_pack_contiguous(p_session, p_request, data, len);
314 const int err = nm_sr_send_rsend(p_session, p_request, p_gate, tag);
315 return err;
316}
317
327static inline int nm_sr_isend_iov(nm_session_t p_session,
328 nm_gate_t p_gate, nm_tag_t tag,
329 const struct iovec *iov, int num_entries,
330 nm_sr_request_t *p_request)
331{
332 nm_sr_send_init(p_session, p_request);
333 nm_sr_send_pack_iov(p_session, p_request, iov, num_entries);
334 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
335 return err;
336}
337
338static inline int nm_sr_isend_iov_with_ref(nm_session_t p_session,
339 nm_gate_t p_gate, nm_tag_t tag,
340 const struct iovec *iov, int num_entries,
341 nm_sr_request_t *p_request,
342 void*ref)
343{
344 nm_sr_send_init(p_session, p_request);
345 nm_sr_request_set_ref(p_request, ref);
346 nm_sr_send_pack_iov(p_session, p_request, iov, num_entries);
347 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
348 return err;
349}
350
351static inline int nm_sr_isend_data(nm_session_t p_session,
352 nm_gate_t p_gate, nm_tag_t tag,
353 struct nm_data_s*p_data,
354 nm_sr_request_t*p_request)
355{
356 nm_sr_send_init(p_session, p_request);
357 nm_sr_send_pack_data(p_session, p_request, p_data);
358 const int err = nm_sr_send_isend(p_session, p_request, p_gate, tag);
359 return err;
360}
361
362
368extern int nm_sr_stest(nm_session_t p_session,
369 nm_sr_request_t *p_request);
370
375extern int nm_sr_progress(nm_session_t p_session);
376
382static inline int nm_sr_swait(nm_session_t p_session, nm_sr_request_t*p_request);
383
389extern int nm_sr_scancel(nm_session_t p_session,
390 nm_sr_request_t *p_request);
391
392
402static inline int nm_sr_irecv(nm_session_t p_session,
403 nm_gate_t p_gate, nm_tag_t tag,
404 void *data, nm_len_t len,
405 nm_sr_request_t *p_request)
406{
407 nm_sr_recv_init(p_session, p_request);
408 nm_sr_recv_unpack_contiguous(p_session, p_request, data, len);
409 nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
410 return NM_ESUCCESS;
411}
412
423static inline int nm_sr_irecv_with_ref(nm_session_t p_session,
424 nm_gate_t p_gate, nm_tag_t tag,
425 void *data, nm_len_t len,
426 nm_sr_request_t *p_request,
427 void *ref)
428{
429 nm_sr_recv_init(p_session, p_request);
430 nm_sr_request_set_ref(p_request, ref);
431 nm_sr_recv_unpack_contiguous(p_session, p_request, data, len);
432 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
433}
434
435static inline int nm_sr_irecv_iov(nm_session_t p_session,
436 nm_gate_t p_gate, nm_tag_t tag,
437 struct iovec *iov, int num_entries,
438 nm_sr_request_t *p_request)
439{
440 nm_sr_recv_init(p_session, p_request);
441 nm_sr_recv_unpack_iov(p_session, p_request, iov, num_entries);
442 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
443}
444
445static inline int nm_sr_irecv_iov_with_ref(nm_session_t p_session,
446 nm_gate_t p_gate, nm_tag_t tag,
447 struct iovec *iov, int num_entries,
448 nm_sr_request_t *p_request, void *ref)
449{
450 nm_sr_recv_init(p_session, p_request);
451 nm_sr_request_set_ref(p_request, ref);
452 nm_sr_recv_unpack_iov(p_session, p_request, iov, num_entries);
453 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
454}
455
456static inline int nm_sr_irecv_data(nm_session_t p_session,
457 nm_gate_t p_gate, nm_tag_t tag,
458 struct nm_data_s*p_data,
459 nm_sr_request_t *p_request)
460{
461 nm_sr_recv_init(p_session, p_request);
462 nm_sr_recv_unpack_data(p_session, p_request, p_data);
463 return nm_sr_recv_irecv(p_session, p_request, p_gate, tag, NM_TAG_MASK_FULL);
464}
465
466
472extern int nm_sr_rtest(nm_session_t p_session, nm_sr_request_t *p_request);
473
474
480static inline int nm_sr_rwait(nm_session_t p_session, nm_sr_request_t*p_request);
481
489static inline int nm_sr_rwait_data(nm_session_t p_session, nm_sr_request_t*p_request);
490
496extern int nm_sr_rcancel(nm_session_t p_session, nm_sr_request_t *p_request);
497
504extern int nm_sr_recv_source(nm_session_t p_session,
505 nm_sr_request_t *p_request, nm_gate_t *p_gate);
506
518extern int nm_sr_probe(nm_session_t p_session,
519 nm_gate_t p_gate, nm_gate_t *p_out_gate,
520 nm_tag_t tag, nm_tag_t tag_mask, nm_tag_t*p_out_tag,
521 nm_len_t*p_out_len);
522
524extern int nm_sr_monitor(nm_session_t p_session, nm_sr_event_t mask, nm_sr_event_notifier_t notifier);
525
527int nm_sr_session_monitor_set(nm_session_t p_session, const struct nm_sr_monitor_s*p_monitor);
528
530int nm_sr_session_monitor_remove(nm_session_t p_session, const struct nm_sr_monitor_s*p_monitor);
531
535extern int nm_sr_recv_success(nm_session_t p_session, nm_sr_request_t **out_req);
536
540extern int nm_sr_send_success(nm_session_t p_session, nm_sr_request_t **out_req);
541
542
543
544#include <nm_sendrecv_private.h> /* private header included for inlining */
545
547static inline int nm_sr_send(nm_session_t p_session,
548 nm_gate_t p_gate, nm_tag_t tag,
549 const void *data, nm_len_t len)
550{
551 nm_sr_request_t request;
552 int rc = nm_sr_isend(p_session, p_gate, tag, data, len, &request);
553 if(rc == NM_ESUCCESS)
554 {
555 rc = nm_sr_swait(p_session, &request);
556 }
557 return rc;
558}
559
561static inline int nm_sr_recv(nm_session_t p_session,
562 nm_gate_t p_gate, nm_tag_t tag,
563 void *data, nm_len_t len)
564{
565 nm_sr_request_t request;
566 int rc = nm_sr_irecv(p_session, p_gate, tag, data, len, &request);
567 if(rc == NM_ESUCCESS)
568 {
569 rc = nm_sr_rwait(p_session, &request);
570 }
571 return rc;
572}
573
574#endif /* NM_SENDRECV_INTERFACE_H */
NM_STATUS_UNPACK_CANCELLED
#define NM_STATUS_UNPACK_CANCELLED
unpack operation has been cancelled
Definition: nm_core_interface.h:148
NM_STATUS_FINALIZED
#define NM_STATUS_FINALIZED
request is finalized, may be freed
Definition: nm_core_interface.h:160
NM_STATUS_UNEXPECTED
#define NM_STATUS_UNEXPECTED
data or rdv has arrived, with no matching unpack
Definition: nm_core_interface.h:146
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:156
nm_status_t
uint32_t nm_status_t
status bits of pack/unpack requests
Definition: nm_core_interface.h:128
NM_STATUS_PACK_COMPLETED
#define NM_STATUS_PACK_COMPLETED
sending operation has completed
Definition: nm_core_interface.h:142
NM_STATUS_UNPACK_COMPLETED
#define NM_STATUS_UNPACK_COMPLETED
unpack operation has completed
Definition: nm_core_interface.h:144
NM_ESUCCESS
@ NM_ESUCCESS
successful operation
Definition: nm_errno.h:34
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:77
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_RECV_DATA
@ NM_SR_EVENT_RECV_DATA
some data has arrived on a req posted without data spec
Definition: nm_sendrecv_interface.h:48
NM_SR_EVENT_SEND_COMPLETED
@ NM_SR_EVENT_SEND_COMPLETED
a posted send has completed
Definition: nm_sendrecv_interface.h:46
NM_SR_EVENT_RECV_CANCELLED
@ NM_SR_EVENT_RECV_CANCELLED
recv operation was canceled
Definition: nm_sendrecv_interface.h:50
NM_SR_EVENT_FINALIZED
@ NM_SR_EVENT_FINALIZED
request finalized, may be freed by user
Definition: nm_sendrecv_interface.h:52
NM_SR_EVENT_RECV_UNEXPECTED
@ NM_SR_EVENT_RECV_UNEXPECTED
an unexpected packet has arrived.
Definition: nm_sendrecv_interface.h:42
NM_SR_EVENT_RECV_COMPLETED
@ NM_SR_EVENT_RECV_COMPLETED
a posted recv has completed
Definition: nm_sendrecv_interface.h:44
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:351
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:423
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:561
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:284
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:327
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:253
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:456
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:435
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:338
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:547
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:307
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:402
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:445
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:273
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:80
nm_tag_t
uint64_t nm_tag_t
user tags, 64 bits, contained in indirect hashtable
Definition: nm_types.h:58
nm_len_t
uint64_t nm_len_t
data length used by nmad
Definition: nm_types.h:70
NM_TAG_MASK_FULL
#define NM_TAG_MASK_FULL
tag mask that matches all bits
Definition: nm_types.h:63
nm_chunk_s
Definition: nm_core_interface.h:311
nm_core_event_s
An event, generated by the NewMad core.
Definition: nm_core_interface.h:258
nm_data_s
a data descriptor, used to pack/unpack data from app layout to/from contiguous buffers
Definition: nm_data.h:189
nm_gate_s
Connection to another process.
Definition: nm_gate.h:100
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:81
nm_sr_monitor_s::tag
nm_tag_t tag
tag value for event filter
Definition: nm_sendrecv_interface.h:85
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:82
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:86
nm_sr_monitor_s::ref
void * ref
reference for user
Definition: nm_sendrecv_interface.h:87
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:83
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:84
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:60
nm_sr_event_info_t::p_core_event
const struct nm_core_event_s * p_core_event
Definition: nm_sendrecv_interface.h:67
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:71
nm_sr_event_info_t::p_session
nm_session_t p_session
session where the unexpected packet arrived
Definition: nm_sendrecv_interface.h:66
nm_sr_event_info_t::tag
nm_tag_t tag
tag of the unexpected received packet
Definition: nm_sendrecv_interface.h:64
nm_sr_event_info_t::p_gate
nm_gate_t p_gate
gate from where the unexpected packet arrived
Definition: nm_sendrecv_interface.h:63
nm_sr_event_info_t::len
nm_len_t len
length of unexpected data
Definition: nm_sendrecv_interface.h:65