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