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 *mdt_close_client[] = {
141 static const struct req_msg_field *obd_statfs_server[] = {
146 static const struct req_msg_field *seq_query_client[] = {
152 static const struct req_msg_field *seq_query_server[] = {
157 static const struct req_msg_field *fld_query_client[] = {
163 static const struct req_msg_field *fld_query_server[] = {
168 static const struct req_msg_field *mds_getattr_name_client[] = {
175 static const struct req_msg_field *mds_reint_client[] = {
180 static const struct req_msg_field *mds_reint_create_client[] = {
187 static const struct req_msg_field *mds_reint_create_slave_client[] = {
196 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
205 static const struct req_msg_field *mds_reint_create_sym_client[] = {
214 static const struct req_msg_field *mds_reint_open_client[] = {
223 static const struct req_msg_field *mds_reint_open_server[] = {
232 static const struct req_msg_field *mds_reint_unlink_client[] = {
240 static const struct req_msg_field *mds_reint_link_client[] = {
249 static const struct req_msg_field *mds_reint_rename_client[] = {
259 static const struct req_msg_field *mds_last_unlink_server[] = {
268 static const struct req_msg_field *mds_reint_setattr_client[] = {
278 static const struct req_msg_field *mds_reint_setxattr_client[] = {
286 static const struct req_msg_field *obd_connect_client[] = {
294 static const struct req_msg_field *obd_connect_server[] = {
299 static const struct req_msg_field *obd_set_info_client[] = {
305 static const struct req_msg_field *ost_grant_shrink_client[] = {
311 static const struct req_msg_field *mds_getinfo_client[] = {
317 static const struct req_msg_field *mds_getinfo_server[] = {
322 static const struct req_msg_field *ldlm_enqueue_client[] = {
327 static const struct req_msg_field *ldlm_enqueue_server[] = {
332 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
338 static const struct req_msg_field *ldlm_cp_callback_client[] = {
344 static const struct req_msg_field *ldlm_gl_callback_server[] = {
349 static const struct req_msg_field *ldlm_intent_client[] = {
356 static const struct req_msg_field *ldlm_intent_server[] = {
364 static const struct req_msg_field *ldlm_intent_open_server[] = {
374 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
378 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
383 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
392 static const struct req_msg_field *ldlm_intent_create_client[] = {
396 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
402 static const struct req_msg_field *ldlm_intent_open_client[] = {
406 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
413 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
417 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
422 static const struct req_msg_field *mds_getxattr_client[] = {
430 static const struct req_msg_field *mds_getxattr_server[] = {
436 static const struct req_msg_field *mds_getattr_server[] = {
445 static const struct req_msg_field *mds_setattr_server[] = {
454 static const struct req_msg_field *llog_catinfo_client[] = {
460 static const struct req_msg_field *llog_catinfo_server[] = {
465 static const struct req_msg_field *llog_origin_handle_create_client[] = {
471 static const struct req_msg_field *llogd_body_only[] = {
476 static const struct req_msg_field *llog_log_hdr_only[] = {
481 static const struct req_msg_field *llogd_conn_body_only[] = {
486 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
492 static const struct req_msg_field *ost_body_only[] = {
497 static const struct req_msg_field *ost_body_capa[] = {
503 static const struct req_msg_field *ost_destroy_client[] = {
511 static const struct req_msg_field *ost_brw_client[] = {
519 static const struct req_msg_field *ost_brw_read_server[] = {
524 static const struct req_msg_field *ost_brw_write_server[] = {
530 static const struct req_msg_field *ost_get_info_generic_server[] = {
535 static const struct req_msg_field *ost_get_info_generic_client[] = {
540 static const struct req_msg_field *ost_get_last_id_server[] = {
545 static const struct req_msg_field *ost_get_fiemap_client[] = {
551 static const struct req_msg_field *ost_get_fiemap_server[] = {
556 static struct req_format *req_formats[] = {
562 &RQF_MGS_CONFIG_READ,
571 &RQF_MDS_GETATTR_NAME,
580 &RQF_MDS_DONE_WRITING,
582 &RQF_MDS_REINT_CREATE,
583 &RQF_MDS_REINT_CREATE_RMT_ACL,
584 &RQF_MDS_REINT_CREATE_SLAVE,
585 &RQF_MDS_REINT_CREATE_SYM,
587 &RQF_MDS_REINT_UNLINK,
589 &RQF_MDS_REINT_RENAME,
590 &RQF_MDS_REINT_SETATTR,
591 &RQF_MDS_REINT_SETXATTR,
594 &RQF_MDS_QUOTA_DQACQ,
600 &RQF_OST_QUOTA_ADJUST_QUNIT,
610 &RQF_OST_SET_GRANT_INFO,
611 &RQF_OST_GET_INFO_GENERIC,
612 &RQF_OST_GET_INFO_LAST_ID,
613 &RQF_OST_GET_INFO_FIEMAP,
615 &RQF_LDLM_ENQUEUE_LVB,
619 &RQF_LDLM_CP_CALLBACK,
620 &RQF_LDLM_BL_CALLBACK,
621 &RQF_LDLM_GL_CALLBACK,
623 &RQF_LDLM_INTENT_GETATTR,
624 &RQF_LDLM_INTENT_OPEN,
625 &RQF_LDLM_INTENT_CREATE,
626 &RQF_LDLM_INTENT_UNLINK,
629 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
630 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
631 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
632 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
633 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
634 &RQF_LLOG_ORIGIN_CONNECT
637 struct req_msg_field {
638 const __u32 rmf_flags;
639 const char *rmf_name;
641 * Field length. (-1) means "variable length". If the
642 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
643 * but the actual size must be a whole multiple of \a rmf_size.
646 void (*rmf_swabber)(void *);
647 void (*rmf_dumper)(void *);
648 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
653 * The field is a string, must be NUL-terminated.
655 RMF_F_STRING = 1 << 0,
657 * The field's buffer size need not match the declared \a rmf_size.
659 RMF_F_NO_SIZE_CHECK = 1 << 1,
661 * The field's buffer size must be a whole multiple of the declared \a
662 * rmf_size and the \a rmf_swabber function must work on the declared \a
663 * rmf_size worth of bytes.
665 RMF_F_STRUCT_ARRAY = 1 << 2
673 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
674 .rmf_name = (name), \
675 .rmf_flags = (flags), \
676 .rmf_size = (size), \
677 .rmf_swabber = (void (*)(void*))(swabber), \
678 .rmf_dumper = (void (*)(void*))(dumper) \
681 struct req_msg_field RMF_GENERIC_DATA =
682 DEFINE_MSGF("generic_data", 0,
684 EXPORT_SYMBOL(RMF_GENERIC_DATA);
686 struct req_msg_field RMF_MGS_TARGET_INFO =
687 DEFINE_MSGF("mgs_target_info", 0,
688 sizeof(struct mgs_target_info),
689 lustre_swab_mgs_target_info, NULL);
690 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
692 struct req_msg_field RMF_MGS_SEND_PARAM =
693 DEFINE_MSGF("mgs_send_param", 0,
694 sizeof(struct mgs_send_param),
696 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
698 struct req_msg_field RMF_MGS_CONFIG_BODY =
699 DEFINE_MSGF("mgs_config_read request", 0,
700 sizeof(struct mgs_config_body),
701 lustre_swab_mgs_config_body, NULL);
702 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
704 struct req_msg_field RMF_MGS_CONFIG_RES =
705 DEFINE_MSGF("mgs_config_read reply ", 0,
706 sizeof(struct mgs_config_res),
707 lustre_swab_mgs_config_res, NULL);
708 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
710 struct req_msg_field RMF_U32 =
711 DEFINE_MSGF("generic u32", 0,
712 sizeof(__u32), lustre_swab_generic_32s, NULL);
713 EXPORT_SYMBOL(RMF_U32);
715 struct req_msg_field RMF_SETINFO_VAL =
716 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
717 EXPORT_SYMBOL(RMF_SETINFO_VAL);
719 struct req_msg_field RMF_GETINFO_KEY =
720 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
721 EXPORT_SYMBOL(RMF_GETINFO_KEY);
723 struct req_msg_field RMF_GETINFO_VALLEN =
724 DEFINE_MSGF("getinfo_vallen", 0,
725 sizeof(__u32), lustre_swab_generic_32s, NULL);
726 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
728 struct req_msg_field RMF_GETINFO_VAL =
729 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
730 EXPORT_SYMBOL(RMF_GETINFO_VAL);
732 struct req_msg_field RMF_SEQ_OPC =
733 DEFINE_MSGF("seq_query_opc", 0,
734 sizeof(__u32), lustre_swab_generic_32s, NULL);
735 EXPORT_SYMBOL(RMF_SEQ_OPC);
737 struct req_msg_field RMF_SEQ_RANGE =
738 DEFINE_MSGF("seq_query_range", 0,
739 sizeof(struct lu_seq_range),
740 lustre_swab_lu_seq_range, NULL);
741 EXPORT_SYMBOL(RMF_SEQ_RANGE);
743 struct req_msg_field RMF_FLD_OPC =
744 DEFINE_MSGF("fld_query_opc", 0,
745 sizeof(__u32), lustre_swab_generic_32s, NULL);
746 EXPORT_SYMBOL(RMF_FLD_OPC);
748 struct req_msg_field RMF_FLD_MDFLD =
749 DEFINE_MSGF("fld_query_mdfld", 0,
750 sizeof(struct lu_seq_range),
751 lustre_swab_lu_seq_range, NULL);
752 EXPORT_SYMBOL(RMF_FLD_MDFLD);
754 struct req_msg_field RMF_MDT_BODY =
755 DEFINE_MSGF("mdt_body", 0,
756 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
757 EXPORT_SYMBOL(RMF_MDT_BODY);
759 struct req_msg_field RMF_OBD_QUOTACTL =
760 DEFINE_MSGF("obd_quotactl", 0,
761 sizeof(struct obd_quotactl),
762 lustre_swab_obd_quotactl, NULL);
763 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
765 struct req_msg_field RMF_QUOTA_ADJUST_QUNIT =
766 DEFINE_MSGF("quota_adjust_qunit", 0,
767 sizeof(struct quota_adjust_qunit),
768 lustre_swab_quota_adjust_qunit, NULL);
769 EXPORT_SYMBOL(RMF_QUOTA_ADJUST_QUNIT);
771 struct req_msg_field RMF_QUNIT_DATA =
772 DEFINE_MSGF("qunit_data", 0,
773 sizeof(struct qunit_data), lustre_swab_qdata, NULL);
774 EXPORT_SYMBOL(RMF_QUNIT_DATA);
776 struct req_msg_field RMF_MDT_EPOCH =
777 DEFINE_MSGF("mdt_ioepoch", 0,
778 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
779 EXPORT_SYMBOL(RMF_MDT_EPOCH);
781 struct req_msg_field RMF_PTLRPC_BODY =
782 DEFINE_MSGF("ptlrpc_body", 0,
783 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
784 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
786 struct req_msg_field RMF_OBD_STATFS =
787 DEFINE_MSGF("obd_statfs", 0,
788 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
789 EXPORT_SYMBOL(RMF_OBD_STATFS);
791 struct req_msg_field RMF_SETINFO_KEY =
792 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
793 EXPORT_SYMBOL(RMF_SETINFO_KEY);
795 struct req_msg_field RMF_NAME =
796 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
797 EXPORT_SYMBOL(RMF_NAME);
799 struct req_msg_field RMF_SYMTGT =
800 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
801 EXPORT_SYMBOL(RMF_SYMTGT);
803 struct req_msg_field RMF_TGTUUID =
804 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
806 EXPORT_SYMBOL(RMF_TGTUUID);
808 struct req_msg_field RMF_CLUUID =
809 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
811 EXPORT_SYMBOL(RMF_CLUUID);
813 struct req_msg_field RMF_STRING =
814 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
815 EXPORT_SYMBOL(RMF_STRING);
817 struct req_msg_field RMF_LLOGD_BODY =
818 DEFINE_MSGF("llogd_body", 0,
819 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
820 EXPORT_SYMBOL(RMF_LLOGD_BODY);
822 struct req_msg_field RMF_LLOG_LOG_HDR =
823 DEFINE_MSGF("llog_log_hdr", 0,
824 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
825 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
827 struct req_msg_field RMF_LLOGD_CONN_BODY =
828 DEFINE_MSGF("llogd_conn_body", 0,
829 sizeof(struct llogd_conn_body),
830 lustre_swab_llogd_conn_body, NULL);
831 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
834 * connection handle received in MDS_CONNECT request.
836 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
837 * that the client does not interpret at all.
839 struct req_msg_field RMF_CONN =
840 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
841 EXPORT_SYMBOL(RMF_CONN);
843 struct req_msg_field RMF_CONNECT_DATA =
845 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
846 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 9, 0, 0)
847 sizeof(struct obd_connect_data),
849 /* For interoperability with 1.8 and 2.0 clients/servers.
850 * The RPC verification code allows larger RPC buffers, but not
851 * smaller buffers. Until we no longer need to keep compatibility
852 * with older servers/clients we can only check that the buffer
853 * size is at least as large as obd_connect_data_v1. That is not
854 * not in itself harmful, since the chance of just corrupting this
855 * field is low. See JIRA LU-16 for details. */
856 sizeof(struct obd_connect_data_v1),
858 lustre_swab_connect, NULL);
859 EXPORT_SYMBOL(RMF_CONNECT_DATA);
861 struct req_msg_field RMF_DLM_REQ =
862 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
863 sizeof(struct ldlm_request),
864 lustre_swab_ldlm_request, NULL);
865 EXPORT_SYMBOL(RMF_DLM_REQ);
867 struct req_msg_field RMF_DLM_REP =
868 DEFINE_MSGF("dlm_rep", 0,
869 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
870 EXPORT_SYMBOL(RMF_DLM_REP);
872 struct req_msg_field RMF_LDLM_INTENT =
873 DEFINE_MSGF("ldlm_intent", 0,
874 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
875 EXPORT_SYMBOL(RMF_LDLM_INTENT);
877 struct req_msg_field RMF_DLM_LVB =
878 DEFINE_MSGF("dlm_lvb", 0, sizeof(union ldlm_wire_lvb), lustre_swab_lvb,
880 EXPORT_SYMBOL(RMF_DLM_LVB);
882 struct req_msg_field RMF_MDT_MD =
883 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
884 EXPORT_SYMBOL(RMF_MDT_MD);
886 struct req_msg_field RMF_REC_REINT =
887 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
888 lustre_swab_mdt_rec_reint, NULL);
889 EXPORT_SYMBOL(RMF_REC_REINT);
891 /* FIXME: this length should be defined as a macro */
892 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
894 EXPORT_SYMBOL(RMF_EADATA);
896 struct req_msg_field RMF_ACL =
897 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
898 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
899 EXPORT_SYMBOL(RMF_ACL);
901 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
902 struct req_msg_field RMF_LOGCOOKIES =
903 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
904 sizeof(struct llog_cookie), NULL, NULL);
905 EXPORT_SYMBOL(RMF_LOGCOOKIES);
907 struct req_msg_field RMF_CAPA1 =
908 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
909 lustre_swab_lustre_capa, NULL);
910 EXPORT_SYMBOL(RMF_CAPA1);
912 struct req_msg_field RMF_CAPA2 =
913 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
914 lustre_swab_lustre_capa, NULL);
915 EXPORT_SYMBOL(RMF_CAPA2);
920 struct req_msg_field RMF_OST_BODY =
921 DEFINE_MSGF("ost_body", 0,
922 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
923 EXPORT_SYMBOL(RMF_OST_BODY);
925 struct req_msg_field RMF_OBD_IOOBJ =
926 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
927 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
928 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
930 struct req_msg_field RMF_NIOBUF_REMOTE =
931 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
932 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
934 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
936 struct req_msg_field RMF_RCS =
937 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
938 lustre_swab_generic_32s, dump_rcs);
939 EXPORT_SYMBOL(RMF_RCS);
941 struct req_msg_field RMF_OBD_ID =
942 DEFINE_MSGF("obd_id", 0,
943 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
944 EXPORT_SYMBOL(RMF_OBD_ID);
946 struct req_msg_field RMF_FIEMAP_KEY =
947 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
948 lustre_swab_fiemap, NULL);
949 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
951 struct req_msg_field RMF_FIEMAP_VAL =
952 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
953 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
964 const struct req_msg_field **d;
968 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
982 #define DEFINE_REQ_FMT0(name, client, server) \
983 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
985 struct req_format RQF_OBD_PING =
986 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
987 EXPORT_SYMBOL(RQF_OBD_PING);
989 struct req_format RQF_OBD_SET_INFO =
990 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
991 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
993 struct req_format RQF_SEC_CTX =
994 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
995 EXPORT_SYMBOL(RQF_SEC_CTX);
997 struct req_format RQF_MGS_TARGET_REG =
998 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
999 mgs_target_info_only);
1000 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1002 struct req_format RQF_MGS_SET_INFO =
1003 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1005 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1007 struct req_format RQF_MGS_CONFIG_READ =
1008 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1009 mgs_config_read_server);
1010 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1012 struct req_format RQF_SEQ_QUERY =
1013 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1014 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1016 struct req_format RQF_FLD_QUERY =
1017 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1018 EXPORT_SYMBOL(RQF_FLD_QUERY);
1020 struct req_format RQF_LOG_CANCEL =
1021 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1022 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1024 struct req_format RQF_MDS_QUOTACHECK =
1025 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1026 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1028 struct req_format RQF_OST_QUOTACHECK =
1029 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1030 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1032 struct req_format RQF_MDS_QUOTACTL =
1033 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1034 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1036 struct req_format RQF_OST_QUOTACTL =
1037 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1038 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1040 struct req_format RQF_OST_QUOTA_ADJUST_QUNIT =
1041 DEFINE_REQ_FMT0("OST_QUOTA_ADJUST_QUNIT", quota_adjust_qunit_only,
1042 quota_adjust_qunit_only);
1043 EXPORT_SYMBOL(RQF_OST_QUOTA_ADJUST_QUNIT);
1045 struct req_format RQF_QC_CALLBACK =
1046 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1047 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1049 struct req_format RQF_MDS_QUOTA_DQACQ =
1050 DEFINE_REQ_FMT0("MDS_QUOTA_DQACQ", qunit_data_only, qunit_data_only);
1051 EXPORT_SYMBOL(RQF_MDS_QUOTA_DQACQ);
1053 struct req_format RQF_MDS_GETSTATUS =
1054 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1055 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1057 struct req_format RQF_MDS_STATFS =
1058 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1059 EXPORT_SYMBOL(RQF_MDS_STATFS);
1061 struct req_format RQF_MDS_SYNC =
1062 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1063 EXPORT_SYMBOL(RQF_MDS_SYNC);
1065 struct req_format RQF_MDS_GETATTR =
1066 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1067 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1069 struct req_format RQF_MDS_GETXATTR =
1070 DEFINE_REQ_FMT0("MDS_GETXATTR",
1071 mds_getxattr_client, mds_getxattr_server);
1072 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1074 struct req_format RQF_MDS_GETATTR_NAME =
1075 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1076 mds_getattr_name_client, mds_getattr_server);
1077 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1079 struct req_format RQF_MDS_REINT =
1080 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1081 EXPORT_SYMBOL(RQF_MDS_REINT);
1083 struct req_format RQF_MDS_REINT_CREATE =
1084 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1085 mds_reint_create_client, mdt_body_capa);
1086 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1088 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1089 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1090 mds_reint_create_rmt_acl_client, mdt_body_capa);
1091 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1093 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1094 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1095 mds_reint_create_slave_client, mdt_body_capa);
1096 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1098 struct req_format RQF_MDS_REINT_CREATE_SYM =
1099 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1100 mds_reint_create_sym_client, mdt_body_capa);
1101 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1103 struct req_format RQF_MDS_REINT_OPEN =
1104 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1105 mds_reint_open_client, mds_reint_open_server);
1106 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1108 struct req_format RQF_MDS_REINT_UNLINK =
1109 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1110 mds_last_unlink_server);
1111 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1113 struct req_format RQF_MDS_REINT_LINK =
1114 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1115 mds_reint_link_client, mdt_body_only);
1116 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1118 struct req_format RQF_MDS_REINT_RENAME =
1119 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1120 mds_last_unlink_server);
1121 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1123 struct req_format RQF_MDS_REINT_SETATTR =
1124 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1125 mds_reint_setattr_client, mds_setattr_server);
1126 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1128 struct req_format RQF_MDS_REINT_SETXATTR =
1129 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1130 mds_reint_setxattr_client, mdt_body_only);
1131 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1133 struct req_format RQF_MDS_CONNECT =
1134 DEFINE_REQ_FMT0("MDS_CONNECT",
1135 obd_connect_client, obd_connect_server);
1136 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1138 struct req_format RQF_MDS_DISCONNECT =
1139 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1140 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1142 struct req_format RQF_MDS_GET_INFO =
1143 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1144 mds_getinfo_server);
1145 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1147 struct req_format RQF_LDLM_ENQUEUE =
1148 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1149 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1150 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1152 struct req_format RQF_LDLM_ENQUEUE_LVB =
1153 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1154 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1155 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1157 struct req_format RQF_LDLM_CONVERT =
1158 DEFINE_REQ_FMT0("LDLM_CONVERT",
1159 ldlm_enqueue_client, ldlm_enqueue_server);
1160 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1162 struct req_format RQF_LDLM_CANCEL =
1163 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1164 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1166 struct req_format RQF_LDLM_CALLBACK =
1167 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1168 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1170 struct req_format RQF_LDLM_CP_CALLBACK =
1171 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1172 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1174 struct req_format RQF_LDLM_BL_CALLBACK =
1175 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1176 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1178 struct req_format RQF_LDLM_GL_CALLBACK =
1179 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1180 ldlm_gl_callback_server);
1181 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1183 struct req_format RQF_LDLM_INTENT =
1184 DEFINE_REQ_FMT0("LDLM_INTENT",
1185 ldlm_intent_client, ldlm_intent_server);
1186 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1188 struct req_format RQF_LDLM_INTENT_GETATTR =
1189 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1190 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1191 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1193 struct req_format RQF_LDLM_INTENT_OPEN =
1194 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1195 ldlm_intent_open_client, ldlm_intent_open_server);
1196 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1198 struct req_format RQF_LDLM_INTENT_CREATE =
1199 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1200 ldlm_intent_create_client, ldlm_intent_getattr_server);
1201 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1203 struct req_format RQF_LDLM_INTENT_UNLINK =
1204 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1205 ldlm_intent_unlink_client, ldlm_intent_server);
1206 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1208 struct req_format RQF_MDS_CLOSE =
1209 DEFINE_REQ_FMT0("MDS_CLOSE",
1210 mdt_close_client, mds_last_unlink_server);
1211 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1213 struct req_format RQF_MDS_PIN =
1214 DEFINE_REQ_FMT0("MDS_PIN",
1215 mdt_body_capa, mdt_body_only);
1216 EXPORT_SYMBOL(RQF_MDS_PIN);
1218 struct req_format RQF_MDS_UNPIN =
1219 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1220 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1222 struct req_format RQF_MDS_DONE_WRITING =
1223 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1224 mdt_close_client, mdt_body_only);
1225 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1227 struct req_format RQF_MDS_READPAGE =
1228 DEFINE_REQ_FMT0("MDS_READPAGE",
1229 mdt_body_capa, mdt_body_only);
1230 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1232 /* This is for split */
1233 struct req_format RQF_MDS_WRITEPAGE =
1234 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1235 mdt_body_capa, mdt_body_only);
1236 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1238 struct req_format RQF_MDS_IS_SUBDIR =
1239 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1240 mdt_body_only, mdt_body_only);
1241 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1243 struct req_format RQF_LLOG_CATINFO =
1244 DEFINE_REQ_FMT0("LLOG_CATINFO",
1245 llog_catinfo_client, llog_catinfo_server);
1246 EXPORT_SYMBOL(RQF_LLOG_CATINFO);
1248 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1249 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1250 llog_origin_handle_create_client, llogd_body_only);
1251 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1253 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1254 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1255 llogd_body_only, llogd_body_only);
1256 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1258 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1259 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1260 llogd_body_only, llog_origin_handle_next_block_server);
1261 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1263 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1264 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1265 llogd_body_only, llog_origin_handle_next_block_server);
1266 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1268 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1269 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1270 llogd_body_only, llog_log_hdr_only);
1271 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1273 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1274 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1275 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1277 struct req_format RQF_OST_CONNECT =
1278 DEFINE_REQ_FMT0("OST_CONNECT",
1279 obd_connect_client, obd_connect_server);
1280 EXPORT_SYMBOL(RQF_OST_CONNECT);
1282 struct req_format RQF_OST_DISCONNECT =
1283 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1284 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1286 struct req_format RQF_OST_GETATTR =
1287 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1288 EXPORT_SYMBOL(RQF_OST_GETATTR);
1290 struct req_format RQF_OST_SETATTR =
1291 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1292 EXPORT_SYMBOL(RQF_OST_SETATTR);
1294 struct req_format RQF_OST_CREATE =
1295 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1296 EXPORT_SYMBOL(RQF_OST_CREATE);
1298 struct req_format RQF_OST_PUNCH =
1299 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1300 EXPORT_SYMBOL(RQF_OST_PUNCH);
1302 struct req_format RQF_OST_SYNC =
1303 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1304 EXPORT_SYMBOL(RQF_OST_SYNC);
1306 struct req_format RQF_OST_DESTROY =
1307 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1308 EXPORT_SYMBOL(RQF_OST_DESTROY);
1310 struct req_format RQF_OST_BRW_READ =
1311 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1312 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1314 struct req_format RQF_OST_BRW_WRITE =
1315 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1316 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1318 struct req_format RQF_OST_STATFS =
1319 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1320 EXPORT_SYMBOL(RQF_OST_STATFS);
1322 struct req_format RQF_OST_SET_GRANT_INFO =
1323 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1325 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1327 struct req_format RQF_OST_GET_INFO_GENERIC =
1328 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1329 ost_get_info_generic_server);
1330 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1332 struct req_format RQF_OST_GET_INFO_LAST_ID =
1333 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1334 ost_get_last_id_server);
1335 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1337 struct req_format RQF_OST_GET_INFO_FIEMAP =
1338 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1339 ost_get_fiemap_server);
1340 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1343 #if !defined(__REQ_LAYOUT_USER__)
1345 /* Convenience macro */
1346 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1349 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1350 * field of RQFs and the \a rmf_offset field of RMFs.
1352 int req_layout_init(void)
1357 struct req_format *rf = NULL;
1359 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1360 rf = req_formats[i];
1362 for (j = 0; j < RCL_NR; ++j) {
1363 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1364 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1365 struct req_msg_field *field;
1367 field = (typeof(field))rf->rf_fields[j].d[k];
1368 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1369 || field->rmf_size > 0);
1370 LASSERT(field->rmf_offset[i][j] == 0);
1372 * k + 1 to detect unused format/field
1375 field->rmf_offset[i][j] = k + 1;
1381 EXPORT_SYMBOL(req_layout_init);
1383 void req_layout_fini(void)
1386 EXPORT_SYMBOL(req_layout_fini);
1389 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1391 * Actual/expected field sizes are set elsewhere in functions in this file:
1392 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1393 * req_capsule_msg_size(). The \a rc_area information is used by.
1394 * ptlrpc_request_set_replen().
1396 void req_capsule_init_area(struct req_capsule *pill)
1400 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1401 pill->rc_area[RCL_CLIENT][i] = -1;
1402 pill->rc_area[RCL_SERVER][i] = -1;
1405 EXPORT_SYMBOL(req_capsule_init_area);
1408 * Initialize a pill.
1410 * The \a location indicates whether the caller is executing on the client side
1411 * (RCL_CLIENT) or server side (RCL_SERVER)..
1413 void req_capsule_init(struct req_capsule *pill,
1414 struct ptlrpc_request *req,
1415 enum req_location location)
1417 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1420 * Today all capsules are embedded in ptlrpc_request structs,
1421 * but just in case that ever isn't the case, we don't reach
1422 * into req unless req != NULL and pill is the one embedded in
1425 * The req->rq_pill_init flag makes it safe to initialize a pill
1426 * twice, which might happen in the OST paths as a result of the
1427 * high-priority RPC queue getting peeked at before ost_handle()
1428 * handles an OST RPC.
1430 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1433 memset(pill, 0, sizeof *pill);
1435 pill->rc_loc = location;
1436 req_capsule_init_area(pill);
1438 if (req != NULL && pill == &req->rq_pill)
1439 req->rq_pill_init = 1;
1441 EXPORT_SYMBOL(req_capsule_init);
1443 void req_capsule_fini(struct req_capsule *pill)
1446 EXPORT_SYMBOL(req_capsule_fini);
1448 static int __req_format_is_sane(const struct req_format *fmt)
1451 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1452 req_formats[fmt->rf_idx] == fmt;
1455 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1456 enum req_location loc)
1458 struct ptlrpc_request *req;
1461 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1465 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1466 * (see req_capsule_extend()).
1468 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1470 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1471 LASSERT(__req_format_is_sane(fmt));
1475 EXPORT_SYMBOL(req_capsule_set);
1478 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1481 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1482 * variable-sized fields. The field sizes come from the declared \a rmf_size
1483 * field of a \a pill's \a rc_fmt's RMF's.
1485 int req_capsule_filled_sizes(struct req_capsule *pill,
1486 enum req_location loc)
1488 const struct req_format *fmt = pill->rc_fmt;
1491 LASSERT(fmt != NULL);
1493 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1494 if (pill->rc_area[loc][i] == -1) {
1495 pill->rc_area[loc][i] =
1496 fmt->rf_fields[loc].d[i]->rmf_size;
1497 if (pill->rc_area[loc][i] == -1) {
1499 * Skip the following fields.
1501 * If this LASSERT() trips then you're missing a
1502 * call to req_capsule_set_size().
1504 LASSERT(loc != RCL_SERVER);
1511 EXPORT_SYMBOL(req_capsule_filled_sizes);
1514 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1516 * This function uses the \a pill's \a rc_area as filled in by
1517 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1520 int req_capsule_server_pack(struct req_capsule *pill)
1522 const struct req_format *fmt;
1526 LASSERT(pill->rc_loc == RCL_SERVER);
1528 LASSERT(fmt != NULL);
1530 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1531 rc = lustre_pack_reply(pill->rc_req, count,
1532 pill->rc_area[RCL_SERVER], NULL);
1534 DEBUG_REQ(D_ERROR, pill->rc_req,
1535 "Cannot pack %d fields in format `%s': ",
1536 count, fmt->rf_name);
1540 EXPORT_SYMBOL(req_capsule_server_pack);
1543 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1544 * corresponding to the given RMF (\a field).
1546 static int __req_capsule_offset(const struct req_capsule *pill,
1547 const struct req_msg_field *field,
1548 enum req_location loc)
1552 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1553 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1554 pill->rc_fmt->rf_name,
1555 field->rmf_name, offset, loc);
1558 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1563 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1568 swabber_dumper_helper(struct req_capsule *pill,
1569 const struct req_msg_field *field,
1570 enum req_location loc,
1572 void *value, int len, int dump, void (*swabber)( void *))
1578 int inout = loc == RCL_CLIENT;
1580 swabber = swabber ?: field->rmf_swabber;
1582 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1583 swabber != NULL && value != NULL)
1588 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1589 if (dump && field->rmf_dumper) {
1590 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1591 do_swab ? "unswabbed " : "", field->rmf_name);
1592 field->rmf_dumper(value);
1597 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1599 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1600 "follows\n", field->rmf_name);
1601 field->rmf_dumper(value);
1608 * We're swabbing an array; swabber() swabs a single array element, so
1609 * swab every element.
1611 LASSERT((len % field->rmf_size) == 0);
1612 for (p = value, i = 0, n = len / field->rmf_size;
1614 i++, p += field->rmf_size) {
1615 if (dump && field->rmf_dumper) {
1616 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1617 "element %d follows\n",
1618 do_swab ? "unswabbed " : "", field->rmf_name, i);
1619 field->rmf_dumper(p);
1624 if (dump && field->rmf_dumper) {
1625 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1626 "element %d follows\n", field->rmf_name, i);
1627 field->rmf_dumper(value);
1631 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1635 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1636 * corresponding to the given RMF (\a field).
1638 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1639 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1640 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1641 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1642 * element of the array swabbed.
1644 static void *__req_capsule_get(struct req_capsule *pill,
1645 const struct req_msg_field *field,
1646 enum req_location loc,
1647 void (*swabber)( void *),
1650 const struct req_format *fmt;
1651 struct lustre_msg *msg;
1656 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1658 static const char *rcl_names[RCL_NR] = {
1659 [RCL_CLIENT] = "client",
1660 [RCL_SERVER] = "server"
1663 LASSERT(pill != NULL);
1664 LASSERT(pill != LP_POISON);
1666 LASSERT(fmt != NULL);
1667 LASSERT(fmt != LP_POISON);
1668 LASSERT(__req_format_is_sane(fmt));
1670 offset = __req_capsule_offset(pill, field, loc);
1672 msg = __req_msg(pill, loc);
1673 LASSERT(msg != NULL);
1675 getter = (field->rmf_flags & RMF_F_STRING) ?
1676 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1678 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1680 * We've already asserted that field->rmf_size > 0 in
1681 * req_layout_init().
1683 len = lustre_msg_buflen(msg, offset);
1684 if ((len % field->rmf_size) != 0) {
1685 CERROR("%s: array field size mismatch "
1686 "%d modulo %d != 0 (%d)\n",
1687 field->rmf_name, len, field->rmf_size, loc);
1690 } else if (pill->rc_area[loc][offset] != -1) {
1691 len = pill->rc_area[loc][offset];
1693 len = max(field->rmf_size, 0);
1695 value = getter(msg, offset, len);
1697 if (value == NULL) {
1698 DEBUG_REQ(D_ERROR, pill->rc_req,
1699 "Wrong buffer for field `%s' (%d of %d) "
1700 "in format `%s': %d vs. %d (%s)\n",
1701 field->rmf_name, offset, lustre_msg_bufcount(msg),
1702 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1705 swabber_dumper_helper(pill, field, loc, offset, value, len,
1713 * Dump a request and/or reply
1715 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1717 const struct req_format *fmt;
1718 const struct req_msg_field *field;
1724 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1725 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1726 field = FMT_FIELD(fmt, loc, i);
1727 if (field->rmf_dumper == NULL) {
1729 * FIXME Add a default hex dumper for fields that don't
1730 * have a specific dumper
1732 len = req_capsule_get_size(pill, field, loc);
1733 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1734 "field size is %d\n", field->rmf_name, len);
1736 /* It's the dumping side-effect that we're interested in */
1737 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1740 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1746 void req_capsule_client_dump(struct req_capsule *pill)
1748 __req_capsule_dump(pill, RCL_CLIENT);
1750 EXPORT_SYMBOL(req_capsule_client_dump);
1755 void req_capsule_server_dump(struct req_capsule *pill)
1757 __req_capsule_dump(pill, RCL_SERVER);
1759 EXPORT_SYMBOL(req_capsule_server_dump);
1762 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
1763 * buffer corresponding to the given RMF (\a field) of a \a pill.
1765 void *req_capsule_client_get(struct req_capsule *pill,
1766 const struct req_msg_field *field)
1768 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1770 EXPORT_SYMBOL(req_capsule_client_get);
1773 * Same as req_capsule_client_get(), but with a \a swabber argument.
1775 * Currently unused; will be removed when req_capsule_server_swab_get() is
1778 void *req_capsule_client_swab_get(struct req_capsule *pill,
1779 const struct req_msg_field *field,
1780 void (*swabber)(void* ))
1782 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
1784 EXPORT_SYMBOL(req_capsule_client_swab_get);
1787 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
1789 * First the \a pill's request \a field's size is set (\a rc_area) using
1790 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1793 void *req_capsule_client_sized_get(struct req_capsule *pill,
1794 const struct req_msg_field *field,
1797 req_capsule_set_size(pill, field, RCL_CLIENT, len);
1798 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1800 EXPORT_SYMBOL(req_capsule_client_sized_get);
1803 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
1804 * buffer corresponding to the given RMF (\a field) of a \a pill.
1806 void *req_capsule_server_get(struct req_capsule *pill,
1807 const struct req_msg_field *field)
1809 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1811 EXPORT_SYMBOL(req_capsule_server_get);
1814 * Same as req_capsule_server_get(), but with a \a swabber argument.
1816 * Ideally all swabbing should be done pursuant to RMF definitions, with no
1817 * swabbing done outside this capsule abstraction.
1819 void *req_capsule_server_swab_get(struct req_capsule *pill,
1820 const struct req_msg_field *field,
1823 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
1825 EXPORT_SYMBOL(req_capsule_server_swab_get);
1828 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
1830 * First the \a pill's request \a field's size is set (\a rc_area) using
1831 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1834 void *req_capsule_server_sized_get(struct req_capsule *pill,
1835 const struct req_msg_field *field,
1838 req_capsule_set_size(pill, field, RCL_SERVER, len);
1839 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1841 EXPORT_SYMBOL(req_capsule_server_sized_get);
1844 * Returns the buffer of a \a pill corresponding to the given \a field from the
1845 * request (if the caller is executing on the server-side) or reply (if the
1846 * caller is executing on the client-side).
1848 * This function convienient for use is code that could be executed on the
1849 * client and server alike.
1851 const void *req_capsule_other_get(struct req_capsule *pill,
1852 const struct req_msg_field *field)
1854 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
1856 EXPORT_SYMBOL(req_capsule_other_get);
1859 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
1860 * field of the given \a pill.
1862 * This function must be used when constructing variable sized fields of a
1865 void req_capsule_set_size(struct req_capsule *pill,
1866 const struct req_msg_field *field,
1867 enum req_location loc, int size)
1869 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1871 if ((size != field->rmf_size) &&
1872 (field->rmf_size != -1) &&
1873 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1875 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1876 (size % field->rmf_size != 0)) {
1877 CERROR("%s: array field size mismatch "
1878 "%d %% %d != 0 (%d)\n",
1879 field->rmf_name, size, field->rmf_size, loc);
1881 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1882 size < field->rmf_size) {
1883 CERROR("%s: field size mismatch %d != %d (%d)\n",
1884 field->rmf_name, size, field->rmf_size, loc);
1889 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
1891 EXPORT_SYMBOL(req_capsule_set_size);
1894 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
1895 * for the given \a pill's given \a field.
1897 * NB: this function doesn't correspond with req_capsule_set_size(), which
1898 * actually sets the size in pill.rc_area[loc][offset], but this function
1899 * returns the message buflen[offset], maybe we should use another name.
1901 int req_capsule_get_size(const struct req_capsule *pill,
1902 const struct req_msg_field *field,
1903 enum req_location loc)
1905 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1907 return lustre_msg_buflen(__req_msg(pill, loc),
1908 __req_capsule_offset(pill, field, loc));
1910 EXPORT_SYMBOL(req_capsule_get_size);
1913 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
1914 * given \a pill's request or reply (\a loc) given the field size recorded in
1915 * the \a pill's rc_area.
1917 * See also req_capsule_set_size().
1919 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
1921 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
1922 pill->rc_fmt->rf_fields[loc].nr,
1923 pill->rc_area[loc]);
1927 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
1928 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
1929 * PTLRPC request or reply given only an RQF (\a fmt).
1931 * This function should not be used for formats which contain variable size
1934 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
1935 enum req_location loc)
1940 * This function should probably LASSERT() that fmt has no fields with
1941 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
1942 * elements in the array there will ultimately be, but then, we could
1943 * assume that there will be at least one element, and that's just what
1946 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
1950 for (; i < fmt->rf_fields[loc].nr; ++i)
1951 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
1952 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
1958 * Changes the format of an RPC.
1960 * The pill must already have been initialized, which means that it already has
1961 * a request format. The new format \a fmt must be an extension of the pill's
1962 * old format. Specifically: the new format must have as many request and reply
1963 * fields as the old one, and all fields shared by the old and new format must
1964 * be at least as large in the new format.
1966 * The new format's fields may be of different "type" than the old format, but
1967 * only for fields that are "opaque" blobs: fields which have a) have no
1968 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
1969 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
1970 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
1971 * according to the key field. When the value, according to the key, contains a
1972 * structure (or array thereof) to be swabbed, the format should be changed to
1973 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
1976 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
1981 const struct req_format *old;
1983 LASSERT(pill->rc_fmt != NULL);
1984 LASSERT(__req_format_is_sane(fmt));
1988 * Sanity checking...
1990 for (i = 0; i < RCL_NR; ++i) {
1991 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
1992 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
1993 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
1995 /* "opaque" fields can be transmogrified */
1996 if (ofield->rmf_swabber == NULL &&
1997 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
1998 (ofield->rmf_size == -1 ||
1999 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2001 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2004 * Last field in old format can be shorter than in new.
2006 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2007 FMT_FIELD(old, i, j)->rmf_size);
2012 EXPORT_SYMBOL(req_capsule_extend);
2015 * This function returns a non-zero value if the given \a field is present in
2016 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2019 int req_capsule_has_field(const struct req_capsule *pill,
2020 const struct req_msg_field *field,
2021 enum req_location loc)
2023 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2025 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2027 EXPORT_SYMBOL(req_capsule_has_field);
2030 * Returns a non-zero value if the given \a field is present in the given \a
2031 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2033 int req_capsule_field_present(const struct req_capsule *pill,
2034 const struct req_msg_field *field,
2035 enum req_location loc)
2039 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2040 LASSERT(req_capsule_has_field(pill, field, loc));
2042 offset = __req_capsule_offset(pill, field, loc);
2043 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2045 EXPORT_SYMBOL(req_capsule_field_present);
2048 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2049 * request or reply (\a loc).
2051 * This is not the opposite of req_capsule_extend().
2053 void req_capsule_shrink(struct req_capsule *pill,
2054 const struct req_msg_field *field,
2055 unsigned int newlen,
2056 enum req_location loc)
2058 const struct req_format *fmt;
2059 struct lustre_msg *msg;
2064 LASSERT(fmt != NULL);
2065 LASSERT(__req_format_is_sane(fmt));
2066 LASSERT(req_capsule_has_field(pill, field, loc));
2067 LASSERT(req_capsule_field_present(pill, field, loc));
2069 offset = __req_capsule_offset(pill, field, loc);
2071 msg = __req_msg(pill, loc);
2072 len = lustre_msg_buflen(msg, offset);
2073 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2074 fmt->rf_name, field->rmf_name, len, newlen);
2076 if (loc == RCL_CLIENT)
2077 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2080 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2083 EXPORT_SYMBOL(req_capsule_shrink);
2085 int req_capsule_server_grow(struct req_capsule *pill,
2086 const struct req_msg_field *field,
2087 unsigned int newlen)
2089 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2091 int offset, len, rc;
2093 LASSERT(pill->rc_fmt != NULL);
2094 LASSERT(__req_format_is_sane(pill->rc_fmt));
2095 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2096 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2098 len = req_capsule_get_size(pill, field, RCL_SERVER);
2099 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2100 if (pill->rc_req->rq_repbuf_len >=
2101 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2102 CERROR("Inplace repack might be done\n");
2104 pill->rc_req->rq_reply_state = NULL;
2105 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2106 rc = req_capsule_server_pack(pill);
2108 /* put old rs back, the caller will decide what to do */
2109 pill->rc_req->rq_reply_state = rs;
2112 nrs = pill->rc_req->rq_reply_state;
2113 /* Now we need only buffers, copy first chunk */
2114 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2115 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2116 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2117 memcpy(to, from, len);
2118 /* check if we have tail and copy it too */
2119 if (rs->rs_msg->lm_bufcount > offset + 1) {
2120 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2121 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2122 offset = rs->rs_msg->lm_bufcount - 1;
2123 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2124 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2125 memcpy(to, from, len);
2127 /* drop old reply if everything is fine */
2128 if (rs->rs_difficult) {
2132 nrs->rs_difficult = 1;
2133 nrs->rs_no_ack = rs->rs_no_ack;
2134 for (i = 0; i < rs->rs_nlocks; i++) {
2135 nrs->rs_locks[i] = rs->rs_locks[i];
2136 nrs->rs_modes[i] = rs->rs_modes[i];
2140 rs->rs_difficult = 0;
2143 ptlrpc_rs_decref(rs);
2146 EXPORT_SYMBOL(req_capsule_server_grow);
2147 /* __REQ_LAYOUT_USER__ */