1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * Copyright (c) 2011 Whamcloud, Inc.
36 * This file is part of Lustre, http://www.lustre.org/
37 * Lustre is a trademark of Sun Microsystems, Inc.
39 * lustre/ptlrpc/layout.c
41 * Lustre Metadata Target (mdt) request handler
43 * Author: Nikita Danilov <nikita@clusterfs.com>
46 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
48 * Every struct ptlrpc_request contains a "pill", which points to a description
49 * of the format that the request conforms to.
52 #if !defined(__REQ_LAYOUT_USER__)
55 # define EXPORT_SYMTAB
57 #define DEBUG_SUBSYSTEM S_RPC
60 #include <linux/module.h>
62 # include <liblustre.h>
65 /* LUSTRE_VERSION_CODE */
66 #include <lustre_ver.h>
68 #include <obd_support.h>
69 /* lustre_swab_mdt_body */
70 #include <lustre/lustre_idl.h>
71 /* obd2cli_tgt() (required by DEBUG_REQ()) */
74 /* __REQ_LAYOUT_USER__ */
76 /* struct ptlrpc_request, lustre_msg* */
77 #include <lustre_req_layout.h>
78 #include <lustre_acl.h>
79 #include <lustre_debug.h>
82 * RQFs (see below) refer to two struct req_msg_field arrays describing the
83 * client request and server reply, respectively.
85 /* empty set of fields... for suitable definition of emptiness. */
86 static const struct req_msg_field *empty[] = {
90 static const struct req_msg_field *mgs_target_info_only[] = {
95 static const struct req_msg_field *mgs_set_info[] = {
100 static const struct req_msg_field *log_cancel_client[] = {
105 static const struct req_msg_field *mdt_body_only[] = {
110 static const struct req_msg_field *mdt_body_capa[] = {
116 static const struct req_msg_field *quotactl_only[] = {
120 static const struct req_msg_field *quota_adjust_qunit_only[] = {
122 &RMF_QUOTA_ADJUST_QUNIT
125 static const struct req_msg_field *qunit_data_only[] = {
130 static const struct req_msg_field *mdt_close_client[] = {
137 static const struct req_msg_field *obd_statfs_server[] = {
142 static const struct req_msg_field *seq_query_client[] = {
148 static const struct req_msg_field *seq_query_server[] = {
153 static const struct req_msg_field *fld_query_client[] = {
159 static const struct req_msg_field *fld_query_server[] = {
164 static const struct req_msg_field *mds_getattr_name_client[] = {
171 static const struct req_msg_field *mds_reint_client[] = {
176 static const struct req_msg_field *mds_reint_create_client[] = {
183 static const struct req_msg_field *mds_reint_create_slave_client[] = {
192 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
201 static const struct req_msg_field *mds_reint_create_sym_client[] = {
210 static const struct req_msg_field *mds_reint_open_client[] = {
219 static const struct req_msg_field *mds_reint_open_server[] = {
228 static const struct req_msg_field *mds_reint_unlink_client[] = {
236 static const struct req_msg_field *mds_reint_link_client[] = {
245 static const struct req_msg_field *mds_reint_rename_client[] = {
255 static const struct req_msg_field *mds_last_unlink_server[] = {
264 static const struct req_msg_field *mds_reint_setattr_client[] = {
274 static const struct req_msg_field *mds_reint_setxattr_client[] = {
282 static const struct req_msg_field *obd_connect_client[] = {
290 static const struct req_msg_field *obd_connect_server[] = {
295 static const struct req_msg_field *obd_set_info_client[] = {
301 static const struct req_msg_field *ost_grant_shrink_client[] = {
307 static const struct req_msg_field *mds_getinfo_client[] = {
313 static const struct req_msg_field *mds_getinfo_server[] = {
318 static const struct req_msg_field *ldlm_enqueue_client[] = {
323 static const struct req_msg_field *ldlm_enqueue_server[] = {
328 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
334 static const struct req_msg_field *ldlm_cp_callback_client[] = {
340 static const struct req_msg_field *ldlm_gl_callback_server[] = {
345 static const struct req_msg_field *ldlm_intent_client[] = {
352 static const struct req_msg_field *ldlm_intent_server[] = {
360 static const struct req_msg_field *ldlm_intent_open_server[] = {
370 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
374 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
379 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
388 static const struct req_msg_field *ldlm_intent_create_client[] = {
392 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
398 static const struct req_msg_field *ldlm_intent_open_client[] = {
402 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
409 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
413 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
418 static const struct req_msg_field *mds_getxattr_client[] = {
426 static const struct req_msg_field *mds_getxattr_server[] = {
432 static const struct req_msg_field *mds_getattr_server[] = {
441 static const struct req_msg_field *mds_setattr_server[] = {
450 static const struct req_msg_field *llog_catinfo_client[] = {
456 static const struct req_msg_field *llog_catinfo_server[] = {
461 static const struct req_msg_field *llog_origin_handle_create_client[] = {
467 static const struct req_msg_field *llogd_body_only[] = {
472 static const struct req_msg_field *llog_log_hdr_only[] = {
477 static const struct req_msg_field *llogd_conn_body_only[] = {
482 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
488 static const struct req_msg_field *ost_body_only[] = {
493 static const struct req_msg_field *ost_body_capa[] = {
499 static const struct req_msg_field *ost_destroy_client[] = {
507 static const struct req_msg_field *ost_brw_client[] = {
515 static const struct req_msg_field *ost_brw_read_server[] = {
520 static const struct req_msg_field *ost_brw_write_server[] = {
526 static const struct req_msg_field *ost_get_info_generic_server[] = {
531 static const struct req_msg_field *ost_get_info_generic_client[] = {
536 static const struct req_msg_field *ost_get_last_id_server[] = {
541 static const struct req_msg_field *ost_get_fiemap_client[] = {
547 static const struct req_msg_field *ost_get_fiemap_server[] = {
552 static struct req_format *req_formats[] = {
566 &RQF_MDS_GETATTR_NAME,
575 &RQF_MDS_DONE_WRITING,
577 &RQF_MDS_REINT_CREATE,
578 &RQF_MDS_REINT_CREATE_RMT_ACL,
579 &RQF_MDS_REINT_CREATE_SLAVE,
580 &RQF_MDS_REINT_CREATE_SYM,
582 &RQF_MDS_REINT_UNLINK,
584 &RQF_MDS_REINT_RENAME,
585 &RQF_MDS_REINT_SETATTR,
586 &RQF_MDS_REINT_SETXATTR,
589 &RQF_MDS_QUOTA_DQACQ,
595 &RQF_OST_QUOTA_ADJUST_QUNIT,
605 &RQF_OST_SET_GRANT_INFO,
606 &RQF_OST_GET_INFO_GENERIC,
607 &RQF_OST_GET_INFO_LAST_ID,
608 &RQF_OST_GET_INFO_FIEMAP,
610 &RQF_LDLM_ENQUEUE_LVB,
614 &RQF_LDLM_CP_CALLBACK,
615 &RQF_LDLM_BL_CALLBACK,
616 &RQF_LDLM_GL_CALLBACK,
618 &RQF_LDLM_INTENT_GETATTR,
619 &RQF_LDLM_INTENT_OPEN,
620 &RQF_LDLM_INTENT_CREATE,
621 &RQF_LDLM_INTENT_UNLINK,
624 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
625 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
626 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
627 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
628 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
629 &RQF_LLOG_ORIGIN_CONNECT
632 struct req_msg_field {
633 const __u32 rmf_flags;
634 const char *rmf_name;
636 * Field length. (-1) means "variable length". If the
637 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
638 * but the actual size must be a whole multiple of \a rmf_size.
641 void (*rmf_swabber)(void *);
642 void (*rmf_dumper)(void *);
643 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
648 * The field is a string, must be NUL-terminated.
650 RMF_F_STRING = 1 << 0,
652 * The field's buffer size need not match the declared \a rmf_size.
654 RMF_F_NO_SIZE_CHECK = 1 << 1,
656 * The field's buffer size must be a whole multiple of the declared \a
657 * rmf_size and the \a rmf_swabber function must work on the declared \a
658 * rmf_size worth of bytes.
660 RMF_F_STRUCT_ARRAY = 1 << 2
668 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
669 .rmf_name = (name), \
670 .rmf_flags = (flags), \
671 .rmf_size = (size), \
672 .rmf_swabber = (void (*)(void*))(swabber), \
673 .rmf_dumper = (void (*)(void*))(dumper) \
676 struct req_msg_field RMF_GENERIC_DATA =
677 DEFINE_MSGF("generic_data", 0,
679 EXPORT_SYMBOL(RMF_GENERIC_DATA);
681 struct req_msg_field RMF_MGS_TARGET_INFO =
682 DEFINE_MSGF("mgs_target_info", 0,
683 sizeof(struct mgs_target_info),
684 lustre_swab_mgs_target_info, NULL);
685 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
687 struct req_msg_field RMF_MGS_SEND_PARAM =
688 DEFINE_MSGF("mgs_send_param", 0,
689 sizeof(struct mgs_send_param),
691 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
693 struct req_msg_field RMF_SETINFO_VAL =
694 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
695 EXPORT_SYMBOL(RMF_SETINFO_VAL);
697 struct req_msg_field RMF_GETINFO_KEY =
698 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
699 EXPORT_SYMBOL(RMF_GETINFO_KEY);
701 struct req_msg_field RMF_GETINFO_VALLEN =
702 DEFINE_MSGF("getinfo_vallen", 0,
703 sizeof(__u32), lustre_swab_generic_32s, NULL);
704 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
706 struct req_msg_field RMF_GETINFO_VAL =
707 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
708 EXPORT_SYMBOL(RMF_GETINFO_VAL);
710 struct req_msg_field RMF_SEQ_OPC =
711 DEFINE_MSGF("seq_query_opc", 0,
712 sizeof(__u32), lustre_swab_generic_32s, NULL);
713 EXPORT_SYMBOL(RMF_SEQ_OPC);
715 struct req_msg_field RMF_SEQ_RANGE =
716 DEFINE_MSGF("seq_query_range", 0,
717 sizeof(struct lu_seq_range),
718 lustre_swab_lu_seq_range, NULL);
719 EXPORT_SYMBOL(RMF_SEQ_RANGE);
721 struct req_msg_field RMF_FLD_OPC =
722 DEFINE_MSGF("fld_query_opc", 0,
723 sizeof(__u32), lustre_swab_generic_32s, NULL);
724 EXPORT_SYMBOL(RMF_FLD_OPC);
726 struct req_msg_field RMF_FLD_MDFLD =
727 DEFINE_MSGF("fld_query_mdfld", 0,
728 sizeof(struct lu_seq_range),
729 lustre_swab_lu_seq_range, NULL);
730 EXPORT_SYMBOL(RMF_FLD_MDFLD);
732 struct req_msg_field RMF_MDT_BODY =
733 DEFINE_MSGF("mdt_body", 0,
734 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
735 EXPORT_SYMBOL(RMF_MDT_BODY);
737 struct req_msg_field RMF_OBD_QUOTACTL =
738 DEFINE_MSGF("obd_quotactl", 0,
739 sizeof(struct obd_quotactl),
740 lustre_swab_obd_quotactl, NULL);
741 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
743 struct req_msg_field RMF_QUOTA_ADJUST_QUNIT =
744 DEFINE_MSGF("quota_adjust_qunit", 0,
745 sizeof(struct quota_adjust_qunit),
746 lustre_swab_quota_adjust_qunit, NULL);
747 EXPORT_SYMBOL(RMF_QUOTA_ADJUST_QUNIT);
749 struct req_msg_field RMF_QUNIT_DATA =
750 DEFINE_MSGF("qunit_data", 0,
751 sizeof(struct qunit_data), lustre_swab_qdata, NULL);
752 EXPORT_SYMBOL(RMF_QUNIT_DATA);
754 struct req_msg_field RMF_MDT_EPOCH =
755 DEFINE_MSGF("mdt_ioepoch", 0,
756 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
757 EXPORT_SYMBOL(RMF_MDT_EPOCH);
759 struct req_msg_field RMF_PTLRPC_BODY =
760 DEFINE_MSGF("ptlrpc_body", 0,
761 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
762 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
764 struct req_msg_field RMF_OBD_STATFS =
765 DEFINE_MSGF("obd_statfs", 0,
766 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
767 EXPORT_SYMBOL(RMF_OBD_STATFS);
769 struct req_msg_field RMF_SETINFO_KEY =
770 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
771 EXPORT_SYMBOL(RMF_SETINFO_KEY);
773 struct req_msg_field RMF_NAME =
774 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
775 EXPORT_SYMBOL(RMF_NAME);
777 struct req_msg_field RMF_SYMTGT =
778 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
779 EXPORT_SYMBOL(RMF_SYMTGT);
781 struct req_msg_field RMF_TGTUUID =
782 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
784 EXPORT_SYMBOL(RMF_TGTUUID);
786 struct req_msg_field RMF_CLUUID =
787 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
789 EXPORT_SYMBOL(RMF_CLUUID);
791 struct req_msg_field RMF_STRING =
792 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
793 EXPORT_SYMBOL(RMF_STRING);
795 struct req_msg_field RMF_LLOGD_BODY =
796 DEFINE_MSGF("llogd_body", 0,
797 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
798 EXPORT_SYMBOL(RMF_LLOGD_BODY);
800 struct req_msg_field RMF_LLOG_LOG_HDR =
801 DEFINE_MSGF("llog_log_hdr", 0,
802 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
803 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
805 struct req_msg_field RMF_LLOGD_CONN_BODY =
806 DEFINE_MSGF("llogd_conn_body", 0,
807 sizeof(struct llogd_conn_body),
808 lustre_swab_llogd_conn_body, NULL);
809 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
812 * connection handle received in MDS_CONNECT request.
814 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
815 * that the client does not interpret at all.
817 struct req_msg_field RMF_CONN =
818 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
819 EXPORT_SYMBOL(RMF_CONN);
821 struct req_msg_field RMF_CONNECT_DATA =
823 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
824 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 9, 0, 0)
825 sizeof(struct obd_connect_data),
827 /* For interoperability with 1.8 and 2.0 clients/servers.
828 * The RPC verification code allows larger RPC buffers, but not
829 * smaller buffers. Until we no longer need to keep compatibility
830 * with older servers/clients we can only check that the buffer
831 * size is at least as large as obd_connect_data_v1. That is not
832 * not in itself harmful, since the chance of just corrupting this
833 * field is low. See JIRA LU-16 for details. */
834 sizeof(struct obd_connect_data_v1),
836 lustre_swab_connect, NULL);
837 EXPORT_SYMBOL(RMF_CONNECT_DATA);
839 struct req_msg_field RMF_DLM_REQ =
840 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
841 sizeof(struct ldlm_request),
842 lustre_swab_ldlm_request, NULL);
843 EXPORT_SYMBOL(RMF_DLM_REQ);
845 struct req_msg_field RMF_DLM_REP =
846 DEFINE_MSGF("dlm_rep", 0,
847 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
848 EXPORT_SYMBOL(RMF_DLM_REP);
850 struct req_msg_field RMF_LDLM_INTENT =
851 DEFINE_MSGF("ldlm_intent", 0,
852 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
853 EXPORT_SYMBOL(RMF_LDLM_INTENT);
855 struct req_msg_field RMF_DLM_LVB =
856 DEFINE_MSGF("dlm_lvb", 0, sizeof(struct ost_lvb), lustre_swab_ost_lvb,
858 EXPORT_SYMBOL(RMF_DLM_LVB);
860 struct req_msg_field RMF_MDT_MD =
861 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
862 EXPORT_SYMBOL(RMF_MDT_MD);
864 struct req_msg_field RMF_REC_REINT =
865 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
866 lustre_swab_mdt_rec_reint, NULL);
867 EXPORT_SYMBOL(RMF_REC_REINT);
869 /* FIXME: this length should be defined as a macro */
870 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
872 EXPORT_SYMBOL(RMF_EADATA);
874 struct req_msg_field RMF_ACL =
875 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
876 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
877 EXPORT_SYMBOL(RMF_ACL);
879 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
880 struct req_msg_field RMF_LOGCOOKIES =
881 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
882 sizeof(struct llog_cookie), NULL, NULL);
883 EXPORT_SYMBOL(RMF_LOGCOOKIES);
885 struct req_msg_field RMF_CAPA1 =
886 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
887 lustre_swab_lustre_capa, NULL);
888 EXPORT_SYMBOL(RMF_CAPA1);
890 struct req_msg_field RMF_CAPA2 =
891 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
892 lustre_swab_lustre_capa, NULL);
893 EXPORT_SYMBOL(RMF_CAPA2);
898 struct req_msg_field RMF_OST_BODY =
899 DEFINE_MSGF("ost_body", 0,
900 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
901 EXPORT_SYMBOL(RMF_OST_BODY);
903 struct req_msg_field RMF_OBD_IOOBJ =
904 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
905 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
906 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
908 struct req_msg_field RMF_NIOBUF_REMOTE =
909 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
910 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
912 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
914 struct req_msg_field RMF_RCS =
915 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
916 lustre_swab_generic_32s, dump_rcs);
917 EXPORT_SYMBOL(RMF_RCS);
919 struct req_msg_field RMF_OBD_ID =
920 DEFINE_MSGF("obd_id", 0,
921 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
922 EXPORT_SYMBOL(RMF_OBD_ID);
924 struct req_msg_field RMF_FIEMAP_KEY =
925 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
926 lustre_swab_fiemap, NULL);
927 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
929 struct req_msg_field RMF_FIEMAP_VAL =
930 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
931 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
942 const struct req_msg_field **d;
946 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
960 #define DEFINE_REQ_FMT0(name, client, server) \
961 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
963 struct req_format RQF_OBD_PING =
964 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
965 EXPORT_SYMBOL(RQF_OBD_PING);
967 struct req_format RQF_OBD_SET_INFO =
968 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
969 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
971 struct req_format RQF_SEC_CTX =
972 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
973 EXPORT_SYMBOL(RQF_SEC_CTX);
975 struct req_format RQF_MGS_TARGET_REG =
976 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
977 mgs_target_info_only);
978 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
980 struct req_format RQF_MGS_SET_INFO =
981 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
983 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
985 struct req_format RQF_SEQ_QUERY =
986 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
987 EXPORT_SYMBOL(RQF_SEQ_QUERY);
989 struct req_format RQF_FLD_QUERY =
990 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
991 EXPORT_SYMBOL(RQF_FLD_QUERY);
993 struct req_format RQF_LOG_CANCEL =
994 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
995 EXPORT_SYMBOL(RQF_LOG_CANCEL);
997 struct req_format RQF_MDS_QUOTACHECK =
998 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
999 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1001 struct req_format RQF_OST_QUOTACHECK =
1002 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1003 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1005 struct req_format RQF_MDS_QUOTACTL =
1006 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1007 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1009 struct req_format RQF_OST_QUOTACTL =
1010 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1011 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1013 struct req_format RQF_OST_QUOTA_ADJUST_QUNIT =
1014 DEFINE_REQ_FMT0("OST_QUOTA_ADJUST_QUNIT", quota_adjust_qunit_only,
1015 quota_adjust_qunit_only);
1016 EXPORT_SYMBOL(RQF_OST_QUOTA_ADJUST_QUNIT);
1018 struct req_format RQF_QC_CALLBACK =
1019 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1020 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1022 struct req_format RQF_MDS_QUOTA_DQACQ =
1023 DEFINE_REQ_FMT0("MDS_QUOTA_DQACQ", qunit_data_only, qunit_data_only);
1024 EXPORT_SYMBOL(RQF_MDS_QUOTA_DQACQ);
1026 struct req_format RQF_MDS_GETSTATUS =
1027 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1028 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1030 struct req_format RQF_MDS_STATFS =
1031 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1032 EXPORT_SYMBOL(RQF_MDS_STATFS);
1034 struct req_format RQF_MDS_SYNC =
1035 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1036 EXPORT_SYMBOL(RQF_MDS_SYNC);
1038 struct req_format RQF_MDS_GETATTR =
1039 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1040 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1042 struct req_format RQF_MDS_GETXATTR =
1043 DEFINE_REQ_FMT0("MDS_GETXATTR",
1044 mds_getxattr_client, mds_getxattr_server);
1045 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1047 struct req_format RQF_MDS_GETATTR_NAME =
1048 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1049 mds_getattr_name_client, mds_getattr_server);
1050 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1052 struct req_format RQF_MDS_REINT =
1053 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1054 EXPORT_SYMBOL(RQF_MDS_REINT);
1056 struct req_format RQF_MDS_REINT_CREATE =
1057 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1058 mds_reint_create_client, mdt_body_capa);
1059 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1061 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1062 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1063 mds_reint_create_rmt_acl_client, mdt_body_capa);
1064 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1066 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1067 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1068 mds_reint_create_slave_client, mdt_body_capa);
1069 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1071 struct req_format RQF_MDS_REINT_CREATE_SYM =
1072 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1073 mds_reint_create_sym_client, mdt_body_capa);
1074 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1076 struct req_format RQF_MDS_REINT_OPEN =
1077 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1078 mds_reint_open_client, mds_reint_open_server);
1079 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1081 struct req_format RQF_MDS_REINT_UNLINK =
1082 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1083 mds_last_unlink_server);
1084 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1086 struct req_format RQF_MDS_REINT_LINK =
1087 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1088 mds_reint_link_client, mdt_body_only);
1089 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1091 struct req_format RQF_MDS_REINT_RENAME =
1092 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1093 mds_last_unlink_server);
1094 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1096 struct req_format RQF_MDS_REINT_SETATTR =
1097 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1098 mds_reint_setattr_client, mds_setattr_server);
1099 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1101 struct req_format RQF_MDS_REINT_SETXATTR =
1102 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1103 mds_reint_setxattr_client, mdt_body_only);
1104 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1106 struct req_format RQF_MDS_CONNECT =
1107 DEFINE_REQ_FMT0("MDS_CONNECT",
1108 obd_connect_client, obd_connect_server);
1109 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1111 struct req_format RQF_MDS_DISCONNECT =
1112 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1113 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1115 struct req_format RQF_MDS_GET_INFO =
1116 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1117 mds_getinfo_server);
1118 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1120 struct req_format RQF_LDLM_ENQUEUE =
1121 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1122 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1123 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1125 struct req_format RQF_LDLM_ENQUEUE_LVB =
1126 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1127 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1128 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1130 struct req_format RQF_LDLM_CONVERT =
1131 DEFINE_REQ_FMT0("LDLM_CONVERT",
1132 ldlm_enqueue_client, ldlm_enqueue_server);
1133 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1135 struct req_format RQF_LDLM_CANCEL =
1136 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1137 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1139 struct req_format RQF_LDLM_CALLBACK =
1140 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1141 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1143 struct req_format RQF_LDLM_CP_CALLBACK =
1144 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1145 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1147 struct req_format RQF_LDLM_BL_CALLBACK =
1148 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1149 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1151 struct req_format RQF_LDLM_GL_CALLBACK =
1152 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1153 ldlm_gl_callback_server);
1154 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1156 struct req_format RQF_LDLM_INTENT =
1157 DEFINE_REQ_FMT0("LDLM_INTENT",
1158 ldlm_intent_client, ldlm_intent_server);
1159 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1161 struct req_format RQF_LDLM_INTENT_GETATTR =
1162 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1163 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1164 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1166 struct req_format RQF_LDLM_INTENT_OPEN =
1167 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1168 ldlm_intent_open_client, ldlm_intent_open_server);
1169 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1171 struct req_format RQF_LDLM_INTENT_CREATE =
1172 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1173 ldlm_intent_create_client, ldlm_intent_getattr_server);
1174 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1176 struct req_format RQF_LDLM_INTENT_UNLINK =
1177 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1178 ldlm_intent_unlink_client, ldlm_intent_server);
1179 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1181 struct req_format RQF_MDS_CLOSE =
1182 DEFINE_REQ_FMT0("MDS_CLOSE",
1183 mdt_close_client, mds_last_unlink_server);
1184 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1186 struct req_format RQF_MDS_PIN =
1187 DEFINE_REQ_FMT0("MDS_PIN",
1188 mdt_body_capa, mdt_body_only);
1189 EXPORT_SYMBOL(RQF_MDS_PIN);
1191 struct req_format RQF_MDS_UNPIN =
1192 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1193 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1195 struct req_format RQF_MDS_DONE_WRITING =
1196 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1197 mdt_close_client, mdt_body_only);
1198 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1200 struct req_format RQF_MDS_READPAGE =
1201 DEFINE_REQ_FMT0("MDS_READPAGE",
1202 mdt_body_capa, mdt_body_only);
1203 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1205 /* This is for split */
1206 struct req_format RQF_MDS_WRITEPAGE =
1207 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1208 mdt_body_capa, mdt_body_only);
1209 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1211 struct req_format RQF_MDS_IS_SUBDIR =
1212 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1213 mdt_body_only, mdt_body_only);
1214 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1216 struct req_format RQF_LLOG_CATINFO =
1217 DEFINE_REQ_FMT0("LLOG_CATINFO",
1218 llog_catinfo_client, llog_catinfo_server);
1219 EXPORT_SYMBOL(RQF_LLOG_CATINFO);
1221 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1222 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1223 llog_origin_handle_create_client, llogd_body_only);
1224 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1226 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1227 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1228 llogd_body_only, llogd_body_only);
1229 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1231 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1232 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1233 llogd_body_only, llog_origin_handle_next_block_server);
1234 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1236 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1237 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1238 llogd_body_only, llog_origin_handle_next_block_server);
1239 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1241 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1242 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1243 llogd_body_only, llog_log_hdr_only);
1244 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1246 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1247 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1248 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1250 struct req_format RQF_OST_CONNECT =
1251 DEFINE_REQ_FMT0("OST_CONNECT",
1252 obd_connect_client, obd_connect_server);
1253 EXPORT_SYMBOL(RQF_OST_CONNECT);
1255 struct req_format RQF_OST_DISCONNECT =
1256 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1257 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1259 struct req_format RQF_OST_GETATTR =
1260 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1261 EXPORT_SYMBOL(RQF_OST_GETATTR);
1263 struct req_format RQF_OST_SETATTR =
1264 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1265 EXPORT_SYMBOL(RQF_OST_SETATTR);
1267 struct req_format RQF_OST_CREATE =
1268 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1269 EXPORT_SYMBOL(RQF_OST_CREATE);
1271 struct req_format RQF_OST_PUNCH =
1272 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1273 EXPORT_SYMBOL(RQF_OST_PUNCH);
1275 struct req_format RQF_OST_SYNC =
1276 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1277 EXPORT_SYMBOL(RQF_OST_SYNC);
1279 struct req_format RQF_OST_DESTROY =
1280 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1281 EXPORT_SYMBOL(RQF_OST_DESTROY);
1283 struct req_format RQF_OST_BRW_READ =
1284 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1285 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1287 struct req_format RQF_OST_BRW_WRITE =
1288 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1289 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1291 struct req_format RQF_OST_STATFS =
1292 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1293 EXPORT_SYMBOL(RQF_OST_STATFS);
1295 struct req_format RQF_OST_SET_GRANT_INFO =
1296 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1298 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1300 struct req_format RQF_OST_GET_INFO_GENERIC =
1301 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1302 ost_get_info_generic_server);
1303 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1305 struct req_format RQF_OST_GET_INFO_LAST_ID =
1306 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1307 ost_get_last_id_server);
1308 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1310 struct req_format RQF_OST_GET_INFO_FIEMAP =
1311 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1312 ost_get_fiemap_server);
1313 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1316 #if !defined(__REQ_LAYOUT_USER__)
1318 /* Convenience macro */
1319 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1322 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1323 * field of RQFs and the \a rmf_offset field of RMFs.
1325 int req_layout_init(void)
1330 struct req_format *rf = NULL;
1332 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1333 rf = req_formats[i];
1335 for (j = 0; j < RCL_NR; ++j) {
1336 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1337 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1338 struct req_msg_field *field;
1340 field = (typeof(field))rf->rf_fields[j].d[k];
1341 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1342 || field->rmf_size > 0);
1343 LASSERT(field->rmf_offset[i][j] == 0);
1345 * k + 1 to detect unused format/field
1348 field->rmf_offset[i][j] = k + 1;
1354 EXPORT_SYMBOL(req_layout_init);
1356 void req_layout_fini(void)
1359 EXPORT_SYMBOL(req_layout_fini);
1362 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1364 * Actual/expected field sizes are set elsewhere in functions in this file:
1365 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1366 * req_capsule_msg_size(). The \a rc_area information is used by.
1367 * ptlrpc_request_set_replen().
1369 void req_capsule_init_area(struct req_capsule *pill)
1373 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1374 pill->rc_area[RCL_CLIENT][i] = -1;
1375 pill->rc_area[RCL_SERVER][i] = -1;
1378 EXPORT_SYMBOL(req_capsule_init_area);
1381 * Initialize a pill.
1383 * The \a location indicates whether the caller is executing on the client side
1384 * (RCL_CLIENT) or server side (RCL_SERVER)..
1386 void req_capsule_init(struct req_capsule *pill,
1387 struct ptlrpc_request *req,
1388 enum req_location location)
1390 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1393 * Today all capsules are embedded in ptlrpc_request structs,
1394 * but just in case that ever isn't the case, we don't reach
1395 * into req unless req != NULL and pill is the one embedded in
1398 * The req->rq_pill_init flag makes it safe to initialize a pill
1399 * twice, which might happen in the OST paths as a result of the
1400 * high-priority RPC queue getting peeked at before ost_handle()
1401 * handles an OST RPC.
1403 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1406 memset(pill, 0, sizeof *pill);
1408 pill->rc_loc = location;
1409 req_capsule_init_area(pill);
1411 if (req != NULL && pill == &req->rq_pill)
1412 req->rq_pill_init = 1;
1414 EXPORT_SYMBOL(req_capsule_init);
1416 void req_capsule_fini(struct req_capsule *pill)
1419 EXPORT_SYMBOL(req_capsule_fini);
1421 static int __req_format_is_sane(const struct req_format *fmt)
1424 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1425 req_formats[fmt->rf_idx] == fmt;
1428 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1429 enum req_location loc)
1431 struct ptlrpc_request *req;
1434 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1438 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1439 * (see req_capsule_extend()).
1441 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1443 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1444 LASSERT(__req_format_is_sane(fmt));
1448 EXPORT_SYMBOL(req_capsule_set);
1451 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1454 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1455 * variable-sized fields. The field sizes come from the declared \a rmf_size
1456 * field of a \a pill's \a rc_fmt's RMF's.
1458 int req_capsule_filled_sizes(struct req_capsule *pill,
1459 enum req_location loc)
1461 const struct req_format *fmt = pill->rc_fmt;
1464 LASSERT(fmt != NULL);
1466 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1467 if (pill->rc_area[loc][i] == -1) {
1468 pill->rc_area[loc][i] =
1469 fmt->rf_fields[loc].d[i]->rmf_size;
1470 if (pill->rc_area[loc][i] == -1) {
1472 * Skip the following fields.
1474 * If this LASSERT() trips then you're missing a
1475 * call to req_capsule_set_size().
1477 LASSERT(loc != RCL_SERVER);
1484 EXPORT_SYMBOL(req_capsule_filled_sizes);
1487 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1489 * This function uses the \a pill's \a rc_area as filled in by
1490 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1493 int req_capsule_server_pack(struct req_capsule *pill)
1495 const struct req_format *fmt;
1499 LASSERT(pill->rc_loc == RCL_SERVER);
1501 LASSERT(fmt != NULL);
1503 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1504 rc = lustre_pack_reply(pill->rc_req, count,
1505 pill->rc_area[RCL_SERVER], NULL);
1507 DEBUG_REQ(D_ERROR, pill->rc_req,
1508 "Cannot pack %d fields in format `%s': ",
1509 count, fmt->rf_name);
1513 EXPORT_SYMBOL(req_capsule_server_pack);
1516 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1517 * corresponding to the given RMF (\a field).
1519 static int __req_capsule_offset(const struct req_capsule *pill,
1520 const struct req_msg_field *field,
1521 enum req_location loc)
1525 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1526 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1527 pill->rc_fmt->rf_name,
1528 field->rmf_name, offset, loc);
1531 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1536 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1541 swabber_dumper_helper(struct req_capsule *pill,
1542 const struct req_msg_field *field,
1543 enum req_location loc,
1545 void *value, int len, int dump, void (*swabber)( void *))
1551 int inout = loc == RCL_CLIENT;
1553 swabber = swabber ?: field->rmf_swabber;
1555 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1556 swabber != NULL && value != NULL)
1561 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1562 if (dump && field->rmf_dumper) {
1563 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1564 do_swab ? "unswabbed " : "", field->rmf_name);
1565 field->rmf_dumper(value);
1570 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1572 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1573 "follows\n", field->rmf_name);
1574 field->rmf_dumper(value);
1581 * We're swabbing an array; swabber() swabs a single array element, so
1582 * swab every element.
1584 LASSERT((len % field->rmf_size) == 0);
1585 for (p = value, i = 0, n = len / field->rmf_size;
1587 i++, p += field->rmf_size) {
1588 if (dump && field->rmf_dumper) {
1589 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1590 "element %d follows\n",
1591 do_swab ? "unswabbed " : "", field->rmf_name, i);
1592 field->rmf_dumper(p);
1597 if (dump && field->rmf_dumper) {
1598 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1599 "element %d follows\n", field->rmf_name, i);
1600 field->rmf_dumper(value);
1604 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1608 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1609 * corresponding to the given RMF (\a field).
1611 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1612 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1613 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1614 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1615 * element of the array swabbed.
1617 static void *__req_capsule_get(struct req_capsule *pill,
1618 const struct req_msg_field *field,
1619 enum req_location loc,
1620 void (*swabber)( void *),
1623 const struct req_format *fmt;
1624 struct lustre_msg *msg;
1629 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1631 static const char *rcl_names[RCL_NR] = {
1632 [RCL_CLIENT] = "client",
1633 [RCL_SERVER] = "server"
1636 LASSERT(pill != NULL);
1637 LASSERT(pill != LP_POISON);
1639 LASSERT(fmt != NULL);
1640 LASSERT(fmt != LP_POISON);
1641 LASSERT(__req_format_is_sane(fmt));
1643 offset = __req_capsule_offset(pill, field, loc);
1645 msg = __req_msg(pill, loc);
1646 LASSERT(msg != NULL);
1648 getter = (field->rmf_flags & RMF_F_STRING) ?
1649 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1651 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1653 * We've already asserted that field->rmf_size > 0 in
1654 * req_layout_init().
1656 len = lustre_msg_buflen(msg, offset);
1657 if ((len % field->rmf_size) != 0) {
1658 CERROR("%s: array field size mismatch "
1659 "%d modulo %d != 0 (%d)\n",
1660 field->rmf_name, len, field->rmf_size, loc);
1663 } else if (pill->rc_area[loc][offset] != -1) {
1664 len = pill->rc_area[loc][offset];
1666 len = max(field->rmf_size, 0);
1668 value = getter(msg, offset, len);
1670 if (value == NULL) {
1671 DEBUG_REQ(D_ERROR, pill->rc_req,
1672 "Wrong buffer for field `%s' (%d of %d) "
1673 "in format `%s': %d vs. %d (%s)\n",
1674 field->rmf_name, offset, lustre_msg_bufcount(msg),
1675 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1678 swabber_dumper_helper(pill, field, loc, offset, value, len,
1686 * Dump a request and/or reply
1688 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1690 const struct req_format *fmt;
1691 const struct req_msg_field *field;
1697 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1698 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1699 field = FMT_FIELD(fmt, loc, i);
1700 if (field->rmf_dumper == NULL) {
1702 * FIXME Add a default hex dumper for fields that don't
1703 * have a specific dumper
1705 len = req_capsule_get_size(pill, field, loc);
1706 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1707 "field size is %d\n", field->rmf_name, len);
1709 /* It's the dumping side-effect that we're interested in */
1710 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1713 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1719 void req_capsule_client_dump(struct req_capsule *pill)
1721 __req_capsule_dump(pill, RCL_CLIENT);
1723 EXPORT_SYMBOL(req_capsule_client_dump);
1728 void req_capsule_server_dump(struct req_capsule *pill)
1730 __req_capsule_dump(pill, RCL_SERVER);
1732 EXPORT_SYMBOL(req_capsule_server_dump);
1735 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
1736 * buffer corresponding to the given RMF (\a field) of a \a pill.
1738 void *req_capsule_client_get(struct req_capsule *pill,
1739 const struct req_msg_field *field)
1741 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1743 EXPORT_SYMBOL(req_capsule_client_get);
1746 * Same as req_capsule_client_get(), but with a \a swabber argument.
1748 * Currently unused; will be removed when req_capsule_server_swab_get() is
1751 void *req_capsule_client_swab_get(struct req_capsule *pill,
1752 const struct req_msg_field *field,
1753 void (*swabber)(void* ))
1755 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
1757 EXPORT_SYMBOL(req_capsule_client_swab_get);
1760 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
1762 * First the \a pill's request \a field's size is set (\a rc_area) using
1763 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1766 void *req_capsule_client_sized_get(struct req_capsule *pill,
1767 const struct req_msg_field *field,
1770 req_capsule_set_size(pill, field, RCL_CLIENT, len);
1771 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1773 EXPORT_SYMBOL(req_capsule_client_sized_get);
1776 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
1777 * buffer corresponding to the given RMF (\a field) of a \a pill.
1779 void *req_capsule_server_get(struct req_capsule *pill,
1780 const struct req_msg_field *field)
1782 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1784 EXPORT_SYMBOL(req_capsule_server_get);
1787 * Same as req_capsule_server_get(), but with a \a swabber argument.
1789 * Ideally all swabbing should be done pursuant to RMF definitions, with no
1790 * swabbing done outside this capsule abstraction.
1792 void *req_capsule_server_swab_get(struct req_capsule *pill,
1793 const struct req_msg_field *field,
1796 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
1798 EXPORT_SYMBOL(req_capsule_server_swab_get);
1801 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
1803 * First the \a pill's request \a field's size is set (\a rc_area) using
1804 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1807 void *req_capsule_server_sized_get(struct req_capsule *pill,
1808 const struct req_msg_field *field,
1811 req_capsule_set_size(pill, field, RCL_SERVER, len);
1812 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1814 EXPORT_SYMBOL(req_capsule_server_sized_get);
1817 * Returns the buffer of a \a pill corresponding to the given \a field from the
1818 * request (if the caller is executing on the server-side) or reply (if the
1819 * caller is executing on the client-side).
1821 * This function convienient for use is code that could be executed on the
1822 * client and server alike.
1824 const void *req_capsule_other_get(struct req_capsule *pill,
1825 const struct req_msg_field *field)
1827 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
1829 EXPORT_SYMBOL(req_capsule_other_get);
1832 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
1833 * field of the given \a pill.
1835 * This function must be used when constructing variable sized fields of a
1838 void req_capsule_set_size(struct req_capsule *pill,
1839 const struct req_msg_field *field,
1840 enum req_location loc, int size)
1842 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1844 if ((size != field->rmf_size) &&
1845 (field->rmf_size != -1) &&
1846 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1848 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1849 (size % field->rmf_size != 0)) {
1850 CERROR("%s: array field size mismatch "
1851 "%d %% %d != 0 (%d)\n",
1852 field->rmf_name, size, field->rmf_size, loc);
1854 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1855 size < field->rmf_size) {
1856 CERROR("%s: field size mismatch %d != %d (%d)\n",
1857 field->rmf_name, size, field->rmf_size, loc);
1862 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
1864 EXPORT_SYMBOL(req_capsule_set_size);
1867 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
1868 * for the given \a pill's given \a field.
1870 * NB: this function doesn't correspond with req_capsule_set_size(), which
1871 * actually sets the size in pill.rc_area[loc][offset], but this function
1872 * returns the message buflen[offset], maybe we should use another name.
1874 int req_capsule_get_size(const struct req_capsule *pill,
1875 const struct req_msg_field *field,
1876 enum req_location loc)
1878 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1880 return lustre_msg_buflen(__req_msg(pill, loc),
1881 __req_capsule_offset(pill, field, loc));
1883 EXPORT_SYMBOL(req_capsule_get_size);
1886 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
1887 * given \a pill's request or reply (\a loc) given the field size recorded in
1888 * the \a pill's rc_area.
1890 * See also req_capsule_set_size().
1892 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
1894 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
1895 pill->rc_fmt->rf_fields[loc].nr,
1896 pill->rc_area[loc]);
1900 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
1901 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
1902 * PTLRPC request or reply given only an RQF (\a fmt).
1904 * This function should not be used for formats which contain variable size
1907 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
1908 enum req_location loc)
1913 * This function should probably LASSERT() that fmt has no fields with
1914 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
1915 * elements in the array there will ultimately be, but then, we could
1916 * assume that there will be at least one element, and that's just what
1919 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
1923 for (; i < fmt->rf_fields[loc].nr; ++i)
1924 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
1925 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
1931 * Changes the format of an RPC.
1933 * The pill must already have been initialized, which means that it already has
1934 * a request format. The new format \a fmt must be an extension of the pill's
1935 * old format. Specifically: the new format must have as many request and reply
1936 * fields as the old one, and all fields shared by the old and new format must
1937 * be at least as large in the new format.
1939 * The new format's fields may be of different "type" than the old format, but
1940 * only for fields that are "opaque" blobs: fields which have a) have no
1941 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
1942 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
1943 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
1944 * according to the key field. When the value, according to the key, contains a
1945 * structure (or array thereof) to be swabbed, the format should be changed to
1946 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
1949 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
1954 const struct req_format *old;
1956 LASSERT(pill->rc_fmt != NULL);
1957 LASSERT(__req_format_is_sane(fmt));
1961 * Sanity checking...
1963 for (i = 0; i < RCL_NR; ++i) {
1964 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
1965 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
1966 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
1968 /* "opaque" fields can be transmogrified */
1969 if (ofield->rmf_swabber == NULL &&
1970 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
1971 (ofield->rmf_size == -1 ||
1972 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
1974 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
1977 * Last field in old format can be shorter than in new.
1979 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
1980 FMT_FIELD(old, i, j)->rmf_size);
1985 EXPORT_SYMBOL(req_capsule_extend);
1988 * This function returns a non-zero value if the given \a field is present in
1989 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
1992 int req_capsule_has_field(const struct req_capsule *pill,
1993 const struct req_msg_field *field,
1994 enum req_location loc)
1996 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1998 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2000 EXPORT_SYMBOL(req_capsule_has_field);
2003 * Returns a non-zero value if the given \a field is present in the given \a
2004 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2006 int req_capsule_field_present(const struct req_capsule *pill,
2007 const struct req_msg_field *field,
2008 enum req_location loc)
2012 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2013 LASSERT(req_capsule_has_field(pill, field, loc));
2015 offset = __req_capsule_offset(pill, field, loc);
2016 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2018 EXPORT_SYMBOL(req_capsule_field_present);
2021 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2022 * request or reply (\a loc).
2024 * This is not the opposite of req_capsule_extend().
2026 void req_capsule_shrink(struct req_capsule *pill,
2027 const struct req_msg_field *field,
2028 unsigned int newlen,
2029 enum req_location loc)
2031 const struct req_format *fmt;
2032 struct lustre_msg *msg;
2037 LASSERT(fmt != NULL);
2038 LASSERT(__req_format_is_sane(fmt));
2039 LASSERT(req_capsule_has_field(pill, field, loc));
2040 LASSERT(req_capsule_field_present(pill, field, loc));
2042 offset = __req_capsule_offset(pill, field, loc);
2044 msg = __req_msg(pill, loc);
2045 len = lustre_msg_buflen(msg, offset);
2046 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2047 fmt->rf_name, field->rmf_name, len, newlen);
2049 if (loc == RCL_CLIENT)
2050 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2053 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2056 EXPORT_SYMBOL(req_capsule_shrink);
2058 /* __REQ_LAYOUT_USER__ */