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