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