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 /* LUSTRE_VERSION_CODE */
56 #include <lustre_ver.h>
58 #include <obd_support.h>
59 /* lustre_swab_mdt_body */
60 #include <lustre/lustre_idl.h>
61 /* obd2cli_tgt() (required by DEBUG_REQ()) */
63 #include <lustre_debug.h>
64 #endif /* !__REQ_LAYOUT_USER__ */
66 /* struct ptlrpc_request, lustre_msg* */
67 #include <lustre_req_layout.h>
68 #include <lustre_acl.h>
71 * RQFs (see below) refer to two struct req_msg_field arrays describing the
72 * client request and server reply, respectively.
74 /* empty set of fields... for suitable definition of emptiness. */
75 static const struct req_msg_field *empty[] = {
79 static const struct req_msg_field *mgs_target_info_only[] = {
84 static const struct req_msg_field *mgs_set_info[] = {
89 static const struct req_msg_field *mgs_config_read_client[] = {
94 static const struct req_msg_field *mgs_config_read_server[] = {
99 static const struct req_msg_field *log_cancel_client[] = {
104 static const struct req_msg_field *mdt_body_only[] = {
109 static const struct req_msg_field *mdt_body_capa[] = {
115 static const struct req_msg_field *quotactl_only[] = {
120 static const struct req_msg_field *quota_body_only[] = {
125 static const struct req_msg_field *ldlm_intent_quota_client[] = {
132 static const struct req_msg_field *ldlm_intent_quota_server[] = {
139 static const struct req_msg_field *mdt_close_client[] = {
146 static const struct req_msg_field *mdt_intent_close_client[] = {
154 static const struct req_msg_field *obd_statfs_server[] = {
159 static const struct req_msg_field *seq_query_client[] = {
165 static const struct req_msg_field *seq_query_server[] = {
170 static const struct req_msg_field *fld_query_client[] = {
176 static const struct req_msg_field *fld_query_server[] = {
181 static const struct req_msg_field *fld_read_client[] = {
186 static const struct req_msg_field *fld_read_server[] = {
191 static const struct req_msg_field *mds_getattr_name_client[] = {
198 static const struct req_msg_field *mds_reint_client[] = {
203 static const struct req_msg_field *mds_reint_create_client[] = {
210 static const struct req_msg_field *mds_reint_create_slave_client[] = {
219 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
228 static const struct req_msg_field *mds_reint_create_sym_client[] = {
237 static const struct req_msg_field *mds_reint_open_client[] = {
246 static const struct req_msg_field *mds_reint_open_server[] = {
255 static const struct req_msg_field *mds_reint_unlink_client[] = {
263 static const struct req_msg_field *mds_reint_link_client[] = {
272 static const struct req_msg_field *mds_reint_rename_client[] = {
282 static const struct req_msg_field *mds_reint_migrate_client[] = {
294 static const struct req_msg_field *mds_last_unlink_server[] = {
303 static const struct req_msg_field *mds_reint_setattr_client[] = {
313 static const struct req_msg_field *mds_reint_setxattr_client[] = {
322 static const struct req_msg_field *mdt_swap_layouts[] = {
331 static const struct req_msg_field *obd_connect_client[] = {
339 static const struct req_msg_field *obd_connect_server[] = {
344 static const struct req_msg_field *obd_set_info_client[] = {
350 static const struct req_msg_field *ost_grant_shrink_client[] = {
356 static const struct req_msg_field *mds_getinfo_client[] = {
362 static const struct req_msg_field *mds_getinfo_server[] = {
367 static const struct req_msg_field *ldlm_enqueue_client[] = {
372 static const struct req_msg_field *ldlm_enqueue_server[] = {
377 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
383 static const struct req_msg_field *ldlm_cp_callback_client[] = {
389 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
395 static const struct req_msg_field *ldlm_gl_callback_server[] = {
400 static const struct req_msg_field *ldlm_intent_basic_client[] = {
406 static const struct req_msg_field *ldlm_intent_client[] = {
413 static const struct req_msg_field *ldlm_intent_server[] = {
421 static const struct req_msg_field *ldlm_intent_layout_client[] = {
426 &RMF_EADATA /* for new layout to be set up */
428 static const struct req_msg_field *ldlm_intent_open_server[] = {
438 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
442 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
447 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
456 static const struct req_msg_field *ldlm_intent_create_client[] = {
460 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
466 static const struct req_msg_field *ldlm_intent_open_client[] = {
470 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
477 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
481 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
486 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
494 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
499 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
505 static const struct req_msg_field *mds_getxattr_client[] = {
513 static const struct req_msg_field *mds_getxattr_server[] = {
519 static const struct req_msg_field *mds_getattr_server[] = {
528 static const struct req_msg_field *mds_setattr_server[] = {
537 static const struct req_msg_field *mds_update_client[] = {
539 &RMF_OUT_UPDATE_HEADER,
543 static const struct req_msg_field *mds_update_server[] = {
545 &RMF_OUT_UPDATE_REPLY,
548 static const struct req_msg_field *llog_origin_handle_create_client[] = {
554 static const struct req_msg_field *llogd_body_only[] = {
559 static const struct req_msg_field *llog_log_hdr_only[] = {
564 static const struct req_msg_field *llogd_conn_body_only[] = {
569 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
575 static const struct req_msg_field *obd_idx_read_client[] = {
580 static const struct req_msg_field *obd_idx_read_server[] = {
585 static const struct req_msg_field *ost_body_only[] = {
590 static const struct req_msg_field *ost_body_capa[] = {
596 static const struct req_msg_field *ost_destroy_client[] = {
604 static const struct req_msg_field *ost_brw_client[] = {
612 static const struct req_msg_field *ost_brw_read_server[] = {
617 static const struct req_msg_field *ost_brw_write_server[] = {
623 static const struct req_msg_field *ost_get_info_generic_server[] = {
628 static const struct req_msg_field *ost_get_info_generic_client[] = {
633 static const struct req_msg_field *ost_get_last_id_server[] = {
638 static const struct req_msg_field *ost_get_last_fid_client[] = {
644 static const struct req_msg_field *ost_get_last_fid_server[] = {
649 static const struct req_msg_field *ost_get_fiemap_client[] = {
655 static const struct req_msg_field *ost_get_fiemap_server[] = {
660 static const struct req_msg_field *mdt_hsm_progress[] = {
663 &RMF_MDS_HSM_PROGRESS,
666 static const struct req_msg_field *mdt_hsm_ct_register[] = {
669 &RMF_MDS_HSM_ARCHIVE,
672 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
677 static const struct req_msg_field *mdt_hsm_action_server[] = {
680 &RMF_MDS_HSM_CURRENT_ACTION,
683 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
689 static const struct req_msg_field *mdt_hsm_state_set[] = {
696 static const struct req_msg_field *mdt_hsm_request[] = {
699 &RMF_MDS_HSM_REQUEST,
700 &RMF_MDS_HSM_USER_ITEM,
704 static const struct req_msg_field *obd_lfsck_request[] = {
709 static const struct req_msg_field *obd_lfsck_reply[] = {
714 static struct req_format *req_formats[] = {
721 &RQF_MGS_CONFIG_READ,
731 &RQF_MDS_GETATTR_NAME,
735 &RQF_MDS_INTENT_CLOSE,
738 &RQF_MDS_REINT_CREATE,
739 &RQF_MDS_REINT_CREATE_RMT_ACL,
740 &RQF_MDS_REINT_CREATE_SLAVE,
741 &RQF_MDS_REINT_CREATE_SYM,
743 &RQF_MDS_REINT_UNLINK,
745 &RQF_MDS_REINT_RENAME,
746 &RQF_MDS_REINT_MIGRATE,
747 &RQF_MDS_REINT_SETATTR,
748 &RQF_MDS_REINT_SETXATTR,
750 &RQF_MDS_HSM_PROGRESS,
751 &RQF_MDS_HSM_CT_REGISTER,
752 &RQF_MDS_HSM_CT_UNREGISTER,
753 &RQF_MDS_HSM_STATE_GET,
754 &RQF_MDS_HSM_STATE_SET,
756 &RQF_MDS_HSM_REQUEST,
757 &RQF_MDS_SWAP_LAYOUTS,
771 &RQF_OST_SET_GRANT_INFO,
773 &RQF_OST_GET_INFO_LAST_ID,
774 &RQF_OST_GET_INFO_LAST_FID,
775 &RQF_OST_SET_INFO_LAST_FID,
776 &RQF_OST_GET_INFO_FIEMAP,
778 &RQF_LDLM_ENQUEUE_LVB,
782 &RQF_LDLM_CP_CALLBACK,
783 &RQF_LDLM_BL_CALLBACK,
784 &RQF_LDLM_GL_CALLBACK,
785 &RQF_LDLM_GL_DESC_CALLBACK,
787 &RQF_LDLM_INTENT_BASIC,
788 &RQF_LDLM_INTENT_LAYOUT,
789 &RQF_LDLM_INTENT_GETATTR,
790 &RQF_LDLM_INTENT_OPEN,
791 &RQF_LDLM_INTENT_CREATE,
792 &RQF_LDLM_INTENT_UNLINK,
793 &RQF_LDLM_INTENT_GETXATTR,
794 &RQF_LDLM_INTENT_QUOTA,
797 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
798 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
799 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
800 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
801 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
802 &RQF_LLOG_ORIGIN_CONNECT,
808 struct req_msg_field {
809 const __u32 rmf_flags;
810 const char *rmf_name;
812 * Field length. (-1) means "variable length". If the
813 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
814 * but the actual size must be a whole multiple of \a rmf_size.
817 void (*rmf_swabber)(void *);
818 void (*rmf_dumper)(void *);
819 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
824 * The field is a string, must be NUL-terminated.
826 RMF_F_STRING = 1 << 0,
828 * The field's buffer size need not match the declared \a rmf_size.
830 RMF_F_NO_SIZE_CHECK = 1 << 1,
832 * The field's buffer size must be a whole multiple of the declared \a
833 * rmf_size and the \a rmf_swabber function must work on the declared \a
834 * rmf_size worth of bytes.
836 RMF_F_STRUCT_ARRAY = 1 << 2
844 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
845 .rmf_name = (name), \
846 .rmf_flags = (flags), \
847 .rmf_size = (size), \
848 .rmf_swabber = (void (*)(void*))(swabber), \
849 .rmf_dumper = (void (*)(void*))(dumper) \
852 struct req_msg_field RMF_GENERIC_DATA =
853 DEFINE_MSGF("generic_data", 0,
855 EXPORT_SYMBOL(RMF_GENERIC_DATA);
857 struct req_msg_field RMF_MGS_TARGET_INFO =
858 DEFINE_MSGF("mgs_target_info", 0,
859 sizeof(struct mgs_target_info),
860 lustre_swab_mgs_target_info, NULL);
861 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
863 struct req_msg_field RMF_MGS_SEND_PARAM =
864 DEFINE_MSGF("mgs_send_param", 0,
865 sizeof(struct mgs_send_param),
867 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
869 struct req_msg_field RMF_MGS_CONFIG_BODY =
870 DEFINE_MSGF("mgs_config_read request", 0,
871 sizeof(struct mgs_config_body),
872 lustre_swab_mgs_config_body, NULL);
873 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
875 struct req_msg_field RMF_MGS_CONFIG_RES =
876 DEFINE_MSGF("mgs_config_read reply ", 0,
877 sizeof(struct mgs_config_res),
878 lustre_swab_mgs_config_res, NULL);
879 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
881 struct req_msg_field RMF_U32 =
882 DEFINE_MSGF("generic u32", 0,
883 sizeof(__u32), lustre_swab_generic_32s, NULL);
884 EXPORT_SYMBOL(RMF_U32);
886 struct req_msg_field RMF_SETINFO_VAL =
887 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
888 EXPORT_SYMBOL(RMF_SETINFO_VAL);
890 struct req_msg_field RMF_GETINFO_KEY =
891 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
892 EXPORT_SYMBOL(RMF_GETINFO_KEY);
894 struct req_msg_field RMF_GETINFO_VALLEN =
895 DEFINE_MSGF("getinfo_vallen", 0,
896 sizeof(__u32), lustre_swab_generic_32s, NULL);
897 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
899 struct req_msg_field RMF_GETINFO_VAL =
900 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
901 EXPORT_SYMBOL(RMF_GETINFO_VAL);
903 struct req_msg_field RMF_SEQ_OPC =
904 DEFINE_MSGF("seq_query_opc", 0,
905 sizeof(__u32), lustre_swab_generic_32s, NULL);
906 EXPORT_SYMBOL(RMF_SEQ_OPC);
908 struct req_msg_field RMF_SEQ_RANGE =
909 DEFINE_MSGF("seq_query_range", 0,
910 sizeof(struct lu_seq_range),
911 lustre_swab_lu_seq_range, NULL);
912 EXPORT_SYMBOL(RMF_SEQ_RANGE);
914 struct req_msg_field RMF_FLD_OPC =
915 DEFINE_MSGF("fld_query_opc", 0,
916 sizeof(__u32), lustre_swab_generic_32s, NULL);
917 EXPORT_SYMBOL(RMF_FLD_OPC);
919 struct req_msg_field RMF_FLD_MDFLD =
920 DEFINE_MSGF("fld_query_mdfld", 0,
921 sizeof(struct lu_seq_range),
922 lustre_swab_lu_seq_range, NULL);
923 EXPORT_SYMBOL(RMF_FLD_MDFLD);
925 struct req_msg_field RMF_MDT_BODY =
926 DEFINE_MSGF("mdt_body", 0,
927 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
928 EXPORT_SYMBOL(RMF_MDT_BODY);
930 struct req_msg_field RMF_OBD_QUOTACTL =
931 DEFINE_MSGF("obd_quotactl", 0,
932 sizeof(struct obd_quotactl),
933 lustre_swab_obd_quotactl, NULL);
934 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
936 struct req_msg_field RMF_QUOTA_BODY =
937 DEFINE_MSGF("quota_body", 0,
938 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
939 EXPORT_SYMBOL(RMF_QUOTA_BODY);
941 struct req_msg_field RMF_MDT_EPOCH =
942 DEFINE_MSGF("mdt_ioepoch", 0,
943 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
944 EXPORT_SYMBOL(RMF_MDT_EPOCH);
946 struct req_msg_field RMF_PTLRPC_BODY =
947 DEFINE_MSGF("ptlrpc_body", 0,
948 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
949 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
951 struct req_msg_field RMF_CLOSE_DATA =
952 DEFINE_MSGF("data_version", 0,
953 sizeof(struct close_data), lustre_swab_close_data, NULL);
954 EXPORT_SYMBOL(RMF_CLOSE_DATA);
956 struct req_msg_field RMF_OBD_STATFS =
957 DEFINE_MSGF("obd_statfs", 0,
958 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
959 EXPORT_SYMBOL(RMF_OBD_STATFS);
961 struct req_msg_field RMF_SETINFO_KEY =
962 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
963 EXPORT_SYMBOL(RMF_SETINFO_KEY);
965 struct req_msg_field RMF_NAME =
966 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_NAME);
969 struct req_msg_field RMF_SYMTGT =
970 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
971 EXPORT_SYMBOL(RMF_SYMTGT);
973 struct req_msg_field RMF_TGTUUID =
974 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
976 EXPORT_SYMBOL(RMF_TGTUUID);
978 struct req_msg_field RMF_CLUUID =
979 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
981 EXPORT_SYMBOL(RMF_CLUUID);
983 struct req_msg_field RMF_STRING =
984 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
985 EXPORT_SYMBOL(RMF_STRING);
987 struct req_msg_field RMF_LLOGD_BODY =
988 DEFINE_MSGF("llogd_body", 0,
989 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
990 EXPORT_SYMBOL(RMF_LLOGD_BODY);
992 struct req_msg_field RMF_LLOG_LOG_HDR =
993 DEFINE_MSGF("llog_log_hdr", 0,
994 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
995 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
997 struct req_msg_field RMF_LLOGD_CONN_BODY =
998 DEFINE_MSGF("llogd_conn_body", 0,
999 sizeof(struct llogd_conn_body),
1000 lustre_swab_llogd_conn_body, NULL);
1001 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1004 * connection handle received in MDS_CONNECT request.
1006 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1007 * that the client does not interpret at all.
1009 struct req_msg_field RMF_CONN =
1010 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1011 EXPORT_SYMBOL(RMF_CONN);
1013 struct req_msg_field RMF_CONNECT_DATA =
1014 DEFINE_MSGF("cdata",
1015 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1016 sizeof(struct obd_connect_data),
1017 lustre_swab_connect, NULL);
1018 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1020 struct req_msg_field RMF_DLM_REQ =
1021 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1022 sizeof(struct ldlm_request),
1023 lustre_swab_ldlm_request, NULL);
1024 EXPORT_SYMBOL(RMF_DLM_REQ);
1026 struct req_msg_field RMF_DLM_REP =
1027 DEFINE_MSGF("dlm_rep", 0,
1028 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1029 EXPORT_SYMBOL(RMF_DLM_REP);
1031 struct req_msg_field RMF_LDLM_INTENT =
1032 DEFINE_MSGF("ldlm_intent", 0,
1033 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1034 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1036 struct req_msg_field RMF_DLM_LVB =
1037 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1038 EXPORT_SYMBOL(RMF_DLM_LVB);
1040 struct req_msg_field RMF_DLM_GL_DESC =
1041 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1042 lustre_swab_gl_desc, NULL);
1043 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1045 struct req_msg_field RMF_MDT_MD =
1046 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1047 EXPORT_SYMBOL(RMF_MDT_MD);
1049 struct req_msg_field RMF_REC_REINT =
1050 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1051 lustre_swab_mdt_rec_reint, NULL);
1052 EXPORT_SYMBOL(RMF_REC_REINT);
1054 /* FIXME: this length should be defined as a macro */
1055 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1057 EXPORT_SYMBOL(RMF_EADATA);
1059 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1060 EXPORT_SYMBOL(RMF_EAVALS);
1062 struct req_msg_field RMF_ACL =
1063 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1064 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1065 EXPORT_SYMBOL(RMF_ACL);
1067 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1068 struct req_msg_field RMF_LOGCOOKIES =
1069 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1070 sizeof(struct llog_cookie), NULL, NULL);
1071 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1073 struct req_msg_field RMF_CAPA1 =
1074 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1075 lustre_swab_lustre_capa, NULL);
1076 EXPORT_SYMBOL(RMF_CAPA1);
1078 struct req_msg_field RMF_CAPA2 =
1079 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1080 lustre_swab_lustre_capa, NULL);
1081 EXPORT_SYMBOL(RMF_CAPA2);
1083 struct req_msg_field RMF_LAYOUT_INTENT =
1084 DEFINE_MSGF("layout_intent", 0,
1085 sizeof(struct layout_intent), lustre_swab_layout_intent,
1087 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1090 * OST request field.
1092 struct req_msg_field RMF_OST_BODY =
1093 DEFINE_MSGF("ost_body", 0,
1094 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1095 EXPORT_SYMBOL(RMF_OST_BODY);
1097 struct req_msg_field RMF_OBD_IOOBJ =
1098 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1099 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1100 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1102 struct req_msg_field RMF_NIOBUF_REMOTE =
1103 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1104 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1106 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1108 struct req_msg_field RMF_RCS =
1109 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1110 lustre_swab_generic_32s, dump_rcs);
1111 EXPORT_SYMBOL(RMF_RCS);
1113 struct req_msg_field RMF_EAVALS_LENS =
1114 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1115 lustre_swab_generic_32s, NULL);
1116 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1118 struct req_msg_field RMF_OBD_ID =
1119 DEFINE_MSGF("obd_id", 0,
1120 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1121 EXPORT_SYMBOL(RMF_OBD_ID);
1123 struct req_msg_field RMF_FID =
1124 DEFINE_MSGF("fid", 0,
1125 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1126 EXPORT_SYMBOL(RMF_FID);
1128 struct req_msg_field RMF_OST_ID =
1129 DEFINE_MSGF("ost_id", 0,
1130 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1131 EXPORT_SYMBOL(RMF_OST_ID);
1133 struct req_msg_field RMF_FIEMAP_KEY =
1134 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1135 lustre_swab_fiemap, NULL);
1136 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1138 struct req_msg_field RMF_FIEMAP_VAL =
1139 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1140 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1142 struct req_msg_field RMF_IDX_INFO =
1143 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1144 lustre_swab_idx_info, NULL);
1145 EXPORT_SYMBOL(RMF_IDX_INFO);
1146 struct req_msg_field RMF_HSM_USER_STATE =
1147 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1148 lustre_swab_hsm_user_state, NULL);
1149 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1151 struct req_msg_field RMF_HSM_STATE_SET =
1152 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1153 lustre_swab_hsm_state_set, NULL);
1154 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1156 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1157 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1158 lustre_swab_hsm_progress_kernel, NULL);
1159 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1161 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1162 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1163 lustre_swab_hsm_current_action, NULL);
1164 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1166 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1167 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1168 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1170 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1172 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1173 DEFINE_MSGF("hsm_archive", 0,
1174 sizeof(__u32), lustre_swab_generic_32s, NULL);
1175 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1177 struct req_msg_field RMF_MDS_HSM_REQUEST =
1178 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1179 lustre_swab_hsm_request, NULL);
1180 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1182 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1183 lustre_swab_object_update_request, NULL);
1184 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1186 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1187 DEFINE_MSGF("object_update_reply", 0, -1,
1188 lustre_swab_object_update_reply, NULL);
1189 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1191 struct req_msg_field RMF_SWAP_LAYOUTS =
1192 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1193 lustre_swab_swap_layouts, NULL);
1194 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1196 struct req_msg_field RMF_LFSCK_REQUEST =
1197 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1198 lustre_swab_lfsck_request, NULL);
1199 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1201 struct req_msg_field RMF_LFSCK_REPLY =
1202 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1203 lustre_swab_lfsck_reply, NULL);
1204 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1206 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1207 -1, lustre_swab_out_update_header, NULL);
1208 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1210 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1211 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1212 lustre_swab_out_update_buffer, NULL);
1213 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1220 const char *rf_name;
1224 const struct req_msg_field **d;
1225 } rf_fields[RCL_NR];
1228 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1242 #define DEFINE_REQ_FMT0(name, client, server) \
1243 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1245 struct req_format RQF_OBD_PING =
1246 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1247 EXPORT_SYMBOL(RQF_OBD_PING);
1249 struct req_format RQF_OBD_SET_INFO =
1250 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1251 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1253 /* Read index file through the network */
1254 struct req_format RQF_OBD_IDX_READ =
1255 DEFINE_REQ_FMT0("OBD_IDX_READ",
1256 obd_idx_read_client, obd_idx_read_server);
1257 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1259 struct req_format RQF_SEC_CTX =
1260 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1261 EXPORT_SYMBOL(RQF_SEC_CTX);
1263 struct req_format RQF_MGS_TARGET_REG =
1264 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1265 mgs_target_info_only);
1266 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1268 struct req_format RQF_MGS_SET_INFO =
1269 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1271 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1273 struct req_format RQF_MGS_CONFIG_READ =
1274 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1275 mgs_config_read_server);
1276 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1278 struct req_format RQF_SEQ_QUERY =
1279 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1280 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1282 struct req_format RQF_FLD_QUERY =
1283 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1284 EXPORT_SYMBOL(RQF_FLD_QUERY);
1286 struct req_format RQF_FLD_READ =
1287 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1288 EXPORT_SYMBOL(RQF_FLD_READ);
1290 struct req_format RQF_LOG_CANCEL =
1291 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1292 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1294 struct req_format RQF_MDS_QUOTACTL =
1295 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1296 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1298 struct req_format RQF_OST_QUOTACTL =
1299 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1300 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1302 struct req_format RQF_QUOTA_DQACQ =
1303 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1304 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1306 struct req_format RQF_LDLM_INTENT_QUOTA =
1307 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1308 ldlm_intent_quota_client,
1309 ldlm_intent_quota_server);
1310 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1312 struct req_format RQF_MDS_GETSTATUS =
1313 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1314 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1316 struct req_format RQF_MDS_STATFS =
1317 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1318 EXPORT_SYMBOL(RQF_MDS_STATFS);
1320 struct req_format RQF_MDS_SYNC =
1321 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1322 EXPORT_SYMBOL(RQF_MDS_SYNC);
1324 struct req_format RQF_MDS_GETATTR =
1325 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1326 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1328 struct req_format RQF_MDS_GETXATTR =
1329 DEFINE_REQ_FMT0("MDS_GETXATTR",
1330 mds_getxattr_client, mds_getxattr_server);
1331 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1333 struct req_format RQF_MDS_GETATTR_NAME =
1334 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1335 mds_getattr_name_client, mds_getattr_server);
1336 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1338 struct req_format RQF_MDS_REINT =
1339 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1340 EXPORT_SYMBOL(RQF_MDS_REINT);
1342 struct req_format RQF_MDS_REINT_CREATE =
1343 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1344 mds_reint_create_client, mdt_body_capa);
1345 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1347 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1348 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1349 mds_reint_create_rmt_acl_client, mdt_body_capa);
1350 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1352 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1353 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1354 mds_reint_create_slave_client, mdt_body_capa);
1355 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1357 struct req_format RQF_MDS_REINT_CREATE_SYM =
1358 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1359 mds_reint_create_sym_client, mdt_body_capa);
1360 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1362 struct req_format RQF_MDS_REINT_OPEN =
1363 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1364 mds_reint_open_client, mds_reint_open_server);
1365 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1367 struct req_format RQF_MDS_REINT_UNLINK =
1368 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1369 mds_last_unlink_server);
1370 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1372 struct req_format RQF_MDS_REINT_LINK =
1373 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1374 mds_reint_link_client, mdt_body_only);
1375 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1377 struct req_format RQF_MDS_REINT_RENAME =
1378 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1379 mds_last_unlink_server);
1380 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1382 struct req_format RQF_MDS_REINT_MIGRATE =
1383 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1384 mds_last_unlink_server);
1385 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1387 struct req_format RQF_MDS_REINT_SETATTR =
1388 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1389 mds_reint_setattr_client, mds_setattr_server);
1390 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1392 struct req_format RQF_MDS_REINT_SETXATTR =
1393 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1394 mds_reint_setxattr_client, mdt_body_only);
1395 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1397 struct req_format RQF_MDS_CONNECT =
1398 DEFINE_REQ_FMT0("MDS_CONNECT",
1399 obd_connect_client, obd_connect_server);
1400 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1402 struct req_format RQF_MDS_DISCONNECT =
1403 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1404 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1406 struct req_format RQF_MDS_GET_INFO =
1407 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1408 mds_getinfo_server);
1409 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1411 struct req_format RQF_OUT_UPDATE =
1412 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1414 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1416 struct req_format RQF_LDLM_ENQUEUE =
1417 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1418 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1419 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1421 struct req_format RQF_LDLM_ENQUEUE_LVB =
1422 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1423 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1424 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1426 struct req_format RQF_LDLM_CONVERT =
1427 DEFINE_REQ_FMT0("LDLM_CONVERT",
1428 ldlm_enqueue_client, ldlm_enqueue_server);
1429 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1431 struct req_format RQF_LDLM_CANCEL =
1432 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1433 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1435 struct req_format RQF_LDLM_CALLBACK =
1436 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1437 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1439 struct req_format RQF_LDLM_CP_CALLBACK =
1440 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1441 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1443 struct req_format RQF_LDLM_BL_CALLBACK =
1444 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1445 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1447 struct req_format RQF_LDLM_GL_CALLBACK =
1448 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1449 ldlm_gl_callback_server);
1450 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1452 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1453 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1454 ldlm_gl_callback_server);
1455 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1457 struct req_format RQF_LDLM_INTENT_BASIC =
1458 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1459 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1460 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1462 struct req_format RQF_LDLM_INTENT =
1463 DEFINE_REQ_FMT0("LDLM_INTENT",
1464 ldlm_intent_client, ldlm_intent_server);
1465 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1467 struct req_format RQF_LDLM_INTENT_LAYOUT =
1468 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1469 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1470 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1472 struct req_format RQF_LDLM_INTENT_GETATTR =
1473 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1474 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1475 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1477 struct req_format RQF_LDLM_INTENT_OPEN =
1478 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1479 ldlm_intent_open_client, ldlm_intent_open_server);
1480 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1482 struct req_format RQF_LDLM_INTENT_CREATE =
1483 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1484 ldlm_intent_create_client, ldlm_intent_getattr_server);
1485 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1487 struct req_format RQF_LDLM_INTENT_UNLINK =
1488 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1489 ldlm_intent_unlink_client, ldlm_intent_server);
1490 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1492 struct req_format RQF_LDLM_INTENT_GETXATTR =
1493 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1494 ldlm_intent_getxattr_client,
1495 ldlm_intent_getxattr_server);
1496 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1498 struct req_format RQF_MDS_CLOSE =
1499 DEFINE_REQ_FMT0("MDS_CLOSE",
1500 mdt_close_client, mds_last_unlink_server);
1501 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1503 struct req_format RQF_MDS_INTENT_CLOSE =
1504 DEFINE_REQ_FMT0("MDS_CLOSE",
1505 mdt_intent_close_client, mds_last_unlink_server);
1506 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1508 struct req_format RQF_MDS_READPAGE =
1509 DEFINE_REQ_FMT0("MDS_READPAGE",
1510 mdt_body_capa, mdt_body_only);
1511 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1513 struct req_format RQF_MDS_HSM_ACTION =
1514 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1515 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1517 struct req_format RQF_MDS_HSM_PROGRESS =
1518 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1519 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1521 struct req_format RQF_MDS_HSM_CT_REGISTER =
1522 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1523 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1525 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1526 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1527 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1529 struct req_format RQF_MDS_HSM_STATE_GET =
1530 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1531 mdt_body_capa, mdt_hsm_state_get_server);
1532 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1534 struct req_format RQF_MDS_HSM_STATE_SET =
1535 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1536 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1538 struct req_format RQF_MDS_HSM_REQUEST =
1539 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1540 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1542 struct req_format RQF_MDS_SWAP_LAYOUTS =
1543 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1544 mdt_swap_layouts, empty);
1545 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1547 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1548 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1549 llog_origin_handle_create_client, llogd_body_only);
1550 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1552 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1553 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1554 llogd_body_only, llogd_body_only);
1555 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1557 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1558 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1559 llogd_body_only, llog_origin_handle_next_block_server);
1560 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1562 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1563 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1564 llogd_body_only, llog_origin_handle_next_block_server);
1565 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1567 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1568 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1569 llogd_body_only, llog_log_hdr_only);
1570 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1572 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1573 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1574 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1576 struct req_format RQF_CONNECT =
1577 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1578 EXPORT_SYMBOL(RQF_CONNECT);
1580 struct req_format RQF_OST_CONNECT =
1581 DEFINE_REQ_FMT0("OST_CONNECT",
1582 obd_connect_client, obd_connect_server);
1583 EXPORT_SYMBOL(RQF_OST_CONNECT);
1585 struct req_format RQF_OST_DISCONNECT =
1586 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1587 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1589 struct req_format RQF_OST_GETATTR =
1590 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1591 EXPORT_SYMBOL(RQF_OST_GETATTR);
1593 struct req_format RQF_OST_SETATTR =
1594 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1595 EXPORT_SYMBOL(RQF_OST_SETATTR);
1597 struct req_format RQF_OST_CREATE =
1598 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1599 EXPORT_SYMBOL(RQF_OST_CREATE);
1601 struct req_format RQF_OST_PUNCH =
1602 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1603 EXPORT_SYMBOL(RQF_OST_PUNCH);
1605 struct req_format RQF_OST_SYNC =
1606 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1607 EXPORT_SYMBOL(RQF_OST_SYNC);
1609 struct req_format RQF_OST_DESTROY =
1610 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1611 EXPORT_SYMBOL(RQF_OST_DESTROY);
1613 struct req_format RQF_OST_BRW_READ =
1614 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1615 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1617 struct req_format RQF_OST_BRW_WRITE =
1618 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1619 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1621 struct req_format RQF_OST_STATFS =
1622 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1623 EXPORT_SYMBOL(RQF_OST_STATFS);
1625 struct req_format RQF_OST_SET_GRANT_INFO =
1626 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1628 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1630 struct req_format RQF_OST_GET_INFO =
1631 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1632 ost_get_info_generic_server);
1633 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1635 struct req_format RQF_OST_GET_INFO_LAST_ID =
1636 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1637 ost_get_last_id_server);
1638 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1640 struct req_format RQF_OST_GET_INFO_LAST_FID =
1641 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1642 ost_get_last_fid_server);
1643 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1645 struct req_format RQF_OST_SET_INFO_LAST_FID =
1646 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1648 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1650 struct req_format RQF_OST_GET_INFO_FIEMAP =
1651 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1652 ost_get_fiemap_server);
1653 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1655 struct req_format RQF_LFSCK_NOTIFY =
1656 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1657 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1659 struct req_format RQF_LFSCK_QUERY =
1660 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1661 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1663 #if !defined(__REQ_LAYOUT_USER__)
1665 /* Convenience macro */
1666 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1669 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1670 * field of RQFs and the \a rmf_offset field of RMFs.
1672 int req_layout_init(void)
1677 struct req_format *rf = NULL;
1679 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1680 rf = req_formats[i];
1682 for (j = 0; j < RCL_NR; ++j) {
1683 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1684 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1685 struct req_msg_field *field;
1687 field = (typeof(field))rf->rf_fields[j].d[k];
1688 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1689 || field->rmf_size > 0);
1690 LASSERT(field->rmf_offset[i][j] == 0);
1692 * k + 1 to detect unused format/field
1695 field->rmf_offset[i][j] = k + 1;
1701 EXPORT_SYMBOL(req_layout_init);
1703 void req_layout_fini(void)
1706 EXPORT_SYMBOL(req_layout_fini);
1709 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1711 * Actual/expected field sizes are set elsewhere in functions in this file:
1712 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1713 * req_capsule_msg_size(). The \a rc_area information is used by.
1714 * ptlrpc_request_set_replen().
1716 void req_capsule_init_area(struct req_capsule *pill)
1720 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1721 pill->rc_area[RCL_CLIENT][i] = -1;
1722 pill->rc_area[RCL_SERVER][i] = -1;
1725 EXPORT_SYMBOL(req_capsule_init_area);
1728 * Initialize a pill.
1730 * The \a location indicates whether the caller is executing on the client side
1731 * (RCL_CLIENT) or server side (RCL_SERVER)..
1733 void req_capsule_init(struct req_capsule *pill,
1734 struct ptlrpc_request *req,
1735 enum req_location location)
1737 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1740 * Today all capsules are embedded in ptlrpc_request structs,
1741 * but just in case that ever isn't the case, we don't reach
1742 * into req unless req != NULL and pill is the one embedded in
1745 * The req->rq_pill_init flag makes it safe to initialize a pill
1746 * twice, which might happen in the OST paths as a result of the
1747 * high-priority RPC queue getting peeked at before ost_handle()
1748 * handles an OST RPC.
1750 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1753 memset(pill, 0, sizeof *pill);
1755 pill->rc_loc = location;
1756 req_capsule_init_area(pill);
1758 if (req != NULL && pill == &req->rq_pill)
1759 req->rq_pill_init = 1;
1761 EXPORT_SYMBOL(req_capsule_init);
1763 void req_capsule_fini(struct req_capsule *pill)
1766 EXPORT_SYMBOL(req_capsule_fini);
1768 static int __req_format_is_sane(const struct req_format *fmt)
1770 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1771 req_formats[fmt->rf_idx] == fmt;
1774 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1775 enum req_location loc)
1777 struct ptlrpc_request *req;
1780 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1784 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1785 * (see req_capsule_extend()).
1787 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1789 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1790 LASSERT(__req_format_is_sane(fmt));
1794 EXPORT_SYMBOL(req_capsule_set);
1797 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1800 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1801 * variable-sized fields. The field sizes come from the declared \a rmf_size
1802 * field of a \a pill's \a rc_fmt's RMF's.
1804 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1805 enum req_location loc)
1807 const struct req_format *fmt = pill->rc_fmt;
1810 LASSERT(fmt != NULL);
1812 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1813 if (pill->rc_area[loc][i] == -1) {
1814 pill->rc_area[loc][i] =
1815 fmt->rf_fields[loc].d[i]->rmf_size;
1816 if (pill->rc_area[loc][i] == -1) {
1818 * Skip the following fields.
1820 * If this LASSERT() trips then you're missing a
1821 * call to req_capsule_set_size().
1823 LASSERT(loc != RCL_SERVER);
1830 EXPORT_SYMBOL(req_capsule_filled_sizes);
1833 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1835 * This function uses the \a pill's \a rc_area as filled in by
1836 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1839 int req_capsule_server_pack(struct req_capsule *pill)
1841 const struct req_format *fmt;
1845 LASSERT(pill->rc_loc == RCL_SERVER);
1847 LASSERT(fmt != NULL);
1849 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1850 rc = lustre_pack_reply(pill->rc_req, count,
1851 pill->rc_area[RCL_SERVER], NULL);
1853 DEBUG_REQ(D_ERROR, pill->rc_req,
1854 "Cannot pack %d fields in format `%s': ",
1855 count, fmt->rf_name);
1859 EXPORT_SYMBOL(req_capsule_server_pack);
1862 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1863 * corresponding to the given RMF (\a field).
1865 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1866 const struct req_msg_field *field,
1867 enum req_location loc)
1871 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1872 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1873 pill->rc_fmt->rf_name,
1874 field->rmf_name, offset, loc);
1877 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1882 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1887 swabber_dumper_helper(struct req_capsule *pill,
1888 const struct req_msg_field *field,
1889 enum req_location loc,
1891 void *value, int len, int dump, void (*swabber)( void *))
1897 int inout = loc == RCL_CLIENT;
1899 swabber = swabber ?: field->rmf_swabber;
1901 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1902 swabber != NULL && value != NULL)
1907 if (!field->rmf_dumper)
1910 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1912 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1913 do_swab ? "unswabbed " : "", field->rmf_name);
1914 field->rmf_dumper(value);
1919 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1921 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1922 "follows\n", field->rmf_name);
1923 field->rmf_dumper(value);
1930 * We're swabbing an array; swabber() swabs a single array element, so
1931 * swab every element.
1933 LASSERT((len % field->rmf_size) == 0);
1934 for (p = value, i = 0, n = len / field->rmf_size;
1936 i++, p += field->rmf_size) {
1938 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1939 "element %d follows\n",
1940 do_swab ? "unswabbed " : "", field->rmf_name, i);
1941 field->rmf_dumper(p);
1947 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1948 "element %d follows\n", field->rmf_name, i);
1949 field->rmf_dumper(value);
1953 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1957 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1958 * corresponding to the given RMF (\a field).
1960 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1961 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1962 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1963 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1964 * element of the array swabbed.
1966 static void *__req_capsule_get(struct req_capsule *pill,
1967 const struct req_msg_field *field,
1968 enum req_location loc,
1969 void (*swabber)( void *),
1972 const struct req_format *fmt;
1973 struct lustre_msg *msg;
1978 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
1980 static const char *rcl_names[RCL_NR] = {
1981 [RCL_CLIENT] = "client",
1982 [RCL_SERVER] = "server"
1985 LASSERT(pill != NULL);
1986 LASSERT(pill != LP_POISON);
1988 LASSERT(fmt != NULL);
1989 LASSERT(fmt != LP_POISON);
1990 LASSERT(__req_format_is_sane(fmt));
1992 offset = __req_capsule_offset(pill, field, loc);
1994 msg = __req_msg(pill, loc);
1995 LASSERT(msg != NULL);
1997 getter = (field->rmf_flags & RMF_F_STRING) ?
1998 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2000 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2002 * We've already asserted that field->rmf_size > 0 in
2003 * req_layout_init().
2005 len = lustre_msg_buflen(msg, offset);
2006 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2007 (len % field->rmf_size) != 0) {
2008 CERROR("%s: array field size mismatch "
2009 "%d modulo %u != 0 (%d)\n",
2010 field->rmf_name, len, field->rmf_size, loc);
2013 } else if (pill->rc_area[loc][offset] != -1) {
2014 len = pill->rc_area[loc][offset];
2016 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2018 value = getter(msg, offset, len);
2020 if (value == NULL) {
2021 DEBUG_REQ(D_ERROR, pill->rc_req,
2022 "Wrong buffer for field `%s' (%u of %u) "
2023 "in format `%s': %u vs. %u (%s)\n",
2024 field->rmf_name, offset, lustre_msg_bufcount(msg),
2025 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2028 swabber_dumper_helper(pill, field, loc, offset, value, len,
2036 * Dump a request and/or reply
2038 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2040 const struct req_format *fmt;
2041 const struct req_msg_field *field;
2047 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2048 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2049 field = FMT_FIELD(fmt, loc, i);
2050 if (field->rmf_dumper == NULL) {
2052 * FIXME Add a default hex dumper for fields that don't
2053 * have a specific dumper
2055 len = req_capsule_get_size(pill, field, loc);
2056 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2057 "field size is %u\n", field->rmf_name, len);
2059 /* It's the dumping side-effect that we're interested in */
2060 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2063 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2069 void req_capsule_client_dump(struct req_capsule *pill)
2071 __req_capsule_dump(pill, RCL_CLIENT);
2073 EXPORT_SYMBOL(req_capsule_client_dump);
2078 void req_capsule_server_dump(struct req_capsule *pill)
2080 __req_capsule_dump(pill, RCL_SERVER);
2082 EXPORT_SYMBOL(req_capsule_server_dump);
2085 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2086 * buffer corresponding to the given RMF (\a field) of a \a pill.
2088 void *req_capsule_client_get(struct req_capsule *pill,
2089 const struct req_msg_field *field)
2091 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2093 EXPORT_SYMBOL(req_capsule_client_get);
2096 * Same as req_capsule_client_get(), but with a \a swabber argument.
2098 * Currently unused; will be removed when req_capsule_server_swab_get() is
2101 void *req_capsule_client_swab_get(struct req_capsule *pill,
2102 const struct req_msg_field *field,
2105 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2107 EXPORT_SYMBOL(req_capsule_client_swab_get);
2110 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2112 * First the \a pill's request \a field's size is set (\a rc_area) using
2113 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2116 void *req_capsule_client_sized_get(struct req_capsule *pill,
2117 const struct req_msg_field *field,
2120 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2121 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2123 EXPORT_SYMBOL(req_capsule_client_sized_get);
2126 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2127 * buffer corresponding to the given RMF (\a field) of a \a pill.
2129 void *req_capsule_server_get(struct req_capsule *pill,
2130 const struct req_msg_field *field)
2132 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2134 EXPORT_SYMBOL(req_capsule_server_get);
2137 * Same as req_capsule_server_get(), but with a \a swabber argument.
2139 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2140 * swabbing done outside this capsule abstraction.
2142 void *req_capsule_server_swab_get(struct req_capsule *pill,
2143 const struct req_msg_field *field,
2146 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2148 EXPORT_SYMBOL(req_capsule_server_swab_get);
2151 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2153 * First the \a pill's request \a field's size is set (\a rc_area) using
2154 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2157 void *req_capsule_server_sized_get(struct req_capsule *pill,
2158 const struct req_msg_field *field,
2161 req_capsule_set_size(pill, field, RCL_SERVER, len);
2162 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2164 EXPORT_SYMBOL(req_capsule_server_sized_get);
2166 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2167 const struct req_msg_field *field,
2168 __u32 len, void *swabber)
2170 req_capsule_set_size(pill, field, RCL_SERVER, len);
2171 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2173 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2176 * Returns the buffer of a \a pill corresponding to the given \a field from the
2177 * request (if the caller is executing on the server-side) or reply (if the
2178 * caller is executing on the client-side).
2180 * This function convienient for use is code that could be executed on the
2181 * client and server alike.
2183 const void *req_capsule_other_get(struct req_capsule *pill,
2184 const struct req_msg_field *field)
2186 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2188 EXPORT_SYMBOL(req_capsule_other_get);
2191 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2192 * field of the given \a pill.
2194 * This function must be used when constructing variable sized fields of a
2197 void req_capsule_set_size(struct req_capsule *pill,
2198 const struct req_msg_field *field,
2199 enum req_location loc, __u32 size)
2201 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2203 if ((size != (__u32)field->rmf_size) &&
2204 (field->rmf_size != -1) &&
2205 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2207 __u32 rmf_size = (__u32)field->rmf_size;
2208 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2209 (size % rmf_size != 0)) {
2210 CERROR("%s: array field size mismatch "
2211 "%u %% %u != 0 (%d)\n",
2212 field->rmf_name, size, rmf_size, loc);
2214 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2216 CERROR("%s: field size mismatch %u != %u (%d)\n",
2217 field->rmf_name, size, rmf_size, loc);
2222 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2224 EXPORT_SYMBOL(req_capsule_set_size);
2227 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2228 * for the given \a pill's given \a field.
2230 * NB: this function doesn't correspond with req_capsule_set_size(), which
2231 * actually sets the size in pill.rc_area[loc][offset], but this function
2232 * returns the message buflen[offset], maybe we should use another name.
2234 __u32 req_capsule_get_size(const struct req_capsule *pill,
2235 const struct req_msg_field *field,
2236 enum req_location loc)
2238 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2240 return lustre_msg_buflen(__req_msg(pill, loc),
2241 __req_capsule_offset(pill, field, loc));
2243 EXPORT_SYMBOL(req_capsule_get_size);
2246 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2247 * given \a pill's request or reply (\a loc) given the field size recorded in
2248 * the \a pill's rc_area.
2250 * See also req_capsule_set_size().
2252 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2254 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2255 pill->rc_fmt->rf_fields[loc].nr,
2256 pill->rc_area[loc]);
2260 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2261 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2262 * PTLRPC request or reply given only an RQF (\a fmt).
2264 * This function should not be used for formats which contain variable size
2267 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2268 enum req_location loc)
2274 * This function should probably LASSERT() that fmt has no fields with
2275 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2276 * elements in the array there will ultimately be, but then, we could
2277 * assume that there will be at least one element, and that's just what
2280 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2284 for (; i < fmt->rf_fields[loc].nr; ++i)
2285 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2286 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2292 * Changes the format of an RPC.
2294 * The pill must already have been initialized, which means that it already has
2295 * a request format. The new format \a fmt must be an extension of the pill's
2296 * old format. Specifically: the new format must have as many request and reply
2297 * fields as the old one, and all fields shared by the old and new format must
2298 * be at least as large in the new format.
2300 * The new format's fields may be of different "type" than the old format, but
2301 * only for fields that are "opaque" blobs: fields which have a) have no
2302 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2303 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2304 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2305 * according to the key field. When the value, according to the key, contains a
2306 * structure (or array thereof) to be swabbed, the format should be changed to
2307 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2310 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2315 const struct req_format *old;
2317 LASSERT(pill->rc_fmt != NULL);
2318 LASSERT(__req_format_is_sane(fmt));
2322 * Sanity checking...
2324 for (i = 0; i < RCL_NR; ++i) {
2325 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2326 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2327 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2329 /* "opaque" fields can be transmogrified */
2330 if (ofield->rmf_swabber == NULL &&
2331 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2332 (ofield->rmf_size == -1 ||
2333 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2335 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2338 * Last field in old format can be shorter than in new.
2340 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2341 FMT_FIELD(old, i, j)->rmf_size);
2346 EXPORT_SYMBOL(req_capsule_extend);
2349 * This function returns a non-zero value if the given \a field is present in
2350 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2353 int req_capsule_has_field(const struct req_capsule *pill,
2354 const struct req_msg_field *field,
2355 enum req_location loc)
2357 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2359 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2361 EXPORT_SYMBOL(req_capsule_has_field);
2364 * Returns a non-zero value if the given \a field is present in the given \a
2365 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2367 int req_capsule_field_present(const struct req_capsule *pill,
2368 const struct req_msg_field *field,
2369 enum req_location loc)
2373 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2374 LASSERT(req_capsule_has_field(pill, field, loc));
2376 offset = __req_capsule_offset(pill, field, loc);
2377 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2379 EXPORT_SYMBOL(req_capsule_field_present);
2382 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2383 * request or reply (\a loc).
2385 * This is not the opposite of req_capsule_extend().
2387 void req_capsule_shrink(struct req_capsule *pill,
2388 const struct req_msg_field *field,
2390 enum req_location loc)
2392 const struct req_format *fmt;
2393 struct lustre_msg *msg;
2398 LASSERT(fmt != NULL);
2399 LASSERT(__req_format_is_sane(fmt));
2400 LASSERT(req_capsule_has_field(pill, field, loc));
2401 LASSERT(req_capsule_field_present(pill, field, loc));
2403 offset = __req_capsule_offset(pill, field, loc);
2405 msg = __req_msg(pill, loc);
2406 len = lustre_msg_buflen(msg, offset);
2407 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2408 fmt->rf_name, field->rmf_name, len, newlen);
2410 if (loc == RCL_CLIENT)
2411 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2414 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2417 EXPORT_SYMBOL(req_capsule_shrink);
2419 int req_capsule_server_grow(struct req_capsule *pill,
2420 const struct req_msg_field *field,
2423 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2428 LASSERT(pill->rc_fmt != NULL);
2429 LASSERT(__req_format_is_sane(pill->rc_fmt));
2430 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2431 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2433 len = req_capsule_get_size(pill, field, RCL_SERVER);
2434 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2435 if ((__u32)pill->rc_req->rq_repbuf_len >=
2436 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2437 CERROR("Inplace repack might be done\n");
2439 pill->rc_req->rq_reply_state = NULL;
2440 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2441 rc = req_capsule_server_pack(pill);
2443 /* put old rs back, the caller will decide what to do */
2444 pill->rc_req->rq_reply_state = rs;
2447 nrs = pill->rc_req->rq_reply_state;
2448 /* Now we need only buffers, copy first chunk */
2449 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2450 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2451 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2452 memcpy(to, from, len);
2453 /* check if we have tail and copy it too */
2454 if (rs->rs_msg->lm_bufcount > offset + 1) {
2455 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2456 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2457 offset = rs->rs_msg->lm_bufcount - 1;
2458 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2459 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2460 memcpy(to, from, len);
2462 /* drop old reply if everything is fine */
2463 if (rs->rs_difficult) {
2467 nrs->rs_difficult = 1;
2468 nrs->rs_no_ack = rs->rs_no_ack;
2469 for (i = 0; i < rs->rs_nlocks; i++) {
2470 nrs->rs_locks[i] = rs->rs_locks[i];
2471 nrs->rs_modes[i] = rs->rs_modes[i];
2475 rs->rs_difficult = 0;
2478 ptlrpc_rs_decref(rs);
2481 EXPORT_SYMBOL(req_capsule_server_grow);
2482 /* __REQ_LAYOUT_USER__ */