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