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,
730 &RQF_MDS_DONE_WRITING,
732 &RQF_MDS_REINT_CREATE,
733 &RQF_MDS_REINT_CREATE_RMT_ACL,
734 &RQF_MDS_REINT_CREATE_SLAVE,
735 &RQF_MDS_REINT_CREATE_SYM,
737 &RQF_MDS_REINT_UNLINK,
739 &RQF_MDS_REINT_RENAME,
740 &RQF_MDS_REINT_SETATTR,
741 &RQF_MDS_REINT_SETXATTR,
744 &RQF_MDS_HSM_PROGRESS,
745 &RQF_MDS_HSM_CT_REGISTER,
746 &RQF_MDS_HSM_CT_UNREGISTER,
747 &RQF_MDS_HSM_STATE_GET,
748 &RQF_MDS_HSM_STATE_SET,
750 &RQF_MDS_HSM_REQUEST,
751 &RQF_MDS_SWAP_LAYOUTS,
767 &RQF_OST_SET_GRANT_INFO,
769 &RQF_OST_GET_INFO_LAST_ID,
770 &RQF_OST_GET_INFO_LAST_FID,
771 &RQF_OST_SET_INFO_LAST_FID,
772 &RQF_OST_GET_INFO_FIEMAP,
774 &RQF_LDLM_ENQUEUE_LVB,
778 &RQF_LDLM_CP_CALLBACK,
779 &RQF_LDLM_BL_CALLBACK,
780 &RQF_LDLM_GL_CALLBACK,
781 &RQF_LDLM_GL_DESC_CALLBACK,
783 &RQF_LDLM_INTENT_BASIC,
784 &RQF_LDLM_INTENT_LAYOUT,
785 &RQF_LDLM_INTENT_GETATTR,
786 &RQF_LDLM_INTENT_OPEN,
787 &RQF_LDLM_INTENT_CREATE,
788 &RQF_LDLM_INTENT_UNLINK,
789 &RQF_LDLM_INTENT_GETXATTR,
790 &RQF_LDLM_INTENT_QUOTA,
793 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
794 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
795 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
796 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
797 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
798 &RQF_LLOG_ORIGIN_CONNECT,
804 struct req_msg_field {
805 const __u32 rmf_flags;
806 const char *rmf_name;
808 * Field length. (-1) means "variable length". If the
809 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
810 * but the actual size must be a whole multiple of \a rmf_size.
813 void (*rmf_swabber)(void *);
814 void (*rmf_dumper)(void *);
815 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
820 * The field is a string, must be NUL-terminated.
822 RMF_F_STRING = 1 << 0,
824 * The field's buffer size need not match the declared \a rmf_size.
826 RMF_F_NO_SIZE_CHECK = 1 << 1,
828 * The field's buffer size must be a whole multiple of the declared \a
829 * rmf_size and the \a rmf_swabber function must work on the declared \a
830 * rmf_size worth of bytes.
832 RMF_F_STRUCT_ARRAY = 1 << 2
840 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
841 .rmf_name = (name), \
842 .rmf_flags = (flags), \
843 .rmf_size = (size), \
844 .rmf_swabber = (void (*)(void*))(swabber), \
845 .rmf_dumper = (void (*)(void*))(dumper) \
848 struct req_msg_field RMF_GENERIC_DATA =
849 DEFINE_MSGF("generic_data", 0,
851 EXPORT_SYMBOL(RMF_GENERIC_DATA);
853 struct req_msg_field RMF_MGS_TARGET_INFO =
854 DEFINE_MSGF("mgs_target_info", 0,
855 sizeof(struct mgs_target_info),
856 lustre_swab_mgs_target_info, NULL);
857 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
859 struct req_msg_field RMF_MGS_SEND_PARAM =
860 DEFINE_MSGF("mgs_send_param", 0,
861 sizeof(struct mgs_send_param),
863 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
865 struct req_msg_field RMF_MGS_CONFIG_BODY =
866 DEFINE_MSGF("mgs_config_read request", 0,
867 sizeof(struct mgs_config_body),
868 lustre_swab_mgs_config_body, NULL);
869 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
871 struct req_msg_field RMF_MGS_CONFIG_RES =
872 DEFINE_MSGF("mgs_config_read reply ", 0,
873 sizeof(struct mgs_config_res),
874 lustre_swab_mgs_config_res, NULL);
875 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
877 struct req_msg_field RMF_U32 =
878 DEFINE_MSGF("generic u32", 0,
879 sizeof(__u32), lustre_swab_generic_32s, NULL);
880 EXPORT_SYMBOL(RMF_U32);
882 struct req_msg_field RMF_SETINFO_VAL =
883 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
884 EXPORT_SYMBOL(RMF_SETINFO_VAL);
886 struct req_msg_field RMF_GETINFO_KEY =
887 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
888 EXPORT_SYMBOL(RMF_GETINFO_KEY);
890 struct req_msg_field RMF_GETINFO_VALLEN =
891 DEFINE_MSGF("getinfo_vallen", 0,
892 sizeof(__u32), lustre_swab_generic_32s, NULL);
893 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
895 struct req_msg_field RMF_GETINFO_VAL =
896 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
897 EXPORT_SYMBOL(RMF_GETINFO_VAL);
899 struct req_msg_field RMF_SEQ_OPC =
900 DEFINE_MSGF("seq_query_opc", 0,
901 sizeof(__u32), lustre_swab_generic_32s, NULL);
902 EXPORT_SYMBOL(RMF_SEQ_OPC);
904 struct req_msg_field RMF_SEQ_RANGE =
905 DEFINE_MSGF("seq_query_range", 0,
906 sizeof(struct lu_seq_range),
907 lustre_swab_lu_seq_range, NULL);
908 EXPORT_SYMBOL(RMF_SEQ_RANGE);
910 struct req_msg_field RMF_FLD_OPC =
911 DEFINE_MSGF("fld_query_opc", 0,
912 sizeof(__u32), lustre_swab_generic_32s, NULL);
913 EXPORT_SYMBOL(RMF_FLD_OPC);
915 struct req_msg_field RMF_FLD_MDFLD =
916 DEFINE_MSGF("fld_query_mdfld", 0,
917 sizeof(struct lu_seq_range),
918 lustre_swab_lu_seq_range, NULL);
919 EXPORT_SYMBOL(RMF_FLD_MDFLD);
921 struct req_msg_field RMF_MDT_BODY =
922 DEFINE_MSGF("mdt_body", 0,
923 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
924 EXPORT_SYMBOL(RMF_MDT_BODY);
926 struct req_msg_field RMF_OBD_QUOTACTL =
927 DEFINE_MSGF("obd_quotactl", 0,
928 sizeof(struct obd_quotactl),
929 lustre_swab_obd_quotactl, NULL);
930 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
932 struct req_msg_field RMF_QUOTA_BODY =
933 DEFINE_MSGF("quota_body", 0,
934 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
935 EXPORT_SYMBOL(RMF_QUOTA_BODY);
937 struct req_msg_field RMF_MDT_EPOCH =
938 DEFINE_MSGF("mdt_ioepoch", 0,
939 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
940 EXPORT_SYMBOL(RMF_MDT_EPOCH);
942 struct req_msg_field RMF_PTLRPC_BODY =
943 DEFINE_MSGF("ptlrpc_body", 0,
944 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
945 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
947 struct req_msg_field RMF_CLOSE_DATA =
948 DEFINE_MSGF("data_version", 0,
949 sizeof(struct close_data), lustre_swab_close_data, NULL);
950 EXPORT_SYMBOL(RMF_CLOSE_DATA);
952 struct req_msg_field RMF_OBD_STATFS =
953 DEFINE_MSGF("obd_statfs", 0,
954 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
955 EXPORT_SYMBOL(RMF_OBD_STATFS);
957 struct req_msg_field RMF_SETINFO_KEY =
958 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
959 EXPORT_SYMBOL(RMF_SETINFO_KEY);
961 struct req_msg_field RMF_NAME =
962 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
963 EXPORT_SYMBOL(RMF_NAME);
965 struct req_msg_field RMF_SYMTGT =
966 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_SYMTGT);
969 struct req_msg_field RMF_TGTUUID =
970 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
972 EXPORT_SYMBOL(RMF_TGTUUID);
974 struct req_msg_field RMF_CLUUID =
975 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
977 EXPORT_SYMBOL(RMF_CLUUID);
979 struct req_msg_field RMF_STRING =
980 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
981 EXPORT_SYMBOL(RMF_STRING);
983 struct req_msg_field RMF_LLOGD_BODY =
984 DEFINE_MSGF("llogd_body", 0,
985 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
986 EXPORT_SYMBOL(RMF_LLOGD_BODY);
988 struct req_msg_field RMF_LLOG_LOG_HDR =
989 DEFINE_MSGF("llog_log_hdr", 0,
990 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
991 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
993 struct req_msg_field RMF_LLOGD_CONN_BODY =
994 DEFINE_MSGF("llogd_conn_body", 0,
995 sizeof(struct llogd_conn_body),
996 lustre_swab_llogd_conn_body, NULL);
997 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1000 * connection handle received in MDS_CONNECT request.
1002 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1003 * that the client does not interpret at all.
1005 struct req_msg_field RMF_CONN =
1006 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1007 EXPORT_SYMBOL(RMF_CONN);
1009 struct req_msg_field RMF_CONNECT_DATA =
1010 DEFINE_MSGF("cdata",
1011 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1012 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
1013 sizeof(struct obd_connect_data),
1015 /* For interoperability with 1.8 and 2.0 clients/servers.
1016 * The RPC verification code allows larger RPC buffers, but not
1017 * smaller buffers. Until we no longer need to keep compatibility
1018 * with older servers/clients we can only check that the buffer
1019 * size is at least as large as obd_connect_data_v1. That is not
1020 * not in itself harmful, since the chance of just corrupting this
1021 * field is low. See JIRA LU-16 for details. */
1022 sizeof(struct obd_connect_data_v1),
1024 lustre_swab_connect, NULL);
1025 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1027 struct req_msg_field RMF_DLM_REQ =
1028 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1029 sizeof(struct ldlm_request),
1030 lustre_swab_ldlm_request, NULL);
1031 EXPORT_SYMBOL(RMF_DLM_REQ);
1033 struct req_msg_field RMF_DLM_REP =
1034 DEFINE_MSGF("dlm_rep", 0,
1035 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1036 EXPORT_SYMBOL(RMF_DLM_REP);
1038 struct req_msg_field RMF_LDLM_INTENT =
1039 DEFINE_MSGF("ldlm_intent", 0,
1040 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1041 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1043 struct req_msg_field RMF_DLM_LVB =
1044 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1045 EXPORT_SYMBOL(RMF_DLM_LVB);
1047 struct req_msg_field RMF_DLM_GL_DESC =
1048 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1049 lustre_swab_gl_desc, NULL);
1050 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1052 struct req_msg_field RMF_MDT_MD =
1053 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1054 EXPORT_SYMBOL(RMF_MDT_MD);
1056 struct req_msg_field RMF_REC_REINT =
1057 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1058 lustre_swab_mdt_rec_reint, NULL);
1059 EXPORT_SYMBOL(RMF_REC_REINT);
1061 /* FIXME: this length should be defined as a macro */
1062 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1064 EXPORT_SYMBOL(RMF_EADATA);
1066 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1067 EXPORT_SYMBOL(RMF_EAVALS);
1069 struct req_msg_field RMF_ACL =
1070 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1071 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1072 EXPORT_SYMBOL(RMF_ACL);
1074 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1075 struct req_msg_field RMF_LOGCOOKIES =
1076 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1077 sizeof(struct llog_cookie), NULL, NULL);
1078 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1080 struct req_msg_field RMF_CAPA1 =
1081 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1082 lustre_swab_lustre_capa, NULL);
1083 EXPORT_SYMBOL(RMF_CAPA1);
1085 struct req_msg_field RMF_CAPA2 =
1086 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1087 lustre_swab_lustre_capa, NULL);
1088 EXPORT_SYMBOL(RMF_CAPA2);
1090 struct req_msg_field RMF_LAYOUT_INTENT =
1091 DEFINE_MSGF("layout_intent", 0,
1092 sizeof(struct layout_intent), lustre_swab_layout_intent,
1094 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1097 * OST request field.
1099 struct req_msg_field RMF_OST_BODY =
1100 DEFINE_MSGF("ost_body", 0,
1101 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1102 EXPORT_SYMBOL(RMF_OST_BODY);
1104 struct req_msg_field RMF_OBD_IOOBJ =
1105 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1106 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1107 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1109 struct req_msg_field RMF_NIOBUF_REMOTE =
1110 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1111 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1113 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1115 struct req_msg_field RMF_RCS =
1116 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1117 lustre_swab_generic_32s, dump_rcs);
1118 EXPORT_SYMBOL(RMF_RCS);
1120 struct req_msg_field RMF_EAVALS_LENS =
1121 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1122 lustre_swab_generic_32s, NULL);
1123 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1125 struct req_msg_field RMF_OBD_ID =
1126 DEFINE_MSGF("obd_id", 0,
1127 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1128 EXPORT_SYMBOL(RMF_OBD_ID);
1130 struct req_msg_field RMF_FID =
1131 DEFINE_MSGF("fid", 0,
1132 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1133 EXPORT_SYMBOL(RMF_FID);
1135 struct req_msg_field RMF_OST_ID =
1136 DEFINE_MSGF("ost_id", 0,
1137 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1138 EXPORT_SYMBOL(RMF_OST_ID);
1140 struct req_msg_field RMF_FIEMAP_KEY =
1141 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1142 lustre_swab_fiemap, NULL);
1143 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1145 struct req_msg_field RMF_FIEMAP_VAL =
1146 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1147 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1149 struct req_msg_field RMF_IDX_INFO =
1150 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1151 lustre_swab_idx_info, NULL);
1152 EXPORT_SYMBOL(RMF_IDX_INFO);
1153 struct req_msg_field RMF_HSM_USER_STATE =
1154 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1155 lustre_swab_hsm_user_state, NULL);
1156 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1158 struct req_msg_field RMF_HSM_STATE_SET =
1159 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1160 lustre_swab_hsm_state_set, NULL);
1161 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1163 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1164 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1165 lustre_swab_hsm_progress_kernel, NULL);
1166 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1168 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1169 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1170 lustre_swab_hsm_current_action, NULL);
1171 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1173 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1174 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1175 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1177 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1179 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1180 DEFINE_MSGF("hsm_archive", 0,
1181 sizeof(__u32), lustre_swab_generic_32s, NULL);
1182 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1184 struct req_msg_field RMF_MDS_HSM_REQUEST =
1185 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1186 lustre_swab_hsm_request, NULL);
1187 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1189 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1190 lustre_swab_object_update_request, NULL);
1191 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1193 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1194 DEFINE_MSGF("object_update_reply", 0, -1,
1195 lustre_swab_object_update_reply, NULL);
1196 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1198 struct req_msg_field RMF_SWAP_LAYOUTS =
1199 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1200 lustre_swab_swap_layouts, NULL);
1201 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1203 struct req_msg_field RMF_LFSCK_REQUEST =
1204 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1205 lustre_swab_lfsck_request, NULL);
1206 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1208 struct req_msg_field RMF_LFSCK_REPLY =
1209 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1210 lustre_swab_lfsck_reply, NULL);
1211 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1218 const char *rf_name;
1222 const struct req_msg_field **d;
1223 } rf_fields[RCL_NR];
1226 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1240 #define DEFINE_REQ_FMT0(name, client, server) \
1241 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1243 struct req_format RQF_OBD_PING =
1244 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1245 EXPORT_SYMBOL(RQF_OBD_PING);
1247 struct req_format RQF_OBD_SET_INFO =
1248 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1249 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1251 /* Read index file through the network */
1252 struct req_format RQF_OBD_IDX_READ =
1253 DEFINE_REQ_FMT0("OBD_IDX_READ",
1254 obd_idx_read_client, obd_idx_read_server);
1255 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1257 struct req_format RQF_SEC_CTX =
1258 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1259 EXPORT_SYMBOL(RQF_SEC_CTX);
1261 struct req_format RQF_MGS_TARGET_REG =
1262 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1263 mgs_target_info_only);
1264 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1266 struct req_format RQF_MGS_SET_INFO =
1267 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1269 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1271 struct req_format RQF_MGS_CONFIG_READ =
1272 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1273 mgs_config_read_server);
1274 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1276 struct req_format RQF_SEQ_QUERY =
1277 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1278 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1280 struct req_format RQF_FLD_QUERY =
1281 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1282 EXPORT_SYMBOL(RQF_FLD_QUERY);
1284 struct req_format RQF_FLD_READ =
1285 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1286 EXPORT_SYMBOL(RQF_FLD_READ);
1288 struct req_format RQF_LOG_CANCEL =
1289 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1290 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1292 struct req_format RQF_MDS_QUOTACHECK =
1293 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1294 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1296 struct req_format RQF_OST_QUOTACHECK =
1297 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1298 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1300 struct req_format RQF_MDS_QUOTACTL =
1301 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1302 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1304 struct req_format RQF_OST_QUOTACTL =
1305 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1306 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1308 struct req_format RQF_QC_CALLBACK =
1309 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1310 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1312 struct req_format RQF_QUOTA_DQACQ =
1313 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1314 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1316 struct req_format RQF_LDLM_INTENT_QUOTA =
1317 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1318 ldlm_intent_quota_client,
1319 ldlm_intent_quota_server);
1320 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1322 struct req_format RQF_MDS_GETSTATUS =
1323 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1324 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1326 struct req_format RQF_MDS_STATFS =
1327 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1328 EXPORT_SYMBOL(RQF_MDS_STATFS);
1330 struct req_format RQF_MDS_SYNC =
1331 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1332 EXPORT_SYMBOL(RQF_MDS_SYNC);
1334 struct req_format RQF_MDS_GETATTR =
1335 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1336 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1338 struct req_format RQF_MDS_GETXATTR =
1339 DEFINE_REQ_FMT0("MDS_GETXATTR",
1340 mds_getxattr_client, mds_getxattr_server);
1341 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1343 struct req_format RQF_MDS_GETATTR_NAME =
1344 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1345 mds_getattr_name_client, mds_getattr_server);
1346 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1348 struct req_format RQF_MDS_REINT =
1349 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1350 EXPORT_SYMBOL(RQF_MDS_REINT);
1352 struct req_format RQF_MDS_REINT_CREATE =
1353 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1354 mds_reint_create_client, mdt_body_capa);
1355 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1357 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1358 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1359 mds_reint_create_rmt_acl_client, mdt_body_capa);
1360 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1362 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1363 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1364 mds_reint_create_slave_client, mdt_body_capa);
1365 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1367 struct req_format RQF_MDS_REINT_CREATE_SYM =
1368 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1369 mds_reint_create_sym_client, mdt_body_capa);
1370 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1372 struct req_format RQF_MDS_REINT_OPEN =
1373 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1374 mds_reint_open_client, mds_reint_open_server);
1375 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1377 struct req_format RQF_MDS_REINT_UNLINK =
1378 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1379 mds_last_unlink_server);
1380 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1382 struct req_format RQF_MDS_REINT_LINK =
1383 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1384 mds_reint_link_client, mdt_body_only);
1385 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1387 struct req_format RQF_MDS_REINT_RENAME =
1388 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1389 mds_last_unlink_server);
1390 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1392 struct req_format RQF_MDS_REINT_SETATTR =
1393 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1394 mds_reint_setattr_client, mds_setattr_server);
1395 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1397 struct req_format RQF_MDS_REINT_SETXATTR =
1398 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1399 mds_reint_setxattr_client, mdt_body_only);
1400 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1402 struct req_format RQF_MDS_CONNECT =
1403 DEFINE_REQ_FMT0("MDS_CONNECT",
1404 obd_connect_client, obd_connect_server);
1405 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1407 struct req_format RQF_MDS_DISCONNECT =
1408 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1409 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1411 struct req_format RQF_MDS_GET_INFO =
1412 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1413 mds_getinfo_server);
1414 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1416 struct req_format RQF_OUT_UPDATE =
1417 DEFINE_REQ_FMT0("OUT_UPDATE_OBJ", mds_update_client,
1419 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1421 struct req_format RQF_LDLM_ENQUEUE =
1422 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1423 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1424 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1426 struct req_format RQF_LDLM_ENQUEUE_LVB =
1427 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1428 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1429 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1431 struct req_format RQF_LDLM_CONVERT =
1432 DEFINE_REQ_FMT0("LDLM_CONVERT",
1433 ldlm_enqueue_client, ldlm_enqueue_server);
1434 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1436 struct req_format RQF_LDLM_CANCEL =
1437 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1438 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1440 struct req_format RQF_LDLM_CALLBACK =
1441 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1442 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1444 struct req_format RQF_LDLM_CP_CALLBACK =
1445 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1446 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1448 struct req_format RQF_LDLM_BL_CALLBACK =
1449 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1450 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1452 struct req_format RQF_LDLM_GL_CALLBACK =
1453 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1454 ldlm_gl_callback_server);
1455 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1457 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1458 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1459 ldlm_gl_callback_server);
1460 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1462 struct req_format RQF_LDLM_INTENT_BASIC =
1463 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1464 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1465 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1467 struct req_format RQF_LDLM_INTENT =
1468 DEFINE_REQ_FMT0("LDLM_INTENT",
1469 ldlm_intent_client, ldlm_intent_server);
1470 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1472 struct req_format RQF_LDLM_INTENT_LAYOUT =
1473 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1474 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1475 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1477 struct req_format RQF_LDLM_INTENT_GETATTR =
1478 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1479 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1480 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1482 struct req_format RQF_LDLM_INTENT_OPEN =
1483 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1484 ldlm_intent_open_client, ldlm_intent_open_server);
1485 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1487 struct req_format RQF_LDLM_INTENT_CREATE =
1488 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1489 ldlm_intent_create_client, ldlm_intent_getattr_server);
1490 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1492 struct req_format RQF_LDLM_INTENT_UNLINK =
1493 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1494 ldlm_intent_unlink_client, ldlm_intent_server);
1495 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1497 struct req_format RQF_LDLM_INTENT_GETXATTR =
1498 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1499 ldlm_intent_getxattr_client,
1500 ldlm_intent_getxattr_server);
1501 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1503 struct req_format RQF_MDS_CLOSE =
1504 DEFINE_REQ_FMT0("MDS_CLOSE",
1505 mdt_close_client, mds_last_unlink_server);
1506 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1508 struct req_format RQF_MDS_RELEASE_CLOSE =
1509 DEFINE_REQ_FMT0("MDS_CLOSE",
1510 mdt_release_close_client, mds_last_unlink_server);
1511 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1513 struct req_format RQF_MDS_DONE_WRITING =
1514 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1515 mdt_close_client, mdt_body_only);
1516 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1518 struct req_format RQF_MDS_READPAGE =
1519 DEFINE_REQ_FMT0("MDS_READPAGE",
1520 mdt_body_capa, mdt_body_only);
1521 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1523 struct req_format RQF_MDS_HSM_ACTION =
1524 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1525 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1527 struct req_format RQF_MDS_HSM_PROGRESS =
1528 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1529 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1531 struct req_format RQF_MDS_HSM_CT_REGISTER =
1532 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1533 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1535 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1536 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1537 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1539 struct req_format RQF_MDS_HSM_STATE_GET =
1540 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1541 mdt_body_capa, mdt_hsm_state_get_server);
1542 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1544 struct req_format RQF_MDS_HSM_STATE_SET =
1545 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1546 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1548 struct req_format RQF_MDS_HSM_REQUEST =
1549 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1550 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1552 struct req_format RQF_MDS_SWAP_LAYOUTS =
1553 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1554 mdt_swap_layouts, empty);
1555 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1557 /* This is for split */
1558 struct req_format RQF_MDS_WRITEPAGE =
1559 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1560 mdt_body_capa, mdt_body_only);
1561 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1563 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1564 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1565 llog_origin_handle_create_client, llogd_body_only);
1566 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1568 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1569 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1570 llogd_body_only, llogd_body_only);
1571 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1573 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1574 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1575 llogd_body_only, llog_origin_handle_next_block_server);
1576 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1578 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1579 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1580 llogd_body_only, llog_origin_handle_next_block_server);
1581 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1583 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1584 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1585 llogd_body_only, llog_log_hdr_only);
1586 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1588 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1589 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1590 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1592 struct req_format RQF_CONNECT =
1593 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1594 EXPORT_SYMBOL(RQF_CONNECT);
1596 struct req_format RQF_OST_CONNECT =
1597 DEFINE_REQ_FMT0("OST_CONNECT",
1598 obd_connect_client, obd_connect_server);
1599 EXPORT_SYMBOL(RQF_OST_CONNECT);
1601 struct req_format RQF_OST_DISCONNECT =
1602 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1603 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1605 struct req_format RQF_OST_GETATTR =
1606 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1607 EXPORT_SYMBOL(RQF_OST_GETATTR);
1609 struct req_format RQF_OST_SETATTR =
1610 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1611 EXPORT_SYMBOL(RQF_OST_SETATTR);
1613 struct req_format RQF_OST_CREATE =
1614 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1615 EXPORT_SYMBOL(RQF_OST_CREATE);
1617 struct req_format RQF_OST_PUNCH =
1618 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1619 EXPORT_SYMBOL(RQF_OST_PUNCH);
1621 struct req_format RQF_OST_SYNC =
1622 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1623 EXPORT_SYMBOL(RQF_OST_SYNC);
1625 struct req_format RQF_OST_DESTROY =
1626 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1627 EXPORT_SYMBOL(RQF_OST_DESTROY);
1629 struct req_format RQF_OST_BRW_READ =
1630 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1631 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1633 struct req_format RQF_OST_BRW_WRITE =
1634 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1635 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1637 struct req_format RQF_OST_STATFS =
1638 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1639 EXPORT_SYMBOL(RQF_OST_STATFS);
1641 struct req_format RQF_OST_SET_GRANT_INFO =
1642 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1644 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1646 struct req_format RQF_OST_GET_INFO =
1647 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1648 ost_get_info_generic_server);
1649 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1651 struct req_format RQF_OST_GET_INFO_LAST_ID =
1652 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1653 ost_get_last_id_server);
1654 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1656 struct req_format RQF_OST_GET_INFO_LAST_FID =
1657 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1658 ost_get_last_fid_server);
1659 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1661 struct req_format RQF_OST_SET_INFO_LAST_FID =
1662 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1664 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1666 struct req_format RQF_OST_GET_INFO_FIEMAP =
1667 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1668 ost_get_fiemap_server);
1669 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1671 struct req_format RQF_LFSCK_NOTIFY =
1672 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1673 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1675 struct req_format RQF_LFSCK_QUERY =
1676 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1677 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1679 #if !defined(__REQ_LAYOUT_USER__)
1681 /* Convenience macro */
1682 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1685 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1686 * field of RQFs and the \a rmf_offset field of RMFs.
1688 int req_layout_init(void)
1693 struct req_format *rf = NULL;
1695 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1696 rf = req_formats[i];
1698 for (j = 0; j < RCL_NR; ++j) {
1699 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1700 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1701 struct req_msg_field *field;
1703 field = (typeof(field))rf->rf_fields[j].d[k];
1704 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1705 || field->rmf_size > 0);
1706 LASSERT(field->rmf_offset[i][j] == 0);
1708 * k + 1 to detect unused format/field
1711 field->rmf_offset[i][j] = k + 1;
1717 EXPORT_SYMBOL(req_layout_init);
1719 void req_layout_fini(void)
1722 EXPORT_SYMBOL(req_layout_fini);
1725 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1727 * Actual/expected field sizes are set elsewhere in functions in this file:
1728 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1729 * req_capsule_msg_size(). The \a rc_area information is used by.
1730 * ptlrpc_request_set_replen().
1732 void req_capsule_init_area(struct req_capsule *pill)
1736 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1737 pill->rc_area[RCL_CLIENT][i] = -1;
1738 pill->rc_area[RCL_SERVER][i] = -1;
1741 EXPORT_SYMBOL(req_capsule_init_area);
1744 * Initialize a pill.
1746 * The \a location indicates whether the caller is executing on the client side
1747 * (RCL_CLIENT) or server side (RCL_SERVER)..
1749 void req_capsule_init(struct req_capsule *pill,
1750 struct ptlrpc_request *req,
1751 enum req_location location)
1753 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1756 * Today all capsules are embedded in ptlrpc_request structs,
1757 * but just in case that ever isn't the case, we don't reach
1758 * into req unless req != NULL and pill is the one embedded in
1761 * The req->rq_pill_init flag makes it safe to initialize a pill
1762 * twice, which might happen in the OST paths as a result of the
1763 * high-priority RPC queue getting peeked at before ost_handle()
1764 * handles an OST RPC.
1766 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1769 memset(pill, 0, sizeof *pill);
1771 pill->rc_loc = location;
1772 req_capsule_init_area(pill);
1774 if (req != NULL && pill == &req->rq_pill)
1775 req->rq_pill_init = 1;
1777 EXPORT_SYMBOL(req_capsule_init);
1779 void req_capsule_fini(struct req_capsule *pill)
1782 EXPORT_SYMBOL(req_capsule_fini);
1784 static int __req_format_is_sane(const struct req_format *fmt)
1787 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1788 req_formats[fmt->rf_idx] == fmt;
1791 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1792 enum req_location loc)
1794 struct ptlrpc_request *req;
1797 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1801 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1802 * (see req_capsule_extend()).
1804 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1806 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1807 LASSERT(__req_format_is_sane(fmt));
1811 EXPORT_SYMBOL(req_capsule_set);
1814 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1817 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1818 * variable-sized fields. The field sizes come from the declared \a rmf_size
1819 * field of a \a pill's \a rc_fmt's RMF's.
1821 int req_capsule_filled_sizes(struct req_capsule *pill,
1822 enum req_location loc)
1824 const struct req_format *fmt = pill->rc_fmt;
1827 LASSERT(fmt != NULL);
1829 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1830 if (pill->rc_area[loc][i] == -1) {
1831 pill->rc_area[loc][i] =
1832 fmt->rf_fields[loc].d[i]->rmf_size;
1833 if (pill->rc_area[loc][i] == -1) {
1835 * Skip the following fields.
1837 * If this LASSERT() trips then you're missing a
1838 * call to req_capsule_set_size().
1840 LASSERT(loc != RCL_SERVER);
1847 EXPORT_SYMBOL(req_capsule_filled_sizes);
1850 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1852 * This function uses the \a pill's \a rc_area as filled in by
1853 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1856 int req_capsule_server_pack(struct req_capsule *pill)
1858 const struct req_format *fmt;
1862 LASSERT(pill->rc_loc == RCL_SERVER);
1864 LASSERT(fmt != NULL);
1866 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1867 rc = lustre_pack_reply(pill->rc_req, count,
1868 pill->rc_area[RCL_SERVER], NULL);
1870 DEBUG_REQ(D_ERROR, pill->rc_req,
1871 "Cannot pack %d fields in format `%s': ",
1872 count, fmt->rf_name);
1876 EXPORT_SYMBOL(req_capsule_server_pack);
1879 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1880 * corresponding to the given RMF (\a field).
1882 static int __req_capsule_offset(const struct req_capsule *pill,
1883 const struct req_msg_field *field,
1884 enum req_location loc)
1888 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1889 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1890 pill->rc_fmt->rf_name,
1891 field->rmf_name, offset, loc);
1894 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1899 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1904 swabber_dumper_helper(struct req_capsule *pill,
1905 const struct req_msg_field *field,
1906 enum req_location loc,
1908 void *value, int len, int dump, void (*swabber)( void *))
1914 int inout = loc == RCL_CLIENT;
1916 swabber = swabber ?: field->rmf_swabber;
1918 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1919 swabber != NULL && value != NULL)
1924 if (!field->rmf_dumper)
1927 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1929 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1930 do_swab ? "unswabbed " : "", field->rmf_name);
1931 field->rmf_dumper(value);
1936 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1938 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1939 "follows\n", field->rmf_name);
1940 field->rmf_dumper(value);
1947 * We're swabbing an array; swabber() swabs a single array element, so
1948 * swab every element.
1950 LASSERT((len % field->rmf_size) == 0);
1951 for (p = value, i = 0, n = len / field->rmf_size;
1953 i++, p += field->rmf_size) {
1955 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1956 "element %d follows\n",
1957 do_swab ? "unswabbed " : "", field->rmf_name, i);
1958 field->rmf_dumper(p);
1964 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1965 "element %d follows\n", field->rmf_name, i);
1966 field->rmf_dumper(value);
1970 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1974 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1975 * corresponding to the given RMF (\a field).
1977 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1978 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1979 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1980 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1981 * element of the array swabbed.
1983 static void *__req_capsule_get(struct req_capsule *pill,
1984 const struct req_msg_field *field,
1985 enum req_location loc,
1986 void (*swabber)( void *),
1989 const struct req_format *fmt;
1990 struct lustre_msg *msg;
1995 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1997 static const char *rcl_names[RCL_NR] = {
1998 [RCL_CLIENT] = "client",
1999 [RCL_SERVER] = "server"
2002 LASSERT(pill != NULL);
2003 LASSERT(pill != LP_POISON);
2005 LASSERT(fmt != NULL);
2006 LASSERT(fmt != LP_POISON);
2007 LASSERT(__req_format_is_sane(fmt));
2009 offset = __req_capsule_offset(pill, field, loc);
2011 msg = __req_msg(pill, loc);
2012 LASSERT(msg != NULL);
2014 getter = (field->rmf_flags & RMF_F_STRING) ?
2015 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2017 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2019 * We've already asserted that field->rmf_size > 0 in
2020 * req_layout_init().
2022 len = lustre_msg_buflen(msg, offset);
2023 if ((len % field->rmf_size) != 0) {
2024 CERROR("%s: array field size mismatch "
2025 "%d modulo %d != 0 (%d)\n",
2026 field->rmf_name, len, field->rmf_size, loc);
2029 } else if (pill->rc_area[loc][offset] != -1) {
2030 len = pill->rc_area[loc][offset];
2032 len = max(field->rmf_size, 0);
2034 value = getter(msg, offset, len);
2036 if (value == NULL) {
2037 DEBUG_REQ(D_ERROR, pill->rc_req,
2038 "Wrong buffer for field `%s' (%d of %d) "
2039 "in format `%s': %d vs. %d (%s)\n",
2040 field->rmf_name, offset, lustre_msg_bufcount(msg),
2041 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2044 swabber_dumper_helper(pill, field, loc, offset, value, len,
2052 * Dump a request and/or reply
2054 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2056 const struct req_format *fmt;
2057 const struct req_msg_field *field;
2063 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2064 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2065 field = FMT_FIELD(fmt, loc, i);
2066 if (field->rmf_dumper == NULL) {
2068 * FIXME Add a default hex dumper for fields that don't
2069 * have a specific dumper
2071 len = req_capsule_get_size(pill, field, loc);
2072 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2073 "field size is %d\n", field->rmf_name, len);
2075 /* It's the dumping side-effect that we're interested in */
2076 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2079 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2085 void req_capsule_client_dump(struct req_capsule *pill)
2087 __req_capsule_dump(pill, RCL_CLIENT);
2089 EXPORT_SYMBOL(req_capsule_client_dump);
2094 void req_capsule_server_dump(struct req_capsule *pill)
2096 __req_capsule_dump(pill, RCL_SERVER);
2098 EXPORT_SYMBOL(req_capsule_server_dump);
2101 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2102 * buffer corresponding to the given RMF (\a field) of a \a pill.
2104 void *req_capsule_client_get(struct req_capsule *pill,
2105 const struct req_msg_field *field)
2107 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2109 EXPORT_SYMBOL(req_capsule_client_get);
2112 * Same as req_capsule_client_get(), but with a \a swabber argument.
2114 * Currently unused; will be removed when req_capsule_server_swab_get() is
2117 void *req_capsule_client_swab_get(struct req_capsule *pill,
2118 const struct req_msg_field *field,
2121 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2123 EXPORT_SYMBOL(req_capsule_client_swab_get);
2126 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2128 * First the \a pill's request \a field's size is set (\a rc_area) using
2129 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2132 void *req_capsule_client_sized_get(struct req_capsule *pill,
2133 const struct req_msg_field *field,
2136 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2137 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2139 EXPORT_SYMBOL(req_capsule_client_sized_get);
2142 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2143 * buffer corresponding to the given RMF (\a field) of a \a pill.
2145 void *req_capsule_server_get(struct req_capsule *pill,
2146 const struct req_msg_field *field)
2148 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2150 EXPORT_SYMBOL(req_capsule_server_get);
2153 * Same as req_capsule_server_get(), but with a \a swabber argument.
2155 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2156 * swabbing done outside this capsule abstraction.
2158 void *req_capsule_server_swab_get(struct req_capsule *pill,
2159 const struct req_msg_field *field,
2162 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2164 EXPORT_SYMBOL(req_capsule_server_swab_get);
2167 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2169 * First the \a pill's request \a field's size is set (\a rc_area) using
2170 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2173 void *req_capsule_server_sized_get(struct req_capsule *pill,
2174 const struct req_msg_field *field,
2177 req_capsule_set_size(pill, field, RCL_SERVER, len);
2178 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2180 EXPORT_SYMBOL(req_capsule_server_sized_get);
2182 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2183 const struct req_msg_field *field,
2184 int len, void *swabber)
2186 req_capsule_set_size(pill, field, RCL_SERVER, len);
2187 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2189 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2192 * Returns the buffer of a \a pill corresponding to the given \a field from the
2193 * request (if the caller is executing on the server-side) or reply (if the
2194 * caller is executing on the client-side).
2196 * This function convienient for use is code that could be executed on the
2197 * client and server alike.
2199 const void *req_capsule_other_get(struct req_capsule *pill,
2200 const struct req_msg_field *field)
2202 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2204 EXPORT_SYMBOL(req_capsule_other_get);
2207 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2208 * field of the given \a pill.
2210 * This function must be used when constructing variable sized fields of a
2213 void req_capsule_set_size(struct req_capsule *pill,
2214 const struct req_msg_field *field,
2215 enum req_location loc, int size)
2217 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2219 if ((size != field->rmf_size) &&
2220 (field->rmf_size != -1) &&
2221 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2223 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2224 (size % field->rmf_size != 0)) {
2225 CERROR("%s: array field size mismatch "
2226 "%d %% %d != 0 (%d)\n",
2227 field->rmf_name, size, field->rmf_size, loc);
2229 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2230 size < field->rmf_size) {
2231 CERROR("%s: field size mismatch %d != %d (%d)\n",
2232 field->rmf_name, size, field->rmf_size, loc);
2237 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2239 EXPORT_SYMBOL(req_capsule_set_size);
2242 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2243 * for the given \a pill's given \a field.
2245 * NB: this function doesn't correspond with req_capsule_set_size(), which
2246 * actually sets the size in pill.rc_area[loc][offset], but this function
2247 * returns the message buflen[offset], maybe we should use another name.
2249 int req_capsule_get_size(const struct req_capsule *pill,
2250 const struct req_msg_field *field,
2251 enum req_location loc)
2253 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2255 return lustre_msg_buflen(__req_msg(pill, loc),
2256 __req_capsule_offset(pill, field, loc));
2258 EXPORT_SYMBOL(req_capsule_get_size);
2261 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2262 * given \a pill's request or reply (\a loc) given the field size recorded in
2263 * the \a pill's rc_area.
2265 * See also req_capsule_set_size().
2267 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2269 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2270 pill->rc_fmt->rf_fields[loc].nr,
2271 pill->rc_area[loc]);
2275 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2276 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2277 * PTLRPC request or reply given only an RQF (\a fmt).
2279 * This function should not be used for formats which contain variable size
2282 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2283 enum req_location loc)
2288 * This function should probably LASSERT() that fmt has no fields with
2289 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2290 * elements in the array there will ultimately be, but then, we could
2291 * assume that there will be at least one element, and that's just what
2294 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2298 for (; i < fmt->rf_fields[loc].nr; ++i)
2299 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2300 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2306 * Changes the format of an RPC.
2308 * The pill must already have been initialized, which means that it already has
2309 * a request format. The new format \a fmt must be an extension of the pill's
2310 * old format. Specifically: the new format must have as many request and reply
2311 * fields as the old one, and all fields shared by the old and new format must
2312 * be at least as large in the new format.
2314 * The new format's fields may be of different "type" than the old format, but
2315 * only for fields that are "opaque" blobs: fields which have a) have no
2316 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2317 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2318 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2319 * according to the key field. When the value, according to the key, contains a
2320 * structure (or array thereof) to be swabbed, the format should be changed to
2321 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2324 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2329 const struct req_format *old;
2331 LASSERT(pill->rc_fmt != NULL);
2332 LASSERT(__req_format_is_sane(fmt));
2336 * Sanity checking...
2338 for (i = 0; i < RCL_NR; ++i) {
2339 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2340 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2341 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2343 /* "opaque" fields can be transmogrified */
2344 if (ofield->rmf_swabber == NULL &&
2345 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2346 (ofield->rmf_size == -1 ||
2347 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2349 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2352 * Last field in old format can be shorter than in new.
2354 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2355 FMT_FIELD(old, i, j)->rmf_size);
2360 EXPORT_SYMBOL(req_capsule_extend);
2363 * This function returns a non-zero value if the given \a field is present in
2364 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2367 int req_capsule_has_field(const struct req_capsule *pill,
2368 const struct req_msg_field *field,
2369 enum req_location loc)
2371 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2373 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2375 EXPORT_SYMBOL(req_capsule_has_field);
2378 * Returns a non-zero value if the given \a field is present in the given \a
2379 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2381 int req_capsule_field_present(const struct req_capsule *pill,
2382 const struct req_msg_field *field,
2383 enum req_location loc)
2387 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2388 LASSERT(req_capsule_has_field(pill, field, loc));
2390 offset = __req_capsule_offset(pill, field, loc);
2391 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2393 EXPORT_SYMBOL(req_capsule_field_present);
2396 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2397 * request or reply (\a loc).
2399 * This is not the opposite of req_capsule_extend().
2401 void req_capsule_shrink(struct req_capsule *pill,
2402 const struct req_msg_field *field,
2403 unsigned int newlen,
2404 enum req_location loc)
2406 const struct req_format *fmt;
2407 struct lustre_msg *msg;
2412 LASSERT(fmt != NULL);
2413 LASSERT(__req_format_is_sane(fmt));
2414 LASSERT(req_capsule_has_field(pill, field, loc));
2415 LASSERT(req_capsule_field_present(pill, field, loc));
2417 offset = __req_capsule_offset(pill, field, loc);
2419 msg = __req_msg(pill, loc);
2420 len = lustre_msg_buflen(msg, offset);
2421 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2422 fmt->rf_name, field->rmf_name, len, newlen);
2424 if (loc == RCL_CLIENT)
2425 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2428 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2431 EXPORT_SYMBOL(req_capsule_shrink);
2433 int req_capsule_server_grow(struct req_capsule *pill,
2434 const struct req_msg_field *field,
2435 unsigned int newlen)
2437 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2439 int offset, len, rc;
2441 LASSERT(pill->rc_fmt != NULL);
2442 LASSERT(__req_format_is_sane(pill->rc_fmt));
2443 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2444 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2446 len = req_capsule_get_size(pill, field, RCL_SERVER);
2447 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2448 if (pill->rc_req->rq_repbuf_len >=
2449 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2450 CERROR("Inplace repack might be done\n");
2452 pill->rc_req->rq_reply_state = NULL;
2453 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2454 rc = req_capsule_server_pack(pill);
2456 /* put old rs back, the caller will decide what to do */
2457 pill->rc_req->rq_reply_state = rs;
2460 nrs = pill->rc_req->rq_reply_state;
2461 /* Now we need only buffers, copy first chunk */
2462 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2463 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2464 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2465 memcpy(to, from, len);
2466 /* check if we have tail and copy it too */
2467 if (rs->rs_msg->lm_bufcount > offset + 1) {
2468 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2469 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2470 offset = rs->rs_msg->lm_bufcount - 1;
2471 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2472 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2473 memcpy(to, from, len);
2475 /* drop old reply if everything is fine */
2476 if (rs->rs_difficult) {
2480 nrs->rs_difficult = 1;
2481 nrs->rs_no_ack = rs->rs_no_ack;
2482 for (i = 0; i < rs->rs_nlocks; i++) {
2483 nrs->rs_locks[i] = rs->rs_locks[i];
2484 nrs->rs_modes[i] = rs->rs_modes[i];
2488 rs->rs_difficult = 0;
2491 ptlrpc_rs_decref(rs);
2494 EXPORT_SYMBOL(req_capsule_server_grow);
2495 /* __REQ_LAYOUT_USER__ */