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