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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2010, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_user.h
38 * Lustre public user-space interface definitions.
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
44 /** \defgroup lustreuser lustreuser
49 #include <libcfs/types.h>
52 # include <linux/string.h> /* snprintf() */
54 # include <stdio.h> /* snprintf() */
56 #include <lustre/ll_fiemap.h>
57 #if defined(__linux__)
58 #include <linux/lustre_user.h>
60 #error Unsupported operating system.
63 #define LUSTRE_EOF 0xffffffffffffffffULL
66 #define LL_SUPER_MAGIC 0x0BD00BD0
68 #ifndef FSFILT_IOC_GETFLAGS
69 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
70 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
71 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
72 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
73 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
74 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
75 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
78 /* FIEMAP flags supported by Lustre */
79 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
81 enum obd_statfs_state {
82 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
83 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
84 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
85 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
86 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
100 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
101 __u32 os_fprecreated; /* objs available now to the caller */
102 /* used in QoS code to find preferred
117 * FID is a cluster-wide unique identifier of a file or an object (stripe).
118 * FIDs are never reused.
122 * FID sequence. Sequence is a unit of migration: all files (objects)
123 * with FIDs from a given sequence are stored on the same server.
124 * Lustre should support 2^64 objects, so even if each sequence
125 * has only a single object we can still enumerate 2^64 objects.
128 /* FID number within sequence. */
131 * FID version, used to distinguish different versions (in the sense
132 * of snapshots, etc.) of the same file system object. Not currently
138 static inline bool fid_is_zero(const struct lu_fid *fid)
140 return fid->f_seq == 0 && fid->f_oid == 0;
143 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
144 * MDT-object's FID::f_ver, instead it is the OST-object index in its
145 * parent MDT-object's layout EA. */
146 #define f_stripe_idx f_ver
149 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
152 /* keep this one for compatibility */
153 struct filter_fid_old {
154 struct lu_fid ff_parent;
159 /* Userspace should treat lu_fid as opaque, and only use the following methods
160 * to print or parse them. Other functions (e.g. compare, swab) could be moved
161 * here from lustre_idl.h if needed. */
162 typedef struct lu_fid lustre_fid;
165 * Following struct for object attributes, that will be kept inode's EA.
166 * Introduced in 2.0 release (please see b15993, for details)
167 * Added to all objects since Lustre 2.4 as contains self FID
169 struct lustre_mdt_attrs {
171 * Bitfield for supported data in this structure. From enum lma_compat.
172 * lma_self_fid and lma_flags are always available.
176 * Per-file incompat feature list. Lustre version should support all
177 * flags set in this field. The supported feature mask is available in
181 /** FID of this inode */
182 struct lu_fid lma_self_fid;
186 * Prior to 2.4, the LMA structure also included SOM attributes which has since
187 * been moved to a dedicated xattr
188 * lma_flags was also removed because of lma_compat/incompat fields.
190 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
193 * OST object IDentifier.
201 struct lu_fid oi_fid;
205 #define DOSTID LPX64":"LPU64
206 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
209 * The ioctl naming rules:
210 * LL_* - works on the currently opened filehandle instead of parent dir
211 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
212 * *_MDC_* - gets/sets data related to MDC
213 * *_LOV_* - gets/sets data related to OSC/LOV
214 * *FILE* - called on parent dir and passes in a filename
215 * *STRIPE* - set/get lov_user_md
216 * *INFO - set/get lov_user_mds_data
218 /* lustre_ioctl.h 101-150 */
219 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
220 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
221 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
222 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
223 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
224 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
225 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
226 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
227 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
228 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
229 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
230 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
231 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
232 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
233 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
234 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
235 #define LL_IOC_RMTACL _IOW ('f', 167, long)
236 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
237 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
238 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
239 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
240 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
241 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
242 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
243 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
244 /* lustre_ioctl.h 177-210 */
245 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
246 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
247 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
248 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
249 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
250 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
251 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
252 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
253 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
254 struct lustre_swap_layouts)
255 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
256 struct hsm_current_action)
257 /* lustre_ioctl.h 221-232 */
258 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
259 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
260 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
261 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
262 #define LL_IOC_GET_LEASE _IO('f', 244)
263 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
264 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
265 #define LL_IOC_MIGRATE _IOR('f', 247, int)
266 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
268 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
270 LL_LEASE_RDLCK = 0x1,
271 LL_LEASE_WRLCK = 0x2,
272 LL_LEASE_UNLCK = 0x4,
275 #define LL_STATFS_LMV 1
276 #define LL_STATFS_LOV 2
277 #define LL_STATFS_NODELAY 4
279 #define IOC_MDC_TYPE 'i'
280 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
281 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
282 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
283 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
285 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
287 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
288 * files, but are unlikely to be used in practice and are not harmful if
289 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
290 * devices and are safe for use on new files. See LU-4209. */
291 /* To be compatible with old statically linked binary we keep the check for
292 * the older 0100000000 flag. This is already removed upstream. LU-812. */
293 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
294 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
295 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
296 O_LOV_DELAY_CREATE_MASK)
298 #define LL_FILE_IGNORE_LOCK 0x00000001
299 #define LL_FILE_GROUP_LOCKED 0x00000002
300 #define LL_FILE_READAHEA 0x00000004
301 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
302 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
303 #define LL_FILE_RMTACL 0x00000020
305 #define LOV_USER_MAGIC_V1 0x0BD10BD0
306 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
307 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
308 #define LOV_USER_MAGIC_V3 0x0BD30BD0
310 #define LMV_USER_MAGIC 0x0CD30CD0 /*default lmv magic*/
312 #define LOV_PATTERN_RAID0 0x001
313 #define LOV_PATTERN_RAID1 0x002
314 #define LOV_PATTERN_FIRST 0x100
315 #define LOV_PATTERN_CMOBD 0x200
317 #define LOV_PATTERN_F_MASK 0xffff0000
318 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
319 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
321 #define LOV_MAXPOOLNAME 16
322 #define LOV_POOLNAMEF "%.16s"
324 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
325 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
326 #define LOV_MAX_STRIPE_COUNT_OLD 160
327 /* This calculation is crafted so that input of 4096 will result in 160
328 * which in turn is equal to old maximal stripe count.
329 * XXX: In fact this is too simpified for now, what it also need is to get
330 * ea_type argument to clearly know how much space each stripe consumes.
332 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
333 * allocation that is sufficient for the current generation of systems.
335 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
336 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
337 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
338 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
340 #define XATTR_LUSTRE_PREFIX "lustre."
341 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
343 #define lov_user_ost_data lov_user_ost_data_v1
344 struct lov_user_ost_data_v1 { /* per-stripe data structure */
345 struct ost_id l_ost_oi; /* OST object ID */
346 __u32 l_ost_gen; /* generation of this OST index */
347 __u32 l_ost_idx; /* OST index in LOV */
348 } __attribute__((packed));
350 #define lov_user_md lov_user_md_v1
351 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
352 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
353 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
354 struct ost_id lmm_oi; /* LOV object ID */
355 __u32 lmm_stripe_size; /* size of stripe in bytes */
356 __u16 lmm_stripe_count; /* num stripes in use for this object */
358 __u16 lmm_stripe_offset; /* starting stripe offset in
359 * lmm_objects, use when writing */
360 __u16 lmm_layout_gen; /* layout generation number
361 * used when reading */
363 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
364 } __attribute__((packed, __may_alias__));
366 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
367 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
368 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
369 struct ost_id lmm_oi; /* LOV object ID */
370 __u32 lmm_stripe_size; /* size of stripe in bytes */
371 __u16 lmm_stripe_count; /* num stripes in use for this object */
373 __u16 lmm_stripe_offset; /* starting stripe offset in
374 * lmm_objects, use when writing */
375 __u16 lmm_layout_gen; /* layout generation number
376 * used when reading */
378 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
379 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
380 } __attribute__((packed));
382 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
384 if (lmm_magic == LOV_USER_MAGIC_V3)
385 return sizeof(struct lov_user_md_v3) +
386 stripes * sizeof(struct lov_user_ost_data_v1);
388 return sizeof(struct lov_user_md_v1) +
389 stripes * sizeof(struct lov_user_ost_data_v1);
392 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
393 * use this. It is unsafe to #define those values in this header as it
394 * is possible the application has already #included <sys/stat.h>. */
395 #ifdef HAVE_LOV_USER_MDS_DATA
396 #define lov_user_mds_data lov_user_mds_data_v1
397 struct lov_user_mds_data_v1 {
398 lstat_t lmd_st; /* MDS stat struct */
399 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
400 } __attribute__((packed));
402 struct lov_user_mds_data_v3 {
403 lstat_t lmd_st; /* MDS stat struct */
404 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
405 } __attribute__((packed));
408 struct lmv_user_mds_data {
409 struct lu_fid lum_fid;
415 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
416 LMV_HASH_TYPE_ALL_CHARS = 1,
417 LMV_HASH_TYPE_FNV_1A_64 = 2,
420 #define LMV_HASH_NAME_ALL_CHARS "all_char"
421 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
423 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
424 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
425 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
426 #define lmv_user_md lmv_user_md_v1
427 struct lmv_user_md_v1 {
428 __u32 lum_magic; /* must be the first field */
429 __u32 lum_stripe_count; /* dirstripe count */
430 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
431 __u32 lum_hash_type; /* Dir stripe policy */
432 __u32 lum_type; /* LMV type: default or normal */
436 char lum_pool_name[LOV_MAXPOOLNAME];
437 struct lmv_user_mds_data lum_objects[0];
438 } __attribute__((packed));
440 static inline int lmv_user_md_size(int stripes, int lmm_magic)
442 return sizeof(struct lmv_user_md) +
443 stripes * sizeof(struct lmv_user_mds_data);
446 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
448 struct ll_recreate_obj {
454 __u64 id; /* holds object id */
455 __u32 generation; /* holds object generation */
456 __u32 f_type; /* holds object type or stripe idx when passing it to
457 * OST for saving into EA. */
465 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
466 const struct obd_uuid *u2)
468 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
471 static inline int obd_uuid_empty(struct obd_uuid *uuid)
473 return uuid->uuid[0] == '\0';
476 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
478 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
479 uuid->uuid[sizeof(*uuid) - 1] = '\0';
482 /* For printf's only, make sure uuid is terminated */
483 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
488 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
489 /* Obviously not safe, but for printfs, no real harm done...
490 we're always null-terminated, even in a race. */
491 static char temp[sizeof(*uuid)];
492 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
493 temp[sizeof(*uuid) - 1] = '\0';
496 return (char *)(uuid->uuid);
499 /* Extract fsname from uuid (or target name) of a target
500 e.g. (myfs-OST0007_UUID -> myfs)
501 see also deuuidify. */
502 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
506 strncpy(buf, uuid, buflen - 1);
507 buf[buflen - 1] = '\0';
508 p = strrchr(buf, '-');
513 /* printf display format
514 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
515 #define FID_NOBRACE_LEN 40
516 #define FID_LEN (FID_NOBRACE_LEN + 2)
517 #define DFID_NOBRACE LPX64":0x%x:0x%x"
518 #define DFID "["DFID_NOBRACE"]"
524 /* scanf input parse format -- strip '[' first.
525 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
526 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
527 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
528 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
530 #define SFID "0x"LPX64i":0x%x:0x%x"
537 /********* Quotas **********/
539 #define LUSTRE_QUOTABLOCK_BITS 10
540 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
542 static inline __u64 lustre_stoqb(size_t space)
544 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
547 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
548 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
549 #define Q_GETOINFO 0x800102 /* get obd quota info */
550 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
551 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
553 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
554 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
555 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
556 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
557 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
558 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
559 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
560 /* lustre-specific control commands */
561 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
562 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
564 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
566 struct if_quotacheck {
568 struct obd_uuid obd_uuid;
571 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
574 #define N_PERMS_MAX 64
576 struct perm_downcall_data {
582 struct identity_downcall_data {
589 struct perm_downcall_data idd_perms[N_PERMS_MAX];
593 /* for non-mapped uid/gid */
594 #define NOBODY_UID 99
595 #define NOBODY_GID 99
597 #define INVALID_ID (-1)
606 #ifdef NEED_QUOTA_DEFS
608 #define QIF_BLIMITS 1
610 #define QIF_ILIMITS 4
614 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
615 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
616 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
617 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
620 #endif /* !__KERNEL__ */
622 /* lustre volatile file support
623 * file name header: .^L^S^T^R:volatile"
625 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
626 #define LUSTRE_VOLATILE_HDR_LEN 14
628 typedef enum lustre_quota_version {
630 } lustre_quota_version_t;
632 /* XXX: same as if_dqinfo struct in kernel */
640 /* XXX: same as if_dqblk struct in kernel, plus one padding */
642 __u64 dqb_bhardlimit;
643 __u64 dqb_bsoftlimit;
645 __u64 dqb_ihardlimit;
646 __u64 dqb_isoftlimit;
668 struct obd_dqinfo qc_dqinfo;
669 struct obd_dqblk qc_dqblk;
671 struct obd_uuid obd_uuid;
674 /* swap layout flags */
675 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
676 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
677 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
678 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
680 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
681 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
682 struct lustre_swap_layouts {
691 /********* Changelogs **********/
692 /** Changelog record types */
693 enum changelog_rec_type {
695 CL_CREATE = 1, /* namespace */
696 CL_MKDIR = 2, /* namespace */
697 CL_HARDLINK = 3, /* namespace */
698 CL_SOFTLINK = 4, /* namespace */
699 CL_MKNOD = 5, /* namespace */
700 CL_UNLINK = 6, /* namespace */
701 CL_RMDIR = 7, /* namespace */
702 CL_RENAME = 8, /* namespace */
703 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
704 CL_OPEN = 10, /* not currently used */
705 CL_CLOSE = 11, /* may be written to log only with mtime change */
706 CL_LAYOUT = 12, /* file layout/striping modified */
710 CL_HSM = 16, /* HSM specific events, see flags */
711 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
717 static inline const char *changelog_type2str(int type) {
718 static const char *changelog_str[] = {
719 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
720 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
721 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME",
724 if (type >= 0 && type < CL_LAST)
725 return changelog_str[type];
729 /* per-record flags */
730 #define CLF_VERSION 0x1000
731 #define CLF_EXT_VERSION 0x2000
732 #define CLF_FLAGSHIFT 12
733 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
734 #define CLF_VERMASK (~CLF_FLAGMASK)
735 /* Anything under the flagmask may be per-type (if desired) */
736 /* Flags for unlink */
737 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
738 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
739 /* HSM cleaning needed */
740 /* Flags for rename */
741 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
743 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
744 * has an archive in backend */
747 /* 12b used (from high weight to low weight):
752 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
753 #define CLF_HSM_ERR_H 6
754 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
755 #define CLF_HSM_EVENT_H 9
756 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
757 #define CLF_HSM_FLAG_H 11
758 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
759 #define CLF_HSM_SPARE_H 15
760 #define CLF_HSM_LAST 15
762 /* Remove bits higher than _h, then extract the value
763 * between _h and _l by shifting lower weigth to bit 0. */
764 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
765 >> (CLF_HSM_LAST - _h + _l))
767 #define CLF_HSM_SUCCESS 0x00
768 #define CLF_HSM_MAXERROR 0x7E
769 #define CLF_HSM_ERROVERFLOW 0x7F
771 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
773 /* 3 bits field => 8 values allowed */
785 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
787 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
791 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
793 *flags |= (he << CLF_HSM_EVENT_L);
796 static inline __u16 hsm_get_cl_flags(int flags)
798 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
801 static inline void hsm_set_cl_flags(int *flags, int bits)
803 *flags |= (bits << CLF_HSM_FLAG_L);
806 static inline int hsm_get_cl_error(int flags)
808 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
811 static inline void hsm_set_cl_error(int *flags, int error)
813 *flags |= (error << CLF_HSM_ERR_L);
816 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
817 sizeof(struct changelog_ext_rec))
819 struct changelog_rec {
821 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
822 __u32 cr_type; /**< \a changelog_rec_type */
823 __u64 cr_index; /**< changelog record number */
824 __u64 cr_prev; /**< last index for this target fid */
827 lustre_fid cr_tfid; /**< target fid */
828 __u32 cr_markerflags; /**< CL_MARK flags */
830 lustre_fid cr_pfid; /**< parent fid */
831 char cr_name[0]; /**< last element */
832 } __attribute__((packed));
834 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
835 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
838 struct changelog_ext_rec {
840 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
842 __u32 cr_type; /**< \a changelog_rec_type */
843 __u64 cr_index; /**< changelog record number */
844 __u64 cr_prev; /**< last index for this target fid */
847 lustre_fid cr_tfid; /**< target fid */
848 __u32 cr_markerflags; /**< CL_MARK flags */
850 lustre_fid cr_pfid; /**< target parent fid */
851 lustre_fid cr_sfid; /**< source fid, or zero */
852 lustre_fid cr_spfid; /**< source parent fid, or zero */
853 char cr_name[0]; /**< last element */
854 } __attribute__((packed));
856 #define CHANGELOG_REC_EXTENDED(rec) \
857 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
859 static inline int changelog_rec_size(struct changelog_rec *rec)
861 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
865 static inline char *changelog_rec_name(struct changelog_rec *rec)
867 return CHANGELOG_REC_EXTENDED(rec) ?
868 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
871 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
873 return rec->cr_namelen - strlen(rec->cr_name) - 1;
876 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
878 return rec->cr_name + strlen(rec->cr_name) + 1;
881 struct ioc_changelog {
888 enum changelog_message_type {
889 CL_RECORD = 10, /* message is a changelog_rec */
890 CL_EOF = 11, /* at end of current changelog */
893 /********* Misc **********/
895 struct ioc_data_version {
897 __u64 idv_flags; /* See LL_DV_xxx */
899 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
900 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
903 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
906 #define dot_lustre_name ".lustre"
909 /********* HSM **********/
911 /** HSM per-file state
912 * See HSM_FLAGS below.
915 HS_EXISTS = 0x00000001,
916 HS_DIRTY = 0x00000002,
917 HS_RELEASED = 0x00000004,
918 HS_ARCHIVED = 0x00000008,
919 HS_NORELEASE = 0x00000010,
920 HS_NOARCHIVE = 0x00000020,
921 HS_LOST = 0x00000040,
924 /* HSM user-setable flags. */
925 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
927 /* Other HSM flags. */
928 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
931 * All HSM-related possible flags that could be applied to a file.
932 * This should be kept in sync with hsm_states.
934 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
937 * HSMÂ request progress state
939 enum hsm_progress_states {
946 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
949 case HPS_WAITING: return "waiting";
950 case HPS_RUNNING: return "running";
951 case HPS_DONE: return "done";
952 default: return "unknown";
959 } __attribute__((packed));
962 * Current HSM states of a Lustre file.
964 * This structure purpose is to be sent to user-space mainly. It describes the
965 * current HSM flags and in-progress action.
967 struct hsm_user_state {
968 /** Current HSM states, from enum hsm_states. */
970 __u32 hus_archive_id;
971 /** The current undergoing action, if there is one */
972 __u32 hus_in_progress_state;
973 __u32 hus_in_progress_action;
974 struct hsm_extent hus_in_progress_location;
975 char hus_extended_info[];
978 struct hsm_state_set_ioc {
979 struct lu_fid hssi_fid;
981 __u64 hssi_clearmask;
985 * This structure describes the current in-progress action for a file.
986 * it is retuned to user space and send over the wire
988 struct hsm_current_action {
989 /** The current undergoing action, if there is one */
990 /* state is one of hsm_progress_states */
992 /* action is one of hsm_user_action */
994 struct hsm_extent hca_location;
997 /***** HSM user requests ******/
998 /* User-generated (lfs/ioctl) request types */
999 enum hsm_user_action {
1000 HUA_NONE = 1, /* no action (noop) */
1001 HUA_ARCHIVE = 10, /* copy to hsm */
1002 HUA_RESTORE = 11, /* prestage */
1003 HUA_RELEASE = 12, /* drop ost objects */
1004 HUA_REMOVE = 13, /* remove from archive */
1005 HUA_CANCEL = 14 /* cancel a request */
1008 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1011 case HUA_NONE: return "NOOP";
1012 case HUA_ARCHIVE: return "ARCHIVE";
1013 case HUA_RESTORE: return "RESTORE";
1014 case HUA_RELEASE: return "RELEASE";
1015 case HUA_REMOVE: return "REMOVE";
1016 case HUA_CANCEL: return "CANCEL";
1017 default: return "UNKNOWN";
1022 * List of hr_flags (bit field)
1024 #define HSM_FORCE_ACTION 0x0001
1025 /* used by CT, connot be set by user */
1026 #define HSM_GHOST_COPY 0x0002
1029 * Contains all the fixed part of struct hsm_user_request.
1032 struct hsm_request {
1033 __u32 hr_action; /* enum hsm_user_action */
1034 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1035 __u64 hr_flags; /* request flags */
1036 __u32 hr_itemcount; /* item count in hur_user_item vector */
1040 struct hsm_user_item {
1042 struct hsm_extent hui_extent;
1043 } __attribute__((packed));
1045 struct hsm_user_request {
1046 struct hsm_request hur_request;
1047 struct hsm_user_item hur_user_item[0];
1048 /* extra data blob at end of struct (after all
1049 * hur_user_items), only use helpers to access it
1051 } __attribute__((packed));
1053 /** Return pointer to data field in a hsm user request */
1054 static inline void *hur_data(struct hsm_user_request *hur)
1056 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1060 * Compute the current length of the provided hsm_user_request. This returns -1
1061 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1063 * return -1 on bounds check error.
1065 static inline ssize_t hur_len(struct hsm_user_request *hur)
1069 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1070 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1071 (__u64)hur->hur_request.hr_itemcount *
1072 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1074 if (size != (ssize_t)size)
1080 /****** HSM RPCs to copytool *****/
1081 /* Message types the copytool may receive */
1082 enum hsm_message_type {
1083 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1086 /* Actions the copytool may be instructed to take for a given action_item */
1087 enum hsm_copytool_action {
1088 HSMA_NONE = 10, /* no action */
1089 HSMA_ARCHIVE = 20, /* arbitrary offset */
1095 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1098 case HSMA_NONE: return "NOOP";
1099 case HSMA_ARCHIVE: return "ARCHIVE";
1100 case HSMA_RESTORE: return "RESTORE";
1101 case HSMA_REMOVE: return "REMOVE";
1102 case HSMA_CANCEL: return "CANCEL";
1103 default: return "UNKNOWN";
1107 /* Copytool item action description */
1108 struct hsm_action_item {
1109 __u32 hai_len; /* valid size of this struct */
1110 __u32 hai_action; /* hsm_copytool_action, but use known size */
1111 lustre_fid hai_fid; /* Lustre FID to operated on */
1112 lustre_fid hai_dfid; /* fid used for data access */
1113 struct hsm_extent hai_extent; /* byte range to operate on */
1114 __u64 hai_cookie; /* action cookie from coordinator */
1115 __u64 hai_gid; /* grouplock id */
1116 char hai_data[0]; /* variable length */
1117 } __attribute__((packed));
1120 * helper function which print in hexa the first bytes of
1122 * \param hai [IN] record to print
1123 * \param buffer [OUT] output buffer
1124 * \param len [IN] max buffer len
1127 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1128 char *buffer, int len)
1130 int i, sz, data_len;
1135 data_len = hai->hai_len - sizeof(*hai);
1136 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1140 cnt = snprintf(ptr, sz, "%.2X",
1141 (unsigned char)hai->hai_data[i]);
1149 /* Copytool action list */
1150 #define HAL_VERSION 1
1151 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1152 struct hsm_action_list {
1154 __u32 hal_count; /* number of hai's to follow */
1155 __u64 hal_compound_id; /* returned by coordinator */
1157 __u32 hal_archive_id; /* which archive backend */
1159 char hal_fsname[0]; /* null-terminated */
1160 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1161 boundaries. See hai_zero */
1162 } __attribute__((packed));
1164 #ifndef HAVE_CFS_SIZE_ROUND
1165 static inline int cfs_size_round (int val)
1167 return (val + 7) & (~0x7);
1169 #define HAVE_CFS_SIZE_ROUND
1172 /* Return pointer to first hai in action list */
1173 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1175 return (struct hsm_action_item *)(hal->hal_fsname +
1176 cfs_size_round(strlen(hal-> \
1180 /* Return pointer to next hai */
1181 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1183 return (struct hsm_action_item *)((char *)hai +
1184 cfs_size_round(hai->hai_len));
1187 /* Return size of an hsm_action_list */
1188 static inline size_t hal_size(struct hsm_action_list *hal)
1192 struct hsm_action_item *hai;
1194 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1195 hai = hai_first(hal);
1196 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1197 sz += cfs_size_round(hai->hai_len);
1203 * describe the attributes to be set on imported file
1205 struct hsm_user_import {
1214 __u32 hui_archive_id;
1217 /* Copytool progress reporting */
1218 #define HP_FLAG_COMPLETED 0x01
1219 #define HP_FLAG_RETRY 0x02
1221 struct hsm_progress {
1224 struct hsm_extent hp_extent;
1226 __u16 hp_errval; /* positive val */
1231 __u64 hc_data_version;
1233 __u16 hc_errval; /* positive val */
1235 struct hsm_action_item hc_hai;
1239 enum llapi_json_types {
1240 LLAPI_JSON_INTEGER = 1,
1246 struct llapi_json_item {
1255 struct llapi_json_item *lji_next;
1258 struct llapi_json_item_list {
1259 int ljil_item_count;
1260 struct llapi_json_item *ljil_items;
1263 /** @} lustreuser */
1265 #endif /* _LUSTRE_USER_H */