lustre/include/lustre_net.h

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