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__)
52 # define EXPORT_SYMTAB
54 #define DEBUG_SUBSYSTEM S_RPC
57 #include <linux/module.h>
59 # include <liblustre.h>
62 /* LUSTRE_VERSION_CODE */
63 #include <lustre_ver.h>
65 #include <obd_support.h>
66 /* lustre_swab_mdt_body */
67 #include <lustre/lustre_idl.h>
68 /* obd2cli_tgt() (required by DEBUG_REQ()) */
71 /* __REQ_LAYOUT_USER__ */
73 /* struct ptlrpc_request, lustre_msg* */
74 #include <lustre_req_layout.h>
75 #include <lustre_acl.h>
76 #include <lustre_debug.h>
79 * RQFs (see below) refer to two struct req_msg_field arrays describing the
80 * client request and server reply, respectively.
82 /* empty set of fields... for suitable definition of emptiness. */
83 static const struct req_msg_field *empty[] = {
87 static const struct req_msg_field *mgs_target_info_only[] = {
92 static const struct req_msg_field *mgs_set_info[] = {
97 static const struct req_msg_field *mgs_config_read_client[] = {
102 static const struct req_msg_field *mgs_config_read_server[] = {
107 static const struct req_msg_field *log_cancel_client[] = {
112 static const struct req_msg_field *mdt_body_only[] = {
117 static const struct req_msg_field *mdt_body_capa[] = {
123 static const struct req_msg_field *quotactl_only[] = {
127 static const struct req_msg_field *quota_adjust_qunit_only[] = {
129 &RMF_QUOTA_ADJUST_QUNIT
132 static const struct req_msg_field *qunit_data_only[] = {
137 static const struct req_msg_field *mdt_close_client[] = {
144 static const struct req_msg_field *obd_statfs_server[] = {
149 static const struct req_msg_field *seq_query_client[] = {
155 static const struct req_msg_field *seq_query_server[] = {
160 static const struct req_msg_field *fld_query_client[] = {
166 static const struct req_msg_field *fld_query_server[] = {
171 static const struct req_msg_field *mds_getattr_name_client[] = {
178 static const struct req_msg_field *mds_reint_client[] = {
183 static const struct req_msg_field *mds_reint_create_client[] = {
190 static const struct req_msg_field *mds_reint_create_slave_client[] = {
199 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
208 static const struct req_msg_field *mds_reint_create_sym_client[] = {
217 static const struct req_msg_field *mds_reint_open_client[] = {
226 static const struct req_msg_field *mds_reint_open_server[] = {
235 static const struct req_msg_field *mds_reint_unlink_client[] = {
243 static const struct req_msg_field *mds_reint_link_client[] = {
252 static const struct req_msg_field *mds_reint_rename_client[] = {
262 static const struct req_msg_field *mds_last_unlink_server[] = {
271 static const struct req_msg_field *mds_reint_setattr_client[] = {
281 static const struct req_msg_field *mds_reint_setxattr_client[] = {
289 static const struct req_msg_field *obd_connect_client[] = {
297 static const struct req_msg_field *obd_connect_server[] = {
302 static const struct req_msg_field *obd_set_info_client[] = {
308 static const struct req_msg_field *ost_grant_shrink_client[] = {
314 static const struct req_msg_field *mds_getinfo_client[] = {
320 static const struct req_msg_field *mds_getinfo_server[] = {
325 static const struct req_msg_field *ldlm_enqueue_client[] = {
330 static const struct req_msg_field *ldlm_enqueue_server[] = {
335 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
341 static const struct req_msg_field *ldlm_cp_callback_client[] = {
347 static const struct req_msg_field *ldlm_gl_callback_server[] = {
352 static const struct req_msg_field *ldlm_intent_client[] = {
359 static const struct req_msg_field *ldlm_intent_server[] = {
367 static const struct req_msg_field *ldlm_intent_open_server[] = {
377 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
381 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
386 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
395 static const struct req_msg_field *ldlm_intent_create_client[] = {
399 &RMF_REC_REINT, /* coincides with mds_reint_create_client[] */
405 static const struct req_msg_field *ldlm_intent_open_client[] = {
409 &RMF_REC_REINT, /* coincides with mds_reint_open_client[] */
416 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
420 &RMF_REC_REINT, /* coincides with mds_reint_unlink_client[] */
425 static const struct req_msg_field *mds_getxattr_client[] = {
433 static const struct req_msg_field *mds_getxattr_server[] = {
439 static const struct req_msg_field *mds_getattr_server[] = {
448 static const struct req_msg_field *mds_setattr_server[] = {
457 static const struct req_msg_field *llog_catinfo_client[] = {
463 static const struct req_msg_field *llog_catinfo_server[] = {
468 static const struct req_msg_field *llog_origin_handle_create_client[] = {
474 static const struct req_msg_field *llogd_body_only[] = {
479 static const struct req_msg_field *llog_log_hdr_only[] = {
484 static const struct req_msg_field *llogd_conn_body_only[] = {
489 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
495 static const struct req_msg_field *ost_body_only[] = {
500 static const struct req_msg_field *ost_body_capa[] = {
506 static const struct req_msg_field *ost_destroy_client[] = {
514 static const struct req_msg_field *ost_brw_client[] = {
522 static const struct req_msg_field *ost_brw_read_server[] = {
527 static const struct req_msg_field *ost_brw_write_server[] = {
533 static const struct req_msg_field *ost_get_info_generic_server[] = {
538 static const struct req_msg_field *ost_get_info_generic_client[] = {
543 static const struct req_msg_field *ost_get_last_id_server[] = {
548 static const struct req_msg_field *ost_get_fiemap_client[] = {
554 static const struct req_msg_field *ost_get_fiemap_server[] = {
559 static struct req_format *req_formats[] = {
565 &RQF_MGS_CONFIG_READ,
574 &RQF_MDS_GETATTR_NAME,
583 &RQF_MDS_DONE_WRITING,
585 &RQF_MDS_REINT_CREATE,
586 &RQF_MDS_REINT_CREATE_RMT_ACL,
587 &RQF_MDS_REINT_CREATE_SLAVE,
588 &RQF_MDS_REINT_CREATE_SYM,
590 &RQF_MDS_REINT_UNLINK,
592 &RQF_MDS_REINT_RENAME,
593 &RQF_MDS_REINT_SETATTR,
594 &RQF_MDS_REINT_SETXATTR,
597 &RQF_MDS_QUOTA_DQACQ,
603 &RQF_OST_QUOTA_ADJUST_QUNIT,
613 &RQF_OST_SET_GRANT_INFO,
614 &RQF_OST_GET_INFO_GENERIC,
615 &RQF_OST_GET_INFO_LAST_ID,
616 &RQF_OST_GET_INFO_FIEMAP,
618 &RQF_LDLM_ENQUEUE_LVB,
622 &RQF_LDLM_CP_CALLBACK,
623 &RQF_LDLM_BL_CALLBACK,
624 &RQF_LDLM_GL_CALLBACK,
626 &RQF_LDLM_INTENT_GETATTR,
627 &RQF_LDLM_INTENT_OPEN,
628 &RQF_LDLM_INTENT_CREATE,
629 &RQF_LDLM_INTENT_UNLINK,
632 &RQF_LLOG_ORIGIN_HANDLE_CREATE,
633 &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
634 &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
635 &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
636 &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
637 &RQF_LLOG_ORIGIN_CONNECT
640 struct req_msg_field {
641 const __u32 rmf_flags;
642 const char *rmf_name;
644 * Field length. (-1) means "variable length". If the
645 * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
646 * but the actual size must be a whole multiple of \a rmf_size.
649 void (*rmf_swabber)(void *);
650 void (*rmf_dumper)(void *);
651 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
656 * The field is a string, must be NUL-terminated.
658 RMF_F_STRING = 1 << 0,
660 * The field's buffer size need not match the declared \a rmf_size.
662 RMF_F_NO_SIZE_CHECK = 1 << 1,
664 * The field's buffer size must be a whole multiple of the declared \a
665 * rmf_size and the \a rmf_swabber function must work on the declared \a
666 * rmf_size worth of bytes.
668 RMF_F_STRUCT_ARRAY = 1 << 2
676 #define DEFINE_MSGF(name, flags, size, swabber, dumper) { \
677 .rmf_name = (name), \
678 .rmf_flags = (flags), \
679 .rmf_size = (size), \
680 .rmf_swabber = (void (*)(void*))(swabber), \
681 .rmf_dumper = (void (*)(void*))(dumper) \
684 struct req_msg_field RMF_GENERIC_DATA =
685 DEFINE_MSGF("generic_data", 0,
687 EXPORT_SYMBOL(RMF_GENERIC_DATA);
689 struct req_msg_field RMF_MGS_TARGET_INFO =
690 DEFINE_MSGF("mgs_target_info", 0,
691 sizeof(struct mgs_target_info),
692 lustre_swab_mgs_target_info, NULL);
693 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
695 struct req_msg_field RMF_MGS_SEND_PARAM =
696 DEFINE_MSGF("mgs_send_param", 0,
697 sizeof(struct mgs_send_param),
699 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
701 struct req_msg_field RMF_MGS_CONFIG_BODY =
702 DEFINE_MSGF("mgs_config_read request", 0,
703 sizeof(struct mgs_config_body),
704 lustre_swab_mgs_config_body, NULL);
705 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
707 struct req_msg_field RMF_MGS_CONFIG_RES =
708 DEFINE_MSGF("mgs_config_read reply ", 0,
709 sizeof(struct mgs_config_res),
710 lustre_swab_mgs_config_res, NULL);
711 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
713 struct req_msg_field RMF_U32 =
714 DEFINE_MSGF("generic u32", 0,
715 sizeof(__u32), lustre_swab_generic_32s, NULL);
716 EXPORT_SYMBOL(RMF_U32);
718 struct req_msg_field RMF_SETINFO_VAL =
719 DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
720 EXPORT_SYMBOL(RMF_SETINFO_VAL);
722 struct req_msg_field RMF_GETINFO_KEY =
723 DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
724 EXPORT_SYMBOL(RMF_GETINFO_KEY);
726 struct req_msg_field RMF_GETINFO_VALLEN =
727 DEFINE_MSGF("getinfo_vallen", 0,
728 sizeof(__u32), lustre_swab_generic_32s, NULL);
729 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
731 struct req_msg_field RMF_GETINFO_VAL =
732 DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
733 EXPORT_SYMBOL(RMF_GETINFO_VAL);
735 struct req_msg_field RMF_SEQ_OPC =
736 DEFINE_MSGF("seq_query_opc", 0,
737 sizeof(__u32), lustre_swab_generic_32s, NULL);
738 EXPORT_SYMBOL(RMF_SEQ_OPC);
740 struct req_msg_field RMF_SEQ_RANGE =
741 DEFINE_MSGF("seq_query_range", 0,
742 sizeof(struct lu_seq_range),
743 lustre_swab_lu_seq_range, NULL);
744 EXPORT_SYMBOL(RMF_SEQ_RANGE);
746 struct req_msg_field RMF_FLD_OPC =
747 DEFINE_MSGF("fld_query_opc", 0,
748 sizeof(__u32), lustre_swab_generic_32s, NULL);
749 EXPORT_SYMBOL(RMF_FLD_OPC);
751 struct req_msg_field RMF_FLD_MDFLD =
752 DEFINE_MSGF("fld_query_mdfld", 0,
753 sizeof(struct lu_seq_range),
754 lustre_swab_lu_seq_range, NULL);
755 EXPORT_SYMBOL(RMF_FLD_MDFLD);
757 struct req_msg_field RMF_MDT_BODY =
758 DEFINE_MSGF("mdt_body", 0,
759 sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
760 EXPORT_SYMBOL(RMF_MDT_BODY);
762 struct req_msg_field RMF_OBD_QUOTACTL =
763 DEFINE_MSGF("obd_quotactl", 0,
764 sizeof(struct obd_quotactl),
765 lustre_swab_obd_quotactl, NULL);
766 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
768 struct req_msg_field RMF_QUOTA_ADJUST_QUNIT =
769 DEFINE_MSGF("quota_adjust_qunit", 0,
770 sizeof(struct quota_adjust_qunit),
771 lustre_swab_quota_adjust_qunit, NULL);
772 EXPORT_SYMBOL(RMF_QUOTA_ADJUST_QUNIT);
774 struct req_msg_field RMF_QUNIT_DATA =
775 DEFINE_MSGF("qunit_data", 0,
776 sizeof(struct qunit_data), lustre_swab_qdata, NULL);
777 EXPORT_SYMBOL(RMF_QUNIT_DATA);
779 struct req_msg_field RMF_MDT_EPOCH =
780 DEFINE_MSGF("mdt_ioepoch", 0,
781 sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
782 EXPORT_SYMBOL(RMF_MDT_EPOCH);
784 struct req_msg_field RMF_PTLRPC_BODY =
785 DEFINE_MSGF("ptlrpc_body", 0,
786 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
787 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
789 struct req_msg_field RMF_OBD_STATFS =
790 DEFINE_MSGF("obd_statfs", 0,
791 sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
792 EXPORT_SYMBOL(RMF_OBD_STATFS);
794 struct req_msg_field RMF_SETINFO_KEY =
795 DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
796 EXPORT_SYMBOL(RMF_SETINFO_KEY);
798 struct req_msg_field RMF_NAME =
799 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
800 EXPORT_SYMBOL(RMF_NAME);
802 struct req_msg_field RMF_SYMTGT =
803 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
804 EXPORT_SYMBOL(RMF_SYMTGT);
806 struct req_msg_field RMF_TGTUUID =
807 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
809 EXPORT_SYMBOL(RMF_TGTUUID);
811 struct req_msg_field RMF_CLUUID =
812 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
814 EXPORT_SYMBOL(RMF_CLUUID);
816 struct req_msg_field RMF_STRING =
817 DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
818 EXPORT_SYMBOL(RMF_STRING);
820 struct req_msg_field RMF_LLOGD_BODY =
821 DEFINE_MSGF("llogd_body", 0,
822 sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
823 EXPORT_SYMBOL(RMF_LLOGD_BODY);
825 struct req_msg_field RMF_LLOG_LOG_HDR =
826 DEFINE_MSGF("llog_log_hdr", 0,
827 sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
828 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
830 struct req_msg_field RMF_LLOGD_CONN_BODY =
831 DEFINE_MSGF("llogd_conn_body", 0,
832 sizeof(struct llogd_conn_body),
833 lustre_swab_llogd_conn_body, NULL);
834 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
837 * connection handle received in MDS_CONNECT request.
839 * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
840 * that the client does not interpret at all.
842 struct req_msg_field RMF_CONN =
843 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
844 EXPORT_SYMBOL(RMF_CONN);
846 struct req_msg_field RMF_CONNECT_DATA =
848 RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
849 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 9, 0, 0)
850 sizeof(struct obd_connect_data),
852 /* For interoperability with 1.8 and 2.0 clients/servers.
853 * The RPC verification code allows larger RPC buffers, but not
854 * smaller buffers. Until we no longer need to keep compatibility
855 * with older servers/clients we can only check that the buffer
856 * size is at least as large as obd_connect_data_v1. That is not
857 * not in itself harmful, since the chance of just corrupting this
858 * field is low. See JIRA LU-16 for details. */
859 sizeof(struct obd_connect_data_v1),
861 lustre_swab_connect, NULL);
862 EXPORT_SYMBOL(RMF_CONNECT_DATA);
864 struct req_msg_field RMF_DLM_REQ =
865 DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
866 sizeof(struct ldlm_request),
867 lustre_swab_ldlm_request, NULL);
868 EXPORT_SYMBOL(RMF_DLM_REQ);
870 struct req_msg_field RMF_DLM_REP =
871 DEFINE_MSGF("dlm_rep", 0,
872 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
873 EXPORT_SYMBOL(RMF_DLM_REP);
875 struct req_msg_field RMF_LDLM_INTENT =
876 DEFINE_MSGF("ldlm_intent", 0,
877 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
878 EXPORT_SYMBOL(RMF_LDLM_INTENT);
880 struct req_msg_field RMF_DLM_LVB =
881 DEFINE_MSGF("dlm_lvb", 0, sizeof(union ldlm_wire_lvb), lustre_swab_lvb,
883 EXPORT_SYMBOL(RMF_DLM_LVB);
885 struct req_msg_field RMF_MDT_MD =
886 DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
887 EXPORT_SYMBOL(RMF_MDT_MD);
889 struct req_msg_field RMF_REC_REINT =
890 DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
891 lustre_swab_mdt_rec_reint, NULL);
892 EXPORT_SYMBOL(RMF_REC_REINT);
894 /* FIXME: this length should be defined as a macro */
895 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
897 EXPORT_SYMBOL(RMF_EADATA);
899 struct req_msg_field RMF_ACL =
900 DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
901 LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
902 EXPORT_SYMBOL(RMF_ACL);
904 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
905 struct req_msg_field RMF_LOGCOOKIES =
906 DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
907 sizeof(struct llog_cookie), NULL, NULL);
908 EXPORT_SYMBOL(RMF_LOGCOOKIES);
910 struct req_msg_field RMF_CAPA1 =
911 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
912 lustre_swab_lustre_capa, NULL);
913 EXPORT_SYMBOL(RMF_CAPA1);
915 struct req_msg_field RMF_CAPA2 =
916 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
917 lustre_swab_lustre_capa, NULL);
918 EXPORT_SYMBOL(RMF_CAPA2);
923 struct req_msg_field RMF_OST_BODY =
924 DEFINE_MSGF("ost_body", 0,
925 sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
926 EXPORT_SYMBOL(RMF_OST_BODY);
928 struct req_msg_field RMF_OBD_IOOBJ =
929 DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
930 sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
931 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
933 struct req_msg_field RMF_NIOBUF_REMOTE =
934 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
935 sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
937 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
939 struct req_msg_field RMF_RCS =
940 DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
941 lustre_swab_generic_32s, dump_rcs);
942 EXPORT_SYMBOL(RMF_RCS);
944 struct req_msg_field RMF_OBD_ID =
945 DEFINE_MSGF("obd_id", 0,
946 sizeof(obd_id), lustre_swab_ost_last_id, NULL);
947 EXPORT_SYMBOL(RMF_OBD_ID);
949 struct req_msg_field RMF_FIEMAP_KEY =
950 DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
951 lustre_swab_fiemap, NULL);
952 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
954 struct req_msg_field RMF_FIEMAP_VAL =
955 DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
956 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
967 const struct req_msg_field **d;
971 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
985 #define DEFINE_REQ_FMT0(name, client, server) \
986 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
988 struct req_format RQF_OBD_PING =
989 DEFINE_REQ_FMT0("OBD_PING", empty, empty);
990 EXPORT_SYMBOL(RQF_OBD_PING);
992 struct req_format RQF_OBD_SET_INFO =
993 DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
994 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
996 struct req_format RQF_SEC_CTX =
997 DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
998 EXPORT_SYMBOL(RQF_SEC_CTX);
1000 struct req_format RQF_MGS_TARGET_REG =
1001 DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1002 mgs_target_info_only);
1003 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1005 struct req_format RQF_MGS_SET_INFO =
1006 DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1008 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1010 struct req_format RQF_MGS_CONFIG_READ =
1011 DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1012 mgs_config_read_server);
1013 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1015 struct req_format RQF_SEQ_QUERY =
1016 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1017 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1019 struct req_format RQF_FLD_QUERY =
1020 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1021 EXPORT_SYMBOL(RQF_FLD_QUERY);
1023 struct req_format RQF_LOG_CANCEL =
1024 DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1025 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1027 struct req_format RQF_MDS_QUOTACHECK =
1028 DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
1029 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1031 struct req_format RQF_OST_QUOTACHECK =
1032 DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1033 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1035 struct req_format RQF_MDS_QUOTACTL =
1036 DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1037 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1039 struct req_format RQF_OST_QUOTACTL =
1040 DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1041 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1043 struct req_format RQF_OST_QUOTA_ADJUST_QUNIT =
1044 DEFINE_REQ_FMT0("OST_QUOTA_ADJUST_QUNIT", quota_adjust_qunit_only,
1045 quota_adjust_qunit_only);
1046 EXPORT_SYMBOL(RQF_OST_QUOTA_ADJUST_QUNIT);
1048 struct req_format RQF_QC_CALLBACK =
1049 DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1050 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1052 struct req_format RQF_MDS_QUOTA_DQACQ =
1053 DEFINE_REQ_FMT0("MDS_QUOTA_DQACQ", qunit_data_only, qunit_data_only);
1054 EXPORT_SYMBOL(RQF_MDS_QUOTA_DQACQ);
1056 struct req_format RQF_MDS_GETSTATUS =
1057 DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1058 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1060 struct req_format RQF_MDS_STATFS =
1061 DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1062 EXPORT_SYMBOL(RQF_MDS_STATFS);
1064 struct req_format RQF_MDS_SYNC =
1065 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1066 EXPORT_SYMBOL(RQF_MDS_SYNC);
1068 struct req_format RQF_MDS_GETATTR =
1069 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1070 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1072 struct req_format RQF_MDS_GETXATTR =
1073 DEFINE_REQ_FMT0("MDS_GETXATTR",
1074 mds_getxattr_client, mds_getxattr_server);
1075 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1077 struct req_format RQF_MDS_GETATTR_NAME =
1078 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1079 mds_getattr_name_client, mds_getattr_server);
1080 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1082 struct req_format RQF_MDS_REINT =
1083 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1084 EXPORT_SYMBOL(RQF_MDS_REINT);
1086 struct req_format RQF_MDS_REINT_CREATE =
1087 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1088 mds_reint_create_client, mdt_body_capa);
1089 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1091 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1092 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1093 mds_reint_create_rmt_acl_client, mdt_body_capa);
1094 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1096 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1097 DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1098 mds_reint_create_slave_client, mdt_body_capa);
1099 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1101 struct req_format RQF_MDS_REINT_CREATE_SYM =
1102 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1103 mds_reint_create_sym_client, mdt_body_capa);
1104 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1106 struct req_format RQF_MDS_REINT_OPEN =
1107 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1108 mds_reint_open_client, mds_reint_open_server);
1109 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1111 struct req_format RQF_MDS_REINT_UNLINK =
1112 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1113 mds_last_unlink_server);
1114 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1116 struct req_format RQF_MDS_REINT_LINK =
1117 DEFINE_REQ_FMT0("MDS_REINT_LINK",
1118 mds_reint_link_client, mdt_body_only);
1119 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1121 struct req_format RQF_MDS_REINT_RENAME =
1122 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1123 mds_last_unlink_server);
1124 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1126 struct req_format RQF_MDS_REINT_SETATTR =
1127 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1128 mds_reint_setattr_client, mds_setattr_server);
1129 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1131 struct req_format RQF_MDS_REINT_SETXATTR =
1132 DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1133 mds_reint_setxattr_client, mdt_body_only);
1134 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1136 struct req_format RQF_MDS_CONNECT =
1137 DEFINE_REQ_FMT0("MDS_CONNECT",
1138 obd_connect_client, obd_connect_server);
1139 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1141 struct req_format RQF_MDS_DISCONNECT =
1142 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1143 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1145 struct req_format RQF_MDS_GET_INFO =
1146 DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1147 mds_getinfo_server);
1148 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1150 struct req_format RQF_LDLM_ENQUEUE =
1151 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1152 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1153 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1155 struct req_format RQF_LDLM_ENQUEUE_LVB =
1156 DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1157 ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1158 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1160 struct req_format RQF_LDLM_CONVERT =
1161 DEFINE_REQ_FMT0("LDLM_CONVERT",
1162 ldlm_enqueue_client, ldlm_enqueue_server);
1163 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1165 struct req_format RQF_LDLM_CANCEL =
1166 DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1167 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1169 struct req_format RQF_LDLM_CALLBACK =
1170 DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1171 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1173 struct req_format RQF_LDLM_CP_CALLBACK =
1174 DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1175 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1177 struct req_format RQF_LDLM_BL_CALLBACK =
1178 DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1179 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1181 struct req_format RQF_LDLM_GL_CALLBACK =
1182 DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1183 ldlm_gl_callback_server);
1184 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1186 struct req_format RQF_LDLM_INTENT =
1187 DEFINE_REQ_FMT0("LDLM_INTENT",
1188 ldlm_intent_client, ldlm_intent_server);
1189 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1191 struct req_format RQF_LDLM_INTENT_GETATTR =
1192 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1193 ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1194 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1196 struct req_format RQF_LDLM_INTENT_OPEN =
1197 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1198 ldlm_intent_open_client, ldlm_intent_open_server);
1199 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1201 struct req_format RQF_LDLM_INTENT_CREATE =
1202 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1203 ldlm_intent_create_client, ldlm_intent_getattr_server);
1204 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1206 struct req_format RQF_LDLM_INTENT_UNLINK =
1207 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1208 ldlm_intent_unlink_client, ldlm_intent_server);
1209 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1211 struct req_format RQF_MDS_CLOSE =
1212 DEFINE_REQ_FMT0("MDS_CLOSE",
1213 mdt_close_client, mds_last_unlink_server);
1214 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1216 struct req_format RQF_MDS_PIN =
1217 DEFINE_REQ_FMT0("MDS_PIN",
1218 mdt_body_capa, mdt_body_only);
1219 EXPORT_SYMBOL(RQF_MDS_PIN);
1221 struct req_format RQF_MDS_UNPIN =
1222 DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1223 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1225 struct req_format RQF_MDS_DONE_WRITING =
1226 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1227 mdt_close_client, mdt_body_only);
1228 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1230 struct req_format RQF_MDS_READPAGE =
1231 DEFINE_REQ_FMT0("MDS_READPAGE",
1232 mdt_body_capa, mdt_body_only);
1233 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1235 /* This is for split */
1236 struct req_format RQF_MDS_WRITEPAGE =
1237 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1238 mdt_body_capa, mdt_body_only);
1239 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1241 struct req_format RQF_MDS_IS_SUBDIR =
1242 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1243 mdt_body_only, mdt_body_only);
1244 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1246 struct req_format RQF_LLOG_CATINFO =
1247 DEFINE_REQ_FMT0("LLOG_CATINFO",
1248 llog_catinfo_client, llog_catinfo_server);
1249 EXPORT_SYMBOL(RQF_LLOG_CATINFO);
1251 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1252 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1253 llog_origin_handle_create_client, llogd_body_only);
1254 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1256 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1257 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1258 llogd_body_only, llogd_body_only);
1259 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1261 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1262 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1263 llogd_body_only, llog_origin_handle_next_block_server);
1264 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1266 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1267 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1268 llogd_body_only, llog_origin_handle_next_block_server);
1269 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1271 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1272 DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1273 llogd_body_only, llog_log_hdr_only);
1274 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1276 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1277 DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1278 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1280 struct req_format RQF_OST_CONNECT =
1281 DEFINE_REQ_FMT0("OST_CONNECT",
1282 obd_connect_client, obd_connect_server);
1283 EXPORT_SYMBOL(RQF_OST_CONNECT);
1285 struct req_format RQF_OST_DISCONNECT =
1286 DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1287 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1289 struct req_format RQF_OST_GETATTR =
1290 DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1291 EXPORT_SYMBOL(RQF_OST_GETATTR);
1293 struct req_format RQF_OST_SETATTR =
1294 DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1295 EXPORT_SYMBOL(RQF_OST_SETATTR);
1297 struct req_format RQF_OST_CREATE =
1298 DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1299 EXPORT_SYMBOL(RQF_OST_CREATE);
1301 struct req_format RQF_OST_PUNCH =
1302 DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1303 EXPORT_SYMBOL(RQF_OST_PUNCH);
1305 struct req_format RQF_OST_SYNC =
1306 DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1307 EXPORT_SYMBOL(RQF_OST_SYNC);
1309 struct req_format RQF_OST_DESTROY =
1310 DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1311 EXPORT_SYMBOL(RQF_OST_DESTROY);
1313 struct req_format RQF_OST_BRW_READ =
1314 DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1315 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1317 struct req_format RQF_OST_BRW_WRITE =
1318 DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1319 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1321 struct req_format RQF_OST_STATFS =
1322 DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1323 EXPORT_SYMBOL(RQF_OST_STATFS);
1325 struct req_format RQF_OST_SET_GRANT_INFO =
1326 DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1328 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1330 struct req_format RQF_OST_GET_INFO_GENERIC =
1331 DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1332 ost_get_info_generic_server);
1333 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1335 struct req_format RQF_OST_GET_INFO_LAST_ID =
1336 DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1337 ost_get_last_id_server);
1338 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1340 struct req_format RQF_OST_GET_INFO_FIEMAP =
1341 DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1342 ost_get_fiemap_server);
1343 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1346 #if !defined(__REQ_LAYOUT_USER__)
1348 /* Convenience macro */
1349 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1352 * Initializes the capsule abstraction by computing and setting the \a rf_idx
1353 * field of RQFs and the \a rmf_offset field of RMFs.
1355 int req_layout_init(void)
1360 struct req_format *rf = NULL;
1362 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1363 rf = req_formats[i];
1365 for (j = 0; j < RCL_NR; ++j) {
1366 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1367 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1368 struct req_msg_field *field;
1370 field = (typeof(field))rf->rf_fields[j].d[k];
1371 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1372 || field->rmf_size > 0);
1373 LASSERT(field->rmf_offset[i][j] == 0);
1375 * k + 1 to detect unused format/field
1378 field->rmf_offset[i][j] = k + 1;
1384 EXPORT_SYMBOL(req_layout_init);
1386 void req_layout_fini(void)
1389 EXPORT_SYMBOL(req_layout_fini);
1392 * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1394 * Actual/expected field sizes are set elsewhere in functions in this file:
1395 * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1396 * req_capsule_msg_size(). The \a rc_area information is used by.
1397 * ptlrpc_request_set_replen().
1399 void req_capsule_init_area(struct req_capsule *pill)
1403 for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1404 pill->rc_area[RCL_CLIENT][i] = -1;
1405 pill->rc_area[RCL_SERVER][i] = -1;
1408 EXPORT_SYMBOL(req_capsule_init_area);
1411 * Initialize a pill.
1413 * The \a location indicates whether the caller is executing on the client side
1414 * (RCL_CLIENT) or server side (RCL_SERVER)..
1416 void req_capsule_init(struct req_capsule *pill,
1417 struct ptlrpc_request *req,
1418 enum req_location location)
1420 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1423 * Today all capsules are embedded in ptlrpc_request structs,
1424 * but just in case that ever isn't the case, we don't reach
1425 * into req unless req != NULL and pill is the one embedded in
1428 * The req->rq_pill_init flag makes it safe to initialize a pill
1429 * twice, which might happen in the OST paths as a result of the
1430 * high-priority RPC queue getting peeked at before ost_handle()
1431 * handles an OST RPC.
1433 if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1436 memset(pill, 0, sizeof *pill);
1438 pill->rc_loc = location;
1439 req_capsule_init_area(pill);
1441 if (req != NULL && pill == &req->rq_pill)
1442 req->rq_pill_init = 1;
1444 EXPORT_SYMBOL(req_capsule_init);
1446 void req_capsule_fini(struct req_capsule *pill)
1449 EXPORT_SYMBOL(req_capsule_fini);
1451 static int __req_format_is_sane(const struct req_format *fmt)
1454 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1455 req_formats[fmt->rf_idx] == fmt;
1458 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1459 enum req_location loc)
1461 struct ptlrpc_request *req;
1464 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1468 * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1469 * (see req_capsule_extend()).
1471 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1473 LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1474 LASSERT(__req_format_is_sane(fmt));
1478 EXPORT_SYMBOL(req_capsule_set);
1481 * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1484 * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1485 * variable-sized fields. The field sizes come from the declared \a rmf_size
1486 * field of a \a pill's \a rc_fmt's RMF's.
1488 int req_capsule_filled_sizes(struct req_capsule *pill,
1489 enum req_location loc)
1491 const struct req_format *fmt = pill->rc_fmt;
1494 LASSERT(fmt != NULL);
1496 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1497 if (pill->rc_area[loc][i] == -1) {
1498 pill->rc_area[loc][i] =
1499 fmt->rf_fields[loc].d[i]->rmf_size;
1500 if (pill->rc_area[loc][i] == -1) {
1502 * Skip the following fields.
1504 * If this LASSERT() trips then you're missing a
1505 * call to req_capsule_set_size().
1507 LASSERT(loc != RCL_SERVER);
1514 EXPORT_SYMBOL(req_capsule_filled_sizes);
1517 * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1519 * This function uses the \a pill's \a rc_area as filled in by
1520 * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1523 int req_capsule_server_pack(struct req_capsule *pill)
1525 const struct req_format *fmt;
1529 LASSERT(pill->rc_loc == RCL_SERVER);
1531 LASSERT(fmt != NULL);
1533 count = req_capsule_filled_sizes(pill, RCL_SERVER);
1534 rc = lustre_pack_reply(pill->rc_req, count,
1535 pill->rc_area[RCL_SERVER], NULL);
1537 DEBUG_REQ(D_ERROR, pill->rc_req,
1538 "Cannot pack %d fields in format `%s': ",
1539 count, fmt->rf_name);
1543 EXPORT_SYMBOL(req_capsule_server_pack);
1546 * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1547 * corresponding to the given RMF (\a field).
1549 static int __req_capsule_offset(const struct req_capsule *pill,
1550 const struct req_msg_field *field,
1551 enum req_location loc)
1555 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1556 LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1557 pill->rc_fmt->rf_name,
1558 field->rmf_name, offset, loc);
1561 LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1566 * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1571 swabber_dumper_helper(struct req_capsule *pill,
1572 const struct req_msg_field *field,
1573 enum req_location loc,
1575 void *value, int len, int dump, void (*swabber)( void *))
1581 int inout = loc == RCL_CLIENT;
1583 swabber = swabber ?: field->rmf_swabber;
1585 if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1586 swabber != NULL && value != NULL)
1591 if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1592 if (dump && field->rmf_dumper) {
1593 CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1594 do_swab ? "unswabbed " : "", field->rmf_name);
1595 field->rmf_dumper(value);
1600 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1602 CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1603 "follows\n", field->rmf_name);
1604 field->rmf_dumper(value);
1611 * We're swabbing an array; swabber() swabs a single array element, so
1612 * swab every element.
1614 LASSERT((len % field->rmf_size) == 0);
1615 for (p = value, i = 0, n = len / field->rmf_size;
1617 i++, p += field->rmf_size) {
1618 if (dump && field->rmf_dumper) {
1619 CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1620 "element %d follows\n",
1621 do_swab ? "unswabbed " : "", field->rmf_name, i);
1622 field->rmf_dumper(p);
1627 if (dump && field->rmf_dumper) {
1628 CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1629 "element %d follows\n", field->rmf_name, i);
1630 field->rmf_dumper(value);
1634 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1638 * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1639 * corresponding to the given RMF (\a field).
1641 * The buffer will be swabbed using the given \a swabber. If \a swabber == NULL
1642 * then the \a rmf_swabber from the RMF will be used. Soon there will be no
1643 * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1644 * be removed. Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1645 * element of the array swabbed.
1647 static void *__req_capsule_get(struct req_capsule *pill,
1648 const struct req_msg_field *field,
1649 enum req_location loc,
1650 void (*swabber)( void *),
1653 const struct req_format *fmt;
1654 struct lustre_msg *msg;
1659 void *(*getter)(struct lustre_msg *m, int n, int minlen);
1661 static const char *rcl_names[RCL_NR] = {
1662 [RCL_CLIENT] = "client",
1663 [RCL_SERVER] = "server"
1666 LASSERT(pill != NULL);
1667 LASSERT(pill != LP_POISON);
1669 LASSERT(fmt != NULL);
1670 LASSERT(fmt != LP_POISON);
1671 LASSERT(__req_format_is_sane(fmt));
1673 offset = __req_capsule_offset(pill, field, loc);
1675 msg = __req_msg(pill, loc);
1676 LASSERT(msg != NULL);
1678 getter = (field->rmf_flags & RMF_F_STRING) ?
1679 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1681 if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1683 * We've already asserted that field->rmf_size > 0 in
1684 * req_layout_init().
1686 len = lustre_msg_buflen(msg, offset);
1687 if ((len % field->rmf_size) != 0) {
1688 CERROR("%s: array field size mismatch "
1689 "%d modulo %d != 0 (%d)\n",
1690 field->rmf_name, len, field->rmf_size, loc);
1693 } else if (pill->rc_area[loc][offset] != -1) {
1694 len = pill->rc_area[loc][offset];
1696 len = max(field->rmf_size, 0);
1698 value = getter(msg, offset, len);
1700 if (value == NULL) {
1701 DEBUG_REQ(D_ERROR, pill->rc_req,
1702 "Wrong buffer for field `%s' (%d of %d) "
1703 "in format `%s': %d vs. %d (%s)\n",
1704 field->rmf_name, offset, lustre_msg_bufcount(msg),
1705 fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1708 swabber_dumper_helper(pill, field, loc, offset, value, len,
1716 * Dump a request and/or reply
1718 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1720 const struct req_format *fmt;
1721 const struct req_msg_field *field;
1727 DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1728 for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1729 field = FMT_FIELD(fmt, loc, i);
1730 if (field->rmf_dumper == NULL) {
1732 * FIXME Add a default hex dumper for fields that don't
1733 * have a specific dumper
1735 len = req_capsule_get_size(pill, field, loc);
1736 CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1737 "field size is %d\n", field->rmf_name, len);
1739 /* It's the dumping side-effect that we're interested in */
1740 (void) __req_capsule_get(pill, field, loc, NULL, 1);
1743 CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1749 void req_capsule_client_dump(struct req_capsule *pill)
1751 __req_capsule_dump(pill, RCL_CLIENT);
1753 EXPORT_SYMBOL(req_capsule_client_dump);
1758 void req_capsule_server_dump(struct req_capsule *pill)
1760 __req_capsule_dump(pill, RCL_SERVER);
1762 EXPORT_SYMBOL(req_capsule_server_dump);
1765 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
1766 * buffer corresponding to the given RMF (\a field) of a \a pill.
1768 void *req_capsule_client_get(struct req_capsule *pill,
1769 const struct req_msg_field *field)
1771 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1773 EXPORT_SYMBOL(req_capsule_client_get);
1776 * Same as req_capsule_client_get(), but with a \a swabber argument.
1778 * Currently unused; will be removed when req_capsule_server_swab_get() is
1781 void *req_capsule_client_swab_get(struct req_capsule *pill,
1782 const struct req_msg_field *field,
1783 void (*swabber)(void* ))
1785 return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
1787 EXPORT_SYMBOL(req_capsule_client_swab_get);
1790 * Utility that combines req_capsule_set_size() and req_capsule_client_get().
1792 * First the \a pill's request \a field's size is set (\a rc_area) using
1793 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1796 void *req_capsule_client_sized_get(struct req_capsule *pill,
1797 const struct req_msg_field *field,
1800 req_capsule_set_size(pill, field, RCL_CLIENT, len);
1801 return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1803 EXPORT_SYMBOL(req_capsule_client_sized_get);
1806 * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
1807 * buffer corresponding to the given RMF (\a field) of a \a pill.
1809 void *req_capsule_server_get(struct req_capsule *pill,
1810 const struct req_msg_field *field)
1812 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1814 EXPORT_SYMBOL(req_capsule_server_get);
1817 * Same as req_capsule_server_get(), but with a \a swabber argument.
1819 * Ideally all swabbing should be done pursuant to RMF definitions, with no
1820 * swabbing done outside this capsule abstraction.
1822 void *req_capsule_server_swab_get(struct req_capsule *pill,
1823 const struct req_msg_field *field,
1826 return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
1828 EXPORT_SYMBOL(req_capsule_server_swab_get);
1831 * Utility that combines req_capsule_set_size() and req_capsule_server_get().
1833 * First the \a pill's request \a field's size is set (\a rc_area) using
1834 * req_capsule_set_size() with the given \a len. Then the actual buffer is
1837 void *req_capsule_server_sized_get(struct req_capsule *pill,
1838 const struct req_msg_field *field,
1841 req_capsule_set_size(pill, field, RCL_SERVER, len);
1842 return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1844 EXPORT_SYMBOL(req_capsule_server_sized_get);
1847 * Returns the buffer of a \a pill corresponding to the given \a field from the
1848 * request (if the caller is executing on the server-side) or reply (if the
1849 * caller is executing on the client-side).
1851 * This function convienient for use is code that could be executed on the
1852 * client and server alike.
1854 const void *req_capsule_other_get(struct req_capsule *pill,
1855 const struct req_msg_field *field)
1857 return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
1859 EXPORT_SYMBOL(req_capsule_other_get);
1862 * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
1863 * field of the given \a pill.
1865 * This function must be used when constructing variable sized fields of a
1868 void req_capsule_set_size(struct req_capsule *pill,
1869 const struct req_msg_field *field,
1870 enum req_location loc, int size)
1872 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1874 if ((size != field->rmf_size) &&
1875 (field->rmf_size != -1) &&
1876 !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1878 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1879 (size % field->rmf_size != 0)) {
1880 CERROR("%s: array field size mismatch "
1881 "%d %% %d != 0 (%d)\n",
1882 field->rmf_name, size, field->rmf_size, loc);
1884 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1885 size < field->rmf_size) {
1886 CERROR("%s: field size mismatch %d != %d (%d)\n",
1887 field->rmf_name, size, field->rmf_size, loc);
1892 pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
1894 EXPORT_SYMBOL(req_capsule_set_size);
1897 * Return the actual PTLRPC buffer length of a request or reply (\a loc)
1898 * for the given \a pill's given \a field.
1900 * NB: this function doesn't correspond with req_capsule_set_size(), which
1901 * actually sets the size in pill.rc_area[loc][offset], but this function
1902 * returns the message buflen[offset], maybe we should use another name.
1904 int req_capsule_get_size(const struct req_capsule *pill,
1905 const struct req_msg_field *field,
1906 enum req_location loc)
1908 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1910 return lustre_msg_buflen(__req_msg(pill, loc),
1911 __req_capsule_offset(pill, field, loc));
1913 EXPORT_SYMBOL(req_capsule_get_size);
1916 * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
1917 * given \a pill's request or reply (\a loc) given the field size recorded in
1918 * the \a pill's rc_area.
1920 * See also req_capsule_set_size().
1922 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
1924 return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
1925 pill->rc_fmt->rf_fields[loc].nr,
1926 pill->rc_area[loc]);
1930 * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
1931 * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
1932 * PTLRPC request or reply given only an RQF (\a fmt).
1934 * This function should not be used for formats which contain variable size
1937 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
1938 enum req_location loc)
1943 * This function should probably LASSERT() that fmt has no fields with
1944 * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
1945 * elements in the array there will ultimately be, but then, we could
1946 * assume that there will be at least one element, and that's just what
1949 size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
1953 for (; i < fmt->rf_fields[loc].nr; ++i)
1954 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
1955 size += cfs_size_round(fmt->rf_fields[loc].d[i]->
1961 * Changes the format of an RPC.
1963 * The pill must already have been initialized, which means that it already has
1964 * a request format. The new format \a fmt must be an extension of the pill's
1965 * old format. Specifically: the new format must have as many request and reply
1966 * fields as the old one, and all fields shared by the old and new format must
1967 * be at least as large in the new format.
1969 * The new format's fields may be of different "type" than the old format, but
1970 * only for fields that are "opaque" blobs: fields which have a) have no
1971 * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
1972 * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK. For example,
1973 * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
1974 * according to the key field. When the value, according to the key, contains a
1975 * structure (or array thereof) to be swabbed, the format should be changed to
1976 * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
1979 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
1984 const struct req_format *old;
1986 LASSERT(pill->rc_fmt != NULL);
1987 LASSERT(__req_format_is_sane(fmt));
1991 * Sanity checking...
1993 for (i = 0; i < RCL_NR; ++i) {
1994 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
1995 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
1996 const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
1998 /* "opaque" fields can be transmogrified */
1999 if (ofield->rmf_swabber == NULL &&
2000 (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2001 (ofield->rmf_size == -1 ||
2002 ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2004 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2007 * Last field in old format can be shorter than in new.
2009 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2010 FMT_FIELD(old, i, j)->rmf_size);
2015 EXPORT_SYMBOL(req_capsule_extend);
2018 * This function returns a non-zero value if the given \a field is present in
2019 * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2022 int req_capsule_has_field(const struct req_capsule *pill,
2023 const struct req_msg_field *field,
2024 enum req_location loc)
2026 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2028 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2030 EXPORT_SYMBOL(req_capsule_has_field);
2033 * Returns a non-zero value if the given \a field is present in the given \a
2034 * pill's PTLRPC request or reply (\a loc), else it returns 0.
2036 int req_capsule_field_present(const struct req_capsule *pill,
2037 const struct req_msg_field *field,
2038 enum req_location loc)
2042 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2043 LASSERT(req_capsule_has_field(pill, field, loc));
2045 offset = __req_capsule_offset(pill, field, loc);
2046 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2048 EXPORT_SYMBOL(req_capsule_field_present);
2051 * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2052 * request or reply (\a loc).
2054 * This is not the opposite of req_capsule_extend().
2056 void req_capsule_shrink(struct req_capsule *pill,
2057 const struct req_msg_field *field,
2058 unsigned int newlen,
2059 enum req_location loc)
2061 const struct req_format *fmt;
2062 struct lustre_msg *msg;
2067 LASSERT(fmt != NULL);
2068 LASSERT(__req_format_is_sane(fmt));
2069 LASSERT(req_capsule_has_field(pill, field, loc));
2070 LASSERT(req_capsule_field_present(pill, field, loc));
2072 offset = __req_capsule_offset(pill, field, loc);
2074 msg = __req_msg(pill, loc);
2075 len = lustre_msg_buflen(msg, offset);
2076 LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2077 fmt->rf_name, field->rmf_name, len, newlen);
2079 if (loc == RCL_CLIENT)
2080 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2083 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2086 EXPORT_SYMBOL(req_capsule_shrink);
2088 int req_capsule_server_grow(struct req_capsule *pill,
2089 const struct req_msg_field *field,
2090 unsigned int newlen)
2092 struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2094 int offset, len, rc;
2096 LASSERT(pill->rc_fmt != NULL);
2097 LASSERT(__req_format_is_sane(pill->rc_fmt));
2098 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2099 LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2101 len = req_capsule_get_size(pill, field, RCL_SERVER);
2102 offset = __req_capsule_offset(pill, field, RCL_SERVER);
2103 if (pill->rc_req->rq_repbuf_len >=
2104 lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2105 CERROR("Inplace repack might be done\n");
2107 pill->rc_req->rq_reply_state = NULL;
2108 req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2109 rc = req_capsule_server_pack(pill);
2111 /* put old rs back, the caller will decide what to do */
2112 pill->rc_req->rq_reply_state = rs;
2115 nrs = pill->rc_req->rq_reply_state;
2116 /* Now we need only buffers, copy first chunk */
2117 to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2118 from = lustre_msg_buf(rs->rs_msg, 0, 0);
2119 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2120 memcpy(to, from, len);
2121 /* check if we have tail and copy it too */
2122 if (rs->rs_msg->lm_bufcount > offset + 1) {
2123 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2124 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2125 offset = rs->rs_msg->lm_bufcount - 1;
2126 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2127 cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2128 memcpy(to, from, len);
2130 /* drop old reply if everything is fine */
2131 if (rs->rs_difficult) {
2135 nrs->rs_difficult = 1;
2136 nrs->rs_no_ack = rs->rs_no_ack;
2137 for (i = 0; i < rs->rs_nlocks; i++) {
2138 nrs->rs_locks[i] = rs->rs_locks[i];
2139 nrs->rs_modes[i] = rs->rs_modes[i];
2143 rs->rs_difficult = 0;
2146 ptlrpc_rs_decref(rs);
2149 EXPORT_SYMBOL(req_capsule_server_grow);
2150 /* __REQ_LAYOUT_USER__ */