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