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>
54 #include <lustre/ll_fiemap.h>
55 #if defined(__linux__)
56 #include <linux/lustre_user.h>
57 #elif defined(__APPLE__)
58 #include <darwin/lustre_user.h>
59 #elif defined(__WINNT__)
60 #include <winnt/lustre_user.h>
62 #error Unsupported operating system.
66 #define LUSTRE_ANONYMOUS_UNION_NAME u
68 #define LUSTRE_ANONYMOUS_UNION_NAME
72 #define LL_SUPER_MAGIC 0x0BD00BD0
74 #ifndef FSFILT_IOC_GETFLAGS
75 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
76 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
77 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
78 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
79 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
80 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
81 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
84 /* FIEMAP flags supported by Lustre */
85 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
87 enum obd_statfs_state {
88 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
89 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
90 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
91 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
92 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
106 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
107 __u32 os_fprecreated; /* objs available now to the caller */
108 /* used in QoS code to find preferred
123 * FID is a cluster-wide unique identifier of a file or an object (stripe).
124 * FIDs are never reused.
128 * FID sequence. Sequence is a unit of migration: all files (objects)
129 * with FIDs from a given sequence are stored on the same server.
130 * Lustre should support 2^64 objects, so even if each sequence
131 * has only a single object we can still enumerate 2^64 objects.
134 /* FID number within sequence. */
137 * FID version, used to distinguish different versions (in the sense
138 * of snapshots, etc.) of the same file system object. Not currently
145 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
148 /* keep this one for compatibility */
149 struct filter_fid_old {
150 struct lu_fid ff_parent;
155 /* Userspace should treat lu_fid as opaque, and only use the following methods
156 * to print or parse them. Other functions (e.g. compare, swab) could be moved
157 * here from lustre_idl.h if needed. */
158 typedef struct lu_fid lustre_fid;
161 * Following struct for object attributes, that will be kept inode's EA.
162 * Introduced in 2.0 release (please see b15993, for details)
163 * Added to all objects since Lustre 2.4 as contains self FID
165 struct lustre_mdt_attrs {
167 * Bitfield for supported data in this structure. From enum lma_compat.
168 * lma_self_fid and lma_flags are always available.
172 * Per-file incompat feature list. Lustre version should support all
173 * flags set in this field. The supported feature mask is available in
177 /** FID of this inode */
178 struct lu_fid lma_self_fid;
182 * Prior to 2.4, the LMA structure also included SOM attributes which has since
183 * been moved to a dedicated xattr
184 * lma_flags was also removed because of lma_compat/incompat fields.
186 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
189 * OST object IDentifier.
197 struct lu_fid oi_fid;
198 } LUSTRE_ANONYMOUS_UNION_NAME;
201 #define DOSTID LPX64":"LPU64
202 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
205 * The ioctl naming rules:
206 * LL_* - works on the currently opened filehandle instead of parent dir
207 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
208 * *_MDC_* - gets/sets data related to MDC
209 * *_LOV_* - gets/sets data related to OSC/LOV
210 * *FILE* - called on parent dir and passes in a filename
211 * *STRIPE* - set/get lov_user_md
212 * *INFO - set/get lov_user_mds_data
214 /* see <lustre_lib.h> for ioctl numberss 101-150 */
215 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
216 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
217 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
218 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
219 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
220 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
221 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
222 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
223 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
224 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
225 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
226 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
227 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
228 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
229 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
230 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
231 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
232 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
233 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
234 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
235 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
236 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
237 #define LL_IOC_RMTACL _IOW ('f', 167, long)
238 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
239 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
240 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
241 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
242 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
243 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
244 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
245 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
247 /* see <lustre_lib.h> for ioctl numbers 177-210 */
249 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
250 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
251 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
252 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
253 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
254 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
255 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
256 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
257 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
258 struct lustre_swap_layouts)
259 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
260 struct hsm_current_action)
261 /* see <lustre_lib.h> for ioctl numbers 221-232 */
263 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
264 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
265 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
266 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
267 #define LL_IOC_GET_LEASE _IO('f', 244)
268 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
270 #define LL_STATFS_LMV 1
271 #define LL_STATFS_LOV 2
272 #define LL_STATFS_NODELAY 4
274 #define IOC_MDC_TYPE 'i'
275 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
276 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
277 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
278 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
280 /* Keep these for backward compartability. */
281 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
282 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
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_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */
311 #define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/
313 #define LOV_PATTERN_RAID0 0x001
314 #define LOV_PATTERN_RAID1 0x002
315 #define LOV_PATTERN_FIRST 0x100
317 #define LOV_MAXPOOLNAME 16
318 #define LOV_POOLNAMEF "%.16s"
320 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
321 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
322 #define LOV_MAX_STRIPE_COUNT_OLD 160
323 /* This calculation is crafted so that input of 4096 will result in 160
324 * which in turn is equal to old maximal stripe count.
325 * XXX: In fact this is too simpified for now, what it also need is to get
326 * ea_type argument to clearly know how much space each stripe consumes.
328 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
329 * allocation that is sufficient for the current generation of systems.
331 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
332 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
333 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
334 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
336 #define XATTR_LUSTRE_PREFIX "lustre."
337 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
339 #define lov_user_ost_data lov_user_ost_data_v1
340 struct lov_user_ost_data_v1 { /* per-stripe data structure */
341 struct ost_id l_ost_oi; /* OST object ID */
342 __u32 l_ost_gen; /* generation of this OST index */
343 __u32 l_ost_idx; /* OST index in LOV */
344 } __attribute__((packed));
346 #define lov_user_md lov_user_md_v1
347 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
348 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
349 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
350 struct ost_id lmm_oi; /* LOV object ID */
351 __u32 lmm_stripe_size; /* size of stripe in bytes */
352 __u16 lmm_stripe_count; /* num stripes in use for this object */
354 __u16 lmm_stripe_offset; /* starting stripe offset in
355 * lmm_objects, use when writing */
356 __u16 lmm_layout_gen; /* layout generation number
357 * used when reading */
359 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
360 } __attribute__((packed, __may_alias__));
362 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
363 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
364 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
365 struct ost_id lmm_oi; /* LOV object ID */
366 __u32 lmm_stripe_size; /* size of stripe in bytes */
367 __u16 lmm_stripe_count; /* num stripes in use for this object */
369 __u16 lmm_stripe_offset; /* starting stripe offset in
370 * lmm_objects, use when writing */
371 __u16 lmm_layout_gen; /* layout generation number
372 * used when reading */
374 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
375 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
376 } __attribute__((packed));
378 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
380 if (lmm_magic == LOV_USER_MAGIC_V3)
381 return sizeof(struct lov_user_md_v3) +
382 stripes * sizeof(struct lov_user_ost_data_v1);
384 return sizeof(struct lov_user_md_v1) +
385 stripes * sizeof(struct lov_user_ost_data_v1);
388 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
389 * use this. It is unsafe to #define those values in this header as it
390 * is possible the application has already #included <sys/stat.h>. */
391 #ifdef HAVE_LOV_USER_MDS_DATA
392 #define lov_user_mds_data lov_user_mds_data_v1
393 struct lov_user_mds_data_v1 {
394 lstat_t lmd_st; /* MDS stat struct */
395 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
396 } __attribute__((packed));
398 struct lov_user_mds_data_v3 {
399 lstat_t lmd_st; /* MDS stat struct */
400 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
401 } __attribute__((packed));
404 /* keep this to be the same size as lov_user_ost_data_v1 */
405 struct lmv_user_mds_data {
406 struct lu_fid lum_fid;
414 LMV_DEFAULT_TYPE = 1,
417 #define lmv_user_md lmv_user_md_v1
418 struct lmv_user_md_v1 {
419 __u32 lum_magic; /* must be the first field */
420 __u32 lum_stripe_count; /* dirstripe count */
421 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
422 __u32 lum_hash_type; /* Dir stripe policy */
423 __u32 lum_type; /* LMV type: default or normal */
427 char lum_pool_name[LOV_MAXPOOLNAME];
428 struct lmv_user_mds_data lum_objects[0];
431 static inline int lmv_user_md_size(int stripes, int lmm_magic)
433 return sizeof(struct lmv_user_md) +
434 stripes * sizeof(struct lmv_user_mds_data);
437 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
439 struct ll_recreate_obj {
445 __u64 id; /* holds object id */
446 __u32 generation; /* holds object generation */
447 __u32 f_type; /* holds object type or stripe idx when passing it to
448 * OST for saving into EA. */
456 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
457 const struct obd_uuid *u2)
459 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
462 static inline int obd_uuid_empty(struct obd_uuid *uuid)
464 return uuid->uuid[0] == '\0';
467 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
469 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
470 uuid->uuid[sizeof(*uuid) - 1] = '\0';
473 /* For printf's only, make sure uuid is terminated */
474 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
479 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
480 /* Obviously not safe, but for printfs, no real harm done...
481 we're always null-terminated, even in a race. */
482 static char temp[sizeof(*uuid)];
483 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
484 temp[sizeof(*uuid) - 1] = '\0';
487 return (char *)(uuid->uuid);
490 /* Extract fsname from uuid (or target name) of a target
491 e.g. (myfs-OST0007_UUID -> myfs)
492 see also deuuidify. */
493 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
497 strncpy(buf, uuid, buflen - 1);
498 buf[buflen - 1] = '\0';
499 p = strrchr(buf, '-');
504 /* printf display format
505 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
506 #define FID_NOBRACE_LEN 40
507 #define FID_LEN (FID_NOBRACE_LEN + 2)
508 #define DFID_NOBRACE LPX64":0x%x:0x%x"
509 #define DFID "["DFID_NOBRACE"]"
515 /* scanf input parse format -- strip '[' first.
516 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
517 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
518 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
519 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
521 #define SFID "0x"LPX64i":0x%x:0x%x"
528 /********* Quotas **********/
530 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
531 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
532 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
533 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
534 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
535 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
536 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
537 /* lustre-specific control commands */
538 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
539 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
541 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
543 struct if_quotacheck {
545 struct obd_uuid obd_uuid;
548 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
551 #define N_PERMS_MAX 64
553 struct perm_downcall_data {
559 struct identity_downcall_data {
566 struct perm_downcall_data idd_perms[N_PERMS_MAX];
570 /* for non-mapped uid/gid */
571 #define NOBODY_UID 99
572 #define NOBODY_GID 99
574 #define INVALID_ID (-1)
583 #ifdef NEED_QUOTA_DEFS
585 #define QIF_BLIMITS 1
587 #define QIF_ILIMITS 4
591 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
592 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
593 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
594 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
597 #endif /* !__KERNEL__ */
599 /* lustre volatile file support
600 * file name header: .^L^S^T^R:volatile"
602 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
603 #define LUSTRE_VOLATILE_HDR_LEN 14
605 typedef enum lustre_quota_version {
607 } lustre_quota_version_t;
609 /* XXX: same as if_dqinfo struct in kernel */
617 /* XXX: same as if_dqblk struct in kernel, plus one padding */
619 __u64 dqb_bhardlimit;
620 __u64 dqb_bsoftlimit;
622 __u64 dqb_ihardlimit;
623 __u64 dqb_isoftlimit;
645 struct obd_dqinfo qc_dqinfo;
646 struct obd_dqblk qc_dqblk;
648 struct obd_uuid obd_uuid;
651 /* swap layout flags */
652 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
653 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
654 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
655 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
657 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
658 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
659 struct lustre_swap_layouts {
668 /********* Changelogs **********/
669 /** Changelog record types */
670 enum changelog_rec_type {
672 CL_CREATE = 1, /* namespace */
673 CL_MKDIR = 2, /* namespace */
674 CL_HARDLINK = 3, /* namespace */
675 CL_SOFTLINK = 4, /* namespace */
676 CL_MKNOD = 5, /* namespace */
677 CL_UNLINK = 6, /* namespace */
678 CL_RMDIR = 7, /* namespace */
679 CL_RENAME = 8, /* namespace */
680 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
681 CL_OPEN = 10, /* not currently used */
682 CL_CLOSE = 11, /* may be written to log only with mtime change */
683 CL_LAYOUT = 12, /* file layout/striping modified */
687 CL_HSM = 16, /* HSM specific events, see flags */
688 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
694 static inline const char *changelog_type2str(int type) {
695 static const char *changelog_str[] = {
696 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
697 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
698 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME",
701 if (type >= 0 && type < CL_LAST)
702 return changelog_str[type];
706 /* per-record flags */
707 #define CLF_VERSION 0x1000
708 #define CLF_EXT_VERSION 0x2000
709 #define CLF_FLAGSHIFT 12
710 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
711 #define CLF_VERMASK (~CLF_FLAGMASK)
712 /* Anything under the flagmask may be per-type (if desired) */
713 /* Flags for unlink */
714 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
715 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
716 /* HSM cleaning needed */
717 /* Flags for rename */
718 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
720 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
721 * has an archive in backend */
724 /* 12b used (from high weight to low weight):
729 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
730 #define CLF_HSM_ERR_H 6
731 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
732 #define CLF_HSM_EVENT_H 9
733 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
734 #define CLF_HSM_FLAG_H 11
735 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
736 #define CLF_HSM_SPARE_H 15
737 #define CLF_HSM_LAST 15
739 /* Remove bits higher than _h, then extract the value
740 * between _h and _l by shifting lower weigth to bit 0. */
741 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
742 >> (CLF_HSM_LAST - _h + _l))
744 #define CLF_HSM_SUCCESS 0x00
745 #define CLF_HSM_MAXERROR 0x7E
746 #define CLF_HSM_ERROVERFLOW 0x7F
748 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
750 /* 3 bits field => 8 values allowed */
762 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
764 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
768 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
770 *flags |= (he << CLF_HSM_EVENT_L);
773 static inline __u16 hsm_get_cl_flags(int flags)
775 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
778 static inline void hsm_set_cl_flags(int *flags, int bits)
780 *flags |= (bits << CLF_HSM_FLAG_L);
783 static inline int hsm_get_cl_error(int flags)
785 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
788 static inline void hsm_set_cl_error(int *flags, int error)
790 *flags |= (error << CLF_HSM_ERR_L);
793 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
794 sizeof(struct changelog_ext_rec))
796 struct changelog_rec {
798 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
799 __u32 cr_type; /**< \a changelog_rec_type */
800 __u64 cr_index; /**< changelog record number */
801 __u64 cr_prev; /**< last index for this target fid */
804 lustre_fid cr_tfid; /**< target fid */
805 __u32 cr_markerflags; /**< CL_MARK flags */
807 lustre_fid cr_pfid; /**< parent fid */
808 char cr_name[0]; /**< last element */
809 } __attribute__((packed));
811 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
812 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
815 struct changelog_ext_rec {
817 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
819 __u32 cr_type; /**< \a changelog_rec_type */
820 __u64 cr_index; /**< changelog record number */
821 __u64 cr_prev; /**< last index for this target fid */
824 lustre_fid cr_tfid; /**< target fid */
825 __u32 cr_markerflags; /**< CL_MARK flags */
827 lustre_fid cr_pfid; /**< target parent fid */
828 lustre_fid cr_sfid; /**< source fid, or zero */
829 lustre_fid cr_spfid; /**< source parent fid, or zero */
830 char cr_name[0]; /**< last element */
831 } __attribute__((packed));
833 #define CHANGELOG_REC_EXTENDED(rec) \
834 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
836 static inline int changelog_rec_size(struct changelog_rec *rec)
838 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
842 static inline char *changelog_rec_name(struct changelog_rec *rec)
844 return CHANGELOG_REC_EXTENDED(rec) ?
845 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
848 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
850 return rec->cr_namelen - strlen(rec->cr_name) - 1;
853 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
855 return rec->cr_name + strlen(rec->cr_name) + 1;
858 struct ioc_changelog {
865 enum changelog_message_type {
866 CL_RECORD = 10, /* message is a changelog_rec */
867 CL_EOF = 11, /* at end of current changelog */
870 /********* Misc **********/
872 struct ioc_data_version {
874 __u64 idv_flags; /* See LL_DV_xxx */
876 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
877 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
880 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
883 #define dot_lustre_name ".lustre"
886 /********* HSM **********/
888 /** HSM per-file state
889 * See HSM_FLAGS below.
892 HS_EXISTS = 0x00000001,
893 HS_DIRTY = 0x00000002,
894 HS_RELEASED = 0x00000004,
895 HS_ARCHIVED = 0x00000008,
896 HS_NORELEASE = 0x00000010,
897 HS_NOARCHIVE = 0x00000020,
898 HS_LOST = 0x00000040,
901 /* HSM user-setable flags. */
902 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
904 /* Other HSM flags. */
905 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
908 * All HSM-related possible flags that could be applied to a file.
909 * This should be kept in sync with hsm_states.
911 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
914 * HSMÂ request progress state
916 enum hsm_progress_states {
923 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
926 case HPS_WAITING: return "waiting";
927 case HPS_RUNNING: return "running";
928 case HPS_DONE: return "done";
929 default: return "unknown";
936 } __attribute__((packed));
939 * Current HSM states of a Lustre file.
941 * This structure purpose is to be sent to user-space mainly. It describes the
942 * current HSM flags and in-progress action.
944 struct hsm_user_state {
945 /** Current HSM states, from enum hsm_states. */
947 __u32 hus_archive_id;
948 /** The current undergoing action, if there is one */
949 __u32 hus_in_progress_state;
950 __u32 hus_in_progress_action;
951 struct hsm_extent hus_in_progress_location;
952 char hus_extended_info[];
955 struct hsm_state_set_ioc {
956 struct lu_fid hssi_fid;
958 __u64 hssi_clearmask;
962 * This structure describes the current in-progress action for a file.
963 * it is retuned to user space and send over the wire
965 struct hsm_current_action {
966 /** The current undergoing action, if there is one */
967 /* state is one of hsm_progress_states */
969 /* action is one of hsm_user_action */
971 struct hsm_extent hca_location;
974 /***** HSM user requests ******/
975 /* User-generated (lfs/ioctl) request types */
976 enum hsm_user_action {
977 HUA_NONE = 1, /* no action (noop) */
978 HUA_ARCHIVE = 10, /* copy to hsm */
979 HUA_RESTORE = 11, /* prestage */
980 HUA_RELEASE = 12, /* drop ost objects */
981 HUA_REMOVE = 13, /* remove from archive */
982 HUA_CANCEL = 14 /* cancel a request */
985 static inline const char *hsm_user_action2name(enum hsm_user_action a)
988 case HUA_NONE: return "NOOP";
989 case HUA_ARCHIVE: return "ARCHIVE";
990 case HUA_RESTORE: return "RESTORE";
991 case HUA_RELEASE: return "RELEASE";
992 case HUA_REMOVE: return "REMOVE";
993 case HUA_CANCEL: return "CANCEL";
994 default: return "UNKNOWN";
999 * List of hr_flags (bit field)
1001 #define HSM_FORCE_ACTION 0x0001
1002 /* used by CT, connot be set by user */
1003 #define HSM_GHOST_COPY 0x0002
1006 * Contains all the fixed part of struct hsm_user_request.
1009 struct hsm_request {
1010 __u32 hr_action; /* enum hsm_user_action */
1011 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1012 __u64 hr_flags; /* request flags */
1013 __u32 hr_itemcount; /* item count in hur_user_item vector */
1017 struct hsm_user_item {
1019 struct hsm_extent hui_extent;
1020 } __attribute__((packed));
1022 struct hsm_user_request {
1023 struct hsm_request hur_request;
1024 struct hsm_user_item hur_user_item[0];
1025 /* extra data blob at end of struct (after all
1026 * hur_user_items), only use helpers to access it
1028 } __attribute__((packed));
1030 /** Return pointer to data field in a hsm user request */
1031 static inline void *hur_data(struct hsm_user_request *hur)
1033 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1036 /** Compute the current length of the provided hsm_user_request. */
1037 static inline int hur_len(struct hsm_user_request *hur)
1039 return offsetof(struct hsm_user_request, hur_user_item[0]) +
1040 hur->hur_request.hr_itemcount * sizeof(hur->hur_user_item[0]) +
1041 hur->hur_request.hr_data_len;
1044 /****** HSM RPCs to copytool *****/
1045 /* Message types the copytool may receive */
1046 enum hsm_message_type {
1047 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1050 /* Actions the copytool may be instructed to take for a given action_item */
1051 enum hsm_copytool_action {
1052 HSMA_NONE = 10, /* no action */
1053 HSMA_ARCHIVE = 20, /* arbitrary offset */
1059 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1062 case HSMA_NONE: return "NOOP";
1063 case HSMA_ARCHIVE: return "ARCHIVE";
1064 case HSMA_RESTORE: return "RESTORE";
1065 case HSMA_REMOVE: return "REMOVE";
1066 case HSMA_CANCEL: return "CANCEL";
1067 default: return "UNKNOWN";
1071 /* Copytool item action description */
1072 struct hsm_action_item {
1073 __u32 hai_len; /* valid size of this struct */
1074 __u32 hai_action; /* hsm_copytool_action, but use known size */
1075 lustre_fid hai_fid; /* Lustre FID to operated on */
1076 lustre_fid hai_dfid; /* fid used for data access */
1077 struct hsm_extent hai_extent; /* byte range to operate on */
1078 __u64 hai_cookie; /* action cookie from coordinator */
1079 __u64 hai_gid; /* grouplock id */
1080 char hai_data[0]; /* variable length */
1081 } __attribute__((packed));
1084 * helper function which print in hexa the first bytes of
1086 * \param hai [IN] record to print
1087 * \param buffer [OUT] output buffer
1088 * \param len [IN] max buffer len
1091 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1092 char *buffer, int len)
1094 int i, sz, data_len;
1099 data_len = hai->hai_len - sizeof(*hai);
1100 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1104 cnt = snprintf(ptr, sz, "%.2X",
1105 (unsigned char)hai->hai_data[i]);
1113 /* Copytool action list */
1114 #define HAL_VERSION 1
1115 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1116 struct hsm_action_list {
1118 __u32 hal_count; /* number of hai's to follow */
1119 __u64 hal_compound_id; /* returned by coordinator */
1121 __u32 hal_archive_id; /* which archive backend */
1123 char hal_fsname[0]; /* null-terminated */
1124 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1125 boundaries. See hai_zero */
1126 } __attribute__((packed));
1128 #ifndef HAVE_CFS_SIZE_ROUND
1129 static inline int cfs_size_round (int val)
1131 return (val + 7) & (~0x7);
1133 #define HAVE_CFS_SIZE_ROUND
1136 /* Return pointer to first hai in action list */
1137 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1139 return (struct hsm_action_item *)(hal->hal_fsname +
1140 cfs_size_round(strlen(hal-> \
1143 /* Return pointer to next hai */
1144 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1146 return (struct hsm_action_item *)((char *)hai +
1147 cfs_size_round(hai->hai_len));
1150 /* Return size of an hsm_action_list */
1151 static inline size_t hal_size(struct hsm_action_list *hal)
1155 struct hsm_action_item *hai;
1157 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1158 hai = hai_first(hal);
1159 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1160 sz += cfs_size_round(hai->hai_len);
1166 * describe the attributes to be set on imported file
1168 struct hsm_user_import {
1177 __u32 hui_archive_id;
1180 /* Copytool progress reporting */
1181 #define HP_FLAG_COMPLETED 0x01
1182 #define HP_FLAG_RETRY 0x02
1184 struct hsm_progress {
1187 struct hsm_extent hp_extent;
1189 __u16 hp_errval; /* positive val */
1194 __u64 hc_data_version;
1196 __u16 hc_errval; /* positive val */
1198 struct hsm_action_item hc_hai;
1201 /** @} lustreuser */
1203 #endif /* _LUSTRE_USER_H */