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_swab.h>
52 #include <obd_support.h>
54 /* struct ptlrpc_request, lustre_msg* */
55 #include <lustre_req_layout.h>
56 #include <lustre_acl.h>
57 #include <lustre_nodemap.h>
60 * RQFs (see below) refer to two struct req_msg_field arrays describing the
61 * client request and server reply, respectively.
63 /* empty set of fields... for suitable definition of emptiness. */
64 static const struct req_msg_field *empty[] = {
68 static const struct req_msg_field *mgs_target_info_only[] = {
73 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
74 static const struct req_msg_field *mgs_set_info[] = {
80 static const struct req_msg_field *mgs_config_read_client[] = {
85 static const struct req_msg_field *mgs_config_read_server[] = {
90 static const struct req_msg_field *mdt_body_only[] = {
95 static const struct req_msg_field *mdt_body_capa[] = {
101 static const struct req_msg_field *quotactl_only[] = {
106 static const struct req_msg_field *quota_body_only[] = {
111 static const struct req_msg_field *ldlm_intent_quota_client[] = {
118 static const struct req_msg_field *ldlm_intent_quota_server[] = {
125 static const struct req_msg_field *mdt_close_client[] = {
132 static const struct req_msg_field *mdt_close_intent_client[] = {
141 static const struct req_msg_field *obd_statfs_server[] = {
146 static const struct req_msg_field *seq_query_client[] = {
152 static const struct req_msg_field *seq_query_server[] = {
157 static const struct req_msg_field *fld_query_client[] = {
163 static const struct req_msg_field *fld_query_server[] = {
168 static const struct req_msg_field *fld_read_client[] = {
173 static const struct req_msg_field *fld_read_server[] = {
178 static const struct req_msg_field *mds_getattr_name_client[] = {
185 static const struct req_msg_field *mds_reint_client[] = {
190 static const struct req_msg_field *mds_reint_create_client[] = {
197 static const struct req_msg_field *mds_reint_create_slave_client[] = {
206 static const struct req_msg_field *mds_reint_create_acl_client[] = {
213 &RMF_FILE_SECCTX_NAME,
219 static const struct req_msg_field *mds_reint_create_sym_client[] = {
226 &RMF_FILE_SECCTX_NAME,
232 static const struct req_msg_field *mds_reint_open_client[] = {
239 &RMF_FILE_SECCTX_NAME,
245 static const struct req_msg_field *mds_reint_open_server[] = {
254 static const struct req_msg_field *mds_reint_unlink_client[] = {
263 static const struct req_msg_field *mds_reint_link_client[] = {
273 static const struct req_msg_field *mds_reint_rename_client[] = {
284 static const struct req_msg_field *mds_reint_migrate_client[] = {
298 static const struct req_msg_field *mds_last_unlink_server[] = {
307 static const struct req_msg_field *mds_reint_setattr_client[] = {
317 static const struct req_msg_field *mds_reint_setxattr_client[] = {
327 static const struct req_msg_field *mds_reint_resync[] = {
333 static const struct req_msg_field *mdt_swap_layouts[] = {
342 static const struct req_msg_field *mds_rmfid_client[] = {
350 static const struct req_msg_field *mds_rmfid_server[] = {
357 static const struct req_msg_field *obd_connect_client[] = {
366 static const struct req_msg_field *obd_connect_server[] = {
371 static const struct req_msg_field *obd_set_info_client[] = {
377 static const struct req_msg_field *mdt_set_info_client[] = {
384 static const struct req_msg_field *ost_grant_shrink_client[] = {
390 static const struct req_msg_field *mds_getinfo_client[] = {
396 static const struct req_msg_field *mds_getinfo_server[] = {
401 static const struct req_msg_field *ldlm_enqueue_client[] = {
406 static const struct req_msg_field *ldlm_enqueue_server[] = {
411 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
417 static const struct req_msg_field *ldlm_cp_callback_client[] = {
423 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
429 static const struct req_msg_field *ldlm_gl_callback_server[] = {
434 static const struct req_msg_field *ldlm_intent_basic_client[] = {
440 static const struct req_msg_field *ldlm_intent_client[] = {
447 static const struct req_msg_field *ldlm_intent_server[] = {
455 static const struct req_msg_field *ldlm_intent_layout_client[] = {
460 &RMF_EADATA /* for new layout to be set up */
463 static const struct req_msg_field *ldlm_intent_open_server[] = {
476 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
480 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
483 &RMF_FILE_SECCTX_NAME
486 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
498 static const struct req_msg_field *ldlm_intent_create_client[] = {
502 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
506 &RMF_FILE_SECCTX_NAME,
512 static const struct req_msg_field *ldlm_intent_open_client[] = {
516 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
521 &RMF_FILE_SECCTX_NAME,
527 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
536 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
541 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
547 static const struct req_msg_field *mds_get_root_client[] = {
553 static const struct req_msg_field *mds_getxattr_client[] = {
562 static const struct req_msg_field *mds_getxattr_server[] = {
568 static const struct req_msg_field *mds_getattr_server[] = {
577 static const struct req_msg_field *mds_setattr_server[] = {
586 static const struct req_msg_field *llog_origin_handle_create_client[] = {
593 static const struct req_msg_field *llogd_body_only[] = {
598 static const struct req_msg_field *llog_log_hdr_only[] = {
603 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
609 static const struct req_msg_field *obd_idx_read_client[] = {
614 static const struct req_msg_field *obd_idx_read_server[] = {
619 static const struct req_msg_field *ost_body_only[] = {
624 static const struct req_msg_field *ost_body_capa[] = {
630 static const struct req_msg_field *ost_destroy_client[] = {
638 static const struct req_msg_field *ost_brw_client[] = {
647 static const struct req_msg_field *ost_brw_read_server[] = {
653 static const struct req_msg_field *ost_brw_write_server[] = {
659 static const struct req_msg_field *ost_get_info_generic_server[] = {
664 static const struct req_msg_field *ost_get_info_generic_client[] = {
669 static const struct req_msg_field *ost_get_last_id_server[] = {
674 static const struct req_msg_field *ost_get_last_fid_client[] = {
680 static const struct req_msg_field *ost_get_last_fid_server[] = {
685 static const struct req_msg_field *ost_get_fiemap_client[] = {
691 static const struct req_msg_field *ost_ladvise[] = {
694 &RMF_OST_LADVISE_HDR,
698 static const struct req_msg_field *ost_get_fiemap_server[] = {
703 static const struct req_msg_field *mdt_hsm_progress[] = {
706 &RMF_MDS_HSM_PROGRESS,
709 static const struct req_msg_field *mdt_hsm_ct_register[] = {
712 &RMF_MDS_HSM_ARCHIVE,
715 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
720 static const struct req_msg_field *mdt_hsm_action_server[] = {
723 &RMF_MDS_HSM_CURRENT_ACTION,
726 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
732 static const struct req_msg_field *mdt_hsm_state_set[] = {
739 static const struct req_msg_field *mdt_hsm_request[] = {
742 &RMF_MDS_HSM_REQUEST,
743 &RMF_MDS_HSM_USER_ITEM,
747 static const struct req_msg_field *obd_lfsck_request[] = {
752 static const struct req_msg_field *obd_lfsck_reply[] = {
757 static struct req_format *req_formats[] = {
764 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
767 &RQF_MGS_CONFIG_READ,
778 &RQF_MDS_GETATTR_NAME,
782 &RQF_MDS_CLOSE_INTENT,
785 &RQF_MDS_REINT_CREATE,
786 &RQF_MDS_REINT_CREATE_ACL,
787 &RQF_MDS_REINT_CREATE_SLAVE,
788 &RQF_MDS_REINT_CREATE_SYM,
790 &RQF_MDS_REINT_UNLINK,
792 &RQF_MDS_REINT_RENAME,
793 &RQF_MDS_REINT_MIGRATE,
794 &RQF_MDS_REINT_SETATTR,
795 &RQF_MDS_REINT_SETXATTR,
796 &RQF_MDS_REINT_RESYNC,
798 &RQF_MDS_HSM_PROGRESS,
799 &RQF_MDS_HSM_CT_REGISTER,
800 &RQF_MDS_HSM_CT_UNREGISTER,
801 &RQF_MDS_HSM_STATE_GET,
802 &RQF_MDS_HSM_STATE_SET,
804 &RQF_MDS_HSM_REQUEST,
805 &RQF_MDS_SWAP_LAYOUTS,
807 #ifdef HAVE_SERVER_SUPPORT
823 &RQF_OST_SET_GRANT_INFO,
825 &RQF_OST_GET_INFO_LAST_ID,
826 &RQF_OST_GET_INFO_LAST_FID,
827 &RQF_OST_SET_INFO_LAST_FID,
828 &RQF_OST_GET_INFO_FIEMAP,
832 &RQF_LDLM_ENQUEUE_LVB,
836 &RQF_LDLM_CP_CALLBACK,
837 &RQF_LDLM_BL_CALLBACK,
838 &RQF_LDLM_GL_CALLBACK,
839 &RQF_LDLM_GL_CALLBACK_DESC,
841 &RQF_LDLM_INTENT_BASIC,
842 &RQF_LDLM_INTENT_LAYOUT,
843 &RQF_LDLM_INTENT_GETATTR,
844 &RQF_LDLM_INTENT_OPEN,
845 &RQF_LDLM_INTENT_CREATE,
846 &RQF_LDLM_INTENT_GETXATTR,
847 &RQF_LDLM_INTENT_QUOTA,
849 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
850 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
851 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
852 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
858 struct req_msg_field {
859 const __u32 rmf_flags;
860 const char *rmf_name;
862 * Field length. (-1) means "variable length". If the
863 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
864 * but the actual size must be a whole multiple of \a rmf_size.
867 void (*rmf_swabber)(void *);
869 * Pass buffer size to swabbing function
870 * \retval > 0 the number of bytes swabbed
871 * -EOVERFLOW on error
873 int (*rmf_swab_len)(void *, __u32);
874 void (*rmf_dumper)(void *);
875 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
880 * The field is a string, must be NUL-terminated.
882 RMF_F_STRING = BIT(0),
884 * The field's buffer size need not match the declared \a rmf_size.
886 RMF_F_NO_SIZE_CHECK = BIT(1),
888 * The field's buffer size must be a whole multiple of the declared \a
889 * rmf_size and the \a rmf_swabber function must work on the declared \a
890 * rmf_size worth of bytes.
892 RMF_F_STRUCT_ARRAY = BIT(2),
900 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
901 .rmf_name = (name), \
902 .rmf_flags = (flags), \
903 .rmf_size = (size), \
904 .rmf_swabber = (void (*)(void*))(swabber), \
905 .rmf_dumper = (void (*)(void*))(dumper) \
908 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
909 .rmf_name = (name), \
910 .rmf_flags = (flags), \
911 .rmf_size = (size), \
912 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
913 .rmf_dumper = (void (*)(void *))(dumper) \
916 struct req_msg_field RMF_GENERIC_DATA =
917 DEFINE_MSGF("generic_data", 0,
919 EXPORT_SYMBOL(RMF_GENERIC_DATA);
921 struct req_msg_field RMF_MGS_TARGET_INFO =
922 DEFINE_MSGF("mgs_target_info", 0,
923 sizeof(struct mgs_target_info),
924 lustre_swab_mgs_target_info, NULL);
925 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
927 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
928 struct req_msg_field RMF_MGS_SEND_PARAM =
929 DEFINE_MSGF("mgs_send_param", 0,
930 sizeof(struct mgs_send_param),
932 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
935 struct req_msg_field RMF_MGS_CONFIG_BODY =
936 DEFINE_MSGF("mgs_config_read request", 0,
937 sizeof(struct mgs_config_body),
938 lustre_swab_mgs_config_body, NULL);
939 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
941 struct req_msg_field RMF_MGS_CONFIG_RES =
942 DEFINE_MSGF("mgs_config_read reply ", 0,
943 sizeof(struct mgs_config_res),
944 lustre_swab_mgs_config_res, NULL);
945 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
947 struct req_msg_field RMF_U32 =
948 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
949 sizeof(__u32), lustre_swab_generic_32s, NULL);
950 EXPORT_SYMBOL(RMF_U32);
952 struct req_msg_field RMF_SETINFO_VAL =
953 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
954 EXPORT_SYMBOL(RMF_SETINFO_VAL);
956 struct req_msg_field RMF_GETINFO_KEY =
957 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
958 EXPORT_SYMBOL(RMF_GETINFO_KEY);
960 struct req_msg_field RMF_GETINFO_VALLEN =
961 DEFINE_MSGF("getinfo_vallen", 0,
962 sizeof(__u32), lustre_swab_generic_32s, NULL);
963 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
965 struct req_msg_field RMF_GETINFO_VAL =
966 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_GETINFO_VAL);
969 struct req_msg_field RMF_SEQ_OPC =
970 DEFINE_MSGF("seq_query_opc", 0,
971 sizeof(__u32), lustre_swab_generic_32s, NULL);
972 EXPORT_SYMBOL(RMF_SEQ_OPC);
974 struct req_msg_field RMF_SEQ_RANGE =
975 DEFINE_MSGF("seq_query_range", 0,
976 sizeof(struct lu_seq_range),
977 lustre_swab_lu_seq_range, NULL);
978 EXPORT_SYMBOL(RMF_SEQ_RANGE);
980 struct req_msg_field RMF_FLD_OPC =
981 DEFINE_MSGF("fld_query_opc", 0,
982 sizeof(__u32), lustre_swab_generic_32s, NULL);
983 EXPORT_SYMBOL(RMF_FLD_OPC);
985 struct req_msg_field RMF_FLD_MDFLD =
986 DEFINE_MSGF("fld_query_mdfld", 0,
987 sizeof(struct lu_seq_range),
988 lustre_swab_lu_seq_range, NULL);
989 EXPORT_SYMBOL(RMF_FLD_MDFLD);
991 struct req_msg_field RMF_MDT_BODY =
992 DEFINE_MSGF("mdt_body", 0,
993 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
994 EXPORT_SYMBOL(RMF_MDT_BODY);
996 struct req_msg_field RMF_OBD_QUOTACTL =
997 DEFINE_MSGFL("obd_quotactl",
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_FILE_ENCCTX =
1067 DEFINE_MSGF("file_encctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1068 EXPORT_SYMBOL(RMF_FILE_ENCCTX);
1070 struct req_msg_field RMF_LLOGD_BODY =
1071 DEFINE_MSGF("llogd_body", 0,
1072 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1073 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1075 struct req_msg_field RMF_LLOG_LOG_HDR =
1076 DEFINE_MSGF("llog_log_hdr", 0,
1077 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1078 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1080 struct req_msg_field RMF_LLOGD_CONN_BODY =
1081 DEFINE_MSGF("llogd_conn_body", 0,
1082 sizeof(struct llogd_conn_body),
1083 lustre_swab_llogd_conn_body, NULL);
1084 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1087 * connection handle received in MDS_CONNECT request.
1089 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1090 * that the client does not interpret at all.
1092 struct req_msg_field RMF_CONN =
1093 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1094 EXPORT_SYMBOL(RMF_CONN);
1096 struct req_msg_field RMF_CONNECT_DATA =
1097 DEFINE_MSGF("cdata",
1098 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1099 sizeof(struct obd_connect_data),
1100 lustre_swab_connect, NULL);
1101 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1103 struct req_msg_field RMF_DLM_REQ =
1104 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1105 sizeof(struct ldlm_request),
1106 lustre_swab_ldlm_request, NULL);
1107 EXPORT_SYMBOL(RMF_DLM_REQ);
1109 struct req_msg_field RMF_DLM_REP =
1110 DEFINE_MSGF("dlm_rep", 0,
1111 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1112 EXPORT_SYMBOL(RMF_DLM_REP);
1114 struct req_msg_field RMF_LDLM_INTENT =
1115 DEFINE_MSGF("ldlm_intent", 0,
1116 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1117 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1119 struct req_msg_field RMF_DLM_LVB =
1120 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1121 EXPORT_SYMBOL(RMF_DLM_LVB);
1123 struct req_msg_field RMF_DLM_GL_DESC =
1124 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1125 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1127 struct req_msg_field RMF_MDT_MD =
1128 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1129 EXPORT_SYMBOL(RMF_MDT_MD);
1131 struct req_msg_field RMF_DEFAULT_MDT_MD =
1132 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1134 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1136 struct req_msg_field RMF_REC_REINT =
1137 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1138 lustre_swab_mdt_rec_reint, NULL);
1139 EXPORT_SYMBOL(RMF_REC_REINT);
1141 /* FIXME: this length should be defined as a macro */
1142 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1144 EXPORT_SYMBOL(RMF_EADATA);
1146 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1147 EXPORT_SYMBOL(RMF_EAVALS);
1149 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1150 EXPORT_SYMBOL(RMF_ACL);
1152 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1153 struct req_msg_field RMF_LOGCOOKIES =
1154 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1155 sizeof(struct llog_cookie), NULL, NULL);
1156 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1158 struct req_msg_field RMF_CAPA1 =
1159 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1160 EXPORT_SYMBOL(RMF_CAPA1);
1162 struct req_msg_field RMF_CAPA2 =
1163 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1164 EXPORT_SYMBOL(RMF_CAPA2);
1166 struct req_msg_field RMF_LAYOUT_INTENT =
1167 DEFINE_MSGF("layout_intent", 0,
1168 sizeof(struct layout_intent), lustre_swab_layout_intent,
1170 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1172 struct req_msg_field RMF_SELINUX_POL =
1173 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1174 EXPORT_SYMBOL(RMF_SELINUX_POL);
1177 * OST request field.
1179 struct req_msg_field RMF_OST_BODY =
1180 DEFINE_MSGF("ost_body", 0,
1181 sizeof(struct ost_body), lustre_swab_ost_body,
1183 EXPORT_SYMBOL(RMF_OST_BODY);
1185 struct req_msg_field RMF_OBD_IOOBJ =
1186 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1187 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1188 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1190 struct req_msg_field RMF_NIOBUF_REMOTE =
1191 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1192 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1194 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1196 struct req_msg_field RMF_NIOBUF_INLINE =
1197 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1198 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1200 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1202 struct req_msg_field RMF_RCS =
1203 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1204 lustre_swab_generic_32s, dump_rcs);
1205 EXPORT_SYMBOL(RMF_RCS);
1207 struct req_msg_field RMF_EAVALS_LENS =
1208 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1209 lustre_swab_generic_32s, NULL);
1210 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1212 struct req_msg_field RMF_OBD_ID =
1213 DEFINE_MSGF("obd_id", 0,
1214 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1215 EXPORT_SYMBOL(RMF_OBD_ID);
1217 struct req_msg_field RMF_FID =
1218 DEFINE_MSGF("fid", 0,
1219 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1220 EXPORT_SYMBOL(RMF_FID);
1222 struct req_msg_field RMF_OST_ID =
1223 DEFINE_MSGF("ost_id", 0,
1224 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1225 EXPORT_SYMBOL(RMF_OST_ID);
1227 struct req_msg_field RMF_FIEMAP_KEY =
1228 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1229 lustre_swab_fiemap_info_key, NULL);
1230 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1232 struct req_msg_field RMF_FIEMAP_VAL =
1233 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1234 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1236 struct req_msg_field RMF_IDX_INFO =
1237 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1238 lustre_swab_idx_info, NULL);
1239 EXPORT_SYMBOL(RMF_IDX_INFO);
1240 struct req_msg_field RMF_SHORT_IO =
1241 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1242 EXPORT_SYMBOL(RMF_SHORT_IO);
1243 struct req_msg_field RMF_HSM_USER_STATE =
1244 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1245 lustre_swab_hsm_user_state, NULL);
1246 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1248 struct req_msg_field RMF_HSM_STATE_SET =
1249 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1250 lustre_swab_hsm_state_set, NULL);
1251 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1253 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1254 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1255 lustre_swab_hsm_progress_kernel, NULL);
1256 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1258 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1259 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1260 lustre_swab_hsm_current_action, NULL);
1261 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1263 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1264 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1265 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1267 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1269 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1270 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1271 sizeof(__u32), lustre_swab_generic_32s, NULL);
1272 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1274 struct req_msg_field RMF_MDS_HSM_REQUEST =
1275 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1276 lustre_swab_hsm_request, NULL);
1277 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1279 struct req_msg_field RMF_SWAP_LAYOUTS =
1280 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1281 lustre_swab_swap_layouts, NULL);
1282 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1284 struct req_msg_field RMF_LFSCK_REQUEST =
1285 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1286 lustre_swab_lfsck_request, NULL);
1287 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1289 struct req_msg_field RMF_LFSCK_REPLY =
1290 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1291 lustre_swab_lfsck_reply, NULL);
1292 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1294 struct req_msg_field RMF_OST_LADVISE_HDR =
1295 DEFINE_MSGF("ladvise_request", 0,
1296 sizeof(struct ladvise_hdr),
1297 lustre_swab_ladvise_hdr, NULL);
1298 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1300 struct req_msg_field RMF_OST_LADVISE =
1301 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1302 sizeof(struct lu_ladvise),
1303 lustre_swab_ladvise, NULL);
1304 EXPORT_SYMBOL(RMF_OST_LADVISE);
1311 const char *rf_name;
1315 const struct req_msg_field **d;
1316 } rf_fields[RCL_NR];
1319 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1333 #define DEFINE_REQ_FMT0(name, client, server) \
1334 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1336 struct req_format RQF_OBD_PING =
1337 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1338 EXPORT_SYMBOL(RQF_OBD_PING);
1340 struct req_format RQF_OBD_SET_INFO =
1341 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1342 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1344 struct req_format RQF_MDT_SET_INFO =
1345 DEFINE_REQ_FMT0("MDT_SET_INFO", mdt_set_info_client, empty);
1346 EXPORT_SYMBOL(RQF_MDT_SET_INFO);
1348 /* Read index file through the network */
1349 struct req_format RQF_OBD_IDX_READ =
1350 DEFINE_REQ_FMT0("OBD_IDX_READ",
1351 obd_idx_read_client, obd_idx_read_server);
1352 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1354 struct req_format RQF_SEC_CTX =
1355 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1356 EXPORT_SYMBOL(RQF_SEC_CTX);
1358 struct req_format RQF_MGS_TARGET_REG =
1359 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1360 mgs_target_info_only);
1361 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1363 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
1364 struct req_format RQF_MGS_SET_INFO =
1365 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1367 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1370 struct req_format RQF_MGS_CONFIG_READ =
1371 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1372 mgs_config_read_server);
1373 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1375 struct req_format RQF_SEQ_QUERY =
1376 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1377 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1379 struct req_format RQF_FLD_QUERY =
1380 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1381 EXPORT_SYMBOL(RQF_FLD_QUERY);
1383 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1384 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1385 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1386 * peers need to handle the RPC reply with fixed little-endian format.
1388 * In theory, we can define new structure with some swabber registered to
1389 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1390 * implementation view, it is not easy to be done within current "struct
1391 * req_msg_field" framework. Because the sequence range array in the RPC
1392 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1393 * count, that is unknown when prepare the RPC buffer. Generally, for such
1394 * flexible length RPC usage, there will be a field in the RPC layout to
1395 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1396 * do that unless we add new length filed that will broken the on-wire RPC
1397 * protocol and cause interoperability trouble with old peer. */
1398 struct req_format RQF_FLD_READ =
1399 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1400 EXPORT_SYMBOL(RQF_FLD_READ);
1402 struct req_format RQF_MDS_QUOTACTL =
1403 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1404 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1406 struct req_format RQF_OST_QUOTACTL =
1407 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1408 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1410 struct req_format RQF_QUOTA_DQACQ =
1411 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1412 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1414 struct req_format RQF_LDLM_INTENT_QUOTA =
1415 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1416 ldlm_intent_quota_client,
1417 ldlm_intent_quota_server);
1418 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1420 struct req_format RQF_MDS_GET_ROOT =
1421 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1422 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1424 struct req_format RQF_MDS_STATFS =
1425 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1426 EXPORT_SYMBOL(RQF_MDS_STATFS);
1428 struct req_format RQF_MDS_STATFS_NEW =
1429 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1430 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1432 struct req_format RQF_MDS_SYNC =
1433 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1434 EXPORT_SYMBOL(RQF_MDS_SYNC);
1436 struct req_format RQF_MDS_GETATTR =
1437 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1438 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1440 struct req_format RQF_MDS_GETXATTR =
1441 DEFINE_REQ_FMT0("MDS_GETXATTR",
1442 mds_getxattr_client, mds_getxattr_server);
1443 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1445 struct req_format RQF_MDS_GETATTR_NAME =
1446 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1447 mds_getattr_name_client, mds_getattr_server);
1448 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1450 struct req_format RQF_MDS_REINT =
1451 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1452 EXPORT_SYMBOL(RQF_MDS_REINT);
1454 struct req_format RQF_MDS_REINT_CREATE =
1455 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1456 mds_reint_create_client, mdt_body_capa);
1457 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1459 struct req_format RQF_MDS_REINT_CREATE_ACL =
1460 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1461 mds_reint_create_acl_client, mdt_body_capa);
1462 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1464 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1465 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1466 mds_reint_create_slave_client, mdt_body_capa);
1467 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1469 struct req_format RQF_MDS_REINT_CREATE_SYM =
1470 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1471 mds_reint_create_sym_client, mdt_body_capa);
1472 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1474 struct req_format RQF_MDS_REINT_OPEN =
1475 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1476 mds_reint_open_client, mds_reint_open_server);
1477 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1479 struct req_format RQF_MDS_REINT_UNLINK =
1480 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1481 mds_last_unlink_server);
1482 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1484 struct req_format RQF_MDS_REINT_LINK =
1485 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1486 mds_reint_link_client, mdt_body_only);
1487 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1489 struct req_format RQF_MDS_REINT_RENAME =
1490 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1491 mds_last_unlink_server);
1492 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1494 struct req_format RQF_MDS_REINT_MIGRATE =
1495 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1496 mds_last_unlink_server);
1497 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1499 struct req_format RQF_MDS_REINT_SETATTR =
1500 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1501 mds_reint_setattr_client, mds_setattr_server);
1502 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1504 struct req_format RQF_MDS_REINT_SETXATTR =
1505 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1506 mds_reint_setxattr_client, mdt_body_only);
1507 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1509 struct req_format RQF_MDS_REINT_RESYNC =
1510 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1511 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1513 struct req_format RQF_MDS_CONNECT =
1514 DEFINE_REQ_FMT0("MDS_CONNECT",
1515 obd_connect_client, obd_connect_server);
1516 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1518 struct req_format RQF_MDS_DISCONNECT =
1519 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1520 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1522 struct req_format RQF_MDS_GET_INFO =
1523 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1524 mds_getinfo_server);
1525 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1527 struct req_format RQF_LDLM_ENQUEUE =
1528 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1529 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1530 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1532 struct req_format RQF_LDLM_ENQUEUE_LVB =
1533 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1534 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1535 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1537 struct req_format RQF_LDLM_CONVERT =
1538 DEFINE_REQ_FMT0("LDLM_CONVERT",
1539 ldlm_enqueue_client, ldlm_enqueue_server);
1540 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1542 struct req_format RQF_LDLM_CANCEL =
1543 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1544 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1546 struct req_format RQF_LDLM_CALLBACK =
1547 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1548 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1550 struct req_format RQF_LDLM_CP_CALLBACK =
1551 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1552 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1554 struct req_format RQF_LDLM_BL_CALLBACK =
1555 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1556 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1558 struct req_format RQF_LDLM_GL_CALLBACK =
1559 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1560 ldlm_gl_callback_server);
1561 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1563 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1564 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1565 ldlm_gl_callback_server);
1566 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1568 struct req_format RQF_LDLM_INTENT_BASIC =
1569 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1570 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1571 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1573 struct req_format RQF_LDLM_INTENT =
1574 DEFINE_REQ_FMT0("LDLM_INTENT",
1575 ldlm_intent_client, ldlm_intent_server);
1576 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1578 struct req_format RQF_LDLM_INTENT_LAYOUT =
1579 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1580 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1581 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1583 struct req_format RQF_LDLM_INTENT_GETATTR =
1584 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1585 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1586 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1588 struct req_format RQF_LDLM_INTENT_OPEN =
1589 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1590 ldlm_intent_open_client, ldlm_intent_open_server);
1591 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1593 struct req_format RQF_LDLM_INTENT_CREATE =
1594 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1595 ldlm_intent_create_client, ldlm_intent_getattr_server);
1596 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1598 struct req_format RQF_LDLM_INTENT_GETXATTR =
1599 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1600 ldlm_intent_getxattr_client,
1601 ldlm_intent_getxattr_server);
1602 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1604 struct req_format RQF_MDS_CLOSE =
1605 DEFINE_REQ_FMT0("MDS_CLOSE",
1606 mdt_close_client, mds_last_unlink_server);
1607 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1609 struct req_format RQF_MDS_CLOSE_INTENT =
1610 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1611 mdt_close_intent_client, mds_last_unlink_server);
1612 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1614 struct req_format RQF_MDS_READPAGE =
1615 DEFINE_REQ_FMT0("MDS_READPAGE",
1616 mdt_body_capa, mdt_body_only);
1617 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1619 struct req_format RQF_MDS_HSM_ACTION =
1620 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1621 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1623 struct req_format RQF_MDS_HSM_PROGRESS =
1624 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1625 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1627 struct req_format RQF_MDS_HSM_CT_REGISTER =
1628 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1629 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1631 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1632 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1633 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1635 struct req_format RQF_MDS_HSM_STATE_GET =
1636 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1637 mdt_body_capa, mdt_hsm_state_get_server);
1638 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1640 struct req_format RQF_MDS_HSM_STATE_SET =
1641 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1642 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1644 struct req_format RQF_MDS_HSM_REQUEST =
1645 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1646 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1648 struct req_format RQF_MDS_SWAP_LAYOUTS =
1649 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1650 mdt_swap_layouts, empty);
1651 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1653 struct req_format RQF_MDS_RMFID =
1654 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1656 EXPORT_SYMBOL(RQF_MDS_RMFID);
1658 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1659 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1660 llog_origin_handle_create_client, llogd_body_only);
1661 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1663 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1664 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1665 llogd_body_only, llog_origin_handle_next_block_server);
1666 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1668 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1669 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1670 llogd_body_only, llog_origin_handle_next_block_server);
1671 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1673 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1674 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1675 llogd_body_only, llog_log_hdr_only);
1676 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1678 struct req_format RQF_CONNECT =
1679 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1680 EXPORT_SYMBOL(RQF_CONNECT);
1682 struct req_format RQF_OST_CONNECT =
1683 DEFINE_REQ_FMT0("OST_CONNECT",
1684 obd_connect_client, obd_connect_server);
1685 EXPORT_SYMBOL(RQF_OST_CONNECT);
1687 struct req_format RQF_OST_DISCONNECT =
1688 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1689 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1691 struct req_format RQF_OST_GETATTR =
1692 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1693 EXPORT_SYMBOL(RQF_OST_GETATTR);
1695 struct req_format RQF_OST_SETATTR =
1696 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1697 EXPORT_SYMBOL(RQF_OST_SETATTR);
1699 struct req_format RQF_OST_CREATE =
1700 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1701 EXPORT_SYMBOL(RQF_OST_CREATE);
1703 struct req_format RQF_OST_PUNCH =
1704 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1705 EXPORT_SYMBOL(RQF_OST_PUNCH);
1707 struct req_format RQF_OST_FALLOCATE =
1708 DEFINE_REQ_FMT0("OST_FALLOCATE", ost_body_capa, ost_body_only);
1709 EXPORT_SYMBOL(RQF_OST_FALLOCATE);
1711 struct req_format RQF_OST_SEEK =
1712 DEFINE_REQ_FMT0("OST_SEEK", ost_body_only, ost_body_only);
1713 EXPORT_SYMBOL(RQF_OST_SEEK);
1715 struct req_format RQF_OST_SYNC =
1716 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1717 EXPORT_SYMBOL(RQF_OST_SYNC);
1719 struct req_format RQF_OST_DESTROY =
1720 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1721 EXPORT_SYMBOL(RQF_OST_DESTROY);
1723 struct req_format RQF_OST_BRW_READ =
1724 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1725 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1727 struct req_format RQF_OST_BRW_WRITE =
1728 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1729 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1731 struct req_format RQF_OST_STATFS =
1732 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1733 EXPORT_SYMBOL(RQF_OST_STATFS);
1735 struct req_format RQF_OST_SET_GRANT_INFO =
1736 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1738 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1740 struct req_format RQF_OST_GET_INFO =
1741 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1742 ost_get_info_generic_server);
1743 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1745 struct req_format RQF_OST_GET_INFO_LAST_ID =
1746 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1747 ost_get_last_id_server);
1748 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1750 struct req_format RQF_OST_GET_INFO_LAST_FID =
1751 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1752 ost_get_last_fid_server);
1753 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1755 struct req_format RQF_OST_SET_INFO_LAST_FID =
1756 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1758 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1760 struct req_format RQF_OST_GET_INFO_FIEMAP =
1761 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1762 ost_get_fiemap_server);
1763 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1765 struct req_format RQF_LFSCK_NOTIFY =
1766 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1767 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1769 struct req_format RQF_LFSCK_QUERY =
1770 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1771 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1773 struct req_format RQF_OST_LADVISE =
1774 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1775 EXPORT_SYMBOL(RQF_OST_LADVISE);
1777 /* Convenience macro */
1778 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1781 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1782 * field of RQFs and the \a rmf_offset field of RMFs.
1784 int req_layout_init(void)
1789 struct req_format *rf = NULL;
1791 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1792 rf = req_formats[i];
1794 for (j = 0; j < RCL_NR; ++j) {
1795 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1796 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1797 struct req_msg_field *field;
1799 field = (typeof(field))rf->rf_fields[j].d[k];
1800 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1801 || field->rmf_size > 0);
1802 LASSERT(field->rmf_offset[i][j] == 0);
1804 * k + 1 to detect unused format/field
1807 field->rmf_offset[i][j] = k + 1;
1813 EXPORT_SYMBOL(req_layout_init);
1815 void req_layout_fini(void)
1818 EXPORT_SYMBOL(req_layout_fini);
1821 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1823 * Actual/expected field sizes are set elsewhere in functions in this file:
1824 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1825 * req_capsule_msg_size(). The \a rc_area information is used by.
1826 * ptlrpc_request_set_replen().
1828 void req_capsule_init_area(struct req_capsule *pill)
1832 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1833 pill->rc_area[RCL_CLIENT][i] = -1;
1834 pill->rc_area[RCL_SERVER][i] = -1;
1837 EXPORT_SYMBOL(req_capsule_init_area);
1840 * Initialize a pill.
1842 * The \a location indicates whether the caller is executing on the client side
1843 * (RCL_CLIENT) or server side (RCL_SERVER)..
1845 void req_capsule_init(struct req_capsule *pill,
1846 struct ptlrpc_request *req,
1847 enum req_location location)
1849 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1852 * Today all capsules are embedded in ptlrpc_request structs,
1853 * but just in case that ever isn't the case, we don't reach
1854 * into req unless req != NULL and pill is the one embedded in
1857 * The req->rq_pill_init flag makes it safe to initialize a pill
1858 * twice, which might happen in the OST paths as a result of the
1859 * high-priority RPC queue getting peeked at before ost_handle()
1860 * handles an OST RPC.
1862 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1865 memset(pill, 0, sizeof *pill);
1867 pill->rc_loc = location;
1868 req_capsule_init_area(pill);
1870 if (req != NULL && pill == &req->rq_pill)
1871 req->rq_pill_init = 1;
1873 EXPORT_SYMBOL(req_capsule_init);
1875 void req_capsule_fini(struct req_capsule *pill)
1878 EXPORT_SYMBOL(req_capsule_fini);
1880 static int __req_format_is_sane(const struct req_format *fmt)
1882 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1883 req_formats[fmt->rf_idx] == fmt;
1886 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1887 enum req_location loc)
1889 struct ptlrpc_request *req;
1892 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1896 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1897 * (see req_capsule_extend()).
1899 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1901 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1902 LASSERT(__req_format_is_sane(fmt));
1906 EXPORT_SYMBOL(req_capsule_set);
1909 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1912 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1913 * variable-sized fields. The field sizes come from the declared \a rmf_size
1914 * field of a \a pill's \a rc_fmt's RMF's.
1916 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1917 enum req_location loc)
1919 const struct req_format *fmt = pill->rc_fmt;
1922 LASSERT(fmt != NULL);
1924 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1925 if (pill->rc_area[loc][i] == -1) {
1926 pill->rc_area[loc][i] =
1927 fmt->rf_fields[loc].d[i]->rmf_size;
1928 if (pill->rc_area[loc][i] == -1) {
1930 * Skip the following fields.
1932 * If this LASSERT() trips then you're missing a
1933 * call to req_capsule_set_size().
1935 LASSERT(loc != RCL_SERVER);
1942 EXPORT_SYMBOL(req_capsule_filled_sizes);
1945 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1947 * This function uses the \a pill's \a rc_area as filled in by
1948 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1951 int req_capsule_server_pack(struct req_capsule *pill)
1953 const struct req_format *fmt;
1957 LASSERT(pill->rc_loc == RCL_SERVER);
1959 LASSERT(fmt != NULL);
1961 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1962 rc = lustre_pack_reply(pill->rc_req, count,
1963 pill->rc_area[RCL_SERVER], NULL);
1965 DEBUG_REQ(D_ERROR, pill->rc_req,
1966 "Cannot pack %d fields in format '%s'",
1967 count, fmt->rf_name);
1971 EXPORT_SYMBOL(req_capsule_server_pack);
1974 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1975 * corresponding to the given RMF (\a field).
1977 __u32 __req_capsule_offset(const struct req_capsule *pill,
1978 const struct req_msg_field *field,
1979 enum req_location loc)
1981 unsigned int offset;
1983 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1984 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1985 pill->rc_fmt->rf_name,
1986 field->rmf_name, offset, loc);
1989 LASSERT(offset < REQ_MAX_FIELD_NR);
1994 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1998 swabber_dumper_helper(struct req_capsule *pill,
1999 const struct req_msg_field *field,
2000 enum req_location loc,
2002 void *value, int len, bool dump, void (*swabber)(void *))
2010 bool inout = loc == RCL_CLIENT;
2011 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
2013 swabber = swabber ?: field->rmf_swabber;
2015 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
2016 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
2021 if (!field->rmf_dumper)
2025 * We're swabbing an array; swabber() swabs a single array element, so
2026 * swab every element.
2028 if (array && (len % field->rmf_size)) {
2029 static const struct req_msg_field *last_field;
2031 if (field != last_field) {
2032 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2033 field->rmf_name, len, field->rmf_size);
2037 /* For the non-array cases, the process of swab/dump/swab only
2038 * needs to be done once. (n = 1)
2041 len = field->rmf_size;
2042 for (p = value, i = 0, n = len / field->rmf_size;
2044 i++, p += field->rmf_size) {
2046 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2047 do_swab ? "unswabbed " : "",
2048 array ? "array " : "",
2049 field->rmf_name, i);
2050 field->rmf_dumper(p);
2058 if (!field->rmf_swab_len) {
2061 size = field->rmf_swab_len(p, len);
2070 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2071 array ? "array " : "", field->rmf_name, i);
2072 field->rmf_dumper(value);
2076 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2082 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2083 * corresponding to the given RMF (\a field).
2085 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2086 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2087 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2088 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2089 * element of the array swabbed.
2091 static void *__req_capsule_get(struct req_capsule *pill,
2092 const struct req_msg_field *field,
2093 enum req_location loc,
2094 void (*swabber)(void *),
2097 const struct req_format *fmt;
2098 struct lustre_msg *msg;
2103 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2105 static const char *rcl_names[RCL_NR] = {
2106 [RCL_CLIENT] = "client",
2107 [RCL_SERVER] = "server"
2110 LASSERT(pill != NULL);
2111 LASSERT(pill != LP_POISON);
2113 LASSERT(fmt != NULL);
2114 LASSERT(fmt != LP_POISON);
2115 LASSERT(__req_format_is_sane(fmt));
2117 offset = __req_capsule_offset(pill, field, loc);
2119 msg = __req_msg(pill, loc);
2120 LASSERT(msg != NULL);
2122 getter = (field->rmf_flags & RMF_F_STRING) ?
2123 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2125 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2127 * We've already asserted that field->rmf_size > 0 in
2128 * req_layout_init().
2130 len = lustre_msg_buflen(msg, offset);
2131 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2132 (len % field->rmf_size) != 0) {
2133 CERROR("%s: array field size mismatch "
2134 "%d modulo %u != 0 (%d)\n",
2135 field->rmf_name, len, field->rmf_size, loc);
2138 } else if (pill->rc_area[loc][offset] != -1) {
2139 len = pill->rc_area[loc][offset];
2141 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2143 value = getter(msg, offset, len);
2145 if (value == NULL) {
2146 DEBUG_REQ(D_ERROR, pill->rc_req,
2147 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2148 field->rmf_name, offset, lustre_msg_bufcount(msg),
2149 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2152 swabber_dumper_helper(pill, field, loc, offset, value, len,
2160 * Dump a request and/or reply
2162 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2164 const struct req_format *fmt;
2165 const struct req_msg_field *field;
2171 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2172 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2173 field = FMT_FIELD(fmt, loc, i);
2174 if (field->rmf_dumper == NULL) {
2176 * FIXME Add a default hex dumper for fields that don't
2177 * have a specific dumper
2179 len = req_capsule_get_size(pill, field, loc);
2181 "Field %s has no dumper function; field size is %u\n",
2182 field->rmf_name, len);
2184 /* It's dumping side-effect that we're interested in */
2185 (void) __req_capsule_get(pill, field, loc, NULL, true);
2188 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2194 void req_capsule_client_dump(struct req_capsule *pill)
2196 __req_capsule_dump(pill, RCL_CLIENT);
2198 EXPORT_SYMBOL(req_capsule_client_dump);
2203 void req_capsule_server_dump(struct req_capsule *pill)
2205 __req_capsule_dump(pill, RCL_SERVER);
2207 EXPORT_SYMBOL(req_capsule_server_dump);
2210 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2211 * buffer corresponding to the given RMF (\a field) of a \a pill.
2213 void *req_capsule_client_get(struct req_capsule *pill,
2214 const struct req_msg_field *field)
2216 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2218 EXPORT_SYMBOL(req_capsule_client_get);
2221 * Same as req_capsule_client_get(), but with a \a swabber argument.
2223 * Currently unused; will be removed when req_capsule_server_swab_get() is
2226 void *req_capsule_client_swab_get(struct req_capsule *pill,
2227 const struct req_msg_field *field,
2230 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2232 EXPORT_SYMBOL(req_capsule_client_swab_get);
2235 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2237 * First the \a pill's request \a field's size is set (\a rc_area) using
2238 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2241 void *req_capsule_client_sized_get(struct req_capsule *pill,
2242 const struct req_msg_field *field,
2245 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2246 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2248 EXPORT_SYMBOL(req_capsule_client_sized_get);
2251 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2252 * buffer corresponding to the given RMF (\a field) of a \a pill.
2254 void *req_capsule_server_get(struct req_capsule *pill,
2255 const struct req_msg_field *field)
2257 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2259 EXPORT_SYMBOL(req_capsule_server_get);
2262 * Same as req_capsule_server_get(), but with a \a swabber argument.
2264 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2265 * swabbing done outside this capsule abstraction.
2267 void *req_capsule_server_swab_get(struct req_capsule *pill,
2268 const struct req_msg_field *field,
2271 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2273 EXPORT_SYMBOL(req_capsule_server_swab_get);
2276 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2278 * First the \a pill's request \a field's size is set (\a rc_area) using
2279 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2282 void *req_capsule_server_sized_get(struct req_capsule *pill,
2283 const struct req_msg_field *field,
2286 req_capsule_set_size(pill, field, RCL_SERVER, len);
2287 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2289 EXPORT_SYMBOL(req_capsule_server_sized_get);
2291 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2292 const struct req_msg_field *field,
2293 __u32 len, void *swabber)
2295 req_capsule_set_size(pill, field, RCL_SERVER, len);
2296 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2298 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2301 * Returns the buffer of a \a pill corresponding to the given \a field from the
2302 * request (if the caller is executing on the server-side) or reply (if the
2303 * caller is executing on the client-side).
2305 * This function convienient for use is code that could be executed on the
2306 * client and server alike.
2308 const void *req_capsule_other_get(struct req_capsule *pill,
2309 const struct req_msg_field *field)
2311 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2313 EXPORT_SYMBOL(req_capsule_other_get);
2316 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2317 * field of the given \a pill.
2319 * This function must be used when constructing variable sized fields of a
2322 void req_capsule_set_size(struct req_capsule *pill,
2323 const struct req_msg_field *field,
2324 enum req_location loc, __u32 size)
2326 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2328 if ((size != (__u32)field->rmf_size) &&
2329 (field->rmf_size != -1) &&
2330 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2332 __u32 rmf_size = (__u32)field->rmf_size;
2333 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2334 (size % rmf_size != 0)) {
2335 CERROR("%s: array field size mismatch "
2336 "%u %% %u != 0 (%d)\n",
2337 field->rmf_name, size, rmf_size, loc);
2339 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2341 CERROR("%s: field size mismatch %u != %u (%d)\n",
2342 field->rmf_name, size, rmf_size, loc);
2347 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2349 EXPORT_SYMBOL(req_capsule_set_size);
2352 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2353 * for the given \a pill's given \a field.
2355 * NB: this function doesn't correspond with req_capsule_set_size(), which
2356 * actually sets the size in pill.rc_area[loc][offset], but this function
2357 * returns the message buflen[offset], maybe we should use another name.
2359 __u32 req_capsule_get_size(const struct req_capsule *pill,
2360 const struct req_msg_field *field,
2361 enum req_location loc)
2363 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2365 return lustre_msg_buflen(__req_msg(pill, loc),
2366 __req_capsule_offset(pill, field, loc));
2368 EXPORT_SYMBOL(req_capsule_get_size);
2371 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2372 * given \a pill's request or reply (\a loc) given the field size recorded in
2373 * the \a pill's rc_area.
2375 * See also req_capsule_set_size().
2377 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2379 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2380 pill->rc_fmt->rf_fields[loc].nr,
2381 pill->rc_area[loc]);
2385 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2386 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2387 * PTLRPC request or reply given only an RQF (\a fmt).
2389 * This function should not be used for formats which contain variable size
2392 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2393 enum req_location loc)
2399 * This function should probably LASSERT() that fmt has no fields with
2400 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2401 * elements in the array there will ultimately be, but then, we could
2402 * assume that there will be at least one element, and that's just what
2405 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2409 for (; i < fmt->rf_fields[loc].nr; ++i)
2410 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2411 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2415 EXPORT_SYMBOL(req_capsule_fmt_size);
2418 * Changes the format of an RPC.
2420 * The pill must already have been initialized, which means that it already has
2421 * a request format. The new format \a fmt must be an extension of the pill's
2422 * old format. Specifically: the new format must have as many request and reply
2423 * fields as the old one, and all fields shared by the old and new format must
2424 * be at least as large in the new format.
2426 * The new format's fields may be of different "type" than the old format, but
2427 * only for fields that are "opaque" blobs: fields which have a) have no
2428 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2429 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2430 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2431 * according to the key field. When the value, according to the key, contains a
2432 * structure (or array thereof) to be swabbed, the format should be changed to
2433 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2436 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2441 const struct req_format *old;
2443 LASSERT(pill->rc_fmt != NULL);
2444 LASSERT(__req_format_is_sane(fmt));
2448 * Sanity checking...
2450 for (i = 0; i < RCL_NR; ++i) {
2451 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2452 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2453 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2455 /* "opaque" fields can be transmogrified */
2456 if (ofield->rmf_swabber == NULL &&
2457 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2458 (ofield->rmf_size == -1 ||
2459 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2461 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2464 * Last field in old format can be shorter than in new.
2466 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2467 FMT_FIELD(old, i, j)->rmf_size);
2472 EXPORT_SYMBOL(req_capsule_extend);
2475 * This function returns a non-zero value if the given \a field is present in
2476 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2479 int req_capsule_has_field(const struct req_capsule *pill,
2480 const struct req_msg_field *field,
2481 enum req_location loc)
2483 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2485 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2487 EXPORT_SYMBOL(req_capsule_has_field);
2490 * Returns a non-zero value if the given \a field is present in the given \a
2491 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2493 int req_capsule_field_present(const struct req_capsule *pill,
2494 const struct req_msg_field *field,
2495 enum req_location loc)
2499 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2500 LASSERT(req_capsule_has_field(pill, field, loc));
2502 offset = __req_capsule_offset(pill, field, loc);
2503 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2505 EXPORT_SYMBOL(req_capsule_field_present);
2508 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2509 * request or reply (\a loc).
2511 * This is not the opposite of req_capsule_extend().
2513 void req_capsule_shrink(struct req_capsule *pill,
2514 const struct req_msg_field *field,
2516 enum req_location loc)
2518 const struct req_format *fmt;
2519 struct lustre_msg *msg;
2524 LASSERT(fmt != NULL);
2525 LASSERT(__req_format_is_sane(fmt));
2526 LASSERT(req_capsule_has_field(pill, field, loc));
2527 LASSERT(req_capsule_field_present(pill, field, loc));
2529 offset = __req_capsule_offset(pill, field, loc);
2531 msg = __req_msg(pill, loc);
2532 len = lustre_msg_buflen(msg, offset);
2533 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2534 fmt->rf_name, field->rmf_name, len, newlen);
2536 if (loc == RCL_CLIENT) {
2537 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2540 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2542 /* update also field size in reply lenghts arrays for possible
2543 * reply re-pack due to req_capsule_server_grow() call.
2545 req_capsule_set_size(pill, field, loc, newlen);
2548 EXPORT_SYMBOL(req_capsule_shrink);
2550 int req_capsule_server_grow(struct req_capsule *pill,
2551 const struct req_msg_field *field,
2554 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2559 LASSERT(pill->rc_fmt != NULL);
2560 LASSERT(__req_format_is_sane(pill->rc_fmt));
2561 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2562 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2564 len = req_capsule_get_size(pill, field, RCL_SERVER);
2565 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2567 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2568 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2571 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2573 * There can be enough space in current reply buffer, make sure
2574 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2575 * re-packing is still needed.
2577 if (rs->rs_msg == rs->rs_repbuf &&
2578 rs->rs_repbuf_len >=
2579 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2580 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2585 /* Re-allocate replay state */
2586 pill->rc_req->rq_reply_state = NULL;
2587 rc = req_capsule_server_pack(pill);
2589 /* put old values back, the caller should decide what to do */
2590 req_capsule_set_size(pill, field, RCL_SERVER, len);
2591 pill->rc_req->rq_reply_state = rs;
2594 nrs = pill->rc_req->rq_reply_state;
2595 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2596 lustre_packed_msg_size(rs->rs_msg));
2598 /* Now we need only buffers, copy them and grow the needed one */
2599 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2600 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2602 (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from);
2603 lustre_msg_set_buflen(nrs->rs_msg, offset, len);
2604 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2606 if (rs->rs_difficult) {
2610 nrs->rs_difficult = 1;
2611 nrs->rs_no_ack = rs->rs_no_ack;
2612 nrs->rs_convert_lock = rs->rs_convert_lock;
2613 for (i = 0; i < rs->rs_nlocks; i++) {
2614 nrs->rs_locks[i] = rs->rs_locks[i];
2615 nrs->rs_modes[i] = rs->rs_modes[i];
2619 rs->rs_difficult = 0;
2622 ptlrpc_rs_decref(rs);
2625 EXPORT_SYMBOL(req_capsule_server_grow);
2627 #ifdef HAVE_SERVER_SUPPORT
2628 static const struct req_msg_field *mds_update_client[] = {
2630 &RMF_OUT_UPDATE_HEADER,
2631 &RMF_OUT_UPDATE_BUF,
2634 static const struct req_msg_field *mds_update_server[] = {
2636 &RMF_OUT_UPDATE_REPLY,
2639 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
2640 lustre_swab_object_update_request, NULL);
2641 EXPORT_SYMBOL(RMF_OUT_UPDATE);
2643 struct req_msg_field RMF_OUT_UPDATE_REPLY =
2644 DEFINE_MSGFL("object_update_reply", 0, -1,
2645 lustre_swab_object_update_reply, NULL);
2646 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
2648 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
2649 -1, lustre_swab_out_update_header, NULL);
2650 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
2652 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
2653 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
2654 lustre_swab_out_update_buffer, NULL);
2655 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
2657 struct req_format RQF_OUT_UPDATE =
2658 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
2660 EXPORT_SYMBOL(RQF_OUT_UPDATE);
2662 int req_check_sepol(struct req_capsule *pill)
2665 struct obd_export *export;
2666 struct lu_nodemap *nm = NULL;
2667 const char *sepol = NULL;
2668 const char *nm_sepol = NULL;
2673 export = pill->rc_req->rq_export;
2674 if (!export || !exp_connect_sepol(export) ||
2675 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2678 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2681 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2682 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2686 nm = nodemap_get_from_exp(export);
2687 if (!IS_ERR_OR_NULL(nm)) {
2688 nm_sepol = nodemap_get_sepol(nm);
2689 if (nm_sepol && nm_sepol[0])
2690 if (sepol == NULL ||
2691 strcmp(sepol, nm_sepol) != 0)
2696 if (!IS_ERR_OR_NULL(nm))
2701 EXPORT_SYMBOL(req_check_sepol);