4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/include/lustre_req_layout.h
34 * Lustre Metadata Target (mdt) request handler
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 #ifndef _LUSTRE_REQ_LAYOUT_H__
40 #define _LUSTRE_REQ_LAYOUT_H__
42 /** \defgroup req_layout req_layout
51 struct ptlrpc_request;
59 /* Maximal number of fields (buffers) in a request message. */
60 #define REQ_MAX_FIELD_NR 10
63 struct ptlrpc_request *rc_req;
64 const struct req_format *rc_fmt;
65 enum req_location rc_loc;
66 __u32 rc_area[RCL_NR][REQ_MAX_FIELD_NR];
69 #if !defined(__REQ_LAYOUT_USER__)
71 /* struct ptlrpc_request, lustre_msg* */
72 #include <lustre_net.h>
74 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
75 enum req_location location);
76 void req_capsule_fini(struct req_capsule *pill);
78 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
79 void req_capsule_client_dump(struct req_capsule *pill);
80 void req_capsule_server_dump(struct req_capsule *pill);
81 void req_capsule_init_area(struct req_capsule *pill);
82 size_t req_capsule_filled_sizes(struct req_capsule *pill,
83 enum req_location loc);
84 int req_capsule_server_pack(struct req_capsule *pill);
86 void *req_capsule_client_get(struct req_capsule *pill,
87 const struct req_msg_field *field);
88 void *req_capsule_client_swab_get(struct req_capsule *pill,
89 const struct req_msg_field *field,
91 void *req_capsule_client_sized_get(struct req_capsule *pill,
92 const struct req_msg_field *field,
94 void *req_capsule_server_get(struct req_capsule *pill,
95 const struct req_msg_field *field);
96 void *req_capsule_server_sized_get(struct req_capsule *pill,
97 const struct req_msg_field *field,
99 void *req_capsule_server_swab_get(struct req_capsule *pill,
100 const struct req_msg_field *field,
102 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
103 const struct req_msg_field *field,
104 __u32 len, void *swabber);
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, __u32 size);
111 __u32 req_capsule_get_size(const struct req_capsule *pill,
112 const struct req_msg_field *field,
113 enum req_location loc);
114 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
115 __u32 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);
129 int req_capsule_server_grow(struct req_capsule *pill,
130 const struct req_msg_field *field,
132 int req_layout_init(void);
133 void req_layout_fini(void);
135 /* __REQ_LAYOUT_USER__ */
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;
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 extern struct req_format RQF_FLD_READ;
151 extern struct req_format RQF_MDS_CONNECT;
152 extern struct req_format RQF_MDS_DISCONNECT;
153 extern struct req_format RQF_MDS_STATFS;
154 extern struct req_format RQF_MDS_GET_ROOT;
155 extern struct req_format RQF_MDS_SYNC;
156 extern struct req_format RQF_MDS_GETXATTR;
157 extern struct req_format RQF_MDS_GETATTR;
158 extern struct req_format RQF_OUT_UPDATE;
161 * This is format of direct (non-intent) MDS_GETATTR_NAME request.
163 extern struct req_format RQF_MDS_GETATTR_NAME;
164 extern struct req_format RQF_MDS_CLOSE;
165 extern struct req_format RQF_MDS_INTENT_CLOSE;
166 extern struct req_format RQF_MDS_CONNECT;
167 extern struct req_format RQF_MDS_DISCONNECT;
168 extern struct req_format RQF_MDS_GET_INFO;
169 extern struct req_format RQF_MDS_READPAGE;
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_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_QUOTACTL;
182 extern struct req_format RQF_QUOTA_DQACQ;
183 extern struct req_format RQF_MDS_SWAP_LAYOUTS;
184 extern struct req_format RQF_MDS_REINT_MIGRATE;
185 /* MDS hsm formats */
186 extern struct req_format RQF_MDS_HSM_STATE_GET;
187 extern struct req_format RQF_MDS_HSM_STATE_SET;
188 extern struct req_format RQF_MDS_HSM_ACTION;
189 extern struct req_format RQF_MDS_HSM_PROGRESS;
190 extern struct req_format RQF_MDS_HSM_CT_REGISTER;
191 extern struct req_format RQF_MDS_HSM_CT_UNREGISTER;
192 extern struct req_format RQF_MDS_HSM_REQUEST;
194 extern struct req_format RQF_OST_CONNECT;
195 extern struct req_format RQF_OST_DISCONNECT;
196 extern struct req_format RQF_OST_QUOTACTL;
197 extern struct req_format RQF_OST_GETATTR;
198 extern struct req_format RQF_OST_SETATTR;
199 extern struct req_format RQF_OST_CREATE;
200 extern struct req_format RQF_OST_PUNCH;
201 extern struct req_format RQF_OST_SYNC;
202 extern struct req_format RQF_OST_DESTROY;
203 extern struct req_format RQF_OST_BRW_READ;
204 extern struct req_format RQF_OST_BRW_WRITE;
205 extern struct req_format RQF_OST_STATFS;
206 extern struct req_format RQF_OST_SET_GRANT_INFO;
207 extern struct req_format RQF_OST_GET_INFO;
208 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
209 extern struct req_format RQF_OST_GET_INFO_LAST_FID;
210 extern struct req_format RQF_OST_SET_INFO_LAST_FID;
211 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
212 extern struct req_format RQF_OST_LADVISE;
214 /* LDLM req_format */
215 extern struct req_format RQF_LDLM_ENQUEUE;
216 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
217 extern struct req_format RQF_LDLM_CONVERT;
218 extern struct req_format RQF_LDLM_INTENT;
219 extern struct req_format RQF_LDLM_INTENT_BASIC;
220 extern struct req_format RQF_LDLM_INTENT_LAYOUT;
221 extern struct req_format RQF_LDLM_INTENT_GETATTR;
222 extern struct req_format RQF_LDLM_INTENT_OPEN;
223 extern struct req_format RQF_LDLM_INTENT_CREATE;
224 extern struct req_format RQF_LDLM_INTENT_UNLINK;
225 extern struct req_format RQF_LDLM_INTENT_GETXATTR;
226 extern struct req_format RQF_LDLM_INTENT_QUOTA;
227 extern struct req_format RQF_LDLM_CANCEL;
228 extern struct req_format RQF_LDLM_CALLBACK;
229 extern struct req_format RQF_LDLM_CP_CALLBACK;
230 extern struct req_format RQF_LDLM_BL_CALLBACK;
231 extern struct req_format RQF_LDLM_GL_CALLBACK;
232 extern struct req_format RQF_LDLM_GL_DESC_CALLBACK;
234 extern struct req_format RQF_LOG_CANCEL;
235 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
236 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
237 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
238 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
239 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
240 extern struct req_format RQF_LLOG_ORIGIN_CONNECT;
242 extern struct req_format RQF_CONNECT;
244 /* LFSCK req_format */
245 extern struct req_format RQF_LFSCK_NOTIFY;
246 extern struct req_format RQF_LFSCK_QUERY;
248 extern struct req_msg_field RMF_GENERIC_DATA;
249 extern struct req_msg_field RMF_PTLRPC_BODY;
250 extern struct req_msg_field RMF_MDT_BODY;
251 extern struct req_msg_field RMF_MDT_EPOCH;
252 extern struct req_msg_field RMF_OBD_STATFS;
253 extern struct req_msg_field RMF_NAME;
254 extern struct req_msg_field RMF_SYMTGT;
255 extern struct req_msg_field RMF_TGTUUID;
256 extern struct req_msg_field RMF_CLUUID;
257 extern struct req_msg_field RMF_SETINFO_VAL;
258 extern struct req_msg_field RMF_SETINFO_KEY;
259 extern struct req_msg_field RMF_GETINFO_VAL;
260 extern struct req_msg_field RMF_GETINFO_VALLEN;
261 extern struct req_msg_field RMF_GETINFO_KEY;
262 extern struct req_msg_field RMF_IDX_INFO;
263 extern struct req_msg_field RMF_CLOSE_DATA;
264 extern struct req_msg_field RMF_FILE_SECCTX_NAME;
265 extern struct req_msg_field RMF_FILE_SECCTX;
268 * connection handle received in MDS_CONNECT request.
270 extern struct req_msg_field RMF_CONN;
271 extern struct req_msg_field RMF_CONNECT_DATA;
272 extern struct req_msg_field RMF_DLM_REQ;
273 extern struct req_msg_field RMF_DLM_REP;
274 extern struct req_msg_field RMF_DLM_LVB;
275 extern struct req_msg_field RMF_DLM_GL_DESC;
276 extern struct req_msg_field RMF_LDLM_INTENT;
277 extern struct req_msg_field RMF_LAYOUT_INTENT;
278 extern struct req_msg_field RMF_MDT_MD;
279 extern struct req_msg_field RMF_REC_REINT;
280 extern struct req_msg_field RMF_EADATA;
281 extern struct req_msg_field RMF_EAVALS;
282 extern struct req_msg_field RMF_EAVALS_LENS;
283 extern struct req_msg_field RMF_ACL;
284 extern struct req_msg_field RMF_LOGCOOKIES;
285 extern struct req_msg_field RMF_CAPA1;
286 extern struct req_msg_field RMF_CAPA2;
287 extern struct req_msg_field RMF_OBD_QUOTACHECK;
288 extern struct req_msg_field RMF_OBD_QUOTACTL;
289 extern struct req_msg_field RMF_QUOTA_BODY;
290 extern struct req_msg_field RMF_STRING;
291 extern struct req_msg_field RMF_SWAP_LAYOUTS;
292 extern struct req_msg_field RMF_MDS_HSM_PROGRESS;
293 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
294 extern struct req_msg_field RMF_MDS_HSM_USER_ITEM;
295 extern struct req_msg_field RMF_MDS_HSM_ARCHIVE;
296 extern struct req_msg_field RMF_HSM_USER_STATE;
297 extern struct req_msg_field RMF_HSM_STATE_SET;
298 extern struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION;
299 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
302 extern struct req_msg_field RMF_SEQ_OPC;
303 extern struct req_msg_field RMF_SEQ_RANGE;
304 extern struct req_msg_field RMF_FID_SPACE;
307 extern struct req_msg_field RMF_FLD_OPC;
308 extern struct req_msg_field RMF_FLD_MDFLD;
310 extern struct req_msg_field RMF_LLOGD_BODY;
311 extern struct req_msg_field RMF_LLOG_LOG_HDR;
312 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
314 extern struct req_msg_field RMF_MGS_TARGET_INFO;
315 extern struct req_msg_field RMF_MGS_SEND_PARAM;
317 extern struct req_msg_field RMF_OST_BODY;
318 extern struct req_msg_field RMF_OBD_IOOBJ;
319 extern struct req_msg_field RMF_OBD_ID;
320 extern struct req_msg_field RMF_FID;
321 extern struct req_msg_field RMF_NIOBUF_REMOTE;
322 extern struct req_msg_field RMF_RCS;
323 extern struct req_msg_field RMF_FIEMAP_KEY;
324 extern struct req_msg_field RMF_FIEMAP_VAL;
325 extern struct req_msg_field RMF_OST_ID;
327 /* MGS config read message format */
328 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
329 extern struct req_msg_field RMF_MGS_CONFIG_RES;
332 extern struct req_msg_field RMF_U32;
334 /* OBJ update format */
335 extern struct req_msg_field RMF_OUT_UPDATE;
336 extern struct req_msg_field RMF_OUT_UPDATE_REPLY;
337 extern struct req_msg_field RMF_OUT_UPDATE_HEADER;
338 extern struct req_msg_field RMF_OUT_UPDATE_BUF;
341 extern struct req_msg_field RMF_LFSCK_REQUEST;
342 extern struct req_msg_field RMF_LFSCK_REPLY;
344 extern struct req_msg_field RMF_OST_LADVISE_HDR;
345 extern struct req_msg_field RMF_OST_LADVISE;
348 #endif /* _LUSTRE_REQ_LAYOUT_H__ */