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_STATFS_NEW,
 740         &RQF_MDS_GETATTR,
 741         &RQF_MDS_GETATTR_NAME,
 742         &RQF_MDS_GETXATTR,
 743         &RQF_MDS_SYNC,
 744         &RQF_MDS_CLOSE,
 745         &RQF_MDS_CLOSE_INTENT,
 746         &RQF_MDS_READPAGE,
 747         &RQF_MDS_REINT,
 748         &RQF_MDS_REINT_CREATE,
 749         &RQF_MDS_REINT_CREATE_ACL,
 750         &RQF_MDS_REINT_CREATE_SLAVE,
 751         &RQF_MDS_REINT_CREATE_SYM,
 752         &RQF_MDS_REINT_OPEN,
 753         &RQF_MDS_REINT_UNLINK,
 754         &RQF_MDS_REINT_LINK,
 755         &RQF_MDS_REINT_RENAME,
 756         &RQF_MDS_REINT_MIGRATE,
 757         &RQF_MDS_REINT_SETATTR,
 758         &RQF_MDS_REINT_SETXATTR,
 759         &RQF_MDS_REINT_RESYNC,
 760         &RQF_MDS_QUOTACTL,
 761         &RQF_MDS_HSM_PROGRESS,
 762         &RQF_MDS_HSM_CT_REGISTER,
 763         &RQF_MDS_HSM_CT_UNREGISTER,
 764         &RQF_MDS_HSM_STATE_GET,
 765         &RQF_MDS_HSM_STATE_SET,
 766         &RQF_MDS_HSM_ACTION,
 767         &RQF_MDS_HSM_REQUEST,
 768         &RQF_MDS_SWAP_LAYOUTS,
 769         &RQF_OUT_UPDATE,
 770         &RQF_OST_CONNECT,
 771         &RQF_OST_DISCONNECT,
 772         &RQF_OST_QUOTACTL,
 773         &RQF_OST_GETATTR,
 774         &RQF_OST_SETATTR,
 775         &RQF_OST_CREATE,
 776         &RQF_OST_PUNCH,
 777         &RQF_OST_SYNC,
 778         &RQF_OST_DESTROY,
 779         &RQF_OST_BRW_READ,
 780         &RQF_OST_BRW_WRITE,
 781         &RQF_OST_STATFS,
 782         &RQF_OST_SET_GRANT_INFO,
 783         &RQF_OST_GET_INFO,
 784         &RQF_OST_GET_INFO_LAST_ID,
 785         &RQF_OST_GET_INFO_LAST_FID,
 786         &RQF_OST_SET_INFO_LAST_FID,
 787         &RQF_OST_GET_INFO_FIEMAP,
 788         &RQF_OST_LADVISE,
 789         &RQF_LDLM_ENQUEUE,
 790         &RQF_LDLM_ENQUEUE_LVB,
 791         &RQF_LDLM_CONVERT,
 792         &RQF_LDLM_CANCEL,
 793         &RQF_LDLM_CALLBACK,
 794         &RQF_LDLM_CP_CALLBACK,
 795         &RQF_LDLM_BL_CALLBACK,
 796         &RQF_LDLM_GL_CALLBACK,
 797         &RQF_LDLM_GL_CALLBACK_DESC,
 798         &RQF_LDLM_INTENT,
 799         &RQF_LDLM_INTENT_BASIC,
 800         &RQF_LDLM_INTENT_LAYOUT,
 801         &RQF_LDLM_INTENT_GETATTR,
 802         &RQF_LDLM_INTENT_OPEN,
 803         &RQF_LDLM_INTENT_CREATE,
 804         &RQF_LDLM_INTENT_GETXATTR,
 805         &RQF_LDLM_INTENT_QUOTA,
 806         &RQF_QUOTA_DQACQ,
 807         &RQF_LLOG_ORIGIN_HANDLE_CREATE,
 808         &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
 809         &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
 810         &RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
 811         &RQF_CONNECT,
 812         &RQF_LFSCK_NOTIFY,
 813         &RQF_LFSCK_QUERY,
 814 };
 815
 816 struct req_msg_field {
 817         const __u32 rmf_flags;
 818         const char  *rmf_name;
 819         /**
 820          * Field length. (-1) means "variable length".  If the
 821          * \a RMF_F_STRUCT_ARRAY flag is set the field is also variable-length,
 822          * but the actual size must be a whole multiple of \a rmf_size.
 823          */
 824         const int   rmf_size;
 825         void        (*rmf_swabber)(void *);
 826         void        (*rmf_dumper)(void *);
 827         int         rmf_offset[ARRAY_SIZE(req_formats)][RCL_NR];
 828 };
 829
 830 enum rmf_flags {
 831         /**
 832          * The field is a string, must be NUL-terminated.
 833          */
 834         RMF_F_STRING = 1 << 0,
 835         /**
 836          * The field's buffer size need not match the declared \a rmf_size.
 837          */
 838         RMF_F_NO_SIZE_CHECK = 1 << 1,
 839         /**
 840          * The field's buffer size must be a whole multiple of the declared \a
 841          * rmf_size and the \a rmf_swabber function must work on the declared \a
 842          * rmf_size worth of bytes.
 843          */
 844         RMF_F_STRUCT_ARRAY = 1 << 2
 845 };
 846
 847 struct req_capsule;
 848
 849 /*
 850  * Request fields.
 851  */
 852 #define DEFINE_MSGF(name, flags, size, swabber, dumper) {       \
 853         .rmf_name    = (name),                                  \
 854         .rmf_flags   = (flags),                                 \
 855         .rmf_size    = (size),                                  \
 856         .rmf_swabber = (void (*)(void*))(swabber),              \
 857         .rmf_dumper  = (void (*)(void*))(dumper)                \
 858 }
 859
 860 struct req_msg_field RMF_GENERIC_DATA =
 861         DEFINE_MSGF("generic_data", 0,
 862                     -1, NULL, NULL);
 863 EXPORT_SYMBOL(RMF_GENERIC_DATA);
 864
 865 struct req_msg_field RMF_MGS_TARGET_INFO =
 866         DEFINE_MSGF("mgs_target_info", 0,
 867                     sizeof(struct mgs_target_info),
 868                     lustre_swab_mgs_target_info, NULL);
 869 EXPORT_SYMBOL(RMF_MGS_TARGET_INFO);
 870
 871 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
 872 struct req_msg_field RMF_MGS_SEND_PARAM =
 873         DEFINE_MSGF("mgs_send_param", 0,
 874                     sizeof(struct mgs_send_param),
 875                     NULL, NULL);
 876 EXPORT_SYMBOL(RMF_MGS_SEND_PARAM);
 877 #endif
 878
 879 struct req_msg_field RMF_MGS_CONFIG_BODY =
 880         DEFINE_MSGF("mgs_config_read request", 0,
 881                     sizeof(struct mgs_config_body),
 882                     lustre_swab_mgs_config_body, NULL);
 883 EXPORT_SYMBOL(RMF_MGS_CONFIG_BODY);
 884
 885 struct req_msg_field RMF_MGS_CONFIG_RES =
 886         DEFINE_MSGF("mgs_config_read reply ", 0,
 887                     sizeof(struct mgs_config_res),
 888                     lustre_swab_mgs_config_res, NULL);
 889 EXPORT_SYMBOL(RMF_MGS_CONFIG_RES);
 890
 891 struct req_msg_field RMF_U32 =
 892         DEFINE_MSGF("generic u32", RMF_F_STRUCT_ARRAY,
 893                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 894 EXPORT_SYMBOL(RMF_U32);
 895
 896 struct req_msg_field RMF_SETINFO_VAL =
 897         DEFINE_MSGF("setinfo_val", 0, -1, NULL, NULL);
 898 EXPORT_SYMBOL(RMF_SETINFO_VAL);
 899
 900 struct req_msg_field RMF_GETINFO_KEY =
 901         DEFINE_MSGF("getinfo_key", 0, -1, NULL, NULL);
 902 EXPORT_SYMBOL(RMF_GETINFO_KEY);
 903
 904 struct req_msg_field RMF_GETINFO_VALLEN =
 905         DEFINE_MSGF("getinfo_vallen", 0,
 906                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 907 EXPORT_SYMBOL(RMF_GETINFO_VALLEN);
 908
 909 struct req_msg_field RMF_GETINFO_VAL =
 910         DEFINE_MSGF("getinfo_val", 0, -1, NULL, NULL);
 911 EXPORT_SYMBOL(RMF_GETINFO_VAL);
 912
 913 struct req_msg_field RMF_SEQ_OPC =
 914         DEFINE_MSGF("seq_query_opc", 0,
 915                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 916 EXPORT_SYMBOL(RMF_SEQ_OPC);
 917
 918 struct req_msg_field RMF_SEQ_RANGE =
 919         DEFINE_MSGF("seq_query_range", 0,
 920                     sizeof(struct lu_seq_range),
 921                     lustre_swab_lu_seq_range, NULL);
 922 EXPORT_SYMBOL(RMF_SEQ_RANGE);
 923
 924 struct req_msg_field RMF_FLD_OPC =
 925         DEFINE_MSGF("fld_query_opc", 0,
 926                     sizeof(__u32), lustre_swab_generic_32s, NULL);
 927 EXPORT_SYMBOL(RMF_FLD_OPC);
 928
 929 struct req_msg_field RMF_FLD_MDFLD =
 930         DEFINE_MSGF("fld_query_mdfld", 0,
 931                     sizeof(struct lu_seq_range),
 932                     lustre_swab_lu_seq_range, NULL);
 933 EXPORT_SYMBOL(RMF_FLD_MDFLD);
 934
 935 struct req_msg_field RMF_MDT_BODY =
 936         DEFINE_MSGF("mdt_body", 0,
 937                     sizeof(struct mdt_body), lustre_swab_mdt_body, NULL);
 938 EXPORT_SYMBOL(RMF_MDT_BODY);
 939
 940 struct req_msg_field RMF_OBD_QUOTACTL =
 941         DEFINE_MSGF("obd_quotactl", 0,
 942                     sizeof(struct obd_quotactl),
 943                     lustre_swab_obd_quotactl, NULL);
 944 EXPORT_SYMBOL(RMF_OBD_QUOTACTL);
 945
 946 struct req_msg_field RMF_QUOTA_BODY =
 947         DEFINE_MSGF("quota_body", 0,
 948                     sizeof(struct quota_body), lustre_swab_quota_body, NULL);
 949 EXPORT_SYMBOL(RMF_QUOTA_BODY);
 950
 951 struct req_msg_field RMF_MDT_EPOCH =
 952         DEFINE_MSGF("mdt_ioepoch", 0,
 953                     sizeof(struct mdt_ioepoch), lustre_swab_mdt_ioepoch, NULL);
 954 EXPORT_SYMBOL(RMF_MDT_EPOCH);
 955
 956 struct req_msg_field RMF_PTLRPC_BODY =
 957         DEFINE_MSGF("ptlrpc_body", 0,
 958                     sizeof(struct ptlrpc_body), lustre_swab_ptlrpc_body, NULL);
 959 EXPORT_SYMBOL(RMF_PTLRPC_BODY);
 960
 961 struct req_msg_field RMF_CLOSE_DATA =
 962         DEFINE_MSGF("data_version", 0,
 963                     sizeof(struct close_data), lustre_swab_close_data, NULL);
 964 EXPORT_SYMBOL(RMF_CLOSE_DATA);
 965
 966 struct req_msg_field RMF_OBD_STATFS =
 967         DEFINE_MSGF("obd_statfs", 0,
 968                     sizeof(struct obd_statfs), lustre_swab_obd_statfs, NULL);
 969 EXPORT_SYMBOL(RMF_OBD_STATFS);
 970
 971 struct req_msg_field RMF_SETINFO_KEY =
 972         DEFINE_MSGF("setinfo_key", 0, -1, NULL, NULL);
 973 EXPORT_SYMBOL(RMF_SETINFO_KEY);
 974
 975 struct req_msg_field RMF_NAME =
 976         DEFINE_MSGF("name", RMF_F_STRING, -1, NULL, NULL);
 977 EXPORT_SYMBOL(RMF_NAME);
 978
 979 struct req_msg_field RMF_SYMTGT =
 980         DEFINE_MSGF("symtgt", RMF_F_STRING, -1, NULL, NULL);
 981 EXPORT_SYMBOL(RMF_SYMTGT);
 982
 983 struct req_msg_field RMF_TGTUUID =
 984         DEFINE_MSGF("tgtuuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
 985         NULL);
 986 EXPORT_SYMBOL(RMF_TGTUUID);
 987
 988 struct req_msg_field RMF_CLUUID =
 989         DEFINE_MSGF("cluuid", RMF_F_STRING, sizeof(struct obd_uuid) - 1, NULL,
 990         NULL);
 991 EXPORT_SYMBOL(RMF_CLUUID);
 992
 993 struct req_msg_field RMF_STRING =
 994         DEFINE_MSGF("string", RMF_F_STRING, -1, NULL, NULL);
 995 EXPORT_SYMBOL(RMF_STRING);
 996
 997 struct req_msg_field RMF_FILE_SECCTX_NAME =
 998         DEFINE_MSGF("file_secctx_name", RMF_F_STRING, -1, NULL, NULL);
 999 EXPORT_SYMBOL(RMF_FILE_SECCTX_NAME);
1000
1001 struct req_msg_field RMF_FILE_SECCTX =
1002         DEFINE_MSGF("file_secctx", 0, -1, NULL, NULL);
1003 EXPORT_SYMBOL(RMF_FILE_SECCTX);
1004
1005 struct req_msg_field RMF_LLOGD_BODY =
1006         DEFINE_MSGF("llogd_body", 0,
1007                     sizeof(struct llogd_body), lustre_swab_llogd_body, NULL);
1008 EXPORT_SYMBOL(RMF_LLOGD_BODY);
1009
1010 struct req_msg_field RMF_LLOG_LOG_HDR =
1011         DEFINE_MSGF("llog_log_hdr", 0,
1012                     sizeof(struct llog_log_hdr), lustre_swab_llog_hdr, NULL);
1013 EXPORT_SYMBOL(RMF_LLOG_LOG_HDR);
1014
1015 struct req_msg_field RMF_LLOGD_CONN_BODY =
1016         DEFINE_MSGF("llogd_conn_body", 0,
1017                     sizeof(struct llogd_conn_body),
1018                     lustre_swab_llogd_conn_body, NULL);
1019 EXPORT_SYMBOL(RMF_LLOGD_CONN_BODY);
1020
1021 /*
1022  * connection handle received in MDS_CONNECT request.
1023  *
1024  * No swabbing needed because struct lustre_handle contains only a 64-bit cookie
1025  * that the client does not interpret at all.
1026  */
1027 struct req_msg_field RMF_CONN =
1028         DEFINE_MSGF("conn", 0, sizeof(struct lustre_handle), NULL, NULL);
1029 EXPORT_SYMBOL(RMF_CONN);
1030
1031 struct req_msg_field RMF_CONNECT_DATA =
1032         DEFINE_MSGF("cdata",
1033                     RMF_F_NO_SIZE_CHECK /* we allow extra space for interop */,
1034                     sizeof(struct obd_connect_data),
1035                     lustre_swab_connect, NULL);
1036 EXPORT_SYMBOL(RMF_CONNECT_DATA);
1037
1038 struct req_msg_field RMF_DLM_REQ =
1039         DEFINE_MSGF("dlm_req", RMF_F_NO_SIZE_CHECK /* ldlm_request_bufsize */,
1040                     sizeof(struct ldlm_request),
1041                     lustre_swab_ldlm_request, NULL);
1042 EXPORT_SYMBOL(RMF_DLM_REQ);
1043
1044 struct req_msg_field RMF_DLM_REP =
1045         DEFINE_MSGF("dlm_rep", 0,
1046                     sizeof(struct ldlm_reply), lustre_swab_ldlm_reply, NULL);
1047 EXPORT_SYMBOL(RMF_DLM_REP);
1048
1049 struct req_msg_field RMF_LDLM_INTENT =
1050         DEFINE_MSGF("ldlm_intent", 0,
1051                     sizeof(struct ldlm_intent), lustre_swab_ldlm_intent, NULL);
1052 EXPORT_SYMBOL(RMF_LDLM_INTENT);
1053
1054 struct req_msg_field RMF_DLM_LVB =
1055         DEFINE_MSGF("dlm_lvb", 0, -1, NULL, NULL);
1056 EXPORT_SYMBOL(RMF_DLM_LVB);
1057
1058 struct req_msg_field RMF_DLM_GL_DESC =
1059         DEFINE_MSGF("dlm_gl_desc", 0, sizeof(union ldlm_gl_desc), NULL, NULL);
1060 EXPORT_SYMBOL(RMF_DLM_GL_DESC);
1061
1062 struct req_msg_field RMF_MDT_MD =
1063         DEFINE_MSGF("mdt_md", RMF_F_NO_SIZE_CHECK, MIN_MD_SIZE, NULL, NULL);
1064 EXPORT_SYMBOL(RMF_MDT_MD);
1065
1066 struct req_msg_field RMF_REC_REINT =
1067         DEFINE_MSGF("rec_reint", 0, sizeof(struct mdt_rec_reint),
1068                     lustre_swab_mdt_rec_reint, NULL);
1069 EXPORT_SYMBOL(RMF_REC_REINT);
1070
1071 /* FIXME: this length should be defined as a macro */
1072 struct req_msg_field RMF_EADATA = DEFINE_MSGF("eadata", 0, -1,
1073                                                     NULL, NULL);
1074 EXPORT_SYMBOL(RMF_EADATA);
1075
1076 struct req_msg_field RMF_EAVALS = DEFINE_MSGF("eavals", 0, -1, NULL, NULL);
1077 EXPORT_SYMBOL(RMF_EAVALS);
1078
1079 struct req_msg_field RMF_ACL = DEFINE_MSGF("acl", 0, -1, NULL, NULL);
1080 EXPORT_SYMBOL(RMF_ACL);
1081
1082 /* FIXME: this should be made to use RMF_F_STRUCT_ARRAY */
1083 struct req_msg_field RMF_LOGCOOKIES =
1084         DEFINE_MSGF("logcookies", RMF_F_NO_SIZE_CHECK /* multiple cookies */,
1085                     sizeof(struct llog_cookie), NULL, NULL);
1086 EXPORT_SYMBOL(RMF_LOGCOOKIES);
1087
1088 struct req_msg_field RMF_CAPA1 =
1089         DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1090 EXPORT_SYMBOL(RMF_CAPA1);
1091
1092 struct req_msg_field RMF_CAPA2 =
1093         DEFINE_MSGF("capa", 0, 0, NULL, NULL);
1094 EXPORT_SYMBOL(RMF_CAPA2);
1095
1096 struct req_msg_field RMF_LAYOUT_INTENT =
1097         DEFINE_MSGF("layout_intent", 0,
1098                     sizeof(struct layout_intent), lustre_swab_layout_intent,
1099                     NULL);
1100 EXPORT_SYMBOL(RMF_LAYOUT_INTENT);
1101
1102 /*
1103  * OST request field.
1104  */
1105 struct req_msg_field RMF_OST_BODY =
1106         DEFINE_MSGF("ost_body", 0,
1107                     sizeof(struct ost_body), lustre_swab_ost_body,
1108                     dump_ost_body);
1109 EXPORT_SYMBOL(RMF_OST_BODY);
1110
1111 struct req_msg_field RMF_OBD_IOOBJ =
1112         DEFINE_MSGF("obd_ioobj", RMF_F_STRUCT_ARRAY,
1113                     sizeof(struct obd_ioobj), lustre_swab_obd_ioobj, dump_ioo);
1114 EXPORT_SYMBOL(RMF_OBD_IOOBJ);
1115
1116 struct req_msg_field RMF_NIOBUF_REMOTE =
1117         DEFINE_MSGF("niobuf_remote", RMF_F_STRUCT_ARRAY,
1118                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1119                     dump_rniobuf);
1120 EXPORT_SYMBOL(RMF_NIOBUF_REMOTE);
1121
1122 struct req_msg_field RMF_NIOBUF_INLINE =
1123         DEFINE_MSGF("niobuf_inline", RMF_F_NO_SIZE_CHECK,
1124                     sizeof(struct niobuf_remote), lustre_swab_niobuf_remote,
1125                     dump_rniobuf);
1126 EXPORT_SYMBOL(RMF_NIOBUF_INLINE);
1127
1128 struct req_msg_field RMF_RCS =
1129         DEFINE_MSGF("niobuf_rcs", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1130                     lustre_swab_generic_32s, dump_rcs);
1131 EXPORT_SYMBOL(RMF_RCS);
1132
1133 struct req_msg_field RMF_EAVALS_LENS =
1134         DEFINE_MSGF("eavals_lens", RMF_F_STRUCT_ARRAY, sizeof(__u32),
1135                 lustre_swab_generic_32s, NULL);
1136 EXPORT_SYMBOL(RMF_EAVALS_LENS);
1137
1138 struct req_msg_field RMF_OBD_ID =
1139         DEFINE_MSGF("obd_id", 0,
1140                     sizeof(__u64), lustre_swab_ost_last_id, NULL);
1141 EXPORT_SYMBOL(RMF_OBD_ID);
1142
1143 struct req_msg_field RMF_FID =
1144         DEFINE_MSGF("fid", 0,
1145                     sizeof(struct lu_fid), lustre_swab_lu_fid, NULL);
1146 EXPORT_SYMBOL(RMF_FID);
1147
1148 struct req_msg_field RMF_OST_ID =
1149         DEFINE_MSGF("ost_id", 0,
1150                     sizeof(struct ost_id), lustre_swab_ost_id, NULL);
1151 EXPORT_SYMBOL(RMF_OST_ID);
1152
1153 struct req_msg_field RMF_FIEMAP_KEY =
1154         DEFINE_MSGF("fiemap", 0, sizeof(struct ll_fiemap_info_key),
1155                     lustre_swab_fiemap, NULL);
1156 EXPORT_SYMBOL(RMF_FIEMAP_KEY);
1157
1158 struct req_msg_field RMF_FIEMAP_VAL =
1159         DEFINE_MSGF("fiemap", 0, -1, lustre_swab_fiemap, NULL);
1160 EXPORT_SYMBOL(RMF_FIEMAP_VAL);
1161
1162 struct req_msg_field RMF_IDX_INFO =
1163         DEFINE_MSGF("idx_info", 0, sizeof(struct idx_info),
1164                     lustre_swab_idx_info, NULL);
1165 EXPORT_SYMBOL(RMF_IDX_INFO);
1166 struct req_msg_field RMF_SHORT_IO =
1167         DEFINE_MSGF("short_io", 0, -1, NULL, NULL);
1168 EXPORT_SYMBOL(RMF_SHORT_IO);
1169 struct req_msg_field RMF_HSM_USER_STATE =
1170         DEFINE_MSGF("hsm_user_state", 0, sizeof(struct hsm_user_state),
1171                     lustre_swab_hsm_user_state, NULL);
1172 EXPORT_SYMBOL(RMF_HSM_USER_STATE);
1173
1174 struct req_msg_field RMF_HSM_STATE_SET =
1175         DEFINE_MSGF("hsm_state_set", 0, sizeof(struct hsm_state_set),
1176                     lustre_swab_hsm_state_set, NULL);
1177 EXPORT_SYMBOL(RMF_HSM_STATE_SET);
1178
1179 struct req_msg_field RMF_MDS_HSM_PROGRESS =
1180         DEFINE_MSGF("hsm_progress", 0, sizeof(struct hsm_progress_kernel),
1181                     lustre_swab_hsm_progress_kernel, NULL);
1182 EXPORT_SYMBOL(RMF_MDS_HSM_PROGRESS);
1183
1184 struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION =
1185         DEFINE_MSGF("hsm_current_action", 0, sizeof(struct hsm_current_action),
1186                     lustre_swab_hsm_current_action, NULL);
1187 EXPORT_SYMBOL(RMF_MDS_HSM_CURRENT_ACTION);
1188
1189 struct req_msg_field RMF_MDS_HSM_USER_ITEM =
1190         DEFINE_MSGF("hsm_user_item", RMF_F_STRUCT_ARRAY,
1191                     sizeof(struct hsm_user_item), lustre_swab_hsm_user_item,
1192                     NULL);
1193 EXPORT_SYMBOL(RMF_MDS_HSM_USER_ITEM);
1194
1195 struct req_msg_field RMF_MDS_HSM_ARCHIVE =
1196         DEFINE_MSGF("hsm_archive", 0,
1197                     sizeof(__u32), lustre_swab_generic_32s, NULL);
1198 EXPORT_SYMBOL(RMF_MDS_HSM_ARCHIVE);
1199
1200 struct req_msg_field RMF_MDS_HSM_REQUEST =
1201         DEFINE_MSGF("hsm_request", 0, sizeof(struct hsm_request),
1202                     lustre_swab_hsm_request, NULL);
1203 EXPORT_SYMBOL(RMF_MDS_HSM_REQUEST);
1204
1205 struct req_msg_field RMF_OUT_UPDATE = DEFINE_MSGF("object_update", 0, -1,
1206                                 lustre_swab_object_update_request, NULL);
1207 EXPORT_SYMBOL(RMF_OUT_UPDATE);
1208
1209 struct req_msg_field RMF_OUT_UPDATE_REPLY =
1210                         DEFINE_MSGF("object_update_reply", 0, -1,
1211                                     lustre_swab_object_update_reply, NULL);
1212 EXPORT_SYMBOL(RMF_OUT_UPDATE_REPLY);
1213
1214 struct req_msg_field RMF_SWAP_LAYOUTS =
1215         DEFINE_MSGF("swap_layouts", 0, sizeof(struct  mdc_swap_layouts),
1216                     lustre_swab_swap_layouts, NULL);
1217 EXPORT_SYMBOL(RMF_SWAP_LAYOUTS);
1218
1219 struct req_msg_field RMF_LFSCK_REQUEST =
1220         DEFINE_MSGF("lfsck_request", 0, sizeof(struct lfsck_request),
1221                     lustre_swab_lfsck_request, NULL);
1222 EXPORT_SYMBOL(RMF_LFSCK_REQUEST);
1223
1224 struct req_msg_field RMF_LFSCK_REPLY =
1225         DEFINE_MSGF("lfsck_reply", 0, sizeof(struct lfsck_reply),
1226                     lustre_swab_lfsck_reply, NULL);
1227 EXPORT_SYMBOL(RMF_LFSCK_REPLY);
1228
1229 struct req_msg_field RMF_OST_LADVISE_HDR =
1230         DEFINE_MSGF("ladvise_request", 0,
1231                     sizeof(struct ladvise_hdr),
1232                     lustre_swab_ladvise_hdr, NULL);
1233 EXPORT_SYMBOL(RMF_OST_LADVISE_HDR);
1234
1235 struct req_msg_field RMF_OST_LADVISE =
1236         DEFINE_MSGF("ladvise_request", RMF_F_STRUCT_ARRAY,
1237                     sizeof(struct lu_ladvise),
1238                     lustre_swab_ladvise, NULL);
1239 EXPORT_SYMBOL(RMF_OST_LADVISE);
1240
1241 struct req_msg_field RMF_OUT_UPDATE_HEADER = DEFINE_MSGF("out_update_header", 0,
1242                                 -1, lustre_swab_out_update_header, NULL);
1243 EXPORT_SYMBOL(RMF_OUT_UPDATE_HEADER);
1244
1245 struct req_msg_field RMF_OUT_UPDATE_BUF = DEFINE_MSGF("update_buf",
1246                         RMF_F_STRUCT_ARRAY, sizeof(struct out_update_buffer),
1247                         lustre_swab_out_update_buffer, NULL);
1248 EXPORT_SYMBOL(RMF_OUT_UPDATE_BUF);
1249
1250 /*
1251  * Request formats.
1252  */
1253
1254 struct req_format {
1255         const char *rf_name;
1256         size_t      rf_idx;
1257         struct {
1258                 size_t                       nr;
1259                 const struct req_msg_field **d;
1260         } rf_fields[RCL_NR];
1261 };
1262
1263 #define DEFINE_REQ_FMT(name, client, client_nr, server, server_nr) {    \
1264         .rf_name   = name,                                              \
1265         .rf_fields = {                                                  \
1266                 [RCL_CLIENT] = {                                        \
1267                         .nr = client_nr,                                \
1268                         .d  = client                                    \
1269                 },                                                      \
1270                 [RCL_SERVER] = {                                        \
1271                         .nr = server_nr,                                \
1272                         .d  = server                                    \
1273                 }                                                       \
1274         }                                                               \
1275 }
1276
1277 #define DEFINE_REQ_FMT0(name, client, server)                                  \
1278 DEFINE_REQ_FMT(name, client, ARRAY_SIZE(client), server, ARRAY_SIZE(server))
1279
1280 struct req_format RQF_OBD_PING =
1281         DEFINE_REQ_FMT0("OBD_PING", empty, empty);
1282 EXPORT_SYMBOL(RQF_OBD_PING);
1283
1284 struct req_format RQF_OBD_SET_INFO =
1285         DEFINE_REQ_FMT0("OBD_SET_INFO", obd_set_info_client, empty);
1286 EXPORT_SYMBOL(RQF_OBD_SET_INFO);
1287
1288 /* Read index file through the network */
1289 struct req_format RQF_OBD_IDX_READ =
1290         DEFINE_REQ_FMT0("OBD_IDX_READ",
1291                         obd_idx_read_client, obd_idx_read_server);
1292 EXPORT_SYMBOL(RQF_OBD_IDX_READ);
1293
1294 struct req_format RQF_SEC_CTX =
1295         DEFINE_REQ_FMT0("SEC_CTX", empty, empty);
1296 EXPORT_SYMBOL(RQF_SEC_CTX);
1297
1298 struct req_format RQF_MGS_TARGET_REG =
1299         DEFINE_REQ_FMT0("MGS_TARGET_REG", mgs_target_info_only,
1300                          mgs_target_info_only);
1301 EXPORT_SYMBOL(RQF_MGS_TARGET_REG);
1302
1303 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
1304 struct req_format RQF_MGS_SET_INFO =
1305         DEFINE_REQ_FMT0("MGS_SET_INFO", mgs_set_info,
1306                          mgs_set_info);
1307 EXPORT_SYMBOL(RQF_MGS_SET_INFO);
1308 #endif
1309
1310 struct req_format RQF_MGS_CONFIG_READ =
1311         DEFINE_REQ_FMT0("MGS_CONFIG_READ", mgs_config_read_client,
1312                          mgs_config_read_server);
1313 EXPORT_SYMBOL(RQF_MGS_CONFIG_READ);
1314
1315 struct req_format RQF_SEQ_QUERY =
1316         DEFINE_REQ_FMT0("SEQ_QUERY", seq_query_client, seq_query_server);
1317 EXPORT_SYMBOL(RQF_SEQ_QUERY);
1318
1319 struct req_format RQF_FLD_QUERY =
1320         DEFINE_REQ_FMT0("FLD_QUERY", fld_query_client, fld_query_server);
1321 EXPORT_SYMBOL(RQF_FLD_QUERY);
1322
1323 /* The 'fld_read_server' uses 'RMF_GENERIC_DATA' to hold the 'FLD_QUERY'
1324  * RPC reply that is composed of 'struct lu_seq_range_array'. But there
1325  * is not registered swabber function for 'RMF_GENERIC_DATA'. So the RPC
1326  * peers need to handle the RPC reply with fixed little-endian format.
1327  *
1328  * In theory, we can define new structure with some swabber registered to
1329  * handle the 'FLD_QUERY' RPC reply result automatically. But from the
1330  * implementation view, it is not easy to be done within current "struct
1331  * req_msg_field" framework. Because the sequence range array in the RPC
1332  * reply is not fixed length, instead, its length depends on 'lu_seq_range'
1333  * count, that is unknown when prepare the RPC buffer. Generally, for such
1334  * flexible length RPC usage, there will be a field in the RPC layout to
1335  * indicate the data length. But for the 'FLD_READ' RPC, we have no way to
1336  * do that unless we add new length filed that will broken the on-wire RPC
1337  * protocol and cause interoperability trouble with old peer. */
1338 struct req_format RQF_FLD_READ =
1339         DEFINE_REQ_FMT0("FLD_READ", fld_read_client, fld_read_server);
1340 EXPORT_SYMBOL(RQF_FLD_READ);
1341
1342 struct req_format RQF_MDS_QUOTACTL =
1343         DEFINE_REQ_FMT0("MDS_QUOTACTL", quotactl_only, quotactl_only);
1344 EXPORT_SYMBOL(RQF_MDS_QUOTACTL);
1345
1346 struct req_format RQF_OST_QUOTACTL =
1347         DEFINE_REQ_FMT0("OST_QUOTACTL", quotactl_only, quotactl_only);
1348 EXPORT_SYMBOL(RQF_OST_QUOTACTL);
1349
1350 struct req_format RQF_QUOTA_DQACQ =
1351         DEFINE_REQ_FMT0("QUOTA_DQACQ", quota_body_only, quota_body_only);
1352 EXPORT_SYMBOL(RQF_QUOTA_DQACQ);
1353
1354 struct req_format RQF_LDLM_INTENT_QUOTA =
1355         DEFINE_REQ_FMT0("LDLM_INTENT_QUOTA",
1356                         ldlm_intent_quota_client,
1357                         ldlm_intent_quota_server);
1358 EXPORT_SYMBOL(RQF_LDLM_INTENT_QUOTA);
1359
1360 struct req_format RQF_MDS_GET_ROOT =
1361         DEFINE_REQ_FMT0("MDS_GET_ROOT", mds_get_root_client, mdt_body_capa);
1362 EXPORT_SYMBOL(RQF_MDS_GET_ROOT);
1363
1364 struct req_format RQF_MDS_STATFS =
1365         DEFINE_REQ_FMT0("MDS_STATFS", empty, obd_statfs_server);
1366 EXPORT_SYMBOL(RQF_MDS_STATFS);
1367
1368 struct req_format RQF_MDS_STATFS_NEW =
1369         DEFINE_REQ_FMT0("MDS_STATFS_NEW", mdt_body_only, obd_statfs_server);
1370 EXPORT_SYMBOL(RQF_MDS_STATFS_NEW);
1371
1372 struct req_format RQF_MDS_SYNC =
1373         DEFINE_REQ_FMT0("MDS_SYNC", mdt_body_capa, mdt_body_only);
1374 EXPORT_SYMBOL(RQF_MDS_SYNC);
1375
1376 struct req_format RQF_MDS_GETATTR =
1377         DEFINE_REQ_FMT0("MDS_GETATTR", mdt_body_capa, mds_getattr_server);
1378 EXPORT_SYMBOL(RQF_MDS_GETATTR);
1379
1380 struct req_format RQF_MDS_GETXATTR =
1381         DEFINE_REQ_FMT0("MDS_GETXATTR",
1382                         mds_getxattr_client, mds_getxattr_server);
1383 EXPORT_SYMBOL(RQF_MDS_GETXATTR);
1384
1385 struct req_format RQF_MDS_GETATTR_NAME =
1386         DEFINE_REQ_FMT0("MDS_GETATTR_NAME",
1387                         mds_getattr_name_client, mds_getattr_server);
1388 EXPORT_SYMBOL(RQF_MDS_GETATTR_NAME);
1389
1390 struct req_format RQF_MDS_REINT =
1391         DEFINE_REQ_FMT0("MDS_REINT", mds_reint_client, mdt_body_only);
1392 EXPORT_SYMBOL(RQF_MDS_REINT);
1393
1394 struct req_format RQF_MDS_REINT_CREATE =
1395         DEFINE_REQ_FMT0("MDS_REINT_CREATE",
1396                         mds_reint_create_client, mdt_body_capa);
1397 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE);
1398
1399 struct req_format RQF_MDS_REINT_CREATE_ACL =
1400         DEFINE_REQ_FMT0("MDS_REINT_CREATE_ACL",
1401                         mds_reint_create_acl_client, mdt_body_capa);
1402 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_ACL);
1403
1404 struct req_format RQF_MDS_REINT_CREATE_SLAVE =
1405         DEFINE_REQ_FMT0("MDS_REINT_CREATE_EA",
1406                         mds_reint_create_slave_client, mdt_body_capa);
1407 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SLAVE);
1408
1409 struct req_format RQF_MDS_REINT_CREATE_SYM =
1410         DEFINE_REQ_FMT0("MDS_REINT_CREATE_SYM",
1411                         mds_reint_create_sym_client, mdt_body_capa);
1412 EXPORT_SYMBOL(RQF_MDS_REINT_CREATE_SYM);
1413
1414 struct req_format RQF_MDS_REINT_OPEN =
1415         DEFINE_REQ_FMT0("MDS_REINT_OPEN",
1416                         mds_reint_open_client, mds_reint_open_server);
1417 EXPORT_SYMBOL(RQF_MDS_REINT_OPEN);
1418
1419 struct req_format RQF_MDS_REINT_UNLINK =
1420         DEFINE_REQ_FMT0("MDS_REINT_UNLINK", mds_reint_unlink_client,
1421                         mds_last_unlink_server);
1422 EXPORT_SYMBOL(RQF_MDS_REINT_UNLINK);
1423
1424 struct req_format RQF_MDS_REINT_LINK =
1425         DEFINE_REQ_FMT0("MDS_REINT_LINK",
1426                         mds_reint_link_client, mdt_body_only);
1427 EXPORT_SYMBOL(RQF_MDS_REINT_LINK);
1428
1429 struct req_format RQF_MDS_REINT_RENAME =
1430         DEFINE_REQ_FMT0("MDS_REINT_RENAME", mds_reint_rename_client,
1431                         mds_last_unlink_server);
1432 EXPORT_SYMBOL(RQF_MDS_REINT_RENAME);
1433
1434 struct req_format RQF_MDS_REINT_MIGRATE =
1435         DEFINE_REQ_FMT0("MDS_REINT_MIGRATE", mds_reint_migrate_client,
1436                         mds_last_unlink_server);
1437 EXPORT_SYMBOL(RQF_MDS_REINT_MIGRATE);
1438
1439 struct req_format RQF_MDS_REINT_SETATTR =
1440         DEFINE_REQ_FMT0("MDS_REINT_SETATTR",
1441                         mds_reint_setattr_client, mds_setattr_server);
1442 EXPORT_SYMBOL(RQF_MDS_REINT_SETATTR);
1443
1444 struct req_format RQF_MDS_REINT_SETXATTR =
1445         DEFINE_REQ_FMT0("MDS_REINT_SETXATTR",
1446                         mds_reint_setxattr_client, mdt_body_only);
1447 EXPORT_SYMBOL(RQF_MDS_REINT_SETXATTR);
1448
1449 struct req_format RQF_MDS_REINT_RESYNC =
1450         DEFINE_REQ_FMT0("MDS_REINT_RESYNC", mds_reint_resync, mdt_body_only);
1451 EXPORT_SYMBOL(RQF_MDS_REINT_RESYNC);
1452
1453 struct req_format RQF_MDS_CONNECT =
1454         DEFINE_REQ_FMT0("MDS_CONNECT",
1455                         obd_connect_client, obd_connect_server);
1456 EXPORT_SYMBOL(RQF_MDS_CONNECT);
1457
1458 struct req_format RQF_MDS_DISCONNECT =
1459         DEFINE_REQ_FMT0("MDS_DISCONNECT", empty, empty);
1460 EXPORT_SYMBOL(RQF_MDS_DISCONNECT);
1461
1462 struct req_format RQF_MDS_GET_INFO =
1463         DEFINE_REQ_FMT0("MDS_GET_INFO", mds_getinfo_client,
1464                         mds_getinfo_server);
1465 EXPORT_SYMBOL(RQF_MDS_GET_INFO);
1466
1467 struct req_format RQF_OUT_UPDATE =
1468         DEFINE_REQ_FMT0("OUT_UPDATE", mds_update_client,
1469                         mds_update_server);
1470 EXPORT_SYMBOL(RQF_OUT_UPDATE);
1471
1472 struct req_format RQF_LDLM_ENQUEUE =
1473         DEFINE_REQ_FMT0("LDLM_ENQUEUE",
1474                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1475 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE);
1476
1477 struct req_format RQF_LDLM_ENQUEUE_LVB =
1478         DEFINE_REQ_FMT0("LDLM_ENQUEUE_LVB",
1479                         ldlm_enqueue_client, ldlm_enqueue_lvb_server);
1480 EXPORT_SYMBOL(RQF_LDLM_ENQUEUE_LVB);
1481
1482 struct req_format RQF_LDLM_CONVERT =
1483         DEFINE_REQ_FMT0("LDLM_CONVERT",
1484                         ldlm_enqueue_client, ldlm_enqueue_server);
1485 EXPORT_SYMBOL(RQF_LDLM_CONVERT);
1486
1487 struct req_format RQF_LDLM_CANCEL =
1488         DEFINE_REQ_FMT0("LDLM_CANCEL", ldlm_enqueue_client, empty);
1489 EXPORT_SYMBOL(RQF_LDLM_CANCEL);
1490
1491 struct req_format RQF_LDLM_CALLBACK =
1492         DEFINE_REQ_FMT0("LDLM_CALLBACK", ldlm_enqueue_client, empty);
1493 EXPORT_SYMBOL(RQF_LDLM_CALLBACK);
1494
1495 struct req_format RQF_LDLM_CP_CALLBACK =
1496         DEFINE_REQ_FMT0("LDLM_CP_CALLBACK", ldlm_cp_callback_client, empty);
1497 EXPORT_SYMBOL(RQF_LDLM_CP_CALLBACK);
1498
1499 struct req_format RQF_LDLM_BL_CALLBACK =
1500         DEFINE_REQ_FMT0("LDLM_BL_CALLBACK", ldlm_enqueue_client, empty);
1501 EXPORT_SYMBOL(RQF_LDLM_BL_CALLBACK);
1502
1503 struct req_format RQF_LDLM_GL_CALLBACK =
1504         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_enqueue_client,
1505                         ldlm_gl_callback_server);
1506 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK);
1507
1508 struct req_format RQF_LDLM_GL_CALLBACK_DESC =
1509         DEFINE_REQ_FMT0("LDLM_GL_CALLBACK", ldlm_gl_callback_desc_client,
1510                         ldlm_gl_callback_server);
1511 EXPORT_SYMBOL(RQF_LDLM_GL_CALLBACK_DESC);
1512
1513 struct req_format RQF_LDLM_INTENT_BASIC =
1514         DEFINE_REQ_FMT0("LDLM_INTENT_BASIC",
1515                         ldlm_intent_basic_client, ldlm_enqueue_lvb_server);
1516 EXPORT_SYMBOL(RQF_LDLM_INTENT_BASIC);
1517
1518 struct req_format RQF_LDLM_INTENT =
1519         DEFINE_REQ_FMT0("LDLM_INTENT",
1520                         ldlm_intent_client, ldlm_intent_server);
1521 EXPORT_SYMBOL(RQF_LDLM_INTENT);
1522
1523 struct req_format RQF_LDLM_INTENT_LAYOUT =
1524         DEFINE_REQ_FMT0("LDLM_INTENT_LAYOUT",
1525                         ldlm_intent_layout_client, ldlm_enqueue_lvb_server);
1526 EXPORT_SYMBOL(RQF_LDLM_INTENT_LAYOUT);
1527
1528 struct req_format RQF_LDLM_INTENT_GETATTR =
1529         DEFINE_REQ_FMT0("LDLM_INTENT_GETATTR",
1530                         ldlm_intent_getattr_client, ldlm_intent_getattr_server);
1531 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETATTR);
1532
1533 struct req_format RQF_LDLM_INTENT_OPEN =
1534         DEFINE_REQ_FMT0("LDLM_INTENT_OPEN",
1535                         ldlm_intent_open_client, ldlm_intent_open_server);
1536 EXPORT_SYMBOL(RQF_LDLM_INTENT_OPEN);
1537
1538 struct req_format RQF_LDLM_INTENT_CREATE =
1539         DEFINE_REQ_FMT0("LDLM_INTENT_CREATE",
1540                         ldlm_intent_create_client, ldlm_intent_getattr_server);
1541 EXPORT_SYMBOL(RQF_LDLM_INTENT_CREATE);
1542
1543 struct req_format RQF_LDLM_INTENT_GETXATTR =
1544         DEFINE_REQ_FMT0("LDLM_INTENT_GETXATTR",
1545                         ldlm_intent_getxattr_client,
1546                         ldlm_intent_getxattr_server);
1547 EXPORT_SYMBOL(RQF_LDLM_INTENT_GETXATTR);
1548
1549 struct req_format RQF_MDS_CLOSE =
1550         DEFINE_REQ_FMT0("MDS_CLOSE",
1551                         mdt_close_client, mds_last_unlink_server);
1552 EXPORT_SYMBOL(RQF_MDS_CLOSE);
1553
1554 struct req_format RQF_MDS_CLOSE_INTENT =
1555         DEFINE_REQ_FMT0("MDS_CLOSE_INTENT",
1556                         mdt_close_intent_client, mds_last_unlink_server);
1557 EXPORT_SYMBOL(RQF_MDS_CLOSE_INTENT);
1558
1559 struct req_format RQF_MDS_READPAGE =
1560         DEFINE_REQ_FMT0("MDS_READPAGE",
1561                         mdt_body_capa, mdt_body_only);
1562 EXPORT_SYMBOL(RQF_MDS_READPAGE);
1563
1564 struct req_format RQF_MDS_HSM_ACTION =
1565         DEFINE_REQ_FMT0("MDS_HSM_ACTION", mdt_body_capa, mdt_hsm_action_server);
1566 EXPORT_SYMBOL(RQF_MDS_HSM_ACTION);
1567
1568 struct req_format RQF_MDS_HSM_PROGRESS =
1569         DEFINE_REQ_FMT0("MDS_HSM_PROGRESS", mdt_hsm_progress, empty);
1570 EXPORT_SYMBOL(RQF_MDS_HSM_PROGRESS);
1571
1572 struct req_format RQF_MDS_HSM_CT_REGISTER =
1573         DEFINE_REQ_FMT0("MDS_HSM_CT_REGISTER", mdt_hsm_ct_register, empty);
1574 EXPORT_SYMBOL(RQF_MDS_HSM_CT_REGISTER);
1575
1576 struct req_format RQF_MDS_HSM_CT_UNREGISTER =
1577         DEFINE_REQ_FMT0("MDS_HSM_CT_UNREGISTER", mdt_hsm_ct_unregister, empty);
1578 EXPORT_SYMBOL(RQF_MDS_HSM_CT_UNREGISTER);
1579
1580 struct req_format RQF_MDS_HSM_STATE_GET =
1581         DEFINE_REQ_FMT0("MDS_HSM_STATE_GET",
1582                         mdt_body_capa, mdt_hsm_state_get_server);
1583 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_GET);
1584
1585 struct req_format RQF_MDS_HSM_STATE_SET =
1586         DEFINE_REQ_FMT0("MDS_HSM_STATE_SET", mdt_hsm_state_set, empty);
1587 EXPORT_SYMBOL(RQF_MDS_HSM_STATE_SET);
1588
1589 struct req_format RQF_MDS_HSM_REQUEST =
1590         DEFINE_REQ_FMT0("MDS_HSM_REQUEST", mdt_hsm_request, empty);
1591 EXPORT_SYMBOL(RQF_MDS_HSM_REQUEST);
1592
1593 struct req_format RQF_MDS_SWAP_LAYOUTS =
1594         DEFINE_REQ_FMT0("MDS_SWAP_LAYOUTS",
1595                         mdt_swap_layouts, empty);
1596 EXPORT_SYMBOL(RQF_MDS_SWAP_LAYOUTS);
1597
1598 struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE =
1599         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_CREATE",
1600                         llog_origin_handle_create_client, llogd_body_only);
1601 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_CREATE);
1602
1603 struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK =
1604         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_NEXT_BLOCK",
1605                         llogd_body_only, llog_origin_handle_next_block_server);
1606 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
1607
1608 struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK =
1609         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_PREV_BLOCK",
1610                         llogd_body_only, llog_origin_handle_next_block_server);
1611 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK);
1612
1613 struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER =
1614         DEFINE_REQ_FMT0("LLOG_ORIGIN_HANDLE_READ_HEADER",
1615                         llogd_body_only, llog_log_hdr_only);
1616 EXPORT_SYMBOL(RQF_LLOG_ORIGIN_HANDLE_READ_HEADER);
1617
1618 struct req_format RQF_CONNECT =
1619         DEFINE_REQ_FMT0("CONNECT", obd_connect_client, obd_connect_server);
1620 EXPORT_SYMBOL(RQF_CONNECT);
1621
1622 struct req_format RQF_OST_CONNECT =
1623         DEFINE_REQ_FMT0("OST_CONNECT",
1624                         obd_connect_client, obd_connect_server);
1625 EXPORT_SYMBOL(RQF_OST_CONNECT);
1626
1627 struct req_format RQF_OST_DISCONNECT =
1628         DEFINE_REQ_FMT0("OST_DISCONNECT", empty, empty);
1629 EXPORT_SYMBOL(RQF_OST_DISCONNECT);
1630
1631 struct req_format RQF_OST_GETATTR =
1632         DEFINE_REQ_FMT0("OST_GETATTR", ost_body_capa, ost_body_only);
1633 EXPORT_SYMBOL(RQF_OST_GETATTR);
1634
1635 struct req_format RQF_OST_SETATTR =
1636         DEFINE_REQ_FMT0("OST_SETATTR", ost_body_capa, ost_body_only);
1637 EXPORT_SYMBOL(RQF_OST_SETATTR);
1638
1639 struct req_format RQF_OST_CREATE =
1640         DEFINE_REQ_FMT0("OST_CREATE", ost_body_only, ost_body_only);
1641 EXPORT_SYMBOL(RQF_OST_CREATE);
1642
1643 struct req_format RQF_OST_PUNCH =
1644         DEFINE_REQ_FMT0("OST_PUNCH", ost_body_capa, ost_body_only);
1645 EXPORT_SYMBOL(RQF_OST_PUNCH);
1646
1647 struct req_format RQF_OST_SYNC =
1648         DEFINE_REQ_FMT0("OST_SYNC", ost_body_capa, ost_body_only);
1649 EXPORT_SYMBOL(RQF_OST_SYNC);
1650
1651 struct req_format RQF_OST_DESTROY =
1652         DEFINE_REQ_FMT0("OST_DESTROY", ost_destroy_client, ost_body_only);
1653 EXPORT_SYMBOL(RQF_OST_DESTROY);
1654
1655 struct req_format RQF_OST_BRW_READ =
1656         DEFINE_REQ_FMT0("OST_BRW_READ", ost_brw_client, ost_brw_read_server);
1657 EXPORT_SYMBOL(RQF_OST_BRW_READ);
1658
1659 struct req_format RQF_OST_BRW_WRITE =
1660         DEFINE_REQ_FMT0("OST_BRW_WRITE", ost_brw_client, ost_brw_write_server);
1661 EXPORT_SYMBOL(RQF_OST_BRW_WRITE);
1662
1663 struct req_format RQF_OST_STATFS =
1664         DEFINE_REQ_FMT0("OST_STATFS", empty, obd_statfs_server);
1665 EXPORT_SYMBOL(RQF_OST_STATFS);
1666
1667 struct req_format RQF_OST_SET_GRANT_INFO =
1668         DEFINE_REQ_FMT0("OST_SET_GRANT_INFO", ost_grant_shrink_client,
1669                          ost_body_only);
1670 EXPORT_SYMBOL(RQF_OST_SET_GRANT_INFO);
1671
1672 struct req_format RQF_OST_GET_INFO =
1673         DEFINE_REQ_FMT0("OST_GET_INFO", ost_get_info_generic_client,
1674                                         ost_get_info_generic_server);
1675 EXPORT_SYMBOL(RQF_OST_GET_INFO);
1676
1677 struct req_format RQF_OST_GET_INFO_LAST_ID =
1678         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_ID", ost_get_info_generic_client,
1679                                                 ost_get_last_id_server);
1680 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_ID);
1681
1682 struct req_format RQF_OST_GET_INFO_LAST_FID =
1683         DEFINE_REQ_FMT0("OST_GET_INFO_LAST_FID", ost_get_last_fid_client,
1684                                                  ost_get_last_fid_server);
1685 EXPORT_SYMBOL(RQF_OST_GET_INFO_LAST_FID);
1686
1687 struct req_format RQF_OST_SET_INFO_LAST_FID =
1688         DEFINE_REQ_FMT0("OST_SET_INFO_LAST_FID", obd_set_info_client,
1689                                                  empty);
1690 EXPORT_SYMBOL(RQF_OST_SET_INFO_LAST_FID);
1691
1692 struct req_format RQF_OST_GET_INFO_FIEMAP =
1693         DEFINE_REQ_FMT0("OST_GET_INFO_FIEMAP", ost_get_fiemap_client,
1694                                                ost_get_fiemap_server);
1695 EXPORT_SYMBOL(RQF_OST_GET_INFO_FIEMAP);
1696
1697 struct req_format RQF_LFSCK_NOTIFY =
1698         DEFINE_REQ_FMT0("LFSCK_NOTIFY", obd_lfsck_request, empty);
1699 EXPORT_SYMBOL(RQF_LFSCK_NOTIFY);
1700
1701 struct req_format RQF_LFSCK_QUERY =
1702         DEFINE_REQ_FMT0("LFSCK_QUERY", obd_lfsck_request, obd_lfsck_reply);
1703 EXPORT_SYMBOL(RQF_LFSCK_QUERY);
1704
1705 struct req_format RQF_OST_LADVISE =
1706         DEFINE_REQ_FMT0("OST_LADVISE", ost_ladvise, ost_body_only);
1707 EXPORT_SYMBOL(RQF_OST_LADVISE);
1708
1709 /* Convenience macro */
1710 #define FMT_FIELD(fmt, i, j) (fmt)->rf_fields[(i)].d[(j)]
1711
1712 /**
1713  * Initializes the capsule abstraction by computing and setting the \a rf_idx
1714  * field of RQFs and the \a rmf_offset field of RMFs.
1715  */
1716 int req_layout_init(void)
1717 {
1718         size_t i;
1719         size_t j;
1720         size_t k;
1721         struct req_format *rf = NULL;
1722
1723         for (i = 0; i < ARRAY_SIZE(req_formats); ++i) {
1724                 rf = req_formats[i];
1725                 rf->rf_idx = i;
1726                 for (j = 0; j < RCL_NR; ++j) {
1727                         LASSERT(rf->rf_fields[j].nr <= REQ_MAX_FIELD_NR);
1728                         for (k = 0; k < rf->rf_fields[j].nr; ++k) {
1729                                 struct req_msg_field *field;
1730
1731                                 field = (typeof(field))rf->rf_fields[j].d[k];
1732                                 LASSERT(!(field->rmf_flags & RMF_F_STRUCT_ARRAY)
1733                                         || field->rmf_size > 0);
1734                                 LASSERT(field->rmf_offset[i][j] == 0);
1735                                 /*
1736                                  * k + 1 to detect unused format/field
1737                                  * combinations.
1738                                  */
1739                                 field->rmf_offset[i][j] = k + 1;
1740                         }
1741                 }
1742         }
1743         return 0;
1744 }
1745 EXPORT_SYMBOL(req_layout_init);
1746
1747 void req_layout_fini(void)
1748 {
1749 }
1750 EXPORT_SYMBOL(req_layout_fini);
1751
1752 /**
1753  * Initializes the expected sizes of each RMF in a \a pill (\a rc_area) to -1.
1754  *
1755  * Actual/expected field sizes are set elsewhere in functions in this file:
1756  * req_capsule_init(), req_capsule_server_pack(), req_capsule_set_size() and
1757  * req_capsule_msg_size().  The \a rc_area information is used by.
1758  * ptlrpc_request_set_replen().
1759  */
1760 void req_capsule_init_area(struct req_capsule *pill)
1761 {
1762         size_t i;
1763
1764         for (i = 0; i < ARRAY_SIZE(pill->rc_area[RCL_CLIENT]); i++) {
1765                 pill->rc_area[RCL_CLIENT][i] = -1;
1766                 pill->rc_area[RCL_SERVER][i] = -1;
1767         }
1768 }
1769 EXPORT_SYMBOL(req_capsule_init_area);
1770
1771 /**
1772  * Initialize a pill.
1773  *
1774  * The \a location indicates whether the caller is executing on the client side
1775  * (RCL_CLIENT) or server side (RCL_SERVER)..
1776  */
1777 void req_capsule_init(struct req_capsule *pill,
1778                       struct ptlrpc_request *req,
1779                       enum req_location location)
1780 {
1781         LASSERT(location == RCL_SERVER || location == RCL_CLIENT);
1782
1783         /*
1784          * Today all capsules are embedded in ptlrpc_request structs,
1785          * but just in case that ever isn't the case, we don't reach
1786          * into req unless req != NULL and pill is the one embedded in
1787          * the req.
1788          *
1789          * The req->rq_pill_init flag makes it safe to initialize a pill
1790          * twice, which might happen in the OST paths as a result of the
1791          * high-priority RPC queue getting peeked at before ost_handle()
1792          * handles an OST RPC.
1793          */
1794         if (req != NULL && pill == &req->rq_pill && req->rq_pill_init)
1795                 return;
1796
1797         memset(pill, 0, sizeof *pill);
1798         pill->rc_req = req;
1799         pill->rc_loc = location;
1800         req_capsule_init_area(pill);
1801
1802         if (req != NULL && pill == &req->rq_pill)
1803                 req->rq_pill_init = 1;
1804 }
1805 EXPORT_SYMBOL(req_capsule_init);
1806
1807 void req_capsule_fini(struct req_capsule *pill)
1808 {
1809 }
1810 EXPORT_SYMBOL(req_capsule_fini);
1811
1812 static int __req_format_is_sane(const struct req_format *fmt)
1813 {
1814         return fmt->rf_idx < ARRAY_SIZE(req_formats) &&
1815                 req_formats[fmt->rf_idx] == fmt;
1816 }
1817
1818 static struct lustre_msg *__req_msg(const struct req_capsule *pill,
1819                                     enum req_location loc)
1820 {
1821         struct ptlrpc_request *req;
1822
1823         req = pill->rc_req;
1824         return loc == RCL_CLIENT ? req->rq_reqmsg : req->rq_repmsg;
1825 }
1826
1827 /**
1828  * Set the format (\a fmt) of a \a pill; format changes are not allowed here
1829  * (see req_capsule_extend()).
1830  */
1831 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt)
1832 {
1833         LASSERT(pill->rc_fmt == NULL || pill->rc_fmt == fmt);
1834         LASSERT(__req_format_is_sane(fmt));
1835
1836         pill->rc_fmt = fmt;
1837 }
1838 EXPORT_SYMBOL(req_capsule_set);
1839
1840 /**
1841  * Fills in any parts of the \a rc_area of a \a pill that haven't been filled in
1842  * yet.
1843
1844  * \a rc_area is an array of REQ_MAX_FIELD_NR elements, used to store sizes of
1845  * variable-sized fields.  The field sizes come from the declared \a rmf_size
1846  * field of a \a pill's \a rc_fmt's RMF's.
1847  */
1848 size_t req_capsule_filled_sizes(struct req_capsule *pill,
1849                                 enum req_location loc)
1850 {
1851         const struct req_format *fmt = pill->rc_fmt;
1852         size_t                   i;
1853
1854         LASSERT(fmt != NULL);
1855
1856         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
1857                 if (pill->rc_area[loc][i] == -1) {
1858                         pill->rc_area[loc][i] =
1859                                             fmt->rf_fields[loc].d[i]->rmf_size;
1860                         if (pill->rc_area[loc][i] == -1) {
1861                                 /*
1862                                  * Skip the following fields.
1863                                  *
1864                                  * If this LASSERT() trips then you're missing a
1865                                  * call to req_capsule_set_size().
1866                                  */
1867                                 LASSERT(loc != RCL_SERVER);
1868                                 break;
1869                         }
1870                 }
1871         }
1872         return i;
1873 }
1874 EXPORT_SYMBOL(req_capsule_filled_sizes);
1875
1876 /**
1877  * Capsule equivalent of lustre_pack_request() and lustre_pack_reply().
1878  *
1879  * This function uses the \a pill's \a rc_area as filled in by
1880  * req_capsule_set_size() or req_capsule_filled_sizes() (the latter is called by
1881  * this function).
1882  */
1883 int req_capsule_server_pack(struct req_capsule *pill)
1884 {
1885         const struct req_format *fmt;
1886         int                      count;
1887         int                      rc;
1888
1889         LASSERT(pill->rc_loc == RCL_SERVER);
1890         fmt = pill->rc_fmt;
1891         LASSERT(fmt != NULL);
1892
1893         count = req_capsule_filled_sizes(pill, RCL_SERVER);
1894         rc = lustre_pack_reply(pill->rc_req, count,
1895                                pill->rc_area[RCL_SERVER], NULL);
1896         if (rc != 0) {
1897                 DEBUG_REQ(D_ERROR, pill->rc_req,
1898                        "Cannot pack %d fields in format `%s': ",
1899                        count, fmt->rf_name);
1900         }
1901         return rc;
1902 }
1903 EXPORT_SYMBOL(req_capsule_server_pack);
1904
1905 /**
1906  * Returns the PTLRPC request or reply (\a loc) buffer offset of a \a pill
1907  * corresponding to the given RMF (\a field).
1908  */
1909 __u32 __req_capsule_offset(const struct req_capsule *pill,
1910                            const struct req_msg_field *field,
1911                            enum req_location loc)
1912 {
1913         unsigned int offset;
1914
1915         offset = field->rmf_offset[pill->rc_fmt->rf_idx][loc];
1916         LASSERTF(offset > 0, "%s:%s, off=%d, loc=%d\n",
1917                              pill->rc_fmt->rf_name,
1918                              field->rmf_name, offset, loc);
1919         offset--;
1920
1921         LASSERT(offset < REQ_MAX_FIELD_NR);
1922         return offset;
1923 }
1924
1925 /**
1926  * Helper for __req_capsule_get(); swabs value / array of values and/or dumps
1927  * them if desired.
1928  */
1929 static
1930 void
1931 swabber_dumper_helper(struct req_capsule *pill,
1932                       const struct req_msg_field *field,
1933                       enum req_location loc,
1934                       int offset,
1935                       void *value, int len, int dump, void (*swabber)( void *))
1936 {
1937         void    *p;
1938         int     i;
1939         int     n;
1940         int     do_swab;
1941         int     inout = loc == RCL_CLIENT;
1942
1943         swabber = swabber ?: field->rmf_swabber;
1944
1945         if (ptlrpc_buf_need_swab(pill->rc_req, inout, offset) &&
1946             swabber != NULL && value != NULL)
1947                 do_swab = 1;
1948         else
1949                 do_swab = 0;
1950
1951         if (!field->rmf_dumper)
1952                 dump = 0;
1953
1954         if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY)) {
1955                 if (dump) {
1956                         CDEBUG(D_RPCTRACE, "Dump of %sfield %s follows\n",
1957                                do_swab ? "unswabbed " : "", field->rmf_name);
1958                         field->rmf_dumper(value);
1959                 }
1960                 if (!do_swab)
1961                         return;
1962                 swabber(value);
1963                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1964                 if (dump) {
1965                         CDEBUG(D_RPCTRACE, "Dump of swabbed field %s "
1966                                "follows\n", field->rmf_name);
1967                         field->rmf_dumper(value);
1968                 }
1969
1970                 return;
1971         }
1972
1973         /*
1974          * We're swabbing an array; swabber() swabs a single array element, so
1975          * swab every element.
1976          */
1977         LASSERT((len % field->rmf_size) == 0);
1978         for (p = value, i = 0, n = len / field->rmf_size;
1979              i < n;
1980              i++, p += field->rmf_size) {
1981                 if (dump) {
1982                         CDEBUG(D_RPCTRACE, "Dump of %sarray field %s, "
1983                                "element %d follows\n",
1984                                do_swab ? "unswabbed " : "", field->rmf_name, i);
1985                         field->rmf_dumper(p);
1986                 }
1987                 if (!do_swab)
1988                         continue;
1989                 swabber(p);
1990                 if (dump) {
1991                         CDEBUG(D_RPCTRACE, "Dump of swabbed array field %s, "
1992                                "element %d follows\n", field->rmf_name, i);
1993                         field->rmf_dumper(value);
1994                 }
1995         }
1996         if (do_swab)
1997                 ptlrpc_buf_set_swabbed(pill->rc_req, inout, offset);
1998 }
1999
2000 /**
2001  * Returns the pointer to a PTLRPC request or reply (\a loc) buffer of a \a pill
2002  * corresponding to the given RMF (\a field).
2003  *
2004  * The buffer will be swabbed using the given \a swabber.  If \a swabber == NULL
2005  * then the \a rmf_swabber from the RMF will be used.  Soon there will be no
2006  * calls to __req_capsule_get() with a non-NULL \a swabber; \a swabber will then
2007  * be removed.  Fields with the \a RMF_F_STRUCT_ARRAY flag set will have each
2008  * element of the array swabbed.
2009  */
2010 static void *__req_capsule_get(struct req_capsule *pill,
2011                                const struct req_msg_field *field,
2012                                enum req_location loc,
2013                                void (*swabber)( void *),
2014                                int dump)
2015 {
2016         const struct req_format *fmt;
2017         struct lustre_msg       *msg;
2018         void                    *value;
2019         __u32                    len;
2020         __u32                    offset;
2021
2022         void *(*getter)(struct lustre_msg *m, __u32 n, __u32 minlen);
2023
2024         static const char *rcl_names[RCL_NR] = {
2025                 [RCL_CLIENT] = "client",
2026                 [RCL_SERVER] = "server"
2027         };
2028
2029         LASSERT(pill != NULL);
2030         LASSERT(pill != LP_POISON);
2031         fmt = pill->rc_fmt;
2032         LASSERT(fmt != NULL);
2033         LASSERT(fmt != LP_POISON);
2034         LASSERT(__req_format_is_sane(fmt));
2035
2036         offset = __req_capsule_offset(pill, field, loc);
2037
2038         msg = __req_msg(pill, loc);
2039         LASSERT(msg != NULL);
2040
2041         getter = (field->rmf_flags & RMF_F_STRING) ?
2042                 (typeof(getter))lustre_msg_string : lustre_msg_buf;
2043
2044         if (field->rmf_flags & (RMF_F_STRUCT_ARRAY|RMF_F_NO_SIZE_CHECK)) {
2045                 /*
2046                  * We've already asserted that field->rmf_size > 0 in
2047                  * req_layout_init().
2048                  */
2049                 len = lustre_msg_buflen(msg, offset);
2050                 if (!(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2051                     (len % field->rmf_size) != 0) {
2052                         CERROR("%s: array field size mismatch "
2053                                 "%d modulo %u != 0 (%d)\n",
2054                                 field->rmf_name, len, field->rmf_size, loc);
2055                         return NULL;
2056                 }
2057         } else if (pill->rc_area[loc][offset] != -1) {
2058                 len = pill->rc_area[loc][offset];
2059         } else {
2060                 len = max_t(typeof(field->rmf_size), field->rmf_size, 0);
2061         }
2062         value = getter(msg, offset, len);
2063
2064         if (value == NULL) {
2065                 DEBUG_REQ(D_ERROR, pill->rc_req,
2066                           "Wrong buffer for field `%s' (%u of %u) "
2067                           "in format `%s': %u vs. %u (%s)\n",
2068                           field->rmf_name, offset, lustre_msg_bufcount(msg),
2069                           fmt->rf_name, lustre_msg_buflen(msg, offset), len,
2070                           rcl_names[loc]);
2071         } else {
2072                 swabber_dumper_helper(pill, field, loc, offset, value, len,
2073                                       dump, swabber);
2074         }
2075
2076         return value;
2077 }
2078
2079 /**
2080  * Dump a request and/or reply
2081  */
2082 void __req_capsule_dump(struct req_capsule *pill, enum req_location loc)
2083 {
2084         const struct    req_format *fmt;
2085         const struct    req_msg_field *field;
2086         __u32           len;
2087         size_t          i;
2088
2089         fmt = pill->rc_fmt;
2090
2091         DEBUG_REQ(D_RPCTRACE, pill->rc_req, "BEGIN REQ CAPSULE DUMP\n");
2092         for (i = 0; i < fmt->rf_fields[loc].nr; ++i) {
2093                 field = FMT_FIELD(fmt, loc, i);
2094                 if (field->rmf_dumper == NULL) {
2095                         /*
2096                          * FIXME Add a default hex dumper for fields that don't
2097                          * have a specific dumper
2098                          */
2099                         len = req_capsule_get_size(pill, field, loc);
2100                         CDEBUG(D_RPCTRACE, "Field %s has no dumper function;"
2101                                 "field size is %u\n", field->rmf_name, len);
2102                 } else {
2103                         /* It's the dumping side-effect that we're interested in */
2104                         (void) __req_capsule_get(pill, field, loc, NULL, 1);
2105                 }
2106         }
2107         CDEBUG(D_RPCTRACE, "END REQ CAPSULE DUMP\n");
2108 }
2109
2110 /**
2111  * Dump a request.
2112  */
2113 void req_capsule_client_dump(struct req_capsule *pill)
2114 {
2115         __req_capsule_dump(pill, RCL_CLIENT);
2116 }
2117 EXPORT_SYMBOL(req_capsule_client_dump);
2118
2119 /**
2120  * Dump a reply
2121  */
2122 void req_capsule_server_dump(struct req_capsule *pill)
2123 {
2124         __req_capsule_dump(pill, RCL_SERVER);
2125 }
2126 EXPORT_SYMBOL(req_capsule_server_dump);
2127
2128 /**
2129  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC request
2130  * buffer corresponding to the given RMF (\a field) of a \a pill.
2131  */
2132 void *req_capsule_client_get(struct req_capsule *pill,
2133                              const struct req_msg_field *field)
2134 {
2135         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2136 }
2137 EXPORT_SYMBOL(req_capsule_client_get);
2138
2139 /**
2140  * Same as req_capsule_client_get(), but with a \a swabber argument.
2141  *
2142  * Currently unused; will be removed when req_capsule_server_swab_get() is
2143  * unused too.
2144  */
2145 void *req_capsule_client_swab_get(struct req_capsule *pill,
2146                                   const struct req_msg_field *field,
2147                                   void *swabber)
2148 {
2149         return __req_capsule_get(pill, field, RCL_CLIENT, swabber, 0);
2150 }
2151 EXPORT_SYMBOL(req_capsule_client_swab_get);
2152
2153 /**
2154  * Utility that combines req_capsule_set_size() and req_capsule_client_get().
2155  *
2156  * First the \a pill's request \a field's size is set (\a rc_area) using
2157  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2158  * returned.
2159  */
2160 void *req_capsule_client_sized_get(struct req_capsule *pill,
2161                                    const struct req_msg_field *field,
2162                                    __u32 len)
2163 {
2164         req_capsule_set_size(pill, field, RCL_CLIENT, len);
2165         return __req_capsule_get(pill, field, RCL_CLIENT, NULL, 0);
2166 }
2167 EXPORT_SYMBOL(req_capsule_client_sized_get);
2168
2169 /**
2170  * Trivial wrapper around __req_capsule_get(), that returns the PTLRPC reply
2171  * buffer corresponding to the given RMF (\a field) of a \a pill.
2172  */
2173 void *req_capsule_server_get(struct req_capsule *pill,
2174                              const struct req_msg_field *field)
2175 {
2176         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2177 }
2178 EXPORT_SYMBOL(req_capsule_server_get);
2179
2180 /**
2181  * Same as req_capsule_server_get(), but with a \a swabber argument.
2182  *
2183  * Ideally all swabbing should be done pursuant to RMF definitions, with no
2184  * swabbing done outside this capsule abstraction.
2185  */
2186 void *req_capsule_server_swab_get(struct req_capsule *pill,
2187                                   const struct req_msg_field *field,
2188                                   void *swabber)
2189 {
2190         return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2191 }
2192 EXPORT_SYMBOL(req_capsule_server_swab_get);
2193
2194 /**
2195  * Utility that combines req_capsule_set_size() and req_capsule_server_get().
2196  *
2197  * First the \a pill's request \a field's size is set (\a rc_area) using
2198  * req_capsule_set_size() with the given \a len.  Then the actual buffer is
2199  * returned.
2200  */
2201 void *req_capsule_server_sized_get(struct req_capsule *pill,
2202                                    const struct req_msg_field *field,
2203                                    __u32 len)
2204 {
2205         req_capsule_set_size(pill, field, RCL_SERVER, len);
2206         return __req_capsule_get(pill, field, RCL_SERVER, NULL, 0);
2207 }
2208 EXPORT_SYMBOL(req_capsule_server_sized_get);
2209
2210 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
2211                                         const struct req_msg_field *field,
2212                                         __u32 len, void *swabber)
2213 {
2214         req_capsule_set_size(pill, field, RCL_SERVER, len);
2215         return __req_capsule_get(pill, field, RCL_SERVER, swabber, 0);
2216 }
2217 EXPORT_SYMBOL(req_capsule_server_sized_swab_get);
2218
2219 /**
2220  * Returns the buffer of a \a pill corresponding to the given \a field from the
2221  * request (if the caller is executing on the server-side) or reply (if the
2222  * caller is executing on the client-side).
2223  *
2224  * This function convienient for use is code that could be executed on the
2225  * client and server alike.
2226  */
2227 const void *req_capsule_other_get(struct req_capsule *pill,
2228                                   const struct req_msg_field *field)
2229 {
2230         return __req_capsule_get(pill, field, pill->rc_loc ^ 1, NULL, 0);
2231 }
2232 EXPORT_SYMBOL(req_capsule_other_get);
2233
2234 /**
2235  * Set the size of the PTLRPC request/reply (\a loc) buffer for the given \a
2236  * field of the given \a pill.
2237  *
2238  * This function must be used when constructing variable sized fields of a
2239  * request or reply.
2240  */
2241 void req_capsule_set_size(struct req_capsule *pill,
2242                           const struct req_msg_field *field,
2243                           enum req_location loc, __u32 size)
2244 {
2245         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2246
2247         if ((size != (__u32)field->rmf_size) &&
2248             (field->rmf_size != -1) &&
2249             !(field->rmf_flags & RMF_F_NO_SIZE_CHECK) &&
2250             (size > 0)) {
2251                 __u32 rmf_size = (__u32)field->rmf_size;
2252                 if ((field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2253                     (size % rmf_size != 0)) {
2254                         CERROR("%s: array field size mismatch "
2255                                 "%u %% %u != 0 (%d)\n",
2256                                 field->rmf_name, size, rmf_size, loc);
2257                         LBUG();
2258                 } else if (!(field->rmf_flags & RMF_F_STRUCT_ARRAY) &&
2259                            size < rmf_size) {
2260                         CERROR("%s: field size mismatch %u != %u (%d)\n",
2261                                 field->rmf_name, size, rmf_size, loc);
2262                         LBUG();
2263                 }
2264         }
2265
2266         pill->rc_area[loc][__req_capsule_offset(pill, field, loc)] = size;
2267 }
2268 EXPORT_SYMBOL(req_capsule_set_size);
2269
2270 /**
2271  * Return the actual PTLRPC buffer length of a request or reply (\a loc)
2272  * for the given \a pill's given \a field.
2273  *
2274  * NB: this function doesn't correspond with req_capsule_set_size(), which
2275  * actually sets the size in pill.rc_area[loc][offset], but this function
2276  * returns the message buflen[offset], maybe we should use another name.
2277  */
2278 __u32 req_capsule_get_size(const struct req_capsule *pill,
2279                          const struct req_msg_field *field,
2280                          enum req_location loc)
2281 {
2282         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2283
2284         return lustre_msg_buflen(__req_msg(pill, loc),
2285                                  __req_capsule_offset(pill, field, loc));
2286 }
2287 EXPORT_SYMBOL(req_capsule_get_size);
2288
2289 /**
2290  * Wrapper around lustre_msg_size() that returns the PTLRPC size needed for the
2291  * given \a pill's request or reply (\a loc) given the field size recorded in
2292  * the \a pill's rc_area.
2293  *
2294  * See also req_capsule_set_size().
2295  */
2296 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc)
2297 {
2298         return lustre_msg_size(pill->rc_req->rq_import->imp_msg_magic,
2299                                pill->rc_fmt->rf_fields[loc].nr,
2300                                pill->rc_area[loc]);
2301 }
2302
2303 /**
2304  * While req_capsule_msg_size() computes the size of a PTLRPC request or reply
2305  * (\a loc) given a \a pill's \a rc_area, this function computes the size of a
2306  * PTLRPC request or reply given only an RQF (\a fmt).
2307  *
2308  * This function should not be used for formats which contain variable size
2309  * fields.
2310  */
2311 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
2312                          enum req_location loc)
2313 {
2314         __u32 size;
2315         size_t i = 0;
2316
2317         /*
2318          * This function should probably LASSERT() that fmt has no fields with
2319          * RMF_F_STRUCT_ARRAY in rmf_flags, since we can't know here how many
2320          * elements in the array there will ultimately be, but then, we could
2321          * assume that there will be at least one element, and that's just what
2322          * we do.
2323          */
2324         size = lustre_msg_hdr_size(magic, fmt->rf_fields[loc].nr);
2325         if (size == 0)
2326                 return size;
2327
2328         for (; i < fmt->rf_fields[loc].nr; ++i)
2329                 if (fmt->rf_fields[loc].d[i]->rmf_size != -1)
2330                         size += cfs_size_round(fmt->rf_fields[loc].d[i]->
2331                                                rmf_size);
2332         return size;
2333 }
2334 EXPORT_SYMBOL(req_capsule_fmt_size);
2335
2336 /**
2337  * Changes the format of an RPC.
2338  *
2339  * The pill must already have been initialized, which means that it already has
2340  * a request format.  The new format \a fmt must be an extension of the pill's
2341  * old format.  Specifically: the new format must have as many request and reply
2342  * fields as the old one, and all fields shared by the old and new format must
2343  * be at least as large in the new format.
2344  *
2345  * The new format's fields may be of different "type" than the old format, but
2346  * only for fields that are "opaque" blobs: fields which have a) have no
2347  * \a rmf_swabber, b) \a rmf_flags == 0 or RMF_F_NO_SIZE_CHECK, and c) \a
2348  * rmf_size == -1 or \a rmf_flags == RMF_F_NO_SIZE_CHECK.  For example,
2349  * OBD_SET_INFO has a key field and an opaque value field that gets interpreted
2350  * according to the key field.  When the value, according to the key, contains a
2351  * structure (or array thereof) to be swabbed, the format should be changed to
2352  * one where the value field has \a rmf_size/rmf_flags/rmf_swabber set
2353  * accordingly.
2354  */
2355 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt)
2356 {
2357         int i;
2358         size_t j;
2359
2360         const struct req_format *old;
2361
2362         LASSERT(pill->rc_fmt != NULL);
2363         LASSERT(__req_format_is_sane(fmt));
2364
2365         old = pill->rc_fmt;
2366         /*
2367          * Sanity checking...
2368          */
2369         for (i = 0; i < RCL_NR; ++i) {
2370                 LASSERT(fmt->rf_fields[i].nr >= old->rf_fields[i].nr);
2371                 for (j = 0; j < old->rf_fields[i].nr - 1; ++j) {
2372                         const struct req_msg_field *ofield = FMT_FIELD(old, i, j);
2373
2374                         /* "opaque" fields can be transmogrified */
2375                         if (ofield->rmf_swabber == NULL &&
2376                             (ofield->rmf_flags & ~RMF_F_NO_SIZE_CHECK) == 0 &&
2377                             (ofield->rmf_size == -1 ||
2378                             ofield->rmf_flags == RMF_F_NO_SIZE_CHECK))
2379                                 continue;
2380                         LASSERT(FMT_FIELD(fmt, i, j) == FMT_FIELD(old, i, j));
2381                 }
2382                 /*
2383                  * Last field in old format can be shorter than in new.
2384                  */
2385                 LASSERT(FMT_FIELD(fmt, i, j)->rmf_size >=
2386                         FMT_FIELD(old, i, j)->rmf_size);
2387         }
2388
2389         pill->rc_fmt = fmt;
2390 }
2391 EXPORT_SYMBOL(req_capsule_extend);
2392
2393 /**
2394  * This function returns a non-zero value if the given \a field is present in
2395  * the format (\a rc_fmt) of \a pill's PTLRPC request or reply (\a loc), else it
2396  * returns 0.
2397  */
2398 int req_capsule_has_field(const struct req_capsule *pill,
2399                           const struct req_msg_field *field,
2400                           enum req_location loc)
2401 {
2402         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2403
2404         return field->rmf_offset[pill->rc_fmt->rf_idx][loc];
2405 }
2406 EXPORT_SYMBOL(req_capsule_has_field);
2407
2408 /**
2409  * Returns a non-zero value if the given \a field is present in the given \a
2410  * pill's PTLRPC request or reply (\a loc), else it returns 0.
2411  */
2412 int req_capsule_field_present(const struct req_capsule *pill,
2413                               const struct req_msg_field *field,
2414                               enum req_location loc)
2415 {
2416         __u32 offset;
2417
2418         LASSERT(loc == RCL_SERVER || loc == RCL_CLIENT);
2419         LASSERT(req_capsule_has_field(pill, field, loc));
2420
2421         offset = __req_capsule_offset(pill, field, loc);
2422         return lustre_msg_bufcount(__req_msg(pill, loc)) > offset;
2423 }
2424 EXPORT_SYMBOL(req_capsule_field_present);
2425
2426 /**
2427  * This function shrinks the size of the _buffer_ of the \a pill's PTLRPC
2428  * request or reply (\a loc).
2429  *
2430  * This is not the opposite of req_capsule_extend().
2431  */
2432 void req_capsule_shrink(struct req_capsule *pill,
2433                         const struct req_msg_field *field,
2434                         __u32 newlen,
2435                         enum req_location loc)
2436 {
2437         const struct req_format *fmt;
2438         struct lustre_msg       *msg;
2439         __u32                    len;
2440         int                      offset;
2441
2442         fmt = pill->rc_fmt;
2443         LASSERT(fmt != NULL);
2444         LASSERT(__req_format_is_sane(fmt));
2445         LASSERT(req_capsule_has_field(pill, field, loc));
2446         LASSERT(req_capsule_field_present(pill, field, loc));
2447
2448         offset = __req_capsule_offset(pill, field, loc);
2449
2450         msg = __req_msg(pill, loc);
2451         len = lustre_msg_buflen(msg, offset);
2452         LASSERTF(newlen <= len, "%s:%s, oldlen=%u, newlen=%u\n",
2453                                 fmt->rf_name, field->rmf_name, len, newlen);
2454
2455         if (loc == RCL_CLIENT)
2456                 pill->rc_req->rq_reqlen = lustre_shrink_msg(msg, offset, newlen,
2457                                                             1);
2458         else
2459                 pill->rc_req->rq_replen = lustre_shrink_msg(msg, offset, newlen,
2460                                                             1);
2461 }
2462 EXPORT_SYMBOL(req_capsule_shrink);
2463
2464 int req_capsule_server_grow(struct req_capsule *pill,
2465                             const struct req_msg_field *field,
2466                             __u32 newlen)
2467 {
2468         struct ptlrpc_reply_state *rs = pill->rc_req->rq_reply_state, *nrs;
2469         char *from, *to;
2470         int rc;
2471         __u32 offset, len;
2472
2473         LASSERT(pill->rc_fmt != NULL);
2474         LASSERT(__req_format_is_sane(pill->rc_fmt));
2475         LASSERT(req_capsule_has_field(pill, field, RCL_SERVER));
2476         LASSERT(req_capsule_field_present(pill, field, RCL_SERVER));
2477
2478         len = req_capsule_get_size(pill, field, RCL_SERVER);
2479         offset = __req_capsule_offset(pill, field, RCL_SERVER);
2480         if ((__u32)pill->rc_req->rq_repbuf_len >=
2481             lustre_packed_msg_size(pill->rc_req->rq_repmsg) - len + newlen)
2482                 CERROR("Inplace repack might be done\n");
2483
2484         pill->rc_req->rq_reply_state = NULL;
2485         req_capsule_set_size(pill, field, RCL_SERVER, newlen);
2486         rc = req_capsule_server_pack(pill);
2487         if (rc) {
2488                 /* put old rs back, the caller will decide what to do */
2489                 pill->rc_req->rq_reply_state = rs;
2490                 return rc;
2491         }
2492         nrs = pill->rc_req->rq_reply_state;
2493         /* Now we need only buffers, copy first chunk */
2494         to = lustre_msg_buf(nrs->rs_msg, 0, 0);
2495         from = lustre_msg_buf(rs->rs_msg, 0, 0);
2496         len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) - from;
2497         memcpy(to, from, len);
2498         /* check if we have tail and copy it too */
2499         if (rs->rs_msg->lm_bufcount > offset + 1) {
2500                 to = lustre_msg_buf(nrs->rs_msg, offset + 1, 0);
2501                 from = lustre_msg_buf(rs->rs_msg, offset + 1, 0);
2502                 offset = rs->rs_msg->lm_bufcount - 1;
2503                 len = (char *)lustre_msg_buf(rs->rs_msg, offset, 0) +
2504                       cfs_size_round(rs->rs_msg->lm_buflens[offset]) - from;
2505                 memcpy(to, from, len);
2506         }
2507         /* drop old reply if everything is fine */
2508         if (rs->rs_difficult) {
2509                 /* copy rs data */
2510                 int i;
2511
2512                 nrs->rs_difficult = 1;
2513                 nrs->rs_no_ack = rs->rs_no_ack;
2514                 nrs->rs_convert_lock = rs->rs_convert_lock;
2515                 for (i = 0; i < rs->rs_nlocks; i++) {
2516                         nrs->rs_locks[i] = rs->rs_locks[i];
2517                         nrs->rs_modes[i] = rs->rs_modes[i];
2518                         nrs->rs_nlocks++;
2519                 }
2520                 rs->rs_nlocks = 0;
2521                 rs->rs_difficult = 0;
2522                 rs->rs_no_ack = 0;
2523         }
2524         ptlrpc_rs_decref(rs);
2525         return 0;
2526 }
2527 EXPORT_SYMBOL(req_capsule_server_grow);