CTDB Project ibwrapper: Difference between revisions
From SambaWiki
No edit summary |
No edit summary |
||
(8 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
/* |
/* |
||
* Unix SMB/CIFS implementation. |
|||
* Infiniband Verbs API socket-like wrapper |
|||
* Wrap Infiniband calls. |
|||
⚫ | |||
* |
* |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
* |
* |
||
* Major code contributions by Peter Somogyi <psomogyi@gamax.hu> |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
* |
|||
⚫ | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||
* |
* GNU General Public License for more details. |
||
* |
* |
||
* You should have received a copy of the GNU |
* You should have received a copy of the GNU General Public License |
||
* |
* along with this program; if not, write to the Free Software |
||
* Foundation, Inc., |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
||
*/ |
*/ |
||
⚫ | |||
/* Server communication state */ |
/* Server communication state */ |
||
enum ibw_state_ctx { |
|||
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_CONNECT_REQUEST, /* after [IBWS_READY + incoming request] */ |
IBWS_CONNECT_REQUEST, /* after [IBWS_READY + incoming request] */ |
||
/* => [(ibw_accept)IBWS_READY | (ibw_disconnect)STOPPED | ERROR] */ |
/* => [(ibw_accept)IBWS_READY | (ibw_disconnect)STOPPED | ERROR] */ |
||
IBWS_STOPPED, /* normal stop <= ibw_disconnect+(IBWS_READY | IBWS_CONNECT_REQUEST) */ |
IBWS_STOPPED, /* normal stop <= ibw_disconnect+(IBWS_READY | IBWS_CONNECT_REQUEST) */ |
||
IBWS_ERROR /* abnormal state; ibw_stop must be called after this */ |
IBWS_ERROR /* abnormal state; ibw_stop must be called after this */ |
||
}; |
|||
} ibw_state_ctx; |
|||
/* Connection state */ |
/* Connection state */ |
||
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 */ |
void *ctx_userdata; /* see ibw_init */ |
||
ibw_state_ctx state; |
enum ibw_state_ctx state; |
||
void *internal; |
void *internal; |
||
⚫ | |||
struct ibw_conn *conn_list; /* 1st elem of double linked list */ |
|||
typedef enum { |
|||
}; |
|||
⚫ | |||
⚫ | |||
IBWC_INIT = 0, /* conn start - internal state */ |
IBWC_INIT = 0, /* conn start - internal state */ |
||
IBWC_CONNECTED, /* after ibw_accept or ibw_connect */ |
IBWC_CONNECTED, /* after ibw_accept or ibw_connect */ |
||
IBWC_DISCONNECTED, /* after ibw_disconnect */ |
IBWC_DISCONNECTED, /* after ibw_disconnect */ |
||
IBWC_ERROR |
IBWC_ERROR |
||
}; |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
typedef struct _ibw_conn { |
|||
ibw_ctx *ctx; |
|||
⚫ | |||
void *conn_userdata; /* see ibw_connect and ibw_accept */ |
void *conn_userdata; /* see ibw_connect and ibw_accept */ |
||
void *internal; |
void *internal; |
||
⚫ | |||
struct ibw_conn *prev, *next; |
|||
}; |
|||
⚫ | |||
⚫ | |||
* (name, value) pair for array param of ibw_init |
|||
*/ |
|||
⚫ | |||
const char *name; |
const char *name; |
||
const char *value; |
const char *value; |
||
}; |
|||
⚫ | |||
/* |
/* |
||
* Callback function definition which should inform you about |
* Callback function definition which should inform you about |
||
* connection state change |
* connection state change |
||
* This callback is invoked |
* This callback is invoked whenever server or client connection changes. |
||
* 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. |
||
*/ |
*/ |
||
typedef int (*ibw_connstate_fn_t)(ibw_ctx *ctx, ibw_conn *conn |
typedef int (*ibw_connstate_fn_t)(struct ibw_ctx *ctx, struct ibw_conn *conn); |
||
/* |
/* |
||
* Callback function definition which should process incoming packets |
* Callback function definition which should process incoming packets |
||
* This callback is invoked |
* This callback is invoked whenever any message arrives. |
||
* Return nonzero on error. |
* Return nonzero on error. |
||
* |
|||
* Important: you mustn't store buf pointer for later use. |
|||
* Process its contents before returning. |
|||
*/ |
*/ |
||
typedef int (*ibw_receive_fn_t)(ibw_conn *conn, void *buf, int n); |
typedef int (*ibw_receive_fn_t)(struct ibw_conn *conn, void *buf, int n); |
||
/* |
/* |
||
* settings: array of (name, value) pairs |
* settings: array of (name, value) pairs |
||
* where name is one of: |
* where name is one of: |
||
* |
* max_send_wr [default is 256] |
||
* |
* max_recv_wr [default is 1024] |
||
* <...> |
|||
* mtu [default is 1024] |
|||
* ib_port [default is 1] |
|||
* |
* |
||
* Must be called _ONCE_ for each node. |
* Must be called _ONCE_ for each node. |
||
* |
|||
* max_msg_size is the maximum size of a message |
|||
* (max_send_wr + max_recv_wr) * max_msg_size bytes allocated per connection |
|||
* |
* |
||
* returns non-NULL on success |
* returns non-NULL on success |
||
Line 98: | Line 106: | ||
* connections(ibw_conn *) must have been closed prior talloc_free |
* connections(ibw_conn *) must have been closed prior talloc_free |
||
*/ |
*/ |
||
ibw_ctx *ibw_init(ibw_initattr *attr, int nattr, |
struct ibw_ctx *ibw_init(struct ibw_initattr *attr, int nattr, |
||
⚫ | |||
void *ctx_userdata, |
void *ctx_userdata, |
||
⚫ | |||
ibw_receive_fn_t ibw_receive |
ibw_receive_fn_t ibw_receive, |
||
struct event_context *ectx); |
|||
/* |
/* |
||
Line 111: | Line 120: | ||
* Only after ctx->state=IBWS_STOPPED you can talloc_free the ctx. |
* Only after ctx->state=IBWS_STOPPED you can talloc_free the ctx. |
||
*/ |
*/ |
||
int ibw_stop(ibw_ctx *ctx); |
int ibw_stop(struct ibw_ctx *ctx); |
||
/*************** connection initiation - like stream sockets *****/ |
/*************** connection initiation - like stream sockets *****/ |
||
Line 121: | Line 130: | ||
* return 0 on success |
* return 0 on success |
||
*/ |
*/ |
||
int ibw_bind(ibw_ctx *ctx, struct sockaddr_in *my_addr); |
int ibw_bind(struct ibw_ctx *ctx, struct sockaddr_in *my_addr); |
||
/* |
/* |
||
Line 129: | Line 138: | ||
* (it doesn't touch ctx->state by itself) |
* (it doesn't touch ctx->state by itself) |
||
* |
* |
||
* returns |
* returns 0 on success |
||
*/ |
*/ |
||
int ibw_listen(ibw_ctx *ctx, int backlog); |
int ibw_listen(struct ibw_ctx *ctx, int backlog); |
||
/* |
/* |
||
Line 145: | Line 154: | ||
* Important: you won't get remote IP address (only internal conn info) |
* Important: you won't get remote IP address (only internal conn info) |
||
*/ |
*/ |
||
int ibw_accept(ibw_ctx *ctx, void *conn_userdata); |
int ibw_accept(struct ibw_ctx *ctx, struct ibw_conn *conn, void *conn_userdata); |
||
/* |
/* |
||
Line 156: | Line 165: | ||
* same <conn_userdata> member) structure in ibw_connstate_fn_t. |
* same <conn_userdata> member) structure in ibw_connstate_fn_t. |
||
*/ |
*/ |
||
int ibw_connect(ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata); |
int ibw_connect(struct ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata); |
||
/* |
/* |
||
* Sends out a disconnect request. |
* Sends out a disconnect request. |
||
* You should process |
* You should process fds after 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 |
||
* |
* |
||
* You mustn't talloc_free <conn> after this |
* You mustn't talloc_free <conn> yet right after this, |
||
* first wait for IBWC_DISCONNECTED. |
|||
*/ |
*/ |
||
int ibw_disconnect(struct ibw_conn *conn); |
|||
/************ Infiniband specific event loop wrapping ******************/ |
/************ Infiniband specific event loop wrapping ******************/ |
||
/* |
/* |
||
* You have to use this buf to fill in before send. |
|||
* Must be called in all cases after selecting/polling for ctx->fd_events is set. |
|||
* It's just to avoid memcpy.in ibw_send. |
|||
* Use the same (buf, key) pair with ibw_send. |
|||
* Don't use more space than maxsize (see ibw_init). |
|||
* |
|||
* Returns 0 on success. |
|||
*/ |
*/ |
||
int ibw_alloc_send_buf(struct ibw_conn *conn, void **buf, void **key, int n); |
|||
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); |
|||
/* |
/* |
||
Line 184: | Line 194: | ||
* 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) |
* (in conn->state=IBWC_CONNECTED) |
||
* n must be less or equal than max_msg_size (see ibw_init) |
|||
* |
|||
* You mustn't use (buf, key) any more for sending. |
|||
*/ |
*/ |
||
int ibw_send(ibw_conn *conn, void *buf, int n); |
int ibw_send(struct ibw_conn *conn, void *buf, void *key, int n); |
||
⚫ | |||
/* |
/* |
||
* Retrieves the last error |
* Retrieves the last error |
||
* result: always non-zero, mustn't be freed (static) |
* result: always non-zero, mustn't be freed (static) |
||
*/ |
*/ |
||
const char *ibw_getLastError(); |
const char *ibw_getLastError(void); |
Latest revision as of 19:57, 18 December 2006
File ibwrapper.h:
/* * Unix SMB/CIFS implementation. * Wrap Infiniband calls. * * Copyright (C) Sven Oehme <oehmes@de.ibm.com> 2006 * * Major code contributions by Peter Somogyi <psomogyi@gamax.hu> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ /* Server communication state */ enum ibw_state_ctx { IBWS_INIT = 0, /* ctx start - after ibw_init */ IBWS_READY, /* after ibw_bind & ibw_listen */ 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 */ }; /* Connection state */ struct ibw_ctx { void *ctx_userdata; /* see ibw_init */ enum ibw_state_ctx state; void *internal; struct ibw_conn *conn_list; /* 1st elem of double linked list */ }; enum ibw_state_conn { IBWC_INIT = 0, /* conn start - internal state */ IBWC_CONNECTED, /* after ibw_accept or ibw_connect */ IBWC_DISCONNECTED, /* after ibw_disconnect */ IBWC_ERROR }; struct ibw_conn { struct ibw_ctx *ctx; enum ibw_state_conn state; void *conn_userdata; /* see ibw_connect and ibw_accept */ void *internal; struct ibw_conn *prev, *next; }; /* * (name, value) pair for array param of ibw_init */ struct ibw_initattr { const char *name; const char *value; }; /* * Callback function definition which should inform you about * connection state change * This callback is invoked whenever server or client connection changes. * Both <conn> and <ctx> can be NULL if their state didn't change. * Return nonzero on error. */ typedef int (*ibw_connstate_fn_t)(struct ibw_ctx *ctx, struct ibw_conn *conn); /* * Callback function definition which should process incoming packets * This callback is invoked whenever any message arrives. * Return nonzero on error. * * Important: you mustn't store buf pointer for later use. * Process its contents before returning. */ typedef int (*ibw_receive_fn_t)(struct ibw_conn *conn, void *buf, int n); /* * settings: array of (name, value) pairs * where name is one of: * max_send_wr [default is 256] * max_recv_wr [default is 1024] * <...> * * Must be called _ONCE_ for each node. * * max_msg_size is the maximum size of a message * (max_send_wr + max_recv_wr) * max_msg_size bytes allocated per connection * * 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 */ struct ibw_ctx *ibw_init(struct ibw_initattr *attr, int nattr, void *ctx_userdata, ibw_connstate_fn_t ibw_connstate, ibw_receive_fn_t ibw_receive, struct event_context *ectx); /* * 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(struct 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(struct 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 0 on success */ int ibw_listen(struct 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(struct ibw_ctx *ctx, struct ibw_conn *conn, 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(struct ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata); /* * Sends out a disconnect request. * You should process fds after 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> yet right after this, * first wait for IBWC_DISCONNECTED. */ int ibw_disconnect(struct ibw_conn *conn); /************ Infiniband specific event loop wrapping ******************/ /* * You have to use this buf to fill in before send. * It's just to avoid memcpy.in ibw_send. * Use the same (buf, key) pair with ibw_send. * Don't use more space than maxsize (see ibw_init). * * Returns 0 on success. */ int ibw_alloc_send_buf(struct ibw_conn *conn, void **buf, void **key, int n); /* * Send the message in one * Can be invoked any times (should fit into buffers) and at any time * (in conn->state=IBWC_CONNECTED) * n must be less or equal than max_msg_size (see ibw_init) * * You mustn't use (buf, key) any more for sending. */ int ibw_send(struct ibw_conn *conn, void *buf, void *key, int n); /* * Retrieves the last error * result: always non-zero, mustn't be freed (static) */ const char *ibw_getLastError(void);