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