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  *  lustre/include/linux/lustre_req_layout.h
   5  *  Lustre Metadata Target (mdt) request handler
   6  *
   7  *  Copyright (c) 2006 Cluster File Systems, Inc.
   8  *   Author: Nikita Danilov <nikita@clusterfs.com>
   9  *
  10  *   This file is part of the Lustre file system, http://www.lustre.org
  11  *   Lustre is a trademark of Cluster File Systems, Inc.
  12  *
  13  *   You may have signed or agreed to another license before downloading
  14  *   this software.  If so, you are bound by the terms and conditions
  15  *   of that agreement, and the following does not apply to you.  See the
  16  *   LICENSE file included with this distribution for more information.
  17  *
  18  *   If you did not agree to a different license, then this copy of Lustre
  19  *   is open source software; you can redistribute it and/or modify it
  20  *   under the terms of version 2 of the GNU General Public License as
  21  *   published by the Free Software Foundation.
  22  *
  23  *   In either case, Lustre is distributed in the hope that it will be
  24  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  25  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *   license text for more details.
  27  */
  28
  29 #ifndef _LUSTRE_REQ_LAYOUT_H__
  30 #define _LUSTRE_REQ_LAYOUT_H__
  31
  32 struct req_msg_field;
  33 struct req_format;
  34 struct req_capsule;
  35
  36 struct ptlrpc_request;
  37
  38 enum req_location {
  39         RCL_CLIENT,
  40         RCL_SERVER,
  41         RCL_NR
  42 };
  43
  44 /* Maximal number of fields (buffers) in a request message. */
  45 #define REQ_MAX_FIELD_NR  9
  46
  47 struct req_capsule {
  48         struct ptlrpc_request   *rc_req;
  49         const struct req_format *rc_fmt;
  50         __u32                    rc_swabbed;
  51         enum req_location        rc_loc;
  52         int                      rc_area[RCL_NR][REQ_MAX_FIELD_NR];
  53 };
  54
  55 #if !defined(__REQ_LAYOUT_USER__)
  56
  57 /* struct ptlrpc_request, lustre_msg* */
  58 #include <lustre_net.h>
  59
  60 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  61                       enum req_location location);
  62 void req_capsule_fini(struct req_capsule *pill);
  63
  64 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  65 void req_capsule_init_area(struct req_capsule *pill);
  66 int req_capsule_filled_sizes(struct req_capsule *pill, enum req_location loc);
  67 int  req_capsule_server_pack(struct req_capsule *pill);
  68
  69 void *req_capsule_client_get(struct req_capsule *pill,
  70                              const struct req_msg_field *field);
  71 void *req_capsule_client_swab_get(struct req_capsule *pill,
  72                                   const struct req_msg_field *field,
  73                                   void (*swabber)(void*));
  74 void *req_capsule_client_sized_get(struct req_capsule *pill,
  75                                    const struct req_msg_field *field,
  76                                    int len);
  77 void *req_capsule_server_get(struct req_capsule *pill,
  78                              const struct req_msg_field *field);
  79 void *req_capsule_server_sized_get(struct req_capsule *pill,
  80                                    const struct req_msg_field *field,
  81                                    int len);
  82 void *req_capsule_server_swab_get(struct req_capsule *pill,
  83                                   const struct req_msg_field *field,
  84                                   void *swabber);
  85 const void *req_capsule_other_get(struct req_capsule *pill,
  86                                   const struct req_msg_field *field);
  87
  88 void req_capsule_set_size(struct req_capsule *pill,
  89                           const struct req_msg_field *field,
  90                           enum req_location loc, int size);
  91 int req_capsule_get_size(const struct req_capsule *pill,
  92                           const struct req_msg_field *field,
  93                           enum req_location loc);
  94 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
  95
  96 int req_capsule_has_field(const struct req_capsule *pill,
  97                           const struct req_msg_field *field,
  98                           enum req_location loc);
  99 int req_capsule_field_present(const struct req_capsule *pill,
 100                               const struct req_msg_field *field,
 101                               enum req_location loc);
 102 void req_capsule_shrink(struct req_capsule *pill,
 103                         const struct req_msg_field *field,
 104                         unsigned int newlen,
 105                         enum req_location loc);
 106
 107 int  req_layout_init(void);
 108 void req_layout_fini(void);
 109
 110 /* __REQ_LAYOUT_USER__ */
 111 #endif
 112
 113 extern const struct req_format RQF_OBD_PING;
 114 extern const struct req_format RQF_SEC_CTX;
 115 /* MGS req_format */
 116 extern const struct req_format RQF_MGS_TARGET_REG;
 117 extern const struct req_format RQF_MGS_SET_INFO;
 118 /* fid/fld req_format */
 119 extern const struct req_format RQF_SEQ_QUERY;
 120 extern const struct req_format RQF_FLD_QUERY;
 121 /* MDS req_format */
 122 extern const struct req_format RQF_MDS_CONNECT;
 123 extern const struct req_format RQF_MDS_DISCONNECT;
 124 extern const struct req_format RQF_MDS_STATFS;
 125 extern const struct req_format RQF_MDS_GETSTATUS;
 126 extern const struct req_format RQF_MDS_SYNC;
 127 extern const struct req_format RQF_MDS_GETXATTR;
 128 extern const struct req_format RQF_MDS_GETATTR;
 129 /*
 130  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 131  */
 132 extern const struct req_format RQF_MDS_GETATTR_NAME;
 133 extern const struct req_format RQF_MDS_CLOSE;
 134 extern const struct req_format RQF_MDS_PIN;
 135 extern const struct req_format RQF_MDS_UNPIN;
 136 extern const struct req_format RQF_MDS_CONNECT;
 137 extern const struct req_format RQF_MDS_DISCONNECT;
 138 extern const struct req_format RQF_MDS_SET_INFO;
 139 extern const struct req_format RQF_MDS_READPAGE;
 140 extern const struct req_format RQF_MDS_WRITEPAGE;
 141 extern const struct req_format RQF_MDS_IS_SUBDIR;
 142 extern const struct req_format RQF_MDS_DONE_WRITING;
 143 extern const struct req_format RQF_MDS_REINT;
 144 extern const struct req_format RQF_MDS_REINT_CREATE;
 145 extern const struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
 146 extern const struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 147 extern const struct req_format RQF_MDS_REINT_CREATE_SYM;
 148 extern const struct req_format RQF_MDS_REINT_OPEN;
 149 extern const struct req_format RQF_MDS_REINT_UNLINK;
 150 extern const struct req_format RQF_MDS_REINT_LINK;
 151 extern const struct req_format RQF_MDS_REINT_RENAME;
 152 extern const struct req_format RQF_MDS_REINT_SETATTR;
 153 extern const struct req_format RQF_MDS_REINT_SETXATTR;
 154 extern const struct req_format RQF_MDS_QUOTACHECK;
 155 extern const struct req_format RQF_MDS_QUOTACTL;
 156 extern const struct req_format RQF_MDS_QUOTA_DQACQ;
 157 extern const struct req_format RQF_QC_CALLBACK;
 158 /* OST req_format */
 159 extern const struct req_format RQF_OST_CONNECT;
 160 extern const struct req_format RQF_OST_DISCONNECT;
 161 extern const struct req_format RQF_OST_QUOTACHECK;
 162 extern const struct req_format RQF_OST_QUOTACTL;
 163 extern const struct req_format RQF_OST_GETATTR;
 164 extern const struct req_format RQF_OST_SETATTR;
 165 extern const struct req_format RQF_OST_CREATE;
 166 extern const struct req_format RQF_OST_PUNCH;
 167 extern const struct req_format RQF_OST_SYNC;
 168 extern const struct req_format RQF_OST_DESTROY;
 169 extern const struct req_format RQF_OST_BRW;
 170 extern const struct req_format RQF_OST_STATFS;
 171 extern const struct req_format RQF_OST_SET_INFO;
 172 extern const struct req_format RQF_OST_GET_INFO;
 173
 174 /* LDLM req_format */
 175 extern const struct req_format RQF_LDLM_ENQUEUE;
 176 extern const struct req_format RQF_LDLM_ENQUEUE_LVB;
 177 extern const struct req_format RQF_LDLM_CONVERT;
 178 extern const struct req_format RQF_LDLM_INTENT;
 179 extern const struct req_format RQF_LDLM_INTENT_GETATTR;
 180 extern const struct req_format RQF_LDLM_INTENT_OPEN;
 181 extern const struct req_format RQF_LDLM_INTENT_CREATE;
 182 extern const struct req_format RQF_LDLM_INTENT_UNLINK;
 183 extern const struct req_format RQF_LDLM_CANCEL;
 184 extern const struct req_format RQF_LDLM_CALLBACK;
 185 extern const struct req_format RQF_LDLM_CP_CALLBACK;
 186 extern const struct req_format RQF_LDLM_BL_CALLBACK;
 187 extern const struct req_format RQF_LDLM_GL_CALLBACK;
 188 /* LOG req_format */
 189 extern const struct req_format RQF_LOG_CANCEL;
 190 extern const struct req_format RQF_LLOG_CATINFO;
 191 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 192 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
 193 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 194 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 195 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 196 extern const struct req_format RQF_LLOG_ORIGIN_CONNECT;
 197
 198 extern const struct req_msg_field RMF_PTLRPC_BODY;
 199 extern const struct req_msg_field RMF_MDT_BODY;
 200 extern const struct req_msg_field RMF_MDT_EPOCH;
 201 extern const struct req_msg_field RMF_OBD_STATFS;
 202 extern const struct req_msg_field RMF_NAME;
 203 extern const struct req_msg_field RMF_SYMTGT;
 204 extern const struct req_msg_field RMF_TGTUUID;
 205 extern const struct req_msg_field RMF_CLUUID;
 206 extern const struct req_msg_field RMF_SETINFO_VAL;
 207 extern const struct req_msg_field RMF_SETINFO_KEY;
 208 /*
 209  * connection handle received in MDS_CONNECT request.
 210  */
 211 extern const struct req_msg_field RMF_CONN;
 212 extern const struct req_msg_field RMF_CONNECT_DATA;
 213 extern const struct req_msg_field RMF_DLM_REQ;
 214 extern const struct req_msg_field RMF_DLM_REP;
 215 extern const struct req_msg_field RMF_DLM_LVB;
 216 extern const struct req_msg_field RMF_LDLM_INTENT;
 217 extern const struct req_msg_field RMF_MDT_MD;
 218 extern const struct req_msg_field RMF_REC_REINT;
 219 extern const struct req_msg_field RMF_REC_JOINFILE;
 220 extern const struct req_msg_field RMF_EADATA;
 221 extern const struct req_msg_field RMF_ACL;
 222 extern const struct req_msg_field RMF_LOGCOOKIES;
 223 extern const struct req_msg_field RMF_CAPA1;
 224 extern const struct req_msg_field RMF_CAPA2;
 225 extern const struct req_msg_field RMF_OBD_QUOTACHECK;
 226 extern const struct req_msg_field RMF_OBD_QUOTACTL;
 227 extern const struct req_msg_field RMF_QUNIT_DATA;
 228 extern const struct req_msg_field RMF_STRING;
 229
 230 /* seq-mgr fields */
 231 extern const struct req_msg_field RMF_SEQ_OPC;
 232 extern const struct req_msg_field RMF_SEQ_RANGE;
 233
 234 /* FLD fields */
 235 extern const struct req_msg_field RMF_FLD_OPC;
 236 extern const struct req_msg_field RMF_FLD_MDFLD;
 237
 238 extern const struct req_msg_field RMF_LLOGD_BODY;
 239 extern const struct req_msg_field RMF_LLOG_LOG_HDR;
 240 extern const struct req_msg_field RMF_LLOGD_CONN_BODY;
 241
 242 extern const struct req_msg_field RMF_MGS_TARGET_INFO;
 243 extern const struct req_msg_field RMF_MGS_SEND_PARAM;
 244
 245 extern const struct req_msg_field RMF_OST_BODY;
 246 extern const struct req_msg_field RMF_OBD_IOOBJ;
 247 extern const struct req_msg_field RMF_OBD_ID;
 248 extern const struct req_msg_field RMF_NIOBUF_REMOTE;
 249
 250 #endif /* _LUSTRE_REQ_LAYOUT_H__ */