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) 2010, 2012, Intel Corporation.
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 * Max # of bulk operations in one request.
87 * In order for the client and server to properly negotiate the maximum
88 * possible transfer size, PTLRPC_BULK_OPS_COUNT must be a power-of-two
89 * value. The client is free to limit the actual RPC size for any bulk
90 * transfer via cl_max_pages_per_rpc to some non-power-of-two value. */
91 #define PTLRPC_BULK_OPS_BITS 2
92 #define PTLRPC_BULK_OPS_COUNT (1U << PTLRPC_BULK_OPS_BITS)
94 * PTLRPC_BULK_OPS_MASK is for the convenience of the client only, and
95 * should not be used on the server at all. Otherwise, it imposes a
96 * protocol limitation on the maximum RPC size that can be used by any
97 * RPC sent to that server in the future. Instead, the server should
98 * use the negotiated per-client ocd_brw_size to determine the bulk
100 #define PTLRPC_BULK_OPS_MASK (~((__u64)PTLRPC_BULK_OPS_COUNT - 1))
103 * Define maxima for bulk I/O.
105 * A single PTLRPC BRW request is sent via up to PTLRPC_BULK_OPS_COUNT
106 * of LNET_MTU sized RDMA transfers. Clients and servers negotiate the
107 * currently supported maximum between peers at connect via ocd_brw_size.
109 #define PTLRPC_MAX_BRW_BITS (LNET_MTU_BITS + PTLRPC_BULK_OPS_BITS)
110 #define PTLRPC_MAX_BRW_SIZE (1 << PTLRPC_MAX_BRW_BITS)
111 #define PTLRPC_MAX_BRW_PAGES (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
113 #define ONE_MB_BRW_SIZE (1 << LNET_MTU_BITS)
114 #define MD_MAX_BRW_SIZE (1 << LNET_MTU_BITS)
115 #define MD_MAX_BRW_PAGES (MD_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
116 #define DT_MAX_BRW_SIZE PTLRPC_MAX_BRW_SIZE
117 #define DT_MAX_BRW_PAGES (DT_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
118 #define OFD_MAX_BRW_SIZE (1 << LNET_MTU_BITS)
120 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
122 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
123 # error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
125 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
126 # error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
128 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU * PTLRPC_BULK_OPS_COUNT)
129 # error "PTLRPC_MAX_BRW_SIZE too big"
131 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV * PTLRPC_BULK_OPS_COUNT)
132 # error "PTLRPC_MAX_BRW_PAGES too big"
134 #endif /* __KERNEL__ */
136 #define PTLRPC_NTHRS_INIT 2
141 * Constants determine how memory is used to buffer incoming service requests.
143 * ?_NBUFS # buffers to allocate when growing the pool
144 * ?_BUFSIZE # bytes in a single request buffer
145 * ?_MAXREQSIZE # maximum request service will receive
147 * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
148 * of ?_NBUFS is added to the pool.
150 * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are
151 * considered full when less than ?_MAXREQSIZE is left in them.
156 * Constants determine how threads are created for ptlrpc service.
158 * ?_NTHRS_INIT # threads to create for each service partition on
159 * initializing. If it's non-affinity service and
160 * there is only one partition, it's the overall #
161 * threads for the service while initializing.
162 * ?_NTHRS_BASE # threads should be created at least for each
163 * ptlrpc partition to keep the service healthy.
164 * It's the low-water mark of threads upper-limit
165 * for each partition.
166 * ?_THR_FACTOR # threads can be added on threads upper-limit for
167 * each CPU core. This factor is only for reference,
168 * we might decrease value of factor if number of cores
169 * per CPT is above a limit.
170 * ?_NTHRS_MAX # overall threads can be created for a service,
171 * it's a soft limit because if service is running
172 * on machine with hundreds of cores and tens of
173 * CPU partitions, we need to guarantee each partition
174 * has ?_NTHRS_BASE threads, which means total threads
175 * will be ?_NTHRS_BASE * number_of_cpts which can
176 * exceed ?_NTHRS_MAX.
180 * #define MDS_NTHRS_INIT 2
181 * #define MDS_NTHRS_BASE 64
182 * #define MDS_NTHRS_FACTOR 8
183 * #define MDS_NTHRS_MAX 1024
186 * ---------------------------------------------------------------------
187 * Server(A) has 16 cores, user configured it to 4 partitions so each
188 * partition has 4 cores, then actual number of service threads on each
190 * MDS_NTHRS_BASE(64) + cores(4) * MDS_NTHRS_FACTOR(8) = 96
192 * Total number of threads for the service is:
193 * 96 * partitions(4) = 384
196 * ---------------------------------------------------------------------
197 * Server(B) has 32 cores, user configured it to 4 partitions so each
198 * partition has 8 cores, then actual number of service threads on each
200 * MDS_NTHRS_BASE(64) + cores(8) * MDS_NTHRS_FACTOR(8) = 128
202 * Total number of threads for the service is:
203 * 128 * partitions(4) = 512
206 * ---------------------------------------------------------------------
207 * Server(B) has 96 cores, user configured it to 8 partitions so each
208 * partition has 12 cores, then actual number of service threads on each
210 * MDS_NTHRS_BASE(64) + cores(12) * MDS_NTHRS_FACTOR(8) = 160
212 * Total number of threads for the service is:
213 * 160 * partitions(8) = 1280
215 * However, it's above the soft limit MDS_NTHRS_MAX, so we choose this number
216 * as upper limit of threads number for each partition:
217 * MDS_NTHRS_MAX(1024) / partitions(8) = 128
220 * ---------------------------------------------------------------------
221 * Server(C) have a thousand of cores and user configured it to 32 partitions
222 * MDS_NTHRS_BASE(64) * 32 = 2048
224 * which is already above soft limit MDS_NTHRS_MAX(1024), but we still need
225 * to guarantee that each partition has at least MDS_NTHRS_BASE(64) threads
226 * to keep service healthy, so total number of threads will just be 2048.
228 * NB: we don't suggest to choose server with that many cores because backend
229 * filesystem itself, buffer cache, or underlying network stack might
230 * have some SMP scalability issues at that large scale.
232 * If user already has a fat machine with hundreds or thousands of cores,
233 * there are two choices for configuration:
234 * a) create CPU table from subset of all CPUs and run Lustre on
236 * b) bind service threads on a few partitions, see modparameters of
237 * MDS and OSS for details
239 * NB: these calculations (and examples below) are simplified to help
240 * understanding, the real implementation is a little more complex,
241 * please see ptlrpc_server_nthreads_check() for details.
246 * LDLM threads constants:
248 * Given 8 as factor and 24 as base threads number
251 * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
254 * On 8-core machine with 2 partitions we will have 24 + 4 * 8 = 56
255 * threads for each partition and total threads number will be 112.
258 * On 64-core machine with 8 partitions we will need LDLM_NTHRS_BASE(24)
259 * threads for each partition to keep service healthy, so total threads
260 * number should be 24 * 8 = 192.
262 * So with these constants, threads number wil be at the similar level
263 * of old versions, unless target machine has over a hundred cores
265 #define LDLM_THR_FACTOR 8
266 #define LDLM_NTHRS_INIT PTLRPC_NTHRS_INIT
267 #define LDLM_NTHRS_BASE 24
268 #define LDLM_NTHRS_MAX (cfs_num_online_cpus() == 1 ? 64 : 128)
270 #define LDLM_BL_THREADS LDLM_NTHRS_AUTO_INIT
271 #define LDLM_NBUFS 64
272 #define LDLM_BUFSIZE (8 * 1024)
273 #define LDLM_MAXREQSIZE (5 * 1024)
274 #define LDLM_MAXREPSIZE (1024)
277 * MDS threads constants:
279 * Please see examples in "Thread Constants", MDS threads number will be at
280 * the comparable level of old versions, unless the server has many cores.
282 #ifndef MDS_MAX_THREADS
283 #define MDS_MAX_THREADS 1024
284 #define MDS_MAX_OTHR_THREADS 256
286 #else /* MDS_MAX_THREADS */
287 #if MDS_MAX_THREADS < PTLRPC_NTHRS_INIT
288 #undef MDS_MAX_THREADS
289 #define MDS_MAX_THREADS PTLRPC_NTHRS_INIT
291 #define MDS_MAX_OTHR_THREADS max(PTLRPC_NTHRS_INIT, MDS_MAX_THREADS / 2)
294 /* default service */
295 #define MDS_THR_FACTOR 8
296 #define MDS_NTHRS_INIT PTLRPC_NTHRS_INIT
297 #define MDS_NTHRS_MAX MDS_MAX_THREADS
298 #define MDS_NTHRS_BASE min(64, MDS_NTHRS_MAX)
300 /* read-page service */
301 #define MDS_RDPG_THR_FACTOR 4
302 #define MDS_RDPG_NTHRS_INIT PTLRPC_NTHRS_INIT
303 #define MDS_RDPG_NTHRS_MAX MDS_MAX_OTHR_THREADS
304 #define MDS_RDPG_NTHRS_BASE min(48, MDS_RDPG_NTHRS_MAX)
306 /* these should be removed when we remove setattr service in the future */
307 #define MDS_SETA_THR_FACTOR 4
308 #define MDS_SETA_NTHRS_INIT PTLRPC_NTHRS_INIT
309 #define MDS_SETA_NTHRS_MAX MDS_MAX_OTHR_THREADS
310 #define MDS_SETA_NTHRS_BASE min(48, MDS_SETA_NTHRS_MAX)
312 /* non-affinity threads */
313 #define MDS_OTHR_NTHRS_INIT PTLRPC_NTHRS_INIT
314 #define MDS_OTHR_NTHRS_MAX MDS_MAX_OTHR_THREADS
318 * Assume file name length = FNAME_MAX = 256 (true for ext3).
319 * path name length = PATH_MAX = 4096
320 * LOV MD size max = EA_MAX = 24 * 2000
321 * (NB: 24 is size of lov_ost_data)
322 * LOV LOGCOOKIE size max = 32 * 2000
323 * (NB: 32 is size of llog_cookie)
324 * symlink: FNAME_MAX + PATH_MAX <- largest
325 * link: FNAME_MAX + PATH_MAX (mds_rec_link < mds_rec_create)
326 * rename: FNAME_MAX + FNAME_MAX
327 * open: FNAME_MAX + EA_MAX
329 * MDS_MAXREQSIZE ~= 4736 bytes =
330 * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
331 * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
333 * Realistic size is about 512 bytes (20 character name + 128 char symlink),
334 * except in the open case where there are a large number of OSTs in a LOV.
336 #define MDS_MAXREQSIZE (5 * 1024) /* >= 4736 */
337 #define MDS_MAXREPSIZE (9 * 1024) /* >= 8300 */
340 * MDS incoming request with LOV EA
341 * 24 = sizeof(struct lov_ost_data), i.e: replay of opencreate
343 #define MDS_LOV_MAXREQSIZE max(MDS_MAXREQSIZE, \
344 362 + LOV_MAX_STRIPE_COUNT * 24)
346 * MDS outgoing reply with LOV EA
348 * NB: max reply size Lustre 2.4+ client can get from old MDS is:
349 * LOV_MAX_STRIPE_COUNT * (llog_cookie + lov_ost_data) + extra bytes
351 * but 2.4 or later MDS will never send reply with llog_cookie to any
352 * version client. This macro is defined for server side reply buffer size.
354 #define MDS_LOV_MAXREPSIZE MDS_LOV_MAXREQSIZE
357 * The update request includes all of updates from the create, which might
358 * include linkea (4K maxim), together with other updates, we set it to 9K:
359 * lustre_msg + ptlrpc_body + UPDATE_BUF_SIZE (8K)
361 #define MDS_OUT_MAXREQSIZE (9 * 1024)
362 #define MDS_OUT_MAXREPSIZE MDS_MAXREPSIZE
364 /** MDS_BUFSIZE = max_reqsize (w/o LOV EA) + max sptlrpc payload size */
365 #define MDS_BUFSIZE max_t(int, MDS_MAXREQSIZE + 1024, 8 * 1024)
368 * MDS_LOV_BUFSIZE should be at least max_reqsize (with LOV EA) +
369 * max sptlrpc payload size, however, we need to allocate a much larger buffer
370 * for it because LNet requires each MD(rqbd) has at least MDS_LOVE_MAXREQSIZE
371 * bytes left to avoid dropping of maximum-sized incoming request.
372 * So if MDS_LOV_BUFSIZE is only a little larger than MDS_LOV_MAXREQSIZE,
373 * then it can only fit in one request even there are 48K bytes left in
374 * a rqbd, and memory utilization is very low.
376 * In the meanwhile, size of rqbd can't be too large, because rqbd can't be
377 * reused until all requests fit in it have been processed and released,
378 * which means one long blocked request can prevent the rqbd be reused.
379 * Now we set request buffer size to 128K, so even each rqbd is unlinked
380 * from LNet with unused 48K, buffer utilization will be about 62%.
381 * Please check LU-2432 for details.
383 /** MDS_LOV_BUFSIZE = max_reqsize (w/ LOV EA) + max sptlrpc payload size */
384 #define MDS_LOV_BUFSIZE max_t(int, MDS_LOV_MAXREQSIZE + 1024, \
388 * MDS_OUT_BUFSIZE = max_out_reqsize + max sptlrpc payload (~1K) which is
389 * about 10K, for the same reason as MDS_LOV_BUFSIZE, we also give some
390 * extra bytes to each request buffer to improve buffer utilization rate.
392 #define MDS_OUT_BUFSIZE max_t(int, MDS_OUT_MAXREQSIZE + 1024, \
395 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
396 #define FLD_MAXREQSIZE (160)
398 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
399 #define FLD_MAXREPSIZE (152)
400 #define FLD_BUFSIZE (1 << 12)
403 * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
405 #define SEQ_MAXREQSIZE (160)
407 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
408 #define SEQ_MAXREPSIZE (152)
409 #define SEQ_BUFSIZE (1 << 12)
411 /** MGS threads must be >= 3, see bug 22458 comment #28 */
412 #define MGS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
413 #define MGS_NTHRS_MAX 32
416 #define MGS_BUFSIZE (8 * 1024)
417 #define MGS_MAXREQSIZE (7 * 1024)
418 #define MGS_MAXREPSIZE (9 * 1024)
421 * OSS threads constants:
423 * Given 8 as factor and 64 as base threads number
426 * On 8-core server configured to 2 partitions, we will have
427 * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
430 * On 32-core machine configured to 4 partitions, we will have
431 * 64 + 8 * 8 = 112 threads for each partition, so total threads number
432 * will be 112 * 4 = 448.
435 * On 64-core machine configured to 4 partitions, we will have
436 * 64 + 16 * 8 = 192 threads for each partition, so total threads number
437 * will be 192 * 4 = 768 which is above limit OSS_NTHRS_MAX(512), so we
438 * cut off the value to OSS_NTHRS_MAX(512) / 4 which is 128 threads
439 * for each partition.
441 * So we can see that with these constants, threads number wil be at the
442 * similar level of old versions, unless the server has many cores.
444 /* depress threads factor for VM with small memory size */
445 #define OSS_THR_FACTOR min_t(int, 8, \
446 CFS_NUM_CACHEPAGES >> (28 - CFS_PAGE_SHIFT))
447 #define OSS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
448 #define OSS_NTHRS_BASE 64
449 #define OSS_NTHRS_MAX 512
451 /* threads for handling "create" request */
452 #define OSS_CR_THR_FACTOR 1
453 #define OSS_CR_NTHRS_INIT PTLRPC_NTHRS_INIT
454 #define OSS_CR_NTHRS_BASE 8
455 #define OSS_CR_NTHRS_MAX 64
459 * lustre_msg + obdo + obd_ioobj + DT_MAX_BRW_PAGES * niobuf_remote
461 * - single object with 16 pages is 512 bytes
462 * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
463 * - Must be a multiple of 1024
465 #define _OST_MAXREQSIZE_SUM (sizeof(struct lustre_msg) + sizeof(struct obdo) + \
466 sizeof(struct obd_ioobj) + DT_MAX_BRW_PAGES * \
467 sizeof(struct niobuf_remote))
468 #define OST_MAXREQSIZE (((_OST_MAXREQSIZE_SUM - 1) | (1024 - 1)) + 1)
470 #define OST_MAXREPSIZE (9 * 1024)
473 #define OST_BUFSIZE (OST_MAXREQSIZE + 1024)
475 /* Macro to hide a typecast. */
476 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
479 * Structure to single define portal connection.
481 struct ptlrpc_connection {
482 /** linkage for connections hash table */
483 cfs_hlist_node_t c_hash;
484 /** Our own lnet nid for this connection */
486 /** Remote side nid for this connection */
487 lnet_process_id_t c_peer;
488 /** UUID of the other side */
489 struct obd_uuid c_remote_uuid;
490 /** reference counter for this connection */
491 cfs_atomic_t c_refcount;
494 /** Client definition for PortalRPC */
495 struct ptlrpc_client {
496 /** What lnet portal does this client send messages to by default */
497 __u32 cli_request_portal;
498 /** What portal do we expect replies on */
499 __u32 cli_reply_portal;
500 /** Name of the client */
504 /** state flags of requests */
505 /* XXX only ones left are those used by the bulk descs as well! */
506 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
507 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
509 #define REQ_MAX_ACK_LOCKS 8
511 union ptlrpc_async_args {
513 * Scratchpad for passing args to completion interpreter. Users
514 * cast to the struct of their choosing, and CLASSERT that this is
515 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
516 * a pointer to it here. The pointer_arg ensures this struct is at
517 * least big enough for that.
519 void *pointer_arg[11];
523 struct ptlrpc_request_set;
524 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
525 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
528 * Definition of request set structure.
529 * Request set is a list of requests (not necessary to the same target) that
530 * once populated with RPCs could be sent in parallel.
531 * There are two kinds of request sets. General purpose and with dedicated
532 * serving thread. Example of the latter is ptlrpcd set.
533 * For general purpose sets once request set started sending it is impossible
534 * to add new requests to such set.
535 * Provides a way to call "completion callbacks" when all requests in the set
538 struct ptlrpc_request_set {
539 cfs_atomic_t set_refcount;
540 /** number of in queue requests */
541 cfs_atomic_t set_new_count;
542 /** number of uncompleted requests */
543 cfs_atomic_t set_remaining;
544 /** wait queue to wait on for request events */
545 cfs_waitq_t set_waitq;
546 cfs_waitq_t *set_wakeup_ptr;
547 /** List of requests in the set */
548 cfs_list_t set_requests;
550 * List of completion callbacks to be called when the set is completed
551 * This is only used if \a set_interpret is NULL.
552 * Links struct ptlrpc_set_cbdata.
554 cfs_list_t set_cblist;
555 /** Completion callback, if only one. */
556 set_interpreter_func set_interpret;
557 /** opaq argument passed to completion \a set_interpret callback. */
560 * Lock for \a set_new_requests manipulations
561 * locked so that any old caller can communicate requests to
562 * the set holder who can then fold them into the lock-free set
564 spinlock_t set_new_req_lock;
565 /** List of new yet unsent requests. Only used with ptlrpcd now. */
566 cfs_list_t set_new_requests;
568 /** rq_status of requests that have been freed already */
570 /** Additional fields used by the flow control extension */
571 /** Maximum number of RPCs in flight */
572 int set_max_inflight;
573 /** Callback function used to generate RPCs */
574 set_producer_func set_producer;
575 /** opaq argument passed to the producer callback */
576 void *set_producer_arg;
580 * Description of a single ptrlrpc_set callback
582 struct ptlrpc_set_cbdata {
583 /** List linkage item */
585 /** Pointer to interpreting function */
586 set_interpreter_func psc_interpret;
587 /** Opaq argument to pass to the callback */
591 struct ptlrpc_bulk_desc;
592 struct ptlrpc_service_part;
593 struct ptlrpc_service;
596 * ptlrpc callback & work item stuff
598 struct ptlrpc_cb_id {
599 void (*cbid_fn)(lnet_event_t *ev); /* specific callback fn */
600 void *cbid_arg; /* additional arg */
603 /** Maximum number of locks to fit into reply state */
604 #define RS_MAX_LOCKS 8
608 * Structure to define reply state on the server
609 * Reply state holds various reply message information. Also for "difficult"
610 * replies (rep-ack case) we store the state after sending reply and wait
611 * for the client to acknowledge the reception. In these cases locks could be
612 * added to the state for replay/failover consistency guarantees.
614 struct ptlrpc_reply_state {
615 /** Callback description */
616 struct ptlrpc_cb_id rs_cb_id;
617 /** Linkage for list of all reply states in a system */
619 /** Linkage for list of all reply states on same export */
620 cfs_list_t rs_exp_list;
621 /** Linkage for list of all reply states for same obd */
622 cfs_list_t rs_obd_list;
624 cfs_list_t rs_debug_list;
626 /** A spinlock to protect the reply state flags */
628 /** Reply state flags */
629 unsigned long rs_difficult:1; /* ACK/commit stuff */
630 unsigned long rs_no_ack:1; /* no ACK, even for
631 difficult requests */
632 unsigned long rs_scheduled:1; /* being handled? */
633 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
634 unsigned long rs_handled:1; /* been handled yet? */
635 unsigned long rs_on_net:1; /* reply_out_callback pending? */
636 unsigned long rs_prealloc:1; /* rs from prealloc list */
637 unsigned long rs_committed:1;/* the transaction was committed
638 and the rs was dispatched
639 by ptlrpc_commit_replies */
640 /** Size of the state */
644 /** Transaction number */
648 struct obd_export *rs_export;
649 struct ptlrpc_service_part *rs_svcpt;
650 /** Lnet metadata handle for the reply */
651 lnet_handle_md_t rs_md_h;
652 cfs_atomic_t rs_refcount;
654 /** Context for the sevice thread */
655 struct ptlrpc_svc_ctx *rs_svc_ctx;
656 /** Reply buffer (actually sent to the client), encoded if needed */
657 struct lustre_msg *rs_repbuf; /* wrapper */
658 /** Size of the reply buffer */
659 int rs_repbuf_len; /* wrapper buf length */
660 /** Size of the reply message */
661 int rs_repdata_len; /* wrapper msg length */
663 * Actual reply message. Its content is encrupted (if needed) to
664 * produce reply buffer for actual sending. In simple case
665 * of no network encryption we jus set \a rs_repbuf to \a rs_msg
667 struct lustre_msg *rs_msg; /* reply message */
669 /** Number of locks awaiting client ACK */
671 /** Handles of locks awaiting client reply ACK */
672 struct lustre_handle rs_locks[RS_MAX_LOCKS];
673 /** Lock modes of locks in \a rs_locks */
674 ldlm_mode_t rs_modes[RS_MAX_LOCKS];
677 struct ptlrpc_thread;
681 RQ_PHASE_NEW = 0xebc0de00,
682 RQ_PHASE_RPC = 0xebc0de01,
683 RQ_PHASE_BULK = 0xebc0de02,
684 RQ_PHASE_INTERPRET = 0xebc0de03,
685 RQ_PHASE_COMPLETE = 0xebc0de04,
686 RQ_PHASE_UNREGISTERING = 0xebc0de05,
687 RQ_PHASE_UNDEFINED = 0xebc0de06
690 /** Type of request interpreter call-back */
691 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
692 struct ptlrpc_request *req,
696 * Definition of request pool structure.
697 * The pool is used to store empty preallocated requests for the case
698 * when we would actually need to send something without performing
699 * any allocations (to avoid e.g. OOM).
701 struct ptlrpc_request_pool {
702 /** Locks the list */
704 /** list of ptlrpc_request structs */
705 cfs_list_t prp_req_list;
706 /** Maximum message size that would fit into a rquest from this pool */
708 /** Function to allocate more requests for this pool */
709 void (*prp_populate)(struct ptlrpc_request_pool *, int);
718 * \defgroup nrs Network Request Scheduler
721 struct ptlrpc_nrs_policy;
722 struct ptlrpc_nrs_resource;
723 struct ptlrpc_nrs_request;
726 * NRS control operations.
728 * These are common for all policies.
730 enum ptlrpc_nrs_ctl {
732 * Activate the policy.
734 PTLRPC_NRS_CTL_START,
736 * Reserved for multiple primary policies, which may be a possibility
741 * Recycle resources for inactive policies.
743 PTLRPC_NRS_CTL_SHRINK,
745 * Not a valid opcode.
747 PTLRPC_NRS_CTL_INVALID,
749 * Policies can start using opcodes from this value and onwards for
750 * their own purposes; the assigned value itself is arbitrary.
752 PTLRPC_NRS_CTL_1ST_POL_SPEC = 0x20,
756 * NRS policy operations.
758 * These determine the behaviour of a policy, and are called in response to
761 struct ptlrpc_nrs_pol_ops {
763 * Called during policy registration; this operation is optional.
765 * \param[in] policy The policy being initialized
767 int (*op_policy_init) (struct ptlrpc_nrs_policy *policy);
769 * Called during policy unregistration; this operation is optional.
771 * \param[in] policy The policy being unregistered/finalized
773 void (*op_policy_fini) (struct ptlrpc_nrs_policy *policy);
775 * Called when activating a policy via lprocfs; policies allocate and
776 * initialize their resources here; this operation is optional.
778 * \param[in] policy The policy being started
780 * \see nrs_policy_start_locked()
782 int (*op_policy_start) (struct ptlrpc_nrs_policy *policy);
784 * Called when deactivating a policy via lprocfs; policies deallocate
785 * their resources here; this operation is optional
787 * \param[in] policy The policy being stopped
789 * \see nrs_policy_stop_final()
791 void (*op_policy_stop) (struct ptlrpc_nrs_policy *policy);
793 * Used for policy-specific operations; i.e. not generic ones like
794 * \e PTLRPC_NRS_CTL_START and \e PTLRPC_NRS_CTL_GET_INFO; analogous
795 * to an ioctl; this operation is optional.
797 * \param[in] policy The policy carrying out operation \a opc
798 * \param[in] opc The command operation being carried out
799 * \param[in,out] arg An generic buffer for communication between the
800 * user and the control operation
805 * \see ptlrpc_nrs_policy_control()
807 int (*op_policy_ctl) (struct ptlrpc_nrs_policy *policy,
808 enum ptlrpc_nrs_ctl opc, void *arg);
811 * Called when obtaining references to the resources of the resource
812 * hierarchy for a request that has arrived for handling at the PTLRPC
813 * service. Policies should return -ve for requests they do not wish
814 * to handle. This operation is mandatory.
816 * \param[in] policy The policy we're getting resources for.
817 * \param[in] nrq The request we are getting resources for.
818 * \param[in] parent The parent resource of the resource being
819 * requested; set to NULL if none.
820 * \param[out] resp The resource is to be returned here; the
821 * fallback policy in an NRS head should
822 * \e always return a non-NULL pointer value.
823 * \param[in] moving_req When set, signifies that this is an attempt
824 * to obtain resources for a request being moved
825 * to the high-priority NRS head by
826 * ldlm_lock_reorder_req().
827 * This implies two things:
828 * 1. We are under obd_export::exp_rpc_lock and
829 * so should not sleep.
830 * 2. We should not perform non-idempotent or can
831 * skip performing idempotent operations that
832 * were carried out when resources were first
833 * taken for the request when it was initialized
834 * in ptlrpc_nrs_req_initialize().
836 * \retval 0, +ve The level of the returned resource in the resource
837 * hierarchy; currently only 0 (for a non-leaf resource)
838 * and 1 (for a leaf resource) are supported by the
842 * \see ptlrpc_nrs_req_initialize()
843 * \see ptlrpc_nrs_hpreq_add_nolock()
844 * \see ptlrpc_nrs_req_hp_move()
846 int (*op_res_get) (struct ptlrpc_nrs_policy *policy,
847 struct ptlrpc_nrs_request *nrq,
848 struct ptlrpc_nrs_resource *parent,
849 struct ptlrpc_nrs_resource **resp,
852 * Called when releasing references taken for resources in the resource
853 * hierarchy for the request; this operation is optional.
855 * \param[in] policy The policy the resource belongs to
856 * \param[in] res The resource to be freed
858 * \see ptlrpc_nrs_req_finalize()
859 * \see ptlrpc_nrs_hpreq_add_nolock()
860 * \see ptlrpc_nrs_req_hp_move()
862 void (*op_res_put) (struct ptlrpc_nrs_policy *policy,
863 struct ptlrpc_nrs_resource *res);
866 * Obtain a request for handling from the policy via polling; this
867 * operation is mandatory.
869 * \param[in] policy The policy to poll
871 * \retval NULL No erquest available for handling
872 * \retval valid-pointer The request polled for handling
874 * \see ptlrpc_nrs_req_poll_nolock()
876 struct ptlrpc_nrs_request *
877 (*op_req_poll) (struct ptlrpc_nrs_policy *policy);
879 * Called when attempting to add a request to a policy for later
880 * handling; this operation is mandatory.
882 * \param[in] policy The policy on which to enqueue \a nrq
883 * \param[in] nrq The request to enqueue
888 * \see ptlrpc_nrs_req_add_nolock()
890 int (*op_req_enqueue) (struct ptlrpc_nrs_policy *policy,
891 struct ptlrpc_nrs_request *nrq);
893 * Removes a request from the policy's set of pending requests. Normally
894 * called after a request has been polled successfully from the policy
895 * for handling; this operation is mandatory.
897 * \param[in] policy The policy the request \a nrq belongs to
898 * \param[in] nrq The request to dequeue
900 * \see ptlrpc_nrs_req_del_nolock()
902 void (*op_req_dequeue) (struct ptlrpc_nrs_policy *policy,
903 struct ptlrpc_nrs_request *nrq);
905 * Called before carrying out the request; should not block. Could be
906 * used for job/resource control; this operation is optional.
908 * \param[in] policy The policy which is starting to handle request
910 * \param[in] nrq The request
912 * \pre spin_is_locked(&svcpt->scp_req_lock)
914 * \see ptlrpc_nrs_req_start_nolock()
916 void (*op_req_start) (struct ptlrpc_nrs_policy *policy,
917 struct ptlrpc_nrs_request *nrq);
919 * Called after the request being carried out. Could be used for
920 * job/resource control; this operation is optional.
922 * \param[in] policy The policy which is stopping to handle request
924 * \param[in] nrq The request
926 * \pre spin_is_locked(&svcpt->scp_req_lock)
928 * \see ptlrpc_nrs_req_stop_nolock()
930 void (*op_req_stop) (struct ptlrpc_nrs_policy *policy,
931 struct ptlrpc_nrs_request *nrq);
933 * Registers the policy's lprocfs interface with a PTLRPC service.
935 * \param[in] svc The service
940 int (*op_lprocfs_init) (struct ptlrpc_service *svc);
942 * Unegisters the policy's lprocfs interface with a PTLRPC service.
944 * \param[in] svc The service
946 void (*op_lprocfs_fini) (struct ptlrpc_service *svc);
952 enum nrs_policy_flags {
954 * Fallback policy, use this flag only on a single supported policy per
955 * service. Do not use this flag for policies registering using
956 * ptlrpc_nrs_policy_register() (i.e. ones that are not in
957 * \e nrs_pols_builtin).
959 PTLRPC_NRS_FL_FALLBACK = (1 << 0),
961 * Start policy immediately after registering.
963 PTLRPC_NRS_FL_REG_START = (1 << 1),
965 * This is a polciy registering externally with NRS core, via
966 * ptlrpc_nrs_policy_register(), (i.e. one that is not in
967 * \e nrs_pols_builtin. Used to avoid ptlrpc_nrs_policy_register()
968 * racing with a policy start operation issued by the user via lprocfs.
970 PTLRPC_NRS_FL_REG_EXTERN = (1 << 2),
976 * Denotes whether an NRS instance is for handling normal or high-priority
977 * RPCs, or whether an operation pertains to one or both of the NRS instances
980 enum ptlrpc_nrs_queue_type {
981 PTLRPC_NRS_QUEUE_REG,
983 PTLRPC_NRS_QUEUE_BOTH,
989 * A PTLRPC service has at least one NRS head instance for handling normal
990 * priority RPCs, and may optionally have a second NRS head instance for
991 * handling high-priority RPCs. Each NRS head maintains a list of available
992 * policies, of which one and only one policy is acting as the fallback policy,
993 * and optionally a different policy may be acting as the primary policy. For
994 * all RPCs handled by this NRS head instance, NRS core will first attempt to
995 * enqueue the RPC using the primary policy (if any). The fallback policy is
996 * used in the following cases:
997 * - when there was no primary policy in the
998 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state at the time the request
1000 * - when the primary policy that was at the
1001 * ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1002 * RPC was initialized, denoted it did not wish, or for some other reason was
1003 * not able to handle the request, by returning a non-valid NRS resource
1005 * - when the primary policy that was at the
1006 * ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1007 * RPC was initialized, fails later during the request enqueueing stage.
1009 * \see nrs_resource_get_safe()
1010 * \see nrs_request_enqueue()
1013 spinlock_t nrs_lock;
1014 /** XXX Possibly replace svcpt->scp_req_lock with another lock here. */
1016 * Linkage into nrs_core_heads_list
1018 cfs_list_t nrs_heads;
1020 * List of registered policies
1022 cfs_list_t nrs_policy_list;
1024 * List of policies with queued requests. Policies that have any
1025 * outstanding requests are queued here, and this list is queried
1026 * in a round-robin manner from NRS core when obtaining a request
1027 * for handling. This ensures that requests from policies that at some
1028 * point transition away from the
1029 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state are drained.
1031 cfs_list_t nrs_policy_queued;
1033 * Service partition for this NRS head
1035 struct ptlrpc_service_part *nrs_svcpt;
1037 * Primary policy, which is the preferred policy for handling RPCs
1039 struct ptlrpc_nrs_policy *nrs_policy_primary;
1041 * Fallback policy, which is the backup policy for handling RPCs
1043 struct ptlrpc_nrs_policy *nrs_policy_fallback;
1045 * This NRS head handles either HP or regular requests
1047 enum ptlrpc_nrs_queue_type nrs_queue_type;
1049 * # queued requests from all policies in this NRS head
1051 unsigned long nrs_req_queued;
1053 * # scheduled requests from all policies in this NRS head
1055 unsigned long nrs_req_started;
1057 * # policies on this NRS
1058 * TODO: Can we avoid having this?
1060 unsigned nrs_num_pols;
1062 * This NRS head is in progress of starting a policy
1064 unsigned nrs_policy_starting:1;
1066 * In progress of shutting down the whole NRS head; used during
1069 unsigned nrs_stopping:1;
1072 #define NRS_POL_NAME_MAX 16
1075 * NRS policy registering descriptor
1077 * Is used to hold a description of a policy that can be passed to NRS core in
1078 * order to register the policy with NRS heads in different PTLRPC services.
1080 struct ptlrpc_nrs_pol_desc {
1082 * Human-readable policy name
1084 char pd_name[NRS_POL_NAME_MAX];
1086 * NRS operations for this policy
1088 struct ptlrpc_nrs_pol_ops *pd_ops;
1090 * Service Compatibility function; this determines whether a policy is
1091 * adequate for handling RPCs of a particular PTLRPC service.
1093 * XXX:This should give the same result during policy
1094 * registration and unregistration, and for all partitions of a
1095 * service; so the result should not depend on temporal service
1096 * or other properties, that may influence the result.
1098 bool (*pd_compat) (struct ptlrpc_service *svc,
1099 const struct ptlrpc_nrs_pol_desc *desc);
1101 * Optionally set for policies that support a single ptlrpc service,
1102 * i.e. ones that have \a pd_compat set to nrs_policy_compat_one()
1104 char *pd_compat_svc_name;
1106 * Bitmask of nrs_policy_flags
1110 * Link into nrs_core::nrs_policies
1118 * Policies transition from one state to the other during their lifetime
1120 enum ptlrpc_nrs_pol_state {
1122 * Not a valid policy state.
1124 NRS_POL_STATE_INVALID,
1126 * For now, this state is used exclusively for policies that register
1127 * externally to NRS core, i.e. ones that do so via
1128 * ptlrpc_nrs_policy_register() and are not part of nrs_pols_builtin;
1129 * it is used to prevent a race condition between the policy registering
1130 * with more than one service partition while service is operational,
1131 * and the user starting the policy via lprocfs.
1133 * \see nrs_pol_make_avail()
1135 NRS_POL_STATE_UNAVAIL,
1137 * Policies are at this state either at the start of their life, or
1138 * transition here when the user selects a different policy to act
1139 * as the primary one.
1141 NRS_POL_STATE_STOPPED,
1143 * Policy is progress of stopping
1145 NRS_POL_STATE_STOPPING,
1147 * Policy is in progress of starting
1149 NRS_POL_STATE_STARTING,
1151 * A policy is in this state in two cases:
1152 * - it is the fallback policy, which is always in this state.
1153 * - it has been activated by the user; i.e. it is the primary policy,
1155 NRS_POL_STATE_STARTED,
1159 * NRS policy information
1161 * Used for obtaining information for the status of a policy via lprocfs
1163 struct ptlrpc_nrs_pol_info {
1167 char pi_name[NRS_POL_NAME_MAX];
1169 * Current policy state
1171 enum ptlrpc_nrs_pol_state pi_state;
1173 * # RPCs enqueued for later dispatching by the policy
1177 * # RPCs started for dispatch by the policy
1179 long pi_req_started;
1181 * Is this a fallback policy?
1183 unsigned pi_fallback:1;
1189 * There is one instance of this for each policy in each NRS head of each
1190 * PTLRPC service partition.
1192 struct ptlrpc_nrs_policy {
1194 * Linkage into the NRS head's list of policies,
1195 * ptlrpc_nrs:nrs_policy_list
1197 cfs_list_t pol_list;
1199 * Linkage into the NRS head's list of policies with enqueued
1200 * requests ptlrpc_nrs:nrs_policy_queued
1202 cfs_list_t pol_list_queued;
1204 * Current state of this policy
1206 enum ptlrpc_nrs_pol_state pol_state;
1208 * Bitmask of nrs_policy_flags
1212 * # RPCs enqueued for later dispatching by the policy
1214 long pol_req_queued;
1216 * # RPCs started for dispatch by the policy
1218 long pol_req_started;
1220 * Usage Reference count taken on the policy instance
1224 * The NRS head this policy has been created at
1226 struct ptlrpc_nrs *pol_nrs;
1228 * NRS operations for this policy; points to ptlrpc_nrs_pol_desc::pd_ops
1230 struct ptlrpc_nrs_pol_ops *pol_ops;
1232 * Private policy data; varies by policy type
1236 * Human-readable policy name; point to ptlrpc_nrs_pol_desc::pd_name
1244 * Resources are embedded into two types of NRS entities:
1245 * - Inside NRS policies, in the policy's private data in
1246 * ptlrpc_nrs_policy::pol_private
1247 * - In objects that act as prime-level scheduling entities in different NRS
1248 * policies; e.g. on a policy that performs round robin or similar order
1249 * scheduling across client NIDs, there would be one NRS resource per unique
1250 * client NID. On a policy which performs round robin scheduling across
1251 * backend filesystem objects, there would be one resource associated with
1252 * each of the backend filesystem objects partaking in the scheduling
1253 * performed by the policy.
1255 * NRS resources share a parent-child relationship, in which resources embedded
1256 * in policy instances are the parent entities, with all scheduling entities
1257 * a policy schedules across being the children, thus forming a simple resource
1258 * hierarchy. This hierarchy may be extended with one or more levels in the
1259 * future if the ability to have more than one primary policy is added.
1261 * Upon request initialization, references to the then active NRS policies are
1262 * taken and used to later handle the dispatching of the request with one of
1265 * \see nrs_resource_get_safe()
1266 * \see ptlrpc_nrs_req_add()
1268 struct ptlrpc_nrs_resource {
1270 * This NRS resource's parent; is NULL for resources embedded in NRS
1271 * policy instances; i.e. those are top-level ones.
1273 struct ptlrpc_nrs_resource *res_parent;
1275 * The policy associated with this resource.
1277 struct ptlrpc_nrs_policy *res_policy;
1290 * This policy is a logical wrapper around previous, non-NRS functionality.
1291 * It dispatches RPCs in the same order as they arrive from the network. This
1292 * policy is currently used as the fallback policy, and the only enabled policy
1293 * on all NRS heads of all PTLRPC service partitions.
1298 * Private data structure for the FIFO policy
1300 struct nrs_fifo_head {
1302 * Resource object for policy instance.
1304 struct ptlrpc_nrs_resource fh_res;
1306 * List of queued requests.
1310 * For debugging purposes.
1315 struct nrs_fifo_req {
1316 /** request header, must be the first member of structure */
1326 * Instances of this object exist embedded within ptlrpc_request; the main
1327 * purpose of this object is to hold references to the request's resources
1328 * for the lifetime of the request, and to hold properties that policies use
1329 * use for determining the request's scheduling priority.
1331 struct ptlrpc_nrs_request {
1333 * The request's resource hierarchy.
1335 struct ptlrpc_nrs_resource *nr_res_ptrs[NRS_RES_MAX];
1337 * Index into ptlrpc_nrs_request::nr_res_ptrs of the resource of the
1338 * policy that was used to enqueue the request.
1340 * \see nrs_request_enqueue()
1342 unsigned nr_res_idx;
1343 unsigned nr_initialized:1;
1344 unsigned nr_enqueued:1;
1345 unsigned nr_dequeued:1;
1346 unsigned nr_started:1;
1347 unsigned nr_finalized:1;
1348 cfs_binheap_node_t nr_node;
1351 * Policy-specific fields, used for determining a request's scheduling
1352 * priority, and other supporting functionality.
1356 * Fields for the FIFO policy
1358 struct nrs_fifo_req fifo;
1361 * Externally-registering policies may want to use this to allocate
1362 * their own request properties.
1370 * Basic request prioritization operations structure.
1371 * The whole idea is centered around locks and RPCs that might affect locks.
1372 * When a lock is contended we try to give priority to RPCs that might lead
1373 * to fastest release of that lock.
1374 * Currently only implemented for OSTs only in a way that makes all
1375 * IO and truncate RPCs that are coming from a locked region where a lock is
1376 * contended a priority over other requests.
1378 struct ptlrpc_hpreq_ops {
1380 * Check if the lock handle of the given lock is the same as
1381 * taken from the request.
1383 int (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
1385 * Check if the request is a high priority one.
1387 int (*hpreq_check)(struct ptlrpc_request *);
1389 * Called after the request has been handled.
1391 void (*hpreq_fini)(struct ptlrpc_request *);
1395 * Represents remote procedure call.
1397 * This is a staple structure used by everybody wanting to send a request
1400 struct ptlrpc_request {
1401 /* Request type: one of PTL_RPC_MSG_* */
1403 /** Result of request processing */
1406 * Linkage item through which this request is included into
1407 * sending/delayed lists on client and into rqbd list on server
1411 * Server side list of incoming unserved requests sorted by arrival
1412 * time. Traversed from time to time to notice about to expire
1413 * requests and sent back "early replies" to clients to let them
1414 * know server is alive and well, just very busy to service their
1417 cfs_list_t rq_timed_list;
1418 /** server-side history, used for debuging purposes. */
1419 cfs_list_t rq_history_list;
1420 /** server-side per-export list */
1421 cfs_list_t rq_exp_list;
1422 /** server-side hp handlers */
1423 struct ptlrpc_hpreq_ops *rq_ops;
1425 /** initial thread servicing this request */
1426 struct ptlrpc_thread *rq_svc_thread;
1428 /** history sequence # */
1429 __u64 rq_history_seq;
1433 /** stub for NRS request */
1434 struct ptlrpc_nrs_request rq_nrq;
1436 /** the index of service's srv_at_array into which request is linked */
1438 /** Lock to protect request flags and some other important bits, like
1442 /** client-side flags are serialized by rq_lock */
1443 unsigned int rq_intr:1, rq_replied:1, rq_err:1,
1444 rq_timedout:1, rq_resend:1, rq_restart:1,
1446 * when ->rq_replay is set, request is kept by the client even
1447 * after server commits corresponding transaction. This is
1448 * used for operations that require sequence of multiple
1449 * requests to be replayed. The only example currently is file
1450 * open/close. When last request in such a sequence is
1451 * committed, ->rq_replay is cleared on all requests in the
1455 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
1456 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
1457 rq_early:1, rq_must_unlink:1,
1458 rq_memalloc:1, /* req originated from "kswapd" */
1459 /* server-side flags */
1460 rq_packed_final:1, /* packed final reply */
1461 rq_hp:1, /* high priority RPC */
1462 rq_at_linked:1, /* link into service's srv_at_array */
1463 rq_reply_truncate:1,
1465 /* whether the "rq_set" is a valid one */
1467 rq_generation_set:1,
1468 /* do not resend request on -EINPROGRESS */
1469 rq_no_retry_einprogress:1,
1470 /* allow the req to be sent if the import is in recovery
1474 unsigned int rq_nr_resend;
1476 enum rq_phase rq_phase; /* one of RQ_PHASE_* */
1477 enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
1478 cfs_atomic_t rq_refcount;/* client-side refcount for SENT race,
1479 server-side refcounf for multiple replies */
1481 /** Portal to which this request would be sent */
1482 short rq_request_portal; /* XXX FIXME bug 249 */
1483 /** Portal where to wait for reply and where reply would be sent */
1484 short rq_reply_portal; /* XXX FIXME bug 249 */
1488 * !rq_truncate : # reply bytes actually received,
1489 * rq_truncate : required repbuf_len for resend
1491 int rq_nob_received;
1492 /** Request length */
1496 /** Request message - what client sent */
1497 struct lustre_msg *rq_reqmsg;
1498 /** Reply message - server response */
1499 struct lustre_msg *rq_repmsg;
1500 /** Transaction number */
1505 * List item to for replay list. Not yet commited requests get linked
1507 * Also see \a rq_replay comment above.
1509 cfs_list_t rq_replay_list;
1512 * security and encryption data
1514 struct ptlrpc_cli_ctx *rq_cli_ctx; /**< client's half ctx */
1515 struct ptlrpc_svc_ctx *rq_svc_ctx; /**< server's half ctx */
1516 cfs_list_t rq_ctx_chain; /**< link to waited ctx */
1518 struct sptlrpc_flavor rq_flvr; /**< for client & server */
1519 enum lustre_sec_part rq_sp_from;
1521 /* client/server security flags */
1523 rq_ctx_init:1, /* context initiation */
1524 rq_ctx_fini:1, /* context destroy */
1525 rq_bulk_read:1, /* request bulk read */
1526 rq_bulk_write:1, /* request bulk write */
1527 /* server authentication flags */
1528 rq_auth_gss:1, /* authenticated by gss */
1529 rq_auth_remote:1, /* authed as remote user */
1530 rq_auth_usr_root:1, /* authed as root */
1531 rq_auth_usr_mdt:1, /* authed as mdt */
1532 rq_auth_usr_ost:1, /* authed as ost */
1533 /* security tfm flags */
1536 /* doesn't expect reply FIXME */
1538 rq_pill_init:1; /* pill initialized */
1540 uid_t rq_auth_uid; /* authed uid */
1541 uid_t rq_auth_mapped_uid; /* authed uid mapped to */
1543 /* (server side), pointed directly into req buffer */
1544 struct ptlrpc_user_desc *rq_user_desc;
1546 /* various buffer pointers */
1547 struct lustre_msg *rq_reqbuf; /* req wrapper */
1548 char *rq_repbuf; /* rep buffer */
1549 struct lustre_msg *rq_repdata; /* rep wrapper msg */
1550 struct lustre_msg *rq_clrbuf; /* only in priv mode */
1551 int rq_reqbuf_len; /* req wrapper buf len */
1552 int rq_reqdata_len; /* req wrapper msg len */
1553 int rq_repbuf_len; /* rep buffer len */
1554 int rq_repdata_len; /* rep wrapper msg len */
1555 int rq_clrbuf_len; /* only in priv mode */
1556 int rq_clrdata_len; /* only in priv mode */
1558 /** early replies go to offset 0, regular replies go after that */
1559 unsigned int rq_reply_off;
1563 /** Fields that help to see if request and reply were swabbed or not */
1564 __u32 rq_req_swab_mask;
1565 __u32 rq_rep_swab_mask;
1567 /** What was import generation when this request was sent */
1568 int rq_import_generation;
1569 enum lustre_imp_state rq_send_state;
1571 /** how many early replies (for stats) */
1574 /** client+server request */
1575 lnet_handle_md_t rq_req_md_h;
1576 struct ptlrpc_cb_id rq_req_cbid;
1577 /** optional time limit for send attempts */
1578 cfs_duration_t rq_delay_limit;
1579 /** time request was first queued */
1580 cfs_time_t rq_queued_time;
1582 /* server-side... */
1583 /** request arrival time */
1584 struct timeval rq_arrival_time;
1585 /** separated reply state */
1586 struct ptlrpc_reply_state *rq_reply_state;
1587 /** incoming request buffer */
1588 struct ptlrpc_request_buffer_desc *rq_rqbd;
1590 /** client-only incoming reply */
1591 lnet_handle_md_t rq_reply_md_h;
1592 cfs_waitq_t rq_reply_waitq;
1593 struct ptlrpc_cb_id rq_reply_cbid;
1597 /** Peer description (the other side) */
1598 lnet_process_id_t rq_peer;
1599 /** Server-side, export on which request was received */
1600 struct obd_export *rq_export;
1601 /** Client side, import where request is being sent */
1602 struct obd_import *rq_import;
1604 /** Replay callback, called after request is replayed at recovery */
1605 void (*rq_replay_cb)(struct ptlrpc_request *);
1607 * Commit callback, called when request is committed and about to be
1610 void (*rq_commit_cb)(struct ptlrpc_request *);
1611 /** Opaq data for replay and commit callbacks. */
1614 /** For bulk requests on client only: bulk descriptor */
1615 struct ptlrpc_bulk_desc *rq_bulk;
1617 /** client outgoing req */
1619 * when request/reply sent (secs), or time when request should be sent
1622 /** time for request really sent out */
1623 time_t rq_real_sent;
1625 /** when request must finish. volatile
1626 * so that servers' early reply updates to the deadline aren't
1627 * kept in per-cpu cache */
1628 volatile time_t rq_deadline;
1629 /** when req reply unlink must finish. */
1630 time_t rq_reply_deadline;
1631 /** when req bulk unlink must finish. */
1632 time_t rq_bulk_deadline;
1634 * service time estimate (secs)
1635 * If the requestsis not served by this time, it is marked as timed out.
1639 /** Multi-rpc bits */
1640 /** Per-request waitq introduced by bug 21938 for recovery waiting */
1641 cfs_waitq_t rq_set_waitq;
1642 /** Link item for request set lists */
1643 cfs_list_t rq_set_chain;
1644 /** Link back to the request set */
1645 struct ptlrpc_request_set *rq_set;
1646 /** Async completion handler, called when reply is received */
1647 ptlrpc_interpterer_t rq_interpret_reply;
1648 /** Async completion context */
1649 union ptlrpc_async_args rq_async_args;
1651 /** Pool if request is from preallocated list */
1652 struct ptlrpc_request_pool *rq_pool;
1654 struct lu_context rq_session;
1655 struct lu_context rq_recov_session;
1657 /** request format description */
1658 struct req_capsule rq_pill;
1662 * Call completion handler for rpc if any, return it's status or original
1663 * rc if there was no handler defined for this request.
1665 static inline int ptlrpc_req_interpret(const struct lu_env *env,
1666 struct ptlrpc_request *req, int rc)
1668 if (req->rq_interpret_reply != NULL) {
1669 req->rq_status = req->rq_interpret_reply(env, req,
1670 &req->rq_async_args,
1672 return req->rq_status;
1680 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_desc *desc);
1681 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_desc *desc);
1682 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
1683 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
1684 struct ptlrpc_nrs_pol_info *info);
1687 * Can the request be moved from the regular NRS head to the high-priority NRS
1688 * head (of the same PTLRPC service partition), if any?
1690 * For a reliable result, this should be checked under svcpt->scp_req lock.
1693 ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
1695 struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
1698 * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
1699 * request has been enqueued first, and ptlrpc_nrs_request::nr_started
1700 * to make sure it has not been scheduled yet (analogous to previous
1701 * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
1703 return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
1708 * Returns 1 if request buffer at offset \a index was already swabbed
1710 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
1712 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1713 return req->rq_req_swab_mask & (1 << index);
1717 * Returns 1 if request reply buffer at offset \a index was already swabbed
1719 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
1721 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1722 return req->rq_rep_swab_mask & (1 << index);
1726 * Returns 1 if request needs to be swabbed into local cpu byteorder
1728 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
1730 return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1734 * Returns 1 if request reply needs to be swabbed into local cpu byteorder
1736 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
1738 return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1742 * Mark request buffer at offset \a index that it was already swabbed
1744 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
1746 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1747 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
1748 req->rq_req_swab_mask |= 1 << index;
1752 * Mark request reply buffer at offset \a index that it was already swabbed
1754 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
1756 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1757 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
1758 req->rq_rep_swab_mask |= 1 << index;
1762 * Convert numerical request phase value \a phase into text string description
1764 static inline const char *
1765 ptlrpc_phase2str(enum rq_phase phase)
1774 case RQ_PHASE_INTERPRET:
1776 case RQ_PHASE_COMPLETE:
1778 case RQ_PHASE_UNREGISTERING:
1779 return "Unregistering";
1786 * Convert numerical request phase of the request \a req into text stringi
1789 static inline const char *
1790 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1792 return ptlrpc_phase2str(req->rq_phase);
1796 * Debugging functions and helpers to print request structure into debug log
1799 /* Spare the preprocessor, spoil the bugs. */
1800 #define FLAG(field, str) (field ? str : "")
1802 /** Convert bit flags into a string */
1803 #define DEBUG_REQ_FLAGS(req) \
1804 ptlrpc_rqphase2str(req), \
1805 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
1806 FLAG(req->rq_err, "E"), \
1807 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
1808 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
1809 FLAG(req->rq_no_resend, "N"), \
1810 FLAG(req->rq_waiting, "W"), \
1811 FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \
1812 FLAG(req->rq_committed, "M")
1814 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s"
1816 void _debug_req(struct ptlrpc_request *req,
1817 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1818 __attribute__ ((format (printf, 3, 4)));
1821 * Helper that decides if we need to print request accordig to current debug
1824 #define debug_req(msgdata, mask, cdls, req, fmt, a...) \
1826 CFS_CHECK_STACK(msgdata, mask, cdls); \
1828 if (((mask) & D_CANTMASK) != 0 || \
1829 ((libcfs_debug & (mask)) != 0 && \
1830 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1831 _debug_req((req), msgdata, fmt, ##a); \
1835 * This is the debug print function you need to use to print request sturucture
1836 * content into lustre debug log.
1837 * for most callers (level is a constant) this is resolved at compile time */
1838 #define DEBUG_REQ(level, req, fmt, args...) \
1840 if ((level) & (D_ERROR | D_WARNING)) { \
1841 static cfs_debug_limit_state_t cdls; \
1842 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1843 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1845 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1846 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
1852 * Structure that defines a single page of a bulk transfer
1854 struct ptlrpc_bulk_page {
1855 /** Linkage to list of pages in a bulk */
1858 * Number of bytes in a page to transfer starting from \a bp_pageoffset
1861 /** offset within a page */
1863 /** The page itself */
1864 struct page *bp_page;
1867 #define BULK_GET_SOURCE 0
1868 #define BULK_PUT_SINK 1
1869 #define BULK_GET_SINK 2
1870 #define BULK_PUT_SOURCE 3
1873 * Definition of bulk descriptor.
1874 * Bulks are special "Two phase" RPCs where initial request message
1875 * is sent first and it is followed bt a transfer (o receiving) of a large
1876 * amount of data to be settled into pages referenced from the bulk descriptors.
1877 * Bulks transfers (the actual data following the small requests) are done
1878 * on separate LNet portals.
1879 * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1880 * Another user is readpage for MDT.
1882 struct ptlrpc_bulk_desc {
1883 /** completed with failure */
1884 unsigned long bd_failure:1;
1885 /** {put,get}{source,sink} */
1886 unsigned long bd_type:2;
1888 unsigned long bd_registered:1;
1889 /** For serialization with callback */
1891 /** Import generation when request for this bulk was sent */
1892 int bd_import_generation;
1893 /** LNet portal for this bulk */
1895 /** Server side - export this bulk created for */
1896 struct obd_export *bd_export;
1897 /** Client side - import this bulk was sent on */
1898 struct obd_import *bd_import;
1899 /** Back pointer to the request */
1900 struct ptlrpc_request *bd_req;
1901 cfs_waitq_t bd_waitq; /* server side only WQ */
1902 int bd_iov_count; /* # entries in bd_iov */
1903 int bd_max_iov; /* allocated size of bd_iov */
1904 int bd_nob; /* # bytes covered */
1905 int bd_nob_transferred; /* # bytes GOT/PUT */
1909 struct ptlrpc_cb_id bd_cbid; /* network callback info */
1910 lnet_nid_t bd_sender; /* stash event::sender */
1911 int bd_md_count; /* # valid entries in bd_mds */
1912 int bd_md_max_brw; /* max entries in bd_mds */
1913 /** array of associated MDs */
1914 lnet_handle_md_t bd_mds[PTLRPC_BULK_OPS_COUNT];
1916 #if defined(__KERNEL__)
1918 * encrypt iov, size is either 0 or bd_iov_count.
1920 lnet_kiov_t *bd_enc_iov;
1922 lnet_kiov_t bd_iov[0];
1924 lnet_md_iovec_t bd_iov[0];
1929 SVC_STOPPED = 1 << 0,
1930 SVC_STOPPING = 1 << 1,
1931 SVC_STARTING = 1 << 2,
1932 SVC_RUNNING = 1 << 3,
1934 SVC_SIGNAL = 1 << 5,
1937 #define PTLRPC_THR_NAME_LEN 32
1939 * Definition of server service thread structure
1941 struct ptlrpc_thread {
1943 * List of active threads in svc->srv_threads
1947 * thread-private data (preallocated memory)
1952 * service thread index, from ptlrpc_start_threads
1956 * service thread pid
1960 * put watchdog in the structure per thread b=14840
1962 struct lc_watchdog *t_watchdog;
1964 * the svc this thread belonged to b=18582
1966 struct ptlrpc_service_part *t_svcpt;
1967 cfs_waitq_t t_ctl_waitq;
1968 struct lu_env *t_env;
1969 char t_name[PTLRPC_THR_NAME_LEN];
1972 static inline int thread_is_init(struct ptlrpc_thread *thread)
1974 return thread->t_flags == 0;
1977 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1979 return !!(thread->t_flags & SVC_STOPPED);
1982 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1984 return !!(thread->t_flags & SVC_STOPPING);
1987 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1989 return !!(thread->t_flags & SVC_STARTING);
1992 static inline int thread_is_running(struct ptlrpc_thread *thread)
1994 return !!(thread->t_flags & SVC_RUNNING);
1997 static inline int thread_is_event(struct ptlrpc_thread *thread)
1999 return !!(thread->t_flags & SVC_EVENT);
2002 static inline int thread_is_signal(struct ptlrpc_thread *thread)
2004 return !!(thread->t_flags & SVC_SIGNAL);
2007 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
2009 thread->t_flags &= ~flags;
2012 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
2014 thread->t_flags = flags;
2017 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
2019 thread->t_flags |= flags;
2022 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
2025 if (thread->t_flags & flags) {
2026 thread->t_flags &= ~flags;
2033 * Request buffer descriptor structure.
2034 * This is a structure that contains one posted request buffer for service.
2035 * Once data land into a buffer, event callback creates actual request and
2036 * notifies wakes one of the service threads to process new incoming request.
2037 * More than one request can fit into the buffer.
2039 struct ptlrpc_request_buffer_desc {
2040 /** Link item for rqbds on a service */
2041 cfs_list_t rqbd_list;
2042 /** History of requests for this buffer */
2043 cfs_list_t rqbd_reqs;
2044 /** Back pointer to service for which this buffer is registered */
2045 struct ptlrpc_service_part *rqbd_svcpt;
2046 /** LNet descriptor */
2047 lnet_handle_md_t rqbd_md_h;
2049 /** The buffer itself */
2051 struct ptlrpc_cb_id rqbd_cbid;
2053 * This "embedded" request structure is only used for the
2054 * last request to fit into the buffer
2056 struct ptlrpc_request rqbd_req;
2059 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
2061 struct ptlrpc_service_ops {
2063 * if non-NULL called during thread creation (ptlrpc_start_thread())
2064 * to initialize service specific per-thread state.
2066 int (*so_thr_init)(struct ptlrpc_thread *thr);
2068 * if non-NULL called during thread shutdown (ptlrpc_main()) to
2069 * destruct state created by ->srv_init().
2071 void (*so_thr_done)(struct ptlrpc_thread *thr);
2073 * Handler function for incoming requests for this service
2075 int (*so_req_handler)(struct ptlrpc_request *req);
2077 * function to determine priority of the request, it's called
2078 * on every new request
2080 int (*so_hpreq_handler)(struct ptlrpc_request *);
2082 * service-specific print fn
2084 void (*so_req_printer)(void *, struct ptlrpc_request *);
2087 #ifndef __cfs_cacheline_aligned
2088 /* NB: put it here for reducing patche dependence */
2089 # define __cfs_cacheline_aligned
2093 * How many high priority requests to serve before serving one normal
2096 #define PTLRPC_SVC_HP_RATIO 10
2099 * Definition of PortalRPC service.
2100 * The service is listening on a particular portal (like tcp port)
2101 * and perform actions for a specific server like IO service for OST
2102 * or general metadata service for MDS.
2104 struct ptlrpc_service {
2105 /** serialize /proc operations */
2106 spinlock_t srv_lock;
2107 /** most often accessed fields */
2108 /** chain thru all services */
2109 cfs_list_t srv_list;
2110 /** service operations table */
2111 struct ptlrpc_service_ops srv_ops;
2112 /** only statically allocated strings here; we don't clean them */
2114 /** only statically allocated strings here; we don't clean them */
2115 char *srv_thread_name;
2116 /** service thread list */
2117 cfs_list_t srv_threads;
2118 /** threads # should be created for each partition on initializing */
2119 int srv_nthrs_cpt_init;
2120 /** limit of threads number for each partition */
2121 int srv_nthrs_cpt_limit;
2122 /** Root of /proc dir tree for this service */
2123 cfs_proc_dir_entry_t *srv_procroot;
2124 /** Pointer to statistic data for this service */
2125 struct lprocfs_stats *srv_stats;
2126 /** # hp per lp reqs to handle */
2127 int srv_hpreq_ratio;
2128 /** biggest request to receive */
2129 int srv_max_req_size;
2130 /** biggest reply to send */
2131 int srv_max_reply_size;
2132 /** size of individual buffers */
2134 /** # buffers to allocate in 1 group */
2135 int srv_nbuf_per_group;
2136 /** Local portal on which to receive requests */
2137 __u32 srv_req_portal;
2138 /** Portal on the client to send replies to */
2139 __u32 srv_rep_portal;
2141 * Tags for lu_context associated with this thread, see struct
2145 /** soft watchdog timeout multiplier */
2146 int srv_watchdog_factor;
2147 /** under unregister_service */
2148 unsigned srv_is_stopping:1;
2150 /** max # request buffers in history per partition */
2151 int srv_hist_nrqbds_cpt_max;
2152 /** number of CPTs this service bound on */
2154 /** CPTs array this service bound on */
2156 /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
2158 /** CPT table this service is running over */
2159 struct cfs_cpt_table *srv_cptable;
2161 * partition data for ptlrpc service
2163 struct ptlrpc_service_part *srv_parts[0];
2167 * Definition of PortalRPC service partition data.
2168 * Although a service only has one instance of it right now, but we
2169 * will have multiple instances very soon (instance per CPT).
2171 * it has four locks:
2173 * serialize operations on rqbd and requests waiting for preprocess
2175 * serialize operations active requests sent to this portal
2177 * serialize adaptive timeout stuff
2179 * serialize operations on RS list (reply states)
2181 * We don't have any use-case to take two or more locks at the same time
2182 * for now, so there is no lock order issue.
2184 struct ptlrpc_service_part {
2185 /** back reference to owner */
2186 struct ptlrpc_service *scp_service __cfs_cacheline_aligned;
2187 /* CPT id, reserved */
2189 /** always increasing number */
2191 /** # of starting threads */
2192 int scp_nthrs_starting;
2193 /** # of stopping threads, reserved for shrinking threads */
2194 int scp_nthrs_stopping;
2195 /** # running threads */
2196 int scp_nthrs_running;
2197 /** service threads list */
2198 cfs_list_t scp_threads;
2201 * serialize the following fields, used for protecting
2202 * rqbd list and incoming requests waiting for preprocess,
2203 * threads starting & stopping are also protected by this lock.
2205 spinlock_t scp_lock __cfs_cacheline_aligned;
2206 /** total # req buffer descs allocated */
2207 int scp_nrqbds_total;
2208 /** # posted request buffers for receiving */
2209 int scp_nrqbds_posted;
2210 /** in progress of allocating rqbd */
2211 int scp_rqbd_allocating;
2212 /** # incoming reqs */
2213 int scp_nreqs_incoming;
2214 /** request buffers to be reposted */
2215 cfs_list_t scp_rqbd_idle;
2216 /** req buffers receiving */
2217 cfs_list_t scp_rqbd_posted;
2218 /** incoming reqs */
2219 cfs_list_t scp_req_incoming;
2220 /** timeout before re-posting reqs, in tick */
2221 cfs_duration_t scp_rqbd_timeout;
2223 * all threads sleep on this. This wait-queue is signalled when new
2224 * incoming request arrives and when difficult reply has to be handled.
2226 cfs_waitq_t scp_waitq;
2228 /** request history */
2229 cfs_list_t scp_hist_reqs;
2230 /** request buffer history */
2231 cfs_list_t scp_hist_rqbds;
2232 /** # request buffers in history */
2233 int scp_hist_nrqbds;
2234 /** sequence number for request */
2236 /** highest seq culled from history */
2237 __u64 scp_hist_seq_culled;
2240 * serialize the following fields, used for processing requests
2241 * sent to this portal
2243 spinlock_t scp_req_lock __cfs_cacheline_aligned;
2244 /** # reqs in either of the NRS heads below */
2245 /** # reqs being served */
2246 int scp_nreqs_active;
2247 /** # HPreqs being served */
2248 int scp_nhreqs_active;
2249 /** # hp requests handled */
2252 /** NRS head for regular requests */
2253 struct ptlrpc_nrs scp_nrs_reg;
2254 /** NRS head for HP requests; this is only valid for services that can
2255 * handle HP requests */
2256 struct ptlrpc_nrs *scp_nrs_hp;
2261 * serialize the following fields, used for changes on
2264 spinlock_t scp_at_lock __cfs_cacheline_aligned;
2265 /** estimated rpc service time */
2266 struct adaptive_timeout scp_at_estimate;
2267 /** reqs waiting for replies */
2268 struct ptlrpc_at_array scp_at_array;
2269 /** early reply timer */
2270 cfs_timer_t scp_at_timer;
2272 cfs_time_t scp_at_checktime;
2273 /** check early replies */
2274 unsigned scp_at_check;
2278 * serialize the following fields, used for processing
2279 * replies for this portal
2281 spinlock_t scp_rep_lock __cfs_cacheline_aligned;
2282 /** all the active replies */
2283 cfs_list_t scp_rep_active;
2285 /** replies waiting for service */
2286 cfs_list_t scp_rep_queue;
2288 /** List of free reply_states */
2289 cfs_list_t scp_rep_idle;
2290 /** waitq to run, when adding stuff to srv_free_rs_list */
2291 cfs_waitq_t scp_rep_waitq;
2292 /** # 'difficult' replies */
2293 cfs_atomic_t scp_nreps_difficult;
2296 #define ptlrpc_service_for_each_part(part, i, svc) \
2298 i < (svc)->srv_ncpts && \
2299 (svc)->srv_parts != NULL && \
2300 ((part) = (svc)->srv_parts[i]) != NULL; i++)
2303 * Declaration of ptlrpcd control structure
2305 struct ptlrpcd_ctl {
2307 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
2309 unsigned long pc_flags;
2311 * Thread lock protecting structure fields.
2317 struct completion pc_starting;
2321 struct completion pc_finishing;
2323 * Thread requests set.
2325 struct ptlrpc_request_set *pc_set;
2327 * Thread name used in cfs_daemonize()
2331 * Environment for request interpreters to run in.
2333 struct lu_env pc_env;
2335 * Index of ptlrpcd thread in the array.
2339 * Number of the ptlrpcd's partners.
2343 * Pointer to the array of partners' ptlrpcd_ctl structure.
2345 struct ptlrpcd_ctl **pc_partners;
2347 * Record the partner index to be processed next.
2352 * Async rpcs flag to make sure that ptlrpcd_check() is called only
2357 * Currently not used.
2361 * User-space async rpcs callback.
2363 void *pc_wait_callback;
2365 * User-space check idle rpcs callback.
2367 void *pc_idle_callback;
2371 /* Bits for pc_flags */
2372 enum ptlrpcd_ctl_flags {
2374 * Ptlrpc thread start flag.
2376 LIOD_START = 1 << 0,
2378 * Ptlrpc thread stop flag.
2382 * Ptlrpc thread force flag (only stop force so far).
2383 * This will cause aborting any inflight rpcs handled
2384 * by thread if LIOD_STOP is specified.
2386 LIOD_FORCE = 1 << 2,
2388 * This is a recovery ptlrpc thread.
2390 LIOD_RECOVERY = 1 << 3,
2392 * The ptlrpcd is bound to some CPU core.
2401 * Service compatibility function; policy is compatible with all services.
2403 * \param[in] svc The service the policy is attempting to register with.
2404 * \param[in] desc The policy descriptor
2406 * \retval true The policy is compatible with the NRS head
2408 * \see ptlrpc_nrs_pol_desc::pd_compat()
2411 nrs_policy_compat_all(struct ptlrpc_service *svc,
2412 const struct ptlrpc_nrs_pol_desc *desc)
2418 * Service compatibility function; policy is compatible with only a specific
2419 * service which is identified by its human-readable name at
2420 * ptlrpc_service::srv_name.
2422 * \param[in] svc The service the policy is attempting to register with.
2423 * \param[in] desc The policy descriptor
2425 * \retval false The policy is not compatible with the NRS head
2426 * \retval true The policy is compatible with the NRS head
2428 * \see ptlrpc_nrs_pol_desc::pd_compat()
2431 nrs_policy_compat_one(struct ptlrpc_service *svc,
2432 const struct ptlrpc_nrs_pol_desc *desc)
2434 LASSERT(desc->pd_compat_svc_name != NULL);
2435 return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
2440 /* ptlrpc/events.c */
2441 extern lnet_handle_eq_t ptlrpc_eq_h;
2442 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
2443 lnet_process_id_t *peer, lnet_nid_t *self);
2445 * These callbacks are invoked by LNet when something happened to
2449 extern void request_out_callback(lnet_event_t *ev);
2450 extern void reply_in_callback(lnet_event_t *ev);
2451 extern void client_bulk_callback(lnet_event_t *ev);
2452 extern void request_in_callback(lnet_event_t *ev);
2453 extern void reply_out_callback(lnet_event_t *ev);
2454 #ifdef HAVE_SERVER_SUPPORT
2455 extern void server_bulk_callback(lnet_event_t *ev);
2459 /* ptlrpc/connection.c */
2460 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
2462 struct obd_uuid *uuid);
2463 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2464 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2465 int ptlrpc_connection_init(void);
2466 void ptlrpc_connection_fini(void);
2467 extern lnet_pid_t ptl_get_pid(void);
2469 /* ptlrpc/niobuf.c */
2471 * Actual interfacing with LNet to put/get/register/unregister stuff
2474 #ifdef HAVE_SERVER_SUPPORT
2475 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2476 unsigned npages, unsigned max_brw,
2477 unsigned type, unsigned portal);
2478 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2479 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2481 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2485 LASSERT(desc != NULL);
2487 spin_lock(&desc->bd_lock);
2488 rc = desc->bd_md_count;
2489 spin_unlock(&desc->bd_lock);
2494 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2495 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2497 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2499 struct ptlrpc_bulk_desc *desc;
2502 LASSERT(req != NULL);
2503 desc = req->rq_bulk;
2505 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK) &&
2506 req->rq_bulk_deadline > cfs_time_current_sec())
2512 spin_lock(&desc->bd_lock);
2513 rc = desc->bd_md_count;
2514 spin_unlock(&desc->bd_lock);
2518 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2519 #define PTLRPC_REPLY_EARLY 0x02
2520 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2521 int ptlrpc_reply(struct ptlrpc_request *req);
2522 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2523 int ptlrpc_error(struct ptlrpc_request *req);
2524 void ptlrpc_resend_req(struct ptlrpc_request *request);
2525 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2526 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2527 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2530 /* ptlrpc/client.c */
2532 * Client-side portals API. Everything to send requests, receive replies,
2533 * request queues, request management, etc.
2536 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
2537 struct ptlrpc_client *);
2538 void ptlrpc_cleanup_client(struct obd_import *imp);
2539 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
2541 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2542 int ptlrpc_replay_req(struct ptlrpc_request *req);
2543 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
2544 void ptlrpc_restart_req(struct ptlrpc_request *req);
2545 void ptlrpc_abort_inflight(struct obd_import *imp);
2546 void ptlrpc_cleanup_imp(struct obd_import *imp);
2547 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2549 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2550 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2552 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
2553 set_interpreter_func fn, void *data);
2554 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
2555 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2556 int ptlrpc_set_wait(struct ptlrpc_request_set *);
2557 int ptlrpc_expired_set(void *data);
2558 void ptlrpc_interrupted_set(void *data);
2559 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2560 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2561 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2562 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
2563 struct ptlrpc_request *req);
2565 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2566 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2568 struct ptlrpc_request_pool *
2569 ptlrpc_init_rq_pool(int, int,
2570 void (*populate_pool)(struct ptlrpc_request_pool *, int));
2572 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2573 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2574 const struct req_format *format);
2575 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2576 struct ptlrpc_request_pool *,
2577 const struct req_format *format);
2578 void ptlrpc_request_free(struct ptlrpc_request *request);
2579 int ptlrpc_request_pack(struct ptlrpc_request *request,
2580 __u32 version, int opcode);
2581 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2582 const struct req_format *format,
2583 __u32 version, int opcode);
2584 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2585 __u32 version, int opcode, char **bufs,
2586 struct ptlrpc_cli_ctx *ctx);
2587 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
2588 int opcode, int count, __u32 *lengths,
2590 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
2591 __u32 version, int opcode,
2592 int count, __u32 *lengths, char **bufs,
2593 struct ptlrpc_request_pool *pool);
2594 void ptlrpc_req_finished(struct ptlrpc_request *request);
2595 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2596 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2597 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2598 unsigned npages, unsigned max_brw,
2599 unsigned type, unsigned portal);
2600 void __ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk, int pin);
2601 static inline void ptlrpc_free_bulk_pin(struct ptlrpc_bulk_desc *bulk)
2603 __ptlrpc_free_bulk(bulk, 1);
2605 static inline void ptlrpc_free_bulk_nopin(struct ptlrpc_bulk_desc *bulk)
2607 __ptlrpc_free_bulk(bulk, 0);
2609 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2610 cfs_page_t *page, int pageoffset, int len, int);
2611 static inline void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
2612 cfs_page_t *page, int pageoffset,
2615 __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
2618 static inline void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
2619 cfs_page_t *page, int pageoffset,
2622 __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
2625 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2626 struct obd_import *imp);
2627 __u64 ptlrpc_next_xid(void);
2628 __u64 ptlrpc_sample_next_xid(void);
2629 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
2631 /* Set of routines to run a function in ptlrpcd context */
2632 void *ptlrpcd_alloc_work(struct obd_import *imp,
2633 int (*cb)(const struct lu_env *, void *), void *data);
2634 void ptlrpcd_destroy_work(void *handler);
2635 int ptlrpcd_queue_work(void *handler);
2638 struct ptlrpc_service_buf_conf {
2639 /* nbufs is buffers # to allocate when growing the pool */
2640 unsigned int bc_nbufs;
2641 /* buffer size to post */
2642 unsigned int bc_buf_size;
2643 /* portal to listed for requests on */
2644 unsigned int bc_req_portal;
2645 /* portal of where to send replies to */
2646 unsigned int bc_rep_portal;
2647 /* maximum request size to be accepted for this service */
2648 unsigned int bc_req_max_size;
2649 /* maximum reply size this service can ever send */
2650 unsigned int bc_rep_max_size;
2653 struct ptlrpc_service_thr_conf {
2654 /* threadname should be 8 characters or less - 6 will be added on */
2656 /* threads increasing factor for each CPU */
2657 unsigned int tc_thr_factor;
2658 /* service threads # to start on each partition while initializing */
2659 unsigned int tc_nthrs_init;
2661 * low water of threads # upper-limit on each partition while running,
2662 * service availability may be impacted if threads number is lower
2663 * than this value. It can be ZERO if the service doesn't require
2664 * CPU affinity or there is only one partition.
2666 unsigned int tc_nthrs_base;
2667 /* "soft" limit for total threads number */
2668 unsigned int tc_nthrs_max;
2669 /* user specified threads number, it will be validated due to
2670 * other members of this structure. */
2671 unsigned int tc_nthrs_user;
2672 /* set NUMA node affinity for service threads */
2673 unsigned int tc_cpu_affinity;
2674 /* Tags for lu_context associated with service thread */
2678 struct ptlrpc_service_cpt_conf {
2679 struct cfs_cpt_table *cc_cptable;
2680 /* string pattern to describe CPTs for a service */
2684 struct ptlrpc_service_conf {
2687 /* soft watchdog timeout multiplifier to print stuck service traces */
2688 unsigned int psc_watchdog_factor;
2689 /* buffer information */
2690 struct ptlrpc_service_buf_conf psc_buf;
2691 /* thread information */
2692 struct ptlrpc_service_thr_conf psc_thr;
2693 /* CPU partition information */
2694 struct ptlrpc_service_cpt_conf psc_cpt;
2695 /* function table */
2696 struct ptlrpc_service_ops psc_ops;
2699 /* ptlrpc/service.c */
2701 * Server-side services API. Register/unregister service, request state
2702 * management, service thread management
2706 void ptlrpc_save_lock(struct ptlrpc_request *req,
2707 struct lustre_handle *lock, int mode, int no_ack);
2708 void ptlrpc_commit_replies(struct obd_export *exp);
2709 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
2710 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
2711 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
2712 struct ptlrpc_service *ptlrpc_register_service(
2713 struct ptlrpc_service_conf *conf,
2714 struct proc_dir_entry *proc_entry);
2715 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
2717 int ptlrpc_start_threads(struct ptlrpc_service *svc);
2718 int ptlrpc_unregister_service(struct ptlrpc_service *service);
2719 int liblustre_check_services(void *arg);
2720 void ptlrpc_daemonize(char *name);
2721 int ptlrpc_service_health_check(struct ptlrpc_service *);
2722 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
2725 int ptlrpc_hr_init(void);
2726 void ptlrpc_hr_fini(void);
2728 # define ptlrpc_hr_init() (0)
2729 # define ptlrpc_hr_fini() do {} while(0)
2734 /* ptlrpc/import.c */
2739 int ptlrpc_connect_import(struct obd_import *imp);
2740 int ptlrpc_init_import(struct obd_import *imp);
2741 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
2742 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
2743 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
2746 /* ptlrpc/pack_generic.c */
2747 int ptlrpc_reconnect_import(struct obd_import *imp);
2751 * ptlrpc msg buffer and swab interface
2755 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
2757 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
2759 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
2760 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
2762 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
2763 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
2765 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
2766 __u32 *lens, char **bufs);
2767 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
2769 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
2770 __u32 *lens, char **bufs, int flags);
2771 #define LPRFL_EARLY_REPLY 1
2772 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
2773 char **bufs, int flags);
2774 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
2775 unsigned int newlen, int move_data);
2776 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
2777 int __lustre_unpack_msg(struct lustre_msg *m, int len);
2778 int lustre_msg_hdr_size(__u32 magic, int count);
2779 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
2780 int lustre_msg_size_v2(int count, __u32 *lengths);
2781 int lustre_packed_msg_size(struct lustre_msg *msg);
2782 int lustre_msg_early_size(void);
2783 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
2784 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
2785 int lustre_msg_buflen(struct lustre_msg *m, int n);
2786 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
2787 int lustre_msg_bufcount(struct lustre_msg *m);
2788 char *lustre_msg_string(struct lustre_msg *m, int n, int max_len);
2789 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
2790 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
2791 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
2792 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
2793 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
2794 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
2795 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
2796 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
2797 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
2798 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
2799 __u32 lustre_msg_get_type(struct lustre_msg *msg);
2800 __u32 lustre_msg_get_version(struct lustre_msg *msg);
2801 void lustre_msg_add_version(struct lustre_msg *msg, int version);
2802 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
2803 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
2804 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
2805 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
2806 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
2807 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
2808 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
2809 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
2810 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
2811 int lustre_msg_get_status(struct lustre_msg *msg);
2812 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
2813 int lustre_msg_is_v1(struct lustre_msg *msg);
2814 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
2815 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
2816 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
2817 char *lustre_msg_get_jobid(struct lustre_msg *msg);
2818 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
2819 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 50, 0)
2820 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18);
2822 # warning "remove checksum compatibility support for b1_8"
2823 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
2825 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
2826 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
2827 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
2828 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
2829 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
2830 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
2831 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
2832 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
2833 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
2834 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
2835 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
2836 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
2837 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
2838 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
2839 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
2842 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
2843 unsigned int newlen, int move_data)
2845 LASSERT(req->rq_reply_state);
2846 LASSERT(req->rq_repmsg);
2847 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2852 /** Change request phase of \a req to \a new_phase */
2854 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2856 if (req->rq_phase == new_phase)
2859 if (new_phase == RQ_PHASE_UNREGISTERING) {
2860 req->rq_next_phase = req->rq_phase;
2862 cfs_atomic_inc(&req->rq_import->imp_unregistering);
2865 if (req->rq_phase == RQ_PHASE_UNREGISTERING) {
2867 cfs_atomic_dec(&req->rq_import->imp_unregistering);
2870 DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
2871 ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2873 req->rq_phase = new_phase;
2877 * Returns true if request \a req got early reply and hard deadline is not met
2880 ptlrpc_client_early(struct ptlrpc_request *req)
2882 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2883 req->rq_reply_deadline > cfs_time_current_sec())
2885 return req->rq_early;
2889 * Returns true if we got real reply from server for this request
2892 ptlrpc_client_replied(struct ptlrpc_request *req)
2894 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2895 req->rq_reply_deadline > cfs_time_current_sec())
2897 return req->rq_replied;
2900 /** Returns true if request \a req is in process of receiving server reply */
2902 ptlrpc_client_recv(struct ptlrpc_request *req)
2904 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2905 req->rq_reply_deadline > cfs_time_current_sec())
2907 return req->rq_receiving_reply;
2911 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2915 spin_lock(&req->rq_lock);
2916 if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) &&
2917 req->rq_reply_deadline > cfs_time_current_sec()) {
2918 spin_unlock(&req->rq_lock);
2921 rc = req->rq_receiving_reply || req->rq_must_unlink;
2922 spin_unlock(&req->rq_lock);
2927 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2929 if (req->rq_set == NULL)
2930 cfs_waitq_signal(&req->rq_reply_waitq);
2932 cfs_waitq_signal(&req->rq_set->set_waitq);
2936 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2938 LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
2939 cfs_atomic_inc(&rs->rs_refcount);
2943 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2945 LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0);
2946 if (cfs_atomic_dec_and_test(&rs->rs_refcount))
2947 lustre_free_reply_state(rs);
2950 /* Should only be called once per req */
2951 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2953 if (req->rq_reply_state == NULL)
2954 return; /* shouldn't occur */
2955 ptlrpc_rs_decref(req->rq_reply_state);
2956 req->rq_reply_state = NULL;
2957 req->rq_repmsg = NULL;
2960 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2962 return lustre_msg_get_magic(req->rq_reqmsg);
2965 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2967 switch (req->rq_reqmsg->lm_magic) {
2968 case LUSTRE_MSG_MAGIC_V2:
2969 return req->rq_reqmsg->lm_repsize;
2971 LASSERTF(0, "incorrect message magic: %08x\n",
2972 req->rq_reqmsg->lm_magic);
2977 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2979 if (req->rq_delay_limit != 0 &&
2980 cfs_time_before(cfs_time_add(req->rq_queued_time,
2981 cfs_time_seconds(req->rq_delay_limit)),
2982 cfs_time_current())) {
2988 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2990 if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2991 spin_lock(&req->rq_lock);
2992 req->rq_no_resend = 1;
2993 spin_unlock(&req->rq_lock);
2995 return req->rq_no_resend;
2999 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
3001 int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
3003 return svcpt->scp_service->srv_watchdog_factor *
3004 max_t(int, at, obd_timeout);
3007 static inline struct ptlrpc_service *
3008 ptlrpc_req2svc(struct ptlrpc_request *req)
3010 LASSERT(req->rq_rqbd != NULL);
3011 return req->rq_rqbd->rqbd_svcpt->scp_service;
3014 /* ldlm/ldlm_lib.c */
3016 * Target client logic
3019 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
3020 int client_obd_cleanup(struct obd_device *obddev);
3021 int client_connect_import(const struct lu_env *env,
3022 struct obd_export **exp, struct obd_device *obd,
3023 struct obd_uuid *cluuid, struct obd_connect_data *,
3025 int client_disconnect_export(struct obd_export *exp);
3026 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
3028 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
3029 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
3030 struct obd_uuid *uuid);
3031 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
3032 void client_destroy_import(struct obd_import *imp);
3035 #ifdef HAVE_SERVER_SUPPORT
3036 int server_disconnect_export(struct obd_export *exp);
3039 /* ptlrpc/pinger.c */
3041 * Pinger API (client side only)
3044 extern int suppress_pings;
3045 enum timeout_event {
3048 struct timeout_item;
3049 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
3050 int ptlrpc_pinger_add_import(struct obd_import *imp);
3051 int ptlrpc_pinger_del_import(struct obd_import *imp);
3052 int ptlrpc_add_timeout_client(int time, enum timeout_event event,
3053 timeout_cb_t cb, void *data,
3054 cfs_list_t *obd_list);
3055 int ptlrpc_del_timeout_client(cfs_list_t *obd_list,
3056 enum timeout_event event);
3057 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
3058 int ptlrpc_obd_ping(struct obd_device *obd);
3059 cfs_time_t ptlrpc_suspend_wakeup_time(void);
3061 void ping_evictor_start(void);
3062 void ping_evictor_stop(void);
3064 #define ping_evictor_start() do {} while (0)
3065 #define ping_evictor_stop() do {} while (0)
3067 int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req);
3070 /* ptlrpc daemon bind policy */
3072 /* all ptlrpcd threads are free mode */
3073 PDB_POLICY_NONE = 1,
3074 /* all ptlrpcd threads are bound mode */
3075 PDB_POLICY_FULL = 2,
3076 /* <free1 bound1> <free2 bound2> ... <freeN boundN> */
3077 PDB_POLICY_PAIR = 3,
3078 /* <free1 bound1> <bound1 free2> ... <freeN boundN> <boundN free1>,
3079 * means each ptlrpcd[X] has two partners: thread[X-1] and thread[X+1].
3080 * If kernel supports NUMA, pthrpcd threads are binded and
3081 * grouped by NUMA node */
3082 PDB_POLICY_NEIGHBOR = 4,
3085 /* ptlrpc daemon load policy
3086 * It is caller's duty to specify how to push the async RPC into some ptlrpcd
3087 * queue, but it is not enforced, affected by "ptlrpcd_bind_policy". If it is
3088 * "PDB_POLICY_FULL", then the RPC will be processed by the selected ptlrpcd,
3089 * Otherwise, the RPC may be processed by the selected ptlrpcd or its partner,
3090 * depends on which is scheduled firstly, to accelerate the RPC processing. */
3092 /* on the same CPU core as the caller */
3093 PDL_POLICY_SAME = 1,
3094 /* within the same CPU partition, but not the same core as the caller */
3095 PDL_POLICY_LOCAL = 2,
3096 /* round-robin on all CPU cores, but not the same core as the caller */
3097 PDL_POLICY_ROUND = 3,
3098 /* the specified CPU core is preferred, but not enforced */
3099 PDL_POLICY_PREFERRED = 4,
3102 /* ptlrpc/ptlrpcd.c */
3103 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
3104 void ptlrpcd_free(struct ptlrpcd_ctl *pc);
3105 void ptlrpcd_wake(struct ptlrpc_request *req);
3106 void ptlrpcd_add_req(struct ptlrpc_request *req, pdl_policy_t policy, int idx);
3107 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
3108 int ptlrpcd_addref(void);
3109 void ptlrpcd_decref(void);
3111 /* ptlrpc/lproc_ptlrpc.c */
3113 * procfs output related functions
3116 const char* ll_opcode2str(__u32 opcode);
3118 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
3119 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
3120 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
3122 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
3123 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
3124 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
3128 /* ptlrpc/llog_server.c */
3129 int llog_origin_handle_open(struct ptlrpc_request *req);
3130 int llog_origin_handle_destroy(struct ptlrpc_request *req);
3131 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
3132 int llog_origin_handle_next_block(struct ptlrpc_request *req);
3133 int llog_origin_handle_read_header(struct ptlrpc_request *req);
3134 int llog_origin_handle_close(struct ptlrpc_request *req);
3135 int llog_origin_handle_cancel(struct ptlrpc_request *req);
3137 /* ptlrpc/llog_client.c */
3138 extern struct llog_operations llog_client_ops;