LXR linux/drivers/staging/lustre/lustre/include/lustre_req

   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, 2012, Intel Corporation.
  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/include/lustre_req_layout.h
  37 *
  38 * Lustre Metadata Target (mdt) request handler
  39 *
  40 * Author: Nikita Danilov <nikita@clusterfs.com>
  41 */
  42
  43#ifndef _LUSTRE_REQ_LAYOUT_H__
  44#define _LUSTRE_REQ_LAYOUT_H__
  45
  46/** \defgroup req_layout req_layout
  47 *
  48 * @{
  49 */
  50
  51struct req_msg_field;
  52struct req_format;
  53struct req_capsule;
  54
  55struct ptlrpc_request;
  56
  57enum req_location {
  58        RCL_CLIENT,
  59        RCL_SERVER,
  60        RCL_NR
  61};
  62
  63/* Maximal number of fields (buffers) in a request message. */
  64#define REQ_MAX_FIELD_NR  9
  65
  66struct req_capsule {
  67        struct ptlrpc_request   *rc_req;
  68        const struct req_format *rc_fmt;
  69        enum req_location       rc_loc;
  70        __u32               rc_area[RCL_NR][REQ_MAX_FIELD_NR];
  71};
  72
  73#if !defined(__REQ_LAYOUT_USER__)
  74
  75/* struct ptlrpc_request, lustre_msg* */
  76#include <lustre_net.h>
  77
  78void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  79                      enum req_location location);
  80void req_capsule_fini(struct req_capsule *pill);
  81
  82void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  83void req_capsule_client_dump(struct req_capsule *pill);
  84void req_capsule_server_dump(struct req_capsule *pill);
  85void req_capsule_init_area(struct req_capsule *pill);
  86int req_capsule_filled_sizes(struct req_capsule *pill, enum req_location loc);
  87int  req_capsule_server_pack(struct req_capsule *pill);
  88
  89void *req_capsule_client_get(struct req_capsule *pill,
  90                             const struct req_msg_field *field);
  91void *req_capsule_client_swab_get(struct req_capsule *pill,
  92                                  const struct req_msg_field *field,
  93                                  void *swabber);
  94void *req_capsule_client_sized_get(struct req_capsule *pill,
  95                                   const struct req_msg_field *field,
  96                                   int len);
  97void *req_capsule_server_get(struct req_capsule *pill,
  98                             const struct req_msg_field *field);
  99void *req_capsule_server_sized_get(struct req_capsule *pill,
 100                                   const struct req_msg_field *field,
 101                                   int len);
 102void *req_capsule_server_swab_get(struct req_capsule *pill,
 103                                  const struct req_msg_field *field,
 104                                  void *swabber);
 105void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
 106                                        const struct req_msg_field *field,
 107                                        int len, void *swabber);
 108const void *req_capsule_other_get(struct req_capsule *pill,
 109                                  const struct req_msg_field *field);
 110
 111void req_capsule_set_size(struct req_capsule *pill,
 112                          const struct req_msg_field *field,
 113                          enum req_location loc, int size);
 114int req_capsule_get_size(const struct req_capsule *pill,
 115                          const struct req_msg_field *field,
 116                          enum req_location loc);
 117int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
 118int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
 119                         enum req_location loc);
 120void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
 121
 122int req_capsule_has_field(const struct req_capsule *pill,
 123                          const struct req_msg_field *field,
 124                          enum req_location loc);
 125int req_capsule_field_present(const struct req_capsule *pill,
 126                              const struct req_msg_field *field,
 127                              enum req_location loc);
 128void req_capsule_shrink(struct req_capsule *pill,
 129                        const struct req_msg_field *field,
 130                        unsigned int newlen,
 131                        enum req_location loc);
 132int req_capsule_server_grow(struct req_capsule *pill,
 133                            const struct req_msg_field *field,
 134                            unsigned int newlen);
 135int  req_layout_init(void);
 136void req_layout_fini(void);
 137
 138/* __REQ_LAYOUT_USER__ */
 139#endif
 140
 141extern struct req_format RQF_OBD_PING;
 142extern struct req_format RQF_OBD_SET_INFO;
 143extern struct req_format RQF_SEC_CTX;
 144extern struct req_format RQF_OBD_IDX_READ;
 145/* MGS req_format */
 146extern struct req_format RQF_MGS_TARGET_REG;
 147extern struct req_format RQF_MGS_SET_INFO;
 148extern struct req_format RQF_MGS_CONFIG_READ;
 149/* fid/fld req_format */
 150extern struct req_format RQF_SEQ_QUERY;
 151extern struct req_format RQF_FLD_QUERY;
 152/* MDS req_format */
 153extern struct req_format RQF_MDS_CONNECT;
 154extern struct req_format RQF_MDS_DISCONNECT;
 155extern struct req_format RQF_MDS_STATFS;
 156extern struct req_format RQF_MDS_GETSTATUS;
 157extern struct req_format RQF_MDS_SYNC;
 158extern struct req_format RQF_MDS_GETXATTR;
 159extern struct req_format RQF_MDS_GETATTR;
 160extern struct req_format RQF_UPDATE_OBJ;
 161
 162/*
 163 * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 164 */
 165extern struct req_format RQF_MDS_GETATTR_NAME;
 166extern struct req_format RQF_MDS_CLOSE;
 167extern struct req_format RQF_MDS_PIN;
 168extern struct req_format RQF_MDS_UNPIN;
 169extern struct req_format RQF_MDS_CONNECT;
 170extern struct req_format RQF_MDS_DISCONNECT;
 171extern struct req_format RQF_MDS_GET_INFO;
 172extern struct req_format RQF_MDS_READPAGE;
 173extern struct req_format RQF_MDS_WRITEPAGE;
 174extern struct req_format RQF_MDS_IS_SUBDIR;
 175extern struct req_format RQF_MDS_DONE_WRITING;
 176extern struct req_format RQF_MDS_REINT;
 177extern struct req_format RQF_MDS_REINT_CREATE;
 178extern struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
 179extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 180extern struct req_format RQF_MDS_REINT_CREATE_SYM;
 181extern struct req_format RQF_MDS_REINT_OPEN;
 182extern struct req_format RQF_MDS_REINT_UNLINK;
 183extern struct req_format RQF_MDS_REINT_LINK;
 184extern struct req_format RQF_MDS_REINT_RENAME;
 185extern struct req_format RQF_MDS_REINT_SETATTR;
 186extern struct req_format RQF_MDS_REINT_SETXATTR;
 187extern struct req_format RQF_MDS_QUOTACHECK;
 188extern struct req_format RQF_MDS_QUOTACTL;
 189extern struct req_format RQF_QC_CALLBACK;
 190extern struct req_format RQF_QUOTA_DQACQ;
 191extern struct req_format RQF_MDS_SWAP_LAYOUTS;
 192/* MDS hsm formats */
 193extern struct req_format RQF_MDS_HSM_STATE_GET;
 194extern struct req_format RQF_MDS_HSM_STATE_SET;
 195extern struct req_format RQF_MDS_HSM_ACTION;
 196extern struct req_format RQF_MDS_HSM_PROGRESS;
 197extern struct req_format RQF_MDS_HSM_CT_REGISTER;
 198extern struct req_format RQF_MDS_HSM_CT_UNREGISTER;
 199extern struct req_format RQF_MDS_HSM_REQUEST;
 200/* OST req_format */
 201extern struct req_format RQF_OST_CONNECT;
 202extern struct req_format RQF_OST_DISCONNECT;
 203extern struct req_format RQF_OST_QUOTACHECK;
 204extern struct req_format RQF_OST_QUOTACTL;
 205extern struct req_format RQF_OST_GETATTR;
 206extern struct req_format RQF_OST_SETATTR;
 207extern struct req_format RQF_OST_CREATE;
 208extern struct req_format RQF_OST_PUNCH;
 209extern struct req_format RQF_OST_SYNC;
 210extern struct req_format RQF_OST_DESTROY;
 211extern struct req_format RQF_OST_BRW_READ;
 212extern struct req_format RQF_OST_BRW_WRITE;
 213extern struct req_format RQF_OST_STATFS;
 214extern struct req_format RQF_OST_SET_GRANT_INFO;
 215extern struct req_format RQF_OST_GET_INFO_GENERIC;
 216extern struct req_format RQF_OST_GET_INFO_LAST_ID;
 217extern struct req_format RQF_OST_GET_INFO_LAST_FID;
 218extern struct req_format RQF_OST_SET_INFO_LAST_FID;
 219extern struct req_format RQF_OST_GET_INFO_FIEMAP;
 220
 221/* LDLM req_format */
 222extern struct req_format RQF_LDLM_ENQUEUE;
 223extern struct req_format RQF_LDLM_ENQUEUE_LVB;
 224extern struct req_format RQF_LDLM_CONVERT;
 225extern struct req_format RQF_LDLM_INTENT;
 226extern struct req_format RQF_LDLM_INTENT_BASIC;
 227extern struct req_format RQF_LDLM_INTENT_LAYOUT;
 228extern struct req_format RQF_LDLM_INTENT_GETATTR;
 229extern struct req_format RQF_LDLM_INTENT_OPEN;
 230extern struct req_format RQF_LDLM_INTENT_CREATE;
 231extern struct req_format RQF_LDLM_INTENT_UNLINK;
 232extern struct req_format RQF_LDLM_INTENT_QUOTA;
 233extern struct req_format RQF_LDLM_CANCEL;
 234extern struct req_format RQF_LDLM_CALLBACK;
 235extern struct req_format RQF_LDLM_CP_CALLBACK;
 236extern struct req_format RQF_LDLM_BL_CALLBACK;
 237extern struct req_format RQF_LDLM_GL_CALLBACK;
 238extern struct req_format RQF_LDLM_GL_DESC_CALLBACK;
 239/* LOG req_format */
 240extern struct req_format RQF_LOG_CANCEL;
 241extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 242extern struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
 243extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 244extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 245extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 246extern struct req_format RQF_LLOG_ORIGIN_CONNECT;
 247
 248extern struct req_msg_field RMF_GENERIC_DATA;
 249extern struct req_msg_field RMF_PTLRPC_BODY;
 250extern struct req_msg_field RMF_MDT_BODY;
 251extern struct req_msg_field RMF_MDT_EPOCH;
 252extern struct req_msg_field RMF_OBD_STATFS;
 253extern struct req_msg_field RMF_NAME;
 254extern struct req_msg_field RMF_SYMTGT;
 255extern struct req_msg_field RMF_TGTUUID;
 256extern struct req_msg_field RMF_CLUUID;
 257extern struct req_msg_field RMF_SETINFO_VAL;
 258extern struct req_msg_field RMF_SETINFO_KEY;
 259extern struct req_msg_field RMF_GETINFO_VAL;
 260extern struct req_msg_field RMF_GETINFO_VALLEN;
 261extern struct req_msg_field RMF_GETINFO_KEY;
 262extern struct req_msg_field RMF_IDX_INFO;
 263
 264/*
 265 * connection handle received in MDS_CONNECT request.
 266 */
 267extern struct req_msg_field RMF_CONN;
 268extern struct req_msg_field RMF_CONNECT_DATA;
 269extern struct req_msg_field RMF_DLM_REQ;
 270extern struct req_msg_field RMF_DLM_REP;
 271extern struct req_msg_field RMF_DLM_LVB;
 272extern struct req_msg_field RMF_DLM_GL_DESC;
 273extern struct req_msg_field RMF_LDLM_INTENT;
 274extern struct req_msg_field RMF_LAYOUT_INTENT;
 275extern struct req_msg_field RMF_MDT_MD;
 276extern struct req_msg_field RMF_REC_REINT;
 277extern struct req_msg_field RMF_EADATA;
 278extern struct req_msg_field RMF_ACL;
 279extern struct req_msg_field RMF_LOGCOOKIES;
 280extern struct req_msg_field RMF_CAPA1;
 281extern struct req_msg_field RMF_CAPA2;
 282extern struct req_msg_field RMF_OBD_QUOTACHECK;
 283extern struct req_msg_field RMF_OBD_QUOTACTL;
 284extern struct req_msg_field RMF_QUOTA_BODY;
 285extern struct req_msg_field RMF_STRING;
 286extern struct req_msg_field RMF_SWAP_LAYOUTS;
 287extern struct req_msg_field RMF_MDS_HSM_PROGRESS;
 288extern struct req_msg_field RMF_MDS_HSM_REQUEST;
 289extern struct req_msg_field RMF_MDS_HSM_USER_ITEM;
 290extern struct req_msg_field RMF_MDS_HSM_ARCHIVE;
 291extern struct req_msg_field RMF_HSM_USER_STATE;
 292extern struct req_msg_field RMF_HSM_STATE_SET;
 293extern struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION;
 294extern struct req_msg_field RMF_MDS_HSM_REQUEST;
 295
 296/* seq-mgr fields */
 297extern struct req_msg_field RMF_SEQ_OPC;
 298extern struct req_msg_field RMF_SEQ_RANGE;
 299extern struct req_msg_field RMF_FID_SPACE;
 300
 301/* FLD fields */
 302extern struct req_msg_field RMF_FLD_OPC;
 303extern struct req_msg_field RMF_FLD_MDFLD;
 304
 305extern struct req_msg_field RMF_LLOGD_BODY;
 306extern struct req_msg_field RMF_LLOG_LOG_HDR;
 307extern struct req_msg_field RMF_LLOGD_CONN_BODY;
 308
 309extern struct req_msg_field RMF_MGS_TARGET_INFO;
 310extern struct req_msg_field RMF_MGS_SEND_PARAM;
 311
 312extern struct req_msg_field RMF_OST_BODY;
 313extern struct req_msg_field RMF_OBD_IOOBJ;
 314extern struct req_msg_field RMF_OBD_ID;
 315extern struct req_msg_field RMF_FID;
 316extern struct req_msg_field RMF_NIOBUF_REMOTE;
 317extern struct req_msg_field RMF_RCS;
 318extern struct req_msg_field RMF_FIEMAP_KEY;
 319extern struct req_msg_field RMF_FIEMAP_VAL;
 320extern struct req_msg_field RMF_OST_ID;
 321
 322/* MGS config read message format */
 323extern struct req_msg_field RMF_MGS_CONFIG_BODY;
 324extern struct req_msg_field RMF_MGS_CONFIG_RES;
 325
 326/* generic uint32 */
 327extern struct req_msg_field RMF_U32;
 328
 329/* OBJ update format */
 330extern struct req_msg_field RMF_UPDATE;
 331extern struct req_msg_field RMF_UPDATE_REPLY;
 332/** @} req_layout */
 333
 334#endif /* _LUSTRE_REQ_LAYOUT_H__ */
 335