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  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 struct req_msg_field;
  47 struct req_format;
  48 struct req_capsule;
  49
  50 struct ptlrpc_request;
  51
  52 enum req_location {
  53         RCL_CLIENT,
  54         RCL_SERVER,
  55         RCL_NR
  56 };
  57
  58 /* Maximal number of fields (buffers) in a request message. */
  59 #define REQ_MAX_FIELD_NR  9
  60
  61 struct req_capsule {
  62         struct ptlrpc_request   *rc_req;
  63         const struct req_format *rc_fmt;
  64         enum req_location        rc_loc;
  65         __u32                    rc_area[RCL_NR][REQ_MAX_FIELD_NR];
  66 };
  67
  68 #if !defined(__REQ_LAYOUT_USER__)
  69
  70 /* struct ptlrpc_request, lustre_msg* */
  71 #include <lustre_net.h>
  72
  73 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  74                       enum req_location location);
  75 void req_capsule_fini(struct req_capsule *pill);
  76
  77 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  78 void req_capsule_client_dump(struct req_capsule *pill);
  79 void req_capsule_server_dump(struct req_capsule *pill);
  80 void req_capsule_init_area(struct req_capsule *pill);
  81 int req_capsule_filled_sizes(struct req_capsule *pill, enum req_location loc);
  82 int  req_capsule_server_pack(struct req_capsule *pill);
  83
  84 void *req_capsule_client_get(struct req_capsule *pill,
  85                              const struct req_msg_field *field);
  86 void *req_capsule_client_swab_get(struct req_capsule *pill,
  87                                   const struct req_msg_field *field,
  88                                   void (*swabber)(void*));
  89 void *req_capsule_client_sized_get(struct req_capsule *pill,
  90                                    const struct req_msg_field *field,
  91                                    int len);
  92 void *req_capsule_server_get(struct req_capsule *pill,
  93                              const struct req_msg_field *field);
  94 void *req_capsule_server_sized_get(struct req_capsule *pill,
  95                                    const struct req_msg_field *field,
  96                                    int len);
  97 void *req_capsule_server_swab_get(struct req_capsule *pill,
  98                                   const struct req_msg_field *field,
  99                                   void *swabber);
 100 const void *req_capsule_other_get(struct req_capsule *pill,
 101                                   const struct req_msg_field *field);
 102
 103 void req_capsule_set_size(struct req_capsule *pill,
 104                           const struct req_msg_field *field,
 105                           enum req_location loc, int size);
 106 int req_capsule_get_size(const struct req_capsule *pill,
 107                           const struct req_msg_field *field,
 108                           enum req_location loc);
 109 int req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
 110 int req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
 111                          enum req_location loc);
 112 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
 113
 114 int req_capsule_has_field(const struct req_capsule *pill,
 115                           const struct req_msg_field *field,
 116                           enum req_location loc);
 117 int req_capsule_field_present(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
 125 int  req_layout_init(void);
 126 void req_layout_fini(void);
 127
 128 /* __REQ_LAYOUT_USER__ */
 129 #endif
 130
 131 extern const struct req_format RQF_OBD_PING;
 132 extern const struct req_format RQF_OBD_SET_INFO;
 133 extern const struct req_format RQF_SEC_CTX;
 134 /* MGS req_format */
 135 extern const struct req_format RQF_MGS_TARGET_REG;
 136 extern const struct req_format RQF_MGS_SET_INFO;
 137 /* fid/fld req_format */
 138 extern const struct req_format RQF_SEQ_QUERY;
 139 extern const struct req_format RQF_FLD_QUERY;
 140 /* MDS req_format */
 141 extern const struct req_format RQF_MDS_CONNECT;
 142 extern const struct req_format RQF_MDS_DISCONNECT;
 143 extern const struct req_format RQF_MDS_STATFS;
 144 extern const struct req_format RQF_MDS_GETSTATUS;
 145 extern const struct req_format RQF_MDS_SYNC;
 146 extern const struct req_format RQF_MDS_GETXATTR;
 147 extern const struct req_format RQF_MDS_GETATTR;
 148 /*
 149  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 150  */
 151 extern const struct req_format RQF_MDS_GETATTR_NAME;
 152 extern const struct req_format RQF_MDS_CLOSE;
 153 extern const struct req_format RQF_MDS_PIN;
 154 extern const struct req_format RQF_MDS_UNPIN;
 155 extern const struct req_format RQF_MDS_CONNECT;
 156 extern const struct req_format RQF_MDS_DISCONNECT;
 157 extern const struct req_format RQF_MDS_GET_INFO;
 158 extern const struct req_format RQF_MDS_READPAGE;
 159 extern const struct req_format RQF_MDS_WRITEPAGE;
 160 extern const struct req_format RQF_MDS_IS_SUBDIR;
 161 extern const struct req_format RQF_MDS_DONE_WRITING;
 162 extern const struct req_format RQF_MDS_REINT;
 163 extern const struct req_format RQF_MDS_REINT_CREATE;
 164 extern const struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
 165 extern const struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 166 extern const struct req_format RQF_MDS_REINT_CREATE_SYM;
 167 extern const struct req_format RQF_MDS_REINT_OPEN;
 168 extern const struct req_format RQF_MDS_REINT_UNLINK;
 169 extern const struct req_format RQF_MDS_REINT_LINK;
 170 extern const struct req_format RQF_MDS_REINT_RENAME;
 171 extern const struct req_format RQF_MDS_REINT_SETATTR;
 172 extern const struct req_format RQF_MDS_REINT_SETXATTR;
 173 extern const struct req_format RQF_MDS_QUOTACHECK;
 174 extern const struct req_format RQF_MDS_QUOTACTL;
 175 extern const struct req_format RQF_MDS_QUOTA_DQACQ;
 176 extern const struct req_format RQF_QC_CALLBACK;
 177 /* OST req_format */
 178 extern const struct req_format RQF_OST_CONNECT;
 179 extern const struct req_format RQF_OST_DISCONNECT;
 180 extern const struct req_format RQF_OST_QUOTACHECK;
 181 extern const struct req_format RQF_OST_QUOTACTL;
 182 extern const struct req_format RQF_OST_QUOTA_ADJUST_QUNIT;
 183 extern const struct req_format RQF_OST_GETATTR;
 184 extern const struct req_format RQF_OST_SETATTR;
 185 extern const struct req_format RQF_OST_CREATE;
 186 extern const struct req_format RQF_OST_PUNCH;
 187 extern const struct req_format RQF_OST_SYNC;
 188 extern const struct req_format RQF_OST_DESTROY;
 189 extern const struct req_format RQF_OST_BRW;
 190 extern const struct req_format RQF_OST_STATFS;
 191 extern const struct req_format RQF_OST_SET_GRANT_INFO;
 192 extern const struct req_format RQF_OST_GET_INFO_GENERIC;
 193 extern const struct req_format RQF_OST_GET_INFO_LAST_ID;
 194 extern const struct req_format RQF_OST_GET_INFO_FIEMAP;
 195
 196 /* LDLM req_format */
 197 extern const struct req_format RQF_LDLM_ENQUEUE;
 198 extern const struct req_format RQF_LDLM_ENQUEUE_LVB;
 199 extern const struct req_format RQF_LDLM_CONVERT;
 200 extern const struct req_format RQF_LDLM_INTENT;
 201 extern const struct req_format RQF_LDLM_INTENT_GETATTR;
 202 extern const struct req_format RQF_LDLM_INTENT_OPEN;
 203 extern const struct req_format RQF_LDLM_INTENT_CREATE;
 204 extern const struct req_format RQF_LDLM_INTENT_UNLINK;
 205 extern const struct req_format RQF_LDLM_CANCEL;
 206 extern const struct req_format RQF_LDLM_CALLBACK;
 207 extern const struct req_format RQF_LDLM_CP_CALLBACK;
 208 extern const struct req_format RQF_LDLM_BL_CALLBACK;
 209 extern const struct req_format RQF_LDLM_GL_CALLBACK;
 210 /* LOG req_format */
 211 extern const struct req_format RQF_LOG_CANCEL;
 212 extern const struct req_format RQF_LLOG_CATINFO;
 213 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 214 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
 215 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 216 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 217 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 218 extern const struct req_format RQF_LLOG_ORIGIN_CONNECT;
 219
 220 extern const struct req_msg_field RMF_GENERIC_DATA;
 221 extern const struct req_msg_field RMF_PTLRPC_BODY;
 222 extern const struct req_msg_field RMF_MDT_BODY;
 223 extern const struct req_msg_field RMF_MDT_EPOCH;
 224 extern const struct req_msg_field RMF_OBD_STATFS;
 225 extern const struct req_msg_field RMF_NAME;
 226 extern const struct req_msg_field RMF_SYMTGT;
 227 extern const struct req_msg_field RMF_TGTUUID;
 228 extern const struct req_msg_field RMF_CLUUID;
 229 extern const struct req_msg_field RMF_SETINFO_VAL;
 230 extern const struct req_msg_field RMF_SETINFO_KEY;
 231 extern const struct req_msg_field RMF_GETINFO_VAL;
 232 extern const struct req_msg_field RMF_GETINFO_VALLEN;
 233 extern const struct req_msg_field RMF_GETINFO_KEY;
 234
 235 /*
 236  * connection handle received in MDS_CONNECT request.
 237  */
 238 extern const struct req_msg_field RMF_CONN;
 239 extern const struct req_msg_field RMF_CONNECT_DATA;
 240 extern const struct req_msg_field RMF_DLM_REQ;
 241 extern const struct req_msg_field RMF_DLM_REP;
 242 extern const struct req_msg_field RMF_DLM_LVB;
 243 extern const struct req_msg_field RMF_LDLM_INTENT;
 244 extern const struct req_msg_field RMF_MDT_MD;
 245 extern const struct req_msg_field RMF_REC_REINT;
 246 extern const struct req_msg_field RMF_EADATA;
 247 extern const struct req_msg_field RMF_ACL;
 248 extern const struct req_msg_field RMF_LOGCOOKIES;
 249 extern const struct req_msg_field RMF_CAPA1;
 250 extern const struct req_msg_field RMF_CAPA2;
 251 extern const struct req_msg_field RMF_OBD_QUOTACHECK;
 252 extern const struct req_msg_field RMF_OBD_QUOTACTL;
 253 extern const struct req_msg_field RMF_QUOTA_ADJUST_QUNIT;
 254 extern const struct req_msg_field RMF_QUNIT_DATA;
 255 extern const struct req_msg_field RMF_STRING;
 256
 257 /* seq-mgr fields */
 258 extern const struct req_msg_field RMF_SEQ_OPC;
 259 extern const struct req_msg_field RMF_SEQ_RANGE;
 260
 261 /* FLD fields */
 262 extern const struct req_msg_field RMF_FLD_OPC;
 263 extern const struct req_msg_field RMF_FLD_MDFLD;
 264
 265 extern const struct req_msg_field RMF_LLOGD_BODY;
 266 extern const struct req_msg_field RMF_LLOG_LOG_HDR;
 267 extern const struct req_msg_field RMF_LLOGD_CONN_BODY;
 268
 269 extern const struct req_msg_field RMF_MGS_TARGET_INFO;
 270 extern const struct req_msg_field RMF_MGS_SEND_PARAM;
 271
 272 extern const struct req_msg_field RMF_OST_BODY;
 273 extern const struct req_msg_field RMF_OBD_IOOBJ;
 274 extern const struct req_msg_field RMF_OBD_ID;
 275 extern const struct req_msg_field RMF_NIOBUF_REMOTE;
 276 extern const struct req_msg_field RMF_RCS;
 277 extern const struct req_msg_field RMF_FIEMAP_KEY;
 278 extern const struct req_msg_field RMF_FIEMAP_VAL;
 279
 280 #endif /* _LUSTRE_REQ_LAYOUT_H__ */