lustre/ptlrpc/layout.c

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