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