nm_coll_dynamic_private.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2019-2026 (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_COLL_PRIVATE_H
#define NM_COLL_PRIVATE_H
 
#include <nm_sendrecv_interface.h>
#include <nm_rpc_interface.h>
#include <nm_coll_dynamic_interface.h>
 
#ifdef PIOMAN
 
struct multicast_header_s
{
  nm_len_t body_len; // See (struct nm_multicast_req_s).body_len
  int nb_nodes;
  int src_node;
}  __attribute__((packed));
 
 
enum nm_multicast_req_type_e
  {
    UNSPECIFIED, // Error !
    PENDING, // I'm the pending recv: the recv always posted to receive broadcast messages which have not matching user recv
    USER_RECV, // I'm the recv posted by the user
    INITIAL_SEND, // I'm the node which called nm_coll_dynamic_send*() and this is my first send
    FORWARD_INITIAL, // I'm the node which called nm_coll_dynamic_send*(), but it's not my first send
    FORWARD_RECV // I received data from a broadcast, and I'm forwarding it to other nodes
  };
 
 
struct nm_multicast_req_s
{
  /* Common attributes for send and recv requests: */
  nm_sr_request_t*request;                
  nm_session_t p_session;                 
  struct nm_data_s body_data;             
  int*ref_nodes;                          
  int*ref_prios;                          
  struct multicast_header_s*ref_header;   
  nm_tag_t tag;
 
  /* Attributes for recv requests: */
  int src_node;
  void (*come_from_coop_callback)(struct nm_data_s*, nm_len_t, void*);
  void*come_from_coop_callback_arg;
  void (*end_recv_callback)(void*);
  void*end_recv_callback_arg;
  void (*normal_recv_recv_data_callback)(nm_sr_request_t*, void*);
  void*normal_recv_recv_data_callback_arg;
  piom_cond_t*cond_wait_recv;
  struct nm_data_s header_data;           
  struct nm_data_s multicast_data;        
  nm_rpc_token_t rpc_token;
  void*copied_data_ptr;                   
  /* Attributes for send requests: */
  int last;                               
  int nb_nodes_in_tree;
  int tree_step;
  int tree_additionnal_info;
  nm_len_t body_len;                       
  struct nm_multicast_req_s*initial_recv;  
  void (*end_send_callback)(void*);
  void*end_send_callback_arg;
 
  enum nm_multicast_req_type_e type;
};
 
PUK_ALLOCATOR_TYPE(nm_multicast_req, struct nm_multicast_req_s);
 
void free_request_nodes_data(struct nm_multicast_req_s*p_req);
void send_multicast(int*nodes, int*prios, int nb_nodes, nm_tag_t tag, struct nm_data_s*data,
                    nm_len_t body_len, int tree_step, int separator_id, int src_node,
                    struct nm_multicast_req_s*initial_recv, callback_function end_send_callback, void*arg);
 
void monitor_send(nm_rpc_req_t rpc_req, void*_ref);
void normal_receive_handler(nm_sr_event_t event, const nm_sr_event_info_t*p_info, void*_ref);
void register_recv_data(nm_session_t p_session, int src_node, nm_tag_t tag, struct nm_data_s*data,
                        nm_len_t len, nm_sr_request_t *p_request, piom_cond_t*cond_wait_recv,
                        callback_function_come_from_coop come_from_coop_callback, callback_function end_recv_callback,
                        callback_function_normal_recv normal_recv_callback, void*arg);
 
 
#else /* PIOMAN */
#  error "cannot use interface coll_dynamic without pioman"
#endif /* PIOMAN */
 
#endif /* NM_COLL_PRIVATE_H */