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, 2016, 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 <lustre/lustre_idl.h>
51 #include <llog_swab.h>
52 #include <lustre_debug.h>
53 #include <lustre_swab.h>
54 #include <lustre_ver.h>
56 #include <obd_support.h>
58 /* struct ptlrpc_request, lustre_msg* */
59 #include <lustre_req_layout.h>
60 #include <lustre_acl.h>
63 * RQFs (see below) refer to two struct req_msg_field arrays describing the
64 * client request and server reply, respectively.
66 /* empty set of fields... for suitable definition of emptiness. */
67 static const struct req_msg_field *empty[] = {
71 static const struct req_msg_field *mgs_target_info_only[] = {
76 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
77 static const struct req_msg_field *mgs_set_info[] = {
83 static const struct req_msg_field *mgs_config_read_client[] = {
88 static const struct req_msg_field *mgs_config_read_server[] = {
93 static const struct req_msg_field *log_cancel_client[] = {
98 static const struct req_msg_field *mdt_body_only[] = {
103 static const struct req_msg_field *mdt_body_capa[] = {
109 static const struct req_msg_field *quotactl_only[] = {
114 static const struct req_msg_field *quota_body_only[] = {
119 static const struct req_msg_field *ldlm_intent_quota_client[] = {
126 static const struct req_msg_field *ldlm_intent_quota_server[] = {
133 static const struct req_msg_field *mdt_close_client[] = {
140 static const struct req_msg_field *mdt_intent_close_client[] = {
148 static const struct req_msg_field *obd_statfs_server[] = {
153 static const struct req_msg_field *seq_query_client[] = {
159 static const struct req_msg_field *seq_query_server[] = {
164 static const struct req_msg_field *fld_query_client[] = {
170 static const struct req_msg_field *fld_query_server[] = {
175 static const struct req_msg_field *fld_read_client[] = {
180 static const struct req_msg_field *fld_read_server[] = {
185 static const struct req_msg_field *mds_getattr_name_client[] = {
192 static const struct req_msg_field *mds_reint_client[] = {
197 static const struct req_msg_field *mds_reint_create_client[] = {
204 static const struct req_msg_field *mds_reint_create_slave_client[] = {
213 static const struct req_msg_field *mds_reint_create_acl_client[] = {
220 &RMF_FILE_SECCTX_NAME,
224 static const struct req_msg_field *mds_reint_create_sym_client[] = {
231 &RMF_FILE_SECCTX_NAME,
235 static const struct req_msg_field *mds_reint_open_client[] = {
242 &RMF_FILE_SECCTX_NAME,
246 static const struct req_msg_field *mds_reint_open_server[] = {
255 static const struct req_msg_field *mds_reint_unlink_client[] = {
263 static const struct req_msg_field *mds_reint_link_client[] = {
272 static const struct req_msg_field *mds_reint_rename_client[] = {
282 static const struct req_msg_field *mds_reint_migrate_client[] = {
294 static const struct req_msg_field *mds_last_unlink_server[] = {
303 static const struct req_msg_field *mds_reint_setattr_client[] = {
313 static const struct req_msg_field *mds_reint_setxattr_client[] = {
322 static const struct req_msg_field *mds_reint_setxattr_server[] = {
328 static const struct req_msg_field *mdt_swap_layouts[] = {
337 static const struct req_msg_field *obd_connect_client[] = {
345 static const struct req_msg_field *obd_connect_server[] = {
350 static const struct req_msg_field *obd_set_info_client[] = {
356 static const struct req_msg_field *ost_grant_shrink_client[] = {
362 static const struct req_msg_field *mds_getinfo_client[] = {
368 static const struct req_msg_field *mds_getinfo_server[] = {
373 static const struct req_msg_field *ldlm_enqueue_client[] = {
378 static const struct req_msg_field *ldlm_enqueue_server[] = {
383 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
389 static const struct req_msg_field *ldlm_cp_callback_client[] = {
395 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
401 static const struct req_msg_field *ldlm_gl_callback_server[] = {
406 static const struct req_msg_field *ldlm_intent_basic_client[] = {
412 static const struct req_msg_field *ldlm_intent_client[] = {
419 static const struct req_msg_field *ldlm_intent_server[] = {
427 static const struct req_msg_field *ldlm_intent_layout_client[] = {
432 &RMF_EADATA /* for new layout to be set up */
434 static const struct req_msg_field *ldlm_intent_open_server[] = {
444 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
448 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
453 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
462 static const struct req_msg_field *ldlm_intent_create_client[] = {
466 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
470 &RMF_FILE_SECCTX_NAME,
474 static const struct req_msg_field *ldlm_intent_open_client[] = {
478 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
483 &RMF_FILE_SECCTX_NAME,
487 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
491 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
496 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
504 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
509 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
515 static const struct req_msg_field *mds_get_root_client[] = {
521 static const struct req_msg_field *mds_getxattr_client[] = {
529 static const struct req_msg_field *mds_getxattr_server[] = {
535 static const struct req_msg_field *mds_getattr_server[] = {
544 static const struct req_msg_field *mds_setattr_server[] = {
553 static const struct req_msg_field *mds_update_client[] = {
555 &RMF_OUT_UPDATE_HEADER,
559 static const struct req_msg_field *mds_update_server[] = {
561 &RMF_OUT_UPDATE_REPLY,
564 static const struct req_msg_field *llog_origin_handle_create_client[] = {
570 static const struct req_msg_field *llogd_body_only[] = {
575 static const struct req_msg_field *llog_log_hdr_only[] = {
580 static const struct req_msg_field *llogd_conn_body_only[] = {
585 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
591 static const struct req_msg_field *obd_idx_read_client[] = {
596 static const struct req_msg_field *obd_idx_read_server[] = {
601 static const struct req_msg_field *ost_body_only[] = {
606 static const struct req_msg_field *ost_body_capa[] = {
612 static const struct req_msg_field *ost_destroy_client[] = {
620 static const struct req_msg_field *ost_brw_client[] = {
628 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_INTENT_CLOSE,
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,
775 &RQF_MDS_HSM_PROGRESS,
776 &RQF_MDS_HSM_CT_REGISTER,
777 &RQF_MDS_HSM_CT_UNREGISTER,
778 &RQF_MDS_HSM_STATE_GET,
779 &RQF_MDS_HSM_STATE_SET,
781 &RQF_MDS_HSM_REQUEST,
782 &RQF_MDS_SWAP_LAYOUTS,
796 &RQF_OST_SET_GRANT_INFO,
798 &RQF_OST_GET_INFO_LAST_ID,
799 &RQF_OST_GET_INFO_LAST_FID,
800 &RQF_OST_SET_INFO_LAST_FID,
801 &RQF_OST_GET_INFO_FIEMAP,
804 &RQF_LDLM_ENQUEUE_LVB,
808 &RQF_LDLM_CP_CALLBACK,
809 &RQF_LDLM_BL_CALLBACK,
810 &RQF_LDLM_GL_CALLBACK,
811 &RQF_LDLM_GL_DESC_CALLBACK,
813 &RQF_LDLM_INTENT_BASIC,
814 &RQF_LDLM_INTENT_LAYOUT,
815 &RQF_LDLM_INTENT_GETATTR,
816 &RQF_LDLM_INTENT_OPEN,
817 &RQF_LDLM_INTENT_CREATE,
818 &RQF_LDLM_INTENT_UNLINK,
819 &RQF_LDLM_INTENT_GETXATTR,
820 &RQF_LDLM_INTENT_QUOTA,
823 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
824 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
825 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
826 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
827 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
828 &RQF_LLOG_ORIGIN_CONNECT,
834 struct req_msg_field {
835 const __u32 rmf_flags;
836 const char *rmf_name;
838 * Field length. (-1) means "variable length". If the
839 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
840 * but the actual size must be a whole multiple of \a rmf_size.
843 void (*rmf_swabber)(void *);
844 void (*rmf_dumper)(void *);
845 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
850 * The field is a string, must be NUL-terminated.
852 RMF_F_STRING = 1 << 0,
854 * The field's buffer size need not match the declared \a rmf_size.
856 RMF_F_NO_SIZE_CHECK = 1 << 1,
858 * The field's buffer size must be a whole multiple of the declared \a
859 * rmf_size and the \a rmf_swabber function must work on the declared \a
860 * rmf_size worth of bytes.
862 RMF_F_STRUCT_ARRAY = 1 << 2
870 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
871 .rmf_name = (name), \
872 .rmf_flags = (flags), \
873 .rmf_size = (size), \
874 .rmf_swabber = (void (*)(void*))(swabber), \
875 .rmf_dumper = (void (*)(void*))(dumper) \
878 struct req_msg_field RMF_GENERIC_DATA =
879 DEFINE_MSGF("generic_data", 0,
881 EXPORT_SYMBOL(RMF_GENERIC_DATA);
883 struct req_msg_field RMF_MGS_TARGET_INFO =
884 DEFINE_MSGF("mgs_target_info", 0,
885 sizeof(struct mgs_target_info),
886 lustre_swab_mgs_target_info, NULL);
887 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
889 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
890 struct req_msg_field RMF_MGS_SEND_PARAM =
891 DEFINE_MSGF("mgs_send_param", 0,
892 sizeof(struct mgs_send_param),
894 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
897 struct req_msg_field RMF_MGS_CONFIG_BODY =
898 DEFINE_MSGF("mgs_config_read request", 0,
899 sizeof(struct mgs_config_body),
900 lustre_swab_mgs_config_body, NULL);
901 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
903 struct req_msg_field RMF_MGS_CONFIG_RES =
904 DEFINE_MSGF("mgs_config_read reply ", 0,
905 sizeof(struct mgs_config_res),
906 lustre_swab_mgs_config_res, NULL);
907 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
909 struct req_msg_field RMF_U32 =
910 DEFINE_MSGF("generic u32", 0,
911 sizeof(__u32), lustre_swab_generic_32s, NULL);
912 EXPORT_SYMBOL(RMF_U32);
914 struct req_msg_field RMF_SETINFO_VAL =
915 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
916 EXPORT_SYMBOL(RMF_SETINFO_VAL);
918 struct req_msg_field RMF_GETINFO_KEY =
919 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
920 EXPORT_SYMBOL(RMF_GETINFO_KEY);
922 struct req_msg_field RMF_GETINFO_VALLEN =
923 DEFINE_MSGF("getinfo_vallen", 0,
924 sizeof(__u32), lustre_swab_generic_32s, NULL);
925 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
927 struct req_msg_field RMF_GETINFO_VAL =
928 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
929 EXPORT_SYMBOL(RMF_GETINFO_VAL);
931 struct req_msg_field RMF_SEQ_OPC =
932 DEFINE_MSGF("seq_query_opc", 0,
933 sizeof(__u32), lustre_swab_generic_32s, NULL);
934 EXPORT_SYMBOL(RMF_SEQ_OPC);
936 struct req_msg_field RMF_SEQ_RANGE =
937 DEFINE_MSGF("seq_query_range", 0,
938 sizeof(struct lu_seq_range),
939 lustre_swab_lu_seq_range, NULL);
940 EXPORT_SYMBOL(RMF_SEQ_RANGE);
942 struct req_msg_field RMF_FLD_OPC =
943 DEFINE_MSGF("fld_query_opc", 0,
944 sizeof(__u32), lustre_swab_generic_32s, NULL);
945 EXPORT_SYMBOL(RMF_FLD_OPC);
947 struct req_msg_field RMF_FLD_MDFLD =
948 DEFINE_MSGF("fld_query_mdfld", 0,
949 sizeof(struct lu_seq_range),
950 lustre_swab_lu_seq_range, NULL);
951 EXPORT_SYMBOL(RMF_FLD_MDFLD);
953 struct req_msg_field RMF_MDT_BODY =
954 DEFINE_MSGF("mdt_body", 0,
955 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
956 EXPORT_SYMBOL(RMF_MDT_BODY);
958 struct req_msg_field RMF_OBD_QUOTACTL =
959 DEFINE_MSGF("obd_quotactl", 0,
960 sizeof(struct obd_quotactl),
961 lustre_swab_obd_quotactl, NULL);
962 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
964 struct req_msg_field RMF_QUOTA_BODY =
965 DEFINE_MSGF("quota_body", 0,
966 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
967 EXPORT_SYMBOL(RMF_QUOTA_BODY);
969 struct req_msg_field RMF_MDT_EPOCH =
970 DEFINE_MSGF("mdt_ioepoch", 0,
971 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
972 EXPORT_SYMBOL(RMF_MDT_EPOCH);
974 struct req_msg_field RMF_PTLRPC_BODY =
975 DEFINE_MSGF("ptlrpc_body", 0,
976 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
977 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
979 struct req_msg_field RMF_CLOSE_DATA =
980 DEFINE_MSGF("data_version", 0,
981 sizeof(struct close_data), lustre_swab_close_data, NULL);
982 EXPORT_SYMBOL(RMF_CLOSE_DATA);
984 struct req_msg_field RMF_OBD_STATFS =
985 DEFINE_MSGF("obd_statfs", 0,
986 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
987 EXPORT_SYMBOL(RMF_OBD_STATFS);
989 struct req_msg_field RMF_SETINFO_KEY =
990 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
991 EXPORT_SYMBOL(RMF_SETINFO_KEY);
993 struct req_msg_field RMF_NAME =
994 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
995 EXPORT_SYMBOL(RMF_NAME);
997 struct req_msg_field RMF_SYMTGT =
998 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
999 EXPORT_SYMBOL(RMF_SYMTGT);
1001 struct req_msg_field RMF_TGTUUID =
1002 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1004 EXPORT_SYMBOL(RMF_TGTUUID);
1006 struct req_msg_field RMF_CLUUID =
1007 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1009 EXPORT_SYMBOL(RMF_CLUUID);
1011 struct req_msg_field RMF_STRING =
1012 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1013 EXPORT_SYMBOL(RMF_STRING);
1015 struct req_msg_field RMF_FILE_SECCTX_NAME =
1016 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1017 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1019 struct req_msg_field RMF_FILE_SECCTX =
1020 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1021 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1023 struct req_msg_field RMF_LLOGD_BODY =
1024 DEFINE_MSGF("llogd_body", 0,
1025 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1026 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1028 struct req_msg_field RMF_LLOG_LOG_HDR =
1029 DEFINE_MSGF("llog_log_hdr", 0,
1030 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1031 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1033 struct req_msg_field RMF_LLOGD_CONN_BODY =
1034 DEFINE_MSGF("llogd_conn_body", 0,
1035 sizeof(struct llogd_conn_body),
1036 lustre_swab_llogd_conn_body, NULL);
1037 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1040 * connection handle received in MDS_CONNECT request.
1042 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1043 * that the client does not interpret at all.
1045 struct req_msg_field RMF_CONN =
1046 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1047 EXPORT_SYMBOL(RMF_CONN);
1049 struct req_msg_field RMF_CONNECT_DATA =
1050 DEFINE_MSGF("cdata",
1051 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1052 sizeof(struct obd_connect_data),
1053 lustre_swab_connect, NULL);
1054 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1056 struct req_msg_field RMF_DLM_REQ =
1057 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1058 sizeof(struct ldlm_request),
1059 lustre_swab_ldlm_request, NULL);
1060 EXPORT_SYMBOL(RMF_DLM_REQ);
1062 struct req_msg_field RMF_DLM_REP =
1063 DEFINE_MSGF("dlm_rep", 0,
1064 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1065 EXPORT_SYMBOL(RMF_DLM_REP);
1067 struct req_msg_field RMF_LDLM_INTENT =
1068 DEFINE_MSGF("ldlm_intent", 0,
1069 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1070 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1072 struct req_msg_field RMF_DLM_LVB =
1073 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1074 EXPORT_SYMBOL(RMF_DLM_LVB);
1076 struct req_msg_field RMF_DLM_GL_DESC =
1077 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1078 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1080 struct req_msg_field RMF_MDT_MD =
1081 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1082 EXPORT_SYMBOL(RMF_MDT_MD);
1084 struct req_msg_field RMF_REC_REINT =
1085 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1086 lustre_swab_mdt_rec_reint, NULL);
1087 EXPORT_SYMBOL(RMF_REC_REINT);
1089 /* FIXME: this length should be defined as a macro */
1090 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1092 EXPORT_SYMBOL(RMF_EADATA);
1094 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1095 EXPORT_SYMBOL(RMF_EAVALS);
1097 struct req_msg_field RMF_ACL =
1098 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1099 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1100 EXPORT_SYMBOL(RMF_ACL);
1102 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1103 struct req_msg_field RMF_LOGCOOKIES =
1104 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1105 sizeof(struct llog_cookie), NULL, NULL);
1106 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1108 struct req_msg_field RMF_CAPA1 =
1109 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1110 lustre_swab_lustre_capa, NULL);
1111 EXPORT_SYMBOL(RMF_CAPA1);
1113 struct req_msg_field RMF_CAPA2 =
1114 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1115 lustre_swab_lustre_capa, NULL);
1116 EXPORT_SYMBOL(RMF_CAPA2);
1118 struct req_msg_field RMF_LAYOUT_INTENT =
1119 DEFINE_MSGF("layout_intent", 0,
1120 sizeof(struct layout_intent), lustre_swab_layout_intent,
1122 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1125 * OST request field.
1127 struct req_msg_field RMF_OST_BODY =
1128 DEFINE_MSGF("ost_body", 0,
1129 sizeof(struct ost_body), lustre_swab_ost_body,
1131 EXPORT_SYMBOL(RMF_OST_BODY);
1133 struct req_msg_field RMF_OBD_IOOBJ =
1134 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1135 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1136 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1138 struct req_msg_field RMF_NIOBUF_REMOTE =
1139 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1140 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1142 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1144 struct req_msg_field RMF_RCS =
1145 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1146 lustre_swab_generic_32s, dump_rcs);
1147 EXPORT_SYMBOL(RMF_RCS);
1149 struct req_msg_field RMF_EAVALS_LENS =
1150 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1151 lustre_swab_generic_32s, NULL);
1152 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1154 struct req_msg_field RMF_OBD_ID =
1155 DEFINE_MSGF("obd_id", 0,
1156 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1157 EXPORT_SYMBOL(RMF_OBD_ID);
1159 struct req_msg_field RMF_FID =
1160 DEFINE_MSGF("fid", 0,
1161 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1162 EXPORT_SYMBOL(RMF_FID);
1164 struct req_msg_field RMF_OST_ID =
1165 DEFINE_MSGF("ost_id", 0,
1166 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1167 EXPORT_SYMBOL(RMF_OST_ID);
1169 struct req_msg_field RMF_FIEMAP_KEY =
1170 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1171 lustre_swab_fiemap, NULL);
1172 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1174 struct req_msg_field RMF_FIEMAP_VAL =
1175 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1176 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1178 struct req_msg_field RMF_IDX_INFO =
1179 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1180 lustre_swab_idx_info, NULL);
1181 EXPORT_SYMBOL(RMF_IDX_INFO);
1182 struct req_msg_field RMF_HSM_USER_STATE =
1183 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1184 lustre_swab_hsm_user_state, NULL);
1185 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1187 struct req_msg_field RMF_HSM_STATE_SET =
1188 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1189 lustre_swab_hsm_state_set, NULL);
1190 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1192 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1193 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1194 lustre_swab_hsm_progress_kernel, NULL);
1195 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1197 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1198 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1199 lustre_swab_hsm_current_action, NULL);
1200 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1202 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1203 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1204 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1206 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1208 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1209 DEFINE_MSGF("hsm_archive", 0,
1210 sizeof(__u32), lustre_swab_generic_32s, NULL);
1211 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1213 struct req_msg_field RMF_MDS_HSM_REQUEST =
1214 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1215 lustre_swab_hsm_request, NULL);
1216 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1218 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1219 lustre_swab_object_update_request, NULL);
1220 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1222 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1223 DEFINE_MSGF("object_update_reply", 0, -1,
1224 lustre_swab_object_update_reply, NULL);
1225 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1227 struct req_msg_field RMF_SWAP_LAYOUTS =
1228 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1229 lustre_swab_swap_layouts, NULL);
1230 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1232 struct req_msg_field RMF_LFSCK_REQUEST =
1233 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1234 lustre_swab_lfsck_request, NULL);
1235 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1237 struct req_msg_field RMF_LFSCK_REPLY =
1238 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1239 lustre_swab_lfsck_reply, NULL);
1240 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1242 struct req_msg_field RMF_OST_LADVISE_HDR =
1243 DEFINE_MSGF("ladvise_request", 0,
1244 sizeof(struct ladvise_hdr),
1245 lustre_swab_ladvise_hdr, NULL);
1246 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1248 struct req_msg_field RMF_OST_LADVISE =
1249 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1250 sizeof(struct lu_ladvise),
1251 lustre_swab_ladvise, NULL);
1252 EXPORT_SYMBOL(RMF_OST_LADVISE);
1254 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1255 -1, lustre_swab_out_update_header, NULL);
1256 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1258 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1259 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1260 lustre_swab_out_update_buffer, NULL);
1261 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1268 const char *rf_name;
1272 const struct req_msg_field **d;
1273 } rf_fields[RCL_NR];
1276 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1290 #define DEFINE_REQ_FMT0(name, client, server) \
1291 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1293 struct req_format RQF_OBD_PING =
1294 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1295 EXPORT_SYMBOL(RQF_OBD_PING);
1297 struct req_format RQF_OBD_SET_INFO =
1298 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1299 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1301 /* Read index file through the network */
1302 struct req_format RQF_OBD_IDX_READ =
1303 DEFINE_REQ_FMT0("OBD_IDX_READ",
1304 obd_idx_read_client, obd_idx_read_server);
1305 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1307 struct req_format RQF_SEC_CTX =
1308 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1309 EXPORT_SYMBOL(RQF_SEC_CTX);
1311 struct req_format RQF_MGS_TARGET_REG =
1312 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1313 mgs_target_info_only);
1314 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1316 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1317 struct req_format RQF_MGS_SET_INFO =
1318 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1320 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1323 struct req_format RQF_MGS_CONFIG_READ =
1324 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1325 mgs_config_read_server);
1326 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1328 struct req_format RQF_SEQ_QUERY =
1329 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1330 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1332 struct req_format RQF_FLD_QUERY =
1333 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1334 EXPORT_SYMBOL(RQF_FLD_QUERY);
1336 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1337 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1338 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1339 * peers need to handle the RPC reply with fixed little-endian format.
1341 * In theory, we can define new structure with some swabber registered to
1342 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1343 * implementation view, it is not easy to be done within current "struct
1344 * req_msg_field" framework. Because the sequence range array in the RPC
1345 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1346 * count, that is unknown when prepare the RPC buffer. Generally, for such
1347 * flexible length RPC usage, there will be a field in the RPC layout to
1348 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1349 * do that unless we add new length filed that will broken the on-wire RPC
1350 * protocol and cause interoperability trouble with old peer. */
1351 struct req_format RQF_FLD_READ =
1352 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1353 EXPORT_SYMBOL(RQF_FLD_READ);
1355 struct req_format RQF_LOG_CANCEL =
1356 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1357 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1359 struct req_format RQF_MDS_QUOTACTL =
1360 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1361 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1363 struct req_format RQF_OST_QUOTACTL =
1364 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1365 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1367 struct req_format RQF_QUOTA_DQACQ =
1368 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1369 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1371 struct req_format RQF_LDLM_INTENT_QUOTA =
1372 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1373 ldlm_intent_quota_client,
1374 ldlm_intent_quota_server);
1375 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1377 struct req_format RQF_MDS_GET_ROOT =
1378 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1379 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1381 struct req_format RQF_MDS_STATFS =
1382 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1383 EXPORT_SYMBOL(RQF_MDS_STATFS);
1385 struct req_format RQF_MDS_SYNC =
1386 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1387 EXPORT_SYMBOL(RQF_MDS_SYNC);
1389 struct req_format RQF_MDS_GETATTR =
1390 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1391 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1393 struct req_format RQF_MDS_GETXATTR =
1394 DEFINE_REQ_FMT0("MDS_GETXATTR",
1395 mds_getxattr_client, mds_getxattr_server);
1396 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1398 struct req_format RQF_MDS_GETATTR_NAME =
1399 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1400 mds_getattr_name_client, mds_getattr_server);
1401 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1403 struct req_format RQF_MDS_REINT =
1404 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1405 EXPORT_SYMBOL(RQF_MDS_REINT);
1407 struct req_format RQF_MDS_REINT_CREATE =
1408 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1409 mds_reint_create_client, mdt_body_capa);
1410 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1412 struct req_format RQF_MDS_REINT_CREATE_ACL =
1413 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1414 mds_reint_create_acl_client, mdt_body_capa);
1415 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1417 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1418 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1419 mds_reint_create_slave_client, mdt_body_capa);
1420 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1422 struct req_format RQF_MDS_REINT_CREATE_SYM =
1423 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1424 mds_reint_create_sym_client, mdt_body_capa);
1425 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1427 struct req_format RQF_MDS_REINT_OPEN =
1428 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1429 mds_reint_open_client, mds_reint_open_server);
1430 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1432 struct req_format RQF_MDS_REINT_UNLINK =
1433 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1434 mds_last_unlink_server);
1435 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1437 struct req_format RQF_MDS_REINT_LINK =
1438 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1439 mds_reint_link_client, mdt_body_only);
1440 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1442 struct req_format RQF_MDS_REINT_RENAME =
1443 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1444 mds_last_unlink_server);
1445 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1447 struct req_format RQF_MDS_REINT_MIGRATE =
1448 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1449 mds_last_unlink_server);
1450 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1452 struct req_format RQF_MDS_REINT_SETATTR =
1453 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1454 mds_reint_setattr_client, mds_setattr_server);
1455 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1457 struct req_format RQF_MDS_REINT_SETXATTR =
1458 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1459 mds_reint_setxattr_client, mds_reint_setxattr_server);
1460 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1462 struct req_format RQF_MDS_CONNECT =
1463 DEFINE_REQ_FMT0("MDS_CONNECT",
1464 obd_connect_client, obd_connect_server);
1465 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1467 struct req_format RQF_MDS_DISCONNECT =
1468 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1469 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1471 struct req_format RQF_MDS_GET_INFO =
1472 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1473 mds_getinfo_server);
1474 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1476 struct req_format RQF_OUT_UPDATE =
1477 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1479 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1481 struct req_format RQF_LDLM_ENQUEUE =
1482 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1483 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1484 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1486 struct req_format RQF_LDLM_ENQUEUE_LVB =
1487 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1488 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1489 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1491 struct req_format RQF_LDLM_CONVERT =
1492 DEFINE_REQ_FMT0("LDLM_CONVERT",
1493 ldlm_enqueue_client, ldlm_enqueue_server);
1494 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1496 struct req_format RQF_LDLM_CANCEL =
1497 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1498 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1500 struct req_format RQF_LDLM_CALLBACK =
1501 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1502 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1504 struct req_format RQF_LDLM_CP_CALLBACK =
1505 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1506 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1508 struct req_format RQF_LDLM_BL_CALLBACK =
1509 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1510 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1512 struct req_format RQF_LDLM_GL_CALLBACK =
1513 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1514 ldlm_gl_callback_server);
1515 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1517 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1518 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1519 ldlm_gl_callback_server);
1520 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1522 struct req_format RQF_LDLM_INTENT_BASIC =
1523 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1524 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1525 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1527 struct req_format RQF_LDLM_INTENT =
1528 DEFINE_REQ_FMT0("LDLM_INTENT",
1529 ldlm_intent_client, ldlm_intent_server);
1530 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1532 struct req_format RQF_LDLM_INTENT_LAYOUT =
1533 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1534 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1535 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1537 struct req_format RQF_LDLM_INTENT_GETATTR =
1538 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1539 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1540 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1542 struct req_format RQF_LDLM_INTENT_OPEN =
1543 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1544 ldlm_intent_open_client, ldlm_intent_open_server);
1545 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1547 struct req_format RQF_LDLM_INTENT_CREATE =
1548 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1549 ldlm_intent_create_client, ldlm_intent_getattr_server);
1550 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1552 struct req_format RQF_LDLM_INTENT_UNLINK =
1553 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1554 ldlm_intent_unlink_client, ldlm_intent_server);
1555 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1557 struct req_format RQF_LDLM_INTENT_GETXATTR =
1558 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1559 ldlm_intent_getxattr_client,
1560 ldlm_intent_getxattr_server);
1561 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1563 struct req_format RQF_MDS_CLOSE =
1564 DEFINE_REQ_FMT0("MDS_CLOSE",
1565 mdt_close_client, mds_last_unlink_server);
1566 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1568 struct req_format RQF_MDS_INTENT_CLOSE =
1569 DEFINE_REQ_FMT0("MDS_CLOSE",
1570 mdt_intent_close_client, mds_last_unlink_server);
1571 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1573 struct req_format RQF_MDS_READPAGE =
1574 DEFINE_REQ_FMT0("MDS_READPAGE",
1575 mdt_body_capa, mdt_body_only);
1576 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1578 struct req_format RQF_MDS_HSM_ACTION =
1579 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1580 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1582 struct req_format RQF_MDS_HSM_PROGRESS =
1583 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1584 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1586 struct req_format RQF_MDS_HSM_CT_REGISTER =
1587 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1588 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1590 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1591 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1592 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1594 struct req_format RQF_MDS_HSM_STATE_GET =
1595 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1596 mdt_body_capa, mdt_hsm_state_get_server);
1597 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1599 struct req_format RQF_MDS_HSM_STATE_SET =
1600 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1601 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1603 struct req_format RQF_MDS_HSM_REQUEST =
1604 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1605 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1607 struct req_format RQF_MDS_SWAP_LAYOUTS =
1608 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1609 mdt_swap_layouts, empty);
1610 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1612 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1613 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1614 llog_origin_handle_create_client, llogd_body_only);
1615 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1617 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1618 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1619 llogd_body_only, llogd_body_only);
1620 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1622 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1623 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1624 llogd_body_only, llog_origin_handle_next_block_server);
1625 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1627 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1628 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1629 llogd_body_only, llog_origin_handle_next_block_server);
1630 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1632 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1633 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1634 llogd_body_only, llog_log_hdr_only);
1635 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1637 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1638 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1639 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1641 struct req_format RQF_CONNECT =
1642 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1643 EXPORT_SYMBOL(RQF_CONNECT);
1645 struct req_format RQF_OST_CONNECT =
1646 DEFINE_REQ_FMT0("OST_CONNECT",
1647 obd_connect_client, obd_connect_server);
1648 EXPORT_SYMBOL(RQF_OST_CONNECT);
1650 struct req_format RQF_OST_DISCONNECT =
1651 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1652 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1654 struct req_format RQF_OST_GETATTR =
1655 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1656 EXPORT_SYMBOL(RQF_OST_GETATTR);
1658 struct req_format RQF_OST_SETATTR =
1659 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1660 EXPORT_SYMBOL(RQF_OST_SETATTR);
1662 struct req_format RQF_OST_CREATE =
1663 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1664 EXPORT_SYMBOL(RQF_OST_CREATE);
1666 struct req_format RQF_OST_PUNCH =
1667 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1668 EXPORT_SYMBOL(RQF_OST_PUNCH);
1670 struct req_format RQF_OST_SYNC =
1671 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1672 EXPORT_SYMBOL(RQF_OST_SYNC);
1674 struct req_format RQF_OST_DESTROY =
1675 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1676 EXPORT_SYMBOL(RQF_OST_DESTROY);
1678 struct req_format RQF_OST_BRW_READ =
1679 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1680 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1682 struct req_format RQF_OST_BRW_WRITE =
1683 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1684 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1686 struct req_format RQF_OST_STATFS =
1687 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1688 EXPORT_SYMBOL(RQF_OST_STATFS);
1690 struct req_format RQF_OST_SET_GRANT_INFO =
1691 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1693 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1695 struct req_format RQF_OST_GET_INFO =
1696 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1697 ost_get_info_generic_server);
1698 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1700 struct req_format RQF_OST_GET_INFO_LAST_ID =
1701 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1702 ost_get_last_id_server);
1703 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1705 struct req_format RQF_OST_GET_INFO_LAST_FID =
1706 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1707 ost_get_last_fid_server);
1708 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1710 struct req_format RQF_OST_SET_INFO_LAST_FID =
1711 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1713 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1715 struct req_format RQF_OST_GET_INFO_FIEMAP =
1716 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1717 ost_get_fiemap_server);
1718 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1720 struct req_format RQF_LFSCK_NOTIFY =
1721 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1722 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1724 struct req_format RQF_LFSCK_QUERY =
1725 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1726 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1728 struct req_format RQF_OST_LADVISE =
1729 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1730 EXPORT_SYMBOL(RQF_OST_LADVISE);
1732 /* Convenience macro */
1733 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1736 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1737 * field of RQFs and the \a rmf_offset field of RMFs.
1739 int req_layout_init(void)
1744 struct req_format *rf = NULL;
1746 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1747 rf = req_formats[i];
1749 for (j = 0; j < RCL_NR; ++j) {
1750 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1751 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1752 struct req_msg_field *field;
1754 field = (typeof(field))rf->rf_fields[j].d[k];
1755 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1756 || field->rmf_size > 0);
1757 LASSERT(field->rmf_offset[i][j] == 0);
1759 * k + 1 to detect unused format/field
1762 field->rmf_offset[i][j] = k + 1;
1768 EXPORT_SYMBOL(req_layout_init);
1770 void req_layout_fini(void)
1773 EXPORT_SYMBOL(req_layout_fini);
1776 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1778 * Actual/expected field sizes are set elsewhere in functions in this file:
1779 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1780 * req_capsule_msg_size(). The \a rc_area information is used by.
1781 * ptlrpc_request_set_replen().
1783 void req_capsule_init_area(struct req_capsule *pill)
1787 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1788 pill->rc_area[RCL_CLIENT][i] = -1;
1789 pill->rc_area[RCL_SERVER][i] = -1;
1792 EXPORT_SYMBOL(req_capsule_init_area);
1795 * Initialize a pill.
1797 * The \a location indicates whether the caller is executing on the client side
1798 * (RCL_CLIENT) or server side (RCL_SERVER)..
1800 void req_capsule_init(struct req_capsule *pill,
1801 struct ptlrpc_request *req,
1802 enum req_location location)
1804 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1807 * Today all capsules are embedded in ptlrpc_request structs,
1808 * but just in case that ever isn't the case, we don't reach
1809 * into req unless req != NULL and pill is the one embedded in
1812 * The req->rq_pill_init flag makes it safe to initialize a pill
1813 * twice, which might happen in the OST paths as a result of the
1814 * high-priority RPC queue getting peeked at before ost_handle()
1815 * handles an OST RPC.
1817 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1820 memset(pill, 0, sizeof *pill);
1822 pill->rc_loc = location;
1823 req_capsule_init_area(pill);
1825 if (req != NULL && pill == &req->rq_pill)
1826 req->rq_pill_init = 1;
1828 EXPORT_SYMBOL(req_capsule_init);
1830 void req_capsule_fini(struct req_capsule *pill)
1833 EXPORT_SYMBOL(req_capsule_fini);
1835 static int __req_format_is_sane(const struct req_format *fmt)
1837 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1838 req_formats[fmt->rf_idx] == fmt;
1841 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1842 enum req_location loc)
1844 struct ptlrpc_request *req;
1847 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1851 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1852 * (see req_capsule_extend()).
1854 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1856 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1857 LASSERT(__req_format_is_sane(fmt));
1861 EXPORT_SYMBOL(req_capsule_set);
1864 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1867 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1868 * variable-sized fields. The field sizes come from the declared \a rmf_size
1869 * field of a \a pill's \a rc_fmt's RMF's.
1871 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1872 enum req_location loc)
1874 const struct req_format *fmt = pill->rc_fmt;
1877 LASSERT(fmt != NULL);
1879 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1880 if (pill->rc_area[loc][i] == -1) {
1881 pill->rc_area[loc][i] =
1882 fmt->rf_fields[loc].d[i]->rmf_size;
1883 if (pill->rc_area[loc][i] == -1) {
1885 * Skip the following fields.
1887 * If this LASSERT() trips then you're missing a
1888 * call to req_capsule_set_size().
1890 LASSERT(loc != RCL_SERVER);
1897 EXPORT_SYMBOL(req_capsule_filled_sizes);
1900 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1902 * This function uses the \a pill's \a rc_area as filled in by
1903 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1906 int req_capsule_server_pack(struct req_capsule *pill)
1908 const struct req_format *fmt;
1912 LASSERT(pill->rc_loc == RCL_SERVER);
1914 LASSERT(fmt != NULL);
1916 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1917 rc = lustre_pack_reply(pill->rc_req, count,
1918 pill->rc_area[RCL_SERVER], NULL);
1920 DEBUG_REQ(D_ERROR, pill->rc_req,
1921 "Cannot pack %d fields in format `%s': ",
1922 count, fmt->rf_name);
1926 EXPORT_SYMBOL(req_capsule_server_pack);
1929 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1930 * corresponding to the given RMF (\a field).
1932 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1933 const struct req_msg_field *field,
1934 enum req_location loc)
1936 unsigned int offset;
1938 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1939 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1940 pill->rc_fmt->rf_name,
1941 field->rmf_name, offset, loc);
1944 LASSERT(offset < REQ_MAX_FIELD_NR);
1949 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1954 swabber_dumper_helper(struct req_capsule *pill,
1955 const struct req_msg_field *field,
1956 enum req_location loc,
1958 void *value, int len, int dump, void (*swabber)( void *))
1964 int inout = loc == RCL_CLIENT;
1966 swabber = swabber ?: field->rmf_swabber;
1968 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1969 swabber != NULL && value != NULL)
1974 if (!field->rmf_dumper)
1977 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1979 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1980 do_swab ? "unswabbed " : "", field->rmf_name);
1981 field->rmf_dumper(value);
1986 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1988 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1989 "follows\n", field->rmf_name);
1990 field->rmf_dumper(value);
1997 * We're swabbing an array; swabber() swabs a single array element, so
1998 * swab every element.
2000 LASSERT((len % field->rmf_size) == 0);
2001 for (p = value, i = 0, n = len / field->rmf_size;
2003 i++, p += field->rmf_size) {
2005 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2006 "element %d follows\n",
2007 do_swab ? "unswabbed " : "", field->rmf_name, i);
2008 field->rmf_dumper(p);
2014 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2015 "element %d follows\n", field->rmf_name, i);
2016 field->rmf_dumper(value);
2020 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2024 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2025 * corresponding to the given RMF (\a field).
2027 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2028 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2029 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2030 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2031 * element of the array swabbed.
2033 static void *__req_capsule_get(struct req_capsule *pill,
2034 const struct req_msg_field *field,
2035 enum req_location loc,
2036 void (*swabber)( void *),
2039 const struct req_format *fmt;
2040 struct lustre_msg *msg;
2045 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2047 static const char *rcl_names[RCL_NR] = {
2048 [RCL_CLIENT] = "client",
2049 [RCL_SERVER] = "server"
2052 LASSERT(pill != NULL);
2053 LASSERT(pill != LP_POISON);
2055 LASSERT(fmt != NULL);
2056 LASSERT(fmt != LP_POISON);
2057 LASSERT(__req_format_is_sane(fmt));
2059 offset = __req_capsule_offset(pill, field, loc);
2061 msg = __req_msg(pill, loc);
2062 LASSERT(msg != NULL);
2064 getter = (field->rmf_flags & RMF_F_STRING) ?
2065 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2067 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2069 * We've already asserted that field->rmf_size > 0 in
2070 * req_layout_init().
2072 len = lustre_msg_buflen(msg, offset);
2073 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2074 (len % field->rmf_size) != 0) {
2075 CERROR("%s: array field size mismatch "
2076 "%d modulo %u != 0 (%d)\n",
2077 field->rmf_name, len, field->rmf_size, loc);
2080 } else if (pill->rc_area[loc][offset] != -1) {
2081 len = pill->rc_area[loc][offset];
2083 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2085 value = getter(msg, offset, len);
2087 if (value == NULL) {
2088 DEBUG_REQ(D_ERROR, pill->rc_req,
2089 "Wrong buffer for field `%s' (%u of %u) "
2090 "in format `%s': %u vs. %u (%s)\n",
2091 field->rmf_name, offset, lustre_msg_bufcount(msg),
2092 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2095 swabber_dumper_helper(pill, field, loc, offset, value, len,
2103 * Dump a request and/or reply
2105 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2107 const struct req_format *fmt;
2108 const struct req_msg_field *field;
2114 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2115 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2116 field = FMT_FIELD(fmt, loc, i);
2117 if (field->rmf_dumper == NULL) {
2119 * FIXME Add a default hex dumper for fields that don't
2120 * have a specific dumper
2122 len = req_capsule_get_size(pill, field, loc);
2123 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2124 "field size is %u\n", field->rmf_name, len);
2126 /* It's the dumping side-effect that we're interested in */
2127 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2130 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2136 void req_capsule_client_dump(struct req_capsule *pill)
2138 __req_capsule_dump(pill, RCL_CLIENT);
2140 EXPORT_SYMBOL(req_capsule_client_dump);
2145 void req_capsule_server_dump(struct req_capsule *pill)
2147 __req_capsule_dump(pill, RCL_SERVER);
2149 EXPORT_SYMBOL(req_capsule_server_dump);
2152 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2153 * buffer corresponding to the given RMF (\a field) of a \a pill.
2155 void *req_capsule_client_get(struct req_capsule *pill,
2156 const struct req_msg_field *field)
2158 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2160 EXPORT_SYMBOL(req_capsule_client_get);
2163 * Same as req_capsule_client_get(), but with a \a swabber argument.
2165 * Currently unused; will be removed when req_capsule_server_swab_get() is
2168 void *req_capsule_client_swab_get(struct req_capsule *pill,
2169 const struct req_msg_field *field,
2172 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2174 EXPORT_SYMBOL(req_capsule_client_swab_get);
2177 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2179 * First the \a pill's request \a field's size is set (\a rc_area) using
2180 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2183 void *req_capsule_client_sized_get(struct req_capsule *pill,
2184 const struct req_msg_field *field,
2187 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2188 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2190 EXPORT_SYMBOL(req_capsule_client_sized_get);
2193 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2194 * buffer corresponding to the given RMF (\a field) of a \a pill.
2196 void *req_capsule_server_get(struct req_capsule *pill,
2197 const struct req_msg_field *field)
2199 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2201 EXPORT_SYMBOL(req_capsule_server_get);
2204 * Same as req_capsule_server_get(), but with a \a swabber argument.
2206 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2207 * swabbing done outside this capsule abstraction.
2209 void *req_capsule_server_swab_get(struct req_capsule *pill,
2210 const struct req_msg_field *field,
2213 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2215 EXPORT_SYMBOL(req_capsule_server_swab_get);
2218 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2220 * First the \a pill's request \a field's size is set (\a rc_area) using
2221 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2224 void *req_capsule_server_sized_get(struct req_capsule *pill,
2225 const struct req_msg_field *field,
2228 req_capsule_set_size(pill, field, RCL_SERVER, len);
2229 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2231 EXPORT_SYMBOL(req_capsule_server_sized_get);
2233 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2234 const struct req_msg_field *field,
2235 __u32 len, void *swabber)
2237 req_capsule_set_size(pill, field, RCL_SERVER, len);
2238 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2240 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2243 * Returns the buffer of a \a pill corresponding to the given \a field from the
2244 * request (if the caller is executing on the server-side) or reply (if the
2245 * caller is executing on the client-side).
2247 * This function convienient for use is code that could be executed on the
2248 * client and server alike.
2250 const void *req_capsule_other_get(struct req_capsule *pill,
2251 const struct req_msg_field *field)
2253 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2255 EXPORT_SYMBOL(req_capsule_other_get);
2258 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2259 * field of the given \a pill.
2261 * This function must be used when constructing variable sized fields of a
2264 void req_capsule_set_size(struct req_capsule *pill,
2265 const struct req_msg_field *field,
2266 enum req_location loc, __u32 size)
2268 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2270 if ((size != (__u32)field->rmf_size) &&
2271 (field->rmf_size != -1) &&
2272 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2274 __u32 rmf_size = (__u32)field->rmf_size;
2275 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2276 (size % rmf_size != 0)) {
2277 CERROR("%s: array field size mismatch "
2278 "%u %% %u != 0 (%d)\n",
2279 field->rmf_name, size, rmf_size, loc);
2281 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2283 CERROR("%s: field size mismatch %u != %u (%d)\n",
2284 field->rmf_name, size, rmf_size, loc);
2289 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2291 EXPORT_SYMBOL(req_capsule_set_size);
2294 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2295 * for the given \a pill's given \a field.
2297 * NB: this function doesn't correspond with req_capsule_set_size(), which
2298 * actually sets the size in pill.rc_area[loc][offset], but this function
2299 * returns the message buflen[offset], maybe we should use another name.
2301 __u32 req_capsule_get_size(const struct req_capsule *pill,
2302 const struct req_msg_field *field,
2303 enum req_location loc)
2305 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2307 return lustre_msg_buflen(__req_msg(pill, loc),
2308 __req_capsule_offset(pill, field, loc));
2310 EXPORT_SYMBOL(req_capsule_get_size);
2313 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2314 * given \a pill's request or reply (\a loc) given the field size recorded in
2315 * the \a pill's rc_area.
2317 * See also req_capsule_set_size().
2319 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2321 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2322 pill->rc_fmt->rf_fields[loc].nr,
2323 pill->rc_area[loc]);
2327 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2328 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2329 * PTLRPC request or reply given only an RQF (\a fmt).
2331 * This function should not be used for formats which contain variable size
2334 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2335 enum req_location loc)
2341 * This function should probably LASSERT() that fmt has no fields with
2342 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2343 * elements in the array there will ultimately be, but then, we could
2344 * assume that there will be at least one element, and that's just what
2347 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2351 for (; i < fmt->rf_fields[loc].nr; ++i)
2352 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2353 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2359 * Changes the format of an RPC.
2361 * The pill must already have been initialized, which means that it already has
2362 * a request format. The new format \a fmt must be an extension of the pill's
2363 * old format. Specifically: the new format must have as many request and reply
2364 * fields as the old one, and all fields shared by the old and new format must
2365 * be at least as large in the new format.
2367 * The new format's fields may be of different "type" than the old format, but
2368 * only for fields that are "opaque" blobs: fields which have a) have no
2369 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2370 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2371 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2372 * according to the key field. When the value, according to the key, contains a
2373 * structure (or array thereof) to be swabbed, the format should be changed to
2374 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2377 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2382 const struct req_format *old;
2384 LASSERT(pill->rc_fmt != NULL);
2385 LASSERT(__req_format_is_sane(fmt));
2389 * Sanity checking...
2391 for (i = 0; i < RCL_NR; ++i) {
2392 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2393 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2394 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2396 /* "opaque" fields can be transmogrified */
2397 if (ofield->rmf_swabber == NULL &&
2398 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2399 (ofield->rmf_size == -1 ||
2400 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2402 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2405 * Last field in old format can be shorter than in new.
2407 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2408 FMT_FIELD(old, i, j)->rmf_size);
2413 EXPORT_SYMBOL(req_capsule_extend);
2416 * This function returns a non-zero value if the given \a field is present in
2417 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2420 int req_capsule_has_field(const struct req_capsule *pill,
2421 const struct req_msg_field *field,
2422 enum req_location loc)
2424 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2426 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2428 EXPORT_SYMBOL(req_capsule_has_field);
2431 * Returns a non-zero value if the given \a field is present in the given \a
2432 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2434 int req_capsule_field_present(const struct req_capsule *pill,
2435 const struct req_msg_field *field,
2436 enum req_location loc)
2440 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2441 LASSERT(req_capsule_has_field(pill, field, loc));
2443 offset = __req_capsule_offset(pill, field, loc);
2444 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2446 EXPORT_SYMBOL(req_capsule_field_present);
2449 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2450 * request or reply (\a loc).
2452 * This is not the opposite of req_capsule_extend().
2454 void req_capsule_shrink(struct req_capsule *pill,
2455 const struct req_msg_field *field,
2457 enum req_location loc)
2459 const struct req_format *fmt;
2460 struct lustre_msg *msg;
2465 LASSERT(fmt != NULL);
2466 LASSERT(__req_format_is_sane(fmt));
2467 LASSERT(req_capsule_has_field(pill, field, loc));
2468 LASSERT(req_capsule_field_present(pill, field, loc));
2470 offset = __req_capsule_offset(pill, field, loc);
2472 msg = __req_msg(pill, loc);
2473 len = lustre_msg_buflen(msg, offset);
2474 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2475 fmt->rf_name, field->rmf_name, len, newlen);
2477 if (loc == RCL_CLIENT)
2478 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2481 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2484 EXPORT_SYMBOL(req_capsule_shrink);
2486 int req_capsule_server_grow(struct req_capsule *pill,
2487 const struct req_msg_field *field,
2490 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2495 LASSERT(pill->rc_fmt != NULL);
2496 LASSERT(__req_format_is_sane(pill->rc_fmt));
2497 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2498 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2500 len = req_capsule_get_size(pill, field, RCL_SERVER);
2501 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2502 if ((__u32)pill->rc_req->rq_repbuf_len >=
2503 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2504 CERROR("Inplace repack might be done\n");
2506 pill->rc_req->rq_reply_state = NULL;
2507 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2508 rc = req_capsule_server_pack(pill);
2510 /* put old rs back, the caller will decide what to do */
2511 pill->rc_req->rq_reply_state = rs;
2514 nrs = pill->rc_req->rq_reply_state;
2515 /* Now we need only buffers, copy first chunk */
2516 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2517 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2518 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2519 memcpy(to, from, len);
2520 /* check if we have tail and copy it too */
2521 if (rs->rs_msg->lm_bufcount > offset + 1) {
2522 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2523 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2524 offset = rs->rs_msg->lm_bufcount - 1;
2525 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2526 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2527 memcpy(to, from, len);
2529 /* drop old reply if everything is fine */
2530 if (rs->rs_difficult) {
2534 nrs->rs_difficult = 1;
2535 nrs->rs_no_ack = rs->rs_no_ack;
2536 for (i = 0; i < rs->rs_nlocks; i++) {
2537 nrs->rs_locks[i] = rs->rs_locks[i];
2538 nrs->rs_modes[i] = rs->rs_modes[i];
2542 rs->rs_difficult = 0;
2545 ptlrpc_rs_decref(rs);
2548 EXPORT_SYMBOL(req_capsule_server_grow);