4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ptlrpc/layout.c
34 * Lustre Metadata Target (mdt) request handler
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
41 * Every struct ptlrpc_request contains a "pill", which points to a description
42 * of the format that the request conforms to.
45 #define DEBUG_SUBSYSTEM S_RPC
47 #include <linux/module.h>
49 #include <llog_swab.h>
50 #include <lustre_debug.h>
51 #include <lustre_swab.h>
53 #include <obd_support.h>
55 /* struct ptlrpc_request, lustre_msg* */
56 #include <lustre_req_layout.h>
57 #include <lustre_acl.h>
58 #include <lustre_nodemap.h>
61 * RQFs (see below) refer to two struct req_msg_field arrays describing the
62 * client request and server reply, respectively.
64 /* empty set of fields... for suitable definition of emptiness. */
65 static const struct req_msg_field *empty[] = {
69 static const struct req_msg_field *mgs_target_info_only[] = {
74 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
75 static const struct req_msg_field *mgs_set_info[] = {
81 static const struct req_msg_field *mgs_config_read_client[] = {
86 static const struct req_msg_field *mgs_config_read_server[] = {
91 static const struct req_msg_field *mdt_body_only[] = {
96 static const struct req_msg_field *mdt_body_capa[] = {
102 static const struct req_msg_field *quotactl_only[] = {
107 static const struct req_msg_field *quota_body_only[] = {
112 static const struct req_msg_field *ldlm_intent_quota_client[] = {
119 static const struct req_msg_field *ldlm_intent_quota_server[] = {
126 static const struct req_msg_field *mdt_close_client[] = {
133 static const struct req_msg_field *mdt_close_intent_client[] = {
142 static const struct req_msg_field *obd_statfs_server[] = {
147 static const struct req_msg_field *seq_query_client[] = {
153 static const struct req_msg_field *seq_query_server[] = {
158 static const struct req_msg_field *fld_query_client[] = {
164 static const struct req_msg_field *fld_query_server[] = {
169 static const struct req_msg_field *fld_read_client[] = {
174 static const struct req_msg_field *fld_read_server[] = {
179 static const struct req_msg_field *mds_getattr_name_client[] = {
186 static const struct req_msg_field *mds_reint_client[] = {
191 static const struct req_msg_field *mds_reint_create_client[] = {
198 static const struct req_msg_field *mds_reint_create_slave_client[] = {
207 static const struct req_msg_field *mds_reint_create_acl_client[] = {
214 &RMF_FILE_SECCTX_NAME,
219 static const struct req_msg_field *mds_reint_create_sym_client[] = {
226 &RMF_FILE_SECCTX_NAME,
231 static const struct req_msg_field *mds_reint_open_client[] = {
238 &RMF_FILE_SECCTX_NAME,
243 static const struct req_msg_field *mds_reint_open_server[] = {
252 static const struct req_msg_field *mds_reint_unlink_client[] = {
261 static const struct req_msg_field *mds_reint_link_client[] = {
271 static const struct req_msg_field *mds_reint_rename_client[] = {
282 static const struct req_msg_field *mds_reint_migrate_client[] = {
296 static const struct req_msg_field *mds_last_unlink_server[] = {
305 static const struct req_msg_field *mds_reint_setattr_client[] = {
315 static const struct req_msg_field *mds_reint_setxattr_client[] = {
325 static const struct req_msg_field *mds_reint_resync[] = {
331 static const struct req_msg_field *mdt_swap_layouts[] = {
340 static const struct req_msg_field *obd_connect_client[] = {
349 static const struct req_msg_field *obd_connect_server[] = {
354 static const struct req_msg_field *obd_set_info_client[] = {
360 static const struct req_msg_field *ost_grant_shrink_client[] = {
366 static const struct req_msg_field *mds_getinfo_client[] = {
372 static const struct req_msg_field *mds_getinfo_server[] = {
377 static const struct req_msg_field *ldlm_enqueue_client[] = {
382 static const struct req_msg_field *ldlm_enqueue_server[] = {
387 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
393 static const struct req_msg_field *ldlm_cp_callback_client[] = {
399 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
405 static const struct req_msg_field *ldlm_gl_callback_server[] = {
410 static const struct req_msg_field *ldlm_intent_basic_client[] = {
416 static const struct req_msg_field *ldlm_intent_client[] = {
423 static const struct req_msg_field *ldlm_intent_server[] = {
431 static const struct req_msg_field *ldlm_intent_layout_client[] = {
436 &RMF_EADATA /* for new layout to be set up */
439 static const struct req_msg_field *ldlm_intent_open_server[] = {
450 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
454 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
459 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
468 static const struct req_msg_field *ldlm_intent_create_client[] = {
472 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
476 &RMF_FILE_SECCTX_NAME,
481 static const struct req_msg_field *ldlm_intent_open_client[] = {
485 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
490 &RMF_FILE_SECCTX_NAME,
495 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
504 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
509 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
515 static const struct req_msg_field *mds_get_root_client[] = {
521 static const struct req_msg_field *mds_getxattr_client[] = {
530 static const struct req_msg_field *mds_getxattr_server[] = {
536 static const struct req_msg_field *mds_getattr_server[] = {
545 static const struct req_msg_field *mds_setattr_server[] = {
554 static const struct req_msg_field *mds_update_client[] = {
556 &RMF_OUT_UPDATE_HEADER,
560 static const struct req_msg_field *mds_update_server[] = {
562 &RMF_OUT_UPDATE_REPLY,
565 static const struct req_msg_field *llog_origin_handle_create_client[] = {
571 static const struct req_msg_field *llogd_body_only[] = {
576 static const struct req_msg_field *llog_log_hdr_only[] = {
581 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
587 static const struct req_msg_field *obd_idx_read_client[] = {
592 static const struct req_msg_field *obd_idx_read_server[] = {
597 static const struct req_msg_field *ost_body_only[] = {
602 static const struct req_msg_field *ost_body_capa[] = {
608 static const struct req_msg_field *ost_destroy_client[] = {
616 static const struct req_msg_field *ost_brw_client[] = {
625 static const struct req_msg_field *ost_brw_read_server[] = {
631 static const struct req_msg_field *ost_brw_write_server[] = {
637 static const struct req_msg_field *ost_get_info_generic_server[] = {
642 static const struct req_msg_field *ost_get_info_generic_client[] = {
647 static const struct req_msg_field *ost_get_last_id_server[] = {
652 static const struct req_msg_field *ost_get_last_fid_client[] = {
658 static const struct req_msg_field *ost_get_last_fid_server[] = {
663 static const struct req_msg_field *ost_get_fiemap_client[] = {
669 static const struct req_msg_field *ost_ladvise[] = {
672 &RMF_OST_LADVISE_HDR,
676 static const struct req_msg_field *ost_get_fiemap_server[] = {
681 static const struct req_msg_field *mdt_hsm_progress[] = {
684 &RMF_MDS_HSM_PROGRESS,
687 static const struct req_msg_field *mdt_hsm_ct_register[] = {
690 &RMF_MDS_HSM_ARCHIVE,
693 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
698 static const struct req_msg_field *mdt_hsm_action_server[] = {
701 &RMF_MDS_HSM_CURRENT_ACTION,
704 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
710 static const struct req_msg_field *mdt_hsm_state_set[] = {
717 static const struct req_msg_field *mdt_hsm_request[] = {
720 &RMF_MDS_HSM_REQUEST,
721 &RMF_MDS_HSM_USER_ITEM,
725 static const struct req_msg_field *obd_lfsck_request[] = {
730 static const struct req_msg_field *obd_lfsck_reply[] = {
735 static struct req_format *req_formats[] = {
741 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
744 &RQF_MGS_CONFIG_READ,
755 &RQF_MDS_GETATTR_NAME,
759 &RQF_MDS_CLOSE_INTENT,
762 &RQF_MDS_REINT_CREATE,
763 &RQF_MDS_REINT_CREATE_ACL,
764 &RQF_MDS_REINT_CREATE_SLAVE,
765 &RQF_MDS_REINT_CREATE_SYM,
767 &RQF_MDS_REINT_UNLINK,
769 &RQF_MDS_REINT_RENAME,
770 &RQF_MDS_REINT_MIGRATE,
771 &RQF_MDS_REINT_SETATTR,
772 &RQF_MDS_REINT_SETXATTR,
773 &RQF_MDS_REINT_RESYNC,
775 &RQF_MDS_HSM_PROGRESS,
776 &RQF_MDS_HSM_CT_REGISTER,
777 &RQF_MDS_HSM_CT_UNREGISTER,
778 &RQF_MDS_HSM_STATE_GET,
779 &RQF_MDS_HSM_STATE_SET,
781 &RQF_MDS_HSM_REQUEST,
782 &RQF_MDS_SWAP_LAYOUTS,
796 &RQF_OST_SET_GRANT_INFO,
798 &RQF_OST_GET_INFO_LAST_ID,
799 &RQF_OST_GET_INFO_LAST_FID,
800 &RQF_OST_SET_INFO_LAST_FID,
801 &RQF_OST_GET_INFO_FIEMAP,
804 &RQF_LDLM_ENQUEUE_LVB,
808 &RQF_LDLM_CP_CALLBACK,
809 &RQF_LDLM_BL_CALLBACK,
810 &RQF_LDLM_GL_CALLBACK,
811 &RQF_LDLM_GL_CALLBACK_DESC,
813 &RQF_LDLM_INTENT_BASIC,
814 &RQF_LDLM_INTENT_LAYOUT,
815 &RQF_LDLM_INTENT_GETATTR,
816 &RQF_LDLM_INTENT_OPEN,
817 &RQF_LDLM_INTENT_CREATE,
818 &RQF_LDLM_INTENT_GETXATTR,
819 &RQF_LDLM_INTENT_QUOTA,
821 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
822 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
823 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
824 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
830 struct req_msg_field {
831 const __u32 rmf_flags;
832 const char *rmf_name;
834 * Field length. (-1) means "variable length". If the
835 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
836 * but the actual size must be a whole multiple of \a rmf_size.
839 void (*rmf_swabber)(void *);
840 void (*rmf_dumper)(void *);
841 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
846 * The field is a string, must be NUL-terminated.
848 RMF_F_STRING = 1 << 0,
850 * The field's buffer size need not match the declared \a rmf_size.
852 RMF_F_NO_SIZE_CHECK = 1 << 1,
854 * The field's buffer size must be a whole multiple of the declared \a
855 * rmf_size and the \a rmf_swabber function must work on the declared \a
856 * rmf_size worth of bytes.
858 RMF_F_STRUCT_ARRAY = 1 << 2
866 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
867 .rmf_name = (name), \
868 .rmf_flags = (flags), \
869 .rmf_size = (size), \
870 .rmf_swabber = (void (*)(void*))(swabber), \
871 .rmf_dumper = (void (*)(void*))(dumper) \
874 struct req_msg_field RMF_GENERIC_DATA =
875 DEFINE_MSGF("generic_data", 0,
877 EXPORT_SYMBOL(RMF_GENERIC_DATA);
879 struct req_msg_field RMF_MGS_TARGET_INFO =
880 DEFINE_MSGF("mgs_target_info", 0,
881 sizeof(struct mgs_target_info),
882 lustre_swab_mgs_target_info, NULL);
883 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
885 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
886 struct req_msg_field RMF_MGS_SEND_PARAM =
887 DEFINE_MSGF("mgs_send_param", 0,
888 sizeof(struct mgs_send_param),
890 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
893 struct req_msg_field RMF_MGS_CONFIG_BODY =
894 DEFINE_MSGF("mgs_config_read request", 0,
895 sizeof(struct mgs_config_body),
896 lustre_swab_mgs_config_body, NULL);
897 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
899 struct req_msg_field RMF_MGS_CONFIG_RES =
900 DEFINE_MSGF("mgs_config_read reply ", 0,
901 sizeof(struct mgs_config_res),
902 lustre_swab_mgs_config_res, NULL);
903 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
905 struct req_msg_field RMF_U32 =
906 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
907 sizeof(__u32), lustre_swab_generic_32s, NULL);
908 EXPORT_SYMBOL(RMF_U32);
910 struct req_msg_field RMF_SETINFO_VAL =
911 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
912 EXPORT_SYMBOL(RMF_SETINFO_VAL);
914 struct req_msg_field RMF_GETINFO_KEY =
915 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
916 EXPORT_SYMBOL(RMF_GETINFO_KEY);
918 struct req_msg_field RMF_GETINFO_VALLEN =
919 DEFINE_MSGF("getinfo_vallen", 0,
920 sizeof(__u32), lustre_swab_generic_32s, NULL);
921 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
923 struct req_msg_field RMF_GETINFO_VAL =
924 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
925 EXPORT_SYMBOL(RMF_GETINFO_VAL);
927 struct req_msg_field RMF_SEQ_OPC =
928 DEFINE_MSGF("seq_query_opc", 0,
929 sizeof(__u32), lustre_swab_generic_32s, NULL);
930 EXPORT_SYMBOL(RMF_SEQ_OPC);
932 struct req_msg_field RMF_SEQ_RANGE =
933 DEFINE_MSGF("seq_query_range", 0,
934 sizeof(struct lu_seq_range),
935 lustre_swab_lu_seq_range, NULL);
936 EXPORT_SYMBOL(RMF_SEQ_RANGE);
938 struct req_msg_field RMF_FLD_OPC =
939 DEFINE_MSGF("fld_query_opc", 0,
940 sizeof(__u32), lustre_swab_generic_32s, NULL);
941 EXPORT_SYMBOL(RMF_FLD_OPC);
943 struct req_msg_field RMF_FLD_MDFLD =
944 DEFINE_MSGF("fld_query_mdfld", 0,
945 sizeof(struct lu_seq_range),
946 lustre_swab_lu_seq_range, NULL);
947 EXPORT_SYMBOL(RMF_FLD_MDFLD);
949 struct req_msg_field RMF_MDT_BODY =
950 DEFINE_MSGF("mdt_body", 0,
951 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
952 EXPORT_SYMBOL(RMF_MDT_BODY);
954 struct req_msg_field RMF_OBD_QUOTACTL =
955 DEFINE_MSGF("obd_quotactl", 0,
956 sizeof(struct obd_quotactl),
957 lustre_swab_obd_quotactl, NULL);
958 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
960 struct req_msg_field RMF_QUOTA_BODY =
961 DEFINE_MSGF("quota_body", 0,
962 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
963 EXPORT_SYMBOL(RMF_QUOTA_BODY);
965 struct req_msg_field RMF_MDT_EPOCH =
966 DEFINE_MSGF("mdt_ioepoch", 0,
967 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
968 EXPORT_SYMBOL(RMF_MDT_EPOCH);
970 struct req_msg_field RMF_PTLRPC_BODY =
971 DEFINE_MSGF("ptlrpc_body", 0,
972 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
973 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
975 struct req_msg_field RMF_CLOSE_DATA =
976 DEFINE_MSGF("data_version", 0,
977 sizeof(struct close_data), lustre_swab_close_data, NULL);
978 EXPORT_SYMBOL(RMF_CLOSE_DATA);
980 struct req_msg_field RMF_OBD_STATFS =
981 DEFINE_MSGF("obd_statfs", 0,
982 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
983 EXPORT_SYMBOL(RMF_OBD_STATFS);
985 struct req_msg_field RMF_SETINFO_KEY =
986 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
987 EXPORT_SYMBOL(RMF_SETINFO_KEY);
989 struct req_msg_field RMF_NAME =
990 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
991 EXPORT_SYMBOL(RMF_NAME);
993 struct req_msg_field RMF_SYMTGT =
994 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
995 EXPORT_SYMBOL(RMF_SYMTGT);
997 struct req_msg_field RMF_TGTUUID =
998 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1000 EXPORT_SYMBOL(RMF_TGTUUID);
1002 struct req_msg_field RMF_CLUUID =
1003 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1005 EXPORT_SYMBOL(RMF_CLUUID);
1007 struct req_msg_field RMF_STRING =
1008 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1009 EXPORT_SYMBOL(RMF_STRING);
1011 struct req_msg_field RMF_FILE_SECCTX_NAME =
1012 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1013 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1015 struct req_msg_field RMF_FILE_SECCTX =
1016 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1017 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1019 struct req_msg_field RMF_LLOGD_BODY =
1020 DEFINE_MSGF("llogd_body", 0,
1021 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1022 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1024 struct req_msg_field RMF_LLOG_LOG_HDR =
1025 DEFINE_MSGF("llog_log_hdr", 0,
1026 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1027 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1029 struct req_msg_field RMF_LLOGD_CONN_BODY =
1030 DEFINE_MSGF("llogd_conn_body", 0,
1031 sizeof(struct llogd_conn_body),
1032 lustre_swab_llogd_conn_body, NULL);
1033 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1036 * connection handle received in MDS_CONNECT request.
1038 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1039 * that the client does not interpret at all.
1041 struct req_msg_field RMF_CONN =
1042 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1043 EXPORT_SYMBOL(RMF_CONN);
1045 struct req_msg_field RMF_CONNECT_DATA =
1046 DEFINE_MSGF("cdata",
1047 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1048 sizeof(struct obd_connect_data),
1049 lustre_swab_connect, NULL);
1050 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1052 struct req_msg_field RMF_DLM_REQ =
1053 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1054 sizeof(struct ldlm_request),
1055 lustre_swab_ldlm_request, NULL);
1056 EXPORT_SYMBOL(RMF_DLM_REQ);
1058 struct req_msg_field RMF_DLM_REP =
1059 DEFINE_MSGF("dlm_rep", 0,
1060 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1061 EXPORT_SYMBOL(RMF_DLM_REP);
1063 struct req_msg_field RMF_LDLM_INTENT =
1064 DEFINE_MSGF("ldlm_intent", 0,
1065 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1066 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1068 struct req_msg_field RMF_DLM_LVB =
1069 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1070 EXPORT_SYMBOL(RMF_DLM_LVB);
1072 struct req_msg_field RMF_DLM_GL_DESC =
1073 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1074 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1076 struct req_msg_field RMF_MDT_MD =
1077 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1078 EXPORT_SYMBOL(RMF_MDT_MD);
1080 struct req_msg_field RMF_REC_REINT =
1081 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1082 lustre_swab_mdt_rec_reint, NULL);
1083 EXPORT_SYMBOL(RMF_REC_REINT);
1085 /* FIXME: this length should be defined as a macro */
1086 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1088 EXPORT_SYMBOL(RMF_EADATA);
1090 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1091 EXPORT_SYMBOL(RMF_EAVALS);
1093 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1094 EXPORT_SYMBOL(RMF_ACL);
1096 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1097 struct req_msg_field RMF_LOGCOOKIES =
1098 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1099 sizeof(struct llog_cookie), NULL, NULL);
1100 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1102 struct req_msg_field RMF_CAPA1 =
1103 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1104 EXPORT_SYMBOL(RMF_CAPA1);
1106 struct req_msg_field RMF_CAPA2 =
1107 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1108 EXPORT_SYMBOL(RMF_CAPA2);
1110 struct req_msg_field RMF_LAYOUT_INTENT =
1111 DEFINE_MSGF("layout_intent", 0,
1112 sizeof(struct layout_intent), lustre_swab_layout_intent,
1114 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1116 struct req_msg_field RMF_SELINUX_POL =
1117 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1118 EXPORT_SYMBOL(RMF_SELINUX_POL);
1121 * OST request field.
1123 struct req_msg_field RMF_OST_BODY =
1124 DEFINE_MSGF("ost_body", 0,
1125 sizeof(struct ost_body), lustre_swab_ost_body,
1127 EXPORT_SYMBOL(RMF_OST_BODY);
1129 struct req_msg_field RMF_OBD_IOOBJ =
1130 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1131 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1132 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1134 struct req_msg_field RMF_NIOBUF_REMOTE =
1135 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1136 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1138 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1140 struct req_msg_field RMF_NIOBUF_INLINE =
1141 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1142 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1144 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1146 struct req_msg_field RMF_RCS =
1147 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1148 lustre_swab_generic_32s, dump_rcs);
1149 EXPORT_SYMBOL(RMF_RCS);
1151 struct req_msg_field RMF_EAVALS_LENS =
1152 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1153 lustre_swab_generic_32s, NULL);
1154 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1156 struct req_msg_field RMF_OBD_ID =
1157 DEFINE_MSGF("obd_id", 0,
1158 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1159 EXPORT_SYMBOL(RMF_OBD_ID);
1161 struct req_msg_field RMF_FID =
1162 DEFINE_MSGF("fid", 0,
1163 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1164 EXPORT_SYMBOL(RMF_FID);
1166 struct req_msg_field RMF_OST_ID =
1167 DEFINE_MSGF("ost_id", 0,
1168 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1169 EXPORT_SYMBOL(RMF_OST_ID);
1171 struct req_msg_field RMF_FIEMAP_KEY =
1172 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1173 lustre_swab_fiemap, NULL);
1174 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1176 struct req_msg_field RMF_FIEMAP_VAL =
1177 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1178 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1180 struct req_msg_field RMF_IDX_INFO =
1181 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1182 lustre_swab_idx_info, NULL);
1183 EXPORT_SYMBOL(RMF_IDX_INFO);
1184 struct req_msg_field RMF_SHORT_IO =
1185 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1186 EXPORT_SYMBOL(RMF_SHORT_IO);
1187 struct req_msg_field RMF_HSM_USER_STATE =
1188 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1189 lustre_swab_hsm_user_state, NULL);
1190 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1192 struct req_msg_field RMF_HSM_STATE_SET =
1193 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1194 lustre_swab_hsm_state_set, NULL);
1195 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1197 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1198 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1199 lustre_swab_hsm_progress_kernel, NULL);
1200 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1202 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1203 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1204 lustre_swab_hsm_current_action, NULL);
1205 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1207 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1208 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1209 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1211 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1213 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1214 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1215 sizeof(__u32), lustre_swab_generic_32s, NULL);
1216 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1218 struct req_msg_field RMF_MDS_HSM_REQUEST =
1219 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1220 lustre_swab_hsm_request, NULL);
1221 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1223 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1224 lustre_swab_object_update_request, NULL);
1225 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1227 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1228 DEFINE_MSGF("object_update_reply", 0, -1,
1229 lustre_swab_object_update_reply, NULL);
1230 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1232 struct req_msg_field RMF_SWAP_LAYOUTS =
1233 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1234 lustre_swab_swap_layouts, NULL);
1235 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1237 struct req_msg_field RMF_LFSCK_REQUEST =
1238 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1239 lustre_swab_lfsck_request, NULL);
1240 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1242 struct req_msg_field RMF_LFSCK_REPLY =
1243 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1244 lustre_swab_lfsck_reply, NULL);
1245 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1247 struct req_msg_field RMF_OST_LADVISE_HDR =
1248 DEFINE_MSGF("ladvise_request", 0,
1249 sizeof(struct ladvise_hdr),
1250 lustre_swab_ladvise_hdr, NULL);
1251 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1253 struct req_msg_field RMF_OST_LADVISE =
1254 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1255 sizeof(struct lu_ladvise),
1256 lustre_swab_ladvise, NULL);
1257 EXPORT_SYMBOL(RMF_OST_LADVISE);
1259 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1260 -1, lustre_swab_out_update_header, NULL);
1261 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1263 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1264 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1265 lustre_swab_out_update_buffer, NULL);
1266 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1273 const char *rf_name;
1277 const struct req_msg_field **d;
1278 } rf_fields[RCL_NR];
1281 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1295 #define DEFINE_REQ_FMT0(name, client, server) \
1296 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1298 struct req_format RQF_OBD_PING =
1299 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1300 EXPORT_SYMBOL(RQF_OBD_PING);
1302 struct req_format RQF_OBD_SET_INFO =
1303 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1304 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1306 /* Read index file through the network */
1307 struct req_format RQF_OBD_IDX_READ =
1308 DEFINE_REQ_FMT0("OBD_IDX_READ",
1309 obd_idx_read_client, obd_idx_read_server);
1310 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1312 struct req_format RQF_SEC_CTX =
1313 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1314 EXPORT_SYMBOL(RQF_SEC_CTX);
1316 struct req_format RQF_MGS_TARGET_REG =
1317 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1318 mgs_target_info_only);
1319 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1321 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1322 struct req_format RQF_MGS_SET_INFO =
1323 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1325 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1328 struct req_format RQF_MGS_CONFIG_READ =
1329 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1330 mgs_config_read_server);
1331 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1333 struct req_format RQF_SEQ_QUERY =
1334 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1335 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1337 struct req_format RQF_FLD_QUERY =
1338 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1339 EXPORT_SYMBOL(RQF_FLD_QUERY);
1341 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1342 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1343 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1344 * peers need to handle the RPC reply with fixed little-endian format.
1346 * In theory, we can define new structure with some swabber registered to
1347 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1348 * implementation view, it is not easy to be done within current "struct
1349 * req_msg_field" framework. Because the sequence range array in the RPC
1350 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1351 * count, that is unknown when prepare the RPC buffer. Generally, for such
1352 * flexible length RPC usage, there will be a field in the RPC layout to
1353 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1354 * do that unless we add new length filed that will broken the on-wire RPC
1355 * protocol and cause interoperability trouble with old peer. */
1356 struct req_format RQF_FLD_READ =
1357 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1358 EXPORT_SYMBOL(RQF_FLD_READ);
1360 struct req_format RQF_MDS_QUOTACTL =
1361 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1362 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1364 struct req_format RQF_OST_QUOTACTL =
1365 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1366 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1368 struct req_format RQF_QUOTA_DQACQ =
1369 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1370 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1372 struct req_format RQF_LDLM_INTENT_QUOTA =
1373 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1374 ldlm_intent_quota_client,
1375 ldlm_intent_quota_server);
1376 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1378 struct req_format RQF_MDS_GET_ROOT =
1379 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1380 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1382 struct req_format RQF_MDS_STATFS =
1383 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1384 EXPORT_SYMBOL(RQF_MDS_STATFS);
1386 struct req_format RQF_MDS_STATFS_NEW =
1387 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1388 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1390 struct req_format RQF_MDS_SYNC =
1391 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1392 EXPORT_SYMBOL(RQF_MDS_SYNC);
1394 struct req_format RQF_MDS_GETATTR =
1395 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1396 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1398 struct req_format RQF_MDS_GETXATTR =
1399 DEFINE_REQ_FMT0("MDS_GETXATTR",
1400 mds_getxattr_client, mds_getxattr_server);
1401 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1403 struct req_format RQF_MDS_GETATTR_NAME =
1404 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1405 mds_getattr_name_client, mds_getattr_server);
1406 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1408 struct req_format RQF_MDS_REINT =
1409 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1410 EXPORT_SYMBOL(RQF_MDS_REINT);
1412 struct req_format RQF_MDS_REINT_CREATE =
1413 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1414 mds_reint_create_client, mdt_body_capa);
1415 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1417 struct req_format RQF_MDS_REINT_CREATE_ACL =
1418 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1419 mds_reint_create_acl_client, mdt_body_capa);
1420 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1422 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1423 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1424 mds_reint_create_slave_client, mdt_body_capa);
1425 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1427 struct req_format RQF_MDS_REINT_CREATE_SYM =
1428 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1429 mds_reint_create_sym_client, mdt_body_capa);
1430 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1432 struct req_format RQF_MDS_REINT_OPEN =
1433 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1434 mds_reint_open_client, mds_reint_open_server);
1435 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1437 struct req_format RQF_MDS_REINT_UNLINK =
1438 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1439 mds_last_unlink_server);
1440 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1442 struct req_format RQF_MDS_REINT_LINK =
1443 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1444 mds_reint_link_client, mdt_body_only);
1445 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1447 struct req_format RQF_MDS_REINT_RENAME =
1448 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1449 mds_last_unlink_server);
1450 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1452 struct req_format RQF_MDS_REINT_MIGRATE =
1453 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1454 mds_last_unlink_server);
1455 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1457 struct req_format RQF_MDS_REINT_SETATTR =
1458 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1459 mds_reint_setattr_client, mds_setattr_server);
1460 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1462 struct req_format RQF_MDS_REINT_SETXATTR =
1463 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1464 mds_reint_setxattr_client, mdt_body_only);
1465 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1467 struct req_format RQF_MDS_REINT_RESYNC =
1468 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1469 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1471 struct req_format RQF_MDS_CONNECT =
1472 DEFINE_REQ_FMT0("MDS_CONNECT",
1473 obd_connect_client, obd_connect_server);
1474 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1476 struct req_format RQF_MDS_DISCONNECT =
1477 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1478 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1480 struct req_format RQF_MDS_GET_INFO =
1481 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1482 mds_getinfo_server);
1483 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1485 struct req_format RQF_OUT_UPDATE =
1486 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1488 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1490 struct req_format RQF_LDLM_ENQUEUE =
1491 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1492 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1493 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1495 struct req_format RQF_LDLM_ENQUEUE_LVB =
1496 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1497 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1498 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1500 struct req_format RQF_LDLM_CONVERT =
1501 DEFINE_REQ_FMT0("LDLM_CONVERT",
1502 ldlm_enqueue_client, ldlm_enqueue_server);
1503 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1505 struct req_format RQF_LDLM_CANCEL =
1506 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1507 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1509 struct req_format RQF_LDLM_CALLBACK =
1510 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1511 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1513 struct req_format RQF_LDLM_CP_CALLBACK =
1514 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1515 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1517 struct req_format RQF_LDLM_BL_CALLBACK =
1518 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1519 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1521 struct req_format RQF_LDLM_GL_CALLBACK =
1522 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1523 ldlm_gl_callback_server);
1524 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1526 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1527 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1528 ldlm_gl_callback_server);
1529 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1531 struct req_format RQF_LDLM_INTENT_BASIC =
1532 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1533 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1534 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1536 struct req_format RQF_LDLM_INTENT =
1537 DEFINE_REQ_FMT0("LDLM_INTENT",
1538 ldlm_intent_client, ldlm_intent_server);
1539 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1541 struct req_format RQF_LDLM_INTENT_LAYOUT =
1542 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1543 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1544 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1546 struct req_format RQF_LDLM_INTENT_GETATTR =
1547 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1548 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1549 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1551 struct req_format RQF_LDLM_INTENT_OPEN =
1552 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1553 ldlm_intent_open_client, ldlm_intent_open_server);
1554 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1556 struct req_format RQF_LDLM_INTENT_CREATE =
1557 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1558 ldlm_intent_create_client, ldlm_intent_getattr_server);
1559 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1561 struct req_format RQF_LDLM_INTENT_GETXATTR =
1562 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1563 ldlm_intent_getxattr_client,
1564 ldlm_intent_getxattr_server);
1565 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1567 struct req_format RQF_MDS_CLOSE =
1568 DEFINE_REQ_FMT0("MDS_CLOSE",
1569 mdt_close_client, mds_last_unlink_server);
1570 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1572 struct req_format RQF_MDS_CLOSE_INTENT =
1573 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1574 mdt_close_intent_client, mds_last_unlink_server);
1575 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1577 struct req_format RQF_MDS_READPAGE =
1578 DEFINE_REQ_FMT0("MDS_READPAGE",
1579 mdt_body_capa, mdt_body_only);
1580 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1582 struct req_format RQF_MDS_HSM_ACTION =
1583 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1584 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1586 struct req_format RQF_MDS_HSM_PROGRESS =
1587 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1588 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1590 struct req_format RQF_MDS_HSM_CT_REGISTER =
1591 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1592 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1594 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1595 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1596 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1598 struct req_format RQF_MDS_HSM_STATE_GET =
1599 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1600 mdt_body_capa, mdt_hsm_state_get_server);
1601 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1603 struct req_format RQF_MDS_HSM_STATE_SET =
1604 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1605 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1607 struct req_format RQF_MDS_HSM_REQUEST =
1608 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1609 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1611 struct req_format RQF_MDS_SWAP_LAYOUTS =
1612 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1613 mdt_swap_layouts, empty);
1614 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1616 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1617 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1618 llog_origin_handle_create_client, llogd_body_only);
1619 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1621 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1622 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1623 llogd_body_only, llog_origin_handle_next_block_server);
1624 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1626 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1627 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1628 llogd_body_only, llog_origin_handle_next_block_server);
1629 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1631 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1632 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1633 llogd_body_only, llog_log_hdr_only);
1634 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1636 struct req_format RQF_CONNECT =
1637 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1638 EXPORT_SYMBOL(RQF_CONNECT);
1640 struct req_format RQF_OST_CONNECT =
1641 DEFINE_REQ_FMT0("OST_CONNECT",
1642 obd_connect_client, obd_connect_server);
1643 EXPORT_SYMBOL(RQF_OST_CONNECT);
1645 struct req_format RQF_OST_DISCONNECT =
1646 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1647 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1649 struct req_format RQF_OST_GETATTR =
1650 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1651 EXPORT_SYMBOL(RQF_OST_GETATTR);
1653 struct req_format RQF_OST_SETATTR =
1654 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1655 EXPORT_SYMBOL(RQF_OST_SETATTR);
1657 struct req_format RQF_OST_CREATE =
1658 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1659 EXPORT_SYMBOL(RQF_OST_CREATE);
1661 struct req_format RQF_OST_PUNCH =
1662 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1663 EXPORT_SYMBOL(RQF_OST_PUNCH);
1665 struct req_format RQF_OST_SYNC =
1666 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1667 EXPORT_SYMBOL(RQF_OST_SYNC);
1669 struct req_format RQF_OST_DESTROY =
1670 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1671 EXPORT_SYMBOL(RQF_OST_DESTROY);
1673 struct req_format RQF_OST_BRW_READ =
1674 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1675 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1677 struct req_format RQF_OST_BRW_WRITE =
1678 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1679 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1681 struct req_format RQF_OST_STATFS =
1682 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1683 EXPORT_SYMBOL(RQF_OST_STATFS);
1685 struct req_format RQF_OST_SET_GRANT_INFO =
1686 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1688 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1690 struct req_format RQF_OST_GET_INFO =
1691 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1692 ost_get_info_generic_server);
1693 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1695 struct req_format RQF_OST_GET_INFO_LAST_ID =
1696 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1697 ost_get_last_id_server);
1698 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1700 struct req_format RQF_OST_GET_INFO_LAST_FID =
1701 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1702 ost_get_last_fid_server);
1703 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1705 struct req_format RQF_OST_SET_INFO_LAST_FID =
1706 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1708 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1710 struct req_format RQF_OST_GET_INFO_FIEMAP =
1711 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1712 ost_get_fiemap_server);
1713 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1715 struct req_format RQF_LFSCK_NOTIFY =
1716 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1717 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1719 struct req_format RQF_LFSCK_QUERY =
1720 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1721 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1723 struct req_format RQF_OST_LADVISE =
1724 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1725 EXPORT_SYMBOL(RQF_OST_LADVISE);
1727 /* Convenience macro */
1728 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1731 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1732 * field of RQFs and the \a rmf_offset field of RMFs.
1734 int req_layout_init(void)
1739 struct req_format *rf = NULL;
1741 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1742 rf = req_formats[i];
1744 for (j = 0; j < RCL_NR; ++j) {
1745 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1746 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1747 struct req_msg_field *field;
1749 field = (typeof(field))rf->rf_fields[j].d[k];
1750 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1751 || field->rmf_size > 0);
1752 LASSERT(field->rmf_offset[i][j] == 0);
1754 * k + 1 to detect unused format/field
1757 field->rmf_offset[i][j] = k + 1;
1763 EXPORT_SYMBOL(req_layout_init);
1765 void req_layout_fini(void)
1768 EXPORT_SYMBOL(req_layout_fini);
1771 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1773 * Actual/expected field sizes are set elsewhere in functions in this file:
1774 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1775 * req_capsule_msg_size(). The \a rc_area information is used by.
1776 * ptlrpc_request_set_replen().
1778 void req_capsule_init_area(struct req_capsule *pill)
1782 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1783 pill->rc_area[RCL_CLIENT][i] = -1;
1784 pill->rc_area[RCL_SERVER][i] = -1;
1787 EXPORT_SYMBOL(req_capsule_init_area);
1790 * Initialize a pill.
1792 * The \a location indicates whether the caller is executing on the client side
1793 * (RCL_CLIENT) or server side (RCL_SERVER)..
1795 void req_capsule_init(struct req_capsule *pill,
1796 struct ptlrpc_request *req,
1797 enum req_location location)
1799 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1802 * Today all capsules are embedded in ptlrpc_request structs,
1803 * but just in case that ever isn't the case, we don't reach
1804 * into req unless req != NULL and pill is the one embedded in
1807 * The req->rq_pill_init flag makes it safe to initialize a pill
1808 * twice, which might happen in the OST paths as a result of the
1809 * high-priority RPC queue getting peeked at before ost_handle()
1810 * handles an OST RPC.
1812 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1815 memset(pill, 0, sizeof *pill);
1817 pill->rc_loc = location;
1818 req_capsule_init_area(pill);
1820 if (req != NULL && pill == &req->rq_pill)
1821 req->rq_pill_init = 1;
1823 EXPORT_SYMBOL(req_capsule_init);
1825 void req_capsule_fini(struct req_capsule *pill)
1828 EXPORT_SYMBOL(req_capsule_fini);
1830 static int __req_format_is_sane(const struct req_format *fmt)
1832 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1833 req_formats[fmt->rf_idx] == fmt;
1836 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1837 enum req_location loc)
1839 struct ptlrpc_request *req;
1842 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1846 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1847 * (see req_capsule_extend()).
1849 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1851 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1852 LASSERT(__req_format_is_sane(fmt));
1856 EXPORT_SYMBOL(req_capsule_set);
1859 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1862 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1863 * variable-sized fields. The field sizes come from the declared \a rmf_size
1864 * field of a \a pill's \a rc_fmt's RMF's.
1866 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1867 enum req_location loc)
1869 const struct req_format *fmt = pill->rc_fmt;
1872 LASSERT(fmt != NULL);
1874 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1875 if (pill->rc_area[loc][i] == -1) {
1876 pill->rc_area[loc][i] =
1877 fmt->rf_fields[loc].d[i]->rmf_size;
1878 if (pill->rc_area[loc][i] == -1) {
1880 * Skip the following fields.
1882 * If this LASSERT() trips then you're missing a
1883 * call to req_capsule_set_size().
1885 LASSERT(loc != RCL_SERVER);
1892 EXPORT_SYMBOL(req_capsule_filled_sizes);
1895 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1897 * This function uses the \a pill's \a rc_area as filled in by
1898 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1901 int req_capsule_server_pack(struct req_capsule *pill)
1903 const struct req_format *fmt;
1907 LASSERT(pill->rc_loc == RCL_SERVER);
1909 LASSERT(fmt != NULL);
1911 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1912 rc = lustre_pack_reply(pill->rc_req, count,
1913 pill->rc_area[RCL_SERVER], NULL);
1915 DEBUG_REQ(D_ERROR, pill->rc_req,
1916 "Cannot pack %d fields in format `%s': ",
1917 count, fmt->rf_name);
1921 EXPORT_SYMBOL(req_capsule_server_pack);
1924 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1925 * corresponding to the given RMF (\a field).
1927 __u32 __req_capsule_offset(const struct req_capsule *pill,
1928 const struct req_msg_field *field,
1929 enum req_location loc)
1931 unsigned int offset;
1933 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1934 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1935 pill->rc_fmt->rf_name,
1936 field->rmf_name, offset, loc);
1939 LASSERT(offset < REQ_MAX_FIELD_NR);
1944 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1949 swabber_dumper_helper(struct req_capsule *pill,
1950 const struct req_msg_field *field,
1951 enum req_location loc,
1953 void *value, int len, int dump, void (*swabber)( void *))
1959 int inout = loc == RCL_CLIENT;
1961 swabber = swabber ?: field->rmf_swabber;
1963 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1964 swabber != NULL && value != NULL)
1969 if (!field->rmf_dumper)
1972 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1974 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1975 do_swab ? "unswabbed " : "", field->rmf_name);
1976 field->rmf_dumper(value);
1981 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1983 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1984 "follows\n", field->rmf_name);
1985 field->rmf_dumper(value);
1992 * We're swabbing an array; swabber() swabs a single array element, so
1993 * swab every element.
1995 LASSERT((len % field->rmf_size) == 0);
1996 for (p = value, i = 0, n = len / field->rmf_size;
1998 i++, p += field->rmf_size) {
2000 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2001 "element %d follows\n",
2002 do_swab ? "unswabbed " : "", field->rmf_name, i);
2003 field->rmf_dumper(p);
2009 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2010 "element %d follows\n", field->rmf_name, i);
2011 field->rmf_dumper(value);
2015 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2019 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2020 * corresponding to the given RMF (\a field).
2022 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2023 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2024 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2025 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2026 * element of the array swabbed.
2028 static void *__req_capsule_get(struct req_capsule *pill,
2029 const struct req_msg_field *field,
2030 enum req_location loc,
2031 void (*swabber)( void *),
2034 const struct req_format *fmt;
2035 struct lustre_msg *msg;
2040 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2042 static const char *rcl_names[RCL_NR] = {
2043 [RCL_CLIENT] = "client",
2044 [RCL_SERVER] = "server"
2047 LASSERT(pill != NULL);
2048 LASSERT(pill != LP_POISON);
2050 LASSERT(fmt != NULL);
2051 LASSERT(fmt != LP_POISON);
2052 LASSERT(__req_format_is_sane(fmt));
2054 offset = __req_capsule_offset(pill, field, loc);
2056 msg = __req_msg(pill, loc);
2057 LASSERT(msg != NULL);
2059 getter = (field->rmf_flags & RMF_F_STRING) ?
2060 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2062 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2064 * We've already asserted that field->rmf_size > 0 in
2065 * req_layout_init().
2067 len = lustre_msg_buflen(msg, offset);
2068 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2069 (len % field->rmf_size) != 0) {
2070 CERROR("%s: array field size mismatch "
2071 "%d modulo %u != 0 (%d)\n",
2072 field->rmf_name, len, field->rmf_size, loc);
2075 } else if (pill->rc_area[loc][offset] != -1) {
2076 len = pill->rc_area[loc][offset];
2078 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2080 value = getter(msg, offset, len);
2082 if (value == NULL) {
2083 DEBUG_REQ(D_ERROR, pill->rc_req,
2084 "Wrong buffer for field `%s' (%u of %u) "
2085 "in format `%s': %u vs. %u (%s)\n",
2086 field->rmf_name, offset, lustre_msg_bufcount(msg),
2087 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2090 swabber_dumper_helper(pill, field, loc, offset, value, len,
2098 * Dump a request and/or reply
2100 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2102 const struct req_format *fmt;
2103 const struct req_msg_field *field;
2109 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2110 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2111 field = FMT_FIELD(fmt, loc, i);
2112 if (field->rmf_dumper == NULL) {
2114 * FIXME Add a default hex dumper for fields that don't
2115 * have a specific dumper
2117 len = req_capsule_get_size(pill, field, loc);
2118 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2119 "field size is %u\n", field->rmf_name, len);
2121 /* It's the dumping side-effect that we're interested in */
2122 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2125 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2131 void req_capsule_client_dump(struct req_capsule *pill)
2133 __req_capsule_dump(pill, RCL_CLIENT);
2135 EXPORT_SYMBOL(req_capsule_client_dump);
2140 void req_capsule_server_dump(struct req_capsule *pill)
2142 __req_capsule_dump(pill, RCL_SERVER);
2144 EXPORT_SYMBOL(req_capsule_server_dump);
2147 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2148 * buffer corresponding to the given RMF (\a field) of a \a pill.
2150 void *req_capsule_client_get(struct req_capsule *pill,
2151 const struct req_msg_field *field)
2153 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2155 EXPORT_SYMBOL(req_capsule_client_get);
2158 * Same as req_capsule_client_get(), but with a \a swabber argument.
2160 * Currently unused; will be removed when req_capsule_server_swab_get() is
2163 void *req_capsule_client_swab_get(struct req_capsule *pill,
2164 const struct req_msg_field *field,
2167 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2169 EXPORT_SYMBOL(req_capsule_client_swab_get);
2172 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2174 * First the \a pill's request \a field's size is set (\a rc_area) using
2175 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2178 void *req_capsule_client_sized_get(struct req_capsule *pill,
2179 const struct req_msg_field *field,
2182 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2183 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2185 EXPORT_SYMBOL(req_capsule_client_sized_get);
2188 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2189 * buffer corresponding to the given RMF (\a field) of a \a pill.
2191 void *req_capsule_server_get(struct req_capsule *pill,
2192 const struct req_msg_field *field)
2194 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2196 EXPORT_SYMBOL(req_capsule_server_get);
2199 * Same as req_capsule_server_get(), but with a \a swabber argument.
2201 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2202 * swabbing done outside this capsule abstraction.
2204 void *req_capsule_server_swab_get(struct req_capsule *pill,
2205 const struct req_msg_field *field,
2208 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2210 EXPORT_SYMBOL(req_capsule_server_swab_get);
2213 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2215 * First the \a pill's request \a field's size is set (\a rc_area) using
2216 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2219 void *req_capsule_server_sized_get(struct req_capsule *pill,
2220 const struct req_msg_field *field,
2223 req_capsule_set_size(pill, field, RCL_SERVER, len);
2224 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2226 EXPORT_SYMBOL(req_capsule_server_sized_get);
2228 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2229 const struct req_msg_field *field,
2230 __u32 len, void *swabber)
2232 req_capsule_set_size(pill, field, RCL_SERVER, len);
2233 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2235 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2238 * Returns the buffer of a \a pill corresponding to the given \a field from the
2239 * request (if the caller is executing on the server-side) or reply (if the
2240 * caller is executing on the client-side).
2242 * This function convienient for use is code that could be executed on the
2243 * client and server alike.
2245 const void *req_capsule_other_get(struct req_capsule *pill,
2246 const struct req_msg_field *field)
2248 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2250 EXPORT_SYMBOL(req_capsule_other_get);
2253 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2254 * field of the given \a pill.
2256 * This function must be used when constructing variable sized fields of a
2259 void req_capsule_set_size(struct req_capsule *pill,
2260 const struct req_msg_field *field,
2261 enum req_location loc, __u32 size)
2263 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2265 if ((size != (__u32)field->rmf_size) &&
2266 (field->rmf_size != -1) &&
2267 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2269 __u32 rmf_size = (__u32)field->rmf_size;
2270 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2271 (size % rmf_size != 0)) {
2272 CERROR("%s: array field size mismatch "
2273 "%u %% %u != 0 (%d)\n",
2274 field->rmf_name, size, rmf_size, loc);
2276 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2278 CERROR("%s: field size mismatch %u != %u (%d)\n",
2279 field->rmf_name, size, rmf_size, loc);
2284 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2286 EXPORT_SYMBOL(req_capsule_set_size);
2289 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2290 * for the given \a pill's given \a field.
2292 * NB: this function doesn't correspond with req_capsule_set_size(), which
2293 * actually sets the size in pill.rc_area[loc][offset], but this function
2294 * returns the message buflen[offset], maybe we should use another name.
2296 __u32 req_capsule_get_size(const struct req_capsule *pill,
2297 const struct req_msg_field *field,
2298 enum req_location loc)
2300 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2302 return lustre_msg_buflen(__req_msg(pill, loc),
2303 __req_capsule_offset(pill, field, loc));
2305 EXPORT_SYMBOL(req_capsule_get_size);
2308 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2309 * given \a pill's request or reply (\a loc) given the field size recorded in
2310 * the \a pill's rc_area.
2312 * See also req_capsule_set_size().
2314 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2316 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2317 pill->rc_fmt->rf_fields[loc].nr,
2318 pill->rc_area[loc]);
2322 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2323 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2324 * PTLRPC request or reply given only an RQF (\a fmt).
2326 * This function should not be used for formats which contain variable size
2329 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2330 enum req_location loc)
2336 * This function should probably LASSERT() that fmt has no fields with
2337 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2338 * elements in the array there will ultimately be, but then, we could
2339 * assume that there will be at least one element, and that's just what
2342 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2346 for (; i < fmt->rf_fields[loc].nr; ++i)
2347 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2348 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2352 EXPORT_SYMBOL(req_capsule_fmt_size);
2355 * Changes the format of an RPC.
2357 * The pill must already have been initialized, which means that it already has
2358 * a request format. The new format \a fmt must be an extension of the pill's
2359 * old format. Specifically: the new format must have as many request and reply
2360 * fields as the old one, and all fields shared by the old and new format must
2361 * be at least as large in the new format.
2363 * The new format's fields may be of different "type" than the old format, but
2364 * only for fields that are "opaque" blobs: fields which have a) have no
2365 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2366 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2367 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2368 * according to the key field. When the value, according to the key, contains a
2369 * structure (or array thereof) to be swabbed, the format should be changed to
2370 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2373 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2378 const struct req_format *old;
2380 LASSERT(pill->rc_fmt != NULL);
2381 LASSERT(__req_format_is_sane(fmt));
2385 * Sanity checking...
2387 for (i = 0; i < RCL_NR; ++i) {
2388 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2389 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2390 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2392 /* "opaque" fields can be transmogrified */
2393 if (ofield->rmf_swabber == NULL &&
2394 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2395 (ofield->rmf_size == -1 ||
2396 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2398 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2401 * Last field in old format can be shorter than in new.
2403 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2404 FMT_FIELD(old, i, j)->rmf_size);
2409 EXPORT_SYMBOL(req_capsule_extend);
2412 * This function returns a non-zero value if the given \a field is present in
2413 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2416 int req_capsule_has_field(const struct req_capsule *pill,
2417 const struct req_msg_field *field,
2418 enum req_location loc)
2420 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2422 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2424 EXPORT_SYMBOL(req_capsule_has_field);
2427 * Returns a non-zero value if the given \a field is present in the given \a
2428 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2430 int req_capsule_field_present(const struct req_capsule *pill,
2431 const struct req_msg_field *field,
2432 enum req_location loc)
2436 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2437 LASSERT(req_capsule_has_field(pill, field, loc));
2439 offset = __req_capsule_offset(pill, field, loc);
2440 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2442 EXPORT_SYMBOL(req_capsule_field_present);
2445 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2446 * request or reply (\a loc).
2448 * This is not the opposite of req_capsule_extend().
2450 void req_capsule_shrink(struct req_capsule *pill,
2451 const struct req_msg_field *field,
2453 enum req_location loc)
2455 const struct req_format *fmt;
2456 struct lustre_msg *msg;
2461 LASSERT(fmt != NULL);
2462 LASSERT(__req_format_is_sane(fmt));
2463 LASSERT(req_capsule_has_field(pill, field, loc));
2464 LASSERT(req_capsule_field_present(pill, field, loc));
2466 offset = __req_capsule_offset(pill, field, loc);
2468 msg = __req_msg(pill, loc);
2469 len = lustre_msg_buflen(msg, offset);
2470 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2471 fmt->rf_name, field->rmf_name, len, newlen);
2473 if (loc == RCL_CLIENT)
2474 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2477 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2480 EXPORT_SYMBOL(req_capsule_shrink);
2482 int req_capsule_server_grow(struct req_capsule *pill,
2483 const struct req_msg_field *field,
2486 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2491 LASSERT(pill->rc_fmt != NULL);
2492 LASSERT(__req_format_is_sane(pill->rc_fmt));
2493 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2494 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2496 len = req_capsule_get_size(pill, field, RCL_SERVER);
2497 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2498 if ((__u32)pill->rc_req->rq_repbuf_len >=
2499 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2500 CERROR("Inplace repack might be done\n");
2502 pill->rc_req->rq_reply_state = NULL;
2503 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2504 rc = req_capsule_server_pack(pill);
2506 /* put old rs back, the caller will decide what to do */
2507 pill->rc_req->rq_reply_state = rs;
2510 nrs = pill->rc_req->rq_reply_state;
2511 /* Now we need only buffers, copy first chunk */
2512 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2513 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2514 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2515 memcpy(to, from, len);
2516 /* check if we have tail and copy it too */
2517 if (rs->rs_msg->lm_bufcount > offset + 1) {
2518 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2519 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2520 offset = rs->rs_msg->lm_bufcount - 1;
2521 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2522 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2523 memcpy(to, from, len);
2525 /* drop old reply if everything is fine */
2526 if (rs->rs_difficult) {
2530 nrs->rs_difficult = 1;
2531 nrs->rs_no_ack = rs->rs_no_ack;
2532 nrs->rs_convert_lock = rs->rs_convert_lock;
2533 for (i = 0; i < rs->rs_nlocks; i++) {
2534 nrs->rs_locks[i] = rs->rs_locks[i];
2535 nrs->rs_modes[i] = rs->rs_modes[i];
2539 rs->rs_difficult = 0;
2542 ptlrpc_rs_decref(rs);
2545 EXPORT_SYMBOL(req_capsule_server_grow);
2547 int req_check_sepol(struct req_capsule *pill)
2550 #ifdef HAVE_SERVER_SUPPORT
2551 struct obd_export *export;
2552 struct lu_nodemap *nm = NULL;
2553 const char *sepol = NULL;
2554 const char *nm_sepol = NULL;
2559 export = pill->rc_req->rq_export;
2560 if (!export || !exp_connect_sepol(export) ||
2561 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2564 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2567 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2568 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2572 nm = nodemap_get_from_exp(export);
2573 if (!IS_ERR_OR_NULL(nm)) {
2574 nm_sepol = nodemap_get_sepol(nm);
2575 if (nm_sepol && nm_sepol[0])
2576 if (sepol == NULL ||
2577 strcmp(sepol, nm_sepol) != 0)
2582 if (!IS_ERR_OR_NULL(nm))
2588 EXPORT_SYMBOL(req_check_sepol);