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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ptlrpc/layout.c
34 * Lustre Metadata Target (mdt) request handler
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
41 * Every struct ptlrpc_request contains a "pill", which points to a description
42 * of the format that the request conforms to.
45 #define DEBUG_SUBSYSTEM S_RPC
47 #include <linux/module.h>
49 #include <llog_swab.h>
50 #include <lustre_debug.h>
51 #include <lustre_swab.h>
53 #include <obd_support.h>
55 /* struct ptlrpc_request, lustre_msg* */
56 #include <lustre_req_layout.h>
57 #include <lustre_acl.h>
58 #include <lustre_nodemap.h>
61 * RQFs (see below) refer to two struct req_msg_field arrays describing the
62 * client request and server reply, respectively.
64 /* empty set of fields... for suitable definition of emptiness. */
65 static const struct req_msg_field *empty[] = {
69 static const struct req_msg_field *mgs_target_info_only[] = {
74 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
75 static const struct req_msg_field *mgs_set_info[] = {
81 static const struct req_msg_field *mgs_config_read_client[] = {
86 static const struct req_msg_field *mgs_config_read_server[] = {
91 static const struct req_msg_field *mdt_body_only[] = {
96 static const struct req_msg_field *mdt_body_capa[] = {
102 static const struct req_msg_field *quotactl_only[] = {
107 static const struct req_msg_field *quota_body_only[] = {
112 static const struct req_msg_field *ldlm_intent_quota_client[] = {
119 static const struct req_msg_field *ldlm_intent_quota_server[] = {
126 static const struct req_msg_field *mdt_close_client[] = {
133 static const struct req_msg_field *mdt_close_intent_client[] = {
142 static const struct req_msg_field *obd_statfs_server[] = {
147 static const struct req_msg_field *seq_query_client[] = {
153 static const struct req_msg_field *seq_query_server[] = {
158 static const struct req_msg_field *fld_query_client[] = {
164 static const struct req_msg_field *fld_query_server[] = {
169 static const struct req_msg_field *fld_read_client[] = {
174 static const struct req_msg_field *fld_read_server[] = {
179 static const struct req_msg_field *mds_getattr_name_client[] = {
186 static const struct req_msg_field *mds_reint_client[] = {
191 static const struct req_msg_field *mds_reint_create_client[] = {
198 static const struct req_msg_field *mds_reint_create_slave_client[] = {
207 static const struct req_msg_field *mds_reint_create_acl_client[] = {
214 &RMF_FILE_SECCTX_NAME,
219 static const struct req_msg_field *mds_reint_create_sym_client[] = {
226 &RMF_FILE_SECCTX_NAME,
231 static const struct req_msg_field *mds_reint_open_client[] = {
238 &RMF_FILE_SECCTX_NAME,
243 static const struct req_msg_field *mds_reint_open_server[] = {
252 static const struct req_msg_field *mds_reint_unlink_client[] = {
261 static const struct req_msg_field *mds_reint_link_client[] = {
271 static const struct req_msg_field *mds_reint_rename_client[] = {
282 static const struct req_msg_field *mds_reint_migrate_client[] = {
296 static const struct req_msg_field *mds_last_unlink_server[] = {
305 static const struct req_msg_field *mds_reint_setattr_client[] = {
315 static const struct req_msg_field *mds_reint_setxattr_client[] = {
325 static const struct req_msg_field *mds_reint_resync[] = {
331 static const struct req_msg_field *mdt_swap_layouts[] = {
340 static const struct req_msg_field *mds_rmfid_client[] = {
348 static const struct req_msg_field *mds_rmfid_server[] = {
355 static const struct req_msg_field *obd_connect_client[] = {
364 static const struct req_msg_field *obd_connect_server[] = {
369 static const struct req_msg_field *obd_set_info_client[] = {
375 static const struct req_msg_field *mdt_set_info_client[] = {
382 static const struct req_msg_field *ost_grant_shrink_client[] = {
388 static const struct req_msg_field *mds_getinfo_client[] = {
394 static const struct req_msg_field *mds_getinfo_server[] = {
399 static const struct req_msg_field *ldlm_enqueue_client[] = {
404 static const struct req_msg_field *ldlm_enqueue_server[] = {
409 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
415 static const struct req_msg_field *ldlm_cp_callback_client[] = {
421 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
427 static const struct req_msg_field *ldlm_gl_callback_server[] = {
432 static const struct req_msg_field *ldlm_intent_basic_client[] = {
438 static const struct req_msg_field *ldlm_intent_client[] = {
445 static const struct req_msg_field *ldlm_intent_server[] = {
453 static const struct req_msg_field *ldlm_intent_layout_client[] = {
458 &RMF_EADATA /* for new layout to be set up */
461 static const struct req_msg_field *ldlm_intent_open_server[] = {
473 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
477 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
480 &RMF_FILE_SECCTX_NAME
483 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
494 static const struct req_msg_field *ldlm_intent_create_client[] = {
498 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
502 &RMF_FILE_SECCTX_NAME,
507 static const struct req_msg_field *ldlm_intent_open_client[] = {
511 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
516 &RMF_FILE_SECCTX_NAME,
521 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
530 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
535 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
541 static const struct req_msg_field *mds_get_root_client[] = {
547 static const struct req_msg_field *mds_getxattr_client[] = {
556 static const struct req_msg_field *mds_getxattr_server[] = {
562 static const struct req_msg_field *mds_getattr_server[] = {
571 static const struct req_msg_field *mds_setattr_server[] = {
580 static const struct req_msg_field *mds_update_client[] = {
582 &RMF_OUT_UPDATE_HEADER,
586 static const struct req_msg_field *mds_update_server[] = {
588 &RMF_OUT_UPDATE_REPLY,
591 static const struct req_msg_field *llog_origin_handle_create_client[] = {
598 static const struct req_msg_field *llogd_body_only[] = {
603 static const struct req_msg_field *llog_log_hdr_only[] = {
608 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
614 static const struct req_msg_field *obd_idx_read_client[] = {
619 static const struct req_msg_field *obd_idx_read_server[] = {
624 static const struct req_msg_field *ost_body_only[] = {
629 static const struct req_msg_field *ost_body_capa[] = {
635 static const struct req_msg_field *ost_destroy_client[] = {
643 static const struct req_msg_field *ost_brw_client[] = {
652 static const struct req_msg_field *ost_brw_read_server[] = {
658 static const struct req_msg_field *ost_brw_write_server[] = {
664 static const struct req_msg_field *ost_get_info_generic_server[] = {
669 static const struct req_msg_field *ost_get_info_generic_client[] = {
674 static const struct req_msg_field *ost_get_last_id_server[] = {
679 static const struct req_msg_field *ost_get_last_fid_client[] = {
685 static const struct req_msg_field *ost_get_last_fid_server[] = {
690 static const struct req_msg_field *ost_get_fiemap_client[] = {
696 static const struct req_msg_field *ost_ladvise[] = {
699 &RMF_OST_LADVISE_HDR,
703 static const struct req_msg_field *ost_get_fiemap_server[] = {
708 static const struct req_msg_field *mdt_hsm_progress[] = {
711 &RMF_MDS_HSM_PROGRESS,
714 static const struct req_msg_field *mdt_hsm_ct_register[] = {
717 &RMF_MDS_HSM_ARCHIVE,
720 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
725 static const struct req_msg_field *mdt_hsm_action_server[] = {
728 &RMF_MDS_HSM_CURRENT_ACTION,
731 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
737 static const struct req_msg_field *mdt_hsm_state_set[] = {
744 static const struct req_msg_field *mdt_hsm_request[] = {
747 &RMF_MDS_HSM_REQUEST,
748 &RMF_MDS_HSM_USER_ITEM,
752 static const struct req_msg_field *obd_lfsck_request[] = {
757 static const struct req_msg_field *obd_lfsck_reply[] = {
762 static struct req_format *req_formats[] = {
769 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
772 &RQF_MGS_CONFIG_READ,
783 &RQF_MDS_GETATTR_NAME,
787 &RQF_MDS_CLOSE_INTENT,
790 &RQF_MDS_REINT_CREATE,
791 &RQF_MDS_REINT_CREATE_ACL,
792 &RQF_MDS_REINT_CREATE_SLAVE,
793 &RQF_MDS_REINT_CREATE_SYM,
795 &RQF_MDS_REINT_UNLINK,
797 &RQF_MDS_REINT_RENAME,
798 &RQF_MDS_REINT_MIGRATE,
799 &RQF_MDS_REINT_SETATTR,
800 &RQF_MDS_REINT_SETXATTR,
801 &RQF_MDS_REINT_RESYNC,
803 &RQF_MDS_HSM_PROGRESS,
804 &RQF_MDS_HSM_CT_REGISTER,
805 &RQF_MDS_HSM_CT_UNREGISTER,
806 &RQF_MDS_HSM_STATE_GET,
807 &RQF_MDS_HSM_STATE_SET,
809 &RQF_MDS_HSM_REQUEST,
810 &RQF_MDS_SWAP_LAYOUTS,
826 &RQF_OST_SET_GRANT_INFO,
828 &RQF_OST_GET_INFO_LAST_ID,
829 &RQF_OST_GET_INFO_LAST_FID,
830 &RQF_OST_SET_INFO_LAST_FID,
831 &RQF_OST_GET_INFO_FIEMAP,
834 &RQF_LDLM_ENQUEUE_LVB,
838 &RQF_LDLM_CP_CALLBACK,
839 &RQF_LDLM_BL_CALLBACK,
840 &RQF_LDLM_GL_CALLBACK,
841 &RQF_LDLM_GL_CALLBACK_DESC,
843 &RQF_LDLM_INTENT_BASIC,
844 &RQF_LDLM_INTENT_LAYOUT,
845 &RQF_LDLM_INTENT_GETATTR,
846 &RQF_LDLM_INTENT_OPEN,
847 &RQF_LDLM_INTENT_CREATE,
848 &RQF_LDLM_INTENT_GETXATTR,
849 &RQF_LDLM_INTENT_QUOTA,
851 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
852 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
853 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
854 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
860 struct req_msg_field {
861 const __u32 rmf_flags;
862 const char *rmf_name;
864 * Field length. (-1) means "variable length". If the
865 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
866 * but the actual size must be a whole multiple of \a rmf_size.
869 void (*rmf_swabber)(void *);
871 * Pass buffer size to swabbing function
872 * \retval > 0 the number of bytes swabbed
873 * -EOVERFLOW on error
875 int (*rmf_swab_len)(void *, __u32);
876 void (*rmf_dumper)(void *);
877 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
882 * The field is a string, must be NUL-terminated.
884 RMF_F_STRING = 1 << 0,
886 * The field's buffer size need not match the declared \a rmf_size.
888 RMF_F_NO_SIZE_CHECK = 1 << 1,
890 * The field's buffer size must be a whole multiple of the declared \a
891 * rmf_size and the \a rmf_swabber function must work on the declared \a
892 * rmf_size worth of bytes.
894 RMF_F_STRUCT_ARRAY = 1 << 2
902 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
903 .rmf_name = (name), \
904 .rmf_flags = (flags), \
905 .rmf_size = (size), \
906 .rmf_swabber = (void (*)(void*))(swabber), \
907 .rmf_dumper = (void (*)(void*))(dumper) \
910 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
911 .rmf_name = (name), \
912 .rmf_flags = (flags), \
913 .rmf_size = (size), \
914 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
915 .rmf_dumper = (void (*)(void *))(dumper) \
918 struct req_msg_field RMF_GENERIC_DATA =
919 DEFINE_MSGF("generic_data", 0,
921 EXPORT_SYMBOL(RMF_GENERIC_DATA);
923 struct req_msg_field RMF_MGS_TARGET_INFO =
924 DEFINE_MSGF("mgs_target_info", 0,
925 sizeof(struct mgs_target_info),
926 lustre_swab_mgs_target_info, NULL);
927 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
929 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
930 struct req_msg_field RMF_MGS_SEND_PARAM =
931 DEFINE_MSGF("mgs_send_param", 0,
932 sizeof(struct mgs_send_param),
934 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
937 struct req_msg_field RMF_MGS_CONFIG_BODY =
938 DEFINE_MSGF("mgs_config_read request", 0,
939 sizeof(struct mgs_config_body),
940 lustre_swab_mgs_config_body, NULL);
941 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
943 struct req_msg_field RMF_MGS_CONFIG_RES =
944 DEFINE_MSGF("mgs_config_read reply ", 0,
945 sizeof(struct mgs_config_res),
946 lustre_swab_mgs_config_res, NULL);
947 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
949 struct req_msg_field RMF_U32 =
950 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
951 sizeof(__u32), lustre_swab_generic_32s, NULL);
952 EXPORT_SYMBOL(RMF_U32);
954 struct req_msg_field RMF_SETINFO_VAL =
955 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
956 EXPORT_SYMBOL(RMF_SETINFO_VAL);
958 struct req_msg_field RMF_GETINFO_KEY =
959 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
960 EXPORT_SYMBOL(RMF_GETINFO_KEY);
962 struct req_msg_field RMF_GETINFO_VALLEN =
963 DEFINE_MSGF("getinfo_vallen", 0,
964 sizeof(__u32), lustre_swab_generic_32s, NULL);
965 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
967 struct req_msg_field RMF_GETINFO_VAL =
968 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
969 EXPORT_SYMBOL(RMF_GETINFO_VAL);
971 struct req_msg_field RMF_SEQ_OPC =
972 DEFINE_MSGF("seq_query_opc", 0,
973 sizeof(__u32), lustre_swab_generic_32s, NULL);
974 EXPORT_SYMBOL(RMF_SEQ_OPC);
976 struct req_msg_field RMF_SEQ_RANGE =
977 DEFINE_MSGF("seq_query_range", 0,
978 sizeof(struct lu_seq_range),
979 lustre_swab_lu_seq_range, NULL);
980 EXPORT_SYMBOL(RMF_SEQ_RANGE);
982 struct req_msg_field RMF_FLD_OPC =
983 DEFINE_MSGF("fld_query_opc", 0,
984 sizeof(__u32), lustre_swab_generic_32s, NULL);
985 EXPORT_SYMBOL(RMF_FLD_OPC);
987 struct req_msg_field RMF_FLD_MDFLD =
988 DEFINE_MSGF("fld_query_mdfld", 0,
989 sizeof(struct lu_seq_range),
990 lustre_swab_lu_seq_range, NULL);
991 EXPORT_SYMBOL(RMF_FLD_MDFLD);
993 struct req_msg_field RMF_MDT_BODY =
994 DEFINE_MSGF("mdt_body", 0,
995 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
996 EXPORT_SYMBOL(RMF_MDT_BODY);
998 struct req_msg_field RMF_OBD_QUOTACTL =
999 DEFINE_MSGFL("obd_quotactl",
1001 sizeof(struct obd_quotactl),
1002 lustre_swab_obd_quotactl, NULL);
1003 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
1005 struct req_msg_field RMF_QUOTA_BODY =
1006 DEFINE_MSGF("quota_body", 0,
1007 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
1008 EXPORT_SYMBOL(RMF_QUOTA_BODY);
1010 struct req_msg_field RMF_MDT_EPOCH =
1011 DEFINE_MSGF("mdt_ioepoch", 0,
1012 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
1013 EXPORT_SYMBOL(RMF_MDT_EPOCH);
1015 struct req_msg_field RMF_PTLRPC_BODY =
1016 DEFINE_MSGF("ptlrpc_body", 0,
1017 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
1018 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
1020 struct req_msg_field RMF_CLOSE_DATA =
1021 DEFINE_MSGF("data_version", 0,
1022 sizeof(struct close_data), lustre_swab_close_data, NULL);
1023 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1025 struct req_msg_field RMF_OBD_STATFS =
1026 DEFINE_MSGF("obd_statfs", 0,
1027 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1028 EXPORT_SYMBOL(RMF_OBD_STATFS);
1030 struct req_msg_field RMF_SETINFO_KEY =
1031 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1032 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1034 struct req_msg_field RMF_NAME =
1035 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1036 EXPORT_SYMBOL(RMF_NAME);
1038 struct req_msg_field RMF_FID_ARRAY =
1039 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1040 EXPORT_SYMBOL(RMF_FID_ARRAY);
1042 struct req_msg_field RMF_SYMTGT =
1043 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
1044 EXPORT_SYMBOL(RMF_SYMTGT);
1046 struct req_msg_field RMF_TGTUUID =
1047 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1049 EXPORT_SYMBOL(RMF_TGTUUID);
1051 struct req_msg_field RMF_CLUUID =
1052 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1054 EXPORT_SYMBOL(RMF_CLUUID);
1056 struct req_msg_field RMF_STRING =
1057 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1058 EXPORT_SYMBOL(RMF_STRING);
1060 struct req_msg_field RMF_FILE_SECCTX_NAME =
1061 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1062 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1064 struct req_msg_field RMF_FILE_SECCTX =
1065 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1066 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1068 struct req_msg_field RMF_LLOGD_BODY =
1069 DEFINE_MSGF("llogd_body", 0,
1070 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1071 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1073 struct req_msg_field RMF_LLOG_LOG_HDR =
1074 DEFINE_MSGF("llog_log_hdr", 0,
1075 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1076 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1078 struct req_msg_field RMF_LLOGD_CONN_BODY =
1079 DEFINE_MSGF("llogd_conn_body", 0,
1080 sizeof(struct llogd_conn_body),
1081 lustre_swab_llogd_conn_body, NULL);
1082 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1085 * connection handle received in MDS_CONNECT request.
1087 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1088 * that the client does not interpret at all.
1090 struct req_msg_field RMF_CONN =
1091 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1092 EXPORT_SYMBOL(RMF_CONN);
1094 struct req_msg_field RMF_CONNECT_DATA =
1095 DEFINE_MSGF("cdata",
1096 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1097 sizeof(struct obd_connect_data),
1098 lustre_swab_connect, NULL);
1099 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1101 struct req_msg_field RMF_DLM_REQ =
1102 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1103 sizeof(struct ldlm_request),
1104 lustre_swab_ldlm_request, NULL);
1105 EXPORT_SYMBOL(RMF_DLM_REQ);
1107 struct req_msg_field RMF_DLM_REP =
1108 DEFINE_MSGF("dlm_rep", 0,
1109 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1110 EXPORT_SYMBOL(RMF_DLM_REP);
1112 struct req_msg_field RMF_LDLM_INTENT =
1113 DEFINE_MSGF("ldlm_intent", 0,
1114 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1115 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1117 struct req_msg_field RMF_DLM_LVB =
1118 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1119 EXPORT_SYMBOL(RMF_DLM_LVB);
1121 struct req_msg_field RMF_DLM_GL_DESC =
1122 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1123 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1125 struct req_msg_field RMF_MDT_MD =
1126 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1127 EXPORT_SYMBOL(RMF_MDT_MD);
1129 struct req_msg_field RMF_DEFAULT_MDT_MD =
1130 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1132 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1134 struct req_msg_field RMF_REC_REINT =
1135 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1136 lustre_swab_mdt_rec_reint, NULL);
1137 EXPORT_SYMBOL(RMF_REC_REINT);
1139 /* FIXME: this length should be defined as a macro */
1140 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1142 EXPORT_SYMBOL(RMF_EADATA);
1144 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1145 EXPORT_SYMBOL(RMF_EAVALS);
1147 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1148 EXPORT_SYMBOL(RMF_ACL);
1150 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1151 struct req_msg_field RMF_LOGCOOKIES =
1152 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1153 sizeof(struct llog_cookie), NULL, NULL);
1154 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1156 struct req_msg_field RMF_CAPA1 =
1157 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1158 EXPORT_SYMBOL(RMF_CAPA1);
1160 struct req_msg_field RMF_CAPA2 =
1161 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1162 EXPORT_SYMBOL(RMF_CAPA2);
1164 struct req_msg_field RMF_LAYOUT_INTENT =
1165 DEFINE_MSGF("layout_intent", 0,
1166 sizeof(struct layout_intent), lustre_swab_layout_intent,
1168 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1170 struct req_msg_field RMF_SELINUX_POL =
1171 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1172 EXPORT_SYMBOL(RMF_SELINUX_POL);
1175 * OST request field.
1177 struct req_msg_field RMF_OST_BODY =
1178 DEFINE_MSGF("ost_body", 0,
1179 sizeof(struct ost_body), lustre_swab_ost_body,
1181 EXPORT_SYMBOL(RMF_OST_BODY);
1183 struct req_msg_field RMF_OBD_IOOBJ =
1184 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1185 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1186 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1188 struct req_msg_field RMF_NIOBUF_REMOTE =
1189 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1190 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1192 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1194 struct req_msg_field RMF_NIOBUF_INLINE =
1195 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1196 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1198 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1200 struct req_msg_field RMF_RCS =
1201 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1202 lustre_swab_generic_32s, dump_rcs);
1203 EXPORT_SYMBOL(RMF_RCS);
1205 struct req_msg_field RMF_EAVALS_LENS =
1206 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1207 lustre_swab_generic_32s, NULL);
1208 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1210 struct req_msg_field RMF_OBD_ID =
1211 DEFINE_MSGF("obd_id", 0,
1212 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1213 EXPORT_SYMBOL(RMF_OBD_ID);
1215 struct req_msg_field RMF_FID =
1216 DEFINE_MSGF("fid", 0,
1217 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1218 EXPORT_SYMBOL(RMF_FID);
1220 struct req_msg_field RMF_OST_ID =
1221 DEFINE_MSGF("ost_id", 0,
1222 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1223 EXPORT_SYMBOL(RMF_OST_ID);
1225 struct req_msg_field RMF_FIEMAP_KEY =
1226 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1227 lustre_swab_fiemap_info_key, NULL);
1228 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1230 struct req_msg_field RMF_FIEMAP_VAL =
1231 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1232 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1234 struct req_msg_field RMF_IDX_INFO =
1235 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1236 lustre_swab_idx_info, NULL);
1237 EXPORT_SYMBOL(RMF_IDX_INFO);
1238 struct req_msg_field RMF_SHORT_IO =
1239 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1240 EXPORT_SYMBOL(RMF_SHORT_IO);
1241 struct req_msg_field RMF_HSM_USER_STATE =
1242 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1243 lustre_swab_hsm_user_state, NULL);
1244 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1246 struct req_msg_field RMF_HSM_STATE_SET =
1247 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1248 lustre_swab_hsm_state_set, NULL);
1249 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1251 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1252 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1253 lustre_swab_hsm_progress_kernel, NULL);
1254 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1256 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1257 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1258 lustre_swab_hsm_current_action, NULL);
1259 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1261 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1262 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1263 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1265 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1267 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1268 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1269 sizeof(__u32), lustre_swab_generic_32s, NULL);
1270 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1272 struct req_msg_field RMF_MDS_HSM_REQUEST =
1273 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1274 lustre_swab_hsm_request, NULL);
1275 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1277 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
1278 lustre_swab_object_update_request, NULL);
1279 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1281 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1282 DEFINE_MSGFL("object_update_reply", 0, -1,
1283 lustre_swab_object_update_reply, NULL);
1284 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1286 struct req_msg_field RMF_SWAP_LAYOUTS =
1287 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1288 lustre_swab_swap_layouts, NULL);
1289 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1291 struct req_msg_field RMF_LFSCK_REQUEST =
1292 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1293 lustre_swab_lfsck_request, NULL);
1294 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1296 struct req_msg_field RMF_LFSCK_REPLY =
1297 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1298 lustre_swab_lfsck_reply, NULL);
1299 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1301 struct req_msg_field RMF_OST_LADVISE_HDR =
1302 DEFINE_MSGF("ladvise_request", 0,
1303 sizeof(struct ladvise_hdr),
1304 lustre_swab_ladvise_hdr, NULL);
1305 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1307 struct req_msg_field RMF_OST_LADVISE =
1308 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1309 sizeof(struct lu_ladvise),
1310 lustre_swab_ladvise, NULL);
1311 EXPORT_SYMBOL(RMF_OST_LADVISE);
1313 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1314 -1, lustre_swab_out_update_header, NULL);
1315 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1317 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1318 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1319 lustre_swab_out_update_buffer, NULL);
1320 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1327 const char *rf_name;
1331 const struct req_msg_field **d;
1332 } rf_fields[RCL_NR];
1335 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1349 #define DEFINE_REQ_FMT0(name, client, server) \
1350 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1352 struct req_format RQF_OBD_PING =
1353 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1354 EXPORT_SYMBOL(RQF_OBD_PING);
1356 struct req_format RQF_OBD_SET_INFO =
1357 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1358 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1360 struct req_format RQF_MDT_SET_INFO =
1361 DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1362 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1364 /* Read index file through the network */
1365 struct req_format RQF_OBD_IDX_READ =
1366 DEFINE_REQ_FMT0("OBD_IDX_READ",
1367 obd_idx_read_client, obd_idx_read_server);
1368 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1370 struct req_format RQF_SEC_CTX =
1371 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1372 EXPORT_SYMBOL(RQF_SEC_CTX);
1374 struct req_format RQF_MGS_TARGET_REG =
1375 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1376 mgs_target_info_only);
1377 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1379 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1380 struct req_format RQF_MGS_SET_INFO =
1381 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1383 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1386 struct req_format RQF_MGS_CONFIG_READ =
1387 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1388 mgs_config_read_server);
1389 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1391 struct req_format RQF_SEQ_QUERY =
1392 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1393 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1395 struct req_format RQF_FLD_QUERY =
1396 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1397 EXPORT_SYMBOL(RQF_FLD_QUERY);
1399 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1400 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1401 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1402 * peers need to handle the RPC reply with fixed little-endian format.
1404 * In theory, we can define new structure with some swabber registered to
1405 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1406 * implementation view, it is not easy to be done within current "struct
1407 * req_msg_field" framework. Because the sequence range array in the RPC
1408 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1409 * count, that is unknown when prepare the RPC buffer. Generally, for such
1410 * flexible length RPC usage, there will be a field in the RPC layout to
1411 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1412 * do that unless we add new length filed that will broken the on-wire RPC
1413 * protocol and cause interoperability trouble with old peer. */
1414 struct req_format RQF_FLD_READ =
1415 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1416 EXPORT_SYMBOL(RQF_FLD_READ);
1418 struct req_format RQF_MDS_QUOTACTL =
1419 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1420 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1422 struct req_format RQF_OST_QUOTACTL =
1423 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1424 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1426 struct req_format RQF_QUOTA_DQACQ =
1427 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1428 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1430 struct req_format RQF_LDLM_INTENT_QUOTA =
1431 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1432 ldlm_intent_quota_client,
1433 ldlm_intent_quota_server);
1434 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1436 struct req_format RQF_MDS_GET_ROOT =
1437 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1438 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1440 struct req_format RQF_MDS_STATFS =
1441 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1442 EXPORT_SYMBOL(RQF_MDS_STATFS);
1444 struct req_format RQF_MDS_STATFS_NEW =
1445 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1446 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1448 struct req_format RQF_MDS_SYNC =
1449 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1450 EXPORT_SYMBOL(RQF_MDS_SYNC);
1452 struct req_format RQF_MDS_GETATTR =
1453 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1454 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1456 struct req_format RQF_MDS_GETXATTR =
1457 DEFINE_REQ_FMT0("MDS_GETXATTR",
1458 mds_getxattr_client, mds_getxattr_server);
1459 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1461 struct req_format RQF_MDS_GETATTR_NAME =
1462 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1463 mds_getattr_name_client, mds_getattr_server);
1464 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1466 struct req_format RQF_MDS_REINT =
1467 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1468 EXPORT_SYMBOL(RQF_MDS_REINT);
1470 struct req_format RQF_MDS_REINT_CREATE =
1471 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1472 mds_reint_create_client, mdt_body_capa);
1473 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1475 struct req_format RQF_MDS_REINT_CREATE_ACL =
1476 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1477 mds_reint_create_acl_client, mdt_body_capa);
1478 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1480 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1481 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1482 mds_reint_create_slave_client, mdt_body_capa);
1483 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1485 struct req_format RQF_MDS_REINT_CREATE_SYM =
1486 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1487 mds_reint_create_sym_client, mdt_body_capa);
1488 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1490 struct req_format RQF_MDS_REINT_OPEN =
1491 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1492 mds_reint_open_client, mds_reint_open_server);
1493 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1495 struct req_format RQF_MDS_REINT_UNLINK =
1496 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1497 mds_last_unlink_server);
1498 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1500 struct req_format RQF_MDS_REINT_LINK =
1501 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1502 mds_reint_link_client, mdt_body_only);
1503 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1505 struct req_format RQF_MDS_REINT_RENAME =
1506 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1507 mds_last_unlink_server);
1508 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1510 struct req_format RQF_MDS_REINT_MIGRATE =
1511 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1512 mds_last_unlink_server);
1513 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1515 struct req_format RQF_MDS_REINT_SETATTR =
1516 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1517 mds_reint_setattr_client, mds_setattr_server);
1518 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1520 struct req_format RQF_MDS_REINT_SETXATTR =
1521 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1522 mds_reint_setxattr_client, mdt_body_only);
1523 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1525 struct req_format RQF_MDS_REINT_RESYNC =
1526 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1527 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1529 struct req_format RQF_MDS_CONNECT =
1530 DEFINE_REQ_FMT0("MDS_CONNECT",
1531 obd_connect_client, obd_connect_server);
1532 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1534 struct req_format RQF_MDS_DISCONNECT =
1535 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1536 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1538 struct req_format RQF_MDS_GET_INFO =
1539 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1540 mds_getinfo_server);
1541 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1543 struct req_format RQF_OUT_UPDATE =
1544 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1546 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1548 struct req_format RQF_LDLM_ENQUEUE =
1549 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1550 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1551 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1553 struct req_format RQF_LDLM_ENQUEUE_LVB =
1554 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1555 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1556 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1558 struct req_format RQF_LDLM_CONVERT =
1559 DEFINE_REQ_FMT0("LDLM_CONVERT",
1560 ldlm_enqueue_client, ldlm_enqueue_server);
1561 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1563 struct req_format RQF_LDLM_CANCEL =
1564 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1565 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1567 struct req_format RQF_LDLM_CALLBACK =
1568 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1569 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1571 struct req_format RQF_LDLM_CP_CALLBACK =
1572 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1573 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1575 struct req_format RQF_LDLM_BL_CALLBACK =
1576 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1577 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1579 struct req_format RQF_LDLM_GL_CALLBACK =
1580 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1581 ldlm_gl_callback_server);
1582 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1584 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1585 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1586 ldlm_gl_callback_server);
1587 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1589 struct req_format RQF_LDLM_INTENT_BASIC =
1590 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1591 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1592 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1594 struct req_format RQF_LDLM_INTENT =
1595 DEFINE_REQ_FMT0("LDLM_INTENT",
1596 ldlm_intent_client, ldlm_intent_server);
1597 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1599 struct req_format RQF_LDLM_INTENT_LAYOUT =
1600 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1601 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1602 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1604 struct req_format RQF_LDLM_INTENT_GETATTR =
1605 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1606 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1607 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1609 struct req_format RQF_LDLM_INTENT_OPEN =
1610 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1611 ldlm_intent_open_client, ldlm_intent_open_server);
1612 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1614 struct req_format RQF_LDLM_INTENT_CREATE =
1615 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1616 ldlm_intent_create_client, ldlm_intent_getattr_server);
1617 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1619 struct req_format RQF_LDLM_INTENT_GETXATTR =
1620 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1621 ldlm_intent_getxattr_client,
1622 ldlm_intent_getxattr_server);
1623 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1625 struct req_format RQF_MDS_CLOSE =
1626 DEFINE_REQ_FMT0("MDS_CLOSE",
1627 mdt_close_client, mds_last_unlink_server);
1628 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1630 struct req_format RQF_MDS_CLOSE_INTENT =
1631 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1632 mdt_close_intent_client, mds_last_unlink_server);
1633 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1635 struct req_format RQF_MDS_READPAGE =
1636 DEFINE_REQ_FMT0("MDS_READPAGE",
1637 mdt_body_capa, mdt_body_only);
1638 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1640 struct req_format RQF_MDS_HSM_ACTION =
1641 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1642 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1644 struct req_format RQF_MDS_HSM_PROGRESS =
1645 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1646 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1648 struct req_format RQF_MDS_HSM_CT_REGISTER =
1649 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1650 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1652 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1653 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1654 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1656 struct req_format RQF_MDS_HSM_STATE_GET =
1657 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1658 mdt_body_capa, mdt_hsm_state_get_server);
1659 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1661 struct req_format RQF_MDS_HSM_STATE_SET =
1662 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1663 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1665 struct req_format RQF_MDS_HSM_REQUEST =
1666 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1667 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1669 struct req_format RQF_MDS_SWAP_LAYOUTS =
1670 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1671 mdt_swap_layouts, empty);
1672 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1674 struct req_format RQF_MDS_RMFID =
1675 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1677 EXPORT_SYMBOL(RQF_MDS_RMFID);
1679 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1680 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1681 llog_origin_handle_create_client, llogd_body_only);
1682 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1684 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1685 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1686 llogd_body_only, llog_origin_handle_next_block_server);
1687 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1689 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1690 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1691 llogd_body_only, llog_origin_handle_next_block_server);
1692 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1694 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1695 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1696 llogd_body_only, llog_log_hdr_only);
1697 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1699 struct req_format RQF_CONNECT =
1700 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1701 EXPORT_SYMBOL(RQF_CONNECT);
1703 struct req_format RQF_OST_CONNECT =
1704 DEFINE_REQ_FMT0("OST_CONNECT",
1705 obd_connect_client, obd_connect_server);
1706 EXPORT_SYMBOL(RQF_OST_CONNECT);
1708 struct req_format RQF_OST_DISCONNECT =
1709 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1710 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1712 struct req_format RQF_OST_GETATTR =
1713 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1714 EXPORT_SYMBOL(RQF_OST_GETATTR);
1716 struct req_format RQF_OST_SETATTR =
1717 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1718 EXPORT_SYMBOL(RQF_OST_SETATTR);
1720 struct req_format RQF_OST_CREATE =
1721 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1722 EXPORT_SYMBOL(RQF_OST_CREATE);
1724 struct req_format RQF_OST_PUNCH =
1725 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1726 EXPORT_SYMBOL(RQF_OST_PUNCH);
1728 struct req_format RQF_OST_FALLOCATE =
1729 DEFINE_REQ_FMT0("OST_FALLOCATE", ost_body_capa, ost_body_only);
1730 EXPORT_SYMBOL(RQF_OST_FALLOCATE);
1732 struct req_format RQF_OST_SYNC =
1733 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1734 EXPORT_SYMBOL(RQF_OST_SYNC);
1736 struct req_format RQF_OST_DESTROY =
1737 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1738 EXPORT_SYMBOL(RQF_OST_DESTROY);
1740 struct req_format RQF_OST_BRW_READ =
1741 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1742 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1744 struct req_format RQF_OST_BRW_WRITE =
1745 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1746 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1748 struct req_format RQF_OST_STATFS =
1749 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1750 EXPORT_SYMBOL(RQF_OST_STATFS);
1752 struct req_format RQF_OST_SET_GRANT_INFO =
1753 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1755 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1757 struct req_format RQF_OST_GET_INFO =
1758 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1759 ost_get_info_generic_server);
1760 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1762 struct req_format RQF_OST_GET_INFO_LAST_ID =
1763 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1764 ost_get_last_id_server);
1765 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1767 struct req_format RQF_OST_GET_INFO_LAST_FID =
1768 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1769 ost_get_last_fid_server);
1770 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1772 struct req_format RQF_OST_SET_INFO_LAST_FID =
1773 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1775 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1777 struct req_format RQF_OST_GET_INFO_FIEMAP =
1778 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1779 ost_get_fiemap_server);
1780 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1782 struct req_format RQF_LFSCK_NOTIFY =
1783 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1784 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1786 struct req_format RQF_LFSCK_QUERY =
1787 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1788 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1790 struct req_format RQF_OST_LADVISE =
1791 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1792 EXPORT_SYMBOL(RQF_OST_LADVISE);
1794 /* Convenience macro */
1795 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1798 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1799 * field of RQFs and the \a rmf_offset field of RMFs.
1801 int req_layout_init(void)
1806 struct req_format *rf = NULL;
1808 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1809 rf = req_formats[i];
1811 for (j = 0; j < RCL_NR; ++j) {
1812 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1813 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1814 struct req_msg_field *field;
1816 field = (typeof(field))rf->rf_fields[j].d[k];
1817 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1818 || field->rmf_size > 0);
1819 LASSERT(field->rmf_offset[i][j] == 0);
1821 * k + 1 to detect unused format/field
1824 field->rmf_offset[i][j] = k + 1;
1830 EXPORT_SYMBOL(req_layout_init);
1832 void req_layout_fini(void)
1835 EXPORT_SYMBOL(req_layout_fini);
1838 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1840 * Actual/expected field sizes are set elsewhere in functions in this file:
1841 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1842 * req_capsule_msg_size(). The \a rc_area information is used by.
1843 * ptlrpc_request_set_replen().
1845 void req_capsule_init_area(struct req_capsule *pill)
1849 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1850 pill->rc_area[RCL_CLIENT][i] = -1;
1851 pill->rc_area[RCL_SERVER][i] = -1;
1854 EXPORT_SYMBOL(req_capsule_init_area);
1857 * Initialize a pill.
1859 * The \a location indicates whether the caller is executing on the client side
1860 * (RCL_CLIENT) or server side (RCL_SERVER)..
1862 void req_capsule_init(struct req_capsule *pill,
1863 struct ptlrpc_request *req,
1864 enum req_location location)
1866 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1869 * Today all capsules are embedded in ptlrpc_request structs,
1870 * but just in case that ever isn't the case, we don't reach
1871 * into req unless req != NULL and pill is the one embedded in
1874 * The req->rq_pill_init flag makes it safe to initialize a pill
1875 * twice, which might happen in the OST paths as a result of the
1876 * high-priority RPC queue getting peeked at before ost_handle()
1877 * handles an OST RPC.
1879 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1882 memset(pill, 0, sizeof *pill);
1884 pill->rc_loc = location;
1885 req_capsule_init_area(pill);
1887 if (req != NULL && pill == &req->rq_pill)
1888 req->rq_pill_init = 1;
1890 EXPORT_SYMBOL(req_capsule_init);
1892 void req_capsule_fini(struct req_capsule *pill)
1895 EXPORT_SYMBOL(req_capsule_fini);
1897 static int __req_format_is_sane(const struct req_format *fmt)
1899 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1900 req_formats[fmt->rf_idx] == fmt;
1903 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1904 enum req_location loc)
1906 struct ptlrpc_request *req;
1909 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1913 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1914 * (see req_capsule_extend()).
1916 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1918 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1919 LASSERT(__req_format_is_sane(fmt));
1923 EXPORT_SYMBOL(req_capsule_set);
1926 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1929 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1930 * variable-sized fields. The field sizes come from the declared \a rmf_size
1931 * field of a \a pill's \a rc_fmt's RMF's.
1933 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1934 enum req_location loc)
1936 const struct req_format *fmt = pill->rc_fmt;
1939 LASSERT(fmt != NULL);
1941 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1942 if (pill->rc_area[loc][i] == -1) {
1943 pill->rc_area[loc][i] =
1944 fmt->rf_fields[loc].d[i]->rmf_size;
1945 if (pill->rc_area[loc][i] == -1) {
1947 * Skip the following fields.
1949 * If this LASSERT() trips then you're missing a
1950 * call to req_capsule_set_size().
1952 LASSERT(loc != RCL_SERVER);
1959 EXPORT_SYMBOL(req_capsule_filled_sizes);
1962 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1964 * This function uses the \a pill's \a rc_area as filled in by
1965 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1968 int req_capsule_server_pack(struct req_capsule *pill)
1970 const struct req_format *fmt;
1974 LASSERT(pill->rc_loc == RCL_SERVER);
1976 LASSERT(fmt != NULL);
1978 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1979 rc = lustre_pack_reply(pill->rc_req, count,
1980 pill->rc_area[RCL_SERVER], NULL);
1982 DEBUG_REQ(D_ERROR, pill->rc_req,
1983 "Cannot pack %d fields in format '%s'",
1984 count, fmt->rf_name);
1988 EXPORT_SYMBOL(req_capsule_server_pack);
1991 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1992 * corresponding to the given RMF (\a field).
1994 __u32 __req_capsule_offset(const struct req_capsule *pill,
1995 const struct req_msg_field *field,
1996 enum req_location loc)
1998 unsigned int offset;
2000 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2001 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
2002 pill->rc_fmt->rf_name,
2003 field->rmf_name, offset, loc);
2006 LASSERT(offset < REQ_MAX_FIELD_NR);
2011 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
2015 swabber_dumper_helper(struct req_capsule *pill,
2016 const struct req_msg_field *field,
2017 enum req_location loc,
2019 void *value, int len, bool dump, void (*swabber)(void *))
2027 bool inout = loc == RCL_CLIENT;
2028 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2030 swabber = swabber ?: field->rmf_swabber;
2032 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
2033 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2038 if (!field->rmf_dumper)
2042 * We're swabbing an array; swabber() swabs a single array element, so
2043 * swab every element.
2045 if (array && (len % field->rmf_size)) {
2046 static const struct req_msg_field *last_field;
2048 if (field != last_field) {
2049 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2050 field->rmf_name, len, field->rmf_size);
2054 /* For the non-array cases, the process of swab/dump/swab only
2055 * needs to be done once. (n = 1)
2058 len = field->rmf_size;
2059 for (p = value, i = 0, n = len / field->rmf_size;
2061 i++, p += field->rmf_size) {
2063 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2064 do_swab ? "unswabbed " : "",
2065 array ? "array " : "",
2066 field->rmf_name, i);
2067 field->rmf_dumper(p);
2075 if (!field->rmf_swab_len) {
2078 size = field->rmf_swab_len(p, len);
2087 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2088 array ? "array " : "", field->rmf_name, i);
2089 field->rmf_dumper(value);
2093 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2099 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2100 * corresponding to the given RMF (\a field).
2102 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2103 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2104 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2105 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2106 * element of the array swabbed.
2108 static void *__req_capsule_get(struct req_capsule *pill,
2109 const struct req_msg_field *field,
2110 enum req_location loc,
2111 void (*swabber)(void *),
2114 const struct req_format *fmt;
2115 struct lustre_msg *msg;
2120 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2122 static const char *rcl_names[RCL_NR] = {
2123 [RCL_CLIENT] = "client",
2124 [RCL_SERVER] = "server"
2127 LASSERT(pill != NULL);
2128 LASSERT(pill != LP_POISON);
2130 LASSERT(fmt != NULL);
2131 LASSERT(fmt != LP_POISON);
2132 LASSERT(__req_format_is_sane(fmt));
2134 offset = __req_capsule_offset(pill, field, loc);
2136 msg = __req_msg(pill, loc);
2137 LASSERT(msg != NULL);
2139 getter = (field->rmf_flags & RMF_F_STRING) ?
2140 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2142 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2144 * We've already asserted that field->rmf_size > 0 in
2145 * req_layout_init().
2147 len = lustre_msg_buflen(msg, offset);
2148 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2149 (len % field->rmf_size) != 0) {
2150 CERROR("%s: array field size mismatch "
2151 "%d modulo %u != 0 (%d)\n",
2152 field->rmf_name, len, field->rmf_size, loc);
2155 } else if (pill->rc_area[loc][offset] != -1) {
2156 len = pill->rc_area[loc][offset];
2158 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2160 value = getter(msg, offset, len);
2162 if (value == NULL) {
2163 DEBUG_REQ(D_ERROR, pill->rc_req,
2164 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2165 field->rmf_name, offset, lustre_msg_bufcount(msg),
2166 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2169 swabber_dumper_helper(pill, field, loc, offset, value, len,
2177 * Dump a request and/or reply
2179 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2181 const struct req_format *fmt;
2182 const struct req_msg_field *field;
2188 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2189 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2190 field = FMT_FIELD(fmt, loc, i);
2191 if (field->rmf_dumper == NULL) {
2193 * FIXME Add a default hex dumper for fields that don't
2194 * have a specific dumper
2196 len = req_capsule_get_size(pill, field, loc);
2198 "Field %s has no dumper function; field size is %u\n",
2199 field->rmf_name, len);
2201 /* It's dumping side-effect that we're interested in */
2202 (void) __req_capsule_get(pill, field, loc, NULL, true);
2205 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2211 void req_capsule_client_dump(struct req_capsule *pill)
2213 __req_capsule_dump(pill, RCL_CLIENT);
2215 EXPORT_SYMBOL(req_capsule_client_dump);
2220 void req_capsule_server_dump(struct req_capsule *pill)
2222 __req_capsule_dump(pill, RCL_SERVER);
2224 EXPORT_SYMBOL(req_capsule_server_dump);
2227 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2228 * buffer corresponding to the given RMF (\a field) of a \a pill.
2230 void *req_capsule_client_get(struct req_capsule *pill,
2231 const struct req_msg_field *field)
2233 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2235 EXPORT_SYMBOL(req_capsule_client_get);
2238 * Same as req_capsule_client_get(), but with a \a swabber argument.
2240 * Currently unused; will be removed when req_capsule_server_swab_get() is
2243 void *req_capsule_client_swab_get(struct req_capsule *pill,
2244 const struct req_msg_field *field,
2247 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2249 EXPORT_SYMBOL(req_capsule_client_swab_get);
2252 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2254 * First the \a pill's request \a field's size is set (\a rc_area) using
2255 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2258 void *req_capsule_client_sized_get(struct req_capsule *pill,
2259 const struct req_msg_field *field,
2262 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2263 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2265 EXPORT_SYMBOL(req_capsule_client_sized_get);
2268 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2269 * buffer corresponding to the given RMF (\a field) of a \a pill.
2271 void *req_capsule_server_get(struct req_capsule *pill,
2272 const struct req_msg_field *field)
2274 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2276 EXPORT_SYMBOL(req_capsule_server_get);
2279 * Same as req_capsule_server_get(), but with a \a swabber argument.
2281 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2282 * swabbing done outside this capsule abstraction.
2284 void *req_capsule_server_swab_get(struct req_capsule *pill,
2285 const struct req_msg_field *field,
2288 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2290 EXPORT_SYMBOL(req_capsule_server_swab_get);
2293 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2295 * First the \a pill's request \a field's size is set (\a rc_area) using
2296 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2299 void *req_capsule_server_sized_get(struct req_capsule *pill,
2300 const struct req_msg_field *field,
2303 req_capsule_set_size(pill, field, RCL_SERVER, len);
2304 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2306 EXPORT_SYMBOL(req_capsule_server_sized_get);
2308 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2309 const struct req_msg_field *field,
2310 __u32 len, void *swabber)
2312 req_capsule_set_size(pill, field, RCL_SERVER, len);
2313 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2315 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2318 * Returns the buffer of a \a pill corresponding to the given \a field from the
2319 * request (if the caller is executing on the server-side) or reply (if the
2320 * caller is executing on the client-side).
2322 * This function convienient for use is code that could be executed on the
2323 * client and server alike.
2325 const void *req_capsule_other_get(struct req_capsule *pill,
2326 const struct req_msg_field *field)
2328 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2330 EXPORT_SYMBOL(req_capsule_other_get);
2333 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2334 * field of the given \a pill.
2336 * This function must be used when constructing variable sized fields of a
2339 void req_capsule_set_size(struct req_capsule *pill,
2340 const struct req_msg_field *field,
2341 enum req_location loc, __u32 size)
2343 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2345 if ((size != (__u32)field->rmf_size) &&
2346 (field->rmf_size != -1) &&
2347 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2349 __u32 rmf_size = (__u32)field->rmf_size;
2350 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2351 (size % rmf_size != 0)) {
2352 CERROR("%s: array field size mismatch "
2353 "%u %% %u != 0 (%d)\n",
2354 field->rmf_name, size, rmf_size, loc);
2356 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2358 CERROR("%s: field size mismatch %u != %u (%d)\n",
2359 field->rmf_name, size, rmf_size, loc);
2364 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2366 EXPORT_SYMBOL(req_capsule_set_size);
2369 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2370 * for the given \a pill's given \a field.
2372 * NB: this function doesn't correspond with req_capsule_set_size(), which
2373 * actually sets the size in pill.rc_area[loc][offset], but this function
2374 * returns the message buflen[offset], maybe we should use another name.
2376 __u32 req_capsule_get_size(const struct req_capsule *pill,
2377 const struct req_msg_field *field,
2378 enum req_location loc)
2380 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2382 return lustre_msg_buflen(__req_msg(pill, loc),
2383 __req_capsule_offset(pill, field, loc));
2385 EXPORT_SYMBOL(req_capsule_get_size);
2388 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2389 * given \a pill's request or reply (\a loc) given the field size recorded in
2390 * the \a pill's rc_area.
2392 * See also req_capsule_set_size().
2394 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2396 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2397 pill->rc_fmt->rf_fields[loc].nr,
2398 pill->rc_area[loc]);
2402 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2403 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2404 * PTLRPC request or reply given only an RQF (\a fmt).
2406 * This function should not be used for formats which contain variable size
2409 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2410 enum req_location loc)
2416 * This function should probably LASSERT() that fmt has no fields with
2417 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2418 * elements in the array there will ultimately be, but then, we could
2419 * assume that there will be at least one element, and that's just what
2422 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2426 for (; i < fmt->rf_fields[loc].nr; ++i)
2427 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2428 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2432 EXPORT_SYMBOL(req_capsule_fmt_size);
2435 * Changes the format of an RPC.
2437 * The pill must already have been initialized, which means that it already has
2438 * a request format. The new format \a fmt must be an extension of the pill's
2439 * old format. Specifically: the new format must have as many request and reply
2440 * fields as the old one, and all fields shared by the old and new format must
2441 * be at least as large in the new format.
2443 * The new format's fields may be of different "type" than the old format, but
2444 * only for fields that are "opaque" blobs: fields which have a) have no
2445 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2446 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2447 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2448 * according to the key field. When the value, according to the key, contains a
2449 * structure (or array thereof) to be swabbed, the format should be changed to
2450 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2453 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2458 const struct req_format *old;
2460 LASSERT(pill->rc_fmt != NULL);
2461 LASSERT(__req_format_is_sane(fmt));
2465 * Sanity checking...
2467 for (i = 0; i < RCL_NR; ++i) {
2468 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2469 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2470 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2472 /* "opaque" fields can be transmogrified */
2473 if (ofield->rmf_swabber == NULL &&
2474 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2475 (ofield->rmf_size == -1 ||
2476 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2478 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2481 * Last field in old format can be shorter than in new.
2483 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2484 FMT_FIELD(old, i, j)->rmf_size);
2489 EXPORT_SYMBOL(req_capsule_extend);
2492 * This function returns a non-zero value if the given \a field is present in
2493 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2496 int req_capsule_has_field(const struct req_capsule *pill,
2497 const struct req_msg_field *field,
2498 enum req_location loc)
2500 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2502 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2504 EXPORT_SYMBOL(req_capsule_has_field);
2507 * Returns a non-zero value if the given \a field is present in the given \a
2508 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2510 int req_capsule_field_present(const struct req_capsule *pill,
2511 const struct req_msg_field *field,
2512 enum req_location loc)
2516 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2517 LASSERT(req_capsule_has_field(pill, field, loc));
2519 offset = __req_capsule_offset(pill, field, loc);
2520 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2522 EXPORT_SYMBOL(req_capsule_field_present);
2525 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2526 * request or reply (\a loc).
2528 * This is not the opposite of req_capsule_extend().
2530 void req_capsule_shrink(struct req_capsule *pill,
2531 const struct req_msg_field *field,
2533 enum req_location loc)
2535 const struct req_format *fmt;
2536 struct lustre_msg *msg;
2541 LASSERT(fmt != NULL);
2542 LASSERT(__req_format_is_sane(fmt));
2543 LASSERT(req_capsule_has_field(pill, field, loc));
2544 LASSERT(req_capsule_field_present(pill, field, loc));
2546 offset = __req_capsule_offset(pill, field, loc);
2548 msg = __req_msg(pill, loc);
2549 len = lustre_msg_buflen(msg, offset);
2550 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2551 fmt->rf_name, field->rmf_name, len, newlen);
2553 if (loc == RCL_CLIENT) {
2554 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2557 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2559 /* update also field size in reply lenghts arrays for possible
2560 * reply re-pack due to req_capsule_server_grow() call.
2562 req_capsule_set_size(pill, field, loc, newlen);
2565 EXPORT_SYMBOL(req_capsule_shrink);
2567 int req_capsule_server_grow(struct req_capsule *pill,
2568 const struct req_msg_field *field,
2571 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2576 LASSERT(pill->rc_fmt != NULL);
2577 LASSERT(__req_format_is_sane(pill->rc_fmt));
2578 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2579 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2581 len = req_capsule_get_size(pill, field, RCL_SERVER);
2582 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2584 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2585 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2588 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2590 * There can be enough space in current reply buffer, make sure
2591 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2592 * re-packing is still needed.
2594 if (rs->rs_msg == rs->rs_repbuf &&
2595 rs->rs_repbuf_len >=
2596 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2597 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2602 /* Re-allocate replay state */
2603 pill->rc_req->rq_reply_state = NULL;
2604 rc = req_capsule_server_pack(pill);
2606 /* put old values back, the caller should decide what to do */
2607 req_capsule_set_size(pill, field, RCL_SERVER, len);
2608 pill->rc_req->rq_reply_state = rs;
2611 nrs = pill->rc_req->rq_reply_state;
2612 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2613 lustre_packed_msg_size(rs->rs_msg));
2615 /* Now we need only buffers, copy them and grow the needed one */
2616 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2617 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2618 len = (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from;
2619 memcpy(to, from, len);
2620 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2622 if (rs->rs_difficult) {
2626 nrs->rs_difficult = 1;
2627 nrs->rs_no_ack = rs->rs_no_ack;
2628 nrs->rs_convert_lock = rs->rs_convert_lock;
2629 for (i = 0; i < rs->rs_nlocks; i++) {
2630 nrs->rs_locks[i] = rs->rs_locks[i];
2631 nrs->rs_modes[i] = rs->rs_modes[i];
2635 rs->rs_difficult = 0;
2638 ptlrpc_rs_decref(rs);
2641 EXPORT_SYMBOL(req_capsule_server_grow);
2643 int req_check_sepol(struct req_capsule *pill)
2646 #ifdef HAVE_SERVER_SUPPORT
2647 struct obd_export *export;
2648 struct lu_nodemap *nm = NULL;
2649 const char *sepol = NULL;
2650 const char *nm_sepol = NULL;
2655 export = pill->rc_req->rq_export;
2656 if (!export || !exp_connect_sepol(export) ||
2657 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2660 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2663 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2664 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2668 nm = nodemap_get_from_exp(export);
2669 if (!IS_ERR_OR_NULL(nm)) {
2670 nm_sepol = nodemap_get_sepol(nm);
2671 if (nm_sepol && nm_sepol[0])
2672 if (sepol == NULL ||
2673 strcmp(sepol, nm_sepol) != 0)
2678 if (!IS_ERR_OR_NULL(nm))
2684 EXPORT_SYMBOL(req_check_sepol);