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