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