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_rmt_acl_client[] = {
227 static const struct req_msg_field *mds_reint_create_sym_client[] = {
236 static const struct req_msg_field *mds_reint_open_client[] = {
245 static const struct req_msg_field *mds_reint_open_server[] = {
254 static const struct req_msg_field *mds_reint_unlink_client[] = {
262 static const struct req_msg_field *mds_reint_link_client[] = {
271 static const struct req_msg_field *mds_reint_rename_client[] = {
281 static const struct req_msg_field *mds_reint_migrate_client[] = {
293 static const struct req_msg_field *mds_last_unlink_server[] = {
302 static const struct req_msg_field *mds_reint_setattr_client[] = {
312 static const struct req_msg_field *mds_reint_setxattr_client[] = {
321 static const struct req_msg_field *mdt_swap_layouts[] = {
330 static const struct req_msg_field *obd_connect_client[] = {
338 static const struct req_msg_field *obd_connect_server[] = {
343 static const struct req_msg_field *obd_set_info_client[] = {
349 static const struct req_msg_field *ost_grant_shrink_client[] = {
355 static const struct req_msg_field *mds_getinfo_client[] = {
361 static const struct req_msg_field *mds_getinfo_server[] = {
366 static const struct req_msg_field *ldlm_enqueue_client[] = {
371 static const struct req_msg_field *ldlm_enqueue_server[] = {
376 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
382 static const struct req_msg_field *ldlm_cp_callback_client[] = {
388 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
394 static const struct req_msg_field *ldlm_gl_callback_server[] = {
399 static const struct req_msg_field *ldlm_intent_basic_client[] = {
405 static const struct req_msg_field *ldlm_intent_client[] = {
412 static const struct req_msg_field *ldlm_intent_server[] = {
420 static const struct req_msg_field *ldlm_intent_layout_client[] = {
425 &RMF_EADATA /* for new layout to be set up */
427 static const struct req_msg_field *ldlm_intent_open_server[] = {
437 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
441 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
446 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
455 static const struct req_msg_field *ldlm_intent_create_client[] = {
459 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
465 static const struct req_msg_field *ldlm_intent_open_client[] = {
469 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
476 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
480 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
485 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
493 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
498 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
504 static const struct req_msg_field *mds_getxattr_client[] = {
512 static const struct req_msg_field *mds_getxattr_server[] = {
518 static const struct req_msg_field *mds_getattr_server[] = {
527 static const struct req_msg_field *mds_setattr_server[] = {
536 static const struct req_msg_field *mds_update_client[] = {
538 &RMF_OUT_UPDATE_HEADER,
542 static const struct req_msg_field *mds_update_server[] = {
544 &RMF_OUT_UPDATE_REPLY,
547 static const struct req_msg_field *llog_origin_handle_create_client[] = {
553 static const struct req_msg_field *llogd_body_only[] = {
558 static const struct req_msg_field *llog_log_hdr_only[] = {
563 static const struct req_msg_field *llogd_conn_body_only[] = {
568 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
574 static const struct req_msg_field *obd_idx_read_client[] = {
579 static const struct req_msg_field *obd_idx_read_server[] = {
584 static const struct req_msg_field *ost_body_only[] = {
589 static const struct req_msg_field *ost_body_capa[] = {
595 static const struct req_msg_field *ost_destroy_client[] = {
603 static const struct req_msg_field *ost_brw_client[] = {
611 static const struct req_msg_field *ost_brw_read_server[] = {
616 static const struct req_msg_field *ost_brw_write_server[] = {
622 static const struct req_msg_field *ost_get_info_generic_server[] = {
627 static const struct req_msg_field *ost_get_info_generic_client[] = {
632 static const struct req_msg_field *ost_get_last_id_server[] = {
637 static const struct req_msg_field *ost_get_last_fid_client[] = {
643 static const struct req_msg_field *ost_get_last_fid_server[] = {
648 static const struct req_msg_field *ost_get_fiemap_client[] = {
654 static const struct req_msg_field *ost_ladvise[] = {
657 &RMF_OST_LADVISE_HDR,
661 static const struct req_msg_field *ost_get_fiemap_server[] = {
666 static const struct req_msg_field *mdt_hsm_progress[] = {
669 &RMF_MDS_HSM_PROGRESS,
672 static const struct req_msg_field *mdt_hsm_ct_register[] = {
675 &RMF_MDS_HSM_ARCHIVE,
678 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
683 static const struct req_msg_field *mdt_hsm_action_server[] = {
686 &RMF_MDS_HSM_CURRENT_ACTION,
689 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
695 static const struct req_msg_field *mdt_hsm_state_set[] = {
702 static const struct req_msg_field *mdt_hsm_request[] = {
705 &RMF_MDS_HSM_REQUEST,
706 &RMF_MDS_HSM_USER_ITEM,
710 static const struct req_msg_field *obd_lfsck_request[] = {
715 static const struct req_msg_field *obd_lfsck_reply[] = {
720 static struct req_format *req_formats[] = {
727 &RQF_MGS_CONFIG_READ,
737 &RQF_MDS_GETATTR_NAME,
741 &RQF_MDS_INTENT_CLOSE,
744 &RQF_MDS_REINT_CREATE,
745 &RQF_MDS_REINT_CREATE_RMT_ACL,
746 &RQF_MDS_REINT_CREATE_SLAVE,
747 &RQF_MDS_REINT_CREATE_SYM,
749 &RQF_MDS_REINT_UNLINK,
751 &RQF_MDS_REINT_RENAME,
752 &RQF_MDS_REINT_MIGRATE,
753 &RQF_MDS_REINT_SETATTR,
754 &RQF_MDS_REINT_SETXATTR,
756 &RQF_MDS_HSM_PROGRESS,
757 &RQF_MDS_HSM_CT_REGISTER,
758 &RQF_MDS_HSM_CT_UNREGISTER,
759 &RQF_MDS_HSM_STATE_GET,
760 &RQF_MDS_HSM_STATE_SET,
762 &RQF_MDS_HSM_REQUEST,
763 &RQF_MDS_SWAP_LAYOUTS,
777 &RQF_OST_SET_GRANT_INFO,
779 &RQF_OST_GET_INFO_LAST_ID,
780 &RQF_OST_GET_INFO_LAST_FID,
781 &RQF_OST_SET_INFO_LAST_FID,
782 &RQF_OST_GET_INFO_FIEMAP,
785 &RQF_LDLM_ENQUEUE_LVB,
789 &RQF_LDLM_CP_CALLBACK,
790 &RQF_LDLM_BL_CALLBACK,
791 &RQF_LDLM_GL_CALLBACK,
792 &RQF_LDLM_GL_DESC_CALLBACK,
794 &RQF_LDLM_INTENT_BASIC,
795 &RQF_LDLM_INTENT_LAYOUT,
796 &RQF_LDLM_INTENT_GETATTR,
797 &RQF_LDLM_INTENT_OPEN,
798 &RQF_LDLM_INTENT_CREATE,
799 &RQF_LDLM_INTENT_UNLINK,
800 &RQF_LDLM_INTENT_GETXATTR,
801 &RQF_LDLM_INTENT_QUOTA,
804 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
805 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
806 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
807 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
808 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
809 &RQF_LLOG_ORIGIN_CONNECT,
815 struct req_msg_field {
816 const __u32 rmf_flags;
817 const char *rmf_name;
819 * Field length. (-1) means "variable length". If the
820 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
821 * but the actual size must be a whole multiple of \a rmf_size.
824 void (*rmf_swabber)(void *);
825 void (*rmf_dumper)(void *);
826 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
831 * The field is a string, must be NUL-terminated.
833 RMF_F_STRING = 1 << 0,
835 * The field's buffer size need not match the declared \a rmf_size.
837 RMF_F_NO_SIZE_CHECK = 1 << 1,
839 * The field's buffer size must be a whole multiple of the declared \a
840 * rmf_size and the \a rmf_swabber function must work on the declared \a
841 * rmf_size worth of bytes.
843 RMF_F_STRUCT_ARRAY = 1 << 2
851 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
852 .rmf_name = (name), \
853 .rmf_flags = (flags), \
854 .rmf_size = (size), \
855 .rmf_swabber = (void (*)(void*))(swabber), \
856 .rmf_dumper = (void (*)(void*))(dumper) \
859 struct req_msg_field RMF_GENERIC_DATA =
860 DEFINE_MSGF("generic_data", 0,
862 EXPORT_SYMBOL(RMF_GENERIC_DATA);
864 struct req_msg_field RMF_MGS_TARGET_INFO =
865 DEFINE_MSGF("mgs_target_info", 0,
866 sizeof(struct mgs_target_info),
867 lustre_swab_mgs_target_info, NULL);
868 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
870 struct req_msg_field RMF_MGS_SEND_PARAM =
871 DEFINE_MSGF("mgs_send_param", 0,
872 sizeof(struct mgs_send_param),
874 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
876 struct req_msg_field RMF_MGS_CONFIG_BODY =
877 DEFINE_MSGF("mgs_config_read request", 0,
878 sizeof(struct mgs_config_body),
879 lustre_swab_mgs_config_body, NULL);
880 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
882 struct req_msg_field RMF_MGS_CONFIG_RES =
883 DEFINE_MSGF("mgs_config_read reply ", 0,
884 sizeof(struct mgs_config_res),
885 lustre_swab_mgs_config_res, NULL);
886 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
888 struct req_msg_field RMF_U32 =
889 DEFINE_MSGF("generic u32", 0,
890 sizeof(__u32), lustre_swab_generic_32s, NULL);
891 EXPORT_SYMBOL(RMF_U32);
893 struct req_msg_field RMF_SETINFO_VAL =
894 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
895 EXPORT_SYMBOL(RMF_SETINFO_VAL);
897 struct req_msg_field RMF_GETINFO_KEY =
898 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
899 EXPORT_SYMBOL(RMF_GETINFO_KEY);
901 struct req_msg_field RMF_GETINFO_VALLEN =
902 DEFINE_MSGF("getinfo_vallen", 0,
903 sizeof(__u32), lustre_swab_generic_32s, NULL);
904 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
906 struct req_msg_field RMF_GETINFO_VAL =
907 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
908 EXPORT_SYMBOL(RMF_GETINFO_VAL);
910 struct req_msg_field RMF_SEQ_OPC =
911 DEFINE_MSGF("seq_query_opc", 0,
912 sizeof(__u32), lustre_swab_generic_32s, NULL);
913 EXPORT_SYMBOL(RMF_SEQ_OPC);
915 struct req_msg_field RMF_SEQ_RANGE =
916 DEFINE_MSGF("seq_query_range", 0,
917 sizeof(struct lu_seq_range),
918 lustre_swab_lu_seq_range, NULL);
919 EXPORT_SYMBOL(RMF_SEQ_RANGE);
921 struct req_msg_field RMF_FLD_OPC =
922 DEFINE_MSGF("fld_query_opc", 0,
923 sizeof(__u32), lustre_swab_generic_32s, NULL);
924 EXPORT_SYMBOL(RMF_FLD_OPC);
926 struct req_msg_field RMF_FLD_MDFLD =
927 DEFINE_MSGF("fld_query_mdfld", 0,
928 sizeof(struct lu_seq_range),
929 lustre_swab_lu_seq_range, NULL);
930 EXPORT_SYMBOL(RMF_FLD_MDFLD);
932 struct req_msg_field RMF_MDT_BODY =
933 DEFINE_MSGF("mdt_body", 0,
934 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
935 EXPORT_SYMBOL(RMF_MDT_BODY);
937 struct req_msg_field RMF_OBD_QUOTACTL =
938 DEFINE_MSGF("obd_quotactl", 0,
939 sizeof(struct obd_quotactl),
940 lustre_swab_obd_quotactl, NULL);
941 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
943 struct req_msg_field RMF_QUOTA_BODY =
944 DEFINE_MSGF("quota_body", 0,
945 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
946 EXPORT_SYMBOL(RMF_QUOTA_BODY);
948 struct req_msg_field RMF_MDT_EPOCH =
949 DEFINE_MSGF("mdt_ioepoch", 0,
950 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
951 EXPORT_SYMBOL(RMF_MDT_EPOCH);
953 struct req_msg_field RMF_PTLRPC_BODY =
954 DEFINE_MSGF("ptlrpc_body", 0,
955 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
956 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
958 struct req_msg_field RMF_CLOSE_DATA =
959 DEFINE_MSGF("data_version", 0,
960 sizeof(struct close_data), lustre_swab_close_data, NULL);
961 EXPORT_SYMBOL(RMF_CLOSE_DATA);
963 struct req_msg_field RMF_OBD_STATFS =
964 DEFINE_MSGF("obd_statfs", 0,
965 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
966 EXPORT_SYMBOL(RMF_OBD_STATFS);
968 struct req_msg_field RMF_SETINFO_KEY =
969 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
970 EXPORT_SYMBOL(RMF_SETINFO_KEY);
972 struct req_msg_field RMF_NAME =
973 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
974 EXPORT_SYMBOL(RMF_NAME);
976 struct req_msg_field RMF_SYMTGT =
977 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
978 EXPORT_SYMBOL(RMF_SYMTGT);
980 struct req_msg_field RMF_TGTUUID =
981 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
983 EXPORT_SYMBOL(RMF_TGTUUID);
985 struct req_msg_field RMF_CLUUID =
986 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
988 EXPORT_SYMBOL(RMF_CLUUID);
990 struct req_msg_field RMF_STRING =
991 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
992 EXPORT_SYMBOL(RMF_STRING);
994 struct req_msg_field RMF_LLOGD_BODY =
995 DEFINE_MSGF("llogd_body", 0,
996 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
997 EXPORT_SYMBOL(RMF_LLOGD_BODY);
999 struct req_msg_field RMF_LLOG_LOG_HDR =
1000 DEFINE_MSGF("llog_log_hdr", 0,
1001 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1002 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1004 struct req_msg_field RMF_LLOGD_CONN_BODY =
1005 DEFINE_MSGF("llogd_conn_body", 0,
1006 sizeof(struct llogd_conn_body),
1007 lustre_swab_llogd_conn_body, NULL);
1008 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1011 * connection handle received in MDS_CONNECT request.
1013 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1014 * that the client does not interpret at all.
1016 struct req_msg_field RMF_CONN =
1017 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1018 EXPORT_SYMBOL(RMF_CONN);
1020 struct req_msg_field RMF_CONNECT_DATA =
1021 DEFINE_MSGF("cdata",
1022 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1023 sizeof(struct obd_connect_data),
1024 lustre_swab_connect, NULL);
1025 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1027 struct req_msg_field RMF_DLM_REQ =
1028 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1029 sizeof(struct ldlm_request),
1030 lustre_swab_ldlm_request, NULL);
1031 EXPORT_SYMBOL(RMF_DLM_REQ);
1033 struct req_msg_field RMF_DLM_REP =
1034 DEFINE_MSGF("dlm_rep", 0,
1035 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1036 EXPORT_SYMBOL(RMF_DLM_REP);
1038 struct req_msg_field RMF_LDLM_INTENT =
1039 DEFINE_MSGF("ldlm_intent", 0,
1040 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1041 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1043 struct req_msg_field RMF_DLM_LVB =
1044 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1045 EXPORT_SYMBOL(RMF_DLM_LVB);
1047 struct req_msg_field RMF_DLM_GL_DESC =
1048 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1049 lustre_swab_gl_desc, NULL);
1050 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1052 struct req_msg_field RMF_MDT_MD =
1053 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1054 EXPORT_SYMBOL(RMF_MDT_MD);
1056 struct req_msg_field RMF_REC_REINT =
1057 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1058 lustre_swab_mdt_rec_reint, NULL);
1059 EXPORT_SYMBOL(RMF_REC_REINT);
1061 /* FIXME: this length should be defined as a macro */
1062 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1064 EXPORT_SYMBOL(RMF_EADATA);
1066 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1067 EXPORT_SYMBOL(RMF_EAVALS);
1069 struct req_msg_field RMF_ACL =
1070 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1071 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1072 EXPORT_SYMBOL(RMF_ACL);
1074 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1075 struct req_msg_field RMF_LOGCOOKIES =
1076 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1077 sizeof(struct llog_cookie), NULL, NULL);
1078 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1080 struct req_msg_field RMF_CAPA1 =
1081 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1082 lustre_swab_lustre_capa, NULL);
1083 EXPORT_SYMBOL(RMF_CAPA1);
1085 struct req_msg_field RMF_CAPA2 =
1086 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1087 lustre_swab_lustre_capa, NULL);
1088 EXPORT_SYMBOL(RMF_CAPA2);
1090 struct req_msg_field RMF_LAYOUT_INTENT =
1091 DEFINE_MSGF("layout_intent", 0,
1092 sizeof(struct layout_intent), lustre_swab_layout_intent,
1094 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1097 * OST request field.
1099 struct req_msg_field RMF_OST_BODY =
1100 DEFINE_MSGF("ost_body", 0,
1101 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1102 EXPORT_SYMBOL(RMF_OST_BODY);
1104 struct req_msg_field RMF_OBD_IOOBJ =
1105 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1106 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1107 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1109 struct req_msg_field RMF_NIOBUF_REMOTE =
1110 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1111 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1113 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1115 struct req_msg_field RMF_RCS =
1116 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1117 lustre_swab_generic_32s, dump_rcs);
1118 EXPORT_SYMBOL(RMF_RCS);
1120 struct req_msg_field RMF_EAVALS_LENS =
1121 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1122 lustre_swab_generic_32s, NULL);
1123 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1125 struct req_msg_field RMF_OBD_ID =
1126 DEFINE_MSGF("obd_id", 0,
1127 sizeof(__u64), lustre_swab_ost_last_id, NULL);
1128 EXPORT_SYMBOL(RMF_OBD_ID);
1130 struct req_msg_field RMF_FID =
1131 DEFINE_MSGF("fid", 0,
1132 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1133 EXPORT_SYMBOL(RMF_FID);
1135 struct req_msg_field RMF_OST_ID =
1136 DEFINE_MSGF("ost_id", 0,
1137 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1138 EXPORT_SYMBOL(RMF_OST_ID);
1140 struct req_msg_field RMF_FIEMAP_KEY =
1141 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1142 lustre_swab_fiemap, NULL);
1143 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1145 struct req_msg_field RMF_FIEMAP_VAL =
1146 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1147 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1149 struct req_msg_field RMF_IDX_INFO =
1150 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1151 lustre_swab_idx_info, NULL);
1152 EXPORT_SYMBOL(RMF_IDX_INFO);
1153 struct req_msg_field RMF_HSM_USER_STATE =
1154 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1155 lustre_swab_hsm_user_state, NULL);
1156 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1158 struct req_msg_field RMF_HSM_STATE_SET =
1159 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1160 lustre_swab_hsm_state_set, NULL);
1161 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1163 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1164 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1165 lustre_swab_hsm_progress_kernel, NULL);
1166 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1168 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1169 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1170 lustre_swab_hsm_current_action, NULL);
1171 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1173 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1174 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1175 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1177 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1179 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1180 DEFINE_MSGF("hsm_archive", 0,
1181 sizeof(__u32), lustre_swab_generic_32s, NULL);
1182 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1184 struct req_msg_field RMF_MDS_HSM_REQUEST =
1185 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1186 lustre_swab_hsm_request, NULL);
1187 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1189 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1190 lustre_swab_object_update_request, NULL);
1191 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1193 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1194 DEFINE_MSGF("object_update_reply", 0, -1,
1195 lustre_swab_object_update_reply, NULL);
1196 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1198 struct req_msg_field RMF_SWAP_LAYOUTS =
1199 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1200 lustre_swab_swap_layouts, NULL);
1201 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1203 struct req_msg_field RMF_LFSCK_REQUEST =
1204 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1205 lustre_swab_lfsck_request, NULL);
1206 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1208 struct req_msg_field RMF_LFSCK_REPLY =
1209 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1210 lustre_swab_lfsck_reply, NULL);
1211 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1213 struct req_msg_field RMF_OST_LADVISE_HDR =
1214 DEFINE_MSGF("ladvise_request", 0,
1215 sizeof(struct ladvise_hdr),
1216 lustre_swab_ladvise_hdr, NULL);
1217 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1219 struct req_msg_field RMF_OST_LADVISE =
1220 DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1221 sizeof(struct lu_ladvise),
1222 lustre_swab_ladvise, NULL);
1223 EXPORT_SYMBOL(RMF_OST_LADVISE);
1225 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1226 -1, lustre_swab_out_update_header, NULL);
1227 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1229 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1230 RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1231 lustre_swab_out_update_buffer, NULL);
1232 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1239 const char *rf_name;
1243 const struct req_msg_field **d;
1244 } rf_fields[RCL_NR];
1247 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1261 #define DEFINE_REQ_FMT0(name, client, server) \
1262 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1264 struct req_format RQF_OBD_PING =
1265 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1266 EXPORT_SYMBOL(RQF_OBD_PING);
1268 struct req_format RQF_OBD_SET_INFO =
1269 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1270 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1272 /* Read index file through the network */
1273 struct req_format RQF_OBD_IDX_READ =
1274 DEFINE_REQ_FMT0("OBD_IDX_READ",
1275 obd_idx_read_client, obd_idx_read_server);
1276 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1278 struct req_format RQF_SEC_CTX =
1279 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1280 EXPORT_SYMBOL(RQF_SEC_CTX);
1282 struct req_format RQF_MGS_TARGET_REG =
1283 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1284 mgs_target_info_only);
1285 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1287 struct req_format RQF_MGS_SET_INFO =
1288 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1290 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1292 struct req_format RQF_MGS_CONFIG_READ =
1293 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1294 mgs_config_read_server);
1295 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1297 struct req_format RQF_SEQ_QUERY =
1298 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1299 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1301 struct req_format RQF_FLD_QUERY =
1302 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1303 EXPORT_SYMBOL(RQF_FLD_QUERY);
1305 struct req_format RQF_FLD_READ =
1306 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1307 EXPORT_SYMBOL(RQF_FLD_READ);
1309 struct req_format RQF_LOG_CANCEL =
1310 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1311 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1313 struct req_format RQF_MDS_QUOTACTL =
1314 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1315 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1317 struct req_format RQF_OST_QUOTACTL =
1318 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1319 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1321 struct req_format RQF_QUOTA_DQACQ =
1322 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1323 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1325 struct req_format RQF_LDLM_INTENT_QUOTA =
1326 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1327 ldlm_intent_quota_client,
1328 ldlm_intent_quota_server);
1329 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1331 struct req_format RQF_MDS_GETSTATUS =
1332 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1333 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1335 struct req_format RQF_MDS_STATFS =
1336 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1337 EXPORT_SYMBOL(RQF_MDS_STATFS);
1339 struct req_format RQF_MDS_SYNC =
1340 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1341 EXPORT_SYMBOL(RQF_MDS_SYNC);
1343 struct req_format RQF_MDS_GETATTR =
1344 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1345 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1347 struct req_format RQF_MDS_GETXATTR =
1348 DEFINE_REQ_FMT0("MDS_GETXATTR",
1349 mds_getxattr_client, mds_getxattr_server);
1350 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1352 struct req_format RQF_MDS_GETATTR_NAME =
1353 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1354 mds_getattr_name_client, mds_getattr_server);
1355 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1357 struct req_format RQF_MDS_REINT =
1358 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1359 EXPORT_SYMBOL(RQF_MDS_REINT);
1361 struct req_format RQF_MDS_REINT_CREATE =
1362 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1363 mds_reint_create_client, mdt_body_capa);
1364 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1366 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1367 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1368 mds_reint_create_rmt_acl_client, mdt_body_capa);
1369 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1371 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1372 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1373 mds_reint_create_slave_client, mdt_body_capa);
1374 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1376 struct req_format RQF_MDS_REINT_CREATE_SYM =
1377 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1378 mds_reint_create_sym_client, mdt_body_capa);
1379 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1381 struct req_format RQF_MDS_REINT_OPEN =
1382 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1383 mds_reint_open_client, mds_reint_open_server);
1384 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1386 struct req_format RQF_MDS_REINT_UNLINK =
1387 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1388 mds_last_unlink_server);
1389 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1391 struct req_format RQF_MDS_REINT_LINK =
1392 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1393 mds_reint_link_client, mdt_body_only);
1394 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1396 struct req_format RQF_MDS_REINT_RENAME =
1397 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1398 mds_last_unlink_server);
1399 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1401 struct req_format RQF_MDS_REINT_MIGRATE =
1402 DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1403 mds_last_unlink_server);
1404 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1406 struct req_format RQF_MDS_REINT_SETATTR =
1407 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1408 mds_reint_setattr_client, mds_setattr_server);
1409 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1411 struct req_format RQF_MDS_REINT_SETXATTR =
1412 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1413 mds_reint_setxattr_client, mdt_body_only);
1414 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1416 struct req_format RQF_MDS_CONNECT =
1417 DEFINE_REQ_FMT0("MDS_CONNECT",
1418 obd_connect_client, obd_connect_server);
1419 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1421 struct req_format RQF_MDS_DISCONNECT =
1422 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1423 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1425 struct req_format RQF_MDS_GET_INFO =
1426 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1427 mds_getinfo_server);
1428 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1430 struct req_format RQF_OUT_UPDATE =
1431 DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1433 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1435 struct req_format RQF_LDLM_ENQUEUE =
1436 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1437 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1438 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1440 struct req_format RQF_LDLM_ENQUEUE_LVB =
1441 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1442 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1443 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1445 struct req_format RQF_LDLM_CONVERT =
1446 DEFINE_REQ_FMT0("LDLM_CONVERT",
1447 ldlm_enqueue_client, ldlm_enqueue_server);
1448 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1450 struct req_format RQF_LDLM_CANCEL =
1451 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1452 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1454 struct req_format RQF_LDLM_CALLBACK =
1455 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1456 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1458 struct req_format RQF_LDLM_CP_CALLBACK =
1459 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1460 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1462 struct req_format RQF_LDLM_BL_CALLBACK =
1463 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1464 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1466 struct req_format RQF_LDLM_GL_CALLBACK =
1467 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1468 ldlm_gl_callback_server);
1469 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1471 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1472 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1473 ldlm_gl_callback_server);
1474 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1476 struct req_format RQF_LDLM_INTENT_BASIC =
1477 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1478 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1479 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1481 struct req_format RQF_LDLM_INTENT =
1482 DEFINE_REQ_FMT0("LDLM_INTENT",
1483 ldlm_intent_client, ldlm_intent_server);
1484 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1486 struct req_format RQF_LDLM_INTENT_LAYOUT =
1487 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1488 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1489 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1491 struct req_format RQF_LDLM_INTENT_GETATTR =
1492 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1493 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1494 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1496 struct req_format RQF_LDLM_INTENT_OPEN =
1497 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1498 ldlm_intent_open_client, ldlm_intent_open_server);
1499 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1501 struct req_format RQF_LDLM_INTENT_CREATE =
1502 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1503 ldlm_intent_create_client, ldlm_intent_getattr_server);
1504 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1506 struct req_format RQF_LDLM_INTENT_UNLINK =
1507 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1508 ldlm_intent_unlink_client, ldlm_intent_server);
1509 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1511 struct req_format RQF_LDLM_INTENT_GETXATTR =
1512 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1513 ldlm_intent_getxattr_client,
1514 ldlm_intent_getxattr_server);
1515 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1517 struct req_format RQF_MDS_CLOSE =
1518 DEFINE_REQ_FMT0("MDS_CLOSE",
1519 mdt_close_client, mds_last_unlink_server);
1520 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1522 struct req_format RQF_MDS_INTENT_CLOSE =
1523 DEFINE_REQ_FMT0("MDS_CLOSE",
1524 mdt_intent_close_client, mds_last_unlink_server);
1525 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1527 struct req_format RQF_MDS_READPAGE =
1528 DEFINE_REQ_FMT0("MDS_READPAGE",
1529 mdt_body_capa, mdt_body_only);
1530 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1532 struct req_format RQF_MDS_HSM_ACTION =
1533 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1534 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1536 struct req_format RQF_MDS_HSM_PROGRESS =
1537 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1538 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1540 struct req_format RQF_MDS_HSM_CT_REGISTER =
1541 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1542 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1544 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1545 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1546 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1548 struct req_format RQF_MDS_HSM_STATE_GET =
1549 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1550 mdt_body_capa, mdt_hsm_state_get_server);
1551 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1553 struct req_format RQF_MDS_HSM_STATE_SET =
1554 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1555 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1557 struct req_format RQF_MDS_HSM_REQUEST =
1558 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1559 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1561 struct req_format RQF_MDS_SWAP_LAYOUTS =
1562 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1563 mdt_swap_layouts, empty);
1564 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1566 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1567 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1568 llog_origin_handle_create_client, llogd_body_only);
1569 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1571 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1572 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1573 llogd_body_only, llogd_body_only);
1574 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1576 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1577 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1578 llogd_body_only, llog_origin_handle_next_block_server);
1579 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1581 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1582 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1583 llogd_body_only, llog_origin_handle_next_block_server);
1584 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1586 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1587 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1588 llogd_body_only, llog_log_hdr_only);
1589 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1591 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1592 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1593 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1595 struct req_format RQF_CONNECT =
1596 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1597 EXPORT_SYMBOL(RQF_CONNECT);
1599 struct req_format RQF_OST_CONNECT =
1600 DEFINE_REQ_FMT0("OST_CONNECT",
1601 obd_connect_client, obd_connect_server);
1602 EXPORT_SYMBOL(RQF_OST_CONNECT);
1604 struct req_format RQF_OST_DISCONNECT =
1605 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1606 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1608 struct req_format RQF_OST_GETATTR =
1609 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1610 EXPORT_SYMBOL(RQF_OST_GETATTR);
1612 struct req_format RQF_OST_SETATTR =
1613 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1614 EXPORT_SYMBOL(RQF_OST_SETATTR);
1616 struct req_format RQF_OST_CREATE =
1617 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1618 EXPORT_SYMBOL(RQF_OST_CREATE);
1620 struct req_format RQF_OST_PUNCH =
1621 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1622 EXPORT_SYMBOL(RQF_OST_PUNCH);
1624 struct req_format RQF_OST_SYNC =
1625 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1626 EXPORT_SYMBOL(RQF_OST_SYNC);
1628 struct req_format RQF_OST_DESTROY =
1629 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1630 EXPORT_SYMBOL(RQF_OST_DESTROY);
1632 struct req_format RQF_OST_BRW_READ =
1633 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1634 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1636 struct req_format RQF_OST_BRW_WRITE =
1637 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1638 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1640 struct req_format RQF_OST_STATFS =
1641 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1642 EXPORT_SYMBOL(RQF_OST_STATFS);
1644 struct req_format RQF_OST_SET_GRANT_INFO =
1645 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1647 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1649 struct req_format RQF_OST_GET_INFO =
1650 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1651 ost_get_info_generic_server);
1652 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1654 struct req_format RQF_OST_GET_INFO_LAST_ID =
1655 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1656 ost_get_last_id_server);
1657 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1659 struct req_format RQF_OST_GET_INFO_LAST_FID =
1660 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1661 ost_get_last_fid_server);
1662 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1664 struct req_format RQF_OST_SET_INFO_LAST_FID =
1665 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1667 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1669 struct req_format RQF_OST_GET_INFO_FIEMAP =
1670 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1671 ost_get_fiemap_server);
1672 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1674 struct req_format RQF_LFSCK_NOTIFY =
1675 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1676 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1678 struct req_format RQF_LFSCK_QUERY =
1679 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1680 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1682 struct req_format RQF_OST_LADVISE =
1683 DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1684 EXPORT_SYMBOL(RQF_OST_LADVISE);
1686 #if !defined(__REQ_LAYOUT_USER__)
1688 /* Convenience macro */
1689 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1692 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1693 * field of RQFs and the \a rmf_offset field of RMFs.
1695 int req_layout_init(void)
1700 struct req_format *rf = NULL;
1702 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1703 rf = req_formats[i];
1705 for (j = 0; j < RCL_NR; ++j) {
1706 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1707 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1708 struct req_msg_field *field;
1710 field = (typeof(field))rf->rf_fields[j].d[k];
1711 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1712 || field->rmf_size > 0);
1713 LASSERT(field->rmf_offset[i][j] == 0);
1715 * k + 1 to detect unused format/field
1718 field->rmf_offset[i][j] = k + 1;
1724 EXPORT_SYMBOL(req_layout_init);
1726 void req_layout_fini(void)
1729 EXPORT_SYMBOL(req_layout_fini);
1732 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1734 * Actual/expected field sizes are set elsewhere in functions in this file:
1735 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1736 * req_capsule_msg_size(). The \a rc_area information is used by.
1737 * ptlrpc_request_set_replen().
1739 void req_capsule_init_area(struct req_capsule *pill)
1743 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1744 pill->rc_area[RCL_CLIENT][i] = -1;
1745 pill->rc_area[RCL_SERVER][i] = -1;
1748 EXPORT_SYMBOL(req_capsule_init_area);
1751 * Initialize a pill.
1753 * The \a location indicates whether the caller is executing on the client side
1754 * (RCL_CLIENT) or server side (RCL_SERVER)..
1756 void req_capsule_init(struct req_capsule *pill,
1757 struct ptlrpc_request *req,
1758 enum req_location location)
1760 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1763 * Today all capsules are embedded in ptlrpc_request structs,
1764 * but just in case that ever isn't the case, we don't reach
1765 * into req unless req != NULL and pill is the one embedded in
1768 * The req->rq_pill_init flag makes it safe to initialize a pill
1769 * twice, which might happen in the OST paths as a result of the
1770 * high-priority RPC queue getting peeked at before ost_handle()
1771 * handles an OST RPC.
1773 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1776 memset(pill, 0, sizeof *pill);
1778 pill->rc_loc = location;
1779 req_capsule_init_area(pill);
1781 if (req != NULL && pill == &req->rq_pill)
1782 req->rq_pill_init = 1;
1784 EXPORT_SYMBOL(req_capsule_init);
1786 void req_capsule_fini(struct req_capsule *pill)
1789 EXPORT_SYMBOL(req_capsule_fini);
1791 static int __req_format_is_sane(const struct req_format *fmt)
1793 return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1794 req_formats[fmt->rf_idx] == fmt;
1797 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1798 enum req_location loc)
1800 struct ptlrpc_request *req;
1803 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1807 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1808 * (see req_capsule_extend()).
1810 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1812 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1813 LASSERT(__req_format_is_sane(fmt));
1817 EXPORT_SYMBOL(req_capsule_set);
1820 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1823 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1824 * variable-sized fields. The field sizes come from the declared \a rmf_size
1825 * field of a \a pill's \a rc_fmt's RMF's.
1827 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1828 enum req_location loc)
1830 const struct req_format *fmt = pill->rc_fmt;
1833 LASSERT(fmt != NULL);
1835 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1836 if (pill->rc_area[loc][i] == -1) {
1837 pill->rc_area[loc][i] =
1838 fmt->rf_fields[loc].d[i]->rmf_size;
1839 if (pill->rc_area[loc][i] == -1) {
1841 * Skip the following fields.
1843 * If this LASSERT() trips then you're missing a
1844 * call to req_capsule_set_size().
1846 LASSERT(loc != RCL_SERVER);
1853 EXPORT_SYMBOL(req_capsule_filled_sizes);
1856 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1858 * This function uses the \a pill's \a rc_area as filled in by
1859 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1862 int req_capsule_server_pack(struct req_capsule *pill)
1864 const struct req_format *fmt;
1868 LASSERT(pill->rc_loc == RCL_SERVER);
1870 LASSERT(fmt != NULL);
1872 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1873 rc = lustre_pack_reply(pill->rc_req, count,
1874 pill->rc_area[RCL_SERVER], NULL);
1876 DEBUG_REQ(D_ERROR, pill->rc_req,
1877 "Cannot pack %d fields in format `%s': ",
1878 count, fmt->rf_name);
1882 EXPORT_SYMBOL(req_capsule_server_pack);
1885 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1886 * corresponding to the given RMF (\a field).
1888 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1889 const struct req_msg_field *field,
1890 enum req_location loc)
1894 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1895 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1896 pill->rc_fmt->rf_name,
1897 field->rmf_name, offset, loc);
1900 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1905 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1910 swabber_dumper_helper(struct req_capsule *pill,
1911 const struct req_msg_field *field,
1912 enum req_location loc,
1914 void *value, int len, int dump, void (*swabber)( void *))
1920 int inout = loc == RCL_CLIENT;
1922 swabber = swabber ?: field->rmf_swabber;
1924 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1925 swabber != NULL && value != NULL)
1930 if (!field->rmf_dumper)
1933 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1935 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1936 do_swab ? "unswabbed " : "", field->rmf_name);
1937 field->rmf_dumper(value);
1942 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1944 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1945 "follows\n", field->rmf_name);
1946 field->rmf_dumper(value);
1953 * We're swabbing an array; swabber() swabs a single array element, so
1954 * swab every element.
1956 LASSERT((len % field->rmf_size) == 0);
1957 for (p = value, i = 0, n = len / field->rmf_size;
1959 i++, p += field->rmf_size) {
1961 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1962 "element %d follows\n",
1963 do_swab ? "unswabbed " : "", field->rmf_name, i);
1964 field->rmf_dumper(p);
1970 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1971 "element %d follows\n", field->rmf_name, i);
1972 field->rmf_dumper(value);
1976 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1980 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1981 * corresponding to the given RMF (\a field).
1983 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1984 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1985 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1986 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1987 * element of the array swabbed.
1989 static void *__req_capsule_get(struct req_capsule *pill,
1990 const struct req_msg_field *field,
1991 enum req_location loc,
1992 void (*swabber)( void *),
1995 const struct req_format *fmt;
1996 struct lustre_msg *msg;
2001 void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2003 static const char *rcl_names[RCL_NR] = {
2004 [RCL_CLIENT] = "client",
2005 [RCL_SERVER] = "server"
2008 LASSERT(pill != NULL);
2009 LASSERT(pill != LP_POISON);
2011 LASSERT(fmt != NULL);
2012 LASSERT(fmt != LP_POISON);
2013 LASSERT(__req_format_is_sane(fmt));
2015 offset = __req_capsule_offset(pill, field, loc);
2017 msg = __req_msg(pill, loc);
2018 LASSERT(msg != NULL);
2020 getter = (field->rmf_flags & RMF_F_STRING) ?
2021 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2023 if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2025 * We've already asserted that field->rmf_size > 0 in
2026 * req_layout_init().
2028 len = lustre_msg_buflen(msg, offset);
2029 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2030 (len % field->rmf_size) != 0) {
2031 CERROR("%s: array field size mismatch "
2032 "%d modulo %u != 0 (%d)\n",
2033 field->rmf_name, len, field->rmf_size, loc);
2036 } else if (pill->rc_area[loc][offset] != -1) {
2037 len = pill->rc_area[loc][offset];
2039 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2041 value = getter(msg, offset, len);
2043 if (value == NULL) {
2044 DEBUG_REQ(D_ERROR, pill->rc_req,
2045 "Wrong buffer for field `%s' (%u of %u) "
2046 "in format `%s': %u vs. %u (%s)\n",
2047 field->rmf_name, offset, lustre_msg_bufcount(msg),
2048 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2051 swabber_dumper_helper(pill, field, loc, offset, value, len,
2059 * Dump a request and/or reply
2061 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2063 const struct req_format *fmt;
2064 const struct req_msg_field *field;
2070 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2071 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2072 field = FMT_FIELD(fmt, loc, i);
2073 if (field->rmf_dumper == NULL) {
2075 * FIXME Add a default hex dumper for fields that don't
2076 * have a specific dumper
2078 len = req_capsule_get_size(pill, field, loc);
2079 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2080 "field size is %u\n", field->rmf_name, len);
2082 /* It's the dumping side-effect that we're interested in */
2083 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2086 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2092 void req_capsule_client_dump(struct req_capsule *pill)
2094 __req_capsule_dump(pill, RCL_CLIENT);
2096 EXPORT_SYMBOL(req_capsule_client_dump);
2101 void req_capsule_server_dump(struct req_capsule *pill)
2103 __req_capsule_dump(pill, RCL_SERVER);
2105 EXPORT_SYMBOL(req_capsule_server_dump);
2108 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2109 * buffer corresponding to the given RMF (\a field) of a \a pill.
2111 void *req_capsule_client_get(struct req_capsule *pill,
2112 const struct req_msg_field *field)
2114 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2116 EXPORT_SYMBOL(req_capsule_client_get);
2119 * Same as req_capsule_client_get(), but with a \a swabber argument.
2121 * Currently unused; will be removed when req_capsule_server_swab_get() is
2124 void *req_capsule_client_swab_get(struct req_capsule *pill,
2125 const struct req_msg_field *field,
2128 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2130 EXPORT_SYMBOL(req_capsule_client_swab_get);
2133 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2135 * First the \a pill's request \a field's size is set (\a rc_area) using
2136 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2139 void *req_capsule_client_sized_get(struct req_capsule *pill,
2140 const struct req_msg_field *field,
2143 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2144 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2146 EXPORT_SYMBOL(req_capsule_client_sized_get);
2149 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2150 * buffer corresponding to the given RMF (\a field) of a \a pill.
2152 void *req_capsule_server_get(struct req_capsule *pill,
2153 const struct req_msg_field *field)
2155 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2157 EXPORT_SYMBOL(req_capsule_server_get);
2160 * Same as req_capsule_server_get(), but with a \a swabber argument.
2162 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2163 * swabbing done outside this capsule abstraction.
2165 void *req_capsule_server_swab_get(struct req_capsule *pill,
2166 const struct req_msg_field *field,
2169 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2171 EXPORT_SYMBOL(req_capsule_server_swab_get);
2174 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2176 * First the \a pill's request \a field's size is set (\a rc_area) using
2177 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2180 void *req_capsule_server_sized_get(struct req_capsule *pill,
2181 const struct req_msg_field *field,
2184 req_capsule_set_size(pill, field, RCL_SERVER, len);
2185 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2187 EXPORT_SYMBOL(req_capsule_server_sized_get);
2189 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2190 const struct req_msg_field *field,
2191 __u32 len, void *swabber)
2193 req_capsule_set_size(pill, field, RCL_SERVER, len);
2194 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2196 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2199 * Returns the buffer of a \a pill corresponding to the given \a field from the
2200 * request (if the caller is executing on the server-side) or reply (if the
2201 * caller is executing on the client-side).
2203 * This function convienient for use is code that could be executed on the
2204 * client and server alike.
2206 const void *req_capsule_other_get(struct req_capsule *pill,
2207 const struct req_msg_field *field)
2209 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2211 EXPORT_SYMBOL(req_capsule_other_get);
2214 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2215 * field of the given \a pill.
2217 * This function must be used when constructing variable sized fields of a
2220 void req_capsule_set_size(struct req_capsule *pill,
2221 const struct req_msg_field *field,
2222 enum req_location loc, __u32 size)
2224 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2226 if ((size != (__u32)field->rmf_size) &&
2227 (field->rmf_size != -1) &&
2228 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2230 __u32 rmf_size = (__u32)field->rmf_size;
2231 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2232 (size % rmf_size != 0)) {
2233 CERROR("%s: array field size mismatch "
2234 "%u %% %u != 0 (%d)\n",
2235 field->rmf_name, size, rmf_size, loc);
2237 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2239 CERROR("%s: field size mismatch %u != %u (%d)\n",
2240 field->rmf_name, size, rmf_size, loc);
2245 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2247 EXPORT_SYMBOL(req_capsule_set_size);
2250 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2251 * for the given \a pill's given \a field.
2253 * NB: this function doesn't correspond with req_capsule_set_size(), which
2254 * actually sets the size in pill.rc_area[loc][offset], but this function
2255 * returns the message buflen[offset], maybe we should use another name.
2257 __u32 req_capsule_get_size(const struct req_capsule *pill,
2258 const struct req_msg_field *field,
2259 enum req_location loc)
2261 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2263 return lustre_msg_buflen(__req_msg(pill, loc),
2264 __req_capsule_offset(pill, field, loc));
2266 EXPORT_SYMBOL(req_capsule_get_size);
2269 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2270 * given \a pill's request or reply (\a loc) given the field size recorded in
2271 * the \a pill's rc_area.
2273 * See also req_capsule_set_size().
2275 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2277 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2278 pill->rc_fmt->rf_fields[loc].nr,
2279 pill->rc_area[loc]);
2283 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2284 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2285 * PTLRPC request or reply given only an RQF (\a fmt).
2287 * This function should not be used for formats which contain variable size
2290 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2291 enum req_location loc)
2297 * This function should probably LASSERT() that fmt has no fields with
2298 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2299 * elements in the array there will ultimately be, but then, we could
2300 * assume that there will be at least one element, and that's just what
2303 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2307 for (; i < fmt->rf_fields[loc].nr; ++i)
2308 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2309 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2315 * Changes the format of an RPC.
2317 * The pill must already have been initialized, which means that it already has
2318 * a request format. The new format \a fmt must be an extension of the pill's
2319 * old format. Specifically: the new format must have as many request and reply
2320 * fields as the old one, and all fields shared by the old and new format must
2321 * be at least as large in the new format.
2323 * The new format's fields may be of different "type" than the old format, but
2324 * only for fields that are "opaque" blobs: fields which have a) have no
2325 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2326 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2327 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2328 * according to the key field. When the value, according to the key, contains a
2329 * structure (or array thereof) to be swabbed, the format should be changed to
2330 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2333 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2338 const struct req_format *old;
2340 LASSERT(pill->rc_fmt != NULL);
2341 LASSERT(__req_format_is_sane(fmt));
2345 * Sanity checking...
2347 for (i = 0; i < RCL_NR; ++i) {
2348 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2349 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2350 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2352 /* "opaque" fields can be transmogrified */
2353 if (ofield->rmf_swabber == NULL &&
2354 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2355 (ofield->rmf_size == -1 ||
2356 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2358 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2361 * Last field in old format can be shorter than in new.
2363 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2364 FMT_FIELD(old, i, j)->rmf_size);
2369 EXPORT_SYMBOL(req_capsule_extend);
2372 * This function returns a non-zero value if the given \a field is present in
2373 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2376 int req_capsule_has_field(const struct req_capsule *pill,
2377 const struct req_msg_field *field,
2378 enum req_location loc)
2380 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2382 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2384 EXPORT_SYMBOL(req_capsule_has_field);
2387 * Returns a non-zero value if the given \a field is present in the given \a
2388 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2390 int req_capsule_field_present(const struct req_capsule *pill,
2391 const struct req_msg_field *field,
2392 enum req_location loc)
2396 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2397 LASSERT(req_capsule_has_field(pill, field, loc));
2399 offset = __req_capsule_offset(pill, field, loc);
2400 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2402 EXPORT_SYMBOL(req_capsule_field_present);
2405 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2406 * request or reply (\a loc).
2408 * This is not the opposite of req_capsule_extend().
2410 void req_capsule_shrink(struct req_capsule *pill,
2411 const struct req_msg_field *field,
2413 enum req_location loc)
2415 const struct req_format *fmt;
2416 struct lustre_msg *msg;
2421 LASSERT(fmt != NULL);
2422 LASSERT(__req_format_is_sane(fmt));
2423 LASSERT(req_capsule_has_field(pill, field, loc));
2424 LASSERT(req_capsule_field_present(pill, field, loc));
2426 offset = __req_capsule_offset(pill, field, loc);
2428 msg = __req_msg(pill, loc);
2429 len = lustre_msg_buflen(msg, offset);
2430 LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2431 fmt->rf_name, field->rmf_name, len, newlen);
2433 if (loc == RCL_CLIENT)
2434 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2437 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2440 EXPORT_SYMBOL(req_capsule_shrink);
2442 int req_capsule_server_grow(struct req_capsule *pill,
2443 const struct req_msg_field *field,
2446 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2451 LASSERT(pill->rc_fmt != NULL);
2452 LASSERT(__req_format_is_sane(pill->rc_fmt));
2453 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2454 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2456 len = req_capsule_get_size(pill, field, RCL_SERVER);
2457 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2458 if ((__u32)pill->rc_req->rq_repbuf_len >=
2459 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2460 CERROR("Inplace repack might be done\n");
2462 pill->rc_req->rq_reply_state = NULL;
2463 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2464 rc = req_capsule_server_pack(pill);
2466 /* put old rs back, the caller will decide what to do */
2467 pill->rc_req->rq_reply_state = rs;
2470 nrs = pill->rc_req->rq_reply_state;
2471 /* Now we need only buffers, copy first chunk */
2472 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2473 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2474 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2475 memcpy(to, from, len);
2476 /* check if we have tail and copy it too */
2477 if (rs->rs_msg->lm_bufcount > offset + 1) {
2478 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2479 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2480 offset = rs->rs_msg->lm_bufcount - 1;
2481 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2482 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2483 memcpy(to, from, len);
2485 /* drop old reply if everything is fine */
2486 if (rs->rs_difficult) {
2490 nrs->rs_difficult = 1;
2491 nrs->rs_no_ack = rs->rs_no_ack;
2492 for (i = 0; i < rs->rs_nlocks; i++) {
2493 nrs->rs_locks[i] = rs->rs_locks[i];
2494 nrs->rs_modes[i] = rs->rs_modes[i];
2498 rs->rs_difficult = 0;
2501 ptlrpc_rs_decref(rs);
2504 EXPORT_SYMBOL(req_capsule_server_grow);
2505 /* __REQ_LAYOUT_USER__ */