Whamcloud - gitweb
6c9f530e4945a8d3bdfd5598e68a09550983b976
[fs/lustre-release.git] / lustre / include / lustre_net.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2010, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32 /** \defgroup PtlRPC Portal RPC and networking module.
33  *
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.
39  *
40  * PortalRPC utilizes LNet as its transport layer.
41  *
42  * @{
43  */
44
45
46 #ifndef _LUSTRE_NET_H
47 #define _LUSTRE_NET_H
48
49 /** \defgroup net net
50  *
51  * @{
52  */
53 #include <linux/kobject.h>
54 #include <linux/uio.h>
55 #include <libcfs/libcfs.h>
56 #include <lnet/nidstr.h>
57 #include <lnet/api.h>
58 #include <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 <lustre_ver.h>
67
68 /* MD flags we _always_ use */
69 #define PTLRPC_MD_OPTIONS  0
70
71 /**
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."
81 #endif
82 #define PTLRPC_BULK_OPS_COUNT   (1U << PTLRPC_BULK_OPS_BITS)
83 /**
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
89  * RPC count. */
90 #define PTLRPC_BULK_OPS_MASK    (~((__u64)PTLRPC_BULK_OPS_COUNT - 1))
91
92 /**
93  * Define maxima for bulk I/O.
94  *
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.
98  */
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)
102
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)
110
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"
114 #endif
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"
117 #endif
118 #if (PTLRPC_MAX_BRW_SIZE > LNET_MTU * PTLRPC_BULK_OPS_COUNT)
119 # error "PTLRPC_MAX_BRW_SIZE too big"
120 #endif
121 #if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV * PTLRPC_BULK_OPS_COUNT)
122 # error "PTLRPC_MAX_BRW_PAGES too big"
123 #endif
124
125 #define PTLRPC_NTHRS_INIT       2
126
127 /**
128  * Buffer Constants
129  *
130  * Constants determine how memory is used to buffer incoming service requests.
131  *
132  * ?_NBUFS              # buffers to allocate when growing the pool
133  * ?_BUFSIZE            # bytes in a single request buffer
134  * ?_MAXREQSIZE         # maximum request service will receive
135  *
136  * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
137  * of ?_NBUFS is added to the pool.
138  *
139  * Messages larger than ?_MAXREQSIZE are dropped.  Request buffers are
140  * considered full when less than ?_MAXREQSIZE is left in them.
141  */
142 /**
143  * Thread Constants
144  *
145  * Constants determine how threads are created for ptlrpc service.
146  *
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.
166  *
167  * Examples
168  *
169  * #define MDS_NTHRS_INIT       2
170  * #define MDS_NTHRS_BASE       64
171  * #define MDS_NTHRS_FACTOR     8
172  * #define MDS_NTHRS_MAX        1024
173  *
174  * Example 1):
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
178  * partition is:
179  *     MDS_NTHRS_BASE(64) + cores(4) * MDS_NTHRS_FACTOR(8) = 96
180  *
181  * Total number of threads for the service is:
182  *     96 * partitions(4) = 384
183  *
184  * Example 2):
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
188  * partition is:
189  *     MDS_NTHRS_BASE(64) + cores(8) * MDS_NTHRS_FACTOR(8) = 128
190  *
191  * Total number of threads for the service is:
192  *     128 * partitions(4) = 512
193  *
194  * Example 3):
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
198  * partition is:
199  *     MDS_NTHRS_BASE(64) + cores(12) * MDS_NTHRS_FACTOR(8) = 160
200  *
201  * Total number of threads for the service is:
202  *     160 * partitions(8) = 1280
203  *
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
207  *
208  * Example 4):
209  * ---------------------------------------------------------------------
210  * Server(C) have a thousand of cores and user configured it to 32 partitions
211  *     MDS_NTHRS_BASE(64) * 32 = 2048
212  *
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.
216  *
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.
220  *
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
224  *        top of this subset
225  *     b) bind service threads on a few partitions, see modparameters of
226  *        MDS and OSS for details
227 *
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.
231  *
232  */
233
234  /*
235   * LDLM threads constants:
236   *
237   * Given 8 as factor and 24 as base threads number
238   *
239   * example 1)
240   * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
241   *
242   * example 2)
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.
245   *
246   * example 3)
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.
250   *
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
253   */
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)
258
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)
265
266  /*
267   * MDS threads constants:
268   *
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.
271   */
272 #ifndef MDS_MAX_THREADS
273 #define MDS_MAX_THREADS         1024
274 #define MDS_MAX_OTHR_THREADS    256
275
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
280 #endif
281 #define MDS_MAX_OTHR_THREADS    max(PTLRPC_NTHRS_INIT, MDS_MAX_THREADS / 2)
282 #endif
283
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)
289
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)
295
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)
301
302 /* non-affinity threads */
303 #define MDS_OTHR_NTHRS_INIT     PTLRPC_NTHRS_INIT
304 #define MDS_OTHR_NTHRS_MAX      MDS_MAX_OTHR_THREADS
305
306 #define MDS_NBUFS               64
307
308 /**
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
319  *
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
323  *
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.
326  */
327 #define MDS_MAXREQSIZE          (5 * 1024)      /* >= 4736 */
328 #define MDS_MAXREPSIZE          (9 * 1024)      /* >= 8300 */
329
330 /**
331  * MDS incoming request with LOV EA
332  * 24 = sizeof(struct lov_ost_data), i.e: replay of opencreate
333  */
334 #define MDS_LOV_MAXREQSIZE      max(MDS_MAXREQSIZE, \
335                                     362 + LOV_MAX_STRIPE_COUNT * 24)
336 /**
337  * MDS outgoing reply with LOV EA
338  *
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
341  *
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.
344  */
345 #define MDS_LOV_MAXREPSIZE      MDS_LOV_MAXREQSIZE
346
347 /**
348  * This is the size of a maximum REINT_SETXATTR request:
349  *
350  *   lustre_msg          56 (32 + 4 x 5 + 4)
351  *   ptlrpc_body        184
352  *   mdt_rec_setxattr   136
353  *   lustre_capa        120
354  *   name               256 (XATTR_NAME_MAX)
355  *   value            65536 (XATTR_SIZE_MAX)
356  */
357 #define MDS_EA_MAXREQSIZE       66288
358
359 /**
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.
362  */
363 #define MDS_REG_MAXREQSIZE      (((max(MDS_EA_MAXREQSIZE, \
364                                        MDS_LOV_MAXREQSIZE) + 1023) >> 10) << 10)
365 #define MDS_REG_MAXREPSIZE      MDS_REG_MAXREQSIZE
366
367 /**
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
371  */
372 #define OUT_MAXREQSIZE  (1000 * 1024)
373 #define OUT_MAXREPSIZE  MDS_MAXREPSIZE
374
375 /** MDS_BUFSIZE = max_reqsize (w/o LOV EA) + max sptlrpc payload size */
376 #define MDS_BUFSIZE             max(MDS_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
377                                     8 * 1024)
378
379 /**
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.
387  *
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.
394  */
395 #define MDS_REG_BUFSIZE         max(MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
396                                     160 * 1024)
397
398 /**
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.
402   */
403 #define OUT_BUFSIZE             max(OUT_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
404                                     24 * 1024)
405
406 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
407 #define FLD_MAXREQSIZE  (160)
408
409 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
410 #define FLD_MAXREPSIZE  (152)
411 #define FLD_BUFSIZE     (1 << 12)
412
413 /**
414  * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
415  * __u32 padding */
416 #define SEQ_MAXREQSIZE  (160)
417
418 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
419 #define SEQ_MAXREPSIZE  (152)
420 #define SEQ_BUFSIZE     (1 << 12)
421
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
425
426 #define MGS_NBUFS       64
427 #define MGS_BUFSIZE     (8 * 1024)
428 #define MGS_MAXREQSIZE  (7 * 1024)
429 #define MGS_MAXREPSIZE  (9 * 1024)
430
431  /*
432   * OSS threads constants:
433   *
434   * Given 8 as factor and 64 as base threads number
435   *
436   * example 1):
437   * On 8-core server configured to 2 partitions, we will have
438   * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
439   *
440   * example 2):
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.
444   *
445   * example 3):
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.
451   *
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.
454   */
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
460
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
466
467 /**
468  * OST_IO_MAXREQSIZE ~=
469  *      lustre_msg + ptlrpc_body + obdo + obd_ioobj +
470  *      DT_MAX_BRW_PAGES * niobuf_remote
471  *
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
475  * - actual size is about 18K
476  */
477 #define _OST_MAXREQSIZE_SUM (sizeof(struct lustre_msg) + \
478                              sizeof(struct ptlrpc_body) + \
479                              sizeof(struct obdo) + \
480                              sizeof(struct obd_ioobj) + \
481                              sizeof(struct niobuf_remote) * DT_MAX_BRW_PAGES)
482 /**
483  * FIEMAP request can be 4K+ for now
484  */
485 #define OST_MAXREQSIZE          (16 * 1024)
486 #define OST_IO_MAXREQSIZE       max_t(int, OST_MAXREQSIZE, \
487                                 (((_OST_MAXREQSIZE_SUM - 1) | (1024 - 1)) + 1))
488
489 #define OST_MAXREPSIZE          (9 * 1024)
490 #define OST_IO_MAXREPSIZE       OST_MAXREPSIZE
491
492 #define OST_NBUFS               64
493 /** OST_BUFSIZE = max_reqsize + max sptlrpc payload size */
494 #define OST_BUFSIZE             max_t(int, OST_MAXREQSIZE + 1024, 16 * 1024)
495 /**
496  * OST_IO_MAXREQSIZE is 18K, giving extra 46K can increase buffer utilization
497  * rate of request buffer, please check comment of MDS_LOV_BUFSIZE for details.
498  */
499 #define OST_IO_BUFSIZE          max_t(int, OST_IO_MAXREQSIZE + 1024, 64 * 1024)
500
501 /* Macro to hide a typecast. */
502 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
503
504 struct ptlrpc_replay_async_args {
505         int             praa_old_state;
506         int             praa_old_status;
507 };
508
509 /**
510  * Structure to single define portal connection.
511  */
512 struct ptlrpc_connection {
513         /** linkage for connections hash table */
514         struct hlist_node        c_hash;
515         /** Our own lnet nid for this connection */
516         lnet_nid_t              c_self;
517         /** Remote side nid for this connection */
518         struct lnet_process_id       c_peer;
519         /** UUID of the other side */
520         struct obd_uuid         c_remote_uuid;
521         /** reference counter for this connection */
522         atomic_t            c_refcount;
523 };
524
525 /** Client definition for PortalRPC */
526 struct ptlrpc_client {
527         /** What lnet portal does this client send messages to by default */
528         __u32                   cli_request_portal;
529         /** What portal do we expect replies on */
530         __u32                   cli_reply_portal;
531         /** Name of the client */
532         char                   *cli_name;
533 };
534
535 /** state flags of requests */
536 /* XXX only ones left are those used by the bulk descs as well! */
537 #define PTL_RPC_FL_INTR      (1 << 0)  /* reply wait was interrupted by user */
538 #define PTL_RPC_FL_TIMEOUT   (1 << 7)  /* request timed out waiting for reply */
539
540 #define REQ_MAX_ACK_LOCKS 8
541
542 union ptlrpc_async_args {
543         /**
544          * Scratchpad for passing args to completion interpreter. Users
545          * cast to the struct of their choosing, and CLASSERT that this is
546          * big enough.  For _tons_ of context, OBD_ALLOC a struct and store
547          * a pointer to it here.  The pointer_arg ensures this struct is at
548          * least big enough for that.
549          */
550         void      *pointer_arg[11];
551         __u64      space[7];
552 };
553
554 struct ptlrpc_request_set;
555 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
556 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
557
558 /**
559  * Definition of request set structure.
560  * Request set is a list of requests (not necessary to the same target) that
561  * once populated with RPCs could be sent in parallel.
562  * There are two kinds of request sets. General purpose and with dedicated
563  * serving thread. Example of the latter is ptlrpcd set.
564  * For general purpose sets once request set started sending it is impossible
565  * to add new requests to such set.
566  * Provides a way to call "completion callbacks" when all requests in the set
567  * returned.
568  */
569 struct ptlrpc_request_set {
570         atomic_t                set_refcount;
571         /** number of in queue requests */
572         atomic_t                set_new_count;
573         /** number of uncompleted requests */
574         atomic_t                set_remaining;
575         /** wait queue to wait on for request events */
576         wait_queue_head_t       set_waitq;
577         wait_queue_head_t      *set_wakeup_ptr;
578         /** List of requests in the set */
579         struct list_head        set_requests;
580         /**
581          * List of completion callbacks to be called when the set is completed
582          * This is only used if \a set_interpret is NULL.
583          * Links struct ptlrpc_set_cbdata.
584          */
585         struct list_head        set_cblist;
586         /** Completion callback, if only one. */
587         set_interpreter_func    set_interpret;
588         /** opaq argument passed to completion \a set_interpret callback. */
589         void                    *set_arg;
590         /**
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
594          */
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;
598
599         /** rq_status of requests that have been freed already */
600         int                     set_rc;
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;
609 };
610
611 /**
612  * Description of a single ptrlrpc_set callback
613  */
614 struct ptlrpc_set_cbdata {
615         /** List linkage item */
616         struct list_head        psc_item;
617         /** Pointer to interpreting function */
618         set_interpreter_func    psc_interpret;
619         /** Opaq argument to pass to the callback */
620         void                    *psc_data;
621 };
622
623 struct ptlrpc_bulk_desc;
624 struct ptlrpc_service_part;
625 struct ptlrpc_service;
626
627 /**
628  * ptlrpc callback & work item stuff
629  */
630 struct ptlrpc_cb_id {
631         void (*cbid_fn)(struct lnet_event *ev); /* specific callback fn */
632         void *cbid_arg;                         /* additional arg */
633 };
634
635 /** Maximum number of locks to fit into reply state */
636 #define RS_MAX_LOCKS 8
637 #define RS_DEBUG     0
638
639 /**
640  * Structure to define reply state on the server
641  * Reply state holds various reply message information. Also for "difficult"
642  * replies (rep-ack case) we store the state after sending reply and wait
643  * for the client to acknowledge the reception. In these cases locks could be
644  * added to the state for replay/failover consistency guarantees.
645  */
646 struct ptlrpc_reply_state {
647         /** Callback description */
648         struct ptlrpc_cb_id     rs_cb_id;
649         /** Linkage for list of all reply states in a system */
650         struct list_head        rs_list;
651         /** Linkage for list of all reply states on same export */
652         struct list_head        rs_exp_list;
653         /** Linkage for list of all reply states for same obd */
654         struct list_head        rs_obd_list;
655 #if RS_DEBUG
656         struct list_head        rs_debug_list;
657 #endif
658         /** A spinlock to protect the reply state flags */
659         spinlock_t              rs_lock;
660         /** Reply state flags */
661         unsigned long          rs_difficult:1;     /* ACK/commit stuff */
662         unsigned long          rs_no_ack:1;    /* no ACK, even for
663                                                   difficult requests */
664         unsigned long          rs_scheduled:1;     /* being handled? */
665         unsigned long          rs_scheduled_ever:1;/* any schedule attempts? */
666         unsigned long          rs_handled:1;  /* been handled yet? */
667         unsigned long          rs_on_net:1;   /* reply_out_callback pending? */
668         unsigned long          rs_prealloc:1; /* rs from prealloc list */
669         unsigned long          rs_committed:1;/* the transaction was committed
670                                                  and the rs was dispatched
671                                                  by ptlrpc_commit_replies */
672         unsigned long           rs_convert_lock:1; /* need to convert saved
673                                                     * locks to COS mode */
674         atomic_t                rs_refcount;    /* number of users */
675         /** Number of locks awaiting client ACK */
676         int                     rs_nlocks;
677
678         /** Size of the state */
679         int                    rs_size;
680         /** opcode */
681         __u32                  rs_opc;
682         /** Transaction number */
683         __u64                  rs_transno;
684         /** xid */
685         __u64                  rs_xid;
686         struct obd_export     *rs_export;
687         struct ptlrpc_service_part *rs_svcpt;
688         /** Lnet metadata handle for the reply */
689         struct lnet_handle_md   rs_md_h;
690
691         /** Context for the sevice thread */
692         struct ptlrpc_svc_ctx   *rs_svc_ctx;
693         /** Reply buffer (actually sent to the client), encoded if needed */
694         struct lustre_msg       *rs_repbuf;     /* wrapper */
695         /** Size of the reply buffer */
696         int                     rs_repbuf_len;  /* wrapper buf length */
697         /** Size of the reply message */
698         int                     rs_repdata_len; /* wrapper msg length */
699         /**
700          * Actual reply message. Its content is encrupted (if needed) to
701          * produce reply buffer for actual sending. In simple case
702          * of no network encryption we jus set \a rs_repbuf to \a rs_msg
703          */
704         struct lustre_msg       *rs_msg;        /* reply message */
705
706         /** Handles of locks awaiting client reply ACK */
707         struct lustre_handle    rs_locks[RS_MAX_LOCKS];
708         /** Lock modes of locks in \a rs_locks */
709         enum ldlm_mode          rs_modes[RS_MAX_LOCKS];
710 };
711
712 struct ptlrpc_thread;
713
714 /** RPC stages */
715 enum rq_phase {
716         RQ_PHASE_NEW            = 0xebc0de00,
717         RQ_PHASE_RPC            = 0xebc0de01,
718         RQ_PHASE_BULK           = 0xebc0de02,
719         RQ_PHASE_INTERPRET      = 0xebc0de03,
720         RQ_PHASE_COMPLETE       = 0xebc0de04,
721         RQ_PHASE_UNREG_RPC      = 0xebc0de05,
722         RQ_PHASE_UNREG_BULK     = 0xebc0de06,
723         RQ_PHASE_UNDEFINED      = 0xebc0de07
724 };
725
726 /** Type of request interpreter call-back */
727 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
728                                     struct ptlrpc_request *req,
729                                     void *arg, int rc);
730 /** Type of request resend call-back */
731 typedef void (*ptlrpc_resend_cb_t)(struct ptlrpc_request *req,
732                                    void *arg);
733
734 /**
735  * Definition of request pool structure.
736  * The pool is used to store empty preallocated requests for the case
737  * when we would actually need to send something without performing
738  * any allocations (to avoid e.g. OOM).
739  */
740 struct ptlrpc_request_pool {
741         /** Locks the list */
742         spinlock_t              prp_lock;
743         /** list of ptlrpc_request structs */
744         struct list_head        prp_req_list;
745         /** Maximum message size that would fit into a rquest from this pool */
746         int                     prp_rq_size;
747         /** Function to allocate more requests for this pool */
748         int (*prp_populate)(struct ptlrpc_request_pool *, int);
749 };
750
751 struct lu_context;
752 struct lu_env;
753
754 struct ldlm_lock;
755
756 #include <lustre_nrs.h>
757
758 /**
759  * Basic request prioritization operations structure.
760  * The whole idea is centered around locks and RPCs that might affect locks.
761  * When a lock is contended we try to give priority to RPCs that might lead
762  * to fastest release of that lock.
763  * Currently only implemented for OSTs only in a way that makes all
764  * IO and truncate RPCs that are coming from a locked region where a lock is
765  * contended a priority over other requests.
766  */
767 struct ptlrpc_hpreq_ops {
768         /**
769          * Check if the lock handle of the given lock is the same as
770          * taken from the request.
771          */
772         int  (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
773         /**
774          * Check if the request is a high priority one.
775          */
776         int  (*hpreq_check)(struct ptlrpc_request *);
777         /**
778          * Called after the request has been handled.
779          */
780         void (*hpreq_fini)(struct ptlrpc_request *);
781 };
782
783 struct ptlrpc_cli_req {
784         /** For bulk requests on client only: bulk descriptor */
785         struct ptlrpc_bulk_desc         *cr_bulk;
786         /** optional time limit for send attempts */
787         cfs_duration_t                   cr_delay_limit;
788         /** time request was first queued */
789         cfs_time_t                       cr_queued_time;
790         /** request sent in nanoseconds */
791         ktime_t                          cr_sent_ns;
792         /** time for request really sent out */
793         time64_t                         cr_sent_out;
794         /** when req reply unlink must finish. */
795         time64_t                         cr_reply_deadline;
796         /** when req bulk unlink must finish. */
797         time64_t                         cr_bulk_deadline;
798         /** when req unlink must finish. */
799         time64_t                         cr_req_deadline;
800         /** Portal to which this request would be sent */
801         short                            cr_req_ptl;
802         /** Portal where to wait for reply and where reply would be sent */
803         short                            cr_rep_ptl;
804         /** request resending number */
805         unsigned int                     cr_resend_nr;
806         /** What was import generation when this request was sent */
807         int                              cr_imp_gen;
808         enum lustre_imp_state            cr_send_state;
809         /** Per-request waitq introduced by bug 21938 for recovery waiting */
810         wait_queue_head_t                cr_set_waitq;
811         /** Link item for request set lists */
812         struct list_head                 cr_set_chain;
813         /** link to waited ctx */
814         struct list_head                 cr_ctx_chain;
815
816         /** client's half ctx */
817         struct ptlrpc_cli_ctx           *cr_cli_ctx;
818         /** Link back to the request set */
819         struct ptlrpc_request_set       *cr_set;
820         /** outgoing request MD handle */
821         struct lnet_handle_md            cr_req_md_h;
822         /** request-out callback parameter */
823         struct ptlrpc_cb_id              cr_req_cbid;
824         /** incoming reply MD handle */
825         struct lnet_handle_md            cr_reply_md_h;
826         wait_queue_head_t                cr_reply_waitq;
827         /** reply callback parameter */
828         struct ptlrpc_cb_id              cr_reply_cbid;
829         /** Async completion handler, called when reply is received */
830         ptlrpc_interpterer_t             cr_reply_interp;
831         /** Resend handler, called when request is resend to update RPC data */
832         ptlrpc_resend_cb_t               cr_resend_cb;
833         /** Async completion context */
834         union ptlrpc_async_args          cr_async_args;
835         /** Opaq data for replay and commit callbacks. */
836         void                            *cr_cb_data;
837         /** Link to the imp->imp_unreplied_list */
838         struct list_head                 cr_unreplied_list;
839         /**
840          * Commit callback, called when request is committed and about to be
841          * freed.
842          */
843         void (*cr_commit_cb)(struct ptlrpc_request *);
844         /** Replay callback, called after request is replayed at recovery */
845         void (*cr_replay_cb)(struct ptlrpc_request *);
846 };
847
848 /** client request member alias */
849 /* NB: these alias should NOT be used by any new code, instead they should
850  * be removed step by step to avoid potential abuse */
851 #define rq_bulk                 rq_cli.cr_bulk
852 #define rq_delay_limit          rq_cli.cr_delay_limit
853 #define rq_queued_time          rq_cli.cr_queued_time
854 #define rq_sent_ns              rq_cli.cr_sent_ns
855 #define rq_real_sent            rq_cli.cr_sent_out
856 #define rq_reply_deadline       rq_cli.cr_reply_deadline
857 #define rq_bulk_deadline        rq_cli.cr_bulk_deadline
858 #define rq_req_deadline         rq_cli.cr_req_deadline
859 #define rq_nr_resend            rq_cli.cr_resend_nr
860 #define rq_request_portal       rq_cli.cr_req_ptl
861 #define rq_reply_portal         rq_cli.cr_rep_ptl
862 #define rq_import_generation    rq_cli.cr_imp_gen
863 #define rq_send_state           rq_cli.cr_send_state
864 #define rq_set_chain            rq_cli.cr_set_chain
865 #define rq_ctx_chain            rq_cli.cr_ctx_chain
866 #define rq_set                  rq_cli.cr_set
867 #define rq_set_waitq            rq_cli.cr_set_waitq
868 #define rq_cli_ctx              rq_cli.cr_cli_ctx
869 #define rq_req_md_h             rq_cli.cr_req_md_h
870 #define rq_req_cbid             rq_cli.cr_req_cbid
871 #define rq_reply_md_h           rq_cli.cr_reply_md_h
872 #define rq_reply_waitq          rq_cli.cr_reply_waitq
873 #define rq_reply_cbid           rq_cli.cr_reply_cbid
874 #define rq_interpret_reply      rq_cli.cr_reply_interp
875 #define rq_resend_cb            rq_cli.cr_resend_cb
876 #define rq_async_args           rq_cli.cr_async_args
877 #define rq_cb_data              rq_cli.cr_cb_data
878 #define rq_unreplied_list       rq_cli.cr_unreplied_list
879 #define rq_commit_cb            rq_cli.cr_commit_cb
880 #define rq_replay_cb            rq_cli.cr_replay_cb
881
882 struct ptlrpc_srv_req {
883         /** initial thread servicing this request */
884         struct ptlrpc_thread            *sr_svc_thread;
885         /**
886          * Server side list of incoming unserved requests sorted by arrival
887          * time.  Traversed from time to time to notice about to expire
888          * requests and sent back "early replies" to clients to let them
889          * know server is alive and well, just very busy to service their
890          * requests in time
891          */
892         struct list_head                 sr_timed_list;
893         /** server-side per-export list */
894         struct list_head                 sr_exp_list;
895         /** server-side history, used for debuging purposes. */
896         struct list_head                 sr_hist_list;
897         /** history sequence # */
898         __u64                            sr_hist_seq;
899         /** the index of service's srv_at_array into which request is linked */
900         __u32                            sr_at_index;
901         /** authed uid */
902         uid_t                            sr_auth_uid;
903         /** authed uid mapped to */
904         uid_t                            sr_auth_mapped_uid;
905         /** RPC is generated from what part of Lustre */
906         enum lustre_sec_part             sr_sp_from;
907         /** request session context */
908         struct lu_context                sr_ses;
909         /** \addtogroup  nrs
910          * @{
911          */
912         /** stub for NRS request */
913         struct ptlrpc_nrs_request        sr_nrq;
914         /** @} nrs */
915         /** request arrival time */
916         struct timespec64                sr_arrival_time;
917         /** server's half ctx */
918         struct ptlrpc_svc_ctx           *sr_svc_ctx;
919         /** (server side), pointed directly into req buffer */
920         struct ptlrpc_user_desc         *sr_user_desc;
921         /** separated reply state, may be vmalloc'd */
922         struct ptlrpc_reply_state       *sr_reply_state;
923         /** server-side hp handlers */
924         struct ptlrpc_hpreq_ops         *sr_ops;
925         /** incoming request buffer */
926         struct ptlrpc_request_buffer_desc *sr_rqbd;
927 };
928
929 /** server request member alias */
930 /* NB: these alias should NOT be used by any new code, instead they should
931  * be removed step by step to avoid potential abuse */
932 #define rq_svc_thread           rq_srv.sr_svc_thread
933 #define rq_timed_list           rq_srv.sr_timed_list
934 #define rq_exp_list             rq_srv.sr_exp_list
935 #define rq_history_list         rq_srv.sr_hist_list
936 #define rq_history_seq          rq_srv.sr_hist_seq
937 #define rq_at_index             rq_srv.sr_at_index
938 #define rq_auth_uid             rq_srv.sr_auth_uid
939 #define rq_auth_mapped_uid      rq_srv.sr_auth_mapped_uid
940 #define rq_sp_from              rq_srv.sr_sp_from
941 #define rq_session              rq_srv.sr_ses
942 #define rq_nrq                  rq_srv.sr_nrq
943 #define rq_arrival_time         rq_srv.sr_arrival_time
944 #define rq_reply_state          rq_srv.sr_reply_state
945 #define rq_svc_ctx              rq_srv.sr_svc_ctx
946 #define rq_user_desc            rq_srv.sr_user_desc
947 #define rq_ops                  rq_srv.sr_ops
948 #define rq_rqbd                 rq_srv.sr_rqbd
949
950 /**
951  * Represents remote procedure call.
952  *
953  * This is a staple structure used by everybody wanting to send a request
954  * in Lustre.
955  */
956 struct ptlrpc_request {
957         /* Request type: one of PTL_RPC_MSG_* */
958         int                              rq_type;
959         /** Result of request processing */
960         int                              rq_status;
961         /**
962          * Linkage item through which this request is included into
963          * sending/delayed lists on client and into rqbd list on server
964          */
965         struct list_head                 rq_list;
966         /** Lock to protect request flags and some other important bits, like
967          * rq_list
968          */
969         spinlock_t                       rq_lock;
970         spinlock_t                       rq_early_free_lock;
971         /** client-side flags are serialized by rq_lock @{ */
972         unsigned int rq_intr:1, rq_replied:1, rq_err:1,
973                 rq_timedout:1, rq_resend:1, rq_restart:1,
974                 /**
975                  * when ->rq_replay is set, request is kept by the client even
976                  * after server commits corresponding transaction. This is
977                  * used for operations that require sequence of multiple
978                  * requests to be replayed. The only example currently is file
979                  * open/close. When last request in such a sequence is
980                  * committed, ->rq_replay is cleared on all requests in the
981                  * sequence.
982                  */
983                 rq_replay:1,
984                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
985                 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
986                 rq_early:1,
987                 rq_req_unlinked:1,      /* unlinked request buffer from lnet */
988                 rq_reply_unlinked:1,    /* unlinked reply buffer from lnet */
989                 rq_memalloc:1,      /* req originated from "kswapd" */
990                 rq_committed:1,
991                 rq_reply_truncated:1,
992                 /** whether the "rq_set" is a valid one */
993                 rq_invalid_rqset:1,
994                 rq_generation_set:1,
995                 /** do not resend request on -EINPROGRESS */
996                 rq_no_retry_einprogress:1,
997                 /* allow the req to be sent if the import is in recovery
998                  * status */
999                 rq_allow_replay:1,
1000                 /* bulk request, sent to server, but uncommitted */
1001                 rq_unstable:1,
1002                 rq_early_free_repbuf:1, /* free reply buffer in advance */
1003                 rq_allow_intr:1;
1004         /** @} */
1005
1006         /** server-side flags @{ */
1007         unsigned int
1008                 rq_hp:1,                /**< high priority RPC */
1009                 rq_at_linked:1,         /**< link into service's srv_at_array */
1010                 rq_packed_final:1;      /**< packed final reply */
1011         /** @} */
1012
1013         /** one of RQ_PHASE_* */
1014         enum rq_phase                    rq_phase;
1015         /** one of RQ_PHASE_* to be used next */
1016         enum rq_phase                    rq_next_phase;
1017         /**
1018          * client-side refcount for SENT race, server-side refcounf
1019          * for multiple replies
1020          */
1021         atomic_t                         rq_refcount;
1022         /**
1023          * client-side:
1024          * !rq_truncate : # reply bytes actually received,
1025          *  rq_truncate : required repbuf_len for resend
1026          */
1027         int rq_nob_received;
1028         /** Request length */
1029         int rq_reqlen;
1030         /** Reply length */
1031         int rq_replen;
1032         /** Pool if request is from preallocated list */
1033         struct ptlrpc_request_pool      *rq_pool;
1034         /** Request message - what client sent */
1035         struct lustre_msg *rq_reqmsg;
1036         /** Reply message - server response */
1037         struct lustre_msg *rq_repmsg;
1038         /** Transaction number */
1039         __u64 rq_transno;
1040         /** xid */
1041         __u64                            rq_xid;
1042         /** bulk match bits */
1043         __u64                            rq_mbits;
1044         /**
1045          * List item to for replay list. Not yet committed requests get linked
1046          * there.
1047          * Also see \a rq_replay comment above.
1048          * It's also link chain on obd_export::exp_req_replay_queue
1049          */
1050         struct list_head                 rq_replay_list;
1051         /** non-shared members for client & server request*/
1052         union {
1053                 struct ptlrpc_cli_req    rq_cli;
1054                 struct ptlrpc_srv_req    rq_srv;
1055         };
1056         /**
1057          * security and encryption data
1058          * @{ */
1059         /** description of flavors for client & server */
1060         struct sptlrpc_flavor            rq_flvr;
1061
1062         /* client/server security flags */
1063         unsigned int
1064                                  rq_ctx_init:1,      /* context initiation */
1065                                  rq_ctx_fini:1,      /* context destroy */
1066                                  rq_bulk_read:1,     /* request bulk read */
1067                                  rq_bulk_write:1,    /* request bulk write */
1068                                  /* server authentication flags */
1069                                  rq_auth_gss:1,      /* authenticated by gss */
1070                                  rq_auth_usr_root:1, /* authed as root */
1071                                  rq_auth_usr_mdt:1,  /* authed as mdt */
1072                                  rq_auth_usr_ost:1,  /* authed as ost */
1073                                  /* security tfm flags */
1074                                  rq_pack_udesc:1,
1075                                  rq_pack_bulk:1,
1076                                  /* doesn't expect reply FIXME */
1077                                  rq_no_reply:1,
1078                                  rq_pill_init:1, /* pill initialized */
1079                                  rq_srv_req:1; /* server request */
1080
1081
1082         /** various buffer pointers */
1083         struct lustre_msg               *rq_reqbuf;  /**< req wrapper, vmalloc*/
1084         char                            *rq_repbuf;  /**< rep buffer, vmalloc */
1085         struct lustre_msg               *rq_repdata; /**< rep wrapper msg */
1086         /** only in priv mode */
1087         struct lustre_msg               *rq_clrbuf;
1088         int                      rq_reqbuf_len;  /* req wrapper buf len */
1089         int                      rq_reqdata_len; /* req wrapper msg len */
1090         int                      rq_repbuf_len;  /* rep buffer len */
1091         int                      rq_repdata_len; /* rep wrapper msg len */
1092         int                      rq_clrbuf_len;  /* only in priv mode */
1093         int                      rq_clrdata_len; /* only in priv mode */
1094
1095         /** early replies go to offset 0, regular replies go after that */
1096         unsigned int                     rq_reply_off;
1097         /** @} */
1098
1099         /** Fields that help to see if request and reply were swabbed or not */
1100         __u32                            rq_req_swab_mask;
1101         __u32                            rq_rep_swab_mask;
1102
1103         /** how many early replies (for stats) */
1104         int                              rq_early_count;
1105         /** Server-side, export on which request was received */
1106         struct obd_export               *rq_export;
1107         /** import where request is being sent */
1108         struct obd_import               *rq_import;
1109         /** our LNet NID */
1110         lnet_nid_t                       rq_self;
1111         /** Peer description (the other side) */
1112         struct lnet_process_id           rq_peer;
1113         /** Descriptor for the NID from which the peer sent the request. */
1114         struct lnet_process_id           rq_source;
1115         /**
1116          * service time estimate (secs)
1117          * If the request is not served by this time, it is marked as timed out.
1118          */
1119         int                              rq_timeout;
1120         /**
1121          * when request/reply sent (secs), or time when request should be sent
1122          */
1123         time64_t                         rq_sent;
1124         /** when request must finish. */
1125         time64_t                         rq_deadline;
1126         /** request format description */
1127         struct req_capsule               rq_pill;
1128 };
1129
1130 /**
1131  * Call completion handler for rpc if any, return it's status or original
1132  * rc if there was no handler defined for this request.
1133  */
1134 static inline int ptlrpc_req_interpret(const struct lu_env *env,
1135                                        struct ptlrpc_request *req, int rc)
1136 {
1137         if (req->rq_interpret_reply != NULL) {
1138                 req->rq_status = req->rq_interpret_reply(env, req,
1139                                                          &req->rq_async_args,
1140                                                          rc);
1141                 return req->rq_status;
1142         }
1143         return rc;
1144 }
1145
1146 /** \addtogroup  nrs
1147  * @{
1148  */
1149 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
1150 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
1151 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
1152 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
1153                                 struct ptlrpc_nrs_pol_info *info);
1154
1155 /*
1156  * Can the request be moved from the regular NRS head to the high-priority NRS
1157  * head (of the same PTLRPC service partition), if any?
1158  *
1159  * For a reliable result, this should be checked under svcpt->scp_req lock.
1160  */
1161 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
1162 {
1163         struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
1164
1165         /**
1166          * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
1167          * request has been enqueued first, and ptlrpc_nrs_request::nr_started
1168          * to make sure it has not been scheduled yet (analogous to previous
1169          * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
1170          */
1171         return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
1172 }
1173 /** @} nrs */
1174
1175 /**
1176  * Returns 1 if request buffer at offset \a index was already swabbed
1177  */
1178 static inline int lustre_req_swabbed(struct ptlrpc_request *req, size_t index)
1179 {
1180         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1181         return req->rq_req_swab_mask & (1 << index);
1182 }
1183
1184 /**
1185  * Returns 1 if request reply buffer at offset \a index was already swabbed
1186  */
1187 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, size_t index)
1188 {
1189         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1190         return req->rq_rep_swab_mask & (1 << index);
1191 }
1192
1193 /**
1194  * Returns 1 if request needs to be swabbed into local cpu byteorder
1195  */
1196 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
1197 {
1198         return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1199 }
1200
1201 /**
1202  * Returns 1 if request reply needs to be swabbed into local cpu byteorder
1203  */
1204 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
1205 {
1206         return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1207 }
1208
1209 /**
1210  * Mark request buffer at offset \a index that it was already swabbed
1211  */
1212 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req,
1213                                           size_t index)
1214 {
1215         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
1216         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
1217         req->rq_req_swab_mask |= 1 << index;
1218 }
1219
1220 /**
1221  * Mark request reply buffer at offset \a index that it was already swabbed
1222  */
1223 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req,
1224                                           size_t index)
1225 {
1226         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
1227         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
1228         req->rq_rep_swab_mask |= 1 << index;
1229 }
1230
1231 /**
1232  * Convert numerical request phase value \a phase into text string description
1233  */
1234 static inline const char *
1235 ptlrpc_phase2str(enum rq_phase phase)
1236 {
1237         switch (phase) {
1238         case RQ_PHASE_NEW:
1239                 return "New";
1240         case RQ_PHASE_RPC:
1241                 return "Rpc";
1242         case RQ_PHASE_BULK:
1243                 return "Bulk";
1244         case RQ_PHASE_INTERPRET:
1245                 return "Interpret";
1246         case RQ_PHASE_COMPLETE:
1247                 return "Complete";
1248         case RQ_PHASE_UNREG_RPC:
1249                 return "UnregRPC";
1250         case RQ_PHASE_UNREG_BULK:
1251                 return "UnregBULK";
1252         default:
1253                 return "?Phase?";
1254         }
1255 }
1256
1257 /**
1258  * Convert numerical request phase of the request \a req into text stringi
1259  * description
1260  */
1261 static inline const char *
1262 ptlrpc_rqphase2str(struct ptlrpc_request *req)
1263 {
1264         return ptlrpc_phase2str(req->rq_phase);
1265 }
1266
1267 /**
1268  * Debugging functions and helpers to print request structure into debug log
1269  * @{
1270  */
1271 /* Spare the preprocessor, spoil the bugs. */
1272 #define FLAG(field, str) (field ? str : "")
1273
1274 /** Convert bit flags into a string */
1275 #define DEBUG_REQ_FLAGS(req)                                                   \
1276         ptlrpc_rqphase2str(req),                                               \
1277         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                   \
1278         FLAG(req->rq_err, "E"), FLAG(req->rq_net_err, "e"),                    \
1279         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),  \
1280         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                 \
1281         FLAG(req->rq_no_resend, "N"),                                          \
1282         FLAG(req->rq_waiting, "W"),                                            \
1283         FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"),                    \
1284         FLAG(req->rq_committed, "M")
1285
1286 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s%s"
1287
1288 void _debug_req(struct ptlrpc_request *req,
1289                 struct libcfs_debug_msg_data *data, const char *fmt, ...)
1290         __attribute__ ((format (printf, 3, 4)));
1291
1292 /**
1293  * Helper that decides if we need to print request accordig to current debug
1294  * level settings
1295  */
1296 #define debug_req(msgdata, mask, cdls, req, fmt, a...)                        \
1297 do {                                                                          \
1298         CFS_CHECK_STACK(msgdata, mask, cdls);                                 \
1299                                                                               \
1300         if (((mask) & D_CANTMASK) != 0 ||                                     \
1301             ((libcfs_debug & (mask)) != 0 &&                                  \
1302              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
1303                 _debug_req((req), msgdata, fmt, ##a);                         \
1304 } while(0)
1305
1306 /**
1307  * This is the debug print function you need to use to print request sturucture
1308  * content into lustre debug log.
1309  * for most callers (level is a constant) this is resolved at compile time */
1310 #define DEBUG_REQ(level, req, fmt, args...)                                   \
1311 do {                                                                          \
1312         if ((level) & (D_ERROR | D_WARNING)) {                                \
1313                 static struct cfs_debug_limit_state cdls;                     \
1314                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls);            \
1315                 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
1316         } else {                                                              \
1317                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL);             \
1318                 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
1319         }                                                                     \
1320 } while (0)
1321 /** @} */
1322
1323 /**
1324  * Structure that defines a single page of a bulk transfer
1325  */
1326 struct ptlrpc_bulk_page {
1327         /** Linkage to list of pages in a bulk */
1328         struct list_head bp_link;
1329         /**
1330          * Number of bytes in a page to transfer starting from \a bp_pageoffset
1331          */
1332         int              bp_buflen;
1333         /** offset within a page */
1334         int              bp_pageoffset;
1335         /** The page itself */
1336         struct page     *bp_page;
1337 };
1338
1339 enum ptlrpc_bulk_op_type {
1340         PTLRPC_BULK_OP_ACTIVE =  0x00000001,
1341         PTLRPC_BULK_OP_PASSIVE = 0x00000002,
1342         PTLRPC_BULK_OP_PUT =     0x00000004,
1343         PTLRPC_BULK_OP_GET =     0x00000008,
1344         PTLRPC_BULK_BUF_KVEC =   0x00000010,
1345         PTLRPC_BULK_BUF_KIOV =   0x00000020,
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,
1350 };
1351
1352 static inline bool ptlrpc_is_bulk_op_get(enum ptlrpc_bulk_op_type type)
1353 {
1354         return (type & PTLRPC_BULK_OP_GET) == PTLRPC_BULK_OP_GET;
1355 }
1356
1357 static inline bool ptlrpc_is_bulk_get_source(enum ptlrpc_bulk_op_type type)
1358 {
1359         return (type & PTLRPC_BULK_GET_SOURCE) == PTLRPC_BULK_GET_SOURCE;
1360 }
1361
1362 static inline bool ptlrpc_is_bulk_put_sink(enum ptlrpc_bulk_op_type type)
1363 {
1364         return (type & PTLRPC_BULK_PUT_SINK) == PTLRPC_BULK_PUT_SINK;
1365 }
1366
1367 static inline bool ptlrpc_is_bulk_get_sink(enum ptlrpc_bulk_op_type type)
1368 {
1369         return (type & PTLRPC_BULK_GET_SINK) == PTLRPC_BULK_GET_SINK;
1370 }
1371
1372 static inline bool ptlrpc_is_bulk_put_source(enum ptlrpc_bulk_op_type type)
1373 {
1374         return (type & PTLRPC_BULK_PUT_SOURCE) == PTLRPC_BULK_PUT_SOURCE;
1375 }
1376
1377 static inline bool ptlrpc_is_bulk_desc_kvec(enum ptlrpc_bulk_op_type type)
1378 {
1379         return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1380                         == PTLRPC_BULK_BUF_KVEC;
1381 }
1382
1383 static inline bool ptlrpc_is_bulk_desc_kiov(enum ptlrpc_bulk_op_type type)
1384 {
1385         return ((type & PTLRPC_BULK_BUF_KVEC) | (type & PTLRPC_BULK_BUF_KIOV))
1386                         == PTLRPC_BULK_BUF_KIOV;
1387 }
1388
1389 static inline bool ptlrpc_is_bulk_op_active(enum ptlrpc_bulk_op_type type)
1390 {
1391         return ((type & PTLRPC_BULK_OP_ACTIVE) |
1392                 (type & PTLRPC_BULK_OP_PASSIVE))
1393                         == PTLRPC_BULK_OP_ACTIVE;
1394 }
1395
1396 static inline bool ptlrpc_is_bulk_op_passive(enum ptlrpc_bulk_op_type type)
1397 {
1398         return ((type & PTLRPC_BULK_OP_ACTIVE) |
1399                 (type & PTLRPC_BULK_OP_PASSIVE))
1400                         == PTLRPC_BULK_OP_PASSIVE;
1401 }
1402
1403 struct ptlrpc_bulk_frag_ops {
1404         /**
1405          * Add a page \a page to the bulk descriptor \a desc
1406          * Data to transfer in the page starts at offset \a pageoffset and
1407          * amount of data to transfer from the page is \a len
1408          */
1409         void (*add_kiov_frag)(struct ptlrpc_bulk_desc *desc,
1410                               struct page *page, int pageoffset, int len);
1411
1412         /*
1413          * Add a \a fragment to the bulk descriptor \a desc.
1414          * Data to transfer in the fragment is pointed to by \a frag
1415          * The size of the fragment is \a len
1416          */
1417         int (*add_iov_frag)(struct ptlrpc_bulk_desc *desc, void *frag, int len);
1418
1419         /**
1420          * Uninitialize and free bulk descriptor \a desc.
1421          * Works on bulk descriptors both from server and client side.
1422          */
1423         void (*release_frags)(struct ptlrpc_bulk_desc *desc);
1424 };
1425
1426 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_pin_ops;
1427 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kiov_nopin_ops;
1428 extern const struct ptlrpc_bulk_frag_ops ptlrpc_bulk_kvec_ops;
1429
1430 /*
1431  * Definition of bulk descriptor.
1432  * Bulks are special "Two phase" RPCs where initial request message
1433  * is sent first and it is followed bt a transfer (o receiving) of a large
1434  * amount of data to be settled into pages referenced from the bulk descriptors.
1435  * Bulks transfers (the actual data following the small requests) are done
1436  * on separate LNet portals.
1437  * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
1438  *  Another user is readpage for MDT.
1439  */
1440 struct ptlrpc_bulk_desc {
1441         /** completed with failure */
1442         unsigned long bd_failure:1;
1443         /** client side */
1444         unsigned long bd_registered:1;
1445         /** For serialization with callback */
1446         spinlock_t bd_lock;
1447         /** Import generation when request for this bulk was sent */
1448         int bd_import_generation;
1449         /** {put,get}{source,sink}{kvec,kiov} */
1450         enum ptlrpc_bulk_op_type bd_type;
1451         /** LNet portal for this bulk */
1452         __u32 bd_portal;
1453         /** Server side - export this bulk created for */
1454         struct obd_export *bd_export;
1455         /** Client side - import this bulk was sent on */
1456         struct obd_import *bd_import;
1457         /** Back pointer to the request */
1458         struct ptlrpc_request *bd_req;
1459         struct ptlrpc_bulk_frag_ops *bd_frag_ops;
1460         wait_queue_head_t      bd_waitq;        /* server side only WQ */
1461         int                    bd_iov_count;    /* # entries in bd_iov */
1462         int                    bd_max_iov;      /* allocated size of bd_iov */
1463         int                    bd_nob;          /* # bytes covered */
1464         int                    bd_nob_transferred; /* # bytes GOT/PUT */
1465
1466         __u64                  bd_last_mbits;
1467
1468         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
1469         lnet_nid_t             bd_sender;       /* stash event::sender */
1470         int                     bd_md_count;    /* # valid entries in bd_mds */
1471         int                     bd_md_max_brw;  /* max entries in bd_mds */
1472         /** array of associated MDs */
1473         struct lnet_handle_md   bd_mds[PTLRPC_BULK_OPS_COUNT];
1474
1475         union {
1476                 struct {
1477                         /*
1478                          * encrypt iov, size is either 0 or bd_iov_count.
1479                          */
1480                         lnet_kiov_t *bd_enc_vec;
1481                         lnet_kiov_t *bd_vec;
1482                 } bd_kiov;
1483
1484                 struct {
1485                         struct kvec *bd_enc_kvec;
1486                         struct kvec *bd_kvec;
1487                 } bd_kvec;
1488         } bd_u;
1489
1490 };
1491
1492 #define GET_KIOV(desc)                  ((desc)->bd_u.bd_kiov.bd_vec)
1493 #define BD_GET_KIOV(desc, i)            ((desc)->bd_u.bd_kiov.bd_vec[i])
1494 #define GET_ENC_KIOV(desc)              ((desc)->bd_u.bd_kiov.bd_enc_vec)
1495 #define BD_GET_ENC_KIOV(desc, i)        ((desc)->bd_u.bd_kiov.bd_enc_vec[i])
1496 #define GET_KVEC(desc)                  ((desc)->bd_u.bd_kvec.bd_kvec)
1497 #define BD_GET_KVEC(desc, i)            ((desc)->bd_u.bd_kvec.bd_kvec[i])
1498 #define GET_ENC_KVEC(desc)              ((desc)->bd_u.bd_kvec.bd_enc_kvec)
1499 #define BD_GET_ENC_KVEC(desc, i)        ((desc)->bd_u.bd_kvec.bd_enc_kvec[i])
1500
1501 enum {
1502         SVC_INIT        = 0,
1503         SVC_STOPPED     = 1 << 0,
1504         SVC_STOPPING    = 1 << 1,
1505         SVC_STARTING    = 1 << 2,
1506         SVC_RUNNING     = 1 << 3,
1507         SVC_EVENT       = 1 << 4,
1508         SVC_SIGNAL      = 1 << 5,
1509 };
1510
1511 #define PTLRPC_THR_NAME_LEN             32
1512 /**
1513  * Definition of server service thread structure
1514  */
1515 struct ptlrpc_thread {
1516         /**
1517          * List of active threads in svc->srv_threads
1518          */
1519         struct list_head t_link;
1520         /**
1521          * thread-private data (preallocated vmalloc'd memory)
1522          */
1523         void *t_data;
1524         __u32 t_flags;
1525         /**
1526          * service thread index, from ptlrpc_start_threads
1527          */
1528         unsigned int t_id;
1529         /**
1530          * service thread pid
1531          */
1532         pid_t t_pid;
1533         /**
1534          * put watchdog in the structure per thread b=14840
1535          */
1536         struct lc_watchdog *t_watchdog;
1537         /**
1538          * the svc this thread belonged to b=18582
1539          */
1540         struct ptlrpc_service_part      *t_svcpt;
1541         wait_queue_head_t               t_ctl_waitq;
1542         struct lu_env                   *t_env;
1543         char                            t_name[PTLRPC_THR_NAME_LEN];
1544 };
1545
1546 static inline int thread_is_init(struct ptlrpc_thread *thread)
1547 {
1548         return thread->t_flags == 0;
1549 }
1550
1551 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
1552 {
1553         return !!(thread->t_flags & SVC_STOPPED);
1554 }
1555
1556 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
1557 {
1558         return !!(thread->t_flags & SVC_STOPPING);
1559 }
1560
1561 static inline int thread_is_starting(struct ptlrpc_thread *thread)
1562 {
1563         return !!(thread->t_flags & SVC_STARTING);
1564 }
1565
1566 static inline int thread_is_running(struct ptlrpc_thread *thread)
1567 {
1568         return !!(thread->t_flags & SVC_RUNNING);
1569 }
1570
1571 static inline int thread_is_event(struct ptlrpc_thread *thread)
1572 {
1573         return !!(thread->t_flags & SVC_EVENT);
1574 }
1575
1576 static inline int thread_is_signal(struct ptlrpc_thread *thread)
1577 {
1578         return !!(thread->t_flags & SVC_SIGNAL);
1579 }
1580
1581 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
1582 {
1583         thread->t_flags &= ~flags;
1584 }
1585
1586 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
1587 {
1588         thread->t_flags = flags;
1589 }
1590
1591 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
1592 {
1593         thread->t_flags |= flags;
1594 }
1595
1596 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
1597                                               __u32 flags)
1598 {
1599         if (thread->t_flags & flags) {
1600                 thread->t_flags &= ~flags;
1601                 return 1;
1602         }
1603         return 0;
1604 }
1605
1606 /**
1607  * Request buffer descriptor structure.
1608  * This is a structure that contains one posted request buffer for service.
1609  * Once data land into a buffer, event callback creates actual request and
1610  * notifies wakes one of the service threads to process new incoming request.
1611  * More than one request can fit into the buffer.
1612  */
1613 struct ptlrpc_request_buffer_desc {
1614         /** Link item for rqbds on a service */
1615         struct list_head                rqbd_list;
1616         /** History of requests for this buffer */
1617         struct list_head                rqbd_reqs;
1618         /** Back pointer to service for which this buffer is registered */
1619         struct ptlrpc_service_part      *rqbd_svcpt;
1620         /** LNet descriptor */
1621         struct lnet_handle_md           rqbd_md_h;
1622         int                             rqbd_refcount;
1623         /** The buffer itself */
1624         char                            *rqbd_buffer;
1625         struct ptlrpc_cb_id             rqbd_cbid;
1626         /**
1627          * This "embedded" request structure is only used for the
1628          * last request to fit into the buffer
1629          */
1630         struct ptlrpc_request           rqbd_req;
1631 };
1632
1633 typedef int  (*svc_handler_t)(struct ptlrpc_request *req);
1634
1635 struct ptlrpc_service_ops {
1636         /**
1637          * if non-NULL called during thread creation (ptlrpc_start_thread())
1638          * to initialize service specific per-thread state.
1639          */
1640         int             (*so_thr_init)(struct ptlrpc_thread *thr);
1641         /**
1642          * if non-NULL called during thread shutdown (ptlrpc_main()) to
1643          * destruct state created by ->srv_init().
1644          */
1645         void            (*so_thr_done)(struct ptlrpc_thread *thr);
1646         /**
1647          * Handler function for incoming requests for this service
1648          */
1649         int             (*so_req_handler)(struct ptlrpc_request *req);
1650         /**
1651          * function to determine priority of the request, it's called
1652          * on every new request
1653          */
1654         int             (*so_hpreq_handler)(struct ptlrpc_request *);
1655         /**
1656          * service-specific print fn
1657          */
1658         void            (*so_req_printer)(void *, struct ptlrpc_request *);
1659 };
1660
1661 #ifndef __cfs_cacheline_aligned
1662 /* NB: put it here for reducing patche dependence */
1663 # define __cfs_cacheline_aligned
1664 #endif
1665
1666 /**
1667  * How many high priority requests to serve before serving one normal
1668  * priority request
1669  */
1670 #define PTLRPC_SVC_HP_RATIO 10
1671
1672 /**
1673  * Definition of PortalRPC service.
1674  * The service is listening on a particular portal (like tcp port)
1675  * and perform actions for a specific server like IO service for OST
1676  * or general metadata service for MDS.
1677  */
1678 struct ptlrpc_service {
1679         /** serialize /proc operations */
1680         spinlock_t                      srv_lock;
1681         /** most often accessed fields */
1682         /** chain thru all services */
1683         struct list_head                srv_list;
1684         /** service operations table */
1685         struct ptlrpc_service_ops       srv_ops;
1686         /** only statically allocated strings here; we don't clean them */
1687         char                           *srv_name;
1688         /** only statically allocated strings here; we don't clean them */
1689         char                           *srv_thread_name;
1690         /** service thread list */
1691         struct list_head                srv_threads;
1692         /** threads # should be created for each partition on initializing */
1693         int                             srv_nthrs_cpt_init;
1694         /** limit of threads number for each partition */
1695         int                             srv_nthrs_cpt_limit;
1696         /** Root of /proc dir tree for this service */
1697         struct proc_dir_entry           *srv_procroot;
1698         /** Pointer to statistic data for this service */
1699         struct lprocfs_stats           *srv_stats;
1700         /** # hp per lp reqs to handle */
1701         int                             srv_hpreq_ratio;
1702         /** biggest request to receive */
1703         int                             srv_max_req_size;
1704         /** biggest reply to send */
1705         int                             srv_max_reply_size;
1706         /** size of individual buffers */
1707         int                             srv_buf_size;
1708         /** # buffers to allocate in 1 group */
1709         int                             srv_nbuf_per_group;
1710         /** Local portal on which to receive requests */
1711         __u32                           srv_req_portal;
1712         /** Portal on the client to send replies to */
1713         __u32                           srv_rep_portal;
1714         /**
1715          * Tags for lu_context associated with this thread, see struct
1716          * lu_context.
1717          */
1718         __u32                           srv_ctx_tags;
1719         /** soft watchdog timeout multiplier */
1720         int                             srv_watchdog_factor;
1721         /** under unregister_service */
1722         unsigned                        srv_is_stopping:1;
1723
1724         /** max # request buffers in history per partition */
1725         int                             srv_hist_nrqbds_cpt_max;
1726         /** number of CPTs this service bound on */
1727         int                             srv_ncpts;
1728         /** CPTs array this service bound on */
1729         __u32                           *srv_cpts;
1730         /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
1731         int                             srv_cpt_bits;
1732         /** CPT table this service is running over */
1733         struct cfs_cpt_table            *srv_cptable;
1734
1735         /* sysfs object */
1736         struct kobject                  srv_kobj;
1737         struct completion               srv_kobj_unregister;
1738         /**
1739          * partition data for ptlrpc service
1740          */
1741         struct ptlrpc_service_part      *srv_parts[0];
1742 };
1743
1744 /**
1745  * Definition of PortalRPC service partition data.
1746  * Although a service only has one instance of it right now, but we
1747  * will have multiple instances very soon (instance per CPT).
1748  *
1749  * it has four locks:
1750  * \a scp_lock
1751  *    serialize operations on rqbd and requests waiting for preprocess
1752  * \a scp_req_lock
1753  *    serialize operations active requests sent to this portal
1754  * \a scp_at_lock
1755  *    serialize adaptive timeout stuff
1756  * \a scp_rep_lock
1757  *    serialize operations on RS list (reply states)
1758  *
1759  * We don't have any use-case to take two or more locks at the same time
1760  * for now, so there is no lock order issue.
1761  */
1762 struct ptlrpc_service_part {
1763         /** back reference to owner */
1764         struct ptlrpc_service           *scp_service __cfs_cacheline_aligned;
1765         /* CPT id, reserved */
1766         int                             scp_cpt;
1767         /** always increasing number */
1768         int                             scp_thr_nextid;
1769         /** # of starting threads */
1770         int                             scp_nthrs_starting;
1771         /** # of stopping threads, reserved for shrinking threads */
1772         int                             scp_nthrs_stopping;
1773         /** # running threads */
1774         int                             scp_nthrs_running;
1775         /** service threads list */
1776         struct list_head                scp_threads;
1777
1778         /**
1779          * serialize the following fields, used for protecting
1780          * rqbd list and incoming requests waiting for preprocess,
1781          * threads starting & stopping are also protected by this lock.
1782          */
1783         spinlock_t                      scp_lock  __cfs_cacheline_aligned;
1784         /** total # req buffer descs allocated */
1785         int                             scp_nrqbds_total;
1786         /** # posted request buffers for receiving */
1787         int                             scp_nrqbds_posted;
1788         /** in progress of allocating rqbd */
1789         int                             scp_rqbd_allocating;
1790         /** # incoming reqs */
1791         int                             scp_nreqs_incoming;
1792         /** request buffers to be reposted */
1793         struct list_head                scp_rqbd_idle;
1794         /** req buffers receiving */
1795         struct list_head                scp_rqbd_posted;
1796         /** incoming reqs */
1797         struct list_head                scp_req_incoming;
1798         /** timeout before re-posting reqs, in tick */
1799         cfs_duration_t                  scp_rqbd_timeout;
1800         /**
1801          * all threads sleep on this. This wait-queue is signalled when new
1802          * incoming request arrives and when difficult reply has to be handled.
1803          */
1804         wait_queue_head_t               scp_waitq;
1805
1806         /** request history */
1807         struct list_head                scp_hist_reqs;
1808         /** request buffer history */
1809         struct list_head                scp_hist_rqbds;
1810         /** # request buffers in history */
1811         int                             scp_hist_nrqbds;
1812         /** sequence number for request */
1813         __u64                           scp_hist_seq;
1814         /** highest seq culled from history */
1815         __u64                           scp_hist_seq_culled;
1816
1817         /**
1818          * serialize the following fields, used for processing requests
1819          * sent to this portal
1820          */
1821         spinlock_t                      scp_req_lock __cfs_cacheline_aligned;
1822         /** # reqs in either of the NRS heads below */
1823         /** # reqs being served */
1824         int                             scp_nreqs_active;
1825         /** # HPreqs being served */
1826         int                             scp_nhreqs_active;
1827         /** # hp requests handled */
1828         int                             scp_hreq_count;
1829
1830         /** NRS head for regular requests */
1831         struct ptlrpc_nrs               scp_nrs_reg;
1832         /** NRS head for HP requests; this is only valid for services that can
1833          *  handle HP requests */
1834         struct ptlrpc_nrs              *scp_nrs_hp;
1835
1836         /** AT stuff */
1837         /** @{ */
1838         /**
1839          * serialize the following fields, used for changes on
1840          * adaptive timeout
1841          */
1842         spinlock_t                      scp_at_lock __cfs_cacheline_aligned;
1843         /** estimated rpc service time */
1844         struct adaptive_timeout         scp_at_estimate;
1845         /** reqs waiting for replies */
1846         struct ptlrpc_at_array          scp_at_array;
1847         /** early reply timer */
1848         struct timer_list               scp_at_timer;
1849         /** debug */
1850         cfs_time_t                      scp_at_checktime;
1851         /** check early replies */
1852         unsigned                        scp_at_check;
1853         /** @} */
1854
1855         /**
1856          * serialize the following fields, used for processing
1857          * replies for this portal
1858          */
1859         spinlock_t                      scp_rep_lock __cfs_cacheline_aligned;
1860         /** all the active replies */
1861         struct list_head                scp_rep_active;
1862         /** List of free reply_states */
1863         struct list_head                scp_rep_idle;
1864         /** waitq to run, when adding stuff to srv_free_rs_list */
1865         wait_queue_head_t               scp_rep_waitq;
1866         /** # 'difficult' replies */
1867         atomic_t                        scp_nreps_difficult;
1868 };
1869
1870 #define ptlrpc_service_for_each_part(part, i, svc)                      \
1871         for (i = 0;                                                     \
1872              i < (svc)->srv_ncpts &&                                    \
1873              (svc)->srv_parts != NULL &&                                \
1874              ((part) = (svc)->srv_parts[i]) != NULL; i++)
1875
1876 /**
1877  * Declaration of ptlrpcd control structure
1878  */
1879 struct ptlrpcd_ctl {
1880         /**
1881          * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
1882          */
1883         unsigned long                   pc_flags;
1884         /**
1885          * Thread lock protecting structure fields.
1886          */
1887         spinlock_t                      pc_lock;
1888         /**
1889          * Start completion.
1890          */
1891         struct completion               pc_starting;
1892         /**
1893          * Stop completion.
1894          */
1895         struct completion               pc_finishing;
1896         /**
1897          * Thread requests set.
1898          */
1899         struct ptlrpc_request_set       *pc_set;
1900         /**
1901          * Thread name used in kthread_run()
1902          */
1903         char                            pc_name[16];
1904         /**
1905          * CPT the thread is bound on.
1906          */
1907         int                             pc_cpt;
1908         /**
1909          * Index of ptlrpcd thread in the array.
1910          */
1911         int                             pc_index;
1912         /**
1913          * Pointer to the array of partners' ptlrpcd_ctl structure.
1914          */
1915         struct ptlrpcd_ctl              **pc_partners;
1916         /**
1917          * Number of the ptlrpcd's partners.
1918          */
1919         int                             pc_npartners;
1920         /**
1921          * Record the partner index to be processed next.
1922          */
1923         int                             pc_cursor;
1924         /**
1925          * Error code if the thread failed to fully start.
1926          */
1927         int                             pc_error;
1928 };
1929
1930 /* Bits for pc_flags */
1931 enum ptlrpcd_ctl_flags {
1932         /**
1933          * Ptlrpc thread start flag.
1934          */
1935         LIOD_START       = 1 << 0,
1936         /**
1937          * Ptlrpc thread stop flag.
1938          */
1939         LIOD_STOP        = 1 << 1,
1940         /**
1941          * Ptlrpc thread force flag (only stop force so far).
1942          * This will cause aborting any inflight rpcs handled
1943          * by thread if LIOD_STOP is specified.
1944          */
1945         LIOD_FORCE       = 1 << 2,
1946         /**
1947          * This is a recovery ptlrpc thread.
1948          */
1949         LIOD_RECOVERY    = 1 << 3,
1950 };
1951
1952 /**
1953  * \addtogroup nrs
1954  * @{
1955  *
1956  * Service compatibility function; the policy is compatible with all services.
1957  *
1958  * \param[in] svc  The service the policy is attempting to register with.
1959  * \param[in] desc The policy descriptor
1960  *
1961  * \retval true The policy is compatible with the service
1962  *
1963  * \see ptlrpc_nrs_pol_desc::pd_compat()
1964  */
1965 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
1966                                          const struct ptlrpc_nrs_pol_desc *desc)
1967 {
1968         return true;
1969 }
1970
1971 /**
1972  * Service compatibility function; the policy is compatible with only a specific
1973  * service which is identified by its human-readable name at
1974  * ptlrpc_service::srv_name.
1975  *
1976  * \param[in] svc  The service the policy is attempting to register with.
1977  * \param[in] desc The policy descriptor
1978  *
1979  * \retval false The policy is not compatible with the service
1980  * \retval true  The policy is compatible with the service
1981  *
1982  * \see ptlrpc_nrs_pol_desc::pd_compat()
1983  */
1984 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
1985                                          const struct ptlrpc_nrs_pol_desc *desc)
1986 {
1987         LASSERT(desc->pd_compat_svc_name != NULL);
1988         return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
1989 }
1990
1991 /** @} nrs */
1992
1993 /* ptlrpc/events.c */
1994 extern struct lnet_handle_eq ptlrpc_eq_h;
1995 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
1996                                struct lnet_process_id *peer, lnet_nid_t *self);
1997 /**
1998  * These callbacks are invoked by LNet when something happened to
1999  * underlying buffer
2000  * @{
2001  */
2002 extern void request_out_callback(struct lnet_event *ev);
2003 extern void reply_in_callback(struct lnet_event *ev);
2004 extern void client_bulk_callback(struct lnet_event *ev);
2005 extern void request_in_callback(struct lnet_event *ev);
2006 extern void reply_out_callback(struct lnet_event *ev);
2007 #ifdef HAVE_SERVER_SUPPORT
2008 extern void server_bulk_callback(struct lnet_event *ev);
2009 #endif
2010 /** @} */
2011
2012 /* ptlrpc/connection.c */
2013 struct ptlrpc_connection *ptlrpc_connection_get(struct lnet_process_id peer,
2014                                                 lnet_nid_t self,
2015                                                 struct obd_uuid *uuid);
2016 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2017 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2018 int ptlrpc_connection_init(void);
2019 void ptlrpc_connection_fini(void);
2020 extern lnet_pid_t ptl_get_pid(void);
2021
2022 /* ptlrpc/niobuf.c */
2023 /**
2024  * Actual interfacing with LNet to put/get/register/unregister stuff
2025  * @{
2026  */
2027 #ifdef HAVE_SERVER_SUPPORT
2028 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2029                                               unsigned nfrags, unsigned max_brw,
2030                                               unsigned int type,
2031                                               unsigned portal,
2032                                               const struct ptlrpc_bulk_frag_ops
2033                                                 *ops);
2034 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2035 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2036
2037 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2038 {
2039         int rc;
2040
2041         LASSERT(desc != NULL);
2042
2043         spin_lock(&desc->bd_lock);
2044         rc = desc->bd_md_count;
2045         spin_unlock(&desc->bd_lock);
2046         return rc;
2047 }
2048 #endif
2049
2050 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2051 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2052
2053 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2054 {
2055         struct ptlrpc_bulk_desc *desc;
2056         int rc;
2057
2058         LASSERT(req != NULL);
2059         desc = req->rq_bulk;
2060
2061         if (req->rq_bulk_deadline > ktime_get_real_seconds())
2062                 return 1;
2063
2064         if (!desc)
2065                 return 0;
2066
2067         spin_lock(&desc->bd_lock);
2068         rc = desc->bd_md_count;
2069         spin_unlock(&desc->bd_lock);
2070         return rc;
2071 }
2072
2073 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2074 #define PTLRPC_REPLY_EARLY           0x02
2075 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2076 int ptlrpc_reply(struct ptlrpc_request *req);
2077 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2078 int ptlrpc_error(struct ptlrpc_request *req);
2079 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2080 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2081 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2082 /** @} */
2083
2084 /* ptlrpc/client.c */
2085 /**
2086  * Client-side portals API. Everything to send requests, receive replies,
2087  * request queues, request management, etc.
2088  * @{
2089  */
2090 void ptlrpc_request_committed(struct ptlrpc_request *req, int force);
2091
2092 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
2093                         struct ptlrpc_client *);
2094 void ptlrpc_cleanup_client(struct obd_import *imp);
2095 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid,
2096                                                     lnet_nid_t nid4refnet);
2097
2098 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2099 int ptlrpc_replay_req(struct ptlrpc_request *req);
2100 void ptlrpc_restart_req(struct ptlrpc_request *req);
2101 void ptlrpc_abort_inflight(struct obd_import *imp);
2102 void ptlrpc_cleanup_imp(struct obd_import *imp);
2103 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2104
2105 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2106 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2107                                              void *arg);
2108 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
2109                       set_interpreter_func fn, void *data);
2110 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2111 int ptlrpc_set_wait(struct ptlrpc_request_set *);
2112 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2113 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2114 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2115
2116 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2117 int ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2118
2119 struct ptlrpc_request_pool *
2120 ptlrpc_init_rq_pool(int, int,
2121                     int (*populate_pool)(struct ptlrpc_request_pool *, int));
2122
2123 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2124 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2125                                             const struct req_format *format);
2126 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2127                                             struct ptlrpc_request_pool *,
2128                                             const struct req_format *format);
2129 void ptlrpc_request_free(struct ptlrpc_request *request);
2130 int ptlrpc_request_pack(struct ptlrpc_request *request,
2131                         __u32 version, int opcode);
2132 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2133                                                 const struct req_format *format,
2134                                                 __u32 version, int opcode);
2135 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2136                              __u32 version, int opcode, char **bufs,
2137                              struct ptlrpc_cli_ctx *ctx);
2138 void ptlrpc_req_finished(struct ptlrpc_request *request);
2139 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2140 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2141 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2142                                               unsigned nfrags, unsigned max_brw,
2143                                               unsigned int type,
2144                                               unsigned portal,
2145                                               const struct ptlrpc_bulk_frag_ops
2146                                                 *ops);
2147
2148 int ptlrpc_prep_bulk_frag(struct ptlrpc_bulk_desc *desc,
2149                           void *frag, int len);
2150 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2151                              struct page *page, int pageoffset, int len,
2152                              int pin);
2153 static inline void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
2154                                              struct page *page, int pageoffset,
2155                                              int len)
2156 {
2157         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
2158 }
2159
2160 static inline void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
2161                                                struct page *page, int pageoffset,
2162                                                int len)
2163 {
2164         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
2165 }
2166
2167 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
2168
2169 static inline void ptlrpc_release_bulk_page_pin(struct ptlrpc_bulk_desc *desc)
2170 {
2171         int i;
2172
2173         for (i = 0; i < desc->bd_iov_count ; i++)
2174                 put_page(BD_GET_KIOV(desc, i).kiov_page);
2175 }
2176
2177 static inline void ptlrpc_release_bulk_noop(struct ptlrpc_bulk_desc *desc)
2178 {
2179 }
2180
2181 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
2182                                       struct obd_import *imp);
2183 __u64 ptlrpc_next_xid(void);
2184 __u64 ptlrpc_sample_next_xid(void);
2185 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
2186
2187 /* Set of routines to run a function in ptlrpcd context */
2188 void *ptlrpcd_alloc_work(struct obd_import *imp,
2189                          int (*cb)(const struct lu_env *, void *), void *data);
2190 void ptlrpcd_destroy_work(void *handler);
2191 int ptlrpcd_queue_work(void *handler);
2192
2193 /** @} */
2194 struct ptlrpc_service_buf_conf {
2195         /* nbufs is buffers # to allocate when growing the pool */
2196         unsigned int                    bc_nbufs;
2197         /* buffer size to post */
2198         unsigned int                    bc_buf_size;
2199         /* portal to listed for requests on */
2200         unsigned int                    bc_req_portal;
2201         /* portal of where to send replies to */
2202         unsigned int                    bc_rep_portal;
2203         /* maximum request size to be accepted for this service */
2204         unsigned int                    bc_req_max_size;
2205         /* maximum reply size this service can ever send */
2206         unsigned int                    bc_rep_max_size;
2207 };
2208
2209 struct ptlrpc_service_thr_conf {
2210         /* threadname should be 8 characters or less - 6 will be added on */
2211         char                            *tc_thr_name;
2212         /* threads increasing factor for each CPU */
2213         unsigned int                    tc_thr_factor;
2214         /* service threads # to start on each partition while initializing */
2215         unsigned int                    tc_nthrs_init;
2216         /*
2217          * low water of threads # upper-limit on each partition while running,
2218          * service availability may be impacted if threads number is lower
2219          * than this value. It can be ZERO if the service doesn't require
2220          * CPU affinity or there is only one partition.
2221          */
2222         unsigned int                    tc_nthrs_base;
2223         /* "soft" limit for total threads number */
2224         unsigned int                    tc_nthrs_max;
2225         /* user specified threads number, it will be validated due to
2226          * other members of this structure. */
2227         unsigned int                    tc_nthrs_user;
2228         /* set NUMA node affinity for service threads */
2229         unsigned int                    tc_cpu_affinity;
2230         /* Tags for lu_context associated with service thread */
2231         __u32                           tc_ctx_tags;
2232 };
2233
2234 struct ptlrpc_service_cpt_conf {
2235         struct cfs_cpt_table            *cc_cptable;
2236         /* string pattern to describe CPTs for a service */
2237         char                            *cc_pattern;
2238 };
2239
2240 struct ptlrpc_service_conf {
2241         /* service name */
2242         char                            *psc_name;
2243         /* soft watchdog timeout multiplifier to print stuck service traces */
2244         unsigned int                    psc_watchdog_factor;
2245         /* buffer information */
2246         struct ptlrpc_service_buf_conf  psc_buf;
2247         /* thread information */
2248         struct ptlrpc_service_thr_conf  psc_thr;
2249         /* CPU partition information */
2250         struct ptlrpc_service_cpt_conf  psc_cpt;
2251         /* function table */
2252         struct ptlrpc_service_ops       psc_ops;
2253 };
2254
2255 /* ptlrpc/service.c */
2256 /**
2257  * Server-side services API. Register/unregister service, request state
2258  * management, service thread management
2259  *
2260  * @{
2261  */
2262 void ptlrpc_save_lock(struct ptlrpc_request *req, struct lustre_handle *lock,
2263                       int mode, bool no_ack, bool convert_lock);
2264 void ptlrpc_commit_replies(struct obd_export *exp);
2265 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
2266 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
2267 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
2268 struct ptlrpc_service *ptlrpc_register_service(
2269                                 struct ptlrpc_service_conf *conf,
2270                                 struct kset *parent,
2271                                 struct proc_dir_entry *proc_entry);
2272 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
2273
2274 int ptlrpc_start_threads(struct ptlrpc_service *svc);
2275 int ptlrpc_unregister_service(struct ptlrpc_service *service);
2276 int liblustre_check_services(void *arg);
2277 void ptlrpc_daemonize(char *name);
2278 int ptlrpc_service_health_check(struct ptlrpc_service *);
2279 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
2280 void ptlrpc_request_change_export(struct ptlrpc_request *req,
2281                                   struct obd_export *export);
2282 void ptlrpc_update_export_timer(struct obd_export *exp, long extra_delay);
2283
2284 int ptlrpc_hr_init(void);
2285 void ptlrpc_hr_fini(void);
2286
2287 /** @} */
2288
2289 /* ptlrpc/import.c */
2290 /**
2291  * Import API
2292  * @{
2293  */
2294 int ptlrpc_connect_import(struct obd_import *imp);
2295 int ptlrpc_init_import(struct obd_import *imp);
2296 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
2297 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
2298 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
2299                int *uuid_len);
2300 void ptlrpc_import_enter_resend(struct obd_import *imp);
2301 /* ptlrpc/pack_generic.c */
2302 int ptlrpc_reconnect_import(struct obd_import *imp);
2303 /** @} */
2304
2305 /**
2306  * ptlrpc msg buffer and swab interface
2307  *
2308  * @{
2309  */
2310 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
2311                          __u32 index);
2312 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
2313                             __u32 index);
2314 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
2315 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
2316
2317 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
2318 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
2319                         char **bufs);
2320 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
2321                         __u32 *lens, char **bufs);
2322 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
2323                       char **bufs);
2324 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
2325                          __u32 *lens, char **bufs, int flags);
2326 #define LPRFL_EARLY_REPLY 1
2327 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
2328                             char **bufs, int flags);
2329 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
2330                       unsigned int newlen, int move_data);
2331 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
2332 int __lustre_unpack_msg(struct lustre_msg *m, int len);
2333 __u32 lustre_msg_hdr_size(__u32 magic, __u32 count);
2334 __u32 lustre_msg_size(__u32 magic, int count, __u32 *lengths);
2335 __u32 lustre_msg_size_v2(int count, __u32 *lengths);
2336 __u32 lustre_packed_msg_size(struct lustre_msg *msg);
2337 __u32 lustre_msg_early_size(void);
2338 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, __u32 n, __u32 min_size);
2339 void *lustre_msg_buf(struct lustre_msg *m, __u32 n, __u32 minlen);
2340 __u32 lustre_msg_buflen(struct lustre_msg *m, __u32 n);
2341 void lustre_msg_set_buflen(struct lustre_msg *m, __u32 n, __u32 len);
2342 __u32 lustre_msg_bufcount(struct lustre_msg *m);
2343 char *lustre_msg_string(struct lustre_msg *m, __u32 n, __u32 max_len);
2344 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
2345 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
2346 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
2347 void lustre_msg_add_flags(struct lustre_msg *msg, __u32 flags);
2348 void lustre_msg_set_flags(struct lustre_msg *msg, __u32 flags);
2349 void lustre_msg_clear_flags(struct lustre_msg *msg, __u32 flags);
2350 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
2351 void lustre_msg_add_op_flags(struct lustre_msg *msg, __u32 flags);
2352 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
2353 __u32 lustre_msg_get_type(struct lustre_msg *msg);
2354 __u32 lustre_msg_get_version(struct lustre_msg *msg);
2355 void lustre_msg_add_version(struct lustre_msg *msg, __u32 version);
2356 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
2357 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
2358 __u16 lustre_msg_get_tag(struct lustre_msg *msg);
2359 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
2360 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
2361 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
2362 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
2363 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
2364 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
2365 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
2366 int lustre_msg_get_status(struct lustre_msg *msg);
2367 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
2368 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
2369 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
2370 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
2371 char *lustre_msg_get_jobid(struct lustre_msg *msg);
2372 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
2373 __u64 lustre_msg_get_mbits(struct lustre_msg *msg);
2374 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
2375 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
2376 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
2377 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
2378 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
2379 void lustre_msg_set_tag(struct lustre_msg *msg, __u16 tag);
2380 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
2381 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
2382 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
2383 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
2384 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
2385 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
2386 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
2387 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
2388 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
2389 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
2390 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
2391 void lustre_msg_set_mbits(struct lustre_msg *msg, __u64 mbits);
2392
2393 static inline void
2394 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
2395                     unsigned int newlen, int move_data)
2396 {
2397         LASSERT(req->rq_reply_state);
2398         LASSERT(req->rq_repmsg);
2399         req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
2400                                            newlen, move_data);
2401 }
2402
2403 #ifdef LUSTRE_TRANSLATE_ERRNOS
2404
2405 static inline int ptlrpc_status_hton(int h)
2406 {
2407         /*
2408          * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
2409          * ELDLM_LOCK_ABORTED, etc.
2410          */
2411         if (h < 0)
2412                 return -lustre_errno_hton(-h);
2413         else
2414                 return h;
2415 }
2416
2417 static inline int ptlrpc_status_ntoh(int n)
2418 {
2419         /*
2420          * See the comment in ptlrpc_status_hton().
2421          */
2422         if (n < 0)
2423                 return -lustre_errno_ntoh(-n);
2424         else
2425                 return n;
2426 }
2427
2428 #else
2429
2430 #define ptlrpc_status_hton(h) (h)
2431 #define ptlrpc_status_ntoh(n) (n)
2432
2433 #endif
2434 /** @} */
2435
2436 /** Change request phase of \a req to \a new_phase */
2437 static inline void
2438 ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase)
2439 {
2440         if (req->rq_phase == new_phase)
2441                 return;
2442
2443         if (new_phase == RQ_PHASE_UNREG_RPC ||
2444             new_phase == RQ_PHASE_UNREG_BULK) {
2445                 /* No embedded unregistering phases */
2446                 if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2447                     req->rq_phase == RQ_PHASE_UNREG_BULK)
2448                         return;
2449
2450                 req->rq_next_phase = req->rq_phase;
2451                 if (req->rq_import)
2452                         atomic_inc(&req->rq_import->imp_unregistering);
2453         }
2454
2455         if (req->rq_phase == RQ_PHASE_UNREG_RPC ||
2456             req->rq_phase == RQ_PHASE_UNREG_BULK) {
2457                 if (req->rq_import)
2458                         atomic_dec(&req->rq_import->imp_unregistering);
2459         }
2460
2461         DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"",
2462                   ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase));
2463
2464         req->rq_phase = new_phase;
2465 }
2466
2467 /**
2468  * Returns true if request \a req got early reply and hard deadline is not met
2469  */
2470 static inline int
2471 ptlrpc_client_early(struct ptlrpc_request *req)
2472 {
2473         return req->rq_early;
2474 }
2475
2476 /**
2477  * Returns true if we got real reply from server for this request
2478  */
2479 static inline int
2480 ptlrpc_client_replied(struct ptlrpc_request *req)
2481 {
2482         if (req->rq_reply_deadline > ktime_get_real_seconds())
2483                 return 0;
2484         return req->rq_replied;
2485 }
2486
2487 /** Returns true if request \a req is in process of receiving server reply */
2488 static inline int
2489 ptlrpc_client_recv(struct ptlrpc_request *req)
2490 {
2491         if (req->rq_reply_deadline > ktime_get_real_seconds())
2492                 return 1;
2493         return req->rq_receiving_reply;
2494 }
2495
2496 static inline int
2497 ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req)
2498 {
2499         int rc;
2500
2501         spin_lock(&req->rq_lock);
2502         if (req->rq_reply_deadline > ktime_get_real_seconds()) {
2503                 spin_unlock(&req->rq_lock);
2504                 return 1;
2505         }
2506         if (req->rq_req_deadline > ktime_get_real_seconds()) {
2507                 spin_unlock(&req->rq_lock);
2508                 return 1;
2509         }
2510
2511         rc = !req->rq_req_unlinked || !req->rq_reply_unlinked ||
2512              req->rq_receiving_reply;
2513         spin_unlock(&req->rq_lock);
2514         return rc;
2515 }
2516
2517 static inline void
2518 ptlrpc_client_wake_req(struct ptlrpc_request *req)
2519 {
2520         if (req->rq_set == NULL)
2521                 wake_up(&req->rq_reply_waitq);
2522         else
2523                 wake_up(&req->rq_set->set_waitq);
2524 }
2525
2526 static inline void
2527 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
2528 {
2529         LASSERT(atomic_read(&rs->rs_refcount) > 0);
2530         atomic_inc(&rs->rs_refcount);
2531 }
2532
2533 static inline void
2534 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
2535 {
2536         LASSERT(atomic_read(&rs->rs_refcount) > 0);
2537         if (atomic_dec_and_test(&rs->rs_refcount))
2538                 lustre_free_reply_state(rs);
2539 }
2540
2541 /* Should only be called once per req */
2542 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
2543 {
2544         if (req->rq_reply_state == NULL)
2545                 return; /* shouldn't occur */
2546         ptlrpc_rs_decref(req->rq_reply_state);
2547         req->rq_reply_state = NULL;
2548         req->rq_repmsg = NULL;
2549 }
2550
2551 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
2552 {
2553         return lustre_msg_get_magic(req->rq_reqmsg);
2554 }
2555
2556 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
2557 {
2558         switch (req->rq_reqmsg->lm_magic) {
2559         case LUSTRE_MSG_MAGIC_V2:
2560                 return req->rq_reqmsg->lm_repsize;
2561         default:
2562                 LASSERTF(0, "incorrect message magic: %08x\n",
2563                          req->rq_reqmsg->lm_magic);
2564                 return -EFAULT;
2565         }
2566 }
2567
2568 static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req)
2569 {
2570         if (req->rq_delay_limit != 0 &&
2571             cfs_time_before(cfs_time_add(req->rq_queued_time,
2572                                          cfs_time_seconds(req->rq_delay_limit)),
2573                             cfs_time_current())) {
2574                 return 1;
2575         }
2576         return 0;
2577 }
2578
2579 static inline int ptlrpc_no_resend(struct ptlrpc_request *req)
2580 {
2581         if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) {
2582                 spin_lock(&req->rq_lock);
2583                 req->rq_no_resend = 1;
2584                 spin_unlock(&req->rq_lock);
2585         }
2586         return req->rq_no_resend;
2587 }
2588
2589 static inline int
2590 ptlrpc_server_get_timeout(struct ptlrpc_service_part *svcpt)
2591 {
2592         int at = AT_OFF ? 0 : at_get(&svcpt->scp_at_estimate);
2593
2594         return svcpt->scp_service->srv_watchdog_factor *
2595                max_t(int, at, obd_timeout);
2596 }
2597
2598 static inline struct ptlrpc_service *
2599 ptlrpc_req2svc(struct ptlrpc_request *req)
2600 {
2601         LASSERT(req->rq_rqbd != NULL);
2602         return req->rq_rqbd->rqbd_svcpt->scp_service;
2603 }
2604
2605 /* ldlm/ldlm_lib.c */
2606 /**
2607  * Target client logic
2608  * @{
2609  */
2610 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
2611 int client_obd_cleanup(struct obd_device *obddev);
2612 int client_connect_import(const struct lu_env *env,
2613                           struct obd_export **exp, struct obd_device *obd,
2614                           struct obd_uuid *cluuid, struct obd_connect_data *,
2615                           void *localdata);
2616 int client_disconnect_export(struct obd_export *exp);
2617 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
2618                            int priority);
2619 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
2620 int client_import_find_conn(struct obd_import *imp, lnet_nid_t peer,
2621                             struct obd_uuid *uuid);
2622 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
2623 void client_destroy_import(struct obd_import *imp);
2624 /** @} */
2625
2626 #ifdef HAVE_SERVER_SUPPORT
2627 int server_disconnect_export(struct obd_export *exp);
2628 #endif
2629
2630 /* ptlrpc/pinger.c */
2631 /**
2632  * Pinger API (client side only)
2633  * @{
2634  */
2635 enum timeout_event {
2636         TIMEOUT_GRANT = 1
2637 };
2638 struct timeout_item;
2639 typedef int (*timeout_cb_t)(struct timeout_item *, void *);
2640 int ptlrpc_pinger_add_import(struct obd_import *imp);
2641 int ptlrpc_pinger_del_import(struct obd_import *imp);
2642 int ptlrpc_add_timeout_client(int time, enum timeout_event event,
2643                               timeout_cb_t cb, void *data,
2644                               struct list_head *obd_list);
2645 int ptlrpc_del_timeout_client(struct list_head *obd_list,
2646                               enum timeout_event event);
2647 struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp);
2648 int ptlrpc_obd_ping(struct obd_device *obd);
2649 void ping_evictor_start(void);
2650 void ping_evictor_stop(void);
2651 void ptlrpc_pinger_ir_up(void);
2652 void ptlrpc_pinger_ir_down(void);
2653 /** @} */
2654 int ptlrpc_pinger_suppress_pings(void);
2655
2656 /* ptlrpc/ptlrpcd.c */
2657 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
2658 void ptlrpcd_free(struct ptlrpcd_ctl *pc);
2659 void ptlrpcd_wake(struct ptlrpc_request *req);
2660 void ptlrpcd_add_req(struct ptlrpc_request *req);
2661 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set);
2662 int ptlrpcd_addref(void);
2663 void ptlrpcd_decref(void);
2664
2665 /* ptlrpc/lproc_ptlrpc.c */
2666 /**
2667  * procfs output related functions
2668  * @{
2669  */
2670 const char* ll_opcode2str(__u32 opcode);
2671 const int ll_str2opcode(const char *ops);
2672 #ifdef CONFIG_PROC_FS
2673 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
2674 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
2675 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
2676 #else
2677 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
2678 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
2679 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
2680 #endif
2681 /** @} */
2682
2683 /* ptlrpc/llog_server.c */
2684 int llog_origin_handle_open(struct ptlrpc_request *req);
2685 int llog_origin_handle_destroy(struct ptlrpc_request *req);
2686 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
2687 int llog_origin_handle_next_block(struct ptlrpc_request *req);
2688 int llog_origin_handle_read_header(struct ptlrpc_request *req);
2689 int llog_origin_handle_close(struct ptlrpc_request *req);
2690
2691 /* ptlrpc/llog_client.c */
2692 extern struct llog_operations llog_client_ops;
2693 /** @} net */
2694
2695 #endif
2696 /** @} PtlRPC */