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, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
53 #include <linux/module.h>
55 #include <lustre/lustre_idl.h>
57 #include <llog_swab.h>
58 #include <lustre_debug.h>
59 #include <lustre_swab.h>
60 #include <lustre_ver.h>
62 #include <obd_support.h>
63 #endif /* !__REQ_LAYOUT_USER__ */
65 /* struct ptlrpc_request, lustre_msg* */
66 #include <lustre_req_layout.h>
67 #include <lustre_acl.h>
70 * RQFs (see below) refer to two struct req_msg_field arrays describing the
71 * client request and server reply, respectively.
73 /* empty set of fields... for suitable definition of emptiness. */
74 static const struct req_msg_field *empty[] = {
78 static const struct req_msg_field *mgs_target_info_only[] = {
83 static const struct req_msg_field *mgs_set_info[] = {
88 static const struct req_msg_field *mgs_config_read_client[] = {
93 static const struct req_msg_field *mgs_config_read_server[] = {
98 static const struct req_msg_field *log_cancel_client[] = {
103 static const struct req_msg_field *mdt_body_only[] = {
108 static const struct req_msg_field *mdt_body_capa[] = {
114 static const struct req_msg_field *quotactl_only[] = {
119 static const struct req_msg_field *quota_body_only[] = {
124 static const struct req_msg_field *ldlm_intent_quota_client[] = {
131 static const struct req_msg_field *ldlm_intent_quota_server[] = {
138 static const struct req_msg_field *mdt_close_client[] = {
145 static const struct req_msg_field *mdt_intent_close_client[] = {
153 static const struct req_msg_field *obd_statfs_server[] = {
158 static const struct req_msg_field *seq_query_client[] = {
164 static const struct req_msg_field *seq_query_server[] = {
169 static const struct req_msg_field *fld_query_client[] = {
175 static const struct req_msg_field *fld_query_server[] = {
180 static const struct req_msg_field *fld_read_client[] = {
185 static const struct req_msg_field *fld_read_server[] = {
190 static const struct req_msg_field *mds_getattr_name_client[] = {
197 static const struct req_msg_field *mds_reint_client[] = {
202 static const struct req_msg_field *mds_reint_create_client[] = {
209 static const struct req_msg_field *mds_reint_create_slave_client[] = {
218 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
227 static const struct req_msg_field *mds_reint_create_sym_client[] = {
236 static const struct req_msg_field *mds_reint_open_client[] = {
245 static const struct req_msg_field *mds_reint_open_server[] = {
254 static const struct req_msg_field *mds_reint_unlink_client[] = {
262 static const struct req_msg_field *mds_reint_link_client[] = {
271 static const struct req_msg_field *mds_reint_rename_client[] = {
281 static const struct req_msg_field *mds_reint_migrate_client[] = {
293 static const struct req_msg_field *mds_last_unlink_server[] = {
302 static const struct req_msg_field *mds_reint_setattr_client[] = {
312 static const struct req_msg_field *mds_reint_setxattr_client[] = {
321 static const struct req_msg_field *mdt_swap_layouts[] = {
330 static const struct req_msg_field *obd_connect_client[] = {
338 static const struct req_msg_field *obd_connect_server[] = {
343 static const struct req_msg_field *obd_set_info_client[] = {
349 static const struct req_msg_field *ost_grant_shrink_client[] = {
355 static const struct req_msg_field *mds_getinfo_client[] = {
361 static const struct req_msg_field *mds_getinfo_server[] = {
366 static const struct req_msg_field *ldlm_enqueue_client[] = {
371 static const struct req_msg_field *ldlm_enqueue_server[] = {
376 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
382 static const struct req_msg_field *ldlm_cp_callback_client[] = {
388 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
394 static const struct req_msg_field *ldlm_gl_callback_server[] = {
399 static const struct req_msg_field *ldlm_intent_basic_client[] = {
405 static const struct req_msg_field *ldlm_intent_client[] = {
412 static const struct req_msg_field *ldlm_intent_server[] = {
420 static const struct req_msg_field *ldlm_intent_layout_client[] = {
425 &RMF_EADATA /* for new layout to be set up */
427 static const struct req_msg_field *ldlm_intent_open_server[] = {
437 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
441 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
446 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
455 static const struct req_msg_field *ldlm_intent_create_client[] = {
459 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
465 static const struct req_msg_field *ldlm_intent_open_client[] = {
469 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
476 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
480 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
485 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
493 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
498 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
504 static const struct req_msg_field *mds_getxattr_client[] = {
512 static const struct req_msg_field *mds_getxattr_server[] = {
518 static const struct req_msg_field *mds_getattr_server[] = {
527 static const struct req_msg_field *mds_setattr_server[] = {
536 static const struct req_msg_field *mds_update_client[] = {
538 &RMF_OUT_UPDATE_HEADER,
542 static const struct req_msg_field *mds_update_server[] = {
544 &RMF_OUT_UPDATE_REPLY,
547 static const struct req_msg_field *llog_origin_handle_create_client[] = {
553 static const struct req_msg_field *llogd_body_only[] = {
558 static const struct req_msg_field *llog_log_hdr_only[] = {
563 static const struct req_msg_field *llogd_conn_body_only[] = {
568 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
574 static const struct req_msg_field *obd_idx_read_client[] = {
579 static const struct req_msg_field *obd_idx_read_server[] = {
584 static const struct req_msg_field *ost_body_only[] = {
589 static const struct req_msg_field *ost_body_capa[] = {
595 static const struct req_msg_field *ost_destroy_client[] = {
603 static const struct req_msg_field *ost_brw_client[] = {
611 static const struct req_msg_field *ost_brw_read_server[] = {
616 static const struct req_msg_field *ost_brw_write_server[] = {
622 static const struct req_msg_field *ost_get_info_generic_server[] = {
627 static const struct req_msg_field *ost_get_info_generic_client[] = {
632 static const struct req_msg_field *ost_get_last_id_server[] = {
637 static const struct req_msg_field *ost_get_last_fid_client[] = {
643 static const struct req_msg_field *ost_get_last_fid_server[] = {
648 static const struct req_msg_field *ost_get_fiemap_client[] = {
654 static const struct req_msg_field *ost_get_fiemap_server[] = {
659 static const struct req_msg_field *mdt_hsm_progress[] = {
662 &RMF_MDS_HSM_PROGRESS,
665 static const struct req_msg_field *mdt_hsm_ct_register[] = {
668 &RMF_MDS_HSM_ARCHIVE,
671 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
676 static const struct req_msg_field *mdt_hsm_action_server[] = {
679 &RMF_MDS_HSM_CURRENT_ACTION,
682 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
688 static const struct req_msg_field *mdt_hsm_state_set[] = {
695 static const struct req_msg_field *mdt_hsm_request[] = {
698 &RMF_MDS_HSM_REQUEST,
699 &RMF_MDS_HSM_USER_ITEM,
703 static const struct req_msg_field *obd_lfsck_request[] = {
708 static const struct req_msg_field *obd_lfsck_reply[] = {
713 static struct req_format *req_formats[] = {
720 &RQF_MGS_CONFIG_READ,
730 &RQF_MDS_GETATTR_NAME,
734 &RQF_MDS_INTENT_CLOSE,
737 &RQF_MDS_REINT_CREATE,
738 &RQF_MDS_REINT_CREATE_RMT_ACL,
739 &RQF_MDS_REINT_CREATE_SLAVE,
740 &RQF_MDS_REINT_CREATE_SYM,
742 &RQF_MDS_REINT_UNLINK,
744 &RQF_MDS_REINT_RENAME,
745 &RQF_MDS_REINT_MIGRATE,
746 &RQF_MDS_REINT_SETATTR,
747 &RQF_MDS_REINT_SETXATTR,
749 &RQF_MDS_HSM_PROGRESS,
750 &RQF_MDS_HSM_CT_REGISTER,
751 &RQF_MDS_HSM_CT_UNREGISTER,
752 &RQF_MDS_HSM_STATE_GET,
753 &RQF_MDS_HSM_STATE_SET,
755 &RQF_MDS_HSM_REQUEST,
756 &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 sizeof(struct obd_connect_data),
1016 lustre_swab_connect, NULL);
1017 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1019 struct req_msg_field RMF_DLM_REQ =
1020 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1021 sizeof(struct ldlm_request),
1022 lustre_swab_ldlm_request, NULL);
1023 EXPORT_SYMBOL(RMF_DLM_REQ);
1025 struct req_msg_field RMF_DLM_REP =
1026 DEFINE_MSGF("dlm_rep", 0,
1027 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1028 EXPORT_SYMBOL(RMF_DLM_REP);
1030 struct req_msg_field RMF_LDLM_INTENT =
1031 DEFINE_MSGF("ldlm_intent", 0,
1032 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1033 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1035 struct req_msg_field RMF_DLM_LVB =
1036 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1037 EXPORT_SYMBOL(RMF_DLM_LVB);
1039 struct req_msg_field RMF_DLM_GL_DESC =
1040 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1041 lustre_swab_gl_desc, NULL);
1042 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1044 struct req_msg_field RMF_MDT_MD =
1045 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1046 EXPORT_SYMBOL(RMF_MDT_MD);
1048 struct req_msg_field RMF_REC_REINT =
1049 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1050 lustre_swab_mdt_rec_reint, NULL);
1051 EXPORT_SYMBOL(RMF_REC_REINT);
1053 /* FIXME: this length should be defined as a macro */
1054 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1056 EXPORT_SYMBOL(RMF_EADATA);
1058 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1059 EXPORT_SYMBOL(RMF_EAVALS);
1061 struct req_msg_field RMF_ACL =
1062 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1063 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_ACL);
1066 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1067 struct req_msg_field RMF_LOGCOOKIES =
1068 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1069 sizeof(struct llog_cookie), NULL, NULL);
1070 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1072 struct req_msg_field RMF_CAPA1 =
1073 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1074 lustre_swab_lustre_capa, NULL);
1075 EXPORT_SYMBOL(RMF_CAPA1);
1077 struct req_msg_field RMF_CAPA2 =
1078 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1079 lustre_swab_lustre_capa, NULL);
1080 EXPORT_SYMBOL(RMF_CAPA2);
1082 struct req_msg_field RMF_LAYOUT_INTENT =
1083 DEFINE_MSGF("layout_intent", 0,
1084 sizeof(struct layout_intent), lustre_swab_layout_intent,
1086 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1089 * OST request field.
1091 struct req_msg_field RMF_OST_BODY =
1092 DEFINE_MSGF("ost_body", 0,
1093 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1094 EXPORT_SYMBOL(RMF_OST_BODY);
1096 struct req_msg_field RMF_OBD_IOOBJ =
1097 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1098 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1099 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1101 struct req_msg_field RMF_NIOBUF_REMOTE =
1102 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1103 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1105 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1107 struct req_msg_field RMF_RCS =
1108 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1109 lustre_swab_generic_32s, dump_rcs);
1110 EXPORT_SYMBOL(RMF_RCS);
1112 struct req_msg_field RMF_EAVALS_LENS =
1113 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1114 lustre_swab_generic_32s, NULL);
1115 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1117 struct req_msg_field RMF_OBD_ID =
1118 DEFINE_MSGF("obd_id", 0,
1119 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1120 EXPORT_SYMBOL(RMF_OBD_ID);
1122 struct req_msg_field RMF_FID =
1123 DEFINE_MSGF("fid", 0,
1124 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1125 EXPORT_SYMBOL(RMF_FID);
1127 struct req_msg_field RMF_OST_ID =
1128 DEFINE_MSGF("ost_id", 0,
1129 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1130 EXPORT_SYMBOL(RMF_OST_ID);
1132 struct req_msg_field RMF_FIEMAP_KEY =
1133 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1134 lustre_swab_fiemap, NULL);
1135 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1137 struct req_msg_field RMF_FIEMAP_VAL =
1138 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1139 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1141 struct req_msg_field RMF_IDX_INFO =
1142 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1143 lustre_swab_idx_info, NULL);
1144 EXPORT_SYMBOL(RMF_IDX_INFO);
1145 struct req_msg_field RMF_HSM_USER_STATE =
1146 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1147 lustre_swab_hsm_user_state, NULL);
1148 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1150 struct req_msg_field RMF_HSM_STATE_SET =
1151 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1152 lustre_swab_hsm_state_set, NULL);
1153 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1155 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1156 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1157 lustre_swab_hsm_progress_kernel, NULL);
1158 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1160 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1161 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1162 lustre_swab_hsm_current_action, NULL);
1163 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1165 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1166 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1167 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1169 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1171 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1172 DEFINE_MSGF("hsm_archive", 0,
1173 sizeof(__u32), lustre_swab_generic_32s, NULL);
1174 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1176 struct req_msg_field RMF_MDS_HSM_REQUEST =
1177 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1178 lustre_swab_hsm_request, NULL);
1179 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1181 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1182 lustre_swab_object_update_request, NULL);
1183 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1185 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1186 DEFINE_MSGF("object_update_reply", 0, -1,
1187 lustre_swab_object_update_reply, NULL);
1188 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1190 struct req_msg_field RMF_SWAP_LAYOUTS =
1191 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1192 lustre_swab_swap_layouts, NULL);
1193 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1195 struct req_msg_field RMF_LFSCK_REQUEST =
1196 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1197 lustre_swab_lfsck_request, NULL);
1198 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1200 struct req_msg_field RMF_LFSCK_REPLY =
1201 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1202 lustre_swab_lfsck_reply, NULL);
1203 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1205 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1206 -1, lustre_swab_out_update_header, NULL);
1207 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1209 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1210 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1211 lustre_swab_out_update_buffer, NULL);
1212 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1219 const char *rf_name;
1223 const struct req_msg_field **d;
1224 } rf_fields[RCL_NR];
1227 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1241 #define DEFINE_REQ_FMT0(name, client, server) \
1242 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1244 struct req_format RQF_OBD_PING =
1245 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1246 EXPORT_SYMBOL(RQF_OBD_PING);
1248 struct req_format RQF_OBD_SET_INFO =
1249 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1250 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1252 /* Read index file through the network */
1253 struct req_format RQF_OBD_IDX_READ =
1254 DEFINE_REQ_FMT0("OBD_IDX_READ",
1255 obd_idx_read_client, obd_idx_read_server);
1256 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1258 struct req_format RQF_SEC_CTX =
1259 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1260 EXPORT_SYMBOL(RQF_SEC_CTX);
1262 struct req_format RQF_MGS_TARGET_REG =
1263 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1264 mgs_target_info_only);
1265 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1267 struct req_format RQF_MGS_SET_INFO =
1268 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1270 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1272 struct req_format RQF_MGS_CONFIG_READ =
1273 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1274 mgs_config_read_server);
1275 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1277 struct req_format RQF_SEQ_QUERY =
1278 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1279 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1281 struct req_format RQF_FLD_QUERY =
1282 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1283 EXPORT_SYMBOL(RQF_FLD_QUERY);
1285 struct req_format RQF_FLD_READ =
1286 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1287 EXPORT_SYMBOL(RQF_FLD_READ);
1289 struct req_format RQF_LOG_CANCEL =
1290 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1291 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1293 struct req_format RQF_MDS_QUOTACTL =
1294 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1295 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1297 struct req_format RQF_OST_QUOTACTL =
1298 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1299 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1301 struct req_format RQF_QUOTA_DQACQ =
1302 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1303 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1305 struct req_format RQF_LDLM_INTENT_QUOTA =
1306 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1307 ldlm_intent_quota_client,
1308 ldlm_intent_quota_server);
1309 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1311 struct req_format RQF_MDS_GETSTATUS =
1312 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1313 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1315 struct req_format RQF_MDS_STATFS =
1316 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1317 EXPORT_SYMBOL(RQF_MDS_STATFS);
1319 struct req_format RQF_MDS_SYNC =
1320 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1321 EXPORT_SYMBOL(RQF_MDS_SYNC);
1323 struct req_format RQF_MDS_GETATTR =
1324 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1325 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1327 struct req_format RQF_MDS_GETXATTR =
1328 DEFINE_REQ_FMT0("MDS_GETXATTR",
1329 mds_getxattr_client, mds_getxattr_server);
1330 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1332 struct req_format RQF_MDS_GETATTR_NAME =
1333 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1334 mds_getattr_name_client, mds_getattr_server);
1335 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1337 struct req_format RQF_MDS_REINT =
1338 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1339 EXPORT_SYMBOL(RQF_MDS_REINT);
1341 struct req_format RQF_MDS_REINT_CREATE =
1342 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1343 mds_reint_create_client, mdt_body_capa);
1344 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1346 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1347 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1348 mds_reint_create_rmt_acl_client, mdt_body_capa);
1349 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1351 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1352 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1353 mds_reint_create_slave_client, mdt_body_capa);
1354 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1356 struct req_format RQF_MDS_REINT_CREATE_SYM =
1357 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1358 mds_reint_create_sym_client, mdt_body_capa);
1359 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1361 struct req_format RQF_MDS_REINT_OPEN =
1362 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1363 mds_reint_open_client, mds_reint_open_server);
1364 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1366 struct req_format RQF_MDS_REINT_UNLINK =
1367 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1368 mds_last_unlink_server);
1369 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1371 struct req_format RQF_MDS_REINT_LINK =
1372 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1373 mds_reint_link_client, mdt_body_only);
1374 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1376 struct req_format RQF_MDS_REINT_RENAME =
1377 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1378 mds_last_unlink_server);
1379 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1381 struct req_format RQF_MDS_REINT_MIGRATE =
1382 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1383 mds_last_unlink_server);
1384 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1386 struct req_format RQF_MDS_REINT_SETATTR =
1387 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1388 mds_reint_setattr_client, mds_setattr_server);
1389 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1391 struct req_format RQF_MDS_REINT_SETXATTR =
1392 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1393 mds_reint_setxattr_client, mdt_body_only);
1394 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1396 struct req_format RQF_MDS_CONNECT =
1397 DEFINE_REQ_FMT0("MDS_CONNECT",
1398 obd_connect_client, obd_connect_server);
1399 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1401 struct req_format RQF_MDS_DISCONNECT =
1402 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1403 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1405 struct req_format RQF_MDS_GET_INFO =
1406 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1407 mds_getinfo_server);
1408 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1410 struct req_format RQF_OUT_UPDATE =
1411 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1413 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1415 struct req_format RQF_LDLM_ENQUEUE =
1416 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1417 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1418 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1420 struct req_format RQF_LDLM_ENQUEUE_LVB =
1421 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1422 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1423 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1425 struct req_format RQF_LDLM_CONVERT =
1426 DEFINE_REQ_FMT0("LDLM_CONVERT",
1427 ldlm_enqueue_client, ldlm_enqueue_server);
1428 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1430 struct req_format RQF_LDLM_CANCEL =
1431 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1432 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1434 struct req_format RQF_LDLM_CALLBACK =
1435 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1436 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1438 struct req_format RQF_LDLM_CP_CALLBACK =
1439 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1440 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1442 struct req_format RQF_LDLM_BL_CALLBACK =
1443 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1444 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1446 struct req_format RQF_LDLM_GL_CALLBACK =
1447 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1448 ldlm_gl_callback_server);
1449 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1451 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1452 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1453 ldlm_gl_callback_server);
1454 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1456 struct req_format RQF_LDLM_INTENT_BASIC =
1457 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1458 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1459 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1461 struct req_format RQF_LDLM_INTENT =
1462 DEFINE_REQ_FMT0("LDLM_INTENT",
1463 ldlm_intent_client, ldlm_intent_server);
1464 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1466 struct req_format RQF_LDLM_INTENT_LAYOUT =
1467 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1468 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1469 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1471 struct req_format RQF_LDLM_INTENT_GETATTR =
1472 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1473 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1474 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1476 struct req_format RQF_LDLM_INTENT_OPEN =
1477 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1478 ldlm_intent_open_client, ldlm_intent_open_server);
1479 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1481 struct req_format RQF_LDLM_INTENT_CREATE =
1482 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1483 ldlm_intent_create_client, ldlm_intent_getattr_server);
1484 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1486 struct req_format RQF_LDLM_INTENT_UNLINK =
1487 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1488 ldlm_intent_unlink_client, ldlm_intent_server);
1489 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1491 struct req_format RQF_LDLM_INTENT_GETXATTR =
1492 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1493 ldlm_intent_getxattr_client,
1494 ldlm_intent_getxattr_server);
1495 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1497 struct req_format RQF_MDS_CLOSE =
1498 DEFINE_REQ_FMT0("MDS_CLOSE",
1499 mdt_close_client, mds_last_unlink_server);
1500 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1502 struct req_format RQF_MDS_INTENT_CLOSE =
1503 DEFINE_REQ_FMT0("MDS_CLOSE",
1504 mdt_intent_close_client, mds_last_unlink_server);
1505 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1507 struct req_format RQF_MDS_READPAGE =
1508 DEFINE_REQ_FMT0("MDS_READPAGE",
1509 mdt_body_capa, mdt_body_only);
1510 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1512 struct req_format RQF_MDS_HSM_ACTION =
1513 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1514 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1516 struct req_format RQF_MDS_HSM_PROGRESS =
1517 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1518 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1520 struct req_format RQF_MDS_HSM_CT_REGISTER =
1521 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1522 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1524 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1525 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1526 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1528 struct req_format RQF_MDS_HSM_STATE_GET =
1529 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1530 mdt_body_capa, mdt_hsm_state_get_server);
1531 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1533 struct req_format RQF_MDS_HSM_STATE_SET =
1534 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1535 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1537 struct req_format RQF_MDS_HSM_REQUEST =
1538 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1539 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1541 struct req_format RQF_MDS_SWAP_LAYOUTS =
1542 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1543 mdt_swap_layouts, empty);
1544 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1546 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1547 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1548 llog_origin_handle_create_client, llogd_body_only);
1549 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1551 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1552 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1553 llogd_body_only, llogd_body_only);
1554 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1556 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1557 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1558 llogd_body_only, llog_origin_handle_next_block_server);
1559 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1561 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1562 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1563 llogd_body_only, llog_origin_handle_next_block_server);
1564 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1566 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1567 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1568 llogd_body_only, llog_log_hdr_only);
1569 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1571 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1572 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1573 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1575 struct req_format RQF_CONNECT =
1576 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1577 EXPORT_SYMBOL(RQF_CONNECT);
1579 struct req_format RQF_OST_CONNECT =
1580 DEFINE_REQ_FMT0("OST_CONNECT",
1581 obd_connect_client, obd_connect_server);
1582 EXPORT_SYMBOL(RQF_OST_CONNECT);
1584 struct req_format RQF_OST_DISCONNECT =
1585 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1586 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1588 struct req_format RQF_OST_GETATTR =
1589 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1590 EXPORT_SYMBOL(RQF_OST_GETATTR);
1592 struct req_format RQF_OST_SETATTR =
1593 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1594 EXPORT_SYMBOL(RQF_OST_SETATTR);
1596 struct req_format RQF_OST_CREATE =
1597 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1598 EXPORT_SYMBOL(RQF_OST_CREATE);
1600 struct req_format RQF_OST_PUNCH =
1601 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1602 EXPORT_SYMBOL(RQF_OST_PUNCH);
1604 struct req_format RQF_OST_SYNC =
1605 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1606 EXPORT_SYMBOL(RQF_OST_SYNC);
1608 struct req_format RQF_OST_DESTROY =
1609 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1610 EXPORT_SYMBOL(RQF_OST_DESTROY);
1612 struct req_format RQF_OST_BRW_READ =
1613 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1614 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1616 struct req_format RQF_OST_BRW_WRITE =
1617 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1618 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1620 struct req_format RQF_OST_STATFS =
1621 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1622 EXPORT_SYMBOL(RQF_OST_STATFS);
1624 struct req_format RQF_OST_SET_GRANT_INFO =
1625 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1627 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1629 struct req_format RQF_OST_GET_INFO =
1630 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1631 ost_get_info_generic_server);
1632 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1634 struct req_format RQF_OST_GET_INFO_LAST_ID =
1635 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1636 ost_get_last_id_server);
1637 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1639 struct req_format RQF_OST_GET_INFO_LAST_FID =
1640 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1641 ost_get_last_fid_server);
1642 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1644 struct req_format RQF_OST_SET_INFO_LAST_FID =
1645 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1647 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1649 struct req_format RQF_OST_GET_INFO_FIEMAP =
1650 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1651 ost_get_fiemap_server);
1652 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1654 struct req_format RQF_LFSCK_NOTIFY =
1655 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1656 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1658 struct req_format RQF_LFSCK_QUERY =
1659 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1660 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1662 #if !defined(__REQ_LAYOUT_USER__)
1664 /* Convenience macro */
1665 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1668 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1669 * field of RQFs and the \a rmf_offset field of RMFs.
1671 int req_layout_init(void)
1676 struct req_format *rf = NULL;
1678 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1679 rf = req_formats[i];
1681 for (j = 0; j < RCL_NR; ++j) {
1682 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1683 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1684 struct req_msg_field *field;
1686 field = (typeof(field))rf->rf_fields[j].d[k];
1687 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1688 || field->rmf_size > 0);
1689 LASSERT(field->rmf_offset[i][j] == 0);
1691 * k + 1 to detect unused format/field
1694 field->rmf_offset[i][j] = k + 1;
1700 EXPORT_SYMBOL(req_layout_init);
1702 void req_layout_fini(void)
1705 EXPORT_SYMBOL(req_layout_fini);
1708 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1710 * Actual/expected field sizes are set elsewhere in functions in this file:
1711 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1712 * req_capsule_msg_size(). The \a rc_area information is used by.
1713 * ptlrpc_request_set_replen().
1715 void req_capsule_init_area(struct req_capsule *pill)
1719 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1720 pill->rc_area[RCL_CLIENT][i] = -1;
1721 pill->rc_area[RCL_SERVER][i] = -1;
1724 EXPORT_SYMBOL(req_capsule_init_area);
1727 * Initialize a pill.
1729 * The \a location indicates whether the caller is executing on the client side
1730 * (RCL_CLIENT) or server side (RCL_SERVER)..
1732 void req_capsule_init(struct req_capsule *pill,
1733 struct ptlrpc_request *req,
1734 enum req_location location)
1736 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1739 * Today all capsules are embedded in ptlrpc_request structs,
1740 * but just in case that ever isn't the case, we don't reach
1741 * into req unless req != NULL and pill is the one embedded in
1744 * The req->rq_pill_init flag makes it safe to initialize a pill
1745 * twice, which might happen in the OST paths as a result of the
1746 * high-priority RPC queue getting peeked at before ost_handle()
1747 * handles an OST RPC.
1749 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1752 memset(pill, 0, sizeof *pill);
1754 pill->rc_loc = location;
1755 req_capsule_init_area(pill);
1757 if (req != NULL && pill == &req->rq_pill)
1758 req->rq_pill_init = 1;
1760 EXPORT_SYMBOL(req_capsule_init);
1762 void req_capsule_fini(struct req_capsule *pill)
1765 EXPORT_SYMBOL(req_capsule_fini);
1767 static int __req_format_is_sane(const struct req_format *fmt)
1769 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1770 req_formats[fmt->rf_idx] == fmt;
1773 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1774 enum req_location loc)
1776 struct ptlrpc_request *req;
1779 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1783 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1784 * (see req_capsule_extend()).
1786 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1788 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1789 LASSERT(__req_format_is_sane(fmt));
1793 EXPORT_SYMBOL(req_capsule_set);
1796 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1799 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1800 * variable-sized fields. The field sizes come from the declared \a rmf_size
1801 * field of a \a pill's \a rc_fmt's RMF's.
1803 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1804 enum req_location loc)
1806 const struct req_format *fmt = pill->rc_fmt;
1809 LASSERT(fmt != NULL);
1811 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1812 if (pill->rc_area[loc][i] == -1) {
1813 pill->rc_area[loc][i] =
1814 fmt->rf_fields[loc].d[i]->rmf_size;
1815 if (pill->rc_area[loc][i] == -1) {
1817 * Skip the following fields.
1819 * If this LASSERT() trips then you're missing a
1820 * call to req_capsule_set_size().
1822 LASSERT(loc != RCL_SERVER);
1829 EXPORT_SYMBOL(req_capsule_filled_sizes);
1832 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1834 * This function uses the \a pill's \a rc_area as filled in by
1835 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1838 int req_capsule_server_pack(struct req_capsule *pill)
1840 const struct req_format *fmt;
1844 LASSERT(pill->rc_loc == RCL_SERVER);
1846 LASSERT(fmt != NULL);
1848 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1849 rc = lustre_pack_reply(pill->rc_req, count,
1850 pill->rc_area[RCL_SERVER], NULL);
1852 DEBUG_REQ(D_ERROR, pill->rc_req,
1853 "Cannot pack %d fields in format `%s': ",
1854 count, fmt->rf_name);
1858 EXPORT_SYMBOL(req_capsule_server_pack);
1861 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1862 * corresponding to the given RMF (\a field).
1864 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1865 const struct req_msg_field *field,
1866 enum req_location loc)
1870 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1871 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1872 pill->rc_fmt->rf_name,
1873 field->rmf_name, offset, loc);
1876 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1881 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1886 swabber_dumper_helper(struct req_capsule *pill,
1887 const struct req_msg_field *field,
1888 enum req_location loc,
1890 void *value, int len, int dump, void (*swabber)( void *))
1896 int inout = loc == RCL_CLIENT;
1898 swabber = swabber ?: field->rmf_swabber;
1900 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1901 swabber != NULL && value != NULL)
1906 if (!field->rmf_dumper)
1909 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1911 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1912 do_swab ? "unswabbed " : "", field->rmf_name);
1913 field->rmf_dumper(value);
1918 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1920 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1921 "follows\n", field->rmf_name);
1922 field->rmf_dumper(value);
1929 * We're swabbing an array; swabber() swabs a single array element, so
1930 * swab every element.
1932 LASSERT((len % field->rmf_size) == 0);
1933 for (p = value, i = 0, n = len / field->rmf_size;
1935 i++, p += field->rmf_size) {
1937 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1938 "element %d follows\n",
1939 do_swab ? "unswabbed " : "", field->rmf_name, i);
1940 field->rmf_dumper(p);
1946 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1947 "element %d follows\n", field->rmf_name, i);
1948 field->rmf_dumper(value);
1952 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1956 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1957 * corresponding to the given RMF (\a field).
1959 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1960 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1961 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1962 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1963 * element of the array swabbed.
1965 static void *__req_capsule_get(struct req_capsule *pill,
1966 const struct req_msg_field *field,
1967 enum req_location loc,
1968 void (*swabber)( void *),
1971 const struct req_format *fmt;
1972 struct lustre_msg *msg;
1977 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
1979 static const char *rcl_names[RCL_NR] = {
1980 [RCL_CLIENT] = "client",
1981 [RCL_SERVER] = "server"
1984 LASSERT(pill != NULL);
1985 LASSERT(pill != LP_POISON);
1987 LASSERT(fmt != NULL);
1988 LASSERT(fmt != LP_POISON);
1989 LASSERT(__req_format_is_sane(fmt));
1991 offset = __req_capsule_offset(pill, field, loc);
1993 msg = __req_msg(pill, loc);
1994 LASSERT(msg != NULL);
1996 getter = (field->rmf_flags & RMF_F_STRING) ?
1997 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1999 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2001 * We've already asserted that field->rmf_size > 0 in
2002 * req_layout_init().
2004 len = lustre_msg_buflen(msg, offset);
2005 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2006 (len % field->rmf_size) != 0) {
2007 CERROR("%s: array field size mismatch "
2008 "%d modulo %u != 0 (%d)\n",
2009 field->rmf_name, len, field->rmf_size, loc);
2012 } else if (pill->rc_area[loc][offset] != -1) {
2013 len = pill->rc_area[loc][offset];
2015 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2017 value = getter(msg, offset, len);
2019 if (value == NULL) {
2020 DEBUG_REQ(D_ERROR, pill->rc_req,
2021 "Wrong buffer for field `%s' (%u of %u) "
2022 "in format `%s': %u vs. %u (%s)\n",
2023 field->rmf_name, offset, lustre_msg_bufcount(msg),
2024 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2027 swabber_dumper_helper(pill, field, loc, offset, value, len,
2035 * Dump a request and/or reply
2037 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2039 const struct req_format *fmt;
2040 const struct req_msg_field *field;
2046 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2047 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2048 field = FMT_FIELD(fmt, loc, i);
2049 if (field->rmf_dumper == NULL) {
2051 * FIXME Add a default hex dumper for fields that don't
2052 * have a specific dumper
2054 len = req_capsule_get_size(pill, field, loc);
2055 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2056 "field size is %u\n", field->rmf_name, len);
2058 /* It's the dumping side-effect that we're interested in */
2059 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2062 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2068 void req_capsule_client_dump(struct req_capsule *pill)
2070 __req_capsule_dump(pill, RCL_CLIENT);
2072 EXPORT_SYMBOL(req_capsule_client_dump);
2077 void req_capsule_server_dump(struct req_capsule *pill)
2079 __req_capsule_dump(pill, RCL_SERVER);
2081 EXPORT_SYMBOL(req_capsule_server_dump);
2084 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2085 * buffer corresponding to the given RMF (\a field) of a \a pill.
2087 void *req_capsule_client_get(struct req_capsule *pill,
2088 const struct req_msg_field *field)
2090 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2092 EXPORT_SYMBOL(req_capsule_client_get);
2095 * Same as req_capsule_client_get(), but with a \a swabber argument.
2097 * Currently unused; will be removed when req_capsule_server_swab_get() is
2100 void *req_capsule_client_swab_get(struct req_capsule *pill,
2101 const struct req_msg_field *field,
2104 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2106 EXPORT_SYMBOL(req_capsule_client_swab_get);
2109 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2111 * First the \a pill's request \a field's size is set (\a rc_area) using
2112 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2115 void *req_capsule_client_sized_get(struct req_capsule *pill,
2116 const struct req_msg_field *field,
2119 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2120 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2122 EXPORT_SYMBOL(req_capsule_client_sized_get);
2125 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2126 * buffer corresponding to the given RMF (\a field) of a \a pill.
2128 void *req_capsule_server_get(struct req_capsule *pill,
2129 const struct req_msg_field *field)
2131 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2133 EXPORT_SYMBOL(req_capsule_server_get);
2136 * Same as req_capsule_server_get(), but with a \a swabber argument.
2138 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2139 * swabbing done outside this capsule abstraction.
2141 void *req_capsule_server_swab_get(struct req_capsule *pill,
2142 const struct req_msg_field *field,
2145 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2147 EXPORT_SYMBOL(req_capsule_server_swab_get);
2150 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2152 * First the \a pill's request \a field's size is set (\a rc_area) using
2153 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2156 void *req_capsule_server_sized_get(struct req_capsule *pill,
2157 const struct req_msg_field *field,
2160 req_capsule_set_size(pill, field, RCL_SERVER, len);
2161 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2163 EXPORT_SYMBOL(req_capsule_server_sized_get);
2165 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2166 const struct req_msg_field *field,
2167 __u32 len, void *swabber)
2169 req_capsule_set_size(pill, field, RCL_SERVER, len);
2170 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2172 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2175 * Returns the buffer of a \a pill corresponding to the given \a field from the
2176 * request (if the caller is executing on the server-side) or reply (if the
2177 * caller is executing on the client-side).
2179 * This function convienient for use is code that could be executed on the
2180 * client and server alike.
2182 const void *req_capsule_other_get(struct req_capsule *pill,
2183 const struct req_msg_field *field)
2185 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2187 EXPORT_SYMBOL(req_capsule_other_get);
2190 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2191 * field of the given \a pill.
2193 * This function must be used when constructing variable sized fields of a
2196 void req_capsule_set_size(struct req_capsule *pill,
2197 const struct req_msg_field *field,
2198 enum req_location loc, __u32 size)
2200 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2202 if ((size != (__u32)field->rmf_size) &&
2203 (field->rmf_size != -1) &&
2204 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2206 __u32 rmf_size = (__u32)field->rmf_size;
2207 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2208 (size % rmf_size != 0)) {
2209 CERROR("%s: array field size mismatch "
2210 "%u %% %u != 0 (%d)\n",
2211 field->rmf_name, size, rmf_size, loc);
2213 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2215 CERROR("%s: field size mismatch %u != %u (%d)\n",
2216 field->rmf_name, size, rmf_size, loc);
2221 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2223 EXPORT_SYMBOL(req_capsule_set_size);
2226 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2227 * for the given \a pill's given \a field.
2229 * NB: this function doesn't correspond with req_capsule_set_size(), which
2230 * actually sets the size in pill.rc_area[loc][offset], but this function
2231 * returns the message buflen[offset], maybe we should use another name.
2233 __u32 req_capsule_get_size(const struct req_capsule *pill,
2234 const struct req_msg_field *field,
2235 enum req_location loc)
2237 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2239 return lustre_msg_buflen(__req_msg(pill, loc),
2240 __req_capsule_offset(pill, field, loc));
2242 EXPORT_SYMBOL(req_capsule_get_size);
2245 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2246 * given \a pill's request or reply (\a loc) given the field size recorded in
2247 * the \a pill's rc_area.
2249 * See also req_capsule_set_size().
2251 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2253 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2254 pill->rc_fmt->rf_fields[loc].nr,
2255 pill->rc_area[loc]);
2259 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2260 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2261 * PTLRPC request or reply given only an RQF (\a fmt).
2263 * This function should not be used for formats which contain variable size
2266 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2267 enum req_location loc)
2273 * This function should probably LASSERT() that fmt has no fields with
2274 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2275 * elements in the array there will ultimately be, but then, we could
2276 * assume that there will be at least one element, and that's just what
2279 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2283 for (; i < fmt->rf_fields[loc].nr; ++i)
2284 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2285 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2291 * Changes the format of an RPC.
2293 * The pill must already have been initialized, which means that it already has
2294 * a request format. The new format \a fmt must be an extension of the pill's
2295 * old format. Specifically: the new format must have as many request and reply
2296 * fields as the old one, and all fields shared by the old and new format must
2297 * be at least as large in the new format.
2299 * The new format's fields may be of different "type" than the old format, but
2300 * only for fields that are "opaque" blobs: fields which have a) have no
2301 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2302 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2303 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2304 * according to the key field. When the value, according to the key, contains a
2305 * structure (or array thereof) to be swabbed, the format should be changed to
2306 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2309 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2314 const struct req_format *old;
2316 LASSERT(pill->rc_fmt != NULL);
2317 LASSERT(__req_format_is_sane(fmt));
2321 * Sanity checking...
2323 for (i = 0; i < RCL_NR; ++i) {
2324 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2325 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2326 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2328 /* "opaque" fields can be transmogrified */
2329 if (ofield->rmf_swabber == NULL &&
2330 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2331 (ofield->rmf_size == -1 ||
2332 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2334 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2337 * Last field in old format can be shorter than in new.
2339 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2340 FMT_FIELD(old, i, j)->rmf_size);
2345 EXPORT_SYMBOL(req_capsule_extend);
2348 * This function returns a non-zero value if the given \a field is present in
2349 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2352 int req_capsule_has_field(const struct req_capsule *pill,
2353 const struct req_msg_field *field,
2354 enum req_location loc)
2356 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2358 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2360 EXPORT_SYMBOL(req_capsule_has_field);
2363 * Returns a non-zero value if the given \a field is present in the given \a
2364 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2366 int req_capsule_field_present(const struct req_capsule *pill,
2367 const struct req_msg_field *field,
2368 enum req_location loc)
2372 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2373 LASSERT(req_capsule_has_field(pill, field, loc));
2375 offset = __req_capsule_offset(pill, field, loc);
2376 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2378 EXPORT_SYMBOL(req_capsule_field_present);
2381 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2382 * request or reply (\a loc).
2384 * This is not the opposite of req_capsule_extend().
2386 void req_capsule_shrink(struct req_capsule *pill,
2387 const struct req_msg_field *field,
2389 enum req_location loc)
2391 const struct req_format *fmt;
2392 struct lustre_msg *msg;
2397 LASSERT(fmt != NULL);
2398 LASSERT(__req_format_is_sane(fmt));
2399 LASSERT(req_capsule_has_field(pill, field, loc));
2400 LASSERT(req_capsule_field_present(pill, field, loc));
2402 offset = __req_capsule_offset(pill, field, loc);
2404 msg = __req_msg(pill, loc);
2405 len = lustre_msg_buflen(msg, offset);
2406 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2407 fmt->rf_name, field->rmf_name, len, newlen);
2409 if (loc == RCL_CLIENT)
2410 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2413 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2416 EXPORT_SYMBOL(req_capsule_shrink);
2418 int req_capsule_server_grow(struct req_capsule *pill,
2419 const struct req_msg_field *field,
2422 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2427 LASSERT(pill->rc_fmt != NULL);
2428 LASSERT(__req_format_is_sane(pill->rc_fmt));
2429 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2430 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2432 len = req_capsule_get_size(pill, field, RCL_SERVER);
2433 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2434 if ((__u32)pill->rc_req->rq_repbuf_len >=
2435 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2436 CERROR("Inplace repack might be done\n");
2438 pill->rc_req->rq_reply_state = NULL;
2439 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2440 rc = req_capsule_server_pack(pill);
2442 /* put old rs back, the caller will decide what to do */
2443 pill->rc_req->rq_reply_state = rs;
2446 nrs = pill->rc_req->rq_reply_state;
2447 /* Now we need only buffers, copy first chunk */
2448 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2449 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2450 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2451 memcpy(to, from, len);
2452 /* check if we have tail and copy it too */
2453 if (rs->rs_msg->lm_bufcount > offset + 1) {
2454 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2455 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2456 offset = rs->rs_msg->lm_bufcount - 1;
2457 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2458 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2459 memcpy(to, from, len);
2461 /* drop old reply if everything is fine */
2462 if (rs->rs_difficult) {
2466 nrs->rs_difficult = 1;
2467 nrs->rs_no_ack = rs->rs_no_ack;
2468 for (i = 0; i < rs->rs_nlocks; i++) {
2469 nrs->rs_locks[i] = rs->rs_locks[i];
2470 nrs->rs_modes[i] = rs->rs_modes[i];
2474 rs->rs_difficult = 0;
2477 ptlrpc_rs_decref(rs);
2480 EXPORT_SYMBOL(req_capsule_server_grow);
2481 /* __REQ_LAYOUT_USER__ */