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, Whamcloud, Inc.
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_acl.h>
73 #include <lustre_debug.h>
76 * RQFs (see below) refer to two struct req_msg_field arrays describing the
77 * client request and server reply, respectively.
79 /* empty set of fields... for suitable definition of emptiness. */
80 static const struct req_msg_field *empty[] = {
84 static const struct req_msg_field *mgs_target_info_only[] = {
89 static const struct req_msg_field *mgs_set_info[] = {
94 static const struct req_msg_field *mgs_config_read_client[] = {
99 static const struct req_msg_field *mgs_config_read_server[] = {
104 static const struct req_msg_field *log_cancel_client[] = {
109 static const struct req_msg_field *mdt_body_only[] = {
114 static const struct req_msg_field *mdt_body_capa[] = {
120 static const struct req_msg_field *quotactl_only[] = {
124 static const struct req_msg_field *quota_adjust_qunit_only[] = {
126 &RMF_QUOTA_ADJUST_QUNIT
129 static const struct req_msg_field *qunit_data_only[] = {
134 static const struct req_msg_field *quota_body_only[] = {
139 static const struct req_msg_field *ldlm_intent_quota_client[] = {
146 static const struct req_msg_field *ldlm_intent_quota_server[] = {
153 static const struct req_msg_field *mdt_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 *mds_getattr_name_client[] = {
194 static const struct req_msg_field *mds_reint_client[] = {
199 static const struct req_msg_field *mds_reint_create_client[] = {
206 static const struct req_msg_field *mds_reint_create_slave_client[] = {
215 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
224 static const struct req_msg_field *mds_reint_create_sym_client[] = {
233 static const struct req_msg_field *mds_reint_open_client[] = {
242 static const struct req_msg_field *mds_reint_open_server[] = {
251 static const struct req_msg_field *mds_reint_unlink_client[] = {
259 static const struct req_msg_field *mds_reint_link_client[] = {
268 static const struct req_msg_field *mds_reint_rename_client[] = {
278 static const struct req_msg_field *mds_last_unlink_server[] = {
287 static const struct req_msg_field *mds_reint_setattr_client[] = {
297 static const struct req_msg_field *mds_reint_setxattr_client[] = {
305 static const struct req_msg_field *obd_connect_client[] = {
313 static const struct req_msg_field *obd_connect_server[] = {
318 static const struct req_msg_field *obd_set_info_client[] = {
324 static const struct req_msg_field *ost_grant_shrink_client[] = {
330 static const struct req_msg_field *mds_getinfo_client[] = {
336 static const struct req_msg_field *mds_getinfo_server[] = {
341 static const struct req_msg_field *ldlm_enqueue_client[] = {
346 static const struct req_msg_field *ldlm_enqueue_server[] = {
351 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
357 static const struct req_msg_field *ldlm_cp_callback_client[] = {
363 static const struct req_msg_field *ldlm_gl_callback_server[] = {
368 static const struct req_msg_field *ldlm_intent_client[] = {
375 static const struct req_msg_field *ldlm_intent_server[] = {
383 static const struct req_msg_field *ldlm_intent_open_server[] = {
393 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
397 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
402 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
411 static const struct req_msg_field *ldlm_intent_create_client[] = {
415 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
421 static const struct req_msg_field *ldlm_intent_open_client[] = {
425 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
432 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
436 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
441 static const struct req_msg_field *mds_getxattr_client[] = {
449 static const struct req_msg_field *mds_getxattr_server[] = {
455 static const struct req_msg_field *mds_getattr_server[] = {
464 static const struct req_msg_field *mds_setattr_server[] = {
473 static const struct req_msg_field *llog_origin_handle_create_client[] = {
479 static const struct req_msg_field *llogd_body_only[] = {
484 static const struct req_msg_field *llog_log_hdr_only[] = {
489 static const struct req_msg_field *llogd_conn_body_only[] = {
494 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
500 static const struct req_msg_field *ost_body_only[] = {
505 static const struct req_msg_field *ost_body_capa[] = {
511 static const struct req_msg_field *ost_destroy_client[] = {
519 static const struct req_msg_field *ost_brw_client[] = {
527 static const struct req_msg_field *ost_brw_read_server[] = {
532 static const struct req_msg_field *ost_brw_write_server[] = {
538 static const struct req_msg_field *ost_get_info_generic_server[] = {
543 static const struct req_msg_field *ost_get_info_generic_client[] = {
548 static const struct req_msg_field *ost_get_last_id_server[] = {
553 static const struct req_msg_field *ost_get_fiemap_client[] = {
559 static const struct req_msg_field *ost_get_fiemap_server[] = {
564 static struct req_format *req_formats[] = {
570 &RQF_MGS_CONFIG_READ,
579 &RQF_MDS_GETATTR_NAME,
588 &RQF_MDS_DONE_WRITING,
590 &RQF_MDS_REINT_CREATE,
591 &RQF_MDS_REINT_CREATE_RMT_ACL,
592 &RQF_MDS_REINT_CREATE_SLAVE,
593 &RQF_MDS_REINT_CREATE_SYM,
595 &RQF_MDS_REINT_UNLINK,
597 &RQF_MDS_REINT_RENAME,
598 &RQF_MDS_REINT_SETATTR,
599 &RQF_MDS_REINT_SETXATTR,
602 &RQF_MDS_QUOTA_DQACQ,
608 &RQF_OST_QUOTA_ADJUST_QUNIT,
618 &RQF_OST_SET_GRANT_INFO,
619 &RQF_OST_GET_INFO_GENERIC,
620 &RQF_OST_GET_INFO_LAST_ID,
621 &RQF_OST_GET_INFO_FIEMAP,
623 &RQF_LDLM_ENQUEUE_LVB,
627 &RQF_LDLM_CP_CALLBACK,
628 &RQF_LDLM_BL_CALLBACK,
629 &RQF_LDLM_GL_CALLBACK,
631 &RQF_LDLM_INTENT_GETATTR,
632 &RQF_LDLM_INTENT_OPEN,
633 &RQF_LDLM_INTENT_CREATE,
634 &RQF_LDLM_INTENT_UNLINK,
635 &RQF_LDLM_INTENT_QUOTA,
638 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
639 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
640 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
641 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
642 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
643 &RQF_LLOG_ORIGIN_CONNECT
646 struct req_msg_field {
647 const __u32 rmf_flags;
648 const char *rmf_name;
650 * Field length. (-1) means "variable length". If the
651 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
652 * but the actual size must be a whole multiple of \a rmf_size.
655 void (*rmf_swabber)(void *);
656 void (*rmf_dumper)(void *);
657 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
662 * The field is a string, must be NUL-terminated.
664 RMF_F_STRING = 1 << 0,
666 * The field's buffer size need not match the declared \a rmf_size.
668 RMF_F_NO_SIZE_CHECK = 1 << 1,
670 * The field's buffer size must be a whole multiple of the declared \a
671 * rmf_size and the \a rmf_swabber function must work on the declared \a
672 * rmf_size worth of bytes.
674 RMF_F_STRUCT_ARRAY = 1 << 2
682 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
683 .rmf_name = (name), \
684 .rmf_flags = (flags), \
685 .rmf_size = (size), \
686 .rmf_swabber = (void (*)(void*))(swabber), \
687 .rmf_dumper = (void (*)(void*))(dumper) \
690 struct req_msg_field RMF_GENERIC_DATA =
691 DEFINE_MSGF("generic_data", 0,
693 EXPORT_SYMBOL(RMF_GENERIC_DATA);
695 struct req_msg_field RMF_MGS_TARGET_INFO =
696 DEFINE_MSGF("mgs_target_info", 0,
697 sizeof(struct mgs_target_info),
698 lustre_swab_mgs_target_info, NULL);
699 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
701 struct req_msg_field RMF_MGS_SEND_PARAM =
702 DEFINE_MSGF("mgs_send_param", 0,
703 sizeof(struct mgs_send_param),
705 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
707 struct req_msg_field RMF_MGS_CONFIG_BODY =
708 DEFINE_MSGF("mgs_config_read request", 0,
709 sizeof(struct mgs_config_body),
710 lustre_swab_mgs_config_body, NULL);
711 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
713 struct req_msg_field RMF_MGS_CONFIG_RES =
714 DEFINE_MSGF("mgs_config_read reply ", 0,
715 sizeof(struct mgs_config_res),
716 lustre_swab_mgs_config_res, NULL);
717 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
719 struct req_msg_field RMF_U32 =
720 DEFINE_MSGF("generic u32", 0,
721 sizeof(__u32), lustre_swab_generic_32s, NULL);
722 EXPORT_SYMBOL(RMF_U32);
724 struct req_msg_field RMF_SETINFO_VAL =
725 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
726 EXPORT_SYMBOL(RMF_SETINFO_VAL);
728 struct req_msg_field RMF_GETINFO_KEY =
729 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
730 EXPORT_SYMBOL(RMF_GETINFO_KEY);
732 struct req_msg_field RMF_GETINFO_VALLEN =
733 DEFINE_MSGF("getinfo_vallen", 0,
734 sizeof(__u32), lustre_swab_generic_32s, NULL);
735 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
737 struct req_msg_field RMF_GETINFO_VAL =
738 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
739 EXPORT_SYMBOL(RMF_GETINFO_VAL);
741 struct req_msg_field RMF_SEQ_OPC =
742 DEFINE_MSGF("seq_query_opc", 0,
743 sizeof(__u32), lustre_swab_generic_32s, NULL);
744 EXPORT_SYMBOL(RMF_SEQ_OPC);
746 struct req_msg_field RMF_SEQ_RANGE =
747 DEFINE_MSGF("seq_query_range", 0,
748 sizeof(struct lu_seq_range),
749 lustre_swab_lu_seq_range, NULL);
750 EXPORT_SYMBOL(RMF_SEQ_RANGE);
752 struct req_msg_field RMF_FLD_OPC =
753 DEFINE_MSGF("fld_query_opc", 0,
754 sizeof(__u32), lustre_swab_generic_32s, NULL);
755 EXPORT_SYMBOL(RMF_FLD_OPC);
757 struct req_msg_field RMF_FLD_MDFLD =
758 DEFINE_MSGF("fld_query_mdfld", 0,
759 sizeof(struct lu_seq_range),
760 lustre_swab_lu_seq_range, NULL);
761 EXPORT_SYMBOL(RMF_FLD_MDFLD);
763 struct req_msg_field RMF_MDT_BODY =
764 DEFINE_MSGF("mdt_body", 0,
765 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
766 EXPORT_SYMBOL(RMF_MDT_BODY);
768 struct req_msg_field RMF_OBD_QUOTACTL =
769 DEFINE_MSGF("obd_quotactl", 0,
770 sizeof(struct obd_quotactl),
771 lustre_swab_obd_quotactl, NULL);
772 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
774 struct req_msg_field RMF_QUOTA_ADJUST_QUNIT =
775 DEFINE_MSGF("quota_adjust_qunit", 0,
776 sizeof(struct quota_adjust_qunit),
777 lustre_swab_quota_adjust_qunit, NULL);
778 EXPORT_SYMBOL(RMF_QUOTA_ADJUST_QUNIT);
780 struct req_msg_field RMF_QUNIT_DATA =
781 DEFINE_MSGF("qunit_data", 0,
782 sizeof(struct qunit_data), lustre_swab_qdata, NULL);
783 EXPORT_SYMBOL(RMF_QUNIT_DATA);
785 struct req_msg_field RMF_QUOTA_BODY =
786 DEFINE_MSGF("quota_body", 0,
787 sizeof(struct quota_body), lustre_swab_quota_body, NULL);
788 EXPORT_SYMBOL(RMF_QUOTA_BODY);
790 struct req_msg_field RMF_MDT_EPOCH =
791 DEFINE_MSGF("mdt_ioepoch", 0,
792 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
793 EXPORT_SYMBOL(RMF_MDT_EPOCH);
795 struct req_msg_field RMF_PTLRPC_BODY =
796 DEFINE_MSGF("ptlrpc_body", 0,
797 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
798 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
800 struct req_msg_field RMF_OBD_STATFS =
801 DEFINE_MSGF("obd_statfs", 0,
802 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
803 EXPORT_SYMBOL(RMF_OBD_STATFS);
805 struct req_msg_field RMF_SETINFO_KEY =
806 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
807 EXPORT_SYMBOL(RMF_SETINFO_KEY);
809 struct req_msg_field RMF_NAME =
810 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
811 EXPORT_SYMBOL(RMF_NAME);
813 struct req_msg_field RMF_SYMTGT =
814 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
815 EXPORT_SYMBOL(RMF_SYMTGT);
817 struct req_msg_field RMF_TGTUUID =
818 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
820 EXPORT_SYMBOL(RMF_TGTUUID);
822 struct req_msg_field RMF_CLUUID =
823 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
825 EXPORT_SYMBOL(RMF_CLUUID);
827 struct req_msg_field RMF_STRING =
828 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
829 EXPORT_SYMBOL(RMF_STRING);
831 struct req_msg_field RMF_LLOGD_BODY =
832 DEFINE_MSGF("llogd_body", 0,
833 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
834 EXPORT_SYMBOL(RMF_LLOGD_BODY);
836 struct req_msg_field RMF_LLOG_LOG_HDR =
837 DEFINE_MSGF("llog_log_hdr", 0,
838 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
839 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
841 struct req_msg_field RMF_LLOGD_CONN_BODY =
842 DEFINE_MSGF("llogd_conn_body", 0,
843 sizeof(struct llogd_conn_body),
844 lustre_swab_llogd_conn_body, NULL);
845 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
848 * connection handle received in MDS_CONNECT request.
850 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
851 * that the client does not interpret at all.
853 struct req_msg_field RMF_CONN =
854 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
855 EXPORT_SYMBOL(RMF_CONN);
857 struct req_msg_field RMF_CONNECT_DATA =
859 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
860 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 7, 50, 0)
861 sizeof(struct obd_connect_data),
863 /* For interoperability with 1.8 and 2.0 clients/servers.
864 * The RPC verification code allows larger RPC buffers, but not
865 * smaller buffers. Until we no longer need to keep compatibility
866 * with older servers/clients we can only check that the buffer
867 * size is at least as large as obd_connect_data_v1. That is not
868 * not in itself harmful, since the chance of just corrupting this
869 * field is low. See JIRA LU-16 for details. */
870 sizeof(struct obd_connect_data_v1),
872 lustre_swab_connect, NULL);
873 EXPORT_SYMBOL(RMF_CONNECT_DATA);
875 struct req_msg_field RMF_DLM_REQ =
876 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
877 sizeof(struct ldlm_request),
878 lustre_swab_ldlm_request, NULL);
879 EXPORT_SYMBOL(RMF_DLM_REQ);
881 struct req_msg_field RMF_DLM_REP =
882 DEFINE_MSGF("dlm_rep", 0,
883 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
884 EXPORT_SYMBOL(RMF_DLM_REP);
886 struct req_msg_field RMF_LDLM_INTENT =
887 DEFINE_MSGF("ldlm_intent", 0,
888 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
889 EXPORT_SYMBOL(RMF_LDLM_INTENT);
891 struct req_msg_field RMF_DLM_LVB =
892 DEFINE_MSGF("dlm_lvb", 0, sizeof(union ldlm_wire_lvb), lustre_swab_lvb,
894 EXPORT_SYMBOL(RMF_DLM_LVB);
896 struct req_msg_field RMF_MDT_MD =
897 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
898 EXPORT_SYMBOL(RMF_MDT_MD);
900 struct req_msg_field RMF_REC_REINT =
901 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
902 lustre_swab_mdt_rec_reint, NULL);
903 EXPORT_SYMBOL(RMF_REC_REINT);
905 /* FIXME: this length should be defined as a macro */
906 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
908 EXPORT_SYMBOL(RMF_EADATA);
910 struct req_msg_field RMF_ACL =
911 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
912 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
913 EXPORT_SYMBOL(RMF_ACL);
915 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
916 struct req_msg_field RMF_LOGCOOKIES =
917 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
918 sizeof(struct llog_cookie), NULL, NULL);
919 EXPORT_SYMBOL(RMF_LOGCOOKIES);
921 struct req_msg_field RMF_CAPA1 =
922 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
923 lustre_swab_lustre_capa, NULL);
924 EXPORT_SYMBOL(RMF_CAPA1);
926 struct req_msg_field RMF_CAPA2 =
927 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
928 lustre_swab_lustre_capa, NULL);
929 EXPORT_SYMBOL(RMF_CAPA2);
934 struct req_msg_field RMF_OST_BODY =
935 DEFINE_MSGF("ost_body", 0,
936 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
937 EXPORT_SYMBOL(RMF_OST_BODY);
939 struct req_msg_field RMF_OBD_IOOBJ =
940 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
941 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
942 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
944 struct req_msg_field RMF_NIOBUF_REMOTE =
945 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
946 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
948 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
950 struct req_msg_field RMF_RCS =
951 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
952 lustre_swab_generic_32s, dump_rcs);
953 EXPORT_SYMBOL(RMF_RCS);
955 struct req_msg_field RMF_OBD_ID =
956 DEFINE_MSGF("obd_id", 0,
957 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
958 EXPORT_SYMBOL(RMF_OBD_ID);
960 struct req_msg_field RMF_FIEMAP_KEY =
961 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
962 lustre_swab_fiemap, NULL);
963 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
965 struct req_msg_field RMF_FIEMAP_VAL =
966 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
967 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
978 const struct req_msg_field **d;
982 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
996 #define DEFINE_REQ_FMT0(name, client, server) \
997 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
999 struct req_format RQF_OBD_PING =
1000 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1001 EXPORT_SYMBOL(RQF_OBD_PING);
1003 struct req_format RQF_OBD_SET_INFO =
1004 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1005 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1007 struct req_format RQF_SEC_CTX =
1008 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1009 EXPORT_SYMBOL(RQF_SEC_CTX);
1011 struct req_format RQF_MGS_TARGET_REG =
1012 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1013 mgs_target_info_only);
1014 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1016 struct req_format RQF_MGS_SET_INFO =
1017 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1019 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1021 struct req_format RQF_MGS_CONFIG_READ =
1022 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1023 mgs_config_read_server);
1024 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1026 struct req_format RQF_SEQ_QUERY =
1027 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1028 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1030 struct req_format RQF_FLD_QUERY =
1031 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1032 EXPORT_SYMBOL(RQF_FLD_QUERY);
1034 struct req_format RQF_LOG_CANCEL =
1035 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1036 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1038 struct req_format RQF_MDS_QUOTACHECK =
1039 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1040 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1042 struct req_format RQF_OST_QUOTACHECK =
1043 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1044 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1046 struct req_format RQF_MDS_QUOTACTL =
1047 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1048 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1050 struct req_format RQF_OST_QUOTACTL =
1051 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1052 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1054 struct req_format RQF_OST_QUOTA_ADJUST_QUNIT =
1055 DEFINE_REQ_FMT0("OST_QUOTA_ADJUST_QUNIT", quota_adjust_qunit_only,
1056 quota_adjust_qunit_only);
1057 EXPORT_SYMBOL(RQF_OST_QUOTA_ADJUST_QUNIT);
1059 struct req_format RQF_QC_CALLBACK =
1060 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1061 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1063 struct req_format RQF_MDS_QUOTA_DQACQ =
1064 DEFINE_REQ_FMT0("MDS_QUOTA_DQACQ", qunit_data_only, qunit_data_only);
1065 EXPORT_SYMBOL(RQF_MDS_QUOTA_DQACQ);
1067 struct req_format RQF_QUOTA_DQACQ =
1068 DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1069 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1071 struct req_format RQF_LDLM_INTENT_QUOTA =
1072 DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1073 ldlm_intent_quota_client,
1074 ldlm_intent_quota_server);
1075 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1077 struct req_format RQF_MDS_GETSTATUS =
1078 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1079 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1081 struct req_format RQF_MDS_STATFS =
1082 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1083 EXPORT_SYMBOL(RQF_MDS_STATFS);
1085 struct req_format RQF_MDS_SYNC =
1086 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1087 EXPORT_SYMBOL(RQF_MDS_SYNC);
1089 struct req_format RQF_MDS_GETATTR =
1090 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1091 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1093 struct req_format RQF_MDS_GETXATTR =
1094 DEFINE_REQ_FMT0("MDS_GETXATTR",
1095 mds_getxattr_client, mds_getxattr_server);
1096 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1098 struct req_format RQF_MDS_GETATTR_NAME =
1099 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1100 mds_getattr_name_client, mds_getattr_server);
1101 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1103 struct req_format RQF_MDS_REINT =
1104 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1105 EXPORT_SYMBOL(RQF_MDS_REINT);
1107 struct req_format RQF_MDS_REINT_CREATE =
1108 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1109 mds_reint_create_client, mdt_body_capa);
1110 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1112 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1113 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1114 mds_reint_create_rmt_acl_client, mdt_body_capa);
1115 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1117 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1118 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1119 mds_reint_create_slave_client, mdt_body_capa);
1120 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1122 struct req_format RQF_MDS_REINT_CREATE_SYM =
1123 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1124 mds_reint_create_sym_client, mdt_body_capa);
1125 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1127 struct req_format RQF_MDS_REINT_OPEN =
1128 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1129 mds_reint_open_client, mds_reint_open_server);
1130 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1132 struct req_format RQF_MDS_REINT_UNLINK =
1133 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1134 mds_last_unlink_server);
1135 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1137 struct req_format RQF_MDS_REINT_LINK =
1138 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1139 mds_reint_link_client, mdt_body_only);
1140 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1142 struct req_format RQF_MDS_REINT_RENAME =
1143 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1144 mds_last_unlink_server);
1145 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1147 struct req_format RQF_MDS_REINT_SETATTR =
1148 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1149 mds_reint_setattr_client, mds_setattr_server);
1150 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1152 struct req_format RQF_MDS_REINT_SETXATTR =
1153 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1154 mds_reint_setxattr_client, mdt_body_only);
1155 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1157 struct req_format RQF_MDS_CONNECT =
1158 DEFINE_REQ_FMT0("MDS_CONNECT",
1159 obd_connect_client, obd_connect_server);
1160 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1162 struct req_format RQF_MDS_DISCONNECT =
1163 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1164 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1166 struct req_format RQF_MDS_GET_INFO =
1167 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1168 mds_getinfo_server);
1169 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1171 struct req_format RQF_LDLM_ENQUEUE =
1172 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1173 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1174 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1176 struct req_format RQF_LDLM_ENQUEUE_LVB =
1177 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1178 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1179 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1181 struct req_format RQF_LDLM_CONVERT =
1182 DEFINE_REQ_FMT0("LDLM_CONVERT",
1183 ldlm_enqueue_client, ldlm_enqueue_server);
1184 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1186 struct req_format RQF_LDLM_CANCEL =
1187 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1188 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1190 struct req_format RQF_LDLM_CALLBACK =
1191 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1192 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1194 struct req_format RQF_LDLM_CP_CALLBACK =
1195 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1196 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1198 struct req_format RQF_LDLM_BL_CALLBACK =
1199 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1200 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1202 struct req_format RQF_LDLM_GL_CALLBACK =
1203 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1204 ldlm_gl_callback_server);
1205 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1207 struct req_format RQF_LDLM_INTENT =
1208 DEFINE_REQ_FMT0("LDLM_INTENT",
1209 ldlm_intent_client, ldlm_intent_server);
1210 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1212 struct req_format RQF_LDLM_INTENT_GETATTR =
1213 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1214 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1215 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1217 struct req_format RQF_LDLM_INTENT_OPEN =
1218 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1219 ldlm_intent_open_client, ldlm_intent_open_server);
1220 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1222 struct req_format RQF_LDLM_INTENT_CREATE =
1223 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1224 ldlm_intent_create_client, ldlm_intent_getattr_server);
1225 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1227 struct req_format RQF_LDLM_INTENT_UNLINK =
1228 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1229 ldlm_intent_unlink_client, ldlm_intent_server);
1230 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1232 struct req_format RQF_MDS_CLOSE =
1233 DEFINE_REQ_FMT0("MDS_CLOSE",
1234 mdt_close_client, mds_last_unlink_server);
1235 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1237 struct req_format RQF_MDS_PIN =
1238 DEFINE_REQ_FMT0("MDS_PIN",
1239 mdt_body_capa, mdt_body_only);
1240 EXPORT_SYMBOL(RQF_MDS_PIN);
1242 struct req_format RQF_MDS_UNPIN =
1243 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1244 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1246 struct req_format RQF_MDS_DONE_WRITING =
1247 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1248 mdt_close_client, mdt_body_only);
1249 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1251 struct req_format RQF_MDS_READPAGE =
1252 DEFINE_REQ_FMT0("MDS_READPAGE",
1253 mdt_body_capa, mdt_body_only);
1254 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1256 /* This is for split */
1257 struct req_format RQF_MDS_WRITEPAGE =
1258 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1259 mdt_body_capa, mdt_body_only);
1260 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1262 struct req_format RQF_MDS_IS_SUBDIR =
1263 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1264 mdt_body_only, mdt_body_only);
1265 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1267 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1268 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1269 llog_origin_handle_create_client, llogd_body_only);
1270 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1272 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1273 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1274 llogd_body_only, llogd_body_only);
1275 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1277 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1278 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1279 llogd_body_only, llog_origin_handle_next_block_server);
1280 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1282 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1283 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1284 llogd_body_only, llog_origin_handle_next_block_server);
1285 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1287 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1288 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1289 llogd_body_only, llog_log_hdr_only);
1290 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1292 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1293 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1294 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1296 struct req_format RQF_OST_CONNECT =
1297 DEFINE_REQ_FMT0("OST_CONNECT",
1298 obd_connect_client, obd_connect_server);
1299 EXPORT_SYMBOL(RQF_OST_CONNECT);
1301 struct req_format RQF_OST_DISCONNECT =
1302 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1303 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1305 struct req_format RQF_OST_GETATTR =
1306 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1307 EXPORT_SYMBOL(RQF_OST_GETATTR);
1309 struct req_format RQF_OST_SETATTR =
1310 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1311 EXPORT_SYMBOL(RQF_OST_SETATTR);
1313 struct req_format RQF_OST_CREATE =
1314 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1315 EXPORT_SYMBOL(RQF_OST_CREATE);
1317 struct req_format RQF_OST_PUNCH =
1318 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1319 EXPORT_SYMBOL(RQF_OST_PUNCH);
1321 struct req_format RQF_OST_SYNC =
1322 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1323 EXPORT_SYMBOL(RQF_OST_SYNC);
1325 struct req_format RQF_OST_DESTROY =
1326 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1327 EXPORT_SYMBOL(RQF_OST_DESTROY);
1329 struct req_format RQF_OST_BRW_READ =
1330 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1331 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1333 struct req_format RQF_OST_BRW_WRITE =
1334 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1335 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1337 struct req_format RQF_OST_STATFS =
1338 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1339 EXPORT_SYMBOL(RQF_OST_STATFS);
1341 struct req_format RQF_OST_SET_GRANT_INFO =
1342 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1344 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1346 struct req_format RQF_OST_GET_INFO_GENERIC =
1347 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1348 ost_get_info_generic_server);
1349 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1351 struct req_format RQF_OST_GET_INFO_LAST_ID =
1352 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1353 ost_get_last_id_server);
1354 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1356 struct req_format RQF_OST_GET_INFO_FIEMAP =
1357 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1358 ost_get_fiemap_server);
1359 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1362 #if !defined(__REQ_LAYOUT_USER__)
1364 /* Convenience macro */
1365 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1368 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1369 * field of RQFs and the \a rmf_offset field of RMFs.
1371 int req_layout_init(void)
1376 struct req_format *rf = NULL;
1378 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1379 rf = req_formats[i];
1381 for (j = 0; j < RCL_NR; ++j) {
1382 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1383 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1384 struct req_msg_field *field;
1386 field = (typeof(field))rf->rf_fields[j].d[k];
1387 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1388 || field->rmf_size > 0);
1389 LASSERT(field->rmf_offset[i][j] == 0);
1391 * k + 1 to detect unused format/field
1394 field->rmf_offset[i][j] = k + 1;
1400 EXPORT_SYMBOL(req_layout_init);
1402 void req_layout_fini(void)
1405 EXPORT_SYMBOL(req_layout_fini);
1408 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1410 * Actual/expected field sizes are set elsewhere in functions in this file:
1411 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1412 * req_capsule_msg_size(). The \a rc_area information is used by.
1413 * ptlrpc_request_set_replen().
1415 void req_capsule_init_area(struct req_capsule *pill)
1419 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1420 pill->rc_area[RCL_CLIENT][i] = -1;
1421 pill->rc_area[RCL_SERVER][i] = -1;
1424 EXPORT_SYMBOL(req_capsule_init_area);
1427 * Initialize a pill.
1429 * The \a location indicates whether the caller is executing on the client side
1430 * (RCL_CLIENT) or server side (RCL_SERVER)..
1432 void req_capsule_init(struct req_capsule *pill,
1433 struct ptlrpc_request *req,
1434 enum req_location location)
1436 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1439 * Today all capsules are embedded in ptlrpc_request structs,
1440 * but just in case that ever isn't the case, we don't reach
1441 * into req unless req != NULL and pill is the one embedded in
1444 * The req->rq_pill_init flag makes it safe to initialize a pill
1445 * twice, which might happen in the OST paths as a result of the
1446 * high-priority RPC queue getting peeked at before ost_handle()
1447 * handles an OST RPC.
1449 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1452 memset(pill, 0, sizeof *pill);
1454 pill->rc_loc = location;
1455 req_capsule_init_area(pill);
1457 if (req != NULL && pill == &req->rq_pill)
1458 req->rq_pill_init = 1;
1460 EXPORT_SYMBOL(req_capsule_init);
1462 void req_capsule_fini(struct req_capsule *pill)
1465 EXPORT_SYMBOL(req_capsule_fini);
1467 static int __req_format_is_sane(const struct req_format *fmt)
1470 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1471 req_formats[fmt->rf_idx] == fmt;
1474 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1475 enum req_location loc)
1477 struct ptlrpc_request *req;
1480 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1484 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1485 * (see req_capsule_extend()).
1487 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1489 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1490 LASSERT(__req_format_is_sane(fmt));
1494 EXPORT_SYMBOL(req_capsule_set);
1497 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1500 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1501 * variable-sized fields. The field sizes come from the declared \a rmf_size
1502 * field of a \a pill's \a rc_fmt's RMF's.
1504 int req_capsule_filled_sizes(struct req_capsule *pill,
1505 enum req_location loc)
1507 const struct req_format *fmt = pill->rc_fmt;
1510 LASSERT(fmt != NULL);
1512 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1513 if (pill->rc_area[loc][i] == -1) {
1514 pill->rc_area[loc][i] =
1515 fmt->rf_fields[loc].d[i]->rmf_size;
1516 if (pill->rc_area[loc][i] == -1) {
1518 * Skip the following fields.
1520 * If this LASSERT() trips then you're missing a
1521 * call to req_capsule_set_size().
1523 LASSERT(loc != RCL_SERVER);
1530 EXPORT_SYMBOL(req_capsule_filled_sizes);
1533 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1535 * This function uses the \a pill's \a rc_area as filled in by
1536 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1539 int req_capsule_server_pack(struct req_capsule *pill)
1541 const struct req_format *fmt;
1545 LASSERT(pill->rc_loc == RCL_SERVER);
1547 LASSERT(fmt != NULL);
1549 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1550 rc = lustre_pack_reply(pill->rc_req, count,
1551 pill->rc_area[RCL_SERVER], NULL);
1553 DEBUG_REQ(D_ERROR, pill->rc_req,
1554 "Cannot pack %d fields in format `%s': ",
1555 count, fmt->rf_name);
1559 EXPORT_SYMBOL(req_capsule_server_pack);
1562 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1563 * corresponding to the given RMF (\a field).
1565 static int __req_capsule_offset(const struct req_capsule *pill,
1566 const struct req_msg_field *field,
1567 enum req_location loc)
1571 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1572 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1573 pill->rc_fmt->rf_name,
1574 field->rmf_name, offset, loc);
1577 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1582 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1587 swabber_dumper_helper(struct req_capsule *pill,
1588 const struct req_msg_field *field,
1589 enum req_location loc,
1591 void *value, int len, int dump, void (*swabber)( void *))
1597 int inout = loc == RCL_CLIENT;
1599 swabber = swabber ?: field->rmf_swabber;
1601 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1602 swabber != NULL && value != NULL)
1607 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1608 if (dump && field->rmf_dumper) {
1609 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1610 do_swab ? "unswabbed " : "", field->rmf_name);
1611 field->rmf_dumper(value);
1616 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1618 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1619 "follows\n", field->rmf_name);
1620 field->rmf_dumper(value);
1627 * We're swabbing an array; swabber() swabs a single array element, so
1628 * swab every element.
1630 LASSERT((len % field->rmf_size) == 0);
1631 for (p = value, i = 0, n = len / field->rmf_size;
1633 i++, p += field->rmf_size) {
1634 if (dump && field->rmf_dumper) {
1635 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1636 "element %d follows\n",
1637 do_swab ? "unswabbed " : "", field->rmf_name, i);
1638 field->rmf_dumper(p);
1643 if (dump && field->rmf_dumper) {
1644 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1645 "element %d follows\n", field->rmf_name, i);
1646 field->rmf_dumper(value);
1650 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1654 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1655 * corresponding to the given RMF (\a field).
1657 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1658 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1659 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1660 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1661 * element of the array swabbed.
1663 static void *__req_capsule_get(struct req_capsule *pill,
1664 const struct req_msg_field *field,
1665 enum req_location loc,
1666 void (*swabber)( void *),
1669 const struct req_format *fmt;
1670 struct lustre_msg *msg;
1675 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1677 static const char *rcl_names[RCL_NR] = {
1678 [RCL_CLIENT] = "client",
1679 [RCL_SERVER] = "server"
1682 LASSERT(pill != NULL);
1683 LASSERT(pill != LP_POISON);
1685 LASSERT(fmt != NULL);
1686 LASSERT(fmt != LP_POISON);
1687 LASSERT(__req_format_is_sane(fmt));
1689 offset = __req_capsule_offset(pill, field, loc);
1691 msg = __req_msg(pill, loc);
1692 LASSERT(msg != NULL);
1694 getter = (field->rmf_flags & RMF_F_STRING) ?
1695 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1697 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1699 * We've already asserted that field->rmf_size > 0 in
1700 * req_layout_init().
1702 len = lustre_msg_buflen(msg, offset);
1703 if ((len % field->rmf_size) != 0) {
1704 CERROR("%s: array field size mismatch "
1705 "%d modulo %d != 0 (%d)\n",
1706 field->rmf_name, len, field->rmf_size, loc);
1709 } else if (pill->rc_area[loc][offset] != -1) {
1710 len = pill->rc_area[loc][offset];
1712 len = max(field->rmf_size, 0);
1714 value = getter(msg, offset, len);
1716 if (value == NULL) {
1717 DEBUG_REQ(D_ERROR, pill->rc_req,
1718 "Wrong buffer for field `%s' (%d of %d) "
1719 "in format `%s': %d vs. %d (%s)\n",
1720 field->rmf_name, offset, lustre_msg_bufcount(msg),
1721 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1724 swabber_dumper_helper(pill, field, loc, offset, value, len,
1732 * Dump a request and/or reply
1734 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1736 const struct req_format *fmt;
1737 const struct req_msg_field *field;
1743 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1744 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1745 field = FMT_FIELD(fmt, loc, i);
1746 if (field->rmf_dumper == NULL) {
1748 * FIXME Add a default hex dumper for fields that don't
1749 * have a specific dumper
1751 len = req_capsule_get_size(pill, field, loc);
1752 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1753 "field size is %d\n", field->rmf_name, len);
1755 /* It's the dumping side-effect that we're interested in */
1756 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1759 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1765 void req_capsule_client_dump(struct req_capsule *pill)
1767 __req_capsule_dump(pill, RCL_CLIENT);
1769 EXPORT_SYMBOL(req_capsule_client_dump);
1774 void req_capsule_server_dump(struct req_capsule *pill)
1776 __req_capsule_dump(pill, RCL_SERVER);
1778 EXPORT_SYMBOL(req_capsule_server_dump);
1781 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
1782 * buffer corresponding to the given RMF (\a field) of a \a pill.
1784 void *req_capsule_client_get(struct req_capsule *pill,
1785 const struct req_msg_field *field)
1787 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1789 EXPORT_SYMBOL(req_capsule_client_get);
1792 * Same as req_capsule_client_get(), but with a \a swabber argument.
1794 * Currently unused; will be removed when req_capsule_server_swab_get() is
1797 void *req_capsule_client_swab_get(struct req_capsule *pill,
1798 const struct req_msg_field *field,
1799 void (*swabber)(void* ))
1801 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
1803 EXPORT_SYMBOL(req_capsule_client_swab_get);
1806 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
1808 * First the \a pill's request \a field's size is set (\a rc_area) using
1809 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1812 void *req_capsule_client_sized_get(struct req_capsule *pill,
1813 const struct req_msg_field *field,
1816 req_capsule_set_size(pill, field, RCL_CLIENT, len);
1817 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1819 EXPORT_SYMBOL(req_capsule_client_sized_get);
1822 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
1823 * buffer corresponding to the given RMF (\a field) of a \a pill.
1825 void *req_capsule_server_get(struct req_capsule *pill,
1826 const struct req_msg_field *field)
1828 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1830 EXPORT_SYMBOL(req_capsule_server_get);
1833 * Same as req_capsule_server_get(), but with a \a swabber argument.
1835 * Ideally all swabbing should be done pursuant to RMF definitions, with no
1836 * swabbing done outside this capsule abstraction.
1838 void *req_capsule_server_swab_get(struct req_capsule *pill,
1839 const struct req_msg_field *field,
1842 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
1844 EXPORT_SYMBOL(req_capsule_server_swab_get);
1847 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
1849 * First the \a pill's request \a field's size is set (\a rc_area) using
1850 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1853 void *req_capsule_server_sized_get(struct req_capsule *pill,
1854 const struct req_msg_field *field,
1857 req_capsule_set_size(pill, field, RCL_SERVER, len);
1858 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1860 EXPORT_SYMBOL(req_capsule_server_sized_get);
1863 * Returns the buffer of a \a pill corresponding to the given \a field from the
1864 * request (if the caller is executing on the server-side) or reply (if the
1865 * caller is executing on the client-side).
1867 * This function convienient for use is code that could be executed on the
1868 * client and server alike.
1870 const void *req_capsule_other_get(struct req_capsule *pill,
1871 const struct req_msg_field *field)
1873 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
1875 EXPORT_SYMBOL(req_capsule_other_get);
1878 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
1879 * field of the given \a pill.
1881 * This function must be used when constructing variable sized fields of a
1884 void req_capsule_set_size(struct req_capsule *pill,
1885 const struct req_msg_field *field,
1886 enum req_location loc, int size)
1888 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1890 if ((size != field->rmf_size) &&
1891 (field->rmf_size != -1) &&
1892 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1894 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1895 (size % field->rmf_size != 0)) {
1896 CERROR("%s: array field size mismatch "
1897 "%d %% %d != 0 (%d)\n",
1898 field->rmf_name, size, field->rmf_size, loc);
1900 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1901 size < field->rmf_size) {
1902 CERROR("%s: field size mismatch %d != %d (%d)\n",
1903 field->rmf_name, size, field->rmf_size, loc);
1908 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
1910 EXPORT_SYMBOL(req_capsule_set_size);
1913 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
1914 * for the given \a pill's given \a field.
1916 * NB: this function doesn't correspond with req_capsule_set_size(), which
1917 * actually sets the size in pill.rc_area[loc][offset], but this function
1918 * returns the message buflen[offset], maybe we should use another name.
1920 int req_capsule_get_size(const struct req_capsule *pill,
1921 const struct req_msg_field *field,
1922 enum req_location loc)
1924 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1926 return lustre_msg_buflen(__req_msg(pill, loc),
1927 __req_capsule_offset(pill, field, loc));
1929 EXPORT_SYMBOL(req_capsule_get_size);
1932 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
1933 * given \a pill's request or reply (\a loc) given the field size recorded in
1934 * the \a pill's rc_area.
1936 * See also req_capsule_set_size().
1938 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
1940 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
1941 pill->rc_fmt->rf_fields[loc].nr,
1942 pill->rc_area[loc]);
1946 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
1947 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
1948 * PTLRPC request or reply given only an RQF (\a fmt).
1950 * This function should not be used for formats which contain variable size
1953 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
1954 enum req_location loc)
1959 * This function should probably LASSERT() that fmt has no fields with
1960 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
1961 * elements in the array there will ultimately be, but then, we could
1962 * assume that there will be at least one element, and that's just what
1965 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
1969 for (; i < fmt->rf_fields[loc].nr; ++i)
1970 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
1971 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
1977 * Changes the format of an RPC.
1979 * The pill must already have been initialized, which means that it already has
1980 * a request format. The new format \a fmt must be an extension of the pill's
1981 * old format. Specifically: the new format must have as many request and reply
1982 * fields as the old one, and all fields shared by the old and new format must
1983 * be at least as large in the new format.
1985 * The new format's fields may be of different "type" than the old format, but
1986 * only for fields that are "opaque" blobs: fields which have a) have no
1987 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
1988 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
1989 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
1990 * according to the key field. When the value, according to the key, contains a
1991 * structure (or array thereof) to be swabbed, the format should be changed to
1992 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
1995 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2000 const struct req_format *old;
2002 LASSERT(pill->rc_fmt != NULL);
2003 LASSERT(__req_format_is_sane(fmt));
2007 * Sanity checking...
2009 for (i = 0; i < RCL_NR; ++i) {
2010 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2011 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2012 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2014 /* "opaque" fields can be transmogrified */
2015 if (ofield->rmf_swabber == NULL &&
2016 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2017 (ofield->rmf_size == -1 ||
2018 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2020 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2023 * Last field in old format can be shorter than in new.
2025 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2026 FMT_FIELD(old, i, j)->rmf_size);
2031 EXPORT_SYMBOL(req_capsule_extend);
2034 * This function returns a non-zero value if the given \a field is present in
2035 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2038 int req_capsule_has_field(const struct req_capsule *pill,
2039 const struct req_msg_field *field,
2040 enum req_location loc)
2042 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2044 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2046 EXPORT_SYMBOL(req_capsule_has_field);
2049 * Returns a non-zero value if the given \a field is present in the given \a
2050 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2052 int req_capsule_field_present(const struct req_capsule *pill,
2053 const struct req_msg_field *field,
2054 enum req_location loc)
2058 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2059 LASSERT(req_capsule_has_field(pill, field, loc));
2061 offset = __req_capsule_offset(pill, field, loc);
2062 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2064 EXPORT_SYMBOL(req_capsule_field_present);
2067 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2068 * request or reply (\a loc).
2070 * This is not the opposite of req_capsule_extend().
2072 void req_capsule_shrink(struct req_capsule *pill,
2073 const struct req_msg_field *field,
2074 unsigned int newlen,
2075 enum req_location loc)
2077 const struct req_format *fmt;
2078 struct lustre_msg *msg;
2083 LASSERT(fmt != NULL);
2084 LASSERT(__req_format_is_sane(fmt));
2085 LASSERT(req_capsule_has_field(pill, field, loc));
2086 LASSERT(req_capsule_field_present(pill, field, loc));
2088 offset = __req_capsule_offset(pill, field, loc);
2090 msg = __req_msg(pill, loc);
2091 len = lustre_msg_buflen(msg, offset);
2092 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2093 fmt->rf_name, field->rmf_name, len, newlen);
2095 if (loc == RCL_CLIENT)
2096 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2099 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2102 EXPORT_SYMBOL(req_capsule_shrink);
2104 int req_capsule_server_grow(struct req_capsule *pill,
2105 const struct req_msg_field *field,
2106 unsigned int newlen)
2108 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2110 int offset, len, rc;
2112 LASSERT(pill->rc_fmt != NULL);
2113 LASSERT(__req_format_is_sane(pill->rc_fmt));
2114 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2115 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2117 len = req_capsule_get_size(pill, field, RCL_SERVER);
2118 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2119 if (pill->rc_req->rq_repbuf_len >=
2120 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2121 CERROR("Inplace repack might be done\n");
2123 pill->rc_req->rq_reply_state = NULL;
2124 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2125 rc = req_capsule_server_pack(pill);
2127 /* put old rs back, the caller will decide what to do */
2128 pill->rc_req->rq_reply_state = rs;
2131 nrs = pill->rc_req->rq_reply_state;
2132 /* Now we need only buffers, copy first chunk */
2133 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2134 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2135 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2136 memcpy(to, from, len);
2137 /* check if we have tail and copy it too */
2138 if (rs->rs_msg->lm_bufcount > offset + 1) {
2139 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2140 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2141 offset = rs->rs_msg->lm_bufcount - 1;
2142 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2143 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2144 memcpy(to, from, len);
2146 /* drop old reply if everything is fine */
2147 if (rs->rs_difficult) {
2151 nrs->rs_difficult = 1;
2152 nrs->rs_no_ack = rs->rs_no_ack;
2153 for (i = 0; i < rs->rs_nlocks; i++) {
2154 nrs->rs_locks[i] = rs->rs_locks[i];
2155 nrs->rs_modes[i] = rs->rs_modes[i];
2159 rs->rs_difficult = 0;
2162 ptlrpc_rs_decref(rs);
2165 EXPORT_SYMBOL(req_capsule_server_grow);
2166 /* __REQ_LAYOUT_USER__ */