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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
53 #include <linux/module.h>
55 /* LUSTRE_VERSION_CODE */
56 #include <lustre_ver.h>
58 #include <obd_support.h>
59 /* lustre_swab_mdt_body */
60 #include <lustre/lustre_idl.h>
61 /* obd2cli_tgt() (required by DEBUG_REQ()) */
63 #include <lustre_debug.h>
64 #include <lustre_update.h>
65 #endif /* !__REQ_LAYOUT_USER__ */
67 /* struct ptlrpc_request, lustre_msg* */
68 #include <lustre_req_layout.h>
69 #include <lustre_acl.h>
72 * RQFs (see below) refer to two struct req_msg_field arrays describing the
73 * client request and server reply, respectively.
75 /* empty set of fields... for suitable definition of emptiness. */
76 static const struct req_msg_field *empty[] = {
80 static const struct req_msg_field *mgs_target_info_only[] = {
85 static const struct req_msg_field *mgs_set_info[] = {
90 static const struct req_msg_field *mgs_config_read_client[] = {
95 static const struct req_msg_field *mgs_config_read_server[] = {
100 static const struct req_msg_field *log_cancel_client[] = {
105 static const struct req_msg_field *mdt_body_only[] = {
110 static const struct req_msg_field *mdt_body_capa[] = {
116 static const struct req_msg_field *quotactl_only[] = {
121 static const struct req_msg_field *quota_body_only[] = {
126 static const struct req_msg_field *ldlm_intent_quota_client[] = {
133 static const struct req_msg_field *ldlm_intent_quota_server[] = {
140 static const struct req_msg_field *mdt_close_client[] = {
147 static const struct req_msg_field *mdt_release_close_client[] = {
155 static const struct req_msg_field *obd_statfs_server[] = {
160 static const struct req_msg_field *seq_query_client[] = {
166 static const struct req_msg_field *seq_query_server[] = {
171 static const struct req_msg_field *fld_query_client[] = {
177 static const struct req_msg_field *fld_query_server[] = {
182 static const struct req_msg_field *fld_read_client[] = {
187 static const struct req_msg_field *fld_read_server[] = {
192 static const struct req_msg_field *mds_getattr_name_client[] = {
199 static const struct req_msg_field *mds_reint_client[] = {
204 static const struct req_msg_field *mds_reint_create_client[] = {
211 static const struct req_msg_field *mds_reint_create_slave_client[] = {
220 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
229 static const struct req_msg_field *mds_reint_create_sym_client[] = {
238 static const struct req_msg_field *mds_reint_open_client[] = {
247 static const struct req_msg_field *mds_reint_open_server[] = {
256 static const struct req_msg_field *mds_reint_unlink_client[] = {
264 static const struct req_msg_field *mds_reint_link_client[] = {
273 static const struct req_msg_field *mds_reint_rename_client[] = {
283 static const struct req_msg_field *mds_last_unlink_server[] = {
292 static const struct req_msg_field *mds_reint_setattr_client[] = {
302 static const struct req_msg_field *mds_reint_setxattr_client[] = {
311 static const struct req_msg_field *mdt_swap_layouts[] = {
320 static const struct req_msg_field *obd_connect_client[] = {
328 static const struct req_msg_field *obd_connect_server[] = {
333 static const struct req_msg_field *obd_set_info_client[] = {
339 static const struct req_msg_field *ost_grant_shrink_client[] = {
345 static const struct req_msg_field *mds_getinfo_client[] = {
351 static const struct req_msg_field *mds_getinfo_server[] = {
356 static const struct req_msg_field *ldlm_enqueue_client[] = {
361 static const struct req_msg_field *ldlm_enqueue_server[] = {
366 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
372 static const struct req_msg_field *ldlm_cp_callback_client[] = {
378 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
384 static const struct req_msg_field *ldlm_gl_callback_server[] = {
389 static const struct req_msg_field *ldlm_intent_basic_client[] = {
395 static const struct req_msg_field *ldlm_intent_client[] = {
402 static const struct req_msg_field *ldlm_intent_server[] = {
410 static const struct req_msg_field *ldlm_intent_layout_client[] = {
415 &RMF_EADATA /* for new layout to be set up */
417 static const struct req_msg_field *ldlm_intent_open_server[] = {
427 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
431 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
436 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
445 static const struct req_msg_field *ldlm_intent_create_client[] = {
449 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
455 static const struct req_msg_field *ldlm_intent_open_client[] = {
459 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
466 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
470 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
475 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
483 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
488 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
494 static const struct req_msg_field *mds_getxattr_client[] = {
502 static const struct req_msg_field *mds_getxattr_server[] = {
508 static const struct req_msg_field *mds_getattr_server[] = {
517 static const struct req_msg_field *mds_setattr_server[] = {
526 static const struct req_msg_field *mds_update_client[] = {
531 static const struct req_msg_field *mds_update_server[] = {
533 &RMF_OUT_UPDATE_REPLY,
536 static const struct req_msg_field *llog_origin_handle_create_client[] = {
542 static const struct req_msg_field *llogd_body_only[] = {
547 static const struct req_msg_field *llog_log_hdr_only[] = {
552 static const struct req_msg_field *llogd_conn_body_only[] = {
557 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
563 static const struct req_msg_field *obd_idx_read_client[] = {
568 static const struct req_msg_field *obd_idx_read_server[] = {
573 static const struct req_msg_field *ost_body_only[] = {
578 static const struct req_msg_field *ost_body_capa[] = {
584 static const struct req_msg_field *ost_destroy_client[] = {
592 static const struct req_msg_field *ost_brw_client[] = {
600 static const struct req_msg_field *ost_brw_read_server[] = {
605 static const struct req_msg_field *ost_brw_write_server[] = {
611 static const struct req_msg_field *ost_get_info_generic_server[] = {
616 static const struct req_msg_field *ost_get_info_generic_client[] = {
621 static const struct req_msg_field *ost_get_last_id_server[] = {
626 static const struct req_msg_field *ost_get_last_fid_client[] = {
632 static const struct req_msg_field *ost_get_last_fid_server[] = {
637 static const struct req_msg_field *ost_get_fiemap_client[] = {
643 static const struct req_msg_field *ost_get_fiemap_server[] = {
648 static const struct req_msg_field *mdt_hsm_progress[] = {
651 &RMF_MDS_HSM_PROGRESS,
654 static const struct req_msg_field *mdt_hsm_ct_register[] = {
657 &RMF_MDS_HSM_ARCHIVE,
660 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
665 static const struct req_msg_field *mdt_hsm_action_server[] = {
668 &RMF_MDS_HSM_CURRENT_ACTION,
671 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
677 static const struct req_msg_field *mdt_hsm_state_set[] = {
684 static const struct req_msg_field *mdt_hsm_request[] = {
687 &RMF_MDS_HSM_REQUEST,
688 &RMF_MDS_HSM_USER_ITEM,
692 static const struct req_msg_field *obd_lfsck_request[] = {
697 static const struct req_msg_field *obd_lfsck_reply[] = {
702 static struct req_format *req_formats[] = {
709 &RQF_MGS_CONFIG_READ,
719 &RQF_MDS_GETATTR_NAME,
723 &RQF_MDS_RELEASE_CLOSE,
726 &RQF_MDS_DONE_WRITING,
728 &RQF_MDS_REINT_CREATE,
729 &RQF_MDS_REINT_CREATE_RMT_ACL,
730 &RQF_MDS_REINT_CREATE_SLAVE,
731 &RQF_MDS_REINT_CREATE_SYM,
733 &RQF_MDS_REINT_UNLINK,
735 &RQF_MDS_REINT_RENAME,
736 &RQF_MDS_REINT_SETATTR,
737 &RQF_MDS_REINT_SETXATTR,
740 &RQF_MDS_HSM_PROGRESS,
741 &RQF_MDS_HSM_CT_REGISTER,
742 &RQF_MDS_HSM_CT_UNREGISTER,
743 &RQF_MDS_HSM_STATE_GET,
744 &RQF_MDS_HSM_STATE_SET,
746 &RQF_MDS_HSM_REQUEST,
747 &RQF_MDS_SWAP_LAYOUTS,
763 &RQF_OST_SET_GRANT_INFO,
765 &RQF_OST_GET_INFO_LAST_ID,
766 &RQF_OST_GET_INFO_LAST_FID,
767 &RQF_OST_SET_INFO_LAST_FID,
768 &RQF_OST_GET_INFO_FIEMAP,
770 &RQF_LDLM_ENQUEUE_LVB,
774 &RQF_LDLM_CP_CALLBACK,
775 &RQF_LDLM_BL_CALLBACK,
776 &RQF_LDLM_GL_CALLBACK,
777 &RQF_LDLM_GL_DESC_CALLBACK,
779 &RQF_LDLM_INTENT_BASIC,
780 &RQF_LDLM_INTENT_LAYOUT,
781 &RQF_LDLM_INTENT_GETATTR,
782 &RQF_LDLM_INTENT_OPEN,
783 &RQF_LDLM_INTENT_CREATE,
784 &RQF_LDLM_INTENT_UNLINK,
785 &RQF_LDLM_INTENT_GETXATTR,
786 &RQF_LDLM_INTENT_QUOTA,
789 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
790 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
791 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
792 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
793 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
794 &RQF_LLOG_ORIGIN_CONNECT,
800 struct req_msg_field {
801 const __u32 rmf_flags;
802 const char *rmf_name;
804 * Field length. (-1) means "variable length". If the
805 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
806 * but the actual size must be a whole multiple of \a rmf_size.
809 void (*rmf_swabber)(void *);
810 void (*rmf_dumper)(void *);
811 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
816 * The field is a string, must be NUL-terminated.
818 RMF_F_STRING = 1 << 0,
820 * The field's buffer size need not match the declared \a rmf_size.
822 RMF_F_NO_SIZE_CHECK = 1 << 1,
824 * The field's buffer size must be a whole multiple of the declared \a
825 * rmf_size and the \a rmf_swabber function must work on the declared \a
826 * rmf_size worth of bytes.
828 RMF_F_STRUCT_ARRAY = 1 << 2
836 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
837 .rmf_name = (name), \
838 .rmf_flags = (flags), \
839 .rmf_size = (size), \
840 .rmf_swabber = (void (*)(void*))(swabber), \
841 .rmf_dumper = (void (*)(void*))(dumper) \
844 struct req_msg_field RMF_GENERIC_DATA =
845 DEFINE_MSGF("generic_data", 0,
847 EXPORT_SYMBOL(RMF_GENERIC_DATA);
849 struct req_msg_field RMF_MGS_TARGET_INFO =
850 DEFINE_MSGF("mgs_target_info", 0,
851 sizeof(struct mgs_target_info),
852 lustre_swab_mgs_target_info, NULL);
853 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
855 struct req_msg_field RMF_MGS_SEND_PARAM =
856 DEFINE_MSGF("mgs_send_param", 0,
857 sizeof(struct mgs_send_param),
859 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
861 struct req_msg_field RMF_MGS_CONFIG_BODY =
862 DEFINE_MSGF("mgs_config_read request", 0,
863 sizeof(struct mgs_config_body),
864 lustre_swab_mgs_config_body, NULL);
865 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
867 struct req_msg_field RMF_MGS_CONFIG_RES =
868 DEFINE_MSGF("mgs_config_read reply ", 0,
869 sizeof(struct mgs_config_res),
870 lustre_swab_mgs_config_res, NULL);
871 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
873 struct req_msg_field RMF_U32 =
874 DEFINE_MSGF("generic u32", 0,
875 sizeof(__u32), lustre_swab_generic_32s, NULL);
876 EXPORT_SYMBOL(RMF_U32);
878 struct req_msg_field RMF_SETINFO_VAL =
879 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
880 EXPORT_SYMBOL(RMF_SETINFO_VAL);
882 struct req_msg_field RMF_GETINFO_KEY =
883 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
884 EXPORT_SYMBOL(RMF_GETINFO_KEY);
886 struct req_msg_field RMF_GETINFO_VALLEN =
887 DEFINE_MSGF("getinfo_vallen", 0,
888 sizeof(__u32), lustre_swab_generic_32s, NULL);
889 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
891 struct req_msg_field RMF_GETINFO_VAL =
892 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
893 EXPORT_SYMBOL(RMF_GETINFO_VAL);
895 struct req_msg_field RMF_SEQ_OPC =
896 DEFINE_MSGF("seq_query_opc", 0,
897 sizeof(__u32), lustre_swab_generic_32s, NULL);
898 EXPORT_SYMBOL(RMF_SEQ_OPC);
900 struct req_msg_field RMF_SEQ_RANGE =
901 DEFINE_MSGF("seq_query_range", 0,
902 sizeof(struct lu_seq_range),
903 lustre_swab_lu_seq_range, NULL);
904 EXPORT_SYMBOL(RMF_SEQ_RANGE);
906 struct req_msg_field RMF_FLD_OPC =
907 DEFINE_MSGF("fld_query_opc", 0,
908 sizeof(__u32), lustre_swab_generic_32s, NULL);
909 EXPORT_SYMBOL(RMF_FLD_OPC);
911 struct req_msg_field RMF_FLD_MDFLD =
912 DEFINE_MSGF("fld_query_mdfld", 0,
913 sizeof(struct lu_seq_range),
914 lustre_swab_lu_seq_range, NULL);
915 EXPORT_SYMBOL(RMF_FLD_MDFLD);
917 struct req_msg_field RMF_MDT_BODY =
918 DEFINE_MSGF("mdt_body", 0,
919 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
920 EXPORT_SYMBOL(RMF_MDT_BODY);
922 struct req_msg_field RMF_OBD_QUOTACTL =
923 DEFINE_MSGF("obd_quotactl", 0,
924 sizeof(struct obd_quotactl),
925 lustre_swab_obd_quotactl, NULL);
926 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
928 struct req_msg_field RMF_QUOTA_BODY =
929 DEFINE_MSGF("quota_body", 0,
930 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
931 EXPORT_SYMBOL(RMF_QUOTA_BODY);
933 struct req_msg_field RMF_MDT_EPOCH =
934 DEFINE_MSGF("mdt_ioepoch", 0,
935 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
936 EXPORT_SYMBOL(RMF_MDT_EPOCH);
938 struct req_msg_field RMF_PTLRPC_BODY =
939 DEFINE_MSGF("ptlrpc_body", 0,
940 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
941 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
943 struct req_msg_field RMF_CLOSE_DATA =
944 DEFINE_MSGF("data_version", 0,
945 sizeof(struct close_data), lustre_swab_close_data, NULL);
946 EXPORT_SYMBOL(RMF_CLOSE_DATA);
948 struct req_msg_field RMF_OBD_STATFS =
949 DEFINE_MSGF("obd_statfs", 0,
950 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
951 EXPORT_SYMBOL(RMF_OBD_STATFS);
953 struct req_msg_field RMF_SETINFO_KEY =
954 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
955 EXPORT_SYMBOL(RMF_SETINFO_KEY);
957 struct req_msg_field RMF_NAME =
958 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
959 EXPORT_SYMBOL(RMF_NAME);
961 struct req_msg_field RMF_SYMTGT =
962 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
963 EXPORT_SYMBOL(RMF_SYMTGT);
965 struct req_msg_field RMF_TGTUUID =
966 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
968 EXPORT_SYMBOL(RMF_TGTUUID);
970 struct req_msg_field RMF_CLUUID =
971 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
973 EXPORT_SYMBOL(RMF_CLUUID);
975 struct req_msg_field RMF_STRING =
976 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
977 EXPORT_SYMBOL(RMF_STRING);
979 struct req_msg_field RMF_LLOGD_BODY =
980 DEFINE_MSGF("llogd_body", 0,
981 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
982 EXPORT_SYMBOL(RMF_LLOGD_BODY);
984 struct req_msg_field RMF_LLOG_LOG_HDR =
985 DEFINE_MSGF("llog_log_hdr", 0,
986 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
987 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
989 struct req_msg_field RMF_LLOGD_CONN_BODY =
990 DEFINE_MSGF("llogd_conn_body", 0,
991 sizeof(struct llogd_conn_body),
992 lustre_swab_llogd_conn_body, NULL);
993 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
996 * connection handle received in MDS_CONNECT request.
998 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
999 * that the client does not interpret at all.
1001 struct req_msg_field RMF_CONN =
1002 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1003 EXPORT_SYMBOL(RMF_CONN);
1005 struct req_msg_field RMF_CONNECT_DATA =
1006 DEFINE_MSGF("cdata",
1007 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1008 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 53, 0)
1009 sizeof(struct obd_connect_data),
1011 /* For interoperability with 1.8 and 2.0 clients/servers.
1012 * The RPC verification code allows larger RPC buffers, but not
1013 * smaller buffers. Until we no longer need to keep compatibility
1014 * with older servers/clients we can only check that the buffer
1015 * size is at least as large as obd_connect_data_v1. That is not
1016 * not in itself harmful, since the chance of just corrupting this
1017 * field is low. See JIRA LU-16 for details. */
1018 sizeof(struct obd_connect_data_v1),
1020 lustre_swab_connect, NULL);
1021 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1023 struct req_msg_field RMF_DLM_REQ =
1024 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1025 sizeof(struct ldlm_request),
1026 lustre_swab_ldlm_request, NULL);
1027 EXPORT_SYMBOL(RMF_DLM_REQ);
1029 struct req_msg_field RMF_DLM_REP =
1030 DEFINE_MSGF("dlm_rep", 0,
1031 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1032 EXPORT_SYMBOL(RMF_DLM_REP);
1034 struct req_msg_field RMF_LDLM_INTENT =
1035 DEFINE_MSGF("ldlm_intent", 0,
1036 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1037 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1039 struct req_msg_field RMF_DLM_LVB =
1040 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1041 EXPORT_SYMBOL(RMF_DLM_LVB);
1043 struct req_msg_field RMF_DLM_GL_DESC =
1044 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1045 lustre_swab_gl_desc, NULL);
1046 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1048 struct req_msg_field RMF_MDT_MD =
1049 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1050 EXPORT_SYMBOL(RMF_MDT_MD);
1052 struct req_msg_field RMF_REC_REINT =
1053 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1054 lustre_swab_mdt_rec_reint, NULL);
1055 EXPORT_SYMBOL(RMF_REC_REINT);
1057 /* FIXME: this length should be defined as a macro */
1058 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1060 EXPORT_SYMBOL(RMF_EADATA);
1062 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1063 EXPORT_SYMBOL(RMF_EAVALS);
1065 struct req_msg_field RMF_ACL =
1066 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1067 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1068 EXPORT_SYMBOL(RMF_ACL);
1070 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1071 struct req_msg_field RMF_LOGCOOKIES =
1072 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1073 sizeof(struct llog_cookie), NULL, NULL);
1074 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1076 struct req_msg_field RMF_CAPA1 =
1077 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1078 lustre_swab_lustre_capa, NULL);
1079 EXPORT_SYMBOL(RMF_CAPA1);
1081 struct req_msg_field RMF_CAPA2 =
1082 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1083 lustre_swab_lustre_capa, NULL);
1084 EXPORT_SYMBOL(RMF_CAPA2);
1086 struct req_msg_field RMF_LAYOUT_INTENT =
1087 DEFINE_MSGF("layout_intent", 0,
1088 sizeof(struct layout_intent), lustre_swab_layout_intent,
1090 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1093 * OST request field.
1095 struct req_msg_field RMF_OST_BODY =
1096 DEFINE_MSGF("ost_body", 0,
1097 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1098 EXPORT_SYMBOL(RMF_OST_BODY);
1100 struct req_msg_field RMF_OBD_IOOBJ =
1101 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1102 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1103 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1105 struct req_msg_field RMF_NIOBUF_REMOTE =
1106 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1107 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1109 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1111 struct req_msg_field RMF_RCS =
1112 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1113 lustre_swab_generic_32s, dump_rcs);
1114 EXPORT_SYMBOL(RMF_RCS);
1116 struct req_msg_field RMF_EAVALS_LENS =
1117 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1118 lustre_swab_generic_32s, NULL);
1119 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1121 struct req_msg_field RMF_OBD_ID =
1122 DEFINE_MSGF("obd_id", 0,
1123 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1124 EXPORT_SYMBOL(RMF_OBD_ID);
1126 struct req_msg_field RMF_FID =
1127 DEFINE_MSGF("fid", 0,
1128 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1129 EXPORT_SYMBOL(RMF_FID);
1131 struct req_msg_field RMF_OST_ID =
1132 DEFINE_MSGF("ost_id", 0,
1133 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1134 EXPORT_SYMBOL(RMF_OST_ID);
1136 struct req_msg_field RMF_FIEMAP_KEY =
1137 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1138 lustre_swab_fiemap, NULL);
1139 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1141 struct req_msg_field RMF_FIEMAP_VAL =
1142 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1143 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1145 struct req_msg_field RMF_IDX_INFO =
1146 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1147 lustre_swab_idx_info, NULL);
1148 EXPORT_SYMBOL(RMF_IDX_INFO);
1149 struct req_msg_field RMF_HSM_USER_STATE =
1150 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1151 lustre_swab_hsm_user_state, NULL);
1152 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1154 struct req_msg_field RMF_HSM_STATE_SET =
1155 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1156 lustre_swab_hsm_state_set, NULL);
1157 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1159 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1160 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1161 lustre_swab_hsm_progress_kernel, NULL);
1162 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1164 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1165 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1166 lustre_swab_hsm_current_action, NULL);
1167 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1169 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1170 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1171 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1173 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1175 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1176 DEFINE_MSGF("hsm_archive", 0,
1177 sizeof(__u32), lustre_swab_generic_32s, NULL);
1178 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1180 struct req_msg_field RMF_MDS_HSM_REQUEST =
1181 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1182 lustre_swab_hsm_request, NULL);
1183 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1185 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1186 lustre_swab_object_update_request, NULL);
1187 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1189 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1190 DEFINE_MSGF("object_update_reply", 0, -1,
1191 lustre_swab_object_update_reply, NULL);
1192 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1194 struct req_msg_field RMF_SWAP_LAYOUTS =
1195 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1196 lustre_swab_swap_layouts, NULL);
1197 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1199 struct req_msg_field RMF_LFSCK_REQUEST =
1200 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1201 lustre_swab_lfsck_request, NULL);
1202 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1204 struct req_msg_field RMF_LFSCK_REPLY =
1205 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1206 lustre_swab_lfsck_reply, NULL);
1207 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1214 const char *rf_name;
1218 const struct req_msg_field **d;
1219 } rf_fields[RCL_NR];
1222 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1236 #define DEFINE_REQ_FMT0(name, client, server) \
1237 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1239 struct req_format RQF_OBD_PING =
1240 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1241 EXPORT_SYMBOL(RQF_OBD_PING);
1243 struct req_format RQF_OBD_SET_INFO =
1244 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1245 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1247 /* Read index file through the network */
1248 struct req_format RQF_OBD_IDX_READ =
1249 DEFINE_REQ_FMT0("OBD_IDX_READ",
1250 obd_idx_read_client, obd_idx_read_server);
1251 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1253 struct req_format RQF_SEC_CTX =
1254 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1255 EXPORT_SYMBOL(RQF_SEC_CTX);
1257 struct req_format RQF_MGS_TARGET_REG =
1258 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1259 mgs_target_info_only);
1260 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1262 struct req_format RQF_MGS_SET_INFO =
1263 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1265 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1267 struct req_format RQF_MGS_CONFIG_READ =
1268 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1269 mgs_config_read_server);
1270 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1272 struct req_format RQF_SEQ_QUERY =
1273 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1274 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1276 struct req_format RQF_FLD_QUERY =
1277 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1278 EXPORT_SYMBOL(RQF_FLD_QUERY);
1280 struct req_format RQF_FLD_READ =
1281 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1282 EXPORT_SYMBOL(RQF_FLD_READ);
1284 struct req_format RQF_LOG_CANCEL =
1285 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1286 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1288 struct req_format RQF_MDS_QUOTACHECK =
1289 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1290 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1292 struct req_format RQF_OST_QUOTACHECK =
1293 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1294 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1296 struct req_format RQF_MDS_QUOTACTL =
1297 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1298 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1300 struct req_format RQF_OST_QUOTACTL =
1301 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1302 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1304 struct req_format RQF_QC_CALLBACK =
1305 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1306 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1308 struct req_format RQF_QUOTA_DQACQ =
1309 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1310 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1312 struct req_format RQF_LDLM_INTENT_QUOTA =
1313 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1314 ldlm_intent_quota_client,
1315 ldlm_intent_quota_server);
1316 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1318 struct req_format RQF_MDS_GETSTATUS =
1319 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1320 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1322 struct req_format RQF_MDS_STATFS =
1323 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1324 EXPORT_SYMBOL(RQF_MDS_STATFS);
1326 struct req_format RQF_MDS_SYNC =
1327 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1328 EXPORT_SYMBOL(RQF_MDS_SYNC);
1330 struct req_format RQF_MDS_GETATTR =
1331 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1332 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1334 struct req_format RQF_MDS_GETXATTR =
1335 DEFINE_REQ_FMT0("MDS_GETXATTR",
1336 mds_getxattr_client, mds_getxattr_server);
1337 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1339 struct req_format RQF_MDS_GETATTR_NAME =
1340 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1341 mds_getattr_name_client, mds_getattr_server);
1342 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1344 struct req_format RQF_MDS_REINT =
1345 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1346 EXPORT_SYMBOL(RQF_MDS_REINT);
1348 struct req_format RQF_MDS_REINT_CREATE =
1349 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1350 mds_reint_create_client, mdt_body_capa);
1351 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1353 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1354 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1355 mds_reint_create_rmt_acl_client, mdt_body_capa);
1356 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1358 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1359 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1360 mds_reint_create_slave_client, mdt_body_capa);
1361 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1363 struct req_format RQF_MDS_REINT_CREATE_SYM =
1364 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1365 mds_reint_create_sym_client, mdt_body_capa);
1366 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1368 struct req_format RQF_MDS_REINT_OPEN =
1369 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1370 mds_reint_open_client, mds_reint_open_server);
1371 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1373 struct req_format RQF_MDS_REINT_UNLINK =
1374 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1375 mds_last_unlink_server);
1376 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1378 struct req_format RQF_MDS_REINT_LINK =
1379 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1380 mds_reint_link_client, mdt_body_only);
1381 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1383 struct req_format RQF_MDS_REINT_RENAME =
1384 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1385 mds_last_unlink_server);
1386 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1388 struct req_format RQF_MDS_REINT_SETATTR =
1389 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1390 mds_reint_setattr_client, mds_setattr_server);
1391 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1393 struct req_format RQF_MDS_REINT_SETXATTR =
1394 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1395 mds_reint_setxattr_client, mdt_body_only);
1396 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1398 struct req_format RQF_MDS_CONNECT =
1399 DEFINE_REQ_FMT0("MDS_CONNECT",
1400 obd_connect_client, obd_connect_server);
1401 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1403 struct req_format RQF_MDS_DISCONNECT =
1404 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1405 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1407 struct req_format RQF_MDS_GET_INFO =
1408 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1409 mds_getinfo_server);
1410 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1412 struct req_format RQF_OUT_UPDATE =
1413 DEFINE_REQ_FMT0("OUT_UPDATE_OBJ", mds_update_client,
1415 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1417 struct req_format RQF_LDLM_ENQUEUE =
1418 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1419 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1420 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1422 struct req_format RQF_LDLM_ENQUEUE_LVB =
1423 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1424 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1425 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1427 struct req_format RQF_LDLM_CONVERT =
1428 DEFINE_REQ_FMT0("LDLM_CONVERT",
1429 ldlm_enqueue_client, ldlm_enqueue_server);
1430 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1432 struct req_format RQF_LDLM_CANCEL =
1433 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1434 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1436 struct req_format RQF_LDLM_CALLBACK =
1437 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1438 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1440 struct req_format RQF_LDLM_CP_CALLBACK =
1441 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1442 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1444 struct req_format RQF_LDLM_BL_CALLBACK =
1445 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1446 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1448 struct req_format RQF_LDLM_GL_CALLBACK =
1449 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1450 ldlm_gl_callback_server);
1451 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1453 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1454 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1455 ldlm_gl_callback_server);
1456 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1458 struct req_format RQF_LDLM_INTENT_BASIC =
1459 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1460 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1461 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1463 struct req_format RQF_LDLM_INTENT =
1464 DEFINE_REQ_FMT0("LDLM_INTENT",
1465 ldlm_intent_client, ldlm_intent_server);
1466 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1468 struct req_format RQF_LDLM_INTENT_LAYOUT =
1469 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1470 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1471 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1473 struct req_format RQF_LDLM_INTENT_GETATTR =
1474 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1475 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1476 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1478 struct req_format RQF_LDLM_INTENT_OPEN =
1479 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1480 ldlm_intent_open_client, ldlm_intent_open_server);
1481 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1483 struct req_format RQF_LDLM_INTENT_CREATE =
1484 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1485 ldlm_intent_create_client, ldlm_intent_getattr_server);
1486 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1488 struct req_format RQF_LDLM_INTENT_UNLINK =
1489 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1490 ldlm_intent_unlink_client, ldlm_intent_server);
1491 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1493 struct req_format RQF_LDLM_INTENT_GETXATTR =
1494 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1495 ldlm_intent_getxattr_client,
1496 ldlm_intent_getxattr_server);
1497 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1499 struct req_format RQF_MDS_CLOSE =
1500 DEFINE_REQ_FMT0("MDS_CLOSE",
1501 mdt_close_client, mds_last_unlink_server);
1502 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1504 struct req_format RQF_MDS_RELEASE_CLOSE =
1505 DEFINE_REQ_FMT0("MDS_CLOSE",
1506 mdt_release_close_client, mds_last_unlink_server);
1507 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1509 struct req_format RQF_MDS_DONE_WRITING =
1510 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1511 mdt_close_client, mdt_body_only);
1512 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1514 struct req_format RQF_MDS_READPAGE =
1515 DEFINE_REQ_FMT0("MDS_READPAGE",
1516 mdt_body_capa, mdt_body_only);
1517 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1519 struct req_format RQF_MDS_HSM_ACTION =
1520 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1521 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1523 struct req_format RQF_MDS_HSM_PROGRESS =
1524 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1525 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1527 struct req_format RQF_MDS_HSM_CT_REGISTER =
1528 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1529 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1531 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1532 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1533 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1535 struct req_format RQF_MDS_HSM_STATE_GET =
1536 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1537 mdt_body_capa, mdt_hsm_state_get_server);
1538 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1540 struct req_format RQF_MDS_HSM_STATE_SET =
1541 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1542 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1544 struct req_format RQF_MDS_HSM_REQUEST =
1545 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1546 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1548 struct req_format RQF_MDS_SWAP_LAYOUTS =
1549 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1550 mdt_swap_layouts, empty);
1551 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1553 /* This is for split */
1554 struct req_format RQF_MDS_WRITEPAGE =
1555 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1556 mdt_body_capa, mdt_body_only);
1557 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1559 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1560 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1561 llog_origin_handle_create_client, llogd_body_only);
1562 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1564 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1565 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1566 llogd_body_only, llogd_body_only);
1567 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1569 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1570 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1571 llogd_body_only, llog_origin_handle_next_block_server);
1572 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1574 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1575 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1576 llogd_body_only, llog_origin_handle_next_block_server);
1577 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1579 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1580 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1581 llogd_body_only, llog_log_hdr_only);
1582 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1584 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1585 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1586 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1588 struct req_format RQF_CONNECT =
1589 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1590 EXPORT_SYMBOL(RQF_CONNECT);
1592 struct req_format RQF_OST_CONNECT =
1593 DEFINE_REQ_FMT0("OST_CONNECT",
1594 obd_connect_client, obd_connect_server);
1595 EXPORT_SYMBOL(RQF_OST_CONNECT);
1597 struct req_format RQF_OST_DISCONNECT =
1598 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1599 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1601 struct req_format RQF_OST_GETATTR =
1602 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1603 EXPORT_SYMBOL(RQF_OST_GETATTR);
1605 struct req_format RQF_OST_SETATTR =
1606 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1607 EXPORT_SYMBOL(RQF_OST_SETATTR);
1609 struct req_format RQF_OST_CREATE =
1610 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1611 EXPORT_SYMBOL(RQF_OST_CREATE);
1613 struct req_format RQF_OST_PUNCH =
1614 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1615 EXPORT_SYMBOL(RQF_OST_PUNCH);
1617 struct req_format RQF_OST_SYNC =
1618 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1619 EXPORT_SYMBOL(RQF_OST_SYNC);
1621 struct req_format RQF_OST_DESTROY =
1622 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1623 EXPORT_SYMBOL(RQF_OST_DESTROY);
1625 struct req_format RQF_OST_BRW_READ =
1626 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1627 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1629 struct req_format RQF_OST_BRW_WRITE =
1630 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1631 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1633 struct req_format RQF_OST_STATFS =
1634 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1635 EXPORT_SYMBOL(RQF_OST_STATFS);
1637 struct req_format RQF_OST_SET_GRANT_INFO =
1638 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1640 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1642 struct req_format RQF_OST_GET_INFO =
1643 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1644 ost_get_info_generic_server);
1645 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1647 struct req_format RQF_OST_GET_INFO_LAST_ID =
1648 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1649 ost_get_last_id_server);
1650 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1652 struct req_format RQF_OST_GET_INFO_LAST_FID =
1653 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1654 ost_get_last_fid_server);
1655 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1657 struct req_format RQF_OST_SET_INFO_LAST_FID =
1658 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1660 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1662 struct req_format RQF_OST_GET_INFO_FIEMAP =
1663 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1664 ost_get_fiemap_server);
1665 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1667 struct req_format RQF_LFSCK_NOTIFY =
1668 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1669 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1671 struct req_format RQF_LFSCK_QUERY =
1672 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1673 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1675 #if !defined(__REQ_LAYOUT_USER__)
1677 /* Convenience macro */
1678 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1681 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1682 * field of RQFs and the \a rmf_offset field of RMFs.
1684 int req_layout_init(void)
1689 struct req_format *rf = NULL;
1691 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1692 rf = req_formats[i];
1694 for (j = 0; j < RCL_NR; ++j) {
1695 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1696 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1697 struct req_msg_field *field;
1699 field = (typeof(field))rf->rf_fields[j].d[k];
1700 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1701 || field->rmf_size > 0);
1702 LASSERT(field->rmf_offset[i][j] == 0);
1704 * k + 1 to detect unused format/field
1707 field->rmf_offset[i][j] = k + 1;
1713 EXPORT_SYMBOL(req_layout_init);
1715 void req_layout_fini(void)
1718 EXPORT_SYMBOL(req_layout_fini);
1721 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1723 * Actual/expected field sizes are set elsewhere in functions in this file:
1724 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1725 * req_capsule_msg_size(). The \a rc_area information is used by.
1726 * ptlrpc_request_set_replen().
1728 void req_capsule_init_area(struct req_capsule *pill)
1732 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1733 pill->rc_area[RCL_CLIENT][i] = -1;
1734 pill->rc_area[RCL_SERVER][i] = -1;
1737 EXPORT_SYMBOL(req_capsule_init_area);
1740 * Initialize a pill.
1742 * The \a location indicates whether the caller is executing on the client side
1743 * (RCL_CLIENT) or server side (RCL_SERVER)..
1745 void req_capsule_init(struct req_capsule *pill,
1746 struct ptlrpc_request *req,
1747 enum req_location location)
1749 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1752 * Today all capsules are embedded in ptlrpc_request structs,
1753 * but just in case that ever isn't the case, we don't reach
1754 * into req unless req != NULL and pill is the one embedded in
1757 * The req->rq_pill_init flag makes it safe to initialize a pill
1758 * twice, which might happen in the OST paths as a result of the
1759 * high-priority RPC queue getting peeked at before ost_handle()
1760 * handles an OST RPC.
1762 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1765 memset(pill, 0, sizeof *pill);
1767 pill->rc_loc = location;
1768 req_capsule_init_area(pill);
1770 if (req != NULL && pill == &req->rq_pill)
1771 req->rq_pill_init = 1;
1773 EXPORT_SYMBOL(req_capsule_init);
1775 void req_capsule_fini(struct req_capsule *pill)
1778 EXPORT_SYMBOL(req_capsule_fini);
1780 static int __req_format_is_sane(const struct req_format *fmt)
1783 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1784 req_formats[fmt->rf_idx] == fmt;
1787 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1788 enum req_location loc)
1790 struct ptlrpc_request *req;
1793 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1797 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1798 * (see req_capsule_extend()).
1800 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1802 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1803 LASSERT(__req_format_is_sane(fmt));
1807 EXPORT_SYMBOL(req_capsule_set);
1810 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1813 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1814 * variable-sized fields. The field sizes come from the declared \a rmf_size
1815 * field of a \a pill's \a rc_fmt's RMF's.
1817 int req_capsule_filled_sizes(struct req_capsule *pill,
1818 enum req_location loc)
1820 const struct req_format *fmt = pill->rc_fmt;
1823 LASSERT(fmt != NULL);
1825 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1826 if (pill->rc_area[loc][i] == -1) {
1827 pill->rc_area[loc][i] =
1828 fmt->rf_fields[loc].d[i]->rmf_size;
1829 if (pill->rc_area[loc][i] == -1) {
1831 * Skip the following fields.
1833 * If this LASSERT() trips then you're missing a
1834 * call to req_capsule_set_size().
1836 LASSERT(loc != RCL_SERVER);
1843 EXPORT_SYMBOL(req_capsule_filled_sizes);
1846 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1848 * This function uses the \a pill's \a rc_area as filled in by
1849 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1852 int req_capsule_server_pack(struct req_capsule *pill)
1854 const struct req_format *fmt;
1858 LASSERT(pill->rc_loc == RCL_SERVER);
1860 LASSERT(fmt != NULL);
1862 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1863 rc = lustre_pack_reply(pill->rc_req, count,
1864 pill->rc_area[RCL_SERVER], NULL);
1866 DEBUG_REQ(D_ERROR, pill->rc_req,
1867 "Cannot pack %d fields in format `%s': ",
1868 count, fmt->rf_name);
1872 EXPORT_SYMBOL(req_capsule_server_pack);
1875 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1876 * corresponding to the given RMF (\a field).
1878 static int __req_capsule_offset(const struct req_capsule *pill,
1879 const struct req_msg_field *field,
1880 enum req_location loc)
1884 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1885 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1886 pill->rc_fmt->rf_name,
1887 field->rmf_name, offset, loc);
1890 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1895 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1900 swabber_dumper_helper(struct req_capsule *pill,
1901 const struct req_msg_field *field,
1902 enum req_location loc,
1904 void *value, int len, int dump, void (*swabber)( void *))
1910 int inout = loc == RCL_CLIENT;
1912 swabber = swabber ?: field->rmf_swabber;
1914 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1915 swabber != NULL && value != NULL)
1920 if (!field->rmf_dumper)
1923 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1925 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1926 do_swab ? "unswabbed " : "", field->rmf_name);
1927 field->rmf_dumper(value);
1932 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1934 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1935 "follows\n", field->rmf_name);
1936 field->rmf_dumper(value);
1943 * We're swabbing an array; swabber() swabs a single array element, so
1944 * swab every element.
1946 LASSERT((len % field->rmf_size) == 0);
1947 for (p = value, i = 0, n = len / field->rmf_size;
1949 i++, p += field->rmf_size) {
1951 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1952 "element %d follows\n",
1953 do_swab ? "unswabbed " : "", field->rmf_name, i);
1954 field->rmf_dumper(p);
1960 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1961 "element %d follows\n", field->rmf_name, i);
1962 field->rmf_dumper(value);
1966 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1970 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1971 * corresponding to the given RMF (\a field).
1973 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1974 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1975 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1976 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1977 * element of the array swabbed.
1979 static void *__req_capsule_get(struct req_capsule *pill,
1980 const struct req_msg_field *field,
1981 enum req_location loc,
1982 void (*swabber)( void *),
1985 const struct req_format *fmt;
1986 struct lustre_msg *msg;
1991 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1993 static const char *rcl_names[RCL_NR] = {
1994 [RCL_CLIENT] = "client",
1995 [RCL_SERVER] = "server"
1998 LASSERT(pill != NULL);
1999 LASSERT(pill != LP_POISON);
2001 LASSERT(fmt != NULL);
2002 LASSERT(fmt != LP_POISON);
2003 LASSERT(__req_format_is_sane(fmt));
2005 offset = __req_capsule_offset(pill, field, loc);
2007 msg = __req_msg(pill, loc);
2008 LASSERT(msg != NULL);
2010 getter = (field->rmf_flags & RMF_F_STRING) ?
2011 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2013 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2015 * We've already asserted that field->rmf_size > 0 in
2016 * req_layout_init().
2018 len = lustre_msg_buflen(msg, offset);
2019 if ((len % field->rmf_size) != 0) {
2020 CERROR("%s: array field size mismatch "
2021 "%d modulo %d != 0 (%d)\n",
2022 field->rmf_name, len, field->rmf_size, loc);
2025 } else if (pill->rc_area[loc][offset] != -1) {
2026 len = pill->rc_area[loc][offset];
2028 len = max(field->rmf_size, 0);
2030 value = getter(msg, offset, len);
2032 if (value == NULL) {
2033 DEBUG_REQ(D_ERROR, pill->rc_req,
2034 "Wrong buffer for field `%s' (%d of %d) "
2035 "in format `%s': %d vs. %d (%s)\n",
2036 field->rmf_name, offset, lustre_msg_bufcount(msg),
2037 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2040 swabber_dumper_helper(pill, field, loc, offset, value, len,
2048 * Dump a request and/or reply
2050 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2052 const struct req_format *fmt;
2053 const struct req_msg_field *field;
2059 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2060 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2061 field = FMT_FIELD(fmt, loc, i);
2062 if (field->rmf_dumper == NULL) {
2064 * FIXME Add a default hex dumper for fields that don't
2065 * have a specific dumper
2067 len = req_capsule_get_size(pill, field, loc);
2068 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2069 "field size is %d\n", field->rmf_name, len);
2071 /* It's the dumping side-effect that we're interested in */
2072 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2075 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2081 void req_capsule_client_dump(struct req_capsule *pill)
2083 __req_capsule_dump(pill, RCL_CLIENT);
2085 EXPORT_SYMBOL(req_capsule_client_dump);
2090 void req_capsule_server_dump(struct req_capsule *pill)
2092 __req_capsule_dump(pill, RCL_SERVER);
2094 EXPORT_SYMBOL(req_capsule_server_dump);
2097 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2098 * buffer corresponding to the given RMF (\a field) of a \a pill.
2100 void *req_capsule_client_get(struct req_capsule *pill,
2101 const struct req_msg_field *field)
2103 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2105 EXPORT_SYMBOL(req_capsule_client_get);
2108 * Same as req_capsule_client_get(), but with a \a swabber argument.
2110 * Currently unused; will be removed when req_capsule_server_swab_get() is
2113 void *req_capsule_client_swab_get(struct req_capsule *pill,
2114 const struct req_msg_field *field,
2117 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2119 EXPORT_SYMBOL(req_capsule_client_swab_get);
2122 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2124 * First the \a pill's request \a field's size is set (\a rc_area) using
2125 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2128 void *req_capsule_client_sized_get(struct req_capsule *pill,
2129 const struct req_msg_field *field,
2132 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2133 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2135 EXPORT_SYMBOL(req_capsule_client_sized_get);
2138 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2139 * buffer corresponding to the given RMF (\a field) of a \a pill.
2141 void *req_capsule_server_get(struct req_capsule *pill,
2142 const struct req_msg_field *field)
2144 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2146 EXPORT_SYMBOL(req_capsule_server_get);
2149 * Same as req_capsule_server_get(), but with a \a swabber argument.
2151 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2152 * swabbing done outside this capsule abstraction.
2154 void *req_capsule_server_swab_get(struct req_capsule *pill,
2155 const struct req_msg_field *field,
2158 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2160 EXPORT_SYMBOL(req_capsule_server_swab_get);
2163 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2165 * First the \a pill's request \a field's size is set (\a rc_area) using
2166 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2169 void *req_capsule_server_sized_get(struct req_capsule *pill,
2170 const struct req_msg_field *field,
2173 req_capsule_set_size(pill, field, RCL_SERVER, len);
2174 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2176 EXPORT_SYMBOL(req_capsule_server_sized_get);
2178 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2179 const struct req_msg_field *field,
2180 int len, void *swabber)
2182 req_capsule_set_size(pill, field, RCL_SERVER, len);
2183 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2185 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2188 * Returns the buffer of a \a pill corresponding to the given \a field from the
2189 * request (if the caller is executing on the server-side) or reply (if the
2190 * caller is executing on the client-side).
2192 * This function convienient for use is code that could be executed on the
2193 * client and server alike.
2195 const void *req_capsule_other_get(struct req_capsule *pill,
2196 const struct req_msg_field *field)
2198 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2200 EXPORT_SYMBOL(req_capsule_other_get);
2203 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2204 * field of the given \a pill.
2206 * This function must be used when constructing variable sized fields of a
2209 void req_capsule_set_size(struct req_capsule *pill,
2210 const struct req_msg_field *field,
2211 enum req_location loc, int size)
2213 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2215 if ((size != field->rmf_size) &&
2216 (field->rmf_size != -1) &&
2217 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2219 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2220 (size % field->rmf_size != 0)) {
2221 CERROR("%s: array field size mismatch "
2222 "%d %% %d != 0 (%d)\n",
2223 field->rmf_name, size, field->rmf_size, loc);
2225 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2226 size < field->rmf_size) {
2227 CERROR("%s: field size mismatch %d != %d (%d)\n",
2228 field->rmf_name, size, field->rmf_size, loc);
2233 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2235 EXPORT_SYMBOL(req_capsule_set_size);
2238 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2239 * for the given \a pill's given \a field.
2241 * NB: this function doesn't correspond with req_capsule_set_size(), which
2242 * actually sets the size in pill.rc_area[loc][offset], but this function
2243 * returns the message buflen[offset], maybe we should use another name.
2245 int req_capsule_get_size(const struct req_capsule *pill,
2246 const struct req_msg_field *field,
2247 enum req_location loc)
2249 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2251 return lustre_msg_buflen(__req_msg(pill, loc),
2252 __req_capsule_offset(pill, field, loc));
2254 EXPORT_SYMBOL(req_capsule_get_size);
2257 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2258 * given \a pill's request or reply (\a loc) given the field size recorded in
2259 * the \a pill's rc_area.
2261 * See also req_capsule_set_size().
2263 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2265 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2266 pill->rc_fmt->rf_fields[loc].nr,
2267 pill->rc_area[loc]);
2271 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2272 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2273 * PTLRPC request or reply given only an RQF (\a fmt).
2275 * This function should not be used for formats which contain variable size
2278 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2279 enum req_location loc)
2284 * This function should probably LASSERT() that fmt has no fields with
2285 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2286 * elements in the array there will ultimately be, but then, we could
2287 * assume that there will be at least one element, and that's just what
2290 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2294 for (; i < fmt->rf_fields[loc].nr; ++i)
2295 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2296 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2302 * Changes the format of an RPC.
2304 * The pill must already have been initialized, which means that it already has
2305 * a request format. The new format \a fmt must be an extension of the pill's
2306 * old format. Specifically: the new format must have as many request and reply
2307 * fields as the old one, and all fields shared by the old and new format must
2308 * be at least as large in the new format.
2310 * The new format's fields may be of different "type" than the old format, but
2311 * only for fields that are "opaque" blobs: fields which have a) have no
2312 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2313 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2314 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2315 * according to the key field. When the value, according to the key, contains a
2316 * structure (or array thereof) to be swabbed, the format should be changed to
2317 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2320 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2325 const struct req_format *old;
2327 LASSERT(pill->rc_fmt != NULL);
2328 LASSERT(__req_format_is_sane(fmt));
2332 * Sanity checking...
2334 for (i = 0; i < RCL_NR; ++i) {
2335 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2336 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2337 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2339 /* "opaque" fields can be transmogrified */
2340 if (ofield->rmf_swabber == NULL &&
2341 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2342 (ofield->rmf_size == -1 ||
2343 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2345 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2348 * Last field in old format can be shorter than in new.
2350 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2351 FMT_FIELD(old, i, j)->rmf_size);
2356 EXPORT_SYMBOL(req_capsule_extend);
2359 * This function returns a non-zero value if the given \a field is present in
2360 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2363 int req_capsule_has_field(const struct req_capsule *pill,
2364 const struct req_msg_field *field,
2365 enum req_location loc)
2367 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2369 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2371 EXPORT_SYMBOL(req_capsule_has_field);
2374 * Returns a non-zero value if the given \a field is present in the given \a
2375 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2377 int req_capsule_field_present(const struct req_capsule *pill,
2378 const struct req_msg_field *field,
2379 enum req_location loc)
2383 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2384 LASSERT(req_capsule_has_field(pill, field, loc));
2386 offset = __req_capsule_offset(pill, field, loc);
2387 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2389 EXPORT_SYMBOL(req_capsule_field_present);
2392 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2393 * request or reply (\a loc).
2395 * This is not the opposite of req_capsule_extend().
2397 void req_capsule_shrink(struct req_capsule *pill,
2398 const struct req_msg_field *field,
2399 unsigned int newlen,
2400 enum req_location loc)
2402 const struct req_format *fmt;
2403 struct lustre_msg *msg;
2408 LASSERT(fmt != NULL);
2409 LASSERT(__req_format_is_sane(fmt));
2410 LASSERT(req_capsule_has_field(pill, field, loc));
2411 LASSERT(req_capsule_field_present(pill, field, loc));
2413 offset = __req_capsule_offset(pill, field, loc);
2415 msg = __req_msg(pill, loc);
2416 len = lustre_msg_buflen(msg, offset);
2417 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2418 fmt->rf_name, field->rmf_name, len, newlen);
2420 if (loc == RCL_CLIENT)
2421 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2424 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2427 EXPORT_SYMBOL(req_capsule_shrink);
2429 int req_capsule_server_grow(struct req_capsule *pill,
2430 const struct req_msg_field *field,
2431 unsigned int newlen)
2433 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2435 int offset, len, rc;
2437 LASSERT(pill->rc_fmt != NULL);
2438 LASSERT(__req_format_is_sane(pill->rc_fmt));
2439 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2440 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2442 len = req_capsule_get_size(pill, field, RCL_SERVER);
2443 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2444 if (pill->rc_req->rq_repbuf_len >=
2445 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2446 CERROR("Inplace repack might be done\n");
2448 pill->rc_req->rq_reply_state = NULL;
2449 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2450 rc = req_capsule_server_pack(pill);
2452 /* put old rs back, the caller will decide what to do */
2453 pill->rc_req->rq_reply_state = rs;
2456 nrs = pill->rc_req->rq_reply_state;
2457 /* Now we need only buffers, copy first chunk */
2458 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2459 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2460 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2461 memcpy(to, from, len);
2462 /* check if we have tail and copy it too */
2463 if (rs->rs_msg->lm_bufcount > offset + 1) {
2464 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2465 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2466 offset = rs->rs_msg->lm_bufcount - 1;
2467 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2468 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2469 memcpy(to, from, len);
2471 /* drop old reply if everything is fine */
2472 if (rs->rs_difficult) {
2476 nrs->rs_difficult = 1;
2477 nrs->rs_no_ack = rs->rs_no_ack;
2478 for (i = 0; i < rs->rs_nlocks; i++) {
2479 nrs->rs_locks[i] = rs->rs_locks[i];
2480 nrs->rs_modes[i] = rs->rs_modes[i];
2484 rs->rs_difficult = 0;
2487 ptlrpc_rs_decref(rs);
2490 EXPORT_SYMBOL(req_capsule_server_grow);
2491 /* __REQ_LAYOUT_USER__ */