4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
54 #include <linux/module.h>
56 # include <liblustre.h>
59 /* LUSTRE_VERSION_CODE */
60 #include <lustre_ver.h>
62 #include <obd_support.h>
63 /* lustre_swab_mdt_body */
64 #include <lustre/lustre_idl.h>
65 /* obd2cli_tgt() (required by DEBUG_REQ()) */
68 /* __REQ_LAYOUT_USER__ */
70 /* struct ptlrpc_request, lustre_msg* */
71 #include <lustre_req_layout.h>
72 #include <lustre_update.h>
73 #include <lustre_acl.h>
74 #include <lustre_debug.h>
77 * RQFs (see below) refer to two struct req_msg_field arrays describing the
78 * client request and server reply, respectively.
80 /* empty set of fields... for suitable definition of emptiness. */
81 static const struct req_msg_field *empty[] = {
85 static const struct req_msg_field *mgs_target_info_only[] = {
90 static const struct req_msg_field *mgs_set_info[] = {
95 static const struct req_msg_field *mgs_config_read_client[] = {
100 static const struct req_msg_field *mgs_config_read_server[] = {
105 static const struct req_msg_field *log_cancel_client[] = {
110 static const struct req_msg_field *mdt_body_only[] = {
115 static const struct req_msg_field *mdt_body_capa[] = {
121 static const struct req_msg_field *quotactl_only[] = {
126 static const struct req_msg_field *quota_body_only[] = {
131 static const struct req_msg_field *ldlm_intent_quota_client[] = {
138 static const struct req_msg_field *ldlm_intent_quota_server[] = {
145 static const struct req_msg_field *mdt_close_client[] = {
152 static const struct req_msg_field *obd_statfs_server[] = {
157 static const struct req_msg_field *seq_query_client[] = {
163 static const struct req_msg_field *seq_query_server[] = {
168 static const struct req_msg_field *fld_query_client[] = {
174 static const struct req_msg_field *fld_query_server[] = {
179 static const struct req_msg_field *mds_getattr_name_client[] = {
186 static const struct req_msg_field *mds_reint_client[] = {
191 static const struct req_msg_field *mds_reint_create_client[] = {
198 static const struct req_msg_field *mds_reint_create_slave_client[] = {
207 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
216 static const struct req_msg_field *mds_reint_create_sym_client[] = {
225 static const struct req_msg_field *mds_reint_open_client[] = {
234 static const struct req_msg_field *mds_reint_open_server[] = {
243 static const struct req_msg_field *mds_reint_unlink_client[] = {
251 static const struct req_msg_field *mds_reint_link_client[] = {
260 static const struct req_msg_field *mds_reint_rename_client[] = {
270 static const struct req_msg_field *mds_last_unlink_server[] = {
279 static const struct req_msg_field *mds_reint_setattr_client[] = {
289 static const struct req_msg_field *mds_reint_setxattr_client[] = {
297 static const struct req_msg_field *mdt_swap_layouts[] = {
306 static const struct req_msg_field *obd_connect_client[] = {
314 static const struct req_msg_field *obd_connect_server[] = {
319 static const struct req_msg_field *obd_set_info_client[] = {
325 static const struct req_msg_field *ost_grant_shrink_client[] = {
331 static const struct req_msg_field *mds_getinfo_client[] = {
337 static const struct req_msg_field *mds_getinfo_server[] = {
342 static const struct req_msg_field *ldlm_enqueue_client[] = {
347 static const struct req_msg_field *ldlm_enqueue_server[] = {
352 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
358 static const struct req_msg_field *ldlm_cp_callback_client[] = {
364 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
370 static const struct req_msg_field *ldlm_gl_callback_server[] = {
375 static const struct req_msg_field *ldlm_intent_basic_client[] = {
381 static const struct req_msg_field *ldlm_intent_client[] = {
388 static const struct req_msg_field *ldlm_intent_server[] = {
396 static const struct req_msg_field *ldlm_intent_layout_client[] = {
401 &RMF_EADATA /* for new layout to be set up */
403 static const struct req_msg_field *ldlm_intent_open_server[] = {
413 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
417 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
422 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
431 static const struct req_msg_field *ldlm_intent_create_client[] = {
435 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
441 static const struct req_msg_field *ldlm_intent_open_client[] = {
445 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
452 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
456 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
461 static const struct req_msg_field *mds_getxattr_client[] = {
469 static const struct req_msg_field *mds_getxattr_server[] = {
475 static const struct req_msg_field *mds_getattr_server[] = {
484 static const struct req_msg_field *mds_setattr_server[] = {
493 static const struct req_msg_field *mds_update_client[] = {
498 static const struct req_msg_field *mds_update_server[] = {
503 static const struct req_msg_field *llog_origin_handle_create_client[] = {
509 static const struct req_msg_field *llogd_body_only[] = {
514 static const struct req_msg_field *llog_log_hdr_only[] = {
519 static const struct req_msg_field *llogd_conn_body_only[] = {
524 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
530 static const struct req_msg_field *obd_idx_read_client[] = {
535 static const struct req_msg_field *obd_idx_read_server[] = {
540 static const struct req_msg_field *ost_body_only[] = {
545 static const struct req_msg_field *ost_body_capa[] = {
551 static const struct req_msg_field *ost_destroy_client[] = {
559 static const struct req_msg_field *ost_brw_client[] = {
567 static const struct req_msg_field *ost_brw_read_server[] = {
572 static const struct req_msg_field *ost_brw_write_server[] = {
578 static const struct req_msg_field *ost_get_info_generic_server[] = {
583 static const struct req_msg_field *ost_get_info_generic_client[] = {
588 static const struct req_msg_field *ost_get_last_id_server[] = {
593 static const struct req_msg_field *ost_get_last_fid_server[] = {
598 static const struct req_msg_field *ost_get_fiemap_client[] = {
604 static const struct req_msg_field *ost_get_fiemap_server[] = {
609 static const struct req_msg_field *mdt_hsm_progress[] = {
612 &RMF_MDS_HSM_PROGRESS,
615 static const struct req_msg_field *mdt_hsm_ct_register[] = {
618 &RMF_MDS_HSM_ARCHIVE,
621 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
626 static const struct req_msg_field *mdt_hsm_action_server[] = {
629 &RMF_MDS_HSM_CURRENT_ACTION,
632 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
638 static const struct req_msg_field *mdt_hsm_state_set[] = {
645 static const struct req_msg_field *mdt_hsm_request[] = {
648 &RMF_MDS_HSM_REQUEST,
649 &RMF_MDS_HSM_USER_ITEM,
653 static struct req_format *req_formats[] = {
660 &RQF_MGS_CONFIG_READ,
669 &RQF_MDS_GETATTR_NAME,
678 &RQF_MDS_DONE_WRITING,
680 &RQF_MDS_REINT_CREATE,
681 &RQF_MDS_REINT_CREATE_RMT_ACL,
682 &RQF_MDS_REINT_CREATE_SLAVE,
683 &RQF_MDS_REINT_CREATE_SYM,
685 &RQF_MDS_REINT_UNLINK,
687 &RQF_MDS_REINT_RENAME,
688 &RQF_MDS_REINT_SETATTR,
689 &RQF_MDS_REINT_SETXATTR,
692 &RQF_MDS_HSM_PROGRESS,
693 &RQF_MDS_HSM_CT_REGISTER,
694 &RQF_MDS_HSM_CT_UNREGISTER,
695 &RQF_MDS_HSM_STATE_GET,
696 &RQF_MDS_HSM_STATE_SET,
698 &RQF_MDS_HSM_REQUEST,
699 &RQF_MDS_SWAP_LAYOUTS,
715 &RQF_OST_SET_GRANT_INFO,
716 &RQF_OST_GET_INFO_GENERIC,
717 &RQF_OST_GET_INFO_LAST_ID,
718 &RQF_OST_GET_INFO_LAST_FID,
719 &RQF_OST_SET_INFO_LAST_FID,
720 &RQF_OST_GET_INFO_FIEMAP,
722 &RQF_LDLM_ENQUEUE_LVB,
726 &RQF_LDLM_CP_CALLBACK,
727 &RQF_LDLM_BL_CALLBACK,
728 &RQF_LDLM_GL_CALLBACK,
729 &RQF_LDLM_GL_DESC_CALLBACK,
731 &RQF_LDLM_INTENT_BASIC,
732 &RQF_LDLM_INTENT_LAYOUT,
733 &RQF_LDLM_INTENT_GETATTR,
734 &RQF_LDLM_INTENT_OPEN,
735 &RQF_LDLM_INTENT_CREATE,
736 &RQF_LDLM_INTENT_UNLINK,
737 &RQF_LDLM_INTENT_QUOTA,
740 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
741 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
742 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
743 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
744 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
745 &RQF_LLOG_ORIGIN_CONNECT
748 struct req_msg_field {
749 const __u32 rmf_flags;
750 const char *rmf_name;
752 * Field length. (-1) means "variable length". If the
753 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
754 * but the actual size must be a whole multiple of \a rmf_size.
757 void (*rmf_swabber)(void *);
758 void (*rmf_dumper)(void *);
759 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
764 * The field is a string, must be NUL-terminated.
766 RMF_F_STRING = 1 << 0,
768 * The field's buffer size need not match the declared \a rmf_size.
770 RMF_F_NO_SIZE_CHECK = 1 << 1,
772 * The field's buffer size must be a whole multiple of the declared \a
773 * rmf_size and the \a rmf_swabber function must work on the declared \a
774 * rmf_size worth of bytes.
776 RMF_F_STRUCT_ARRAY = 1 << 2
784 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
785 .rmf_name = (name), \
786 .rmf_flags = (flags), \
787 .rmf_size = (size), \
788 .rmf_swabber = (void (*)(void*))(swabber), \
789 .rmf_dumper = (void (*)(void*))(dumper) \
792 struct req_msg_field RMF_GENERIC_DATA =
793 DEFINE_MSGF("generic_data", 0,
795 EXPORT_SYMBOL(RMF_GENERIC_DATA);
797 struct req_msg_field RMF_MGS_TARGET_INFO =
798 DEFINE_MSGF("mgs_target_info", 0,
799 sizeof(struct mgs_target_info),
800 lustre_swab_mgs_target_info, NULL);
801 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
803 struct req_msg_field RMF_MGS_SEND_PARAM =
804 DEFINE_MSGF("mgs_send_param", 0,
805 sizeof(struct mgs_send_param),
807 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
809 struct req_msg_field RMF_MGS_CONFIG_BODY =
810 DEFINE_MSGF("mgs_config_read request", 0,
811 sizeof(struct mgs_config_body),
812 lustre_swab_mgs_config_body, NULL);
813 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
815 struct req_msg_field RMF_MGS_CONFIG_RES =
816 DEFINE_MSGF("mgs_config_read reply ", 0,
817 sizeof(struct mgs_config_res),
818 lustre_swab_mgs_config_res, NULL);
819 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
821 struct req_msg_field RMF_U32 =
822 DEFINE_MSGF("generic u32", 0,
823 sizeof(__u32), lustre_swab_generic_32s, NULL);
824 EXPORT_SYMBOL(RMF_U32);
826 struct req_msg_field RMF_SETINFO_VAL =
827 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
828 EXPORT_SYMBOL(RMF_SETINFO_VAL);
830 struct req_msg_field RMF_GETINFO_KEY =
831 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
832 EXPORT_SYMBOL(RMF_GETINFO_KEY);
834 struct req_msg_field RMF_GETINFO_VALLEN =
835 DEFINE_MSGF("getinfo_vallen", 0,
836 sizeof(__u32), lustre_swab_generic_32s, NULL);
837 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
839 struct req_msg_field RMF_GETINFO_VAL =
840 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
841 EXPORT_SYMBOL(RMF_GETINFO_VAL);
843 struct req_msg_field RMF_SEQ_OPC =
844 DEFINE_MSGF("seq_query_opc", 0,
845 sizeof(__u32), lustre_swab_generic_32s, NULL);
846 EXPORT_SYMBOL(RMF_SEQ_OPC);
848 struct req_msg_field RMF_SEQ_RANGE =
849 DEFINE_MSGF("seq_query_range", 0,
850 sizeof(struct lu_seq_range),
851 lustre_swab_lu_seq_range, NULL);
852 EXPORT_SYMBOL(RMF_SEQ_RANGE);
854 struct req_msg_field RMF_FLD_OPC =
855 DEFINE_MSGF("fld_query_opc", 0,
856 sizeof(__u32), lustre_swab_generic_32s, NULL);
857 EXPORT_SYMBOL(RMF_FLD_OPC);
859 struct req_msg_field RMF_FLD_MDFLD =
860 DEFINE_MSGF("fld_query_mdfld", 0,
861 sizeof(struct lu_seq_range),
862 lustre_swab_lu_seq_range, NULL);
863 EXPORT_SYMBOL(RMF_FLD_MDFLD);
865 struct req_msg_field RMF_MDT_BODY =
866 DEFINE_MSGF("mdt_body", 0,
867 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
868 EXPORT_SYMBOL(RMF_MDT_BODY);
870 struct req_msg_field RMF_OBD_QUOTACTL =
871 DEFINE_MSGF("obd_quotactl", 0,
872 sizeof(struct obd_quotactl),
873 lustre_swab_obd_quotactl, NULL);
874 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
876 struct req_msg_field RMF_QUOTA_BODY =
877 DEFINE_MSGF("quota_body", 0,
878 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
879 EXPORT_SYMBOL(RMF_QUOTA_BODY);
881 struct req_msg_field RMF_MDT_EPOCH =
882 DEFINE_MSGF("mdt_ioepoch", 0,
883 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
884 EXPORT_SYMBOL(RMF_MDT_EPOCH);
886 struct req_msg_field RMF_PTLRPC_BODY =
887 DEFINE_MSGF("ptlrpc_body", 0,
888 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
889 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
891 struct req_msg_field RMF_OBD_STATFS =
892 DEFINE_MSGF("obd_statfs", 0,
893 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
894 EXPORT_SYMBOL(RMF_OBD_STATFS);
896 struct req_msg_field RMF_SETINFO_KEY =
897 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
898 EXPORT_SYMBOL(RMF_SETINFO_KEY);
900 struct req_msg_field RMF_NAME =
901 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
902 EXPORT_SYMBOL(RMF_NAME);
904 struct req_msg_field RMF_SYMTGT =
905 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
906 EXPORT_SYMBOL(RMF_SYMTGT);
908 struct req_msg_field RMF_TGTUUID =
909 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
911 EXPORT_SYMBOL(RMF_TGTUUID);
913 struct req_msg_field RMF_CLUUID =
914 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
916 EXPORT_SYMBOL(RMF_CLUUID);
918 struct req_msg_field RMF_STRING =
919 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
920 EXPORT_SYMBOL(RMF_STRING);
922 struct req_msg_field RMF_LLOGD_BODY =
923 DEFINE_MSGF("llogd_body", 0,
924 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
925 EXPORT_SYMBOL(RMF_LLOGD_BODY);
927 struct req_msg_field RMF_LLOG_LOG_HDR =
928 DEFINE_MSGF("llog_log_hdr", 0,
929 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
930 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
932 struct req_msg_field RMF_LLOGD_CONN_BODY =
933 DEFINE_MSGF("llogd_conn_body", 0,
934 sizeof(struct llogd_conn_body),
935 lustre_swab_llogd_conn_body, NULL);
936 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
939 * connection handle received in MDS_CONNECT request.
941 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
942 * that the client does not interpret at all.
944 struct req_msg_field RMF_CONN =
945 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
946 EXPORT_SYMBOL(RMF_CONN);
948 struct req_msg_field RMF_CONNECT_DATA =
950 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
951 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
952 sizeof(struct obd_connect_data),
954 /* For interoperability with 1.8 and 2.0 clients/servers.
955 * The RPC verification code allows larger RPC buffers, but not
956 * smaller buffers. Until we no longer need to keep compatibility
957 * with older servers/clients we can only check that the buffer
958 * size is at least as large as obd_connect_data_v1. That is not
959 * not in itself harmful, since the chance of just corrupting this
960 * field is low. See JIRA LU-16 for details. */
961 sizeof(struct obd_connect_data_v1),
963 lustre_swab_connect, NULL);
964 EXPORT_SYMBOL(RMF_CONNECT_DATA);
966 struct req_msg_field RMF_DLM_REQ =
967 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
968 sizeof(struct ldlm_request),
969 lustre_swab_ldlm_request, NULL);
970 EXPORT_SYMBOL(RMF_DLM_REQ);
972 struct req_msg_field RMF_DLM_REP =
973 DEFINE_MSGF("dlm_rep", 0,
974 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
975 EXPORT_SYMBOL(RMF_DLM_REP);
977 struct req_msg_field RMF_LDLM_INTENT =
978 DEFINE_MSGF("ldlm_intent", 0,
979 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
980 EXPORT_SYMBOL(RMF_LDLM_INTENT);
982 struct req_msg_field RMF_DLM_LVB =
983 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
984 EXPORT_SYMBOL(RMF_DLM_LVB);
986 struct req_msg_field RMF_DLM_GL_DESC =
987 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
988 lustre_swab_gl_desc, NULL);
989 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
991 struct req_msg_field RMF_MDT_MD =
992 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
993 EXPORT_SYMBOL(RMF_MDT_MD);
995 struct req_msg_field RMF_REC_REINT =
996 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
997 lustre_swab_mdt_rec_reint, NULL);
998 EXPORT_SYMBOL(RMF_REC_REINT);
1000 /* FIXME: this length should be defined as a macro */
1001 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1003 EXPORT_SYMBOL(RMF_EADATA);
1005 struct req_msg_field RMF_ACL =
1006 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1007 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1008 EXPORT_SYMBOL(RMF_ACL);
1010 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1011 struct req_msg_field RMF_LOGCOOKIES =
1012 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1013 sizeof(struct llog_cookie), NULL, NULL);
1014 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1016 struct req_msg_field RMF_CAPA1 =
1017 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1018 lustre_swab_lustre_capa, NULL);
1019 EXPORT_SYMBOL(RMF_CAPA1);
1021 struct req_msg_field RMF_CAPA2 =
1022 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1023 lustre_swab_lustre_capa, NULL);
1024 EXPORT_SYMBOL(RMF_CAPA2);
1026 struct req_msg_field RMF_LAYOUT_INTENT =
1027 DEFINE_MSGF("layout_intent", 0,
1028 sizeof(struct layout_intent), lustre_swab_layout_intent,
1030 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1033 * OST request field.
1035 struct req_msg_field RMF_OST_BODY =
1036 DEFINE_MSGF("ost_body", 0,
1037 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1038 EXPORT_SYMBOL(RMF_OST_BODY);
1040 struct req_msg_field RMF_OBD_IOOBJ =
1041 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1042 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1043 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1045 struct req_msg_field RMF_NIOBUF_REMOTE =
1046 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1047 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1049 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1051 struct req_msg_field RMF_RCS =
1052 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1053 lustre_swab_generic_32s, dump_rcs);
1054 EXPORT_SYMBOL(RMF_RCS);
1056 struct req_msg_field RMF_OBD_ID =
1057 DEFINE_MSGF("obd_id", 0,
1058 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1059 EXPORT_SYMBOL(RMF_OBD_ID);
1061 struct req_msg_field RMF_FID =
1062 DEFINE_MSGF("fid", 0,
1063 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1064 EXPORT_SYMBOL(RMF_FID);
1066 struct req_msg_field RMF_OST_ID =
1067 DEFINE_MSGF("ost_id", 0,
1068 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1069 EXPORT_SYMBOL(RMF_OST_ID);
1071 struct req_msg_field RMF_FIEMAP_KEY =
1072 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1073 lustre_swab_fiemap, NULL);
1074 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1076 struct req_msg_field RMF_FIEMAP_VAL =
1077 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1078 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1080 struct req_msg_field RMF_IDX_INFO =
1081 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1082 lustre_swab_idx_info, NULL);
1083 EXPORT_SYMBOL(RMF_IDX_INFO);
1084 struct req_msg_field RMF_HSM_USER_STATE =
1085 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1086 lustre_swab_hsm_user_state, NULL);
1087 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1089 struct req_msg_field RMF_HSM_STATE_SET =
1090 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1091 lustre_swab_hsm_state_set, NULL);
1092 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1094 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1095 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1096 lustre_swab_hsm_progress_kernel, NULL);
1097 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1099 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1100 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1101 lustre_swab_hsm_current_action, NULL);
1102 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1104 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1105 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1106 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1108 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1110 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1111 DEFINE_MSGF("hsm_archive", 0,
1112 sizeof(__u32), lustre_swab_generic_32s, NULL);
1113 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1115 struct req_msg_field RMF_MDS_HSM_REQUEST =
1116 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1117 lustre_swab_hsm_request, NULL);
1118 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1120 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1121 lustre_swab_update_buf, NULL);
1122 EXPORT_SYMBOL(RMF_UPDATE);
1124 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1125 lustre_swab_update_reply_buf,
1127 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1129 struct req_msg_field RMF_SWAP_LAYOUTS =
1130 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1131 lustre_swab_swap_layouts, NULL);
1132 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1138 const char *rf_name;
1142 const struct req_msg_field **d;
1143 } rf_fields[RCL_NR];
1146 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1160 #define DEFINE_REQ_FMT0(name, client, server) \
1161 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1163 struct req_format RQF_OBD_PING =
1164 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1165 EXPORT_SYMBOL(RQF_OBD_PING);
1167 struct req_format RQF_OBD_SET_INFO =
1168 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1169 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1171 /* Read index file through the network */
1172 struct req_format RQF_OBD_IDX_READ =
1173 DEFINE_REQ_FMT0("OBD_IDX_READ",
1174 obd_idx_read_client, obd_idx_read_server);
1175 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1177 struct req_format RQF_SEC_CTX =
1178 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1179 EXPORT_SYMBOL(RQF_SEC_CTX);
1181 struct req_format RQF_MGS_TARGET_REG =
1182 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1183 mgs_target_info_only);
1184 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1186 struct req_format RQF_MGS_SET_INFO =
1187 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1189 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1191 struct req_format RQF_MGS_CONFIG_READ =
1192 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1193 mgs_config_read_server);
1194 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1196 struct req_format RQF_SEQ_QUERY =
1197 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1198 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1200 struct req_format RQF_FLD_QUERY =
1201 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1202 EXPORT_SYMBOL(RQF_FLD_QUERY);
1204 struct req_format RQF_LOG_CANCEL =
1205 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1206 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1208 struct req_format RQF_MDS_QUOTACHECK =
1209 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1210 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1212 struct req_format RQF_OST_QUOTACHECK =
1213 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1214 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1216 struct req_format RQF_MDS_QUOTACTL =
1217 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1218 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1220 struct req_format RQF_OST_QUOTACTL =
1221 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1222 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1224 struct req_format RQF_QC_CALLBACK =
1225 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1226 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1228 struct req_format RQF_QUOTA_DQACQ =
1229 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1230 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1232 struct req_format RQF_LDLM_INTENT_QUOTA =
1233 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1234 ldlm_intent_quota_client,
1235 ldlm_intent_quota_server);
1236 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1238 struct req_format RQF_MDS_GETSTATUS =
1239 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1240 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1242 struct req_format RQF_MDS_STATFS =
1243 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1244 EXPORT_SYMBOL(RQF_MDS_STATFS);
1246 struct req_format RQF_MDS_SYNC =
1247 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1248 EXPORT_SYMBOL(RQF_MDS_SYNC);
1250 struct req_format RQF_MDS_GETATTR =
1251 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1252 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1254 struct req_format RQF_MDS_GETXATTR =
1255 DEFINE_REQ_FMT0("MDS_GETXATTR",
1256 mds_getxattr_client, mds_getxattr_server);
1257 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1259 struct req_format RQF_MDS_GETATTR_NAME =
1260 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1261 mds_getattr_name_client, mds_getattr_server);
1262 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1264 struct req_format RQF_MDS_REINT =
1265 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1266 EXPORT_SYMBOL(RQF_MDS_REINT);
1268 struct req_format RQF_MDS_REINT_CREATE =
1269 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1270 mds_reint_create_client, mdt_body_capa);
1271 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1273 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1274 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1275 mds_reint_create_rmt_acl_client, mdt_body_capa);
1276 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1278 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1279 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1280 mds_reint_create_slave_client, mdt_body_capa);
1281 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1283 struct req_format RQF_MDS_REINT_CREATE_SYM =
1284 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1285 mds_reint_create_sym_client, mdt_body_capa);
1286 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1288 struct req_format RQF_MDS_REINT_OPEN =
1289 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1290 mds_reint_open_client, mds_reint_open_server);
1291 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1293 struct req_format RQF_MDS_REINT_UNLINK =
1294 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1295 mds_last_unlink_server);
1296 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1298 struct req_format RQF_MDS_REINT_LINK =
1299 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1300 mds_reint_link_client, mdt_body_only);
1301 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1303 struct req_format RQF_MDS_REINT_RENAME =
1304 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1305 mds_last_unlink_server);
1306 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1308 struct req_format RQF_MDS_REINT_SETATTR =
1309 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1310 mds_reint_setattr_client, mds_setattr_server);
1311 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1313 struct req_format RQF_MDS_REINT_SETXATTR =
1314 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1315 mds_reint_setxattr_client, mdt_body_only);
1316 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1318 struct req_format RQF_MDS_CONNECT =
1319 DEFINE_REQ_FMT0("MDS_CONNECT",
1320 obd_connect_client, obd_connect_server);
1321 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1323 struct req_format RQF_MDS_DISCONNECT =
1324 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1325 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1327 struct req_format RQF_MDS_GET_INFO =
1328 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1329 mds_getinfo_server);
1330 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1332 struct req_format RQF_UPDATE_OBJ =
1333 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1335 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1337 struct req_format RQF_LDLM_ENQUEUE =
1338 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1339 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1340 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1342 struct req_format RQF_LDLM_ENQUEUE_LVB =
1343 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1344 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1345 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1347 struct req_format RQF_LDLM_CONVERT =
1348 DEFINE_REQ_FMT0("LDLM_CONVERT",
1349 ldlm_enqueue_client, ldlm_enqueue_server);
1350 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1352 struct req_format RQF_LDLM_CANCEL =
1353 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1354 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1356 struct req_format RQF_LDLM_CALLBACK =
1357 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1358 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1360 struct req_format RQF_LDLM_CP_CALLBACK =
1361 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1362 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1364 struct req_format RQF_LDLM_BL_CALLBACK =
1365 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1366 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1368 struct req_format RQF_LDLM_GL_CALLBACK =
1369 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1370 ldlm_gl_callback_server);
1371 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1373 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1374 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1375 ldlm_gl_callback_server);
1376 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1378 struct req_format RQF_LDLM_INTENT_BASIC =
1379 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1380 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1381 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1383 struct req_format RQF_LDLM_INTENT =
1384 DEFINE_REQ_FMT0("LDLM_INTENT",
1385 ldlm_intent_client, ldlm_intent_server);
1386 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1388 struct req_format RQF_LDLM_INTENT_LAYOUT =
1389 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1390 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1391 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1393 struct req_format RQF_LDLM_INTENT_GETATTR =
1394 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1395 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1396 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1398 struct req_format RQF_LDLM_INTENT_OPEN =
1399 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1400 ldlm_intent_open_client, ldlm_intent_open_server);
1401 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1403 struct req_format RQF_LDLM_INTENT_CREATE =
1404 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1405 ldlm_intent_create_client, ldlm_intent_getattr_server);
1406 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1408 struct req_format RQF_LDLM_INTENT_UNLINK =
1409 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1410 ldlm_intent_unlink_client, ldlm_intent_server);
1411 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1413 struct req_format RQF_MDS_CLOSE =
1414 DEFINE_REQ_FMT0("MDS_CLOSE",
1415 mdt_close_client, mds_last_unlink_server);
1416 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1418 struct req_format RQF_MDS_PIN =
1419 DEFINE_REQ_FMT0("MDS_PIN",
1420 mdt_body_capa, mdt_body_only);
1421 EXPORT_SYMBOL(RQF_MDS_PIN);
1423 struct req_format RQF_MDS_UNPIN =
1424 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1425 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1427 struct req_format RQF_MDS_DONE_WRITING =
1428 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1429 mdt_close_client, mdt_body_only);
1430 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1432 struct req_format RQF_MDS_READPAGE =
1433 DEFINE_REQ_FMT0("MDS_READPAGE",
1434 mdt_body_capa, mdt_body_only);
1435 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1437 struct req_format RQF_MDS_HSM_ACTION =
1438 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1439 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1441 struct req_format RQF_MDS_HSM_PROGRESS =
1442 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1443 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1445 struct req_format RQF_MDS_HSM_CT_REGISTER =
1446 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1447 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1449 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1450 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1451 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1453 struct req_format RQF_MDS_HSM_STATE_GET =
1454 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1455 mdt_body_capa, mdt_hsm_state_get_server);
1456 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1458 struct req_format RQF_MDS_HSM_STATE_SET =
1459 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1460 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1462 struct req_format RQF_MDS_HSM_REQUEST =
1463 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1464 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1466 struct req_format RQF_MDS_SWAP_LAYOUTS =
1467 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1468 mdt_swap_layouts, empty);
1469 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1471 /* This is for split */
1472 struct req_format RQF_MDS_WRITEPAGE =
1473 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1474 mdt_body_capa, mdt_body_only);
1475 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1477 struct req_format RQF_MDS_IS_SUBDIR =
1478 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1479 mdt_body_only, mdt_body_only);
1480 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1482 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1483 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1484 llog_origin_handle_create_client, llogd_body_only);
1485 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1487 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1488 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1489 llogd_body_only, llogd_body_only);
1490 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1492 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1493 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1494 llogd_body_only, llog_origin_handle_next_block_server);
1495 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1497 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1498 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1499 llogd_body_only, llog_origin_handle_next_block_server);
1500 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1502 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1503 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1504 llogd_body_only, llog_log_hdr_only);
1505 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1507 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1508 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1509 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1511 struct req_format RQF_OST_CONNECT =
1512 DEFINE_REQ_FMT0("OST_CONNECT",
1513 obd_connect_client, obd_connect_server);
1514 EXPORT_SYMBOL(RQF_OST_CONNECT);
1516 struct req_format RQF_OST_DISCONNECT =
1517 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1518 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1520 struct req_format RQF_OST_GETATTR =
1521 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1522 EXPORT_SYMBOL(RQF_OST_GETATTR);
1524 struct req_format RQF_OST_SETATTR =
1525 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1526 EXPORT_SYMBOL(RQF_OST_SETATTR);
1528 struct req_format RQF_OST_CREATE =
1529 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1530 EXPORT_SYMBOL(RQF_OST_CREATE);
1532 struct req_format RQF_OST_PUNCH =
1533 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1534 EXPORT_SYMBOL(RQF_OST_PUNCH);
1536 struct req_format RQF_OST_SYNC =
1537 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1538 EXPORT_SYMBOL(RQF_OST_SYNC);
1540 struct req_format RQF_OST_DESTROY =
1541 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1542 EXPORT_SYMBOL(RQF_OST_DESTROY);
1544 struct req_format RQF_OST_BRW_READ =
1545 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1546 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1548 struct req_format RQF_OST_BRW_WRITE =
1549 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1550 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1552 struct req_format RQF_OST_STATFS =
1553 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1554 EXPORT_SYMBOL(RQF_OST_STATFS);
1556 struct req_format RQF_OST_SET_GRANT_INFO =
1557 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1559 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1561 struct req_format RQF_OST_GET_INFO_GENERIC =
1562 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1563 ost_get_info_generic_server);
1564 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1566 struct req_format RQF_OST_GET_INFO_LAST_ID =
1567 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1568 ost_get_last_id_server);
1569 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1571 struct req_format RQF_OST_GET_INFO_LAST_FID =
1572 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", obd_set_info_client,
1573 ost_get_last_fid_server);
1574 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1576 struct req_format RQF_OST_SET_INFO_LAST_FID =
1577 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1579 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1581 struct req_format RQF_OST_GET_INFO_FIEMAP =
1582 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1583 ost_get_fiemap_server);
1584 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1586 #if !defined(__REQ_LAYOUT_USER__)
1588 /* Convenience macro */
1589 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1592 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1593 * field of RQFs and the \a rmf_offset field of RMFs.
1595 int req_layout_init(void)
1600 struct req_format *rf = NULL;
1602 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1603 rf = req_formats[i];
1605 for (j = 0; j < RCL_NR; ++j) {
1606 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1607 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1608 struct req_msg_field *field;
1610 field = (typeof(field))rf->rf_fields[j].d[k];
1611 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1612 || field->rmf_size > 0);
1613 LASSERT(field->rmf_offset[i][j] == 0);
1615 * k + 1 to detect unused format/field
1618 field->rmf_offset[i][j] = k + 1;
1624 EXPORT_SYMBOL(req_layout_init);
1626 void req_layout_fini(void)
1629 EXPORT_SYMBOL(req_layout_fini);
1632 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1634 * Actual/expected field sizes are set elsewhere in functions in this file:
1635 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1636 * req_capsule_msg_size(). The \a rc_area information is used by.
1637 * ptlrpc_request_set_replen().
1639 void req_capsule_init_area(struct req_capsule *pill)
1643 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1644 pill->rc_area[RCL_CLIENT][i] = -1;
1645 pill->rc_area[RCL_SERVER][i] = -1;
1648 EXPORT_SYMBOL(req_capsule_init_area);
1651 * Initialize a pill.
1653 * The \a location indicates whether the caller is executing on the client side
1654 * (RCL_CLIENT) or server side (RCL_SERVER)..
1656 void req_capsule_init(struct req_capsule *pill,
1657 struct ptlrpc_request *req,
1658 enum req_location location)
1660 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1663 * Today all capsules are embedded in ptlrpc_request structs,
1664 * but just in case that ever isn't the case, we don't reach
1665 * into req unless req != NULL and pill is the one embedded in
1668 * The req->rq_pill_init flag makes it safe to initialize a pill
1669 * twice, which might happen in the OST paths as a result of the
1670 * high-priority RPC queue getting peeked at before ost_handle()
1671 * handles an OST RPC.
1673 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1676 memset(pill, 0, sizeof *pill);
1678 pill->rc_loc = location;
1679 req_capsule_init_area(pill);
1681 if (req != NULL && pill == &req->rq_pill)
1682 req->rq_pill_init = 1;
1684 EXPORT_SYMBOL(req_capsule_init);
1686 void req_capsule_fini(struct req_capsule *pill)
1689 EXPORT_SYMBOL(req_capsule_fini);
1691 static int __req_format_is_sane(const struct req_format *fmt)
1694 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1695 req_formats[fmt->rf_idx] == fmt;
1698 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1699 enum req_location loc)
1701 struct ptlrpc_request *req;
1704 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1708 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1709 * (see req_capsule_extend()).
1711 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1713 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1714 LASSERT(__req_format_is_sane(fmt));
1718 EXPORT_SYMBOL(req_capsule_set);
1721 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1724 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1725 * variable-sized fields. The field sizes come from the declared \a rmf_size
1726 * field of a \a pill's \a rc_fmt's RMF's.
1728 int req_capsule_filled_sizes(struct req_capsule *pill,
1729 enum req_location loc)
1731 const struct req_format *fmt = pill->rc_fmt;
1734 LASSERT(fmt != NULL);
1736 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1737 if (pill->rc_area[loc][i] == -1) {
1738 pill->rc_area[loc][i] =
1739 fmt->rf_fields[loc].d[i]->rmf_size;
1740 if (pill->rc_area[loc][i] == -1) {
1742 * Skip the following fields.
1744 * If this LASSERT() trips then you're missing a
1745 * call to req_capsule_set_size().
1747 LASSERT(loc != RCL_SERVER);
1754 EXPORT_SYMBOL(req_capsule_filled_sizes);
1757 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1759 * This function uses the \a pill's \a rc_area as filled in by
1760 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1763 int req_capsule_server_pack(struct req_capsule *pill)
1765 const struct req_format *fmt;
1769 LASSERT(pill->rc_loc == RCL_SERVER);
1771 LASSERT(fmt != NULL);
1773 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1774 rc = lustre_pack_reply(pill->rc_req, count,
1775 pill->rc_area[RCL_SERVER], NULL);
1777 DEBUG_REQ(D_ERROR, pill->rc_req,
1778 "Cannot pack %d fields in format `%s': ",
1779 count, fmt->rf_name);
1783 EXPORT_SYMBOL(req_capsule_server_pack);
1786 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1787 * corresponding to the given RMF (\a field).
1789 static int __req_capsule_offset(const struct req_capsule *pill,
1790 const struct req_msg_field *field,
1791 enum req_location loc)
1795 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1796 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1797 pill->rc_fmt->rf_name,
1798 field->rmf_name, offset, loc);
1801 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1806 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1811 swabber_dumper_helper(struct req_capsule *pill,
1812 const struct req_msg_field *field,
1813 enum req_location loc,
1815 void *value, int len, int dump, void (*swabber)( void *))
1821 int inout = loc == RCL_CLIENT;
1823 swabber = swabber ?: field->rmf_swabber;
1825 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1826 swabber != NULL && value != NULL)
1831 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1832 if (dump && field->rmf_dumper) {
1833 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1834 do_swab ? "unswabbed " : "", field->rmf_name);
1835 field->rmf_dumper(value);
1840 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1842 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1843 "follows\n", field->rmf_name);
1844 field->rmf_dumper(value);
1851 * We're swabbing an array; swabber() swabs a single array element, so
1852 * swab every element.
1854 LASSERT((len % field->rmf_size) == 0);
1855 for (p = value, i = 0, n = len / field->rmf_size;
1857 i++, p += field->rmf_size) {
1858 if (dump && field->rmf_dumper) {
1859 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1860 "element %d follows\n",
1861 do_swab ? "unswabbed " : "", field->rmf_name, i);
1862 field->rmf_dumper(p);
1867 if (dump && field->rmf_dumper) {
1868 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1869 "element %d follows\n", field->rmf_name, i);
1870 field->rmf_dumper(value);
1874 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1878 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1879 * corresponding to the given RMF (\a field).
1881 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1882 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1883 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1884 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1885 * element of the array swabbed.
1887 static void *__req_capsule_get(struct req_capsule *pill,
1888 const struct req_msg_field *field,
1889 enum req_location loc,
1890 void (*swabber)( void *),
1893 const struct req_format *fmt;
1894 struct lustre_msg *msg;
1899 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1901 static const char *rcl_names[RCL_NR] = {
1902 [RCL_CLIENT] = "client",
1903 [RCL_SERVER] = "server"
1906 LASSERT(pill != NULL);
1907 LASSERT(pill != LP_POISON);
1909 LASSERT(fmt != NULL);
1910 LASSERT(fmt != LP_POISON);
1911 LASSERT(__req_format_is_sane(fmt));
1913 offset = __req_capsule_offset(pill, field, loc);
1915 msg = __req_msg(pill, loc);
1916 LASSERT(msg != NULL);
1918 getter = (field->rmf_flags & RMF_F_STRING) ?
1919 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1921 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1923 * We've already asserted that field->rmf_size > 0 in
1924 * req_layout_init().
1926 len = lustre_msg_buflen(msg, offset);
1927 if ((len % field->rmf_size) != 0) {
1928 CERROR("%s: array field size mismatch "
1929 "%d modulo %d != 0 (%d)\n",
1930 field->rmf_name, len, field->rmf_size, loc);
1933 } else if (pill->rc_area[loc][offset] != -1) {
1934 len = pill->rc_area[loc][offset];
1936 len = max(field->rmf_size, 0);
1938 value = getter(msg, offset, len);
1940 if (value == NULL) {
1941 DEBUG_REQ(D_ERROR, pill->rc_req,
1942 "Wrong buffer for field `%s' (%d of %d) "
1943 "in format `%s': %d vs. %d (%s)\n",
1944 field->rmf_name, offset, lustre_msg_bufcount(msg),
1945 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1948 swabber_dumper_helper(pill, field, loc, offset, value, len,
1956 * Dump a request and/or reply
1958 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1960 const struct req_format *fmt;
1961 const struct req_msg_field *field;
1967 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1968 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1969 field = FMT_FIELD(fmt, loc, i);
1970 if (field->rmf_dumper == NULL) {
1972 * FIXME Add a default hex dumper for fields that don't
1973 * have a specific dumper
1975 len = req_capsule_get_size(pill, field, loc);
1976 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1977 "field size is %d\n", field->rmf_name, len);
1979 /* It's the dumping side-effect that we're interested in */
1980 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1983 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1989 void req_capsule_client_dump(struct req_capsule *pill)
1991 __req_capsule_dump(pill, RCL_CLIENT);
1993 EXPORT_SYMBOL(req_capsule_client_dump);
1998 void req_capsule_server_dump(struct req_capsule *pill)
2000 __req_capsule_dump(pill, RCL_SERVER);
2002 EXPORT_SYMBOL(req_capsule_server_dump);
2005 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2006 * buffer corresponding to the given RMF (\a field) of a \a pill.
2008 void *req_capsule_client_get(struct req_capsule *pill,
2009 const struct req_msg_field *field)
2011 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2013 EXPORT_SYMBOL(req_capsule_client_get);
2016 * Same as req_capsule_client_get(), but with a \a swabber argument.
2018 * Currently unused; will be removed when req_capsule_server_swab_get() is
2021 void *req_capsule_client_swab_get(struct req_capsule *pill,
2022 const struct req_msg_field *field,
2025 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2027 EXPORT_SYMBOL(req_capsule_client_swab_get);
2030 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2032 * First the \a pill's request \a field's size is set (\a rc_area) using
2033 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2036 void *req_capsule_client_sized_get(struct req_capsule *pill,
2037 const struct req_msg_field *field,
2040 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2041 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2043 EXPORT_SYMBOL(req_capsule_client_sized_get);
2046 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2047 * buffer corresponding to the given RMF (\a field) of a \a pill.
2049 void *req_capsule_server_get(struct req_capsule *pill,
2050 const struct req_msg_field *field)
2052 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2054 EXPORT_SYMBOL(req_capsule_server_get);
2057 * Same as req_capsule_server_get(), but with a \a swabber argument.
2059 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2060 * swabbing done outside this capsule abstraction.
2062 void *req_capsule_server_swab_get(struct req_capsule *pill,
2063 const struct req_msg_field *field,
2066 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2068 EXPORT_SYMBOL(req_capsule_server_swab_get);
2071 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2073 * First the \a pill's request \a field's size is set (\a rc_area) using
2074 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2077 void *req_capsule_server_sized_get(struct req_capsule *pill,
2078 const struct req_msg_field *field,
2081 req_capsule_set_size(pill, field, RCL_SERVER, len);
2082 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2084 EXPORT_SYMBOL(req_capsule_server_sized_get);
2086 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2087 const struct req_msg_field *field,
2088 int len, void *swabber)
2090 req_capsule_set_size(pill, field, RCL_SERVER, len);
2091 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2093 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2096 * Returns the buffer of a \a pill corresponding to the given \a field from the
2097 * request (if the caller is executing on the server-side) or reply (if the
2098 * caller is executing on the client-side).
2100 * This function convienient for use is code that could be executed on the
2101 * client and server alike.
2103 const void *req_capsule_other_get(struct req_capsule *pill,
2104 const struct req_msg_field *field)
2106 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2108 EXPORT_SYMBOL(req_capsule_other_get);
2111 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2112 * field of the given \a pill.
2114 * This function must be used when constructing variable sized fields of a
2117 void req_capsule_set_size(struct req_capsule *pill,
2118 const struct req_msg_field *field,
2119 enum req_location loc, int size)
2121 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2123 if ((size != field->rmf_size) &&
2124 (field->rmf_size != -1) &&
2125 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2127 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2128 (size % field->rmf_size != 0)) {
2129 CERROR("%s: array field size mismatch "
2130 "%d %% %d != 0 (%d)\n",
2131 field->rmf_name, size, field->rmf_size, loc);
2133 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2134 size < field->rmf_size) {
2135 CERROR("%s: field size mismatch %d != %d (%d)\n",
2136 field->rmf_name, size, field->rmf_size, loc);
2141 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2143 EXPORT_SYMBOL(req_capsule_set_size);
2146 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2147 * for the given \a pill's given \a field.
2149 * NB: this function doesn't correspond with req_capsule_set_size(), which
2150 * actually sets the size in pill.rc_area[loc][offset], but this function
2151 * returns the message buflen[offset], maybe we should use another name.
2153 int req_capsule_get_size(const struct req_capsule *pill,
2154 const struct req_msg_field *field,
2155 enum req_location loc)
2157 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2159 return lustre_msg_buflen(__req_msg(pill, loc),
2160 __req_capsule_offset(pill, field, loc));
2162 EXPORT_SYMBOL(req_capsule_get_size);
2165 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2166 * given \a pill's request or reply (\a loc) given the field size recorded in
2167 * the \a pill's rc_area.
2169 * See also req_capsule_set_size().
2171 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2173 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2174 pill->rc_fmt->rf_fields[loc].nr,
2175 pill->rc_area[loc]);
2179 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2180 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2181 * PTLRPC request or reply given only an RQF (\a fmt).
2183 * This function should not be used for formats which contain variable size
2186 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2187 enum req_location loc)
2192 * This function should probably LASSERT() that fmt has no fields with
2193 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2194 * elements in the array there will ultimately be, but then, we could
2195 * assume that there will be at least one element, and that's just what
2198 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2202 for (; i < fmt->rf_fields[loc].nr; ++i)
2203 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2204 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2210 * Changes the format of an RPC.
2212 * The pill must already have been initialized, which means that it already has
2213 * a request format. The new format \a fmt must be an extension of the pill's
2214 * old format. Specifically: the new format must have as many request and reply
2215 * fields as the old one, and all fields shared by the old and new format must
2216 * be at least as large in the new format.
2218 * The new format's fields may be of different "type" than the old format, but
2219 * only for fields that are "opaque" blobs: fields which have a) have no
2220 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2221 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2222 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2223 * according to the key field. When the value, according to the key, contains a
2224 * structure (or array thereof) to be swabbed, the format should be changed to
2225 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2228 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2233 const struct req_format *old;
2235 LASSERT(pill->rc_fmt != NULL);
2236 LASSERT(__req_format_is_sane(fmt));
2240 * Sanity checking...
2242 for (i = 0; i < RCL_NR; ++i) {
2243 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2244 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2245 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2247 /* "opaque" fields can be transmogrified */
2248 if (ofield->rmf_swabber == NULL &&
2249 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2250 (ofield->rmf_size == -1 ||
2251 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2253 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2256 * Last field in old format can be shorter than in new.
2258 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2259 FMT_FIELD(old, i, j)->rmf_size);
2264 EXPORT_SYMBOL(req_capsule_extend);
2267 * This function returns a non-zero value if the given \a field is present in
2268 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2271 int req_capsule_has_field(const struct req_capsule *pill,
2272 const struct req_msg_field *field,
2273 enum req_location loc)
2275 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2277 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2279 EXPORT_SYMBOL(req_capsule_has_field);
2282 * Returns a non-zero value if the given \a field is present in the given \a
2283 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2285 int req_capsule_field_present(const struct req_capsule *pill,
2286 const struct req_msg_field *field,
2287 enum req_location loc)
2291 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2292 LASSERT(req_capsule_has_field(pill, field, loc));
2294 offset = __req_capsule_offset(pill, field, loc);
2295 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2297 EXPORT_SYMBOL(req_capsule_field_present);
2300 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2301 * request or reply (\a loc).
2303 * This is not the opposite of req_capsule_extend().
2305 void req_capsule_shrink(struct req_capsule *pill,
2306 const struct req_msg_field *field,
2307 unsigned int newlen,
2308 enum req_location loc)
2310 const struct req_format *fmt;
2311 struct lustre_msg *msg;
2316 LASSERT(fmt != NULL);
2317 LASSERT(__req_format_is_sane(fmt));
2318 LASSERT(req_capsule_has_field(pill, field, loc));
2319 LASSERT(req_capsule_field_present(pill, field, loc));
2321 offset = __req_capsule_offset(pill, field, loc);
2323 msg = __req_msg(pill, loc);
2324 len = lustre_msg_buflen(msg, offset);
2325 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2326 fmt->rf_name, field->rmf_name, len, newlen);
2328 if (loc == RCL_CLIENT)
2329 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2332 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2335 EXPORT_SYMBOL(req_capsule_shrink);
2337 int req_capsule_server_grow(struct req_capsule *pill,
2338 const struct req_msg_field *field,
2339 unsigned int newlen)
2341 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2343 int offset, len, rc;
2345 LASSERT(pill->rc_fmt != NULL);
2346 LASSERT(__req_format_is_sane(pill->rc_fmt));
2347 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2348 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2350 len = req_capsule_get_size(pill, field, RCL_SERVER);
2351 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2352 if (pill->rc_req->rq_repbuf_len >=
2353 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2354 CERROR("Inplace repack might be done\n");
2356 pill->rc_req->rq_reply_state = NULL;
2357 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2358 rc = req_capsule_server_pack(pill);
2360 /* put old rs back, the caller will decide what to do */
2361 pill->rc_req->rq_reply_state = rs;
2364 nrs = pill->rc_req->rq_reply_state;
2365 /* Now we need only buffers, copy first chunk */
2366 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2367 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2368 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2369 memcpy(to, from, len);
2370 /* check if we have tail and copy it too */
2371 if (rs->rs_msg->lm_bufcount > offset + 1) {
2372 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2373 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2374 offset = rs->rs_msg->lm_bufcount - 1;
2375 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2376 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2377 memcpy(to, from, len);
2379 /* drop old reply if everything is fine */
2380 if (rs->rs_difficult) {
2384 nrs->rs_difficult = 1;
2385 nrs->rs_no_ack = rs->rs_no_ack;
2386 for (i = 0; i < rs->rs_nlocks; i++) {
2387 nrs->rs_locks[i] = rs->rs_locks[i];
2388 nrs->rs_modes[i] = rs->rs_modes[i];
2392 rs->rs_difficult = 0;
2395 ptlrpc_rs_decref(rs);
2398 EXPORT_SYMBOL(req_capsule_server_grow);
2399 /* __REQ_LAYOUT_USER__ */