Implementing basic data structure handling...
[vlendec/samba-autobuild/.git] / ctdb / ib / ibwrapper.h
1 /*
2  * Unix SMB/CIFS implementation.
3  * Wrap Infiniband calls.
4  *
5  * Copyright (C) Sven Oehme <oehmes@de.ibm.com> 2006
6  *
7  * Major code contributions by Peter Somogyi <psomogyi@gamax.hu>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  */
23
24 /* Server communication state */
25 typedef enum {
26         IBWS_INIT = 0, /* ctx start - after ibw_init */
27         IBWS_READY, /* after ibw_bind & ibw_listen */
28         IBWS_CONNECT_REQUEST, /* after [IBWS_READY + incoming request] */
29                 /* => [(ibw_accept)IBWS_READY | (ibw_disconnect)STOPPED | ERROR] */
30         IBWS_STOPPED, /* normal stop <= ibw_disconnect+(IBWS_READY | IBWS_CONNECT_REQUEST) */
31         IBWS_ERROR /* abnormal state; ibw_stop must be called after this */
32 } ibw_state_ctx;
33
34 /* Connection state */
35 typedef struct _ibw_ctx {
36         void *ctx_userdata; /* see ibw_init */
37
38         ibw_state_ctx state;
39         void *internal;
40
41         ibw_conn *first_conn, *last_conn;
42 } ibw_ctx;
43
44 typedef enum {
45         IBWC_INIT = 0, /* conn start - internal state */
46         IBWC_CONNECTED, /* after ibw_accept or ibw_connect */
47         IBWC_DISCONNECTED, /* after ibw_disconnect */
48         IBWC_ERROR
49 } ibw_state_conn;
50
51 typedef struct _ibw_conn {
52         ibw_ctx *ctx;
53         ibw_state_conn state;
54
55         void *conn_userdata; /* see ibw_connect and ibw_accept */
56         void *internal;
57
58         ibw_conn *prev, next;
59 } ibw_conn;
60
61 /*
62  * (name, value) pair for array param of ibw_init
63  */
64 typedef struct _ibw_initattr {
65         const char *name;
66         const char *value;
67 } ibw_initattr;
68
69 /*
70  * Callback function definition which should inform you about
71  * connection state change
72  * This callback is invoked from within ibw_process_event.
73  * Both <conn> and <ctx> can be NULL if their state didn't change.
74  * Return nonzero on error.
75  */
76 typedef int (*ibw_connstate_fn_t)(ibw_ctx *ctx, ibw_conn *conn);
77
78 /*
79  * Callback function definition which should process incoming packets
80  * This callback is invoked from within ibw_process_event.
81  * Return nonzero on error.
82  *
83  * Important: you mustn't store buf pointer for later use. Process its contents before returning.
84  */
85 typedef int (*ibw_receive_fn_t)(ibw_conn *conn, void *buf, int n);
86
87 /*
88  * settings: array of (name, value) pairs
89  * where name is one of:
90  *      dev_name [default is the first one]
91  *      rx_depth [default is 500]
92  *      mtu     [default is 1024]
93  *      ib_port [default is 1]
94  *
95  * Must be called _ONCE_ for each node.
96  *
97  * returns non-NULL on success
98  *
99  * talloc_free must be called for the result in IBWS_STOPPED;
100  *    it will close resources by destructor
101  *    connections(ibw_conn *) must have been closed prior talloc_free
102  */
103 ibw_ctx *ibw_init(ibw_initattr *attr, int nattr,
104         void *ctx_userdata,
105         ibw_connstate_fn_t ibw_connstate,
106         ibw_receive_fn_t ibw_receive);
107
108 /*
109  * Must be called in states of (IBWS_ERROR, IBWS_READY, IBWS_CONNECT_REQUEST)
110  *
111  * It will send out disconnect requests and free up ibw_conn structures.
112  * The ctx->state will transit to IBWS_STOPPED after every conn are disconnected.
113  * During that time, you mustn't send/recv/disconnect any more.
114  * Only after ctx->state=IBWS_STOPPED you can talloc_free the ctx.
115  */
116 int ibw_stop(ibw_ctx *ctx);
117
118 /*************** connection initiation - like stream sockets *****/
119
120 /*
121  * works like socket bind
122  * needs a normal internet address here
123  *
124  * return 0 on success
125  */
126 int ibw_bind(ibw_ctx *ctx, struct sockaddr_in *my_addr);
127
128 /*
129  * works like socket listen
130  * non-blocking
131  * enables accepting incoming connections (after IBWS_READY)
132  * (it doesn't touch ctx->state by itself)
133  *
134  * returns 0 on success
135  */
136 int ibw_listen(ibw_ctx *ctx, int backlog);
137
138 /*
139  * works like socket accept
140  * initializes a connection to a client
141  * must be called when state=IBWS_CONNECT_REQUEST
142  *
143  * returns 0 on success
144  *
145  * You have +1 waiting here: you will get ibw_conn (having the
146  * same <conn_userdata> member) structure in ibw_connstate_fn_t.
147  *
148  * Important: you won't get remote IP address (only internal conn info)
149  */
150 int ibw_accept(ibw_ctx *ctx, void *conn_userdata);
151
152 /*
153  * Needs a normal internet address here
154  * can be called within IBWS_READY|IBWS_CONNECT_REQUEST
155  *
156  * returns non-NULL on success
157  *
158  * You have +1 waiting here: you will get ibw_conn (having the
159  * same <conn_userdata> member) structure in ibw_connstate_fn_t.
160  */
161 int ibw_connect(ibw_ctx *ctx, struct sockaddr_in *serv_addr, void *conn_userdata);
162
163 /*
164  * Sends out a disconnect request.
165  * You should process fds after calling this function
166  * and then process it with ibw_process_event normally
167  * until you get conn->state = IBWC_DISCONNECTED
168  *
169  * You mustn't talloc_free <conn> yet right after this,
170  * first wait for IBWC_DISCONNECTED.
171  */
172 void ibw_disconnect(ibw_conn *conn);
173
174 /************ Infiniband specific event loop wrapping ******************/
175
176 /*
177  * You have to use this buf to fill in before send.
178  * It's just to avoid memcpy.in ibw_send.
179  * Use the same (buf, key) pair with ibw_send.
180  *
181  * Returns 0 on success.
182  */
183 int ibw_alloc_send_buf(ibw_conn *conn, void **buf, void **key, int n);
184
185 /*
186  * Send the message in one
187  * Can be invoked any times (should fit into buffers) and at any time
188  * (in conn->state=IBWC_CONNECTED)
189  *
190  * You mustn't use (buf, key) any more for sending.
191  */
192 int ibw_send(ibw_conn *conn, void *buf, void *key, int n);
193
194 /*
195  * Retrieves the last error
196  * result: always non-zero, mustn't be freed (static)
197  */
198 const char *ibw_getLastError();