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