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 *mdt_release_close_client[] = {
160 static const struct req_msg_field *obd_statfs_server[] = {
165 static const struct req_msg_field *seq_query_client[] = {
171 static const struct req_msg_field *seq_query_server[] = {
176 static const struct req_msg_field *fld_query_client[] = {
182 static const struct req_msg_field *fld_query_server[] = {
187 static const struct req_msg_field *mds_getattr_name_client[] = {
194 static const struct req_msg_field *mds_reint_client[] = {
199 static const struct req_msg_field *mds_reint_create_client[] = {
206 static const struct req_msg_field *mds_reint_create_slave_client[] = {
215 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
224 static const struct req_msg_field *mds_reint_create_sym_client[] = {
233 static const struct req_msg_field *mds_reint_open_client[] = {
242 static const struct req_msg_field *mds_reint_open_server[] = {
251 static const struct req_msg_field *mds_reint_unlink_client[] = {
259 static const struct req_msg_field *mds_reint_link_client[] = {
268 static const struct req_msg_field *mds_reint_rename_client[] = {
278 static const struct req_msg_field *mds_last_unlink_server[] = {
287 static const struct req_msg_field *mds_reint_setattr_client[] = {
297 static const struct req_msg_field *mds_reint_setxattr_client[] = {
305 static const struct req_msg_field *mdt_swap_layouts[] = {
314 static const struct req_msg_field *obd_connect_client[] = {
322 static const struct req_msg_field *obd_connect_server[] = {
327 static const struct req_msg_field *obd_set_info_client[] = {
333 static const struct req_msg_field *ost_grant_shrink_client[] = {
339 static const struct req_msg_field *mds_getinfo_client[] = {
345 static const struct req_msg_field *mds_getinfo_server[] = {
350 static const struct req_msg_field *ldlm_enqueue_client[] = {
355 static const struct req_msg_field *ldlm_enqueue_server[] = {
360 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
366 static const struct req_msg_field *ldlm_cp_callback_client[] = {
372 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
378 static const struct req_msg_field *ldlm_gl_callback_server[] = {
383 static const struct req_msg_field *ldlm_intent_basic_client[] = {
389 static const struct req_msg_field *ldlm_intent_client[] = {
396 static const struct req_msg_field *ldlm_intent_server[] = {
404 static const struct req_msg_field *ldlm_intent_layout_client[] = {
409 &RMF_EADATA /* for new layout to be set up */
411 static const struct req_msg_field *ldlm_intent_open_server[] = {
421 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
425 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
430 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
439 static const struct req_msg_field *ldlm_intent_create_client[] = {
443 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
449 static const struct req_msg_field *ldlm_intent_open_client[] = {
453 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
460 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
464 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
469 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
477 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
482 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
488 static const struct req_msg_field *mds_getxattr_client[] = {
496 static const struct req_msg_field *mds_getxattr_server[] = {
502 static const struct req_msg_field *mds_getattr_server[] = {
511 static const struct req_msg_field *mds_setattr_server[] = {
520 static const struct req_msg_field *mds_update_client[] = {
525 static const struct req_msg_field *mds_update_server[] = {
530 static const struct req_msg_field *llog_origin_handle_create_client[] = {
536 static const struct req_msg_field *llogd_body_only[] = {
541 static const struct req_msg_field *llog_log_hdr_only[] = {
546 static const struct req_msg_field *llogd_conn_body_only[] = {
551 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
557 static const struct req_msg_field *obd_idx_read_client[] = {
562 static const struct req_msg_field *obd_idx_read_server[] = {
567 static const struct req_msg_field *ost_body_only[] = {
572 static const struct req_msg_field *ost_body_capa[] = {
578 static const struct req_msg_field *ost_destroy_client[] = {
586 static const struct req_msg_field *ost_brw_client[] = {
594 static const struct req_msg_field *ost_brw_read_server[] = {
599 static const struct req_msg_field *ost_brw_write_server[] = {
605 static const struct req_msg_field *ost_get_info_generic_server[] = {
610 static const struct req_msg_field *ost_get_info_generic_client[] = {
615 static const struct req_msg_field *ost_get_last_id_server[] = {
620 static const struct req_msg_field *ost_get_last_fid_server[] = {
625 static const struct req_msg_field *ost_get_fiemap_client[] = {
631 static const struct req_msg_field *ost_get_fiemap_server[] = {
636 static const struct req_msg_field *mdt_hsm_progress[] = {
639 &RMF_MDS_HSM_PROGRESS,
642 static const struct req_msg_field *mdt_hsm_ct_register[] = {
645 &RMF_MDS_HSM_ARCHIVE,
648 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
653 static const struct req_msg_field *mdt_hsm_action_server[] = {
656 &RMF_MDS_HSM_CURRENT_ACTION,
659 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
665 static const struct req_msg_field *mdt_hsm_state_set[] = {
672 static const struct req_msg_field *mdt_hsm_request[] = {
675 &RMF_MDS_HSM_REQUEST,
676 &RMF_MDS_HSM_USER_ITEM,
680 static struct req_format *req_formats[] = {
687 &RQF_MGS_CONFIG_READ,
696 &RQF_MDS_GETATTR_NAME,
700 &RQF_MDS_RELEASE_CLOSE,
706 &RQF_MDS_DONE_WRITING,
708 &RQF_MDS_REINT_CREATE,
709 &RQF_MDS_REINT_CREATE_RMT_ACL,
710 &RQF_MDS_REINT_CREATE_SLAVE,
711 &RQF_MDS_REINT_CREATE_SYM,
713 &RQF_MDS_REINT_UNLINK,
715 &RQF_MDS_REINT_RENAME,
716 &RQF_MDS_REINT_SETATTR,
717 &RQF_MDS_REINT_SETXATTR,
720 &RQF_MDS_HSM_PROGRESS,
721 &RQF_MDS_HSM_CT_REGISTER,
722 &RQF_MDS_HSM_CT_UNREGISTER,
723 &RQF_MDS_HSM_STATE_GET,
724 &RQF_MDS_HSM_STATE_SET,
726 &RQF_MDS_HSM_REQUEST,
727 &RQF_MDS_SWAP_LAYOUTS,
743 &RQF_OST_SET_GRANT_INFO,
744 &RQF_OST_GET_INFO_GENERIC,
745 &RQF_OST_GET_INFO_LAST_ID,
746 &RQF_OST_GET_INFO_LAST_FID,
747 &RQF_OST_SET_INFO_LAST_FID,
748 &RQF_OST_GET_INFO_FIEMAP,
750 &RQF_LDLM_ENQUEUE_LVB,
754 &RQF_LDLM_CP_CALLBACK,
755 &RQF_LDLM_BL_CALLBACK,
756 &RQF_LDLM_GL_CALLBACK,
757 &RQF_LDLM_GL_DESC_CALLBACK,
759 &RQF_LDLM_INTENT_BASIC,
760 &RQF_LDLM_INTENT_LAYOUT,
761 &RQF_LDLM_INTENT_GETATTR,
762 &RQF_LDLM_INTENT_OPEN,
763 &RQF_LDLM_INTENT_CREATE,
764 &RQF_LDLM_INTENT_UNLINK,
765 &RQF_LDLM_INTENT_GETXATTR,
766 &RQF_LDLM_INTENT_QUOTA,
769 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
770 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
771 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
772 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
773 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
774 &RQF_LLOG_ORIGIN_CONNECT,
778 struct req_msg_field {
779 const __u32 rmf_flags;
780 const char *rmf_name;
782 * Field length. (-1) means "variable length". If the
783 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
784 * but the actual size must be a whole multiple of \a rmf_size.
787 void (*rmf_swabber)(void *);
788 void (*rmf_dumper)(void *);
789 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
794 * The field is a string, must be NUL-terminated.
796 RMF_F_STRING = 1 << 0,
798 * The field's buffer size need not match the declared \a rmf_size.
800 RMF_F_NO_SIZE_CHECK = 1 << 1,
802 * The field's buffer size must be a whole multiple of the declared \a
803 * rmf_size and the \a rmf_swabber function must work on the declared \a
804 * rmf_size worth of bytes.
806 RMF_F_STRUCT_ARRAY = 1 << 2
814 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
815 .rmf_name = (name), \
816 .rmf_flags = (flags), \
817 .rmf_size = (size), \
818 .rmf_swabber = (void (*)(void*))(swabber), \
819 .rmf_dumper = (void (*)(void*))(dumper) \
822 struct req_msg_field RMF_GENERIC_DATA =
823 DEFINE_MSGF("generic_data", 0,
825 EXPORT_SYMBOL(RMF_GENERIC_DATA);
827 struct req_msg_field RMF_MGS_TARGET_INFO =
828 DEFINE_MSGF("mgs_target_info", 0,
829 sizeof(struct mgs_target_info),
830 lustre_swab_mgs_target_info, NULL);
831 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
833 struct req_msg_field RMF_MGS_SEND_PARAM =
834 DEFINE_MSGF("mgs_send_param", 0,
835 sizeof(struct mgs_send_param),
837 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
839 struct req_msg_field RMF_MGS_CONFIG_BODY =
840 DEFINE_MSGF("mgs_config_read request", 0,
841 sizeof(struct mgs_config_body),
842 lustre_swab_mgs_config_body, NULL);
843 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
845 struct req_msg_field RMF_MGS_CONFIG_RES =
846 DEFINE_MSGF("mgs_config_read reply ", 0,
847 sizeof(struct mgs_config_res),
848 lustre_swab_mgs_config_res, NULL);
849 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
851 struct req_msg_field RMF_U32 =
852 DEFINE_MSGF("generic u32", 0,
853 sizeof(__u32), lustre_swab_generic_32s, NULL);
854 EXPORT_SYMBOL(RMF_U32);
856 struct req_msg_field RMF_SETINFO_VAL =
857 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
858 EXPORT_SYMBOL(RMF_SETINFO_VAL);
860 struct req_msg_field RMF_GETINFO_KEY =
861 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
862 EXPORT_SYMBOL(RMF_GETINFO_KEY);
864 struct req_msg_field RMF_GETINFO_VALLEN =
865 DEFINE_MSGF("getinfo_vallen", 0,
866 sizeof(__u32), lustre_swab_generic_32s, NULL);
867 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
869 struct req_msg_field RMF_GETINFO_VAL =
870 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
871 EXPORT_SYMBOL(RMF_GETINFO_VAL);
873 struct req_msg_field RMF_SEQ_OPC =
874 DEFINE_MSGF("seq_query_opc", 0,
875 sizeof(__u32), lustre_swab_generic_32s, NULL);
876 EXPORT_SYMBOL(RMF_SEQ_OPC);
878 struct req_msg_field RMF_SEQ_RANGE =
879 DEFINE_MSGF("seq_query_range", 0,
880 sizeof(struct lu_seq_range),
881 lustre_swab_lu_seq_range, NULL);
882 EXPORT_SYMBOL(RMF_SEQ_RANGE);
884 struct req_msg_field RMF_FLD_OPC =
885 DEFINE_MSGF("fld_query_opc", 0,
886 sizeof(__u32), lustre_swab_generic_32s, NULL);
887 EXPORT_SYMBOL(RMF_FLD_OPC);
889 struct req_msg_field RMF_FLD_MDFLD =
890 DEFINE_MSGF("fld_query_mdfld", 0,
891 sizeof(struct lu_seq_range),
892 lustre_swab_lu_seq_range, NULL);
893 EXPORT_SYMBOL(RMF_FLD_MDFLD);
895 struct req_msg_field RMF_MDT_BODY =
896 DEFINE_MSGF("mdt_body", 0,
897 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
898 EXPORT_SYMBOL(RMF_MDT_BODY);
900 struct req_msg_field RMF_OBD_QUOTACTL =
901 DEFINE_MSGF("obd_quotactl", 0,
902 sizeof(struct obd_quotactl),
903 lustre_swab_obd_quotactl, NULL);
904 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
906 struct req_msg_field RMF_QUOTA_BODY =
907 DEFINE_MSGF("quota_body", 0,
908 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
909 EXPORT_SYMBOL(RMF_QUOTA_BODY);
911 struct req_msg_field RMF_MDT_EPOCH =
912 DEFINE_MSGF("mdt_ioepoch", 0,
913 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
914 EXPORT_SYMBOL(RMF_MDT_EPOCH);
916 struct req_msg_field RMF_PTLRPC_BODY =
917 DEFINE_MSGF("ptlrpc_body", 0,
918 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
919 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
921 struct req_msg_field RMF_CLOSE_DATA =
922 DEFINE_MSGF("data_version", 0,
923 sizeof(struct close_data), lustre_swab_close_data, NULL);
924 EXPORT_SYMBOL(RMF_CLOSE_DATA);
926 struct req_msg_field RMF_OBD_STATFS =
927 DEFINE_MSGF("obd_statfs", 0,
928 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
929 EXPORT_SYMBOL(RMF_OBD_STATFS);
931 struct req_msg_field RMF_SETINFO_KEY =
932 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
933 EXPORT_SYMBOL(RMF_SETINFO_KEY);
935 struct req_msg_field RMF_NAME =
936 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
937 EXPORT_SYMBOL(RMF_NAME);
939 struct req_msg_field RMF_SYMTGT =
940 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
941 EXPORT_SYMBOL(RMF_SYMTGT);
943 struct req_msg_field RMF_TGTUUID =
944 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
946 EXPORT_SYMBOL(RMF_TGTUUID);
948 struct req_msg_field RMF_CLUUID =
949 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
951 EXPORT_SYMBOL(RMF_CLUUID);
953 struct req_msg_field RMF_STRING =
954 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
955 EXPORT_SYMBOL(RMF_STRING);
957 struct req_msg_field RMF_LLOGD_BODY =
958 DEFINE_MSGF("llogd_body", 0,
959 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
960 EXPORT_SYMBOL(RMF_LLOGD_BODY);
962 struct req_msg_field RMF_LLOG_LOG_HDR =
963 DEFINE_MSGF("llog_log_hdr", 0,
964 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
965 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
967 struct req_msg_field RMF_LLOGD_CONN_BODY =
968 DEFINE_MSGF("llogd_conn_body", 0,
969 sizeof(struct llogd_conn_body),
970 lustre_swab_llogd_conn_body, NULL);
971 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
974 * connection handle received in MDS_CONNECT request.
976 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
977 * that the client does not interpret at all.
979 struct req_msg_field RMF_CONN =
980 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
981 EXPORT_SYMBOL(RMF_CONN);
983 struct req_msg_field RMF_CONNECT_DATA =
985 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
986 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
987 sizeof(struct obd_connect_data),
989 /* For interoperability with 1.8 and 2.0 clients/servers.
990 * The RPC verification code allows larger RPC buffers, but not
991 * smaller buffers. Until we no longer need to keep compatibility
992 * with older servers/clients we can only check that the buffer
993 * size is at least as large as obd_connect_data_v1. That is not
994 * not in itself harmful, since the chance of just corrupting this
995 * field is low. See JIRA LU-16 for details. */
996 sizeof(struct obd_connect_data_v1),
998 lustre_swab_connect, NULL);
999 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1001 struct req_msg_field RMF_DLM_REQ =
1002 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1003 sizeof(struct ldlm_request),
1004 lustre_swab_ldlm_request, NULL);
1005 EXPORT_SYMBOL(RMF_DLM_REQ);
1007 struct req_msg_field RMF_DLM_REP =
1008 DEFINE_MSGF("dlm_rep", 0,
1009 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1010 EXPORT_SYMBOL(RMF_DLM_REP);
1012 struct req_msg_field RMF_LDLM_INTENT =
1013 DEFINE_MSGF("ldlm_intent", 0,
1014 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1015 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1017 struct req_msg_field RMF_DLM_LVB =
1018 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1019 EXPORT_SYMBOL(RMF_DLM_LVB);
1021 struct req_msg_field RMF_DLM_GL_DESC =
1022 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1023 lustre_swab_gl_desc, NULL);
1024 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1026 struct req_msg_field RMF_MDT_MD =
1027 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1028 EXPORT_SYMBOL(RMF_MDT_MD);
1030 struct req_msg_field RMF_REC_REINT =
1031 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1032 lustre_swab_mdt_rec_reint, NULL);
1033 EXPORT_SYMBOL(RMF_REC_REINT);
1035 /* FIXME: this length should be defined as a macro */
1036 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1038 EXPORT_SYMBOL(RMF_EADATA);
1040 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1041 EXPORT_SYMBOL(RMF_EAVALS);
1043 struct req_msg_field RMF_ACL =
1044 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1045 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1046 EXPORT_SYMBOL(RMF_ACL);
1048 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1049 struct req_msg_field RMF_LOGCOOKIES =
1050 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1051 sizeof(struct llog_cookie), NULL, NULL);
1052 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1054 struct req_msg_field RMF_CAPA1 =
1055 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1056 lustre_swab_lustre_capa, NULL);
1057 EXPORT_SYMBOL(RMF_CAPA1);
1059 struct req_msg_field RMF_CAPA2 =
1060 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1061 lustre_swab_lustre_capa, NULL);
1062 EXPORT_SYMBOL(RMF_CAPA2);
1064 struct req_msg_field RMF_LAYOUT_INTENT =
1065 DEFINE_MSGF("layout_intent", 0,
1066 sizeof(struct layout_intent), lustre_swab_layout_intent,
1068 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1071 * OST request field.
1073 struct req_msg_field RMF_OST_BODY =
1074 DEFINE_MSGF("ost_body", 0,
1075 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1076 EXPORT_SYMBOL(RMF_OST_BODY);
1078 struct req_msg_field RMF_OBD_IOOBJ =
1079 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1080 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1081 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1083 struct req_msg_field RMF_NIOBUF_REMOTE =
1084 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1085 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1087 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1089 struct req_msg_field RMF_RCS =
1090 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1091 lustre_swab_generic_32s, dump_rcs);
1092 EXPORT_SYMBOL(RMF_RCS);
1094 struct req_msg_field RMF_EAVALS_LENS =
1095 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1096 lustre_swab_generic_32s, NULL);
1097 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1099 struct req_msg_field RMF_OBD_ID =
1100 DEFINE_MSGF("obd_id", 0,
1101 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1102 EXPORT_SYMBOL(RMF_OBD_ID);
1104 struct req_msg_field RMF_FID =
1105 DEFINE_MSGF("fid", 0,
1106 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1107 EXPORT_SYMBOL(RMF_FID);
1109 struct req_msg_field RMF_OST_ID =
1110 DEFINE_MSGF("ost_id", 0,
1111 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1112 EXPORT_SYMBOL(RMF_OST_ID);
1114 struct req_msg_field RMF_FIEMAP_KEY =
1115 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1116 lustre_swab_fiemap, NULL);
1117 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1119 struct req_msg_field RMF_FIEMAP_VAL =
1120 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1121 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1123 struct req_msg_field RMF_IDX_INFO =
1124 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1125 lustre_swab_idx_info, NULL);
1126 EXPORT_SYMBOL(RMF_IDX_INFO);
1127 struct req_msg_field RMF_HSM_USER_STATE =
1128 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1129 lustre_swab_hsm_user_state, NULL);
1130 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1132 struct req_msg_field RMF_HSM_STATE_SET =
1133 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1134 lustre_swab_hsm_state_set, NULL);
1135 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1137 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1138 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1139 lustre_swab_hsm_progress_kernel, NULL);
1140 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1142 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1143 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1144 lustre_swab_hsm_current_action, NULL);
1145 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1147 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1148 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1149 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1151 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1153 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1154 DEFINE_MSGF("hsm_archive", 0,
1155 sizeof(__u32), lustre_swab_generic_32s, NULL);
1156 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1158 struct req_msg_field RMF_MDS_HSM_REQUEST =
1159 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1160 lustre_swab_hsm_request, NULL);
1161 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1163 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1164 lustre_swab_update_buf, NULL);
1165 EXPORT_SYMBOL(RMF_UPDATE);
1167 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1168 lustre_swab_update_reply_buf,
1170 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1172 struct req_msg_field RMF_SWAP_LAYOUTS =
1173 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1174 lustre_swab_swap_layouts, NULL);
1175 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1181 const char *rf_name;
1185 const struct req_msg_field **d;
1186 } rf_fields[RCL_NR];
1189 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1203 #define DEFINE_REQ_FMT0(name, client, server) \
1204 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1206 struct req_format RQF_OBD_PING =
1207 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1208 EXPORT_SYMBOL(RQF_OBD_PING);
1210 struct req_format RQF_OBD_SET_INFO =
1211 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1212 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1214 /* Read index file through the network */
1215 struct req_format RQF_OBD_IDX_READ =
1216 DEFINE_REQ_FMT0("OBD_IDX_READ",
1217 obd_idx_read_client, obd_idx_read_server);
1218 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1220 struct req_format RQF_SEC_CTX =
1221 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1222 EXPORT_SYMBOL(RQF_SEC_CTX);
1224 struct req_format RQF_MGS_TARGET_REG =
1225 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1226 mgs_target_info_only);
1227 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1229 struct req_format RQF_MGS_SET_INFO =
1230 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1232 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1234 struct req_format RQF_MGS_CONFIG_READ =
1235 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1236 mgs_config_read_server);
1237 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1239 struct req_format RQF_SEQ_QUERY =
1240 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1241 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1243 struct req_format RQF_FLD_QUERY =
1244 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1245 EXPORT_SYMBOL(RQF_FLD_QUERY);
1247 struct req_format RQF_LOG_CANCEL =
1248 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1249 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1251 struct req_format RQF_MDS_QUOTACHECK =
1252 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1253 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1255 struct req_format RQF_OST_QUOTACHECK =
1256 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1257 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1259 struct req_format RQF_MDS_QUOTACTL =
1260 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1261 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1263 struct req_format RQF_OST_QUOTACTL =
1264 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1265 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1267 struct req_format RQF_QC_CALLBACK =
1268 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1269 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1271 struct req_format RQF_QUOTA_DQACQ =
1272 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1273 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1275 struct req_format RQF_LDLM_INTENT_QUOTA =
1276 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1277 ldlm_intent_quota_client,
1278 ldlm_intent_quota_server);
1279 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1281 struct req_format RQF_MDS_GETSTATUS =
1282 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1283 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1285 struct req_format RQF_MDS_STATFS =
1286 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1287 EXPORT_SYMBOL(RQF_MDS_STATFS);
1289 struct req_format RQF_MDS_SYNC =
1290 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1291 EXPORT_SYMBOL(RQF_MDS_SYNC);
1293 struct req_format RQF_MDS_GETATTR =
1294 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1295 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1297 struct req_format RQF_MDS_GETXATTR =
1298 DEFINE_REQ_FMT0("MDS_GETXATTR",
1299 mds_getxattr_client, mds_getxattr_server);
1300 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1302 struct req_format RQF_MDS_GETATTR_NAME =
1303 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1304 mds_getattr_name_client, mds_getattr_server);
1305 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1307 struct req_format RQF_MDS_REINT =
1308 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1309 EXPORT_SYMBOL(RQF_MDS_REINT);
1311 struct req_format RQF_MDS_REINT_CREATE =
1312 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1313 mds_reint_create_client, mdt_body_capa);
1314 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1316 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1317 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1318 mds_reint_create_rmt_acl_client, mdt_body_capa);
1319 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1321 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1322 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1323 mds_reint_create_slave_client, mdt_body_capa);
1324 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1326 struct req_format RQF_MDS_REINT_CREATE_SYM =
1327 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1328 mds_reint_create_sym_client, mdt_body_capa);
1329 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1331 struct req_format RQF_MDS_REINT_OPEN =
1332 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1333 mds_reint_open_client, mds_reint_open_server);
1334 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1336 struct req_format RQF_MDS_REINT_UNLINK =
1337 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1338 mds_last_unlink_server);
1339 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1341 struct req_format RQF_MDS_REINT_LINK =
1342 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1343 mds_reint_link_client, mdt_body_only);
1344 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1346 struct req_format RQF_MDS_REINT_RENAME =
1347 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1348 mds_last_unlink_server);
1349 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1351 struct req_format RQF_MDS_REINT_SETATTR =
1352 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1353 mds_reint_setattr_client, mds_setattr_server);
1354 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1356 struct req_format RQF_MDS_REINT_SETXATTR =
1357 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1358 mds_reint_setxattr_client, mdt_body_only);
1359 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1361 struct req_format RQF_MDS_CONNECT =
1362 DEFINE_REQ_FMT0("MDS_CONNECT",
1363 obd_connect_client, obd_connect_server);
1364 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1366 struct req_format RQF_MDS_DISCONNECT =
1367 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1368 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1370 struct req_format RQF_MDS_GET_INFO =
1371 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1372 mds_getinfo_server);
1373 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1375 struct req_format RQF_UPDATE_OBJ =
1376 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1378 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1380 struct req_format RQF_LDLM_ENQUEUE =
1381 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1382 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1383 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1385 struct req_format RQF_LDLM_ENQUEUE_LVB =
1386 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1387 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1388 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1390 struct req_format RQF_LDLM_CONVERT =
1391 DEFINE_REQ_FMT0("LDLM_CONVERT",
1392 ldlm_enqueue_client, ldlm_enqueue_server);
1393 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1395 struct req_format RQF_LDLM_CANCEL =
1396 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1397 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1399 struct req_format RQF_LDLM_CALLBACK =
1400 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1401 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1403 struct req_format RQF_LDLM_CP_CALLBACK =
1404 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1405 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1407 struct req_format RQF_LDLM_BL_CALLBACK =
1408 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1409 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1411 struct req_format RQF_LDLM_GL_CALLBACK =
1412 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1413 ldlm_gl_callback_server);
1414 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1416 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1417 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1418 ldlm_gl_callback_server);
1419 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1421 struct req_format RQF_LDLM_INTENT_BASIC =
1422 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1423 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1424 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1426 struct req_format RQF_LDLM_INTENT =
1427 DEFINE_REQ_FMT0("LDLM_INTENT",
1428 ldlm_intent_client, ldlm_intent_server);
1429 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1431 struct req_format RQF_LDLM_INTENT_LAYOUT =
1432 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1433 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1434 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1436 struct req_format RQF_LDLM_INTENT_GETATTR =
1437 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1438 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1439 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1441 struct req_format RQF_LDLM_INTENT_OPEN =
1442 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1443 ldlm_intent_open_client, ldlm_intent_open_server);
1444 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1446 struct req_format RQF_LDLM_INTENT_CREATE =
1447 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1448 ldlm_intent_create_client, ldlm_intent_getattr_server);
1449 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1451 struct req_format RQF_LDLM_INTENT_UNLINK =
1452 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1453 ldlm_intent_unlink_client, ldlm_intent_server);
1454 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1456 struct req_format RQF_LDLM_INTENT_GETXATTR =
1457 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1458 ldlm_intent_getxattr_client,
1459 ldlm_intent_getxattr_server);
1460 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1462 struct req_format RQF_MDS_CLOSE =
1463 DEFINE_REQ_FMT0("MDS_CLOSE",
1464 mdt_close_client, mds_last_unlink_server);
1465 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1467 struct req_format RQF_MDS_RELEASE_CLOSE =
1468 DEFINE_REQ_FMT0("MDS_CLOSE",
1469 mdt_release_close_client, mds_last_unlink_server);
1470 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1472 struct req_format RQF_MDS_PIN =
1473 DEFINE_REQ_FMT0("MDS_PIN",
1474 mdt_body_capa, mdt_body_only);
1475 EXPORT_SYMBOL(RQF_MDS_PIN);
1477 struct req_format RQF_MDS_UNPIN =
1478 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1479 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1481 struct req_format RQF_MDS_DONE_WRITING =
1482 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1483 mdt_close_client, mdt_body_only);
1484 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1486 struct req_format RQF_MDS_READPAGE =
1487 DEFINE_REQ_FMT0("MDS_READPAGE",
1488 mdt_body_capa, mdt_body_only);
1489 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1491 struct req_format RQF_MDS_HSM_ACTION =
1492 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1493 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1495 struct req_format RQF_MDS_HSM_PROGRESS =
1496 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1497 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1499 struct req_format RQF_MDS_HSM_CT_REGISTER =
1500 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1501 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1503 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1504 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1505 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1507 struct req_format RQF_MDS_HSM_STATE_GET =
1508 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1509 mdt_body_capa, mdt_hsm_state_get_server);
1510 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1512 struct req_format RQF_MDS_HSM_STATE_SET =
1513 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1514 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1516 struct req_format RQF_MDS_HSM_REQUEST =
1517 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1518 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1520 struct req_format RQF_MDS_SWAP_LAYOUTS =
1521 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1522 mdt_swap_layouts, empty);
1523 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1525 /* This is for split */
1526 struct req_format RQF_MDS_WRITEPAGE =
1527 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1528 mdt_body_capa, mdt_body_only);
1529 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1531 struct req_format RQF_MDS_IS_SUBDIR =
1532 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1533 mdt_body_only, mdt_body_only);
1534 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1536 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1537 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1538 llog_origin_handle_create_client, llogd_body_only);
1539 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1541 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1542 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1543 llogd_body_only, llogd_body_only);
1544 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1546 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1547 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1548 llogd_body_only, llog_origin_handle_next_block_server);
1549 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1551 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1552 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1553 llogd_body_only, llog_origin_handle_next_block_server);
1554 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1556 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1557 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1558 llogd_body_only, llog_log_hdr_only);
1559 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1561 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1562 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1563 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1565 struct req_format RQF_CONNECT =
1566 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1567 EXPORT_SYMBOL(RQF_CONNECT);
1569 struct req_format RQF_OST_CONNECT =
1570 DEFINE_REQ_FMT0("OST_CONNECT",
1571 obd_connect_client, obd_connect_server);
1572 EXPORT_SYMBOL(RQF_OST_CONNECT);
1574 struct req_format RQF_OST_DISCONNECT =
1575 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1576 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1578 struct req_format RQF_OST_GETATTR =
1579 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1580 EXPORT_SYMBOL(RQF_OST_GETATTR);
1582 struct req_format RQF_OST_SETATTR =
1583 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1584 EXPORT_SYMBOL(RQF_OST_SETATTR);
1586 struct req_format RQF_OST_CREATE =
1587 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1588 EXPORT_SYMBOL(RQF_OST_CREATE);
1590 struct req_format RQF_OST_PUNCH =
1591 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1592 EXPORT_SYMBOL(RQF_OST_PUNCH);
1594 struct req_format RQF_OST_SYNC =
1595 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1596 EXPORT_SYMBOL(RQF_OST_SYNC);
1598 struct req_format RQF_OST_DESTROY =
1599 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1600 EXPORT_SYMBOL(RQF_OST_DESTROY);
1602 struct req_format RQF_OST_BRW_READ =
1603 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1604 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1606 struct req_format RQF_OST_BRW_WRITE =
1607 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1608 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1610 struct req_format RQF_OST_STATFS =
1611 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1612 EXPORT_SYMBOL(RQF_OST_STATFS);
1614 struct req_format RQF_OST_SET_GRANT_INFO =
1615 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1617 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1619 struct req_format RQF_OST_GET_INFO_GENERIC =
1620 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1621 ost_get_info_generic_server);
1622 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1624 struct req_format RQF_OST_GET_INFO_LAST_ID =
1625 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1626 ost_get_last_id_server);
1627 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1629 struct req_format RQF_OST_GET_INFO_LAST_FID =
1630 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", obd_set_info_client,
1631 ost_get_last_fid_server);
1632 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1634 struct req_format RQF_OST_SET_INFO_LAST_FID =
1635 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1637 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1639 struct req_format RQF_OST_GET_INFO_FIEMAP =
1640 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1641 ost_get_fiemap_server);
1642 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1644 #if !defined(__REQ_LAYOUT_USER__)
1646 /* Convenience macro */
1647 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1650 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1651 * field of RQFs and the \a rmf_offset field of RMFs.
1653 int req_layout_init(void)
1658 struct req_format *rf = NULL;
1660 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1661 rf = req_formats[i];
1663 for (j = 0; j < RCL_NR; ++j) {
1664 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1665 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1666 struct req_msg_field *field;
1668 field = (typeof(field))rf->rf_fields[j].d[k];
1669 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1670 || field->rmf_size > 0);
1671 LASSERT(field->rmf_offset[i][j] == 0);
1673 * k + 1 to detect unused format/field
1676 field->rmf_offset[i][j] = k + 1;
1682 EXPORT_SYMBOL(req_layout_init);
1684 void req_layout_fini(void)
1687 EXPORT_SYMBOL(req_layout_fini);
1690 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1692 * Actual/expected field sizes are set elsewhere in functions in this file:
1693 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1694 * req_capsule_msg_size(). The \a rc_area information is used by.
1695 * ptlrpc_request_set_replen().
1697 void req_capsule_init_area(struct req_capsule *pill)
1701 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1702 pill->rc_area[RCL_CLIENT][i] = -1;
1703 pill->rc_area[RCL_SERVER][i] = -1;
1706 EXPORT_SYMBOL(req_capsule_init_area);
1709 * Initialize a pill.
1711 * The \a location indicates whether the caller is executing on the client side
1712 * (RCL_CLIENT) or server side (RCL_SERVER)..
1714 void req_capsule_init(struct req_capsule *pill,
1715 struct ptlrpc_request *req,
1716 enum req_location location)
1718 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1721 * Today all capsules are embedded in ptlrpc_request structs,
1722 * but just in case that ever isn't the case, we don't reach
1723 * into req unless req != NULL and pill is the one embedded in
1726 * The req->rq_pill_init flag makes it safe to initialize a pill
1727 * twice, which might happen in the OST paths as a result of the
1728 * high-priority RPC queue getting peeked at before ost_handle()
1729 * handles an OST RPC.
1731 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1734 memset(pill, 0, sizeof *pill);
1736 pill->rc_loc = location;
1737 req_capsule_init_area(pill);
1739 if (req != NULL && pill == &req->rq_pill)
1740 req->rq_pill_init = 1;
1742 EXPORT_SYMBOL(req_capsule_init);
1744 void req_capsule_fini(struct req_capsule *pill)
1747 EXPORT_SYMBOL(req_capsule_fini);
1749 static int __req_format_is_sane(const struct req_format *fmt)
1752 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1753 req_formats[fmt->rf_idx] == fmt;
1756 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1757 enum req_location loc)
1759 struct ptlrpc_request *req;
1762 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1766 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1767 * (see req_capsule_extend()).
1769 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1771 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1772 LASSERT(__req_format_is_sane(fmt));
1776 EXPORT_SYMBOL(req_capsule_set);
1779 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1782 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1783 * variable-sized fields. The field sizes come from the declared \a rmf_size
1784 * field of a \a pill's \a rc_fmt's RMF's.
1786 int req_capsule_filled_sizes(struct req_capsule *pill,
1787 enum req_location loc)
1789 const struct req_format *fmt = pill->rc_fmt;
1792 LASSERT(fmt != NULL);
1794 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1795 if (pill->rc_area[loc][i] == -1) {
1796 pill->rc_area[loc][i] =
1797 fmt->rf_fields[loc].d[i]->rmf_size;
1798 if (pill->rc_area[loc][i] == -1) {
1800 * Skip the following fields.
1802 * If this LASSERT() trips then you're missing a
1803 * call to req_capsule_set_size().
1805 LASSERT(loc != RCL_SERVER);
1812 EXPORT_SYMBOL(req_capsule_filled_sizes);
1815 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1817 * This function uses the \a pill's \a rc_area as filled in by
1818 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1821 int req_capsule_server_pack(struct req_capsule *pill)
1823 const struct req_format *fmt;
1827 LASSERT(pill->rc_loc == RCL_SERVER);
1829 LASSERT(fmt != NULL);
1831 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1832 rc = lustre_pack_reply(pill->rc_req, count,
1833 pill->rc_area[RCL_SERVER], NULL);
1835 DEBUG_REQ(D_ERROR, pill->rc_req,
1836 "Cannot pack %d fields in format `%s': ",
1837 count, fmt->rf_name);
1841 EXPORT_SYMBOL(req_capsule_server_pack);
1844 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1845 * corresponding to the given RMF (\a field).
1847 static int __req_capsule_offset(const struct req_capsule *pill,
1848 const struct req_msg_field *field,
1849 enum req_location loc)
1853 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1854 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1855 pill->rc_fmt->rf_name,
1856 field->rmf_name, offset, loc);
1859 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1864 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1869 swabber_dumper_helper(struct req_capsule *pill,
1870 const struct req_msg_field *field,
1871 enum req_location loc,
1873 void *value, int len, int dump, void (*swabber)( void *))
1879 int inout = loc == RCL_CLIENT;
1881 swabber = swabber ?: field->rmf_swabber;
1883 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1884 swabber != NULL && value != NULL)
1889 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1890 if (dump && field->rmf_dumper) {
1891 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1892 do_swab ? "unswabbed " : "", field->rmf_name);
1893 field->rmf_dumper(value);
1898 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1900 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1901 "follows\n", field->rmf_name);
1902 field->rmf_dumper(value);
1909 * We're swabbing an array; swabber() swabs a single array element, so
1910 * swab every element.
1912 LASSERT((len % field->rmf_size) == 0);
1913 for (p = value, i = 0, n = len / field->rmf_size;
1915 i++, p += field->rmf_size) {
1916 if (dump && field->rmf_dumper) {
1917 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1918 "element %d follows\n",
1919 do_swab ? "unswabbed " : "", field->rmf_name, i);
1920 field->rmf_dumper(p);
1925 if (dump && field->rmf_dumper) {
1926 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1927 "element %d follows\n", field->rmf_name, i);
1928 field->rmf_dumper(value);
1932 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1936 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1937 * corresponding to the given RMF (\a field).
1939 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1940 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1941 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1942 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1943 * element of the array swabbed.
1945 static void *__req_capsule_get(struct req_capsule *pill,
1946 const struct req_msg_field *field,
1947 enum req_location loc,
1948 void (*swabber)( void *),
1951 const struct req_format *fmt;
1952 struct lustre_msg *msg;
1957 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1959 static const char *rcl_names[RCL_NR] = {
1960 [RCL_CLIENT] = "client",
1961 [RCL_SERVER] = "server"
1964 LASSERT(pill != NULL);
1965 LASSERT(pill != LP_POISON);
1967 LASSERT(fmt != NULL);
1968 LASSERT(fmt != LP_POISON);
1969 LASSERT(__req_format_is_sane(fmt));
1971 offset = __req_capsule_offset(pill, field, loc);
1973 msg = __req_msg(pill, loc);
1974 LASSERT(msg != NULL);
1976 getter = (field->rmf_flags & RMF_F_STRING) ?
1977 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1979 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1981 * We've already asserted that field->rmf_size > 0 in
1982 * req_layout_init().
1984 len = lustre_msg_buflen(msg, offset);
1985 if ((len % field->rmf_size) != 0) {
1986 CERROR("%s: array field size mismatch "
1987 "%d modulo %d != 0 (%d)\n",
1988 field->rmf_name, len, field->rmf_size, loc);
1991 } else if (pill->rc_area[loc][offset] != -1) {
1992 len = pill->rc_area[loc][offset];
1994 len = max(field->rmf_size, 0);
1996 value = getter(msg, offset, len);
1998 if (value == NULL) {
1999 DEBUG_REQ(D_ERROR, pill->rc_req,
2000 "Wrong buffer for field `%s' (%d of %d) "
2001 "in format `%s': %d vs. %d (%s)\n",
2002 field->rmf_name, offset, lustre_msg_bufcount(msg),
2003 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2006 swabber_dumper_helper(pill, field, loc, offset, value, len,
2014 * Dump a request and/or reply
2016 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2018 const struct req_format *fmt;
2019 const struct req_msg_field *field;
2025 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2026 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2027 field = FMT_FIELD(fmt, loc, i);
2028 if (field->rmf_dumper == NULL) {
2030 * FIXME Add a default hex dumper for fields that don't
2031 * have a specific dumper
2033 len = req_capsule_get_size(pill, field, loc);
2034 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2035 "field size is %d\n", field->rmf_name, len);
2037 /* It's the dumping side-effect that we're interested in */
2038 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2041 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2047 void req_capsule_client_dump(struct req_capsule *pill)
2049 __req_capsule_dump(pill, RCL_CLIENT);
2051 EXPORT_SYMBOL(req_capsule_client_dump);
2056 void req_capsule_server_dump(struct req_capsule *pill)
2058 __req_capsule_dump(pill, RCL_SERVER);
2060 EXPORT_SYMBOL(req_capsule_server_dump);
2063 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2064 * buffer corresponding to the given RMF (\a field) of a \a pill.
2066 void *req_capsule_client_get(struct req_capsule *pill,
2067 const struct req_msg_field *field)
2069 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2071 EXPORT_SYMBOL(req_capsule_client_get);
2074 * Same as req_capsule_client_get(), but with a \a swabber argument.
2076 * Currently unused; will be removed when req_capsule_server_swab_get() is
2079 void *req_capsule_client_swab_get(struct req_capsule *pill,
2080 const struct req_msg_field *field,
2083 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2085 EXPORT_SYMBOL(req_capsule_client_swab_get);
2088 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2090 * First the \a pill's request \a field's size is set (\a rc_area) using
2091 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2094 void *req_capsule_client_sized_get(struct req_capsule *pill,
2095 const struct req_msg_field *field,
2098 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2099 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2101 EXPORT_SYMBOL(req_capsule_client_sized_get);
2104 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2105 * buffer corresponding to the given RMF (\a field) of a \a pill.
2107 void *req_capsule_server_get(struct req_capsule *pill,
2108 const struct req_msg_field *field)
2110 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2112 EXPORT_SYMBOL(req_capsule_server_get);
2115 * Same as req_capsule_server_get(), but with a \a swabber argument.
2117 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2118 * swabbing done outside this capsule abstraction.
2120 void *req_capsule_server_swab_get(struct req_capsule *pill,
2121 const struct req_msg_field *field,
2124 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2126 EXPORT_SYMBOL(req_capsule_server_swab_get);
2129 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2131 * First the \a pill's request \a field's size is set (\a rc_area) using
2132 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2135 void *req_capsule_server_sized_get(struct req_capsule *pill,
2136 const struct req_msg_field *field,
2139 req_capsule_set_size(pill, field, RCL_SERVER, len);
2140 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2142 EXPORT_SYMBOL(req_capsule_server_sized_get);
2144 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2145 const struct req_msg_field *field,
2146 int len, void *swabber)
2148 req_capsule_set_size(pill, field, RCL_SERVER, len);
2149 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2151 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2154 * Returns the buffer of a \a pill corresponding to the given \a field from the
2155 * request (if the caller is executing on the server-side) or reply (if the
2156 * caller is executing on the client-side).
2158 * This function convienient for use is code that could be executed on the
2159 * client and server alike.
2161 const void *req_capsule_other_get(struct req_capsule *pill,
2162 const struct req_msg_field *field)
2164 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2166 EXPORT_SYMBOL(req_capsule_other_get);
2169 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2170 * field of the given \a pill.
2172 * This function must be used when constructing variable sized fields of a
2175 void req_capsule_set_size(struct req_capsule *pill,
2176 const struct req_msg_field *field,
2177 enum req_location loc, int size)
2179 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2181 if ((size != field->rmf_size) &&
2182 (field->rmf_size != -1) &&
2183 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2185 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2186 (size % field->rmf_size != 0)) {
2187 CERROR("%s: array field size mismatch "
2188 "%d %% %d != 0 (%d)\n",
2189 field->rmf_name, size, field->rmf_size, loc);
2191 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2192 size < field->rmf_size) {
2193 CERROR("%s: field size mismatch %d != %d (%d)\n",
2194 field->rmf_name, size, field->rmf_size, loc);
2199 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2201 EXPORT_SYMBOL(req_capsule_set_size);
2204 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2205 * for the given \a pill's given \a field.
2207 * NB: this function doesn't correspond with req_capsule_set_size(), which
2208 * actually sets the size in pill.rc_area[loc][offset], but this function
2209 * returns the message buflen[offset], maybe we should use another name.
2211 int req_capsule_get_size(const struct req_capsule *pill,
2212 const struct req_msg_field *field,
2213 enum req_location loc)
2215 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2217 return lustre_msg_buflen(__req_msg(pill, loc),
2218 __req_capsule_offset(pill, field, loc));
2220 EXPORT_SYMBOL(req_capsule_get_size);
2223 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2224 * given \a pill's request or reply (\a loc) given the field size recorded in
2225 * the \a pill's rc_area.
2227 * See also req_capsule_set_size().
2229 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2231 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2232 pill->rc_fmt->rf_fields[loc].nr,
2233 pill->rc_area[loc]);
2237 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2238 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2239 * PTLRPC request or reply given only an RQF (\a fmt).
2241 * This function should not be used for formats which contain variable size
2244 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2245 enum req_location loc)
2250 * This function should probably LASSERT() that fmt has no fields with
2251 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2252 * elements in the array there will ultimately be, but then, we could
2253 * assume that there will be at least one element, and that's just what
2256 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2260 for (; i < fmt->rf_fields[loc].nr; ++i)
2261 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2262 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2268 * Changes the format of an RPC.
2270 * The pill must already have been initialized, which means that it already has
2271 * a request format. The new format \a fmt must be an extension of the pill's
2272 * old format. Specifically: the new format must have as many request and reply
2273 * fields as the old one, and all fields shared by the old and new format must
2274 * be at least as large in the new format.
2276 * The new format's fields may be of different "type" than the old format, but
2277 * only for fields that are "opaque" blobs: fields which have a) have no
2278 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2279 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2280 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2281 * according to the key field. When the value, according to the key, contains a
2282 * structure (or array thereof) to be swabbed, the format should be changed to
2283 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2286 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2291 const struct req_format *old;
2293 LASSERT(pill->rc_fmt != NULL);
2294 LASSERT(__req_format_is_sane(fmt));
2298 * Sanity checking...
2300 for (i = 0; i < RCL_NR; ++i) {
2301 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2302 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2303 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2305 /* "opaque" fields can be transmogrified */
2306 if (ofield->rmf_swabber == NULL &&
2307 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2308 (ofield->rmf_size == -1 ||
2309 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2311 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2314 * Last field in old format can be shorter than in new.
2316 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2317 FMT_FIELD(old, i, j)->rmf_size);
2322 EXPORT_SYMBOL(req_capsule_extend);
2325 * This function returns a non-zero value if the given \a field is present in
2326 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2329 int req_capsule_has_field(const struct req_capsule *pill,
2330 const struct req_msg_field *field,
2331 enum req_location loc)
2333 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2335 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2337 EXPORT_SYMBOL(req_capsule_has_field);
2340 * Returns a non-zero value if the given \a field is present in the given \a
2341 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2343 int req_capsule_field_present(const struct req_capsule *pill,
2344 const struct req_msg_field *field,
2345 enum req_location loc)
2349 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2350 LASSERT(req_capsule_has_field(pill, field, loc));
2352 offset = __req_capsule_offset(pill, field, loc);
2353 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2355 EXPORT_SYMBOL(req_capsule_field_present);
2358 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2359 * request or reply (\a loc).
2361 * This is not the opposite of req_capsule_extend().
2363 void req_capsule_shrink(struct req_capsule *pill,
2364 const struct req_msg_field *field,
2365 unsigned int newlen,
2366 enum req_location loc)
2368 const struct req_format *fmt;
2369 struct lustre_msg *msg;
2374 LASSERT(fmt != NULL);
2375 LASSERT(__req_format_is_sane(fmt));
2376 LASSERT(req_capsule_has_field(pill, field, loc));
2377 LASSERT(req_capsule_field_present(pill, field, loc));
2379 offset = __req_capsule_offset(pill, field, loc);
2381 msg = __req_msg(pill, loc);
2382 len = lustre_msg_buflen(msg, offset);
2383 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2384 fmt->rf_name, field->rmf_name, len, newlen);
2386 if (loc == RCL_CLIENT)
2387 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2390 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2393 EXPORT_SYMBOL(req_capsule_shrink);
2395 int req_capsule_server_grow(struct req_capsule *pill,
2396 const struct req_msg_field *field,
2397 unsigned int newlen)
2399 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2401 int offset, len, rc;
2403 LASSERT(pill->rc_fmt != NULL);
2404 LASSERT(__req_format_is_sane(pill->rc_fmt));
2405 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2406 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2408 len = req_capsule_get_size(pill, field, RCL_SERVER);
2409 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2410 if (pill->rc_req->rq_repbuf_len >=
2411 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2412 CERROR("Inplace repack might be done\n");
2414 pill->rc_req->rq_reply_state = NULL;
2415 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2416 rc = req_capsule_server_pack(pill);
2418 /* put old rs back, the caller will decide what to do */
2419 pill->rc_req->rq_reply_state = rs;
2422 nrs = pill->rc_req->rq_reply_state;
2423 /* Now we need only buffers, copy first chunk */
2424 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2425 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2426 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2427 memcpy(to, from, len);
2428 /* check if we have tail and copy it too */
2429 if (rs->rs_msg->lm_bufcount > offset + 1) {
2430 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2431 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2432 offset = rs->rs_msg->lm_bufcount - 1;
2433 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2434 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2435 memcpy(to, from, len);
2437 /* drop old reply if everything is fine */
2438 if (rs->rs_difficult) {
2442 nrs->rs_difficult = 1;
2443 nrs->rs_no_ack = rs->rs_no_ack;
2444 for (i = 0; i < rs->rs_nlocks; i++) {
2445 nrs->rs_locks[i] = rs->rs_locks[i];
2446 nrs->rs_modes[i] = rs->rs_modes[i];
2450 rs->rs_difficult = 0;
2453 ptlrpc_rs_decref(rs);
2456 EXPORT_SYMBOL(req_capsule_server_grow);
2457 /* __REQ_LAYOUT_USER__ */