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