lustre/ptlrpc/layout.c

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