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