drivers/staging/lustre/lustre/include/lustre_req_layout.h

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