4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup PtlRPC Portal RPC and networking module.
38 * PortalRPC is the layer used by rest of lustre code to achieve network
39 * communications: establish connections with corresponding export and import
40 * states, listen for a service, send and receive RPCs.
41 * PortalRPC also includes base recovery framework: packet resending and
42 * replaying, reconnections, pinger.
44 * PortalRPC utilizes LNet as its transport layer.
58 #if defined(__linux__)
59 #include <linux/lustre_net.h>
60 #elif defined(__APPLE__)
61 #include <darwin/lustre_net.h>
62 #elif defined(__WINNT__)
63 #include <winnt/lustre_net.h>
65 #error Unsupported operating system.
68 #include <libcfs/libcfs.h>
70 #include <lnet/lnet.h>
71 #include <lustre/lustre_idl.h>
72 #include <lustre_ha.h>
73 #include <lustre_sec.h>
74 #include <lustre_import.h>
75 #include <lprocfs_status.h>
76 #include <lu_object.h>
77 #include <lustre_req_layout.h>
79 #include <obd_support.h>
80 #include <lustre_ver.h>
82 /* MD flags we _always_ use */
83 #define PTLRPC_MD_OPTIONS 0
86 * Define maxima for bulk I/O
87 * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
88 * these limits are system wide and not interface-local. */
89 #define PTLRPC_MAX_BRW_BITS LNET_MTU_BITS
90 #define PTLRPC_MAX_BRW_SIZE (1<<LNET_MTU_BITS)
91 #define PTLRPC_MAX_BRW_PAGES (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
93 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
95 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
96 # error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
98 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
99 # error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
101 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU)
102 # error "PTLRPC_MAX_BRW_SIZE too big"
104 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV)
105 # error "PTLRPC_MAX_BRW_PAGES too big"
107 #endif /* __KERNEL__ */
109 #define PTLRPC_NTHRS_INIT 2
114 * Constants determine how memory is used to buffer incoming service requests.
116 * ?_NBUFS # buffers to allocate when growing the pool
117 * ?_BUFSIZE # bytes in a single request buffer
118 * ?_MAXREQSIZE # maximum request service will receive
120 * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
121 * of ?_NBUFS is added to the pool.
123 * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are
124 * considered full when less than ?_MAXREQSIZE is left in them.
129 * Constants determine how threads are created for ptlrpc service.
131 * ?_NTHRS_INIT # threads to create for each service partition on
132 * initializing. If it's non-affinity service and
133 * there is only one partition, it's the overall #
134 * threads for the service while initializing.
135 * ?_NTHRS_BASE # threads should be created at least for each
136 * ptlrpc partition to keep the service healthy.
137 * It's the low-water mark of threads upper-limit
138 * for each partition.
139 * ?_THR_FACTOR # threads can be added on threads upper-limit for
140 * each CPU core. This factor is only for reference,
141 * we might decrease value of factor if number of cores
142 * per CPT is above a limit.
143 * ?_NTHRS_MAX # overall threads can be created for a service,
144 * it's a soft limit because if service is running
145 * on machine with hundreds of cores and tens of
146 * CPU partitions, we need to guarantee each partition
147 * has ?_NTHRS_BASE threads, which means total threads
148 * will be ?_NTHRS_BASE * number_of_cpts which can
149 * exceed ?_NTHRS_MAX.
153 * #define MDT_NTHRS_INIT 2
154 * #define MDT_NTHRS_BASE 64
155 * #define MDT_NTHRS_FACTOR 8
156 * #define MDT_NTHRS_MAX 1024
159 * ---------------------------------------------------------------------
160 * Server(A) has 16 cores, user configured it to 4 partitions so each
161 * partition has 4 cores, then actual number of service threads on each
163 * MDT_NTHRS_BASE(64) + cores(4) * MDT_NTHRS_FACTOR(8) = 96
165 * Total number of threads for the service is:
166 * 96 * partitions(4) = 384
169 * ---------------------------------------------------------------------
170 * Server(B) has 32 cores, user configured it to 4 partitions so each
171 * partition has 8 cores, then actual number of service threads on each
173 * MDT_NTHRS_BASE(64) + cores(8) * MDT_NTHRS_FACTOR(8) = 128
175 * Total number of threads for the service is:
176 * 128 * partitions(4) = 512
179 * ---------------------------------------------------------------------
180 * Server(B) has 96 cores, user configured it to 8 partitions so each
181 * partition has 12 cores, then actual number of service threads on each
183 * MDT_NTHRS_BASE(64) + cores(12) * MDT_NTHRS_FACTOR(8) = 160
185 * Total number of threads for the service is:
186 * 160 * partitions(8) = 1280
188 * However, it's above the soft limit MDT_NTHRS_MAX, so we choose this number
189 * as upper limit of threads number for each partition:
190 * MDT_NTHRS_MAX(1024) / partitions(8) = 128
193 * ---------------------------------------------------------------------
194 * Server(C) have a thousand of cores and user configured it to 32 partitions
195 * MDT_NTHRS_BASE(64) * 32 = 2048
197 * which is already above soft limit MDT_NTHRS_MAX(1024), but we still need
198 * to guarantee that each partition has at least MDT_NTHRS_BASE(64) threads
199 * to keep service healthy, so total number of threads will just be 2048.
201 * NB: we don't suggest to choose server with that many cores because backend
202 * filesystem itself, buffer cache, or underlying network stack might
203 * have some SMP scalability issues at that large scale.
205 * If user already has a fat machine with hundreds or thousands of cores,
206 * there are two choices for configuration:
207 * a) create CPU table from subset of all CPUs and run Lustre on
209 * b) bind service threads on a few partitions, see modparameters of
210 * MDS and OSS for details
212 * NB: these calculations (and examples below) are simplified to help
213 * understanding, the real implementation is a little more complex,
214 * please see ptlrpc_server_nthreads_check() for details.
219 * LDLM threads constants:
221 * Given 8 as factor and 24 as base threads number
224 * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
227 * On 8-core machine with 2 partitions we will have 24 + 4 * 8 = 56
228 * threads for each partition and total threads number will be 112.
231 * On 64-core machine with 8 partitions we will need LDLM_NTHRS_BASE(24)
232 * threads for each partition to keep service healthy, so total threads
233 * number should be 24 * 8 = 192.
235 * So with these constants, threads number wil be at the similar level
236 * of old versions, unless target machine has over a hundred cores
238 #define LDLM_THR_FACTOR 8
239 #define LDLM_NTHRS_INIT PTLRPC_NTHRS_INIT
240 #define LDLM_NTHRS_BASE 24
241 #define LDLM_NTHRS_MAX (cfs_num_online_cpus() == 1 ? 64 : 128)
243 #define LDLM_BL_THREADS LDLM_NTHRS_AUTO_INIT
244 #define LDLM_NBUFS (64 * cfs_num_online_cpus())
245 #define LDLM_BUFSIZE (8 * 1024)
246 #define LDLM_MAXREQSIZE (5 * 1024)
247 #define LDLM_MAXREPSIZE (1024)
250 * MDS threads constants:
252 * Please see examples in "Thread Constants", MDS threads number will be at
253 * the comparable level of old versions, unless the server has many cores.
255 #ifndef MDT_MAX_THREADS
256 #define MDT_MAX_THREADS 1024
257 #define MDT_MAX_OTHR_THREADS 256
259 #else /* MDT_MAX_THREADS */
260 #if MDT_MAX_THREADS < PTLRPC_NTHRS_INIT
261 #undef MDT_MAX_THREADS
262 #define MDT_MAX_THREADS PTLRPC_NTHRS_INIT
264 #define MDT_MAX_OTHR_THREADS max(PTLRPC_NTHRS_INIT, MDT_MAX_THREADS / 2)
267 /* default service */
268 #define MDT_THR_FACTOR 8
269 #define MDT_NTHRS_INIT PTLRPC_NTHRS_INIT
270 #define MDT_NTHRS_MAX MDT_MAX_THREADS
271 #define MDT_NTHRS_BASE min(64, MDT_NTHRS_MAX)
273 /* read-page service */
274 #define MDT_RDPG_THR_FACTOR 4
275 #define MDT_RDPG_NTHRS_INIT PTLRPC_NTHRS_INIT
276 #define MDT_RDPG_NTHRS_MAX MDT_MAX_OTHR_THREADS
277 #define MDT_RDPG_NTHRS_BASE min(48, MDT_RDPG_NTHRS_MAX)
279 /* these should be removed when we remove setattr service in the future */
280 #define MDT_SETA_THR_FACTOR 4
281 #define MDT_SETA_NTHRS_INIT PTLRPC_NTHRS_INIT
282 #define MDT_SETA_NTHRS_MAX MDT_MAX_OTHR_THREADS
283 #define MDT_SETA_NTHRS_BASE min(48, MDT_SETA_NTHRS_MAX)
285 /* non-affinity threads */
286 #define MDT_OTHR_NTHRS_INIT PTLRPC_NTHRS_INIT
287 #define MDT_OTHR_NTHRS_MAX MDT_MAX_OTHR_THREADS
289 #define MDS_NBUFS (64 * cfs_num_online_cpus())
291 * Assume file name length = FNAME_MAX = 256 (true for ext3).
292 * path name length = PATH_MAX = 4096
293 * LOV MD size max = EA_MAX = 48000 (2000 stripes)
294 * symlink: FNAME_MAX + PATH_MAX <- largest
295 * link: FNAME_MAX + PATH_MAX (mds_rec_link < mds_rec_create)
296 * rename: FNAME_MAX + FNAME_MAX
297 * open: FNAME_MAX + EA_MAX
299 * MDS_MAXREQSIZE ~= 4736 bytes =
300 * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
301 * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
302 * or, for mds_close() and mds_reint_unlink() on a many-OST filesystem:
303 * = 9210 bytes = lustre_msg + mdt_body + 160 * (easize + cookiesize)
305 * Realistic size is about 512 bytes (20 character name + 128 char symlink),
306 * except in the open case where there are a large number of OSTs in a LOV.
308 #define MDS_MAXREPSIZE max(10 * 1024, 362 + LOV_MAX_STRIPE_COUNT * 56)
309 #define MDS_MAXREQSIZE MDS_MAXREPSIZE
311 /** MDS_BUFSIZE = max_reqsize + max sptlrpc payload size */
312 #define MDS_BUFSIZE (MDS_MAXREQSIZE + 1024)
314 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
315 #define FLD_MAXREQSIZE (160)
317 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
318 #define FLD_MAXREPSIZE (152)
321 * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
323 #define SEQ_MAXREQSIZE (160)
325 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
326 #define SEQ_MAXREPSIZE (152)
328 /** MGS threads must be >= 3, see bug 22458 comment #28 */
329 #define MGS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
330 #define MGS_NTHRS_MAX 32
332 #define MGS_NBUFS (64 * cfs_num_online_cpus())
333 #define MGS_BUFSIZE (8 * 1024)
334 #define MGS_MAXREQSIZE (7 * 1024)
335 #define MGS_MAXREPSIZE (9 * 1024)
338 * OSS threads constants:
340 * Given 8 as factor and 64 as base threads number
343 * On 8-core server configured to 2 partitions, we will have
344 * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
347 * On 32-core machine configured to 4 partitions, we will have
348 * 64 + 8 * 8 = 112 threads for each partition, so total threads number
349 * will be 112 * 4 = 448.
352 * On 64-core machine configured to 4 partitions, we will have
353 * 64 + 16 * 8 = 192 threads for each partition, so total threads number
354 * will be 192 * 4 = 768 which is above limit OSS_NTHRS_MAX(512), so we
355 * cut off the value to OSS_NTHRS_MAX(512) / 4 which is 128 threads
356 * for each partition.
358 * So we can see that with these constants, threads number wil be at the
359 * similar level of old versions, unless the server has many cores.
361 /* depress threads factor for VM with small memory size */
362 #define OSS_THR_FACTOR min_t(int, 8, \
363 CFS_NUM_CACHEPAGES >> (28 - CFS_PAGE_SHIFT))
364 #define OSS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
365 #define OSS_NTHRS_BASE 64
366 #define OSS_NTHRS_MAX 512
368 /* threads for handling "create" request */
369 #define OSS_CR_THR_FACTOR 1
370 #define OSS_CR_NTHRS_INIT PTLRPC_NTHRS_INIT
371 #define OSS_CR_NTHRS_BASE 8
372 #define OSS_CR_NTHRS_MAX 64
374 #define OST_NBUFS (64 * cfs_num_online_cpus())
375 #define OST_BUFSIZE (8 * 1024)
378 * OST_MAXREQSIZE ~= 4768 bytes =
379 * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote
381 * - single object with 16 pages is 512 bytes
382 * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
384 #define OST_MAXREQSIZE (5 * 1024)
385 #define OST_MAXREPSIZE (9 * 1024)
387 /* Macro to hide a typecast. */
388 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
391 * Structure to single define portal connection.
393 struct ptlrpc_connection {
394 /** linkage for connections hash table */
395 cfs_hlist_node_t c_hash;
396 /** Our own lnet nid for this connection */
398 /** Remote side nid for this connection */
399 lnet_process_id_t c_peer;
400 /** UUID of the other side */
401 struct obd_uuid c_remote_uuid;
402 /** reference counter for this connection */
403 cfs_atomic_t c_refcount;
406 /** Client definition for PortalRPC */
407 struct ptlrpc_client {
408 /** What lnet portal does this client send messages to by default */
409 __u32 cli_request_portal;
410 /** What portal do we expect replies on */
411 __u32 cli_reply_portal;
412 /** Name of the client */
416 /** state flags of requests */
417 /* XXX only ones left are those used by the bulk descs as well! */
418 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
419 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
421 #define REQ_MAX_ACK_LOCKS 8
423 union ptlrpc_async_args {
425 * Scratchpad for passing args to completion interpreter. Users
426 * cast to the struct of their choosing, and CLASSERT that this is
427 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
428 * a pointer to it here. The pointer_arg ensures this struct is at
429 * least big enough for that.
431 void *pointer_arg[11];
435 struct ptlrpc_request_set;
436 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
437 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
440 * Definition of request set structure.
441 * Request set is a list of requests (not necessary to the same target) that
442 * once populated with RPCs could be sent in parallel.
443 * There are two kinds of request sets. General purpose and with dedicated
444 * serving thread. Example of the latter is ptlrpcd set.
445 * For general purpose sets once request set started sending it is impossible
446 * to add new requests to such set.
447 * Provides a way to call "completion callbacks" when all requests in the set
450 struct ptlrpc_request_set {
451 cfs_atomic_t set_refcount;
452 /** number of in queue requests */
453 cfs_atomic_t set_new_count;
454 /** number of uncompleted requests */
455 cfs_atomic_t set_remaining;
456 /** wait queue to wait on for request events */
457 cfs_waitq_t set_waitq;
458 cfs_waitq_t *set_wakeup_ptr;
459 /** List of requests in the set */
460 cfs_list_t set_requests;
462 * List of completion callbacks to be called when the set is completed
463 * This is only used if \a set_interpret is NULL.
464 * Links struct ptlrpc_set_cbdata.
466 cfs_list_t set_cblist;
467 /** Completion callback, if only one. */
468 set_interpreter_func set_interpret;
469 /** opaq argument passed to completion \a set_interpret callback. */
472 * Lock for \a set_new_requests manipulations
473 * locked so that any old caller can communicate requests to
474 * the set holder who can then fold them into the lock-free set
476 cfs_spinlock_t set_new_req_lock;
477 /** List of new yet unsent requests. Only used with ptlrpcd now. */
478 cfs_list_t set_new_requests;
480 /** rq_status of requests that have been freed already */
482 /** Additional fields used by the flow control extension */
483 /** Maximum number of RPCs in flight */
484 int set_max_inflight;
485 /** Callback function used to generate RPCs */
486 set_producer_func set_producer;
487 /** opaq argument passed to the producer callback */
488 void *set_producer_arg;
492 * Description of a single ptrlrpc_set callback
494 struct ptlrpc_set_cbdata {
495 /** List linkage item */
497 /** Pointer to interpreting function */
498 set_interpreter_func psc_interpret;
499 /** Opaq argument to pass to the callback */
503 struct ptlrpc_bulk_desc;
504 struct ptlrpc_service_part;
507 * ptlrpc callback & work item stuff
509 struct ptlrpc_cb_id {
510 void (*cbid_fn)(lnet_event_t *ev); /* specific callback fn */
511 void *cbid_arg; /* additional arg */
514 /** Maximum number of locks to fit into reply state */
515 #define RS_MAX_LOCKS 8
519 * Structure to define reply state on the server
520 * Reply state holds various reply message information. Also for "difficult"
521 * replies (rep-ack case) we store the state after sending reply and wait
522 * for the client to acknowledge the reception. In these cases locks could be
523 * added to the state for replay/failover consistency guarantees.
525 struct ptlrpc_reply_state {
526 /** Callback description */
527 struct ptlrpc_cb_id rs_cb_id;
528 /** Linkage for list of all reply states in a system */
530 /** Linkage for list of all reply states on same export */
531 cfs_list_t rs_exp_list;
532 /** Linkage for list of all reply states for same obd */
533 cfs_list_t rs_obd_list;
535 cfs_list_t rs_debug_list;
537 /** A spinlock to protect the reply state flags */
538 cfs_spinlock_t rs_lock;
539 /** Reply state flags */
540 unsigned long rs_difficult:1; /* ACK/commit stuff */
541 unsigned long rs_no_ack:1; /* no ACK, even for
542 difficult requests */
543 unsigned long rs_scheduled:1; /* being handled? */
544 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
545 unsigned long rs_handled:1; /* been handled yet? */
546 unsigned long rs_on_net:1; /* reply_out_callback pending? */
547 unsigned long rs_prealloc:1; /* rs from prealloc list */
548 unsigned long rs_committed:1;/* the transaction was committed
549 and the rs was dispatched
550 by ptlrpc_commit_replies */
551 /** Size of the state */
555 /** Transaction number */
559 struct obd_export *rs_export;
560 struct ptlrpc_service_part *rs_svcpt;
561 /** Lnet metadata handle for the reply */
562 lnet_handle_md_t rs_md_h;
563 cfs_atomic_t rs_refcount;
565 /** Context for the sevice thread */
566 struct ptlrpc_svc_ctx *rs_svc_ctx;
567 /** Reply buffer (actually sent to the client), encoded if needed */
568 struct lustre_msg *rs_repbuf; /* wrapper */
569 /** Size of the reply buffer */
570 int rs_repbuf_len; /* wrapper buf length */
571 /** Size of the reply message */
572 int rs_repdata_len; /* wrapper msg length */
574 * Actual reply message. Its content is encrupted (if needed) to
575 * produce reply buffer for actual sending. In simple case
576 * of no network encryption we jus set \a rs_repbuf to \a rs_msg
578 struct lustre_msg *rs_msg; /* reply message */
580 /** Number of locks awaiting client ACK */
582 /** Handles of locks awaiting client reply ACK */
583 struct lustre_handle rs_locks[RS_MAX_LOCKS];
584 /** Lock modes of locks in \a rs_locks */
585 ldlm_mode_t rs_modes[RS_MAX_LOCKS];
588 struct ptlrpc_thread;
592 RQ_PHASE_NEW = 0xebc0de00,
593 RQ_PHASE_RPC = 0xebc0de01,
594 RQ_PHASE_BULK = 0xebc0de02,
595 RQ_PHASE_INTERPRET = 0xebc0de03,
596 RQ_PHASE_COMPLETE = 0xebc0de04,
597 RQ_PHASE_UNREGISTERING = 0xebc0de05,
598 RQ_PHASE_UNDEFINED = 0xebc0de06
601 /** Type of request interpreter call-back */
602 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
603 struct ptlrpc_request *req,
607 * Definition of request pool structure.
608 * The pool is used to store empty preallocated requests for the case
609 * when we would actually need to send something without performing
610 * any allocations (to avoid e.g. OOM).
612 struct ptlrpc_request_pool {
613 /** Locks the list */
614 cfs_spinlock_t prp_lock;
615 /** list of ptlrpc_request structs */
616 cfs_list_t prp_req_list;
617 /** Maximum message size that would fit into a rquest from this pool */
619 /** Function to allocate more requests for this pool */
620 void (*prp_populate)(struct ptlrpc_request_pool *, int);
629 * Basic request prioritization operations structure.
630 * The whole idea is centered around locks and RPCs that might affect locks.
631 * When a lock is contended we try to give priority to RPCs that might lead
632 * to fastest release of that lock.
633 * Currently only implemented for OSTs only in a way that makes all
634 * IO and truncate RPCs that are coming from a locked region where a lock is
635 * contended a priority over other requests.
637 struct ptlrpc_hpreq_ops {
639 * Check if the lock handle of the given lock is the same as
640 * taken from the request.
642 int (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
644 * Check if the request is a high priority one.
646 int (*hpreq_check)(struct ptlrpc_request *);
648 * Called after the request has been handled.
650 void (*hpreq_fini)(struct ptlrpc_request *);
654 * Represents remote procedure call.
656 * This is a staple structure used by everybody wanting to send a request
659 struct ptlrpc_request {
660 /* Request type: one of PTL_RPC_MSG_* */
663 * Linkage item through which this request is included into
664 * sending/delayed lists on client and into rqbd list on server
668 * Server side list of incoming unserved requests sorted by arrival
669 * time. Traversed from time to time to notice about to expire
670 * requests and sent back "early replies" to clients to let them
671 * know server is alive and well, just very busy to service their
674 cfs_list_t rq_timed_list;
675 /** server-side history, used for debuging purposes. */
676 cfs_list_t rq_history_list;
677 /** server-side per-export list */
678 cfs_list_t rq_exp_list;
679 /** server-side hp handlers */
680 struct ptlrpc_hpreq_ops *rq_ops;
681 /** history sequence # */
682 __u64 rq_history_seq;
683 /** the index of service's srv_at_array into which request is linked */
685 /** Result of request processing */
687 /** Lock to protect request flags and some other important bits, like
690 cfs_spinlock_t rq_lock;
691 /** client-side flags are serialized by rq_lock */
692 unsigned long rq_intr:1, rq_replied:1, rq_err:1,
693 rq_timedout:1, rq_resend:1, rq_restart:1,
695 * when ->rq_replay is set, request is kept by the client even
696 * after server commits corresponding transaction. This is
697 * used for operations that require sequence of multiple
698 * requests to be replayed. The only example currently is file
699 * open/close. When last request in such a sequence is
700 * committed, ->rq_replay is cleared on all requests in the
704 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
705 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
706 rq_early:1, rq_must_unlink:1,
707 rq_fake:1, /* this fake req */
708 rq_memalloc:1, /* req originated from "kswapd" */
709 /* server-side flags */
710 rq_packed_final:1, /* packed final reply */
711 rq_hp:1, /* high priority RPC */
712 rq_at_linked:1, /* link into service's srv_at_array */
715 /* whether the "rq_set" is a valid one */
719 enum rq_phase rq_phase; /* one of RQ_PHASE_* */
720 enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
721 cfs_atomic_t rq_refcount;/* client-side refcount for SENT race,
722 server-side refcounf for multiple replies */
724 /** initial thread servicing this request */
725 struct ptlrpc_thread *rq_svc_thread;
727 /** Portal to which this request would be sent */
728 int rq_request_portal; /* XXX FIXME bug 249 */
729 /** Portal where to wait for reply and where reply would be sent */
730 int rq_reply_portal; /* XXX FIXME bug 249 */
734 * !rq_truncate : # reply bytes actually received,
735 * rq_truncate : required repbuf_len for resend
738 /** Request length */
740 /** Request message - what client sent */
741 struct lustre_msg *rq_reqmsg;
745 /** Reply message - server response */
746 struct lustre_msg *rq_repmsg;
747 /** Transaction number */
752 * List item to for replay list. Not yet commited requests get linked
754 * Also see \a rq_replay comment above.
756 cfs_list_t rq_replay_list;
759 * security and encryption data
761 struct ptlrpc_cli_ctx *rq_cli_ctx; /**< client's half ctx */
762 struct ptlrpc_svc_ctx *rq_svc_ctx; /**< server's half ctx */
763 cfs_list_t rq_ctx_chain; /**< link to waited ctx */
765 struct sptlrpc_flavor rq_flvr; /**< for client & server */
766 enum lustre_sec_part rq_sp_from;
768 unsigned long /* client/server security flags */
769 rq_ctx_init:1, /* context initiation */
770 rq_ctx_fini:1, /* context destroy */
771 rq_bulk_read:1, /* request bulk read */
772 rq_bulk_write:1, /* request bulk write */
773 /* server authentication flags */
774 rq_auth_gss:1, /* authenticated by gss */
775 rq_auth_remote:1, /* authed as remote user */
776 rq_auth_usr_root:1, /* authed as root */
777 rq_auth_usr_mdt:1, /* authed as mdt */
778 rq_auth_usr_ost:1, /* authed as ost */
779 /* security tfm flags */
782 /* doesn't expect reply FIXME */
784 rq_pill_init:1; /* pill initialized */
786 uid_t rq_auth_uid; /* authed uid */
787 uid_t rq_auth_mapped_uid; /* authed uid mapped to */
789 /* (server side), pointed directly into req buffer */
790 struct ptlrpc_user_desc *rq_user_desc;
792 /** early replies go to offset 0, regular replies go after that */
793 unsigned int rq_reply_off;
795 /* various buffer pointers */
796 struct lustre_msg *rq_reqbuf; /* req wrapper */
797 int rq_reqbuf_len; /* req wrapper buf len */
798 int rq_reqdata_len; /* req wrapper msg len */
799 char *rq_repbuf; /* rep buffer */
800 int rq_repbuf_len; /* rep buffer len */
801 struct lustre_msg *rq_repdata; /* rep wrapper msg */
802 int rq_repdata_len; /* rep wrapper msg len */
803 struct lustre_msg *rq_clrbuf; /* only in priv mode */
804 int rq_clrbuf_len; /* only in priv mode */
805 int rq_clrdata_len; /* only in priv mode */
809 /** Fields that help to see if request and reply were swabbed or not */
810 __u32 rq_req_swab_mask;
811 __u32 rq_rep_swab_mask;
813 /** What was import generation when this request was sent */
814 int rq_import_generation;
815 enum lustre_imp_state rq_send_state;
817 /** how many early replies (for stats) */
820 /** client+server request */
821 lnet_handle_md_t rq_req_md_h;
822 struct ptlrpc_cb_id rq_req_cbid;
823 /** optional time limit for send attempts */
824 cfs_duration_t rq_delay_limit;
825 /** time request was first queued */
826 cfs_time_t rq_queued_time;
829 /** request arrival time */
830 struct timeval rq_arrival_time;
831 /** separated reply state */
832 struct ptlrpc_reply_state *rq_reply_state;
833 /** incoming request buffer */
834 struct ptlrpc_request_buffer_desc *rq_rqbd;
836 /** client-only incoming reply */
837 lnet_handle_md_t rq_reply_md_h;
838 cfs_waitq_t rq_reply_waitq;
839 struct ptlrpc_cb_id rq_reply_cbid;
843 /** Peer description (the other side) */
844 lnet_process_id_t rq_peer;
845 /** Server-side, export on which request was received */
846 struct obd_export *rq_export;
847 /** Client side, import where request is being sent */
848 struct obd_import *rq_import;
850 /** Replay callback, called after request is replayed at recovery */
851 void (*rq_replay_cb)(struct ptlrpc_request *);
853 * Commit callback, called when request is committed and about to be
856 void (*rq_commit_cb)(struct ptlrpc_request *);
857 /** Opaq data for replay and commit callbacks. */
860 /** For bulk requests on client only: bulk descriptor */
861 struct ptlrpc_bulk_desc *rq_bulk;
863 /** client outgoing req */
865 * when request/reply sent (secs), or time when request should be sent
868 /** time for request really sent out */
871 /** when request must finish. volatile
872 * so that servers' early reply updates to the deadline aren't
873 * kept in per-cpu cache */
874 volatile time_t rq_deadline;
875 /** when req reply unlink must finish. */
876 time_t rq_reply_deadline;
877 /** when req bulk unlink must finish. */
878 time_t rq_bulk_deadline;
880 * service time estimate (secs)
881 * If the requestsis not served by this time, it is marked as timed out.
885 /** Multi-rpc bits */
886 /** Link item for request set lists */
887 cfs_list_t rq_set_chain;
888 /** Per-request waitq introduced by bug 21938 for recovery waiting */
889 cfs_waitq_t rq_set_waitq;
890 /** Link back to the request set */
891 struct ptlrpc_request_set *rq_set;
892 /** Async completion handler, called when reply is received */
893 ptlrpc_interpterer_t rq_interpret_reply;
894 /** Async completion context */
895 union ptlrpc_async_args rq_async_args;
897 /** Pool if request is from preallocated list */
898 struct ptlrpc_request_pool *rq_pool;
900 struct lu_context rq_session;
901 struct lu_context rq_recov_session;
903 /** request format description */
904 struct req_capsule rq_pill;
908 * Call completion handler for rpc if any, return it's status or original
909 * rc if there was no handler defined for this request.
911 static inline int ptlrpc_req_interpret(const struct lu_env *env,
912 struct ptlrpc_request *req, int rc)
914 if (req->rq_interpret_reply != NULL) {
915 req->rq_status = req->rq_interpret_reply(env, req,
918 return req->rq_status;
924 * Returns 1 if request buffer at offset \a index was already swabbed
926 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
928 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
929 return req->rq_req_swab_mask & (1 << index);
933 * Returns 1 if request reply buffer at offset \a index was already swabbed
935 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
937 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
938 return req->rq_rep_swab_mask & (1 << index);
942 * Returns 1 if request needs to be swabbed into local cpu byteorder
944 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
946 return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
950 * Returns 1 if request reply needs to be swabbed into local cpu byteorder
952 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
954 return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
958 * Mark request buffer at offset \a index that it was already swabbed
960 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
962 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
963 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
964 req->rq_req_swab_mask |= 1 << index;
968 * Mark request reply buffer at offset \a index that it was already swabbed
970 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
972 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
973 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
974 req->rq_rep_swab_mask |= 1 << index;
978 * Convert numerical request phase value \a phase into text string description
980 static inline const char *
981 ptlrpc_phase2str(enum rq_phase phase)
990 case RQ_PHASE_INTERPRET:
992 case RQ_PHASE_COMPLETE:
994 case RQ_PHASE_UNREGISTERING:
995 return "Unregistering";
1002 * Convert numerical request phase of the request \a req into text stringi
1005 static inline const char *
1006 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1008 return ptlrpc_phase2str(req->rq_phase);
1012 * Debugging functions and helpers to print request structure into debug log
1015 /* Spare the preprocessor, spoil the bugs. */
1016 #define FLAG(field, str) (field ? str : "")
1018 /** Convert bit flags into a string */
1019 #define DEBUG_REQ_FLAGS(req) \
1020 ptlrpc_rqphase2str(req), \
1021 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
1022 FLAG(req->rq_err, "E"), \
1023 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
1024 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
1025 FLAG(req->rq_no_resend, "N"), \
1026 FLAG(req->rq_waiting, "W"), \
1027 FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \
1028 FLAG(req->rq_committed, "M")
1030 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s"
1032 void _debug_req(struct ptlrpc_request *req,
1033 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1034 __attribute__ ((format (printf, 3, 4)));
1037 * Helper that decides if we need to print request accordig to current debug
1040 #define debug_req(msgdata, mask, cdls, req, fmt, a...) \
1042 CFS_CHECK_STACK(msgdata, mask, cdls); \
1044 if (((mask) & D_CANTMASK) != 0 || \
1045 ((libcfs_debug & (mask)) != 0 && \
1046 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1047 _debug_req((req), msgdata, fmt, ##a); \
1051 * This is the debug print function you need to use to print request sturucture
1052 * content into lustre debug log.
1053 * for most callers (level is a constant) this is resolved at compile time */
1054 #define DEBUG_REQ(level, req, fmt, args...) \
1056 if ((level) & (D_ERROR | D_WARNING)) { \
1057 static cfs_debug_limit_state_t cdls; \
1058 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1059 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1061 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1062 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
1068 * Structure that defines a single page of a bulk transfer
1070 struct ptlrpc_bulk_page {
1071 /** Linkage to list of pages in a bulk */
1074 * Number of bytes in a page to transfer starting from \a bp_pageoffset
1077 /** offset within a page */
1079 /** The page itself */
1080 struct page *bp_page;
1083 #define BULK_GET_SOURCE 0
1084 #define BULK_PUT_SINK 1
1085 #define BULK_GET_SINK 2
1086 #define BULK_PUT_SOURCE 3
1089 * Definition of buk descriptor.
1090 * Bulks are special "Two phase" RPCs where initial request message
1091 * is sent first and it is followed bt a transfer (o receiving) of a large
1092 * amount of data to be settled into pages referenced from the bulk descriptors.
1093 * Bulks transfers (the actual data following the small requests) are done
1094 * on separate LNet portals.
1095 * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1096 * Another user is readpage for MDT.
1098 struct ptlrpc_bulk_desc {
1099 /** completed successfully */
1100 unsigned long bd_success:1;
1101 /** accessible to the network (network io potentially in progress) */
1102 unsigned long bd_network_rw:1;
1103 /** {put,get}{source,sink} */
1104 unsigned long bd_type:2;
1106 unsigned long bd_registered:1;
1107 /** For serialization with callback */
1108 cfs_spinlock_t bd_lock;
1109 /** Import generation when request for this bulk was sent */
1110 int bd_import_generation;
1111 /** Server side - export this bulk created for */
1112 struct obd_export *bd_export;
1113 /** Client side - import this bulk was sent on */
1114 struct obd_import *bd_import;
1115 /** LNet portal for this bulk */
1117 /** Back pointer to the request */
1118 struct ptlrpc_request *bd_req;
1119 cfs_waitq_t bd_waitq; /* server side only WQ */
1120 int bd_iov_count; /* # entries in bd_iov */
1121 int bd_max_iov; /* allocated size of bd_iov */
1122 int bd_nob; /* # bytes covered */
1123 int bd_nob_transferred; /* # bytes GOT/PUT */
1127 struct ptlrpc_cb_id bd_cbid; /* network callback info */
1128 lnet_handle_md_t bd_md_h; /* associated MD */
1129 lnet_nid_t bd_sender; /* stash event::sender */
1131 #if defined(__KERNEL__)
1133 * encrypt iov, size is either 0 or bd_iov_count.
1135 lnet_kiov_t *bd_enc_iov;
1137 lnet_kiov_t bd_iov[0];
1139 lnet_md_iovec_t bd_iov[0];
1144 SVC_STOPPED = 1 << 0,
1145 SVC_STOPPING = 1 << 1,
1146 SVC_STARTING = 1 << 2,
1147 SVC_RUNNING = 1 << 3,
1149 SVC_SIGNAL = 1 << 5,
1152 #define PTLRPC_THR_NAME_LEN 32
1154 * Definition of server service thread structure
1156 struct ptlrpc_thread {
1158 * List of active threads in svc->srv_threads
1162 * thread-private data (preallocated memory)
1167 * service thread index, from ptlrpc_start_threads
1171 * service thread pid
1175 * put watchdog in the structure per thread b=14840
1177 struct lc_watchdog *t_watchdog;
1179 * the svc this thread belonged to b=18582
1181 struct ptlrpc_service_part *t_svcpt;
1182 cfs_waitq_t t_ctl_waitq;
1183 struct lu_env *t_env;
1184 char t_name[PTLRPC_THR_NAME_LEN];
1187 static inline int thread_is_init(struct ptlrpc_thread *thread)
1189 return thread->t_flags == 0;
1192 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1194 return !!(thread->t_flags & SVC_STOPPED);
1197 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1199 return !!(thread->t_flags & SVC_STOPPING);
1202 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1204 return !!(thread->t_flags & SVC_STARTING);
1207 static inline int thread_is_running(struct ptlrpc_thread *thread)
1209 return !!(thread->t_flags & SVC_RUNNING);
1212 static inline int thread_is_event(struct ptlrpc_thread *thread)
1214 return !!(thread->t_flags & SVC_EVENT);
1217 static inline int thread_is_signal(struct ptlrpc_thread *thread)
1219 return !!(thread->t_flags & SVC_SIGNAL);
1222 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1224 thread->t_flags &= ~flags;
1227 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1229 thread->t_flags = flags;
1232 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1234 thread->t_flags |= flags;
1237 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1240 if (thread->t_flags & flags) {
1241 thread->t_flags &= ~flags;
1248 * Request buffer descriptor structure.
1249 * This is a structure that contains one posted request buffer for service.
1250 * Once data land into a buffer, event callback creates actual request and
1251 * notifies wakes one of the service threads to process new incoming request.
1252 * More than one request can fit into the buffer.
1254 struct ptlrpc_request_buffer_desc {
1255 /** Link item for rqbds on a service */
1256 cfs_list_t rqbd_list;
1257 /** History of requests for this buffer */
1258 cfs_list_t rqbd_reqs;
1259 /** Back pointer to service for which this buffer is registered */
1260 struct ptlrpc_service_part *rqbd_svcpt;
1261 /** LNet descriptor */
1262 lnet_handle_md_t rqbd_md_h;
1264 /** The buffer itself */
1266 struct ptlrpc_cb_id rqbd_cbid;
1268 * This "embedded" request structure is only used for the
1269 * last request to fit into the buffer
1271 struct ptlrpc_request rqbd_req;
1274 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
1276 struct ptlrpc_service_ops {
1278 * if non-NULL called during thread creation (ptlrpc_start_thread())
1279 * to initialize service specific per-thread state.
1281 int (*so_thr_init)(struct ptlrpc_thread *thr);
1283 * if non-NULL called during thread shutdown (ptlrpc_main()) to
1284 * destruct state created by ->srv_init().
1286 void (*so_thr_done)(struct ptlrpc_thread *thr);
1288 * Handler function for incoming requests for this service
1290 int (*so_req_handler)(struct ptlrpc_request *req);
1292 * function to determine priority of the request, it's called
1293 * on every new request
1295 int (*so_hpreq_handler)(struct ptlrpc_request *);
1297 * service-specific print fn
1299 void (*so_req_printer)(void *, struct ptlrpc_request *);
1302 #ifndef __cfs_cacheline_aligned
1303 /* NB: put it here for reducing patche dependence */
1304 # define __cfs_cacheline_aligned
1308 * How many high priority requests to serve before serving one normal
1311 #define PTLRPC_SVC_HP_RATIO 10
1314 * Definition of PortalRPC service.
1315 * The service is listening on a particular portal (like tcp port)
1316 * and perform actions for a specific server like IO service for OST
1317 * or general metadata service for MDS.
1319 struct ptlrpc_service {
1320 /** serialize /proc operations */
1321 cfs_spinlock_t srv_lock;
1322 /** most often accessed fields */
1323 /** chain thru all services */
1324 cfs_list_t srv_list;
1325 /** service operations table */
1326 struct ptlrpc_service_ops srv_ops;
1327 /** only statically allocated strings here; we don't clean them */
1329 /** only statically allocated strings here; we don't clean them */
1330 char *srv_thread_name;
1331 /** service thread list */
1332 cfs_list_t srv_threads;
1333 /** threads # should be created for each partition on initializing */
1334 int srv_nthrs_cpt_init;
1335 /** limit of threads number for each partition */
1336 int srv_nthrs_cpt_limit;
1337 /** Root of /proc dir tree for this service */
1338 cfs_proc_dir_entry_t *srv_procroot;
1339 /** Pointer to statistic data for this service */
1340 struct lprocfs_stats *srv_stats;
1341 /** # hp per lp reqs to handle */
1342 int srv_hpreq_ratio;
1343 /** biggest request to receive */
1344 int srv_max_req_size;
1345 /** biggest reply to send */
1346 int srv_max_reply_size;
1347 /** size of individual buffers */
1349 /** # buffers to allocate in 1 group */
1350 int srv_nbuf_per_group;
1351 /** Local portal on which to receive requests */
1352 __u32 srv_req_portal;
1353 /** Portal on the client to send replies to */
1354 __u32 srv_rep_portal;
1356 * Tags for lu_context associated with this thread, see struct
1360 /** soft watchdog timeout multiplier */
1361 int srv_watchdog_factor;
1362 /** under unregister_service */
1363 unsigned srv_is_stopping:1;
1365 /** max # request buffers in history per partition */
1366 int srv_hist_nrqbds_cpt_max;
1367 /** number of CPTs this service bound on */
1369 /** CPTs array this service bound on */
1371 /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
1373 /** CPT table this service is running over */
1374 struct cfs_cpt_table *srv_cptable;
1376 * partition data for ptlrpc service
1378 struct ptlrpc_service_part *srv_parts[0];
1382 * Definition of PortalRPC service partition data.
1383 * Although a service only has one instance of it right now, but we
1384 * will have multiple instances very soon (instance per CPT).
1386 * it has four locks:
1388 * serialize operations on rqbd and requests waiting for preprocess
1390 * serialize operations active requests sent to this portal
1392 * serialize adaptive timeout stuff
1394 * serialize operations on RS list (reply states)
1396 * We don't have any use-case to take two or more locks at the same time
1397 * for now, so there is no lock order issue.
1399 struct ptlrpc_service_part {
1400 /** back reference to owner */
1401 struct ptlrpc_service *scp_service __cfs_cacheline_aligned;
1402 /* CPT id, reserved */
1404 /** always increasing number */
1406 /** # of starting threads */
1407 int scp_nthrs_starting;
1408 /** # of stopping threads, reserved for shrinking threads */
1409 int scp_nthrs_stopping;
1410 /** # running threads */
1411 int scp_nthrs_running;
1412 /** service threads list */
1413 cfs_list_t scp_threads;
1416 * serialize the following fields, used for protecting
1417 * rqbd list and incoming requests waiting for preprocess,
1418 * threads starting & stopping are also protected by this lock.
1420 cfs_spinlock_t scp_lock __cfs_cacheline_aligned;
1421 /** total # req buffer descs allocated */
1422 int scp_nrqbds_total;
1423 /** # posted request buffers for receiving */
1424 int scp_nrqbds_posted;
1425 /** # incoming reqs */
1426 int scp_nreqs_incoming;
1427 /** request buffers to be reposted */
1428 cfs_list_t scp_rqbd_idle;
1429 /** req buffers receiving */
1430 cfs_list_t scp_rqbd_posted;
1431 /** incoming reqs */
1432 cfs_list_t scp_req_incoming;
1433 /** timeout before re-posting reqs, in tick */
1434 cfs_duration_t scp_rqbd_timeout;
1436 * all threads sleep on this. This wait-queue is signalled when new
1437 * incoming request arrives and when difficult reply has to be handled.
1439 cfs_waitq_t scp_waitq;
1441 /** request history */
1442 cfs_list_t scp_hist_reqs;
1443 /** request buffer history */
1444 cfs_list_t scp_hist_rqbds;
1445 /** # request buffers in history */
1446 int scp_hist_nrqbds;
1447 /** sequence number for request */
1449 /** highest seq culled from history */
1450 __u64 scp_hist_seq_culled;
1453 * serialize the following fields, used for processing requests
1454 * sent to this portal
1456 cfs_spinlock_t scp_req_lock __cfs_cacheline_aligned;
1457 /** # reqs in either of the queues below */
1458 /** reqs waiting for service */
1459 cfs_list_t scp_req_pending;
1460 /** high priority queue */
1461 cfs_list_t scp_hreq_pending;
1462 /** # reqs being served */
1463 int scp_nreqs_active;
1464 /** # HPreqs being served */
1465 int scp_nhreqs_active;
1466 /** # hp requests handled */
1472 * serialize the following fields, used for changes on
1475 cfs_spinlock_t scp_at_lock __cfs_cacheline_aligned;
1476 /** estimated rpc service time */
1477 struct adaptive_timeout scp_at_estimate;
1478 /** reqs waiting for replies */
1479 struct ptlrpc_at_array scp_at_array;
1480 /** early reply timer */
1481 cfs_timer_t scp_at_timer;
1483 cfs_time_t scp_at_checktime;
1484 /** check early replies */
1485 unsigned scp_at_check;
1489 * serialize the following fields, used for processing
1490 * replies for this portal
1492 cfs_spinlock_t scp_rep_lock __cfs_cacheline_aligned;
1493 /** all the active replies */
1494 cfs_list_t scp_rep_active;
1496 /** replies waiting for service */
1497 cfs_list_t scp_rep_queue;
1499 /** List of free reply_states */
1500 cfs_list_t scp_rep_idle;
1501 /** waitq to run, when adding stuff to srv_free_rs_list */
1502 cfs_waitq_t scp_rep_waitq;
1503 /** # 'difficult' replies */
1504 cfs_atomic_t scp_nreps_difficult;
1507 #define ptlrpc_service_for_each_part(part, i, svc) \
1509 i < (svc)->srv_ncpts && \
1510 (svc)->srv_parts != NULL && \
1511 ((part) = (svc)->srv_parts[i]) != NULL; i++)
1514 * Declaration of ptlrpcd control structure
1516 struct ptlrpcd_ctl {
1518 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1520 unsigned long pc_flags;
1522 * Thread lock protecting structure fields.
1524 cfs_spinlock_t pc_lock;
1528 cfs_completion_t pc_starting;
1532 cfs_completion_t pc_finishing;
1534 * Thread requests set.
1536 struct ptlrpc_request_set *pc_set;
1538 * Thread name used in cfs_daemonize()
1542 * Environment for request interpreters to run in.
1544 struct lu_env pc_env;
1546 * Index of ptlrpcd thread in the array.
1550 * Number of the ptlrpcd's partners.
1554 * Pointer to the array of partners' ptlrpcd_ctl structure.
1556 struct ptlrpcd_ctl **pc_partners;
1558 * Record the partner index to be processed next.
1563 * Async rpcs flag to make sure that ptlrpcd_check() is called only
1568 * Currently not used.
1572 * User-space async rpcs callback.
1574 void *pc_wait_callback;
1576 * User-space check idle rpcs callback.
1578 void *pc_idle_callback;
1582 /* Bits for pc_flags */
1583 enum ptlrpcd_ctl_flags {
1585 * Ptlrpc thread start flag.
1587 LIOD_START = 1 << 0,
1589 * Ptlrpc thread stop flag.
1593 * Ptlrpc thread force flag (only stop force so far).
1594 * This will cause aborting any inflight rpcs handled
1595 * by thread if LIOD_STOP is specified.
1597 LIOD_FORCE = 1 << 2,
1599 * This is a recovery ptlrpc thread.
1601 LIOD_RECOVERY = 1 << 3,
1603 * The ptlrpcd is bound to some CPU core.
1608 /* ptlrpc/events.c */
1609 extern lnet_handle_eq_t ptlrpc_eq_h;
1610 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
1611 lnet_process_id_t *peer, lnet_nid_t *self);
1613 * These callbacks are invoked by LNet when something happened to
1617 extern void request_out_callback(lnet_event_t *ev);
1618 extern void reply_in_callback(lnet_event_t *ev);
1619 extern void client_bulk_callback(lnet_event_t *ev);
1620 extern void request_in_callback(lnet_event_t *ev);
1621 extern void reply_out_callback(lnet_event_t *ev);
1622 #ifdef HAVE_SERVER_SUPPORT
1623 extern void server_bulk_callback(lnet_event_t *ev);
1627 /* ptlrpc/connection.c */
1628 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
1630 struct obd_uuid *uuid);
1631 int ptlrpc_connection_put(struct ptlrpc_connection *c);
1632 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
1633 int ptlrpc_connection_init(void);
1634 void ptlrpc_connection_fini(void);
1635 extern lnet_pid_t ptl_get_pid(void);
1637 /* ptlrpc/niobuf.c */
1639 * Actual interfacing with LNet to put/get/register/unregister stuff
1642 #ifdef HAVE_SERVER_SUPPORT
1643 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
1644 int npages, int type, int portal);
1645 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
1646 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
1648 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
1652 LASSERT(desc != NULL);
1654 cfs_spin_lock(&desc->bd_lock);
1655 rc = desc->bd_network_rw;
1656 cfs_spin_unlock(&desc->bd_lock);
1661 int ptlrpc_register_bulk(struct ptlrpc_request *req);
1662 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
1664 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
1666 struct ptlrpc_bulk_desc *desc = req->rq_bulk;
1669 LASSERT(req != NULL);
1671 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK) &&
1672 req->rq_bulk_deadline > cfs_time_current_sec())
1678 cfs_spin_lock(&desc->bd_lock);
1679 rc = desc->bd_network_rw;
1680 cfs_spin_unlock(&desc->bd_lock);
1684 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
1685 #define PTLRPC_REPLY_EARLY 0x02
1686 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
1687 int ptlrpc_reply(struct ptlrpc_request *req);
1688 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
1689 int ptlrpc_error(struct ptlrpc_request *req);
1690 void ptlrpc_resend_req(struct ptlrpc_request *request);
1691 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
1692 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
1693 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
1696 /* ptlrpc/client.c */
1698 * Client-side portals API. Everything to send requests, receive replies,
1699 * request queues, request management, etc.
1702 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
1703 struct ptlrpc_client *);
1704 void ptlrpc_cleanup_client(struct obd_import *imp);
1705 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
1707 int ptlrpc_queue_wait(struct ptlrpc_request *req);
1708 int ptlrpc_replay_req(struct ptlrpc_request *req);
1709 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
1710 void ptlrpc_restart_req(struct ptlrpc_request *req);
1711 void ptlrpc_abort_inflight(struct obd_import *imp);
1712 void ptlrpc_cleanup_imp(struct obd_import *imp);
1713 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
1715 struct ptlrpc_request_set *ptlrpc_prep_set(void);
1716 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
1718 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
1719 set_interpreter_func fn, void *data);
1720 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
1721 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
1722 int ptlrpc_set_wait(struct ptlrpc_request_set *);
1723 int ptlrpc_expired_set(void *data);
1724 void ptlrpc_interrupted_set(void *data);
1725 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
1726 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
1727 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
1728 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
1729 struct ptlrpc_request *req);
1731 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
1732 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
1734 struct ptlrpc_request_pool *
1735 ptlrpc_init_rq_pool(int, int,
1736 void (*populate_pool)(struct ptlrpc_request_pool *, int));
1738 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
1739 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
1740 const struct req_format *format);
1741 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
1742 struct ptlrpc_request_pool *,
1743 const struct req_format *format);
1744 void ptlrpc_request_free(struct ptlrpc_request *request);
1745 int ptlrpc_request_pack(struct ptlrpc_request *request,
1746 __u32 version, int opcode);
1747 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
1748 const struct req_format *format,
1749 __u32 version, int opcode);
1750 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
1751 __u32 version, int opcode, char **bufs,
1752 struct ptlrpc_cli_ctx *ctx);
1753 struct ptlrpc_request *ptlrpc_prep_fakereq(struct obd_import *imp,
1754 unsigned int timeout,
1755 ptlrpc_interpterer_t interpreter);
1756 void ptlrpc_fakereq_finished(struct ptlrpc_request *req);
1758 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
1759 int opcode, int count, __u32 *lengths,
1761 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
1762 __u32 version, int opcode,
1763 int count, __u32 *lengths, char **bufs,
1764 struct ptlrpc_request_pool *pool);
1765 void ptlrpc_req_finished(struct ptlrpc_request *request);
1766 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
1767 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
1768 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
1769 int npages, int type, int portal);
1770 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
1771 void ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
1772 cfs_page_t *page, int pageoffset, int len);
1773 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
1774 struct obd_import *imp);
1775 __u64 ptlrpc_next_xid(void);
1776 __u64 ptlrpc_sample_next_xid(void);
1777 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
1779 /* Set of routines to run a function in ptlrpcd context */
1780 void *ptlrpcd_alloc_work(struct obd_import *imp,
1781 int (*cb)(const struct lu_env *, void *), void *data);
1782 void ptlrpcd_destroy_work(void *handler);
1783 int ptlrpcd_queue_work(void *handler);
1786 struct ptlrpc_service_buf_conf {
1787 /* nbufs is how many buffers to post */
1788 unsigned int bc_nbufs;
1789 /* buffer size to post */
1790 unsigned int bc_buf_size;
1791 /* portal to listed for requests on */
1792 unsigned int bc_req_portal;
1793 /* portal of where to send replies to */
1794 unsigned int bc_rep_portal;
1795 /* maximum request size to be accepted for this service */
1796 unsigned int bc_req_max_size;
1797 /* maximum reply size this service can ever send */
1798 unsigned int bc_rep_max_size;
1801 struct ptlrpc_service_thr_conf {
1802 /* threadname should be 8 characters or less - 6 will be added on */
1804 /* threads increasing factor for each CPU */
1805 unsigned int tc_thr_factor;
1806 /* service threads # to start on each partition while initializing */
1807 unsigned int tc_nthrs_init;
1809 * low water of threads # upper-limit on each partition while running,
1810 * service availability may be impacted if threads number is lower
1811 * than this value. It can be ZERO if the service doesn't require
1812 * CPU affinity or there is only one partition.
1814 unsigned int tc_nthrs_base;
1815 /* "soft" limit for total threads number */
1816 unsigned int tc_nthrs_max;
1817 /* user specified threads number, it will be validated due to
1818 * other members of this structure. */
1819 unsigned int tc_nthrs_user;
1820 /* set NUMA node affinity for service threads */
1821 unsigned int tc_cpu_affinity;
1822 /* Tags for lu_context associated with service thread */
1826 struct ptlrpc_service_cpt_conf {
1827 struct cfs_cpt_table *cc_cptable;
1828 /* string pattern to describe CPTs for a service */
1832 struct ptlrpc_service_conf {
1835 /* soft watchdog timeout multiplifier to print stuck service traces */
1836 unsigned int psc_watchdog_factor;
1837 /* buffer information */
1838 struct ptlrpc_service_buf_conf psc_buf;
1839 /* thread information */
1840 struct ptlrpc_service_thr_conf psc_thr;
1841 /* CPU partition information */
1842 struct ptlrpc_service_cpt_conf psc_cpt;
1843 /* function table */
1844 struct ptlrpc_service_ops psc_ops;
1847 /* ptlrpc/service.c */
1849 * Server-side services API. Register/unregister service, request state
1850 * management, service thread management
1854 void ptlrpc_save_lock(struct ptlrpc_request *req,
1855 struct lustre_handle *lock, int mode, int no_ack);
1856 void ptlrpc_commit_replies(struct obd_export *exp);
1857 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
1858 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
1859 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
1860 struct ptlrpc_service *ptlrpc_register_service(
1861 struct ptlrpc_service_conf *conf,
1862 struct proc_dir_entry *proc_entry);
1863 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
1865 int ptlrpc_start_threads(struct ptlrpc_service *svc);
1866 int ptlrpc_unregister_service(struct ptlrpc_service *service);
1867 int liblustre_check_services(void *arg);
1868 void ptlrpc_daemonize(char *name);
1869 int ptlrpc_service_health_check(struct ptlrpc_service *);
1870 void ptlrpc_hpreq_reorder(struct ptlrpc_request *req);
1871 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
1874 int ptlrpc_hr_init(void);
1875 void ptlrpc_hr_fini(void);
1877 # define ptlrpc_hr_init() (0)
1878 # define ptlrpc_hr_fini() do {} while(0)
1883 /* ptlrpc/import.c */
1888 int ptlrpc_connect_import(struct obd_import *imp);
1889 int ptlrpc_init_import(struct obd_import *imp);
1890 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
1891 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
1892 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
1895 /* ptlrpc/pack_generic.c */
1896 int ptlrpc_reconnect_import(struct obd_import *imp);
1900 * ptlrpc msg buffer and swab interface
1904 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
1906 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
1908 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
1909 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
1911 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
1912 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
1914 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
1915 __u32 *lens, char **bufs);
1916 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
1918 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
1919 __u32 *lens, char **bufs, int flags);
1920 #define LPRFL_EARLY_REPLY 1
1921 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
1922 char **bufs, int flags);
1923 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
1924 unsigned int newlen, int move_data);
1925 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
1926 int __lustre_unpack_msg(struct lustre_msg *m, int len);
1927 int lustre_msg_hdr_size(__u32 magic, int count);
1928 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
1929 int lustre_msg_size_v2(int count, __u32 *lengths);
1930 int lustre_packed_msg_size(struct lustre_msg *msg);
1931 int lustre_msg_early_size(void);
1932 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
1933 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
1934 int lustre_msg_buflen(struct lustre_msg *m, int n);
1935 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
1936 int lustre_msg_bufcount(struct lustre_msg *m);
1937 char *lustre_msg_string(struct lustre_msg *m, int n, int max_len);
1938 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
1939 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
1940 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
1941 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
1942 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
1943 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
1944 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
1945 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
1946 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
1947 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
1948 __u32 lustre_msg_get_type(struct lustre_msg *msg);
1949 __u32 lustre_msg_get_version(struct lustre_msg *msg);
1950 void lustre_msg_add_version(struct lustre_msg *msg, int version);
1951 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
1952 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
1953 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
1954 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
1955 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
1956 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
1957 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
1958 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
1959 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
1960 int lustre_msg_get_status(struct lustre_msg *msg);
1961 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
1962 int lustre_msg_is_v1(struct lustre_msg *msg);
1963 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
1964 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
1965 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
1966 char *lustre_msg_get_jobid(struct lustre_msg *msg);
1967 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
1968 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 9, 0, 0)
1969 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18);
1971 # warning "remove checksum compatibility support for b1_8"
1972 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
1974 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
1975 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
1976 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
1977 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
1978 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
1979 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
1980 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
1981 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
1982 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
1983 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
1984 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
1985 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
1986 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
1987 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
1988 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
1991 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
1992 unsigned int newlen, int move_data)
1994 LASSERT(req->rq_reply_state);
1995 LASSERT(req->rq_repmsg);
1996 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2001 /** Change request phase of \a req to \a new_phase */
2003 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2005 if (req->rq_phase == new_phase)
2008 if (new_phase == RQ_PHASE_UNREGISTERING) {
2009 req->rq_next_phase = req->rq_phase;
2011 cfs_atomic_inc(&req->rq_import->imp_unregistering);
2014 if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
2016 cfs_atomic_dec(&req->rq_import->imp_unregistering);
2019 DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
2020 ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2022 req->rq_phase = new_phase;
2026 * Returns true if request \a req got early reply and hard deadline is not met
2029 ptlrpc_client_early(struct ptlrpc_request *req)
2031 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2032 req->rq_reply_deadline > cfs_time_current_sec())
2034 return req->rq_early;
2038 * Returns true if we got real reply from server for this request
2041 ptlrpc_client_replied(struct ptlrpc_request *req)
2043 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2044 req->rq_reply_deadline > cfs_time_current_sec())
2046 return req->rq_replied;
2049 /** Returns true if request \a req is in process of receiving server reply */
2051 ptlrpc_client_recv(struct ptlrpc_request *req)
2053 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2054 req->rq_reply_deadline > cfs_time_current_sec())
2056 return req->rq_receiving_reply;
2060 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2064 cfs_spin_lock(&req->rq_lock);
2065 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2066 req->rq_reply_deadline > cfs_time_current_sec()) {
2067 cfs_spin_unlock(&req->rq_lock);
2070 rc = req->rq_receiving_reply || req->rq_must_unlink;
2071 cfs_spin_unlock(&req->rq_lock);
2076 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2078 if (req->rq_set == NULL)
2079 cfs_waitq_signal(&req->rq_reply_waitq);
2081 cfs_waitq_signal(&req->rq_set->set_waitq);
2085 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2087 LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
2088 cfs_atomic_inc(&rs->rs_refcount);
2092 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2094 LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
2095 if (cfs_atomic_dec_and_test(&rs->rs_refcount))
2096 lustre_free_reply_state(rs);
2099 /* Should only be called once per req */
2100 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2102 if (req->rq_reply_state == NULL)
2103 return; /* shouldn't occur */
2104 ptlrpc_rs_decref(req->rq_reply_state);
2105 req->rq_reply_state = NULL;
2106 req->rq_repmsg = NULL;
2109 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2111 return lustre_msg_get_magic(req->rq_reqmsg);
2114 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2116 switch (req->rq_reqmsg->lm_magic) {
2117 case LUSTRE_MSG_MAGIC_V2:
2118 return req->rq_reqmsg->lm_repsize;
2120 LASSERTF(0, "incorrect message magic: %08x\n",
2121 req->rq_reqmsg->lm_magic);
2126 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2128 if (req->rq_delay_limit != 0 &&
2129 cfs_time_before(cfs_time_add(req->rq_queued_time,
2130 cfs_time_seconds(req->rq_delay_limit)),
2131 cfs_time_current())) {
2137 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2139 if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2140 cfs_spin_lock(&req->rq_lock);
2141 req->rq_no_resend = 1;
2142 cfs_spin_unlock(&req->rq_lock);
2144 return req->rq_no_resend;
2148 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
2150 int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
2152 return svcpt->scp_service->srv_watchdog_factor *
2153 max_t(int, at, obd_timeout);
2156 static inline struct ptlrpc_service *
2157 ptlrpc_req2svc(struct ptlrpc_request *req)
2159 LASSERT(req->rq_rqbd != NULL);
2160 return req->rq_rqbd->rqbd_svcpt->scp_service;
2163 /* ldlm/ldlm_lib.c */
2165 * Target client logic
2168 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
2169 int client_obd_cleanup(struct obd_device *obddev);
2170 int client_connect_import(const struct lu_env *env,
2171 struct obd_export **exp, struct obd_device *obd,
2172 struct obd_uuid *cluuid, struct obd_connect_data *,
2174 int client_disconnect_export(struct obd_export *exp);
2175 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
2177 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
2178 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
2179 struct obd_uuid *uuid);
2180 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
2181 void client_destroy_import(struct obd_import *imp);
2184 #ifdef HAVE_SERVER_SUPPORT
2185 int server_disconnect_export(struct obd_export *exp);
2188 /* ptlrpc/pinger.c */
2190 * Pinger API (client side only)
2193 enum timeout_event {
2196 struct timeout_item;
2197 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
2198 int ptlrpc_pinger_add_import(struct obd_import *imp);
2199 int ptlrpc_pinger_del_import(struct obd_import *imp);
2200 int ptlrpc_add_timeout_client(int time, enum timeout_event event,
2201 timeout_cb_t cb, void *data,
2202 cfs_list_t *obd_list);
2203 int ptlrpc_del_timeout_client(cfs_list_t *obd_list,
2204 enum timeout_event event);
2205 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
2206 int ptlrpc_obd_ping(struct obd_device *obd);
2207 cfs_time_t ptlrpc_suspend_wakeup_time(void);
2209 void ping_evictor_start(void);
2210 void ping_evictor_stop(void);
2212 #define ping_evictor_start() do {} while (0)
2213 #define ping_evictor_stop() do {} while (0)
2215 int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req);
2218 /* ptlrpc daemon bind policy */
2220 /* all ptlrpcd threads are free mode */
2221 PDB_POLICY_NONE = 1,
2222 /* all ptlrpcd threads are bound mode */
2223 PDB_POLICY_FULL = 2,
2224 /* <free1 bound1> <free2 bound2> ... <freeN boundN> */
2225 PDB_POLICY_PAIR = 3,
2226 /* <free1 bound1> <bound1 free2> ... <freeN boundN> <boundN free1>,
2227 * means each ptlrpcd[X] has two partners: thread[X-1] and thread[X+1].
2228 * If kernel supports NUMA, pthrpcd threads are binded and
2229 * grouped by NUMA node */
2230 PDB_POLICY_NEIGHBOR = 4,
2233 /* ptlrpc daemon load policy
2234 * It is caller's duty to specify how to push the async RPC into some ptlrpcd
2235 * queue, but it is not enforced, affected by "ptlrpcd_bind_policy". If it is
2236 * "PDB_POLICY_FULL", then the RPC will be processed by the selected ptlrpcd,
2237 * Otherwise, the RPC may be processed by the selected ptlrpcd or its partner,
2238 * depends on which is scheduled firstly, to accelerate the RPC processing. */
2240 /* on the same CPU core as the caller */
2241 PDL_POLICY_SAME = 1,
2242 /* within the same CPU partition, but not the same core as the caller */
2243 PDL_POLICY_LOCAL = 2,
2244 /* round-robin on all CPU cores, but not the same core as the caller */
2245 PDL_POLICY_ROUND = 3,
2246 /* the specified CPU core is preferred, but not enforced */
2247 PDL_POLICY_PREFERRED = 4,
2250 /* ptlrpc/ptlrpcd.c */
2251 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
2252 void ptlrpcd_wake(struct ptlrpc_request *req);
2253 void ptlrpcd_add_req(struct ptlrpc_request *req, pdl_policy_t policy, int idx);
2254 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
2255 int ptlrpcd_addref(void);
2256 void ptlrpcd_decref(void);
2258 /* ptlrpc/lproc_ptlrpc.c */
2260 * procfs output related functions
2263 const char* ll_opcode2str(__u32 opcode);
2265 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
2266 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
2267 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
2269 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
2270 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
2271 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
2275 /* ptlrpc/llog_server.c */
2276 int llog_origin_handle_create(struct ptlrpc_request *req);
2277 int llog_origin_handle_destroy(struct ptlrpc_request *req);
2278 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
2279 int llog_origin_handle_next_block(struct ptlrpc_request *req);
2280 int llog_origin_handle_read_header(struct ptlrpc_request *req);
2281 int llog_origin_handle_close(struct ptlrpc_request *req);
2282 int llog_origin_handle_cancel(struct ptlrpc_request *req);
2283 int llog_catinfo(struct ptlrpc_request *req);
2285 /* ptlrpc/llog_client.c */
2286 extern struct llog_operations llog_client_ops;