lustre/ptlrpc/layout.c

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