photon_collectives.h

Go to the documentation of this file.

// =============================================================================
//  Photon RDMA Library (libphoton)
//
//  Copyright (c) 2017, Trustees of Indiana University,
//  All rights reserved.
//
//  This software may be modified and distributed under the terms of the BSD
//  license.  See the COPYING file for details.
//
//  This software was created at the Indiana University Center for Research in
//  Extreme Scale Technologies (CREST).
// =============================================================================

#ifndef PHOTON_COLLECTIVES_H
#define PHOTON_COLLECTIVES_H

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
  PHOTON_COLL_IFACE_DEFAULT = 0,
  PHOTON_COLL_IFACE_PWC,
  PHOTON_COLL_IFACE_NBC,
  PHOTON_COLL_IFACE_MAX
} photon_cfg_coll_iface_t;

static const char* const PHOTON_COLL_IFACE_TO_STRING[] = {
  "default",
  "pwc",
  "nbc",
  "INVALID_COLLECTIVE_INTERACE"
};

typedef void* photon_datatype_t;
typedef photon_datatype_t photonDatatype;

extern photon_datatype_t photon_datatype_null;
extern photon_datatype_t photon_char;
extern photon_datatype_t photon_signed_char;
extern photon_datatype_t photon_unsigned_char;
extern photon_datatype_t photon_byte;
extern photon_datatype_t photon_short;
extern photon_datatype_t photon_unsigned_short;
extern photon_datatype_t photon_int;
extern photon_datatype_t photon_unsigned;
extern photon_datatype_t photon_long;
extern photon_datatype_t photon_unsigned_long;
extern photon_datatype_t photon_long_long_int;
extern photon_datatype_t photon_unsigned_long_long;
extern photon_datatype_t photon_float;
extern photon_datatype_t photon_double;
extern photon_datatype_t photon_long_double;
extern photon_datatype_t photon_wchar;
extern photon_datatype_t photon_packed;

#define PHOTON_DT_NULL ((photonDatatype) (photon_datatype_null))
#define PHOTON_DT_BYTE ((photonDatatype) (photon_byte))
#define PHOTON_DT_PACKED ((photonDatatype) (photon_packed))
#define PHOTON_DT_CHAR ((photonDatatype) (photon_char))
#define PHOTON_DT_SHORT ((photonDatatype) (photon_short))
#define PHOTON_DT_INT ((photonDatatype) (photon_int))
#define PHOTON_DT_LONG ((photonDatatype) (photon_long))
#define PHOTON_DT_FLOAT ((photonDatatype) (photon_float))
#define PHOTON_DT_DOUBLE ((photonDatatype) (photon_double))
#define PHOTON_DT_LONG_DOUBLE ((photonDatatype) (photon_long_double))
#define PHOTON_DT_UNSIGNED_CHAR ((photonDatatype) (photon_unsigned_char))
#define PHOTON_DT_SIGNED_CHAR ((photonDatatype) (photon_signed_char))
#define PHOTON_DT_UNSIGNED_SHORT ((photonDatatype) (photon_unsigned_short))
#define PHOTON_DT_UNSIGNED_LONG ((photonDatatype) (photon_unsigned_long))
#define PHOTON_DT_UNSIGNED ((photonDatatype) (photon_unsigned))
#define PHOTON_DT_LONG_LONG_INT ((photonDatatype) (photon_long_long_int))
#define PHOTON_DT_LONG_LONG ((photonDatatype) (photon_long_long))
#define PHOTON_DT_UNSIGNED_LONG_LONG ((photonDatatype) (photon_unsigned_long_long))

typedef void* photon_op_t;
typedef photon_op_t photonOp;
  
extern photon_op_t photon_op_null;
extern photon_op_t photon_op_min;
extern photon_op_t photon_op_max;
extern photon_op_t photon_op_sum;
extern photon_op_t photon_op_prod;
extern photon_op_t photon_op_land;
extern photon_op_t photon_op_band;
extern photon_op_t photon_op_lor;
extern photon_op_t photon_op_bor;
extern photon_op_t photon_op_lxor;
extern photon_op_t photon_op_bxor;
extern photon_op_t photon_op_maxloc;
extern photon_op_t photon_op_minloc;
extern photon_op_t photon_op_replace;
extern photon_op_t photon_op_no_op;  

#define PHOTON_OP_NULL ((photonOp) (photon_op_null))
#define PHOTON_OP_MAX ((photonOp) (photon_op_max))
#define PHOTON_OP_MIN ((photonOp) (photon_op_min))
#define PHOTON_OP_SUM ((photonOp) (photon_op_sum))
#define PHOTON_OP_PROD ((photonOp) (photon_op_prod))
#define PHOTON_OP_LAND ((photonOp) (photon_op_land))
#define PHOTON_OP_BAND ((photonOp) (photon_op_band))
#define PHOTON_OP_LOR ((photonOp) (photon_op_lor))
#define PHOTON_OP_BOR ((photonOp) (photon_op_bor))
#define PHOTON_OP_LXOR ((photonOp) (photon_op_lxor))
#define PHOTON_OP_BXOR ((photonOp) (photon_op_bxor))
#define PHOTON_OP_MAXLOC ((photonOp) (photon_op_maxloc))
#define PHOTON_OP_MINLOC ((photonOp) (photon_op_minloc))
#define PHOTON_OP_REPLACE ((photonOp) (photon_op_replace))
#define PHOTON_OP_NO_OP ((photonOp) (photon_op_no_op))
  
typedef enum {
  PHOTON_COLL_BARRIER = 1,
  PHOTON_COLL_REDUCE,
  PHOTON_COLL_GATHER,
  PHOTON_COLL_ALLREDUCE,
  PHOTON_COLL_SCAN,
  PHOTON_COLL_IBARRIER,
  PHOTON_COLL_IREDUCE,
  PHOTON_COLL_IGATHER,
  PHOTON_COLL_IALLREDUCE,
  PHOTON_COLL_ISCAN,
  PHOTON_COLL_MAXVAL
} photon_coll;

typedef enum {
  PHOTON_COLL_ALGO_RING = 1,
  PHOTON_COLL_ALGO_TREE,
  PHOTON_COLL_ALGO_REC_DOUBLING
} photon_coll_algo;

typedef enum {
  PHOTON_COLL_NODE_RING_HEAD = 1,
  PHOTON_COLL_NODE_RING_REGULAR,
  PHOTON_COLL_NODE_TREE_ROOT,
  PHOTON_COLL_NODE_TREE_INTERNAL,
  PHOTON_COLL_NODE_TREE_LEAF,
  PHOTON_COLL_NODE_REC_DOUBLING
} photon_coll_node;

#define PHOTON_COLL_MSG_RING_AT_BR       65
#define PHOTON_COLL_MSG_RING_RELEASE_BR  67
#define PHOTON_COLL_MSG_TREE_CHILD_AT_BR 68
#define PHOTON_COLL_MSG_REC_DOUBLING_TAG 1

// Collectives with completion
typedef void* photonComm;
extern photonComm PHOTON_COMM_WORLD;
  


int photon_collective_init(photonComm comm, photon_coll ctype, photon_cid local,
               photon_rid *request, int flags);

int photon_collective_join(photon_rid request, void *in, void *out, int scount, int rcount,
               photonDatatype stype, photonDatatype rtype, int root, photonOp op);

int photon_collective_comm_create(void *active, int num_active, int total, photonComm *c);
int photon_collective_init_new_comm(void *active, int num_active, int total, photon_coll ctype,
                    photon_cid local, photon_rid *request, int flags, photonComm *c);
  
  
#ifdef __cplusplus
}
#endif

#endif