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