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,
825 &RQF_OST_SET_GRANT_INFO,
827 &RQF_OST_GET_INFO_LAST_ID,
828 &RQF_OST_GET_INFO_LAST_FID,
829 &RQF_OST_SET_INFO_LAST_FID,
830 &RQF_OST_GET_INFO_FIEMAP,
833 &RQF_LDLM_ENQUEUE_LVB,
837 &RQF_LDLM_CP_CALLBACK,
838 &RQF_LDLM_BL_CALLBACK,
839 &RQF_LDLM_GL_CALLBACK,
840 &RQF_LDLM_GL_CALLBACK_DESC,
842 &RQF_LDLM_INTENT_BASIC,
843 &RQF_LDLM_INTENT_LAYOUT,
844 &RQF_LDLM_INTENT_GETATTR,
845 &RQF_LDLM_INTENT_OPEN,
846 &RQF_LDLM_INTENT_CREATE,
847 &RQF_LDLM_INTENT_GETXATTR,
848 &RQF_LDLM_INTENT_QUOTA,
850 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
851 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
852 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
853 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
859 struct req_msg_field {
860 const __u32 rmf_flags;
861 const char *rmf_name;
863 * Field length. (-1) means "variable length". If the
864 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
865 * but the actual size must be a whole multiple of \a rmf_size.
868 void (*rmf_swabber)(void *);
870 * Pass buffer size to swabbing function
871 * \retval > 0 the number of bytes swabbed
872 * -EOVERFLOW on error
874 int (*rmf_swab_len)(void *, __u32);
875 void (*rmf_dumper)(void *);
876 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
881 * The field is a string, must be NUL-terminated.
883 RMF_F_STRING = 1 << 0,
885 * The field's buffer size need not match the declared \a rmf_size.
887 RMF_F_NO_SIZE_CHECK = 1 << 1,
889 * The field's buffer size must be a whole multiple of the declared \a
890 * rmf_size and the \a rmf_swabber function must work on the declared \a
891 * rmf_size worth of bytes.
893 RMF_F_STRUCT_ARRAY = 1 << 2
901 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
902 .rmf_name = (name), \
903 .rmf_flags = (flags), \
904 .rmf_size = (size), \
905 .rmf_swabber = (void (*)(void*))(swabber), \
906 .rmf_dumper = (void (*)(void*))(dumper) \
909 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
910 .rmf_name = (name), \
911 .rmf_flags = (flags), \
912 .rmf_size = (size), \
913 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
914 .rmf_dumper = (void (*)(void *))(dumper) \
917 struct req_msg_field RMF_GENERIC_DATA =
918 DEFINE_MSGF("generic_data", 0,
920 EXPORT_SYMBOL(RMF_GENERIC_DATA);
922 struct req_msg_field RMF_MGS_TARGET_INFO =
923 DEFINE_MSGF("mgs_target_info", 0,
924 sizeof(struct mgs_target_info),
925 lustre_swab_mgs_target_info, NULL);
926 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
928 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
929 struct req_msg_field RMF_MGS_SEND_PARAM =
930 DEFINE_MSGF("mgs_send_param", 0,
931 sizeof(struct mgs_send_param),
933 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
936 struct req_msg_field RMF_MGS_CONFIG_BODY =
937 DEFINE_MSGF("mgs_config_read request", 0,
938 sizeof(struct mgs_config_body),
939 lustre_swab_mgs_config_body, NULL);
940 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
942 struct req_msg_field RMF_MGS_CONFIG_RES =
943 DEFINE_MSGF("mgs_config_read reply ", 0,
944 sizeof(struct mgs_config_res),
945 lustre_swab_mgs_config_res, NULL);
946 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
948 struct req_msg_field RMF_U32 =
949 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
950 sizeof(__u32), lustre_swab_generic_32s, NULL);
951 EXPORT_SYMBOL(RMF_U32);
953 struct req_msg_field RMF_SETINFO_VAL =
954 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
955 EXPORT_SYMBOL(RMF_SETINFO_VAL);
957 struct req_msg_field RMF_GETINFO_KEY =
958 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
959 EXPORT_SYMBOL(RMF_GETINFO_KEY);
961 struct req_msg_field RMF_GETINFO_VALLEN =
962 DEFINE_MSGF("getinfo_vallen", 0,
963 sizeof(__u32), lustre_swab_generic_32s, NULL);
964 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
966 struct req_msg_field RMF_GETINFO_VAL =
967 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
968 EXPORT_SYMBOL(RMF_GETINFO_VAL);
970 struct req_msg_field RMF_SEQ_OPC =
971 DEFINE_MSGF("seq_query_opc", 0,
972 sizeof(__u32), lustre_swab_generic_32s, NULL);
973 EXPORT_SYMBOL(RMF_SEQ_OPC);
975 struct req_msg_field RMF_SEQ_RANGE =
976 DEFINE_MSGF("seq_query_range", 0,
977 sizeof(struct lu_seq_range),
978 lustre_swab_lu_seq_range, NULL);
979 EXPORT_SYMBOL(RMF_SEQ_RANGE);
981 struct req_msg_field RMF_FLD_OPC =
982 DEFINE_MSGF("fld_query_opc", 0,
983 sizeof(__u32), lustre_swab_generic_32s, NULL);
984 EXPORT_SYMBOL(RMF_FLD_OPC);
986 struct req_msg_field RMF_FLD_MDFLD =
987 DEFINE_MSGF("fld_query_mdfld", 0,
988 sizeof(struct lu_seq_range),
989 lustre_swab_lu_seq_range, NULL);
990 EXPORT_SYMBOL(RMF_FLD_MDFLD);
992 struct req_msg_field RMF_MDT_BODY =
993 DEFINE_MSGF("mdt_body", 0,
994 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
995 EXPORT_SYMBOL(RMF_MDT_BODY);
997 struct req_msg_field RMF_OBD_QUOTACTL =
998 DEFINE_MSGF("obd_quotactl", 0,
999 sizeof(struct obd_quotactl),
1000 lustre_swab_obd_quotactl, NULL);
1001 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
1003 struct req_msg_field RMF_QUOTA_BODY =
1004 DEFINE_MSGF("quota_body", 0,
1005 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
1006 EXPORT_SYMBOL(RMF_QUOTA_BODY);
1008 struct req_msg_field RMF_MDT_EPOCH =
1009 DEFINE_MSGF("mdt_ioepoch", 0,
1010 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
1011 EXPORT_SYMBOL(RMF_MDT_EPOCH);
1013 struct req_msg_field RMF_PTLRPC_BODY =
1014 DEFINE_MSGF("ptlrpc_body", 0,
1015 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
1016 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
1018 struct req_msg_field RMF_CLOSE_DATA =
1019 DEFINE_MSGF("data_version", 0,
1020 sizeof(struct close_data), lustre_swab_close_data, NULL);
1021 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1023 struct req_msg_field RMF_OBD_STATFS =
1024 DEFINE_MSGF("obd_statfs", 0,
1025 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1026 EXPORT_SYMBOL(RMF_OBD_STATFS);
1028 struct req_msg_field RMF_SETINFO_KEY =
1029 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1030 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1032 struct req_msg_field RMF_NAME =
1033 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1034 EXPORT_SYMBOL(RMF_NAME);
1036 struct req_msg_field RMF_FID_ARRAY =
1037 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1038 EXPORT_SYMBOL(RMF_FID_ARRAY);
1040 struct req_msg_field RMF_SYMTGT =
1041 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
1042 EXPORT_SYMBOL(RMF_SYMTGT);
1044 struct req_msg_field RMF_TGTUUID =
1045 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1047 EXPORT_SYMBOL(RMF_TGTUUID);
1049 struct req_msg_field RMF_CLUUID =
1050 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1052 EXPORT_SYMBOL(RMF_CLUUID);
1054 struct req_msg_field RMF_STRING =
1055 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1056 EXPORT_SYMBOL(RMF_STRING);
1058 struct req_msg_field RMF_FILE_SECCTX_NAME =
1059 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1060 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1062 struct req_msg_field RMF_FILE_SECCTX =
1063 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1066 struct req_msg_field RMF_LLOGD_BODY =
1067 DEFINE_MSGF("llogd_body", 0,
1068 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1069 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1071 struct req_msg_field RMF_LLOG_LOG_HDR =
1072 DEFINE_MSGF("llog_log_hdr", 0,
1073 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1074 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1076 struct req_msg_field RMF_LLOGD_CONN_BODY =
1077 DEFINE_MSGF("llogd_conn_body", 0,
1078 sizeof(struct llogd_conn_body),
1079 lustre_swab_llogd_conn_body, NULL);
1080 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1083 * connection handle received in MDS_CONNECT request.
1085 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1086 * that the client does not interpret at all.
1088 struct req_msg_field RMF_CONN =
1089 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1090 EXPORT_SYMBOL(RMF_CONN);
1092 struct req_msg_field RMF_CONNECT_DATA =
1093 DEFINE_MSGF("cdata",
1094 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1095 sizeof(struct obd_connect_data),
1096 lustre_swab_connect, NULL);
1097 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1099 struct req_msg_field RMF_DLM_REQ =
1100 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1101 sizeof(struct ldlm_request),
1102 lustre_swab_ldlm_request, NULL);
1103 EXPORT_SYMBOL(RMF_DLM_REQ);
1105 struct req_msg_field RMF_DLM_REP =
1106 DEFINE_MSGF("dlm_rep", 0,
1107 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1108 EXPORT_SYMBOL(RMF_DLM_REP);
1110 struct req_msg_field RMF_LDLM_INTENT =
1111 DEFINE_MSGF("ldlm_intent", 0,
1112 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1113 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1115 struct req_msg_field RMF_DLM_LVB =
1116 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1117 EXPORT_SYMBOL(RMF_DLM_LVB);
1119 struct req_msg_field RMF_DLM_GL_DESC =
1120 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1121 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1123 struct req_msg_field RMF_MDT_MD =
1124 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1125 EXPORT_SYMBOL(RMF_MDT_MD);
1127 struct req_msg_field RMF_DEFAULT_MDT_MD =
1128 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1130 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1132 struct req_msg_field RMF_REC_REINT =
1133 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1134 lustre_swab_mdt_rec_reint, NULL);
1135 EXPORT_SYMBOL(RMF_REC_REINT);
1137 /* FIXME: this length should be defined as a macro */
1138 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1140 EXPORT_SYMBOL(RMF_EADATA);
1142 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1143 EXPORT_SYMBOL(RMF_EAVALS);
1145 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1146 EXPORT_SYMBOL(RMF_ACL);
1148 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1149 struct req_msg_field RMF_LOGCOOKIES =
1150 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1151 sizeof(struct llog_cookie), NULL, NULL);
1152 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1154 struct req_msg_field RMF_CAPA1 =
1155 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1156 EXPORT_SYMBOL(RMF_CAPA1);
1158 struct req_msg_field RMF_CAPA2 =
1159 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1160 EXPORT_SYMBOL(RMF_CAPA2);
1162 struct req_msg_field RMF_LAYOUT_INTENT =
1163 DEFINE_MSGF("layout_intent", 0,
1164 sizeof(struct layout_intent), lustre_swab_layout_intent,
1166 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1168 struct req_msg_field RMF_SELINUX_POL =
1169 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1170 EXPORT_SYMBOL(RMF_SELINUX_POL);
1173 * OST request field.
1175 struct req_msg_field RMF_OST_BODY =
1176 DEFINE_MSGF("ost_body", 0,
1177 sizeof(struct ost_body), lustre_swab_ost_body,
1179 EXPORT_SYMBOL(RMF_OST_BODY);
1181 struct req_msg_field RMF_OBD_IOOBJ =
1182 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1183 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1184 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1186 struct req_msg_field RMF_NIOBUF_REMOTE =
1187 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1188 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1190 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1192 struct req_msg_field RMF_NIOBUF_INLINE =
1193 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1194 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1196 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1198 struct req_msg_field RMF_RCS =
1199 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1200 lustre_swab_generic_32s, dump_rcs);
1201 EXPORT_SYMBOL(RMF_RCS);
1203 struct req_msg_field RMF_EAVALS_LENS =
1204 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1205 lustre_swab_generic_32s, NULL);
1206 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1208 struct req_msg_field RMF_OBD_ID =
1209 DEFINE_MSGF("obd_id", 0,
1210 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1211 EXPORT_SYMBOL(RMF_OBD_ID);
1213 struct req_msg_field RMF_FID =
1214 DEFINE_MSGF("fid", 0,
1215 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1216 EXPORT_SYMBOL(RMF_FID);
1218 struct req_msg_field RMF_OST_ID =
1219 DEFINE_MSGF("ost_id", 0,
1220 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1221 EXPORT_SYMBOL(RMF_OST_ID);
1223 struct req_msg_field RMF_FIEMAP_KEY =
1224 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1225 lustre_swab_fiemap_info_key, NULL);
1226 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1228 struct req_msg_field RMF_FIEMAP_VAL =
1229 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1230 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1232 struct req_msg_field RMF_IDX_INFO =
1233 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1234 lustre_swab_idx_info, NULL);
1235 EXPORT_SYMBOL(RMF_IDX_INFO);
1236 struct req_msg_field RMF_SHORT_IO =
1237 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1238 EXPORT_SYMBOL(RMF_SHORT_IO);
1239 struct req_msg_field RMF_HSM_USER_STATE =
1240 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1241 lustre_swab_hsm_user_state, NULL);
1242 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1244 struct req_msg_field RMF_HSM_STATE_SET =
1245 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1246 lustre_swab_hsm_state_set, NULL);
1247 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1249 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1250 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1251 lustre_swab_hsm_progress_kernel, NULL);
1252 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1254 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1255 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1256 lustre_swab_hsm_current_action, NULL);
1257 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1259 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1260 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1261 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1263 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1265 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1266 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1267 sizeof(__u32), lustre_swab_generic_32s, NULL);
1268 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1270 struct req_msg_field RMF_MDS_HSM_REQUEST =
1271 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1272 lustre_swab_hsm_request, NULL);
1273 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1275 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
1276 lustre_swab_object_update_request, NULL);
1277 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1279 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1280 DEFINE_MSGFL("object_update_reply", 0, -1,
1281 lustre_swab_object_update_reply, NULL);
1282 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1284 struct req_msg_field RMF_SWAP_LAYOUTS =
1285 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1286 lustre_swab_swap_layouts, NULL);
1287 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1289 struct req_msg_field RMF_LFSCK_REQUEST =
1290 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1291 lustre_swab_lfsck_request, NULL);
1292 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1294 struct req_msg_field RMF_LFSCK_REPLY =
1295 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1296 lustre_swab_lfsck_reply, NULL);
1297 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1299 struct req_msg_field RMF_OST_LADVISE_HDR =
1300 DEFINE_MSGF("ladvise_request", 0,
1301 sizeof(struct ladvise_hdr),
1302 lustre_swab_ladvise_hdr, NULL);
1303 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1305 struct req_msg_field RMF_OST_LADVISE =
1306 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1307 sizeof(struct lu_ladvise),
1308 lustre_swab_ladvise, NULL);
1309 EXPORT_SYMBOL(RMF_OST_LADVISE);
1311 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1312 -1, lustre_swab_out_update_header, NULL);
1313 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1315 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1316 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1317 lustre_swab_out_update_buffer, NULL);
1318 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1325 const char *rf_name;
1329 const struct req_msg_field **d;
1330 } rf_fields[RCL_NR];
1333 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1347 #define DEFINE_REQ_FMT0(name, client, server) \
1348 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1350 struct req_format RQF_OBD_PING =
1351 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1352 EXPORT_SYMBOL(RQF_OBD_PING);
1354 struct req_format RQF_OBD_SET_INFO =
1355 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1356 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1358 struct req_format RQF_MDT_SET_INFO =
1359 DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1360 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1362 /* Read index file through the network */
1363 struct req_format RQF_OBD_IDX_READ =
1364 DEFINE_REQ_FMT0("OBD_IDX_READ",
1365 obd_idx_read_client, obd_idx_read_server);
1366 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1368 struct req_format RQF_SEC_CTX =
1369 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1370 EXPORT_SYMBOL(RQF_SEC_CTX);
1372 struct req_format RQF_MGS_TARGET_REG =
1373 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1374 mgs_target_info_only);
1375 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1377 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1378 struct req_format RQF_MGS_SET_INFO =
1379 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1381 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1384 struct req_format RQF_MGS_CONFIG_READ =
1385 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1386 mgs_config_read_server);
1387 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1389 struct req_format RQF_SEQ_QUERY =
1390 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1391 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1393 struct req_format RQF_FLD_QUERY =
1394 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1395 EXPORT_SYMBOL(RQF_FLD_QUERY);
1397 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1398 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1399 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1400 * peers need to handle the RPC reply with fixed little-endian format.
1402 * In theory, we can define new structure with some swabber registered to
1403 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1404 * implementation view, it is not easy to be done within current "struct
1405 * req_msg_field" framework. Because the sequence range array in the RPC
1406 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1407 * count, that is unknown when prepare the RPC buffer. Generally, for such
1408 * flexible length RPC usage, there will be a field in the RPC layout to
1409 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1410 * do that unless we add new length filed that will broken the on-wire RPC
1411 * protocol and cause interoperability trouble with old peer. */
1412 struct req_format RQF_FLD_READ =
1413 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1414 EXPORT_SYMBOL(RQF_FLD_READ);
1416 struct req_format RQF_MDS_QUOTACTL =
1417 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1418 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1420 struct req_format RQF_OST_QUOTACTL =
1421 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1422 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1424 struct req_format RQF_QUOTA_DQACQ =
1425 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1426 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1428 struct req_format RQF_LDLM_INTENT_QUOTA =
1429 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1430 ldlm_intent_quota_client,
1431 ldlm_intent_quota_server);
1432 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1434 struct req_format RQF_MDS_GET_ROOT =
1435 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1436 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1438 struct req_format RQF_MDS_STATFS =
1439 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1440 EXPORT_SYMBOL(RQF_MDS_STATFS);
1442 struct req_format RQF_MDS_STATFS_NEW =
1443 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1444 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1446 struct req_format RQF_MDS_SYNC =
1447 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1448 EXPORT_SYMBOL(RQF_MDS_SYNC);
1450 struct req_format RQF_MDS_GETATTR =
1451 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1452 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1454 struct req_format RQF_MDS_GETXATTR =
1455 DEFINE_REQ_FMT0("MDS_GETXATTR",
1456 mds_getxattr_client, mds_getxattr_server);
1457 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1459 struct req_format RQF_MDS_GETATTR_NAME =
1460 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1461 mds_getattr_name_client, mds_getattr_server);
1462 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1464 struct req_format RQF_MDS_REINT =
1465 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1466 EXPORT_SYMBOL(RQF_MDS_REINT);
1468 struct req_format RQF_MDS_REINT_CREATE =
1469 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1470 mds_reint_create_client, mdt_body_capa);
1471 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1473 struct req_format RQF_MDS_REINT_CREATE_ACL =
1474 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1475 mds_reint_create_acl_client, mdt_body_capa);
1476 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1478 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1479 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1480 mds_reint_create_slave_client, mdt_body_capa);
1481 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1483 struct req_format RQF_MDS_REINT_CREATE_SYM =
1484 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1485 mds_reint_create_sym_client, mdt_body_capa);
1486 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1488 struct req_format RQF_MDS_REINT_OPEN =
1489 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1490 mds_reint_open_client, mds_reint_open_server);
1491 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1493 struct req_format RQF_MDS_REINT_UNLINK =
1494 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1495 mds_last_unlink_server);
1496 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1498 struct req_format RQF_MDS_REINT_LINK =
1499 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1500 mds_reint_link_client, mdt_body_only);
1501 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1503 struct req_format RQF_MDS_REINT_RENAME =
1504 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1505 mds_last_unlink_server);
1506 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1508 struct req_format RQF_MDS_REINT_MIGRATE =
1509 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1510 mds_last_unlink_server);
1511 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1513 struct req_format RQF_MDS_REINT_SETATTR =
1514 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1515 mds_reint_setattr_client, mds_setattr_server);
1516 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1518 struct req_format RQF_MDS_REINT_SETXATTR =
1519 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1520 mds_reint_setxattr_client, mdt_body_only);
1521 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1523 struct req_format RQF_MDS_REINT_RESYNC =
1524 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1525 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1527 struct req_format RQF_MDS_CONNECT =
1528 DEFINE_REQ_FMT0("MDS_CONNECT",
1529 obd_connect_client, obd_connect_server);
1530 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1532 struct req_format RQF_MDS_DISCONNECT =
1533 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1534 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1536 struct req_format RQF_MDS_GET_INFO =
1537 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1538 mds_getinfo_server);
1539 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1541 struct req_format RQF_OUT_UPDATE =
1542 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1544 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1546 struct req_format RQF_LDLM_ENQUEUE =
1547 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1548 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1549 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1551 struct req_format RQF_LDLM_ENQUEUE_LVB =
1552 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1553 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1554 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1556 struct req_format RQF_LDLM_CONVERT =
1557 DEFINE_REQ_FMT0("LDLM_CONVERT",
1558 ldlm_enqueue_client, ldlm_enqueue_server);
1559 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1561 struct req_format RQF_LDLM_CANCEL =
1562 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1563 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1565 struct req_format RQF_LDLM_CALLBACK =
1566 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1567 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1569 struct req_format RQF_LDLM_CP_CALLBACK =
1570 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1571 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1573 struct req_format RQF_LDLM_BL_CALLBACK =
1574 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1575 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1577 struct req_format RQF_LDLM_GL_CALLBACK =
1578 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1579 ldlm_gl_callback_server);
1580 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1582 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1583 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1584 ldlm_gl_callback_server);
1585 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1587 struct req_format RQF_LDLM_INTENT_BASIC =
1588 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1589 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1590 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1592 struct req_format RQF_LDLM_INTENT =
1593 DEFINE_REQ_FMT0("LDLM_INTENT",
1594 ldlm_intent_client, ldlm_intent_server);
1595 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1597 struct req_format RQF_LDLM_INTENT_LAYOUT =
1598 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1599 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1600 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1602 struct req_format RQF_LDLM_INTENT_GETATTR =
1603 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1604 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1605 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1607 struct req_format RQF_LDLM_INTENT_OPEN =
1608 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1609 ldlm_intent_open_client, ldlm_intent_open_server);
1610 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1612 struct req_format RQF_LDLM_INTENT_CREATE =
1613 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1614 ldlm_intent_create_client, ldlm_intent_getattr_server);
1615 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1617 struct req_format RQF_LDLM_INTENT_GETXATTR =
1618 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1619 ldlm_intent_getxattr_client,
1620 ldlm_intent_getxattr_server);
1621 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1623 struct req_format RQF_MDS_CLOSE =
1624 DEFINE_REQ_FMT0("MDS_CLOSE",
1625 mdt_close_client, mds_last_unlink_server);
1626 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1628 struct req_format RQF_MDS_CLOSE_INTENT =
1629 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1630 mdt_close_intent_client, mds_last_unlink_server);
1631 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1633 struct req_format RQF_MDS_READPAGE =
1634 DEFINE_REQ_FMT0("MDS_READPAGE",
1635 mdt_body_capa, mdt_body_only);
1636 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1638 struct req_format RQF_MDS_HSM_ACTION =
1639 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1640 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1642 struct req_format RQF_MDS_HSM_PROGRESS =
1643 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1644 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1646 struct req_format RQF_MDS_HSM_CT_REGISTER =
1647 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1648 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1650 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1651 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1652 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1654 struct req_format RQF_MDS_HSM_STATE_GET =
1655 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1656 mdt_body_capa, mdt_hsm_state_get_server);
1657 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1659 struct req_format RQF_MDS_HSM_STATE_SET =
1660 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1661 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1663 struct req_format RQF_MDS_HSM_REQUEST =
1664 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1665 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1667 struct req_format RQF_MDS_SWAP_LAYOUTS =
1668 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1669 mdt_swap_layouts, empty);
1670 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1672 struct req_format RQF_MDS_RMFID =
1673 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1675 EXPORT_SYMBOL(RQF_MDS_RMFID);
1677 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1678 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1679 llog_origin_handle_create_client, llogd_body_only);
1680 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1682 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1683 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1684 llogd_body_only, llog_origin_handle_next_block_server);
1685 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1687 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1688 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1689 llogd_body_only, llog_origin_handle_next_block_server);
1690 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1692 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1693 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1694 llogd_body_only, llog_log_hdr_only);
1695 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1697 struct req_format RQF_CONNECT =
1698 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1699 EXPORT_SYMBOL(RQF_CONNECT);
1701 struct req_format RQF_OST_CONNECT =
1702 DEFINE_REQ_FMT0("OST_CONNECT",
1703 obd_connect_client, obd_connect_server);
1704 EXPORT_SYMBOL(RQF_OST_CONNECT);
1706 struct req_format RQF_OST_DISCONNECT =
1707 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1708 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1710 struct req_format RQF_OST_GETATTR =
1711 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1712 EXPORT_SYMBOL(RQF_OST_GETATTR);
1714 struct req_format RQF_OST_SETATTR =
1715 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1716 EXPORT_SYMBOL(RQF_OST_SETATTR);
1718 struct req_format RQF_OST_CREATE =
1719 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1720 EXPORT_SYMBOL(RQF_OST_CREATE);
1722 struct req_format RQF_OST_PUNCH =
1723 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1724 EXPORT_SYMBOL(RQF_OST_PUNCH);
1726 struct req_format RQF_OST_SYNC =
1727 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1728 EXPORT_SYMBOL(RQF_OST_SYNC);
1730 struct req_format RQF_OST_DESTROY =
1731 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1732 EXPORT_SYMBOL(RQF_OST_DESTROY);
1734 struct req_format RQF_OST_BRW_READ =
1735 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1736 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1738 struct req_format RQF_OST_BRW_WRITE =
1739 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1740 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1742 struct req_format RQF_OST_STATFS =
1743 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1744 EXPORT_SYMBOL(RQF_OST_STATFS);
1746 struct req_format RQF_OST_SET_GRANT_INFO =
1747 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1749 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1751 struct req_format RQF_OST_GET_INFO =
1752 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1753 ost_get_info_generic_server);
1754 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1756 struct req_format RQF_OST_GET_INFO_LAST_ID =
1757 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1758 ost_get_last_id_server);
1759 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1761 struct req_format RQF_OST_GET_INFO_LAST_FID =
1762 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1763 ost_get_last_fid_server);
1764 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1766 struct req_format RQF_OST_SET_INFO_LAST_FID =
1767 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1769 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1771 struct req_format RQF_OST_GET_INFO_FIEMAP =
1772 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1773 ost_get_fiemap_server);
1774 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1776 struct req_format RQF_LFSCK_NOTIFY =
1777 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1778 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1780 struct req_format RQF_LFSCK_QUERY =
1781 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1782 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1784 struct req_format RQF_OST_LADVISE =
1785 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1786 EXPORT_SYMBOL(RQF_OST_LADVISE);
1788 /* Convenience macro */
1789 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1792 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1793 * field of RQFs and the \a rmf_offset field of RMFs.
1795 int req_layout_init(void)
1800 struct req_format *rf = NULL;
1802 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1803 rf = req_formats[i];
1805 for (j = 0; j < RCL_NR; ++j) {
1806 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1807 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1808 struct req_msg_field *field;
1810 field = (typeof(field))rf->rf_fields[j].d[k];
1811 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1812 || field->rmf_size > 0);
1813 LASSERT(field->rmf_offset[i][j] == 0);
1815 * k + 1 to detect unused format/field
1818 field->rmf_offset[i][j] = k + 1;
1824 EXPORT_SYMBOL(req_layout_init);
1826 void req_layout_fini(void)
1829 EXPORT_SYMBOL(req_layout_fini);
1832 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1834 * Actual/expected field sizes are set elsewhere in functions in this file:
1835 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1836 * req_capsule_msg_size(). The \a rc_area information is used by.
1837 * ptlrpc_request_set_replen().
1839 void req_capsule_init_area(struct req_capsule *pill)
1843 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1844 pill->rc_area[RCL_CLIENT][i] = -1;
1845 pill->rc_area[RCL_SERVER][i] = -1;
1848 EXPORT_SYMBOL(req_capsule_init_area);
1851 * Initialize a pill.
1853 * The \a location indicates whether the caller is executing on the client side
1854 * (RCL_CLIENT) or server side (RCL_SERVER)..
1856 void req_capsule_init(struct req_capsule *pill,
1857 struct ptlrpc_request *req,
1858 enum req_location location)
1860 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1863 * Today all capsules are embedded in ptlrpc_request structs,
1864 * but just in case that ever isn't the case, we don't reach
1865 * into req unless req != NULL and pill is the one embedded in
1868 * The req->rq_pill_init flag makes it safe to initialize a pill
1869 * twice, which might happen in the OST paths as a result of the
1870 * high-priority RPC queue getting peeked at before ost_handle()
1871 * handles an OST RPC.
1873 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1876 memset(pill, 0, sizeof *pill);
1878 pill->rc_loc = location;
1879 req_capsule_init_area(pill);
1881 if (req != NULL && pill == &req->rq_pill)
1882 req->rq_pill_init = 1;
1884 EXPORT_SYMBOL(req_capsule_init);
1886 void req_capsule_fini(struct req_capsule *pill)
1889 EXPORT_SYMBOL(req_capsule_fini);
1891 static int __req_format_is_sane(const struct req_format *fmt)
1893 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1894 req_formats[fmt->rf_idx] == fmt;
1897 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1898 enum req_location loc)
1900 struct ptlrpc_request *req;
1903 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1907 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1908 * (see req_capsule_extend()).
1910 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1912 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1913 LASSERT(__req_format_is_sane(fmt));
1917 EXPORT_SYMBOL(req_capsule_set);
1920 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1923 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1924 * variable-sized fields. The field sizes come from the declared \a rmf_size
1925 * field of a \a pill's \a rc_fmt's RMF's.
1927 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1928 enum req_location loc)
1930 const struct req_format *fmt = pill->rc_fmt;
1933 LASSERT(fmt != NULL);
1935 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1936 if (pill->rc_area[loc][i] == -1) {
1937 pill->rc_area[loc][i] =
1938 fmt->rf_fields[loc].d[i]->rmf_size;
1939 if (pill->rc_area[loc][i] == -1) {
1941 * Skip the following fields.
1943 * If this LASSERT() trips then you're missing a
1944 * call to req_capsule_set_size().
1946 LASSERT(loc != RCL_SERVER);
1953 EXPORT_SYMBOL(req_capsule_filled_sizes);
1956 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1958 * This function uses the \a pill's \a rc_area as filled in by
1959 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1962 int req_capsule_server_pack(struct req_capsule *pill)
1964 const struct req_format *fmt;
1968 LASSERT(pill->rc_loc == RCL_SERVER);
1970 LASSERT(fmt != NULL);
1972 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1973 rc = lustre_pack_reply(pill->rc_req, count,
1974 pill->rc_area[RCL_SERVER], NULL);
1976 DEBUG_REQ(D_ERROR, pill->rc_req,
1977 "Cannot pack %d fields in format '%s'",
1978 count, fmt->rf_name);
1982 EXPORT_SYMBOL(req_capsule_server_pack);
1985 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1986 * corresponding to the given RMF (\a field).
1988 __u32 __req_capsule_offset(const struct req_capsule *pill,
1989 const struct req_msg_field *field,
1990 enum req_location loc)
1992 unsigned int offset;
1994 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1995 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1996 pill->rc_fmt->rf_name,
1997 field->rmf_name, offset, loc);
2000 LASSERT(offset < REQ_MAX_FIELD_NR);
2005 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
2009 swabber_dumper_helper(struct req_capsule *pill,
2010 const struct req_msg_field *field,
2011 enum req_location loc,
2013 void *value, int len, bool dump, void (*swabber)(void *))
2021 bool inout = loc == RCL_CLIENT;
2022 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2024 swabber = swabber ?: field->rmf_swabber;
2026 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
2027 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2032 if (!field->rmf_dumper)
2036 * We're swabbing an array; swabber() swabs a single array element, so
2037 * swab every element.
2039 if (array && (len % field->rmf_size)) {
2040 static const struct req_msg_field *last_field;
2042 if (field != last_field) {
2043 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2044 field->rmf_name, len, field->rmf_size);
2048 /* For the non-array cases, the process of swab/dump/swab only
2049 * needs to be done once. (n = 1)
2052 len = field->rmf_size;
2053 for (p = value, i = 0, n = len / field->rmf_size;
2055 i++, p += field->rmf_size) {
2057 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2058 do_swab ? "unswabbed " : "",
2059 array ? "array " : "",
2060 field->rmf_name, i);
2061 field->rmf_dumper(p);
2069 if (!field->rmf_swab_len) {
2072 size = field->rmf_swab_len(p, len);
2081 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2082 array ? "array " : "", field->rmf_name, i);
2083 field->rmf_dumper(value);
2087 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2093 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2094 * corresponding to the given RMF (\a field).
2096 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2097 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2098 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2099 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2100 * element of the array swabbed.
2102 static void *__req_capsule_get(struct req_capsule *pill,
2103 const struct req_msg_field *field,
2104 enum req_location loc,
2105 void (*swabber)(void *),
2108 const struct req_format *fmt;
2109 struct lustre_msg *msg;
2114 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2116 static const char *rcl_names[RCL_NR] = {
2117 [RCL_CLIENT] = "client",
2118 [RCL_SERVER] = "server"
2121 LASSERT(pill != NULL);
2122 LASSERT(pill != LP_POISON);
2124 LASSERT(fmt != NULL);
2125 LASSERT(fmt != LP_POISON);
2126 LASSERT(__req_format_is_sane(fmt));
2128 offset = __req_capsule_offset(pill, field, loc);
2130 msg = __req_msg(pill, loc);
2131 LASSERT(msg != NULL);
2133 getter = (field->rmf_flags & RMF_F_STRING) ?
2134 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2136 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2138 * We've already asserted that field->rmf_size > 0 in
2139 * req_layout_init().
2141 len = lustre_msg_buflen(msg, offset);
2142 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2143 (len % field->rmf_size) != 0) {
2144 CERROR("%s: array field size mismatch "
2145 "%d modulo %u != 0 (%d)\n",
2146 field->rmf_name, len, field->rmf_size, loc);
2149 } else if (pill->rc_area[loc][offset] != -1) {
2150 len = pill->rc_area[loc][offset];
2152 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2154 value = getter(msg, offset, len);
2156 if (value == NULL) {
2157 DEBUG_REQ(D_ERROR, pill->rc_req,
2158 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2159 field->rmf_name, offset, lustre_msg_bufcount(msg),
2160 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2163 swabber_dumper_helper(pill, field, loc, offset, value, len,
2171 * Dump a request and/or reply
2173 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2175 const struct req_format *fmt;
2176 const struct req_msg_field *field;
2182 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2183 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2184 field = FMT_FIELD(fmt, loc, i);
2185 if (field->rmf_dumper == NULL) {
2187 * FIXME Add a default hex dumper for fields that don't
2188 * have a specific dumper
2190 len = req_capsule_get_size(pill, field, loc);
2192 "Field %s has no dumper function; field size is %u\n",
2193 field->rmf_name, len);
2195 /* It's dumping side-effect that we're interested in */
2196 (void) __req_capsule_get(pill, field, loc, NULL, true);
2199 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2205 void req_capsule_client_dump(struct req_capsule *pill)
2207 __req_capsule_dump(pill, RCL_CLIENT);
2209 EXPORT_SYMBOL(req_capsule_client_dump);
2214 void req_capsule_server_dump(struct req_capsule *pill)
2216 __req_capsule_dump(pill, RCL_SERVER);
2218 EXPORT_SYMBOL(req_capsule_server_dump);
2221 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2222 * buffer corresponding to the given RMF (\a field) of a \a pill.
2224 void *req_capsule_client_get(struct req_capsule *pill,
2225 const struct req_msg_field *field)
2227 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2229 EXPORT_SYMBOL(req_capsule_client_get);
2232 * Same as req_capsule_client_get(), but with a \a swabber argument.
2234 * Currently unused; will be removed when req_capsule_server_swab_get() is
2237 void *req_capsule_client_swab_get(struct req_capsule *pill,
2238 const struct req_msg_field *field,
2241 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2243 EXPORT_SYMBOL(req_capsule_client_swab_get);
2246 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2248 * First the \a pill's request \a field's size is set (\a rc_area) using
2249 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2252 void *req_capsule_client_sized_get(struct req_capsule *pill,
2253 const struct req_msg_field *field,
2256 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2257 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2259 EXPORT_SYMBOL(req_capsule_client_sized_get);
2262 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2263 * buffer corresponding to the given RMF (\a field) of a \a pill.
2265 void *req_capsule_server_get(struct req_capsule *pill,
2266 const struct req_msg_field *field)
2268 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2270 EXPORT_SYMBOL(req_capsule_server_get);
2273 * Same as req_capsule_server_get(), but with a \a swabber argument.
2275 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2276 * swabbing done outside this capsule abstraction.
2278 void *req_capsule_server_swab_get(struct req_capsule *pill,
2279 const struct req_msg_field *field,
2282 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2284 EXPORT_SYMBOL(req_capsule_server_swab_get);
2287 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2289 * First the \a pill's request \a field's size is set (\a rc_area) using
2290 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2293 void *req_capsule_server_sized_get(struct req_capsule *pill,
2294 const struct req_msg_field *field,
2297 req_capsule_set_size(pill, field, RCL_SERVER, len);
2298 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2300 EXPORT_SYMBOL(req_capsule_server_sized_get);
2302 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2303 const struct req_msg_field *field,
2304 __u32 len, void *swabber)
2306 req_capsule_set_size(pill, field, RCL_SERVER, len);
2307 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2309 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2312 * Returns the buffer of a \a pill corresponding to the given \a field from the
2313 * request (if the caller is executing on the server-side) or reply (if the
2314 * caller is executing on the client-side).
2316 * This function convienient for use is code that could be executed on the
2317 * client and server alike.
2319 const void *req_capsule_other_get(struct req_capsule *pill,
2320 const struct req_msg_field *field)
2322 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2324 EXPORT_SYMBOL(req_capsule_other_get);
2327 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2328 * field of the given \a pill.
2330 * This function must be used when constructing variable sized fields of a
2333 void req_capsule_set_size(struct req_capsule *pill,
2334 const struct req_msg_field *field,
2335 enum req_location loc, __u32 size)
2337 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2339 if ((size != (__u32)field->rmf_size) &&
2340 (field->rmf_size != -1) &&
2341 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2343 __u32 rmf_size = (__u32)field->rmf_size;
2344 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2345 (size % rmf_size != 0)) {
2346 CERROR("%s: array field size mismatch "
2347 "%u %% %u != 0 (%d)\n",
2348 field->rmf_name, size, rmf_size, loc);
2350 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2352 CERROR("%s: field size mismatch %u != %u (%d)\n",
2353 field->rmf_name, size, rmf_size, loc);
2358 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2360 EXPORT_SYMBOL(req_capsule_set_size);
2363 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2364 * for the given \a pill's given \a field.
2366 * NB: this function doesn't correspond with req_capsule_set_size(), which
2367 * actually sets the size in pill.rc_area[loc][offset], but this function
2368 * returns the message buflen[offset], maybe we should use another name.
2370 __u32 req_capsule_get_size(const struct req_capsule *pill,
2371 const struct req_msg_field *field,
2372 enum req_location loc)
2374 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2376 return lustre_msg_buflen(__req_msg(pill, loc),
2377 __req_capsule_offset(pill, field, loc));
2379 EXPORT_SYMBOL(req_capsule_get_size);
2382 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2383 * given \a pill's request or reply (\a loc) given the field size recorded in
2384 * the \a pill's rc_area.
2386 * See also req_capsule_set_size().
2388 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2390 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2391 pill->rc_fmt->rf_fields[loc].nr,
2392 pill->rc_area[loc]);
2396 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2397 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2398 * PTLRPC request or reply given only an RQF (\a fmt).
2400 * This function should not be used for formats which contain variable size
2403 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2404 enum req_location loc)
2410 * This function should probably LASSERT() that fmt has no fields with
2411 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2412 * elements in the array there will ultimately be, but then, we could
2413 * assume that there will be at least one element, and that's just what
2416 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2420 for (; i < fmt->rf_fields[loc].nr; ++i)
2421 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2422 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2426 EXPORT_SYMBOL(req_capsule_fmt_size);
2429 * Changes the format of an RPC.
2431 * The pill must already have been initialized, which means that it already has
2432 * a request format. The new format \a fmt must be an extension of the pill's
2433 * old format. Specifically: the new format must have as many request and reply
2434 * fields as the old one, and all fields shared by the old and new format must
2435 * be at least as large in the new format.
2437 * The new format's fields may be of different "type" than the old format, but
2438 * only for fields that are "opaque" blobs: fields which have a) have no
2439 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2440 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2441 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2442 * according to the key field. When the value, according to the key, contains a
2443 * structure (or array thereof) to be swabbed, the format should be changed to
2444 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2447 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2452 const struct req_format *old;
2454 LASSERT(pill->rc_fmt != NULL);
2455 LASSERT(__req_format_is_sane(fmt));
2459 * Sanity checking...
2461 for (i = 0; i < RCL_NR; ++i) {
2462 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2463 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2464 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2466 /* "opaque" fields can be transmogrified */
2467 if (ofield->rmf_swabber == NULL &&
2468 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2469 (ofield->rmf_size == -1 ||
2470 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2472 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2475 * Last field in old format can be shorter than in new.
2477 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2478 FMT_FIELD(old, i, j)->rmf_size);
2483 EXPORT_SYMBOL(req_capsule_extend);
2486 * This function returns a non-zero value if the given \a field is present in
2487 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2490 int req_capsule_has_field(const struct req_capsule *pill,
2491 const struct req_msg_field *field,
2492 enum req_location loc)
2494 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2496 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2498 EXPORT_SYMBOL(req_capsule_has_field);
2501 * Returns a non-zero value if the given \a field is present in the given \a
2502 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2504 int req_capsule_field_present(const struct req_capsule *pill,
2505 const struct req_msg_field *field,
2506 enum req_location loc)
2510 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2511 LASSERT(req_capsule_has_field(pill, field, loc));
2513 offset = __req_capsule_offset(pill, field, loc);
2514 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2516 EXPORT_SYMBOL(req_capsule_field_present);
2519 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2520 * request or reply (\a loc).
2522 * This is not the opposite of req_capsule_extend().
2524 void req_capsule_shrink(struct req_capsule *pill,
2525 const struct req_msg_field *field,
2527 enum req_location loc)
2529 const struct req_format *fmt;
2530 struct lustre_msg *msg;
2535 LASSERT(fmt != NULL);
2536 LASSERT(__req_format_is_sane(fmt));
2537 LASSERT(req_capsule_has_field(pill, field, loc));
2538 LASSERT(req_capsule_field_present(pill, field, loc));
2540 offset = __req_capsule_offset(pill, field, loc);
2542 msg = __req_msg(pill, loc);
2543 len = lustre_msg_buflen(msg, offset);
2544 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2545 fmt->rf_name, field->rmf_name, len, newlen);
2547 if (loc == RCL_CLIENT) {
2548 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2551 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2553 /* update also field size in reply lenghts arrays for possible
2554 * reply re-pack due to req_capsule_server_grow() call.
2556 req_capsule_set_size(pill, field, loc, newlen);
2559 EXPORT_SYMBOL(req_capsule_shrink);
2561 int req_capsule_server_grow(struct req_capsule *pill,
2562 const struct req_msg_field *field,
2565 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2570 LASSERT(pill->rc_fmt != NULL);
2571 LASSERT(__req_format_is_sane(pill->rc_fmt));
2572 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2573 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2575 len = req_capsule_get_size(pill, field, RCL_SERVER);
2576 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2578 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2579 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2582 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2584 * There can be enough space in current reply buffer, make sure
2585 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2586 * re-packing is still needed.
2588 if (rs->rs_msg == rs->rs_repbuf &&
2589 rs->rs_repbuf_len >=
2590 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2591 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2596 /* Re-allocate replay state */
2597 pill->rc_req->rq_reply_state = NULL;
2598 rc = req_capsule_server_pack(pill);
2600 /* put old values back, the caller should decide what to do */
2601 req_capsule_set_size(pill, field, RCL_SERVER, len);
2602 pill->rc_req->rq_reply_state = rs;
2605 nrs = pill->rc_req->rq_reply_state;
2606 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2607 lustre_packed_msg_size(rs->rs_msg));
2609 /* Now we need only buffers, copy them and grow the needed one */
2610 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2611 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2612 len = (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from;
2613 memcpy(to, from, len);
2614 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2616 if (rs->rs_difficult) {
2620 nrs->rs_difficult = 1;
2621 nrs->rs_no_ack = rs->rs_no_ack;
2622 nrs->rs_convert_lock = rs->rs_convert_lock;
2623 for (i = 0; i < rs->rs_nlocks; i++) {
2624 nrs->rs_locks[i] = rs->rs_locks[i];
2625 nrs->rs_modes[i] = rs->rs_modes[i];
2629 rs->rs_difficult = 0;
2632 ptlrpc_rs_decref(rs);
2635 EXPORT_SYMBOL(req_capsule_server_grow);
2637 int req_check_sepol(struct req_capsule *pill)
2640 #ifdef HAVE_SERVER_SUPPORT
2641 struct obd_export *export;
2642 struct lu_nodemap *nm = NULL;
2643 const char *sepol = NULL;
2644 const char *nm_sepol = NULL;
2649 export = pill->rc_req->rq_export;
2650 if (!export || !exp_connect_sepol(export) ||
2651 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2654 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2657 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2658 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2662 nm = nodemap_get_from_exp(export);
2663 if (!IS_ERR_OR_NULL(nm)) {
2664 nm_sepol = nodemap_get_sepol(nm);
2665 if (nm_sepol && nm_sepol[0])
2666 if (sepol == NULL ||
2667 strcmp(sepol, nm_sepol) != 0)
2672 if (!IS_ERR_OR_NULL(nm))
2678 EXPORT_SYMBOL(req_check_sepol);