1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/ptlrpc/layout.c
5 * Lustre Metadata Target (mdt) request handler
7 * Copyright (c) 2006 Cluster File Systems, Inc.
8 * Author: Nikita Danilov <nikita@clusterfs.com>
10 * This file is part of the Lustre file system, http://www.lustre.org
11 * Lustre is a trademark of Cluster File Systems, Inc.
13 * You may have signed or agreed to another license before downloading
14 * this software. If so, you are bound by the terms and conditions
15 * of that agreement, and the following does not apply to you. See the
16 * LICENSE file included with this distribution for more information.
18 * If you did not agree to a different license, then this copy of Lustre
19 * is open source software; you can redistribute it and/or modify it
20 * under the terms of version 2 of the GNU General Public License as
21 * published by the Free Software Foundation.
23 * In either case, Lustre is distributed in the hope that it will be
24 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
25 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * license text for more details.
29 #if !defined(__REQ_LAYOUT_USER__)
32 # define EXPORT_SYMTAB
34 #define DEBUG_SUBSYSTEM S_RPC
37 #include <linux/module.h>
39 # include <liblustre.h>
42 /* LUSTRE_VERSION_CODE */
43 #include <lustre_ver.h>
45 #include <obd_support.h>
46 /* lustre_swab_mdt_body */
47 #include <lustre/lustre_idl.h>
48 /* obd2cli_tgt() (required by DEBUG_REQ()) */
51 /* __REQ_LAYOUT_USER__ */
53 /* struct ptlrpc_request, lustre_msg* */
54 #include <lustre_req_layout.h>
55 #include <linux/lustre_acl.h>
58 * empty set of fields... for suitable definition of emptiness.
60 static const struct req_msg_field *empty[] = {
64 static const struct req_msg_field *mdt_body_only[] = {
69 static const struct req_msg_field *mdt_body_capa[] = {
75 static const struct req_msg_field *mdt_close_client[] = {
82 static const struct req_msg_field *mds_statfs_server[] = {
87 static const struct req_msg_field *seq_query_client[] = {
93 static const struct req_msg_field *seq_query_server[] = {
98 static const struct req_msg_field *fld_query_client[] = {
104 static const struct req_msg_field *fld_query_server[] = {
109 static const struct req_msg_field *mds_getattr_name_client[] = {
116 static const struct req_msg_field *mds_reint_client[] = {
121 static const struct req_msg_field *mds_reint_create_client[] = {
128 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
137 static const struct req_msg_field *mds_reint_create_sym_client[] = {
146 static const struct req_msg_field *mds_reint_create_slave_client[] = {
154 static const struct req_msg_field *mds_reint_open_client[] = {
163 static const struct req_msg_field *mds_reint_open_server[] = {
172 static const struct req_msg_field *mds_reint_unlink_client[] = {
180 static const struct req_msg_field *mds_reint_link_client[] = {
189 static const struct req_msg_field *mds_reint_rename_client[] = {
199 static const struct req_msg_field *mds_last_unlink_server[] = {
206 static const struct req_msg_field *mds_reint_setattr_client[] = {
216 static const struct req_msg_field *mds_connect_client[] = {
224 static const struct req_msg_field *mds_connect_server[] = {
229 static const struct req_msg_field *mds_set_info_client[] = {
235 static const struct req_msg_field *ldlm_enqueue_client[] = {
240 static const struct req_msg_field *ldlm_enqueue_server[] = {
245 static const struct req_msg_field *ldlm_intent_client[] = {
252 static const struct req_msg_field *ldlm_intent_server[] = {
261 static const struct req_msg_field *ldlm_intent_open_server[] = {
271 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
275 &RMF_MDT_BODY, /* coincides with mds_getattr_name_client[] */
280 static const struct req_msg_field *ldlm_intent_create_client[] = {
284 &RMF_REC_CREATE, /* coincides with mds_reint_create_client[] */
290 static const struct req_msg_field *ldlm_intent_open_client[] = {
294 &RMF_REC_CREATE, /* coincides with mds_reint_open_client[] */
301 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
305 &RMF_REC_UNLINK, /* coincides with mds_reint_unlink_client[] */
310 static const struct req_msg_field *mds_getxattr_client[] = {
318 static const struct req_msg_field *mds_getxattr_server[] = {
324 static const struct req_msg_field *mds_setxattr_client[] = {
332 static const struct req_msg_field *mds_setxattr_server[] = {
337 static const struct req_msg_field *mds_getattr_server[] = {
345 static const struct req_format *req_formats[] = {
352 &RQF_MDS_GETATTR_NAME,
354 &RQF_MDS_REINT_CREATE,
355 &RQF_MDS_REINT_CREATE_RMT_ACL,
356 &RQF_MDS_REINT_CREATE_SYM,
357 &RQF_MDS_REINT_CREATE_SLAVE,
359 &RQF_MDS_REINT_UNLINK,
361 &RQF_MDS_REINT_RENAME,
362 &RQF_MDS_REINT_SETATTR,
365 &RQF_LDLM_INTENT_GETATTR,
366 &RQF_LDLM_INTENT_OPEN,
367 &RQF_LDLM_INTENT_CREATE,
368 &RQF_LDLM_INTENT_UNLINK,
379 &RQF_MDS_DONE_WRITING
382 struct req_msg_field {
384 const char *rmf_name;
386 * Field length. (-1) means "variable length".
389 void (*rmf_swabber)(void *);
390 int rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
394 RMF_F_STRING = 1 << 0
402 #define DEFINE_MSGF(name, flags, size, swabber) { \
403 .rmf_name = (name), \
404 .rmf_flags = (flags), \
405 .rmf_size = (size), \
406 .rmf_swabber = (void (*)(void*))(swabber) \
409 const struct req_msg_field RMF_SETINFO_VAL =
410 DEFINE_MSGF("setinfo_val", 0,
411 sizeof(__u32), lustre_swab_generic_32s);
412 EXPORT_SYMBOL(RMF_SETINFO_VAL);
414 const struct req_msg_field RMF_SEQ_OPC =
415 DEFINE_MSGF("seq_query_opc", 0,
416 sizeof(__u32), lustre_swab_generic_32s);
417 EXPORT_SYMBOL(RMF_SEQ_OPC);
419 const struct req_msg_field RMF_SEQ_RANGE =
420 DEFINE_MSGF("seq_query_range", 0,
421 sizeof(struct lu_range), lustre_swab_lu_range);
422 EXPORT_SYMBOL(RMF_SEQ_RANGE);
424 const struct req_msg_field RMF_FLD_OPC =
425 DEFINE_MSGF("fld_query_opc", 0,
426 sizeof(__u32), lustre_swab_generic_32s);
427 EXPORT_SYMBOL(RMF_FLD_OPC);
429 const struct req_msg_field RMF_FLD_MDFLD =
430 DEFINE_MSGF("fld_query_mdfld", 0,
431 sizeof(struct md_fld), lustre_swab_md_fld);
432 EXPORT_SYMBOL(RMF_FLD_MDFLD);
434 const struct req_msg_field RMF_MDT_BODY =
435 DEFINE_MSGF("mdt_body", 0,
436 sizeof(struct mdt_body), lustre_swab_mdt_body);
437 EXPORT_SYMBOL(RMF_MDT_BODY);
439 const struct req_msg_field RMF_MDT_EPOCH =
440 DEFINE_MSGF("mdt_epoch", 0,
441 sizeof(struct mdt_epoch), lustre_swab_mdt_epoch);
442 EXPORT_SYMBOL(RMF_MDT_EPOCH);
444 const struct req_msg_field RMF_PTLRPC_BODY =
445 DEFINE_MSGF("ptlrpc_body", 0,
446 sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body);
447 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
449 const struct req_msg_field RMF_OBD_STATFS =
450 DEFINE_MSGF("obd_statfs", 0,
451 sizeof(struct obd_statfs), lustre_swab_obd_statfs);
452 EXPORT_SYMBOL(RMF_OBD_STATFS);
454 const struct req_msg_field RMF_SETINFO_KEY =
455 DEFINE_MSGF("setinfo_key", 0, -1, NULL);
456 EXPORT_SYMBOL(RMF_SETINFO_KEY);
458 const struct req_msg_field RMF_NAME =
459 DEFINE_MSGF("name", RMF_F_STRING, -1, NULL);
460 EXPORT_SYMBOL(RMF_NAME);
462 const struct req_msg_field RMF_SYMTGT =
463 DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL);
464 EXPORT_SYMBOL(RMF_SYMTGT);
466 const struct req_msg_field RMF_TGTUUID =
467 DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL);
468 EXPORT_SYMBOL(RMF_TGTUUID);
470 const struct req_msg_field RMF_CLUUID =
471 DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL);
472 EXPORT_SYMBOL(RMF_CLUUID);
475 * connection handle received in MDS_CONNECT request.
479 const struct req_msg_field RMF_CONN =
480 DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL);
481 EXPORT_SYMBOL(RMF_CONN);
483 const struct req_msg_field RMF_CONNECT_DATA =
484 DEFINE_MSGF("cdata", 0,
485 sizeof(struct obd_connect_data), lustre_swab_connect);
486 EXPORT_SYMBOL(RMF_CONNECT_DATA);
488 const struct req_msg_field RMF_DLM_REQ =
489 DEFINE_MSGF("dlm_req", 0,
490 sizeof(struct ldlm_request), lustre_swab_ldlm_request);
491 EXPORT_SYMBOL(RMF_DLM_REQ);
493 const struct req_msg_field RMF_DLM_REP =
494 DEFINE_MSGF("dlm_rep", 0,
495 sizeof(struct ldlm_reply), lustre_swab_ldlm_reply);
496 EXPORT_SYMBOL(RMF_DLM_REP);
498 const struct req_msg_field RMF_LDLM_INTENT =
499 DEFINE_MSGF("ldlm_intent", 0,
500 sizeof(struct ldlm_intent), lustre_swab_ldlm_intent);
501 EXPORT_SYMBOL(RMF_LDLM_INTENT);
503 const struct req_msg_field RMF_MDT_MD =
504 DEFINE_MSGF("mdt_md", 0, MIN_MD_SIZE, lustre_swab_lov_mds_md);
505 EXPORT_SYMBOL(RMF_MDT_MD);
507 const struct req_msg_field RMF_REC_UNLINK =
508 DEFINE_MSGF("rec_unlink", 0, sizeof(struct mdt_rec_unlink),
509 lustre_swab_mdt_rec_unlink);
510 EXPORT_SYMBOL(RMF_REC_UNLINK);
512 const struct req_msg_field RMF_REC_LINK =
513 DEFINE_MSGF("rec_link", 0, sizeof(struct mdt_rec_link),
514 lustre_swab_mdt_rec_link);
515 EXPORT_SYMBOL(RMF_REC_LINK);
517 const struct req_msg_field RMF_REC_RENAME =
518 DEFINE_MSGF("rec_rename", 0, sizeof(struct mdt_rec_rename),
519 lustre_swab_mdt_rec_rename);
520 EXPORT_SYMBOL(RMF_REC_RENAME);
522 const struct req_msg_field RMF_REC_CREATE =
523 DEFINE_MSGF("rec_create", 0,
524 sizeof(struct mdt_rec_create), lustre_swab_mdt_rec_create);
525 EXPORT_SYMBOL(RMF_REC_CREATE);
527 const struct req_msg_field RMF_REC_SETATTR =
528 DEFINE_MSGF("rec_setattr", 0, sizeof(struct mdt_rec_setattr),
529 lustre_swab_mdt_rec_setattr);
530 EXPORT_SYMBOL(RMF_REC_SETATTR);
532 /* FIXME: this length should be defined as a macro */
533 const struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1, NULL);
534 EXPORT_SYMBOL(RMF_EADATA);
536 const struct req_msg_field RMF_ACL =
537 DEFINE_MSGF("acl", 0, LUSTRE_POSIX_ACL_MAX_SIZE, NULL);
538 EXPORT_SYMBOL(RMF_ACL);
540 const struct req_msg_field RMF_LOGCOOKIES =
541 DEFINE_MSGF("logcookies", 0, sizeof(struct llog_cookie), NULL);
542 EXPORT_SYMBOL(RMF_LOGCOOKIES);
544 const struct req_msg_field RMF_REINT_OPC =
545 DEFINE_MSGF("reint_opc", 0, sizeof(__u32), lustre_swab_generic_32s);
546 EXPORT_SYMBOL(RMF_REINT_OPC);
548 const struct req_msg_field RMF_CAPA1 =
549 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
550 lustre_swab_lustre_capa);
551 EXPORT_SYMBOL(RMF_CAPA1);
553 const struct req_msg_field RMF_CAPA2 =
554 DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
555 lustre_swab_lustre_capa);
556 EXPORT_SYMBOL(RMF_CAPA2);
567 const struct req_msg_field **d;
571 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) { \
585 #define DEFINE_REQ_FMT0(name, client, server) \
586 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
588 const struct req_format RQF_SEQ_QUERY =
589 DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
590 EXPORT_SYMBOL(RQF_SEQ_QUERY);
592 const struct req_format RQF_FLD_QUERY =
593 DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
594 EXPORT_SYMBOL(RQF_FLD_QUERY);
596 const struct req_format RQF_MDS_GETSTATUS =
597 DEFINE_REQ_FMT0("MDS_GETSTATUS", empty, mdt_body_capa);
598 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
600 const struct req_format RQF_MDS_STATFS =
601 DEFINE_REQ_FMT0("MDS_STATFS", empty, mds_statfs_server);
602 EXPORT_SYMBOL(RQF_MDS_STATFS);
604 const struct req_format RQF_MDS_SYNC =
605 DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
606 EXPORT_SYMBOL(RQF_MDS_SYNC);
608 const struct req_format RQF_MDS_GETATTR =
609 DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
610 EXPORT_SYMBOL(RQF_MDS_GETATTR);
612 const struct req_format RQF_MDS_GETXATTR =
613 DEFINE_REQ_FMT0("MDS_GETXATTR",
614 mds_getxattr_client, mds_getxattr_server);
615 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
617 const struct req_format RQF_MDS_SETXATTR =
618 DEFINE_REQ_FMT0("MDS_SETXATTR",
619 mds_setxattr_client, mds_setxattr_server);
620 EXPORT_SYMBOL(RQF_MDS_SETXATTR);
622 const struct req_format RQF_MDS_GETATTR_NAME =
623 DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
624 mds_getattr_name_client, mds_getattr_server);
625 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
627 const struct req_format RQF_MDS_REINT =
628 DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
629 EXPORT_SYMBOL(RQF_MDS_REINT);
631 const struct req_format RQF_MDS_REINT_CREATE =
632 DEFINE_REQ_FMT0("MDS_REINT_CREATE",
633 mds_reint_create_client, mdt_body_capa);
634 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
636 const struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
637 DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
638 mds_reint_create_rmt_acl_client, mdt_body_capa);
639 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
641 const struct req_format RQF_MDS_REINT_CREATE_SLAVE =
642 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SLAVE",
643 mds_reint_create_slave_client, mdt_body_capa);
644 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
646 const struct req_format RQF_MDS_REINT_CREATE_SYM =
647 DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
648 mds_reint_create_sym_client, mdt_body_capa);
649 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
651 const struct req_format RQF_MDS_REINT_OPEN =
652 DEFINE_REQ_FMT0("MDS_REINT_OPEN",
653 mds_reint_open_client, mds_reint_open_server);
654 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
656 const struct req_format RQF_MDS_REINT_UNLINK =
657 DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
658 mds_last_unlink_server);
659 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
661 const struct req_format RQF_MDS_REINT_LINK =
662 DEFINE_REQ_FMT0("MDS_REINT_LINK",
663 mds_reint_link_client, mdt_body_only);
664 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
666 const struct req_format RQF_MDS_REINT_RENAME =
667 DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
668 mds_last_unlink_server);
669 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
671 const struct req_format RQF_MDS_REINT_SETATTR =
672 DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
673 mds_reint_setattr_client, mdt_body_capa);
674 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
676 const struct req_format RQF_MDS_CONNECT =
677 DEFINE_REQ_FMT0("MDS_CONNECT",
678 mds_connect_client, mds_connect_server);
679 EXPORT_SYMBOL(RQF_MDS_CONNECT);
681 const struct req_format RQF_MDS_DISCONNECT =
682 DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
683 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
685 const struct req_format RQF_MDS_SET_INFO =
686 DEFINE_REQ_FMT0("MDS_SET_INFO", mds_set_info_client, empty);
687 EXPORT_SYMBOL(RQF_MDS_SET_INFO);
689 const struct req_format RQF_LDLM_ENQUEUE =
690 DEFINE_REQ_FMT0("LDLM_ENQUEUE",
691 ldlm_enqueue_client, ldlm_enqueue_server);
692 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
694 const struct req_format RQF_LDLM_INTENT =
695 DEFINE_REQ_FMT0("LDLM_INTENT",
696 ldlm_intent_client, ldlm_intent_server);
697 EXPORT_SYMBOL(RQF_LDLM_INTENT);
699 const struct req_format RQF_LDLM_INTENT_GETATTR =
700 DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
701 ldlm_intent_getattr_client, ldlm_intent_server);
702 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
704 const struct req_format RQF_LDLM_INTENT_OPEN =
705 DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
706 ldlm_intent_open_client, ldlm_intent_open_server);
707 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
709 const struct req_format RQF_LDLM_INTENT_CREATE =
710 DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
711 ldlm_intent_create_client, ldlm_intent_server);
712 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
714 const struct req_format RQF_LDLM_INTENT_UNLINK =
715 DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
716 ldlm_intent_unlink_client, ldlm_intent_server);
717 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
719 const struct req_format RQF_MDS_CLOSE =
720 DEFINE_REQ_FMT0("MDS_CLOSE",
721 mdt_close_client, mds_last_unlink_server);
722 EXPORT_SYMBOL(RQF_MDS_CLOSE);
724 const struct req_format RQF_MDS_PIN =
725 DEFINE_REQ_FMT0("MDS_PIN",
726 mdt_body_capa, mdt_body_only);
727 EXPORT_SYMBOL(RQF_MDS_PIN);
729 const struct req_format RQF_MDS_DONE_WRITING =
730 DEFINE_REQ_FMT0("MDS_DONE_WRITING",
731 mdt_close_client, mdt_body_only);
732 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
734 const struct req_format RQF_MDS_READPAGE =
735 DEFINE_REQ_FMT0("MDS_READPAGE",
736 mdt_body_capa, mdt_body_only);
737 EXPORT_SYMBOL(RQF_MDS_READPAGE);
739 /* This is for split */
740 const struct req_format RQF_MDS_WRITEPAGE =
741 DEFINE_REQ_FMT0("MDS_WRITEPAGE",
742 mdt_body_capa, mdt_body_only);
743 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
745 const struct req_format RQF_MDS_IS_SUBDIR =
746 DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
747 mdt_body_only, mdt_body_only);
748 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
750 #if !defined(__REQ_LAYOUT_USER__)
752 int req_layout_init(void)
758 for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
759 struct req_format *rf;
761 rf = (struct req_format *)req_formats[i];
763 for (j = 0; j < RCL_NR; ++j) {
764 LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
765 for (k = 0; k < rf->rf_fields[j].nr; ++k) {
766 struct req_msg_field *field;
768 field = (typeof(field))rf->rf_fields[j].d[k];
769 LASSERT(field->rmf_offset[i][j] == 0);
771 * k + 1 to detect unused format/field
774 field->rmf_offset[i][j] = k + 1;
780 EXPORT_SYMBOL(req_layout_init);
782 void req_layout_fini(void)
785 EXPORT_SYMBOL(req_layout_fini);
788 * Initialize capsule.
790 * @area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
791 * variable-sized fields.
793 void req_capsule_init(struct req_capsule *pill,
794 struct ptlrpc_request *req, enum req_location location,
797 LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
799 memset(pill, 0, sizeof *pill);
801 pill->rc_loc = location;
802 pill->rc_area = area;
804 EXPORT_SYMBOL(req_capsule_init);
806 void req_capsule_fini(struct req_capsule *pill)
809 EXPORT_SYMBOL(req_capsule_fini);
811 static int __req_format_is_sane(const struct req_format *fmt)
814 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
815 req_formats[fmt->rf_idx] == fmt;
818 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
819 enum req_location loc)
821 struct ptlrpc_request *req;
824 return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
827 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
829 LASSERT(pill->rc_fmt == NULL);
830 LASSERT(__req_format_is_sane(fmt));
834 EXPORT_SYMBOL(req_capsule_set);
836 int req_capsule_pack(struct req_capsule *pill)
843 const struct req_format *fmt;
845 LASSERT(pill->rc_loc == RCL_SERVER);
847 LASSERT(fmt != NULL);
849 nr = fmt->rf_fields[RCL_SERVER].nr;
850 for (total = 0, i = 0; i < nr; ++i) {
853 size = &pill->rc_area[i];
855 *size = fmt->rf_fields[RCL_SERVER].d[i]->rmf_size;
856 LASSERT(*size != -1);
860 result = lustre_pack_reply(pill->rc_req, nr, pill->rc_area, NULL);
862 DEBUG_REQ(D_ERROR, pill->rc_req,
863 "Cannot pack %d fields (%d bytes) in format `%s': ",
864 nr, total, fmt->rf_name);
868 EXPORT_SYMBOL(req_capsule_pack);
870 static int __req_capsule_offset(const struct req_capsule *pill,
871 const struct req_msg_field *field,
872 enum req_location loc)
876 offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
879 LASSERT(0 <= offset && offset < (sizeof(pill->rc_swabbed) << 3));
883 static void *__req_capsule_get(struct req_capsule *pill,
884 const struct req_msg_field *field,
885 enum req_location loc)
887 const struct req_format *fmt;
888 struct lustre_msg *msg;
893 void *(*getter)(struct lustre_msg *m, int n, int minlen);
895 static const char *rcl_names[RCL_NR] = {
896 [RCL_CLIENT] = "client",
897 [RCL_SERVER] = "server"
901 LASSERT(fmt != NULL);
902 LASSERT(__req_format_is_sane(fmt));
904 offset = __req_capsule_offset(pill, field, loc);
906 msg = __req_msg(pill, loc);
908 getter = (field->rmf_flags & RMF_F_STRING) ?
909 (typeof(getter))lustre_msg_string : lustre_msg_buf;
911 len = max(field->rmf_size, 0);
912 value = getter(msg, offset, len);
914 if (!(pill->rc_swabbed & (1 << offset)) && loc != pill->rc_loc &&
915 field->rmf_swabber != NULL && value != NULL &&
916 lustre_msg_swabbed(msg)) {
917 field->rmf_swabber(value);
918 pill->rc_swabbed |= (1 << offset);
921 DEBUG_REQ(D_ERROR, pill->rc_req,
922 "Wrong buffer for field `%s' (%d of %d) "
923 "in format `%s': %d vs. %d (%s)\n",
924 field->rmf_name, offset, lustre_msg_bufcount(msg), fmt->rf_name,
925 lustre_msg_buflen(msg, offset), field->rmf_size,
931 void *req_capsule_client_get(struct req_capsule *pill,
932 const struct req_msg_field *field)
934 return __req_capsule_get(pill, field, RCL_CLIENT);
936 EXPORT_SYMBOL(req_capsule_client_get);
938 void *req_capsule_server_get(struct req_capsule *pill,
939 const struct req_msg_field *field)
941 return __req_capsule_get(pill, field, RCL_SERVER);
943 EXPORT_SYMBOL(req_capsule_server_get);
945 const void *req_capsule_other_get(struct req_capsule *pill,
946 const struct req_msg_field *field)
948 return __req_capsule_get(pill, field, pill->rc_loc ^ 1);
950 EXPORT_SYMBOL(req_capsule_other_get);
952 void req_capsule_set_size(const struct req_capsule *pill,
953 const struct req_msg_field *field,
954 enum req_location loc, int size)
956 pill->rc_area[__req_capsule_offset(pill, field, loc)] = size;
958 EXPORT_SYMBOL(req_capsule_set_size);
960 int req_capsule_get_size(const struct req_capsule *pill,
961 const struct req_msg_field *field,
962 enum req_location loc)
964 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
966 return lustre_msg_buflen(__req_msg(pill, loc),
967 __req_capsule_offset(pill, field, loc));
969 EXPORT_SYMBOL(req_capsule_get_size);
971 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
973 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
978 const struct req_format *old;
980 LASSERT(pill->rc_fmt != NULL);
981 LASSERT(__req_format_is_sane(fmt));
987 for (i = 0; i < RCL_NR; ++i) {
988 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
989 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
990 LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
993 * Last field in old format can be shorter than in new.
995 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
996 FMT_FIELD(old, i, j)->rmf_size);
998 /* last field should be returned to the unswabbed state */
999 pill->rc_swabbed &= ~(__u32)(1 << j);
1002 EXPORT_SYMBOL(req_capsule_extend);
1004 int req_capsule_has_field(const struct req_capsule *pill,
1005 const struct req_msg_field *field,
1006 enum req_location loc)
1008 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1010 return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1012 EXPORT_SYMBOL(req_capsule_has_field);
1014 int req_capsule_field_present(const struct req_capsule *pill,
1015 const struct req_msg_field *field,
1016 enum req_location loc)
1020 LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1021 LASSERT(req_capsule_has_field(pill, field, loc));
1023 offset = __req_capsule_offset(pill, field, loc);
1024 return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
1026 EXPORT_SYMBOL(req_capsule_field_present);
1030 * Shrink the specified reply message buffer @field to a specified @newlen.
1031 * If @move_data is non-zero, then move following buffer backward
1032 * if @newlen is zero;
1033 * The internal offset should be adjusted by @adjust because buffer maybe has
1034 * been moved by previous call. (@adjust >= 0) is a must.
1035 * Return value: 1 if buffer has been moved, otherwise 0 is returned.
1037 int req_capsule_shrink(const struct req_capsule *pill,
1038 const struct req_msg_field *field,
1039 const unsigned int newlen,
1041 const int move_data)
1045 LASSERT(adjust >= 0);
1046 LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
1048 offset = __req_capsule_offset(pill, field, RCL_SERVER);
1050 LASSERT(offset >= 1);
1052 lustre_shrink_reply(pill->rc_req, offset, newlen, move_data);
1053 return (newlen == 0) ? 1 : 0;
1055 EXPORT_SYMBOL(req_capsule_shrink);
1057 /* __REQ_LAYOUT_USER__ */