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, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
53 #include <linux/module.h>
55 /* LUSTRE_VERSION_CODE */
56 #include <lustre_ver.h>
58 #include <obd_support.h>
59 /* lustre_swab_mdt_body */
60 #include <lustre/lustre_idl.h>
61 /* obd2cli_tgt() (required by DEBUG_REQ()) */
63 #include <lustre_debug.h>
64 #include <lustre_update.h>
65 #endif /* !__REQ_LAYOUT_USER__ */
67 /* struct ptlrpc_request, lustre_msg* */
68 #include <lustre_req_layout.h>
69 #include <lustre_acl.h>
72 * RQFs (see below) refer to two struct req_msg_field arrays describing the
73 * client request and server reply, respectively.
75 /* empty set of fields... for suitable definition of emptiness. */
76 static const struct req_msg_field *empty[] = {
80 static const struct req_msg_field *mgs_target_info_only[] = {
85 static const struct req_msg_field *mgs_set_info[] = {
90 static const struct req_msg_field *mgs_config_read_client[] = {
95 static const struct req_msg_field *mgs_config_read_server[] = {
100 static const struct req_msg_field *log_cancel_client[] = {
105 static const struct req_msg_field *mdt_body_only[] = {
110 static const struct req_msg_field *mdt_body_capa[] = {
116 static const struct req_msg_field *quotactl_only[] = {
121 static const struct req_msg_field *quota_body_only[] = {
126 static const struct req_msg_field *ldlm_intent_quota_client[] = {
133 static const struct req_msg_field *ldlm_intent_quota_server[] = {
140 static const struct req_msg_field *mdt_close_client[] = {
147 static const struct req_msg_field *mdt_release_close_client[] = {
155 static const struct req_msg_field *obd_statfs_server[] = {
160 static const struct req_msg_field *seq_query_client[] = {
166 static const struct req_msg_field *seq_query_server[] = {
171 static const struct req_msg_field *fld_query_client[] = {
177 static const struct req_msg_field *fld_query_server[] = {
182 static const struct req_msg_field *fld_read_client[] = {
187 static const struct req_msg_field *fld_read_server[] = {
192 static const struct req_msg_field *mds_getattr_name_client[] = {
199 static const struct req_msg_field *mds_reint_client[] = {
204 static const struct req_msg_field *mds_reint_create_client[] = {
211 static const struct req_msg_field *mds_reint_create_slave_client[] = {
220 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
229 static const struct req_msg_field *mds_reint_create_sym_client[] = {
238 static const struct req_msg_field *mds_reint_open_client[] = {
247 static const struct req_msg_field *mds_reint_open_server[] = {
256 static const struct req_msg_field *mds_reint_unlink_client[] = {
264 static const struct req_msg_field *mds_reint_link_client[] = {
273 static const struct req_msg_field *mds_reint_rename_client[] = {
283 static const struct req_msg_field *mds_last_unlink_server[] = {
292 static const struct req_msg_field *mds_reint_setattr_client[] = {
302 static const struct req_msg_field *mds_reint_setxattr_client[] = {
311 static const struct req_msg_field *mdt_swap_layouts[] = {
320 static const struct req_msg_field *obd_connect_client[] = {
328 static const struct req_msg_field *obd_connect_server[] = {
333 static const struct req_msg_field *obd_set_info_client[] = {
339 static const struct req_msg_field *ost_grant_shrink_client[] = {
345 static const struct req_msg_field *mds_getinfo_client[] = {
351 static const struct req_msg_field *mds_getinfo_server[] = {
356 static const struct req_msg_field *ldlm_enqueue_client[] = {
361 static const struct req_msg_field *ldlm_enqueue_server[] = {
366 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
372 static const struct req_msg_field *ldlm_cp_callback_client[] = {
378 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
384 static const struct req_msg_field *ldlm_gl_callback_server[] = {
389 static const struct req_msg_field *ldlm_intent_basic_client[] = {
395 static const struct req_msg_field *ldlm_intent_client[] = {
402 static const struct req_msg_field *ldlm_intent_server[] = {
410 static const struct req_msg_field *ldlm_intent_layout_client[] = {
415 &RMF_EADATA /* for new layout to be set up */
417 static const struct req_msg_field *ldlm_intent_open_server[] = {
427 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
431 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
436 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
445 static const struct req_msg_field *ldlm_intent_create_client[] = {
449 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
455 static const struct req_msg_field *ldlm_intent_open_client[] = {
459 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
466 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
470 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
475 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
483 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
488 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
494 static const struct req_msg_field *mds_getxattr_client[] = {
502 static const struct req_msg_field *mds_getxattr_server[] = {
508 static const struct req_msg_field *mds_getattr_server[] = {
517 static const struct req_msg_field *mds_setattr_server[] = {
526 static const struct req_msg_field *mds_update_client[] = {
531 static const struct req_msg_field *mds_update_server[] = {
533 &RMF_OUT_UPDATE_REPLY,
536 static const struct req_msg_field *llog_origin_handle_create_client[] = {
542 static const struct req_msg_field *llogd_body_only[] = {
547 static const struct req_msg_field *llog_log_hdr_only[] = {
552 static const struct req_msg_field *llogd_conn_body_only[] = {
557 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
563 static const struct req_msg_field *obd_idx_read_client[] = {
568 static const struct req_msg_field *obd_idx_read_server[] = {
573 static const struct req_msg_field *ost_body_only[] = {
578 static const struct req_msg_field *ost_body_capa[] = {
584 static const struct req_msg_field *ost_destroy_client[] = {
592 static const struct req_msg_field *ost_brw_client[] = {
600 static const struct req_msg_field *ost_brw_read_server[] = {
605 static const struct req_msg_field *ost_brw_write_server[] = {
611 static const struct req_msg_field *ost_get_info_generic_server[] = {
616 static const struct req_msg_field *ost_get_info_generic_client[] = {
621 static const struct req_msg_field *ost_get_last_id_server[] = {
626 static const struct req_msg_field *ost_get_last_fid_client[] = {
632 static const struct req_msg_field *ost_get_last_fid_server[] = {
637 static const struct req_msg_field *ost_get_fiemap_client[] = {
643 static const struct req_msg_field *ost_get_fiemap_server[] = {
648 static const struct req_msg_field *mdt_hsm_progress[] = {
651 &RMF_MDS_HSM_PROGRESS,
654 static const struct req_msg_field *mdt_hsm_ct_register[] = {
657 &RMF_MDS_HSM_ARCHIVE,
660 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
665 static const struct req_msg_field *mdt_hsm_action_server[] = {
668 &RMF_MDS_HSM_CURRENT_ACTION,
671 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
677 static const struct req_msg_field *mdt_hsm_state_set[] = {
684 static const struct req_msg_field *mdt_hsm_request[] = {
687 &RMF_MDS_HSM_REQUEST,
688 &RMF_MDS_HSM_USER_ITEM,
692 static const struct req_msg_field *obd_lfsck_request[] = {
697 static const struct req_msg_field *obd_lfsck_reply[] = {
702 static struct req_format *req_formats[] = {
709 &RQF_MGS_CONFIG_READ,
719 &RQF_MDS_GETATTR_NAME,
723 &RQF_MDS_RELEASE_CLOSE,
725 &RQF_MDS_DONE_WRITING,
727 &RQF_MDS_REINT_CREATE,
728 &RQF_MDS_REINT_CREATE_RMT_ACL,
729 &RQF_MDS_REINT_CREATE_SLAVE,
730 &RQF_MDS_REINT_CREATE_SYM,
732 &RQF_MDS_REINT_UNLINK,
734 &RQF_MDS_REINT_RENAME,
735 &RQF_MDS_REINT_SETATTR,
736 &RQF_MDS_REINT_SETXATTR,
739 &RQF_MDS_HSM_PROGRESS,
740 &RQF_MDS_HSM_CT_REGISTER,
741 &RQF_MDS_HSM_CT_UNREGISTER,
742 &RQF_MDS_HSM_STATE_GET,
743 &RQF_MDS_HSM_STATE_SET,
745 &RQF_MDS_HSM_REQUEST,
746 &RQF_MDS_SWAP_LAYOUTS,
762 &RQF_OST_SET_GRANT_INFO,
764 &RQF_OST_GET_INFO_LAST_ID,
765 &RQF_OST_GET_INFO_LAST_FID,
766 &RQF_OST_SET_INFO_LAST_FID,
767 &RQF_OST_GET_INFO_FIEMAP,
769 &RQF_LDLM_ENQUEUE_LVB,
773 &RQF_LDLM_CP_CALLBACK,
774 &RQF_LDLM_BL_CALLBACK,
775 &RQF_LDLM_GL_CALLBACK,
776 &RQF_LDLM_GL_DESC_CALLBACK,
778 &RQF_LDLM_INTENT_BASIC,
779 &RQF_LDLM_INTENT_LAYOUT,
780 &RQF_LDLM_INTENT_GETATTR,
781 &RQF_LDLM_INTENT_OPEN,
782 &RQF_LDLM_INTENT_CREATE,
783 &RQF_LDLM_INTENT_UNLINK,
784 &RQF_LDLM_INTENT_GETXATTR,
785 &RQF_LDLM_INTENT_QUOTA,
788 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
789 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
790 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
791 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
792 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
793 &RQF_LLOG_ORIGIN_CONNECT,
799 struct req_msg_field {
800 const __u32 rmf_flags;
801 const char *rmf_name;
803 * Field length. (-1) means "variable length". If the
804 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
805 * but the actual size must be a whole multiple of \a rmf_size.
808 void (*rmf_swabber)(void *);
809 void (*rmf_dumper)(void *);
810 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
815 * The field is a string, must be NUL-terminated.
817 RMF_F_STRING = 1 << 0,
819 * The field's buffer size need not match the declared \a rmf_size.
821 RMF_F_NO_SIZE_CHECK = 1 << 1,
823 * The field's buffer size must be a whole multiple of the declared \a
824 * rmf_size and the \a rmf_swabber function must work on the declared \a
825 * rmf_size worth of bytes.
827 RMF_F_STRUCT_ARRAY = 1 << 2
835 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
836 .rmf_name = (name), \
837 .rmf_flags = (flags), \
838 .rmf_size = (size), \
839 .rmf_swabber = (void (*)(void*))(swabber), \
840 .rmf_dumper = (void (*)(void*))(dumper) \
843 struct req_msg_field RMF_GENERIC_DATA =
844 DEFINE_MSGF("generic_data", 0,
846 EXPORT_SYMBOL(RMF_GENERIC_DATA);
848 struct req_msg_field RMF_MGS_TARGET_INFO =
849 DEFINE_MSGF("mgs_target_info", 0,
850 sizeof(struct mgs_target_info),
851 lustre_swab_mgs_target_info, NULL);
852 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
854 struct req_msg_field RMF_MGS_SEND_PARAM =
855 DEFINE_MSGF("mgs_send_param", 0,
856 sizeof(struct mgs_send_param),
858 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
860 struct req_msg_field RMF_MGS_CONFIG_BODY =
861 DEFINE_MSGF("mgs_config_read request", 0,
862 sizeof(struct mgs_config_body),
863 lustre_swab_mgs_config_body, NULL);
864 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
866 struct req_msg_field RMF_MGS_CONFIG_RES =
867 DEFINE_MSGF("mgs_config_read reply ", 0,
868 sizeof(struct mgs_config_res),
869 lustre_swab_mgs_config_res, NULL);
870 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
872 struct req_msg_field RMF_U32 =
873 DEFINE_MSGF("generic u32", 0,
874 sizeof(__u32), lustre_swab_generic_32s, NULL);
875 EXPORT_SYMBOL(RMF_U32);
877 struct req_msg_field RMF_SETINFO_VAL =
878 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
879 EXPORT_SYMBOL(RMF_SETINFO_VAL);
881 struct req_msg_field RMF_GETINFO_KEY =
882 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
883 EXPORT_SYMBOL(RMF_GETINFO_KEY);
885 struct req_msg_field RMF_GETINFO_VALLEN =
886 DEFINE_MSGF("getinfo_vallen", 0,
887 sizeof(__u32), lustre_swab_generic_32s, NULL);
888 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
890 struct req_msg_field RMF_GETINFO_VAL =
891 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
892 EXPORT_SYMBOL(RMF_GETINFO_VAL);
894 struct req_msg_field RMF_SEQ_OPC =
895 DEFINE_MSGF("seq_query_opc", 0,
896 sizeof(__u32), lustre_swab_generic_32s, NULL);
897 EXPORT_SYMBOL(RMF_SEQ_OPC);
899 struct req_msg_field RMF_SEQ_RANGE =
900 DEFINE_MSGF("seq_query_range", 0,
901 sizeof(struct lu_seq_range),
902 lustre_swab_lu_seq_range, NULL);
903 EXPORT_SYMBOL(RMF_SEQ_RANGE);
905 struct req_msg_field RMF_FLD_OPC =
906 DEFINE_MSGF("fld_query_opc", 0,
907 sizeof(__u32), lustre_swab_generic_32s, NULL);
908 EXPORT_SYMBOL(RMF_FLD_OPC);
910 struct req_msg_field RMF_FLD_MDFLD =
911 DEFINE_MSGF("fld_query_mdfld", 0,
912 sizeof(struct lu_seq_range),
913 lustre_swab_lu_seq_range, NULL);
914 EXPORT_SYMBOL(RMF_FLD_MDFLD);
916 struct req_msg_field RMF_MDT_BODY =
917 DEFINE_MSGF("mdt_body", 0,
918 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
919 EXPORT_SYMBOL(RMF_MDT_BODY);
921 struct req_msg_field RMF_OBD_QUOTACTL =
922 DEFINE_MSGF("obd_quotactl", 0,
923 sizeof(struct obd_quotactl),
924 lustre_swab_obd_quotactl, NULL);
925 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
927 struct req_msg_field RMF_QUOTA_BODY =
928 DEFINE_MSGF("quota_body", 0,
929 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
930 EXPORT_SYMBOL(RMF_QUOTA_BODY);
932 struct req_msg_field RMF_MDT_EPOCH =
933 DEFINE_MSGF("mdt_ioepoch", 0,
934 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
935 EXPORT_SYMBOL(RMF_MDT_EPOCH);
937 struct req_msg_field RMF_PTLRPC_BODY =
938 DEFINE_MSGF("ptlrpc_body", 0,
939 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
940 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
942 struct req_msg_field RMF_CLOSE_DATA =
943 DEFINE_MSGF("data_version", 0,
944 sizeof(struct close_data), lustre_swab_close_data, NULL);
945 EXPORT_SYMBOL(RMF_CLOSE_DATA);
947 struct req_msg_field RMF_OBD_STATFS =
948 DEFINE_MSGF("obd_statfs", 0,
949 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
950 EXPORT_SYMBOL(RMF_OBD_STATFS);
952 struct req_msg_field RMF_SETINFO_KEY =
953 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
954 EXPORT_SYMBOL(RMF_SETINFO_KEY);
956 struct req_msg_field RMF_NAME =
957 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
958 EXPORT_SYMBOL(RMF_NAME);
960 struct req_msg_field RMF_SYMTGT =
961 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
962 EXPORT_SYMBOL(RMF_SYMTGT);
964 struct req_msg_field RMF_TGTUUID =
965 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
967 EXPORT_SYMBOL(RMF_TGTUUID);
969 struct req_msg_field RMF_CLUUID =
970 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
972 EXPORT_SYMBOL(RMF_CLUUID);
974 struct req_msg_field RMF_STRING =
975 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
976 EXPORT_SYMBOL(RMF_STRING);
978 struct req_msg_field RMF_LLOGD_BODY =
979 DEFINE_MSGF("llogd_body", 0,
980 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
981 EXPORT_SYMBOL(RMF_LLOGD_BODY);
983 struct req_msg_field RMF_LLOG_LOG_HDR =
984 DEFINE_MSGF("llog_log_hdr", 0,
985 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
986 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
988 struct req_msg_field RMF_LLOGD_CONN_BODY =
989 DEFINE_MSGF("llogd_conn_body", 0,
990 sizeof(struct llogd_conn_body),
991 lustre_swab_llogd_conn_body, NULL);
992 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
995 * connection handle received in MDS_CONNECT request.
997 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
998 * that the client does not interpret at all.
1000 struct req_msg_field RMF_CONN =
1001 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1002 EXPORT_SYMBOL(RMF_CONN);
1004 struct req_msg_field RMF_CONNECT_DATA =
1005 DEFINE_MSGF("cdata",
1006 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1007 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 53, 0)
1008 sizeof(struct obd_connect_data),
1010 /* For interoperability with 1.8 and 2.0 clients/servers.
1011 * The RPC verification code allows larger RPC buffers, but not
1012 * smaller buffers. Until we no longer need to keep compatibility
1013 * with older servers/clients we can only check that the buffer
1014 * size is at least as large as obd_connect_data_v1. That is not
1015 * not in itself harmful, since the chance of just corrupting this
1016 * field is low. See JIRA LU-16 for details. */
1017 sizeof(struct obd_connect_data_v1),
1019 lustre_swab_connect, NULL);
1020 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1022 struct req_msg_field RMF_DLM_REQ =
1023 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1024 sizeof(struct ldlm_request),
1025 lustre_swab_ldlm_request, NULL);
1026 EXPORT_SYMBOL(RMF_DLM_REQ);
1028 struct req_msg_field RMF_DLM_REP =
1029 DEFINE_MSGF("dlm_rep", 0,
1030 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1031 EXPORT_SYMBOL(RMF_DLM_REP);
1033 struct req_msg_field RMF_LDLM_INTENT =
1034 DEFINE_MSGF("ldlm_intent", 0,
1035 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1036 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1038 struct req_msg_field RMF_DLM_LVB =
1039 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1040 EXPORT_SYMBOL(RMF_DLM_LVB);
1042 struct req_msg_field RMF_DLM_GL_DESC =
1043 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1044 lustre_swab_gl_desc, NULL);
1045 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1047 struct req_msg_field RMF_MDT_MD =
1048 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1049 EXPORT_SYMBOL(RMF_MDT_MD);
1051 struct req_msg_field RMF_REC_REINT =
1052 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1053 lustre_swab_mdt_rec_reint, NULL);
1054 EXPORT_SYMBOL(RMF_REC_REINT);
1056 /* FIXME: this length should be defined as a macro */
1057 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1059 EXPORT_SYMBOL(RMF_EADATA);
1061 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1062 EXPORT_SYMBOL(RMF_EAVALS);
1064 struct req_msg_field RMF_ACL =
1065 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1066 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1067 EXPORT_SYMBOL(RMF_ACL);
1069 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1070 struct req_msg_field RMF_LOGCOOKIES =
1071 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1072 sizeof(struct llog_cookie), NULL, NULL);
1073 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1075 struct req_msg_field RMF_CAPA1 =
1076 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1077 lustre_swab_lustre_capa, NULL);
1078 EXPORT_SYMBOL(RMF_CAPA1);
1080 struct req_msg_field RMF_CAPA2 =
1081 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1082 lustre_swab_lustre_capa, NULL);
1083 EXPORT_SYMBOL(RMF_CAPA2);
1085 struct req_msg_field RMF_LAYOUT_INTENT =
1086 DEFINE_MSGF("layout_intent", 0,
1087 sizeof(struct layout_intent), lustre_swab_layout_intent,
1089 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1092 * OST request field.
1094 struct req_msg_field RMF_OST_BODY =
1095 DEFINE_MSGF("ost_body", 0,
1096 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1097 EXPORT_SYMBOL(RMF_OST_BODY);
1099 struct req_msg_field RMF_OBD_IOOBJ =
1100 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1101 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1102 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1104 struct req_msg_field RMF_NIOBUF_REMOTE =
1105 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1106 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1108 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1110 struct req_msg_field RMF_RCS =
1111 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1112 lustre_swab_generic_32s, dump_rcs);
1113 EXPORT_SYMBOL(RMF_RCS);
1115 struct req_msg_field RMF_EAVALS_LENS =
1116 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1117 lustre_swab_generic_32s, NULL);
1118 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1120 struct req_msg_field RMF_OBD_ID =
1121 DEFINE_MSGF("obd_id", 0,
1122 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1123 EXPORT_SYMBOL(RMF_OBD_ID);
1125 struct req_msg_field RMF_FID =
1126 DEFINE_MSGF("fid", 0,
1127 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1128 EXPORT_SYMBOL(RMF_FID);
1130 struct req_msg_field RMF_OST_ID =
1131 DEFINE_MSGF("ost_id", 0,
1132 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1133 EXPORT_SYMBOL(RMF_OST_ID);
1135 struct req_msg_field RMF_FIEMAP_KEY =
1136 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1137 lustre_swab_fiemap, NULL);
1138 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1140 struct req_msg_field RMF_FIEMAP_VAL =
1141 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1142 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1144 struct req_msg_field RMF_IDX_INFO =
1145 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1146 lustre_swab_idx_info, NULL);
1147 EXPORT_SYMBOL(RMF_IDX_INFO);
1148 struct req_msg_field RMF_HSM_USER_STATE =
1149 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1150 lustre_swab_hsm_user_state, NULL);
1151 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1153 struct req_msg_field RMF_HSM_STATE_SET =
1154 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1155 lustre_swab_hsm_state_set, NULL);
1156 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1158 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1159 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1160 lustre_swab_hsm_progress_kernel, NULL);
1161 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1163 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1164 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1165 lustre_swab_hsm_current_action, NULL);
1166 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1168 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1169 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1170 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1172 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1174 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1175 DEFINE_MSGF("hsm_archive", 0,
1176 sizeof(__u32), lustre_swab_generic_32s, NULL);
1177 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1179 struct req_msg_field RMF_MDS_HSM_REQUEST =
1180 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1181 lustre_swab_hsm_request, NULL);
1182 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1184 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1185 lustre_swab_object_update_request, NULL);
1186 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1188 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1189 DEFINE_MSGF("object_update_reply", 0, -1,
1190 lustre_swab_object_update_reply, NULL);
1191 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1193 struct req_msg_field RMF_SWAP_LAYOUTS =
1194 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1195 lustre_swab_swap_layouts, NULL);
1196 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1198 struct req_msg_field RMF_LFSCK_REQUEST =
1199 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1200 lustre_swab_lfsck_request, NULL);
1201 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1203 struct req_msg_field RMF_LFSCK_REPLY =
1204 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1205 lustre_swab_lfsck_reply, NULL);
1206 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1213 const char *rf_name;
1217 const struct req_msg_field **d;
1218 } rf_fields[RCL_NR];
1221 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1235 #define DEFINE_REQ_FMT0(name, client, server) \
1236 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1238 struct req_format RQF_OBD_PING =
1239 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1240 EXPORT_SYMBOL(RQF_OBD_PING);
1242 struct req_format RQF_OBD_SET_INFO =
1243 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1244 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1246 /* Read index file through the network */
1247 struct req_format RQF_OBD_IDX_READ =
1248 DEFINE_REQ_FMT0("OBD_IDX_READ",
1249 obd_idx_read_client, obd_idx_read_server);
1250 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1252 struct req_format RQF_SEC_CTX =
1253 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1254 EXPORT_SYMBOL(RQF_SEC_CTX);
1256 struct req_format RQF_MGS_TARGET_REG =
1257 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1258 mgs_target_info_only);
1259 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1261 struct req_format RQF_MGS_SET_INFO =
1262 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1264 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1266 struct req_format RQF_MGS_CONFIG_READ =
1267 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1268 mgs_config_read_server);
1269 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1271 struct req_format RQF_SEQ_QUERY =
1272 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1273 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1275 struct req_format RQF_FLD_QUERY =
1276 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1277 EXPORT_SYMBOL(RQF_FLD_QUERY);
1279 struct req_format RQF_FLD_READ =
1280 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1281 EXPORT_SYMBOL(RQF_FLD_READ);
1283 struct req_format RQF_LOG_CANCEL =
1284 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1285 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1287 struct req_format RQF_MDS_QUOTACHECK =
1288 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1289 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1291 struct req_format RQF_OST_QUOTACHECK =
1292 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1293 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1295 struct req_format RQF_MDS_QUOTACTL =
1296 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1297 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1299 struct req_format RQF_OST_QUOTACTL =
1300 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1301 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1303 struct req_format RQF_QC_CALLBACK =
1304 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1305 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1307 struct req_format RQF_QUOTA_DQACQ =
1308 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1309 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1311 struct req_format RQF_LDLM_INTENT_QUOTA =
1312 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1313 ldlm_intent_quota_client,
1314 ldlm_intent_quota_server);
1315 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1317 struct req_format RQF_MDS_GETSTATUS =
1318 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1319 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1321 struct req_format RQF_MDS_STATFS =
1322 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1323 EXPORT_SYMBOL(RQF_MDS_STATFS);
1325 struct req_format RQF_MDS_SYNC =
1326 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1327 EXPORT_SYMBOL(RQF_MDS_SYNC);
1329 struct req_format RQF_MDS_GETATTR =
1330 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1331 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1333 struct req_format RQF_MDS_GETXATTR =
1334 DEFINE_REQ_FMT0("MDS_GETXATTR",
1335 mds_getxattr_client, mds_getxattr_server);
1336 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1338 struct req_format RQF_MDS_GETATTR_NAME =
1339 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1340 mds_getattr_name_client, mds_getattr_server);
1341 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1343 struct req_format RQF_MDS_REINT =
1344 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1345 EXPORT_SYMBOL(RQF_MDS_REINT);
1347 struct req_format RQF_MDS_REINT_CREATE =
1348 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1349 mds_reint_create_client, mdt_body_capa);
1350 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1352 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1353 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1354 mds_reint_create_rmt_acl_client, mdt_body_capa);
1355 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1357 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1358 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1359 mds_reint_create_slave_client, mdt_body_capa);
1360 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1362 struct req_format RQF_MDS_REINT_CREATE_SYM =
1363 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1364 mds_reint_create_sym_client, mdt_body_capa);
1365 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1367 struct req_format RQF_MDS_REINT_OPEN =
1368 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1369 mds_reint_open_client, mds_reint_open_server);
1370 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1372 struct req_format RQF_MDS_REINT_UNLINK =
1373 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1374 mds_last_unlink_server);
1375 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1377 struct req_format RQF_MDS_REINT_LINK =
1378 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1379 mds_reint_link_client, mdt_body_only);
1380 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1382 struct req_format RQF_MDS_REINT_RENAME =
1383 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1384 mds_last_unlink_server);
1385 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
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_OBJ", 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_RELEASE_CLOSE =
1504 DEFINE_REQ_FMT0("MDS_CLOSE",
1505 mdt_release_close_client, mds_last_unlink_server);
1506 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1508 struct req_format RQF_MDS_DONE_WRITING =
1509 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1510 mdt_close_client, mdt_body_only);
1511 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1513 struct req_format RQF_MDS_READPAGE =
1514 DEFINE_REQ_FMT0("MDS_READPAGE",
1515 mdt_body_capa, mdt_body_only);
1516 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1518 struct req_format RQF_MDS_HSM_ACTION =
1519 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1520 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1522 struct req_format RQF_MDS_HSM_PROGRESS =
1523 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1524 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1526 struct req_format RQF_MDS_HSM_CT_REGISTER =
1527 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1528 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1530 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1531 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1532 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1534 struct req_format RQF_MDS_HSM_STATE_GET =
1535 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1536 mdt_body_capa, mdt_hsm_state_get_server);
1537 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1539 struct req_format RQF_MDS_HSM_STATE_SET =
1540 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1541 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1543 struct req_format RQF_MDS_HSM_REQUEST =
1544 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1545 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1547 struct req_format RQF_MDS_SWAP_LAYOUTS =
1548 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1549 mdt_swap_layouts, empty);
1550 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1552 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1553 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1554 llog_origin_handle_create_client, llogd_body_only);
1555 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1557 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1558 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1559 llogd_body_only, llogd_body_only);
1560 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1562 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1563 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1564 llogd_body_only, llog_origin_handle_next_block_server);
1565 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1567 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1568 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1569 llogd_body_only, llog_origin_handle_next_block_server);
1570 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1572 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1573 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1574 llogd_body_only, llog_log_hdr_only);
1575 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1577 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1578 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1579 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1581 struct req_format RQF_CONNECT =
1582 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1583 EXPORT_SYMBOL(RQF_CONNECT);
1585 struct req_format RQF_OST_CONNECT =
1586 DEFINE_REQ_FMT0("OST_CONNECT",
1587 obd_connect_client, obd_connect_server);
1588 EXPORT_SYMBOL(RQF_OST_CONNECT);
1590 struct req_format RQF_OST_DISCONNECT =
1591 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1592 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1594 struct req_format RQF_OST_GETATTR =
1595 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1596 EXPORT_SYMBOL(RQF_OST_GETATTR);
1598 struct req_format RQF_OST_SETATTR =
1599 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1600 EXPORT_SYMBOL(RQF_OST_SETATTR);
1602 struct req_format RQF_OST_CREATE =
1603 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1604 EXPORT_SYMBOL(RQF_OST_CREATE);
1606 struct req_format RQF_OST_PUNCH =
1607 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1608 EXPORT_SYMBOL(RQF_OST_PUNCH);
1610 struct req_format RQF_OST_SYNC =
1611 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1612 EXPORT_SYMBOL(RQF_OST_SYNC);
1614 struct req_format RQF_OST_DESTROY =
1615 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1616 EXPORT_SYMBOL(RQF_OST_DESTROY);
1618 struct req_format RQF_OST_BRW_READ =
1619 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1620 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1622 struct req_format RQF_OST_BRW_WRITE =
1623 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1624 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1626 struct req_format RQF_OST_STATFS =
1627 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1628 EXPORT_SYMBOL(RQF_OST_STATFS);
1630 struct req_format RQF_OST_SET_GRANT_INFO =
1631 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1633 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1635 struct req_format RQF_OST_GET_INFO =
1636 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1637 ost_get_info_generic_server);
1638 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1640 struct req_format RQF_OST_GET_INFO_LAST_ID =
1641 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1642 ost_get_last_id_server);
1643 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1645 struct req_format RQF_OST_GET_INFO_LAST_FID =
1646 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1647 ost_get_last_fid_server);
1648 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1650 struct req_format RQF_OST_SET_INFO_LAST_FID =
1651 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1653 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1655 struct req_format RQF_OST_GET_INFO_FIEMAP =
1656 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1657 ost_get_fiemap_server);
1658 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1660 struct req_format RQF_LFSCK_NOTIFY =
1661 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1662 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1664 struct req_format RQF_LFSCK_QUERY =
1665 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1666 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1668 #if !defined(__REQ_LAYOUT_USER__)
1670 /* Convenience macro */
1671 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1674 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1675 * field of RQFs and the \a rmf_offset field of RMFs.
1677 int req_layout_init(void)
1682 struct req_format *rf = NULL;
1684 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1685 rf = req_formats[i];
1687 for (j = 0; j < RCL_NR; ++j) {
1688 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1689 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1690 struct req_msg_field *field;
1692 field = (typeof(field))rf->rf_fields[j].d[k];
1693 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1694 || field->rmf_size > 0);
1695 LASSERT(field->rmf_offset[i][j] == 0);
1697 * k + 1 to detect unused format/field
1700 field->rmf_offset[i][j] = k + 1;
1706 EXPORT_SYMBOL(req_layout_init);
1708 void req_layout_fini(void)
1711 EXPORT_SYMBOL(req_layout_fini);
1714 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1716 * Actual/expected field sizes are set elsewhere in functions in this file:
1717 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1718 * req_capsule_msg_size(). The \a rc_area information is used by.
1719 * ptlrpc_request_set_replen().
1721 void req_capsule_init_area(struct req_capsule *pill)
1725 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1726 pill->rc_area[RCL_CLIENT][i] = -1;
1727 pill->rc_area[RCL_SERVER][i] = -1;
1730 EXPORT_SYMBOL(req_capsule_init_area);
1733 * Initialize a pill.
1735 * The \a location indicates whether the caller is executing on the client side
1736 * (RCL_CLIENT) or server side (RCL_SERVER)..
1738 void req_capsule_init(struct req_capsule *pill,
1739 struct ptlrpc_request *req,
1740 enum req_location location)
1742 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1745 * Today all capsules are embedded in ptlrpc_request structs,
1746 * but just in case that ever isn't the case, we don't reach
1747 * into req unless req != NULL and pill is the one embedded in
1750 * The req->rq_pill_init flag makes it safe to initialize a pill
1751 * twice, which might happen in the OST paths as a result of the
1752 * high-priority RPC queue getting peeked at before ost_handle()
1753 * handles an OST RPC.
1755 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1758 memset(pill, 0, sizeof *pill);
1760 pill->rc_loc = location;
1761 req_capsule_init_area(pill);
1763 if (req != NULL && pill == &req->rq_pill)
1764 req->rq_pill_init = 1;
1766 EXPORT_SYMBOL(req_capsule_init);
1768 void req_capsule_fini(struct req_capsule *pill)
1771 EXPORT_SYMBOL(req_capsule_fini);
1773 static int __req_format_is_sane(const struct req_format *fmt)
1775 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1776 req_formats[fmt->rf_idx] == fmt;
1779 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1780 enum req_location loc)
1782 struct ptlrpc_request *req;
1785 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1789 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1790 * (see req_capsule_extend()).
1792 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1794 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1795 LASSERT(__req_format_is_sane(fmt));
1799 EXPORT_SYMBOL(req_capsule_set);
1802 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1805 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1806 * variable-sized fields. The field sizes come from the declared \a rmf_size
1807 * field of a \a pill's \a rc_fmt's RMF's.
1809 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1810 enum req_location loc)
1812 const struct req_format *fmt = pill->rc_fmt;
1815 LASSERT(fmt != NULL);
1817 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1818 if (pill->rc_area[loc][i] == -1) {
1819 pill->rc_area[loc][i] =
1820 fmt->rf_fields[loc].d[i]->rmf_size;
1821 if (pill->rc_area[loc][i] == -1) {
1823 * Skip the following fields.
1825 * If this LASSERT() trips then you're missing a
1826 * call to req_capsule_set_size().
1828 LASSERT(loc != RCL_SERVER);
1835 EXPORT_SYMBOL(req_capsule_filled_sizes);
1838 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1840 * This function uses the \a pill's \a rc_area as filled in by
1841 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1844 int req_capsule_server_pack(struct req_capsule *pill)
1846 const struct req_format *fmt;
1850 LASSERT(pill->rc_loc == RCL_SERVER);
1852 LASSERT(fmt != NULL);
1854 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1855 rc = lustre_pack_reply(pill->rc_req, count,
1856 pill->rc_area[RCL_SERVER], NULL);
1858 DEBUG_REQ(D_ERROR, pill->rc_req,
1859 "Cannot pack %d fields in format `%s': ",
1860 count, fmt->rf_name);
1864 EXPORT_SYMBOL(req_capsule_server_pack);
1867 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1868 * corresponding to the given RMF (\a field).
1870 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1871 const struct req_msg_field *field,
1872 enum req_location loc)
1876 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1877 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1878 pill->rc_fmt->rf_name,
1879 field->rmf_name, offset, loc);
1882 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1887 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1892 swabber_dumper_helper(struct req_capsule *pill,
1893 const struct req_msg_field *field,
1894 enum req_location loc,
1896 void *value, int len, int dump, void (*swabber)( void *))
1902 int inout = loc == RCL_CLIENT;
1904 swabber = swabber ?: field->rmf_swabber;
1906 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1907 swabber != NULL && value != NULL)
1912 if (!field->rmf_dumper)
1915 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1917 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1918 do_swab ? "unswabbed " : "", field->rmf_name);
1919 field->rmf_dumper(value);
1924 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1926 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1927 "follows\n", field->rmf_name);
1928 field->rmf_dumper(value);
1935 * We're swabbing an array; swabber() swabs a single array element, so
1936 * swab every element.
1938 LASSERT((len % field->rmf_size) == 0);
1939 for (p = value, i = 0, n = len / field->rmf_size;
1941 i++, p += field->rmf_size) {
1943 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1944 "element %d follows\n",
1945 do_swab ? "unswabbed " : "", field->rmf_name, i);
1946 field->rmf_dumper(p);
1952 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1953 "element %d follows\n", field->rmf_name, i);
1954 field->rmf_dumper(value);
1958 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1962 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1963 * corresponding to the given RMF (\a field).
1965 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1966 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1967 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1968 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1969 * element of the array swabbed.
1971 static void *__req_capsule_get(struct req_capsule *pill,
1972 const struct req_msg_field *field,
1973 enum req_location loc,
1974 void (*swabber)( void *),
1977 const struct req_format *fmt;
1978 struct lustre_msg *msg;
1983 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
1985 static const char *rcl_names[RCL_NR] = {
1986 [RCL_CLIENT] = "client",
1987 [RCL_SERVER] = "server"
1990 LASSERT(pill != NULL);
1991 LASSERT(pill != LP_POISON);
1993 LASSERT(fmt != NULL);
1994 LASSERT(fmt != LP_POISON);
1995 LASSERT(__req_format_is_sane(fmt));
1997 offset = __req_capsule_offset(pill, field, loc);
1999 msg = __req_msg(pill, loc);
2000 LASSERT(msg != NULL);
2002 getter = (field->rmf_flags & RMF_F_STRING) ?
2003 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2005 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2007 * We've already asserted that field->rmf_size > 0 in
2008 * req_layout_init().
2010 len = lustre_msg_buflen(msg, offset);
2011 if ((len % field->rmf_size) != 0) {
2012 CERROR("%s: array field size mismatch "
2013 "%d modulo %u != 0 (%d)\n",
2014 field->rmf_name, len, field->rmf_size, loc);
2017 } else if (pill->rc_area[loc][offset] != -1) {
2018 len = pill->rc_area[loc][offset];
2020 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2022 value = getter(msg, offset, len);
2024 if (value == NULL) {
2025 DEBUG_REQ(D_ERROR, pill->rc_req,
2026 "Wrong buffer for field `%s' (%u of %u) "
2027 "in format `%s': %u vs. %u (%s)\n",
2028 field->rmf_name, offset, lustre_msg_bufcount(msg),
2029 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2032 swabber_dumper_helper(pill, field, loc, offset, value, len,
2040 * Dump a request and/or reply
2042 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2044 const struct req_format *fmt;
2045 const struct req_msg_field *field;
2051 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2052 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2053 field = FMT_FIELD(fmt, loc, i);
2054 if (field->rmf_dumper == NULL) {
2056 * FIXME Add a default hex dumper for fields that don't
2057 * have a specific dumper
2059 len = req_capsule_get_size(pill, field, loc);
2060 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2061 "field size is %u\n", field->rmf_name, len);
2063 /* It's the dumping side-effect that we're interested in */
2064 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2067 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2073 void req_capsule_client_dump(struct req_capsule *pill)
2075 __req_capsule_dump(pill, RCL_CLIENT);
2077 EXPORT_SYMBOL(req_capsule_client_dump);
2082 void req_capsule_server_dump(struct req_capsule *pill)
2084 __req_capsule_dump(pill, RCL_SERVER);
2086 EXPORT_SYMBOL(req_capsule_server_dump);
2089 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2090 * buffer corresponding to the given RMF (\a field) of a \a pill.
2092 void *req_capsule_client_get(struct req_capsule *pill,
2093 const struct req_msg_field *field)
2095 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2097 EXPORT_SYMBOL(req_capsule_client_get);
2100 * Same as req_capsule_client_get(), but with a \a swabber argument.
2102 * Currently unused; will be removed when req_capsule_server_swab_get() is
2105 void *req_capsule_client_swab_get(struct req_capsule *pill,
2106 const struct req_msg_field *field,
2109 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2111 EXPORT_SYMBOL(req_capsule_client_swab_get);
2114 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2116 * First the \a pill's request \a field's size is set (\a rc_area) using
2117 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2120 void *req_capsule_client_sized_get(struct req_capsule *pill,
2121 const struct req_msg_field *field,
2124 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2125 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2127 EXPORT_SYMBOL(req_capsule_client_sized_get);
2130 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2131 * buffer corresponding to the given RMF (\a field) of a \a pill.
2133 void *req_capsule_server_get(struct req_capsule *pill,
2134 const struct req_msg_field *field)
2136 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2138 EXPORT_SYMBOL(req_capsule_server_get);
2141 * Same as req_capsule_server_get(), but with a \a swabber argument.
2143 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2144 * swabbing done outside this capsule abstraction.
2146 void *req_capsule_server_swab_get(struct req_capsule *pill,
2147 const struct req_msg_field *field,
2150 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2152 EXPORT_SYMBOL(req_capsule_server_swab_get);
2155 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2157 * First the \a pill's request \a field's size is set (\a rc_area) using
2158 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2161 void *req_capsule_server_sized_get(struct req_capsule *pill,
2162 const struct req_msg_field *field,
2165 req_capsule_set_size(pill, field, RCL_SERVER, len);
2166 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2168 EXPORT_SYMBOL(req_capsule_server_sized_get);
2170 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2171 const struct req_msg_field *field,
2172 __u32 len, void *swabber)
2174 req_capsule_set_size(pill, field, RCL_SERVER, len);
2175 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2177 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2180 * Returns the buffer of a \a pill corresponding to the given \a field from the
2181 * request (if the caller is executing on the server-side) or reply (if the
2182 * caller is executing on the client-side).
2184 * This function convienient for use is code that could be executed on the
2185 * client and server alike.
2187 const void *req_capsule_other_get(struct req_capsule *pill,
2188 const struct req_msg_field *field)
2190 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2192 EXPORT_SYMBOL(req_capsule_other_get);
2195 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2196 * field of the given \a pill.
2198 * This function must be used when constructing variable sized fields of a
2201 void req_capsule_set_size(struct req_capsule *pill,
2202 const struct req_msg_field *field,
2203 enum req_location loc, __u32 size)
2205 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2207 if ((size != (__u32)field->rmf_size) &&
2208 (field->rmf_size != -1) &&
2209 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2211 __u32 rmf_size = (__u32)field->rmf_size;
2212 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2213 (size % rmf_size != 0)) {
2214 CERROR("%s: array field size mismatch "
2215 "%u %% %u != 0 (%d)\n",
2216 field->rmf_name, size, rmf_size, loc);
2218 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2220 CERROR("%s: field size mismatch %u != %u (%d)\n",
2221 field->rmf_name, size, rmf_size, loc);
2226 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2228 EXPORT_SYMBOL(req_capsule_set_size);
2231 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2232 * for the given \a pill's given \a field.
2234 * NB: this function doesn't correspond with req_capsule_set_size(), which
2235 * actually sets the size in pill.rc_area[loc][offset], but this function
2236 * returns the message buflen[offset], maybe we should use another name.
2238 __u32 req_capsule_get_size(const struct req_capsule *pill,
2239 const struct req_msg_field *field,
2240 enum req_location loc)
2242 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2244 return lustre_msg_buflen(__req_msg(pill, loc),
2245 __req_capsule_offset(pill, field, loc));
2247 EXPORT_SYMBOL(req_capsule_get_size);
2250 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2251 * given \a pill's request or reply (\a loc) given the field size recorded in
2252 * the \a pill's rc_area.
2254 * See also req_capsule_set_size().
2256 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2258 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2259 pill->rc_fmt->rf_fields[loc].nr,
2260 pill->rc_area[loc]);
2264 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2265 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2266 * PTLRPC request or reply given only an RQF (\a fmt).
2268 * This function should not be used for formats which contain variable size
2271 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2272 enum req_location loc)
2278 * This function should probably LASSERT() that fmt has no fields with
2279 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2280 * elements in the array there will ultimately be, but then, we could
2281 * assume that there will be at least one element, and that's just what
2284 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2288 for (; i < fmt->rf_fields[loc].nr; ++i)
2289 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2290 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2296 * Changes the format of an RPC.
2298 * The pill must already have been initialized, which means that it already has
2299 * a request format. The new format \a fmt must be an extension of the pill's
2300 * old format. Specifically: the new format must have as many request and reply
2301 * fields as the old one, and all fields shared by the old and new format must
2302 * be at least as large in the new format.
2304 * The new format's fields may be of different "type" than the old format, but
2305 * only for fields that are "opaque" blobs: fields which have a) have no
2306 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2307 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2308 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2309 * according to the key field. When the value, according to the key, contains a
2310 * structure (or array thereof) to be swabbed, the format should be changed to
2311 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2314 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2319 const struct req_format *old;
2321 LASSERT(pill->rc_fmt != NULL);
2322 LASSERT(__req_format_is_sane(fmt));
2326 * Sanity checking...
2328 for (i = 0; i < RCL_NR; ++i) {
2329 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2330 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2331 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2333 /* "opaque" fields can be transmogrified */
2334 if (ofield->rmf_swabber == NULL &&
2335 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2336 (ofield->rmf_size == -1 ||
2337 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2339 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2342 * Last field in old format can be shorter than in new.
2344 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2345 FMT_FIELD(old, i, j)->rmf_size);
2350 EXPORT_SYMBOL(req_capsule_extend);
2353 * This function returns a non-zero value if the given \a field is present in
2354 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2357 int req_capsule_has_field(const struct req_capsule *pill,
2358 const struct req_msg_field *field,
2359 enum req_location loc)
2361 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2363 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2365 EXPORT_SYMBOL(req_capsule_has_field);
2368 * Returns a non-zero value if the given \a field is present in the given \a
2369 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2371 int req_capsule_field_present(const struct req_capsule *pill,
2372 const struct req_msg_field *field,
2373 enum req_location loc)
2377 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2378 LASSERT(req_capsule_has_field(pill, field, loc));
2380 offset = __req_capsule_offset(pill, field, loc);
2381 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2383 EXPORT_SYMBOL(req_capsule_field_present);
2386 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2387 * request or reply (\a loc).
2389 * This is not the opposite of req_capsule_extend().
2391 void req_capsule_shrink(struct req_capsule *pill,
2392 const struct req_msg_field *field,
2394 enum req_location loc)
2396 const struct req_format *fmt;
2397 struct lustre_msg *msg;
2402 LASSERT(fmt != NULL);
2403 LASSERT(__req_format_is_sane(fmt));
2404 LASSERT(req_capsule_has_field(pill, field, loc));
2405 LASSERT(req_capsule_field_present(pill, field, loc));
2407 offset = __req_capsule_offset(pill, field, loc);
2409 msg = __req_msg(pill, loc);
2410 len = lustre_msg_buflen(msg, offset);
2411 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2412 fmt->rf_name, field->rmf_name, len, newlen);
2414 if (loc == RCL_CLIENT)
2415 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2418 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2421 EXPORT_SYMBOL(req_capsule_shrink);
2423 int req_capsule_server_grow(struct req_capsule *pill,
2424 const struct req_msg_field *field,
2427 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2432 LASSERT(pill->rc_fmt != NULL);
2433 LASSERT(__req_format_is_sane(pill->rc_fmt));
2434 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2435 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2437 len = req_capsule_get_size(pill, field, RCL_SERVER);
2438 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2439 if ((__u32)pill->rc_req->rq_repbuf_len >=
2440 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2441 CERROR("Inplace repack might be done\n");
2443 pill->rc_req->rq_reply_state = NULL;
2444 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2445 rc = req_capsule_server_pack(pill);
2447 /* put old rs back, the caller will decide what to do */
2448 pill->rc_req->rq_reply_state = rs;
2451 nrs = pill->rc_req->rq_reply_state;
2452 /* Now we need only buffers, copy first chunk */
2453 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2454 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2455 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2456 memcpy(to, from, len);
2457 /* check if we have tail and copy it too */
2458 if (rs->rs_msg->lm_bufcount > offset + 1) {
2459 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2460 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2461 offset = rs->rs_msg->lm_bufcount - 1;
2462 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2463 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2464 memcpy(to, from, len);
2466 /* drop old reply if everything is fine */
2467 if (rs->rs_difficult) {
2471 nrs->rs_difficult = 1;
2472 nrs->rs_no_ack = rs->rs_no_ack;
2473 for (i = 0; i < rs->rs_nlocks; i++) {
2474 nrs->rs_locks[i] = rs->rs_locks[i];
2475 nrs->rs_modes[i] = rs->rs_modes[i];
2479 rs->rs_difficult = 0;
2482 ptlrpc_rs_decref(rs);
2485 EXPORT_SYMBOL(req_capsule_server_grow);
2486 /* __REQ_LAYOUT_USER__ */