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 static const struct req_msg_field *mgs_config_read_client[] = {
79 static const struct req_msg_field *mgs_config_read_server[] = {
84 static const struct req_msg_field *mdt_body_only[] = {
89 static const struct req_msg_field *mdt_body_capa[] = {
95 static const struct req_msg_field *quotactl_only[] = {
100 static const struct req_msg_field *quota_body_only[] = {
105 static const struct req_msg_field *ldlm_intent_quota_client[] = {
112 static const struct req_msg_field *ldlm_intent_quota_server[] = {
119 static const struct req_msg_field *mdt_close_client[] = {
126 static const struct req_msg_field *mdt_close_intent_client[] = {
135 static const struct req_msg_field *obd_statfs_server[] = {
140 static const struct req_msg_field *seq_query_client[] = {
146 static const struct req_msg_field *seq_query_server[] = {
151 static const struct req_msg_field *fld_query_client[] = {
157 static const struct req_msg_field *fld_query_server[] = {
162 static const struct req_msg_field *fld_read_client[] = {
167 static const struct req_msg_field *fld_read_server[] = {
172 static const struct req_msg_field *mds_getattr_name_client[] = {
179 static const struct req_msg_field *mds_reint_client[] = {
184 static const struct req_msg_field *mds_reint_create_client[] = {
191 static const struct req_msg_field *mds_reint_create_slave_client[] = {
200 static const struct req_msg_field *mds_reint_create_acl_client[] = {
207 &RMF_FILE_SECCTX_NAME,
212 static const struct req_msg_field *mds_reint_create_sym_client[] = {
219 &RMF_FILE_SECCTX_NAME,
224 static const struct req_msg_field *mds_reint_open_client[] = {
231 &RMF_FILE_SECCTX_NAME,
236 static const struct req_msg_field *mds_reint_open_server[] = {
245 static const struct req_msg_field *mds_reint_unlink_client[] = {
254 static const struct req_msg_field *mds_reint_link_client[] = {
264 static const struct req_msg_field *mds_reint_rename_client[] = {
275 static const struct req_msg_field *mds_reint_migrate_client[] = {
289 static const struct req_msg_field *mds_last_unlink_server[] = {
298 static const struct req_msg_field *mds_reint_setattr_client[] = {
308 static const struct req_msg_field *mds_reint_setxattr_client[] = {
318 static const struct req_msg_field *mds_reint_resync[] = {
324 static const struct req_msg_field *mdt_swap_layouts[] = {
333 static const struct req_msg_field *mds_rmfid_client[] = {
341 static const struct req_msg_field *mds_rmfid_server[] = {
348 static const struct req_msg_field *obd_connect_client[] = {
357 static const struct req_msg_field *obd_connect_server[] = {
362 static const struct req_msg_field *obd_set_info_client[] = {
368 static const struct req_msg_field *ost_grant_shrink_client[] = {
374 static const struct req_msg_field *mds_getinfo_client[] = {
380 static const struct req_msg_field *mds_getinfo_server[] = {
385 static const struct req_msg_field *ldlm_enqueue_client[] = {
390 static const struct req_msg_field *ldlm_enqueue_server[] = {
395 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
401 static const struct req_msg_field *ldlm_cp_callback_client[] = {
407 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
413 static const struct req_msg_field *ldlm_gl_callback_server[] = {
418 static const struct req_msg_field *ldlm_intent_basic_client[] = {
424 static const struct req_msg_field *ldlm_intent_client[] = {
431 static const struct req_msg_field *ldlm_intent_server[] = {
439 static const struct req_msg_field *ldlm_intent_layout_client[] = {
444 &RMF_EADATA /* for new layout to be set up */
447 static const struct req_msg_field *ldlm_intent_open_server[] = {
459 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
463 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
466 &RMF_FILE_SECCTX_NAME
469 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
480 static const struct req_msg_field *ldlm_intent_create_client[] = {
484 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
488 &RMF_FILE_SECCTX_NAME,
493 static const struct req_msg_field *ldlm_intent_open_client[] = {
497 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
502 &RMF_FILE_SECCTX_NAME,
507 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
516 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
521 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
527 static const struct req_msg_field *mds_get_root_client[] = {
533 static const struct req_msg_field *mds_getxattr_client[] = {
542 static const struct req_msg_field *mds_getxattr_server[] = {
548 static const struct req_msg_field *mds_getattr_server[] = {
557 static const struct req_msg_field *mds_setattr_server[] = {
566 static const struct req_msg_field *mds_update_client[] = {
568 &RMF_OUT_UPDATE_HEADER,
572 static const struct req_msg_field *mds_update_server[] = {
574 &RMF_OUT_UPDATE_REPLY,
577 static const struct req_msg_field *llog_origin_handle_create_client[] = {
583 static const struct req_msg_field *llogd_body_only[] = {
588 static const struct req_msg_field *llog_log_hdr_only[] = {
593 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
599 static const struct req_msg_field *obd_idx_read_client[] = {
604 static const struct req_msg_field *obd_idx_read_server[] = {
609 static const struct req_msg_field *ost_body_only[] = {
614 static const struct req_msg_field *ost_body_capa[] = {
620 static const struct req_msg_field *ost_destroy_client[] = {
628 static const struct req_msg_field *ost_brw_client[] = {
637 static const struct req_msg_field *ost_brw_read_server[] = {
643 static const struct req_msg_field *ost_brw_write_server[] = {
649 static const struct req_msg_field *ost_get_info_generic_server[] = {
654 static const struct req_msg_field *ost_get_info_generic_client[] = {
659 static const struct req_msg_field *ost_get_last_id_server[] = {
664 static const struct req_msg_field *ost_get_last_fid_client[] = {
670 static const struct req_msg_field *ost_get_last_fid_server[] = {
675 static const struct req_msg_field *ost_get_fiemap_client[] = {
681 static const struct req_msg_field *ost_ladvise[] = {
684 &RMF_OST_LADVISE_HDR,
688 static const struct req_msg_field *ost_get_fiemap_server[] = {
693 static const struct req_msg_field *mdt_hsm_progress[] = {
696 &RMF_MDS_HSM_PROGRESS,
699 static const struct req_msg_field *mdt_hsm_ct_register[] = {
702 &RMF_MDS_HSM_ARCHIVE,
705 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
710 static const struct req_msg_field *mdt_hsm_action_server[] = {
713 &RMF_MDS_HSM_CURRENT_ACTION,
716 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
722 static const struct req_msg_field *mdt_hsm_state_set[] = {
729 static const struct req_msg_field *mdt_hsm_request[] = {
732 &RMF_MDS_HSM_REQUEST,
733 &RMF_MDS_HSM_USER_ITEM,
737 static const struct req_msg_field *obd_lfsck_request[] = {
742 static const struct req_msg_field *obd_lfsck_reply[] = {
747 static struct req_format *req_formats[] = {
753 &RQF_MGS_CONFIG_READ,
764 &RQF_MDS_GETATTR_NAME,
768 &RQF_MDS_CLOSE_INTENT,
771 &RQF_MDS_REINT_CREATE,
772 &RQF_MDS_REINT_CREATE_ACL,
773 &RQF_MDS_REINT_CREATE_SLAVE,
774 &RQF_MDS_REINT_CREATE_SYM,
776 &RQF_MDS_REINT_UNLINK,
778 &RQF_MDS_REINT_RENAME,
779 &RQF_MDS_REINT_MIGRATE,
780 &RQF_MDS_REINT_SETATTR,
781 &RQF_MDS_REINT_SETXATTR,
782 &RQF_MDS_REINT_RESYNC,
784 &RQF_MDS_HSM_PROGRESS,
785 &RQF_MDS_HSM_CT_REGISTER,
786 &RQF_MDS_HSM_CT_UNREGISTER,
787 &RQF_MDS_HSM_STATE_GET,
788 &RQF_MDS_HSM_STATE_SET,
790 &RQF_MDS_HSM_REQUEST,
791 &RQF_MDS_SWAP_LAYOUTS,
806 &RQF_OST_SET_GRANT_INFO,
808 &RQF_OST_GET_INFO_LAST_ID,
809 &RQF_OST_GET_INFO_LAST_FID,
810 &RQF_OST_SET_INFO_LAST_FID,
811 &RQF_OST_GET_INFO_FIEMAP,
814 &RQF_LDLM_ENQUEUE_LVB,
818 &RQF_LDLM_CP_CALLBACK,
819 &RQF_LDLM_BL_CALLBACK,
820 &RQF_LDLM_GL_CALLBACK,
821 &RQF_LDLM_GL_CALLBACK_DESC,
823 &RQF_LDLM_INTENT_BASIC,
824 &RQF_LDLM_INTENT_LAYOUT,
825 &RQF_LDLM_INTENT_GETATTR,
826 &RQF_LDLM_INTENT_OPEN,
827 &RQF_LDLM_INTENT_CREATE,
828 &RQF_LDLM_INTENT_GETXATTR,
829 &RQF_LDLM_INTENT_QUOTA,
831 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
832 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
833 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
834 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
840 struct req_msg_field {
841 const __u32 rmf_flags;
842 const char *rmf_name;
844 * Field length. (-1) means "variable length". If the
845 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
846 * but the actual size must be a whole multiple of \a rmf_size.
849 void (*rmf_swabber)(void *);
851 * Pass buffer size to swabbing function
852 * \retval > 0 the number of bytes swabbed
853 * -EOVERFLOW on error
855 int (*rmf_swab_len)(void *, __u32);
856 void (*rmf_dumper)(void *);
857 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
862 * The field is a string, must be NUL-terminated.
864 RMF_F_STRING = 1 << 0,
866 * The field's buffer size need not match the declared \a rmf_size.
868 RMF_F_NO_SIZE_CHECK = 1 << 1,
870 * The field's buffer size must be a whole multiple of the declared \a
871 * rmf_size and the \a rmf_swabber function must work on the declared \a
872 * rmf_size worth of bytes.
874 RMF_F_STRUCT_ARRAY = 1 << 2
882 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
883 .rmf_name = (name), \
884 .rmf_flags = (flags), \
885 .rmf_size = (size), \
886 .rmf_swabber = (void (*)(void*))(swabber), \
887 .rmf_dumper = (void (*)(void*))(dumper) \
890 #define DEFINE_MSGFL(name, flags, size, swab_len, dumper) { \
891 .rmf_name = (name), \
892 .rmf_flags = (flags), \
893 .rmf_size = (size), \
894 .rmf_swab_len = (int (*)(void *, __u32))(swab_len), \
895 .rmf_dumper = (void (*)(void *))(dumper) \
898 struct req_msg_field RMF_GENERIC_DATA =
899 DEFINE_MSGF("generic_data", 0,
901 EXPORT_SYMBOL(RMF_GENERIC_DATA);
903 struct req_msg_field RMF_MGS_TARGET_INFO =
904 DEFINE_MSGF("mgs_target_info", 0,
905 sizeof(struct mgs_target_info),
906 lustre_swab_mgs_target_info, NULL);
907 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
909 struct req_msg_field RMF_MGS_CONFIG_BODY =
910 DEFINE_MSGF("mgs_config_read request", 0,
911 sizeof(struct mgs_config_body),
912 lustre_swab_mgs_config_body, NULL);
913 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
915 struct req_msg_field RMF_MGS_CONFIG_RES =
916 DEFINE_MSGF("mgs_config_read reply ", 0,
917 sizeof(struct mgs_config_res),
918 lustre_swab_mgs_config_res, NULL);
919 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
921 struct req_msg_field RMF_U32 =
922 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
923 sizeof(__u32), lustre_swab_generic_32s, NULL);
924 EXPORT_SYMBOL(RMF_U32);
926 struct req_msg_field RMF_SETINFO_VAL =
927 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
928 EXPORT_SYMBOL(RMF_SETINFO_VAL);
930 struct req_msg_field RMF_GETINFO_KEY =
931 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
932 EXPORT_SYMBOL(RMF_GETINFO_KEY);
934 struct req_msg_field RMF_GETINFO_VALLEN =
935 DEFINE_MSGF("getinfo_vallen", 0,
936 sizeof(__u32), lustre_swab_generic_32s, NULL);
937 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
939 struct req_msg_field RMF_GETINFO_VAL =
940 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
941 EXPORT_SYMBOL(RMF_GETINFO_VAL);
943 struct req_msg_field RMF_SEQ_OPC =
944 DEFINE_MSGF("seq_query_opc", 0,
945 sizeof(__u32), lustre_swab_generic_32s, NULL);
946 EXPORT_SYMBOL(RMF_SEQ_OPC);
948 struct req_msg_field RMF_SEQ_RANGE =
949 DEFINE_MSGF("seq_query_range", 0,
950 sizeof(struct lu_seq_range),
951 lustre_swab_lu_seq_range, NULL);
952 EXPORT_SYMBOL(RMF_SEQ_RANGE);
954 struct req_msg_field RMF_FLD_OPC =
955 DEFINE_MSGF("fld_query_opc", 0,
956 sizeof(__u32), lustre_swab_generic_32s, NULL);
957 EXPORT_SYMBOL(RMF_FLD_OPC);
959 struct req_msg_field RMF_FLD_MDFLD =
960 DEFINE_MSGF("fld_query_mdfld", 0,
961 sizeof(struct lu_seq_range),
962 lustre_swab_lu_seq_range, NULL);
963 EXPORT_SYMBOL(RMF_FLD_MDFLD);
965 struct req_msg_field RMF_MDT_BODY =
966 DEFINE_MSGF("mdt_body", 0,
967 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
968 EXPORT_SYMBOL(RMF_MDT_BODY);
970 struct req_msg_field RMF_OBD_QUOTACTL =
971 DEFINE_MSGF("obd_quotactl", 0,
972 sizeof(struct obd_quotactl),
973 lustre_swab_obd_quotactl, NULL);
974 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
976 struct req_msg_field RMF_QUOTA_BODY =
977 DEFINE_MSGF("quota_body", 0,
978 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
979 EXPORT_SYMBOL(RMF_QUOTA_BODY);
981 struct req_msg_field RMF_MDT_EPOCH =
982 DEFINE_MSGF("mdt_ioepoch", 0,
983 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
984 EXPORT_SYMBOL(RMF_MDT_EPOCH);
986 struct req_msg_field RMF_PTLRPC_BODY =
987 DEFINE_MSGF("ptlrpc_body", 0,
988 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
989 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
991 struct req_msg_field RMF_CLOSE_DATA =
992 DEFINE_MSGF("data_version", 0,
993 sizeof(struct close_data), lustre_swab_close_data, NULL);
994 EXPORT_SYMBOL(RMF_CLOSE_DATA);
996 struct req_msg_field RMF_OBD_STATFS =
997 DEFINE_MSGF("obd_statfs", 0,
998 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
999 EXPORT_SYMBOL(RMF_OBD_STATFS);
1001 struct req_msg_field RMF_SETINFO_KEY =
1002 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1003 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1005 struct req_msg_field RMF_NAME =
1006 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1007 EXPORT_SYMBOL(RMF_NAME);
1009 struct req_msg_field RMF_FID_ARRAY =
1010 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1011 EXPORT_SYMBOL(RMF_FID_ARRAY);
1013 struct req_msg_field RMF_SYMTGT =
1014 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
1015 EXPORT_SYMBOL(RMF_SYMTGT);
1017 struct req_msg_field RMF_TGTUUID =
1018 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1020 EXPORT_SYMBOL(RMF_TGTUUID);
1022 struct req_msg_field RMF_CLUUID =
1023 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1025 EXPORT_SYMBOL(RMF_CLUUID);
1027 struct req_msg_field RMF_STRING =
1028 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1029 EXPORT_SYMBOL(RMF_STRING);
1031 struct req_msg_field RMF_FILE_SECCTX_NAME =
1032 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1033 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1035 struct req_msg_field RMF_FILE_SECCTX =
1036 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1037 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1039 struct req_msg_field RMF_LLOGD_BODY =
1040 DEFINE_MSGF("llogd_body", 0,
1041 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1042 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1044 struct req_msg_field RMF_LLOG_LOG_HDR =
1045 DEFINE_MSGF("llog_log_hdr", 0,
1046 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1047 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1049 struct req_msg_field RMF_LLOGD_CONN_BODY =
1050 DEFINE_MSGF("llogd_conn_body", 0,
1051 sizeof(struct llogd_conn_body),
1052 lustre_swab_llogd_conn_body, NULL);
1053 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1056 * connection handle received in MDS_CONNECT request.
1058 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1059 * that the client does not interpret at all.
1061 struct req_msg_field RMF_CONN =
1062 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1063 EXPORT_SYMBOL(RMF_CONN);
1065 struct req_msg_field RMF_CONNECT_DATA =
1066 DEFINE_MSGF("cdata",
1067 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1068 sizeof(struct obd_connect_data),
1069 lustre_swab_connect, NULL);
1070 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1072 struct req_msg_field RMF_DLM_REQ =
1073 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1074 sizeof(struct ldlm_request),
1075 lustre_swab_ldlm_request, NULL);
1076 EXPORT_SYMBOL(RMF_DLM_REQ);
1078 struct req_msg_field RMF_DLM_REP =
1079 DEFINE_MSGF("dlm_rep", 0,
1080 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1081 EXPORT_SYMBOL(RMF_DLM_REP);
1083 struct req_msg_field RMF_LDLM_INTENT =
1084 DEFINE_MSGF("ldlm_intent", 0,
1085 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1086 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1088 struct req_msg_field RMF_DLM_LVB =
1089 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1090 EXPORT_SYMBOL(RMF_DLM_LVB);
1092 struct req_msg_field RMF_DLM_GL_DESC =
1093 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1094 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1096 struct req_msg_field RMF_MDT_MD =
1097 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1098 EXPORT_SYMBOL(RMF_MDT_MD);
1100 struct req_msg_field RMF_DEFAULT_MDT_MD =
1101 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1103 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1105 struct req_msg_field RMF_REC_REINT =
1106 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1107 lustre_swab_mdt_rec_reint, NULL);
1108 EXPORT_SYMBOL(RMF_REC_REINT);
1110 /* FIXME: this length should be defined as a macro */
1111 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1113 EXPORT_SYMBOL(RMF_EADATA);
1115 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1116 EXPORT_SYMBOL(RMF_EAVALS);
1118 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1119 EXPORT_SYMBOL(RMF_ACL);
1121 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1122 struct req_msg_field RMF_LOGCOOKIES =
1123 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1124 sizeof(struct llog_cookie), NULL, NULL);
1125 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1127 struct req_msg_field RMF_CAPA1 =
1128 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1129 EXPORT_SYMBOL(RMF_CAPA1);
1131 struct req_msg_field RMF_CAPA2 =
1132 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1133 EXPORT_SYMBOL(RMF_CAPA2);
1135 struct req_msg_field RMF_LAYOUT_INTENT =
1136 DEFINE_MSGF("layout_intent", 0,
1137 sizeof(struct layout_intent), lustre_swab_layout_intent,
1139 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1141 struct req_msg_field RMF_SELINUX_POL =
1142 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1143 EXPORT_SYMBOL(RMF_SELINUX_POL);
1146 * OST request field.
1148 struct req_msg_field RMF_OST_BODY =
1149 DEFINE_MSGF("ost_body", 0,
1150 sizeof(struct ost_body), lustre_swab_ost_body,
1152 EXPORT_SYMBOL(RMF_OST_BODY);
1154 struct req_msg_field RMF_OBD_IOOBJ =
1155 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1156 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1157 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1159 struct req_msg_field RMF_NIOBUF_REMOTE =
1160 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1161 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1163 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1165 struct req_msg_field RMF_NIOBUF_INLINE =
1166 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1167 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1169 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1171 struct req_msg_field RMF_RCS =
1172 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1173 lustre_swab_generic_32s, dump_rcs);
1174 EXPORT_SYMBOL(RMF_RCS);
1176 struct req_msg_field RMF_EAVALS_LENS =
1177 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1178 lustre_swab_generic_32s, NULL);
1179 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1181 struct req_msg_field RMF_OBD_ID =
1182 DEFINE_MSGF("obd_id", 0,
1183 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1184 EXPORT_SYMBOL(RMF_OBD_ID);
1186 struct req_msg_field RMF_FID =
1187 DEFINE_MSGF("fid", 0,
1188 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1189 EXPORT_SYMBOL(RMF_FID);
1191 struct req_msg_field RMF_OST_ID =
1192 DEFINE_MSGF("ost_id", 0,
1193 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1194 EXPORT_SYMBOL(RMF_OST_ID);
1196 struct req_msg_field RMF_FIEMAP_KEY =
1197 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1198 lustre_swab_fiemap_info_key, NULL);
1199 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1201 struct req_msg_field RMF_FIEMAP_VAL =
1202 DEFINE_MSGFL("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1203 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1205 struct req_msg_field RMF_IDX_INFO =
1206 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1207 lustre_swab_idx_info, NULL);
1208 EXPORT_SYMBOL(RMF_IDX_INFO);
1209 struct req_msg_field RMF_SHORT_IO =
1210 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1211 EXPORT_SYMBOL(RMF_SHORT_IO);
1212 struct req_msg_field RMF_HSM_USER_STATE =
1213 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1214 lustre_swab_hsm_user_state, NULL);
1215 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1217 struct req_msg_field RMF_HSM_STATE_SET =
1218 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1219 lustre_swab_hsm_state_set, NULL);
1220 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1222 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1223 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1224 lustre_swab_hsm_progress_kernel, NULL);
1225 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1227 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1228 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1229 lustre_swab_hsm_current_action, NULL);
1230 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1232 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1233 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1234 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1236 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1238 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1239 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1240 sizeof(__u32), lustre_swab_generic_32s, NULL);
1241 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1243 struct req_msg_field RMF_MDS_HSM_REQUEST =
1244 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1245 lustre_swab_hsm_request, NULL);
1246 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1248 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGFL("object_update", 0, -1,
1249 lustre_swab_object_update_request, NULL);
1250 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1252 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1253 DEFINE_MSGFL("object_update_reply", 0, -1,
1254 lustre_swab_object_update_reply, NULL);
1255 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1257 struct req_msg_field RMF_SWAP_LAYOUTS =
1258 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1259 lustre_swab_swap_layouts, NULL);
1260 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1262 struct req_msg_field RMF_LFSCK_REQUEST =
1263 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1264 lustre_swab_lfsck_request, NULL);
1265 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1267 struct req_msg_field RMF_LFSCK_REPLY =
1268 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1269 lustre_swab_lfsck_reply, NULL);
1270 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1272 struct req_msg_field RMF_OST_LADVISE_HDR =
1273 DEFINE_MSGF("ladvise_request", 0,
1274 sizeof(struct ladvise_hdr),
1275 lustre_swab_ladvise_hdr, NULL);
1276 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1278 struct req_msg_field RMF_OST_LADVISE =
1279 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1280 sizeof(struct lu_ladvise),
1281 lustre_swab_ladvise, NULL);
1282 EXPORT_SYMBOL(RMF_OST_LADVISE);
1284 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1285 -1, lustre_swab_out_update_header, NULL);
1286 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1288 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1289 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1290 lustre_swab_out_update_buffer, NULL);
1291 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1298 const char *rf_name;
1302 const struct req_msg_field **d;
1303 } rf_fields[RCL_NR];
1306 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1320 #define DEFINE_REQ_FMT0(name, client, server) \
1321 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1323 struct req_format RQF_OBD_PING =
1324 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1325 EXPORT_SYMBOL(RQF_OBD_PING);
1327 struct req_format RQF_OBD_SET_INFO =
1328 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1329 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1331 /* Read index file through the network */
1332 struct req_format RQF_OBD_IDX_READ =
1333 DEFINE_REQ_FMT0("OBD_IDX_READ",
1334 obd_idx_read_client, obd_idx_read_server);
1335 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1337 struct req_format RQF_SEC_CTX =
1338 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1339 EXPORT_SYMBOL(RQF_SEC_CTX);
1341 struct req_format RQF_MGS_TARGET_REG =
1342 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1343 mgs_target_info_only);
1344 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1346 struct req_format RQF_MGS_CONFIG_READ =
1347 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1348 mgs_config_read_server);
1349 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1351 struct req_format RQF_SEQ_QUERY =
1352 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1353 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1355 struct req_format RQF_FLD_QUERY =
1356 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1357 EXPORT_SYMBOL(RQF_FLD_QUERY);
1359 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1360 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1361 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1362 * peers need to handle the RPC reply with fixed little-endian format.
1364 * In theory, we can define new structure with some swabber registered to
1365 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1366 * implementation view, it is not easy to be done within current "struct
1367 * req_msg_field" framework. Because the sequence range array in the RPC
1368 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1369 * count, that is unknown when prepare the RPC buffer. Generally, for such
1370 * flexible length RPC usage, there will be a field in the RPC layout to
1371 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1372 * do that unless we add new length filed that will broken the on-wire RPC
1373 * protocol and cause interoperability trouble with old peer. */
1374 struct req_format RQF_FLD_READ =
1375 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1376 EXPORT_SYMBOL(RQF_FLD_READ);
1378 struct req_format RQF_MDS_QUOTACTL =
1379 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1380 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1382 struct req_format RQF_OST_QUOTACTL =
1383 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1384 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1386 struct req_format RQF_QUOTA_DQACQ =
1387 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1388 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1390 struct req_format RQF_LDLM_INTENT_QUOTA =
1391 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1392 ldlm_intent_quota_client,
1393 ldlm_intent_quota_server);
1394 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1396 struct req_format RQF_MDS_GET_ROOT =
1397 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1398 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1400 struct req_format RQF_MDS_STATFS =
1401 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1402 EXPORT_SYMBOL(RQF_MDS_STATFS);
1404 struct req_format RQF_MDS_STATFS_NEW =
1405 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1406 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1408 struct req_format RQF_MDS_SYNC =
1409 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1410 EXPORT_SYMBOL(RQF_MDS_SYNC);
1412 struct req_format RQF_MDS_GETATTR =
1413 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1414 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1416 struct req_format RQF_MDS_GETXATTR =
1417 DEFINE_REQ_FMT0("MDS_GETXATTR",
1418 mds_getxattr_client, mds_getxattr_server);
1419 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1421 struct req_format RQF_MDS_GETATTR_NAME =
1422 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1423 mds_getattr_name_client, mds_getattr_server);
1424 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1426 struct req_format RQF_MDS_REINT =
1427 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1428 EXPORT_SYMBOL(RQF_MDS_REINT);
1430 struct req_format RQF_MDS_REINT_CREATE =
1431 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1432 mds_reint_create_client, mdt_body_capa);
1433 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1435 struct req_format RQF_MDS_REINT_CREATE_ACL =
1436 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1437 mds_reint_create_acl_client, mdt_body_capa);
1438 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1440 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1441 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1442 mds_reint_create_slave_client, mdt_body_capa);
1443 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1445 struct req_format RQF_MDS_REINT_CREATE_SYM =
1446 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1447 mds_reint_create_sym_client, mdt_body_capa);
1448 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1450 struct req_format RQF_MDS_REINT_OPEN =
1451 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1452 mds_reint_open_client, mds_reint_open_server);
1453 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1455 struct req_format RQF_MDS_REINT_UNLINK =
1456 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1457 mds_last_unlink_server);
1458 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1460 struct req_format RQF_MDS_REINT_LINK =
1461 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1462 mds_reint_link_client, mdt_body_only);
1463 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1465 struct req_format RQF_MDS_REINT_RENAME =
1466 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1467 mds_last_unlink_server);
1468 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1470 struct req_format RQF_MDS_REINT_MIGRATE =
1471 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1472 mds_last_unlink_server);
1473 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1475 struct req_format RQF_MDS_REINT_SETATTR =
1476 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1477 mds_reint_setattr_client, mds_setattr_server);
1478 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1480 struct req_format RQF_MDS_REINT_SETXATTR =
1481 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1482 mds_reint_setxattr_client, mdt_body_only);
1483 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1485 struct req_format RQF_MDS_REINT_RESYNC =
1486 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1487 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1489 struct req_format RQF_MDS_CONNECT =
1490 DEFINE_REQ_FMT0("MDS_CONNECT",
1491 obd_connect_client, obd_connect_server);
1492 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1494 struct req_format RQF_MDS_DISCONNECT =
1495 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1496 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1498 struct req_format RQF_MDS_GET_INFO =
1499 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1500 mds_getinfo_server);
1501 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1503 struct req_format RQF_OUT_UPDATE =
1504 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1506 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1508 struct req_format RQF_LDLM_ENQUEUE =
1509 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1510 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1511 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1513 struct req_format RQF_LDLM_ENQUEUE_LVB =
1514 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1515 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1516 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1518 struct req_format RQF_LDLM_CONVERT =
1519 DEFINE_REQ_FMT0("LDLM_CONVERT",
1520 ldlm_enqueue_client, ldlm_enqueue_server);
1521 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1523 struct req_format RQF_LDLM_CANCEL =
1524 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1525 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1527 struct req_format RQF_LDLM_CALLBACK =
1528 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1529 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1531 struct req_format RQF_LDLM_CP_CALLBACK =
1532 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1533 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1535 struct req_format RQF_LDLM_BL_CALLBACK =
1536 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1537 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1539 struct req_format RQF_LDLM_GL_CALLBACK =
1540 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1541 ldlm_gl_callback_server);
1542 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1544 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1545 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1546 ldlm_gl_callback_server);
1547 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1549 struct req_format RQF_LDLM_INTENT_BASIC =
1550 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1551 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1552 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1554 struct req_format RQF_LDLM_INTENT =
1555 DEFINE_REQ_FMT0("LDLM_INTENT",
1556 ldlm_intent_client, ldlm_intent_server);
1557 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1559 struct req_format RQF_LDLM_INTENT_LAYOUT =
1560 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1561 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1562 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1564 struct req_format RQF_LDLM_INTENT_GETATTR =
1565 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1566 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1567 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1569 struct req_format RQF_LDLM_INTENT_OPEN =
1570 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1571 ldlm_intent_open_client, ldlm_intent_open_server);
1572 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1574 struct req_format RQF_LDLM_INTENT_CREATE =
1575 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1576 ldlm_intent_create_client, ldlm_intent_getattr_server);
1577 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1579 struct req_format RQF_LDLM_INTENT_GETXATTR =
1580 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1581 ldlm_intent_getxattr_client,
1582 ldlm_intent_getxattr_server);
1583 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1585 struct req_format RQF_MDS_CLOSE =
1586 DEFINE_REQ_FMT0("MDS_CLOSE",
1587 mdt_close_client, mds_last_unlink_server);
1588 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1590 struct req_format RQF_MDS_CLOSE_INTENT =
1591 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1592 mdt_close_intent_client, mds_last_unlink_server);
1593 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1595 struct req_format RQF_MDS_READPAGE =
1596 DEFINE_REQ_FMT0("MDS_READPAGE",
1597 mdt_body_capa, mdt_body_only);
1598 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1600 struct req_format RQF_MDS_HSM_ACTION =
1601 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1602 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1604 struct req_format RQF_MDS_HSM_PROGRESS =
1605 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1606 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1608 struct req_format RQF_MDS_HSM_CT_REGISTER =
1609 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1610 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1612 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1613 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1614 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1616 struct req_format RQF_MDS_HSM_STATE_GET =
1617 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1618 mdt_body_capa, mdt_hsm_state_get_server);
1619 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1621 struct req_format RQF_MDS_HSM_STATE_SET =
1622 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1623 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1625 struct req_format RQF_MDS_HSM_REQUEST =
1626 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1627 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1629 struct req_format RQF_MDS_SWAP_LAYOUTS =
1630 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1631 mdt_swap_layouts, empty);
1632 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1634 struct req_format RQF_MDS_RMFID =
1635 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1637 EXPORT_SYMBOL(RQF_MDS_RMFID);
1639 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1640 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1641 llog_origin_handle_create_client, llogd_body_only);
1642 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1644 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1645 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1646 llogd_body_only, llog_origin_handle_next_block_server);
1647 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1649 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1650 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1651 llogd_body_only, llog_origin_handle_next_block_server);
1652 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1654 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1655 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1656 llogd_body_only, llog_log_hdr_only);
1657 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1659 struct req_format RQF_CONNECT =
1660 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1661 EXPORT_SYMBOL(RQF_CONNECT);
1663 struct req_format RQF_OST_CONNECT =
1664 DEFINE_REQ_FMT0("OST_CONNECT",
1665 obd_connect_client, obd_connect_server);
1666 EXPORT_SYMBOL(RQF_OST_CONNECT);
1668 struct req_format RQF_OST_DISCONNECT =
1669 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1670 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1672 struct req_format RQF_OST_GETATTR =
1673 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1674 EXPORT_SYMBOL(RQF_OST_GETATTR);
1676 struct req_format RQF_OST_SETATTR =
1677 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1678 EXPORT_SYMBOL(RQF_OST_SETATTR);
1680 struct req_format RQF_OST_CREATE =
1681 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1682 EXPORT_SYMBOL(RQF_OST_CREATE);
1684 struct req_format RQF_OST_PUNCH =
1685 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1686 EXPORT_SYMBOL(RQF_OST_PUNCH);
1688 struct req_format RQF_OST_SYNC =
1689 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1690 EXPORT_SYMBOL(RQF_OST_SYNC);
1692 struct req_format RQF_OST_DESTROY =
1693 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1694 EXPORT_SYMBOL(RQF_OST_DESTROY);
1696 struct req_format RQF_OST_BRW_READ =
1697 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1698 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1700 struct req_format RQF_OST_BRW_WRITE =
1701 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1702 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1704 struct req_format RQF_OST_STATFS =
1705 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1706 EXPORT_SYMBOL(RQF_OST_STATFS);
1708 struct req_format RQF_OST_SET_GRANT_INFO =
1709 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1711 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1713 struct req_format RQF_OST_GET_INFO =
1714 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1715 ost_get_info_generic_server);
1716 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1718 struct req_format RQF_OST_GET_INFO_LAST_ID =
1719 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1720 ost_get_last_id_server);
1721 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1723 struct req_format RQF_OST_GET_INFO_LAST_FID =
1724 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1725 ost_get_last_fid_server);
1726 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1728 struct req_format RQF_OST_SET_INFO_LAST_FID =
1729 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1731 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1733 struct req_format RQF_OST_GET_INFO_FIEMAP =
1734 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1735 ost_get_fiemap_server);
1736 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1738 struct req_format RQF_LFSCK_NOTIFY =
1739 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1740 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1742 struct req_format RQF_LFSCK_QUERY =
1743 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1744 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1746 struct req_format RQF_OST_LADVISE =
1747 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1748 EXPORT_SYMBOL(RQF_OST_LADVISE);
1750 /* Convenience macro */
1751 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1754 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1755 * field of RQFs and the \a rmf_offset field of RMFs.
1757 int req_layout_init(void)
1762 struct req_format *rf = NULL;
1764 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1765 rf = req_formats[i];
1767 for (j = 0; j < RCL_NR; ++j) {
1768 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1769 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1770 struct req_msg_field *field;
1772 field = (typeof(field))rf->rf_fields[j].d[k];
1773 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1774 || field->rmf_size > 0);
1775 LASSERT(field->rmf_offset[i][j] == 0);
1777 * k + 1 to detect unused format/field
1780 field->rmf_offset[i][j] = k + 1;
1786 EXPORT_SYMBOL(req_layout_init);
1788 void req_layout_fini(void)
1791 EXPORT_SYMBOL(req_layout_fini);
1794 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1796 * Actual/expected field sizes are set elsewhere in functions in this file:
1797 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1798 * req_capsule_msg_size(). The \a rc_area information is used by.
1799 * ptlrpc_request_set_replen().
1801 void req_capsule_init_area(struct req_capsule *pill)
1805 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1806 pill->rc_area[RCL_CLIENT][i] = -1;
1807 pill->rc_area[RCL_SERVER][i] = -1;
1810 EXPORT_SYMBOL(req_capsule_init_area);
1813 * Initialize a pill.
1815 * The \a location indicates whether the caller is executing on the client side
1816 * (RCL_CLIENT) or server side (RCL_SERVER)..
1818 void req_capsule_init(struct req_capsule *pill,
1819 struct ptlrpc_request *req,
1820 enum req_location location)
1822 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1825 * Today all capsules are embedded in ptlrpc_request structs,
1826 * but just in case that ever isn't the case, we don't reach
1827 * into req unless req != NULL and pill is the one embedded in
1830 * The req->rq_pill_init flag makes it safe to initialize a pill
1831 * twice, which might happen in the OST paths as a result of the
1832 * high-priority RPC queue getting peeked at before ost_handle()
1833 * handles an OST RPC.
1835 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1838 memset(pill, 0, sizeof *pill);
1840 pill->rc_loc = location;
1841 req_capsule_init_area(pill);
1843 if (req != NULL && pill == &req->rq_pill)
1844 req->rq_pill_init = 1;
1846 EXPORT_SYMBOL(req_capsule_init);
1848 void req_capsule_fini(struct req_capsule *pill)
1851 EXPORT_SYMBOL(req_capsule_fini);
1853 static int __req_format_is_sane(const struct req_format *fmt)
1855 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1856 req_formats[fmt->rf_idx] == fmt;
1859 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1860 enum req_location loc)
1862 struct ptlrpc_request *req;
1865 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1869 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1870 * (see req_capsule_extend()).
1872 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1874 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1875 LASSERT(__req_format_is_sane(fmt));
1879 EXPORT_SYMBOL(req_capsule_set);
1882 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1885 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1886 * variable-sized fields. The field sizes come from the declared \a rmf_size
1887 * field of a \a pill's \a rc_fmt's RMF's.
1889 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1890 enum req_location loc)
1892 const struct req_format *fmt = pill->rc_fmt;
1895 LASSERT(fmt != NULL);
1897 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1898 if (pill->rc_area[loc][i] == -1) {
1899 pill->rc_area[loc][i] =
1900 fmt->rf_fields[loc].d[i]->rmf_size;
1901 if (pill->rc_area[loc][i] == -1) {
1903 * Skip the following fields.
1905 * If this LASSERT() trips then you're missing a
1906 * call to req_capsule_set_size().
1908 LASSERT(loc != RCL_SERVER);
1915 EXPORT_SYMBOL(req_capsule_filled_sizes);
1918 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1920 * This function uses the \a pill's \a rc_area as filled in by
1921 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1924 int req_capsule_server_pack(struct req_capsule *pill)
1926 const struct req_format *fmt;
1930 LASSERT(pill->rc_loc == RCL_SERVER);
1932 LASSERT(fmt != NULL);
1934 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1935 rc = lustre_pack_reply(pill->rc_req, count,
1936 pill->rc_area[RCL_SERVER], NULL);
1938 DEBUG_REQ(D_ERROR, pill->rc_req,
1939 "Cannot pack %d fields in format '%s'",
1940 count, fmt->rf_name);
1944 EXPORT_SYMBOL(req_capsule_server_pack);
1947 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1948 * corresponding to the given RMF (\a field).
1950 __u32 __req_capsule_offset(const struct req_capsule *pill,
1951 const struct req_msg_field *field,
1952 enum req_location loc)
1954 unsigned int offset;
1956 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1957 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1958 pill->rc_fmt->rf_name,
1959 field->rmf_name, offset, loc);
1962 LASSERT(offset < REQ_MAX_FIELD_NR);
1967 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1971 swabber_dumper_helper(struct req_capsule *pill,
1972 const struct req_msg_field *field,
1973 enum req_location loc,
1975 void *value, int len, bool dump, void (*swabber)(void *))
1983 bool inout = loc == RCL_CLIENT;
1984 bool array = field->rmf_flags & RMF_F_STRUCT_ARRAY;
1986 swabber = swabber ?: field->rmf_swabber;
1988 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1989 (swabber != NULL || field->rmf_swab_len != NULL) && value != NULL)
1994 if (!field->rmf_dumper)
1998 * We're swabbing an array; swabber() swabs a single array element, so
1999 * swab every element.
2001 if (array && (len % field->rmf_size)) {
2002 static const struct req_msg_field *last_field;
2004 if (field != last_field) {
2005 CERROR("%s: array buffer size %u is not a multiple of element size %u\n",
2006 field->rmf_name, len, field->rmf_size);
2010 /* For the non-array cases, the process of swab/dump/swab only
2011 * needs to be done once. (n = 1)
2014 len = field->rmf_size;
2015 for (p = value, i = 0, n = len / field->rmf_size;
2017 i++, p += field->rmf_size) {
2019 CDEBUG(D_RPCTRACE, "Dump of %s%sfield %s element %d follows\n",
2020 do_swab ? "unswabbed " : "",
2021 array ? "array " : "",
2022 field->rmf_name, i);
2023 field->rmf_dumper(p);
2031 if (!field->rmf_swab_len) {
2034 size = field->rmf_swab_len(p, len);
2043 CDEBUG(D_RPCTRACE, "Dump of swabbed %sfield %s, element %d follows\n",
2044 array ? "array " : "", field->rmf_name, i);
2045 field->rmf_dumper(value);
2049 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2055 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2056 * corresponding to the given RMF (\a field).
2058 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2059 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2060 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2061 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2062 * element of the array swabbed.
2064 static void *__req_capsule_get(struct req_capsule *pill,
2065 const struct req_msg_field *field,
2066 enum req_location loc,
2067 void (*swabber)(void *),
2070 const struct req_format *fmt;
2071 struct lustre_msg *msg;
2076 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2078 static const char *rcl_names[RCL_NR] = {
2079 [RCL_CLIENT] = "client",
2080 [RCL_SERVER] = "server"
2083 LASSERT(pill != NULL);
2084 LASSERT(pill != LP_POISON);
2086 LASSERT(fmt != NULL);
2087 LASSERT(fmt != LP_POISON);
2088 LASSERT(__req_format_is_sane(fmt));
2090 offset = __req_capsule_offset(pill, field, loc);
2092 msg = __req_msg(pill, loc);
2093 LASSERT(msg != NULL);
2095 getter = (field->rmf_flags & RMF_F_STRING) ?
2096 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2098 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2100 * We've already asserted that field->rmf_size > 0 in
2101 * req_layout_init().
2103 len = lustre_msg_buflen(msg, offset);
2104 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2105 (len % field->rmf_size) != 0) {
2106 CERROR("%s: array field size mismatch "
2107 "%d modulo %u != 0 (%d)\n",
2108 field->rmf_name, len, field->rmf_size, loc);
2111 } else if (pill->rc_area[loc][offset] != -1) {
2112 len = pill->rc_area[loc][offset];
2114 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2116 value = getter(msg, offset, len);
2118 if (value == NULL) {
2119 DEBUG_REQ(D_ERROR, pill->rc_req,
2120 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2121 field->rmf_name, offset, lustre_msg_bufcount(msg),
2122 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2125 swabber_dumper_helper(pill, field, loc, offset, value, len,
2133 * Dump a request and/or reply
2135 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2137 const struct req_format *fmt;
2138 const struct req_msg_field *field;
2144 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2145 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2146 field = FMT_FIELD(fmt, loc, i);
2147 if (field->rmf_dumper == NULL) {
2149 * FIXME Add a default hex dumper for fields that don't
2150 * have a specific dumper
2152 len = req_capsule_get_size(pill, field, loc);
2154 "Field %s has no dumper function; field size is %u\n",
2155 field->rmf_name, len);
2157 /* It's dumping side-effect that we're interested in */
2158 (void) __req_capsule_get(pill, field, loc, NULL, true);
2161 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2167 void req_capsule_client_dump(struct req_capsule *pill)
2169 __req_capsule_dump(pill, RCL_CLIENT);
2171 EXPORT_SYMBOL(req_capsule_client_dump);
2176 void req_capsule_server_dump(struct req_capsule *pill)
2178 __req_capsule_dump(pill, RCL_SERVER);
2180 EXPORT_SYMBOL(req_capsule_server_dump);
2183 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2184 * buffer corresponding to the given RMF (\a field) of a \a pill.
2186 void *req_capsule_client_get(struct req_capsule *pill,
2187 const struct req_msg_field *field)
2189 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2191 EXPORT_SYMBOL(req_capsule_client_get);
2194 * Same as req_capsule_client_get(), but with a \a swabber argument.
2196 * Currently unused; will be removed when req_capsule_server_swab_get() is
2199 void *req_capsule_client_swab_get(struct req_capsule *pill,
2200 const struct req_msg_field *field,
2203 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, false);
2205 EXPORT_SYMBOL(req_capsule_client_swab_get);
2208 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2210 * First the \a pill's request \a field's size is set (\a rc_area) using
2211 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2214 void *req_capsule_client_sized_get(struct req_capsule *pill,
2215 const struct req_msg_field *field,
2218 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2219 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, false);
2221 EXPORT_SYMBOL(req_capsule_client_sized_get);
2224 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2225 * buffer corresponding to the given RMF (\a field) of a \a pill.
2227 void *req_capsule_server_get(struct req_capsule *pill,
2228 const struct req_msg_field *field)
2230 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2232 EXPORT_SYMBOL(req_capsule_server_get);
2235 * Same as req_capsule_server_get(), but with a \a swabber argument.
2237 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2238 * swabbing done outside this capsule abstraction.
2240 void *req_capsule_server_swab_get(struct req_capsule *pill,
2241 const struct req_msg_field *field,
2244 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2246 EXPORT_SYMBOL(req_capsule_server_swab_get);
2249 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2251 * First the \a pill's request \a field's size is set (\a rc_area) using
2252 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2255 void *req_capsule_server_sized_get(struct req_capsule *pill,
2256 const struct req_msg_field *field,
2259 req_capsule_set_size(pill, field, RCL_SERVER, len);
2260 return __req_capsule_get(pill, field, RCL_SERVER, NULL, false);
2262 EXPORT_SYMBOL(req_capsule_server_sized_get);
2264 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2265 const struct req_msg_field *field,
2266 __u32 len, void *swabber)
2268 req_capsule_set_size(pill, field, RCL_SERVER, len);
2269 return __req_capsule_get(pill, field, RCL_SERVER, swabber, false);
2271 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2274 * Returns the buffer of a \a pill corresponding to the given \a field from the
2275 * request (if the caller is executing on the server-side) or reply (if the
2276 * caller is executing on the client-side).
2278 * This function convienient for use is code that could be executed on the
2279 * client and server alike.
2281 const void *req_capsule_other_get(struct req_capsule *pill,
2282 const struct req_msg_field *field)
2284 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, false);
2286 EXPORT_SYMBOL(req_capsule_other_get);
2289 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2290 * field of the given \a pill.
2292 * This function must be used when constructing variable sized fields of a
2295 void req_capsule_set_size(struct req_capsule *pill,
2296 const struct req_msg_field *field,
2297 enum req_location loc, __u32 size)
2299 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2301 if ((size != (__u32)field->rmf_size) &&
2302 (field->rmf_size != -1) &&
2303 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2305 __u32 rmf_size = (__u32)field->rmf_size;
2306 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2307 (size % rmf_size != 0)) {
2308 CERROR("%s: array field size mismatch "
2309 "%u %% %u != 0 (%d)\n",
2310 field->rmf_name, size, rmf_size, loc);
2312 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2314 CERROR("%s: field size mismatch %u != %u (%d)\n",
2315 field->rmf_name, size, rmf_size, loc);
2320 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2322 EXPORT_SYMBOL(req_capsule_set_size);
2325 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2326 * for the given \a pill's given \a field.
2328 * NB: this function doesn't correspond with req_capsule_set_size(), which
2329 * actually sets the size in pill.rc_area[loc][offset], but this function
2330 * returns the message buflen[offset], maybe we should use another name.
2332 __u32 req_capsule_get_size(const struct req_capsule *pill,
2333 const struct req_msg_field *field,
2334 enum req_location loc)
2336 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2338 return lustre_msg_buflen(__req_msg(pill, loc),
2339 __req_capsule_offset(pill, field, loc));
2341 EXPORT_SYMBOL(req_capsule_get_size);
2344 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2345 * given \a pill's request or reply (\a loc) given the field size recorded in
2346 * the \a pill's rc_area.
2348 * See also req_capsule_set_size().
2350 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2352 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2353 pill->rc_fmt->rf_fields[loc].nr,
2354 pill->rc_area[loc]);
2358 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2359 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2360 * PTLRPC request or reply given only an RQF (\a fmt).
2362 * This function should not be used for formats which contain variable size
2365 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2366 enum req_location loc)
2372 * This function should probably LASSERT() that fmt has no fields with
2373 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2374 * elements in the array there will ultimately be, but then, we could
2375 * assume that there will be at least one element, and that's just what
2378 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2382 for (; i < fmt->rf_fields[loc].nr; ++i)
2383 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2384 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2388 EXPORT_SYMBOL(req_capsule_fmt_size);
2391 * Changes the format of an RPC.
2393 * The pill must already have been initialized, which means that it already has
2394 * a request format. The new format \a fmt must be an extension of the pill's
2395 * old format. Specifically: the new format must have as many request and reply
2396 * fields as the old one, and all fields shared by the old and new format must
2397 * be at least as large in the new format.
2399 * The new format's fields may be of different "type" than the old format, but
2400 * only for fields that are "opaque" blobs: fields which have a) have no
2401 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2402 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2403 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2404 * according to the key field. When the value, according to the key, contains a
2405 * structure (or array thereof) to be swabbed, the format should be changed to
2406 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2409 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2414 const struct req_format *old;
2416 LASSERT(pill->rc_fmt != NULL);
2417 LASSERT(__req_format_is_sane(fmt));
2421 * Sanity checking...
2423 for (i = 0; i < RCL_NR; ++i) {
2424 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2425 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2426 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2428 /* "opaque" fields can be transmogrified */
2429 if (ofield->rmf_swabber == NULL &&
2430 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2431 (ofield->rmf_size == -1 ||
2432 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2434 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2437 * Last field in old format can be shorter than in new.
2439 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2440 FMT_FIELD(old, i, j)->rmf_size);
2445 EXPORT_SYMBOL(req_capsule_extend);
2448 * This function returns a non-zero value if the given \a field is present in
2449 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2452 int req_capsule_has_field(const struct req_capsule *pill,
2453 const struct req_msg_field *field,
2454 enum req_location loc)
2456 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2458 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2460 EXPORT_SYMBOL(req_capsule_has_field);
2463 * Returns a non-zero value if the given \a field is present in the given \a
2464 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2466 int req_capsule_field_present(const struct req_capsule *pill,
2467 const struct req_msg_field *field,
2468 enum req_location loc)
2472 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2473 LASSERT(req_capsule_has_field(pill, field, loc));
2475 offset = __req_capsule_offset(pill, field, loc);
2476 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2478 EXPORT_SYMBOL(req_capsule_field_present);
2481 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2482 * request or reply (\a loc).
2484 * This is not the opposite of req_capsule_extend().
2486 void req_capsule_shrink(struct req_capsule *pill,
2487 const struct req_msg_field *field,
2489 enum req_location loc)
2491 const struct req_format *fmt;
2492 struct lustre_msg *msg;
2497 LASSERT(fmt != NULL);
2498 LASSERT(__req_format_is_sane(fmt));
2499 LASSERT(req_capsule_has_field(pill, field, loc));
2500 LASSERT(req_capsule_field_present(pill, field, loc));
2502 offset = __req_capsule_offset(pill, field, loc);
2504 msg = __req_msg(pill, loc);
2505 len = lustre_msg_buflen(msg, offset);
2506 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2507 fmt->rf_name, field->rmf_name, len, newlen);
2509 if (loc == RCL_CLIENT) {
2510 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2513 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2515 /* update also field size in reply lenghts arrays for possible
2516 * reply re-pack due to req_capsule_server_grow() call.
2518 req_capsule_set_size(pill, field, loc, newlen);
2521 EXPORT_SYMBOL(req_capsule_shrink);
2523 int req_capsule_server_grow(struct req_capsule *pill,
2524 const struct req_msg_field *field,
2527 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2532 LASSERT(pill->rc_fmt != NULL);
2533 LASSERT(__req_format_is_sane(pill->rc_fmt));
2534 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2535 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2537 len = req_capsule_get_size(pill, field, RCL_SERVER);
2538 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2540 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2541 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2544 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2546 * There can be enough space in current reply buffer, make sure
2547 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2548 * re-packing is still needed.
2550 if (rs->rs_msg == rs->rs_repbuf &&
2551 rs->rs_repbuf_len >=
2552 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2553 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2558 /* Re-allocate replay state */
2559 pill->rc_req->rq_reply_state = NULL;
2560 rc = req_capsule_server_pack(pill);
2562 /* put old values back, the caller should decide what to do */
2563 req_capsule_set_size(pill, field, RCL_SERVER, len);
2564 pill->rc_req->rq_reply_state = rs;
2567 nrs = pill->rc_req->rq_reply_state;
2568 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2569 lustre_packed_msg_size(rs->rs_msg));
2571 /* Now we need only buffers, copy them and grow the needed one */
2572 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2573 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2574 len = (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from;
2575 memcpy(to, from, len);
2576 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2578 if (rs->rs_difficult) {
2582 nrs->rs_difficult = 1;
2583 nrs->rs_no_ack = rs->rs_no_ack;
2584 nrs->rs_convert_lock = rs->rs_convert_lock;
2585 for (i = 0; i < rs->rs_nlocks; i++) {
2586 nrs->rs_locks[i] = rs->rs_locks[i];
2587 nrs->rs_modes[i] = rs->rs_modes[i];
2591 rs->rs_difficult = 0;
2594 ptlrpc_rs_decref(rs);
2597 EXPORT_SYMBOL(req_capsule_server_grow);
2599 int req_check_sepol(struct req_capsule *pill)
2602 #ifdef HAVE_SERVER_SUPPORT
2603 struct obd_export *export;
2604 struct lu_nodemap *nm = NULL;
2605 const char *sepol = NULL;
2606 const char *nm_sepol = NULL;
2611 export = pill->rc_req->rq_export;
2612 if (!export || !exp_connect_sepol(export) ||
2613 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2616 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2619 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2620 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2624 nm = nodemap_get_from_exp(export);
2625 if (!IS_ERR_OR_NULL(nm)) {
2626 nm_sepol = nodemap_get_sepol(nm);
2627 if (nm_sepol && nm_sepol[0])
2628 if (sepol == NULL ||
2629 strcmp(sepol, nm_sepol) != 0)
2634 if (!IS_ERR_OR_NULL(nm))
2640 EXPORT_SYMBOL(req_check_sepol);