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, 2015, 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 #include <lustre/lustre_idl.h>
57 #include <llog_swab.h>
58 #include <lustre_debug.h>
59 #include <lustre_swab.h>
60 #include <lustre_ver.h>
62 #include <obd_support.h>
63 #endif /* !__REQ_LAYOUT_USER__ */
65 /* struct ptlrpc_request, lustre_msg* */
66 #include <lustre_req_layout.h>
67 #include <lustre_acl.h>
70 * RQFs (see below) refer to two struct req_msg_field arrays describing the
71 * client request and server reply, respectively.
73 /* empty set of fields... for suitable definition of emptiness. */
74 static const struct req_msg_field *empty[] = {
78 static const struct req_msg_field *mgs_target_info_only[] = {
83 static const struct req_msg_field *mgs_set_info[] = {
88 static const struct req_msg_field *mgs_config_read_client[] = {
93 static const struct req_msg_field *mgs_config_read_server[] = {
98 static const struct req_msg_field *log_cancel_client[] = {
103 static const struct req_msg_field *mdt_body_only[] = {
108 static const struct req_msg_field *mdt_body_capa[] = {
114 static const struct req_msg_field *quotactl_only[] = {
119 static const struct req_msg_field *quota_body_only[] = {
124 static const struct req_msg_field *ldlm_intent_quota_client[] = {
131 static const struct req_msg_field *ldlm_intent_quota_server[] = {
138 static const struct req_msg_field *mdt_close_client[] = {
145 static const struct req_msg_field *mdt_intent_close_client[] = {
153 static const struct req_msg_field *obd_statfs_server[] = {
158 static const struct req_msg_field *seq_query_client[] = {
164 static const struct req_msg_field *seq_query_server[] = {
169 static const struct req_msg_field *fld_query_client[] = {
175 static const struct req_msg_field *fld_query_server[] = {
180 static const struct req_msg_field *fld_read_client[] = {
185 static const struct req_msg_field *fld_read_server[] = {
190 static const struct req_msg_field *mds_getattr_name_client[] = {
197 static const struct req_msg_field *mds_reint_client[] = {
202 static const struct req_msg_field *mds_reint_create_client[] = {
209 static const struct req_msg_field *mds_reint_create_slave_client[] = {
218 static const struct req_msg_field *mds_reint_create_acl_client[] = {
225 &RMF_FILE_SECCTX_NAME,
229 static const struct req_msg_field *mds_reint_create_sym_client[] = {
236 &RMF_FILE_SECCTX_NAME,
240 static const struct req_msg_field *mds_reint_open_client[] = {
247 &RMF_FILE_SECCTX_NAME,
251 static const struct req_msg_field *mds_reint_open_server[] = {
260 static const struct req_msg_field *mds_reint_unlink_client[] = {
268 static const struct req_msg_field *mds_reint_link_client[] = {
277 static const struct req_msg_field *mds_reint_rename_client[] = {
287 static const struct req_msg_field *mds_reint_migrate_client[] = {
299 static const struct req_msg_field *mds_last_unlink_server[] = {
308 static const struct req_msg_field *mds_reint_setattr_client[] = {
318 static const struct req_msg_field *mds_reint_setxattr_client[] = {
327 static const struct req_msg_field *mdt_swap_layouts[] = {
336 static const struct req_msg_field *obd_connect_client[] = {
344 static const struct req_msg_field *obd_connect_server[] = {
349 static const struct req_msg_field *obd_set_info_client[] = {
355 static const struct req_msg_field *ost_grant_shrink_client[] = {
361 static const struct req_msg_field *mds_getinfo_client[] = {
367 static const struct req_msg_field *mds_getinfo_server[] = {
372 static const struct req_msg_field *ldlm_enqueue_client[] = {
377 static const struct req_msg_field *ldlm_enqueue_server[] = {
382 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
388 static const struct req_msg_field *ldlm_cp_callback_client[] = {
394 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
400 static const struct req_msg_field *ldlm_gl_callback_server[] = {
405 static const struct req_msg_field *ldlm_intent_basic_client[] = {
411 static const struct req_msg_field *ldlm_intent_client[] = {
418 static const struct req_msg_field *ldlm_intent_server[] = {
426 static const struct req_msg_field *ldlm_intent_layout_client[] = {
431 &RMF_EADATA /* for new layout to be set up */
433 static const struct req_msg_field *ldlm_intent_open_server[] = {
443 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
447 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
452 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
461 static const struct req_msg_field *ldlm_intent_create_client[] = {
465 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
469 &RMF_FILE_SECCTX_NAME,
473 static const struct req_msg_field *ldlm_intent_open_client[] = {
477 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
482 &RMF_FILE_SECCTX_NAME,
486 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
490 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
495 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
503 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
508 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
514 static const struct req_msg_field *mds_get_root_client[] = {
520 static const struct req_msg_field *mds_getxattr_client[] = {
528 static const struct req_msg_field *mds_getxattr_server[] = {
534 static const struct req_msg_field *mds_getattr_server[] = {
543 static const struct req_msg_field *mds_setattr_server[] = {
552 static const struct req_msg_field *mds_update_client[] = {
554 &RMF_OUT_UPDATE_HEADER,
558 static const struct req_msg_field *mds_update_server[] = {
560 &RMF_OUT_UPDATE_REPLY,
563 static const struct req_msg_field *llog_origin_handle_create_client[] = {
569 static const struct req_msg_field *llogd_body_only[] = {
574 static const struct req_msg_field *llog_log_hdr_only[] = {
579 static const struct req_msg_field *llogd_conn_body_only[] = {
584 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
590 static const struct req_msg_field *obd_idx_read_client[] = {
595 static const struct req_msg_field *obd_idx_read_server[] = {
600 static const struct req_msg_field *ost_body_only[] = {
605 static const struct req_msg_field *ost_body_capa[] = {
611 static const struct req_msg_field *ost_destroy_client[] = {
619 static const struct req_msg_field *ost_brw_client[] = {
627 static const struct req_msg_field *ost_brw_read_server[] = {
632 static const struct req_msg_field *ost_brw_write_server[] = {
638 static const struct req_msg_field *ost_get_info_generic_server[] = {
643 static const struct req_msg_field *ost_get_info_generic_client[] = {
648 static const struct req_msg_field *ost_get_last_id_server[] = {
653 static const struct req_msg_field *ost_get_last_fid_client[] = {
659 static const struct req_msg_field *ost_get_last_fid_server[] = {
664 static const struct req_msg_field *ost_get_fiemap_client[] = {
670 static const struct req_msg_field *ost_ladvise[] = {
673 &RMF_OST_LADVISE_HDR,
677 static const struct req_msg_field *ost_get_fiemap_server[] = {
682 static const struct req_msg_field *mdt_hsm_progress[] = {
685 &RMF_MDS_HSM_PROGRESS,
688 static const struct req_msg_field *mdt_hsm_ct_register[] = {
691 &RMF_MDS_HSM_ARCHIVE,
694 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
699 static const struct req_msg_field *mdt_hsm_action_server[] = {
702 &RMF_MDS_HSM_CURRENT_ACTION,
705 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
711 static const struct req_msg_field *mdt_hsm_state_set[] = {
718 static const struct req_msg_field *mdt_hsm_request[] = {
721 &RMF_MDS_HSM_REQUEST,
722 &RMF_MDS_HSM_USER_ITEM,
726 static const struct req_msg_field *obd_lfsck_request[] = {
731 static const struct req_msg_field *obd_lfsck_reply[] = {
736 static struct req_format *req_formats[] = {
743 &RQF_MGS_CONFIG_READ,
753 &RQF_MDS_GETATTR_NAME,
757 &RQF_MDS_INTENT_CLOSE,
760 &RQF_MDS_REINT_CREATE,
761 &RQF_MDS_REINT_CREATE_ACL,
762 &RQF_MDS_REINT_CREATE_SLAVE,
763 &RQF_MDS_REINT_CREATE_SYM,
765 &RQF_MDS_REINT_UNLINK,
767 &RQF_MDS_REINT_RENAME,
768 &RQF_MDS_REINT_MIGRATE,
769 &RQF_MDS_REINT_SETATTR,
770 &RQF_MDS_REINT_SETXATTR,
772 &RQF_MDS_HSM_PROGRESS,
773 &RQF_MDS_HSM_CT_REGISTER,
774 &RQF_MDS_HSM_CT_UNREGISTER,
775 &RQF_MDS_HSM_STATE_GET,
776 &RQF_MDS_HSM_STATE_SET,
778 &RQF_MDS_HSM_REQUEST,
779 &RQF_MDS_SWAP_LAYOUTS,
793 &RQF_OST_SET_GRANT_INFO,
795 &RQF_OST_GET_INFO_LAST_ID,
796 &RQF_OST_GET_INFO_LAST_FID,
797 &RQF_OST_SET_INFO_LAST_FID,
798 &RQF_OST_GET_INFO_FIEMAP,
801 &RQF_LDLM_ENQUEUE_LVB,
805 &RQF_LDLM_CP_CALLBACK,
806 &RQF_LDLM_BL_CALLBACK,
807 &RQF_LDLM_GL_CALLBACK,
808 &RQF_LDLM_GL_DESC_CALLBACK,
810 &RQF_LDLM_INTENT_BASIC,
811 &RQF_LDLM_INTENT_LAYOUT,
812 &RQF_LDLM_INTENT_GETATTR,
813 &RQF_LDLM_INTENT_OPEN,
814 &RQF_LDLM_INTENT_CREATE,
815 &RQF_LDLM_INTENT_UNLINK,
816 &RQF_LDLM_INTENT_GETXATTR,
817 &RQF_LDLM_INTENT_QUOTA,
820 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
821 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
822 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
823 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
824 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
825 &RQF_LLOG_ORIGIN_CONNECT,
831 struct req_msg_field {
832 const __u32 rmf_flags;
833 const char *rmf_name;
835 * Field length. (-1) means "variable length". If the
836 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
837 * but the actual size must be a whole multiple of \a rmf_size.
840 void (*rmf_swabber)(void *);
841 void (*rmf_dumper)(void *);
842 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
847 * The field is a string, must be NUL-terminated.
849 RMF_F_STRING = 1 << 0,
851 * The field's buffer size need not match the declared \a rmf_size.
853 RMF_F_NO_SIZE_CHECK = 1 << 1,
855 * The field's buffer size must be a whole multiple of the declared \a
856 * rmf_size and the \a rmf_swabber function must work on the declared \a
857 * rmf_size worth of bytes.
859 RMF_F_STRUCT_ARRAY = 1 << 2
867 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
868 .rmf_name = (name), \
869 .rmf_flags = (flags), \
870 .rmf_size = (size), \
871 .rmf_swabber = (void (*)(void*))(swabber), \
872 .rmf_dumper = (void (*)(void*))(dumper) \
875 struct req_msg_field RMF_GENERIC_DATA =
876 DEFINE_MSGF("generic_data", 0,
878 EXPORT_SYMBOL(RMF_GENERIC_DATA);
880 struct req_msg_field RMF_MGS_TARGET_INFO =
881 DEFINE_MSGF("mgs_target_info", 0,
882 sizeof(struct mgs_target_info),
883 lustre_swab_mgs_target_info, NULL);
884 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
886 struct req_msg_field RMF_MGS_SEND_PARAM =
887 DEFINE_MSGF("mgs_send_param", 0,
888 sizeof(struct mgs_send_param),
890 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
892 struct req_msg_field RMF_MGS_CONFIG_BODY =
893 DEFINE_MSGF("mgs_config_read request", 0,
894 sizeof(struct mgs_config_body),
895 lustre_swab_mgs_config_body, NULL);
896 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
898 struct req_msg_field RMF_MGS_CONFIG_RES =
899 DEFINE_MSGF("mgs_config_read reply ", 0,
900 sizeof(struct mgs_config_res),
901 lustre_swab_mgs_config_res, NULL);
902 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
904 struct req_msg_field RMF_U32 =
905 DEFINE_MSGF("generic u32", 0,
906 sizeof(__u32), lustre_swab_generic_32s, NULL);
907 EXPORT_SYMBOL(RMF_U32);
909 struct req_msg_field RMF_SETINFO_VAL =
910 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
911 EXPORT_SYMBOL(RMF_SETINFO_VAL);
913 struct req_msg_field RMF_GETINFO_KEY =
914 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
915 EXPORT_SYMBOL(RMF_GETINFO_KEY);
917 struct req_msg_field RMF_GETINFO_VALLEN =
918 DEFINE_MSGF("getinfo_vallen", 0,
919 sizeof(__u32), lustre_swab_generic_32s, NULL);
920 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
922 struct req_msg_field RMF_GETINFO_VAL =
923 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
924 EXPORT_SYMBOL(RMF_GETINFO_VAL);
926 struct req_msg_field RMF_SEQ_OPC =
927 DEFINE_MSGF("seq_query_opc", 0,
928 sizeof(__u32), lustre_swab_generic_32s, NULL);
929 EXPORT_SYMBOL(RMF_SEQ_OPC);
931 struct req_msg_field RMF_SEQ_RANGE =
932 DEFINE_MSGF("seq_query_range", 0,
933 sizeof(struct lu_seq_range),
934 lustre_swab_lu_seq_range, NULL);
935 EXPORT_SYMBOL(RMF_SEQ_RANGE);
937 struct req_msg_field RMF_FLD_OPC =
938 DEFINE_MSGF("fld_query_opc", 0,
939 sizeof(__u32), lustre_swab_generic_32s, NULL);
940 EXPORT_SYMBOL(RMF_FLD_OPC);
942 struct req_msg_field RMF_FLD_MDFLD =
943 DEFINE_MSGF("fld_query_mdfld", 0,
944 sizeof(struct lu_seq_range),
945 lustre_swab_lu_seq_range, NULL);
946 EXPORT_SYMBOL(RMF_FLD_MDFLD);
948 struct req_msg_field RMF_MDT_BODY =
949 DEFINE_MSGF("mdt_body", 0,
950 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
951 EXPORT_SYMBOL(RMF_MDT_BODY);
953 struct req_msg_field RMF_OBD_QUOTACTL =
954 DEFINE_MSGF("obd_quotactl", 0,
955 sizeof(struct obd_quotactl),
956 lustre_swab_obd_quotactl, NULL);
957 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
959 struct req_msg_field RMF_QUOTA_BODY =
960 DEFINE_MSGF("quota_body", 0,
961 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
962 EXPORT_SYMBOL(RMF_QUOTA_BODY);
964 struct req_msg_field RMF_MDT_EPOCH =
965 DEFINE_MSGF("mdt_ioepoch", 0,
966 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
967 EXPORT_SYMBOL(RMF_MDT_EPOCH);
969 struct req_msg_field RMF_PTLRPC_BODY =
970 DEFINE_MSGF("ptlrpc_body", 0,
971 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
972 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
974 struct req_msg_field RMF_CLOSE_DATA =
975 DEFINE_MSGF("data_version", 0,
976 sizeof(struct close_data), lustre_swab_close_data, NULL);
977 EXPORT_SYMBOL(RMF_CLOSE_DATA);
979 struct req_msg_field RMF_OBD_STATFS =
980 DEFINE_MSGF("obd_statfs", 0,
981 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
982 EXPORT_SYMBOL(RMF_OBD_STATFS);
984 struct req_msg_field RMF_SETINFO_KEY =
985 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
986 EXPORT_SYMBOL(RMF_SETINFO_KEY);
988 struct req_msg_field RMF_NAME =
989 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
990 EXPORT_SYMBOL(RMF_NAME);
992 struct req_msg_field RMF_SYMTGT =
993 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
994 EXPORT_SYMBOL(RMF_SYMTGT);
996 struct req_msg_field RMF_TGTUUID =
997 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
999 EXPORT_SYMBOL(RMF_TGTUUID);
1001 struct req_msg_field RMF_CLUUID =
1002 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1004 EXPORT_SYMBOL(RMF_CLUUID);
1006 struct req_msg_field RMF_STRING =
1007 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1008 EXPORT_SYMBOL(RMF_STRING);
1010 struct req_msg_field RMF_FILE_SECCTX_NAME =
1011 DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1012 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1014 struct req_msg_field RMF_FILE_SECCTX =
1015 DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1016 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1018 struct req_msg_field RMF_LLOGD_BODY =
1019 DEFINE_MSGF("llogd_body", 0,
1020 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1021 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1023 struct req_msg_field RMF_LLOG_LOG_HDR =
1024 DEFINE_MSGF("llog_log_hdr", 0,
1025 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1026 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1028 struct req_msg_field RMF_LLOGD_CONN_BODY =
1029 DEFINE_MSGF("llogd_conn_body", 0,
1030 sizeof(struct llogd_conn_body),
1031 lustre_swab_llogd_conn_body, NULL);
1032 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1035 * connection handle received in MDS_CONNECT request.
1037 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1038 * that the client does not interpret at all.
1040 struct req_msg_field RMF_CONN =
1041 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1042 EXPORT_SYMBOL(RMF_CONN);
1044 struct req_msg_field RMF_CONNECT_DATA =
1045 DEFINE_MSGF("cdata",
1046 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1047 sizeof(struct obd_connect_data),
1048 lustre_swab_connect, NULL);
1049 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1051 struct req_msg_field RMF_DLM_REQ =
1052 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1053 sizeof(struct ldlm_request),
1054 lustre_swab_ldlm_request, NULL);
1055 EXPORT_SYMBOL(RMF_DLM_REQ);
1057 struct req_msg_field RMF_DLM_REP =
1058 DEFINE_MSGF("dlm_rep", 0,
1059 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1060 EXPORT_SYMBOL(RMF_DLM_REP);
1062 struct req_msg_field RMF_LDLM_INTENT =
1063 DEFINE_MSGF("ldlm_intent", 0,
1064 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1065 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1067 struct req_msg_field RMF_DLM_LVB =
1068 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1069 EXPORT_SYMBOL(RMF_DLM_LVB);
1071 struct req_msg_field RMF_DLM_GL_DESC =
1072 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1073 lustre_swab_gl_desc, NULL);
1074 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1076 struct req_msg_field RMF_MDT_MD =
1077 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1078 EXPORT_SYMBOL(RMF_MDT_MD);
1080 struct req_msg_field RMF_REC_REINT =
1081 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1082 lustre_swab_mdt_rec_reint, NULL);
1083 EXPORT_SYMBOL(RMF_REC_REINT);
1085 /* FIXME: this length should be defined as a macro */
1086 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1088 EXPORT_SYMBOL(RMF_EADATA);
1090 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1091 EXPORT_SYMBOL(RMF_EAVALS);
1093 struct req_msg_field RMF_ACL =
1094 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1095 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1096 EXPORT_SYMBOL(RMF_ACL);
1098 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1099 struct req_msg_field RMF_LOGCOOKIES =
1100 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1101 sizeof(struct llog_cookie), NULL, NULL);
1102 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1104 struct req_msg_field RMF_CAPA1 =
1105 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1106 lustre_swab_lustre_capa, NULL);
1107 EXPORT_SYMBOL(RMF_CAPA1);
1109 struct req_msg_field RMF_CAPA2 =
1110 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1111 lustre_swab_lustre_capa, NULL);
1112 EXPORT_SYMBOL(RMF_CAPA2);
1114 struct req_msg_field RMF_LAYOUT_INTENT =
1115 DEFINE_MSGF("layout_intent", 0,
1116 sizeof(struct layout_intent), lustre_swab_layout_intent,
1118 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1121 * OST request field.
1123 struct req_msg_field RMF_OST_BODY =
1124 DEFINE_MSGF("ost_body", 0,
1125 sizeof(struct ost_body), lustre_swab_ost_body,
1127 EXPORT_SYMBOL(RMF_OST_BODY);
1129 struct req_msg_field RMF_OBD_IOOBJ =
1130 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1131 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1132 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1134 struct req_msg_field RMF_NIOBUF_REMOTE =
1135 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1136 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1138 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1140 struct req_msg_field RMF_RCS =
1141 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1142 lustre_swab_generic_32s, dump_rcs);
1143 EXPORT_SYMBOL(RMF_RCS);
1145 struct req_msg_field RMF_EAVALS_LENS =
1146 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1147 lustre_swab_generic_32s, NULL);
1148 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1150 struct req_msg_field RMF_OBD_ID =
1151 DEFINE_MSGF("obd_id", 0,
1152 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1153 EXPORT_SYMBOL(RMF_OBD_ID);
1155 struct req_msg_field RMF_FID =
1156 DEFINE_MSGF("fid", 0,
1157 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1158 EXPORT_SYMBOL(RMF_FID);
1160 struct req_msg_field RMF_OST_ID =
1161 DEFINE_MSGF("ost_id", 0,
1162 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1163 EXPORT_SYMBOL(RMF_OST_ID);
1165 struct req_msg_field RMF_FIEMAP_KEY =
1166 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1167 lustre_swab_fiemap, NULL);
1168 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1170 struct req_msg_field RMF_FIEMAP_VAL =
1171 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1172 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1174 struct req_msg_field RMF_IDX_INFO =
1175 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1176 lustre_swab_idx_info, NULL);
1177 EXPORT_SYMBOL(RMF_IDX_INFO);
1178 struct req_msg_field RMF_HSM_USER_STATE =
1179 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1180 lustre_swab_hsm_user_state, NULL);
1181 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1183 struct req_msg_field RMF_HSM_STATE_SET =
1184 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1185 lustre_swab_hsm_state_set, NULL);
1186 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1188 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1189 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1190 lustre_swab_hsm_progress_kernel, NULL);
1191 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1193 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1194 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1195 lustre_swab_hsm_current_action, NULL);
1196 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1198 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1199 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1200 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1202 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1204 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1205 DEFINE_MSGF("hsm_archive", 0,
1206 sizeof(__u32), lustre_swab_generic_32s, NULL);
1207 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1209 struct req_msg_field RMF_MDS_HSM_REQUEST =
1210 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1211 lustre_swab_hsm_request, NULL);
1212 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1214 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1215 lustre_swab_object_update_request, NULL);
1216 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1218 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1219 DEFINE_MSGF("object_update_reply", 0, -1,
1220 lustre_swab_object_update_reply, NULL);
1221 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1223 struct req_msg_field RMF_SWAP_LAYOUTS =
1224 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1225 lustre_swab_swap_layouts, NULL);
1226 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1228 struct req_msg_field RMF_LFSCK_REQUEST =
1229 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1230 lustre_swab_lfsck_request, NULL);
1231 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1233 struct req_msg_field RMF_LFSCK_REPLY =
1234 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1235 lustre_swab_lfsck_reply, NULL);
1236 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1238 struct req_msg_field RMF_OST_LADVISE_HDR =
1239 DEFINE_MSGF("ladvise_request", 0,
1240 sizeof(struct ladvise_hdr),
1241 lustre_swab_ladvise_hdr, NULL);
1242 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1244 struct req_msg_field RMF_OST_LADVISE =
1245 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1246 sizeof(struct lu_ladvise),
1247 lustre_swab_ladvise, NULL);
1248 EXPORT_SYMBOL(RMF_OST_LADVISE);
1250 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1251 -1, lustre_swab_out_update_header, NULL);
1252 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1254 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1255 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1256 lustre_swab_out_update_buffer, NULL);
1257 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1264 const char *rf_name;
1268 const struct req_msg_field **d;
1269 } rf_fields[RCL_NR];
1272 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1286 #define DEFINE_REQ_FMT0(name, client, server) \
1287 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1289 struct req_format RQF_OBD_PING =
1290 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1291 EXPORT_SYMBOL(RQF_OBD_PING);
1293 struct req_format RQF_OBD_SET_INFO =
1294 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1295 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1297 /* Read index file through the network */
1298 struct req_format RQF_OBD_IDX_READ =
1299 DEFINE_REQ_FMT0("OBD_IDX_READ",
1300 obd_idx_read_client, obd_idx_read_server);
1301 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1303 struct req_format RQF_SEC_CTX =
1304 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1305 EXPORT_SYMBOL(RQF_SEC_CTX);
1307 struct req_format RQF_MGS_TARGET_REG =
1308 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1309 mgs_target_info_only);
1310 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1312 struct req_format RQF_MGS_SET_INFO =
1313 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1315 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1317 struct req_format RQF_MGS_CONFIG_READ =
1318 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1319 mgs_config_read_server);
1320 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1322 struct req_format RQF_SEQ_QUERY =
1323 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1324 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1326 struct req_format RQF_FLD_QUERY =
1327 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1328 EXPORT_SYMBOL(RQF_FLD_QUERY);
1330 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1331 * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1332 * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1333 * peers need to handle the RPC reply with fixed little-endian format.
1335 * In theory, we can define new structure with some swabber registered to
1336 * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1337 * implementation view, it is not easy to be done within current "struct
1338 * req_msg_field" framework. Because the sequence range array in the RPC
1339 * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1340 * count, that is unknown when prepare the RPC buffer. Generally, for such
1341 * flexible length RPC usage, there will be a field in the RPC layout to
1342 * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1343 * do that unless we add new length filed that will broken the on-wire RPC
1344 * protocol and cause interoperability trouble with old peer. */
1345 struct req_format RQF_FLD_READ =
1346 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1347 EXPORT_SYMBOL(RQF_FLD_READ);
1349 struct req_format RQF_LOG_CANCEL =
1350 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1351 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1353 struct req_format RQF_MDS_QUOTACTL =
1354 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1355 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1357 struct req_format RQF_OST_QUOTACTL =
1358 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1359 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1361 struct req_format RQF_QUOTA_DQACQ =
1362 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1363 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1365 struct req_format RQF_LDLM_INTENT_QUOTA =
1366 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1367 ldlm_intent_quota_client,
1368 ldlm_intent_quota_server);
1369 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1371 struct req_format RQF_MDS_GET_ROOT =
1372 DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1373 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1375 struct req_format RQF_MDS_STATFS =
1376 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1377 EXPORT_SYMBOL(RQF_MDS_STATFS);
1379 struct req_format RQF_MDS_SYNC =
1380 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1381 EXPORT_SYMBOL(RQF_MDS_SYNC);
1383 struct req_format RQF_MDS_GETATTR =
1384 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1385 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1387 struct req_format RQF_MDS_GETXATTR =
1388 DEFINE_REQ_FMT0("MDS_GETXATTR",
1389 mds_getxattr_client, mds_getxattr_server);
1390 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1392 struct req_format RQF_MDS_GETATTR_NAME =
1393 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1394 mds_getattr_name_client, mds_getattr_server);
1395 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1397 struct req_format RQF_MDS_REINT =
1398 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1399 EXPORT_SYMBOL(RQF_MDS_REINT);
1401 struct req_format RQF_MDS_REINT_CREATE =
1402 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1403 mds_reint_create_client, mdt_body_capa);
1404 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1406 struct req_format RQF_MDS_REINT_CREATE_ACL =
1407 DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1408 mds_reint_create_acl_client, mdt_body_capa);
1409 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1411 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1412 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1413 mds_reint_create_slave_client, mdt_body_capa);
1414 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1416 struct req_format RQF_MDS_REINT_CREATE_SYM =
1417 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1418 mds_reint_create_sym_client, mdt_body_capa);
1419 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1421 struct req_format RQF_MDS_REINT_OPEN =
1422 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1423 mds_reint_open_client, mds_reint_open_server);
1424 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1426 struct req_format RQF_MDS_REINT_UNLINK =
1427 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1428 mds_last_unlink_server);
1429 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1431 struct req_format RQF_MDS_REINT_LINK =
1432 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1433 mds_reint_link_client, mdt_body_only);
1434 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1436 struct req_format RQF_MDS_REINT_RENAME =
1437 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1438 mds_last_unlink_server);
1439 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1441 struct req_format RQF_MDS_REINT_MIGRATE =
1442 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1443 mds_last_unlink_server);
1444 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1446 struct req_format RQF_MDS_REINT_SETATTR =
1447 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1448 mds_reint_setattr_client, mds_setattr_server);
1449 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1451 struct req_format RQF_MDS_REINT_SETXATTR =
1452 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1453 mds_reint_setxattr_client, mdt_body_only);
1454 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1456 struct req_format RQF_MDS_CONNECT =
1457 DEFINE_REQ_FMT0("MDS_CONNECT",
1458 obd_connect_client, obd_connect_server);
1459 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1461 struct req_format RQF_MDS_DISCONNECT =
1462 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1463 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1465 struct req_format RQF_MDS_GET_INFO =
1466 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1467 mds_getinfo_server);
1468 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1470 struct req_format RQF_OUT_UPDATE =
1471 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1473 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1475 struct req_format RQF_LDLM_ENQUEUE =
1476 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1477 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1478 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1480 struct req_format RQF_LDLM_ENQUEUE_LVB =
1481 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1482 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1483 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1485 struct req_format RQF_LDLM_CONVERT =
1486 DEFINE_REQ_FMT0("LDLM_CONVERT",
1487 ldlm_enqueue_client, ldlm_enqueue_server);
1488 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1490 struct req_format RQF_LDLM_CANCEL =
1491 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1492 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1494 struct req_format RQF_LDLM_CALLBACK =
1495 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1496 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1498 struct req_format RQF_LDLM_CP_CALLBACK =
1499 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1500 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1502 struct req_format RQF_LDLM_BL_CALLBACK =
1503 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1504 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1506 struct req_format RQF_LDLM_GL_CALLBACK =
1507 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1508 ldlm_gl_callback_server);
1509 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1511 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1512 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1513 ldlm_gl_callback_server);
1514 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1516 struct req_format RQF_LDLM_INTENT_BASIC =
1517 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1518 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1519 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1521 struct req_format RQF_LDLM_INTENT =
1522 DEFINE_REQ_FMT0("LDLM_INTENT",
1523 ldlm_intent_client, ldlm_intent_server);
1524 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1526 struct req_format RQF_LDLM_INTENT_LAYOUT =
1527 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1528 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1529 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1531 struct req_format RQF_LDLM_INTENT_GETATTR =
1532 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1533 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1534 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1536 struct req_format RQF_LDLM_INTENT_OPEN =
1537 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1538 ldlm_intent_open_client, ldlm_intent_open_server);
1539 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1541 struct req_format RQF_LDLM_INTENT_CREATE =
1542 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1543 ldlm_intent_create_client, ldlm_intent_getattr_server);
1544 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1546 struct req_format RQF_LDLM_INTENT_UNLINK =
1547 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1548 ldlm_intent_unlink_client, ldlm_intent_server);
1549 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1551 struct req_format RQF_LDLM_INTENT_GETXATTR =
1552 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1553 ldlm_intent_getxattr_client,
1554 ldlm_intent_getxattr_server);
1555 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1557 struct req_format RQF_MDS_CLOSE =
1558 DEFINE_REQ_FMT0("MDS_CLOSE",
1559 mdt_close_client, mds_last_unlink_server);
1560 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1562 struct req_format RQF_MDS_INTENT_CLOSE =
1563 DEFINE_REQ_FMT0("MDS_CLOSE",
1564 mdt_intent_close_client, mds_last_unlink_server);
1565 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1567 struct req_format RQF_MDS_READPAGE =
1568 DEFINE_REQ_FMT0("MDS_READPAGE",
1569 mdt_body_capa, mdt_body_only);
1570 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1572 struct req_format RQF_MDS_HSM_ACTION =
1573 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1574 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1576 struct req_format RQF_MDS_HSM_PROGRESS =
1577 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1578 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1580 struct req_format RQF_MDS_HSM_CT_REGISTER =
1581 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1582 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1584 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1585 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1586 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1588 struct req_format RQF_MDS_HSM_STATE_GET =
1589 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1590 mdt_body_capa, mdt_hsm_state_get_server);
1591 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1593 struct req_format RQF_MDS_HSM_STATE_SET =
1594 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1595 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1597 struct req_format RQF_MDS_HSM_REQUEST =
1598 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1599 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1601 struct req_format RQF_MDS_SWAP_LAYOUTS =
1602 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1603 mdt_swap_layouts, empty);
1604 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1606 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1607 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1608 llog_origin_handle_create_client, llogd_body_only);
1609 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1611 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1612 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1613 llogd_body_only, llogd_body_only);
1614 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1616 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1617 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1618 llogd_body_only, llog_origin_handle_next_block_server);
1619 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1621 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1622 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1623 llogd_body_only, llog_origin_handle_next_block_server);
1624 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1626 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1627 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1628 llogd_body_only, llog_log_hdr_only);
1629 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1631 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1632 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1633 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1635 struct req_format RQF_CONNECT =
1636 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1637 EXPORT_SYMBOL(RQF_CONNECT);
1639 struct req_format RQF_OST_CONNECT =
1640 DEFINE_REQ_FMT0("OST_CONNECT",
1641 obd_connect_client, obd_connect_server);
1642 EXPORT_SYMBOL(RQF_OST_CONNECT);
1644 struct req_format RQF_OST_DISCONNECT =
1645 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1646 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1648 struct req_format RQF_OST_GETATTR =
1649 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1650 EXPORT_SYMBOL(RQF_OST_GETATTR);
1652 struct req_format RQF_OST_SETATTR =
1653 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1654 EXPORT_SYMBOL(RQF_OST_SETATTR);
1656 struct req_format RQF_OST_CREATE =
1657 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1658 EXPORT_SYMBOL(RQF_OST_CREATE);
1660 struct req_format RQF_OST_PUNCH =
1661 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1662 EXPORT_SYMBOL(RQF_OST_PUNCH);
1664 struct req_format RQF_OST_SYNC =
1665 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1666 EXPORT_SYMBOL(RQF_OST_SYNC);
1668 struct req_format RQF_OST_DESTROY =
1669 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1670 EXPORT_SYMBOL(RQF_OST_DESTROY);
1672 struct req_format RQF_OST_BRW_READ =
1673 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1674 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1676 struct req_format RQF_OST_BRW_WRITE =
1677 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1678 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1680 struct req_format RQF_OST_STATFS =
1681 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1682 EXPORT_SYMBOL(RQF_OST_STATFS);
1684 struct req_format RQF_OST_SET_GRANT_INFO =
1685 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1687 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1689 struct req_format RQF_OST_GET_INFO =
1690 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1691 ost_get_info_generic_server);
1692 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1694 struct req_format RQF_OST_GET_INFO_LAST_ID =
1695 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1696 ost_get_last_id_server);
1697 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1699 struct req_format RQF_OST_GET_INFO_LAST_FID =
1700 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1701 ost_get_last_fid_server);
1702 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1704 struct req_format RQF_OST_SET_INFO_LAST_FID =
1705 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1707 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1709 struct req_format RQF_OST_GET_INFO_FIEMAP =
1710 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1711 ost_get_fiemap_server);
1712 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1714 struct req_format RQF_LFSCK_NOTIFY =
1715 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1716 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1718 struct req_format RQF_LFSCK_QUERY =
1719 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1720 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1722 struct req_format RQF_OST_LADVISE =
1723 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1724 EXPORT_SYMBOL(RQF_OST_LADVISE);
1726 #if !defined(__REQ_LAYOUT_USER__)
1728 /* Convenience macro */
1729 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1732 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1733 * field of RQFs and the \a rmf_offset field of RMFs.
1735 int req_layout_init(void)
1740 struct req_format *rf = NULL;
1742 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1743 rf = req_formats[i];
1745 for (j = 0; j < RCL_NR; ++j) {
1746 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1747 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1748 struct req_msg_field *field;
1750 field = (typeof(field))rf->rf_fields[j].d[k];
1751 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1752 || field->rmf_size > 0);
1753 LASSERT(field->rmf_offset[i][j] == 0);
1755 * k + 1 to detect unused format/field
1758 field->rmf_offset[i][j] = k + 1;
1764 EXPORT_SYMBOL(req_layout_init);
1766 void req_layout_fini(void)
1769 EXPORT_SYMBOL(req_layout_fini);
1772 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1774 * Actual/expected field sizes are set elsewhere in functions in this file:
1775 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1776 * req_capsule_msg_size(). The \a rc_area information is used by.
1777 * ptlrpc_request_set_replen().
1779 void req_capsule_init_area(struct req_capsule *pill)
1783 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1784 pill->rc_area[RCL_CLIENT][i] = -1;
1785 pill->rc_area[RCL_SERVER][i] = -1;
1788 EXPORT_SYMBOL(req_capsule_init_area);
1791 * Initialize a pill.
1793 * The \a location indicates whether the caller is executing on the client side
1794 * (RCL_CLIENT) or server side (RCL_SERVER)..
1796 void req_capsule_init(struct req_capsule *pill,
1797 struct ptlrpc_request *req,
1798 enum req_location location)
1800 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1803 * Today all capsules are embedded in ptlrpc_request structs,
1804 * but just in case that ever isn't the case, we don't reach
1805 * into req unless req != NULL and pill is the one embedded in
1808 * The req->rq_pill_init flag makes it safe to initialize a pill
1809 * twice, which might happen in the OST paths as a result of the
1810 * high-priority RPC queue getting peeked at before ost_handle()
1811 * handles an OST RPC.
1813 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1816 memset(pill, 0, sizeof *pill);
1818 pill->rc_loc = location;
1819 req_capsule_init_area(pill);
1821 if (req != NULL && pill == &req->rq_pill)
1822 req->rq_pill_init = 1;
1824 EXPORT_SYMBOL(req_capsule_init);
1826 void req_capsule_fini(struct req_capsule *pill)
1829 EXPORT_SYMBOL(req_capsule_fini);
1831 static int __req_format_is_sane(const struct req_format *fmt)
1833 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1834 req_formats[fmt->rf_idx] == fmt;
1837 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1838 enum req_location loc)
1840 struct ptlrpc_request *req;
1843 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1847 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1848 * (see req_capsule_extend()).
1850 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1852 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1853 LASSERT(__req_format_is_sane(fmt));
1857 EXPORT_SYMBOL(req_capsule_set);
1860 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1863 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1864 * variable-sized fields. The field sizes come from the declared \a rmf_size
1865 * field of a \a pill's \a rc_fmt's RMF's.
1867 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1868 enum req_location loc)
1870 const struct req_format *fmt = pill->rc_fmt;
1873 LASSERT(fmt != NULL);
1875 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1876 if (pill->rc_area[loc][i] == -1) {
1877 pill->rc_area[loc][i] =
1878 fmt->rf_fields[loc].d[i]->rmf_size;
1879 if (pill->rc_area[loc][i] == -1) {
1881 * Skip the following fields.
1883 * If this LASSERT() trips then you're missing a
1884 * call to req_capsule_set_size().
1886 LASSERT(loc != RCL_SERVER);
1893 EXPORT_SYMBOL(req_capsule_filled_sizes);
1896 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1898 * This function uses the \a pill's \a rc_area as filled in by
1899 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1902 int req_capsule_server_pack(struct req_capsule *pill)
1904 const struct req_format *fmt;
1908 LASSERT(pill->rc_loc == RCL_SERVER);
1910 LASSERT(fmt != NULL);
1912 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1913 rc = lustre_pack_reply(pill->rc_req, count,
1914 pill->rc_area[RCL_SERVER], NULL);
1916 DEBUG_REQ(D_ERROR, pill->rc_req,
1917 "Cannot pack %d fields in format `%s': ",
1918 count, fmt->rf_name);
1922 EXPORT_SYMBOL(req_capsule_server_pack);
1925 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1926 * corresponding to the given RMF (\a field).
1928 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1929 const struct req_msg_field *field,
1930 enum req_location loc)
1934 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1935 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1936 pill->rc_fmt->rf_name,
1937 field->rmf_name, offset, loc);
1940 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1945 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1950 swabber_dumper_helper(struct req_capsule *pill,
1951 const struct req_msg_field *field,
1952 enum req_location loc,
1954 void *value, int len, int dump, void (*swabber)( void *))
1960 int inout = loc == RCL_CLIENT;
1962 swabber = swabber ?: field->rmf_swabber;
1964 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1965 swabber != NULL && value != NULL)
1970 if (!field->rmf_dumper)
1973 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1975 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1976 do_swab ? "unswabbed " : "", field->rmf_name);
1977 field->rmf_dumper(value);
1982 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1984 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1985 "follows\n", field->rmf_name);
1986 field->rmf_dumper(value);
1993 * We're swabbing an array; swabber() swabs a single array element, so
1994 * swab every element.
1996 LASSERT((len % field->rmf_size) == 0);
1997 for (p = value, i = 0, n = len / field->rmf_size;
1999 i++, p += field->rmf_size) {
2001 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2002 "element %d follows\n",
2003 do_swab ? "unswabbed " : "", field->rmf_name, i);
2004 field->rmf_dumper(p);
2010 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2011 "element %d follows\n", field->rmf_name, i);
2012 field->rmf_dumper(value);
2016 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2020 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2021 * corresponding to the given RMF (\a field).
2023 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
2024 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
2025 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2026 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2027 * element of the array swabbed.
2029 static void *__req_capsule_get(struct req_capsule *pill,
2030 const struct req_msg_field *field,
2031 enum req_location loc,
2032 void (*swabber)( void *),
2035 const struct req_format *fmt;
2036 struct lustre_msg *msg;
2041 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2043 static const char *rcl_names[RCL_NR] = {
2044 [RCL_CLIENT] = "client",
2045 [RCL_SERVER] = "server"
2048 LASSERT(pill != NULL);
2049 LASSERT(pill != LP_POISON);
2051 LASSERT(fmt != NULL);
2052 LASSERT(fmt != LP_POISON);
2053 LASSERT(__req_format_is_sane(fmt));
2055 offset = __req_capsule_offset(pill, field, loc);
2057 msg = __req_msg(pill, loc);
2058 LASSERT(msg != NULL);
2060 getter = (field->rmf_flags & RMF_F_STRING) ?
2061 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2063 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2065 * We've already asserted that field->rmf_size > 0 in
2066 * req_layout_init().
2068 len = lustre_msg_buflen(msg, offset);
2069 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2070 (len % field->rmf_size) != 0) {
2071 CERROR("%s: array field size mismatch "
2072 "%d modulo %u != 0 (%d)\n",
2073 field->rmf_name, len, field->rmf_size, loc);
2076 } else if (pill->rc_area[loc][offset] != -1) {
2077 len = pill->rc_area[loc][offset];
2079 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2081 value = getter(msg, offset, len);
2083 if (value == NULL) {
2084 DEBUG_REQ(D_ERROR, pill->rc_req,
2085 "Wrong buffer for field `%s' (%u of %u) "
2086 "in format `%s': %u vs. %u (%s)\n",
2087 field->rmf_name, offset, lustre_msg_bufcount(msg),
2088 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2091 swabber_dumper_helper(pill, field, loc, offset, value, len,
2099 * Dump a request and/or reply
2101 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2103 const struct req_format *fmt;
2104 const struct req_msg_field *field;
2110 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2111 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2112 field = FMT_FIELD(fmt, loc, i);
2113 if (field->rmf_dumper == NULL) {
2115 * FIXME Add a default hex dumper for fields that don't
2116 * have a specific dumper
2118 len = req_capsule_get_size(pill, field, loc);
2119 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2120 "field size is %u\n", field->rmf_name, len);
2122 /* It's the dumping side-effect that we're interested in */
2123 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2126 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2132 void req_capsule_client_dump(struct req_capsule *pill)
2134 __req_capsule_dump(pill, RCL_CLIENT);
2136 EXPORT_SYMBOL(req_capsule_client_dump);
2141 void req_capsule_server_dump(struct req_capsule *pill)
2143 __req_capsule_dump(pill, RCL_SERVER);
2145 EXPORT_SYMBOL(req_capsule_server_dump);
2148 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2149 * buffer corresponding to the given RMF (\a field) of a \a pill.
2151 void *req_capsule_client_get(struct req_capsule *pill,
2152 const struct req_msg_field *field)
2154 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2156 EXPORT_SYMBOL(req_capsule_client_get);
2159 * Same as req_capsule_client_get(), but with a \a swabber argument.
2161 * Currently unused; will be removed when req_capsule_server_swab_get() is
2164 void *req_capsule_client_swab_get(struct req_capsule *pill,
2165 const struct req_msg_field *field,
2168 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2170 EXPORT_SYMBOL(req_capsule_client_swab_get);
2173 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2175 * First the \a pill's request \a field's size is set (\a rc_area) using
2176 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2179 void *req_capsule_client_sized_get(struct req_capsule *pill,
2180 const struct req_msg_field *field,
2183 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2184 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2186 EXPORT_SYMBOL(req_capsule_client_sized_get);
2189 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2190 * buffer corresponding to the given RMF (\a field) of a \a pill.
2192 void *req_capsule_server_get(struct req_capsule *pill,
2193 const struct req_msg_field *field)
2195 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2197 EXPORT_SYMBOL(req_capsule_server_get);
2200 * Same as req_capsule_server_get(), but with a \a swabber argument.
2202 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2203 * swabbing done outside this capsule abstraction.
2205 void *req_capsule_server_swab_get(struct req_capsule *pill,
2206 const struct req_msg_field *field,
2209 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2211 EXPORT_SYMBOL(req_capsule_server_swab_get);
2214 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2216 * First the \a pill's request \a field's size is set (\a rc_area) using
2217 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2220 void *req_capsule_server_sized_get(struct req_capsule *pill,
2221 const struct req_msg_field *field,
2224 req_capsule_set_size(pill, field, RCL_SERVER, len);
2225 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2227 EXPORT_SYMBOL(req_capsule_server_sized_get);
2229 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2230 const struct req_msg_field *field,
2231 __u32 len, void *swabber)
2233 req_capsule_set_size(pill, field, RCL_SERVER, len);
2234 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2236 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2239 * Returns the buffer of a \a pill corresponding to the given \a field from the
2240 * request (if the caller is executing on the server-side) or reply (if the
2241 * caller is executing on the client-side).
2243 * This function convienient for use is code that could be executed on the
2244 * client and server alike.
2246 const void *req_capsule_other_get(struct req_capsule *pill,
2247 const struct req_msg_field *field)
2249 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2251 EXPORT_SYMBOL(req_capsule_other_get);
2254 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2255 * field of the given \a pill.
2257 * This function must be used when constructing variable sized fields of a
2260 void req_capsule_set_size(struct req_capsule *pill,
2261 const struct req_msg_field *field,
2262 enum req_location loc, __u32 size)
2264 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2266 if ((size != (__u32)field->rmf_size) &&
2267 (field->rmf_size != -1) &&
2268 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2270 __u32 rmf_size = (__u32)field->rmf_size;
2271 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2272 (size % rmf_size != 0)) {
2273 CERROR("%s: array field size mismatch "
2274 "%u %% %u != 0 (%d)\n",
2275 field->rmf_name, size, rmf_size, loc);
2277 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2279 CERROR("%s: field size mismatch %u != %u (%d)\n",
2280 field->rmf_name, size, rmf_size, loc);
2285 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2287 EXPORT_SYMBOL(req_capsule_set_size);
2290 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2291 * for the given \a pill's given \a field.
2293 * NB: this function doesn't correspond with req_capsule_set_size(), which
2294 * actually sets the size in pill.rc_area[loc][offset], but this function
2295 * returns the message buflen[offset], maybe we should use another name.
2297 __u32 req_capsule_get_size(const struct req_capsule *pill,
2298 const struct req_msg_field *field,
2299 enum req_location loc)
2301 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2303 return lustre_msg_buflen(__req_msg(pill, loc),
2304 __req_capsule_offset(pill, field, loc));
2306 EXPORT_SYMBOL(req_capsule_get_size);
2309 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2310 * given \a pill's request or reply (\a loc) given the field size recorded in
2311 * the \a pill's rc_area.
2313 * See also req_capsule_set_size().
2315 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2317 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2318 pill->rc_fmt->rf_fields[loc].nr,
2319 pill->rc_area[loc]);
2323 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2324 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2325 * PTLRPC request or reply given only an RQF (\a fmt).
2327 * This function should not be used for formats which contain variable size
2330 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2331 enum req_location loc)
2337 * This function should probably LASSERT() that fmt has no fields with
2338 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2339 * elements in the array there will ultimately be, but then, we could
2340 * assume that there will be at least one element, and that's just what
2343 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2347 for (; i < fmt->rf_fields[loc].nr; ++i)
2348 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2349 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2355 * Changes the format of an RPC.
2357 * The pill must already have been initialized, which means that it already has
2358 * a request format. The new format \a fmt must be an extension of the pill's
2359 * old format. Specifically: the new format must have as many request and reply
2360 * fields as the old one, and all fields shared by the old and new format must
2361 * be at least as large in the new format.
2363 * The new format's fields may be of different "type" than the old format, but
2364 * only for fields that are "opaque" blobs: fields which have a) have no
2365 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2366 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2367 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2368 * according to the key field. When the value, according to the key, contains a
2369 * structure (or array thereof) to be swabbed, the format should be changed to
2370 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2373 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2378 const struct req_format *old;
2380 LASSERT(pill->rc_fmt != NULL);
2381 LASSERT(__req_format_is_sane(fmt));
2385 * Sanity checking...
2387 for (i = 0; i < RCL_NR; ++i) {
2388 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2389 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2390 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2392 /* "opaque" fields can be transmogrified */
2393 if (ofield->rmf_swabber == NULL &&
2394 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2395 (ofield->rmf_size == -1 ||
2396 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2398 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2401 * Last field in old format can be shorter than in new.
2403 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2404 FMT_FIELD(old, i, j)->rmf_size);
2409 EXPORT_SYMBOL(req_capsule_extend);
2412 * This function returns a non-zero value if the given \a field is present in
2413 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2416 int req_capsule_has_field(const struct req_capsule *pill,
2417 const struct req_msg_field *field,
2418 enum req_location loc)
2420 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2422 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2424 EXPORT_SYMBOL(req_capsule_has_field);
2427 * Returns a non-zero value if the given \a field is present in the given \a
2428 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2430 int req_capsule_field_present(const struct req_capsule *pill,
2431 const struct req_msg_field *field,
2432 enum req_location loc)
2436 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2437 LASSERT(req_capsule_has_field(pill, field, loc));
2439 offset = __req_capsule_offset(pill, field, loc);
2440 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2442 EXPORT_SYMBOL(req_capsule_field_present);
2445 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2446 * request or reply (\a loc).
2448 * This is not the opposite of req_capsule_extend().
2450 void req_capsule_shrink(struct req_capsule *pill,
2451 const struct req_msg_field *field,
2453 enum req_location loc)
2455 const struct req_format *fmt;
2456 struct lustre_msg *msg;
2461 LASSERT(fmt != NULL);
2462 LASSERT(__req_format_is_sane(fmt));
2463 LASSERT(req_capsule_has_field(pill, field, loc));
2464 LASSERT(req_capsule_field_present(pill, field, loc));
2466 offset = __req_capsule_offset(pill, field, loc);
2468 msg = __req_msg(pill, loc);
2469 len = lustre_msg_buflen(msg, offset);
2470 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2471 fmt->rf_name, field->rmf_name, len, newlen);
2473 if (loc == RCL_CLIENT)
2474 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2477 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2480 EXPORT_SYMBOL(req_capsule_shrink);
2482 int req_capsule_server_grow(struct req_capsule *pill,
2483 const struct req_msg_field *field,
2486 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2491 LASSERT(pill->rc_fmt != NULL);
2492 LASSERT(__req_format_is_sane(pill->rc_fmt));
2493 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2494 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2496 len = req_capsule_get_size(pill, field, RCL_SERVER);
2497 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2498 if ((__u32)pill->rc_req->rq_repbuf_len >=
2499 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2500 CERROR("Inplace repack might be done\n");
2502 pill->rc_req->rq_reply_state = NULL;
2503 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2504 rc = req_capsule_server_pack(pill);
2506 /* put old rs back, the caller will decide what to do */
2507 pill->rc_req->rq_reply_state = rs;
2510 nrs = pill->rc_req->rq_reply_state;
2511 /* Now we need only buffers, copy first chunk */
2512 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2513 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2514 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2515 memcpy(to, from, len);
2516 /* check if we have tail and copy it too */
2517 if (rs->rs_msg->lm_bufcount > offset + 1) {
2518 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2519 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2520 offset = rs->rs_msg->lm_bufcount - 1;
2521 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2522 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2523 memcpy(to, from, len);
2525 /* drop old reply if everything is fine */
2526 if (rs->rs_difficult) {
2530 nrs->rs_difficult = 1;
2531 nrs->rs_no_ack = rs->rs_no_ack;
2532 for (i = 0; i < rs->rs_nlocks; i++) {
2533 nrs->rs_locks[i] = rs->rs_locks[i];
2534 nrs->rs_modes[i] = rs->rs_modes[i];
2538 rs->rs_difficult = 0;
2541 ptlrpc_rs_decref(rs);
2544 EXPORT_SYMBOL(req_capsule_server_grow);
2545 /* __REQ_LAYOUT_USER__ */