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