nm_colldrv.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 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_COLLDRV_H
#define NM_COLLDRV_H
 
#include <nm_public.h>
#include <nm_core_interface.h>
#include <Padico/Puk.h>
 
 
/* ********************************************************* */
/* ** coll driver interface */
 
typedef void (*nm_colldrv_req_notifier_t)(void*ref);
 
struct nm_colldrv_req_s
{
#ifdef NMAD_PIOMAN
  struct piom_ltask_s ltask;
#else /* NMAD_PIOMAN */
  struct nm_core_pollable_s pollable; 
#endif /* NMAD_PIOMAN */
  struct nm_colldrv_s*p_colldrv; 
  nm_core_tag_t core_tag;
  int root;                      
  int self;                      
  enum nm_colldrv_op_e
    {
      NM_COLLDRV_OP_NONE,
      NM_COLLDRV_OP_WAITALL,  
      NM_COLLDRV_OP_BARRIER,  
      NM_COLLDRV_OP_BCAST,    
      NM_COLLDRV_OP_SCATTER,
      NM_COLLDRV_OP_GATHER
    } op;
  struct nm_data_s data;      
  void*p_buf;                 
  nm_len_t buf_len;           
  nm_gate_t*p_gates;          
  int n_gates;                
  const struct nm_uuid_binary_s*p_group_uuid; 
  void*p_drv_specific;
  nm_colldrv_req_notifier_t p_notify; 
  void*p_notify_ref;                  
};
 
struct nm_coll_driver_properties_s
{
  const char*nickname;
  struct nm_coll_driver_capabilities_s
  {
    nm_len_t max_msg_size;
  } capabilities;
};
 
struct nm_coll_driver_interface_s
{
  /* ** init */
  void (*getprops)(puk_context_t context, struct nm_coll_driver_properties_s*p_props);
  void (*init)(puk_context_t context);
  void (*finalize)(puk_context_t context);
  /* ** collectives */
  void (*buf_get)(puk_context_t context, struct nm_colldrv_req_s*p_colldrv_req);
  void (*buf_release)(puk_context_t context, struct nm_colldrv_req_s*p_colldrv_req);
  void (*dispatch)(puk_context_t context, struct nm_colldrv_req_s*p_colldrv_req);
  int  (*poll)(puk_context_t context, struct nm_colldrv_req_s*p_colldrv_req);
};
PUK_IFACE_TYPE(NewMad_coll_driver, struct nm_coll_driver_interface_s);
 
/* ********************************************************* */
/* ** front-end */
 
struct nm_colldrv_s
{
  const struct nm_coll_driver_interface_s*p_driver;
  puk_context_t p_context;
  puk_component_t p_component;
  struct nm_coll_driver_properties_s properties;
};
 
static inline void nm_colldrv_getprops(struct nm_colldrv_s*p_colldrv, struct nm_coll_driver_properties_s*p_props)
{
  (*p_colldrv->p_driver->getprops)(p_colldrv->p_context, p_props);
}
 
static inline void nm_colldrv_buf_get(struct nm_colldrv_s*p_colldrv, struct nm_colldrv_req_s*p_colldrv_req)
{
  (*p_colldrv->p_driver->buf_get)(p_colldrv->p_context, p_colldrv_req);
}
 
static inline void nm_colldrv_buf_release(struct nm_colldrv_s*p_colldrv, struct nm_colldrv_req_s*p_colldrv_req)
{
  (*p_colldrv->p_driver->buf_release)(p_colldrv->p_context, p_colldrv_req);
}
 
static inline void nm_colldrv_dispatch(struct nm_colldrv_s*p_colldrv, struct nm_colldrv_req_s*p_colldrv_req)
{
  (*p_colldrv->p_driver->dispatch)(p_colldrv->p_context, p_colldrv_req);
}
 
static inline int nm_colldrv_poll(struct nm_colldrv_s*p_colldrv, struct nm_colldrv_req_s*p_colldrv_req)
{
  return (*p_colldrv->p_driver->poll)(p_colldrv->p_context, p_colldrv_req);
}
 
#endif /* NM_COLLDRV_H */