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, sizeof(struct lustre_capa),
1089 lustre_swab_lustre_capa, NULL);
1090 EXPORT_SYMBOL(RMF_CAPA1);
1092 struct req_msg_field RMF_CAPA2 =
1093 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1094 lustre_swab_lustre_capa, NULL);
1095 EXPORT_SYMBOL(RMF_CAPA2);
1097 struct req_msg_field RMF_LAYOUT_INTENT =
1098 DEFINE_MSGF("layout_intent", 0,
1099 sizeof(struct layout_intent), lustre_swab_layout_intent,
1101 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1104 * OST request field.
1106 struct req_msg_field RMF_OST_BODY =
1107 DEFINE_MSGF("ost_body", 0,
1108 sizeof(struct ost_body), lustre_swab_ost_body,
1110 EXPORT_SYMBOL(RMF_OST_BODY);
1112 struct req_msg_field RMF_OBD_IOOBJ =
1113 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1114 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1115 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1117 struct req_msg_field RMF_NIOBUF_REMOTE =
1118 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1119 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1121 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1123 struct req_msg_field RMF_NIOBUF_INLINE =
1124 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1125 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1127 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1129 struct req_msg_field RMF_RCS =
1130 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1131 lustre_swab_generic_32s, dump_rcs);
1132 EXPORT_SYMBOL(RMF_RCS);
1134 struct req_msg_field RMF_EAVALS_LENS =
1135 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1136 lustre_swab_generic_32s, NULL);
1137 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1139 struct req_msg_field RMF_OBD_ID =
1140 DEFINE_MSGF("obd_id", 0,
1141 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1142 EXPORT_SYMBOL(RMF_OBD_ID);
1144 struct req_msg_field RMF_FID =
1145 DEFINE_MSGF("fid", 0,
1146 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1147 EXPORT_SYMBOL(RMF_FID);
1149 struct req_msg_field RMF_OST_ID =
1150 DEFINE_MSGF("ost_id", 0,
1151 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1152 EXPORT_SYMBOL(RMF_OST_ID);
1154 struct req_msg_field RMF_FIEMAP_KEY =
1155 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1156 lustre_swab_fiemap, NULL);
1157 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1159 struct req_msg_field RMF_FIEMAP_VAL =
1160 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1161 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1163 struct req_msg_field RMF_IDX_INFO =
1164 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1165 lustre_swab_idx_info, NULL);
1166 EXPORT_SYMBOL(RMF_IDX_INFO);
1167 struct req_msg_field RMF_SHORT_IO =
1168 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1169 EXPORT_SYMBOL(RMF_SHORT_IO);
1170 struct req_msg_field RMF_HSM_USER_STATE =
1171 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1172 lustre_swab_hsm_user_state, NULL);
1173 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1175 struct req_msg_field RMF_HSM_STATE_SET =
1176 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1177 lustre_swab_hsm_state_set, NULL);
1178 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1180 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1181 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1182 lustre_swab_hsm_progress_kernel, NULL);
1183 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1185 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1186 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1187 lustre_swab_hsm_current_action, NULL);
1188 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1190 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1191 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1192 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1194 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1196 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1197 DEFINE_MSGF("hsm_archive", 0,
1198 sizeof(__u32), lustre_swab_generic_32s, NULL);
1199 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1201 struct req_msg_field RMF_MDS_HSM_REQUEST =
1202 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1203 lustre_swab_hsm_request, NULL);
1204 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1206 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1207 lustre_swab_object_update_request, NULL);
1208 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1210 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1211 DEFINE_MSGF("object_update_reply", 0, -1,
1212 lustre_swab_object_update_reply, NULL);
1213 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1215 struct req_msg_field RMF_SWAP_LAYOUTS =
1216 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1217 lustre_swab_swap_layouts, NULL);
1218 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1220 struct req_msg_field RMF_LFSCK_REQUEST =
1221 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1222 lustre_swab_lfsck_request, NULL);
1223 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1225 struct req_msg_field RMF_LFSCK_REPLY =
1226 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1227 lustre_swab_lfsck_reply, NULL);
1228 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1230 struct req_msg_field RMF_OST_LADVISE_HDR =
1231 DEFINE_MSGF("ladvise_request", 0,
1232 sizeof(struct ladvise_hdr),
1233 lustre_swab_ladvise_hdr, NULL);
1234 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1236 struct req_msg_field RMF_OST_LADVISE =
1237 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1238 sizeof(struct lu_ladvise),
1239 lustre_swab_ladvise, NULL);
1240 EXPORT_SYMBOL(RMF_OST_LADVISE);
1242 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1243 -1, lustre_swab_out_update_header, NULL);
1244 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1246 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1247 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1248 lustre_swab_out_update_buffer, NULL);
1249 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1256 const char *rf_name;
1260 const struct req_msg_field **d;
1261 } rf_fields[RCL_NR];
1264 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1278 #define DEFINE_REQ_FMT0(name, client, server) \
1279 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1281 struct req_format RQF_OBD_PING =
1282 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1283 EXPORT_SYMBOL(RQF_OBD_PING);
1285 struct req_format RQF_OBD_SET_INFO =
1286 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1287 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1289 /* Read index file through the network */
1290 struct req_format RQF_OBD_IDX_READ =
1291 DEFINE_REQ_FMT0("OBD_IDX_READ",
1292 obd_idx_read_client, obd_idx_read_server);
1293 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1295 struct req_format RQF_SEC_CTX =
1296 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1297 EXPORT_SYMBOL(RQF_SEC_CTX);
1299 struct req_format RQF_MGS_TARGET_REG =
1300 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1301 mgs_target_info_only);
1302 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1304 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1305 struct req_format RQF_MGS_SET_INFO =
1306 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1308 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1311 struct req_format RQF_MGS_CONFIG_READ =
1312 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1313 mgs_config_read_server);
1314 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1316 struct req_format RQF_SEQ_QUERY =
1317 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1318 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1320 struct req_format RQF_FLD_QUERY =
1321 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1322 EXPORT_SYMBOL(RQF_FLD_QUERY);
1324 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1325 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1326 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1327 * peers need to handle the RPC reply with fixed little-endian format.
1329 * In theory, we can define new structure with some swabber registered to
1330 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1331 * implementation view, it is not easy to be done within current "struct
1332 * req_msg_field" framework. Because the sequence range array in the RPC
1333 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1334 * count, that is unknown when prepare the RPC buffer. Generally, for such
1335 * flexible length RPC usage, there will be a field in the RPC layout to
1336 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1337 * do that unless we add new length filed that will broken the on-wire RPC
1338 * protocol and cause interoperability trouble with old peer. */
1339 struct req_format RQF_FLD_READ =
1340 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1341 EXPORT_SYMBOL(RQF_FLD_READ);
1343 struct req_format RQF_MDS_QUOTACTL =
1344 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1345 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1347 struct req_format RQF_OST_QUOTACTL =
1348 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1349 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1351 struct req_format RQF_QUOTA_DQACQ =
1352 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1353 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1355 struct req_format RQF_LDLM_INTENT_QUOTA =
1356 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1357 ldlm_intent_quota_client,
1358 ldlm_intent_quota_server);
1359 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1361 struct req_format RQF_MDS_GET_ROOT =
1362 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1363 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1365 struct req_format RQF_MDS_STATFS =
1366 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1367 EXPORT_SYMBOL(RQF_MDS_STATFS);
1369 struct req_format RQF_MDS_SYNC =
1370 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1371 EXPORT_SYMBOL(RQF_MDS_SYNC);
1373 struct req_format RQF_MDS_GETATTR =
1374 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1375 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1377 struct req_format RQF_MDS_GETXATTR =
1378 DEFINE_REQ_FMT0("MDS_GETXATTR",
1379 mds_getxattr_client, mds_getxattr_server);
1380 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1382 struct req_format RQF_MDS_GETATTR_NAME =
1383 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1384 mds_getattr_name_client, mds_getattr_server);
1385 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1387 struct req_format RQF_MDS_REINT =
1388 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1389 EXPORT_SYMBOL(RQF_MDS_REINT);
1391 struct req_format RQF_MDS_REINT_CREATE =
1392 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1393 mds_reint_create_client, mdt_body_capa);
1394 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1396 struct req_format RQF_MDS_REINT_CREATE_ACL =
1397 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1398 mds_reint_create_acl_client, mdt_body_capa);
1399 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1401 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1402 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1403 mds_reint_create_slave_client, mdt_body_capa);
1404 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1406 struct req_format RQF_MDS_REINT_CREATE_SYM =
1407 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1408 mds_reint_create_sym_client, mdt_body_capa);
1409 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1411 struct req_format RQF_MDS_REINT_OPEN =
1412 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1413 mds_reint_open_client, mds_reint_open_server);
1414 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1416 struct req_format RQF_MDS_REINT_UNLINK =
1417 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1418 mds_last_unlink_server);
1419 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1421 struct req_format RQF_MDS_REINT_LINK =
1422 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1423 mds_reint_link_client, mdt_body_only);
1424 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1426 struct req_format RQF_MDS_REINT_RENAME =
1427 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1428 mds_last_unlink_server);
1429 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1431 struct req_format RQF_MDS_REINT_MIGRATE =
1432 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1433 mds_last_unlink_server);
1434 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1436 struct req_format RQF_MDS_REINT_SETATTR =
1437 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1438 mds_reint_setattr_client, mds_setattr_server);
1439 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1441 struct req_format RQF_MDS_REINT_SETXATTR =
1442 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1443 mds_reint_setxattr_client, mdt_body_only);
1444 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1446 struct req_format RQF_MDS_REINT_RESYNC =
1447 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1448 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1450 struct req_format RQF_MDS_CONNECT =
1451 DEFINE_REQ_FMT0("MDS_CONNECT",
1452 obd_connect_client, obd_connect_server);
1453 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1455 struct req_format RQF_MDS_DISCONNECT =
1456 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1457 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1459 struct req_format RQF_MDS_GET_INFO =
1460 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1461 mds_getinfo_server);
1462 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1464 struct req_format RQF_OUT_UPDATE =
1465 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1467 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1469 struct req_format RQF_LDLM_ENQUEUE =
1470 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1471 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1472 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1474 struct req_format RQF_LDLM_ENQUEUE_LVB =
1475 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1476 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1477 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1479 struct req_format RQF_LDLM_CONVERT =
1480 DEFINE_REQ_FMT0("LDLM_CONVERT",
1481 ldlm_enqueue_client, ldlm_enqueue_server);
1482 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1484 struct req_format RQF_LDLM_CANCEL =
1485 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1486 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1488 struct req_format RQF_LDLM_CALLBACK =
1489 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1490 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1492 struct req_format RQF_LDLM_CP_CALLBACK =
1493 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1494 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1496 struct req_format RQF_LDLM_BL_CALLBACK =
1497 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1498 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1500 struct req_format RQF_LDLM_GL_CALLBACK =
1501 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1502 ldlm_gl_callback_server);
1503 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1505 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1506 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1507 ldlm_gl_callback_server);
1508 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1510 struct req_format RQF_LDLM_INTENT_BASIC =
1511 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1512 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1513 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1515 struct req_format RQF_LDLM_INTENT =
1516 DEFINE_REQ_FMT0("LDLM_INTENT",
1517 ldlm_intent_client, ldlm_intent_server);
1518 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1520 struct req_format RQF_LDLM_INTENT_LAYOUT =
1521 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1522 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1523 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1525 struct req_format RQF_LDLM_INTENT_GETATTR =
1526 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1527 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1528 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1530 struct req_format RQF_LDLM_INTENT_OPEN =
1531 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1532 ldlm_intent_open_client, ldlm_intent_open_server);
1533 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1535 struct req_format RQF_LDLM_INTENT_CREATE =
1536 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1537 ldlm_intent_create_client, ldlm_intent_getattr_server);
1538 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1540 struct req_format RQF_LDLM_INTENT_GETXATTR =
1541 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1542 ldlm_intent_getxattr_client,
1543 ldlm_intent_getxattr_server);
1544 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1546 struct req_format RQF_MDS_CLOSE =
1547 DEFINE_REQ_FMT0("MDS_CLOSE",
1548 mdt_close_client, mds_last_unlink_server);
1549 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1551 struct req_format RQF_MDS_CLOSE_INTENT =
1552 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1553 mdt_close_intent_client, mds_last_unlink_server);
1554 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1556 struct req_format RQF_MDS_READPAGE =
1557 DEFINE_REQ_FMT0("MDS_READPAGE",
1558 mdt_body_capa, mdt_body_only);
1559 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1561 struct req_format RQF_MDS_HSM_ACTION =
1562 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1563 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1565 struct req_format RQF_MDS_HSM_PROGRESS =
1566 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1567 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1569 struct req_format RQF_MDS_HSM_CT_REGISTER =
1570 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1571 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1573 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1574 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1575 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1577 struct req_format RQF_MDS_HSM_STATE_GET =
1578 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1579 mdt_body_capa, mdt_hsm_state_get_server);
1580 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1582 struct req_format RQF_MDS_HSM_STATE_SET =
1583 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1584 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1586 struct req_format RQF_MDS_HSM_REQUEST =
1587 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1588 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1590 struct req_format RQF_MDS_SWAP_LAYOUTS =
1591 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1592 mdt_swap_layouts, empty);
1593 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1595 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1596 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1597 llog_origin_handle_create_client, llogd_body_only);
1598 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1600 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1601 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1602 llogd_body_only, llog_origin_handle_next_block_server);
1603 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1605 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1606 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1607 llogd_body_only, llog_origin_handle_next_block_server);
1608 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1610 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1611 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1612 llogd_body_only, llog_log_hdr_only);
1613 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1615 struct req_format RQF_CONNECT =
1616 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1617 EXPORT_SYMBOL(RQF_CONNECT);
1619 struct req_format RQF_OST_CONNECT =
1620 DEFINE_REQ_FMT0("OST_CONNECT",
1621 obd_connect_client, obd_connect_server);
1622 EXPORT_SYMBOL(RQF_OST_CONNECT);
1624 struct req_format RQF_OST_DISCONNECT =
1625 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1626 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1628 struct req_format RQF_OST_GETATTR =
1629 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1630 EXPORT_SYMBOL(RQF_OST_GETATTR);
1632 struct req_format RQF_OST_SETATTR =
1633 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1634 EXPORT_SYMBOL(RQF_OST_SETATTR);
1636 struct req_format RQF_OST_CREATE =
1637 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1638 EXPORT_SYMBOL(RQF_OST_CREATE);
1640 struct req_format RQF_OST_PUNCH =
1641 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1642 EXPORT_SYMBOL(RQF_OST_PUNCH);
1644 struct req_format RQF_OST_SYNC =
1645 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1646 EXPORT_SYMBOL(RQF_OST_SYNC);
1648 struct req_format RQF_OST_DESTROY =
1649 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1650 EXPORT_SYMBOL(RQF_OST_DESTROY);
1652 struct req_format RQF_OST_BRW_READ =
1653 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1654 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1656 struct req_format RQF_OST_BRW_WRITE =
1657 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1658 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1660 struct req_format RQF_OST_STATFS =
1661 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1662 EXPORT_SYMBOL(RQF_OST_STATFS);
1664 struct req_format RQF_OST_SET_GRANT_INFO =
1665 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1667 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1669 struct req_format RQF_OST_GET_INFO =
1670 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1671 ost_get_info_generic_server);
1672 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1674 struct req_format RQF_OST_GET_INFO_LAST_ID =
1675 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1676 ost_get_last_id_server);
1677 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1679 struct req_format RQF_OST_GET_INFO_LAST_FID =
1680 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1681 ost_get_last_fid_server);
1682 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1684 struct req_format RQF_OST_SET_INFO_LAST_FID =
1685 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1687 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1689 struct req_format RQF_OST_GET_INFO_FIEMAP =
1690 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1691 ost_get_fiemap_server);
1692 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1694 struct req_format RQF_LFSCK_NOTIFY =
1695 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1696 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1698 struct req_format RQF_LFSCK_QUERY =
1699 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1700 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1702 struct req_format RQF_OST_LADVISE =
1703 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1704 EXPORT_SYMBOL(RQF_OST_LADVISE);
1706 /* Convenience macro */
1707 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1710 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1711 * field of RQFs and the \a rmf_offset field of RMFs.
1713 int req_layout_init(void)
1718 struct req_format *rf = NULL;
1720 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1721 rf = req_formats[i];
1723 for (j = 0; j < RCL_NR; ++j) {
1724 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1725 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1726 struct req_msg_field *field;
1728 field = (typeof(field))rf->rf_fields[j].d[k];
1729 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1730 || field->rmf_size > 0);
1731 LASSERT(field->rmf_offset[i][j] == 0);
1733 * k + 1 to detect unused format/field
1736 field->rmf_offset[i][j] = k + 1;
1742 EXPORT_SYMBOL(req_layout_init);
1744 void req_layout_fini(void)
1747 EXPORT_SYMBOL(req_layout_fini);
1750 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1752 * Actual/expected field sizes are set elsewhere in functions in this file:
1753 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1754 * req_capsule_msg_size(). The \a rc_area information is used by.
1755 * ptlrpc_request_set_replen().
1757 void req_capsule_init_area(struct req_capsule *pill)
1761 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1762 pill->rc_area[RCL_CLIENT][i] = -1;
1763 pill->rc_area[RCL_SERVER][i] = -1;
1766 EXPORT_SYMBOL(req_capsule_init_area);
1769 * Initialize a pill.
1771 * The \a location indicates whether the caller is executing on the client side
1772 * (RCL_CLIENT) or server side (RCL_SERVER)..
1774 void req_capsule_init(struct req_capsule *pill,
1775 struct ptlrpc_request *req,
1776 enum req_location location)
1778 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1781 * Today all capsules are embedded in ptlrpc_request structs,
1782 * but just in case that ever isn't the case, we don't reach
1783 * into req unless req != NULL and pill is the one embedded in
1786 * The req->rq_pill_init flag makes it safe to initialize a pill
1787 * twice, which might happen in the OST paths as a result of the
1788 * high-priority RPC queue getting peeked at before ost_handle()
1789 * handles an OST RPC.
1791 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1794 memset(pill, 0, sizeof *pill);
1796 pill->rc_loc = location;
1797 req_capsule_init_area(pill);
1799 if (req != NULL && pill == &req->rq_pill)
1800 req->rq_pill_init = 1;
1802 EXPORT_SYMBOL(req_capsule_init);
1804 void req_capsule_fini(struct req_capsule *pill)
1807 EXPORT_SYMBOL(req_capsule_fini);
1809 static int __req_format_is_sane(const struct req_format *fmt)
1811 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1812 req_formats[fmt->rf_idx] == fmt;
1815 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1816 enum req_location loc)
1818 struct ptlrpc_request *req;
1821 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1825 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1826 * (see req_capsule_extend()).
1828 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1830 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1831 LASSERT(__req_format_is_sane(fmt));
1835 EXPORT_SYMBOL(req_capsule_set);
1838 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1841 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1842 * variable-sized fields. The field sizes come from the declared \a rmf_size
1843 * field of a \a pill's \a rc_fmt's RMF's.
1845 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1846 enum req_location loc)
1848 const struct req_format *fmt = pill->rc_fmt;
1851 LASSERT(fmt != NULL);
1853 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1854 if (pill->rc_area[loc][i] == -1) {
1855 pill->rc_area[loc][i] =
1856 fmt->rf_fields[loc].d[i]->rmf_size;
1857 if (pill->rc_area[loc][i] == -1) {
1859 * Skip the following fields.
1861 * If this LASSERT() trips then you're missing a
1862 * call to req_capsule_set_size().
1864 LASSERT(loc != RCL_SERVER);
1871 EXPORT_SYMBOL(req_capsule_filled_sizes);
1874 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1876 * This function uses the \a pill's \a rc_area as filled in by
1877 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1880 int req_capsule_server_pack(struct req_capsule *pill)
1882 const struct req_format *fmt;
1886 LASSERT(pill->rc_loc == RCL_SERVER);
1888 LASSERT(fmt != NULL);
1890 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1891 rc = lustre_pack_reply(pill->rc_req, count,
1892 pill->rc_area[RCL_SERVER], NULL);
1894 DEBUG_REQ(D_ERROR, pill->rc_req,
1895 "Cannot pack %d fields in format `%s': ",
1896 count, fmt->rf_name);
1900 EXPORT_SYMBOL(req_capsule_server_pack);
1903 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1904 * corresponding to the given RMF (\a field).
1906 __u32 __req_capsule_offset(const struct req_capsule *pill,
1907 const struct req_msg_field *field,
1908 enum req_location loc)
1910 unsigned int offset;
1912 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1913 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1914 pill->rc_fmt->rf_name,
1915 field->rmf_name, offset, loc);
1918 LASSERT(offset < REQ_MAX_FIELD_NR);
1923 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1928 swabber_dumper_helper(struct req_capsule *pill,
1929 const struct req_msg_field *field,
1930 enum req_location loc,
1932 void *value, int len, int dump, void (*swabber)( void *))
1938 int inout = loc == RCL_CLIENT;
1940 swabber = swabber ?: field->rmf_swabber;
1942 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1943 swabber != NULL && value != NULL)
1948 if (!field->rmf_dumper)
1951 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1953 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1954 do_swab ? "unswabbed " : "", field->rmf_name);
1955 field->rmf_dumper(value);
1960 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1962 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1963 "follows\n", field->rmf_name);
1964 field->rmf_dumper(value);
1971 * We're swabbing an array; swabber() swabs a single array element, so
1972 * swab every element.
1974 LASSERT((len % field->rmf_size) == 0);
1975 for (p = value, i = 0, n = len / field->rmf_size;
1977 i++, p += field->rmf_size) {
1979 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1980 "element %d follows\n",
1981 do_swab ? "unswabbed " : "", field->rmf_name, i);
1982 field->rmf_dumper(p);
1988 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1989 "element %d follows\n", field->rmf_name, i);
1990 field->rmf_dumper(value);
1994 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1998 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1999 * corresponding to the given RMF (\a field).
2001 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2002 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2003 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2004 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2005 * element of the array swabbed.
2007 static void *__req_capsule_get(struct req_capsule *pill,
2008 const struct req_msg_field *field,
2009 enum req_location loc,
2010 void (*swabber)( void *),
2013 const struct req_format *fmt;
2014 struct lustre_msg *msg;
2019 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2021 static const char *rcl_names[RCL_NR] = {
2022 [RCL_CLIENT] = "client",
2023 [RCL_SERVER] = "server"
2026 LASSERT(pill != NULL);
2027 LASSERT(pill != LP_POISON);
2029 LASSERT(fmt != NULL);
2030 LASSERT(fmt != LP_POISON);
2031 LASSERT(__req_format_is_sane(fmt));
2033 offset = __req_capsule_offset(pill, field, loc);
2035 msg = __req_msg(pill, loc);
2036 LASSERT(msg != NULL);
2038 getter = (field->rmf_flags & RMF_F_STRING) ?
2039 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2041 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2043 * We've already asserted that field->rmf_size > 0 in
2044 * req_layout_init().
2046 len = lustre_msg_buflen(msg, offset);
2047 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2048 (len % field->rmf_size) != 0) {
2049 CERROR("%s: array field size mismatch "
2050 "%d modulo %u != 0 (%d)\n",
2051 field->rmf_name, len, field->rmf_size, loc);
2054 } else if (pill->rc_area[loc][offset] != -1) {
2055 len = pill->rc_area[loc][offset];
2057 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2059 value = getter(msg, offset, len);
2061 if (value == NULL) {
2062 DEBUG_REQ(D_ERROR, pill->rc_req,
2063 "Wrong buffer for field `%s' (%u of %u) "
2064 "in format `%s': %u vs. %u (%s)\n",
2065 field->rmf_name, offset, lustre_msg_bufcount(msg),
2066 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2069 swabber_dumper_helper(pill, field, loc, offset, value, len,
2077 * Dump a request and/or reply
2079 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2081 const struct req_format *fmt;
2082 const struct req_msg_field *field;
2088 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2089 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2090 field = FMT_FIELD(fmt, loc, i);
2091 if (field->rmf_dumper == NULL) {
2093 * FIXME Add a default hex dumper for fields that don't
2094 * have a specific dumper
2096 len = req_capsule_get_size(pill, field, loc);
2097 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2098 "field size is %u\n", field->rmf_name, len);
2100 /* It's the dumping side-effect that we're interested in */
2101 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2104 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2110 void req_capsule_client_dump(struct req_capsule *pill)
2112 __req_capsule_dump(pill, RCL_CLIENT);
2114 EXPORT_SYMBOL(req_capsule_client_dump);
2119 void req_capsule_server_dump(struct req_capsule *pill)
2121 __req_capsule_dump(pill, RCL_SERVER);
2123 EXPORT_SYMBOL(req_capsule_server_dump);
2126 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2127 * buffer corresponding to the given RMF (\a field) of a \a pill.
2129 void *req_capsule_client_get(struct req_capsule *pill,
2130 const struct req_msg_field *field)
2132 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2134 EXPORT_SYMBOL(req_capsule_client_get);
2137 * Same as req_capsule_client_get(), but with a \a swabber argument.
2139 * Currently unused; will be removed when req_capsule_server_swab_get() is
2142 void *req_capsule_client_swab_get(struct req_capsule *pill,
2143 const struct req_msg_field *field,
2146 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2148 EXPORT_SYMBOL(req_capsule_client_swab_get);
2151 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2153 * First the \a pill's request \a field's size is set (\a rc_area) using
2154 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2157 void *req_capsule_client_sized_get(struct req_capsule *pill,
2158 const struct req_msg_field *field,
2161 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2162 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2164 EXPORT_SYMBOL(req_capsule_client_sized_get);
2167 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2168 * buffer corresponding to the given RMF (\a field) of a \a pill.
2170 void *req_capsule_server_get(struct req_capsule *pill,
2171 const struct req_msg_field *field)
2173 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2175 EXPORT_SYMBOL(req_capsule_server_get);
2178 * Same as req_capsule_server_get(), but with a \a swabber argument.
2180 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2181 * swabbing done outside this capsule abstraction.
2183 void *req_capsule_server_swab_get(struct req_capsule *pill,
2184 const struct req_msg_field *field,
2187 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2189 EXPORT_SYMBOL(req_capsule_server_swab_get);
2192 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2194 * First the \a pill's request \a field's size is set (\a rc_area) using
2195 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2198 void *req_capsule_server_sized_get(struct req_capsule *pill,
2199 const struct req_msg_field *field,
2202 req_capsule_set_size(pill, field, RCL_SERVER, len);
2203 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2205 EXPORT_SYMBOL(req_capsule_server_sized_get);
2207 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2208 const struct req_msg_field *field,
2209 __u32 len, void *swabber)
2211 req_capsule_set_size(pill, field, RCL_SERVER, len);
2212 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2214 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2217 * Returns the buffer of a \a pill corresponding to the given \a field from the
2218 * request (if the caller is executing on the server-side) or reply (if the
2219 * caller is executing on the client-side).
2221 * This function convienient for use is code that could be executed on the
2222 * client and server alike.
2224 const void *req_capsule_other_get(struct req_capsule *pill,
2225 const struct req_msg_field *field)
2227 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2229 EXPORT_SYMBOL(req_capsule_other_get);
2232 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2233 * field of the given \a pill.
2235 * This function must be used when constructing variable sized fields of a
2238 void req_capsule_set_size(struct req_capsule *pill,
2239 const struct req_msg_field *field,
2240 enum req_location loc, __u32 size)
2242 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2244 if ((size != (__u32)field->rmf_size) &&
2245 (field->rmf_size != -1) &&
2246 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2248 __u32 rmf_size = (__u32)field->rmf_size;
2249 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2250 (size % rmf_size != 0)) {
2251 CERROR("%s: array field size mismatch "
2252 "%u %% %u != 0 (%d)\n",
2253 field->rmf_name, size, rmf_size, loc);
2255 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2257 CERROR("%s: field size mismatch %u != %u (%d)\n",
2258 field->rmf_name, size, rmf_size, loc);
2263 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2265 EXPORT_SYMBOL(req_capsule_set_size);
2268 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2269 * for the given \a pill's given \a field.
2271 * NB: this function doesn't correspond with req_capsule_set_size(), which
2272 * actually sets the size in pill.rc_area[loc][offset], but this function
2273 * returns the message buflen[offset], maybe we should use another name.
2275 __u32 req_capsule_get_size(const struct req_capsule *pill,
2276 const struct req_msg_field *field,
2277 enum req_location loc)
2279 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2281 return lustre_msg_buflen(__req_msg(pill, loc),
2282 __req_capsule_offset(pill, field, loc));
2284 EXPORT_SYMBOL(req_capsule_get_size);
2287 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2288 * given \a pill's request or reply (\a loc) given the field size recorded in
2289 * the \a pill's rc_area.
2291 * See also req_capsule_set_size().
2293 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2295 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2296 pill->rc_fmt->rf_fields[loc].nr,
2297 pill->rc_area[loc]);
2301 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2302 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2303 * PTLRPC request or reply given only an RQF (\a fmt).
2305 * This function should not be used for formats which contain variable size
2308 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2309 enum req_location loc)
2315 * This function should probably LASSERT() that fmt has no fields with
2316 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2317 * elements in the array there will ultimately be, but then, we could
2318 * assume that there will be at least one element, and that's just what
2321 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2325 for (; i < fmt->rf_fields[loc].nr; ++i)
2326 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2327 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2333 * Changes the format of an RPC.
2335 * The pill must already have been initialized, which means that it already has
2336 * a request format. The new format \a fmt must be an extension of the pill's
2337 * old format. Specifically: the new format must have as many request and reply
2338 * fields as the old one, and all fields shared by the old and new format must
2339 * be at least as large in the new format.
2341 * The new format's fields may be of different "type" than the old format, but
2342 * only for fields that are "opaque" blobs: fields which have a) have no
2343 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2344 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2345 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2346 * according to the key field. When the value, according to the key, contains a
2347 * structure (or array thereof) to be swabbed, the format should be changed to
2348 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2351 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2356 const struct req_format *old;
2358 LASSERT(pill->rc_fmt != NULL);
2359 LASSERT(__req_format_is_sane(fmt));
2363 * Sanity checking...
2365 for (i = 0; i < RCL_NR; ++i) {
2366 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2367 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2368 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2370 /* "opaque" fields can be transmogrified */
2371 if (ofield->rmf_swabber == NULL &&
2372 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2373 (ofield->rmf_size == -1 ||
2374 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2376 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2379 * Last field in old format can be shorter than in new.
2381 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2382 FMT_FIELD(old, i, j)->rmf_size);
2387 EXPORT_SYMBOL(req_capsule_extend);
2390 * This function returns a non-zero value if the given \a field is present in
2391 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2394 int req_capsule_has_field(const struct req_capsule *pill,
2395 const struct req_msg_field *field,
2396 enum req_location loc)
2398 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2400 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2402 EXPORT_SYMBOL(req_capsule_has_field);
2405 * Returns a non-zero value if the given \a field is present in the given \a
2406 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2408 int req_capsule_field_present(const struct req_capsule *pill,
2409 const struct req_msg_field *field,
2410 enum req_location loc)
2414 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2415 LASSERT(req_capsule_has_field(pill, field, loc));
2417 offset = __req_capsule_offset(pill, field, loc);
2418 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2420 EXPORT_SYMBOL(req_capsule_field_present);
2423 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2424 * request or reply (\a loc).
2426 * This is not the opposite of req_capsule_extend().
2428 void req_capsule_shrink(struct req_capsule *pill,
2429 const struct req_msg_field *field,
2431 enum req_location loc)
2433 const struct req_format *fmt;
2434 struct lustre_msg *msg;
2439 LASSERT(fmt != NULL);
2440 LASSERT(__req_format_is_sane(fmt));
2441 LASSERT(req_capsule_has_field(pill, field, loc));
2442 LASSERT(req_capsule_field_present(pill, field, loc));
2444 offset = __req_capsule_offset(pill, field, loc);
2446 msg = __req_msg(pill, loc);
2447 len = lustre_msg_buflen(msg, offset);
2448 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2449 fmt->rf_name, field->rmf_name, len, newlen);
2451 if (loc == RCL_CLIENT)
2452 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2455 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2458 EXPORT_SYMBOL(req_capsule_shrink);
2460 int req_capsule_server_grow(struct req_capsule *pill,
2461 const struct req_msg_field *field,
2464 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2469 LASSERT(pill->rc_fmt != NULL);
2470 LASSERT(__req_format_is_sane(pill->rc_fmt));
2471 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2472 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2474 len = req_capsule_get_size(pill, field, RCL_SERVER);
2475 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2476 if ((__u32)pill->rc_req->rq_repbuf_len >=
2477 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2478 CERROR("Inplace repack might be done\n");
2480 pill->rc_req->rq_reply_state = NULL;
2481 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2482 rc = req_capsule_server_pack(pill);
2484 /* put old rs back, the caller will decide what to do */
2485 pill->rc_req->rq_reply_state = rs;
2488 nrs = pill->rc_req->rq_reply_state;
2489 /* Now we need only buffers, copy first chunk */
2490 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2491 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2492 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2493 memcpy(to, from, len);
2494 /* check if we have tail and copy it too */
2495 if (rs->rs_msg->lm_bufcount > offset + 1) {
2496 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2497 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2498 offset = rs->rs_msg->lm_bufcount - 1;
2499 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2500 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2501 memcpy(to, from, len);
2503 /* drop old reply if everything is fine */
2504 if (rs->rs_difficult) {
2508 nrs->rs_difficult = 1;
2509 nrs->rs_no_ack = rs->rs_no_ack;
2510 nrs->rs_convert_lock = rs->rs_convert_lock;
2511 for (i = 0; i < rs->rs_nlocks; i++) {
2512 nrs->rs_locks[i] = rs->rs_locks[i];
2513 nrs->rs_modes[i] = rs->rs_modes[i];
2517 rs->rs_difficult = 0;
2520 ptlrpc_rs_decref(rs);
2523 EXPORT_SYMBOL(req_capsule_server_grow);