lustre/ptlrpc/layout.c

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