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