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[] = {
476 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
480 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
483 &RMF_FILE_SECCTX_NAME
486 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
498 static const struct req_msg_field *ldlm_intent_create_client[] = {
502 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
506 &RMF_FILE_SECCTX_NAME,
512 static const struct req_msg_field *ldlm_intent_open_client[] = {
516 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
521 &RMF_FILE_SECCTX_NAME,
527 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
536 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
541 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
547 static const struct req_msg_field *mds_get_root_client[] = {
553 static const struct req_msg_field *mds_getxattr_client[] = {
562 static const struct req_msg_field *mds_getxattr_server[] = {
568 static const struct req_msg_field *mds_getattr_server[] = {
578 static const struct req_msg_field *mds_setattr_server[] = {
587 static const struct req_msg_field *mds_batch_client[] = {
593 static const struct req_msg_field *mds_batch_server[] = {
598 static const struct req_msg_field *llog_origin_handle_create_client[] = {
605 static const struct req_msg_field *llogd_body_only[] = {
610 static const struct req_msg_field *llog_log_hdr_only[] = {
615 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
621 static const struct req_msg_field *obd_idx_read_client[] = {
626 static const struct req_msg_field *obd_idx_read_server[] = {
631 static const struct req_msg_field *ost_body_only[] = {
636 static const struct req_msg_field *ost_body_capa[] = {
642 static const struct req_msg_field *ost_destroy_client[] = {
650 static const struct req_msg_field *ost_brw_client[] = {
659 static const struct req_msg_field *ost_brw_read_server[] = {
665 static const struct req_msg_field *ost_brw_write_server[] = {
671 static const struct req_msg_field *ost_get_info_generic_server[] = {
676 static const struct req_msg_field *ost_get_info_generic_client[] = {
681 static const struct req_msg_field *ost_get_last_id_server[] = {
686 static const struct req_msg_field *ost_get_last_fid_client[] = {
692 static const struct req_msg_field *ost_get_last_fid_server[] = {
697 static const struct req_msg_field *ost_get_fiemap_client[] = {
703 static const struct req_msg_field *ost_ladvise[] = {
706 &RMF_OST_LADVISE_HDR,
710 static const struct req_msg_field *ost_get_fiemap_server[] = {
715 static const struct req_msg_field *mdt_hsm_progress[] = {
718 &RMF_MDS_HSM_PROGRESS,
721 static const struct req_msg_field *mdt_hsm_ct_register[] = {
724 &RMF_MDS_HSM_ARCHIVE,
727 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
732 static const struct req_msg_field *mdt_hsm_action_server[] = {
735 &RMF_MDS_HSM_CURRENT_ACTION,
738 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
744 static const struct req_msg_field *mdt_hsm_state_set[] = {
751 static const struct req_msg_field *mdt_hsm_request[] = {
754 &RMF_MDS_HSM_REQUEST,
755 &RMF_MDS_HSM_USER_ITEM,
759 static const struct req_msg_field *obd_lfsck_request[] = {
764 static const struct req_msg_field *obd_lfsck_reply[] = {
769 static struct req_format *req_formats[] = {
776 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
779 &RQF_MGS_CONFIG_READ,
790 &RQF_MDS_GETATTR_NAME,
794 &RQF_MDS_CLOSE_INTENT,
797 &RQF_MDS_REINT_CREATE,
798 &RQF_MDS_REINT_CREATE_ACL,
799 &RQF_MDS_REINT_CREATE_SLAVE,
800 &RQF_MDS_REINT_CREATE_SYM,
802 &RQF_MDS_REINT_UNLINK,
804 &RQF_MDS_REINT_RENAME,
805 &RQF_MDS_REINT_MIGRATE,
806 &RQF_MDS_REINT_SETATTR,
807 &RQF_MDS_REINT_SETXATTR,
808 &RQF_MDS_REINT_RESYNC,
810 &RQF_MDS_HSM_PROGRESS,
811 &RQF_MDS_HSM_CT_REGISTER,
812 &RQF_MDS_HSM_CT_UNREGISTER,
813 &RQF_MDS_HSM_STATE_GET,
814 &RQF_MDS_HSM_STATE_SET,
816 &RQF_MDS_HSM_REQUEST,
817 &RQF_MDS_SWAP_LAYOUTS,
819 #ifdef HAVE_SERVER_SUPPORT
835 &RQF_OST_SET_GRANT_INFO,
837 &RQF_OST_GET_INFO_LAST_ID,
838 &RQF_OST_GET_INFO_LAST_FID,
839 &RQF_OST_SET_INFO_LAST_FID,
840 &RQF_OST_GET_INFO_FIEMAP,
844 &RQF_LDLM_ENQUEUE_LVB,
848 &RQF_LDLM_CP_CALLBACK,
849 &RQF_LDLM_BL_CALLBACK,
850 &RQF_LDLM_GL_CALLBACK,
851 &RQF_LDLM_GL_CALLBACK_DESC,
853 &RQF_LDLM_INTENT_BASIC,
854 &RQF_LDLM_INTENT_LAYOUT,
855 &RQF_LDLM_INTENT_GETATTR,
856 &RQF_LDLM_INTENT_OPEN,
857 &RQF_LDLM_INTENT_CREATE,
858 &RQF_LDLM_INTENT_GETXATTR,
859 &RQF_LDLM_INTENT_QUOTA,
861 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
862 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
863 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
864 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
871 struct req_msg_field {
872 const __u32 rmf_flags;
873 const char *rmf_name;
875 * Field length. (-1) means "variable length". If the
876 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
877 * but the actual size must be a whole multiple of \a rmf_size.
880 void (*rmf_swabber)(void *);
882 * Pass buffer size to swabbing function
883 * \retval > 0 the number of bytes swabbed
884 * -EOVERFLOW on error
886 int (*rmf_swab_len)(void *, __u32);
887 void (*rmf_dumper)(void *);
888 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
893 * The field is a string, must be NUL-terminated.
895 RMF_F_STRING = BIT(0),
897 * The field's buffer size need not match the declared \a rmf_size.
899 RMF_F_NO_SIZE_CHECK = BIT(1),
901 * The field's buffer size must be a whole multiple of the declared \a
902 * rmf_size and the \a rmf_swabber function must work on the declared \a
903 * rmf_size worth of bytes.
905 RMF_F_STRUCT_ARRAY = BIT(2),
913 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
914 .rmf_name = (name), \
915 .rmf_flags = (flags), \
916 .rmf_size = (size), \
917 .rmf_swabber = (void (*)(void*))(swabber), \
918 .rmf_dumper = (void (*)(void*))(dumper) \
921 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
922 .rmf_name = (name), \
923 .rmf_flags = (flags), \
924 .rmf_size = (size), \
925 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
926 .rmf_dumper = (void (*)(void *))(dumper) \
929 struct req_msg_field RMF_GENERIC_DATA =
930 DEFINE_MSGF("generic_data", 0,
932 EXPORT_SYMBOL(RMF_GENERIC_DATA);
934 struct req_msg_field RMF_MGS_TARGET_INFO =
935 DEFINE_MSGF("mgs_target_info", 0,
936 sizeof(struct mgs_target_info),
937 lustre_swab_mgs_target_info, NULL);
938 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
940 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
941 struct req_msg_field RMF_MGS_SEND_PARAM =
942 DEFINE_MSGF("mgs_send_param", 0,
943 sizeof(struct mgs_send_param),
945 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
948 struct req_msg_field RMF_MGS_CONFIG_BODY =
949 DEFINE_MSGF("mgs_config_read request", 0,
950 sizeof(struct mgs_config_body),
951 lustre_swab_mgs_config_body, NULL);
952 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
954 struct req_msg_field RMF_MGS_CONFIG_RES =
955 DEFINE_MSGF("mgs_config_read reply ", 0,
956 sizeof(struct mgs_config_res),
957 lustre_swab_mgs_config_res, NULL);
958 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
960 struct req_msg_field RMF_U32 =
961 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
962 sizeof(__u32), lustre_swab_generic_32s, NULL);
963 EXPORT_SYMBOL(RMF_U32);
965 struct req_msg_field RMF_SETINFO_VAL =
966 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_SETINFO_VAL);
969 struct req_msg_field RMF_GETINFO_KEY =
970 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
971 EXPORT_SYMBOL(RMF_GETINFO_KEY);
973 struct req_msg_field RMF_GETINFO_VALLEN =
974 DEFINE_MSGF("getinfo_vallen", 0,
975 sizeof(__u32), lustre_swab_generic_32s, NULL);
976 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
978 struct req_msg_field RMF_GETINFO_VAL =
979 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
980 EXPORT_SYMBOL(RMF_GETINFO_VAL);
982 struct req_msg_field RMF_SEQ_OPC =
983 DEFINE_MSGF("seq_query_opc", 0,
984 sizeof(__u32), lustre_swab_generic_32s, NULL);
985 EXPORT_SYMBOL(RMF_SEQ_OPC);
987 struct req_msg_field RMF_SEQ_RANGE =
988 DEFINE_MSGF("seq_query_range", 0,
989 sizeof(struct lu_seq_range),
990 lustre_swab_lu_seq_range, NULL);
991 EXPORT_SYMBOL(RMF_SEQ_RANGE);
993 struct req_msg_field RMF_FLD_OPC =
994 DEFINE_MSGF("fld_query_opc", 0,
995 sizeof(__u32), lustre_swab_generic_32s, NULL);
996 EXPORT_SYMBOL(RMF_FLD_OPC);
998 struct req_msg_field RMF_FLD_MDFLD =
999 DEFINE_MSGF("fld_query_mdfld", 0,
1000 sizeof(struct lu_seq_range),
1001 lustre_swab_lu_seq_range, NULL);
1002 EXPORT_SYMBOL(RMF_FLD_MDFLD);
1004 struct req_msg_field RMF_MDT_BODY =
1005 DEFINE_MSGF("mdt_body", 0,
1006 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
1007 EXPORT_SYMBOL(RMF_MDT_BODY);
1009 struct req_msg_field RMF_OBD_QUOTACTL =
1010 DEFINE_MSGFL("obd_quotactl",
1012 sizeof(struct obd_quotactl),
1013 lustre_swab_obd_quotactl, NULL);
1014 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
1016 struct req_msg_field RMF_QUOTA_BODY =
1017 DEFINE_MSGF("quota_body", 0,
1018 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
1019 EXPORT_SYMBOL(RMF_QUOTA_BODY);
1021 struct req_msg_field RMF_MDT_EPOCH =
1022 DEFINE_MSGF("mdt_ioepoch", 0,
1023 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
1024 EXPORT_SYMBOL(RMF_MDT_EPOCH);
1026 struct req_msg_field RMF_PTLRPC_BODY =
1027 DEFINE_MSGF("ptlrpc_body", 0,
1028 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
1029 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
1031 struct req_msg_field RMF_CLOSE_DATA =
1032 DEFINE_MSGF("data_version", 0,
1033 sizeof(struct close_data), lustre_swab_close_data, NULL);
1034 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1036 struct req_msg_field RMF_OBD_STATFS =
1037 DEFINE_MSGF("obd_statfs", 0,
1038 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1039 EXPORT_SYMBOL(RMF_OBD_STATFS);
1041 struct req_msg_field RMF_SETINFO_KEY =
1042 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1043 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1045 struct req_msg_field RMF_NAME =
1046 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1047 EXPORT_SYMBOL(RMF_NAME);
1049 struct req_msg_field RMF_FID_ARRAY =
1050 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1051 EXPORT_SYMBOL(RMF_FID_ARRAY);
1053 struct req_msg_field RMF_SYMTGT =
1054 DEFINE_MSGF("symtgt", 0, -1, NULL, NULL);
1055 EXPORT_SYMBOL(RMF_SYMTGT);
1057 struct req_msg_field RMF_TGTUUID =
1058 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1060 EXPORT_SYMBOL(RMF_TGTUUID);
1062 struct req_msg_field RMF_CLUUID =
1063 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1065 EXPORT_SYMBOL(RMF_CLUUID);
1067 struct req_msg_field RMF_STRING =
1068 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1069 EXPORT_SYMBOL(RMF_STRING);
1071 struct req_msg_field RMF_FILE_SECCTX_NAME =
1072 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1073 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1075 struct req_msg_field RMF_FILE_SECCTX =
1076 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1077 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1079 struct req_msg_field RMF_FILE_ENCCTX =
1080 DEFINE_MSGF("file_encctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1081 EXPORT_SYMBOL(RMF_FILE_ENCCTX);
1083 struct req_msg_field RMF_LLOGD_BODY =
1084 DEFINE_MSGF("llogd_body", 0,
1085 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1086 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1088 struct req_msg_field RMF_LLOG_LOG_HDR =
1089 DEFINE_MSGF("llog_log_hdr", 0,
1090 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1091 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1093 struct req_msg_field RMF_LLOGD_CONN_BODY =
1094 DEFINE_MSGF("llogd_conn_body", 0,
1095 sizeof(struct llogd_conn_body),
1096 lustre_swab_llogd_conn_body, NULL);
1097 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1100 * connection handle received in MDS_CONNECT request.
1102 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1103 * that the client does not interpret at all.
1105 struct req_msg_field RMF_CONN =
1106 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1107 EXPORT_SYMBOL(RMF_CONN);
1109 struct req_msg_field RMF_CONNECT_DATA =
1110 DEFINE_MSGF("cdata",
1111 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1112 sizeof(struct obd_connect_data),
1113 lustre_swab_connect, NULL);
1114 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1116 struct req_msg_field RMF_DLM_REQ =
1117 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1118 sizeof(struct ldlm_request),
1119 lustre_swab_ldlm_request, NULL);
1120 EXPORT_SYMBOL(RMF_DLM_REQ);
1122 struct req_msg_field RMF_DLM_REP =
1123 DEFINE_MSGF("dlm_rep", 0,
1124 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1125 EXPORT_SYMBOL(RMF_DLM_REP);
1127 struct req_msg_field RMF_LDLM_INTENT =
1128 DEFINE_MSGF("ldlm_intent", 0,
1129 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1130 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1132 struct req_msg_field RMF_DLM_LVB =
1133 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1134 EXPORT_SYMBOL(RMF_DLM_LVB);
1136 struct req_msg_field RMF_DLM_GL_DESC =
1137 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1138 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1140 struct req_msg_field RMF_MDT_MD =
1141 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1142 EXPORT_SYMBOL(RMF_MDT_MD);
1144 struct req_msg_field RMF_DEFAULT_MDT_MD =
1145 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1147 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1149 struct req_msg_field RMF_REC_REINT =
1150 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1151 lustre_swab_mdt_rec_reint, NULL);
1152 EXPORT_SYMBOL(RMF_REC_REINT);
1154 /* FIXME: this length should be defined as a macro */
1155 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1157 EXPORT_SYMBOL(RMF_EADATA);
1159 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1160 EXPORT_SYMBOL(RMF_EAVALS);
1162 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1163 EXPORT_SYMBOL(RMF_ACL);
1165 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1166 struct req_msg_field RMF_LOGCOOKIES =
1167 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1168 sizeof(struct llog_cookie), NULL, NULL);
1169 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1171 struct req_msg_field RMF_CAPA1 =
1172 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1173 EXPORT_SYMBOL(RMF_CAPA1);
1175 struct req_msg_field RMF_CAPA2 =
1176 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1177 EXPORT_SYMBOL(RMF_CAPA2);
1179 struct req_msg_field RMF_LAYOUT_INTENT =
1180 DEFINE_MSGF("layout_intent", 0,
1181 sizeof(struct layout_intent), lustre_swab_layout_intent,
1183 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1185 struct req_msg_field RMF_SELINUX_POL =
1186 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1187 EXPORT_SYMBOL(RMF_SELINUX_POL);
1190 * OST request field.
1192 struct req_msg_field RMF_OST_BODY =
1193 DEFINE_MSGF("ost_body", 0,
1194 sizeof(struct ost_body), lustre_swab_ost_body,
1196 EXPORT_SYMBOL(RMF_OST_BODY);
1198 struct req_msg_field RMF_OBD_IOOBJ =
1199 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1200 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1201 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1203 struct req_msg_field RMF_NIOBUF_REMOTE =
1204 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1205 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1207 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1209 struct req_msg_field RMF_NIOBUF_INLINE =
1210 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1211 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1213 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1215 struct req_msg_field RMF_RCS =
1216 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1217 lustre_swab_generic_32s, dump_rcs);
1218 EXPORT_SYMBOL(RMF_RCS);
1220 struct req_msg_field RMF_EAVALS_LENS =
1221 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1222 lustre_swab_generic_32s, NULL);
1223 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1225 struct req_msg_field RMF_OBD_ID =
1226 DEFINE_MSGF("obd_id", 0,
1227 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1228 EXPORT_SYMBOL(RMF_OBD_ID);
1230 struct req_msg_field RMF_FID =
1231 DEFINE_MSGF("fid", 0,
1232 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1233 EXPORT_SYMBOL(RMF_FID);
1235 struct req_msg_field RMF_OST_ID =
1236 DEFINE_MSGF("ost_id", 0,
1237 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1238 EXPORT_SYMBOL(RMF_OST_ID);
1240 struct req_msg_field RMF_FIEMAP_KEY =
1241 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1242 lustre_swab_fiemap_info_key, NULL);
1243 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1245 struct req_msg_field RMF_FIEMAP_VAL =
1246 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1247 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1249 struct req_msg_field RMF_IDX_INFO =
1250 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1251 lustre_swab_idx_info, NULL);
1252 EXPORT_SYMBOL(RMF_IDX_INFO);
1253 struct req_msg_field RMF_SHORT_IO =
1254 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1255 EXPORT_SYMBOL(RMF_SHORT_IO);
1256 struct req_msg_field RMF_HSM_USER_STATE =
1257 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1258 lustre_swab_hsm_user_state, NULL);
1259 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1261 struct req_msg_field RMF_HSM_STATE_SET =
1262 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1263 lustre_swab_hsm_state_set, NULL);
1264 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1266 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1267 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1268 lustre_swab_hsm_progress_kernel, NULL);
1269 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1271 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1272 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1273 lustre_swab_hsm_current_action, NULL);
1274 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1276 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1277 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1278 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1280 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1282 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1283 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1284 sizeof(__u32), lustre_swab_generic_32s, NULL);
1285 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1287 struct req_msg_field RMF_MDS_HSM_REQUEST =
1288 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1289 lustre_swab_hsm_request, NULL);
1290 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1292 struct req_msg_field RMF_SWAP_LAYOUTS =
1293 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1294 lustre_swab_swap_layouts, NULL);
1295 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1297 struct req_msg_field RMF_LFSCK_REQUEST =
1298 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1299 lustre_swab_lfsck_request, NULL);
1300 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1302 struct req_msg_field RMF_LFSCK_REPLY =
1303 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1304 lustre_swab_lfsck_reply, NULL);
1305 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1307 struct req_msg_field RMF_OST_LADVISE_HDR =
1308 DEFINE_MSGF("ladvise_request", 0,
1309 sizeof(struct ladvise_hdr),
1310 lustre_swab_ladvise_hdr, NULL);
1311 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1313 struct req_msg_field RMF_OST_LADVISE =
1314 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1315 sizeof(struct lu_ladvise),
1316 lustre_swab_ladvise, NULL);
1317 EXPORT_SYMBOL(RMF_OST_LADVISE);
1319 struct req_msg_field RMF_BUT_REPLY =
1320 DEFINE_MSGF("batch_update_reply", 0, -1,
1321 lustre_swab_batch_update_reply, NULL);
1322 EXPORT_SYMBOL(RMF_BUT_REPLY);
1324 struct req_msg_field RMF_BUT_HEADER = DEFINE_MSGF("but_update_header", 0,
1325 -1, lustre_swab_but_update_header, NULL);
1326 EXPORT_SYMBOL(RMF_BUT_HEADER);
1328 struct req_msg_field RMF_BUT_BUF = DEFINE_MSGF("but_update_buf",
1329 RMF_F_STRUCT_ARRAY, sizeof(struct but_update_buffer),
1330 lustre_swab_but_update_buffer, NULL);
1331 EXPORT_SYMBOL(RMF_BUT_BUF);
1338 const char *rf_name;
1342 const struct req_msg_field **d;
1343 } rf_fields[RCL_NR];
1346 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1360 #define DEFINE_REQ_FMT0(name, client, server) \
1361 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1363 struct req_format RQF_OBD_PING =
1364 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1365 EXPORT_SYMBOL(RQF_OBD_PING);
1367 struct req_format RQF_OBD_SET_INFO =
1368 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1369 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1371 struct req_format RQF_MDT_SET_INFO =
1372 DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1373 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1375 /* Read index file through the network */
1376 struct req_format RQF_OBD_IDX_READ =
1377 DEFINE_REQ_FMT0("OBD_IDX_READ",
1378 obd_idx_read_client, obd_idx_read_server);
1379 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1381 struct req_format RQF_SEC_CTX =
1382 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1383 EXPORT_SYMBOL(RQF_SEC_CTX);
1385 struct req_format RQF_MGS_TARGET_REG =
1386 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1387 mgs_target_info_only);
1388 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1390 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1391 struct req_format RQF_MGS_SET_INFO =
1392 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1394 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1397 struct req_format RQF_MGS_CONFIG_READ =
1398 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1399 mgs_config_read_server);
1400 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1402 struct req_format RQF_SEQ_QUERY =
1403 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1404 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1406 struct req_format RQF_FLD_QUERY =
1407 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1408 EXPORT_SYMBOL(RQF_FLD_QUERY);
1410 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1411 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1412 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1413 * peers need to handle the RPC reply with fixed little-endian format.
1415 * In theory, we can define new structure with some swabber registered to
1416 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1417 * implementation view, it is not easy to be done within current "struct
1418 * req_msg_field" framework. Because the sequence range array in the RPC
1419 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1420 * count, that is unknown when prepare the RPC buffer. Generally, for such
1421 * flexible length RPC usage, there will be a field in the RPC layout to
1422 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1423 * do that unless we add new length filed that will broken the on-wire RPC
1424 * protocol and cause interoperability trouble with old peer. */
1425 struct req_format RQF_FLD_READ =
1426 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1427 EXPORT_SYMBOL(RQF_FLD_READ);
1429 struct req_format RQF_MDS_QUOTACTL =
1430 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1431 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1433 struct req_format RQF_OST_QUOTACTL =
1434 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1435 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1437 struct req_format RQF_QUOTA_DQACQ =
1438 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1439 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1441 struct req_format RQF_LDLM_INTENT_QUOTA =
1442 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1443 ldlm_intent_quota_client,
1444 ldlm_intent_quota_server);
1445 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1447 struct req_format RQF_MDS_GET_ROOT =
1448 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1449 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1451 struct req_format RQF_MDS_STATFS =
1452 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1453 EXPORT_SYMBOL(RQF_MDS_STATFS);
1455 struct req_format RQF_MDS_STATFS_NEW =
1456 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1457 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1459 struct req_format RQF_MDS_SYNC =
1460 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1461 EXPORT_SYMBOL(RQF_MDS_SYNC);
1463 struct req_format RQF_MDS_GETATTR =
1464 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1465 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1467 struct req_format RQF_MDS_GETXATTR =
1468 DEFINE_REQ_FMT0("MDS_GETXATTR",
1469 mds_getxattr_client, mds_getxattr_server);
1470 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1472 struct req_format RQF_MDS_GETATTR_NAME =
1473 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1474 mds_getattr_name_client, mds_getattr_server);
1475 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1477 struct req_format RQF_MDS_REINT =
1478 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1479 EXPORT_SYMBOL(RQF_MDS_REINT);
1481 struct req_format RQF_MDS_REINT_CREATE =
1482 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1483 mds_reint_create_client, mdt_body_capa);
1484 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1486 struct req_format RQF_MDS_REINT_CREATE_ACL =
1487 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1488 mds_reint_create_acl_client, mdt_body_capa);
1489 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1491 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1492 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1493 mds_reint_create_slave_client, mdt_body_capa);
1494 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1496 struct req_format RQF_MDS_REINT_CREATE_SYM =
1497 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1498 mds_reint_create_sym_client, mdt_body_capa);
1499 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1501 struct req_format RQF_MDS_REINT_OPEN =
1502 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1503 mds_reint_open_client, mds_reint_open_server);
1504 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1506 struct req_format RQF_MDS_REINT_UNLINK =
1507 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1508 mds_last_unlink_server);
1509 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1511 struct req_format RQF_MDS_REINT_LINK =
1512 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1513 mds_reint_link_client, mdt_body_only);
1514 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1516 struct req_format RQF_MDS_REINT_RENAME =
1517 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1518 mds_last_unlink_server);
1519 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1521 struct req_format RQF_MDS_REINT_MIGRATE =
1522 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1523 mds_last_unlink_server);
1524 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1526 struct req_format RQF_MDS_REINT_SETATTR =
1527 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1528 mds_reint_setattr_client, mds_setattr_server);
1529 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1531 struct req_format RQF_MDS_REINT_SETXATTR =
1532 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1533 mds_reint_setxattr_client, mdt_body_only);
1534 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1536 struct req_format RQF_MDS_REINT_RESYNC =
1537 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1538 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1540 struct req_format RQF_MDS_CONNECT =
1541 DEFINE_REQ_FMT0("MDS_CONNECT",
1542 obd_connect_client, obd_connect_server);
1543 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1545 struct req_format RQF_MDS_DISCONNECT =
1546 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1547 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1549 struct req_format RQF_MDS_GET_INFO =
1550 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1551 mds_getinfo_server);
1552 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1554 struct req_format RQF_MDS_BATCH =
1555 DEFINE_REQ_FMT0("MDS_BATCH", mds_batch_client,
1557 EXPORT_SYMBOL(RQF_MDS_BATCH);
1559 struct req_format RQF_LDLM_ENQUEUE =
1560 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1561 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1562 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1564 struct req_format RQF_LDLM_ENQUEUE_LVB =
1565 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1566 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1567 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1569 struct req_format RQF_LDLM_CONVERT =
1570 DEFINE_REQ_FMT0("LDLM_CONVERT",
1571 ldlm_enqueue_client, ldlm_enqueue_server);
1572 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1574 struct req_format RQF_LDLM_CANCEL =
1575 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1576 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1578 struct req_format RQF_LDLM_CALLBACK =
1579 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1580 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1582 struct req_format RQF_LDLM_CP_CALLBACK =
1583 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1584 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1586 struct req_format RQF_LDLM_BL_CALLBACK =
1587 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1588 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1590 struct req_format RQF_LDLM_GL_CALLBACK =
1591 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1592 ldlm_gl_callback_server);
1593 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1595 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1596 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1597 ldlm_gl_callback_server);
1598 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1600 struct req_format RQF_LDLM_INTENT_BASIC =
1601 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1602 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1603 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1605 struct req_format RQF_LDLM_INTENT =
1606 DEFINE_REQ_FMT0("LDLM_INTENT",
1607 ldlm_intent_client, ldlm_intent_server);
1608 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1610 struct req_format RQF_LDLM_INTENT_LAYOUT =
1611 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1612 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1613 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1615 struct req_format RQF_LDLM_INTENT_GETATTR =
1616 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1617 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1618 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1620 struct req_format RQF_LDLM_INTENT_OPEN =
1621 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1622 ldlm_intent_open_client, ldlm_intent_open_server);
1623 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1625 struct req_format RQF_LDLM_INTENT_CREATE =
1626 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1627 ldlm_intent_create_client, ldlm_intent_getattr_server);
1628 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1630 struct req_format RQF_LDLM_INTENT_GETXATTR =
1631 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1632 ldlm_intent_getxattr_client,
1633 ldlm_intent_getxattr_server);
1634 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1636 struct req_format RQF_MDS_CLOSE =
1637 DEFINE_REQ_FMT0("MDS_CLOSE",
1638 mdt_close_client, mds_last_unlink_server);
1639 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1641 struct req_format RQF_MDS_CLOSE_INTENT =
1642 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1643 mdt_close_intent_client, mds_last_unlink_server);
1644 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1646 struct req_format RQF_MDS_READPAGE =
1647 DEFINE_REQ_FMT0("MDS_READPAGE",
1648 mdt_body_capa, mdt_body_only);
1649 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1651 struct req_format RQF_MDS_HSM_ACTION =
1652 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1653 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1655 struct req_format RQF_MDS_HSM_PROGRESS =
1656 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1657 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1659 struct req_format RQF_MDS_HSM_CT_REGISTER =
1660 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1661 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1663 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1664 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1665 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1667 struct req_format RQF_MDS_HSM_STATE_GET =
1668 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1669 mdt_body_capa, mdt_hsm_state_get_server);
1670 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1672 struct req_format RQF_MDS_HSM_STATE_SET =
1673 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1674 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1676 struct req_format RQF_MDS_HSM_REQUEST =
1677 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1678 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1680 struct req_format RQF_MDS_SWAP_LAYOUTS =
1681 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1682 mdt_swap_layouts, empty);
1683 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1685 struct req_format RQF_MDS_RMFID =
1686 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1688 EXPORT_SYMBOL(RQF_MDS_RMFID);
1690 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1691 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1692 llog_origin_handle_create_client, llogd_body_only);
1693 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1695 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1696 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1697 llogd_body_only, llog_origin_handle_next_block_server);
1698 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1700 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1701 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1702 llogd_body_only, llog_origin_handle_next_block_server);
1703 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1705 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1706 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1707 llogd_body_only, llog_log_hdr_only);
1708 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1710 struct req_format RQF_CONNECT =
1711 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1712 EXPORT_SYMBOL(RQF_CONNECT);
1714 struct req_format RQF_OST_CONNECT =
1715 DEFINE_REQ_FMT0("OST_CONNECT",
1716 obd_connect_client, obd_connect_server);
1717 EXPORT_SYMBOL(RQF_OST_CONNECT);
1719 struct req_format RQF_OST_DISCONNECT =
1720 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1721 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1723 struct req_format RQF_OST_GETATTR =
1724 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1725 EXPORT_SYMBOL(RQF_OST_GETATTR);
1727 struct req_format RQF_OST_SETATTR =
1728 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1729 EXPORT_SYMBOL(RQF_OST_SETATTR);
1731 struct req_format RQF_OST_CREATE =
1732 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1733 EXPORT_SYMBOL(RQF_OST_CREATE);
1735 struct req_format RQF_OST_PUNCH =
1736 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1737 EXPORT_SYMBOL(RQF_OST_PUNCH);
1739 struct req_format RQF_OST_FALLOCATE =
1740 DEFINE_REQ_FMT0("OST_FALLOCATE", ost_body_capa, ost_body_only);
1741 EXPORT_SYMBOL(RQF_OST_FALLOCATE);
1743 struct req_format RQF_OST_SEEK =
1744 DEFINE_REQ_FMT0("OST_SEEK", ost_body_only, ost_body_only);
1745 EXPORT_SYMBOL(RQF_OST_SEEK);
1747 struct req_format RQF_OST_SYNC =
1748 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1749 EXPORT_SYMBOL(RQF_OST_SYNC);
1751 struct req_format RQF_OST_DESTROY =
1752 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1753 EXPORT_SYMBOL(RQF_OST_DESTROY);
1755 struct req_format RQF_OST_BRW_READ =
1756 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1757 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1759 struct req_format RQF_OST_BRW_WRITE =
1760 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1761 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1763 struct req_format RQF_OST_STATFS =
1764 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1765 EXPORT_SYMBOL(RQF_OST_STATFS);
1767 struct req_format RQF_OST_SET_GRANT_INFO =
1768 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1770 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1772 struct req_format RQF_OST_GET_INFO =
1773 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1774 ost_get_info_generic_server);
1775 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1777 struct req_format RQF_OST_GET_INFO_LAST_ID =
1778 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1779 ost_get_last_id_server);
1780 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1782 struct req_format RQF_OST_GET_INFO_LAST_FID =
1783 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1784 ost_get_last_fid_server);
1785 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1787 struct req_format RQF_OST_SET_INFO_LAST_FID =
1788 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1790 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1792 struct req_format RQF_OST_GET_INFO_FIEMAP =
1793 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1794 ost_get_fiemap_server);
1795 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1797 struct req_format RQF_LFSCK_NOTIFY =
1798 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1799 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1801 struct req_format RQF_LFSCK_QUERY =
1802 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1803 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1805 struct req_format RQF_OST_LADVISE =
1806 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1807 EXPORT_SYMBOL(RQF_OST_LADVISE);
1809 /* Convenience macro */
1810 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1813 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1814 * field of RQFs and the \a rmf_offset field of RMFs.
1816 int req_layout_init(void)
1821 struct req_format *rf = NULL;
1823 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1824 rf = req_formats[i];
1826 for (j = 0; j < RCL_NR; ++j) {
1827 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1828 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1829 struct req_msg_field *field;
1831 field = (typeof(field))rf->rf_fields[j].d[k];
1832 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1833 || field->rmf_size > 0);
1834 LASSERT(field->rmf_offset[i][j] == 0);
1836 * k + 1 to detect unused format/field
1839 field->rmf_offset[i][j] = k + 1;
1845 EXPORT_SYMBOL(req_layout_init);
1847 void req_layout_fini(void)
1850 EXPORT_SYMBOL(req_layout_fini);
1853 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1855 * Actual/expected field sizes are set elsewhere in functions in this file:
1856 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1857 * req_capsule_msg_size(). The \a rc_area information is used by.
1858 * ptlrpc_request_set_replen().
1860 void req_capsule_init_area(struct req_capsule *pill)
1864 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1865 pill->rc_area[RCL_CLIENT][i] = -1;
1866 pill->rc_area[RCL_SERVER][i] = -1;
1869 EXPORT_SYMBOL(req_capsule_init_area);
1872 * Initialize a pill.
1874 * The \a location indicates whether the caller is executing on the client side
1875 * (RCL_CLIENT) or server side (RCL_SERVER)..
1877 void req_capsule_init(struct req_capsule *pill,
1878 struct ptlrpc_request *req,
1879 enum req_location location)
1881 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1884 * Today all capsules are embedded in ptlrpc_request structs,
1885 * but just in case that ever isn't the case, we don't reach
1886 * into req unless req != NULL and pill is the one embedded in
1889 * The req->rq_pill_init flag makes it safe to initialize a pill
1890 * twice, which might happen in the OST paths as a result of the
1891 * high-priority RPC queue getting peeked at before ost_handle()
1892 * handles an OST RPC.
1894 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1897 pill->rc_fmt = NULL;
1899 pill->rc_loc = location;
1900 req_capsule_init_area(pill);
1902 if (req != NULL && pill == &req->rq_pill)
1903 req->rq_pill_init = 1;
1905 EXPORT_SYMBOL(req_capsule_init);
1907 void req_capsule_fini(struct req_capsule *pill)
1910 EXPORT_SYMBOL(req_capsule_fini);
1912 static int __req_format_is_sane(const struct req_format *fmt)
1914 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1915 req_formats[fmt->rf_idx] == fmt;
1918 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1919 enum req_location loc)
1921 return loc == RCL_CLIENT ? pill->rc_reqmsg : pill->rc_repmsg;
1925 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1926 * (see req_capsule_extend()).
1928 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1930 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1931 LASSERT(__req_format_is_sane(fmt));
1935 EXPORT_SYMBOL(req_capsule_set);
1938 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1941 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1942 * variable-sized fields. The field sizes come from the declared \a rmf_size
1943 * field of a \a pill's \a rc_fmt's RMF's.
1945 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1946 enum req_location loc)
1948 const struct req_format *fmt = pill->rc_fmt;
1951 LASSERT(fmt != NULL);
1953 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1954 if (pill->rc_area[loc][i] == -1) {
1955 pill->rc_area[loc][i] =
1956 fmt->rf_fields[loc].d[i]->rmf_size;
1957 if (pill->rc_area[loc][i] == -1) {
1959 * Skip the following fields.
1961 * If this LASSERT() trips then you're missing a
1962 * call to req_capsule_set_size().
1964 LASSERT(loc != RCL_SERVER);
1971 EXPORT_SYMBOL(req_capsule_filled_sizes);
1974 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1976 * This function uses the \a pill's \a rc_area as filled in by
1977 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1980 int req_capsule_server_pack(struct req_capsule *pill)
1982 const struct req_format *fmt;
1986 LASSERT(pill->rc_loc == RCL_SERVER);
1988 LASSERT(fmt != NULL);
1990 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1991 if (req_capsule_ptlreq(pill)) {
1992 rc = lustre_pack_reply(pill->rc_req, count,
1993 pill->rc_area[RCL_SERVER], NULL);
1995 DEBUG_REQ(D_ERROR, pill->rc_req,
1996 "Cannot pack %d fields in format '%s'",
1997 count, fmt->rf_name);
1999 } else { /* SUB request */
2002 msg_len = lustre_msg_size_v2(count, pill->rc_area[RCL_SERVER]);
2003 if (msg_len > pill->rc_reqmsg->lm_repsize) {
2004 /* TODO: Check whether there is enough buffer size */
2006 "Overflow pack %d fields in format '%s' for "
2007 "the SUB request with message len %u:%u\n",
2008 count, fmt->rf_name, msg_len,
2009 pill->rc_reqmsg->lm_repsize);
2013 lustre_init_msg_v2(pill->rc_repmsg, count,
2014 pill->rc_area[RCL_SERVER], NULL);
2019 EXPORT_SYMBOL(req_capsule_server_pack);
2021 int req_capsule_client_pack(struct req_capsule *pill)
2023 const struct req_format *fmt;
2027 LASSERT(pill->rc_loc == RCL_CLIENT);
2029 LASSERT(fmt != NULL);
2031 count = req_capsule_filled_sizes(pill, RCL_CLIENT);
2032 if (req_capsule_ptlreq(pill)) {
2033 struct ptlrpc_request *req = pill->rc_req;
2035 rc = lustre_pack_request(req, req->rq_import->imp_msg_magic,
2036 count, pill->rc_area[RCL_CLIENT],
2039 /* Sub request in a batch PTLRPC request */
2040 lustre_init_msg_v2(pill->rc_reqmsg, count,
2041 pill->rc_area[RCL_CLIENT], NULL);
2045 EXPORT_SYMBOL(req_capsule_client_pack);
2048 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
2049 * corresponding to the given RMF (\a field).
2051 __u32 __req_capsule_offset(const struct req_capsule *pill,
2052 const struct req_msg_field *field,
2053 enum req_location loc)
2055 unsigned int offset;
2057 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2058 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
2059 pill->rc_fmt->rf_name,
2060 field->rmf_name, offset, loc);
2063 LASSERT(offset < REQ_MAX_FIELD_NR);
2067 void req_capsule_set_swabbed(struct req_capsule *pill, enum req_location loc,
2070 if (loc == RCL_CLIENT)
2071 req_capsule_set_req_swabbed(pill, index);
2073 req_capsule_set_rep_swabbed(pill, index);
2076 bool req_capsule_need_swab(struct req_capsule *pill, enum req_location loc,
2079 if (loc == RCL_CLIENT)
2080 return (req_capsule_req_need_swab(pill) &&
2081 !req_capsule_req_swabbed(pill, index));
2083 return (req_capsule_rep_need_swab(pill) &&
2084 !req_capsule_rep_swabbed(pill, index));
2088 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
2092 swabber_dumper_helper(struct req_capsule *pill,
2093 const struct req_msg_field *field,
2094 enum req_location loc,
2096 void *value, int len, bool dump, void (*swabber)(void *))
2104 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2106 swabber = swabber ?: field->rmf_swabber;
2108 if (req_capsule_need_swab(pill, loc, offset) &&
2109 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2114 if (!field->rmf_dumper)
2118 * We're swabbing an array; swabber() swabs a single array element, so
2119 * swab every element.
2121 if (array && (len % field->rmf_size)) {
2122 static const struct req_msg_field *last_field;
2124 if (field != last_field) {
2125 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2126 field->rmf_name, len, field->rmf_size);
2130 /* For the non-array cases, the process of swab/dump/swab only
2131 * needs to be done once. (n = 1)
2134 len = field->rmf_size;
2135 for (p = value, i = 0, n = len / field->rmf_size;
2137 i++, p += field->rmf_size) {
2139 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2140 do_swab ? "unswabbed " : "",
2141 array ? "array " : "",
2142 field->rmf_name, i);
2143 field->rmf_dumper(p);
2151 if (!field->rmf_swab_len) {
2154 size = field->rmf_swab_len(p, len);
2163 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2164 array ? "array " : "", field->rmf_name, i);
2165 field->rmf_dumper(value);
2169 req_capsule_set_swabbed(pill, loc, offset);
2175 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2176 * corresponding to the given RMF (\a field).
2178 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2179 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2180 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2181 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2182 * element of the array swabbed.
2184 static void *__req_capsule_get(struct req_capsule *pill,
2185 const struct req_msg_field *field,
2186 enum req_location loc,
2187 void (*swabber)(void *),
2190 const struct req_format *fmt;
2191 struct lustre_msg *msg;
2196 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2198 static const char *rcl_names[RCL_NR] = {
2199 [RCL_CLIENT] = "client",
2200 [RCL_SERVER] = "server"
2203 LASSERT(pill != NULL);
2204 LASSERT(pill != LP_POISON);
2206 LASSERT(fmt != NULL);
2207 LASSERT(fmt != LP_POISON);
2208 LASSERT(__req_format_is_sane(fmt));
2210 offset = __req_capsule_offset(pill, field, loc);
2212 msg = __req_msg(pill, loc);
2213 LASSERT(msg != NULL);
2215 getter = (field->rmf_flags & RMF_F_STRING) ?
2216 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2218 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2220 * We've already asserted that field->rmf_size > 0 in
2221 * req_layout_init().
2223 len = lustre_msg_buflen(msg, offset);
2224 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2225 (len % field->rmf_size) != 0) {
2226 CERROR("%s: array field size mismatch "
2227 "%d modulo %u != 0 (%d)\n",
2228 field->rmf_name, len, field->rmf_size, loc);
2231 } else if (pill->rc_area[loc][offset] != -1) {
2232 len = pill->rc_area[loc][offset];
2234 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2236 value = getter(msg, offset, len);
2238 if (value == NULL) {
2239 LASSERT(pill->rc_req != NULL);
2240 DEBUG_REQ(D_ERROR, pill->rc_req,
2241 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2242 field->rmf_name, offset, lustre_msg_bufcount(msg),
2243 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2246 swabber_dumper_helper(pill, field, loc, offset, value, len,
2254 * Dump a request and/or reply
2256 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2258 const struct req_format *fmt;
2259 const struct req_msg_field *field;
2265 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2266 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2267 field = FMT_FIELD(fmt, loc, i);
2268 if (field->rmf_dumper == NULL) {
2270 * FIXME Add a default hex dumper for fields that don't
2271 * have a specific dumper
2273 len = req_capsule_get_size(pill, field, loc);
2275 "Field %s has no dumper function; field size is %u\n",
2276 field->rmf_name, len);
2278 /* It's dumping side-effect that we're interested in */
2279 (void) __req_capsule_get(pill, field, loc, NULL, true);
2282 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2288 void req_capsule_client_dump(struct req_capsule *pill)
2290 __req_capsule_dump(pill, RCL_CLIENT);
2292 EXPORT_SYMBOL(req_capsule_client_dump);
2297 void req_capsule_server_dump(struct req_capsule *pill)
2299 __req_capsule_dump(pill, RCL_SERVER);
2301 EXPORT_SYMBOL(req_capsule_server_dump);
2304 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2305 * buffer corresponding to the given RMF (\a field) of a \a pill.
2307 void *req_capsule_client_get(struct req_capsule *pill,
2308 const struct req_msg_field *field)
2310 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2312 EXPORT_SYMBOL(req_capsule_client_get);
2315 * Same as req_capsule_client_get(), but with a \a swabber argument.
2317 * Currently unused; will be removed when req_capsule_server_swab_get() is
2320 void *req_capsule_client_swab_get(struct req_capsule *pill,
2321 const struct req_msg_field *field,
2324 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2326 EXPORT_SYMBOL(req_capsule_client_swab_get);
2329 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2331 * First the \a pill's request \a field's size is set (\a rc_area) using
2332 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2335 void *req_capsule_client_sized_get(struct req_capsule *pill,
2336 const struct req_msg_field *field,
2339 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2340 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2342 EXPORT_SYMBOL(req_capsule_client_sized_get);
2345 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2346 * buffer corresponding to the given RMF (\a field) of a \a pill.
2348 void *req_capsule_server_get(struct req_capsule *pill,
2349 const struct req_msg_field *field)
2351 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2353 EXPORT_SYMBOL(req_capsule_server_get);
2356 * Same as req_capsule_server_get(), but with a \a swabber argument.
2358 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2359 * swabbing done outside this capsule abstraction.
2361 void *req_capsule_server_swab_get(struct req_capsule *pill,
2362 const struct req_msg_field *field,
2365 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2367 EXPORT_SYMBOL(req_capsule_server_swab_get);
2370 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2372 * First the \a pill's request \a field's size is set (\a rc_area) using
2373 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2376 void *req_capsule_server_sized_get(struct req_capsule *pill,
2377 const struct req_msg_field *field,
2380 req_capsule_set_size(pill, field, RCL_SERVER, len);
2381 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2383 EXPORT_SYMBOL(req_capsule_server_sized_get);
2385 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2386 const struct req_msg_field *field,
2387 __u32 len, void *swabber)
2389 req_capsule_set_size(pill, field, RCL_SERVER, len);
2390 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2392 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2395 * Returns the buffer of a \a pill corresponding to the given \a field from the
2396 * request (if the caller is executing on the server-side) or reply (if the
2397 * caller is executing on the client-side).
2399 * This function convienient for use is code that could be executed on the
2400 * client and server alike.
2402 const void *req_capsule_other_get(struct req_capsule *pill,
2403 const struct req_msg_field *field)
2405 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2407 EXPORT_SYMBOL(req_capsule_other_get);
2410 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2411 * field of the given \a pill.
2413 * This function must be used when constructing variable sized fields of a
2416 void req_capsule_set_size(struct req_capsule *pill,
2417 const struct req_msg_field *field,
2418 enum req_location loc, __u32 size)
2420 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2422 if ((size != (__u32)field->rmf_size) &&
2423 (field->rmf_size != -1) &&
2424 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2426 __u32 rmf_size = (__u32)field->rmf_size;
2427 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2428 (size % rmf_size != 0)) {
2429 CERROR("%s: array field size mismatch "
2430 "%u %% %u != 0 (%d)\n",
2431 field->rmf_name, size, rmf_size, loc);
2433 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2435 CERROR("%s: field size mismatch %u != %u (%d)\n",
2436 field->rmf_name, size, rmf_size, loc);
2441 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2443 EXPORT_SYMBOL(req_capsule_set_size);
2446 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2447 * for the given \a pill's given \a field.
2449 * NB: this function doesn't correspond with req_capsule_set_size(), which
2450 * actually sets the size in pill.rc_area[loc][offset], but this function
2451 * returns the message buflen[offset], maybe we should use another name.
2453 __u32 req_capsule_get_size(const struct req_capsule *pill,
2454 const struct req_msg_field *field,
2455 enum req_location loc)
2457 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2459 return lustre_msg_buflen(__req_msg(pill, loc),
2460 __req_capsule_offset(pill, field, loc));
2462 EXPORT_SYMBOL(req_capsule_get_size);
2465 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2466 * given \a pill's request or reply (\a loc) given the field size recorded in
2467 * the \a pill's rc_area.
2469 * See also req_capsule_set_size().
2471 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2473 if (req_capsule_ptlreq(pill)) {
2474 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2475 pill->rc_fmt->rf_fields[loc].nr,
2476 pill->rc_area[loc]);
2477 } else { /* SUB request in a batch request */
2480 count = req_capsule_filled_sizes(pill, loc);
2481 return lustre_msg_size_v2(count, pill->rc_area[loc]);
2484 EXPORT_SYMBOL(req_capsule_msg_size);
2487 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2488 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2489 * PTLRPC request or reply given only an RQF (\a fmt).
2491 * This function should not be used for formats which contain variable size
2494 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2495 enum req_location loc)
2501 * This function should probably LASSERT() that fmt has no fields with
2502 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2503 * elements in the array there will ultimately be, but then, we could
2504 * assume that there will be at least one element, and that's just what
2507 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2511 for (; i < fmt->rf_fields[loc].nr; ++i)
2512 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2513 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2517 EXPORT_SYMBOL(req_capsule_fmt_size);
2520 * Changes the format of an RPC.
2522 * The pill must already have been initialized, which means that it already has
2523 * a request format. The new format \a fmt must be an extension of the pill's
2524 * old format. Specifically: the new format must have as many request and reply
2525 * fields as the old one, and all fields shared by the old and new format must
2526 * be at least as large in the new format.
2528 * The new format's fields may be of different "type" than the old format, but
2529 * only for fields that are "opaque" blobs: fields which have a) have no
2530 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2531 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2532 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2533 * according to the key field. When the value, according to the key, contains a
2534 * structure (or array thereof) to be swabbed, the format should be changed to
2535 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2538 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2543 const struct req_format *old;
2545 LASSERT(pill->rc_fmt != NULL);
2546 LASSERT(__req_format_is_sane(fmt));
2550 * Sanity checking...
2552 for (i = 0; i < RCL_NR; ++i) {
2553 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2554 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2555 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2557 /* "opaque" fields can be transmogrified */
2558 if (ofield->rmf_swabber == NULL &&
2559 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2560 (ofield->rmf_size == -1 ||
2561 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2563 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2566 * Last field in old format can be shorter than in new.
2568 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2569 FMT_FIELD(old, i, j)->rmf_size);
2574 EXPORT_SYMBOL(req_capsule_extend);
2577 * This function returns a non-zero value if the given \a field is present in
2578 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2581 int req_capsule_has_field(const struct req_capsule *pill,
2582 const struct req_msg_field *field,
2583 enum req_location loc)
2585 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2587 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2589 EXPORT_SYMBOL(req_capsule_has_field);
2592 * Returns a non-zero value if the given \a field is present in the given \a
2593 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2595 int req_capsule_field_present(const struct req_capsule *pill,
2596 const struct req_msg_field *field,
2597 enum req_location loc)
2601 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2602 LASSERT(req_capsule_has_field(pill, field, loc));
2604 offset = __req_capsule_offset(pill, field, loc);
2605 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2607 EXPORT_SYMBOL(req_capsule_field_present);
2610 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2611 * request or reply (\a loc).
2613 * This is not the opposite of req_capsule_extend().
2615 void req_capsule_shrink(struct req_capsule *pill,
2616 const struct req_msg_field *field,
2618 enum req_location loc)
2620 const struct req_format *fmt;
2621 struct lustre_msg *msg;
2626 LASSERT(fmt != NULL);
2627 LASSERT(__req_format_is_sane(fmt));
2628 LASSERT(req_capsule_has_field(pill, field, loc));
2629 LASSERT(req_capsule_field_present(pill, field, loc));
2631 offset = __req_capsule_offset(pill, field, loc);
2633 msg = __req_msg(pill, loc);
2634 len = lustre_msg_buflen(msg, offset);
2635 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2636 fmt->rf_name, field->rmf_name, len, newlen);
2638 len = lustre_shrink_msg(msg, offset, newlen, 1);
2639 if (loc == RCL_CLIENT) {
2640 if (req_capsule_ptlreq(pill))
2641 pill->rc_req->rq_reqlen = len;
2643 /* update also field size in reply lenghts arrays for possible
2644 * reply re-pack due to req_capsule_server_grow() call.
2646 req_capsule_set_size(pill, field, loc, newlen);
2647 if (req_capsule_ptlreq(pill))
2648 pill->rc_req->rq_replen = len;
2651 EXPORT_SYMBOL(req_capsule_shrink);
2653 int req_capsule_server_grow(struct req_capsule *pill,
2654 const struct req_msg_field *field,
2657 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2662 LASSERT(pill->rc_fmt != NULL);
2663 LASSERT(__req_format_is_sane(pill->rc_fmt));
2664 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2665 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2667 len = req_capsule_get_size(pill, field, RCL_SERVER);
2668 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2670 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2671 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2674 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2676 * There can be enough space in current reply buffer, make sure
2677 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2678 * re-packing is still needed.
2680 if (rs->rs_msg == rs->rs_repbuf &&
2681 rs->rs_repbuf_len >=
2682 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2683 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2688 /* Re-allocate replay state */
2689 pill->rc_req->rq_reply_state = NULL;
2690 rc = req_capsule_server_pack(pill);
2692 /* put old values back, the caller should decide what to do */
2693 req_capsule_set_size(pill, field, RCL_SERVER, len);
2694 pill->rc_req->rq_reply_state = rs;
2697 nrs = pill->rc_req->rq_reply_state;
2698 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2699 lustre_packed_msg_size(rs->rs_msg));
2701 /* Now we need only buffers, copy them and grow the needed one */
2702 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2703 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2705 (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from);
2706 lustre_msg_set_buflen(nrs->rs_msg, offset, len);
2707 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2709 if (rs->rs_difficult) {
2713 nrs->rs_difficult = 1;
2714 nrs->rs_no_ack = rs->rs_no_ack;
2715 nrs->rs_convert_lock = rs->rs_convert_lock;
2716 for (i = 0; i < rs->rs_nlocks; i++) {
2717 nrs->rs_locks[i] = rs->rs_locks[i];
2718 nrs->rs_modes[i] = rs->rs_modes[i];
2722 rs->rs_difficult = 0;
2725 ptlrpc_rs_decref(rs);
2728 EXPORT_SYMBOL(req_capsule_server_grow);
2730 #ifdef HAVE_SERVER_SUPPORT
2731 static const struct req_msg_field *mds_update_client[] = {
2733 &RMF_OUT_UPDATE_HEADER,
2734 &RMF_OUT_UPDATE_BUF,
2737 static const struct req_msg_field *mds_update_server[] = {
2739 &RMF_OUT_UPDATE_REPLY,
2742 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
2743 lustre_swab_object_update_request, NULL);
2744 EXPORT_SYMBOL(RMF_OUT_UPDATE);
2746 struct req_msg_field RMF_OUT_UPDATE_REPLY =
2747 DEFINE_MSGFL("object_update_reply", 0, -1,
2748 lustre_swab_object_update_reply, NULL);
2749 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
2751 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
2752 -1, lustre_swab_out_update_header, NULL);
2753 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
2755 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
2756 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
2757 lustre_swab_out_update_buffer, NULL);
2758 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
2760 struct req_format RQF_OUT_UPDATE =
2761 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
2763 EXPORT_SYMBOL(RQF_OUT_UPDATE);
2765 int req_check_sepol(struct req_capsule *pill)
2768 struct obd_export *export;
2769 struct lu_nodemap *nm = NULL;
2770 const char *sepol = NULL;
2771 const char *nm_sepol = NULL;
2773 if (req_capsule_subreq(pill))
2779 export = pill->rc_req->rq_export;
2780 if (!export || !exp_connect_sepol(export) ||
2781 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2784 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2787 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2788 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2792 nm = nodemap_get_from_exp(export);
2793 if (!IS_ERR_OR_NULL(nm)) {
2794 nm_sepol = nodemap_get_sepol(nm);
2795 if (nm_sepol && nm_sepol[0])
2796 if (sepol == NULL ||
2797 strcmp(sepol, nm_sepol) != 0)
2802 if (!IS_ERR_OR_NULL(nm))
2807 EXPORT_SYMBOL(req_check_sepol);
2810 void req_capsule_subreq_init(struct req_capsule *pill,
2811 const struct req_format *fmt,
2812 struct ptlrpc_request *req,
2813 struct lustre_msg *reqmsg,
2814 struct lustre_msg *repmsg,
2815 enum req_location loc)
2817 req_capsule_init(pill, req, loc);
2818 req_capsule_set(pill, fmt);
2819 pill->rc_reqmsg = reqmsg;
2820 pill->rc_repmsg = repmsg;
2822 EXPORT_SYMBOL(req_capsule_subreq_init);
2824 void req_capsule_set_replen(struct req_capsule *pill)
2826 if (req_capsule_ptlreq(pill)) {
2827 ptlrpc_request_set_replen(pill->rc_req);
2828 } else { /* SUB request in a batch request */
2831 count = req_capsule_filled_sizes(pill, RCL_SERVER);
2832 pill->rc_reqmsg->lm_repsize =
2833 lustre_msg_size_v2(count,
2834 pill->rc_area[RCL_SERVER]);
2837 EXPORT_SYMBOL(req_capsule_set_replen);