---

ce.h

Go to the documentation of this file.

/**************************************************************/
/* CE.H */
/* Author: Ohad Rodeh */
/* Based on code by Mark Hayden and Alexey Vaysburd. */
/**************************************************************/
/**************************************************************/

#ifndef __CE_H__
#define __CE_H__

#include "e_iovec.h"
#include <memory.h>

#ifdef _WIN32
#include <winsock2.h>
#endif

/******************************************************************/
/* This is for defining DLLs on windows. Do NOT define CE_DLL_LINK
 * in applications that use the CE library.
 */
#ifdef _WIN32
#ifdef CE_MAKE_A_DLL
#define LINKDLL __declspec( dllexport)
#else
#define LINKDLL __declspec( dllimport)
#endif
#else
/* This is unused on Unix
 */
#define LINKDLL 
#endif
/******************************************************************/


typedef double      ce_float_t ;

typedef int         ce_bool_t ;

typedef int         ce_rank_t ;

typedef int         ce_ltime_t ;

typedef int         ce_len_t ;

typedef void       *ce_env_t ;

typedef double      ce_time_t ;

typedef char*       ce_endpt_t;

typedef char*       ce_addr_t;

typedef char       *ce_data_t;

typedef ce_iovec_t *ce_iovec_array_t;

/* An array of boolean values. 
 */
typedef ce_bool_t  *ce_bool_array_t;

typedef ce_endpt_t *ce_endpt_array_t ;

typedef ce_rank_t  *ce_rank_array_t ;

typedef ce_addr_t  *ce_addr_array_t ;

typedef struct ce_view_id_t {
    ce_ltime_t ltime ;
    ce_endpt_t endpt ;
} ce_view_id_t ;

typedef ce_view_id_t **ce_view_id_array_t;

typedef struct ce_view_state_t {
    char* version ;                
    char* group ;                  
    char* proto ;                  
    ce_rank_t coord ;              
    int ltime ;                    
    ce_bool_t primary ;            
    ce_bool_t groupd ;             
    ce_bool_t xfer_view ;          
    char* key ;                    
    int num_ids ;                  
    ce_view_id_array_t prev_ids ;  
    char *params;                  
    ce_time_t uptime ;             
    ce_endpt_array_t view ;        
    ce_addr_array_t address ;      
} ce_view_state_t ;

typedef struct ce_local_state_t {
    ce_endpt_t endpt ;             
    ce_addr_t addr ;               
    ce_rank_t rank ;               
    char* name ;                   
    int nmembers ;                 
    ce_view_id_t *view_id ;        
    ce_bool_t am_coord ;           
} ce_local_state_t ;

typedef struct ce_jops_t {
    ce_time_t hrtbt_rate ;         
    char *transports ;             
    char *protocol ;               
    char *group_name ;             
    char *properties ;             
    ce_bool_t use_properties ;     
    ce_bool_t groupd ;             
    char *params ;                 
    ce_bool_t client;              
    ce_bool_t debug ;              
    char *endpt ;                  
    char *princ ;                  
    char *key ;                    
    ce_bool_t secure ;             
} ce_jops_t;

#define CE_DEFAULT_PROTOCOL "Top:Heal:Switch:Leave:Inter:Intra:Elect:Merge:Slander:Sync:Suspect:Stable:Vsync:Frag_Abv:Top_appl:Frag:Pt2ptw:Mflow:Pt2pt:Mnak:Bottom"


#define CE_DEFAULT_PROPERTIES "Gmp:Sync:Heal:Switch:Frag:Suspect:Flow:Slander"

/**************************************************************/
/*
 * Utilities
 */

#define record_create(type, var) ((type)malloc(sizeof(*var)))

#define record_free(rec) free(rec)

#define record_clear(rec) memset(rec, 0, sizeof(*rec))

LINKDLL char *ce_copy_string(char *str);

LINKDLL void ce_view_full_free(ce_local_state_t *ls, ce_view_state_t* vs);

LINKDLL void ce_jops_free(ce_jops_t*) ;

/**************************************************************/
typedef void (*ce_appl_install_t)(ce_env_t, ce_local_state_t*, ce_view_state_t*);

typedef void (*ce_appl_exit_t)(ce_env_t) ;

typedef void (*ce_appl_receive_cast_t)(ce_env_t, ce_rank_t, int, ce_iovec_array_t) ;

typedef void (*ce_appl_receive_send_t)(ce_env_t, ce_rank_t, int, ce_iovec_array_t) ;

typedef void (*ce_appl_flow_block_t)(ce_env_t, ce_rank_t, ce_bool_t) ;

typedef void (*ce_appl_block_t)(ce_env_t) ;

typedef void (*ce_appl_heartbeat_t)(ce_env_t, ce_time_t) ;

typedef struct ce_appl_intf_t ce_appl_intf_t ;

LINKDLL ce_appl_intf_t*
ce_create_intf(ce_env_t env, 
               ce_appl_exit_t exit,
               ce_appl_install_t install,
               ce_appl_flow_block_t flow_block,
               ce_appl_block_t block,
               ce_appl_receive_cast_t cast,
               ce_appl_receive_send_t send,
               ce_appl_heartbeat_t heartbeat
    );

/**************************************************************/

LINKDLL void ce_Init(
    int argc,
    char **argv
    ) ;

LINKDLL void ce_Main_loop (void);

LINKDLL void ce_Join(
    ce_jops_t *ops,
    ce_appl_intf_t *c_appl
    ) ;

/**************************************************************/
/* The set of actions supported on a group. 
 */

LINKDLL void ce_Leave(ce_appl_intf_t *c_appl) ;

LINKDLL void ce_Cast(
    ce_appl_intf_t *c_appl,
    int num,
    ce_iovec_array_t iovl
    ) ;

LINKDLL void ce_Send(
    ce_appl_intf_t *c_appl,
    int num_dests,
    ce_rank_array_t dests,
    int num,
    ce_iovec_array_t iovl
    ) ;


LINKDLL void ce_Send1(
    ce_appl_intf_t *c_appl,
    ce_rank_t dest,
    int num,
    ce_iovec_array_t iovl
    ) ;

LINKDLL void ce_Prompt(
    ce_appl_intf_t *c_appl
    );

LINKDLL void ce_Suspect(
    ce_appl_intf_t *c_appl,
    int num,
    ce_rank_array_t suspects
    );

LINKDLL void ce_XferDone(
    ce_appl_intf_t *c_appl
    ) ;

LINKDLL void ce_Rekey(
    ce_appl_intf_t *c_appl
    ) ;

LINKDLL void ce_ChangeProtocol(
    ce_appl_intf_t *c_appl,
    char *protocol_name
    ) ;


LINKDLL void ce_ChangeProperties(
    ce_appl_intf_t *c_appl,
    char *properties
    ) ;

/**************************************************************/
LINKDLL void ce_MLPrintOverride(
    void (*handler)(char *msg)
    ) ;
    
LINKDLL void ce_MLUncaughtException(
    void (*handler)(char *info)
    ) ;
    
/**************************************************************/
#ifdef _WIN32
typedef SOCKET CE_SOCKET ;
#else
typedef int    CE_SOCKET ;
#endif

typedef void (*ce_handler_t)(void*);

LINKDLL void ce_AddSockRecv(
    CE_SOCKET socket,
    ce_handler_t handler,
    ce_env_t env
    );

LINKDLL void ce_RmvSockRecv(
    CE_SOCKET socket
    );

/**************************************************************/
/* Here is a simpler "flat" inteface.
 * No iovec's are used, as above, things are zero-copy.
 */





typedef void (*ce_appl_flat_receive_cast_t)(ce_env_t, ce_rank_t, ce_len_t, ce_data_t) ;

typedef void (*ce_appl_flat_receive_send_t)(ce_env_t, ce_rank_t, ce_len_t, ce_data_t) ;

LINKDLL ce_appl_intf_t*
ce_create_flat_intf(ce_env_t env, 
                    ce_appl_exit_t exit,
                    ce_appl_install_t install,
                    ce_appl_flow_block_t flow_block,
                    ce_appl_block_t block,
                    ce_appl_flat_receive_cast_t cast,
                    ce_appl_flat_receive_send_t send,
                    ce_appl_heartbeat_t heartbeat
    );


LINKDLL void ce_flat_Cast(
     ce_appl_intf_t *c_appl,
     ce_len_t len, 
     ce_data_t buf
     ) ;

LINKDLL void ce_flat_Send(
    ce_appl_intf_t *c_appl,
    int num_dests,
    ce_rank_array_t dests,
    ce_len_t len, 
    ce_data_t buf
    ) ;


LINKDLL void ce_flat_Send1(
    ce_appl_intf_t *c_appl,
    ce_rank_t dest,
    ce_len_t len, 
    ce_data_t buf
    ) ;

#endif  /* __CE_H__ */

/**************************************************************/

---