lustre/ptlrpc/layout.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/ptlrpc/layout.c
  33  *
  34  * Lustre Metadata Target (mdt) request handler
  35  *
  36  * Author: Nikita Danilov <nikita@clusterfs.com>
  37  */
  38 /*
  39  * This file contains the "capsule/pill" abstraction layered above PTLRPC.
  40  *
  41  * Every struct ptlrpc_request contains a "pill", which points to a description
  42  * of the format that the request conforms to.
  43  */
  44
  45 #if !defined(__REQ_LAYOUT_USER__)
  46
  47 #define DEBUG_SUBSYSTEM S_RPC
  48
  49 #include <linux/module.h>
  50
  51 #include <lustre/lustre_idl.h>
  52
  53 #include <llog_swab.h>
  54 #include <lustre_debug.h>
  55 #include <lustre_swab.h>
  56 #include <lustre_ver.h>
  57 #include <obd.h>
  58 #include <obd_support.h>
  59 #endif /* !__REQ_LAYOUT_USER__ */
  60
  61 /* struct ptlrpc_request, lustre_msg* */
  62 #include <lustre_req_layout.h>
  63 #include <lustre_acl.h>
  64
  65 /*
  66  * RQFs (see below) refer to two struct req_msg_field arrays describing the
  67  * client request and server reply, respectively.
  68  */
  69 /* empty set of fields... for suitable definition of emptiness. */
  70 static const struct req_msg_field *empty[] = {
  71         &RMF_PTLRPC_BODY
  72 };
  73
  74 static const struct req_msg_field *mgs_target_info_only[] = {
  75         &RMF_PTLRPC_BODY,
  76         &RMF_MGS_TARGET_INFO
  77 };
  78
  79 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
  80 static const struct req_msg_field *mgs_set_info[] = {
  81         &RMF_PTLRPC_BODY,
  82         &RMF_MGS_SEND_PARAM
  83 };
  84 #endif
  85
  86 static const struct req_msg_field *mgs_config_read_client[] = {
  87         &RMF_PTLRPC_BODY,
  88         &RMF_MGS_CONFIG_BODY
  89 };
  90
  91 static const struct req_msg_field *mgs_config_read_server[] = {
  92         &RMF_PTLRPC_BODY,
  93         &RMF_MGS_CONFIG_RES
  94 };
  95
  96 static const struct req_msg_field *log_cancel_client[] = {
  97         &RMF_PTLRPC_BODY,
  98         &RMF_LOGCOOKIES
  99 };
 100
 101 static const struct req_msg_field *mdt_body_only[] = {
 102         &RMF_PTLRPC_BODY,
 103         &RMF_MDT_BODY
 104 };
 105
 106 static const struct req_msg_field *mdt_body_capa[] = {
 107         &RMF_PTLRPC_BODY,
 108         &RMF_MDT_BODY,
 109         &RMF_CAPA1
 110 };
 111
 112 static const struct req_msg_field *quotactl_only[] = {
 113         &RMF_PTLRPC_BODY,
 114         &RMF_OBD_QUOTACTL
 115 };
 116
 117 static const struct req_msg_field *quota_body_only[] = {
 118         &RMF_PTLRPC_BODY,
 119         &RMF_QUOTA_BODY
 120 };
 121
 122 static const struct req_msg_field *ldlm_intent_quota_client[] = {
 123         &RMF_PTLRPC_BODY,
 124         &RMF_DLM_REQ,
 125         &RMF_LDLM_INTENT,
 126         &RMF_QUOTA_BODY
 127 };
 128
 129 static const struct req_msg_field *ldlm_intent_quota_server[] = {
 130         &RMF_PTLRPC_BODY,
 131         &RMF_DLM_REP,
 132         &RMF_DLM_LVB,
 133         &RMF_QUOTA_BODY
 134 };
 135
 136 static const struct req_msg_field *mdt_close_client[] = {
 137         &RMF_PTLRPC_BODY,
 138         &RMF_MDT_EPOCH,
 139         &RMF_REC_REINT,
 140         &RMF_CAPA1
 141 };
 142
 143 static const struct req_msg_field *mdt_intent_close_client[] = {
 144         &RMF_PTLRPC_BODY,
 145         &RMF_MDT_EPOCH,
 146         &RMF_REC_REINT,
 147         &RMF_CAPA1,
 148         &RMF_CLOSE_DATA
 149 };
 150
 151 static const struct req_msg_field *obd_statfs_server[] = {
 152         &RMF_PTLRPC_BODY,
 153         &RMF_OBD_STATFS
 154 };
 155
 156 static const struct req_msg_field *seq_query_client[] = {
 157         &RMF_PTLRPC_BODY,
 158         &RMF_SEQ_OPC,
 159         &RMF_SEQ_RANGE
 160 };
 161
 162 static const struct req_msg_field *seq_query_server[] = {
 163         &RMF_PTLRPC_BODY,
 164         &RMF_SEQ_RANGE
 165 };
 166
 167 static const struct req_msg_field *fld_query_client[] = {
 168         &RMF_PTLRPC_BODY,
 169         &RMF_FLD_OPC,
 170         &RMF_FLD_MDFLD
 171 };
 172
 173 static const struct req_msg_field *fld_query_server[] = {
 174         &RMF_PTLRPC_BODY,
 175         &RMF_FLD_MDFLD
 176 };
 177
 178 static const struct req_msg_field *fld_read_client[] = {
 179         &RMF_PTLRPC_BODY,
 180         &RMF_FLD_MDFLD
 181 };
 182
 183 static const struct req_msg_field *fld_read_server[] = {
 184         &RMF_PTLRPC_BODY,
 185         &RMF_GENERIC_DATA
 186 };
 187
 188 static const struct req_msg_field *mds_getattr_name_client[] = {
 189         &RMF_PTLRPC_BODY,
 190         &RMF_MDT_BODY,
 191         &RMF_CAPA1,
 192         &RMF_NAME
 193 };
 194
 195 static const struct req_msg_field *mds_reint_client[] = {
 196         &RMF_PTLRPC_BODY,
 197         &RMF_REC_REINT
 198 };
 199
 200 static const struct req_msg_field *mds_reint_create_client[] = {
 201         &RMF_PTLRPC_BODY,
 202         &RMF_REC_REINT,
 203         &RMF_CAPA1,
 204         &RMF_NAME
 205 };
 206
 207 static const struct req_msg_field *mds_reint_create_slave_client[] = {
 208         &RMF_PTLRPC_BODY,
 209         &RMF_REC_REINT,
 210         &RMF_CAPA1,
 211         &RMF_NAME,
 212         &RMF_EADATA,
 213         &RMF_DLM_REQ
 214 };
 215
 216 static const struct req_msg_field *mds_reint_create_acl_client[] = {
 217         &RMF_PTLRPC_BODY,
 218         &RMF_REC_REINT,
 219         &RMF_CAPA1,
 220         &RMF_NAME,
 221         &RMF_EADATA,
 222         &RMF_DLM_REQ,
 223         &RMF_FILE_SECCTX_NAME,
 224         &RMF_FILE_SECCTX
 225 };
 226
 227 static const struct req_msg_field *mds_reint_create_sym_client[] = {
 228         &RMF_PTLRPC_BODY,
 229         &RMF_REC_REINT,
 230         &RMF_CAPA1,
 231         &RMF_NAME,
 232         &RMF_SYMTGT,
 233         &RMF_DLM_REQ,
 234         &RMF_FILE_SECCTX_NAME,
 235         &RMF_FILE_SECCTX
 236 };
 237
 238 static const struct req_msg_field *mds_reint_open_client[] = {
 239         &RMF_PTLRPC_BODY,
 240         &RMF_REC_REINT,
 241         &RMF_CAPA1,
 242         &RMF_CAPA2,
 243         &RMF_NAME,
 244         &RMF_EADATA,
 245         &RMF_FILE_SECCTX_NAME,
 246         &RMF_FILE_SECCTX
 247 };
 248
 249 static const struct req_msg_field *mds_reint_open_server[] = {
 250         &RMF_PTLRPC_BODY,
 251         &RMF_MDT_BODY,
 252         &RMF_MDT_MD,
 253         &RMF_ACL,
 254         &RMF_CAPA1,
 255         &RMF_CAPA2
 256 };
 257
 258 static const struct req_msg_field *mds_reint_unlink_client[] = {
 259         &RMF_PTLRPC_BODY,
 260         &RMF_REC_REINT,
 261         &RMF_CAPA1,
 262         &RMF_NAME,
 263         &RMF_DLM_REQ
 264 };
 265
 266 static const struct req_msg_field *mds_reint_link_client[] = {
 267         &RMF_PTLRPC_BODY,
 268         &RMF_REC_REINT,
 269         &RMF_CAPA1,
 270         &RMF_CAPA2,
 271         &RMF_NAME,
 272         &RMF_DLM_REQ
 273 };
 274
 275 static const struct req_msg_field *mds_reint_rename_client[] = {
 276         &RMF_PTLRPC_BODY,
 277         &RMF_REC_REINT,
 278         &RMF_CAPA1,
 279         &RMF_CAPA2,
 280         &RMF_NAME,
 281         &RMF_SYMTGT,
 282         &RMF_DLM_REQ
 283 };
 284
 285 static const struct req_msg_field *mds_reint_migrate_client[] = {
 286         &RMF_PTLRPC_BODY,
 287         &RMF_REC_REINT,
 288         &RMF_CAPA1,
 289         &RMF_CAPA2,
 290         &RMF_NAME,
 291         &RMF_SYMTGT,
 292         &RMF_DLM_REQ,
 293         &RMF_MDT_EPOCH,
 294         &RMF_CLOSE_DATA
 295 };
 296
 297 static const struct req_msg_field *mds_last_unlink_server[] = {
 298         &RMF_PTLRPC_BODY,
 299         &RMF_MDT_BODY,
 300         &RMF_MDT_MD,
 301         &RMF_LOGCOOKIES,
 302         &RMF_CAPA1,
 303         &RMF_CAPA2
 304 };
 305
 306 static const struct req_msg_field *mds_reint_setattr_client[] = {
 307         &RMF_PTLRPC_BODY,
 308         &RMF_REC_REINT,
 309         &RMF_CAPA1,
 310         &RMF_MDT_EPOCH,
 311         &RMF_EADATA,
 312         &RMF_LOGCOOKIES,
 313         &RMF_DLM_REQ
 314 };
 315
 316 static const struct req_msg_field *mds_reint_setxattr_client[] = {
 317         &RMF_PTLRPC_BODY,
 318         &RMF_REC_REINT,
 319         &RMF_CAPA1,
 320         &RMF_NAME,
 321         &RMF_EADATA,
 322         &RMF_DLM_REQ
 323 };
 324
 325 static const struct req_msg_field *mdt_swap_layouts[] = {
 326         &RMF_PTLRPC_BODY,
 327         &RMF_MDT_BODY,
 328         &RMF_SWAP_LAYOUTS,
 329         &RMF_CAPA1,
 330         &RMF_CAPA2,
 331         &RMF_DLM_REQ
 332 };
 333
 334 static const struct req_msg_field *obd_connect_client[] = {
 335         &RMF_PTLRPC_BODY,
 336         &RMF_TGTUUID,
 337         &RMF_CLUUID,
 338         &RMF_CONN,
 339         &RMF_CONNECT_DATA
 340 };
 341
 342 static const struct req_msg_field *obd_connect_server[] = {
 343         &RMF_PTLRPC_BODY,
 344         &RMF_CONNECT_DATA
 345 };
 346
 347 static const struct req_msg_field *obd_set_info_client[] = {
 348         &RMF_PTLRPC_BODY,
 349         &RMF_SETINFO_KEY,
 350         &RMF_SETINFO_VAL
 351 };
 352
 353 static const struct req_msg_field *ost_grant_shrink_client[] = {
 354         &RMF_PTLRPC_BODY,
 355         &RMF_SETINFO_KEY,
 356         &RMF_OST_BODY
 357 };
 358
 359 static const struct req_msg_field *mds_getinfo_client[] = {
 360         &RMF_PTLRPC_BODY,
 361         &RMF_GETINFO_KEY,
 362         &RMF_GETINFO_VALLEN
 363 };
 364
 365 static const struct req_msg_field *mds_getinfo_server[] = {
 366         &RMF_PTLRPC_BODY,
 367         &RMF_GETINFO_VAL,
 368 };
 369
 370 static const struct req_msg_field *ldlm_enqueue_client[] = {
 371         &RMF_PTLRPC_BODY,
 372         &RMF_DLM_REQ
 373 };
 374
 375 static const struct req_msg_field *ldlm_enqueue_server[] = {
 376         &RMF_PTLRPC_BODY,
 377         &RMF_DLM_REP
 378 };
 379
 380 static const struct req_msg_field *ldlm_enqueue_lvb_server[] = {
 381         &RMF_PTLRPC_BODY,
 382         &RMF_DLM_REP,
 383         &RMF_DLM_LVB
 384 };
 385
 386 static const struct req_msg_field *ldlm_cp_callback_client[] = {
 387         &RMF_PTLRPC_BODY,
 388         &RMF_DLM_REQ,
 389         &RMF_DLM_LVB
 390 };
 391
 392 static const struct req_msg_field *ldlm_gl_callback_desc_client[] = {
 393         &RMF_PTLRPC_BODY,
 394         &RMF_DLM_REQ,
 395         &RMF_DLM_GL_DESC
 396 };
 397
 398 static const struct req_msg_field *ldlm_gl_callback_server[] = {
 399         &RMF_PTLRPC_BODY,
 400         &RMF_DLM_LVB
 401 };
 402
 403 static const struct req_msg_field *ldlm_intent_basic_client[] = {
 404         &RMF_PTLRPC_BODY,
 405         &RMF_DLM_REQ,
 406         &RMF_LDLM_INTENT,
 407 };
 408
 409 static const struct req_msg_field *ldlm_intent_client[] = {
 410         &RMF_PTLRPC_BODY,
 411         &RMF_DLM_REQ,
 412         &RMF_LDLM_INTENT,
 413         &RMF_REC_REINT
 414 };
 415
 416 static const struct req_msg_field *ldlm_intent_server[] = {
 417         &RMF_PTLRPC_BODY,
 418         &RMF_DLM_REP,
 419         &RMF_MDT_BODY,
 420         &RMF_MDT_MD,
 421         &RMF_ACL
 422 };
 423
 424 static const struct req_msg_field *ldlm_intent_layout_client[] = {
 425         &RMF_PTLRPC_BODY,
 426         &RMF_DLM_REQ,
 427         &RMF_LDLM_INTENT,
 428         &RMF_LAYOUT_INTENT,
 429         &RMF_EADATA /* for new layout to be set up */
 430 };
 431 static const struct req_msg_field *ldlm_intent_open_server[] = {
 432         &RMF_PTLRPC_BODY,
 433         &RMF_DLM_REP,
 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 *ldlm_intent_getattr_client[] = {
 442         &RMF_PTLRPC_BODY,
 443         &RMF_DLM_REQ,
 444         &RMF_LDLM_INTENT,
 445         &RMF_MDT_BODY,     /* coincides with mds_getattr_name_client[] */
 446         &RMF_CAPA1,
 447         &RMF_NAME
 448 };
 449
 450 static const struct req_msg_field *ldlm_intent_getattr_server[] = {
 451         &RMF_PTLRPC_BODY,
 452         &RMF_DLM_REP,
 453         &RMF_MDT_BODY,
 454         &RMF_MDT_MD,
 455         &RMF_ACL,
 456         &RMF_CAPA1
 457 };
 458
 459 static const struct req_msg_field *ldlm_intent_create_client[] = {
 460         &RMF_PTLRPC_BODY,
 461         &RMF_DLM_REQ,
 462         &RMF_LDLM_INTENT,
 463         &RMF_REC_REINT,    /* coincides with mds_reint_create_client[] */
 464         &RMF_CAPA1,
 465         &RMF_NAME,
 466         &RMF_EADATA,
 467         &RMF_FILE_SECCTX_NAME,
 468         &RMF_FILE_SECCTX
 469 };
 470
 471 static const struct req_msg_field *ldlm_intent_open_client[] = {
 472         &RMF_PTLRPC_BODY,
 473         &RMF_DLM_REQ,
 474         &RMF_LDLM_INTENT,
 475         &RMF_REC_REINT,    /* coincides with mds_reint_open_client[] */
 476         &RMF_CAPA1,
 477         &RMF_CAPA2,
 478         &RMF_NAME,
 479         &RMF_EADATA,
 480         &RMF_FILE_SECCTX_NAME,
 481         &RMF_FILE_SECCTX
 482 };
 483
 484 static const struct req_msg_field *ldlm_intent_unlink_client[] = {
 485         &RMF_PTLRPC_BODY,
 486         &RMF_DLM_REQ,
 487         &RMF_LDLM_INTENT,
 488         &RMF_REC_REINT,    /* coincides with mds_reint_unlink_client[] */
 489         &RMF_CAPA1,
 490         &RMF_NAME
 491 };
 492
 493 static const struct req_msg_field *ldlm_intent_getxattr_client[] = {
 494         &RMF_PTLRPC_BODY,
 495         &RMF_DLM_REQ,
 496         &RMF_LDLM_INTENT,
 497         &RMF_MDT_BODY,
 498         &RMF_CAPA1,
 499 };
 500
 501 static const struct req_msg_field *ldlm_intent_getxattr_server[] = {
 502         &RMF_PTLRPC_BODY,
 503         &RMF_DLM_REP,
 504         &RMF_MDT_BODY,
 505         &RMF_MDT_MD,
 506         &RMF_ACL, /* for req_capsule_extend/mdt_intent_policy */
 507         &RMF_EADATA,
 508         &RMF_EAVALS,
 509         &RMF_EAVALS_LENS
 510 };
 511
 512 static const struct req_msg_field *mds_get_root_client[] = {
 513         &RMF_PTLRPC_BODY,
 514         &RMF_MDT_BODY,
 515         &RMF_NAME
 516 };
 517
 518 static const struct req_msg_field *mds_getxattr_client[] = {
 519         &RMF_PTLRPC_BODY,
 520         &RMF_MDT_BODY,
 521         &RMF_CAPA1,
 522         &RMF_NAME,
 523         &RMF_EADATA
 524 };
 525
 526 static const struct req_msg_field *mds_getxattr_server[] = {
 527         &RMF_PTLRPC_BODY,
 528         &RMF_MDT_BODY,
 529         &RMF_EADATA
 530 };
 531
 532 static const struct req_msg_field *mds_getattr_server[] = {
 533         &RMF_PTLRPC_BODY,
 534         &RMF_MDT_BODY,
 535         &RMF_MDT_MD,
 536         &RMF_ACL,
 537         &RMF_CAPA1,
 538         &RMF_CAPA2
 539 };
 540
 541 static const struct req_msg_field *mds_setattr_server[] = {
 542         &RMF_PTLRPC_BODY,
 543         &RMF_MDT_BODY,
 544         &RMF_MDT_MD,
 545         &RMF_ACL,
 546         &RMF_CAPA1,
 547         &RMF_CAPA2
 548 };
 549
 550 static const struct req_msg_field *mds_update_client[] = {
 551         &RMF_PTLRPC_BODY,
 552         &RMF_OUT_UPDATE_HEADER,
 553         &RMF_OUT_UPDATE_BUF,
 554 };
 555
 556 static const struct req_msg_field *mds_update_server[] = {
 557         &RMF_PTLRPC_BODY,
 558         &RMF_OUT_UPDATE_REPLY,
 559 };
 560
 561 static const struct req_msg_field *llog_origin_handle_create_client[] = {
 562         &RMF_PTLRPC_BODY,
 563         &RMF_LLOGD_BODY,
 564         &RMF_NAME
 565 };
 566
 567 static const struct req_msg_field *llogd_body_only[] = {
 568         &RMF_PTLRPC_BODY,
 569         &RMF_LLOGD_BODY
 570 };
 571
 572 static const struct req_msg_field *llog_log_hdr_only[] = {
 573         &RMF_PTLRPC_BODY,
 574         &RMF_LLOG_LOG_HDR
 575 };
 576
 577 static const struct req_msg_field *llogd_conn_body_only[] = {
 578         &RMF_PTLRPC_BODY,
 579         &RMF_LLOGD_CONN_BODY
 580 };
 581
 582 static const struct req_msg_field *llog_origin_handle_next_block_server[] = {
 583         &RMF_PTLRPC_BODY,
 584         &RMF_LLOGD_BODY,
 585         &RMF_EADATA
 586 };
 587
 588 static const struct req_msg_field *obd_idx_read_client[] = {
 589         &RMF_PTLRPC_BODY,
 590         &RMF_IDX_INFO
 591 };
 592
 593 static const struct req_msg_field *obd_idx_read_server[] = {
 594         &RMF_PTLRPC_BODY,
 595         &RMF_IDX_INFO
 596 };
 597
 598 static const struct req_msg_field *ost_body_only[] = {
 599         &RMF_PTLRPC_BODY,
 600         &RMF_OST_BODY
 601 };
 602
 603 static const struct req_msg_field *ost_body_capa[] = {
 604         &RMF_PTLRPC_BODY,
 605         &RMF_OST_BODY,
 606         &RMF_CAPA1
 607 };
 608
 609 static const struct req_msg_field *ost_destroy_client[] = {
 610         &RMF_PTLRPC_BODY,
 611         &RMF_OST_BODY,
 612         &RMF_DLM_REQ,
 613         &RMF_CAPA1
 614 };
 615
 616
 617 static const struct req_msg_field *ost_brw_client[] = {
 618         &RMF_PTLRPC_BODY,
 619         &RMF_OST_BODY,
 620         &RMF_OBD_IOOBJ,
 621         &RMF_NIOBUF_REMOTE,
 622         &RMF_CAPA1
 623 };
 624
 625 static const struct req_msg_field *ost_brw_read_server[] = {
 626         &RMF_PTLRPC_BODY,
 627         &RMF_OST_BODY
 628 };
 629
 630 static const struct req_msg_field *ost_brw_write_server[] = {
 631         &RMF_PTLRPC_BODY,
 632         &RMF_OST_BODY,
 633         &RMF_RCS
 634 };
 635
 636 static const struct req_msg_field *ost_get_info_generic_server[] = {
 637         &RMF_PTLRPC_BODY,
 638         &RMF_GENERIC_DATA,
 639 };
 640
 641 static const struct req_msg_field *ost_get_info_generic_client[] = {
 642         &RMF_PTLRPC_BODY,
 643         &RMF_GETINFO_KEY
 644 };
 645
 646 static const struct req_msg_field *ost_get_last_id_server[] = {
 647         &RMF_PTLRPC_BODY,
 648         &RMF_OBD_ID
 649 };
 650
 651 static const struct req_msg_field *ost_get_last_fid_client[] = {
 652         &RMF_PTLRPC_BODY,
 653         &RMF_GETINFO_KEY,
 654         &RMF_FID,
 655 };
 656
 657 static const struct req_msg_field *ost_get_last_fid_server[] = {
 658         &RMF_PTLRPC_BODY,
 659         &RMF_FID,
 660 };
 661
 662 static const struct req_msg_field *ost_get_fiemap_client[] = {
 663         &RMF_PTLRPC_BODY,
 664         &RMF_FIEMAP_KEY,
 665         &RMF_FIEMAP_VAL
 666 };
 667
 668 static const struct req_msg_field *ost_ladvise[] = {
 669         &RMF_PTLRPC_BODY,
 670         &RMF_OST_BODY,
 671         &RMF_OST_LADVISE_HDR,
 672         &RMF_OST_LADVISE,
 673 };
 674
 675 static const struct req_msg_field *ost_get_fiemap_server[] = {
 676         &RMF_PTLRPC_BODY,
 677         &RMF_FIEMAP_VAL
 678 };
 679
 680 static const struct req_msg_field *mdt_hsm_progress[] = {
 681         &RMF_PTLRPC_BODY,
 682         &RMF_MDT_BODY,
 683         &RMF_MDS_HSM_PROGRESS,
 684 };
 685
 686 static const struct req_msg_field *mdt_hsm_ct_register[] = {
 687         &RMF_PTLRPC_BODY,
 688         &RMF_MDT_BODY,
 689         &RMF_MDS_HSM_ARCHIVE,
 690 };
 691
 692 static const struct req_msg_field *mdt_hsm_ct_unregister[] = {
 693         &RMF_PTLRPC_BODY,
 694         &RMF_MDT_BODY,
 695 };
 696
 697 static const struct req_msg_field *mdt_hsm_action_server[] = {
 698         &RMF_PTLRPC_BODY,
 699         &RMF_MDT_BODY,
 700         &RMF_MDS_HSM_CURRENT_ACTION,
 701 };
 702
 703 static const struct req_msg_field *mdt_hsm_state_get_server[] = {
 704         &RMF_PTLRPC_BODY,
 705         &RMF_MDT_BODY,
 706         &RMF_HSM_USER_STATE,
 707 };
 708
 709 static const struct req_msg_field *mdt_hsm_state_set[] = {
 710         &RMF_PTLRPC_BODY,
 711         &RMF_MDT_BODY,
 712         &RMF_CAPA1,
 713         &RMF_HSM_STATE_SET,
 714 };
 715
 716 static const struct req_msg_field *mdt_hsm_request[] = {
 717         &RMF_PTLRPC_BODY,
 718         &RMF_MDT_BODY,
 719         &RMF_MDS_HSM_REQUEST,
 720         &RMF_MDS_HSM_USER_ITEM,
 721         &RMF_GENERIC_DATA,
 722 };
 723
 724 static const struct req_msg_field *obd_lfsck_request[] = {
 725         &RMF_PTLRPC_BODY,
 726         &RMF_LFSCK_REQUEST,
 727 };
 728
 729 static const struct req_msg_field *obd_lfsck_reply[] = {
 730         &RMF_PTLRPC_BODY,
 731         &RMF_LFSCK_REPLY,
 732 };
 733
 734 static struct req_format *req_formats[] = {
 735         &RQF_OBD_PING,
 736         &RQF_OBD_SET_INFO,
 737         &RQF_OBD_IDX_READ,
 738         &RQF_SEC_CTX,
 739         &RQF_MGS_TARGET_REG,
 740 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
 741         &RQF_MGS_SET_INFO,
 742 #endif
 743         &RQF_MGS_CONFIG_READ,
 744         &RQF_SEQ_QUERY,
 745         &RQF_FLD_QUERY,
 746         &RQF_FLD_READ,
 747         &RQF_MDS_CONNECT,
 748         &RQF_MDS_DISCONNECT,
 749         &RQF_MDS_GET_INFO,
 750         &RQF_MDS_GET_ROOT,
 751         &RQF_MDS_STATFS,
 752         &RQF_MDS_GETATTR,
 753         &RQF_MDS_GETATTR_NAME,
 754         &RQF_MDS_GETXATTR,
 755         &RQF_MDS_SYNC,
 756         &RQF_MDS_CLOSE,
 757         &RQF_MDS_INTENT_CLOSE,
 758         &RQF_MDS_READPAGE,
 759         &RQF_MDS_REINT,
 760         &RQF_MDS_REINT_CREATE,
 761         &RQF_MDS_REINT_CREATE_ACL,
 762         &RQF_MDS_REINT_CREATE_SLAVE,
 763         &RQF_MDS_REINT_CREATE_SYM,
 764         &RQF_MDS_REINT_OPEN,
 765         &RQF_MDS_REINT_UNLINK,
 766         &RQF_MDS_REINT_LINK,
 767         &RQF_MDS_REINT_RENAME,
 768         &RQF_MDS_REINT_MIGRATE,
 769         &RQF_MDS_REINT_SETATTR,
 770         &RQF_MDS_REINT_SETXATTR,
 771         &RQF_MDS_QUOTACTL,
 772         &RQF_MDS_HSM_PROGRESS,
 773         &RQF_MDS_HSM_CT_REGISTER,
 774         &RQF_MDS_HSM_CT_UNREGISTER,
 775         &RQF_MDS_HSM_STATE_GET,
 776         &RQF_MDS_HSM_STATE_SET,
 777         &RQF_MDS_HSM_ACTION,
 778         &RQF_MDS_HSM_REQUEST,
 779         &RQF_MDS_SWAP_LAYOUTS,
 780         &RQF_OUT_UPDATE,
 781         &RQF_OST_CONNECT,
 782         &RQF_OST_DISCONNECT,
 783         &RQF_OST_QUOTACTL,
 784         &RQF_OST_GETATTR,
 785         &RQF_OST_SETATTR,
 786         &RQF_OST_CREATE,
 787         &RQF_OST_PUNCH,
 788         &RQF_OST_SYNC,
 789         &RQF_OST_DESTROY,
 790         &RQF_OST_BRW_READ,
 791         &RQF_OST_BRW_WRITE,
 792         &RQF_OST_STATFS,
 793         &RQF_OST_SET_GRANT_INFO,
 794         &RQF_OST_GET_INFO,
 795         &RQF_OST_GET_INFO_LAST_ID,
 796         &RQF_OST_GET_INFO_LAST_FID,
 797         &RQF_OST_SET_INFO_LAST_FID,
 798         &RQF_OST_GET_INFO_FIEMAP,
 799         &RQF_OST_LADVISE,
 800         &RQF_LDLM_ENQUEUE,
 801         &RQF_LDLM_ENQUEUE_LVB,
 802         &RQF_LDLM_CONVERT,
 803         &RQF_LDLM_CANCEL,
 804         &RQF_LDLM_CALLBACK,
 805         &RQF_LDLM_CP_CALLBACK,
 806         &RQF_LDLM_BL_CALLBACK,
 807         &RQF_LDLM_GL_CALLBACK,
 808         &RQF_LDLM_GL_DESC_CALLBACK,
 809         &RQF_LDLM_INTENT,
 810         &RQF_LDLM_INTENT_BASIC,
 811         &RQF_LDLM_INTENT_LAYOUT,
 812         &RQF_LDLM_INTENT_GETATTR,
 813         &RQF_LDLM_INTENT_OPEN,
 814         &RQF_LDLM_INTENT_CREATE,
 815         &RQF_LDLM_INTENT_UNLINK,
 816         &RQF_LDLM_INTENT_GETXATTR,
 817         &RQF_LDLM_INTENT_QUOTA,
 818         &RQF_QUOTA_DQACQ,
 819         &RQF_LOG_CANCEL,
 820         &RQF_LLOG_ORIGIN_HANDLE_CREATE,
 821         &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
 822         &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
 823         &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
 824         &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
 825         &RQF_LLOG_ORIGIN_CONNECT,
 826         &RQF_CONNECT,
 827         &RQF_LFSCK_NOTIFY,
 828         &RQF_LFSCK_QUERY,
 829 };
 830
 831 struct req_msg_field {
 832         const __u32 rmf_flags;
 833         const char  *rmf_name;
 834         /**
 835          * Field length. (-1) means "variable length".  If the
 836          * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
 837          * but the actual size must be a whole multiple of \a rmf_size.
 838          */
 839         const int   rmf_size;
 840         void        (*rmf_swabber)(void *);
 841         void        (*rmf_dumper)(void *);
 842         int         rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
 843 };
 844
 845 enum rmf_flags {
 846         /**
 847          * The field is a string, must be NUL-terminated.
 848          */
 849         RMF_F_STRING = 1 << 0,
 850         /**
 851          * The field's buffer size need not match the declared \a rmf_size.
 852          */
 853         RMF_F_NO_SIZE_CHECK = 1 << 1,
 854         /**
 855          * The field's buffer size must be a whole multiple of the declared \a
 856          * rmf_size and the \a rmf_swabber function must work on the declared \a
 857          * rmf_size worth of bytes.
 858          */
 859         RMF_F_STRUCT_ARRAY = 1 << 2
 860 };
 861
 862 struct req_capsule;
 863
 864 /*
 865  * Request fields.
 866  */
 867 #define DEFINE_MSGF(name, flags, size, swabber, dumper) {       \
 868         .rmf_name    = (name),                                  \
 869         .rmf_flags   = (flags),                                 \
 870         .rmf_size    = (size),                                  \
 871         .rmf_swabber = (void (*)(void*))(swabber),              \
 872         .rmf_dumper  = (void (*)(void*))(dumper)                \
 873 }
 874
 875 struct req_msg_field RMF_GENERIC_DATA =
 876         DEFINE_MSGF("generic_data", 0,
 877                     -1, NULL, NULL);
 878 EXPORT_SYMBOL(RMF_GENERIC_DATA);
 879
 880 struct req_msg_field RMF_MGS_TARGET_INFO =
 881         DEFINE_MSGF("mgs_target_info", 0,
 882                     sizeof(struct mgs_target_info),
 883                     lustre_swab_mgs_target_info, NULL);
 884 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
 885
 886 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
 887 struct req_msg_field RMF_MGS_SEND_PARAM =
 888         DEFINE_MSGF("mgs_send_param", 0,
 889                     sizeof(struct mgs_send_param),
 890                     NULL, NULL);
 891 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
 892 #endif
 893
 894 struct req_msg_field RMF_MGS_CONFIG_BODY =
 895         DEFINE_MSGF("mgs_config_read request", 0,
 896                     sizeof(struct mgs_config_body),
 897                     lustre_swab_mgs_config_body, NULL);
 898 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
 899
 900 struct req_msg_field RMF_MGS_CONFIG_RES =
 901         DEFINE_MSGF("mgs_config_read reply ", 0,
 902                     sizeof(struct mgs_config_res),
 903                     lustre_swab_mgs_config_res, NULL);
 904 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
 905
 906 struct req_msg_field RMF_U32 =
 907         DEFINE_MSGF("generic u32", 0,
 908                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 909 EXPORT_SYMBOL(RMF_U32);
 910
 911 struct req_msg_field RMF_SETINFO_VAL =
 912         DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
 913 EXPORT_SYMBOL(RMF_SETINFO_VAL);
 914
 915 struct req_msg_field RMF_GETINFO_KEY =
 916         DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
 917 EXPORT_SYMBOL(RMF_GETINFO_KEY);
 918
 919 struct req_msg_field RMF_GETINFO_VALLEN =
 920         DEFINE_MSGF("getinfo_vallen", 0,
 921                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 922 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
 923
 924 struct req_msg_field RMF_GETINFO_VAL =
 925         DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
 926 EXPORT_SYMBOL(RMF_GETINFO_VAL);
 927
 928 struct req_msg_field RMF_SEQ_OPC =
 929         DEFINE_MSGF("seq_query_opc", 0,
 930                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 931 EXPORT_SYMBOL(RMF_SEQ_OPC);
 932
 933 struct req_msg_field RMF_SEQ_RANGE =
 934         DEFINE_MSGF("seq_query_range", 0,
 935                     sizeof(struct lu_seq_range),
 936                     lustre_swab_lu_seq_range, NULL);
 937 EXPORT_SYMBOL(RMF_SEQ_RANGE);
 938
 939 struct req_msg_field RMF_FLD_OPC =
 940         DEFINE_MSGF("fld_query_opc", 0,
 941                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 942 EXPORT_SYMBOL(RMF_FLD_OPC);
 943
 944 struct req_msg_field RMF_FLD_MDFLD =
 945         DEFINE_MSGF("fld_query_mdfld", 0,
 946                     sizeof(struct lu_seq_range),
 947                     lustre_swab_lu_seq_range, NULL);
 948 EXPORT_SYMBOL(RMF_FLD_MDFLD);
 949
 950 struct req_msg_field RMF_MDT_BODY =
 951         DEFINE_MSGF("mdt_body", 0,
 952                     sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
 953 EXPORT_SYMBOL(RMF_MDT_BODY);
 954
 955 struct req_msg_field RMF_OBD_QUOTACTL =
 956         DEFINE_MSGF("obd_quotactl", 0,
 957                     sizeof(struct obd_quotactl),
 958                     lustre_swab_obd_quotactl, NULL);
 959 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
 960
 961 struct req_msg_field RMF_QUOTA_BODY =
 962         DEFINE_MSGF("quota_body", 0,
 963                     sizeof(struct quota_body), lustre_swab_quota_body, NULL);
 964 EXPORT_SYMBOL(RMF_QUOTA_BODY);
 965
 966 struct req_msg_field RMF_MDT_EPOCH =
 967         DEFINE_MSGF("mdt_ioepoch", 0,
 968                     sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
 969 EXPORT_SYMBOL(RMF_MDT_EPOCH);
 970
 971 struct req_msg_field RMF_PTLRPC_BODY =
 972         DEFINE_MSGF("ptlrpc_body", 0,
 973                     sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
 974 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
 975
 976 struct req_msg_field RMF_CLOSE_DATA =
 977         DEFINE_MSGF("data_version", 0,
 978                     sizeof(struct close_data), lustre_swab_close_data, NULL);
 979 EXPORT_SYMBOL(RMF_CLOSE_DATA);
 980
 981 struct req_msg_field RMF_OBD_STATFS =
 982         DEFINE_MSGF("obd_statfs", 0,
 983                     sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
 984 EXPORT_SYMBOL(RMF_OBD_STATFS);
 985
 986 struct req_msg_field RMF_SETINFO_KEY =
 987         DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
 988 EXPORT_SYMBOL(RMF_SETINFO_KEY);
 989
 990 struct req_msg_field RMF_NAME =
 991         DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
 992 EXPORT_SYMBOL(RMF_NAME);
 993
 994 struct req_msg_field RMF_SYMTGT =
 995         DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
 996 EXPORT_SYMBOL(RMF_SYMTGT);
 997
 998 struct req_msg_field RMF_TGTUUID =
 999         DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1000         NULL);
1001 EXPORT_SYMBOL(RMF_TGTUUID);
1002
1003 struct req_msg_field RMF_CLUUID =
1004         DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
1005         NULL);
1006 EXPORT_SYMBOL(RMF_CLUUID);
1007
1008 struct req_msg_field RMF_STRING =
1009         DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
1010 EXPORT_SYMBOL(RMF_STRING);
1011
1012 struct req_msg_field RMF_FILE_SECCTX_NAME =
1013         DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
1014 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1015
1016 struct req_msg_field RMF_FILE_SECCTX =
1017         DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1018 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1019
1020 struct req_msg_field RMF_LLOGD_BODY =
1021         DEFINE_MSGF("llogd_body", 0,
1022                     sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1023 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1024
1025 struct req_msg_field RMF_LLOG_LOG_HDR =
1026         DEFINE_MSGF("llog_log_hdr", 0,
1027                     sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1028 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1029
1030 struct req_msg_field RMF_LLOGD_CONN_BODY =
1031         DEFINE_MSGF("llogd_conn_body", 0,
1032                     sizeof(struct llogd_conn_body),
1033                     lustre_swab_llogd_conn_body, NULL);
1034 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1035
1036 /*
1037  * connection handle received in MDS_CONNECT request.
1038  *
1039  * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1040  * that the client does not interpret at all.
1041  */
1042 struct req_msg_field RMF_CONN =
1043         DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1044 EXPORT_SYMBOL(RMF_CONN);
1045
1046 struct req_msg_field RMF_CONNECT_DATA =
1047         DEFINE_MSGF("cdata",
1048                     RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1049                     sizeof(struct obd_connect_data),
1050                     lustre_swab_connect, NULL);
1051 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1052
1053 struct req_msg_field RMF_DLM_REQ =
1054         DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1055                     sizeof(struct ldlm_request),
1056                     lustre_swab_ldlm_request, NULL);
1057 EXPORT_SYMBOL(RMF_DLM_REQ);
1058
1059 struct req_msg_field RMF_DLM_REP =
1060         DEFINE_MSGF("dlm_rep", 0,
1061                     sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1062 EXPORT_SYMBOL(RMF_DLM_REP);
1063
1064 struct req_msg_field RMF_LDLM_INTENT =
1065         DEFINE_MSGF("ldlm_intent", 0,
1066                     sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1067 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1068
1069 struct req_msg_field RMF_DLM_LVB =
1070         DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1071 EXPORT_SYMBOL(RMF_DLM_LVB);
1072
1073 struct req_msg_field RMF_DLM_GL_DESC =
1074         DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc),
1075                     lustre_swab_gl_desc, NULL);
1076 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1077
1078 struct req_msg_field RMF_MDT_MD =
1079         DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1080 EXPORT_SYMBOL(RMF_MDT_MD);
1081
1082 struct req_msg_field RMF_REC_REINT =
1083         DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1084                     lustre_swab_mdt_rec_reint, NULL);
1085 EXPORT_SYMBOL(RMF_REC_REINT);
1086
1087 /* FIXME: this length should be defined as a macro */
1088 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1089                                                     NULL, NULL);
1090 EXPORT_SYMBOL(RMF_EADATA);
1091
1092 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1093 EXPORT_SYMBOL(RMF_EAVALS);
1094
1095 struct req_msg_field RMF_ACL =
1096         DEFINE_MSGF("acl", RMF_F_NO_SIZE_CHECK,
1097                     LUSTRE_POSIX_ACL_MAX_SIZE, NULL, NULL);
1098 EXPORT_SYMBOL(RMF_ACL);
1099
1100 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1101 struct req_msg_field RMF_LOGCOOKIES =
1102         DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1103                     sizeof(struct llog_cookie), NULL, NULL);
1104 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1105
1106 struct req_msg_field RMF_CAPA1 =
1107         DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1108                     lustre_swab_lustre_capa, NULL);
1109 EXPORT_SYMBOL(RMF_CAPA1);
1110
1111 struct req_msg_field RMF_CAPA2 =
1112         DEFINE_MSGF("capa", 0, sizeof(struct lustre_capa),
1113                     lustre_swab_lustre_capa, NULL);
1114 EXPORT_SYMBOL(RMF_CAPA2);
1115
1116 struct req_msg_field RMF_LAYOUT_INTENT =
1117         DEFINE_MSGF("layout_intent", 0,
1118                     sizeof(struct layout_intent), lustre_swab_layout_intent,
1119                     NULL);
1120 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1121
1122 /*
1123  * OST request field.
1124  */
1125 struct req_msg_field RMF_OST_BODY =
1126         DEFINE_MSGF("ost_body", 0,
1127                     sizeof(struct ost_body), lustre_swab_ost_body,
1128                     dump_ost_body);
1129 EXPORT_SYMBOL(RMF_OST_BODY);
1130
1131 struct req_msg_field RMF_OBD_IOOBJ =
1132         DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1133                     sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1134 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1135
1136 struct req_msg_field RMF_NIOBUF_REMOTE =
1137         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1138                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1139                     dump_rniobuf);
1140 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1141
1142 struct req_msg_field RMF_RCS =
1143         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1144                     lustre_swab_generic_32s, dump_rcs);
1145 EXPORT_SYMBOL(RMF_RCS);
1146
1147 struct req_msg_field RMF_EAVALS_LENS =
1148         DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1149                 lustre_swab_generic_32s, NULL);
1150 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1151
1152 struct req_msg_field RMF_OBD_ID =
1153         DEFINE_MSGF("obd_id", 0,
1154                     sizeof(__u64), lustre_swab_ost_last_id, NULL);
1155 EXPORT_SYMBOL(RMF_OBD_ID);
1156
1157 struct req_msg_field RMF_FID =
1158         DEFINE_MSGF("fid", 0,
1159                     sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1160 EXPORT_SYMBOL(RMF_FID);
1161
1162 struct req_msg_field RMF_OST_ID =
1163         DEFINE_MSGF("ost_id", 0,
1164                     sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1165 EXPORT_SYMBOL(RMF_OST_ID);
1166
1167 struct req_msg_field RMF_FIEMAP_KEY =
1168         DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1169                     lustre_swab_fiemap, NULL);
1170 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1171
1172 struct req_msg_field RMF_FIEMAP_VAL =
1173         DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1174 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1175
1176 struct req_msg_field RMF_IDX_INFO =
1177         DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1178                     lustre_swab_idx_info, NULL);
1179 EXPORT_SYMBOL(RMF_IDX_INFO);
1180 struct req_msg_field RMF_HSM_USER_STATE =
1181         DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1182                     lustre_swab_hsm_user_state, NULL);
1183 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1184
1185 struct req_msg_field RMF_HSM_STATE_SET =
1186         DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1187                     lustre_swab_hsm_state_set, NULL);
1188 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1189
1190 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1191         DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1192                     lustre_swab_hsm_progress_kernel, NULL);
1193 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1194
1195 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1196         DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1197                     lustre_swab_hsm_current_action, NULL);
1198 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1199
1200 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1201         DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1202                     sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1203                     NULL);
1204 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1205
1206 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1207         DEFINE_MSGF("hsm_archive", 0,
1208                     sizeof(__u32), lustre_swab_generic_32s, NULL);
1209 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1210
1211 struct req_msg_field RMF_MDS_HSM_REQUEST =
1212         DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1213                     lustre_swab_hsm_request, NULL);
1214 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1215
1216 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1217                                 lustre_swab_object_update_request, NULL);
1218 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1219
1220 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1221                         DEFINE_MSGF("object_update_reply", 0, -1,
1222                                     lustre_swab_object_update_reply, NULL);
1223 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1224
1225 struct req_msg_field RMF_SWAP_LAYOUTS =
1226         DEFINE_MSGF("swap_layouts", 0, sizeof(struct  mdc_swap_layouts),
1227                     lustre_swab_swap_layouts, NULL);
1228 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1229
1230 struct req_msg_field RMF_LFSCK_REQUEST =
1231         DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1232                     lustre_swab_lfsck_request, NULL);
1233 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1234
1235 struct req_msg_field RMF_LFSCK_REPLY =
1236         DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1237                     lustre_swab_lfsck_reply, NULL);
1238 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1239
1240 struct req_msg_field RMF_OST_LADVISE_HDR =
1241         DEFINE_MSGF("ladvise_request", 0,
1242                     sizeof(struct ladvise_hdr),
1243                     lustre_swab_ladvise_hdr, NULL);
1244 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1245
1246 struct req_msg_field RMF_OST_LADVISE =
1247         DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1248                     sizeof(struct lu_ladvise),
1249                     lustre_swab_ladvise, NULL);
1250 EXPORT_SYMBOL(RMF_OST_LADVISE);
1251
1252 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1253                                 -1, lustre_swab_out_update_header, NULL);
1254 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1255
1256 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1257                         RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1258                         lustre_swab_out_update_buffer, NULL);
1259 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1260
1261 /*
1262  * Request formats.
1263  */
1264
1265 struct req_format {
1266         const char *rf_name;
1267         size_t      rf_idx;
1268         struct {
1269                 size_t                       nr;
1270                 const struct req_msg_field **d;
1271         } rf_fields[RCL_NR];
1272 };
1273
1274 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) {    \
1275         .rf_name   = name,                                              \
1276         .rf_fields = {                                                  \
1277                 [RCL_CLIENT] = {                                        \
1278                         .nr = client_nr,                                \
1279                         .d  = client                                    \
1280                 },                                                      \
1281                 [RCL_SERVER] = {                                        \
1282                         .nr = server_nr,                                \
1283                         .d  = server                                    \
1284                 }                                                       \
1285         }                                                               \
1286 }
1287
1288 #define DEFINE_REQ_FMT0(name, client, server)                                  \
1289 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1290
1291 struct req_format RQF_OBD_PING =
1292         DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1293 EXPORT_SYMBOL(RQF_OBD_PING);
1294
1295 struct req_format RQF_OBD_SET_INFO =
1296         DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1297 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1298
1299 /* Read index file through the network */
1300 struct req_format RQF_OBD_IDX_READ =
1301         DEFINE_REQ_FMT0("OBD_IDX_READ",
1302                         obd_idx_read_client, obd_idx_read_server);
1303 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1304
1305 struct req_format RQF_SEC_CTX =
1306         DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1307 EXPORT_SYMBOL(RQF_SEC_CTX);
1308
1309 struct req_format RQF_MGS_TARGET_REG =
1310         DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1311                          mgs_target_info_only);
1312 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1313
1314 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1315 struct req_format RQF_MGS_SET_INFO =
1316         DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1317                          mgs_set_info);
1318 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1319 #endif
1320
1321 struct req_format RQF_MGS_CONFIG_READ =
1322         DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1323                          mgs_config_read_server);
1324 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1325
1326 struct req_format RQF_SEQ_QUERY =
1327         DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1328 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1329
1330 struct req_format RQF_FLD_QUERY =
1331         DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1332 EXPORT_SYMBOL(RQF_FLD_QUERY);
1333
1334 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1335  * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1336  * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1337  * peers need to handle the RPC reply with fixed little-endian format.
1338  *
1339  * In theory, we can define new structure with some swabber registered to
1340  * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1341  * implementation view, it is not easy to be done within current "struct
1342  * req_msg_field" framework. Because the sequence range array in the RPC
1343  * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1344  * count, that is unknown when prepare the RPC buffer. Generally, for such
1345  * flexible length RPC usage, there will be a field in the RPC layout to
1346  * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1347  * do that unless we add new length filed that will broken the on-wire RPC
1348  * protocol and cause interoperability trouble with old peer. */
1349 struct req_format RQF_FLD_READ =
1350         DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1351 EXPORT_SYMBOL(RQF_FLD_READ);
1352
1353 struct req_format RQF_LOG_CANCEL =
1354         DEFINE_REQ_FMT0("OBD_LOG_CANCEL", log_cancel_client, empty);
1355 EXPORT_SYMBOL(RQF_LOG_CANCEL);
1356
1357 struct req_format RQF_MDS_QUOTACTL =
1358         DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1359 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1360
1361 struct req_format RQF_OST_QUOTACTL =
1362         DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1363 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1364
1365 struct req_format RQF_QUOTA_DQACQ =
1366         DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1367 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1368
1369 struct req_format RQF_LDLM_INTENT_QUOTA =
1370         DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1371                         ldlm_intent_quota_client,
1372                         ldlm_intent_quota_server);
1373 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1374
1375 struct req_format RQF_MDS_GET_ROOT =
1376         DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1377 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1378
1379 struct req_format RQF_MDS_STATFS =
1380         DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1381 EXPORT_SYMBOL(RQF_MDS_STATFS);
1382
1383 struct req_format RQF_MDS_SYNC =
1384         DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1385 EXPORT_SYMBOL(RQF_MDS_SYNC);
1386
1387 struct req_format RQF_MDS_GETATTR =
1388         DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1389 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1390
1391 struct req_format RQF_MDS_GETXATTR =
1392         DEFINE_REQ_FMT0("MDS_GETXATTR",
1393                         mds_getxattr_client, mds_getxattr_server);
1394 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1395
1396 struct req_format RQF_MDS_GETATTR_NAME =
1397         DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1398                         mds_getattr_name_client, mds_getattr_server);
1399 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1400
1401 struct req_format RQF_MDS_REINT =
1402         DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1403 EXPORT_SYMBOL(RQF_MDS_REINT);
1404
1405 struct req_format RQF_MDS_REINT_CREATE =
1406         DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1407                         mds_reint_create_client, mdt_body_capa);
1408 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1409
1410 struct req_format RQF_MDS_REINT_CREATE_ACL =
1411         DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1412                         mds_reint_create_acl_client, mdt_body_capa);
1413 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1414
1415 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1416         DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1417                         mds_reint_create_slave_client, mdt_body_capa);
1418 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1419
1420 struct req_format RQF_MDS_REINT_CREATE_SYM =
1421         DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1422                         mds_reint_create_sym_client, mdt_body_capa);
1423 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1424
1425 struct req_format RQF_MDS_REINT_OPEN =
1426         DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1427                         mds_reint_open_client, mds_reint_open_server);
1428 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1429
1430 struct req_format RQF_MDS_REINT_UNLINK =
1431         DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1432                         mds_last_unlink_server);
1433 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1434
1435 struct req_format RQF_MDS_REINT_LINK =
1436         DEFINE_REQ_FMT0("MDS_REINT_LINK",
1437                         mds_reint_link_client, mdt_body_only);
1438 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1439
1440 struct req_format RQF_MDS_REINT_RENAME =
1441         DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1442                         mds_last_unlink_server);
1443 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1444
1445 struct req_format RQF_MDS_REINT_MIGRATE =
1446         DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1447                         mds_last_unlink_server);
1448 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1449
1450 struct req_format RQF_MDS_REINT_SETATTR =
1451         DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1452                         mds_reint_setattr_client, mds_setattr_server);
1453 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1454
1455 struct req_format RQF_MDS_REINT_SETXATTR =
1456         DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1457                         mds_reint_setxattr_client, mdt_body_only);
1458 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1459
1460 struct req_format RQF_MDS_CONNECT =
1461         DEFINE_REQ_FMT0("MDS_CONNECT",
1462                         obd_connect_client, obd_connect_server);
1463 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1464
1465 struct req_format RQF_MDS_DISCONNECT =
1466         DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1467 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1468
1469 struct req_format RQF_MDS_GET_INFO =
1470         DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1471                         mds_getinfo_server);
1472 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1473
1474 struct req_format RQF_OUT_UPDATE =
1475         DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1476                         mds_update_server);
1477 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1478
1479 struct req_format RQF_LDLM_ENQUEUE =
1480         DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1481                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1482 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1483
1484 struct req_format RQF_LDLM_ENQUEUE_LVB =
1485         DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1486                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1487 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1488
1489 struct req_format RQF_LDLM_CONVERT =
1490         DEFINE_REQ_FMT0("LDLM_CONVERT",
1491                         ldlm_enqueue_client, ldlm_enqueue_server);
1492 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1493
1494 struct req_format RQF_LDLM_CANCEL =
1495         DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1496 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1497
1498 struct req_format RQF_LDLM_CALLBACK =
1499         DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1500 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1501
1502 struct req_format RQF_LDLM_CP_CALLBACK =
1503         DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1504 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1505
1506 struct req_format RQF_LDLM_BL_CALLBACK =
1507         DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1508 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1509
1510 struct req_format RQF_LDLM_GL_CALLBACK =
1511         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1512                         ldlm_gl_callback_server);
1513 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1514
1515 struct req_format RQF_LDLM_GL_DESC_CALLBACK =
1516         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1517                         ldlm_gl_callback_server);
1518 EXPORT_SYMBOL(RQF_LDLM_GL_DESC_CALLBACK);
1519
1520 struct req_format RQF_LDLM_INTENT_BASIC =
1521         DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1522                         ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1523 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1524
1525 struct req_format RQF_LDLM_INTENT =
1526         DEFINE_REQ_FMT0("LDLM_INTENT",
1527                         ldlm_intent_client, ldlm_intent_server);
1528 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1529
1530 struct req_format RQF_LDLM_INTENT_LAYOUT =
1531         DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT ",
1532                         ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1533 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1534
1535 struct req_format RQF_LDLM_INTENT_GETATTR =
1536         DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1537                         ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1538 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1539
1540 struct req_format RQF_LDLM_INTENT_OPEN =
1541         DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1542                         ldlm_intent_open_client, ldlm_intent_open_server);
1543 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1544
1545 struct req_format RQF_LDLM_INTENT_CREATE =
1546         DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1547                         ldlm_intent_create_client, ldlm_intent_getattr_server);
1548 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1549
1550 struct req_format RQF_LDLM_INTENT_UNLINK =
1551         DEFINE_REQ_FMT0("LDLM_INTENT_UNLINK",
1552                         ldlm_intent_unlink_client, ldlm_intent_server);
1553 EXPORT_SYMBOL(RQF_LDLM_INTENT_UNLINK);
1554
1555 struct req_format RQF_LDLM_INTENT_GETXATTR =
1556         DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1557                         ldlm_intent_getxattr_client,
1558                         ldlm_intent_getxattr_server);
1559 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1560
1561 struct req_format RQF_MDS_CLOSE =
1562         DEFINE_REQ_FMT0("MDS_CLOSE",
1563                         mdt_close_client, mds_last_unlink_server);
1564 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1565
1566 struct req_format RQF_MDS_INTENT_CLOSE =
1567         DEFINE_REQ_FMT0("MDS_CLOSE",
1568                         mdt_intent_close_client, mds_last_unlink_server);
1569 EXPORT_SYMBOL(RQF_MDS_INTENT_CLOSE);
1570
1571 struct req_format RQF_MDS_READPAGE =
1572         DEFINE_REQ_FMT0("MDS_READPAGE",
1573                         mdt_body_capa, mdt_body_only);
1574 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1575
1576 struct req_format RQF_MDS_HSM_ACTION =
1577         DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1578 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1579
1580 struct req_format RQF_MDS_HSM_PROGRESS =
1581         DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1582 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1583
1584 struct req_format RQF_MDS_HSM_CT_REGISTER =
1585         DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1586 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1587
1588 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1589         DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1590 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1591
1592 struct req_format RQF_MDS_HSM_STATE_GET =
1593         DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1594                         mdt_body_capa, mdt_hsm_state_get_server);
1595 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1596
1597 struct req_format RQF_MDS_HSM_STATE_SET =
1598         DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1599 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1600
1601 struct req_format RQF_MDS_HSM_REQUEST =
1602         DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1603 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1604
1605 struct req_format RQF_MDS_SWAP_LAYOUTS =
1606         DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1607                         mdt_swap_layouts, empty);
1608 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1609
1610 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1611         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1612                         llog_origin_handle_create_client, llogd_body_only);
1613 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1614
1615 struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY =
1616         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_DESTROY",
1617                         llogd_body_only, llogd_body_only);
1618 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_DESTROY);
1619
1620 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1621         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1622                         llogd_body_only, llog_origin_handle_next_block_server);
1623 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1624
1625 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1626         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1627                         llogd_body_only, llog_origin_handle_next_block_server);
1628 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1629
1630 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1631         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1632                         llogd_body_only, llog_log_hdr_only);
1633 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1634
1635 struct req_format RQF_LLOG_ORIGIN_CONNECT =
1636         DEFINE_REQ_FMT0("LLOG_ORIGIN_CONNECT", llogd_conn_body_only, empty);
1637 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_CONNECT);
1638
1639 struct req_format RQF_CONNECT =
1640         DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1641 EXPORT_SYMBOL(RQF_CONNECT);
1642
1643 struct req_format RQF_OST_CONNECT =
1644         DEFINE_REQ_FMT0("OST_CONNECT",
1645                         obd_connect_client, obd_connect_server);
1646 EXPORT_SYMBOL(RQF_OST_CONNECT);
1647
1648 struct req_format RQF_OST_DISCONNECT =
1649         DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1650 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1651
1652 struct req_format RQF_OST_GETATTR =
1653         DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1654 EXPORT_SYMBOL(RQF_OST_GETATTR);
1655
1656 struct req_format RQF_OST_SETATTR =
1657         DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1658 EXPORT_SYMBOL(RQF_OST_SETATTR);
1659
1660 struct req_format RQF_OST_CREATE =
1661         DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1662 EXPORT_SYMBOL(RQF_OST_CREATE);
1663
1664 struct req_format RQF_OST_PUNCH =
1665         DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1666 EXPORT_SYMBOL(RQF_OST_PUNCH);
1667
1668 struct req_format RQF_OST_SYNC =
1669         DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1670 EXPORT_SYMBOL(RQF_OST_SYNC);
1671
1672 struct req_format RQF_OST_DESTROY =
1673         DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1674 EXPORT_SYMBOL(RQF_OST_DESTROY);
1675
1676 struct req_format RQF_OST_BRW_READ =
1677         DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1678 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1679
1680 struct req_format RQF_OST_BRW_WRITE =
1681         DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1682 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1683
1684 struct req_format RQF_OST_STATFS =
1685         DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1686 EXPORT_SYMBOL(RQF_OST_STATFS);
1687
1688 struct req_format RQF_OST_SET_GRANT_INFO =
1689         DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1690                          ost_body_only);
1691 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1692
1693 struct req_format RQF_OST_GET_INFO =
1694         DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1695                                         ost_get_info_generic_server);
1696 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1697
1698 struct req_format RQF_OST_GET_INFO_LAST_ID =
1699         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1700                                                 ost_get_last_id_server);
1701 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1702
1703 struct req_format RQF_OST_GET_INFO_LAST_FID =
1704         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1705                                                  ost_get_last_fid_server);
1706 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1707
1708 struct req_format RQF_OST_SET_INFO_LAST_FID =
1709         DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1710                                                  empty);
1711 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1712
1713 struct req_format RQF_OST_GET_INFO_FIEMAP =
1714         DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1715                                                ost_get_fiemap_server);
1716 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1717
1718 struct req_format RQF_LFSCK_NOTIFY =
1719         DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1720 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1721
1722 struct req_format RQF_LFSCK_QUERY =
1723         DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1724 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1725
1726 struct req_format RQF_OST_LADVISE =
1727         DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1728 EXPORT_SYMBOL(RQF_OST_LADVISE);
1729
1730 #if !defined(__REQ_LAYOUT_USER__)
1731
1732 /* Convenience macro */
1733 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1734
1735 /**
1736  * Initializes the capsule abstraction by computing and setting the \a rf_idx
1737  * field of RQFs and the \a rmf_offset field of RMFs.
1738  */
1739 int req_layout_init(void)
1740 {
1741         size_t i;
1742         size_t j;
1743         size_t k;
1744         struct req_format *rf = NULL;
1745
1746         for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1747                 rf = req_formats[i];
1748                 rf->rf_idx = i;
1749                 for (j = 0; j < RCL_NR; ++j) {
1750                         LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1751                         for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1752                                 struct req_msg_field *field;
1753
1754                                 field = (typeof(field))rf->rf_fields[j].d[k];
1755                                 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1756                                         || field->rmf_size > 0);
1757                                 LASSERT(field->rmf_offset[i][j] == 0);
1758                                 /*
1759                                  * k + 1 to detect unused format/field
1760                                  * combinations.
1761                                  */
1762                                 field->rmf_offset[i][j] = k + 1;
1763                         }
1764                 }
1765         }
1766         return 0;
1767 }
1768 EXPORT_SYMBOL(req_layout_init);
1769
1770 void req_layout_fini(void)
1771 {
1772 }
1773 EXPORT_SYMBOL(req_layout_fini);
1774
1775 /**
1776  * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1777  *
1778  * Actual/expected field sizes are set elsewhere in functions in this file:
1779  * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1780  * req_capsule_msg_size().  The \a rc_area information is used by.
1781  * ptlrpc_request_set_replen().
1782  */
1783 void req_capsule_init_area(struct req_capsule *pill)
1784 {
1785         size_t i;
1786
1787         for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1788                 pill->rc_area[RCL_CLIENT][i] = -1;
1789                 pill->rc_area[RCL_SERVER][i] = -1;
1790         }
1791 }
1792 EXPORT_SYMBOL(req_capsule_init_area);
1793
1794 /**
1795  * Initialize a pill.
1796  *
1797  * The \a location indicates whether the caller is executing on the client side
1798  * (RCL_CLIENT) or server side (RCL_SERVER)..
1799  */
1800 void req_capsule_init(struct req_capsule *pill,
1801                       struct ptlrpc_request *req,
1802                       enum req_location location)
1803 {
1804         LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1805
1806         /*
1807          * Today all capsules are embedded in ptlrpc_request structs,
1808          * but just in case that ever isn't the case, we don't reach
1809          * into req unless req != NULL and pill is the one embedded in
1810          * the req.
1811          *
1812          * The req->rq_pill_init flag makes it safe to initialize a pill
1813          * twice, which might happen in the OST paths as a result of the
1814          * high-priority RPC queue getting peeked at before ost_handle()
1815          * handles an OST RPC.
1816          */
1817         if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1818                 return;
1819
1820         memset(pill, 0, sizeof *pill);
1821         pill->rc_req = req;
1822         pill->rc_loc = location;
1823         req_capsule_init_area(pill);
1824
1825         if (req != NULL && pill == &req->rq_pill)
1826                 req->rq_pill_init = 1;
1827 }
1828 EXPORT_SYMBOL(req_capsule_init);
1829
1830 void req_capsule_fini(struct req_capsule *pill)
1831 {
1832 }
1833 EXPORT_SYMBOL(req_capsule_fini);
1834
1835 static int __req_format_is_sane(const struct req_format *fmt)
1836 {
1837         return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1838                 req_formats[fmt->rf_idx] == fmt;
1839 }
1840
1841 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1842                                     enum req_location loc)
1843 {
1844         struct ptlrpc_request *req;
1845
1846         req = pill->rc_req;
1847         return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1848 }
1849
1850 /**
1851  * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1852  * (see req_capsule_extend()).
1853  */
1854 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1855 {
1856         LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1857         LASSERT(__req_format_is_sane(fmt));
1858
1859         pill->rc_fmt = fmt;
1860 }
1861 EXPORT_SYMBOL(req_capsule_set);
1862
1863 /**
1864  * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1865  * yet.
1866
1867  * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1868  * variable-sized fields.  The field sizes come from the declared \a rmf_size
1869  * field of a \a pill's \a rc_fmt's RMF's.
1870  */
1871 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1872                                 enum req_location loc)
1873 {
1874         const struct req_format *fmt = pill->rc_fmt;
1875         size_t                   i;
1876
1877         LASSERT(fmt != NULL);
1878
1879         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1880                 if (pill->rc_area[loc][i] == -1) {
1881                         pill->rc_area[loc][i] =
1882                                             fmt->rf_fields[loc].d[i]->rmf_size;
1883                         if (pill->rc_area[loc][i] == -1) {
1884                                 /*
1885                                  * Skip the following fields.
1886                                  *
1887                                  * If this LASSERT() trips then you're missing a
1888                                  * call to req_capsule_set_size().
1889                                  */
1890                                 LASSERT(loc != RCL_SERVER);
1891                                 break;
1892                         }
1893                 }
1894         }
1895         return i;
1896 }
1897 EXPORT_SYMBOL(req_capsule_filled_sizes);
1898
1899 /**
1900  * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1901  *
1902  * This function uses the \a pill's \a rc_area as filled in by
1903  * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1904  * this function).
1905  */
1906 int req_capsule_server_pack(struct req_capsule *pill)
1907 {
1908         const struct req_format *fmt;
1909         int                      count;
1910         int                      rc;
1911
1912         LASSERT(pill->rc_loc == RCL_SERVER);
1913         fmt = pill->rc_fmt;
1914         LASSERT(fmt != NULL);
1915
1916         count = req_capsule_filled_sizes(pill, RCL_SERVER);
1917         rc = lustre_pack_reply(pill->rc_req, count,
1918                                pill->rc_area[RCL_SERVER], NULL);
1919         if (rc != 0) {
1920                 DEBUG_REQ(D_ERROR, pill->rc_req,
1921                        "Cannot pack %d fields in format `%s': ",
1922                        count, fmt->rf_name);
1923         }
1924         return rc;
1925 }
1926 EXPORT_SYMBOL(req_capsule_server_pack);
1927
1928 /**
1929  * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1930  * corresponding to the given RMF (\a field).
1931  */
1932 static __u32 __req_capsule_offset(const struct req_capsule *pill,
1933                                   const struct req_msg_field *field,
1934                                   enum req_location loc)
1935 {
1936         int offset;
1937
1938         offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1939         LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1940                             pill->rc_fmt->rf_name,
1941                             field->rmf_name, offset, loc);
1942         offset --;
1943
1944         LASSERT(0 <= offset && offset < REQ_MAX_FIELD_NR);
1945         return offset;
1946 }
1947
1948 /**
1949  * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1950  * them if desired.
1951  */
1952 static
1953 void
1954 swabber_dumper_helper(struct req_capsule *pill,
1955                       const struct req_msg_field *field,
1956                       enum req_location loc,
1957                       int offset,
1958                       void *value, int len, int dump, void (*swabber)( void *))
1959 {
1960         void    *p;
1961         int     i;
1962         int     n;
1963         int     do_swab;
1964         int     inout = loc == RCL_CLIENT;
1965
1966         swabber = swabber ?: field->rmf_swabber;
1967
1968         if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1969             swabber != NULL && value != NULL)
1970                 do_swab = 1;
1971         else
1972                 do_swab = 0;
1973
1974         if (!field->rmf_dumper)
1975                 dump = 0;
1976
1977         if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1978                 if (dump) {
1979                         CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1980                                do_swab ? "unswabbed " : "", field->rmf_name);
1981                         field->rmf_dumper(value);
1982                 }
1983                 if (!do_swab)
1984                         return;
1985                 swabber(value);
1986                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1987                 if (dump) {
1988                         CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1989                                "follows\n", field->rmf_name);
1990                         field->rmf_dumper(value);
1991                 }
1992
1993                 return;
1994         }
1995
1996         /*
1997          * We're swabbing an array; swabber() swabs a single array element, so
1998          * swab every element.
1999          */
2000         LASSERT((len % field->rmf_size) == 0);
2001         for (p = value, i = 0, n = len / field->rmf_size;
2002              i < n;
2003              i++, p += field->rmf_size) {
2004                 if (dump) {
2005                         CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
2006                                "element %d follows\n",
2007                                do_swab ? "unswabbed " : "", field->rmf_name, i);
2008                         field->rmf_dumper(p);
2009                 }
2010                 if (!do_swab)
2011                         continue;
2012                 swabber(p);
2013                 if (dump) {
2014                         CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
2015                                "element %d follows\n", field->rmf_name, i);
2016                         field->rmf_dumper(value);
2017                 }
2018         }
2019         if (do_swab)
2020                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
2021 }
2022
2023 /**
2024  * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2025  * corresponding to the given RMF (\a field).
2026  *
2027  * The buffer will be swabbed using the given \a swabber.  If \a swabber == NULL
2028  * then the \a rmf_swabber from the RMF will be used.  Soon there will be no
2029  * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2030  * be removed.  Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2031  * element of the array swabbed.
2032  */
2033 static void *__req_capsule_get(struct req_capsule *pill,
2034                                const struct req_msg_field *field,
2035                                enum req_location loc,
2036                                void (*swabber)( void *),
2037                                int dump)
2038 {
2039         const struct req_format *fmt;
2040         struct lustre_msg       *msg;
2041         void                    *value;
2042         __u32                    len;
2043         __u32                    offset;
2044
2045         void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2046
2047         static const char *rcl_names[RCL_NR] = {
2048                 [RCL_CLIENT] = "client",
2049                 [RCL_SERVER] = "server"
2050         };
2051
2052         LASSERT(pill != NULL);
2053         LASSERT(pill != LP_POISON);
2054         fmt = pill->rc_fmt;
2055         LASSERT(fmt != NULL);
2056         LASSERT(fmt != LP_POISON);
2057         LASSERT(__req_format_is_sane(fmt));
2058
2059         offset = __req_capsule_offset(pill, field, loc);
2060
2061         msg = __req_msg(pill, loc);
2062         LASSERT(msg != NULL);
2063
2064         getter = (field->rmf_flags & RMF_F_STRING) ?
2065                 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2066
2067         if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2068                 /*
2069                  * We've already asserted that field->rmf_size > 0 in
2070                  * req_layout_init().
2071                  */
2072                 len = lustre_msg_buflen(msg, offset);
2073                 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2074                     (len % field->rmf_size) != 0) {
2075                         CERROR("%s: array field size mismatch "
2076                                 "%d modulo %u != 0 (%d)\n",
2077                                 field->rmf_name, len, field->rmf_size, loc);
2078                         return NULL;
2079                 }
2080         } else if (pill->rc_area[loc][offset] != -1) {
2081                 len = pill->rc_area[loc][offset];
2082         } else {
2083                 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2084         }
2085         value = getter(msg, offset, len);
2086
2087         if (value == NULL) {
2088                 DEBUG_REQ(D_ERROR, pill->rc_req,
2089                           "Wrong buffer for field `%s' (%u of %u) "
2090                           "in format `%s': %u vs. %u (%s)\n",
2091                           field->rmf_name, offset, lustre_msg_bufcount(msg),
2092                           fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2093                           rcl_names[loc]);
2094         } else {
2095                 swabber_dumper_helper(pill, field, loc, offset, value, len,
2096                                       dump, swabber);
2097         }
2098
2099         return value;
2100 }
2101
2102 /**
2103  * Dump a request and/or reply
2104  */
2105 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2106 {
2107         const struct    req_format *fmt;
2108         const struct    req_msg_field *field;
2109         __u32           len;
2110         size_t          i;
2111
2112         fmt = pill->rc_fmt;
2113
2114         DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2115         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2116                 field = FMT_FIELD(fmt, loc, i);
2117                 if (field->rmf_dumper == NULL) {
2118                         /*
2119                          * FIXME Add a default hex dumper for fields that don't
2120                          * have a specific dumper
2121                          */
2122                         len = req_capsule_get_size(pill, field, loc);
2123                         CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2124                                 "field size is %u\n", field->rmf_name, len);
2125                 } else {
2126                         /* It's the dumping side-effect that we're interested in */
2127                         (void) __req_capsule_get(pill, field, loc, NULL, 1);
2128                 }
2129         }
2130         CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2131 }
2132
2133 /**
2134  * Dump a request.
2135  */
2136 void req_capsule_client_dump(struct req_capsule *pill)
2137 {
2138         __req_capsule_dump(pill, RCL_CLIENT);
2139 }
2140 EXPORT_SYMBOL(req_capsule_client_dump);
2141
2142 /**
2143  * Dump a reply
2144  */
2145 void req_capsule_server_dump(struct req_capsule *pill)
2146 {
2147         __req_capsule_dump(pill, RCL_SERVER);
2148 }
2149 EXPORT_SYMBOL(req_capsule_server_dump);
2150
2151 /**
2152  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2153  * buffer corresponding to the given RMF (\a field) of a \a pill.
2154  */
2155 void *req_capsule_client_get(struct req_capsule *pill,
2156                              const struct req_msg_field *field)
2157 {
2158         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2159 }
2160 EXPORT_SYMBOL(req_capsule_client_get);
2161
2162 /**
2163  * Same as req_capsule_client_get(), but with a \a swabber argument.
2164  *
2165  * Currently unused; will be removed when req_capsule_server_swab_get() is
2166  * unused too.
2167  */
2168 void *req_capsule_client_swab_get(struct req_capsule *pill,
2169                                   const struct req_msg_field *field,
2170                                   void *swabber)
2171 {
2172         return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2173 }
2174 EXPORT_SYMBOL(req_capsule_client_swab_get);
2175
2176 /**
2177  * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2178  *
2179  * First the \a pill's request \a field's size is set (\a rc_area) using
2180  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2181  * returned.
2182  */
2183 void *req_capsule_client_sized_get(struct req_capsule *pill,
2184                                    const struct req_msg_field *field,
2185                                    __u32 len)
2186 {
2187         req_capsule_set_size(pill, field, RCL_CLIENT, len);
2188         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2189 }
2190 EXPORT_SYMBOL(req_capsule_client_sized_get);
2191
2192 /**
2193  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2194  * buffer corresponding to the given RMF (\a field) of a \a pill.
2195  */
2196 void *req_capsule_server_get(struct req_capsule *pill,
2197                              const struct req_msg_field *field)
2198 {
2199         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2200 }
2201 EXPORT_SYMBOL(req_capsule_server_get);
2202
2203 /**
2204  * Same as req_capsule_server_get(), but with a \a swabber argument.
2205  *
2206  * Ideally all swabbing should be done pursuant to RMF definitions, with no
2207  * swabbing done outside this capsule abstraction.
2208  */
2209 void *req_capsule_server_swab_get(struct req_capsule *pill,
2210                                   const struct req_msg_field *field,
2211                                   void *swabber)
2212 {
2213         return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2214 }
2215 EXPORT_SYMBOL(req_capsule_server_swab_get);
2216
2217 /**
2218  * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2219  *
2220  * First the \a pill's request \a field's size is set (\a rc_area) using
2221  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2222  * returned.
2223  */
2224 void *req_capsule_server_sized_get(struct req_capsule *pill,
2225                                    const struct req_msg_field *field,
2226                                    __u32 len)
2227 {
2228         req_capsule_set_size(pill, field, RCL_SERVER, len);
2229         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2230 }
2231 EXPORT_SYMBOL(req_capsule_server_sized_get);
2232
2233 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2234                                         const struct req_msg_field *field,
2235                                         __u32 len, void *swabber)
2236 {
2237         req_capsule_set_size(pill, field, RCL_SERVER, len);
2238         return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2239 }
2240 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2241
2242 /**
2243  * Returns the buffer of a \a pill corresponding to the given \a field from the
2244  * request (if the caller is executing on the server-side) or reply (if the
2245  * caller is executing on the client-side).
2246  *
2247  * This function convienient for use is code that could be executed on the
2248  * client and server alike.
2249  */
2250 const void *req_capsule_other_get(struct req_capsule *pill,
2251                                   const struct req_msg_field *field)
2252 {
2253         return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2254 }
2255 EXPORT_SYMBOL(req_capsule_other_get);
2256
2257 /**
2258  * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2259  * field of the given \a pill.
2260  *
2261  * This function must be used when constructing variable sized fields of a
2262  * request or reply.
2263  */
2264 void req_capsule_set_size(struct req_capsule *pill,
2265                           const struct req_msg_field *field,
2266                           enum req_location loc, __u32 size)
2267 {
2268         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2269
2270         if ((size != (__u32)field->rmf_size) &&
2271             (field->rmf_size != -1) &&
2272             !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2273             (size > 0)) {
2274                 __u32 rmf_size = (__u32)field->rmf_size;
2275                 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2276                     (size % rmf_size != 0)) {
2277                         CERROR("%s: array field size mismatch "
2278                                 "%u %% %u != 0 (%d)\n",
2279                                 field->rmf_name, size, rmf_size, loc);
2280                         LBUG();
2281                 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2282                            size < rmf_size) {
2283                         CERROR("%s: field size mismatch %u != %u (%d)\n",
2284                                 field->rmf_name, size, rmf_size, loc);
2285                         LBUG();
2286                 }
2287         }
2288
2289         pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2290 }
2291 EXPORT_SYMBOL(req_capsule_set_size);
2292
2293 /**
2294  * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2295  * for the given \a pill's given \a field.
2296  *
2297  * NB: this function doesn't correspond with req_capsule_set_size(), which
2298  * actually sets the size in pill.rc_area[loc][offset], but this function
2299  * returns the message buflen[offset], maybe we should use another name.
2300  */
2301 __u32 req_capsule_get_size(const struct req_capsule *pill,
2302                          const struct req_msg_field *field,
2303                          enum req_location loc)
2304 {
2305         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2306
2307         return lustre_msg_buflen(__req_msg(pill, loc),
2308                                  __req_capsule_offset(pill, field, loc));
2309 }
2310 EXPORT_SYMBOL(req_capsule_get_size);
2311
2312 /**
2313  * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2314  * given \a pill's request or reply (\a loc) given the field size recorded in
2315  * the \a pill's rc_area.
2316  *
2317  * See also req_capsule_set_size().
2318  */
2319 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2320 {
2321         return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2322                                pill->rc_fmt->rf_fields[loc].nr,
2323                                pill->rc_area[loc]);
2324 }
2325
2326 /**
2327  * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2328  * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2329  * PTLRPC request or reply given only an RQF (\a fmt).
2330  *
2331  * This function should not be used for formats which contain variable size
2332  * fields.
2333  */
2334 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2335                          enum req_location loc)
2336 {
2337         __u32 size;
2338         size_t i = 0;
2339
2340         /*
2341          * This function should probably LASSERT() that fmt has no fields with
2342          * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2343          * elements in the array there will ultimately be, but then, we could
2344          * assume that there will be at least one element, and that's just what
2345          * we do.
2346          */
2347         size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2348         if (size == 0)
2349                 return size;
2350
2351         for (; i < fmt->rf_fields[loc].nr; ++i)
2352                 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2353                         size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2354                                                rmf_size);
2355         return size;
2356 }
2357
2358 /**
2359  * Changes the format of an RPC.
2360  *
2361  * The pill must already have been initialized, which means that it already has
2362  * a request format.  The new format \a fmt must be an extension of the pill's
2363  * old format.  Specifically: the new format must have as many request and reply
2364  * fields as the old one, and all fields shared by the old and new format must
2365  * be at least as large in the new format.
2366  *
2367  * The new format's fields may be of different "type" than the old format, but
2368  * only for fields that are "opaque" blobs: fields which have a) have no
2369  * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2370  * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK.  For example,
2371  * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2372  * according to the key field.  When the value, according to the key, contains a
2373  * structure (or array thereof) to be swabbed, the format should be changed to
2374  * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2375  * accordingly.
2376  */
2377 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2378 {
2379         int i;
2380         size_t j;
2381
2382         const struct req_format *old;
2383
2384         LASSERT(pill->rc_fmt != NULL);
2385         LASSERT(__req_format_is_sane(fmt));
2386
2387         old = pill->rc_fmt;
2388         /*
2389          * Sanity checking...
2390          */
2391         for (i = 0; i < RCL_NR; ++i) {
2392                 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2393                 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2394                         const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2395
2396                         /* "opaque" fields can be transmogrified */
2397                         if (ofield->rmf_swabber == NULL &&
2398                             (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2399                             (ofield->rmf_size == -1 ||
2400                             ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2401                                 continue;
2402                         LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2403                 }
2404                 /*
2405                  * Last field in old format can be shorter than in new.
2406                  */
2407                 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2408                         FMT_FIELD(old, i, j)->rmf_size);
2409         }
2410
2411         pill->rc_fmt = fmt;
2412 }
2413 EXPORT_SYMBOL(req_capsule_extend);
2414
2415 /**
2416  * This function returns a non-zero value if the given \a field is present in
2417  * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2418  * returns 0.
2419  */
2420 int req_capsule_has_field(const struct req_capsule *pill,
2421                           const struct req_msg_field *field,
2422                           enum req_location loc)
2423 {
2424         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2425
2426         return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2427 }
2428 EXPORT_SYMBOL(req_capsule_has_field);
2429
2430 /**
2431  * Returns a non-zero value if the given \a field is present in the given \a
2432  * pill's PTLRPC request or reply (\a loc), else it returns 0.
2433  */
2434 int req_capsule_field_present(const struct req_capsule *pill,
2435                               const struct req_msg_field *field,
2436                               enum req_location loc)
2437 {
2438         __u32 offset;
2439
2440         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2441         LASSERT(req_capsule_has_field(pill, field, loc));
2442
2443         offset = __req_capsule_offset(pill, field, loc);
2444         return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2445 }
2446 EXPORT_SYMBOL(req_capsule_field_present);
2447
2448 /**
2449  * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2450  * request or reply (\a loc).
2451  *
2452  * This is not the opposite of req_capsule_extend().
2453  */
2454 void req_capsule_shrink(struct req_capsule *pill,
2455                         const struct req_msg_field *field,
2456                         __u32 newlen,
2457                         enum req_location loc)
2458 {
2459         const struct req_format *fmt;
2460         struct lustre_msg       *msg;
2461         __u32                    len;
2462         int                      offset;
2463
2464         fmt = pill->rc_fmt;
2465         LASSERT(fmt != NULL);
2466         LASSERT(__req_format_is_sane(fmt));
2467         LASSERT(req_capsule_has_field(pill, field, loc));
2468         LASSERT(req_capsule_field_present(pill, field, loc));
2469
2470         offset = __req_capsule_offset(pill, field, loc);
2471
2472         msg = __req_msg(pill, loc);
2473         len = lustre_msg_buflen(msg, offset);
2474         LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2475                                 fmt->rf_name, field->rmf_name, len, newlen);
2476
2477         if (loc == RCL_CLIENT)
2478                 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2479                                                             1);
2480         else
2481                 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2482                                                             1);
2483 }
2484 EXPORT_SYMBOL(req_capsule_shrink);
2485
2486 int req_capsule_server_grow(struct req_capsule *pill,
2487                             const struct req_msg_field *field,
2488                             __u32 newlen)
2489 {
2490         struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2491         char *from, *to;
2492         int rc;
2493         __u32 offset, len;
2494
2495         LASSERT(pill->rc_fmt != NULL);
2496         LASSERT(__req_format_is_sane(pill->rc_fmt));
2497         LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2498         LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2499
2500         len = req_capsule_get_size(pill, field, RCL_SERVER);
2501         offset = __req_capsule_offset(pill, field, RCL_SERVER);
2502         if ((__u32)pill->rc_req->rq_repbuf_len >=
2503             lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2504                 CERROR("Inplace repack might be done\n");
2505
2506         pill->rc_req->rq_reply_state = NULL;
2507         req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2508         rc = req_capsule_server_pack(pill);
2509         if (rc) {
2510                 /* put old rs back, the caller will decide what to do */
2511                 pill->rc_req->rq_reply_state = rs;
2512                 return rc;
2513         }
2514         nrs = pill->rc_req->rq_reply_state;
2515         /* Now we need only buffers, copy first chunk */
2516         to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2517         from = lustre_msg_buf(rs->rs_msg, 0, 0);
2518         len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2519         memcpy(to, from, len);
2520         /* check if we have tail and copy it too */
2521         if (rs->rs_msg->lm_bufcount > offset + 1) {
2522                 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2523                 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2524                 offset = rs->rs_msg->lm_bufcount - 1;
2525                 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2526                       cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2527                 memcpy(to, from, len);
2528         }
2529         /* drop old reply if everything is fine */
2530         if (rs->rs_difficult) {
2531                 /* copy rs data */
2532                 int i;
2533
2534                 nrs->rs_difficult = 1;
2535                 nrs->rs_no_ack = rs->rs_no_ack;
2536                 for (i = 0; i < rs->rs_nlocks; i++) {
2537                         nrs->rs_locks[i] = rs->rs_locks[i];
2538                         nrs->rs_modes[i] = rs->rs_modes[i];
2539                         nrs->rs_nlocks++;
2540                 }
2541                 rs->rs_nlocks = 0;
2542                 rs->rs_difficult = 0;
2543                 rs->rs_no_ack = 0;
2544         }
2545         ptlrpc_rs_decref(rs);
2546         return 0;
2547 }
2548 EXPORT_SYMBOL(req_capsule_server_grow);
2549 /* __REQ_LAYOUT_USER__ */
2550 #endif