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