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