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 *mds_rmfid_client[] = {
348 static const struct req_msg_field *mds_rmfid_server[] = {
355 static const struct req_msg_field *obd_connect_client[] = {
364 static const struct req_msg_field *obd_connect_server[] = {
369 static const struct req_msg_field *obd_set_info_client[] = {
375 static const struct req_msg_field *ost_grant_shrink_client[] = {
381 static const struct req_msg_field *mds_getinfo_client[] = {
387 static const struct req_msg_field *mds_getinfo_server[] = {
392 static const struct req_msg_field *ldlm_enqueue_client[] = {
397 static const struct req_msg_field *ldlm_enqueue_server[] = {
402 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
408 static const struct req_msg_field *ldlm_cp_callback_client[] = {
414 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
420 static const struct req_msg_field *ldlm_gl_callback_server[] = {
425 static const struct req_msg_field *ldlm_intent_basic_client[] = {
431 static const struct req_msg_field *ldlm_intent_client[] = {
438 static const struct req_msg_field *ldlm_intent_server[] = {
446 static const struct req_msg_field *ldlm_intent_layout_client[] = {
451 &RMF_EADATA /* for new layout to be set up */
454 static const struct req_msg_field *ldlm_intent_open_server[] = {
466 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
470 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
473 &RMF_FILE_SECCTX_NAME
476 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
487 static const struct req_msg_field *ldlm_intent_create_client[] = {
491 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
495 &RMF_FILE_SECCTX_NAME,
500 static const struct req_msg_field *ldlm_intent_open_client[] = {
504 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
509 &RMF_FILE_SECCTX_NAME,
514 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
523 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
528 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
534 static const struct req_msg_field *mds_get_root_client[] = {
540 static const struct req_msg_field *mds_getxattr_client[] = {
549 static const struct req_msg_field *mds_getxattr_server[] = {
555 static const struct req_msg_field *mds_getattr_server[] = {
564 static const struct req_msg_field *mds_setattr_server[] = {
573 static const struct req_msg_field *mds_update_client[] = {
575 &RMF_OUT_UPDATE_HEADER,
579 static const struct req_msg_field *mds_update_server[] = {
581 &RMF_OUT_UPDATE_REPLY,
584 static const struct req_msg_field *llog_origin_handle_create_client[] = {
590 static const struct req_msg_field *llogd_body_only[] = {
595 static const struct req_msg_field *llog_log_hdr_only[] = {
600 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
606 static const struct req_msg_field *obd_idx_read_client[] = {
611 static const struct req_msg_field *obd_idx_read_server[] = {
616 static const struct req_msg_field *ost_body_only[] = {
621 static const struct req_msg_field *ost_body_capa[] = {
627 static const struct req_msg_field *ost_destroy_client[] = {
635 static const struct req_msg_field *ost_brw_client[] = {
644 static const struct req_msg_field *ost_brw_read_server[] = {
650 static const struct req_msg_field *ost_brw_write_server[] = {
656 static const struct req_msg_field *ost_get_info_generic_server[] = {
661 static const struct req_msg_field *ost_get_info_generic_client[] = {
666 static const struct req_msg_field *ost_get_last_id_server[] = {
671 static const struct req_msg_field *ost_get_last_fid_client[] = {
677 static const struct req_msg_field *ost_get_last_fid_server[] = {
682 static const struct req_msg_field *ost_get_fiemap_client[] = {
688 static const struct req_msg_field *ost_ladvise[] = {
691 &RMF_OST_LADVISE_HDR,
695 static const struct req_msg_field *ost_get_fiemap_server[] = {
700 static const struct req_msg_field *mdt_hsm_progress[] = {
703 &RMF_MDS_HSM_PROGRESS,
706 static const struct req_msg_field *mdt_hsm_ct_register[] = {
709 &RMF_MDS_HSM_ARCHIVE,
712 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
717 static const struct req_msg_field *mdt_hsm_action_server[] = {
720 &RMF_MDS_HSM_CURRENT_ACTION,
723 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
729 static const struct req_msg_field *mdt_hsm_state_set[] = {
736 static const struct req_msg_field *mdt_hsm_request[] = {
739 &RMF_MDS_HSM_REQUEST,
740 &RMF_MDS_HSM_USER_ITEM,
744 static const struct req_msg_field *obd_lfsck_request[] = {
749 static const struct req_msg_field *obd_lfsck_reply[] = {
754 static struct req_format *req_formats[] = {
760 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
763 &RQF_MGS_CONFIG_READ,
774 &RQF_MDS_GETATTR_NAME,
778 &RQF_MDS_CLOSE_INTENT,
781 &RQF_MDS_REINT_CREATE,
782 &RQF_MDS_REINT_CREATE_ACL,
783 &RQF_MDS_REINT_CREATE_SLAVE,
784 &RQF_MDS_REINT_CREATE_SYM,
786 &RQF_MDS_REINT_UNLINK,
788 &RQF_MDS_REINT_RENAME,
789 &RQF_MDS_REINT_MIGRATE,
790 &RQF_MDS_REINT_SETATTR,
791 &RQF_MDS_REINT_SETXATTR,
792 &RQF_MDS_REINT_RESYNC,
794 &RQF_MDS_HSM_PROGRESS,
795 &RQF_MDS_HSM_CT_REGISTER,
796 &RQF_MDS_HSM_CT_UNREGISTER,
797 &RQF_MDS_HSM_STATE_GET,
798 &RQF_MDS_HSM_STATE_SET,
800 &RQF_MDS_HSM_REQUEST,
801 &RQF_MDS_SWAP_LAYOUTS,
816 &RQF_OST_SET_GRANT_INFO,
818 &RQF_OST_GET_INFO_LAST_ID,
819 &RQF_OST_GET_INFO_LAST_FID,
820 &RQF_OST_SET_INFO_LAST_FID,
821 &RQF_OST_GET_INFO_FIEMAP,
824 &RQF_LDLM_ENQUEUE_LVB,
828 &RQF_LDLM_CP_CALLBACK,
829 &RQF_LDLM_BL_CALLBACK,
830 &RQF_LDLM_GL_CALLBACK,
831 &RQF_LDLM_GL_CALLBACK_DESC,
833 &RQF_LDLM_INTENT_BASIC,
834 &RQF_LDLM_INTENT_LAYOUT,
835 &RQF_LDLM_INTENT_GETATTR,
836 &RQF_LDLM_INTENT_OPEN,
837 &RQF_LDLM_INTENT_CREATE,
838 &RQF_LDLM_INTENT_GETXATTR,
839 &RQF_LDLM_INTENT_QUOTA,
841 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
842 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
843 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
844 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
850 struct req_msg_field {
851 const __u32 rmf_flags;
852 const char *rmf_name;
854 * Field length. (-1) means "variable length". If the
855 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
856 * but the actual size must be a whole multiple of \a rmf_size.
859 void (*rmf_swabber)(void *);
860 void (*rmf_dumper)(void *);
861 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
866 * The field is a string, must be NUL-terminated.
868 RMF_F_STRING = 1 << 0,
870 * The field's buffer size need not match the declared \a rmf_size.
872 RMF_F_NO_SIZE_CHECK = 1 << 1,
874 * The field's buffer size must be a whole multiple of the declared \a
875 * rmf_size and the \a rmf_swabber function must work on the declared \a
876 * rmf_size worth of bytes.
878 RMF_F_STRUCT_ARRAY = 1 << 2
886 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
887 .rmf_name = (name), \
888 .rmf_flags = (flags), \
889 .rmf_size = (size), \
890 .rmf_swabber = (void (*)(void*))(swabber), \
891 .rmf_dumper = (void (*)(void*))(dumper) \
894 struct req_msg_field RMF_GENERIC_DATA =
895 DEFINE_MSGF("generic_data", 0,
897 EXPORT_SYMBOL(RMF_GENERIC_DATA);
899 struct req_msg_field RMF_MGS_TARGET_INFO =
900 DEFINE_MSGF("mgs_target_info", 0,
901 sizeof(struct mgs_target_info),
902 lustre_swab_mgs_target_info, NULL);
903 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
905 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
906 struct req_msg_field RMF_MGS_SEND_PARAM =
907 DEFINE_MSGF("mgs_send_param", 0,
908 sizeof(struct mgs_send_param),
910 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
913 struct req_msg_field RMF_MGS_CONFIG_BODY =
914 DEFINE_MSGF("mgs_config_read request", 0,
915 sizeof(struct mgs_config_body),
916 lustre_swab_mgs_config_body, NULL);
917 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
919 struct req_msg_field RMF_MGS_CONFIG_RES =
920 DEFINE_MSGF("mgs_config_read reply ", 0,
921 sizeof(struct mgs_config_res),
922 lustre_swab_mgs_config_res, NULL);
923 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
925 struct req_msg_field RMF_U32 =
926 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
927 sizeof(__u32), lustre_swab_generic_32s, NULL);
928 EXPORT_SYMBOL(RMF_U32);
930 struct req_msg_field RMF_SETINFO_VAL =
931 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
932 EXPORT_SYMBOL(RMF_SETINFO_VAL);
934 struct req_msg_field RMF_GETINFO_KEY =
935 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
936 EXPORT_SYMBOL(RMF_GETINFO_KEY);
938 struct req_msg_field RMF_GETINFO_VALLEN =
939 DEFINE_MSGF("getinfo_vallen", 0,
940 sizeof(__u32), lustre_swab_generic_32s, NULL);
941 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
943 struct req_msg_field RMF_GETINFO_VAL =
944 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
945 EXPORT_SYMBOL(RMF_GETINFO_VAL);
947 struct req_msg_field RMF_SEQ_OPC =
948 DEFINE_MSGF("seq_query_opc", 0,
949 sizeof(__u32), lustre_swab_generic_32s, NULL);
950 EXPORT_SYMBOL(RMF_SEQ_OPC);
952 struct req_msg_field RMF_SEQ_RANGE =
953 DEFINE_MSGF("seq_query_range", 0,
954 sizeof(struct lu_seq_range),
955 lustre_swab_lu_seq_range, NULL);
956 EXPORT_SYMBOL(RMF_SEQ_RANGE);
958 struct req_msg_field RMF_FLD_OPC =
959 DEFINE_MSGF("fld_query_opc", 0,
960 sizeof(__u32), lustre_swab_generic_32s, NULL);
961 EXPORT_SYMBOL(RMF_FLD_OPC);
963 struct req_msg_field RMF_FLD_MDFLD =
964 DEFINE_MSGF("fld_query_mdfld", 0,
965 sizeof(struct lu_seq_range),
966 lustre_swab_lu_seq_range, NULL);
967 EXPORT_SYMBOL(RMF_FLD_MDFLD);
969 struct req_msg_field RMF_MDT_BODY =
970 DEFINE_MSGF("mdt_body", 0,
971 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
972 EXPORT_SYMBOL(RMF_MDT_BODY);
974 struct req_msg_field RMF_OBD_QUOTACTL =
975 DEFINE_MSGF("obd_quotactl", 0,
976 sizeof(struct obd_quotactl),
977 lustre_swab_obd_quotactl, NULL);
978 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
980 struct req_msg_field RMF_QUOTA_BODY =
981 DEFINE_MSGF("quota_body", 0,
982 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
983 EXPORT_SYMBOL(RMF_QUOTA_BODY);
985 struct req_msg_field RMF_MDT_EPOCH =
986 DEFINE_MSGF("mdt_ioepoch", 0,
987 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
988 EXPORT_SYMBOL(RMF_MDT_EPOCH);
990 struct req_msg_field RMF_PTLRPC_BODY =
991 DEFINE_MSGF("ptlrpc_body", 0,
992 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
993 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
995 struct req_msg_field RMF_CLOSE_DATA =
996 DEFINE_MSGF("data_version", 0,
997 sizeof(struct close_data), lustre_swab_close_data, NULL);
998 EXPORT_SYMBOL(RMF_CLOSE_DATA);
1000 struct req_msg_field RMF_OBD_STATFS =
1001 DEFINE_MSGF("obd_statfs", 0,
1002 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
1003 EXPORT_SYMBOL(RMF_OBD_STATFS);
1005 struct req_msg_field RMF_SETINFO_KEY =
1006 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
1007 EXPORT_SYMBOL(RMF_SETINFO_KEY);
1009 struct req_msg_field RMF_NAME =
1010 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
1011 EXPORT_SYMBOL(RMF_NAME);
1013 struct req_msg_field RMF_FID_ARRAY =
1014 DEFINE_MSGF("fid_array", 0, -1, NULL, NULL);
1015 EXPORT_SYMBOL(RMF_FID_ARRAY);
1017 struct req_msg_field RMF_SYMTGT =
1018 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
1019 EXPORT_SYMBOL(RMF_SYMTGT);
1021 struct req_msg_field RMF_TGTUUID =
1022 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1024 EXPORT_SYMBOL(RMF_TGTUUID);
1026 struct req_msg_field RMF_CLUUID =
1027 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1029 EXPORT_SYMBOL(RMF_CLUUID);
1031 struct req_msg_field RMF_STRING =
1032 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1033 EXPORT_SYMBOL(RMF_STRING);
1035 struct req_msg_field RMF_FILE_SECCTX_NAME =
1036 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1037 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1039 struct req_msg_field RMF_FILE_SECCTX =
1040 DEFINE_MSGF("file_secctx", RMF_F_NO_SIZE_CHECK, -1, NULL, NULL);
1041 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1043 struct req_msg_field RMF_LLOGD_BODY =
1044 DEFINE_MSGF("llogd_body", 0,
1045 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1046 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1048 struct req_msg_field RMF_LLOG_LOG_HDR =
1049 DEFINE_MSGF("llog_log_hdr", 0,
1050 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1051 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1053 struct req_msg_field RMF_LLOGD_CONN_BODY =
1054 DEFINE_MSGF("llogd_conn_body", 0,
1055 sizeof(struct llogd_conn_body),
1056 lustre_swab_llogd_conn_body, NULL);
1057 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1060 * connection handle received in MDS_CONNECT request.
1062 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1063 * that the client does not interpret at all.
1065 struct req_msg_field RMF_CONN =
1066 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1067 EXPORT_SYMBOL(RMF_CONN);
1069 struct req_msg_field RMF_CONNECT_DATA =
1070 DEFINE_MSGF("cdata",
1071 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1072 sizeof(struct obd_connect_data),
1073 lustre_swab_connect, NULL);
1074 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1076 struct req_msg_field RMF_DLM_REQ =
1077 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1078 sizeof(struct ldlm_request),
1079 lustre_swab_ldlm_request, NULL);
1080 EXPORT_SYMBOL(RMF_DLM_REQ);
1082 struct req_msg_field RMF_DLM_REP =
1083 DEFINE_MSGF("dlm_rep", 0,
1084 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1085 EXPORT_SYMBOL(RMF_DLM_REP);
1087 struct req_msg_field RMF_LDLM_INTENT =
1088 DEFINE_MSGF("ldlm_intent", 0,
1089 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1090 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1092 struct req_msg_field RMF_DLM_LVB =
1093 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1094 EXPORT_SYMBOL(RMF_DLM_LVB);
1096 struct req_msg_field RMF_DLM_GL_DESC =
1097 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1098 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1100 struct req_msg_field RMF_MDT_MD =
1101 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1102 EXPORT_SYMBOL(RMF_MDT_MD);
1104 struct req_msg_field RMF_DEFAULT_MDT_MD =
1105 DEFINE_MSGF("default_mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL,
1107 EXPORT_SYMBOL(RMF_DEFAULT_MDT_MD);
1109 struct req_msg_field RMF_REC_REINT =
1110 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1111 lustre_swab_mdt_rec_reint, NULL);
1112 EXPORT_SYMBOL(RMF_REC_REINT);
1114 /* FIXME: this length should be defined as a macro */
1115 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1117 EXPORT_SYMBOL(RMF_EADATA);
1119 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1120 EXPORT_SYMBOL(RMF_EAVALS);
1122 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1123 EXPORT_SYMBOL(RMF_ACL);
1125 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1126 struct req_msg_field RMF_LOGCOOKIES =
1127 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1128 sizeof(struct llog_cookie), NULL, NULL);
1129 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1131 struct req_msg_field RMF_CAPA1 =
1132 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1133 EXPORT_SYMBOL(RMF_CAPA1);
1135 struct req_msg_field RMF_CAPA2 =
1136 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1137 EXPORT_SYMBOL(RMF_CAPA2);
1139 struct req_msg_field RMF_LAYOUT_INTENT =
1140 DEFINE_MSGF("layout_intent", 0,
1141 sizeof(struct layout_intent), lustre_swab_layout_intent,
1143 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1145 struct req_msg_field RMF_SELINUX_POL =
1146 DEFINE_MSGF("selinux_pol", RMF_F_STRING, -1, NULL, NULL);
1147 EXPORT_SYMBOL(RMF_SELINUX_POL);
1150 * OST request field.
1152 struct req_msg_field RMF_OST_BODY =
1153 DEFINE_MSGF("ost_body", 0,
1154 sizeof(struct ost_body), lustre_swab_ost_body,
1156 EXPORT_SYMBOL(RMF_OST_BODY);
1158 struct req_msg_field RMF_OBD_IOOBJ =
1159 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1160 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1161 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1163 struct req_msg_field RMF_NIOBUF_REMOTE =
1164 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1165 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1167 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1169 struct req_msg_field RMF_NIOBUF_INLINE =
1170 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1171 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1173 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1175 struct req_msg_field RMF_RCS =
1176 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1177 lustre_swab_generic_32s, dump_rcs);
1178 EXPORT_SYMBOL(RMF_RCS);
1180 struct req_msg_field RMF_EAVALS_LENS =
1181 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1182 lustre_swab_generic_32s, NULL);
1183 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1185 struct req_msg_field RMF_OBD_ID =
1186 DEFINE_MSGF("obd_id", 0,
1187 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1188 EXPORT_SYMBOL(RMF_OBD_ID);
1190 struct req_msg_field RMF_FID =
1191 DEFINE_MSGF("fid", 0,
1192 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1193 EXPORT_SYMBOL(RMF_FID);
1195 struct req_msg_field RMF_OST_ID =
1196 DEFINE_MSGF("ost_id", 0,
1197 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1198 EXPORT_SYMBOL(RMF_OST_ID);
1200 struct req_msg_field RMF_FIEMAP_KEY =
1201 DEFINE_MSGF("fiemap_key", 0, sizeof(struct ll_fiemap_info_key),
1202 lustre_swab_fiemap_info_key, NULL);
1203 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1205 struct req_msg_field RMF_FIEMAP_VAL =
1206 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1207 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1209 struct req_msg_field RMF_IDX_INFO =
1210 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1211 lustre_swab_idx_info, NULL);
1212 EXPORT_SYMBOL(RMF_IDX_INFO);
1213 struct req_msg_field RMF_SHORT_IO =
1214 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1215 EXPORT_SYMBOL(RMF_SHORT_IO);
1216 struct req_msg_field RMF_HSM_USER_STATE =
1217 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1218 lustre_swab_hsm_user_state, NULL);
1219 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1221 struct req_msg_field RMF_HSM_STATE_SET =
1222 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1223 lustre_swab_hsm_state_set, NULL);
1224 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1226 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1227 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1228 lustre_swab_hsm_progress_kernel, NULL);
1229 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1231 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1232 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1233 lustre_swab_hsm_current_action, NULL);
1234 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1236 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1237 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1238 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1240 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1242 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1243 DEFINE_MSGF("hsm_archive", RMF_F_STRUCT_ARRAY,
1244 sizeof(__u32), lustre_swab_generic_32s, NULL);
1245 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1247 struct req_msg_field RMF_MDS_HSM_REQUEST =
1248 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1249 lustre_swab_hsm_request, NULL);
1250 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1252 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1253 lustre_swab_object_update_request, NULL);
1254 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1256 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1257 DEFINE_MSGF("object_update_reply", 0, -1,
1258 lustre_swab_object_update_reply, NULL);
1259 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1261 struct req_msg_field RMF_SWAP_LAYOUTS =
1262 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1263 lustre_swab_swap_layouts, NULL);
1264 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1266 struct req_msg_field RMF_LFSCK_REQUEST =
1267 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1268 lustre_swab_lfsck_request, NULL);
1269 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1271 struct req_msg_field RMF_LFSCK_REPLY =
1272 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1273 lustre_swab_lfsck_reply, NULL);
1274 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1276 struct req_msg_field RMF_OST_LADVISE_HDR =
1277 DEFINE_MSGF("ladvise_request", 0,
1278 sizeof(struct ladvise_hdr),
1279 lustre_swab_ladvise_hdr, NULL);
1280 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1282 struct req_msg_field RMF_OST_LADVISE =
1283 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1284 sizeof(struct lu_ladvise),
1285 lustre_swab_ladvise, NULL);
1286 EXPORT_SYMBOL(RMF_OST_LADVISE);
1288 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1289 -1, lustre_swab_out_update_header, NULL);
1290 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1292 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1293 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1294 lustre_swab_out_update_buffer, NULL);
1295 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1302 const char *rf_name;
1306 const struct req_msg_field **d;
1307 } rf_fields[RCL_NR];
1310 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1324 #define DEFINE_REQ_FMT0(name, client, server) \
1325 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1327 struct req_format RQF_OBD_PING =
1328 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1329 EXPORT_SYMBOL(RQF_OBD_PING);
1331 struct req_format RQF_OBD_SET_INFO =
1332 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1333 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1335 /* Read index file through the network */
1336 struct req_format RQF_OBD_IDX_READ =
1337 DEFINE_REQ_FMT0("OBD_IDX_READ",
1338 obd_idx_read_client, obd_idx_read_server);
1339 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1341 struct req_format RQF_SEC_CTX =
1342 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1343 EXPORT_SYMBOL(RQF_SEC_CTX);
1345 struct req_format RQF_MGS_TARGET_REG =
1346 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1347 mgs_target_info_only);
1348 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1350 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1351 struct req_format RQF_MGS_SET_INFO =
1352 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1354 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1357 struct req_format RQF_MGS_CONFIG_READ =
1358 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1359 mgs_config_read_server);
1360 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1362 struct req_format RQF_SEQ_QUERY =
1363 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1364 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1366 struct req_format RQF_FLD_QUERY =
1367 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1368 EXPORT_SYMBOL(RQF_FLD_QUERY);
1370 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1371 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1372 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1373 * peers need to handle the RPC reply with fixed little-endian format.
1375 * In theory, we can define new structure with some swabber registered to
1376 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1377 * implementation view, it is not easy to be done within current "struct
1378 * req_msg_field" framework. Because the sequence range array in the RPC
1379 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1380 * count, that is unknown when prepare the RPC buffer. Generally, for such
1381 * flexible length RPC usage, there will be a field in the RPC layout to
1382 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1383 * do that unless we add new length filed that will broken the on-wire RPC
1384 * protocol and cause interoperability trouble with old peer. */
1385 struct req_format RQF_FLD_READ =
1386 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1387 EXPORT_SYMBOL(RQF_FLD_READ);
1389 struct req_format RQF_MDS_QUOTACTL =
1390 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1391 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1393 struct req_format RQF_OST_QUOTACTL =
1394 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1395 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1397 struct req_format RQF_QUOTA_DQACQ =
1398 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1399 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1401 struct req_format RQF_LDLM_INTENT_QUOTA =
1402 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1403 ldlm_intent_quota_client,
1404 ldlm_intent_quota_server);
1405 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1407 struct req_format RQF_MDS_GET_ROOT =
1408 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1409 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1411 struct req_format RQF_MDS_STATFS =
1412 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1413 EXPORT_SYMBOL(RQF_MDS_STATFS);
1415 struct req_format RQF_MDS_STATFS_NEW =
1416 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1417 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1419 struct req_format RQF_MDS_SYNC =
1420 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1421 EXPORT_SYMBOL(RQF_MDS_SYNC);
1423 struct req_format RQF_MDS_GETATTR =
1424 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1425 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1427 struct req_format RQF_MDS_GETXATTR =
1428 DEFINE_REQ_FMT0("MDS_GETXATTR",
1429 mds_getxattr_client, mds_getxattr_server);
1430 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1432 struct req_format RQF_MDS_GETATTR_NAME =
1433 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1434 mds_getattr_name_client, mds_getattr_server);
1435 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1437 struct req_format RQF_MDS_REINT =
1438 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1439 EXPORT_SYMBOL(RQF_MDS_REINT);
1441 struct req_format RQF_MDS_REINT_CREATE =
1442 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1443 mds_reint_create_client, mdt_body_capa);
1444 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1446 struct req_format RQF_MDS_REINT_CREATE_ACL =
1447 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1448 mds_reint_create_acl_client, mdt_body_capa);
1449 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1451 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1452 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1453 mds_reint_create_slave_client, mdt_body_capa);
1454 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1456 struct req_format RQF_MDS_REINT_CREATE_SYM =
1457 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1458 mds_reint_create_sym_client, mdt_body_capa);
1459 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1461 struct req_format RQF_MDS_REINT_OPEN =
1462 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1463 mds_reint_open_client, mds_reint_open_server);
1464 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1466 struct req_format RQF_MDS_REINT_UNLINK =
1467 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1468 mds_last_unlink_server);
1469 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1471 struct req_format RQF_MDS_REINT_LINK =
1472 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1473 mds_reint_link_client, mdt_body_only);
1474 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1476 struct req_format RQF_MDS_REINT_RENAME =
1477 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1478 mds_last_unlink_server);
1479 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1481 struct req_format RQF_MDS_REINT_MIGRATE =
1482 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1483 mds_last_unlink_server);
1484 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1486 struct req_format RQF_MDS_REINT_SETATTR =
1487 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1488 mds_reint_setattr_client, mds_setattr_server);
1489 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1491 struct req_format RQF_MDS_REINT_SETXATTR =
1492 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1493 mds_reint_setxattr_client, mdt_body_only);
1494 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1496 struct req_format RQF_MDS_REINT_RESYNC =
1497 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1498 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1500 struct req_format RQF_MDS_CONNECT =
1501 DEFINE_REQ_FMT0("MDS_CONNECT",
1502 obd_connect_client, obd_connect_server);
1503 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1505 struct req_format RQF_MDS_DISCONNECT =
1506 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1507 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1509 struct req_format RQF_MDS_GET_INFO =
1510 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1511 mds_getinfo_server);
1512 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1514 struct req_format RQF_OUT_UPDATE =
1515 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1517 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1519 struct req_format RQF_LDLM_ENQUEUE =
1520 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1521 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1522 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1524 struct req_format RQF_LDLM_ENQUEUE_LVB =
1525 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1526 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1527 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1529 struct req_format RQF_LDLM_CONVERT =
1530 DEFINE_REQ_FMT0("LDLM_CONVERT",
1531 ldlm_enqueue_client, ldlm_enqueue_server);
1532 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1534 struct req_format RQF_LDLM_CANCEL =
1535 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1536 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1538 struct req_format RQF_LDLM_CALLBACK =
1539 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1540 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1542 struct req_format RQF_LDLM_CP_CALLBACK =
1543 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1544 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1546 struct req_format RQF_LDLM_BL_CALLBACK =
1547 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1548 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1550 struct req_format RQF_LDLM_GL_CALLBACK =
1551 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1552 ldlm_gl_callback_server);
1553 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1555 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1556 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1557 ldlm_gl_callback_server);
1558 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1560 struct req_format RQF_LDLM_INTENT_BASIC =
1561 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1562 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1563 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1565 struct req_format RQF_LDLM_INTENT =
1566 DEFINE_REQ_FMT0("LDLM_INTENT",
1567 ldlm_intent_client, ldlm_intent_server);
1568 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1570 struct req_format RQF_LDLM_INTENT_LAYOUT =
1571 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1572 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1573 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1575 struct req_format RQF_LDLM_INTENT_GETATTR =
1576 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1577 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1578 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1580 struct req_format RQF_LDLM_INTENT_OPEN =
1581 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1582 ldlm_intent_open_client, ldlm_intent_open_server);
1583 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1585 struct req_format RQF_LDLM_INTENT_CREATE =
1586 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1587 ldlm_intent_create_client, ldlm_intent_getattr_server);
1588 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1590 struct req_format RQF_LDLM_INTENT_GETXATTR =
1591 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1592 ldlm_intent_getxattr_client,
1593 ldlm_intent_getxattr_server);
1594 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1596 struct req_format RQF_MDS_CLOSE =
1597 DEFINE_REQ_FMT0("MDS_CLOSE",
1598 mdt_close_client, mds_last_unlink_server);
1599 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1601 struct req_format RQF_MDS_CLOSE_INTENT =
1602 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1603 mdt_close_intent_client, mds_last_unlink_server);
1604 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1606 struct req_format RQF_MDS_READPAGE =
1607 DEFINE_REQ_FMT0("MDS_READPAGE",
1608 mdt_body_capa, mdt_body_only);
1609 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1611 struct req_format RQF_MDS_HSM_ACTION =
1612 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1613 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1615 struct req_format RQF_MDS_HSM_PROGRESS =
1616 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1617 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1619 struct req_format RQF_MDS_HSM_CT_REGISTER =
1620 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1621 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1623 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1624 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1625 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1627 struct req_format RQF_MDS_HSM_STATE_GET =
1628 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1629 mdt_body_capa, mdt_hsm_state_get_server);
1630 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1632 struct req_format RQF_MDS_HSM_STATE_SET =
1633 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1634 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1636 struct req_format RQF_MDS_HSM_REQUEST =
1637 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1638 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1640 struct req_format RQF_MDS_SWAP_LAYOUTS =
1641 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1642 mdt_swap_layouts, empty);
1643 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1645 struct req_format RQF_MDS_RMFID =
1646 DEFINE_REQ_FMT0("MDS_RMFID", mds_rmfid_client,
1648 EXPORT_SYMBOL(RQF_MDS_RMFID);
1650 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1651 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1652 llog_origin_handle_create_client, llogd_body_only);
1653 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1655 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1656 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1657 llogd_body_only, llog_origin_handle_next_block_server);
1658 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1660 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1661 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1662 llogd_body_only, llog_origin_handle_next_block_server);
1663 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1665 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1666 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1667 llogd_body_only, llog_log_hdr_only);
1668 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1670 struct req_format RQF_CONNECT =
1671 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1672 EXPORT_SYMBOL(RQF_CONNECT);
1674 struct req_format RQF_OST_CONNECT =
1675 DEFINE_REQ_FMT0("OST_CONNECT",
1676 obd_connect_client, obd_connect_server);
1677 EXPORT_SYMBOL(RQF_OST_CONNECT);
1679 struct req_format RQF_OST_DISCONNECT =
1680 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1681 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1683 struct req_format RQF_OST_GETATTR =
1684 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1685 EXPORT_SYMBOL(RQF_OST_GETATTR);
1687 struct req_format RQF_OST_SETATTR =
1688 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1689 EXPORT_SYMBOL(RQF_OST_SETATTR);
1691 struct req_format RQF_OST_CREATE =
1692 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1693 EXPORT_SYMBOL(RQF_OST_CREATE);
1695 struct req_format RQF_OST_PUNCH =
1696 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1697 EXPORT_SYMBOL(RQF_OST_PUNCH);
1699 struct req_format RQF_OST_SYNC =
1700 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1701 EXPORT_SYMBOL(RQF_OST_SYNC);
1703 struct req_format RQF_OST_DESTROY =
1704 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1705 EXPORT_SYMBOL(RQF_OST_DESTROY);
1707 struct req_format RQF_OST_BRW_READ =
1708 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1709 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1711 struct req_format RQF_OST_BRW_WRITE =
1712 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1713 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1715 struct req_format RQF_OST_STATFS =
1716 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1717 EXPORT_SYMBOL(RQF_OST_STATFS);
1719 struct req_format RQF_OST_SET_GRANT_INFO =
1720 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1722 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1724 struct req_format RQF_OST_GET_INFO =
1725 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1726 ost_get_info_generic_server);
1727 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1729 struct req_format RQF_OST_GET_INFO_LAST_ID =
1730 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1731 ost_get_last_id_server);
1732 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1734 struct req_format RQF_OST_GET_INFO_LAST_FID =
1735 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1736 ost_get_last_fid_server);
1737 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1739 struct req_format RQF_OST_SET_INFO_LAST_FID =
1740 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1742 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1744 struct req_format RQF_OST_GET_INFO_FIEMAP =
1745 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1746 ost_get_fiemap_server);
1747 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1749 struct req_format RQF_LFSCK_NOTIFY =
1750 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1751 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1753 struct req_format RQF_LFSCK_QUERY =
1754 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1755 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1757 struct req_format RQF_OST_LADVISE =
1758 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1759 EXPORT_SYMBOL(RQF_OST_LADVISE);
1761 /* Convenience macro */
1762 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1765 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1766 * field of RQFs and the \a rmf_offset field of RMFs.
1768 int req_layout_init(void)
1773 struct req_format *rf = NULL;
1775 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1776 rf = req_formats[i];
1778 for (j = 0; j < RCL_NR; ++j) {
1779 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1780 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1781 struct req_msg_field *field;
1783 field = (typeof(field))rf->rf_fields[j].d[k];
1784 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1785 || field->rmf_size > 0);
1786 LASSERT(field->rmf_offset[i][j] == 0);
1788 * k + 1 to detect unused format/field
1791 field->rmf_offset[i][j] = k + 1;
1797 EXPORT_SYMBOL(req_layout_init);
1799 void req_layout_fini(void)
1802 EXPORT_SYMBOL(req_layout_fini);
1805 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1807 * Actual/expected field sizes are set elsewhere in functions in this file:
1808 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1809 * req_capsule_msg_size(). The \a rc_area information is used by.
1810 * ptlrpc_request_set_replen().
1812 void req_capsule_init_area(struct req_capsule *pill)
1816 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1817 pill->rc_area[RCL_CLIENT][i] = -1;
1818 pill->rc_area[RCL_SERVER][i] = -1;
1821 EXPORT_SYMBOL(req_capsule_init_area);
1824 * Initialize a pill.
1826 * The \a location indicates whether the caller is executing on the client side
1827 * (RCL_CLIENT) or server side (RCL_SERVER)..
1829 void req_capsule_init(struct req_capsule *pill,
1830 struct ptlrpc_request *req,
1831 enum req_location location)
1833 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1836 * Today all capsules are embedded in ptlrpc_request structs,
1837 * but just in case that ever isn't the case, we don't reach
1838 * into req unless req != NULL and pill is the one embedded in
1841 * The req->rq_pill_init flag makes it safe to initialize a pill
1842 * twice, which might happen in the OST paths as a result of the
1843 * high-priority RPC queue getting peeked at before ost_handle()
1844 * handles an OST RPC.
1846 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1849 memset(pill, 0, sizeof *pill);
1851 pill->rc_loc = location;
1852 req_capsule_init_area(pill);
1854 if (req != NULL && pill == &req->rq_pill)
1855 req->rq_pill_init = 1;
1857 EXPORT_SYMBOL(req_capsule_init);
1859 void req_capsule_fini(struct req_capsule *pill)
1862 EXPORT_SYMBOL(req_capsule_fini);
1864 static int __req_format_is_sane(const struct req_format *fmt)
1866 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1867 req_formats[fmt->rf_idx] == fmt;
1870 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1871 enum req_location loc)
1873 struct ptlrpc_request *req;
1876 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1880 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1881 * (see req_capsule_extend()).
1883 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1885 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1886 LASSERT(__req_format_is_sane(fmt));
1890 EXPORT_SYMBOL(req_capsule_set);
1893 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1896 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1897 * variable-sized fields. The field sizes come from the declared \a rmf_size
1898 * field of a \a pill's \a rc_fmt's RMF's.
1900 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1901 enum req_location loc)
1903 const struct req_format *fmt = pill->rc_fmt;
1906 LASSERT(fmt != NULL);
1908 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1909 if (pill->rc_area[loc][i] == -1) {
1910 pill->rc_area[loc][i] =
1911 fmt->rf_fields[loc].d[i]->rmf_size;
1912 if (pill->rc_area[loc][i] == -1) {
1914 * Skip the following fields.
1916 * If this LASSERT() trips then you're missing a
1917 * call to req_capsule_set_size().
1919 LASSERT(loc != RCL_SERVER);
1926 EXPORT_SYMBOL(req_capsule_filled_sizes);
1929 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1931 * This function uses the \a pill's \a rc_area as filled in by
1932 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1935 int req_capsule_server_pack(struct req_capsule *pill)
1937 const struct req_format *fmt;
1941 LASSERT(pill->rc_loc == RCL_SERVER);
1943 LASSERT(fmt != NULL);
1945 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1946 rc = lustre_pack_reply(pill->rc_req, count,
1947 pill->rc_area[RCL_SERVER], NULL);
1949 DEBUG_REQ(D_ERROR, pill->rc_req,
1950 "Cannot pack %d fields in format '%s'",
1951 count, fmt->rf_name);
1955 EXPORT_SYMBOL(req_capsule_server_pack);
1958 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1959 * corresponding to the given RMF (\a field).
1961 __u32 __req_capsule_offset(const struct req_capsule *pill,
1962 const struct req_msg_field *field,
1963 enum req_location loc)
1965 unsigned int offset;
1967 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1968 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1969 pill->rc_fmt->rf_name,
1970 field->rmf_name, offset, loc);
1973 LASSERT(offset < REQ_MAX_FIELD_NR);
1978 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1983 swabber_dumper_helper(struct req_capsule *pill,
1984 const struct req_msg_field *field,
1985 enum req_location loc,
1987 void *value, int len, int dump, void (*swabber)( void *))
1993 int inout = loc == RCL_CLIENT;
1995 swabber = swabber ?: field->rmf_swabber;
1997 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1998 swabber != NULL && value != NULL)
2003 if (!field->rmf_dumper)
2006 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
2008 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
2009 do_swab ? "unswabbed " : "", field->rmf_name);
2010 field->rmf_dumper(value);
2015 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2017 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
2018 "follows\n", field->rmf_name);
2019 field->rmf_dumper(value);
2026 * We're swabbing an array; swabber() swabs a single array element, so
2027 * swab every element.
2029 LASSERT((len % field->rmf_size) == 0);
2030 for (p = value, i = 0, n = len / field->rmf_size;
2032 i++, p += field->rmf_size) {
2034 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2035 "element %d follows\n",
2036 do_swab ? "unswabbed " : "", field->rmf_name, i);
2037 field->rmf_dumper(p);
2043 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2044 "element %d follows\n", field->rmf_name, i);
2045 field->rmf_dumper(value);
2049 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2053 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2054 * corresponding to the given RMF (\a field).
2056 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2057 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2058 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2059 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2060 * element of the array swabbed.
2062 static void *__req_capsule_get(struct req_capsule *pill,
2063 const struct req_msg_field *field,
2064 enum req_location loc,
2065 void (*swabber)( void *),
2068 const struct req_format *fmt;
2069 struct lustre_msg *msg;
2074 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2076 static const char *rcl_names[RCL_NR] = {
2077 [RCL_CLIENT] = "client",
2078 [RCL_SERVER] = "server"
2081 LASSERT(pill != NULL);
2082 LASSERT(pill != LP_POISON);
2084 LASSERT(fmt != NULL);
2085 LASSERT(fmt != LP_POISON);
2086 LASSERT(__req_format_is_sane(fmt));
2088 offset = __req_capsule_offset(pill, field, loc);
2090 msg = __req_msg(pill, loc);
2091 LASSERT(msg != NULL);
2093 getter = (field->rmf_flags & RMF_F_STRING) ?
2094 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2096 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2098 * We've already asserted that field->rmf_size > 0 in
2099 * req_layout_init().
2101 len = lustre_msg_buflen(msg, offset);
2102 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2103 (len % field->rmf_size) != 0) {
2104 CERROR("%s: array field size mismatch "
2105 "%d modulo %u != 0 (%d)\n",
2106 field->rmf_name, len, field->rmf_size, loc);
2109 } else if (pill->rc_area[loc][offset] != -1) {
2110 len = pill->rc_area[loc][offset];
2112 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2114 value = getter(msg, offset, len);
2116 if (value == NULL) {
2117 DEBUG_REQ(D_ERROR, pill->rc_req,
2118 "Wrong buffer for field '%s' (%u of %u) in format '%s', %u vs. %u (%s)",
2119 field->rmf_name, offset, lustre_msg_bufcount(msg),
2120 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2123 swabber_dumper_helper(pill, field, loc, offset, value, len,
2131 * Dump a request and/or reply
2133 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2135 const struct req_format *fmt;
2136 const struct req_msg_field *field;
2142 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP");
2143 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2144 field = FMT_FIELD(fmt, loc, i);
2145 if (field->rmf_dumper == NULL) {
2147 * FIXME Add a default hex dumper for fields that don't
2148 * have a specific dumper
2150 len = req_capsule_get_size(pill, field, loc);
2151 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2152 "field size is %u\n", field->rmf_name, len);
2154 /* It's dumping side-effect that we're interested in */
2155 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2158 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2164 void req_capsule_client_dump(struct req_capsule *pill)
2166 __req_capsule_dump(pill, RCL_CLIENT);
2168 EXPORT_SYMBOL(req_capsule_client_dump);
2173 void req_capsule_server_dump(struct req_capsule *pill)
2175 __req_capsule_dump(pill, RCL_SERVER);
2177 EXPORT_SYMBOL(req_capsule_server_dump);
2180 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2181 * buffer corresponding to the given RMF (\a field) of a \a pill.
2183 void *req_capsule_client_get(struct req_capsule *pill,
2184 const struct req_msg_field *field)
2186 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2188 EXPORT_SYMBOL(req_capsule_client_get);
2191 * Same as req_capsule_client_get(), but with a \a swabber argument.
2193 * Currently unused; will be removed when req_capsule_server_swab_get() is
2196 void *req_capsule_client_swab_get(struct req_capsule *pill,
2197 const struct req_msg_field *field,
2200 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2202 EXPORT_SYMBOL(req_capsule_client_swab_get);
2205 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2207 * First the \a pill's request \a field's size is set (\a rc_area) using
2208 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2211 void *req_capsule_client_sized_get(struct req_capsule *pill,
2212 const struct req_msg_field *field,
2215 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2216 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2218 EXPORT_SYMBOL(req_capsule_client_sized_get);
2221 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2222 * buffer corresponding to the given RMF (\a field) of a \a pill.
2224 void *req_capsule_server_get(struct req_capsule *pill,
2225 const struct req_msg_field *field)
2227 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2229 EXPORT_SYMBOL(req_capsule_server_get);
2232 * Same as req_capsule_server_get(), but with a \a swabber argument.
2234 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2235 * swabbing done outside this capsule abstraction.
2237 void *req_capsule_server_swab_get(struct req_capsule *pill,
2238 const struct req_msg_field *field,
2241 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2243 EXPORT_SYMBOL(req_capsule_server_swab_get);
2246 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2248 * First the \a pill's request \a field's size is set (\a rc_area) using
2249 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2252 void *req_capsule_server_sized_get(struct req_capsule *pill,
2253 const struct req_msg_field *field,
2256 req_capsule_set_size(pill, field, RCL_SERVER, len);
2257 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2259 EXPORT_SYMBOL(req_capsule_server_sized_get);
2261 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2262 const struct req_msg_field *field,
2263 __u32 len, void *swabber)
2265 req_capsule_set_size(pill, field, RCL_SERVER, len);
2266 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2268 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2271 * Returns the buffer of a \a pill corresponding to the given \a field from the
2272 * request (if the caller is executing on the server-side) or reply (if the
2273 * caller is executing on the client-side).
2275 * This function convienient for use is code that could be executed on the
2276 * client and server alike.
2278 const void *req_capsule_other_get(struct req_capsule *pill,
2279 const struct req_msg_field *field)
2281 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2283 EXPORT_SYMBOL(req_capsule_other_get);
2286 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2287 * field of the given \a pill.
2289 * This function must be used when constructing variable sized fields of a
2292 void req_capsule_set_size(struct req_capsule *pill,
2293 const struct req_msg_field *field,
2294 enum req_location loc, __u32 size)
2296 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2298 if ((size != (__u32)field->rmf_size) &&
2299 (field->rmf_size != -1) &&
2300 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2302 __u32 rmf_size = (__u32)field->rmf_size;
2303 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2304 (size % rmf_size != 0)) {
2305 CERROR("%s: array field size mismatch "
2306 "%u %% %u != 0 (%d)\n",
2307 field->rmf_name, size, rmf_size, loc);
2309 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2311 CERROR("%s: field size mismatch %u != %u (%d)\n",
2312 field->rmf_name, size, rmf_size, loc);
2317 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2319 EXPORT_SYMBOL(req_capsule_set_size);
2322 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2323 * for the given \a pill's given \a field.
2325 * NB: this function doesn't correspond with req_capsule_set_size(), which
2326 * actually sets the size in pill.rc_area[loc][offset], but this function
2327 * returns the message buflen[offset], maybe we should use another name.
2329 __u32 req_capsule_get_size(const struct req_capsule *pill,
2330 const struct req_msg_field *field,
2331 enum req_location loc)
2333 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2335 return lustre_msg_buflen(__req_msg(pill, loc),
2336 __req_capsule_offset(pill, field, loc));
2338 EXPORT_SYMBOL(req_capsule_get_size);
2341 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2342 * given \a pill's request or reply (\a loc) given the field size recorded in
2343 * the \a pill's rc_area.
2345 * See also req_capsule_set_size().
2347 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2349 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2350 pill->rc_fmt->rf_fields[loc].nr,
2351 pill->rc_area[loc]);
2355 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2356 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2357 * PTLRPC request or reply given only an RQF (\a fmt).
2359 * This function should not be used for formats which contain variable size
2362 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2363 enum req_location loc)
2369 * This function should probably LASSERT() that fmt has no fields with
2370 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2371 * elements in the array there will ultimately be, but then, we could
2372 * assume that there will be at least one element, and that's just what
2375 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2379 for (; i < fmt->rf_fields[loc].nr; ++i)
2380 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2381 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2385 EXPORT_SYMBOL(req_capsule_fmt_size);
2388 * Changes the format of an RPC.
2390 * The pill must already have been initialized, which means that it already has
2391 * a request format. The new format \a fmt must be an extension of the pill's
2392 * old format. Specifically: the new format must have as many request and reply
2393 * fields as the old one, and all fields shared by the old and new format must
2394 * be at least as large in the new format.
2396 * The new format's fields may be of different "type" than the old format, but
2397 * only for fields that are "opaque" blobs: fields which have a) have no
2398 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2399 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2400 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2401 * according to the key field. When the value, according to the key, contains a
2402 * structure (or array thereof) to be swabbed, the format should be changed to
2403 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2406 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2411 const struct req_format *old;
2413 LASSERT(pill->rc_fmt != NULL);
2414 LASSERT(__req_format_is_sane(fmt));
2418 * Sanity checking...
2420 for (i = 0; i < RCL_NR; ++i) {
2421 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2422 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2423 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2425 /* "opaque" fields can be transmogrified */
2426 if (ofield->rmf_swabber == NULL &&
2427 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2428 (ofield->rmf_size == -1 ||
2429 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2431 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2434 * Last field in old format can be shorter than in new.
2436 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2437 FMT_FIELD(old, i, j)->rmf_size);
2442 EXPORT_SYMBOL(req_capsule_extend);
2445 * This function returns a non-zero value if the given \a field is present in
2446 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2449 int req_capsule_has_field(const struct req_capsule *pill,
2450 const struct req_msg_field *field,
2451 enum req_location loc)
2453 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2455 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2457 EXPORT_SYMBOL(req_capsule_has_field);
2460 * Returns a non-zero value if the given \a field is present in the given \a
2461 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2463 int req_capsule_field_present(const struct req_capsule *pill,
2464 const struct req_msg_field *field,
2465 enum req_location loc)
2469 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2470 LASSERT(req_capsule_has_field(pill, field, loc));
2472 offset = __req_capsule_offset(pill, field, loc);
2473 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2475 EXPORT_SYMBOL(req_capsule_field_present);
2478 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2479 * request or reply (\a loc).
2481 * This is not the opposite of req_capsule_extend().
2483 void req_capsule_shrink(struct req_capsule *pill,
2484 const struct req_msg_field *field,
2486 enum req_location loc)
2488 const struct req_format *fmt;
2489 struct lustre_msg *msg;
2494 LASSERT(fmt != NULL);
2495 LASSERT(__req_format_is_sane(fmt));
2496 LASSERT(req_capsule_has_field(pill, field, loc));
2497 LASSERT(req_capsule_field_present(pill, field, loc));
2499 offset = __req_capsule_offset(pill, field, loc);
2501 msg = __req_msg(pill, loc);
2502 len = lustre_msg_buflen(msg, offset);
2503 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2504 fmt->rf_name, field->rmf_name, len, newlen);
2506 if (loc == RCL_CLIENT) {
2507 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2510 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2512 /* update also field size in reply lenghts arrays for possible
2513 * reply re-pack due to req_capsule_server_grow() call.
2515 req_capsule_set_size(pill, field, loc, newlen);
2518 EXPORT_SYMBOL(req_capsule_shrink);
2520 int req_capsule_server_grow(struct req_capsule *pill,
2521 const struct req_msg_field *field,
2524 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2529 LASSERT(pill->rc_fmt != NULL);
2530 LASSERT(__req_format_is_sane(pill->rc_fmt));
2531 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2532 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2534 len = req_capsule_get_size(pill, field, RCL_SERVER);
2535 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2537 CDEBUG(D_INFO, "Reply packed: %d, allocated: %d, field len %d -> %d\n",
2538 lustre_packed_msg_size(rs->rs_msg), rs->rs_repbuf_len,
2541 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2543 * There can be enough space in current reply buffer, make sure
2544 * that rs_repbuf is not a wrapper but real reply msg, otherwise
2545 * re-packing is still needed.
2547 if (rs->rs_msg == rs->rs_repbuf &&
2548 rs->rs_repbuf_len >=
2549 lustre_packed_msg_size(rs->rs_msg) - len + newlen) {
2550 pill->rc_req->rq_replen = lustre_grow_msg(rs->rs_msg, offset,
2555 /* Re-allocate replay state */
2556 pill->rc_req->rq_reply_state = NULL;
2557 rc = req_capsule_server_pack(pill);
2559 /* put old values back, the caller should decide what to do */
2560 req_capsule_set_size(pill, field, RCL_SERVER, len);
2561 pill->rc_req->rq_reply_state = rs;
2564 nrs = pill->rc_req->rq_reply_state;
2565 LASSERT(lustre_packed_msg_size(nrs->rs_msg) >
2566 lustre_packed_msg_size(rs->rs_msg));
2568 /* Now we need only buffers, copy them and grow the needed one */
2569 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2570 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2571 len = (char *)rs->rs_msg + lustre_packed_msg_size(rs->rs_msg) - from;
2572 memcpy(to, from, len);
2573 pill->rc_req->rq_replen = lustre_grow_msg(nrs->rs_msg, offset, newlen);
2575 if (rs->rs_difficult) {
2579 nrs->rs_difficult = 1;
2580 nrs->rs_no_ack = rs->rs_no_ack;
2581 nrs->rs_convert_lock = rs->rs_convert_lock;
2582 for (i = 0; i < rs->rs_nlocks; i++) {
2583 nrs->rs_locks[i] = rs->rs_locks[i];
2584 nrs->rs_modes[i] = rs->rs_modes[i];
2588 rs->rs_difficult = 0;
2591 ptlrpc_rs_decref(rs);
2594 EXPORT_SYMBOL(req_capsule_server_grow);
2596 int req_check_sepol(struct req_capsule *pill)
2599 #ifdef HAVE_SERVER_SUPPORT
2600 struct obd_export *export;
2601 struct lu_nodemap *nm = NULL;
2602 const char *sepol = NULL;
2603 const char *nm_sepol = NULL;
2608 export = pill->rc_req->rq_export;
2609 if (!export || !exp_connect_sepol(export) ||
2610 !req_capsule_has_field(pill, &RMF_SELINUX_POL, RCL_CLIENT))
2613 if (req_capsule_get_size(pill, &RMF_SELINUX_POL, RCL_CLIENT) == 0)
2616 sepol = req_capsule_client_get(pill, &RMF_SELINUX_POL);
2617 CDEBUG(D_SEC, "retrieved sepol %s\n", sepol);
2621 nm = nodemap_get_from_exp(export);
2622 if (!IS_ERR_OR_NULL(nm)) {
2623 nm_sepol = nodemap_get_sepol(nm);
2624 if (nm_sepol && nm_sepol[0])
2625 if (sepol == NULL ||
2626 strcmp(sepol, nm_sepol) != 0)
2631 if (!IS_ERR_OR_NULL(nm))
2637 EXPORT_SYMBOL(req_check_sepol);