projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
staging: lustre: remove remote client support
[deliverable/linux.git] / drivers / staging / lustre / lustre / include / lustre / lustre_user.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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
25 *
26 * Copyright (c) 2010, 2015, Intel Corporation.
27 */
28 /*
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
31 *
32 * lustre/include/lustre/lustre_user.h
33 *
34 * Lustre public user-space interface definitions.
35 */
36
37 #ifndef _LUSTRE_USER_H
38 #define _LUSTRE_USER_H
39
40 /** \defgroup lustreuser lustreuser
41 *
42 * @{
43 */
44
45 #include "ll_fiemap.h"
46 #include "../linux/lustre_user.h"
47
48 /* for statfs() */
49 #define LL_SUPER_MAGIC 0x0BD00BD0
50
51 #ifndef FSFILT_IOC_GETFLAGS
52 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
53 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
54 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
55 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
56 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
57 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
58 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
59 #endif
60
61 /* FIEMAP flags supported by Lustre */
62 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
63
64 enum obd_statfs_state {
65 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
66 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
67 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
68 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
69 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
70 };
71
72 struct obd_statfs {
73 __u64 os_type;
74 __u64 os_blocks;
75 __u64 os_bfree;
76 __u64 os_bavail;
77 __u64 os_files;
78 __u64 os_ffree;
79 __u8 os_fsid[40];
80 __u32 os_bsize;
81 __u32 os_namelen;
82 __u64 os_maxbytes;
83 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
84 __u32 os_fprecreated; /* objs available now to the caller */
85 /* used in QoS code to find preferred OSTs */
86 __u32 os_spare2;
87 __u32 os_spare3;
88 __u32 os_spare4;
89 __u32 os_spare5;
90 __u32 os_spare6;
91 __u32 os_spare7;
92 __u32 os_spare8;
93 __u32 os_spare9;
94 };
95
96 /**
97 * File IDentifier.
98 *
99 * FID is a cluster-wide unique identifier of a file or an object (stripe).
100 * FIDs are never reused.
101 **/
102 struct lu_fid {
103 /**
104 * FID sequence. Sequence is a unit of migration: all files (objects)
105 * with FIDs from a given sequence are stored on the same server.
106 * Lustre should support 2^64 objects, so even if each sequence
107 * has only a single object we can still enumerate 2^64 objects.
108 **/
109 __u64 f_seq;
110 /* FID number within sequence. */
111 __u32 f_oid;
112 /**
113 * FID version, used to distinguish different versions (in the sense
114 * of snapshots, etc.) of the same file system object. Not currently
115 * used.
116 **/
117 __u32 f_ver;
118 };
119
120 struct filter_fid {
121 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
122 };
123
124 /* keep this one for compatibility */
125 struct filter_fid_old {
126 struct lu_fid ff_parent;
127 __u64 ff_objid;
128 __u64 ff_seq;
129 };
130
131 /* Userspace should treat lu_fid as opaque, and only use the following methods
132 * to print or parse them. Other functions (e.g. compare, swab) could be moved
133 * here from lustre_idl.h if needed.
134 */
135 struct lu_fid;
136
137 /**
138 * Following struct for object attributes, that will be kept inode's EA.
139 * Introduced in 2.0 release (please see b15993, for details)
140 * Added to all objects since Lustre 2.4 as contains self FID
141 */
142 struct lustre_mdt_attrs {
143 /**
144 * Bitfield for supported data in this structure. From enum lma_compat.
145 * lma_self_fid and lma_flags are always available.
146 */
147 __u32 lma_compat;
148 /**
149 * Per-file incompat feature list. Lustre version should support all
150 * flags set in this field. The supported feature mask is available in
151 * LMA_INCOMPAT_SUPP.
152 */
153 __u32 lma_incompat;
154 /** FID of this inode */
155 struct lu_fid lma_self_fid;
156 };
157
158 /**
159 * Prior to 2.4, the LMA structure also included SOM attributes which has since
160 * been moved to a dedicated xattr
161 * lma_flags was also removed because of lma_compat/incompat fields.
162 */
163 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
164
165 /**
166 * OST object IDentifier.
167 */
168 struct ost_id {
169 union {
170 struct ostid {
171 __u64 oi_id;
172 __u64 oi_seq;
173 } oi;
174 struct lu_fid oi_fid;
175 };
176 };
177
178 #define DOSTID "%#llx:%llu"
179 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
180
181 /*
182 * The ioctl naming rules:
183 * LL_* - works on the currently opened filehandle instead of parent dir
184 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
185 * *_MDC_* - gets/sets data related to MDC
186 * *_LOV_* - gets/sets data related to OSC/LOV
187 * *FILE* - called on parent dir and passes in a filename
188 * *STRIPE* - set/get lov_user_md
189 * *INFO - set/get lov_user_mds_data
190 */
191 /* see <lustre_lib.h> for ioctl numberss 101-150 */
192 #define LL_IOC_GETFLAGS _IOR('f', 151, long)
193 #define LL_IOC_SETFLAGS _IOW('f', 152, long)
194 #define LL_IOC_CLRFLAGS _IOW('f', 153, long)
195 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
196 #define LL_IOC_LOV_SETSTRIPE _IOW('f', 154, long)
197 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
198 #define LL_IOC_LOV_GETSTRIPE _IOW('f', 155, long)
199 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
200 #define LL_IOC_LOV_SETEA _IOW('f', 156, long)
201 #define LL_IOC_RECREATE_OBJ _IOW('f', 157, long)
202 #define LL_IOC_RECREATE_FID _IOW('f', 157, struct lu_fid)
203 #define LL_IOC_GROUP_LOCK _IOW('f', 158, long)
204 #define LL_IOC_GROUP_UNLOCK _IOW('f', 159, long)
205 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
206 #define LL_IOC_QUOTACHECK _IOW('f', 160, int)
207 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
208 #define LL_IOC_POLL_QUOTACHECK _IOR('f', 161, struct if_quotacheck *)
209 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
210 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
211 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
212 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
213 #define LL_IOC_FLUSHCTX _IOW('f', 166, long)
214 /* LL_IOC_RMTACL 167 obsolete */
215 #define LL_IOC_GETOBDCOUNT _IOR('f', 168, long)
216 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
217 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
218 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
219 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
220 #define LL_IOC_PATH2FID _IOR('f', 173, long)
221 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
222 #define LL_IOC_GET_MDTIDX _IOR('f', 175, int)
223
224 /* see <lustre_lib.h> for ioctl numbers 177-210 */
225
226 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
227 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
228 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
229 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
230 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
231 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
232 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
233 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
234 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
235 struct lustre_swap_layouts)
236 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
237 struct hsm_current_action)
238 /* see <lustre_lib.h> for ioctl numbers 221-232 */
239
240 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
241 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
242 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
243 #define LL_IOC_GET_LEASE _IO('f', 244)
244 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
245
246 #define LL_STATFS_LMV 1
247 #define LL_STATFS_LOV 2
248 #define LL_STATFS_NODELAY 4
249
250 #define IOC_MDC_TYPE 'i'
251 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
252 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
253 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
254 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
255
256 /* Keep these for backward compartability. */
257 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
258 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
259
260 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
261
262 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
263 * files, but are unlikely to be used in practice and are not harmful if
264 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
265 * devices and are safe for use on new files (See LU-812, LU-4209).
266 */
267 #define O_LOV_DELAY_CREATE (O_NOCTTY | FASYNC)
268
269 #define LL_FILE_IGNORE_LOCK 0x00000001
270 #define LL_FILE_GROUP_LOCKED 0x00000002
271 #define LL_FILE_READAHEA 0x00000004
272 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
273 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
274 #define LL_FILE_RMTACL 0x00000020
275
276 #define LOV_USER_MAGIC_V1 0x0BD10BD0
277 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
278 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
279 #define LOV_USER_MAGIC_V3 0x0BD30BD0
280
281 #define LMV_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */
282 #define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/
283
284 #define LOV_PATTERN_RAID0 0x001
285 #define LOV_PATTERN_RAID1 0x002
286 #define LOV_PATTERN_FIRST 0x100
287
288 #define LOV_MAXPOOLNAME 16
289 #define LOV_POOLNAMEF "%.16s"
290
291 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
292 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
293 #define LOV_MAX_STRIPE_COUNT_OLD 160
294 /* This calculation is crafted so that input of 4096 will result in 160
295 * which in turn is equal to old maximal stripe count.
296 * XXX: In fact this is too simplified for now, what it also need is to get
297 * ea_type argument to clearly know how much space each stripe consumes.
298 *
299 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
300 * allocation that is sufficient for the current generation of systems.
301 *
302 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1)
303 */
304 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
305 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
306 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
307
308 #define lov_user_ost_data lov_user_ost_data_v1
309 struct lov_user_ost_data_v1 { /* per-stripe data structure */
310 struct ost_id l_ost_oi; /* OST object ID */
311 __u32 l_ost_gen; /* generation of this OST index */
312 __u32 l_ost_idx; /* OST index in LOV */
313 } __packed;
314
315 #define lov_user_md lov_user_md_v1
316 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
317 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
318 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
319 struct ost_id lmm_oi; /* LOV object ID */
320 __u32 lmm_stripe_size; /* size of stripe in bytes */
321 __u16 lmm_stripe_count; /* num stripes in use for this object */
322 union {
323 __u16 lmm_stripe_offset; /* starting stripe offset in
324 * lmm_objects, use when writing
325 */
326 __u16 lmm_layout_gen; /* layout generation number
327 * used when reading
328 */
329 };
330 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
331 } __attribute__((packed, __may_alias__));
332
333 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
334 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
335 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
336 struct ost_id lmm_oi; /* LOV object ID */
337 __u32 lmm_stripe_size; /* size of stripe in bytes */
338 __u16 lmm_stripe_count; /* num stripes in use for this object */
339 union {
340 __u16 lmm_stripe_offset; /* starting stripe offset in
341 * lmm_objects, use when writing
342 */
343 __u16 lmm_layout_gen; /* layout generation number
344 * used when reading
345 */
346 };
347 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
348 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
349 } __packed;
350
351 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
352 {
353 if (lmm_magic == LOV_USER_MAGIC_V3)
354 return sizeof(struct lov_user_md_v3) +
355 stripes * sizeof(struct lov_user_ost_data_v1);
356 else
357 return sizeof(struct lov_user_md_v1) +
358 stripes * sizeof(struct lov_user_ost_data_v1);
359 }
360
361 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
362 * use this. It is unsafe to #define those values in this header as it
363 * is possible the application has already #included <sys/stat.h>. */
364 #ifdef HAVE_LOV_USER_MDS_DATA
365 #define lov_user_mds_data lov_user_mds_data_v1
366 struct lov_user_mds_data_v1 {
367 lstat_t lmd_st; /* MDS stat struct */
368 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
369 } __packed;
370
371 struct lov_user_mds_data_v3 {
372 lstat_t lmd_st; /* MDS stat struct */
373 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
374 } __packed;
375 #endif
376
377 /* keep this to be the same size as lov_user_ost_data_v1 */
378 struct lmv_user_mds_data {
379 struct lu_fid lum_fid;
380 __u32 lum_padding;
381 __u32 lum_mds;
382 };
383
384 /* lum_type */
385 enum {
386 LMV_STRIPE_TYPE = 0,
387 LMV_DEFAULT_TYPE = 1,
388 };
389
390 #define lmv_user_md lmv_user_md_v1
391 struct lmv_user_md_v1 {
392 __u32 lum_magic; /* must be the first field */
393 __u32 lum_stripe_count; /* dirstripe count */
394 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
395 __u32 lum_hash_type; /* Dir stripe policy */
396 __u32 lum_type; /* LMV type: default or normal */
397 __u32 lum_padding1;
398 __u32 lum_padding2;
399 __u32 lum_padding3;
400 char lum_pool_name[LOV_MAXPOOLNAME];
401 struct lmv_user_mds_data lum_objects[0];
402 };
403
404 static inline int lmv_user_md_size(int stripes, int lmm_magic)
405 {
406 return sizeof(struct lmv_user_md) +
407 stripes * sizeof(struct lmv_user_mds_data);
408 }
409
410 struct ll_recreate_obj {
411 __u64 lrc_id;
412 __u32 lrc_ost_idx;
413 };
414
415 struct ll_fid {
416 __u64 id; /* holds object id */
417 __u32 generation; /* holds object generation */
418 __u32 f_type; /* holds object type or stripe idx when passing it to
419 * OST for saving into EA. */
420 };
421
422 #define UUID_MAX 40
423 struct obd_uuid {
424 char uuid[UUID_MAX];
425 };
426
427 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
428 const struct obd_uuid *u2)
429 {
430 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
431 }
432
433 static inline int obd_uuid_empty(struct obd_uuid *uuid)
434 {
435 return uuid->uuid[0] == '\0';
436 }
437
438 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
439 {
440 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
441 uuid->uuid[sizeof(*uuid) - 1] = '\0';
442 }
443
444 /* For printf's only, make sure uuid is terminated */
445 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
446 {
447 if (!uuid)
448 return NULL;
449
450 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
451 /* Obviously not safe, but for printfs, no real harm done...
452 * we're always null-terminated, even in a race.
453 */
454 static char temp[sizeof(*uuid)];
455
456 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
457 temp[sizeof(*uuid) - 1] = '\0';
458 return temp;
459 }
460 return (char *)(uuid->uuid);
461 }
462
463 /* Extract fsname from uuid (or target name) of a target
464 * e.g. (myfs-OST0007_UUID -> myfs)
465 * see also deuuidify.
466 */
467 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
468 {
469 char *p;
470
471 strncpy(buf, uuid, buflen - 1);
472 buf[buflen - 1] = '\0';
473 p = strrchr(buf, '-');
474 if (p)
475 *p = '\0';
476 }
477
478 /* printf display format
479 * e.g. printf("file FID is "DFID"\n", PFID(fid));
480 */
481 #define FID_NOBRACE_LEN 40
482 #define FID_LEN (FID_NOBRACE_LEN + 2)
483 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
484 #define DFID "["DFID_NOBRACE"]"
485 #define PFID(fid) \
486 (fid)->f_seq, \
487 (fid)->f_oid, \
488 (fid)->f_ver
489
490 /* scanf input parse format -- strip '[' first.
491 * e.g. sscanf(fidstr, SFID, RFID(&fid));
492 */
493 #define SFID "0x%llx:0x%x:0x%x"
494 #define RFID(fid) \
495 &((fid)->f_seq), \
496 &((fid)->f_oid), \
497 &((fid)->f_ver)
498
499 /********* Quotas **********/
500
501 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
502 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
503 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
504 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
505 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
506 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
507 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
508 /* lustre-specific control commands */
509 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
510 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
511
512 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
513
514 struct if_quotacheck {
515 char obd_type[16];
516 struct obd_uuid obd_uuid;
517 };
518
519 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
520
521 /* permission */
522 #define N_PERMS_MAX 64
523
524 struct perm_downcall_data {
525 __u64 pdd_nid;
526 __u32 pdd_perm;
527 __u32 pdd_padding;
528 };
529
530 struct identity_downcall_data {
531 __u32 idd_magic;
532 __u32 idd_err;
533 __u32 idd_uid;
534 __u32 idd_gid;
535 __u32 idd_nperms;
536 __u32 idd_ngroups;
537 struct perm_downcall_data idd_perms[N_PERMS_MAX];
538 __u32 idd_groups[0];
539 };
540
541 /* lustre volatile file support
542 * file name header: .^L^S^T^R:volatile"
543 */
544 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
545 #define LUSTRE_VOLATILE_HDR_LEN 14
546 /* hdr + MDT index */
547 #define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:"
548
549 enum lustre_quota_version {
550 LUSTRE_QUOTA_V2 = 1
551 };
552
553 /* XXX: same as if_dqinfo struct in kernel */
554 struct obd_dqinfo {
555 __u64 dqi_bgrace;
556 __u64 dqi_igrace;
557 __u32 dqi_flags;
558 __u32 dqi_valid;
559 };
560
561 /* XXX: same as if_dqblk struct in kernel, plus one padding */
562 struct obd_dqblk {
563 __u64 dqb_bhardlimit;
564 __u64 dqb_bsoftlimit;
565 __u64 dqb_curspace;
566 __u64 dqb_ihardlimit;
567 __u64 dqb_isoftlimit;
568 __u64 dqb_curinodes;
569 __u64 dqb_btime;
570 __u64 dqb_itime;
571 __u32 dqb_valid;
572 __u32 dqb_padding;
573 };
574
575 enum {
576 QC_GENERAL = 0,
577 QC_MDTIDX = 1,
578 QC_OSTIDX = 2,
579 QC_UUID = 3
580 };
581
582 struct if_quotactl {
583 __u32 qc_cmd;
584 __u32 qc_type;
585 __u32 qc_id;
586 __u32 qc_stat;
587 __u32 qc_valid;
588 __u32 qc_idx;
589 struct obd_dqinfo qc_dqinfo;
590 struct obd_dqblk qc_dqblk;
591 char obd_type[16];
592 struct obd_uuid obd_uuid;
593 };
594
595 /* swap layout flags */
596 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
597 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
598 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
599 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
600
601 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
602 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
603 struct lustre_swap_layouts {
604 __u64 sl_flags;
605 __u32 sl_fd;
606 __u32 sl_gid;
607 __u64 sl_dv1;
608 __u64 sl_dv2;
609 };
610
611 /********* Changelogs **********/
612 /** Changelog record types */
613 enum changelog_rec_type {
614 CL_MARK = 0,
615 CL_CREATE = 1, /* namespace */
616 CL_MKDIR = 2, /* namespace */
617 CL_HARDLINK = 3, /* namespace */
618 CL_SOFTLINK = 4, /* namespace */
619 CL_MKNOD = 5, /* namespace */
620 CL_UNLINK = 6, /* namespace */
621 CL_RMDIR = 7, /* namespace */
622 CL_RENAME = 8, /* namespace */
623 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
624 CL_OPEN = 10, /* not currently used */
625 CL_CLOSE = 11, /* may be written to log only with mtime change */
626 CL_LAYOUT = 12, /* file layout/striping modified */
627 CL_TRUNC = 13,
628 CL_SETATTR = 14,
629 CL_XATTR = 15,
630 CL_HSM = 16, /* HSM specific events, see flags */
631 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
632 CL_CTIME = 18,
633 CL_ATIME = 19,
634 CL_LAST
635 };
636
637 static inline const char *changelog_type2str(int type)
638 {
639 static const char *changelog_str[] = {
640 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
641 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
642 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME",
643 };
644
645 if (type >= 0 && type < CL_LAST)
646 return changelog_str[type];
647 return NULL;
648 }
649
650 /* per-record flags */
651 #define CLF_VERSION 0x1000
652 #define CLF_EXT_VERSION 0x2000
653 #define CLF_FLAGSHIFT 12
654 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
655 #define CLF_VERMASK (~CLF_FLAGMASK)
656 /* Anything under the flagmask may be per-type (if desired) */
657 /* Flags for unlink */
658 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
659 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
660 /* HSM cleaning needed */
661 /* Flags for rename */
662 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of
663 * target
664 */
665 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
666 * has an archive in backend
667 */
668
669 /* Flags for HSM */
670 /* 12b used (from high weight to low weight):
671 * 2b for flags
672 * 3b for event
673 * 7b for error code
674 */
675 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
676 #define CLF_HSM_ERR_H 6
677 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
678 #define CLF_HSM_EVENT_H 9
679 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
680 #define CLF_HSM_FLAG_H 11
681 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
682 #define CLF_HSM_SPARE_H 15
683 #define CLF_HSM_LAST 15
684
685 /* Remove bits higher than _h, then extract the value
686 * between _h and _l by shifting lower weigth to bit 0.
687 */
688 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
689 >> (CLF_HSM_LAST - _h + _l))
690
691 #define CLF_HSM_SUCCESS 0x00
692 #define CLF_HSM_MAXERROR 0x7E
693 #define CLF_HSM_ERROVERFLOW 0x7F
694
695 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
696
697 /* 3 bits field => 8 values allowed */
698 enum hsm_event {
699 HE_ARCHIVE = 0,
700 HE_RESTORE = 1,
701 HE_CANCEL = 2,
702 HE_RELEASE = 3,
703 HE_REMOVE = 4,
704 HE_STATE = 5,
705 HE_SPARE1 = 6,
706 HE_SPARE2 = 7,
707 };
708
709 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
710 {
711 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
712 }
713
714 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
715 {
716 *flags |= (he << CLF_HSM_EVENT_L);
717 }
718
719 static inline __u16 hsm_get_cl_flags(int flags)
720 {
721 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
722 }
723
724 static inline void hsm_set_cl_flags(int *flags, int bits)
725 {
726 *flags |= (bits << CLF_HSM_FLAG_L);
727 }
728
729 static inline int hsm_get_cl_error(int flags)
730 {
731 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
732 }
733
734 static inline void hsm_set_cl_error(int *flags, int error)
735 {
736 *flags |= (error << CLF_HSM_ERR_L);
737 }
738
739 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
740 sizeof(struct changelog_ext_rec))
741
742 struct changelog_rec {
743 __u16 cr_namelen;
744 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
745 __u32 cr_type; /**< \a changelog_rec_type */
746 __u64 cr_index; /**< changelog record number */
747 __u64 cr_prev; /**< last index for this target fid */
748 __u64 cr_time;
749 union {
750 struct lu_fid cr_tfid; /**< target fid */
751 __u32 cr_markerflags; /**< CL_MARK flags */
752 };
753 struct lu_fid cr_pfid; /**< parent fid */
754 char cr_name[0]; /**< last element */
755 } __packed;
756
757 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
758 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
759 * store records.
760 */
761 struct changelog_ext_rec {
762 __u16 cr_namelen;
763 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
764 * CLF_EXT_VERSION
765 */
766 __u32 cr_type; /**< \a changelog_rec_type */
767 __u64 cr_index; /**< changelog record number */
768 __u64 cr_prev; /**< last index for this target fid */
769 __u64 cr_time;
770 union {
771 struct lu_fid cr_tfid; /**< target fid */
772 __u32 cr_markerflags; /**< CL_MARK flags */
773 };
774 struct lu_fid cr_pfid; /**< target parent fid */
775 struct lu_fid cr_sfid; /**< source fid, or zero */
776 struct lu_fid cr_spfid; /**< source parent fid, or zero */
777 char cr_name[0]; /**< last element */
778 } __packed;
779
780 #define CHANGELOG_REC_EXTENDED(rec) \
781 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
782
783 static inline int changelog_rec_size(struct changelog_rec *rec)
784 {
785 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec) :
786 sizeof(*rec);
787 }
788
789 static inline char *changelog_rec_name(struct changelog_rec *rec)
790 {
791 return CHANGELOG_REC_EXTENDED(rec) ?
792 ((struct changelog_ext_rec *)rec)->cr_name : rec->cr_name;
793 }
794
795 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
796 {
797 return rec->cr_namelen - strlen(rec->cr_name) - 1;
798 }
799
800 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
801 {
802 return rec->cr_name + strlen(rec->cr_name) + 1;
803 }
804
805 struct ioc_changelog {
806 __u64 icc_recno;
807 __u32 icc_mdtindex;
808 __u32 icc_id;
809 __u32 icc_flags;
810 };
811
812 enum changelog_message_type {
813 CL_RECORD = 10, /* message is a changelog_rec */
814 CL_EOF = 11, /* at end of current changelog */
815 };
816
817 /********* Misc **********/
818
819 struct ioc_data_version {
820 __u64 idv_version;
821 __u64 idv_flags; /* See LL_DV_xxx */
822 };
823
824 #define LL_DV_RD_FLUSH BIT(0) /* Flush dirty pages from clients */
825 #define LL_DV_WR_FLUSH BIT(1) /* Flush all caching pages from clients */
826
827 #ifndef offsetof
828 # define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
829 #endif
830
831 #define dot_lustre_name ".lustre"
832
833 /********* HSM **********/
834
835 /** HSM per-file state
836 * See HSM_FLAGS below.
837 */
838 enum hsm_states {
839 HS_EXISTS = 0x00000001,
840 HS_DIRTY = 0x00000002,
841 HS_RELEASED = 0x00000004,
842 HS_ARCHIVED = 0x00000008,
843 HS_NORELEASE = 0x00000010,
844 HS_NOARCHIVE = 0x00000020,
845 HS_LOST = 0x00000040,
846 };
847
848 /* HSM user-setable flags. */
849 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
850
851 /* Other HSM flags. */
852 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
853
854 /*
855 * All HSM-related possible flags that could be applied to a file.
856 * This should be kept in sync with hsm_states.
857 */
858 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
859
860 /**
861 * HSM request progress state
862 */
863 enum hsm_progress_states {
864 HPS_WAITING = 1,
865 HPS_RUNNING = 2,
866 HPS_DONE = 3,
867 };
868
869 #define HPS_NONE 0
870
871 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
872 {
873 switch (s) {
874 case HPS_WAITING: return "waiting";
875 case HPS_RUNNING: return "running";
876 case HPS_DONE: return "done";
877 default: return "unknown";
878 }
879 }
880
881 struct hsm_extent {
882 __u64 offset;
883 __u64 length;
884 } __packed;
885
886 /**
887 * Current HSM states of a Lustre file.
888 *
889 * This structure purpose is to be sent to user-space mainly. It describes the
890 * current HSM flags and in-progress action.
891 */
892 struct hsm_user_state {
893 /** Current HSM states, from enum hsm_states. */
894 __u32 hus_states;
895 __u32 hus_archive_id;
896 /** The current undergoing action, if there is one */
897 __u32 hus_in_progress_state;
898 __u32 hus_in_progress_action;
899 struct hsm_extent hus_in_progress_location;
900 char hus_extended_info[];
901 };
902
903 struct hsm_state_set_ioc {
904 struct lu_fid hssi_fid;
905 __u64 hssi_setmask;
906 __u64 hssi_clearmask;
907 };
908
909 /*
910 * This structure describes the current in-progress action for a file.
911 * it is returned to user space and send over the wire
912 */
913 struct hsm_current_action {
914 /** The current undergoing action, if there is one */
915 /* state is one of hsm_progress_states */
916 __u32 hca_state;
917 /* action is one of hsm_user_action */
918 __u32 hca_action;
919 struct hsm_extent hca_location;
920 };
921
922 /***** HSM user requests ******/
923 /* User-generated (lfs/ioctl) request types */
924 enum hsm_user_action {
925 HUA_NONE = 1, /* no action (noop) */
926 HUA_ARCHIVE = 10, /* copy to hsm */
927 HUA_RESTORE = 11, /* prestage */
928 HUA_RELEASE = 12, /* drop ost objects */
929 HUA_REMOVE = 13, /* remove from archive */
930 HUA_CANCEL = 14 /* cancel a request */
931 };
932
933 static inline char *hsm_user_action2name(enum hsm_user_action a)
934 {
935 switch (a) {
936 case HUA_NONE: return "NOOP";
937 case HUA_ARCHIVE: return "ARCHIVE";
938 case HUA_RESTORE: return "RESTORE";
939 case HUA_RELEASE: return "RELEASE";
940 case HUA_REMOVE: return "REMOVE";
941 case HUA_CANCEL: return "CANCEL";
942 default: return "UNKNOWN";
943 }
944 }
945
946 /*
947 * List of hr_flags (bit field)
948 */
949 #define HSM_FORCE_ACTION 0x0001
950 /* used by CT, connot be set by user */
951 #define HSM_GHOST_COPY 0x0002
952
953 /**
954 * Contains all the fixed part of struct hsm_user_request.
955 *
956 */
957 struct hsm_request {
958 __u32 hr_action; /* enum hsm_user_action */
959 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
960 __u64 hr_flags; /* request flags */
961 __u32 hr_itemcount; /* item count in hur_user_item vector */
962 __u32 hr_data_len;
963 };
964
965 struct hsm_user_item {
966 struct lu_fid hui_fid;
967 struct hsm_extent hui_extent;
968 } __packed;
969
970 struct hsm_user_request {
971 struct hsm_request hur_request;
972 struct hsm_user_item hur_user_item[0];
973 /* extra data blob at end of struct (after all
974 * hur_user_items), only use helpers to access it
975 */
976 } __packed;
977
978 /** Return pointer to data field in a hsm user request */
979 static inline void *hur_data(struct hsm_user_request *hur)
980 {
981 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
982 }
983
984 /**
985 * Compute the current length of the provided hsm_user_request. This returns -1
986 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
987 *
988 * return -1 on bounds check error.
989 */
990 static inline ssize_t hur_len(struct hsm_user_request *hur)
991 {
992 __u64 size;
993
994 /* can't overflow a __u64 since hr_itemcount is only __u32 */
995 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
996 (__u64)hur->hur_request.hr_itemcount *
997 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
998
999 if (size != (ssize_t)size)
1000 return -1;
1001
1002 return size;
1003 }
1004
1005 /****** HSM RPCs to copytool *****/
1006 /* Message types the copytool may receive */
1007 enum hsm_message_type {
1008 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1009 };
1010
1011 /* Actions the copytool may be instructed to take for a given action_item */
1012 enum hsm_copytool_action {
1013 HSMA_NONE = 10, /* no action */
1014 HSMA_ARCHIVE = 20, /* arbitrary offset */
1015 HSMA_RESTORE = 21,
1016 HSMA_REMOVE = 22,
1017 HSMA_CANCEL = 23
1018 };
1019
1020 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
1021 {
1022 switch (a) {
1023 case HSMA_NONE: return "NOOP";
1024 case HSMA_ARCHIVE: return "ARCHIVE";
1025 case HSMA_RESTORE: return "RESTORE";
1026 case HSMA_REMOVE: return "REMOVE";
1027 case HSMA_CANCEL: return "CANCEL";
1028 default: return "UNKNOWN";
1029 }
1030 }
1031
1032 /* Copytool item action description */
1033 struct hsm_action_item {
1034 __u32 hai_len; /* valid size of this struct */
1035 __u32 hai_action; /* hsm_copytool_action, but use known size */
1036 struct lu_fid hai_fid; /* Lustre FID to operated on */
1037 struct lu_fid hai_dfid; /* fid used for data access */
1038 struct hsm_extent hai_extent; /* byte range to operate on */
1039 __u64 hai_cookie; /* action cookie from coordinator */
1040 __u64 hai_gid; /* grouplock id */
1041 char hai_data[0]; /* variable length */
1042 } __packed;
1043
1044 /*
1045 * helper function which print in hexa the first bytes of
1046 * hai opaque field
1047 * \param hai [IN] record to print
1048 * \param buffer [OUT] output buffer
1049 * \param len [IN] max buffer len
1050 * \retval buffer
1051 */
1052 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
1053 char *buffer, int len)
1054 {
1055 int i, sz, data_len;
1056 char *ptr;
1057
1058 ptr = buffer;
1059 sz = len;
1060 data_len = hai->hai_len - sizeof(*hai);
1061 for (i = 0 ; (i < data_len) && (sz > 0) ; i++) {
1062 int cnt;
1063
1064 cnt = snprintf(ptr, sz, "%.2X",
1065 (unsigned char)hai->hai_data[i]);
1066 ptr += cnt;
1067 sz -= cnt;
1068 }
1069 *ptr = '\0';
1070 return buffer;
1071 }
1072
1073 /* Copytool action list */
1074 #define HAL_VERSION 1
1075 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1076 struct hsm_action_list {
1077 __u32 hal_version;
1078 __u32 hal_count; /* number of hai's to follow */
1079 __u64 hal_compound_id; /* returned by coordinator */
1080 __u64 hal_flags;
1081 __u32 hal_archive_id; /* which archive backend */
1082 __u32 padding1;
1083 char hal_fsname[0]; /* null-terminated */
1084 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1085 * boundaries. See hai_first
1086 */
1087 } __packed;
1088
1089 #ifndef HAVE_CFS_SIZE_ROUND
1090 static inline int cfs_size_round(int val)
1091 {
1092 return (val + 7) & (~0x7);
1093 }
1094
1095 #define HAVE_CFS_SIZE_ROUND
1096 #endif
1097
1098 /* Return pointer to first hai in action list */
1099 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1100 {
1101 return (struct hsm_action_item *)(hal->hal_fsname +
1102 cfs_size_round(strlen(hal-> \
1103 hal_fsname)
1104 + 1));
1105 }
1106
1107 /* Return pointer to next hai */
1108 static inline struct hsm_action_item *hai_next(struct hsm_action_item *hai)
1109 {
1110 return (struct hsm_action_item *)((char *)hai +
1111 cfs_size_round(hai->hai_len));
1112 }
1113
1114 /* Return size of an hsm_action_list */
1115 static inline int hal_size(struct hsm_action_list *hal)
1116 {
1117 int i, sz;
1118 struct hsm_action_item *hai;
1119
1120 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1121 hai = hai_first(hal);
1122 for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai))
1123 sz += cfs_size_round(hai->hai_len);
1124
1125 return sz;
1126 }
1127
1128 /* HSM file import
1129 * describe the attributes to be set on imported file
1130 */
1131 struct hsm_user_import {
1132 __u64 hui_size;
1133 __u64 hui_atime;
1134 __u64 hui_mtime;
1135 __u32 hui_atime_ns;
1136 __u32 hui_mtime_ns;
1137 __u32 hui_uid;
1138 __u32 hui_gid;
1139 __u32 hui_mode;
1140 __u32 hui_archive_id;
1141 };
1142
1143 /* Copytool progress reporting */
1144 #define HP_FLAG_COMPLETED 0x01
1145 #define HP_FLAG_RETRY 0x02
1146
1147 struct hsm_progress {
1148 struct lu_fid hp_fid;
1149 __u64 hp_cookie;
1150 struct hsm_extent hp_extent;
1151 __u16 hp_flags;
1152 __u16 hp_errval; /* positive val */
1153 __u32 padding;
1154 };
1155
1156 struct hsm_copy {
1157 __u64 hc_data_version;
1158 __u16 hc_flags;
1159 __u16 hc_errval; /* positive val */
1160 __u32 padding;
1161 struct hsm_action_item hc_hai;
1162 };
1163
1164 /** @} lustreuser */
1165
1166 #endif /* _LUSTRE_USER_H */
Linux kernel - Deliverables
This page took 0.113366 seconds and 5 git commands to generate.