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
51 #include <libcfs/posix/posix-types.h>
53 #include <lustre/ll_fiemap.h>
54 #if defined(__linux__)
55 #include <linux/lustre_user.h>
56 #elif defined(__APPLE__)
57 #include <darwin/lustre_user.h>
58 #elif defined(__WINNT__)
59 #include <winnt/lustre_user.h>
61 #error Unsupported operating system.
65 #define LL_SUPER_MAGIC 0x0BD00BD0
67 #ifndef FSFILT_IOC_GETFLAGS
68 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
69 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
70 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
71 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
72 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
73 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
74 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
77 /* FIEMAP flags supported by Lustre */
78 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
80 enum obd_statfs_state {
81 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
82 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
83 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
84 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
85 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
99 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
100 __u32 os_fprecreated; /* objs available now to the caller */
101 /* used in QoS code to find preferred
116 * FID is a cluster-wide unique identifier of a file or an object (stripe).
117 * FIDs are never reused.
121 * FID sequence. Sequence is a unit of migration: all files (objects)
122 * with FIDs from a given sequence are stored on the same server.
123 * Lustre should support 2^64 objects, so even if each sequence
124 * has only a single object we can still enumerate 2^64 objects.
127 /* FID number within sequence. */
130 * FID version, used to distinguish different versions (in the sense
131 * of snapshots, etc.) of the same file system object. Not currently
138 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
141 /* keep this one for compatibility */
142 struct filter_fid_old {
143 struct lu_fid ff_parent;
148 /* Userspace should treat lu_fid as opaque, and only use the following methods
149 * to print or parse them. Other functions (e.g. compare, swab) could be moved
150 * here from lustre_idl.h if needed. */
151 typedef struct lu_fid lustre_fid;
154 * Following struct for object attributes, that will be kept inode's EA.
155 * Introduced in 2.0 release (please see b15993, for details)
156 * Added to all objects since Lustre 2.4 as contains self FID
158 struct lustre_mdt_attrs {
160 * Bitfield for supported data in this structure. From enum lma_compat.
161 * lma_self_fid and lma_flags are always available.
165 * Per-file incompat feature list. Lustre version should support all
166 * flags set in this field. The supported feature mask is available in
170 /** FID of this inode */
171 struct lu_fid lma_self_fid;
175 * Prior to 2.4, the LMA structure also included SOM attributes which has since
176 * been moved to a dedicated xattr
177 * lma_flags was also removed because of lma_compat/incompat fields.
179 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
182 * OST object IDentifier.
190 struct lu_fid oi_fid;
194 #define DOSTID LPX64":"LPU64
195 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
198 * The ioctl naming rules:
199 * LL_* - works on the currently opened filehandle instead of parent dir
200 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
201 * *_MDC_* - gets/sets data related to MDC
202 * *_LOV_* - gets/sets data related to OSC/LOV
203 * *FILE* - called on parent dir and passes in a filename
204 * *STRIPE* - set/get lov_user_md
205 * *INFO - set/get lov_user_mds_data
207 /* see <lustre_lib.h> for ioctl numberss 101-150 */
208 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
209 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
210 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
211 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
212 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
213 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
214 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
215 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
216 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
217 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
218 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
219 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
220 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
221 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
222 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
223 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
224 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
225 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
226 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
227 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
228 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
229 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
230 #define LL_IOC_RMTACL _IOW ('f', 167, long)
231 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
232 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
233 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
234 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
235 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
236 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
237 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
238 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
240 /* see <lustre_lib.h> for ioctl numbers 177-210 */
242 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
243 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
244 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
245 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
246 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
247 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
248 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
249 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
250 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
251 struct lustre_swap_layouts)
252 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
253 struct hsm_current_action)
254 /* see <lustre_lib.h> for ioctl numbers 221-232 */
256 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
257 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
258 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
259 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
260 #define LL_IOC_GET_LEASE _IO('f', 244)
261 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
263 #define LL_STATFS_LMV 1
264 #define LL_STATFS_LOV 2
265 #define LL_STATFS_NODELAY 4
267 #define IOC_MDC_TYPE 'i'
268 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
269 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
270 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
271 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
273 /* Keep these for backward compartability. */
274 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
275 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
278 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
280 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
281 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
282 * which was added since kernel 2.6.36, so we redefine it as 020000000.
283 * To be compatible with old version's statically linked binary, finally we
284 * define it as (020000000 | 0100000000).
286 #define O_LOV_DELAY_CREATE 0120000000
288 #define LL_FILE_IGNORE_LOCK 0x00000001
289 #define LL_FILE_GROUP_LOCKED 0x00000002
290 #define LL_FILE_READAHEA 0x00000004
291 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
292 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
293 #define LL_FILE_RMTACL 0x00000020
295 #define LOV_USER_MAGIC_V1 0x0BD10BD0
296 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
297 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
298 #define LOV_USER_MAGIC_V3 0x0BD30BD0
300 #define LMV_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */
301 #define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/
303 #define LOV_PATTERN_RAID0 0x001
304 #define LOV_PATTERN_RAID1 0x002
305 #define LOV_PATTERN_FIRST 0x100
307 #define LOV_MAXPOOLNAME 16
308 #define LOV_POOLNAMEF "%.16s"
310 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
311 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
312 #define LOV_MAX_STRIPE_COUNT_OLD 160
313 /* This calculation is crafted so that input of 4096 will result in 160
314 * which in turn is equal to old maximal stripe count.
315 * XXX: In fact this is too simpified for now, what it also need is to get
316 * ea_type argument to clearly know how much space each stripe consumes.
318 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
319 * allocation that is sufficient for the current generation of systems.
321 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
322 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
323 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
324 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
326 #define XATTR_LUSTRE_PREFIX "lustre."
327 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
329 #define lov_user_ost_data lov_user_ost_data_v1
330 struct lov_user_ost_data_v1 { /* per-stripe data structure */
331 struct ost_id l_ost_oi; /* OST object ID */
332 __u32 l_ost_gen; /* generation of this OST index */
333 __u32 l_ost_idx; /* OST index in LOV */
334 } __attribute__((packed));
336 #define lov_user_md lov_user_md_v1
337 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
338 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
339 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
340 struct ost_id lmm_oi; /* LOV object ID */
341 __u32 lmm_stripe_size; /* size of stripe in bytes */
342 __u16 lmm_stripe_count; /* num stripes in use for this object */
344 __u16 lmm_stripe_offset; /* starting stripe offset in
345 * lmm_objects, use when writing */
346 __u16 lmm_layout_gen; /* layout generation number
347 * used when reading */
349 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
350 } __attribute__((packed, __may_alias__));
352 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
353 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
354 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
355 struct ost_id lmm_oi; /* LOV object ID */
356 __u32 lmm_stripe_size; /* size of stripe in bytes */
357 __u16 lmm_stripe_count; /* num stripes in use for this object */
359 __u16 lmm_stripe_offset; /* starting stripe offset in
360 * lmm_objects, use when writing */
361 __u16 lmm_layout_gen; /* layout generation number
362 * used when reading */
364 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
365 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
366 } __attribute__((packed));
368 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
370 if (lmm_magic == LOV_USER_MAGIC_V3)
371 return sizeof(struct lov_user_md_v3) +
372 stripes * sizeof(struct lov_user_ost_data_v1);
374 return sizeof(struct lov_user_md_v1) +
375 stripes * sizeof(struct lov_user_ost_data_v1);
378 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
379 * use this. It is unsafe to #define those values in this header as it
380 * is possible the application has already #included <sys/stat.h>. */
381 #ifdef HAVE_LOV_USER_MDS_DATA
382 #define lov_user_mds_data lov_user_mds_data_v1
383 struct lov_user_mds_data_v1 {
384 lstat_t lmd_st; /* MDS stat struct */
385 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
386 } __attribute__((packed));
388 struct lov_user_mds_data_v3 {
389 lstat_t lmd_st; /* MDS stat struct */
390 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
391 } __attribute__((packed));
394 /* keep this to be the same size as lov_user_ost_data_v1 */
395 struct lmv_user_mds_data {
396 struct lu_fid lum_fid;
404 LMV_DEFAULT_TYPE = 1,
407 #define lmv_user_md lmv_user_md_v1
408 struct lmv_user_md_v1 {
409 __u32 lum_magic; /* must be the first field */
410 __u32 lum_stripe_count; /* dirstripe count */
411 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
412 __u32 lum_hash_type; /* Dir stripe policy */
413 __u32 lum_type; /* LMV type: default or normal */
417 char lum_pool_name[LOV_MAXPOOLNAME];
418 struct lmv_user_mds_data lum_objects[0];
421 static inline int lmv_user_md_size(int stripes, int lmm_magic)
423 return sizeof(struct lmv_user_md) +
424 stripes * sizeof(struct lmv_user_mds_data);
427 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
429 struct ll_recreate_obj {
435 __u64 id; /* holds object id */
436 __u32 generation; /* holds object generation */
437 __u32 f_type; /* holds object type or stripe idx when passing it to
438 * OST for saving into EA. */
446 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
447 const struct obd_uuid *u2)
449 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
452 static inline int obd_uuid_empty(struct obd_uuid *uuid)
454 return uuid->uuid[0] == '\0';
457 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
459 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
460 uuid->uuid[sizeof(*uuid) - 1] = '\0';
463 /* For printf's only, make sure uuid is terminated */
464 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
469 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
470 /* Obviously not safe, but for printfs, no real harm done...
471 we're always null-terminated, even in a race. */
472 static char temp[sizeof(*uuid)];
473 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
474 temp[sizeof(*uuid) - 1] = '\0';
477 return (char *)(uuid->uuid);
480 /* Extract fsname from uuid (or target name) of a target
481 e.g. (myfs-OST0007_UUID -> myfs)
482 see also deuuidify. */
483 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
487 strncpy(buf, uuid, buflen - 1);
488 buf[buflen - 1] = '\0';
489 p = strrchr(buf, '-');
494 /* printf display format
495 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
496 #define FID_NOBRACE_LEN 40
497 #define FID_LEN (FID_NOBRACE_LEN + 2)
498 #define DFID_NOBRACE LPX64":0x%x:0x%x"
499 #define DFID "["DFID_NOBRACE"]"
505 /* scanf input parse format -- strip '[' first.
506 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
507 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
508 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
509 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
511 #define SFID "0x"LPX64i":0x%x:0x%x"
518 /********* Quotas **********/
520 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
521 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
522 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
523 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
524 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
525 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
526 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
527 /* lustre-specific control commands */
528 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
529 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
531 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
533 struct if_quotacheck {
535 struct obd_uuid obd_uuid;
538 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
541 #define N_PERMS_MAX 64
543 struct perm_downcall_data {
549 struct identity_downcall_data {
556 struct perm_downcall_data idd_perms[N_PERMS_MAX];
560 /* for non-mapped uid/gid */
561 #define NOBODY_UID 99
562 #define NOBODY_GID 99
564 #define INVALID_ID (-1)
573 #ifdef NEED_QUOTA_DEFS
575 #define QIF_BLIMITS 1
577 #define QIF_ILIMITS 4
581 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
582 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
583 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
584 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
587 #endif /* !__KERNEL__ */
589 /* lustre volatile file support
590 * file name header: .^L^S^T^R:volatile"
592 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
593 #define LUSTRE_VOLATILE_HDR_LEN 14
594 /* hdr + MDT index */
595 #define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:"
597 typedef enum lustre_quota_version {
599 } lustre_quota_version_t;
601 /* XXX: same as if_dqinfo struct in kernel */
609 /* XXX: same as if_dqblk struct in kernel, plus one padding */
611 __u64 dqb_bhardlimit;
612 __u64 dqb_bsoftlimit;
614 __u64 dqb_ihardlimit;
615 __u64 dqb_isoftlimit;
637 struct obd_dqinfo qc_dqinfo;
638 struct obd_dqblk qc_dqblk;
640 struct obd_uuid obd_uuid;
643 /* swap layout flags */
644 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
645 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
646 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
647 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
649 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
650 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
651 struct lustre_swap_layouts {
660 /********* Changelogs **********/
661 /** Changelog record types */
662 enum changelog_rec_type {
664 CL_CREATE = 1, /* namespace */
665 CL_MKDIR = 2, /* namespace */
666 CL_HARDLINK = 3, /* namespace */
667 CL_SOFTLINK = 4, /* namespace */
668 CL_MKNOD = 5, /* namespace */
669 CL_UNLINK = 6, /* namespace */
670 CL_RMDIR = 7, /* namespace */
671 CL_RENAME = 8, /* namespace */
672 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
673 CL_OPEN = 10, /* not currently used */
674 CL_CLOSE = 11, /* may be written to log only with mtime change */
675 CL_LAYOUT = 12, /* file layout/striping modified */
679 CL_HSM = 16, /* HSM specific events, see flags */
680 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
686 static inline const char *changelog_type2str(int type) {
687 static const char *changelog_str[] = {
688 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
689 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
690 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME",
693 if (type >= 0 && type < CL_LAST)
694 return changelog_str[type];
698 /* per-record flags */
699 #define CLF_VERSION 0x1000
700 #define CLF_EXT_VERSION 0x2000
701 #define CLF_FLAGSHIFT 12
702 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
703 #define CLF_VERMASK (~CLF_FLAGMASK)
704 /* Anything under the flagmask may be per-type (if desired) */
705 /* Flags for unlink */
706 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
707 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
708 /* HSM cleaning needed */
709 /* Flags for rename */
710 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
712 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
713 * has an archive in backend */
716 /* 12b used (from high weight to low weight):
721 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
722 #define CLF_HSM_ERR_H 6
723 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
724 #define CLF_HSM_EVENT_H 9
725 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
726 #define CLF_HSM_FLAG_H 11
727 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
728 #define CLF_HSM_SPARE_H 15
729 #define CLF_HSM_LAST 15
731 /* Remove bits higher than _h, then extract the value
732 * between _h and _l by shifting lower weigth to bit 0. */
733 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
734 >> (CLF_HSM_LAST - _h + _l))
736 #define CLF_HSM_SUCCESS 0x00
737 #define CLF_HSM_MAXERROR 0x7E
738 #define CLF_HSM_ERROVERFLOW 0x7F
740 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
742 /* 3 bits field => 8 values allowed */
754 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
756 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
759 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
761 *flags |= (he << CLF_HSM_EVENT_L);
764 static inline __u16 hsm_get_cl_flags(int flags)
766 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
769 static inline void hsm_set_cl_flags(int *flags, int bits)
771 *flags |= (bits << CLF_HSM_FLAG_L);
774 static inline int hsm_get_cl_error(int flags)
776 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
779 static inline void hsm_set_cl_error(int *flags, int error)
781 *flags |= (error << CLF_HSM_ERR_L);
784 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
785 sizeof(struct changelog_ext_rec))
787 struct changelog_rec {
789 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
790 __u32 cr_type; /**< \a changelog_rec_type */
791 __u64 cr_index; /**< changelog record number */
792 __u64 cr_prev; /**< last index for this target fid */
795 lustre_fid cr_tfid; /**< target fid */
796 __u32 cr_markerflags; /**< CL_MARK flags */
798 lustre_fid cr_pfid; /**< parent fid */
799 char cr_name[0]; /**< last element */
800 } __attribute__((packed));
802 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
803 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
806 struct changelog_ext_rec {
808 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
810 __u32 cr_type; /**< \a changelog_rec_type */
811 __u64 cr_index; /**< changelog record number */
812 __u64 cr_prev; /**< last index for this target fid */
815 lustre_fid cr_tfid; /**< target fid */
816 __u32 cr_markerflags; /**< CL_MARK flags */
818 lustre_fid cr_pfid; /**< target parent fid */
819 lustre_fid cr_sfid; /**< source fid, or zero */
820 lustre_fid cr_spfid; /**< source parent fid, or zero */
821 char cr_name[0]; /**< last element */
822 } __attribute__((packed));
824 #define CHANGELOG_REC_EXTENDED(rec) \
825 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
827 static inline int changelog_rec_size(struct changelog_rec *rec)
829 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
833 static inline char *changelog_rec_name(struct changelog_rec *rec)
835 return CHANGELOG_REC_EXTENDED(rec) ?
836 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
839 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
841 return rec->cr_namelen - strlen(rec->cr_name) - 1;
844 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
846 return rec->cr_name + strlen(rec->cr_name) + 1;
849 struct ioc_changelog {
856 enum changelog_message_type {
857 CL_RECORD = 10, /* message is a changelog_rec */
858 CL_EOF = 11, /* at end of current changelog */
861 /********* Misc **********/
863 struct ioc_data_version {
865 __u64 idv_flags; /* See LL_DV_xxx */
867 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
868 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
871 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
874 #define dot_lustre_name ".lustre"
877 /********* HSM **********/
879 /** HSM per-file state
880 * See HSM_FLAGS below.
883 HS_EXISTS = 0x00000001,
884 HS_DIRTY = 0x00000002,
885 HS_RELEASED = 0x00000004,
886 HS_ARCHIVED = 0x00000008,
887 HS_NORELEASE = 0x00000010,
888 HS_NOARCHIVE = 0x00000020,
889 HS_LOST = 0x00000040,
892 /* HSM user-setable flags. */
893 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
895 /* Other HSM flags. */
896 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
899 * All HSM-related possible flags that could be applied to a file.
900 * This should be kept in sync with hsm_states.
902 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
905 * HSMÂ request progress state
907 enum hsm_progress_states {
914 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
917 case HPS_WAITING: return "waiting";
918 case HPS_RUNNING: return "running";
919 case HPS_DONE: return "done";
920 default: return "unknown";
927 } __attribute__((packed));
930 * Current HSM states of a Lustre file.
932 * This structure purpose is to be sent to user-space mainly. It describes the
933 * current HSM flags and in-progress action.
935 struct hsm_user_state {
936 /** Current HSM states, from enum hsm_states. */
938 __u32 hus_archive_id;
939 /** The current undergoing action, if there is one */
940 __u32 hus_in_progress_state;
941 __u32 hus_in_progress_action;
942 struct hsm_extent hus_in_progress_location;
943 char hus_extended_info[];
946 struct hsm_state_set_ioc {
947 struct lu_fid hssi_fid;
949 __u64 hssi_clearmask;
953 * This structure describes the current in-progress action for a file.
954 * it is retuned to user space and send over the wire
956 struct hsm_current_action {
957 /** The current undergoing action, if there is one */
958 /* state is one of hsm_progress_states */
960 /* action is one of hsm_user_action */
962 struct hsm_extent hca_location;
965 /***** HSM user requests ******/
966 /* User-generated (lfs/ioctl) request types */
967 enum hsm_user_action {
968 HUA_NONE = 1, /* no action (noop) */
969 HUA_ARCHIVE = 10, /* copy to hsm */
970 HUA_RESTORE = 11, /* prestage */
971 HUA_RELEASE = 12, /* drop ost objects */
972 HUA_REMOVE = 13, /* remove from archive */
973 HUA_CANCEL = 14 /* cancel a request */
976 static inline char *hsm_user_action2name(enum hsm_user_action a)
979 case HUA_NONE: return "NOOP";
980 case HUA_ARCHIVE: return "ARCHIVE";
981 case HUA_RESTORE: return "RESTORE";
982 case HUA_RELEASE: return "RELEASE";
983 case HUA_REMOVE: return "REMOVE";
984 case HUA_CANCEL: return "CANCEL";
985 default: return "UNKNOWN";
990 * List of hr_flags (bit field)
992 #define HSM_FORCE_ACTION 0x0001
993 /* used by CT, connot be set by user */
994 #define HSM_GHOST_COPY 0x0002
997 * Contains all the fixed part of struct hsm_user_request.
1000 struct hsm_request {
1001 __u32 hr_action; /* enum hsm_user_action */
1002 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1003 __u64 hr_flags; /* request flags */
1004 __u32 hr_itemcount; /* item count in hur_user_item vector */
1008 struct hsm_user_item {
1010 struct hsm_extent hui_extent;
1011 } __attribute__((packed));
1013 struct hsm_user_request {
1014 struct hsm_request hur_request;
1015 struct hsm_user_item hur_user_item[0];
1016 /* extra data blob at end of struct (after all
1017 * hur_user_items), only use helpers to access it
1019 } __attribute__((packed));
1021 /** Return pointer to data field in a hsm user request */
1022 static inline void *hur_data(struct hsm_user_request *hur)
1024 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1027 /** Compute the current length of the provided hsm_user_request. */
1028 static inline int hur_len(struct hsm_user_request *hur)
1030 return offsetof(struct hsm_user_request,
1031 hur_user_item[hur->hur_request.hr_itemcount]) +
1032 hur->hur_request.hr_data_len;
1035 /****** HSM RPCs to copytool *****/
1036 /* Message types the copytool may receive */
1037 enum hsm_message_type {
1038 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1041 /* Actions the copytool may be instructed to take for a given action_item */
1042 enum hsm_copytool_action {
1043 HSMA_NONE = 10, /* no action */
1044 HSMA_ARCHIVE = 20, /* arbitrary offset */
1050 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
1053 case HSMA_NONE: return "NOOP";
1054 case HSMA_ARCHIVE: return "ARCHIVE";
1055 case HSMA_RESTORE: return "RESTORE";
1056 case HSMA_REMOVE: return "REMOVE";
1057 case HSMA_CANCEL: return "CANCEL";
1058 default: return "UNKNOWN";
1062 /* Copytool item action description */
1063 struct hsm_action_item {
1064 __u32 hai_len; /* valid size of this struct */
1065 __u32 hai_action; /* hsm_copytool_action, but use known size */
1066 lustre_fid hai_fid; /* Lustre FID to operated on */
1067 lustre_fid hai_dfid; /* fid used for data access */
1068 struct hsm_extent hai_extent; /* byte range to operate on */
1069 __u64 hai_cookie; /* action cookie from coordinator */
1070 __u64 hai_gid; /* grouplock id */
1071 char hai_data[0]; /* variable length */
1072 } __attribute__((packed));
1075 * helper function which print in hexa the first bytes of
1077 * \param hai [IN] record to print
1078 * \param buffer [OUT] output buffer
1079 * \param len [IN] max buffer len
1082 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1083 char *buffer, int len)
1085 int i, sz, data_len;
1090 data_len = hai->hai_len - sizeof(*hai);
1091 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1095 cnt = snprintf(ptr, sz, "%.2X",
1096 (unsigned char)hai->hai_data[i]);
1104 /* Copytool action list */
1105 #define HAL_VERSION 1
1106 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1107 struct hsm_action_list {
1109 __u32 hal_count; /* number of hai's to follow */
1110 __u64 hal_compound_id; /* returned by coordinator */
1112 __u32 hal_archive_id; /* which archive backend */
1114 char hal_fsname[0]; /* null-terminated */
1115 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1116 boundaries. See hai_zero */
1117 } __attribute__((packed));
1119 #ifndef HAVE_CFS_SIZE_ROUND
1120 static inline int cfs_size_round (int val)
1122 return (val + 7) & (~0x7);
1124 #define HAVE_CFS_SIZE_ROUND
1127 /* Return pointer to first hai in action list */
1128 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1130 return (struct hsm_action_item *)(hal->hal_fsname +
1131 cfs_size_round(strlen(hal-> \
1134 /* Return pointer to next hai */
1135 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1137 return (struct hsm_action_item *)((char *)hai +
1138 cfs_size_round(hai->hai_len));
1141 /* Return size of an hsm_action_list */
1142 static inline int hal_size(struct hsm_action_list *hal)
1145 struct hsm_action_item *hai;
1147 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1148 hai = hai_first(hal);
1149 for (i = 0 ; i < hal->hal_count ; i++, hai = hai_next(hai))
1150 sz += cfs_size_round(hai->hai_len);
1156 * describe the attributes to be set on imported file
1158 struct hsm_user_import {
1167 __u32 hui_archive_id;
1170 /* Copytool progress reporting */
1171 #define HP_FLAG_COMPLETED 0x01
1172 #define HP_FLAG_RETRY 0x02
1174 struct hsm_progress {
1177 struct hsm_extent hp_extent;
1179 __u16 hp_errval; /* positive val */
1184 __u64 hc_data_version;
1186 __u16 hc_errval; /* positive val */
1188 struct hsm_action_item hc_hai;
1191 /** @} lustreuser */
1193 #endif /* _LUSTRE_USER_H */