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 <uapi/linux/lnet/nidstr.h>
58 #include <uapi/linux/lustre/lustre_idl.h>
59 #include <lustre_ha.h>
60 #include <lustre_sec.h>
61 #include <lustre_import.h>
62 #include <lprocfs_status.h>
63 #include <lu_object.h>
64 #include <lustre_req_layout.h>
65 #include <obd_support.h>
66 #include <uapi/linux/lustre/lustre_ver.h>
68 /* MD flags we _always_ use */
69 #define PTLRPC_MD_OPTIONS 0
72 * log2 max # of bulk operations in one request: 2=4MB/RPC, 5=32MB/RPC, ...
73 * In order for the client and server to properly negotiate the maximum
74 * possible transfer size, PTLRPC_BULK_OPS_COUNT must be a power-of-two
75 * value. The client is free to limit the actual RPC size for any bulk
76 * transfer via cl_max_pages_per_rpc to some non-power-of-two value.
77 * NOTE: This is limited to 16 (=64GB RPCs) by IOOBJ_MAX_BRW_BITS. */
78 #define PTLRPC_BULK_OPS_BITS 4
79 #if PTLRPC_BULK_OPS_BITS > 16
80 #error "More than 65536 BRW RPCs not allowed by IOOBJ_MAX_BRW_BITS."
82 #define PTLRPC_BULK_OPS_COUNT (1U << PTLRPC_BULK_OPS_BITS)
84 * PTLRPC_BULK_OPS_MASK is for the convenience of the client only, and
85 * should not be used on the server at all. Otherwise, it imposes a
86 * protocol limitation on the maximum RPC size that can be used by any
87 * RPC sent to that server in the future. Instead, the server should
88 * use the negotiated per-client ocd_brw_size to determine the bulk
90 #define PTLRPC_BULK_OPS_MASK (~((__u64)PTLRPC_BULK_OPS_COUNT - 1))
93 * Define maxima for bulk I/O.
95 * A single PTLRPC BRW request is sent via up to PTLRPC_BULK_OPS_COUNT
96 * of LNET_MTU sized RDMA transfers. Clients and servers negotiate the
97 * currently supported maximum between peers at connect via ocd_brw_size.
99 #define PTLRPC_MAX_BRW_BITS (LNET_MTU_BITS + PTLRPC_BULK_OPS_BITS)
100 #define PTLRPC_MAX_BRW_SIZE (1U << PTLRPC_MAX_BRW_BITS)
101 #define PTLRPC_MAX_BRW_PAGES (PTLRPC_MAX_BRW_SIZE >> PAGE_SHIFT)
103 #define ONE_MB_BRW_SIZE (1U << LNET_MTU_BITS)
104 #define MD_MAX_BRW_SIZE (1U << LNET_MTU_BITS)
105 #define MD_MAX_BRW_PAGES (MD_MAX_BRW_SIZE >> PAGE_SHIFT)
106 #define DT_MAX_BRW_SIZE PTLRPC_MAX_BRW_SIZE
107 #define DT_DEF_BRW_SIZE (4 * ONE_MB_BRW_SIZE)
108 #define DT_MAX_BRW_PAGES (DT_MAX_BRW_SIZE >> PAGE_SHIFT)
109 #define OFD_MAX_BRW_SIZE (1U << LNET_MTU_BITS)
111 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
112 #if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
113 # error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
115 #if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * PAGE_SIZE))
116 # error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * PAGE_SIZE"
118 #if (PTLRPC_MAX_BRW_SIZE > LNET_MTU * PTLRPC_BULK_OPS_COUNT)
119 # error "PTLRPC_MAX_BRW_SIZE too big"
121 #if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV * PTLRPC_BULK_OPS_COUNT)
122 # error "PTLRPC_MAX_BRW_PAGES too big"
125 #define PTLRPC_NTHRS_INIT 2
130 * Constants determine how memory is used to buffer incoming service requests.
132 * ?_NBUFS # buffers to allocate when growing the pool
133 * ?_BUFSIZE # bytes in a single request buffer
134 * ?_MAXREQSIZE # maximum request service will receive
136 * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
137 * of ?_NBUFS is added to the pool.
139 * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are
140 * considered full when less than ?_MAXREQSIZE is left in them.
145 * Constants determine how threads are created for ptlrpc service.
147 * ?_NTHRS_INIT # threads to create for each service partition on
148 * initializing. If it's non-affinity service and
149 * there is only one partition, it's the overall #
150 * threads for the service while initializing.
151 * ?_NTHRS_BASE # threads should be created at least for each
152 * ptlrpc partition to keep the service healthy.
153 * It's the low-water mark of threads upper-limit
154 * for each partition.
155 * ?_THR_FACTOR # threads can be added on threads upper-limit for
156 * each CPU core. This factor is only for reference,
157 * we might decrease value of factor if number of cores
158 * per CPT is above a limit.
159 * ?_NTHRS_MAX # overall threads can be created for a service,
160 * it's a soft limit because if service is running
161 * on machine with hundreds of cores and tens of
162 * CPU partitions, we need to guarantee each partition
163 * has ?_NTHRS_BASE threads, which means total threads
164 * will be ?_NTHRS_BASE * number_of_cpts which can
165 * exceed ?_NTHRS_MAX.
169 * #define MDS_NTHRS_INIT 2
170 * #define MDS_NTHRS_BASE 64
171 * #define MDS_NTHRS_FACTOR 8
172 * #define MDS_NTHRS_MAX 1024
175 * ---------------------------------------------------------------------
176 * Server(A) has 16 cores, user configured it to 4 partitions so each
177 * partition has 4 cores, then actual number of service threads on each
179 * MDS_NTHRS_BASE(64) + cores(4) * MDS_NTHRS_FACTOR(8) = 96
181 * Total number of threads for the service is:
182 * 96 * partitions(4) = 384
185 * ---------------------------------------------------------------------
186 * Server(B) has 32 cores, user configured it to 4 partitions so each
187 * partition has 8 cores, then actual number of service threads on each
189 * MDS_NTHRS_BASE(64) + cores(8) * MDS_NTHRS_FACTOR(8) = 128
191 * Total number of threads for the service is:
192 * 128 * partitions(4) = 512
195 * ---------------------------------------------------------------------
196 * Server(B) has 96 cores, user configured it to 8 partitions so each
197 * partition has 12 cores, then actual number of service threads on each
199 * MDS_NTHRS_BASE(64) + cores(12) * MDS_NTHRS_FACTOR(8) = 160
201 * Total number of threads for the service is:
202 * 160 * partitions(8) = 1280
204 * However, it's above the soft limit MDS_NTHRS_MAX, so we choose this number
205 * as upper limit of threads number for each partition:
206 * MDS_NTHRS_MAX(1024) / partitions(8) = 128
209 * ---------------------------------------------------------------------
210 * Server(C) have a thousand of cores and user configured it to 32 partitions
211 * MDS_NTHRS_BASE(64) * 32 = 2048
213 * which is already above soft limit MDS_NTHRS_MAX(1024), but we still need
214 * to guarantee that each partition has at least MDS_NTHRS_BASE(64) threads
215 * to keep service healthy, so total number of threads will just be 2048.
217 * NB: we don't suggest to choose server with that many cores because backend
218 * filesystem itself, buffer cache, or underlying network stack might
219 * have some SMP scalability issues at that large scale.
221 * If user already has a fat machine with hundreds or thousands of cores,
222 * there are two choices for configuration:
223 * a) create CPU table from subset of all CPUs and run Lustre on
225 * b) bind service threads on a few partitions, see modparameters of
226 * MDS and OSS for details
228 * NB: these calculations (and examples below) are simplified to help
229 * understanding, the real implementation is a little more complex,
230 * please see ptlrpc_server_nthreads_check() for details.
235 * LDLM threads constants:
237 * Given 8 as factor and 24 as base threads number
240 * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
243 * On 8-core machine with 2 partitions we will have 24 + 4 * 8 = 56
244 * threads for each partition and total threads number will be 112.
247 * On 64-core machine with 8 partitions we will need LDLM_NTHRS_BASE(24)
248 * threads for each partition to keep service healthy, so total threads
249 * number should be 24 * 8 = 192.
251 * So with these constants, threads number will be at the similar level
252 * of old versions, unless target machine has over a hundred cores
254 #define LDLM_THR_FACTOR 8
255 #define LDLM_NTHRS_INIT PTLRPC_NTHRS_INIT
256 #define LDLM_NTHRS_BASE 24
257 #define LDLM_NTHRS_MAX (num_online_cpus() == 1 ? 64 : 128)
259 #define LDLM_BL_THREADS LDLM_NTHRS_AUTO_INIT
260 #define LDLM_CLIENT_NBUFS 1
261 #define LDLM_SERVER_NBUFS 64
262 #define LDLM_BUFSIZE (8 * 1024)
263 #define LDLM_MAXREQSIZE (5 * 1024)
264 #define LDLM_MAXREPSIZE (1024)
267 * MDS threads constants:
269 * Please see examples in "Thread Constants", MDS threads number will be at
270 * the comparable level of old versions, unless the server has many cores.
272 #ifndef MDS_MAX_THREADS
273 #define MDS_MAX_THREADS 1024
274 #define MDS_MAX_OTHR_THREADS 256
276 #else /* MDS_MAX_THREADS */
277 #if MDS_MAX_THREADS < PTLRPC_NTHRS_INIT
278 #undef MDS_MAX_THREADS
279 #define MDS_MAX_THREADS PTLRPC_NTHRS_INIT
281 #define MDS_MAX_OTHR_THREADS max(PTLRPC_NTHRS_INIT, MDS_MAX_THREADS / 2)
284 /* default service */
285 #define MDS_THR_FACTOR 8
286 #define MDS_NTHRS_INIT PTLRPC_NTHRS_INIT
287 #define MDS_NTHRS_MAX MDS_MAX_THREADS
288 #define MDS_NTHRS_BASE min(64, MDS_NTHRS_MAX)
290 /* read-page service */
291 #define MDS_RDPG_THR_FACTOR 4
292 #define MDS_RDPG_NTHRS_INIT PTLRPC_NTHRS_INIT
293 #define MDS_RDPG_NTHRS_MAX MDS_MAX_OTHR_THREADS
294 #define MDS_RDPG_NTHRS_BASE min(48, MDS_RDPG_NTHRS_MAX)
296 /* these should be removed when we remove setattr service in the future */
297 #define MDS_SETA_THR_FACTOR 4
298 #define MDS_SETA_NTHRS_INIT PTLRPC_NTHRS_INIT
299 #define MDS_SETA_NTHRS_MAX MDS_MAX_OTHR_THREADS
300 #define MDS_SETA_NTHRS_BASE min(48, MDS_SETA_NTHRS_MAX)
302 /* non-affinity threads */
303 #define MDS_OTHR_NTHRS_INIT PTLRPC_NTHRS_INIT
304 #define MDS_OTHR_NTHRS_MAX MDS_MAX_OTHR_THREADS
309 * Assume file name length = FNAME_MAX = 256 (true for ext3).
310 * path name length = PATH_MAX = 4096
311 * LOV MD size max = EA_MAX = 24 * 2000
312 * (NB: 24 is size of lov_ost_data)
313 * LOV LOGCOOKIE size max = 32 * 2000
314 * (NB: 32 is size of llog_cookie)
315 * symlink: FNAME_MAX + PATH_MAX <- largest
316 * link: FNAME_MAX + PATH_MAX (mds_rec_link < mds_rec_create)
317 * rename: FNAME_MAX + FNAME_MAX
318 * open: FNAME_MAX + EA_MAX
320 * MDS_MAXREQSIZE ~= 4736 bytes =
321 * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
322 * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
324 * Realistic size is about 512 bytes (20 character name + 128 char symlink),
325 * except in the open case where there are a large number of OSTs in a LOV.
327 #define MDS_MAXREQSIZE (5 * 1024) /* >= 4736 */
328 #define MDS_MAXREPSIZE (9 * 1024) /* >= 8300 */
331 * MDS incoming request with LOV EA
332 * 24 = sizeof(struct lov_ost_data), i.e: replay of opencreate
334 #define MDS_LOV_MAXREQSIZE max(MDS_MAXREQSIZE, \
335 362 + LOV_MAX_STRIPE_COUNT * 24)
337 * MDS outgoing reply with LOV EA
339 * NB: max reply size Lustre 2.4+ client can get from old MDS is:
340 * LOV_MAX_STRIPE_COUNT * (llog_cookie + lov_ost_data) + extra bytes
342 * but 2.4 or later MDS will never send reply with llog_cookie to any
343 * version client. This macro is defined for server side reply buffer size.
345 #define MDS_LOV_MAXREPSIZE MDS_LOV_MAXREQSIZE
348 * This is the size of a maximum REINT_SETXATTR request:
350 * lustre_msg 56 (32 + 4 x 5 + 4)
352 * mdt_rec_setxattr 136
354 * name 256 (XATTR_NAME_MAX)
355 * value 65536 (XATTR_SIZE_MAX)
357 #define MDS_EA_MAXREQSIZE 66288
360 * These are the maximum request and reply sizes (rounded up to 1 KB
361 * boundaries) for the "regular" MDS_REQUEST_PORTAL and MDS_REPLY_PORTAL.
363 #define MDS_REG_MAXREQSIZE (((max(MDS_EA_MAXREQSIZE, \
364 MDS_LOV_MAXREQSIZE) + 1023) >> 10) << 10)
365 #define MDS_REG_MAXREPSIZE MDS_REG_MAXREQSIZE
368 * The update request includes all of updates from the create, which might
369 * include linkea (4K maxim), together with other updates, we set it to 1000K:
370 * lustre_msg + ptlrpc_body + OUT_UPDATE_BUFFER_SIZE_MAX
372 #define OUT_MAXREQSIZE (1000 * 1024)
373 #define OUT_MAXREPSIZE MDS_MAXREPSIZE
375 /** MDS_BUFSIZE = max_reqsize (w/o LOV EA) + max sptlrpc payload size */
376 #define MDS_BUFSIZE max(MDS_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
380 * MDS_REG_BUFSIZE should at least be MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD.
381 * However, we need to allocate a much larger buffer for it because LNet
382 * requires each MD(rqbd) has at least MDS_REQ_MAXREQSIZE bytes left to avoid
383 * dropping of maximum-sized incoming request. So if MDS_REG_BUFSIZE is only a
384 * little larger than MDS_REG_MAXREQSIZE, then it can only fit in one request
385 * even there are about MDS_REG_MAX_REQSIZE bytes left in a rqbd, and memory
386 * utilization is very low.
388 * In the meanwhile, size of rqbd can't be too large, because rqbd can't be
389 * reused until all requests fit in it have been processed and released,
390 * which means one long blocked request can prevent the rqbd be reused.
391 * Now we set request buffer size to 160 KB, so even each rqbd is unlinked
392 * from LNet with unused 65 KB, buffer utilization will be about 59%.
393 * Please check LU-2432 for details.
395 #define MDS_REG_BUFSIZE max(MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
399 * OUT_BUFSIZE = max_out_reqsize + max sptlrpc payload (~1K) which is
400 * about 10K, for the same reason as MDS_REG_BUFSIZE, we also give some
401 * extra bytes to each request buffer to improve buffer utilization rate.
403 #define OUT_BUFSIZE max(OUT_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
406 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
407 #define FLD_MAXREQSIZE (160)
409 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
410 #define FLD_MAXREPSIZE (152)
411 #define FLD_BUFSIZE (1 << 12)
414 * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
416 #define SEQ_MAXREQSIZE (160)
418 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
419 #define SEQ_MAXREPSIZE (152)
420 #define SEQ_BUFSIZE (1 << 12)
422 /** MGS threads must be >= 3, see bug 22458 comment #28 */
423 #define MGS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
424 #define MGS_NTHRS_MAX 32
427 #define MGS_BUFSIZE (8 * 1024)
428 #define MGS_MAXREQSIZE (7 * 1024)
429 #define MGS_MAXREPSIZE (9 * 1024)
432 * OSS threads constants:
434 * Given 8 as factor and 64 as base threads number
437 * On 8-core server configured to 2 partitions, we will have
438 * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
441 * On 32-core machine configured to 4 partitions, we will have
442 * 64 + 8 * 8 = 112 threads for each partition, so total threads number
443 * will be 112 * 4 = 448.
446 * On 64-core machine configured to 4 partitions, we will have
447 * 64 + 16 * 8 = 192 threads for each partition, so total threads number
448 * will be 192 * 4 = 768 which is above limit OSS_NTHRS_MAX(512), so we
449 * cut off the value to OSS_NTHRS_MAX(512) / 4 which is 128 threads
450 * for each partition.
452 * So we can see that with these constants, threads number wil be at the
453 * similar level of old versions, unless the server has many cores.
455 /* depress threads factor for VM with small memory size */
456 #define OSS_THR_FACTOR min_t(int, 8, \
457 NUM_CACHEPAGES >> (28 - PAGE_SHIFT))
458 #define OSS_NTHRS_INIT (PTLRPC_NTHRS_INIT + 1)
459 #define OSS_NTHRS_BASE 64
461 /* threads for handling "create" request */
462 #define OSS_CR_THR_FACTOR 1
463 #define OSS_CR_NTHRS_INIT PTLRPC_NTHRS_INIT
464 #define OSS_CR_NTHRS_BASE 8
465 #define OSS_CR_NTHRS_MAX 64
468 * OST_IO_MAXREQSIZE ~=
469 * lustre_msg + ptlrpc_body + obdo + obd_ioobj +
470 * DT_MAX_BRW_PAGES * niobuf_remote
472 * - single object with 16 pages is 512 bytes
473 * - OST_IO_MAXREQSIZE must be at least 1 page of cookies plus some spillover
474 * - Must be a multiple of 1024
476 #define _OST_MAXREQSIZE_BASE (sizeof(struct lustre_msg) + \
477 sizeof(struct ptlrpc_body) + \
478 sizeof(struct obdo) + \
479 sizeof(struct obd_ioobj) + \
480 sizeof(struct niobuf_remote))
481 #define _OST_MAXREQSIZE_SUM (_OST_MAXREQSIZE_BASE + \
482 sizeof(struct niobuf_remote) * \
483 (DT_MAX_BRW_PAGES - 1))
485 * FIEMAP request can be 4K+ for now
487 #define OST_MAXREQSIZE (16 * 1024)
488 #define OST_IO_MAXREQSIZE max_t(int, OST_MAXREQSIZE, \
489 (((_OST_MAXREQSIZE_SUM - 1) | (1024 - 1)) + 1))
490 /* Safe estimate of free space in standard RPC, provides upper limit for # of
491 * bytes of i/o to pack in RPC (skipping bulk transfer). */
492 #define OST_SHORT_IO_SPACE (OST_IO_MAXREQSIZE - _OST_MAXREQSIZE_BASE)
494 /* Actual size used for short i/o buffer. Calculation means this:
495 * At least one page (for large PAGE_SIZE), or 16 KiB, but not more
496 * than the available space aligned to a page boundary. */
497 #define OBD_MAX_SHORT_IO_BYTES (min(max(PAGE_SIZE, 16UL * 1024UL), \
498 OST_SHORT_IO_SPACE & PAGE_MASK))
500 #define OST_MAXREPSIZE (9 * 1024)
501 #define OST_IO_MAXREPSIZE OST_MAXREPSIZE
504 /** OST_BUFSIZE = max_reqsize + max sptlrpc payload size */
505 #define OST_BUFSIZE max_t(int, OST_MAXREQSIZE + 1024, 16 * 1024)
507 * OST_IO_MAXREQSIZE is 18K, giving extra 46K can increase buffer utilization
508 * rate of request buffer, please check comment of MDS_LOV_BUFSIZE for details.
510 #define OST_IO_BUFSIZE max_t(int, OST_IO_MAXREQSIZE + 1024, 64 * 1024)
513 /* Macro to hide a typecast. */
514 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
516 struct ptlrpc_replay_async_args {
522 * Structure to single define portal connection.
524 struct ptlrpc_connection {
525 /** linkage for connections hash table */
526 struct hlist_node c_hash;
527 /** Our own lnet nid for this connection */
529 /** Remote side nid for this connection */
530 struct lnet_process_id c_peer;
531 /** UUID of the other side */
532 struct obd_uuid c_remote_uuid;
533 /** reference counter for this connection */
537 /** Client definition for PortalRPC */
538 struct ptlrpc_client {
539 /** What lnet portal does this client send messages to by default */
540 __u32 cli_request_portal;
541 /** What portal do we expect replies on */
542 __u32 cli_reply_portal;
543 /** Name of the client */
547 /** state flags of requests */
548 /* XXX only ones left are those used by the bulk descs as well! */
549 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
550 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
552 #define REQ_MAX_ACK_LOCKS 8
554 union ptlrpc_async_args {
556 * Scratchpad for passing args to completion interpreter. Users
557 * cast to the struct of their choosing, and CLASSERT that this is
558 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
559 * a pointer to it here. The pointer_arg ensures this struct is at
560 * least big enough for that.
562 void *pointer_arg[11];
566 struct ptlrpc_request_set;
567 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
570 * Definition of request set structure.
571 * Request set is a list of requests (not necessary to the same target) that
572 * once populated with RPCs could be sent in parallel.
573 * There are two kinds of request sets. General purpose and with dedicated
574 * serving thread. Example of the latter is ptlrpcd set.
575 * For general purpose sets once request set started sending it is impossible
576 * to add new requests to such set.
577 * Provides a way to call "completion callbacks" when all requests in the set
580 struct ptlrpc_request_set {
581 atomic_t set_refcount;
582 /** number of in queue requests */
583 atomic_t set_new_count;
584 /** number of uncompleted requests */
585 atomic_t set_remaining;
586 /** wait queue to wait on for request events */
587 wait_queue_head_t set_waitq;
588 /** List of requests in the set */
589 struct list_head set_requests;
591 * Lock for \a set_new_requests manipulations
592 * locked so that any old caller can communicate requests to
593 * the set holder who can then fold them into the lock-free set
595 spinlock_t set_new_req_lock;
596 /** List of new yet unsent requests. Only used with ptlrpcd now. */
597 struct list_head set_new_requests;
599 /** rq_status of requests that have been freed already */
601 /** Additional fields used by the flow control extension */
602 /** Maximum number of RPCs in flight */
603 int set_max_inflight;
604 /** Callback function used to generate RPCs */
605 set_producer_func set_producer;
606 /** opaq argument passed to the producer callback */
607 void *set_producer_arg;
608 unsigned int set_allow_intr:1;
611 struct ptlrpc_bulk_desc;
612 struct ptlrpc_service_part;
613 struct ptlrpc_service;
616 * ptlrpc callback & work item stuff
618 struct ptlrpc_cb_id {
619 void (*cbid_fn)(struct lnet_event *ev); /* specific callback fn */
620 void *cbid_arg; /* additional arg */
623 /** Maximum number of locks to fit into reply state */
624 #define RS_MAX_LOCKS 8
628 * Structure to define reply state on the server
629 * Reply state holds various reply message information. Also for "difficult"
630 * replies (rep-ack case) we store the state after sending reply and wait
631 * for the client to acknowledge the reception. In these cases locks could be
632 * added to the state for replay/failover consistency guarantees.
634 struct ptlrpc_reply_state {
635 /** Callback description */
636 struct ptlrpc_cb_id rs_cb_id;
637 /** Linkage for list of all reply states in a system */
638 struct list_head rs_list;
639 /** Linkage for list of all reply states on same export */
640 struct list_head rs_exp_list;
641 /** Linkage for list of all reply states for same obd */
642 struct list_head rs_obd_list;
644 struct list_head rs_debug_list;
646 /** A spinlock to protect the reply state flags */
648 /** Reply state flags */
649 unsigned long rs_difficult:1; /* ACK/commit stuff */
650 unsigned long rs_no_ack:1; /* no ACK, even for
651 difficult requests */
652 unsigned long rs_scheduled:1; /* being handled? */
653 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
654 unsigned long rs_handled:1; /* been handled yet? */
655 unsigned long rs_on_net:1; /* reply_out_callback pending? */
656 unsigned long rs_prealloc:1; /* rs from prealloc list */
657 unsigned long rs_committed:1;/* the transaction was committed
658 and the rs was dispatched
659 by ptlrpc_commit_replies */
660 unsigned long rs_convert_lock:1; /* need to convert saved
661 * locks to COS mode */
662 atomic_t rs_refcount; /* number of users */
663 /** Number of locks awaiting client ACK */
666 /** Size of the state */
670 /** Transaction number */
674 struct obd_export *rs_export;
675 struct ptlrpc_service_part *rs_svcpt;
676 /** Lnet metadata handle for the reply */
677 struct lnet_handle_md rs_md_h;
679 /** Context for the sevice thread */
680 struct ptlrpc_svc_ctx *rs_svc_ctx;
681 /** Reply buffer (actually sent to the client), encoded if needed */
682 struct lustre_msg *rs_repbuf; /* wrapper */
683 /** Size of the reply buffer */
684 int rs_repbuf_len; /* wrapper buf length */
685 /** Size of the reply message */
686 int rs_repdata_len; /* wrapper msg length */
688 * Actual reply message. Its content is encrupted (if needed) to
689 * produce reply buffer for actual sending. In simple case
690 * of no network encryption we jus set \a rs_repbuf to \a rs_msg
692 struct lustre_msg *rs_msg; /* reply message */
694 /** Handles of locks awaiting client reply ACK */
695 struct lustre_handle rs_locks[RS_MAX_LOCKS];
696 /** Lock modes of locks in \a rs_locks */
697 enum ldlm_mode rs_modes[RS_MAX_LOCKS];
700 struct ptlrpc_thread;
704 RQ_PHASE_NEW = 0xebc0de00,
705 RQ_PHASE_RPC = 0xebc0de01,
706 RQ_PHASE_BULK = 0xebc0de02,
707 RQ_PHASE_INTERPRET = 0xebc0de03,
708 RQ_PHASE_COMPLETE = 0xebc0de04,
709 RQ_PHASE_UNREG_RPC = 0xebc0de05,
710 RQ_PHASE_UNREG_BULK = 0xebc0de06,
711 RQ_PHASE_UNDEFINED = 0xebc0de07
714 /** Type of request interpreter call-back */
715 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
716 struct ptlrpc_request *req,
718 /** Type of request resend call-back */
719 typedef void (*ptlrpc_resend_cb_t)(struct ptlrpc_request *req,
723 * Definition of request pool structure.
724 * The pool is used to store empty preallocated requests for the case
725 * when we would actually need to send something without performing
726 * any allocations (to avoid e.g. OOM).
728 struct ptlrpc_request_pool {
729 /** Locks the list */
731 /** list of ptlrpc_request structs */
732 struct list_head prp_req_list;
733 /** Maximum message size that would fit into a rquest from this pool */
735 /** Function to allocate more requests for this pool */
736 int (*prp_populate)(struct ptlrpc_request_pool *, int);
744 #include <lustre_nrs.h>
747 * Basic request prioritization operations structure.
748 * The whole idea is centered around locks and RPCs that might affect locks.
749 * When a lock is contended we try to give priority to RPCs that might lead
750 * to fastest release of that lock.
751 * Currently only implemented for OSTs only in a way that makes all
752 * IO and truncate RPCs that are coming from a locked region where a lock is
753 * contended a priority over other requests.
755 struct ptlrpc_hpreq_ops {
757 * Check if the lock handle of the given lock is the same as
758 * taken from the request.
760 int (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
762 * Check if the request is a high priority one.
764 int (*hpreq_check)(struct ptlrpc_request *);
766 * Called after the request has been handled.
768 void (*hpreq_fini)(struct ptlrpc_request *);
771 struct ptlrpc_cli_req {
772 /** For bulk requests on client only: bulk descriptor */
773 struct ptlrpc_bulk_desc *cr_bulk;
774 /** optional time limit for send attempts */
775 time64_t cr_delay_limit;
776 /** time request was first queued */
777 time64_t cr_queued_time;
778 /** request sent in nanoseconds */
780 /** time for request really sent out */
781 time64_t cr_sent_out;
782 /** when req reply unlink must finish. */
783 time64_t cr_reply_deadline;
784 /** when req bulk unlink must finish. */
785 time64_t cr_bulk_deadline;
786 /** when req unlink must finish. */
787 time64_t cr_req_deadline;
788 /** Portal to which this request would be sent */
790 /** Portal where to wait for reply and where reply would be sent */
792 /** request resending number */
793 unsigned int cr_resend_nr;
794 /** What was import generation when this request was sent */
796 enum lustre_imp_state cr_send_state;
797 /** Per-request waitq introduced by bug 21938 for recovery waiting */
798 wait_queue_head_t cr_set_waitq;
799 /** Link item for request set lists */
800 struct list_head cr_set_chain;
801 /** link to waited ctx */
802 struct list_head cr_ctx_chain;
804 /** client's half ctx */
805 struct ptlrpc_cli_ctx *cr_cli_ctx;
806 /** Link back to the request set */
807 struct ptlrpc_request_set *cr_set;
808 /** outgoing request MD handle */
809 struct lnet_handle_md cr_req_md_h;
810 /** request-out callback parameter */
811 struct ptlrpc_cb_id cr_req_cbid;
812 /** incoming reply MD handle */
813 struct lnet_handle_md cr_reply_md_h;
814 wait_queue_head_t cr_reply_waitq;
815 /** reply callback parameter */
816 struct ptlrpc_cb_id cr_reply_cbid;
817 /** Async completion handler, called when reply is received */
818 ptlrpc_interpterer_t cr_reply_interp;
819 /** Resend handler, called when request is resend to update RPC data */
820 ptlrpc_resend_cb_t cr_resend_cb;
821 /** Async completion context */
822 union ptlrpc_async_args cr_async_args;
823 /** Opaq data for replay and commit callbacks. */
825 /** Link to the imp->imp_unreplied_list */
826 struct list_head cr_unreplied_list;
828 * Commit callback, called when request is committed and about to be
831 void (*cr_commit_cb)(struct ptlrpc_request *);
832 /** Replay callback, called after request is replayed at recovery */
833 void (*cr_replay_cb)(struct ptlrpc_request *);
836 /** client request member alias */
837 /* NB: these alias should NOT be used by any new code, instead they should
838 * be removed step by step to avoid potential abuse */
839 #define rq_bulk rq_cli.cr_bulk
840 #define rq_delay_limit rq_cli.cr_delay_limit
841 #define rq_queued_time rq_cli.cr_queued_time
842 #define rq_sent_ns rq_cli.cr_sent_ns
843 #define rq_real_sent rq_cli.cr_sent_out
844 #define rq_reply_deadline rq_cli.cr_reply_deadline
845 #define rq_bulk_deadline rq_cli.cr_bulk_deadline
846 #define rq_req_deadline rq_cli.cr_req_deadline
847 #define rq_nr_resend rq_cli.cr_resend_nr
848 #define rq_request_portal rq_cli.cr_req_ptl
849 #define rq_reply_portal rq_cli.cr_rep_ptl
850 #define rq_import_generation rq_cli.cr_imp_gen
851 #define rq_send_state rq_cli.cr_send_state
852 #define rq_set_chain rq_cli.cr_set_chain
853 #define rq_ctx_chain rq_cli.cr_ctx_chain
854 #define rq_set rq_cli.cr_set
855 #define rq_set_waitq rq_cli.cr_set_waitq
856 #define rq_cli_ctx rq_cli.cr_cli_ctx
857 #define rq_req_md_h rq_cli.cr_req_md_h
858 #define rq_req_cbid rq_cli.cr_req_cbid
859 #define rq_reply_md_h rq_cli.cr_reply_md_h
860 #define rq_reply_waitq rq_cli.cr_reply_waitq
861 #define rq_reply_cbid rq_cli.cr_reply_cbid
862 #define rq_interpret_reply rq_cli.cr_reply_interp
863 #define rq_resend_cb rq_cli.cr_resend_cb
864 #define rq_async_args rq_cli.cr_async_args
865 #define rq_cb_data rq_cli.cr_cb_data
866 #define rq_unreplied_list rq_cli.cr_unreplied_list
867 #define rq_commit_cb rq_cli.cr_commit_cb
868 #define rq_replay_cb rq_cli.cr_replay_cb
870 struct ptlrpc_srv_req {
871 /** initial thread servicing this request */
872 struct ptlrpc_thread *sr_svc_thread;
874 * Server side list of incoming unserved requests sorted by arrival
875 * time. Traversed from time to time to notice about to expire
876 * requests and sent back "early replies" to clients to let them
877 * know server is alive and well, just very busy to service their
880 struct list_head sr_timed_list;
881 /** server-side per-export list */
882 struct list_head sr_exp_list;
883 /** server-side history, used for debuging purposes. */
884 struct list_head sr_hist_list;
885 /** history sequence # */
887 /** the index of service's srv_at_array into which request is linked */
891 /** authed uid mapped to */
892 uid_t sr_auth_mapped_uid;
893 /** RPC is generated from what part of Lustre */
894 enum lustre_sec_part sr_sp_from;
895 /** request session context */
896 struct lu_context sr_ses;
900 /** stub for NRS request */
901 struct ptlrpc_nrs_request sr_nrq;
903 /** request arrival time */
904 struct timespec64 sr_arrival_time;
905 /** server's half ctx */
906 struct ptlrpc_svc_ctx *sr_svc_ctx;
907 /** (server side), pointed directly into req buffer */
908 struct ptlrpc_user_desc *sr_user_desc;
909 /** separated reply state, may be vmalloc'd */
910 struct ptlrpc_reply_state *sr_reply_state;
911 /** server-side hp handlers */
912 struct ptlrpc_hpreq_ops *sr_ops;
913 /** incoming request buffer */
914 struct ptlrpc_request_buffer_desc *sr_rqbd;
917 /** server request member alias */
918 /* NB: these alias should NOT be used by any new code, instead they should
919 * be removed step by step to avoid potential abuse */
920 #define rq_svc_thread rq_srv.sr_svc_thread
921 #define rq_timed_list rq_srv.sr_timed_list
922 #define rq_exp_list rq_srv.sr_exp_list
923 #define rq_history_list rq_srv.sr_hist_list
924 #define rq_history_seq rq_srv.sr_hist_seq
925 #define rq_at_index rq_srv.sr_at_index
926 #define rq_auth_uid rq_srv.sr_auth_uid
927 #define rq_auth_mapped_uid rq_srv.sr_auth_mapped_uid
928 #define rq_sp_from rq_srv.sr_sp_from
929 #define rq_session rq_srv.sr_ses
930 #define rq_nrq rq_srv.sr_nrq
931 #define rq_arrival_time rq_srv.sr_arrival_time
932 #define rq_reply_state rq_srv.sr_reply_state
933 #define rq_svc_ctx rq_srv.sr_svc_ctx
934 #define rq_user_desc rq_srv.sr_user_desc
935 #define rq_ops rq_srv.sr_ops
936 #define rq_rqbd rq_srv.sr_rqbd
939 * Represents remote procedure call.
941 * This is a staple structure used by everybody wanting to send a request
944 struct ptlrpc_request {
945 /* Request type: one of PTL_RPC_MSG_* */
947 /** Result of request processing */
950 * Linkage item through which this request is included into
951 * sending/delayed lists on client and into rqbd list on server
953 struct list_head rq_list;
954 /** Lock to protect request flags and some other important bits, like
958 spinlock_t rq_early_free_lock;
959 /** client-side flags are serialized by rq_lock @{ */
960 unsigned int rq_intr:1, rq_replied:1, rq_err:1,
961 rq_timedout:1, rq_resend:1, rq_restart:1,
963 * when ->rq_replay is set, request is kept by the client even
964 * after server commits corresponding transaction. This is
965 * used for operations that require sequence of multiple
966 * requests to be replayed. The only example currently is file
967 * open/close. When last request in such a sequence is
968 * committed, ->rq_replay is cleared on all requests in the
972 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
973 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
975 rq_req_unlinked:1, /* unlinked request buffer from lnet */
976 rq_reply_unlinked:1, /* unlinked reply buffer from lnet */
977 rq_memalloc:1, /* req originated from "kswapd" */
979 rq_reply_truncated:1,
980 /** whether the "rq_set" is a valid one */
983 /** do not resend request on -EINPROGRESS */
984 rq_no_retry_einprogress:1,
985 /* allow the req to be sent if the import is in recovery
988 /* bulk request, sent to server, but uncommitted */
990 rq_early_free_repbuf:1, /* free reply buffer in advance */
994 /** server-side flags @{ */
996 rq_hp:1, /**< high priority RPC */
997 rq_at_linked:1, /**< link into service's srv_at_array */
998 rq_packed_final:1; /**< packed final reply */
1001 /** one of RQ_PHASE_* */
1002 enum rq_phase rq_phase;
1003 /** one of RQ_PHASE_* to be used next */
1004 enum rq_phase rq_next_phase;
1006 * client-side refcount for SENT race, server-side refcounf
1007 * for multiple replies
1009 atomic_t rq_refcount;
1012 * !rq_truncate : # reply bytes actually received,
1013 * rq_truncate : required repbuf_len for resend
1015 int rq_nob_received;
1016 /** Request length */
1020 /** Pool if request is from preallocated list */
1021 struct ptlrpc_request_pool *rq_pool;
1022 /** Request message - what client sent */
1023 struct lustre_msg *rq_reqmsg;
1024 /** Reply message - server response */
1025 struct lustre_msg *rq_repmsg;
1026 /** Transaction number */
1030 /** bulk match bits */
1033 * List item to for replay list. Not yet committed requests get linked
1035 * Also see \a rq_replay comment above.
1036 * It's also link chain on obd_export::exp_req_replay_queue
1038 struct list_head rq_replay_list;
1039 /** non-shared members for client & server request*/
1041 struct ptlrpc_cli_req rq_cli;
1042 struct ptlrpc_srv_req rq_srv;
1045 * security and encryption data
1047 /** description of flavors for client & server */
1048 struct sptlrpc_flavor rq_flvr;
1050 /* client/server security flags */
1052 rq_ctx_init:1, /* context initiation */
1053 rq_ctx_fini:1, /* context destroy */
1054 rq_bulk_read:1, /* request bulk read */
1055 rq_bulk_write:1, /* request bulk write */
1056 /* server authentication flags */
1057 rq_auth_gss:1, /* authenticated by gss */
1058 rq_auth_usr_root:1, /* authed as root */
1059 rq_auth_usr_mdt:1, /* authed as mdt */
1060 rq_auth_usr_ost:1, /* authed as ost */
1061 /* security tfm flags */
1064 /* doesn't expect reply FIXME */
1066 rq_pill_init:1, /* pill initialized */
1067 rq_srv_req:1; /* server request */
1070 /** various buffer pointers */
1071 struct lustre_msg *rq_reqbuf; /**< req wrapper, vmalloc*/
1072 char *rq_repbuf; /**< rep buffer, vmalloc */
1073 struct lustre_msg *rq_repdata; /**< rep wrapper msg */
1074 /** only in priv mode */
1075 struct lustre_msg *rq_clrbuf;
1076 int rq_reqbuf_len; /* req wrapper buf len */
1077 int rq_reqdata_len; /* req wrapper msg len */
1078 int rq_repbuf_len; /* rep buffer len */
1079 int rq_repdata_len; /* rep wrapper msg len */
1080 int rq_clrbuf_len; /* only in priv mode */
1081 int rq_clrdata_len; /* only in priv mode */
1083 /** early replies go to offset 0, regular replies go after that */
1084 unsigned int rq_reply_off;
1087 /** Fields that help to see if request and reply were swabbed or not */
1088 __u32 rq_req_swab_mask;
1089 __u32 rq_rep_swab_mask;
1091 /** how many early replies (for stats) */
1093 /** Server-side, export on which request was received */
1094 struct obd_export *rq_export;
1095 /** import where request is being sent */
1096 struct obd_import *rq_import;
1099 /** Peer description (the other side) */
1100 struct lnet_process_id rq_peer;
1101 /** Descriptor for the NID from which the peer sent the request. */
1102 struct lnet_process_id rq_source;
1104 * service time estimate (secs)
1105 * If the request is not served by this time, it is marked as timed out.
1106 * Do not change to time64_t since this is transmitted over the wire.
1110 * when request/reply sent (secs), or time when request should be sent
1113 /** when request must finish. */
1114 time64_t rq_deadline;
1115 /** request format description */
1116 struct req_capsule rq_pill;
1120 * Call completion handler for rpc if any, return it's status or original
1121 * rc if there was no handler defined for this request.
1123 static inline int ptlrpc_req_interpret(const struct lu_env *env,
1124 struct ptlrpc_request *req, int rc)
1126 if (req->rq_interpret_reply != NULL) {
1127 req->rq_status = req->rq_interpret_reply(env, req,
1128 &req->rq_async_args,
1130 return req->rq_status;
1138 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
1139 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
1140 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
1141 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
1142 struct ptlrpc_nrs_pol_info *info);
1145 * Can the request be moved from the regular NRS head to the high-priority NRS
1146 * head (of the same PTLRPC service partition), if any?
1148 * For a reliable result, this should be checked under svcpt->scp_req lock.
1150 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
1152 struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
1155 * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
1156 * request has been enqueued first, and ptlrpc_nrs_request::nr_started
1157 * to make sure it has not been scheduled yet (analogous to previous
1158 * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
1160 return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
1165 * Returns 1 if request buffer at offset \a index was already swabbed
1167 static inline int lustre_req_swabbed(struct ptlrpc_request *req, size_t index)
1169 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1170 return req->rq_req_swab_mask & (1 << index);
1174 * Returns 1 if request reply buffer at offset \a index was already swabbed
1176 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, size_t index)
1178 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1179 return req->rq_rep_swab_mask & (1 << index);
1183 * Returns 1 if request needs to be swabbed into local cpu byteorder
1185 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
1187 return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1191 * Returns 1 if request reply needs to be swabbed into local cpu byteorder
1193 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
1195 return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1199 * Mark request buffer at offset \a index that it was already swabbed
1201 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req,
1204 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1205 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
1206 req->rq_req_swab_mask |= 1 << index;
1210 * Mark request reply buffer at offset \a index that it was already swabbed
1212 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req,
1215 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1216 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
1217 req->rq_rep_swab_mask |= 1 << index;
1221 * Convert numerical request phase value \a phase into text string description
1223 static inline const char *
1224 ptlrpc_phase2str(enum rq_phase phase)
1233 case RQ_PHASE_INTERPRET:
1235 case RQ_PHASE_COMPLETE:
1237 case RQ_PHASE_UNREG_RPC:
1239 case RQ_PHASE_UNREG_BULK:
1247 * Convert numerical request phase of the request \a req into text stringi
1250 static inline const char *
1251 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1253 return ptlrpc_phase2str(req->rq_phase);
1257 * Debugging functions and helpers to print request structure into debug log
1260 /* Spare the preprocessor, spoil the bugs. */
1261 #define FLAG(field, str) (field ? str : "")
1263 /** Convert bit flags into a string */
1264 #define DEBUG_REQ_FLAGS(req) \
1265 ptlrpc_rqphase2str(req), \
1266 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
1267 FLAG(req->rq_err, "E"), FLAG(req->rq_net_err, "e"), \
1268 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
1269 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
1270 FLAG(req->rq_no_resend, "N"), \
1271 FLAG(req->rq_waiting, "W"), \
1272 FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \
1273 FLAG(req->rq_committed, "M")
1275 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s%s"
1277 void _debug_req(struct ptlrpc_request *req,
1278 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1279 __attribute__ ((format (printf, 3, 4)));
1282 * Helper that decides if we need to print request accordig to current debug
1285 #define debug_req(msgdata, mask, cdls, req, fmt, a...) \
1287 CFS_CHECK_STACK(msgdata, mask, cdls); \
1289 if (((mask) & D_CANTMASK) != 0 || \
1290 ((libcfs_debug & (mask)) != 0 && \
1291 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1292 _debug_req((req), msgdata, fmt, ##a); \
1296 * This is the debug print function you need to use to print request sturucture
1297 * content into lustre debug log.
1298 * for most callers (level is a constant) this is resolved at compile time */
1299 #define DEBUG_REQ(level, req, fmt, args...) \
1301 if ((level) & (D_ERROR | D_WARNING)) { \
1302 static struct cfs_debug_limit_state cdls; \
1303 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1304 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1306 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1307 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
1313 * Structure that defines a single page of a bulk transfer
1315 struct ptlrpc_bulk_page {
1316 /** Linkage to list of pages in a bulk */
1317 struct list_head bp_link;
1319 * Number of bytes in a page to transfer starting from \a bp_pageoffset
1322 /** offset within a page */
1324 /** The page itself */
1325 struct page *bp_page;
1328 enum ptlrpc_bulk_op_type {
1329 PTLRPC_BULK_OP_ACTIVE = 0x00000001,
1330 PTLRPC_BULK_OP_PASSIVE = 0x00000002,
1331 PTLRPC_BULK_OP_PUT = 0x00000004,
1332 PTLRPC_BULK_OP_GET = 0x00000008,
1333 PTLRPC_BULK_BUF_KVEC = 0x00000010,
1334 PTLRPC_BULK_BUF_KIOV = 0x00000020,
1335 PTLRPC_BULK_GET_SOURCE = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_GET,
1336 PTLRPC_BULK_PUT_SINK = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_PUT,
1337 PTLRPC_BULK_GET_SINK = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_GET,
1338 PTLRPC_BULK_PUT_SOURCE = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_PUT,
1341 static inline bool ptlrpc_is_bulk_op_get(enum ptlrpc_bulk_op_type type)
1343 return (type & PTLRPC_BULK_OP_GET) == PTLRPC_BULK_OP_GET;
1346 static inline bool ptlrpc_is_bulk_get_source(enum ptlrpc_bulk_op_type type)
1348 return (type & PTLRPC_BULK_GET_SOURCE) == PTLRPC_BULK_GET_SOURCE;
1351 static inline bool ptlrpc_is_bulk_put_sink(enum ptlrpc_bulk_op_type type)
1353 return (type & PTLRPC_BULK_PUT_SINK) == PTLRPC_BULK_PUT_SINK;
1356 static inline bool ptlrpc_is_bulk_get_sink(enum ptlrpc_bulk_op_type type)
1358 return (type & PTLRPC_BULK_GET_SINK) == PTLRPC_BULK_GET_SINK;
1361 static inline bool ptlrpc_is_bulk_put_source(enum ptlrpc_bulk_op_type type)
1363 return (type & PTLRPC_BULK_PUT_SOURCE) == PTLRPC_BULK_PUT_SOURCE;
1366 static inline bool ptlrpc_is_bulk_desc_kvec(enum ptlrpc_bulk_op_type type)
1368 return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1369 == PTLRPC_BULK_BUF_KVEC;
1372 static inline bool ptlrpc_is_bulk_desc_kiov(enum ptlrpc_bulk_op_type type)
1374 return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1375 == PTLRPC_BULK_BUF_KIOV;
1378 static inline bool ptlrpc_is_bulk_op_active(enum ptlrpc_bulk_op_type type)
1380 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1381 (type & PTLRPC_BULK_OP_PASSIVE))
1382 == PTLRPC_BULK_OP_ACTIVE;
1385 static inline bool ptlrpc_is_bulk_op_passive(enum ptlrpc_bulk_op_type type)
1387 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1388 (type & PTLRPC_BULK_OP_PASSIVE))
1389 == PTLRPC_BULK_OP_PASSIVE;
1392 struct ptlrpc_bulk_frag_ops {
1394 * Add a page \a page to the bulk descriptor \a desc
1395 * Data to transfer in the page starts at offset \a pageoffset and
1396 * amount of data to transfer from the page is \a len
1398 void (*add_kiov_frag)(struct ptlrpc_bulk_desc *desc,
1399 struct page *page, int pageoffset, int len);
1402 * Add a \a fragment to the bulk descriptor \a desc.
1403 * Data to transfer in the fragment is pointed to by \a frag
1404 * The size of the fragment is \a len
1406 int (*add_iov_frag)(struct ptlrpc_bulk_desc *desc, void *frag, int len);
1409 * Uninitialize and free bulk descriptor \a desc.
1410 * Works on bulk descriptors both from server and client side.
1412 void (*release_frags)(struct ptlrpc_bulk_desc *desc);
1415 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops;
1416 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops;
1417 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kvec_ops;
1420 * Definition of bulk descriptor.
1421 * Bulks are special "Two phase" RPCs where initial request message
1422 * is sent first and it is followed bt a transfer (o receiving) of a large
1423 * amount of data to be settled into pages referenced from the bulk descriptors.
1424 * Bulks transfers (the actual data following the small requests) are done
1425 * on separate LNet portals.
1426 * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1427 * Another user is readpage for MDT.
1429 struct ptlrpc_bulk_desc {
1430 /** completed with failure */
1431 unsigned long bd_failure:1;
1433 unsigned long bd_registered:1;
1434 /** For serialization with callback */
1436 /** Import generation when request for this bulk was sent */
1437 int bd_import_generation;
1438 /** {put,get}{source,sink}{kvec,kiov} */
1439 enum ptlrpc_bulk_op_type bd_type;
1440 /** LNet portal for this bulk */
1442 /** Server side - export this bulk created for */
1443 struct obd_export *bd_export;
1444 /** Client side - import this bulk was sent on */
1445 struct obd_import *bd_import;
1446 /** Back pointer to the request */
1447 struct ptlrpc_request *bd_req;
1448 struct ptlrpc_bulk_frag_ops *bd_frag_ops;
1449 wait_queue_head_t bd_waitq; /* server side only WQ */
1450 int bd_iov_count; /* # entries in bd_iov */
1451 int bd_max_iov; /* allocated size of bd_iov */
1452 int bd_nob; /* # bytes covered */
1453 int bd_nob_transferred; /* # bytes GOT/PUT */
1455 __u64 bd_last_mbits;
1457 struct ptlrpc_cb_id bd_cbid; /* network callback info */
1458 lnet_nid_t bd_sender; /* stash event::sender */
1459 int bd_md_count; /* # valid entries in bd_mds */
1460 int bd_md_max_brw; /* max entries in bd_mds */
1461 /** array of associated MDs */
1462 struct lnet_handle_md bd_mds[PTLRPC_BULK_OPS_COUNT];
1467 * encrypt iov, size is either 0 or bd_iov_count.
1469 lnet_kiov_t *bd_enc_vec;
1470 lnet_kiov_t *bd_vec;
1474 struct kvec *bd_enc_kvec;
1475 struct kvec *bd_kvec;
1481 #define GET_KIOV(desc) ((desc)->bd_u.bd_kiov.bd_vec)
1482 #define BD_GET_KIOV(desc, i) ((desc)->bd_u.bd_kiov.bd_vec[i])
1483 #define GET_ENC_KIOV(desc) ((desc)->bd_u.bd_kiov.bd_enc_vec)
1484 #define BD_GET_ENC_KIOV(desc, i) ((desc)->bd_u.bd_kiov.bd_enc_vec[i])
1485 #define GET_KVEC(desc) ((desc)->bd_u.bd_kvec.bd_kvec)
1486 #define BD_GET_KVEC(desc, i) ((desc)->bd_u.bd_kvec.bd_kvec[i])
1487 #define GET_ENC_KVEC(desc) ((desc)->bd_u.bd_kvec.bd_enc_kvec)
1488 #define BD_GET_ENC_KVEC(desc, i) ((desc)->bd_u.bd_kvec.bd_enc_kvec[i])
1492 SVC_STOPPED = 1 << 0,
1493 SVC_STOPPING = 1 << 1,
1494 SVC_STARTING = 1 << 2,
1495 SVC_RUNNING = 1 << 3,
1497 SVC_SIGNAL = 1 << 5,
1500 #define PTLRPC_THR_NAME_LEN 32
1502 * Definition of server service thread structure
1504 struct ptlrpc_thread {
1506 * List of active threads in svc->srv_threads
1508 struct list_head t_link;
1510 * thread-private data (preallocated vmalloc'd memory)
1515 * service thread index, from ptlrpc_start_threads
1519 * service thread pid
1523 * put watchdog in the structure per thread b=14840
1525 struct lc_watchdog *t_watchdog;
1527 * the svc this thread belonged to b=18582
1529 struct ptlrpc_service_part *t_svcpt;
1530 wait_queue_head_t t_ctl_waitq;
1531 struct lu_env *t_env;
1532 char t_name[PTLRPC_THR_NAME_LEN];
1535 static inline int thread_is_init(struct ptlrpc_thread *thread)
1537 return thread->t_flags == 0;
1540 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1542 return !!(thread->t_flags & SVC_STOPPED);
1545 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1547 return !!(thread->t_flags & SVC_STOPPING);
1550 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1552 return !!(thread->t_flags & SVC_STARTING);
1555 static inline int thread_is_running(struct ptlrpc_thread *thread)
1557 return !!(thread->t_flags & SVC_RUNNING);
1560 static inline int thread_is_event(struct ptlrpc_thread *thread)
1562 return !!(thread->t_flags & SVC_EVENT);
1565 static inline int thread_is_signal(struct ptlrpc_thread *thread)
1567 return !!(thread->t_flags & SVC_SIGNAL);
1570 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1572 thread->t_flags &= ~flags;
1575 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1577 thread->t_flags = flags;
1580 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1582 thread->t_flags |= flags;
1585 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1588 if (thread->t_flags & flags) {
1589 thread->t_flags &= ~flags;
1596 * Request buffer descriptor structure.
1597 * This is a structure that contains one posted request buffer for service.
1598 * Once data land into a buffer, event callback creates actual request and
1599 * notifies wakes one of the service threads to process new incoming request.
1600 * More than one request can fit into the buffer.
1602 struct ptlrpc_request_buffer_desc {
1603 /** Link item for rqbds on a service */
1604 struct list_head rqbd_list;
1605 /** History of requests for this buffer */
1606 struct list_head rqbd_reqs;
1607 /** Back pointer to service for which this buffer is registered */
1608 struct ptlrpc_service_part *rqbd_svcpt;
1609 /** LNet descriptor */
1610 struct lnet_handle_md rqbd_md_h;
1612 /** The buffer itself */
1614 struct ptlrpc_cb_id rqbd_cbid;
1616 * This "embedded" request structure is only used for the
1617 * last request to fit into the buffer
1619 struct ptlrpc_request rqbd_req;
1622 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
1624 struct ptlrpc_service_ops {
1626 * if non-NULL called during thread creation (ptlrpc_start_thread())
1627 * to initialize service specific per-thread state.
1629 int (*so_thr_init)(struct ptlrpc_thread *thr);
1631 * if non-NULL called during thread shutdown (ptlrpc_main()) to
1632 * destruct state created by ->srv_init().
1634 void (*so_thr_done)(struct ptlrpc_thread *thr);
1636 * Handler function for incoming requests for this service
1638 int (*so_req_handler)(struct ptlrpc_request *req);
1640 * function to determine priority of the request, it's called
1641 * on every new request
1643 int (*so_hpreq_handler)(struct ptlrpc_request *);
1645 * service-specific print fn
1647 void (*so_req_printer)(void *, struct ptlrpc_request *);
1650 #ifndef __cfs_cacheline_aligned
1651 /* NB: put it here for reducing patche dependence */
1652 # define __cfs_cacheline_aligned
1656 * How many high priority requests to serve before serving one normal
1659 #define PTLRPC_SVC_HP_RATIO 10
1662 * Definition of PortalRPC service.
1663 * The service is listening on a particular portal (like tcp port)
1664 * and perform actions for a specific server like IO service for OST
1665 * or general metadata service for MDS.
1667 struct ptlrpc_service {
1668 /** serialize /proc operations */
1669 spinlock_t srv_lock;
1670 /** most often accessed fields */
1671 /** chain thru all services */
1672 struct list_head srv_list;
1673 /** service operations table */
1674 struct ptlrpc_service_ops srv_ops;
1675 /** only statically allocated strings here; we don't clean them */
1677 /** only statically allocated strings here; we don't clean them */
1678 char *srv_thread_name;
1679 /** service thread list */
1680 struct list_head srv_threads;
1681 /** threads # should be created for each partition on initializing */
1682 int srv_nthrs_cpt_init;
1683 /** limit of threads number for each partition */
1684 int srv_nthrs_cpt_limit;
1685 /** Root of /proc dir tree for this service */
1686 struct proc_dir_entry *srv_procroot;
1687 /** Pointer to statistic data for this service */
1688 struct lprocfs_stats *srv_stats;
1689 /** # hp per lp reqs to handle */
1690 int srv_hpreq_ratio;
1691 /** biggest request to receive */
1692 int srv_max_req_size;
1693 /** biggest reply to send */
1694 int srv_max_reply_size;
1695 /** size of individual buffers */
1697 /** # buffers to allocate in 1 group */
1698 int srv_nbuf_per_group;
1699 /** Local portal on which to receive requests */
1700 __u32 srv_req_portal;
1701 /** Portal on the client to send replies to */
1702 __u32 srv_rep_portal;
1704 * Tags for lu_context associated with this thread, see struct
1708 /** soft watchdog timeout multiplier */
1709 int srv_watchdog_factor;
1710 /** under unregister_service */
1711 unsigned srv_is_stopping:1;
1713 /** max # request buffers */
1715 /** max # request buffers in history per partition */
1716 int srv_hist_nrqbds_cpt_max;
1717 /** number of CPTs this service bound on */
1719 /** CPTs array this service bound on */
1721 /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
1723 /** CPT table this service is running over */
1724 struct cfs_cpt_table *srv_cptable;
1727 struct kobject srv_kobj;
1728 struct completion srv_kobj_unregister;
1730 * partition data for ptlrpc service
1732 struct ptlrpc_service_part *srv_parts[0];
1736 * Definition of PortalRPC service partition data.
1737 * Although a service only has one instance of it right now, but we
1738 * will have multiple instances very soon (instance per CPT).
1740 * it has four locks:
1742 * serialize operations on rqbd and requests waiting for preprocess
1744 * serialize operations active requests sent to this portal
1746 * serialize adaptive timeout stuff
1748 * serialize operations on RS list (reply states)
1750 * We don't have any use-case to take two or more locks at the same time
1751 * for now, so there is no lock order issue.
1753 struct ptlrpc_service_part {
1754 /** back reference to owner */
1755 struct ptlrpc_service *scp_service __cfs_cacheline_aligned;
1756 /* CPT id, reserved */
1758 /** always increasing number */
1760 /** # of starting threads */
1761 int scp_nthrs_starting;
1762 /** # of stopping threads, reserved for shrinking threads */
1763 int scp_nthrs_stopping;
1764 /** # running threads */
1765 int scp_nthrs_running;
1766 /** service threads list */
1767 struct list_head scp_threads;
1770 * serialize the following fields, used for protecting
1771 * rqbd list and incoming requests waiting for preprocess,
1772 * threads starting & stopping are also protected by this lock.
1774 spinlock_t scp_lock __cfs_cacheline_aligned;
1775 /** total # req buffer descs allocated */
1776 int scp_nrqbds_total;
1777 /** # posted request buffers for receiving */
1778 int scp_nrqbds_posted;
1779 /** in progress of allocating rqbd */
1780 int scp_rqbd_allocating;
1781 /** # incoming reqs */
1782 int scp_nreqs_incoming;
1783 /** request buffers to be reposted */
1784 struct list_head scp_rqbd_idle;
1785 /** req buffers receiving */
1786 struct list_head scp_rqbd_posted;
1787 /** incoming reqs */
1788 struct list_head scp_req_incoming;
1789 /** timeout before re-posting reqs, in tick */
1790 cfs_duration_t scp_rqbd_timeout;
1792 * all threads sleep on this. This wait-queue is signalled when new
1793 * incoming request arrives and when difficult reply has to be handled.
1795 wait_queue_head_t scp_waitq;
1797 /** request history */
1798 struct list_head scp_hist_reqs;
1799 /** request buffer history */
1800 struct list_head scp_hist_rqbds;
1801 /** # request buffers in history */
1802 int scp_hist_nrqbds;
1803 /** sequence number for request */
1805 /** highest seq culled from history */
1806 __u64 scp_hist_seq_culled;
1809 * serialize the following fields, used for processing requests
1810 * sent to this portal
1812 spinlock_t scp_req_lock __cfs_cacheline_aligned;
1813 /** # reqs in either of the NRS heads below */
1814 /** # reqs being served */
1815 int scp_nreqs_active;
1816 /** # HPreqs being served */
1817 int scp_nhreqs_active;
1818 /** # hp requests handled */
1821 /** NRS head for regular requests */
1822 struct ptlrpc_nrs scp_nrs_reg;
1823 /** NRS head for HP requests; this is only valid for services that can
1824 * handle HP requests */
1825 struct ptlrpc_nrs *scp_nrs_hp;
1830 * serialize the following fields, used for changes on
1833 spinlock_t scp_at_lock __cfs_cacheline_aligned;
1834 /** estimated rpc service time */
1835 struct adaptive_timeout scp_at_estimate;
1836 /** reqs waiting for replies */
1837 struct ptlrpc_at_array scp_at_array;
1838 /** early reply timer */
1839 struct timer_list scp_at_timer;
1841 cfs_time_t scp_at_checktime;
1842 /** check early replies */
1843 unsigned scp_at_check;
1847 * serialize the following fields, used for processing
1848 * replies for this portal
1850 spinlock_t scp_rep_lock __cfs_cacheline_aligned;
1851 /** all the active replies */
1852 struct list_head scp_rep_active;
1853 /** List of free reply_states */
1854 struct list_head scp_rep_idle;
1855 /** waitq to run, when adding stuff to srv_free_rs_list */
1856 wait_queue_head_t scp_rep_waitq;
1857 /** # 'difficult' replies */
1858 atomic_t scp_nreps_difficult;
1861 #define ptlrpc_service_for_each_part(part, i, svc) \
1863 i < (svc)->srv_ncpts && \
1864 (svc)->srv_parts != NULL && \
1865 ((part) = (svc)->srv_parts[i]) != NULL; i++)
1868 * Declaration of ptlrpcd control structure
1870 struct ptlrpcd_ctl {
1872 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1874 unsigned long pc_flags;
1876 * Thread lock protecting structure fields.
1882 struct completion pc_starting;
1886 struct completion pc_finishing;
1888 * Thread requests set.
1890 struct ptlrpc_request_set *pc_set;
1892 * Thread name used in kthread_run()
1896 * CPT the thread is bound on.
1900 * Index of ptlrpcd thread in the array.
1904 * Pointer to the array of partners' ptlrpcd_ctl structure.
1906 struct ptlrpcd_ctl **pc_partners;
1908 * Number of the ptlrpcd's partners.
1912 * Record the partner index to be processed next.
1916 * Error code if the thread failed to fully start.
1921 /* Bits for pc_flags */
1922 enum ptlrpcd_ctl_flags {
1924 * Ptlrpc thread start flag.
1926 LIOD_START = 1 << 0,
1928 * Ptlrpc thread stop flag.
1932 * Ptlrpc thread force flag (only stop force so far).
1933 * This will cause aborting any inflight rpcs handled
1934 * by thread if LIOD_STOP is specified.
1936 LIOD_FORCE = 1 << 2,
1938 * This is a recovery ptlrpc thread.
1940 LIOD_RECOVERY = 1 << 3,
1947 * Service compatibility function; the policy is compatible with all services.
1949 * \param[in] svc The service the policy is attempting to register with.
1950 * \param[in] desc The policy descriptor
1952 * \retval true The policy is compatible with the service
1954 * \see ptlrpc_nrs_pol_desc::pd_compat()
1956 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
1957 const struct ptlrpc_nrs_pol_desc *desc)
1963 * Service compatibility function; the policy is compatible with only a specific
1964 * service which is identified by its human-readable name at
1965 * ptlrpc_service::srv_name.
1967 * \param[in] svc The service the policy is attempting to register with.
1968 * \param[in] desc The policy descriptor
1970 * \retval false The policy is not compatible with the service
1971 * \retval true The policy is compatible with the service
1973 * \see ptlrpc_nrs_pol_desc::pd_compat()
1975 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
1976 const struct ptlrpc_nrs_pol_desc *desc)
1978 LASSERT(desc->pd_compat_svc_name != NULL);
1979 return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
1984 /* ptlrpc/events.c */
1985 extern struct lnet_handle_eq ptlrpc_eq_h;
1986 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
1987 struct lnet_process_id *peer, lnet_nid_t *self);
1989 * These callbacks are invoked by LNet when something happened to
1993 extern void request_out_callback(struct lnet_event *ev);
1994 extern void reply_in_callback(struct lnet_event *ev);
1995 extern void client_bulk_callback(struct lnet_event *ev);
1996 extern void request_in_callback(struct lnet_event *ev);
1997 extern void reply_out_callback(struct lnet_event *ev);
1998 #ifdef HAVE_SERVER_SUPPORT
1999 extern void server_bulk_callback(struct lnet_event *ev);
2003 /* ptlrpc/connection.c */
2004 struct ptlrpc_connection *ptlrpc_connection_get(struct lnet_process_id peer,
2006 struct obd_uuid *uuid);
2007 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2008 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2009 int ptlrpc_connection_init(void);
2010 void ptlrpc_connection_fini(void);
2011 extern lnet_pid_t ptl_get_pid(void);
2014 * Check if the peer connection is on the local node. We need to use GFP_NOFS
2015 * for requests from a local client to avoid recursing into the filesystem
2016 * as we might end up waiting on a page sent in the request we're serving.
2018 * Use __GFP_HIGHMEM so that the pages can use all of the available memory
2019 * on 32-bit machines. Use more aggressive GFP_HIGHUSER flags from non-local
2020 * clients to be able to generate more memory pressure on the OSS and allow
2021 * inactive pages to be reclaimed, since it doesn't have any other processes
2022 * or allocations that generate memory reclaim pressure.
2024 * See b=17576 (bdf50dc9) and b=19529 (3dcf18d3) for details.
2026 static inline bool ptlrpc_connection_is_local(struct ptlrpc_connection *conn)
2031 if (conn->c_peer.nid == conn->c_self)
2034 RETURN(LNetIsPeerLocal(conn->c_peer.nid));
2037 /* ptlrpc/niobuf.c */
2039 * Actual interfacing with LNet to put/get/register/unregister stuff
2042 #ifdef HAVE_SERVER_SUPPORT
2043 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2044 unsigned nfrags, unsigned max_brw,
2047 const struct ptlrpc_bulk_frag_ops
2049 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2050 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2052 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2056 LASSERT(desc != NULL);
2058 spin_lock(&desc->bd_lock);
2059 rc = desc->bd_md_count;
2060 spin_unlock(&desc->bd_lock);
2065 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2066 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2068 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2070 struct ptlrpc_bulk_desc *desc;
2073 LASSERT(req != NULL);
2074 desc = req->rq_bulk;
2079 if (req->rq_bulk_deadline > ktime_get_real_seconds())
2083 spin_lock(&desc->bd_lock);
2084 rc = desc->bd_md_count;
2085 spin_unlock(&desc->bd_lock);
2089 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2090 #define PTLRPC_REPLY_EARLY 0x02
2091 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2092 int ptlrpc_reply(struct ptlrpc_request *req);
2093 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2094 int ptlrpc_error(struct ptlrpc_request *req);
2095 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2096 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2097 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2100 /* ptlrpc/client.c */
2102 * Client-side portals API. Everything to send requests, receive replies,
2103 * request queues, request management, etc.
2106 void ptlrpc_request_committed(struct ptlrpc_request *req, int force);
2108 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
2109 struct ptlrpc_client *);
2110 void ptlrpc_cleanup_client(struct obd_import *imp);
2111 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
2112 lnet_nid_t nid4refnet);
2114 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2115 int ptlrpc_replay_req(struct ptlrpc_request *req);
2116 void ptlrpc_restart_req(struct ptlrpc_request *req);
2117 void ptlrpc_abort_inflight(struct obd_import *imp);
2118 void ptlrpc_cleanup_imp(struct obd_import *imp);
2119 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2121 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2122 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2124 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2125 int ptlrpc_set_wait(struct ptlrpc_request_set *);
2126 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2127 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2128 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2130 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2131 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2133 struct ptlrpc_request_pool *
2134 ptlrpc_init_rq_pool(int, int,
2135 int (*populate_pool)(struct ptlrpc_request_pool *, int));
2137 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2138 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2139 const struct req_format *format);
2140 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2141 struct ptlrpc_request_pool *,
2142 const struct req_format *format);
2143 void ptlrpc_request_free(struct ptlrpc_request *request);
2144 int ptlrpc_request_pack(struct ptlrpc_request *request,
2145 __u32 version, int opcode);
2146 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2147 const struct req_format *format,
2148 __u32 version, int opcode);
2149 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2150 __u32 version, int opcode, char **bufs,
2151 struct ptlrpc_cli_ctx *ctx);
2152 void ptlrpc_req_finished(struct ptlrpc_request *request);
2153 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2154 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2155 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2156 unsigned nfrags, unsigned max_brw,
2159 const struct ptlrpc_bulk_frag_ops
2162 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
2163 void *frag, int len);
2164 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2165 struct page *page, int pageoffset, int len,
2167 static inline void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
2168 struct page *page, int pageoffset,
2171 __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
2174 static inline void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
2175 struct page *page, int pageoffset,
2178 __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
2181 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
2183 static inline void ptlrpc_release_bulk_page_pin(struct ptlrpc_bulk_desc *desc)
2187 for (i = 0; i < desc->bd_iov_count ; i++)
2188 put_page(BD_GET_KIOV(desc, i).kiov_page);
2191 static inline void ptlrpc_release_bulk_noop(struct ptlrpc_bulk_desc *desc)
2195 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2196 struct obd_import *imp);
2197 __u64 ptlrpc_next_xid(void);
2198 __u64 ptlrpc_sample_next_xid(void);
2199 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
2201 /* Set of routines to run a function in ptlrpcd context */
2202 void *ptlrpcd_alloc_work(struct obd_import *imp,
2203 int (*cb)(const struct lu_env *, void *), void *data);
2204 void ptlrpcd_destroy_work(void *handler);
2205 int ptlrpcd_queue_work(void *handler);
2208 struct ptlrpc_service_buf_conf {
2209 /* nbufs is buffers # to allocate when growing the pool */
2210 unsigned int bc_nbufs;
2211 /* buffer size to post */
2212 unsigned int bc_buf_size;
2213 /* portal to listed for requests on */
2214 unsigned int bc_req_portal;
2215 /* portal of where to send replies to */
2216 unsigned int bc_rep_portal;
2217 /* maximum request size to be accepted for this service */
2218 unsigned int bc_req_max_size;
2219 /* maximum reply size this service can ever send */
2220 unsigned int bc_rep_max_size;
2223 struct ptlrpc_service_thr_conf {
2224 /* threadname should be 8 characters or less - 6 will be added on */
2226 /* threads increasing factor for each CPU */
2227 unsigned int tc_thr_factor;
2228 /* service threads # to start on each partition while initializing */
2229 unsigned int tc_nthrs_init;
2231 * low water of threads # upper-limit on each partition while running,
2232 * service availability may be impacted if threads number is lower
2233 * than this value. It can be ZERO if the service doesn't require
2234 * CPU affinity or there is only one partition.
2236 unsigned int tc_nthrs_base;
2237 /* "soft" limit for total threads number */
2238 unsigned int tc_nthrs_max;
2239 /* user specified threads number, it will be validated due to
2240 * other members of this structure. */
2241 unsigned int tc_nthrs_user;
2242 /* set NUMA node affinity for service threads */
2243 unsigned int tc_cpu_affinity;
2244 /* Tags for lu_context associated with service thread */
2248 struct ptlrpc_service_cpt_conf {
2249 struct cfs_cpt_table *cc_cptable;
2250 /* string pattern to describe CPTs for a service */
2254 struct ptlrpc_service_conf {
2257 /* soft watchdog timeout multiplifier to print stuck service traces */
2258 unsigned int psc_watchdog_factor;
2259 /* buffer information */
2260 struct ptlrpc_service_buf_conf psc_buf;
2261 /* thread information */
2262 struct ptlrpc_service_thr_conf psc_thr;
2263 /* CPU partition information */
2264 struct ptlrpc_service_cpt_conf psc_cpt;
2265 /* function table */
2266 struct ptlrpc_service_ops psc_ops;
2269 /* ptlrpc/service.c */
2271 * Server-side services API. Register/unregister service, request state
2272 * management, service thread management
2276 void ptlrpc_save_lock(struct ptlrpc_request *req, struct lustre_handle *lock,
2277 int mode, bool no_ack, bool convert_lock);
2278 void ptlrpc_commit_replies(struct obd_export *exp);
2279 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
2280 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
2281 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
2282 struct ptlrpc_service *ptlrpc_register_service(
2283 struct ptlrpc_service_conf *conf,
2284 struct kset *parent,
2285 struct proc_dir_entry *proc_entry);
2286 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
2288 int ptlrpc_start_threads(struct ptlrpc_service *svc);
2289 int ptlrpc_unregister_service(struct ptlrpc_service *service);
2290 int ptlrpc_service_health_check(struct ptlrpc_service *);
2291 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
2292 void ptlrpc_request_change_export(struct ptlrpc_request *req,
2293 struct obd_export *export);
2294 void ptlrpc_update_export_timer(struct obd_export *exp,
2295 time64_t extra_delay);
2297 int ptlrpc_hr_init(void);
2298 void ptlrpc_hr_fini(void);
2302 /* ptlrpc/import.c */
2307 int ptlrpc_connect_import(struct obd_import *imp);
2308 int ptlrpc_init_import(struct obd_import *imp);
2309 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
2310 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
2311 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
2313 void ptlrpc_import_enter_resend(struct obd_import *imp);
2314 /* ptlrpc/pack_generic.c */
2315 int ptlrpc_reconnect_import(struct obd_import *imp);
2319 * ptlrpc msg buffer and swab interface
2323 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
2325 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
2327 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
2328 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
2330 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
2331 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
2333 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
2334 __u32 *lens, char **bufs);
2335 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
2337 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
2338 __u32 *lens, char **bufs, int flags);
2339 #define LPRFL_EARLY_REPLY 1
2340 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
2341 char **bufs, int flags);
2342 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
2343 unsigned int newlen, int move_data);
2344 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
2345 int __lustre_unpack_msg(struct lustre_msg *m, int len);
2346 __u32 lustre_msg_hdr_size(__u32 magic, __u32 count);
2347 __u32 lustre_msg_size(__u32 magic, int count, __u32 *lengths);
2348 __u32 lustre_msg_size_v2(int count, __u32 *lengths);
2349 __u32 lustre_packed_msg_size(struct lustre_msg *msg);
2350 __u32 lustre_msg_early_size(void);
2351 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, __u32 n, __u32 min_size);
2352 void *lustre_msg_buf(struct lustre_msg *m, __u32 n, __u32 minlen);
2353 __u32 lustre_msg_buflen(struct lustre_msg *m, __u32 n);
2354 void lustre_msg_set_buflen(struct lustre_msg *m, __u32 n, __u32 len);
2355 __u32 lustre_msg_bufcount(struct lustre_msg *m);
2356 char *lustre_msg_string(struct lustre_msg *m, __u32 n, __u32 max_len);
2357 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
2358 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
2359 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
2360 void lustre_msg_add_flags(struct lustre_msg *msg, __u32 flags);
2361 void lustre_msg_set_flags(struct lustre_msg *msg, __u32 flags);
2362 void lustre_msg_clear_flags(struct lustre_msg *msg, __u32 flags);
2363 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
2364 void lustre_msg_add_op_flags(struct lustre_msg *msg, __u32 flags);
2365 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
2366 __u32 lustre_msg_get_type(struct lustre_msg *msg);
2367 enum lustre_msg_version lustre_msg_get_version(struct lustre_msg *msg);
2368 void lustre_msg_add_version(struct lustre_msg *msg, __u32 version);
2369 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
2370 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
2371 __u16 lustre_msg_get_tag(struct lustre_msg *msg);
2372 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
2373 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
2374 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
2375 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
2376 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
2377 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
2378 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
2379 int lustre_msg_get_status(struct lustre_msg *msg);
2380 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
2381 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
2382 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
2383 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
2384 char *lustre_msg_get_jobid(struct lustre_msg *msg);
2385 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
2386 __u64 lustre_msg_get_mbits(struct lustre_msg *msg);
2387 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
2388 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
2389 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
2390 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
2391 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
2392 void lustre_msg_set_tag(struct lustre_msg *msg, __u16 tag);
2393 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
2394 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
2395 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
2396 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
2397 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
2398 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
2399 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
2400 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
2401 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
2402 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
2403 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
2404 void lustre_msg_set_mbits(struct lustre_msg *msg, __u64 mbits);
2407 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
2408 unsigned int newlen, int move_data)
2410 LASSERT(req->rq_reply_state);
2411 LASSERT(req->rq_repmsg);
2412 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2416 #ifdef LUSTRE_TRANSLATE_ERRNOS
2418 static inline int ptlrpc_status_hton(int h)
2421 * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
2422 * ELDLM_LOCK_ABORTED, etc.
2425 return -lustre_errno_hton(-h);
2430 static inline int ptlrpc_status_ntoh(int n)
2433 * See the comment in ptlrpc_status_hton().
2436 return -lustre_errno_ntoh(-n);
2443 #define ptlrpc_status_hton(h) (h)
2444 #define ptlrpc_status_ntoh(n) (n)
2449 /** Change request phase of \a req to \a new_phase */
2451 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2453 if (req->rq_phase == new_phase)
2456 if (new_phase == RQ_PHASE_UNREG_RPC ||
2457 new_phase == RQ_PHASE_UNREG_BULK) {
2458 /* No embedded unregistering phases */
2459 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2460 req->rq_phase == RQ_PHASE_UNREG_BULK)
2463 req->rq_next_phase = req->rq_phase;
2465 atomic_inc(&req->rq_import->imp_unregistering);
2468 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2469 req->rq_phase == RQ_PHASE_UNREG_BULK) {
2471 atomic_dec(&req->rq_import->imp_unregistering);
2474 DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
2475 ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2477 req->rq_phase = new_phase;
2481 * Returns true if request \a req got early reply and hard deadline is not met
2484 ptlrpc_client_early(struct ptlrpc_request *req)
2486 return req->rq_early;
2490 * Returns true if we got real reply from server for this request
2493 ptlrpc_client_replied(struct ptlrpc_request *req)
2495 if (req->rq_reply_deadline > ktime_get_real_seconds())
2497 return req->rq_replied;
2500 /** Returns true if request \a req is in process of receiving server reply */
2502 ptlrpc_client_recv(struct ptlrpc_request *req)
2504 if (req->rq_reply_deadline > ktime_get_real_seconds())
2506 return req->rq_receiving_reply;
2510 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2514 spin_lock(&req->rq_lock);
2515 if (req->rq_reply_deadline > ktime_get_real_seconds()) {
2516 spin_unlock(&req->rq_lock);
2519 if (req->rq_req_deadline > ktime_get_real_seconds()) {
2520 spin_unlock(&req->rq_lock);
2524 rc = !req->rq_req_unlinked || !req->rq_reply_unlinked ||
2525 req->rq_receiving_reply;
2526 spin_unlock(&req->rq_lock);
2531 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2534 if (req->rq_set == NULL)
2535 wake_up(&req->rq_reply_waitq);
2537 wake_up(&req->rq_set->set_waitq);
2541 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2543 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2544 atomic_inc(&rs->rs_refcount);
2548 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2550 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2551 if (atomic_dec_and_test(&rs->rs_refcount))
2552 lustre_free_reply_state(rs);
2555 /* Should only be called once per req */
2556 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2558 if (req->rq_reply_state == NULL)
2559 return; /* shouldn't occur */
2560 ptlrpc_rs_decref(req->rq_reply_state);
2561 req->rq_reply_state = NULL;
2562 req->rq_repmsg = NULL;
2565 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2567 return lustre_msg_get_magic(req->rq_reqmsg);
2570 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2572 switch (req->rq_reqmsg->lm_magic) {
2573 case LUSTRE_MSG_MAGIC_V2:
2574 return req->rq_reqmsg->lm_repsize;
2576 LASSERTF(0, "incorrect message magic: %08x\n",
2577 req->rq_reqmsg->lm_magic);
2582 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2584 if (req->rq_delay_limit != 0 &&
2585 req->rq_queued_time + req->rq_delay_limit < ktime_get_seconds())
2590 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2592 if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2593 spin_lock(&req->rq_lock);
2594 req->rq_no_resend = 1;
2595 spin_unlock(&req->rq_lock);
2597 return req->rq_no_resend;
2601 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
2603 int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
2605 return svcpt->scp_service->srv_watchdog_factor *
2606 max_t(int, at, obd_timeout);
2609 static inline struct ptlrpc_service *
2610 ptlrpc_req2svc(struct ptlrpc_request *req)
2612 LASSERT(req->rq_rqbd != NULL);
2613 return req->rq_rqbd->rqbd_svcpt->scp_service;
2616 /* ldlm/ldlm_lib.c */
2618 * Target client logic
2621 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
2622 int client_obd_cleanup(struct obd_device *obddev);
2623 int client_connect_import(const struct lu_env *env,
2624 struct obd_export **exp, struct obd_device *obd,
2625 struct obd_uuid *cluuid, struct obd_connect_data *,
2627 int client_disconnect_export(struct obd_export *exp);
2628 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
2630 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
2631 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
2632 struct obd_uuid *uuid);
2633 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
2634 void client_destroy_import(struct obd_import *imp);
2637 #ifdef HAVE_SERVER_SUPPORT
2638 int server_disconnect_export(struct obd_export *exp);
2641 /* ptlrpc/pinger.c */
2643 * Pinger API (client side only)
2646 enum timeout_event {
2649 struct timeout_item;
2650 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
2651 int ptlrpc_pinger_add_import(struct obd_import *imp);
2652 int ptlrpc_pinger_del_import(struct obd_import *imp);
2653 int ptlrpc_add_timeout_client(time64_t time, enum timeout_event event,
2654 timeout_cb_t cb, void *data,
2655 struct list_head *obd_list);
2656 int ptlrpc_del_timeout_client(struct list_head *obd_list,
2657 enum timeout_event event);
2658 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
2659 int ptlrpc_obd_ping(struct obd_device *obd);
2660 void ping_evictor_start(void);
2661 void ping_evictor_stop(void);
2662 void ptlrpc_pinger_ir_up(void);
2663 void ptlrpc_pinger_ir_down(void);
2665 int ptlrpc_pinger_suppress_pings(void);
2667 /* ptlrpc/ptlrpcd.c */
2668 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
2669 void ptlrpcd_free(struct ptlrpcd_ctl *pc);
2670 void ptlrpcd_wake(struct ptlrpc_request *req);
2671 void ptlrpcd_add_req(struct ptlrpc_request *req);
2672 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
2673 int ptlrpcd_addref(void);
2674 void ptlrpcd_decref(void);
2676 /* ptlrpc/lproc_ptlrpc.c */
2678 * procfs output related functions
2681 const char* ll_opcode2str(__u32 opcode);
2682 const int ll_str2opcode(const char *ops);
2683 #ifdef CONFIG_PROC_FS
2684 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
2685 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
2686 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
2688 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
2689 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
2690 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
2694 /* ptlrpc/llog_server.c */
2695 int llog_origin_handle_open(struct ptlrpc_request *req);
2696 int llog_origin_handle_destroy(struct ptlrpc_request *req);
2697 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
2698 int llog_origin_handle_next_block(struct ptlrpc_request *req);
2699 int llog_origin_handle_read_header(struct ptlrpc_request *req);
2700 int llog_origin_handle_close(struct ptlrpc_request *req);
2702 /* ptlrpc/llog_client.c */
2703 extern struct llog_operations llog_client_ops;