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