Difference between revisions of "CTDB Project ibwrapper"

Line 25: Line 25:
 
  IBWS_INIT = 0, /* ctx start - after ibw_init */
 
  IBWS_INIT = 0, /* ctx start - after ibw_init */
 
  IBWS_ADDR_RESOLVED, /* after bind - should proceed to IBWS_READY processing the next fd_cm event - internally */
 
  IBWS_ADDR_RESOLVED, /* after bind - should proceed to IBWS_READY processing the next fd_cm event - internally */
  IBWS_READY, /* after bind 2. */
+
  IBWS_READY, /* after bind 2.; call ibw_listen on this - once */
  IBWS_CONNECT_REQUEST, /* after [IBWS_ROUTE_RESOLVED + listen]
+
  IBWS_CONNECT_REQUEST, /* after [IBWS_READY + incoming request] */
  => [IBWS_READY | STOPPED | ERROR] */
+
  /* => [(ibw_accept)IBWS_READY | (ibw_disconnect)STOPPED | ERROR] */
  IBWS_STOPPED, /* normal stop */
+
  IBWS_STOPPED, /* normal stop <= ibw_disconnect+(IBWS_READY | IBWS_CONNECT_REQUEST) */
  IBWS_ERROR /* abnormal state */
+
  IBWS_ERROR /* abnormal state; ibw_stop must be called after this */
 
  } ibw_state_ctx;
 
  } ibw_state_ctx;
 
   
 
   
Line 60: Line 60:
 
  void *internal;
 
  void *internal;
 
  } ibw_conn;
 
  } ibw_conn;
 
/*
 
  * Retrieves the last error
 
  * result: always non-zero, mustn't be freed (static)
 
  */
 
const char *ibw_getLastError();
 
 
 
   
 
   
 
  typedef struct _ibw_initattr {
 
  typedef struct _ibw_initattr {
Line 76: Line 69:
 
   * Callback function definition which should inform you about
 
   * Callback function definition which should inform you about
 
   * connection state change
 
   * connection state change
   * invoked from within ibw_process_statechange
+
   * This callback is invoked from within ibw_process_statechange.
 
   * Both <conn> and <ctx> can be NULL if their state didn't change.
 
   * Both <conn> and <ctx> can be NULL if their state didn't change.
 
   * Return nonzero on error.
 
   * Return nonzero on error.
Line 84: Line 77:
 
  /*
 
  /*
 
   * Callback function definition which should process incoming packets
 
   * Callback function definition which should process incoming packets
   * invoked from within ibw_process_event.
+
   * This callback is invoked from within ibw_process_event.
 
   * Return nonzero on error.
 
   * Return nonzero on error.
 
   */
 
   */
Line 97: Line 90:
 
   *      ib_port [default is 1]
 
   *      ib_port [default is 1]
 
   *
 
   *
   * Must be called for each NODE _ONCE_
+
   * Must be called _ONCE_ for each node.
 
   *
 
   *
 
   * returns non-NULL on success
 
   * returns non-NULL on success
   * talloc_free must be called for the result
+
  *
 +
   * talloc_free must be called for the result in IBWS_STOPPED;
 +
  *    it will close resources by destructor
 +
  *    connections(ibw_conn *) must have been closed prior talloc_free
 
   */
 
   */
 
  ibw_ctx *ibw_init(ibw_initattr *attr, int nattr,
 
  ibw_ctx *ibw_init(ibw_initattr *attr, int nattr,
Line 107: Line 103:
 
  ibw_receive_fn_t ibw_receive);
 
  ibw_receive_fn_t ibw_receive);
 
   
 
   
 +
/*
 +
  * Must be called in states of (IBWS_ERROR, IBWS_READY, IBWS_CONNECT_REQUEST)
 +
  *
 +
  * It will send out disconnect requests and free up ibw_conn structures.
 +
  * The ctx->state will transit to IBWS_STOPPED after every conn are disconnected.
 +
  * During that time, you mustn't send/recv/disconnect any more.
 +
  * Only after ctx->state=IBWS_STOPPED you can talloc_free the ctx.
 +
  */
 +
int ibw_stop(ibw_ctx *ctx);
 
   
 
   
 
  /*************** connection initiation - like stream sockets *****/
 
  /*************** connection initiation - like stream sockets *****/
Line 120: Line 125:
 
  /*
 
  /*
 
   * works like socket listen
 
   * works like socket listen
   * !!!: it's NON-blocking; use ctx->fd_cm + ibw_process_statechange +
+
   * non-blocking
   * ibw_connstate_fn_t to wait for a conn state change (=IBWS_READY)
+
   * enables accepting incoming connections (after IBWS_READY)
 +
  * (it doesn't touch ctx->state by itself)
 
   *
 
   *
 
   * returns ctx->cm_fd
 
   * returns ctx->cm_fd
 
   */
 
   */
  int ibw_listen(ibw_ctx *ctx, int sockfd, int backlog);
+
  int ibw_listen(ibw_ctx *ctx, int backlog);
 
   
 
   
 
  /*
 
  /*
 
   * works like socket accept
 
   * works like socket accept
   * initializes a connection
+
   * initializes a connection to a client
   * Normally should be called from ibw_connstate_fn_t callback
+
   * must be called when state=IBWS_CONNECT_REQUEST
  * when state=IBWS_CONNECT_REQUEST
 
 
   *
 
   *
   * returns non-NULL on success
+
   * returns 0 on success
 +
  *
 +
  * You have +1 waiting here: you will get ibw_conn (having the
 +
  * same <conn_userdata> member) structure in ibw_connstate_fn_t.
 
   *
 
   *
   * userdata: will be put into ibw_conn (see also ibw_callback_fn_t)
+
   * Important: you won't get remote IP address (only internal conn info)
 
   */
 
   */
  ibw_conn *ibw_accept(ibw_ctx *ctx, void *conn_userdata);
+
  int ibw_accept(ibw_ctx *ctx, void *conn_userdata);
 
   
 
   
 
  /*
 
  /*
 
   * Needs a normal internet address here
 
   * Needs a normal internet address here
   * can be called within IBWS_READY (or IBWS_CONNECT_REQUEST)
+
   * can be called within IBWS_READY|IBWS_CONNECT_REQUEST
 
   *
 
   *
 
   * returns non-NULL on success
 
   * returns non-NULL on success
 
   *
 
   *
   * userdata: will be put into ibw_conn (see also ibw_callback_fn_t)
+
   * You have +1 waiting here: you will get ibw_conn (having the
 +
  * same <conn_userdata> member) structure in ibw_connstate_fn_t.
 
   */
 
   */
  ibw_conn *ibw_connect(ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata);
+
  int ibw_connect(ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata);
 
   
 
   
 
  /*
 
  /*
   * Sends a disconnect request
+
   * Sends out a disconnect request.
 
   * You should process ctx->cm_fd ater calling this function
 
   * You should process ctx->cm_fd ater calling this function
 
   * and then process it with ibw_process_event normally
 
   * and then process it with ibw_process_event normally
 
   * (until you get conn->state = IBWC_DISCONNECTED)
 
   * (until you get conn->state = IBWC_DISCONNECTED)
 
   *
 
   *
   * You have to talloc_free <conn> after this (even in the callback).
+
   * You mustn't talloc_free <conn> after this.
 
   */
 
   */
 
  void ibw_disconnect(ibw_conn *conn);
 
  void ibw_disconnect(ibw_conn *conn);
Line 162: Line 171:
 
   
 
   
 
  /*  
 
  /*  
   * !!! Must be called in all cases after selecting/polling for ctx->fd_events is set.
+
   * Must be called in all cases after selecting/polling for ctx->fd_events is set.
 
   */
 
   */
 
  int ibw_process_event(ibw_ctx *ctx);
 
  int ibw_process_event(ibw_ctx *ctx);
 
   
 
   
 
  /*  
 
  /*  
   * !!! Must be called in all cases after selecting/polling for ctx->fd_cm is set.
+
   * Must be called in all cases after selecting/polling for ctx->fd_cm is set.
 
   */
 
   */
 
  int ibw_process_statechange(ibw_ctx *ctx);
 
  int ibw_process_statechange(ibw_ctx *ctx);
Line 174: Line 183:
 
   * Send the message in one
 
   * Send the message in one
 
   * Can be invoked any times (should fit into buffers) and at any time
 
   * Can be invoked any times (should fit into buffers) and at any time
 +
  * (in conn->state=IBWC_CONNECTED)
 
   */
 
   */
 
  int ibw_send(ibw_conn *conn, void *buf, int n);
 
  int ibw_send(ibw_conn *conn, void *buf, int n);
 +
 +
/*
 +
  * Retrieves the last error
 +
  * result: always non-zero, mustn't be freed (static)
 +
  */
 +
const char *ibw_getLastError();

Revision as of 12:03, 28 November 2006

File ibwrapper.h:

/*
 * Infiniband Verbs API socket-like wrapper
 * Copyright (C) Peter Somogyi 2006
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


/* Server communication state */
typedef enum {
	IBWS_INIT = 0, /* ctx start - after ibw_init */
	IBWS_ADDR_RESOLVED, /* after bind - should proceed to IBWS_READY processing the next fd_cm event - internally */
	IBWS_READY, /* after bind 2.; call ibw_listen on this - once */
	IBWS_CONNECT_REQUEST, /* after [IBWS_READY + incoming request] */
		/* => [(ibw_accept)IBWS_READY | (ibw_disconnect)STOPPED | ERROR] */
	IBWS_STOPPED, /* normal stop <= ibw_disconnect+(IBWS_READY | IBWS_CONNECT_REQUEST) */
	IBWS_ERROR /* abnormal state; ibw_stop must be called after this */
} ibw_state_ctx;

/* Connection state */
typedef struct _ibw_ctx {
	int fd_events; /* read fd of verbs events */
		/* ibw_process_event must be _always_ invoked */
		/* when this fd is set after a select/poll */

	int fd_cm; /* read fd about a cm state change */
		/* call ibw_process_statechange after it's set */

	void *ctx_userdata; /* see ibw_init */

	ibw_state_ctx state;
	void *internal;
} ibw_ctx;

typedef enum {
	IBWC_INIT = 0, /* conn start - internal state */
	IBWC_CONNECTED, /* after ibw_accept or ibw_connect */
	IBWC_DISCONNECTED, /* after ibw_disconnect */
	IBWC_ERROR
} ibw_state_conn;

typedef struct _ibw_conn {
	ibw_ctx *ctx;
	ibw_state_conn state;
	void *conn_userdata; /* see ibw_connect and ibw_accept */
	void *internal;
} ibw_conn;

typedef struct _ibw_initattr {
	const char *name;
	const char *value;
} ibw_initattr;

/*
 * Callback function definition which should inform you about
 * connection state change
 * This callback is invoked from within ibw_process_statechange.
 * Both <conn> and <ctx> can be NULL if their state didn't change.
 * Return nonzero on error.
 */
typedef int (*ibw_connstate_fn_t)(ibw_ctx *ctx, ibw_conn *conn, void *ctx_userdata);

/*
 * Callback function definition which should process incoming packets
 * This callback is invoked from within ibw_process_event.
 * Return nonzero on error.
 */
typedef int (*ibw_receive_fn_t)(ibw_conn *conn, void *buf, int n);

/*
 * settings: array of (name, value) pairs
 * where name is one of:
 *      dev_name [default is the first one]
 *      rx_depth [default is 500]
 *      mtu     [default is 1024]
 *      ib_port [default is 1]
 *
 * Must be called _ONCE_ for each node.
 *
 * returns non-NULL on success
 *
 * talloc_free must be called for the result in IBWS_STOPPED;
 *    it will close resources by destructor
 *    connections(ibw_conn *) must have been closed prior talloc_free
 */
ibw_ctx *ibw_init(ibw_initattr *attr, int nattr,
	ibw_connstate_fn_t ibw_connstate,
	void *ctx_userdata,
	ibw_receive_fn_t ibw_receive);

/*
 * Must be called in states of (IBWS_ERROR, IBWS_READY, IBWS_CONNECT_REQUEST)
 *
 * It will send out disconnect requests and free up ibw_conn structures.
 * The ctx->state will transit to IBWS_STOPPED after every conn are disconnected.
 * During that time, you mustn't send/recv/disconnect any more.
 * Only after ctx->state=IBWS_STOPPED you can talloc_free the ctx.
 */
int ibw_stop(ibw_ctx *ctx);

/*************** connection initiation - like stream sockets *****/

/*
 * works like socket bind
 * needs a normal internet address here
 *
 * return 0 on success
 */
int ibw_bind(ibw_ctx *ctx, struct sockaddr_in *my_addr);

/*
 * works like socket listen
 * non-blocking
 * enables accepting incoming connections (after IBWS_READY)
 * (it doesn't touch ctx->state by itself)
 *
 * returns ctx->cm_fd
 */
int ibw_listen(ibw_ctx *ctx, int backlog);

/*
 * works like socket accept
 * initializes a connection to a client
 * must be called when state=IBWS_CONNECT_REQUEST
 *
 * returns 0 on success
 *
 * You have +1 waiting here: you will get ibw_conn (having the
 * same <conn_userdata> member) structure in ibw_connstate_fn_t.
 *
 * Important: you won't get remote IP address (only internal conn info)
 */
int ibw_accept(ibw_ctx *ctx, void *conn_userdata);

/*
 * Needs a normal internet address here
 * can be called within IBWS_READY|IBWS_CONNECT_REQUEST
 *
 * returns non-NULL on success
 *
 * You have +1 waiting here: you will get ibw_conn (having the
 * same <conn_userdata> member) structure in ibw_connstate_fn_t.
 */
int ibw_connect(ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata);

/*
 * Sends out a disconnect request.
 * You should process ctx->cm_fd ater calling this function
 * and then process it with ibw_process_event normally
 * (until you get conn->state = IBWC_DISCONNECTED)
 *
 * You mustn't talloc_free <conn> after this.
 */
void ibw_disconnect(ibw_conn *conn);

/************ Infiniband specific event loop wrapping ******************/

/* 
 * Must be called in all cases after selecting/polling for ctx->fd_events is set.
 */
int ibw_process_event(ibw_ctx *ctx);

/* 
 * Must be called in all cases after selecting/polling for ctx->fd_cm is set.
 */
int ibw_process_statechange(ibw_ctx *ctx);

/*
 * Send the message in one
 * Can be invoked any times (should fit into buffers) and at any time
 * (in conn->state=IBWC_CONNECTED)
 */
int ibw_send(ibw_conn *conn, void *buf, int n);
/*
 * Retrieves the last error
 * result: always non-zero, mustn't be freed (static)
 */
const char *ibw_getLastError();