lustre/include/lustre_net.h

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