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, 2012, 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 <lustre/ll_fiemap.h>
50 #include <linux/lustre_user.h>
53 #define LL_SUPER_MAGIC 0x0BD00BD0
55 #ifndef FSFILT_IOC_GETFLAGS
56 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
57 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
58 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
59 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
60 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
61 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
62 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
65 /* FIEMAP flags supported by Lustre */
66 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
68 enum obd_statfs_state {
69 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
70 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
71 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
72 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
73 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
87 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
88 __u32 os_fprecreated; /* objs available now to the caller */
89 /* used in QoS code to find preferred
104 * FID is a cluster-wide unique identifier of a file or an object (stripe).
105 * FIDs are never reused.
109 * FID sequence. Sequence is a unit of migration: all files (objects)
110 * with FIDs from a given sequence are stored on the same server.
111 * Lustre should support 2^64 objects, so even if each sequence
112 * has only a single object we can still enumerate 2^64 objects.
115 /* FID number within sequence. */
118 * FID version, used to distinguish different versions (in the sense
119 * of snapshots, etc.) of the same file system object. Not currently
126 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
129 /* keep this one for compatibility */
130 struct filter_fid_old {
131 struct lu_fid ff_parent;
136 /* Userspace should treat lu_fid as opaque, and only use the following methods
137 * to print or parse them. Other functions (e.g. compare, swab) could be moved
138 * here from lustre_idl.h if needed. */
139 typedef struct lu_fid lustre_fid;
142 * Following struct for object attributes, that will be kept inode's EA.
143 * Introduced in 2.0 release (please see b15993, for details)
144 * Added to all objects since Lustre 2.4 as contains self FID
146 struct lustre_mdt_attrs {
148 * Bitfield for supported data in this structure. From enum lma_compat.
149 * lma_self_fid and lma_flags are always available.
153 * Per-file incompat feature list. Lustre version should support all
154 * flags set in this field. The supported feature mask is available in
158 /** FID of this inode */
159 struct lu_fid lma_self_fid;
163 * Prior to 2.4, the LMA structure also included SOM attributes which has since
164 * been moved to a dedicated xattr
165 * lma_flags was also removed because of lma_compat/incompat fields.
167 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
170 * OST object IDentifier.
178 struct lu_fid oi_fid;
182 #define DOSTID LPX64":"LPU64
183 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
186 * The ioctl naming rules:
187 * LL_* - works on the currently opened filehandle instead of parent dir
188 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
189 * *_MDC_* - gets/sets data related to MDC
190 * *_LOV_* - gets/sets data related to OSC/LOV
191 * *FILE* - called on parent dir and passes in a filename
192 * *STRIPE* - set/get lov_user_md
193 * *INFO - set/get lov_user_mds_data
195 /* see <lustre_lib.h> for ioctl numberss 101-150 */
196 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
197 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
198 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
199 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
200 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
201 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
202 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
203 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
204 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
205 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
206 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
207 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
208 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
209 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
210 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
211 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
212 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
213 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
214 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
215 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
216 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
217 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
218 #define LL_IOC_RMTACL _IOW ('f', 167, long)
219 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
220 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
221 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
222 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
223 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
224 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
225 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
226 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
228 /* see <lustre_lib.h> for ioctl numbers 177-210 */
230 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
231 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
232 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
233 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
234 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
235 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
236 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
237 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
238 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
239 struct lustre_swap_layouts)
240 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
241 struct hsm_current_action)
242 /* see <lustre_lib.h> for ioctl numbers 221-232 */
244 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
245 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
246 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
248 #define LL_STATFS_LMV 1
249 #define LL_STATFS_LOV 2
250 #define LL_STATFS_NODELAY 4
252 #define IOC_MDC_TYPE 'i'
253 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
254 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
255 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
256 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
258 /* Keep these for backward compartability. */
259 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
260 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
263 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
265 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
266 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
267 * which was added since kernel 2.6.36, so we redefine it as 020000000.
268 * To be compatible with old version's statically linked binary, finally we
269 * define it as (020000000 | 0100000000).
271 #define O_LOV_DELAY_CREATE 0120000000
273 #define LL_FILE_IGNORE_LOCK 0x00000001
274 #define LL_FILE_GROUP_LOCKED 0x00000002
275 #define LL_FILE_READAHEA 0x00000004
276 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
277 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
278 #define LL_FILE_RMTACL 0x00000020
280 #define LOV_USER_MAGIC_V1 0x0BD10BD0
281 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
282 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
283 #define LOV_USER_MAGIC_V3 0x0BD30BD0
285 #define LMV_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */
286 #define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/
288 #define LOV_PATTERN_RAID0 0x001
289 #define LOV_PATTERN_RAID1 0x002
290 #define LOV_PATTERN_FIRST 0x100
292 #define LOV_MAXPOOLNAME 16
293 #define LOV_POOLNAMEF "%.16s"
295 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
296 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
297 #define LOV_MAX_STRIPE_COUNT_OLD 160
298 /* This calculation is crafted so that input of 4096 will result in 160
299 * which in turn is equal to old maximal stripe count.
300 * XXX: In fact this is too simpified for now, what it also need is to get
301 * ea_type argument to clearly know how much space each stripe consumes.
303 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
304 * allocation that is sufficient for the current generation of systems.
306 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
307 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
308 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
309 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
311 #define lov_user_ost_data lov_user_ost_data_v1
312 struct lov_user_ost_data_v1 { /* per-stripe data structure */
313 struct ost_id l_ost_oi; /* OST object ID */
314 __u32 l_ost_gen; /* generation of this OST index */
315 __u32 l_ost_idx; /* OST index in LOV */
316 } __attribute__((packed));
318 #define lov_user_md lov_user_md_v1
319 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
320 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
321 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
322 struct ost_id lmm_oi; /* LOV object ID */
323 __u32 lmm_stripe_size; /* size of stripe in bytes */
324 __u16 lmm_stripe_count; /* num stripes in use for this object */
326 __u16 lmm_stripe_offset; /* starting stripe offset in
327 * lmm_objects, use when writing */
328 __u16 lmm_layout_gen; /* layout generation number
329 * used when reading */
331 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
332 } __attribute__((packed, __may_alias__));
334 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
335 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
336 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
337 struct ost_id lmm_oi; /* LOV object ID */
338 __u32 lmm_stripe_size; /* size of stripe in bytes */
339 __u16 lmm_stripe_count; /* num stripes in use for this object */
341 __u16 lmm_stripe_offset; /* starting stripe offset in
342 * lmm_objects, use when writing */
343 __u16 lmm_layout_gen; /* layout generation number
344 * used when reading */
346 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
347 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
348 } __attribute__((packed));
350 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
351 * use this. It is unsafe to #define those values in this header as it
352 * is possible the application has already #included <sys/stat.h>. */
353 #ifdef HAVE_LOV_USER_MDS_DATA
354 #define lov_user_mds_data lov_user_mds_data_v1
355 struct lov_user_mds_data_v1 {
356 lstat_t lmd_st; /* MDS stat struct */
357 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
358 } __attribute__((packed));
360 struct lov_user_mds_data_v3 {
361 lstat_t lmd_st; /* MDS stat struct */
362 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
363 } __attribute__((packed));
366 /* keep this to be the same size as lov_user_ost_data_v1 */
367 struct lmv_user_mds_data {
368 struct lu_fid lum_fid;
376 LMV_DEFAULT_TYPE = 1,
379 #define lmv_user_md lmv_user_md_v1
380 struct lmv_user_md_v1 {
381 __u32 lum_magic; /* must be the first field */
382 __u32 lum_stripe_count; /* dirstripe count */
383 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
384 __u32 lum_hash_type; /* Dir stripe policy */
385 __u32 lum_type; /* LMV type: default or normal */
389 char lum_pool_name[LOV_MAXPOOLNAME];
390 struct lmv_user_mds_data lum_objects[0];
393 static inline int lmv_user_md_size(int stripes, int lmm_magic)
395 return sizeof(struct lmv_user_md) +
396 stripes * sizeof(struct lmv_user_mds_data);
399 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
401 struct ll_recreate_obj {
407 __u64 id; /* holds object id */
408 __u32 generation; /* holds object generation */
409 __u32 f_type; /* holds object type or stripe idx when passing it to
410 * OST for saving into EA. */
418 static inline int obd_uuid_equals(const struct obd_uuid *u1,
419 const struct obd_uuid *u2)
421 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
424 static inline int obd_uuid_empty(struct obd_uuid *uuid)
426 return uuid->uuid[0] == '\0';
429 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
431 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
432 uuid->uuid[sizeof(*uuid) - 1] = '\0';
435 /* For printf's only, make sure uuid is terminated */
436 static inline char *obd_uuid2str(struct obd_uuid *uuid)
438 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
439 /* Obviously not safe, but for printfs, no real harm done...
440 we're always null-terminated, even in a race. */
441 static char temp[sizeof(*uuid)];
442 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
443 temp[sizeof(*uuid) - 1] = '\0';
446 return (char *)(uuid->uuid);
449 /* Extract fsname from uuid (or target name) of a target
450 e.g. (myfs-OST0007_UUID -> myfs)
451 see also deuuidify. */
452 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
456 strncpy(buf, uuid, buflen - 1);
457 buf[buflen - 1] = '\0';
458 p = strrchr(buf, '-');
463 /* printf display format
464 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
465 #define DFID_NOBRACE LPX64":0x%x:0x%x"
466 #define DFID "["DFID_NOBRACE"]"
472 /* scanf input parse format -- strip '[' first.
473 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
474 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
475 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
476 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
478 #define SFID "0x"LPX64i":0x%x:0x%x"
485 /********* Quotas **********/
487 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
488 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
489 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
490 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
491 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
492 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
493 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
494 /* lustre-specific control commands */
495 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
496 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
498 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
500 struct if_quotacheck {
502 struct obd_uuid obd_uuid;
505 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
508 #define N_PERMS_MAX 64
510 struct perm_downcall_data {
516 struct identity_downcall_data {
523 struct perm_downcall_data idd_perms[N_PERMS_MAX];
527 /* for non-mapped uid/gid */
528 #define NOBODY_UID 99
529 #define NOBODY_GID 99
531 #define INVALID_ID (-1)
540 #ifdef NEED_QUOTA_DEFS
542 #define QIF_BLIMITS 1
544 #define QIF_ILIMITS 4
548 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
549 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
550 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
551 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
554 #endif /* !__KERNEL__ */
556 /* lustre volatile file support
557 * file name header: .^L^S^T^R:volatile"
559 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
560 #define LUSTRE_VOLATILE_HDR_LEN 14
561 /* hdr + MDT index */
562 #define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:"
564 typedef enum lustre_quota_version {
566 } lustre_quota_version_t;
568 /* XXX: same as if_dqinfo struct in kernel */
576 /* XXX: same as if_dqblk struct in kernel, plus one padding */
578 __u64 dqb_bhardlimit;
579 __u64 dqb_bsoftlimit;
581 __u64 dqb_ihardlimit;
582 __u64 dqb_isoftlimit;
604 struct obd_dqinfo qc_dqinfo;
605 struct obd_dqblk qc_dqblk;
607 struct obd_uuid obd_uuid;
610 /* swap layout flags */
611 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
612 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
613 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
614 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
615 struct lustre_swap_layouts {
624 /********* Changelogs **********/
625 /** Changelog record types */
626 enum changelog_rec_type {
628 CL_CREATE = 1, /* namespace */
629 CL_MKDIR = 2, /* namespace */
630 CL_HARDLINK = 3, /* namespace */
631 CL_SOFTLINK = 4, /* namespace */
632 CL_MKNOD = 5, /* namespace */
633 CL_UNLINK = 6, /* namespace */
634 CL_RMDIR = 7, /* namespace */
635 CL_RENAME = 8, /* namespace */
636 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
637 CL_OPEN = 10, /* not currently used */
638 CL_CLOSE = 11, /* may be written to log only with mtime change */
643 CL_HSM = 16, /* HSM specific events, see flags */
644 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
651 static inline const char *changelog_type2str(int type) {
652 static const char *changelog_str[] = {
653 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
654 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
655 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "LAYOUT"
658 if (type >= 0 && type < CL_LAST)
659 return changelog_str[type];
663 /* per-record flags */
664 #define CLF_VERSION 0x1000
665 #define CLF_EXT_VERSION 0x2000
666 #define CLF_FLAGSHIFT 12
667 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
668 #define CLF_VERMASK (~CLF_FLAGMASK)
669 /* Anything under the flagmask may be per-type (if desired) */
670 /* Flags for unlink */
671 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
672 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
673 /* HSM cleaning needed */
674 /* Flags for rename */
675 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */
678 /* 12b used (from high weight to low weight):
683 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
684 #define CLF_HSM_ERR_H 6
685 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
686 #define CLF_HSM_EVENT_H 9
687 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
688 #define CLF_HSM_FLAG_H 11
689 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
690 #define CLF_HSM_SPARE_H 15
691 #define CLF_HSM_LAST 15
693 /* Remove bits higher than _h, then extract the value
694 * between _h and _l by shifting lower weigth to bit 0. */
695 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
696 >> (CLF_HSM_LAST - _h + _l))
698 #define CLF_HSM_SUCCESS 0x00
699 #define CLF_HSM_MAXERROR 0x7E
700 #define CLF_HSM_ERROVERFLOW 0x7F
702 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
704 /* 3 bits field => 8 values allowed */
716 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
718 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
721 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
723 *flags |= (he << CLF_HSM_EVENT_L);
726 static inline __u16 hsm_get_cl_flags(int flags)
728 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
731 static inline void hsm_set_cl_flags(int *flags, int bits)
733 *flags |= (bits << CLF_HSM_FLAG_L);
736 static inline int hsm_get_cl_error(int flags)
738 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
741 static inline void hsm_set_cl_error(int *flags, int error)
743 *flags |= (error << CLF_HSM_ERR_L);
746 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
748 struct changelog_rec {
750 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
751 __u32 cr_type; /**< \a changelog_rec_type */
752 __u64 cr_index; /**< changelog record number */
753 __u64 cr_prev; /**< last index for this target fid */
756 lustre_fid cr_tfid; /**< target fid */
757 __u32 cr_markerflags; /**< CL_MARK flags */
759 lustre_fid cr_pfid; /**< parent fid */
760 char cr_name[0]; /**< last element */
761 } __attribute__((packed));
763 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
764 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
767 struct changelog_ext_rec {
769 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
771 __u32 cr_type; /**< \a changelog_rec_type */
772 __u64 cr_index; /**< changelog record number */
773 __u64 cr_prev; /**< last index for this target fid */
776 lustre_fid cr_tfid; /**< target fid */
777 __u32 cr_markerflags; /**< CL_MARK flags */
779 lustre_fid cr_pfid; /**< target parent fid */
780 lustre_fid cr_sfid; /**< source fid, or zero */
781 lustre_fid cr_spfid; /**< source parent fid, or zero */
782 char cr_name[0]; /**< last element */
783 } __attribute__((packed));
785 #define CHANGELOG_REC_EXTENDED(rec) \
786 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
788 static inline int changelog_rec_size(struct changelog_rec *rec)
790 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
794 static inline char *changelog_rec_name(struct changelog_rec *rec)
796 return CHANGELOG_REC_EXTENDED(rec) ?
797 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
800 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
802 return rec->cr_namelen - strlen(rec->cr_name) - 1;
805 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
807 return rec->cr_name + strlen(rec->cr_name) + 1;
810 struct ioc_changelog {
817 enum changelog_message_type {
818 CL_RECORD = 10, /* message is a changelog_rec */
819 CL_EOF = 11, /* at end of current changelog */
822 /********* Misc **********/
824 struct ioc_data_version {
826 __u64 idv_flags; /* See LL_DV_xxx */
828 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
829 version. Dirty caches are left unchanged. */
832 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
835 #define dot_lustre_name ".lustre"
838 /********* HSM **********/
840 /** HSM per-file state
841 * See HSM_FLAGS below.
844 HS_EXISTS = 0x00000001,
845 HS_DIRTY = 0x00000002,
846 HS_RELEASED = 0x00000004,
847 HS_ARCHIVED = 0x00000008,
848 HS_NORELEASE = 0x00000010,
849 HS_NOARCHIVE = 0x00000020,
850 HS_LOST = 0x00000040,
853 /* HSM user-setable flags. */
854 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
856 /* Other HSM flags. */
857 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
860 * All HSM-related possible flags that could be applied to a file.
861 * This should be kept in sync with hsm_states.
863 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
866 * HSMÂ request progress state
868 enum hsm_progress_states {
875 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
878 case HPS_WAITING: return "waiting";
879 case HPS_RUNNING: return "running";
880 case HPS_DONE: return "done";
881 default: return "unknown";
888 } __attribute__((packed));
891 * Current HSM states of a Lustre file.
893 * This structure purpose is to be sent to user-space mainly. It describes the
894 * current HSM flags and in-progress action.
896 struct hsm_user_state {
897 /** Current HSM states, from enum hsm_states. */
899 __u32 hus_archive_id;
900 /** The current undergoing action, if there is one */
901 __u32 hus_in_progress_state;
902 __u32 hus_in_progress_action;
903 struct hsm_extent hus_in_progress_location;
904 char hus_extended_info[];
907 struct hsm_state_set_ioc {
908 struct lu_fid hssi_fid;
910 __u64 hssi_clearmask;
914 * This structure describes the current in-progress action for a file.
915 * it is retuned to user space and send over the wire
917 struct hsm_current_action {
918 /** The current undergoing action, if there is one */
919 /* state is one of hsm_progress_states */
921 /* action is one of hsm_user_action */
923 struct hsm_extent hca_location;
926 /***** HSM user requests ******/
927 /* User-generated (lfs/ioctl) request types */
928 enum hsm_user_action {
929 HUA_NONE = 1, /* no action (noop) */
930 HUA_ARCHIVE = 10, /* copy to hsm */
931 HUA_RESTORE = 11, /* prestage */
932 HUA_RELEASE = 12, /* drop ost objects */
933 HUA_REMOVE = 13, /* remove from archive */
934 HUA_CANCEL = 14 /* cancel a request */
937 static inline char *hsm_user_action2name(enum hsm_user_action a)
940 case HUA_NONE: return "NOOP";
941 case HUA_ARCHIVE: return "ARCHIVE";
942 case HUA_RESTORE: return "RESTORE";
943 case HUA_RELEASE: return "RELEASE";
944 case HUA_REMOVE: return "REMOVE";
945 case HUA_CANCEL: return "CANCEL";
946 default: return "UNKNOWN";
951 * List of hr_flags (bit field)
953 #define HSM_FORCE_ACTION 0x0001
954 /* used by CT, connot be set by user */
955 #define HSM_GHOST_COPY 0x0002
958 * Contains all the fixed part of struct hsm_user_request.
962 __u32 hr_action; /* enum hsm_user_action */
963 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
964 __u64 hr_flags; /* request flags */
965 __u32 hr_itemcount; /* item count in hur_user_item vector */
969 struct hsm_user_item {
971 struct hsm_extent hui_extent;
972 } __attribute__((packed));
974 struct hsm_user_request {
975 struct hsm_request hur_request;
976 struct hsm_user_item hur_user_item[0];
977 /* extra data blob at end of struct (after all
978 * hur_user_items), only use helpers to access it
980 } __attribute__((packed));
982 /** Return pointer to data field in a hsm user request */
983 static inline void *hur_data(struct hsm_user_request *hur)
985 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
988 /** Compute the current length of the provided hsm_user_request. */
989 static inline int hur_len(struct hsm_user_request *hur)
991 return offsetof(struct hsm_user_request,
992 hur_user_item[hur->hur_request.hr_itemcount]) +
993 hur->hur_request.hr_data_len;
996 /****** HSM RPCs to copytool *****/
997 /* Message types the copytool may receive */
998 enum hsm_message_type {
999 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1002 /* Actions the copytool may be instructed to take for a given action_item */
1003 enum hsm_copytool_action {
1004 HSMA_NONE = 10, /* no action */
1005 HSMA_ARCHIVE = 20, /* arbitrary offset */
1011 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
1014 case HSMA_NONE: return "NOOP";
1015 case HSMA_ARCHIVE: return "ARCHIVE";
1016 case HSMA_RESTORE: return "RESTORE";
1017 case HSMA_REMOVE: return "REMOVE";
1018 case HSMA_CANCEL: return "CANCEL";
1019 default: return "UNKNOWN";
1023 /* Copytool item action description */
1024 struct hsm_action_item {
1025 __u32 hai_len; /* valid size of this struct */
1026 __u32 hai_action; /* hsm_copytool_action, but use known size */
1027 lustre_fid hai_fid; /* Lustre FID to operated on */
1028 lustre_fid hai_dfid; /* fid used for data access */
1029 struct hsm_extent hai_extent; /* byte range to operate on */
1030 __u64 hai_cookie; /* action cookie from coordinator */
1031 __u64 hai_gid; /* grouplock id */
1032 char hai_data[0]; /* variable length */
1033 } __attribute__((packed));
1036 * helper function which print in hexa the first bytes of
1038 * \param hai [IN] record to print
1039 * \param buffer [OUT] output buffer
1040 * \param len [IN] max buffer len
1043 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
1044 char *buffer, int len)
1046 int i, sz, data_len;
1051 data_len = hai->hai_len - sizeof(*hai);
1052 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1056 cnt = snprintf(ptr, sz, "%.2X",
1057 (unsigned char)hai->hai_data[i]);
1065 /* Copytool action list */
1066 #define HAL_VERSION 1
1067 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1068 struct hsm_action_list {
1070 __u32 hal_count; /* number of hai's to follow */
1071 __u64 hal_compound_id; /* returned by coordinator */
1073 __u32 hal_archive_id; /* which archive backend */
1075 char hal_fsname[0]; /* null-terminated */
1076 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1077 boundaries. See hai_zero */
1078 } __attribute__((packed));
1080 #ifndef HAVE_CFS_SIZE_ROUND
1081 static inline int cfs_size_round (int val)
1083 return (val + 7) & (~0x7);
1085 #define HAVE_CFS_SIZE_ROUND
1088 /* Return pointer to first hai in action list */
1089 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
1091 return (struct hsm_action_item *)(hal->hal_fsname +
1092 cfs_size_round(strlen(hal-> \
1095 /* Return pointer to next hai */
1096 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1098 return (struct hsm_action_item *)((char *)hai +
1099 cfs_size_round(hai->hai_len));
1102 /* Return size of an hsm_action_list */
1103 static inline int hal_size(struct hsm_action_list *hal)
1106 struct hsm_action_item *hai;
1108 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1109 hai = hai_zero(hal);
1110 for (i = 0 ; i < hal->hal_count ; i++) {
1111 sz += cfs_size_round(hai->hai_len);
1112 hai = hai_next(hai);
1117 /* Copytool progress reporting */
1118 #define HP_FLAG_COMPLETED 0x01
1119 #define HP_FLAG_RETRY 0x02
1121 struct hsm_progress {
1124 struct hsm_extent hp_extent;
1126 __u16 hp_errval; /* positive val */
1131 * Use by copytool during any hsm request they handled.
1132 * This structure is initialized by llapi_hsm_copy_start()
1133 * which is an helper over the ioctl() interface
1134 * Store Lustre, internal use only, data.
1137 __u64 hc_data_version;
1139 __u16 hc_errval; /* positive val */
1141 struct hsm_action_item hc_hai;
1144 /** @} lustreuser */
1146 #endif /* _LUSTRE_USER_H */