Whamcloud - gitweb
f1a0870e92d6def98378dae5e0760d5883079845
[fs/lustre-release.git] / lustre / include / linux / lustre_net.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (C) 2002 Cluster File Systems, Inc.
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
8  *   Lustre is free software; you can redistribute it and/or
9  *   modify it under the terms of version 2 of the GNU General Public
10  *   License as published by the Free Software Foundation.
11  *
12  *   Lustre is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *   GNU General Public License for more details.
16  *
17  *   You should have received a copy of the GNU General Public License
18  *   along with Lustre; if not, write to the Free Software
19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  */
22
23 #ifndef _LUSTRE_NET_H
24 #define _LUSTRE_NET_H
25
26 #include <linux/tqueue.h>
27 #include <linux/kp30.h>
28 // #include <linux/obd.h>
29 #include <portals/p30.h>
30 #include <linux/lustre_idl.h>
31 #include <linux/lustre_ha.h>
32 #include <linux/lustre_import.h>
33
34 /* The following constants determine how much memory is devoted to
35  * buffering in the lustre services.
36  *
37  * ?_NEVENTS            # event queue entries
38  *
39  * ?_NBUFS              # request buffers
40  * ?_BUFSIZE            # bytes in a single request buffer
41  * total memory = ?_NBUFS * ?_BUFSIZE
42  *
43  * ?_MAXREQSIZE         # maximum request service will receive
44  * larger messages will get dropped.
45  * request buffers are auto-unlinked when less than ?_MAXREQSIZE
46  * is left in them.
47  */
48
49 #define LDLM_NUM_THREADS        4
50 #define LDLM_NEVENTS    1024
51 #define LDLM_NBUFS      10
52 #define LDLM_BUFSIZE    (64 * 1024)
53 #define LDLM_MAXREQSIZE 1024
54
55 #define MDT_NUM_THREADS 8
56 #define MDS_NEVENTS     1024
57 #define MDS_NBUFS       10
58 #define MDS_BUFSIZE     (64 * 1024)
59 #define MDS_MAXREQSIZE  1024
60
61 #define OST_NUM_THREADS 6
62 #define OST_NEVENTS     min(num_physpages / 16, 32768UL)
63 #define OST_NBUFS       min(OST_NEVENTS / 128, 256UL)
64 #define OST_BUFSIZE     ((OST_NEVENTS > 4096UL ? 128 : 64) * 1024)
65 #define OST_MAXREQSIZE  (8 * 1024)
66
67 #define CONN_INVALID 1
68
69 struct ptlrpc_connection {
70         struct list_head        c_link;
71         struct lustre_peer      c_peer;
72         __u8                    c_local_uuid[37];  /* XXX do we need this? */
73         __u8                    c_remote_uuid[37];
74
75         int                     c_level;
76         __u32                   c_generation;  /* changes upon new connection */
77         __u32                   c_epoch;       /* changes when peer changes */
78         __u32                   c_bootcount;   /* peer's boot count */
79
80         spinlock_t              c_lock;        /* also protects req->rq_list */
81         __u32                   c_xid_in;
82         __u32                   c_xid_out;
83
84         atomic_t                c_refcount;
85         __u64                   c_token;
86         __u64                   c_remote_conn;
87         __u64                   c_remote_token;
88
89         __u64                   c_last_xid;    /* protected by c_lock */
90         __u64                   c_last_committed;/* protected by c_lock */
91         struct list_head        c_delayed_head;/* delayed until post-recovery */
92         struct list_head        c_sending_head;/* protected by c_lock */
93         struct list_head        c_dying_head;  /* protected by c_lock */
94         struct recovd_data      c_recovd_data;
95
96         struct list_head        c_imports;
97         struct list_head        c_exports;
98         struct list_head        c_sb_chain;
99         __u32                   c_flags; /* can we indicate INVALID elsewhere? */
100 };
101
102 struct ptlrpc_client {
103         __u32                     cli_request_portal;
104         __u32                     cli_reply_portal;
105
106         __u32                     cli_target_devno;
107
108         void                     *cli_data;
109         // struct semaphore          cli_rpc_sem; /* limits outstanding requests */
110
111         char                     *cli_name;
112 };
113
114 /* state flags of requests */
115 #define PTL_RPC_FL_INTR      (1 << 0)
116 #define PTL_RPC_FL_REPLIED   (1 << 1)  /* reply was received */
117 #define PTL_RPC_FL_SENT      (1 << 2)
118 #define PTL_BULK_FL_SENT     (1 << 3)
119 #define PTL_BULK_FL_RCVD     (1 << 4)
120 #define PTL_RPC_FL_ERR       (1 << 5)
121 #define PTL_RPC_FL_TIMEOUT   (1 << 6)
122 #define PTL_RPC_FL_RESEND    (1 << 7)
123 #define PTL_RPC_FL_RECOVERY  (1 << 8)  /* retransmission for recovery */
124 #define PTL_RPC_FL_FINISHED  (1 << 9)
125 #define PTL_RPC_FL_RETAIN    (1 << 10) /* retain for replay after reply */
126 #define PTL_RPC_FL_REPLAY    (1 << 11) /* replay upon recovery */
127 #define PTL_RPC_FL_ALLOCREP  (1 << 12) /* reply buffer allocated */
128
129 struct ptlrpc_request {
130         int rq_type; /* one of PTL_RPC_MSG_* */
131         struct list_head rq_list;
132         struct obd_device *rq_obd;
133         int rq_status;
134         int rq_flags;
135         atomic_t rq_refcount;
136
137         int rq_request_portal; /* XXX FIXME bug 625069 */
138         int rq_reply_portal; /* XXX FIXME bug 625069 */
139
140         int rq_reqlen;
141         struct lustre_msg *rq_reqmsg;
142
143         int rq_replen;
144         struct lustre_msg *rq_repmsg;
145         __u64 rq_transno;
146         __u64 rq_xid;
147
148         int rq_level;
149         time_t rq_timeout;
150         //        void * rq_reply_handle;
151         wait_queue_head_t rq_wait_for_rep;
152
153         /* incoming reply */
154         ptl_md_t rq_reply_md;
155         ptl_handle_me_t rq_reply_me_h;
156
157         /* outgoing req/rep */
158         ptl_md_t rq_req_md;
159
160         struct lustre_peer rq_peer; /* XXX see service.c can this be factored away? */
161         struct obd_export *rq_export;
162         struct ptlrpc_connection *rq_connection;
163         struct obd_import *rq_import;
164         struct ptlrpc_service *rq_svc;
165
166         void (*rq_replay_cb)(struct ptlrpc_request *);
167 };
168
169 #define DEBUG_REQ(level, req, fmt, args...)                                    \
170 do {                                                                           \
171 CDEBUG(level,                                                                  \
172        "@@@ " fmt " req x"LPD64"/t"LPD64" o%d->%s:%d lens %d/%d fl "           \
173        "%x\n" ,  ## args, req->rq_xid, req->rq_transno,                        \
174        req->rq_reqmsg ? req->rq_reqmsg->opc : -1,                              \
175        req->rq_connection ? (char *)req->rq_connection->c_remote_uuid : "<?>", \
176        (req->rq_import && req->rq_import->imp_client) ?                        \
177            req->rq_import->imp_client->cli_request_portal : -1,                \
178        req->rq_reqlen, req->rq_replen, req->rq_flags);                         \
179 } while (0)
180
181 struct ptlrpc_bulk_page {
182         struct ptlrpc_bulk_desc *bp_desc;
183         struct list_head bp_link;
184         void *bp_buf;
185         int bp_buflen;
186         struct page *bp_page;
187         __u32 bp_xid;
188         __u32 bp_flags;
189         struct dentry *bp_dentry;
190         int (*bp_cb)(struct ptlrpc_bulk_page *);
191 };
192
193
194 struct ptlrpc_bulk_desc {
195         struct list_head bd_set_chain; /* entry in obd_brw_set */
196         struct obd_brw_set *bd_brw_set;
197         int bd_flags;
198         struct ptlrpc_connection *bd_connection;
199         struct ptlrpc_client *bd_client;
200         __u32 bd_portal;
201         struct lustre_handle bd_conn;
202         void (*bd_ptl_ev_hdlr)(struct ptlrpc_bulk_desc *);
203
204         wait_queue_head_t bd_waitq;
205         struct list_head bd_page_list;
206         __u32 bd_page_count;
207         atomic_t bd_refcount;
208         void *bd_desc_private;
209
210 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
211         struct work_struct bd_queue;
212 #else
213         struct tq_struct bd_queue;
214 #endif
215
216         ptl_md_t bd_md;
217         ptl_handle_md_t bd_md_h;
218         ptl_handle_me_t bd_me_h;
219
220         atomic_t bd_source_callback_count;
221
222         struct iovec bd_iov[16];    /* self-sized pre-allocated iov */
223 };
224
225 struct ptlrpc_thread {
226         struct list_head t_link;
227
228         __u32 t_flags;
229         wait_queue_head_t t_ctl_waitq;
230 };
231
232 struct ptlrpc_request_buffer_desc {
233         struct list_head       rqbd_list;
234         struct ptlrpc_service *rqbd_service;
235         ptl_handle_me_t        rqbd_me_h;
236         atomic_t               rqbd_refcount;
237         char                  *rqbd_buffer;
238 };
239
240 struct ptlrpc_service {
241         time_t srv_time;
242         time_t srv_timeout;
243
244         /* incoming request buffers */
245         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
246
247         __u32            srv_max_req_size;     /* biggest request to receive */
248         __u32            srv_buf_size;         /* # bytes in a request buffer */
249         struct list_head srv_rqbds;            /* all the request buffer descriptors */
250         __u32            srv_nrqbds;           /* # request buffers */
251         atomic_t         srv_nrqbds_receiving; /* # request buffers posted for input */
252
253         __u32 srv_req_portal;
254         __u32 srv_rep_portal;
255
256         __u32 srv_xid;
257
258         /* event queue */
259         ptl_handle_eq_t srv_eq_h;
260
261         struct lustre_peer srv_self;
262
263         wait_queue_head_t srv_waitq; /* all threads sleep on this */
264
265         spinlock_t srv_lock;
266         struct list_head srv_threads;
267         int (*srv_handler)(struct ptlrpc_request *req);
268         char *srv_name;  /* only statically allocated strings here; we don't clean them */
269 };
270
271 static inline void ptlrpc_hdl2req(struct ptlrpc_request *req,
272                                   struct lustre_handle *h)
273 {
274         req->rq_reqmsg->addr = h->addr;
275         req->rq_reqmsg->cookie = h->cookie;
276 }
277
278 typedef void (*bulk_callback_t)(struct ptlrpc_bulk_desc *, void *);
279
280 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
281
282 /* rpc/connection.c */
283 void ptlrpc_readdress_connection(struct ptlrpc_connection *, obd_uuid_t uuid);
284 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer,
285                                                 obd_uuid_t uuid);
286 int ptlrpc_put_connection(struct ptlrpc_connection *c);
287 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
288 void ptlrpc_init_connection(void);
289 void ptlrpc_cleanup_connection(void);
290
291 /* rpc/niobuf.c */
292 int ptlrpc_check_bulk_sent(struct ptlrpc_bulk_desc *bulk);
293 int ptlrpc_check_bulk_received(struct ptlrpc_bulk_desc *bulk);
294 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
295 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
296 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
297 struct obd_brw_set *obd_brw_set_new(void);
298 void obd_brw_set_add(struct obd_brw_set *, struct ptlrpc_bulk_desc *);
299 void obd_brw_set_free(struct obd_brw_set *);
300
301 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
302 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
303 void ptlrpc_resend_req(struct ptlrpc_request *request);
304 int ptl_send_rpc(struct ptlrpc_request *request);
305 void ptlrpc_link_svc_me(struct ptlrpc_request_buffer_desc *rqbd);
306
307 /* rpc/client.c */
308 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
309                         struct ptlrpc_client *);
310 void ptlrpc_cleanup_client(struct obd_import *imp);
311 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
312 struct ptlrpc_connection *ptlrpc_uuid_to_connection(obd_uuid_t uuid);
313
314 int ll_brw_sync_wait(struct obd_brw_set *, int phase);
315
316 int ptlrpc_queue_wait(struct ptlrpc_request *req);
317 void ptlrpc_continue_req(struct ptlrpc_request *req);
318 int ptlrpc_replay_req(struct ptlrpc_request *req);
319 void ptlrpc_restart_req(struct ptlrpc_request *req);
320
321 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, int opcode,
322                                        int count, int *lengths, char **bufs);
323 void ptlrpc_free_req(struct ptlrpc_request *request);
324 void ptlrpc_req_finished(struct ptlrpc_request *request);
325 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
326 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
327 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
328 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
329 int ptlrpc_check_status(struct ptlrpc_request *req, int err);
330
331 /* rpc/service.c */
332 struct ptlrpc_service *
333 ptlrpc_init_svc(__u32 nevents, __u32 nbufs, __u32 bufsize, __u32 max_req_size,
334                 int req_portal, int rep_portal,
335                 obd_uuid_t uuid, svc_handler_t, char *name);
336 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
337 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
338                         char *name);
339 int ptlrpc_unregister_service(struct ptlrpc_service *service);
340
341 struct ptlrpc_svc_data {
342         char *name;
343         struct ptlrpc_service *svc;
344         struct ptlrpc_thread *thread;
345         struct obd_device *dev;
346 };
347
348 /* rpc/pack_generic.c */
349 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
350                     struct lustre_msg **msg);
351 int lustre_msg_size(int count, int *lengths);
352 int lustre_unpack_msg(struct lustre_msg *m, int len);
353 void *lustre_msg_buf(struct lustre_msg *m, int n);
354
355 static inline void ptlrpc_bulk_decref(struct ptlrpc_bulk_desc *desc)
356 {
357         if (atomic_dec_and_test(&desc->bd_refcount)) {
358                 CDEBUG(D_PAGE, "Released last ref on %p, freeing\n", desc);
359                 ptlrpc_free_bulk(desc);
360         } else {
361                 CDEBUG(D_PAGE, "%p -> %d\n", desc,
362                        atomic_read(&desc->bd_refcount));
363         }
364 }
365
366 static inline void ptlrpc_bulk_addref(struct ptlrpc_bulk_desc *desc)
367 {
368         atomic_inc(&desc->bd_refcount);
369         CDEBUG(D_PAGE, "Set refcount of %p to %d\n", desc,
370                atomic_read(&desc->bd_refcount));
371 }
372
373 #endif