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,
741 &RQF_MDS_GETATTR_NAME,
745 &RQF_MDS_CLOSE_INTENT,
748 &RQF_MDS_REINT_CREATE,
749 &RQF_MDS_REINT_CREATE_ACL,
750 &RQF_MDS_REINT_CREATE_SLAVE,
751 &RQF_MDS_REINT_CREATE_SYM,
753 &RQF_MDS_REINT_UNLINK,
755 &RQF_MDS_REINT_RENAME,
756 &RQF_MDS_REINT_MIGRATE,
757 &RQF_MDS_REINT_SETATTR,
758 &RQF_MDS_REINT_SETXATTR,
759 &RQF_MDS_REINT_RESYNC,
761 &RQF_MDS_HSM_PROGRESS,
762 &RQF_MDS_HSM_CT_REGISTER,
763 &RQF_MDS_HSM_CT_UNREGISTER,
764 &RQF_MDS_HSM_STATE_GET,
765 &RQF_MDS_HSM_STATE_SET,
767 &RQF_MDS_HSM_REQUEST,
768 &RQF_MDS_SWAP_LAYOUTS,
782 &RQF_OST_SET_GRANT_INFO,
784 &RQF_OST_GET_INFO_LAST_ID,
785 &RQF_OST_GET_INFO_LAST_FID,
786 &RQF_OST_SET_INFO_LAST_FID,
787 &RQF_OST_GET_INFO_FIEMAP,
790 &RQF_LDLM_ENQUEUE_LVB,
794 &RQF_LDLM_CP_CALLBACK,
795 &RQF_LDLM_BL_CALLBACK,
796 &RQF_LDLM_GL_CALLBACK,
797 &RQF_LDLM_GL_CALLBACK_DESC,
799 &RQF_LDLM_INTENT_BASIC,
800 &RQF_LDLM_INTENT_LAYOUT,
801 &RQF_LDLM_INTENT_GETATTR,
802 &RQF_LDLM_INTENT_OPEN,
803 &RQF_LDLM_INTENT_CREATE,
804 &RQF_LDLM_INTENT_GETXATTR,
805 &RQF_LDLM_INTENT_QUOTA,
807 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
808 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
809 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
810 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
816 struct req_msg_field {
817 const __u32 rmf_flags;
818 const char *rmf_name;
820 * Field length. (-1) means "variable length". If the
821 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
822 * but the actual size must be a whole multiple of \a rmf_size.
825 void (*rmf_swabber)(void *);
826 void (*rmf_dumper)(void *);
827 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
832 * The field is a string, must be NUL-terminated.
834 RMF_F_STRING = 1 << 0,
836 * The field's buffer size need not match the declared \a rmf_size.
838 RMF_F_NO_SIZE_CHECK = 1 << 1,
840 * The field's buffer size must be a whole multiple of the declared \a
841 * rmf_size and the \a rmf_swabber function must work on the declared \a
842 * rmf_size worth of bytes.
844 RMF_F_STRUCT_ARRAY = 1 << 2
852 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
853 .rmf_name = (name), \
854 .rmf_flags = (flags), \
855 .rmf_size = (size), \
856 .rmf_swabber = (void (*)(void*))(swabber), \
857 .rmf_dumper = (void (*)(void*))(dumper) \
860 struct req_msg_field RMF_GENERIC_DATA =
861 DEFINE_MSGF("generic_data", 0,
863 EXPORT_SYMBOL(RMF_GENERIC_DATA);
865 struct req_msg_field RMF_MGS_TARGET_INFO =
866 DEFINE_MSGF("mgs_target_info", 0,
867 sizeof(struct mgs_target_info),
868 lustre_swab_mgs_target_info, NULL);
869 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
871 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
872 struct req_msg_field RMF_MGS_SEND_PARAM =
873 DEFINE_MSGF("mgs_send_param", 0,
874 sizeof(struct mgs_send_param),
876 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
879 struct req_msg_field RMF_MGS_CONFIG_BODY =
880 DEFINE_MSGF("mgs_config_read request", 0,
881 sizeof(struct mgs_config_body),
882 lustre_swab_mgs_config_body, NULL);
883 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
885 struct req_msg_field RMF_MGS_CONFIG_RES =
886 DEFINE_MSGF("mgs_config_read reply ", 0,
887 sizeof(struct mgs_config_res),
888 lustre_swab_mgs_config_res, NULL);
889 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
891 struct req_msg_field RMF_U32 =
892 DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
893 sizeof(__u32), lustre_swab_generic_32s, NULL);
894 EXPORT_SYMBOL(RMF_U32);
896 struct req_msg_field RMF_SETINFO_VAL =
897 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
898 EXPORT_SYMBOL(RMF_SETINFO_VAL);
900 struct req_msg_field RMF_GETINFO_KEY =
901 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
902 EXPORT_SYMBOL(RMF_GETINFO_KEY);
904 struct req_msg_field RMF_GETINFO_VALLEN =
905 DEFINE_MSGF("getinfo_vallen", 0,
906 sizeof(__u32), lustre_swab_generic_32s, NULL);
907 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
909 struct req_msg_field RMF_GETINFO_VAL =
910 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
911 EXPORT_SYMBOL(RMF_GETINFO_VAL);
913 struct req_msg_field RMF_SEQ_OPC =
914 DEFINE_MSGF("seq_query_opc", 0,
915 sizeof(__u32), lustre_swab_generic_32s, NULL);
916 EXPORT_SYMBOL(RMF_SEQ_OPC);
918 struct req_msg_field RMF_SEQ_RANGE =
919 DEFINE_MSGF("seq_query_range", 0,
920 sizeof(struct lu_seq_range),
921 lustre_swab_lu_seq_range, NULL);
922 EXPORT_SYMBOL(RMF_SEQ_RANGE);
924 struct req_msg_field RMF_FLD_OPC =
925 DEFINE_MSGF("fld_query_opc", 0,
926 sizeof(__u32), lustre_swab_generic_32s, NULL);
927 EXPORT_SYMBOL(RMF_FLD_OPC);
929 struct req_msg_field RMF_FLD_MDFLD =
930 DEFINE_MSGF("fld_query_mdfld", 0,
931 sizeof(struct lu_seq_range),
932 lustre_swab_lu_seq_range, NULL);
933 EXPORT_SYMBOL(RMF_FLD_MDFLD);
935 struct req_msg_field RMF_MDT_BODY =
936 DEFINE_MSGF("mdt_body", 0,
937 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
938 EXPORT_SYMBOL(RMF_MDT_BODY);
940 struct req_msg_field RMF_OBD_QUOTACTL =
941 DEFINE_MSGF("obd_quotactl", 0,
942 sizeof(struct obd_quotactl),
943 lustre_swab_obd_quotactl, NULL);
944 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
946 struct req_msg_field RMF_QUOTA_BODY =
947 DEFINE_MSGF("quota_body", 0,
948 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
949 EXPORT_SYMBOL(RMF_QUOTA_BODY);
951 struct req_msg_field RMF_MDT_EPOCH =
952 DEFINE_MSGF("mdt_ioepoch", 0,
953 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
954 EXPORT_SYMBOL(RMF_MDT_EPOCH);
956 struct req_msg_field RMF_PTLRPC_BODY =
957 DEFINE_MSGF("ptlrpc_body", 0,
958 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
959 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
961 struct req_msg_field RMF_CLOSE_DATA =
962 DEFINE_MSGF("data_version", 0,
963 sizeof(struct close_data), lustre_swab_close_data, NULL);
964 EXPORT_SYMBOL(RMF_CLOSE_DATA);
966 struct req_msg_field RMF_OBD_STATFS =
967 DEFINE_MSGF("obd_statfs", 0,
968 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
969 EXPORT_SYMBOL(RMF_OBD_STATFS);
971 struct req_msg_field RMF_SETINFO_KEY =
972 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
973 EXPORT_SYMBOL(RMF_SETINFO_KEY);
975 struct req_msg_field RMF_NAME =
976 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
977 EXPORT_SYMBOL(RMF_NAME);
979 struct req_msg_field RMF_SYMTGT =
980 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
981 EXPORT_SYMBOL(RMF_SYMTGT);
983 struct req_msg_field RMF_TGTUUID =
984 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
986 EXPORT_SYMBOL(RMF_TGTUUID);
988 struct req_msg_field RMF_CLUUID =
989 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
991 EXPORT_SYMBOL(RMF_CLUUID);
993 struct req_msg_field RMF_STRING =
994 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
995 EXPORT_SYMBOL(RMF_STRING);
997 struct req_msg_field RMF_FILE_SECCTX_NAME =
998 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
999 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1001 struct req_msg_field RMF_FILE_SECCTX =
1002 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1003 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1005 struct req_msg_field RMF_LLOGD_BODY =
1006 DEFINE_MSGF("llogd_body", 0,
1007 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1008 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1010 struct req_msg_field RMF_LLOG_LOG_HDR =
1011 DEFINE_MSGF("llog_log_hdr", 0,
1012 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1013 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1015 struct req_msg_field RMF_LLOGD_CONN_BODY =
1016 DEFINE_MSGF("llogd_conn_body", 0,
1017 sizeof(struct llogd_conn_body),
1018 lustre_swab_llogd_conn_body, NULL);
1019 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1022 * connection handle received in MDS_CONNECT request.
1024 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1025 * that the client does not interpret at all.
1027 struct req_msg_field RMF_CONN =
1028 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1029 EXPORT_SYMBOL(RMF_CONN);
1031 struct req_msg_field RMF_CONNECT_DATA =
1032 DEFINE_MSGF("cdata",
1033 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1034 sizeof(struct obd_connect_data),
1035 lustre_swab_connect, NULL);
1036 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1038 struct req_msg_field RMF_DLM_REQ =
1039 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1040 sizeof(struct ldlm_request),
1041 lustre_swab_ldlm_request, NULL);
1042 EXPORT_SYMBOL(RMF_DLM_REQ);
1044 struct req_msg_field RMF_DLM_REP =
1045 DEFINE_MSGF("dlm_rep", 0,
1046 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1047 EXPORT_SYMBOL(RMF_DLM_REP);
1049 struct req_msg_field RMF_LDLM_INTENT =
1050 DEFINE_MSGF("ldlm_intent", 0,
1051 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1052 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1054 struct req_msg_field RMF_DLM_LVB =
1055 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1056 EXPORT_SYMBOL(RMF_DLM_LVB);
1058 struct req_msg_field RMF_DLM_GL_DESC =
1059 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1060 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1062 struct req_msg_field RMF_MDT_MD =
1063 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_MDT_MD);
1066 struct req_msg_field RMF_REC_REINT =
1067 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1068 lustre_swab_mdt_rec_reint, NULL);
1069 EXPORT_SYMBOL(RMF_REC_REINT);
1071 /* FIXME: this length should be defined as a macro */
1072 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1074 EXPORT_SYMBOL(RMF_EADATA);
1076 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1077 EXPORT_SYMBOL(RMF_EAVALS);
1079 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1080 EXPORT_SYMBOL(RMF_ACL);
1082 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1083 struct req_msg_field RMF_LOGCOOKIES =
1084 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1085 sizeof(struct llog_cookie), NULL, NULL);
1086 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1088 struct req_msg_field RMF_CAPA1 =
1089 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1090 EXPORT_SYMBOL(RMF_CAPA1);
1092 struct req_msg_field RMF_CAPA2 =
1093 DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1094 EXPORT_SYMBOL(RMF_CAPA2);
1096 struct req_msg_field RMF_LAYOUT_INTENT =
1097 DEFINE_MSGF("layout_intent", 0,
1098 sizeof(struct layout_intent), lustre_swab_layout_intent,
1100 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1103 * OST request field.
1105 struct req_msg_field RMF_OST_BODY =
1106 DEFINE_MSGF("ost_body", 0,
1107 sizeof(struct ost_body), lustre_swab_ost_body,
1109 EXPORT_SYMBOL(RMF_OST_BODY);
1111 struct req_msg_field RMF_OBD_IOOBJ =
1112 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1113 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1114 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1116 struct req_msg_field RMF_NIOBUF_REMOTE =
1117 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1118 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1120 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1122 struct req_msg_field RMF_NIOBUF_INLINE =
1123 DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1124 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1126 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1128 struct req_msg_field RMF_RCS =
1129 DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1130 lustre_swab_generic_32s, dump_rcs);
1131 EXPORT_SYMBOL(RMF_RCS);
1133 struct req_msg_field RMF_EAVALS_LENS =
1134 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1135 lustre_swab_generic_32s, NULL);
1136 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1138 struct req_msg_field RMF_OBD_ID =
1139 DEFINE_MSGF("obd_id", 0,
1140 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1141 EXPORT_SYMBOL(RMF_OBD_ID);
1143 struct req_msg_field RMF_FID =
1144 DEFINE_MSGF("fid", 0,
1145 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1146 EXPORT_SYMBOL(RMF_FID);
1148 struct req_msg_field RMF_OST_ID =
1149 DEFINE_MSGF("ost_id", 0,
1150 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1151 EXPORT_SYMBOL(RMF_OST_ID);
1153 struct req_msg_field RMF_FIEMAP_KEY =
1154 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1155 lustre_swab_fiemap, NULL);
1156 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1158 struct req_msg_field RMF_FIEMAP_VAL =
1159 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1160 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1162 struct req_msg_field RMF_IDX_INFO =
1163 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1164 lustre_swab_idx_info, NULL);
1165 EXPORT_SYMBOL(RMF_IDX_INFO);
1166 struct req_msg_field RMF_SHORT_IO =
1167 DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1168 EXPORT_SYMBOL(RMF_SHORT_IO);
1169 struct req_msg_field RMF_HSM_USER_STATE =
1170 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1171 lustre_swab_hsm_user_state, NULL);
1172 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1174 struct req_msg_field RMF_HSM_STATE_SET =
1175 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1176 lustre_swab_hsm_state_set, NULL);
1177 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1179 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1180 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1181 lustre_swab_hsm_progress_kernel, NULL);
1182 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1184 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1185 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1186 lustre_swab_hsm_current_action, NULL);
1187 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1189 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1190 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1191 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1193 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1195 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1196 DEFINE_MSGF("hsm_archive", 0,
1197 sizeof(__u32), lustre_swab_generic_32s, NULL);
1198 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1200 struct req_msg_field RMF_MDS_HSM_REQUEST =
1201 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1202 lustre_swab_hsm_request, NULL);
1203 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1205 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1206 lustre_swab_object_update_request, NULL);
1207 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1209 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1210 DEFINE_MSGF("object_update_reply", 0, -1,
1211 lustre_swab_object_update_reply, NULL);
1212 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1214 struct req_msg_field RMF_SWAP_LAYOUTS =
1215 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1216 lustre_swab_swap_layouts, NULL);
1217 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1219 struct req_msg_field RMF_LFSCK_REQUEST =
1220 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1221 lustre_swab_lfsck_request, NULL);
1222 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1224 struct req_msg_field RMF_LFSCK_REPLY =
1225 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1226 lustre_swab_lfsck_reply, NULL);
1227 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1229 struct req_msg_field RMF_OST_LADVISE_HDR =
1230 DEFINE_MSGF("ladvise_request", 0,
1231 sizeof(struct ladvise_hdr),
1232 lustre_swab_ladvise_hdr, NULL);
1233 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1235 struct req_msg_field RMF_OST_LADVISE =
1236 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1237 sizeof(struct lu_ladvise),
1238 lustre_swab_ladvise, NULL);
1239 EXPORT_SYMBOL(RMF_OST_LADVISE);
1241 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1242 -1, lustre_swab_out_update_header, NULL);
1243 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1245 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1246 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1247 lustre_swab_out_update_buffer, NULL);
1248 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1255 const char *rf_name;
1259 const struct req_msg_field **d;
1260 } rf_fields[RCL_NR];
1263 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1277 #define DEFINE_REQ_FMT0(name, client, server) \
1278 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1280 struct req_format RQF_OBD_PING =
1281 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1282 EXPORT_SYMBOL(RQF_OBD_PING);
1284 struct req_format RQF_OBD_SET_INFO =
1285 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1286 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1288 /* Read index file through the network */
1289 struct req_format RQF_OBD_IDX_READ =
1290 DEFINE_REQ_FMT0("OBD_IDX_READ",
1291 obd_idx_read_client, obd_idx_read_server);
1292 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1294 struct req_format RQF_SEC_CTX =
1295 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1296 EXPORT_SYMBOL(RQF_SEC_CTX);
1298 struct req_format RQF_MGS_TARGET_REG =
1299 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1300 mgs_target_info_only);
1301 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1303 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1304 struct req_format RQF_MGS_SET_INFO =
1305 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1307 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1310 struct req_format RQF_MGS_CONFIG_READ =
1311 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1312 mgs_config_read_server);
1313 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1315 struct req_format RQF_SEQ_QUERY =
1316 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1317 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1319 struct req_format RQF_FLD_QUERY =
1320 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1321 EXPORT_SYMBOL(RQF_FLD_QUERY);
1323 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1324 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1325 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1326 * peers need to handle the RPC reply with fixed little-endian format.
1328 * In theory, we can define new structure with some swabber registered to
1329 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1330 * implementation view, it is not easy to be done within current "struct
1331 * req_msg_field" framework. Because the sequence range array in the RPC
1332 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1333 * count, that is unknown when prepare the RPC buffer. Generally, for such
1334 * flexible length RPC usage, there will be a field in the RPC layout to
1335 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1336 * do that unless we add new length filed that will broken the on-wire RPC
1337 * protocol and cause interoperability trouble with old peer. */
1338 struct req_format RQF_FLD_READ =
1339 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1340 EXPORT_SYMBOL(RQF_FLD_READ);
1342 struct req_format RQF_MDS_QUOTACTL =
1343 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1344 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1346 struct req_format RQF_OST_QUOTACTL =
1347 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1348 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1350 struct req_format RQF_QUOTA_DQACQ =
1351 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1352 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1354 struct req_format RQF_LDLM_INTENT_QUOTA =
1355 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1356 ldlm_intent_quota_client,
1357 ldlm_intent_quota_server);
1358 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1360 struct req_format RQF_MDS_GET_ROOT =
1361 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1362 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1364 struct req_format RQF_MDS_STATFS =
1365 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1366 EXPORT_SYMBOL(RQF_MDS_STATFS);
1368 struct req_format RQF_MDS_STATFS_NEW =
1369 DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1370 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1372 struct req_format RQF_MDS_SYNC =
1373 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1374 EXPORT_SYMBOL(RQF_MDS_SYNC);
1376 struct req_format RQF_MDS_GETATTR =
1377 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1378 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1380 struct req_format RQF_MDS_GETXATTR =
1381 DEFINE_REQ_FMT0("MDS_GETXATTR",
1382 mds_getxattr_client, mds_getxattr_server);
1383 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1385 struct req_format RQF_MDS_GETATTR_NAME =
1386 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1387 mds_getattr_name_client, mds_getattr_server);
1388 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1390 struct req_format RQF_MDS_REINT =
1391 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1392 EXPORT_SYMBOL(RQF_MDS_REINT);
1394 struct req_format RQF_MDS_REINT_CREATE =
1395 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1396 mds_reint_create_client, mdt_body_capa);
1397 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1399 struct req_format RQF_MDS_REINT_CREATE_ACL =
1400 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1401 mds_reint_create_acl_client, mdt_body_capa);
1402 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1404 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1405 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1406 mds_reint_create_slave_client, mdt_body_capa);
1407 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1409 struct req_format RQF_MDS_REINT_CREATE_SYM =
1410 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1411 mds_reint_create_sym_client, mdt_body_capa);
1412 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1414 struct req_format RQF_MDS_REINT_OPEN =
1415 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1416 mds_reint_open_client, mds_reint_open_server);
1417 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1419 struct req_format RQF_MDS_REINT_UNLINK =
1420 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1421 mds_last_unlink_server);
1422 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1424 struct req_format RQF_MDS_REINT_LINK =
1425 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1426 mds_reint_link_client, mdt_body_only);
1427 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1429 struct req_format RQF_MDS_REINT_RENAME =
1430 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1431 mds_last_unlink_server);
1432 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1434 struct req_format RQF_MDS_REINT_MIGRATE =
1435 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1436 mds_last_unlink_server);
1437 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1439 struct req_format RQF_MDS_REINT_SETATTR =
1440 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1441 mds_reint_setattr_client, mds_setattr_server);
1442 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1444 struct req_format RQF_MDS_REINT_SETXATTR =
1445 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1446 mds_reint_setxattr_client, mdt_body_only);
1447 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1449 struct req_format RQF_MDS_REINT_RESYNC =
1450 DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1451 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1453 struct req_format RQF_MDS_CONNECT =
1454 DEFINE_REQ_FMT0("MDS_CONNECT",
1455 obd_connect_client, obd_connect_server);
1456 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1458 struct req_format RQF_MDS_DISCONNECT =
1459 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1460 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1462 struct req_format RQF_MDS_GET_INFO =
1463 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1464 mds_getinfo_server);
1465 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1467 struct req_format RQF_OUT_UPDATE =
1468 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1470 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1472 struct req_format RQF_LDLM_ENQUEUE =
1473 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1474 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1475 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1477 struct req_format RQF_LDLM_ENQUEUE_LVB =
1478 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1479 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1480 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1482 struct req_format RQF_LDLM_CONVERT =
1483 DEFINE_REQ_FMT0("LDLM_CONVERT",
1484 ldlm_enqueue_client, ldlm_enqueue_server);
1485 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1487 struct req_format RQF_LDLM_CANCEL =
1488 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1489 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1491 struct req_format RQF_LDLM_CALLBACK =
1492 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1493 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1495 struct req_format RQF_LDLM_CP_CALLBACK =
1496 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1497 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1499 struct req_format RQF_LDLM_BL_CALLBACK =
1500 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1501 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1503 struct req_format RQF_LDLM_GL_CALLBACK =
1504 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1505 ldlm_gl_callback_server);
1506 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1508 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1509 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1510 ldlm_gl_callback_server);
1511 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1513 struct req_format RQF_LDLM_INTENT_BASIC =
1514 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1515 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1516 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1518 struct req_format RQF_LDLM_INTENT =
1519 DEFINE_REQ_FMT0("LDLM_INTENT",
1520 ldlm_intent_client, ldlm_intent_server);
1521 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1523 struct req_format RQF_LDLM_INTENT_LAYOUT =
1524 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1525 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1526 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1528 struct req_format RQF_LDLM_INTENT_GETATTR =
1529 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1530 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1531 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1533 struct req_format RQF_LDLM_INTENT_OPEN =
1534 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1535 ldlm_intent_open_client, ldlm_intent_open_server);
1536 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1538 struct req_format RQF_LDLM_INTENT_CREATE =
1539 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1540 ldlm_intent_create_client, ldlm_intent_getattr_server);
1541 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1543 struct req_format RQF_LDLM_INTENT_GETXATTR =
1544 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1545 ldlm_intent_getxattr_client,
1546 ldlm_intent_getxattr_server);
1547 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1549 struct req_format RQF_MDS_CLOSE =
1550 DEFINE_REQ_FMT0("MDS_CLOSE",
1551 mdt_close_client, mds_last_unlink_server);
1552 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1554 struct req_format RQF_MDS_CLOSE_INTENT =
1555 DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1556 mdt_close_intent_client, mds_last_unlink_server);
1557 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1559 struct req_format RQF_MDS_READPAGE =
1560 DEFINE_REQ_FMT0("MDS_READPAGE",
1561 mdt_body_capa, mdt_body_only);
1562 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1564 struct req_format RQF_MDS_HSM_ACTION =
1565 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1566 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1568 struct req_format RQF_MDS_HSM_PROGRESS =
1569 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1570 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1572 struct req_format RQF_MDS_HSM_CT_REGISTER =
1573 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1574 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1576 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1577 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1578 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1580 struct req_format RQF_MDS_HSM_STATE_GET =
1581 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1582 mdt_body_capa, mdt_hsm_state_get_server);
1583 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1585 struct req_format RQF_MDS_HSM_STATE_SET =
1586 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1587 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1589 struct req_format RQF_MDS_HSM_REQUEST =
1590 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1591 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1593 struct req_format RQF_MDS_SWAP_LAYOUTS =
1594 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1595 mdt_swap_layouts, empty);
1596 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1598 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1599 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1600 llog_origin_handle_create_client, llogd_body_only);
1601 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1603 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1604 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1605 llogd_body_only, llog_origin_handle_next_block_server);
1606 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1608 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1609 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1610 llogd_body_only, llog_origin_handle_next_block_server);
1611 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1613 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1614 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1615 llogd_body_only, llog_log_hdr_only);
1616 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1618 struct req_format RQF_CONNECT =
1619 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1620 EXPORT_SYMBOL(RQF_CONNECT);
1622 struct req_format RQF_OST_CONNECT =
1623 DEFINE_REQ_FMT0("OST_CONNECT",
1624 obd_connect_client, obd_connect_server);
1625 EXPORT_SYMBOL(RQF_OST_CONNECT);
1627 struct req_format RQF_OST_DISCONNECT =
1628 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1629 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1631 struct req_format RQF_OST_GETATTR =
1632 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1633 EXPORT_SYMBOL(RQF_OST_GETATTR);
1635 struct req_format RQF_OST_SETATTR =
1636 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1637 EXPORT_SYMBOL(RQF_OST_SETATTR);
1639 struct req_format RQF_OST_CREATE =
1640 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1641 EXPORT_SYMBOL(RQF_OST_CREATE);
1643 struct req_format RQF_OST_PUNCH =
1644 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1645 EXPORT_SYMBOL(RQF_OST_PUNCH);
1647 struct req_format RQF_OST_SYNC =
1648 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1649 EXPORT_SYMBOL(RQF_OST_SYNC);
1651 struct req_format RQF_OST_DESTROY =
1652 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1653 EXPORT_SYMBOL(RQF_OST_DESTROY);
1655 struct req_format RQF_OST_BRW_READ =
1656 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1657 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1659 struct req_format RQF_OST_BRW_WRITE =
1660 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1661 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1663 struct req_format RQF_OST_STATFS =
1664 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1665 EXPORT_SYMBOL(RQF_OST_STATFS);
1667 struct req_format RQF_OST_SET_GRANT_INFO =
1668 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1670 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1672 struct req_format RQF_OST_GET_INFO =
1673 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1674 ost_get_info_generic_server);
1675 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1677 struct req_format RQF_OST_GET_INFO_LAST_ID =
1678 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1679 ost_get_last_id_server);
1680 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1682 struct req_format RQF_OST_GET_INFO_LAST_FID =
1683 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1684 ost_get_last_fid_server);
1685 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1687 struct req_format RQF_OST_SET_INFO_LAST_FID =
1688 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1690 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1692 struct req_format RQF_OST_GET_INFO_FIEMAP =
1693 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1694 ost_get_fiemap_server);
1695 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1697 struct req_format RQF_LFSCK_NOTIFY =
1698 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1699 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1701 struct req_format RQF_LFSCK_QUERY =
1702 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1703 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1705 struct req_format RQF_OST_LADVISE =
1706 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1707 EXPORT_SYMBOL(RQF_OST_LADVISE);
1709 /* Convenience macro */
1710 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1713 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1714 * field of RQFs and the \a rmf_offset field of RMFs.
1716 int req_layout_init(void)
1721 struct req_format *rf = NULL;
1723 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1724 rf = req_formats[i];
1726 for (j = 0; j < RCL_NR; ++j) {
1727 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1728 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1729 struct req_msg_field *field;
1731 field = (typeof(field))rf->rf_fields[j].d[k];
1732 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1733 || field->rmf_size > 0);
1734 LASSERT(field->rmf_offset[i][j] == 0);
1736 * k + 1 to detect unused format/field
1739 field->rmf_offset[i][j] = k + 1;
1745 EXPORT_SYMBOL(req_layout_init);
1747 void req_layout_fini(void)
1750 EXPORT_SYMBOL(req_layout_fini);
1753 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1755 * Actual/expected field sizes are set elsewhere in functions in this file:
1756 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1757 * req_capsule_msg_size(). The \a rc_area information is used by.
1758 * ptlrpc_request_set_replen().
1760 void req_capsule_init_area(struct req_capsule *pill)
1764 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1765 pill->rc_area[RCL_CLIENT][i] = -1;
1766 pill->rc_area[RCL_SERVER][i] = -1;
1769 EXPORT_SYMBOL(req_capsule_init_area);
1772 * Initialize a pill.
1774 * The \a location indicates whether the caller is executing on the client side
1775 * (RCL_CLIENT) or server side (RCL_SERVER)..
1777 void req_capsule_init(struct req_capsule *pill,
1778 struct ptlrpc_request *req,
1779 enum req_location location)
1781 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1784 * Today all capsules are embedded in ptlrpc_request structs,
1785 * but just in case that ever isn't the case, we don't reach
1786 * into req unless req != NULL and pill is the one embedded in
1789 * The req->rq_pill_init flag makes it safe to initialize a pill
1790 * twice, which might happen in the OST paths as a result of the
1791 * high-priority RPC queue getting peeked at before ost_handle()
1792 * handles an OST RPC.
1794 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1797 memset(pill, 0, sizeof *pill);
1799 pill->rc_loc = location;
1800 req_capsule_init_area(pill);
1802 if (req != NULL && pill == &req->rq_pill)
1803 req->rq_pill_init = 1;
1805 EXPORT_SYMBOL(req_capsule_init);
1807 void req_capsule_fini(struct req_capsule *pill)
1810 EXPORT_SYMBOL(req_capsule_fini);
1812 static int __req_format_is_sane(const struct req_format *fmt)
1814 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1815 req_formats[fmt->rf_idx] == fmt;
1818 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1819 enum req_location loc)
1821 struct ptlrpc_request *req;
1824 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1828 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1829 * (see req_capsule_extend()).
1831 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1833 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1834 LASSERT(__req_format_is_sane(fmt));
1838 EXPORT_SYMBOL(req_capsule_set);
1841 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1844 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1845 * variable-sized fields. The field sizes come from the declared \a rmf_size
1846 * field of a \a pill's \a rc_fmt's RMF's.
1848 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1849 enum req_location loc)
1851 const struct req_format *fmt = pill->rc_fmt;
1854 LASSERT(fmt != NULL);
1856 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1857 if (pill->rc_area[loc][i] == -1) {
1858 pill->rc_area[loc][i] =
1859 fmt->rf_fields[loc].d[i]->rmf_size;
1860 if (pill->rc_area[loc][i] == -1) {
1862 * Skip the following fields.
1864 * If this LASSERT() trips then you're missing a
1865 * call to req_capsule_set_size().
1867 LASSERT(loc != RCL_SERVER);
1874 EXPORT_SYMBOL(req_capsule_filled_sizes);
1877 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1879 * This function uses the \a pill's \a rc_area as filled in by
1880 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1883 int req_capsule_server_pack(struct req_capsule *pill)
1885 const struct req_format *fmt;
1889 LASSERT(pill->rc_loc == RCL_SERVER);
1891 LASSERT(fmt != NULL);
1893 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1894 rc = lustre_pack_reply(pill->rc_req, count,
1895 pill->rc_area[RCL_SERVER], NULL);
1897 DEBUG_REQ(D_ERROR, pill->rc_req,
1898 "Cannot pack %d fields in format `%s': ",
1899 count, fmt->rf_name);
1903 EXPORT_SYMBOL(req_capsule_server_pack);
1906 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1907 * corresponding to the given RMF (\a field).
1909 __u32 __req_capsule_offset(const struct req_capsule *pill,
1910 const struct req_msg_field *field,
1911 enum req_location loc)
1913 unsigned int offset;
1915 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1916 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1917 pill->rc_fmt->rf_name,
1918 field->rmf_name, offset, loc);
1921 LASSERT(offset < REQ_MAX_FIELD_NR);
1926 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1931 swabber_dumper_helper(struct req_capsule *pill,
1932 const struct req_msg_field *field,
1933 enum req_location loc,
1935 void *value, int len, int dump, void (*swabber)( void *))
1941 int inout = loc == RCL_CLIENT;
1943 swabber = swabber ?: field->rmf_swabber;
1945 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1946 swabber != NULL && value != NULL)
1951 if (!field->rmf_dumper)
1954 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1956 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1957 do_swab ? "unswabbed " : "", field->rmf_name);
1958 field->rmf_dumper(value);
1963 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1965 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1966 "follows\n", field->rmf_name);
1967 field->rmf_dumper(value);
1974 * We're swabbing an array; swabber() swabs a single array element, so
1975 * swab every element.
1977 LASSERT((len % field->rmf_size) == 0);
1978 for (p = value, i = 0, n = len / field->rmf_size;
1980 i++, p += field->rmf_size) {
1982 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1983 "element %d follows\n",
1984 do_swab ? "unswabbed " : "", field->rmf_name, i);
1985 field->rmf_dumper(p);
1991 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1992 "element %d follows\n", field->rmf_name, i);
1993 field->rmf_dumper(value);
1997 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2001 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2002 * corresponding to the given RMF (\a field).
2004 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2005 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2006 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2007 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2008 * element of the array swabbed.
2010 static void *__req_capsule_get(struct req_capsule *pill,
2011 const struct req_msg_field *field,
2012 enum req_location loc,
2013 void (*swabber)( void *),
2016 const struct req_format *fmt;
2017 struct lustre_msg *msg;
2022 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2024 static const char *rcl_names[RCL_NR] = {
2025 [RCL_CLIENT] = "client",
2026 [RCL_SERVER] = "server"
2029 LASSERT(pill != NULL);
2030 LASSERT(pill != LP_POISON);
2032 LASSERT(fmt != NULL);
2033 LASSERT(fmt != LP_POISON);
2034 LASSERT(__req_format_is_sane(fmt));
2036 offset = __req_capsule_offset(pill, field, loc);
2038 msg = __req_msg(pill, loc);
2039 LASSERT(msg != NULL);
2041 getter = (field->rmf_flags & RMF_F_STRING) ?
2042 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2044 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2046 * We've already asserted that field->rmf_size > 0 in
2047 * req_layout_init().
2049 len = lustre_msg_buflen(msg, offset);
2050 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2051 (len % field->rmf_size) != 0) {
2052 CERROR("%s: array field size mismatch "
2053 "%d modulo %u != 0 (%d)\n",
2054 field->rmf_name, len, field->rmf_size, loc);
2057 } else if (pill->rc_area[loc][offset] != -1) {
2058 len = pill->rc_area[loc][offset];
2060 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2062 value = getter(msg, offset, len);
2064 if (value == NULL) {
2065 DEBUG_REQ(D_ERROR, pill->rc_req,
2066 "Wrong buffer for field `%s' (%u of %u) "
2067 "in format `%s': %u vs. %u (%s)\n",
2068 field->rmf_name, offset, lustre_msg_bufcount(msg),
2069 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2072 swabber_dumper_helper(pill, field, loc, offset, value, len,
2080 * Dump a request and/or reply
2082 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2084 const struct req_format *fmt;
2085 const struct req_msg_field *field;
2091 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2092 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2093 field = FMT_FIELD(fmt, loc, i);
2094 if (field->rmf_dumper == NULL) {
2096 * FIXME Add a default hex dumper for fields that don't
2097 * have a specific dumper
2099 len = req_capsule_get_size(pill, field, loc);
2100 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2101 "field size is %u\n", field->rmf_name, len);
2103 /* It's the dumping side-effect that we're interested in */
2104 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2107 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2113 void req_capsule_client_dump(struct req_capsule *pill)
2115 __req_capsule_dump(pill, RCL_CLIENT);
2117 EXPORT_SYMBOL(req_capsule_client_dump);
2122 void req_capsule_server_dump(struct req_capsule *pill)
2124 __req_capsule_dump(pill, RCL_SERVER);
2126 EXPORT_SYMBOL(req_capsule_server_dump);
2129 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2130 * buffer corresponding to the given RMF (\a field) of a \a pill.
2132 void *req_capsule_client_get(struct req_capsule *pill,
2133 const struct req_msg_field *field)
2135 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2137 EXPORT_SYMBOL(req_capsule_client_get);
2140 * Same as req_capsule_client_get(), but with a \a swabber argument.
2142 * Currently unused; will be removed when req_capsule_server_swab_get() is
2145 void *req_capsule_client_swab_get(struct req_capsule *pill,
2146 const struct req_msg_field *field,
2149 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2151 EXPORT_SYMBOL(req_capsule_client_swab_get);
2154 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2156 * First the \a pill's request \a field's size is set (\a rc_area) using
2157 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2160 void *req_capsule_client_sized_get(struct req_capsule *pill,
2161 const struct req_msg_field *field,
2164 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2165 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2167 EXPORT_SYMBOL(req_capsule_client_sized_get);
2170 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2171 * buffer corresponding to the given RMF (\a field) of a \a pill.
2173 void *req_capsule_server_get(struct req_capsule *pill,
2174 const struct req_msg_field *field)
2176 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2178 EXPORT_SYMBOL(req_capsule_server_get);
2181 * Same as req_capsule_server_get(), but with a \a swabber argument.
2183 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2184 * swabbing done outside this capsule abstraction.
2186 void *req_capsule_server_swab_get(struct req_capsule *pill,
2187 const struct req_msg_field *field,
2190 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2192 EXPORT_SYMBOL(req_capsule_server_swab_get);
2195 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2197 * First the \a pill's request \a field's size is set (\a rc_area) using
2198 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2201 void *req_capsule_server_sized_get(struct req_capsule *pill,
2202 const struct req_msg_field *field,
2205 req_capsule_set_size(pill, field, RCL_SERVER, len);
2206 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2208 EXPORT_SYMBOL(req_capsule_server_sized_get);
2210 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2211 const struct req_msg_field *field,
2212 __u32 len, void *swabber)
2214 req_capsule_set_size(pill, field, RCL_SERVER, len);
2215 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2217 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2220 * Returns the buffer of a \a pill corresponding to the given \a field from the
2221 * request (if the caller is executing on the server-side) or reply (if the
2222 * caller is executing on the client-side).
2224 * This function convienient for use is code that could be executed on the
2225 * client and server alike.
2227 const void *req_capsule_other_get(struct req_capsule *pill,
2228 const struct req_msg_field *field)
2230 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2232 EXPORT_SYMBOL(req_capsule_other_get);
2235 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2236 * field of the given \a pill.
2238 * This function must be used when constructing variable sized fields of a
2241 void req_capsule_set_size(struct req_capsule *pill,
2242 const struct req_msg_field *field,
2243 enum req_location loc, __u32 size)
2245 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2247 if ((size != (__u32)field->rmf_size) &&
2248 (field->rmf_size != -1) &&
2249 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2251 __u32 rmf_size = (__u32)field->rmf_size;
2252 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2253 (size % rmf_size != 0)) {
2254 CERROR("%s: array field size mismatch "
2255 "%u %% %u != 0 (%d)\n",
2256 field->rmf_name, size, rmf_size, loc);
2258 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2260 CERROR("%s: field size mismatch %u != %u (%d)\n",
2261 field->rmf_name, size, rmf_size, loc);
2266 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2268 EXPORT_SYMBOL(req_capsule_set_size);
2271 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2272 * for the given \a pill's given \a field.
2274 * NB: this function doesn't correspond with req_capsule_set_size(), which
2275 * actually sets the size in pill.rc_area[loc][offset], but this function
2276 * returns the message buflen[offset], maybe we should use another name.
2278 __u32 req_capsule_get_size(const struct req_capsule *pill,
2279 const struct req_msg_field *field,
2280 enum req_location loc)
2282 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2284 return lustre_msg_buflen(__req_msg(pill, loc),
2285 __req_capsule_offset(pill, field, loc));
2287 EXPORT_SYMBOL(req_capsule_get_size);
2290 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2291 * given \a pill's request or reply (\a loc) given the field size recorded in
2292 * the \a pill's rc_area.
2294 * See also req_capsule_set_size().
2296 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2298 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2299 pill->rc_fmt->rf_fields[loc].nr,
2300 pill->rc_area[loc]);
2304 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2305 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2306 * PTLRPC request or reply given only an RQF (\a fmt).
2308 * This function should not be used for formats which contain variable size
2311 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2312 enum req_location loc)
2318 * This function should probably LASSERT() that fmt has no fields with
2319 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2320 * elements in the array there will ultimately be, but then, we could
2321 * assume that there will be at least one element, and that's just what
2324 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2328 for (; i < fmt->rf_fields[loc].nr; ++i)
2329 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2330 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2334 EXPORT_SYMBOL(req_capsule_fmt_size);
2337 * Changes the format of an RPC.
2339 * The pill must already have been initialized, which means that it already has
2340 * a request format. The new format \a fmt must be an extension of the pill's
2341 * old format. Specifically: the new format must have as many request and reply
2342 * fields as the old one, and all fields shared by the old and new format must
2343 * be at least as large in the new format.
2345 * The new format's fields may be of different "type" than the old format, but
2346 * only for fields that are "opaque" blobs: fields which have a) have no
2347 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2348 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2349 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2350 * according to the key field. When the value, according to the key, contains a
2351 * structure (or array thereof) to be swabbed, the format should be changed to
2352 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2355 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2360 const struct req_format *old;
2362 LASSERT(pill->rc_fmt != NULL);
2363 LASSERT(__req_format_is_sane(fmt));
2367 * Sanity checking...
2369 for (i = 0; i < RCL_NR; ++i) {
2370 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2371 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2372 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2374 /* "opaque" fields can be transmogrified */
2375 if (ofield->rmf_swabber == NULL &&
2376 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2377 (ofield->rmf_size == -1 ||
2378 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2380 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2383 * Last field in old format can be shorter than in new.
2385 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2386 FMT_FIELD(old, i, j)->rmf_size);
2391 EXPORT_SYMBOL(req_capsule_extend);
2394 * This function returns a non-zero value if the given \a field is present in
2395 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2398 int req_capsule_has_field(const struct req_capsule *pill,
2399 const struct req_msg_field *field,
2400 enum req_location loc)
2402 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2404 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2406 EXPORT_SYMBOL(req_capsule_has_field);
2409 * Returns a non-zero value if the given \a field is present in the given \a
2410 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2412 int req_capsule_field_present(const struct req_capsule *pill,
2413 const struct req_msg_field *field,
2414 enum req_location loc)
2418 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2419 LASSERT(req_capsule_has_field(pill, field, loc));
2421 offset = __req_capsule_offset(pill, field, loc);
2422 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2424 EXPORT_SYMBOL(req_capsule_field_present);
2427 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2428 * request or reply (\a loc).
2430 * This is not the opposite of req_capsule_extend().
2432 void req_capsule_shrink(struct req_capsule *pill,
2433 const struct req_msg_field *field,
2435 enum req_location loc)
2437 const struct req_format *fmt;
2438 struct lustre_msg *msg;
2443 LASSERT(fmt != NULL);
2444 LASSERT(__req_format_is_sane(fmt));
2445 LASSERT(req_capsule_has_field(pill, field, loc));
2446 LASSERT(req_capsule_field_present(pill, field, loc));
2448 offset = __req_capsule_offset(pill, field, loc);
2450 msg = __req_msg(pill, loc);
2451 len = lustre_msg_buflen(msg, offset);
2452 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2453 fmt->rf_name, field->rmf_name, len, newlen);
2455 if (loc == RCL_CLIENT)
2456 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2459 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2462 EXPORT_SYMBOL(req_capsule_shrink);
2464 int req_capsule_server_grow(struct req_capsule *pill,
2465 const struct req_msg_field *field,
2468 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2473 LASSERT(pill->rc_fmt != NULL);
2474 LASSERT(__req_format_is_sane(pill->rc_fmt));
2475 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2476 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2478 len = req_capsule_get_size(pill, field, RCL_SERVER);
2479 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2480 if ((__u32)pill->rc_req->rq_repbuf_len >=
2481 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2482 CERROR("Inplace repack might be done\n");
2484 pill->rc_req->rq_reply_state = NULL;
2485 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2486 rc = req_capsule_server_pack(pill);
2488 /* put old rs back, the caller will decide what to do */
2489 pill->rc_req->rq_reply_state = rs;
2492 nrs = pill->rc_req->rq_reply_state;
2493 /* Now we need only buffers, copy first chunk */
2494 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2495 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2496 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2497 memcpy(to, from, len);
2498 /* check if we have tail and copy it too */
2499 if (rs->rs_msg->lm_bufcount > offset + 1) {
2500 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2501 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2502 offset = rs->rs_msg->lm_bufcount - 1;
2503 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2504 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2505 memcpy(to, from, len);
2507 /* drop old reply if everything is fine */
2508 if (rs->rs_difficult) {
2512 nrs->rs_difficult = 1;
2513 nrs->rs_no_ack = rs->rs_no_ack;
2514 nrs->rs_convert_lock = rs->rs_convert_lock;
2515 for (i = 0; i < rs->rs_nlocks; i++) {
2516 nrs->rs_locks[i] = rs->rs_locks[i];
2517 nrs->rs_modes[i] = rs->rs_modes[i];
2521 rs->rs_difficult = 0;
2524 ptlrpc_rs_decref(rs);
2527 EXPORT_SYMBOL(req_capsule_server_grow);