Whamcloud - gitweb
LU-2139 osc: Track and limit "unstable" pages
[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          (5 * 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         cfs_hlist_node_t        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         cfs_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         cfs_atomic_t          set_refcount;
578         /** number of in queue requests */
579         cfs_atomic_t          set_new_count;
580         /** number of uncompleted requests */
581         cfs_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         cfs_list_t            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         cfs_list_t            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         cfs_list_t            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         cfs_list_t              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         cfs_list_t             rs_list;
657         /** Linkage for list of all reply states on same export */
658         cfs_list_t             rs_exp_list;
659         /** Linkage for list of all reply states for same obd */
660         cfs_list_t             rs_obd_list;
661 #if RS_DEBUG
662         cfs_list_t             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         cfs_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         cfs_list_t 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          *
826          * \see nrs_policy_start_locked()
827          */
828         int     (*op_policy_start) (struct ptlrpc_nrs_policy *policy);
829         /**
830          * Called when deactivating a policy via lprocfs; policies deallocate
831          * their resources here; this operation is optional
832          *
833          * \param[in,out] policy The policy being stopped
834          *
835          * \see nrs_policy_stop0()
836          */
837         void    (*op_policy_stop) (struct ptlrpc_nrs_policy *policy);
838         /**
839          * Used for policy-specific operations; i.e. not generic ones like
840          * \e PTLRPC_NRS_CTL_START and \e PTLRPC_NRS_CTL_GET_INFO; analogous
841          * to an ioctl; this operation is optional.
842          *
843          * \param[in,out]        policy The policy carrying out operation \a opc
844          * \param[in]     opc    The command operation being carried out
845          * \param[in,out] arg    An generic buffer for communication between the
846          *                       user and the control operation
847          *
848          * \retval -ve error
849          * \retval   0 success
850          *
851          * \see ptlrpc_nrs_policy_control()
852          */
853         int     (*op_policy_ctl) (struct ptlrpc_nrs_policy *policy,
854                                   enum ptlrpc_nrs_ctl opc, void *arg);
855
856         /**
857          * Called when obtaining references to the resources of the resource
858          * hierarchy for a request that has arrived for handling at the PTLRPC
859          * service. Policies should return -ve for requests they do not wish
860          * to handle. This operation is mandatory.
861          *
862          * \param[in,out] policy  The policy we're getting resources for.
863          * \param[in,out] nrq     The request we are getting resources for.
864          * \param[in]     parent  The parent resource of the resource being
865          *                        requested; set to NULL if none.
866          * \param[out]    resp    The resource is to be returned here; the
867          *                        fallback policy in an NRS head should
868          *                        \e always return a non-NULL pointer value.
869          * \param[in]  moving_req When set, signifies that this is an attempt
870          *                        to obtain resources for a request being moved
871          *                        to the high-priority NRS head by
872          *                        ldlm_lock_reorder_req().
873          *                        This implies two things:
874          *                        1. We are under obd_export::exp_rpc_lock and
875          *                        so should not sleep.
876          *                        2. We should not perform non-idempotent or can
877          *                        skip performing idempotent operations that
878          *                        were carried out when resources were first
879          *                        taken for the request when it was initialized
880          *                        in ptlrpc_nrs_req_initialize().
881          *
882          * \retval 0, +ve The level of the returned resource in the resource
883          *                hierarchy; currently only 0 (for a non-leaf resource)
884          *                and 1 (for a leaf resource) are supported by the
885          *                framework.
886          * \retval -ve    error
887          *
888          * \see ptlrpc_nrs_req_initialize()
889          * \see ptlrpc_nrs_hpreq_add_nolock()
890          * \see ptlrpc_nrs_req_hp_move()
891          */
892         int     (*op_res_get) (struct ptlrpc_nrs_policy *policy,
893                                struct ptlrpc_nrs_request *nrq,
894                                const struct ptlrpc_nrs_resource *parent,
895                                struct ptlrpc_nrs_resource **resp,
896                                bool moving_req);
897         /**
898          * Called when releasing references taken for resources in the resource
899          * hierarchy for the request; this operation is optional.
900          *
901          * \param[in,out] policy The policy the resource belongs to
902          * \param[in] res        The resource to be freed
903          *
904          * \see ptlrpc_nrs_req_finalize()
905          * \see ptlrpc_nrs_hpreq_add_nolock()
906          * \see ptlrpc_nrs_req_hp_move()
907          */
908         void    (*op_res_put) (struct ptlrpc_nrs_policy *policy,
909                                const struct ptlrpc_nrs_resource *res);
910
911         /**
912          * Obtains a request for handling from the policy, and optionally
913          * removes the request from the policy; this operation is mandatory.
914          *
915          * \param[in,out] policy The policy to poll
916          * \param[in]     peek   When set, signifies that we just want to
917          *                       examine the request, and not handle it, so the
918          *                       request is not removed from the policy.
919          * \param[in]     force  When set, it will force a policy to return a
920          *                       request if it has one queued.
921          *
922          * \retval NULL No request available for handling
923          * \retval valid-pointer The request polled for handling
924          *
925          * \see ptlrpc_nrs_req_get_nolock()
926          */
927         struct ptlrpc_nrs_request *
928                 (*op_req_get) (struct ptlrpc_nrs_policy *policy, bool peek,
929                                bool force);
930         /**
931          * Called when attempting to add a request to a policy for later
932          * handling; this operation is mandatory.
933          *
934          * \param[in,out] policy  The policy on which to enqueue \a nrq
935          * \param[in,out] nrq The request to enqueue
936          *
937          * \retval 0    success
938          * \retval != 0 error
939          *
940          * \see ptlrpc_nrs_req_add_nolock()
941          */
942         int     (*op_req_enqueue) (struct ptlrpc_nrs_policy *policy,
943                                    struct ptlrpc_nrs_request *nrq);
944         /**
945          * Removes a request from the policy's set of pending requests. Normally
946          * called after a request has been polled successfully from the policy
947          * for handling; this operation is mandatory.
948          *
949          * \param[in,out] policy The policy the request \a nrq belongs to
950          * \param[in,out] nrq    The request to dequeue
951          *
952          * \see ptlrpc_nrs_req_del_nolock()
953          */
954         void    (*op_req_dequeue) (struct ptlrpc_nrs_policy *policy,
955                                    struct ptlrpc_nrs_request *nrq);
956         /**
957          * Called after the request being carried out. Could be used for
958          * job/resource control; this operation is optional.
959          *
960          * \param[in,out] policy The policy which is stopping to handle request
961          *                       \a nrq
962          * \param[in,out] nrq    The request
963          *
964          * \pre spin_is_locked(&svcpt->scp_req_lock)
965          *
966          * \see ptlrpc_nrs_req_stop_nolock()
967          */
968         void    (*op_req_stop) (struct ptlrpc_nrs_policy *policy,
969                                 struct ptlrpc_nrs_request *nrq);
970         /**
971          * Registers the policy's lprocfs interface with a PTLRPC service.
972          *
973          * \param[in] svc The service
974          *
975          * \retval 0    success
976          * \retval != 0 error
977          */
978         int     (*op_lprocfs_init) (struct ptlrpc_service *svc);
979         /**
980          * Unegisters the policy's lprocfs interface with a PTLRPC service.
981          *
982          * In cases of failed policy registration in
983          * \e ptlrpc_nrs_policy_register(), this function may be called for a
984          * service which has not registered the policy successfully, so
985          * implementations of this method should make sure their operations are
986          * safe in such cases.
987          *
988          * \param[in] svc The service
989          */
990         void    (*op_lprocfs_fini) (struct ptlrpc_service *svc);
991 };
992
993 /**
994  * Policy flags
995  */
996 enum nrs_policy_flags {
997         /**
998          * Fallback policy, use this flag only on a single supported policy per
999          * service. The flag cannot be used on policies that use
1000          * \e PTLRPC_NRS_FL_REG_EXTERN
1001          */
1002         PTLRPC_NRS_FL_FALLBACK          = (1 << 0),
1003         /**
1004          * Start policy immediately after registering.
1005          */
1006         PTLRPC_NRS_FL_REG_START         = (1 << 1),
1007         /**
1008          * This is a policy registering from a module different to the one NRS
1009          * core ships in (currently ptlrpc).
1010          */
1011         PTLRPC_NRS_FL_REG_EXTERN        = (1 << 2),
1012 };
1013
1014 /**
1015  * NRS queue type.
1016  *
1017  * Denotes whether an NRS instance is for handling normal or high-priority
1018  * RPCs, or whether an operation pertains to one or both of the NRS instances
1019  * in a service.
1020  */
1021 enum ptlrpc_nrs_queue_type {
1022         PTLRPC_NRS_QUEUE_REG    = (1 << 0),
1023         PTLRPC_NRS_QUEUE_HP     = (1 << 1),
1024         PTLRPC_NRS_QUEUE_BOTH   = (PTLRPC_NRS_QUEUE_REG | PTLRPC_NRS_QUEUE_HP)
1025 };
1026
1027 /**
1028  * NRS head
1029  *
1030  * A PTLRPC service has at least one NRS head instance for handling normal
1031  * priority RPCs, and may optionally have a second NRS head instance for
1032  * handling high-priority RPCs. Each NRS head maintains a list of available
1033  * policies, of which one and only one policy is acting as the fallback policy,
1034  * and optionally a different policy may be acting as the primary policy. For
1035  * all RPCs handled by this NRS head instance, NRS core will first attempt to
1036  * enqueue the RPC using the primary policy (if any). The fallback policy is
1037  * used in the following cases:
1038  * - when there was no primary policy in the
1039  *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state at the time the request
1040  *   was initialized.
1041  * - when the primary policy that was at the
1042  *   ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1043  *   RPC was initialized, denoted it did not wish, or for some other reason was
1044  *   not able to handle the request, by returning a non-valid NRS resource
1045  *   reference.
1046  * - when the primary policy that was at the
1047  *   ptlrpc_nrs_pol_state::PTLRPC_NRS_POL_STATE_STARTED state at the time the
1048  *   RPC was initialized, fails later during the request enqueueing stage.
1049  *
1050  * \see nrs_resource_get_safe()
1051  * \see nrs_request_enqueue()
1052  */
1053 struct ptlrpc_nrs {
1054         spinlock_t                      nrs_lock;
1055         /** XXX Possibly replace svcpt->scp_req_lock with another lock here. */
1056         /**
1057          * List of registered policies
1058          */
1059         cfs_list_t                      nrs_policy_list;
1060         /**
1061          * List of policies with queued requests. Policies that have any
1062          * outstanding requests are queued here, and this list is queried
1063          * in a round-robin manner from NRS core when obtaining a request
1064          * for handling. This ensures that requests from policies that at some
1065          * point transition away from the
1066          * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED state are drained.
1067          */
1068         cfs_list_t                      nrs_policy_queued;
1069         /**
1070          * Service partition for this NRS head
1071          */
1072         struct ptlrpc_service_part     *nrs_svcpt;
1073         /**
1074          * Primary policy, which is the preferred policy for handling RPCs
1075          */
1076         struct ptlrpc_nrs_policy       *nrs_policy_primary;
1077         /**
1078          * Fallback policy, which is the backup policy for handling RPCs
1079          */
1080         struct ptlrpc_nrs_policy       *nrs_policy_fallback;
1081         /**
1082          * This NRS head handles either HP or regular requests
1083          */
1084         enum ptlrpc_nrs_queue_type      nrs_queue_type;
1085         /**
1086          * # queued requests from all policies in this NRS head
1087          */
1088         unsigned long                   nrs_req_queued;
1089         /**
1090          * # scheduled requests from all policies in this NRS head
1091          */
1092         unsigned long                   nrs_req_started;
1093         /**
1094          * # policies on this NRS
1095          */
1096         unsigned                        nrs_num_pols;
1097         /**
1098          * This NRS head is in progress of starting a policy
1099          */
1100         unsigned                        nrs_policy_starting:1;
1101         /**
1102          * In progress of shutting down the whole NRS head; used during
1103          * unregistration
1104          */
1105         unsigned                        nrs_stopping:1;
1106 };
1107
1108 #define NRS_POL_NAME_MAX                16
1109
1110 struct ptlrpc_nrs_pol_desc;
1111
1112 /**
1113  * Service compatibility predicate; this determines whether a policy is adequate
1114  * for handling RPCs of a particular PTLRPC service.
1115  *
1116  * XXX:This should give the same result during policy registration and
1117  * unregistration, and for all partitions of a service; so the result should not
1118  * depend on temporal service or other properties, that may influence the
1119  * result.
1120  */
1121 typedef bool (*nrs_pol_desc_compat_t) (const struct ptlrpc_service *svc,
1122                                        const struct ptlrpc_nrs_pol_desc *desc);
1123
1124 struct ptlrpc_nrs_pol_conf {
1125         /**
1126          * Human-readable policy name
1127          */
1128         char                               nc_name[NRS_POL_NAME_MAX];
1129         /**
1130          * NRS operations for this policy
1131          */
1132         const struct ptlrpc_nrs_pol_ops   *nc_ops;
1133         /**
1134          * Service compatibility predicate
1135          */
1136         nrs_pol_desc_compat_t              nc_compat;
1137         /**
1138          * Set for policies that support a single ptlrpc service, i.e. ones that
1139          * have \a pd_compat set to nrs_policy_compat_one(). The variable value
1140          * depicts the name of the single service that such policies are
1141          * compatible with.
1142          */
1143         const char                        *nc_compat_svc_name;
1144         /**
1145          * Owner module for this policy descriptor; policies registering from a
1146          * different module to the one the NRS framework is held within
1147          * (currently ptlrpc), should set this field to THIS_MODULE.
1148          */
1149         struct module                     *nc_owner;
1150         /**
1151          * Policy registration flags; a bitmast of \e nrs_policy_flags
1152          */
1153         unsigned                           nc_flags;
1154 };
1155
1156 /**
1157  * NRS policy registering descriptor
1158  *
1159  * Is used to hold a description of a policy that can be passed to NRS core in
1160  * order to register the policy with NRS heads in different PTLRPC services.
1161  */
1162 struct ptlrpc_nrs_pol_desc {
1163         /**
1164          * Human-readable policy name
1165          */
1166         char                                    pd_name[NRS_POL_NAME_MAX];
1167         /**
1168          * Link into nrs_core::nrs_policies
1169          */
1170         cfs_list_t                              pd_list;
1171         /**
1172          * NRS operations for this policy
1173          */
1174         const struct ptlrpc_nrs_pol_ops        *pd_ops;
1175         /**
1176          * Service compatibility predicate
1177          */
1178         nrs_pol_desc_compat_t                   pd_compat;
1179         /**
1180          * Set for policies that are compatible with only one PTLRPC service.
1181          *
1182          * \see ptlrpc_nrs_pol_conf::nc_compat_svc_name
1183          */
1184         const char                             *pd_compat_svc_name;
1185         /**
1186          * Owner module for this policy descriptor.
1187          *
1188          * We need to hold a reference to the module whenever we might make use
1189          * of any of the module's contents, i.e.
1190          * - If one or more instances of the policy are at a state where they
1191          *   might be handling a request, i.e.
1192          *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED or
1193          *   ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPING as we will have to
1194          *   call into the policy's ptlrpc_nrs_pol_ops() handlers. A reference
1195          *   is taken on the module when
1196          *   \e ptlrpc_nrs_pol_desc::pd_refs becomes 1, and released when it
1197          *   becomes 0, so that we hold only one reference to the module maximum
1198          *   at any time.
1199          *
1200          *   We do not need to hold a reference to the module, even though we
1201          *   might use code and data from the module, in the following cases:
1202          * - During external policy registration, because this should happen in
1203          *   the module's init() function, in which case the module is safe from
1204          *   removal because a reference is being held on the module by the
1205          *   kernel, and iirc kmod (and I guess module-init-tools also) will
1206          *   serialize any racing processes properly anyway.
1207          * - During external policy unregistration, because this should happen
1208          *   in a module's exit() function, and any attempts to start a policy
1209          *   instance would need to take a reference on the module, and this is
1210          *   not possible once we have reached the point where the exit()
1211          *   handler is called.
1212          * - During service registration and unregistration, as service setup
1213          *   and cleanup, and policy registration, unregistration and policy
1214          *   instance starting, are serialized by \e nrs_core::nrs_mutex, so
1215          *   as long as users adhere to the convention of registering policies
1216          *   in init() and unregistering them in module exit() functions, there
1217          *   should not be a race between these operations.
1218          * - During any policy-specific lprocfs operations, because a reference
1219          *   is held by the kernel on a proc entry that has been entered by a
1220          *   syscall, so as long as proc entries are removed during unregistration time,
1221          *   then unregistration and lprocfs operations will be properly
1222          *   serialized.
1223          */
1224         struct module                          *pd_owner;
1225         /**
1226          * Bitmask of \e nrs_policy_flags
1227          */
1228         unsigned                                pd_flags;
1229         /**
1230          * # of references on this descriptor
1231          */
1232         cfs_atomic_t                            pd_refs;
1233 };
1234
1235 /**
1236  * NRS policy state
1237  *
1238  * Policies transition from one state to the other during their lifetime
1239  */
1240 enum ptlrpc_nrs_pol_state {
1241         /**
1242          * Not a valid policy state.
1243          */
1244         NRS_POL_STATE_INVALID,
1245         /**
1246          * Policies are at this state either at the start of their life, or
1247          * transition here when the user selects a different policy to act
1248          * as the primary one.
1249          */
1250         NRS_POL_STATE_STOPPED,
1251         /**
1252          * Policy is progress of stopping
1253          */
1254         NRS_POL_STATE_STOPPING,
1255         /**
1256          * Policy is in progress of starting
1257          */
1258         NRS_POL_STATE_STARTING,
1259         /**
1260          * A policy is in this state in two cases:
1261          * - it is the fallback policy, which is always in this state.
1262          * - it has been activated by the user; i.e. it is the primary policy,
1263          */
1264         NRS_POL_STATE_STARTED,
1265 };
1266
1267 /**
1268  * NRS policy information
1269  *
1270  * Used for obtaining information for the status of a policy via lprocfs
1271  */
1272 struct ptlrpc_nrs_pol_info {
1273         /**
1274          * Policy name
1275          */
1276         char                            pi_name[NRS_POL_NAME_MAX];
1277         /**
1278          * Current policy state
1279          */
1280         enum ptlrpc_nrs_pol_state       pi_state;
1281         /**
1282          * # RPCs enqueued for later dispatching by the policy
1283          */
1284         long                            pi_req_queued;
1285         /**
1286          * # RPCs started for dispatch by the policy
1287          */
1288         long                            pi_req_started;
1289         /**
1290          * Is this a fallback policy?
1291          */
1292         unsigned                        pi_fallback:1;
1293 };
1294
1295 /**
1296  * NRS policy
1297  *
1298  * There is one instance of this for each policy in each NRS head of each
1299  * PTLRPC service partition.
1300  */
1301 struct ptlrpc_nrs_policy {
1302         /**
1303          * Linkage into the NRS head's list of policies,
1304          * ptlrpc_nrs:nrs_policy_list
1305          */
1306         cfs_list_t                      pol_list;
1307         /**
1308          * Linkage into the NRS head's list of policies with enqueued
1309          * requests ptlrpc_nrs:nrs_policy_queued
1310          */
1311         cfs_list_t                      pol_list_queued;
1312         /**
1313          * Current state of this policy
1314          */
1315         enum ptlrpc_nrs_pol_state       pol_state;
1316         /**
1317          * Bitmask of nrs_policy_flags
1318          */
1319         unsigned                        pol_flags;
1320         /**
1321          * # RPCs enqueued for later dispatching by the policy
1322          */
1323         long                            pol_req_queued;
1324         /**
1325          * # RPCs started for dispatch by the policy
1326          */
1327         long                            pol_req_started;
1328         /**
1329          * Usage Reference count taken on the policy instance
1330          */
1331         long                            pol_ref;
1332         /**
1333          * The NRS head this policy has been created at
1334          */
1335         struct ptlrpc_nrs              *pol_nrs;
1336         /**
1337          * Private policy data; varies by policy type
1338          */
1339         void                           *pol_private;
1340         /**
1341          * Policy descriptor for this policy instance.
1342          */
1343         struct ptlrpc_nrs_pol_desc     *pol_desc;
1344 };
1345
1346 /**
1347  * NRS resource
1348  *
1349  * Resources are embedded into two types of NRS entities:
1350  * - Inside NRS policies, in the policy's private data in
1351  *   ptlrpc_nrs_policy::pol_private
1352  * - In objects that act as prime-level scheduling entities in different NRS
1353  *   policies; e.g. on a policy that performs round robin or similar order
1354  *   scheduling across client NIDs, there would be one NRS resource per unique
1355  *   client NID. On a policy which performs round robin scheduling across
1356  *   backend filesystem objects, there would be one resource associated with
1357  *   each of the backend filesystem objects partaking in the scheduling
1358  *   performed by the policy.
1359  *
1360  * NRS resources share a parent-child relationship, in which resources embedded
1361  * in policy instances are the parent entities, with all scheduling entities
1362  * a policy schedules across being the children, thus forming a simple resource
1363  * hierarchy. This hierarchy may be extended with one or more levels in the
1364  * future if the ability to have more than one primary policy is added.
1365  *
1366  * Upon request initialization, references to the then active NRS policies are
1367  * taken and used to later handle the dispatching of the request with one of
1368  * these policies.
1369  *
1370  * \see nrs_resource_get_safe()
1371  * \see ptlrpc_nrs_req_add()
1372  */
1373 struct ptlrpc_nrs_resource {
1374         /**
1375          * This NRS resource's parent; is NULL for resources embedded in NRS
1376          * policy instances; i.e. those are top-level ones.
1377          */
1378         struct ptlrpc_nrs_resource     *res_parent;
1379         /**
1380          * The policy associated with this resource.
1381          */
1382         struct ptlrpc_nrs_policy       *res_policy;
1383 };
1384
1385 enum {
1386         NRS_RES_FALLBACK,
1387         NRS_RES_PRIMARY,
1388         NRS_RES_MAX
1389 };
1390
1391 /* \name fifo
1392  *
1393  * FIFO policy
1394  *
1395  * This policy is a logical wrapper around previous, non-NRS functionality.
1396  * It dispatches RPCs in the same order as they arrive from the network. This
1397  * policy is currently used as the fallback policy, and the only enabled policy
1398  * on all NRS heads of all PTLRPC service partitions.
1399  * @{
1400  */
1401
1402 /**
1403  * Private data structure for the FIFO policy
1404  */
1405 struct nrs_fifo_head {
1406         /**
1407          * Resource object for policy instance.
1408          */
1409         struct ptlrpc_nrs_resource      fh_res;
1410         /**
1411          * List of queued requests.
1412          */
1413         cfs_list_t                      fh_list;
1414         /**
1415          * For debugging purposes.
1416          */
1417         __u64                           fh_sequence;
1418 };
1419
1420 struct nrs_fifo_req {
1421         cfs_list_t              fr_list;
1422         __u64                   fr_sequence;
1423 };
1424
1425 /** @} fifo */
1426
1427 /**
1428  * \name CRR-N
1429  *
1430  * CRR-N, Client Round Robin over NIDs
1431  * @{
1432  */
1433
1434 /**
1435  * private data structure for CRR-N NRS
1436  */
1437 struct nrs_crrn_net {
1438         struct ptlrpc_nrs_resource      cn_res;
1439         cfs_binheap_t                  *cn_binheap;
1440         cfs_hash_t                     *cn_cli_hash;
1441         /**
1442          * Used when a new scheduling round commences, in order to synchronize
1443          * all clients with the new round number.
1444          */
1445         __u64                           cn_round;
1446         /**
1447          * Determines the relevant ordering amongst request batches within a
1448          * scheduling round.
1449          */
1450         __u64                           cn_sequence;
1451         /**
1452          * Round Robin quantum; the maximum number of RPCs that each request
1453          * batch for each client can have in a scheduling round.
1454          */
1455         __u16                           cn_quantum;
1456 };
1457
1458 /**
1459  * Object representing a client in CRR-N, as identified by its NID
1460  */
1461 struct nrs_crrn_client {
1462         struct ptlrpc_nrs_resource      cc_res;
1463         cfs_hlist_node_t                cc_hnode;
1464         lnet_nid_t                      cc_nid;
1465         /**
1466          * The round number against which this client is currently scheduling
1467          * requests.
1468          */
1469         __u64                           cc_round;
1470         /**
1471          * The sequence number used for requests scheduled by this client during
1472          * the current round number.
1473          */
1474         __u64                           cc_sequence;
1475         cfs_atomic_t                    cc_ref;
1476         /**
1477          * Round Robin quantum; the maximum number of RPCs the client is allowed
1478          * to schedule in a single batch of each round.
1479          */
1480         __u16                           cc_quantum;
1481         /**
1482          * # of pending requests for this client, on all existing rounds
1483          */
1484         __u16                           cc_active;
1485 };
1486
1487 /**
1488  * CRR-N NRS request definition
1489  */
1490 struct nrs_crrn_req {
1491         /**
1492          * Round number for this request; shared with all other requests in the
1493          * same batch.
1494          */
1495         __u64                   cr_round;
1496         /**
1497          * Sequence number for this request; shared with all other requests in
1498          * the same batch.
1499          */
1500         __u64                   cr_sequence;
1501 };
1502
1503 /**
1504  * CRR-N policy operations.
1505  */
1506 enum nrs_ctl_crr {
1507         /**
1508          * Read the RR quantum size of a CRR-N policy.
1509          */
1510         NRS_CTL_CRRN_RD_QUANTUM = PTLRPC_NRS_CTL_1ST_POL_SPEC,
1511         /**
1512          * Write the RR quantum size of a CRR-N policy.
1513          */
1514         NRS_CTL_CRRN_WR_QUANTUM,
1515 };
1516
1517 /** @} CRR-N */
1518
1519 /**
1520  * \name ORR/TRR
1521  *
1522  * ORR/TRR (Object-based Round Robin/Target-based Round Robin) NRS policies
1523  * @{
1524  */
1525
1526 /**
1527  * Lower and upper byte offsets of a brw RPC
1528  */
1529 struct nrs_orr_req_range {
1530         __u64           or_start;
1531         __u64           or_end;
1532 };
1533
1534 /**
1535  * RPC types supported by the ORR/TRR policies
1536  */
1537 enum nrs_orr_supp {
1538         NOS_OST_READ  = (1 << 0),
1539         NOS_OST_WRITE = (1 << 1),
1540         NOS_OST_RW    = (NOS_OST_READ | NOS_OST_WRITE),
1541         /**
1542          * Default value for policies.
1543          */
1544         NOS_DFLT      = NOS_OST_READ
1545 };
1546
1547 /**
1548  * As unique keys for grouping RPCs together, we use the object's OST FID for
1549  * the ORR policy, and the OST index for the TRR policy.
1550  *
1551  * XXX: We waste some space for TRR policy instances by using a union, but it
1552  *      allows to consolidate some of the code between ORR and TRR, and these
1553  *      policies will probably eventually merge into one anyway.
1554  */
1555 struct nrs_orr_key {
1556         union {
1557                 /** object FID for ORR */
1558                 struct lu_fid   ok_fid;
1559                 /** OST index for TRR */
1560                 __u32           ok_idx;
1561         };
1562 };
1563
1564 /**
1565  * The largest base string for unique hash/slab object names is
1566  * "nrs_orr_reg_", so 13 characters. We add 3 to this to be used for the CPT
1567  * id number, so this _should_ be more than enough for the maximum number of
1568  * CPTs on any system. If it does happen that this statement is incorrect,
1569  * nrs_orr_genobjname() will inevitably yield a non-unique name and cause
1570  * kmem_cache_create() to complain (on Linux), so the erroneous situation
1571  * will hopefully not go unnoticed.
1572  */
1573 #define NRS_ORR_OBJ_NAME_MAX    (sizeof("nrs_orr_reg_") + 3)
1574
1575 /**
1576  * private data structure for ORR and TRR NRS
1577  */
1578 struct nrs_orr_data {
1579         struct ptlrpc_nrs_resource      od_res;
1580         cfs_binheap_t                  *od_binheap;
1581         cfs_hash_t                     *od_obj_hash;
1582         struct kmem_cache              *od_cache;
1583         /**
1584          * Used when a new scheduling round commences, in order to synchronize
1585          * all object or OST batches with the new round number.
1586          */
1587         __u64                           od_round;
1588         /**
1589          * Determines the relevant ordering amongst request batches within a
1590          * scheduling round.
1591          */
1592         __u64                           od_sequence;
1593         /**
1594          * RPC types that are currently supported.
1595          */
1596         enum nrs_orr_supp               od_supp;
1597         /**
1598          * Round Robin quantum; the maxium number of RPCs that each request
1599          * batch for each object or OST can have in a scheduling round.
1600          */
1601         __u16                           od_quantum;
1602         /**
1603          * Whether to use physical disk offsets or logical file offsets.
1604          */
1605         bool                            od_physical;
1606         /**
1607          * XXX: We need to provide a persistently allocated string to hold
1608          * unique object names for this policy, since in currently supported
1609          * versions of Linux by Lustre, kmem_cache_create() just sets a pointer
1610          * to the name string provided. kstrdup() is used in the version of
1611          * kmeme_cache_create() in current Linux mainline, so we may be able to
1612          * remove this in the future.
1613          */
1614         char                            od_objname[NRS_ORR_OBJ_NAME_MAX];
1615 };
1616
1617 /**
1618  * Represents a backend-fs object or OST in the ORR and TRR policies
1619  * respectively
1620  */
1621 struct nrs_orr_object {
1622         struct ptlrpc_nrs_resource      oo_res;
1623         cfs_hlist_node_t                oo_hnode;
1624         /**
1625          * The round number against which requests are being scheduled for this
1626          * object or OST
1627          */
1628         __u64                           oo_round;
1629         /**
1630          * The sequence number used for requests scheduled for this object or
1631          * OST during the current round number.
1632          */
1633         __u64                           oo_sequence;
1634         /**
1635          * The key of the object or OST for which this structure instance is
1636          * scheduling RPCs
1637          */
1638         struct nrs_orr_key              oo_key;
1639         long                            oo_ref;
1640         /**
1641          * Round Robin quantum; the maximum number of RPCs that are allowed to
1642          * be scheduled for the object or OST in a single batch of each round.
1643          */
1644         __u16                           oo_quantum;
1645         /**
1646          * # of pending requests for this object or OST, on all existing rounds
1647          */
1648         __u16                           oo_active;
1649 };
1650
1651 /**
1652  * ORR/TRR NRS request definition
1653  */
1654 struct nrs_orr_req {
1655         /**
1656          * The offset range this request covers
1657          */
1658         struct nrs_orr_req_range        or_range;
1659         /**
1660          * Round number for this request; shared with all other requests in the
1661          * same batch.
1662          */
1663         __u64                           or_round;
1664         /**
1665          * Sequence number for this request; shared with all other requests in
1666          * the same batch.
1667          */
1668         __u64                           or_sequence;
1669         /**
1670          * For debugging purposes.
1671          */
1672         struct nrs_orr_key              or_key;
1673         /**
1674          * An ORR policy instance has filled in request information while
1675          * enqueueing the request on the service partition's regular NRS head.
1676          */
1677         unsigned int                    or_orr_set:1;
1678         /**
1679          * A TRR policy instance has filled in request information while
1680          * enqueueing the request on the service partition's regular NRS head.
1681          */
1682         unsigned int                    or_trr_set:1;
1683         /**
1684          * Request offset ranges have been filled in with logical offset
1685          * values.
1686          */
1687         unsigned int                    or_logical_set:1;
1688         /**
1689          * Request offset ranges have been filled in with physical offset
1690          * values.
1691          */
1692         unsigned int                    or_physical_set:1;
1693 };
1694
1695 /** @} ORR/TRR */
1696
1697 /**
1698  * NRS request
1699  *
1700  * Instances of this object exist embedded within ptlrpc_request; the main
1701  * purpose of this object is to hold references to the request's resources
1702  * for the lifetime of the request, and to hold properties that policies use
1703  * use for determining the request's scheduling priority.
1704  * */
1705 struct ptlrpc_nrs_request {
1706         /**
1707          * The request's resource hierarchy.
1708          */
1709         struct ptlrpc_nrs_resource     *nr_res_ptrs[NRS_RES_MAX];
1710         /**
1711          * Index into ptlrpc_nrs_request::nr_res_ptrs of the resource of the
1712          * policy that was used to enqueue the request.
1713          *
1714          * \see nrs_request_enqueue()
1715          */
1716         unsigned                        nr_res_idx;
1717         unsigned                        nr_initialized:1;
1718         unsigned                        nr_enqueued:1;
1719         unsigned                        nr_started:1;
1720         unsigned                        nr_finalized:1;
1721         cfs_binheap_node_t              nr_node;
1722
1723         /**
1724          * Policy-specific fields, used for determining a request's scheduling
1725          * priority, and other supporting functionality.
1726          */
1727         union {
1728                 /**
1729                  * Fields for the FIFO policy
1730                  */
1731                 struct nrs_fifo_req     fifo;
1732                 /**
1733                  * CRR-N request defintion
1734                  */
1735                 struct nrs_crrn_req     crr;
1736                 /** ORR and TRR share the same request definition */
1737                 struct nrs_orr_req      orr;
1738         } nr_u;
1739         /**
1740          * Externally-registering policies may want to use this to allocate
1741          * their own request properties.
1742          */
1743         void                           *ext;
1744 };
1745
1746 /** @} nrs */
1747
1748 /**
1749  * Basic request prioritization operations structure.
1750  * The whole idea is centered around locks and RPCs that might affect locks.
1751  * When a lock is contended we try to give priority to RPCs that might lead
1752  * to fastest release of that lock.
1753  * Currently only implemented for OSTs only in a way that makes all
1754  * IO and truncate RPCs that are coming from a locked region where a lock is
1755  * contended a priority over other requests.
1756  */
1757 struct ptlrpc_hpreq_ops {
1758         /**
1759          * Check if the lock handle of the given lock is the same as
1760          * taken from the request.
1761          */
1762         int  (*hpreq_lock_match)(struct ptlrpc_request *, struct ldlm_lock *);
1763         /**
1764          * Check if the request is a high priority one.
1765          */
1766         int  (*hpreq_check)(struct ptlrpc_request *);
1767         /**
1768          * Called after the request has been handled.
1769          */
1770         void (*hpreq_fini)(struct ptlrpc_request *);
1771 };
1772
1773 /**
1774  * Represents remote procedure call.
1775  *
1776  * This is a staple structure used by everybody wanting to send a request
1777  * in Lustre.
1778  */
1779 struct ptlrpc_request {
1780         /* Request type: one of PTL_RPC_MSG_* */
1781         int rq_type;
1782         /** Result of request processing */
1783         int rq_status;
1784         /**
1785          * Linkage item through which this request is included into
1786          * sending/delayed lists on client and into rqbd list on server
1787          */
1788         cfs_list_t rq_list;
1789         /**
1790          * Server side list of incoming unserved requests sorted by arrival
1791          * time.  Traversed from time to time to notice about to expire
1792          * requests and sent back "early replies" to clients to let them
1793          * know server is alive and well, just very busy to service their
1794          * requests in time
1795          */
1796         cfs_list_t rq_timed_list;
1797         /** server-side history, used for debuging purposes. */
1798         cfs_list_t rq_history_list;
1799         /** server-side per-export list */
1800         cfs_list_t rq_exp_list;
1801         /** server-side hp handlers */
1802         struct ptlrpc_hpreq_ops *rq_ops;
1803
1804         /** initial thread servicing this request */
1805         struct ptlrpc_thread *rq_svc_thread;
1806
1807         /** history sequence # */
1808         __u64 rq_history_seq;
1809         /** \addtogroup  nrs
1810          * @{
1811          */
1812         /** stub for NRS request */
1813         struct ptlrpc_nrs_request rq_nrq;
1814         /** @} nrs */
1815         /** the index of service's srv_at_array into which request is linked */
1816         time_t rq_at_index;
1817         /** Lock to protect request flags and some other important bits, like
1818          * rq_list
1819          */
1820         spinlock_t rq_lock;
1821         /** client-side flags are serialized by rq_lock */
1822         unsigned int rq_intr:1, rq_replied:1, rq_err:1,
1823                 rq_timedout:1, rq_resend:1, rq_restart:1,
1824                 /**
1825                  * when ->rq_replay is set, request is kept by the client even
1826                  * after server commits corresponding transaction. This is
1827                  * used for operations that require sequence of multiple
1828                  * requests to be replayed. The only example currently is file
1829                  * open/close. When last request in such a sequence is
1830                  * committed, ->rq_replay is cleared on all requests in the
1831                  * sequence.
1832                  */
1833                 rq_replay:1,
1834                 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
1835                 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
1836                 rq_early:1, rq_must_unlink:1,
1837                 rq_memalloc:1,      /* req originated from "kswapd" */
1838                 /* server-side flags */
1839                 rq_packed_final:1,  /* packed final reply */
1840                 rq_hp:1,            /* high priority RPC */
1841                 rq_at_linked:1,     /* link into service's srv_at_array */
1842                 rq_reply_truncate:1,
1843                 rq_committed:1,
1844                 /* whether the "rq_set" is a valid one */
1845                 rq_invalid_rqset:1,
1846                 rq_generation_set:1,
1847                 /* do not resend request on -EINPROGRESS */
1848                 rq_no_retry_einprogress:1,
1849                 /* allow the req to be sent if the import is in recovery
1850                  * status */
1851                 rq_allow_replay:1,
1852                 /* bulk request, sent to server, but uncommitted */
1853                 rq_unstable:1;
1854
1855         unsigned int rq_nr_resend;
1856
1857         enum rq_phase rq_phase; /* one of RQ_PHASE_* */
1858         enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */
1859         cfs_atomic_t rq_refcount;/* client-side refcount for SENT race,
1860                                     server-side refcounf for multiple replies */
1861
1862         /** Portal to which this request would be sent */
1863         short rq_request_portal;  /* XXX FIXME bug 249 */
1864         /** Portal where to wait for reply and where reply would be sent */
1865         short rq_reply_portal;    /* XXX FIXME bug 249 */
1866
1867         /**
1868          * client-side:
1869          * !rq_truncate : # reply bytes actually received,
1870          *  rq_truncate : required repbuf_len for resend
1871          */
1872         int rq_nob_received;
1873         /** Request length */
1874         int rq_reqlen;
1875         /** Reply length */
1876         int rq_replen;
1877         /** Request message - what client sent */
1878         struct lustre_msg *rq_reqmsg;
1879         /** Reply message - server response */
1880         struct lustre_msg *rq_repmsg;
1881         /** Transaction number */
1882         __u64 rq_transno;
1883         /** xid */
1884         __u64 rq_xid;
1885         /**
1886          * List item to for replay list. Not yet commited requests get linked
1887          * there.
1888          * Also see \a rq_replay comment above.
1889          */
1890         cfs_list_t rq_replay_list;
1891
1892         /**
1893          * security and encryption data
1894          * @{ */
1895         struct ptlrpc_cli_ctx   *rq_cli_ctx;     /**< client's half ctx */
1896         struct ptlrpc_svc_ctx   *rq_svc_ctx;     /**< server's half ctx */
1897         cfs_list_t               rq_ctx_chain;   /**< link to waited ctx */
1898
1899         struct sptlrpc_flavor    rq_flvr;        /**< for client & server */
1900         enum lustre_sec_part     rq_sp_from;
1901
1902         /* client/server security flags */
1903         unsigned int
1904                                  rq_ctx_init:1,      /* context initiation */
1905                                  rq_ctx_fini:1,      /* context destroy */
1906                                  rq_bulk_read:1,     /* request bulk read */
1907                                  rq_bulk_write:1,    /* request bulk write */
1908                                  /* server authentication flags */
1909                                  rq_auth_gss:1,      /* authenticated by gss */
1910                                  rq_auth_remote:1,   /* authed as remote user */
1911                                  rq_auth_usr_root:1, /* authed as root */
1912                                  rq_auth_usr_mdt:1,  /* authed as mdt */
1913                                  rq_auth_usr_ost:1,  /* authed as ost */
1914                                  /* security tfm flags */
1915                                  rq_pack_udesc:1,
1916                                  rq_pack_bulk:1,
1917                                  /* doesn't expect reply FIXME */
1918                                  rq_no_reply:1,
1919                                  rq_pill_init:1;     /* pill initialized */
1920
1921         uid_t                    rq_auth_uid;        /* authed uid */
1922         uid_t                    rq_auth_mapped_uid; /* authed uid mapped to */
1923
1924         /* (server side), pointed directly into req buffer */
1925         struct ptlrpc_user_desc *rq_user_desc;
1926
1927         /* various buffer pointers */
1928         struct lustre_msg       *rq_reqbuf;      /* req wrapper */
1929         char                    *rq_repbuf;      /* rep buffer */
1930         struct lustre_msg       *rq_repdata;     /* rep wrapper msg */
1931         struct lustre_msg       *rq_clrbuf;      /* only in priv mode */
1932         int                      rq_reqbuf_len;  /* req wrapper buf len */
1933         int                      rq_reqdata_len; /* req wrapper msg len */
1934         int                      rq_repbuf_len;  /* rep buffer len */
1935         int                      rq_repdata_len; /* rep wrapper msg len */
1936         int                      rq_clrbuf_len;  /* only in priv mode */
1937         int                      rq_clrdata_len; /* only in priv mode */
1938
1939         /** early replies go to offset 0, regular replies go after that */
1940         unsigned int             rq_reply_off;
1941
1942         /** @} */
1943
1944         /** Fields that help to see if request and reply were swabbed or not */
1945         __u32 rq_req_swab_mask;
1946         __u32 rq_rep_swab_mask;
1947
1948         /** What was import generation when this request was sent */
1949         int rq_import_generation;
1950         enum lustre_imp_state rq_send_state;
1951
1952         /** how many early replies (for stats) */
1953         int rq_early_count;
1954
1955         /** client+server request */
1956         lnet_handle_md_t     rq_req_md_h;
1957         struct ptlrpc_cb_id  rq_req_cbid;
1958         /** optional time limit for send attempts */
1959         cfs_duration_t       rq_delay_limit;
1960         /** time request was first queued */
1961         cfs_time_t           rq_queued_time;
1962
1963         /* server-side... */
1964         /** request arrival time */
1965         struct timeval       rq_arrival_time;
1966         /** separated reply state */
1967         struct ptlrpc_reply_state *rq_reply_state;
1968         /** incoming request buffer */
1969         struct ptlrpc_request_buffer_desc *rq_rqbd;
1970
1971         /** client-only incoming reply */
1972         lnet_handle_md_t     rq_reply_md_h;
1973         wait_queue_head_t    rq_reply_waitq;
1974         struct ptlrpc_cb_id  rq_reply_cbid;
1975
1976         /** our LNet NID */
1977         lnet_nid_t           rq_self;
1978         /** Peer description (the other side) */
1979         lnet_process_id_t    rq_peer;
1980         /** Server-side, export on which request was received */
1981         struct obd_export   *rq_export;
1982         /** Client side, import where request is being sent */
1983         struct obd_import   *rq_import;
1984
1985         /** Replay callback, called after request is replayed at recovery */
1986         void (*rq_replay_cb)(struct ptlrpc_request *);
1987         /**
1988          * Commit callback, called when request is committed and about to be
1989          * freed.
1990          */
1991         void (*rq_commit_cb)(struct ptlrpc_request *);
1992         /** Opaq data for replay and commit callbacks. */
1993         void  *rq_cb_data;
1994
1995         /** For bulk requests on client only: bulk descriptor */
1996         struct ptlrpc_bulk_desc *rq_bulk;
1997
1998         /** client outgoing req */
1999         /**
2000          * when request/reply sent (secs), or time when request should be sent
2001          */
2002         time_t rq_sent;
2003         /** time for request really sent out */
2004         time_t rq_real_sent;
2005
2006         /** when request must finish. volatile
2007          * so that servers' early reply updates to the deadline aren't
2008          * kept in per-cpu cache */
2009         volatile time_t rq_deadline;
2010         /** when req reply unlink must finish. */
2011         time_t rq_reply_deadline;
2012         /** when req bulk unlink must finish. */
2013         time_t rq_bulk_deadline;
2014         /**
2015          * service time estimate (secs) 
2016          * If the requestsis not served by this time, it is marked as timed out.
2017          */
2018         int    rq_timeout;
2019
2020         /** Multi-rpc bits */
2021         /** Per-request waitq introduced by bug 21938 for recovery waiting */
2022         wait_queue_head_t rq_set_waitq;
2023         /** Link item for request set lists */
2024         cfs_list_t  rq_set_chain;
2025         /** Link back to the request set */
2026         struct ptlrpc_request_set *rq_set;
2027         /** Async completion handler, called when reply is received */
2028         ptlrpc_interpterer_t rq_interpret_reply;
2029         /** Async completion context */
2030         union ptlrpc_async_args rq_async_args;
2031
2032         /** Pool if request is from preallocated list */
2033         struct ptlrpc_request_pool *rq_pool;
2034
2035         struct lu_context           rq_session;
2036         struct lu_context           rq_recov_session;
2037
2038         /** request format description */
2039         struct req_capsule          rq_pill;
2040 };
2041
2042 /**
2043  * Call completion handler for rpc if any, return it's status or original
2044  * rc if there was no handler defined for this request.
2045  */
2046 static inline int ptlrpc_req_interpret(const struct lu_env *env,
2047                                        struct ptlrpc_request *req, int rc)
2048 {
2049         if (req->rq_interpret_reply != NULL) {
2050                 req->rq_status = req->rq_interpret_reply(env, req,
2051                                                          &req->rq_async_args,
2052                                                          rc);
2053                 return req->rq_status;
2054         }
2055         return rc;
2056 }
2057
2058 /** \addtogroup  nrs
2059  * @{
2060  */
2061 int ptlrpc_nrs_policy_register(struct ptlrpc_nrs_pol_conf *conf);
2062 int ptlrpc_nrs_policy_unregister(struct ptlrpc_nrs_pol_conf *conf);
2063 void ptlrpc_nrs_req_hp_move(struct ptlrpc_request *req);
2064 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
2065                                 struct ptlrpc_nrs_pol_info *info);
2066
2067 /*
2068  * Can the request be moved from the regular NRS head to the high-priority NRS
2069  * head (of the same PTLRPC service partition), if any?
2070  *
2071  * For a reliable result, this should be checked under svcpt->scp_req lock.
2072  */
2073 static inline bool ptlrpc_nrs_req_can_move(struct ptlrpc_request *req)
2074 {
2075         struct ptlrpc_nrs_request *nrq = &req->rq_nrq;
2076
2077         /**
2078          * LU-898: Check ptlrpc_nrs_request::nr_enqueued to make sure the
2079          * request has been enqueued first, and ptlrpc_nrs_request::nr_started
2080          * to make sure it has not been scheduled yet (analogous to previous
2081          * (non-NRS) checking of !list_empty(&ptlrpc_request::rq_list).
2082          */
2083         return nrq->nr_enqueued && !nrq->nr_started && !req->rq_hp;
2084 }
2085 /** @} nrs */
2086
2087 /**
2088  * Returns 1 if request buffer at offset \a index was already swabbed
2089  */
2090 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
2091 {
2092         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
2093         return req->rq_req_swab_mask & (1 << index);
2094 }
2095
2096 /**
2097  * Returns 1 if request reply buffer at offset \a index was already swabbed
2098  */
2099 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
2100 {
2101         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
2102         return req->rq_rep_swab_mask & (1 << index);
2103 }
2104
2105 /**
2106  * Returns 1 if request needs to be swabbed into local cpu byteorder
2107  */
2108 static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req)
2109 {
2110         return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
2111 }
2112
2113 /**
2114  * Returns 1 if request reply needs to be swabbed into local cpu byteorder
2115  */
2116 static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req)
2117 {
2118         return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
2119 }
2120
2121 /**
2122  * Mark request buffer at offset \a index that it was already swabbed
2123  */
2124 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
2125 {
2126         LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
2127         LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
2128         req->rq_req_swab_mask |= 1 << index;
2129 }
2130
2131 /**
2132  * Mark request reply buffer at offset \a index that it was already swabbed
2133  */
2134 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
2135 {
2136         LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
2137         LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
2138         req->rq_rep_swab_mask |= 1 << index;
2139 }
2140
2141 /**
2142  * Convert numerical request phase value \a phase into text string description
2143  */
2144 static inline const char *
2145 ptlrpc_phase2str(enum rq_phase phase)
2146 {
2147         switch (phase) {
2148         case RQ_PHASE_NEW:
2149                 return "New";
2150         case RQ_PHASE_RPC:
2151                 return "Rpc";
2152         case RQ_PHASE_BULK:
2153                 return "Bulk";
2154         case RQ_PHASE_INTERPRET:
2155                 return "Interpret";
2156         case RQ_PHASE_COMPLETE:
2157                 return "Complete";
2158         case RQ_PHASE_UNREGISTERING:
2159                 return "Unregistering";
2160         default:
2161                 return "?Phase?";
2162         }
2163 }
2164
2165 /**
2166  * Convert numerical request phase of the request \a req into text stringi
2167  * description
2168  */
2169 static inline const char *
2170 ptlrpc_rqphase2str(struct ptlrpc_request *req)
2171 {
2172         return ptlrpc_phase2str(req->rq_phase);
2173 }
2174
2175 /**
2176  * Debugging functions and helpers to print request structure into debug log
2177  * @{
2178  */ 
2179 /* Spare the preprocessor, spoil the bugs. */
2180 #define FLAG(field, str) (field ? str : "")
2181
2182 /** Convert bit flags into a string */
2183 #define DEBUG_REQ_FLAGS(req)                                                    \
2184         ptlrpc_rqphase2str(req),                                                \
2185         FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"),                    \
2186         FLAG(req->rq_err, "E"),                                                 \
2187         FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"),   \
2188         FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"),                  \
2189         FLAG(req->rq_no_resend, "N"),                                           \
2190         FLAG(req->rq_waiting, "W"),                                             \
2191         FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"),                     \
2192         FLAG(req->rq_committed, "M")
2193
2194 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s"
2195
2196 void _debug_req(struct ptlrpc_request *req,
2197                 struct libcfs_debug_msg_data *data, const char *fmt, ...)
2198         __attribute__ ((format (printf, 3, 4)));
2199
2200 /**
2201  * Helper that decides if we need to print request accordig to current debug
2202  * level settings
2203  */
2204 #define debug_req(msgdata, mask, cdls, req, fmt, a...)                        \
2205 do {                                                                          \
2206         CFS_CHECK_STACK(msgdata, mask, cdls);                                 \
2207                                                                               \
2208         if (((mask) & D_CANTMASK) != 0 ||                                     \
2209             ((libcfs_debug & (mask)) != 0 &&                                  \
2210              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
2211                 _debug_req((req), msgdata, fmt, ##a);                         \
2212 } while(0)
2213
2214 /**
2215  * This is the debug print function you need to use to print request sturucture
2216  * content into lustre debug log.
2217  * for most callers (level is a constant) this is resolved at compile time */
2218 #define DEBUG_REQ(level, req, fmt, args...)                                   \
2219 do {                                                                          \
2220         if ((level) & (D_ERROR | D_WARNING)) {                                \
2221                 static cfs_debug_limit_state_t cdls;                          \
2222                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls);            \
2223                 debug_req(&msgdata, level, &cdls, req, "@@@ "fmt" ", ## args);\
2224         } else {                                                              \
2225                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL);             \
2226                 debug_req(&msgdata, level, NULL, req, "@@@ "fmt" ", ## args); \
2227         }                                                                     \
2228 } while (0)
2229 /** @} */
2230
2231 /**
2232  * Structure that defines a single page of a bulk transfer
2233  */
2234 struct ptlrpc_bulk_page {
2235         /** Linkage to list of pages in a bulk */
2236         cfs_list_t       bp_link;
2237         /**
2238          * Number of bytes in a page to transfer starting from \a bp_pageoffset
2239          */
2240         int              bp_buflen;
2241         /** offset within a page */
2242         int              bp_pageoffset;
2243         /** The page itself */
2244         struct page     *bp_page;
2245 };
2246
2247 #define BULK_GET_SOURCE   0
2248 #define BULK_PUT_SINK     1
2249 #define BULK_GET_SINK     2
2250 #define BULK_PUT_SOURCE   3
2251
2252 /**
2253  * Definition of bulk descriptor.
2254  * Bulks are special "Two phase" RPCs where initial request message
2255  * is sent first and it is followed bt a transfer (o receiving) of a large
2256  * amount of data to be settled into pages referenced from the bulk descriptors.
2257  * Bulks transfers (the actual data following the small requests) are done
2258  * on separate LNet portals.
2259  * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs.
2260  *  Another user is readpage for MDT.
2261  */
2262 struct ptlrpc_bulk_desc {
2263         /** completed with failure */
2264         unsigned long bd_failure:1;
2265         /** {put,get}{source,sink} */
2266         unsigned long bd_type:2;
2267         /** client side */
2268         unsigned long bd_registered:1;
2269         /** For serialization with callback */
2270         spinlock_t bd_lock;
2271         /** Import generation when request for this bulk was sent */
2272         int bd_import_generation;
2273         /** LNet portal for this bulk */
2274         __u32 bd_portal;
2275         /** Server side - export this bulk created for */
2276         struct obd_export *bd_export;
2277         /** Client side - import this bulk was sent on */
2278         struct obd_import *bd_import;
2279         /** Back pointer to the request */
2280         struct ptlrpc_request *bd_req;
2281         wait_queue_head_t      bd_waitq;        /* server side only WQ */
2282         int                    bd_iov_count;    /* # entries in bd_iov */
2283         int                    bd_max_iov;      /* allocated size of bd_iov */
2284         int                    bd_nob;          /* # bytes covered */
2285         int                    bd_nob_transferred; /* # bytes GOT/PUT */
2286
2287         __u64                  bd_last_xid;
2288
2289         struct ptlrpc_cb_id    bd_cbid;         /* network callback info */
2290         lnet_nid_t             bd_sender;       /* stash event::sender */
2291         int                     bd_md_count;    /* # valid entries in bd_mds */
2292         int                     bd_md_max_brw;  /* max entries in bd_mds */
2293         /** array of associated MDs */
2294         lnet_handle_md_t        bd_mds[PTLRPC_BULK_OPS_COUNT];
2295
2296 #if defined(__KERNEL__)
2297         /*
2298          * encrypt iov, size is either 0 or bd_iov_count.
2299          */
2300         lnet_kiov_t           *bd_enc_iov;
2301
2302         lnet_kiov_t            bd_iov[0];
2303 #else
2304         lnet_md_iovec_t        bd_iov[0];
2305 #endif
2306 };
2307
2308 enum {
2309         SVC_STOPPED     = 1 << 0,
2310         SVC_STOPPING    = 1 << 1,
2311         SVC_STARTING    = 1 << 2,
2312         SVC_RUNNING     = 1 << 3,
2313         SVC_EVENT       = 1 << 4,
2314         SVC_SIGNAL      = 1 << 5,
2315 };
2316
2317 #define PTLRPC_THR_NAME_LEN             32
2318 /**
2319  * Definition of server service thread structure
2320  */
2321 struct ptlrpc_thread {
2322         /**
2323          * List of active threads in svc->srv_threads
2324          */
2325         cfs_list_t t_link;
2326         /**
2327          * thread-private data (preallocated memory)
2328          */
2329         void *t_data;
2330         __u32 t_flags;
2331         /**
2332          * service thread index, from ptlrpc_start_threads
2333          */
2334         unsigned int t_id;
2335         /**
2336          * service thread pid
2337          */
2338         pid_t t_pid; 
2339         /**
2340          * put watchdog in the structure per thread b=14840
2341          */
2342         struct lc_watchdog *t_watchdog;
2343         /**
2344          * the svc this thread belonged to b=18582
2345          */
2346         struct ptlrpc_service_part      *t_svcpt;
2347         wait_queue_head_t               t_ctl_waitq;
2348         struct lu_env                   *t_env;
2349         char                            t_name[PTLRPC_THR_NAME_LEN];
2350 };
2351
2352 static inline int thread_is_init(struct ptlrpc_thread *thread)
2353 {
2354         return thread->t_flags == 0;
2355 }
2356
2357 static inline int thread_is_stopped(struct ptlrpc_thread *thread)
2358 {
2359         return !!(thread->t_flags & SVC_STOPPED);
2360 }
2361
2362 static inline int thread_is_stopping(struct ptlrpc_thread *thread)
2363 {
2364         return !!(thread->t_flags & SVC_STOPPING);
2365 }
2366
2367 static inline int thread_is_starting(struct ptlrpc_thread *thread)
2368 {
2369         return !!(thread->t_flags & SVC_STARTING);
2370 }
2371
2372 static inline int thread_is_running(struct ptlrpc_thread *thread)
2373 {
2374         return !!(thread->t_flags & SVC_RUNNING);
2375 }
2376
2377 static inline int thread_is_event(struct ptlrpc_thread *thread)
2378 {
2379         return !!(thread->t_flags & SVC_EVENT);
2380 }
2381
2382 static inline int thread_is_signal(struct ptlrpc_thread *thread)
2383 {
2384         return !!(thread->t_flags & SVC_SIGNAL);
2385 }
2386
2387 static inline void thread_clear_flags(struct ptlrpc_thread *thread, __u32 flags)
2388 {
2389         thread->t_flags &= ~flags;
2390 }
2391
2392 static inline void thread_set_flags(struct ptlrpc_thread *thread, __u32 flags)
2393 {
2394         thread->t_flags = flags;
2395 }
2396
2397 static inline void thread_add_flags(struct ptlrpc_thread *thread, __u32 flags)
2398 {
2399         thread->t_flags |= flags;
2400 }
2401
2402 static inline int thread_test_and_clear_flags(struct ptlrpc_thread *thread,
2403                                               __u32 flags)
2404 {
2405         if (thread->t_flags & flags) {
2406                 thread->t_flags &= ~flags;
2407                 return 1;
2408         }
2409         return 0;
2410 }
2411
2412 /**
2413  * Request buffer descriptor structure.
2414  * This is a structure that contains one posted request buffer for service.
2415  * Once data land into a buffer, event callback creates actual request and
2416  * notifies wakes one of the service threads to process new incoming request.
2417  * More than one request can fit into the buffer.
2418  */
2419 struct ptlrpc_request_buffer_desc {
2420         /** Link item for rqbds on a service */
2421         cfs_list_t             rqbd_list;
2422         /** History of requests for this buffer */
2423         cfs_list_t             rqbd_reqs;
2424         /** Back pointer to service for which this buffer is registered */
2425         struct ptlrpc_service_part *rqbd_svcpt;
2426         /** LNet descriptor */
2427         lnet_handle_md_t       rqbd_md_h;
2428         int                    rqbd_refcount;
2429         /** The buffer itself */
2430         char                  *rqbd_buffer;
2431         struct ptlrpc_cb_id    rqbd_cbid;
2432         /**
2433          * This "embedded" request structure is only used for the
2434          * last request to fit into the buffer
2435          */
2436         struct ptlrpc_request  rqbd_req;
2437 };
2438
2439 typedef int  (*svc_handler_t)(struct ptlrpc_request *req);
2440
2441 struct ptlrpc_service_ops {
2442         /**
2443          * if non-NULL called during thread creation (ptlrpc_start_thread())
2444          * to initialize service specific per-thread state.
2445          */
2446         int             (*so_thr_init)(struct ptlrpc_thread *thr);
2447         /**
2448          * if non-NULL called during thread shutdown (ptlrpc_main()) to
2449          * destruct state created by ->srv_init().
2450          */
2451         void            (*so_thr_done)(struct ptlrpc_thread *thr);
2452         /**
2453          * Handler function for incoming requests for this service
2454          */
2455         int             (*so_req_handler)(struct ptlrpc_request *req);
2456         /**
2457          * function to determine priority of the request, it's called
2458          * on every new request
2459          */
2460         int             (*so_hpreq_handler)(struct ptlrpc_request *);
2461         /**
2462          * service-specific print fn
2463          */
2464         void            (*so_req_printer)(void *, struct ptlrpc_request *);
2465 };
2466
2467 #ifndef __cfs_cacheline_aligned
2468 /* NB: put it here for reducing patche dependence */
2469 # define __cfs_cacheline_aligned
2470 #endif
2471
2472 /**
2473  * How many high priority requests to serve before serving one normal
2474  * priority request
2475  */
2476 #define PTLRPC_SVC_HP_RATIO 10
2477
2478 /**
2479  * Definition of PortalRPC service.
2480  * The service is listening on a particular portal (like tcp port)
2481  * and perform actions for a specific server like IO service for OST
2482  * or general metadata service for MDS.
2483  */
2484 struct ptlrpc_service {
2485         /** serialize /proc operations */
2486         spinlock_t                      srv_lock;
2487         /** most often accessed fields */
2488         /** chain thru all services */
2489         cfs_list_t                      srv_list;
2490         /** service operations table */
2491         struct ptlrpc_service_ops       srv_ops;
2492         /** only statically allocated strings here; we don't clean them */
2493         char                           *srv_name;
2494         /** only statically allocated strings here; we don't clean them */
2495         char                           *srv_thread_name;
2496         /** service thread list */
2497         cfs_list_t                      srv_threads;
2498         /** threads # should be created for each partition on initializing */
2499         int                             srv_nthrs_cpt_init;
2500         /** limit of threads number for each partition */
2501         int                             srv_nthrs_cpt_limit;
2502         /** Root of /proc dir tree for this service */
2503         cfs_proc_dir_entry_t           *srv_procroot;
2504         /** Pointer to statistic data for this service */
2505         struct lprocfs_stats           *srv_stats;
2506         /** # hp per lp reqs to handle */
2507         int                             srv_hpreq_ratio;
2508         /** biggest request to receive */
2509         int                             srv_max_req_size;
2510         /** biggest reply to send */
2511         int                             srv_max_reply_size;
2512         /** size of individual buffers */
2513         int                             srv_buf_size;
2514         /** # buffers to allocate in 1 group */
2515         int                             srv_nbuf_per_group;
2516         /** Local portal on which to receive requests */
2517         __u32                           srv_req_portal;
2518         /** Portal on the client to send replies to */
2519         __u32                           srv_rep_portal;
2520         /**
2521          * Tags for lu_context associated with this thread, see struct
2522          * lu_context.
2523          */
2524         __u32                           srv_ctx_tags;
2525         /** soft watchdog timeout multiplier */
2526         int                             srv_watchdog_factor;
2527         /** under unregister_service */
2528         unsigned                        srv_is_stopping:1;
2529
2530         /** max # request buffers in history per partition */
2531         int                             srv_hist_nrqbds_cpt_max;
2532         /** number of CPTs this service bound on */
2533         int                             srv_ncpts;
2534         /** CPTs array this service bound on */
2535         __u32                           *srv_cpts;
2536         /** 2^srv_cptab_bits >= cfs_cpt_numbert(srv_cptable) */
2537         int                             srv_cpt_bits;
2538         /** CPT table this service is running over */
2539         struct cfs_cpt_table            *srv_cptable;
2540         /**
2541          * partition data for ptlrpc service
2542          */
2543         struct ptlrpc_service_part      *srv_parts[0];
2544 };
2545
2546 /**
2547  * Definition of PortalRPC service partition data.
2548  * Although a service only has one instance of it right now, but we
2549  * will have multiple instances very soon (instance per CPT).
2550  *
2551  * it has four locks:
2552  * \a scp_lock
2553  *    serialize operations on rqbd and requests waiting for preprocess
2554  * \a scp_req_lock
2555  *    serialize operations active requests sent to this portal
2556  * \a scp_at_lock
2557  *    serialize adaptive timeout stuff
2558  * \a scp_rep_lock
2559  *    serialize operations on RS list (reply states)
2560  *
2561  * We don't have any use-case to take two or more locks at the same time
2562  * for now, so there is no lock order issue.
2563  */
2564 struct ptlrpc_service_part {
2565         /** back reference to owner */
2566         struct ptlrpc_service           *scp_service __cfs_cacheline_aligned;
2567         /* CPT id, reserved */
2568         int                             scp_cpt;
2569         /** always increasing number */
2570         int                             scp_thr_nextid;
2571         /** # of starting threads */
2572         int                             scp_nthrs_starting;
2573         /** # of stopping threads, reserved for shrinking threads */
2574         int                             scp_nthrs_stopping;
2575         /** # running threads */
2576         int                             scp_nthrs_running;
2577         /** service threads list */
2578         cfs_list_t                      scp_threads;
2579
2580         /**
2581          * serialize the following fields, used for protecting
2582          * rqbd list and incoming requests waiting for preprocess,
2583          * threads starting & stopping are also protected by this lock.
2584          */
2585         spinlock_t                      scp_lock  __cfs_cacheline_aligned;
2586         /** total # req buffer descs allocated */
2587         int                             scp_nrqbds_total;
2588         /** # posted request buffers for receiving */
2589         int                             scp_nrqbds_posted;
2590         /** in progress of allocating rqbd */
2591         int                             scp_rqbd_allocating;
2592         /** # incoming reqs */
2593         int                             scp_nreqs_incoming;
2594         /** request buffers to be reposted */
2595         cfs_list_t                      scp_rqbd_idle;
2596         /** req buffers receiving */
2597         cfs_list_t                      scp_rqbd_posted;
2598         /** incoming reqs */
2599         cfs_list_t                      scp_req_incoming;
2600         /** timeout before re-posting reqs, in tick */
2601         cfs_duration_t                  scp_rqbd_timeout;
2602         /**
2603          * all threads sleep on this. This wait-queue is signalled when new
2604          * incoming request arrives and when difficult reply has to be handled.
2605          */
2606         wait_queue_head_t               scp_waitq;
2607
2608         /** request history */
2609         cfs_list_t                      scp_hist_reqs;
2610         /** request buffer history */
2611         cfs_list_t                      scp_hist_rqbds;
2612         /** # request buffers in history */
2613         int                             scp_hist_nrqbds;
2614         /** sequence number for request */
2615         __u64                           scp_hist_seq;
2616         /** highest seq culled from history */
2617         __u64                           scp_hist_seq_culled;
2618
2619         /**
2620          * serialize the following fields, used for processing requests
2621          * sent to this portal
2622          */
2623         spinlock_t                      scp_req_lock __cfs_cacheline_aligned;
2624         /** # reqs in either of the NRS heads below */
2625         /** # reqs being served */
2626         int                             scp_nreqs_active;
2627         /** # HPreqs being served */
2628         int                             scp_nhreqs_active;
2629         /** # hp requests handled */
2630         int                             scp_hreq_count;
2631
2632         /** NRS head for regular requests */
2633         struct ptlrpc_nrs               scp_nrs_reg;
2634         /** NRS head for HP requests; this is only valid for services that can
2635          *  handle HP requests */
2636         struct ptlrpc_nrs              *scp_nrs_hp;
2637
2638         /** AT stuff */
2639         /** @{ */
2640         /**
2641          * serialize the following fields, used for changes on
2642          * adaptive timeout
2643          */
2644         spinlock_t                      scp_at_lock __cfs_cacheline_aligned;
2645         /** estimated rpc service time */
2646         struct adaptive_timeout         scp_at_estimate;
2647         /** reqs waiting for replies */
2648         struct ptlrpc_at_array          scp_at_array;
2649         /** early reply timer */
2650         struct timer_list               scp_at_timer;
2651         /** debug */
2652         cfs_time_t                      scp_at_checktime;
2653         /** check early replies */
2654         unsigned                        scp_at_check;
2655         /** @} */
2656
2657         /**
2658          * serialize the following fields, used for processing
2659          * replies for this portal
2660          */
2661         spinlock_t                      scp_rep_lock __cfs_cacheline_aligned;
2662         /** all the active replies */
2663         cfs_list_t                      scp_rep_active;
2664 #ifndef __KERNEL__
2665         /** replies waiting for service */
2666         cfs_list_t                      scp_rep_queue;
2667 #endif
2668         /** List of free reply_states */
2669         cfs_list_t                      scp_rep_idle;
2670         /** waitq to run, when adding stuff to srv_free_rs_list */
2671         wait_queue_head_t               scp_rep_waitq;
2672         /** # 'difficult' replies */
2673         cfs_atomic_t                    scp_nreps_difficult;
2674 };
2675
2676 #define ptlrpc_service_for_each_part(part, i, svc)                      \
2677         for (i = 0;                                                     \
2678              i < (svc)->srv_ncpts &&                                    \
2679              (svc)->srv_parts != NULL &&                                \
2680              ((part) = (svc)->srv_parts[i]) != NULL; i++)
2681
2682 /**
2683  * Declaration of ptlrpcd control structure
2684  */
2685 struct ptlrpcd_ctl {
2686         /**
2687          * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE)
2688          */
2689         unsigned long                   pc_flags;
2690         /**
2691          * Thread lock protecting structure fields.
2692          */
2693         spinlock_t                      pc_lock;
2694         /**
2695          * Start completion.
2696          */
2697         struct completion               pc_starting;
2698         /**
2699          * Stop completion.
2700          */
2701         struct completion               pc_finishing;
2702         /**
2703          * Thread requests set.
2704          */
2705         struct ptlrpc_request_set  *pc_set;
2706         /**
2707          * Thread name used in kthread_run()
2708          */
2709         char                        pc_name[16];
2710         /**
2711          * Environment for request interpreters to run in.
2712          */
2713         struct lu_env               pc_env;
2714         /**
2715          * Index of ptlrpcd thread in the array.
2716          */
2717         int                         pc_index;
2718         /**
2719          * Number of the ptlrpcd's partners.
2720          */
2721         int                         pc_npartners;
2722         /**
2723          * Pointer to the array of partners' ptlrpcd_ctl structure.
2724          */
2725         struct ptlrpcd_ctl        **pc_partners;
2726         /**
2727          * Record the partner index to be processed next.
2728          */
2729         int                         pc_cursor;
2730 #ifndef __KERNEL__
2731         /**
2732          * Async rpcs flag to make sure that ptlrpcd_check() is called only
2733          * once.
2734          */
2735         int                         pc_recurred;
2736         /**
2737          * Currently not used.
2738          */
2739         void                       *pc_callback;
2740         /**
2741          * User-space async rpcs callback.
2742          */
2743         void                       *pc_wait_callback;
2744         /**
2745          * User-space check idle rpcs callback.
2746          */
2747         void                       *pc_idle_callback;
2748 #endif
2749 };
2750
2751 /* Bits for pc_flags */
2752 enum ptlrpcd_ctl_flags {
2753         /**
2754          * Ptlrpc thread start flag.
2755          */
2756         LIOD_START       = 1 << 0,
2757         /**
2758          * Ptlrpc thread stop flag.
2759          */
2760         LIOD_STOP        = 1 << 1,
2761         /**
2762          * Ptlrpc thread force flag (only stop force so far).
2763          * This will cause aborting any inflight rpcs handled
2764          * by thread if LIOD_STOP is specified.
2765          */
2766         LIOD_FORCE       = 1 << 2,
2767         /**
2768          * This is a recovery ptlrpc thread.
2769          */
2770         LIOD_RECOVERY    = 1 << 3,
2771         /**
2772          * The ptlrpcd is bound to some CPU core.
2773          */
2774         LIOD_BIND        = 1 << 4,
2775 };
2776
2777 /**
2778  * \addtogroup nrs
2779  * @{
2780  *
2781  * Service compatibility function; the policy is compatible with all services.
2782  *
2783  * \param[in] svc  The service the policy is attempting to register with.
2784  * \param[in] desc The policy descriptor
2785  *
2786  * \retval true The policy is compatible with the service
2787  *
2788  * \see ptlrpc_nrs_pol_desc::pd_compat()
2789  */
2790 static inline bool nrs_policy_compat_all(const struct ptlrpc_service *svc,
2791                                          const struct ptlrpc_nrs_pol_desc *desc)
2792 {
2793         return true;
2794 }
2795
2796 /**
2797  * Service compatibility function; the policy is compatible with only a specific
2798  * service which is identified by its human-readable name at
2799  * ptlrpc_service::srv_name.
2800  *
2801  * \param[in] svc  The service the policy is attempting to register with.
2802  * \param[in] desc The policy descriptor
2803  *
2804  * \retval false The policy is not compatible with the service
2805  * \retval true  The policy is compatible with the service
2806  *
2807  * \see ptlrpc_nrs_pol_desc::pd_compat()
2808  */
2809 static inline bool nrs_policy_compat_one(const struct ptlrpc_service *svc,
2810                                          const struct ptlrpc_nrs_pol_desc *desc)
2811 {
2812         LASSERT(desc->pd_compat_svc_name != NULL);
2813         return strcmp(svc->srv_name, desc->pd_compat_svc_name) == 0;
2814 }
2815
2816 /** @} nrs */
2817
2818 /* ptlrpc/events.c */
2819 extern lnet_handle_eq_t ptlrpc_eq_h;
2820 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
2821                                lnet_process_id_t *peer, lnet_nid_t *self);
2822 /**
2823  * These callbacks are invoked by LNet when something happened to
2824  * underlying buffer
2825  * @{
2826  */
2827 extern void request_out_callback(lnet_event_t *ev);
2828 extern void reply_in_callback(lnet_event_t *ev);
2829 extern void client_bulk_callback(lnet_event_t *ev);
2830 extern void request_in_callback(lnet_event_t *ev);
2831 extern void reply_out_callback(lnet_event_t *ev);
2832 #ifdef HAVE_SERVER_SUPPORT
2833 extern void server_bulk_callback(lnet_event_t *ev);
2834 #endif
2835 /** @} */
2836
2837 /* ptlrpc/connection.c */
2838 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
2839                                                 lnet_nid_t self,
2840                                                 struct obd_uuid *uuid);
2841 int ptlrpc_connection_put(struct ptlrpc_connection *c);
2842 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
2843 int ptlrpc_connection_init(void);
2844 void ptlrpc_connection_fini(void);
2845 extern lnet_pid_t ptl_get_pid(void);
2846
2847 /* ptlrpc/niobuf.c */
2848 /**
2849  * Actual interfacing with LNet to put/get/register/unregister stuff
2850  * @{
2851  */
2852 #ifdef HAVE_SERVER_SUPPORT
2853 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
2854                                               unsigned npages, unsigned max_brw,
2855                                               unsigned type, unsigned portal);
2856 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
2857 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
2858
2859 static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc)
2860 {
2861         int rc;
2862
2863         LASSERT(desc != NULL);
2864
2865         spin_lock(&desc->bd_lock);
2866         rc = desc->bd_md_count;
2867         spin_unlock(&desc->bd_lock);
2868         return rc;
2869 }
2870 #endif
2871
2872 int ptlrpc_register_bulk(struct ptlrpc_request *req);
2873 int ptlrpc_unregister_bulk(struct ptlrpc_request *req, int async);
2874
2875 static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req)
2876 {
2877         struct ptlrpc_bulk_desc *desc;
2878         int                      rc;
2879
2880         LASSERT(req != NULL);
2881         desc = req->rq_bulk;
2882
2883         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_BULK_UNLINK) &&
2884             req->rq_bulk_deadline > cfs_time_current_sec())
2885                 return 1;
2886
2887         if (!desc)
2888                 return 0;
2889
2890         spin_lock(&desc->bd_lock);
2891         rc = desc->bd_md_count;
2892         spin_unlock(&desc->bd_lock);
2893         return rc;
2894 }
2895
2896 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
2897 #define PTLRPC_REPLY_EARLY           0x02
2898 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
2899 int ptlrpc_reply(struct ptlrpc_request *req);
2900 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
2901 int ptlrpc_error(struct ptlrpc_request *req);
2902 void ptlrpc_resend_req(struct ptlrpc_request *request);
2903 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
2904 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
2905 int ptlrpc_register_rqbd(struct ptlrpc_request_buffer_desc *rqbd);
2906 /** @} */
2907
2908 /* ptlrpc/client.c */
2909 /**
2910  * Client-side portals API. Everything to send requests, receive replies,
2911  * request queues, request management, etc.
2912  * @{
2913  */
2914 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
2915                         struct ptlrpc_client *);
2916 void ptlrpc_cleanup_client(struct obd_import *imp);
2917 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
2918
2919 int ptlrpc_queue_wait(struct ptlrpc_request *req);
2920 int ptlrpc_replay_req(struct ptlrpc_request *req);
2921 int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async);
2922 void ptlrpc_restart_req(struct ptlrpc_request *req);
2923 void ptlrpc_abort_inflight(struct obd_import *imp);
2924 void ptlrpc_cleanup_imp(struct obd_import *imp);
2925 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
2926
2927 struct ptlrpc_request_set *ptlrpc_prep_set(void);
2928 struct ptlrpc_request_set *ptlrpc_prep_fcset(int max, set_producer_func func,
2929                                              void *arg);
2930 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
2931                       set_interpreter_func fn, void *data);
2932 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
2933 int ptlrpc_check_set(const struct lu_env *env, struct ptlrpc_request_set *set);
2934 int ptlrpc_set_wait(struct ptlrpc_request_set *);
2935 int ptlrpc_expired_set(void *data);
2936 void ptlrpc_interrupted_set(void *data);
2937 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
2938 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
2939 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
2940 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
2941                             struct ptlrpc_request *req);
2942
2943 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
2944 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
2945
2946 struct ptlrpc_request_pool *
2947 ptlrpc_init_rq_pool(int, int,
2948                     void (*populate_pool)(struct ptlrpc_request_pool *, int));
2949
2950 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
2951 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
2952                                             const struct req_format *format);
2953 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
2954                                             struct ptlrpc_request_pool *,
2955                                             const struct req_format *format);
2956 void ptlrpc_request_free(struct ptlrpc_request *request);
2957 int ptlrpc_request_pack(struct ptlrpc_request *request,
2958                         __u32 version, int opcode);
2959 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
2960                                                 const struct req_format *format,
2961                                                 __u32 version, int opcode);
2962 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
2963                              __u32 version, int opcode, char **bufs,
2964                              struct ptlrpc_cli_ctx *ctx);
2965 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
2966                                        int opcode, int count, __u32 *lengths,
2967                                        char **bufs);
2968 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
2969                                              __u32 version, int opcode,
2970                                             int count, __u32 *lengths, char **bufs,
2971                                             struct ptlrpc_request_pool *pool);
2972 void ptlrpc_req_finished(struct ptlrpc_request *request);
2973 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
2974 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
2975 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp(struct ptlrpc_request *req,
2976                                               unsigned npages, unsigned max_brw,
2977                                               unsigned type, unsigned portal);
2978 void __ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk, int pin);
2979 static inline void ptlrpc_free_bulk_pin(struct ptlrpc_bulk_desc *bulk)
2980 {
2981         __ptlrpc_free_bulk(bulk, 1);
2982 }
2983 static inline void ptlrpc_free_bulk_nopin(struct ptlrpc_bulk_desc *bulk)
2984 {
2985         __ptlrpc_free_bulk(bulk, 0);
2986 }
2987 void __ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
2988                              struct page *page, int pageoffset, int len, int);
2989 static inline void ptlrpc_prep_bulk_page_pin(struct ptlrpc_bulk_desc *desc,
2990                                              struct page *page, int pageoffset,
2991                                              int len)
2992 {
2993         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 1);
2994 }
2995
2996 static inline void ptlrpc_prep_bulk_page_nopin(struct ptlrpc_bulk_desc *desc,
2997                                                struct page *page, int pageoffset,
2998                                                int len)
2999 {
3000         __ptlrpc_prep_bulk_page(desc, page, pageoffset, len, 0);
3001 }
3002
3003 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
3004                                       struct obd_import *imp);
3005 __u64 ptlrpc_next_xid(void);
3006 __u64 ptlrpc_sample_next_xid(void);
3007 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
3008
3009 /* Set of routines to run a function in ptlrpcd context */
3010 void *ptlrpcd_alloc_work(struct obd_import *imp,
3011                          int (*cb)(const struct lu_env *, void *), void *data);
3012 void ptlrpcd_destroy_work(void *handler);
3013 int ptlrpcd_queue_work(void *handler);
3014
3015 /** @} */
3016 struct ptlrpc_service_buf_conf {
3017         /* nbufs is buffers # to allocate when growing the pool */
3018         unsigned int                    bc_nbufs;
3019         /* buffer size to post */
3020         unsigned int                    bc_buf_size;
3021         /* portal to listed for requests on */
3022         unsigned int                    bc_req_portal;
3023         /* portal of where to send replies to */
3024         unsigned int                    bc_rep_portal;
3025         /* maximum request size to be accepted for this service */
3026         unsigned int                    bc_req_max_size;
3027         /* maximum reply size this service can ever send */
3028         unsigned int                    bc_rep_max_size;
3029 };
3030
3031 struct ptlrpc_service_thr_conf {
3032         /* threadname should be 8 characters or less - 6 will be added on */
3033         char                            *tc_thr_name;
3034         /* threads increasing factor for each CPU */
3035         unsigned int                    tc_thr_factor;
3036         /* service threads # to start on each partition while initializing */
3037         unsigned int                    tc_nthrs_init;
3038         /*
3039          * low water of threads # upper-limit on each partition while running,
3040          * service availability may be impacted if threads number is lower
3041          * than this value. It can be ZERO if the service doesn't require
3042          * CPU affinity or there is only one partition.
3043          */
3044         unsigned int                    tc_nthrs_base;
3045         /* "soft" limit for total threads number */
3046         unsigned int                    tc_nthrs_max;
3047         /* user specified threads number, it will be validated due to
3048          * other members of this structure. */
3049         unsigned int                    tc_nthrs_user;
3050         /* set NUMA node affinity for service threads */
3051         unsigned int                    tc_cpu_affinity;
3052         /* Tags for lu_context associated with service thread */
3053         __u32                           tc_ctx_tags;
3054 };
3055
3056 struct ptlrpc_service_cpt_conf {
3057         struct cfs_cpt_table            *cc_cptable;
3058         /* string pattern to describe CPTs for a service */
3059         char                            *cc_pattern;
3060 };
3061
3062 struct ptlrpc_service_conf {
3063         /* service name */
3064         char                            *psc_name;
3065         /* soft watchdog timeout multiplifier to print stuck service traces */
3066         unsigned int                    psc_watchdog_factor;
3067         /* buffer information */
3068         struct ptlrpc_service_buf_conf  psc_buf;
3069         /* thread information */
3070         struct ptlrpc_service_thr_conf  psc_thr;
3071         /* CPU partition information */
3072         struct ptlrpc_service_cpt_conf  psc_cpt;
3073         /* function table */
3074         struct ptlrpc_service_ops       psc_ops;
3075 };
3076
3077 /* ptlrpc/service.c */
3078 /**
3079  * Server-side services API. Register/unregister service, request state
3080  * management, service thread management
3081  *
3082  * @{
3083  */
3084 void ptlrpc_save_lock(struct ptlrpc_request *req,
3085                       struct lustre_handle *lock, int mode, int no_ack);
3086 void ptlrpc_commit_replies(struct obd_export *exp);
3087 void ptlrpc_dispatch_difficult_reply(struct ptlrpc_reply_state *rs);
3088 void ptlrpc_schedule_difficult_reply(struct ptlrpc_reply_state *rs);
3089 int ptlrpc_hpreq_handler(struct ptlrpc_request *req);
3090 struct ptlrpc_service *ptlrpc_register_service(
3091                                 struct ptlrpc_service_conf *conf,
3092                                 struct proc_dir_entry *proc_entry);
3093 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
3094
3095 int ptlrpc_start_threads(struct ptlrpc_service *svc);
3096 int ptlrpc_unregister_service(struct ptlrpc_service *service);
3097 int liblustre_check_services(void *arg);
3098 void ptlrpc_daemonize(char *name);
3099 int ptlrpc_service_health_check(struct ptlrpc_service *);
3100 void ptlrpc_server_drop_request(struct ptlrpc_request *req);
3101 void ptlrpc_request_change_export(struct ptlrpc_request *req,
3102                                   struct obd_export *export);
3103
3104 #ifdef __KERNEL__
3105 int ptlrpc_hr_init(void);
3106 void ptlrpc_hr_fini(void);
3107 #else
3108 # define ptlrpc_hr_init() (0)
3109 # define ptlrpc_hr_fini() do {} while(0)
3110 #endif
3111
3112 /** @} */
3113
3114 /* ptlrpc/import.c */
3115 /**
3116  * Import API
3117  * @{
3118  */
3119 int ptlrpc_connect_import(struct obd_import *imp);
3120 int ptlrpc_init_import(struct obd_import *imp);
3121 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
3122 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
3123 void deuuidify(char *uuid, const char *prefix, char **uuid_start,
3124                int *uuid_len);
3125
3126 /* ptlrpc/pack_generic.c */
3127 int ptlrpc_reconnect_import(struct obd_import *imp);
3128 /** @} */
3129
3130 /**
3131  * ptlrpc msg buffer and swab interface 
3132  *
3133  * @{
3134  */
3135 int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout,
3136                          int index);
3137 void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout,
3138                                 int index);
3139 int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len);
3140 int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len);
3141
3142 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
3143 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
3144                         char **bufs);
3145 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
3146                         __u32 *lens, char **bufs);
3147 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
3148                       char **bufs);
3149 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
3150                          __u32 *lens, char **bufs, int flags);
3151 #define LPRFL_EARLY_REPLY 1
3152 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
3153                             char **bufs, int flags);
3154 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
3155                       unsigned int newlen, int move_data);
3156 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
3157 int __lustre_unpack_msg(struct lustre_msg *m, int len);
3158 int lustre_msg_hdr_size(__u32 magic, int count);
3159 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
3160 int lustre_msg_size_v2(int count, __u32 *lengths);
3161 int lustre_packed_msg_size(struct lustre_msg *msg);
3162 int lustre_msg_early_size(void);
3163 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
3164 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
3165 int lustre_msg_buflen(struct lustre_msg *m, int n);
3166 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
3167 int lustre_msg_bufcount(struct lustre_msg *m);
3168 char *lustre_msg_string(struct lustre_msg *m, int n, int max_len);
3169 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
3170 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
3171 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
3172 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
3173 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
3174 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
3175 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
3176 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
3177 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
3178 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
3179 __u32 lustre_msg_get_type(struct lustre_msg *msg);
3180 __u32 lustre_msg_get_version(struct lustre_msg *msg);
3181 void lustre_msg_add_version(struct lustre_msg *msg, int version);
3182 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
3183 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
3184 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
3185 __u64 *lustre_msg_get_versions(struct lustre_msg *msg);
3186 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
3187 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
3188 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
3189 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
3190 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
3191 int lustre_msg_get_status(struct lustre_msg *msg);
3192 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
3193 int lustre_msg_is_v1(struct lustre_msg *msg);
3194 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
3195 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
3196 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
3197 char *lustre_msg_get_jobid(struct lustre_msg *msg);
3198 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
3199 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 50, 0)
3200 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18);
3201 #else
3202 # warning "remove checksum compatibility support for b1_8"
3203 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
3204 #endif
3205 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
3206 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
3207 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
3208 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
3209 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
3210 void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions);
3211 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
3212 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
3213 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
3214 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
3215 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
3216 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
3217 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
3218 void lustre_msg_set_jobid(struct lustre_msg *msg, char *jobid);
3219 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
3220
3221 static inline void
3222 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
3223                     unsigned int newlen, int move_data)
3224 {
3225         LASSERT(req->rq_reply_state);
3226         LASSERT(req->rq_repmsg);
3227         req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
3228                                            newlen, move_data);
3229 }
3230
3231 #ifdef LUSTRE_TRANSLATE_ERRNOS
3232
3233 static inline int ptlrpc_status_hton(int h)
3234 {
3235         /*
3236          * Positive errnos must be network errnos, such as LUSTRE_EDEADLK,
3237          * ELDLM_LOCK_ABORTED, etc.
3238          */
3239         if (h < 0)
3240                 return -lustre_errno_hton(-h);
3241         else
3242                 return h;
3243 }
3244
3245 static inline int ptlrpc_status_ntoh(int n)
3246 {
3247         /*
3248          * See the comment in ptlrpc_status_hton().
3249          */
3250         if (n < 0)
3251                 return -lustre_errno_ntoh(-n);
3252         else
3253                 return n;
3254 }
3255
3256 #else
3257
3258 #define ptlrpc_status_hton(h) (h)
3259 #define ptlrpc_status_ntoh(n) (n)
3260
3261 #endif