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 *log_cancel_client[] = {
95 static const struct req_msg_field *mdt_body_only[] = {
100 static const struct req_msg_field *mdt_body_capa[] = {
106 static const struct req_msg_field *quotactl_only[] = {
111 static const struct req_msg_field *quota_body_only[] = {
116 static const struct req_msg_field *ldlm_intent_quota_client[] = {
123 static const struct req_msg_field *ldlm_intent_quota_server[] = {
130 static const struct req_msg_field *mdt_close_client[] = {
137 static const struct req_msg_field *mdt_close_intent_client[] = {
146 static const struct req_msg_field *obd_statfs_server[] = {
151 static const struct req_msg_field *seq_query_client[] = {
157 static const struct req_msg_field *seq_query_server[] = {
162 static const struct req_msg_field *fld_query_client[] = {
168 static const struct req_msg_field *fld_query_server[] = {
173 static const struct req_msg_field *fld_read_client[] = {
178 static const struct req_msg_field *fld_read_server[] = {
183 static const struct req_msg_field *mds_getattr_name_client[] = {
190 static const struct req_msg_field *mds_reint_client[] = {
195 static const struct req_msg_field *mds_reint_create_client[] = {
202 static const struct req_msg_field *mds_reint_create_slave_client[] = {
211 static const struct req_msg_field *mds_reint_create_acl_client[] = {
218 &RMF_FILE_SECCTX_NAME,
222 static const struct req_msg_field *mds_reint_create_sym_client[] = {
229 &RMF_FILE_SECCTX_NAME,
233 static const struct req_msg_field *mds_reint_open_client[] = {
240 &RMF_FILE_SECCTX_NAME,
244 static const struct req_msg_field *mds_reint_open_server[] = {
253 static const struct req_msg_field *mds_reint_unlink_client[] = {
261 static const struct req_msg_field *mds_reint_link_client[] = {
270 static const struct req_msg_field *mds_reint_rename_client[] = {
280 static const struct req_msg_field *mds_reint_migrate_client[] = {
292 static const struct req_msg_field *mds_last_unlink_server[] = {
301 static const struct req_msg_field *mds_reint_setattr_client[] = {
311 static const struct req_msg_field *mds_reint_setxattr_client[] = {
320 static const struct req_msg_field *mds_reint_resync[] = {
326 static const struct req_msg_field *mdt_swap_layouts[] = {
335 static const struct req_msg_field *obd_connect_client[] = {
343 static const struct req_msg_field *obd_connect_server[] = {
348 static const struct req_msg_field *obd_set_info_client[] = {
354 static const struct req_msg_field *ost_grant_shrink_client[] = {
360 static const struct req_msg_field *mds_getinfo_client[] = {
366 static const struct req_msg_field *mds_getinfo_server[] = {
371 static const struct req_msg_field *ldlm_enqueue_client[] = {
376 static const struct req_msg_field *ldlm_enqueue_server[] = {
381 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
387 static const struct req_msg_field *ldlm_cp_callback_client[] = {
393 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
399 static const struct req_msg_field *ldlm_gl_callback_server[] = {
404 static const struct req_msg_field *ldlm_intent_basic_client[] = {
410 static const struct req_msg_field *ldlm_intent_client[] = {
417 static const struct req_msg_field *ldlm_intent_server[] = {
425 static const struct req_msg_field *ldlm_intent_layout_client[] = {
430 &RMF_EADATA /* for new layout to be set up */
432 static const struct req_msg_field *ldlm_intent_open_server[] = {
442 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
446 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
451 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
460 static const struct req_msg_field *ldlm_intent_create_client[] = {
464 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
468 &RMF_FILE_SECCTX_NAME,
472 static const struct req_msg_field *ldlm_intent_open_client[] = {
476 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
481 &RMF_FILE_SECCTX_NAME,
485 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
489 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
494 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
502 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
507 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
513 static const struct req_msg_field *mds_get_root_client[] = {
519 static const struct req_msg_field *mds_getxattr_client[] = {
527 static const struct req_msg_field *mds_getxattr_server[] = {
533 static const struct req_msg_field *mds_getattr_server[] = {
542 static const struct req_msg_field *mds_setattr_server[] = {
551 static const struct req_msg_field *mds_update_client[] = {
553 &RMF_OUT_UPDATE_HEADER,
557 static const struct req_msg_field *mds_update_server[] = {
559 &RMF_OUT_UPDATE_REPLY,
562 static const struct req_msg_field *llog_origin_handle_create_client[] = {
568 static const struct req_msg_field *llogd_body_only[] = {
573 static const struct req_msg_field *llog_log_hdr_only[] = {
578 static const struct req_msg_field *llogd_conn_body_only[] = {
583 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
589 static const struct req_msg_field *obd_idx_read_client[] = {
594 static const struct req_msg_field *obd_idx_read_server[] = {
599 static const struct req_msg_field *ost_body_only[] = {
604 static const struct req_msg_field *ost_body_capa[] = {
610 static const struct req_msg_field *ost_destroy_client[] = {
618 static const struct req_msg_field *ost_brw_client[] = {
627 static const struct req_msg_field *ost_brw_read_server[] = {
633 static const struct req_msg_field *ost_brw_write_server[] = {
639 static const struct req_msg_field *ost_get_info_generic_server[] = {
644 static const struct req_msg_field *ost_get_info_generic_client[] = {
649 static const struct req_msg_field *ost_get_last_id_server[] = {
654 static const struct req_msg_field *ost_get_last_fid_client[] = {
660 static const struct req_msg_field *ost_get_last_fid_server[] = {
665 static const struct req_msg_field *ost_get_fiemap_client[] = {
671 static const struct req_msg_field *ost_ladvise[] = {
674 &RMF_OST_LADVISE_HDR,
678 static const struct req_msg_field *ost_get_fiemap_server[] = {
683 static const struct req_msg_field *mdt_hsm_progress[] = {
686 &RMF_MDS_HSM_PROGRESS,
689 static const struct req_msg_field *mdt_hsm_ct_register[] = {
692 &RMF_MDS_HSM_ARCHIVE,
695 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
700 static const struct req_msg_field *mdt_hsm_action_server[] = {
703 &RMF_MDS_HSM_CURRENT_ACTION,
706 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
712 static const struct req_msg_field *mdt_hsm_state_set[] = {
719 static const struct req_msg_field *mdt_hsm_request[] = {
722 &RMF_MDS_HSM_REQUEST,
723 &RMF_MDS_HSM_USER_ITEM,
727 static const struct req_msg_field *obd_lfsck_request[] = {
732 static const struct req_msg_field *obd_lfsck_reply[] = {
737 static struct req_format *req_formats[] = {
743 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
746 &RQF_MGS_CONFIG_READ,
756 &RQF_MDS_GETATTR_NAME,
760 &RQF_MDS_CLOSE_INTENT,
763 &RQF_MDS_REINT_CREATE,
764 &RQF_MDS_REINT_CREATE_ACL,
765 &RQF_MDS_REINT_CREATE_SLAVE,
766 &RQF_MDS_REINT_CREATE_SYM,
768 &RQF_MDS_REINT_UNLINK,
770 &RQF_MDS_REINT_RENAME,
771 &RQF_MDS_REINT_MIGRATE,
772 &RQF_MDS_REINT_SETATTR,
773 &RQF_MDS_REINT_SETXATTR,
774 &RQF_MDS_REINT_RESYNC,
776 &RQF_MDS_HSM_PROGRESS,
777 &RQF_MDS_HSM_CT_REGISTER,
778 &RQF_MDS_HSM_CT_UNREGISTER,
779 &RQF_MDS_HSM_STATE_GET,
780 &RQF_MDS_HSM_STATE_SET,
782 &RQF_MDS_HSM_REQUEST,
783 &RQF_MDS_SWAP_LAYOUTS,
797 &RQF_OST_SET_GRANT_INFO,
799 &RQF_OST_GET_INFO_LAST_ID,
800 &RQF_OST_GET_INFO_LAST_FID,
801 &RQF_OST_SET_INFO_LAST_FID,
802 &RQF_OST_GET_INFO_FIEMAP,
805 &RQF_LDLM_ENQUEUE_LVB,
809 &RQF_LDLM_CP_CALLBACK,
810 &RQF_LDLM_BL_CALLBACK,
811 &RQF_LDLM_GL_CALLBACK,
812 &RQF_LDLM_GL_CALLBACK_DESC,
814 &RQF_LDLM_INTENT_BASIC,
815 &RQF_LDLM_INTENT_LAYOUT,
816 &RQF_LDLM_INTENT_GETATTR,
817 &RQF_LDLM_INTENT_OPEN,
818 &RQF_LDLM_INTENT_CREATE,
819 &RQF_LDLM_INTENT_UNLINK,
820 &RQF_LDLM_INTENT_GETXATTR,
821 &RQF_LDLM_INTENT_QUOTA,
824 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
825 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
826 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
827 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
828 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
829 &RQF_LLOG_ORIGIN_CONNECT,
835 struct req_msg_field {
836 const __u32 rmf_flags;
837 const char *rmf_name;
839 * Field length. (-1) means "variable length". If the
840 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
841 * but the actual size must be a whole multiple of \a rmf_size.
844 void (*rmf_swabber)(void *);
845 void (*rmf_dumper)(void *);
846 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
851 * The field is a string, must be NUL-terminated.
853 RMF_F_STRING = 1 << 0,
855 * The field's buffer size need not match the declared \a rmf_size.
857 RMF_F_NO_SIZE_CHECK = 1 << 1,
859 * The field's buffer size must be a whole multiple of the declared \a
860 * rmf_size and the \a rmf_swabber function must work on the declared \a
861 * rmf_size worth of bytes.
863 RMF_F_STRUCT_ARRAY = 1 << 2
871 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
872 .rmf_name = (name), \
873 .rmf_flags = (flags), \
874 .rmf_size = (size), \
875 .rmf_swabber = (void (*)(void*))(swabber), \
876 .rmf_dumper = (void (*)(void*))(dumper) \
879 struct req_msg_field RMF_GENERIC_DATA =
880 DEFINE_MSGF("generic_data", 0,
882 EXPORT_SYMBOL(RMF_GENERIC_DATA);
884 struct req_msg_field RMF_MGS_TARGET_INFO =
885 DEFINE_MSGF("mgs_target_info", 0,
886 sizeof(struct mgs_target_info),
887 lustre_swab_mgs_target_info, NULL);
888 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
890 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
891 struct req_msg_field RMF_MGS_SEND_PARAM =
892 DEFINE_MSGF("mgs_send_param", 0,
893 sizeof(struct mgs_send_param),
895 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
898 struct req_msg_field RMF_MGS_CONFIG_BODY =
899 DEFINE_MSGF("mgs_config_read request", 0,
900 sizeof(struct mgs_config_body),
901 lustre_swab_mgs_config_body, NULL);
902 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
904 struct req_msg_field RMF_MGS_CONFIG_RES =
905 DEFINE_MSGF("mgs_config_read reply ", 0,
906 sizeof(struct mgs_config_res),
907 lustre_swab_mgs_config_res, NULL);
908 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
910 struct req_msg_field RMF_U32 =
911 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
912 sizeof(__u32), lustre_swab_generic_32s, NULL);
913 EXPORT_SYMBOL(RMF_U32);
915 struct req_msg_field RMF_SETINFO_VAL =
916 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
917 EXPORT_SYMBOL(RMF_SETINFO_VAL);
919 struct req_msg_field RMF_GETINFO_KEY =
920 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
921 EXPORT_SYMBOL(RMF_GETINFO_KEY);
923 struct req_msg_field RMF_GETINFO_VALLEN =
924 DEFINE_MSGF("getinfo_vallen", 0,
925 sizeof(__u32), lustre_swab_generic_32s, NULL);
926 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
928 struct req_msg_field RMF_GETINFO_VAL =
929 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
930 EXPORT_SYMBOL(RMF_GETINFO_VAL);
932 struct req_msg_field RMF_SEQ_OPC =
933 DEFINE_MSGF("seq_query_opc", 0,
934 sizeof(__u32), lustre_swab_generic_32s, NULL);
935 EXPORT_SYMBOL(RMF_SEQ_OPC);
937 struct req_msg_field RMF_SEQ_RANGE =
938 DEFINE_MSGF("seq_query_range", 0,
939 sizeof(struct lu_seq_range),
940 lustre_swab_lu_seq_range, NULL);
941 EXPORT_SYMBOL(RMF_SEQ_RANGE);
943 struct req_msg_field RMF_FLD_OPC =
944 DEFINE_MSGF("fld_query_opc", 0,
945 sizeof(__u32), lustre_swab_generic_32s, NULL);
946 EXPORT_SYMBOL(RMF_FLD_OPC);
948 struct req_msg_field RMF_FLD_MDFLD =
949 DEFINE_MSGF("fld_query_mdfld", 0,
950 sizeof(struct lu_seq_range),
951 lustre_swab_lu_seq_range, NULL);
952 EXPORT_SYMBOL(RMF_FLD_MDFLD);
954 struct req_msg_field RMF_MDT_BODY =
955 DEFINE_MSGF("mdt_body", 0,
956 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
957 EXPORT_SYMBOL(RMF_MDT_BODY);
959 struct req_msg_field RMF_OBD_QUOTACTL =
960 DEFINE_MSGF("obd_quotactl", 0,
961 sizeof(struct obd_quotactl),
962 lustre_swab_obd_quotactl, NULL);
963 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
965 struct req_msg_field RMF_QUOTA_BODY =
966 DEFINE_MSGF("quota_body", 0,
967 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
968 EXPORT_SYMBOL(RMF_QUOTA_BODY);
970 struct req_msg_field RMF_MDT_EPOCH =
971 DEFINE_MSGF("mdt_ioepoch", 0,
972 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
973 EXPORT_SYMBOL(RMF_MDT_EPOCH);
975 struct req_msg_field RMF_PTLRPC_BODY =
976 DEFINE_MSGF("ptlrpc_body", 0,
977 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
978 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
980 struct req_msg_field RMF_CLOSE_DATA =
981 DEFINE_MSGF("data_version", 0,
982 sizeof(struct close_data), lustre_swab_close_data, NULL);
983 EXPORT_SYMBOL(RMF_CLOSE_DATA);
985 struct req_msg_field RMF_OBD_STATFS =
986 DEFINE_MSGF("obd_statfs", 0,
987 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
988 EXPORT_SYMBOL(RMF_OBD_STATFS);
990 struct req_msg_field RMF_SETINFO_KEY =
991 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
992 EXPORT_SYMBOL(RMF_SETINFO_KEY);
994 struct req_msg_field RMF_NAME =
995 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
996 EXPORT_SYMBOL(RMF_NAME);
998 struct req_msg_field RMF_SYMTGT =
999 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
1000 EXPORT_SYMBOL(RMF_SYMTGT);
1002 struct req_msg_field RMF_TGTUUID =
1003 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1005 EXPORT_SYMBOL(RMF_TGTUUID);
1007 struct req_msg_field RMF_CLUUID =
1008 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1010 EXPORT_SYMBOL(RMF_CLUUID);
1012 struct req_msg_field RMF_STRING =
1013 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1014 EXPORT_SYMBOL(RMF_STRING);
1016 struct req_msg_field RMF_FILE_SECCTX_NAME =
1017 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1018 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1020 struct req_msg_field RMF_FILE_SECCTX =
1021 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1022 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1024 struct req_msg_field RMF_LLOGD_BODY =
1025 DEFINE_MSGF("llogd_body", 0,
1026 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1027 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1029 struct req_msg_field RMF_LLOG_LOG_HDR =
1030 DEFINE_MSGF("llog_log_hdr", 0,
1031 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1032 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1034 struct req_msg_field RMF_LLOGD_CONN_BODY =
1035 DEFINE_MSGF("llogd_conn_body", 0,
1036 sizeof(struct llogd_conn_body),
1037 lustre_swab_llogd_conn_body, NULL);
1038 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1041 * connection handle received in MDS_CONNECT request.
1043 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1044 * that the client does not interpret at all.
1046 struct req_msg_field RMF_CONN =
1047 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1048 EXPORT_SYMBOL(RMF_CONN);
1050 struct req_msg_field RMF_CONNECT_DATA =
1051 DEFINE_MSGF("cdata",
1052 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1053 sizeof(struct obd_connect_data),
1054 lustre_swab_connect, NULL);
1055 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1057 struct req_msg_field RMF_DLM_REQ =
1058 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1059 sizeof(struct ldlm_request),
1060 lustre_swab_ldlm_request, NULL);
1061 EXPORT_SYMBOL(RMF_DLM_REQ);
1063 struct req_msg_field RMF_DLM_REP =
1064 DEFINE_MSGF("dlm_rep", 0,
1065 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1066 EXPORT_SYMBOL(RMF_DLM_REP);
1068 struct req_msg_field RMF_LDLM_INTENT =
1069 DEFINE_MSGF("ldlm_intent", 0,
1070 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1071 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1073 struct req_msg_field RMF_DLM_LVB =
1074 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1075 EXPORT_SYMBOL(RMF_DLM_LVB);
1077 struct req_msg_field RMF_DLM_GL_DESC =
1078 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1079 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1081 struct req_msg_field RMF_MDT_MD =
1082 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1083 EXPORT_SYMBOL(RMF_MDT_MD);
1085 struct req_msg_field RMF_REC_REINT =
1086 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1087 lustre_swab_mdt_rec_reint, NULL);
1088 EXPORT_SYMBOL(RMF_REC_REINT);
1090 /* FIXME: this length should be defined as a macro */
1091 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1093 EXPORT_SYMBOL(RMF_EADATA);
1095 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1096 EXPORT_SYMBOL(RMF_EAVALS);
1098 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1099 EXPORT_SYMBOL(RMF_ACL);
1101 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1102 struct req_msg_field RMF_LOGCOOKIES =
1103 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1104 sizeof(struct llog_cookie), NULL, NULL);
1105 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1107 struct req_msg_field RMF_CAPA1 =
1108 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1109 lustre_swab_lustre_capa, NULL);
1110 EXPORT_SYMBOL(RMF_CAPA1);
1112 struct req_msg_field RMF_CAPA2 =
1113 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1114 lustre_swab_lustre_capa, NULL);
1115 EXPORT_SYMBOL(RMF_CAPA2);
1117 struct req_msg_field RMF_LAYOUT_INTENT =
1118 DEFINE_MSGF("layout_intent", 0,
1119 sizeof(struct layout_intent), lustre_swab_layout_intent,
1121 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1124 * OST request field.
1126 struct req_msg_field RMF_OST_BODY =
1127 DEFINE_MSGF("ost_body", 0,
1128 sizeof(struct ost_body), lustre_swab_ost_body,
1130 EXPORT_SYMBOL(RMF_OST_BODY);
1132 struct req_msg_field RMF_OBD_IOOBJ =
1133 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1134 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1135 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1137 struct req_msg_field RMF_NIOBUF_REMOTE =
1138 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1139 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1141 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1143 struct req_msg_field RMF_RCS =
1144 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1145 lustre_swab_generic_32s, dump_rcs);
1146 EXPORT_SYMBOL(RMF_RCS);
1148 struct req_msg_field RMF_EAVALS_LENS =
1149 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1150 lustre_swab_generic_32s, NULL);
1151 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1153 struct req_msg_field RMF_OBD_ID =
1154 DEFINE_MSGF("obd_id", 0,
1155 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1156 EXPORT_SYMBOL(RMF_OBD_ID);
1158 struct req_msg_field RMF_FID =
1159 DEFINE_MSGF("fid", 0,
1160 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1161 EXPORT_SYMBOL(RMF_FID);
1163 struct req_msg_field RMF_OST_ID =
1164 DEFINE_MSGF("ost_id", 0,
1165 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1166 EXPORT_SYMBOL(RMF_OST_ID);
1168 struct req_msg_field RMF_FIEMAP_KEY =
1169 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1170 lustre_swab_fiemap, NULL);
1171 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1173 struct req_msg_field RMF_FIEMAP_VAL =
1174 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1175 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1177 struct req_msg_field RMF_IDX_INFO =
1178 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1179 lustre_swab_idx_info, NULL);
1180 EXPORT_SYMBOL(RMF_IDX_INFO);
1181 struct req_msg_field RMF_SHORT_IO =
1182 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1183 EXPORT_SYMBOL(RMF_SHORT_IO);
1184 struct req_msg_field RMF_HSM_USER_STATE =
1185 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1186 lustre_swab_hsm_user_state, NULL);
1187 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1189 struct req_msg_field RMF_HSM_STATE_SET =
1190 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1191 lustre_swab_hsm_state_set, NULL);
1192 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1194 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1195 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1196 lustre_swab_hsm_progress_kernel, NULL);
1197 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1199 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1200 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1201 lustre_swab_hsm_current_action, NULL);
1202 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1204 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1205 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1206 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1208 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1210 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1211 DEFINE_MSGF("hsm_archive", 0,
1212 sizeof(__u32), lustre_swab_generic_32s, NULL);
1213 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1215 struct req_msg_field RMF_MDS_HSM_REQUEST =
1216 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1217 lustre_swab_hsm_request, NULL);
1218 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1220 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1221 lustre_swab_object_update_request, NULL);
1222 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1224 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1225 DEFINE_MSGF("object_update_reply", 0, -1,
1226 lustre_swab_object_update_reply, NULL);
1227 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1229 struct req_msg_field RMF_SWAP_LAYOUTS =
1230 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1231 lustre_swab_swap_layouts, NULL);
1232 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1234 struct req_msg_field RMF_LFSCK_REQUEST =
1235 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1236 lustre_swab_lfsck_request, NULL);
1237 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1239 struct req_msg_field RMF_LFSCK_REPLY =
1240 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1241 lustre_swab_lfsck_reply, NULL);
1242 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1244 struct req_msg_field RMF_OST_LADVISE_HDR =
1245 DEFINE_MSGF("ladvise_request", 0,
1246 sizeof(struct ladvise_hdr),
1247 lustre_swab_ladvise_hdr, NULL);
1248 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1250 struct req_msg_field RMF_OST_LADVISE =
1251 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1252 sizeof(struct lu_ladvise),
1253 lustre_swab_ladvise, NULL);
1254 EXPORT_SYMBOL(RMF_OST_LADVISE);
1256 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1257 -1, lustre_swab_out_update_header, NULL);
1258 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1260 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1261 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1262 lustre_swab_out_update_buffer, NULL);
1263 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1270 const char *rf_name;
1274 const struct req_msg_field **d;
1275 } rf_fields[RCL_NR];
1278 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1292 #define DEFINE_REQ_FMT0(name, client, server) \
1293 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1295 struct req_format RQF_OBD_PING =
1296 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1297 EXPORT_SYMBOL(RQF_OBD_PING);
1299 struct req_format RQF_OBD_SET_INFO =
1300 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1301 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1303 /* Read index file through the network */
1304 struct req_format RQF_OBD_IDX_READ =
1305 DEFINE_REQ_FMT0("OBD_IDX_READ",
1306 obd_idx_read_client, obd_idx_read_server);
1307 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1309 struct req_format RQF_SEC_CTX =
1310 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1311 EXPORT_SYMBOL(RQF_SEC_CTX);
1313 struct req_format RQF_MGS_TARGET_REG =
1314 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1315 mgs_target_info_only);
1316 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1318 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1319 struct req_format RQF_MGS_SET_INFO =
1320 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1322 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1325 struct req_format RQF_MGS_CONFIG_READ =
1326 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1327 mgs_config_read_server);
1328 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1330 struct req_format RQF_SEQ_QUERY =
1331 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1332 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1334 struct req_format RQF_FLD_QUERY =
1335 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1336 EXPORT_SYMBOL(RQF_FLD_QUERY);
1338 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1339 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1340 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1341 * peers need to handle the RPC reply with fixed little-endian format.
1343 * In theory, we can define new structure with some swabber registered to
1344 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1345 * implementation view, it is not easy to be done within current "struct
1346 * req_msg_field" framework. Because the sequence range array in the RPC
1347 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1348 * count, that is unknown when prepare the RPC buffer. Generally, for such
1349 * flexible length RPC usage, there will be a field in the RPC layout to
1350 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1351 * do that unless we add new length filed that will broken the on-wire RPC
1352 * protocol and cause interoperability trouble with old peer. */
1353 struct req_format RQF_FLD_READ =
1354 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1355 EXPORT_SYMBOL(RQF_FLD_READ);
1357 struct req_format RQF_LOG_CANCEL =
1358 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1359 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1361 struct req_format RQF_MDS_QUOTACTL =
1362 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1363 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1365 struct req_format RQF_OST_QUOTACTL =
1366 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1367 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1369 struct req_format RQF_QUOTA_DQACQ =
1370 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1371 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1373 struct req_format RQF_LDLM_INTENT_QUOTA =
1374 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1375 ldlm_intent_quota_client,
1376 ldlm_intent_quota_server);
1377 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1379 struct req_format RQF_MDS_GET_ROOT =
1380 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1381 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1383 struct req_format RQF_MDS_STATFS =
1384 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1385 EXPORT_SYMBOL(RQF_MDS_STATFS);
1387 struct req_format RQF_MDS_SYNC =
1388 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1389 EXPORT_SYMBOL(RQF_MDS_SYNC);
1391 struct req_format RQF_MDS_GETATTR =
1392 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1393 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1395 struct req_format RQF_MDS_GETXATTR =
1396 DEFINE_REQ_FMT0("MDS_GETXATTR",
1397 mds_getxattr_client, mds_getxattr_server);
1398 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1400 struct req_format RQF_MDS_GETATTR_NAME =
1401 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1402 mds_getattr_name_client, mds_getattr_server);
1403 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1405 struct req_format RQF_MDS_REINT =
1406 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1407 EXPORT_SYMBOL(RQF_MDS_REINT);
1409 struct req_format RQF_MDS_REINT_CREATE =
1410 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1411 mds_reint_create_client, mdt_body_capa);
1412 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1414 struct req_format RQF_MDS_REINT_CREATE_ACL =
1415 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1416 mds_reint_create_acl_client, mdt_body_capa);
1417 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1419 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1420 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1421 mds_reint_create_slave_client, mdt_body_capa);
1422 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1424 struct req_format RQF_MDS_REINT_CREATE_SYM =
1425 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1426 mds_reint_create_sym_client, mdt_body_capa);
1427 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1429 struct req_format RQF_MDS_REINT_OPEN =
1430 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1431 mds_reint_open_client, mds_reint_open_server);
1432 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1434 struct req_format RQF_MDS_REINT_UNLINK =
1435 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1436 mds_last_unlink_server);
1437 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1439 struct req_format RQF_MDS_REINT_LINK =
1440 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1441 mds_reint_link_client, mdt_body_only);
1442 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1444 struct req_format RQF_MDS_REINT_RENAME =
1445 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1446 mds_last_unlink_server);
1447 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1449 struct req_format RQF_MDS_REINT_MIGRATE =
1450 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1451 mds_last_unlink_server);
1452 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1454 struct req_format RQF_MDS_REINT_SETATTR =
1455 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1456 mds_reint_setattr_client, mds_setattr_server);
1457 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1459 struct req_format RQF_MDS_REINT_SETXATTR =
1460 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1461 mds_reint_setxattr_client, mdt_body_only);
1462 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1464 struct req_format RQF_MDS_REINT_RESYNC =
1465 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1466 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1468 struct req_format RQF_MDS_CONNECT =
1469 DEFINE_REQ_FMT0("MDS_CONNECT",
1470 obd_connect_client, obd_connect_server);
1471 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1473 struct req_format RQF_MDS_DISCONNECT =
1474 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1475 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1477 struct req_format RQF_MDS_GET_INFO =
1478 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1479 mds_getinfo_server);
1480 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1482 struct req_format RQF_OUT_UPDATE =
1483 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1485 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1487 struct req_format RQF_LDLM_ENQUEUE =
1488 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1489 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1490 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1492 struct req_format RQF_LDLM_ENQUEUE_LVB =
1493 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1494 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1495 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1497 struct req_format RQF_LDLM_CONVERT =
1498 DEFINE_REQ_FMT0("LDLM_CONVERT",
1499 ldlm_enqueue_client, ldlm_enqueue_server);
1500 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1502 struct req_format RQF_LDLM_CANCEL =
1503 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1504 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1506 struct req_format RQF_LDLM_CALLBACK =
1507 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1508 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1510 struct req_format RQF_LDLM_CP_CALLBACK =
1511 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1512 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1514 struct req_format RQF_LDLM_BL_CALLBACK =
1515 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1516 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1518 struct req_format RQF_LDLM_GL_CALLBACK =
1519 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1520 ldlm_gl_callback_server);
1521 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1523 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1524 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1525 ldlm_gl_callback_server);
1526 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1528 struct req_format RQF_LDLM_INTENT_BASIC =
1529 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1530 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1531 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1533 struct req_format RQF_LDLM_INTENT =
1534 DEFINE_REQ_FMT0("LDLM_INTENT",
1535 ldlm_intent_client, ldlm_intent_server);
1536 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1538 struct req_format RQF_LDLM_INTENT_LAYOUT =
1539 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1540 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1541 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1543 struct req_format RQF_LDLM_INTENT_GETATTR =
1544 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1545 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1546 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1548 struct req_format RQF_LDLM_INTENT_OPEN =
1549 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1550 ldlm_intent_open_client, ldlm_intent_open_server);
1551 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1553 struct req_format RQF_LDLM_INTENT_CREATE =
1554 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1555 ldlm_intent_create_client, ldlm_intent_getattr_server);
1556 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1558 struct req_format RQF_LDLM_INTENT_UNLINK =
1559 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1560 ldlm_intent_unlink_client, ldlm_intent_server);
1561 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1563 struct req_format RQF_LDLM_INTENT_GETXATTR =
1564 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1565 ldlm_intent_getxattr_client,
1566 ldlm_intent_getxattr_server);
1567 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1569 struct req_format RQF_MDS_CLOSE =
1570 DEFINE_REQ_FMT0("MDS_CLOSE",
1571 mdt_close_client, mds_last_unlink_server);
1572 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1574 struct req_format RQF_MDS_CLOSE_INTENT =
1575 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1576 mdt_close_intent_client, mds_last_unlink_server);
1577 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1579 struct req_format RQF_MDS_READPAGE =
1580 DEFINE_REQ_FMT0("MDS_READPAGE",
1581 mdt_body_capa, mdt_body_only);
1582 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1584 struct req_format RQF_MDS_HSM_ACTION =
1585 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1586 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1588 struct req_format RQF_MDS_HSM_PROGRESS =
1589 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1590 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1592 struct req_format RQF_MDS_HSM_CT_REGISTER =
1593 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1594 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1596 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1597 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1598 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1600 struct req_format RQF_MDS_HSM_STATE_GET =
1601 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1602 mdt_body_capa, mdt_hsm_state_get_server);
1603 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1605 struct req_format RQF_MDS_HSM_STATE_SET =
1606 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1607 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1609 struct req_format RQF_MDS_HSM_REQUEST =
1610 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1611 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1613 struct req_format RQF_MDS_SWAP_LAYOUTS =
1614 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1615 mdt_swap_layouts, empty);
1616 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1618 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1619 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1620 llog_origin_handle_create_client, llogd_body_only);
1621 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1623 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1624 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1625 llogd_body_only, llogd_body_only);
1626 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1628 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1629 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1630 llogd_body_only, llog_origin_handle_next_block_server);
1631 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1633 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1634 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1635 llogd_body_only, llog_origin_handle_next_block_server);
1636 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1638 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1639 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1640 llogd_body_only, llog_log_hdr_only);
1641 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1643 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1644 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1645 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1647 struct req_format RQF_CONNECT =
1648 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1649 EXPORT_SYMBOL(RQF_CONNECT);
1651 struct req_format RQF_OST_CONNECT =
1652 DEFINE_REQ_FMT0("OST_CONNECT",
1653 obd_connect_client, obd_connect_server);
1654 EXPORT_SYMBOL(RQF_OST_CONNECT);
1656 struct req_format RQF_OST_DISCONNECT =
1657 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1658 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1660 struct req_format RQF_OST_GETATTR =
1661 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1662 EXPORT_SYMBOL(RQF_OST_GETATTR);
1664 struct req_format RQF_OST_SETATTR =
1665 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1666 EXPORT_SYMBOL(RQF_OST_SETATTR);
1668 struct req_format RQF_OST_CREATE =
1669 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1670 EXPORT_SYMBOL(RQF_OST_CREATE);
1672 struct req_format RQF_OST_PUNCH =
1673 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1674 EXPORT_SYMBOL(RQF_OST_PUNCH);
1676 struct req_format RQF_OST_SYNC =
1677 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1678 EXPORT_SYMBOL(RQF_OST_SYNC);
1680 struct req_format RQF_OST_DESTROY =
1681 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1682 EXPORT_SYMBOL(RQF_OST_DESTROY);
1684 struct req_format RQF_OST_BRW_READ =
1685 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1686 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1688 struct req_format RQF_OST_BRW_WRITE =
1689 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1690 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1692 struct req_format RQF_OST_STATFS =
1693 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1694 EXPORT_SYMBOL(RQF_OST_STATFS);
1696 struct req_format RQF_OST_SET_GRANT_INFO =
1697 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1699 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1701 struct req_format RQF_OST_GET_INFO =
1702 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1703 ost_get_info_generic_server);
1704 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1706 struct req_format RQF_OST_GET_INFO_LAST_ID =
1707 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1708 ost_get_last_id_server);
1709 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1711 struct req_format RQF_OST_GET_INFO_LAST_FID =
1712 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1713 ost_get_last_fid_server);
1714 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1716 struct req_format RQF_OST_SET_INFO_LAST_FID =
1717 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1719 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1721 struct req_format RQF_OST_GET_INFO_FIEMAP =
1722 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1723 ost_get_fiemap_server);
1724 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1726 struct req_format RQF_LFSCK_NOTIFY =
1727 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1728 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1730 struct req_format RQF_LFSCK_QUERY =
1731 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1732 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1734 struct req_format RQF_OST_LADVISE =
1735 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1736 EXPORT_SYMBOL(RQF_OST_LADVISE);
1738 /* Convenience macro */
1739 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1742 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1743 * field of RQFs and the \a rmf_offset field of RMFs.
1745 int req_layout_init(void)
1750 struct req_format *rf = NULL;
1752 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1753 rf = req_formats[i];
1755 for (j = 0; j < RCL_NR; ++j) {
1756 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1757 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1758 struct req_msg_field *field;
1760 field = (typeof(field))rf->rf_fields[j].d[k];
1761 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1762 || field->rmf_size > 0);
1763 LASSERT(field->rmf_offset[i][j] == 0);
1765 * k + 1 to detect unused format/field
1768 field->rmf_offset[i][j] = k + 1;
1774 EXPORT_SYMBOL(req_layout_init);
1776 void req_layout_fini(void)
1779 EXPORT_SYMBOL(req_layout_fini);
1782 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1784 * Actual/expected field sizes are set elsewhere in functions in this file:
1785 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1786 * req_capsule_msg_size(). The \a rc_area information is used by.
1787 * ptlrpc_request_set_replen().
1789 void req_capsule_init_area(struct req_capsule *pill)
1793 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1794 pill->rc_area[RCL_CLIENT][i] = -1;
1795 pill->rc_area[RCL_SERVER][i] = -1;
1798 EXPORT_SYMBOL(req_capsule_init_area);
1801 * Initialize a pill.
1803 * The \a location indicates whether the caller is executing on the client side
1804 * (RCL_CLIENT) or server side (RCL_SERVER)..
1806 void req_capsule_init(struct req_capsule *pill,
1807 struct ptlrpc_request *req,
1808 enum req_location location)
1810 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1813 * Today all capsules are embedded in ptlrpc_request structs,
1814 * but just in case that ever isn't the case, we don't reach
1815 * into req unless req != NULL and pill is the one embedded in
1818 * The req->rq_pill_init flag makes it safe to initialize a pill
1819 * twice, which might happen in the OST paths as a result of the
1820 * high-priority RPC queue getting peeked at before ost_handle()
1821 * handles an OST RPC.
1823 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1826 memset(pill, 0, sizeof *pill);
1828 pill->rc_loc = location;
1829 req_capsule_init_area(pill);
1831 if (req != NULL && pill == &req->rq_pill)
1832 req->rq_pill_init = 1;
1834 EXPORT_SYMBOL(req_capsule_init);
1836 void req_capsule_fini(struct req_capsule *pill)
1839 EXPORT_SYMBOL(req_capsule_fini);
1841 static int __req_format_is_sane(const struct req_format *fmt)
1843 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1844 req_formats[fmt->rf_idx] == fmt;
1847 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1848 enum req_location loc)
1850 struct ptlrpc_request *req;
1853 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1857 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1858 * (see req_capsule_extend()).
1860 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1862 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1863 LASSERT(__req_format_is_sane(fmt));
1867 EXPORT_SYMBOL(req_capsule_set);
1870 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1873 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1874 * variable-sized fields. The field sizes come from the declared \a rmf_size
1875 * field of a \a pill's \a rc_fmt's RMF's.
1877 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1878 enum req_location loc)
1880 const struct req_format *fmt = pill->rc_fmt;
1883 LASSERT(fmt != NULL);
1885 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1886 if (pill->rc_area[loc][i] == -1) {
1887 pill->rc_area[loc][i] =
1888 fmt->rf_fields[loc].d[i]->rmf_size;
1889 if (pill->rc_area[loc][i] == -1) {
1891 * Skip the following fields.
1893 * If this LASSERT() trips then you're missing a
1894 * call to req_capsule_set_size().
1896 LASSERT(loc != RCL_SERVER);
1903 EXPORT_SYMBOL(req_capsule_filled_sizes);
1906 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1908 * This function uses the \a pill's \a rc_area as filled in by
1909 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1912 int req_capsule_server_pack(struct req_capsule *pill)
1914 const struct req_format *fmt;
1918 LASSERT(pill->rc_loc == RCL_SERVER);
1920 LASSERT(fmt != NULL);
1922 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1923 rc = lustre_pack_reply(pill->rc_req, count,
1924 pill->rc_area[RCL_SERVER], NULL);
1926 DEBUG_REQ(D_ERROR, pill->rc_req,
1927 "Cannot pack %d fields in format `%s': ",
1928 count, fmt->rf_name);
1932 EXPORT_SYMBOL(req_capsule_server_pack);
1935 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1936 * corresponding to the given RMF (\a field).
1938 __u32 __req_capsule_offset(const struct req_capsule *pill,
1939 const struct req_msg_field *field,
1940 enum req_location loc)
1942 unsigned int offset;
1944 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1945 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1946 pill->rc_fmt->rf_name,
1947 field->rmf_name, offset, loc);
1950 LASSERT(offset < REQ_MAX_FIELD_NR);
1955 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1960 swabber_dumper_helper(struct req_capsule *pill,
1961 const struct req_msg_field *field,
1962 enum req_location loc,
1964 void *value, int len, int dump, void (*swabber)( void *))
1970 int inout = loc == RCL_CLIENT;
1972 swabber = swabber ?: field->rmf_swabber;
1974 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1975 swabber != NULL && value != NULL)
1980 if (!field->rmf_dumper)
1983 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1985 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1986 do_swab ? "unswabbed " : "", field->rmf_name);
1987 field->rmf_dumper(value);
1992 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1994 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1995 "follows\n", field->rmf_name);
1996 field->rmf_dumper(value);
2003 * We're swabbing an array; swabber() swabs a single array element, so
2004 * swab every element.
2006 LASSERT((len % field->rmf_size) == 0);
2007 for (p = value, i = 0, n = len / field->rmf_size;
2009 i++, p += field->rmf_size) {
2011 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2012 "element %d follows\n",
2013 do_swab ? "unswabbed " : "", field->rmf_name, i);
2014 field->rmf_dumper(p);
2020 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2021 "element %d follows\n", field->rmf_name, i);
2022 field->rmf_dumper(value);
2026 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2030 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2031 * corresponding to the given RMF (\a field).
2033 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2034 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2035 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2036 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2037 * element of the array swabbed.
2039 static void *__req_capsule_get(struct req_capsule *pill,
2040 const struct req_msg_field *field,
2041 enum req_location loc,
2042 void (*swabber)( void *),
2045 const struct req_format *fmt;
2046 struct lustre_msg *msg;
2051 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2053 static const char *rcl_names[RCL_NR] = {
2054 [RCL_CLIENT] = "client",
2055 [RCL_SERVER] = "server"
2058 LASSERT(pill != NULL);
2059 LASSERT(pill != LP_POISON);
2061 LASSERT(fmt != NULL);
2062 LASSERT(fmt != LP_POISON);
2063 LASSERT(__req_format_is_sane(fmt));
2065 offset = __req_capsule_offset(pill, field, loc);
2067 msg = __req_msg(pill, loc);
2068 LASSERT(msg != NULL);
2070 getter = (field->rmf_flags & RMF_F_STRING) ?
2071 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2073 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2075 * We've already asserted that field->rmf_size > 0 in
2076 * req_layout_init().
2078 len = lustre_msg_buflen(msg, offset);
2079 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2080 (len % field->rmf_size) != 0) {
2081 CERROR("%s: array field size mismatch "
2082 "%d modulo %u != 0 (%d)\n",
2083 field->rmf_name, len, field->rmf_size, loc);
2086 } else if (pill->rc_area[loc][offset] != -1) {
2087 len = pill->rc_area[loc][offset];
2089 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2091 value = getter(msg, offset, len);
2093 if (value == NULL) {
2094 DEBUG_REQ(D_ERROR, pill->rc_req,
2095 "Wrong buffer for field `%s' (%u of %u) "
2096 "in format `%s': %u vs. %u (%s)\n",
2097 field->rmf_name, offset, lustre_msg_bufcount(msg),
2098 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2101 swabber_dumper_helper(pill, field, loc, offset, value, len,
2109 * Dump a request and/or reply
2111 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2113 const struct req_format *fmt;
2114 const struct req_msg_field *field;
2120 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2121 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2122 field = FMT_FIELD(fmt, loc, i);
2123 if (field->rmf_dumper == NULL) {
2125 * FIXME Add a default hex dumper for fields that don't
2126 * have a specific dumper
2128 len = req_capsule_get_size(pill, field, loc);
2129 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2130 "field size is %u\n", field->rmf_name, len);
2132 /* It's the dumping side-effect that we're interested in */
2133 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2136 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2142 void req_capsule_client_dump(struct req_capsule *pill)
2144 __req_capsule_dump(pill, RCL_CLIENT);
2146 EXPORT_SYMBOL(req_capsule_client_dump);
2151 void req_capsule_server_dump(struct req_capsule *pill)
2153 __req_capsule_dump(pill, RCL_SERVER);
2155 EXPORT_SYMBOL(req_capsule_server_dump);
2158 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2159 * buffer corresponding to the given RMF (\a field) of a \a pill.
2161 void *req_capsule_client_get(struct req_capsule *pill,
2162 const struct req_msg_field *field)
2164 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2166 EXPORT_SYMBOL(req_capsule_client_get);
2169 * Same as req_capsule_client_get(), but with a \a swabber argument.
2171 * Currently unused; will be removed when req_capsule_server_swab_get() is
2174 void *req_capsule_client_swab_get(struct req_capsule *pill,
2175 const struct req_msg_field *field,
2178 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2180 EXPORT_SYMBOL(req_capsule_client_swab_get);
2183 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2185 * First the \a pill's request \a field's size is set (\a rc_area) using
2186 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2189 void *req_capsule_client_sized_get(struct req_capsule *pill,
2190 const struct req_msg_field *field,
2193 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2194 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2196 EXPORT_SYMBOL(req_capsule_client_sized_get);
2199 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2200 * buffer corresponding to the given RMF (\a field) of a \a pill.
2202 void *req_capsule_server_get(struct req_capsule *pill,
2203 const struct req_msg_field *field)
2205 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2207 EXPORT_SYMBOL(req_capsule_server_get);
2210 * Same as req_capsule_server_get(), but with a \a swabber argument.
2212 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2213 * swabbing done outside this capsule abstraction.
2215 void *req_capsule_server_swab_get(struct req_capsule *pill,
2216 const struct req_msg_field *field,
2219 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2221 EXPORT_SYMBOL(req_capsule_server_swab_get);
2224 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2226 * First the \a pill's request \a field's size is set (\a rc_area) using
2227 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2230 void *req_capsule_server_sized_get(struct req_capsule *pill,
2231 const struct req_msg_field *field,
2234 req_capsule_set_size(pill, field, RCL_SERVER, len);
2235 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2237 EXPORT_SYMBOL(req_capsule_server_sized_get);
2239 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2240 const struct req_msg_field *field,
2241 __u32 len, void *swabber)
2243 req_capsule_set_size(pill, field, RCL_SERVER, len);
2244 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2246 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2249 * Returns the buffer of a \a pill corresponding to the given \a field from the
2250 * request (if the caller is executing on the server-side) or reply (if the
2251 * caller is executing on the client-side).
2253 * This function convienient for use is code that could be executed on the
2254 * client and server alike.
2256 const void *req_capsule_other_get(struct req_capsule *pill,
2257 const struct req_msg_field *field)
2259 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2261 EXPORT_SYMBOL(req_capsule_other_get);
2264 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2265 * field of the given \a pill.
2267 * This function must be used when constructing variable sized fields of a
2270 void req_capsule_set_size(struct req_capsule *pill,
2271 const struct req_msg_field *field,
2272 enum req_location loc, __u32 size)
2274 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2276 if ((size != (__u32)field->rmf_size) &&
2277 (field->rmf_size != -1) &&
2278 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2280 __u32 rmf_size = (__u32)field->rmf_size;
2281 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2282 (size % rmf_size != 0)) {
2283 CERROR("%s: array field size mismatch "
2284 "%u %% %u != 0 (%d)\n",
2285 field->rmf_name, size, rmf_size, loc);
2287 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2289 CERROR("%s: field size mismatch %u != %u (%d)\n",
2290 field->rmf_name, size, rmf_size, loc);
2295 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2297 EXPORT_SYMBOL(req_capsule_set_size);
2300 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2301 * for the given \a pill's given \a field.
2303 * NB: this function doesn't correspond with req_capsule_set_size(), which
2304 * actually sets the size in pill.rc_area[loc][offset], but this function
2305 * returns the message buflen[offset], maybe we should use another name.
2307 __u32 req_capsule_get_size(const struct req_capsule *pill,
2308 const struct req_msg_field *field,
2309 enum req_location loc)
2311 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2313 return lustre_msg_buflen(__req_msg(pill, loc),
2314 __req_capsule_offset(pill, field, loc));
2316 EXPORT_SYMBOL(req_capsule_get_size);
2319 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2320 * given \a pill's request or reply (\a loc) given the field size recorded in
2321 * the \a pill's rc_area.
2323 * See also req_capsule_set_size().
2325 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2327 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2328 pill->rc_fmt->rf_fields[loc].nr,
2329 pill->rc_area[loc]);
2333 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2334 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2335 * PTLRPC request or reply given only an RQF (\a fmt).
2337 * This function should not be used for formats which contain variable size
2340 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2341 enum req_location loc)
2347 * This function should probably LASSERT() that fmt has no fields with
2348 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2349 * elements in the array there will ultimately be, but then, we could
2350 * assume that there will be at least one element, and that's just what
2353 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2357 for (; i < fmt->rf_fields[loc].nr; ++i)
2358 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2359 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2365 * Changes the format of an RPC.
2367 * The pill must already have been initialized, which means that it already has
2368 * a request format. The new format \a fmt must be an extension of the pill's
2369 * old format. Specifically: the new format must have as many request and reply
2370 * fields as the old one, and all fields shared by the old and new format must
2371 * be at least as large in the new format.
2373 * The new format's fields may be of different "type" than the old format, but
2374 * only for fields that are "opaque" blobs: fields which have a) have no
2375 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2376 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2377 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2378 * according to the key field. When the value, according to the key, contains a
2379 * structure (or array thereof) to be swabbed, the format should be changed to
2380 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2383 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2388 const struct req_format *old;
2390 LASSERT(pill->rc_fmt != NULL);
2391 LASSERT(__req_format_is_sane(fmt));
2395 * Sanity checking...
2397 for (i = 0; i < RCL_NR; ++i) {
2398 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2399 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2400 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2402 /* "opaque" fields can be transmogrified */
2403 if (ofield->rmf_swabber == NULL &&
2404 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2405 (ofield->rmf_size == -1 ||
2406 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2408 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2411 * Last field in old format can be shorter than in new.
2413 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2414 FMT_FIELD(old, i, j)->rmf_size);
2419 EXPORT_SYMBOL(req_capsule_extend);
2422 * This function returns a non-zero value if the given \a field is present in
2423 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2426 int req_capsule_has_field(const struct req_capsule *pill,
2427 const struct req_msg_field *field,
2428 enum req_location loc)
2430 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2432 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2434 EXPORT_SYMBOL(req_capsule_has_field);
2437 * Returns a non-zero value if the given \a field is present in the given \a
2438 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2440 int req_capsule_field_present(const struct req_capsule *pill,
2441 const struct req_msg_field *field,
2442 enum req_location loc)
2446 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2447 LASSERT(req_capsule_has_field(pill, field, loc));
2449 offset = __req_capsule_offset(pill, field, loc);
2450 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2452 EXPORT_SYMBOL(req_capsule_field_present);
2455 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2456 * request or reply (\a loc).
2458 * This is not the opposite of req_capsule_extend().
2460 void req_capsule_shrink(struct req_capsule *pill,
2461 const struct req_msg_field *field,
2463 enum req_location loc)
2465 const struct req_format *fmt;
2466 struct lustre_msg *msg;
2471 LASSERT(fmt != NULL);
2472 LASSERT(__req_format_is_sane(fmt));
2473 LASSERT(req_capsule_has_field(pill, field, loc));
2474 LASSERT(req_capsule_field_present(pill, field, loc));
2476 offset = __req_capsule_offset(pill, field, loc);
2478 msg = __req_msg(pill, loc);
2479 len = lustre_msg_buflen(msg, offset);
2480 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2481 fmt->rf_name, field->rmf_name, len, newlen);
2483 if (loc == RCL_CLIENT)
2484 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2487 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2490 EXPORT_SYMBOL(req_capsule_shrink);
2492 int req_capsule_server_grow(struct req_capsule *pill,
2493 const struct req_msg_field *field,
2496 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2501 LASSERT(pill->rc_fmt != NULL);
2502 LASSERT(__req_format_is_sane(pill->rc_fmt));
2503 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2504 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2506 len = req_capsule_get_size(pill, field, RCL_SERVER);
2507 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2508 if ((__u32)pill->rc_req->rq_repbuf_len >=
2509 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2510 CERROR("Inplace repack might be done\n");
2512 pill->rc_req->rq_reply_state = NULL;
2513 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2514 rc = req_capsule_server_pack(pill);
2516 /* put old rs back, the caller will decide what to do */
2517 pill->rc_req->rq_reply_state = rs;
2520 nrs = pill->rc_req->rq_reply_state;
2521 /* Now we need only buffers, copy first chunk */
2522 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2523 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2524 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2525 memcpy(to, from, len);
2526 /* check if we have tail and copy it too */
2527 if (rs->rs_msg->lm_bufcount > offset + 1) {
2528 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2529 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2530 offset = rs->rs_msg->lm_bufcount - 1;
2531 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2532 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2533 memcpy(to, from, len);
2535 /* drop old reply if everything is fine */
2536 if (rs->rs_difficult) {
2540 nrs->rs_difficult = 1;
2541 nrs->rs_no_ack = rs->rs_no_ack;
2542 nrs->rs_convert_lock = rs->rs_convert_lock;
2543 for (i = 0; i < rs->rs_nlocks; i++) {
2544 nrs->rs_locks[i] = rs->rs_locks[i];
2545 nrs->rs_modes[i] = rs->rs_modes[i];
2549 rs->rs_difficult = 0;
2552 ptlrpc_rs_decref(rs);
2555 EXPORT_SYMBOL(req_capsule_server_grow);