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