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) 2011, 2012, Whamcloud, Inc.
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
50 #include <libcfs/posix/posix-types.h>
52 #include <lustre/ll_fiemap.h>
53 #if defined(__linux__)
54 #include <linux/lustre_user.h>
55 #elif defined(__APPLE__)
56 #include <darwin/lustre_user.h>
57 #elif defined(__WINNT__)
58 #include <winnt/lustre_user.h>
60 #error Unsupported operating system.
64 #define LL_SUPER_MAGIC 0x0BD00BD0
66 #ifndef FSFILT_IOC_GETFLAGS
67 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
68 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
69 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
70 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
71 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
72 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
73 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
76 /* FIEMAP flags supported by Lustre */
77 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
79 enum obd_statfs_state {
80 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
81 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
82 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
83 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
84 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
98 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
99 __u32 os_fprecreated; /* objs available now to the caller */
100 /* used in QoS code to find preferred
114 * The ioctl naming rules:
115 * LL_* - works on the currently opened filehandle instead of parent dir
116 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
117 * *_MDC_* - gets/sets data related to MDC
118 * *_LOV_* - gets/sets data related to OSC/LOV
119 * *FILE* - called on parent dir and passes in a filename
120 * *STRIPE* - set/get lov_user_md
121 * *INFO - set/get lov_user_mds_data
123 /* see <lustre_lib.h> for ioctl numberss 101-150 */
124 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
125 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
126 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
127 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
128 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
129 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
130 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
131 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
132 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
133 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
134 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
135 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
136 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
137 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
138 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
139 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
140 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
141 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
142 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
143 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
144 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
145 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
146 #define LL_IOC_RMTACL _IOW ('f', 167, long)
147 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
148 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
149 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
150 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
151 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
152 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
153 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
154 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
155 #define LL_IOC_HSM_CT_START _IOW ('f', 176,struct lustre_kernelcomm)
156 /* see <lustre_lib.h> for ioctl numbers 177-210 */
158 #define LL_IOC_DATA_VERSION _IOR ('f', 218, struct ioc_data_version)
160 #define LL_STATFS_LMV 1
161 #define LL_STATFS_LOV 2
162 #define LL_STATFS_NODELAY 4
164 #define IOC_MDC_TYPE 'i'
165 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
166 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
167 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
168 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
170 /* Keep these for backward compartability. */
171 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
172 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
175 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
177 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
178 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
179 * which was added since kernel 2.6.36, so we redefine it as 020000000.
180 * To be compatible with old version's statically linked binary, finally we
181 * define it as (020000000 | 0100000000).
183 #define O_LOV_DELAY_CREATE 0120000000
185 #define LL_FILE_IGNORE_LOCK 0x00000001
186 #define LL_FILE_GROUP_LOCKED 0x00000002
187 #define LL_FILE_READAHEA 0x00000004
188 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
189 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
190 #define LL_FILE_RMTACL 0x00000020
192 #define LOV_USER_MAGIC_V1 0x0BD10BD0
193 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
194 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
195 #define LOV_USER_MAGIC_V3 0x0BD30BD0
197 #define LOV_PATTERN_RAID0 0x001
198 #define LOV_PATTERN_RAID1 0x002
199 #define LOV_PATTERN_FIRST 0x100
201 #define LOV_MAXPOOLNAME 16
202 #define LOV_POOLNAMEF "%.16s"
204 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
205 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
206 #define LOV_MAX_STRIPE_COUNT_OLD 160
207 /* This calculation is crafted so that input of 4096 will result in 160
208 * which in turn is equal to old maximal stripe count.
209 * XXX: In fact this is too simpified for now, what it also need is to get
210 * ea_type argument to clearly know how much space each stripe consumes.
212 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
213 * allocation that is sufficient for the current generation of systems.
215 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
216 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
217 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
218 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
220 #define lov_user_ost_data lov_user_ost_data_v1
221 struct lov_user_ost_data_v1 { /* per-stripe data structure */
222 __u64 l_object_id; /* OST object ID */
223 __u64 l_object_seq; /* OST object seq number */
224 __u32 l_ost_gen; /* generation of this OST index */
225 __u32 l_ost_idx; /* OST index in LOV */
226 } __attribute__((packed));
228 #define lov_user_md lov_user_md_v1
229 #define lmm_stripe_offset u.lum_stripe_offset
230 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
231 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
232 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
233 __u64 lmm_object_id; /* LOV object ID */
234 __u64 lmm_object_seq; /* LOV object seq */
235 __u32 lmm_stripe_size; /* size of stripe in bytes */
236 __u16 lmm_stripe_count; /* num stripes in use for this object */
238 __u16 lum_stripe_offset; /* starting stripe offset in
239 * lmm_objects, use when writing */
240 __u16 lum_layout_gen; /* layout generation number
241 * used when reading */
243 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
244 } __attribute__((packed, __may_alias__));
246 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
247 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
248 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
249 __u64 lmm_object_id; /* LOV object ID */
250 __u64 lmm_object_seq; /* LOV object seq */
251 __u32 lmm_stripe_size; /* size of stripe in bytes */
252 __u16 lmm_stripe_count; /* num stripes in use for this object */
254 __u16 lum_stripe_offset; /* starting stripe offset in
255 * lmm_objects, use when writing */
256 __u16 lum_layout_gen; /* layout generation number
257 * used when reading */
259 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
260 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
261 } __attribute__((packed));
263 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
264 * use this. It is unsafe to #define those values in this header as it
265 * is possible the application has already #included <sys/stat.h>. */
266 #ifdef HAVE_LOV_USER_MDS_DATA
267 #define lov_user_mds_data lov_user_mds_data_v1
268 struct lov_user_mds_data_v1 {
269 lstat_t lmd_st; /* MDS stat struct */
270 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
271 } __attribute__((packed));
273 struct lov_user_mds_data_v3 {
274 lstat_t lmd_st; /* MDS stat struct */
275 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
276 } __attribute__((packed));
279 struct ll_recreate_obj {
285 __u64 id; /* holds object id */
286 __u32 generation; /* holds object generation */
287 __u32 f_type; /* holds object type or stripe idx when passing it to
288 * OST for saving into EA. */
296 static inline int obd_uuid_equals(const struct obd_uuid *u1,
297 const struct obd_uuid *u2)
299 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
302 static inline int obd_uuid_empty(struct obd_uuid *uuid)
304 return uuid->uuid[0] == '\0';
307 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
309 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
310 uuid->uuid[sizeof(*uuid) - 1] = '\0';
313 /* For printf's only, make sure uuid is terminated */
314 static inline char *obd_uuid2str(struct obd_uuid *uuid)
316 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
317 /* Obviously not safe, but for printfs, no real harm done...
318 we're always null-terminated, even in a race. */
319 static char temp[sizeof(*uuid)];
320 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
321 temp[sizeof(*uuid) - 1] = '\0';
324 return (char *)(uuid->uuid);
327 /* Extract fsname from uuid (or target name) of a target
328 e.g. (myfs-OST0007_UUID -> myfs)
329 see also deuuidify. */
330 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
334 strncpy(buf, uuid, buflen - 1);
335 buf[buflen - 1] = '\0';
336 p = strrchr(buf, '-');
344 * FID is a cluster-wide unique identifier of a file or an object (stripe).
345 * FIDs are never reused.
349 * FID sequence. Sequence is a unit of migration: all files (objects)
350 * with FIDs from a given sequence are stored on the same server.
351 * Lustre should support 2^64 objects, so even if each sequence
352 * has only a single object we can still enumerate 2^64 objects.
355 /** FID number within sequence. */
358 * FID version, used to distinguish different versions (in the sense
359 * of snapshots, etc.) of the same file system object. Not currently
366 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
371 /* Userspace should treat lu_fid as opaque, and only use the following methods
372 to print or parse them. Other functions (e.g. compare, swab) could be moved
373 here from lustre_idl.h if needed. */
374 typedef struct lu_fid lustre_fid;
376 /* printf display format
377 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
378 #define DFID_NOBRACE LPX64":0x%x:0x%x"
379 #define DFID "["DFID_NOBRACE"]"
385 /* scanf input parse format -- strip '[' first.
386 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
387 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
388 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
389 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
391 #define SFID "0x"LPX64i":0x%x:0x%x"
398 /********* Quotas **********/
400 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
401 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
402 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
403 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
404 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
405 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
406 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
407 /* lustre-specific control commands */
408 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
409 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
411 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
413 struct if_quotacheck {
415 struct obd_uuid obd_uuid;
418 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
421 #define N_PERMS_MAX 64
423 struct perm_downcall_data {
429 struct identity_downcall_data {
436 struct perm_downcall_data idd_perms[N_PERMS_MAX];
440 /* for non-mapped uid/gid */
441 #define NOBODY_UID 99
442 #define NOBODY_GID 99
444 #define INVALID_ID (-1)
453 #ifdef NEED_QUOTA_DEFS
455 #define QIF_BLIMITS 1
457 #define QIF_ILIMITS 4
461 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
462 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
463 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
464 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
467 #endif /* !__KERNEL__ */
469 typedef enum lustre_quota_version {
471 } lustre_quota_version_t;
473 /* XXX: same as if_dqinfo struct in kernel */
481 /* XXX: same as if_dqblk struct in kernel, plus one padding */
483 __u64 dqb_bhardlimit;
484 __u64 dqb_bsoftlimit;
486 __u64 dqb_ihardlimit;
487 __u64 dqb_isoftlimit;
509 struct obd_dqinfo qc_dqinfo;
510 struct obd_dqblk qc_dqblk;
512 struct obd_uuid obd_uuid;
516 /********* Changelogs **********/
517 /** Changelog record types */
518 enum changelog_rec_type {
520 CL_CREATE = 1, /* namespace */
521 CL_MKDIR = 2, /* namespace */
522 CL_HARDLINK = 3, /* namespace */
523 CL_SOFTLINK = 4, /* namespace */
524 CL_MKNOD = 5, /* namespace */
525 CL_UNLINK = 6, /* namespace */
526 CL_RMDIR = 7, /* namespace */
527 CL_RENAME = 8, /* namespace */
528 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
529 CL_OPEN = 10, /* not currently used */
530 CL_CLOSE = 11, /* may be written to log only with mtime change */
535 CL_HSM = 16, /* HSM specific events, see flags */
536 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
542 static inline const char *changelog_type2str(int type) {
543 static const char *changelog_str[] = {
544 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
545 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
546 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME" };
547 if (type >= 0 && type < CL_LAST)
548 return changelog_str[type];
552 /* per-record flags */
553 #define CLF_VERSION 0x1000
554 #define CLF_EXT_VERSION 0x2000
555 #define CLF_FLAGSHIFT 12
556 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
557 #define CLF_VERMASK (~CLF_FLAGMASK)
558 /* Anything under the flagmask may be per-type (if desired) */
559 /* Flags for unlink */
560 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
561 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
562 /* HSM cleaning needed */
563 /* Flags for rename */
564 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */
567 /* 12b used (from high weight to low weight):
572 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
573 #define CLF_HSM_ERR_H 6
574 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
575 #define CLF_HSM_EVENT_H 9
576 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
577 #define CLF_HSM_FLAG_H 11
578 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
579 #define CLF_HSM_SPARE_H 15
580 #define CLF_HSM_LAST 15
582 /* Remove bits higher than _h, then extract the value
583 * between _h and _l by shifting lower weigth to bit 0. */
584 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
585 >> (CLF_HSM_LAST - _h + _l))
587 #define CLF_HSM_SUCCESS 0x00
588 #define CLF_HSM_MAXERROR 0x7E
589 #define CLF_HSM_ERROVERFLOW 0x7F
591 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
593 /* 3 bits field => 8 values allowed */
605 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
607 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
610 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
612 *flags |= (he << CLF_HSM_EVENT_L);
615 static inline __u16 hsm_get_cl_flags(int flags)
617 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
620 static inline void hsm_set_cl_flags(int *flags, int bits)
622 *flags |= (bits << CLF_HSM_FLAG_L);
625 static inline int hsm_get_cl_error(int flags)
627 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
630 static inline void hsm_set_cl_error(int *flags, int error)
632 *flags |= (error << CLF_HSM_ERR_L);
635 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
637 struct changelog_rec {
639 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
640 __u32 cr_type; /**< \a changelog_rec_type */
641 __u64 cr_index; /**< changelog record number */
642 __u64 cr_prev; /**< last index for this target fid */
645 lustre_fid cr_tfid; /**< target fid */
646 __u32 cr_markerflags; /**< CL_MARK flags */
648 lustre_fid cr_pfid; /**< parent fid */
649 char cr_name[0]; /**< last element */
650 } __attribute__((packed));
652 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
653 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
656 struct changelog_ext_rec {
658 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
660 __u32 cr_type; /**< \a changelog_rec_type */
661 __u64 cr_index; /**< changelog record number */
662 __u64 cr_prev; /**< last index for this target fid */
665 lustre_fid cr_tfid; /**< target fid */
666 __u32 cr_markerflags; /**< CL_MARK flags */
668 lustre_fid cr_pfid; /**< target parent fid */
669 lustre_fid cr_sfid; /**< source fid, or zero */
670 lustre_fid cr_spfid; /**< source parent fid, or zero */
671 char cr_name[0]; /**< last element */
672 } __attribute__((packed));
674 #define CHANGELOG_REC_EXTENDED(rec) \
675 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
677 static inline int changelog_rec_size(struct changelog_rec *rec)
679 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
683 static inline char *changelog_rec_name(struct changelog_rec *rec)
685 return CHANGELOG_REC_EXTENDED(rec) ?
686 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
689 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
691 return rec->cr_namelen - strlen(rec->cr_name) - 1;
694 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
696 return rec->cr_name + strlen(rec->cr_name) + 1;
699 struct ioc_changelog {
706 enum changelog_message_type {
707 CL_RECORD = 10, /* message is a changelog_rec */
708 CL_EOF = 11, /* at end of current changelog */
711 /********* Misc **********/
713 struct ioc_data_version {
715 __u64 idv_flags; /* See LL_DV_xxx */
717 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
718 version. Dirty caches are left unchanged. */
721 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
724 #define dot_lustre_name ".lustre"
727 /********* HSM **********/
729 /** HSM per-file state
730 * See HSM_FLAGS below.
733 HS_EXISTS = 0x00000001,
734 HS_DIRTY = 0x00000002,
735 HS_RELEASED = 0x00000004,
736 HS_ARCHIVED = 0x00000008,
737 HS_NORELEASE = 0x00000010,
738 HS_NOARCHIVE = 0x00000020,
739 HS_LOST = 0x00000040,
742 /* HSM user-setable flags. */
743 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
745 /* Other HSM flags. */
746 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
749 * All HSM-related possible flags that could be applied to a file.
750 * This should be kept in sync with hsm_states.
752 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
755 * HSMÂ request progress state
757 enum hsm_progress_states {
764 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
767 case HPS_WAITING: return "waiting";
768 case HPS_RUNNING: return "running";
769 case HPS_DONE: return "done";
770 default: return "unknown";
777 } __attribute__((packed));
780 * Current HSM states of a Lustre file.
782 * This structure purpose is to be sent to user-space mainly. It describes the
783 * current HSM flags and in-progress action.
785 struct hsm_user_state {
786 /** Current HSM states, from enum hsm_states. */
788 __u32 hus_archive_num;
789 /** The current undergoing action, if there is one */
790 __u32 hus_in_progress_state;
791 __u32 hus_in_progress_action;
792 struct hsm_extent hus_in_progress_location;
793 char hus_extended_info[];
796 struct hsm_state_set_ioc {
797 struct lu_fid hssi_fid;
799 __u64 hssi_clearmask;
802 /***** HSM user requests ******/
803 /* User-generated (lfs/ioctl) request types */
804 enum hsm_user_action {
805 HUA_NONE = 1, /* no action (noop) */
806 HUA_ARCHIVE = 10, /* copy to hsm */
807 HUA_RESTORE = 11, /* prestage */
808 HUA_RELEASE = 12, /* drop ost objects */
809 HUA_REMOVE = 13, /* remove from archive */
810 HUA_CANCEL = 14 /* cancel a request */
813 static inline char *hsm_user_action2name(enum hsm_user_action a)
816 case HUA_NONE: return "NOOP";
817 case HUA_ARCHIVE: return "ARCHIVE";
818 case HUA_RESTORE: return "RESTORE";
819 case HUA_RELEASE: return "RELEASE";
820 case HUA_REMOVE: return "REMOVE";
821 case HUA_CANCEL: return "CANCEL";
822 default: return "UNKNOWN";
826 struct hsm_user_item {
828 struct hsm_extent hui_extent;
829 } __attribute__((packed));
831 struct hsm_user_request {
832 __u32 hur_action; /* enum hsm_user_action */
833 __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
836 struct hsm_user_item hur_user_item[0];
837 /* extra data blob at end of struct (after all
838 * hur_user_items), only use helpers to access it
840 } __attribute__((packed));
842 /** Return pointer to data field in a hsm user request */
843 static inline void *hur_data(struct hsm_user_request *hur)
845 return &(hur->hur_user_item[hur->hur_itemcount]);
848 /** Compute the current length of the provided hsm_user_request. */
849 static inline int hur_len(struct hsm_user_request *hur)
853 data_offset = hur_data(hur) - (void *)hur;
854 return (data_offset + hur->hur_data_len);
857 /****** HSM RPCs to copytool *****/
858 /* Message types the copytool may receive */
859 enum hsm_message_type {
860 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
863 /* Actions the copytool may be instructed to take for a given action_item */
864 enum hsm_copytool_action {
865 HSMA_NONE = 10, /* no action */
866 HSMA_ARCHIVE = 20, /* arbitrary offset */
872 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
875 case HSMA_NONE: return "NOOP";
876 case HSMA_ARCHIVE: return "ARCHIVE";
877 case HSMA_RESTORE: return "RESTORE";
878 case HSMA_REMOVE: return "REMOVE";
879 case HSMA_CANCEL: return "CANCEL";
880 default: return "UNKNOWN";
884 /* Copytool item action description */
885 struct hsm_action_item {
886 __u32 hai_len; /* valid size of this struct */
887 __u32 hai_action; /* hsm_copytool_action, but use known size */
888 lustre_fid hai_fid; /* Lustre FID to operated on */
889 struct hsm_extent hai_extent; /* byte range to operate on */
890 __u64 hai_cookie; /* action cookie from coordinator */
891 __u64 hai_gid; /* grouplock id */
892 char hai_data[0]; /* variable length */
893 } __attribute__((packed));
896 * helper function which print in hexa the first bytes of
898 * \param hai [IN] record to print
899 * \param buffer [OUT] output buffer
900 * \param len [IN] max buffer len
903 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
904 char *buffer, int len)
911 data_len = hai->hai_len - sizeof(*hai);
912 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
916 cnt = snprintf(ptr, sz, "%.2X",
917 (unsigned char)hai->hai_data[i]);
925 /* Copytool action list */
926 #define HAL_VERSION 1
927 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
928 struct hsm_action_list {
930 __u32 hal_count; /* number of hai's to follow */
931 __u64 hal_compound_id; /* returned by coordinator */
932 __u32 hal_archive_num; /* which archive backend */
934 char hal_fsname[0]; /* null-terminated */
935 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
936 boundaries. See hai_zero */
937 } __attribute__((packed));
939 #ifndef HAVE_CFS_SIZE_ROUND
940 static inline int cfs_size_round (int val)
942 return (val + 7) & (~0x7);
944 #define HAVE_CFS_SIZE_ROUND
947 /* Return pointer to first hai in action list */
948 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
950 return (struct hsm_action_item *)(hal->hal_fsname +
951 cfs_size_round(strlen(hal-> \
954 /* Return pointer to next hai */
955 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
957 return (struct hsm_action_item *)((char *)hai +
958 cfs_size_round(hai->hai_len));
961 /* Return size of an hsm_action_list */
962 static inline int hal_size(struct hsm_action_list *hal)
965 struct hsm_action_item *hai;
967 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
969 for (i = 0 ; i < hal->hal_count ; i++) {
970 sz += cfs_size_round(hai->hai_len);
976 /* Copytool progress reporting */
977 #define HP_FLAG_COMPLETED 0x01
978 #define HP_FLAG_RETRY 0x02
980 struct hsm_progress {
983 struct hsm_extent hp_extent;
985 __u16 hp_errval; /* positive val */
986 } __attribute__((packed));
990 #endif /* _LUSTRE_USER_H */