4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ptlrpc/layout.c
34 * Lustre Metadata Target (mdt) request handler
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
41 * Every struct ptlrpc_request contains a "pill", which points to a description
42 * of the format that the request conforms to.
45 #define DEBUG_SUBSYSTEM S_RPC
47 #include <linux/module.h>
49 #include <llog_swab.h>
50 #include <lustre_debug.h>
51 #include <lustre_swab.h>
53 #include <obd_support.h>
55 /* struct ptlrpc_request, lustre_msg* */
56 #include <lustre_req_layout.h>
57 #include <lustre_acl.h>
60 * RQFs (see below) refer to two struct req_msg_field arrays describing the
61 * client request and server reply, respectively.
63 /* empty set of fields... for suitable definition of emptiness. */
64 static const struct req_msg_field *empty[] = {
68 static const struct req_msg_field *mgs_target_info_only[] = {
73 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
74 static const struct req_msg_field *mgs_set_info[] = {
80 static const struct req_msg_field *mgs_config_read_client[] = {
85 static const struct req_msg_field *mgs_config_read_server[] = {
90 static const struct req_msg_field *mdt_body_only[] = {
95 static const struct req_msg_field *mdt_body_capa[] = {
101 static const struct req_msg_field *quotactl_only[] = {
106 static const struct req_msg_field *quota_body_only[] = {
111 static const struct req_msg_field *ldlm_intent_quota_client[] = {
118 static const struct req_msg_field *ldlm_intent_quota_server[] = {
125 static const struct req_msg_field *mdt_close_client[] = {
132 static const struct req_msg_field *mdt_close_intent_client[] = {
141 static const struct req_msg_field *obd_statfs_server[] = {
146 static const struct req_msg_field *seq_query_client[] = {
152 static const struct req_msg_field *seq_query_server[] = {
157 static const struct req_msg_field *fld_query_client[] = {
163 static const struct req_msg_field *fld_query_server[] = {
168 static const struct req_msg_field *fld_read_client[] = {
173 static const struct req_msg_field *fld_read_server[] = {
178 static const struct req_msg_field *mds_getattr_name_client[] = {
185 static const struct req_msg_field *mds_reint_client[] = {
190 static const struct req_msg_field *mds_reint_create_client[] = {
197 static const struct req_msg_field *mds_reint_create_slave_client[] = {
206 static const struct req_msg_field *mds_reint_create_acl_client[] = {
213 &RMF_FILE_SECCTX_NAME,
217 static const struct req_msg_field *mds_reint_create_sym_client[] = {
224 &RMF_FILE_SECCTX_NAME,
228 static const struct req_msg_field *mds_reint_open_client[] = {
235 &RMF_FILE_SECCTX_NAME,
239 static const struct req_msg_field *mds_reint_open_server[] = {
248 static const struct req_msg_field *mds_reint_unlink_client[] = {
256 static const struct req_msg_field *mds_reint_link_client[] = {
265 static const struct req_msg_field *mds_reint_rename_client[] = {
275 static const struct req_msg_field *mds_reint_migrate_client[] = {
288 static const struct req_msg_field *mds_last_unlink_server[] = {
297 static const struct req_msg_field *mds_reint_setattr_client[] = {
307 static const struct req_msg_field *mds_reint_setxattr_client[] = {
316 static const struct req_msg_field *mds_reint_resync[] = {
322 static const struct req_msg_field *mdt_swap_layouts[] = {
331 static const struct req_msg_field *obd_connect_client[] = {
339 static const struct req_msg_field *obd_connect_server[] = {
344 static const struct req_msg_field *obd_set_info_client[] = {
350 static const struct req_msg_field *ost_grant_shrink_client[] = {
356 static const struct req_msg_field *mds_getinfo_client[] = {
362 static const struct req_msg_field *mds_getinfo_server[] = {
367 static const struct req_msg_field *ldlm_enqueue_client[] = {
372 static const struct req_msg_field *ldlm_enqueue_server[] = {
377 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
383 static const struct req_msg_field *ldlm_cp_callback_client[] = {
389 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
395 static const struct req_msg_field *ldlm_gl_callback_server[] = {
400 static const struct req_msg_field *ldlm_intent_basic_client[] = {
406 static const struct req_msg_field *ldlm_intent_client[] = {
413 static const struct req_msg_field *ldlm_intent_server[] = {
421 static const struct req_msg_field *ldlm_intent_layout_client[] = {
426 &RMF_EADATA /* for new layout to be set up */
429 static const struct req_msg_field *ldlm_intent_open_server[] = {
440 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
444 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
449 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
458 static const struct req_msg_field *ldlm_intent_create_client[] = {
462 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
466 &RMF_FILE_SECCTX_NAME,
470 static const struct req_msg_field *ldlm_intent_open_client[] = {
474 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
479 &RMF_FILE_SECCTX_NAME,
483 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
491 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
496 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
502 static const struct req_msg_field *mds_get_root_client[] = {
508 static const struct req_msg_field *mds_getxattr_client[] = {
516 static const struct req_msg_field *mds_getxattr_server[] = {
522 static const struct req_msg_field *mds_getattr_server[] = {
531 static const struct req_msg_field *mds_setattr_server[] = {
540 static const struct req_msg_field *mds_update_client[] = {
542 &RMF_OUT_UPDATE_HEADER,
546 static const struct req_msg_field *mds_update_server[] = {
548 &RMF_OUT_UPDATE_REPLY,
551 static const struct req_msg_field *llog_origin_handle_create_client[] = {
557 static const struct req_msg_field *llogd_body_only[] = {
562 static const struct req_msg_field *llog_log_hdr_only[] = {
567 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
573 static const struct req_msg_field *obd_idx_read_client[] = {
578 static const struct req_msg_field *obd_idx_read_server[] = {
583 static const struct req_msg_field *ost_body_only[] = {
588 static const struct req_msg_field *ost_body_capa[] = {
594 static const struct req_msg_field *ost_destroy_client[] = {
602 static const struct req_msg_field *ost_brw_client[] = {
611 static const struct req_msg_field *ost_brw_read_server[] = {
617 static const struct req_msg_field *ost_brw_write_server[] = {
623 static const struct req_msg_field *ost_get_info_generic_server[] = {
628 static const struct req_msg_field *ost_get_info_generic_client[] = {
633 static const struct req_msg_field *ost_get_last_id_server[] = {
638 static const struct req_msg_field *ost_get_last_fid_client[] = {
644 static const struct req_msg_field *ost_get_last_fid_server[] = {
649 static const struct req_msg_field *ost_get_fiemap_client[] = {
655 static const struct req_msg_field *ost_ladvise[] = {
658 &RMF_OST_LADVISE_HDR,
662 static const struct req_msg_field *ost_get_fiemap_server[] = {
667 static const struct req_msg_field *mdt_hsm_progress[] = {
670 &RMF_MDS_HSM_PROGRESS,
673 static const struct req_msg_field *mdt_hsm_ct_register[] = {
676 &RMF_MDS_HSM_ARCHIVE,
679 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
684 static const struct req_msg_field *mdt_hsm_action_server[] = {
687 &RMF_MDS_HSM_CURRENT_ACTION,
690 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
696 static const struct req_msg_field *mdt_hsm_state_set[] = {
703 static const struct req_msg_field *mdt_hsm_request[] = {
706 &RMF_MDS_HSM_REQUEST,
707 &RMF_MDS_HSM_USER_ITEM,
711 static const struct req_msg_field *obd_lfsck_request[] = {
716 static const struct req_msg_field *obd_lfsck_reply[] = {
721 static struct req_format *req_formats[] = {
727 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
730 &RQF_MGS_CONFIG_READ,
740 &RQF_MDS_GETATTR_NAME,
744 &RQF_MDS_CLOSE_INTENT,
747 &RQF_MDS_REINT_CREATE,
748 &RQF_MDS_REINT_CREATE_ACL,
749 &RQF_MDS_REINT_CREATE_SLAVE,
750 &RQF_MDS_REINT_CREATE_SYM,
752 &RQF_MDS_REINT_UNLINK,
754 &RQF_MDS_REINT_RENAME,
755 &RQF_MDS_REINT_MIGRATE,
756 &RQF_MDS_REINT_SETATTR,
757 &RQF_MDS_REINT_SETXATTR,
758 &RQF_MDS_REINT_RESYNC,
760 &RQF_MDS_HSM_PROGRESS,
761 &RQF_MDS_HSM_CT_REGISTER,
762 &RQF_MDS_HSM_CT_UNREGISTER,
763 &RQF_MDS_HSM_STATE_GET,
764 &RQF_MDS_HSM_STATE_SET,
766 &RQF_MDS_HSM_REQUEST,
767 &RQF_MDS_SWAP_LAYOUTS,
781 &RQF_OST_SET_GRANT_INFO,
783 &RQF_OST_GET_INFO_LAST_ID,
784 &RQF_OST_GET_INFO_LAST_FID,
785 &RQF_OST_SET_INFO_LAST_FID,
786 &RQF_OST_GET_INFO_FIEMAP,
789 &RQF_LDLM_ENQUEUE_LVB,
793 &RQF_LDLM_CP_CALLBACK,
794 &RQF_LDLM_BL_CALLBACK,
795 &RQF_LDLM_GL_CALLBACK,
796 &RQF_LDLM_GL_CALLBACK_DESC,
798 &RQF_LDLM_INTENT_BASIC,
799 &RQF_LDLM_INTENT_LAYOUT,
800 &RQF_LDLM_INTENT_GETATTR,
801 &RQF_LDLM_INTENT_OPEN,
802 &RQF_LDLM_INTENT_CREATE,
803 &RQF_LDLM_INTENT_GETXATTR,
804 &RQF_LDLM_INTENT_QUOTA,
806 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
807 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
808 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
809 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
815 struct req_msg_field {
816 const __u32 rmf_flags;
817 const char *rmf_name;
819 * Field length. (-1) means "variable length". If the
820 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
821 * but the actual size must be a whole multiple of \a rmf_size.
824 void (*rmf_swabber)(void *);
825 void (*rmf_dumper)(void *);
826 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
831 * The field is a string, must be NUL-terminated.
833 RMF_F_STRING = 1 << 0,
835 * The field's buffer size need not match the declared \a rmf_size.
837 RMF_F_NO_SIZE_CHECK = 1 << 1,
839 * The field's buffer size must be a whole multiple of the declared \a
840 * rmf_size and the \a rmf_swabber function must work on the declared \a
841 * rmf_size worth of bytes.
843 RMF_F_STRUCT_ARRAY = 1 << 2
851 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
852 .rmf_name = (name), \
853 .rmf_flags = (flags), \
854 .rmf_size = (size), \
855 .rmf_swabber = (void (*)(void*))(swabber), \
856 .rmf_dumper = (void (*)(void*))(dumper) \
859 struct req_msg_field RMF_GENERIC_DATA =
860 DEFINE_MSGF("generic_data", 0,
862 EXPORT_SYMBOL(RMF_GENERIC_DATA);
864 struct req_msg_field RMF_MGS_TARGET_INFO =
865 DEFINE_MSGF("mgs_target_info", 0,
866 sizeof(struct mgs_target_info),
867 lustre_swab_mgs_target_info, NULL);
868 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
870 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
871 struct req_msg_field RMF_MGS_SEND_PARAM =
872 DEFINE_MSGF("mgs_send_param", 0,
873 sizeof(struct mgs_send_param),
875 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
878 struct req_msg_field RMF_MGS_CONFIG_BODY =
879 DEFINE_MSGF("mgs_config_read request", 0,
880 sizeof(struct mgs_config_body),
881 lustre_swab_mgs_config_body, NULL);
882 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
884 struct req_msg_field RMF_MGS_CONFIG_RES =
885 DEFINE_MSGF("mgs_config_read reply ", 0,
886 sizeof(struct mgs_config_res),
887 lustre_swab_mgs_config_res, NULL);
888 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
890 struct req_msg_field RMF_U32 =
891 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
892 sizeof(__u32), lustre_swab_generic_32s, NULL);
893 EXPORT_SYMBOL(RMF_U32);
895 struct req_msg_field RMF_SETINFO_VAL =
896 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
897 EXPORT_SYMBOL(RMF_SETINFO_VAL);
899 struct req_msg_field RMF_GETINFO_KEY =
900 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
901 EXPORT_SYMBOL(RMF_GETINFO_KEY);
903 struct req_msg_field RMF_GETINFO_VALLEN =
904 DEFINE_MSGF("getinfo_vallen", 0,
905 sizeof(__u32), lustre_swab_generic_32s, NULL);
906 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
908 struct req_msg_field RMF_GETINFO_VAL =
909 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
910 EXPORT_SYMBOL(RMF_GETINFO_VAL);
912 struct req_msg_field RMF_SEQ_OPC =
913 DEFINE_MSGF("seq_query_opc", 0,
914 sizeof(__u32), lustre_swab_generic_32s, NULL);
915 EXPORT_SYMBOL(RMF_SEQ_OPC);
917 struct req_msg_field RMF_SEQ_RANGE =
918 DEFINE_MSGF("seq_query_range", 0,
919 sizeof(struct lu_seq_range),
920 lustre_swab_lu_seq_range, NULL);
921 EXPORT_SYMBOL(RMF_SEQ_RANGE);
923 struct req_msg_field RMF_FLD_OPC =
924 DEFINE_MSGF("fld_query_opc", 0,
925 sizeof(__u32), lustre_swab_generic_32s, NULL);
926 EXPORT_SYMBOL(RMF_FLD_OPC);
928 struct req_msg_field RMF_FLD_MDFLD =
929 DEFINE_MSGF("fld_query_mdfld", 0,
930 sizeof(struct lu_seq_range),
931 lustre_swab_lu_seq_range, NULL);
932 EXPORT_SYMBOL(RMF_FLD_MDFLD);
934 struct req_msg_field RMF_MDT_BODY =
935 DEFINE_MSGF("mdt_body", 0,
936 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
937 EXPORT_SYMBOL(RMF_MDT_BODY);
939 struct req_msg_field RMF_OBD_QUOTACTL =
940 DEFINE_MSGF("obd_quotactl", 0,
941 sizeof(struct obd_quotactl),
942 lustre_swab_obd_quotactl, NULL);
943 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
945 struct req_msg_field RMF_QUOTA_BODY =
946 DEFINE_MSGF("quota_body", 0,
947 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
948 EXPORT_SYMBOL(RMF_QUOTA_BODY);
950 struct req_msg_field RMF_MDT_EPOCH =
951 DEFINE_MSGF("mdt_ioepoch", 0,
952 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
953 EXPORT_SYMBOL(RMF_MDT_EPOCH);
955 struct req_msg_field RMF_PTLRPC_BODY =
956 DEFINE_MSGF("ptlrpc_body", 0,
957 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
958 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
960 struct req_msg_field RMF_CLOSE_DATA =
961 DEFINE_MSGF("data_version", 0,
962 sizeof(struct close_data), lustre_swab_close_data, NULL);
963 EXPORT_SYMBOL(RMF_CLOSE_DATA);
965 struct req_msg_field RMF_OBD_STATFS =
966 DEFINE_MSGF("obd_statfs", 0,
967 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
968 EXPORT_SYMBOL(RMF_OBD_STATFS);
970 struct req_msg_field RMF_SETINFO_KEY =
971 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
972 EXPORT_SYMBOL(RMF_SETINFO_KEY);
974 struct req_msg_field RMF_NAME =
975 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
976 EXPORT_SYMBOL(RMF_NAME);
978 struct req_msg_field RMF_SYMTGT =
979 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
980 EXPORT_SYMBOL(RMF_SYMTGT);
982 struct req_msg_field RMF_TGTUUID =
983 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
985 EXPORT_SYMBOL(RMF_TGTUUID);
987 struct req_msg_field RMF_CLUUID =
988 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
990 EXPORT_SYMBOL(RMF_CLUUID);
992 struct req_msg_field RMF_STRING =
993 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
994 EXPORT_SYMBOL(RMF_STRING);
996 struct req_msg_field RMF_FILE_SECCTX_NAME =
997 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
998 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1000 struct req_msg_field RMF_FILE_SECCTX =
1001 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1002 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1004 struct req_msg_field RMF_LLOGD_BODY =
1005 DEFINE_MSGF("llogd_body", 0,
1006 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1007 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1009 struct req_msg_field RMF_LLOG_LOG_HDR =
1010 DEFINE_MSGF("llog_log_hdr", 0,
1011 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1012 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1014 struct req_msg_field RMF_LLOGD_CONN_BODY =
1015 DEFINE_MSGF("llogd_conn_body", 0,
1016 sizeof(struct llogd_conn_body),
1017 lustre_swab_llogd_conn_body, NULL);
1018 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1021 * connection handle received in MDS_CONNECT request.
1023 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1024 * that the client does not interpret at all.
1026 struct req_msg_field RMF_CONN =
1027 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1028 EXPORT_SYMBOL(RMF_CONN);
1030 struct req_msg_field RMF_CONNECT_DATA =
1031 DEFINE_MSGF("cdata",
1032 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1033 sizeof(struct obd_connect_data),
1034 lustre_swab_connect, NULL);
1035 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1037 struct req_msg_field RMF_DLM_REQ =
1038 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1039 sizeof(struct ldlm_request),
1040 lustre_swab_ldlm_request, NULL);
1041 EXPORT_SYMBOL(RMF_DLM_REQ);
1043 struct req_msg_field RMF_DLM_REP =
1044 DEFINE_MSGF("dlm_rep", 0,
1045 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1046 EXPORT_SYMBOL(RMF_DLM_REP);
1048 struct req_msg_field RMF_LDLM_INTENT =
1049 DEFINE_MSGF("ldlm_intent", 0,
1050 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1051 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1053 struct req_msg_field RMF_DLM_LVB =
1054 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1055 EXPORT_SYMBOL(RMF_DLM_LVB);
1057 struct req_msg_field RMF_DLM_GL_DESC =
1058 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1059 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1061 struct req_msg_field RMF_MDT_MD =
1062 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1063 EXPORT_SYMBOL(RMF_MDT_MD);
1065 struct req_msg_field RMF_REC_REINT =
1066 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1067 lustre_swab_mdt_rec_reint, NULL);
1068 EXPORT_SYMBOL(RMF_REC_REINT);
1070 /* FIXME: this length should be defined as a macro */
1071 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1073 EXPORT_SYMBOL(RMF_EADATA);
1075 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1076 EXPORT_SYMBOL(RMF_EAVALS);
1078 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1079 EXPORT_SYMBOL(RMF_ACL);
1081 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1082 struct req_msg_field RMF_LOGCOOKIES =
1083 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1084 sizeof(struct llog_cookie), NULL, NULL);
1085 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1087 struct req_msg_field RMF_CAPA1 =
1088 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1089 EXPORT_SYMBOL(RMF_CAPA1);
1091 struct req_msg_field RMF_CAPA2 =
1092 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1093 EXPORT_SYMBOL(RMF_CAPA2);
1095 struct req_msg_field RMF_LAYOUT_INTENT =
1096 DEFINE_MSGF("layout_intent", 0,
1097 sizeof(struct layout_intent), lustre_swab_layout_intent,
1099 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1102 * OST request field.
1104 struct req_msg_field RMF_OST_BODY =
1105 DEFINE_MSGF("ost_body", 0,
1106 sizeof(struct ost_body), lustre_swab_ost_body,
1108 EXPORT_SYMBOL(RMF_OST_BODY);
1110 struct req_msg_field RMF_OBD_IOOBJ =
1111 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1112 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1113 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1115 struct req_msg_field RMF_NIOBUF_REMOTE =
1116 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1117 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1119 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1121 struct req_msg_field RMF_NIOBUF_INLINE =
1122 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1123 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1125 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1127 struct req_msg_field RMF_RCS =
1128 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1129 lustre_swab_generic_32s, dump_rcs);
1130 EXPORT_SYMBOL(RMF_RCS);
1132 struct req_msg_field RMF_EAVALS_LENS =
1133 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1134 lustre_swab_generic_32s, NULL);
1135 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1137 struct req_msg_field RMF_OBD_ID =
1138 DEFINE_MSGF("obd_id", 0,
1139 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1140 EXPORT_SYMBOL(RMF_OBD_ID);
1142 struct req_msg_field RMF_FID =
1143 DEFINE_MSGF("fid", 0,
1144 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1145 EXPORT_SYMBOL(RMF_FID);
1147 struct req_msg_field RMF_OST_ID =
1148 DEFINE_MSGF("ost_id", 0,
1149 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1150 EXPORT_SYMBOL(RMF_OST_ID);
1152 struct req_msg_field RMF_FIEMAP_KEY =
1153 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1154 lustre_swab_fiemap, NULL);
1155 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1157 struct req_msg_field RMF_FIEMAP_VAL =
1158 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1159 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1161 struct req_msg_field RMF_IDX_INFO =
1162 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1163 lustre_swab_idx_info, NULL);
1164 EXPORT_SYMBOL(RMF_IDX_INFO);
1165 struct req_msg_field RMF_SHORT_IO =
1166 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1167 EXPORT_SYMBOL(RMF_SHORT_IO);
1168 struct req_msg_field RMF_HSM_USER_STATE =
1169 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1170 lustre_swab_hsm_user_state, NULL);
1171 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1173 struct req_msg_field RMF_HSM_STATE_SET =
1174 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1175 lustre_swab_hsm_state_set, NULL);
1176 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1178 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1179 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1180 lustre_swab_hsm_progress_kernel, NULL);
1181 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1183 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1184 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1185 lustre_swab_hsm_current_action, NULL);
1186 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1188 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1189 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1190 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1192 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1194 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1195 DEFINE_MSGF("hsm_archive", 0,
1196 sizeof(__u32), lustre_swab_generic_32s, NULL);
1197 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1199 struct req_msg_field RMF_MDS_HSM_REQUEST =
1200 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1201 lustre_swab_hsm_request, NULL);
1202 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1204 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1205 lustre_swab_object_update_request, NULL);
1206 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1208 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1209 DEFINE_MSGF("object_update_reply", 0, -1,
1210 lustre_swab_object_update_reply, NULL);
1211 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1213 struct req_msg_field RMF_SWAP_LAYOUTS =
1214 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1215 lustre_swab_swap_layouts, NULL);
1216 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1218 struct req_msg_field RMF_LFSCK_REQUEST =
1219 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1220 lustre_swab_lfsck_request, NULL);
1221 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1223 struct req_msg_field RMF_LFSCK_REPLY =
1224 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1225 lustre_swab_lfsck_reply, NULL);
1226 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1228 struct req_msg_field RMF_OST_LADVISE_HDR =
1229 DEFINE_MSGF("ladvise_request", 0,
1230 sizeof(struct ladvise_hdr),
1231 lustre_swab_ladvise_hdr, NULL);
1232 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1234 struct req_msg_field RMF_OST_LADVISE =
1235 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1236 sizeof(struct lu_ladvise),
1237 lustre_swab_ladvise, NULL);
1238 EXPORT_SYMBOL(RMF_OST_LADVISE);
1240 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1241 -1, lustre_swab_out_update_header, NULL);
1242 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1244 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1245 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1246 lustre_swab_out_update_buffer, NULL);
1247 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1254 const char *rf_name;
1258 const struct req_msg_field **d;
1259 } rf_fields[RCL_NR];
1262 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1276 #define DEFINE_REQ_FMT0(name, client, server) \
1277 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1279 struct req_format RQF_OBD_PING =
1280 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1281 EXPORT_SYMBOL(RQF_OBD_PING);
1283 struct req_format RQF_OBD_SET_INFO =
1284 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1285 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1287 /* Read index file through the network */
1288 struct req_format RQF_OBD_IDX_READ =
1289 DEFINE_REQ_FMT0("OBD_IDX_READ",
1290 obd_idx_read_client, obd_idx_read_server);
1291 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1293 struct req_format RQF_SEC_CTX =
1294 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1295 EXPORT_SYMBOL(RQF_SEC_CTX);
1297 struct req_format RQF_MGS_TARGET_REG =
1298 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1299 mgs_target_info_only);
1300 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1302 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1303 struct req_format RQF_MGS_SET_INFO =
1304 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1306 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1309 struct req_format RQF_MGS_CONFIG_READ =
1310 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1311 mgs_config_read_server);
1312 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1314 struct req_format RQF_SEQ_QUERY =
1315 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1316 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1318 struct req_format RQF_FLD_QUERY =
1319 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1320 EXPORT_SYMBOL(RQF_FLD_QUERY);
1322 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1323 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1324 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1325 * peers need to handle the RPC reply with fixed little-endian format.
1327 * In theory, we can define new structure with some swabber registered to
1328 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1329 * implementation view, it is not easy to be done within current "struct
1330 * req_msg_field" framework. Because the sequence range array in the RPC
1331 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1332 * count, that is unknown when prepare the RPC buffer. Generally, for such
1333 * flexible length RPC usage, there will be a field in the RPC layout to
1334 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1335 * do that unless we add new length filed that will broken the on-wire RPC
1336 * protocol and cause interoperability trouble with old peer. */
1337 struct req_format RQF_FLD_READ =
1338 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1339 EXPORT_SYMBOL(RQF_FLD_READ);
1341 struct req_format RQF_MDS_QUOTACTL =
1342 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1343 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1345 struct req_format RQF_OST_QUOTACTL =
1346 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1347 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1349 struct req_format RQF_QUOTA_DQACQ =
1350 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1351 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1353 struct req_format RQF_LDLM_INTENT_QUOTA =
1354 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1355 ldlm_intent_quota_client,
1356 ldlm_intent_quota_server);
1357 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1359 struct req_format RQF_MDS_GET_ROOT =
1360 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1361 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1363 struct req_format RQF_MDS_STATFS =
1364 DEFINE_REQ_FMT0("MDS_STATFS", mdt_body_only, obd_statfs_server);
1365 EXPORT_SYMBOL(RQF_MDS_STATFS);
1367 struct req_format RQF_MDS_SYNC =
1368 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1369 EXPORT_SYMBOL(RQF_MDS_SYNC);
1371 struct req_format RQF_MDS_GETATTR =
1372 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1373 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1375 struct req_format RQF_MDS_GETXATTR =
1376 DEFINE_REQ_FMT0("MDS_GETXATTR",
1377 mds_getxattr_client, mds_getxattr_server);
1378 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1380 struct req_format RQF_MDS_GETATTR_NAME =
1381 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1382 mds_getattr_name_client, mds_getattr_server);
1383 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1385 struct req_format RQF_MDS_REINT =
1386 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1387 EXPORT_SYMBOL(RQF_MDS_REINT);
1389 struct req_format RQF_MDS_REINT_CREATE =
1390 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1391 mds_reint_create_client, mdt_body_capa);
1392 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1394 struct req_format RQF_MDS_REINT_CREATE_ACL =
1395 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1396 mds_reint_create_acl_client, mdt_body_capa);
1397 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1399 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1400 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1401 mds_reint_create_slave_client, mdt_body_capa);
1402 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1404 struct req_format RQF_MDS_REINT_CREATE_SYM =
1405 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1406 mds_reint_create_sym_client, mdt_body_capa);
1407 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1409 struct req_format RQF_MDS_REINT_OPEN =
1410 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1411 mds_reint_open_client, mds_reint_open_server);
1412 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1414 struct req_format RQF_MDS_REINT_UNLINK =
1415 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1416 mds_last_unlink_server);
1417 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1419 struct req_format RQF_MDS_REINT_LINK =
1420 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1421 mds_reint_link_client, mdt_body_only);
1422 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1424 struct req_format RQF_MDS_REINT_RENAME =
1425 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1426 mds_last_unlink_server);
1427 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1429 struct req_format RQF_MDS_REINT_MIGRATE =
1430 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1431 mds_last_unlink_server);
1432 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1434 struct req_format RQF_MDS_REINT_SETATTR =
1435 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1436 mds_reint_setattr_client, mds_setattr_server);
1437 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1439 struct req_format RQF_MDS_REINT_SETXATTR =
1440 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1441 mds_reint_setxattr_client, mdt_body_only);
1442 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1444 struct req_format RQF_MDS_REINT_RESYNC =
1445 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1446 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1448 struct req_format RQF_MDS_CONNECT =
1449 DEFINE_REQ_FMT0("MDS_CONNECT",
1450 obd_connect_client, obd_connect_server);
1451 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1453 struct req_format RQF_MDS_DISCONNECT =
1454 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1455 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1457 struct req_format RQF_MDS_GET_INFO =
1458 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1459 mds_getinfo_server);
1460 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1462 struct req_format RQF_OUT_UPDATE =
1463 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1465 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1467 struct req_format RQF_LDLM_ENQUEUE =
1468 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1469 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1470 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1472 struct req_format RQF_LDLM_ENQUEUE_LVB =
1473 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1474 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1475 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1477 struct req_format RQF_LDLM_CONVERT =
1478 DEFINE_REQ_FMT0("LDLM_CONVERT",
1479 ldlm_enqueue_client, ldlm_enqueue_server);
1480 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1482 struct req_format RQF_LDLM_CANCEL =
1483 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1484 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1486 struct req_format RQF_LDLM_CALLBACK =
1487 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1488 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1490 struct req_format RQF_LDLM_CP_CALLBACK =
1491 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1492 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1494 struct req_format RQF_LDLM_BL_CALLBACK =
1495 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1496 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1498 struct req_format RQF_LDLM_GL_CALLBACK =
1499 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1500 ldlm_gl_callback_server);
1501 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1503 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1504 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1505 ldlm_gl_callback_server);
1506 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1508 struct req_format RQF_LDLM_INTENT_BASIC =
1509 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1510 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1511 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1513 struct req_format RQF_LDLM_INTENT =
1514 DEFINE_REQ_FMT0("LDLM_INTENT",
1515 ldlm_intent_client, ldlm_intent_server);
1516 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1518 struct req_format RQF_LDLM_INTENT_LAYOUT =
1519 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1520 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1521 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1523 struct req_format RQF_LDLM_INTENT_GETATTR =
1524 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1525 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1526 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1528 struct req_format RQF_LDLM_INTENT_OPEN =
1529 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1530 ldlm_intent_open_client, ldlm_intent_open_server);
1531 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1533 struct req_format RQF_LDLM_INTENT_CREATE =
1534 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1535 ldlm_intent_create_client, ldlm_intent_getattr_server);
1536 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1538 struct req_format RQF_LDLM_INTENT_GETXATTR =
1539 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1540 ldlm_intent_getxattr_client,
1541 ldlm_intent_getxattr_server);
1542 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1544 struct req_format RQF_MDS_CLOSE =
1545 DEFINE_REQ_FMT0("MDS_CLOSE",
1546 mdt_close_client, mds_last_unlink_server);
1547 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1549 struct req_format RQF_MDS_CLOSE_INTENT =
1550 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1551 mdt_close_intent_client, mds_last_unlink_server);
1552 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1554 struct req_format RQF_MDS_READPAGE =
1555 DEFINE_REQ_FMT0("MDS_READPAGE",
1556 mdt_body_capa, mdt_body_only);
1557 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1559 struct req_format RQF_MDS_HSM_ACTION =
1560 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1561 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1563 struct req_format RQF_MDS_HSM_PROGRESS =
1564 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1565 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1567 struct req_format RQF_MDS_HSM_CT_REGISTER =
1568 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1569 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1571 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1572 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1573 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1575 struct req_format RQF_MDS_HSM_STATE_GET =
1576 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1577 mdt_body_capa, mdt_hsm_state_get_server);
1578 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1580 struct req_format RQF_MDS_HSM_STATE_SET =
1581 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1582 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1584 struct req_format RQF_MDS_HSM_REQUEST =
1585 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1586 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1588 struct req_format RQF_MDS_SWAP_LAYOUTS =
1589 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1590 mdt_swap_layouts, empty);
1591 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1593 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1594 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1595 llog_origin_handle_create_client, llogd_body_only);
1596 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1598 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1599 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1600 llogd_body_only, llog_origin_handle_next_block_server);
1601 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1603 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1604 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1605 llogd_body_only, llog_origin_handle_next_block_server);
1606 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1608 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1609 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1610 llogd_body_only, llog_log_hdr_only);
1611 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1613 struct req_format RQF_CONNECT =
1614 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1615 EXPORT_SYMBOL(RQF_CONNECT);
1617 struct req_format RQF_OST_CONNECT =
1618 DEFINE_REQ_FMT0("OST_CONNECT",
1619 obd_connect_client, obd_connect_server);
1620 EXPORT_SYMBOL(RQF_OST_CONNECT);
1622 struct req_format RQF_OST_DISCONNECT =
1623 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1624 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1626 struct req_format RQF_OST_GETATTR =
1627 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1628 EXPORT_SYMBOL(RQF_OST_GETATTR);
1630 struct req_format RQF_OST_SETATTR =
1631 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1632 EXPORT_SYMBOL(RQF_OST_SETATTR);
1634 struct req_format RQF_OST_CREATE =
1635 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1636 EXPORT_SYMBOL(RQF_OST_CREATE);
1638 struct req_format RQF_OST_PUNCH =
1639 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1640 EXPORT_SYMBOL(RQF_OST_PUNCH);
1642 struct req_format RQF_OST_SYNC =
1643 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1644 EXPORT_SYMBOL(RQF_OST_SYNC);
1646 struct req_format RQF_OST_DESTROY =
1647 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1648 EXPORT_SYMBOL(RQF_OST_DESTROY);
1650 struct req_format RQF_OST_BRW_READ =
1651 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1652 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1654 struct req_format RQF_OST_BRW_WRITE =
1655 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1656 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1658 struct req_format RQF_OST_STATFS =
1659 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1660 EXPORT_SYMBOL(RQF_OST_STATFS);
1662 struct req_format RQF_OST_SET_GRANT_INFO =
1663 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1665 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1667 struct req_format RQF_OST_GET_INFO =
1668 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1669 ost_get_info_generic_server);
1670 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1672 struct req_format RQF_OST_GET_INFO_LAST_ID =
1673 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1674 ost_get_last_id_server);
1675 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1677 struct req_format RQF_OST_GET_INFO_LAST_FID =
1678 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1679 ost_get_last_fid_server);
1680 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1682 struct req_format RQF_OST_SET_INFO_LAST_FID =
1683 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1685 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1687 struct req_format RQF_OST_GET_INFO_FIEMAP =
1688 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1689 ost_get_fiemap_server);
1690 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1692 struct req_format RQF_LFSCK_NOTIFY =
1693 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1694 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1696 struct req_format RQF_LFSCK_QUERY =
1697 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1698 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1700 struct req_format RQF_OST_LADVISE =
1701 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1702 EXPORT_SYMBOL(RQF_OST_LADVISE);
1704 /* Convenience macro */
1705 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1708 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1709 * field of RQFs and the \a rmf_offset field of RMFs.
1711 int req_layout_init(void)
1716 struct req_format *rf = NULL;
1718 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1719 rf = req_formats[i];
1721 for (j = 0; j < RCL_NR; ++j) {
1722 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1723 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1724 struct req_msg_field *field;
1726 field = (typeof(field))rf->rf_fields[j].d[k];
1727 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1728 || field->rmf_size > 0);
1729 LASSERT(field->rmf_offset[i][j] == 0);
1731 * k + 1 to detect unused format/field
1734 field->rmf_offset[i][j] = k + 1;
1740 EXPORT_SYMBOL(req_layout_init);
1742 void req_layout_fini(void)
1745 EXPORT_SYMBOL(req_layout_fini);
1748 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1750 * Actual/expected field sizes are set elsewhere in functions in this file:
1751 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1752 * req_capsule_msg_size(). The \a rc_area information is used by.
1753 * ptlrpc_request_set_replen().
1755 void req_capsule_init_area(struct req_capsule *pill)
1759 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1760 pill->rc_area[RCL_CLIENT][i] = -1;
1761 pill->rc_area[RCL_SERVER][i] = -1;
1764 EXPORT_SYMBOL(req_capsule_init_area);
1767 * Initialize a pill.
1769 * The \a location indicates whether the caller is executing on the client side
1770 * (RCL_CLIENT) or server side (RCL_SERVER)..
1772 void req_capsule_init(struct req_capsule *pill,
1773 struct ptlrpc_request *req,
1774 enum req_location location)
1776 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1779 * Today all capsules are embedded in ptlrpc_request structs,
1780 * but just in case that ever isn't the case, we don't reach
1781 * into req unless req != NULL and pill is the one embedded in
1784 * The req->rq_pill_init flag makes it safe to initialize a pill
1785 * twice, which might happen in the OST paths as a result of the
1786 * high-priority RPC queue getting peeked at before ost_handle()
1787 * handles an OST RPC.
1789 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1792 memset(pill, 0, sizeof *pill);
1794 pill->rc_loc = location;
1795 req_capsule_init_area(pill);
1797 if (req != NULL && pill == &req->rq_pill)
1798 req->rq_pill_init = 1;
1800 EXPORT_SYMBOL(req_capsule_init);
1802 void req_capsule_fini(struct req_capsule *pill)
1805 EXPORT_SYMBOL(req_capsule_fini);
1807 static int __req_format_is_sane(const struct req_format *fmt)
1809 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1810 req_formats[fmt->rf_idx] == fmt;
1813 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1814 enum req_location loc)
1816 struct ptlrpc_request *req;
1819 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1823 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1824 * (see req_capsule_extend()).
1826 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1828 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1829 LASSERT(__req_format_is_sane(fmt));
1833 EXPORT_SYMBOL(req_capsule_set);
1836 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1839 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1840 * variable-sized fields. The field sizes come from the declared \a rmf_size
1841 * field of a \a pill's \a rc_fmt's RMF's.
1843 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1844 enum req_location loc)
1846 const struct req_format *fmt = pill->rc_fmt;
1849 LASSERT(fmt != NULL);
1851 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1852 if (pill->rc_area[loc][i] == -1) {
1853 pill->rc_area[loc][i] =
1854 fmt->rf_fields[loc].d[i]->rmf_size;
1855 if (pill->rc_area[loc][i] == -1) {
1857 * Skip the following fields.
1859 * If this LASSERT() trips then you're missing a
1860 * call to req_capsule_set_size().
1862 LASSERT(loc != RCL_SERVER);
1869 EXPORT_SYMBOL(req_capsule_filled_sizes);
1872 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1874 * This function uses the \a pill's \a rc_area as filled in by
1875 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1878 int req_capsule_server_pack(struct req_capsule *pill)
1880 const struct req_format *fmt;
1884 LASSERT(pill->rc_loc == RCL_SERVER);
1886 LASSERT(fmt != NULL);
1888 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1889 rc = lustre_pack_reply(pill->rc_req, count,
1890 pill->rc_area[RCL_SERVER], NULL);
1892 DEBUG_REQ(D_ERROR, pill->rc_req,
1893 "Cannot pack %d fields in format `%s': ",
1894 count, fmt->rf_name);
1898 EXPORT_SYMBOL(req_capsule_server_pack);
1901 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1902 * corresponding to the given RMF (\a field).
1904 __u32 __req_capsule_offset(const struct req_capsule *pill,
1905 const struct req_msg_field *field,
1906 enum req_location loc)
1908 unsigned int offset;
1910 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1911 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1912 pill->rc_fmt->rf_name,
1913 field->rmf_name, offset, loc);
1916 LASSERT(offset < REQ_MAX_FIELD_NR);
1921 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1926 swabber_dumper_helper(struct req_capsule *pill,
1927 const struct req_msg_field *field,
1928 enum req_location loc,
1930 void *value, int len, int dump, void (*swabber)( void *))
1936 int inout = loc == RCL_CLIENT;
1938 swabber = swabber ?: field->rmf_swabber;
1940 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1941 swabber != NULL && value != NULL)
1946 if (!field->rmf_dumper)
1949 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1951 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1952 do_swab ? "unswabbed " : "", field->rmf_name);
1953 field->rmf_dumper(value);
1958 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1960 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1961 "follows\n", field->rmf_name);
1962 field->rmf_dumper(value);
1969 * We're swabbing an array; swabber() swabs a single array element, so
1970 * swab every element.
1972 LASSERT((len % field->rmf_size) == 0);
1973 for (p = value, i = 0, n = len / field->rmf_size;
1975 i++, p += field->rmf_size) {
1977 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1978 "element %d follows\n",
1979 do_swab ? "unswabbed " : "", field->rmf_name, i);
1980 field->rmf_dumper(p);
1986 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1987 "element %d follows\n", field->rmf_name, i);
1988 field->rmf_dumper(value);
1992 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1996 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1997 * corresponding to the given RMF (\a field).
1999 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2000 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2001 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2002 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2003 * element of the array swabbed.
2005 static void *__req_capsule_get(struct req_capsule *pill,
2006 const struct req_msg_field *field,
2007 enum req_location loc,
2008 void (*swabber)( void *),
2011 const struct req_format *fmt;
2012 struct lustre_msg *msg;
2017 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2019 static const char *rcl_names[RCL_NR] = {
2020 [RCL_CLIENT] = "client",
2021 [RCL_SERVER] = "server"
2024 LASSERT(pill != NULL);
2025 LASSERT(pill != LP_POISON);
2027 LASSERT(fmt != NULL);
2028 LASSERT(fmt != LP_POISON);
2029 LASSERT(__req_format_is_sane(fmt));
2031 offset = __req_capsule_offset(pill, field, loc);
2033 msg = __req_msg(pill, loc);
2034 LASSERT(msg != NULL);
2036 getter = (field->rmf_flags & RMF_F_STRING) ?
2037 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2039 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2041 * We've already asserted that field->rmf_size > 0 in
2042 * req_layout_init().
2044 len = lustre_msg_buflen(msg, offset);
2045 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2046 (len % field->rmf_size) != 0) {
2047 CERROR("%s: array field size mismatch "
2048 "%d modulo %u != 0 (%d)\n",
2049 field->rmf_name, len, field->rmf_size, loc);
2052 } else if (pill->rc_area[loc][offset] != -1) {
2053 len = pill->rc_area[loc][offset];
2055 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2057 value = getter(msg, offset, len);
2059 if (value == NULL) {
2060 DEBUG_REQ(D_ERROR, pill->rc_req,
2061 "Wrong buffer for field `%s' (%u of %u) "
2062 "in format `%s': %u vs. %u (%s)\n",
2063 field->rmf_name, offset, lustre_msg_bufcount(msg),
2064 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2067 swabber_dumper_helper(pill, field, loc, offset, value, len,
2075 * Dump a request and/or reply
2077 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2079 const struct req_format *fmt;
2080 const struct req_msg_field *field;
2086 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2087 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2088 field = FMT_FIELD(fmt, loc, i);
2089 if (field->rmf_dumper == NULL) {
2091 * FIXME Add a default hex dumper for fields that don't
2092 * have a specific dumper
2094 len = req_capsule_get_size(pill, field, loc);
2095 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2096 "field size is %u\n", field->rmf_name, len);
2098 /* It's the dumping side-effect that we're interested in */
2099 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2102 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2108 void req_capsule_client_dump(struct req_capsule *pill)
2110 __req_capsule_dump(pill, RCL_CLIENT);
2112 EXPORT_SYMBOL(req_capsule_client_dump);
2117 void req_capsule_server_dump(struct req_capsule *pill)
2119 __req_capsule_dump(pill, RCL_SERVER);
2121 EXPORT_SYMBOL(req_capsule_server_dump);
2124 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2125 * buffer corresponding to the given RMF (\a field) of a \a pill.
2127 void *req_capsule_client_get(struct req_capsule *pill,
2128 const struct req_msg_field *field)
2130 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2132 EXPORT_SYMBOL(req_capsule_client_get);
2135 * Same as req_capsule_client_get(), but with a \a swabber argument.
2137 * Currently unused; will be removed when req_capsule_server_swab_get() is
2140 void *req_capsule_client_swab_get(struct req_capsule *pill,
2141 const struct req_msg_field *field,
2144 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2146 EXPORT_SYMBOL(req_capsule_client_swab_get);
2149 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2151 * First the \a pill's request \a field's size is set (\a rc_area) using
2152 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2155 void *req_capsule_client_sized_get(struct req_capsule *pill,
2156 const struct req_msg_field *field,
2159 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2160 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2162 EXPORT_SYMBOL(req_capsule_client_sized_get);
2165 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2166 * buffer corresponding to the given RMF (\a field) of a \a pill.
2168 void *req_capsule_server_get(struct req_capsule *pill,
2169 const struct req_msg_field *field)
2171 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2173 EXPORT_SYMBOL(req_capsule_server_get);
2176 * Same as req_capsule_server_get(), but with a \a swabber argument.
2178 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2179 * swabbing done outside this capsule abstraction.
2181 void *req_capsule_server_swab_get(struct req_capsule *pill,
2182 const struct req_msg_field *field,
2185 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2187 EXPORT_SYMBOL(req_capsule_server_swab_get);
2190 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2192 * First the \a pill's request \a field's size is set (\a rc_area) using
2193 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2196 void *req_capsule_server_sized_get(struct req_capsule *pill,
2197 const struct req_msg_field *field,
2200 req_capsule_set_size(pill, field, RCL_SERVER, len);
2201 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2203 EXPORT_SYMBOL(req_capsule_server_sized_get);
2205 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2206 const struct req_msg_field *field,
2207 __u32 len, void *swabber)
2209 req_capsule_set_size(pill, field, RCL_SERVER, len);
2210 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2212 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2215 * Returns the buffer of a \a pill corresponding to the given \a field from the
2216 * request (if the caller is executing on the server-side) or reply (if the
2217 * caller is executing on the client-side).
2219 * This function convienient for use is code that could be executed on the
2220 * client and server alike.
2222 const void *req_capsule_other_get(struct req_capsule *pill,
2223 const struct req_msg_field *field)
2225 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2227 EXPORT_SYMBOL(req_capsule_other_get);
2230 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2231 * field of the given \a pill.
2233 * This function must be used when constructing variable sized fields of a
2236 void req_capsule_set_size(struct req_capsule *pill,
2237 const struct req_msg_field *field,
2238 enum req_location loc, __u32 size)
2240 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2242 if ((size != (__u32)field->rmf_size) &&
2243 (field->rmf_size != -1) &&
2244 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2246 __u32 rmf_size = (__u32)field->rmf_size;
2247 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2248 (size % rmf_size != 0)) {
2249 CERROR("%s: array field size mismatch "
2250 "%u %% %u != 0 (%d)\n",
2251 field->rmf_name, size, rmf_size, loc);
2253 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2255 CERROR("%s: field size mismatch %u != %u (%d)\n",
2256 field->rmf_name, size, rmf_size, loc);
2261 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2263 EXPORT_SYMBOL(req_capsule_set_size);
2266 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2267 * for the given \a pill's given \a field.
2269 * NB: this function doesn't correspond with req_capsule_set_size(), which
2270 * actually sets the size in pill.rc_area[loc][offset], but this function
2271 * returns the message buflen[offset], maybe we should use another name.
2273 __u32 req_capsule_get_size(const struct req_capsule *pill,
2274 const struct req_msg_field *field,
2275 enum req_location loc)
2277 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2279 return lustre_msg_buflen(__req_msg(pill, loc),
2280 __req_capsule_offset(pill, field, loc));
2282 EXPORT_SYMBOL(req_capsule_get_size);
2285 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2286 * given \a pill's request or reply (\a loc) given the field size recorded in
2287 * the \a pill's rc_area.
2289 * See also req_capsule_set_size().
2291 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2293 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2294 pill->rc_fmt->rf_fields[loc].nr,
2295 pill->rc_area[loc]);
2299 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2300 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2301 * PTLRPC request or reply given only an RQF (\a fmt).
2303 * This function should not be used for formats which contain variable size
2306 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2307 enum req_location loc)
2313 * This function should probably LASSERT() that fmt has no fields with
2314 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2315 * elements in the array there will ultimately be, but then, we could
2316 * assume that there will be at least one element, and that's just what
2319 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2323 for (; i < fmt->rf_fields[loc].nr; ++i)
2324 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2325 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2331 * Changes the format of an RPC.
2333 * The pill must already have been initialized, which means that it already has
2334 * a request format. The new format \a fmt must be an extension of the pill's
2335 * old format. Specifically: the new format must have as many request and reply
2336 * fields as the old one, and all fields shared by the old and new format must
2337 * be at least as large in the new format.
2339 * The new format's fields may be of different "type" than the old format, but
2340 * only for fields that are "opaque" blobs: fields which have a) have no
2341 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2342 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2343 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2344 * according to the key field. When the value, according to the key, contains a
2345 * structure (or array thereof) to be swabbed, the format should be changed to
2346 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2349 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2354 const struct req_format *old;
2356 LASSERT(pill->rc_fmt != NULL);
2357 LASSERT(__req_format_is_sane(fmt));
2361 * Sanity checking...
2363 for (i = 0; i < RCL_NR; ++i) {
2364 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2365 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2366 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2368 /* "opaque" fields can be transmogrified */
2369 if (ofield->rmf_swabber == NULL &&
2370 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2371 (ofield->rmf_size == -1 ||
2372 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2374 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2377 * Last field in old format can be shorter than in new.
2379 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2380 FMT_FIELD(old, i, j)->rmf_size);
2385 EXPORT_SYMBOL(req_capsule_extend);
2388 * This function returns a non-zero value if the given \a field is present in
2389 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2392 int req_capsule_has_field(const struct req_capsule *pill,
2393 const struct req_msg_field *field,
2394 enum req_location loc)
2396 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2398 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2400 EXPORT_SYMBOL(req_capsule_has_field);
2403 * Returns a non-zero value if the given \a field is present in the given \a
2404 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2406 int req_capsule_field_present(const struct req_capsule *pill,
2407 const struct req_msg_field *field,
2408 enum req_location loc)
2412 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2413 LASSERT(req_capsule_has_field(pill, field, loc));
2415 offset = __req_capsule_offset(pill, field, loc);
2416 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2418 EXPORT_SYMBOL(req_capsule_field_present);
2421 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2422 * request or reply (\a loc).
2424 * This is not the opposite of req_capsule_extend().
2426 void req_capsule_shrink(struct req_capsule *pill,
2427 const struct req_msg_field *field,
2429 enum req_location loc)
2431 const struct req_format *fmt;
2432 struct lustre_msg *msg;
2437 LASSERT(fmt != NULL);
2438 LASSERT(__req_format_is_sane(fmt));
2439 LASSERT(req_capsule_has_field(pill, field, loc));
2440 LASSERT(req_capsule_field_present(pill, field, loc));
2442 offset = __req_capsule_offset(pill, field, loc);
2444 msg = __req_msg(pill, loc);
2445 len = lustre_msg_buflen(msg, offset);
2446 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2447 fmt->rf_name, field->rmf_name, len, newlen);
2449 if (loc == RCL_CLIENT)
2450 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2453 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2456 EXPORT_SYMBOL(req_capsule_shrink);
2458 int req_capsule_server_grow(struct req_capsule *pill,
2459 const struct req_msg_field *field,
2462 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2467 LASSERT(pill->rc_fmt != NULL);
2468 LASSERT(__req_format_is_sane(pill->rc_fmt));
2469 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2470 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2472 len = req_capsule_get_size(pill, field, RCL_SERVER);
2473 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2474 if ((__u32)pill->rc_req->rq_repbuf_len >=
2475 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2476 CERROR("Inplace repack might be done\n");
2478 pill->rc_req->rq_reply_state = NULL;
2479 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2480 rc = req_capsule_server_pack(pill);
2482 /* put old rs back, the caller will decide what to do */
2483 pill->rc_req->rq_reply_state = rs;
2486 nrs = pill->rc_req->rq_reply_state;
2487 /* Now we need only buffers, copy first chunk */
2488 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2489 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2490 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2491 memcpy(to, from, len);
2492 /* check if we have tail and copy it too */
2493 if (rs->rs_msg->lm_bufcount > offset + 1) {
2494 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2495 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2496 offset = rs->rs_msg->lm_bufcount - 1;
2497 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2498 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2499 memcpy(to, from, len);
2501 /* drop old reply if everything is fine */
2502 if (rs->rs_difficult) {
2506 nrs->rs_difficult = 1;
2507 nrs->rs_no_ack = rs->rs_no_ack;
2508 nrs->rs_convert_lock = rs->rs_convert_lock;
2509 for (i = 0; i < rs->rs_nlocks; i++) {
2510 nrs->rs_locks[i] = rs->rs_locks[i];
2511 nrs->rs_modes[i] = rs->rs_modes[i];
2515 rs->rs_difficult = 0;
2518 ptlrpc_rs_decref(rs);
2521 EXPORT_SYMBOL(req_capsule_server_grow);