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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  */
  38 /** \defgroup PtlRPC Portal RPC and networking module.
  39  *
  40  * PortalRPC is the layer used by rest of lustre code to achieve network
  41  * communications: establish connections with corresponding export and import
  42  * states, listen for a service, send and receive RPCs.
  43  * PortalRPC also includes base recovery framework: packet resending and
  44  * replaying, reconnections, pinger.
  45  *
  46  * PortalRPC utilizes LNet as its transport layer.
  47  *
  48  * @{
  49  */
  50
  51
  52 #ifndef _LUSTRE_NET_H
  53 #define _LUSTRE_NET_H
  54
  55 /** \defgroup net net
  56  *
  57  * @{
  58  */
  59
  60 #if defined(__linux__)
  61 #include <linux/lustre_net.h>
  62 #elif defined(__APPLE__)
  63 #include <darwin/lustre_net.h>
  64 #elif defined(__WINNT__)
  65 #include <winnt/lustre_net.h>
  66 #else
  67 #error Unsupported operating system.
  68 #endif
  69
  70 #include <libcfs/libcfs.h>
  71 // #include <obd.h>
  72 #include <lnet/lnet.h>
  73 #include <lustre/lustre_idl.h>
  74 #include <lustre_ha.h>
  75 #include <lustre_sec.h>
  76 #include <lustre_import.h>
  77 #include <lprocfs_status.h>
  78 #include <lu_object.h>
  79 #include <lustre_req_layout.h>
  80
  81 #include <obd_support.h>
  82 #include <lustre_ver.h>
  83
  84 /* MD flags we _always_ use */
  85 #define PTLRPC_MD_OPTIONS  0
  86
  87 /**
  88  * Define maxima for bulk I/O
  89  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
  90  * these limits are system wide and not interface-local. */
  91 #define PTLRPC_MAX_BRW_BITS     LNET_MTU_BITS
  92 #define PTLRPC_MAX_BRW_SIZE     (1<<LNET_MTU_BITS)
  93 #define PTLRPC_MAX_BRW_PAGES    (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
  94
  95 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
  96 #ifdef __KERNEL__
  97 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
  98 #  error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
  99 # endif
 100 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
 101 #  error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
 102 # endif
 103 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU)
 104 #  error "PTLRPC_MAX_BRW_SIZE too big"
 105 # endif
 106 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV)
 107 #  error "PTLRPC_MAX_BRW_PAGES too big"
 108 # endif
 109 #endif /* __KERNEL__ */
 110
 111 /**
 112  * The following constants determine how memory is used to buffer incoming
 113  * service requests.
 114  *
 115  * ?_NBUFS              # buffers to allocate when growing the pool
 116  * ?_BUFSIZE            # bytes in a single request buffer
 117  * ?_MAXREQSIZE         # maximum request service will receive
 118  *
 119  * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
 120  * of ?_NBUFS is added to the pool.
 121  *
 122  * Messages larger than ?_MAXREQSIZE are dropped.  Request buffers are
 123  * considered full when less than ?_MAXREQSIZE is left in them.
 124  */
 125 #define LDLM_THREADS_AUTO_MIN (2)
 126 #define LDLM_THREADS_AUTO_MAX min_t(unsigned, cfs_num_online_cpus() * \
 127                                   cfs_num_online_cpus() * 32, 128)
 128 #define LDLM_BL_THREADS  LDLM_THREADS_AUTO_MIN
 129 #define LDLM_NBUFS      (64 * cfs_num_online_cpus())
 130 #define LDLM_BUFSIZE    (8 * 1024)
 131 #define LDLM_MAXREQSIZE (5 * 1024)
 132 #define LDLM_MAXREPSIZE (1024)
 133
 134 /** Absolute limits */
 135 #define MDT_MIN_THREADS 2UL
 136 #ifndef MDT_MAX_THREADS
 137 #define MDT_MAX_THREADS 512UL
 138 #endif
 139 #define MDS_NBUFS       (64 * cfs_num_online_cpus())
 140 /**
 141  * Assume file name length = FNAME_MAX = 256 (true for ext3).
 142  *        path name length = PATH_MAX = 4096
 143  *        LOV MD size max  = EA_MAX = 48000 (2000 stripes)
 144  * symlink:  FNAME_MAX + PATH_MAX  <- largest
 145  * link:     FNAME_MAX + PATH_MAX  (mds_rec_link < mds_rec_create)
 146  * rename:   FNAME_MAX + FNAME_MAX
 147  * open:     FNAME_MAX + EA_MAX
 148  *
 149  * MDS_MAXREQSIZE ~= 4736 bytes =
 150  * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
 151  * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
 152  * or, for mds_close() and mds_reint_unlink() on a many-OST filesystem:
 153  *      = 9210 bytes = lustre_msg + mdt_body + 160 * (easize + cookiesize)
 154  *
 155  * Realistic size is about 512 bytes (20 character name + 128 char symlink),
 156  * except in the open case where there are a large number of OSTs in a LOV.
 157  */
 158 #define MDS_MAXREPSIZE  max(10 * 1024, 362 + LOV_MAX_STRIPE_COUNT * 56)
 159 #define MDS_MAXREQSIZE  MDS_MAXREPSIZE
 160
 161 /** MDS_BUFSIZE = max_reqsize + max sptlrpc payload size */
 162 #define MDS_BUFSIZE     (MDS_MAXREQSIZE + 1024)
 163
 164 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
 165 #define FLD_MAXREQSIZE  (160)
 166
 167 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
 168 #define FLD_MAXREPSIZE  (152)
 169
 170 /**
 171  * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
 172  * __u32 padding */
 173 #define SEQ_MAXREQSIZE  (160)
 174
 175 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
 176 #define SEQ_MAXREPSIZE  (152)
 177
 178 /** MGS threads must be >= 3, see bug 22458 comment #28 */
 179 #define MGS_THREADS_AUTO_MIN 3
 180 #define MGS_THREADS_AUTO_MAX 32
 181 #define MGS_NBUFS       (64 * cfs_num_online_cpus())
 182 #define MGS_BUFSIZE     (8 * 1024)
 183 #define MGS_MAXREQSIZE  (7 * 1024)
 184 #define MGS_MAXREPSIZE  (9 * 1024)
 185
 186 /** Absolute OSS limits */
 187 #define OSS_THREADS_MIN 3       /* difficult replies, HPQ, others */
 188 #define OSS_THREADS_MAX 512
 189 #define OST_NBUFS       (64 * cfs_num_online_cpus())
 190 #define OST_BUFSIZE     (8 * 1024)
 191
 192 /**
 193  * OST_MAXREQSIZE ~= 4768 bytes =
 194  * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote
 195  *
 196  * - single object with 16 pages is 512 bytes
 197  * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
 198  */
 199 #define OST_MAXREQSIZE  (5 * 1024)
 200 #define OST_MAXREPSIZE  (9 * 1024)
 201
 202 /* Macro to hide a typecast. */
 203 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
 204
 205 /**
 206  * Structure to single define portal connection.
 207  */
 208 struct ptlrpc_connection {
 209         /** linkage for connections hash table */
 210         cfs_hlist_node_t        c_hash;
 211         /** Our own lnet nid for this connection */
 212         lnet_nid_t              c_self;
 213         /** Remote side nid for this connection */
 214         lnet_process_id_t       c_peer;
 215         /** UUID of the other side */
 216         struct obd_uuid         c_remote_uuid;
 217         /** reference counter for this connection */
 218         cfs_atomic_t            c_refcount;
 219 };
 220
 221 /** Client definition for PortalRPC */
 222 struct ptlrpc_client {
 223         /** What lnet portal does this client send messages to by default */
 224         __u32                   cli_request_portal;
 225         /** What portal do we expect replies on */
 226         __u32                   cli_reply_portal;
 227         /** Name of the client */
 228         char                   *cli_name;
 229 };
 230
 231 /** state flags of requests */
 232 /* XXX only ones left are those used by the bulk descs as well! */
 233 #define PTL_RPC_FL_INTR      (1 << 0)  /* reply wait was interrupted by user */
 234 #define PTL_RPC_FL_TIMEOUT   (1 << 7)  /* request timed out waiting for reply */
 235
 236 #define REQ_MAX_ACK_LOCKS 8
 237
 238 union ptlrpc_async_args {
 239         /**
 240          * Scratchpad for passing args to completion interpreter. Users
 241          * cast to the struct of their choosing, and CLASSERT that this is
 242          * big enough.  For _tons_ of context, OBD_ALLOC a struct and store
 243          * a pointer to it here.  The pointer_arg ensures this struct is at
 244          * least big enough for that.
 245          */
 246         void      *pointer_arg[11];
 247         __u64      space[6];
 248 };
 249
 250 struct ptlrpc_request_set;
 251 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
 252
 253 /**
 254  * Definition of request set structure.
 255  * Request set is a list of requests (not necessary to the same target) that
 256  * once populated with RPCs could be sent in parallel.
 257  * There are two kinds of request sets. General purpose and with dedicated
 258  * serving thread. Example of the latter is ptlrpcd set.
 259  * For general purpose sets once request set started sending it is impossible
 260  * to add new requests to such set.
 261  * Provides a way to call "completion callbacks" when all requests in the set
 262  * returned.
 263  */
 264 struct ptlrpc_request_set {
 265         cfs_atomic_t          set_refcount;
 266         /** number of in queue requests */
 267         cfs_atomic_t          set_new_count;
 268         /** number of uncompleted requests */
 269         cfs_atomic_t          set_remaining;
 270         /** wait queue to wait on for request events */
 271         cfs_waitq_t           set_waitq;
 272         cfs_waitq_t          *set_wakeup_ptr;
 273         /** List of requests in the set */
 274         cfs_list_t            set_requests;
 275         /**
 276          * List of completion callbacks to be called when the set is completed
 277          * This is only used if \a set_interpret is NULL.
 278          * Links struct ptlrpc_set_cbdata.
 279          */
 280         cfs_list_t            set_cblist;
 281         /** Completion callback, if only one. */
 282         set_interpreter_func  set_interpret;
 283         /** opaq argument passed to completion \a set_interpret callback. */
 284         void                 *set_arg;
 285         /**
 286          * Lock for \a set_new_requests manipulations
 287          * locked so that any old caller can communicate requests to
 288          * the set holder who can then fold them into the lock-free set
 289          */
 290         cfs_spinlock_t        set_new_req_lock;
 291         /** List of new yet unsent requests. Only used with ptlrpcd now. */
 292         cfs_list_t            set_new_requests;
 293 };
 294
 295 /**
 296  * Description of a single ptrlrpc_set callback
 297  */
 298 struct ptlrpc_set_cbdata {
 299         /** List linkage item */
 300         cfs_list_t              psc_item;
 301         /** Pointer to interpreting function */
 302         set_interpreter_func    psc_interpret;
 303         /** Opaq argument to pass to the callback */
 304         void                   *psc_data;
 305 };
 306
 307 struct ptlrpc_bulk_desc;
 308
 309 /**
 310  * ptlrpc callback & work item stuff
 311  */
 312 struct ptlrpc_cb_id {
 313         void   (*cbid_fn)(lnet_event_t *ev);     /* specific callback fn */
 314         void    *cbid_arg;                      /* additional arg */
 315 };
 316
 317 /** Maximum number of locks to fit into reply state */
 318 #define RS_MAX_LOCKS 8
 319 #define RS_DEBUG     0
 320
 321 /**
 322  * Structure to define reply state on the server
 323  * Reply state holds various reply message information. Also for "difficult"
 324  * replies (rep-ack case) we store the state after sending reply and wait
 325  * for the client to acknowledge the reception. In these cases locks could be
 326  * added to the state for replay/failover consistency guarantees.
 327  */
 328 struct ptlrpc_reply_state {
 329         /** Callback description */
 330         struct ptlrpc_cb_id    rs_cb_id;
 331         /** Linkage for list of all reply states in a system */
 332         cfs_list_t             rs_list;
 333         /** Linkage for list of all reply states on same export */
 334         cfs_list_t             rs_exp_list;
 335         /** Linkage for list of all reply states for same obd */
 336         cfs_list_t             rs_obd_list;
 337 #if RS_DEBUG
 338         cfs_list_t             rs_debug_list;
 339 #endif
 340         /** A spinlock to protect the reply state flags */
 341         cfs_spinlock_t         rs_lock;
 342         /** Reply state flags */
 343         unsigned long          rs_difficult:1;     /* ACK/commit stuff */
 344         unsigned long          rs_no_ack:1;    /* no ACK, even for
 345                                                   difficult requests */
 346         unsigned long          rs_scheduled:1;     /* being handled? */
 347         unsigned long          rs_scheduled_ever:1;/* any schedule attempts? */
 348         unsigned long          rs_handled:1;  /* been handled yet? */
 349         unsigned long          rs_on_net:1;   /* reply_out_callback pending? */
 350         unsigned long          rs_prealloc:1; /* rs from prealloc list */
 351         unsigned long          rs_committed:1;/* the transaction was committed
 352                                                  and the rs was dispatched
 353                                                  by ptlrpc_commit_replies */
 354         /** Size of the state */
 355         int                    rs_size;
 356         /** opcode */
 357         __u32                  rs_opc;
 358         /** Transaction number */
 359         __u64                  rs_transno;
 360         /** xid */
 361         __u64                  rs_xid;
 362         struct obd_export     *rs_export;
 363         struct ptlrpc_service *rs_service;
 364         /** Lnet metadata handle for the reply */
 365         lnet_handle_md_t       rs_md_h;
 366         cfs_atomic_t           rs_refcount;
 367
 368         /** Context for the sevice thread */
 369         struct ptlrpc_svc_ctx *rs_svc_ctx;
 370         /** Reply buffer (actually sent to the client), encoded if needed */
 371         struct lustre_msg     *rs_repbuf;       /* wrapper */
 372         /** Size of the reply buffer */
 373         int                    rs_repbuf_len;   /* wrapper buf length */
 374         /** Size of the reply message */
 375         int                    rs_repdata_len;  /* wrapper msg length */
 376         /**
 377          * Actual reply message. Its content is encrupted (if needed) to
 378          * produce reply buffer for actual sending. In simple case
 379          * of no network encryption we jus set \a rs_repbuf to \a rs_msg
 380          */
 381         struct lustre_msg     *rs_msg;          /* reply message */
 382
 383         /** Number of locks awaiting client ACK */
 384         int                    rs_nlocks;
 385         /** Handles of locks awaiting client reply ACK */
 386         struct lustre_handle   rs_locks[RS_MAX_LOCKS];
 387         /** Lock modes of locks in \a rs_locks */
 388         ldlm_mode_t            rs_modes[RS_MAX_LOCKS];
 389 };
 390
 391 struct ptlrpc_thread;
 392
 393 /** RPC stages */
 394 enum rq_phase {
 395         RQ_PHASE_NEW            = 0xebc0de00,
 396         RQ_PHASE_RPC            = 0xebc0de01,
 397         RQ_PHASE_BULK           = 0xebc0de02,
 398         RQ_PHASE_INTERPRET      = 0xebc0de03,
 399         RQ_PHASE_COMPLETE       = 0xebc0de04,
 400         RQ_PHASE_UNREGISTERING  = 0xebc0de05,
 401         RQ_PHASE_UNDEFINED      = 0xebc0de06
 402 };
 403
 404 /** Type of request interpreter call-back */
 405 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
 406                                     struct ptlrpc_request *req,
 407                                     void *arg, int rc);
 408
 409 /**
 410  * Definition of request pool structure.
 411  * The pool is used to store empty preallocated requests for the case
 412  * when we would actually need to send something without performing
 413  * any allocations (to avoid e.g. OOM).
 414  */
 415 struct ptlrpc_request_pool {
 416         /** Locks the list */
 417         cfs_spinlock_t prp_lock;
 418         /** list of ptlrpc_request structs */
 419         cfs_list_t prp_req_list;
 420         /** Maximum message size that would fit into a rquest from this pool */
 421         int prp_rq_size;
 422         /** Function to allocate more requests for this pool */
 423         void (*prp_populate)(struct ptlrpc_request_pool *, int);
 424 };
 425
 426 struct lu_context;
 427 struct lu_env;
 428
 429 struct ldlm_lock;
 430
 431 /**
 432  * Basic request prioritization operations structure.
 433  * The whole idea is centered around locks and RPCs that might affect locks.
 434  * When a lock is contended we try to give priority to RPCs that might lead
 435  * to fastest release of that lock.
 436  * Currently only implemented for OSTs only in a way that makes all
 437  * IO and truncate RPCs that are coming from a locked region where a lock is
 438  * contended a priority over other requests.
 439  */
 440 struct ptlrpc_hpreq_ops {
 441         /**
 442          * Check if the lock handle of the given lock is the same as
 443          * taken from the request.
 444          */
 445         int  (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
 446         /**
 447          * Check if the request is a high priority one.
 448          */
 449         int  (*hpreq_check)(struct ptlrpc_request *);
 450         /**
 451          * Called after the request has been handled.
 452          */
 453         void (*hpreq_fini)(struct ptlrpc_request *);
 454 };
 455
 456 /**
 457  * Represents remote procedure call.
 458  *
 459  * This is a staple structure used by everybody wanting to send a request
 460  * in Lustre.
 461  */
 462 struct ptlrpc_request {
 463         /* Request type: one of PTL_RPC_MSG_* */
 464         int rq_type;
 465         /**
 466          * Linkage item through which this request is included into
 467          * sending/delayed lists on client and into rqbd list on server
 468          */
 469         cfs_list_t rq_list;
 470         /**
 471          * Server side list of incoming unserved requests sorted by arrival
 472          * time.  Traversed from time to time to notice about to expire
 473          * requests and sent back "early replies" to clients to let them
 474          * know server is alive and well, just very busy to service their
 475          * requests in time
 476          */
 477         cfs_list_t rq_timed_list;
 478         /** server-side history, used for debuging purposes. */
 479         cfs_list_t rq_history_list;
 480         /** server-side per-export list */
 481         cfs_list_t rq_exp_list;
 482         /** server-side hp handlers */
 483         struct ptlrpc_hpreq_ops *rq_ops;
 484         /** history sequence # */
 485         __u64 rq_history_seq;
 486         /** the index of service's srv_at_array into which request is linked */
 487         time_t rq_at_index;
 488         /** Result of request processing */
 489         int rq_status;
 490         /** Lock to protect request flags and some other important bits, like
 491          * rq_list
 492          */
 493         cfs_spinlock_t rq_lock;
 494         /** client-side flags are serialized by rq_lock */
 495         unsigned long rq_intr:1, rq_replied:1, rq_err:1,
 496                 rq_timedout:1, rq_resend:1, rq_restart:1,
 497                 /**
 498                  * when ->rq_replay is set, request is kept by the client even
 499                  * after server commits corresponding transaction. This is
 500                  * used for operations that require sequence of multiple
 501                  * requests to be replayed. The only example currently is file
 502                  * open/close. When last request in such a sequence is
 503                  * committed, ->rq_replay is cleared on all requests in the
 504                  * sequence.
 505                  */
 506                 rq_replay:1,
 507                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
 508                 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
 509                 rq_early:1, rq_must_unlink:1,
 510                 rq_fake:1,          /* this fake req */
 511                 rq_memalloc:1,      /* req originated from "kswapd" */
 512                 /* server-side flags */
 513                 rq_packed_final:1,  /* packed final reply */
 514                 rq_hp:1,            /* high priority RPC */
 515                 rq_at_linked:1,     /* link into service's srv_at_array */
 516                 rq_reply_truncate:1,
 517                 rq_committed:1,
 518                 /* whether the "rq_set" is a valid one */
 519                 rq_invalid_rqset:1,
 520                 rq_generation_set:1;
 521
 522         enum rq_phase rq_phase; /* one of RQ_PHASE_* */
 523         enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
 524         cfs_atomic_t rq_refcount;/* client-side refcount for SENT race,
 525                                     server-side refcounf for multiple replies */
 526
 527         /** initial thread servicing this request */
 528         struct ptlrpc_thread *rq_svc_thread;
 529
 530         /** Portal to which this request would be sent */
 531         int rq_request_portal;  /* XXX FIXME bug 249 */
 532         /** Portal where to wait for reply and where reply would be sent */
 533         int rq_reply_portal;    /* XXX FIXME bug 249 */
 534
 535         /**
 536          * client-side:
 537          * !rq_truncate : # reply bytes actually received,
 538          *  rq_truncate : required repbuf_len for resend
 539          */
 540         int rq_nob_received;
 541         /** Request length */
 542         int rq_reqlen;
 543          /** Request message - what client sent */
 544         struct lustre_msg *rq_reqmsg;
 545
 546         /** Reply length */
 547         int rq_replen;
 548         /** Reply message - server response */
 549         struct lustre_msg *rq_repmsg;
 550         /** Transaction number */
 551         __u64 rq_transno;
 552         /** xid */
 553         __u64 rq_xid;
 554         /**
 555          * List item to for replay list. Not yet commited requests get linked
 556          * there.
 557          * Also see \a rq_replay comment above.
 558          */
 559         cfs_list_t rq_replay_list;
 560
 561         /**
 562          * security and encryption data
 563          * @{ */
 564         struct ptlrpc_cli_ctx   *rq_cli_ctx;     /**< client's half ctx */
 565         struct ptlrpc_svc_ctx   *rq_svc_ctx;     /**< server's half ctx */
 566         cfs_list_t               rq_ctx_chain;   /**< link to waited ctx */
 567
 568         struct sptlrpc_flavor    rq_flvr;        /**< for client & server */
 569         enum lustre_sec_part     rq_sp_from;
 570
 571         unsigned long            /* client/server security flags */
 572                                  rq_ctx_init:1,      /* context initiation */
 573                                  rq_ctx_fini:1,      /* context destroy */
 574                                  rq_bulk_read:1,     /* request bulk read */
 575                                  rq_bulk_write:1,    /* request bulk write */
 576                                  /* server authentication flags */
 577                                  rq_auth_gss:1,      /* authenticated by gss */
 578                                  rq_auth_remote:1,   /* authed as remote user */
 579                                  rq_auth_usr_root:1, /* authed as root */
 580                                  rq_auth_usr_mdt:1,  /* authed as mdt */
 581                                  rq_auth_usr_ost:1,  /* authed as ost */
 582                                  /* security tfm flags */
 583                                  rq_pack_udesc:1,
 584                                  rq_pack_bulk:1,
 585                                  /* doesn't expect reply FIXME */
 586                                  rq_no_reply:1,
 587                                  rq_pill_init:1;     /* pill initialized */
 588
 589         uid_t                    rq_auth_uid;        /* authed uid */
 590         uid_t                    rq_auth_mapped_uid; /* authed uid mapped to */
 591
 592         /* (server side), pointed directly into req buffer */
 593         struct ptlrpc_user_desc *rq_user_desc;
 594
 595         /** early replies go to offset 0, regular replies go after that */
 596         unsigned int             rq_reply_off;
 597
 598         /* various buffer pointers */
 599         struct lustre_msg       *rq_reqbuf;      /* req wrapper */
 600         int                      rq_reqbuf_len;  /* req wrapper buf len */
 601         int                      rq_reqdata_len; /* req wrapper msg len */
 602         char                    *rq_repbuf;      /* rep buffer */
 603         int                      rq_repbuf_len;  /* rep buffer len */
 604         struct lustre_msg       *rq_repdata;     /* rep wrapper msg */
 605         int                      rq_repdata_len; /* rep wrapper msg len */
 606         struct lustre_msg       *rq_clrbuf;      /* only in priv mode */
 607         int                      rq_clrbuf_len;  /* only in priv mode */
 608         int                      rq_clrdata_len; /* only in priv mode */
 609
 610         /** @} */
 611
 612         /** Fields that help to see if request and reply were swabbed or not */
 613         __u32 rq_req_swab_mask;
 614         __u32 rq_rep_swab_mask;
 615
 616         /** What was import generation when this request was sent */
 617         int rq_import_generation;
 618         enum lustre_imp_state rq_send_state;
 619
 620         /** how many early replies (for stats) */
 621         int rq_early_count;
 622
 623         /** client+server request */
 624         lnet_handle_md_t     rq_req_md_h;
 625         struct ptlrpc_cb_id  rq_req_cbid;
 626         /** optional time limit for send attempts */
 627         cfs_duration_t       rq_delay_limit;
 628         /** time request was first queued */
 629         cfs_time_t           rq_queued_time;
 630
 631         /* server-side... */
 632         /** request arrival time */
 633         struct timeval       rq_arrival_time;
 634         /** separated reply state */
 635         struct ptlrpc_reply_state *rq_reply_state;
 636         /** incoming request buffer */
 637         struct ptlrpc_request_buffer_desc *rq_rqbd;
 638 #ifdef CRAY_XT3
 639         __u32                rq_uid;            /* peer uid, used in MDS only */
 640 #endif
 641
 642         /** client-only incoming reply */
 643         lnet_handle_md_t     rq_reply_md_h;
 644         cfs_waitq_t          rq_reply_waitq;
 645         struct ptlrpc_cb_id  rq_reply_cbid;
 646
 647         /** our LNet NID */
 648         lnet_nid_t           rq_self;
 649         /** Peer description (the other side) */
 650         lnet_process_id_t    rq_peer;
 651         /** Server-side, export on which request was received */
 652         struct obd_export   *rq_export;
 653         /** Client side, import where request is being sent */
 654         struct obd_import   *rq_import;
 655
 656         /** Replay callback, called after request is replayed at recovery */
 657         void (*rq_replay_cb)(struct ptlrpc_request *);
 658         /**
 659          * Commit callback, called when request is committed and about to be
 660          * freed.
 661          */
 662         void (*rq_commit_cb)(struct ptlrpc_request *);
 663         /** Opaq data for replay and commit callbacks. */
 664         void  *rq_cb_data;
 665
 666         /** For bulk requests on client only: bulk descriptor */
 667         struct ptlrpc_bulk_desc *rq_bulk;
 668
 669         /** client outgoing req */
 670         /**
 671          * when request/reply sent (secs), or time when request should be sent
 672          */
 673         time_t rq_sent;
 674         /** time for request really sent out */
 675         time_t rq_real_sent;
 676
 677         /** when request must finish. volatile
 678          * so that servers' early reply updates to the deadline aren't
 679          * kept in per-cpu cache */
 680         volatile time_t rq_deadline;
 681         /** when req reply unlink must finish. */
 682         time_t rq_reply_deadline;
 683         /** when req bulk unlink must finish. */
 684         time_t rq_bulk_deadline;
 685         /**
 686          * service time estimate (secs)
 687          * If the requestsis not served by this time, it is marked as timed out.
 688          */
 689         int    rq_timeout;
 690
 691         /** Multi-rpc bits */
 692         /** Link item for request set lists */
 693         cfs_list_t  rq_set_chain;
 694         /** Per-request waitq introduced by bug 21938 for recovery waiting */
 695         cfs_waitq_t rq_set_waitq;
 696         /** Link back to the request set */
 697         struct ptlrpc_request_set *rq_set;
 698         /** Async completion handler, called when reply is received */
 699         ptlrpc_interpterer_t rq_interpret_reply;
 700         /** Async completion context */
 701         union ptlrpc_async_args rq_async_args;
 702
 703         /** Pool if request is from preallocated list */
 704         struct ptlrpc_request_pool *rq_pool;
 705
 706         struct lu_context           rq_session;
 707         struct lu_context           rq_recov_session;
 708
 709         /** request format description */
 710         struct req_capsule          rq_pill;
 711 };
 712
 713 /**
 714  * Call completion handler for rpc if any, return it's status or original
 715  * rc if there was no handler defined for this request.
 716  */
 717 static inline int ptlrpc_req_interpret(const struct lu_env *env,
 718                                        struct ptlrpc_request *req, int rc)
 719 {
 720         if (req->rq_interpret_reply != NULL) {
 721                 req->rq_status = req->rq_interpret_reply(env, req,
 722                                                          &req->rq_async_args,
 723                                                          rc);
 724                 return req->rq_status;
 725         }
 726         return rc;
 727 }
 728
 729 /**
 730  * Returns 1 if request buffer at offset \a index was already swabbed
 731  */
 732 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
 733 {
 734         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
 735         return req->rq_req_swab_mask & (1 << index);
 736 }
 737
 738 /**
 739  * Returns 1 if request reply buffer at offset \a index was already swabbed
 740  */
 741 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
 742 {
 743         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
 744         return req->rq_rep_swab_mask & (1 << index);
 745 }
 746
 747 /**
 748  * Returns 1 if request needs to be swabbed into local cpu byteorder
 749  */
 750 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
 751 {
 752         return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
 753 }
 754
 755 /**
 756  * Returns 1 if request reply needs to be swabbed into local cpu byteorder
 757  */
 758 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
 759 {
 760         return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
 761 }
 762
 763 /**
 764  * Mark request buffer at offset \a index that it was already swabbed
 765  */
 766 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
 767 {
 768         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
 769         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
 770         req->rq_req_swab_mask |= 1 << index;
 771 }
 772
 773 /**
 774  * Mark request reply buffer at offset \a index that it was already swabbed
 775  */
 776 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
 777 {
 778         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
 779         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
 780         req->rq_rep_swab_mask |= 1 << index;
 781 }
 782
 783 /**
 784  * Convert numerical request phase value \a phase into text string description
 785  */
 786 static inline const char *
 787 ptlrpc_phase2str(enum rq_phase phase)
 788 {
 789         switch (phase) {
 790         case RQ_PHASE_NEW:
 791                 return "New";
 792         case RQ_PHASE_RPC:
 793                 return "Rpc";
 794         case RQ_PHASE_BULK:
 795                 return "Bulk";
 796         case RQ_PHASE_INTERPRET:
 797                 return "Interpret";
 798         case RQ_PHASE_COMPLETE:
 799                 return "Complete";
 800         case RQ_PHASE_UNREGISTERING:
 801                 return "Unregistering";
 802         default:
 803                 return "?Phase?";
 804         }
 805 }
 806
 807 /**
 808  * Convert numerical request phase of the request \a req into text stringi
 809  * description
 810  */
 811 static inline const char *
 812 ptlrpc_rqphase2str(struct ptlrpc_request *req)
 813 {
 814         return ptlrpc_phase2str(req->rq_phase);
 815 }
 816
 817 /**
 818  * Debugging functions and helpers to print request structure into debug log
 819  * @{
 820  */
 821 /* Spare the preprocessor, spoil the bugs. */
 822 #define FLAG(field, str) (field ? str : "")
 823
 824 /** Convert bit flags into a string */
 825 #define DEBUG_REQ_FLAGS(req)                                                    \
 826         ptlrpc_rqphase2str(req),                                                \
 827         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                    \
 828         FLAG(req->rq_err, "E"),                                                 \
 829         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),   \
 830         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                  \
 831         FLAG(req->rq_no_resend, "N"),                                           \
 832         FLAG(req->rq_waiting, "W"),                                             \
 833         FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"),                     \
 834         FLAG(req->rq_committed, "M")
 835
 836 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s"
 837
 838 void _debug_req(struct ptlrpc_request *req,
 839                 struct libcfs_debug_msg_data *data, const char *fmt, ...)
 840         __attribute__ ((format (printf, 3, 4)));
 841
 842 /**
 843  * Helper that decides if we need to print request accordig to current debug
 844  * level settings
 845  */
 846 #define debug_req(msgdata, mask, cdls, req, fmt, a...)                        \
 847 do {                                                                          \
 848         CFS_CHECK_STACK(msgdata, mask, cdls);                                 \
 849                                                                               \
 850         if (((mask) & D_CANTMASK) != 0 ||                                     \
 851             ((libcfs_debug & (mask)) != 0 &&                                  \
 852              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
 853                 _debug_req((req), msgdata, fmt, ##a);                         \
 854 } while(0)
 855
 856 /**
 857  * This is the debug print function you need to use to print request sturucture
 858  * content into lustre debug log.
 859  * for most callers (level is a constant) this is resolved at compile time */
 860 #define DEBUG_REQ(level, req, fmt, args...)                                   \
 861 do {                                                                          \
 862         if ((level) & (D_ERROR | D_WARNING)) {                                \
 863                 static cfs_debug_limit_state_t cdls;                          \
 864                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls);            \
 865                 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
 866         } else {                                                              \
 867                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL);             \
 868                 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
 869         }                                                                     \
 870 } while (0)
 871 /** @} */
 872
 873 /**
 874  * Structure that defines a single page of a bulk transfer
 875  */
 876 struct ptlrpc_bulk_page {
 877         /** Linkage to list of pages in a bulk */
 878         cfs_list_t       bp_link;
 879         /**
 880          * Number of bytes in a page to transfer starting from \a bp_pageoffset
 881          */
 882         int              bp_buflen;
 883         /** offset within a page */
 884         int              bp_pageoffset;
 885         /** The page itself */
 886         struct page     *bp_page;
 887 };
 888
 889 #define BULK_GET_SOURCE   0
 890 #define BULK_PUT_SINK     1
 891 #define BULK_GET_SINK     2
 892 #define BULK_PUT_SOURCE   3
 893
 894 /**
 895  * Definition of buk descriptor.
 896  * Bulks are special "Two phase" RPCs where initial request message
 897  * is sent first and it is followed bt a transfer (o receiving) of a large
 898  * amount of data to be settled into pages referenced from the bulk descriptors.
 899  * Bulks transfers (the actual data following the small requests) are done
 900  * on separate LNet portals.
 901  * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
 902  *  Another user is readpage for MDT.
 903  */
 904 struct ptlrpc_bulk_desc {
 905         /** completed successfully */
 906         unsigned long bd_success:1;
 907         /** accessible to the network (network io potentially in progress) */
 908         unsigned long bd_network_rw:1;
 909         /** {put,get}{source,sink} */
 910         unsigned long bd_type:2;
 911         /** client side */
 912         unsigned long bd_registered:1;
 913         /** For serialization with callback */
 914         cfs_spinlock_t bd_lock;
 915         /** Import generation when request for this bulk was sent */
 916         int bd_import_generation;
 917         /** Server side - export this bulk created for */
 918         struct obd_export *bd_export;
 919         /** Client side - import this bulk was sent on */
 920         struct obd_import *bd_import;
 921         /** LNet portal for this bulk */
 922         __u32 bd_portal;
 923         /** Back pointer to the request */
 924         struct ptlrpc_request *bd_req;
 925         cfs_waitq_t            bd_waitq;        /* server side only WQ */
 926         int                    bd_iov_count;    /* # entries in bd_iov */
 927         int                    bd_max_iov;      /* allocated size of bd_iov */
 928         int                    bd_nob;          /* # bytes covered */
 929         int                    bd_nob_transferred; /* # bytes GOT/PUT */
 930
 931         __u64                  bd_last_xid;
 932
 933         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
 934         lnet_handle_md_t       bd_md_h;         /* associated MD */
 935         lnet_nid_t             bd_sender;       /* stash event::sender */
 936
 937 #if defined(__KERNEL__)
 938         /*
 939          * encrypt iov, size is either 0 or bd_iov_count.
 940          */
 941         lnet_kiov_t           *bd_enc_iov;
 942
 943         lnet_kiov_t            bd_iov[0];
 944 #else
 945         lnet_md_iovec_t        bd_iov[0];
 946 #endif
 947 };
 948
 949 enum {
 950         SVC_STOPPED     = 1 << 0,
 951         SVC_STOPPING    = 1 << 1,
 952         SVC_STARTING    = 1 << 2,
 953         SVC_RUNNING     = 1 << 3,
 954         SVC_EVENT       = 1 << 4,
 955         SVC_SIGNAL      = 1 << 5,
 956 };
 957
 958 /**
 959  * Definition of server service thread structure
 960  */
 961 struct ptlrpc_thread {
 962         /**
 963          * List of active threads in svc->srv_threads
 964          */
 965         cfs_list_t t_link;
 966         /**
 967          * thread-private data (preallocated memory)
 968          */
 969         void *t_data;
 970         __u32 t_flags;
 971         /**
 972          * service thread index, from ptlrpc_start_threads
 973          */
 974         unsigned int t_id;
 975         /**
 976          * service thread pid
 977          */
 978         pid_t t_pid;
 979         /**
 980          * put watchdog in the structure per thread b=14840
 981          */
 982         struct lc_watchdog *t_watchdog;
 983         /**
 984          * the svc this thread belonged to b=18582
 985          */
 986         struct ptlrpc_service *t_svc;
 987         cfs_waitq_t t_ctl_waitq;
 988         struct lu_env *t_env;
 989 };
 990
 991 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
 992 {
 993         return !!(thread->t_flags & SVC_STOPPED);
 994 }
 995
 996 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
 997 {
 998         return !!(thread->t_flags & SVC_STOPPING);
 999 }
1000
1001 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1002 {
1003         return !!(thread->t_flags & SVC_STARTING);
1004 }
1005
1006 static inline int thread_is_running(struct ptlrpc_thread *thread)
1007 {
1008         return !!(thread->t_flags & SVC_RUNNING);
1009 }
1010
1011 static inline int thread_is_event(struct ptlrpc_thread *thread)
1012 {
1013         return !!(thread->t_flags & SVC_EVENT);
1014 }
1015
1016 static inline int thread_is_signal(struct ptlrpc_thread *thread)
1017 {
1018         return !!(thread->t_flags & SVC_SIGNAL);
1019 }
1020
1021 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1022 {
1023         thread->t_flags &= ~flags;
1024 }
1025
1026 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1027 {
1028         thread->t_flags = flags;
1029 }
1030
1031 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1032 {
1033         thread->t_flags |= flags;
1034 }
1035
1036 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1037                                               __u32 flags)
1038 {
1039         if (thread->t_flags & flags) {
1040                 thread->t_flags &= ~flags;
1041                 return 1;
1042         }
1043         return 0;
1044 }
1045
1046 /**
1047  * Request buffer descriptor structure.
1048  * This is a structure that contains one posted request buffer for service.
1049  * Once data land into a buffer, event callback creates actual request and
1050  * notifies wakes one of the service threads to process new incoming request.
1051  * More than one request can fit into the buffer.
1052  */
1053 struct ptlrpc_request_buffer_desc {
1054         /** Link item for rqbds on a service */
1055         cfs_list_t             rqbd_list;
1056         /** History of requests for this buffer */
1057         cfs_list_t             rqbd_reqs;
1058         /** Back pointer to service for which this buffer is registered */
1059         struct ptlrpc_service *rqbd_service;
1060         /** LNet descriptor */
1061         lnet_handle_md_t       rqbd_md_h;
1062         int                    rqbd_refcount;
1063         /** The buffer itself */
1064         char                  *rqbd_buffer;
1065         struct ptlrpc_cb_id    rqbd_cbid;
1066         /**
1067          * This "embedded" request structure is only used for the
1068          * last request to fit into the buffer
1069          */
1070         struct ptlrpc_request  rqbd_req;
1071 };
1072
1073 typedef int  (*svc_thr_init_t)(struct ptlrpc_thread *thread);
1074 typedef void (*svc_thr_done_t)(struct ptlrpc_thread *thread);
1075 typedef int  (*svc_handler_t)(struct ptlrpc_request *req);
1076 typedef int  (*svc_hpreq_handler_t)(struct ptlrpc_request *);
1077 typedef void (*svc_req_printfn_t)(void *, struct ptlrpc_request *);
1078
1079 #ifndef __cfs_cacheline_aligned
1080 /* NB: put it here for reducing patche dependence */
1081 # define __cfs_cacheline_aligned
1082 #endif
1083
1084 /**
1085  * How many high priority requests to serve before serving one normal
1086  * priority request
1087  */
1088 #define PTLRPC_SVC_HP_RATIO 10
1089
1090 /**
1091  * Definition of PortalRPC service.
1092  * The service is listening on a particular portal (like tcp port)
1093  * and perform actions for a specific server like IO service for OST
1094  * or general metadata service for MDS.
1095  *
1096  * ptlrpc service has four locks:
1097  * \a srv_lock
1098  *    serialize operations on rqbd and requests waiting for preprocess
1099  * \a srv_rq_lock
1100  *    serialize operations active requests sent to this portal
1101  * \a srv_at_lock
1102  *    serialize adaptive timeout stuff
1103  * \a srv_rs_lock
1104  *    serialize operations on RS list (reply states)
1105  *
1106  * We don't have any use-case to take two or more locks at the same time
1107  * for now, so there is no lock order issue.
1108  */
1109 struct ptlrpc_service {
1110         /** most often accessed fields */
1111         /** chain thru all services */
1112         cfs_list_t                      srv_list;
1113         /** only statically allocated strings here; we don't clean them */
1114         char                           *srv_name;
1115         /** only statically allocated strings here; we don't clean them */
1116         char                           *srv_thread_name;
1117         /** service thread list */
1118         cfs_list_t                      srv_threads;
1119         /** threads to start at beginning of service */
1120         int                             srv_threads_min;
1121         /** thread upper limit */
1122         int                             srv_threads_max;
1123         /** always increasing number */
1124         unsigned                        srv_threads_next_id;
1125         /** # of starting threads */
1126         int                             srv_threads_starting;
1127         /** # running threads */
1128         int                             srv_threads_running;
1129
1130         /** service operations, move to ptlrpc_svc_ops_t in the future */
1131         /** @{ */
1132         /**
1133          * if non-NULL called during thread creation (ptlrpc_start_thread())
1134          * to initialize service specific per-thread state.
1135          */
1136         svc_thr_init_t                  srv_init;
1137         /**
1138          * if non-NULL called during thread shutdown (ptlrpc_main()) to
1139          * destruct state created by ->srv_init().
1140          */
1141         svc_thr_done_t                  srv_done;
1142         /** Handler function for incoming requests for this service */
1143         svc_handler_t                   srv_handler;
1144         /** hp request handler */
1145         svc_hpreq_handler_t             srv_hpreq_handler;
1146         /** service-specific print fn */
1147         svc_req_printfn_t               srv_req_printfn;
1148         /** @} */
1149
1150         /** Root of /proc dir tree for this service */
1151         cfs_proc_dir_entry_t           *srv_procroot;
1152         /** Pointer to statistic data for this service */
1153         struct lprocfs_stats           *srv_stats;
1154         /** # hp per lp reqs to handle */
1155         int                             srv_hpreq_ratio;
1156         /** biggest request to receive */
1157         int                             srv_max_req_size;
1158         /** biggest reply to send */
1159         int                             srv_max_reply_size;
1160         /** size of individual buffers */
1161         int                             srv_buf_size;
1162         /** # buffers to allocate in 1 group */
1163         int                             srv_nbuf_per_group;
1164         /** Local portal on which to receive requests */
1165         __u32                           srv_req_portal;
1166         /** Portal on the client to send replies to */
1167         __u32                           srv_rep_portal;
1168         /**
1169          * Tags for lu_context associated with this thread, see struct
1170          * lu_context.
1171          */
1172         __u32                           srv_ctx_tags;
1173         /** soft watchdog timeout multiplier */
1174         int                             srv_watchdog_factor;
1175         /** bind threads to CPUs */
1176         unsigned                        srv_cpu_affinity:1;
1177         /** under unregister_service */
1178         unsigned                        srv_is_stopping:1;
1179
1180         /**
1181          * serialize the following fields, used for protecting
1182          * rqbd list and incoming requests waiting for preprocess
1183          */
1184         cfs_spinlock_t                  srv_lock  __cfs_cacheline_aligned;
1185         /** incoming reqs */
1186         cfs_list_t                      srv_req_in_queue;
1187         /** total # req buffer descs allocated */
1188         int                             srv_nbufs;
1189         /** # posted request buffers */
1190         int                             srv_nrqbd_receiving;
1191         /** timeout before re-posting reqs, in tick */
1192         cfs_duration_t                  srv_rqbd_timeout;
1193         /** request buffers to be reposted */
1194         cfs_list_t                      srv_idle_rqbds;
1195         /** req buffers receiving */
1196         cfs_list_t                      srv_active_rqbds;
1197         /** request buffer history */
1198         cfs_list_t                      srv_history_rqbds;
1199         /** # request buffers in history */
1200         int                             srv_n_history_rqbds;
1201         /** max # request buffers in history */
1202         int                             srv_max_history_rqbds;
1203         /** request history */
1204         cfs_list_t                      srv_request_history;
1205         /** next request sequence # */
1206         __u64                           srv_request_seq;
1207         /** highest seq culled from history */
1208         __u64                           srv_request_max_cull_seq;
1209         /**
1210          * all threads sleep on this. This wait-queue is signalled when new
1211          * incoming request arrives and when difficult reply has to be handled.
1212          */
1213         cfs_waitq_t                     srv_waitq;
1214
1215         /**
1216          * serialize the following fields, used for processing requests
1217          * sent to this portal
1218          */
1219         cfs_spinlock_t                  srv_rq_lock __cfs_cacheline_aligned;
1220         /** # reqs in either of the queues below */
1221         /** reqs waiting for service */
1222         cfs_list_t                      srv_request_queue;
1223         /** high priority queue */
1224         cfs_list_t                      srv_request_hpq;
1225         /** # incoming reqs */
1226         int                             srv_n_queued_reqs;
1227         /** # reqs being served */
1228         int                             srv_n_active_reqs;
1229         /** # HPreqs being served */
1230         int                             srv_n_active_hpreq;
1231         /** # hp requests handled */
1232         int                             srv_hpreq_count;
1233
1234         /** AT stuff */
1235         /** @{ */
1236         /**
1237          * serialize the following fields, used for changes on
1238          * adaptive timeout
1239          */
1240         cfs_spinlock_t                  srv_at_lock __cfs_cacheline_aligned;
1241         /** estimated rpc service time */
1242         struct adaptive_timeout         srv_at_estimate;
1243         /** reqs waiting for replies */
1244         struct ptlrpc_at_array          srv_at_array;
1245         /** early reply timer */
1246         cfs_timer_t                     srv_at_timer;
1247         /** check early replies */
1248         unsigned                        srv_at_check;
1249         /** debug */
1250         cfs_time_t                      srv_at_checktime;
1251         /** @} */
1252
1253         /**
1254          * serialize the following fields, used for processing
1255          * replies for this portal
1256          */
1257         cfs_spinlock_t                  srv_rs_lock __cfs_cacheline_aligned;
1258         /** all the active replies */
1259         cfs_list_t                      srv_active_replies;
1260 #ifndef __KERNEL__
1261         /** replies waiting for service */
1262         cfs_list_t                      srv_reply_queue;
1263 #endif
1264         /** List of free reply_states */
1265         cfs_list_t                      srv_free_rs_list;
1266         /** waitq to run, when adding stuff to srv_free_rs_list */
1267         cfs_waitq_t                     srv_free_rs_waitq;
1268         /** # 'difficult' replies */
1269         cfs_atomic_t                    srv_n_difficult_replies;
1270         //struct ptlrpc_srv_ni srv_interfaces[0];
1271 };
1272
1273 /**
1274  * Declaration of ptlrpcd control structure
1275  */
1276 struct ptlrpcd_ctl {
1277         /**
1278          * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1279          */
1280         unsigned long               pc_flags;
1281         /**
1282          * Thread lock protecting structure fields.
1283          */
1284         cfs_spinlock_t              pc_lock;
1285         /**
1286          * Start completion.
1287          */
1288         cfs_completion_t            pc_starting;
1289         /**
1290          * Stop completion.
1291          */
1292         cfs_completion_t            pc_finishing;
1293         /**
1294          * Thread requests set.
1295          */
1296         struct ptlrpc_request_set  *pc_set;
1297         /**
1298          * Thread name used in cfs_daemonize()
1299          */
1300         char                        pc_name[16];
1301         /**
1302          * Environment for request interpreters to run in.
1303          */
1304         struct lu_env               pc_env;
1305         /**
1306          * Index of ptlrpcd thread in the array.
1307          */
1308         int                         pc_index;
1309         /**
1310          * Number of the ptlrpcd's partners.
1311          */
1312         int                         pc_npartners;
1313         /**
1314          * Pointer to the array of partners' ptlrpcd_ctl structure.
1315          */
1316         struct ptlrpcd_ctl        **pc_partners;
1317         /**
1318          * Record the partner index to be processed next.
1319          */
1320         int                         pc_cursor;
1321 #ifndef __KERNEL__
1322         /**
1323          * Async rpcs flag to make sure that ptlrpcd_check() is called only
1324          * once.
1325          */
1326         int                         pc_recurred;
1327         /**
1328          * Currently not used.
1329          */
1330         void                       *pc_callback;
1331         /**
1332          * User-space async rpcs callback.
1333          */
1334         void                       *pc_wait_callback;
1335         /**
1336          * User-space check idle rpcs callback.
1337          */
1338         void                       *pc_idle_callback;
1339 #endif
1340 };
1341
1342 /* Bits for pc_flags */
1343 enum ptlrpcd_ctl_flags {
1344         /**
1345          * Ptlrpc thread start flag.
1346          */
1347         LIOD_START       = 1 << 0,
1348         /**
1349          * Ptlrpc thread stop flag.
1350          */
1351         LIOD_STOP        = 1 << 1,
1352         /**
1353          * Ptlrpc thread force flag (only stop force so far).
1354          * This will cause aborting any inflight rpcs handled
1355          * by thread if LIOD_STOP is specified.
1356          */
1357         LIOD_FORCE       = 1 << 2,
1358         /**
1359          * This is a recovery ptlrpc thread.
1360          */
1361         LIOD_RECOVERY    = 1 << 3,
1362         /**
1363          * The ptlrpcd is bound to some CPU core.
1364          */
1365         LIOD_BIND        = 1 << 4,
1366 };
1367
1368 /* ptlrpc/events.c */
1369 extern lnet_handle_eq_t ptlrpc_eq_h;
1370 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
1371                                lnet_process_id_t *peer, lnet_nid_t *self);
1372 /**
1373  * These callbacks are invoked by LNet when something happened to
1374  * underlying buffer
1375  * @{
1376  */
1377 extern void request_out_callback(lnet_event_t *ev);
1378 extern void reply_in_callback(lnet_event_t *ev);
1379 extern void client_bulk_callback(lnet_event_t *ev);
1380 extern void request_in_callback(lnet_event_t *ev);
1381 extern void reply_out_callback(lnet_event_t *ev);
1382 #ifdef HAVE_SERVER_SUPPORT
1383 extern void server_bulk_callback(lnet_event_t *ev);
1384 #endif
1385 /** @} */
1386
1387 /* ptlrpc/connection.c */
1388 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
1389                                                 lnet_nid_t self,
1390                                                 struct obd_uuid *uuid);
1391 int ptlrpc_connection_put(struct ptlrpc_connection *c);
1392 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
1393 int ptlrpc_connection_init(void);
1394 void ptlrpc_connection_fini(void);
1395 extern lnet_pid_t ptl_get_pid(void);
1396
1397 /* ptlrpc/niobuf.c */
1398 /**
1399  * Actual interfacing with LNet to put/get/register/unregister stuff
1400  * @{
1401  */
1402 #ifdef HAVE_SERVER_SUPPORT
1403 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
1404                                               int npages, int type, int portal);
1405 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
1406 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
1407
1408 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
1409 {
1410         int rc;
1411
1412         LASSERT(desc != NULL);
1413
1414         cfs_spin_lock(&desc->bd_lock);
1415         rc = desc->bd_network_rw;
1416         cfs_spin_unlock(&desc->bd_lock);
1417         return rc;
1418 }
1419 #endif
1420
1421 int ptlrpc_register_bulk(struct ptlrpc_request *req);
1422 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
1423
1424 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
1425 {
1426         struct ptlrpc_bulk_desc *desc = req->rq_bulk;
1427         int                      rc;
1428
1429         LASSERT(req != NULL);
1430
1431         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK) &&
1432             req->rq_bulk_deadline > cfs_time_current_sec())
1433                 return 1;
1434
1435         if (!desc)
1436                 return 0;
1437
1438         cfs_spin_lock(&desc->bd_lock);
1439         rc = desc->bd_network_rw;
1440         cfs_spin_unlock(&desc->bd_lock);
1441         return rc;
1442 }
1443
1444 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
1445 #define PTLRPC_REPLY_EARLY           0x02
1446 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
1447 int ptlrpc_reply(struct ptlrpc_request *req);
1448 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
1449 int ptlrpc_error(struct ptlrpc_request *req);
1450 void ptlrpc_resend_req(struct ptlrpc_request *request);
1451 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
1452 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
1453 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
1454 /** @} */
1455
1456 /* ptlrpc/client.c */
1457 /**
1458  * Client-side portals API. Everything to send requests, receive replies,
1459  * request queues, request management, etc.
1460  * @{
1461  */
1462 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
1463                         struct ptlrpc_client *);
1464 void ptlrpc_cleanup_client(struct obd_import *imp);
1465 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
1466
1467 int ptlrpc_queue_wait(struct ptlrpc_request *req);
1468 int ptlrpc_replay_req(struct ptlrpc_request *req);
1469 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
1470 void ptlrpc_restart_req(struct ptlrpc_request *req);
1471 void ptlrpc_abort_inflight(struct obd_import *imp);
1472 void ptlrpc_cleanup_imp(struct obd_import *imp);
1473 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
1474
1475 struct ptlrpc_request_set *ptlrpc_prep_set(void);
1476 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
1477                       set_interpreter_func fn, void *data);
1478 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
1479 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
1480 int ptlrpc_set_wait(struct ptlrpc_request_set *);
1481 int ptlrpc_expired_set(void *data);
1482 void ptlrpc_interrupted_set(void *data);
1483 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
1484 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
1485 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
1486 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1487                             struct ptlrpc_request *req);
1488
1489 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
1490 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
1491
1492 struct ptlrpc_request_pool *
1493 ptlrpc_init_rq_pool(int, int,
1494                     void (*populate_pool)(struct ptlrpc_request_pool *, int));
1495
1496 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
1497 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
1498                                             const struct req_format *format);
1499 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
1500                                             struct ptlrpc_request_pool *,
1501                                             const struct req_format *format);
1502 void ptlrpc_request_free(struct ptlrpc_request *request);
1503 int ptlrpc_request_pack(struct ptlrpc_request *request,
1504                         __u32 version, int opcode);
1505 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
1506                                                 const struct req_format *format,
1507                                                 __u32 version, int opcode);
1508 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
1509                              __u32 version, int opcode, char **bufs,
1510                              struct ptlrpc_cli_ctx *ctx);
1511 struct ptlrpc_request *ptlrpc_prep_fakereq(struct obd_import *imp,
1512                                            unsigned int timeout,
1513                                            ptlrpc_interpterer_t interpreter);
1514 void ptlrpc_fakereq_finished(struct ptlrpc_request *req);
1515
1516 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
1517                                        int opcode, int count, __u32 *lengths,
1518                                        char **bufs);
1519 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
1520                                              __u32 version, int opcode,
1521                                             int count, __u32 *lengths, char **bufs,
1522                                             struct ptlrpc_request_pool *pool);
1523 void ptlrpc_req_finished(struct ptlrpc_request *request);
1524 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
1525 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
1526 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
1527                                               int npages, int type, int portal);
1528 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
1529 void ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
1530                            cfs_page_t *page, int pageoffset, int len);
1531 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
1532                                       struct obd_import *imp);
1533 __u64 ptlrpc_next_xid(void);
1534 __u64 ptlrpc_sample_next_xid(void);
1535 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
1536
1537 /* Set of routines to run a function in ptlrpcd context */
1538 void *ptlrpcd_alloc_work(struct obd_import *imp,
1539                          int (*cb)(const struct lu_env *, void *), void *data);
1540 void ptlrpcd_destroy_work(void *handler);
1541 int ptlrpcd_queue_work(void *handler);
1542
1543 /** @} */
1544
1545 struct ptlrpc_service_conf {
1546         int psc_nbufs;
1547         int psc_bufsize;
1548         int psc_max_req_size;
1549         int psc_max_reply_size;
1550         int psc_req_portal;
1551         int psc_rep_portal;
1552         int psc_watchdog_factor;
1553         int psc_min_threads;
1554         int psc_max_threads;
1555         __u32 psc_ctx_tags;
1556 };
1557
1558 /* ptlrpc/service.c */
1559 /**
1560  * Server-side services API. Register/unregister service, request state
1561  * management, service thread management
1562  *
1563  * @{
1564  */
1565 void ptlrpc_save_lock(struct ptlrpc_request *req,
1566                       struct lustre_handle *lock, int mode, int no_ack);
1567 void ptlrpc_commit_replies(struct obd_export *exp);
1568 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
1569 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
1570 struct ptlrpc_service *ptlrpc_init_svc_conf(struct ptlrpc_service_conf *c,
1571                                             svc_handler_t h, char *name,
1572                                             struct proc_dir_entry *proc_entry,
1573                                             svc_req_printfn_t prntfn,
1574                                             char *threadname);
1575
1576 struct ptlrpc_service *ptlrpc_init_svc(int nbufs, int bufsize, int max_req_size,
1577                                        int max_reply_size,
1578                                        int req_portal, int rep_portal,
1579                                        int watchdog_factor,
1580                                        svc_handler_t, char *name,
1581                                        cfs_proc_dir_entry_t *proc_entry,
1582                                        svc_req_printfn_t,
1583                                        int min_threads, int max_threads,
1584                                        char *threadname, __u32 ctx_tags,
1585                                        svc_hpreq_handler_t);
1586 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
1587
1588 int ptlrpc_start_threads(struct ptlrpc_service *svc);
1589 int ptlrpc_start_thread(struct ptlrpc_service *svc);
1590 int ptlrpc_unregister_service(struct ptlrpc_service *service);
1591 int liblustre_check_services(void *arg);
1592 void ptlrpc_daemonize(char *name);
1593 int ptlrpc_service_health_check(struct ptlrpc_service *);
1594 void ptlrpc_hpreq_reorder(struct ptlrpc_request *req);
1595 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
1596
1597 #ifdef __KERNEL__
1598 int ptlrpc_hr_init(void);
1599 void ptlrpc_hr_fini(void);
1600 #else
1601 # define ptlrpc_hr_init() (0)
1602 # define ptlrpc_hr_fini() do {} while(0)
1603 #endif
1604
1605 struct ptlrpc_svc_data {
1606         char *name;
1607         struct ptlrpc_service *svc;
1608         struct ptlrpc_thread *thread;
1609 };
1610 /** @} */
1611
1612 /* ptlrpc/import.c */
1613 /**
1614  * Import API
1615  * @{
1616  */
1617 int ptlrpc_connect_import(struct obd_import *imp);
1618 int ptlrpc_init_import(struct obd_import *imp);
1619 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
1620 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
1621 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
1622                int *uuid_len);
1623
1624 /* ptlrpc/pack_generic.c */
1625 int ptlrpc_reconnect_import(struct obd_import *imp);
1626 /** @} */
1627
1628 /**
1629  * ptlrpc msg buffer and swab interface
1630  *
1631  * @{
1632  */
1633 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
1634                          int index);
1635 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
1636                                 int index);
1637 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
1638 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
1639
1640 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
1641 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
1642                         char **bufs);
1643 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
1644                         __u32 *lens, char **bufs);
1645 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
1646                       char **bufs);
1647 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
1648                          __u32 *lens, char **bufs, int flags);
1649 #define LPRFL_EARLY_REPLY 1
1650 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
1651                             char **bufs, int flags);
1652 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
1653                       unsigned int newlen, int move_data);
1654 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
1655 int __lustre_unpack_msg(struct lustre_msg *m, int len);
1656 int lustre_msg_hdr_size(__u32 magic, int count);
1657 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
1658 int lustre_msg_size_v2(int count, __u32 *lengths);
1659 int lustre_packed_msg_size(struct lustre_msg *msg);
1660 int lustre_msg_early_size(void);
1661 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
1662 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
1663 int lustre_msg_buflen(struct lustre_msg *m, int n);
1664 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
1665 int lustre_msg_bufcount(struct lustre_msg *m);
1666 char *lustre_msg_string(struct lustre_msg *m, int n, int max_len);
1667 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
1668 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
1669 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
1670 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
1671 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
1672 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
1673 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
1674 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
1675 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
1676 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
1677 __u32 lustre_msg_get_type(struct lustre_msg *msg);
1678 __u32 lustre_msg_get_version(struct lustre_msg *msg);
1679 void lustre_msg_add_version(struct lustre_msg *msg, int version);
1680 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
1681 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
1682 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
1683 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
1684 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
1685 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
1686 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
1687 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
1688 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
1689 int lustre_msg_get_status(struct lustre_msg *msg);
1690 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
1691 int lustre_msg_is_v1(struct lustre_msg *msg);
1692 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
1693 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
1694 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
1695 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
1696 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 9, 0, 0)
1697 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18);
1698 #else
1699 # warning "remove checksum compatibility support for b1_8"
1700 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
1701 #endif
1702 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
1703 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
1704 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
1705 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
1706 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
1707 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
1708 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
1709 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
1710 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
1711 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
1712 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
1713 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
1714 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
1715 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
1716
1717 static inline void
1718 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
1719                     unsigned int newlen, int move_data)
1720 {
1721         LASSERT(req->rq_reply_state);
1722         LASSERT(req->rq_repmsg);
1723         req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
1724                                            newlen, move_data);
1725 }
1726 /** @} */
1727
1728 /** Change request phase of \a req to \a new_phase */
1729 static inline void
1730 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
1731 {
1732         if (req->rq_phase == new_phase)
1733                 return;
1734
1735         if (new_phase == RQ_PHASE_UNREGISTERING) {
1736                 req->rq_next_phase = req->rq_phase;
1737                 if (req->rq_import)
1738                         cfs_atomic_inc(&req->rq_import->imp_unregistering);
1739         }
1740
1741         if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
1742                 if (req->rq_import)
1743                         cfs_atomic_dec(&req->rq_import->imp_unregistering);
1744         }
1745
1746         DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
1747                   ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
1748
1749         req->rq_phase = new_phase;
1750 }
1751
1752 /**
1753  * Returns true if request \a req got early reply and hard deadline is not met
1754  */
1755 static inline int
1756 ptlrpc_client_early(struct ptlrpc_request *req)
1757 {
1758         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
1759             req->rq_reply_deadline > cfs_time_current_sec())
1760                 return 0;
1761         return req->rq_early;
1762 }
1763
1764 /**
1765  * Returns true if we got real reply from server for this request
1766  */
1767 static inline int
1768 ptlrpc_client_replied(struct ptlrpc_request *req)
1769 {
1770         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
1771             req->rq_reply_deadline > cfs_time_current_sec())
1772                 return 0;
1773         return req->rq_replied;
1774 }
1775
1776 /** Returns true if request \a req is in process of receiving server reply */
1777 static inline int
1778 ptlrpc_client_recv(struct ptlrpc_request *req)
1779 {
1780         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
1781             req->rq_reply_deadline > cfs_time_current_sec())
1782                 return 1;
1783         return req->rq_receiving_reply;
1784 }
1785
1786 static inline int
1787 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
1788 {
1789         int rc;
1790
1791         cfs_spin_lock(&req->rq_lock);
1792         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
1793             req->rq_reply_deadline > cfs_time_current_sec()) {
1794                 cfs_spin_unlock(&req->rq_lock);
1795                 return 1;
1796         }
1797         rc = req->rq_receiving_reply || req->rq_must_unlink;
1798         cfs_spin_unlock(&req->rq_lock);
1799         return rc;
1800 }
1801
1802 static inline void
1803 ptlrpc_client_wake_req(struct ptlrpc_request *req)
1804 {
1805         if (req->rq_set == NULL)
1806                 cfs_waitq_signal(&req->rq_reply_waitq);
1807         else
1808                 cfs_waitq_signal(&req->rq_set->set_waitq);
1809 }
1810
1811 static inline void
1812 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
1813 {
1814         LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
1815         cfs_atomic_inc(&rs->rs_refcount);
1816 }
1817
1818 static inline void
1819 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
1820 {
1821         LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
1822         if (cfs_atomic_dec_and_test(&rs->rs_refcount))
1823                 lustre_free_reply_state(rs);
1824 }
1825
1826 /* Should only be called once per req */
1827 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
1828 {
1829         if (req->rq_reply_state == NULL)
1830                 return; /* shouldn't occur */
1831         ptlrpc_rs_decref(req->rq_reply_state);
1832         req->rq_reply_state = NULL;
1833         req->rq_repmsg = NULL;
1834 }
1835
1836 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
1837 {
1838         return lustre_msg_get_magic(req->rq_reqmsg);
1839 }
1840
1841 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
1842 {
1843         switch (req->rq_reqmsg->lm_magic) {
1844         case LUSTRE_MSG_MAGIC_V2:
1845                 return req->rq_reqmsg->lm_repsize;
1846         default:
1847                 LASSERTF(0, "incorrect message magic: %08x\n",
1848                          req->rq_reqmsg->lm_magic);
1849                 return -EFAULT;
1850         }
1851 }
1852
1853 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
1854 {
1855         if (req->rq_delay_limit != 0 &&
1856             cfs_time_before(cfs_time_add(req->rq_queued_time,
1857                                          cfs_time_seconds(req->rq_delay_limit)),
1858                             cfs_time_current())) {
1859                 return 1;
1860         }
1861         return 0;
1862 }
1863
1864 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
1865 {
1866         if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
1867                 cfs_spin_lock(&req->rq_lock);
1868                 req->rq_no_resend = 1;
1869                 cfs_spin_unlock(&req->rq_lock);
1870         }
1871         return req->rq_no_resend;
1872 }
1873
1874 /* ldlm/ldlm_lib.c */
1875 /**
1876  * Target client logic
1877  * @{
1878  */
1879 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
1880 int client_obd_cleanup(struct obd_device *obddev);
1881 int client_connect_import(const struct lu_env *env,
1882                           struct obd_export **exp, struct obd_device *obd,
1883                           struct obd_uuid *cluuid, struct obd_connect_data *,
1884                           void *localdata);
1885 int client_disconnect_export(struct obd_export *exp);
1886 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
1887                            int priority);
1888 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
1889 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
1890                             struct obd_uuid *uuid);
1891 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
1892 void client_destroy_import(struct obd_import *imp);
1893 /** @} */
1894
1895 #ifdef HAVE_SERVER_SUPPORT
1896 int server_disconnect_export(struct obd_export *exp);
1897 #endif
1898
1899 /* ptlrpc/pinger.c */
1900 /**
1901  * Pinger API (client side only)
1902  * @{
1903  */
1904 enum timeout_event {
1905         TIMEOUT_GRANT = 1
1906 };
1907 struct timeout_item;
1908 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
1909 int ptlrpc_pinger_add_import(struct obd_import *imp);
1910 int ptlrpc_pinger_del_import(struct obd_import *imp);
1911 int ptlrpc_add_timeout_client(int time, enum timeout_event event,
1912                               timeout_cb_t cb, void *data,
1913                               cfs_list_t *obd_list);
1914 int ptlrpc_del_timeout_client(cfs_list_t *obd_list,
1915                               enum timeout_event event);
1916 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
1917 int ptlrpc_obd_ping(struct obd_device *obd);
1918 cfs_time_t ptlrpc_suspend_wakeup_time(void);
1919 #ifdef __KERNEL__
1920 void ping_evictor_start(void);
1921 void ping_evictor_stop(void);
1922 #else
1923 #define ping_evictor_start()    do {} while (0)
1924 #define ping_evictor_stop()     do {} while (0)
1925 #endif
1926 int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req);
1927 /** @} */
1928
1929 /* ptlrpc daemon bind policy */
1930 typedef enum {
1931         /* all ptlrpcd threads are free mode */
1932         PDB_POLICY_NONE          = 1,
1933         /* all ptlrpcd threads are bound mode */
1934         PDB_POLICY_FULL          = 2,
1935         /* <free1 bound1> <free2 bound2> ... <freeN boundN> */
1936         PDB_POLICY_PAIR          = 3,
1937         /* <free1 bound1> <bound1 free2> ... <freeN boundN> <boundN free1>,
1938          * means each ptlrpcd[X] has two partners: thread[X-1] and thread[X+1].
1939          * If kernel supports NUMA, pthrpcd threads are binded and
1940          * grouped by NUMA node */
1941         PDB_POLICY_NEIGHBOR      = 4,
1942 } pdb_policy_t;
1943
1944 /* ptlrpc daemon load policy
1945  * It is caller's duty to specify how to push the async RPC into some ptlrpcd
1946  * queue, but it is not enforced, affected by "ptlrpcd_bind_policy". If it is
1947  * "PDB_POLICY_FULL", then the RPC will be processed by the selected ptlrpcd,
1948  * Otherwise, the RPC may be processed by the selected ptlrpcd or its partner,
1949  * depends on which is scheduled firstly, to accelerate the RPC processing. */
1950 typedef enum {
1951         /* on the same CPU core as the caller */
1952         PDL_POLICY_SAME         = 1,
1953         /* within the same CPU partition, but not the same core as the caller */
1954         PDL_POLICY_LOCAL        = 2,
1955         /* round-robin on all CPU cores, but not the same core as the caller */
1956         PDL_POLICY_ROUND        = 3,
1957         /* the specified CPU core is preferred, but not enforced */
1958         PDL_POLICY_PREFERRED    = 4,
1959 } pdl_policy_t;
1960
1961 /* ptlrpc/ptlrpcd.c */
1962 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
1963 void ptlrpcd_wake(struct ptlrpc_request *req);
1964 void ptlrpcd_add_req(struct ptlrpc_request *req, pdl_policy_t policy, int idx);
1965 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
1966 int ptlrpcd_addref(void);
1967 void ptlrpcd_decref(void);
1968
1969 /* ptlrpc/lproc_ptlrpc.c */
1970 /**
1971  * procfs output related functions
1972  * @{
1973  */
1974 const char* ll_opcode2str(__u32 opcode);
1975 #ifdef LPROCFS
1976 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
1977 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
1978 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
1979 #else
1980 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
1981 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
1982 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
1983 #endif
1984 /** @} */
1985
1986 /* ptlrpc/llog_server.c */
1987 int llog_origin_handle_create(struct ptlrpc_request *req);
1988 int llog_origin_handle_destroy(struct ptlrpc_request *req);
1989 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
1990 int llog_origin_handle_next_block(struct ptlrpc_request *req);
1991 int llog_origin_handle_read_header(struct ptlrpc_request *req);
1992 int llog_origin_handle_close(struct ptlrpc_request *req);
1993 int llog_origin_handle_cancel(struct ptlrpc_request *req);
1994 int llog_catinfo(struct ptlrpc_request *req);
1995
1996 /* ptlrpc/llog_client.c */
1997 extern struct llog_operations llog_client_ops;
1998
1999 /** @} net */
2000
2001 #endif
2002 /** @} PtlRPC */