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