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 *mds_getxattr_client[] = {
477 static const struct req_msg_field *mds_getxattr_server[] = {
483 static const struct req_msg_field *mds_getattr_server[] = {
492 static const struct req_msg_field *mds_setattr_server[] = {
501 static const struct req_msg_field *mds_update_client[] = {
506 static const struct req_msg_field *mds_update_server[] = {
511 static const struct req_msg_field *llog_origin_handle_create_client[] = {
517 static const struct req_msg_field *llogd_body_only[] = {
522 static const struct req_msg_field *llog_log_hdr_only[] = {
527 static const struct req_msg_field *llogd_conn_body_only[] = {
532 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
538 static const struct req_msg_field *obd_idx_read_client[] = {
543 static const struct req_msg_field *obd_idx_read_server[] = {
548 static const struct req_msg_field *ost_body_only[] = {
553 static const struct req_msg_field *ost_body_capa[] = {
559 static const struct req_msg_field *ost_destroy_client[] = {
567 static const struct req_msg_field *ost_brw_client[] = {
575 static const struct req_msg_field *ost_brw_read_server[] = {
580 static const struct req_msg_field *ost_brw_write_server[] = {
586 static const struct req_msg_field *ost_get_info_generic_server[] = {
591 static const struct req_msg_field *ost_get_info_generic_client[] = {
596 static const struct req_msg_field *ost_get_last_id_server[] = {
601 static const struct req_msg_field *ost_get_last_fid_server[] = {
606 static const struct req_msg_field *ost_get_fiemap_client[] = {
612 static const struct req_msg_field *ost_get_fiemap_server[] = {
617 static const struct req_msg_field *mdt_hsm_progress[] = {
620 &RMF_MDS_HSM_PROGRESS,
623 static const struct req_msg_field *mdt_hsm_ct_register[] = {
626 &RMF_MDS_HSM_ARCHIVE,
629 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
634 static const struct req_msg_field *mdt_hsm_action_server[] = {
637 &RMF_MDS_HSM_CURRENT_ACTION,
640 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
646 static const struct req_msg_field *mdt_hsm_state_set[] = {
653 static const struct req_msg_field *mdt_hsm_request[] = {
656 &RMF_MDS_HSM_REQUEST,
657 &RMF_MDS_HSM_USER_ITEM,
661 static struct req_format *req_formats[] = {
668 &RQF_MGS_CONFIG_READ,
677 &RQF_MDS_GETATTR_NAME,
681 &RQF_MDS_RELEASE_CLOSE,
687 &RQF_MDS_DONE_WRITING,
689 &RQF_MDS_REINT_CREATE,
690 &RQF_MDS_REINT_CREATE_RMT_ACL,
691 &RQF_MDS_REINT_CREATE_SLAVE,
692 &RQF_MDS_REINT_CREATE_SYM,
694 &RQF_MDS_REINT_UNLINK,
696 &RQF_MDS_REINT_RENAME,
697 &RQF_MDS_REINT_SETATTR,
698 &RQF_MDS_REINT_SETXATTR,
701 &RQF_MDS_HSM_PROGRESS,
702 &RQF_MDS_HSM_CT_REGISTER,
703 &RQF_MDS_HSM_CT_UNREGISTER,
704 &RQF_MDS_HSM_STATE_GET,
705 &RQF_MDS_HSM_STATE_SET,
707 &RQF_MDS_HSM_REQUEST,
708 &RQF_MDS_SWAP_LAYOUTS,
724 &RQF_OST_SET_GRANT_INFO,
725 &RQF_OST_GET_INFO_GENERIC,
726 &RQF_OST_GET_INFO_LAST_ID,
727 &RQF_OST_GET_INFO_LAST_FID,
728 &RQF_OST_SET_INFO_LAST_FID,
729 &RQF_OST_GET_INFO_FIEMAP,
731 &RQF_LDLM_ENQUEUE_LVB,
735 &RQF_LDLM_CP_CALLBACK,
736 &RQF_LDLM_BL_CALLBACK,
737 &RQF_LDLM_GL_CALLBACK,
738 &RQF_LDLM_GL_DESC_CALLBACK,
740 &RQF_LDLM_INTENT_BASIC,
741 &RQF_LDLM_INTENT_LAYOUT,
742 &RQF_LDLM_INTENT_GETATTR,
743 &RQF_LDLM_INTENT_OPEN,
744 &RQF_LDLM_INTENT_CREATE,
745 &RQF_LDLM_INTENT_UNLINK,
746 &RQF_LDLM_INTENT_QUOTA,
749 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
750 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
751 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
752 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
753 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
754 &RQF_LLOG_ORIGIN_CONNECT,
758 struct req_msg_field {
759 const __u32 rmf_flags;
760 const char *rmf_name;
762 * Field length. (-1) means "variable length". If the
763 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
764 * but the actual size must be a whole multiple of \a rmf_size.
767 void (*rmf_swabber)(void *);
768 void (*rmf_dumper)(void *);
769 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
774 * The field is a string, must be NUL-terminated.
776 RMF_F_STRING = 1 << 0,
778 * The field's buffer size need not match the declared \a rmf_size.
780 RMF_F_NO_SIZE_CHECK = 1 << 1,
782 * The field's buffer size must be a whole multiple of the declared \a
783 * rmf_size and the \a rmf_swabber function must work on the declared \a
784 * rmf_size worth of bytes.
786 RMF_F_STRUCT_ARRAY = 1 << 2
794 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
795 .rmf_name = (name), \
796 .rmf_flags = (flags), \
797 .rmf_size = (size), \
798 .rmf_swabber = (void (*)(void*))(swabber), \
799 .rmf_dumper = (void (*)(void*))(dumper) \
802 struct req_msg_field RMF_GENERIC_DATA =
803 DEFINE_MSGF("generic_data", 0,
805 EXPORT_SYMBOL(RMF_GENERIC_DATA);
807 struct req_msg_field RMF_MGS_TARGET_INFO =
808 DEFINE_MSGF("mgs_target_info", 0,
809 sizeof(struct mgs_target_info),
810 lustre_swab_mgs_target_info, NULL);
811 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
813 struct req_msg_field RMF_MGS_SEND_PARAM =
814 DEFINE_MSGF("mgs_send_param", 0,
815 sizeof(struct mgs_send_param),
817 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
819 struct req_msg_field RMF_MGS_CONFIG_BODY =
820 DEFINE_MSGF("mgs_config_read request", 0,
821 sizeof(struct mgs_config_body),
822 lustre_swab_mgs_config_body, NULL);
823 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
825 struct req_msg_field RMF_MGS_CONFIG_RES =
826 DEFINE_MSGF("mgs_config_read reply ", 0,
827 sizeof(struct mgs_config_res),
828 lustre_swab_mgs_config_res, NULL);
829 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
831 struct req_msg_field RMF_U32 =
832 DEFINE_MSGF("generic u32", 0,
833 sizeof(__u32), lustre_swab_generic_32s, NULL);
834 EXPORT_SYMBOL(RMF_U32);
836 struct req_msg_field RMF_SETINFO_VAL =
837 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
838 EXPORT_SYMBOL(RMF_SETINFO_VAL);
840 struct req_msg_field RMF_GETINFO_KEY =
841 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
842 EXPORT_SYMBOL(RMF_GETINFO_KEY);
844 struct req_msg_field RMF_GETINFO_VALLEN =
845 DEFINE_MSGF("getinfo_vallen", 0,
846 sizeof(__u32), lustre_swab_generic_32s, NULL);
847 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
849 struct req_msg_field RMF_GETINFO_VAL =
850 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
851 EXPORT_SYMBOL(RMF_GETINFO_VAL);
853 struct req_msg_field RMF_SEQ_OPC =
854 DEFINE_MSGF("seq_query_opc", 0,
855 sizeof(__u32), lustre_swab_generic_32s, NULL);
856 EXPORT_SYMBOL(RMF_SEQ_OPC);
858 struct req_msg_field RMF_SEQ_RANGE =
859 DEFINE_MSGF("seq_query_range", 0,
860 sizeof(struct lu_seq_range),
861 lustre_swab_lu_seq_range, NULL);
862 EXPORT_SYMBOL(RMF_SEQ_RANGE);
864 struct req_msg_field RMF_FLD_OPC =
865 DEFINE_MSGF("fld_query_opc", 0,
866 sizeof(__u32), lustre_swab_generic_32s, NULL);
867 EXPORT_SYMBOL(RMF_FLD_OPC);
869 struct req_msg_field RMF_FLD_MDFLD =
870 DEFINE_MSGF("fld_query_mdfld", 0,
871 sizeof(struct lu_seq_range),
872 lustre_swab_lu_seq_range, NULL);
873 EXPORT_SYMBOL(RMF_FLD_MDFLD);
875 struct req_msg_field RMF_MDT_BODY =
876 DEFINE_MSGF("mdt_body", 0,
877 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
878 EXPORT_SYMBOL(RMF_MDT_BODY);
880 struct req_msg_field RMF_OBD_QUOTACTL =
881 DEFINE_MSGF("obd_quotactl", 0,
882 sizeof(struct obd_quotactl),
883 lustre_swab_obd_quotactl, NULL);
884 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
886 struct req_msg_field RMF_QUOTA_BODY =
887 DEFINE_MSGF("quota_body", 0,
888 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
889 EXPORT_SYMBOL(RMF_QUOTA_BODY);
891 struct req_msg_field RMF_MDT_EPOCH =
892 DEFINE_MSGF("mdt_ioepoch", 0,
893 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
894 EXPORT_SYMBOL(RMF_MDT_EPOCH);
896 struct req_msg_field RMF_PTLRPC_BODY =
897 DEFINE_MSGF("ptlrpc_body", 0,
898 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
899 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
901 struct req_msg_field RMF_CLOSE_DATA =
902 DEFINE_MSGF("data_version", 0,
903 sizeof(struct close_data), lustre_swab_close_data, NULL);
904 EXPORT_SYMBOL(RMF_CLOSE_DATA);
906 struct req_msg_field RMF_OBD_STATFS =
907 DEFINE_MSGF("obd_statfs", 0,
908 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
909 EXPORT_SYMBOL(RMF_OBD_STATFS);
911 struct req_msg_field RMF_SETINFO_KEY =
912 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
913 EXPORT_SYMBOL(RMF_SETINFO_KEY);
915 struct req_msg_field RMF_NAME =
916 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
917 EXPORT_SYMBOL(RMF_NAME);
919 struct req_msg_field RMF_SYMTGT =
920 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
921 EXPORT_SYMBOL(RMF_SYMTGT);
923 struct req_msg_field RMF_TGTUUID =
924 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
926 EXPORT_SYMBOL(RMF_TGTUUID);
928 struct req_msg_field RMF_CLUUID =
929 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
931 EXPORT_SYMBOL(RMF_CLUUID);
933 struct req_msg_field RMF_STRING =
934 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
935 EXPORT_SYMBOL(RMF_STRING);
937 struct req_msg_field RMF_LLOGD_BODY =
938 DEFINE_MSGF("llogd_body", 0,
939 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
940 EXPORT_SYMBOL(RMF_LLOGD_BODY);
942 struct req_msg_field RMF_LLOG_LOG_HDR =
943 DEFINE_MSGF("llog_log_hdr", 0,
944 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
945 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
947 struct req_msg_field RMF_LLOGD_CONN_BODY =
948 DEFINE_MSGF("llogd_conn_body", 0,
949 sizeof(struct llogd_conn_body),
950 lustre_swab_llogd_conn_body, NULL);
951 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
954 * connection handle received in MDS_CONNECT request.
956 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
957 * that the client does not interpret at all.
959 struct req_msg_field RMF_CONN =
960 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
961 EXPORT_SYMBOL(RMF_CONN);
963 struct req_msg_field RMF_CONNECT_DATA =
965 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
966 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
967 sizeof(struct obd_connect_data),
969 /* For interoperability with 1.8 and 2.0 clients/servers.
970 * The RPC verification code allows larger RPC buffers, but not
971 * smaller buffers. Until we no longer need to keep compatibility
972 * with older servers/clients we can only check that the buffer
973 * size is at least as large as obd_connect_data_v1. That is not
974 * not in itself harmful, since the chance of just corrupting this
975 * field is low. See JIRA LU-16 for details. */
976 sizeof(struct obd_connect_data_v1),
978 lustre_swab_connect, NULL);
979 EXPORT_SYMBOL(RMF_CONNECT_DATA);
981 struct req_msg_field RMF_DLM_REQ =
982 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
983 sizeof(struct ldlm_request),
984 lustre_swab_ldlm_request, NULL);
985 EXPORT_SYMBOL(RMF_DLM_REQ);
987 struct req_msg_field RMF_DLM_REP =
988 DEFINE_MSGF("dlm_rep", 0,
989 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
990 EXPORT_SYMBOL(RMF_DLM_REP);
992 struct req_msg_field RMF_LDLM_INTENT =
993 DEFINE_MSGF("ldlm_intent", 0,
994 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
995 EXPORT_SYMBOL(RMF_LDLM_INTENT);
997 struct req_msg_field RMF_DLM_LVB =
998 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
999 EXPORT_SYMBOL(RMF_DLM_LVB);
1001 struct req_msg_field RMF_DLM_GL_DESC =
1002 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1003 lustre_swab_gl_desc, NULL);
1004 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1006 struct req_msg_field RMF_MDT_MD =
1007 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1008 EXPORT_SYMBOL(RMF_MDT_MD);
1010 struct req_msg_field RMF_REC_REINT =
1011 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1012 lustre_swab_mdt_rec_reint, NULL);
1013 EXPORT_SYMBOL(RMF_REC_REINT);
1015 /* FIXME: this length should be defined as a macro */
1016 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1018 EXPORT_SYMBOL(RMF_EADATA);
1020 struct req_msg_field RMF_ACL =
1021 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1022 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1023 EXPORT_SYMBOL(RMF_ACL);
1025 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1026 struct req_msg_field RMF_LOGCOOKIES =
1027 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1028 sizeof(struct llog_cookie), NULL, NULL);
1029 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1031 struct req_msg_field RMF_CAPA1 =
1032 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1033 lustre_swab_lustre_capa, NULL);
1034 EXPORT_SYMBOL(RMF_CAPA1);
1036 struct req_msg_field RMF_CAPA2 =
1037 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1038 lustre_swab_lustre_capa, NULL);
1039 EXPORT_SYMBOL(RMF_CAPA2);
1041 struct req_msg_field RMF_LAYOUT_INTENT =
1042 DEFINE_MSGF("layout_intent", 0,
1043 sizeof(struct layout_intent), lustre_swab_layout_intent,
1045 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1048 * OST request field.
1050 struct req_msg_field RMF_OST_BODY =
1051 DEFINE_MSGF("ost_body", 0,
1052 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1053 EXPORT_SYMBOL(RMF_OST_BODY);
1055 struct req_msg_field RMF_OBD_IOOBJ =
1056 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1057 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1058 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1060 struct req_msg_field RMF_NIOBUF_REMOTE =
1061 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1062 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1064 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1066 struct req_msg_field RMF_RCS =
1067 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1068 lustre_swab_generic_32s, dump_rcs);
1069 EXPORT_SYMBOL(RMF_RCS);
1071 struct req_msg_field RMF_OBD_ID =
1072 DEFINE_MSGF("obd_id", 0,
1073 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1074 EXPORT_SYMBOL(RMF_OBD_ID);
1076 struct req_msg_field RMF_FID =
1077 DEFINE_MSGF("fid", 0,
1078 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1079 EXPORT_SYMBOL(RMF_FID);
1081 struct req_msg_field RMF_OST_ID =
1082 DEFINE_MSGF("ost_id", 0,
1083 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1084 EXPORT_SYMBOL(RMF_OST_ID);
1086 struct req_msg_field RMF_FIEMAP_KEY =
1087 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1088 lustre_swab_fiemap, NULL);
1089 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1091 struct req_msg_field RMF_FIEMAP_VAL =
1092 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1093 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1095 struct req_msg_field RMF_IDX_INFO =
1096 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1097 lustre_swab_idx_info, NULL);
1098 EXPORT_SYMBOL(RMF_IDX_INFO);
1099 struct req_msg_field RMF_HSM_USER_STATE =
1100 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1101 lustre_swab_hsm_user_state, NULL);
1102 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1104 struct req_msg_field RMF_HSM_STATE_SET =
1105 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1106 lustre_swab_hsm_state_set, NULL);
1107 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1109 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1110 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1111 lustre_swab_hsm_progress_kernel, NULL);
1112 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1114 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1115 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1116 lustre_swab_hsm_current_action, NULL);
1117 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1119 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1120 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1121 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1123 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1125 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1126 DEFINE_MSGF("hsm_archive", 0,
1127 sizeof(__u32), lustre_swab_generic_32s, NULL);
1128 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1130 struct req_msg_field RMF_MDS_HSM_REQUEST =
1131 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1132 lustre_swab_hsm_request, NULL);
1133 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1135 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1136 lustre_swab_update_buf, NULL);
1137 EXPORT_SYMBOL(RMF_UPDATE);
1139 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1140 lustre_swab_update_reply_buf,
1142 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1144 struct req_msg_field RMF_SWAP_LAYOUTS =
1145 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1146 lustre_swab_swap_layouts, NULL);
1147 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1153 const char *rf_name;
1157 const struct req_msg_field **d;
1158 } rf_fields[RCL_NR];
1161 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1175 #define DEFINE_REQ_FMT0(name, client, server) \
1176 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1178 struct req_format RQF_OBD_PING =
1179 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1180 EXPORT_SYMBOL(RQF_OBD_PING);
1182 struct req_format RQF_OBD_SET_INFO =
1183 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1184 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1186 /* Read index file through the network */
1187 struct req_format RQF_OBD_IDX_READ =
1188 DEFINE_REQ_FMT0("OBD_IDX_READ",
1189 obd_idx_read_client, obd_idx_read_server);
1190 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1192 struct req_format RQF_SEC_CTX =
1193 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1194 EXPORT_SYMBOL(RQF_SEC_CTX);
1196 struct req_format RQF_MGS_TARGET_REG =
1197 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1198 mgs_target_info_only);
1199 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1201 struct req_format RQF_MGS_SET_INFO =
1202 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1204 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1206 struct req_format RQF_MGS_CONFIG_READ =
1207 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1208 mgs_config_read_server);
1209 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1211 struct req_format RQF_SEQ_QUERY =
1212 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1213 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1215 struct req_format RQF_FLD_QUERY =
1216 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1217 EXPORT_SYMBOL(RQF_FLD_QUERY);
1219 struct req_format RQF_LOG_CANCEL =
1220 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1221 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1223 struct req_format RQF_MDS_QUOTACHECK =
1224 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1225 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1227 struct req_format RQF_OST_QUOTACHECK =
1228 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1229 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1231 struct req_format RQF_MDS_QUOTACTL =
1232 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1233 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1235 struct req_format RQF_OST_QUOTACTL =
1236 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1237 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1239 struct req_format RQF_QC_CALLBACK =
1240 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1241 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1243 struct req_format RQF_QUOTA_DQACQ =
1244 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1245 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1247 struct req_format RQF_LDLM_INTENT_QUOTA =
1248 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1249 ldlm_intent_quota_client,
1250 ldlm_intent_quota_server);
1251 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1253 struct req_format RQF_MDS_GETSTATUS =
1254 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1255 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1257 struct req_format RQF_MDS_STATFS =
1258 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1259 EXPORT_SYMBOL(RQF_MDS_STATFS);
1261 struct req_format RQF_MDS_SYNC =
1262 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1263 EXPORT_SYMBOL(RQF_MDS_SYNC);
1265 struct req_format RQF_MDS_GETATTR =
1266 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1267 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1269 struct req_format RQF_MDS_GETXATTR =
1270 DEFINE_REQ_FMT0("MDS_GETXATTR",
1271 mds_getxattr_client, mds_getxattr_server);
1272 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1274 struct req_format RQF_MDS_GETATTR_NAME =
1275 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1276 mds_getattr_name_client, mds_getattr_server);
1277 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1279 struct req_format RQF_MDS_REINT =
1280 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1281 EXPORT_SYMBOL(RQF_MDS_REINT);
1283 struct req_format RQF_MDS_REINT_CREATE =
1284 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1285 mds_reint_create_client, mdt_body_capa);
1286 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1288 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1289 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1290 mds_reint_create_rmt_acl_client, mdt_body_capa);
1291 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1293 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1294 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1295 mds_reint_create_slave_client, mdt_body_capa);
1296 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1298 struct req_format RQF_MDS_REINT_CREATE_SYM =
1299 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1300 mds_reint_create_sym_client, mdt_body_capa);
1301 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1303 struct req_format RQF_MDS_REINT_OPEN =
1304 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1305 mds_reint_open_client, mds_reint_open_server);
1306 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1308 struct req_format RQF_MDS_REINT_UNLINK =
1309 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1310 mds_last_unlink_server);
1311 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1313 struct req_format RQF_MDS_REINT_LINK =
1314 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1315 mds_reint_link_client, mdt_body_only);
1316 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1318 struct req_format RQF_MDS_REINT_RENAME =
1319 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1320 mds_last_unlink_server);
1321 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1323 struct req_format RQF_MDS_REINT_SETATTR =
1324 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1325 mds_reint_setattr_client, mds_setattr_server);
1326 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1328 struct req_format RQF_MDS_REINT_SETXATTR =
1329 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1330 mds_reint_setxattr_client, mdt_body_only);
1331 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1333 struct req_format RQF_MDS_CONNECT =
1334 DEFINE_REQ_FMT0("MDS_CONNECT",
1335 obd_connect_client, obd_connect_server);
1336 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1338 struct req_format RQF_MDS_DISCONNECT =
1339 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1340 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1342 struct req_format RQF_MDS_GET_INFO =
1343 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1344 mds_getinfo_server);
1345 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1347 struct req_format RQF_UPDATE_OBJ =
1348 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1350 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1352 struct req_format RQF_LDLM_ENQUEUE =
1353 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1354 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1355 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1357 struct req_format RQF_LDLM_ENQUEUE_LVB =
1358 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1359 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1360 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1362 struct req_format RQF_LDLM_CONVERT =
1363 DEFINE_REQ_FMT0("LDLM_CONVERT",
1364 ldlm_enqueue_client, ldlm_enqueue_server);
1365 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1367 struct req_format RQF_LDLM_CANCEL =
1368 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1369 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1371 struct req_format RQF_LDLM_CALLBACK =
1372 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1373 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1375 struct req_format RQF_LDLM_CP_CALLBACK =
1376 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1377 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1379 struct req_format RQF_LDLM_BL_CALLBACK =
1380 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1381 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1383 struct req_format RQF_LDLM_GL_CALLBACK =
1384 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1385 ldlm_gl_callback_server);
1386 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1388 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1389 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1390 ldlm_gl_callback_server);
1391 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1393 struct req_format RQF_LDLM_INTENT_BASIC =
1394 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1395 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1396 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1398 struct req_format RQF_LDLM_INTENT =
1399 DEFINE_REQ_FMT0("LDLM_INTENT",
1400 ldlm_intent_client, ldlm_intent_server);
1401 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1403 struct req_format RQF_LDLM_INTENT_LAYOUT =
1404 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1405 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1406 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1408 struct req_format RQF_LDLM_INTENT_GETATTR =
1409 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1410 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1411 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1413 struct req_format RQF_LDLM_INTENT_OPEN =
1414 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1415 ldlm_intent_open_client, ldlm_intent_open_server);
1416 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1418 struct req_format RQF_LDLM_INTENT_CREATE =
1419 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1420 ldlm_intent_create_client, ldlm_intent_getattr_server);
1421 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1423 struct req_format RQF_LDLM_INTENT_UNLINK =
1424 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1425 ldlm_intent_unlink_client, ldlm_intent_server);
1426 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1428 struct req_format RQF_MDS_CLOSE =
1429 DEFINE_REQ_FMT0("MDS_CLOSE",
1430 mdt_close_client, mds_last_unlink_server);
1431 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1433 struct req_format RQF_MDS_RELEASE_CLOSE =
1434 DEFINE_REQ_FMT0("MDS_CLOSE",
1435 mdt_release_close_client, mds_last_unlink_server);
1436 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1438 struct req_format RQF_MDS_PIN =
1439 DEFINE_REQ_FMT0("MDS_PIN",
1440 mdt_body_capa, mdt_body_only);
1441 EXPORT_SYMBOL(RQF_MDS_PIN);
1443 struct req_format RQF_MDS_UNPIN =
1444 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1445 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1447 struct req_format RQF_MDS_DONE_WRITING =
1448 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1449 mdt_close_client, mdt_body_only);
1450 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1452 struct req_format RQF_MDS_READPAGE =
1453 DEFINE_REQ_FMT0("MDS_READPAGE",
1454 mdt_body_capa, mdt_body_only);
1455 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1457 struct req_format RQF_MDS_HSM_ACTION =
1458 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1459 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1461 struct req_format RQF_MDS_HSM_PROGRESS =
1462 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1463 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1465 struct req_format RQF_MDS_HSM_CT_REGISTER =
1466 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1467 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1469 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1470 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1471 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1473 struct req_format RQF_MDS_HSM_STATE_GET =
1474 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1475 mdt_body_capa, mdt_hsm_state_get_server);
1476 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1478 struct req_format RQF_MDS_HSM_STATE_SET =
1479 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1480 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1482 struct req_format RQF_MDS_HSM_REQUEST =
1483 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1484 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1486 struct req_format RQF_MDS_SWAP_LAYOUTS =
1487 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1488 mdt_swap_layouts, empty);
1489 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1491 /* This is for split */
1492 struct req_format RQF_MDS_WRITEPAGE =
1493 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1494 mdt_body_capa, mdt_body_only);
1495 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1497 struct req_format RQF_MDS_IS_SUBDIR =
1498 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1499 mdt_body_only, mdt_body_only);
1500 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1502 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1503 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1504 llog_origin_handle_create_client, llogd_body_only);
1505 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1507 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1508 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1509 llogd_body_only, llogd_body_only);
1510 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1512 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1513 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1514 llogd_body_only, llog_origin_handle_next_block_server);
1515 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1517 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1518 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1519 llogd_body_only, llog_origin_handle_next_block_server);
1520 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1522 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1523 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1524 llogd_body_only, llog_log_hdr_only);
1525 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1527 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1528 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1529 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1531 struct req_format RQF_CONNECT =
1532 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1533 EXPORT_SYMBOL(RQF_CONNECT);
1535 struct req_format RQF_OST_CONNECT =
1536 DEFINE_REQ_FMT0("OST_CONNECT",
1537 obd_connect_client, obd_connect_server);
1538 EXPORT_SYMBOL(RQF_OST_CONNECT);
1540 struct req_format RQF_OST_DISCONNECT =
1541 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1542 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1544 struct req_format RQF_OST_GETATTR =
1545 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1546 EXPORT_SYMBOL(RQF_OST_GETATTR);
1548 struct req_format RQF_OST_SETATTR =
1549 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1550 EXPORT_SYMBOL(RQF_OST_SETATTR);
1552 struct req_format RQF_OST_CREATE =
1553 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1554 EXPORT_SYMBOL(RQF_OST_CREATE);
1556 struct req_format RQF_OST_PUNCH =
1557 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1558 EXPORT_SYMBOL(RQF_OST_PUNCH);
1560 struct req_format RQF_OST_SYNC =
1561 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1562 EXPORT_SYMBOL(RQF_OST_SYNC);
1564 struct req_format RQF_OST_DESTROY =
1565 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1566 EXPORT_SYMBOL(RQF_OST_DESTROY);
1568 struct req_format RQF_OST_BRW_READ =
1569 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1570 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1572 struct req_format RQF_OST_BRW_WRITE =
1573 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1574 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1576 struct req_format RQF_OST_STATFS =
1577 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1578 EXPORT_SYMBOL(RQF_OST_STATFS);
1580 struct req_format RQF_OST_SET_GRANT_INFO =
1581 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1583 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1585 struct req_format RQF_OST_GET_INFO_GENERIC =
1586 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1587 ost_get_info_generic_server);
1588 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1590 struct req_format RQF_OST_GET_INFO_LAST_ID =
1591 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1592 ost_get_last_id_server);
1593 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1595 struct req_format RQF_OST_GET_INFO_LAST_FID =
1596 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", obd_set_info_client,
1597 ost_get_last_fid_server);
1598 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1600 struct req_format RQF_OST_SET_INFO_LAST_FID =
1601 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1603 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1605 struct req_format RQF_OST_GET_INFO_FIEMAP =
1606 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1607 ost_get_fiemap_server);
1608 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1610 #if !defined(__REQ_LAYOUT_USER__)
1612 /* Convenience macro */
1613 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1616 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1617 * field of RQFs and the \a rmf_offset field of RMFs.
1619 int req_layout_init(void)
1624 struct req_format *rf = NULL;
1626 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1627 rf = req_formats[i];
1629 for (j = 0; j < RCL_NR; ++j) {
1630 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1631 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1632 struct req_msg_field *field;
1634 field = (typeof(field))rf->rf_fields[j].d[k];
1635 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1636 || field->rmf_size > 0);
1637 LASSERT(field->rmf_offset[i][j] == 0);
1639 * k + 1 to detect unused format/field
1642 field->rmf_offset[i][j] = k + 1;
1648 EXPORT_SYMBOL(req_layout_init);
1650 void req_layout_fini(void)
1653 EXPORT_SYMBOL(req_layout_fini);
1656 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1658 * Actual/expected field sizes are set elsewhere in functions in this file:
1659 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1660 * req_capsule_msg_size(). The \a rc_area information is used by.
1661 * ptlrpc_request_set_replen().
1663 void req_capsule_init_area(struct req_capsule *pill)
1667 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1668 pill->rc_area[RCL_CLIENT][i] = -1;
1669 pill->rc_area[RCL_SERVER][i] = -1;
1672 EXPORT_SYMBOL(req_capsule_init_area);
1675 * Initialize a pill.
1677 * The \a location indicates whether the caller is executing on the client side
1678 * (RCL_CLIENT) or server side (RCL_SERVER)..
1680 void req_capsule_init(struct req_capsule *pill,
1681 struct ptlrpc_request *req,
1682 enum req_location location)
1684 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1687 * Today all capsules are embedded in ptlrpc_request structs,
1688 * but just in case that ever isn't the case, we don't reach
1689 * into req unless req != NULL and pill is the one embedded in
1692 * The req->rq_pill_init flag makes it safe to initialize a pill
1693 * twice, which might happen in the OST paths as a result of the
1694 * high-priority RPC queue getting peeked at before ost_handle()
1695 * handles an OST RPC.
1697 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1700 memset(pill, 0, sizeof *pill);
1702 pill->rc_loc = location;
1703 req_capsule_init_area(pill);
1705 if (req != NULL && pill == &req->rq_pill)
1706 req->rq_pill_init = 1;
1708 EXPORT_SYMBOL(req_capsule_init);
1710 void req_capsule_fini(struct req_capsule *pill)
1713 EXPORT_SYMBOL(req_capsule_fini);
1715 static int __req_format_is_sane(const struct req_format *fmt)
1718 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1719 req_formats[fmt->rf_idx] == fmt;
1722 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1723 enum req_location loc)
1725 struct ptlrpc_request *req;
1728 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1732 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1733 * (see req_capsule_extend()).
1735 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1737 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1738 LASSERT(__req_format_is_sane(fmt));
1742 EXPORT_SYMBOL(req_capsule_set);
1745 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1748 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1749 * variable-sized fields. The field sizes come from the declared \a rmf_size
1750 * field of a \a pill's \a rc_fmt's RMF's.
1752 int req_capsule_filled_sizes(struct req_capsule *pill,
1753 enum req_location loc)
1755 const struct req_format *fmt = pill->rc_fmt;
1758 LASSERT(fmt != NULL);
1760 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1761 if (pill->rc_area[loc][i] == -1) {
1762 pill->rc_area[loc][i] =
1763 fmt->rf_fields[loc].d[i]->rmf_size;
1764 if (pill->rc_area[loc][i] == -1) {
1766 * Skip the following fields.
1768 * If this LASSERT() trips then you're missing a
1769 * call to req_capsule_set_size().
1771 LASSERT(loc != RCL_SERVER);
1778 EXPORT_SYMBOL(req_capsule_filled_sizes);
1781 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1783 * This function uses the \a pill's \a rc_area as filled in by
1784 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1787 int req_capsule_server_pack(struct req_capsule *pill)
1789 const struct req_format *fmt;
1793 LASSERT(pill->rc_loc == RCL_SERVER);
1795 LASSERT(fmt != NULL);
1797 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1798 rc = lustre_pack_reply(pill->rc_req, count,
1799 pill->rc_area[RCL_SERVER], NULL);
1801 DEBUG_REQ(D_ERROR, pill->rc_req,
1802 "Cannot pack %d fields in format `%s': ",
1803 count, fmt->rf_name);
1807 EXPORT_SYMBOL(req_capsule_server_pack);
1810 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1811 * corresponding to the given RMF (\a field).
1813 static int __req_capsule_offset(const struct req_capsule *pill,
1814 const struct req_msg_field *field,
1815 enum req_location loc)
1819 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1820 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1821 pill->rc_fmt->rf_name,
1822 field->rmf_name, offset, loc);
1825 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1830 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1835 swabber_dumper_helper(struct req_capsule *pill,
1836 const struct req_msg_field *field,
1837 enum req_location loc,
1839 void *value, int len, int dump, void (*swabber)( void *))
1845 int inout = loc == RCL_CLIENT;
1847 swabber = swabber ?: field->rmf_swabber;
1849 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1850 swabber != NULL && value != NULL)
1855 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1856 if (dump && field->rmf_dumper) {
1857 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1858 do_swab ? "unswabbed " : "", field->rmf_name);
1859 field->rmf_dumper(value);
1864 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1866 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1867 "follows\n", field->rmf_name);
1868 field->rmf_dumper(value);
1875 * We're swabbing an array; swabber() swabs a single array element, so
1876 * swab every element.
1878 LASSERT((len % field->rmf_size) == 0);
1879 for (p = value, i = 0, n = len / field->rmf_size;
1881 i++, p += field->rmf_size) {
1882 if (dump && field->rmf_dumper) {
1883 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1884 "element %d follows\n",
1885 do_swab ? "unswabbed " : "", field->rmf_name, i);
1886 field->rmf_dumper(p);
1891 if (dump && field->rmf_dumper) {
1892 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1893 "element %d follows\n", field->rmf_name, i);
1894 field->rmf_dumper(value);
1898 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1902 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1903 * corresponding to the given RMF (\a field).
1905 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1906 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1907 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1908 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1909 * element of the array swabbed.
1911 static void *__req_capsule_get(struct req_capsule *pill,
1912 const struct req_msg_field *field,
1913 enum req_location loc,
1914 void (*swabber)( void *),
1917 const struct req_format *fmt;
1918 struct lustre_msg *msg;
1923 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1925 static const char *rcl_names[RCL_NR] = {
1926 [RCL_CLIENT] = "client",
1927 [RCL_SERVER] = "server"
1930 LASSERT(pill != NULL);
1931 LASSERT(pill != LP_POISON);
1933 LASSERT(fmt != NULL);
1934 LASSERT(fmt != LP_POISON);
1935 LASSERT(__req_format_is_sane(fmt));
1937 offset = __req_capsule_offset(pill, field, loc);
1939 msg = __req_msg(pill, loc);
1940 LASSERT(msg != NULL);
1942 getter = (field->rmf_flags & RMF_F_STRING) ?
1943 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1945 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1947 * We've already asserted that field->rmf_size > 0 in
1948 * req_layout_init().
1950 len = lustre_msg_buflen(msg, offset);
1951 if ((len % field->rmf_size) != 0) {
1952 CERROR("%s: array field size mismatch "
1953 "%d modulo %d != 0 (%d)\n",
1954 field->rmf_name, len, field->rmf_size, loc);
1957 } else if (pill->rc_area[loc][offset] != -1) {
1958 len = pill->rc_area[loc][offset];
1960 len = max(field->rmf_size, 0);
1962 value = getter(msg, offset, len);
1964 if (value == NULL) {
1965 DEBUG_REQ(D_ERROR, pill->rc_req,
1966 "Wrong buffer for field `%s' (%d of %d) "
1967 "in format `%s': %d vs. %d (%s)\n",
1968 field->rmf_name, offset, lustre_msg_bufcount(msg),
1969 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1972 swabber_dumper_helper(pill, field, loc, offset, value, len,
1980 * Dump a request and/or reply
1982 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1984 const struct req_format *fmt;
1985 const struct req_msg_field *field;
1991 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1992 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1993 field = FMT_FIELD(fmt, loc, i);
1994 if (field->rmf_dumper == NULL) {
1996 * FIXME Add a default hex dumper for fields that don't
1997 * have a specific dumper
1999 len = req_capsule_get_size(pill, field, loc);
2000 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2001 "field size is %d\n", field->rmf_name, len);
2003 /* It's the dumping side-effect that we're interested in */
2004 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2007 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2013 void req_capsule_client_dump(struct req_capsule *pill)
2015 __req_capsule_dump(pill, RCL_CLIENT);
2017 EXPORT_SYMBOL(req_capsule_client_dump);
2022 void req_capsule_server_dump(struct req_capsule *pill)
2024 __req_capsule_dump(pill, RCL_SERVER);
2026 EXPORT_SYMBOL(req_capsule_server_dump);
2029 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2030 * buffer corresponding to the given RMF (\a field) of a \a pill.
2032 void *req_capsule_client_get(struct req_capsule *pill,
2033 const struct req_msg_field *field)
2035 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2037 EXPORT_SYMBOL(req_capsule_client_get);
2040 * Same as req_capsule_client_get(), but with a \a swabber argument.
2042 * Currently unused; will be removed when req_capsule_server_swab_get() is
2045 void *req_capsule_client_swab_get(struct req_capsule *pill,
2046 const struct req_msg_field *field,
2049 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2051 EXPORT_SYMBOL(req_capsule_client_swab_get);
2054 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2056 * First the \a pill's request \a field's size is set (\a rc_area) using
2057 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2060 void *req_capsule_client_sized_get(struct req_capsule *pill,
2061 const struct req_msg_field *field,
2064 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2065 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2067 EXPORT_SYMBOL(req_capsule_client_sized_get);
2070 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2071 * buffer corresponding to the given RMF (\a field) of a \a pill.
2073 void *req_capsule_server_get(struct req_capsule *pill,
2074 const struct req_msg_field *field)
2076 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2078 EXPORT_SYMBOL(req_capsule_server_get);
2081 * Same as req_capsule_server_get(), but with a \a swabber argument.
2083 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2084 * swabbing done outside this capsule abstraction.
2086 void *req_capsule_server_swab_get(struct req_capsule *pill,
2087 const struct req_msg_field *field,
2090 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2092 EXPORT_SYMBOL(req_capsule_server_swab_get);
2095 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2097 * First the \a pill's request \a field's size is set (\a rc_area) using
2098 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2101 void *req_capsule_server_sized_get(struct req_capsule *pill,
2102 const struct req_msg_field *field,
2105 req_capsule_set_size(pill, field, RCL_SERVER, len);
2106 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2108 EXPORT_SYMBOL(req_capsule_server_sized_get);
2110 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2111 const struct req_msg_field *field,
2112 int len, void *swabber)
2114 req_capsule_set_size(pill, field, RCL_SERVER, len);
2115 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2117 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2120 * Returns the buffer of a \a pill corresponding to the given \a field from the
2121 * request (if the caller is executing on the server-side) or reply (if the
2122 * caller is executing on the client-side).
2124 * This function convienient for use is code that could be executed on the
2125 * client and server alike.
2127 const void *req_capsule_other_get(struct req_capsule *pill,
2128 const struct req_msg_field *field)
2130 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2132 EXPORT_SYMBOL(req_capsule_other_get);
2135 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2136 * field of the given \a pill.
2138 * This function must be used when constructing variable sized fields of a
2141 void req_capsule_set_size(struct req_capsule *pill,
2142 const struct req_msg_field *field,
2143 enum req_location loc, int size)
2145 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2147 if ((size != field->rmf_size) &&
2148 (field->rmf_size != -1) &&
2149 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2151 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2152 (size % field->rmf_size != 0)) {
2153 CERROR("%s: array field size mismatch "
2154 "%d %% %d != 0 (%d)\n",
2155 field->rmf_name, size, field->rmf_size, loc);
2157 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2158 size < field->rmf_size) {
2159 CERROR("%s: field size mismatch %d != %d (%d)\n",
2160 field->rmf_name, size, field->rmf_size, loc);
2165 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2167 EXPORT_SYMBOL(req_capsule_set_size);
2170 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2171 * for the given \a pill's given \a field.
2173 * NB: this function doesn't correspond with req_capsule_set_size(), which
2174 * actually sets the size in pill.rc_area[loc][offset], but this function
2175 * returns the message buflen[offset], maybe we should use another name.
2177 int req_capsule_get_size(const struct req_capsule *pill,
2178 const struct req_msg_field *field,
2179 enum req_location loc)
2181 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2183 return lustre_msg_buflen(__req_msg(pill, loc),
2184 __req_capsule_offset(pill, field, loc));
2186 EXPORT_SYMBOL(req_capsule_get_size);
2189 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2190 * given \a pill's request or reply (\a loc) given the field size recorded in
2191 * the \a pill's rc_area.
2193 * See also req_capsule_set_size().
2195 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2197 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2198 pill->rc_fmt->rf_fields[loc].nr,
2199 pill->rc_area[loc]);
2203 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2204 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2205 * PTLRPC request or reply given only an RQF (\a fmt).
2207 * This function should not be used for formats which contain variable size
2210 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2211 enum req_location loc)
2216 * This function should probably LASSERT() that fmt has no fields with
2217 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2218 * elements in the array there will ultimately be, but then, we could
2219 * assume that there will be at least one element, and that's just what
2222 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2226 for (; i < fmt->rf_fields[loc].nr; ++i)
2227 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2228 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2234 * Changes the format of an RPC.
2236 * The pill must already have been initialized, which means that it already has
2237 * a request format. The new format \a fmt must be an extension of the pill's
2238 * old format. Specifically: the new format must have as many request and reply
2239 * fields as the old one, and all fields shared by the old and new format must
2240 * be at least as large in the new format.
2242 * The new format's fields may be of different "type" than the old format, but
2243 * only for fields that are "opaque" blobs: fields which have a) have no
2244 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2245 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2246 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2247 * according to the key field. When the value, according to the key, contains a
2248 * structure (or array thereof) to be swabbed, the format should be changed to
2249 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2252 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2257 const struct req_format *old;
2259 LASSERT(pill->rc_fmt != NULL);
2260 LASSERT(__req_format_is_sane(fmt));
2264 * Sanity checking...
2266 for (i = 0; i < RCL_NR; ++i) {
2267 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2268 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2269 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2271 /* "opaque" fields can be transmogrified */
2272 if (ofield->rmf_swabber == NULL &&
2273 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2274 (ofield->rmf_size == -1 ||
2275 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2277 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2280 * Last field in old format can be shorter than in new.
2282 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2283 FMT_FIELD(old, i, j)->rmf_size);
2288 EXPORT_SYMBOL(req_capsule_extend);
2291 * This function returns a non-zero value if the given \a field is present in
2292 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2295 int req_capsule_has_field(const struct req_capsule *pill,
2296 const struct req_msg_field *field,
2297 enum req_location loc)
2299 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2301 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2303 EXPORT_SYMBOL(req_capsule_has_field);
2306 * Returns a non-zero value if the given \a field is present in the given \a
2307 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2309 int req_capsule_field_present(const struct req_capsule *pill,
2310 const struct req_msg_field *field,
2311 enum req_location loc)
2315 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2316 LASSERT(req_capsule_has_field(pill, field, loc));
2318 offset = __req_capsule_offset(pill, field, loc);
2319 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2321 EXPORT_SYMBOL(req_capsule_field_present);
2324 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2325 * request or reply (\a loc).
2327 * This is not the opposite of req_capsule_extend().
2329 void req_capsule_shrink(struct req_capsule *pill,
2330 const struct req_msg_field *field,
2331 unsigned int newlen,
2332 enum req_location loc)
2334 const struct req_format *fmt;
2335 struct lustre_msg *msg;
2340 LASSERT(fmt != NULL);
2341 LASSERT(__req_format_is_sane(fmt));
2342 LASSERT(req_capsule_has_field(pill, field, loc));
2343 LASSERT(req_capsule_field_present(pill, field, loc));
2345 offset = __req_capsule_offset(pill, field, loc);
2347 msg = __req_msg(pill, loc);
2348 len = lustre_msg_buflen(msg, offset);
2349 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2350 fmt->rf_name, field->rmf_name, len, newlen);
2352 if (loc == RCL_CLIENT)
2353 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2356 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2359 EXPORT_SYMBOL(req_capsule_shrink);
2361 int req_capsule_server_grow(struct req_capsule *pill,
2362 const struct req_msg_field *field,
2363 unsigned int newlen)
2365 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2367 int offset, len, rc;
2369 LASSERT(pill->rc_fmt != NULL);
2370 LASSERT(__req_format_is_sane(pill->rc_fmt));
2371 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2372 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2374 len = req_capsule_get_size(pill, field, RCL_SERVER);
2375 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2376 if (pill->rc_req->rq_repbuf_len >=
2377 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2378 CERROR("Inplace repack might be done\n");
2380 pill->rc_req->rq_reply_state = NULL;
2381 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2382 rc = req_capsule_server_pack(pill);
2384 /* put old rs back, the caller will decide what to do */
2385 pill->rc_req->rq_reply_state = rs;
2388 nrs = pill->rc_req->rq_reply_state;
2389 /* Now we need only buffers, copy first chunk */
2390 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2391 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2392 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2393 memcpy(to, from, len);
2394 /* check if we have tail and copy it too */
2395 if (rs->rs_msg->lm_bufcount > offset + 1) {
2396 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2397 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2398 offset = rs->rs_msg->lm_bufcount - 1;
2399 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2400 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2401 memcpy(to, from, len);
2403 /* drop old reply if everything is fine */
2404 if (rs->rs_difficult) {
2408 nrs->rs_difficult = 1;
2409 nrs->rs_no_ack = rs->rs_no_ack;
2410 for (i = 0; i < rs->rs_nlocks; i++) {
2411 nrs->rs_locks[i] = rs->rs_locks[i];
2412 nrs->rs_modes[i] = rs->rs_modes[i];
2416 rs->rs_difficult = 0;
2419 ptlrpc_rs_decref(rs);
2422 EXPORT_SYMBOL(req_capsule_server_grow);
2423 /* __REQ_LAYOUT_USER__ */