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
54 #include <linux/module.h>
56 # include <liblustre.h>
59 /* LUSTRE_VERSION_CODE */
60 #include <lustre_ver.h>
62 #include <obd_support.h>
63 /* lustre_swab_mdt_body */
64 #include <lustre/lustre_idl.h>
65 /* obd2cli_tgt() (required by DEBUG_REQ()) */
67 #include <lustre_debug.h>
68 #include <lustre_update.h>
69 #endif /* !__REQ_LAYOUT_USER__ */
71 /* struct ptlrpc_request, lustre_msg* */
72 #include <lustre_req_layout.h>
73 #include <lustre_acl.h>
76 * RQFs (see below) refer to two struct req_msg_field arrays describing the
77 * client request and server reply, respectively.
79 /* empty set of fields... for suitable definition of emptiness. */
80 static const struct req_msg_field *empty[] = {
84 static const struct req_msg_field *mgs_target_info_only[] = {
89 static const struct req_msg_field *mgs_set_info[] = {
94 static const struct req_msg_field *mgs_config_read_client[] = {
99 static const struct req_msg_field *mgs_config_read_server[] = {
104 static const struct req_msg_field *log_cancel_client[] = {
109 static const struct req_msg_field *mdt_body_only[] = {
114 static const struct req_msg_field *mdt_body_capa[] = {
120 static const struct req_msg_field *quotactl_only[] = {
125 static const struct req_msg_field *quota_body_only[] = {
130 static const struct req_msg_field *ldlm_intent_quota_client[] = {
137 static const struct req_msg_field *ldlm_intent_quota_server[] = {
144 static const struct req_msg_field *mdt_close_client[] = {
151 static const struct req_msg_field *mdt_release_close_client[] = {
159 static const struct req_msg_field *obd_statfs_server[] = {
164 static const struct req_msg_field *seq_query_client[] = {
170 static const struct req_msg_field *seq_query_server[] = {
175 static const struct req_msg_field *fld_query_client[] = {
181 static const struct req_msg_field *fld_query_server[] = {
186 static const struct req_msg_field *fld_read_client[] = {
191 static const struct req_msg_field *fld_read_server[] = {
196 static const struct req_msg_field *mds_getattr_name_client[] = {
203 static const struct req_msg_field *mds_reint_client[] = {
208 static const struct req_msg_field *mds_reint_create_client[] = {
215 static const struct req_msg_field *mds_reint_create_slave_client[] = {
224 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
233 static const struct req_msg_field *mds_reint_create_sym_client[] = {
242 static const struct req_msg_field *mds_reint_open_client[] = {
251 static const struct req_msg_field *mds_reint_open_server[] = {
260 static const struct req_msg_field *mds_reint_unlink_client[] = {
268 static const struct req_msg_field *mds_reint_link_client[] = {
277 static const struct req_msg_field *mds_reint_rename_client[] = {
287 static const struct req_msg_field *mds_last_unlink_server[] = {
296 static const struct req_msg_field *mds_reint_setattr_client[] = {
306 static const struct req_msg_field *mds_reint_setxattr_client[] = {
315 static const struct req_msg_field *mdt_swap_layouts[] = {
324 static const struct req_msg_field *obd_connect_client[] = {
332 static const struct req_msg_field *obd_connect_server[] = {
337 static const struct req_msg_field *obd_set_info_client[] = {
343 static const struct req_msg_field *ost_grant_shrink_client[] = {
349 static const struct req_msg_field *mds_getinfo_client[] = {
355 static const struct req_msg_field *mds_getinfo_server[] = {
360 static const struct req_msg_field *ldlm_enqueue_client[] = {
365 static const struct req_msg_field *ldlm_enqueue_server[] = {
370 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
376 static const struct req_msg_field *ldlm_cp_callback_client[] = {
382 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
388 static const struct req_msg_field *ldlm_gl_callback_server[] = {
393 static const struct req_msg_field *ldlm_intent_basic_client[] = {
399 static const struct req_msg_field *ldlm_intent_client[] = {
406 static const struct req_msg_field *ldlm_intent_server[] = {
414 static const struct req_msg_field *ldlm_intent_layout_client[] = {
419 &RMF_EADATA /* for new layout to be set up */
421 static const struct req_msg_field *ldlm_intent_open_server[] = {
431 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
435 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
440 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
449 static const struct req_msg_field *ldlm_intent_create_client[] = {
453 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
459 static const struct req_msg_field *ldlm_intent_open_client[] = {
463 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
470 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
474 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
479 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
487 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
492 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
498 static const struct req_msg_field *mds_getxattr_client[] = {
506 static const struct req_msg_field *mds_getxattr_server[] = {
512 static const struct req_msg_field *mds_getattr_server[] = {
521 static const struct req_msg_field *mds_setattr_server[] = {
530 static const struct req_msg_field *mds_update_client[] = {
535 static const struct req_msg_field *mds_update_server[] = {
537 &RMF_OUT_UPDATE_REPLY,
540 static const struct req_msg_field *llog_origin_handle_create_client[] = {
546 static const struct req_msg_field *llogd_body_only[] = {
551 static const struct req_msg_field *llog_log_hdr_only[] = {
556 static const struct req_msg_field *llogd_conn_body_only[] = {
561 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
567 static const struct req_msg_field *obd_idx_read_client[] = {
572 static const struct req_msg_field *obd_idx_read_server[] = {
577 static const struct req_msg_field *ost_body_only[] = {
582 static const struct req_msg_field *ost_body_capa[] = {
588 static const struct req_msg_field *ost_destroy_client[] = {
596 static const struct req_msg_field *ost_brw_client[] = {
604 static const struct req_msg_field *ost_brw_read_server[] = {
609 static const struct req_msg_field *ost_brw_write_server[] = {
615 static const struct req_msg_field *ost_get_info_generic_server[] = {
620 static const struct req_msg_field *ost_get_info_generic_client[] = {
625 static const struct req_msg_field *ost_get_last_id_server[] = {
630 static const struct req_msg_field *ost_get_last_fid_client[] = {
636 static const struct req_msg_field *ost_get_last_fid_server[] = {
641 static const struct req_msg_field *ost_get_fiemap_client[] = {
647 static const struct req_msg_field *ost_get_fiemap_server[] = {
652 static const struct req_msg_field *mdt_hsm_progress[] = {
655 &RMF_MDS_HSM_PROGRESS,
658 static const struct req_msg_field *mdt_hsm_ct_register[] = {
661 &RMF_MDS_HSM_ARCHIVE,
664 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
669 static const struct req_msg_field *mdt_hsm_action_server[] = {
672 &RMF_MDS_HSM_CURRENT_ACTION,
675 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
681 static const struct req_msg_field *mdt_hsm_state_set[] = {
688 static const struct req_msg_field *mdt_hsm_request[] = {
691 &RMF_MDS_HSM_REQUEST,
692 &RMF_MDS_HSM_USER_ITEM,
696 static const struct req_msg_field *obd_lfsck_request[] = {
701 static const struct req_msg_field *obd_lfsck_reply[] = {
706 static struct req_format *req_formats[] = {
713 &RQF_MGS_CONFIG_READ,
723 &RQF_MDS_GETATTR_NAME,
727 &RQF_MDS_RELEASE_CLOSE,
733 &RQF_MDS_DONE_WRITING,
735 &RQF_MDS_REINT_CREATE,
736 &RQF_MDS_REINT_CREATE_RMT_ACL,
737 &RQF_MDS_REINT_CREATE_SLAVE,
738 &RQF_MDS_REINT_CREATE_SYM,
740 &RQF_MDS_REINT_UNLINK,
742 &RQF_MDS_REINT_RENAME,
743 &RQF_MDS_REINT_SETATTR,
744 &RQF_MDS_REINT_SETXATTR,
747 &RQF_MDS_HSM_PROGRESS,
748 &RQF_MDS_HSM_CT_REGISTER,
749 &RQF_MDS_HSM_CT_UNREGISTER,
750 &RQF_MDS_HSM_STATE_GET,
751 &RQF_MDS_HSM_STATE_SET,
753 &RQF_MDS_HSM_REQUEST,
754 &RQF_MDS_SWAP_LAYOUTS,
770 &RQF_OST_SET_GRANT_INFO,
772 &RQF_OST_GET_INFO_LAST_ID,
773 &RQF_OST_GET_INFO_LAST_FID,
774 &RQF_OST_SET_INFO_LAST_FID,
775 &RQF_OST_GET_INFO_FIEMAP,
777 &RQF_LDLM_ENQUEUE_LVB,
781 &RQF_LDLM_CP_CALLBACK,
782 &RQF_LDLM_BL_CALLBACK,
783 &RQF_LDLM_GL_CALLBACK,
784 &RQF_LDLM_GL_DESC_CALLBACK,
786 &RQF_LDLM_INTENT_BASIC,
787 &RQF_LDLM_INTENT_LAYOUT,
788 &RQF_LDLM_INTENT_GETATTR,
789 &RQF_LDLM_INTENT_OPEN,
790 &RQF_LDLM_INTENT_CREATE,
791 &RQF_LDLM_INTENT_UNLINK,
792 &RQF_LDLM_INTENT_GETXATTR,
793 &RQF_LDLM_INTENT_QUOTA,
796 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
797 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
798 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
799 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
800 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
801 &RQF_LLOG_ORIGIN_CONNECT,
807 struct req_msg_field {
808 const __u32 rmf_flags;
809 const char *rmf_name;
811 * Field length. (-1) means "variable length". If the
812 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
813 * but the actual size must be a whole multiple of \a rmf_size.
816 void (*rmf_swabber)(void *);
817 void (*rmf_dumper)(void *);
818 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
823 * The field is a string, must be NUL-terminated.
825 RMF_F_STRING = 1 << 0,
827 * The field's buffer size need not match the declared \a rmf_size.
829 RMF_F_NO_SIZE_CHECK = 1 << 1,
831 * The field's buffer size must be a whole multiple of the declared \a
832 * rmf_size and the \a rmf_swabber function must work on the declared \a
833 * rmf_size worth of bytes.
835 RMF_F_STRUCT_ARRAY = 1 << 2
843 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
844 .rmf_name = (name), \
845 .rmf_flags = (flags), \
846 .rmf_size = (size), \
847 .rmf_swabber = (void (*)(void*))(swabber), \
848 .rmf_dumper = (void (*)(void*))(dumper) \
851 struct req_msg_field RMF_GENERIC_DATA =
852 DEFINE_MSGF("generic_data", 0,
854 EXPORT_SYMBOL(RMF_GENERIC_DATA);
856 struct req_msg_field RMF_MGS_TARGET_INFO =
857 DEFINE_MSGF("mgs_target_info", 0,
858 sizeof(struct mgs_target_info),
859 lustre_swab_mgs_target_info, NULL);
860 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
862 struct req_msg_field RMF_MGS_SEND_PARAM =
863 DEFINE_MSGF("mgs_send_param", 0,
864 sizeof(struct mgs_send_param),
866 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
868 struct req_msg_field RMF_MGS_CONFIG_BODY =
869 DEFINE_MSGF("mgs_config_read request", 0,
870 sizeof(struct mgs_config_body),
871 lustre_swab_mgs_config_body, NULL);
872 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
874 struct req_msg_field RMF_MGS_CONFIG_RES =
875 DEFINE_MSGF("mgs_config_read reply ", 0,
876 sizeof(struct mgs_config_res),
877 lustre_swab_mgs_config_res, NULL);
878 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
880 struct req_msg_field RMF_U32 =
881 DEFINE_MSGF("generic u32", 0,
882 sizeof(__u32), lustre_swab_generic_32s, NULL);
883 EXPORT_SYMBOL(RMF_U32);
885 struct req_msg_field RMF_SETINFO_VAL =
886 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
887 EXPORT_SYMBOL(RMF_SETINFO_VAL);
889 struct req_msg_field RMF_GETINFO_KEY =
890 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
891 EXPORT_SYMBOL(RMF_GETINFO_KEY);
893 struct req_msg_field RMF_GETINFO_VALLEN =
894 DEFINE_MSGF("getinfo_vallen", 0,
895 sizeof(__u32), lustre_swab_generic_32s, NULL);
896 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
898 struct req_msg_field RMF_GETINFO_VAL =
899 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
900 EXPORT_SYMBOL(RMF_GETINFO_VAL);
902 struct req_msg_field RMF_SEQ_OPC =
903 DEFINE_MSGF("seq_query_opc", 0,
904 sizeof(__u32), lustre_swab_generic_32s, NULL);
905 EXPORT_SYMBOL(RMF_SEQ_OPC);
907 struct req_msg_field RMF_SEQ_RANGE =
908 DEFINE_MSGF("seq_query_range", 0,
909 sizeof(struct lu_seq_range),
910 lustre_swab_lu_seq_range, NULL);
911 EXPORT_SYMBOL(RMF_SEQ_RANGE);
913 struct req_msg_field RMF_FLD_OPC =
914 DEFINE_MSGF("fld_query_opc", 0,
915 sizeof(__u32), lustre_swab_generic_32s, NULL);
916 EXPORT_SYMBOL(RMF_FLD_OPC);
918 struct req_msg_field RMF_FLD_MDFLD =
919 DEFINE_MSGF("fld_query_mdfld", 0,
920 sizeof(struct lu_seq_range),
921 lustre_swab_lu_seq_range, NULL);
922 EXPORT_SYMBOL(RMF_FLD_MDFLD);
924 struct req_msg_field RMF_MDT_BODY =
925 DEFINE_MSGF("mdt_body", 0,
926 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
927 EXPORT_SYMBOL(RMF_MDT_BODY);
929 struct req_msg_field RMF_OBD_QUOTACTL =
930 DEFINE_MSGF("obd_quotactl", 0,
931 sizeof(struct obd_quotactl),
932 lustre_swab_obd_quotactl, NULL);
933 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
935 struct req_msg_field RMF_QUOTA_BODY =
936 DEFINE_MSGF("quota_body", 0,
937 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
938 EXPORT_SYMBOL(RMF_QUOTA_BODY);
940 struct req_msg_field RMF_MDT_EPOCH =
941 DEFINE_MSGF("mdt_ioepoch", 0,
942 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
943 EXPORT_SYMBOL(RMF_MDT_EPOCH);
945 struct req_msg_field RMF_PTLRPC_BODY =
946 DEFINE_MSGF("ptlrpc_body", 0,
947 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
948 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
950 struct req_msg_field RMF_CLOSE_DATA =
951 DEFINE_MSGF("data_version", 0,
952 sizeof(struct close_data), lustre_swab_close_data, NULL);
953 EXPORT_SYMBOL(RMF_CLOSE_DATA);
955 struct req_msg_field RMF_OBD_STATFS =
956 DEFINE_MSGF("obd_statfs", 0,
957 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
958 EXPORT_SYMBOL(RMF_OBD_STATFS);
960 struct req_msg_field RMF_SETINFO_KEY =
961 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
962 EXPORT_SYMBOL(RMF_SETINFO_KEY);
964 struct req_msg_field RMF_NAME =
965 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
966 EXPORT_SYMBOL(RMF_NAME);
968 struct req_msg_field RMF_SYMTGT =
969 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
970 EXPORT_SYMBOL(RMF_SYMTGT);
972 struct req_msg_field RMF_TGTUUID =
973 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
975 EXPORT_SYMBOL(RMF_TGTUUID);
977 struct req_msg_field RMF_CLUUID =
978 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
980 EXPORT_SYMBOL(RMF_CLUUID);
982 struct req_msg_field RMF_STRING =
983 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
984 EXPORT_SYMBOL(RMF_STRING);
986 struct req_msg_field RMF_LLOGD_BODY =
987 DEFINE_MSGF("llogd_body", 0,
988 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
989 EXPORT_SYMBOL(RMF_LLOGD_BODY);
991 struct req_msg_field RMF_LLOG_LOG_HDR =
992 DEFINE_MSGF("llog_log_hdr", 0,
993 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
994 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
996 struct req_msg_field RMF_LLOGD_CONN_BODY =
997 DEFINE_MSGF("llogd_conn_body", 0,
998 sizeof(struct llogd_conn_body),
999 lustre_swab_llogd_conn_body, NULL);
1000 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1003 * connection handle received in MDS_CONNECT request.
1005 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1006 * that the client does not interpret at all.
1008 struct req_msg_field RMF_CONN =
1009 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1010 EXPORT_SYMBOL(RMF_CONN);
1012 struct req_msg_field RMF_CONNECT_DATA =
1013 DEFINE_MSGF("cdata",
1014 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1015 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
1016 sizeof(struct obd_connect_data),
1018 /* For interoperability with 1.8 and 2.0 clients/servers.
1019 * The RPC verification code allows larger RPC buffers, but not
1020 * smaller buffers. Until we no longer need to keep compatibility
1021 * with older servers/clients we can only check that the buffer
1022 * size is at least as large as obd_connect_data_v1. That is not
1023 * not in itself harmful, since the chance of just corrupting this
1024 * field is low. See JIRA LU-16 for details. */
1025 sizeof(struct obd_connect_data_v1),
1027 lustre_swab_connect, NULL);
1028 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1030 struct req_msg_field RMF_DLM_REQ =
1031 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1032 sizeof(struct ldlm_request),
1033 lustre_swab_ldlm_request, NULL);
1034 EXPORT_SYMBOL(RMF_DLM_REQ);
1036 struct req_msg_field RMF_DLM_REP =
1037 DEFINE_MSGF("dlm_rep", 0,
1038 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1039 EXPORT_SYMBOL(RMF_DLM_REP);
1041 struct req_msg_field RMF_LDLM_INTENT =
1042 DEFINE_MSGF("ldlm_intent", 0,
1043 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1044 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1046 struct req_msg_field RMF_DLM_LVB =
1047 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1048 EXPORT_SYMBOL(RMF_DLM_LVB);
1050 struct req_msg_field RMF_DLM_GL_DESC =
1051 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1052 lustre_swab_gl_desc, NULL);
1053 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1055 struct req_msg_field RMF_MDT_MD =
1056 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1057 EXPORT_SYMBOL(RMF_MDT_MD);
1059 struct req_msg_field RMF_REC_REINT =
1060 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1061 lustre_swab_mdt_rec_reint, NULL);
1062 EXPORT_SYMBOL(RMF_REC_REINT);
1064 /* FIXME: this length should be defined as a macro */
1065 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1067 EXPORT_SYMBOL(RMF_EADATA);
1069 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1070 EXPORT_SYMBOL(RMF_EAVALS);
1072 struct req_msg_field RMF_ACL =
1073 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1074 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1075 EXPORT_SYMBOL(RMF_ACL);
1077 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1078 struct req_msg_field RMF_LOGCOOKIES =
1079 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1080 sizeof(struct llog_cookie), NULL, NULL);
1081 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1083 struct req_msg_field RMF_CAPA1 =
1084 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1085 lustre_swab_lustre_capa, NULL);
1086 EXPORT_SYMBOL(RMF_CAPA1);
1088 struct req_msg_field RMF_CAPA2 =
1089 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1090 lustre_swab_lustre_capa, NULL);
1091 EXPORT_SYMBOL(RMF_CAPA2);
1093 struct req_msg_field RMF_LAYOUT_INTENT =
1094 DEFINE_MSGF("layout_intent", 0,
1095 sizeof(struct layout_intent), lustre_swab_layout_intent,
1097 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1100 * OST request field.
1102 struct req_msg_field RMF_OST_BODY =
1103 DEFINE_MSGF("ost_body", 0,
1104 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1105 EXPORT_SYMBOL(RMF_OST_BODY);
1107 struct req_msg_field RMF_OBD_IOOBJ =
1108 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1109 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1110 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1112 struct req_msg_field RMF_NIOBUF_REMOTE =
1113 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1114 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1116 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1118 struct req_msg_field RMF_RCS =
1119 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1120 lustre_swab_generic_32s, dump_rcs);
1121 EXPORT_SYMBOL(RMF_RCS);
1123 struct req_msg_field RMF_EAVALS_LENS =
1124 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1125 lustre_swab_generic_32s, NULL);
1126 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1128 struct req_msg_field RMF_OBD_ID =
1129 DEFINE_MSGF("obd_id", 0,
1130 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1131 EXPORT_SYMBOL(RMF_OBD_ID);
1133 struct req_msg_field RMF_FID =
1134 DEFINE_MSGF("fid", 0,
1135 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1136 EXPORT_SYMBOL(RMF_FID);
1138 struct req_msg_field RMF_OST_ID =
1139 DEFINE_MSGF("ost_id", 0,
1140 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1141 EXPORT_SYMBOL(RMF_OST_ID);
1143 struct req_msg_field RMF_FIEMAP_KEY =
1144 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1145 lustre_swab_fiemap, NULL);
1146 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1148 struct req_msg_field RMF_FIEMAP_VAL =
1149 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1150 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1152 struct req_msg_field RMF_IDX_INFO =
1153 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1154 lustre_swab_idx_info, NULL);
1155 EXPORT_SYMBOL(RMF_IDX_INFO);
1156 struct req_msg_field RMF_HSM_USER_STATE =
1157 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1158 lustre_swab_hsm_user_state, NULL);
1159 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1161 struct req_msg_field RMF_HSM_STATE_SET =
1162 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1163 lustre_swab_hsm_state_set, NULL);
1164 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1166 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1167 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1168 lustre_swab_hsm_progress_kernel, NULL);
1169 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1171 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1172 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1173 lustre_swab_hsm_current_action, NULL);
1174 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1176 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1177 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1178 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1180 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1182 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1183 DEFINE_MSGF("hsm_archive", 0,
1184 sizeof(__u32), lustre_swab_generic_32s, NULL);
1185 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1187 struct req_msg_field RMF_MDS_HSM_REQUEST =
1188 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1189 lustre_swab_hsm_request, NULL);
1190 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1192 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1193 lustre_swab_object_update_request, NULL);
1194 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1196 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1197 DEFINE_MSGF("object_update_reply", 0, -1,
1198 lustre_swab_object_update_reply, NULL);
1199 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1201 struct req_msg_field RMF_SWAP_LAYOUTS =
1202 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1203 lustre_swab_swap_layouts, NULL);
1204 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1206 struct req_msg_field RMF_LFSCK_REQUEST =
1207 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1208 lustre_swab_lfsck_request, NULL);
1209 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1211 struct req_msg_field RMF_LFSCK_REPLY =
1212 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1213 lustre_swab_lfsck_reply, NULL);
1214 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1221 const char *rf_name;
1225 const struct req_msg_field **d;
1226 } rf_fields[RCL_NR];
1229 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1243 #define DEFINE_REQ_FMT0(name, client, server) \
1244 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1246 struct req_format RQF_OBD_PING =
1247 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1248 EXPORT_SYMBOL(RQF_OBD_PING);
1250 struct req_format RQF_OBD_SET_INFO =
1251 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1252 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1254 /* Read index file through the network */
1255 struct req_format RQF_OBD_IDX_READ =
1256 DEFINE_REQ_FMT0("OBD_IDX_READ",
1257 obd_idx_read_client, obd_idx_read_server);
1258 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1260 struct req_format RQF_SEC_CTX =
1261 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1262 EXPORT_SYMBOL(RQF_SEC_CTX);
1264 struct req_format RQF_MGS_TARGET_REG =
1265 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1266 mgs_target_info_only);
1267 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1269 struct req_format RQF_MGS_SET_INFO =
1270 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1272 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1274 struct req_format RQF_MGS_CONFIG_READ =
1275 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1276 mgs_config_read_server);
1277 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1279 struct req_format RQF_SEQ_QUERY =
1280 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1281 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1283 struct req_format RQF_FLD_QUERY =
1284 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1285 EXPORT_SYMBOL(RQF_FLD_QUERY);
1287 struct req_format RQF_FLD_READ =
1288 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1289 EXPORT_SYMBOL(RQF_FLD_READ);
1291 struct req_format RQF_LOG_CANCEL =
1292 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1293 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1295 struct req_format RQF_MDS_QUOTACHECK =
1296 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1297 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1299 struct req_format RQF_OST_QUOTACHECK =
1300 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1301 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1303 struct req_format RQF_MDS_QUOTACTL =
1304 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1305 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1307 struct req_format RQF_OST_QUOTACTL =
1308 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1309 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1311 struct req_format RQF_QC_CALLBACK =
1312 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1313 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1315 struct req_format RQF_QUOTA_DQACQ =
1316 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1317 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1319 struct req_format RQF_LDLM_INTENT_QUOTA =
1320 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1321 ldlm_intent_quota_client,
1322 ldlm_intent_quota_server);
1323 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1325 struct req_format RQF_MDS_GETSTATUS =
1326 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1327 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1329 struct req_format RQF_MDS_STATFS =
1330 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1331 EXPORT_SYMBOL(RQF_MDS_STATFS);
1333 struct req_format RQF_MDS_SYNC =
1334 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1335 EXPORT_SYMBOL(RQF_MDS_SYNC);
1337 struct req_format RQF_MDS_GETATTR =
1338 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1339 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1341 struct req_format RQF_MDS_GETXATTR =
1342 DEFINE_REQ_FMT0("MDS_GETXATTR",
1343 mds_getxattr_client, mds_getxattr_server);
1344 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1346 struct req_format RQF_MDS_GETATTR_NAME =
1347 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1348 mds_getattr_name_client, mds_getattr_server);
1349 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1351 struct req_format RQF_MDS_REINT =
1352 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1353 EXPORT_SYMBOL(RQF_MDS_REINT);
1355 struct req_format RQF_MDS_REINT_CREATE =
1356 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1357 mds_reint_create_client, mdt_body_capa);
1358 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1360 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1361 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1362 mds_reint_create_rmt_acl_client, mdt_body_capa);
1363 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1365 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1366 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1367 mds_reint_create_slave_client, mdt_body_capa);
1368 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1370 struct req_format RQF_MDS_REINT_CREATE_SYM =
1371 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1372 mds_reint_create_sym_client, mdt_body_capa);
1373 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1375 struct req_format RQF_MDS_REINT_OPEN =
1376 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1377 mds_reint_open_client, mds_reint_open_server);
1378 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1380 struct req_format RQF_MDS_REINT_UNLINK =
1381 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1382 mds_last_unlink_server);
1383 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1385 struct req_format RQF_MDS_REINT_LINK =
1386 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1387 mds_reint_link_client, mdt_body_only);
1388 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1390 struct req_format RQF_MDS_REINT_RENAME =
1391 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1392 mds_last_unlink_server);
1393 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1395 struct req_format RQF_MDS_REINT_SETATTR =
1396 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1397 mds_reint_setattr_client, mds_setattr_server);
1398 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1400 struct req_format RQF_MDS_REINT_SETXATTR =
1401 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1402 mds_reint_setxattr_client, mdt_body_only);
1403 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1405 struct req_format RQF_MDS_CONNECT =
1406 DEFINE_REQ_FMT0("MDS_CONNECT",
1407 obd_connect_client, obd_connect_server);
1408 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1410 struct req_format RQF_MDS_DISCONNECT =
1411 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1412 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1414 struct req_format RQF_MDS_GET_INFO =
1415 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1416 mds_getinfo_server);
1417 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1419 struct req_format RQF_OUT_UPDATE =
1420 DEFINE_REQ_FMT0("OUT_UPDATE_OBJ", mds_update_client,
1422 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1424 struct req_format RQF_LDLM_ENQUEUE =
1425 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1426 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1427 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1429 struct req_format RQF_LDLM_ENQUEUE_LVB =
1430 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1431 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1432 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1434 struct req_format RQF_LDLM_CONVERT =
1435 DEFINE_REQ_FMT0("LDLM_CONVERT",
1436 ldlm_enqueue_client, ldlm_enqueue_server);
1437 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1439 struct req_format RQF_LDLM_CANCEL =
1440 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1441 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1443 struct req_format RQF_LDLM_CALLBACK =
1444 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1445 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1447 struct req_format RQF_LDLM_CP_CALLBACK =
1448 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1449 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1451 struct req_format RQF_LDLM_BL_CALLBACK =
1452 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1453 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1455 struct req_format RQF_LDLM_GL_CALLBACK =
1456 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1457 ldlm_gl_callback_server);
1458 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1460 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1461 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1462 ldlm_gl_callback_server);
1463 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1465 struct req_format RQF_LDLM_INTENT_BASIC =
1466 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1467 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1468 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1470 struct req_format RQF_LDLM_INTENT =
1471 DEFINE_REQ_FMT0("LDLM_INTENT",
1472 ldlm_intent_client, ldlm_intent_server);
1473 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1475 struct req_format RQF_LDLM_INTENT_LAYOUT =
1476 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1477 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1478 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1480 struct req_format RQF_LDLM_INTENT_GETATTR =
1481 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1482 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1483 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1485 struct req_format RQF_LDLM_INTENT_OPEN =
1486 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1487 ldlm_intent_open_client, ldlm_intent_open_server);
1488 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1490 struct req_format RQF_LDLM_INTENT_CREATE =
1491 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1492 ldlm_intent_create_client, ldlm_intent_getattr_server);
1493 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1495 struct req_format RQF_LDLM_INTENT_UNLINK =
1496 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1497 ldlm_intent_unlink_client, ldlm_intent_server);
1498 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1500 struct req_format RQF_LDLM_INTENT_GETXATTR =
1501 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1502 ldlm_intent_getxattr_client,
1503 ldlm_intent_getxattr_server);
1504 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1506 struct req_format RQF_MDS_CLOSE =
1507 DEFINE_REQ_FMT0("MDS_CLOSE",
1508 mdt_close_client, mds_last_unlink_server);
1509 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1511 struct req_format RQF_MDS_RELEASE_CLOSE =
1512 DEFINE_REQ_FMT0("MDS_CLOSE",
1513 mdt_release_close_client, mds_last_unlink_server);
1514 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1516 struct req_format RQF_MDS_PIN =
1517 DEFINE_REQ_FMT0("MDS_PIN",
1518 mdt_body_capa, mdt_body_only);
1519 EXPORT_SYMBOL(RQF_MDS_PIN);
1521 struct req_format RQF_MDS_UNPIN =
1522 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1523 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1525 struct req_format RQF_MDS_DONE_WRITING =
1526 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1527 mdt_close_client, mdt_body_only);
1528 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1530 struct req_format RQF_MDS_READPAGE =
1531 DEFINE_REQ_FMT0("MDS_READPAGE",
1532 mdt_body_capa, mdt_body_only);
1533 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1535 struct req_format RQF_MDS_HSM_ACTION =
1536 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1537 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1539 struct req_format RQF_MDS_HSM_PROGRESS =
1540 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1541 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1543 struct req_format RQF_MDS_HSM_CT_REGISTER =
1544 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1545 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1547 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1548 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1549 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1551 struct req_format RQF_MDS_HSM_STATE_GET =
1552 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1553 mdt_body_capa, mdt_hsm_state_get_server);
1554 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1556 struct req_format RQF_MDS_HSM_STATE_SET =
1557 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1558 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1560 struct req_format RQF_MDS_HSM_REQUEST =
1561 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1562 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1564 struct req_format RQF_MDS_SWAP_LAYOUTS =
1565 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1566 mdt_swap_layouts, empty);
1567 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1569 /* This is for split */
1570 struct req_format RQF_MDS_WRITEPAGE =
1571 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1572 mdt_body_capa, mdt_body_only);
1573 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1575 struct req_format RQF_MDS_IS_SUBDIR =
1576 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1577 mdt_body_only, mdt_body_only);
1578 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1580 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1581 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1582 llog_origin_handle_create_client, llogd_body_only);
1583 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1585 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1586 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1587 llogd_body_only, llogd_body_only);
1588 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1590 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1591 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1592 llogd_body_only, llog_origin_handle_next_block_server);
1593 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1595 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1596 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1597 llogd_body_only, llog_origin_handle_next_block_server);
1598 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1600 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1601 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1602 llogd_body_only, llog_log_hdr_only);
1603 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1605 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1606 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1607 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1609 struct req_format RQF_CONNECT =
1610 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1611 EXPORT_SYMBOL(RQF_CONNECT);
1613 struct req_format RQF_OST_CONNECT =
1614 DEFINE_REQ_FMT0("OST_CONNECT",
1615 obd_connect_client, obd_connect_server);
1616 EXPORT_SYMBOL(RQF_OST_CONNECT);
1618 struct req_format RQF_OST_DISCONNECT =
1619 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1620 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1622 struct req_format RQF_OST_GETATTR =
1623 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1624 EXPORT_SYMBOL(RQF_OST_GETATTR);
1626 struct req_format RQF_OST_SETATTR =
1627 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1628 EXPORT_SYMBOL(RQF_OST_SETATTR);
1630 struct req_format RQF_OST_CREATE =
1631 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1632 EXPORT_SYMBOL(RQF_OST_CREATE);
1634 struct req_format RQF_OST_PUNCH =
1635 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1636 EXPORT_SYMBOL(RQF_OST_PUNCH);
1638 struct req_format RQF_OST_SYNC =
1639 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1640 EXPORT_SYMBOL(RQF_OST_SYNC);
1642 struct req_format RQF_OST_DESTROY =
1643 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1644 EXPORT_SYMBOL(RQF_OST_DESTROY);
1646 struct req_format RQF_OST_BRW_READ =
1647 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1648 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1650 struct req_format RQF_OST_BRW_WRITE =
1651 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1652 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1654 struct req_format RQF_OST_STATFS =
1655 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1656 EXPORT_SYMBOL(RQF_OST_STATFS);
1658 struct req_format RQF_OST_SET_GRANT_INFO =
1659 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1661 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1663 struct req_format RQF_OST_GET_INFO =
1664 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1665 ost_get_info_generic_server);
1666 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1668 struct req_format RQF_OST_GET_INFO_LAST_ID =
1669 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1670 ost_get_last_id_server);
1671 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1673 struct req_format RQF_OST_GET_INFO_LAST_FID =
1674 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1675 ost_get_last_fid_server);
1676 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1678 struct req_format RQF_OST_SET_INFO_LAST_FID =
1679 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1681 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1683 struct req_format RQF_OST_GET_INFO_FIEMAP =
1684 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1685 ost_get_fiemap_server);
1686 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1688 struct req_format RQF_LFSCK_NOTIFY =
1689 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1690 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1692 struct req_format RQF_LFSCK_QUERY =
1693 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1694 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1696 #if !defined(__REQ_LAYOUT_USER__)
1698 /* Convenience macro */
1699 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1702 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1703 * field of RQFs and the \a rmf_offset field of RMFs.
1705 int req_layout_init(void)
1710 struct req_format *rf = NULL;
1712 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1713 rf = req_formats[i];
1715 for (j = 0; j < RCL_NR; ++j) {
1716 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1717 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1718 struct req_msg_field *field;
1720 field = (typeof(field))rf->rf_fields[j].d[k];
1721 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1722 || field->rmf_size > 0);
1723 LASSERT(field->rmf_offset[i][j] == 0);
1725 * k + 1 to detect unused format/field
1728 field->rmf_offset[i][j] = k + 1;
1734 EXPORT_SYMBOL(req_layout_init);
1736 void req_layout_fini(void)
1739 EXPORT_SYMBOL(req_layout_fini);
1742 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1744 * Actual/expected field sizes are set elsewhere in functions in this file:
1745 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1746 * req_capsule_msg_size(). The \a rc_area information is used by.
1747 * ptlrpc_request_set_replen().
1749 void req_capsule_init_area(struct req_capsule *pill)
1753 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1754 pill->rc_area[RCL_CLIENT][i] = -1;
1755 pill->rc_area[RCL_SERVER][i] = -1;
1758 EXPORT_SYMBOL(req_capsule_init_area);
1761 * Initialize a pill.
1763 * The \a location indicates whether the caller is executing on the client side
1764 * (RCL_CLIENT) or server side (RCL_SERVER)..
1766 void req_capsule_init(struct req_capsule *pill,
1767 struct ptlrpc_request *req,
1768 enum req_location location)
1770 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1773 * Today all capsules are embedded in ptlrpc_request structs,
1774 * but just in case that ever isn't the case, we don't reach
1775 * into req unless req != NULL and pill is the one embedded in
1778 * The req->rq_pill_init flag makes it safe to initialize a pill
1779 * twice, which might happen in the OST paths as a result of the
1780 * high-priority RPC queue getting peeked at before ost_handle()
1781 * handles an OST RPC.
1783 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1786 memset(pill, 0, sizeof *pill);
1788 pill->rc_loc = location;
1789 req_capsule_init_area(pill);
1791 if (req != NULL && pill == &req->rq_pill)
1792 req->rq_pill_init = 1;
1794 EXPORT_SYMBOL(req_capsule_init);
1796 void req_capsule_fini(struct req_capsule *pill)
1799 EXPORT_SYMBOL(req_capsule_fini);
1801 static int __req_format_is_sane(const struct req_format *fmt)
1804 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1805 req_formats[fmt->rf_idx] == fmt;
1808 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1809 enum req_location loc)
1811 struct ptlrpc_request *req;
1814 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1818 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1819 * (see req_capsule_extend()).
1821 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1823 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1824 LASSERT(__req_format_is_sane(fmt));
1828 EXPORT_SYMBOL(req_capsule_set);
1831 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1834 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1835 * variable-sized fields. The field sizes come from the declared \a rmf_size
1836 * field of a \a pill's \a rc_fmt's RMF's.
1838 int req_capsule_filled_sizes(struct req_capsule *pill,
1839 enum req_location loc)
1841 const struct req_format *fmt = pill->rc_fmt;
1844 LASSERT(fmt != NULL);
1846 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1847 if (pill->rc_area[loc][i] == -1) {
1848 pill->rc_area[loc][i] =
1849 fmt->rf_fields[loc].d[i]->rmf_size;
1850 if (pill->rc_area[loc][i] == -1) {
1852 * Skip the following fields.
1854 * If this LASSERT() trips then you're missing a
1855 * call to req_capsule_set_size().
1857 LASSERT(loc != RCL_SERVER);
1864 EXPORT_SYMBOL(req_capsule_filled_sizes);
1867 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1869 * This function uses the \a pill's \a rc_area as filled in by
1870 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1873 int req_capsule_server_pack(struct req_capsule *pill)
1875 const struct req_format *fmt;
1879 LASSERT(pill->rc_loc == RCL_SERVER);
1881 LASSERT(fmt != NULL);
1883 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1884 rc = lustre_pack_reply(pill->rc_req, count,
1885 pill->rc_area[RCL_SERVER], NULL);
1887 DEBUG_REQ(D_ERROR, pill->rc_req,
1888 "Cannot pack %d fields in format `%s': ",
1889 count, fmt->rf_name);
1893 EXPORT_SYMBOL(req_capsule_server_pack);
1896 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1897 * corresponding to the given RMF (\a field).
1899 static int __req_capsule_offset(const struct req_capsule *pill,
1900 const struct req_msg_field *field,
1901 enum req_location loc)
1905 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1906 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1907 pill->rc_fmt->rf_name,
1908 field->rmf_name, offset, loc);
1911 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1916 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1921 swabber_dumper_helper(struct req_capsule *pill,
1922 const struct req_msg_field *field,
1923 enum req_location loc,
1925 void *value, int len, int dump, void (*swabber)( void *))
1931 int inout = loc == RCL_CLIENT;
1933 swabber = swabber ?: field->rmf_swabber;
1935 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1936 swabber != NULL && value != NULL)
1941 if (!field->rmf_dumper)
1944 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1946 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1947 do_swab ? "unswabbed " : "", field->rmf_name);
1948 field->rmf_dumper(value);
1953 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1955 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1956 "follows\n", field->rmf_name);
1957 field->rmf_dumper(value);
1964 * We're swabbing an array; swabber() swabs a single array element, so
1965 * swab every element.
1967 LASSERT((len % field->rmf_size) == 0);
1968 for (p = value, i = 0, n = len / field->rmf_size;
1970 i++, p += field->rmf_size) {
1972 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1973 "element %d follows\n",
1974 do_swab ? "unswabbed " : "", field->rmf_name, i);
1975 field->rmf_dumper(p);
1981 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1982 "element %d follows\n", field->rmf_name, i);
1983 field->rmf_dumper(value);
1987 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1991 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1992 * corresponding to the given RMF (\a field).
1994 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1995 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1996 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1997 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1998 * element of the array swabbed.
2000 static void *__req_capsule_get(struct req_capsule *pill,
2001 const struct req_msg_field *field,
2002 enum req_location loc,
2003 void (*swabber)( void *),
2006 const struct req_format *fmt;
2007 struct lustre_msg *msg;
2012 void *(*getter)(struct lustre_msg *m, int n, int minlen);
2014 static const char *rcl_names[RCL_NR] = {
2015 [RCL_CLIENT] = "client",
2016 [RCL_SERVER] = "server"
2019 LASSERT(pill != NULL);
2020 LASSERT(pill != LP_POISON);
2022 LASSERT(fmt != NULL);
2023 LASSERT(fmt != LP_POISON);
2024 LASSERT(__req_format_is_sane(fmt));
2026 offset = __req_capsule_offset(pill, field, loc);
2028 msg = __req_msg(pill, loc);
2029 LASSERT(msg != NULL);
2031 getter = (field->rmf_flags & RMF_F_STRING) ?
2032 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2034 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2036 * We've already asserted that field->rmf_size > 0 in
2037 * req_layout_init().
2039 len = lustre_msg_buflen(msg, offset);
2040 if ((len % field->rmf_size) != 0) {
2041 CERROR("%s: array field size mismatch "
2042 "%d modulo %d != 0 (%d)\n",
2043 field->rmf_name, len, field->rmf_size, loc);
2046 } else if (pill->rc_area[loc][offset] != -1) {
2047 len = pill->rc_area[loc][offset];
2049 len = max(field->rmf_size, 0);
2051 value = getter(msg, offset, len);
2053 if (value == NULL) {
2054 DEBUG_REQ(D_ERROR, pill->rc_req,
2055 "Wrong buffer for field `%s' (%d of %d) "
2056 "in format `%s': %d vs. %d (%s)\n",
2057 field->rmf_name, offset, lustre_msg_bufcount(msg),
2058 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2061 swabber_dumper_helper(pill, field, loc, offset, value, len,
2069 * Dump a request and/or reply
2071 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2073 const struct req_format *fmt;
2074 const struct req_msg_field *field;
2080 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2081 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2082 field = FMT_FIELD(fmt, loc, i);
2083 if (field->rmf_dumper == NULL) {
2085 * FIXME Add a default hex dumper for fields that don't
2086 * have a specific dumper
2088 len = req_capsule_get_size(pill, field, loc);
2089 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2090 "field size is %d\n", field->rmf_name, len);
2092 /* It's the dumping side-effect that we're interested in */
2093 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2096 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2102 void req_capsule_client_dump(struct req_capsule *pill)
2104 __req_capsule_dump(pill, RCL_CLIENT);
2106 EXPORT_SYMBOL(req_capsule_client_dump);
2111 void req_capsule_server_dump(struct req_capsule *pill)
2113 __req_capsule_dump(pill, RCL_SERVER);
2115 EXPORT_SYMBOL(req_capsule_server_dump);
2118 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2119 * buffer corresponding to the given RMF (\a field) of a \a pill.
2121 void *req_capsule_client_get(struct req_capsule *pill,
2122 const struct req_msg_field *field)
2124 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2126 EXPORT_SYMBOL(req_capsule_client_get);
2129 * Same as req_capsule_client_get(), but with a \a swabber argument.
2131 * Currently unused; will be removed when req_capsule_server_swab_get() is
2134 void *req_capsule_client_swab_get(struct req_capsule *pill,
2135 const struct req_msg_field *field,
2138 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2140 EXPORT_SYMBOL(req_capsule_client_swab_get);
2143 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2145 * First the \a pill's request \a field's size is set (\a rc_area) using
2146 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2149 void *req_capsule_client_sized_get(struct req_capsule *pill,
2150 const struct req_msg_field *field,
2153 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2154 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2156 EXPORT_SYMBOL(req_capsule_client_sized_get);
2159 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2160 * buffer corresponding to the given RMF (\a field) of a \a pill.
2162 void *req_capsule_server_get(struct req_capsule *pill,
2163 const struct req_msg_field *field)
2165 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2167 EXPORT_SYMBOL(req_capsule_server_get);
2170 * Same as req_capsule_server_get(), but with a \a swabber argument.
2172 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2173 * swabbing done outside this capsule abstraction.
2175 void *req_capsule_server_swab_get(struct req_capsule *pill,
2176 const struct req_msg_field *field,
2179 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2181 EXPORT_SYMBOL(req_capsule_server_swab_get);
2184 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2186 * First the \a pill's request \a field's size is set (\a rc_area) using
2187 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2190 void *req_capsule_server_sized_get(struct req_capsule *pill,
2191 const struct req_msg_field *field,
2194 req_capsule_set_size(pill, field, RCL_SERVER, len);
2195 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2197 EXPORT_SYMBOL(req_capsule_server_sized_get);
2199 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2200 const struct req_msg_field *field,
2201 int len, void *swabber)
2203 req_capsule_set_size(pill, field, RCL_SERVER, len);
2204 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2206 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2209 * Returns the buffer of a \a pill corresponding to the given \a field from the
2210 * request (if the caller is executing on the server-side) or reply (if the
2211 * caller is executing on the client-side).
2213 * This function convienient for use is code that could be executed on the
2214 * client and server alike.
2216 const void *req_capsule_other_get(struct req_capsule *pill,
2217 const struct req_msg_field *field)
2219 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2221 EXPORT_SYMBOL(req_capsule_other_get);
2224 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2225 * field of the given \a pill.
2227 * This function must be used when constructing variable sized fields of a
2230 void req_capsule_set_size(struct req_capsule *pill,
2231 const struct req_msg_field *field,
2232 enum req_location loc, int size)
2234 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2236 if ((size != field->rmf_size) &&
2237 (field->rmf_size != -1) &&
2238 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2240 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2241 (size % field->rmf_size != 0)) {
2242 CERROR("%s: array field size mismatch "
2243 "%d %% %d != 0 (%d)\n",
2244 field->rmf_name, size, field->rmf_size, loc);
2246 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2247 size < field->rmf_size) {
2248 CERROR("%s: field size mismatch %d != %d (%d)\n",
2249 field->rmf_name, size, field->rmf_size, loc);
2254 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2256 EXPORT_SYMBOL(req_capsule_set_size);
2259 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2260 * for the given \a pill's given \a field.
2262 * NB: this function doesn't correspond with req_capsule_set_size(), which
2263 * actually sets the size in pill.rc_area[loc][offset], but this function
2264 * returns the message buflen[offset], maybe we should use another name.
2266 int req_capsule_get_size(const struct req_capsule *pill,
2267 const struct req_msg_field *field,
2268 enum req_location loc)
2270 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2272 return lustre_msg_buflen(__req_msg(pill, loc),
2273 __req_capsule_offset(pill, field, loc));
2275 EXPORT_SYMBOL(req_capsule_get_size);
2278 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2279 * given \a pill's request or reply (\a loc) given the field size recorded in
2280 * the \a pill's rc_area.
2282 * See also req_capsule_set_size().
2284 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2286 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2287 pill->rc_fmt->rf_fields[loc].nr,
2288 pill->rc_area[loc]);
2292 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2293 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2294 * PTLRPC request or reply given only an RQF (\a fmt).
2296 * This function should not be used for formats which contain variable size
2299 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2300 enum req_location loc)
2305 * This function should probably LASSERT() that fmt has no fields with
2306 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2307 * elements in the array there will ultimately be, but then, we could
2308 * assume that there will be at least one element, and that's just what
2311 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2315 for (; i < fmt->rf_fields[loc].nr; ++i)
2316 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2317 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2323 * Changes the format of an RPC.
2325 * The pill must already have been initialized, which means that it already has
2326 * a request format. The new format \a fmt must be an extension of the pill's
2327 * old format. Specifically: the new format must have as many request and reply
2328 * fields as the old one, and all fields shared by the old and new format must
2329 * be at least as large in the new format.
2331 * The new format's fields may be of different "type" than the old format, but
2332 * only for fields that are "opaque" blobs: fields which have a) have no
2333 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2334 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2335 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2336 * according to the key field. When the value, according to the key, contains a
2337 * structure (or array thereof) to be swabbed, the format should be changed to
2338 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2341 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2346 const struct req_format *old;
2348 LASSERT(pill->rc_fmt != NULL);
2349 LASSERT(__req_format_is_sane(fmt));
2353 * Sanity checking...
2355 for (i = 0; i < RCL_NR; ++i) {
2356 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2357 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2358 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2360 /* "opaque" fields can be transmogrified */
2361 if (ofield->rmf_swabber == NULL &&
2362 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2363 (ofield->rmf_size == -1 ||
2364 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2366 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2369 * Last field in old format can be shorter than in new.
2371 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2372 FMT_FIELD(old, i, j)->rmf_size);
2377 EXPORT_SYMBOL(req_capsule_extend);
2380 * This function returns a non-zero value if the given \a field is present in
2381 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2384 int req_capsule_has_field(const struct req_capsule *pill,
2385 const struct req_msg_field *field,
2386 enum req_location loc)
2388 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2390 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2392 EXPORT_SYMBOL(req_capsule_has_field);
2395 * Returns a non-zero value if the given \a field is present in the given \a
2396 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2398 int req_capsule_field_present(const struct req_capsule *pill,
2399 const struct req_msg_field *field,
2400 enum req_location loc)
2404 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2405 LASSERT(req_capsule_has_field(pill, field, loc));
2407 offset = __req_capsule_offset(pill, field, loc);
2408 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2410 EXPORT_SYMBOL(req_capsule_field_present);
2413 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2414 * request or reply (\a loc).
2416 * This is not the opposite of req_capsule_extend().
2418 void req_capsule_shrink(struct req_capsule *pill,
2419 const struct req_msg_field *field,
2420 unsigned int newlen,
2421 enum req_location loc)
2423 const struct req_format *fmt;
2424 struct lustre_msg *msg;
2429 LASSERT(fmt != NULL);
2430 LASSERT(__req_format_is_sane(fmt));
2431 LASSERT(req_capsule_has_field(pill, field, loc));
2432 LASSERT(req_capsule_field_present(pill, field, loc));
2434 offset = __req_capsule_offset(pill, field, loc);
2436 msg = __req_msg(pill, loc);
2437 len = lustre_msg_buflen(msg, offset);
2438 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2439 fmt->rf_name, field->rmf_name, len, newlen);
2441 if (loc == RCL_CLIENT)
2442 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2445 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2448 EXPORT_SYMBOL(req_capsule_shrink);
2450 int req_capsule_server_grow(struct req_capsule *pill,
2451 const struct req_msg_field *field,
2452 unsigned int newlen)
2454 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2456 int offset, len, rc;
2458 LASSERT(pill->rc_fmt != NULL);
2459 LASSERT(__req_format_is_sane(pill->rc_fmt));
2460 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2461 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2463 len = req_capsule_get_size(pill, field, RCL_SERVER);
2464 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2465 if (pill->rc_req->rq_repbuf_len >=
2466 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2467 CERROR("Inplace repack might be done\n");
2469 pill->rc_req->rq_reply_state = NULL;
2470 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2471 rc = req_capsule_server_pack(pill);
2473 /* put old rs back, the caller will decide what to do */
2474 pill->rc_req->rq_reply_state = rs;
2477 nrs = pill->rc_req->rq_reply_state;
2478 /* Now we need only buffers, copy first chunk */
2479 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2480 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2481 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2482 memcpy(to, from, len);
2483 /* check if we have tail and copy it too */
2484 if (rs->rs_msg->lm_bufcount > offset + 1) {
2485 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2486 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2487 offset = rs->rs_msg->lm_bufcount - 1;
2488 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2489 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2490 memcpy(to, from, len);
2492 /* drop old reply if everything is fine */
2493 if (rs->rs_difficult) {
2497 nrs->rs_difficult = 1;
2498 nrs->rs_no_ack = rs->rs_no_ack;
2499 for (i = 0; i < rs->rs_nlocks; i++) {
2500 nrs->rs_locks[i] = rs->rs_locks[i];
2501 nrs->rs_modes[i] = rs->rs_modes[i];
2505 rs->rs_difficult = 0;
2508 ptlrpc_rs_decref(rs);
2511 EXPORT_SYMBOL(req_capsule_server_grow);
2512 /* __REQ_LAYOUT_USER__ */