lustre/ptlrpc/layout.c

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