4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/layout.c
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 * This file contains the "capsule/pill" abstraction layered above PTLRPC.
45 * Every struct ptlrpc_request contains a "pill", which points to a description
46 * of the format that the request conforms to.
49 #if !defined(__REQ_LAYOUT_USER__)
51 #define DEBUG_SUBSYSTEM S_RPC
54 #include <linux/module.h>
56 # include <liblustre.h>
59 /* LUSTRE_VERSION_CODE */
60 #include <lustre_ver.h>
62 #include <obd_support.h>
63 /* lustre_swab_mdt_body */
64 #include <lustre/lustre_idl.h>
65 /* obd2cli_tgt() (required by DEBUG_REQ()) */
68 /* __REQ_LAYOUT_USER__ */
70 /* struct ptlrpc_request, lustre_msg* */
71 #include <lustre_req_layout.h>
72 #include <lustre_update.h>
73 #include <lustre_acl.h>
74 #include <lustre_debug.h>
77 * RQFs (see below) refer to two struct req_msg_field arrays describing the
78 * client request and server reply, respectively.
80 /* empty set of fields... for suitable definition of emptiness. */
81 static const struct req_msg_field *empty[] = {
85 static const struct req_msg_field *mgs_target_info_only[] = {
90 static const struct req_msg_field *mgs_set_info[] = {
95 static const struct req_msg_field *mgs_config_read_client[] = {
100 static const struct req_msg_field *mgs_config_read_server[] = {
105 static const struct req_msg_field *log_cancel_client[] = {
110 static const struct req_msg_field *mdt_body_only[] = {
115 static const struct req_msg_field *mdt_body_capa[] = {
121 static const struct req_msg_field *quotactl_only[] = {
126 static const struct req_msg_field *quota_body_only[] = {
131 static const struct req_msg_field *ldlm_intent_quota_client[] = {
138 static const struct req_msg_field *ldlm_intent_quota_server[] = {
145 static const struct req_msg_field *mdt_close_client[] = {
152 static const struct req_msg_field *mdt_release_close_client[] = {
160 static const struct req_msg_field *obd_statfs_server[] = {
165 static const struct req_msg_field *seq_query_client[] = {
171 static const struct req_msg_field *seq_query_server[] = {
176 static const struct req_msg_field *fld_query_client[] = {
182 static const struct req_msg_field *fld_query_server[] = {
187 static const struct req_msg_field *fld_read_client[] = {
192 static const struct req_msg_field *fld_read_server[] = {
197 static const struct req_msg_field *mds_getattr_name_client[] = {
204 static const struct req_msg_field *mds_reint_client[] = {
209 static const struct req_msg_field *mds_reint_create_client[] = {
216 static const struct req_msg_field *mds_reint_create_slave_client[] = {
225 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
234 static const struct req_msg_field *mds_reint_create_sym_client[] = {
243 static const struct req_msg_field *mds_reint_open_client[] = {
252 static const struct req_msg_field *mds_reint_open_server[] = {
261 static const struct req_msg_field *mds_reint_unlink_client[] = {
269 static const struct req_msg_field *mds_reint_link_client[] = {
278 static const struct req_msg_field *mds_reint_rename_client[] = {
288 static const struct req_msg_field *mds_last_unlink_server[] = {
297 static const struct req_msg_field *mds_reint_setattr_client[] = {
307 static const struct req_msg_field *mds_reint_setxattr_client[] = {
316 static const struct req_msg_field *mdt_swap_layouts[] = {
325 static const struct req_msg_field *obd_connect_client[] = {
333 static const struct req_msg_field *obd_connect_server[] = {
338 static const struct req_msg_field *obd_set_info_client[] = {
344 static const struct req_msg_field *ost_grant_shrink_client[] = {
350 static const struct req_msg_field *mds_getinfo_client[] = {
356 static const struct req_msg_field *mds_getinfo_server[] = {
361 static const struct req_msg_field *ldlm_enqueue_client[] = {
366 static const struct req_msg_field *ldlm_enqueue_server[] = {
371 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
377 static const struct req_msg_field *ldlm_cp_callback_client[] = {
383 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
389 static const struct req_msg_field *ldlm_gl_callback_server[] = {
394 static const struct req_msg_field *ldlm_intent_basic_client[] = {
400 static const struct req_msg_field *ldlm_intent_client[] = {
407 static const struct req_msg_field *ldlm_intent_server[] = {
415 static const struct req_msg_field *ldlm_intent_layout_client[] = {
420 &RMF_EADATA /* for new layout to be set up */
422 static const struct req_msg_field *ldlm_intent_open_server[] = {
432 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
436 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
441 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
450 static const struct req_msg_field *ldlm_intent_create_client[] = {
454 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
460 static const struct req_msg_field *ldlm_intent_open_client[] = {
464 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
471 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
475 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
480 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
488 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
493 &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
499 static const struct req_msg_field *mds_getxattr_client[] = {
507 static const struct req_msg_field *mds_getxattr_server[] = {
513 static const struct req_msg_field *mds_getattr_server[] = {
522 static const struct req_msg_field *mds_setattr_server[] = {
531 static const struct req_msg_field *mds_update_client[] = {
536 static const struct req_msg_field *mds_update_server[] = {
541 static const struct req_msg_field *llog_origin_handle_create_client[] = {
547 static const struct req_msg_field *llogd_body_only[] = {
552 static const struct req_msg_field *llog_log_hdr_only[] = {
557 static const struct req_msg_field *llogd_conn_body_only[] = {
562 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
568 static const struct req_msg_field *obd_idx_read_client[] = {
573 static const struct req_msg_field *obd_idx_read_server[] = {
578 static const struct req_msg_field *ost_body_only[] = {
583 static const struct req_msg_field *ost_body_capa[] = {
589 static const struct req_msg_field *ost_destroy_client[] = {
597 static const struct req_msg_field *ost_brw_client[] = {
605 static const struct req_msg_field *ost_brw_read_server[] = {
610 static const struct req_msg_field *ost_brw_write_server[] = {
616 static const struct req_msg_field *ost_get_info_generic_server[] = {
621 static const struct req_msg_field *ost_get_info_generic_client[] = {
626 static const struct req_msg_field *ost_get_last_id_server[] = {
631 static const struct req_msg_field *ost_get_last_fid_client[] = {
637 static const struct req_msg_field *ost_get_last_fid_server[] = {
642 static const struct req_msg_field *ost_get_fiemap_client[] = {
648 static const struct req_msg_field *ost_get_fiemap_server[] = {
653 static const struct req_msg_field *mdt_hsm_progress[] = {
656 &RMF_MDS_HSM_PROGRESS,
659 static const struct req_msg_field *mdt_hsm_ct_register[] = {
662 &RMF_MDS_HSM_ARCHIVE,
665 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
670 static const struct req_msg_field *mdt_hsm_action_server[] = {
673 &RMF_MDS_HSM_CURRENT_ACTION,
676 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
682 static const struct req_msg_field *mdt_hsm_state_set[] = {
689 static const struct req_msg_field *mdt_hsm_request[] = {
692 &RMF_MDS_HSM_REQUEST,
693 &RMF_MDS_HSM_USER_ITEM,
697 static const struct req_msg_field *obd_lfsck_request[] = {
702 static const struct req_msg_field *obd_lfsck_reply[] = {
707 static struct req_format *req_formats[] = {
714 &RQF_MGS_CONFIG_READ,
724 &RQF_MDS_GETATTR_NAME,
728 &RQF_MDS_RELEASE_CLOSE,
734 &RQF_MDS_DONE_WRITING,
736 &RQF_MDS_REINT_CREATE,
737 &RQF_MDS_REINT_CREATE_RMT_ACL,
738 &RQF_MDS_REINT_CREATE_SLAVE,
739 &RQF_MDS_REINT_CREATE_SYM,
741 &RQF_MDS_REINT_UNLINK,
743 &RQF_MDS_REINT_RENAME,
744 &RQF_MDS_REINT_SETATTR,
745 &RQF_MDS_REINT_SETXATTR,
748 &RQF_MDS_HSM_PROGRESS,
749 &RQF_MDS_HSM_CT_REGISTER,
750 &RQF_MDS_HSM_CT_UNREGISTER,
751 &RQF_MDS_HSM_STATE_GET,
752 &RQF_MDS_HSM_STATE_SET,
754 &RQF_MDS_HSM_REQUEST,
755 &RQF_MDS_SWAP_LAYOUTS,
771 &RQF_OST_SET_GRANT_INFO,
773 &RQF_OST_GET_INFO_LAST_ID,
774 &RQF_OST_GET_INFO_LAST_FID,
775 &RQF_OST_SET_INFO_LAST_FID,
776 &RQF_OST_GET_INFO_FIEMAP,
778 &RQF_LDLM_ENQUEUE_LVB,
782 &RQF_LDLM_CP_CALLBACK,
783 &RQF_LDLM_BL_CALLBACK,
784 &RQF_LDLM_GL_CALLBACK,
785 &RQF_LDLM_GL_DESC_CALLBACK,
787 &RQF_LDLM_INTENT_BASIC,
788 &RQF_LDLM_INTENT_LAYOUT,
789 &RQF_LDLM_INTENT_GETATTR,
790 &RQF_LDLM_INTENT_OPEN,
791 &RQF_LDLM_INTENT_CREATE,
792 &RQF_LDLM_INTENT_UNLINK,
793 &RQF_LDLM_INTENT_GETXATTR,
794 &RQF_LDLM_INTENT_QUOTA,
797 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
798 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
799 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
800 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
801 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
802 &RQF_LLOG_ORIGIN_CONNECT,
808 struct req_msg_field {
809 const __u32 rmf_flags;
810 const char *rmf_name;
812 * Field length. (-1) means "variable length". If the
813 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
814 * but the actual size must be a whole multiple of \a rmf_size.
817 void (*rmf_swabber)(void *);
818 void (*rmf_dumper)(void *);
819 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
824 * The field is a string, must be NUL-terminated.
826 RMF_F_STRING = 1 << 0,
828 * The field's buffer size need not match the declared \a rmf_size.
830 RMF_F_NO_SIZE_CHECK = 1 << 1,
832 * The field's buffer size must be a whole multiple of the declared \a
833 * rmf_size and the \a rmf_swabber function must work on the declared \a
834 * rmf_size worth of bytes.
836 RMF_F_STRUCT_ARRAY = 1 << 2
844 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
845 .rmf_name = (name), \
846 .rmf_flags = (flags), \
847 .rmf_size = (size), \
848 .rmf_swabber = (void (*)(void*))(swabber), \
849 .rmf_dumper = (void (*)(void*))(dumper) \
852 struct req_msg_field RMF_GENERIC_DATA =
853 DEFINE_MSGF("generic_data", 0,
855 EXPORT_SYMBOL(RMF_GENERIC_DATA);
857 struct req_msg_field RMF_MGS_TARGET_INFO =
858 DEFINE_MSGF("mgs_target_info", 0,
859 sizeof(struct mgs_target_info),
860 lustre_swab_mgs_target_info, NULL);
861 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
863 struct req_msg_field RMF_MGS_SEND_PARAM =
864 DEFINE_MSGF("mgs_send_param", 0,
865 sizeof(struct mgs_send_param),
867 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
869 struct req_msg_field RMF_MGS_CONFIG_BODY =
870 DEFINE_MSGF("mgs_config_read request", 0,
871 sizeof(struct mgs_config_body),
872 lustre_swab_mgs_config_body, NULL);
873 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
875 struct req_msg_field RMF_MGS_CONFIG_RES =
876 DEFINE_MSGF("mgs_config_read reply ", 0,
877 sizeof(struct mgs_config_res),
878 lustre_swab_mgs_config_res, NULL);
879 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
881 struct req_msg_field RMF_U32 =
882 DEFINE_MSGF("generic u32", 0,
883 sizeof(__u32), lustre_swab_generic_32s, NULL);
884 EXPORT_SYMBOL(RMF_U32);
886 struct req_msg_field RMF_SETINFO_VAL =
887 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
888 EXPORT_SYMBOL(RMF_SETINFO_VAL);
890 struct req_msg_field RMF_GETINFO_KEY =
891 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
892 EXPORT_SYMBOL(RMF_GETINFO_KEY);
894 struct req_msg_field RMF_GETINFO_VALLEN =
895 DEFINE_MSGF("getinfo_vallen", 0,
896 sizeof(__u32), lustre_swab_generic_32s, NULL);
897 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
899 struct req_msg_field RMF_GETINFO_VAL =
900 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
901 EXPORT_SYMBOL(RMF_GETINFO_VAL);
903 struct req_msg_field RMF_SEQ_OPC =
904 DEFINE_MSGF("seq_query_opc", 0,
905 sizeof(__u32), lustre_swab_generic_32s, NULL);
906 EXPORT_SYMBOL(RMF_SEQ_OPC);
908 struct req_msg_field RMF_SEQ_RANGE =
909 DEFINE_MSGF("seq_query_range", 0,
910 sizeof(struct lu_seq_range),
911 lustre_swab_lu_seq_range, NULL);
912 EXPORT_SYMBOL(RMF_SEQ_RANGE);
914 struct req_msg_field RMF_FLD_OPC =
915 DEFINE_MSGF("fld_query_opc", 0,
916 sizeof(__u32), lustre_swab_generic_32s, NULL);
917 EXPORT_SYMBOL(RMF_FLD_OPC);
919 struct req_msg_field RMF_FLD_MDFLD =
920 DEFINE_MSGF("fld_query_mdfld", 0,
921 sizeof(struct lu_seq_range),
922 lustre_swab_lu_seq_range, NULL);
923 EXPORT_SYMBOL(RMF_FLD_MDFLD);
925 struct req_msg_field RMF_MDT_BODY =
926 DEFINE_MSGF("mdt_body", 0,
927 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
928 EXPORT_SYMBOL(RMF_MDT_BODY);
930 struct req_msg_field RMF_OBD_QUOTACTL =
931 DEFINE_MSGF("obd_quotactl", 0,
932 sizeof(struct obd_quotactl),
933 lustre_swab_obd_quotactl, NULL);
934 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
936 struct req_msg_field RMF_QUOTA_BODY =
937 DEFINE_MSGF("quota_body", 0,
938 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
939 EXPORT_SYMBOL(RMF_QUOTA_BODY);
941 struct req_msg_field RMF_MDT_EPOCH =
942 DEFINE_MSGF("mdt_ioepoch", 0,
943 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
944 EXPORT_SYMBOL(RMF_MDT_EPOCH);
946 struct req_msg_field RMF_PTLRPC_BODY =
947 DEFINE_MSGF("ptlrpc_body", 0,
948 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
949 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
951 struct req_msg_field RMF_CLOSE_DATA =
952 DEFINE_MSGF("data_version", 0,
953 sizeof(struct close_data), lustre_swab_close_data, NULL);
954 EXPORT_SYMBOL(RMF_CLOSE_DATA);
956 struct req_msg_field RMF_OBD_STATFS =
957 DEFINE_MSGF("obd_statfs", 0,
958 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
959 EXPORT_SYMBOL(RMF_OBD_STATFS);
961 struct req_msg_field RMF_SETINFO_KEY =
962 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
963 EXPORT_SYMBOL(RMF_SETINFO_KEY);
965 struct req_msg_field RMF_NAME =
966 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
967 EXPORT_SYMBOL(RMF_NAME);
969 struct req_msg_field RMF_SYMTGT =
970 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
971 EXPORT_SYMBOL(RMF_SYMTGT);
973 struct req_msg_field RMF_TGTUUID =
974 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
976 EXPORT_SYMBOL(RMF_TGTUUID);
978 struct req_msg_field RMF_CLUUID =
979 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
981 EXPORT_SYMBOL(RMF_CLUUID);
983 struct req_msg_field RMF_STRING =
984 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
985 EXPORT_SYMBOL(RMF_STRING);
987 struct req_msg_field RMF_LLOGD_BODY =
988 DEFINE_MSGF("llogd_body", 0,
989 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
990 EXPORT_SYMBOL(RMF_LLOGD_BODY);
992 struct req_msg_field RMF_LLOG_LOG_HDR =
993 DEFINE_MSGF("llog_log_hdr", 0,
994 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
995 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
997 struct req_msg_field RMF_LLOGD_CONN_BODY =
998 DEFINE_MSGF("llogd_conn_body", 0,
999 sizeof(struct llogd_conn_body),
1000 lustre_swab_llogd_conn_body, NULL);
1001 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1004 * connection handle received in MDS_CONNECT request.
1006 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1007 * that the client does not interpret at all.
1009 struct req_msg_field RMF_CONN =
1010 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1011 EXPORT_SYMBOL(RMF_CONN);
1013 struct req_msg_field RMF_CONNECT_DATA =
1014 DEFINE_MSGF("cdata",
1015 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1016 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
1017 sizeof(struct obd_connect_data),
1019 /* For interoperability with 1.8 and 2.0 clients/servers.
1020 * The RPC verification code allows larger RPC buffers, but not
1021 * smaller buffers. Until we no longer need to keep compatibility
1022 * with older servers/clients we can only check that the buffer
1023 * size is at least as large as obd_connect_data_v1. That is not
1024 * not in itself harmful, since the chance of just corrupting this
1025 * field is low. See JIRA LU-16 for details. */
1026 sizeof(struct obd_connect_data_v1),
1028 lustre_swab_connect, NULL);
1029 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1031 struct req_msg_field RMF_DLM_REQ =
1032 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1033 sizeof(struct ldlm_request),
1034 lustre_swab_ldlm_request, NULL);
1035 EXPORT_SYMBOL(RMF_DLM_REQ);
1037 struct req_msg_field RMF_DLM_REP =
1038 DEFINE_MSGF("dlm_rep", 0,
1039 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1040 EXPORT_SYMBOL(RMF_DLM_REP);
1042 struct req_msg_field RMF_LDLM_INTENT =
1043 DEFINE_MSGF("ldlm_intent", 0,
1044 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1045 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1047 struct req_msg_field RMF_DLM_LVB =
1048 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1049 EXPORT_SYMBOL(RMF_DLM_LVB);
1051 struct req_msg_field RMF_DLM_GL_DESC =
1052 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1053 lustre_swab_gl_desc, NULL);
1054 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1056 struct req_msg_field RMF_MDT_MD =
1057 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1058 EXPORT_SYMBOL(RMF_MDT_MD);
1060 struct req_msg_field RMF_REC_REINT =
1061 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1062 lustre_swab_mdt_rec_reint, NULL);
1063 EXPORT_SYMBOL(RMF_REC_REINT);
1065 /* FIXME: this length should be defined as a macro */
1066 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1068 EXPORT_SYMBOL(RMF_EADATA);
1070 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1071 EXPORT_SYMBOL(RMF_EAVALS);
1073 struct req_msg_field RMF_ACL =
1074 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1075 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1076 EXPORT_SYMBOL(RMF_ACL);
1078 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1079 struct req_msg_field RMF_LOGCOOKIES =
1080 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1081 sizeof(struct llog_cookie), NULL, NULL);
1082 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1084 struct req_msg_field RMF_CAPA1 =
1085 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1086 lustre_swab_lustre_capa, NULL);
1087 EXPORT_SYMBOL(RMF_CAPA1);
1089 struct req_msg_field RMF_CAPA2 =
1090 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1091 lustre_swab_lustre_capa, NULL);
1092 EXPORT_SYMBOL(RMF_CAPA2);
1094 struct req_msg_field RMF_LAYOUT_INTENT =
1095 DEFINE_MSGF("layout_intent", 0,
1096 sizeof(struct layout_intent), lustre_swab_layout_intent,
1098 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1101 * OST request field.
1103 struct req_msg_field RMF_OST_BODY =
1104 DEFINE_MSGF("ost_body", 0,
1105 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1106 EXPORT_SYMBOL(RMF_OST_BODY);
1108 struct req_msg_field RMF_OBD_IOOBJ =
1109 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1110 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1111 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1113 struct req_msg_field RMF_NIOBUF_REMOTE =
1114 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1115 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1117 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1119 struct req_msg_field RMF_RCS =
1120 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1121 lustre_swab_generic_32s, dump_rcs);
1122 EXPORT_SYMBOL(RMF_RCS);
1124 struct req_msg_field RMF_EAVALS_LENS =
1125 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1126 lustre_swab_generic_32s, NULL);
1127 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1129 struct req_msg_field RMF_OBD_ID =
1130 DEFINE_MSGF("obd_id", 0,
1131 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1132 EXPORT_SYMBOL(RMF_OBD_ID);
1134 struct req_msg_field RMF_FID =
1135 DEFINE_MSGF("fid", 0,
1136 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1137 EXPORT_SYMBOL(RMF_FID);
1139 struct req_msg_field RMF_OST_ID =
1140 DEFINE_MSGF("ost_id", 0,
1141 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1142 EXPORT_SYMBOL(RMF_OST_ID);
1144 struct req_msg_field RMF_FIEMAP_KEY =
1145 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1146 lustre_swab_fiemap, NULL);
1147 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1149 struct req_msg_field RMF_FIEMAP_VAL =
1150 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1151 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1153 struct req_msg_field RMF_IDX_INFO =
1154 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1155 lustre_swab_idx_info, NULL);
1156 EXPORT_SYMBOL(RMF_IDX_INFO);
1157 struct req_msg_field RMF_HSM_USER_STATE =
1158 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1159 lustre_swab_hsm_user_state, NULL);
1160 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1162 struct req_msg_field RMF_HSM_STATE_SET =
1163 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1164 lustre_swab_hsm_state_set, NULL);
1165 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1167 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1168 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1169 lustre_swab_hsm_progress_kernel, NULL);
1170 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1172 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1173 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1174 lustre_swab_hsm_current_action, NULL);
1175 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1177 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1178 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1179 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1181 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1183 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1184 DEFINE_MSGF("hsm_archive", 0,
1185 sizeof(__u32), lustre_swab_generic_32s, NULL);
1186 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1188 struct req_msg_field RMF_MDS_HSM_REQUEST =
1189 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1190 lustre_swab_hsm_request, NULL);
1191 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1193 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1194 lustre_swab_update_buf, NULL);
1195 EXPORT_SYMBOL(RMF_UPDATE);
1197 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1198 lustre_swab_update_reply_buf,
1200 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1202 struct req_msg_field RMF_SWAP_LAYOUTS =
1203 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1204 lustre_swab_swap_layouts, NULL);
1205 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1207 struct req_msg_field RMF_LFSCK_REQUEST =
1208 DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1209 lustre_swab_lfsck_request, NULL);
1210 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1212 struct req_msg_field RMF_LFSCK_REPLY =
1213 DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1214 lustre_swab_lfsck_reply, NULL);
1215 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1222 const char *rf_name;
1226 const struct req_msg_field **d;
1227 } rf_fields[RCL_NR];
1230 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1244 #define DEFINE_REQ_FMT0(name, client, server) \
1245 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1247 struct req_format RQF_OBD_PING =
1248 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1249 EXPORT_SYMBOL(RQF_OBD_PING);
1251 struct req_format RQF_OBD_SET_INFO =
1252 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1253 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1255 /* Read index file through the network */
1256 struct req_format RQF_OBD_IDX_READ =
1257 DEFINE_REQ_FMT0("OBD_IDX_READ",
1258 obd_idx_read_client, obd_idx_read_server);
1259 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1261 struct req_format RQF_SEC_CTX =
1262 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1263 EXPORT_SYMBOL(RQF_SEC_CTX);
1265 struct req_format RQF_MGS_TARGET_REG =
1266 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1267 mgs_target_info_only);
1268 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1270 struct req_format RQF_MGS_SET_INFO =
1271 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1273 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1275 struct req_format RQF_MGS_CONFIG_READ =
1276 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1277 mgs_config_read_server);
1278 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1280 struct req_format RQF_SEQ_QUERY =
1281 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1282 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1284 struct req_format RQF_FLD_QUERY =
1285 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1286 EXPORT_SYMBOL(RQF_FLD_QUERY);
1288 struct req_format RQF_FLD_READ =
1289 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1290 EXPORT_SYMBOL(RQF_FLD_READ);
1292 struct req_format RQF_LOG_CANCEL =
1293 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1294 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1296 struct req_format RQF_MDS_QUOTACHECK =
1297 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1298 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1300 struct req_format RQF_OST_QUOTACHECK =
1301 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1302 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1304 struct req_format RQF_MDS_QUOTACTL =
1305 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1306 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1308 struct req_format RQF_OST_QUOTACTL =
1309 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1310 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1312 struct req_format RQF_QC_CALLBACK =
1313 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1314 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1316 struct req_format RQF_QUOTA_DQACQ =
1317 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1318 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1320 struct req_format RQF_LDLM_INTENT_QUOTA =
1321 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1322 ldlm_intent_quota_client,
1323 ldlm_intent_quota_server);
1324 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1326 struct req_format RQF_MDS_GETSTATUS =
1327 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1328 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1330 struct req_format RQF_MDS_STATFS =
1331 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1332 EXPORT_SYMBOL(RQF_MDS_STATFS);
1334 struct req_format RQF_MDS_SYNC =
1335 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1336 EXPORT_SYMBOL(RQF_MDS_SYNC);
1338 struct req_format RQF_MDS_GETATTR =
1339 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1340 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1342 struct req_format RQF_MDS_GETXATTR =
1343 DEFINE_REQ_FMT0("MDS_GETXATTR",
1344 mds_getxattr_client, mds_getxattr_server);
1345 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1347 struct req_format RQF_MDS_GETATTR_NAME =
1348 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1349 mds_getattr_name_client, mds_getattr_server);
1350 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1352 struct req_format RQF_MDS_REINT =
1353 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1354 EXPORT_SYMBOL(RQF_MDS_REINT);
1356 struct req_format RQF_MDS_REINT_CREATE =
1357 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1358 mds_reint_create_client, mdt_body_capa);
1359 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1361 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1362 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1363 mds_reint_create_rmt_acl_client, mdt_body_capa);
1364 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1366 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1367 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1368 mds_reint_create_slave_client, mdt_body_capa);
1369 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1371 struct req_format RQF_MDS_REINT_CREATE_SYM =
1372 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1373 mds_reint_create_sym_client, mdt_body_capa);
1374 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1376 struct req_format RQF_MDS_REINT_OPEN =
1377 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1378 mds_reint_open_client, mds_reint_open_server);
1379 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1381 struct req_format RQF_MDS_REINT_UNLINK =
1382 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1383 mds_last_unlink_server);
1384 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1386 struct req_format RQF_MDS_REINT_LINK =
1387 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1388 mds_reint_link_client, mdt_body_only);
1389 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1391 struct req_format RQF_MDS_REINT_RENAME =
1392 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1393 mds_last_unlink_server);
1394 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1396 struct req_format RQF_MDS_REINT_SETATTR =
1397 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1398 mds_reint_setattr_client, mds_setattr_server);
1399 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1401 struct req_format RQF_MDS_REINT_SETXATTR =
1402 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1403 mds_reint_setxattr_client, mdt_body_only);
1404 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1406 struct req_format RQF_MDS_CONNECT =
1407 DEFINE_REQ_FMT0("MDS_CONNECT",
1408 obd_connect_client, obd_connect_server);
1409 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1411 struct req_format RQF_MDS_DISCONNECT =
1412 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1413 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1415 struct req_format RQF_MDS_GET_INFO =
1416 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1417 mds_getinfo_server);
1418 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1420 struct req_format RQF_UPDATE_OBJ =
1421 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1423 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1425 struct req_format RQF_LDLM_ENQUEUE =
1426 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1427 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1428 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1430 struct req_format RQF_LDLM_ENQUEUE_LVB =
1431 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1432 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1433 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1435 struct req_format RQF_LDLM_CONVERT =
1436 DEFINE_REQ_FMT0("LDLM_CONVERT",
1437 ldlm_enqueue_client, ldlm_enqueue_server);
1438 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1440 struct req_format RQF_LDLM_CANCEL =
1441 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1442 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1444 struct req_format RQF_LDLM_CALLBACK =
1445 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1446 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1448 struct req_format RQF_LDLM_CP_CALLBACK =
1449 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1450 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1452 struct req_format RQF_LDLM_BL_CALLBACK =
1453 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1454 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1456 struct req_format RQF_LDLM_GL_CALLBACK =
1457 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1458 ldlm_gl_callback_server);
1459 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1461 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1462 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1463 ldlm_gl_callback_server);
1464 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1466 struct req_format RQF_LDLM_INTENT_BASIC =
1467 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1468 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1469 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1471 struct req_format RQF_LDLM_INTENT =
1472 DEFINE_REQ_FMT0("LDLM_INTENT",
1473 ldlm_intent_client, ldlm_intent_server);
1474 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1476 struct req_format RQF_LDLM_INTENT_LAYOUT =
1477 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1478 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1479 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1481 struct req_format RQF_LDLM_INTENT_GETATTR =
1482 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1483 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1484 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1486 struct req_format RQF_LDLM_INTENT_OPEN =
1487 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1488 ldlm_intent_open_client, ldlm_intent_open_server);
1489 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1491 struct req_format RQF_LDLM_INTENT_CREATE =
1492 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1493 ldlm_intent_create_client, ldlm_intent_getattr_server);
1494 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1496 struct req_format RQF_LDLM_INTENT_UNLINK =
1497 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1498 ldlm_intent_unlink_client, ldlm_intent_server);
1499 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1501 struct req_format RQF_LDLM_INTENT_GETXATTR =
1502 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1503 ldlm_intent_getxattr_client,
1504 ldlm_intent_getxattr_server);
1505 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1507 struct req_format RQF_MDS_CLOSE =
1508 DEFINE_REQ_FMT0("MDS_CLOSE",
1509 mdt_close_client, mds_last_unlink_server);
1510 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1512 struct req_format RQF_MDS_RELEASE_CLOSE =
1513 DEFINE_REQ_FMT0("MDS_CLOSE",
1514 mdt_release_close_client, mds_last_unlink_server);
1515 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1517 struct req_format RQF_MDS_PIN =
1518 DEFINE_REQ_FMT0("MDS_PIN",
1519 mdt_body_capa, mdt_body_only);
1520 EXPORT_SYMBOL(RQF_MDS_PIN);
1522 struct req_format RQF_MDS_UNPIN =
1523 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1524 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1526 struct req_format RQF_MDS_DONE_WRITING =
1527 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1528 mdt_close_client, mdt_body_only);
1529 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1531 struct req_format RQF_MDS_READPAGE =
1532 DEFINE_REQ_FMT0("MDS_READPAGE",
1533 mdt_body_capa, mdt_body_only);
1534 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1536 struct req_format RQF_MDS_HSM_ACTION =
1537 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1538 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1540 struct req_format RQF_MDS_HSM_PROGRESS =
1541 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1542 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1544 struct req_format RQF_MDS_HSM_CT_REGISTER =
1545 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1546 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1548 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1549 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1550 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1552 struct req_format RQF_MDS_HSM_STATE_GET =
1553 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1554 mdt_body_capa, mdt_hsm_state_get_server);
1555 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1557 struct req_format RQF_MDS_HSM_STATE_SET =
1558 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1559 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1561 struct req_format RQF_MDS_HSM_REQUEST =
1562 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1563 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1565 struct req_format RQF_MDS_SWAP_LAYOUTS =
1566 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1567 mdt_swap_layouts, empty);
1568 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1570 /* This is for split */
1571 struct req_format RQF_MDS_WRITEPAGE =
1572 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1573 mdt_body_capa, mdt_body_only);
1574 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1576 struct req_format RQF_MDS_IS_SUBDIR =
1577 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1578 mdt_body_only, mdt_body_only);
1579 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1581 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1582 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1583 llog_origin_handle_create_client, llogd_body_only);
1584 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1586 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1587 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1588 llogd_body_only, llogd_body_only);
1589 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1591 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1592 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1593 llogd_body_only, llog_origin_handle_next_block_server);
1594 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1596 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1597 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1598 llogd_body_only, llog_origin_handle_next_block_server);
1599 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1601 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1602 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1603 llogd_body_only, llog_log_hdr_only);
1604 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1606 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1607 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1608 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1610 struct req_format RQF_CONNECT =
1611 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1612 EXPORT_SYMBOL(RQF_CONNECT);
1614 struct req_format RQF_OST_CONNECT =
1615 DEFINE_REQ_FMT0("OST_CONNECT",
1616 obd_connect_client, obd_connect_server);
1617 EXPORT_SYMBOL(RQF_OST_CONNECT);
1619 struct req_format RQF_OST_DISCONNECT =
1620 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1621 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1623 struct req_format RQF_OST_GETATTR =
1624 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1625 EXPORT_SYMBOL(RQF_OST_GETATTR);
1627 struct req_format RQF_OST_SETATTR =
1628 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1629 EXPORT_SYMBOL(RQF_OST_SETATTR);
1631 struct req_format RQF_OST_CREATE =
1632 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1633 EXPORT_SYMBOL(RQF_OST_CREATE);
1635 struct req_format RQF_OST_PUNCH =
1636 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1637 EXPORT_SYMBOL(RQF_OST_PUNCH);
1639 struct req_format RQF_OST_SYNC =
1640 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1641 EXPORT_SYMBOL(RQF_OST_SYNC);
1643 struct req_format RQF_OST_DESTROY =
1644 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1645 EXPORT_SYMBOL(RQF_OST_DESTROY);
1647 struct req_format RQF_OST_BRW_READ =
1648 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1649 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1651 struct req_format RQF_OST_BRW_WRITE =
1652 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1653 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1655 struct req_format RQF_OST_STATFS =
1656 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1657 EXPORT_SYMBOL(RQF_OST_STATFS);
1659 struct req_format RQF_OST_SET_GRANT_INFO =
1660 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1662 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1664 struct req_format RQF_OST_GET_INFO =
1665 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1666 ost_get_info_generic_server);
1667 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1669 struct req_format RQF_OST_GET_INFO_LAST_ID =
1670 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1671 ost_get_last_id_server);
1672 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1674 struct req_format RQF_OST_GET_INFO_LAST_FID =
1675 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1676 ost_get_last_fid_server);
1677 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1679 struct req_format RQF_OST_SET_INFO_LAST_FID =
1680 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1682 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1684 struct req_format RQF_OST_GET_INFO_FIEMAP =
1685 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1686 ost_get_fiemap_server);
1687 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1689 struct req_format RQF_LFSCK_NOTIFY =
1690 DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1691 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1693 struct req_format RQF_LFSCK_QUERY =
1694 DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1695 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1697 #if !defined(__REQ_LAYOUT_USER__)
1699 /* Convenience macro */
1700 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1703 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1704 * field of RQFs and the \a rmf_offset field of RMFs.
1706 int req_layout_init(void)
1711 struct req_format *rf = NULL;
1713 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1714 rf = req_formats[i];
1716 for (j = 0; j < RCL_NR; ++j) {
1717 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1718 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1719 struct req_msg_field *field;
1721 field = (typeof(field))rf->rf_fields[j].d[k];
1722 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1723 || field->rmf_size > 0);
1724 LASSERT(field->rmf_offset[i][j] == 0);
1726 * k + 1 to detect unused format/field
1729 field->rmf_offset[i][j] = k + 1;
1735 EXPORT_SYMBOL(req_layout_init);
1737 void req_layout_fini(void)
1740 EXPORT_SYMBOL(req_layout_fini);
1743 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1745 * Actual/expected field sizes are set elsewhere in functions in this file:
1746 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1747 * req_capsule_msg_size(). The \a rc_area information is used by.
1748 * ptlrpc_request_set_replen().
1750 void req_capsule_init_area(struct req_capsule *pill)
1754 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1755 pill->rc_area[RCL_CLIENT][i] = -1;
1756 pill->rc_area[RCL_SERVER][i] = -1;
1759 EXPORT_SYMBOL(req_capsule_init_area);
1762 * Initialize a pill.
1764 * The \a location indicates whether the caller is executing on the client side
1765 * (RCL_CLIENT) or server side (RCL_SERVER)..
1767 void req_capsule_init(struct req_capsule *pill,
1768 struct ptlrpc_request *req,
1769 enum req_location location)
1771 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1774 * Today all capsules are embedded in ptlrpc_request structs,
1775 * but just in case that ever isn't the case, we don't reach
1776 * into req unless req != NULL and pill is the one embedded in
1779 * The req->rq_pill_init flag makes it safe to initialize a pill
1780 * twice, which might happen in the OST paths as a result of the
1781 * high-priority RPC queue getting peeked at before ost_handle()
1782 * handles an OST RPC.
1784 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1787 memset(pill, 0, sizeof *pill);
1789 pill->rc_loc = location;
1790 req_capsule_init_area(pill);
1792 if (req != NULL && pill == &req->rq_pill)
1793 req->rq_pill_init = 1;
1795 EXPORT_SYMBOL(req_capsule_init);
1797 void req_capsule_fini(struct req_capsule *pill)
1800 EXPORT_SYMBOL(req_capsule_fini);
1802 static int __req_format_is_sane(const struct req_format *fmt)
1805 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1806 req_formats[fmt->rf_idx] == fmt;
1809 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1810 enum req_location loc)
1812 struct ptlrpc_request *req;
1815 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1819 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1820 * (see req_capsule_extend()).
1822 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1824 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1825 LASSERT(__req_format_is_sane(fmt));
1829 EXPORT_SYMBOL(req_capsule_set);
1832 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1835 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1836 * variable-sized fields. The field sizes come from the declared \a rmf_size
1837 * field of a \a pill's \a rc_fmt's RMF's.
1839 int req_capsule_filled_sizes(struct req_capsule *pill,
1840 enum req_location loc)
1842 const struct req_format *fmt = pill->rc_fmt;
1845 LASSERT(fmt != NULL);
1847 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1848 if (pill->rc_area[loc][i] == -1) {
1849 pill->rc_area[loc][i] =
1850 fmt->rf_fields[loc].d[i]->rmf_size;
1851 if (pill->rc_area[loc][i] == -1) {
1853 * Skip the following fields.
1855 * If this LASSERT() trips then you're missing a
1856 * call to req_capsule_set_size().
1858 LASSERT(loc != RCL_SERVER);
1865 EXPORT_SYMBOL(req_capsule_filled_sizes);
1868 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1870 * This function uses the \a pill's \a rc_area as filled in by
1871 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1874 int req_capsule_server_pack(struct req_capsule *pill)
1876 const struct req_format *fmt;
1880 LASSERT(pill->rc_loc == RCL_SERVER);
1882 LASSERT(fmt != NULL);
1884 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1885 rc = lustre_pack_reply(pill->rc_req, count,
1886 pill->rc_area[RCL_SERVER], NULL);
1888 DEBUG_REQ(D_ERROR, pill->rc_req,
1889 "Cannot pack %d fields in format `%s': ",
1890 count, fmt->rf_name);
1894 EXPORT_SYMBOL(req_capsule_server_pack);
1897 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1898 * corresponding to the given RMF (\a field).
1900 static int __req_capsule_offset(const struct req_capsule *pill,
1901 const struct req_msg_field *field,
1902 enum req_location loc)
1906 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1907 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1908 pill->rc_fmt->rf_name,
1909 field->rmf_name, offset, loc);
1912 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1917 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1922 swabber_dumper_helper(struct req_capsule *pill,
1923 const struct req_msg_field *field,
1924 enum req_location loc,
1926 void *value, int len, int dump, void (*swabber)( void *))
1932 int inout = loc == RCL_CLIENT;
1934 swabber = swabber ?: field->rmf_swabber;
1936 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1937 swabber != NULL && value != NULL)
1942 if (!field->rmf_dumper)
1945 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1947 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1948 do_swab ? "unswabbed " : "", field->rmf_name);
1949 field->rmf_dumper(value);
1954 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1956 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1957 "follows\n", field->rmf_name);
1958 field->rmf_dumper(value);
1965 * We're swabbing an array; swabber() swabs a single array element, so
1966 * swab every element.
1968 LASSERT((len % field->rmf_size) == 0);
1969 for (p = value, i = 0, n = len / field->rmf_size;
1971 i++, p += field->rmf_size) {
1973 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1974 "element %d follows\n",
1975 do_swab ? "unswabbed " : "", field->rmf_name, i);
1976 field->rmf_dumper(p);
1982 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1983 "element %d follows\n", field->rmf_name, i);
1984 field->rmf_dumper(value);
1988 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1992 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1993 * corresponding to the given RMF (\a field).
1995 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1996 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1997 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1998 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1999 * element of the array swabbed.
2001 static void *__req_capsule_get(struct req_capsule *pill,
2002 const struct req_msg_field *field,
2003 enum req_location loc,
2004 void (*swabber)( void *),
2007 const struct req_format *fmt;
2008 struct lustre_msg *msg;
2013 void *(*getter)(struct lustre_msg *m, int n, int minlen);
2015 static const char *rcl_names[RCL_NR] = {
2016 [RCL_CLIENT] = "client",
2017 [RCL_SERVER] = "server"
2020 LASSERT(pill != NULL);
2021 LASSERT(pill != LP_POISON);
2023 LASSERT(fmt != NULL);
2024 LASSERT(fmt != LP_POISON);
2025 LASSERT(__req_format_is_sane(fmt));
2027 offset = __req_capsule_offset(pill, field, loc);
2029 msg = __req_msg(pill, loc);
2030 LASSERT(msg != NULL);
2032 getter = (field->rmf_flags & RMF_F_STRING) ?
2033 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2035 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2037 * We've already asserted that field->rmf_size > 0 in
2038 * req_layout_init().
2040 len = lustre_msg_buflen(msg, offset);
2041 if ((len % field->rmf_size) != 0) {
2042 CERROR("%s: array field size mismatch "
2043 "%d modulo %d != 0 (%d)\n",
2044 field->rmf_name, len, field->rmf_size, loc);
2047 } else if (pill->rc_area[loc][offset] != -1) {
2048 len = pill->rc_area[loc][offset];
2050 len = max(field->rmf_size, 0);
2052 value = getter(msg, offset, len);
2054 if (value == NULL) {
2055 DEBUG_REQ(D_ERROR, pill->rc_req,
2056 "Wrong buffer for field `%s' (%d of %d) "
2057 "in format `%s': %d vs. %d (%s)\n",
2058 field->rmf_name, offset, lustre_msg_bufcount(msg),
2059 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2062 swabber_dumper_helper(pill, field, loc, offset, value, len,
2070 * Dump a request and/or reply
2072 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2074 const struct req_format *fmt;
2075 const struct req_msg_field *field;
2081 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2082 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2083 field = FMT_FIELD(fmt, loc, i);
2084 if (field->rmf_dumper == NULL) {
2086 * FIXME Add a default hex dumper for fields that don't
2087 * have a specific dumper
2089 len = req_capsule_get_size(pill, field, loc);
2090 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2091 "field size is %d\n", field->rmf_name, len);
2093 /* It's the dumping side-effect that we're interested in */
2094 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2097 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2103 void req_capsule_client_dump(struct req_capsule *pill)
2105 __req_capsule_dump(pill, RCL_CLIENT);
2107 EXPORT_SYMBOL(req_capsule_client_dump);
2112 void req_capsule_server_dump(struct req_capsule *pill)
2114 __req_capsule_dump(pill, RCL_SERVER);
2116 EXPORT_SYMBOL(req_capsule_server_dump);
2119 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2120 * buffer corresponding to the given RMF (\a field) of a \a pill.
2122 void *req_capsule_client_get(struct req_capsule *pill,
2123 const struct req_msg_field *field)
2125 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2127 EXPORT_SYMBOL(req_capsule_client_get);
2130 * Same as req_capsule_client_get(), but with a \a swabber argument.
2132 * Currently unused; will be removed when req_capsule_server_swab_get() is
2135 void *req_capsule_client_swab_get(struct req_capsule *pill,
2136 const struct req_msg_field *field,
2139 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2141 EXPORT_SYMBOL(req_capsule_client_swab_get);
2144 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2146 * First the \a pill's request \a field's size is set (\a rc_area) using
2147 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2150 void *req_capsule_client_sized_get(struct req_capsule *pill,
2151 const struct req_msg_field *field,
2154 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2155 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2157 EXPORT_SYMBOL(req_capsule_client_sized_get);
2160 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2161 * buffer corresponding to the given RMF (\a field) of a \a pill.
2163 void *req_capsule_server_get(struct req_capsule *pill,
2164 const struct req_msg_field *field)
2166 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2168 EXPORT_SYMBOL(req_capsule_server_get);
2171 * Same as req_capsule_server_get(), but with a \a swabber argument.
2173 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2174 * swabbing done outside this capsule abstraction.
2176 void *req_capsule_server_swab_get(struct req_capsule *pill,
2177 const struct req_msg_field *field,
2180 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2182 EXPORT_SYMBOL(req_capsule_server_swab_get);
2185 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2187 * First the \a pill's request \a field's size is set (\a rc_area) using
2188 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2191 void *req_capsule_server_sized_get(struct req_capsule *pill,
2192 const struct req_msg_field *field,
2195 req_capsule_set_size(pill, field, RCL_SERVER, len);
2196 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2198 EXPORT_SYMBOL(req_capsule_server_sized_get);
2200 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2201 const struct req_msg_field *field,
2202 int len, void *swabber)
2204 req_capsule_set_size(pill, field, RCL_SERVER, len);
2205 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2207 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2210 * Returns the buffer of a \a pill corresponding to the given \a field from the
2211 * request (if the caller is executing on the server-side) or reply (if the
2212 * caller is executing on the client-side).
2214 * This function convienient for use is code that could be executed on the
2215 * client and server alike.
2217 const void *req_capsule_other_get(struct req_capsule *pill,
2218 const struct req_msg_field *field)
2220 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2222 EXPORT_SYMBOL(req_capsule_other_get);
2225 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2226 * field of the given \a pill.
2228 * This function must be used when constructing variable sized fields of a
2231 void req_capsule_set_size(struct req_capsule *pill,
2232 const struct req_msg_field *field,
2233 enum req_location loc, int size)
2235 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2237 if ((size != field->rmf_size) &&
2238 (field->rmf_size != -1) &&
2239 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2241 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2242 (size % field->rmf_size != 0)) {
2243 CERROR("%s: array field size mismatch "
2244 "%d %% %d != 0 (%d)\n",
2245 field->rmf_name, size, field->rmf_size, loc);
2247 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2248 size < field->rmf_size) {
2249 CERROR("%s: field size mismatch %d != %d (%d)\n",
2250 field->rmf_name, size, field->rmf_size, loc);
2255 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2257 EXPORT_SYMBOL(req_capsule_set_size);
2260 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2261 * for the given \a pill's given \a field.
2263 * NB: this function doesn't correspond with req_capsule_set_size(), which
2264 * actually sets the size in pill.rc_area[loc][offset], but this function
2265 * returns the message buflen[offset], maybe we should use another name.
2267 int req_capsule_get_size(const struct req_capsule *pill,
2268 const struct req_msg_field *field,
2269 enum req_location loc)
2271 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2273 return lustre_msg_buflen(__req_msg(pill, loc),
2274 __req_capsule_offset(pill, field, loc));
2276 EXPORT_SYMBOL(req_capsule_get_size);
2279 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2280 * given \a pill's request or reply (\a loc) given the field size recorded in
2281 * the \a pill's rc_area.
2283 * See also req_capsule_set_size().
2285 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2287 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2288 pill->rc_fmt->rf_fields[loc].nr,
2289 pill->rc_area[loc]);
2293 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2294 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2295 * PTLRPC request or reply given only an RQF (\a fmt).
2297 * This function should not be used for formats which contain variable size
2300 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2301 enum req_location loc)
2306 * This function should probably LASSERT() that fmt has no fields with
2307 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2308 * elements in the array there will ultimately be, but then, we could
2309 * assume that there will be at least one element, and that's just what
2312 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2316 for (; i < fmt->rf_fields[loc].nr; ++i)
2317 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2318 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2324 * Changes the format of an RPC.
2326 * The pill must already have been initialized, which means that it already has
2327 * a request format. The new format \a fmt must be an extension of the pill's
2328 * old format. Specifically: the new format must have as many request and reply
2329 * fields as the old one, and all fields shared by the old and new format must
2330 * be at least as large in the new format.
2332 * The new format's fields may be of different "type" than the old format, but
2333 * only for fields that are "opaque" blobs: fields which have a) have no
2334 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2335 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2336 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2337 * according to the key field. When the value, according to the key, contains a
2338 * structure (or array thereof) to be swabbed, the format should be changed to
2339 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2342 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2347 const struct req_format *old;
2349 LASSERT(pill->rc_fmt != NULL);
2350 LASSERT(__req_format_is_sane(fmt));
2354 * Sanity checking...
2356 for (i = 0; i < RCL_NR; ++i) {
2357 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2358 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2359 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2361 /* "opaque" fields can be transmogrified */
2362 if (ofield->rmf_swabber == NULL &&
2363 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2364 (ofield->rmf_size == -1 ||
2365 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2367 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2370 * Last field in old format can be shorter than in new.
2372 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2373 FMT_FIELD(old, i, j)->rmf_size);
2378 EXPORT_SYMBOL(req_capsule_extend);
2381 * This function returns a non-zero value if the given \a field is present in
2382 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2385 int req_capsule_has_field(const struct req_capsule *pill,
2386 const struct req_msg_field *field,
2387 enum req_location loc)
2389 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2391 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2393 EXPORT_SYMBOL(req_capsule_has_field);
2396 * Returns a non-zero value if the given \a field is present in the given \a
2397 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2399 int req_capsule_field_present(const struct req_capsule *pill,
2400 const struct req_msg_field *field,
2401 enum req_location loc)
2405 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2406 LASSERT(req_capsule_has_field(pill, field, loc));
2408 offset = __req_capsule_offset(pill, field, loc);
2409 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2411 EXPORT_SYMBOL(req_capsule_field_present);
2414 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2415 * request or reply (\a loc).
2417 * This is not the opposite of req_capsule_extend().
2419 void req_capsule_shrink(struct req_capsule *pill,
2420 const struct req_msg_field *field,
2421 unsigned int newlen,
2422 enum req_location loc)
2424 const struct req_format *fmt;
2425 struct lustre_msg *msg;
2430 LASSERT(fmt != NULL);
2431 LASSERT(__req_format_is_sane(fmt));
2432 LASSERT(req_capsule_has_field(pill, field, loc));
2433 LASSERT(req_capsule_field_present(pill, field, loc));
2435 offset = __req_capsule_offset(pill, field, loc);
2437 msg = __req_msg(pill, loc);
2438 len = lustre_msg_buflen(msg, offset);
2439 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2440 fmt->rf_name, field->rmf_name, len, newlen);
2442 if (loc == RCL_CLIENT)
2443 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2446 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2449 EXPORT_SYMBOL(req_capsule_shrink);
2451 int req_capsule_server_grow(struct req_capsule *pill,
2452 const struct req_msg_field *field,
2453 unsigned int newlen)
2455 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2457 int offset, len, rc;
2459 LASSERT(pill->rc_fmt != NULL);
2460 LASSERT(__req_format_is_sane(pill->rc_fmt));
2461 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2462 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2464 len = req_capsule_get_size(pill, field, RCL_SERVER);
2465 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2466 if (pill->rc_req->rq_repbuf_len >=
2467 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2468 CERROR("Inplace repack might be done\n");
2470 pill->rc_req->rq_reply_state = NULL;
2471 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2472 rc = req_capsule_server_pack(pill);
2474 /* put old rs back, the caller will decide what to do */
2475 pill->rc_req->rq_reply_state = rs;
2478 nrs = pill->rc_req->rq_reply_state;
2479 /* Now we need only buffers, copy first chunk */
2480 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2481 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2482 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2483 memcpy(to, from, len);
2484 /* check if we have tail and copy it too */
2485 if (rs->rs_msg->lm_bufcount > offset + 1) {
2486 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2487 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2488 offset = rs->rs_msg->lm_bufcount - 1;
2489 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2490 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2491 memcpy(to, from, len);
2493 /* drop old reply if everything is fine */
2494 if (rs->rs_difficult) {
2498 nrs->rs_difficult = 1;
2499 nrs->rs_no_ack = rs->rs_no_ack;
2500 for (i = 0; i < rs->rs_nlocks; i++) {
2501 nrs->rs_locks[i] = rs->rs_locks[i];
2502 nrs->rs_modes[i] = rs->rs_modes[i];
2506 rs->rs_difficult = 0;
2509 ptlrpc_rs_decref(rs);
2512 EXPORT_SYMBOL(req_capsule_server_grow);
2513 /* __REQ_LAYOUT_USER__ */