1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/ptlrpc/layout.c
5 * Lustre Metadata Target (mdt) request handler
7 * Copyright (c) 2006 Cluster File Systems, Inc.
8 * Author: Nikita Danilov <nikita@clusterfs.com>
10 * This file is part of the Lustre file system, http://www.lustre.org
11 * Lustre is a trademark of Cluster File Systems, Inc.
13 * You may have signed or agreed to another license before downloading
14 * this software. If so, you are bound by the terms and conditions
15 * of that agreement, and the following does not apply to you. See the
16 * LICENSE file included with this distribution for more information.
18 * If you did not agree to a different license, then this copy of Lustre
19 * is open source software; you can redistribute it and/or modify it
20 * under the terms of version 2 of the GNU General Public License as
21 * published by the Free Software Foundation.
23 * In either case, Lustre is distributed in the hope that it will be
24 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
25 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * license text for more details.
29 #if !defined(__REQ_LAYOUT_USER__)
32 # define EXPORT_SYMTAB
34 #define DEBUG_SUBSYSTEM S_RPC
37 #include <linux/module.h>
39 # include <liblustre.h>
42 /* LUSTRE_VERSION_CODE */
43 #include <lustre_ver.h>
45 #include <obd_support.h>
46 /* lustre_swab_mdt_body */
47 #include <lustre/lustre_idl.h>
48 /* obd2cli_tgt() (required by DEBUG_REQ()) */
51 /* __REQ_LAYOUT_USER__ */
53 /* struct ptlrpc_request, lustre_msg* */
54 #include <lustre_req_layout.h>
55 #include <linux/lustre_acl.h>
58 * empty set of fields... for suitable definition of emptiness.
60 static const struct req_msg_field *empty[] = {
64 static const struct req_msg_field *mdt_body_only[] = {
69 static const struct req_msg_field *mdt_body_capa[] = {
75 static const struct req_msg_field *mdt_close_client[] = {
82 static const struct req_msg_field *mds_statfs_server[] = {
87 static const struct req_msg_field *seq_query_client[] = {
93 static const struct req_msg_field *seq_query_server[] = {
98 static const struct req_msg_field *fld_query_client[] = {
104 static const struct req_msg_field *fld_query_server[] = {
109 static const struct req_msg_field *mds_getattr_name_client[] = {
116 static const struct req_msg_field *mds_reint_client[] = {
121 static const struct req_msg_field *mds_reint_create_client[] = {
128 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
137 static const struct req_msg_field *mds_reint_create_sym_client[] = {
146 static const struct req_msg_field *mds_reint_create_slave_client[] = {
154 static const struct req_msg_field *mds_reint_open_client[] = {
163 static const struct req_msg_field *mds_reint_open_server[] = {
172 static const struct req_msg_field *mds_reint_unlink_client[] = {
180 static const struct req_msg_field *mds_reint_link_client[] = {
189 static const struct req_msg_field *mds_reint_rename_client[] = {
199 static const struct req_msg_field *mds_last_unlink_server[] = {
206 static const struct req_msg_field *mds_reint_setattr_client[] = {
216 static const struct req_msg_field *mds_connect_client[] = {
224 static const struct req_msg_field *mds_connect_server[] = {
229 static const struct req_msg_field *mds_set_info_client[] = {
235 static const struct req_msg_field *ldlm_enqueue_client[] = {
240 static const struct req_msg_field *ldlm_enqueue_server[] = {
245 static const struct req_msg_field *ldlm_intent_client[] = {
252 static const struct req_msg_field *ldlm_intent_server[] = {
261 static const struct req_msg_field *ldlm_intent_open_server[] = {
271 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
275 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
280 static const struct req_msg_field *ldlm_intent_create_client[] = {
284 &RMF_REC_CREATE, /* coincides with mds_reint_create_client[] */
290 static const struct req_msg_field *ldlm_intent_open_client[] = {
294 &RMF_REC_CREATE, /* coincides with mds_reint_open_client[] */
301 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
305 &RMF_REC_UNLINK, /* coincides with mds_reint_unlink_client[] */
310 static const struct req_msg_field *mds_getxattr_client[] = {
318 static const struct req_msg_field *mds_getxattr_server[] = {
324 static const struct req_msg_field *mds_setxattr_client[] = {
332 static const struct req_msg_field *mds_setxattr_server[] = {
336 static const struct req_msg_field *mds_getattr_server[] = {
344 static const struct req_format *req_formats[] = {
351 &RQF_MDS_GETATTR_NAME,
353 &RQF_MDS_REINT_CREATE,
354 &RQF_MDS_REINT_CREATE_RMT_ACL,
355 &RQF_MDS_REINT_CREATE_SYM,
356 &RQF_MDS_REINT_CREATE_SLAVE,
358 &RQF_MDS_REINT_UNLINK,
360 &RQF_MDS_REINT_RENAME,
361 &RQF_MDS_REINT_SETATTR,
364 &RQF_LDLM_INTENT_GETATTR,
365 &RQF_LDLM_INTENT_OPEN,
366 &RQF_LDLM_INTENT_CREATE,
367 &RQF_LDLM_INTENT_UNLINK,
378 &RQF_MDS_DONE_WRITING
381 struct req_msg_field {
383 const char *rmf_name;
385 * Field length. (-1) means "variable length".
388 void (*rmf_swabber)(void *);
389 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
393 RMF_F_STRING = 1 << 0
401 #define DEFINE_MSGF(name, flags, size, swabber) { \
402 .rmf_name = (name), \
403 .rmf_flags = (flags), \
404 .rmf_size = (size), \
405 .rmf_swabber = (void (*)(void*))(swabber) \
408 const struct req_msg_field RMF_SETINFO_VAL =
409 DEFINE_MSGF("setinfo_val", 0,
410 sizeof(__u32), lustre_swab_generic_32s);
411 EXPORT_SYMBOL(RMF_SETINFO_VAL);
413 const struct req_msg_field RMF_SEQ_OPC =
414 DEFINE_MSGF("seq_query_opc", 0,
415 sizeof(__u32), lustre_swab_generic_32s);
416 EXPORT_SYMBOL(RMF_SEQ_OPC);
418 const struct req_msg_field RMF_SEQ_RANGE =
419 DEFINE_MSGF("seq_query_range", 0,
420 sizeof(struct lu_range), lustre_swab_lu_range);
421 EXPORT_SYMBOL(RMF_SEQ_RANGE);
423 const struct req_msg_field RMF_FLD_OPC =
424 DEFINE_MSGF("fld_query_opc", 0,
425 sizeof(__u32), lustre_swab_generic_32s);
426 EXPORT_SYMBOL(RMF_FLD_OPC);
428 const struct req_msg_field RMF_FLD_MDFLD =
429 DEFINE_MSGF("fld_query_mdfld", 0,
430 sizeof(struct md_fld), lustre_swab_md_fld);
431 EXPORT_SYMBOL(RMF_FLD_MDFLD);
433 const struct req_msg_field RMF_MDT_BODY =
434 DEFINE_MSGF("mdt_body", 0,
435 sizeof(struct mdt_body), lustre_swab_mdt_body);
436 EXPORT_SYMBOL(RMF_MDT_BODY);
438 const struct req_msg_field RMF_MDT_EPOCH =
439 DEFINE_MSGF("mdt_epoch", 0,
440 sizeof(struct mdt_epoch), lustre_swab_mdt_epoch);
441 EXPORT_SYMBOL(RMF_MDT_EPOCH);
443 const struct req_msg_field RMF_PTLRPC_BODY =
444 DEFINE_MSGF("ptlrpc_body", 0,
445 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body);
446 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
448 const struct req_msg_field RMF_OBD_STATFS =
449 DEFINE_MSGF("obd_statfs", 0,
450 sizeof(struct obd_statfs), lustre_swab_obd_statfs);
451 EXPORT_SYMBOL(RMF_OBD_STATFS);
453 const struct req_msg_field RMF_SETINFO_KEY =
454 DEFINE_MSGF("setinfo_key", 0, -1, NULL);
455 EXPORT_SYMBOL(RMF_SETINFO_KEY);
457 const struct req_msg_field RMF_NAME =
458 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL);
459 EXPORT_SYMBOL(RMF_NAME);
461 const struct req_msg_field RMF_SYMTGT =
462 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL);
463 EXPORT_SYMBOL(RMF_SYMTGT);
465 const struct req_msg_field RMF_TGTUUID =
466 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL);
467 EXPORT_SYMBOL(RMF_TGTUUID);
469 const struct req_msg_field RMF_CLUUID =
470 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL);
471 EXPORT_SYMBOL(RMF_CLUUID);
474 * connection handle received in MDS_CONNECT request.
478 const struct req_msg_field RMF_CONN =
479 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL);
480 EXPORT_SYMBOL(RMF_CONN);
482 const struct req_msg_field RMF_CONNECT_DATA =
483 DEFINE_MSGF("cdata", 0,
484 sizeof(struct obd_connect_data), lustre_swab_connect);
485 EXPORT_SYMBOL(RMF_CONNECT_DATA);
487 const struct req_msg_field RMF_DLM_REQ =
488 DEFINE_MSGF("dlm_req", 0,
489 sizeof(struct ldlm_request), lustre_swab_ldlm_request);
490 EXPORT_SYMBOL(RMF_DLM_REQ);
492 const struct req_msg_field RMF_DLM_REP =
493 DEFINE_MSGF("dlm_rep", 0,
494 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply);
495 EXPORT_SYMBOL(RMF_DLM_REP);
497 const struct req_msg_field RMF_LDLM_INTENT =
498 DEFINE_MSGF("ldlm_intent", 0,
499 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent);
500 EXPORT_SYMBOL(RMF_LDLM_INTENT);
502 const struct req_msg_field RMF_MDT_MD =
503 DEFINE_MSGF("mdt_md", 0, MIN_MD_SIZE, lustre_swab_lov_mds_md);
504 EXPORT_SYMBOL(RMF_MDT_MD);
506 const struct req_msg_field RMF_REC_UNLINK =
507 DEFINE_MSGF("rec_unlink", 0, sizeof(struct mdt_rec_unlink),
508 lustre_swab_mdt_rec_unlink);
509 EXPORT_SYMBOL(RMF_REC_UNLINK);
511 const struct req_msg_field RMF_REC_LINK =
512 DEFINE_MSGF("rec_link", 0, sizeof(struct mdt_rec_link),
513 lustre_swab_mdt_rec_link);
514 EXPORT_SYMBOL(RMF_REC_LINK);
516 const struct req_msg_field RMF_REC_RENAME =
517 DEFINE_MSGF("rec_rename", 0, sizeof(struct mdt_rec_rename),
518 lustre_swab_mdt_rec_rename);
519 EXPORT_SYMBOL(RMF_REC_RENAME);
521 const struct req_msg_field RMF_REC_CREATE =
522 DEFINE_MSGF("rec_create", 0,
523 sizeof(struct mdt_rec_create), lustre_swab_mdt_rec_create);
524 EXPORT_SYMBOL(RMF_REC_CREATE);
526 const struct req_msg_field RMF_REC_SETATTR =
527 DEFINE_MSGF("rec_setattr", 0, sizeof(struct mdt_rec_setattr),
528 lustre_swab_mdt_rec_setattr);
529 EXPORT_SYMBOL(RMF_REC_SETATTR);
531 /* FIXME: this length should be defined as a macro */
532 const struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1, NULL);
533 EXPORT_SYMBOL(RMF_EADATA);
535 const struct req_msg_field RMF_ACL =
536 DEFINE_MSGF("acl", 0, LUSTRE_POSIX_ACL_MAX_SIZE, NULL);
537 EXPORT_SYMBOL(RMF_ACL);
539 const struct req_msg_field RMF_LOGCOOKIES =
540 DEFINE_MSGF("logcookies", 0, sizeof(struct llog_cookie), NULL);
541 EXPORT_SYMBOL(RMF_LOGCOOKIES);
543 const struct req_msg_field RMF_REINT_OPC =
544 DEFINE_MSGF("reint_opc", 0, sizeof(__u32), lustre_swab_generic_32s);
545 EXPORT_SYMBOL(RMF_REINT_OPC);
547 const struct req_msg_field RMF_CAPA1 =
548 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
549 lustre_swab_lustre_capa);
550 EXPORT_SYMBOL(RMF_CAPA1);
552 const struct req_msg_field RMF_CAPA2 =
553 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
554 lustre_swab_lustre_capa);
555 EXPORT_SYMBOL(RMF_CAPA2);
566 const struct req_msg_field **d;
570 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
584 #define DEFINE_REQ_FMT0(name, client, server) \
585 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
587 const struct req_format RQF_SEQ_QUERY =
588 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
589 EXPORT_SYMBOL(RQF_SEQ_QUERY);
591 const struct req_format RQF_FLD_QUERY =
592 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
593 EXPORT_SYMBOL(RQF_FLD_QUERY);
595 const struct req_format RQF_MDS_GETSTATUS =
596 DEFINE_REQ_FMT0("MDS_GETSTATUS", empty, mdt_body_capa);
597 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
599 const struct req_format RQF_MDS_STATFS =
600 DEFINE_REQ_FMT0("MDS_STATFS", empty, mds_statfs_server);
601 EXPORT_SYMBOL(RQF_MDS_STATFS);
603 const struct req_format RQF_MDS_SYNC =
604 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
605 EXPORT_SYMBOL(RQF_MDS_SYNC);
607 const struct req_format RQF_MDS_GETATTR =
608 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
609 EXPORT_SYMBOL(RQF_MDS_GETATTR);
611 const struct req_format RQF_MDS_GETXATTR =
612 DEFINE_REQ_FMT0("MDS_GETXATTR",
613 mds_getxattr_client, mds_getxattr_server);
614 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
616 const struct req_format RQF_MDS_SETXATTR =
617 DEFINE_REQ_FMT0("MDS_SETXATTR",
618 mds_setxattr_client, mds_setxattr_server);
619 EXPORT_SYMBOL(RQF_MDS_SETXATTR);
621 const struct req_format RQF_MDS_GETATTR_NAME =
622 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
623 mds_getattr_name_client, mds_getattr_server);
624 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
626 const struct req_format RQF_MDS_REINT =
627 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
628 EXPORT_SYMBOL(RQF_MDS_REINT);
630 const struct req_format RQF_MDS_REINT_CREATE =
631 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
632 mds_reint_create_client, mdt_body_capa);
633 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
635 const struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
636 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
637 mds_reint_create_rmt_acl_client, mdt_body_capa);
638 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
640 const struct req_format RQF_MDS_REINT_CREATE_SLAVE =
641 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SLAVE",
642 mds_reint_create_slave_client, mdt_body_capa);
643 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
645 const struct req_format RQF_MDS_REINT_CREATE_SYM =
646 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
647 mds_reint_create_sym_client, mdt_body_capa);
648 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
650 const struct req_format RQF_MDS_REINT_OPEN =
651 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
652 mds_reint_open_client, mds_reint_open_server);
653 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
655 const struct req_format RQF_MDS_REINT_UNLINK =
656 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
657 mds_last_unlink_server);
658 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
660 const struct req_format RQF_MDS_REINT_LINK =
661 DEFINE_REQ_FMT0("MDS_REINT_LINK",
662 mds_reint_link_client, mdt_body_only);
663 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
665 const struct req_format RQF_MDS_REINT_RENAME =
666 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
667 mds_last_unlink_server);
668 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
670 const struct req_format RQF_MDS_REINT_SETATTR =
671 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
672 mds_reint_setattr_client, mdt_body_capa);
673 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
675 const struct req_format RQF_MDS_CONNECT =
676 DEFINE_REQ_FMT0("MDS_CONNECT",
677 mds_connect_client, mds_connect_server);
678 EXPORT_SYMBOL(RQF_MDS_CONNECT);
680 const struct req_format RQF_MDS_DISCONNECT =
681 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
682 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
684 const struct req_format RQF_MDS_SET_INFO =
685 DEFINE_REQ_FMT0("MDS_SET_INFO", mds_set_info_client, empty);
686 EXPORT_SYMBOL(RQF_MDS_SET_INFO);
688 const struct req_format RQF_LDLM_ENQUEUE =
689 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
690 ldlm_enqueue_client, ldlm_enqueue_server);
691 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
693 const struct req_format RQF_LDLM_INTENT =
694 DEFINE_REQ_FMT0("LDLM_INTENT",
695 ldlm_intent_client, ldlm_intent_server);
696 EXPORT_SYMBOL(RQF_LDLM_INTENT);
698 const struct req_format RQF_LDLM_INTENT_GETATTR =
699 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
700 ldlm_intent_getattr_client, ldlm_intent_server);
701 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
703 const struct req_format RQF_LDLM_INTENT_OPEN =
704 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
705 ldlm_intent_open_client, ldlm_intent_open_server);
706 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
708 const struct req_format RQF_LDLM_INTENT_CREATE =
709 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
710 ldlm_intent_create_client, ldlm_intent_server);
711 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
713 const struct req_format RQF_LDLM_INTENT_UNLINK =
714 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
715 ldlm_intent_unlink_client, ldlm_intent_server);
716 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
718 const struct req_format RQF_MDS_CLOSE =
719 DEFINE_REQ_FMT0("MDS_CLOSE",
720 mdt_close_client, mds_last_unlink_server);
721 EXPORT_SYMBOL(RQF_MDS_CLOSE);
723 const struct req_format RQF_MDS_PIN =
724 DEFINE_REQ_FMT0("MDS_PIN",
725 mdt_body_capa, mdt_body_only);
726 EXPORT_SYMBOL(RQF_MDS_PIN);
728 const struct req_format RQF_MDS_DONE_WRITING =
729 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
730 mdt_close_client, mdt_body_only);
731 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
733 const struct req_format RQF_MDS_READPAGE =
734 DEFINE_REQ_FMT0("MDS_READPAGE",
735 mdt_body_capa, mdt_body_only);
736 EXPORT_SYMBOL(RQF_MDS_READPAGE);
738 /* This is for split */
739 const struct req_format RQF_MDS_WRITEPAGE =
740 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
741 mdt_body_capa, mdt_body_only);
742 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
744 const struct req_format RQF_MDS_IS_SUBDIR =
745 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
746 mdt_body_only, mdt_body_only);
747 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
749 #if !defined(__REQ_LAYOUT_USER__)
751 int req_layout_init(void)
757 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
758 struct req_format *rf;
760 rf = (struct req_format *)req_formats[i];
762 for (j = 0; j < RCL_NR; ++j) {
763 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
764 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
765 struct req_msg_field *field;
767 field = (typeof(field))rf->rf_fields[j].d[k];
768 LASSERT(field->rmf_offset[i][j] == 0);
770 * k + 1 to detect unused format/field
773 field->rmf_offset[i][j] = k + 1;
779 EXPORT_SYMBOL(req_layout_init);
781 void req_layout_fini(void)
784 EXPORT_SYMBOL(req_layout_fini);
787 * Initialize capsule.
789 * @area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
790 * variable-sized fields.
792 void req_capsule_init(struct req_capsule *pill,
793 struct ptlrpc_request *req, enum req_location location,
796 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
798 memset(pill, 0, sizeof *pill);
800 pill->rc_loc = location;
801 pill->rc_area = area;
803 EXPORT_SYMBOL(req_capsule_init);
805 void req_capsule_fini(struct req_capsule *pill)
808 EXPORT_SYMBOL(req_capsule_fini);
810 static int __req_format_is_sane(const struct req_format *fmt)
813 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
814 req_formats[fmt->rf_idx] == fmt;
817 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
818 enum req_location loc)
820 struct ptlrpc_request *req;
823 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
826 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
828 LASSERT(pill->rc_fmt == NULL);
829 LASSERT(__req_format_is_sane(fmt));
833 EXPORT_SYMBOL(req_capsule_set);
835 int req_capsule_pack(struct req_capsule *pill)
842 const struct req_format *fmt;
844 LASSERT(pill->rc_loc == RCL_SERVER);
846 LASSERT(fmt != NULL);
848 nr = fmt->rf_fields[RCL_SERVER].nr;
849 for (total = 0, i = 0; i < nr; ++i) {
852 size = &pill->rc_area[i];
854 *size = fmt->rf_fields[RCL_SERVER].d[i]->rmf_size;
855 LASSERT(*size != -1);
859 result = lustre_pack_reply(pill->rc_req, nr, pill->rc_area, NULL);
861 DEBUG_REQ(D_ERROR, pill->rc_req,
862 "Cannot pack %d fields (%d bytes) in format `%s': ",
863 nr, total, fmt->rf_name);
867 EXPORT_SYMBOL(req_capsule_pack);
869 static int __req_capsule_offset(const struct req_capsule *pill,
870 const struct req_msg_field *field,
871 enum req_location loc)
875 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
878 LASSERT(0 <= offset && offset < (sizeof(pill->rc_swabbed) << 3));
882 static void *__req_capsule_get(struct req_capsule *pill,
883 const struct req_msg_field *field,
884 enum req_location loc)
886 const struct req_format *fmt;
887 struct lustre_msg *msg;
892 void *(*getter)(struct lustre_msg *m, int n, int minlen);
894 static const char *rcl_names[RCL_NR] = {
895 [RCL_CLIENT] = "client",
896 [RCL_SERVER] = "server"
900 LASSERT(fmt != NULL);
901 LASSERT(__req_format_is_sane(fmt));
903 offset = __req_capsule_offset(pill, field, loc);
905 msg = __req_msg(pill, loc);
907 getter = (field->rmf_flags & RMF_F_STRING) ?
908 (typeof(getter))lustre_msg_string : lustre_msg_buf;
910 len = max(field->rmf_size, 0);
911 value = getter(msg, offset, len);
913 if (!(pill->rc_swabbed & (1 << offset)) && loc != pill->rc_loc &&
914 field->rmf_swabber != NULL && value != NULL &&
915 lustre_msg_swabbed(msg)) {
916 field->rmf_swabber(value);
917 pill->rc_swabbed |= (1 << offset);
920 DEBUG_REQ(D_ERROR, pill->rc_req,
921 "Wrong buffer for field `%s' (%d of %d) "
922 "in format `%s': %d vs. %d (%s)\n",
923 field->rmf_name, offset, lustre_msg_bufcount(msg), fmt->rf_name,
924 lustre_msg_buflen(msg, offset), field->rmf_size,
930 void *req_capsule_client_get(struct req_capsule *pill,
931 const struct req_msg_field *field)
933 return __req_capsule_get(pill, field, RCL_CLIENT);
935 EXPORT_SYMBOL(req_capsule_client_get);
937 void *req_capsule_server_get(struct req_capsule *pill,
938 const struct req_msg_field *field)
940 return __req_capsule_get(pill, field, RCL_SERVER);
942 EXPORT_SYMBOL(req_capsule_server_get);
944 const void *req_capsule_other_get(struct req_capsule *pill,
945 const struct req_msg_field *field)
947 return __req_capsule_get(pill, field, pill->rc_loc ^ 1);
949 EXPORT_SYMBOL(req_capsule_other_get);
951 void req_capsule_set_size(const struct req_capsule *pill,
952 const struct req_msg_field *field,
953 enum req_location loc, int size)
955 pill->rc_area[__req_capsule_offset(pill, field, loc)] = size;
957 EXPORT_SYMBOL(req_capsule_set_size);
959 int req_capsule_get_size(const struct req_capsule *pill,
960 const struct req_msg_field *field,
961 enum req_location loc)
963 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
965 return lustre_msg_buflen(__req_msg(pill, loc),
966 __req_capsule_offset(pill, field, loc));
968 EXPORT_SYMBOL(req_capsule_get_size);
970 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
972 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
977 const struct req_format *old;
979 LASSERT(pill->rc_fmt != NULL);
980 LASSERT(__req_format_is_sane(fmt));
986 for (i = 0; i < RCL_NR; ++i) {
987 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
988 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
989 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
992 * Last field in old format can be shorter than in new.
994 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
995 FMT_FIELD(old, i, j)->rmf_size);
997 /* last field should be returned to the unswabbed state */
998 pill->rc_swabbed &= ~(__u32)(1 << j);
1001 EXPORT_SYMBOL(req_capsule_extend);
1003 int req_capsule_has_field(const struct req_capsule *pill,
1004 const struct req_msg_field *field,
1005 enum req_location loc)
1007 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1009 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1011 EXPORT_SYMBOL(req_capsule_has_field);
1013 int req_capsule_field_present(const struct req_capsule *pill,
1014 const struct req_msg_field *field,
1015 enum req_location loc)
1019 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1020 LASSERT(req_capsule_has_field(pill, field, loc));
1022 offset = __req_capsule_offset(pill, field, loc);
1023 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
1025 EXPORT_SYMBOL(req_capsule_field_present);
1029 * Shrink the specified reply message buffer @field to a specified @newlen.
1030 * If @move_data is non-zero, then move following buffer backward
1031 * if @newlen is zero;
1032 * The internal offset should be adjusted by @adjust because buffer maybe has
1033 * been moved by previous call. (@adjust >= 0) is a must.
1034 * Return value: 1 if buffer has been moved, otherwise 0 is returned.
1036 int req_capsule_shrink(const struct req_capsule *pill,
1037 const struct req_msg_field *field,
1038 const unsigned int newlen,
1040 const int move_data)
1044 LASSERT(adjust >= 0);
1045 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
1047 offset = __req_capsule_offset(pill, field, RCL_SERVER);
1049 LASSERT(offset >= 1);
1051 lustre_shrink_reply(pill->rc_req, offset, newlen, move_data);
1052 return (newlen == 0) ? 1 : 0;
1054 EXPORT_SYMBOL(req_capsule_shrink);
1056 /* __REQ_LAYOUT_USER__ */