4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
53 #include <linux/module.h>
55 /* LUSTRE_VERSION_CODE */
56 #include <lustre_ver.h>
58 #include <obd_support.h>
59 /* lustre_swab_mdt_body */
60 #include <lustre/lustre_idl.h>
61 /* obd2cli_tgt() (required by DEBUG_REQ()) */
63 #include <lustre_debug.h>
64 #endif /* !__REQ_LAYOUT_USER__ */
66 /* struct ptlrpc_request, lustre_msg* */
67 #include <lustre_req_layout.h>
68 #include <lustre_acl.h>
71 * RQFs (see below) refer to two struct req_msg_field arrays describing the
72 * client request and server reply, respectively.
74 /* empty set of fields... for suitable definition of emptiness. */
75 static const struct req_msg_field *empty[] = {
79 static const struct req_msg_field *mgs_target_info_only[] = {
84 static const struct req_msg_field *mgs_set_info[] = {
89 static const struct req_msg_field *mgs_config_read_client[] = {
94 static const struct req_msg_field *mgs_config_read_server[] = {
99 static const struct req_msg_field *log_cancel_client[] = {
104 static const struct req_msg_field *mdt_body_only[] = {
109 static const struct req_msg_field *mdt_body_capa[] = {
115 static const struct req_msg_field *quotactl_only[] = {
120 static const struct req_msg_field *quota_body_only[] = {
125 static const struct req_msg_field *ldlm_intent_quota_client[] = {
132 static const struct req_msg_field *ldlm_intent_quota_server[] = {
139 static const struct req_msg_field *mdt_close_client[] = {
146 static const struct req_msg_field *mdt_intent_close_client[] = {
154 static const struct req_msg_field *obd_statfs_server[] = {
159 static const struct req_msg_field *seq_query_client[] = {
165 static const struct req_msg_field *seq_query_server[] = {
170 static const struct req_msg_field *fld_query_client[] = {
176 static const struct req_msg_field *fld_query_server[] = {
181 static const struct req_msg_field *fld_read_client[] = {
186 static const struct req_msg_field *fld_read_server[] = {
191 static const struct req_msg_field *mds_getattr_name_client[] = {
198 static const struct req_msg_field *mds_reint_client[] = {
203 static const struct req_msg_field *mds_reint_create_client[] = {
210 static const struct req_msg_field *mds_reint_create_slave_client[] = {
219 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
228 static const struct req_msg_field *mds_reint_create_sym_client[] = {
237 static const struct req_msg_field *mds_reint_open_client[] = {
246 static const struct req_msg_field *mds_reint_open_server[] = {
255 static const struct req_msg_field *mds_reint_unlink_client[] = {
263 static const struct req_msg_field *mds_reint_link_client[] = {
272 static const struct req_msg_field *mds_reint_rename_client[] = {
282 static const struct req_msg_field *mds_last_unlink_server[] = {
291 static const struct req_msg_field *mds_reint_setattr_client[] = {
301 static const struct req_msg_field *mds_reint_setxattr_client[] = {
310 static const struct req_msg_field *mdt_swap_layouts[] = {
319 static const struct req_msg_field *obd_connect_client[] = {
327 static const struct req_msg_field *obd_connect_server[] = {
332 static const struct req_msg_field *obd_set_info_client[] = {
338 static const struct req_msg_field *ost_grant_shrink_client[] = {
344 static const struct req_msg_field *mds_getinfo_client[] = {
350 static const struct req_msg_field *mds_getinfo_server[] = {
355 static const struct req_msg_field *ldlm_enqueue_client[] = {
360 static const struct req_msg_field *ldlm_enqueue_server[] = {
365 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
371 static const struct req_msg_field *ldlm_cp_callback_client[] = {
377 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
383 static const struct req_msg_field *ldlm_gl_callback_server[] = {
388 static const struct req_msg_field *ldlm_intent_basic_client[] = {
394 static const struct req_msg_field *ldlm_intent_client[] = {
401 static const struct req_msg_field *ldlm_intent_server[] = {
409 static const struct req_msg_field *ldlm_intent_layout_client[] = {
414 &RMF_EADATA /* for new layout to be set up */
416 static const struct req_msg_field *ldlm_intent_open_server[] = {
426 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
430 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
435 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
444 static const struct req_msg_field *ldlm_intent_create_client[] = {
448 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
454 static const struct req_msg_field *ldlm_intent_open_client[] = {
458 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
465 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
469 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
474 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
482 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
487 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
493 static const struct req_msg_field *mds_getxattr_client[] = {
501 static const struct req_msg_field *mds_getxattr_server[] = {
507 static const struct req_msg_field *mds_getattr_server[] = {
516 static const struct req_msg_field *mds_setattr_server[] = {
525 static const struct req_msg_field *mds_update_client[] = {
530 static const struct req_msg_field *mds_update_server[] = {
532 &RMF_OUT_UPDATE_REPLY,
535 static const struct req_msg_field *llog_origin_handle_create_client[] = {
541 static const struct req_msg_field *llogd_body_only[] = {
546 static const struct req_msg_field *llog_log_hdr_only[] = {
551 static const struct req_msg_field *llogd_conn_body_only[] = {
556 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
562 static const struct req_msg_field *obd_idx_read_client[] = {
567 static const struct req_msg_field *obd_idx_read_server[] = {
572 static const struct req_msg_field *ost_body_only[] = {
577 static const struct req_msg_field *ost_body_capa[] = {
583 static const struct req_msg_field *ost_destroy_client[] = {
591 static const struct req_msg_field *ost_brw_client[] = {
599 static const struct req_msg_field *ost_brw_read_server[] = {
604 static const struct req_msg_field *ost_brw_write_server[] = {
610 static const struct req_msg_field *ost_get_info_generic_server[] = {
615 static const struct req_msg_field *ost_get_info_generic_client[] = {
620 static const struct req_msg_field *ost_get_last_id_server[] = {
625 static const struct req_msg_field *ost_get_last_fid_client[] = {
631 static const struct req_msg_field *ost_get_last_fid_server[] = {
636 static const struct req_msg_field *ost_get_fiemap_client[] = {
642 static const struct req_msg_field *ost_get_fiemap_server[] = {
647 static const struct req_msg_field *mdt_hsm_progress[] = {
650 &RMF_MDS_HSM_PROGRESS,
653 static const struct req_msg_field *mdt_hsm_ct_register[] = {
656 &RMF_MDS_HSM_ARCHIVE,
659 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
664 static const struct req_msg_field *mdt_hsm_action_server[] = {
667 &RMF_MDS_HSM_CURRENT_ACTION,
670 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
676 static const struct req_msg_field *mdt_hsm_state_set[] = {
683 static const struct req_msg_field *mdt_hsm_request[] = {
686 &RMF_MDS_HSM_REQUEST,
687 &RMF_MDS_HSM_USER_ITEM,
691 static const struct req_msg_field *obd_lfsck_request[] = {
696 static const struct req_msg_field *obd_lfsck_reply[] = {
701 static struct req_format *req_formats[] = {
708 &RQF_MGS_CONFIG_READ,
718 &RQF_MDS_GETATTR_NAME,
722 &RQF_MDS_INTENT_CLOSE,
725 &RQF_MDS_REINT_CREATE,
726 &RQF_MDS_REINT_CREATE_RMT_ACL,
727 &RQF_MDS_REINT_CREATE_SLAVE,
728 &RQF_MDS_REINT_CREATE_SYM,
730 &RQF_MDS_REINT_UNLINK,
732 &RQF_MDS_REINT_RENAME,
733 &RQF_MDS_REINT_SETATTR,
734 &RQF_MDS_REINT_SETXATTR,
736 &RQF_MDS_HSM_PROGRESS,
737 &RQF_MDS_HSM_CT_REGISTER,
738 &RQF_MDS_HSM_CT_UNREGISTER,
739 &RQF_MDS_HSM_STATE_GET,
740 &RQF_MDS_HSM_STATE_SET,
742 &RQF_MDS_HSM_REQUEST,
743 &RQF_MDS_SWAP_LAYOUTS,
757 &RQF_OST_SET_GRANT_INFO,
759 &RQF_OST_GET_INFO_LAST_ID,
760 &RQF_OST_GET_INFO_LAST_FID,
761 &RQF_OST_SET_INFO_LAST_FID,
762 &RQF_OST_GET_INFO_FIEMAP,
764 &RQF_LDLM_ENQUEUE_LVB,
768 &RQF_LDLM_CP_CALLBACK,
769 &RQF_LDLM_BL_CALLBACK,
770 &RQF_LDLM_GL_CALLBACK,
771 &RQF_LDLM_GL_DESC_CALLBACK,
773 &RQF_LDLM_INTENT_BASIC,
774 &RQF_LDLM_INTENT_LAYOUT,
775 &RQF_LDLM_INTENT_GETATTR,
776 &RQF_LDLM_INTENT_OPEN,
777 &RQF_LDLM_INTENT_CREATE,
778 &RQF_LDLM_INTENT_UNLINK,
779 &RQF_LDLM_INTENT_GETXATTR,
780 &RQF_LDLM_INTENT_QUOTA,
783 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
784 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
785 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
786 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
787 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
788 &RQF_LLOG_ORIGIN_CONNECT,
794 struct req_msg_field {
795 const __u32 rmf_flags;
796 const char *rmf_name;
798 * Field length. (-1) means "variable length". If the
799 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
800 * but the actual size must be a whole multiple of \a rmf_size.
803 void (*rmf_swabber)(void *);
804 void (*rmf_dumper)(void *);
805 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
810 * The field is a string, must be NUL-terminated.
812 RMF_F_STRING = 1 << 0,
814 * The field's buffer size need not match the declared \a rmf_size.
816 RMF_F_NO_SIZE_CHECK = 1 << 1,
818 * The field's buffer size must be a whole multiple of the declared \a
819 * rmf_size and the \a rmf_swabber function must work on the declared \a
820 * rmf_size worth of bytes.
822 RMF_F_STRUCT_ARRAY = 1 << 2
830 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
831 .rmf_name = (name), \
832 .rmf_flags = (flags), \
833 .rmf_size = (size), \
834 .rmf_swabber = (void (*)(void*))(swabber), \
835 .rmf_dumper = (void (*)(void*))(dumper) \
838 struct req_msg_field RMF_GENERIC_DATA =
839 DEFINE_MSGF("generic_data", 0,
841 EXPORT_SYMBOL(RMF_GENERIC_DATA);
843 struct req_msg_field RMF_MGS_TARGET_INFO =
844 DEFINE_MSGF("mgs_target_info", 0,
845 sizeof(struct mgs_target_info),
846 lustre_swab_mgs_target_info, NULL);
847 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
849 struct req_msg_field RMF_MGS_SEND_PARAM =
850 DEFINE_MSGF("mgs_send_param", 0,
851 sizeof(struct mgs_send_param),
853 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
855 struct req_msg_field RMF_MGS_CONFIG_BODY =
856 DEFINE_MSGF("mgs_config_read request", 0,
857 sizeof(struct mgs_config_body),
858 lustre_swab_mgs_config_body, NULL);
859 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
861 struct req_msg_field RMF_MGS_CONFIG_RES =
862 DEFINE_MSGF("mgs_config_read reply ", 0,
863 sizeof(struct mgs_config_res),
864 lustre_swab_mgs_config_res, NULL);
865 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
867 struct req_msg_field RMF_U32 =
868 DEFINE_MSGF("generic u32", 0,
869 sizeof(__u32), lustre_swab_generic_32s, NULL);
870 EXPORT_SYMBOL(RMF_U32);
872 struct req_msg_field RMF_SETINFO_VAL =
873 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
874 EXPORT_SYMBOL(RMF_SETINFO_VAL);
876 struct req_msg_field RMF_GETINFO_KEY =
877 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
878 EXPORT_SYMBOL(RMF_GETINFO_KEY);
880 struct req_msg_field RMF_GETINFO_VALLEN =
881 DEFINE_MSGF("getinfo_vallen", 0,
882 sizeof(__u32), lustre_swab_generic_32s, NULL);
883 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
885 struct req_msg_field RMF_GETINFO_VAL =
886 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
887 EXPORT_SYMBOL(RMF_GETINFO_VAL);
889 struct req_msg_field RMF_SEQ_OPC =
890 DEFINE_MSGF("seq_query_opc", 0,
891 sizeof(__u32), lustre_swab_generic_32s, NULL);
892 EXPORT_SYMBOL(RMF_SEQ_OPC);
894 struct req_msg_field RMF_SEQ_RANGE =
895 DEFINE_MSGF("seq_query_range", 0,
896 sizeof(struct lu_seq_range),
897 lustre_swab_lu_seq_range, NULL);
898 EXPORT_SYMBOL(RMF_SEQ_RANGE);
900 struct req_msg_field RMF_FLD_OPC =
901 DEFINE_MSGF("fld_query_opc", 0,
902 sizeof(__u32), lustre_swab_generic_32s, NULL);
903 EXPORT_SYMBOL(RMF_FLD_OPC);
905 struct req_msg_field RMF_FLD_MDFLD =
906 DEFINE_MSGF("fld_query_mdfld", 0,
907 sizeof(struct lu_seq_range),
908 lustre_swab_lu_seq_range, NULL);
909 EXPORT_SYMBOL(RMF_FLD_MDFLD);
911 struct req_msg_field RMF_MDT_BODY =
912 DEFINE_MSGF("mdt_body", 0,
913 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
914 EXPORT_SYMBOL(RMF_MDT_BODY);
916 struct req_msg_field RMF_OBD_QUOTACTL =
917 DEFINE_MSGF("obd_quotactl", 0,
918 sizeof(struct obd_quotactl),
919 lustre_swab_obd_quotactl, NULL);
920 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
922 struct req_msg_field RMF_QUOTA_BODY =
923 DEFINE_MSGF("quota_body", 0,
924 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
925 EXPORT_SYMBOL(RMF_QUOTA_BODY);
927 struct req_msg_field RMF_MDT_EPOCH =
928 DEFINE_MSGF("mdt_ioepoch", 0,
929 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
930 EXPORT_SYMBOL(RMF_MDT_EPOCH);
932 struct req_msg_field RMF_PTLRPC_BODY =
933 DEFINE_MSGF("ptlrpc_body", 0,
934 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
935 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
937 struct req_msg_field RMF_CLOSE_DATA =
938 DEFINE_MSGF("data_version", 0,
939 sizeof(struct close_data), lustre_swab_close_data, NULL);
940 EXPORT_SYMBOL(RMF_CLOSE_DATA);
942 struct req_msg_field RMF_OBD_STATFS =
943 DEFINE_MSGF("obd_statfs", 0,
944 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
945 EXPORT_SYMBOL(RMF_OBD_STATFS);
947 struct req_msg_field RMF_SETINFO_KEY =
948 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
949 EXPORT_SYMBOL(RMF_SETINFO_KEY);
951 struct req_msg_field RMF_NAME =
952 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
953 EXPORT_SYMBOL(RMF_NAME);
955 struct req_msg_field RMF_SYMTGT =
956 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
957 EXPORT_SYMBOL(RMF_SYMTGT);
959 struct req_msg_field RMF_TGTUUID =
960 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
962 EXPORT_SYMBOL(RMF_TGTUUID);
964 struct req_msg_field RMF_CLUUID =
965 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
967 EXPORT_SYMBOL(RMF_CLUUID);
969 struct req_msg_field RMF_STRING =
970 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
971 EXPORT_SYMBOL(RMF_STRING);
973 struct req_msg_field RMF_LLOGD_BODY =
974 DEFINE_MSGF("llogd_body", 0,
975 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
976 EXPORT_SYMBOL(RMF_LLOGD_BODY);
978 struct req_msg_field RMF_LLOG_LOG_HDR =
979 DEFINE_MSGF("llog_log_hdr", 0,
980 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
981 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
983 struct req_msg_field RMF_LLOGD_CONN_BODY =
984 DEFINE_MSGF("llogd_conn_body", 0,
985 sizeof(struct llogd_conn_body),
986 lustre_swab_llogd_conn_body, NULL);
987 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
990 * connection handle received in MDS_CONNECT request.
992 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
993 * that the client does not interpret at all.
995 struct req_msg_field RMF_CONN =
996 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
997 EXPORT_SYMBOL(RMF_CONN);
999 struct req_msg_field RMF_CONNECT_DATA =
1000 DEFINE_MSGF("cdata",
1001 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1002 sizeof(struct obd_connect_data),
1003 lustre_swab_connect, NULL);
1004 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1006 struct req_msg_field RMF_DLM_REQ =
1007 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1008 sizeof(struct ldlm_request),
1009 lustre_swab_ldlm_request, NULL);
1010 EXPORT_SYMBOL(RMF_DLM_REQ);
1012 struct req_msg_field RMF_DLM_REP =
1013 DEFINE_MSGF("dlm_rep", 0,
1014 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1015 EXPORT_SYMBOL(RMF_DLM_REP);
1017 struct req_msg_field RMF_LDLM_INTENT =
1018 DEFINE_MSGF("ldlm_intent", 0,
1019 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1020 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1022 struct req_msg_field RMF_DLM_LVB =
1023 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1024 EXPORT_SYMBOL(RMF_DLM_LVB);
1026 struct req_msg_field RMF_DLM_GL_DESC =
1027 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1028 lustre_swab_gl_desc, NULL);
1029 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1031 struct req_msg_field RMF_MDT_MD =
1032 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1033 EXPORT_SYMBOL(RMF_MDT_MD);
1035 struct req_msg_field RMF_REC_REINT =
1036 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1037 lustre_swab_mdt_rec_reint, NULL);
1038 EXPORT_SYMBOL(RMF_REC_REINT);
1040 /* FIXME: this length should be defined as a macro */
1041 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1043 EXPORT_SYMBOL(RMF_EADATA);
1045 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1046 EXPORT_SYMBOL(RMF_EAVALS);
1048 struct req_msg_field RMF_ACL =
1049 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1050 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1051 EXPORT_SYMBOL(RMF_ACL);
1053 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1054 struct req_msg_field RMF_LOGCOOKIES =
1055 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1056 sizeof(struct llog_cookie), NULL, NULL);
1057 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1059 struct req_msg_field RMF_CAPA1 =
1060 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1061 lustre_swab_lustre_capa, NULL);
1062 EXPORT_SYMBOL(RMF_CAPA1);
1064 struct req_msg_field RMF_CAPA2 =
1065 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1066 lustre_swab_lustre_capa, NULL);
1067 EXPORT_SYMBOL(RMF_CAPA2);
1069 struct req_msg_field RMF_LAYOUT_INTENT =
1070 DEFINE_MSGF("layout_intent", 0,
1071 sizeof(struct layout_intent), lustre_swab_layout_intent,
1073 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1076 * OST request field.
1078 struct req_msg_field RMF_OST_BODY =
1079 DEFINE_MSGF("ost_body", 0,
1080 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1081 EXPORT_SYMBOL(RMF_OST_BODY);
1083 struct req_msg_field RMF_OBD_IOOBJ =
1084 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1085 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1086 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1088 struct req_msg_field RMF_NIOBUF_REMOTE =
1089 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1090 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1092 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1094 struct req_msg_field RMF_RCS =
1095 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1096 lustre_swab_generic_32s, dump_rcs);
1097 EXPORT_SYMBOL(RMF_RCS);
1099 struct req_msg_field RMF_EAVALS_LENS =
1100 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1101 lustre_swab_generic_32s, NULL);
1102 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1104 struct req_msg_field RMF_OBD_ID =
1105 DEFINE_MSGF("obd_id", 0,
1106 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1107 EXPORT_SYMBOL(RMF_OBD_ID);
1109 struct req_msg_field RMF_FID =
1110 DEFINE_MSGF("fid", 0,
1111 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1112 EXPORT_SYMBOL(RMF_FID);
1114 struct req_msg_field RMF_OST_ID =
1115 DEFINE_MSGF("ost_id", 0,
1116 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1117 EXPORT_SYMBOL(RMF_OST_ID);
1119 struct req_msg_field RMF_FIEMAP_KEY =
1120 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1121 lustre_swab_fiemap, NULL);
1122 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1124 struct req_msg_field RMF_FIEMAP_VAL =
1125 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1126 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1128 struct req_msg_field RMF_IDX_INFO =
1129 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1130 lustre_swab_idx_info, NULL);
1131 EXPORT_SYMBOL(RMF_IDX_INFO);
1132 struct req_msg_field RMF_HSM_USER_STATE =
1133 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1134 lustre_swab_hsm_user_state, NULL);
1135 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1137 struct req_msg_field RMF_HSM_STATE_SET =
1138 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1139 lustre_swab_hsm_state_set, NULL);
1140 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1142 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1143 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1144 lustre_swab_hsm_progress_kernel, NULL);
1145 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1147 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1148 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1149 lustre_swab_hsm_current_action, NULL);
1150 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1152 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1153 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1154 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1156 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1158 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1159 DEFINE_MSGF("hsm_archive", 0,
1160 sizeof(__u32), lustre_swab_generic_32s, NULL);
1161 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1163 struct req_msg_field RMF_MDS_HSM_REQUEST =
1164 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1165 lustre_swab_hsm_request, NULL);
1166 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1168 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1169 lustre_swab_object_update_request, NULL);
1170 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1172 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1173 DEFINE_MSGF("object_update_reply", 0, -1,
1174 lustre_swab_object_update_reply, NULL);
1175 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1177 struct req_msg_field RMF_SWAP_LAYOUTS =
1178 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1179 lustre_swab_swap_layouts, NULL);
1180 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1182 struct req_msg_field RMF_LFSCK_REQUEST =
1183 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1184 lustre_swab_lfsck_request, NULL);
1185 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1187 struct req_msg_field RMF_LFSCK_REPLY =
1188 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1189 lustre_swab_lfsck_reply, NULL);
1190 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1197 const char *rf_name;
1201 const struct req_msg_field **d;
1202 } rf_fields[RCL_NR];
1205 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1219 #define DEFINE_REQ_FMT0(name, client, server) \
1220 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1222 struct req_format RQF_OBD_PING =
1223 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1224 EXPORT_SYMBOL(RQF_OBD_PING);
1226 struct req_format RQF_OBD_SET_INFO =
1227 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1228 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1230 /* Read index file through the network */
1231 struct req_format RQF_OBD_IDX_READ =
1232 DEFINE_REQ_FMT0("OBD_IDX_READ",
1233 obd_idx_read_client, obd_idx_read_server);
1234 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1236 struct req_format RQF_SEC_CTX =
1237 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1238 EXPORT_SYMBOL(RQF_SEC_CTX);
1240 struct req_format RQF_MGS_TARGET_REG =
1241 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1242 mgs_target_info_only);
1243 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1245 struct req_format RQF_MGS_SET_INFO =
1246 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1248 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1250 struct req_format RQF_MGS_CONFIG_READ =
1251 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1252 mgs_config_read_server);
1253 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1255 struct req_format RQF_SEQ_QUERY =
1256 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1257 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1259 struct req_format RQF_FLD_QUERY =
1260 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1261 EXPORT_SYMBOL(RQF_FLD_QUERY);
1263 struct req_format RQF_FLD_READ =
1264 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1265 EXPORT_SYMBOL(RQF_FLD_READ);
1267 struct req_format RQF_LOG_CANCEL =
1268 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1269 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1271 struct req_format RQF_MDS_QUOTACTL =
1272 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1273 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1275 struct req_format RQF_OST_QUOTACTL =
1276 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1277 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1279 struct req_format RQF_QUOTA_DQACQ =
1280 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1281 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1283 struct req_format RQF_LDLM_INTENT_QUOTA =
1284 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1285 ldlm_intent_quota_client,
1286 ldlm_intent_quota_server);
1287 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1289 struct req_format RQF_MDS_GETSTATUS =
1290 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1291 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1293 struct req_format RQF_MDS_STATFS =
1294 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1295 EXPORT_SYMBOL(RQF_MDS_STATFS);
1297 struct req_format RQF_MDS_SYNC =
1298 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1299 EXPORT_SYMBOL(RQF_MDS_SYNC);
1301 struct req_format RQF_MDS_GETATTR =
1302 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1303 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1305 struct req_format RQF_MDS_GETXATTR =
1306 DEFINE_REQ_FMT0("MDS_GETXATTR",
1307 mds_getxattr_client, mds_getxattr_server);
1308 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1310 struct req_format RQF_MDS_GETATTR_NAME =
1311 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1312 mds_getattr_name_client, mds_getattr_server);
1313 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1315 struct req_format RQF_MDS_REINT =
1316 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1317 EXPORT_SYMBOL(RQF_MDS_REINT);
1319 struct req_format RQF_MDS_REINT_CREATE =
1320 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1321 mds_reint_create_client, mdt_body_capa);
1322 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1324 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1325 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1326 mds_reint_create_rmt_acl_client, mdt_body_capa);
1327 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1329 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1330 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1331 mds_reint_create_slave_client, mdt_body_capa);
1332 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1334 struct req_format RQF_MDS_REINT_CREATE_SYM =
1335 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1336 mds_reint_create_sym_client, mdt_body_capa);
1337 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1339 struct req_format RQF_MDS_REINT_OPEN =
1340 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1341 mds_reint_open_client, mds_reint_open_server);
1342 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1344 struct req_format RQF_MDS_REINT_UNLINK =
1345 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1346 mds_last_unlink_server);
1347 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1349 struct req_format RQF_MDS_REINT_LINK =
1350 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1351 mds_reint_link_client, mdt_body_only);
1352 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1354 struct req_format RQF_MDS_REINT_RENAME =
1355 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1356 mds_last_unlink_server);
1357 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1359 struct req_format RQF_MDS_REINT_SETATTR =
1360 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1361 mds_reint_setattr_client, mds_setattr_server);
1362 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1364 struct req_format RQF_MDS_REINT_SETXATTR =
1365 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1366 mds_reint_setxattr_client, mdt_body_only);
1367 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1369 struct req_format RQF_MDS_CONNECT =
1370 DEFINE_REQ_FMT0("MDS_CONNECT",
1371 obd_connect_client, obd_connect_server);
1372 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1374 struct req_format RQF_MDS_DISCONNECT =
1375 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1376 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1378 struct req_format RQF_MDS_GET_INFO =
1379 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1380 mds_getinfo_server);
1381 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1383 struct req_format RQF_OUT_UPDATE =
1384 DEFINE_REQ_FMT0("OUT_UPDATE_OBJ", mds_update_client,
1386 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1388 struct req_format RQF_LDLM_ENQUEUE =
1389 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1390 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1391 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1393 struct req_format RQF_LDLM_ENQUEUE_LVB =
1394 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1395 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1396 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1398 struct req_format RQF_LDLM_CONVERT =
1399 DEFINE_REQ_FMT0("LDLM_CONVERT",
1400 ldlm_enqueue_client, ldlm_enqueue_server);
1401 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1403 struct req_format RQF_LDLM_CANCEL =
1404 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1405 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1407 struct req_format RQF_LDLM_CALLBACK =
1408 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1409 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1411 struct req_format RQF_LDLM_CP_CALLBACK =
1412 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1413 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1415 struct req_format RQF_LDLM_BL_CALLBACK =
1416 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1417 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1419 struct req_format RQF_LDLM_GL_CALLBACK =
1420 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1421 ldlm_gl_callback_server);
1422 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1424 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1425 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1426 ldlm_gl_callback_server);
1427 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1429 struct req_format RQF_LDLM_INTENT_BASIC =
1430 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1431 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1432 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1434 struct req_format RQF_LDLM_INTENT =
1435 DEFINE_REQ_FMT0("LDLM_INTENT",
1436 ldlm_intent_client, ldlm_intent_server);
1437 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1439 struct req_format RQF_LDLM_INTENT_LAYOUT =
1440 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1441 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1442 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1444 struct req_format RQF_LDLM_INTENT_GETATTR =
1445 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1446 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1447 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1449 struct req_format RQF_LDLM_INTENT_OPEN =
1450 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1451 ldlm_intent_open_client, ldlm_intent_open_server);
1452 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1454 struct req_format RQF_LDLM_INTENT_CREATE =
1455 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1456 ldlm_intent_create_client, ldlm_intent_getattr_server);
1457 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1459 struct req_format RQF_LDLM_INTENT_UNLINK =
1460 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1461 ldlm_intent_unlink_client, ldlm_intent_server);
1462 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1464 struct req_format RQF_LDLM_INTENT_GETXATTR =
1465 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1466 ldlm_intent_getxattr_client,
1467 ldlm_intent_getxattr_server);
1468 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1470 struct req_format RQF_MDS_CLOSE =
1471 DEFINE_REQ_FMT0("MDS_CLOSE",
1472 mdt_close_client, mds_last_unlink_server);
1473 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1475 struct req_format RQF_MDS_INTENT_CLOSE =
1476 DEFINE_REQ_FMT0("MDS_CLOSE",
1477 mdt_intent_close_client, mds_last_unlink_server);
1478 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1480 struct req_format RQF_MDS_READPAGE =
1481 DEFINE_REQ_FMT0("MDS_READPAGE",
1482 mdt_body_capa, mdt_body_only);
1483 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1485 struct req_format RQF_MDS_HSM_ACTION =
1486 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1487 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1489 struct req_format RQF_MDS_HSM_PROGRESS =
1490 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1491 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1493 struct req_format RQF_MDS_HSM_CT_REGISTER =
1494 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1495 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1497 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1498 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1499 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1501 struct req_format RQF_MDS_HSM_STATE_GET =
1502 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1503 mdt_body_capa, mdt_hsm_state_get_server);
1504 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1506 struct req_format RQF_MDS_HSM_STATE_SET =
1507 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1508 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1510 struct req_format RQF_MDS_HSM_REQUEST =
1511 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1512 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1514 struct req_format RQF_MDS_SWAP_LAYOUTS =
1515 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1516 mdt_swap_layouts, empty);
1517 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1519 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1520 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1521 llog_origin_handle_create_client, llogd_body_only);
1522 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1524 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1525 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1526 llogd_body_only, llogd_body_only);
1527 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1529 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1530 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1531 llogd_body_only, llog_origin_handle_next_block_server);
1532 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1534 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1535 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1536 llogd_body_only, llog_origin_handle_next_block_server);
1537 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1539 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1540 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1541 llogd_body_only, llog_log_hdr_only);
1542 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1544 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1545 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1546 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1548 struct req_format RQF_CONNECT =
1549 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1550 EXPORT_SYMBOL(RQF_CONNECT);
1552 struct req_format RQF_OST_CONNECT =
1553 DEFINE_REQ_FMT0("OST_CONNECT",
1554 obd_connect_client, obd_connect_server);
1555 EXPORT_SYMBOL(RQF_OST_CONNECT);
1557 struct req_format RQF_OST_DISCONNECT =
1558 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1559 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1561 struct req_format RQF_OST_GETATTR =
1562 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1563 EXPORT_SYMBOL(RQF_OST_GETATTR);
1565 struct req_format RQF_OST_SETATTR =
1566 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1567 EXPORT_SYMBOL(RQF_OST_SETATTR);
1569 struct req_format RQF_OST_CREATE =
1570 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1571 EXPORT_SYMBOL(RQF_OST_CREATE);
1573 struct req_format RQF_OST_PUNCH =
1574 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1575 EXPORT_SYMBOL(RQF_OST_PUNCH);
1577 struct req_format RQF_OST_SYNC =
1578 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1579 EXPORT_SYMBOL(RQF_OST_SYNC);
1581 struct req_format RQF_OST_DESTROY =
1582 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1583 EXPORT_SYMBOL(RQF_OST_DESTROY);
1585 struct req_format RQF_OST_BRW_READ =
1586 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1587 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1589 struct req_format RQF_OST_BRW_WRITE =
1590 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1591 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1593 struct req_format RQF_OST_STATFS =
1594 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1595 EXPORT_SYMBOL(RQF_OST_STATFS);
1597 struct req_format RQF_OST_SET_GRANT_INFO =
1598 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1600 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1602 struct req_format RQF_OST_GET_INFO =
1603 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1604 ost_get_info_generic_server);
1605 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1607 struct req_format RQF_OST_GET_INFO_LAST_ID =
1608 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1609 ost_get_last_id_server);
1610 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1612 struct req_format RQF_OST_GET_INFO_LAST_FID =
1613 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1614 ost_get_last_fid_server);
1615 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1617 struct req_format RQF_OST_SET_INFO_LAST_FID =
1618 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1620 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1622 struct req_format RQF_OST_GET_INFO_FIEMAP =
1623 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1624 ost_get_fiemap_server);
1625 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1627 struct req_format RQF_LFSCK_NOTIFY =
1628 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1629 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1631 struct req_format RQF_LFSCK_QUERY =
1632 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1633 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1635 #if !defined(__REQ_LAYOUT_USER__)
1637 /* Convenience macro */
1638 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1641 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1642 * field of RQFs and the \a rmf_offset field of RMFs.
1644 int req_layout_init(void)
1649 struct req_format *rf = NULL;
1651 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1652 rf = req_formats[i];
1654 for (j = 0; j < RCL_NR; ++j) {
1655 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1656 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1657 struct req_msg_field *field;
1659 field = (typeof(field))rf->rf_fields[j].d[k];
1660 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1661 || field->rmf_size > 0);
1662 LASSERT(field->rmf_offset[i][j] == 0);
1664 * k + 1 to detect unused format/field
1667 field->rmf_offset[i][j] = k + 1;
1673 EXPORT_SYMBOL(req_layout_init);
1675 void req_layout_fini(void)
1678 EXPORT_SYMBOL(req_layout_fini);
1681 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1683 * Actual/expected field sizes are set elsewhere in functions in this file:
1684 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1685 * req_capsule_msg_size(). The \a rc_area information is used by.
1686 * ptlrpc_request_set_replen().
1688 void req_capsule_init_area(struct req_capsule *pill)
1692 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1693 pill->rc_area[RCL_CLIENT][i] = -1;
1694 pill->rc_area[RCL_SERVER][i] = -1;
1697 EXPORT_SYMBOL(req_capsule_init_area);
1700 * Initialize a pill.
1702 * The \a location indicates whether the caller is executing on the client side
1703 * (RCL_CLIENT) or server side (RCL_SERVER)..
1705 void req_capsule_init(struct req_capsule *pill,
1706 struct ptlrpc_request *req,
1707 enum req_location location)
1709 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1712 * Today all capsules are embedded in ptlrpc_request structs,
1713 * but just in case that ever isn't the case, we don't reach
1714 * into req unless req != NULL and pill is the one embedded in
1717 * The req->rq_pill_init flag makes it safe to initialize a pill
1718 * twice, which might happen in the OST paths as a result of the
1719 * high-priority RPC queue getting peeked at before ost_handle()
1720 * handles an OST RPC.
1722 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1725 memset(pill, 0, sizeof *pill);
1727 pill->rc_loc = location;
1728 req_capsule_init_area(pill);
1730 if (req != NULL && pill == &req->rq_pill)
1731 req->rq_pill_init = 1;
1733 EXPORT_SYMBOL(req_capsule_init);
1735 void req_capsule_fini(struct req_capsule *pill)
1738 EXPORT_SYMBOL(req_capsule_fini);
1740 static int __req_format_is_sane(const struct req_format *fmt)
1742 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1743 req_formats[fmt->rf_idx] == fmt;
1746 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1747 enum req_location loc)
1749 struct ptlrpc_request *req;
1752 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1756 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1757 * (see req_capsule_extend()).
1759 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1761 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1762 LASSERT(__req_format_is_sane(fmt));
1766 EXPORT_SYMBOL(req_capsule_set);
1769 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1772 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1773 * variable-sized fields. The field sizes come from the declared \a rmf_size
1774 * field of a \a pill's \a rc_fmt's RMF's.
1776 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1777 enum req_location loc)
1779 const struct req_format *fmt = pill->rc_fmt;
1782 LASSERT(fmt != NULL);
1784 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1785 if (pill->rc_area[loc][i] == -1) {
1786 pill->rc_area[loc][i] =
1787 fmt->rf_fields[loc].d[i]->rmf_size;
1788 if (pill->rc_area[loc][i] == -1) {
1790 * Skip the following fields.
1792 * If this LASSERT() trips then you're missing a
1793 * call to req_capsule_set_size().
1795 LASSERT(loc != RCL_SERVER);
1802 EXPORT_SYMBOL(req_capsule_filled_sizes);
1805 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1807 * This function uses the \a pill's \a rc_area as filled in by
1808 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1811 int req_capsule_server_pack(struct req_capsule *pill)
1813 const struct req_format *fmt;
1817 LASSERT(pill->rc_loc == RCL_SERVER);
1819 LASSERT(fmt != NULL);
1821 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1822 rc = lustre_pack_reply(pill->rc_req, count,
1823 pill->rc_area[RCL_SERVER], NULL);
1825 DEBUG_REQ(D_ERROR, pill->rc_req,
1826 "Cannot pack %d fields in format `%s': ",
1827 count, fmt->rf_name);
1831 EXPORT_SYMBOL(req_capsule_server_pack);
1834 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1835 * corresponding to the given RMF (\a field).
1837 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1838 const struct req_msg_field *field,
1839 enum req_location loc)
1843 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1844 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1845 pill->rc_fmt->rf_name,
1846 field->rmf_name, offset, loc);
1849 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1854 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1859 swabber_dumper_helper(struct req_capsule *pill,
1860 const struct req_msg_field *field,
1861 enum req_location loc,
1863 void *value, int len, int dump, void (*swabber)( void *))
1869 int inout = loc == RCL_CLIENT;
1871 swabber = swabber ?: field->rmf_swabber;
1873 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1874 swabber != NULL && value != NULL)
1879 if (!field->rmf_dumper)
1882 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1884 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1885 do_swab ? "unswabbed " : "", field->rmf_name);
1886 field->rmf_dumper(value);
1891 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1893 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1894 "follows\n", field->rmf_name);
1895 field->rmf_dumper(value);
1902 * We're swabbing an array; swabber() swabs a single array element, so
1903 * swab every element.
1905 LASSERT((len % field->rmf_size) == 0);
1906 for (p = value, i = 0, n = len / field->rmf_size;
1908 i++, p += field->rmf_size) {
1910 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1911 "element %d follows\n",
1912 do_swab ? "unswabbed " : "", field->rmf_name, i);
1913 field->rmf_dumper(p);
1919 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1920 "element %d follows\n", field->rmf_name, i);
1921 field->rmf_dumper(value);
1925 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1929 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1930 * corresponding to the given RMF (\a field).
1932 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1933 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1934 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1935 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1936 * element of the array swabbed.
1938 static void *__req_capsule_get(struct req_capsule *pill,
1939 const struct req_msg_field *field,
1940 enum req_location loc,
1941 void (*swabber)( void *),
1944 const struct req_format *fmt;
1945 struct lustre_msg *msg;
1950 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
1952 static const char *rcl_names[RCL_NR] = {
1953 [RCL_CLIENT] = "client",
1954 [RCL_SERVER] = "server"
1957 LASSERT(pill != NULL);
1958 LASSERT(pill != LP_POISON);
1960 LASSERT(fmt != NULL);
1961 LASSERT(fmt != LP_POISON);
1962 LASSERT(__req_format_is_sane(fmt));
1964 offset = __req_capsule_offset(pill, field, loc);
1966 msg = __req_msg(pill, loc);
1967 LASSERT(msg != NULL);
1969 getter = (field->rmf_flags & RMF_F_STRING) ?
1970 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1972 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
1974 * We've already asserted that field->rmf_size > 0 in
1975 * req_layout_init().
1977 len = lustre_msg_buflen(msg, offset);
1978 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1979 (len % field->rmf_size) != 0) {
1980 CERROR("%s: array field size mismatch "
1981 "%d modulo %u != 0 (%d)\n",
1982 field->rmf_name, len, field->rmf_size, loc);
1985 } else if (pill->rc_area[loc][offset] != -1) {
1986 len = pill->rc_area[loc][offset];
1988 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
1990 value = getter(msg, offset, len);
1992 if (value == NULL) {
1993 DEBUG_REQ(D_ERROR, pill->rc_req,
1994 "Wrong buffer for field `%s' (%u of %u) "
1995 "in format `%s': %u vs. %u (%s)\n",
1996 field->rmf_name, offset, lustre_msg_bufcount(msg),
1997 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2000 swabber_dumper_helper(pill, field, loc, offset, value, len,
2008 * Dump a request and/or reply
2010 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2012 const struct req_format *fmt;
2013 const struct req_msg_field *field;
2019 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2020 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2021 field = FMT_FIELD(fmt, loc, i);
2022 if (field->rmf_dumper == NULL) {
2024 * FIXME Add a default hex dumper for fields that don't
2025 * have a specific dumper
2027 len = req_capsule_get_size(pill, field, loc);
2028 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2029 "field size is %u\n", field->rmf_name, len);
2031 /* It's the dumping side-effect that we're interested in */
2032 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2035 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2041 void req_capsule_client_dump(struct req_capsule *pill)
2043 __req_capsule_dump(pill, RCL_CLIENT);
2045 EXPORT_SYMBOL(req_capsule_client_dump);
2050 void req_capsule_server_dump(struct req_capsule *pill)
2052 __req_capsule_dump(pill, RCL_SERVER);
2054 EXPORT_SYMBOL(req_capsule_server_dump);
2057 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2058 * buffer corresponding to the given RMF (\a field) of a \a pill.
2060 void *req_capsule_client_get(struct req_capsule *pill,
2061 const struct req_msg_field *field)
2063 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2065 EXPORT_SYMBOL(req_capsule_client_get);
2068 * Same as req_capsule_client_get(), but with a \a swabber argument.
2070 * Currently unused; will be removed when req_capsule_server_swab_get() is
2073 void *req_capsule_client_swab_get(struct req_capsule *pill,
2074 const struct req_msg_field *field,
2077 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2079 EXPORT_SYMBOL(req_capsule_client_swab_get);
2082 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2084 * First the \a pill's request \a field's size is set (\a rc_area) using
2085 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2088 void *req_capsule_client_sized_get(struct req_capsule *pill,
2089 const struct req_msg_field *field,
2092 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2093 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2095 EXPORT_SYMBOL(req_capsule_client_sized_get);
2098 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2099 * buffer corresponding to the given RMF (\a field) of a \a pill.
2101 void *req_capsule_server_get(struct req_capsule *pill,
2102 const struct req_msg_field *field)
2104 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2106 EXPORT_SYMBOL(req_capsule_server_get);
2109 * Same as req_capsule_server_get(), but with a \a swabber argument.
2111 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2112 * swabbing done outside this capsule abstraction.
2114 void *req_capsule_server_swab_get(struct req_capsule *pill,
2115 const struct req_msg_field *field,
2118 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2120 EXPORT_SYMBOL(req_capsule_server_swab_get);
2123 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2125 * First the \a pill's request \a field's size is set (\a rc_area) using
2126 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2129 void *req_capsule_server_sized_get(struct req_capsule *pill,
2130 const struct req_msg_field *field,
2133 req_capsule_set_size(pill, field, RCL_SERVER, len);
2134 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2136 EXPORT_SYMBOL(req_capsule_server_sized_get);
2138 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2139 const struct req_msg_field *field,
2140 __u32 len, void *swabber)
2142 req_capsule_set_size(pill, field, RCL_SERVER, len);
2143 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2145 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2148 * Returns the buffer of a \a pill corresponding to the given \a field from the
2149 * request (if the caller is executing on the server-side) or reply (if the
2150 * caller is executing on the client-side).
2152 * This function convienient for use is code that could be executed on the
2153 * client and server alike.
2155 const void *req_capsule_other_get(struct req_capsule *pill,
2156 const struct req_msg_field *field)
2158 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2160 EXPORT_SYMBOL(req_capsule_other_get);
2163 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2164 * field of the given \a pill.
2166 * This function must be used when constructing variable sized fields of a
2169 void req_capsule_set_size(struct req_capsule *pill,
2170 const struct req_msg_field *field,
2171 enum req_location loc, __u32 size)
2173 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2175 if ((size != (__u32)field->rmf_size) &&
2176 (field->rmf_size != -1) &&
2177 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2179 __u32 rmf_size = (__u32)field->rmf_size;
2180 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2181 (size % rmf_size != 0)) {
2182 CERROR("%s: array field size mismatch "
2183 "%u %% %u != 0 (%d)\n",
2184 field->rmf_name, size, rmf_size, loc);
2186 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2188 CERROR("%s: field size mismatch %u != %u (%d)\n",
2189 field->rmf_name, size, rmf_size, loc);
2194 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2196 EXPORT_SYMBOL(req_capsule_set_size);
2199 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2200 * for the given \a pill's given \a field.
2202 * NB: this function doesn't correspond with req_capsule_set_size(), which
2203 * actually sets the size in pill.rc_area[loc][offset], but this function
2204 * returns the message buflen[offset], maybe we should use another name.
2206 __u32 req_capsule_get_size(const struct req_capsule *pill,
2207 const struct req_msg_field *field,
2208 enum req_location loc)
2210 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2212 return lustre_msg_buflen(__req_msg(pill, loc),
2213 __req_capsule_offset(pill, field, loc));
2215 EXPORT_SYMBOL(req_capsule_get_size);
2218 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2219 * given \a pill's request or reply (\a loc) given the field size recorded in
2220 * the \a pill's rc_area.
2222 * See also req_capsule_set_size().
2224 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2226 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2227 pill->rc_fmt->rf_fields[loc].nr,
2228 pill->rc_area[loc]);
2232 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2233 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2234 * PTLRPC request or reply given only an RQF (\a fmt).
2236 * This function should not be used for formats which contain variable size
2239 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2240 enum req_location loc)
2246 * This function should probably LASSERT() that fmt has no fields with
2247 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2248 * elements in the array there will ultimately be, but then, we could
2249 * assume that there will be at least one element, and that's just what
2252 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2256 for (; i < fmt->rf_fields[loc].nr; ++i)
2257 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2258 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2264 * Changes the format of an RPC.
2266 * The pill must already have been initialized, which means that it already has
2267 * a request format. The new format \a fmt must be an extension of the pill's
2268 * old format. Specifically: the new format must have as many request and reply
2269 * fields as the old one, and all fields shared by the old and new format must
2270 * be at least as large in the new format.
2272 * The new format's fields may be of different "type" than the old format, but
2273 * only for fields that are "opaque" blobs: fields which have a) have no
2274 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2275 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2276 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2277 * according to the key field. When the value, according to the key, contains a
2278 * structure (or array thereof) to be swabbed, the format should be changed to
2279 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2282 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2287 const struct req_format *old;
2289 LASSERT(pill->rc_fmt != NULL);
2290 LASSERT(__req_format_is_sane(fmt));
2294 * Sanity checking...
2296 for (i = 0; i < RCL_NR; ++i) {
2297 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2298 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2299 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2301 /* "opaque" fields can be transmogrified */
2302 if (ofield->rmf_swabber == NULL &&
2303 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2304 (ofield->rmf_size == -1 ||
2305 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2307 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2310 * Last field in old format can be shorter than in new.
2312 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2313 FMT_FIELD(old, i, j)->rmf_size);
2318 EXPORT_SYMBOL(req_capsule_extend);
2321 * This function returns a non-zero value if the given \a field is present in
2322 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2325 int req_capsule_has_field(const struct req_capsule *pill,
2326 const struct req_msg_field *field,
2327 enum req_location loc)
2329 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2331 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2333 EXPORT_SYMBOL(req_capsule_has_field);
2336 * Returns a non-zero value if the given \a field is present in the given \a
2337 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2339 int req_capsule_field_present(const struct req_capsule *pill,
2340 const struct req_msg_field *field,
2341 enum req_location loc)
2345 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2346 LASSERT(req_capsule_has_field(pill, field, loc));
2348 offset = __req_capsule_offset(pill, field, loc);
2349 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2351 EXPORT_SYMBOL(req_capsule_field_present);
2354 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2355 * request or reply (\a loc).
2357 * This is not the opposite of req_capsule_extend().
2359 void req_capsule_shrink(struct req_capsule *pill,
2360 const struct req_msg_field *field,
2362 enum req_location loc)
2364 const struct req_format *fmt;
2365 struct lustre_msg *msg;
2370 LASSERT(fmt != NULL);
2371 LASSERT(__req_format_is_sane(fmt));
2372 LASSERT(req_capsule_has_field(pill, field, loc));
2373 LASSERT(req_capsule_field_present(pill, field, loc));
2375 offset = __req_capsule_offset(pill, field, loc);
2377 msg = __req_msg(pill, loc);
2378 len = lustre_msg_buflen(msg, offset);
2379 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2380 fmt->rf_name, field->rmf_name, len, newlen);
2382 if (loc == RCL_CLIENT)
2383 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2386 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2389 EXPORT_SYMBOL(req_capsule_shrink);
2391 int req_capsule_server_grow(struct req_capsule *pill,
2392 const struct req_msg_field *field,
2395 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2400 LASSERT(pill->rc_fmt != NULL);
2401 LASSERT(__req_format_is_sane(pill->rc_fmt));
2402 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2403 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2405 len = req_capsule_get_size(pill, field, RCL_SERVER);
2406 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2407 if ((__u32)pill->rc_req->rq_repbuf_len >=
2408 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2409 CERROR("Inplace repack might be done\n");
2411 pill->rc_req->rq_reply_state = NULL;
2412 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2413 rc = req_capsule_server_pack(pill);
2415 /* put old rs back, the caller will decide what to do */
2416 pill->rc_req->rq_reply_state = rs;
2419 nrs = pill->rc_req->rq_reply_state;
2420 /* Now we need only buffers, copy first chunk */
2421 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2422 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2423 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2424 memcpy(to, from, len);
2425 /* check if we have tail and copy it too */
2426 if (rs->rs_msg->lm_bufcount > offset + 1) {
2427 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2428 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2429 offset = rs->rs_msg->lm_bufcount - 1;
2430 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2431 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2432 memcpy(to, from, len);
2434 /* drop old reply if everything is fine */
2435 if (rs->rs_difficult) {
2439 nrs->rs_difficult = 1;
2440 nrs->rs_no_ack = rs->rs_no_ack;
2441 for (i = 0; i < rs->rs_nlocks; i++) {
2442 nrs->rs_locks[i] = rs->rs_locks[i];
2443 nrs->rs_modes[i] = rs->rs_modes[i];
2447 rs->rs_difficult = 0;
2450 ptlrpc_rs_decref(rs);
2453 EXPORT_SYMBOL(req_capsule_server_grow);
2454 /* __REQ_LAYOUT_USER__ */