345 строки
10 KiB
C
345 строки
10 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University.
|
|
* All rights reserved.
|
|
* Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
|
|
* All rights reserved.
|
|
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
|
|
* University of Stuttgart. All rights reserved.
|
|
* Copyright (c) 2004-2005 The Regents of the University of California.
|
|
* All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
/** @file:
|
|
*
|
|
* Defines the functions for the tcp module.
|
|
*/
|
|
|
|
#ifndef _MCA_OOB_TCP_H_
|
|
#define _MCA_OOB_TCP_H_
|
|
|
|
#include "mca/oob/oob.h"
|
|
#include "mca/oob/base/base.h"
|
|
#include "mca/base/base.h"
|
|
#include "mca/ns/ns_types.h"
|
|
#include "opal/class/opal_free_list.h"
|
|
#include "class/opal_hash_table.h"
|
|
#include "opal/event/event.h"
|
|
#include "opal/threads/mutex.h"
|
|
#include "opal/threads/condition.h"
|
|
#include "mca/oob/tcp/oob_tcp_peer.h"
|
|
#include "mca/oob/tcp/oob_tcp_msg.h"
|
|
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
|
|
/*
|
|
* standard component functions
|
|
*/
|
|
int mca_oob_tcp_component_open(void);
|
|
int mca_oob_tcp_component_close(void);
|
|
mca_oob_t* mca_oob_tcp_component_init(int* priority);
|
|
|
|
/**
|
|
* Hook function to allow the selected oob components
|
|
* to register their contact info with the registry
|
|
*/
|
|
|
|
int mca_oob_tcp_init(void);
|
|
|
|
/**
|
|
* Cleanup resources during shutdown.
|
|
*/
|
|
int mca_oob_tcp_fini(void);
|
|
|
|
#if SIZEOF_SIZE_T == 8
|
|
/*
|
|
* Convert a 64 bit value to network byte order.
|
|
*/
|
|
static inline uint64_t hton64(uint64_t val)
|
|
{
|
|
union { uint64_t ll;
|
|
uint32_t l[2];
|
|
} w, r;
|
|
|
|
/* platform already in network byte order? */
|
|
if(htonl(1) == 1L)
|
|
return val;
|
|
w.ll = val;
|
|
r.l[0] = htonl(w.l[1]);
|
|
r.l[1] = htonl(w.l[0]);
|
|
return r.ll;
|
|
}
|
|
|
|
/*
|
|
* Convert a 64 bit value from network to host byte order.
|
|
*/
|
|
|
|
static inline uint64_t ntoh64(uint64_t val)
|
|
{
|
|
union { uint64_t ll;
|
|
uint32_t l[2];
|
|
} w, r;
|
|
|
|
/* platform already in network byte order? */
|
|
if(htonl(1) == 1L)
|
|
return val;
|
|
w.ll = val;
|
|
r.l[0] = ntohl(w.l[1]);
|
|
r.l[1] = ntohl(w.l[0]);
|
|
return r.ll;
|
|
}
|
|
|
|
/**
|
|
* Convert process name from host to network byte order.
|
|
*
|
|
* @param name
|
|
*/
|
|
#define OMPI_PROCESS_NAME_HTON(n) \
|
|
n.cellid = hton64(n.cellid); \
|
|
n.jobid = hton64(n.jobid); \
|
|
n.vpid = hton64(n.vpid);
|
|
|
|
/**
|
|
* Convert process name from network to host byte order.
|
|
*
|
|
* @param name
|
|
*/
|
|
#define OMPI_PROCESS_NAME_NTOH(n) \
|
|
n.cellid = ntoh64(n.cellid); \
|
|
n.jobid = ntoh64(n.jobid); \
|
|
n.vpid = ntoh64(n.vpid);
|
|
|
|
#else
|
|
|
|
/**
|
|
* Convert process name from host to network byte order.
|
|
*
|
|
* @param name
|
|
*/
|
|
#define OMPI_PROCESS_NAME_HTON(n) \
|
|
n.cellid = htonl(n.cellid); \
|
|
n.jobid = htonl(n.jobid); \
|
|
n.vpid = htonl(n.vpid);
|
|
|
|
/**
|
|
* Convert process name from network to host byte order.
|
|
*
|
|
* @param name
|
|
*/
|
|
#define OMPI_PROCESS_NAME_NTOH(n) \
|
|
n.cellid = ntohl(n.cellid); \
|
|
n.jobid = ntohl(n.jobid); \
|
|
n.vpid = ntohl(n.vpid);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Compare two process names for equality.
|
|
*
|
|
* @param n1 Process name 1.
|
|
* @param n2 Process name 2.
|
|
* @return (-1 for n1<n2 0 for equality, 1 for n1>n2)
|
|
*
|
|
* Note that the definition of < or > is somewhat arbitrary -
|
|
* just needs to be consistently applied to maintain an ordering
|
|
* when process names are used as indices.
|
|
*/
|
|
int mca_oob_tcp_process_name_compare(const orte_process_name_t* n1, const orte_process_name_t* n2);
|
|
/**
|
|
* Obtain contact information for this host (e.g. <ipaddress>:<port>)
|
|
*/
|
|
|
|
char* mca_oob_tcp_get_addr(void);
|
|
|
|
/**
|
|
* Setup cached addresses for the peers.
|
|
*/
|
|
|
|
int mca_oob_tcp_set_addr(const orte_process_name_t*, const char*);
|
|
|
|
/**
|
|
* A routine to ping a given process name to determine if it is reachable.
|
|
*
|
|
* @param name The peer name.
|
|
* @param tv The length of time to wait on a connection/response.
|
|
*
|
|
* Note that this routine blocks up to the specified timeout waiting for a
|
|
* connection / response from the specified peer. If the peer is unavailable
|
|
* an error status is returned.
|
|
*/
|
|
|
|
int mca_oob_tcp_ping(const orte_process_name_t*, const char* uri, const struct timeval* tv);
|
|
|
|
/**
|
|
* Similiar to unix writev(2).
|
|
*
|
|
* @param peer (IN) Opaque name of peer process.
|
|
* @param msg (IN) Array of iovecs describing user buffers and lengths.
|
|
* @param count (IN) Number of elements in iovec array.
|
|
* @param tag (IN) User defined tag for matching send/recv.
|
|
* @param flags (IN) Currently unused.
|
|
* @return OMPI error code (<0) on error number of bytes actually sent.
|
|
*/
|
|
|
|
int mca_oob_tcp_send(
|
|
orte_process_name_t* peer,
|
|
struct iovec *msg,
|
|
int count,
|
|
int tag,
|
|
int flags);
|
|
|
|
/**
|
|
* Similiar to unix readv(2)
|
|
*
|
|
* @param peer (IN) Opaque name of peer process or MCA_OOB_NAME_ANY for wildcard receive.
|
|
* @param msg (IN) Array of iovecs describing user buffers and lengths.
|
|
* @param count (IN) Number of elements in iovec array.
|
|
* @param tag (IN) User defined tag for matching send/recv.
|
|
* @param flags (IN) May be MCA_OOB_PEEK to return up to the number of bytes provided in the
|
|
* iovec array without removing the message from the queue.
|
|
* @return OMPI error code (<0) on error or number of bytes actually received.
|
|
*/
|
|
|
|
int mca_oob_tcp_recv(
|
|
orte_process_name_t* peer,
|
|
struct iovec * msg,
|
|
int count,
|
|
int tag,
|
|
int flags);
|
|
|
|
|
|
/*
|
|
* Non-blocking versions of send/recv.
|
|
*/
|
|
|
|
/**
|
|
* Non-blocking version of mca_oob_send().
|
|
*
|
|
* @param peer (IN) Opaque name of peer process.
|
|
* @param msg (IN) Array of iovecs describing user buffers and lengths.
|
|
* @param count (IN) Number of elements in iovec array.
|
|
* @param tag (IN) User defined tag for matching send/recv.
|
|
* @param flags (IN) Currently unused.
|
|
* @param cbfunc (IN) Callback function on send completion.
|
|
* @param cbdata (IN) User data that is passed to callback function.
|
|
* @return OMPI error code (<0) on error number of bytes actually sent.
|
|
*
|
|
*/
|
|
|
|
int mca_oob_tcp_send_nb(
|
|
orte_process_name_t* peer,
|
|
struct iovec* msg,
|
|
int count,
|
|
int tag,
|
|
int flags,
|
|
mca_oob_callback_fn_t cbfunc,
|
|
void* cbdata);
|
|
|
|
/**
|
|
* Non-blocking version of mca_oob_recv().
|
|
*
|
|
* @param peer (IN) Opaque name of peer process or MCA_OOB_NAME_ANY for wildcard receive.
|
|
* @param msg (IN) Array of iovecs describing user buffers and lengths.
|
|
* @param count (IN) Number of elements in iovec array.
|
|
* @param tag (IN) User defined tag for matching send/recv.
|
|
* @param flags (IN) May be MCA_OOB_PEEK to return up to size bytes of msg w/out removing it from the queue,
|
|
* @param cbfunc (IN) Callback function on recv completion.
|
|
* @param cbdata (IN) User data that is passed to callback function.
|
|
* @return OMPI error code (<0) on error or number of bytes actually received.
|
|
*/
|
|
|
|
int mca_oob_tcp_recv_nb(
|
|
orte_process_name_t* peer,
|
|
struct iovec* msg,
|
|
int count,
|
|
int tag,
|
|
int flags,
|
|
mca_oob_callback_fn_t cbfunc,
|
|
void* cbdata);
|
|
|
|
/**
|
|
* Cancel non-blocking receive.
|
|
*
|
|
* @param peer (IN) Opaque name of peer process or MCA_OOB_NAME_ANY for wildcard receive.
|
|
* @param tag (IN) User defined tag for matching send/recv.
|
|
* @return OMPI error code (<0) on error or number of bytes actually received.
|
|
*/
|
|
|
|
int mca_oob_tcp_recv_cancel(
|
|
orte_process_name_t* peer,
|
|
int tag);
|
|
|
|
/**
|
|
* Attempt to map a peer name to its corresponding address.
|
|
*/
|
|
|
|
int mca_oob_tcp_resolve(mca_oob_tcp_peer_t*);
|
|
|
|
/**
|
|
* Parse a URI string into an IP address and port number.
|
|
*/
|
|
int mca_oob_tcp_parse_uri(
|
|
const char* uri,
|
|
struct sockaddr_in* inaddr
|
|
);
|
|
|
|
/**
|
|
* Callback from registry on change to subscribed segments
|
|
*/
|
|
void mca_oob_tcp_registry_callback(
|
|
orte_gpr_notify_data_t* data,
|
|
void* cbdata);
|
|
|
|
|
|
/**
|
|
* OOB TCP Component
|
|
*/
|
|
struct mca_oob_tcp_component_t {
|
|
mca_oob_base_component_1_0_0_t super; /**< base OOB component */
|
|
char* tcp_include; /**< list of ip interfaces to include */
|
|
char* tcp_exclude; /**< list of ip interfaces to exclude */
|
|
int tcp_listen_sd; /**< listen socket for incoming connection requests */
|
|
unsigned short tcp_listen_port; /**< listen port */
|
|
opal_list_t tcp_subscriptions; /**< list of registry subscriptions */
|
|
opal_list_t tcp_peer_list; /**< list of peers sorted in mru order */
|
|
opal_hash_table_t tcp_peers; /**< peers sorted by name */
|
|
opal_hash_table_t tcp_peer_names; /**< cache of peer contact info sorted by name */
|
|
opal_free_list_t tcp_peer_free; /**< free list of peers */
|
|
int tcp_peer_limit; /**< max size of tcp peer cache */
|
|
int tcp_peer_retries; /**< max number of retries before declaring peer gone */
|
|
opal_free_list_t tcp_msgs; /**< free list of messages */
|
|
opal_event_t tcp_send_event; /**< event structure for sends */
|
|
opal_event_t tcp_recv_event; /**< event structure for recvs */
|
|
opal_mutex_t tcp_lock; /**< lock for accessing module state */
|
|
opal_list_t tcp_events; /**< list of pending events (accepts) */
|
|
opal_list_t tcp_msg_post; /**< list of recieves user has posted */
|
|
opal_list_t tcp_msg_recv; /**< list of recieved messages */
|
|
opal_mutex_t tcp_match_lock; /**< lock held while searching/posting messages */
|
|
opal_condition_t tcp_match_cond; /**< condition variable used in finalize */
|
|
int tcp_match_count; /**< number of matched recvs in progress */
|
|
int tcp_debug; /**< debug level */
|
|
};
|
|
|
|
/**
|
|
* Convenience Typedef
|
|
*/
|
|
typedef struct mca_oob_tcp_component_t mca_oob_tcp_component_t;
|
|
|
|
OMPI_COMP_EXPORT extern mca_oob_tcp_component_t mca_oob_tcp_component;
|
|
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* MCA_OOB_TCP_H_ */
|
|
|