lustre/include/lustre_req_layout.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  *
  38  * lustre/include/lustre_req_layout.h
  39  *
  40  * Lustre Metadata Target (mdt) request handler
  41  *
  42  * Author: Nikita Danilov <nikita@clusterfs.com>
  43  */
  44
  45 #ifndef _LUSTRE_REQ_LAYOUT_H__
  46 #define _LUSTRE_REQ_LAYOUT_H__
  47
  48 /** \defgroup req_layout req_layout
  49  *
  50  * @{
  51  */
  52
  53 struct req_msg_field;
  54 struct req_format;
  55 struct req_capsule;
  56
  57 struct ptlrpc_request;
  58
  59 enum req_location {
  60         RCL_CLIENT,
  61         RCL_SERVER,
  62         RCL_NR
  63 };
  64
  65 /* Maximal number of fields (buffers) in a request message. */
  66 #define REQ_MAX_FIELD_NR  9
  67
  68 struct req_capsule {
  69         struct ptlrpc_request   *rc_req;
  70         const struct req_format *rc_fmt;
  71         enum req_location        rc_loc;
  72         __u32                    rc_area[RCL_NR][REQ_MAX_FIELD_NR];
  73 };
  74
  75 #if !defined(__REQ_LAYOUT_USER__)
  76
  77 /* struct ptlrpc_request, lustre_msg* */
  78 #include <lustre_net.h>
  79
  80 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  81                       enum req_location location);
  82 void req_capsule_fini(struct req_capsule *pill);
  83
  84 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  85 void req_capsule_client_dump(struct req_capsule *pill);
  86 void req_capsule_server_dump(struct req_capsule *pill);
  87 void req_capsule_init_area(struct req_capsule *pill);
  88 int req_capsule_filled_sizes(struct req_capsule *pill, enum req_location loc);
  89 int  req_capsule_server_pack(struct req_capsule *pill);
  90
  91 void *req_capsule_client_get(struct req_capsule *pill,
  92                              const struct req_msg_field *field);
  93 void *req_capsule_client_swab_get(struct req_capsule *pill,
  94                                   const struct req_msg_field *field,
  95                                   void (*swabber)(void*));
  96 void *req_capsule_client_sized_get(struct req_capsule *pill,
  97                                    const struct req_msg_field *field,
  98                                    int len);
  99 void *req_capsule_server_get(struct req_capsule *pill,
 100                              const struct req_msg_field *field);
 101 void *req_capsule_server_sized_get(struct req_capsule *pill,
 102                                    const struct req_msg_field *field,
 103                                    int len);
 104 void *req_capsule_server_swab_get(struct req_capsule *pill,
 105                                   const struct req_msg_field *field,
 106                                   void *swabber);
 107 const void *req_capsule_other_get(struct req_capsule *pill,
 108                                   const struct req_msg_field *field);
 109
 110 void req_capsule_set_size(struct req_capsule *pill,
 111                           const struct req_msg_field *field,
 112                           enum req_location loc, int size);
 113 int req_capsule_get_size(const struct req_capsule *pill,
 114                           const struct req_msg_field *field,
 115                           enum req_location loc);
 116 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
 117 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
 118                          enum req_location loc);
 119 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
 120
 121 int req_capsule_has_field(const struct req_capsule *pill,
 122                           const struct req_msg_field *field,
 123                           enum req_location loc);
 124 int req_capsule_field_present(const struct req_capsule *pill,
 125                               const struct req_msg_field *field,
 126                               enum req_location loc);
 127 void req_capsule_shrink(struct req_capsule *pill,
 128                         const struct req_msg_field *field,
 129                         unsigned int newlen,
 130                         enum req_location loc);
 131
 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 /* MGS req_format */
 142 extern struct req_format RQF_MGS_TARGET_REG;
 143 extern struct req_format RQF_MGS_SET_INFO;
 144 extern struct req_format RQF_MGS_CONFIG_READ;
 145 /* fid/fld req_format */
 146 extern struct req_format RQF_SEQ_QUERY;
 147 extern struct req_format RQF_FLD_QUERY;
 148 /* MDS req_format */
 149 extern struct req_format RQF_MDS_CONNECT;
 150 extern struct req_format RQF_MDS_DISCONNECT;
 151 extern struct req_format RQF_MDS_STATFS;
 152 extern struct req_format RQF_MDS_GETSTATUS;
 153 extern struct req_format RQF_MDS_SYNC;
 154 extern struct req_format RQF_MDS_GETXATTR;
 155 extern struct req_format RQF_MDS_GETATTR;
 156 /*
 157  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 158  */
 159 extern struct req_format RQF_MDS_GETATTR_NAME;
 160 extern struct req_format RQF_MDS_CLOSE;
 161 extern struct req_format RQF_MDS_PIN;
 162 extern struct req_format RQF_MDS_UNPIN;
 163 extern struct req_format RQF_MDS_CONNECT;
 164 extern struct req_format RQF_MDS_DISCONNECT;
 165 extern struct req_format RQF_MDS_GET_INFO;
 166 extern struct req_format RQF_MDS_READPAGE;
 167 extern struct req_format RQF_MDS_WRITEPAGE;
 168 extern struct req_format RQF_MDS_IS_SUBDIR;
 169 extern struct req_format RQF_MDS_DONE_WRITING;
 170 extern struct req_format RQF_MDS_REINT;
 171 extern struct req_format RQF_MDS_REINT_CREATE;
 172 extern struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
 173 extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 174 extern struct req_format RQF_MDS_REINT_CREATE_SYM;
 175 extern struct req_format RQF_MDS_REINT_OPEN;
 176 extern struct req_format RQF_MDS_REINT_UNLINK;
 177 extern struct req_format RQF_MDS_REINT_LINK;
 178 extern struct req_format RQF_MDS_REINT_RENAME;
 179 extern struct req_format RQF_MDS_REINT_SETATTR;
 180 extern struct req_format RQF_MDS_REINT_SETXATTR;
 181 extern struct req_format RQF_MDS_QUOTACHECK;
 182 extern struct req_format RQF_MDS_QUOTACTL;
 183 extern struct req_format RQF_MDS_QUOTA_DQACQ;
 184 extern struct req_format RQF_QC_CALLBACK;
 185 /* OST req_format */
 186 extern struct req_format RQF_OST_CONNECT;
 187 extern struct req_format RQF_OST_DISCONNECT;
 188 extern struct req_format RQF_OST_QUOTACHECK;
 189 extern struct req_format RQF_OST_QUOTACTL;
 190 extern struct req_format RQF_OST_QUOTA_ADJUST_QUNIT;
 191 extern struct req_format RQF_OST_GETATTR;
 192 extern struct req_format RQF_OST_SETATTR;
 193 extern struct req_format RQF_OST_CREATE;
 194 extern struct req_format RQF_OST_PUNCH;
 195 extern struct req_format RQF_OST_SYNC;
 196 extern struct req_format RQF_OST_DESTROY;
 197 extern struct req_format RQF_OST_BRW_READ;
 198 extern struct req_format RQF_OST_BRW_WRITE;
 199 extern struct req_format RQF_OST_STATFS;
 200 extern struct req_format RQF_OST_SET_GRANT_INFO;
 201 extern struct req_format RQF_OST_GET_INFO_GENERIC;
 202 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
 203 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
 204
 205 /* LDLM req_format */
 206 extern struct req_format RQF_LDLM_ENQUEUE;
 207 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
 208 extern struct req_format RQF_LDLM_CONVERT;
 209 extern struct req_format RQF_LDLM_INTENT;
 210 extern struct req_format RQF_LDLM_INTENT_GETATTR;
 211 extern struct req_format RQF_LDLM_INTENT_OPEN;
 212 extern struct req_format RQF_LDLM_INTENT_CREATE;
 213 extern struct req_format RQF_LDLM_INTENT_UNLINK;
 214 extern struct req_format RQF_LDLM_CANCEL;
 215 extern struct req_format RQF_LDLM_CALLBACK;
 216 extern struct req_format RQF_LDLM_CP_CALLBACK;
 217 extern struct req_format RQF_LDLM_BL_CALLBACK;
 218 extern struct req_format RQF_LDLM_GL_CALLBACK;
 219 /* LOG req_format */
 220 extern struct req_format RQF_LOG_CANCEL;
 221 extern struct req_format RQF_LLOG_CATINFO;
 222 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 223 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
 224 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 225 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 226 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 227 extern struct req_format RQF_LLOG_ORIGIN_CONNECT;
 228
 229 extern struct req_msg_field RMF_GENERIC_DATA;
 230 extern struct req_msg_field RMF_PTLRPC_BODY;
 231 extern struct req_msg_field RMF_MDT_BODY;
 232 extern struct req_msg_field RMF_MDT_EPOCH;
 233 extern struct req_msg_field RMF_OBD_STATFS;
 234 extern struct req_msg_field RMF_NAME;
 235 extern struct req_msg_field RMF_SYMTGT;
 236 extern struct req_msg_field RMF_TGTUUID;
 237 extern struct req_msg_field RMF_CLUUID;
 238 extern struct req_msg_field RMF_SETINFO_VAL;
 239 extern struct req_msg_field RMF_SETINFO_KEY;
 240 extern struct req_msg_field RMF_GETINFO_VAL;
 241 extern struct req_msg_field RMF_GETINFO_VALLEN;
 242 extern struct req_msg_field RMF_GETINFO_KEY;
 243
 244 /*
 245  * connection handle received in MDS_CONNECT request.
 246  */
 247 extern struct req_msg_field RMF_CONN;
 248 extern struct req_msg_field RMF_CONNECT_DATA;
 249 extern struct req_msg_field RMF_DLM_REQ;
 250 extern struct req_msg_field RMF_DLM_REP;
 251 extern struct req_msg_field RMF_DLM_LVB;
 252 extern struct req_msg_field RMF_LDLM_INTENT;
 253 extern struct req_msg_field RMF_MDT_MD;
 254 extern struct req_msg_field RMF_REC_REINT;
 255 extern struct req_msg_field RMF_EADATA;
 256 extern struct req_msg_field RMF_ACL;
 257 extern struct req_msg_field RMF_LOGCOOKIES;
 258 extern struct req_msg_field RMF_CAPA1;
 259 extern struct req_msg_field RMF_CAPA2;
 260 extern struct req_msg_field RMF_OBD_QUOTACHECK;
 261 extern struct req_msg_field RMF_OBD_QUOTACTL;
 262 extern struct req_msg_field RMF_QUOTA_ADJUST_QUNIT;
 263 extern struct req_msg_field RMF_QUNIT_DATA;
 264 extern struct req_msg_field RMF_STRING;
 265
 266 /* seq-mgr fields */
 267 extern struct req_msg_field RMF_SEQ_OPC;
 268 extern struct req_msg_field RMF_SEQ_RANGE;
 269
 270 /* FLD fields */
 271 extern struct req_msg_field RMF_FLD_OPC;
 272 extern struct req_msg_field RMF_FLD_MDFLD;
 273
 274 extern struct req_msg_field RMF_LLOGD_BODY;
 275 extern struct req_msg_field RMF_LLOG_LOG_HDR;
 276 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
 277
 278 extern struct req_msg_field RMF_MGS_TARGET_INFO;
 279 extern struct req_msg_field RMF_MGS_SEND_PARAM;
 280
 281 extern struct req_msg_field RMF_OST_BODY;
 282 extern struct req_msg_field RMF_OBD_IOOBJ;
 283 extern struct req_msg_field RMF_OBD_ID;
 284 extern struct req_msg_field RMF_NIOBUF_REMOTE;
 285 extern struct req_msg_field RMF_RCS;
 286 extern struct req_msg_field RMF_FIEMAP_KEY;
 287 extern struct req_msg_field RMF_FIEMAP_VAL;
 288
 289 /* MGS config read message format */
 290 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
 291 extern struct req_msg_field RMF_MGS_CONFIG_RES;
 292
 293 /* generic uint32 */
 294 extern struct req_msg_field RMF_U32;
 295
 296 /** @} req_layout */
 297
 298 #endif /* _LUSTRE_REQ_LAYOUT_H__ */