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