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