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 9
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 size_t req_capsule_filled_sizes(struct req_capsule *pill,
80 enum req_location loc);
81 int req_capsule_server_pack(struct req_capsule *pill);
83 void *req_capsule_client_get(struct req_capsule *pill,
84 const struct req_msg_field *field);
85 void *req_capsule_client_swab_get(struct req_capsule *pill,
86 const struct req_msg_field *field,
88 void *req_capsule_client_sized_get(struct req_capsule *pill,
89 const struct req_msg_field *field,
91 void *req_capsule_server_get(struct req_capsule *pill,
92 const struct req_msg_field *field);
93 void *req_capsule_server_sized_get(struct req_capsule *pill,
94 const struct req_msg_field *field,
96 void *req_capsule_server_swab_get(struct req_capsule *pill,
97 const struct req_msg_field *field,
99 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
100 const struct req_msg_field *field,
101 u32 len, void *swabber);
103 void req_capsule_set_size(struct req_capsule *pill,
104 const struct req_msg_field *field,
105 enum req_location loc, u32 size);
106 u32 req_capsule_get_size(const struct req_capsule *pill,
107 const struct req_msg_field *field,
108 enum req_location loc);
109 u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
110 u32 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);
114 int req_capsule_has_field(const struct req_capsule *pill,
115 const struct req_msg_field *field,
116 enum req_location loc);
117 void req_capsule_shrink(struct req_capsule *pill,
118 const struct req_msg_field *field,
119 u32 newlen, enum req_location loc);
120 int req_layout_init(void);
121 void req_layout_fini(void);
123 /* __REQ_LAYOUT_USER__ */
126 extern struct req_format RQF_OBD_PING;
127 extern struct req_format RQF_OBD_SET_INFO;
128 extern struct req_format RQF_SEC_CTX;
130 extern struct req_format RQF_MGS_TARGET_REG;
131 extern struct req_format RQF_MGS_SET_INFO;
132 extern struct req_format RQF_MGS_CONFIG_READ;
133 /* fid/fld req_format */
134 extern struct req_format RQF_SEQ_QUERY;
135 extern struct req_format RQF_FLD_QUERY;
136 extern struct req_format RQF_FLD_READ;
138 extern struct req_format RQF_MDS_CONNECT;
139 extern struct req_format RQF_MDS_DISCONNECT;
140 extern struct req_format RQF_MDS_STATFS;
141 extern struct req_format RQF_MDS_GETSTATUS;
142 extern struct req_format RQF_MDS_SYNC;
143 extern struct req_format RQF_MDS_GETXATTR;
144 extern struct req_format RQF_MDS_GETATTR;
147 * This is format of direct (non-intent) MDS_GETATTR_NAME request.
149 extern struct req_format RQF_MDS_GETATTR_NAME;
150 extern struct req_format RQF_MDS_CLOSE;
151 extern struct req_format RQF_MDS_INTENT_CLOSE;
152 extern struct req_format RQF_MDS_CONNECT;
153 extern struct req_format RQF_MDS_DISCONNECT;
154 extern struct req_format RQF_MDS_GET_INFO;
155 extern struct req_format RQF_MDS_READPAGE;
156 extern struct req_format RQF_MDS_WRITEPAGE;
157 extern struct req_format RQF_MDS_REINT;
158 extern struct req_format RQF_MDS_REINT_CREATE;
159 extern struct req_format RQF_MDS_REINT_CREATE_ACL;
160 extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
161 extern struct req_format RQF_MDS_REINT_CREATE_SYM;
162 extern struct req_format RQF_MDS_REINT_OPEN;
163 extern struct req_format RQF_MDS_REINT_UNLINK;
164 extern struct req_format RQF_MDS_REINT_LINK;
165 extern struct req_format RQF_MDS_REINT_RENAME;
166 extern struct req_format RQF_MDS_REINT_SETATTR;
167 extern struct req_format RQF_MDS_REINT_SETXATTR;
168 extern struct req_format RQF_MDS_QUOTACTL;
169 extern struct req_format RQF_MDS_SWAP_LAYOUTS;
170 extern struct req_format RQF_MDS_REINT_MIGRATE;
171 /* MDS hsm formats */
172 extern struct req_format RQF_MDS_HSM_STATE_GET;
173 extern struct req_format RQF_MDS_HSM_STATE_SET;
174 extern struct req_format RQF_MDS_HSM_ACTION;
175 extern struct req_format RQF_MDS_HSM_PROGRESS;
176 extern struct req_format RQF_MDS_HSM_CT_REGISTER;
177 extern struct req_format RQF_MDS_HSM_CT_UNREGISTER;
178 extern struct req_format RQF_MDS_HSM_REQUEST;
180 extern struct req_format RQF_OST_CONNECT;
181 extern struct req_format RQF_OST_DISCONNECT;
182 extern struct req_format RQF_OST_QUOTACTL;
183 extern struct req_format RQF_OST_GETATTR;
184 extern struct req_format RQF_OST_SETATTR;
185 extern struct req_format RQF_OST_CREATE;
186 extern struct req_format RQF_OST_PUNCH;
187 extern struct req_format RQF_OST_SYNC;
188 extern struct req_format RQF_OST_DESTROY;
189 extern struct req_format RQF_OST_BRW_READ;
190 extern struct req_format RQF_OST_BRW_WRITE;
191 extern struct req_format RQF_OST_STATFS;
192 extern struct req_format RQF_OST_SET_GRANT_INFO;
193 extern struct req_format RQF_OST_GET_INFO;
194 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
195 extern struct req_format RQF_OST_GET_INFO_LAST_FID;
196 extern struct req_format RQF_OST_SET_INFO_LAST_FID;
197 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
199 /* LDLM req_format */
200 extern struct req_format RQF_LDLM_ENQUEUE;
201 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
202 extern struct req_format RQF_LDLM_CONVERT;
203 extern struct req_format RQF_LDLM_INTENT;
204 extern struct req_format RQF_LDLM_INTENT_BASIC;
205 extern struct req_format RQF_LDLM_INTENT_LAYOUT;
206 extern struct req_format RQF_LDLM_INTENT_GETATTR;
207 extern struct req_format RQF_LDLM_INTENT_OPEN;
208 extern struct req_format RQF_LDLM_INTENT_CREATE;
209 extern struct req_format RQF_LDLM_INTENT_UNLINK;
210 extern struct req_format RQF_LDLM_INTENT_GETXATTR;
211 extern struct req_format RQF_LDLM_CANCEL;
212 extern struct req_format RQF_LDLM_CALLBACK;
213 extern struct req_format RQF_LDLM_CP_CALLBACK;
214 extern struct req_format RQF_LDLM_BL_CALLBACK;
215 extern struct req_format RQF_LDLM_GL_CALLBACK;
216 extern struct req_format RQF_LDLM_GL_DESC_CALLBACK;
218 extern struct req_format RQF_LOG_CANCEL;
219 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
220 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_DESTROY;
221 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
222 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
223 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
224 extern struct req_format RQF_LLOG_ORIGIN_CONNECT;
226 extern struct req_format RQF_CONNECT;
228 extern struct req_msg_field RMF_GENERIC_DATA;
229 extern struct req_msg_field RMF_PTLRPC_BODY;
230 extern struct req_msg_field RMF_MDT_BODY;
231 extern struct req_msg_field RMF_MDT_EPOCH;
232 extern struct req_msg_field RMF_OBD_STATFS;
233 extern struct req_msg_field RMF_NAME;
234 extern struct req_msg_field RMF_SYMTGT;
235 extern struct req_msg_field RMF_TGTUUID;
236 extern struct req_msg_field RMF_CLUUID;
237 extern struct req_msg_field RMF_SETINFO_VAL;
238 extern struct req_msg_field RMF_SETINFO_KEY;
239 extern struct req_msg_field RMF_GETINFO_VAL;
240 extern struct req_msg_field RMF_GETINFO_VALLEN;
241 extern struct req_msg_field RMF_GETINFO_KEY;
242 extern struct req_msg_field RMF_CLOSE_DATA;
245 * connection handle received in MDS_CONNECT request.
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_DLM_GL_DESC;
253 extern struct req_msg_field RMF_LDLM_INTENT;
254 extern struct req_msg_field RMF_LAYOUT_INTENT;
255 extern struct req_msg_field RMF_MDT_MD;
256 extern struct req_msg_field RMF_REC_REINT;
257 extern struct req_msg_field RMF_EADATA;
258 extern struct req_msg_field RMF_EAVALS;
259 extern struct req_msg_field RMF_EAVALS_LENS;
260 extern struct req_msg_field RMF_ACL;
261 extern struct req_msg_field RMF_LOGCOOKIES;
262 extern struct req_msg_field RMF_CAPA1;
263 extern struct req_msg_field RMF_CAPA2;
264 extern struct req_msg_field RMF_OBD_QUOTACHECK;
265 extern struct req_msg_field RMF_OBD_QUOTACTL;
266 extern struct req_msg_field RMF_STRING;
267 extern struct req_msg_field RMF_SWAP_LAYOUTS;
268 extern struct req_msg_field RMF_MDS_HSM_PROGRESS;
269 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
270 extern struct req_msg_field RMF_MDS_HSM_USER_ITEM;
271 extern struct req_msg_field RMF_MDS_HSM_ARCHIVE;
272 extern struct req_msg_field RMF_HSM_USER_STATE;
273 extern struct req_msg_field RMF_HSM_STATE_SET;
274 extern struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION;
275 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
278 extern struct req_msg_field RMF_SEQ_OPC;
279 extern struct req_msg_field RMF_SEQ_RANGE;
280 extern struct req_msg_field RMF_FID_SPACE;
283 extern struct req_msg_field RMF_FLD_OPC;
284 extern struct req_msg_field RMF_FLD_MDFLD;
286 extern struct req_msg_field RMF_LLOGD_BODY;
287 extern struct req_msg_field RMF_LLOG_LOG_HDR;
288 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
290 extern struct req_msg_field RMF_MGS_TARGET_INFO;
291 extern struct req_msg_field RMF_MGS_SEND_PARAM;
293 extern struct req_msg_field RMF_OST_BODY;
294 extern struct req_msg_field RMF_OBD_IOOBJ;
295 extern struct req_msg_field RMF_OBD_ID;
296 extern struct req_msg_field RMF_FID;
297 extern struct req_msg_field RMF_NIOBUF_REMOTE;
298 extern struct req_msg_field RMF_RCS;
299 extern struct req_msg_field RMF_FIEMAP_KEY;
300 extern struct req_msg_field RMF_FIEMAP_VAL;
301 extern struct req_msg_field RMF_OST_ID;
303 /* MGS config read message format */
304 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
305 extern struct req_msg_field RMF_MGS_CONFIG_RES;
308 extern struct req_msg_field RMF_U32;
312 #endif /* _LUSTRE_REQ_LAYOUT_H__ */