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, 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/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 void req_capsule_client_dump(struct req_capsule *pill);
  84 void req_capsule_server_dump(struct req_capsule *pill);
  85 void req_capsule_init_area(struct req_capsule *pill);
  86 int req_capsule_filled_sizes(struct req_capsule *pill, enum req_location loc);
  87 int  req_capsule_server_pack(struct req_capsule *pill);
  88
  89 void *req_capsule_client_get(struct req_capsule *pill,
  90                              const struct req_msg_field *field);
  91 void *req_capsule_client_swab_get(struct req_capsule *pill,
  92                                   const struct req_msg_field *field,
  93                                   void (*swabber)(void*));
  94 void *req_capsule_client_sized_get(struct req_capsule *pill,
  95                                    const struct req_msg_field *field,
  96                                    int len);
  97 void *req_capsule_server_get(struct req_capsule *pill,
  98                              const struct req_msg_field *field);
  99 void *req_capsule_server_sized_get(struct req_capsule *pill,
 100                                    const struct req_msg_field *field,
 101                                    int len);
 102 void *req_capsule_server_swab_get(struct req_capsule *pill,
 103                                   const struct req_msg_field *field,
 104                                   void *swabber);
 105 const void *req_capsule_other_get(struct req_capsule *pill,
 106                                   const struct req_msg_field *field);
 107
 108 void req_capsule_set_size(struct req_capsule *pill,
 109                           const struct req_msg_field *field,
 110                           enum req_location loc, int size);
 111 int req_capsule_get_size(const struct req_capsule *pill,
 112                           const struct req_msg_field *field,
 113                           enum req_location loc);
 114 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
 115 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
 116                          enum req_location loc);
 117 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
 118
 119 int req_capsule_has_field(const struct req_capsule *pill,
 120                           const struct req_msg_field *field,
 121                           enum req_location loc);
 122 int req_capsule_field_present(const struct req_capsule *pill,
 123                               const struct req_msg_field *field,
 124                               enum req_location loc);
 125 void req_capsule_shrink(struct req_capsule *pill,
 126                         const struct req_msg_field *field,
 127                         unsigned int newlen,
 128                         enum req_location loc);
 129 int req_capsule_server_grow(struct req_capsule *pill,
 130                             const struct req_msg_field *field,
 131                             unsigned int newlen);
 132 int  req_layout_init(void);
 133 void req_layout_fini(void);
 134
 135 /* __REQ_LAYOUT_USER__ */
 136 #endif
 137
 138 extern struct req_format RQF_OBD_PING;
 139 extern struct req_format RQF_OBD_SET_INFO;
 140 extern struct req_format RQF_SEC_CTX;
 141 extern struct req_format RQF_OBD_IDX_READ;
 142 /* MGS req_format */
 143 extern struct req_format RQF_MGS_TARGET_REG;
 144 extern struct req_format RQF_MGS_SET_INFO;
 145 extern struct req_format RQF_MGS_CONFIG_READ;
 146 /* fid/fld req_format */
 147 extern struct req_format RQF_SEQ_QUERY;
 148 extern struct req_format RQF_FLD_QUERY;
 149 /* MDS req_format */
 150 extern struct req_format RQF_MDS_CONNECT;
 151 extern struct req_format RQF_MDS_DISCONNECT;
 152 extern struct req_format RQF_MDS_STATFS;
 153 extern struct req_format RQF_MDS_GETSTATUS;
 154 extern struct req_format RQF_MDS_SYNC;
 155 extern struct req_format RQF_MDS_GETXATTR;
 156 extern struct req_format RQF_MDS_GETATTR;
 157 /*
 158  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 159  */
 160 extern struct req_format RQF_MDS_GETATTR_NAME;
 161 extern struct req_format RQF_MDS_CLOSE;
 162 extern struct req_format RQF_MDS_PIN;
 163 extern struct req_format RQF_MDS_UNPIN;
 164 extern struct req_format RQF_MDS_CONNECT;
 165 extern struct req_format RQF_MDS_DISCONNECT;
 166 extern struct req_format RQF_MDS_GET_INFO;
 167 extern struct req_format RQF_MDS_READPAGE;
 168 extern struct req_format RQF_MDS_WRITEPAGE;
 169 extern struct req_format RQF_MDS_IS_SUBDIR;
 170 extern struct req_format RQF_MDS_DONE_WRITING;
 171 extern struct req_format RQF_MDS_REINT;
 172 extern struct req_format RQF_MDS_REINT_CREATE;
 173 extern struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
 174 extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 175 extern struct req_format RQF_MDS_REINT_CREATE_SYM;
 176 extern struct req_format RQF_MDS_REINT_OPEN;
 177 extern struct req_format RQF_MDS_REINT_UNLINK;
 178 extern struct req_format RQF_MDS_REINT_LINK;
 179 extern struct req_format RQF_MDS_REINT_RENAME;
 180 extern struct req_format RQF_MDS_REINT_SETATTR;
 181 extern struct req_format RQF_MDS_REINT_SETXATTR;
 182 extern struct req_format RQF_MDS_QUOTACHECK;
 183 extern struct req_format RQF_MDS_QUOTACTL;
 184 extern struct req_format RQF_MDS_QUOTA_DQACQ;
 185 extern struct req_format RQF_QC_CALLBACK;
 186 extern struct req_format RQF_QUOTA_DQACQ;
 187 /* OST req_format */
 188 extern struct req_format RQF_OST_CONNECT;
 189 extern struct req_format RQF_OST_DISCONNECT;
 190 extern struct req_format RQF_OST_QUOTACHECK;
 191 extern struct req_format RQF_OST_QUOTACTL;
 192 extern struct req_format RQF_OST_QUOTA_ADJUST_QUNIT;
 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_GENERIC;
 204 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
 205 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
 206
 207 /* LDLM req_format */
 208 extern struct req_format RQF_LDLM_ENQUEUE;
 209 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
 210 extern struct req_format RQF_LDLM_CONVERT;
 211 extern struct req_format RQF_LDLM_INTENT;
 212 extern struct req_format RQF_LDLM_INTENT_BASIC;
 213 extern struct req_format RQF_LDLM_INTENT_GETATTR;
 214 extern struct req_format RQF_LDLM_INTENT_OPEN;
 215 extern struct req_format RQF_LDLM_INTENT_CREATE;
 216 extern struct req_format RQF_LDLM_INTENT_UNLINK;
 217 extern struct req_format RQF_LDLM_INTENT_QUOTA;
 218 extern struct req_format RQF_LDLM_CANCEL;
 219 extern struct req_format RQF_LDLM_CALLBACK;
 220 extern struct req_format RQF_LDLM_CP_CALLBACK;
 221 extern struct req_format RQF_LDLM_BL_CALLBACK;
 222 extern struct req_format RQF_LDLM_GL_CALLBACK;
 223 extern struct req_format RQF_LDLM_GL_DESC_CALLBACK;
 224 /* LOG req_format */
 225 extern struct req_format RQF_LOG_CANCEL;
 226 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 227 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
 228 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 229 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 230 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 231 extern struct req_format RQF_LLOG_ORIGIN_CONNECT;
 232
 233 extern struct req_msg_field RMF_GENERIC_DATA;
 234 extern struct req_msg_field RMF_PTLRPC_BODY;
 235 extern struct req_msg_field RMF_MDT_BODY;
 236 extern struct req_msg_field RMF_MDT_EPOCH;
 237 extern struct req_msg_field RMF_OBD_STATFS;
 238 extern struct req_msg_field RMF_NAME;
 239 extern struct req_msg_field RMF_SYMTGT;
 240 extern struct req_msg_field RMF_TGTUUID;
 241 extern struct req_msg_field RMF_CLUUID;
 242 extern struct req_msg_field RMF_SETINFO_VAL;
 243 extern struct req_msg_field RMF_SETINFO_KEY;
 244 extern struct req_msg_field RMF_GETINFO_VAL;
 245 extern struct req_msg_field RMF_GETINFO_VALLEN;
 246 extern struct req_msg_field RMF_GETINFO_KEY;
 247 extern struct req_msg_field RMF_IDX_INFO;
 248
 249 /*
 250  * connection handle received in MDS_CONNECT request.
 251  */
 252 extern struct req_msg_field RMF_CONN;
 253 extern struct req_msg_field RMF_CONNECT_DATA;
 254 extern struct req_msg_field RMF_DLM_REQ;
 255 extern struct req_msg_field RMF_DLM_REP;
 256 extern struct req_msg_field RMF_DLM_LVB;
 257 extern struct req_msg_field RMF_DLM_GL_DESC;
 258 extern struct req_msg_field RMF_LDLM_INTENT;
 259 extern struct req_msg_field RMF_MDT_MD;
 260 extern struct req_msg_field RMF_REC_REINT;
 261 extern struct req_msg_field RMF_EADATA;
 262 extern struct req_msg_field RMF_ACL;
 263 extern struct req_msg_field RMF_LOGCOOKIES;
 264 extern struct req_msg_field RMF_CAPA1;
 265 extern struct req_msg_field RMF_CAPA2;
 266 extern struct req_msg_field RMF_OBD_QUOTACHECK;
 267 extern struct req_msg_field RMF_OBD_QUOTACTL;
 268 extern struct req_msg_field RMF_QUOTA_ADJUST_QUNIT;
 269 extern struct req_msg_field RMF_QUNIT_DATA;
 270 extern struct req_msg_field RMF_QUOTA_BODY;
 271 extern struct req_msg_field RMF_STRING;
 272
 273 /* seq-mgr fields */
 274 extern struct req_msg_field RMF_SEQ_OPC;
 275 extern struct req_msg_field RMF_SEQ_RANGE;
 276
 277 /* FLD fields */
 278 extern struct req_msg_field RMF_FLD_OPC;
 279 extern struct req_msg_field RMF_FLD_MDFLD;
 280
 281 extern struct req_msg_field RMF_LLOGD_BODY;
 282 extern struct req_msg_field RMF_LLOG_LOG_HDR;
 283 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
 284
 285 extern struct req_msg_field RMF_MGS_TARGET_INFO;
 286 extern struct req_msg_field RMF_MGS_SEND_PARAM;
 287
 288 extern struct req_msg_field RMF_OST_BODY;
 289 extern struct req_msg_field RMF_OBD_IOOBJ;
 290 extern struct req_msg_field RMF_OBD_ID;
 291 extern struct req_msg_field RMF_NIOBUF_REMOTE;
 292 extern struct req_msg_field RMF_RCS;
 293 extern struct req_msg_field RMF_FIEMAP_KEY;
 294 extern struct req_msg_field RMF_FIEMAP_VAL;
 295
 296 /* MGS config read message format */
 297 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
 298 extern struct req_msg_field RMF_MGS_CONFIG_RES;
 299
 300 /* generic uint32 */
 301 extern struct req_msg_field RMF_U32;
 302
 303 /** @} req_layout */
 304
 305 #endif /* _LUSTRE_REQ_LAYOUT_H__ */