4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/ptlrpc/layout.c
33 * Lustre Metadata Target (mdt) request handler
35 * Author: Nikita Danilov <nikita@clusterfs.com>
38 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
40 * Every struct ptlrpc_request contains a "pill", which points to a description
41 * of the format that the request conforms to.
44 #define DEBUG_SUBSYSTEM S_RPC
46 #include <linux/module.h>
48 #include <llog_swab.h>
49 #include <lustre_swab.h>
51 #include <obd_support.h>
53 /* struct ptlrpc_request, lustre_msg* */
54 #include <lustre_req_layout.h>
55 #include <lustre_acl.h>
56 #include <lustre_nodemap.h>
59 * RQFs (see below) refer to two struct req_msg_field arrays describing the
60 * client request and server reply, respectively.
62 /* empty set of fields... for suitable definition of emptiness. */
63 static const struct req_msg_field *empty[] = {
67 static const struct req_msg_field *mgs_target_info_only[] = {
72 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
73 static const struct req_msg_field *mgs_set_info[] = {
79 static const struct req_msg_field *mgs_config_read_client[] = {
84 static const struct req_msg_field *mgs_config_read_server[] = {
89 static const struct req_msg_field *mdt_body_only[] = {
94 static const struct req_msg_field *mdt_body_capa[] = {
100 static const struct req_msg_field *quotactl_only[] = {
105 static const struct req_msg_field *quota_body_only[] = {
110 static const struct req_msg_field *ldlm_intent_quota_client[] = {
117 static const struct req_msg_field *ldlm_intent_quota_server[] = {
124 static const struct req_msg_field *mdt_close_client[] = {
131 static const struct req_msg_field *mdt_close_intent_client[] = {
140 static const struct req_msg_field *obd_statfs_server[] = {
145 static const struct req_msg_field *seq_query_client[] = {
151 static const struct req_msg_field *seq_query_server[] = {
156 static const struct req_msg_field *fld_query_client[] = {
162 static const struct req_msg_field *fld_query_server[] = {
167 static const struct req_msg_field *fld_read_client[] = {
172 static const struct req_msg_field *fld_read_server[] = {
177 static const struct req_msg_field *mds_getattr_name_client[] = {
184 static const struct req_msg_field *mds_reint_client[] = {
189 static const struct req_msg_field *mds_reint_create_client[] = {
196 static const struct req_msg_field *mds_reint_create_slave_client[] = {
205 static const struct req_msg_field *mds_reint_create_acl_client[] = {
212 &RMF_FILE_SECCTX_NAME,
218 static const struct req_msg_field *mds_reint_create_sym_client[] = {
225 &RMF_FILE_SECCTX_NAME,
231 static const struct req_msg_field *mds_reint_open_client[] = {
238 &RMF_FILE_SECCTX_NAME,
244 static const struct req_msg_field *mds_reint_open_server[] = {
253 static const struct req_msg_field *mds_reint_unlink_client[] = {
262 static const struct req_msg_field *mds_reint_link_client[] = {
272 static const struct req_msg_field *mds_reint_rename_client[] = {
283 static const struct req_msg_field *mds_reint_migrate_client[] = {
297 static const struct req_msg_field *mds_last_unlink_server[] = {
306 static const struct req_msg_field *mds_reint_setattr_client[] = {
316 static const struct req_msg_field *mds_reint_setxattr_client[] = {
326 static const struct req_msg_field *mds_reint_resync[] = {
332 static const struct req_msg_field *mdt_swap_layouts[] = {
341 static const struct req_msg_field *mds_rmfid_client[] = {
349 static const struct req_msg_field *mds_rmfid_server[] = {
356 static const struct req_msg_field *obd_connect_client[] = {
365 static const struct req_msg_field *obd_connect_server[] = {
370 static const struct req_msg_field *obd_set_info_client[] = {
376 static const struct req_msg_field *mdt_set_info_client[] = {
383 static const struct req_msg_field *ost_grant_shrink_client[] = {
389 static const struct req_msg_field *mds_getinfo_client[] = {
395 static const struct req_msg_field *mds_getinfo_server[] = {
400 static const struct req_msg_field *ldlm_enqueue_client[] = {
405 static const struct req_msg_field *ldlm_enqueue_server[] = {
410 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
416 static const struct req_msg_field *ldlm_cp_callback_client[] = {
422 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
428 static const struct req_msg_field *ldlm_gl_callback_server[] = {
433 static const struct req_msg_field *ldlm_intent_basic_client[] = {
439 static const struct req_msg_field *ldlm_intent_client[] = {
446 static const struct req_msg_field *ldlm_intent_server[] = {
454 static const struct req_msg_field *ldlm_intent_layout_client[] = {
459 &RMF_EADATA /* for new layout to be set up */
462 static const struct req_msg_field *ldlm_intent_open_server[] = {
475 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
479 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
482 &RMF_FILE_SECCTX_NAME
485 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
497 static const struct req_msg_field *ldlm_intent_create_client[] = {
501 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
505 &RMF_FILE_SECCTX_NAME,
511 static const struct req_msg_field *ldlm_intent_open_client[] = {
515 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
520 &RMF_FILE_SECCTX_NAME,
526 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
535 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
540 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
546 static const struct req_msg_field *mds_get_root_client[] = {
552 static const struct req_msg_field *mds_getxattr_client[] = {
561 static const struct req_msg_field *mds_getxattr_server[] = {
567 static const struct req_msg_field *mds_getattr_server[] = {
576 static const struct req_msg_field *mds_setattr_server[] = {
585 static const struct req_msg_field *llog_origin_handle_create_client[] = {
592 static const struct req_msg_field *llogd_body_only[] = {
597 static const struct req_msg_field *llog_log_hdr_only[] = {
602 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
608 static const struct req_msg_field *obd_idx_read_client[] = {
613 static const struct req_msg_field *obd_idx_read_server[] = {
618 static const struct req_msg_field *ost_body_only[] = {
623 static const struct req_msg_field *ost_body_capa[] = {
629 static const struct req_msg_field *ost_destroy_client[] = {
637 static const struct req_msg_field *ost_brw_client[] = {
646 static const struct req_msg_field *ost_brw_read_server[] = {
652 static const struct req_msg_field *ost_brw_write_server[] = {
658 static const struct req_msg_field *ost_get_info_generic_server[] = {
663 static const struct req_msg_field *ost_get_info_generic_client[] = {
668 static const struct req_msg_field *ost_get_last_id_server[] = {
673 static const struct req_msg_field *ost_get_last_fid_client[] = {
679 static const struct req_msg_field *ost_get_last_fid_server[] = {
684 static const struct req_msg_field *ost_get_fiemap_client[] = {
690 static const struct req_msg_field *ost_ladvise[] = {
693 &RMF_OST_LADVISE_HDR,
697 static const struct req_msg_field *ost_get_fiemap_server[] = {
702 static const struct req_msg_field *mdt_hsm_progress[] = {
705 &RMF_MDS_HSM_PROGRESS,
708 static const struct req_msg_field *mdt_hsm_ct_register[] = {
711 &RMF_MDS_HSM_ARCHIVE,
714 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
719 static const struct req_msg_field *mdt_hsm_action_server[] = {
722 &RMF_MDS_HSM_CURRENT_ACTION,
725 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
731 static const struct req_msg_field *mdt_hsm_state_set[] = {
738 static const struct req_msg_field *mdt_hsm_request[] = {
741 &RMF_MDS_HSM_REQUEST,
742 &RMF_MDS_HSM_USER_ITEM,
746 static const struct req_msg_field *obd_lfsck_request[] = {
751 static const struct req_msg_field *obd_lfsck_reply[] = {
756 static struct req_format *req_formats[] = {
763 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
766 &RQF_MGS_CONFIG_READ,
777 &RQF_MDS_GETATTR_NAME,
781 &RQF_MDS_CLOSE_INTENT,
784 &RQF_MDS_REINT_CREATE,
785 &RQF_MDS_REINT_CREATE_ACL,
786 &RQF_MDS_REINT_CREATE_SLAVE,
787 &RQF_MDS_REINT_CREATE_SYM,
789 &RQF_MDS_REINT_UNLINK,
791 &RQF_MDS_REINT_RENAME,
792 &RQF_MDS_REINT_MIGRATE,
793 &RQF_MDS_REINT_SETATTR,
794 &RQF_MDS_REINT_SETXATTR,
795 &RQF_MDS_REINT_RESYNC,
797 &RQF_MDS_HSM_PROGRESS,
798 &RQF_MDS_HSM_CT_REGISTER,
799 &RQF_MDS_HSM_CT_UNREGISTER,
800 &RQF_MDS_HSM_STATE_GET,
801 &RQF_MDS_HSM_STATE_SET,
803 &RQF_MDS_HSM_REQUEST,
804 &RQF_MDS_SWAP_LAYOUTS,
806 #ifdef HAVE_SERVER_SUPPORT
822 &RQF_OST_SET_GRANT_INFO,
824 &RQF_OST_GET_INFO_LAST_ID,
825 &RQF_OST_GET_INFO_LAST_FID,
826 &RQF_OST_SET_INFO_LAST_FID,
827 &RQF_OST_GET_INFO_FIEMAP,
831 &RQF_LDLM_ENQUEUE_LVB,
835 &RQF_LDLM_CP_CALLBACK,
836 &RQF_LDLM_BL_CALLBACK,
837 &RQF_LDLM_GL_CALLBACK,
838 &RQF_LDLM_GL_CALLBACK_DESC,
840 &RQF_LDLM_INTENT_BASIC,
841 &RQF_LDLM_INTENT_LAYOUT,
842 &RQF_LDLM_INTENT_GETATTR,
843 &RQF_LDLM_INTENT_OPEN,
844 &RQF_LDLM_INTENT_CREATE,
845 &RQF_LDLM_INTENT_GETXATTR,
846 &RQF_LDLM_INTENT_QUOTA,
848 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
849 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
850 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
851 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
857 struct req_msg_field {
858 const __u32 rmf_flags;
859 const char *rmf_name;
861 * Field length. (-1) means "variable length". If the
862 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
863 * but the actual size must be a whole multiple of \a rmf_size.
866 void (*rmf_swabber)(void *);
868 * Pass buffer size to swabbing function
869 * \retval > 0 the number of bytes swabbed
870 * -EOVERFLOW on error
872 int (*rmf_swab_len)(void *, __u32);
873 void (*rmf_dumper)(void *);
874 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
879 * The field is a string, must be NUL-terminated.
881 RMF_F_STRING = BIT(0),
883 * The field's buffer size need not match the declared \a rmf_size.
885 RMF_F_NO_SIZE_CHECK = BIT(1),
887 * The field's buffer size must be a whole multiple of the declared \a
888 * rmf_size and the \a rmf_swabber function must work on the declared \a
889 * rmf_size worth of bytes.
891 RMF_F_STRUCT_ARRAY = BIT(2),
899 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
900 .rmf_name = (name), \
901 .rmf_flags = (flags), \
902 .rmf_size = (size), \
903 .rmf_swabber = (void (*)(void*))(swabber), \
904 .rmf_dumper = (void (*)(void*))(dumper) \
907 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
908 .rmf_name = (name), \
909 .rmf_flags = (flags), \
910 .rmf_size = (size), \
911 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
912 .rmf_dumper = (void (*)(void *))(dumper) \
915 struct req_msg_field RMF_GENERIC_DATA =
916 DEFINE_MSGF("generic_data", 0,
918 EXPORT_SYMBOL(RMF_GENERIC_DATA);
920 struct req_msg_field RMF_MGS_TARGET_INFO =
921 DEFINE_MSGF("mgs_target_info", 0,
922 sizeof(struct mgs_target_info),
923 lustre_swab_mgs_target_info, NULL);
924 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
926 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
927 struct req_msg_field RMF_MGS_SEND_PARAM =
928 DEFINE_MSGF("mgs_send_param", 0,
929 sizeof(struct mgs_send_param),
931 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
934 struct req_msg_field RMF_MGS_CONFIG_BODY =
935 DEFINE_MSGF("mgs_config_read request", 0,
936 sizeof(struct mgs_config_body),
937 lustre_swab_mgs_config_body, NULL);
938 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
940 struct req_msg_field RMF_MGS_CONFIG_RES =
941 DEFINE_MSGF("mgs_config_read reply ", 0,
942 sizeof(struct mgs_config_res),
943 lustre_swab_mgs_config_res, NULL);
944 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
946 struct req_msg_field RMF_U32 =
947 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
948 sizeof(__u32), lustre_swab_generic_32s, NULL);
949 EXPORT_SYMBOL(RMF_U32);
951 struct req_msg_field RMF_SETINFO_VAL =
952 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
953 EXPORT_SYMBOL(RMF_SETINFO_VAL);
955 struct req_msg_field RMF_GETINFO_KEY =
956 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
957 EXPORT_SYMBOL(RMF_GETINFO_KEY);
959 struct req_msg_field RMF_GETINFO_VALLEN =
960 DEFINE_MSGF("getinfo_vallen", 0,
961 sizeof(__u32), lustre_swab_generic_32s, NULL);
962 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
964 struct req_msg_field RMF_GETINFO_VAL =
965 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
966 EXPORT_SYMBOL(RMF_GETINFO_VAL);
968 struct req_msg_field RMF_SEQ_OPC =
969 DEFINE_MSGF("seq_query_opc", 0,
970 sizeof(__u32), lustre_swab_generic_32s, NULL);
971 EXPORT_SYMBOL(RMF_SEQ_OPC);
973 struct req_msg_field RMF_SEQ_RANGE =
974 DEFINE_MSGF("seq_query_range", 0,
975 sizeof(struct lu_seq_range),
976 lustre_swab_lu_seq_range, NULL);
977 EXPORT_SYMBOL(RMF_SEQ_RANGE);
979 struct req_msg_field RMF_FLD_OPC =
980 DEFINE_MSGF("fld_query_opc", 0,
981 sizeof(__u32), lustre_swab_generic_32s, NULL);
982 EXPORT_SYMBOL(RMF_FLD_OPC);
984 struct req_msg_field RMF_FLD_MDFLD =
985 DEFINE_MSGF("fld_query_mdfld", 0,
986 sizeof(struct lu_seq_range),
987 lustre_swab_lu_seq_range, NULL);
988 EXPORT_SYMBOL(RMF_FLD_MDFLD);
990 struct req_msg_field RMF_MDT_BODY =
991 DEFINE_MSGF("mdt_body", 0,
992 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
993 EXPORT_SYMBOL(RMF_MDT_BODY);
995 struct req_msg_field RMF_OBD_QUOTACTL =
996 DEFINE_MSGFL("obd_quotactl",
998 sizeof(struct obd_quotactl),
999 lustre_swab_obd_quotactl, NULL);
1000 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
1002 struct req_msg_field RMF_QUOTA_BODY =
1003 DEFINE_MSGF("quota_body", 0,
1004 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
1005 EXPORT_SYMBOL(RMF_QUOTA_BODY);
1007 struct req_msg_field RMF_MDT_EPOCH =
1008 DEFINE_MSGF("mdt_ioepoch", 0,
1009 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
1010 EXPORT_SYMBOL(RMF_MDT_EPOCH);
1012 struct req_msg_field RMF_PTLRPC_BODY =
1013 DEFINE_MSGF("ptlrpc_body", 0,
1014 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
1015 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
1017 struct req_msg_field RMF_CLOSE_DATA =
1018 DEFINE_MSGF("data_version", 0,
1019 sizeof(struct close_data), lustre_swab_close_data, NULL);
1020 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1022 struct req_msg_field RMF_OBD_STATFS =
1023 DEFINE_MSGF("obd_statfs", 0,
1024 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1025 EXPORT_SYMBOL(RMF_OBD_STATFS);
1027 struct req_msg_field RMF_SETINFO_KEY =
1028 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1029 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1031 struct req_msg_field RMF_NAME =
1032 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1033 EXPORT_SYMBOL(RMF_NAME);
1035 struct req_msg_field RMF_FID_ARRAY =
1036 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1037 EXPORT_SYMBOL(RMF_FID_ARRAY);
1039 struct req_msg_field RMF_SYMTGT =
1040 DEFINE_MSGF("symtgt", 0, -1, NULL, NULL);
1041 EXPORT_SYMBOL(RMF_SYMTGT);
1043 struct req_msg_field RMF_TGTUUID =
1044 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1046 EXPORT_SYMBOL(RMF_TGTUUID);
1048 struct req_msg_field RMF_CLUUID =
1049 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1051 EXPORT_SYMBOL(RMF_CLUUID);
1053 struct req_msg_field RMF_STRING =
1054 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1055 EXPORT_SYMBOL(RMF_STRING);
1057 struct req_msg_field RMF_FILE_SECCTX_NAME =
1058 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1059 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1061 struct req_msg_field RMF_FILE_SECCTX =
1062 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1063 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1065 struct req_msg_field RMF_FILE_ENCCTX =
1066 DEFINE_MSGF("file_encctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1067 EXPORT_SYMBOL(RMF_FILE_ENCCTX);
1069 struct req_msg_field RMF_LLOGD_BODY =
1070 DEFINE_MSGF("llogd_body", 0,
1071 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1072 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1074 struct req_msg_field RMF_LLOG_LOG_HDR =
1075 DEFINE_MSGF("llog_log_hdr", 0,
1076 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1077 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1079 struct req_msg_field RMF_LLOGD_CONN_BODY =
1080 DEFINE_MSGF("llogd_conn_body", 0,
1081 sizeof(struct llogd_conn_body),
1082 lustre_swab_llogd_conn_body, NULL);
1083 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1086 * connection handle received in MDS_CONNECT request.
1088 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1089 * that the client does not interpret at all.
1091 struct req_msg_field RMF_CONN =
1092 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1093 EXPORT_SYMBOL(RMF_CONN);
1095 struct req_msg_field RMF_CONNECT_DATA =
1096 DEFINE_MSGF("cdata",
1097 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1098 sizeof(struct obd_connect_data),
1099 lustre_swab_connect, NULL);
1100 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1102 struct req_msg_field RMF_DLM_REQ =
1103 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1104 sizeof(struct ldlm_request),
1105 lustre_swab_ldlm_request, NULL);
1106 EXPORT_SYMBOL(RMF_DLM_REQ);
1108 struct req_msg_field RMF_DLM_REP =
1109 DEFINE_MSGF("dlm_rep", 0,
1110 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1111 EXPORT_SYMBOL(RMF_DLM_REP);
1113 struct req_msg_field RMF_LDLM_INTENT =
1114 DEFINE_MSGF("ldlm_intent", 0,
1115 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1116 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1118 struct req_msg_field RMF_DLM_LVB =
1119 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1120 EXPORT_SYMBOL(RMF_DLM_LVB);
1122 struct req_msg_field RMF_DLM_GL_DESC =
1123 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1124 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1126 struct req_msg_field RMF_MDT_MD =
1127 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1128 EXPORT_SYMBOL(RMF_MDT_MD);
1130 struct req_msg_field RMF_DEFAULT_MDT_MD =
1131 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1133 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1135 struct req_msg_field RMF_REC_REINT =
1136 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1137 lustre_swab_mdt_rec_reint, NULL);
1138 EXPORT_SYMBOL(RMF_REC_REINT);
1140 /* FIXME: this length should be defined as a macro */
1141 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1143 EXPORT_SYMBOL(RMF_EADATA);
1145 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1146 EXPORT_SYMBOL(RMF_EAVALS);
1148 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1149 EXPORT_SYMBOL(RMF_ACL);
1151 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1152 struct req_msg_field RMF_LOGCOOKIES =
1153 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1154 sizeof(struct llog_cookie), NULL, NULL);
1155 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1157 struct req_msg_field RMF_CAPA1 =
1158 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1159 EXPORT_SYMBOL(RMF_CAPA1);
1161 struct req_msg_field RMF_CAPA2 =
1162 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1163 EXPORT_SYMBOL(RMF_CAPA2);
1165 struct req_msg_field RMF_LAYOUT_INTENT =
1166 DEFINE_MSGF("layout_intent", 0,
1167 sizeof(struct layout_intent), lustre_swab_layout_intent,
1169 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1171 struct req_msg_field RMF_SELINUX_POL =
1172 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1173 EXPORT_SYMBOL(RMF_SELINUX_POL);
1176 * OST request field.
1178 struct req_msg_field RMF_OST_BODY =
1179 DEFINE_MSGF("ost_body", 0,
1180 sizeof(struct ost_body), lustre_swab_ost_body,
1182 EXPORT_SYMBOL(RMF_OST_BODY);
1184 struct req_msg_field RMF_OBD_IOOBJ =
1185 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1186 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1187 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1189 struct req_msg_field RMF_NIOBUF_REMOTE =
1190 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1191 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1193 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1195 struct req_msg_field RMF_NIOBUF_INLINE =
1196 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1197 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1199 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1201 struct req_msg_field RMF_RCS =
1202 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1203 lustre_swab_generic_32s, dump_rcs);
1204 EXPORT_SYMBOL(RMF_RCS);
1206 struct req_msg_field RMF_EAVALS_LENS =
1207 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1208 lustre_swab_generic_32s, NULL);
1209 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1211 struct req_msg_field RMF_OBD_ID =
1212 DEFINE_MSGF("obd_id", 0,
1213 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1214 EXPORT_SYMBOL(RMF_OBD_ID);
1216 struct req_msg_field RMF_FID =
1217 DEFINE_MSGF("fid", 0,
1218 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1219 EXPORT_SYMBOL(RMF_FID);
1221 struct req_msg_field RMF_OST_ID =
1222 DEFINE_MSGF("ost_id", 0,
1223 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1224 EXPORT_SYMBOL(RMF_OST_ID);
1226 struct req_msg_field RMF_FIEMAP_KEY =
1227 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1228 lustre_swab_fiemap_info_key, NULL);
1229 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1231 struct req_msg_field RMF_FIEMAP_VAL =
1232 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1233 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1235 struct req_msg_field RMF_IDX_INFO =
1236 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1237 lustre_swab_idx_info, NULL);
1238 EXPORT_SYMBOL(RMF_IDX_INFO);
1239 struct req_msg_field RMF_SHORT_IO =
1240 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1241 EXPORT_SYMBOL(RMF_SHORT_IO);
1242 struct req_msg_field RMF_HSM_USER_STATE =
1243 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1244 lustre_swab_hsm_user_state, NULL);
1245 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1247 struct req_msg_field RMF_HSM_STATE_SET =
1248 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1249 lustre_swab_hsm_state_set, NULL);
1250 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1252 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1253 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1254 lustre_swab_hsm_progress_kernel, NULL);
1255 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1257 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1258 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1259 lustre_swab_hsm_current_action, NULL);
1260 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1262 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1263 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1264 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1266 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1268 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1269 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1270 sizeof(__u32), lustre_swab_generic_32s, NULL);
1271 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1273 struct req_msg_field RMF_MDS_HSM_REQUEST =
1274 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1275 lustre_swab_hsm_request, NULL);
1276 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1278 struct req_msg_field RMF_SWAP_LAYOUTS =
1279 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1280 lustre_swab_swap_layouts, NULL);
1281 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1283 struct req_msg_field RMF_LFSCK_REQUEST =
1284 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1285 lustre_swab_lfsck_request, NULL);
1286 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1288 struct req_msg_field RMF_LFSCK_REPLY =
1289 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1290 lustre_swab_lfsck_reply, NULL);
1291 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1293 struct req_msg_field RMF_OST_LADVISE_HDR =
1294 DEFINE_MSGF("ladvise_request", 0,
1295 sizeof(struct ladvise_hdr),
1296 lustre_swab_ladvise_hdr, NULL);
1297 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1299 struct req_msg_field RMF_OST_LADVISE =
1300 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1301 sizeof(struct lu_ladvise),
1302 lustre_swab_ladvise, NULL);
1303 EXPORT_SYMBOL(RMF_OST_LADVISE);
1310 const char *rf_name;
1314 const struct req_msg_field **d;
1315 } rf_fields[RCL_NR];
1318 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1332 #define DEFINE_REQ_FMT0(name, client, server) \
1333 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1335 struct req_format RQF_OBD_PING =
1336 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1337 EXPORT_SYMBOL(RQF_OBD_PING);
1339 struct req_format RQF_OBD_SET_INFO =
1340 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1341 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1343 struct req_format RQF_MDT_SET_INFO =
1344 DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1345 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1347 /* Read index file through the network */
1348 struct req_format RQF_OBD_IDX_READ =
1349 DEFINE_REQ_FMT0("OBD_IDX_READ",
1350 obd_idx_read_client, obd_idx_read_server);
1351 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1353 struct req_format RQF_SEC_CTX =
1354 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1355 EXPORT_SYMBOL(RQF_SEC_CTX);
1357 struct req_format RQF_MGS_TARGET_REG =
1358 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1359 mgs_target_info_only);
1360 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1362 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1363 struct req_format RQF_MGS_SET_INFO =
1364 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1366 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1369 struct req_format RQF_MGS_CONFIG_READ =
1370 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1371 mgs_config_read_server);
1372 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1374 struct req_format RQF_SEQ_QUERY =
1375 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1376 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1378 struct req_format RQF_FLD_QUERY =
1379 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1380 EXPORT_SYMBOL(RQF_FLD_QUERY);
1382 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1383 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1384 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1385 * peers need to handle the RPC reply with fixed little-endian format.
1387 * In theory, we can define new structure with some swabber registered to
1388 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1389 * implementation view, it is not easy to be done within current "struct
1390 * req_msg_field" framework. Because the sequence range array in the RPC
1391 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1392 * count, that is unknown when prepare the RPC buffer. Generally, for such
1393 * flexible length RPC usage, there will be a field in the RPC layout to
1394 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1395 * do that unless we add new length filed that will broken the on-wire RPC
1396 * protocol and cause interoperability trouble with old peer. */
1397 struct req_format RQF_FLD_READ =
1398 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1399 EXPORT_SYMBOL(RQF_FLD_READ);
1401 struct req_format RQF_MDS_QUOTACTL =
1402 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1403 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1405 struct req_format RQF_OST_QUOTACTL =
1406 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1407 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1409 struct req_format RQF_QUOTA_DQACQ =
1410 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1411 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1413 struct req_format RQF_LDLM_INTENT_QUOTA =
1414 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1415 ldlm_intent_quota_client,
1416 ldlm_intent_quota_server);
1417 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1419 struct req_format RQF_MDS_GET_ROOT =
1420 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1421 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1423 struct req_format RQF_MDS_STATFS =
1424 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1425 EXPORT_SYMBOL(RQF_MDS_STATFS);
1427 struct req_format RQF_MDS_STATFS_NEW =
1428 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1429 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1431 struct req_format RQF_MDS_SYNC =
1432 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1433 EXPORT_SYMBOL(RQF_MDS_SYNC);
1435 struct req_format RQF_MDS_GETATTR =
1436 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1437 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1439 struct req_format RQF_MDS_GETXATTR =
1440 DEFINE_REQ_FMT0("MDS_GETXATTR",
1441 mds_getxattr_client, mds_getxattr_server);
1442 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1444 struct req_format RQF_MDS_GETATTR_NAME =
1445 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1446 mds_getattr_name_client, mds_getattr_server);
1447 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1449 struct req_format RQF_MDS_REINT =
1450 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1451 EXPORT_SYMBOL(RQF_MDS_REINT);
1453 struct req_format RQF_MDS_REINT_CREATE =
1454 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1455 mds_reint_create_client, mdt_body_capa);
1456 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1458 struct req_format RQF_MDS_REINT_CREATE_ACL =
1459 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1460 mds_reint_create_acl_client, mdt_body_capa);
1461 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1463 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1464 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1465 mds_reint_create_slave_client, mdt_body_capa);
1466 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1468 struct req_format RQF_MDS_REINT_CREATE_SYM =
1469 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1470 mds_reint_create_sym_client, mdt_body_capa);
1471 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1473 struct req_format RQF_MDS_REINT_OPEN =
1474 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1475 mds_reint_open_client, mds_reint_open_server);
1476 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1478 struct req_format RQF_MDS_REINT_UNLINK =
1479 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1480 mds_last_unlink_server);
1481 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1483 struct req_format RQF_MDS_REINT_LINK =
1484 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1485 mds_reint_link_client, mdt_body_only);
1486 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1488 struct req_format RQF_MDS_REINT_RENAME =
1489 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1490 mds_last_unlink_server);
1491 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1493 struct req_format RQF_MDS_REINT_MIGRATE =
1494 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1495 mds_last_unlink_server);
1496 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1498 struct req_format RQF_MDS_REINT_SETATTR =
1499 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1500 mds_reint_setattr_client, mds_setattr_server);
1501 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1503 struct req_format RQF_MDS_REINT_SETXATTR =
1504 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1505 mds_reint_setxattr_client, mdt_body_only);
1506 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1508 struct req_format RQF_MDS_REINT_RESYNC =
1509 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1510 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1512 struct req_format RQF_MDS_CONNECT =
1513 DEFINE_REQ_FMT0("MDS_CONNECT",
1514 obd_connect_client, obd_connect_server);
1515 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1517 struct req_format RQF_MDS_DISCONNECT =
1518 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1519 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1521 struct req_format RQF_MDS_GET_INFO =
1522 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1523 mds_getinfo_server);
1524 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1526 struct req_format RQF_LDLM_ENQUEUE =
1527 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1528 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1529 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1531 struct req_format RQF_LDLM_ENQUEUE_LVB =
1532 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1533 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1534 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1536 struct req_format RQF_LDLM_CONVERT =
1537 DEFINE_REQ_FMT0("LDLM_CONVERT",
1538 ldlm_enqueue_client, ldlm_enqueue_server);
1539 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1541 struct req_format RQF_LDLM_CANCEL =
1542 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1543 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1545 struct req_format RQF_LDLM_CALLBACK =
1546 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1547 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1549 struct req_format RQF_LDLM_CP_CALLBACK =
1550 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1551 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1553 struct req_format RQF_LDLM_BL_CALLBACK =
1554 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1555 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1557 struct req_format RQF_LDLM_GL_CALLBACK =
1558 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1559 ldlm_gl_callback_server);
1560 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1562 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1563 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1564 ldlm_gl_callback_server);
1565 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1567 struct req_format RQF_LDLM_INTENT_BASIC =
1568 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1569 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1570 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1572 struct req_format RQF_LDLM_INTENT =
1573 DEFINE_REQ_FMT0("LDLM_INTENT",
1574 ldlm_intent_client, ldlm_intent_server);
1575 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1577 struct req_format RQF_LDLM_INTENT_LAYOUT =
1578 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1579 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1580 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1582 struct req_format RQF_LDLM_INTENT_GETATTR =
1583 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1584 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1585 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1587 struct req_format RQF_LDLM_INTENT_OPEN =
1588 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1589 ldlm_intent_open_client, ldlm_intent_open_server);
1590 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1592 struct req_format RQF_LDLM_INTENT_CREATE =
1593 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1594 ldlm_intent_create_client, ldlm_intent_getattr_server);
1595 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1597 struct req_format RQF_LDLM_INTENT_GETXATTR =
1598 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1599 ldlm_intent_getxattr_client,
1600 ldlm_intent_getxattr_server);
1601 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1603 struct req_format RQF_MDS_CLOSE =
1604 DEFINE_REQ_FMT0("MDS_CLOSE",
1605 mdt_close_client, mds_last_unlink_server);
1606 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1608 struct req_format RQF_MDS_CLOSE_INTENT =
1609 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1610 mdt_close_intent_client, mds_last_unlink_server);
1611 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1613 struct req_format RQF_MDS_READPAGE =
1614 DEFINE_REQ_FMT0("MDS_READPAGE",
1615 mdt_body_capa, mdt_body_only);
1616 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1618 struct req_format RQF_MDS_HSM_ACTION =
1619 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1620 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1622 struct req_format RQF_MDS_HSM_PROGRESS =
1623 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1624 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1626 struct req_format RQF_MDS_HSM_CT_REGISTER =
1627 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1628 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1630 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1631 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1632 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1634 struct req_format RQF_MDS_HSM_STATE_GET =
1635 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1636 mdt_body_capa, mdt_hsm_state_get_server);
1637 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1639 struct req_format RQF_MDS_HSM_STATE_SET =
1640 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1641 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1643 struct req_format RQF_MDS_HSM_REQUEST =
1644 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1645 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1647 struct req_format RQF_MDS_SWAP_LAYOUTS =
1648 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1649 mdt_swap_layouts, empty);
1650 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1652 struct req_format RQF_MDS_RMFID =
1653 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1655 EXPORT_SYMBOL(RQF_MDS_RMFID);
1657 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1658 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1659 llog_origin_handle_create_client, llogd_body_only);
1660 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1662 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1663 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1664 llogd_body_only, llog_origin_handle_next_block_server);
1665 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1667 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1668 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1669 llogd_body_only, llog_origin_handle_next_block_server);
1670 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1672 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1673 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1674 llogd_body_only, llog_log_hdr_only);
1675 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1677 struct req_format RQF_CONNECT =
1678 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1679 EXPORT_SYMBOL(RQF_CONNECT);
1681 struct req_format RQF_OST_CONNECT =
1682 DEFINE_REQ_FMT0("OST_CONNECT",
1683 obd_connect_client, obd_connect_server);
1684 EXPORT_SYMBOL(RQF_OST_CONNECT);
1686 struct req_format RQF_OST_DISCONNECT =
1687 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1688 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1690 struct req_format RQF_OST_GETATTR =
1691 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1692 EXPORT_SYMBOL(RQF_OST_GETATTR);
1694 struct req_format RQF_OST_SETATTR =
1695 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1696 EXPORT_SYMBOL(RQF_OST_SETATTR);
1698 struct req_format RQF_OST_CREATE =
1699 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1700 EXPORT_SYMBOL(RQF_OST_CREATE);
1702 struct req_format RQF_OST_PUNCH =
1703 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1704 EXPORT_SYMBOL(RQF_OST_PUNCH);
1706 struct req_format RQF_OST_FALLOCATE =
1707 DEFINE_REQ_FMT0("OST_FALLOCATE", ost_body_capa, ost_body_only);
1708 EXPORT_SYMBOL(RQF_OST_FALLOCATE);
1710 struct req_format RQF_OST_SEEK =
1711 DEFINE_REQ_FMT0("OST_SEEK", ost_body_only, ost_body_only);
1712 EXPORT_SYMBOL(RQF_OST_SEEK);
1714 struct req_format RQF_OST_SYNC =
1715 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1716 EXPORT_SYMBOL(RQF_OST_SYNC);
1718 struct req_format RQF_OST_DESTROY =
1719 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1720 EXPORT_SYMBOL(RQF_OST_DESTROY);
1722 struct req_format RQF_OST_BRW_READ =
1723 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1724 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1726 struct req_format RQF_OST_BRW_WRITE =
1727 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1728 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1730 struct req_format RQF_OST_STATFS =
1731 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1732 EXPORT_SYMBOL(RQF_OST_STATFS);
1734 struct req_format RQF_OST_SET_GRANT_INFO =
1735 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1737 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1739 struct req_format RQF_OST_GET_INFO =
1740 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1741 ost_get_info_generic_server);
1742 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1744 struct req_format RQF_OST_GET_INFO_LAST_ID =
1745 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1746 ost_get_last_id_server);
1747 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1749 struct req_format RQF_OST_GET_INFO_LAST_FID =
1750 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1751 ost_get_last_fid_server);
1752 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1754 struct req_format RQF_OST_SET_INFO_LAST_FID =
1755 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1757 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1759 struct req_format RQF_OST_GET_INFO_FIEMAP =
1760 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1761 ost_get_fiemap_server);
1762 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1764 struct req_format RQF_LFSCK_NOTIFY =
1765 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1766 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1768 struct req_format RQF_LFSCK_QUERY =
1769 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1770 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1772 struct req_format RQF_OST_LADVISE =
1773 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1774 EXPORT_SYMBOL(RQF_OST_LADVISE);
1776 /* Convenience macro */
1777 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1780 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1781 * field of RQFs and the \a rmf_offset field of RMFs.
1783 int req_layout_init(void)
1788 struct req_format *rf = NULL;
1790 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1791 rf = req_formats[i];
1793 for (j = 0; j < RCL_NR; ++j) {
1794 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1795 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1796 struct req_msg_field *field;
1798 field = (typeof(field))rf->rf_fields[j].d[k];
1799 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1800 || field->rmf_size > 0);
1801 LASSERT(field->rmf_offset[i][j] == 0);
1803 * k + 1 to detect unused format/field
1806 field->rmf_offset[i][j] = k + 1;
1812 EXPORT_SYMBOL(req_layout_init);
1814 void req_layout_fini(void)
1817 EXPORT_SYMBOL(req_layout_fini);
1820 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1822 * Actual/expected field sizes are set elsewhere in functions in this file:
1823 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1824 * req_capsule_msg_size(). The \a rc_area information is used by.
1825 * ptlrpc_request_set_replen().
1827 void req_capsule_init_area(struct req_capsule *pill)
1831 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1832 pill->rc_area[RCL_CLIENT][i] = -1;
1833 pill->rc_area[RCL_SERVER][i] = -1;
1836 EXPORT_SYMBOL(req_capsule_init_area);
1839 * Initialize a pill.
1841 * The \a location indicates whether the caller is executing on the client side
1842 * (RCL_CLIENT) or server side (RCL_SERVER)..
1844 void req_capsule_init(struct req_capsule *pill,
1845 struct ptlrpc_request *req,
1846 enum req_location location)
1848 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1851 * Today all capsules are embedded in ptlrpc_request structs,
1852 * but just in case that ever isn't the case, we don't reach
1853 * into req unless req != NULL and pill is the one embedded in
1856 * The req->rq_pill_init flag makes it safe to initialize a pill
1857 * twice, which might happen in the OST paths as a result of the
1858 * high-priority RPC queue getting peeked at before ost_handle()
1859 * handles an OST RPC.
1861 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1864 pill->rc_fmt = NULL;
1866 pill->rc_loc = location;
1867 req_capsule_init_area(pill);
1869 if (req != NULL && pill == &req->rq_pill)
1870 req->rq_pill_init = 1;
1872 EXPORT_SYMBOL(req_capsule_init);
1874 void req_capsule_fini(struct req_capsule *pill)
1877 EXPORT_SYMBOL(req_capsule_fini);
1879 static int __req_format_is_sane(const struct req_format *fmt)
1881 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1882 req_formats[fmt->rf_idx] == fmt;
1885 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1886 enum req_location loc)
1888 return loc == RCL_CLIENT ? pill->rc_reqmsg : pill->rc_repmsg;
1892 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1893 * (see req_capsule_extend()).
1895 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1897 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1898 LASSERT(__req_format_is_sane(fmt));
1902 EXPORT_SYMBOL(req_capsule_set);
1905 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1908 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1909 * variable-sized fields. The field sizes come from the declared \a rmf_size
1910 * field of a \a pill's \a rc_fmt's RMF's.
1912 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1913 enum req_location loc)
1915 const struct req_format *fmt = pill->rc_fmt;
1918 LASSERT(fmt != NULL);
1920 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1921 if (pill->rc_area[loc][i] == -1) {
1922 pill->rc_area[loc][i] =
1923 fmt->rf_fields[loc].d[i]->rmf_size;
1924 if (pill->rc_area[loc][i] == -1) {
1926 * Skip the following fields.
1928 * If this LASSERT() trips then you're missing a
1929 * call to req_capsule_set_size().
1931 LASSERT(loc != RCL_SERVER);
1938 EXPORT_SYMBOL(req_capsule_filled_sizes);
1941 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1943 * This function uses the \a pill's \a rc_area as filled in by
1944 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1947 int req_capsule_server_pack(struct req_capsule *pill)
1949 const struct req_format *fmt;
1953 LASSERT(pill->rc_loc == RCL_SERVER);
1955 LASSERT(fmt != NULL);
1957 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1958 rc = lustre_pack_reply(pill->rc_req, count,
1959 pill->rc_area[RCL_SERVER], NULL);
1961 DEBUG_REQ(D_ERROR, pill->rc_req,
1962 "Cannot pack %d fields in format '%s'",
1963 count, fmt->rf_name);
1967 EXPORT_SYMBOL(req_capsule_server_pack);
1970 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1971 * corresponding to the given RMF (\a field).
1973 __u32 __req_capsule_offset(const struct req_capsule *pill,
1974 const struct req_msg_field *field,
1975 enum req_location loc)
1977 unsigned int offset;
1979 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1980 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1981 pill->rc_fmt->rf_name,
1982 field->rmf_name, offset, loc);
1985 LASSERT(offset < REQ_MAX_FIELD_NR);
1989 void req_capsule_set_swabbed(struct req_capsule *pill, enum req_location loc,
1992 if (loc == RCL_CLIENT)
1993 req_capsule_set_req_swabbed(pill, index);
1995 req_capsule_set_rep_swabbed(pill, index);
1998 bool req_capsule_need_swab(struct req_capsule *pill, enum req_location loc,
2001 if (loc == RCL_CLIENT)
2002 return (req_capsule_req_need_swab(pill) &&
2003 !req_capsule_req_swabbed(pill, index));
2005 return (req_capsule_rep_need_swab(pill) &&
2006 !req_capsule_rep_swabbed(pill, index));
2010 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
2014 swabber_dumper_helper(struct req_capsule *pill,
2015 const struct req_msg_field *field,
2016 enum req_location loc,
2018 void *value, int len, bool dump, void (*swabber)(void *))
2026 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2028 swabber = swabber ?: field->rmf_swabber;
2030 if (req_capsule_need_swab(pill, loc, offset) &&
2031 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2036 if (!field->rmf_dumper)
2040 * We're swabbing an array; swabber() swabs a single array element, so
2041 * swab every element.
2043 if (array && (len % field->rmf_size)) {
2044 static const struct req_msg_field *last_field;
2046 if (field != last_field) {
2047 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2048 field->rmf_name, len, field->rmf_size);
2052 /* For the non-array cases, the process of swab/dump/swab only
2053 * needs to be done once. (n = 1)
2056 len = field->rmf_size;
2057 for (p = value, i = 0, n = len / field->rmf_size;
2059 i++, p += field->rmf_size) {
2061 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2062 do_swab ? "unswabbed " : "",
2063 array ? "array " : "",
2064 field->rmf_name, i);
2065 field->rmf_dumper(p);
2073 if (!field->rmf_swab_len) {
2076 size = field->rmf_swab_len(p, len);
2085 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2086 array ? "array " : "", field->rmf_name, i);
2087 field->rmf_dumper(value);
2091 req_capsule_set_swabbed(pill, loc, offset);
2097 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2098 * corresponding to the given RMF (\a field).
2100 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2101 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2102 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2103 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2104 * element of the array swabbed.
2106 static void *__req_capsule_get(struct req_capsule *pill,
2107 const struct req_msg_field *field,
2108 enum req_location loc,
2109 void (*swabber)(void *),
2112 const struct req_format *fmt;
2113 struct lustre_msg *msg;
2118 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2120 static const char *rcl_names[RCL_NR] = {
2121 [RCL_CLIENT] = "client",
2122 [RCL_SERVER] = "server"
2125 LASSERT(pill != NULL);
2126 LASSERT(pill != LP_POISON);
2128 LASSERT(fmt != NULL);
2129 LASSERT(fmt != LP_POISON);
2130 LASSERT(__req_format_is_sane(fmt));
2132 offset = __req_capsule_offset(pill, field, loc);
2134 msg = __req_msg(pill, loc);
2135 LASSERT(msg != NULL);
2137 getter = (field->rmf_flags & RMF_F_STRING) ?
2138 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2140 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2142 * We've already asserted that field->rmf_size > 0 in
2143 * req_layout_init().
2145 len = lustre_msg_buflen(msg, offset);
2146 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2147 (len % field->rmf_size) != 0) {
2148 CERROR("%s: array field size mismatch "
2149 "%d modulo %u != 0 (%d)\n",
2150 field->rmf_name, len, field->rmf_size, loc);
2153 } else if (pill->rc_area[loc][offset] != -1) {
2154 len = pill->rc_area[loc][offset];
2156 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2158 value = getter(msg, offset, len);
2160 if (value == NULL) {
2161 DEBUG_REQ(D_ERROR, pill->rc_req,
2162 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2163 field->rmf_name, offset, lustre_msg_bufcount(msg),
2164 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2167 swabber_dumper_helper(pill, field, loc, offset, value, len,
2175 * Dump a request and/or reply
2177 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2179 const struct req_format *fmt;
2180 const struct req_msg_field *field;
2186 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2187 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2188 field = FMT_FIELD(fmt, loc, i);
2189 if (field->rmf_dumper == NULL) {
2191 * FIXME Add a default hex dumper for fields that don't
2192 * have a specific dumper
2194 len = req_capsule_get_size(pill, field, loc);
2196 "Field %s has no dumper function; field size is %u\n",
2197 field->rmf_name, len);
2199 /* It's dumping side-effect that we're interested in */
2200 (void) __req_capsule_get(pill, field, loc, NULL, true);
2203 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2209 void req_capsule_client_dump(struct req_capsule *pill)
2211 __req_capsule_dump(pill, RCL_CLIENT);
2213 EXPORT_SYMBOL(req_capsule_client_dump);
2218 void req_capsule_server_dump(struct req_capsule *pill)
2220 __req_capsule_dump(pill, RCL_SERVER);
2222 EXPORT_SYMBOL(req_capsule_server_dump);
2225 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2226 * buffer corresponding to the given RMF (\a field) of a \a pill.
2228 void *req_capsule_client_get(struct req_capsule *pill,
2229 const struct req_msg_field *field)
2231 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2233 EXPORT_SYMBOL(req_capsule_client_get);
2236 * Same as req_capsule_client_get(), but with a \a swabber argument.
2238 * Currently unused; will be removed when req_capsule_server_swab_get() is
2241 void *req_capsule_client_swab_get(struct req_capsule *pill,
2242 const struct req_msg_field *field,
2245 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2247 EXPORT_SYMBOL(req_capsule_client_swab_get);
2250 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2252 * First the \a pill's request \a field's size is set (\a rc_area) using
2253 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2256 void *req_capsule_client_sized_get(struct req_capsule *pill,
2257 const struct req_msg_field *field,
2260 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2261 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2263 EXPORT_SYMBOL(req_capsule_client_sized_get);
2266 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2267 * buffer corresponding to the given RMF (\a field) of a \a pill.
2269 void *req_capsule_server_get(struct req_capsule *pill,
2270 const struct req_msg_field *field)
2272 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2274 EXPORT_SYMBOL(req_capsule_server_get);
2277 * Same as req_capsule_server_get(), but with a \a swabber argument.
2279 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2280 * swabbing done outside this capsule abstraction.
2282 void *req_capsule_server_swab_get(struct req_capsule *pill,
2283 const struct req_msg_field *field,
2286 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2288 EXPORT_SYMBOL(req_capsule_server_swab_get);
2291 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2293 * First the \a pill's request \a field's size is set (\a rc_area) using
2294 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2297 void *req_capsule_server_sized_get(struct req_capsule *pill,
2298 const struct req_msg_field *field,
2301 req_capsule_set_size(pill, field, RCL_SERVER, len);
2302 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2304 EXPORT_SYMBOL(req_capsule_server_sized_get);
2306 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2307 const struct req_msg_field *field,
2308 __u32 len, void *swabber)
2310 req_capsule_set_size(pill, field, RCL_SERVER, len);
2311 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2313 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2316 * Returns the buffer of a \a pill corresponding to the given \a field from the
2317 * request (if the caller is executing on the server-side) or reply (if the
2318 * caller is executing on the client-side).
2320 * This function convienient for use is code that could be executed on the
2321 * client and server alike.
2323 const void *req_capsule_other_get(struct req_capsule *pill,
2324 const struct req_msg_field *field)
2326 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2328 EXPORT_SYMBOL(req_capsule_other_get);
2331 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2332 * field of the given \a pill.
2334 * This function must be used when constructing variable sized fields of a
2337 void req_capsule_set_size(struct req_capsule *pill,
2338 const struct req_msg_field *field,
2339 enum req_location loc, __u32 size)
2341 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2343 if ((size != (__u32)field->rmf_size) &&
2344 (field->rmf_size != -1) &&
2345 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2347 __u32 rmf_size = (__u32)field->rmf_size;
2348 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2349 (size % rmf_size != 0)) {
2350 CERROR("%s: array field size mismatch "
2351 "%u %% %u != 0 (%d)\n",
2352 field->rmf_name, size, rmf_size, loc);
2354 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2356 CERROR("%s: field size mismatch %u != %u (%d)\n",
2357 field->rmf_name, size, rmf_size, loc);
2362 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2364 EXPORT_SYMBOL(req_capsule_set_size);
2367 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2368 * for the given \a pill's given \a field.
2370 * NB: this function doesn't correspond with req_capsule_set_size(), which
2371 * actually sets the size in pill.rc_area[loc][offset], but this function
2372 * returns the message buflen[offset], maybe we should use another name.
2374 __u32 req_capsule_get_size(const struct req_capsule *pill,
2375 const struct req_msg_field *field,
2376 enum req_location loc)
2378 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2380 return lustre_msg_buflen(__req_msg(pill, loc),
2381 __req_capsule_offset(pill, field, loc));
2383 EXPORT_SYMBOL(req_capsule_get_size);
2386 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2387 * given \a pill's request or reply (\a loc) given the field size recorded in
2388 * the \a pill's rc_area.
2390 * See also req_capsule_set_size().
2392 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2394 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2395 pill->rc_fmt->rf_fields[loc].nr,
2396 pill->rc_area[loc]);
2400 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2401 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2402 * PTLRPC request or reply given only an RQF (\a fmt).
2404 * This function should not be used for formats which contain variable size
2407 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2408 enum req_location loc)
2414 * This function should probably LASSERT() that fmt has no fields with
2415 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2416 * elements in the array there will ultimately be, but then, we could
2417 * assume that there will be at least one element, and that's just what
2420 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2424 for (; i < fmt->rf_fields[loc].nr; ++i)
2425 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2426 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2430 EXPORT_SYMBOL(req_capsule_fmt_size);
2433 * Changes the format of an RPC.
2435 * The pill must already have been initialized, which means that it already has
2436 * a request format. The new format \a fmt must be an extension of the pill's
2437 * old format. Specifically: the new format must have as many request and reply
2438 * fields as the old one, and all fields shared by the old and new format must
2439 * be at least as large in the new format.
2441 * The new format's fields may be of different "type" than the old format, but
2442 * only for fields that are "opaque" blobs: fields which have a) have no
2443 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2444 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2445 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2446 * according to the key field. When the value, according to the key, contains a
2447 * structure (or array thereof) to be swabbed, the format should be changed to
2448 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2451 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2456 const struct req_format *old;
2458 LASSERT(pill->rc_fmt != NULL);
2459 LASSERT(__req_format_is_sane(fmt));
2463 * Sanity checking...
2465 for (i = 0; i < RCL_NR; ++i) {
2466 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2467 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2468 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2470 /* "opaque" fields can be transmogrified */
2471 if (ofield->rmf_swabber == NULL &&
2472 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2473 (ofield->rmf_size == -1 ||
2474 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2476 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2479 * Last field in old format can be shorter than in new.
2481 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2482 FMT_FIELD(old, i, j)->rmf_size);
2487 EXPORT_SYMBOL(req_capsule_extend);
2490 * This function returns a non-zero value if the given \a field is present in
2491 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2494 int req_capsule_has_field(const struct req_capsule *pill,
2495 const struct req_msg_field *field,
2496 enum req_location loc)
2498 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2500 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2502 EXPORT_SYMBOL(req_capsule_has_field);
2505 * Returns a non-zero value if the given \a field is present in the given \a
2506 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2508 int req_capsule_field_present(const struct req_capsule *pill,
2509 const struct req_msg_field *field,
2510 enum req_location loc)
2514 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2515 LASSERT(req_capsule_has_field(pill, field, loc));
2517 offset = __req_capsule_offset(pill, field, loc);
2518 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2520 EXPORT_SYMBOL(req_capsule_field_present);
2523 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2524 * request or reply (\a loc).
2526 * This is not the opposite of req_capsule_extend().
2528 void req_capsule_shrink(struct req_capsule *pill,
2529 const struct req_msg_field *field,
2531 enum req_location loc)
2533 const struct req_format *fmt;
2534 struct lustre_msg *msg;
2539 LASSERT(fmt != NULL);
2540 LASSERT(__req_format_is_sane(fmt));
2541 LASSERT(req_capsule_has_field(pill, field, loc));
2542 LASSERT(req_capsule_field_present(pill, field, loc));
2544 offset = __req_capsule_offset(pill, field, loc);
2546 msg = __req_msg(pill, loc);
2547 len = lustre_msg_buflen(msg, offset);
2548 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2549 fmt->rf_name, field->rmf_name, len, newlen);
2551 if (loc == RCL_CLIENT) {
2552 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2555 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2557 /* update also field size in reply lenghts arrays for possible
2558 * reply re-pack due to req_capsule_server_grow() call.
2560 req_capsule_set_size(pill, field, loc, newlen);
2563 EXPORT_SYMBOL(req_capsule_shrink);
2565 int req_capsule_server_grow(struct req_capsule *pill,
2566 const struct req_msg_field *field,
2569 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2574 LASSERT(pill->rc_fmt != NULL);
2575 LASSERT(__req_format_is_sane(pill->rc_fmt));
2576 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2577 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2579 len = req_capsule_get_size(pill, field, RCL_SERVER);
2580 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2582 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2583 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2586 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2588 * There can be enough space in current reply buffer, make sure
2589 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2590 * re-packing is still needed.
2592 if (rs->rs_msg == rs->rs_repbuf &&
2593 rs->rs_repbuf_len >=
2594 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2595 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2600 /* Re-allocate replay state */
2601 pill->rc_req->rq_reply_state = NULL;
2602 rc = req_capsule_server_pack(pill);
2604 /* put old values back, the caller should decide what to do */
2605 req_capsule_set_size(pill, field, RCL_SERVER, len);
2606 pill->rc_req->rq_reply_state = rs;
2609 nrs = pill->rc_req->rq_reply_state;
2610 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2611 lustre_packed_msg_size(rs->rs_msg));
2613 /* Now we need only buffers, copy them and grow the needed one */
2614 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2615 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2617 (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from);
2618 lustre_msg_set_buflen(nrs->rs_msg, offset, len);
2619 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2621 if (rs->rs_difficult) {
2625 nrs->rs_difficult = 1;
2626 nrs->rs_no_ack = rs->rs_no_ack;
2627 nrs->rs_convert_lock = rs->rs_convert_lock;
2628 for (i = 0; i < rs->rs_nlocks; i++) {
2629 nrs->rs_locks[i] = rs->rs_locks[i];
2630 nrs->rs_modes[i] = rs->rs_modes[i];
2634 rs->rs_difficult = 0;
2637 ptlrpc_rs_decref(rs);
2640 EXPORT_SYMBOL(req_capsule_server_grow);
2642 #ifdef HAVE_SERVER_SUPPORT
2643 static const struct req_msg_field *mds_update_client[] = {
2645 &RMF_OUT_UPDATE_HEADER,
2646 &RMF_OUT_UPDATE_BUF,
2649 static const struct req_msg_field *mds_update_server[] = {
2651 &RMF_OUT_UPDATE_REPLY,
2654 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
2655 lustre_swab_object_update_request, NULL);
2656 EXPORT_SYMBOL(RMF_OUT_UPDATE);
2658 struct req_msg_field RMF_OUT_UPDATE_REPLY =
2659 DEFINE_MSGFL("object_update_reply", 0, -1,
2660 lustre_swab_object_update_reply, NULL);
2661 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
2663 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
2664 -1, lustre_swab_out_update_header, NULL);
2665 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
2667 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
2668 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
2669 lustre_swab_out_update_buffer, NULL);
2670 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
2672 struct req_format RQF_OUT_UPDATE =
2673 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
2675 EXPORT_SYMBOL(RQF_OUT_UPDATE);
2677 int req_check_sepol(struct req_capsule *pill)
2680 struct obd_export *export;
2681 struct lu_nodemap *nm = NULL;
2682 const char *sepol = NULL;
2683 const char *nm_sepol = NULL;
2688 export = pill->rc_req->rq_export;
2689 if (!export || !exp_connect_sepol(export) ||
2690 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2693 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2696 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2697 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2701 nm = nodemap_get_from_exp(export);
2702 if (!IS_ERR_OR_NULL(nm)) {
2703 nm_sepol = nodemap_get_sepol(nm);
2704 if (nm_sepol && nm_sepol[0])
2705 if (sepol == NULL ||
2706 strcmp(sepol, nm_sepol) != 0)
2711 if (!IS_ERR_OR_NULL(nm))
2716 EXPORT_SYMBOL(req_check_sepol);