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