nm_group.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2014-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.
 */
 
#include <nm_public.h>
#include <nm_sendrecv_interface.h>
#include <Padico/Puk.h>
 
/* ********************************************************* */
 
typedef struct nm_group_s*nm_group_t;
 
#define NM_GROUP_NULL ((nm_group_t)NULL)
 
#define NM_GROUP_IDENT   0x01
#define NM_GROUP_SIMILAR 0x02
#define NM_GROUP_UNEQUAL 0x04
 
PUK_VECT_TYPE(nm_coll_subgroup, int);
 
struct nm_coll_topology_s
{
  struct nm_coll_subgroup_vect_s subgroups; 
  int n_subgroups;                          
};
 
PUK_VECT_TYPE(nm_coll_rank, int);
 
struct nm_coll_topology_groups_s
{
  nm_group_t p_leaders_group;         
  nm_group_t p_local_group;           
};
 
/*
 * MPI_Group_size       returns number of processes in group
 * MPI_Group_rank       returns rank of calling process in group
 * MPI_Group_compare    compares group members and group order
 * MPI_Group_union      creates a group by combining two groups
 * MPI_Group_intersection       creates a group from the intersection of two groups
 * MPI_Group_difference         creates a group from the difference between two groups
 * MPI_Group_incl       creates a group from listed members of an existing group
 * MPI_Group_excl       creates a group excluding listed members of an existing group
 * MPI_Group_free       marks a group for deallocation
 * MPI_Group_translate_ranks    translates ranks of processes in one group to those in another group
 
 TODO-
 MPI_Group_range_incl   creates a group according to first rank, stride, last rank
 MPI_Group_range_excl   creates a group by deleting according to first rank, stride, last rank
 
 MPI_GROUP_NULL
 MPI_GROUP_EMPTY
*/
 
extern nm_group_t nm_group_new(void);
 
extern void nm_group_add_node(nm_group_t p_group, nm_gate_t p_gate);
 
extern int nm_group_size(nm_group_t group);
 
extern int nm_group_rank(nm_group_t group);
 
extern nm_gate_t nm_group_get_gate(nm_group_t p_group, int rank);
 
extern nm_gate_t*nm_group_get_gates(nm_group_t p_group);
 
extern const struct nm_uuid_binary_s*nm_group_get_uuid(nm_group_t p_group);
 
extern int nm_group_get_dest(nm_group_t p_group, nm_gate_t p_gate);
 
extern const struct nm_coll_topology_s*nm_group_get_topology(nm_group_t p_group);
 
extern const struct nm_coll_topology_groups_s*nm_group_get_topology_groups(nm_group_t p_group, int root);
 
extern nm_group_t nm_group_world(void);
 
extern int nm_group_compare(nm_group_t group1, nm_group_t group2);
 
extern void nm_group_free(nm_group_t group);
 
extern nm_group_t nm_group_dup(nm_group_t group);
 
extern nm_group_t nm_group_incl(nm_group_t group, int n, const int ranks[]);
 
extern nm_group_t nm_group_excl(nm_group_t group, int n, const int ranks[]);
 
extern nm_group_t nm_group_union(nm_group_t group1, nm_group_t group2);
 
extern nm_group_t nm_group_intersection(nm_group_t group1, nm_group_t group2);
 
extern nm_group_t nm_group_difference(nm_group_t group1, nm_group_t group2);
 
extern int nm_group_translate_ranks(nm_group_t p_group1, int n, const int*p_ranks1, nm_group_t p_group2, int*p_ranks2);