lustre/ptlrpc/layout.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * Copyright (c) 2011 Whamcloud, Inc.
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  *
  39  * lustre/ptlrpc/layout.c
  40  *
  41  * Lustre Metadata Target (mdt) request handler
  42  *
  43  * Author: Nikita Danilov <nikita@clusterfs.com>
  44  */
  45 /*
  46  * This file contains the "capsule/pill" abstraction layered above PTLRPC.
  47  *
  48  * Every struct ptlrpc_request contains a "pill", which points to a description
  49  * of the format that the request conforms to.
  50  */
  51
  52 #if !defined(__REQ_LAYOUT_USER__)
  53
  54 #ifndef EXPORT_SYMTAB
  55 # define EXPORT_SYMTAB
  56 #endif
  57 #define DEBUG_SUBSYSTEM S_RPC
  58
  59 #ifdef __KERNEL__
  60 #include <linux/module.h>
  61 #else
  62 # include <liblustre.h>
  63 #endif
  64
  65 /* LUSTRE_VERSION_CODE */
  66 #include <lustre_ver.h>
  67
  68 #include <obd_support.h>
  69 /* lustre_swab_mdt_body */
  70 #include <lustre/lustre_idl.h>
  71 /* obd2cli_tgt() (required by DEBUG_REQ()) */
  72 #include <obd.h>
  73
  74 /* __REQ_LAYOUT_USER__ */
  75 #endif
  76 /* struct ptlrpc_request, lustre_msg* */
  77 #include <lustre_req_layout.h>
  78 #include <lustre_acl.h>
  79 #include <lustre_debug.h>
  80
  81 /*
  82  * RQFs (see below) refer to two struct req_msg_field arrays describing the
  83  * client request and server reply, respectively.
  84  */
  85 /* empty set of fields... for suitable definition of emptiness. */
  86 static const struct req_msg_field *empty[] = {
  87         &RMF_PTLRPC_BODY
  88 };
  89
  90 static const struct req_msg_field *mgs_target_info_only[] = {
  91         &RMF_PTLRPC_BODY,
  92         &RMF_MGS_TARGET_INFO
  93 };
  94
  95 static const struct req_msg_field *mgs_set_info[] = {
  96         &RMF_PTLRPC_BODY,
  97         &RMF_MGS_SEND_PARAM
  98 };
  99
 100 static const struct req_msg_field *log_cancel_client[] = {
 101         &RMF_PTLRPC_BODY,
 102         &RMF_LOGCOOKIES
 103 };
 104
 105 static const struct req_msg_field *mdt_body_only[] = {
 106         &RMF_PTLRPC_BODY,
 107         &RMF_MDT_BODY
 108 };
 109
 110 static const struct req_msg_field *mdt_body_capa[] = {
 111         &RMF_PTLRPC_BODY,
 112         &RMF_MDT_BODY,
 113         &RMF_CAPA1
 114 };
 115
 116 static const struct req_msg_field *quotactl_only[] = {
 117         &RMF_PTLRPC_BODY,
 118         &RMF_OBD_QUOTACTL
 119 };
 120 static const struct req_msg_field *quota_adjust_qunit_only[] = {
 121         &RMF_PTLRPC_BODY,
 122         &RMF_QUOTA_ADJUST_QUNIT
 123 };
 124
 125 static const struct req_msg_field *qunit_data_only[] = {
 126         &RMF_PTLRPC_BODY,
 127         &RMF_QUNIT_DATA
 128 };
 129
 130 static const struct req_msg_field *mdt_close_client[] = {
 131         &RMF_PTLRPC_BODY,
 132         &RMF_MDT_EPOCH,
 133         &RMF_REC_REINT,
 134         &RMF_CAPA1
 135 };
 136
 137 static const struct req_msg_field *obd_statfs_server[] = {
 138         &RMF_PTLRPC_BODY,
 139         &RMF_OBD_STATFS
 140 };
 141
 142 static const struct req_msg_field *seq_query_client[] = {
 143         &RMF_PTLRPC_BODY,
 144         &RMF_SEQ_OPC,
 145         &RMF_SEQ_RANGE
 146 };
 147
 148 static const struct req_msg_field *seq_query_server[] = {
 149         &RMF_PTLRPC_BODY,
 150         &RMF_SEQ_RANGE
 151 };
 152
 153 static const struct req_msg_field *fld_query_client[] = {
 154         &RMF_PTLRPC_BODY,
 155         &RMF_FLD_OPC,
 156         &RMF_FLD_MDFLD
 157 };
 158
 159 static const struct req_msg_field *fld_query_server[] = {
 160         &RMF_PTLRPC_BODY,
 161         &RMF_FLD_MDFLD
 162 };
 163
 164 static const struct req_msg_field *mds_getattr_name_client[] = {
 165         &RMF_PTLRPC_BODY,
 166         &RMF_MDT_BODY,
 167         &RMF_CAPA1,
 168         &RMF_NAME
 169 };
 170
 171 static const struct req_msg_field *mds_reint_client[] = {
 172         &RMF_PTLRPC_BODY,
 173         &RMF_REC_REINT
 174 };
 175
 176 static const struct req_msg_field *mds_reint_create_client[] = {
 177         &RMF_PTLRPC_BODY,
 178         &RMF_REC_REINT,
 179         &RMF_CAPA1,
 180         &RMF_NAME
 181 };
 182
 183 static const struct req_msg_field *mds_reint_create_slave_client[] = {
 184         &RMF_PTLRPC_BODY,
 185         &RMF_REC_REINT,
 186         &RMF_CAPA1,
 187         &RMF_NAME,
 188         &RMF_EADATA,
 189         &RMF_DLM_REQ
 190 };
 191
 192 static const struct req_msg_field *mds_reint_create_rmt_acl_client[] = {
 193         &RMF_PTLRPC_BODY,
 194         &RMF_REC_REINT,
 195         &RMF_CAPA1,
 196         &RMF_NAME,
 197         &RMF_EADATA,
 198         &RMF_DLM_REQ
 199 };
 200
 201 static const struct req_msg_field *mds_reint_create_sym_client[] = {
 202         &RMF_PTLRPC_BODY,
 203         &RMF_REC_REINT,
 204         &RMF_CAPA1,
 205         &RMF_NAME,
 206         &RMF_SYMTGT,
 207         &RMF_DLM_REQ
 208 };
 209
 210 static const struct req_msg_field *mds_reint_open_client[] = {
 211         &RMF_PTLRPC_BODY,
 212         &RMF_REC_REINT,
 213         &RMF_CAPA1,
 214         &RMF_CAPA2,
 215         &RMF_NAME,
 216         &RMF_EADATA
 217 };
 218
 219 static const struct req_msg_field *mds_reint_open_server[] = {
 220         &RMF_PTLRPC_BODY,
 221         &RMF_MDT_BODY,
 222         &RMF_MDT_MD,
 223         &RMF_ACL,
 224         &RMF_CAPA1,
 225         &RMF_CAPA2
 226 };
 227
 228 static const struct req_msg_field *mds_reint_unlink_client[] = {
 229         &RMF_PTLRPC_BODY,
 230         &RMF_REC_REINT,
 231         &RMF_CAPA1,
 232         &RMF_NAME,
 233         &RMF_DLM_REQ
 234 };
 235
 236 static const struct req_msg_field *mds_reint_link_client[] = {
 237         &RMF_PTLRPC_BODY,
 238         &RMF_REC_REINT,
 239         &RMF_CAPA1,
 240         &RMF_CAPA2,
 241         &RMF_NAME,
 242         &RMF_DLM_REQ
 243 };
 244
 245 static const struct req_msg_field *mds_reint_rename_client[] = {
 246         &RMF_PTLRPC_BODY,
 247         &RMF_REC_REINT,
 248         &RMF_CAPA1,
 249         &RMF_CAPA2,
 250         &RMF_NAME,
 251         &RMF_SYMTGT,
 252         &RMF_DLM_REQ
 253 };
 254
 255 static const struct req_msg_field *mds_last_unlink_server[] = {
 256         &RMF_PTLRPC_BODY,
 257         &RMF_MDT_BODY,
 258         &RMF_MDT_MD,
 259         &RMF_LOGCOOKIES,
 260         &RMF_CAPA1,
 261         &RMF_CAPA2
 262 };
 263
 264 static const struct req_msg_field *mds_reint_setattr_client[] = {
 265         &RMF_PTLRPC_BODY,
 266         &RMF_REC_REINT,
 267         &RMF_CAPA1,
 268         &RMF_MDT_EPOCH,
 269         &RMF_EADATA,
 270         &RMF_LOGCOOKIES,
 271         &RMF_DLM_REQ
 272 };
 273
 274 static const struct req_msg_field *mds_reint_setxattr_client[] = {
 275         &RMF_PTLRPC_BODY,
 276         &RMF_REC_REINT,
 277         &RMF_CAPA1,
 278         &RMF_NAME,
 279         &RMF_EADATA
 280 };
 281
 282 static const struct req_msg_field *obd_connect_client[] = {
 283         &RMF_PTLRPC_BODY,
 284         &RMF_TGTUUID,
 285         &RMF_CLUUID,
 286         &RMF_CONN,
 287         &RMF_CONNECT_DATA
 288 };
 289
 290 static const struct req_msg_field *obd_connect_server[] = {
 291         &RMF_PTLRPC_BODY,
 292         &RMF_CONNECT_DATA
 293 };
 294
 295 static const struct req_msg_field *obd_set_info_client[] = {
 296         &RMF_PTLRPC_BODY,
 297         &RMF_SETINFO_KEY,
 298         &RMF_SETINFO_VAL
 299 };
 300
 301 static const struct req_msg_field *ost_grant_shrink_client[] = {
 302         &RMF_PTLRPC_BODY,
 303         &RMF_SETINFO_KEY,
 304         &RMF_OST_BODY
 305 };
 306
 307 static const struct req_msg_field *mds_getinfo_client[] = {
 308         &RMF_PTLRPC_BODY,
 309         &RMF_GETINFO_KEY,
 310         &RMF_GETINFO_VALLEN
 311 };
 312
 313 static const struct req_msg_field *mds_getinfo_server[] = {
 314         &RMF_PTLRPC_BODY,
 315         &RMF_GETINFO_VAL,
 316 };
 317
 318 static const struct req_msg_field *ldlm_enqueue_client[] = {
 319         &RMF_PTLRPC_BODY,
 320         &RMF_DLM_REQ
 321 };
 322
 323 static const struct req_msg_field *ldlm_enqueue_server[] = {
 324         &RMF_PTLRPC_BODY,
 325         &RMF_DLM_REP
 326 };
 327
 328 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
 329         &RMF_PTLRPC_BODY,
 330         &RMF_DLM_REP,
 331         &RMF_DLM_LVB
 332 };
 333
 334 static const struct req_msg_field *ldlm_cp_callback_client[] = {
 335         &RMF_PTLRPC_BODY,
 336         &RMF_DLM_REQ,
 337         &RMF_DLM_LVB
 338 };
 339
 340 static const struct req_msg_field *ldlm_gl_callback_server[] = {
 341         &RMF_PTLRPC_BODY,
 342         &RMF_DLM_LVB
 343 };
 344
 345 static const struct req_msg_field *ldlm_intent_client[] = {
 346         &RMF_PTLRPC_BODY,
 347         &RMF_DLM_REQ,
 348         &RMF_LDLM_INTENT,
 349         &RMF_REC_REINT
 350 };
 351
 352 static const struct req_msg_field *ldlm_intent_server[] = {
 353         &RMF_PTLRPC_BODY,
 354         &RMF_DLM_REP,
 355         &RMF_MDT_BODY,
 356         &RMF_MDT_MD,
 357         &RMF_ACL
 358 };
 359
 360 static const struct req_msg_field *ldlm_intent_open_server[] = {
 361         &RMF_PTLRPC_BODY,
 362         &RMF_DLM_REP,
 363         &RMF_MDT_BODY,
 364         &RMF_MDT_MD,
 365         &RMF_ACL,
 366         &RMF_CAPA1,
 367         &RMF_CAPA2
 368 };
 369
 370 static const struct req_msg_field *ldlm_intent_getattr_client[] = {
 371         &RMF_PTLRPC_BODY,
 372         &RMF_DLM_REQ,
 373         &RMF_LDLM_INTENT,
 374         &RMF_MDT_BODY,     /* coincides with mds_getattr_name_client[] */
 375         &RMF_CAPA1,
 376         &RMF_NAME
 377 };
 378
 379 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
 380         &RMF_PTLRPC_BODY,
 381         &RMF_DLM_REP,
 382         &RMF_MDT_BODY,
 383         &RMF_MDT_MD,
 384         &RMF_ACL,
 385         &RMF_CAPA1
 386 };
 387
 388 static const struct req_msg_field *ldlm_intent_create_client[] = {
 389         &RMF_PTLRPC_BODY,
 390         &RMF_DLM_REQ,
 391         &RMF_LDLM_INTENT,
 392         &RMF_REC_REINT,    /* coincides with mds_reint_create_client[] */
 393         &RMF_CAPA1,
 394         &RMF_NAME,
 395         &RMF_EADATA
 396 };
 397
 398 static const struct req_msg_field *ldlm_intent_open_client[] = {
 399         &RMF_PTLRPC_BODY,
 400         &RMF_DLM_REQ,
 401         &RMF_LDLM_INTENT,
 402         &RMF_REC_REINT,    /* coincides with mds_reint_open_client[] */
 403         &RMF_CAPA1,
 404         &RMF_CAPA2,
 405         &RMF_NAME,
 406         &RMF_EADATA
 407 };
 408
 409 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
 410         &RMF_PTLRPC_BODY,
 411         &RMF_DLM_REQ,
 412         &RMF_LDLM_INTENT,
 413         &RMF_REC_REINT,    /* coincides with mds_reint_unlink_client[] */
 414         &RMF_CAPA1,
 415         &RMF_NAME
 416 };
 417
 418 static const struct req_msg_field *mds_getxattr_client[] = {
 419         &RMF_PTLRPC_BODY,
 420         &RMF_MDT_BODY,
 421         &RMF_CAPA1,
 422         &RMF_NAME,
 423         &RMF_EADATA
 424 };
 425
 426 static const struct req_msg_field *mds_getxattr_server[] = {
 427         &RMF_PTLRPC_BODY,
 428         &RMF_MDT_BODY,
 429         &RMF_EADATA
 430 };
 431
 432 static const struct req_msg_field *mds_getattr_server[] = {
 433         &RMF_PTLRPC_BODY,
 434         &RMF_MDT_BODY,
 435         &RMF_MDT_MD,
 436         &RMF_ACL,
 437         &RMF_CAPA1,
 438         &RMF_CAPA2
 439 };
 440
 441 static const struct req_msg_field *mds_setattr_server[] = {
 442         &RMF_PTLRPC_BODY,
 443         &RMF_MDT_BODY,
 444         &RMF_MDT_MD,
 445         &RMF_ACL,
 446         &RMF_CAPA1,
 447         &RMF_CAPA2
 448 };
 449
 450 static const struct req_msg_field *llog_catinfo_client[] = {
 451         &RMF_PTLRPC_BODY,
 452         &RMF_NAME,
 453         &RMF_STRING
 454 };
 455
 456 static const struct req_msg_field *llog_catinfo_server[] = {
 457         &RMF_PTLRPC_BODY,
 458         &RMF_STRING
 459 };
 460
 461 static const struct req_msg_field *llog_origin_handle_create_client[] = {
 462         &RMF_PTLRPC_BODY,
 463         &RMF_LLOGD_BODY,
 464         &RMF_NAME
 465 };
 466
 467 static const struct req_msg_field *llogd_body_only[] = {
 468         &RMF_PTLRPC_BODY,
 469         &RMF_LLOGD_BODY
 470 };
 471
 472 static const struct req_msg_field *llog_log_hdr_only[] = {
 473         &RMF_PTLRPC_BODY,
 474         &RMF_LLOG_LOG_HDR
 475 };
 476
 477 static const struct req_msg_field *llogd_conn_body_only[] = {
 478         &RMF_PTLRPC_BODY,
 479         &RMF_LLOGD_CONN_BODY
 480 };
 481
 482 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
 483         &RMF_PTLRPC_BODY,
 484         &RMF_LLOGD_BODY,
 485         &RMF_EADATA
 486 };
 487
 488 static const struct req_msg_field *ost_body_only[] = {
 489         &RMF_PTLRPC_BODY,
 490         &RMF_OST_BODY
 491 };
 492
 493 static const struct req_msg_field *ost_body_capa[] = {
 494         &RMF_PTLRPC_BODY,
 495         &RMF_OST_BODY,
 496         &RMF_CAPA1
 497 };
 498
 499 static const struct req_msg_field *ost_destroy_client[] = {
 500         &RMF_PTLRPC_BODY,
 501         &RMF_OST_BODY,
 502         &RMF_DLM_REQ,
 503         &RMF_CAPA1
 504 };
 505
 506
 507 static const struct req_msg_field *ost_brw_client[] = {
 508         &RMF_PTLRPC_BODY,
 509         &RMF_OST_BODY,
 510         &RMF_OBD_IOOBJ,
 511         &RMF_NIOBUF_REMOTE,
 512         &RMF_CAPA1
 513 };
 514
 515 static const struct req_msg_field *ost_brw_read_server[] = {
 516         &RMF_PTLRPC_BODY,
 517         &RMF_OST_BODY
 518 };
 519
 520 static const struct req_msg_field *ost_brw_write_server[] = {
 521         &RMF_PTLRPC_BODY,
 522         &RMF_OST_BODY,
 523         &RMF_RCS
 524 };
 525
 526 static const struct req_msg_field *ost_get_info_generic_server[] = {
 527         &RMF_PTLRPC_BODY,
 528         &RMF_GENERIC_DATA,
 529 };
 530
 531 static const struct req_msg_field *ost_get_info_generic_client[] = {
 532         &RMF_PTLRPC_BODY,
 533         &RMF_SETINFO_KEY
 534 };
 535
 536 static const struct req_msg_field *ost_get_last_id_server[] = {
 537         &RMF_PTLRPC_BODY,
 538         &RMF_OBD_ID
 539 };
 540
 541 static const struct req_msg_field *ost_get_fiemap_client[] = {
 542         &RMF_PTLRPC_BODY,
 543         &RMF_FIEMAP_KEY,
 544         &RMF_FIEMAP_VAL
 545 };
 546
 547 static const struct req_msg_field *ost_get_fiemap_server[] = {
 548         &RMF_PTLRPC_BODY,
 549         &RMF_FIEMAP_VAL
 550 };
 551
 552 static struct req_format *req_formats[] = {
 553         &RQF_OBD_PING,
 554         &RQF_OBD_SET_INFO,
 555         &RQF_SEC_CTX,
 556         &RQF_MGS_TARGET_REG,
 557         &RQF_MGS_SET_INFO,
 558         &RQF_SEQ_QUERY,
 559         &RQF_FLD_QUERY,
 560         &RQF_MDS_CONNECT,
 561         &RQF_MDS_DISCONNECT,
 562         &RQF_MDS_GET_INFO,
 563         &RQF_MDS_GETSTATUS,
 564         &RQF_MDS_STATFS,
 565         &RQF_MDS_GETATTR,
 566         &RQF_MDS_GETATTR_NAME,
 567         &RQF_MDS_GETXATTR,
 568         &RQF_MDS_SYNC,
 569         &RQF_MDS_CLOSE,
 570         &RQF_MDS_PIN,
 571         &RQF_MDS_UNPIN,
 572         &RQF_MDS_READPAGE,
 573         &RQF_MDS_WRITEPAGE,
 574         &RQF_MDS_IS_SUBDIR,
 575         &RQF_MDS_DONE_WRITING,
 576         &RQF_MDS_REINT,
 577         &RQF_MDS_REINT_CREATE,
 578         &RQF_MDS_REINT_CREATE_RMT_ACL,
 579         &RQF_MDS_REINT_CREATE_SLAVE,
 580         &RQF_MDS_REINT_CREATE_SYM,
 581         &RQF_MDS_REINT_OPEN,
 582         &RQF_MDS_REINT_UNLINK,
 583         &RQF_MDS_REINT_LINK,
 584         &RQF_MDS_REINT_RENAME,
 585         &RQF_MDS_REINT_SETATTR,
 586         &RQF_MDS_REINT_SETXATTR,
 587         &RQF_MDS_QUOTACHECK,
 588         &RQF_MDS_QUOTACTL,
 589         &RQF_MDS_QUOTA_DQACQ,
 590         &RQF_QC_CALLBACK,
 591         &RQF_OST_CONNECT,
 592         &RQF_OST_DISCONNECT,
 593         &RQF_OST_QUOTACHECK,
 594         &RQF_OST_QUOTACTL,
 595         &RQF_OST_QUOTA_ADJUST_QUNIT,
 596         &RQF_OST_GETATTR,
 597         &RQF_OST_SETATTR,
 598         &RQF_OST_CREATE,
 599         &RQF_OST_PUNCH,
 600         &RQF_OST_SYNC,
 601         &RQF_OST_DESTROY,
 602         &RQF_OST_BRW_READ,
 603         &RQF_OST_BRW_WRITE,
 604         &RQF_OST_STATFS,
 605         &RQF_OST_SET_GRANT_INFO,
 606         &RQF_OST_GET_INFO_GENERIC,
 607         &RQF_OST_GET_INFO_LAST_ID,
 608         &RQF_OST_GET_INFO_FIEMAP,
 609         &RQF_LDLM_ENQUEUE,
 610         &RQF_LDLM_ENQUEUE_LVB,
 611         &RQF_LDLM_CONVERT,
 612         &RQF_LDLM_CANCEL,
 613         &RQF_LDLM_CALLBACK,
 614         &RQF_LDLM_CP_CALLBACK,
 615         &RQF_LDLM_BL_CALLBACK,
 616         &RQF_LDLM_GL_CALLBACK,
 617         &RQF_LDLM_INTENT,
 618         &RQF_LDLM_INTENT_GETATTR,
 619         &RQF_LDLM_INTENT_OPEN,
 620         &RQF_LDLM_INTENT_CREATE,
 621         &RQF_LDLM_INTENT_UNLINK,
 622         &RQF_LOG_CANCEL,
 623         &RQF_LLOG_CATINFO,
 624         &RQF_LLOG_ORIGIN_HANDLE_CREATE,
 625         &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
 626         &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
 627         &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
 628         &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
 629         &RQF_LLOG_ORIGIN_CONNECT
 630 };
 631
 632 struct req_msg_field {
 633         const __u32 rmf_flags;
 634         const char  *rmf_name;
 635         /**
 636          * Field length. (-1) means "variable length".  If the
 637          * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
 638          * but the actual size must be a whole multiple of \a rmf_size.
 639          */
 640         const int   rmf_size;
 641         void        (*rmf_swabber)(void *);
 642         void        (*rmf_dumper)(void *);
 643         int         rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
 644 };
 645
 646 enum rmf_flags {
 647         /**
 648          * The field is a string, must be NUL-terminated.
 649          */
 650         RMF_F_STRING = 1 << 0,
 651         /**
 652          * The field's buffer size need not match the declared \a rmf_size.
 653          */
 654         RMF_F_NO_SIZE_CHECK = 1 << 1,
 655         /**
 656          * The field's buffer size must be a whole multiple of the declared \a
 657          * rmf_size and the \a rmf_swabber function must work on the declared \a
 658          * rmf_size worth of bytes.
 659          */
 660         RMF_F_STRUCT_ARRAY = 1 << 2
 661 };
 662
 663 struct req_capsule;
 664
 665 /*
 666  * Request fields.
 667  */
 668 #define DEFINE_MSGF(name, flags, size, swabber, dumper) {       \
 669         .rmf_name    = (name),                                  \
 670         .rmf_flags   = (flags),                                 \
 671         .rmf_size    = (size),                                  \
 672         .rmf_swabber = (void (*)(void*))(swabber),              \
 673         .rmf_dumper  = (void (*)(void*))(dumper)                \
 674 }
 675
 676 struct req_msg_field RMF_GENERIC_DATA =
 677         DEFINE_MSGF("generic_data", 0,
 678                     -1, NULL, NULL);
 679 EXPORT_SYMBOL(RMF_GENERIC_DATA);
 680
 681 struct req_msg_field RMF_MGS_TARGET_INFO =
 682         DEFINE_MSGF("mgs_target_info", 0,
 683                     sizeof(struct mgs_target_info),
 684                     lustre_swab_mgs_target_info, NULL);
 685 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
 686
 687 struct req_msg_field RMF_MGS_SEND_PARAM =
 688         DEFINE_MSGF("mgs_send_param", 0,
 689                     sizeof(struct mgs_send_param),
 690                     NULL, NULL);
 691 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
 692
 693 struct req_msg_field RMF_SETINFO_VAL =
 694         DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
 695 EXPORT_SYMBOL(RMF_SETINFO_VAL);
 696
 697 struct req_msg_field RMF_GETINFO_KEY =
 698         DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
 699 EXPORT_SYMBOL(RMF_GETINFO_KEY);
 700
 701 struct req_msg_field RMF_GETINFO_VALLEN =
 702         DEFINE_MSGF("getinfo_vallen", 0,
 703                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 704 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
 705
 706 struct req_msg_field RMF_GETINFO_VAL =
 707         DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
 708 EXPORT_SYMBOL(RMF_GETINFO_VAL);
 709
 710 struct req_msg_field RMF_SEQ_OPC =
 711         DEFINE_MSGF("seq_query_opc", 0,
 712                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 713 EXPORT_SYMBOL(RMF_SEQ_OPC);
 714
 715 struct req_msg_field RMF_SEQ_RANGE =
 716         DEFINE_MSGF("seq_query_range", 0,
 717                     sizeof(struct lu_seq_range),
 718                     lustre_swab_lu_seq_range, NULL);
 719 EXPORT_SYMBOL(RMF_SEQ_RANGE);
 720
 721 struct req_msg_field RMF_FLD_OPC =
 722         DEFINE_MSGF("fld_query_opc", 0,
 723                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 724 EXPORT_SYMBOL(RMF_FLD_OPC);
 725
 726 struct req_msg_field RMF_FLD_MDFLD =
 727         DEFINE_MSGF("fld_query_mdfld", 0,
 728                     sizeof(struct lu_seq_range),
 729                     lustre_swab_lu_seq_range, NULL);
 730 EXPORT_SYMBOL(RMF_FLD_MDFLD);
 731
 732 struct req_msg_field RMF_MDT_BODY =
 733         DEFINE_MSGF("mdt_body", 0,
 734                     sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
 735 EXPORT_SYMBOL(RMF_MDT_BODY);
 736
 737 struct req_msg_field RMF_OBD_QUOTACTL =
 738         DEFINE_MSGF("obd_quotactl", 0,
 739                     sizeof(struct obd_quotactl),
 740                     lustre_swab_obd_quotactl, NULL);
 741 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
 742
 743 struct req_msg_field RMF_QUOTA_ADJUST_QUNIT =
 744         DEFINE_MSGF("quota_adjust_qunit", 0,
 745                     sizeof(struct quota_adjust_qunit),
 746                     lustre_swab_quota_adjust_qunit, NULL);
 747 EXPORT_SYMBOL(RMF_QUOTA_ADJUST_QUNIT);
 748
 749 struct req_msg_field RMF_QUNIT_DATA =
 750         DEFINE_MSGF("qunit_data", 0,
 751                     sizeof(struct qunit_data), lustre_swab_qdata, NULL);
 752 EXPORT_SYMBOL(RMF_QUNIT_DATA);
 753
 754 struct req_msg_field RMF_MDT_EPOCH =
 755         DEFINE_MSGF("mdt_ioepoch", 0,
 756                     sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
 757 EXPORT_SYMBOL(RMF_MDT_EPOCH);
 758
 759 struct req_msg_field RMF_PTLRPC_BODY =
 760         DEFINE_MSGF("ptlrpc_body", 0,
 761                     sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
 762 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
 763
 764 struct req_msg_field RMF_OBD_STATFS =
 765         DEFINE_MSGF("obd_statfs", 0,
 766                     sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
 767 EXPORT_SYMBOL(RMF_OBD_STATFS);
 768
 769 struct req_msg_field RMF_SETINFO_KEY =
 770         DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
 771 EXPORT_SYMBOL(RMF_SETINFO_KEY);
 772
 773 struct req_msg_field RMF_NAME =
 774         DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
 775 EXPORT_SYMBOL(RMF_NAME);
 776
 777 struct req_msg_field RMF_SYMTGT =
 778         DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
 779 EXPORT_SYMBOL(RMF_SYMTGT);
 780
 781 struct req_msg_field RMF_TGTUUID =
 782         DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
 783         NULL);
 784 EXPORT_SYMBOL(RMF_TGTUUID);
 785
 786 struct req_msg_field RMF_CLUUID =
 787         DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
 788         NULL);
 789 EXPORT_SYMBOL(RMF_CLUUID);
 790
 791 struct req_msg_field RMF_STRING =
 792         DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
 793 EXPORT_SYMBOL(RMF_STRING);
 794
 795 struct req_msg_field RMF_LLOGD_BODY =
 796         DEFINE_MSGF("llogd_body", 0,
 797                     sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
 798 EXPORT_SYMBOL(RMF_LLOGD_BODY);
 799
 800 struct req_msg_field RMF_LLOG_LOG_HDR =
 801         DEFINE_MSGF("llog_log_hdr", 0,
 802                     sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
 803 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
 804
 805 struct req_msg_field RMF_LLOGD_CONN_BODY =
 806         DEFINE_MSGF("llogd_conn_body", 0,
 807                     sizeof(struct llogd_conn_body),
 808                     lustre_swab_llogd_conn_body, NULL);
 809 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
 810
 811 /*
 812  * connection handle received in MDS_CONNECT request.
 813  *
 814  * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
 815  * that the client does not interpret at all.
 816  */
 817 struct req_msg_field RMF_CONN =
 818         DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
 819 EXPORT_SYMBOL(RMF_CONN);
 820
 821 struct req_msg_field RMF_CONNECT_DATA =
 822         DEFINE_MSGF("cdata",
 823                     RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
 824 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 9, 0, 0)
 825                     sizeof(struct obd_connect_data),
 826 #else
 827 /* For interoperability with 1.8 and 2.0 clients/servers.
 828  * The RPC verification code allows larger RPC buffers, but not
 829  * smaller buffers.  Until we no longer need to keep compatibility
 830  * with older servers/clients we can only check that the buffer
 831  * size is at least as large as obd_connect_data_v1.  That is not
 832  * not in itself harmful, since the chance of just corrupting this
 833  * field is low.  See JIRA LU-16 for details. */
 834                     sizeof(struct obd_connect_data_v1),
 835 #endif
 836                     lustre_swab_connect, NULL);
 837 EXPORT_SYMBOL(RMF_CONNECT_DATA);
 838
 839 struct req_msg_field RMF_DLM_REQ =
 840         DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
 841                     sizeof(struct ldlm_request),
 842                     lustre_swab_ldlm_request, NULL);
 843 EXPORT_SYMBOL(RMF_DLM_REQ);
 844
 845 struct req_msg_field RMF_DLM_REP =
 846         DEFINE_MSGF("dlm_rep", 0,
 847                     sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
 848 EXPORT_SYMBOL(RMF_DLM_REP);
 849
 850 struct req_msg_field RMF_LDLM_INTENT =
 851         DEFINE_MSGF("ldlm_intent", 0,
 852                     sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
 853 EXPORT_SYMBOL(RMF_LDLM_INTENT);
 854
 855 struct req_msg_field RMF_DLM_LVB =
 856         DEFINE_MSGF("dlm_lvb", 0, sizeof(struct ost_lvb), lustre_swab_ost_lvb,
 857         NULL);
 858 EXPORT_SYMBOL(RMF_DLM_LVB);
 859
 860 struct req_msg_field RMF_MDT_MD =
 861         DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
 862 EXPORT_SYMBOL(RMF_MDT_MD);
 863
 864 struct req_msg_field RMF_REC_REINT =
 865         DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
 866                     lustre_swab_mdt_rec_reint, NULL);
 867 EXPORT_SYMBOL(RMF_REC_REINT);
 868
 869 /* FIXME: this length should be defined as a macro */
 870 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
 871                                                     NULL, NULL);
 872 EXPORT_SYMBOL(RMF_EADATA);
 873
 874 struct req_msg_field RMF_ACL =
 875         DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
 876                     LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
 877 EXPORT_SYMBOL(RMF_ACL);
 878
 879 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
 880 struct req_msg_field RMF_LOGCOOKIES =
 881         DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
 882                     sizeof(struct llog_cookie), NULL, NULL);
 883 EXPORT_SYMBOL(RMF_LOGCOOKIES);
 884
 885 struct req_msg_field RMF_CAPA1 =
 886         DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
 887                     lustre_swab_lustre_capa, NULL);
 888 EXPORT_SYMBOL(RMF_CAPA1);
 889
 890 struct req_msg_field RMF_CAPA2 =
 891         DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
 892                     lustre_swab_lustre_capa, NULL);
 893 EXPORT_SYMBOL(RMF_CAPA2);
 894
 895 /*
 896  * OST request field.
 897  */
 898 struct req_msg_field RMF_OST_BODY =
 899         DEFINE_MSGF("ost_body", 0,
 900                     sizeof(struct ost_body), lustre_swab_ost_body, dump_ost_body);
 901 EXPORT_SYMBOL(RMF_OST_BODY);
 902
 903 struct req_msg_field RMF_OBD_IOOBJ =
 904         DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
 905                     sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
 906 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
 907
 908 struct req_msg_field RMF_NIOBUF_REMOTE =
 909         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
 910                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
 911                     dump_rniobuf);
 912 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
 913
 914 struct req_msg_field RMF_RCS =
 915         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
 916                     lustre_swab_generic_32s, dump_rcs);
 917 EXPORT_SYMBOL(RMF_RCS);
 918
 919 struct req_msg_field RMF_OBD_ID =
 920         DEFINE_MSGF("obd_id", 0,
 921                     sizeof(obd_id), lustre_swab_ost_last_id, NULL);
 922 EXPORT_SYMBOL(RMF_OBD_ID);
 923
 924 struct req_msg_field RMF_FIEMAP_KEY =
 925         DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
 926                     lustre_swab_fiemap, NULL);
 927 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
 928
 929 struct req_msg_field RMF_FIEMAP_VAL =
 930         DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
 931 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
 932
 933 /*
 934  * Request formats.
 935  */
 936
 937 struct req_format {
 938         const char *rf_name;
 939         int         rf_idx;
 940         struct {
 941                 int                          nr;
 942                 const struct req_msg_field **d;
 943         } rf_fields[RCL_NR];
 944 };
 945
 946 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) {    \
 947         .rf_name   = name,                                              \
 948         .rf_fields = {                                                  \
 949                 [RCL_CLIENT] = {                                        \
 950                         .nr = client_nr,                                \
 951                         .d  = client                                    \
 952                 },                                                      \
 953                 [RCL_SERVER] = {                                        \
 954                         .nr = server_nr,                                \
 955                         .d  = server                                    \
 956                 }                                                       \
 957         }                                                               \
 958 }
 959
 960 #define DEFINE_REQ_FMT0(name, client, server)                                  \
 961 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
 962
 963 struct req_format RQF_OBD_PING =
 964         DEFINE_REQ_FMT0("OBD_PING", empty, empty);
 965 EXPORT_SYMBOL(RQF_OBD_PING);
 966
 967 struct req_format RQF_OBD_SET_INFO =
 968         DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
 969 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
 970
 971 struct req_format RQF_SEC_CTX =
 972         DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
 973 EXPORT_SYMBOL(RQF_SEC_CTX);
 974
 975 struct req_format RQF_MGS_TARGET_REG =
 976         DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
 977                          mgs_target_info_only);
 978 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
 979
 980 struct req_format RQF_MGS_SET_INFO =
 981         DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
 982                          mgs_set_info);
 983 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
 984
 985 struct req_format RQF_SEQ_QUERY =
 986         DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
 987 EXPORT_SYMBOL(RQF_SEQ_QUERY);
 988
 989 struct req_format RQF_FLD_QUERY =
 990         DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
 991 EXPORT_SYMBOL(RQF_FLD_QUERY);
 992
 993 struct req_format RQF_LOG_CANCEL =
 994         DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
 995 EXPORT_SYMBOL(RQF_LOG_CANCEL);
 996
 997 struct req_format RQF_MDS_QUOTACHECK =
 998         DEFINE_REQ_FMT0("MDS_QUOTACHECK", quotactl_only, empty);
 999 EXPORT_SYMBOL(RQF_MDS_QUOTACHECK);
1000
1001 struct req_format RQF_OST_QUOTACHECK =
1002         DEFINE_REQ_FMT0("OST_QUOTACHECK", quotactl_only, empty);
1003 EXPORT_SYMBOL(RQF_OST_QUOTACHECK);
1004
1005 struct req_format RQF_MDS_QUOTACTL =
1006         DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1007 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1008
1009 struct req_format RQF_OST_QUOTACTL =
1010         DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1011 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1012
1013 struct req_format RQF_OST_QUOTA_ADJUST_QUNIT =
1014         DEFINE_REQ_FMT0("OST_QUOTA_ADJUST_QUNIT", quota_adjust_qunit_only,
1015                         quota_adjust_qunit_only);
1016 EXPORT_SYMBOL(RQF_OST_QUOTA_ADJUST_QUNIT);
1017
1018 struct req_format RQF_QC_CALLBACK =
1019         DEFINE_REQ_FMT0("QC_CALLBACK", quotactl_only, empty);
1020 EXPORT_SYMBOL(RQF_QC_CALLBACK);
1021
1022 struct req_format RQF_MDS_QUOTA_DQACQ =
1023         DEFINE_REQ_FMT0("MDS_QUOTA_DQACQ", qunit_data_only, qunit_data_only);
1024 EXPORT_SYMBOL(RQF_MDS_QUOTA_DQACQ);
1025
1026 struct req_format RQF_MDS_GETSTATUS =
1027         DEFINE_REQ_FMT0("MDS_GETSTATUS", mdt_body_only, mdt_body_capa);
1028 EXPORT_SYMBOL(RQF_MDS_GETSTATUS);
1029
1030 struct req_format RQF_MDS_STATFS =
1031         DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1032 EXPORT_SYMBOL(RQF_MDS_STATFS);
1033
1034 struct req_format RQF_MDS_SYNC =
1035         DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1036 EXPORT_SYMBOL(RQF_MDS_SYNC);
1037
1038 struct req_format RQF_MDS_GETATTR =
1039         DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1040 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1041
1042 struct req_format RQF_MDS_GETXATTR =
1043         DEFINE_REQ_FMT0("MDS_GETXATTR",
1044                         mds_getxattr_client, mds_getxattr_server);
1045 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1046
1047 struct req_format RQF_MDS_GETATTR_NAME =
1048         DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1049                         mds_getattr_name_client, mds_getattr_server);
1050 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1051
1052 struct req_format RQF_MDS_REINT =
1053         DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1054 EXPORT_SYMBOL(RQF_MDS_REINT);
1055
1056 struct req_format RQF_MDS_REINT_CREATE =
1057         DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1058                         mds_reint_create_client, mdt_body_capa);
1059 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1060
1061 struct req_format RQF_MDS_REINT_CREATE_RMT_ACL =
1062         DEFINE_REQ_FMT0("MDS_REINT_CREATE_RMT_ACL",
1063                         mds_reint_create_rmt_acl_client, mdt_body_capa);
1064 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_RMT_ACL);
1065
1066 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1067         DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1068                         mds_reint_create_slave_client, mdt_body_capa);
1069 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1070
1071 struct req_format RQF_MDS_REINT_CREATE_SYM =
1072         DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1073                         mds_reint_create_sym_client, mdt_body_capa);
1074 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1075
1076 struct req_format RQF_MDS_REINT_OPEN =
1077         DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1078                         mds_reint_open_client, mds_reint_open_server);
1079 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1080
1081 struct req_format RQF_MDS_REINT_UNLINK =
1082         DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1083                         mds_last_unlink_server);
1084 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1085
1086 struct req_format RQF_MDS_REINT_LINK =
1087         DEFINE_REQ_FMT0("MDS_REINT_LINK",
1088                         mds_reint_link_client, mdt_body_only);
1089 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1090
1091 struct req_format RQF_MDS_REINT_RENAME =
1092         DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1093                         mds_last_unlink_server);
1094 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1095
1096 struct req_format RQF_MDS_REINT_SETATTR =
1097         DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1098                         mds_reint_setattr_client, mds_setattr_server);
1099 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1100
1101 struct req_format RQF_MDS_REINT_SETXATTR =
1102         DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1103                         mds_reint_setxattr_client, mdt_body_only);
1104 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1105
1106 struct req_format RQF_MDS_CONNECT =
1107         DEFINE_REQ_FMT0("MDS_CONNECT",
1108                         obd_connect_client, obd_connect_server);
1109 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1110
1111 struct req_format RQF_MDS_DISCONNECT =
1112         DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1113 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1114
1115 struct req_format RQF_MDS_GET_INFO =
1116         DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1117                         mds_getinfo_server);
1118 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1119
1120 struct req_format RQF_LDLM_ENQUEUE =
1121         DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1122                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1123 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1124
1125 struct req_format RQF_LDLM_ENQUEUE_LVB =
1126         DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1127                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1128 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1129
1130 struct req_format RQF_LDLM_CONVERT =
1131         DEFINE_REQ_FMT0("LDLM_CONVERT",
1132                         ldlm_enqueue_client, ldlm_enqueue_server);
1133 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1134
1135 struct req_format RQF_LDLM_CANCEL =
1136         DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1137 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1138
1139 struct req_format RQF_LDLM_CALLBACK =
1140         DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1141 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1142
1143 struct req_format RQF_LDLM_CP_CALLBACK =
1144         DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1145 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1146
1147 struct req_format RQF_LDLM_BL_CALLBACK =
1148         DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1149 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1150
1151 struct req_format RQF_LDLM_GL_CALLBACK =
1152         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1153                         ldlm_gl_callback_server);
1154 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1155
1156 struct req_format RQF_LDLM_INTENT =
1157         DEFINE_REQ_FMT0("LDLM_INTENT",
1158                         ldlm_intent_client, ldlm_intent_server);
1159 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1160
1161 struct req_format RQF_LDLM_INTENT_GETATTR =
1162         DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1163                         ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1164 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1165
1166 struct req_format RQF_LDLM_INTENT_OPEN =
1167         DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1168                         ldlm_intent_open_client, ldlm_intent_open_server);
1169 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1170
1171 struct req_format RQF_LDLM_INTENT_CREATE =
1172         DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1173                         ldlm_intent_create_client, ldlm_intent_getattr_server);
1174 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1175
1176 struct req_format RQF_LDLM_INTENT_UNLINK =
1177         DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1178                         ldlm_intent_unlink_client, ldlm_intent_server);
1179 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1180
1181 struct req_format RQF_MDS_CLOSE =
1182         DEFINE_REQ_FMT0("MDS_CLOSE",
1183                         mdt_close_client, mds_last_unlink_server);
1184 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1185
1186 struct req_format RQF_MDS_PIN =
1187         DEFINE_REQ_FMT0("MDS_PIN",
1188                         mdt_body_capa, mdt_body_only);
1189 EXPORT_SYMBOL(RQF_MDS_PIN);
1190
1191 struct req_format RQF_MDS_UNPIN =
1192         DEFINE_REQ_FMT0("MDS_UNPIN", mdt_body_only, empty);
1193 EXPORT_SYMBOL(RQF_MDS_UNPIN);
1194
1195 struct req_format RQF_MDS_DONE_WRITING =
1196         DEFINE_REQ_FMT0("MDS_DONE_WRITING",
1197                         mdt_close_client, mdt_body_only);
1198 EXPORT_SYMBOL(RQF_MDS_DONE_WRITING);
1199
1200 struct req_format RQF_MDS_READPAGE =
1201         DEFINE_REQ_FMT0("MDS_READPAGE",
1202                         mdt_body_capa, mdt_body_only);
1203 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1204
1205 /* This is for split */
1206 struct req_format RQF_MDS_WRITEPAGE =
1207         DEFINE_REQ_FMT0("MDS_WRITEPAGE",
1208                         mdt_body_capa, mdt_body_only);
1209 EXPORT_SYMBOL(RQF_MDS_WRITEPAGE);
1210
1211 struct req_format RQF_MDS_IS_SUBDIR =
1212         DEFINE_REQ_FMT0("MDS_IS_SUBDIR",
1213                         mdt_body_only, mdt_body_only);
1214 EXPORT_SYMBOL(RQF_MDS_IS_SUBDIR);
1215
1216 struct req_format RQF_LLOG_CATINFO =
1217         DEFINE_REQ_FMT0("LLOG_CATINFO",
1218                         llog_catinfo_client, llog_catinfo_server);
1219 EXPORT_SYMBOL(RQF_LLOG_CATINFO);
1220
1221 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1222         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1223                         llog_origin_handle_create_client, llogd_body_only);
1224 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1225
1226 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1227         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1228                         llogd_body_only, llogd_body_only);
1229 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1230
1231 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1232         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1233                         llogd_body_only, llog_origin_handle_next_block_server);
1234 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1235
1236 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1237         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1238                         llogd_body_only, llog_origin_handle_next_block_server);
1239 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1240
1241 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1242         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1243                         llogd_body_only, llog_log_hdr_only);
1244 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1245
1246 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1247         DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1248 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1249
1250 struct req_format RQF_OST_CONNECT =
1251         DEFINE_REQ_FMT0("OST_CONNECT",
1252                         obd_connect_client, obd_connect_server);
1253 EXPORT_SYMBOL(RQF_OST_CONNECT);
1254
1255 struct req_format RQF_OST_DISCONNECT =
1256         DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1257 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1258
1259 struct req_format RQF_OST_GETATTR =
1260         DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1261 EXPORT_SYMBOL(RQF_OST_GETATTR);
1262
1263 struct req_format RQF_OST_SETATTR =
1264         DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1265 EXPORT_SYMBOL(RQF_OST_SETATTR);
1266
1267 struct req_format RQF_OST_CREATE =
1268         DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1269 EXPORT_SYMBOL(RQF_OST_CREATE);
1270
1271 struct req_format RQF_OST_PUNCH =
1272         DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1273 EXPORT_SYMBOL(RQF_OST_PUNCH);
1274
1275 struct req_format RQF_OST_SYNC =
1276         DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1277 EXPORT_SYMBOL(RQF_OST_SYNC);
1278
1279 struct req_format RQF_OST_DESTROY =
1280         DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1281 EXPORT_SYMBOL(RQF_OST_DESTROY);
1282
1283 struct req_format RQF_OST_BRW_READ =
1284         DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1285 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1286
1287 struct req_format RQF_OST_BRW_WRITE =
1288         DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1289 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1290
1291 struct req_format RQF_OST_STATFS =
1292         DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1293 EXPORT_SYMBOL(RQF_OST_STATFS);
1294
1295 struct req_format RQF_OST_SET_GRANT_INFO =
1296         DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1297                          ost_body_only);
1298 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1299
1300 struct req_format RQF_OST_GET_INFO_GENERIC =
1301         DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1302                                         ost_get_info_generic_server);
1303 EXPORT_SYMBOL(RQF_OST_GET_INFO_GENERIC);
1304
1305 struct req_format RQF_OST_GET_INFO_LAST_ID =
1306         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1307                                                 ost_get_last_id_server);
1308 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1309
1310 struct req_format RQF_OST_GET_INFO_FIEMAP =
1311         DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1312                                                ost_get_fiemap_server);
1313 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1314
1315
1316 #if !defined(__REQ_LAYOUT_USER__)
1317
1318 /* Convenience macro */
1319 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1320
1321 /**
1322  * Initializes the capsule abstraction by computing and setting the \a rf_idx
1323  * field of RQFs and the \a rmf_offset field of RMFs.
1324  */
1325 int req_layout_init(void)
1326 {
1327         int i;
1328         int j;
1329         int k;
1330         struct req_format *rf = NULL;
1331
1332         for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1333                 rf = req_formats[i];
1334                 rf->rf_idx = i;
1335                 for (j = 0; j < RCL_NR; ++j) {
1336                         LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1337                         for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1338                                 struct req_msg_field *field;
1339
1340                                 field = (typeof(field))rf->rf_fields[j].d[k];
1341                                 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1342                                         || field->rmf_size > 0);
1343                                 LASSERT(field->rmf_offset[i][j] == 0);
1344                                 /*
1345                                  * k + 1 to detect unused format/field
1346                                  * combinations.
1347                                  */
1348                                 field->rmf_offset[i][j] = k + 1;
1349                         }
1350                 }
1351         }
1352         return 0;
1353 }
1354 EXPORT_SYMBOL(req_layout_init);
1355
1356 void req_layout_fini(void)
1357 {
1358 }
1359 EXPORT_SYMBOL(req_layout_fini);
1360
1361 /**
1362  * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1363  *
1364  * Actual/expected field sizes are set elsewhere in functions in this file:
1365  * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1366  * req_capsule_msg_size().  The \a rc_area information is used by.
1367  * ptlrpc_request_set_replen().
1368  */
1369 void req_capsule_init_area(struct req_capsule *pill)
1370 {
1371         int i;
1372
1373         for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1374                 pill->rc_area[RCL_CLIENT][i] = -1;
1375                 pill->rc_area[RCL_SERVER][i] = -1;
1376         }
1377 }
1378 EXPORT_SYMBOL(req_capsule_init_area);
1379
1380 /**
1381  * Initialize a pill.
1382  *
1383  * The \a location indicates whether the caller is executing on the client side
1384  * (RCL_CLIENT) or server side (RCL_SERVER)..
1385  */
1386 void req_capsule_init(struct req_capsule *pill,
1387                       struct ptlrpc_request *req,
1388                       enum req_location location)
1389 {
1390         LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1391
1392         /*
1393          * Today all capsules are embedded in ptlrpc_request structs,
1394          * but just in case that ever isn't the case, we don't reach
1395          * into req unless req != NULL and pill is the one embedded in
1396          * the req.
1397          *
1398          * The req->rq_pill_init flag makes it safe to initialize a pill
1399          * twice, which might happen in the OST paths as a result of the
1400          * high-priority RPC queue getting peeked at before ost_handle()
1401          * handles an OST RPC.
1402          */
1403         if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1404                 return;
1405
1406         memset(pill, 0, sizeof *pill);
1407         pill->rc_req = req;
1408         pill->rc_loc = location;
1409         req_capsule_init_area(pill);
1410
1411         if (req != NULL && pill == &req->rq_pill)
1412                 req->rq_pill_init = 1;
1413 }
1414 EXPORT_SYMBOL(req_capsule_init);
1415
1416 void req_capsule_fini(struct req_capsule *pill)
1417 {
1418 }
1419 EXPORT_SYMBOL(req_capsule_fini);
1420
1421 static int __req_format_is_sane(const struct req_format *fmt)
1422 {
1423         return
1424                 0 <= fmt->rf_idx && fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1425                 req_formats[fmt->rf_idx] == fmt;
1426 }
1427
1428 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1429                                     enum req_location loc)
1430 {
1431         struct ptlrpc_request *req;
1432
1433         req = pill->rc_req;
1434         return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1435 }
1436
1437 /**
1438  * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1439  * (see req_capsule_extend()).
1440  */
1441 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1442 {
1443         LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1444         LASSERT(__req_format_is_sane(fmt));
1445
1446         pill->rc_fmt = fmt;
1447 }
1448 EXPORT_SYMBOL(req_capsule_set);
1449
1450 /**
1451  * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1452  * yet.
1453
1454  * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1455  * variable-sized fields.  The field sizes come from the declared \a rmf_size
1456  * field of a \a pill's \a rc_fmt's RMF's.
1457  */
1458 int req_capsule_filled_sizes(struct req_capsule *pill,
1459                            enum req_location loc)
1460 {
1461         const struct req_format *fmt = pill->rc_fmt;
1462         int                      i;
1463
1464         LASSERT(fmt != NULL);
1465
1466         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1467                 if (pill->rc_area[loc][i] == -1) {
1468                         pill->rc_area[loc][i] =
1469                                             fmt->rf_fields[loc].d[i]->rmf_size;
1470                         if (pill->rc_area[loc][i] == -1) {
1471                                 /*
1472                                  * Skip the following fields.
1473                                  *
1474                                  * If this LASSERT() trips then you're missing a
1475                                  * call to req_capsule_set_size().
1476                                  */
1477                                 LASSERT(loc != RCL_SERVER);
1478                                 break;
1479                         }
1480                 }
1481         }
1482         return i;
1483 }
1484 EXPORT_SYMBOL(req_capsule_filled_sizes);
1485
1486 /**
1487  * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1488  *
1489  * This function uses the \a pill's \a rc_area as filled in by
1490  * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1491  * this function).
1492  */
1493 int req_capsule_server_pack(struct req_capsule *pill)
1494 {
1495         const struct req_format *fmt;
1496         int                      count;
1497         int                      rc;
1498
1499         LASSERT(pill->rc_loc == RCL_SERVER);
1500         fmt = pill->rc_fmt;
1501         LASSERT(fmt != NULL);
1502
1503         count = req_capsule_filled_sizes(pill, RCL_SERVER);
1504         rc = lustre_pack_reply(pill->rc_req, count,
1505                                pill->rc_area[RCL_SERVER], NULL);
1506         if (rc != 0) {
1507                 DEBUG_REQ(D_ERROR, pill->rc_req,
1508                        "Cannot pack %d fields in format `%s': ",
1509                        count, fmt->rf_name);
1510         }
1511         return rc;
1512 }
1513 EXPORT_SYMBOL(req_capsule_server_pack);
1514
1515 /**
1516  * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1517  * corresponding to the given RMF (\a field).
1518  */
1519 static int __req_capsule_offset(const struct req_capsule *pill,
1520                                 const struct req_msg_field *field,
1521                                 enum req_location loc)
1522 {
1523         int offset;
1524
1525         offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1526         LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1527                             pill->rc_fmt->rf_name,
1528                             field->rmf_name, offset, loc);
1529         offset --;
1530
1531         LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1532         return offset;
1533 }
1534
1535 /**
1536  * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1537  * them if desired.
1538  */
1539 static
1540 void
1541 swabber_dumper_helper(struct req_capsule *pill,
1542                       const struct req_msg_field *field,
1543                       enum req_location loc,
1544                       int offset,
1545                       void *value, int len, int dump, void (*swabber)( void *))
1546 {
1547         void    *p;
1548         int     i;
1549         int     n;
1550         int     do_swab;
1551         int     inout = loc == RCL_CLIENT;
1552
1553         swabber = swabber ?: field->rmf_swabber;
1554
1555         if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1556             swabber != NULL && value != NULL)
1557                 do_swab = 1;
1558         else
1559                 do_swab = 0;
1560
1561         if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1562                 if (dump && field->rmf_dumper) {
1563                         CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1564                                do_swab ? "unswabbed " : "", field->rmf_name);
1565                         field->rmf_dumper(value);
1566                 }
1567                 if (!do_swab)
1568                         return;
1569                 swabber(value);
1570                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1571                 if (dump) {
1572                         CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1573                                "follows\n", field->rmf_name);
1574                         field->rmf_dumper(value);
1575                 }
1576
1577                 return;
1578         }
1579
1580         /*
1581          * We're swabbing an array; swabber() swabs a single array element, so
1582          * swab every element.
1583          */
1584         LASSERT((len % field->rmf_size) == 0);
1585         for (p = value, i = 0, n = len / field->rmf_size;
1586              i < n;
1587              i++, p += field->rmf_size) {
1588                 if (dump && field->rmf_dumper) {
1589                         CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1590                                "element %d follows\n",
1591                                do_swab ? "unswabbed " : "", field->rmf_name, i);
1592                         field->rmf_dumper(p);
1593                 }
1594                 if (!do_swab)
1595                         continue;
1596                 swabber(p);
1597                 if (dump && field->rmf_dumper) {
1598                         CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1599                                "element %d follows\n", field->rmf_name, i);
1600                         field->rmf_dumper(value);
1601                 }
1602         }
1603         if (do_swab)
1604                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1605 }
1606
1607 /**
1608  * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
1609  * corresponding to the given RMF (\a field).
1610  *
1611  * The buffer will be swabbed using the given \a swabber.  If \a swabber == NULL
1612  * then the \a rmf_swabber from the RMF will be used.  Soon there will be no
1613  * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
1614  * be removed.  Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
1615  * element of the array swabbed.
1616  */
1617 static void *__req_capsule_get(struct req_capsule *pill,
1618                                const struct req_msg_field *field,
1619                                enum req_location loc,
1620                                void (*swabber)( void *),
1621                                int dump)
1622 {
1623         const struct req_format *fmt;
1624         struct lustre_msg       *msg;
1625         void                    *value;
1626         int                      len;
1627         int                      offset;
1628
1629         void *(*getter)(struct lustre_msg *m, int n, int minlen);
1630
1631         static const char *rcl_names[RCL_NR] = {
1632                 [RCL_CLIENT] = "client",
1633                 [RCL_SERVER] = "server"
1634         };
1635
1636         LASSERT(pill != NULL);
1637         LASSERT(pill != LP_POISON);
1638         fmt = pill->rc_fmt;
1639         LASSERT(fmt != NULL);
1640         LASSERT(fmt != LP_POISON);
1641         LASSERT(__req_format_is_sane(fmt));
1642
1643         offset = __req_capsule_offset(pill, field, loc);
1644
1645         msg = __req_msg(pill, loc);
1646         LASSERT(msg != NULL);
1647
1648         getter = (field->rmf_flags & RMF_F_STRING) ?
1649                 (typeof(getter))lustre_msg_string : lustre_msg_buf;
1650
1651         if (field->rmf_flags & RMF_F_STRUCT_ARRAY) {
1652                 /*
1653                  * We've already asserted that field->rmf_size > 0 in
1654                  * req_layout_init().
1655                  */
1656                 len = lustre_msg_buflen(msg, offset);
1657                 if ((len % field->rmf_size) != 0) {
1658                         CERROR("%s: array field size mismatch "
1659                                "%d modulo %d != 0 (%d)\n",
1660                                field->rmf_name, len, field->rmf_size, loc);
1661                         return NULL;
1662                 }
1663         } else if (pill->rc_area[loc][offset] != -1) {
1664                 len = pill->rc_area[loc][offset];
1665         } else {
1666                 len = max(field->rmf_size, 0);
1667         }
1668         value = getter(msg, offset, len);
1669
1670         if (value == NULL) {
1671                 DEBUG_REQ(D_ERROR, pill->rc_req,
1672                           "Wrong buffer for field `%s' (%d of %d) "
1673                           "in format `%s': %d vs. %d (%s)\n",
1674                           field->rmf_name, offset, lustre_msg_bufcount(msg),
1675                           fmt->rf_name, lustre_msg_buflen(msg, offset), len,
1676                           rcl_names[loc]);
1677         } else {
1678                 swabber_dumper_helper(pill, field, loc, offset, value, len,
1679                                       dump, swabber);
1680         }
1681
1682         return value;
1683 }
1684
1685 /**
1686  * Dump a request and/or reply
1687  */
1688 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
1689 {
1690         const struct    req_format *fmt;
1691         const struct    req_msg_field *field;
1692         int             len;
1693         int             i;
1694
1695         fmt = pill->rc_fmt;
1696
1697         DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
1698         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1699                 field = FMT_FIELD(fmt, loc, i);
1700                 if (field->rmf_dumper == NULL) {
1701                         /*
1702                          * FIXME Add a default hex dumper for fields that don't
1703                          * have a specific dumper
1704                          */
1705                         len = req_capsule_get_size(pill, field, loc);
1706                         CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
1707                                "field size is %d\n", field->rmf_name, len);
1708                 } else {
1709                         /* It's the dumping side-effect that we're interested in */
1710                         (void) __req_capsule_get(pill, field, loc, NULL, 1);
1711                 }
1712         }
1713         CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
1714 }
1715
1716 /**
1717  * Dump a request.
1718  */
1719 void req_capsule_client_dump(struct req_capsule *pill)
1720 {
1721         __req_capsule_dump(pill, RCL_CLIENT);
1722 }
1723 EXPORT_SYMBOL(req_capsule_client_dump);
1724
1725 /**
1726  * Dump a reply
1727  */
1728 void req_capsule_server_dump(struct req_capsule *pill)
1729 {
1730         __req_capsule_dump(pill, RCL_SERVER);
1731 }
1732 EXPORT_SYMBOL(req_capsule_server_dump);
1733
1734 /**
1735  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
1736  * buffer corresponding to the given RMF (\a field) of a \a pill.
1737  */
1738 void *req_capsule_client_get(struct req_capsule *pill,
1739                              const struct req_msg_field *field)
1740 {
1741         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1742 }
1743 EXPORT_SYMBOL(req_capsule_client_get);
1744
1745 /**
1746  * Same as req_capsule_client_get(), but with a \a swabber argument.
1747  *
1748  * Currently unused; will be removed when req_capsule_server_swab_get() is
1749  * unused too.
1750  */
1751 void *req_capsule_client_swab_get(struct req_capsule *pill,
1752                                   const struct req_msg_field *field,
1753                                   void (*swabber)(void* ))
1754 {
1755         return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
1756 }
1757 EXPORT_SYMBOL(req_capsule_client_swab_get);
1758
1759 /**
1760  * Utility that combines req_capsule_set_size() and req_capsule_client_get().
1761  *
1762  * First the \a pill's request \a field's size is set (\a rc_area) using
1763  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
1764  * returned.
1765  */
1766 void *req_capsule_client_sized_get(struct req_capsule *pill,
1767                                    const struct req_msg_field *field,
1768                                    int len)
1769 {
1770         req_capsule_set_size(pill, field, RCL_CLIENT, len);
1771         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
1772 }
1773 EXPORT_SYMBOL(req_capsule_client_sized_get);
1774
1775 /**
1776  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
1777  * buffer corresponding to the given RMF (\a field) of a \a pill.
1778  */
1779 void *req_capsule_server_get(struct req_capsule *pill,
1780                              const struct req_msg_field *field)
1781 {
1782         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1783 }
1784 EXPORT_SYMBOL(req_capsule_server_get);
1785
1786 /**
1787  * Same as req_capsule_server_get(), but with a \a swabber argument.
1788  *
1789  * Ideally all swabbing should be done pursuant to RMF definitions, with no
1790  * swabbing done outside this capsule abstraction.
1791  */
1792 void *req_capsule_server_swab_get(struct req_capsule *pill,
1793                                   const struct req_msg_field *field,
1794                                   void *swabber)
1795 {
1796         return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
1797 }
1798 EXPORT_SYMBOL(req_capsule_server_swab_get);
1799
1800 /**
1801  * Utility that combines req_capsule_set_size() and req_capsule_server_get().
1802  *
1803  * First the \a pill's request \a field's size is set (\a rc_area) using
1804  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
1805  * returned.
1806  */
1807 void *req_capsule_server_sized_get(struct req_capsule *pill,
1808                                    const struct req_msg_field *field,
1809                                    int len)
1810 {
1811         req_capsule_set_size(pill, field, RCL_SERVER, len);
1812         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
1813 }
1814 EXPORT_SYMBOL(req_capsule_server_sized_get);
1815
1816 /**
1817  * Returns the buffer of a \a pill corresponding to the given \a field from the
1818  * request (if the caller is executing on the server-side) or reply (if the
1819  * caller is executing on the client-side).
1820  *
1821  * This function convienient for use is code that could be executed on the
1822  * client and server alike.
1823  */
1824 const void *req_capsule_other_get(struct req_capsule *pill,
1825                                   const struct req_msg_field *field)
1826 {
1827         return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
1828 }
1829 EXPORT_SYMBOL(req_capsule_other_get);
1830
1831 /**
1832  * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
1833  * field of the given \a pill.
1834  *
1835  * This function must be used when constructing variable sized fields of a
1836  * request or reply.
1837  */
1838 void req_capsule_set_size(struct req_capsule *pill,
1839                           const struct req_msg_field *field,
1840                           enum req_location loc, int size)
1841 {
1842         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1843
1844         if ((size != field->rmf_size) &&
1845             (field->rmf_size != -1) &&
1846             !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
1847             (size > 0)) {
1848                 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1849                     (size % field->rmf_size != 0)) {
1850                         CERROR("%s: array field size mismatch "
1851                                "%d %% %d != 0 (%d)\n",
1852                                field->rmf_name, size, field->rmf_size, loc);
1853                         LBUG();
1854                 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
1855                     size < field->rmf_size) {
1856                         CERROR("%s: field size mismatch %d != %d (%d)\n",
1857                                field->rmf_name, size, field->rmf_size, loc);
1858                         LBUG();
1859                 }
1860         }
1861
1862         pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
1863 }
1864 EXPORT_SYMBOL(req_capsule_set_size);
1865
1866 /**
1867  * Return the actual PTLRPC buffer length of a request or reply (\a loc)
1868  * for the given \a pill's given \a field.
1869  *
1870  * NB: this function doesn't correspond with req_capsule_set_size(), which
1871  * actually sets the size in pill.rc_area[loc][offset], but this function
1872  * returns the message buflen[offset], maybe we should use another name.
1873  */
1874 int req_capsule_get_size(const struct req_capsule *pill,
1875                          const struct req_msg_field *field,
1876                          enum req_location loc)
1877 {
1878         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1879
1880         return lustre_msg_buflen(__req_msg(pill, loc),
1881                                  __req_capsule_offset(pill, field, loc));
1882 }
1883 EXPORT_SYMBOL(req_capsule_get_size);
1884
1885 /**
1886  * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
1887  * given \a pill's request or reply (\a loc) given the field size recorded in
1888  * the \a pill's rc_area.
1889  *
1890  * See also req_capsule_set_size().
1891  */
1892 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
1893 {
1894         return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
1895                                pill->rc_fmt->rf_fields[loc].nr,
1896                                pill->rc_area[loc]);
1897 }
1898
1899 /**
1900  * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
1901  * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
1902  * PTLRPC request or reply given only an RQF (\a fmt).
1903  *
1904  * This function should not be used for formats which contain variable size
1905  * fields.
1906  */
1907 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
1908                          enum req_location loc)
1909 {
1910         int size, i = 0;
1911
1912         /*
1913          * This function should probably LASSERT() that fmt has no fields with
1914          * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
1915          * elements in the array there will ultimately be, but then, we could
1916          * assume that there will be at least one element, and that's just what
1917          * we do.
1918          */
1919         size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
1920         if (size < 0)
1921                 return size;
1922
1923         for (; i < fmt->rf_fields[loc].nr; ++i)
1924                 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
1925                         size += cfs_size_round(fmt->rf_fields[loc].d[i]->
1926                                                rmf_size);
1927         return size;
1928 }
1929
1930 /**
1931  * Changes the format of an RPC.
1932  *
1933  * The pill must already have been initialized, which means that it already has
1934  * a request format.  The new format \a fmt must be an extension of the pill's
1935  * old format.  Specifically: the new format must have as many request and reply
1936  * fields as the old one, and all fields shared by the old and new format must
1937  * be at least as large in the new format.
1938  *
1939  * The new format's fields may be of different "type" than the old format, but
1940  * only for fields that are "opaque" blobs: fields which have a) have no
1941  * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
1942  * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK.  For example,
1943  * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
1944  * according to the key field.  When the value, according to the key, contains a
1945  * structure (or array thereof) to be swabbed, the format should be changed to
1946  * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
1947  * accordingly.
1948  */
1949 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
1950 {
1951         int i;
1952         int j;
1953
1954         const struct req_format *old;
1955
1956         LASSERT(pill->rc_fmt != NULL);
1957         LASSERT(__req_format_is_sane(fmt));
1958
1959         old = pill->rc_fmt;
1960         /*
1961          * Sanity checking...
1962          */
1963         for (i = 0; i < RCL_NR; ++i) {
1964                 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
1965                 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
1966                         const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
1967
1968                         /* "opaque" fields can be transmogrified */
1969                         if (ofield->rmf_swabber == NULL &&
1970                             (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
1971                             (ofield->rmf_size == -1 ||
1972                             ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
1973                                 continue;
1974                         LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
1975                 }
1976                 /*
1977                  * Last field in old format can be shorter than in new.
1978                  */
1979                 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
1980                         FMT_FIELD(old, i, j)->rmf_size);
1981         }
1982
1983         pill->rc_fmt = fmt;
1984 }
1985 EXPORT_SYMBOL(req_capsule_extend);
1986
1987 /**
1988  * This function returns a non-zero value if the given \a field is present in
1989  * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
1990  * returns 0.
1991  */
1992 int req_capsule_has_field(const struct req_capsule *pill,
1993                           const struct req_msg_field *field,
1994                           enum req_location loc)
1995 {
1996         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
1997
1998         return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1999 }
2000 EXPORT_SYMBOL(req_capsule_has_field);
2001
2002 /**
2003  * Returns a non-zero value if the given \a field is present in the given \a
2004  * pill's PTLRPC request or reply (\a loc), else it returns 0.
2005  */
2006 int req_capsule_field_present(const struct req_capsule *pill,
2007                               const struct req_msg_field *field,
2008                               enum req_location loc)
2009 {
2010         int offset;
2011
2012         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2013         LASSERT(req_capsule_has_field(pill, field, loc));
2014
2015         offset = __req_capsule_offset(pill, field, loc);
2016         return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2017 }
2018 EXPORT_SYMBOL(req_capsule_field_present);
2019
2020 /**
2021  * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2022  * request or reply (\a loc).
2023  *
2024  * This is not the opposite of req_capsule_extend().
2025  */
2026 void req_capsule_shrink(struct req_capsule *pill,
2027                         const struct req_msg_field *field,
2028                         unsigned int newlen,
2029                         enum req_location loc)
2030 {
2031         const struct req_format *fmt;
2032         struct lustre_msg       *msg;
2033         int                      len;
2034         int                      offset;
2035
2036         fmt = pill->rc_fmt;
2037         LASSERT(fmt != NULL);
2038         LASSERT(__req_format_is_sane(fmt));
2039         LASSERT(req_capsule_has_field(pill, field, loc));
2040         LASSERT(req_capsule_field_present(pill, field, loc));
2041
2042         offset = __req_capsule_offset(pill, field, loc);
2043
2044         msg = __req_msg(pill, loc);
2045         len = lustre_msg_buflen(msg, offset);
2046         LASSERTF(newlen <= len, "%s:%s, oldlen=%d, newlen=%d\n",
2047                                 fmt->rf_name, field->rmf_name, len, newlen);
2048
2049         if (loc == RCL_CLIENT)
2050                 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2051                                                             1);
2052         else
2053                 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2054                                                             1);
2055 }
2056 EXPORT_SYMBOL(req_capsule_shrink);
2057
2058 /* __REQ_LAYOUT_USER__ */
2059 #endif