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