lustre/ptlrpc/layout.c

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