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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2010, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 /** \defgroup PtlRPC Portal RPC and networking module.
34 * PortalRPC is the layer used by rest of lustre code to achieve network
35 * communications: establish connections with corresponding export and import
36 * states, listen for a service, send and receive RPCs.
37 * PortalRPC also includes base recovery framework: packet resending and
38 * replaying, reconnections, pinger.
40 * PortalRPC utilizes LNet as its transport layer.
53 #include <linux/kobject.h>
54 #include <linux/uio.h>
55 #include <libcfs/libcfs.h>
57 #include <lnet/lib-types.h>
58 #include <uapi/linux/lnet/nidstr.h>
59 #include <uapi/linux/lustre/lustre_idl.h>
60 #include <lustre_ha.h>
61 #include <lustre_sec.h>
62 #include <lustre_import.h>
63 #include <lprocfs_status.h>
64 #include <lu_object.h>
65 #include <lustre_req_layout.h>
66 #include <obd_support.h>
67 #include <uapi/linux/lustre/lustre_ver.h>
69 /* MD flags we _always_ use */
70 #define PTLRPC_MD_OPTIONS 0
73 * log2 max # of bulk operations in one request: 2=4MB/RPC, 5=32MB/RPC, ...
74 * In order for the client and server to properly negotiate the maximum
75 * possible transfer size, PTLRPC_BULK_OPS_COUNT must be a power-of-two
76 * value. The client is free to limit the actual RPC size for any bulk
77 * transfer via cl_max_pages_per_rpc to some non-power-of-two value.
78 * NOTE: This is limited to 16 (=64GB RPCs) by IOOBJ_MAX_BRW_BITS. */
79 #define PTLRPC_BULK_OPS_BITS 6
80 #if PTLRPC_BULK_OPS_BITS > 16
81 #error "More than 65536 BRW RPCs not allowed by IOOBJ_MAX_BRW_BITS."
83 #define PTLRPC_BULK_OPS_COUNT (1U << PTLRPC_BULK_OPS_BITS)
85 * PTLRPC_BULK_OPS_MASK is for the convenience of the client only, and
86 * should not be used on the server at all. Otherwise, it imposes a
87 * protocol limitation on the maximum RPC size that can be used by any
88 * RPC sent to that server in the future. Instead, the server should
89 * use the negotiated per-client ocd_brw_size to determine the bulk
91 #define PTLRPC_BULK_OPS_MASK (~((__u64)PTLRPC_BULK_OPS_COUNT - 1))
94 * Define maxima for bulk I/O.
96 * A single PTLRPC BRW request is sent via up to PTLRPC_BULK_OPS_COUNT
97 * of LNET_MTU sized RDMA transfers. Clients and servers negotiate the
98 * currently supported maximum between peers at connect via ocd_brw_size.
100 #define PTLRPC_MAX_BRW_BITS (LNET_MTU_BITS + PTLRPC_BULK_OPS_BITS)
101 #define PTLRPC_MAX_BRW_SIZE (1U << PTLRPC_MAX_BRW_BITS)
102 #define PTLRPC_MAX_BRW_PAGES (PTLRPC_MAX_BRW_SIZE >> PAGE_SHIFT)
104 #define ONE_MB_BRW_SIZE (1U << LNET_MTU_BITS)
105 #define MD_MAX_BRW_SIZE (1U << LNET_MTU_BITS)
106 #define MD_MAX_BRW_PAGES (MD_MAX_BRW_SIZE >> PAGE_SHIFT)
107 #define DT_MAX_BRW_SIZE PTLRPC_MAX_BRW_SIZE
108 #define DT_DEF_BRW_SIZE (4 * ONE_MB_BRW_SIZE)
109 #define DT_MAX_BRW_PAGES (DT_MAX_BRW_SIZE >> PAGE_SHIFT)
110 #define OFD_MAX_BRW_SIZE (1U << LNET_MTU_BITS)
112 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
113 #if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
114 # error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
116 #if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * PAGE_SIZE))
117 # error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * PAGE_SIZE"
119 #if (PTLRPC_MAX_BRW_SIZE > LNET_MTU * PTLRPC_BULK_OPS_COUNT)
120 # error "PTLRPC_MAX_BRW_SIZE too big"
122 #if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV * PTLRPC_BULK_OPS_COUNT)
123 # error "PTLRPC_MAX_BRW_PAGES too big"
126 #define PTLRPC_NTHRS_INIT 2
131 * Constants determine how memory is used to buffer incoming service requests.
133 * ?_NBUFS # buffers to allocate when growing the pool
134 * ?_BUFSIZE # bytes in a single request buffer
135 * ?_MAXREQSIZE # maximum request service will receive
137 * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
138 * of ?_NBUFS is added to the pool.
140 * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are
141 * considered full when less than ?_MAXREQSIZE is left in them.
146 * Constants determine how threads are created for ptlrpc service.
148 * ?_NTHRS_INIT # threads to create for each service partition on
149 * initializing. If it's non-affinity service and
150 * there is only one partition, it's the overall #
151 * threads for the service while initializing.
152 * ?_NTHRS_BASE # threads should be created at least for each
153 * ptlrpc partition to keep the service healthy.
154 * It's the low-water mark of threads upper-limit
155 * for each partition.
156 * ?_THR_FACTOR # threads can be added on threads upper-limit for
157 * each CPU core. This factor is only for reference,
158 * we might decrease value of factor if number of cores
159 * per CPT is above a limit.
160 * ?_NTHRS_MAX # overall threads can be created for a service,
161 * it's a soft limit because if service is running
162 * on machine with hundreds of cores and tens of
163 * CPU partitions, we need to guarantee each partition
164 * has ?_NTHRS_BASE threads, which means total threads
165 * will be ?_NTHRS_BASE * number_of_cpts which can
166 * exceed ?_NTHRS_MAX.
170 * #define MDS_NTHRS_INIT 2
171 * #define MDS_NTHRS_BASE 64
172 * #define MDS_NTHRS_FACTOR 8
173 * #define MDS_NTHRS_MAX 1024
176 * ---------------------------------------------------------------------
177 * Server(A) has 16 cores, user configured it to 4 partitions so each
178 * partition has 4 cores, then actual number of service threads on each
180 * MDS_NTHRS_BASE(64) + cores(4) * MDS_NTHRS_FACTOR(8) = 96
182 * Total number of threads for the service is:
183 * 96 * partitions(4) = 384
186 * ---------------------------------------------------------------------
187 * Server(B) has 32 cores, user configured it to 4 partitions so each
188 * partition has 8 cores, then actual number of service threads on each
190 * MDS_NTHRS_BASE(64) + cores(8) * MDS_NTHRS_FACTOR(8) = 128
192 * Total number of threads for the service is:
193 * 128 * partitions(4) = 512
196 * ---------------------------------------------------------------------
197 * Server(B) has 96 cores, user configured it to 8 partitions so each
198 * partition has 12 cores, then actual number of service threads on each
200 * MDS_NTHRS_BASE(64) + cores(12) * MDS_NTHRS_FACTOR(8) = 160
202 * Total number of threads for the service is:
203 * 160 * partitions(8) = 1280
205 * However, it's above the soft limit MDS_NTHRS_MAX, so we choose this number
206 * as upper limit of threads number for each partition:
207 * MDS_NTHRS_MAX(1024) / partitions(8) = 128
210 * ---------------------------------------------------------------------
211 * Server(C) have a thousand of cores and user configured it to 32 partitions
212 * MDS_NTHRS_BASE(64) * 32 = 2048
214 * which is already above soft limit MDS_NTHRS_MAX(1024), but we still need
215 * to guarantee that each partition has at least MDS_NTHRS_BASE(64) threads
216 * to keep service healthy, so total number of threads will just be 2048.
218 * NB: we don't suggest to choose server with that many cores because backend
219 * filesystem itself, buffer cache, or underlying network stack might
220 * have some SMP scalability issues at that large scale.
222 * If user already has a fat machine with hundreds or thousands of cores,
223 * there are two choices for configuration:
224 * a) create CPU table from subset of all CPUs and run Lustre on
226 * b) bind service threads on a few partitions, see modparameters of
227 * MDS and OSS for details
229 * NB: these calculations (and examples below) are simplified to help
230 * understanding, the real implementation is a little more complex,
231 * please see ptlrpc_server_nthreads_check() for details.
236 * LDLM threads constants:
238 * Given 8 as factor and 24 as base threads number
241 * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
244 * On 8-core machine with 2 partitions we will have 24 + 4 * 8 = 56
245 * threads for each partition and total threads number will be 112.
248 * On 64-core machine with 8 partitions we will need LDLM_NTHRS_BASE(24)
249 * threads for each partition to keep service healthy, so total threads
250 * number should be 24 * 8 = 192.
252 * So with these constants, threads number will be at the similar level
253 * of old versions, unless target machine has over a hundred cores
255 #define LDLM_THR_FACTOR 8
256 #define LDLM_NTHRS_INIT PTLRPC_NTHRS_INIT
257 #define LDLM_NTHRS_BASE 24
258 #define LDLM_NTHRS_MAX (num_online_cpus() == 1 ? 64 : 128)
260 #define LDLM_BL_THREADS LDLM_NTHRS_AUTO_INIT
261 #define LDLM_CLIENT_NBUFS 1
262 #define LDLM_SERVER_NBUFS 64
263 #define LDLM_BUFSIZE (8 * 1024)
264 #define LDLM_MAXREQSIZE (5 * 1024)
265 #define LDLM_MAXREPSIZE (1024)
268 * MDS threads constants:
270 * Please see examples in "Thread Constants", MDS threads number will be at
271 * the comparable level of old versions, unless the server has many cores.
273 #ifndef MDS_MAX_THREADS
274 #define MDS_MAX_THREADS 1024
275 #define MDS_MAX_OTHR_THREADS 256
277 #else /* MDS_MAX_THREADS */
278 #if MDS_MAX_THREADS < PTLRPC_NTHRS_INIT
279 #undef MDS_MAX_THREADS
280 #define MDS_MAX_THREADS PTLRPC_NTHRS_INIT
282 #define MDS_MAX_OTHR_THREADS max(PTLRPC_NTHRS_INIT, MDS_MAX_THREADS / 2)
285 /* default service */
286 #define MDS_THR_FACTOR 8
287 #define MDS_NTHRS_INIT PTLRPC_NTHRS_INIT
288 #define MDS_NTHRS_MAX MDS_MAX_THREADS
289 #define MDS_NTHRS_BASE min(64, MDS_NTHRS_MAX)
291 /* read-page service */
292 #define MDS_RDPG_THR_FACTOR 4
293 #define MDS_RDPG_NTHRS_INIT PTLRPC_NTHRS_INIT
294 #define MDS_RDPG_NTHRS_MAX MDS_MAX_OTHR_THREADS
295 #define MDS_RDPG_NTHRS_BASE min(48, MDS_RDPG_NTHRS_MAX)
297 /* these should be removed when we remove setattr service in the future */
298 #define MDS_SETA_THR_FACTOR 4
299 #define MDS_SETA_NTHRS_INIT PTLRPC_NTHRS_INIT
300 #define MDS_SETA_NTHRS_MAX MDS_MAX_OTHR_THREADS
301 #define MDS_SETA_NTHRS_BASE min(48, MDS_SETA_NTHRS_MAX)
303 /* non-affinity threads */
304 #define MDS_OTHR_NTHRS_INIT PTLRPC_NTHRS_INIT
305 #define MDS_OTHR_NTHRS_MAX MDS_MAX_OTHR_THREADS
310 * Assume file name length = FNAME_MAX = 256 (true for ext3).
311 * path name length = PATH_MAX = 4096
312 * LOV MD size max = EA_MAX = 24 * 2000
313 * (NB: 24 is size of lov_ost_data)
314 * LOV LOGCOOKIE size max = 32 * 2000
315 * (NB: 32 is size of llog_cookie)
316 * symlink: FNAME_MAX + PATH_MAX <- largest
317 * link: FNAME_MAX + PATH_MAX (mds_rec_link < mds_rec_create)
318 * rename: FNAME_MAX + FNAME_MAX
319 * open: FNAME_MAX + EA_MAX
321 * MDS_MAXREQSIZE ~= 4736 bytes =
322 * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
323 * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
325 * Realistic size is about 512 bytes (20 character name + 128 char symlink),
326 * except in the open case where there are a large number of OSTs in a LOV.
328 #define MDS_MAXREQSIZE (5 * 1024) /* >= 4736 */
329 #define MDS_MAXREPSIZE (9 * 1024) /* >= 8300 */
332 * MDS incoming request with LOV EA
333 * 24 = sizeof(struct lov_ost_data), i.e: replay of opencreate
335 #define MDS_LOV_MAXREQSIZE max(MDS_MAXREQSIZE, \
336 362 + LOV_MAX_STRIPE_COUNT * 24)
338 * MDS outgoing reply with LOV EA
340 * NB: max reply size Lustre 2.4+ client can get from old MDS is:
341 * LOV_MAX_STRIPE_COUNT * (llog_cookie + lov_ost_data) + extra bytes
343 * but 2.4 or later MDS will never send reply with llog_cookie to any
344 * version client. This macro is defined for server side reply buffer size.
346 #define MDS_LOV_MAXREPSIZE MDS_LOV_MAXREQSIZE
349 * This is the size of a maximum REINT_SETXATTR request:
351 * lustre_msg 56 (32 + 4 x 5 + 4)
353 * mdt_rec_setxattr 136
355 * name 256 (XATTR_NAME_MAX)
356 * value 65536 (XATTR_SIZE_MAX)
358 #define MDS_EA_MAXREQSIZE 66288
361 * These are the maximum request and reply sizes (rounded up to 1 KB
362 * boundaries) for the "regular" MDS_REQUEST_PORTAL and MDS_REPLY_PORTAL.
364 #define MDS_REG_MAXREQSIZE (((max(MDS_EA_MAXREQSIZE, \
365 MDS_LOV_MAXREQSIZE) + 1023) >> 10) << 10)
366 #define MDS_REG_MAXREPSIZE MDS_REG_MAXREQSIZE
369 * The update request includes all of updates from the create, which might
370 * include linkea (4K maxim), together with other updates, we set it to 1000K:
371 * lustre_msg + ptlrpc_body + OUT_UPDATE_BUFFER_SIZE_MAX
373 #define OUT_MAXREQSIZE (1000 * 1024)
374 #define OUT_MAXREPSIZE MDS_MAXREPSIZE
376 /** MDS_BUFSIZE = max_reqsize (w/o LOV EA) + max sptlrpc payload size */
377 #define MDS_BUFSIZE max(MDS_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
381 * MDS_REG_BUFSIZE should at least be MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD.
382 * However, we need to allocate a much larger buffer for it because LNet
383 * requires each MD(rqbd) has at least MDS_REQ_MAXREQSIZE bytes left to avoid
384 * dropping of maximum-sized incoming request. So if MDS_REG_BUFSIZE is only a
385 * little larger than MDS_REG_MAXREQSIZE, then it can only fit in one request
386 * even there are about MDS_REG_MAX_REQSIZE bytes left in a rqbd, and memory
387 * utilization is very low.
389 * In the meanwhile, size of rqbd can't be too large, because rqbd can't be
390 * reused until all requests fit in it have been processed and released,
391 * which means one long blocked request can prevent the rqbd be reused.
392 * Now we set request buffer size to 160 KB, so even each rqbd is unlinked
393 * from LNet with unused 65 KB, buffer utilization will be about 59%.
394 * Please check LU-2432 for details.
396 #define MDS_REG_BUFSIZE max(MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
400 * OUT_BUFSIZE = max_out_reqsize + max sptlrpc payload (~1K) which is
401 * about 10K, for the same reason as MDS_REG_BUFSIZE, we also give some
402 * extra bytes to each request buffer to improve buffer utilization rate.
404 #define OUT_BUFSIZE max(OUT_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
407 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
408 #define FLD_MAXREQSIZE (160)
410 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
411 #define FLD_MAXREPSIZE (152)
412 #define FLD_BUFSIZE (1 << 12)
415 * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
417 #define SEQ_MAXREQSIZE (160)
419 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
420 #define SEQ_MAXREPSIZE (152)
421 #define SEQ_BUFSIZE (1 << 12)
423 /** MGS threads must be >= 3, see bug 22458 comment #28 */
424 #define MGS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
425 #define MGS_NTHRS_MAX 32
428 #define MGS_BUFSIZE (8 * 1024)
429 #define MGS_MAXREQSIZE (7 * 1024)
430 #define MGS_MAXREPSIZE (9 * 1024)
433 * OSS threads constants:
435 * Given 8 as factor and 64 as base threads number
438 * On 8-core server configured to 2 partitions, we will have
439 * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
442 * On 32-core machine configured to 4 partitions, we will have
443 * 64 + 8 * 8 = 112 threads for each partition, so total threads number
444 * will be 112 * 4 = 448.
447 * On 64-core machine configured to 4 partitions, we will have
448 * 64 + 16 * 8 = 192 threads for each partition, so total threads number
449 * will be 192 * 4 = 768 which is above limit OSS_NTHRS_MAX(512), so we
450 * cut off the value to OSS_NTHRS_MAX(512) / 4 which is 128 threads
451 * for each partition.
453 * So we can see that with these constants, threads number wil be at the
454 * similar level of old versions, unless the server has many cores.
456 /* depress threads factor for VM with small memory size */
457 #define OSS_THR_FACTOR min_t(int, 8, \
458 NUM_CACHEPAGES >> (28 - PAGE_SHIFT))
459 #define OSS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
460 #define OSS_NTHRS_BASE 64
462 /* threads for handling "create" request */
463 #define OSS_CR_THR_FACTOR 1
464 #define OSS_CR_NTHRS_INIT PTLRPC_NTHRS_INIT
465 #define OSS_CR_NTHRS_BASE 8
466 #define OSS_CR_NTHRS_MAX 64
469 * OST_IO_MAXREQSIZE ~=
470 * lustre_msg + ptlrpc_body + obdo + obd_ioobj +
471 * DT_MAX_BRW_PAGES * niobuf_remote
473 * - single object with 16 pages is 512 bytes
474 * - OST_IO_MAXREQSIZE must be at least 1 page of cookies plus some spillover
475 * - Must be a multiple of 1024
477 #define _OST_MAXREQSIZE_BASE ((unsigned long)(sizeof(struct lustre_msg) + \
478 sizeof(struct ptlrpc_body) + \
479 sizeof(struct obdo) + \
480 sizeof(struct obd_ioobj) + \
481 sizeof(struct niobuf_remote)))
482 #define _OST_MAXREQSIZE_SUM ((unsigned long)(_OST_MAXREQSIZE_BASE + \
483 sizeof(struct niobuf_remote) * \
484 (DT_MAX_BRW_PAGES - 1)))
486 * FIEMAP request can be 4K+ for now
488 #define OST_MAXREQSIZE (16UL * 1024UL)
489 #define OST_IO_MAXREQSIZE max(OST_MAXREQSIZE, \
490 ((_OST_MAXREQSIZE_SUM - 1) | \
492 /* Safe estimate of free space in standard RPC, provides upper limit for # of
493 * bytes of i/o to pack in RPC (skipping bulk transfer). */
494 #define OST_SHORT_IO_SPACE (OST_IO_MAXREQSIZE - _OST_MAXREQSIZE_BASE)
496 /* Actual size used for short i/o buffer. Calculation means this:
497 * At least one page (for large PAGE_SIZE), or 16 KiB, but not more
498 * than the available space aligned to a page boundary. */
499 #define OBD_MAX_SHORT_IO_BYTES min(max(PAGE_SIZE, 16UL * 1024UL), \
500 OST_SHORT_IO_SPACE & PAGE_MASK)
502 #define OST_MAXREPSIZE (9 * 1024)
503 #define OST_IO_MAXREPSIZE OST_MAXREPSIZE
506 /** OST_BUFSIZE = max_reqsize + max sptlrpc payload size */
507 #define OST_BUFSIZE max_t(int, OST_MAXREQSIZE + 1024, 32 * 1024)
509 * OST_IO_MAXREQSIZE is 18K, giving extra 46K can increase buffer utilization
510 * rate of request buffer, please check comment of MDS_LOV_BUFSIZE for details.
512 #define OST_IO_BUFSIZE max_t(int, OST_IO_MAXREQSIZE + 1024, 64 * 1024)
515 /* Macro to hide a typecast. */
516 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
518 struct ptlrpc_replay_async_args {
524 * Structure to single define portal connection.
526 struct ptlrpc_connection {
527 /** linkage for connections hash table */
528 struct hlist_node c_hash;
529 /** Our own lnet nid for this connection */
531 /** Remote side nid for this connection */
532 struct lnet_process_id c_peer;
533 /** UUID of the other side */
534 struct obd_uuid c_remote_uuid;
535 /** reference counter for this connection */
539 /** Client definition for PortalRPC */
540 struct ptlrpc_client {
541 /** What lnet portal does this client send messages to by default */
542 __u32 cli_request_portal;
543 /** What portal do we expect replies on */
544 __u32 cli_reply_portal;
545 /** Name of the client */
546 const char *cli_name;
549 /** state flags of requests */
550 /* XXX only ones left are those used by the bulk descs as well! */
551 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
552 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
554 #define REQ_MAX_ACK_LOCKS 8
556 union ptlrpc_async_args {
558 * Scratchpad for passing args to completion interpreter. Users
559 * cast to the struct of their choosing, and CLASSERT that this is
560 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
561 * a pointer to it here. The pointer_arg ensures this struct is at
562 * least big enough for that.
564 void *pointer_arg[11];
568 struct ptlrpc_request_set;
569 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
572 * Definition of request set structure.
573 * Request set is a list of requests (not necessary to the same target) that
574 * once populated with RPCs could be sent in parallel.
575 * There are two kinds of request sets. General purpose and with dedicated
576 * serving thread. Example of the latter is ptlrpcd set.
577 * For general purpose sets once request set started sending it is impossible
578 * to add new requests to such set.
579 * Provides a way to call "completion callbacks" when all requests in the set
582 struct ptlrpc_request_set {
583 atomic_t set_refcount;
584 /** number of in queue requests */
585 atomic_t set_new_count;
586 /** number of uncompleted requests */
587 atomic_t set_remaining;
588 /** wait queue to wait on for request events */
589 wait_queue_head_t set_waitq;
590 /** List of requests in the set */
591 struct list_head set_requests;
593 * Lock for \a set_new_requests manipulations
594 * locked so that any old caller can communicate requests to
595 * the set holder who can then fold them into the lock-free set
597 spinlock_t set_new_req_lock;
598 /** List of new yet unsent requests. Only used with ptlrpcd now. */
599 struct list_head set_new_requests;
601 /** rq_status of requests that have been freed already */
603 /** Additional fields used by the flow control extension */
604 /** Maximum number of RPCs in flight */
605 int set_max_inflight;
606 /** Callback function used to generate RPCs */
607 set_producer_func set_producer;
608 /** opaq argument passed to the producer callback */
609 void *set_producer_arg;
610 unsigned int set_allow_intr:1;
613 struct ptlrpc_bulk_desc;
614 struct ptlrpc_service_part;
615 struct ptlrpc_service;
618 * ptlrpc callback & work item stuff
620 struct ptlrpc_cb_id {
621 void (*cbid_fn)(struct lnet_event *ev); /* specific callback fn */
622 void *cbid_arg; /* additional arg */
625 /** Maximum number of locks to fit into reply state */
626 #define RS_MAX_LOCKS 8
630 * Structure to define reply state on the server
631 * Reply state holds various reply message information. Also for "difficult"
632 * replies (rep-ack case) we store the state after sending reply and wait
633 * for the client to acknowledge the reception. In these cases locks could be
634 * added to the state for replay/failover consistency guarantees.
636 struct ptlrpc_reply_state {
637 /** Callback description */
638 struct ptlrpc_cb_id rs_cb_id;
639 /** Linkage for list of all reply states in a system */
640 struct list_head rs_list;
641 /** Linkage for list of all reply states on same export */
642 struct list_head rs_exp_list;
643 /** Linkage for list of all reply states for same obd */
644 struct list_head rs_obd_list;
646 struct list_head rs_debug_list;
648 /** A spinlock to protect the reply state flags */
650 /** Reply state flags */
651 unsigned long rs_difficult:1; /* ACK/commit stuff */
652 unsigned long rs_no_ack:1; /* no ACK, even for
653 difficult requests */
654 unsigned long rs_scheduled:1; /* being handled? */
655 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
656 unsigned long rs_handled:1; /* been handled yet? */
657 unsigned long rs_on_net:1; /* reply_out_callback pending? */
658 unsigned long rs_prealloc:1; /* rs from prealloc list */
659 unsigned long rs_committed:1;/* the transaction was committed
660 and the rs was dispatched
661 by ptlrpc_commit_replies */
662 unsigned long rs_convert_lock:1; /* need to convert saved
663 * locks to COS mode */
664 atomic_t rs_refcount; /* number of users */
665 /** Number of locks awaiting client ACK */
668 /** Size of the state */
672 /** Transaction number */
676 struct obd_export *rs_export;
677 struct ptlrpc_service_part *rs_svcpt;
678 /** Lnet metadata handle for the reply */
679 struct lnet_handle_md rs_md_h;
681 /** Context for the sevice thread */
682 struct ptlrpc_svc_ctx *rs_svc_ctx;
683 /** Reply buffer (actually sent to the client), encoded if needed */
684 struct lustre_msg *rs_repbuf; /* wrapper */
685 /** Size of the reply buffer */
686 int rs_repbuf_len; /* wrapper buf length */
687 /** Size of the reply message */
688 int rs_repdata_len; /* wrapper msg length */
690 * Actual reply message. Its content is encrupted (if needed) to
691 * produce reply buffer for actual sending. In simple case
692 * of no network encryption we jus set \a rs_repbuf to \a rs_msg
694 struct lustre_msg *rs_msg; /* reply message */
696 /** Handles of locks awaiting client reply ACK */
697 struct lustre_handle rs_locks[RS_MAX_LOCKS];
698 /** Lock modes of locks in \a rs_locks */
699 enum ldlm_mode rs_modes[RS_MAX_LOCKS];
702 struct ptlrpc_thread;
706 RQ_PHASE_NEW = 0xebc0de00,
707 RQ_PHASE_RPC = 0xebc0de01,
708 RQ_PHASE_BULK = 0xebc0de02,
709 RQ_PHASE_INTERPRET = 0xebc0de03,
710 RQ_PHASE_COMPLETE = 0xebc0de04,
711 RQ_PHASE_UNREG_RPC = 0xebc0de05,
712 RQ_PHASE_UNREG_BULK = 0xebc0de06,
713 RQ_PHASE_UNDEFINED = 0xebc0de07
716 /** Type of request interpreter call-back */
717 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
718 struct ptlrpc_request *req,
720 /** Type of request resend call-back */
721 typedef void (*ptlrpc_resend_cb_t)(struct ptlrpc_request *req,
725 * Definition of request pool structure.
726 * The pool is used to store empty preallocated requests for the case
727 * when we would actually need to send something without performing
728 * any allocations (to avoid e.g. OOM).
730 struct ptlrpc_request_pool {
731 /** Locks the list */
733 /** list of ptlrpc_request structs */
734 struct list_head prp_req_list;
735 /** Maximum message size that would fit into a rquest from this pool */
737 /** Function to allocate more requests for this pool */
738 int (*prp_populate)(struct ptlrpc_request_pool *, int);
746 #include <lustre_nrs.h>
749 * Basic request prioritization operations structure.
750 * The whole idea is centered around locks and RPCs that might affect locks.
751 * When a lock is contended we try to give priority to RPCs that might lead
752 * to fastest release of that lock.
753 * Currently only implemented for OSTs only in a way that makes all
754 * IO and truncate RPCs that are coming from a locked region where a lock is
755 * contended a priority over other requests.
757 struct ptlrpc_hpreq_ops {
759 * Check if the lock handle of the given lock is the same as
760 * taken from the request.
762 int (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
764 * Check if the request is a high priority one.
766 int (*hpreq_check)(struct ptlrpc_request *);
768 * Called after the request has been handled.
770 void (*hpreq_fini)(struct ptlrpc_request *);
773 struct ptlrpc_cli_req {
774 /** For bulk requests on client only: bulk descriptor */
775 struct ptlrpc_bulk_desc *cr_bulk;
776 /** optional time limit for send attempts */
777 time64_t cr_delay_limit;
778 /** time request was first queued */
779 time64_t cr_queued_time;
780 /** request sent in nanoseconds */
782 /** time for request really sent out */
783 time64_t cr_sent_out;
784 /** when req reply unlink must finish. */
785 time64_t cr_reply_deadline;
786 /** when req bulk unlink must finish. */
787 time64_t cr_bulk_deadline;
788 /** when req unlink must finish. */
789 time64_t cr_req_deadline;
790 /** Portal to which this request would be sent */
792 /** Portal where to wait for reply and where reply would be sent */
794 /** request resending number */
795 unsigned int cr_resend_nr;
796 /** What was import generation when this request was sent */
798 enum lustre_imp_state cr_send_state;
799 /** Per-request waitq introduced by bug 21938 for recovery waiting */
800 wait_queue_head_t cr_set_waitq;
801 /** Link item for request set lists */
802 struct list_head cr_set_chain;
803 /** link to waited ctx */
804 struct list_head cr_ctx_chain;
806 /** client's half ctx */
807 struct ptlrpc_cli_ctx *cr_cli_ctx;
808 /** Link back to the request set */
809 struct ptlrpc_request_set *cr_set;
810 /** outgoing request MD handle */
811 struct lnet_handle_md cr_req_md_h;
812 /** request-out callback parameter */
813 struct ptlrpc_cb_id cr_req_cbid;
814 /** incoming reply MD handle */
815 struct lnet_handle_md cr_reply_md_h;
816 wait_queue_head_t cr_reply_waitq;
817 /** reply callback parameter */
818 struct ptlrpc_cb_id cr_reply_cbid;
819 /** Async completion handler, called when reply is received */
820 ptlrpc_interpterer_t cr_reply_interp;
821 /** Resend handler, called when request is resend to update RPC data */
822 ptlrpc_resend_cb_t cr_resend_cb;
823 /** Async completion context */
824 union ptlrpc_async_args cr_async_args;
825 /** Opaq data for replay and commit callbacks. */
827 /** Link to the imp->imp_unreplied_list */
828 struct list_head cr_unreplied_list;
830 * Commit callback, called when request is committed and about to be
833 void (*cr_commit_cb)(struct ptlrpc_request *);
834 /** Replay callback, called after request is replayed at recovery */
835 void (*cr_replay_cb)(struct ptlrpc_request *);
838 /** client request member alias */
839 /* NB: these alias should NOT be used by any new code, instead they should
840 * be removed step by step to avoid potential abuse */
841 #define rq_bulk rq_cli.cr_bulk
842 #define rq_delay_limit rq_cli.cr_delay_limit
843 #define rq_queued_time rq_cli.cr_queued_time
844 #define rq_sent_ns rq_cli.cr_sent_ns
845 #define rq_real_sent rq_cli.cr_sent_out
846 #define rq_reply_deadline rq_cli.cr_reply_deadline
847 #define rq_bulk_deadline rq_cli.cr_bulk_deadline
848 #define rq_req_deadline rq_cli.cr_req_deadline
849 #define rq_nr_resend rq_cli.cr_resend_nr
850 #define rq_request_portal rq_cli.cr_req_ptl
851 #define rq_reply_portal rq_cli.cr_rep_ptl
852 #define rq_import_generation rq_cli.cr_imp_gen
853 #define rq_send_state rq_cli.cr_send_state
854 #define rq_set_chain rq_cli.cr_set_chain
855 #define rq_ctx_chain rq_cli.cr_ctx_chain
856 #define rq_set rq_cli.cr_set
857 #define rq_set_waitq rq_cli.cr_set_waitq
858 #define rq_cli_ctx rq_cli.cr_cli_ctx
859 #define rq_req_md_h rq_cli.cr_req_md_h
860 #define rq_req_cbid rq_cli.cr_req_cbid
861 #define rq_reply_md_h rq_cli.cr_reply_md_h
862 #define rq_reply_waitq rq_cli.cr_reply_waitq
863 #define rq_reply_cbid rq_cli.cr_reply_cbid
864 #define rq_interpret_reply rq_cli.cr_reply_interp
865 #define rq_resend_cb rq_cli.cr_resend_cb
866 #define rq_async_args rq_cli.cr_async_args
867 #define rq_cb_data rq_cli.cr_cb_data
868 #define rq_unreplied_list rq_cli.cr_unreplied_list
869 #define rq_commit_cb rq_cli.cr_commit_cb
870 #define rq_replay_cb rq_cli.cr_replay_cb
872 struct ptlrpc_srv_req {
873 /** initial thread servicing this request */
874 struct ptlrpc_thread *sr_svc_thread;
876 * Server side list of incoming unserved requests sorted by arrival
877 * time. Traversed from time to time to notice about to expire
878 * requests and sent back "early replies" to clients to let them
879 * know server is alive and well, just very busy to service their
882 struct list_head sr_timed_list;
883 /** server-side per-export list */
884 struct list_head sr_exp_list;
885 /** server-side history, used for debuging purposes. */
886 struct list_head sr_hist_list;
887 /** history sequence # */
889 /** the index of service's srv_at_array into which request is linked */
893 /** authed uid mapped to */
894 uid_t sr_auth_mapped_uid;
895 /** RPC is generated from what part of Lustre */
896 enum lustre_sec_part sr_sp_from;
897 /** request session context */
898 struct lu_context sr_ses;
902 /** stub for NRS request */
903 struct ptlrpc_nrs_request sr_nrq;
905 /** request arrival time */
906 struct timespec64 sr_arrival_time;
907 /** server's half ctx */
908 struct ptlrpc_svc_ctx *sr_svc_ctx;
909 /** (server side), pointed directly into req buffer */
910 struct ptlrpc_user_desc *sr_user_desc;
911 /** separated reply state, may be vmalloc'd */
912 struct ptlrpc_reply_state *sr_reply_state;
913 /** server-side hp handlers */
914 struct ptlrpc_hpreq_ops *sr_ops;
915 /** incoming request buffer */
916 struct ptlrpc_request_buffer_desc *sr_rqbd;
919 /** server request member alias */
920 /* NB: these alias should NOT be used by any new code, instead they should
921 * be removed step by step to avoid potential abuse */
922 #define rq_svc_thread rq_srv.sr_svc_thread
923 #define rq_timed_list rq_srv.sr_timed_list
924 #define rq_exp_list rq_srv.sr_exp_list
925 #define rq_history_list rq_srv.sr_hist_list
926 #define rq_history_seq rq_srv.sr_hist_seq
927 #define rq_at_index rq_srv.sr_at_index
928 #define rq_auth_uid rq_srv.sr_auth_uid
929 #define rq_auth_mapped_uid rq_srv.sr_auth_mapped_uid
930 #define rq_sp_from rq_srv.sr_sp_from
931 #define rq_session rq_srv.sr_ses
932 #define rq_nrq rq_srv.sr_nrq
933 #define rq_arrival_time rq_srv.sr_arrival_time
934 #define rq_reply_state rq_srv.sr_reply_state
935 #define rq_svc_ctx rq_srv.sr_svc_ctx
936 #define rq_user_desc rq_srv.sr_user_desc
937 #define rq_ops rq_srv.sr_ops
938 #define rq_rqbd rq_srv.sr_rqbd
941 * Represents remote procedure call.
943 * This is a staple structure used by everybody wanting to send a request
946 struct ptlrpc_request {
947 /* Request type: one of PTL_RPC_MSG_* */
949 /** Result of request processing */
952 * Linkage item through which this request is included into
953 * sending/delayed lists on client and into rqbd list on server
955 struct list_head rq_list;
956 /** Lock to protect request flags and some other important bits, like
960 spinlock_t rq_early_free_lock;
961 /** client-side flags are serialized by rq_lock @{ */
962 unsigned int rq_intr:1, rq_replied:1, rq_err:1,
963 rq_timedout:1, rq_resend:1, rq_restart:1,
965 * when ->rq_replay is set, request is kept by the client even
966 * after server commits corresponding transaction. This is
967 * used for operations that require sequence of multiple
968 * requests to be replayed. The only example currently is file
969 * open/close. When last request in such a sequence is
970 * committed, ->rq_replay is cleared on all requests in the
974 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
975 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
977 rq_req_unlinked:1, /* unlinked request buffer from lnet */
978 rq_reply_unlinked:1, /* unlinked reply buffer from lnet */
979 rq_memalloc:1, /* req originated from "kswapd" */
981 rq_reply_truncated:1,
982 /** whether the "rq_set" is a valid one */
985 /** do not resend request on -EINPROGRESS */
986 rq_no_retry_einprogress:1,
987 /* allow the req to be sent if the import is in recovery
990 /* bulk request, sent to server, but uncommitted */
992 rq_early_free_repbuf:1, /* free reply buffer in advance */
996 /** server-side flags @{ */
998 rq_hp:1, /**< high priority RPC */
999 rq_at_linked:1, /**< link into service's srv_at_array */
1000 rq_packed_final:1; /**< packed final reply */
1003 /** one of RQ_PHASE_* */
1004 enum rq_phase rq_phase;
1005 /** one of RQ_PHASE_* to be used next */
1006 enum rq_phase rq_next_phase;
1008 * client-side refcount for SENT race, server-side refcounf
1009 * for multiple replies
1011 atomic_t rq_refcount;
1014 * !rq_truncate : # reply bytes actually received,
1015 * rq_truncate : required repbuf_len for resend
1017 int rq_nob_received;
1018 /** Request length */
1022 /** Pool if request is from preallocated list */
1023 struct ptlrpc_request_pool *rq_pool;
1024 /** Request message - what client sent */
1025 struct lustre_msg *rq_reqmsg;
1026 /** Reply message - server response */
1027 struct lustre_msg *rq_repmsg;
1028 /** Transaction number */
1032 /** bulk match bits */
1035 * List item to for replay list. Not yet committed requests get linked
1037 * Also see \a rq_replay comment above.
1038 * It's also link chain on obd_export::exp_req_replay_queue
1040 struct list_head rq_replay_list;
1041 /** non-shared members for client & server request*/
1043 struct ptlrpc_cli_req rq_cli;
1044 struct ptlrpc_srv_req rq_srv;
1047 * security and encryption data
1049 /** description of flavors for client & server */
1050 struct sptlrpc_flavor rq_flvr;
1053 * SELinux policy info at the time of the request
1054 * sepol string format is:
1055 * <mode>:<policy name>:<policy version>:<policy hash>
1057 char rq_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
1059 /* client/server security flags */
1061 rq_ctx_init:1, /* context initiation */
1062 rq_ctx_fini:1, /* context destroy */
1063 rq_bulk_read:1, /* request bulk read */
1064 rq_bulk_write:1, /* request bulk write */
1065 /* server authentication flags */
1066 rq_auth_gss:1, /* authenticated by gss */
1067 rq_auth_usr_root:1, /* authed as root */
1068 rq_auth_usr_mdt:1, /* authed as mdt */
1069 rq_auth_usr_ost:1, /* authed as ost */
1070 /* security tfm flags */
1073 /* doesn't expect reply FIXME */
1075 rq_pill_init:1, /* pill initialized */
1076 rq_srv_req:1; /* server request */
1079 /** various buffer pointers */
1080 struct lustre_msg *rq_reqbuf; /**< req wrapper, vmalloc*/
1081 char *rq_repbuf; /**< rep buffer, vmalloc */
1082 struct lustre_msg *rq_repdata; /**< rep wrapper msg */
1083 /** only in priv mode */
1084 struct lustre_msg *rq_clrbuf;
1085 int rq_reqbuf_len; /* req wrapper buf len */
1086 int rq_reqdata_len; /* req wrapper msg len */
1087 int rq_repbuf_len; /* rep buffer len */
1088 int rq_repdata_len; /* rep wrapper msg len */
1089 int rq_clrbuf_len; /* only in priv mode */
1090 int rq_clrdata_len; /* only in priv mode */
1092 /** early replies go to offset 0, regular replies go after that */
1093 unsigned int rq_reply_off;
1096 /** Fields that help to see if request and reply were swabbed or not */
1097 __u32 rq_req_swab_mask;
1098 __u32 rq_rep_swab_mask;
1100 /** how many early replies (for stats) */
1102 /** Server-side, export on which request was received */
1103 struct obd_export *rq_export;
1104 /** import where request is being sent */
1105 struct obd_import *rq_import;
1108 /** Peer description (the other side) */
1109 struct lnet_process_id rq_peer;
1110 /** Descriptor for the NID from which the peer sent the request. */
1111 struct lnet_process_id rq_source;
1113 * service time estimate (secs)
1114 * If the request is not served by this time, it is marked as timed out.
1115 * Do not change to time64_t since this is transmitted over the wire.
1119 * when request/reply sent (secs), or time when request should be sent
1122 /** when request must finish. */
1123 time64_t rq_deadline;
1124 /** request format description */
1125 struct req_capsule rq_pill;
1129 * Call completion handler for rpc if any, return it's status or original
1130 * rc if there was no handler defined for this request.
1132 static inline int ptlrpc_req_interpret(const struct lu_env *env,
1133 struct ptlrpc_request *req, int rc)
1135 if (req->rq_interpret_reply != NULL) {
1136 req->rq_status = req->rq_interpret_reply(env, req,
1137 &req->rq_async_args,
1139 return req->rq_status;
1148 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
1149 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
1150 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
1151 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
1152 struct ptlrpc_nrs_pol_info *info);
1155 * Can the request be moved from the regular NRS head to the high-priority NRS
1156 * head (of the same PTLRPC service partition), if any?
1158 * For a reliable result, this should be checked under svcpt->scp_req lock.
1160 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
1162 struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
1165 * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
1166 * request has been enqueued first, and ptlrpc_nrs_request::nr_started
1167 * to make sure it has not been scheduled yet (analogous to previous
1168 * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
1170 return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
1175 * Returns true if request buffer at offset \a index was already swabbed
1177 static inline bool lustre_req_swabbed(struct ptlrpc_request *req, size_t index)
1179 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1180 return req->rq_req_swab_mask & (1 << index);
1184 * Returns true if request reply buffer at offset \a index was already swabbed
1186 static inline bool lustre_rep_swabbed(struct ptlrpc_request *req, size_t index)
1188 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1189 return req->rq_rep_swab_mask & (1 << index);
1193 * Returns true if request needs to be swabbed into local cpu byteorder
1195 static inline bool ptlrpc_req_need_swab(struct ptlrpc_request *req)
1197 return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1201 * Returns true if request reply needs to be swabbed into local cpu byteorder
1203 static inline bool ptlrpc_rep_need_swab(struct ptlrpc_request *req)
1205 return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1209 * Mark request buffer at offset \a index that it was already swabbed
1211 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req,
1214 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1215 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
1216 req->rq_req_swab_mask |= 1 << index;
1220 * Mark request reply buffer at offset \a index that it was already swabbed
1222 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req,
1225 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1226 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
1227 req->rq_rep_swab_mask |= 1 << index;
1231 * Convert numerical request phase value \a phase into text string description
1233 static inline const char *
1234 ptlrpc_phase2str(enum rq_phase phase)
1243 case RQ_PHASE_INTERPRET:
1245 case RQ_PHASE_COMPLETE:
1247 case RQ_PHASE_UNREG_RPC:
1249 case RQ_PHASE_UNREG_BULK:
1257 * Convert numerical request phase of the request \a req into text stringi
1260 static inline const char *
1261 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1263 return ptlrpc_phase2str(req->rq_phase);
1267 * Debugging functions and helpers to print request structure into debug log
1270 /* Spare the preprocessor, spoil the bugs. */
1271 #define FLAG(field, str) (field ? str : "")
1273 /** Convert bit flags into a string */
1274 #define DEBUG_REQ_FLAGS(req) \
1275 ptlrpc_rqphase2str(req), \
1276 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
1277 FLAG(req->rq_err, "E"), FLAG(req->rq_net_err, "e"), \
1278 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
1279 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
1280 FLAG(req->rq_no_resend, "N"), FLAG(req->rq_no_reply, "n"), \
1281 FLAG(req->rq_waiting, "W"), \
1282 FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \
1283 FLAG(req->rq_committed, "M"), \
1284 FLAG(req->rq_req_unlinked, "Q"), \
1285 FLAG(req->rq_reply_unlinked, "U"), \
1286 FLAG(req->rq_receiving_reply, "r")
1288 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s"
1290 void _debug_req(struct ptlrpc_request *req,
1291 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1292 __attribute__ ((format (printf, 3, 4)));
1295 * Helper that decides if we need to print request accordig to current debug
1298 #define debug_req(msgdata, mask, cdls, req, fmt, a...) \
1300 CFS_CHECK_STACK(msgdata, mask, cdls); \
1302 if (((mask) & D_CANTMASK) != 0 || \
1303 ((libcfs_debug & (mask)) != 0 && \
1304 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1305 _debug_req((req), msgdata, fmt, ##a); \
1309 * This is the debug print function you need to use to print request sturucture
1310 * content into lustre debug log.
1311 * for most callers (level is a constant) this is resolved at compile time */
1312 #define DEBUG_REQ(level, req, fmt, args...) \
1314 if ((level) & (D_ERROR | D_WARNING)) { \
1315 static struct cfs_debug_limit_state cdls; \
1316 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1317 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1319 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1320 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
1326 * Structure that defines a single page of a bulk transfer
1328 struct ptlrpc_bulk_page {
1329 /** Linkage to list of pages in a bulk */
1330 struct list_head bp_link;
1332 * Number of bytes in a page to transfer starting from \a bp_pageoffset
1335 /** offset within a page */
1337 /** The page itself */
1338 struct page *bp_page;
1341 enum ptlrpc_bulk_op_type {
1342 PTLRPC_BULK_OP_ACTIVE = 0x00000001,
1343 PTLRPC_BULK_OP_PASSIVE = 0x00000002,
1344 PTLRPC_BULK_OP_PUT = 0x00000004,
1345 PTLRPC_BULK_OP_GET = 0x00000008,
1346 PTLRPC_BULK_BUF_KVEC = 0x00000010,
1347 PTLRPC_BULK_BUF_KIOV = 0x00000020,
1348 PTLRPC_BULK_GET_SOURCE = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_GET,
1349 PTLRPC_BULK_PUT_SINK = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_PUT,
1350 PTLRPC_BULK_GET_SINK = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_GET,
1351 PTLRPC_BULK_PUT_SOURCE = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_PUT,
1354 static inline bool ptlrpc_is_bulk_op_get(enum ptlrpc_bulk_op_type type)
1356 return (type & PTLRPC_BULK_OP_GET) == PTLRPC_BULK_OP_GET;
1359 static inline bool ptlrpc_is_bulk_get_source(enum ptlrpc_bulk_op_type type)
1361 return (type & PTLRPC_BULK_GET_SOURCE) == PTLRPC_BULK_GET_SOURCE;
1364 static inline bool ptlrpc_is_bulk_put_sink(enum ptlrpc_bulk_op_type type)
1366 return (type & PTLRPC_BULK_PUT_SINK) == PTLRPC_BULK_PUT_SINK;
1369 static inline bool ptlrpc_is_bulk_get_sink(enum ptlrpc_bulk_op_type type)
1371 return (type & PTLRPC_BULK_GET_SINK) == PTLRPC_BULK_GET_SINK;
1374 static inline bool ptlrpc_is_bulk_put_source(enum ptlrpc_bulk_op_type type)
1376 return (type & PTLRPC_BULK_PUT_SOURCE) == PTLRPC_BULK_PUT_SOURCE;
1379 static inline bool ptlrpc_is_bulk_desc_kvec(enum ptlrpc_bulk_op_type type)
1381 return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1382 == PTLRPC_BULK_BUF_KVEC;
1385 static inline bool ptlrpc_is_bulk_desc_kiov(enum ptlrpc_bulk_op_type type)
1387 return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1388 == PTLRPC_BULK_BUF_KIOV;
1391 static inline bool ptlrpc_is_bulk_op_active(enum ptlrpc_bulk_op_type type)
1393 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1394 (type & PTLRPC_BULK_OP_PASSIVE))
1395 == PTLRPC_BULK_OP_ACTIVE;
1398 static inline bool ptlrpc_is_bulk_op_passive(enum ptlrpc_bulk_op_type type)
1400 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1401 (type & PTLRPC_BULK_OP_PASSIVE))
1402 == PTLRPC_BULK_OP_PASSIVE;
1405 struct ptlrpc_bulk_frag_ops {
1407 * Add a page \a page to the bulk descriptor \a desc
1408 * Data to transfer in the page starts at offset \a pageoffset and
1409 * amount of data to transfer from the page is \a len
1411 void (*add_kiov_frag)(struct ptlrpc_bulk_desc *desc,
1412 struct page *page, int pageoffset, int len);
1415 * Add a \a fragment to the bulk descriptor \a desc.
1416 * Data to transfer in the fragment is pointed to by \a frag
1417 * The size of the fragment is \a len
1419 int (*add_iov_frag)(struct ptlrpc_bulk_desc *desc, void *frag, int len);
1422 * Uninitialize and free bulk descriptor \a desc.
1423 * Works on bulk descriptors both from server and client side.
1425 void (*release_frags)(struct ptlrpc_bulk_desc *desc);
1428 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops;
1429 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops;
1430 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kvec_ops;
1433 * Definition of bulk descriptor.
1434 * Bulks are special "Two phase" RPCs where initial request message
1435 * is sent first and it is followed bt a transfer (o receiving) of a large
1436 * amount of data to be settled into pages referenced from the bulk descriptors.
1437 * Bulks transfers (the actual data following the small requests) are done
1438 * on separate LNet portals.
1439 * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1440 * Another user is readpage for MDT.
1442 struct ptlrpc_bulk_desc {
1443 /** completed with failure */
1444 unsigned long bd_failure:1;
1446 unsigned long bd_registered:1;
1447 /** For serialization with callback */
1449 /** Import generation when request for this bulk was sent */
1450 int bd_import_generation;
1451 /** {put,get}{source,sink}{kvec,kiov} */
1452 enum ptlrpc_bulk_op_type bd_type;
1453 /** LNet portal for this bulk */
1455 /** Server side - export this bulk created for */
1456 struct obd_export *bd_export;
1457 /** Client side - import this bulk was sent on */
1458 struct obd_import *bd_import;
1459 /** Back pointer to the request */
1460 struct ptlrpc_request *bd_req;
1461 const struct ptlrpc_bulk_frag_ops *bd_frag_ops;
1462 wait_queue_head_t bd_waitq; /* server side only WQ */
1463 int bd_iov_count; /* # entries in bd_iov */
1464 int bd_max_iov; /* allocated size of bd_iov */
1465 int bd_nob; /* # bytes covered */
1466 int bd_nob_transferred; /* # bytes GOT/PUT */
1468 __u64 bd_last_mbits;
1470 struct ptlrpc_cb_id bd_cbid; /* network callback info */
1471 lnet_nid_t bd_sender; /* stash event::sender */
1472 int bd_md_count; /* # valid entries in bd_mds */
1473 int bd_md_max_brw; /* max entries in bd_mds */
1474 /** array of associated MDs */
1475 struct lnet_handle_md bd_mds[PTLRPC_BULK_OPS_COUNT];
1480 * encrypt iov, size is either 0 or bd_iov_count.
1482 lnet_kiov_t *bd_enc_vec;
1483 lnet_kiov_t *bd_vec;
1487 struct kvec *bd_enc_kvec;
1488 struct kvec *bd_kvec;
1494 #define GET_KIOV(desc) ((desc)->bd_u.bd_kiov.bd_vec)
1495 #define BD_GET_KIOV(desc, i) ((desc)->bd_u.bd_kiov.bd_vec[i])
1496 #define GET_ENC_KIOV(desc) ((desc)->bd_u.bd_kiov.bd_enc_vec)
1497 #define BD_GET_ENC_KIOV(desc, i) ((desc)->bd_u.bd_kiov.bd_enc_vec[i])
1498 #define GET_KVEC(desc) ((desc)->bd_u.bd_kvec.bd_kvec)
1499 #define BD_GET_KVEC(desc, i) ((desc)->bd_u.bd_kvec.bd_kvec[i])
1500 #define GET_ENC_KVEC(desc) ((desc)->bd_u.bd_kvec.bd_enc_kvec)
1501 #define BD_GET_ENC_KVEC(desc, i) ((desc)->bd_u.bd_kvec.bd_enc_kvec[i])
1505 SVC_STOPPED = 1 << 0,
1506 SVC_STOPPING = 1 << 1,
1507 SVC_STARTING = 1 << 2,
1508 SVC_RUNNING = 1 << 3,
1512 #define PTLRPC_THR_NAME_LEN 32
1514 * Definition of server service thread structure
1516 struct ptlrpc_thread {
1518 * List of active threads in svc->srv_threads
1520 struct list_head t_link;
1522 * thread-private data (preallocated vmalloc'd memory)
1527 * service thread index, from ptlrpc_start_threads
1533 struct task_struct *t_task;
1537 * put watchdog in the structure per thread b=14840
1539 struct delayed_work t_watchdog;
1541 * the svc this thread belonged to b=18582
1543 struct ptlrpc_service_part *t_svcpt;
1544 wait_queue_head_t t_ctl_waitq;
1545 struct lu_env *t_env;
1546 char t_name[PTLRPC_THR_NAME_LEN];
1549 static inline int thread_is_init(struct ptlrpc_thread *thread)
1551 return thread->t_flags == 0;
1554 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1556 return !!(thread->t_flags & SVC_STOPPED);
1559 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1561 return !!(thread->t_flags & SVC_STOPPING);
1564 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1566 return !!(thread->t_flags & SVC_STARTING);
1569 static inline int thread_is_running(struct ptlrpc_thread *thread)
1571 return !!(thread->t_flags & SVC_RUNNING);
1574 static inline int thread_is_event(struct ptlrpc_thread *thread)
1576 return !!(thread->t_flags & SVC_EVENT);
1579 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1581 thread->t_flags &= ~flags;
1584 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1586 thread->t_flags = flags;
1589 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1591 thread->t_flags |= flags;
1594 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1597 if (thread->t_flags & flags) {
1598 thread->t_flags &= ~flags;
1605 * Request buffer descriptor structure.
1606 * This is a structure that contains one posted request buffer for service.
1607 * Once data land into a buffer, event callback creates actual request and
1608 * notifies wakes one of the service threads to process new incoming request.
1609 * More than one request can fit into the buffer.
1611 struct ptlrpc_request_buffer_desc {
1612 /** Link item for rqbds on a service */
1613 struct list_head rqbd_list;
1614 /** History of requests for this buffer */
1615 struct list_head rqbd_reqs;
1616 /** Back pointer to service for which this buffer is registered */
1617 struct ptlrpc_service_part *rqbd_svcpt;
1618 /** LNet descriptor */
1619 struct lnet_handle_md rqbd_md_h;
1621 /** The buffer itself */
1623 struct ptlrpc_cb_id rqbd_cbid;
1625 * This "embedded" request structure is only used for the
1626 * last request to fit into the buffer
1628 struct ptlrpc_request rqbd_req;
1631 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
1633 struct ptlrpc_service_ops {
1635 * if non-NULL called during thread creation (ptlrpc_start_thread())
1636 * to initialize service specific per-thread state.
1638 int (*so_thr_init)(struct ptlrpc_thread *thr);
1640 * if non-NULL called during thread shutdown (ptlrpc_main()) to
1641 * destruct state created by ->srv_init().
1643 void (*so_thr_done)(struct ptlrpc_thread *thr);
1645 * Handler function for incoming requests for this service
1647 int (*so_req_handler)(struct ptlrpc_request *req);
1649 * function to determine priority of the request, it's called
1650 * on every new request
1652 int (*so_hpreq_handler)(struct ptlrpc_request *);
1654 * service-specific print fn
1656 void (*so_req_printer)(void *, struct ptlrpc_request *);
1659 #ifndef __cfs_cacheline_aligned
1660 /* NB: put it here for reducing patche dependence */
1661 # define __cfs_cacheline_aligned
1665 * How many high priority requests to serve before serving one normal
1668 #define PTLRPC_SVC_HP_RATIO 10
1671 * Definition of PortalRPC service.
1672 * The service is listening on a particular portal (like tcp port)
1673 * and perform actions for a specific server like IO service for OST
1674 * or general metadata service for MDS.
1676 struct ptlrpc_service {
1677 /** serialize /proc operations */
1678 spinlock_t srv_lock;
1679 /** most often accessed fields */
1680 /** chain thru all services */
1681 struct list_head srv_list;
1682 /** service operations table */
1683 struct ptlrpc_service_ops srv_ops;
1684 /** only statically allocated strings here; we don't clean them */
1686 /** only statically allocated strings here; we don't clean them */
1687 char *srv_thread_name;
1688 /** service thread list */
1689 struct list_head srv_threads;
1690 /** threads # should be created for each partition on initializing */
1691 int srv_nthrs_cpt_init;
1692 /** limit of threads number for each partition */
1693 int srv_nthrs_cpt_limit;
1694 /** Root of debugfs dir tree for this service */
1695 struct dentry *srv_debugfs_entry;
1696 /** Pointer to statistic data for this service */
1697 struct lprocfs_stats *srv_stats;
1698 /** # hp per lp reqs to handle */
1699 int srv_hpreq_ratio;
1700 /** biggest request to receive */
1701 int srv_max_req_size;
1702 /** biggest reply to send */
1703 int srv_max_reply_size;
1704 /** size of individual buffers */
1706 /** # buffers to allocate in 1 group */
1707 int srv_nbuf_per_group;
1708 /** Local portal on which to receive requests */
1709 __u32 srv_req_portal;
1710 /** Portal on the client to send replies to */
1711 __u32 srv_rep_portal;
1713 * Tags for lu_context associated with this thread, see struct
1717 /** soft watchdog timeout multiplier */
1718 int srv_watchdog_factor;
1719 /** under unregister_service */
1720 unsigned srv_is_stopping:1;
1721 /** Whether or not to restrict service threads to CPUs in this CPT */
1722 unsigned srv_cpt_bind:1;
1724 /** max # request buffers */
1726 /** max # request buffers in history per partition */
1727 int srv_hist_nrqbds_cpt_max;
1728 /** number of CPTs this service associated with */
1730 /** CPTs array this service associated with */
1732 /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
1734 /** CPT table this service is running over */
1735 struct cfs_cpt_table *srv_cptable;
1738 struct kobject srv_kobj;
1739 struct completion srv_kobj_unregister;
1741 * partition data for ptlrpc service
1743 struct ptlrpc_service_part *srv_parts[0];
1747 * Definition of PortalRPC service partition data.
1748 * Although a service only has one instance of it right now, but we
1749 * will have multiple instances very soon (instance per CPT).
1751 * it has four locks:
1753 * serialize operations on rqbd and requests waiting for preprocess
1755 * serialize operations active requests sent to this portal
1757 * serialize adaptive timeout stuff
1759 * serialize operations on RS list (reply states)
1761 * We don't have any use-case to take two or more locks at the same time
1762 * for now, so there is no lock order issue.
1764 struct ptlrpc_service_part {
1765 /** back reference to owner */
1766 struct ptlrpc_service *scp_service __cfs_cacheline_aligned;
1767 /* CPT id, reserved */
1769 /** always increasing number */
1771 /** # of starting threads */
1772 int scp_nthrs_starting;
1773 /** # of stopping threads, reserved for shrinking threads */
1774 int scp_nthrs_stopping;
1775 /** # running threads */
1776 int scp_nthrs_running;
1777 /** service threads list */
1778 struct list_head scp_threads;
1781 * serialize the following fields, used for protecting
1782 * rqbd list and incoming requests waiting for preprocess,
1783 * threads starting & stopping are also protected by this lock.
1785 spinlock_t scp_lock __cfs_cacheline_aligned;
1786 /** userland serialization */
1787 struct mutex scp_mutex;
1788 /** total # req buffer descs allocated */
1789 int scp_nrqbds_total;
1790 /** # posted request buffers for receiving */
1791 int scp_nrqbds_posted;
1792 /** in progress of allocating rqbd */
1793 int scp_rqbd_allocating;
1794 /** # incoming reqs */
1795 int scp_nreqs_incoming;
1796 /** request buffers to be reposted */
1797 struct list_head scp_rqbd_idle;
1798 /** req buffers receiving */
1799 struct list_head scp_rqbd_posted;
1800 /** incoming reqs */
1801 struct list_head scp_req_incoming;
1802 /** timeout before re-posting reqs, in jiffies */
1803 long scp_rqbd_timeout;
1805 * all threads sleep on this. This wait-queue is signalled when new
1806 * incoming request arrives and when difficult reply has to be handled.
1808 wait_queue_head_t scp_waitq;
1810 /** request history */
1811 struct list_head scp_hist_reqs;
1812 /** request buffer history */
1813 struct list_head scp_hist_rqbds;
1814 /** # request buffers in history */
1815 int scp_hist_nrqbds;
1816 /** sequence number for request */
1818 /** highest seq culled from history */
1819 __u64 scp_hist_seq_culled;
1822 * serialize the following fields, used for processing requests
1823 * sent to this portal
1825 spinlock_t scp_req_lock __cfs_cacheline_aligned;
1826 /** # reqs in either of the NRS heads below */
1827 /** # reqs being served */
1828 int scp_nreqs_active;
1829 /** # HPreqs being served */
1830 int scp_nhreqs_active;
1831 /** # hp requests handled */
1834 /** NRS head for regular requests */
1835 struct ptlrpc_nrs scp_nrs_reg;
1836 /** NRS head for HP requests; this is only valid for services that can
1837 * handle HP requests */
1838 struct ptlrpc_nrs *scp_nrs_hp;
1843 * serialize the following fields, used for changes on
1846 spinlock_t scp_at_lock __cfs_cacheline_aligned;
1847 /** estimated rpc service time */
1848 struct adaptive_timeout scp_at_estimate;
1849 /** reqs waiting for replies */
1850 struct ptlrpc_at_array scp_at_array;
1851 /** early reply timer */
1852 struct timer_list scp_at_timer;
1854 ktime_t scp_at_checktime;
1855 /** check early replies */
1856 unsigned scp_at_check;
1860 * serialize the following fields, used for processing
1861 * replies for this portal
1863 spinlock_t scp_rep_lock __cfs_cacheline_aligned;
1864 /** all the active replies */
1865 struct list_head scp_rep_active;
1866 /** List of free reply_states */
1867 struct list_head scp_rep_idle;
1868 /** waitq to run, when adding stuff to srv_free_rs_list */
1869 wait_queue_head_t scp_rep_waitq;
1870 /** # 'difficult' replies */
1871 atomic_t scp_nreps_difficult;
1874 #define ptlrpc_service_for_each_part(part, i, svc) \
1876 i < (svc)->srv_ncpts && \
1877 (svc)->srv_parts != NULL && \
1878 ((part) = (svc)->srv_parts[i]) != NULL; i++)
1881 * Declaration of ptlrpcd control structure
1883 struct ptlrpcd_ctl {
1885 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1887 unsigned long pc_flags;
1889 * Thread lock protecting structure fields.
1895 struct completion pc_starting;
1899 struct completion pc_finishing;
1901 * Thread requests set.
1903 struct ptlrpc_request_set *pc_set;
1905 * Thread name used in kthread_run()
1909 * CPT the thread is bound on.
1913 * Index of ptlrpcd thread in the array.
1917 * Pointer to the array of partners' ptlrpcd_ctl structure.
1919 struct ptlrpcd_ctl **pc_partners;
1921 * Number of the ptlrpcd's partners.
1925 * Record the partner index to be processed next.
1929 * Error code if the thread failed to fully start.
1934 /* Bits for pc_flags */
1935 enum ptlrpcd_ctl_flags {
1937 * Ptlrpc thread start flag.
1939 LIOD_START = 1 << 0,
1941 * Ptlrpc thread stop flag.
1945 * Ptlrpc thread force flag (only stop force so far).
1946 * This will cause aborting any inflight rpcs handled
1947 * by thread if LIOD_STOP is specified.
1949 LIOD_FORCE = 1 << 2,
1951 * This is a recovery ptlrpc thread.
1953 LIOD_RECOVERY = 1 << 3,
1960 * Service compatibility function; the policy is compatible with all services.
1962 * \param[in] svc The service the policy is attempting to register with.
1963 * \param[in] desc The policy descriptor
1965 * \retval true The policy is compatible with the service
1967 * \see ptlrpc_nrs_pol_desc::pd_compat()
1969 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
1970 const struct ptlrpc_nrs_pol_desc *desc)
1976 * Service compatibility function; the policy is compatible with only a specific
1977 * service which is identified by its human-readable name at
1978 * ptlrpc_service::srv_name.
1980 * \param[in] svc The service the policy is attempting to register with.
1981 * \param[in] desc The policy descriptor
1983 * \retval false The policy is not compatible with the service
1984 * \retval true The policy is compatible with the service
1986 * \see ptlrpc_nrs_pol_desc::pd_compat()
1988 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
1989 const struct ptlrpc_nrs_pol_desc *desc)
1991 LASSERT(desc->pd_compat_svc_name != NULL);
1992 return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
1997 /* ptlrpc/events.c */
1998 extern struct lnet_handle_eq ptlrpc_eq_h;
1999 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
2000 struct lnet_process_id *peer, lnet_nid_t *self);
2002 * These callbacks are invoked by LNet when something happened to
2006 extern void request_out_callback(struct lnet_event *ev);
2007 extern void reply_in_callback(struct lnet_event *ev);
2008 extern void client_bulk_callback(struct lnet_event *ev);
2009 extern void request_in_callback(struct lnet_event *ev);
2010 extern void reply_out_callback(struct lnet_event *ev);
2011 #ifdef HAVE_SERVER_SUPPORT
2012 extern void server_bulk_callback(struct lnet_event *ev);
2016 /* ptlrpc/connection.c */
2017 struct ptlrpc_connection *ptlrpc_connection_get(struct lnet_process_id peer,
2019 struct obd_uuid *uuid);
2020 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2021 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2022 int ptlrpc_connection_init(void);
2023 void ptlrpc_connection_fini(void);
2024 extern lnet_pid_t ptl_get_pid(void);
2027 * Check if the peer connection is on the local node. We need to use GFP_NOFS
2028 * for requests from a local client to avoid recursing into the filesystem
2029 * as we might end up waiting on a page sent in the request we're serving.
2031 * Use __GFP_HIGHMEM so that the pages can use all of the available memory
2032 * on 32-bit machines. Use more aggressive GFP_HIGHUSER flags from non-local
2033 * clients to be able to generate more memory pressure on the OSS and allow
2034 * inactive pages to be reclaimed, since it doesn't have any other processes
2035 * or allocations that generate memory reclaim pressure.
2037 * See b=17576 (bdf50dc9) and b=19529 (3dcf18d3) for details.
2039 static inline bool ptlrpc_connection_is_local(struct ptlrpc_connection *conn)
2044 if (conn->c_peer.nid == conn->c_self)
2047 RETURN(LNetIsPeerLocal(conn->c_peer.nid));
2050 /* ptlrpc/niobuf.c */
2052 * Actual interfacing with LNet to put/get/register/unregister stuff
2055 #ifdef HAVE_SERVER_SUPPORT
2056 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2057 unsigned nfrags, unsigned max_brw,
2060 const struct ptlrpc_bulk_frag_ops
2062 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2063 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2065 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2069 LASSERT(desc != NULL);
2071 spin_lock(&desc->bd_lock);
2072 rc = desc->bd_md_count;
2073 spin_unlock(&desc->bd_lock);
2078 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2079 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2081 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2083 struct ptlrpc_bulk_desc *desc;
2086 LASSERT(req != NULL);
2087 desc = req->rq_bulk;
2092 if (req->rq_bulk_deadline > ktime_get_real_seconds())
2096 spin_lock(&desc->bd_lock);
2097 rc = desc->bd_md_count;
2098 spin_unlock(&desc->bd_lock);
2102 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2103 #define PTLRPC_REPLY_EARLY 0x02
2104 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2105 int ptlrpc_reply(struct ptlrpc_request *req);
2106 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2107 int ptlrpc_error(struct ptlrpc_request *req);
2108 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2109 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2110 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2113 /* ptlrpc/client.c */
2115 * Client-side portals API. Everything to send requests, receive replies,
2116 * request queues, request management, etc.
2119 void ptlrpc_request_committed(struct ptlrpc_request *req, int force);
2121 void ptlrpc_init_client(int req_portal, int rep_portal, const char *name,
2122 struct ptlrpc_client *);
2123 void ptlrpc_cleanup_client(struct obd_import *imp);
2124 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
2125 lnet_nid_t nid4refnet);
2127 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2128 int ptlrpc_replay_req(struct ptlrpc_request *req);
2129 void ptlrpc_restart_req(struct ptlrpc_request *req);
2130 void ptlrpc_abort_inflight(struct obd_import *imp);
2131 void ptlrpc_cleanup_imp(struct obd_import *imp);
2132 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2134 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2135 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2137 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2138 int ptlrpc_set_wait(const struct lu_env *env, struct ptlrpc_request_set *);
2139 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2140 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2141 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2143 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2144 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2146 struct ptlrpc_request_pool *
2147 ptlrpc_init_rq_pool(int, int,
2148 int (*populate_pool)(struct ptlrpc_request_pool *, int));
2150 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2151 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2152 const struct req_format *format);
2153 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2154 struct ptlrpc_request_pool *,
2155 const struct req_format *format);
2156 void ptlrpc_request_free(struct ptlrpc_request *request);
2157 int ptlrpc_request_pack(struct ptlrpc_request *request,
2158 __u32 version, int opcode);
2159 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2160 const struct req_format *format,
2161 __u32 version, int opcode);
2162 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2163 __u32 version, int opcode, char **bufs,
2164 struct ptlrpc_cli_ctx *ctx);
2165 void ptlrpc_req_finished(struct ptlrpc_request *request);
2166 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2167 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2168 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2169 unsigned nfrags, unsigned max_brw,
2172 const struct ptlrpc_bulk_frag_ops
2175 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
2176 void *frag, int len);
2177 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2178 struct page *page, int pageoffset, int len,
2181 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
2183 static inline void ptlrpc_release_bulk_noop(struct ptlrpc_bulk_desc *desc)
2187 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2188 struct obd_import *imp);
2189 __u64 ptlrpc_next_xid(void);
2190 __u64 ptlrpc_sample_next_xid(void);
2191 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
2193 /* Set of routines to run a function in ptlrpcd context */
2194 void *ptlrpcd_alloc_work(struct obd_import *imp,
2195 int (*cb)(const struct lu_env *, void *), void *data);
2196 void ptlrpcd_destroy_work(void *handler);
2197 int ptlrpcd_queue_work(void *handler);
2200 struct ptlrpc_service_buf_conf {
2201 /* nbufs is buffers # to allocate when growing the pool */
2202 unsigned int bc_nbufs;
2203 /* buffer size to post */
2204 unsigned int bc_buf_size;
2205 /* portal to listed for requests on */
2206 unsigned int bc_req_portal;
2207 /* portal of where to send replies to */
2208 unsigned int bc_rep_portal;
2209 /* maximum request size to be accepted for this service */
2210 unsigned int bc_req_max_size;
2211 /* maximum reply size this service can ever send */
2212 unsigned int bc_rep_max_size;
2215 struct ptlrpc_service_thr_conf {
2216 /* threadname should be 8 characters or less - 6 will be added on */
2218 /* threads increasing factor for each CPU */
2219 unsigned int tc_thr_factor;
2220 /* service threads # to start on each partition while initializing */
2221 unsigned int tc_nthrs_init;
2223 * low water of threads # upper-limit on each partition while running,
2224 * service availability may be impacted if threads number is lower
2225 * than this value. It can be ZERO if the service doesn't require
2226 * CPU affinity or there is only one partition.
2228 unsigned int tc_nthrs_base;
2229 /* "soft" limit for total threads number */
2230 unsigned int tc_nthrs_max;
2231 /* user specified threads number, it will be validated due to
2232 * other members of this structure. */
2233 unsigned int tc_nthrs_user;
2234 /* bind service threads to only CPUs in their associated CPT */
2235 unsigned int tc_cpu_bind;
2236 /* Tags for lu_context associated with service thread */
2240 struct ptlrpc_service_cpt_conf {
2241 struct cfs_cpt_table *cc_cptable;
2242 /* string pattern to describe CPTs for a service */
2244 /* whether or not to have per-CPT service partitions */
2248 struct ptlrpc_service_conf {
2251 /* soft watchdog timeout multiplifier to print stuck service traces */
2252 unsigned int psc_watchdog_factor;
2253 /* buffer information */
2254 struct ptlrpc_service_buf_conf psc_buf;
2255 /* thread information */
2256 struct ptlrpc_service_thr_conf psc_thr;
2257 /* CPU partition information */
2258 struct ptlrpc_service_cpt_conf psc_cpt;
2259 /* function table */
2260 struct ptlrpc_service_ops psc_ops;
2263 /* ptlrpc/service.c */
2265 * Server-side services API. Register/unregister service, request state
2266 * management, service thread management
2270 void ptlrpc_save_lock(struct ptlrpc_request *req, struct lustre_handle *lock,
2271 int mode, bool no_ack, bool convert_lock);
2272 void ptlrpc_commit_replies(struct obd_export *exp);
2273 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
2274 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
2275 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
2276 struct ptlrpc_service *ptlrpc_register_service(
2277 struct ptlrpc_service_conf *conf,
2278 struct kset *parent,
2279 struct dentry *debugfs_entry);
2280 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
2282 int ptlrpc_start_threads(struct ptlrpc_service *svc);
2283 int ptlrpc_unregister_service(struct ptlrpc_service *service);
2284 int ptlrpc_service_health_check(struct ptlrpc_service *);
2285 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
2286 void ptlrpc_request_change_export(struct ptlrpc_request *req,
2287 struct obd_export *export);
2288 void ptlrpc_update_export_timer(struct obd_export *exp,
2289 time64_t extra_delay);
2291 int ptlrpc_hr_init(void);
2292 void ptlrpc_hr_fini(void);
2296 /* ptlrpc/import.c */
2301 int ptlrpc_connect_import(struct obd_import *imp);
2302 int ptlrpc_init_import(struct obd_import *imp);
2303 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
2304 int ptlrpc_disconnect_and_idle_import(struct obd_import *imp);
2305 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
2306 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
2308 void ptlrpc_import_enter_resend(struct obd_import *imp);
2309 /* ptlrpc/pack_generic.c */
2310 int ptlrpc_reconnect_import(struct obd_import *imp);
2314 * ptlrpc msg buffer and swab interface
2318 bool ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
2320 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
2322 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
2323 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
2325 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
2326 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
2328 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
2329 __u32 *lens, char **bufs);
2330 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
2332 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
2333 __u32 *lens, char **bufs, int flags);
2334 #define LPRFL_EARLY_REPLY 1
2335 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
2336 char **bufs, int flags);
2337 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
2338 unsigned int newlen, int move_data);
2339 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
2340 int __lustre_unpack_msg(struct lustre_msg *m, int len);
2341 __u32 lustre_msg_hdr_size(__u32 magic, __u32 count);
2342 __u32 lustre_msg_size(__u32 magic, int count, __u32 *lengths);
2343 __u32 lustre_msg_size_v2(int count, __u32 *lengths);
2344 __u32 lustre_packed_msg_size(struct lustre_msg *msg);
2345 __u32 lustre_msg_early_size(void);
2346 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, __u32 n, __u32 min_size);
2347 void *lustre_msg_buf(struct lustre_msg *m, __u32 n, __u32 minlen);
2348 __u32 lustre_msg_buflen(struct lustre_msg *m, __u32 n);
2349 void lustre_msg_set_buflen(struct lustre_msg *m, __u32 n, __u32 len);
2350 __u32 lustre_msg_bufcount(struct lustre_msg *m);
2351 char *lustre_msg_string(struct lustre_msg *m, __u32 n, __u32 max_len);
2352 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
2353 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
2354 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
2355 void lustre_msg_add_flags(struct lustre_msg *msg, __u32 flags);
2356 void lustre_msg_set_flags(struct lustre_msg *msg, __u32 flags);
2357 void lustre_msg_clear_flags(struct lustre_msg *msg, __u32 flags);
2358 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
2359 void lustre_msg_add_op_flags(struct lustre_msg *msg, __u32 flags);
2360 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
2361 __u32 lustre_msg_get_type(struct lustre_msg *msg);
2362 enum lustre_msg_version lustre_msg_get_version(struct lustre_msg *msg);
2363 void lustre_msg_add_version(struct lustre_msg *msg, __u32 version);
2364 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
2365 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
2366 __u16 lustre_msg_get_tag(struct lustre_msg *msg);
2367 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
2368 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
2369 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
2370 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
2371 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
2372 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
2373 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
2374 int lustre_msg_get_status(struct lustre_msg *msg);
2375 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
2376 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
2377 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
2378 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
2379 char *lustre_msg_get_jobid(struct lustre_msg *msg);
2380 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
2381 __u64 lustre_msg_get_mbits(struct lustre_msg *msg);
2382 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
2383 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
2384 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
2385 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
2386 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
2387 void lustre_msg_set_tag(struct lustre_msg *msg, __u16 tag);
2388 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
2389 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
2390 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
2391 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
2392 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
2393 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
2394 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
2395 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
2396 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
2397 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
2398 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
2399 void lustre_msg_set_mbits(struct lustre_msg *msg, __u64 mbits);
2402 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
2403 unsigned int newlen, int move_data)
2405 LASSERT(req->rq_reply_state);
2406 LASSERT(req->rq_repmsg);
2407 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2411 #ifdef LUSTRE_TRANSLATE_ERRNOS
2413 static inline int ptlrpc_status_hton(int h)
2416 * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
2417 * ELDLM_LOCK_ABORTED, etc.
2420 return -lustre_errno_hton(-h);
2425 static inline int ptlrpc_status_ntoh(int n)
2428 * See the comment in ptlrpc_status_hton().
2431 return -lustre_errno_ntoh(-n);
2438 #define ptlrpc_status_hton(h) (h)
2439 #define ptlrpc_status_ntoh(n) (n)
2444 /** Change request phase of \a req to \a new_phase */
2446 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2448 if (req->rq_phase == new_phase)
2451 if (new_phase == RQ_PHASE_UNREG_RPC ||
2452 new_phase == RQ_PHASE_UNREG_BULK) {
2453 /* No embedded unregistering phases */
2454 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2455 req->rq_phase == RQ_PHASE_UNREG_BULK)
2458 req->rq_next_phase = req->rq_phase;
2460 atomic_inc(&req->rq_import->imp_unregistering);
2463 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2464 req->rq_phase == RQ_PHASE_UNREG_BULK) {
2466 atomic_dec(&req->rq_import->imp_unregistering);
2469 DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
2470 ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2472 req->rq_phase = new_phase;
2476 * Returns true if request \a req got early reply and hard deadline is not met
2479 ptlrpc_client_early(struct ptlrpc_request *req)
2481 return req->rq_early;
2485 * Returns true if we got real reply from server for this request
2488 ptlrpc_client_replied(struct ptlrpc_request *req)
2490 if (req->rq_reply_deadline > ktime_get_real_seconds())
2492 return req->rq_replied;
2495 /** Returns true if request \a req is in process of receiving server reply */
2497 ptlrpc_client_recv(struct ptlrpc_request *req)
2499 if (req->rq_reply_deadline > ktime_get_real_seconds())
2501 return req->rq_receiving_reply;
2505 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2509 spin_lock(&req->rq_lock);
2510 if (req->rq_reply_deadline > ktime_get_real_seconds()) {
2511 spin_unlock(&req->rq_lock);
2514 if (req->rq_req_deadline > ktime_get_real_seconds()) {
2515 spin_unlock(&req->rq_lock);
2519 rc = !req->rq_req_unlinked || !req->rq_reply_unlinked ||
2520 req->rq_receiving_reply;
2521 spin_unlock(&req->rq_lock);
2526 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2529 if (req->rq_set == NULL)
2530 wake_up(&req->rq_reply_waitq);
2532 wake_up(&req->rq_set->set_waitq);
2536 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2538 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2539 atomic_inc(&rs->rs_refcount);
2543 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2545 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2546 if (atomic_dec_and_test(&rs->rs_refcount))
2547 lustre_free_reply_state(rs);
2550 /* Should only be called once per req */
2551 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2553 if (req->rq_reply_state == NULL)
2554 return; /* shouldn't occur */
2555 ptlrpc_rs_decref(req->rq_reply_state);
2556 req->rq_reply_state = NULL;
2557 req->rq_repmsg = NULL;
2560 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2562 return lustre_msg_get_magic(req->rq_reqmsg);
2565 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2567 switch (req->rq_reqmsg->lm_magic) {
2568 case LUSTRE_MSG_MAGIC_V2:
2569 return req->rq_reqmsg->lm_repsize;
2571 LASSERTF(0, "incorrect message magic: %08x\n",
2572 req->rq_reqmsg->lm_magic);
2577 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2579 if (req->rq_delay_limit != 0 &&
2580 req->rq_queued_time + req->rq_delay_limit < ktime_get_seconds())
2585 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2587 if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2588 spin_lock(&req->rq_lock);
2589 req->rq_no_resend = 1;
2590 spin_unlock(&req->rq_lock);
2592 return req->rq_no_resend;
2596 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
2598 int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
2600 return svcpt->scp_service->srv_watchdog_factor *
2601 max_t(int, at, obd_timeout);
2604 static inline struct ptlrpc_service *
2605 ptlrpc_req2svc(struct ptlrpc_request *req)
2607 LASSERT(req->rq_rqbd != NULL);
2608 return req->rq_rqbd->rqbd_svcpt->scp_service;
2611 /* ldlm/ldlm_lib.c */
2613 * Target client logic
2616 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
2617 int client_obd_cleanup(struct obd_device *obddev);
2618 int client_connect_import(const struct lu_env *env,
2619 struct obd_export **exp, struct obd_device *obd,
2620 struct obd_uuid *cluuid, struct obd_connect_data *,
2622 int client_disconnect_export(struct obd_export *exp);
2623 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
2625 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
2626 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
2627 struct obd_uuid *uuid);
2628 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
2629 void client_destroy_import(struct obd_import *imp);
2632 #ifdef HAVE_SERVER_SUPPORT
2633 int server_disconnect_export(struct obd_export *exp);
2636 /* ptlrpc/pinger.c */
2638 * Pinger API (client side only)
2641 enum timeout_event {
2644 struct timeout_item;
2645 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
2646 int ptlrpc_pinger_add_import(struct obd_import *imp);
2647 int ptlrpc_pinger_del_import(struct obd_import *imp);
2648 int ptlrpc_add_timeout_client(time64_t time, enum timeout_event event,
2649 timeout_cb_t cb, void *data,
2650 struct list_head *obd_list);
2651 int ptlrpc_del_timeout_client(struct list_head *obd_list,
2652 enum timeout_event event);
2653 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
2654 int ptlrpc_obd_ping(struct obd_device *obd);
2655 void ping_evictor_start(void);
2656 void ping_evictor_stop(void);
2657 void ptlrpc_pinger_ir_up(void);
2658 void ptlrpc_pinger_ir_down(void);
2660 int ptlrpc_pinger_suppress_pings(void);
2662 /* ptlrpc/ptlrpcd.c */
2663 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
2664 void ptlrpcd_free(struct ptlrpcd_ctl *pc);
2665 void ptlrpcd_wake(struct ptlrpc_request *req);
2666 void ptlrpcd_add_req(struct ptlrpc_request *req);
2667 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
2668 int ptlrpcd_addref(void);
2669 void ptlrpcd_decref(void);
2671 /* ptlrpc/lproc_ptlrpc.c */
2673 * procfs output related functions
2676 const char* ll_opcode2str(__u32 opcode);
2677 const int ll_str2opcode(const char *ops);
2678 #ifdef CONFIG_PROC_FS
2679 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
2680 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
2681 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
2683 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
2684 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
2685 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
2689 /* ptlrpc/llog_server.c */
2690 int llog_origin_handle_open(struct ptlrpc_request *req);
2691 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
2692 int llog_origin_handle_next_block(struct ptlrpc_request *req);
2693 int llog_origin_handle_read_header(struct ptlrpc_request *req);
2695 /* ptlrpc/llog_client.c */
2696 extern struct llog_operations llog_client_ops;