Whamcloud - gitweb
Land b1_6_bug11013 onto HEAD (20070313_0924)
[fs/lustre-release.git] / lustre / include / 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, 2003 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 #if defined(__linux__)
27 #include <linux/lustre_net.h>
28 #elif defined(__APPLE__)
29 #include <darwin/lustre_net.h>
30 #elif defined(__WINNT__)
31 #include <winnt/lustre_net.h>
32 #else
33 #error Unsupported operating system.
34 #endif
35
36 #include <libcfs/kp30.h>
37 // #include <obd.h>
38 #include <lnet/lnet.h>
39 #include <lustre/lustre_idl.h>
40 #include <lustre_ha.h>
41 #include <lustre_import.h>
42 #include <lprocfs_status.h>
43
44 /* MD flags we _always_ use */
45 #define PTLRPC_MD_OPTIONS  0
46
47 /* Define maxima for bulk I/O
48  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
49  * these limits are system wide and not interface-local. */
50 #define PTLRPC_MAX_BRW_BITS     LNET_MTU_BITS
51 #define PTLRPC_MAX_BRW_SIZE     (1<<LNET_MTU_BITS)
52 #define PTLRPC_MAX_BRW_PAGES    (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
53
54 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
55 #ifdef __KERNEL__
56 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
57 #  error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
58 # endif
59 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
60 #  error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
61 # endif
62 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU)
63 #  error "PTLRPC_MAX_BRW_SIZE too big"
64 # endif
65 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV)
66 #  error "PTLRPC_MAX_BRW_PAGES too big"
67 # endif
68 #endif /* __KERNEL__ */
69
70 /* Size over which to OBD_VMALLOC() rather than OBD_ALLOC() service request
71  * buffers */
72 #define SVC_BUF_VMALLOC_THRESHOLD (2 * CFS_PAGE_SIZE)
73
74 /* The following constants determine how memory is used to buffer incoming
75  * service requests.
76  *
77  * ?_NBUFS              # buffers to allocate when growing the pool
78  * ?_BUFSIZE            # bytes in a single request buffer
79  * ?_MAXREQSIZE         # maximum request service will receive
80  *
81  * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
82  * of ?_NBUFS is added to the pool.
83  *
84  * Messages larger than ?_MAXREQSIZE are dropped.  Request buffers are
85  * considered full when less than ?_MAXREQSIZE is left in them.
86  */
87
88 #define LDLM_THREADS_AUTO_MIN min((int)(smp_num_cpus * smp_num_cpus * 2), 8)
89 #define LDLM_THREADS_AUTO_MAX (LDLM_THREADS_AUTO_MIN * 16)
90 #define LDLM_BL_THREADS  LDLM_THREADS_AUTO_MIN
91 #define LDLM_NBUFS      (64 * smp_num_cpus)
92 #define LDLM_BUFSIZE    (8 * 1024)
93 #define LDLM_MAXREQSIZE (5 * 1024)
94 #define LDLM_MAXREPSIZE (1024)
95
96 /* Absolute limits */
97 #define MDS_THREADS_MIN 2
98 #define MDS_THREADS_MAX 512
99 #define MDS_THREADS_MIN_READPAGE 2
100 #define MDS_NBUFS       (64 * smp_num_cpus)
101 #define MDS_BUFSIZE     (8 * 1024)
102 /* Assume file name length = FNAME_MAX = 256 (true for ext3).
103  *        path name length = PATH_MAX = 4096
104  *        LOV MD size max  = EA_MAX = 4000
105  * symlink:  FNAME_MAX + PATH_MAX  <- largest
106  * link:     FNAME_MAX + PATH_MAX  (mds_rec_link < mds_rec_create)
107  * rename:   FNAME_MAX + FNAME_MAX
108  * open:     FNAME_MAX + EA_MAX
109  *
110  * MDS_MAXREQSIZE ~= 4736 bytes =
111  * lustre_msg + ldlm_request + mds_body + mds_rec_create + FNAME_MAX + PATH_MAX
112  * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
113  * or, for mds_close() and mds_reint_unlink() on a many-OST filesystem:
114  *      = 9210 bytes = lustre_msg + mds_body + 160 * (easize + cookiesize)
115  *
116  * Realistic size is about 512 bytes (20 character name + 128 char symlink),
117  * except in the open case where there are a large number of OSTs in a LOV.
118  */
119 #define MDS_MAXREQSIZE  (5 * 1024)
120 #define MDS_MAXREPSIZE  max(9 * 1024, 280 + LOV_MAX_STRIPE_COUNT * 56)
121
122 #define MGS_THREADS_AUTO_MIN 2
123 #define MGS_THREADS_AUTO_MAX 32
124 #define MGS_NBUFS       (64 * smp_num_cpus)
125 #define MGS_BUFSIZE     (8 * 1024)
126 #define MGS_MAXREQSIZE  (8 * 1024)
127 #define MGS_MAXREPSIZE  (9 * 1024)
128
129 /* Absolute limits */
130 #define OSS_THREADS_MIN 2
131 #define OSS_THREADS_MAX 512
132 #define OST_NBUFS       (64 * smp_num_cpus)
133 #define OST_BUFSIZE     (8 * 1024)
134 /* OST_MAXREQSIZE ~= 4768 bytes =
135  * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote
136  *
137  * - single object with 16 pages is 512 bytes
138  * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
139  */
140 #define OST_MAXREQSIZE  (5 * 1024)
141 #define OST_MAXREPSIZE  (9 * 1024)
142
143 struct ptlrpc_connection {
144         struct list_head        c_link;
145         struct hlist_node       c_hash;
146         lnet_nid_t              c_self;
147         lnet_process_id_t       c_peer;
148         struct obd_uuid         c_remote_uuid;
149         atomic_t                c_refcount;
150 };
151
152 struct ptlrpc_client {
153         __u32                     cli_request_portal;
154         __u32                     cli_reply_portal;
155         char                     *cli_name;
156 };
157
158 /* state flags of requests */
159 /* XXX only ones left are those used by the bulk descs as well! */
160 #define PTL_RPC_FL_INTR      (1 << 0)  /* reply wait was interrupted by user */
161 #define PTL_RPC_FL_TIMEOUT   (1 << 7)  /* request timed out waiting for reply */
162
163 #define REQ_MAX_ACK_LOCKS 8
164
165 union ptlrpc_async_args {
166         /* Scratchpad for passing args to completion interpreter. Users
167          * cast to the struct of their choosing, and LASSERT that this is
168          * big enough.  For _tons_ of context, OBD_ALLOC a struct and store
169          * a pointer to it here.  The pointer_arg ensures this struct is at
170          * least big enough for that. */
171         void      *pointer_arg[9];
172         __u64      space[4];
173 };
174
175 struct ptlrpc_request_set;
176 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
177
178 struct ptlrpc_request_set {
179         int               set_remaining; /* # uncompleted requests */
180         cfs_waitq_t       set_waitq;
181         cfs_waitq_t      *set_wakeup_ptr;
182         struct list_head  set_requests;
183         set_interpreter_func    set_interpret; /* completion callback */
184         void              *set_arg; /* completion context */
185         /* locked so that any old caller can communicate requests to
186          * the set holder who can then fold them into the lock-free set */
187         spinlock_t        set_new_req_lock;
188         struct list_head  set_new_requests;
189 };
190
191 struct ptlrpc_bulk_desc;
192
193 /*
194  * ptlrpc callback & work item stuff
195  */
196 struct ptlrpc_cb_id {
197         void   (*cbid_fn)(lnet_event_t *ev);     /* specific callback fn */
198         void    *cbid_arg;                      /* additional arg */
199 };
200
201 #define RS_MAX_LOCKS 4
202 #define RS_DEBUG     1
203
204 struct ptlrpc_reply_state {
205         struct ptlrpc_cb_id    rs_cb_id;
206         struct list_head       rs_list;
207         struct list_head       rs_exp_list;
208         struct list_head       rs_obd_list;
209 #if RS_DEBUG
210         struct list_head       rs_debug_list;
211 #endif
212         /* updates to following flag serialised by srv_request_lock */
213         unsigned int           rs_difficult:1;     /* ACK/commit stuff */
214         unsigned int           rs_scheduled:1;     /* being handled? */
215         unsigned int           rs_scheduled_ever:1;/* any schedule attempts? */
216         unsigned int           rs_handled:1;  /* been handled yet? */
217         unsigned int           rs_on_net:1;   /* reply_out_callback pending? */
218         unsigned int           rs_prealloc:1; /* rs from prealloc list */
219
220         int                    rs_size;
221         __u64                  rs_transno;
222         __u64                  rs_xid;
223         struct obd_export     *rs_export;
224         struct ptlrpc_service *rs_service;
225         lnet_handle_md_t       rs_md_h;
226         atomic_t               rs_refcount;
227
228         /* locks awaiting client reply ACK */
229         int                    rs_nlocks;
230         struct lustre_handle   rs_locks[RS_MAX_LOCKS];
231         ldlm_mode_t            rs_modes[RS_MAX_LOCKS];
232         /* last member: variable sized reply message */
233         struct lustre_msg     *rs_msg;
234 };
235
236 struct ptlrpc_thread;
237
238 enum rq_phase {
239         RQ_PHASE_NEW         = 0xebc0de00,
240         RQ_PHASE_RPC         = 0xebc0de01,
241         RQ_PHASE_BULK        = 0xebc0de02,
242         RQ_PHASE_INTERPRET   = 0xebc0de03,
243         RQ_PHASE_COMPLETE    = 0xebc0de04,
244 };
245
246 struct ptlrpc_request_pool {
247         spinlock_t prp_lock;
248         struct list_head prp_req_list;    /* list of ptlrpc_request structs */
249         int prp_rq_size;
250         void (*prp_populate)(struct ptlrpc_request_pool *, int);
251 };
252
253 struct ptlrpc_request {
254         int rq_type; /* one of PTL_RPC_MSG_* */
255         struct list_head rq_list;
256         struct list_head rq_history_list;       /* server-side history */
257         __u64            rq_history_seq;        /* history sequence # */
258         int rq_status;
259         spinlock_t rq_lock;
260         /* client-side flags */
261         unsigned int rq_intr:1, rq_replied:1, rq_err:1,
262                 rq_timedout:1, rq_resend:1, rq_restart:1,
263                 /*
264                  * when ->rq_replay is set, request is kept by the client even
265                  * after server commits corresponding transaction. This is
266                  * used for operations that require sequence of multiple
267                  * requests to be replayed. The only example currently is file
268                  * open/close. When last request in such a sequence is
269                  * committed, ->rq_replay is cleared on all requests in the
270                  * sequence.
271                  */
272                 rq_replay:1,
273                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
274                 rq_no_delay:1, rq_net_err:1;
275         enum rq_phase rq_phase; /* one of RQ_PHASE_* */
276         atomic_t rq_refcount;   /* client-side refcount for SENT race */
277
278         struct ptlrpc_thread *rq_svc_thread; /* initial thread servicing req */
279
280         int rq_request_portal;  /* XXX FIXME bug 249 */
281         int rq_reply_portal;    /* XXX FIXME bug 249 */
282
283         int rq_nob_received; /* client-side # reply bytes actually received  */
284
285         int rq_reqlen;
286         struct lustre_msg *rq_reqmsg;
287
288         int rq_timeout;         /* time to wait for reply (seconds) */
289         int rq_replen;
290         struct lustre_msg *rq_repmsg;
291         __u64 rq_transno;
292         __u64 rq_xid;
293         struct list_head rq_replay_list;
294
295         __u32 rq_req_swab_mask;
296         __u32 rq_rep_swab_mask;
297
298         int rq_import_generation;
299         enum lustre_imp_state rq_send_state;
300
301         /* client+server request */
302         lnet_handle_md_t     rq_req_md_h;
303         struct ptlrpc_cb_id  rq_req_cbid;
304
305         /* server-side... */
306         struct timeval       rq_arrival_time;       /* request arrival time */
307         struct ptlrpc_reply_state *rq_reply_state;  /* separated reply state */
308         struct ptlrpc_request_buffer_desc *rq_rqbd; /* incoming request buffer*/
309 #ifdef CRAY_XT3
310         __u32                rq_uid;            /* peer uid, used in MDS only */
311 #endif
312
313         /* client-only incoming reply */
314         lnet_handle_md_t     rq_reply_md_h;
315         cfs_waitq_t          rq_reply_waitq;
316         struct ptlrpc_cb_id  rq_reply_cbid;
317
318         lnet_nid_t           rq_self;
319         lnet_process_id_t    rq_peer;
320         struct obd_export   *rq_export;
321         struct obd_import   *rq_import;
322
323         void (*rq_replay_cb)(struct ptlrpc_request *);
324         void (*rq_commit_cb)(struct ptlrpc_request *);
325         void  *rq_cb_data;
326
327         struct ptlrpc_bulk_desc *rq_bulk;       /* client side bulk */
328         time_t rq_sent;                         /* when request sent, seconds */
329
330         /* Multi-rpc bits */
331         struct list_head rq_set_chain;
332         struct ptlrpc_request_set *rq_set;
333         void *rq_interpret_reply;               /* Async completion handler */
334         union ptlrpc_async_args rq_async_args;  /* Async completion context */
335         void *rq_ptlrpcd_data;
336         struct ptlrpc_request_pool *rq_pool;    /* Pool if request from
337                                                    preallocated list */
338 };
339
340 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
341 {
342         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
343         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
344         req->rq_req_swab_mask |= 1 << index;
345 }
346
347 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
348 {
349         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
350         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
351         req->rq_rep_swab_mask |= 1 << index;
352 }
353
354 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
355
356         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
357         return req->rq_req_swab_mask & (1 << index);
358 }
359
360 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
361 {
362         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
363         return req->rq_rep_swab_mask & (1 << index);
364 }
365
366 #define SWAB_PARANOIA 1
367
368 #if SWAB_PARANOIA
369 /* unpacking: assert idx not unpacked already */
370 #define LASSERT_REQSWAB(rq, idx) lustre_set_req_swabbed(rq, idx)
371 #define LASSERT_REPSWAB(rq, idx) lustre_set_rep_swabbed(rq, idx)
372
373 /* just looking: assert idx already unpacked */
374 #define LASSERT_REQSWABBED(rq, idx) LASSERT(lustre_req_swabbed(rq, idx))
375 #define LASSERT_REPSWABBED(rq, idx) LASSERT(lustre_rep_swabbed(rq, idx))
376
377 #else
378 #define LASSERT_REQSWAB(rq, idx)
379 #define LASSERT_REPSWAB(rq, idx)
380 #define LASSERT_REQSWABBED(rq, idx)
381 #define LASSERT_REPSWABBED(rq, idx)
382 #endif
383
384 static inline const char *
385 ptlrpc_rqphase2str(struct ptlrpc_request *req)
386 {
387         switch (req->rq_phase) {
388         case RQ_PHASE_NEW:
389                 return "New";
390         case RQ_PHASE_RPC:
391                 return "Rpc";
392         case RQ_PHASE_BULK:
393                 return "Bulk";
394         case RQ_PHASE_INTERPRET:
395                 return "Interpret";
396         case RQ_PHASE_COMPLETE:
397                 return "Complete";
398         default:
399                 return "?Phase?";
400         }
401 }
402
403 /* Spare the preprocessor, spoil the bugs. */
404 #define FLAG(field, str) (field ? str : "")
405
406 #define DEBUG_REQ_FLAGS(req)                                                    \
407         ptlrpc_rqphase2str(req),                                                \
408         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                    \
409         FLAG(req->rq_err, "E"),                                                 \
410         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),   \
411         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                  \
412         FLAG(req->rq_no_resend, "N"),                                           \
413         FLAG(req->rq_waiting, "W")
414
415 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s"
416
417 void _debug_req(struct ptlrpc_request *req, __u32 mask,
418                struct libcfs_debug_msg_data *data, const char *fmt, ...);
419
420 #define debug_req(cdls, level, req, file, func, line, fmt, a...)                \
421 do {                                                                            \
422         CHECK_STACK();                                                          \
423                                                                                 \
424         if (((level) & D_CANTMASK) != 0 ||                                      \
425             ((libcfs_debug & (level)) != 0 &&                                   \
426              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {                \
427                 static struct libcfs_debug_msg_data _req_dbg_data =             \
428                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM, file, func, line);   \
429                 _debug_req((req), (level), &_req_dbg_data, fmt, ##a);           \
430         }                                                                       \
431 } while(0)
432
433 /* for most callers (level is a constant) this is resolved at compile time */
434 #define DEBUG_REQ(level, req, fmt, args...)                                    \
435 do {                                                                           \
436         if ((level) & (D_ERROR | D_WARNING)) {                                 \
437                 static cfs_debug_limit_state_t cdls;                           \
438                 debug_req(&cdls, level, req, __FILE__, __func__, __LINE__,     \
439                           "@@@ "fmt, ## args);                                 \
440         } else                                                                 \
441                 debug_req(NULL, level, req, __FILE__, __func__, __LINE__,      \
442                           "@@@ "fmt, ## args);                                 \
443 } while (0)
444
445 struct ptlrpc_bulk_page {
446         struct list_head bp_link;
447         int bp_buflen;
448         int bp_pageoffset;                      /* offset within a page */
449         struct page *bp_page;
450 };
451
452 #define BULK_GET_SOURCE   0
453 #define BULK_PUT_SINK     1
454 #define BULK_GET_SINK     2
455 #define BULK_PUT_SOURCE   3
456
457 struct ptlrpc_bulk_desc {
458         unsigned int bd_success:1;              /* completed successfully */
459         unsigned int bd_network_rw:1;           /* accessible to the network */
460         unsigned int bd_type:2;                 /* {put,get}{source,sink} */
461         unsigned int bd_registered:1;           /* client side */
462         spinlock_t   bd_lock;                   /* serialise with callback */
463         int bd_import_generation;
464         struct obd_export *bd_export;
465         struct obd_import *bd_import;
466         __u32 bd_portal;
467         struct ptlrpc_request *bd_req;          /* associated request */
468         cfs_waitq_t            bd_waitq;        /* server side only WQ */
469         int                    bd_iov_count;    /* # entries in bd_iov */
470         int                    bd_max_iov;      /* allocated size of bd_iov */
471         int                    bd_nob;          /* # bytes covered */
472         int                    bd_nob_transferred; /* # bytes GOT/PUT */
473
474         __u64                  bd_last_xid;
475
476         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
477         lnet_handle_md_t        bd_md_h;         /* associated MD */
478
479 #if defined(__KERNEL__)
480         lnet_kiov_t             bd_iov[0];
481 #else
482         lnet_md_iovec_t         bd_iov[0];
483 #endif
484 };
485
486 struct ptlrpc_thread {
487
488         struct list_head t_link; /* active threads for service, from svc->srv_threads */
489
490         void *t_data;            /* thread-private data (preallocated memory) */
491         __u32 t_flags;
492
493         unsigned int t_id; /* service thread index, from ptlrpc_start_threads */
494         cfs_waitq_t t_ctl_waitq;
495 };
496
497 struct ptlrpc_request_buffer_desc {
498         struct list_head       rqbd_list;
499         struct list_head       rqbd_reqs;
500         struct ptlrpc_service *rqbd_service;
501         lnet_handle_md_t       rqbd_md_h;
502         int                    rqbd_refcount;
503         char                  *rqbd_buffer;
504         struct ptlrpc_cb_id    rqbd_cbid;
505         struct ptlrpc_request  rqbd_req;
506 };
507
508 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
509 typedef void (*svcreq_printfn_t)(void *, struct ptlrpc_request *);
510
511 struct ptlrpc_service {
512         struct list_head srv_list;              /* chain thru all services */
513         int              srv_max_req_size;      /* biggest request to receive */
514         int              srv_max_reply_size;    /* biggest reply to send */
515         int              srv_buf_size;          /* size of individual buffers */
516         int              srv_nbuf_per_group;    /* # buffers to allocate in 1 group */
517         int              srv_nbufs;             /* total # req buffer descs allocated */
518         int              srv_threads_min;       /* threads to start at SOW */
519         int              srv_threads_max;       /* thread upper limit */
520         int              srv_threads_started;   /* index of last started thread */
521         int              srv_threads_running;   /* # running threads */
522         int              srv_n_difficult_replies; /* # 'difficult' replies */
523         int              srv_n_active_reqs;     /* # reqs being served */
524         cfs_duration_t   srv_rqbd_timeout;      /* timeout before re-posting reqs, in tick */
525         int              srv_watchdog_timeout;  /* soft watchdog timeout, in ms */
526         unsigned         srv_cpu_affinity:1;    /* bind threads to CPUs */
527
528         __u32            srv_req_portal;
529         __u32            srv_rep_portal;
530
531         int               srv_n_queued_reqs;    /* # reqs waiting to be served */
532         struct list_head  srv_request_queue;    /* reqs waiting for service */
533
534         struct list_head  srv_request_history;  /* request history */
535         __u64             srv_request_seq;      /* next request sequence # */
536         __u64             srv_request_max_cull_seq; /* highest seq culled from history */
537         svcreq_printfn_t  srv_request_history_print_fn; /* service-specific print fn */
538
539         struct list_head  srv_idle_rqbds;       /* request buffers to be reposted */
540         struct list_head  srv_active_rqbds;     /* req buffers receiving */
541         struct list_head  srv_history_rqbds;    /* request buffer history */
542         int               srv_nrqbd_receiving;  /* # posted request buffers */
543         int               srv_n_history_rqbds;  /* # request buffers in history */
544         int               srv_max_history_rqbds;/* max # request buffers in history */
545
546         atomic_t          srv_outstanding_replies;
547         struct list_head  srv_active_replies;   /* all the active replies */
548         struct list_head  srv_reply_queue;      /* replies waiting for service */
549
550         cfs_waitq_t       srv_waitq; /* all threads sleep on this. This
551                                       * wait-queue is signalled when new
552                                       * incoming request arrives and when
553                                       * difficult reply has to be handled. */
554
555         struct list_head   srv_threads;         /* service thread list */
556         svc_handler_t      srv_handler;
557
558         char *srv_name;  /* only statically allocated strings here; we don't clean them */
559         char *srv_thread_name;  /* only statically allocated strings here; we don't clean them */
560
561         spinlock_t               srv_lock;
562
563         cfs_proc_dir_entry_t    *srv_procroot;
564         struct lprocfs_stats    *srv_stats;
565
566         /* List of free reply_states */
567         struct list_head         srv_free_rs_list;
568         /* waitq to run, when adding stuff to srv_free_rs_list */
569         cfs_waitq_t              srv_free_rs_waitq;
570         
571         /*
572          * if non-NULL called during thread creation (ptlrpc_start_thread())
573          * to initialize service specific per-thread state.
574          */
575         int (*srv_init)(struct ptlrpc_thread *thread);
576         /*
577          * if non-NULL called during thread shutdown (ptlrpc_main()) to
578          * destruct state created by ->srv_init().
579          */
580         void (*srv_done)(struct ptlrpc_thread *thread);
581
582         //struct ptlrpc_srv_ni srv_interfaces[0];
583 };
584
585 /* ptlrpc/events.c */
586 extern lnet_handle_eq_t ptlrpc_eq_h;
587 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
588                                lnet_process_id_t *peer, lnet_nid_t *self);
589 extern void request_out_callback (lnet_event_t *ev);
590 extern void reply_in_callback(lnet_event_t *ev);
591 extern void client_bulk_callback (lnet_event_t *ev);
592 extern void request_in_callback(lnet_event_t *ev);
593 extern void reply_out_callback(lnet_event_t *ev);
594 extern void server_bulk_callback (lnet_event_t *ev);
595
596 /* ptlrpc/connection.c */
597 void ptlrpc_dump_connections(void);
598 void ptlrpc_readdress_connection(struct ptlrpc_connection *, struct obd_uuid *);
599 struct ptlrpc_connection *ptlrpc_get_connection(lnet_process_id_t peer,
600                                                 lnet_nid_t self, struct obd_uuid *uuid);
601 int ptlrpc_put_connection(struct ptlrpc_connection *c);
602 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
603 int ptlrpc_init_connection(void);
604 void ptlrpc_cleanup_connection(void);
605 extern lnet_pid_t ptl_get_pid(void);
606
607 /* ptlrpc/niobuf.c */
608 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
609 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
610 int ptlrpc_register_bulk(struct ptlrpc_request *req);
611 void ptlrpc_unregister_bulk (struct ptlrpc_request *req);
612
613 static inline int ptlrpc_bulk_active (struct ptlrpc_bulk_desc *desc)
614 {
615         int           rc;
616
617         spin_lock(&desc->bd_lock);
618         rc = desc->bd_network_rw;
619         spin_unlock(&desc->bd_lock);
620         return (rc);
621 }
622
623 int ptlrpc_send_reply(struct ptlrpc_request *req, int);
624 int ptlrpc_reply(struct ptlrpc_request *req);
625 int ptlrpc_error(struct ptlrpc_request *req);
626 void ptlrpc_resend_req(struct ptlrpc_request *request);
627 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
628 int ptlrpc_register_rqbd (struct ptlrpc_request_buffer_desc *rqbd);
629
630 /* ptlrpc/client.c */
631 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
632                         struct ptlrpc_client *);
633 void ptlrpc_cleanup_client(struct obd_import *imp);
634 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
635
636 static inline int
637 ptlrpc_client_receiving_reply (struct ptlrpc_request *req)
638 {
639         int           rc;
640
641         spin_lock(&req->rq_lock);
642         rc = req->rq_receiving_reply;
643         spin_unlock(&req->rq_lock);
644         return (rc);
645 }
646
647 static inline int
648 ptlrpc_client_replied (struct ptlrpc_request *req)
649 {
650         int           rc;
651
652         spin_lock(&req->rq_lock);
653         rc = req->rq_replied;
654         spin_unlock(&req->rq_lock);
655         return (rc);
656 }
657
658 static inline void
659 ptlrpc_wake_client_req (struct ptlrpc_request *req)
660 {
661         if (req->rq_set == NULL)
662                 cfs_waitq_signal(&req->rq_reply_waitq);
663         else
664                 cfs_waitq_signal(&req->rq_set->set_waitq);
665 }
666
667 int ptlrpc_queue_wait(struct ptlrpc_request *req);
668 int ptlrpc_replay_req(struct ptlrpc_request *req);
669 void ptlrpc_unregister_reply(struct ptlrpc_request *req);
670 void ptlrpc_restart_req(struct ptlrpc_request *req);
671 void ptlrpc_abort_inflight(struct obd_import *imp);
672
673 struct ptlrpc_request_set *ptlrpc_prep_set(void);
674 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
675 int ptlrpc_check_set(struct ptlrpc_request_set *set);
676 int ptlrpc_set_wait(struct ptlrpc_request_set *);
677 int ptlrpc_expired_set(void *data);
678 void ptlrpc_interrupted_set(void *data);
679 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
680 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
681 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
682 void ptlrpc_set_add_new_req(struct ptlrpc_request_set *,
683                             struct ptlrpc_request *);
684
685 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
686 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
687 struct ptlrpc_request_pool *ptlrpc_init_rq_pool(int, int,
688                                                 void (*populate_pool)(struct ptlrpc_request_pool *, int));
689 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
690                                        int opcode, int count, int *lengths,
691                                        char **bufs);
692 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
693                                              __u32 version, int opcode,
694                                             int count, int *lengths, char **bufs,
695                                             struct ptlrpc_request_pool *pool);
696 void ptlrpc_free_req(struct ptlrpc_request *request);
697 void ptlrpc_req_finished(struct ptlrpc_request *request);
698 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
699 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
700 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp (struct ptlrpc_request *req,
701                                                int npages, int type, int portal);
702 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
703                                               int npages, int type, int portal);
704 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
705 void ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
706                            cfs_page_t *page, int pageoffset, int len);
707 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
708                                       struct obd_import *imp);
709 __u64 ptlrpc_next_xid(void);
710 __u64 ptlrpc_sample_next_xid(void);
711 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
712
713 /* ptlrpc/service.c */
714 void ptlrpc_save_lock (struct ptlrpc_request *req,
715                        struct lustre_handle *lock, int mode);
716 void ptlrpc_commit_replies (struct obd_device *obd);
717 void ptlrpc_schedule_difficult_reply (struct ptlrpc_reply_state *rs);
718 struct ptlrpc_service *ptlrpc_init_svc(int nbufs, int bufsize, int max_req_size,
719                                        int max_reply_size,
720                                        int req_portal, int rep_portal,
721                                        int watchdog_timeout, /* in ms */
722                                        svc_handler_t, char *name,
723                                        cfs_proc_dir_entry_t *proc_entry,
724                                        svcreq_printfn_t, 
725                                        int min_threads, int max_threads,
726                                        char *threadname);
727 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
728
729 int ptlrpc_start_threads(struct obd_device *dev, struct ptlrpc_service *svc);
730 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc);
731 int ptlrpc_unregister_service(struct ptlrpc_service *service);
732 int liblustre_check_services (void *arg);
733 void ptlrpc_daemonize(char *name);
734 int ptlrpc_service_health_check(struct ptlrpc_service *);
735
736
737 struct ptlrpc_svc_data {
738         char *name;
739         struct ptlrpc_service *svc;
740         struct ptlrpc_thread *thread;
741         struct obd_device *dev;
742 };
743
744 /* ptlrpc/import.c */
745 int ptlrpc_connect_import(struct obd_import *imp, char * new_uuid);
746 int ptlrpc_init_import(struct obd_import *imp);
747 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
748 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
749
750 /* ptlrpc/pack_generic.c */
751 int lustre_msg_swabbed(struct lustre_msg *msg);
752 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
753 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
754                         int *lens, char **bufs);
755 int lustre_pack_reply(struct ptlrpc_request *, int count, int *lens,
756                       char **bufs);
757 void lustre_shrink_reply(struct ptlrpc_request *req, int segment,
758                          unsigned int newlen, int move_data);
759 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
760 int lustre_msg_size(__u32 magic, int count, int *lengths);
761 int lustre_unpack_msg(struct lustre_msg *m, int len);
762 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
763 int lustre_msg_buflen(struct lustre_msg *m, int n);
764 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
765 int lustre_msg_bufcount(struct lustre_msg *m);
766 char *lustre_msg_string (struct lustre_msg *m, int n, int max_len);
767 void *lustre_swab_buf(struct lustre_msg *, int n, int minlen, void *swabber);
768 void *lustre_swab_reqbuf(struct ptlrpc_request *req, int n, int minlen,
769                          void *swabber);
770 void *lustre_swab_repbuf(struct ptlrpc_request *req, int n, int minlen,
771                          void *swabber);
772 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
773 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
774 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
775 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
776 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
777 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
778 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
779 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
780 __u32 lustre_msg_get_type(struct lustre_msg *msg);
781 __u32 lustre_msg_get_version(struct lustre_msg *msg);
782 void lustre_msg_add_version(struct lustre_msg *msg, int version);
783 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
784 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
785 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
786 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
787 int   lustre_msg_get_status(struct lustre_msg *msg);
788 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
789 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
790 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
791 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
792 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
793 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
794 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
795 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
796 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
797 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
798
799 static inline void
800 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
801 {
802         LASSERT(atomic_read(&rs->rs_refcount) > 0);
803         atomic_inc(&rs->rs_refcount);
804 }
805
806 static inline void
807 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
808 {
809         LASSERT(atomic_read(&rs->rs_refcount) > 0);
810         if (atomic_dec_and_test(&rs->rs_refcount))
811                 lustre_free_reply_state(rs);
812 }
813
814 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
815 {
816         return lustre_msg_get_magic(req->rq_reqmsg);
817 }
818
819 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
820 {
821         switch (req->rq_reqmsg->lm_magic) {
822         case LUSTRE_MSG_MAGIC_V1:
823                 CERROR("function not supported for lustre_msg V1!\n");
824                 return -ENOTSUPP;
825         case LUSTRE_MSG_MAGIC_V2:
826                 return req->rq_reqmsg->lm_repsize;
827         default:
828                 LASSERTF(0, "incorrect message magic: %08x\n",
829                          req->rq_reqmsg->lm_magic);
830                 return -EFAULT;
831         }
832 }
833
834 static inline void
835 ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, int *lens)
836 {
837         req->rq_replen = lustre_msg_size(req->rq_reqmsg->lm_magic, count, lens);
838         if (req->rq_reqmsg->lm_magic == LUSTRE_MSG_MAGIC_V2)
839                 req->rq_reqmsg->lm_repsize = req->rq_replen;
840 }
841
842 /* ldlm/ldlm_lib.c */
843 int client_obd_setup(struct obd_device *obddev, obd_count len, void *buf);
844 int client_obd_cleanup(struct obd_device * obddev);
845 int client_connect_import(struct lustre_handle *conn, struct obd_device *obd,
846                           struct obd_uuid *cluuid, struct obd_connect_data *);
847 int client_disconnect_export(struct obd_export *exp);
848 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
849                            int priority);
850 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
851 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
852
853 /* ptlrpc/pinger.c */
854 int ptlrpc_pinger_add_import(struct obd_import *imp);
855 int ptlrpc_pinger_del_import(struct obd_import *imp);
856 #ifdef __KERNEL__
857 void ping_evictor_start(void);
858 void ping_evictor_stop(void);
859 #else
860 #define ping_evictor_start()    do {} while (0)
861 #define ping_evictor_stop()     do {} while (0)
862 #endif
863
864 /* ptlrpc/ptlrpcd.c */
865 void ptlrpcd_wake(struct ptlrpc_request *req);
866 void ptlrpcd_add_req(struct ptlrpc_request *req);
867 int ptlrpcd_addref(void);
868 void ptlrpcd_decref(void);
869
870 /* ptlrpc/lproc_ptlrpc.c */
871 #ifdef LPROCFS
872 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
873 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
874 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int opc, int bytes);
875 #else
876 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
877 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
878 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int opc,
879                                       int bytes) {}
880 #endif
881
882 /* ptlrpc/llog_server.c */
883 int llog_origin_handle_create(struct ptlrpc_request *req);
884 int llog_origin_handle_destroy(struct ptlrpc_request *req);
885 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
886 int llog_origin_handle_next_block(struct ptlrpc_request *req);
887 int llog_origin_handle_read_header(struct ptlrpc_request *req);
888 int llog_origin_handle_close(struct ptlrpc_request *req);
889 int llog_origin_handle_cancel(struct ptlrpc_request *req);
890 int llog_catinfo(struct ptlrpc_request *req);
891
892 /* ptlrpc/llog_client.c */
893 extern struct llog_operations llog_client_ops;
894
895 #endif