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>
60 * RQFs (see below) refer to two struct req_msg_field arrays describing the
61 * client request and server reply, respectively.
63 /* empty set of fields... for suitable definition of emptiness. */
64 static const struct req_msg_field *empty[] = {
68 static const struct req_msg_field *mgs_target_info_only[] = {
73 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
74 static const struct req_msg_field *mgs_set_info[] = {
80 static const struct req_msg_field *mgs_config_read_client[] = {
85 static const struct req_msg_field *mgs_config_read_server[] = {
90 static const struct req_msg_field *mdt_body_only[] = {
95 static const struct req_msg_field *mdt_body_capa[] = {
101 static const struct req_msg_field *quotactl_only[] = {
106 static const struct req_msg_field *quota_body_only[] = {
111 static const struct req_msg_field *ldlm_intent_quota_client[] = {
118 static const struct req_msg_field *ldlm_intent_quota_server[] = {
125 static const struct req_msg_field *mdt_close_client[] = {
132 static const struct req_msg_field *mdt_close_intent_client[] = {
141 static const struct req_msg_field *obd_statfs_server[] = {
146 static const struct req_msg_field *seq_query_client[] = {
152 static const struct req_msg_field *seq_query_server[] = {
157 static const struct req_msg_field *fld_query_client[] = {
163 static const struct req_msg_field *fld_query_server[] = {
168 static const struct req_msg_field *fld_read_client[] = {
173 static const struct req_msg_field *fld_read_server[] = {
178 static const struct req_msg_field *mds_getattr_name_client[] = {
185 static const struct req_msg_field *mds_reint_client[] = {
190 static const struct req_msg_field *mds_reint_create_client[] = {
197 static const struct req_msg_field *mds_reint_create_slave_client[] = {
206 static const struct req_msg_field *mds_reint_create_acl_client[] = {
213 &RMF_FILE_SECCTX_NAME,
217 static const struct req_msg_field *mds_reint_create_sym_client[] = {
224 &RMF_FILE_SECCTX_NAME,
228 static const struct req_msg_field *mds_reint_open_client[] = {
235 &RMF_FILE_SECCTX_NAME,
239 static const struct req_msg_field *mds_reint_open_server[] = {
248 static const struct req_msg_field *mds_reint_unlink_client[] = {
256 static const struct req_msg_field *mds_reint_link_client[] = {
265 static const struct req_msg_field *mds_reint_rename_client[] = {
275 static const struct req_msg_field *mds_reint_migrate_client[] = {
287 static const struct req_msg_field *mds_last_unlink_server[] = {
296 static const struct req_msg_field *mds_reint_setattr_client[] = {
306 static const struct req_msg_field *mds_reint_setxattr_client[] = {
315 static const struct req_msg_field *mds_reint_resync[] = {
321 static const struct req_msg_field *mdt_swap_layouts[] = {
330 static const struct req_msg_field *obd_connect_client[] = {
338 static const struct req_msg_field *obd_connect_server[] = {
343 static const struct req_msg_field *obd_set_info_client[] = {
349 static const struct req_msg_field *ost_grant_shrink_client[] = {
355 static const struct req_msg_field *mds_getinfo_client[] = {
361 static const struct req_msg_field *mds_getinfo_server[] = {
366 static const struct req_msg_field *ldlm_enqueue_client[] = {
371 static const struct req_msg_field *ldlm_enqueue_server[] = {
376 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
382 static const struct req_msg_field *ldlm_cp_callback_client[] = {
388 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
394 static const struct req_msg_field *ldlm_gl_callback_server[] = {
399 static const struct req_msg_field *ldlm_intent_basic_client[] = {
405 static const struct req_msg_field *ldlm_intent_client[] = {
412 static const struct req_msg_field *ldlm_intent_server[] = {
420 static const struct req_msg_field *ldlm_intent_layout_client[] = {
425 &RMF_EADATA /* for new layout to be set up */
428 static const struct req_msg_field *ldlm_intent_open_server[] = {
439 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
443 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
448 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
457 static const struct req_msg_field *ldlm_intent_create_client[] = {
461 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
465 &RMF_FILE_SECCTX_NAME,
469 static const struct req_msg_field *ldlm_intent_open_client[] = {
473 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
478 &RMF_FILE_SECCTX_NAME,
482 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
486 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
491 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
499 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
504 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
510 static const struct req_msg_field *mds_get_root_client[] = {
516 static const struct req_msg_field *mds_getxattr_client[] = {
524 static const struct req_msg_field *mds_getxattr_server[] = {
530 static const struct req_msg_field *mds_getattr_server[] = {
539 static const struct req_msg_field *mds_setattr_server[] = {
548 static const struct req_msg_field *mds_update_client[] = {
550 &RMF_OUT_UPDATE_HEADER,
554 static const struct req_msg_field *mds_update_server[] = {
556 &RMF_OUT_UPDATE_REPLY,
559 static const struct req_msg_field *llog_origin_handle_create_client[] = {
565 static const struct req_msg_field *llogd_body_only[] = {
570 static const struct req_msg_field *llog_log_hdr_only[] = {
575 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
581 static const struct req_msg_field *obd_idx_read_client[] = {
586 static const struct req_msg_field *obd_idx_read_server[] = {
591 static const struct req_msg_field *ost_body_only[] = {
596 static const struct req_msg_field *ost_body_capa[] = {
602 static const struct req_msg_field *ost_destroy_client[] = {
610 static const struct req_msg_field *ost_brw_client[] = {
619 static const struct req_msg_field *ost_brw_read_server[] = {
625 static const struct req_msg_field *ost_brw_write_server[] = {
631 static const struct req_msg_field *ost_get_info_generic_server[] = {
636 static const struct req_msg_field *ost_get_info_generic_client[] = {
641 static const struct req_msg_field *ost_get_last_id_server[] = {
646 static const struct req_msg_field *ost_get_last_fid_client[] = {
652 static const struct req_msg_field *ost_get_last_fid_server[] = {
657 static const struct req_msg_field *ost_get_fiemap_client[] = {
663 static const struct req_msg_field *ost_ladvise[] = {
666 &RMF_OST_LADVISE_HDR,
670 static const struct req_msg_field *ost_get_fiemap_server[] = {
675 static const struct req_msg_field *mdt_hsm_progress[] = {
678 &RMF_MDS_HSM_PROGRESS,
681 static const struct req_msg_field *mdt_hsm_ct_register[] = {
684 &RMF_MDS_HSM_ARCHIVE,
687 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
692 static const struct req_msg_field *mdt_hsm_action_server[] = {
695 &RMF_MDS_HSM_CURRENT_ACTION,
698 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
704 static const struct req_msg_field *mdt_hsm_state_set[] = {
711 static const struct req_msg_field *mdt_hsm_request[] = {
714 &RMF_MDS_HSM_REQUEST,
715 &RMF_MDS_HSM_USER_ITEM,
719 static const struct req_msg_field *obd_lfsck_request[] = {
724 static const struct req_msg_field *obd_lfsck_reply[] = {
729 static struct req_format *req_formats[] = {
735 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
738 &RQF_MGS_CONFIG_READ,
748 &RQF_MDS_GETATTR_NAME,
752 &RQF_MDS_CLOSE_INTENT,
755 &RQF_MDS_REINT_CREATE,
756 &RQF_MDS_REINT_CREATE_ACL,
757 &RQF_MDS_REINT_CREATE_SLAVE,
758 &RQF_MDS_REINT_CREATE_SYM,
760 &RQF_MDS_REINT_UNLINK,
762 &RQF_MDS_REINT_RENAME,
763 &RQF_MDS_REINT_MIGRATE,
764 &RQF_MDS_REINT_SETATTR,
765 &RQF_MDS_REINT_SETXATTR,
766 &RQF_MDS_REINT_RESYNC,
768 &RQF_MDS_HSM_PROGRESS,
769 &RQF_MDS_HSM_CT_REGISTER,
770 &RQF_MDS_HSM_CT_UNREGISTER,
771 &RQF_MDS_HSM_STATE_GET,
772 &RQF_MDS_HSM_STATE_SET,
774 &RQF_MDS_HSM_REQUEST,
775 &RQF_MDS_SWAP_LAYOUTS,
789 &RQF_OST_SET_GRANT_INFO,
791 &RQF_OST_GET_INFO_LAST_ID,
792 &RQF_OST_GET_INFO_LAST_FID,
793 &RQF_OST_SET_INFO_LAST_FID,
794 &RQF_OST_GET_INFO_FIEMAP,
797 &RQF_LDLM_ENQUEUE_LVB,
801 &RQF_LDLM_CP_CALLBACK,
802 &RQF_LDLM_BL_CALLBACK,
803 &RQF_LDLM_GL_CALLBACK,
804 &RQF_LDLM_GL_CALLBACK_DESC,
806 &RQF_LDLM_INTENT_BASIC,
807 &RQF_LDLM_INTENT_LAYOUT,
808 &RQF_LDLM_INTENT_GETATTR,
809 &RQF_LDLM_INTENT_OPEN,
810 &RQF_LDLM_INTENT_CREATE,
811 &RQF_LDLM_INTENT_UNLINK,
812 &RQF_LDLM_INTENT_GETXATTR,
813 &RQF_LDLM_INTENT_QUOTA,
815 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
816 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
817 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
818 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
824 struct req_msg_field {
825 const __u32 rmf_flags;
826 const char *rmf_name;
828 * Field length. (-1) means "variable length". If the
829 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
830 * but the actual size must be a whole multiple of \a rmf_size.
833 void (*rmf_swabber)(void *);
834 void (*rmf_dumper)(void *);
835 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
840 * The field is a string, must be NUL-terminated.
842 RMF_F_STRING = 1 << 0,
844 * The field's buffer size need not match the declared \a rmf_size.
846 RMF_F_NO_SIZE_CHECK = 1 << 1,
848 * The field's buffer size must be a whole multiple of the declared \a
849 * rmf_size and the \a rmf_swabber function must work on the declared \a
850 * rmf_size worth of bytes.
852 RMF_F_STRUCT_ARRAY = 1 << 2
860 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
861 .rmf_name = (name), \
862 .rmf_flags = (flags), \
863 .rmf_size = (size), \
864 .rmf_swabber = (void (*)(void*))(swabber), \
865 .rmf_dumper = (void (*)(void*))(dumper) \
868 struct req_msg_field RMF_GENERIC_DATA =
869 DEFINE_MSGF("generic_data", 0,
871 EXPORT_SYMBOL(RMF_GENERIC_DATA);
873 struct req_msg_field RMF_MGS_TARGET_INFO =
874 DEFINE_MSGF("mgs_target_info", 0,
875 sizeof(struct mgs_target_info),
876 lustre_swab_mgs_target_info, NULL);
877 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
879 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
880 struct req_msg_field RMF_MGS_SEND_PARAM =
881 DEFINE_MSGF("mgs_send_param", 0,
882 sizeof(struct mgs_send_param),
884 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
887 struct req_msg_field RMF_MGS_CONFIG_BODY =
888 DEFINE_MSGF("mgs_config_read request", 0,
889 sizeof(struct mgs_config_body),
890 lustre_swab_mgs_config_body, NULL);
891 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
893 struct req_msg_field RMF_MGS_CONFIG_RES =
894 DEFINE_MSGF("mgs_config_read reply ", 0,
895 sizeof(struct mgs_config_res),
896 lustre_swab_mgs_config_res, NULL);
897 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
899 struct req_msg_field RMF_U32 =
900 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
901 sizeof(__u32), lustre_swab_generic_32s, NULL);
902 EXPORT_SYMBOL(RMF_U32);
904 struct req_msg_field RMF_SETINFO_VAL =
905 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
906 EXPORT_SYMBOL(RMF_SETINFO_VAL);
908 struct req_msg_field RMF_GETINFO_KEY =
909 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
910 EXPORT_SYMBOL(RMF_GETINFO_KEY);
912 struct req_msg_field RMF_GETINFO_VALLEN =
913 DEFINE_MSGF("getinfo_vallen", 0,
914 sizeof(__u32), lustre_swab_generic_32s, NULL);
915 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
917 struct req_msg_field RMF_GETINFO_VAL =
918 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
919 EXPORT_SYMBOL(RMF_GETINFO_VAL);
921 struct req_msg_field RMF_SEQ_OPC =
922 DEFINE_MSGF("seq_query_opc", 0,
923 sizeof(__u32), lustre_swab_generic_32s, NULL);
924 EXPORT_SYMBOL(RMF_SEQ_OPC);
926 struct req_msg_field RMF_SEQ_RANGE =
927 DEFINE_MSGF("seq_query_range", 0,
928 sizeof(struct lu_seq_range),
929 lustre_swab_lu_seq_range, NULL);
930 EXPORT_SYMBOL(RMF_SEQ_RANGE);
932 struct req_msg_field RMF_FLD_OPC =
933 DEFINE_MSGF("fld_query_opc", 0,
934 sizeof(__u32), lustre_swab_generic_32s, NULL);
935 EXPORT_SYMBOL(RMF_FLD_OPC);
937 struct req_msg_field RMF_FLD_MDFLD =
938 DEFINE_MSGF("fld_query_mdfld", 0,
939 sizeof(struct lu_seq_range),
940 lustre_swab_lu_seq_range, NULL);
941 EXPORT_SYMBOL(RMF_FLD_MDFLD);
943 struct req_msg_field RMF_MDT_BODY =
944 DEFINE_MSGF("mdt_body", 0,
945 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
946 EXPORT_SYMBOL(RMF_MDT_BODY);
948 struct req_msg_field RMF_OBD_QUOTACTL =
949 DEFINE_MSGF("obd_quotactl", 0,
950 sizeof(struct obd_quotactl),
951 lustre_swab_obd_quotactl, NULL);
952 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
954 struct req_msg_field RMF_QUOTA_BODY =
955 DEFINE_MSGF("quota_body", 0,
956 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
957 EXPORT_SYMBOL(RMF_QUOTA_BODY);
959 struct req_msg_field RMF_MDT_EPOCH =
960 DEFINE_MSGF("mdt_ioepoch", 0,
961 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
962 EXPORT_SYMBOL(RMF_MDT_EPOCH);
964 struct req_msg_field RMF_PTLRPC_BODY =
965 DEFINE_MSGF("ptlrpc_body", 0,
966 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
967 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
969 struct req_msg_field RMF_CLOSE_DATA =
970 DEFINE_MSGF("data_version", 0,
971 sizeof(struct close_data), lustre_swab_close_data, NULL);
972 EXPORT_SYMBOL(RMF_CLOSE_DATA);
974 struct req_msg_field RMF_OBD_STATFS =
975 DEFINE_MSGF("obd_statfs", 0,
976 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
977 EXPORT_SYMBOL(RMF_OBD_STATFS);
979 struct req_msg_field RMF_SETINFO_KEY =
980 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
981 EXPORT_SYMBOL(RMF_SETINFO_KEY);
983 struct req_msg_field RMF_NAME =
984 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
985 EXPORT_SYMBOL(RMF_NAME);
987 struct req_msg_field RMF_SYMTGT =
988 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
989 EXPORT_SYMBOL(RMF_SYMTGT);
991 struct req_msg_field RMF_TGTUUID =
992 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
994 EXPORT_SYMBOL(RMF_TGTUUID);
996 struct req_msg_field RMF_CLUUID =
997 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
999 EXPORT_SYMBOL(RMF_CLUUID);
1001 struct req_msg_field RMF_STRING =
1002 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1003 EXPORT_SYMBOL(RMF_STRING);
1005 struct req_msg_field RMF_FILE_SECCTX_NAME =
1006 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1007 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1009 struct req_msg_field RMF_FILE_SECCTX =
1010 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1011 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1013 struct req_msg_field RMF_LLOGD_BODY =
1014 DEFINE_MSGF("llogd_body", 0,
1015 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1016 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1018 struct req_msg_field RMF_LLOG_LOG_HDR =
1019 DEFINE_MSGF("llog_log_hdr", 0,
1020 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1021 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1023 struct req_msg_field RMF_LLOGD_CONN_BODY =
1024 DEFINE_MSGF("llogd_conn_body", 0,
1025 sizeof(struct llogd_conn_body),
1026 lustre_swab_llogd_conn_body, NULL);
1027 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1030 * connection handle received in MDS_CONNECT request.
1032 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1033 * that the client does not interpret at all.
1035 struct req_msg_field RMF_CONN =
1036 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1037 EXPORT_SYMBOL(RMF_CONN);
1039 struct req_msg_field RMF_CONNECT_DATA =
1040 DEFINE_MSGF("cdata",
1041 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1042 sizeof(struct obd_connect_data),
1043 lustre_swab_connect, NULL);
1044 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1046 struct req_msg_field RMF_DLM_REQ =
1047 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1048 sizeof(struct ldlm_request),
1049 lustre_swab_ldlm_request, NULL);
1050 EXPORT_SYMBOL(RMF_DLM_REQ);
1052 struct req_msg_field RMF_DLM_REP =
1053 DEFINE_MSGF("dlm_rep", 0,
1054 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1055 EXPORT_SYMBOL(RMF_DLM_REP);
1057 struct req_msg_field RMF_LDLM_INTENT =
1058 DEFINE_MSGF("ldlm_intent", 0,
1059 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1060 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1062 struct req_msg_field RMF_DLM_LVB =
1063 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_DLM_LVB);
1066 struct req_msg_field RMF_DLM_GL_DESC =
1067 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1068 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1070 struct req_msg_field RMF_MDT_MD =
1071 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1072 EXPORT_SYMBOL(RMF_MDT_MD);
1074 struct req_msg_field RMF_REC_REINT =
1075 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1076 lustre_swab_mdt_rec_reint, NULL);
1077 EXPORT_SYMBOL(RMF_REC_REINT);
1079 /* FIXME: this length should be defined as a macro */
1080 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1082 EXPORT_SYMBOL(RMF_EADATA);
1084 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1085 EXPORT_SYMBOL(RMF_EAVALS);
1087 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1088 EXPORT_SYMBOL(RMF_ACL);
1090 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1091 struct req_msg_field RMF_LOGCOOKIES =
1092 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1093 sizeof(struct llog_cookie), NULL, NULL);
1094 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1096 struct req_msg_field RMF_CAPA1 =
1097 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1098 lustre_swab_lustre_capa, NULL);
1099 EXPORT_SYMBOL(RMF_CAPA1);
1101 struct req_msg_field RMF_CAPA2 =
1102 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1103 lustre_swab_lustre_capa, NULL);
1104 EXPORT_SYMBOL(RMF_CAPA2);
1106 struct req_msg_field RMF_LAYOUT_INTENT =
1107 DEFINE_MSGF("layout_intent", 0,
1108 sizeof(struct layout_intent), lustre_swab_layout_intent,
1110 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1113 * OST request field.
1115 struct req_msg_field RMF_OST_BODY =
1116 DEFINE_MSGF("ost_body", 0,
1117 sizeof(struct ost_body), lustre_swab_ost_body,
1119 EXPORT_SYMBOL(RMF_OST_BODY);
1121 struct req_msg_field RMF_OBD_IOOBJ =
1122 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1123 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1124 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1126 struct req_msg_field RMF_NIOBUF_REMOTE =
1127 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1128 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1130 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1132 struct req_msg_field RMF_NIOBUF_INLINE =
1133 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1134 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1136 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1138 struct req_msg_field RMF_RCS =
1139 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1140 lustre_swab_generic_32s, dump_rcs);
1141 EXPORT_SYMBOL(RMF_RCS);
1143 struct req_msg_field RMF_EAVALS_LENS =
1144 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1145 lustre_swab_generic_32s, NULL);
1146 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1148 struct req_msg_field RMF_OBD_ID =
1149 DEFINE_MSGF("obd_id", 0,
1150 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1151 EXPORT_SYMBOL(RMF_OBD_ID);
1153 struct req_msg_field RMF_FID =
1154 DEFINE_MSGF("fid", 0,
1155 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1156 EXPORT_SYMBOL(RMF_FID);
1158 struct req_msg_field RMF_OST_ID =
1159 DEFINE_MSGF("ost_id", 0,
1160 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1161 EXPORT_SYMBOL(RMF_OST_ID);
1163 struct req_msg_field RMF_FIEMAP_KEY =
1164 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1165 lustre_swab_fiemap, NULL);
1166 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1168 struct req_msg_field RMF_FIEMAP_VAL =
1169 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1170 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1172 struct req_msg_field RMF_IDX_INFO =
1173 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1174 lustre_swab_idx_info, NULL);
1175 EXPORT_SYMBOL(RMF_IDX_INFO);
1176 struct req_msg_field RMF_SHORT_IO =
1177 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1178 EXPORT_SYMBOL(RMF_SHORT_IO);
1179 struct req_msg_field RMF_HSM_USER_STATE =
1180 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1181 lustre_swab_hsm_user_state, NULL);
1182 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1184 struct req_msg_field RMF_HSM_STATE_SET =
1185 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1186 lustre_swab_hsm_state_set, NULL);
1187 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1189 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1190 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1191 lustre_swab_hsm_progress_kernel, NULL);
1192 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1194 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1195 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1196 lustre_swab_hsm_current_action, NULL);
1197 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1199 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1200 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1201 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1203 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1205 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1206 DEFINE_MSGF("hsm_archive", 0,
1207 sizeof(__u32), lustre_swab_generic_32s, NULL);
1208 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1210 struct req_msg_field RMF_MDS_HSM_REQUEST =
1211 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1212 lustre_swab_hsm_request, NULL);
1213 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1215 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1216 lustre_swab_object_update_request, NULL);
1217 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1219 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1220 DEFINE_MSGF("object_update_reply", 0, -1,
1221 lustre_swab_object_update_reply, NULL);
1222 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1224 struct req_msg_field RMF_SWAP_LAYOUTS =
1225 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1226 lustre_swab_swap_layouts, NULL);
1227 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1229 struct req_msg_field RMF_LFSCK_REQUEST =
1230 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1231 lustre_swab_lfsck_request, NULL);
1232 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1234 struct req_msg_field RMF_LFSCK_REPLY =
1235 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1236 lustre_swab_lfsck_reply, NULL);
1237 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1239 struct req_msg_field RMF_OST_LADVISE_HDR =
1240 DEFINE_MSGF("ladvise_request", 0,
1241 sizeof(struct ladvise_hdr),
1242 lustre_swab_ladvise_hdr, NULL);
1243 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1245 struct req_msg_field RMF_OST_LADVISE =
1246 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1247 sizeof(struct lu_ladvise),
1248 lustre_swab_ladvise, NULL);
1249 EXPORT_SYMBOL(RMF_OST_LADVISE);
1251 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1252 -1, lustre_swab_out_update_header, NULL);
1253 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1255 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1256 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1257 lustre_swab_out_update_buffer, NULL);
1258 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1265 const char *rf_name;
1269 const struct req_msg_field **d;
1270 } rf_fields[RCL_NR];
1273 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1287 #define DEFINE_REQ_FMT0(name, client, server) \
1288 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1290 struct req_format RQF_OBD_PING =
1291 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1292 EXPORT_SYMBOL(RQF_OBD_PING);
1294 struct req_format RQF_OBD_SET_INFO =
1295 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1296 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1298 /* Read index file through the network */
1299 struct req_format RQF_OBD_IDX_READ =
1300 DEFINE_REQ_FMT0("OBD_IDX_READ",
1301 obd_idx_read_client, obd_idx_read_server);
1302 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1304 struct req_format RQF_SEC_CTX =
1305 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1306 EXPORT_SYMBOL(RQF_SEC_CTX);
1308 struct req_format RQF_MGS_TARGET_REG =
1309 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1310 mgs_target_info_only);
1311 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1313 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1314 struct req_format RQF_MGS_SET_INFO =
1315 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1317 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1320 struct req_format RQF_MGS_CONFIG_READ =
1321 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1322 mgs_config_read_server);
1323 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1325 struct req_format RQF_SEQ_QUERY =
1326 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1327 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1329 struct req_format RQF_FLD_QUERY =
1330 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1331 EXPORT_SYMBOL(RQF_FLD_QUERY);
1333 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1334 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1335 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1336 * peers need to handle the RPC reply with fixed little-endian format.
1338 * In theory, we can define new structure with some swabber registered to
1339 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1340 * implementation view, it is not easy to be done within current "struct
1341 * req_msg_field" framework. Because the sequence range array in the RPC
1342 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1343 * count, that is unknown when prepare the RPC buffer. Generally, for such
1344 * flexible length RPC usage, there will be a field in the RPC layout to
1345 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1346 * do that unless we add new length filed that will broken the on-wire RPC
1347 * protocol and cause interoperability trouble with old peer. */
1348 struct req_format RQF_FLD_READ =
1349 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1350 EXPORT_SYMBOL(RQF_FLD_READ);
1352 struct req_format RQF_MDS_QUOTACTL =
1353 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1354 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1356 struct req_format RQF_OST_QUOTACTL =
1357 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1358 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1360 struct req_format RQF_QUOTA_DQACQ =
1361 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1362 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1364 struct req_format RQF_LDLM_INTENT_QUOTA =
1365 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1366 ldlm_intent_quota_client,
1367 ldlm_intent_quota_server);
1368 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1370 struct req_format RQF_MDS_GET_ROOT =
1371 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1372 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1374 struct req_format RQF_MDS_STATFS =
1375 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1376 EXPORT_SYMBOL(RQF_MDS_STATFS);
1378 struct req_format RQF_MDS_SYNC =
1379 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1380 EXPORT_SYMBOL(RQF_MDS_SYNC);
1382 struct req_format RQF_MDS_GETATTR =
1383 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1384 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1386 struct req_format RQF_MDS_GETXATTR =
1387 DEFINE_REQ_FMT0("MDS_GETXATTR",
1388 mds_getxattr_client, mds_getxattr_server);
1389 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1391 struct req_format RQF_MDS_GETATTR_NAME =
1392 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1393 mds_getattr_name_client, mds_getattr_server);
1394 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1396 struct req_format RQF_MDS_REINT =
1397 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1398 EXPORT_SYMBOL(RQF_MDS_REINT);
1400 struct req_format RQF_MDS_REINT_CREATE =
1401 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1402 mds_reint_create_client, mdt_body_capa);
1403 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1405 struct req_format RQF_MDS_REINT_CREATE_ACL =
1406 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1407 mds_reint_create_acl_client, mdt_body_capa);
1408 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1410 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1411 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1412 mds_reint_create_slave_client, mdt_body_capa);
1413 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1415 struct req_format RQF_MDS_REINT_CREATE_SYM =
1416 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1417 mds_reint_create_sym_client, mdt_body_capa);
1418 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1420 struct req_format RQF_MDS_REINT_OPEN =
1421 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1422 mds_reint_open_client, mds_reint_open_server);
1423 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1425 struct req_format RQF_MDS_REINT_UNLINK =
1426 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1427 mds_last_unlink_server);
1428 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1430 struct req_format RQF_MDS_REINT_LINK =
1431 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1432 mds_reint_link_client, mdt_body_only);
1433 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1435 struct req_format RQF_MDS_REINT_RENAME =
1436 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1437 mds_last_unlink_server);
1438 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1440 struct req_format RQF_MDS_REINT_MIGRATE =
1441 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1442 mds_last_unlink_server);
1443 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1445 struct req_format RQF_MDS_REINT_SETATTR =
1446 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1447 mds_reint_setattr_client, mds_setattr_server);
1448 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1450 struct req_format RQF_MDS_REINT_SETXATTR =
1451 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1452 mds_reint_setxattr_client, mdt_body_only);
1453 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1455 struct req_format RQF_MDS_REINT_RESYNC =
1456 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1457 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1459 struct req_format RQF_MDS_CONNECT =
1460 DEFINE_REQ_FMT0("MDS_CONNECT",
1461 obd_connect_client, obd_connect_server);
1462 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1464 struct req_format RQF_MDS_DISCONNECT =
1465 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1466 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1468 struct req_format RQF_MDS_GET_INFO =
1469 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1470 mds_getinfo_server);
1471 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1473 struct req_format RQF_OUT_UPDATE =
1474 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1476 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1478 struct req_format RQF_LDLM_ENQUEUE =
1479 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1480 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1481 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1483 struct req_format RQF_LDLM_ENQUEUE_LVB =
1484 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1485 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1486 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1488 struct req_format RQF_LDLM_CONVERT =
1489 DEFINE_REQ_FMT0("LDLM_CONVERT",
1490 ldlm_enqueue_client, ldlm_enqueue_server);
1491 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1493 struct req_format RQF_LDLM_CANCEL =
1494 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1495 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1497 struct req_format RQF_LDLM_CALLBACK =
1498 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1499 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1501 struct req_format RQF_LDLM_CP_CALLBACK =
1502 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1503 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1505 struct req_format RQF_LDLM_BL_CALLBACK =
1506 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1507 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1509 struct req_format RQF_LDLM_GL_CALLBACK =
1510 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1511 ldlm_gl_callback_server);
1512 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1514 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1515 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1516 ldlm_gl_callback_server);
1517 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1519 struct req_format RQF_LDLM_INTENT_BASIC =
1520 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1521 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1522 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1524 struct req_format RQF_LDLM_INTENT =
1525 DEFINE_REQ_FMT0("LDLM_INTENT",
1526 ldlm_intent_client, ldlm_intent_server);
1527 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1529 struct req_format RQF_LDLM_INTENT_LAYOUT =
1530 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1531 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1532 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1534 struct req_format RQF_LDLM_INTENT_GETATTR =
1535 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1536 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1537 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1539 struct req_format RQF_LDLM_INTENT_OPEN =
1540 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1541 ldlm_intent_open_client, ldlm_intent_open_server);
1542 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1544 struct req_format RQF_LDLM_INTENT_CREATE =
1545 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1546 ldlm_intent_create_client, ldlm_intent_getattr_server);
1547 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1549 struct req_format RQF_LDLM_INTENT_UNLINK =
1550 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1551 ldlm_intent_unlink_client, ldlm_intent_server);
1552 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1554 struct req_format RQF_LDLM_INTENT_GETXATTR =
1555 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1556 ldlm_intent_getxattr_client,
1557 ldlm_intent_getxattr_server);
1558 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1560 struct req_format RQF_MDS_CLOSE =
1561 DEFINE_REQ_FMT0("MDS_CLOSE",
1562 mdt_close_client, mds_last_unlink_server);
1563 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1565 struct req_format RQF_MDS_CLOSE_INTENT =
1566 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1567 mdt_close_intent_client, mds_last_unlink_server);
1568 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1570 struct req_format RQF_MDS_READPAGE =
1571 DEFINE_REQ_FMT0("MDS_READPAGE",
1572 mdt_body_capa, mdt_body_only);
1573 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1575 struct req_format RQF_MDS_HSM_ACTION =
1576 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1577 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1579 struct req_format RQF_MDS_HSM_PROGRESS =
1580 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1581 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1583 struct req_format RQF_MDS_HSM_CT_REGISTER =
1584 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1585 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1587 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1588 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1589 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1591 struct req_format RQF_MDS_HSM_STATE_GET =
1592 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1593 mdt_body_capa, mdt_hsm_state_get_server);
1594 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1596 struct req_format RQF_MDS_HSM_STATE_SET =
1597 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1598 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1600 struct req_format RQF_MDS_HSM_REQUEST =
1601 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1602 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1604 struct req_format RQF_MDS_SWAP_LAYOUTS =
1605 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1606 mdt_swap_layouts, empty);
1607 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1609 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1610 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1611 llog_origin_handle_create_client, llogd_body_only);
1612 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1614 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1615 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1616 llogd_body_only, llog_origin_handle_next_block_server);
1617 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1619 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1620 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1621 llogd_body_only, llog_origin_handle_next_block_server);
1622 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1624 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1625 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1626 llogd_body_only, llog_log_hdr_only);
1627 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1629 struct req_format RQF_CONNECT =
1630 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1631 EXPORT_SYMBOL(RQF_CONNECT);
1633 struct req_format RQF_OST_CONNECT =
1634 DEFINE_REQ_FMT0("OST_CONNECT",
1635 obd_connect_client, obd_connect_server);
1636 EXPORT_SYMBOL(RQF_OST_CONNECT);
1638 struct req_format RQF_OST_DISCONNECT =
1639 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1640 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1642 struct req_format RQF_OST_GETATTR =
1643 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1644 EXPORT_SYMBOL(RQF_OST_GETATTR);
1646 struct req_format RQF_OST_SETATTR =
1647 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1648 EXPORT_SYMBOL(RQF_OST_SETATTR);
1650 struct req_format RQF_OST_CREATE =
1651 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1652 EXPORT_SYMBOL(RQF_OST_CREATE);
1654 struct req_format RQF_OST_PUNCH =
1655 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1656 EXPORT_SYMBOL(RQF_OST_PUNCH);
1658 struct req_format RQF_OST_SYNC =
1659 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1660 EXPORT_SYMBOL(RQF_OST_SYNC);
1662 struct req_format RQF_OST_DESTROY =
1663 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1664 EXPORT_SYMBOL(RQF_OST_DESTROY);
1666 struct req_format RQF_OST_BRW_READ =
1667 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1668 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1670 struct req_format RQF_OST_BRW_WRITE =
1671 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1672 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1674 struct req_format RQF_OST_STATFS =
1675 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1676 EXPORT_SYMBOL(RQF_OST_STATFS);
1678 struct req_format RQF_OST_SET_GRANT_INFO =
1679 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1681 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1683 struct req_format RQF_OST_GET_INFO =
1684 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1685 ost_get_info_generic_server);
1686 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1688 struct req_format RQF_OST_GET_INFO_LAST_ID =
1689 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1690 ost_get_last_id_server);
1691 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1693 struct req_format RQF_OST_GET_INFO_LAST_FID =
1694 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1695 ost_get_last_fid_server);
1696 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1698 struct req_format RQF_OST_SET_INFO_LAST_FID =
1699 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1701 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1703 struct req_format RQF_OST_GET_INFO_FIEMAP =
1704 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1705 ost_get_fiemap_server);
1706 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1708 struct req_format RQF_LFSCK_NOTIFY =
1709 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1710 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1712 struct req_format RQF_LFSCK_QUERY =
1713 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1714 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1716 struct req_format RQF_OST_LADVISE =
1717 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1718 EXPORT_SYMBOL(RQF_OST_LADVISE);
1720 /* Convenience macro */
1721 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1724 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1725 * field of RQFs and the \a rmf_offset field of RMFs.
1727 int req_layout_init(void)
1732 struct req_format *rf = NULL;
1734 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1735 rf = req_formats[i];
1737 for (j = 0; j < RCL_NR; ++j) {
1738 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1739 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1740 struct req_msg_field *field;
1742 field = (typeof(field))rf->rf_fields[j].d[k];
1743 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1744 || field->rmf_size > 0);
1745 LASSERT(field->rmf_offset[i][j] == 0);
1747 * k + 1 to detect unused format/field
1750 field->rmf_offset[i][j] = k + 1;
1756 EXPORT_SYMBOL(req_layout_init);
1758 void req_layout_fini(void)
1761 EXPORT_SYMBOL(req_layout_fini);
1764 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1766 * Actual/expected field sizes are set elsewhere in functions in this file:
1767 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1768 * req_capsule_msg_size(). The \a rc_area information is used by.
1769 * ptlrpc_request_set_replen().
1771 void req_capsule_init_area(struct req_capsule *pill)
1775 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1776 pill->rc_area[RCL_CLIENT][i] = -1;
1777 pill->rc_area[RCL_SERVER][i] = -1;
1780 EXPORT_SYMBOL(req_capsule_init_area);
1783 * Initialize a pill.
1785 * The \a location indicates whether the caller is executing on the client side
1786 * (RCL_CLIENT) or server side (RCL_SERVER)..
1788 void req_capsule_init(struct req_capsule *pill,
1789 struct ptlrpc_request *req,
1790 enum req_location location)
1792 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1795 * Today all capsules are embedded in ptlrpc_request structs,
1796 * but just in case that ever isn't the case, we don't reach
1797 * into req unless req != NULL and pill is the one embedded in
1800 * The req->rq_pill_init flag makes it safe to initialize a pill
1801 * twice, which might happen in the OST paths as a result of the
1802 * high-priority RPC queue getting peeked at before ost_handle()
1803 * handles an OST RPC.
1805 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1808 memset(pill, 0, sizeof *pill);
1810 pill->rc_loc = location;
1811 req_capsule_init_area(pill);
1813 if (req != NULL && pill == &req->rq_pill)
1814 req->rq_pill_init = 1;
1816 EXPORT_SYMBOL(req_capsule_init);
1818 void req_capsule_fini(struct req_capsule *pill)
1821 EXPORT_SYMBOL(req_capsule_fini);
1823 static int __req_format_is_sane(const struct req_format *fmt)
1825 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1826 req_formats[fmt->rf_idx] == fmt;
1829 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1830 enum req_location loc)
1832 struct ptlrpc_request *req;
1835 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1839 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1840 * (see req_capsule_extend()).
1842 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1844 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1845 LASSERT(__req_format_is_sane(fmt));
1849 EXPORT_SYMBOL(req_capsule_set);
1852 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1855 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1856 * variable-sized fields. The field sizes come from the declared \a rmf_size
1857 * field of a \a pill's \a rc_fmt's RMF's.
1859 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1860 enum req_location loc)
1862 const struct req_format *fmt = pill->rc_fmt;
1865 LASSERT(fmt != NULL);
1867 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1868 if (pill->rc_area[loc][i] == -1) {
1869 pill->rc_area[loc][i] =
1870 fmt->rf_fields[loc].d[i]->rmf_size;
1871 if (pill->rc_area[loc][i] == -1) {
1873 * Skip the following fields.
1875 * If this LASSERT() trips then you're missing a
1876 * call to req_capsule_set_size().
1878 LASSERT(loc != RCL_SERVER);
1885 EXPORT_SYMBOL(req_capsule_filled_sizes);
1888 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1890 * This function uses the \a pill's \a rc_area as filled in by
1891 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1894 int req_capsule_server_pack(struct req_capsule *pill)
1896 const struct req_format *fmt;
1900 LASSERT(pill->rc_loc == RCL_SERVER);
1902 LASSERT(fmt != NULL);
1904 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1905 rc = lustre_pack_reply(pill->rc_req, count,
1906 pill->rc_area[RCL_SERVER], NULL);
1908 DEBUG_REQ(D_ERROR, pill->rc_req,
1909 "Cannot pack %d fields in format `%s': ",
1910 count, fmt->rf_name);
1914 EXPORT_SYMBOL(req_capsule_server_pack);
1917 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1918 * corresponding to the given RMF (\a field).
1920 __u32 __req_capsule_offset(const struct req_capsule *pill,
1921 const struct req_msg_field *field,
1922 enum req_location loc)
1924 unsigned int offset;
1926 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1927 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1928 pill->rc_fmt->rf_name,
1929 field->rmf_name, offset, loc);
1932 LASSERT(offset < REQ_MAX_FIELD_NR);
1937 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1942 swabber_dumper_helper(struct req_capsule *pill,
1943 const struct req_msg_field *field,
1944 enum req_location loc,
1946 void *value, int len, int dump, void (*swabber)( void *))
1952 int inout = loc == RCL_CLIENT;
1954 swabber = swabber ?: field->rmf_swabber;
1956 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1957 swabber != NULL && value != NULL)
1962 if (!field->rmf_dumper)
1965 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1967 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1968 do_swab ? "unswabbed " : "", field->rmf_name);
1969 field->rmf_dumper(value);
1974 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1976 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1977 "follows\n", field->rmf_name);
1978 field->rmf_dumper(value);
1985 * We're swabbing an array; swabber() swabs a single array element, so
1986 * swab every element.
1988 LASSERT((len % field->rmf_size) == 0);
1989 for (p = value, i = 0, n = len / field->rmf_size;
1991 i++, p += field->rmf_size) {
1993 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1994 "element %d follows\n",
1995 do_swab ? "unswabbed " : "", field->rmf_name, i);
1996 field->rmf_dumper(p);
2002 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2003 "element %d follows\n", field->rmf_name, i);
2004 field->rmf_dumper(value);
2008 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2012 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2013 * corresponding to the given RMF (\a field).
2015 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2016 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2017 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2018 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2019 * element of the array swabbed.
2021 static void *__req_capsule_get(struct req_capsule *pill,
2022 const struct req_msg_field *field,
2023 enum req_location loc,
2024 void (*swabber)( void *),
2027 const struct req_format *fmt;
2028 struct lustre_msg *msg;
2033 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2035 static const char *rcl_names[RCL_NR] = {
2036 [RCL_CLIENT] = "client",
2037 [RCL_SERVER] = "server"
2040 LASSERT(pill != NULL);
2041 LASSERT(pill != LP_POISON);
2043 LASSERT(fmt != NULL);
2044 LASSERT(fmt != LP_POISON);
2045 LASSERT(__req_format_is_sane(fmt));
2047 offset = __req_capsule_offset(pill, field, loc);
2049 msg = __req_msg(pill, loc);
2050 LASSERT(msg != NULL);
2052 getter = (field->rmf_flags & RMF_F_STRING) ?
2053 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2055 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2057 * We've already asserted that field->rmf_size > 0 in
2058 * req_layout_init().
2060 len = lustre_msg_buflen(msg, offset);
2061 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2062 (len % field->rmf_size) != 0) {
2063 CERROR("%s: array field size mismatch "
2064 "%d modulo %u != 0 (%d)\n",
2065 field->rmf_name, len, field->rmf_size, loc);
2068 } else if (pill->rc_area[loc][offset] != -1) {
2069 len = pill->rc_area[loc][offset];
2071 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2073 value = getter(msg, offset, len);
2075 if (value == NULL) {
2076 DEBUG_REQ(D_ERROR, pill->rc_req,
2077 "Wrong buffer for field `%s' (%u of %u) "
2078 "in format `%s': %u vs. %u (%s)\n",
2079 field->rmf_name, offset, lustre_msg_bufcount(msg),
2080 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2083 swabber_dumper_helper(pill, field, loc, offset, value, len,
2091 * Dump a request and/or reply
2093 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2095 const struct req_format *fmt;
2096 const struct req_msg_field *field;
2102 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2103 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2104 field = FMT_FIELD(fmt, loc, i);
2105 if (field->rmf_dumper == NULL) {
2107 * FIXME Add a default hex dumper for fields that don't
2108 * have a specific dumper
2110 len = req_capsule_get_size(pill, field, loc);
2111 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2112 "field size is %u\n", field->rmf_name, len);
2114 /* It's the dumping side-effect that we're interested in */
2115 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2118 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2124 void req_capsule_client_dump(struct req_capsule *pill)
2126 __req_capsule_dump(pill, RCL_CLIENT);
2128 EXPORT_SYMBOL(req_capsule_client_dump);
2133 void req_capsule_server_dump(struct req_capsule *pill)
2135 __req_capsule_dump(pill, RCL_SERVER);
2137 EXPORT_SYMBOL(req_capsule_server_dump);
2140 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2141 * buffer corresponding to the given RMF (\a field) of a \a pill.
2143 void *req_capsule_client_get(struct req_capsule *pill,
2144 const struct req_msg_field *field)
2146 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2148 EXPORT_SYMBOL(req_capsule_client_get);
2151 * Same as req_capsule_client_get(), but with a \a swabber argument.
2153 * Currently unused; will be removed when req_capsule_server_swab_get() is
2156 void *req_capsule_client_swab_get(struct req_capsule *pill,
2157 const struct req_msg_field *field,
2160 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2162 EXPORT_SYMBOL(req_capsule_client_swab_get);
2165 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2167 * First the \a pill's request \a field's size is set (\a rc_area) using
2168 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2171 void *req_capsule_client_sized_get(struct req_capsule *pill,
2172 const struct req_msg_field *field,
2175 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2176 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2178 EXPORT_SYMBOL(req_capsule_client_sized_get);
2181 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2182 * buffer corresponding to the given RMF (\a field) of a \a pill.
2184 void *req_capsule_server_get(struct req_capsule *pill,
2185 const struct req_msg_field *field)
2187 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2189 EXPORT_SYMBOL(req_capsule_server_get);
2192 * Same as req_capsule_server_get(), but with a \a swabber argument.
2194 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2195 * swabbing done outside this capsule abstraction.
2197 void *req_capsule_server_swab_get(struct req_capsule *pill,
2198 const struct req_msg_field *field,
2201 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2203 EXPORT_SYMBOL(req_capsule_server_swab_get);
2206 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2208 * First the \a pill's request \a field's size is set (\a rc_area) using
2209 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2212 void *req_capsule_server_sized_get(struct req_capsule *pill,
2213 const struct req_msg_field *field,
2216 req_capsule_set_size(pill, field, RCL_SERVER, len);
2217 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2219 EXPORT_SYMBOL(req_capsule_server_sized_get);
2221 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2222 const struct req_msg_field *field,
2223 __u32 len, void *swabber)
2225 req_capsule_set_size(pill, field, RCL_SERVER, len);
2226 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2228 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2231 * Returns the buffer of a \a pill corresponding to the given \a field from the
2232 * request (if the caller is executing on the server-side) or reply (if the
2233 * caller is executing on the client-side).
2235 * This function convienient for use is code that could be executed on the
2236 * client and server alike.
2238 const void *req_capsule_other_get(struct req_capsule *pill,
2239 const struct req_msg_field *field)
2241 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2243 EXPORT_SYMBOL(req_capsule_other_get);
2246 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2247 * field of the given \a pill.
2249 * This function must be used when constructing variable sized fields of a
2252 void req_capsule_set_size(struct req_capsule *pill,
2253 const struct req_msg_field *field,
2254 enum req_location loc, __u32 size)
2256 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2258 if ((size != (__u32)field->rmf_size) &&
2259 (field->rmf_size != -1) &&
2260 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2262 __u32 rmf_size = (__u32)field->rmf_size;
2263 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2264 (size % rmf_size != 0)) {
2265 CERROR("%s: array field size mismatch "
2266 "%u %% %u != 0 (%d)\n",
2267 field->rmf_name, size, rmf_size, loc);
2269 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2271 CERROR("%s: field size mismatch %u != %u (%d)\n",
2272 field->rmf_name, size, rmf_size, loc);
2277 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2279 EXPORT_SYMBOL(req_capsule_set_size);
2282 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2283 * for the given \a pill's given \a field.
2285 * NB: this function doesn't correspond with req_capsule_set_size(), which
2286 * actually sets the size in pill.rc_area[loc][offset], but this function
2287 * returns the message buflen[offset], maybe we should use another name.
2289 __u32 req_capsule_get_size(const struct req_capsule *pill,
2290 const struct req_msg_field *field,
2291 enum req_location loc)
2293 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2295 return lustre_msg_buflen(__req_msg(pill, loc),
2296 __req_capsule_offset(pill, field, loc));
2298 EXPORT_SYMBOL(req_capsule_get_size);
2301 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2302 * given \a pill's request or reply (\a loc) given the field size recorded in
2303 * the \a pill's rc_area.
2305 * See also req_capsule_set_size().
2307 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2309 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2310 pill->rc_fmt->rf_fields[loc].nr,
2311 pill->rc_area[loc]);
2315 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2316 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2317 * PTLRPC request or reply given only an RQF (\a fmt).
2319 * This function should not be used for formats which contain variable size
2322 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2323 enum req_location loc)
2329 * This function should probably LASSERT() that fmt has no fields with
2330 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2331 * elements in the array there will ultimately be, but then, we could
2332 * assume that there will be at least one element, and that's just what
2335 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2339 for (; i < fmt->rf_fields[loc].nr; ++i)
2340 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2341 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2347 * Changes the format of an RPC.
2349 * The pill must already have been initialized, which means that it already has
2350 * a request format. The new format \a fmt must be an extension of the pill's
2351 * old format. Specifically: the new format must have as many request and reply
2352 * fields as the old one, and all fields shared by the old and new format must
2353 * be at least as large in the new format.
2355 * The new format's fields may be of different "type" than the old format, but
2356 * only for fields that are "opaque" blobs: fields which have a) have no
2357 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2358 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2359 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2360 * according to the key field. When the value, according to the key, contains a
2361 * structure (or array thereof) to be swabbed, the format should be changed to
2362 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2365 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2370 const struct req_format *old;
2372 LASSERT(pill->rc_fmt != NULL);
2373 LASSERT(__req_format_is_sane(fmt));
2377 * Sanity checking...
2379 for (i = 0; i < RCL_NR; ++i) {
2380 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2381 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2382 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2384 /* "opaque" fields can be transmogrified */
2385 if (ofield->rmf_swabber == NULL &&
2386 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2387 (ofield->rmf_size == -1 ||
2388 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2390 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2393 * Last field in old format can be shorter than in new.
2395 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2396 FMT_FIELD(old, i, j)->rmf_size);
2401 EXPORT_SYMBOL(req_capsule_extend);
2404 * This function returns a non-zero value if the given \a field is present in
2405 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2408 int req_capsule_has_field(const struct req_capsule *pill,
2409 const struct req_msg_field *field,
2410 enum req_location loc)
2412 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2414 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2416 EXPORT_SYMBOL(req_capsule_has_field);
2419 * Returns a non-zero value if the given \a field is present in the given \a
2420 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2422 int req_capsule_field_present(const struct req_capsule *pill,
2423 const struct req_msg_field *field,
2424 enum req_location loc)
2428 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2429 LASSERT(req_capsule_has_field(pill, field, loc));
2431 offset = __req_capsule_offset(pill, field, loc);
2432 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2434 EXPORT_SYMBOL(req_capsule_field_present);
2437 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2438 * request or reply (\a loc).
2440 * This is not the opposite of req_capsule_extend().
2442 void req_capsule_shrink(struct req_capsule *pill,
2443 const struct req_msg_field *field,
2445 enum req_location loc)
2447 const struct req_format *fmt;
2448 struct lustre_msg *msg;
2453 LASSERT(fmt != NULL);
2454 LASSERT(__req_format_is_sane(fmt));
2455 LASSERT(req_capsule_has_field(pill, field, loc));
2456 LASSERT(req_capsule_field_present(pill, field, loc));
2458 offset = __req_capsule_offset(pill, field, loc);
2460 msg = __req_msg(pill, loc);
2461 len = lustre_msg_buflen(msg, offset);
2462 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2463 fmt->rf_name, field->rmf_name, len, newlen);
2465 if (loc == RCL_CLIENT)
2466 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2469 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2472 EXPORT_SYMBOL(req_capsule_shrink);
2474 int req_capsule_server_grow(struct req_capsule *pill,
2475 const struct req_msg_field *field,
2478 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2483 LASSERT(pill->rc_fmt != NULL);
2484 LASSERT(__req_format_is_sane(pill->rc_fmt));
2485 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2486 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2488 len = req_capsule_get_size(pill, field, RCL_SERVER);
2489 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2490 if ((__u32)pill->rc_req->rq_repbuf_len >=
2491 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2492 CERROR("Inplace repack might be done\n");
2494 pill->rc_req->rq_reply_state = NULL;
2495 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2496 rc = req_capsule_server_pack(pill);
2498 /* put old rs back, the caller will decide what to do */
2499 pill->rc_req->rq_reply_state = rs;
2502 nrs = pill->rc_req->rq_reply_state;
2503 /* Now we need only buffers, copy first chunk */
2504 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2505 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2506 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2507 memcpy(to, from, len);
2508 /* check if we have tail and copy it too */
2509 if (rs->rs_msg->lm_bufcount > offset + 1) {
2510 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2511 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2512 offset = rs->rs_msg->lm_bufcount - 1;
2513 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2514 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2515 memcpy(to, from, len);
2517 /* drop old reply if everything is fine */
2518 if (rs->rs_difficult) {
2522 nrs->rs_difficult = 1;
2523 nrs->rs_no_ack = rs->rs_no_ack;
2524 nrs->rs_convert_lock = rs->rs_convert_lock;
2525 for (i = 0; i < rs->rs_nlocks; i++) {
2526 nrs->rs_locks[i] = rs->rs_locks[i];
2527 nrs->rs_modes[i] = rs->rs_modes[i];
2531 rs->rs_difficult = 0;
2534 ptlrpc_rs_decref(rs);
2537 EXPORT_SYMBOL(req_capsule_server_grow);