Whamcloud - gitweb
LU-14628 ptlrpc: remove might_sleep() in sptlrpc_gc_del_sec()
[fs/lustre-release.git] / lustre / include / lustre_req_layout.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/include/lustre_req_layout.h
32  *
33  * Lustre Metadata Target (mdt) request handler
34  *
35  * Author: Nikita Danilov <nikita@clusterfs.com>
36  */
37
38 #ifndef _LUSTRE_REQ_LAYOUT_H__
39 #define _LUSTRE_REQ_LAYOUT_H__
40
41 #include <linux/types.h>
42
43 /** \defgroup req_layout req_layout
44  *
45  * @{
46  */
47
48 struct req_msg_field;
49 struct req_format;
50 struct req_capsule;
51
52 struct ptlrpc_request;
53
54 enum req_location {
55         RCL_CLIENT,
56         RCL_SERVER,
57         RCL_NR
58 };
59
60 /* Maximal number of fields (buffers) in a request message. */
61 #define REQ_MAX_FIELD_NR 12
62
63 struct req_capsule {
64         struct ptlrpc_request   *rc_req;
65         const struct req_format *rc_fmt;
66         enum req_location        rc_loc;
67         __u32                    rc_area[RCL_NR][REQ_MAX_FIELD_NR];
68 };
69
70 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
71                       enum req_location location);
72 void req_capsule_fini(struct req_capsule *pill);
73
74 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
75 void req_capsule_client_dump(struct req_capsule *pill);
76 void req_capsule_server_dump(struct req_capsule *pill);
77 void req_capsule_init_area(struct req_capsule *pill);
78 size_t req_capsule_filled_sizes(struct req_capsule *pill,
79                                 enum req_location loc);
80 int  req_capsule_server_pack(struct req_capsule *pill);
81
82 void *req_capsule_client_get(struct req_capsule *pill,
83                              const struct req_msg_field *field);
84 void *req_capsule_client_swab_get(struct req_capsule *pill,
85                                   const struct req_msg_field *field,
86                                   void *swabber);
87 void *req_capsule_client_sized_get(struct req_capsule *pill,
88                                    const struct req_msg_field *field,
89                                    __u32 len);
90 void *req_capsule_server_get(struct req_capsule *pill,
91                              const struct req_msg_field *field);
92 void *req_capsule_server_sized_get(struct req_capsule *pill,
93                                    const struct req_msg_field *field,
94                                    __u32 len);
95 void *req_capsule_server_swab_get(struct req_capsule *pill,
96                                   const struct req_msg_field *field,
97                                   void *swabber);
98 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
99                                         const struct req_msg_field *field,
100                                         __u32 len, void *swabber);
101 const void *req_capsule_other_get(struct req_capsule *pill,
102                                   const struct req_msg_field *field);
103
104 void req_capsule_set_size(struct req_capsule *pill,
105                           const struct req_msg_field *field,
106                           enum req_location loc, __u32 size);
107 __u32 req_capsule_get_size(const struct req_capsule *pill,
108                            const struct req_msg_field *field,
109                            enum req_location loc);
110 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
111 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
112                          enum req_location loc);
113 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
114
115 int req_capsule_has_field(const struct req_capsule *pill,
116                           const struct req_msg_field *field,
117                           enum req_location loc);
118 int req_capsule_field_present(const struct req_capsule *pill,
119                               const struct req_msg_field *field,
120                               enum req_location loc);
121 void req_capsule_shrink(struct req_capsule *pill,
122                         const struct req_msg_field *field,
123                         __u32 newlen,
124                         enum req_location loc);
125 int req_capsule_server_grow(struct req_capsule *pill,
126                             const struct req_msg_field *field,
127                             __u32 newlen);
128 int  req_layout_init(void);
129 void req_layout_fini(void);
130 #ifdef HAVE_SERVER_SUPPORT
131 int req_check_sepol(struct req_capsule *pill);
132 #else
133 static inline int req_check_sepol(struct req_capsule *pill)
134 {
135         return 0;
136 }
137 #endif
138
139 extern struct req_format RQF_OBD_PING;
140 extern struct req_format RQF_OBD_SET_INFO;
141 extern struct req_format RQF_MDT_SET_INFO;
142 extern struct req_format RQF_SEC_CTX;
143 extern struct req_format RQF_OBD_IDX_READ;
144 /* MGS req_format */
145 extern struct req_format RQF_MGS_TARGET_REG;
146 extern struct req_format RQF_MGS_SET_INFO;
147 extern struct req_format RQF_MGS_CONFIG_READ;
148 /* fid/fld req_format */
149 extern struct req_format RQF_SEQ_QUERY;
150 extern struct req_format RQF_FLD_QUERY;
151 extern struct req_format RQF_FLD_READ;
152 /* MDS req_format */
153 extern struct req_format RQF_MDS_CONNECT;
154 extern struct req_format RQF_MDS_DISCONNECT;
155 extern struct req_format RQF_MDS_STATFS;
156 extern struct req_format RQF_MDS_STATFS_NEW;
157 extern struct req_format RQF_MDS_GET_ROOT;
158 extern struct req_format RQF_MDS_SYNC;
159 extern struct req_format RQF_MDS_GETXATTR;
160 extern struct req_format RQF_MDS_GETATTR;
161 extern struct req_format RQF_OUT_UPDATE;
162
163 /*
164  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
165  */
166 extern struct req_format RQF_MDS_GETATTR_NAME;
167 extern struct req_format RQF_MDS_CLOSE;
168 extern struct req_format RQF_MDS_CLOSE_INTENT;
169 extern struct req_format RQF_MDS_CONNECT;
170 extern struct req_format RQF_MDS_DISCONNECT;
171 extern struct req_format RQF_MDS_GET_INFO;
172 extern struct req_format RQF_MDS_READPAGE;
173 extern struct req_format RQF_MDS_REINT;
174 extern struct req_format RQF_MDS_REINT_CREATE;
175 extern struct req_format RQF_MDS_REINT_CREATE_ACL;
176 extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
177 extern struct req_format RQF_MDS_REINT_CREATE_SYM;
178 extern struct req_format RQF_MDS_REINT_OPEN;
179 extern struct req_format RQF_MDS_REINT_UNLINK;
180 extern struct req_format RQF_MDS_REINT_LINK;
181 extern struct req_format RQF_MDS_REINT_RENAME;
182 extern struct req_format RQF_MDS_REINT_SETATTR;
183 extern struct req_format RQF_MDS_REINT_SETXATTR;
184 extern struct req_format RQF_MDS_QUOTACTL;
185 extern struct req_format RQF_QUOTA_DQACQ;
186 extern struct req_format RQF_MDS_SWAP_LAYOUTS;
187 extern struct req_format RQF_MDS_REINT_MIGRATE;
188 extern struct req_format RQF_MDS_REINT_RESYNC;
189 extern struct req_format RQF_MDS_RMFID;
190 /* MDS hsm formats */
191 extern struct req_format RQF_MDS_HSM_STATE_GET;
192 extern struct req_format RQF_MDS_HSM_STATE_SET;
193 extern struct req_format RQF_MDS_HSM_ACTION;
194 extern struct req_format RQF_MDS_HSM_PROGRESS;
195 extern struct req_format RQF_MDS_HSM_CT_REGISTER;
196 extern struct req_format RQF_MDS_HSM_CT_UNREGISTER;
197 extern struct req_format RQF_MDS_HSM_REQUEST;
198 /* OST req_format */
199 extern struct req_format RQF_OST_CONNECT;
200 extern struct req_format RQF_OST_DISCONNECT;
201 extern struct req_format RQF_OST_QUOTACTL;
202 extern struct req_format RQF_OST_GETATTR;
203 extern struct req_format RQF_OST_SETATTR;
204 extern struct req_format RQF_OST_CREATE;
205 extern struct req_format RQF_OST_PUNCH;
206 extern struct req_format RQF_OST_FALLOCATE;
207 extern struct req_format RQF_OST_SYNC;
208 extern struct req_format RQF_OST_DESTROY;
209 extern struct req_format RQF_OST_BRW_READ;
210 extern struct req_format RQF_OST_BRW_WRITE;
211 extern struct req_format RQF_OST_STATFS;
212 extern struct req_format RQF_OST_SET_GRANT_INFO;
213 extern struct req_format RQF_OST_GET_INFO;
214 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
215 extern struct req_format RQF_OST_GET_INFO_LAST_FID;
216 extern struct req_format RQF_OST_SET_INFO_LAST_FID;
217 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
218 extern struct req_format RQF_OST_LADVISE;
219 extern struct req_format RQF_OST_SEEK;
220
221 /* LDLM req_format */
222 extern struct req_format RQF_LDLM_ENQUEUE;
223 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
224 extern struct req_format RQF_LDLM_CONVERT;
225 extern struct req_format RQF_LDLM_INTENT;
226 extern struct req_format RQF_LDLM_INTENT_BASIC;
227 extern struct req_format RQF_LDLM_INTENT_LAYOUT;
228 extern struct req_format RQF_LDLM_INTENT_GETATTR;
229 extern struct req_format RQF_LDLM_INTENT_OPEN;
230 extern struct req_format RQF_LDLM_INTENT_CREATE;
231 extern struct req_format RQF_LDLM_INTENT_GETXATTR;
232 extern struct req_format RQF_LDLM_INTENT_QUOTA;
233 extern struct req_format RQF_LDLM_CANCEL;
234 extern struct req_format RQF_LDLM_CALLBACK;
235 extern struct req_format RQF_LDLM_CP_CALLBACK;
236 extern struct req_format RQF_LDLM_BL_CALLBACK;
237 extern struct req_format RQF_LDLM_GL_CALLBACK;
238 extern struct req_format RQF_LDLM_GL_CALLBACK_DESC;
239 /* LOG req_format */
240 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
241 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
242 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
243 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
244
245 extern struct req_format RQF_CONNECT;
246
247 /* LFSCK req_format */
248 extern struct req_format RQF_LFSCK_NOTIFY;
249 extern struct req_format RQF_LFSCK_QUERY;
250
251 extern struct req_msg_field RMF_GENERIC_DATA;
252 extern struct req_msg_field RMF_PTLRPC_BODY;
253 extern struct req_msg_field RMF_MDT_BODY;
254 extern struct req_msg_field RMF_MDT_EPOCH;
255 extern struct req_msg_field RMF_OBD_STATFS;
256 extern struct req_msg_field RMF_NAME;
257 extern struct req_msg_field RMF_SYMTGT;
258 extern struct req_msg_field RMF_TGTUUID;
259 extern struct req_msg_field RMF_CLUUID;
260 extern struct req_msg_field RMF_SETINFO_VAL;
261 extern struct req_msg_field RMF_SETINFO_KEY;
262 extern struct req_msg_field RMF_GETINFO_VAL;
263 extern struct req_msg_field RMF_GETINFO_VALLEN;
264 extern struct req_msg_field RMF_GETINFO_KEY;
265 extern struct req_msg_field RMF_IDX_INFO;
266 extern struct req_msg_field RMF_CLOSE_DATA;
267 extern struct req_msg_field RMF_FILE_SECCTX_NAME;
268 extern struct req_msg_field RMF_FILE_SECCTX;
269 extern struct req_msg_field RMF_FID_ARRAY;
270 extern struct req_msg_field RMF_FILE_ENCCTX;
271
272 /*
273  * connection handle received in MDS_CONNECT request.
274  */
275 extern struct req_msg_field RMF_CONN;
276 extern struct req_msg_field RMF_CONNECT_DATA;
277 extern struct req_msg_field RMF_DLM_REQ;
278 extern struct req_msg_field RMF_DLM_REP;
279 extern struct req_msg_field RMF_DLM_LVB;
280 extern struct req_msg_field RMF_DLM_GL_DESC;
281 extern struct req_msg_field RMF_LDLM_INTENT;
282 extern struct req_msg_field RMF_LAYOUT_INTENT;
283 extern struct req_msg_field RMF_MDT_MD;
284 extern struct req_msg_field RMF_DEFAULT_MDT_MD;
285 extern struct req_msg_field RMF_REC_REINT;
286 extern struct req_msg_field RMF_EADATA;
287 extern struct req_msg_field RMF_EAVALS;
288 extern struct req_msg_field RMF_EAVALS_LENS;
289 extern struct req_msg_field RMF_ACL;
290 extern struct req_msg_field RMF_LOGCOOKIES;
291 extern struct req_msg_field RMF_CAPA1;
292 extern struct req_msg_field RMF_CAPA2;
293 extern struct req_msg_field RMF_OBD_QUOTACHECK;
294 extern struct req_msg_field RMF_OBD_QUOTACTL;
295 extern struct req_msg_field RMF_OBD_QUOTACTL_POOL;
296 extern struct req_msg_field RMF_QUOTA_BODY;
297 extern struct req_msg_field RMF_STRING;
298 extern struct req_msg_field RMF_SWAP_LAYOUTS;
299 extern struct req_msg_field RMF_MDS_HSM_PROGRESS;
300 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
301 extern struct req_msg_field RMF_MDS_HSM_USER_ITEM;
302 extern struct req_msg_field RMF_MDS_HSM_ARCHIVE;
303 extern struct req_msg_field RMF_HSM_USER_STATE;
304 extern struct req_msg_field RMF_HSM_STATE_SET;
305 extern struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION;
306 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
307 extern struct req_msg_field RMF_SELINUX_POL;
308
309 /* seq-mgr fields */
310 extern struct req_msg_field RMF_SEQ_OPC;
311 extern struct req_msg_field RMF_SEQ_RANGE;
312 extern struct req_msg_field RMF_FID_SPACE;
313
314 /* FLD fields */
315 extern struct req_msg_field RMF_FLD_OPC;
316 extern struct req_msg_field RMF_FLD_MDFLD;
317
318 extern struct req_msg_field RMF_LLOGD_BODY;
319 extern struct req_msg_field RMF_LLOG_LOG_HDR;
320 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
321
322 extern struct req_msg_field RMF_MGS_TARGET_INFO;
323 extern struct req_msg_field RMF_MGS_SEND_PARAM;
324
325 extern struct req_msg_field RMF_OST_BODY;
326 extern struct req_msg_field RMF_OBD_IOOBJ;
327 extern struct req_msg_field RMF_OBD_ID;
328 extern struct req_msg_field RMF_FID;
329 extern struct req_msg_field RMF_NIOBUF_REMOTE;
330 extern struct req_msg_field RMF_NIOBUF_INLINE;
331 extern struct req_msg_field RMF_RCS;
332 extern struct req_msg_field RMF_FIEMAP_KEY;
333 extern struct req_msg_field RMF_FIEMAP_VAL;
334 extern struct req_msg_field RMF_OST_ID;
335 extern struct req_msg_field RMF_SHORT_IO;
336
337 /* MGS config read message format */
338 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
339 extern struct req_msg_field RMF_MGS_CONFIG_RES;
340
341 /* generic uint32 */
342 extern struct req_msg_field RMF_U32;
343
344 /* OBJ update format */
345 extern struct req_msg_field RMF_OUT_UPDATE;
346 extern struct req_msg_field RMF_OUT_UPDATE_REPLY;
347 extern struct req_msg_field RMF_OUT_UPDATE_HEADER;
348 extern struct req_msg_field RMF_OUT_UPDATE_BUF;
349
350 /* LFSCK format */
351 extern struct req_msg_field RMF_LFSCK_REQUEST;
352 extern struct req_msg_field RMF_LFSCK_REPLY;
353
354 extern struct req_msg_field RMF_OST_LADVISE_HDR;
355 extern struct req_msg_field RMF_OST_LADVISE;
356 /** @} req_layout */
357
358 #endif /* _LUSTRE_REQ_LAYOUT_H__ */