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