nm_onesided_interface.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-2022 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
 
#ifndef NM_ONESIDED_INTERFACE_H
#define NM_ONESIDED_INTERFACE_H
 
#include <nm_public.h>
#include <nm_sendrecv_interface.h>
#include <nm_onesided_private.h>
 
#include <stdint.h>
 
/* ********************************************************* */
 
typedef struct nm_onesided_s*nm_onesided_t;
 
void nm_onesided_init(nm_session_t p_session, nm_onesided_t*pp_onesided);
 
void nm_onesided_finalize(nm_onesided_t p_onesided);
 
/* ** basic ops ******************************************** */
 
typedef struct nm_onesided_request_s nm_onesided_request_t;
 
void nm_onesided_iput(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                      const void*p_ptr, nm_len_t len, uintptr_t dest_addr, nm_onesided_request_t*p_req);
 
void nm_onesided_iput_data(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                           struct nm_data_s*p_data, uintptr_t dest_addr, nm_onesided_request_t*p_req);
 
void nm_onesided_iget(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                      void*p_ptr, nm_len_t len, uintptr_t dest_addr, nm_onesided_request_t*p_req);
 
void nm_onesided_iget_data(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                           struct nm_data_s*p_data, uintptr_t dest_addr, nm_onesided_request_t*p_req);
 
void nm_onesided_ifence(nm_onesided_t p_onesided, struct nm_gate_s*p_gate, nm_onesided_request_t*p_req);
 
void nm_onesided_req_wait(nm_onesided_request_t*p_req);
 
void nm_onesided_req_wait_all(nm_onesided_request_t**p_reqs, int n);
 
int nm_onesided_req_test(nm_onesided_request_t*p_req);
 
/* ** remote queues **************************************** */
 
typedef int nm_onesided_queue_id_t;
 
nm_onesided_queue_id_t nm_onesided_queue_create(nm_onesided_t p_onesided);
 
void nm_onesided_queue_ienqueue(nm_onesided_t p_onesided, struct nm_gate_s*p_gate, nm_onesided_queue_id_t queue,
                                const void*p_ptr, nm_len_t len, nm_onesided_request_t*p_req);
 
void nm_onesided_queue_enqueue(nm_onesided_t p_onesided, struct nm_gate_s*p_gate, nm_onesided_queue_id_t queue,
                               const void*p_ptr, nm_len_t len);
 
void*nm_onesided_queue_dequeue(nm_onesided_t p_onesided, nm_onesided_queue_id_t queue);
 
/* ** target-side completions ****************************** */
 
typedef struct nm_onesided_target_request_s nm_onesided_target_request_t;
 
void nm_onesided_iput_with_target(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                                  void*p_ptr, nm_len_t len, uintptr_t dest_addr,
                                  void*p_target_ptr, nm_len_t target_len,
                                  nm_onesided_request_t*p_req);
 
void nm_onesided_iget_with_target(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                                  void*p_ptr, nm_len_t len, uintptr_t dest_addr,
                                  void*p_target_ptr, nm_len_t target_len,
                                  nm_onesided_request_t*p_req);
 
void nm_onesided_target_irecv(nm_onesided_t p_onesided, nm_gate_t p_gate, void*p_ptr, nm_len_t len,
                              nm_onesided_target_request_t*p_req);
 
void nm_onesided_target_wait(nm_onesided_target_request_t*p_req);
 
nm_gate_t nm_onesided_target_get_source(nm_onesided_target_request_t*p_req);
 
uintptr_t nm_onesided_target_get_addr(nm_onesided_target_request_t*p_req);
 
nm_len_t nm_onesided_target_get_size(nm_onesided_target_request_t*p_req);
 
/* ** blocking versions ************************************ */
 
void nm_onesided_put(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                     void*p_ptr, nm_len_t len, uintptr_t dest_addr);
 
void nm_onesided_get(nm_onesided_t p_onesided, struct nm_gate_s*p_gate,
                     void*p_ptr, nm_len_t len, uintptr_t dest_addr);
 
void nm_onesided_fence(nm_onesided_t p_onesided, struct nm_gate_s*p_gate);
 
#endif /* NM_ONESIDED_INTERFACE_H */