photon_config.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_CONFIG_H
#define PHOTON_CONFIG_H

#ifdef __cplusplus
extern "C" {
#endif

 
  
#define PHOTON_ORDER_DEFAULT   0x0000  
#define PHOTON_ORDER_NONE      0x0001  
#define PHOTON_ORDER_STRICT    0x0002  

static const char* const PHOTON_ORDER_TO_STRING[] = {
  "default",
  "none",
  "strict",
  "INVALID_COMP_ORDER"
};

typedef enum {
  PHOTON_BACKEND_DEFAULT = 0, 
  PHOTON_BACKEND_VERBS,       
  PHOTON_BACKEND_UGNI,        
  PHOTON_BACKEND_FI,          
  PHOTON_BACKEND_MAX
} photon_cfg_backend_t;

static const char* const PHOTON_BACKEND_TO_STRING[] = {
  "default",
  "verbs",
  "ugni",
  "fi",
  "INVALID_BACKEND"
};

struct photon_config_t {
  int address;              
  int nproc;                

  struct {
    const char *eth_dev;    
    const char *ib_dev;     
    int use_cma;            
    int use_ud;             
    int num_srq;            
    const char *ud_gid_prefix; 
  } ibv;

  struct {
    const char *eth_dev;    
    int bte_thresh;         
  } ugni;

  struct {
    const char *eth_dev;    
    const char *domain;     
    const char *node;       
    const char *service;    
    const char *provider;   
  } fi;

  struct {
    int use_forwarder;
    char **forwarder_eids;
  } forwarder;

  // Photon library capabilities
  struct {
    int max_cid_size;       
    int eager_buf_size;     
    int pwc_buf_size;       
    int small_msg_size;     
    int small_pwc_size;     
    int ledger_entries;     
    int max_rd;             
    int default_rd;         
    int num_cq;             
    int use_rcq;            
  } cap;

  struct {
    int comp_order;         
  } attr;

  struct {
    int (*barrier)(void *);                         
    int (*allgather)(void *, void *, void *, int);  
  } exch;
  
  void *comm;                   
  int meta_exch;                
  photon_cfg_backend_t backend; 
  photon_cfg_coll_iface_t coll; 
};

typedef struct photon_config_t * photonConfig;

  
#ifdef __cplusplus
}
#endif

#endif