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 niobuf per page of data
475 * - Must be a multiple of 1024
476 * - should allow a reasonably large SHORT_IO_BYTES size (64KB)
478 #define _OST_MAXREQSIZE_BASE ((unsigned long)(sizeof(struct lustre_msg) + \
479 /* lm_buflens */ sizeof(__u32) * 4 + \
480 sizeof(struct ptlrpc_body) + \
481 sizeof(struct obdo) + \
482 sizeof(struct obd_ioobj) + \
483 sizeof(struct niobuf_remote)))
484 #define _OST_MAXREQSIZE_SUM ((unsigned long)(_OST_MAXREQSIZE_BASE + \
485 sizeof(struct niobuf_remote) * \
488 * FIEMAP request can be 4K+ for now
490 #define OST_MAXREQSIZE (16UL * 1024UL)
491 #define OST_IO_MAXREQSIZE max(OST_MAXREQSIZE, \
492 ((_OST_MAXREQSIZE_SUM - 1) | \
494 /* Safe estimate of free space in standard RPC, provides upper limit for # of
495 * bytes of i/o to pack in RPC (skipping bulk transfer). */
496 #define OST_MAX_SHORT_IO_BYTES ((OST_IO_MAXREQSIZE - _OST_MAXREQSIZE_BASE) & \
499 /* Actual size used for short i/o buffer. Calculation means this:
500 * At least one page (for large PAGE_SIZE), or 16 KiB, but not more
501 * than the available space aligned to a page boundary. */
502 #define OBD_DEF_SHORT_IO_BYTES min(max(PAGE_SIZE, 16UL * 1024UL), \
503 OST_MAX_SHORT_IO_BYTES)
505 #define OST_MAXREPSIZE (9 * 1024)
506 #define OST_IO_MAXREPSIZE OST_MAXREPSIZE
509 /** OST_BUFSIZE = max_reqsize + max sptlrpc payload size */
510 #define OST_BUFSIZE max_t(int, OST_MAXREQSIZE + 1024, 32 * 1024)
512 * OST_IO_MAXREQSIZE is 18K, giving extra 46K can increase buffer utilization
513 * rate of request buffer, please check comment of MDS_LOV_BUFSIZE for details.
515 #define OST_IO_BUFSIZE max_t(int, OST_IO_MAXREQSIZE + 1024, 64 * 1024)
517 /* Macro to hide a typecast and BUILD_BUG. */
518 #define ptlrpc_req_async_args(_var, req) ({ \
519 BUILD_BUG_ON(sizeof(*_var) > sizeof(req->rq_async_args)); \
520 (typeof(_var))&req->rq_async_args; \
523 struct ptlrpc_replay_async_args {
529 * Structure to single define portal connection.
531 struct ptlrpc_connection {
532 /** linkage for connections hash table */
533 struct hlist_node c_hash;
534 /** Our own lnet nid for this connection */
536 /** Remote side nid for this connection */
537 struct lnet_process_id c_peer;
538 /** UUID of the other side */
539 struct obd_uuid c_remote_uuid;
540 /** reference counter for this connection */
544 /** Client definition for PortalRPC */
545 struct ptlrpc_client {
546 /** What lnet portal does this client send messages to by default */
547 __u32 cli_request_portal;
548 /** What portal do we expect replies on */
549 __u32 cli_reply_portal;
550 /** Name of the client */
551 const char *cli_name;
554 /** state flags of requests */
555 /* XXX only ones left are those used by the bulk descs as well! */
556 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
557 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
559 #define REQ_MAX_ACK_LOCKS 8
561 union ptlrpc_async_args {
563 * Scratchpad for passing args to completion interpreter. Users
564 * cast to the struct of their choosing, and BUILD_BUG_ON that this is
565 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
566 * a pointer to it here. The pointer_arg ensures this struct is at
567 * least big enough for that.
569 void *pointer_arg[11];
573 struct ptlrpc_request_set;
574 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
577 * Definition of request set structure.
578 * Request set is a list of requests (not necessary to the same target) that
579 * once populated with RPCs could be sent in parallel.
580 * There are two kinds of request sets. General purpose and with dedicated
581 * serving thread. Example of the latter is ptlrpcd set.
582 * For general purpose sets once request set started sending it is impossible
583 * to add new requests to such set.
584 * Provides a way to call "completion callbacks" when all requests in the set
587 struct ptlrpc_request_set {
588 atomic_t set_refcount;
589 /** number of in queue requests */
590 atomic_t set_new_count;
591 /** number of uncompleted requests */
592 atomic_t set_remaining;
593 /** wait queue to wait on for request events */
594 wait_queue_head_t set_waitq;
595 /** List of requests in the set */
596 struct list_head set_requests;
598 * Lock for \a set_new_requests manipulations
599 * locked so that any old caller can communicate requests to
600 * the set holder who can then fold them into the lock-free set
602 spinlock_t set_new_req_lock;
603 /** List of new yet unsent requests. Only used with ptlrpcd now. */
604 struct list_head set_new_requests;
606 /** rq_status of requests that have been freed already */
608 /** Additional fields used by the flow control extension */
609 /** Maximum number of RPCs in flight */
610 int set_max_inflight;
611 /** Callback function used to generate RPCs */
612 set_producer_func set_producer;
613 /** opaq argument passed to the producer callback */
614 void *set_producer_arg;
615 unsigned int set_allow_intr:1;
618 struct ptlrpc_bulk_desc;
619 struct ptlrpc_service_part;
620 struct ptlrpc_service;
623 * ptlrpc callback & work item stuff
625 struct ptlrpc_cb_id {
626 void (*cbid_fn)(struct lnet_event *ev); /* specific callback fn */
627 void *cbid_arg; /* additional arg */
630 /** Maximum number of locks to fit into reply state */
631 #define RS_MAX_LOCKS 8
635 * Structure to define reply state on the server
636 * Reply state holds various reply message information. Also for "difficult"
637 * replies (rep-ack case) we store the state after sending reply and wait
638 * for the client to acknowledge the reception. In these cases locks could be
639 * added to the state for replay/failover consistency guarantees.
641 struct ptlrpc_reply_state {
642 /** Callback description */
643 struct ptlrpc_cb_id rs_cb_id;
644 /** Linkage for list of all reply states in a system */
645 struct list_head rs_list;
646 /** Linkage for list of all reply states on same export */
647 struct list_head rs_exp_list;
648 /** Linkage for list of all reply states for same obd */
649 struct list_head rs_obd_list;
651 struct list_head rs_debug_list;
653 /** A spinlock to protect the reply state flags */
655 /** Reply state flags */
656 unsigned long rs_difficult:1; /* ACK/commit stuff */
657 unsigned long rs_no_ack:1; /* no ACK, even for
658 difficult requests */
659 unsigned long rs_scheduled:1; /* being handled? */
660 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
661 unsigned long rs_handled:1; /* been handled yet? */
662 unsigned long rs_on_net:1; /* reply_out_callback pending? */
663 unsigned long rs_prealloc:1; /* rs from prealloc list */
664 unsigned long rs_committed:1;/* the transaction was committed
665 and the rs was dispatched
666 by ptlrpc_commit_replies */
667 unsigned long rs_convert_lock:1; /* need to convert saved
668 * locks to COS mode */
669 atomic_t rs_refcount; /* number of users */
670 /** Number of locks awaiting client ACK */
673 /** Size of the state */
677 /** Transaction number */
681 struct obd_export *rs_export;
682 struct ptlrpc_service_part *rs_svcpt;
683 /** Lnet metadata handle for the reply */
684 struct lnet_handle_md rs_md_h;
686 /** Context for the sevice thread */
687 struct ptlrpc_svc_ctx *rs_svc_ctx;
688 /** Reply buffer (actually sent to the client), encoded if needed */
689 struct lustre_msg *rs_repbuf; /* wrapper */
690 /** Size of the reply buffer */
691 int rs_repbuf_len; /* wrapper buf length */
692 /** Size of the reply message */
693 int rs_repdata_len; /* wrapper msg length */
695 * Actual reply message. Its content is encrupted (if needed) to
696 * produce reply buffer for actual sending. In simple case
697 * of no network encryption we jus set \a rs_repbuf to \a rs_msg
699 struct lustre_msg *rs_msg; /* reply message */
701 /** Handles of locks awaiting client reply ACK */
702 struct lustre_handle rs_locks[RS_MAX_LOCKS];
703 /** Lock modes of locks in \a rs_locks */
704 enum ldlm_mode rs_modes[RS_MAX_LOCKS];
707 struct ptlrpc_thread;
711 RQ_PHASE_NEW = 0xebc0de00,
712 RQ_PHASE_RPC = 0xebc0de01,
713 RQ_PHASE_BULK = 0xebc0de02,
714 RQ_PHASE_INTERPRET = 0xebc0de03,
715 RQ_PHASE_COMPLETE = 0xebc0de04,
716 RQ_PHASE_UNREG_RPC = 0xebc0de05,
717 RQ_PHASE_UNREG_BULK = 0xebc0de06,
718 RQ_PHASE_UNDEFINED = 0xebc0de07
721 /** Type of request interpreter call-back */
722 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
723 struct ptlrpc_request *req,
725 /** Type of request resend call-back */
726 typedef void (*ptlrpc_resend_cb_t)(struct ptlrpc_request *req,
730 * Definition of request pool structure.
731 * The pool is used to store empty preallocated requests for the case
732 * when we would actually need to send something without performing
733 * any allocations (to avoid e.g. OOM).
735 struct ptlrpc_request_pool {
736 /** Locks the list */
738 /** list of ptlrpc_request structs */
739 struct list_head prp_req_list;
740 /** Maximum message size that would fit into a rquest from this pool */
742 /** Function to allocate more requests for this pool */
743 int (*prp_populate)(struct ptlrpc_request_pool *, int);
751 #include <lustre_nrs.h>
754 * Basic request prioritization operations structure.
755 * The whole idea is centered around locks and RPCs that might affect locks.
756 * When a lock is contended we try to give priority to RPCs that might lead
757 * to fastest release of that lock.
758 * Currently only implemented for OSTs only in a way that makes all
759 * IO and truncate RPCs that are coming from a locked region where a lock is
760 * contended a priority over other requests.
762 struct ptlrpc_hpreq_ops {
764 * Check if the lock handle of the given lock is the same as
765 * taken from the request.
767 int (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
769 * Check if the request is a high priority one.
771 int (*hpreq_check)(struct ptlrpc_request *);
773 * Called after the request has been handled.
775 void (*hpreq_fini)(struct ptlrpc_request *);
778 struct ptlrpc_cli_req {
779 /** For bulk requests on client only: bulk descriptor */
780 struct ptlrpc_bulk_desc *cr_bulk;
781 /** optional time limit for send attempts. This is a timeout
782 * not a timestamp so timeout_t (s32) is used instead of time64_t
784 timeout_t cr_delay_limit;
785 /** time request was first queued */
786 time64_t cr_queued_time;
787 /** request sent in nanoseconds */
789 /** time for request really sent out */
790 time64_t cr_sent_out;
791 /** when req reply unlink must finish. */
792 time64_t cr_reply_deadline;
793 /** when req bulk unlink must finish. */
794 time64_t cr_bulk_deadline;
795 /** when req unlink must finish. */
796 time64_t cr_req_deadline;
797 /** Portal to which this request would be sent */
799 /** Portal where to wait for reply and where reply would be sent */
801 /** request resending number */
802 unsigned int cr_resend_nr;
803 /** What was import generation when this request was sent */
805 enum lustre_imp_state cr_send_state;
806 /** Per-request waitq introduced by bug 21938 for recovery waiting */
807 wait_queue_head_t cr_set_waitq;
808 /** Link item for request set lists */
809 struct list_head cr_set_chain;
810 /** link to waited ctx */
811 struct list_head cr_ctx_chain;
813 /** client's half ctx */
814 struct ptlrpc_cli_ctx *cr_cli_ctx;
815 /** Link back to the request set */
816 struct ptlrpc_request_set *cr_set;
817 /** outgoing request MD handle */
818 struct lnet_handle_md cr_req_md_h;
819 /** request-out callback parameter */
820 struct ptlrpc_cb_id cr_req_cbid;
821 /** incoming reply MD handle */
822 struct lnet_handle_md cr_reply_md_h;
823 wait_queue_head_t cr_reply_waitq;
824 /** reply callback parameter */
825 struct ptlrpc_cb_id cr_reply_cbid;
826 /** Async completion handler, called when reply is received */
827 ptlrpc_interpterer_t cr_reply_interp;
828 /** Resend handler, called when request is resend to update RPC data */
829 ptlrpc_resend_cb_t cr_resend_cb;
830 /** Async completion context */
831 union ptlrpc_async_args cr_async_args;
832 /** Opaq data for replay and commit callbacks. */
834 /** Link to the imp->imp_unreplied_list */
835 struct list_head cr_unreplied_list;
837 * Commit callback, called when request is committed and about to be
840 void (*cr_commit_cb)(struct ptlrpc_request *);
841 /** Replay callback, called after request is replayed at recovery */
842 void (*cr_replay_cb)(struct ptlrpc_request *);
845 /** client request member alias */
846 /* NB: these alias should NOT be used by any new code, instead they should
847 * be removed step by step to avoid potential abuse */
848 #define rq_bulk rq_cli.cr_bulk
849 #define rq_delay_limit rq_cli.cr_delay_limit
850 #define rq_queued_time rq_cli.cr_queued_time
851 #define rq_sent_ns rq_cli.cr_sent_ns
852 #define rq_real_sent rq_cli.cr_sent_out
853 #define rq_reply_deadline rq_cli.cr_reply_deadline
854 #define rq_bulk_deadline rq_cli.cr_bulk_deadline
855 #define rq_req_deadline rq_cli.cr_req_deadline
856 #define rq_nr_resend rq_cli.cr_resend_nr
857 #define rq_request_portal rq_cli.cr_req_ptl
858 #define rq_reply_portal rq_cli.cr_rep_ptl
859 #define rq_import_generation rq_cli.cr_imp_gen
860 #define rq_send_state rq_cli.cr_send_state
861 #define rq_set_chain rq_cli.cr_set_chain
862 #define rq_ctx_chain rq_cli.cr_ctx_chain
863 #define rq_set rq_cli.cr_set
864 #define rq_set_waitq rq_cli.cr_set_waitq
865 #define rq_cli_ctx rq_cli.cr_cli_ctx
866 #define rq_req_md_h rq_cli.cr_req_md_h
867 #define rq_req_cbid rq_cli.cr_req_cbid
868 #define rq_reply_md_h rq_cli.cr_reply_md_h
869 #define rq_reply_waitq rq_cli.cr_reply_waitq
870 #define rq_reply_cbid rq_cli.cr_reply_cbid
871 #define rq_interpret_reply rq_cli.cr_reply_interp
872 #define rq_resend_cb rq_cli.cr_resend_cb
873 #define rq_async_args rq_cli.cr_async_args
874 #define rq_cb_data rq_cli.cr_cb_data
875 #define rq_unreplied_list rq_cli.cr_unreplied_list
876 #define rq_commit_cb rq_cli.cr_commit_cb
877 #define rq_replay_cb rq_cli.cr_replay_cb
879 struct ptlrpc_srv_req {
880 /** initial thread servicing this request */
881 struct ptlrpc_thread *sr_svc_thread;
883 * Server side list of incoming unserved requests sorted by arrival
884 * time. Traversed from time to time to notice about to expire
885 * requests and sent back "early replies" to clients to let them
886 * know server is alive and well, just very busy to service their
889 struct list_head sr_timed_list;
890 /** server-side per-export list */
891 struct list_head sr_exp_list;
892 /** server-side history, used for debuging purposes. */
893 struct list_head sr_hist_list;
894 /** history sequence # */
896 /** the index of service's srv_at_array into which request is linked */
900 /** authed uid mapped to */
901 uid_t sr_auth_mapped_uid;
902 /** RPC is generated from what part of Lustre */
903 enum lustre_sec_part sr_sp_from;
904 /** request session context */
905 struct lu_context sr_ses;
909 /** stub for NRS request */
910 struct ptlrpc_nrs_request sr_nrq;
912 /** request arrival time */
913 struct timespec64 sr_arrival_time;
914 /** server's half ctx */
915 struct ptlrpc_svc_ctx *sr_svc_ctx;
916 /** (server side), pointed directly into req buffer */
917 struct ptlrpc_user_desc *sr_user_desc;
918 /** separated reply state, may be vmalloc'd */
919 struct ptlrpc_reply_state *sr_reply_state;
920 /** server-side hp handlers */
921 struct ptlrpc_hpreq_ops *sr_ops;
922 /** incoming request buffer */
923 struct ptlrpc_request_buffer_desc *sr_rqbd;
926 /** server request member alias */
927 /* NB: these alias should NOT be used by any new code, instead they should
928 * be removed step by step to avoid potential abuse */
929 #define rq_svc_thread rq_srv.sr_svc_thread
930 #define rq_timed_list rq_srv.sr_timed_list
931 #define rq_exp_list rq_srv.sr_exp_list
932 #define rq_history_list rq_srv.sr_hist_list
933 #define rq_history_seq rq_srv.sr_hist_seq
934 #define rq_at_index rq_srv.sr_at_index
935 #define rq_auth_uid rq_srv.sr_auth_uid
936 #define rq_auth_mapped_uid rq_srv.sr_auth_mapped_uid
937 #define rq_sp_from rq_srv.sr_sp_from
938 #define rq_session rq_srv.sr_ses
939 #define rq_nrq rq_srv.sr_nrq
940 #define rq_arrival_time rq_srv.sr_arrival_time
941 #define rq_reply_state rq_srv.sr_reply_state
942 #define rq_svc_ctx rq_srv.sr_svc_ctx
943 #define rq_user_desc rq_srv.sr_user_desc
944 #define rq_ops rq_srv.sr_ops
945 #define rq_rqbd rq_srv.sr_rqbd
948 * Represents remote procedure call.
950 * This is a staple structure used by everybody wanting to send a request
953 struct ptlrpc_request {
954 /* Request type: one of PTL_RPC_MSG_* */
956 /** Result of request processing */
959 * Linkage item through which this request is included into
960 * sending/delayed lists on client and into rqbd list on server
962 struct list_head rq_list;
963 /** Lock to protect request flags and some other important bits, like
967 spinlock_t rq_early_free_lock;
968 /** client-side flags are serialized by rq_lock @{ */
969 unsigned int rq_intr:1, rq_replied:1, rq_err:1,
970 rq_timedout:1, rq_resend:1, rq_restart:1,
972 * when ->rq_replay is set, request is kept by the client even
973 * after server commits corresponding transaction. This is
974 * used for operations that require sequence of multiple
975 * requests to be replayed. The only example currently is file
976 * open/close. When last request in such a sequence is
977 * committed, ->rq_replay is cleared on all requests in the
981 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
982 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
984 rq_req_unlinked:1, /* unlinked request buffer from lnet */
985 rq_reply_unlinked:1, /* unlinked reply buffer from lnet */
986 rq_memalloc:1, /* req originated from "kswapd" */
988 rq_reply_truncated:1,
989 /** whether the "rq_set" is a valid one */
992 /** do not resend request on -EINPROGRESS */
993 rq_no_retry_einprogress:1,
994 /* allow the req to be sent if the import is in recovery
997 /* bulk request, sent to server, but uncommitted */
999 rq_early_free_repbuf:1, /* free reply buffer in advance */
1003 /** server-side flags @{ */
1005 rq_hp:1, /**< high priority RPC */
1006 rq_at_linked:1, /**< link into service's srv_at_array */
1007 rq_packed_final:1, /**< packed final reply */
1008 rq_obsolete:1; /* aborted by a signal on a client */
1011 /** one of RQ_PHASE_* */
1012 enum rq_phase rq_phase;
1013 /** one of RQ_PHASE_* to be used next */
1014 enum rq_phase rq_next_phase;
1016 * client-side refcount for SENT race, server-side refcounf
1017 * for multiple replies
1019 atomic_t rq_refcount;
1022 * !rq_truncate : # reply bytes actually received,
1023 * rq_truncate : required repbuf_len for resend
1025 int rq_nob_received;
1026 /** Request length */
1030 /** Pool if request is from preallocated list */
1031 struct ptlrpc_request_pool *rq_pool;
1032 /** Request message - what client sent */
1033 struct lustre_msg *rq_reqmsg;
1034 /** Reply message - server response */
1035 struct lustre_msg *rq_repmsg;
1036 /** Transaction number */
1040 /** bulk match bits */
1043 * List item to for replay list. Not yet committed requests get linked
1045 * Also see \a rq_replay comment above.
1046 * It's also link chain on obd_export::exp_req_replay_queue
1048 struct list_head rq_replay_list;
1049 /** non-shared members for client & server request*/
1051 struct ptlrpc_cli_req rq_cli;
1052 struct ptlrpc_srv_req rq_srv;
1055 * security and encryption data
1057 /** description of flavors for client & server */
1058 struct sptlrpc_flavor rq_flvr;
1061 * SELinux policy info at the time of the request
1062 * sepol string format is:
1063 * <mode>:<policy name>:<policy version>:<policy hash>
1065 char rq_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
1067 /* client/server security flags */
1069 rq_ctx_init:1, /* context initiation */
1070 rq_ctx_fini:1, /* context destroy */
1071 rq_bulk_read:1, /* request bulk read */
1072 rq_bulk_write:1, /* request bulk write */
1073 /* server authentication flags */
1074 rq_auth_gss:1, /* authenticated by gss */
1075 rq_auth_usr_root:1, /* authed as root */
1076 rq_auth_usr_mdt:1, /* authed as mdt */
1077 rq_auth_usr_ost:1, /* authed as ost */
1078 /* security tfm flags */
1081 /* doesn't expect reply FIXME */
1083 rq_pill_init:1, /* pill initialized */
1084 rq_srv_req:1; /* server request */
1087 /** various buffer pointers */
1088 struct lustre_msg *rq_reqbuf; /**< req wrapper, vmalloc*/
1089 char *rq_repbuf; /**< rep buffer, vmalloc */
1090 struct lustre_msg *rq_repdata; /**< rep wrapper msg */
1091 /** only in priv mode */
1092 struct lustre_msg *rq_clrbuf;
1093 int rq_reqbuf_len; /* req wrapper buf len */
1094 int rq_reqdata_len; /* req wrapper msg len */
1095 int rq_repbuf_len; /* rep buffer len */
1096 int rq_repdata_len; /* rep wrapper msg len */
1097 int rq_clrbuf_len; /* only in priv mode */
1098 int rq_clrdata_len; /* only in priv mode */
1100 /** early replies go to offset 0, regular replies go after that */
1101 unsigned int rq_reply_off;
1104 /** Fields that help to see if request and reply were swabbed or not */
1105 __u32 rq_req_swab_mask;
1106 __u32 rq_rep_swab_mask;
1108 /** how many early replies (for stats) */
1110 /** Server-side, export on which request was received */
1111 struct obd_export *rq_export;
1112 /** import where request is being sent */
1113 struct obd_import *rq_import;
1116 /** Peer description (the other side) */
1117 struct lnet_process_id rq_peer;
1118 /** Descriptor for the NID from which the peer sent the request. */
1119 struct lnet_process_id rq_source;
1121 * service time estimate (secs)
1122 * If the request is not served by this time, it is marked as timed out.
1123 * Do not change to time64_t since this is transmitted over the wire.
1125 * The linux kernel handles timestamps with time64_t and timeouts
1126 * are normally done with jiffies. Lustre shares the rq_timeout between
1127 * nodes. Since jiffies can vary from node to node Lustre instead
1128 * will express the timeout value in seconds. To avoid confusion with
1129 * timestamps (time64_t) and jiffy timeouts (long) Lustre timeouts
1130 * are expressed in s32 (timeout_t). Also what is transmitted over
1131 * the wire is 32 bits.
1133 timeout_t rq_timeout;
1135 * when request/reply sent (secs), or time when request should be sent
1138 /** when request must finish. */
1139 time64_t rq_deadline;
1140 /** request format description */
1141 struct req_capsule rq_pill;
1145 * Call completion handler for rpc if any, return it's status or original
1146 * rc if there was no handler defined for this request.
1148 static inline int ptlrpc_req_interpret(const struct lu_env *env,
1149 struct ptlrpc_request *req, int rc)
1151 if (req->rq_interpret_reply != NULL) {
1152 req->rq_status = req->rq_interpret_reply(env, req,
1153 &req->rq_async_args,
1155 return req->rq_status;
1164 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
1165 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
1166 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
1167 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
1168 struct ptlrpc_nrs_pol_info *info);
1171 * Can the request be moved from the regular NRS head to the high-priority NRS
1172 * head (of the same PTLRPC service partition), if any?
1174 * For a reliable result, this should be checked under svcpt->scp_req lock.
1176 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
1178 struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
1181 * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
1182 * request has been enqueued first, and ptlrpc_nrs_request::nr_started
1183 * to make sure it has not been scheduled yet (analogous to previous
1184 * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
1186 return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
1191 * Returns true if request buffer at offset \a index was already swabbed
1193 static inline bool lustre_req_swabbed(struct ptlrpc_request *req, size_t index)
1195 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1196 return req->rq_req_swab_mask & (1 << index);
1200 * Returns true if request reply buffer at offset \a index was already swabbed
1202 static inline bool lustre_rep_swabbed(struct ptlrpc_request *req, size_t index)
1204 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1205 return req->rq_rep_swab_mask & (1 << index);
1209 * Returns true if request needs to be swabbed into local cpu byteorder
1211 static inline bool ptlrpc_req_need_swab(struct ptlrpc_request *req)
1213 return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1217 * Returns true if request reply needs to be swabbed into local cpu byteorder
1219 static inline bool ptlrpc_rep_need_swab(struct ptlrpc_request *req)
1221 return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1225 * Mark request buffer at offset \a index that it was already swabbed
1227 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req,
1230 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1231 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
1232 req->rq_req_swab_mask |= 1 << index;
1236 * Mark request reply buffer at offset \a index that it was already swabbed
1238 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req,
1241 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1242 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
1243 req->rq_rep_swab_mask |= 1 << index;
1247 * Convert numerical request phase value \a phase into text string description
1249 static inline const char *
1250 ptlrpc_phase2str(enum rq_phase phase)
1259 case RQ_PHASE_INTERPRET:
1261 case RQ_PHASE_COMPLETE:
1263 case RQ_PHASE_UNREG_RPC:
1265 case RQ_PHASE_UNREG_BULK:
1273 * Convert numerical request phase of the request \a req into text stringi
1276 static inline const char *
1277 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1279 return ptlrpc_phase2str(req->rq_phase);
1283 * Debugging functions and helpers to print request structure into debug log
1286 /* Spare the preprocessor, spoil the bugs. */
1287 #define FLAG(field, str) (field ? str : "")
1289 /** Convert bit flags into a string */
1290 #define DEBUG_REQ_FLAGS(req) \
1291 ptlrpc_rqphase2str(req), \
1292 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
1293 FLAG(req->rq_err, "E"), FLAG(req->rq_net_err, "e"), \
1294 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
1295 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
1296 FLAG(req->rq_no_resend, "N"), FLAG(req->rq_no_reply, "n"), \
1297 FLAG(req->rq_waiting, "W"), \
1298 FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \
1299 FLAG(req->rq_committed, "M"), \
1300 FLAG(req->rq_req_unlinked, "Q"), \
1301 FLAG(req->rq_reply_unlinked, "U"), \
1302 FLAG(req->rq_receiving_reply, "r")
1304 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s"
1306 void _debug_req(struct ptlrpc_request *req,
1307 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1308 __attribute__ ((format (printf, 3, 4)));
1311 * Helper that decides if we need to print request accordig to current debug
1314 #define debug_req(msgdata, mask, cdls, req, fmt, a...) \
1316 CFS_CHECK_STACK(msgdata, mask, cdls); \
1318 if (((mask) & D_CANTMASK) != 0 || \
1319 ((libcfs_debug & (mask)) != 0 && \
1320 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1321 _debug_req((req), msgdata, fmt, ##a); \
1325 * This is the debug print function you need to use to print request sturucture
1326 * content into lustre debug log.
1327 * for most callers (level is a constant) this is resolved at compile time */
1328 #define DEBUG_REQ(level, req, fmt, args...) \
1330 if ((level) & (D_ERROR | D_WARNING)) { \
1331 static struct cfs_debug_limit_state cdls; \
1332 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1333 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1335 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1336 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
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_GET_SOURCE = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_GET,
1347 PTLRPC_BULK_PUT_SINK = PTLRPC_BULK_OP_PASSIVE | PTLRPC_BULK_OP_PUT,
1348 PTLRPC_BULK_GET_SINK = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_GET,
1349 PTLRPC_BULK_PUT_SOURCE = PTLRPC_BULK_OP_ACTIVE | PTLRPC_BULK_OP_PUT,
1352 static inline bool ptlrpc_is_bulk_op_get(enum ptlrpc_bulk_op_type type)
1354 return (type & PTLRPC_BULK_OP_GET) == PTLRPC_BULK_OP_GET;
1357 static inline bool ptlrpc_is_bulk_get_source(enum ptlrpc_bulk_op_type type)
1359 return (type & PTLRPC_BULK_GET_SOURCE) == PTLRPC_BULK_GET_SOURCE;
1362 static inline bool ptlrpc_is_bulk_put_sink(enum ptlrpc_bulk_op_type type)
1364 return (type & PTLRPC_BULK_PUT_SINK) == PTLRPC_BULK_PUT_SINK;
1367 static inline bool ptlrpc_is_bulk_get_sink(enum ptlrpc_bulk_op_type type)
1369 return (type & PTLRPC_BULK_GET_SINK) == PTLRPC_BULK_GET_SINK;
1372 static inline bool ptlrpc_is_bulk_put_source(enum ptlrpc_bulk_op_type type)
1374 return (type & PTLRPC_BULK_PUT_SOURCE) == PTLRPC_BULK_PUT_SOURCE;
1377 static inline bool ptlrpc_is_bulk_op_active(enum ptlrpc_bulk_op_type type)
1379 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1380 (type & PTLRPC_BULK_OP_PASSIVE))
1381 == PTLRPC_BULK_OP_ACTIVE;
1384 static inline bool ptlrpc_is_bulk_op_passive(enum ptlrpc_bulk_op_type type)
1386 return ((type & PTLRPC_BULK_OP_ACTIVE) |
1387 (type & PTLRPC_BULK_OP_PASSIVE))
1388 == PTLRPC_BULK_OP_PASSIVE;
1391 struct ptlrpc_bulk_frag_ops {
1393 * Add a page \a page to the bulk descriptor \a desc
1394 * Data to transfer in the page starts at offset \a pageoffset and
1395 * amount of data to transfer from the page is \a len
1397 void (*add_kiov_frag)(struct ptlrpc_bulk_desc *desc,
1398 struct page *page, int pageoffset, int len);
1401 * Add a \a fragment to the bulk descriptor \a desc.
1402 * Data to transfer in the fragment is pointed to by \a frag
1403 * The size of the fragment is \a len
1405 int (*add_iov_frag)(struct ptlrpc_bulk_desc *desc, void *frag, int len);
1408 * Uninitialize and free bulk descriptor \a desc.
1409 * Works on bulk descriptors both from server and client side.
1411 void (*release_frags)(struct ptlrpc_bulk_desc *desc);
1414 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops;
1415 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops;
1418 * Definition of bulk descriptor.
1419 * Bulks are special "Two phase" RPCs where initial request message
1420 * is sent first and it is followed bt a transfer (o receiving) of a large
1421 * amount of data to be settled into pages referenced from the bulk descriptors.
1422 * Bulks transfers (the actual data following the small requests) are done
1423 * on separate LNet portals.
1424 * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1425 * Another user is readpage for MDT.
1427 struct ptlrpc_bulk_desc {
1428 /** completed with failure */
1429 unsigned long bd_failure:1;
1431 unsigned long bd_registered:1;
1432 /** For serialization with callback */
1434 /** {put,get}{source,sink}{kvec,kiov} */
1435 enum ptlrpc_bulk_op_type bd_type;
1436 /** LNet portal for this bulk */
1438 /** Server side - export this bulk created for */
1439 struct obd_export *bd_export;
1440 /** Client side - import this bulk was sent on */
1441 struct obd_import *bd_import;
1442 /** Back pointer to the request */
1443 struct ptlrpc_request *bd_req;
1444 const struct ptlrpc_bulk_frag_ops *bd_frag_ops;
1445 wait_queue_head_t bd_waitq; /* server side only WQ */
1446 int bd_iov_count; /* # entries in bd_iov */
1447 int bd_max_iov; /* allocated size of bd_iov */
1448 int bd_nob; /* # bytes covered */
1449 int bd_nob_transferred; /* # bytes GOT/PUT */
1451 __u64 bd_last_mbits;
1453 struct ptlrpc_cb_id bd_cbid; /* network callback info */
1454 lnet_nid_t bd_sender; /* stash event::sender */
1455 int bd_md_count; /* # valid entries in bd_mds */
1456 int bd_md_max_brw; /* max entries in bd_mds */
1457 /** array of associated MDs */
1458 struct lnet_handle_md bd_mds[PTLRPC_BULK_OPS_COUNT];
1460 /* encrypted iov, size is either 0 or bd_iov_count. */
1461 struct bio_vec *bd_enc_vec;
1462 struct bio_vec *bd_vec;
1467 SVC_STOPPED = 1 << 0,
1468 SVC_STOPPING = 1 << 1,
1469 SVC_STARTING = 1 << 2,
1470 SVC_RUNNING = 1 << 3,
1473 #define PTLRPC_THR_NAME_LEN 32
1475 * Definition of server service thread structure
1477 struct ptlrpc_thread {
1479 * List of active threads in svcpt->scp_threads
1481 struct list_head t_link;
1483 * thread-private data (preallocated vmalloc'd memory)
1488 * service thread index, from ptlrpc_start_threads
1494 struct task_struct *t_task;
1498 * put watchdog in the structure per thread b=14840
1500 struct delayed_work t_watchdog;
1502 * the svc this thread belonged to b=18582
1504 struct ptlrpc_service_part *t_svcpt;
1505 wait_queue_head_t t_ctl_waitq;
1506 struct lu_env *t_env;
1507 char t_name[PTLRPC_THR_NAME_LEN];
1510 static inline int thread_is_init(struct ptlrpc_thread *thread)
1512 return thread->t_flags == 0;
1515 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1517 return !!(thread->t_flags & SVC_STOPPED);
1520 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1522 return !!(thread->t_flags & SVC_STOPPING);
1525 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1527 return !!(thread->t_flags & SVC_STARTING);
1530 static inline int thread_is_running(struct ptlrpc_thread *thread)
1532 return !!(thread->t_flags & SVC_RUNNING);
1535 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1537 thread->t_flags &= ~flags;
1540 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1542 thread->t_flags = flags;
1545 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1547 thread->t_flags |= flags;
1550 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1553 if (thread->t_flags & flags) {
1554 thread->t_flags &= ~flags;
1561 * Request buffer descriptor structure.
1562 * This is a structure that contains one posted request buffer for service.
1563 * Once data land into a buffer, event callback creates actual request and
1564 * notifies wakes one of the service threads to process new incoming request.
1565 * More than one request can fit into the buffer.
1567 struct ptlrpc_request_buffer_desc {
1568 /** Link item for rqbds on a service */
1569 struct list_head rqbd_list;
1570 /** History of requests for this buffer */
1571 struct list_head rqbd_reqs;
1572 /** Back pointer to service for which this buffer is registered */
1573 struct ptlrpc_service_part *rqbd_svcpt;
1574 /** LNet descriptor */
1575 struct lnet_handle_md rqbd_md_h;
1577 /** The buffer itself */
1579 struct ptlrpc_cb_id rqbd_cbid;
1581 * This "embedded" request structure is only used for the
1582 * last request to fit into the buffer
1584 struct ptlrpc_request rqbd_req;
1587 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
1589 struct ptlrpc_service_ops {
1591 * if non-NULL called during thread creation (ptlrpc_start_thread())
1592 * to initialize service specific per-thread state.
1594 int (*so_thr_init)(struct ptlrpc_thread *thr);
1596 * if non-NULL called during thread shutdown (ptlrpc_main()) to
1597 * destruct state created by ->srv_init().
1599 void (*so_thr_done)(struct ptlrpc_thread *thr);
1601 * Handler function for incoming requests for this service
1603 int (*so_req_handler)(struct ptlrpc_request *req);
1605 * function to determine priority of the request, it's called
1606 * on every new request
1608 int (*so_hpreq_handler)(struct ptlrpc_request *);
1610 * service-specific print fn
1612 void (*so_req_printer)(void *, struct ptlrpc_request *);
1615 #ifndef __cfs_cacheline_aligned
1616 /* NB: put it here for reducing patche dependence */
1617 # define __cfs_cacheline_aligned
1621 * How many high priority requests to serve before serving one normal
1624 #define PTLRPC_SVC_HP_RATIO 10
1627 * Definition of PortalRPC service.
1628 * The service is listening on a particular portal (like tcp port)
1629 * and perform actions for a specific server like IO service for OST
1630 * or general metadata service for MDS.
1632 struct ptlrpc_service {
1633 /** serialize /proc operations */
1634 spinlock_t srv_lock;
1635 /** most often accessed fields */
1636 /** chain thru all services */
1637 struct list_head srv_list;
1638 /** service operations table */
1639 struct ptlrpc_service_ops srv_ops;
1640 /** only statically allocated strings here; we don't clean them */
1642 /** only statically allocated strings here; we don't clean them */
1643 char *srv_thread_name;
1644 /** threads # should be created for each partition on initializing */
1645 int srv_nthrs_cpt_init;
1646 /** limit of threads number for each partition */
1647 int srv_nthrs_cpt_limit;
1648 /** Root of debugfs dir tree for this service */
1649 struct dentry *srv_debugfs_entry;
1650 /** Pointer to statistic data for this service */
1651 struct lprocfs_stats *srv_stats;
1652 /** # hp per lp reqs to handle */
1653 int srv_hpreq_ratio;
1654 /** biggest request to receive */
1655 int srv_max_req_size;
1656 /** biggest reply to send */
1657 int srv_max_reply_size;
1658 /** size of individual buffers */
1660 /** # buffers to allocate in 1 group */
1661 int srv_nbuf_per_group;
1662 /** Local portal on which to receive requests */
1663 __u32 srv_req_portal;
1664 /** Portal on the client to send replies to */
1665 __u32 srv_rep_portal;
1667 * Tags for lu_context associated with this thread, see struct
1671 /** soft watchdog timeout multiplier */
1672 int srv_watchdog_factor;
1673 /** under unregister_service */
1674 unsigned srv_is_stopping:1;
1675 /** Whether or not to restrict service threads to CPUs in this CPT */
1676 unsigned srv_cpt_bind:1;
1678 /** max # request buffers */
1680 /** max # request buffers in history per partition */
1681 int srv_hist_nrqbds_cpt_max;
1682 /** number of CPTs this service associated with */
1684 /** CPTs array this service associated with */
1686 /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
1688 /** CPT table this service is running over */
1689 struct cfs_cpt_table *srv_cptable;
1692 struct kobject srv_kobj;
1693 struct completion srv_kobj_unregister;
1695 * partition data for ptlrpc service
1697 struct ptlrpc_service_part *srv_parts[0];
1701 * Definition of PortalRPC service partition data.
1702 * Although a service only has one instance of it right now, but we
1703 * will have multiple instances very soon (instance per CPT).
1705 * it has four locks:
1707 * serialize operations on rqbd and requests waiting for preprocess
1709 * serialize operations active requests sent to this portal
1711 * serialize adaptive timeout stuff
1713 * serialize operations on RS list (reply states)
1715 * We don't have any use-case to take two or more locks at the same time
1716 * for now, so there is no lock order issue.
1718 struct ptlrpc_service_part {
1719 /** back reference to owner */
1720 struct ptlrpc_service *scp_service __cfs_cacheline_aligned;
1721 /* CPT id, reserved */
1723 /** always increasing number */
1725 /** # of starting threads */
1726 int scp_nthrs_starting;
1727 /** # running threads */
1728 int scp_nthrs_running;
1729 /** service threads list */
1730 struct list_head scp_threads;
1733 * serialize the following fields, used for protecting
1734 * rqbd list and incoming requests waiting for preprocess,
1735 * threads starting & stopping are also protected by this lock.
1737 spinlock_t scp_lock __cfs_cacheline_aligned;
1738 /** userland serialization */
1739 struct mutex scp_mutex;
1740 /** total # req buffer descs allocated */
1741 int scp_nrqbds_total;
1742 /** # posted request buffers for receiving */
1743 int scp_nrqbds_posted;
1744 /** in progress of allocating rqbd */
1745 int scp_rqbd_allocating;
1746 /** # incoming reqs */
1747 int scp_nreqs_incoming;
1748 /** request buffers to be reposted */
1749 struct list_head scp_rqbd_idle;
1750 /** req buffers receiving */
1751 struct list_head scp_rqbd_posted;
1752 /** incoming reqs */
1753 struct list_head scp_req_incoming;
1754 /** timeout before re-posting reqs, in jiffies */
1755 long scp_rqbd_timeout;
1757 * all threads sleep on this. This wait-queue is signalled when new
1758 * incoming request arrives and when difficult reply has to be handled.
1760 wait_queue_head_t scp_waitq;
1762 /** request history */
1763 struct list_head scp_hist_reqs;
1764 /** request buffer history */
1765 struct list_head scp_hist_rqbds;
1766 /** # request buffers in history */
1767 int scp_hist_nrqbds;
1768 /** sequence number for request */
1770 /** highest seq culled from history */
1771 __u64 scp_hist_seq_culled;
1774 * serialize the following fields, used for processing requests
1775 * sent to this portal
1777 spinlock_t scp_req_lock __cfs_cacheline_aligned;
1778 /** # reqs in either of the NRS heads below */
1779 /** # reqs being served */
1780 int scp_nreqs_active;
1781 /** # HPreqs being served */
1782 int scp_nhreqs_active;
1783 /** # hp requests handled */
1786 /** NRS head for regular requests */
1787 struct ptlrpc_nrs scp_nrs_reg;
1788 /** NRS head for HP requests; this is only valid for services that can
1789 * handle HP requests */
1790 struct ptlrpc_nrs *scp_nrs_hp;
1795 * serialize the following fields, used for changes on
1798 spinlock_t scp_at_lock __cfs_cacheline_aligned;
1799 /** estimated rpc service time */
1800 struct adaptive_timeout scp_at_estimate;
1801 /** reqs waiting for replies */
1802 struct ptlrpc_at_array scp_at_array;
1803 /** early reply timer */
1804 struct timer_list scp_at_timer;
1806 ktime_t scp_at_checktime;
1807 /** check early replies */
1808 unsigned scp_at_check;
1812 * serialize the following fields, used for processing
1813 * replies for this portal
1815 spinlock_t scp_rep_lock __cfs_cacheline_aligned;
1816 /** all the active replies */
1817 struct list_head scp_rep_active;
1818 /** List of free reply_states */
1819 struct list_head scp_rep_idle;
1820 /** waitq to run, when adding stuff to srv_free_rs_list */
1821 wait_queue_head_t scp_rep_waitq;
1822 /** # 'difficult' replies */
1823 atomic_t scp_nreps_difficult;
1826 #define ptlrpc_service_for_each_part(part, i, svc) \
1828 i < (svc)->srv_ncpts && \
1829 (svc)->srv_parts != NULL && \
1830 ((part) = (svc)->srv_parts[i]) != NULL; i++)
1833 * Declaration of ptlrpcd control structure
1835 struct ptlrpcd_ctl {
1837 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1839 unsigned long pc_flags;
1841 * Thread lock protecting structure fields.
1847 struct completion pc_starting;
1851 struct completion pc_finishing;
1853 * Thread requests set.
1855 struct ptlrpc_request_set *pc_set;
1857 * Thread name used in kthread_run()
1861 * CPT the thread is bound on.
1865 * Index of ptlrpcd thread in the array.
1869 * Pointer to the array of partners' ptlrpcd_ctl structure.
1871 struct ptlrpcd_ctl **pc_partners;
1873 * Number of the ptlrpcd's partners.
1877 * Record the partner index to be processed next.
1881 * Error code if the thread failed to fully start.
1886 /* Bits for pc_flags */
1887 enum ptlrpcd_ctl_flags {
1889 * Ptlrpc thread start flag.
1891 LIOD_START = 1 << 0,
1893 * Ptlrpc thread stop flag.
1897 * Ptlrpc thread force flag (only stop force so far).
1898 * This will cause aborting any inflight rpcs handled
1899 * by thread if LIOD_STOP is specified.
1901 LIOD_FORCE = 1 << 2,
1903 * This is a recovery ptlrpc thread.
1905 LIOD_RECOVERY = 1 << 3,
1912 * Service compatibility function; the policy is compatible with all services.
1914 * \param[in] svc The service the policy is attempting to register with.
1915 * \param[in] desc The policy descriptor
1917 * \retval true The policy is compatible with the service
1919 * \see ptlrpc_nrs_pol_desc::pd_compat()
1921 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
1922 const struct ptlrpc_nrs_pol_desc *desc)
1928 * Service compatibility function; the policy is compatible with only a specific
1929 * service which is identified by its human-readable name at
1930 * ptlrpc_service::srv_name.
1932 * \param[in] svc The service the policy is attempting to register with.
1933 * \param[in] desc The policy descriptor
1935 * \retval false The policy is not compatible with the service
1936 * \retval true The policy is compatible with the service
1938 * \see ptlrpc_nrs_pol_desc::pd_compat()
1940 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
1941 const struct ptlrpc_nrs_pol_desc *desc)
1943 LASSERT(desc->pd_compat_svc_name != NULL);
1944 return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
1949 /* ptlrpc/events.c */
1950 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
1951 struct lnet_process_id *peer, lnet_nid_t *self);
1953 * These callbacks are invoked by LNet when something happened to
1957 extern void request_out_callback(struct lnet_event *ev);
1958 extern void reply_in_callback(struct lnet_event *ev);
1959 extern void client_bulk_callback(struct lnet_event *ev);
1960 extern void request_in_callback(struct lnet_event *ev);
1961 extern void reply_out_callback(struct lnet_event *ev);
1962 #ifdef HAVE_SERVER_SUPPORT
1963 extern void server_bulk_callback(struct lnet_event *ev);
1967 /* ptlrpc/connection.c */
1968 struct ptlrpc_connection *ptlrpc_connection_get(struct lnet_process_id peer,
1970 struct obd_uuid *uuid);
1971 int ptlrpc_connection_put(struct ptlrpc_connection *c);
1972 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
1973 int ptlrpc_connection_init(void);
1974 void ptlrpc_connection_fini(void);
1975 extern lnet_pid_t ptl_get_pid(void);
1978 * Check if the peer connection is on the local node. We need to use GFP_NOFS
1979 * for requests from a local client to avoid recursing into the filesystem
1980 * as we might end up waiting on a page sent in the request we're serving.
1982 * Use __GFP_HIGHMEM so that the pages can use all of the available memory
1983 * on 32-bit machines. Use more aggressive GFP_HIGHUSER flags from non-local
1984 * clients to be able to generate more memory pressure on the OSS and allow
1985 * inactive pages to be reclaimed, since it doesn't have any other processes
1986 * or allocations that generate memory reclaim pressure.
1988 * See b=17576 (bdf50dc9) and b=19529 (3dcf18d3) for details.
1990 static inline bool ptlrpc_connection_is_local(struct ptlrpc_connection *conn)
1995 if (conn->c_peer.nid == conn->c_self)
1998 RETURN(LNetIsPeerLocal(conn->c_peer.nid));
2001 /* ptlrpc/niobuf.c */
2003 * Actual interfacing with LNet to put/get/register/unregister stuff
2006 #ifdef HAVE_SERVER_SUPPORT
2007 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2008 unsigned nfrags, unsigned max_brw,
2011 const struct ptlrpc_bulk_frag_ops
2013 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2014 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2016 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2020 LASSERT(desc != NULL);
2022 spin_lock(&desc->bd_lock);
2023 rc = desc->bd_md_count;
2024 spin_unlock(&desc->bd_lock);
2029 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2030 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2032 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2034 struct ptlrpc_bulk_desc *desc;
2037 LASSERT(req != NULL);
2038 desc = req->rq_bulk;
2043 if (req->rq_bulk_deadline > ktime_get_real_seconds())
2047 spin_lock(&desc->bd_lock);
2048 rc = desc->bd_md_count;
2049 spin_unlock(&desc->bd_lock);
2053 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2054 #define PTLRPC_REPLY_EARLY 0x02
2055 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2056 int ptlrpc_reply(struct ptlrpc_request *req);
2057 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2058 int ptlrpc_error(struct ptlrpc_request *req);
2059 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2060 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2061 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2064 /* ptlrpc/client.c */
2066 * Client-side portals API. Everything to send requests, receive replies,
2067 * request queues, request management, etc.
2070 void ptlrpc_request_committed(struct ptlrpc_request *req, int force);
2072 void ptlrpc_init_client(int req_portal, int rep_portal, const char *name,
2073 struct ptlrpc_client *);
2074 void ptlrpc_cleanup_client(struct obd_import *imp);
2075 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
2076 lnet_nid_t nid4refnet);
2078 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2079 int ptlrpc_replay_req(struct ptlrpc_request *req);
2080 void ptlrpc_restart_req(struct ptlrpc_request *req);
2081 void ptlrpc_abort_inflight(struct obd_import *imp);
2082 void ptlrpc_cleanup_imp(struct obd_import *imp);
2083 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2085 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2086 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2088 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2089 int ptlrpc_set_wait(const struct lu_env *env, struct ptlrpc_request_set *);
2090 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2091 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2092 #define PTLRPCD_SET ((struct ptlrpc_request_set *)1)
2094 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2095 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2097 struct ptlrpc_request_pool *
2098 ptlrpc_init_rq_pool(int, int,
2099 int (*populate_pool)(struct ptlrpc_request_pool *, int));
2101 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2102 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2103 const struct req_format *format);
2104 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2105 struct ptlrpc_request_pool *,
2106 const struct req_format *format);
2107 void ptlrpc_request_free(struct ptlrpc_request *request);
2108 int ptlrpc_request_pack(struct ptlrpc_request *request,
2109 __u32 version, int opcode);
2110 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2111 const struct req_format *format,
2112 __u32 version, int opcode);
2113 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2114 __u32 version, int opcode, char **bufs,
2115 struct ptlrpc_cli_ctx *ctx);
2116 void ptlrpc_req_finished(struct ptlrpc_request *request);
2117 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2118 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2119 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2120 unsigned nfrags, unsigned max_brw,
2123 const struct ptlrpc_bulk_frag_ops
2126 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2127 struct page *page, int pageoffset, int len,
2130 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
2132 static inline void ptlrpc_release_bulk_noop(struct ptlrpc_bulk_desc *desc)
2136 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2137 struct obd_import *imp);
2138 __u64 ptlrpc_next_xid(void);
2139 __u64 ptlrpc_sample_next_xid(void);
2140 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
2141 void ptlrpc_get_mod_rpc_slot(struct ptlrpc_request *req);
2142 void ptlrpc_put_mod_rpc_slot(struct ptlrpc_request *req);
2144 /* Set of routines to run a function in ptlrpcd context */
2145 void *ptlrpcd_alloc_work(struct obd_import *imp,
2146 int (*cb)(const struct lu_env *, void *), void *data);
2147 void ptlrpcd_destroy_work(void *handler);
2148 int ptlrpcd_queue_work(void *handler);
2151 struct ptlrpc_service_buf_conf {
2152 /* nbufs is buffers # to allocate when growing the pool */
2153 unsigned int bc_nbufs;
2154 /* buffer size to post */
2155 unsigned int bc_buf_size;
2156 /* portal to listed for requests on */
2157 unsigned int bc_req_portal;
2158 /* portal of where to send replies to */
2159 unsigned int bc_rep_portal;
2160 /* maximum request size to be accepted for this service */
2161 unsigned int bc_req_max_size;
2162 /* maximum reply size this service can ever send */
2163 unsigned int bc_rep_max_size;
2166 struct ptlrpc_service_thr_conf {
2167 /* threadname should be 8 characters or less - 6 will be added on */
2169 /* threads increasing factor for each CPU */
2170 unsigned int tc_thr_factor;
2171 /* service threads # to start on each partition while initializing */
2172 unsigned int tc_nthrs_init;
2174 * low water of threads # upper-limit on each partition while running,
2175 * service availability may be impacted if threads number is lower
2176 * than this value. It can be ZERO if the service doesn't require
2177 * CPU affinity or there is only one partition.
2179 unsigned int tc_nthrs_base;
2180 /* "soft" limit for total threads number */
2181 unsigned int tc_nthrs_max;
2182 /* user specified threads number, it will be validated due to
2183 * other members of this structure. */
2184 unsigned int tc_nthrs_user;
2185 /* bind service threads to only CPUs in their associated CPT */
2186 unsigned int tc_cpu_bind;
2187 /* Tags for lu_context associated with service thread */
2191 struct ptlrpc_service_cpt_conf {
2192 struct cfs_cpt_table *cc_cptable;
2193 /* string pattern to describe CPTs for a service */
2195 /* whether or not to have per-CPT service partitions */
2199 struct ptlrpc_service_conf {
2202 /* soft watchdog timeout multiplifier to print stuck service traces */
2203 unsigned int psc_watchdog_factor;
2204 /* buffer information */
2205 struct ptlrpc_service_buf_conf psc_buf;
2206 /* thread information */
2207 struct ptlrpc_service_thr_conf psc_thr;
2208 /* CPU partition information */
2209 struct ptlrpc_service_cpt_conf psc_cpt;
2210 /* function table */
2211 struct ptlrpc_service_ops psc_ops;
2214 /* ptlrpc/service.c */
2216 * Server-side services API. Register/unregister service, request state
2217 * management, service thread management
2221 void ptlrpc_save_lock(struct ptlrpc_request *req, struct lustre_handle *lock,
2222 int mode, bool no_ack, bool convert_lock);
2223 void ptlrpc_commit_replies(struct obd_export *exp);
2224 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
2225 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
2226 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
2227 struct ptlrpc_service *ptlrpc_register_service(
2228 struct ptlrpc_service_conf *conf,
2229 struct kset *parent,
2230 struct dentry *debugfs_entry);
2231 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
2233 int ptlrpc_start_threads(struct ptlrpc_service *svc);
2234 int ptlrpc_unregister_service(struct ptlrpc_service *service);
2235 int ptlrpc_service_health_check(struct ptlrpc_service *);
2236 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
2237 void ptlrpc_request_change_export(struct ptlrpc_request *req,
2238 struct obd_export *export);
2239 void ptlrpc_update_export_timer(struct obd_export *exp,
2240 time64_t extra_delay);
2242 int ptlrpc_hr_init(void);
2243 void ptlrpc_hr_fini(void);
2247 /* ptlrpc/import.c */
2252 int ptlrpc_connect_import(struct obd_import *imp);
2253 int ptlrpc_connect_import_locked(struct obd_import *imp);
2254 int ptlrpc_init_import(struct obd_import *imp);
2255 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
2256 int ptlrpc_disconnect_and_idle_import(struct obd_import *imp);
2257 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
2258 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
2260 void ptlrpc_import_enter_resend(struct obd_import *imp);
2261 /* ptlrpc/pack_generic.c */
2262 int ptlrpc_reconnect_import(struct obd_import *imp);
2266 * ptlrpc msg buffer and swab interface
2270 #define PTLRPC_MAX_BUFCOUNT \
2271 (sizeof(((struct ptlrpc_request *)0)->rq_req_swab_mask) * 8)
2272 #define MD_MAX_BUFLEN (MDS_REG_MAXREQSIZE > OUT_MAXREQSIZE ? \
2273 MDS_REG_MAXREQSIZE : OUT_MAXREQSIZE)
2274 #define PTLRPC_MAX_BUFLEN (OST_IO_MAXREQSIZE > MD_MAX_BUFLEN ? \
2275 OST_IO_MAXREQSIZE : MD_MAX_BUFLEN)
2276 bool ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
2278 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
2280 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
2281 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
2283 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
2284 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
2286 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
2287 __u32 *lens, char **bufs);
2288 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
2290 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
2291 __u32 *lens, char **bufs, int flags);
2292 #define LPRFL_EARLY_REPLY 1
2293 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
2294 char **bufs, int flags);
2295 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
2296 unsigned int newlen, int move_data);
2297 int lustre_grow_msg(struct lustre_msg *msg, int segment, unsigned int newlen);
2298 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
2299 int __lustre_unpack_msg(struct lustre_msg *m, int len);
2300 __u32 lustre_msg_hdr_size(__u32 magic, __u32 count);
2301 __u32 lustre_msg_size(__u32 magic, int count, __u32 *lengths);
2302 __u32 lustre_msg_size_v2(int count, __u32 *lengths);
2303 __u32 lustre_packed_msg_size(struct lustre_msg *msg);
2304 __u32 lustre_msg_early_size(void);
2305 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, __u32 n, __u32 min_size);
2306 void *lustre_msg_buf(struct lustre_msg *m, __u32 n, __u32 minlen);
2307 __u32 lustre_msg_buflen(struct lustre_msg *m, __u32 n);
2308 void lustre_msg_set_buflen(struct lustre_msg *m, __u32 n, __u32 len);
2309 __u32 lustre_msg_bufcount(struct lustre_msg *m);
2310 char *lustre_msg_string(struct lustre_msg *m, __u32 n, __u32 max_len);
2311 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
2312 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
2313 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
2314 void lustre_msg_add_flags(struct lustre_msg *msg, __u32 flags);
2315 void lustre_msg_set_flags(struct lustre_msg *msg, __u32 flags);
2316 void lustre_msg_clear_flags(struct lustre_msg *msg, __u32 flags);
2317 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
2318 void lustre_msg_add_op_flags(struct lustre_msg *msg, __u32 flags);
2319 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
2320 __u32 lustre_msg_get_type(struct lustre_msg *msg);
2321 enum lustre_msg_version lustre_msg_get_version(struct lustre_msg *msg);
2322 void lustre_msg_add_version(struct lustre_msg *msg, __u32 version);
2323 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
2324 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
2325 __u16 lustre_msg_get_tag(struct lustre_msg *msg);
2326 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
2327 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
2328 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
2329 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
2330 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
2331 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
2332 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
2333 int lustre_msg_get_status(struct lustre_msg *msg);
2334 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
2335 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
2336 timeout_t lustre_msg_get_timeout(struct lustre_msg *msg);
2337 timeout_t lustre_msg_get_service_timeout(struct lustre_msg *msg);
2338 char *lustre_msg_get_jobid(struct lustre_msg *msg);
2339 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
2340 __u64 lustre_msg_get_mbits(struct lustre_msg *msg);
2341 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
2342 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
2343 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
2344 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
2345 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
2346 void lustre_msg_set_tag(struct lustre_msg *msg, __u16 tag);
2347 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
2348 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
2349 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
2350 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
2351 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
2352 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
2353 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
2354 void lustre_msg_set_timeout(struct lustre_msg *msg, timeout_t timeout);
2355 void lustre_msg_set_service_timeout(struct lustre_msg *msg,
2356 timeout_t service_timeout);
2357 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
2358 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
2359 void lustre_msg_set_mbits(struct lustre_msg *msg, __u64 mbits);
2362 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
2363 unsigned int newlen, int move_data)
2365 LASSERT(req->rq_reply_state);
2366 LASSERT(req->rq_repmsg);
2367 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2371 #ifdef LUSTRE_TRANSLATE_ERRNOS
2373 static inline int ptlrpc_status_hton(int h)
2376 * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
2377 * ELDLM_LOCK_ABORTED, etc.
2380 return -lustre_errno_hton(-h);
2385 static inline int ptlrpc_status_ntoh(int n)
2388 * See the comment in ptlrpc_status_hton().
2391 return -lustre_errno_ntoh(-n);
2398 #define ptlrpc_status_hton(h) (h)
2399 #define ptlrpc_status_ntoh(n) (n)
2404 /** Change request phase of \a req to \a new_phase */
2406 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2408 if (req->rq_phase == new_phase)
2411 if (new_phase == RQ_PHASE_UNREG_RPC ||
2412 new_phase == RQ_PHASE_UNREG_BULK) {
2413 /* No embedded unregistering phases */
2414 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2415 req->rq_phase == RQ_PHASE_UNREG_BULK)
2418 req->rq_next_phase = req->rq_phase;
2420 atomic_inc(&req->rq_import->imp_unregistering);
2423 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2424 req->rq_phase == RQ_PHASE_UNREG_BULK) {
2426 atomic_dec(&req->rq_import->imp_unregistering);
2429 DEBUG_REQ(D_INFO, req, "move request phase from %s to %s",
2430 ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2432 req->rq_phase = new_phase;
2436 * Returns true if request \a req got early reply and hard deadline is not met
2439 ptlrpc_client_early(struct ptlrpc_request *req)
2441 return req->rq_early;
2445 * Returns true if we got real reply from server for this request
2448 ptlrpc_client_replied(struct ptlrpc_request *req)
2450 if (req->rq_reply_deadline > ktime_get_real_seconds())
2452 return req->rq_replied;
2455 /** Returns true if request \a req is in process of receiving server reply */
2457 ptlrpc_client_recv(struct ptlrpc_request *req)
2459 if (req->rq_reply_deadline > ktime_get_real_seconds())
2461 return req->rq_receiving_reply;
2465 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2469 spin_lock(&req->rq_lock);
2470 if (req->rq_reply_deadline > ktime_get_real_seconds()) {
2471 spin_unlock(&req->rq_lock);
2474 if (req->rq_req_deadline > ktime_get_real_seconds()) {
2475 spin_unlock(&req->rq_lock);
2479 rc = !req->rq_req_unlinked || !req->rq_reply_unlinked ||
2480 req->rq_receiving_reply;
2481 spin_unlock(&req->rq_lock);
2486 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2489 if (req->rq_set == NULL)
2490 wake_up(&req->rq_reply_waitq);
2492 wake_up(&req->rq_set->set_waitq);
2496 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2498 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2499 atomic_inc(&rs->rs_refcount);
2503 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2505 LASSERT(atomic_read(&rs->rs_refcount) > 0);
2506 if (atomic_dec_and_test(&rs->rs_refcount))
2507 lustre_free_reply_state(rs);
2510 /* Should only be called once per req */
2511 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2513 if (req->rq_reply_state == NULL)
2514 return; /* shouldn't occur */
2515 ptlrpc_rs_decref(req->rq_reply_state);
2516 req->rq_reply_state = NULL;
2517 req->rq_repmsg = NULL;
2520 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2522 return lustre_msg_get_magic(req->rq_reqmsg);
2525 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2527 switch (req->rq_reqmsg->lm_magic) {
2528 case LUSTRE_MSG_MAGIC_V2:
2529 return req->rq_reqmsg->lm_repsize;
2531 LASSERTF(0, "incorrect message magic: %08x\n",
2532 req->rq_reqmsg->lm_magic);
2537 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2539 if (req->rq_delay_limit != 0 &&
2540 req->rq_queued_time + req->rq_delay_limit < ktime_get_seconds())
2545 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2547 if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2548 spin_lock(&req->rq_lock);
2549 req->rq_no_resend = 1;
2550 spin_unlock(&req->rq_lock);
2552 return req->rq_no_resend;
2556 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
2558 int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
2560 return svcpt->scp_service->srv_watchdog_factor *
2561 max_t(int, at, obd_timeout);
2565 * Calculate the amount of time for lock prolongation.
2567 * This is helper function to get the timeout extra time.
2569 * @req current request
2571 * Return: amount of time to extend the timeout with
2573 static inline timeout_t prolong_timeout(struct ptlrpc_request *req)
2575 struct ptlrpc_service_part *svcpt = req->rq_rqbd->rqbd_svcpt;
2576 timeout_t req_timeout = 0;
2579 return obd_timeout / 2;
2581 if (req->rq_deadline > req->rq_arrival_time.tv_sec)
2582 req_timeout = req->rq_deadline - req->rq_arrival_time.tv_sec;
2584 return max(req_timeout,
2585 at_est2timeout(at_get(&svcpt->scp_at_estimate)));
2588 static inline struct ptlrpc_service *
2589 ptlrpc_req2svc(struct ptlrpc_request *req)
2591 LASSERT(req->rq_rqbd != NULL);
2592 return req->rq_rqbd->rqbd_svcpt->scp_service;
2595 /* ldlm/ldlm_lib.c */
2597 * Target client logic
2600 int client_obd_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
2601 int client_obd_cleanup(struct obd_device *obd);
2602 int client_connect_import(const struct lu_env *env,
2603 struct obd_export **exp, struct obd_device *obd,
2604 struct obd_uuid *cluuid, struct obd_connect_data *,
2606 int client_disconnect_export(struct obd_export *exp);
2607 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
2609 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
2610 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
2611 struct obd_uuid *uuid);
2612 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
2613 void client_destroy_import(struct obd_import *imp);
2616 #ifdef HAVE_SERVER_SUPPORT
2617 int server_disconnect_export(struct obd_export *exp);
2620 /* ptlrpc/pinger.c */
2622 * Pinger API (client side only)
2625 enum timeout_event {
2628 struct timeout_item;
2629 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
2630 int ptlrpc_pinger_add_import(struct obd_import *imp);
2631 int ptlrpc_pinger_del_import(struct obd_import *imp);
2632 int ptlrpc_add_timeout_client(time64_t time, enum timeout_event event,
2633 timeout_cb_t cb, void *data,
2634 struct list_head *obd_list);
2635 int ptlrpc_del_timeout_client(struct list_head *obd_list,
2636 enum timeout_event event);
2637 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
2638 int ptlrpc_obd_ping(struct obd_device *obd);
2639 void ping_evictor_start(void);
2640 void ping_evictor_stop(void);
2641 void ptlrpc_pinger_ir_up(void);
2642 void ptlrpc_pinger_ir_down(void);
2644 int ptlrpc_pinger_suppress_pings(void);
2646 /* ptlrpc/ptlrpcd.c */
2647 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
2648 void ptlrpcd_free(struct ptlrpcd_ctl *pc);
2649 void ptlrpcd_wake(struct ptlrpc_request *req);
2650 void ptlrpcd_add_req(struct ptlrpc_request *req);
2651 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
2652 int ptlrpcd_addref(void);
2653 void ptlrpcd_decref(void);
2655 /* ptlrpc/lproc_ptlrpc.c */
2657 * procfs output related functions
2660 const char* ll_opcode2str(__u32 opcode);
2661 const int ll_str2opcode(const char *ops);
2662 #ifdef CONFIG_PROC_FS
2663 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
2664 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
2665 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
2667 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
2668 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
2669 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
2673 /* ptlrpc/llog_server.c */
2674 int llog_origin_handle_open(struct ptlrpc_request *req);
2675 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
2676 int llog_origin_handle_next_block(struct ptlrpc_request *req);
2677 int llog_origin_handle_read_header(struct ptlrpc_request *req);
2679 /* ptlrpc/llog_client.c */
2680 extern struct llog_operations llog_client_ops;