Whamcloud - gitweb
973c4226f9f22e7b2bcf14f7b878868676e86bc2
[fs/lustre-release.git] / lustre / ptlrpc / layout.c
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) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/ptlrpc/layout.c
32  *
33  * Lustre Metadata Target (mdt) request handler
34  *
35  * Author: Nikita Danilov <nikita@clusterfs.com>
36  */
37 /*
38  * This file contains the "capsule/pill" abstraction layered above PTLRPC.
39  *
40  * Every struct ptlrpc_request contains a "pill", which points to a description
41  * of the format that the request conforms to.
42  */
43
44 #define DEBUG_SUBSYSTEM S_RPC
45
46 #include <linux/module.h>
47
48 #include <llog_swab.h>
49 #include <lustre_swab.h>
50 #include <obd.h>
51 #include <obd_support.h>
52
53 /* struct ptlrpc_request, lustre_msg* */
54 #include <lustre_req_layout.h>
55 #include <lustre_acl.h>
56 #include <lustre_nodemap.h>
57
58 /*
59  * RQFs (see below) refer to two struct req_msg_field arrays describing the
60  * client request and server reply, respectively.
61  */
62 /* empty set of fields... for suitable definition of emptiness. */
63 static const struct req_msg_field *empty[] = {
64         &RMF_PTLRPC_BODY
65 };
66
67 static const struct req_msg_field *mgs_target_info_only[] = {
68         &RMF_PTLRPC_BODY,
69         &RMF_MGS_TARGET_INFO
70 };
71
72 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
73 static const struct req_msg_field *mgs_set_info[] = {
74         &RMF_PTLRPC_BODY,
75         &RMF_MGS_SEND_PARAM
76 };
77 #endif
78
79 static const struct req_msg_field *mgs_config_read_client[] = {
80         &RMF_PTLRPC_BODY,
81         &RMF_MGS_CONFIG_BODY
82 };
83
84 static const struct req_msg_field *mgs_config_read_server[] = {
85         &RMF_PTLRPC_BODY,
86         &RMF_MGS_CONFIG_RES
87 };
88
89 static const struct req_msg_field *mdt_body_only[] = {
90         &RMF_PTLRPC_BODY,
91         &RMF_MDT_BODY
92 };
93
94 static const struct req_msg_field *mdt_body_capa[] = {
95         &RMF_PTLRPC_BODY,
96         &RMF_MDT_BODY,
97         &RMF_CAPA1
98 };
99
100 static const struct req_msg_field *quotactl_only[] = {
101         &RMF_PTLRPC_BODY,
102         &RMF_OBD_QUOTACTL
103 };
104
105 static const struct req_msg_field *quota_body_only[] = {
106         &RMF_PTLRPC_BODY,
107         &RMF_QUOTA_BODY
108 };
109
110 static const struct req_msg_field *ldlm_intent_quota_client[] = {
111         &RMF_PTLRPC_BODY,
112         &RMF_DLM_REQ,
113         &RMF_LDLM_INTENT,
114         &RMF_QUOTA_BODY
115 };
116
117 static const struct req_msg_field *ldlm_intent_quota_server[] = {
118         &RMF_PTLRPC_BODY,
119         &RMF_DLM_REP,
120         &RMF_DLM_LVB,
121         &RMF_QUOTA_BODY
122 };
123
124 static const struct req_msg_field *mdt_close_client[] = {
125         &RMF_PTLRPC_BODY,
126         &RMF_MDT_EPOCH,
127         &RMF_REC_REINT,
128         &RMF_CAPA1
129 };
130
131 static const struct req_msg_field *mdt_close_intent_client[] = {
132         &RMF_PTLRPC_BODY,
133         &RMF_MDT_EPOCH,
134         &RMF_REC_REINT,
135         &RMF_CAPA1,
136         &RMF_CLOSE_DATA,
137         &RMF_U32
138 };
139
140 static const struct req_msg_field *obd_statfs_server[] = {
141         &RMF_PTLRPC_BODY,
142         &RMF_OBD_STATFS
143 };
144
145 static const struct req_msg_field *seq_query_client[] = {
146         &RMF_PTLRPC_BODY,
147         &RMF_SEQ_OPC,
148         &RMF_SEQ_RANGE
149 };
150
151 static const struct req_msg_field *seq_query_server[] = {
152         &RMF_PTLRPC_BODY,
153         &RMF_SEQ_RANGE
154 };
155
156 static const struct req_msg_field *fld_query_client[] = {
157         &RMF_PTLRPC_BODY,
158         &RMF_FLD_OPC,
159         &RMF_FLD_MDFLD
160 };
161
162 static const struct req_msg_field *fld_query_server[] = {
163         &RMF_PTLRPC_BODY,
164         &RMF_FLD_MDFLD
165 };
166
167 static const struct req_msg_field *fld_read_client[] = {
168         &RMF_PTLRPC_BODY,
169         &RMF_FLD_MDFLD
170 };
171
172 static const struct req_msg_field *fld_read_server[] = {
173         &RMF_PTLRPC_BODY,
174         &RMF_GENERIC_DATA
175 };
176
177 static const struct req_msg_field *mds_getattr_name_client[] = {
178         &RMF_PTLRPC_BODY,
179         &RMF_MDT_BODY,
180         &RMF_CAPA1,
181         &RMF_NAME
182 };
183
184 static const struct req_msg_field *mds_reint_client[] = {
185         &RMF_PTLRPC_BODY,
186         &RMF_REC_REINT
187 };
188
189 static const struct req_msg_field *mds_reint_create_client[] = {
190         &RMF_PTLRPC_BODY,
191         &RMF_REC_REINT,
192         &RMF_CAPA1,
193         &RMF_NAME
194 };
195
196 static const struct req_msg_field *mds_reint_create_slave_client[] = {
197         &RMF_PTLRPC_BODY,
198         &RMF_REC_REINT,
199         &RMF_CAPA1,
200         &RMF_NAME,
201         &RMF_EADATA,
202         &RMF_DLM_REQ
203 };
204
205 static const struct req_msg_field *mds_reint_create_acl_client[] = {
206         &RMF_PTLRPC_BODY,
207         &RMF_REC_REINT,
208         &RMF_CAPA1,
209         &RMF_NAME,
210         &RMF_EADATA,
211         &RMF_DLM_REQ,
212         &RMF_FILE_SECCTX_NAME,
213         &RMF_FILE_SECCTX,
214         &RMF_SELINUX_POL,
215         &RMF_FILE_ENCCTX,
216 };
217
218 static const struct req_msg_field *mds_reint_create_sym_client[] = {
219         &RMF_PTLRPC_BODY,
220         &RMF_REC_REINT,
221         &RMF_CAPA1,
222         &RMF_NAME,
223         &RMF_SYMTGT,
224         &RMF_DLM_REQ,
225         &RMF_FILE_SECCTX_NAME,
226         &RMF_FILE_SECCTX,
227         &RMF_SELINUX_POL,
228         &RMF_FILE_ENCCTX,
229 };
230
231 static const struct req_msg_field *mds_reint_open_client[] = {
232         &RMF_PTLRPC_BODY,
233         &RMF_REC_REINT,
234         &RMF_CAPA1,
235         &RMF_CAPA2,
236         &RMF_NAME,
237         &RMF_EADATA,
238         &RMF_FILE_SECCTX_NAME,
239         &RMF_FILE_SECCTX,
240         &RMF_SELINUX_POL,
241         &RMF_FILE_ENCCTX,
242 };
243
244 static const struct req_msg_field *mds_reint_open_server[] = {
245         &RMF_PTLRPC_BODY,
246         &RMF_MDT_BODY,
247         &RMF_MDT_MD,
248         &RMF_ACL,
249         &RMF_CAPA1,
250         &RMF_CAPA2
251 };
252
253 static const struct req_msg_field *mds_reint_unlink_client[] = {
254         &RMF_PTLRPC_BODY,
255         &RMF_REC_REINT,
256         &RMF_CAPA1,
257         &RMF_NAME,
258         &RMF_DLM_REQ,
259         &RMF_SELINUX_POL
260 };
261
262 static const struct req_msg_field *mds_reint_link_client[] = {
263         &RMF_PTLRPC_BODY,
264         &RMF_REC_REINT,
265         &RMF_CAPA1,
266         &RMF_CAPA2,
267         &RMF_NAME,
268         &RMF_DLM_REQ,
269         &RMF_SELINUX_POL
270 };
271
272 static const struct req_msg_field *mds_reint_rename_client[] = {
273         &RMF_PTLRPC_BODY,
274         &RMF_REC_REINT,
275         &RMF_CAPA1,
276         &RMF_CAPA2,
277         &RMF_NAME,
278         &RMF_SYMTGT,
279         &RMF_DLM_REQ,
280         &RMF_SELINUX_POL
281 };
282
283 static const struct req_msg_field *mds_reint_migrate_client[] = {
284         &RMF_PTLRPC_BODY,
285         &RMF_REC_REINT,
286         &RMF_CAPA1,
287         &RMF_CAPA2,
288         &RMF_NAME,
289         &RMF_SYMTGT,
290         &RMF_DLM_REQ,
291         &RMF_SELINUX_POL,
292         &RMF_MDT_EPOCH,
293         &RMF_CLOSE_DATA,
294         &RMF_EADATA
295 };
296
297 static const struct req_msg_field *mds_last_unlink_server[] = {
298         &RMF_PTLRPC_BODY,
299         &RMF_MDT_BODY,
300         &RMF_MDT_MD,
301         &RMF_LOGCOOKIES,
302         &RMF_CAPA1,
303         &RMF_CAPA2
304 };
305
306 static const struct req_msg_field *mds_reint_setattr_client[] = {
307         &RMF_PTLRPC_BODY,
308         &RMF_REC_REINT,
309         &RMF_CAPA1,
310         &RMF_MDT_EPOCH,
311         &RMF_EADATA,
312         &RMF_LOGCOOKIES,
313         &RMF_DLM_REQ
314 };
315
316 static const struct req_msg_field *mds_reint_setxattr_client[] = {
317         &RMF_PTLRPC_BODY,
318         &RMF_REC_REINT,
319         &RMF_CAPA1,
320         &RMF_NAME,
321         &RMF_EADATA,
322         &RMF_DLM_REQ,
323         &RMF_SELINUX_POL
324 };
325
326 static const struct req_msg_field *mds_reint_resync[] = {
327         &RMF_PTLRPC_BODY,
328         &RMF_REC_REINT,
329         &RMF_DLM_REQ
330 };
331
332 static const struct req_msg_field *mdt_swap_layouts[] = {
333         &RMF_PTLRPC_BODY,
334         &RMF_MDT_BODY,
335         &RMF_SWAP_LAYOUTS,
336         &RMF_CAPA1,
337         &RMF_CAPA2,
338         &RMF_DLM_REQ
339 };
340
341 static const struct req_msg_field *mds_rmfid_client[] = {
342         &RMF_PTLRPC_BODY,
343         &RMF_MDT_BODY,
344         &RMF_FID_ARRAY,
345         &RMF_CAPA1,
346         &RMF_CAPA2,
347 };
348
349 static const struct req_msg_field *mds_rmfid_server[] = {
350         &RMF_PTLRPC_BODY,
351         &RMF_MDT_BODY,
352         &RMF_FID_ARRAY,
353         &RMF_RCS,
354 };
355
356 static const struct req_msg_field *obd_connect_client[] = {
357         &RMF_PTLRPC_BODY,
358         &RMF_TGTUUID,
359         &RMF_CLUUID,
360         &RMF_CONN,
361         &RMF_CONNECT_DATA,
362         &RMF_SELINUX_POL
363 };
364
365 static const struct req_msg_field *obd_connect_server[] = {
366         &RMF_PTLRPC_BODY,
367         &RMF_CONNECT_DATA
368 };
369
370 static const struct req_msg_field *obd_set_info_client[] = {
371         &RMF_PTLRPC_BODY,
372         &RMF_SETINFO_KEY,
373         &RMF_SETINFO_VAL
374 };
375
376 static const struct req_msg_field *mdt_set_info_client[] = {
377         &RMF_PTLRPC_BODY,
378         &RMF_SETINFO_KEY,
379         &RMF_SETINFO_VAL,
380         &RMF_MDT_BODY
381 };
382
383 static const struct req_msg_field *ost_grant_shrink_client[] = {
384         &RMF_PTLRPC_BODY,
385         &RMF_SETINFO_KEY,
386         &RMF_OST_BODY
387 };
388
389 static const struct req_msg_field *mds_getinfo_client[] = {
390         &RMF_PTLRPC_BODY,
391         &RMF_GETINFO_KEY,
392         &RMF_GETINFO_VALLEN
393 };
394
395 static const struct req_msg_field *mds_getinfo_server[] = {
396         &RMF_PTLRPC_BODY,
397         &RMF_GETINFO_VAL,
398 };
399
400 static const struct req_msg_field *ldlm_enqueue_client[] = {
401         &RMF_PTLRPC_BODY,
402         &RMF_DLM_REQ
403 };
404
405 static const struct req_msg_field *ldlm_enqueue_server[] = {
406         &RMF_PTLRPC_BODY,
407         &RMF_DLM_REP
408 };
409
410 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
411         &RMF_PTLRPC_BODY,
412         &RMF_DLM_REP,
413         &RMF_DLM_LVB
414 };
415
416 static const struct req_msg_field *ldlm_cp_callback_client[] = {
417         &RMF_PTLRPC_BODY,
418         &RMF_DLM_REQ,
419         &RMF_DLM_LVB
420 };
421
422 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
423         &RMF_PTLRPC_BODY,
424         &RMF_DLM_REQ,
425         &RMF_DLM_GL_DESC
426 };
427
428 static const struct req_msg_field *ldlm_gl_callback_server[] = {
429         &RMF_PTLRPC_BODY,
430         &RMF_DLM_LVB
431 };
432
433 static const struct req_msg_field *ldlm_intent_basic_client[] = {
434         &RMF_PTLRPC_BODY,
435         &RMF_DLM_REQ,
436         &RMF_LDLM_INTENT,
437 };
438
439 static const struct req_msg_field *ldlm_intent_client[] = {
440         &RMF_PTLRPC_BODY,
441         &RMF_DLM_REQ,
442         &RMF_LDLM_INTENT,
443         &RMF_REC_REINT
444 };
445
446 static const struct req_msg_field *ldlm_intent_server[] = {
447         &RMF_PTLRPC_BODY,
448         &RMF_DLM_REP,
449         &RMF_MDT_BODY,
450         &RMF_MDT_MD,
451         &RMF_ACL
452 };
453
454 static const struct req_msg_field *ldlm_intent_layout_client[] = {
455         &RMF_PTLRPC_BODY,
456         &RMF_DLM_REQ,
457         &RMF_LDLM_INTENT,
458         &RMF_LAYOUT_INTENT,
459         &RMF_EADATA /* for new layout to be set up */
460 };
461
462 static const struct req_msg_field *ldlm_intent_open_server[] = {
463         &RMF_PTLRPC_BODY,
464         &RMF_DLM_REP,
465         &RMF_MDT_BODY,
466         &RMF_MDT_MD,
467         &RMF_ACL,
468         &RMF_CAPA1,
469         &RMF_CAPA2,
470         &RMF_NIOBUF_INLINE,
471         &RMF_FILE_SECCTX,
472         &RMF_FILE_ENCCTX,
473 };
474
475 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
476         &RMF_PTLRPC_BODY,
477         &RMF_DLM_REQ,
478         &RMF_LDLM_INTENT,
479         &RMF_MDT_BODY,     /* coincides with mds_getattr_name_client[] */
480         &RMF_CAPA1,
481         &RMF_NAME,
482         &RMF_FILE_SECCTX_NAME
483 };
484
485 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
486         &RMF_PTLRPC_BODY,
487         &RMF_DLM_REP,
488         &RMF_MDT_BODY,
489         &RMF_MDT_MD,
490         &RMF_ACL,
491         &RMF_CAPA1,
492         &RMF_FILE_SECCTX,
493         &RMF_DEFAULT_MDT_MD,
494         &RMF_FILE_ENCCTX,
495 };
496
497 static const struct req_msg_field *ldlm_intent_create_client[] = {
498         &RMF_PTLRPC_BODY,
499         &RMF_DLM_REQ,
500         &RMF_LDLM_INTENT,
501         &RMF_REC_REINT,    /* coincides with mds_reint_create_client[] */
502         &RMF_CAPA1,
503         &RMF_NAME,
504         &RMF_EADATA,
505         &RMF_FILE_SECCTX_NAME,
506         &RMF_FILE_SECCTX,
507         &RMF_SELINUX_POL,
508         &RMF_FILE_ENCCTX,
509 };
510
511 static const struct req_msg_field *ldlm_intent_open_client[] = {
512         &RMF_PTLRPC_BODY,
513         &RMF_DLM_REQ,
514         &RMF_LDLM_INTENT,
515         &RMF_REC_REINT,    /* coincides with mds_reint_open_client[] */
516         &RMF_CAPA1,
517         &RMF_CAPA2,
518         &RMF_NAME,
519         &RMF_EADATA,
520         &RMF_FILE_SECCTX_NAME,
521         &RMF_FILE_SECCTX,
522         &RMF_SELINUX_POL,
523         &RMF_FILE_ENCCTX,
524 };
525
526 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
527         &RMF_PTLRPC_BODY,
528         &RMF_DLM_REQ,
529         &RMF_LDLM_INTENT,
530         &RMF_MDT_BODY,
531         &RMF_CAPA1,
532         &RMF_SELINUX_POL
533 };
534
535 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
536         &RMF_PTLRPC_BODY,
537         &RMF_DLM_REP,
538         &RMF_MDT_BODY,
539         &RMF_MDT_MD,
540         &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
541         &RMF_EADATA,
542         &RMF_EAVALS,
543         &RMF_EAVALS_LENS
544 };
545
546 static const struct req_msg_field *mds_get_root_client[] = {
547         &RMF_PTLRPC_BODY,
548         &RMF_MDT_BODY,
549         &RMF_NAME
550 };
551
552 static const struct req_msg_field *mds_getxattr_client[] = {
553         &RMF_PTLRPC_BODY,
554         &RMF_MDT_BODY,
555         &RMF_CAPA1,
556         &RMF_NAME,
557         &RMF_EADATA,
558         &RMF_SELINUX_POL
559 };
560
561 static const struct req_msg_field *mds_getxattr_server[] = {
562         &RMF_PTLRPC_BODY,
563         &RMF_MDT_BODY,
564         &RMF_EADATA
565 };
566
567 static const struct req_msg_field *mds_getattr_server[] = {
568         &RMF_PTLRPC_BODY,
569         &RMF_MDT_BODY,
570         &RMF_MDT_MD,
571         &RMF_ACL,
572         &RMF_CAPA1,
573         &RMF_CAPA2,
574         &RMF_FILE_ENCCTX,
575 };
576
577 static const struct req_msg_field *mds_setattr_server[] = {
578         &RMF_PTLRPC_BODY,
579         &RMF_MDT_BODY,
580         &RMF_MDT_MD,
581         &RMF_ACL,
582         &RMF_CAPA1,
583         &RMF_CAPA2
584 };
585
586 static const struct req_msg_field *llog_origin_handle_create_client[] = {
587         &RMF_PTLRPC_BODY,
588         &RMF_LLOGD_BODY,
589         &RMF_NAME,
590         &RMF_MDT_BODY
591 };
592
593 static const struct req_msg_field *llogd_body_only[] = {
594         &RMF_PTLRPC_BODY,
595         &RMF_LLOGD_BODY
596 };
597
598 static const struct req_msg_field *llog_log_hdr_only[] = {
599         &RMF_PTLRPC_BODY,
600         &RMF_LLOG_LOG_HDR
601 };
602
603 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
604         &RMF_PTLRPC_BODY,
605         &RMF_LLOGD_BODY,
606         &RMF_EADATA
607 };
608
609 static const struct req_msg_field *obd_idx_read_client[] = {
610         &RMF_PTLRPC_BODY,
611         &RMF_IDX_INFO
612 };
613
614 static const struct req_msg_field *obd_idx_read_server[] = {
615         &RMF_PTLRPC_BODY,
616         &RMF_IDX_INFO
617 };
618
619 static const struct req_msg_field *ost_body_only[] = {
620         &RMF_PTLRPC_BODY,
621         &RMF_OST_BODY
622 };
623
624 static const struct req_msg_field *ost_body_capa[] = {
625         &RMF_PTLRPC_BODY,
626         &RMF_OST_BODY,
627         &RMF_CAPA1
628 };
629
630 static const struct req_msg_field *ost_destroy_client[] = {
631         &RMF_PTLRPC_BODY,
632         &RMF_OST_BODY,
633         &RMF_DLM_REQ,
634         &RMF_CAPA1
635 };
636
637
638 static const struct req_msg_field *ost_brw_client[] = {
639         &RMF_PTLRPC_BODY,
640         &RMF_OST_BODY,
641         &RMF_OBD_IOOBJ,
642         &RMF_NIOBUF_REMOTE,
643         &RMF_CAPA1,
644         &RMF_SHORT_IO
645 };
646
647 static const struct req_msg_field *ost_brw_read_server[] = {
648         &RMF_PTLRPC_BODY,
649         &RMF_OST_BODY,
650         &RMF_SHORT_IO
651 };
652
653 static const struct req_msg_field *ost_brw_write_server[] = {
654         &RMF_PTLRPC_BODY,
655         &RMF_OST_BODY,
656         &RMF_RCS
657 };
658
659 static const struct req_msg_field *ost_get_info_generic_server[] = {
660         &RMF_PTLRPC_BODY,
661         &RMF_GENERIC_DATA,
662 };
663
664 static const struct req_msg_field *ost_get_info_generic_client[] = {
665         &RMF_PTLRPC_BODY,
666         &RMF_GETINFO_KEY
667 };
668
669 static const struct req_msg_field *ost_get_last_id_server[] = {
670         &RMF_PTLRPC_BODY,
671         &RMF_OBD_ID
672 };
673
674 static const struct req_msg_field *ost_get_last_fid_client[] = {
675         &RMF_PTLRPC_BODY,
676         &RMF_GETINFO_KEY,
677         &RMF_FID,
678 };
679
680 static const struct req_msg_field *ost_get_last_fid_server[] = {
681         &RMF_PTLRPC_BODY,
682         &RMF_FID,
683 };
684
685 static const struct req_msg_field *ost_get_fiemap_client[] = {
686         &RMF_PTLRPC_BODY,
687         &RMF_FIEMAP_KEY,
688         &RMF_FIEMAP_VAL
689 };
690
691 static const struct req_msg_field *ost_ladvise[] = {
692         &RMF_PTLRPC_BODY,
693         &RMF_OST_BODY,
694         &RMF_OST_LADVISE_HDR,
695         &RMF_OST_LADVISE,
696 };
697
698 static const struct req_msg_field *ost_get_fiemap_server[] = {
699         &RMF_PTLRPC_BODY,
700         &RMF_FIEMAP_VAL
701 };
702
703 static const struct req_msg_field *mdt_hsm_progress[] = {
704         &RMF_PTLRPC_BODY,
705         &RMF_MDT_BODY,
706         &RMF_MDS_HSM_PROGRESS,
707 };
708
709 static const struct req_msg_field *mdt_hsm_ct_register[] = {
710         &RMF_PTLRPC_BODY,
711         &RMF_MDT_BODY,
712         &RMF_MDS_HSM_ARCHIVE,
713 };
714
715 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
716         &RMF_PTLRPC_BODY,
717         &RMF_MDT_BODY,
718 };
719
720 static const struct req_msg_field *mdt_hsm_action_server[] = {
721         &RMF_PTLRPC_BODY,
722         &RMF_MDT_BODY,
723         &RMF_MDS_HSM_CURRENT_ACTION,
724 };
725
726 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
727         &RMF_PTLRPC_BODY,
728         &RMF_MDT_BODY,
729         &RMF_HSM_USER_STATE,
730 };
731
732 static const struct req_msg_field *mdt_hsm_state_set[] = {
733         &RMF_PTLRPC_BODY,
734         &RMF_MDT_BODY,
735         &RMF_CAPA1,
736         &RMF_HSM_STATE_SET,
737 };
738
739 static const struct req_msg_field *mdt_hsm_request[] = {
740         &RMF_PTLRPC_BODY,
741         &RMF_MDT_BODY,
742         &RMF_MDS_HSM_REQUEST,
743         &RMF_MDS_HSM_USER_ITEM,
744         &RMF_GENERIC_DATA,
745 };
746
747 static const struct req_msg_field *obd_lfsck_request[] = {
748         &RMF_PTLRPC_BODY,
749         &RMF_LFSCK_REQUEST,
750 };
751
752 static const struct req_msg_field *obd_lfsck_reply[] = {
753         &RMF_PTLRPC_BODY,
754         &RMF_LFSCK_REPLY,
755 };
756
757 static struct req_format *req_formats[] = {
758         &RQF_OBD_PING,
759         &RQF_OBD_SET_INFO,
760         &RQF_MDT_SET_INFO,
761         &RQF_OBD_IDX_READ,
762         &RQF_SEC_CTX,
763         &RQF_MGS_TARGET_REG,
764 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
765         &RQF_MGS_SET_INFO,
766 #endif
767         &RQF_MGS_CONFIG_READ,
768         &RQF_SEQ_QUERY,
769         &RQF_FLD_QUERY,
770         &RQF_FLD_READ,
771         &RQF_MDS_CONNECT,
772         &RQF_MDS_DISCONNECT,
773         &RQF_MDS_GET_INFO,
774         &RQF_MDS_GET_ROOT,
775         &RQF_MDS_STATFS,
776         &RQF_MDS_STATFS_NEW,
777         &RQF_MDS_GETATTR,
778         &RQF_MDS_GETATTR_NAME,
779         &RQF_MDS_GETXATTR,
780         &RQF_MDS_SYNC,
781         &RQF_MDS_CLOSE,
782         &RQF_MDS_CLOSE_INTENT,
783         &RQF_MDS_READPAGE,
784         &RQF_MDS_REINT,
785         &RQF_MDS_REINT_CREATE,
786         &RQF_MDS_REINT_CREATE_ACL,
787         &RQF_MDS_REINT_CREATE_SLAVE,
788         &RQF_MDS_REINT_CREATE_SYM,
789         &RQF_MDS_REINT_OPEN,
790         &RQF_MDS_REINT_UNLINK,
791         &RQF_MDS_REINT_LINK,
792         &RQF_MDS_REINT_RENAME,
793         &RQF_MDS_REINT_MIGRATE,
794         &RQF_MDS_REINT_SETATTR,
795         &RQF_MDS_REINT_SETXATTR,
796         &RQF_MDS_REINT_RESYNC,
797         &RQF_MDS_QUOTACTL,
798         &RQF_MDS_HSM_PROGRESS,
799         &RQF_MDS_HSM_CT_REGISTER,
800         &RQF_MDS_HSM_CT_UNREGISTER,
801         &RQF_MDS_HSM_STATE_GET,
802         &RQF_MDS_HSM_STATE_SET,
803         &RQF_MDS_HSM_ACTION,
804         &RQF_MDS_HSM_REQUEST,
805         &RQF_MDS_SWAP_LAYOUTS,
806         &RQF_MDS_RMFID,
807 #ifdef HAVE_SERVER_SUPPORT
808         &RQF_OUT_UPDATE,
809 #endif
810         &RQF_OST_CONNECT,
811         &RQF_OST_DISCONNECT,
812         &RQF_OST_QUOTACTL,
813         &RQF_OST_GETATTR,
814         &RQF_OST_SETATTR,
815         &RQF_OST_CREATE,
816         &RQF_OST_PUNCH,
817         &RQF_OST_FALLOCATE,
818         &RQF_OST_SYNC,
819         &RQF_OST_DESTROY,
820         &RQF_OST_BRW_READ,
821         &RQF_OST_BRW_WRITE,
822         &RQF_OST_STATFS,
823         &RQF_OST_SET_GRANT_INFO,
824         &RQF_OST_GET_INFO,
825         &RQF_OST_GET_INFO_LAST_ID,
826         &RQF_OST_GET_INFO_LAST_FID,
827         &RQF_OST_SET_INFO_LAST_FID,
828         &RQF_OST_GET_INFO_FIEMAP,
829         &RQF_OST_LADVISE,
830         &RQF_OST_SEEK,
831         &RQF_LDLM_ENQUEUE,
832         &RQF_LDLM_ENQUEUE_LVB,
833         &RQF_LDLM_CONVERT,
834         &RQF_LDLM_CANCEL,
835         &RQF_LDLM_CALLBACK,
836         &RQF_LDLM_CP_CALLBACK,
837         &RQF_LDLM_BL_CALLBACK,
838         &RQF_LDLM_GL_CALLBACK,
839         &RQF_LDLM_GL_CALLBACK_DESC,
840         &RQF_LDLM_INTENT,
841         &RQF_LDLM_INTENT_BASIC,
842         &RQF_LDLM_INTENT_LAYOUT,
843         &RQF_LDLM_INTENT_GETATTR,
844         &RQF_LDLM_INTENT_OPEN,
845         &RQF_LDLM_INTENT_CREATE,
846         &RQF_LDLM_INTENT_GETXATTR,
847         &RQF_LDLM_INTENT_QUOTA,
848         &RQF_QUOTA_DQACQ,
849         &RQF_LLOG_ORIGIN_HANDLE_CREATE,
850         &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
851         &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
852         &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
853         &RQF_CONNECT,
854         &RQF_LFSCK_NOTIFY,
855         &RQF_LFSCK_QUERY,
856 };
857
858 struct req_msg_field {
859         const __u32 rmf_flags;
860         const char  *rmf_name;
861         /**
862          * Field length. (-1) means "variable length".  If the
863          * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
864          * but the actual size must be a whole multiple of \a rmf_size.
865          */
866         const int   rmf_size;
867         void        (*rmf_swabber)(void *);
868         /**
869          * Pass buffer size to swabbing function
870          * \retval      > 0             the number of bytes swabbed
871          *              -EOVERFLOW      on error
872          */
873         int         (*rmf_swab_len)(void *, __u32);
874         void        (*rmf_dumper)(void *);
875         int         rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
876 };
877
878 enum rmf_flags {
879         /**
880          * The field is a string, must be NUL-terminated.
881          */
882         RMF_F_STRING            = BIT(0),
883         /**
884          * The field's buffer size need not match the declared \a rmf_size.
885          */
886         RMF_F_NO_SIZE_CHECK     = BIT(1),
887         /**
888          * The field's buffer size must be a whole multiple of the declared \a
889          * rmf_size and the \a rmf_swabber function must work on the declared \a
890          * rmf_size worth of bytes.
891          */
892         RMF_F_STRUCT_ARRAY      = BIT(2),
893 };
894
895 struct req_capsule;
896
897 /*
898  * Request fields.
899  */
900 #define DEFINE_MSGF(name, flags, size, swabber, dumper) {       \
901         .rmf_name    = (name),                                  \
902         .rmf_flags   = (flags),                                 \
903         .rmf_size    = (size),                                  \
904         .rmf_swabber = (void (*)(void*))(swabber),              \
905         .rmf_dumper  = (void (*)(void*))(dumper)                \
906 }
907
908 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) {     \
909         .rmf_name     = (name),                                 \
910         .rmf_flags    = (flags),                                \
911         .rmf_size     = (size),                                 \
912         .rmf_swab_len = (int (*)(void *, __u32))(swab_len),     \
913         .rmf_dumper   = (void (*)(void *))(dumper)              \
914 }
915
916 struct req_msg_field RMF_GENERIC_DATA =
917         DEFINE_MSGF("generic_data", 0,
918                     -1, NULL, NULL);
919 EXPORT_SYMBOL(RMF_GENERIC_DATA);
920
921 struct req_msg_field RMF_MGS_TARGET_INFO =
922         DEFINE_MSGF("mgs_target_info", 0,
923                     sizeof(struct mgs_target_info),
924                     lustre_swab_mgs_target_info, NULL);
925 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
926
927 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
928 struct req_msg_field RMF_MGS_SEND_PARAM =
929         DEFINE_MSGF("mgs_send_param", 0,
930                     sizeof(struct mgs_send_param),
931                     NULL, NULL);
932 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
933 #endif
934
935 struct req_msg_field RMF_MGS_CONFIG_BODY =
936         DEFINE_MSGF("mgs_config_read request", 0,
937                     sizeof(struct mgs_config_body),
938                     lustre_swab_mgs_config_body, NULL);
939 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
940
941 struct req_msg_field RMF_MGS_CONFIG_RES =
942         DEFINE_MSGF("mgs_config_read reply ", 0,
943                     sizeof(struct mgs_config_res),
944                     lustre_swab_mgs_config_res, NULL);
945 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
946
947 struct req_msg_field RMF_U32 =
948         DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
949                     sizeof(__u32), lustre_swab_generic_32s, NULL);
950 EXPORT_SYMBOL(RMF_U32);
951
952 struct req_msg_field RMF_SETINFO_VAL =
953         DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
954 EXPORT_SYMBOL(RMF_SETINFO_VAL);
955
956 struct req_msg_field RMF_GETINFO_KEY =
957         DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
958 EXPORT_SYMBOL(RMF_GETINFO_KEY);
959
960 struct req_msg_field RMF_GETINFO_VALLEN =
961         DEFINE_MSGF("getinfo_vallen", 0,
962                     sizeof(__u32), lustre_swab_generic_32s, NULL);
963 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
964
965 struct req_msg_field RMF_GETINFO_VAL =
966         DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_GETINFO_VAL);
968
969 struct req_msg_field RMF_SEQ_OPC =
970         DEFINE_MSGF("seq_query_opc", 0,
971                     sizeof(__u32), lustre_swab_generic_32s, NULL);
972 EXPORT_SYMBOL(RMF_SEQ_OPC);
973
974 struct req_msg_field RMF_SEQ_RANGE =
975         DEFINE_MSGF("seq_query_range", 0,
976                     sizeof(struct lu_seq_range),
977                     lustre_swab_lu_seq_range, NULL);
978 EXPORT_SYMBOL(RMF_SEQ_RANGE);
979
980 struct req_msg_field RMF_FLD_OPC =
981         DEFINE_MSGF("fld_query_opc", 0,
982                     sizeof(__u32), lustre_swab_generic_32s, NULL);
983 EXPORT_SYMBOL(RMF_FLD_OPC);
984
985 struct req_msg_field RMF_FLD_MDFLD =
986         DEFINE_MSGF("fld_query_mdfld", 0,
987                     sizeof(struct lu_seq_range),
988                     lustre_swab_lu_seq_range, NULL);
989 EXPORT_SYMBOL(RMF_FLD_MDFLD);
990
991 struct req_msg_field RMF_MDT_BODY =
992         DEFINE_MSGF("mdt_body", 0,
993                     sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
994 EXPORT_SYMBOL(RMF_MDT_BODY);
995
996 struct req_msg_field RMF_OBD_QUOTACTL =
997         DEFINE_MSGFL("obd_quotactl",
998                      0,
999                      sizeof(struct obd_quotactl),
1000                      lustre_swab_obd_quotactl, NULL);
1001 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
1002
1003 struct req_msg_field RMF_QUOTA_BODY =
1004         DEFINE_MSGF("quota_body", 0,
1005                     sizeof(struct quota_body), lustre_swab_quota_body, NULL);
1006 EXPORT_SYMBOL(RMF_QUOTA_BODY);
1007
1008 struct req_msg_field RMF_MDT_EPOCH =
1009         DEFINE_MSGF("mdt_ioepoch", 0,
1010                     sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
1011 EXPORT_SYMBOL(RMF_MDT_EPOCH);
1012
1013 struct req_msg_field RMF_PTLRPC_BODY =
1014         DEFINE_MSGF("ptlrpc_body", 0,
1015                     sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
1016 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
1017
1018 struct req_msg_field RMF_CLOSE_DATA =
1019         DEFINE_MSGF("data_version", 0,
1020                     sizeof(struct close_data), lustre_swab_close_data, NULL);
1021 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1022
1023 struct req_msg_field RMF_OBD_STATFS =
1024         DEFINE_MSGF("obd_statfs", 0,
1025                     sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1026 EXPORT_SYMBOL(RMF_OBD_STATFS);
1027
1028 struct req_msg_field RMF_SETINFO_KEY =
1029         DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1030 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1031
1032 struct req_msg_field RMF_NAME =
1033         DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1034 EXPORT_SYMBOL(RMF_NAME);
1035
1036 struct req_msg_field RMF_FID_ARRAY =
1037         DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1038 EXPORT_SYMBOL(RMF_FID_ARRAY);
1039
1040 struct req_msg_field RMF_SYMTGT =
1041         DEFINE_MSGF("symtgt", 0, -1, NULL, NULL);
1042 EXPORT_SYMBOL(RMF_SYMTGT);
1043
1044 struct req_msg_field RMF_TGTUUID =
1045         DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1046         NULL);
1047 EXPORT_SYMBOL(RMF_TGTUUID);
1048
1049 struct req_msg_field RMF_CLUUID =
1050         DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1051         NULL);
1052 EXPORT_SYMBOL(RMF_CLUUID);
1053
1054 struct req_msg_field RMF_STRING =
1055         DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1056 EXPORT_SYMBOL(RMF_STRING);
1057
1058 struct req_msg_field RMF_FILE_SECCTX_NAME =
1059         DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1060 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1061
1062 struct req_msg_field RMF_FILE_SECCTX =
1063         DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1065
1066 struct req_msg_field RMF_FILE_ENCCTX =
1067         DEFINE_MSGF("file_encctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1068 EXPORT_SYMBOL(RMF_FILE_ENCCTX);
1069
1070 struct req_msg_field RMF_LLOGD_BODY =
1071         DEFINE_MSGF("llogd_body", 0,
1072                     sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1073 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1074
1075 struct req_msg_field RMF_LLOG_LOG_HDR =
1076         DEFINE_MSGF("llog_log_hdr", 0,
1077                     sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1078 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1079
1080 struct req_msg_field RMF_LLOGD_CONN_BODY =
1081         DEFINE_MSGF("llogd_conn_body", 0,
1082                     sizeof(struct llogd_conn_body),
1083                     lustre_swab_llogd_conn_body, NULL);
1084 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1085
1086 /*
1087  * connection handle received in MDS_CONNECT request.
1088  *
1089  * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1090  * that the client does not interpret at all.
1091  */
1092 struct req_msg_field RMF_CONN =
1093         DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1094 EXPORT_SYMBOL(RMF_CONN);
1095
1096 struct req_msg_field RMF_CONNECT_DATA =
1097         DEFINE_MSGF("cdata",
1098                     RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1099                     sizeof(struct obd_connect_data),
1100                     lustre_swab_connect, NULL);
1101 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1102
1103 struct req_msg_field RMF_DLM_REQ =
1104         DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1105                     sizeof(struct ldlm_request),
1106                     lustre_swab_ldlm_request, NULL);
1107 EXPORT_SYMBOL(RMF_DLM_REQ);
1108
1109 struct req_msg_field RMF_DLM_REP =
1110         DEFINE_MSGF("dlm_rep", 0,
1111                     sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1112 EXPORT_SYMBOL(RMF_DLM_REP);
1113
1114 struct req_msg_field RMF_LDLM_INTENT =
1115         DEFINE_MSGF("ldlm_intent", 0,
1116                     sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1117 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1118
1119 struct req_msg_field RMF_DLM_LVB =
1120         DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1121 EXPORT_SYMBOL(RMF_DLM_LVB);
1122
1123 struct req_msg_field RMF_DLM_GL_DESC =
1124         DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1125 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1126
1127 struct req_msg_field RMF_MDT_MD =
1128         DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1129 EXPORT_SYMBOL(RMF_MDT_MD);
1130
1131 struct req_msg_field RMF_DEFAULT_MDT_MD =
1132         DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1133                     NULL);
1134 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1135
1136 struct req_msg_field RMF_REC_REINT =
1137         DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1138                     lustre_swab_mdt_rec_reint, NULL);
1139 EXPORT_SYMBOL(RMF_REC_REINT);
1140
1141 /* FIXME: this length should be defined as a macro */
1142 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1143                                                     NULL, NULL);
1144 EXPORT_SYMBOL(RMF_EADATA);
1145
1146 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1147 EXPORT_SYMBOL(RMF_EAVALS);
1148
1149 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1150 EXPORT_SYMBOL(RMF_ACL);
1151
1152 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1153 struct req_msg_field RMF_LOGCOOKIES =
1154         DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1155                     sizeof(struct llog_cookie), NULL, NULL);
1156 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1157
1158 struct req_msg_field RMF_CAPA1 =
1159         DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1160 EXPORT_SYMBOL(RMF_CAPA1);
1161
1162 struct req_msg_field RMF_CAPA2 =
1163         DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1164 EXPORT_SYMBOL(RMF_CAPA2);
1165
1166 struct req_msg_field RMF_LAYOUT_INTENT =
1167         DEFINE_MSGF("layout_intent", 0,
1168                     sizeof(struct layout_intent), lustre_swab_layout_intent,
1169                     NULL);
1170 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1171
1172 struct req_msg_field RMF_SELINUX_POL =
1173         DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1174 EXPORT_SYMBOL(RMF_SELINUX_POL);
1175
1176 /*
1177  * OST request field.
1178  */
1179 struct req_msg_field RMF_OST_BODY =
1180         DEFINE_MSGF("ost_body", 0,
1181                     sizeof(struct ost_body), lustre_swab_ost_body,
1182                     dump_ost_body);
1183 EXPORT_SYMBOL(RMF_OST_BODY);
1184
1185 struct req_msg_field RMF_OBD_IOOBJ =
1186         DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1187                     sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1188 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1189
1190 struct req_msg_field RMF_NIOBUF_REMOTE =
1191         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1192                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1193                     dump_rniobuf);
1194 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1195
1196 struct req_msg_field RMF_NIOBUF_INLINE =
1197         DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1198                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1199                     dump_rniobuf);
1200 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1201
1202 struct req_msg_field RMF_RCS =
1203         DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1204                     lustre_swab_generic_32s, dump_rcs);
1205 EXPORT_SYMBOL(RMF_RCS);
1206
1207 struct req_msg_field RMF_EAVALS_LENS =
1208         DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1209                 lustre_swab_generic_32s, NULL);
1210 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1211
1212 struct req_msg_field RMF_OBD_ID =
1213         DEFINE_MSGF("obd_id", 0,
1214                     sizeof(__u64), lustre_swab_ost_last_id, NULL);
1215 EXPORT_SYMBOL(RMF_OBD_ID);
1216
1217 struct req_msg_field RMF_FID =
1218         DEFINE_MSGF("fid", 0,
1219                     sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1220 EXPORT_SYMBOL(RMF_FID);
1221
1222 struct req_msg_field RMF_OST_ID =
1223         DEFINE_MSGF("ost_id", 0,
1224                     sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1225 EXPORT_SYMBOL(RMF_OST_ID);
1226
1227 struct req_msg_field RMF_FIEMAP_KEY =
1228         DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1229                     lustre_swab_fiemap_info_key, NULL);
1230 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1231
1232 struct req_msg_field RMF_FIEMAP_VAL =
1233         DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1234 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1235
1236 struct req_msg_field RMF_IDX_INFO =
1237         DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1238                     lustre_swab_idx_info, NULL);
1239 EXPORT_SYMBOL(RMF_IDX_INFO);
1240 struct req_msg_field RMF_SHORT_IO =
1241         DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1242 EXPORT_SYMBOL(RMF_SHORT_IO);
1243 struct req_msg_field RMF_HSM_USER_STATE =
1244         DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1245                     lustre_swab_hsm_user_state, NULL);
1246 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1247
1248 struct req_msg_field RMF_HSM_STATE_SET =
1249         DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1250                     lustre_swab_hsm_state_set, NULL);
1251 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1252
1253 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1254         DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1255                     lustre_swab_hsm_progress_kernel, NULL);
1256 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1257
1258 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1259         DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1260                     lustre_swab_hsm_current_action, NULL);
1261 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1262
1263 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1264         DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1265                     sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1266                     NULL);
1267 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1268
1269 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1270         DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1271                     sizeof(__u32), lustre_swab_generic_32s, NULL);
1272 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1273
1274 struct req_msg_field RMF_MDS_HSM_REQUEST =
1275         DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1276                     lustre_swab_hsm_request, NULL);
1277 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1278
1279 struct req_msg_field RMF_SWAP_LAYOUTS =
1280         DEFINE_MSGF("swap_layouts", 0, sizeof(struct  mdc_swap_layouts),
1281                     lustre_swab_swap_layouts, NULL);
1282 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1283
1284 struct req_msg_field RMF_LFSCK_REQUEST =
1285         DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1286                     lustre_swab_lfsck_request, NULL);
1287 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1288
1289 struct req_msg_field RMF_LFSCK_REPLY =
1290         DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1291                     lustre_swab_lfsck_reply, NULL);
1292 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1293
1294 struct req_msg_field RMF_OST_LADVISE_HDR =
1295         DEFINE_MSGF("ladvise_request", 0,
1296                     sizeof(struct ladvise_hdr),
1297                     lustre_swab_ladvise_hdr, NULL);
1298 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1299
1300 struct req_msg_field RMF_OST_LADVISE =
1301         DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1302                     sizeof(struct lu_ladvise),
1303                     lustre_swab_ladvise, NULL);
1304 EXPORT_SYMBOL(RMF_OST_LADVISE);
1305
1306 /*
1307  * Request formats.
1308  */
1309
1310 struct req_format {
1311         const char *rf_name;
1312         size_t      rf_idx;
1313         struct {
1314                 size_t                       nr;
1315                 const struct req_msg_field **d;
1316         } rf_fields[RCL_NR];
1317 };
1318
1319 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) {    \
1320         .rf_name   = name,                                              \
1321         .rf_fields = {                                                  \
1322                 [RCL_CLIENT] = {                                        \
1323                         .nr = client_nr,                                \
1324                         .d  = client                                    \
1325                 },                                                      \
1326                 [RCL_SERVER] = {                                        \
1327                         .nr = server_nr,                                \
1328                         .d  = server                                    \
1329                 }                                                       \
1330         }                                                               \
1331 }
1332
1333 #define DEFINE_REQ_FMT0(name, client, server)                                  \
1334 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1335
1336 struct req_format RQF_OBD_PING =
1337         DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1338 EXPORT_SYMBOL(RQF_OBD_PING);
1339
1340 struct req_format RQF_OBD_SET_INFO =
1341         DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1342 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1343
1344 struct req_format RQF_MDT_SET_INFO =
1345         DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1346 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1347
1348 /* Read index file through the network */
1349 struct req_format RQF_OBD_IDX_READ =
1350         DEFINE_REQ_FMT0("OBD_IDX_READ",
1351                         obd_idx_read_client, obd_idx_read_server);
1352 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1353
1354 struct req_format RQF_SEC_CTX =
1355         DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1356 EXPORT_SYMBOL(RQF_SEC_CTX);
1357
1358 struct req_format RQF_MGS_TARGET_REG =
1359         DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1360                          mgs_target_info_only);
1361 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1362
1363 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1364 struct req_format RQF_MGS_SET_INFO =
1365         DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1366                         mgs_set_info);
1367 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1368 #endif
1369
1370 struct req_format RQF_MGS_CONFIG_READ =
1371         DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1372                          mgs_config_read_server);
1373 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1374
1375 struct req_format RQF_SEQ_QUERY =
1376         DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1377 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1378
1379 struct req_format RQF_FLD_QUERY =
1380         DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1381 EXPORT_SYMBOL(RQF_FLD_QUERY);
1382
1383 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1384  * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1385  * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1386  * peers need to handle the RPC reply with fixed little-endian format.
1387  *
1388  * In theory, we can define new structure with some swabber registered to
1389  * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1390  * implementation view, it is not easy to be done within current "struct
1391  * req_msg_field" framework. Because the sequence range array in the RPC
1392  * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1393  * count, that is unknown when prepare the RPC buffer. Generally, for such
1394  * flexible length RPC usage, there will be a field in the RPC layout to
1395  * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1396  * do that unless we add new length filed that will broken the on-wire RPC
1397  * protocol and cause interoperability trouble with old peer. */
1398 struct req_format RQF_FLD_READ =
1399         DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1400 EXPORT_SYMBOL(RQF_FLD_READ);
1401
1402 struct req_format RQF_MDS_QUOTACTL =
1403         DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1404 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1405
1406 struct req_format RQF_OST_QUOTACTL =
1407         DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1408 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1409
1410 struct req_format RQF_QUOTA_DQACQ =
1411         DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1412 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1413
1414 struct req_format RQF_LDLM_INTENT_QUOTA =
1415         DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1416                         ldlm_intent_quota_client,
1417                         ldlm_intent_quota_server);
1418 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1419
1420 struct req_format RQF_MDS_GET_ROOT =
1421         DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1422 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1423
1424 struct req_format RQF_MDS_STATFS =
1425         DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1426 EXPORT_SYMBOL(RQF_MDS_STATFS);
1427
1428 struct req_format RQF_MDS_STATFS_NEW =
1429         DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1430 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1431
1432 struct req_format RQF_MDS_SYNC =
1433         DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1434 EXPORT_SYMBOL(RQF_MDS_SYNC);
1435
1436 struct req_format RQF_MDS_GETATTR =
1437         DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1438 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1439
1440 struct req_format RQF_MDS_GETXATTR =
1441         DEFINE_REQ_FMT0("MDS_GETXATTR",
1442                         mds_getxattr_client, mds_getxattr_server);
1443 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1444
1445 struct req_format RQF_MDS_GETATTR_NAME =
1446         DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1447                         mds_getattr_name_client, mds_getattr_server);
1448 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1449
1450 struct req_format RQF_MDS_REINT =
1451         DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1452 EXPORT_SYMBOL(RQF_MDS_REINT);
1453
1454 struct req_format RQF_MDS_REINT_CREATE =
1455         DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1456                         mds_reint_create_client, mdt_body_capa);
1457 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1458
1459 struct req_format RQF_MDS_REINT_CREATE_ACL =
1460         DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1461                         mds_reint_create_acl_client, mdt_body_capa);
1462 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1463
1464 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1465         DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1466                         mds_reint_create_slave_client, mdt_body_capa);
1467 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1468
1469 struct req_format RQF_MDS_REINT_CREATE_SYM =
1470         DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1471                         mds_reint_create_sym_client, mdt_body_capa);
1472 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1473
1474 struct req_format RQF_MDS_REINT_OPEN =
1475         DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1476                         mds_reint_open_client, mds_reint_open_server);
1477 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1478
1479 struct req_format RQF_MDS_REINT_UNLINK =
1480         DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1481                         mds_last_unlink_server);
1482 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1483
1484 struct req_format RQF_MDS_REINT_LINK =
1485         DEFINE_REQ_FMT0("MDS_REINT_LINK",
1486                         mds_reint_link_client, mdt_body_only);
1487 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1488
1489 struct req_format RQF_MDS_REINT_RENAME =
1490         DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1491                         mds_last_unlink_server);
1492 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1493
1494 struct req_format RQF_MDS_REINT_MIGRATE =
1495         DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1496                         mds_last_unlink_server);
1497 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1498
1499 struct req_format RQF_MDS_REINT_SETATTR =
1500         DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1501                         mds_reint_setattr_client, mds_setattr_server);
1502 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1503
1504 struct req_format RQF_MDS_REINT_SETXATTR =
1505         DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1506                         mds_reint_setxattr_client, mdt_body_only);
1507 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1508
1509 struct req_format RQF_MDS_REINT_RESYNC =
1510         DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1511 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1512
1513 struct req_format RQF_MDS_CONNECT =
1514         DEFINE_REQ_FMT0("MDS_CONNECT",
1515                         obd_connect_client, obd_connect_server);
1516 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1517
1518 struct req_format RQF_MDS_DISCONNECT =
1519         DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1520 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1521
1522 struct req_format RQF_MDS_GET_INFO =
1523         DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1524                         mds_getinfo_server);
1525 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1526
1527 struct req_format RQF_LDLM_ENQUEUE =
1528         DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1529                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1530 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1531
1532 struct req_format RQF_LDLM_ENQUEUE_LVB =
1533         DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1534                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1535 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1536
1537 struct req_format RQF_LDLM_CONVERT =
1538         DEFINE_REQ_FMT0("LDLM_CONVERT",
1539                         ldlm_enqueue_client, ldlm_enqueue_server);
1540 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1541
1542 struct req_format RQF_LDLM_CANCEL =
1543         DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1544 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1545
1546 struct req_format RQF_LDLM_CALLBACK =
1547         DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1548 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1549
1550 struct req_format RQF_LDLM_CP_CALLBACK =
1551         DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1552 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1553
1554 struct req_format RQF_LDLM_BL_CALLBACK =
1555         DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1556 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1557
1558 struct req_format RQF_LDLM_GL_CALLBACK =
1559         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1560                         ldlm_gl_callback_server);
1561 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1562
1563 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1564         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1565                         ldlm_gl_callback_server);
1566 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1567
1568 struct req_format RQF_LDLM_INTENT_BASIC =
1569         DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1570                         ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1571 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1572
1573 struct req_format RQF_LDLM_INTENT =
1574         DEFINE_REQ_FMT0("LDLM_INTENT",
1575                         ldlm_intent_client, ldlm_intent_server);
1576 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1577
1578 struct req_format RQF_LDLM_INTENT_LAYOUT =
1579         DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1580                         ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1581 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1582
1583 struct req_format RQF_LDLM_INTENT_GETATTR =
1584         DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1585                         ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1586 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1587
1588 struct req_format RQF_LDLM_INTENT_OPEN =
1589         DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1590                         ldlm_intent_open_client, ldlm_intent_open_server);
1591 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1592
1593 struct req_format RQF_LDLM_INTENT_CREATE =
1594         DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1595                         ldlm_intent_create_client, ldlm_intent_getattr_server);
1596 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1597
1598 struct req_format RQF_LDLM_INTENT_GETXATTR =
1599         DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1600                         ldlm_intent_getxattr_client,
1601                         ldlm_intent_getxattr_server);
1602 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1603
1604 struct req_format RQF_MDS_CLOSE =
1605         DEFINE_REQ_FMT0("MDS_CLOSE",
1606                         mdt_close_client, mds_last_unlink_server);
1607 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1608
1609 struct req_format RQF_MDS_CLOSE_INTENT =
1610         DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1611                         mdt_close_intent_client, mds_last_unlink_server);
1612 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1613
1614 struct req_format RQF_MDS_READPAGE =
1615         DEFINE_REQ_FMT0("MDS_READPAGE",
1616                         mdt_body_capa, mdt_body_only);
1617 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1618
1619 struct req_format RQF_MDS_HSM_ACTION =
1620         DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1621 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1622
1623 struct req_format RQF_MDS_HSM_PROGRESS =
1624         DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1625 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1626
1627 struct req_format RQF_MDS_HSM_CT_REGISTER =
1628         DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1629 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1630
1631 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1632         DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1633 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1634
1635 struct req_format RQF_MDS_HSM_STATE_GET =
1636         DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1637                         mdt_body_capa, mdt_hsm_state_get_server);
1638 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1639
1640 struct req_format RQF_MDS_HSM_STATE_SET =
1641         DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1642 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1643
1644 struct req_format RQF_MDS_HSM_REQUEST =
1645         DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1646 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1647
1648 struct req_format RQF_MDS_SWAP_LAYOUTS =
1649         DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1650                         mdt_swap_layouts, empty);
1651 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1652
1653 struct req_format RQF_MDS_RMFID =
1654         DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1655                         mds_rmfid_server);
1656 EXPORT_SYMBOL(RQF_MDS_RMFID);
1657
1658 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1659         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1660                         llog_origin_handle_create_client, llogd_body_only);
1661 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1662
1663 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1664         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1665                         llogd_body_only, llog_origin_handle_next_block_server);
1666 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1667
1668 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1669         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1670                         llogd_body_only, llog_origin_handle_next_block_server);
1671 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1672
1673 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1674         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1675                         llogd_body_only, llog_log_hdr_only);
1676 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1677
1678 struct req_format RQF_CONNECT =
1679         DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1680 EXPORT_SYMBOL(RQF_CONNECT);
1681
1682 struct req_format RQF_OST_CONNECT =
1683         DEFINE_REQ_FMT0("OST_CONNECT",
1684                         obd_connect_client, obd_connect_server);
1685 EXPORT_SYMBOL(RQF_OST_CONNECT);
1686
1687 struct req_format RQF_OST_DISCONNECT =
1688         DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1689 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1690
1691 struct req_format RQF_OST_GETATTR =
1692         DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1693 EXPORT_SYMBOL(RQF_OST_GETATTR);
1694
1695 struct req_format RQF_OST_SETATTR =
1696         DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1697 EXPORT_SYMBOL(RQF_OST_SETATTR);
1698
1699 struct req_format RQF_OST_CREATE =
1700         DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1701 EXPORT_SYMBOL(RQF_OST_CREATE);
1702
1703 struct req_format RQF_OST_PUNCH =
1704         DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1705 EXPORT_SYMBOL(RQF_OST_PUNCH);
1706
1707 struct req_format RQF_OST_FALLOCATE =
1708         DEFINE_REQ_FMT0("OST_FALLOCATE", ost_body_capa, ost_body_only);
1709 EXPORT_SYMBOL(RQF_OST_FALLOCATE);
1710
1711 struct req_format RQF_OST_SEEK =
1712         DEFINE_REQ_FMT0("OST_SEEK", ost_body_only, ost_body_only);
1713 EXPORT_SYMBOL(RQF_OST_SEEK);
1714
1715 struct req_format RQF_OST_SYNC =
1716         DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1717 EXPORT_SYMBOL(RQF_OST_SYNC);
1718
1719 struct req_format RQF_OST_DESTROY =
1720         DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1721 EXPORT_SYMBOL(RQF_OST_DESTROY);
1722
1723 struct req_format RQF_OST_BRW_READ =
1724         DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1725 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1726
1727 struct req_format RQF_OST_BRW_WRITE =
1728         DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1729 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1730
1731 struct req_format RQF_OST_STATFS =
1732         DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1733 EXPORT_SYMBOL(RQF_OST_STATFS);
1734
1735 struct req_format RQF_OST_SET_GRANT_INFO =
1736         DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1737                          ost_body_only);
1738 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1739
1740 struct req_format RQF_OST_GET_INFO =
1741         DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1742                                         ost_get_info_generic_server);
1743 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1744
1745 struct req_format RQF_OST_GET_INFO_LAST_ID =
1746         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1747                                                 ost_get_last_id_server);
1748 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1749
1750 struct req_format RQF_OST_GET_INFO_LAST_FID =
1751         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1752                                                  ost_get_last_fid_server);
1753 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1754
1755 struct req_format RQF_OST_SET_INFO_LAST_FID =
1756         DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1757                                                  empty);
1758 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1759
1760 struct req_format RQF_OST_GET_INFO_FIEMAP =
1761         DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1762                                                ost_get_fiemap_server);
1763 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1764
1765 struct req_format RQF_LFSCK_NOTIFY =
1766         DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1767 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1768
1769 struct req_format RQF_LFSCK_QUERY =
1770         DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1771 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1772
1773 struct req_format RQF_OST_LADVISE =
1774         DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1775 EXPORT_SYMBOL(RQF_OST_LADVISE);
1776
1777 /* Convenience macro */
1778 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1779
1780 /**
1781  * Initializes the capsule abstraction by computing and setting the \a rf_idx
1782  * field of RQFs and the \a rmf_offset field of RMFs.
1783  */
1784 int req_layout_init(void)
1785 {
1786         size_t i;
1787         size_t j;
1788         size_t k;
1789         struct req_format *rf = NULL;
1790
1791         for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1792                 rf = req_formats[i];
1793                 rf->rf_idx = i;
1794                 for (j = 0; j < RCL_NR; ++j) {
1795                         LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1796                         for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1797                                 struct req_msg_field *field;
1798
1799                                 field = (typeof(field))rf->rf_fields[j].d[k];
1800                                 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1801                                         || field->rmf_size > 0);
1802                                 LASSERT(field->rmf_offset[i][j] == 0);
1803                                 /*
1804                                  * k + 1 to detect unused format/field
1805                                  * combinations.
1806                                  */
1807                                 field->rmf_offset[i][j] = k + 1;
1808                         }
1809                 }
1810         }
1811         return 0;
1812 }
1813 EXPORT_SYMBOL(req_layout_init);
1814
1815 void req_layout_fini(void)
1816 {
1817 }
1818 EXPORT_SYMBOL(req_layout_fini);
1819
1820 /**
1821  * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1822  *
1823  * Actual/expected field sizes are set elsewhere in functions in this file:
1824  * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1825  * req_capsule_msg_size().  The \a rc_area information is used by.
1826  * ptlrpc_request_set_replen().
1827  */
1828 void req_capsule_init_area(struct req_capsule *pill)
1829 {
1830         size_t i;
1831
1832         for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1833                 pill->rc_area[RCL_CLIENT][i] = -1;
1834                 pill->rc_area[RCL_SERVER][i] = -1;
1835         }
1836 }
1837 EXPORT_SYMBOL(req_capsule_init_area);
1838
1839 /**
1840  * Initialize a pill.
1841  *
1842  * The \a location indicates whether the caller is executing on the client side
1843  * (RCL_CLIENT) or server side (RCL_SERVER)..
1844  */
1845 void req_capsule_init(struct req_capsule *pill,
1846                       struct ptlrpc_request *req,
1847                       enum req_location location)
1848 {
1849         LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1850
1851         /*
1852          * Today all capsules are embedded in ptlrpc_request structs,
1853          * but just in case that ever isn't the case, we don't reach
1854          * into req unless req != NULL and pill is the one embedded in
1855          * the req.
1856          *
1857          * The req->rq_pill_init flag makes it safe to initialize a pill
1858          * twice, which might happen in the OST paths as a result of the
1859          * high-priority RPC queue getting peeked at before ost_handle()
1860          * handles an OST RPC.
1861          */
1862         if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1863                 return;
1864
1865         pill->rc_fmt = NULL;
1866         pill->rc_req = req;
1867         pill->rc_loc = location;
1868         req_capsule_init_area(pill);
1869
1870         if (req != NULL && pill == &req->rq_pill)
1871                 req->rq_pill_init = 1;
1872 }
1873 EXPORT_SYMBOL(req_capsule_init);
1874
1875 void req_capsule_fini(struct req_capsule *pill)
1876 {
1877 }
1878 EXPORT_SYMBOL(req_capsule_fini);
1879
1880 static int __req_format_is_sane(const struct req_format *fmt)
1881 {
1882         return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1883                 req_formats[fmt->rf_idx] == fmt;
1884 }
1885
1886 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1887                                     enum req_location loc)
1888 {
1889         return loc == RCL_CLIENT ? pill->rc_reqmsg : pill->rc_repmsg;
1890 }
1891
1892 /**
1893  * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1894  * (see req_capsule_extend()).
1895  */
1896 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1897 {
1898         LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1899         LASSERT(__req_format_is_sane(fmt));
1900
1901         pill->rc_fmt = fmt;
1902 }
1903 EXPORT_SYMBOL(req_capsule_set);
1904
1905 /**
1906  * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1907  * yet.
1908
1909  * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1910  * variable-sized fields.  The field sizes come from the declared \a rmf_size
1911  * field of a \a pill's \a rc_fmt's RMF's.
1912  */
1913 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1914                                 enum req_location loc)
1915 {
1916         const struct req_format *fmt = pill->rc_fmt;
1917         size_t                   i;
1918
1919         LASSERT(fmt != NULL);
1920
1921         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1922                 if (pill->rc_area[loc][i] == -1) {
1923                         pill->rc_area[loc][i] =
1924                                             fmt->rf_fields[loc].d[i]->rmf_size;
1925                         if (pill->rc_area[loc][i] == -1) {
1926                                 /*
1927                                  * Skip the following fields.
1928                                  *
1929                                  * If this LASSERT() trips then you're missing a
1930                                  * call to req_capsule_set_size().
1931                                  */
1932                                 LASSERT(loc != RCL_SERVER);
1933                                 break;
1934                         }
1935                 }
1936         }
1937         return i;
1938 }
1939 EXPORT_SYMBOL(req_capsule_filled_sizes);
1940
1941 /**
1942  * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1943  *
1944  * This function uses the \a pill's \a rc_area as filled in by
1945  * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1946  * this function).
1947  */
1948 int req_capsule_server_pack(struct req_capsule *pill)
1949 {
1950         const struct req_format *fmt;
1951         int count;
1952         int rc;
1953
1954         LASSERT(pill->rc_loc == RCL_SERVER);
1955         fmt = pill->rc_fmt;
1956         LASSERT(fmt != NULL);
1957
1958         count = req_capsule_filled_sizes(pill, RCL_SERVER);
1959         rc = lustre_pack_reply(pill->rc_req, count,
1960                                pill->rc_area[RCL_SERVER], NULL);
1961         if (rc != 0) {
1962                 DEBUG_REQ(D_ERROR, pill->rc_req,
1963                           "Cannot pack %d fields in format '%s'",
1964                           count, fmt->rf_name);
1965         }
1966         return rc;
1967 }
1968 EXPORT_SYMBOL(req_capsule_server_pack);
1969
1970 /**
1971  * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1972  * corresponding to the given RMF (\a field).
1973  */
1974 __u32 __req_capsule_offset(const struct req_capsule *pill,
1975                            const struct req_msg_field *field,
1976                            enum req_location loc)
1977 {
1978         unsigned int offset;
1979
1980         offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1981         LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1982                              pill->rc_fmt->rf_name,
1983                              field->rmf_name, offset, loc);
1984         offset--;
1985
1986         LASSERT(offset < REQ_MAX_FIELD_NR);
1987         return offset;
1988 }
1989
1990 void req_capsule_set_swabbed(struct req_capsule *pill, enum req_location loc,
1991                             __u32 index)
1992 {
1993         if (loc == RCL_CLIENT)
1994                 req_capsule_set_req_swabbed(pill, index);
1995         else
1996                 req_capsule_set_rep_swabbed(pill, index);
1997 }
1998
1999 bool req_capsule_need_swab(struct req_capsule *pill, enum req_location loc,
2000                            __u32 index)
2001 {
2002         if (loc == RCL_CLIENT)
2003                 return (req_capsule_req_need_swab(pill) &&
2004                         !req_capsule_req_swabbed(pill, index));
2005
2006         return (req_capsule_rep_need_swab(pill) &&
2007                !req_capsule_rep_swabbed(pill, index));
2008 }
2009
2010 /**
2011  * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
2012  * them if desired.
2013  */
2014 static int
2015 swabber_dumper_helper(struct req_capsule *pill,
2016                       const struct req_msg_field *field,
2017                       enum req_location loc,
2018                       int offset,
2019                       void *value, int len, bool dump, void (*swabber)(void *))
2020 {
2021         void *p;
2022         int i;
2023         int n;
2024         int size;
2025         int rc = 0;
2026         bool do_swab;
2027         bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2028
2029         swabber = swabber ?: field->rmf_swabber;
2030
2031         if (req_capsule_need_swab(pill, loc, offset) &&
2032             (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2033                 do_swab = true;
2034         else
2035                 do_swab = false;
2036
2037         if (!field->rmf_dumper)
2038                 dump = false;
2039
2040         /*
2041          * We're swabbing an array; swabber() swabs a single array element, so
2042          * swab every element.
2043          */
2044         if (array && (len % field->rmf_size)) {
2045                 static const struct req_msg_field *last_field;
2046
2047                 if (field != last_field) {
2048                         CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2049                                field->rmf_name, len, field->rmf_size);
2050                         last_field = field;
2051                 }
2052         }
2053         /* For the non-array cases, the process of swab/dump/swab only
2054          * needs to be done once. (n = 1)
2055          */
2056         if (!array)
2057                 len = field->rmf_size;
2058         for (p = value, i = 0, n = len / field->rmf_size;
2059              i < n;
2060              i++, p += field->rmf_size) {
2061                 if (dump) {
2062                         CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2063                                do_swab ? "unswabbed " : "",
2064                                array ? "array " : "",
2065                                field->rmf_name, i);
2066                         field->rmf_dumper(p);
2067                 }
2068                 if (!do_swab) {
2069                         if (array)
2070                                 continue;
2071                         else
2072                                 break;
2073                 }
2074                 if (!field->rmf_swab_len) {
2075                         swabber(p);
2076                 } else {
2077                         size = field->rmf_swab_len(p, len);
2078                         if (size > 0) {
2079                                 len -= size;
2080                         } else {
2081                                 rc = size;
2082                                 break;
2083                         }
2084                 }
2085                 if (dump) {
2086                         CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2087                                array ? "array " : "", field->rmf_name, i);
2088                         field->rmf_dumper(value);
2089                 }
2090         }
2091         if (do_swab)
2092                 req_capsule_set_swabbed(pill, loc, offset);
2093
2094         return rc;
2095 }
2096
2097 /**
2098  * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2099  * corresponding to the given RMF (\a field).
2100  *
2101  * The buffer will be swabbed using the given \a swabber.  If \a swabber == NULL
2102  * then the \a rmf_swabber from the RMF will be used.  Soon there will be no
2103  * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2104  * be removed.  Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2105  * element of the array swabbed.
2106  */
2107 static void *__req_capsule_get(struct req_capsule *pill,
2108                                const struct req_msg_field *field,
2109                                enum req_location loc,
2110                                void (*swabber)(void *),
2111                                bool dump)
2112 {
2113         const struct req_format *fmt;
2114         struct lustre_msg       *msg;
2115         void                    *value;
2116         __u32                    len;
2117         __u32                    offset;
2118
2119         void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2120
2121         static const char *rcl_names[RCL_NR] = {
2122                 [RCL_CLIENT] = "client",
2123                 [RCL_SERVER] = "server"
2124         };
2125
2126         LASSERT(pill != NULL);
2127         LASSERT(pill != LP_POISON);
2128         fmt = pill->rc_fmt;
2129         LASSERT(fmt != NULL);
2130         LASSERT(fmt != LP_POISON);
2131         LASSERT(__req_format_is_sane(fmt));
2132
2133         offset = __req_capsule_offset(pill, field, loc);
2134
2135         msg = __req_msg(pill, loc);
2136         LASSERT(msg != NULL);
2137
2138         getter = (field->rmf_flags & RMF_F_STRING) ?
2139                 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2140
2141         if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2142                 /*
2143                  * We've already asserted that field->rmf_size > 0 in
2144                  * req_layout_init().
2145                  */
2146                 len = lustre_msg_buflen(msg, offset);
2147                 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2148                     (len % field->rmf_size) != 0) {
2149                         CERROR("%s: array field size mismatch "
2150                                 "%d modulo %u != 0 (%d)\n",
2151                                 field->rmf_name, len, field->rmf_size, loc);
2152                         return NULL;
2153                 }
2154         } else if (pill->rc_area[loc][offset] != -1) {
2155                 len = pill->rc_area[loc][offset];
2156         } else {
2157                 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2158         }
2159         value = getter(msg, offset, len);
2160
2161         if (value == NULL) {
2162                 DEBUG_REQ(D_ERROR, pill->rc_req,
2163                           "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2164                           field->rmf_name, offset, lustre_msg_bufcount(msg),
2165                           fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2166                           rcl_names[loc]);
2167         } else {
2168                 swabber_dumper_helper(pill, field, loc, offset, value, len,
2169                                       dump, swabber);
2170         }
2171
2172         return value;
2173 }
2174
2175 /**
2176  * Dump a request and/or reply
2177  */
2178 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2179 {
2180         const struct req_format *fmt;
2181         const struct req_msg_field *field;
2182         __u32 len;
2183         size_t i;
2184
2185         fmt = pill->rc_fmt;
2186
2187         DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2188         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2189                 field = FMT_FIELD(fmt, loc, i);
2190                 if (field->rmf_dumper == NULL) {
2191                         /*
2192                          * FIXME Add a default hex dumper for fields that don't
2193                          * have a specific dumper
2194                          */
2195                         len = req_capsule_get_size(pill, field, loc);
2196                         CDEBUG(D_RPCTRACE,
2197                                "Field %s has no dumper function; field size is %u\n",
2198                                field->rmf_name, len);
2199                 } else {
2200                         /* It's dumping side-effect that we're interested in */
2201                         (void) __req_capsule_get(pill, field, loc, NULL, true);
2202                 }
2203         }
2204         CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2205 }
2206
2207 /**
2208  * Dump a request.
2209  */
2210 void req_capsule_client_dump(struct req_capsule *pill)
2211 {
2212         __req_capsule_dump(pill, RCL_CLIENT);
2213 }
2214 EXPORT_SYMBOL(req_capsule_client_dump);
2215
2216 /**
2217  * Dump a reply
2218  */
2219 void req_capsule_server_dump(struct req_capsule *pill)
2220 {
2221         __req_capsule_dump(pill, RCL_SERVER);
2222 }
2223 EXPORT_SYMBOL(req_capsule_server_dump);
2224
2225 /**
2226  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2227  * buffer corresponding to the given RMF (\a field) of a \a pill.
2228  */
2229 void *req_capsule_client_get(struct req_capsule *pill,
2230                              const struct req_msg_field *field)
2231 {
2232         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2233 }
2234 EXPORT_SYMBOL(req_capsule_client_get);
2235
2236 /**
2237  * Same as req_capsule_client_get(), but with a \a swabber argument.
2238  *
2239  * Currently unused; will be removed when req_capsule_server_swab_get() is
2240  * unused too.
2241  */
2242 void *req_capsule_client_swab_get(struct req_capsule *pill,
2243                                   const struct req_msg_field *field,
2244                                   void *swabber)
2245 {
2246         return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2247 }
2248 EXPORT_SYMBOL(req_capsule_client_swab_get);
2249
2250 /**
2251  * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2252  *
2253  * First the \a pill's request \a field's size is set (\a rc_area) using
2254  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2255  * returned.
2256  */
2257 void *req_capsule_client_sized_get(struct req_capsule *pill,
2258                                    const struct req_msg_field *field,
2259                                    __u32 len)
2260 {
2261         req_capsule_set_size(pill, field, RCL_CLIENT, len);
2262         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2263 }
2264 EXPORT_SYMBOL(req_capsule_client_sized_get);
2265
2266 /**
2267  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2268  * buffer corresponding to the given RMF (\a field) of a \a pill.
2269  */
2270 void *req_capsule_server_get(struct req_capsule *pill,
2271                              const struct req_msg_field *field)
2272 {
2273         return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2274 }
2275 EXPORT_SYMBOL(req_capsule_server_get);
2276
2277 /**
2278  * Same as req_capsule_server_get(), but with a \a swabber argument.
2279  *
2280  * Ideally all swabbing should be done pursuant to RMF definitions, with no
2281  * swabbing done outside this capsule abstraction.
2282  */
2283 void *req_capsule_server_swab_get(struct req_capsule *pill,
2284                                   const struct req_msg_field *field,
2285                                   void *swabber)
2286 {
2287         return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2288 }
2289 EXPORT_SYMBOL(req_capsule_server_swab_get);
2290
2291 /**
2292  * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2293  *
2294  * First the \a pill's request \a field's size is set (\a rc_area) using
2295  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2296  * returned.
2297  */
2298 void *req_capsule_server_sized_get(struct req_capsule *pill,
2299                                    const struct req_msg_field *field,
2300                                    __u32 len)
2301 {
2302         req_capsule_set_size(pill, field, RCL_SERVER, len);
2303         return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2304 }
2305 EXPORT_SYMBOL(req_capsule_server_sized_get);
2306
2307 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2308                                         const struct req_msg_field *field,
2309                                         __u32 len, void *swabber)
2310 {
2311         req_capsule_set_size(pill, field, RCL_SERVER, len);
2312         return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2313 }
2314 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2315
2316 /**
2317  * Returns the buffer of a \a pill corresponding to the given \a field from the
2318  * request (if the caller is executing on the server-side) or reply (if the
2319  * caller is executing on the client-side).
2320  *
2321  * This function convienient for use is code that could be executed on the
2322  * client and server alike.
2323  */
2324 const void *req_capsule_other_get(struct req_capsule *pill,
2325                                   const struct req_msg_field *field)
2326 {
2327         return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2328 }
2329 EXPORT_SYMBOL(req_capsule_other_get);
2330
2331 /**
2332  * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2333  * field of the given \a pill.
2334  *
2335  * This function must be used when constructing variable sized fields of a
2336  * request or reply.
2337  */
2338 void req_capsule_set_size(struct req_capsule *pill,
2339                           const struct req_msg_field *field,
2340                           enum req_location loc, __u32 size)
2341 {
2342         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2343
2344         if ((size != (__u32)field->rmf_size) &&
2345             (field->rmf_size != -1) &&
2346             !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2347             (size > 0)) {
2348                 __u32 rmf_size = (__u32)field->rmf_size;
2349                 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2350                     (size % rmf_size != 0)) {
2351                         CERROR("%s: array field size mismatch "
2352                                 "%u %% %u != 0 (%d)\n",
2353                                 field->rmf_name, size, rmf_size, loc);
2354                         LBUG();
2355                 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2356                            size < rmf_size) {
2357                         CERROR("%s: field size mismatch %u != %u (%d)\n",
2358                                 field->rmf_name, size, rmf_size, loc);
2359                         LBUG();
2360                 }
2361         }
2362
2363         pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2364 }
2365 EXPORT_SYMBOL(req_capsule_set_size);
2366
2367 /**
2368  * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2369  * for the given \a pill's given \a field.
2370  *
2371  * NB: this function doesn't correspond with req_capsule_set_size(), which
2372  * actually sets the size in pill.rc_area[loc][offset], but this function
2373  * returns the message buflen[offset], maybe we should use another name.
2374  */
2375 __u32 req_capsule_get_size(const struct req_capsule *pill,
2376                          const struct req_msg_field *field,
2377                          enum req_location loc)
2378 {
2379         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2380
2381         return lustre_msg_buflen(__req_msg(pill, loc),
2382                                  __req_capsule_offset(pill, field, loc));
2383 }
2384 EXPORT_SYMBOL(req_capsule_get_size);
2385
2386 /**
2387  * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2388  * given \a pill's request or reply (\a loc) given the field size recorded in
2389  * the \a pill's rc_area.
2390  *
2391  * See also req_capsule_set_size().
2392  */
2393 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2394 {
2395         return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2396                                pill->rc_fmt->rf_fields[loc].nr,
2397                                pill->rc_area[loc]);
2398 }
2399
2400 /**
2401  * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2402  * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2403  * PTLRPC request or reply given only an RQF (\a fmt).
2404  *
2405  * This function should not be used for formats which contain variable size
2406  * fields.
2407  */
2408 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2409                          enum req_location loc)
2410 {
2411         __u32 size;
2412         size_t i = 0;
2413
2414         /*
2415          * This function should probably LASSERT() that fmt has no fields with
2416          * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2417          * elements in the array there will ultimately be, but then, we could
2418          * assume that there will be at least one element, and that's just what
2419          * we do.
2420          */
2421         size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2422         if (size == 0)
2423                 return size;
2424
2425         for (; i < fmt->rf_fields[loc].nr; ++i)
2426                 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2427                         size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2428                                                rmf_size);
2429         return size;
2430 }
2431 EXPORT_SYMBOL(req_capsule_fmt_size);
2432
2433 /**
2434  * Changes the format of an RPC.
2435  *
2436  * The pill must already have been initialized, which means that it already has
2437  * a request format.  The new format \a fmt must be an extension of the pill's
2438  * old format.  Specifically: the new format must have as many request and reply
2439  * fields as the old one, and all fields shared by the old and new format must
2440  * be at least as large in the new format.
2441  *
2442  * The new format's fields may be of different "type" than the old format, but
2443  * only for fields that are "opaque" blobs: fields which have a) have no
2444  * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2445  * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK.  For example,
2446  * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2447  * according to the key field.  When the value, according to the key, contains a
2448  * structure (or array thereof) to be swabbed, the format should be changed to
2449  * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2450  * accordingly.
2451  */
2452 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2453 {
2454         int i;
2455         size_t j;
2456
2457         const struct req_format *old;
2458
2459         LASSERT(pill->rc_fmt != NULL);
2460         LASSERT(__req_format_is_sane(fmt));
2461
2462         old = pill->rc_fmt;
2463         /*
2464          * Sanity checking...
2465          */
2466         for (i = 0; i < RCL_NR; ++i) {
2467                 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2468                 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2469                         const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2470
2471                         /* "opaque" fields can be transmogrified */
2472                         if (ofield->rmf_swabber == NULL &&
2473                             (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2474                             (ofield->rmf_size == -1 ||
2475                             ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2476                                 continue;
2477                         LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2478                 }
2479                 /*
2480                  * Last field in old format can be shorter than in new.
2481                  */
2482                 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2483                         FMT_FIELD(old, i, j)->rmf_size);
2484         }
2485
2486         pill->rc_fmt = fmt;
2487 }
2488 EXPORT_SYMBOL(req_capsule_extend);
2489
2490 /**
2491  * This function returns a non-zero value if the given \a field is present in
2492  * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2493  * returns 0.
2494  */
2495 int req_capsule_has_field(const struct req_capsule *pill,
2496                           const struct req_msg_field *field,
2497                           enum req_location loc)
2498 {
2499         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2500
2501         return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2502 }
2503 EXPORT_SYMBOL(req_capsule_has_field);
2504
2505 /**
2506  * Returns a non-zero value if the given \a field is present in the given \a
2507  * pill's PTLRPC request or reply (\a loc), else it returns 0.
2508  */
2509 int req_capsule_field_present(const struct req_capsule *pill,
2510                               const struct req_msg_field *field,
2511                               enum req_location loc)
2512 {
2513         __u32 offset;
2514
2515         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2516         LASSERT(req_capsule_has_field(pill, field, loc));
2517
2518         offset = __req_capsule_offset(pill, field, loc);
2519         return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2520 }
2521 EXPORT_SYMBOL(req_capsule_field_present);
2522
2523 /**
2524  * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2525  * request or reply (\a loc).
2526  *
2527  * This is not the opposite of req_capsule_extend().
2528  */
2529 void req_capsule_shrink(struct req_capsule *pill,
2530                         const struct req_msg_field *field,
2531                         __u32 newlen,
2532                         enum req_location loc)
2533 {
2534         const struct req_format *fmt;
2535         struct lustre_msg       *msg;
2536         __u32                    len;
2537         int                      offset;
2538
2539         fmt = pill->rc_fmt;
2540         LASSERT(fmt != NULL);
2541         LASSERT(__req_format_is_sane(fmt));
2542         LASSERT(req_capsule_has_field(pill, field, loc));
2543         LASSERT(req_capsule_field_present(pill, field, loc));
2544
2545         offset = __req_capsule_offset(pill, field, loc);
2546
2547         msg = __req_msg(pill, loc);
2548         len = lustre_msg_buflen(msg, offset);
2549         LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2550                  fmt->rf_name, field->rmf_name, len, newlen);
2551
2552         if (loc == RCL_CLIENT) {
2553                 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2554                                                             1);
2555         } else {
2556                 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2557                                                             1);
2558                 /* update also field size in reply lenghts arrays for possible
2559                  * reply re-pack due to req_capsule_server_grow() call.
2560                  */
2561                 req_capsule_set_size(pill, field, loc, newlen);
2562         }
2563 }
2564 EXPORT_SYMBOL(req_capsule_shrink);
2565
2566 int req_capsule_server_grow(struct req_capsule *pill,
2567                             const struct req_msg_field *field,
2568                             __u32 newlen)
2569 {
2570         struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2571         char *from, *to;
2572         int rc;
2573         __u32 offset, len;
2574
2575         LASSERT(pill->rc_fmt != NULL);
2576         LASSERT(__req_format_is_sane(pill->rc_fmt));
2577         LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2578         LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2579
2580         len = req_capsule_get_size(pill, field, RCL_SERVER);
2581         offset = __req_capsule_offset(pill, field, RCL_SERVER);
2582
2583         CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2584                lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2585                                       len, newlen);
2586
2587         req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2588         /**
2589          * There can be enough space in current reply buffer, make sure
2590          * that rs_repbuf is not a wrapper but real reply msg, otherwise
2591          * re-packing is still needed.
2592          */
2593         if (rs->rs_msg == rs->rs_repbuf &&
2594             rs->rs_repbuf_len >=
2595             lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2596                 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2597                                                           newlen);
2598                 return 0;
2599         }
2600
2601         /* Re-allocate replay state */
2602         pill->rc_req->rq_reply_state = NULL;
2603         rc = req_capsule_server_pack(pill);
2604         if (rc) {
2605                 /* put old values back, the caller should decide what to do */
2606                 req_capsule_set_size(pill, field, RCL_SERVER, len);
2607                 pill->rc_req->rq_reply_state = rs;
2608                 return rc;
2609         }
2610         nrs = pill->rc_req->rq_reply_state;
2611         LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2612                 lustre_packed_msg_size(rs->rs_msg));
2613
2614         /* Now we need only buffers, copy them and grow the needed one */
2615         to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2616         from = lustre_msg_buf(rs->rs_msg, 0, 0);
2617         memcpy(to, from,
2618                (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from);
2619         lustre_msg_set_buflen(nrs->rs_msg, offset, len);
2620         pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2621
2622         if (rs->rs_difficult) {
2623                 /* copy rs data */
2624                 int i;
2625
2626                 nrs->rs_difficult = 1;
2627                 nrs->rs_no_ack = rs->rs_no_ack;
2628                 nrs->rs_convert_lock = rs->rs_convert_lock;
2629                 for (i = 0; i < rs->rs_nlocks; i++) {
2630                         nrs->rs_locks[i] = rs->rs_locks[i];
2631                         nrs->rs_modes[i] = rs->rs_modes[i];
2632                         nrs->rs_nlocks++;
2633                 }
2634                 rs->rs_nlocks = 0;
2635                 rs->rs_difficult = 0;
2636                 rs->rs_no_ack = 0;
2637         }
2638         ptlrpc_rs_decref(rs);
2639         return 0;
2640 }
2641 EXPORT_SYMBOL(req_capsule_server_grow);
2642
2643 #ifdef HAVE_SERVER_SUPPORT
2644 static const struct req_msg_field *mds_update_client[] = {
2645         &RMF_PTLRPC_BODY,
2646         &RMF_OUT_UPDATE_HEADER,
2647         &RMF_OUT_UPDATE_BUF,
2648 };
2649
2650 static const struct req_msg_field *mds_update_server[] = {
2651         &RMF_PTLRPC_BODY,
2652         &RMF_OUT_UPDATE_REPLY,
2653 };
2654
2655 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
2656                                 lustre_swab_object_update_request, NULL);
2657 EXPORT_SYMBOL(RMF_OUT_UPDATE);
2658
2659 struct req_msg_field RMF_OUT_UPDATE_REPLY =
2660                         DEFINE_MSGFL("object_update_reply", 0, -1,
2661                                     lustre_swab_object_update_reply, NULL);
2662 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
2663
2664 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
2665                                 -1, lustre_swab_out_update_header, NULL);
2666 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
2667
2668 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
2669                         RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
2670                         lustre_swab_out_update_buffer, NULL);
2671 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
2672
2673 struct req_format RQF_OUT_UPDATE =
2674         DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
2675                         mds_update_server);
2676 EXPORT_SYMBOL(RQF_OUT_UPDATE);
2677
2678 int req_check_sepol(struct req_capsule *pill)
2679 {
2680         int rc = 0;
2681         struct obd_export *export;
2682         struct lu_nodemap *nm = NULL;
2683         const char *sepol = NULL;
2684         const char *nm_sepol = NULL;
2685
2686         if (!pill->rc_req)
2687                 return -EPROTO;
2688
2689         export = pill->rc_req->rq_export;
2690         if (!export || !exp_connect_sepol(export) ||
2691             !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2692                 goto nm;
2693
2694         if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2695                 goto nm;
2696
2697         sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2698         CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2699
2700 nm:
2701         if (export) {
2702                 nm = nodemap_get_from_exp(export);
2703                 if (!IS_ERR_OR_NULL(nm)) {
2704                         nm_sepol = nodemap_get_sepol(nm);
2705                         if (nm_sepol && nm_sepol[0])
2706                                 if (sepol == NULL ||
2707                                     strcmp(sepol, nm_sepol) != 0)
2708                                         rc = -EACCES;
2709                 }
2710         }
2711
2712         if (!IS_ERR_OR_NULL(nm))
2713                 nodemap_putref(nm);
2714
2715         return rc;
2716 }
2717 EXPORT_SYMBOL(req_check_sepol);
2718 #endif