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 struct req_format *req_formats[] = {
704 &RQF_MGS_CONFIG_READ,
714 &RQF_MDS_GETATTR_NAME,
718 &RQF_MDS_RELEASE_CLOSE,
724 &RQF_MDS_DONE_WRITING,
726 &RQF_MDS_REINT_CREATE,
727 &RQF_MDS_REINT_CREATE_RMT_ACL,
728 &RQF_MDS_REINT_CREATE_SLAVE,
729 &RQF_MDS_REINT_CREATE_SYM,
731 &RQF_MDS_REINT_UNLINK,
733 &RQF_MDS_REINT_RENAME,
734 &RQF_MDS_REINT_SETATTR,
735 &RQF_MDS_REINT_SETXATTR,
738 &RQF_MDS_HSM_PROGRESS,
739 &RQF_MDS_HSM_CT_REGISTER,
740 &RQF_MDS_HSM_CT_UNREGISTER,
741 &RQF_MDS_HSM_STATE_GET,
742 &RQF_MDS_HSM_STATE_SET,
744 &RQF_MDS_HSM_REQUEST,
745 &RQF_MDS_SWAP_LAYOUTS,
761 &RQF_OST_SET_GRANT_INFO,
763 &RQF_OST_GET_INFO_LAST_ID,
764 &RQF_OST_GET_INFO_LAST_FID,
765 &RQF_OST_SET_INFO_LAST_FID,
766 &RQF_OST_GET_INFO_FIEMAP,
768 &RQF_LDLM_ENQUEUE_LVB,
772 &RQF_LDLM_CP_CALLBACK,
773 &RQF_LDLM_BL_CALLBACK,
774 &RQF_LDLM_GL_CALLBACK,
775 &RQF_LDLM_GL_DESC_CALLBACK,
777 &RQF_LDLM_INTENT_BASIC,
778 &RQF_LDLM_INTENT_LAYOUT,
779 &RQF_LDLM_INTENT_GETATTR,
780 &RQF_LDLM_INTENT_OPEN,
781 &RQF_LDLM_INTENT_CREATE,
782 &RQF_LDLM_INTENT_UNLINK,
783 &RQF_LDLM_INTENT_GETXATTR,
784 &RQF_LDLM_INTENT_QUOTA,
787 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
788 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
789 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
790 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
791 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
792 &RQF_LLOG_ORIGIN_CONNECT,
796 struct req_msg_field {
797 const __u32 rmf_flags;
798 const char *rmf_name;
800 * Field length. (-1) means "variable length". If the
801 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
802 * but the actual size must be a whole multiple of \a rmf_size.
805 void (*rmf_swabber)(void *);
806 void (*rmf_dumper)(void *);
807 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
812 * The field is a string, must be NUL-terminated.
814 RMF_F_STRING = 1 << 0,
816 * The field's buffer size need not match the declared \a rmf_size.
818 RMF_F_NO_SIZE_CHECK = 1 << 1,
820 * The field's buffer size must be a whole multiple of the declared \a
821 * rmf_size and the \a rmf_swabber function must work on the declared \a
822 * rmf_size worth of bytes.
824 RMF_F_STRUCT_ARRAY = 1 << 2
832 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
833 .rmf_name = (name), \
834 .rmf_flags = (flags), \
835 .rmf_size = (size), \
836 .rmf_swabber = (void (*)(void*))(swabber), \
837 .rmf_dumper = (void (*)(void*))(dumper) \
840 struct req_msg_field RMF_GENERIC_DATA =
841 DEFINE_MSGF("generic_data", 0,
843 EXPORT_SYMBOL(RMF_GENERIC_DATA);
845 struct req_msg_field RMF_MGS_TARGET_INFO =
846 DEFINE_MSGF("mgs_target_info", 0,
847 sizeof(struct mgs_target_info),
848 lustre_swab_mgs_target_info, NULL);
849 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
851 struct req_msg_field RMF_MGS_SEND_PARAM =
852 DEFINE_MSGF("mgs_send_param", 0,
853 sizeof(struct mgs_send_param),
855 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
857 struct req_msg_field RMF_MGS_CONFIG_BODY =
858 DEFINE_MSGF("mgs_config_read request", 0,
859 sizeof(struct mgs_config_body),
860 lustre_swab_mgs_config_body, NULL);
861 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
863 struct req_msg_field RMF_MGS_CONFIG_RES =
864 DEFINE_MSGF("mgs_config_read reply ", 0,
865 sizeof(struct mgs_config_res),
866 lustre_swab_mgs_config_res, NULL);
867 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
869 struct req_msg_field RMF_U32 =
870 DEFINE_MSGF("generic u32", 0,
871 sizeof(__u32), lustre_swab_generic_32s, NULL);
872 EXPORT_SYMBOL(RMF_U32);
874 struct req_msg_field RMF_SETINFO_VAL =
875 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
876 EXPORT_SYMBOL(RMF_SETINFO_VAL);
878 struct req_msg_field RMF_GETINFO_KEY =
879 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
880 EXPORT_SYMBOL(RMF_GETINFO_KEY);
882 struct req_msg_field RMF_GETINFO_VALLEN =
883 DEFINE_MSGF("getinfo_vallen", 0,
884 sizeof(__u32), lustre_swab_generic_32s, NULL);
885 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
887 struct req_msg_field RMF_GETINFO_VAL =
888 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
889 EXPORT_SYMBOL(RMF_GETINFO_VAL);
891 struct req_msg_field RMF_SEQ_OPC =
892 DEFINE_MSGF("seq_query_opc", 0,
893 sizeof(__u32), lustre_swab_generic_32s, NULL);
894 EXPORT_SYMBOL(RMF_SEQ_OPC);
896 struct req_msg_field RMF_SEQ_RANGE =
897 DEFINE_MSGF("seq_query_range", 0,
898 sizeof(struct lu_seq_range),
899 lustre_swab_lu_seq_range, NULL);
900 EXPORT_SYMBOL(RMF_SEQ_RANGE);
902 struct req_msg_field RMF_FLD_OPC =
903 DEFINE_MSGF("fld_query_opc", 0,
904 sizeof(__u32), lustre_swab_generic_32s, NULL);
905 EXPORT_SYMBOL(RMF_FLD_OPC);
907 struct req_msg_field RMF_FLD_MDFLD =
908 DEFINE_MSGF("fld_query_mdfld", 0,
909 sizeof(struct lu_seq_range),
910 lustre_swab_lu_seq_range, NULL);
911 EXPORT_SYMBOL(RMF_FLD_MDFLD);
913 struct req_msg_field RMF_MDT_BODY =
914 DEFINE_MSGF("mdt_body", 0,
915 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
916 EXPORT_SYMBOL(RMF_MDT_BODY);
918 struct req_msg_field RMF_OBD_QUOTACTL =
919 DEFINE_MSGF("obd_quotactl", 0,
920 sizeof(struct obd_quotactl),
921 lustre_swab_obd_quotactl, NULL);
922 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
924 struct req_msg_field RMF_QUOTA_BODY =
925 DEFINE_MSGF("quota_body", 0,
926 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
927 EXPORT_SYMBOL(RMF_QUOTA_BODY);
929 struct req_msg_field RMF_MDT_EPOCH =
930 DEFINE_MSGF("mdt_ioepoch", 0,
931 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
932 EXPORT_SYMBOL(RMF_MDT_EPOCH);
934 struct req_msg_field RMF_PTLRPC_BODY =
935 DEFINE_MSGF("ptlrpc_body", 0,
936 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
937 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
939 struct req_msg_field RMF_CLOSE_DATA =
940 DEFINE_MSGF("data_version", 0,
941 sizeof(struct close_data), lustre_swab_close_data, NULL);
942 EXPORT_SYMBOL(RMF_CLOSE_DATA);
944 struct req_msg_field RMF_OBD_STATFS =
945 DEFINE_MSGF("obd_statfs", 0,
946 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
947 EXPORT_SYMBOL(RMF_OBD_STATFS);
949 struct req_msg_field RMF_SETINFO_KEY =
950 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
951 EXPORT_SYMBOL(RMF_SETINFO_KEY);
953 struct req_msg_field RMF_NAME =
954 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
955 EXPORT_SYMBOL(RMF_NAME);
957 struct req_msg_field RMF_SYMTGT =
958 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
959 EXPORT_SYMBOL(RMF_SYMTGT);
961 struct req_msg_field RMF_TGTUUID =
962 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
964 EXPORT_SYMBOL(RMF_TGTUUID);
966 struct req_msg_field RMF_CLUUID =
967 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
969 EXPORT_SYMBOL(RMF_CLUUID);
971 struct req_msg_field RMF_STRING =
972 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
973 EXPORT_SYMBOL(RMF_STRING);
975 struct req_msg_field RMF_LLOGD_BODY =
976 DEFINE_MSGF("llogd_body", 0,
977 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
978 EXPORT_SYMBOL(RMF_LLOGD_BODY);
980 struct req_msg_field RMF_LLOG_LOG_HDR =
981 DEFINE_MSGF("llog_log_hdr", 0,
982 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
983 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
985 struct req_msg_field RMF_LLOGD_CONN_BODY =
986 DEFINE_MSGF("llogd_conn_body", 0,
987 sizeof(struct llogd_conn_body),
988 lustre_swab_llogd_conn_body, NULL);
989 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
992 * connection handle received in MDS_CONNECT request.
994 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
995 * that the client does not interpret at all.
997 struct req_msg_field RMF_CONN =
998 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
999 EXPORT_SYMBOL(RMF_CONN);
1001 struct req_msg_field RMF_CONNECT_DATA =
1002 DEFINE_MSGF("cdata",
1003 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1004 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
1005 sizeof(struct obd_connect_data),
1007 /* For interoperability with 1.8 and 2.0 clients/servers.
1008 * The RPC verification code allows larger RPC buffers, but not
1009 * smaller buffers. Until we no longer need to keep compatibility
1010 * with older servers/clients we can only check that the buffer
1011 * size is at least as large as obd_connect_data_v1. That is not
1012 * not in itself harmful, since the chance of just corrupting this
1013 * field is low. See JIRA LU-16 for details. */
1014 sizeof(struct obd_connect_data_v1),
1016 lustre_swab_connect, NULL);
1017 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1019 struct req_msg_field RMF_DLM_REQ =
1020 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1021 sizeof(struct ldlm_request),
1022 lustre_swab_ldlm_request, NULL);
1023 EXPORT_SYMBOL(RMF_DLM_REQ);
1025 struct req_msg_field RMF_DLM_REP =
1026 DEFINE_MSGF("dlm_rep", 0,
1027 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1028 EXPORT_SYMBOL(RMF_DLM_REP);
1030 struct req_msg_field RMF_LDLM_INTENT =
1031 DEFINE_MSGF("ldlm_intent", 0,
1032 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1033 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1035 struct req_msg_field RMF_DLM_LVB =
1036 DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1037 EXPORT_SYMBOL(RMF_DLM_LVB);
1039 struct req_msg_field RMF_DLM_GL_DESC =
1040 DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1041 lustre_swab_gl_desc, NULL);
1042 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1044 struct req_msg_field RMF_MDT_MD =
1045 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1046 EXPORT_SYMBOL(RMF_MDT_MD);
1048 struct req_msg_field RMF_REC_REINT =
1049 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1050 lustre_swab_mdt_rec_reint, NULL);
1051 EXPORT_SYMBOL(RMF_REC_REINT);
1053 /* FIXME: this length should be defined as a macro */
1054 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1056 EXPORT_SYMBOL(RMF_EADATA);
1058 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1059 EXPORT_SYMBOL(RMF_EAVALS);
1061 struct req_msg_field RMF_ACL =
1062 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1063 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_ACL);
1066 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1067 struct req_msg_field RMF_LOGCOOKIES =
1068 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1069 sizeof(struct llog_cookie), NULL, NULL);
1070 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1072 struct req_msg_field RMF_CAPA1 =
1073 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1074 lustre_swab_lustre_capa, NULL);
1075 EXPORT_SYMBOL(RMF_CAPA1);
1077 struct req_msg_field RMF_CAPA2 =
1078 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1079 lustre_swab_lustre_capa, NULL);
1080 EXPORT_SYMBOL(RMF_CAPA2);
1082 struct req_msg_field RMF_LAYOUT_INTENT =
1083 DEFINE_MSGF("layout_intent", 0,
1084 sizeof(struct layout_intent), lustre_swab_layout_intent,
1086 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1089 * OST request field.
1091 struct req_msg_field RMF_OST_BODY =
1092 DEFINE_MSGF("ost_body", 0,
1093 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
1094 EXPORT_SYMBOL(RMF_OST_BODY);
1096 struct req_msg_field RMF_OBD_IOOBJ =
1097 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1098 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1099 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1101 struct req_msg_field RMF_NIOBUF_REMOTE =
1102 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1103 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1105 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1107 struct req_msg_field RMF_RCS =
1108 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1109 lustre_swab_generic_32s, dump_rcs);
1110 EXPORT_SYMBOL(RMF_RCS);
1112 struct req_msg_field RMF_EAVALS_LENS =
1113 DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1114 lustre_swab_generic_32s, NULL);
1115 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1117 struct req_msg_field RMF_OBD_ID =
1118 DEFINE_MSGF("obd_id", 0,
1119 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
1120 EXPORT_SYMBOL(RMF_OBD_ID);
1122 struct req_msg_field RMF_FID =
1123 DEFINE_MSGF("fid", 0,
1124 sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1125 EXPORT_SYMBOL(RMF_FID);
1127 struct req_msg_field RMF_OST_ID =
1128 DEFINE_MSGF("ost_id", 0,
1129 sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1130 EXPORT_SYMBOL(RMF_OST_ID);
1132 struct req_msg_field RMF_FIEMAP_KEY =
1133 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1134 lustre_swab_fiemap, NULL);
1135 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1137 struct req_msg_field RMF_FIEMAP_VAL =
1138 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1139 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1141 struct req_msg_field RMF_IDX_INFO =
1142 DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1143 lustre_swab_idx_info, NULL);
1144 EXPORT_SYMBOL(RMF_IDX_INFO);
1145 struct req_msg_field RMF_HSM_USER_STATE =
1146 DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1147 lustre_swab_hsm_user_state, NULL);
1148 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1150 struct req_msg_field RMF_HSM_STATE_SET =
1151 DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1152 lustre_swab_hsm_state_set, NULL);
1153 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1155 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1156 DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1157 lustre_swab_hsm_progress_kernel, NULL);
1158 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1160 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1161 DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1162 lustre_swab_hsm_current_action, NULL);
1163 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1165 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1166 DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1167 sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1169 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1171 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1172 DEFINE_MSGF("hsm_archive", 0,
1173 sizeof(__u32), lustre_swab_generic_32s, NULL);
1174 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1176 struct req_msg_field RMF_MDS_HSM_REQUEST =
1177 DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1178 lustre_swab_hsm_request, NULL);
1179 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1181 struct req_msg_field RMF_UPDATE = DEFINE_MSGF("update", 0, -1,
1182 lustre_swab_update_buf, NULL);
1183 EXPORT_SYMBOL(RMF_UPDATE);
1185 struct req_msg_field RMF_UPDATE_REPLY = DEFINE_MSGF("update_reply", 0, -1,
1186 lustre_swab_update_reply_buf,
1188 EXPORT_SYMBOL(RMF_UPDATE_REPLY);
1190 struct req_msg_field RMF_SWAP_LAYOUTS =
1191 DEFINE_MSGF("swap_layouts", 0, sizeof(struct mdc_swap_layouts),
1192 lustre_swab_swap_layouts, NULL);
1193 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1199 const char *rf_name;
1203 const struct req_msg_field **d;
1204 } rf_fields[RCL_NR];
1207 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
1221 #define DEFINE_REQ_FMT0(name, client, server) \
1222 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1224 struct req_format RQF_OBD_PING =
1225 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1226 EXPORT_SYMBOL(RQF_OBD_PING);
1228 struct req_format RQF_OBD_SET_INFO =
1229 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1230 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1232 /* Read index file through the network */
1233 struct req_format RQF_OBD_IDX_READ =
1234 DEFINE_REQ_FMT0("OBD_IDX_READ",
1235 obd_idx_read_client, obd_idx_read_server);
1236 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1238 struct req_format RQF_SEC_CTX =
1239 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1240 EXPORT_SYMBOL(RQF_SEC_CTX);
1242 struct req_format RQF_MGS_TARGET_REG =
1243 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1244 mgs_target_info_only);
1245 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1247 struct req_format RQF_MGS_SET_INFO =
1248 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1250 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1252 struct req_format RQF_MGS_CONFIG_READ =
1253 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1254 mgs_config_read_server);
1255 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1257 struct req_format RQF_SEQ_QUERY =
1258 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1259 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1261 struct req_format RQF_FLD_QUERY =
1262 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1263 EXPORT_SYMBOL(RQF_FLD_QUERY);
1265 struct req_format RQF_FLD_READ =
1266 DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1267 EXPORT_SYMBOL(RQF_FLD_READ);
1269 struct req_format RQF_LOG_CANCEL =
1270 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1271 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1273 struct req_format RQF_MDS_QUOTACHECK =
1274 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1275 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1277 struct req_format RQF_OST_QUOTACHECK =
1278 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1279 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1281 struct req_format RQF_MDS_QUOTACTL =
1282 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1283 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1285 struct req_format RQF_OST_QUOTACTL =
1286 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1287 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1289 struct req_format RQF_QC_CALLBACK =
1290 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1291 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1293 struct req_format RQF_QUOTA_DQACQ =
1294 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1295 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1297 struct req_format RQF_LDLM_INTENT_QUOTA =
1298 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1299 ldlm_intent_quota_client,
1300 ldlm_intent_quota_server);
1301 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1303 struct req_format RQF_MDS_GETSTATUS =
1304 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1305 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1307 struct req_format RQF_MDS_STATFS =
1308 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1309 EXPORT_SYMBOL(RQF_MDS_STATFS);
1311 struct req_format RQF_MDS_SYNC =
1312 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1313 EXPORT_SYMBOL(RQF_MDS_SYNC);
1315 struct req_format RQF_MDS_GETATTR =
1316 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1317 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1319 struct req_format RQF_MDS_GETXATTR =
1320 DEFINE_REQ_FMT0("MDS_GETXATTR",
1321 mds_getxattr_client, mds_getxattr_server);
1322 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1324 struct req_format RQF_MDS_GETATTR_NAME =
1325 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1326 mds_getattr_name_client, mds_getattr_server);
1327 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1329 struct req_format RQF_MDS_REINT =
1330 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1331 EXPORT_SYMBOL(RQF_MDS_REINT);
1333 struct req_format RQF_MDS_REINT_CREATE =
1334 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1335 mds_reint_create_client, mdt_body_capa);
1336 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1338 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1339 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1340 mds_reint_create_rmt_acl_client, mdt_body_capa);
1341 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1343 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1344 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1345 mds_reint_create_slave_client, mdt_body_capa);
1346 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1348 struct req_format RQF_MDS_REINT_CREATE_SYM =
1349 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1350 mds_reint_create_sym_client, mdt_body_capa);
1351 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1353 struct req_format RQF_MDS_REINT_OPEN =
1354 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1355 mds_reint_open_client, mds_reint_open_server);
1356 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1358 struct req_format RQF_MDS_REINT_UNLINK =
1359 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1360 mds_last_unlink_server);
1361 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1363 struct req_format RQF_MDS_REINT_LINK =
1364 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1365 mds_reint_link_client, mdt_body_only);
1366 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1368 struct req_format RQF_MDS_REINT_RENAME =
1369 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1370 mds_last_unlink_server);
1371 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1373 struct req_format RQF_MDS_REINT_SETATTR =
1374 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1375 mds_reint_setattr_client, mds_setattr_server);
1376 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1378 struct req_format RQF_MDS_REINT_SETXATTR =
1379 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1380 mds_reint_setxattr_client, mdt_body_only);
1381 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1383 struct req_format RQF_MDS_CONNECT =
1384 DEFINE_REQ_FMT0("MDS_CONNECT",
1385 obd_connect_client, obd_connect_server);
1386 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1388 struct req_format RQF_MDS_DISCONNECT =
1389 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1390 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1392 struct req_format RQF_MDS_GET_INFO =
1393 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1394 mds_getinfo_server);
1395 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1397 struct req_format RQF_UPDATE_OBJ =
1398 DEFINE_REQ_FMT0("OBJECT_UPDATE_OBJ", mds_update_client,
1400 EXPORT_SYMBOL(RQF_UPDATE_OBJ);
1402 struct req_format RQF_LDLM_ENQUEUE =
1403 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1404 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1405 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1407 struct req_format RQF_LDLM_ENQUEUE_LVB =
1408 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1409 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1410 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1412 struct req_format RQF_LDLM_CONVERT =
1413 DEFINE_REQ_FMT0("LDLM_CONVERT",
1414 ldlm_enqueue_client, ldlm_enqueue_server);
1415 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1417 struct req_format RQF_LDLM_CANCEL =
1418 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1419 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1421 struct req_format RQF_LDLM_CALLBACK =
1422 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1423 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1425 struct req_format RQF_LDLM_CP_CALLBACK =
1426 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1427 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1429 struct req_format RQF_LDLM_BL_CALLBACK =
1430 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1431 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1433 struct req_format RQF_LDLM_GL_CALLBACK =
1434 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1435 ldlm_gl_callback_server);
1436 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1438 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1439 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1440 ldlm_gl_callback_server);
1441 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1443 struct req_format RQF_LDLM_INTENT_BASIC =
1444 DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1445 ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1446 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1448 struct req_format RQF_LDLM_INTENT =
1449 DEFINE_REQ_FMT0("LDLM_INTENT",
1450 ldlm_intent_client, ldlm_intent_server);
1451 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1453 struct req_format RQF_LDLM_INTENT_LAYOUT =
1454 DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1455 ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1456 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1458 struct req_format RQF_LDLM_INTENT_GETATTR =
1459 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1460 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1461 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1463 struct req_format RQF_LDLM_INTENT_OPEN =
1464 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1465 ldlm_intent_open_client, ldlm_intent_open_server);
1466 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1468 struct req_format RQF_LDLM_INTENT_CREATE =
1469 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1470 ldlm_intent_create_client, ldlm_intent_getattr_server);
1471 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1473 struct req_format RQF_LDLM_INTENT_UNLINK =
1474 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1475 ldlm_intent_unlink_client, ldlm_intent_server);
1476 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1478 struct req_format RQF_LDLM_INTENT_GETXATTR =
1479 DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1480 ldlm_intent_getxattr_client,
1481 ldlm_intent_getxattr_server);
1482 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1484 struct req_format RQF_MDS_CLOSE =
1485 DEFINE_REQ_FMT0("MDS_CLOSE",
1486 mdt_close_client, mds_last_unlink_server);
1487 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1489 struct req_format RQF_MDS_RELEASE_CLOSE =
1490 DEFINE_REQ_FMT0("MDS_CLOSE",
1491 mdt_release_close_client, mds_last_unlink_server);
1492 EXPORT_SYMBOL(RQF_MDS_RELEASE_CLOSE);
1494 struct req_format RQF_MDS_PIN =
1495 DEFINE_REQ_FMT0("MDS_PIN",
1496 mdt_body_capa, mdt_body_only);
1497 EXPORT_SYMBOL(RQF_MDS_PIN);
1499 struct req_format RQF_MDS_UNPIN =
1500 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1501 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1503 struct req_format RQF_MDS_DONE_WRITING =
1504 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1505 mdt_close_client, mdt_body_only);
1506 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1508 struct req_format RQF_MDS_READPAGE =
1509 DEFINE_REQ_FMT0("MDS_READPAGE",
1510 mdt_body_capa, mdt_body_only);
1511 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1513 struct req_format RQF_MDS_HSM_ACTION =
1514 DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1515 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1517 struct req_format RQF_MDS_HSM_PROGRESS =
1518 DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1519 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1521 struct req_format RQF_MDS_HSM_CT_REGISTER =
1522 DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1523 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1525 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1526 DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1527 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1529 struct req_format RQF_MDS_HSM_STATE_GET =
1530 DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1531 mdt_body_capa, mdt_hsm_state_get_server);
1532 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1534 struct req_format RQF_MDS_HSM_STATE_SET =
1535 DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1536 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1538 struct req_format RQF_MDS_HSM_REQUEST =
1539 DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1540 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1542 struct req_format RQF_MDS_SWAP_LAYOUTS =
1543 DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1544 mdt_swap_layouts, empty);
1545 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1547 /* This is for split */
1548 struct req_format RQF_MDS_WRITEPAGE =
1549 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1550 mdt_body_capa, mdt_body_only);
1551 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1553 struct req_format RQF_MDS_IS_SUBDIR =
1554 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1555 mdt_body_only, mdt_body_only);
1556 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1558 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1559 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1560 llog_origin_handle_create_client, llogd_body_only);
1561 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1563 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1564 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1565 llogd_body_only, llogd_body_only);
1566 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1568 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1569 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1570 llogd_body_only, llog_origin_handle_next_block_server);
1571 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1573 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1574 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1575 llogd_body_only, llog_origin_handle_next_block_server);
1576 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1578 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1579 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1580 llogd_body_only, llog_log_hdr_only);
1581 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1583 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1584 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1585 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1587 struct req_format RQF_CONNECT =
1588 DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1589 EXPORT_SYMBOL(RQF_CONNECT);
1591 struct req_format RQF_OST_CONNECT =
1592 DEFINE_REQ_FMT0("OST_CONNECT",
1593 obd_connect_client, obd_connect_server);
1594 EXPORT_SYMBOL(RQF_OST_CONNECT);
1596 struct req_format RQF_OST_DISCONNECT =
1597 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1598 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1600 struct req_format RQF_OST_GETATTR =
1601 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1602 EXPORT_SYMBOL(RQF_OST_GETATTR);
1604 struct req_format RQF_OST_SETATTR =
1605 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1606 EXPORT_SYMBOL(RQF_OST_SETATTR);
1608 struct req_format RQF_OST_CREATE =
1609 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1610 EXPORT_SYMBOL(RQF_OST_CREATE);
1612 struct req_format RQF_OST_PUNCH =
1613 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1614 EXPORT_SYMBOL(RQF_OST_PUNCH);
1616 struct req_format RQF_OST_SYNC =
1617 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1618 EXPORT_SYMBOL(RQF_OST_SYNC);
1620 struct req_format RQF_OST_DESTROY =
1621 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1622 EXPORT_SYMBOL(RQF_OST_DESTROY);
1624 struct req_format RQF_OST_BRW_READ =
1625 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1626 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1628 struct req_format RQF_OST_BRW_WRITE =
1629 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1630 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1632 struct req_format RQF_OST_STATFS =
1633 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1634 EXPORT_SYMBOL(RQF_OST_STATFS);
1636 struct req_format RQF_OST_SET_GRANT_INFO =
1637 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1639 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1641 struct req_format RQF_OST_GET_INFO =
1642 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1643 ost_get_info_generic_server);
1644 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1646 struct req_format RQF_OST_GET_INFO_LAST_ID =
1647 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1648 ost_get_last_id_server);
1649 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1651 struct req_format RQF_OST_GET_INFO_LAST_FID =
1652 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1653 ost_get_last_fid_server);
1654 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1656 struct req_format RQF_OST_SET_INFO_LAST_FID =
1657 DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1659 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1661 struct req_format RQF_OST_GET_INFO_FIEMAP =
1662 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1663 ost_get_fiemap_server);
1664 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1666 #if !defined(__REQ_LAYOUT_USER__)
1668 /* Convenience macro */
1669 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1672 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1673 * field of RQFs and the \a rmf_offset field of RMFs.
1675 int req_layout_init(void)
1680 struct req_format *rf = NULL;
1682 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1683 rf = req_formats[i];
1685 for (j = 0; j < RCL_NR; ++j) {
1686 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1687 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1688 struct req_msg_field *field;
1690 field = (typeof(field))rf->rf_fields[j].d[k];
1691 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1692 || field->rmf_size > 0);
1693 LASSERT(field->rmf_offset[i][j] == 0);
1695 * k + 1 to detect unused format/field
1698 field->rmf_offset[i][j] = k + 1;
1704 EXPORT_SYMBOL(req_layout_init);
1706 void req_layout_fini(void)
1709 EXPORT_SYMBOL(req_layout_fini);
1712 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1714 * Actual/expected field sizes are set elsewhere in functions in this file:
1715 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1716 * req_capsule_msg_size(). The \a rc_area information is used by.
1717 * ptlrpc_request_set_replen().
1719 void req_capsule_init_area(struct req_capsule *pill)
1723 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1724 pill->rc_area[RCL_CLIENT][i] = -1;
1725 pill->rc_area[RCL_SERVER][i] = -1;
1728 EXPORT_SYMBOL(req_capsule_init_area);
1731 * Initialize a pill.
1733 * The \a location indicates whether the caller is executing on the client side
1734 * (RCL_CLIENT) or server side (RCL_SERVER)..
1736 void req_capsule_init(struct req_capsule *pill,
1737 struct ptlrpc_request *req,
1738 enum req_location location)
1740 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1743 * Today all capsules are embedded in ptlrpc_request structs,
1744 * but just in case that ever isn't the case, we don't reach
1745 * into req unless req != NULL and pill is the one embedded in
1748 * The req->rq_pill_init flag makes it safe to initialize a pill
1749 * twice, which might happen in the OST paths as a result of the
1750 * high-priority RPC queue getting peeked at before ost_handle()
1751 * handles an OST RPC.
1753 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1756 memset(pill, 0, sizeof *pill);
1758 pill->rc_loc = location;
1759 req_capsule_init_area(pill);
1761 if (req != NULL && pill == &req->rq_pill)
1762 req->rq_pill_init = 1;
1764 EXPORT_SYMBOL(req_capsule_init);
1766 void req_capsule_fini(struct req_capsule *pill)
1769 EXPORT_SYMBOL(req_capsule_fini);
1771 static int __req_format_is_sane(const struct req_format *fmt)
1774 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1775 req_formats[fmt->rf_idx] == fmt;
1778 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1779 enum req_location loc)
1781 struct ptlrpc_request *req;
1784 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1788 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1789 * (see req_capsule_extend()).
1791 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1793 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1794 LASSERT(__req_format_is_sane(fmt));
1798 EXPORT_SYMBOL(req_capsule_set);
1801 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1804 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1805 * variable-sized fields. The field sizes come from the declared \a rmf_size
1806 * field of a \a pill's \a rc_fmt's RMF's.
1808 int req_capsule_filled_sizes(struct req_capsule *pill,
1809 enum req_location loc)
1811 const struct req_format *fmt = pill->rc_fmt;
1814 LASSERT(fmt != NULL);
1816 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1817 if (pill->rc_area[loc][i] == -1) {
1818 pill->rc_area[loc][i] =
1819 fmt->rf_fields[loc].d[i]->rmf_size;
1820 if (pill->rc_area[loc][i] == -1) {
1822 * Skip the following fields.
1824 * If this LASSERT() trips then you're missing a
1825 * call to req_capsule_set_size().
1827 LASSERT(loc != RCL_SERVER);
1834 EXPORT_SYMBOL(req_capsule_filled_sizes);
1837 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1839 * This function uses the \a pill's \a rc_area as filled in by
1840 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1843 int req_capsule_server_pack(struct req_capsule *pill)
1845 const struct req_format *fmt;
1849 LASSERT(pill->rc_loc == RCL_SERVER);
1851 LASSERT(fmt != NULL);
1853 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1854 rc = lustre_pack_reply(pill->rc_req, count,
1855 pill->rc_area[RCL_SERVER], NULL);
1857 DEBUG_REQ(D_ERROR, pill->rc_req,
1858 "Cannot pack %d fields in format `%s': ",
1859 count, fmt->rf_name);
1863 EXPORT_SYMBOL(req_capsule_server_pack);
1866 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1867 * corresponding to the given RMF (\a field).
1869 static int __req_capsule_offset(const struct req_capsule *pill,
1870 const struct req_msg_field *field,
1871 enum req_location loc)
1875 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1876 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1877 pill->rc_fmt->rf_name,
1878 field->rmf_name, offset, loc);
1881 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1886 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1891 swabber_dumper_helper(struct req_capsule *pill,
1892 const struct req_msg_field *field,
1893 enum req_location loc,
1895 void *value, int len, int dump, void (*swabber)( void *))
1901 int inout = loc == RCL_CLIENT;
1903 swabber = swabber ?: field->rmf_swabber;
1905 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1906 swabber != NULL && value != NULL)
1911 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1912 if (dump && field->rmf_dumper) {
1913 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1914 do_swab ? "unswabbed " : "", field->rmf_name);
1915 field->rmf_dumper(value);
1920 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1921 if (dump && field->rmf_dumper) {
1922 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1923 "follows\n", field->rmf_name);
1924 field->rmf_dumper(value);
1931 * We're swabbing an array; swabber() swabs a single array element, so
1932 * swab every element.
1934 LASSERT((len % field->rmf_size) == 0);
1935 for (p = value, i = 0, n = len / field->rmf_size;
1937 i++, p += field->rmf_size) {
1938 if (dump && field->rmf_dumper) {
1939 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1940 "element %d follows\n",
1941 do_swab ? "unswabbed " : "", field->rmf_name, i);
1942 field->rmf_dumper(p);
1947 if (dump && field->rmf_dumper) {
1948 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1949 "element %d follows\n", field->rmf_name, i);
1950 field->rmf_dumper(value);
1954 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1958 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1959 * corresponding to the given RMF (\a field).
1961 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1962 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1963 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1964 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1965 * element of the array swabbed.
1967 static void *__req_capsule_get(struct req_capsule *pill,
1968 const struct req_msg_field *field,
1969 enum req_location loc,
1970 void (*swabber)( void *),
1973 const struct req_format *fmt;
1974 struct lustre_msg *msg;
1979 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1981 static const char *rcl_names[RCL_NR] = {
1982 [RCL_CLIENT] = "client",
1983 [RCL_SERVER] = "server"
1986 LASSERT(pill != NULL);
1987 LASSERT(pill != LP_POISON);
1989 LASSERT(fmt != NULL);
1990 LASSERT(fmt != LP_POISON);
1991 LASSERT(__req_format_is_sane(fmt));
1993 offset = __req_capsule_offset(pill, field, loc);
1995 msg = __req_msg(pill, loc);
1996 LASSERT(msg != NULL);
1998 getter = (field->rmf_flags & RMF_F_STRING) ?
1999 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2001 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
2003 * We've already asserted that field->rmf_size > 0 in
2004 * req_layout_init().
2006 len = lustre_msg_buflen(msg, offset);
2007 if ((len % field->rmf_size) != 0) {
2008 CERROR("%s: array field size mismatch "
2009 "%d modulo %d != 0 (%d)\n",
2010 field->rmf_name, len, field->rmf_size, loc);
2013 } else if (pill->rc_area[loc][offset] != -1) {
2014 len = pill->rc_area[loc][offset];
2016 len = max(field->rmf_size, 0);
2018 value = getter(msg, offset, len);
2020 if (value == NULL) {
2021 DEBUG_REQ(D_ERROR, pill->rc_req,
2022 "Wrong buffer for field `%s' (%d of %d) "
2023 "in format `%s': %d vs. %d (%s)\n",
2024 field->rmf_name, offset, lustre_msg_bufcount(msg),
2025 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2028 swabber_dumper_helper(pill, field, loc, offset, value, len,
2036 * Dump a request and/or reply
2038 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2040 const struct req_format *fmt;
2041 const struct req_msg_field *field;
2047 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2048 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2049 field = FMT_FIELD(fmt, loc, i);
2050 if (field->rmf_dumper == NULL) {
2052 * FIXME Add a default hex dumper for fields that don't
2053 * have a specific dumper
2055 len = req_capsule_get_size(pill, field, loc);
2056 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2057 "field size is %d\n", field->rmf_name, len);
2059 /* It's the dumping side-effect that we're interested in */
2060 (void) __req_capsule_get(pill, field, loc, NULL, 1);
2063 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2069 void req_capsule_client_dump(struct req_capsule *pill)
2071 __req_capsule_dump(pill, RCL_CLIENT);
2073 EXPORT_SYMBOL(req_capsule_client_dump);
2078 void req_capsule_server_dump(struct req_capsule *pill)
2080 __req_capsule_dump(pill, RCL_SERVER);
2082 EXPORT_SYMBOL(req_capsule_server_dump);
2085 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2086 * buffer corresponding to the given RMF (\a field) of a \a pill.
2088 void *req_capsule_client_get(struct req_capsule *pill,
2089 const struct req_msg_field *field)
2091 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2093 EXPORT_SYMBOL(req_capsule_client_get);
2096 * Same as req_capsule_client_get(), but with a \a swabber argument.
2098 * Currently unused; will be removed when req_capsule_server_swab_get() is
2101 void *req_capsule_client_swab_get(struct req_capsule *pill,
2102 const struct req_msg_field *field,
2105 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2107 EXPORT_SYMBOL(req_capsule_client_swab_get);
2110 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2112 * First the \a pill's request \a field's size is set (\a rc_area) using
2113 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2116 void *req_capsule_client_sized_get(struct req_capsule *pill,
2117 const struct req_msg_field *field,
2120 req_capsule_set_size(pill, field, RCL_CLIENT, len);
2121 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2123 EXPORT_SYMBOL(req_capsule_client_sized_get);
2126 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2127 * buffer corresponding to the given RMF (\a field) of a \a pill.
2129 void *req_capsule_server_get(struct req_capsule *pill,
2130 const struct req_msg_field *field)
2132 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2134 EXPORT_SYMBOL(req_capsule_server_get);
2137 * Same as req_capsule_server_get(), but with a \a swabber argument.
2139 * Ideally all swabbing should be done pursuant to RMF definitions, with no
2140 * swabbing done outside this capsule abstraction.
2142 void *req_capsule_server_swab_get(struct req_capsule *pill,
2143 const struct req_msg_field *field,
2146 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2148 EXPORT_SYMBOL(req_capsule_server_swab_get);
2151 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2153 * First the \a pill's request \a field's size is set (\a rc_area) using
2154 * req_capsule_set_size() with the given \a len. Then the actual buffer is
2157 void *req_capsule_server_sized_get(struct req_capsule *pill,
2158 const struct req_msg_field *field,
2161 req_capsule_set_size(pill, field, RCL_SERVER, len);
2162 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2164 EXPORT_SYMBOL(req_capsule_server_sized_get);
2166 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2167 const struct req_msg_field *field,
2168 int len, void *swabber)
2170 req_capsule_set_size(pill, field, RCL_SERVER, len);
2171 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2173 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2176 * Returns the buffer of a \a pill corresponding to the given \a field from the
2177 * request (if the caller is executing on the server-side) or reply (if the
2178 * caller is executing on the client-side).
2180 * This function convienient for use is code that could be executed on the
2181 * client and server alike.
2183 const void *req_capsule_other_get(struct req_capsule *pill,
2184 const struct req_msg_field *field)
2186 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2188 EXPORT_SYMBOL(req_capsule_other_get);
2191 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2192 * field of the given \a pill.
2194 * This function must be used when constructing variable sized fields of a
2197 void req_capsule_set_size(struct req_capsule *pill,
2198 const struct req_msg_field *field,
2199 enum req_location loc, int size)
2201 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2203 if ((size != field->rmf_size) &&
2204 (field->rmf_size != -1) &&
2205 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2207 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2208 (size % field->rmf_size != 0)) {
2209 CERROR("%s: array field size mismatch "
2210 "%d %% %d != 0 (%d)\n",
2211 field->rmf_name, size, field->rmf_size, loc);
2213 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2214 size < field->rmf_size) {
2215 CERROR("%s: field size mismatch %d != %d (%d)\n",
2216 field->rmf_name, size, field->rmf_size, loc);
2221 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2223 EXPORT_SYMBOL(req_capsule_set_size);
2226 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2227 * for the given \a pill's given \a field.
2229 * NB: this function doesn't correspond with req_capsule_set_size(), which
2230 * actually sets the size in pill.rc_area[loc][offset], but this function
2231 * returns the message buflen[offset], maybe we should use another name.
2233 int req_capsule_get_size(const struct req_capsule *pill,
2234 const struct req_msg_field *field,
2235 enum req_location loc)
2237 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2239 return lustre_msg_buflen(__req_msg(pill, loc),
2240 __req_capsule_offset(pill, field, loc));
2242 EXPORT_SYMBOL(req_capsule_get_size);
2245 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2246 * given \a pill's request or reply (\a loc) given the field size recorded in
2247 * the \a pill's rc_area.
2249 * See also req_capsule_set_size().
2251 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2253 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2254 pill->rc_fmt->rf_fields[loc].nr,
2255 pill->rc_area[loc]);
2259 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2260 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2261 * PTLRPC request or reply given only an RQF (\a fmt).
2263 * This function should not be used for formats which contain variable size
2266 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2267 enum req_location loc)
2272 * This function should probably LASSERT() that fmt has no fields with
2273 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2274 * elements in the array there will ultimately be, but then, we could
2275 * assume that there will be at least one element, and that's just what
2278 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2282 for (; i < fmt->rf_fields[loc].nr; ++i)
2283 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2284 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2290 * Changes the format of an RPC.
2292 * The pill must already have been initialized, which means that it already has
2293 * a request format. The new format \a fmt must be an extension of the pill's
2294 * old format. Specifically: the new format must have as many request and reply
2295 * fields as the old one, and all fields shared by the old and new format must
2296 * be at least as large in the new format.
2298 * The new format's fields may be of different "type" than the old format, but
2299 * only for fields that are "opaque" blobs: fields which have a) have no
2300 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2301 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
2302 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2303 * according to the key field. When the value, according to the key, contains a
2304 * structure (or array thereof) to be swabbed, the format should be changed to
2305 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2308 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2313 const struct req_format *old;
2315 LASSERT(pill->rc_fmt != NULL);
2316 LASSERT(__req_format_is_sane(fmt));
2320 * Sanity checking...
2322 for (i = 0; i < RCL_NR; ++i) {
2323 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2324 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2325 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2327 /* "opaque" fields can be transmogrified */
2328 if (ofield->rmf_swabber == NULL &&
2329 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2330 (ofield->rmf_size == -1 ||
2331 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2333 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2336 * Last field in old format can be shorter than in new.
2338 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2339 FMT_FIELD(old, i, j)->rmf_size);
2344 EXPORT_SYMBOL(req_capsule_extend);
2347 * This function returns a non-zero value if the given \a field is present in
2348 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2351 int req_capsule_has_field(const struct req_capsule *pill,
2352 const struct req_msg_field *field,
2353 enum req_location loc)
2355 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2357 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2359 EXPORT_SYMBOL(req_capsule_has_field);
2362 * Returns a non-zero value if the given \a field is present in the given \a
2363 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2365 int req_capsule_field_present(const struct req_capsule *pill,
2366 const struct req_msg_field *field,
2367 enum req_location loc)
2371 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2372 LASSERT(req_capsule_has_field(pill, field, loc));
2374 offset = __req_capsule_offset(pill, field, loc);
2375 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2377 EXPORT_SYMBOL(req_capsule_field_present);
2380 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2381 * request or reply (\a loc).
2383 * This is not the opposite of req_capsule_extend().
2385 void req_capsule_shrink(struct req_capsule *pill,
2386 const struct req_msg_field *field,
2387 unsigned int newlen,
2388 enum req_location loc)
2390 const struct req_format *fmt;
2391 struct lustre_msg *msg;
2396 LASSERT(fmt != NULL);
2397 LASSERT(__req_format_is_sane(fmt));
2398 LASSERT(req_capsule_has_field(pill, field, loc));
2399 LASSERT(req_capsule_field_present(pill, field, loc));
2401 offset = __req_capsule_offset(pill, field, loc);
2403 msg = __req_msg(pill, loc);
2404 len = lustre_msg_buflen(msg, offset);
2405 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2406 fmt->rf_name, field->rmf_name, len, newlen);
2408 if (loc == RCL_CLIENT)
2409 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2412 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2415 EXPORT_SYMBOL(req_capsule_shrink);
2417 int req_capsule_server_grow(struct req_capsule *pill,
2418 const struct req_msg_field *field,
2419 unsigned int newlen)
2421 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2423 int offset, len, rc;
2425 LASSERT(pill->rc_fmt != NULL);
2426 LASSERT(__req_format_is_sane(pill->rc_fmt));
2427 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2428 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2430 len = req_capsule_get_size(pill, field, RCL_SERVER);
2431 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2432 if (pill->rc_req->rq_repbuf_len >=
2433 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2434 CERROR("Inplace repack might be done\n");
2436 pill->rc_req->rq_reply_state = NULL;
2437 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2438 rc = req_capsule_server_pack(pill);
2440 /* put old rs back, the caller will decide what to do */
2441 pill->rc_req->rq_reply_state = rs;
2444 nrs = pill->rc_req->rq_reply_state;
2445 /* Now we need only buffers, copy first chunk */
2446 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2447 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2448 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2449 memcpy(to, from, len);
2450 /* check if we have tail and copy it too */
2451 if (rs->rs_msg->lm_bufcount > offset + 1) {
2452 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2453 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2454 offset = rs->rs_msg->lm_bufcount - 1;
2455 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2456 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2457 memcpy(to, from, len);
2459 /* drop old reply if everything is fine */
2460 if (rs->rs_difficult) {
2464 nrs->rs_difficult = 1;
2465 nrs->rs_no_ack = rs->rs_no_ack;
2466 for (i = 0; i < rs->rs_nlocks; i++) {
2467 nrs->rs_locks[i] = rs->rs_locks[i];
2468 nrs->rs_modes[i] = rs->rs_modes[i];
2472 rs->rs_difficult = 0;
2475 ptlrpc_rs_decref(rs);
2478 EXPORT_SYMBOL(req_capsule_server_grow);
2479 /* __REQ_LAYOUT_USER__ */