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