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