Whamcloud - gitweb
LU-3963 obdclass: convert to linux list api
[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, 2013, 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 #if defined(__linux__)
59 #include <linux/lustre_net.h>
60 #elif defined(__APPLE__)
61 #include <darwin/lustre_net.h>
62 #elif defined(__WINNT__)
63 #include <winnt/lustre_net.h>
64 #else
65 #error Unsupported operating system.
66 #endif
67
68 #include <libcfs/libcfs.h>
69 // #include <obd.h>
70 #include <lnet/lnet.h>
71 #include <lustre/lustre_idl.h>
72 #include <lustre_ha.h>
73 #include <lustre_sec.h>
74 #include <lustre_import.h>
75 #include <lprocfs_status.h>
76 #include <lu_object.h>
77 #include <lustre_req_layout.h>
78
79 #include <obd_support.h>
80 #include <lustre_ver.h>
81
82 /* MD flags we _always_ use */
83 #define PTLRPC_MD_OPTIONS  0
84
85 /**
86  * Max # of bulk operations in one request.
87  * In order for the client and server to properly negotiate the maximum
88  * possible transfer size, PTLRPC_BULK_OPS_COUNT must be a power-of-two
89  * value.  The client is free to limit the actual RPC size for any bulk
90  * transfer via cl_max_pages_per_rpc to some non-power-of-two value. */
91 #define PTLRPC_BULK_OPS_BITS    2
92 #define PTLRPC_BULK_OPS_COUNT   (1U << PTLRPC_BULK_OPS_BITS)
93 /**
94  * PTLRPC_BULK_OPS_MASK is for the convenience of the client only, and
95  * should not be used on the server at all.  Otherwise, it imposes a
96  * protocol limitation on the maximum RPC size that can be used by any
97  * RPC sent to that server in the future.  Instead, the server should
98  * use the negotiated per-client ocd_brw_size to determine the bulk
99  * RPC count. */
100 #define PTLRPC_BULK_OPS_MASK    (~((__u64)PTLRPC_BULK_OPS_COUNT - 1))
101
102 /**
103  * Define maxima for bulk I/O.
104  *
105  * A single PTLRPC BRW request is sent via up to PTLRPC_BULK_OPS_COUNT
106  * of LNET_MTU sized RDMA transfers.  Clients and servers negotiate the
107  * currently supported maximum between peers at connect via ocd_brw_size.
108  */
109 #define PTLRPC_MAX_BRW_BITS     (LNET_MTU_BITS + PTLRPC_BULK_OPS_BITS)
110 #define PTLRPC_MAX_BRW_SIZE     (1 << PTLRPC_MAX_BRW_BITS)
111 #define PTLRPC_MAX_BRW_PAGES    (PTLRPC_MAX_BRW_SIZE >> PAGE_CACHE_SHIFT)
112
113 #define ONE_MB_BRW_SIZE         (1 << LNET_MTU_BITS)
114 #define MD_MAX_BRW_SIZE         (1 << LNET_MTU_BITS)
115 #define MD_MAX_BRW_PAGES        (MD_MAX_BRW_SIZE >> PAGE_CACHE_SHIFT)
116 #define DT_MAX_BRW_SIZE         PTLRPC_MAX_BRW_SIZE
117 #define DT_MAX_BRW_PAGES        (DT_MAX_BRW_SIZE >> PAGE_CACHE_SHIFT)
118 #define OFD_MAX_BRW_SIZE        (1 << LNET_MTU_BITS)
119
120 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
121 #ifdef __KERNEL__
122 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
123 #  error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
124 # endif
125 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * PAGE_CACHE_SIZE))
126 #  error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * PAGE_CACHE_SIZE"
127 # endif
128 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU * PTLRPC_BULK_OPS_COUNT)
129 #  error "PTLRPC_MAX_BRW_SIZE too big"
130 # endif
131 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV * PTLRPC_BULK_OPS_COUNT)
132 #  error "PTLRPC_MAX_BRW_PAGES too big"
133 # endif
134 #endif /* __KERNEL__ */
135
136 #define PTLRPC_NTHRS_INIT       2
137
138 /**
139  * Buffer Constants
140  *
141  * Constants determine how memory is used to buffer incoming service requests.
142  *
143  * ?_NBUFS              # buffers to allocate when growing the pool
144  * ?_BUFSIZE            # bytes in a single request buffer
145  * ?_MAXREQSIZE         # maximum request service will receive
146  *
147  * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
148  * of ?_NBUFS is added to the pool.
149  *
150  * Messages larger than ?_MAXREQSIZE are dropped.  Request buffers are
151  * considered full when less than ?_MAXREQSIZE is left in them.
152  */
153 /**
154  * Thread Constants
155  *
156  * Constants determine how threads are created for ptlrpc service.
157  *
158  * ?_NTHRS_INIT         # threads to create for each service partition on
159  *                        initializing. If it's non-affinity service and
160  *                        there is only one partition, it's the overall #
161  *                        threads for the service while initializing.
162  * ?_NTHRS_BASE         # threads should be created at least for each
163  *                        ptlrpc partition to keep the service healthy.
164  *                        It's the low-water mark of threads upper-limit
165  *                        for each partition.
166  * ?_THR_FACTOR         # threads can be added on threads upper-limit for
167  *                        each CPU core. This factor is only for reference,
168  *                        we might decrease value of factor if number of cores
169  *                        per CPT is above a limit.
170  * ?_NTHRS_MAX          # overall threads can be created for a service,
171  *                        it's a soft limit because if service is running
172  *                        on machine with hundreds of cores and tens of
173  *                        CPU partitions, we need to guarantee each partition
174  *                        has ?_NTHRS_BASE threads, which means total threads
175  *                        will be ?_NTHRS_BASE * number_of_cpts which can
176  *                        exceed ?_NTHRS_MAX.
177  *
178  * Examples
179  *
180  * #define MDS_NTHRS_INIT       2
181  * #define MDS_NTHRS_BASE       64
182  * #define MDS_NTHRS_FACTOR     8
183  * #define MDS_NTHRS_MAX        1024
184  *
185  * Example 1):
186  * ---------------------------------------------------------------------
187  * Server(A) has 16 cores, user configured it to 4 partitions so each
188  * partition has 4 cores, then actual number of service threads on each
189  * partition is:
190  *     MDS_NTHRS_BASE(64) + cores(4) * MDS_NTHRS_FACTOR(8) = 96
191  *
192  * Total number of threads for the service is:
193  *     96 * partitions(4) = 384
194  *
195  * Example 2):
196  * ---------------------------------------------------------------------
197  * Server(B) has 32 cores, user configured it to 4 partitions so each
198  * partition has 8 cores, then actual number of service threads on each
199  * partition is:
200  *     MDS_NTHRS_BASE(64) + cores(8) * MDS_NTHRS_FACTOR(8) = 128
201  *
202  * Total number of threads for the service is:
203  *     128 * partitions(4) = 512
204  *
205  * Example 3):
206  * ---------------------------------------------------------------------
207  * Server(B) has 96 cores, user configured it to 8 partitions so each
208  * partition has 12 cores, then actual number of service threads on each
209  * partition is:
210  *     MDS_NTHRS_BASE(64) + cores(12) * MDS_NTHRS_FACTOR(8) = 160
211  *
212  * Total number of threads for the service is:
213  *     160 * partitions(8) = 1280
214  *
215  * However, it's above the soft limit MDS_NTHRS_MAX, so we choose this number
216  * as upper limit of threads number for each partition:
217  *     MDS_NTHRS_MAX(1024) / partitions(8) = 128
218  *
219  * Example 4):
220  * ---------------------------------------------------------------------
221  * Server(C) have a thousand of cores and user configured it to 32 partitions
222  *     MDS_NTHRS_BASE(64) * 32 = 2048
223  *
224  * which is already above soft limit MDS_NTHRS_MAX(1024), but we still need
225  * to guarantee that each partition has at least MDS_NTHRS_BASE(64) threads
226  * to keep service healthy, so total number of threads will just be 2048.
227  *
228  * NB: we don't suggest to choose server with that many cores because backend
229  *     filesystem itself, buffer cache, or underlying network stack might
230  *     have some SMP scalability issues at that large scale.
231  *
232  *     If user already has a fat machine with hundreds or thousands of cores,
233  *     there are two choices for configuration:
234  *     a) create CPU table from subset of all CPUs and run Lustre on
235  *        top of this subset
236  *     b) bind service threads on a few partitions, see modparameters of
237  *        MDS and OSS for details
238 *
239  * NB: these calculations (and examples below) are simplified to help
240  *     understanding, the real implementation is a little more complex,
241  *     please see ptlrpc_server_nthreads_check() for details.
242  *
243  */
244
245  /*
246   * LDLM threads constants:
247   *
248   * Given 8 as factor and 24 as base threads number
249   *
250   * example 1)
251   * On 4-core machine we will have 24 + 8 * 4 = 56 threads.
252   *
253   * example 2)
254   * On 8-core machine with 2 partitions we will have 24 + 4 * 8 = 56
255   * threads for each partition and total threads number will be 112.
256   *
257   * example 3)
258   * On 64-core machine with 8 partitions we will need LDLM_NTHRS_BASE(24)
259   * threads for each partition to keep service healthy, so total threads
260   * number should be 24 * 8 = 192.
261   *
262   * So with these constants, threads number will be at the similar level
263   * of old versions, unless target machine has over a hundred cores
264   */
265 #define LDLM_THR_FACTOR         8
266 #define LDLM_NTHRS_INIT         PTLRPC_NTHRS_INIT
267 #define LDLM_NTHRS_BASE         24
268 #define LDLM_NTHRS_MAX          (num_online_cpus() == 1 ? 64 : 128)
269
270 #define LDLM_BL_THREADS   LDLM_NTHRS_AUTO_INIT
271 #define LDLM_CLIENT_NBUFS 1
272 #define LDLM_SERVER_NBUFS 64
273 #define LDLM_BUFSIZE      (8 * 1024)
274 #define LDLM_MAXREQSIZE   (5 * 1024)
275 #define LDLM_MAXREPSIZE   (1024)
276
277  /*
278   * MDS threads constants:
279   *
280   * Please see examples in "Thread Constants", MDS threads number will be at
281   * the comparable level of old versions, unless the server has many cores.
282   */
283 #ifndef MDS_MAX_THREADS
284 #define MDS_MAX_THREADS         1024
285 #define MDS_MAX_OTHR_THREADS    256
286
287 #else /* MDS_MAX_THREADS */
288 #if MDS_MAX_THREADS < PTLRPC_NTHRS_INIT
289 #undef MDS_MAX_THREADS
290 #define MDS_MAX_THREADS PTLRPC_NTHRS_INIT
291 #endif
292 #define MDS_MAX_OTHR_THREADS    max(PTLRPC_NTHRS_INIT, MDS_MAX_THREADS / 2)
293 #endif
294
295 /* default service */
296 #define MDS_THR_FACTOR          8
297 #define MDS_NTHRS_INIT          PTLRPC_NTHRS_INIT
298 #define MDS_NTHRS_MAX           MDS_MAX_THREADS
299 #define MDS_NTHRS_BASE          min(64, MDS_NTHRS_MAX)
300
301 /* read-page service */
302 #define MDS_RDPG_THR_FACTOR     4
303 #define MDS_RDPG_NTHRS_INIT     PTLRPC_NTHRS_INIT
304 #define MDS_RDPG_NTHRS_MAX      MDS_MAX_OTHR_THREADS
305 #define MDS_RDPG_NTHRS_BASE     min(48, MDS_RDPG_NTHRS_MAX)
306
307 /* these should be removed when we remove setattr service in the future */
308 #define MDS_SETA_THR_FACTOR     4
309 #define MDS_SETA_NTHRS_INIT     PTLRPC_NTHRS_INIT
310 #define MDS_SETA_NTHRS_MAX      MDS_MAX_OTHR_THREADS
311 #define MDS_SETA_NTHRS_BASE     min(48, MDS_SETA_NTHRS_MAX)
312
313 /* non-affinity threads */
314 #define MDS_OTHR_NTHRS_INIT     PTLRPC_NTHRS_INIT
315 #define MDS_OTHR_NTHRS_MAX      MDS_MAX_OTHR_THREADS
316
317 #define MDS_NBUFS               64
318
319 /**
320  * Assume file name length = FNAME_MAX = 256 (true for ext3).
321  *        path name length = PATH_MAX = 4096
322  *        LOV MD size max  = EA_MAX = 24 * 2000
323  *              (NB: 24 is size of lov_ost_data)
324  *        LOV LOGCOOKIE size max = 32 * 2000
325  *              (NB: 32 is size of llog_cookie)
326  * symlink:  FNAME_MAX + PATH_MAX  <- largest
327  * link:     FNAME_MAX + PATH_MAX  (mds_rec_link < mds_rec_create)
328  * rename:   FNAME_MAX + FNAME_MAX
329  * open:     FNAME_MAX + EA_MAX
330  *
331  * MDS_MAXREQSIZE ~= 4736 bytes =
332  * lustre_msg + ldlm_request + mdt_body + mds_rec_create + FNAME_MAX + PATH_MAX
333  * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
334  *
335  * Realistic size is about 512 bytes (20 character name + 128 char symlink),
336  * except in the open case where there are a large number of OSTs in a LOV.
337  */
338 #define MDS_MAXREQSIZE          (5 * 1024)      /* >= 4736 */
339 #define MDS_MAXREPSIZE          (9 * 1024)      /* >= 8300 */
340
341 /**
342  * MDS incoming request with LOV EA
343  * 24 = sizeof(struct lov_ost_data), i.e: replay of opencreate
344  */
345 #define MDS_LOV_MAXREQSIZE      max(MDS_MAXREQSIZE, \
346                                     362 + LOV_MAX_STRIPE_COUNT * 24)
347 /**
348  * MDS outgoing reply with LOV EA
349  *
350  * NB: max reply size Lustre 2.4+ client can get from old MDS is:
351  * LOV_MAX_STRIPE_COUNT * (llog_cookie + lov_ost_data) + extra bytes
352  *
353  * but 2.4 or later MDS will never send reply with llog_cookie to any
354  * version client. This macro is defined for server side reply buffer size.
355  */
356 #define MDS_LOV_MAXREPSIZE      MDS_LOV_MAXREQSIZE
357
358 /**
359  * This is the size of a maximum REINT_SETXATTR request:
360  *
361  *   lustre_msg          56 (32 + 4 x 5 + 4)
362  *   ptlrpc_body        184
363  *   mdt_rec_setxattr   136
364  *   lustre_capa        120
365  *   name               256 (XATTR_NAME_MAX)
366  *   value            65536 (XATTR_SIZE_MAX)
367  */
368 #define MDS_EA_MAXREQSIZE       66288
369
370 /**
371  * These are the maximum request and reply sizes (rounded up to 1 KB
372  * boundaries) for the "regular" MDS_REQUEST_PORTAL and MDS_REPLY_PORTAL.
373  */
374 #define MDS_REG_MAXREQSIZE      (((max(MDS_EA_MAXREQSIZE, \
375                                        MDS_LOV_MAXREQSIZE) + 1023) >> 10) << 10)
376 #define MDS_REG_MAXREPSIZE      MDS_REG_MAXREQSIZE
377
378 /**
379  * The update request includes all of updates from the create, which might
380  * include linkea (4K maxim), together with other updates, we set it to 9K:
381  * lustre_msg + ptlrpc_body + UPDATE_BUF_SIZE (8K)
382  */
383 #define OUT_MAXREQSIZE  (9 * 1024)
384 #define OUT_MAXREPSIZE  MDS_MAXREPSIZE
385
386 /** MDS_BUFSIZE = max_reqsize (w/o LOV EA) + max sptlrpc payload size */
387 #define MDS_BUFSIZE             max(MDS_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
388                                     8 * 1024)
389
390 /**
391  * MDS_REG_BUFSIZE should at least be MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD.
392  * However, we need to allocate a much larger buffer for it because LNet
393  * requires each MD(rqbd) has at least MDS_REQ_MAXREQSIZE bytes left to avoid
394  * dropping of maximum-sized incoming request.  So if MDS_REG_BUFSIZE is only a
395  * little larger than MDS_REG_MAXREQSIZE, then it can only fit in one request
396  * even there are about MDS_REG_MAX_REQSIZE bytes left in a rqbd, and memory
397  * utilization is very low.
398  *
399  * In the meanwhile, size of rqbd can't be too large, because rqbd can't be
400  * reused until all requests fit in it have been processed and released,
401  * which means one long blocked request can prevent the rqbd be reused.
402  * Now we set request buffer size to 160 KB, so even each rqbd is unlinked
403  * from LNet with unused 65 KB, buffer utilization will be about 59%.
404  * Please check LU-2432 for details.
405  */
406 #define MDS_REG_BUFSIZE         max(MDS_REG_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
407                                     160 * 1024)
408
409 /**
410  * OUT_BUFSIZE = max_out_reqsize + max sptlrpc payload (~1K) which is
411  * about 10K, for the same reason as MDS_REG_BUFSIZE, we also give some
412  * extra bytes to each request buffer to improve buffer utilization rate.
413   */
414 #define OUT_BUFSIZE             max(OUT_MAXREQSIZE + SPTLRPC_MAX_PAYLOAD, \
415                                     24 * 1024)
416
417 /** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc */
418 #define FLD_MAXREQSIZE  (160)
419
420 /** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body */
421 #define FLD_MAXREPSIZE  (152)
422 #define FLD_BUFSIZE     (1 << 12)
423
424 /**
425  * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
426  * __u32 padding */
427 #define SEQ_MAXREQSIZE  (160)
428
429 /** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
430 #define SEQ_MAXREPSIZE  (152)
431 #define SEQ_BUFSIZE     (1 << 12)
432
433 /** MGS threads must be >= 3, see bug 22458 comment #28 */
434 #define MGS_NTHRS_INIT  (PTLRPC_NTHRS_INIT + 1)
435 #define MGS_NTHRS_MAX   32
436
437 #define MGS_NBUFS       64
438 #define MGS_BUFSIZE     (8 * 1024)
439 #define MGS_MAXREQSIZE  (7 * 1024)
440 #define MGS_MAXREPSIZE  (9 * 1024)
441
442  /*
443   * OSS threads constants:
444   *
445   * Given 8 as factor and 64 as base threads number
446   *
447   * example 1):
448   * On 8-core server configured to 2 partitions, we will have
449   * 64 + 8 * 4 = 96 threads for each partition, 192 total threads.
450   *
451   * example 2):
452   * On 32-core machine configured to 4 partitions, we will have
453   * 64 + 8 * 8 = 112 threads for each partition, so total threads number
454   * will be 112 * 4 = 448.
455   *
456   * example 3):
457   * On 64-core machine configured to 4 partitions, we will have
458   * 64 + 16 * 8 = 192 threads for each partition, so total threads number
459   * will be 192 * 4 = 768 which is above limit OSS_NTHRS_MAX(512), so we
460   * cut off the value to OSS_NTHRS_MAX(512) / 4 which is 128 threads
461   * for each partition.
462   *
463   * So we can see that with these constants, threads number wil be at the
464   * similar level of old versions, unless the server has many cores.
465   */
466  /* depress threads factor for VM with small memory size */
467 #define OSS_THR_FACTOR          min_t(int, 8, \
468                                 NUM_CACHEPAGES >> (28 - PAGE_CACHE_SHIFT))
469 #define OSS_NTHRS_INIT          (PTLRPC_NTHRS_INIT + 1)
470 #define OSS_NTHRS_BASE          64
471 #define OSS_NTHRS_MAX           512
472
473 /* threads for handling "create" request */
474 #define OSS_CR_THR_FACTOR       1
475 #define OSS_CR_NTHRS_INIT       PTLRPC_NTHRS_INIT
476 #define OSS_CR_NTHRS_BASE       8
477 #define OSS_CR_NTHRS_MAX        64
478
479 /**
480  * OST_IO_MAXREQSIZE ~=
481  *      lustre_msg + ptlrpc_body + obdo + obd_ioobj +
482  *      DT_MAX_BRW_PAGES * niobuf_remote
483  *
484  * - single object with 16 pages is 512 bytes
485  * - OST_IO_MAXREQSIZE must be at least 1 page of cookies plus some spillover
486  * - Must be a multiple of 1024
487  * - actual size is about 18K
488  */
489 #define _OST_MAXREQSIZE_SUM (sizeof(struct lustre_msg) + \
490                              sizeof(struct ptlrpc_body) + \
491                              sizeof(struct obdo) + \
492                              sizeof(struct obd_ioobj) + \
493                              sizeof(struct niobuf_remote) * DT_MAX_BRW_PAGES)
494 /**
495  * FIEMAP request can be 4K+ for now
496  */
497 #define OST_MAXREQSIZE          (16 * 1024)
498 #define OST_IO_MAXREQSIZE       max_t(int, OST_MAXREQSIZE, \
499                                 (((_OST_MAXREQSIZE_SUM - 1) | (1024 - 1)) + 1))
500
501 #define OST_MAXREPSIZE          (9 * 1024)
502 #define OST_IO_MAXREPSIZE       OST_MAXREPSIZE
503
504 #define OST_NBUFS               64
505 /** OST_BUFSIZE = max_reqsize + max sptlrpc payload size */
506 #define OST_BUFSIZE             max_t(int, OST_MAXREQSIZE + 1024, 16 * 1024)
507 /**
508  * OST_IO_MAXREQSIZE is 18K, giving extra 46K can increase buffer utilization
509  * rate of request buffer, please check comment of MDS_LOV_BUFSIZE for details.
510  */
511 #define OST_IO_BUFSIZE          max_t(int, OST_IO_MAXREQSIZE + 1024, 64 * 1024)
512
513 /* Macro to hide a typecast. */
514 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
515
516 /**
517  * Structure to single define portal connection.
518  */
519 struct ptlrpc_connection {
520         /** linkage for connections hash table */
521         struct hlist_node        c_hash;
522         /** Our own lnet nid for this connection */
523         lnet_nid_t              c_self;
524         /** Remote side nid for this connection */
525         lnet_process_id_t       c_peer;
526         /** UUID of the other side */
527         struct obd_uuid         c_remote_uuid;
528         /** reference counter for this connection */
529         atomic_t            c_refcount;
530 };
531
532 /** Client definition for PortalRPC */
533 struct ptlrpc_client {
534         /** What lnet portal does this client send messages to by default */
535         __u32                   cli_request_portal;
536         /** What portal do we expect replies on */
537         __u32                   cli_reply_portal;
538         /** Name of the client */
539         char                   *cli_name;
540 };
541
542 /** state flags of requests */
543 /* XXX only ones left are those used by the bulk descs as well! */
544 #define PTL_RPC_FL_INTR      (1 << 0)  /* reply wait was interrupted by user */
545 #define PTL_RPC_FL_TIMEOUT   (1 << 7)  /* request timed out waiting for reply */
546
547 #define REQ_MAX_ACK_LOCKS 8
548
549 union ptlrpc_async_args {
550         /**
551          * Scratchpad for passing args to completion interpreter. Users
552          * cast to the struct of their choosing, and CLASSERT that this is
553          * big enough.  For _tons_ of context, OBD_ALLOC a struct and store
554          * a pointer to it here.  The pointer_arg ensures this struct is at
555          * least big enough for that.
556          */
557         void      *pointer_arg[11];
558         __u64      space[7];
559 };
560
561 struct ptlrpc_request_set;
562 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
563 typedef int (*set_producer_func)(struct ptlrpc_request_set *, void *);
564
565 /**
566  * Definition of request set structure.
567  * Request set is a list of requests (not necessary to the same target) that
568  * once populated with RPCs could be sent in parallel.
569  * There are two kinds of request sets. General purpose and with dedicated
570  * serving thread. Example of the latter is ptlrpcd set.
571  * For general purpose sets once request set started sending it is impossible
572  * to add new requests to such set.
573  * Provides a way to call "completion callbacks" when all requests in the set
574  * returned.
575  */
576 struct ptlrpc_request_set {
577         atomic_t                set_refcount;
578         /** number of in queue requests */
579         atomic_t                set_new_count;
580         /** number of uncompleted requests */
581         atomic_t                set_remaining;
582         /** wait queue to wait on for request events */
583         wait_queue_head_t       set_waitq;
584         wait_queue_head_t      *set_wakeup_ptr;
585         /** List of requests in the set */
586         struct list_head        set_requests;
587         /**
588          * List of completion callbacks to be called when the set is completed
589          * This is only used if \a set_interpret is NULL.
590          * Links struct ptlrpc_set_cbdata.
591          */
592         struct list_head        set_cblist;
593         /** Completion callback, if only one. */
594         set_interpreter_func    set_interpret;
595         /** opaq argument passed to completion \a set_interpret callback. */
596         void                    *set_arg;
597         /**
598          * Lock for \a set_new_requests manipulations
599          * locked so that any old caller can communicate requests to
600          * the set holder who can then fold them into the lock-free set
601          */
602         spinlock_t              set_new_req_lock;
603         /** List of new yet unsent requests. Only used with ptlrpcd now. */
604         struct list_head        set_new_requests;
605
606         /** rq_status of requests that have been freed already */
607         int                     set_rc;
608         /** Additional fields used by the flow control extension */
609         /** Maximum number of RPCs in flight */
610         int                     set_max_inflight;
611         /** Callback function used to generate RPCs */
612         set_producer_func       set_producer;
613         /** opaq argument passed to the producer callback */
614         void                    *set_producer_arg;
615 };
616
617 /**
618  * Description of a single ptrlrpc_set callback
619  */
620 struct ptlrpc_set_cbdata {
621         /** List linkage item */
622         struct list_head        psc_item;
623         /** Pointer to interpreting function */
624         set_interpreter_func    psc_interpret;
625         /** Opaq argument to pass to the callback */
626         void                    *psc_data;
627 };
628
629 struct ptlrpc_bulk_desc;
630 struct ptlrpc_service_part;
631 struct ptlrpc_service;
632
633 /**
634  * ptlrpc callback & work item stuff
635  */
636 struct ptlrpc_cb_id {
637         void   (*cbid_fn)(lnet_event_t *ev);     /* specific callback fn */
638         void    *cbid_arg;                      /* additional arg */
639 };
640
641 /** Maximum number of locks to fit into reply state */
642 #define RS_MAX_LOCKS 8
643 #define RS_DEBUG     0
644
645 /**
646  * Structure to define reply state on the server
647  * Reply state holds various reply message information. Also for "difficult"
648  * replies (rep-ack case) we store the state after sending reply and wait
649  * for the client to acknowledge the reception. In these cases locks could be
650  * added to the state for replay/failover consistency guarantees.
651  */
652 struct ptlrpc_reply_state {
653         /** Callback description */
654         struct ptlrpc_cb_id     rs_cb_id;
655         /** Linkage for list of all reply states in a system */
656         struct list_head        rs_list;
657         /** Linkage for list of all reply states on same export */
658         struct list_head        rs_exp_list;
659         /** Linkage for list of all reply states for same obd */
660         struct list_head        rs_obd_list;
661 #if RS_DEBUG
662         struct list_head        rs_debug_list;
663 #endif
664         /** A spinlock to protect the reply state flags */
665         spinlock_t              rs_lock;
666         /** Reply state flags */
667         unsigned long          rs_difficult:1;     /* ACK/commit stuff */
668         unsigned long          rs_no_ack:1;    /* no ACK, even for
669                                                   difficult requests */
670         unsigned long          rs_scheduled:1;     /* being handled? */
671         unsigned long          rs_scheduled_ever:1;/* any schedule attempts? */
672         unsigned long          rs_handled:1;  /* been handled yet? */
673         unsigned long          rs_on_net:1;   /* reply_out_callback pending? */
674         unsigned long          rs_prealloc:1; /* rs from prealloc list */
675         unsigned long          rs_committed:1;/* the transaction was committed
676                                                  and the rs was dispatched
677                                                  by ptlrpc_commit_replies */
678         /** Size of the state */
679         int                    rs_size;
680         /** opcode */
681         __u32                  rs_opc;
682         /** Transaction number */
683         __u64                  rs_transno;
684         /** xid */
685         __u64                  rs_xid;
686         struct obd_export     *rs_export;
687         struct ptlrpc_service_part *rs_svcpt;
688         /** Lnet metadata handle for the reply */
689         lnet_handle_md_t       rs_md_h;
690         atomic_t               rs_refcount;
691
692         /** Context for the sevice thread */
693         struct ptlrpc_svc_ctx *rs_svc_ctx;
694         /** Reply buffer (actually sent to the client), encoded if needed */
695         struct lustre_msg     *rs_repbuf;       /* wrapper */
696         /** Size of the reply buffer */
697         int                    rs_repbuf_len;   /* wrapper buf length */
698         /** Size of the reply message */
699         int                    rs_repdata_len;  /* wrapper msg length */
700         /**
701          * Actual reply message. Its content is encrupted (if needed) to
702          * produce reply buffer for actual sending. In simple case
703          * of no network encryption we jus set \a rs_repbuf to \a rs_msg
704          */
705         struct lustre_msg     *rs_msg;          /* reply message */
706
707         /** Number of locks awaiting client ACK */
708         int                    rs_nlocks;
709         /** Handles of locks awaiting client reply ACK */
710         struct lustre_handle   rs_locks[RS_MAX_LOCKS];
711         /** Lock modes of locks in \a rs_locks */
712         ldlm_mode_t            rs_modes[RS_MAX_LOCKS];
713 };
714
715 struct ptlrpc_thread;
716
717 /** RPC stages */
718 enum rq_phase {
719         RQ_PHASE_NEW            = 0xebc0de00,
720         RQ_PHASE_RPC            = 0xebc0de01,
721         RQ_PHASE_BULK           = 0xebc0de02,
722         RQ_PHASE_INTERPRET      = 0xebc0de03,
723         RQ_PHASE_COMPLETE       = 0xebc0de04,
724         RQ_PHASE_UNREGISTERING  = 0xebc0de05,
725         RQ_PHASE_UNDEFINED      = 0xebc0de06
726 };
727
728 /** Type of request interpreter call-back */
729 typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env,
730                                     struct ptlrpc_request *req,
731                                     void *arg, int rc);
732
733 /**
734  * Definition of request pool structure.
735  * The pool is used to store empty preallocated requests for the case
736  * when we would actually need to send something without performing
737  * any allocations (to avoid e.g. OOM).
738  */
739 struct ptlrpc_request_pool {
740         /** Locks the list */
741         spinlock_t              prp_lock;
742         /** list of ptlrpc_request structs */
743         struct list_head        prp_req_list;
744         /** Maximum message size that would fit into a rquest from this pool */
745         int                     prp_rq_size;
746         /** Function to allocate more requests for this pool */
747         void (*prp_populate)(struct ptlrpc_request_pool *, int);
748 };
749
750 struct lu_context;
751 struct lu_env;
752
753 struct ldlm_lock;
754
755 /**
756  * \defgroup nrs Network Request Scheduler
757  * @{
758  */
759 struct ptlrpc_nrs_policy;
760 struct ptlrpc_nrs_resource;
761 struct ptlrpc_nrs_request;
762
763 /**
764  * NRS control operations.
765  *
766  * These are common for all policies.
767  */
768 enum ptlrpc_nrs_ctl {
769         /**
770          * Not a valid opcode.
771          */
772         PTLRPC_NRS_CTL_INVALID,
773         /**
774          * Activate the policy.
775          */
776         PTLRPC_NRS_CTL_START,
777         /**
778          * Reserved for multiple primary policies, which may be a possibility
779          * in the future.
780          */
781         PTLRPC_NRS_CTL_STOP,
782         /**
783          * Policies can start using opcodes from this value and onwards for
784          * their own purposes; the assigned value itself is arbitrary.
785          */
786         PTLRPC_NRS_CTL_1ST_POL_SPEC = 0x20,
787 };
788
789 /**
790  * ORR policy operations
791  */
792 enum nrs_ctl_orr {
793         NRS_CTL_ORR_RD_QUANTUM = PTLRPC_NRS_CTL_1ST_POL_SPEC,
794         NRS_CTL_ORR_WR_QUANTUM,
795         NRS_CTL_ORR_RD_OFF_TYPE,
796         NRS_CTL_ORR_WR_OFF_TYPE,
797         NRS_CTL_ORR_RD_SUPP_REQ,
798         NRS_CTL_ORR_WR_SUPP_REQ,
799 };
800
801 /**
802  * NRS policy operations.
803  *
804  * These determine the behaviour of a policy, and are called in response to
805  * NRS core events.
806  */
807 struct ptlrpc_nrs_pol_ops {
808         /**
809          * Called during policy registration; this operation is optional.
810          *
811          * \param[in,out] policy The policy being initialized
812          */
813         int     (*op_policy_init) (struct ptlrpc_nrs_policy *policy);
814         /**
815          * Called during policy unregistration; this operation is optional.
816          *
817          * \param[in,out] policy The policy being unregistered/finalized
818          */
819         void    (*op_policy_fini) (struct ptlrpc_nrs_policy *policy);
820         /**
821          * Called when activating a policy via lprocfs; policies allocate and
822          * initialize their resources here; this operation is optional.
823          *
824          * \param[in,out] policy The policy being started
825          * \param[in,out] arg A generic char buffer
826          *
827          * \see nrs_policy_start_locked()
828          */
829         int     (*op_policy_start) (struct ptlrpc_nrs_policy *policy,
830                                     char *arg);
831         /**
832          * Called when deactivating a policy via lprocfs; policies deallocate
833          * their resources here; this operation is optional
834          *
835          * \param[in,out] policy The policy being stopped
836          *
837          * \see nrs_policy_stop0()
838          */
839         void    (*op_policy_stop) (struct ptlrpc_nrs_policy *policy);
840         /**
841          * Used for policy-specific operations; i.e. not generic ones like
842          * \e PTLRPC_NRS_CTL_START and \e PTLRPC_NRS_CTL_GET_INFO; analogous
843          * to an ioctl; this operation is optional.
844          *
845          * \param[in,out]        policy The policy carrying out operation \a opc
846          * \param[in]     opc    The command operation being carried out
847          * \param[in,out] arg    An generic buffer for communication between the
848          *                       user and the control operation
849          *
850          * \retval -ve error
851          * \retval   0 success
852          *
853          * \see ptlrpc_nrs_policy_control()
854          */
855         int     (*op_policy_ctl) (struct ptlrpc_nrs_policy *policy,
856                                   enum ptlrpc_nrs_ctl opc, void *arg);
857
858         /**
859          * Called when obtaining references to the resources of the resource
860          * hierarchy for a request that has arrived for handling at the PTLRPC
861          * service. Policies should return -ve for requests they do not wish
862          * to handle. This operation is mandatory.
863          *
864          * \param[in,out] policy  The policy we're getting resources for.
865          * \param[in,out] nrq     The request we are getting resources for.
866          * \param[in]     parent  The parent resource of the resource being
867          *                        requested; set to NULL if none.
868          * \param[out]    resp    The resource is to be returned here; the
869          *                        fallback policy in an NRS head should
870          *                        \e always return a non-NULL pointer value.
871          * \param[in]  moving_req When set, signifies that this is an attempt
872          *                        to obtain resources for a request being moved
873          *                        to the high-priority NRS head by
874          *                        ldlm_lock_reorder_req().
875          *                        This implies two things:
876          *                        1. We are under obd_export::exp_rpc_lock and
877          *                        so should not sleep.
878          *                        2. We should not perform non-idempotent or can
879          *                        skip performing idempotent operations that
880          *                        were carried out when resources were first
881          *                        taken for the request when it was initialized
882          *                        in ptlrpc_nrs_req_initialize().
883          *
884          * \retval 0, +ve The level of the returned resource in the resource
885          *                hierarchy; currently only 0 (for a non-leaf resource)
886          *                and 1 (for a leaf resource) are supported by the
887          *                framework.
888          * \retval -ve    error
889          *
890          * \see ptlrpc_nrs_req_initialize()
891          * \see ptlrpc_nrs_hpreq_add_nolock()
892          * \see ptlrpc_nrs_req_hp_move()
893          */
894         int     (*op_res_get) (struct ptlrpc_nrs_policy *policy,
895                                struct ptlrpc_nrs_request *nrq,
896                                const struct ptlrpc_nrs_resource *parent,
897                                struct ptlrpc_nrs_resource **resp,
898                                bool moving_req);
899         /**
900          * Called when releasing references taken for resources in the resource
901          * hierarchy for the request; this operation is optional.
902          *
903          * \param[in,out] policy The policy the resource belongs to
904          * \param[in] res        The resource to be freed
905          *
906          * \see ptlrpc_nrs_req_finalize()
907          * \see ptlrpc_nrs_hpreq_add_nolock()
908          * \see ptlrpc_nrs_req_hp_move()
909          */
910         void    (*op_res_put) (struct ptlrpc_nrs_policy *policy,
911                                const struct ptlrpc_nrs_resource *res);
912
913         /**
914          * Obtains a request for handling from the policy, and optionally
915          * removes the request from the policy; this operation is mandatory.
916          *
917          * \param[in,out] policy The policy to poll
918          * \param[in]     peek   When set, signifies that we just want to
919          *                       examine the request, and not handle it, so the
920          *                       request is not removed from the policy.
921          * \param[in]     force  When set, it will force a policy to return a
922          *                       request if it has one queued.
923          *
924          * \retval NULL No request available for handling
925          * \retval valid-pointer The request polled for handling
926          *
927          * \see ptlrpc_nrs_req_get_nolock()
928          */
929         struct ptlrpc_nrs_request *
930                 (*op_req_get) (struct ptlrpc_nrs_policy *policy, bool peek,
931                                bool force);
932         /**
933          * Called when attempting to add a request to a policy for later
934          * handling; this operation is mandatory.
935          *
936          * \param[in,out] policy  The policy on which to enqueue \a nrq
937          * \param[in,out] nrq The request to enqueue
938          *
939          * \retval 0    success
940          * \retval != 0 error
941          *
942          * \see ptlrpc_nrs_req_add_nolock()
943          */
944         int     (*op_req_enqueue) (struct ptlrpc_nrs_policy *policy,
945                                    struct ptlrpc_nrs_request *nrq);
946         /**
947          * Removes a request from the policy's set of pending requests. Normally
948          * called after a request has been polled successfully from the policy
949          * for handling; this operation is mandatory.
950          *
951          * \param[in,out] policy The policy the request \a nrq belongs to
952          * \param[in,out] nrq    The request to dequeue
953          *
954          * \see ptlrpc_nrs_req_del_nolock()
955          */
956         void    (*op_req_dequeue) (struct ptlrpc_nrs_policy *policy,
957                                    struct ptlrpc_nrs_request *nrq);
958         /**
959          * Called after the request being carried out. Could be used for
960          * job/resource control; this operation is optional.
961          *
962          * \param[in,out] policy The policy which is stopping to handle request
963          *                       \a nrq
964          * \param[in,out] nrq    The request
965          *
966          * \pre assert_spin_locked(&svcpt->scp_req_lock)
967          *
968          * \see ptlrpc_nrs_req_stop_nolock()
969          */
970         void    (*op_req_stop) (struct ptlrpc_nrs_policy *policy,
971                                 struct ptlrpc_nrs_request *nrq);
972         /**
973          * Registers the policy's lprocfs interface with a PTLRPC service.
974          *
975          * \param[in] svc The service
976          *
977          * \retval 0    success
978          * \retval != 0 error
979          */
980         int     (*op_lprocfs_init) (struct ptlrpc_service *svc);
981         /**
982          * Unegisters the policy's lprocfs interface with a PTLRPC service.
983          *
984          * In cases of failed policy registration in
985          * \e ptlrpc_nrs_policy_register(), this function may be called for a
986          * service which has not registered the policy successfully, so
987          * implementations of this method should make sure their operations are
988          * safe in such cases.
989          *
990          * \param[in] svc The service
991          */
992         void    (*op_lprocfs_fini) (struct ptlrpc_service *svc);
993 };
994
995 /**
996  * Policy flags
997  */
998 enum nrs_policy_flags {
999         /**
1000          * Fallback policy, use this flag only on a single supported policy per
1001          * service. The flag cannot be used on policies that use
1002          * \e PTLRPC_NRS_FL_REG_EXTERN
1003          */
1004         PTLRPC_NRS_FL_FALLBACK          = (1 << 0),
1005         /**
1006          * Start policy immediately after registering.
1007          */
1008         PTLRPC_NRS_FL_REG_START         = (1 << 1),
1009         /**
1010          * This is a policy registering from a module different to the one NRS
1011          * core ships in (currently ptlrpc).
1012          */
1013         PTLRPC_NRS_FL_REG_EXTERN        = (1 << 2),
1014 };
1015
1016 /**
1017  * NRS queue type.
1018  *
1019  * Denotes whether an NRS instance is for handling normal or high-priority
1020  * RPCs, or whether an operation pertains to one or both of the NRS instances
1021  * in a service.
1022  */
1023 enum ptlrpc_nrs_queue_type {
1024         PTLRPC_NRS_QUEUE_REG    = (1 << 0),
1025         PTLRPC_NRS_QUEUE_HP     = (1 << 1),
1026         PTLRPC_NRS_QUEUE_BOTH   = (PTLRPC_NRS_QUEUE_REG | PTLRPC_NRS_QUEUE_HP)
1027 };
1028
1029 /**
1030  * NRS head
1031  *
1032  * A PTLRPC service has at least one NRS head instance for handling normal
1033  * priority RPCs, and may optionally have a second NRS head instance for
1034  * handling high-priority RPCs. Each NRS head maintains a list of available
1035  * policies, of which one and only one policy is acting as the fallback policy,
1036  * and optionally a different policy may be acting as the primary policy. For
1037  * all RPCs handled by this NRS head instance, NRS core will first attempt to
1038  * enqueue the RPC using the primary policy (if any). The fallback policy is
1039  * used in the following cases:
1040  * - when there was no primary policy in the
1041  *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state at the time the request
1042  *   was initialized.
1043  * - when the primary policy that was at the
1044  *   ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1045  *   RPC was initialized, denoted it did not wish, or for some other reason was
1046  *   not able to handle the request, by returning a non-valid NRS resource
1047  *   reference.
1048  * - when the primary policy that was at the
1049  *   ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1050  *   RPC was initialized, fails later during the request enqueueing stage.
1051  *
1052  * \see nrs_resource_get_safe()
1053  * \see nrs_request_enqueue()
1054  */
1055 struct ptlrpc_nrs {
1056         spinlock_t                      nrs_lock;
1057         /** XXX Possibly replace svcpt->scp_req_lock with another lock here. */
1058         /**
1059          * List of registered policies
1060          */
1061         struct list_head                nrs_policy_list;
1062         /**
1063          * List of policies with queued requests. Policies that have any
1064          * outstanding requests are queued here, and this list is queried
1065          * in a round-robin manner from NRS core when obtaining a request
1066          * for handling. This ensures that requests from policies that at some
1067          * point transition away from the
1068          * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state are drained.
1069          */
1070         struct list_head                nrs_policy_queued;
1071         /**
1072          * Service partition for this NRS head
1073          */
1074         struct ptlrpc_service_part     *nrs_svcpt;
1075         /**
1076          * Primary policy, which is the preferred policy for handling RPCs
1077          */
1078         struct ptlrpc_nrs_policy       *nrs_policy_primary;
1079         /**
1080          * Fallback policy, which is the backup policy for handling RPCs
1081          */
1082         struct ptlrpc_nrs_policy       *nrs_policy_fallback;
1083         /**
1084          * This NRS head handles either HP or regular requests
1085          */
1086         enum ptlrpc_nrs_queue_type      nrs_queue_type;
1087         /**
1088          * # queued requests from all policies in this NRS head
1089          */
1090         unsigned long                   nrs_req_queued;
1091         /**
1092          * # scheduled requests from all policies in this NRS head
1093          */
1094         unsigned long                   nrs_req_started;
1095         /**
1096          * # policies on this NRS
1097          */
1098         unsigned                        nrs_num_pols;
1099         /**
1100          * This NRS head is in progress of starting a policy
1101          */
1102         unsigned                        nrs_policy_starting:1;
1103         /**
1104          * In progress of shutting down the whole NRS head; used during
1105          * unregistration
1106          */
1107         unsigned                        nrs_stopping:1;
1108         /**
1109          * NRS policy is throttling reqeust
1110          */
1111         unsigned                        nrs_throttling:1;
1112 };
1113
1114 #define NRS_POL_NAME_MAX                16
1115
1116 struct ptlrpc_nrs_pol_desc;
1117
1118 /**
1119  * Service compatibility predicate; this determines whether a policy is adequate
1120  * for handling RPCs of a particular PTLRPC service.
1121  *
1122  * XXX:This should give the same result during policy registration and
1123  * unregistration, and for all partitions of a service; so the result should not
1124  * depend on temporal service or other properties, that may influence the
1125  * result.
1126  */
1127 typedef bool (*nrs_pol_desc_compat_t) (const struct ptlrpc_service *svc,
1128                                        const struct ptlrpc_nrs_pol_desc *desc);
1129
1130 struct ptlrpc_nrs_pol_conf {
1131         /**
1132          * Human-readable policy name
1133          */
1134         char                               nc_name[NRS_POL_NAME_MAX];
1135         /**
1136          * NRS operations for this policy
1137          */
1138         const struct ptlrpc_nrs_pol_ops   *nc_ops;
1139         /**
1140          * Service compatibility predicate
1141          */
1142         nrs_pol_desc_compat_t              nc_compat;
1143         /**
1144          * Set for policies that support a single ptlrpc service, i.e. ones that
1145          * have \a pd_compat set to nrs_policy_compat_one(). The variable value
1146          * depicts the name of the single service that such policies are
1147          * compatible with.
1148          */
1149         const char                        *nc_compat_svc_name;
1150         /**
1151          * Owner module for this policy descriptor; policies registering from a
1152          * different module to the one the NRS framework is held within
1153          * (currently ptlrpc), should set this field to THIS_MODULE.
1154          */
1155         struct module                     *nc_owner;
1156         /**
1157          * Policy registration flags; a bitmast of \e nrs_policy_flags
1158          */
1159         unsigned                           nc_flags;
1160 };
1161
1162 /**
1163  * NRS policy registering descriptor
1164  *
1165  * Is used to hold a description of a policy that can be passed to NRS core in
1166  * order to register the policy with NRS heads in different PTLRPC services.
1167  */
1168 struct ptlrpc_nrs_pol_desc {
1169         /**
1170          * Human-readable policy name
1171          */
1172         char                                    pd_name[NRS_POL_NAME_MAX];
1173         /**
1174          * Link into nrs_core::nrs_policies
1175          */
1176         struct list_head                        pd_list;
1177         /**
1178          * NRS operations for this policy
1179          */
1180         const struct ptlrpc_nrs_pol_ops        *pd_ops;
1181         /**
1182          * Service compatibility predicate
1183          */
1184         nrs_pol_desc_compat_t                   pd_compat;
1185         /**
1186          * Set for policies that are compatible with only one PTLRPC service.
1187          *
1188          * \see ptlrpc_nrs_pol_conf::nc_compat_svc_name
1189          */
1190         const char                             *pd_compat_svc_name;
1191         /**
1192          * Owner module for this policy descriptor.
1193          *
1194          * We need to hold a reference to the module whenever we might make use
1195          * of any of the module's contents, i.e.
1196          * - If one or more instances of the policy are at a state where they
1197          *   might be handling a request, i.e.
1198          *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED or
1199          *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPING as we will have to
1200          *   call into the policy's ptlrpc_nrs_pol_ops() handlers. A reference
1201          *   is taken on the module when
1202          *   \e ptlrpc_nrs_pol_desc::pd_refs becomes 1, and released when it
1203          *   becomes 0, so that we hold only one reference to the module maximum
1204          *   at any time.
1205          *
1206          *   We do not need to hold a reference to the module, even though we
1207          *   might use code and data from the module, in the following cases:
1208          * - During external policy registration, because this should happen in
1209          *   the module's init() function, in which case the module is safe from
1210          *   removal because a reference is being held on the module by the
1211          *   kernel, and iirc kmod (and I guess module-init-tools also) will
1212          *   serialize any racing processes properly anyway.
1213          * - During external policy unregistration, because this should happen
1214          *   in a module's exit() function, and any attempts to start a policy
1215          *   instance would need to take a reference on the module, and this is
1216          *   not possible once we have reached the point where the exit()
1217          *   handler is called.
1218          * - During service registration and unregistration, as service setup
1219          *   and cleanup, and policy registration, unregistration and policy
1220          *   instance starting, are serialized by \e nrs_core::nrs_mutex, so
1221          *   as long as users adhere to the convention of registering policies
1222          *   in init() and unregistering them in module exit() functions, there
1223          *   should not be a race between these operations.
1224          * - During any policy-specific lprocfs operations, because a reference
1225          *   is held by the kernel on a proc entry that has been entered by a
1226          *   syscall, so as long as proc entries are removed during unregistration time,
1227          *   then unregistration and lprocfs operations will be properly
1228          *   serialized.
1229          */
1230         struct module                          *pd_owner;
1231         /**
1232          * Bitmask of \e nrs_policy_flags
1233          */
1234         unsigned                                pd_flags;
1235         /**
1236          * # of references on this descriptor
1237          */
1238         atomic_t                                pd_refs;
1239 };
1240
1241 /**
1242  * NRS policy state
1243  *
1244  * Policies transition from one state to the other during their lifetime
1245  */
1246 enum ptlrpc_nrs_pol_state {
1247         /**
1248          * Not a valid policy state.
1249          */
1250         NRS_POL_STATE_INVALID,
1251         /**
1252          * Policies are at this state either at the start of their life, or
1253          * transition here when the user selects a different policy to act
1254          * as the primary one.
1255          */
1256         NRS_POL_STATE_STOPPED,
1257         /**
1258          * Policy is progress of stopping
1259          */
1260         NRS_POL_STATE_STOPPING,
1261         /**
1262          * Policy is in progress of starting
1263          */
1264         NRS_POL_STATE_STARTING,
1265         /**
1266          * A policy is in this state in two cases:
1267          * - it is the fallback policy, which is always in this state.
1268          * - it has been activated by the user; i.e. it is the primary policy,
1269          */
1270         NRS_POL_STATE_STARTED,
1271 };
1272
1273 /**
1274  * NRS policy information
1275  *
1276  * Used for obtaining information for the status of a policy via lprocfs
1277  */
1278 struct ptlrpc_nrs_pol_info {
1279         /**
1280          * Policy name
1281          */
1282         char                            pi_name[NRS_POL_NAME_MAX];
1283         /**
1284          * Current policy state
1285          */
1286         enum ptlrpc_nrs_pol_state       pi_state;
1287         /**
1288          * # RPCs enqueued for later dispatching by the policy
1289          */
1290         long                            pi_req_queued;
1291         /**
1292          * # RPCs started for dispatch by the policy
1293          */
1294         long                            pi_req_started;
1295         /**
1296          * Is this a fallback policy?
1297          */
1298         unsigned                        pi_fallback:1;
1299 };
1300
1301 /**
1302  * NRS policy
1303  *
1304  * There is one instance of this for each policy in each NRS head of each
1305  * PTLRPC service partition.
1306  */
1307 struct ptlrpc_nrs_policy {
1308         /**
1309          * Linkage into the NRS head's list of policies,
1310          * ptlrpc_nrs:nrs_policy_list
1311          */
1312         struct list_head                pol_list;
1313         /**
1314          * Linkage into the NRS head's list of policies with enqueued
1315          * requests ptlrpc_nrs:nrs_policy_queued
1316          */
1317         struct list_head                pol_list_queued;
1318         /**
1319          * Current state of this policy
1320          */
1321         enum ptlrpc_nrs_pol_state       pol_state;
1322         /**
1323          * Bitmask of nrs_policy_flags
1324          */
1325         unsigned                        pol_flags;
1326         /**
1327          * # RPCs enqueued for later dispatching by the policy
1328          */
1329         long                            pol_req_queued;
1330         /**
1331          * # RPCs started for dispatch by the policy
1332          */
1333         long                            pol_req_started;
1334         /**
1335          * Usage Reference count taken on the policy instance
1336          */
1337         long                            pol_ref;
1338         /**
1339          * The NRS head this policy has been created at
1340          */
1341         struct ptlrpc_nrs              *pol_nrs;
1342         /**
1343          * Private policy data; varies by policy type
1344          */
1345         void                           *pol_private;
1346         /**
1347          * Policy descriptor for this policy instance.
1348          */
1349         struct ptlrpc_nrs_pol_desc     *pol_desc;
1350 };
1351
1352 /**
1353  * NRS resource
1354  *
1355  * Resources are embedded into two types of NRS entities:
1356  * - Inside NRS policies, in the policy's private data in
1357  *   ptlrpc_nrs_policy::pol_private
1358  * - In objects that act as prime-level scheduling entities in different NRS
1359  *   policies; e.g. on a policy that performs round robin or similar order
1360  *   scheduling across client NIDs, there would be one NRS resource per unique
1361  *   client NID. On a policy which performs round robin scheduling across
1362  *   backend filesystem objects, there would be one resource associated with
1363  *   each of the backend filesystem objects partaking in the scheduling
1364  *   performed by the policy.
1365  *
1366  * NRS resources share a parent-child relationship, in which resources embedded
1367  * in policy instances are the parent entities, with all scheduling entities
1368  * a policy schedules across being the children, thus forming a simple resource
1369  * hierarchy. This hierarchy may be extended with one or more levels in the
1370  * future if the ability to have more than one primary policy is added.
1371  *
1372  * Upon request initialization, references to the then active NRS policies are
1373  * taken and used to later handle the dispatching of the request with one of
1374  * these policies.
1375  *
1376  * \see nrs_resource_get_safe()
1377  * \see ptlrpc_nrs_req_add()
1378  */
1379 struct ptlrpc_nrs_resource {
1380         /**
1381          * This NRS resource's parent; is NULL for resources embedded in NRS
1382          * policy instances; i.e. those are top-level ones.
1383          */
1384         struct ptlrpc_nrs_resource     *res_parent;
1385         /**
1386          * The policy associated with this resource.
1387          */
1388         struct ptlrpc_nrs_policy       *res_policy;
1389 };
1390
1391 enum {
1392         NRS_RES_FALLBACK,
1393         NRS_RES_PRIMARY,
1394         NRS_RES_MAX
1395 };
1396
1397 /* \name fifo
1398  *
1399  * FIFO policy
1400  *
1401  * This policy is a logical wrapper around previous, non-NRS functionality.
1402  * It dispatches RPCs in the same order as they arrive from the network. This
1403  * policy is currently used as the fallback policy, and the only enabled policy
1404  * on all NRS heads of all PTLRPC service partitions.
1405  * @{
1406  */
1407
1408 /**
1409  * Private data structure for the FIFO policy
1410  */
1411 struct nrs_fifo_head {
1412         /**
1413          * Resource object for policy instance.
1414          */
1415         struct ptlrpc_nrs_resource      fh_res;
1416         /**
1417          * List of queued requests.
1418          */
1419         struct list_head                fh_list;
1420         /**
1421          * For debugging purposes.
1422          */
1423         __u64                           fh_sequence;
1424 };
1425
1426 struct nrs_fifo_req {
1427         struct list_head        fr_list;
1428         __u64                   fr_sequence;
1429 };
1430
1431 /** @} fifo */
1432
1433 /**
1434  * \name CRR-N
1435  *
1436  * CRR-N, Client Round Robin over NIDs
1437  * @{
1438  */
1439
1440 /**
1441  * private data structure for CRR-N NRS
1442  */
1443 struct nrs_crrn_net {
1444         struct ptlrpc_nrs_resource      cn_res;
1445         cfs_binheap_t                  *cn_binheap;
1446         cfs_hash_t                     *cn_cli_hash;
1447         /**
1448          * Used when a new scheduling round commences, in order to synchronize
1449          * all clients with the new round number.
1450          */
1451         __u64                           cn_round;
1452         /**
1453          * Determines the relevant ordering amongst request batches within a
1454          * scheduling round.
1455          */
1456         __u64                           cn_sequence;
1457         /**
1458          * Round Robin quantum; the maximum number of RPCs that each request
1459          * batch for each client can have in a scheduling round.
1460          */
1461         __u16                           cn_quantum;
1462 };
1463
1464 /**
1465  * Object representing a client in CRR-N, as identified by its NID
1466  */
1467 struct nrs_crrn_client {
1468         struct ptlrpc_nrs_resource      cc_res;
1469         struct hlist_node               cc_hnode;
1470         lnet_nid_t                      cc_nid;
1471         /**
1472          * The round number against which this client is currently scheduling
1473          * requests.
1474          */
1475         __u64                           cc_round;
1476         /**
1477          * The sequence number used for requests scheduled by this client during
1478          * the current round number.
1479          */
1480         __u64                           cc_sequence;
1481         atomic_t                        cc_ref;
1482         /**
1483          * Round Robin quantum; the maximum number of RPCs the client is allowed
1484          * to schedule in a single batch of each round.
1485          */
1486         __u16                           cc_quantum;
1487         /**
1488          * # of pending requests for this client, on all existing rounds
1489          */
1490         __u16                           cc_active;
1491 };
1492
1493 /**
1494  * CRR-N NRS request definition
1495  */
1496 struct nrs_crrn_req {
1497         /**
1498          * Round number for this request; shared with all other requests in the
1499          * same batch.
1500          */
1501         __u64                   cr_round;
1502         /**
1503          * Sequence number for this request; shared with all other requests in
1504          * the same batch.
1505          */
1506         __u64                   cr_sequence;
1507 };
1508
1509 /**
1510  * CRR-N policy operations.
1511  */
1512 enum nrs_ctl_crr {
1513         /**
1514          * Read the RR quantum size of a CRR-N policy.
1515          */
1516         NRS_CTL_CRRN_RD_QUANTUM = PTLRPC_NRS_CTL_1ST_POL_SPEC,
1517         /**
1518          * Write the RR quantum size of a CRR-N policy.
1519          */
1520         NRS_CTL_CRRN_WR_QUANTUM,
1521 };
1522
1523 /** @} CRR-N */
1524
1525 /**
1526  * \name ORR/TRR
1527  *
1528  * ORR/TRR (Object-based Round Robin/Target-based Round Robin) NRS policies
1529  * @{
1530  */
1531
1532 /**
1533  * Lower and upper byte offsets of a brw RPC
1534  */
1535 struct nrs_orr_req_range {
1536         __u64           or_start;
1537         __u64           or_end;
1538 };
1539
1540 /**
1541  * RPC types supported by the ORR/TRR policies
1542  */
1543 enum nrs_orr_supp {
1544         NOS_OST_READ  = (1 << 0),
1545         NOS_OST_WRITE = (1 << 1),
1546         NOS_OST_RW    = (NOS_OST_READ | NOS_OST_WRITE),
1547         /**
1548          * Default value for policies.
1549          */
1550         NOS_DFLT      = NOS_OST_READ
1551 };
1552
1553 /**
1554  * As unique keys for grouping RPCs together, we use the object's OST FID for
1555  * the ORR policy, and the OST index for the TRR policy.
1556  *
1557  * XXX: We waste some space for TRR policy instances by using a union, but it
1558  *      allows to consolidate some of the code between ORR and TRR, and these
1559  *      policies will probably eventually merge into one anyway.
1560  */
1561 struct nrs_orr_key {
1562         union {
1563                 /** object FID for ORR */
1564                 struct lu_fid   ok_fid;
1565                 /** OST index for TRR */
1566                 __u32           ok_idx;
1567         };
1568 };
1569
1570 /**
1571  * The largest base string for unique hash/slab object names is
1572  * "nrs_orr_reg_", so 13 characters. We add 3 to this to be used for the CPT
1573  * id number, so this _should_ be more than enough for the maximum number of
1574  * CPTs on any system. If it does happen that this statement is incorrect,
1575  * nrs_orr_genobjname() will inevitably yield a non-unique name and cause
1576  * kmem_cache_create() to complain (on Linux), so the erroneous situation
1577  * will hopefully not go unnoticed.
1578  */
1579 #define NRS_ORR_OBJ_NAME_MAX    (sizeof("nrs_orr_reg_") + 3)
1580
1581 /**
1582  * private data structure for ORR and TRR NRS
1583  */
1584 struct nrs_orr_data {
1585         struct ptlrpc_nrs_resource      od_res;
1586         cfs_binheap_t                  *od_binheap;
1587         cfs_hash_t                     *od_obj_hash;
1588         struct kmem_cache              *od_cache;
1589         /**
1590          * Used when a new scheduling round commences, in order to synchronize
1591          * all object or OST batches with the new round number.
1592          */
1593         __u64                           od_round;
1594         /**
1595          * Determines the relevant ordering amongst request batches within a
1596          * scheduling round.
1597          */
1598         __u64                           od_sequence;
1599         /**
1600          * RPC types that are currently supported.
1601          */
1602         enum nrs_orr_supp               od_supp;
1603         /**
1604          * Round Robin quantum; the maxium number of RPCs that each request
1605          * batch for each object or OST can have in a scheduling round.
1606          */
1607         __u16                           od_quantum;
1608         /**
1609          * Whether to use physical disk offsets or logical file offsets.
1610          */
1611         bool                            od_physical;
1612         /**
1613          * XXX: We need to provide a persistently allocated string to hold
1614          * unique object names for this policy, since in currently supported
1615          * versions of Linux by Lustre, kmem_cache_create() just sets a pointer
1616          * to the name string provided. kstrdup() is used in the version of
1617          * kmeme_cache_create() in current Linux mainline, so we may be able to
1618          * remove this in the future.
1619          */
1620         char                            od_objname[NRS_ORR_OBJ_NAME_MAX];
1621 };
1622
1623 /**
1624  * Represents a backend-fs object or OST in the ORR and TRR policies
1625  * respectively
1626  */
1627 struct nrs_orr_object {
1628         struct ptlrpc_nrs_resource      oo_res;
1629         struct hlist_node               oo_hnode;
1630         /**
1631          * The round number against which requests are being scheduled for this
1632          * object or OST
1633          */
1634         __u64                           oo_round;
1635         /**
1636          * The sequence number used for requests scheduled for this object or
1637          * OST during the current round number.
1638          */
1639         __u64                           oo_sequence;
1640         /**
1641          * The key of the object or OST for which this structure instance is
1642          * scheduling RPCs
1643          */
1644         struct nrs_orr_key              oo_key;
1645         long                            oo_ref;
1646         /**
1647          * Round Robin quantum; the maximum number of RPCs that are allowed to
1648          * be scheduled for the object or OST in a single batch of each round.
1649          */
1650         __u16                           oo_quantum;
1651         /**
1652          * # of pending requests for this object or OST, on all existing rounds
1653          */
1654         __u16                           oo_active;
1655 };
1656
1657 /**
1658  * ORR/TRR NRS request definition
1659  */
1660 struct nrs_orr_req {
1661         /**
1662          * The offset range this request covers
1663          */
1664         struct nrs_orr_req_range        or_range;
1665         /**
1666          * Round number for this request; shared with all other requests in the
1667          * same batch.
1668          */
1669         __u64                           or_round;
1670         /**
1671          * Sequence number for this request; shared with all other requests in
1672          * the same batch.
1673          */
1674         __u64                           or_sequence;
1675         /**
1676          * For debugging purposes.
1677          */
1678         struct nrs_orr_key              or_key;
1679         /**
1680          * An ORR policy instance has filled in request information while
1681          * enqueueing the request on the service partition's regular NRS head.
1682          */
1683         unsigned int                    or_orr_set:1;
1684         /**
1685          * A TRR policy instance has filled in request information while
1686          * enqueueing the request on the service partition's regular NRS head.
1687          */
1688         unsigned int                    or_trr_set:1;
1689         /**
1690          * Request offset ranges have been filled in with logical offset
1691          * values.
1692          */
1693         unsigned int                    or_logical_set:1;
1694         /**
1695          * Request offset ranges have been filled in with physical offset
1696          * values.
1697          */
1698         unsigned int                    or_physical_set:1;
1699 };
1700
1701 /** @} ORR/TRR */
1702
1703 #include <lustre_nrs_tbf.h>
1704
1705 /**
1706  * NRS request
1707  *
1708  * Instances of this object exist embedded within ptlrpc_request; the main
1709  * purpose of this object is to hold references to the request's resources
1710  * for the lifetime of the request, and to hold properties that policies use
1711  * use for determining the request's scheduling priority.
1712  * */
1713 struct ptlrpc_nrs_request {
1714         /**
1715          * The request's resource hierarchy.
1716          */
1717         struct ptlrpc_nrs_resource     *nr_res_ptrs[NRS_RES_MAX];
1718         /**
1719          * Index into ptlrpc_nrs_request::nr_res_ptrs of the resource of the
1720          * policy that was used to enqueue the request.
1721          *
1722          * \see nrs_request_enqueue()
1723          */
1724         unsigned                        nr_res_idx;
1725         unsigned                        nr_initialized:1;
1726         unsigned                        nr_enqueued:1;
1727         unsigned                        nr_started:1;
1728         unsigned                        nr_finalized:1;
1729         cfs_binheap_node_t              nr_node;
1730
1731         /**
1732          * Policy-specific fields, used for determining a request's scheduling
1733          * priority, and other supporting functionality.
1734          */
1735         union {
1736                 /**
1737                  * Fields for the FIFO policy
1738                  */
1739                 struct nrs_fifo_req     fifo;
1740                 /**
1741                  * CRR-N request defintion
1742                  */
1743                 struct nrs_crrn_req     crr;
1744                 /** ORR and TRR share the same request definition */
1745                 struct nrs_orr_req      orr;
1746                 /**
1747                  * TBF request definition
1748                  */
1749                 struct nrs_tbf_req      tbf;
1750         } nr_u;
1751         /**
1752          * Externally-registering policies may want to use this to allocate
1753          * their own request properties.
1754          */
1755         void                           *ext;
1756 };
1757
1758 /** @} nrs */
1759
1760 /**
1761  * Basic request prioritization operations structure.
1762  * The whole idea is centered around locks and RPCs that might affect locks.
1763  * When a lock is contended we try to give priority to RPCs that might lead
1764  * to fastest release of that lock.
1765  * Currently only implemented for OSTs only in a way that makes all
1766  * IO and truncate RPCs that are coming from a locked region where a lock is
1767  * contended a priority over other requests.
1768  */
1769 struct ptlrpc_hpreq_ops {
1770         /**
1771          * Check if the lock handle of the given lock is the same as
1772          * taken from the request.
1773          */
1774         int  (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
1775         /**
1776          * Check if the request is a high priority one.
1777          */
1778         int  (*hpreq_check)(struct ptlrpc_request *);
1779         /**
1780          * Called after the request has been handled.
1781          */
1782         void (*hpreq_fini)(struct ptlrpc_request *);
1783 };
1784
1785 /**
1786  * Represents remote procedure call.
1787  *
1788  * This is a staple structure used by everybody wanting to send a request
1789  * in Lustre.
1790  */
1791 struct ptlrpc_request {
1792         /* Request type: one of PTL_RPC_MSG_* */
1793         int                     rq_type;
1794         /** Result of request processing */
1795         int                     rq_status;
1796         /**
1797          * Linkage item through which this request is included into
1798          * sending/delayed lists on client and into rqbd list on server
1799          */
1800         struct list_head        rq_list;
1801         /**
1802          * Server side list of incoming unserved requests sorted by arrival
1803          * time.  Traversed from time to time to notice about to expire
1804          * requests and sent back "early replies" to clients to let them
1805          * know server is alive and well, just very busy to service their
1806          * requests in time
1807          */
1808         struct list_head        rq_timed_list;
1809         /** server-side history, used for debuging purposes. */
1810         struct list_head        rq_history_list;
1811         /** server-side per-export list */
1812         struct list_head        rq_exp_list;
1813         /** server-side hp handlers */
1814         struct ptlrpc_hpreq_ops *rq_ops;
1815
1816         /** initial thread servicing this request */
1817         struct ptlrpc_thread    *rq_svc_thread;
1818
1819         /** history sequence # */
1820         __u64                   rq_history_seq;
1821         /** \addtogroup  nrs
1822          * @{
1823          */
1824         /** stub for NRS request */
1825         struct ptlrpc_nrs_request rq_nrq;
1826         /** @} nrs */
1827         /** the index of service's srv_at_array into which request is linked */
1828         time_t rq_at_index;
1829         /** Lock to protect request flags and some other important bits, like
1830          * rq_list
1831          */
1832         spinlock_t rq_lock;
1833         /** client-side flags are serialized by rq_lock */
1834         unsigned int rq_intr:1, rq_replied:1, rq_err:1,
1835                 rq_timedout:1, rq_resend:1, rq_restart:1,
1836                 /**
1837                  * when ->rq_replay is set, request is kept by the client even
1838                  * after server commits corresponding transaction. This is
1839                  * used for operations that require sequence of multiple
1840                  * requests to be replayed. The only example currently is file
1841                  * open/close. When last request in such a sequence is
1842                  * committed, ->rq_replay is cleared on all requests in the
1843                  * sequence.
1844                  */
1845                 rq_replay:1,
1846                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
1847                 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
1848                 rq_early:1,
1849                 rq_req_unlink:1, rq_reply_unlink:1,
1850                 rq_memalloc:1,      /* req originated from "kswapd" */
1851                 /* server-side flags */
1852                 rq_packed_final:1,  /* packed final reply */
1853                 rq_hp:1,            /* high priority RPC */
1854                 rq_at_linked:1,     /* link into service's srv_at_array */
1855                 rq_reply_truncate:1,
1856                 rq_committed:1,
1857                 /* whether the "rq_set" is a valid one */
1858                 rq_invalid_rqset:1,
1859                 rq_generation_set:1,
1860                 /* do not resend request on -EINPROGRESS */
1861                 rq_no_retry_einprogress:1,
1862                 /* allow the req to be sent if the import is in recovery
1863                  * status */
1864                 rq_allow_replay:1,
1865                 /* bulk request, sent to server, but uncommitted */
1866                 rq_unstable:1;
1867
1868         unsigned int rq_nr_resend;
1869
1870         enum rq_phase rq_phase; /* one of RQ_PHASE_* */
1871         enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
1872         atomic_t rq_refcount;/* client-side refcount for SENT race,
1873                                     server-side refcounf for multiple replies */
1874
1875         /** Portal to which this request would be sent */
1876         short rq_request_portal;  /* XXX FIXME bug 249 */
1877         /** Portal where to wait for reply and where reply would be sent */
1878         short rq_reply_portal;    /* XXX FIXME bug 249 */
1879
1880         /**
1881          * client-side:
1882          * !rq_truncate : # reply bytes actually received,
1883          *  rq_truncate : required repbuf_len for resend
1884          */
1885         int rq_nob_received;
1886         /** Request length */
1887         int rq_reqlen;
1888         /** Reply length */
1889         int rq_replen;
1890         /** Request message - what client sent */
1891         struct lustre_msg *rq_reqmsg;
1892         /** Reply message - server response */
1893         struct lustre_msg *rq_repmsg;
1894         /** Transaction number */
1895         __u64 rq_transno;
1896         /** xid */
1897         __u64 rq_xid;
1898         /**
1899          * List item to for replay list. Not yet commited requests get linked
1900          * there.
1901          * Also see \a rq_replay comment above.
1902          */
1903         struct list_head        rq_replay_list;
1904
1905         /**
1906          * security and encryption data
1907          * @{ */
1908         struct ptlrpc_cli_ctx   *rq_cli_ctx;    /**< client's half ctx */
1909         struct ptlrpc_svc_ctx   *rq_svc_ctx;    /**< server's half ctx */
1910         struct list_head        rq_ctx_chain;   /**< link to waited ctx */
1911
1912         struct sptlrpc_flavor   rq_flvr;        /**< for client & server */
1913         enum lustre_sec_part    rq_sp_from;
1914
1915         /* client/server security flags */
1916         unsigned int
1917                                  rq_ctx_init:1,      /* context initiation */
1918                                  rq_ctx_fini:1,      /* context destroy */
1919                                  rq_bulk_read:1,     /* request bulk read */
1920                                  rq_bulk_write:1,    /* request bulk write */
1921                                  /* server authentication flags */
1922                                  rq_auth_gss:1,      /* authenticated by gss */
1923                                  rq_auth_remote:1,   /* authed as remote user */
1924                                  rq_auth_usr_root:1, /* authed as root */
1925                                  rq_auth_usr_mdt:1,  /* authed as mdt */
1926                                  rq_auth_usr_ost:1,  /* authed as ost */
1927                                  /* security tfm flags */
1928                                  rq_pack_udesc:1,
1929                                  rq_pack_bulk:1,
1930                                  /* doesn't expect reply FIXME */
1931                                  rq_no_reply:1,
1932                                  rq_pill_init:1;     /* pill initialized */
1933
1934         uid_t                    rq_auth_uid;        /* authed uid */
1935         uid_t                    rq_auth_mapped_uid; /* authed uid mapped to */
1936
1937         /* (server side), pointed directly into req buffer */
1938         struct ptlrpc_user_desc *rq_user_desc;
1939
1940         /* various buffer pointers */
1941         struct lustre_msg       *rq_reqbuf;      /* req wrapper */
1942         char                    *rq_repbuf;      /* rep buffer */
1943         struct lustre_msg       *rq_repdata;     /* rep wrapper msg */
1944         struct lustre_msg       *rq_clrbuf;      /* only in priv mode */
1945         int                      rq_reqbuf_len;  /* req wrapper buf len */
1946         int                      rq_reqdata_len; /* req wrapper msg len */
1947         int                      rq_repbuf_len;  /* rep buffer len */
1948         int                      rq_repdata_len; /* rep wrapper msg len */
1949         int                      rq_clrbuf_len;  /* only in priv mode */
1950         int                      rq_clrdata_len; /* only in priv mode */
1951
1952         /** early replies go to offset 0, regular replies go after that */
1953         unsigned int             rq_reply_off;
1954
1955         /** @} */
1956
1957         /** Fields that help to see if request and reply were swabbed or not */
1958         __u32 rq_req_swab_mask;
1959         __u32 rq_rep_swab_mask;
1960
1961         /** What was import generation when this request was sent */
1962         int rq_import_generation;
1963         enum lustre_imp_state rq_send_state;
1964
1965         /** how many early replies (for stats) */
1966         int rq_early_count;
1967
1968         /** client+server request */
1969         lnet_handle_md_t     rq_req_md_h;
1970         struct ptlrpc_cb_id  rq_req_cbid;
1971         /** optional time limit for send attempts */
1972         cfs_duration_t       rq_delay_limit;
1973         /** time request was first queued */
1974         cfs_time_t           rq_queued_time;
1975
1976         /* server-side... */
1977         /** request arrival time */
1978         struct timeval       rq_arrival_time;
1979         /** separated reply state */
1980         struct ptlrpc_reply_state *rq_reply_state;
1981         /** incoming request buffer */
1982         struct ptlrpc_request_buffer_desc *rq_rqbd;
1983
1984         /** client-only incoming reply */
1985         lnet_handle_md_t     rq_reply_md_h;
1986         wait_queue_head_t    rq_reply_waitq;
1987         struct ptlrpc_cb_id  rq_reply_cbid;
1988
1989         /** our LNet NID */
1990         lnet_nid_t           rq_self;
1991         /** Peer description (the other side) */
1992         lnet_process_id_t    rq_peer;
1993         /** Server-side, export on which request was received */
1994         struct obd_export   *rq_export;
1995         /** Client side, import where request is being sent */
1996         struct obd_import   *rq_import;
1997
1998         /** Replay callback, called after request is replayed at recovery */
1999         void (*rq_replay_cb)(struct ptlrpc_request *);
2000         /**
2001          * Commit callback, called when request is committed and about to be
2002          * freed.
2003          */
2004         void (*rq_commit_cb)(struct ptlrpc_request *);
2005         /** Opaq data for replay and commit callbacks. */
2006         void  *rq_cb_data;
2007
2008         /** For bulk requests on client only: bulk descriptor */
2009         struct ptlrpc_bulk_desc *rq_bulk;
2010
2011         /** client outgoing req */
2012         /**
2013          * when request/reply sent (secs), or time when request should be sent
2014          */
2015         time_t rq_sent;
2016         /** time for request really sent out */
2017         time_t rq_real_sent;
2018
2019         /** when request must finish. volatile
2020          * so that servers' early reply updates to the deadline aren't
2021          * kept in per-cpu cache */
2022         volatile time_t rq_deadline;
2023         /** when req reply unlink must finish. */
2024         time_t rq_reply_deadline;
2025         /** when req bulk unlink must finish. */
2026         time_t rq_bulk_deadline;
2027         /**
2028          * service time estimate (secs) 
2029          * If the requestsis not served by this time, it is marked as timed out.
2030          */
2031         int    rq_timeout;
2032
2033         /** Multi-rpc bits */
2034         /** Per-request waitq introduced by bug 21938 for recovery waiting */
2035         wait_queue_head_t rq_set_waitq;
2036         /** Link item for request set lists */
2037         struct list_head  rq_set_chain;
2038         /** Link back to the request set */
2039         struct ptlrpc_request_set *rq_set;
2040         /** Async completion handler, called when reply is received */
2041         ptlrpc_interpterer_t rq_interpret_reply;
2042         /** Async completion context */
2043         union ptlrpc_async_args rq_async_args;
2044
2045         /** Pool if request is from preallocated list */
2046         struct ptlrpc_request_pool *rq_pool;
2047
2048         struct lu_context           rq_session;
2049
2050         /** request format description */
2051         struct req_capsule          rq_pill;
2052 };
2053
2054 /**
2055  * Call completion handler for rpc if any, return it's status or original
2056  * rc if there was no handler defined for this request.
2057  */
2058 static inline int ptlrpc_req_interpret(const struct lu_env *env,
2059                                        struct ptlrpc_request *req, int rc)
2060 {
2061         if (req->rq_interpret_reply != NULL) {
2062                 req->rq_status = req->rq_interpret_reply(env, req,
2063                                                          &req->rq_async_args,
2064                                                          rc);
2065                 return req->rq_status;
2066         }
2067         return rc;
2068 }
2069
2070 /** \addtogroup  nrs
2071  * @{
2072  */
2073 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
2074 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
2075 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
2076 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
2077                                 struct ptlrpc_nrs_pol_info *info);
2078
2079 /*
2080  * Can the request be moved from the regular NRS head to the high-priority NRS
2081  * head (of the same PTLRPC service partition), if any?
2082  *
2083  * For a reliable result, this should be checked under svcpt->scp_req lock.
2084  */
2085 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
2086 {
2087         struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
2088
2089         /**
2090          * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
2091          * request has been enqueued first, and ptlrpc_nrs_request::nr_started
2092          * to make sure it has not been scheduled yet (analogous to previous
2093          * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
2094          */
2095         return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
2096 }
2097 /** @} nrs */
2098
2099 /**
2100  * Returns 1 if request buffer at offset \a index was already swabbed
2101  */
2102 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
2103 {
2104         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
2105         return req->rq_req_swab_mask & (1 << index);
2106 }
2107
2108 /**
2109  * Returns 1 if request reply buffer at offset \a index was already swabbed
2110  */
2111 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
2112 {
2113         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
2114         return req->rq_rep_swab_mask & (1 << index);
2115 }
2116
2117 /**
2118  * Returns 1 if request needs to be swabbed into local cpu byteorder
2119  */
2120 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
2121 {
2122         return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
2123 }
2124
2125 /**
2126  * Returns 1 if request reply needs to be swabbed into local cpu byteorder
2127  */
2128 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
2129 {
2130         return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
2131 }
2132
2133 /**
2134  * Mark request buffer at offset \a index that it was already swabbed
2135  */
2136 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
2137 {
2138         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
2139         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
2140         req->rq_req_swab_mask |= 1 << index;
2141 }
2142
2143 /**
2144  * Mark request reply buffer at offset \a index that it was already swabbed
2145  */
2146 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
2147 {
2148         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
2149         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
2150         req->rq_rep_swab_mask |= 1 << index;
2151 }
2152
2153 /**
2154  * Convert numerical request phase value \a phase into text string description
2155  */
2156 static inline const char *
2157 ptlrpc_phase2str(enum rq_phase phase)
2158 {
2159         switch (phase) {
2160         case RQ_PHASE_NEW:
2161                 return "New";
2162         case RQ_PHASE_RPC:
2163                 return "Rpc";
2164         case RQ_PHASE_BULK:
2165                 return "Bulk";
2166         case RQ_PHASE_INTERPRET:
2167                 return "Interpret";
2168         case RQ_PHASE_COMPLETE:
2169                 return "Complete";
2170         case RQ_PHASE_UNREGISTERING:
2171                 return "Unregistering";
2172         default:
2173                 return "?Phase?";
2174         }
2175 }
2176
2177 /**
2178  * Convert numerical request phase of the request \a req into text stringi
2179  * description
2180  */
2181 static inline const char *
2182 ptlrpc_rqphase2str(struct ptlrpc_request *req)
2183 {
2184         return ptlrpc_phase2str(req->rq_phase);
2185 }
2186
2187 /**
2188  * Debugging functions and helpers to print request structure into debug log
2189  * @{
2190  */ 
2191 /* Spare the preprocessor, spoil the bugs. */
2192 #define FLAG(field, str) (field ? str : "")
2193
2194 /** Convert bit flags into a string */
2195 #define DEBUG_REQ_FLAGS(req)                                                    \
2196         ptlrpc_rqphase2str(req),                                                \
2197         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                    \
2198         FLAG(req->rq_err, "E"),                                                 \
2199         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),   \
2200         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                  \
2201         FLAG(req->rq_no_resend, "N"),                                           \
2202         FLAG(req->rq_waiting, "W"),                                             \
2203         FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"),                     \
2204         FLAG(req->rq_committed, "M")
2205
2206 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s"
2207
2208 void _debug_req(struct ptlrpc_request *req,
2209                 struct libcfs_debug_msg_data *data, const char *fmt, ...)
2210         __attribute__ ((format (printf, 3, 4)));
2211
2212 /**
2213  * Helper that decides if we need to print request accordig to current debug
2214  * level settings
2215  */
2216 #define debug_req(msgdata, mask, cdls, req, fmt, a...)                        \
2217 do {                                                                          \
2218         CFS_CHECK_STACK(msgdata, mask, cdls);                                 \
2219                                                                               \
2220         if (((mask) & D_CANTMASK) != 0 ||                                     \
2221             ((libcfs_debug & (mask)) != 0 &&                                  \
2222              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
2223                 _debug_req((req), msgdata, fmt, ##a);                         \
2224 } while(0)
2225
2226 /**
2227  * This is the debug print function you need to use to print request sturucture
2228  * content into lustre debug log.
2229  * for most callers (level is a constant) this is resolved at compile time */
2230 #define DEBUG_REQ(level, req, fmt, args...)                                   \
2231 do {                                                                          \
2232         if ((level) & (D_ERROR | D_WARNING)) {                                \
2233                 static cfs_debug_limit_state_t cdls;                          \
2234                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls);            \
2235                 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
2236         } else {                                                              \
2237                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL);             \
2238                 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
2239         }                                                                     \
2240 } while (0)
2241 /** @} */
2242
2243 /**
2244  * Structure that defines a single page of a bulk transfer
2245  */
2246 struct ptlrpc_bulk_page {
2247         /** Linkage to list of pages in a bulk */
2248         struct list_head bp_link;
2249         /**
2250          * Number of bytes in a page to transfer starting from \a bp_pageoffset
2251          */
2252         int              bp_buflen;
2253         /** offset within a page */
2254         int              bp_pageoffset;
2255         /** The page itself */
2256         struct page     *bp_page;
2257 };
2258
2259 #define BULK_GET_SOURCE   0
2260 #define BULK_PUT_SINK     1
2261 #define BULK_GET_SINK     2
2262 #define BULK_PUT_SOURCE   3
2263
2264 /**
2265  * Definition of bulk descriptor.
2266  * Bulks are special "Two phase" RPCs where initial request message
2267  * is sent first and it is followed bt a transfer (o receiving) of a large
2268  * amount of data to be settled into pages referenced from the bulk descriptors.
2269  * Bulks transfers (the actual data following the small requests) are done
2270  * on separate LNet portals.
2271  * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
2272  *  Another user is readpage for MDT.
2273  */
2274 struct ptlrpc_bulk_desc {
2275         /** completed with failure */
2276         unsigned long bd_failure:1;
2277         /** {put,get}{source,sink} */
2278         unsigned long bd_type:2;
2279         /** client side */
2280         unsigned long bd_registered:1;
2281         /** For serialization with callback */
2282         spinlock_t bd_lock;
2283         /** Import generation when request for this bulk was sent */
2284         int bd_import_generation;
2285         /** LNet portal for this bulk */
2286         __u32 bd_portal;
2287         /** Server side - export this bulk created for */
2288         struct obd_export *bd_export;
2289         /** Client side - import this bulk was sent on */
2290         struct obd_import *bd_import;
2291         /** Back pointer to the request */
2292         struct ptlrpc_request *bd_req;
2293         wait_queue_head_t      bd_waitq;        /* server side only WQ */
2294         int                    bd_iov_count;    /* # entries in bd_iov */
2295         int                    bd_max_iov;      /* allocated size of bd_iov */
2296         int                    bd_nob;          /* # bytes covered */
2297         int                    bd_nob_transferred; /* # bytes GOT/PUT */
2298
2299         __u64                  bd_last_xid;
2300
2301         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
2302         lnet_nid_t             bd_sender;       /* stash event::sender */
2303         int                     bd_md_count;    /* # valid entries in bd_mds */
2304         int                     bd_md_max_brw;  /* max entries in bd_mds */
2305         /** array of associated MDs */
2306         lnet_handle_md_t        bd_mds[PTLRPC_BULK_OPS_COUNT];
2307
2308 #if defined(__KERNEL__)
2309         /*
2310          * encrypt iov, size is either 0 or bd_iov_count.
2311          */
2312         lnet_kiov_t           *bd_enc_iov;
2313
2314         lnet_kiov_t            bd_iov[0];
2315 #else
2316         lnet_md_iovec_t        bd_iov[0];
2317 #endif
2318 };
2319
2320 enum {
2321         SVC_STOPPED     = 1 << 0,
2322         SVC_STOPPING    = 1 << 1,
2323         SVC_STARTING    = 1 << 2,
2324         SVC_RUNNING     = 1 << 3,
2325         SVC_EVENT       = 1 << 4,
2326         SVC_SIGNAL      = 1 << 5,
2327 };
2328
2329 #define PTLRPC_THR_NAME_LEN             32
2330 /**
2331  * Definition of server service thread structure
2332  */
2333 struct ptlrpc_thread {
2334         /**
2335          * List of active threads in svc->srv_threads
2336          */
2337         struct list_head t_link;
2338         /**
2339          * thread-private data (preallocated memory)
2340          */
2341         void *t_data;
2342         __u32 t_flags;
2343         /**
2344          * service thread index, from ptlrpc_start_threads
2345          */
2346         unsigned int t_id;
2347         /**
2348          * service thread pid
2349          */
2350         pid_t t_pid; 
2351         /**
2352          * put watchdog in the structure per thread b=14840
2353          */
2354         struct lc_watchdog *t_watchdog;
2355         /**
2356          * the svc this thread belonged to b=18582
2357          */
2358         struct ptlrpc_service_part      *t_svcpt;
2359         wait_queue_head_t               t_ctl_waitq;
2360         struct lu_env                   *t_env;
2361         char                            t_name[PTLRPC_THR_NAME_LEN];
2362 };
2363
2364 static inline int thread_is_init(struct ptlrpc_thread *thread)
2365 {
2366         return thread->t_flags == 0;
2367 }
2368
2369 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
2370 {
2371         return !!(thread->t_flags & SVC_STOPPED);
2372 }
2373
2374 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
2375 {
2376         return !!(thread->t_flags & SVC_STOPPING);
2377 }
2378
2379 static inline int thread_is_starting(struct ptlrpc_thread *thread)
2380 {
2381         return !!(thread->t_flags & SVC_STARTING);
2382 }
2383
2384 static inline int thread_is_running(struct ptlrpc_thread *thread)
2385 {
2386         return !!(thread->t_flags & SVC_RUNNING);
2387 }
2388
2389 static inline int thread_is_event(struct ptlrpc_thread *thread)
2390 {
2391         return !!(thread->t_flags & SVC_EVENT);
2392 }
2393
2394 static inline int thread_is_signal(struct ptlrpc_thread *thread)
2395 {
2396         return !!(thread->t_flags & SVC_SIGNAL);
2397 }
2398
2399 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
2400 {
2401         thread->t_flags &= ~flags;
2402 }
2403
2404 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
2405 {
2406         thread->t_flags = flags;
2407 }
2408
2409 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
2410 {
2411         thread->t_flags |= flags;
2412 }
2413
2414 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
2415                                               __u32 flags)
2416 {
2417         if (thread->t_flags & flags) {
2418                 thread->t_flags &= ~flags;
2419                 return 1;
2420         }
2421         return 0;
2422 }
2423
2424 /**
2425  * Request buffer descriptor structure.
2426  * This is a structure that contains one posted request buffer for service.
2427  * Once data land into a buffer, event callback creates actual request and
2428  * notifies wakes one of the service threads to process new incoming request.
2429  * More than one request can fit into the buffer.
2430  */
2431 struct ptlrpc_request_buffer_desc {
2432         /** Link item for rqbds on a service */
2433         struct list_head                rqbd_list;
2434         /** History of requests for this buffer */
2435         struct list_head                rqbd_reqs;
2436         /** Back pointer to service for which this buffer is registered */
2437         struct ptlrpc_service_part      *rqbd_svcpt;
2438         /** LNet descriptor */
2439         lnet_handle_md_t                rqbd_md_h;
2440         int                             rqbd_refcount;
2441         /** The buffer itself */
2442         char                            *rqbd_buffer;
2443         struct ptlrpc_cb_id             rqbd_cbid;
2444         /**
2445          * This "embedded" request structure is only used for the
2446          * last request to fit into the buffer
2447          */
2448         struct ptlrpc_request           rqbd_req;
2449 };
2450
2451 typedef int  (*svc_handler_t)(struct ptlrpc_request *req);
2452
2453 struct ptlrpc_service_ops {
2454         /**
2455          * if non-NULL called during thread creation (ptlrpc_start_thread())
2456          * to initialize service specific per-thread state.
2457          */
2458         int             (*so_thr_init)(struct ptlrpc_thread *thr);
2459         /**
2460          * if non-NULL called during thread shutdown (ptlrpc_main()) to
2461          * destruct state created by ->srv_init().
2462          */
2463         void            (*so_thr_done)(struct ptlrpc_thread *thr);
2464         /**
2465          * Handler function for incoming requests for this service
2466          */
2467         int             (*so_req_handler)(struct ptlrpc_request *req);
2468         /**
2469          * function to determine priority of the request, it's called
2470          * on every new request
2471          */
2472         int             (*so_hpreq_handler)(struct ptlrpc_request *);
2473         /**
2474          * service-specific print fn
2475          */
2476         void            (*so_req_printer)(void *, struct ptlrpc_request *);
2477 };
2478
2479 #ifndef __cfs_cacheline_aligned
2480 /* NB: put it here for reducing patche dependence */
2481 # define __cfs_cacheline_aligned
2482 #endif
2483
2484 /**
2485  * How many high priority requests to serve before serving one normal
2486  * priority request
2487  */
2488 #define PTLRPC_SVC_HP_RATIO 10
2489
2490 /**
2491  * Definition of PortalRPC service.
2492  * The service is listening on a particular portal (like tcp port)
2493  * and perform actions for a specific server like IO service for OST
2494  * or general metadata service for MDS.
2495  */
2496 struct ptlrpc_service {
2497         /** serialize /proc operations */
2498         spinlock_t                      srv_lock;
2499         /** most often accessed fields */
2500         /** chain thru all services */
2501         struct list_head                srv_list;
2502         /** service operations table */
2503         struct ptlrpc_service_ops       srv_ops;
2504         /** only statically allocated strings here; we don't clean them */
2505         char                           *srv_name;
2506         /** only statically allocated strings here; we don't clean them */
2507         char                           *srv_thread_name;
2508         /** service thread list */
2509         struct list_head                srv_threads;
2510         /** threads # should be created for each partition on initializing */
2511         int                             srv_nthrs_cpt_init;
2512         /** limit of threads number for each partition */
2513         int                             srv_nthrs_cpt_limit;
2514         /** Root of /proc dir tree for this service */
2515         cfs_proc_dir_entry_t           *srv_procroot;
2516         /** Pointer to statistic data for this service */
2517         struct lprocfs_stats           *srv_stats;
2518         /** # hp per lp reqs to handle */
2519         int                             srv_hpreq_ratio;
2520         /** biggest request to receive */
2521         int                             srv_max_req_size;
2522         /** biggest reply to send */
2523         int                             srv_max_reply_size;
2524         /** size of individual buffers */
2525         int                             srv_buf_size;
2526         /** # buffers to allocate in 1 group */
2527         int                             srv_nbuf_per_group;
2528         /** Local portal on which to receive requests */
2529         __u32                           srv_req_portal;
2530         /** Portal on the client to send replies to */
2531         __u32                           srv_rep_portal;
2532         /**
2533          * Tags for lu_context associated with this thread, see struct
2534          * lu_context.
2535          */
2536         __u32                           srv_ctx_tags;
2537         /** soft watchdog timeout multiplier */
2538         int                             srv_watchdog_factor;
2539         /** under unregister_service */
2540         unsigned                        srv_is_stopping:1;
2541
2542         /** max # request buffers in history per partition */
2543         int                             srv_hist_nrqbds_cpt_max;
2544         /** number of CPTs this service bound on */
2545         int                             srv_ncpts;
2546         /** CPTs array this service bound on */
2547         __u32                           *srv_cpts;
2548         /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
2549         int                             srv_cpt_bits;
2550         /** CPT table this service is running over */
2551         struct cfs_cpt_table            *srv_cptable;
2552         /**
2553          * partition data for ptlrpc service
2554          */
2555         struct ptlrpc_service_part      *srv_parts[0];
2556 };
2557
2558 /**
2559  * Definition of PortalRPC service partition data.
2560  * Although a service only has one instance of it right now, but we
2561  * will have multiple instances very soon (instance per CPT).
2562  *
2563  * it has four locks:
2564  * \a scp_lock
2565  *    serialize operations on rqbd and requests waiting for preprocess
2566  * \a scp_req_lock
2567  *    serialize operations active requests sent to this portal
2568  * \a scp_at_lock
2569  *    serialize adaptive timeout stuff
2570  * \a scp_rep_lock
2571  *    serialize operations on RS list (reply states)
2572  *
2573  * We don't have any use-case to take two or more locks at the same time
2574  * for now, so there is no lock order issue.
2575  */
2576 struct ptlrpc_service_part {
2577         /** back reference to owner */
2578         struct ptlrpc_service           *scp_service __cfs_cacheline_aligned;
2579         /* CPT id, reserved */
2580         int                             scp_cpt;
2581         /** always increasing number */
2582         int                             scp_thr_nextid;
2583         /** # of starting threads */
2584         int                             scp_nthrs_starting;
2585         /** # of stopping threads, reserved for shrinking threads */
2586         int                             scp_nthrs_stopping;
2587         /** # running threads */
2588         int                             scp_nthrs_running;
2589         /** service threads list */
2590         struct list_head                scp_threads;
2591
2592         /**
2593          * serialize the following fields, used for protecting
2594          * rqbd list and incoming requests waiting for preprocess,
2595          * threads starting & stopping are also protected by this lock.
2596          */
2597         spinlock_t                      scp_lock  __cfs_cacheline_aligned;
2598         /** total # req buffer descs allocated */
2599         int                             scp_nrqbds_total;
2600         /** # posted request buffers for receiving */
2601         int                             scp_nrqbds_posted;
2602         /** in progress of allocating rqbd */
2603         int                             scp_rqbd_allocating;
2604         /** # incoming reqs */
2605         int                             scp_nreqs_incoming;
2606         /** request buffers to be reposted */
2607         struct list_head                scp_rqbd_idle;
2608         /** req buffers receiving */
2609         struct list_head                scp_rqbd_posted;
2610         /** incoming reqs */
2611         struct list_head                scp_req_incoming;
2612         /** timeout before re-posting reqs, in tick */
2613         cfs_duration_t                  scp_rqbd_timeout;
2614         /**
2615          * all threads sleep on this. This wait-queue is signalled when new
2616          * incoming request arrives and when difficult reply has to be handled.
2617          */
2618         wait_queue_head_t               scp_waitq;
2619
2620         /** request history */
2621         struct list_head                scp_hist_reqs;
2622         /** request buffer history */
2623         struct list_head                scp_hist_rqbds;
2624         /** # request buffers in history */
2625         int                             scp_hist_nrqbds;
2626         /** sequence number for request */
2627         __u64                           scp_hist_seq;
2628         /** highest seq culled from history */
2629         __u64                           scp_hist_seq_culled;
2630
2631         /**
2632          * serialize the following fields, used for processing requests
2633          * sent to this portal
2634          */
2635         spinlock_t                      scp_req_lock __cfs_cacheline_aligned;
2636         /** # reqs in either of the NRS heads below */
2637         /** # reqs being served */
2638         int                             scp_nreqs_active;
2639         /** # HPreqs being served */
2640         int                             scp_nhreqs_active;
2641         /** # hp requests handled */
2642         int                             scp_hreq_count;
2643
2644         /** NRS head for regular requests */
2645         struct ptlrpc_nrs               scp_nrs_reg;
2646         /** NRS head for HP requests; this is only valid for services that can
2647          *  handle HP requests */
2648         struct ptlrpc_nrs              *scp_nrs_hp;
2649
2650         /** AT stuff */
2651         /** @{ */
2652         /**
2653          * serialize the following fields, used for changes on
2654          * adaptive timeout
2655          */
2656         spinlock_t                      scp_at_lock __cfs_cacheline_aligned;
2657         /** estimated rpc service time */
2658         struct adaptive_timeout         scp_at_estimate;
2659         /** reqs waiting for replies */
2660         struct ptlrpc_at_array          scp_at_array;
2661         /** early reply timer */
2662         struct timer_list               scp_at_timer;
2663         /** debug */
2664         cfs_time_t                      scp_at_checktime;
2665         /** check early replies */
2666         unsigned                        scp_at_check;
2667         /** @} */
2668
2669         /**
2670          * serialize the following fields, used for processing
2671          * replies for this portal
2672          */
2673         spinlock_t                      scp_rep_lock __cfs_cacheline_aligned;
2674         /** all the active replies */
2675         struct list_head                scp_rep_active;
2676 #ifndef __KERNEL__
2677         /** replies waiting for service */
2678         struct list_head                scp_rep_queue;
2679 #endif
2680         /** List of free reply_states */
2681         struct list_head                scp_rep_idle;
2682         /** waitq to run, when adding stuff to srv_free_rs_list */
2683         wait_queue_head_t               scp_rep_waitq;
2684         /** # 'difficult' replies */
2685         atomic_t                        scp_nreps_difficult;
2686 };
2687
2688 #define ptlrpc_service_for_each_part(part, i, svc)                      \
2689         for (i = 0;                                                     \
2690              i < (svc)->srv_ncpts &&                                    \
2691              (svc)->srv_parts != NULL &&                                \
2692              ((part) = (svc)->srv_parts[i]) != NULL; i++)
2693
2694 /**
2695  * Declaration of ptlrpcd control structure
2696  */
2697 struct ptlrpcd_ctl {
2698         /**
2699          * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
2700          */
2701         unsigned long                   pc_flags;
2702         /**
2703          * Thread lock protecting structure fields.
2704          */
2705         spinlock_t                      pc_lock;
2706         /**
2707          * Start completion.
2708          */
2709         struct completion               pc_starting;
2710         /**
2711          * Stop completion.
2712          */
2713         struct completion               pc_finishing;
2714         /**
2715          * Thread requests set.
2716          */
2717         struct ptlrpc_request_set  *pc_set;
2718         /**
2719          * Thread name used in kthread_run()
2720          */
2721         char                        pc_name[16];
2722         /**
2723          * Environment for request interpreters to run in.
2724          */
2725         struct lu_env               pc_env;
2726         /**
2727          * Index of ptlrpcd thread in the array.
2728          */
2729         int                         pc_index;
2730         /**
2731          * Number of the ptlrpcd's partners.
2732          */
2733         int                         pc_npartners;
2734         /**
2735          * Pointer to the array of partners' ptlrpcd_ctl structure.
2736          */
2737         struct ptlrpcd_ctl        **pc_partners;
2738         /**
2739          * Record the partner index to be processed next.
2740          */
2741         int                         pc_cursor;
2742 #ifndef __KERNEL__
2743         /**
2744          * Async rpcs flag to make sure that ptlrpcd_check() is called only
2745          * once.
2746          */
2747         int                         pc_recurred;
2748         /**
2749          * Currently not used.
2750          */
2751         void                       *pc_callback;
2752         /**
2753          * User-space async rpcs callback.
2754          */
2755         void                       *pc_wait_callback;
2756         /**
2757          * User-space check idle rpcs callback.
2758          */
2759         void                       *pc_idle_callback;
2760 #endif
2761 };
2762
2763 /* Bits for pc_flags */
2764 enum ptlrpcd_ctl_flags {
2765         /**
2766          * Ptlrpc thread start flag.
2767          */
2768         LIOD_START       = 1 << 0,
2769         /**
2770          * Ptlrpc thread stop flag.
2771          */
2772         LIOD_STOP        = 1 << 1,
2773         /**
2774          * Ptlrpc thread force flag (only stop force so far).
2775          * This will cause aborting any inflight rpcs handled
2776          * by thread if LIOD_STOP is specified.
2777          */
2778         LIOD_FORCE       = 1 << 2,
2779         /**
2780          * This is a recovery ptlrpc thread.
2781          */
2782         LIOD_RECOVERY    = 1 << 3,
2783         /**
2784          * The ptlrpcd is bound to some CPU core.
2785          */
2786         LIOD_BIND        = 1 << 4,
2787 };
2788
2789 /**
2790  * \addtogroup nrs
2791  * @{
2792  *
2793  * Service compatibility function; the policy is compatible with all services.
2794  *
2795  * \param[in] svc  The service the policy is attempting to register with.
2796  * \param[in] desc The policy descriptor
2797  *
2798  * \retval true The policy is compatible with the service
2799  *
2800  * \see ptlrpc_nrs_pol_desc::pd_compat()
2801  */
2802 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
2803                                          const struct ptlrpc_nrs_pol_desc *desc)
2804 {
2805         return true;
2806 }
2807
2808 /**
2809  * Service compatibility function; the policy is compatible with only a specific
2810  * service which is identified by its human-readable name at
2811  * ptlrpc_service::srv_name.
2812  *
2813  * \param[in] svc  The service the policy is attempting to register with.
2814  * \param[in] desc The policy descriptor
2815  *
2816  * \retval false The policy is not compatible with the service
2817  * \retval true  The policy is compatible with the service
2818  *
2819  * \see ptlrpc_nrs_pol_desc::pd_compat()
2820  */
2821 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
2822                                          const struct ptlrpc_nrs_pol_desc *desc)
2823 {
2824         LASSERT(desc->pd_compat_svc_name != NULL);
2825         return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
2826 }
2827
2828 /** @} nrs */
2829
2830 /* ptlrpc/events.c */
2831 extern lnet_handle_eq_t ptlrpc_eq_h;
2832 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
2833                                lnet_process_id_t *peer, lnet_nid_t *self);
2834 /**
2835  * These callbacks are invoked by LNet when something happened to
2836  * underlying buffer
2837  * @{
2838  */
2839 extern void request_out_callback(lnet_event_t *ev);
2840 extern void reply_in_callback(lnet_event_t *ev);
2841 extern void client_bulk_callback(lnet_event_t *ev);
2842 extern void request_in_callback(lnet_event_t *ev);
2843 extern void reply_out_callback(lnet_event_t *ev);
2844 #ifdef HAVE_SERVER_SUPPORT
2845 extern void server_bulk_callback(lnet_event_t *ev);
2846 #endif
2847 /** @} */
2848
2849 /* ptlrpc/connection.c */
2850 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
2851                                                 lnet_nid_t self,
2852                                                 struct obd_uuid *uuid);
2853 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2854 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2855 int ptlrpc_connection_init(void);
2856 void ptlrpc_connection_fini(void);
2857 extern lnet_pid_t ptl_get_pid(void);
2858
2859 /* ptlrpc/niobuf.c */
2860 /**
2861  * Actual interfacing with LNet to put/get/register/unregister stuff
2862  * @{
2863  */
2864 #ifdef HAVE_SERVER_SUPPORT
2865 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2866                                               unsigned npages, unsigned max_brw,
2867                                               unsigned type, unsigned portal);
2868 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2869 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2870
2871 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2872 {
2873         int rc;
2874
2875         LASSERT(desc != NULL);
2876
2877         spin_lock(&desc->bd_lock);
2878         rc = desc->bd_md_count;
2879         spin_unlock(&desc->bd_lock);
2880         return rc;
2881 }
2882 #endif
2883
2884 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2885 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2886
2887 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2888 {
2889         struct ptlrpc_bulk_desc *desc;
2890         int                      rc;
2891
2892         LASSERT(req != NULL);
2893         desc = req->rq_bulk;
2894
2895         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK) &&
2896             req->rq_bulk_deadline > cfs_time_current_sec())
2897                 return 1;
2898
2899         if (!desc)
2900                 return 0;
2901
2902         spin_lock(&desc->bd_lock);
2903         rc = desc->bd_md_count;
2904         spin_unlock(&desc->bd_lock);
2905         return rc;
2906 }
2907
2908 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2909 #define PTLRPC_REPLY_EARLY           0x02
2910 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2911 int ptlrpc_reply(struct ptlrpc_request *req);
2912 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2913 int ptlrpc_error(struct ptlrpc_request *req);
2914 void ptlrpc_resend_req(struct ptlrpc_request *request);
2915 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2916 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2917 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2918 /** @} */
2919
2920 /* ptlrpc/client.c */
2921 /**
2922  * Client-side portals API. Everything to send requests, receive replies,
2923  * request queues, request management, etc.
2924  * @{
2925  */
2926 void ptlrpc_request_committed(struct ptlrpc_request *req, int force);
2927
2928 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
2929                         struct ptlrpc_client *);
2930 void ptlrpc_cleanup_client(struct obd_import *imp);
2931 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
2932
2933 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2934 int ptlrpc_replay_req(struct ptlrpc_request *req);
2935 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
2936 void ptlrpc_restart_req(struct ptlrpc_request *req);
2937 void ptlrpc_abort_inflight(struct obd_import *imp);
2938 void ptlrpc_cleanup_imp(struct obd_import *imp);
2939 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2940
2941 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2942 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2943                                              void *arg);
2944 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
2945                       set_interpreter_func fn, void *data);
2946 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
2947 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2948 int ptlrpc_set_wait(struct ptlrpc_request_set *);
2949 int ptlrpc_expired_set(void *data);
2950 void ptlrpc_interrupted_set(void *data);
2951 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2952 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2953 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2954 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
2955                             struct ptlrpc_request *req);
2956
2957 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2958 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2959
2960 struct ptlrpc_request_pool *
2961 ptlrpc_init_rq_pool(int, int,
2962                     void (*populate_pool)(struct ptlrpc_request_pool *, int));
2963
2964 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2965 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2966                                             const struct req_format *format);
2967 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2968                                             struct ptlrpc_request_pool *,
2969                                             const struct req_format *format);
2970 void ptlrpc_request_free(struct ptlrpc_request *request);
2971 int ptlrpc_request_pack(struct ptlrpc_request *request,
2972                         __u32 version, int opcode);
2973 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2974                                                 const struct req_format *format,
2975                                                 __u32 version, int opcode);
2976 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2977                              __u32 version, int opcode, char **bufs,
2978                              struct ptlrpc_cli_ctx *ctx);
2979 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
2980                                        int opcode, int count, __u32 *lengths,
2981                                        char **bufs);
2982 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
2983                                              __u32 version, int opcode,
2984                                             int count, __u32 *lengths, char **bufs,
2985                                             struct ptlrpc_request_pool *pool);
2986 void ptlrpc_req_finished(struct ptlrpc_request *request);
2987 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2988 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2989 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2990                                               unsigned npages, unsigned max_brw,
2991                                               unsigned type, unsigned portal);
2992 void __ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk, int pin);
2993 static inline void ptlrpc_free_bulk_pin(struct ptlrpc_bulk_desc *bulk)
2994 {
2995         __ptlrpc_free_bulk(bulk, 1);
2996 }
2997 static inline void ptlrpc_free_bulk_nopin(struct ptlrpc_bulk_desc *bulk)
2998 {
2999         __ptlrpc_free_bulk(bulk, 0);
3000 }
3001 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
3002                              struct page *page, int pageoffset, int len, int);
3003 static inline void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
3004                                              struct page *page, int pageoffset,
3005                                              int len)
3006 {
3007         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
3008 }
3009
3010 static inline void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
3011                                                struct page *page, int pageoffset,
3012                                                int len)
3013 {
3014         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
3015 }
3016
3017 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
3018                                       struct obd_import *imp);
3019 __u64 ptlrpc_next_xid(void);
3020 __u64 ptlrpc_sample_next_xid(void);
3021 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
3022
3023 /* Set of routines to run a function in ptlrpcd context */
3024 void *ptlrpcd_alloc_work(struct obd_import *imp,
3025                          int (*cb)(const struct lu_env *, void *), void *data);
3026 void ptlrpcd_destroy_work(void *handler);
3027 int ptlrpcd_queue_work(void *handler);
3028
3029 /** @} */
3030 struct ptlrpc_service_buf_conf {
3031         /* nbufs is buffers # to allocate when growing the pool */
3032         unsigned int                    bc_nbufs;
3033         /* buffer size to post */
3034         unsigned int                    bc_buf_size;
3035         /* portal to listed for requests on */
3036         unsigned int                    bc_req_portal;
3037         /* portal of where to send replies to */
3038         unsigned int                    bc_rep_portal;
3039         /* maximum request size to be accepted for this service */
3040         unsigned int                    bc_req_max_size;
3041         /* maximum reply size this service can ever send */
3042         unsigned int                    bc_rep_max_size;
3043 };
3044
3045 struct ptlrpc_service_thr_conf {
3046         /* threadname should be 8 characters or less - 6 will be added on */
3047         char                            *tc_thr_name;
3048         /* threads increasing factor for each CPU */
3049         unsigned int                    tc_thr_factor;
3050         /* service threads # to start on each partition while initializing */
3051         unsigned int                    tc_nthrs_init;
3052         /*
3053          * low water of threads # upper-limit on each partition while running,
3054          * service availability may be impacted if threads number is lower
3055          * than this value. It can be ZERO if the service doesn't require
3056          * CPU affinity or there is only one partition.
3057          */
3058         unsigned int                    tc_nthrs_base;
3059         /* "soft" limit for total threads number */
3060         unsigned int                    tc_nthrs_max;
3061         /* user specified threads number, it will be validated due to
3062          * other members of this structure. */
3063         unsigned int                    tc_nthrs_user;
3064         /* set NUMA node affinity for service threads */
3065         unsigned int                    tc_cpu_affinity;
3066         /* Tags for lu_context associated with service thread */
3067         __u32                           tc_ctx_tags;
3068 };
3069
3070 struct ptlrpc_service_cpt_conf {
3071         struct cfs_cpt_table            *cc_cptable;
3072         /* string pattern to describe CPTs for a service */
3073         char                            *cc_pattern;
3074 };
3075
3076 struct ptlrpc_service_conf {
3077         /* service name */
3078         char                            *psc_name;
3079         /* soft watchdog timeout multiplifier to print stuck service traces */
3080         unsigned int                    psc_watchdog_factor;
3081         /* buffer information */
3082         struct ptlrpc_service_buf_conf  psc_buf;
3083         /* thread information */
3084         struct ptlrpc_service_thr_conf  psc_thr;
3085         /* CPU partition information */
3086         struct ptlrpc_service_cpt_conf  psc_cpt;
3087         /* function table */
3088         struct ptlrpc_service_ops       psc_ops;
3089 };
3090
3091 /* ptlrpc/service.c */
3092 /**
3093  * Server-side services API. Register/unregister service, request state
3094  * management, service thread management
3095  *
3096  * @{
3097  */
3098 void ptlrpc_save_lock(struct ptlrpc_request *req,
3099                       struct lustre_handle *lock, int mode, int no_ack);
3100 void ptlrpc_commit_replies(struct obd_export *exp);
3101 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
3102 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
3103 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
3104 struct ptlrpc_service *ptlrpc_register_service(
3105                                 struct ptlrpc_service_conf *conf,
3106                                 struct proc_dir_entry *proc_entry);
3107 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
3108
3109 int ptlrpc_start_threads(struct ptlrpc_service *svc);
3110 int ptlrpc_unregister_service(struct ptlrpc_service *service);
3111 int liblustre_check_services(void *arg);
3112 void ptlrpc_daemonize(char *name);
3113 int ptlrpc_service_health_check(struct ptlrpc_service *);
3114 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
3115 void ptlrpc_request_change_export(struct ptlrpc_request *req,
3116                                   struct obd_export *export);
3117
3118 #ifdef __KERNEL__
3119 int ptlrpc_hr_init(void);
3120 void ptlrpc_hr_fini(void);
3121 #else
3122 # define ptlrpc_hr_init() (0)
3123 # define ptlrpc_hr_fini() do {} while(0)
3124 #endif
3125
3126 /** @} */
3127
3128 /* ptlrpc/import.c */
3129 /**
3130  * Import API
3131  * @{
3132  */
3133 int ptlrpc_connect_import(struct obd_import *imp);
3134 int ptlrpc_init_import(struct obd_import *imp);
3135 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
3136 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
3137 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
3138                int *uuid_len);
3139
3140 /* ptlrpc/pack_generic.c */
3141 int ptlrpc_reconnect_import(struct obd_import *imp);
3142 /** @} */
3143
3144 /**
3145  * ptlrpc msg buffer and swab interface 
3146  *
3147  * @{
3148  */
3149 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
3150                          int index);
3151 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
3152                                 int index);
3153 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
3154 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
3155
3156 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
3157 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
3158                         char **bufs);
3159 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
3160                         __u32 *lens, char **bufs);
3161 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
3162                       char **bufs);
3163 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
3164                          __u32 *lens, char **bufs, int flags);
3165 #define LPRFL_EARLY_REPLY 1
3166 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
3167                             char **bufs, int flags);
3168 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
3169                       unsigned int newlen, int move_data);
3170 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
3171 int __lustre_unpack_msg(struct lustre_msg *m, int len);
3172 int lustre_msg_hdr_size(__u32 magic, int count);
3173 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
3174 int lustre_msg_size_v2(int count, __u32 *lengths);
3175 int lustre_packed_msg_size(struct lustre_msg *msg);
3176 int lustre_msg_early_size(void);
3177 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
3178 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
3179 int lustre_msg_buflen(struct lustre_msg *m, int n);
3180 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
3181 int lustre_msg_bufcount(struct lustre_msg *m);
3182 char *lustre_msg_string(struct lustre_msg *m, int n, int max_len);
3183 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
3184 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
3185 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
3186 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
3187 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
3188 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
3189 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
3190 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
3191 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
3192 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
3193 __u32 lustre_msg_get_type(struct lustre_msg *msg);
3194 __u32 lustre_msg_get_version(struct lustre_msg *msg);
3195 void lustre_msg_add_version(struct lustre_msg *msg, int version);
3196 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
3197 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
3198 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
3199 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
3200 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
3201 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
3202 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
3203 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
3204 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
3205 int lustre_msg_get_status(struct lustre_msg *msg);
3206 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
3207 int lustre_msg_is_v1(struct lustre_msg *msg);
3208 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
3209 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
3210 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
3211 char *lustre_msg_get_jobid(struct lustre_msg *msg);
3212 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
3213 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 50, 0)
3214 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18);
3215 #else
3216 # warning "remove checksum compatibility support for b1_8"
3217 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
3218 #endif
3219 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
3220 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
3221 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
3222 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
3223 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
3224 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
3225 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
3226 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
3227 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
3228 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
3229 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
3230 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
3231 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
3232 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
3233 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
3234
3235 static inline void
3236 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
3237                     unsigned int newlen, int move_data)
3238 {
3239         LASSERT(req->rq_reply_state);
3240         LASSERT(req->rq_repmsg);
3241         req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
3242                                            newlen, move_data);
3243 }
3244
3245 #ifdef LUSTRE_TRANSLATE_ERRNOS
3246
3247 static inline int ptlrpc_status_hton(int h)
3248 {
3249         /*
3250          * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
3251          * ELDLM_LOCK_ABORTED, etc.
3252          */
3253         if (h < 0)
3254                 return -lustre_errno_hton(-h);
3255         else