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