lustre/ptlrpc/layout.c

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