Whamcloud - gitweb
9d7f95be5aa5c6ee974913f831ffedabeaa770ec
[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  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef _LUSTRE_NET_H
38 #define _LUSTRE_NET_H
39
40 #if defined(__linux__)
41 #include <linux/lustre_net.h>
42 #elif defined(__APPLE__)
43 #include <darwin/lustre_net.h>
44 #elif defined(__WINNT__)
45 #include <winnt/lustre_net.h>
46 #else
47 #error Unsupported operating system.
48 #endif
49
50 #include <libcfs/libcfs.h>
51 // #include <obd.h>
52 #include <lnet/lnet.h>
53 #include <lustre/lustre_idl.h>
54 #include <lustre_ha.h>
55 #include <lustre_sec.h>
56 #include <lustre_import.h>
57 #include <lprocfs_status.h>
58 #include <lu_object.h>
59 #include <lustre_req_layout.h>
60
61 #include <obd_support.h>
62
63 /* MD flags we _always_ use */
64 #define PTLRPC_MD_OPTIONS  0
65
66 /* Define maxima for bulk I/O
67  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
68  * these limits are system wide and not interface-local. */
69 #define PTLRPC_MAX_BRW_BITS     LNET_MTU_BITS
70 #define PTLRPC_MAX_BRW_SIZE     (1<<LNET_MTU_BITS)
71 #define PTLRPC_MAX_BRW_PAGES    (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
72
73 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
74 #ifdef __KERNEL__
75 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
76 #  error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
77 # endif
78 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
79 #  error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
80 # endif
81 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU)
82 #  error "PTLRPC_MAX_BRW_SIZE too big"
83 # endif
84 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV)
85 #  error "PTLRPC_MAX_BRW_PAGES too big"
86 # endif
87 #endif /* __KERNEL__ */
88
89 /* Size over which to OBD_VMALLOC() rather than OBD_ALLOC() service request
90  * buffers */
91 #define SVC_BUF_VMALLOC_THRESHOLD (2 * CFS_PAGE_SIZE)
92
93 /* The following constants determine how memory is used to buffer incoming
94  * service requests.
95  *
96  * ?_NBUFS              # buffers to allocate when growing the pool
97  * ?_BUFSIZE            # bytes in a single request buffer
98  * ?_MAXREQSIZE         # maximum request service will receive
99  *
100  * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
101  * of ?_NBUFS is added to the pool.
102  *
103  * Messages larger than ?_MAXREQSIZE are dropped.  Request buffers are
104  * considered full when less than ?_MAXREQSIZE is left in them.
105  */
106
107 #define LDLM_THREADS_AUTO_MIN                                                 \
108         min((int)(num_online_cpus() * num_online_cpus() * 2), 8)
109 #define LDLM_THREADS_AUTO_MAX (LDLM_THREADS_AUTO_MIN * 16)
110 #define LDLM_BL_THREADS  LDLM_THREADS_AUTO_MIN
111 #define LDLM_NBUFS      (64 * num_online_cpus())
112 #define LDLM_BUFSIZE    (8 * 1024)
113 #define LDLM_MAXREQSIZE (5 * 1024)
114 #define LDLM_MAXREPSIZE (1024)
115
116 #define MDT_MIN_THREADS 2UL
117 #define MDT_MAX_THREADS 512UL
118 #define MDT_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
119                                   num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
120 #define FLD_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
121                                   num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
122 #define SEQ_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
123                                   num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
124
125 /* Absolute limits */
126 #define MDS_THREADS_MIN 2
127 #define MDS_THREADS_MAX 512
128 #define MDS_THREADS_MIN_READPAGE 2
129 #define MDS_NBUFS       (64 * num_online_cpus())
130 #define MDS_BUFSIZE     (8 * 1024)
131 /* Assume file name length = FNAME_MAX = 256 (true for ext3).
132  *        path name length = PATH_MAX = 4096
133  *        LOV MD size max  = EA_MAX = 4000
134  * symlink:  FNAME_MAX + PATH_MAX  <- largest
135  * link:     FNAME_MAX + PATH_MAX  (mds_rec_link < mds_rec_create)
136  * rename:   FNAME_MAX + FNAME_MAX
137  * open:     FNAME_MAX + EA_MAX
138  *
139  * MDS_MAXREQSIZE ~= 4736 bytes =
140  * lustre_msg + ldlm_request + mds_body + mds_rec_create + FNAME_MAX + PATH_MAX
141  * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
142  * or, for mds_close() and mds_reint_unlink() on a many-OST filesystem:
143  *      = 9210 bytes = lustre_msg + mds_body + 160 * (easize + cookiesize)
144  *
145  * Realistic size is about 512 bytes (20 character name + 128 char symlink),
146  * except in the open case where there are a large number of OSTs in a LOV.
147  */
148 #define MDS_MAXREQSIZE  (5 * 1024)
149 #define MDS_MAXREPSIZE  max(9 * 1024, 280 + LOV_MAX_STRIPE_COUNT * 56)
150
151 /* FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + md_fld */
152 #define FLD_MAXREQSIZE  (160)
153
154 /* FLD_MAXREPSIZE == lustre_msg + ptlrpc_body + md_fld */
155 #define FLD_MAXREPSIZE  (152)
156
157 /* SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
158  * __u32 padding */
159 #define SEQ_MAXREQSIZE  (160)
160
161 /* SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
162 #define SEQ_MAXREPSIZE  (152)
163
164 #define MGS_THREADS_AUTO_MIN 2
165 #define MGS_THREADS_AUTO_MAX 32
166 #define MGS_NBUFS       (64 * num_online_cpus())
167 #define MGS_BUFSIZE     (8 * 1024)
168 #define MGS_MAXREQSIZE  (7 * 1024)
169 #define MGS_MAXREPSIZE  (9 * 1024)
170
171 /* Absolute limits */
172 #define OSS_THREADS_MIN 2
173 #define OSS_THREADS_MAX 512
174 #define OST_NBUFS       (64 * num_online_cpus())
175 #define OST_BUFSIZE     (8 * 1024)
176 /* OST_MAXREQSIZE ~= 4768 bytes =
177  * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote
178  *
179  * - single object with 16 pages is 512 bytes
180  * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
181  */
182 #define OST_MAXREQSIZE  (5 * 1024)
183 #define OST_MAXREPSIZE  (9 * 1024)
184
185 /* Macro to hide a typecast. */
186 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
187
188 struct ptlrpc_connection {
189         struct hlist_node       c_hash;
190         lnet_nid_t              c_self;
191         lnet_process_id_t       c_peer;
192         struct obd_uuid         c_remote_uuid;
193         atomic_t                c_refcount;
194 };
195
196 struct ptlrpc_client {
197         __u32                   cli_request_portal;
198         __u32                   cli_reply_portal;
199         char                   *cli_name;
200 };
201
202 /* state flags of requests */
203 /* XXX only ones left are those used by the bulk descs as well! */
204 #define PTL_RPC_FL_INTR      (1 << 0)  /* reply wait was interrupted by user */
205 #define PTL_RPC_FL_TIMEOUT   (1 << 7)  /* request timed out waiting for reply */
206
207 #define REQ_MAX_ACK_LOCKS 8
208
209 union ptlrpc_async_args {
210         /* Scratchpad for passing args to completion interpreter. Users
211          * cast to the struct of their choosing, and LASSERT that this is
212          * big enough.  For _tons_ of context, OBD_ALLOC a struct and store
213          * a pointer to it here.  The pointer_arg ensures this struct is at
214          * least big enough for that. */
215         void      *pointer_arg[11];
216         __u64      space[6];
217 };
218
219 struct ptlrpc_request_set;
220 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
221
222 struct ptlrpc_request_set {
223         int               set_remaining; /* # uncompleted requests */
224         cfs_waitq_t       set_waitq;
225         cfs_waitq_t      *set_wakeup_ptr;
226         struct list_head  set_requests;
227         struct list_head  set_cblist; /* list of completion callbacks */
228         set_interpreter_func    set_interpret; /* completion callback */
229         void              *set_arg; /* completion context */
230         /* locked so that any old caller can communicate requests to
231          * the set holder who can then fold them into the lock-free set */
232         spinlock_t        set_new_req_lock;
233         struct list_head  set_new_requests;
234 };
235
236 struct ptlrpc_set_cbdata {
237         struct list_head        psc_item;
238         set_interpreter_func    psc_interpret;
239         void                   *psc_data;
240 };
241
242 struct ptlrpc_bulk_desc;
243
244 /*
245  * ptlrpc callback & work item stuff
246  */
247 struct ptlrpc_cb_id {
248         void   (*cbid_fn)(lnet_event_t *ev);     /* specific callback fn */
249         void    *cbid_arg;                      /* additional arg */
250 };
251
252 #define RS_MAX_LOCKS 8
253 #define RS_DEBUG     1
254
255 struct ptlrpc_reply_state {
256         struct ptlrpc_cb_id    rs_cb_id;
257         struct list_head       rs_list;
258         struct list_head       rs_exp_list;
259         struct list_head       rs_obd_list;
260 #if RS_DEBUG
261         struct list_head       rs_debug_list;
262 #endif
263         /* updates to following flag serialised by srv_request_lock */
264         unsigned long          rs_difficult:1;     /* ACK/commit stuff */
265         unsigned long          rs_no_ack:1;    /* no ACK, even for
266                                                   difficult requests */
267         unsigned long          rs_scheduled:1;     /* being handled? */
268         unsigned long          rs_scheduled_ever:1;/* any schedule attempts? */
269         unsigned long          rs_handled:1;  /* been handled yet? */
270         unsigned long          rs_on_net:1;   /* reply_out_callback pending? */
271         unsigned long          rs_prealloc:1; /* rs from prealloc list */
272
273         int                    rs_size;
274         __u64                  rs_transno;
275         __u64                  rs_xid;
276         struct obd_export     *rs_export;
277         struct ptlrpc_service *rs_service;
278         lnet_handle_md_t       rs_md_h;
279         atomic_t               rs_refcount;
280
281         struct ptlrpc_svc_ctx *rs_svc_ctx;
282         struct lustre_msg     *rs_repbuf;       /* wrapper */
283         int                    rs_repbuf_len;   /* wrapper buf length */
284         int                    rs_repdata_len;  /* wrapper msg length */
285         struct lustre_msg     *rs_msg;          /* reply message */
286
287         /* locks awaiting client reply ACK */
288         int                    rs_nlocks;
289         struct lustre_handle   rs_locks[RS_MAX_LOCKS];
290         ldlm_mode_t            rs_modes[RS_MAX_LOCKS];
291 };
292
293 struct ptlrpc_thread;
294
295 enum rq_phase {
296         RQ_PHASE_NEW            = 0xebc0de00,
297         RQ_PHASE_RPC            = 0xebc0de01,
298         RQ_PHASE_BULK           = 0xebc0de02,
299         RQ_PHASE_INTERPRET      = 0xebc0de03,
300         RQ_PHASE_COMPLETE       = 0xebc0de04,
301         RQ_PHASE_UNREGISTERING  = 0xebc0de05,
302         RQ_PHASE_UNDEFINED      = 0xebc0de06
303 };
304
305 /** Type of request interpreter call-back */
306 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
307                                     struct ptlrpc_request *req,
308                                     void *arg, int rc);
309
310 struct ptlrpc_request_pool {
311         spinlock_t prp_lock;
312         struct list_head prp_req_list;    /* list of ptlrpc_request structs */
313         int prp_rq_size;
314         void (*prp_populate)(struct ptlrpc_request_pool *, int);
315 };
316
317 struct lu_context;
318 struct lu_env;
319
320 /**
321  * Represents remote procedure call.
322  */
323 struct ptlrpc_request {
324         int rq_type; /* one of PTL_RPC_MSG_* */
325         struct list_head rq_list;
326         struct list_head rq_timed_list;         /* server-side early replies */
327         struct list_head rq_history_list;       /* server-side history */
328         __u64            rq_history_seq;        /* history sequence # */
329         int rq_status;
330         spinlock_t rq_lock;
331         /* client-side flags are serialized by rq_lock */
332         unsigned long rq_intr:1, rq_replied:1, rq_err:1,
333                 rq_timedout:1, rq_resend:1, rq_restart:1,
334                 /*
335                  * when ->rq_replay is set, request is kept by the client even
336                  * after server commits corresponding transaction. This is
337                  * used for operations that require sequence of multiple
338                  * requests to be replayed. The only example currently is file
339                  * open/close/dw/setattr. When last request in such a sequence
340                  * is committed, ->rq_replay is cleared on all requests in the
341                  * sequence.
342                  */
343                 rq_replay:1,
344                 /* this is the last request in the sequence. */
345                 rq_sequence:1,
346                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
347                 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
348                 rq_early:1, rq_must_unlink:1,
349                 /* server-side flags */
350                 rq_packed_final:1,  /* packed final reply */
351                 rq_sent_final:1;    /* stop sending early replies */
352
353         enum rq_phase rq_phase; /* one of RQ_PHASE_* */
354         enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
355         atomic_t rq_refcount;   /* client-side refcount for SENT race,
356                                    server-side refcounf for multiple replies */
357
358         struct ptlrpc_thread *rq_svc_thread; /* initial thread servicing req */
359
360         int rq_request_portal;  /* XXX FIXME bug 249 */
361         int rq_reply_portal;    /* XXX FIXME bug 249 */
362
363         int rq_nob_received; /* client-side # reply bytes actually received  */
364
365         int rq_reqlen;
366         struct lustre_msg *rq_reqmsg;
367
368         int rq_replen;
369         struct lustre_msg *rq_repmsg;
370         __u64 rq_transno;
371         __u64 rq_xid;
372         struct list_head rq_replay_list;
373         struct list_head rq_mod_list;
374
375         struct ptlrpc_cli_ctx   *rq_cli_ctx;     /* client's half ctx */
376         struct ptlrpc_svc_ctx   *rq_svc_ctx;     /* server's half ctx */
377         struct list_head         rq_ctx_chain;   /* link to waited ctx */
378
379         struct sptlrpc_flavor    rq_flvr;        /* client & server */
380         enum lustre_sec_part     rq_sp_from;
381
382         unsigned long            /* client/server security flags */
383                                  rq_ctx_init:1,      /* context initiation */
384                                  rq_ctx_fini:1,      /* context destroy */
385                                  rq_bulk_read:1,     /* request bulk read */
386                                  rq_bulk_write:1,    /* request bulk write */
387                                  /* server authentication flags */
388                                  rq_auth_gss:1,      /* authenticated by gss */
389                                  rq_auth_remote:1,   /* authed as remote user */
390                                  rq_auth_usr_root:1, /* authed as root */
391                                  rq_auth_usr_mdt:1,  /* authed as mdt */
392                                  /* security tfm flags */
393                                  rq_pack_udesc:1,
394                                  rq_pack_bulk:1,
395                                  /* doesn't expect reply FIXME */
396                                  rq_no_reply:1;
397
398         uid_t                    rq_auth_uid;        /* authed uid */
399         uid_t                    rq_auth_mapped_uid; /* authed uid mapped to */
400
401         /* (server side), pointed directly into req buffer */
402         struct ptlrpc_user_desc *rq_user_desc;
403
404         /* early replies go to offset 0, regular replies go after that */
405         unsigned int             rq_reply_off;
406
407         /* various buffer pointers */
408         struct lustre_msg       *rq_reqbuf;      /* req wrapper */
409         int                      rq_reqbuf_len;  /* req wrapper buf len */
410         int                      rq_reqdata_len; /* req wrapper msg len */
411         char                    *rq_repbuf;      /* rep buffer */
412         int                      rq_repbuf_len;  /* rep buffer len */
413         struct lustre_msg       *rq_repdata;     /* rep wrapper msg */
414         int                      rq_repdata_len; /* rep wrapper msg len */
415         struct lustre_msg       *rq_clrbuf;      /* only in priv mode */
416         int                      rq_clrbuf_len;  /* only in priv mode */
417         int                      rq_clrdata_len; /* only in priv mode */
418
419         __u32 rq_req_swab_mask;
420         __u32 rq_rep_swab_mask;
421
422         int rq_import_generation;
423         enum lustre_imp_state rq_send_state;
424
425         int rq_early_count;           /* how many early replies (for stats) */
426
427         /* client+server request */
428         lnet_handle_md_t     rq_req_md_h;
429         struct ptlrpc_cb_id  rq_req_cbid;
430
431         /* server-side... */
432         struct timeval       rq_arrival_time;       /* request arrival time */
433         struct ptlrpc_reply_state *rq_reply_state;  /* separated reply state */
434         struct ptlrpc_request_buffer_desc *rq_rqbd; /* incoming request buffer*/
435 #ifdef CRAY_XT3
436         __u32                rq_uid;            /* peer uid, used in MDS only */
437 #endif
438
439         /* client-only incoming reply */
440         lnet_handle_md_t     rq_reply_md_h;
441         cfs_waitq_t          rq_reply_waitq;
442         struct ptlrpc_cb_id  rq_reply_cbid;
443
444         lnet_nid_t           rq_self;
445         lnet_process_id_t    rq_peer;
446         struct obd_export   *rq_export;
447         struct obd_import   *rq_import;
448
449         void (*rq_replay_cb)(struct ptlrpc_request *);
450         void (*rq_commit_cb)(struct ptlrpc_request *);
451         void  *rq_cb_data;
452
453         struct ptlrpc_bulk_desc *rq_bulk;/* client side bulk */
454
455         /* client outgoing req */
456         time_t rq_sent;                  /* when request/reply sent (secs), or
457                                           * time when request should be sent */
458
459         volatile time_t rq_deadline;     /* when request must finish. volatile
460                so that servers' early reply updates to the deadline aren't
461                kept in per-cpu cache */
462         time_t rq_reply_deadline;        /* when req reply unlink must finish. */
463         int    rq_timeout;               /* service time estimate (secs) */
464
465         /* Multi-rpc bits */
466         struct list_head rq_set_chain;
467         struct ptlrpc_request_set *rq_set;
468         /** Async completion handler */
469         ptlrpc_interpterer_t rq_interpret_reply;
470         union ptlrpc_async_args rq_async_args;  /* Async completion context */
471         struct ptlrpc_request_pool *rq_pool;    /* Pool if request from
472                                                    preallocated list */
473         struct lu_context           rq_session;
474
475         /* request format */
476         struct req_capsule          rq_pill;
477 };
478
479 static inline void ptlrpc_close_replay_seq(struct ptlrpc_request *req)
480 {
481         spin_lock(&req->rq_lock);
482         req->rq_replay = 0;
483         req->rq_sequence = 1;
484         spin_unlock(&req->rq_lock);
485 }
486
487 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
488 {
489         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
490         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
491         req->rq_req_swab_mask |= 1 << index;
492 }
493
494 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
495 {
496         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
497         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
498         req->rq_rep_swab_mask |= 1 << index;
499 }
500
501 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
502 {
503         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
504         return req->rq_req_swab_mask & (1 << index);
505 }
506
507 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
508 {
509         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
510         return req->rq_rep_swab_mask & (1 << index);
511 }
512
513 static inline const char *
514 ptlrpc_phase2str(enum rq_phase phase)
515 {
516         switch (phase) {
517         case RQ_PHASE_NEW:
518                 return "New";
519         case RQ_PHASE_RPC:
520                 return "Rpc";
521         case RQ_PHASE_BULK:
522                 return "Bulk";
523         case RQ_PHASE_INTERPRET:
524                 return "Interpret";
525         case RQ_PHASE_COMPLETE:
526                 return "Complete";
527         case RQ_PHASE_UNREGISTERING:
528                 return "Unregistering";
529         default:
530                 return "?Phase?";
531         }
532 }
533
534 static inline const char *
535 ptlrpc_rqphase2str(struct ptlrpc_request *req)
536 {
537         return ptlrpc_phase2str(req->rq_phase);
538 }
539
540 /* Spare the preprocessor, spoil the bugs. */
541 #define FLAG(field, str) (field ? str : "")
542
543 #define DEBUG_REQ_FLAGS(req)                                                    \
544         ptlrpc_rqphase2str(req),                                                \
545         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                    \
546         FLAG(req->rq_err, "E"),                                                 \
547         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),   \
548         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                  \
549         FLAG(req->rq_no_resend, "N"),                                           \
550         FLAG(req->rq_waiting, "W"),                                             \
551         FLAG(req->rq_wait_ctx, "C")
552
553 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s"
554
555 void _debug_req(struct ptlrpc_request *req, __u32 mask,
556                 struct libcfs_debug_msg_data *data, const char *fmt, ...)
557         __attribute__ ((format (printf, 4, 5)));
558
559 #define debug_req(cdls, level, req, file, func, line, fmt, a...)              \
560 do {                                                                          \
561         CHECK_STACK();                                                        \
562                                                                               \
563         if (((level) & D_CANTMASK) != 0 ||                                    \
564             ((libcfs_debug & (level)) != 0 &&                                 \
565              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {              \
566                 static struct libcfs_debug_msg_data _req_dbg_data =           \
567                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM, file, func, line); \
568                 _debug_req((req), (level), &_req_dbg_data, fmt, ##a);         \
569         }                                                                     \
570 } while(0)
571
572 /* for most callers (level is a constant) this is resolved at compile time */
573 #define DEBUG_REQ(level, req, fmt, args...)                                   \
574 do {                                                                          \
575         if ((level) & (D_ERROR | D_WARNING)) {                                \
576                 static cfs_debug_limit_state_t cdls;                          \
577                 debug_req(&cdls, level, req, __FILE__, __func__, __LINE__,    \
578                           "@@@ "fmt" ", ## args);                             \
579         } else                                                                \
580                 debug_req(NULL, level, req, __FILE__, __func__, __LINE__,     \
581                           "@@@ "fmt" ", ## args);                             \
582 } while (0)
583
584 struct ptlrpc_bulk_page {
585         struct list_head bp_link;
586         int              bp_buflen;
587         int              bp_pageoffset; /* offset within a page */
588         struct page     *bp_page;
589 };
590
591 #define BULK_GET_SOURCE   0
592 #define BULK_PUT_SINK     1
593 #define BULK_GET_SINK     2
594 #define BULK_PUT_SOURCE   3
595
596 struct ptlrpc_bulk_desc {
597         unsigned long bd_success:1;              /* completed successfully */
598         unsigned long bd_network_rw:1;           /* accessible to the network */
599         unsigned long bd_type:2;                 /* {put,get}{source,sink} */
600         unsigned long bd_registered:1;           /* client side */
601         spinlock_t   bd_lock;                   /* serialise with callback */
602         int bd_import_generation;
603         struct obd_export *bd_export;
604         struct obd_import *bd_import;
605         __u32 bd_portal;
606         struct ptlrpc_request *bd_req;          /* associated request */
607         cfs_waitq_t            bd_waitq;        /* server side only WQ */
608         int                    bd_iov_count;    /* # entries in bd_iov */
609         int                    bd_max_iov;      /* allocated size of bd_iov */
610         int                    bd_nob;          /* # bytes covered */
611         int                    bd_nob_transferred; /* # bytes GOT/PUT */
612
613         __u64                  bd_last_xid;
614
615         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
616         lnet_handle_md_t       bd_md_h;         /* associated MD */
617         lnet_nid_t             bd_sender;       /* stash event::sender */
618
619         cfs_page_t           **bd_enc_pages;
620 #if defined(__KERNEL__)
621         lnet_kiov_t            bd_iov[0];
622 #else
623         lnet_md_iovec_t        bd_iov[0];
624 #endif
625 };
626
627 struct ptlrpc_thread {
628         /**
629          * active threads in svc->srv_threads
630          */
631         struct list_head t_link;
632         /**
633          * thread-private data (preallocated memory)
634          */
635         void *t_data;
636         __u32 t_flags;
637         /**
638          * service thread index, from ptlrpc_start_threads
639          */
640         unsigned int t_id;
641         /**
642          * put watchdog in the structure per thread b=14840
643          */
644         struct lc_watchdog *t_watchdog;
645         cfs_waitq_t t_ctl_waitq;
646         struct lu_env *t_env;
647 };
648
649 struct ptlrpc_request_buffer_desc {
650         struct list_head       rqbd_list;
651         struct list_head       rqbd_reqs;
652         struct ptlrpc_service *rqbd_service;
653         lnet_handle_md_t       rqbd_md_h;
654         int                    rqbd_refcount;
655         char                  *rqbd_buffer;
656         struct ptlrpc_cb_id    rqbd_cbid;
657         struct ptlrpc_request  rqbd_req;
658 };
659
660 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
661 typedef void (*svcreq_printfn_t)(void *, struct ptlrpc_request *);
662
663 struct ptlrpc_service {
664         struct list_head srv_list;              /* chain thru all services */
665         int              srv_max_req_size;      /* biggest request to receive */
666         int              srv_max_reply_size;    /* biggest reply to send */
667         int              srv_buf_size;          /* size of individual buffers */
668         int              srv_nbuf_per_group;    /* # buffers to allocate in 1 group */
669         int              srv_nbufs;             /* total # req buffer descs allocated */
670         int              srv_threads_min;       /* threads to start at SOW */
671         int              srv_threads_max;       /* thread upper limit */
672         int              srv_threads_started;   /* index of last started thread */
673         int              srv_threads_running;   /* # running threads */
674         int              srv_n_difficult_replies; /* # 'difficult' replies */
675         int              srv_n_active_reqs;     /* # reqs being served */
676         cfs_duration_t   srv_rqbd_timeout;      /* timeout before re-posting reqs, in tick */
677         int              srv_watchdog_factor;   /* soft watchdog timeout mutiplier */
678         unsigned         srv_cpu_affinity:1;    /* bind threads to CPUs */
679         unsigned         srv_at_check:1;        /* check early replies */
680         unsigned         srv_is_stopping:1;     /* under unregister_service */
681         cfs_time_t       srv_at_checktime;      /* debug */
682
683         __u32            srv_req_portal;
684         __u32            srv_rep_portal;
685
686         /* AT stuff */
687         struct adaptive_timeout srv_at_estimate;/* estimated rpc service time */
688         spinlock_t        srv_at_lock;
689         struct list_head  srv_at_list;          /* reqs waiting for replies */
690         cfs_timer_t       srv_at_timer;         /* early reply timer */
691
692         int               srv_n_queued_reqs;    /* # reqs in either of the queues below */
693         struct list_head  srv_req_in_queue;     /* incoming reqs */
694         struct list_head  srv_request_queue;    /* reqs waiting for service */
695
696         struct list_head  srv_request_history;  /* request history */
697         __u64             srv_request_seq;      /* next request sequence # */
698         __u64             srv_request_max_cull_seq; /* highest seq culled from history */
699         svcreq_printfn_t  srv_request_history_print_fn; /* service-specific print fn */
700
701         struct list_head  srv_idle_rqbds;       /* request buffers to be reposted */
702         struct list_head  srv_active_rqbds;     /* req buffers receiving */
703         struct list_head  srv_history_rqbds;    /* request buffer history */
704         int               srv_nrqbd_receiving;  /* # posted request buffers */
705         int               srv_n_history_rqbds;  /* # request buffers in history */
706         int               srv_max_history_rqbds;/* max # request buffers in history */
707
708         atomic_t          srv_outstanding_replies;
709         struct list_head  srv_active_replies;   /* all the active replies */
710         struct list_head  srv_reply_queue;      /* replies waiting for service */
711
712         cfs_waitq_t       srv_waitq; /* all threads sleep on this. This
713                                       * wait-queue is signalled when new
714                                       * incoming request arrives and when
715                                       * difficult reply has to be handled. */
716
717         struct list_head   srv_threads;         /* service thread list */
718         svc_handler_t      srv_handler;
719
720         char *srv_name; /* only statically allocated strings here; we don't clean them */
721         char *srv_thread_name; /* only statically allocated strings here; we don't clean them */
722
723         spinlock_t               srv_lock;
724
725         cfs_proc_dir_entry_t    *srv_procroot;
726         struct lprocfs_stats    *srv_stats;
727
728         /* List of free reply_states */
729         struct list_head         srv_free_rs_list;
730         /* waitq to run, when adding stuff to srv_free_rs_list */
731         cfs_waitq_t              srv_free_rs_waitq;
732
733         /*
734          * Tags for lu_context associated with this thread, see struct
735          * lu_context.
736          */
737         __u32                    srv_ctx_tags;
738         /*
739          * if non-NULL called during thread creation (ptlrpc_start_thread())
740          * to initialize service specific per-thread state.
741          */
742         int (*srv_init)(struct ptlrpc_thread *thread);
743         /*
744          * if non-NULL called during thread shutdown (ptlrpc_main()) to
745          * destruct state created by ->srv_init().
746          */
747         void (*srv_done)(struct ptlrpc_thread *thread);
748
749         //struct ptlrpc_srv_ni srv_interfaces[0];
750 };
751
752 struct ptlrpcd_ctl {
753         /**
754          * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
755          */
756         unsigned long               pc_flags;
757         /**
758          * Thread lock protecting structure fields.
759          */
760         spinlock_t                  pc_lock;
761         /**
762          * Start completion.
763          */
764         struct completion           pc_starting;
765         /**
766          * Stop completion.
767          */
768         struct completion           pc_finishing;
769         /**
770          * Thread requests set.
771          */
772         struct ptlrpc_request_set  *pc_set;
773         /**
774          * Thread name used in cfs_daemonize()
775          */
776         char                        pc_name[16];
777         /**
778          * Environment for request interpreters to run in.
779          */
780         struct lu_env               pc_env;
781 #ifndef __KERNEL__
782         /**
783          * Async rpcs flag to make sure that ptlrpcd_check() is called only
784          * once.
785          */
786         int                         pc_recurred;
787         /**
788          * Currently not used.
789          */
790         void                       *pc_callback;
791         /**
792          * User-space async rpcs callback.
793          */
794         void                       *pc_wait_callback;
795         /**
796          * User-space check idle rpcs callback.
797          */
798         void                       *pc_idle_callback;
799 #endif
800 };
801
802 /* Bits for pc_flags */
803 enum ptlrpcd_ctl_flags {
804         /**
805          * Ptlrpc thread start flag.
806          */
807         LIOD_START       = 1 << 0,
808         /**
809          * Ptlrpc thread stop flag.
810          */
811         LIOD_STOP        = 1 << 1,
812         /**
813          * Ptlrpc thread force flag (only stop force so far).
814          * This will cause aborting any inflight rpcs handled
815          * by thread if LIOD_STOP is specified.
816          */
817         LIOD_FORCE       = 1 << 2,
818         /**
819          * This is a recovery ptlrpc thread.
820          */
821         LIOD_RECOVERY    = 1 << 3
822 };
823
824 /* ptlrpc/events.c */
825 extern lnet_handle_eq_t ptlrpc_eq_h;
826 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
827                                lnet_process_id_t *peer, lnet_nid_t *self);
828 extern void request_out_callback (lnet_event_t *ev);
829 extern void reply_in_callback(lnet_event_t *ev);
830 extern void client_bulk_callback (lnet_event_t *ev);
831 extern void request_in_callback(lnet_event_t *ev);
832 extern void reply_out_callback(lnet_event_t *ev);
833 extern void server_bulk_callback (lnet_event_t *ev);
834
835 /* ptlrpc/connection.c */
836 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
837                                                 lnet_nid_t self,
838                                                 struct obd_uuid *uuid);
839 int ptlrpc_connection_put(struct ptlrpc_connection *c);
840 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
841 int ptlrpc_connection_init(void);
842 void ptlrpc_connection_fini(void);
843 extern lnet_pid_t ptl_get_pid(void);
844
845 /* ptlrpc/niobuf.c */
846 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
847 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
848 int ptlrpc_register_bulk(struct ptlrpc_request *req);
849 void ptlrpc_unregister_bulk (struct ptlrpc_request *req);
850
851 static inline int ptlrpc_bulk_active (struct ptlrpc_bulk_desc *desc)
852 {
853         int           rc;
854
855         spin_lock(&desc->bd_lock);
856         rc = desc->bd_network_rw;
857         spin_unlock(&desc->bd_lock);
858         return (rc);
859 }
860
861 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
862 #define PTLRPC_REPLY_EARLY           0x02
863 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
864 int ptlrpc_reply(struct ptlrpc_request *req);
865 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
866 int ptlrpc_error(struct ptlrpc_request *req);
867 void ptlrpc_resend_req(struct ptlrpc_request *request);
868 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
869 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
870 int ptlrpc_register_rqbd (struct ptlrpc_request_buffer_desc *rqbd);
871
872 /* ptlrpc/client.c */
873 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
874                         struct ptlrpc_client *);
875 void ptlrpc_cleanup_client(struct obd_import *imp);
876 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
877
878 int ptlrpc_queue_wait(struct ptlrpc_request *req);
879 int ptlrpc_replay_req(struct ptlrpc_request *req);
880 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
881 void ptlrpc_restart_req(struct ptlrpc_request *req);
882 void ptlrpc_abort_inflight(struct obd_import *imp);
883 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
884
885 struct ptlrpc_request_set *ptlrpc_prep_set(void);
886 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
887                       set_interpreter_func fn, void *data);
888 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
889 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
890 int ptlrpc_set_wait(struct ptlrpc_request_set *);
891 int ptlrpc_expired_set(void *data);
892 void ptlrpc_interrupted_set(void *data);
893 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
894 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
895 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
896 int ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
897                            struct ptlrpc_request *req);
898
899 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
900 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
901
902 struct ptlrpc_request_pool *
903 ptlrpc_init_rq_pool(int, int,
904                     void (*populate_pool)(struct ptlrpc_request_pool *, int));
905
906 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
907 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
908                                             const struct req_format *format);
909 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
910                                             struct ptlrpc_request_pool *,
911                                             const struct req_format *format);
912 void ptlrpc_request_free(struct ptlrpc_request *request);
913 int ptlrpc_request_pack(struct ptlrpc_request *request,
914                         __u32 version, int opcode);
915 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
916                                                 const struct req_format *format,
917                                                 __u32 version, int opcode);
918 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
919                              __u32 version, int opcode, char **bufs,
920                              struct ptlrpc_cli_ctx *ctx);
921 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
922                                        int opcode, int count, __u32 *lengths,
923                                        char **bufs);
924 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
925                                              __u32 version, int opcode,
926                                             int count, __u32 *lengths, char **bufs,
927                                             struct ptlrpc_request_pool *pool);
928 void ptlrpc_req_finished(struct ptlrpc_request *request);
929 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
930 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
931 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp (struct ptlrpc_request *req,
932                                                int npages, int type, int portal);
933 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
934                                               int npages, int type, int portal);
935 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
936 void ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
937                            cfs_page_t *page, int pageoffset, int len);
938 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
939                                       struct obd_import *imp);
940 __u64 ptlrpc_next_xid(void);
941 __u64 ptlrpc_sample_next_xid(void);
942 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
943
944 struct ptlrpc_service_conf {
945         int psc_nbufs;
946         int psc_bufsize;
947         int psc_max_req_size;
948         int psc_max_reply_size;
949         int psc_req_portal;
950         int psc_rep_portal;
951         int psc_watchdog_factor;
952         int psc_min_threads;
953         int psc_max_threads;
954         __u32 psc_ctx_tags;
955 };
956
957 /* ptlrpc/service.c */
958 void ptlrpc_save_lock (struct ptlrpc_request *req,
959                        struct lustre_handle *lock, int mode, int no_ack);
960 void ptlrpc_commit_replies (struct obd_device *obd);
961 void ptlrpc_schedule_difficult_reply (struct ptlrpc_reply_state *rs);
962 struct ptlrpc_service *ptlrpc_init_svc_conf(struct ptlrpc_service_conf *c,
963                                             svc_handler_t h, char *name,
964                                             struct proc_dir_entry *proc_entry,
965                                             svcreq_printfn_t prntfn,
966                                             char *threadname);
967
968 struct ptlrpc_service *ptlrpc_init_svc(int nbufs, int bufsize, int max_req_size,
969                                        int max_reply_size,
970                                        int req_portal, int rep_portal,
971                                        int watchdog_factor,
972                                        svc_handler_t, char *name,
973                                        cfs_proc_dir_entry_t *proc_entry,
974                                        svcreq_printfn_t,
975                                        int min_threads, int max_threads,
976                                        char *threadname, __u32 ctx_tags);
977 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
978
979 int ptlrpc_start_threads(struct obd_device *dev, struct ptlrpc_service *svc);
980 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc);
981 int ptlrpc_unregister_service(struct ptlrpc_service *service);
982 int liblustre_check_services (void *arg);
983 void ptlrpc_daemonize(char *name);
984 int ptlrpc_service_health_check(struct ptlrpc_service *);
985
986
987 struct ptlrpc_svc_data {
988         char *name;
989         struct ptlrpc_service *svc;
990         struct ptlrpc_thread *thread;
991         struct obd_device *dev;
992 };
993
994 /* ptlrpc/import.c */
995 int ptlrpc_connect_import(struct obd_import *imp, char * new_uuid);
996 int ptlrpc_init_import(struct obd_import *imp);
997 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
998 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
999
1000 /* ptlrpc/pack_generic.c */
1001 int ptlrpc_reconnect_import(struct obd_import *imp);
1002 int lustre_msg_swabbed(struct lustre_msg *msg);
1003 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
1004 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
1005                         char **bufs);
1006 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
1007                         __u32 *lens, char **bufs);
1008 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
1009                       char **bufs);
1010 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
1011                          __u32 *lens, char **bufs, int flags);
1012 #define LPRFL_EARLY_REPLY 1
1013 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
1014                             char **bufs, int flags);
1015 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
1016                       unsigned int newlen, int move_data);
1017 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
1018 int lustre_msg_hdr_size(__u32 magic, int count);
1019 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
1020 int lustre_msg_size_v2(int count, __u32 *lengths);
1021 int lustre_packed_msg_size(struct lustre_msg *msg);
1022 int lustre_msg_early_size(void);
1023 int lustre_unpack_msg(struct lustre_msg *m, int len);
1024 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
1025 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
1026 int lustre_msg_buflen(struct lustre_msg *m, int n);
1027 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
1028 int lustre_msg_bufcount(struct lustre_msg *m);
1029 char *lustre_msg_string (struct lustre_msg *m, int n, int max_len);
1030 void *lustre_swab_buf(struct lustre_msg *, int n, int minlen, void *swabber);
1031 void *lustre_swab_reqbuf(struct ptlrpc_request *req, int n, int minlen,
1032                          void *swabber);
1033 void *lustre_swab_repbuf(struct ptlrpc_request *req, int n, int minlen,
1034                          void *swabber);
1035 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
1036 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
1037 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
1038 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
1039 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
1040 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
1041 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
1042 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
1043 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
1044 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
1045 __u32 lustre_msg_get_type(struct lustre_msg *msg);
1046 __u32 lustre_msg_get_version(struct lustre_msg *msg);
1047 void lustre_msg_add_version(struct lustre_msg *msg, int version);
1048 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
1049 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
1050 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
1051 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
1052 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
1053 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
1054 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
1055 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
1056 int lustre_msg_get_status(struct lustre_msg *msg);
1057 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
1058 int lustre_msg_is_v1(struct lustre_msg *msg);
1059 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
1060 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
1061 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
1062 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
1063 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
1064 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
1065 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
1066 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
1067 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
1068 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
1069 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
1070 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
1071 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
1072 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
1073 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
1074 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
1075 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
1076 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
1077
1078 static inline void
1079 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
1080                     unsigned int newlen, int move_data)
1081 {
1082         LASSERT(req->rq_reply_state);
1083         LASSERT(req->rq_repmsg);
1084         req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
1085                                            newlen, move_data);
1086 }
1087
1088 static inline void
1089 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
1090 {
1091         if (req->rq_phase == new_phase)
1092                 return;
1093         
1094         if (new_phase == RQ_PHASE_UNREGISTERING) {
1095                 req->rq_next_phase = req->rq_phase;
1096                 if (req->rq_import)
1097                         atomic_inc(&req->rq_import->imp_unregistering);
1098         }
1099         
1100         if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
1101                 if (req->rq_import)
1102                         atomic_dec(&req->rq_import->imp_unregistering);
1103         }
1104
1105         DEBUG_REQ(D_RPCTRACE, req, "move req \"%s\" -> \"%s\"", 
1106                   ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
1107
1108         req->rq_phase = new_phase;
1109 }
1110
1111 static inline int
1112 ptlrpc_client_early(struct ptlrpc_request *req)
1113 {
1114         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_UNLINK) &&
1115             req->rq_reply_deadline > cfs_time_current_sec())
1116                 return 0;
1117         return req->rq_early;
1118 }
1119
1120 static inline int
1121 ptlrpc_client_replied(struct ptlrpc_request *req)
1122 {
1123         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_UNLINK) &&
1124             req->rq_reply_deadline > cfs_time_current_sec())
1125                 return 0;
1126         return req->rq_replied;
1127 }
1128
1129 static inline int
1130 ptlrpc_client_recv(struct ptlrpc_request *req)
1131 {
1132         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_UNLINK) &&
1133             req->rq_reply_deadline > cfs_time_current_sec())
1134                 return 1;
1135         return req->rq_receiving_reply;
1136 }
1137
1138 static inline int
1139 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
1140 {
1141         int rc;
1142
1143         spin_lock(&req->rq_lock);
1144         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_UNLINK) &&
1145             req->rq_reply_deadline > cfs_time_current_sec()) {
1146                 spin_unlock(&req->rq_lock);
1147                 return 1;
1148         }
1149         rc = req->rq_receiving_reply || req->rq_must_unlink;
1150         spin_unlock(&req->rq_lock);
1151         return rc;
1152 }
1153
1154 static inline void
1155 ptlrpc_client_wake_req(struct ptlrpc_request *req)
1156 {
1157         if (req->rq_set == NULL)
1158                 cfs_waitq_signal(&req->rq_reply_waitq);
1159         else
1160                 cfs_waitq_signal(&req->rq_set->set_waitq);
1161 }
1162
1163 static inline void
1164 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
1165 {
1166         LASSERT(atomic_read(&rs->rs_refcount) > 0);
1167         atomic_inc(&rs->rs_refcount);
1168 }
1169
1170 static inline void
1171 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
1172 {
1173         LASSERT(atomic_read(&rs->rs_refcount) > 0);
1174         if (atomic_dec_and_test(&rs->rs_refcount))
1175                 lustre_free_reply_state(rs);
1176 }
1177
1178 /* Should only be called once per req */
1179 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
1180 {
1181         if (req->rq_reply_state == NULL)
1182                 return; /* shouldn't occur */
1183         ptlrpc_rs_decref(req->rq_reply_state);
1184         req->rq_reply_state = NULL;
1185         req->rq_repmsg = NULL;
1186 }
1187
1188 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
1189 {
1190         return lustre_msg_get_magic(req->rq_reqmsg);
1191 }
1192
1193 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
1194 {
1195         switch (req->rq_reqmsg->lm_magic) {
1196         case LUSTRE_MSG_MAGIC_V2:
1197                 return req->rq_reqmsg->lm_repsize;
1198         default:
1199                 LASSERTF(0, "incorrect message magic: %08x\n",
1200                          req->rq_reqmsg->lm_magic);
1201                 return -EFAULT;
1202         }
1203 }
1204
1205 /* ldlm/ldlm_lib.c */
1206 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
1207 int client_obd_cleanup(struct obd_device *obddev);
1208 int client_connect_import(const struct lu_env *env,
1209                           struct lustre_handle *conn, struct obd_device *obd,
1210                           struct obd_uuid *cluuid, struct obd_connect_data *,
1211                           void *localdata);
1212 int client_disconnect_export(struct obd_export *exp);
1213 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
1214                            int priority);
1215 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
1216 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
1217
1218 /* ptlrpc/pinger.c */
1219 int ptlrpc_pinger_add_import(struct obd_import *imp);
1220 int ptlrpc_pinger_del_import(struct obd_import *imp);
1221 cfs_time_t ptlrpc_suspend_wakeup_time(void);
1222 #ifdef __KERNEL__
1223 void ping_evictor_start(void);
1224 void ping_evictor_stop(void);
1225 #else
1226 #define ping_evictor_start()    do {} while (0)
1227 #define ping_evictor_stop()     do {} while (0)
1228 #endif
1229 int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req);
1230
1231 /* ptlrpc/ptlrpcd.c */
1232
1233 /**
1234  * Ptlrpcd scope is a set of two threads: ptlrpcd-foo and ptlrpcd-foo-rcv,
1235  * these threads are used to asynchronously send requests queued with
1236  * ptlrpcd_add_req(req, PCSOPE_FOO), and to handle completion call-backs for
1237  * such requests. Multiple scopes are needed to avoid dead-locks.
1238  */
1239 enum ptlrpcd_scope {
1240         /** Scope of bulk read-write rpcs. */
1241         PSCOPE_BRW,
1242         /** Everything else. */
1243         PSCOPE_OTHER,
1244         PSCOPE_NR
1245 };
1246
1247 int ptlrpcd_start(const char *name, struct ptlrpcd_ctl *pc);
1248 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
1249 void ptlrpcd_wake(struct ptlrpc_request *req);
1250 void ptlrpcd_add_req(struct ptlrpc_request *req, enum ptlrpcd_scope scope);
1251 int ptlrpcd_addref(void);
1252 void ptlrpcd_decref(void);
1253
1254 /* ptlrpc/lproc_ptlrpc.c */
1255 const char* ll_opcode2str(__u32 opcode);
1256 #ifdef LPROCFS
1257 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
1258 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
1259 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
1260 #else
1261 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
1262 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
1263 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
1264 #endif
1265
1266 /* ptlrpc/llog_server.c */
1267 int llog_origin_handle_create(struct ptlrpc_request *req);
1268 int llog_origin_handle_destroy(struct ptlrpc_request *req);
1269 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
1270 int llog_origin_handle_next_block(struct ptlrpc_request *req);
1271 int llog_origin_handle_read_header(struct ptlrpc_request *req);
1272 int llog_origin_handle_close(struct ptlrpc_request *req);
1273 int llog_origin_handle_cancel(struct ptlrpc_request *req);
1274 int llog_catinfo(struct ptlrpc_request *req);
1275
1276 /* ptlrpc/llog_client.c */
1277 extern struct llog_operations llog_client_ops;
1278
1279 #endif