nm_launcher_interface.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-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_LAUNCHER_INTERFACE_H
#define NM_LAUNCHER_INTERFACE_H
 
#include <nm_public.h>
#include <nm_session_interface.h>
 
NM_EXTERN_C_BEGIN
 
PUK_VECT_TYPE(nm_launcher_rank, int);
 
PUK_VECT_TYPE(nm_launcher_subgroup, int);
 
static inline int nm_launcher_init(int*argc, char**argv);
 
int nm_launcher_exit(void);
 
int nm_launcher_get_rank(int*rank);
 
int nm_launcher_get_size(int*size);
 
int nm_launcher_get_gate(int dest, nm_gate_t*gate);
 
int nm_launcher_get_dest(nm_gate_t p_gate, int*dest);
 
int nm_launcher_get_topology(struct nm_launcher_rank_vect_s*p_ranks,
                             struct nm_launcher_subgroup_vect_s*p_subgroups, int*n_subgroups);
 
void nm_launcher_abort(int rc);
 
typedef void (*nm_launcher_atexit_t)(void);
void nm_launcher_atexit(nm_launcher_atexit_t p_func);
 
int nm_launcher_init_nocheck(int*argc, char**argv);
 
static inline int nm_launcher_init(int*argc, char**argv)
{
  nm_abi_config_check();
  return nm_launcher_init_nocheck(argc, argv);
}
 
static inline nm_gate_t nm_launcher_self_gate(void)
{
  int rank;
  nm_launcher_get_rank(&rank);
  nm_gate_t p_gate;
  nm_launcher_get_gate(rank, &p_gate);
  return p_gate;
}
 
void nm_launcher_print_drivers_strategy(nm_core_t p_core);
 
int nm_launcher_homogeneous_network(void);
 
/* ** lazy init for sub-modules **************************** */
 
#ifndef __cplusplus
 
#include <stdatomic.h>
 
struct nm_lazy_initializer_s
{
  atomic_int init_done;    
  atomic_int initializing; 
};
 
#define NM_LAZY_INITIALIZER_INIT { .init_done = 0, .initializing = 0 }
 
#define NM_LAZY_INITIALIZER(ENAME, CTOR, DTOR)                          \
  static struct nm_lazy_initializer_s ENAME ## _lazy_initializer = NM_LAZY_INITIALIZER_INIT; \
                                                                        \
  static void ENAME ## _lazy_destructor(void)                           \
  {                                                                     \
    if(ENAME##_lazy_initializer.init_done > 0)                          \
      {                                                                 \
        (*DTOR)();                                                      \
      }                                                                 \
    ENAME##_lazy_initializer.init_done = -1;                            \
  }                                                                     \
  static void ENAME ## _lazy_init(void)                                 \
  {                                                                     \
    if(ENAME##_lazy_initializer.init_done == 0)                         \
      {                                                                 \
        if(atomic_fetch_add(&ENAME##_lazy_initializer.initializing, 1) == 0) \
          {                                                             \
            (*CTOR)();                                                  \
            atomic_fetch_add(&ENAME##_lazy_initializer.init_done, 1);   \
            nm_launcher_atexit(ENAME ## _lazy_destructor);              \
          }                                                             \
        else                                                            \
          {                                                             \
            while(!ENAME##_lazy_initializer.init_done)                  \
              {                                                         \
                sched_yield();                                          \
              }                                                         \
          }                                                             \
      }                                                                 \
    else if(ENAME##_lazy_initializer.init_done == -1)                   \
      {                                                                 \
        NM_FATAL("trying to use %s after detructor.\n", #ENAME);        \
      }                                                                 \
  }
 
#endif /* __cplusplus */
 
NM_EXTERN_C_END
 
#endif /* NM_LAUNCHER_INTERFACE_H */