1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre_req_layout.h
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 #ifndef _LUSTRE_REQ_LAYOUT_H__
44 #define _LUSTRE_REQ_LAYOUT_H__
46 /** \defgroup req_layout req_layout
55 struct ptlrpc_request;
63 /* Maximal number of fields (buffers) in a request message. */
64 #define REQ_MAX_FIELD_NR 9
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];
73 #if !defined(__REQ_LAYOUT_USER__)
75 /* struct ptlrpc_request, lustre_msg* */
76 #include <lustre_net.h>
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);
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);
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,
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,
102 void *req_capsule_server_swab_get(struct req_capsule *pill,
103 const struct req_msg_field *field,
105 const void *req_capsule_other_get(struct req_capsule *pill,
106 const struct req_msg_field *field);
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);
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,
128 enum req_location loc);
130 int req_layout_init(void);
131 void req_layout_fini(void);
133 /* __REQ_LAYOUT_USER__ */
136 extern const struct req_format RQF_OBD_PING;
137 extern const struct req_format RQF_OBD_SET_INFO;
138 extern const struct req_format RQF_SEC_CTX;
140 extern const struct req_format RQF_MGS_TARGET_REG;
141 extern const struct req_format RQF_MGS_SET_INFO;
142 /* fid/fld req_format */
143 extern const struct req_format RQF_SEQ_QUERY;
144 extern const struct req_format RQF_FLD_QUERY;
146 extern const struct req_format RQF_MDS_CONNECT;
147 extern const struct req_format RQF_MDS_DISCONNECT;
148 extern const struct req_format RQF_MDS_STATFS;
149 extern const struct req_format RQF_MDS_GETSTATUS;
150 extern const struct req_format RQF_MDS_SYNC;
151 extern const struct req_format RQF_MDS_GETXATTR;
152 extern const struct req_format RQF_MDS_GETATTR;
154 * This is format of direct (non-intent) MDS_GETATTR_NAME request.
156 extern const struct req_format RQF_MDS_GETATTR_NAME;
157 extern const struct req_format RQF_MDS_CLOSE;
158 extern const struct req_format RQF_MDS_PIN;
159 extern const struct req_format RQF_MDS_UNPIN;
160 extern const struct req_format RQF_MDS_CONNECT;
161 extern const struct req_format RQF_MDS_DISCONNECT;
162 extern const struct req_format RQF_MDS_GET_INFO;
163 extern const struct req_format RQF_MDS_READPAGE;
164 extern const struct req_format RQF_MDS_WRITEPAGE;
165 extern const struct req_format RQF_MDS_IS_SUBDIR;
166 extern const struct req_format RQF_MDS_DONE_WRITING;
167 extern const struct req_format RQF_MDS_REINT;
168 extern const struct req_format RQF_MDS_REINT_CREATE;
169 extern const struct req_format RQF_MDS_REINT_CREATE_RMT_ACL;
170 extern const struct req_format RQF_MDS_REINT_CREATE_SLAVE;
171 extern const struct req_format RQF_MDS_REINT_CREATE_SYM;
172 extern const struct req_format RQF_MDS_REINT_OPEN;
173 extern const struct req_format RQF_MDS_REINT_UNLINK;
174 extern const struct req_format RQF_MDS_REINT_LINK;
175 extern const struct req_format RQF_MDS_REINT_RENAME;
176 extern const struct req_format RQF_MDS_REINT_SETATTR;
177 extern const struct req_format RQF_MDS_REINT_SETXATTR;
178 extern const struct req_format RQF_MDS_QUOTACHECK;
179 extern const struct req_format RQF_MDS_QUOTACTL;
180 extern const struct req_format RQF_MDS_QUOTA_DQACQ;
181 extern const struct req_format RQF_QC_CALLBACK;
183 extern const struct req_format RQF_OST_CONNECT;
184 extern const struct req_format RQF_OST_DISCONNECT;
185 extern const struct req_format RQF_OST_QUOTACHECK;
186 extern const struct req_format RQF_OST_QUOTACTL;
187 extern const struct req_format RQF_OST_QUOTA_ADJUST_QUNIT;
188 extern const struct req_format RQF_OST_GETATTR;
189 extern const struct req_format RQF_OST_SETATTR;
190 extern const struct req_format RQF_OST_CREATE;
191 extern const struct req_format RQF_OST_PUNCH;
192 extern const struct req_format RQF_OST_SYNC;
193 extern const struct req_format RQF_OST_DESTROY;
194 extern const struct req_format RQF_OST_BRW_READ;
195 extern const struct req_format RQF_OST_BRW_WRITE;
196 extern const struct req_format RQF_OST_STATFS;
197 extern const struct req_format RQF_OST_SET_GRANT_INFO;
198 extern const struct req_format RQF_OST_GET_INFO_GENERIC;
199 extern const struct req_format RQF_OST_GET_INFO_LAST_ID;
200 extern const struct req_format RQF_OST_GET_INFO_FIEMAP;
202 /* LDLM req_format */
203 extern const struct req_format RQF_LDLM_ENQUEUE;
204 extern const struct req_format RQF_LDLM_ENQUEUE_LVB;
205 extern const struct req_format RQF_LDLM_CONVERT;
206 extern const struct req_format RQF_LDLM_INTENT;
207 extern const struct req_format RQF_LDLM_INTENT_GETATTR;
208 extern const struct req_format RQF_LDLM_INTENT_OPEN;
209 extern const struct req_format RQF_LDLM_INTENT_CREATE;
210 extern const struct req_format RQF_LDLM_INTENT_UNLINK;
211 extern const struct req_format RQF_LDLM_CANCEL;
212 extern const struct req_format RQF_LDLM_CALLBACK;
213 extern const struct req_format RQF_LDLM_CP_CALLBACK;
214 extern const struct req_format RQF_LDLM_BL_CALLBACK;
215 extern const struct req_format RQF_LDLM_GL_CALLBACK;
217 extern const struct req_format RQF_LOG_CANCEL;
218 extern const struct req_format RQF_LLOG_CATINFO;
219 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
220 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
221 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
222 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
223 extern const struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
224 extern const struct req_format RQF_LLOG_ORIGIN_CONNECT;
226 extern const struct req_msg_field RMF_GENERIC_DATA;
227 extern const struct req_msg_field RMF_PTLRPC_BODY;
228 extern const struct req_msg_field RMF_MDT_BODY;
229 extern const struct req_msg_field RMF_MDT_EPOCH;
230 extern const struct req_msg_field RMF_OBD_STATFS;
231 extern const struct req_msg_field RMF_NAME;
232 extern const struct req_msg_field RMF_SYMTGT;
233 extern const struct req_msg_field RMF_TGTUUID;
234 extern const struct req_msg_field RMF_CLUUID;
235 extern const struct req_msg_field RMF_SETINFO_VAL;
236 extern const struct req_msg_field RMF_SETINFO_KEY;
237 extern const struct req_msg_field RMF_GETINFO_VAL;
238 extern const struct req_msg_field RMF_GETINFO_VALLEN;
239 extern const struct req_msg_field RMF_GETINFO_KEY;
242 * connection handle received in MDS_CONNECT request.
244 extern const struct req_msg_field RMF_CONN;
245 extern const struct req_msg_field RMF_CONNECT_DATA;
246 extern const struct req_msg_field RMF_DLM_REQ;
247 extern const struct req_msg_field RMF_DLM_REP;
248 extern const struct req_msg_field RMF_DLM_LVB;
249 extern const struct req_msg_field RMF_LDLM_INTENT;
250 extern const struct req_msg_field RMF_MDT_MD;
251 extern const struct req_msg_field RMF_REC_REINT;
252 extern const struct req_msg_field RMF_EADATA;
253 extern const struct req_msg_field RMF_ACL;
254 extern const struct req_msg_field RMF_LOGCOOKIES;
255 extern const struct req_msg_field RMF_CAPA1;
256 extern const struct req_msg_field RMF_CAPA2;
257 extern const struct req_msg_field RMF_OBD_QUOTACHECK;
258 extern const struct req_msg_field RMF_OBD_QUOTACTL;
259 extern const struct req_msg_field RMF_QUOTA_ADJUST_QUNIT;
260 extern const struct req_msg_field RMF_QUNIT_DATA;
261 extern const struct req_msg_field RMF_STRING;
264 extern const struct req_msg_field RMF_SEQ_OPC;
265 extern const struct req_msg_field RMF_SEQ_RANGE;
268 extern const struct req_msg_field RMF_FLD_OPC;
269 extern const struct req_msg_field RMF_FLD_MDFLD;
271 extern const struct req_msg_field RMF_LLOGD_BODY;
272 extern const struct req_msg_field RMF_LLOG_LOG_HDR;
273 extern const struct req_msg_field RMF_LLOGD_CONN_BODY;
275 extern const struct req_msg_field RMF_MGS_TARGET_INFO;
276 extern const struct req_msg_field RMF_MGS_SEND_PARAM;
278 extern const struct req_msg_field RMF_OST_BODY;
279 extern const struct req_msg_field RMF_OBD_IOOBJ;
280 extern const struct req_msg_field RMF_OBD_ID;
281 extern const struct req_msg_field RMF_NIOBUF_REMOTE;
282 extern const struct req_msg_field RMF_RCS;
283 extern const struct req_msg_field RMF_FIEMAP_KEY;
284 extern const struct req_msg_field RMF_FIEMAP_VAL;
288 #endif /* _LUSTRE_REQ_LAYOUT_H__ */