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, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
53 #include <linux/module.h>
55 /* LUSTRE_VERSION_CODE */
56 #include <lustre_ver.h>
58 #include <obd_support.h>
59 /* lustre_swab_mdt_body */
60 #include <lustre/lustre_idl.h>
61 /* obd2cli_tgt() (required by DEBUG_REQ()) */
64 /* __REQ_LAYOUT_USER__ */
66 /* struct ptlrpc_request, lustre_msg* */
67 #include <lustre_req_layout.h>
68 #include <lustre_update.h>
69 #include <lustre_acl.h>
70 #include <lustre_debug.h>
73 * RQFs (see below) refer to two struct req_msg_field arrays describing the
74 * client request and server reply, respectively.
76 /* empty set of fields... for suitable definition of emptiness. */
77 static const struct req_msg_field *empty[] = {
81 static const struct req_msg_field *mgs_target_info_only[] = {
86 static const struct req_msg_field *mgs_set_info[] = {
91 static const struct req_msg_field *mgs_config_read_client[] = {
96 static const struct req_msg_field *mgs_config_read_server[] = {
101 static const struct req_msg_field *log_cancel_client[] = {
106 static const struct req_msg_field *mdt_body_only[] = {
111 static const struct req_msg_field *mdt_body_capa[] = {
117 static const struct req_msg_field *quotactl_only[] = {
122 static const struct req_msg_field *quota_body_only[] = {
127 static const struct req_msg_field *ldlm_intent_quota_client[] = {
134 static const struct req_msg_field *ldlm_intent_quota_server[] = {
141 static const struct req_msg_field *mdt_close_client[] = {
148 static const struct req_msg_field *obd_statfs_server[] = {
153 static const struct req_msg_field *seq_query_client[] = {
159 static const struct req_msg_field *seq_query_server[] = {
164 static const struct req_msg_field *fld_query_client[] = {
170 static const struct req_msg_field *fld_query_server[] = {
175 static const struct req_msg_field *mds_getattr_name_client[] = {
182 static const struct req_msg_field *mds_reint_client[] = {
187 static const struct req_msg_field *mds_reint_create_client[] = {
194 static const struct req_msg_field *mds_reint_create_slave_client[] = {
203 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
212 static const struct req_msg_field *mds_reint_create_sym_client[] = {
221 static const struct req_msg_field *mds_reint_open_client[] = {
230 static const struct req_msg_field *mds_reint_open_server[] = {
239 static const struct req_msg_field *mds_reint_unlink_client[] = {
247 static const struct req_msg_field *mds_reint_link_client[] = {
256 static const struct req_msg_field *mds_reint_rename_client[] = {
266 static const struct req_msg_field *mds_last_unlink_server[] = {
275 static const struct req_msg_field *mds_reint_setattr_client[] = {
285 static const struct req_msg_field *mds_reint_setxattr_client[] = {
293 static const struct req_msg_field *mdt_swap_layouts[] = {
302 static const struct req_msg_field *obd_connect_client[] = {
310 static const struct req_msg_field *obd_connect_server[] = {
315 static const struct req_msg_field *obd_set_info_client[] = {
321 static const struct req_msg_field *ost_grant_shrink_client[] = {
327 static const struct req_msg_field *mds_getinfo_client[] = {
333 static const struct req_msg_field *mds_getinfo_server[] = {
338 static const struct req_msg_field *ldlm_enqueue_client[] = {
343 static const struct req_msg_field *ldlm_enqueue_server[] = {
348 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
354 static const struct req_msg_field *ldlm_cp_callback_client[] = {
360 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
366 static const struct req_msg_field *ldlm_gl_callback_server[] = {
371 static const struct req_msg_field *ldlm_intent_basic_client[] = {
377 static const struct req_msg_field *ldlm_intent_client[] = {
384 static const struct req_msg_field *ldlm_intent_server[] = {
392 static const struct req_msg_field *ldlm_intent_layout_client[] = {
397 &RMF_EADATA /* for new layout to be set up */
399 static const struct req_msg_field *ldlm_intent_open_server[] = {
409 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
413 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
418 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
427 static const struct req_msg_field *ldlm_intent_create_client[] = {
431 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
437 static const struct req_msg_field *ldlm_intent_open_client[] = {
441 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
448 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
452 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
457 static const struct req_msg_field *mds_getxattr_client[] = {
465 static const struct req_msg_field *mds_getxattr_server[] = {
471 static const struct req_msg_field *mds_getattr_server[] = {
480 static const struct req_msg_field *mds_setattr_server[] = {
489 static const struct req_msg_field *mds_update_client[] = {
494 static const struct req_msg_field *mds_update_server[] = {
499 static const struct req_msg_field *llog_origin_handle_create_client[] = {
505 static const struct req_msg_field *llogd_body_only[] = {
510 static const struct req_msg_field *llog_log_hdr_only[] = {
515 static const struct req_msg_field *llogd_conn_body_only[] = {
520 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
526 static const struct req_msg_field *obd_idx_read_client[] = {
531 static const struct req_msg_field *obd_idx_read_server[] = {
536 static const struct req_msg_field *ost_body_only[] = {
541 static const struct req_msg_field *ost_body_capa[] = {
547 static const struct req_msg_field *ost_destroy_client[] = {
555 static const struct req_msg_field *ost_brw_client[] = {
563 static const struct req_msg_field *ost_brw_read_server[] = {
568 static const struct req_msg_field *ost_brw_write_server[] = {
574 static const struct req_msg_field *ost_get_info_generic_server[] = {
579 static const struct req_msg_field *ost_get_info_generic_client[] = {
584 static const struct req_msg_field *ost_get_last_id_server[] = {
589 static const struct req_msg_field *ost_get_last_fid_server[] = {
594 static const struct req_msg_field *ost_get_fiemap_client[] = {
600 static const struct req_msg_field *ost_get_fiemap_server[] = {
605 static const struct req_msg_field *mdt_hsm_progress[] = {
608 &RMF_MDS_HSM_PROGRESS,
611 static const struct req_msg_field *mdt_hsm_ct_register[] = {
614 &RMF_MDS_HSM_ARCHIVE,
617 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
622 static const struct req_msg_field *mdt_hsm_action_server[] = {
625 &RMF_MDS_HSM_CURRENT_ACTION,
628 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
634 static const struct req_msg_field *mdt_hsm_state_set[] = {
641 static const struct req_msg_field *mdt_hsm_request[] = {
644 &RMF_MDS_HSM_REQUEST,
645 &RMF_MDS_HSM_USER_ITEM,
649 static struct req_format *req_formats[] = {
656 &RQF_MGS_CONFIG_READ,
665 &RQF_MDS_GETATTR_NAME,
674 &RQF_MDS_DONE_WRITING,
676 &RQF_MDS_REINT_CREATE,
677 &RQF_MDS_REINT_CREATE_RMT_ACL,
678 &RQF_MDS_REINT_CREATE_SLAVE,
679 &RQF_MDS_REINT_CREATE_SYM,
681 &RQF_MDS_REINT_UNLINK,
683 &RQF_MDS_REINT_RENAME,
684 &RQF_MDS_REINT_SETATTR,
685 &RQF_MDS_REINT_SETXATTR,
688 &RQF_MDS_HSM_PROGRESS,
689 &RQF_MDS_HSM_CT_REGISTER,
690 &RQF_MDS_HSM_CT_UNREGISTER,
691 &RQF_MDS_HSM_STATE_GET,
692 &RQF_MDS_HSM_STATE_SET,
694 &RQF_MDS_HSM_REQUEST,
695 &RQF_MDS_SWAP_LAYOUTS,
711 &RQF_OST_SET_GRANT_INFO,
712 &RQF_OST_GET_INFO_GENERIC,
713 &RQF_OST_GET_INFO_LAST_ID,
714 &RQF_OST_GET_INFO_LAST_FID,
715 &RQF_OST_SET_INFO_LAST_FID,
716 &RQF_OST_GET_INFO_FIEMAP,
718 &RQF_LDLM_ENQUEUE_LVB,
722 &RQF_LDLM_CP_CALLBACK,
723 &RQF_LDLM_BL_CALLBACK,
724 &RQF_LDLM_GL_CALLBACK,
725 &RQF_LDLM_GL_DESC_CALLBACK,
727 &RQF_LDLM_INTENT_BASIC,
728 &RQF_LDLM_INTENT_LAYOUT,
729 &RQF_LDLM_INTENT_GETATTR,
730 &RQF_LDLM_INTENT_OPEN,
731 &RQF_LDLM_INTENT_CREATE,
732 &RQF_LDLM_INTENT_UNLINK,
733 &RQF_LDLM_INTENT_QUOTA,
736 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
737 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
738 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
739 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
740 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
741 &RQF_LLOG_ORIGIN_CONNECT
744 struct req_msg_field {
745 const __u32 rmf_flags;
746 const char *rmf_name;
748 * Field length. (-1) means "variable length". If the
749 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
750 * but the actual size must be a whole multiple of \a rmf_size.
753 void (*rmf_swabber)(void *);
754 void (*rmf_dumper)(void *);
755 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
760 * The field is a string, must be NUL-terminated.
762 RMF_F_STRING = 1 << 0,
764 * The field's buffer size need not match the declared \a rmf_size.
766 RMF_F_NO_SIZE_CHECK = 1 << 1,
768 * The field's buffer size must be a whole multiple of the declared \a
769 * rmf_size and the \a rmf_swabber function must work on the declared \a
770 * rmf_size worth of bytes.
772 RMF_F_STRUCT_ARRAY = 1 << 2
780 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
781 .rmf_name = (name), \
782 .rmf_flags = (flags), \
783 .rmf_size = (size), \
784 .rmf_swabber = (void (*)(void*))(swabber), \
785 .rmf_dumper = (void (*)(void*))(dumper) \
788 struct req_msg_field RMF_GENERIC_DATA =
789 DEFINE_MSGF("generic_data", 0,
791 EXPORT_SYMBOL(RMF_GENERIC_DATA);
793 struct req_msg_field RMF_MGS_TARGET_INFO =
794 DEFINE_MSGF("mgs_target_info", 0,
795 sizeof(struct mgs_target_info),
796 lustre_swab_mgs_target_info, NULL);
797 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
799 struct req_msg_field RMF_MGS_SEND_PARAM =
800 DEFINE_MSGF("mgs_send_param", 0,
801 sizeof(struct mgs_send_param),
803 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
805 struct req_msg_field RMF_MGS_CONFIG_BODY =
806 DEFINE_MSGF("mgs_config_read request", 0,
807 sizeof(struct mgs_config_body),
808 lustre_swab_mgs_config_body, NULL);
809 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
811 struct req_msg_field RMF_MGS_CONFIG_RES =
812 DEFINE_MSGF("mgs_config_read reply ", 0,
813 sizeof(struct mgs_config_res),
814 lustre_swab_mgs_config_res, NULL);
815 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
817 struct req_msg_field RMF_U32 =
818 DEFINE_MSGF("generic u32", 0,
819 sizeof(__u32), lustre_swab_generic_32s, NULL);
820 EXPORT_SYMBOL(RMF_U32);
822 struct req_msg_field RMF_SETINFO_VAL =
823 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
824 EXPORT_SYMBOL(RMF_SETINFO_VAL);
826 struct req_msg_field RMF_GETINFO_KEY =
827 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
828 EXPORT_SYMBOL(RMF_GETINFO_KEY);
830 struct req_msg_field RMF_GETINFO_VALLEN =
831 DEFINE_MSGF("getinfo_vallen", 0,
832 sizeof(__u32), lustre_swab_generic_32s, NULL);
833 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
835 struct req_msg_field RMF_GETINFO_VAL =
836 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
837 EXPORT_SYMBOL(RMF_GETINFO_VAL);
839 struct req_msg_field RMF_SEQ_OPC =
840 DEFINE_MSGF("seq_query_opc", 0,
841 sizeof(__u32), lustre_swab_generic_32s, NULL);
842 EXPORT_SYMBOL(RMF_SEQ_OPC);
844 struct req_msg_field RMF_SEQ_RANGE =
845 DEFINE_MSGF("seq_query_range", 0,
846 sizeof(struct lu_seq_range),
847 lustre_swab_lu_seq_range, NULL);
848 EXPORT_SYMBOL(RMF_SEQ_RANGE);
850 struct req_msg_field RMF_FLD_OPC =
851 DEFINE_MSGF("fld_query_opc", 0,
852 sizeof(__u32), lustre_swab_generic_32s, NULL);
853 EXPORT_SYMBOL(RMF_FLD_OPC);
855 struct req_msg_field RMF_FLD_MDFLD =
856 DEFINE_MSGF("fld_query_mdfld", 0,
857 sizeof(struct lu_seq_range),
858 lustre_swab_lu_seq_range, NULL);
859 EXPORT_SYMBOL(RMF_FLD_MDFLD);
861 struct req_msg_field RMF_MDT_BODY =
862 DEFINE_MSGF("mdt_body", 0,
863 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
864 EXPORT_SYMBOL(RMF_MDT_BODY);
866 struct req_msg_field RMF_OBD_QUOTACTL =
867 DEFINE_MSGF("obd_quotactl", 0,
868 sizeof(struct obd_quotactl),
869 lustre_swab_obd_quotactl, NULL);
870 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
872 struct req_msg_field RMF_QUOTA_BODY =
873 DEFINE_MSGF("quota_body", 0,
874 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
875 EXPORT_SYMBOL(RMF_QUOTA_BODY);
877 struct req_msg_field RMF_MDT_EPOCH =
878 DEFINE_MSGF("mdt_ioepoch", 0,
879 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
880 EXPORT_SYMBOL(RMF_MDT_EPOCH);
882 struct req_msg_field RMF_PTLRPC_BODY =
883 DEFINE_MSGF("ptlrpc_body", 0,
884 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
885 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
887 struct req_msg_field RMF_OBD_STATFS =
888 DEFINE_MSGF("obd_statfs", 0,
889 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
890 EXPORT_SYMBOL(RMF_OBD_STATFS);
892 struct req_msg_field RMF_SETINFO_KEY =
893 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
894 EXPORT_SYMBOL(RMF_SETINFO_KEY);
896 struct req_msg_field RMF_NAME =
897 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
898 EXPORT_SYMBOL(RMF_NAME);
900 struct req_msg_field RMF_SYMTGT =
901 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
902 EXPORT_SYMBOL(RMF_SYMTGT);
904 struct req_msg_field RMF_TGTUUID =
905 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
907 EXPORT_SYMBOL(RMF_TGTUUID);
909 struct req_msg_field RMF_CLUUID =
910 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
912 EXPORT_SYMBOL(RMF_CLUUID);
914 struct req_msg_field RMF_STRING =
915 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
916 EXPORT_SYMBOL(RMF_STRING);
918 struct req_msg_field RMF_LLOGD_BODY =
919 DEFINE_MSGF("llogd_body", 0,
920 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
921 EXPORT_SYMBOL(RMF_LLOGD_BODY);
923 struct req_msg_field RMF_LLOG_LOG_HDR =
924 DEFINE_MSGF("llog_log_hdr", 0,
925 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
926 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
928 struct req_msg_field RMF_LLOGD_CONN_BODY =
929 DEFINE_MSGF("llogd_conn_body", 0,
930 sizeof(struct llogd_conn_body),
931 lustre_swab_llogd_conn_body, NULL);
932 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
935 * connection handle received in MDS_CONNECT request.
937 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
938 * that the client does not interpret at all.
940 struct req_msg_field RMF_CONN =
941 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
942 EXPORT_SYMBOL(RMF_CONN);
944 struct req_msg_field RMF_CONNECT_DATA =
946 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
947 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
948 sizeof(struct obd_connect_data),
950 /* For interoperability with 1.8 and 2.0 clients/servers.
951 * The RPC verification code allows larger RPC buffers, but not
952 * smaller buffers. Until we no longer need to keep compatibility
953 * with older servers/clients we can only check that the buffer
954 * size is at least as large as obd_connect_data_v1. That is not
955 * not in itself harmful, since the chance of just corrupting this
956 * field is low. See JIRA LU-16 for details. */
957 sizeof(struct obd_connect_data_v1),
959 lustre_swab_connect, NULL);
960 EXPORT_SYMBOL(RMF_CONNECT_DATA);
962 struct req_msg_field RMF_DLM_REQ =
963 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
964 sizeof(struct ldlm_request),
965 lustre_swab_ldlm_request, NULL);
966 EXPORT_SYMBOL(RMF_DLM_REQ);
968 struct req_msg_field RMF_DLM_REP =
969 DEFINE_MSGF("dlm_rep", 0,
970 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
971 EXPORT_SYMBOL(RMF_DLM_REP);
973 struct req_msg_field RMF_LDLM_INTENT =
974 DEFINE_MSGF("ldlm_intent", 0,
975 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
976 EXPORT_SYMBOL(RMF_LDLM_INTENT);
978 struct req_msg_field RMF_DLM_LVB =
979 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
980 EXPORT_SYMBOL(RMF_DLM_LVB);
982 struct req_msg_field RMF_DLM_GL_DESC =
983 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
984 lustre_swab_gl_desc, NULL);
985 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
987 struct req_msg_field RMF_MDT_MD =
988 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
989 EXPORT_SYMBOL(RMF_MDT_MD);
991 struct req_msg_field RMF_REC_REINT =
992 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
993 lustre_swab_mdt_rec_reint, NULL);
994 EXPORT_SYMBOL(RMF_REC_REINT);
996 /* FIXME: this length should be defined as a macro */
997 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
999 EXPORT_SYMBOL(RMF_EADATA);
1001 struct req_msg_field RMF_ACL =
1002 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1003 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1004 EXPORT_SYMBOL(RMF_ACL);
1006 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1007 struct req_msg_field RMF_LOGCOOKIES =
1008 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1009 sizeof(struct llog_cookie), NULL, NULL);
1010 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1012 struct req_msg_field RMF_CAPA1 =
1013 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1014 lustre_swab_lustre_capa, NULL);
1015 EXPORT_SYMBOL(RMF_CAPA1);
1017 struct req_msg_field RMF_CAPA2 =
1018 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1019 lustre_swab_lustre_capa, NULL);
1020 EXPORT_SYMBOL(RMF_CAPA2);
1022 struct req_msg_field RMF_LAYOUT_INTENT =
1023 DEFINE_MSGF("layout_intent", 0,
1024 sizeof(struct layout_intent), lustre_swab_layout_intent,
1026 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1029 * OST request field.
1031 struct req_msg_field RMF_OST_BODY =
1032 DEFINE_MSGF("ost_body", 0,
1033 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1034 EXPORT_SYMBOL(RMF_OST_BODY);
1036 struct req_msg_field RMF_OBD_IOOBJ =
1037 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1038 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1039 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1041 struct req_msg_field RMF_NIOBUF_REMOTE =
1042 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1043 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1045 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1047 struct req_msg_field RMF_RCS =
1048 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1049 lustre_swab_generic_32s, dump_rcs);
1050 EXPORT_SYMBOL(RMF_RCS);
1052 struct req_msg_field RMF_OBD_ID =
1053 DEFINE_MSGF("obd_id", 0,
1054 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1055 EXPORT_SYMBOL(RMF_OBD_ID);
1057 struct req_msg_field RMF_FID =
1058 DEFINE_MSGF("fid", 0,
1059 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1060 EXPORT_SYMBOL(RMF_FID);
1062 struct req_msg_field RMF_OST_ID =
1063 DEFINE_MSGF("ost_id", 0,
1064 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1065 EXPORT_SYMBOL(RMF_OST_ID);
1067 struct req_msg_field RMF_FIEMAP_KEY =
1068 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1069 lustre_swab_fiemap, NULL);
1070 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1072 struct req_msg_field RMF_FIEMAP_VAL =
1073 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1074 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1076 struct req_msg_field RMF_IDX_INFO =
1077 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1078 lustre_swab_idx_info, NULL);
1079 EXPORT_SYMBOL(RMF_IDX_INFO);
1080 struct req_msg_field RMF_HSM_USER_STATE =
1081 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1082 lustre_swab_hsm_user_state, NULL);
1083 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1085 struct req_msg_field RMF_HSM_STATE_SET =
1086 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1087 lustre_swab_hsm_state_set, NULL);
1088 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1090 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1091 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1092 lustre_swab_hsm_progress_kernel, NULL);
1093 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1095 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1096 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1097 lustre_swab_hsm_current_action, NULL);
1098 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1100 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1101 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1102 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1104 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1106 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1107 DEFINE_MSGF("hsm_archive", 0,
1108 sizeof(__u32), lustre_swab_generic_32s, NULL);
1109 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1111 struct req_msg_field RMF_MDS_HSM_REQUEST =
1112 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1113 lustre_swab_hsm_request, NULL);
1114 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1116 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1117 lustre_swab_update_buf, NULL);
1118 EXPORT_SYMBOL(RMF_UPDATE);
1120 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1121 lustre_swab_update_reply_buf,
1123 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1125 struct req_msg_field RMF_SWAP_LAYOUTS =
1126 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1127 lustre_swab_swap_layouts, NULL);
1128 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1134 const char *rf_name;
1138 const struct req_msg_field **d;
1139 } rf_fields[RCL_NR];
1142 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1156 #define DEFINE_REQ_FMT0(name, client, server) \
1157 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1159 struct req_format RQF_OBD_PING =
1160 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1161 EXPORT_SYMBOL(RQF_OBD_PING);
1163 struct req_format RQF_OBD_SET_INFO =
1164 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1165 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1167 /* Read index file through the network */
1168 struct req_format RQF_OBD_IDX_READ =
1169 DEFINE_REQ_FMT0("OBD_IDX_READ",
1170 obd_idx_read_client, obd_idx_read_server);
1171 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1173 struct req_format RQF_SEC_CTX =
1174 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1175 EXPORT_SYMBOL(RQF_SEC_CTX);
1177 struct req_format RQF_MGS_TARGET_REG =
1178 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1179 mgs_target_info_only);
1180 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1182 struct req_format RQF_MGS_SET_INFO =
1183 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1185 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1187 struct req_format RQF_MGS_CONFIG_READ =
1188 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1189 mgs_config_read_server);
1190 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1192 struct req_format RQF_SEQ_QUERY =
1193 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1194 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1196 struct req_format RQF_FLD_QUERY =
1197 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1198 EXPORT_SYMBOL(RQF_FLD_QUERY);
1200 struct req_format RQF_LOG_CANCEL =
1201 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1202 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1204 struct req_format RQF_MDS_QUOTACHECK =
1205 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1206 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1208 struct req_format RQF_OST_QUOTACHECK =
1209 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1210 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1212 struct req_format RQF_MDS_QUOTACTL =
1213 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1214 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1216 struct req_format RQF_OST_QUOTACTL =
1217 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1218 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1220 struct req_format RQF_QC_CALLBACK =
1221 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1222 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1224 struct req_format RQF_QUOTA_DQACQ =
1225 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1226 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1228 struct req_format RQF_LDLM_INTENT_QUOTA =
1229 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1230 ldlm_intent_quota_client,
1231 ldlm_intent_quota_server);
1232 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1234 struct req_format RQF_MDS_GETSTATUS =
1235 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1236 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1238 struct req_format RQF_MDS_STATFS =
1239 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1240 EXPORT_SYMBOL(RQF_MDS_STATFS);
1242 struct req_format RQF_MDS_SYNC =
1243 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1244 EXPORT_SYMBOL(RQF_MDS_SYNC);
1246 struct req_format RQF_MDS_GETATTR =
1247 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1248 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1250 struct req_format RQF_MDS_GETXATTR =
1251 DEFINE_REQ_FMT0("MDS_GETXATTR",
1252 mds_getxattr_client, mds_getxattr_server);
1253 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1255 struct req_format RQF_MDS_GETATTR_NAME =
1256 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1257 mds_getattr_name_client, mds_getattr_server);
1258 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1260 struct req_format RQF_MDS_REINT =
1261 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1262 EXPORT_SYMBOL(RQF_MDS_REINT);
1264 struct req_format RQF_MDS_REINT_CREATE =
1265 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1266 mds_reint_create_client, mdt_body_capa);
1267 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1269 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1270 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1271 mds_reint_create_rmt_acl_client, mdt_body_capa);
1272 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1274 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1275 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1276 mds_reint_create_slave_client, mdt_body_capa);
1277 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1279 struct req_format RQF_MDS_REINT_CREATE_SYM =
1280 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1281 mds_reint_create_sym_client, mdt_body_capa);
1282 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1284 struct req_format RQF_MDS_REINT_OPEN =
1285 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1286 mds_reint_open_client, mds_reint_open_server);
1287 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1289 struct req_format RQF_MDS_REINT_UNLINK =
1290 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1291 mds_last_unlink_server);
1292 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1294 struct req_format RQF_MDS_REINT_LINK =
1295 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1296 mds_reint_link_client, mdt_body_only);
1297 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1299 struct req_format RQF_MDS_REINT_RENAME =
1300 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1301 mds_last_unlink_server);
1302 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1304 struct req_format RQF_MDS_REINT_SETATTR =
1305 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1306 mds_reint_setattr_client, mds_setattr_server);
1307 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1309 struct req_format RQF_MDS_REINT_SETXATTR =
1310 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1311 mds_reint_setxattr_client, mdt_body_only);
1312 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1314 struct req_format RQF_MDS_CONNECT =
1315 DEFINE_REQ_FMT0("MDS_CONNECT",
1316 obd_connect_client, obd_connect_server);
1317 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1319 struct req_format RQF_MDS_DISCONNECT =
1320 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1321 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1323 struct req_format RQF_MDS_GET_INFO =
1324 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1325 mds_getinfo_server);
1326 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1328 struct req_format RQF_UPDATE_OBJ =
1329 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1331 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1333 struct req_format RQF_LDLM_ENQUEUE =
1334 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1335 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1336 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1338 struct req_format RQF_LDLM_ENQUEUE_LVB =
1339 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1340 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1341 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1343 struct req_format RQF_LDLM_CONVERT =
1344 DEFINE_REQ_FMT0("LDLM_CONVERT",
1345 ldlm_enqueue_client, ldlm_enqueue_server);
1346 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1348 struct req_format RQF_LDLM_CANCEL =
1349 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1350 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1352 struct req_format RQF_LDLM_CALLBACK =
1353 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1354 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1356 struct req_format RQF_LDLM_CP_CALLBACK =
1357 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1358 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1360 struct req_format RQF_LDLM_BL_CALLBACK =
1361 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1362 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1364 struct req_format RQF_LDLM_GL_CALLBACK =
1365 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1366 ldlm_gl_callback_server);
1367 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1369 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1370 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1371 ldlm_gl_callback_server);
1372 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1374 struct req_format RQF_LDLM_INTENT_BASIC =
1375 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1376 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1377 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1379 struct req_format RQF_LDLM_INTENT =
1380 DEFINE_REQ_FMT0("LDLM_INTENT",
1381 ldlm_intent_client, ldlm_intent_server);
1382 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1384 struct req_format RQF_LDLM_INTENT_LAYOUT =
1385 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1386 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1387 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1389 struct req_format RQF_LDLM_INTENT_GETATTR =
1390 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1391 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1392 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1394 struct req_format RQF_LDLM_INTENT_OPEN =
1395 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1396 ldlm_intent_open_client, ldlm_intent_open_server);
1397 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1399 struct req_format RQF_LDLM_INTENT_CREATE =
1400 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1401 ldlm_intent_create_client, ldlm_intent_getattr_server);
1402 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1404 struct req_format RQF_LDLM_INTENT_UNLINK =
1405 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1406 ldlm_intent_unlink_client, ldlm_intent_server);
1407 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1409 struct req_format RQF_MDS_CLOSE =
1410 DEFINE_REQ_FMT0("MDS_CLOSE",
1411 mdt_close_client, mds_last_unlink_server);
1412 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1414 struct req_format RQF_MDS_PIN =
1415 DEFINE_REQ_FMT0("MDS_PIN",
1416 mdt_body_capa, mdt_body_only);
1417 EXPORT_SYMBOL(RQF_MDS_PIN);
1419 struct req_format RQF_MDS_UNPIN =
1420 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1421 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1423 struct req_format RQF_MDS_DONE_WRITING =
1424 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1425 mdt_close_client, mdt_body_only);
1426 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1428 struct req_format RQF_MDS_READPAGE =
1429 DEFINE_REQ_FMT0("MDS_READPAGE",
1430 mdt_body_capa, mdt_body_only);
1431 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1433 struct req_format RQF_MDS_HSM_ACTION =
1434 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1435 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1437 struct req_format RQF_MDS_HSM_PROGRESS =
1438 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1439 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1441 struct req_format RQF_MDS_HSM_CT_REGISTER =
1442 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1443 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1445 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1446 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1447 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1449 struct req_format RQF_MDS_HSM_STATE_GET =
1450 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1451 mdt_body_capa, mdt_hsm_state_get_server);
1452 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1454 struct req_format RQF_MDS_HSM_STATE_SET =
1455 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1456 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1458 struct req_format RQF_MDS_HSM_REQUEST =
1459 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1460 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1462 struct req_format RQF_MDS_SWAP_LAYOUTS =
1463 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1464 mdt_swap_layouts, empty);
1465 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1467 /* This is for split */
1468 struct req_format RQF_MDS_WRITEPAGE =
1469 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1470 mdt_body_capa, mdt_body_only);
1471 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1473 struct req_format RQF_MDS_IS_SUBDIR =
1474 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1475 mdt_body_only, mdt_body_only);
1476 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1478 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1479 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1480 llog_origin_handle_create_client, llogd_body_only);
1481 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1483 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1484 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1485 llogd_body_only, llogd_body_only);
1486 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1488 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1489 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1490 llogd_body_only, llog_origin_handle_next_block_server);
1491 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1493 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1494 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1495 llogd_body_only, llog_origin_handle_next_block_server);
1496 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1498 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1499 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1500 llogd_body_only, llog_log_hdr_only);
1501 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1503 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1504 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1505 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1507 struct req_format RQF_OST_CONNECT =
1508 DEFINE_REQ_FMT0("OST_CONNECT",
1509 obd_connect_client, obd_connect_server);
1510 EXPORT_SYMBOL(RQF_OST_CONNECT);
1512 struct req_format RQF_OST_DISCONNECT =
1513 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1514 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1516 struct req_format RQF_OST_GETATTR =
1517 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1518 EXPORT_SYMBOL(RQF_OST_GETATTR);
1520 struct req_format RQF_OST_SETATTR =
1521 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1522 EXPORT_SYMBOL(RQF_OST_SETATTR);
1524 struct req_format RQF_OST_CREATE =
1525 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1526 EXPORT_SYMBOL(RQF_OST_CREATE);
1528 struct req_format RQF_OST_PUNCH =
1529 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1530 EXPORT_SYMBOL(RQF_OST_PUNCH);
1532 struct req_format RQF_OST_SYNC =
1533 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1534 EXPORT_SYMBOL(RQF_OST_SYNC);
1536 struct req_format RQF_OST_DESTROY =
1537 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1538 EXPORT_SYMBOL(RQF_OST_DESTROY);
1540 struct req_format RQF_OST_BRW_READ =
1541 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1542 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1544 struct req_format RQF_OST_BRW_WRITE =
1545 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1546 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1548 struct req_format RQF_OST_STATFS =
1549 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1550 EXPORT_SYMBOL(RQF_OST_STATFS);
1552 struct req_format RQF_OST_SET_GRANT_INFO =
1553 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1555 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1557 struct req_format RQF_OST_GET_INFO_GENERIC =
1558 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1559 ost_get_info_generic_server);
1560 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1562 struct req_format RQF_OST_GET_INFO_LAST_ID =
1563 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1564 ost_get_last_id_server);
1565 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1567 struct req_format RQF_OST_GET_INFO_LAST_FID =
1568 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", obd_set_info_client,
1569 ost_get_last_fid_server);
1570 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1572 struct req_format RQF_OST_SET_INFO_LAST_FID =
1573 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1575 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1577 struct req_format RQF_OST_GET_INFO_FIEMAP =
1578 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1579 ost_get_fiemap_server);
1580 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1582 #if !defined(__REQ_LAYOUT_USER__)
1584 /* Convenience macro */
1585 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1588 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1589 * field of RQFs and the \a rmf_offset field of RMFs.
1591 int req_layout_init(void)
1596 struct req_format *rf = NULL;
1598 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1599 rf = req_formats[i];
1601 for (j = 0; j < RCL_NR; ++j) {
1602 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1603 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1604 struct req_msg_field *field;
1606 field = (typeof(field))rf->rf_fields[j].d[k];
1607 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1608 || field->rmf_size > 0);
1609 LASSERT(field->rmf_offset[i][j] == 0);
1611 * k + 1 to detect unused format/field
1614 field->rmf_offset[i][j] = k + 1;
1620 EXPORT_SYMBOL(req_layout_init);
1622 void req_layout_fini(void)
1625 EXPORT_SYMBOL(req_layout_fini);
1628 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1630 * Actual/expected field sizes are set elsewhere in functions in this file:
1631 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1632 * req_capsule_msg_size(). The \a rc_area information is used by.
1633 * ptlrpc_request_set_replen().
1635 void req_capsule_init_area(struct req_capsule *pill)
1639 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1640 pill->rc_area[RCL_CLIENT][i] = -1;
1641 pill->rc_area[RCL_SERVER][i] = -1;
1644 EXPORT_SYMBOL(req_capsule_init_area);
1647 * Initialize a pill.
1649 * The \a location indicates whether the caller is executing on the client side
1650 * (RCL_CLIENT) or server side (RCL_SERVER)..
1652 void req_capsule_init(struct req_capsule *pill,
1653 struct ptlrpc_request *req,
1654 enum req_location location)
1656 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1659 * Today all capsules are embedded in ptlrpc_request structs,
1660 * but just in case that ever isn't the case, we don't reach
1661 * into req unless req != NULL and pill is the one embedded in
1664 * The req->rq_pill_init flag makes it safe to initialize a pill
1665 * twice, which might happen in the OST paths as a result of the
1666 * high-priority RPC queue getting peeked at before ost_handle()
1667 * handles an OST RPC.
1669 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1672 memset(pill, 0, sizeof *pill);
1674 pill->rc_loc = location;
1675 req_capsule_init_area(pill);
1677 if (req != NULL && pill == &req->rq_pill)
1678 req->rq_pill_init = 1;
1680 EXPORT_SYMBOL(req_capsule_init);
1682 void req_capsule_fini(struct req_capsule *pill)
1685 EXPORT_SYMBOL(req_capsule_fini);
1687 static int __req_format_is_sane(const struct req_format *fmt)
1690 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1691 req_formats[fmt->rf_idx] == fmt;
1694 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1695 enum req_location loc)
1697 struct ptlrpc_request *req;
1700 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1704 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1705 * (see req_capsule_extend()).
1707 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1709 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1710 LASSERT(__req_format_is_sane(fmt));
1714 EXPORT_SYMBOL(req_capsule_set);
1717 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1720 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1721 * variable-sized fields. The field sizes come from the declared \a rmf_size
1722 * field of a \a pill's \a rc_fmt's RMF's.
1724 int req_capsule_filled_sizes(struct req_capsule *pill,
1725 enum req_location loc)
1727 const struct req_format *fmt = pill->rc_fmt;
1730 LASSERT(fmt != NULL);
1732 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1733 if (pill->rc_area[loc][i] == -1) {
1734 pill->rc_area[loc][i] =
1735 fmt->rf_fields[loc].d[i]->rmf_size;
1736 if (pill->rc_area[loc][i] == -1) {
1738 * Skip the following fields.
1740 * If this LASSERT() trips then you're missing a
1741 * call to req_capsule_set_size().
1743 LASSERT(loc != RCL_SERVER);
1750 EXPORT_SYMBOL(req_capsule_filled_sizes);
1753 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1755 * This function uses the \a pill's \a rc_area as filled in by
1756 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1759 int req_capsule_server_pack(struct req_capsule *pill)
1761 const struct req_format *fmt;
1765 LASSERT(pill->rc_loc == RCL_SERVER);
1767 LASSERT(fmt != NULL);
1769 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1770 rc = lustre_pack_reply(pill->rc_req, count,
1771 pill->rc_area[RCL_SERVER], NULL);
1773 DEBUG_REQ(D_ERROR, pill->rc_req,
1774 "Cannot pack %d fields in format `%s': ",
1775 count, fmt->rf_name);
1779 EXPORT_SYMBOL(req_capsule_server_pack);
1782 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1783 * corresponding to the given RMF (\a field).
1785 static int __req_capsule_offset(const struct req_capsule *pill,
1786 const struct req_msg_field *field,
1787 enum req_location loc)
1791 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1792 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1793 pill->rc_fmt->rf_name,
1794 field->rmf_name, offset, loc);
1797 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1802 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1807 swabber_dumper_helper(struct req_capsule *pill,
1808 const struct req_msg_field *field,
1809 enum req_location loc,
1811 void *value, int len, int dump, void (*swabber)( void *))
1817 int inout = loc == RCL_CLIENT;
1819 swabber = swabber ?: field->rmf_swabber;
1821 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1822 swabber != NULL && value != NULL)
1827 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1828 if (dump && field->rmf_dumper) {
1829 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1830 do_swab ? "unswabbed " : "", field->rmf_name);
1831 field->rmf_dumper(value);
1836 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1838 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1839 "follows\n", field->rmf_name);
1840 field->rmf_dumper(value);
1847 * We're swabbing an array; swabber() swabs a single array element, so
1848 * swab every element.
1850 LASSERT((len % field->rmf_size) == 0);
1851 for (p = value, i = 0, n = len / field->rmf_size;
1853 i++, p += field->rmf_size) {
1854 if (dump && field->rmf_dumper) {
1855 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1856 "element %d follows\n",
1857 do_swab ? "unswabbed " : "", field->rmf_name, i);
1858 field->rmf_dumper(p);
1863 if (dump && field->rmf_dumper) {
1864 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1865 "element %d follows\n", field->rmf_name, i);
1866 field->rmf_dumper(value);
1870 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1874 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1875 * corresponding to the given RMF (\a field).
1877 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1878 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1879 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1880 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1881 * element of the array swabbed.
1883 static void *__req_capsule_get(struct req_capsule *pill,
1884 const struct req_msg_field *field,
1885 enum req_location loc,
1886 void (*swabber)( void *),
1889 const struct req_format *fmt;
1890 struct lustre_msg *msg;
1895 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1897 static const char *rcl_names[RCL_NR] = {
1898 [RCL_CLIENT] = "client",
1899 [RCL_SERVER] = "server"
1902 LASSERT(pill != NULL);
1903 LASSERT(pill != LP_POISON);
1905 LASSERT(fmt != NULL);
1906 LASSERT(fmt != LP_POISON);
1907 LASSERT(__req_format_is_sane(fmt));
1909 offset = __req_capsule_offset(pill, field, loc);
1911 msg = __req_msg(pill, loc);
1912 LASSERT(msg != NULL);
1914 getter = (field->rmf_flags & RMF_F_STRING) ?
1915 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1917 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1919 * We've already asserted that field->rmf_size > 0 in
1920 * req_layout_init().
1922 len = lustre_msg_buflen(msg, offset);
1923 if ((len % field->rmf_size) != 0) {
1924 CERROR("%s: array field size mismatch "
1925 "%d modulo %d != 0 (%d)\n",
1926 field->rmf_name, len, field->rmf_size, loc);
1929 } else if (pill->rc_area[loc][offset] != -1) {
1930 len = pill->rc_area[loc][offset];
1932 len = max(field->rmf_size, 0);
1934 value = getter(msg, offset, len);
1936 if (value == NULL) {
1937 DEBUG_REQ(D_ERROR, pill->rc_req,
1938 "Wrong buffer for field `%s' (%d of %d) "
1939 "in format `%s': %d vs. %d (%s)\n",
1940 field->rmf_name, offset, lustre_msg_bufcount(msg),
1941 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1944 swabber_dumper_helper(pill, field, loc, offset, value, len,
1952 * Dump a request and/or reply
1954 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1956 const struct req_format *fmt;
1957 const struct req_msg_field *field;
1963 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1964 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1965 field = FMT_FIELD(fmt, loc, i);
1966 if (field->rmf_dumper == NULL) {
1968 * FIXME Add a default hex dumper for fields that don't
1969 * have a specific dumper
1971 len = req_capsule_get_size(pill, field, loc);
1972 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1973 "field size is %d\n", field->rmf_name, len);
1975 /* It's the dumping side-effect that we're interested in */
1976 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1979 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1985 void req_capsule_client_dump(struct req_capsule *pill)
1987 __req_capsule_dump(pill, RCL_CLIENT);
1989 EXPORT_SYMBOL(req_capsule_client_dump);
1994 void req_capsule_server_dump(struct req_capsule *pill)
1996 __req_capsule_dump(pill, RCL_SERVER);
1998 EXPORT_SYMBOL(req_capsule_server_dump);
2001 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2002 * buffer corresponding to the given RMF (\a field) of a \a pill.
2004 void *req_capsule_client_get(struct req_capsule *pill,
2005 const struct req_msg_field *field)
2007 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2009 EXPORT_SYMBOL(req_capsule_client_get);
2012 * Same as req_capsule_client_get(), but with a \a swabber argument.
2014 * Currently unused; will be removed when req_capsule_server_swab_get() is
2017 void *req_capsule_client_swab_get(struct req_capsule *pill,
2018 const struct req_msg_field *field,
2021 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2023 EXPORT_SYMBOL(req_capsule_client_swab_get);
2026 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2028 * First the \a pill's request \a field's size is set (\a rc_area) using
2029 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2032 void *req_capsule_client_sized_get(struct req_capsule *pill,
2033 const struct req_msg_field *field,
2036 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2037 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2039 EXPORT_SYMBOL(req_capsule_client_sized_get);
2042 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2043 * buffer corresponding to the given RMF (\a field) of a \a pill.
2045 void *req_capsule_server_get(struct req_capsule *pill,
2046 const struct req_msg_field *field)
2048 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2050 EXPORT_SYMBOL(req_capsule_server_get);
2053 * Same as req_capsule_server_get(), but with a \a swabber argument.
2055 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2056 * swabbing done outside this capsule abstraction.
2058 void *req_capsule_server_swab_get(struct req_capsule *pill,
2059 const struct req_msg_field *field,
2062 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2064 EXPORT_SYMBOL(req_capsule_server_swab_get);
2067 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2069 * First the \a pill's request \a field's size is set (\a rc_area) using
2070 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2073 void *req_capsule_server_sized_get(struct req_capsule *pill,
2074 const struct req_msg_field *field,
2077 req_capsule_set_size(pill, field, RCL_SERVER, len);
2078 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2080 EXPORT_SYMBOL(req_capsule_server_sized_get);
2082 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2083 const struct req_msg_field *field,
2084 int len, void *swabber)
2086 req_capsule_set_size(pill, field, RCL_SERVER, len);
2087 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2089 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2092 * Returns the buffer of a \a pill corresponding to the given \a field from the
2093 * request (if the caller is executing on the server-side) or reply (if the
2094 * caller is executing on the client-side).
2096 * This function convienient for use is code that could be executed on the
2097 * client and server alike.
2099 const void *req_capsule_other_get(struct req_capsule *pill,
2100 const struct req_msg_field *field)
2102 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2104 EXPORT_SYMBOL(req_capsule_other_get);
2107 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2108 * field of the given \a pill.
2110 * This function must be used when constructing variable sized fields of a
2113 void req_capsule_set_size(struct req_capsule *pill,
2114 const struct req_msg_field *field,
2115 enum req_location loc, int size)
2117 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2119 if ((size != field->rmf_size) &&
2120 (field->rmf_size != -1) &&
2121 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2123 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2124 (size % field->rmf_size != 0)) {
2125 CERROR("%s: array field size mismatch "
2126 "%d %% %d != 0 (%d)\n",
2127 field->rmf_name, size, field->rmf_size, loc);
2129 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2130 size < field->rmf_size) {
2131 CERROR("%s: field size mismatch %d != %d (%d)\n",
2132 field->rmf_name, size, field->rmf_size, loc);
2137 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2139 EXPORT_SYMBOL(req_capsule_set_size);
2142 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2143 * for the given \a pill's given \a field.
2145 * NB: this function doesn't correspond with req_capsule_set_size(), which
2146 * actually sets the size in pill.rc_area[loc][offset], but this function
2147 * returns the message buflen[offset], maybe we should use another name.
2149 int req_capsule_get_size(const struct req_capsule *pill,
2150 const struct req_msg_field *field,
2151 enum req_location loc)
2153 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2155 return lustre_msg_buflen(__req_msg(pill, loc),
2156 __req_capsule_offset(pill, field, loc));
2158 EXPORT_SYMBOL(req_capsule_get_size);
2161 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2162 * given \a pill's request or reply (\a loc) given the field size recorded in
2163 * the \a pill's rc_area.
2165 * See also req_capsule_set_size().
2167 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2169 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2170 pill->rc_fmt->rf_fields[loc].nr,
2171 pill->rc_area[loc]);
2175 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2176 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2177 * PTLRPC request or reply given only an RQF (\a fmt).
2179 * This function should not be used for formats which contain variable size
2182 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2183 enum req_location loc)
2188 * This function should probably LASSERT() that fmt has no fields with
2189 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2190 * elements in the array there will ultimately be, but then, we could
2191 * assume that there will be at least one element, and that's just what
2194 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2198 for (; i < fmt->rf_fields[loc].nr; ++i)
2199 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2200 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2206 * Changes the format of an RPC.
2208 * The pill must already have been initialized, which means that it already has
2209 * a request format. The new format \a fmt must be an extension of the pill's
2210 * old format. Specifically: the new format must have as many request and reply
2211 * fields as the old one, and all fields shared by the old and new format must
2212 * be at least as large in the new format.
2214 * The new format's fields may be of different "type" than the old format, but
2215 * only for fields that are "opaque" blobs: fields which have a) have no
2216 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2217 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2218 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2219 * according to the key field. When the value, according to the key, contains a
2220 * structure (or array thereof) to be swabbed, the format should be changed to
2221 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2224 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2229 const struct req_format *old;
2231 LASSERT(pill->rc_fmt != NULL);
2232 LASSERT(__req_format_is_sane(fmt));
2236 * Sanity checking...
2238 for (i = 0; i < RCL_NR; ++i) {
2239 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2240 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2241 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2243 /* "opaque" fields can be transmogrified */
2244 if (ofield->rmf_swabber == NULL &&
2245 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2246 (ofield->rmf_size == -1 ||
2247 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2249 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2252 * Last field in old format can be shorter than in new.
2254 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2255 FMT_FIELD(old, i, j)->rmf_size);
2260 EXPORT_SYMBOL(req_capsule_extend);
2263 * This function returns a non-zero value if the given \a field is present in
2264 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2267 int req_capsule_has_field(const struct req_capsule *pill,
2268 const struct req_msg_field *field,
2269 enum req_location loc)
2271 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2273 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2275 EXPORT_SYMBOL(req_capsule_has_field);
2278 * Returns a non-zero value if the given \a field is present in the given \a
2279 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2281 int req_capsule_field_present(const struct req_capsule *pill,
2282 const struct req_msg_field *field,
2283 enum req_location loc)
2287 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2288 LASSERT(req_capsule_has_field(pill, field, loc));
2290 offset = __req_capsule_offset(pill, field, loc);
2291 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2293 EXPORT_SYMBOL(req_capsule_field_present);
2296 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2297 * request or reply (\a loc).
2299 * This is not the opposite of req_capsule_extend().
2301 void req_capsule_shrink(struct req_capsule *pill,
2302 const struct req_msg_field *field,
2303 unsigned int newlen,
2304 enum req_location loc)
2306 const struct req_format *fmt;
2307 struct lustre_msg *msg;
2312 LASSERT(fmt != NULL);
2313 LASSERT(__req_format_is_sane(fmt));
2314 LASSERT(req_capsule_has_field(pill, field, loc));
2315 LASSERT(req_capsule_field_present(pill, field, loc));
2317 offset = __req_capsule_offset(pill, field, loc);
2319 msg = __req_msg(pill, loc);
2320 len = lustre_msg_buflen(msg, offset);
2321 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2322 fmt->rf_name, field->rmf_name, len, newlen);
2324 if (loc == RCL_CLIENT)
2325 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2328 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2331 EXPORT_SYMBOL(req_capsule_shrink);
2333 int req_capsule_server_grow(struct req_capsule *pill,
2334 const struct req_msg_field *field,
2335 unsigned int newlen)
2337 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2339 int offset, len, rc;
2341 LASSERT(pill->rc_fmt != NULL);
2342 LASSERT(__req_format_is_sane(pill->rc_fmt));
2343 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2344 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2346 len = req_capsule_get_size(pill, field, RCL_SERVER);
2347 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2348 if (pill->rc_req->rq_repbuf_len >=
2349 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2350 CERROR("Inplace repack might be done\n");
2352 pill->rc_req->rq_reply_state = NULL;
2353 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2354 rc = req_capsule_server_pack(pill);
2356 /* put old rs back, the caller will decide what to do */
2357 pill->rc_req->rq_reply_state = rs;
2360 nrs = pill->rc_req->rq_reply_state;
2361 /* Now we need only buffers, copy first chunk */
2362 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2363 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2364 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2365 memcpy(to, from, len);
2366 /* check if we have tail and copy it too */
2367 if (rs->rs_msg->lm_bufcount > offset + 1) {
2368 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2369 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2370 offset = rs->rs_msg->lm_bufcount - 1;
2371 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2372 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2373 memcpy(to, from, len);
2375 /* drop old reply if everything is fine */
2376 if (rs->rs_difficult) {
2380 nrs->rs_difficult = 1;
2381 nrs->rs_no_ack = rs->rs_no_ack;
2382 for (i = 0; i < rs->rs_nlocks; i++) {
2383 nrs->rs_locks[i] = rs->rs_locks[i];
2384 nrs->rs_modes[i] = rs->rs_modes[i];
2388 rs->rs_difficult = 0;
2391 ptlrpc_rs_decref(rs);
2394 EXPORT_SYMBOL(req_capsule_server_grow);
2395 /* __REQ_LAYOUT_USER__ */