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