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