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