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 */
112 * The ioctl naming rules:
113 * LL_* - works on the currently opened filehandle instead of parent dir
114 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
115 * *_MDC_* - gets/sets data related to MDC
116 * *_LOV_* - gets/sets data related to OSC/LOV
117 * *FILE* - called on parent dir and passes in a filename
118 * *STRIPE* - set/get lov_user_md
119 * *INFO - set/get lov_user_mds_data
121 /* see <lustre_lib.h> for ioctl numberss 101-150 */
122 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
123 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
124 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
125 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
126 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
127 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
128 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
129 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
130 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
131 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
132 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
133 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
134 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
135 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
136 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
137 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
138 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
139 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
140 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
141 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
142 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
143 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
144 #define LL_IOC_RMTACL _IOW ('f', 167, long)
145 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
146 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
147 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
148 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
149 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
150 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
151 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
152 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
153 #define LL_IOC_HSM_CT_START _IOW ('f', 176,struct lustre_kernelcomm)
154 /* see <lustre_lib.h> for ioctl numbers 177-210 */
156 #define LL_IOC_DATA_VERSION _IOR ('f', 218, struct ioc_data_version)
158 #define LL_STATFS_LMV 1
159 #define LL_STATFS_LOV 2
161 #define IOC_MDC_TYPE 'i'
162 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
163 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
164 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
165 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
167 /* Keep these for backward compartability. */
168 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
169 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
172 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
174 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
175 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
176 * which was added since kernel 2.6.36, so we redefine it as 020000000.
177 * To be compatible with old version's statically linked binary, finally we
178 * define it as (020000000 | 0100000000).
180 #define O_LOV_DELAY_CREATE 0120000000
182 #define LL_FILE_IGNORE_LOCK 0x00000001
183 #define LL_FILE_GROUP_LOCKED 0x00000002
184 #define LL_FILE_READAHEA 0x00000004
185 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
186 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
187 #define LL_FILE_RMTACL 0x00000020
189 #define LOV_USER_MAGIC_V1 0x0BD10BD0
190 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
191 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
192 #define LOV_USER_MAGIC_V3 0x0BD30BD0
194 #define LOV_PATTERN_RAID0 0x001
195 #define LOV_PATTERN_RAID1 0x002
196 #define LOV_PATTERN_FIRST 0x100
198 #define LOV_MAXPOOLNAME 16
199 #define LOV_POOLNAMEF "%.16s"
201 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
202 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
203 #define LOV_MAX_STRIPE_COUNT_OLD 160
204 /* This calculation is crafted so that input of 4096 will result in 160
205 * which in turn is equal to old maximal stripe count.
206 * XXX: In fact this is too simpified for now, what it also need is to get
207 * ea_type argument to clearly know how much space each stripe consumes.
209 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
210 * allocation that is sufficient for the current generation of systems.
212 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
213 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
214 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
215 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
217 #define lov_user_ost_data lov_user_ost_data_v1
218 struct lov_user_ost_data_v1 { /* per-stripe data structure */
219 __u64 l_object_id; /* OST object ID */
220 __u64 l_object_seq; /* OST object seq number */
221 __u32 l_ost_gen; /* generation of this OST index */
222 __u32 l_ost_idx; /* OST index in LOV */
223 } __attribute__((packed));
225 #define lov_user_md lov_user_md_v1
226 #define lmm_stripe_offset u.lum_stripe_offset
227 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
228 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
229 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
230 __u64 lmm_object_id; /* LOV object ID */
231 __u64 lmm_object_seq; /* LOV object seq */
232 __u32 lmm_stripe_size; /* size of stripe in bytes */
233 __u16 lmm_stripe_count; /* num stripes in use for this object */
235 __u16 lum_stripe_offset; /* starting stripe offset in
236 * lmm_objects, use when writing */
237 __u16 lum_layout_gen; /* layout generation number
238 * used when reading */
240 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
241 } __attribute__((packed, __may_alias__));
243 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
244 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
245 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
246 __u64 lmm_object_id; /* LOV object ID */
247 __u64 lmm_object_seq; /* LOV object seq */
248 __u32 lmm_stripe_size; /* size of stripe in bytes */
249 __u16 lmm_stripe_count; /* num stripes in use for this object */
251 __u16 lum_stripe_offset; /* starting stripe offset in
252 * lmm_objects, use when writing */
253 __u16 lum_layout_gen; /* layout generation number
254 * used when reading */
256 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
257 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
258 } __attribute__((packed));
260 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
261 * use this. It is unsafe to #define those values in this header as it
262 * is possible the application has already #included <sys/stat.h>. */
263 #ifdef HAVE_LOV_USER_MDS_DATA
264 #define lov_user_mds_data lov_user_mds_data_v1
265 struct lov_user_mds_data_v1 {
266 lstat_t lmd_st; /* MDS stat struct */
267 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
268 } __attribute__((packed));
270 struct lov_user_mds_data_v3 {
271 lstat_t lmd_st; /* MDS stat struct */
272 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
273 } __attribute__((packed));
276 struct ll_recreate_obj {
282 __u64 id; /* holds object id */
283 __u32 generation; /* holds object generation */
284 __u32 f_type; /* holds object type or stripe idx when passing it to
285 * OST for saving into EA. */
293 static inline int obd_uuid_equals(const struct obd_uuid *u1,
294 const struct obd_uuid *u2)
296 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
299 static inline int obd_uuid_empty(struct obd_uuid *uuid)
301 return uuid->uuid[0] == '\0';
304 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
306 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
307 uuid->uuid[sizeof(*uuid) - 1] = '\0';
310 /* For printf's only, make sure uuid is terminated */
311 static inline char *obd_uuid2str(struct obd_uuid *uuid)
313 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
314 /* Obviously not safe, but for printfs, no real harm done...
315 we're always null-terminated, even in a race. */
316 static char temp[sizeof(*uuid)];
317 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
318 temp[sizeof(*uuid) - 1] = '\0';
321 return (char *)(uuid->uuid);
324 /* Extract fsname from uuid (or target name) of a target
325 e.g. (myfs-OST0007_UUID -> myfs)
326 see also deuuidify. */
327 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
331 strncpy(buf, uuid, buflen - 1);
332 buf[buflen - 1] = '\0';
333 p = strrchr(buf, '-');
341 * FID is a cluster-wide unique identifier of a file or an object (stripe).
342 * FIDs are never reused.
346 * FID sequence. Sequence is a unit of migration: all files (objects)
347 * with FIDs from a given sequence are stored on the same server.
348 * Lustre should support 2^64 objects, so even if each sequence
349 * has only a single object we can still enumerate 2^64 objects.
352 /** FID number within sequence. */
355 * FID version, used to distinguish different versions (in the sense
356 * of snapshots, etc.) of the same file system object. Not currently
363 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
368 /* Userspace should treat lu_fid as opaque, and only use the following methods
369 to print or parse them. Other functions (e.g. compare, swab) could be moved
370 here from lustre_idl.h if needed. */
371 typedef struct lu_fid lustre_fid;
373 /* printf display format
374 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
375 #define DFID_NOBRACE LPX64":0x%x:0x%x"
376 #define DFID "["DFID_NOBRACE"]"
382 /* scanf input parse format -- strip '[' first.
383 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
384 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
385 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
386 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
388 #define SFID "0x"LPX64i":0x%x:0x%x"
395 /********* Quotas **********/
397 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
398 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
399 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
400 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
401 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
402 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
403 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
404 /* lustre-specific control commands */
405 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
406 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
408 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
410 struct if_quotacheck {
412 struct obd_uuid obd_uuid;
415 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
418 #define N_PERMS_MAX 64
420 struct perm_downcall_data {
426 struct identity_downcall_data {
433 struct perm_downcall_data idd_perms[N_PERMS_MAX];
437 /* for non-mapped uid/gid */
438 #define NOBODY_UID 99
439 #define NOBODY_GID 99
441 #define INVALID_ID (-1)
450 #ifdef NEED_QUOTA_DEFS
452 #define QIF_BLIMITS 1
454 #define QIF_ILIMITS 4
458 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
459 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
460 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
461 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
464 #endif /* !__KERNEL__ */
466 typedef enum lustre_quota_version {
468 } lustre_quota_version_t;
470 /* XXX: same as if_dqinfo struct in kernel */
478 /* XXX: same as if_dqblk struct in kernel, plus one padding */
480 __u64 dqb_bhardlimit;
481 __u64 dqb_bsoftlimit;
483 __u64 dqb_ihardlimit;
484 __u64 dqb_isoftlimit;
506 struct obd_dqinfo qc_dqinfo;
507 struct obd_dqblk qc_dqblk;
509 struct obd_uuid obd_uuid;
513 /********* Changelogs **********/
514 /** Changelog record types */
515 enum changelog_rec_type {
517 CL_CREATE = 1, /* namespace */
518 CL_MKDIR = 2, /* namespace */
519 CL_HARDLINK = 3, /* namespace */
520 CL_SOFTLINK = 4, /* namespace */
521 CL_MKNOD = 5, /* namespace */
522 CL_UNLINK = 6, /* namespace */
523 CL_RMDIR = 7, /* namespace */
524 CL_RENAME = 8, /* namespace */
525 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
526 CL_OPEN = 10, /* not currently used */
527 CL_CLOSE = 11, /* may be written to log only with mtime change */
532 CL_HSM = 16, /* HSM specific events, see flags */
533 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
539 static inline const char *changelog_type2str(int type) {
540 static const char *changelog_str[] = {
541 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
542 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
543 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME" };
544 if (type >= 0 && type < CL_LAST)
545 return changelog_str[type];
549 /* per-record flags */
550 #define CLF_VERSION 0x1000
551 #define CLF_EXT_VERSION 0x2000
552 #define CLF_FLAGSHIFT 12
553 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
554 #define CLF_VERMASK (~CLF_FLAGMASK)
555 /* Anything under the flagmask may be per-type (if desired) */
556 /* Flags for unlink */
557 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
558 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
559 /* HSM cleaning needed */
560 /* Flags for rename */
561 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */
564 /* 12b used (from high weight to low weight):
569 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
570 #define CLF_HSM_ERR_H 6
571 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
572 #define CLF_HSM_EVENT_H 9
573 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
574 #define CLF_HSM_FLAG_H 11
575 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
576 #define CLF_HSM_SPARE_H 15
577 #define CLF_HSM_LAST 15
579 /* Remove bits higher than _h, then extract the value
580 * between _h and _l by shifting lower weigth to bit 0. */
581 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
582 >> (CLF_HSM_LAST - _h + _l))
584 #define CLF_HSM_SUCCESS 0x00
585 #define CLF_HSM_MAXERROR 0x7E
586 #define CLF_HSM_ERROVERFLOW 0x7F
588 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
590 /* 3 bits field => 8 values allowed */
602 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
604 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
607 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
609 *flags |= (he << CLF_HSM_EVENT_L);
612 static inline __u16 hsm_get_cl_flags(int flags)
614 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
617 static inline void hsm_set_cl_flags(int *flags, int bits)
619 *flags |= (bits << CLF_HSM_FLAG_L);
622 static inline int hsm_get_cl_error(int flags)
624 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
627 static inline void hsm_set_cl_error(int *flags, int error)
629 *flags |= (error << CLF_HSM_ERR_L);
632 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
634 struct changelog_rec {
636 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
637 __u32 cr_type; /**< \a changelog_rec_type */
638 __u64 cr_index; /**< changelog record number */
639 __u64 cr_prev; /**< last index for this target fid */
642 lustre_fid cr_tfid; /**< target fid */
643 __u32 cr_markerflags; /**< CL_MARK flags */
645 lustre_fid cr_pfid; /**< parent fid */
646 char cr_name[0]; /**< last element */
647 } __attribute__((packed));
649 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
650 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
653 struct changelog_ext_rec {
655 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
657 __u32 cr_type; /**< \a changelog_rec_type */
658 __u64 cr_index; /**< changelog record number */
659 __u64 cr_prev; /**< last index for this target fid */
662 lustre_fid cr_tfid; /**< target fid */
663 __u32 cr_markerflags; /**< CL_MARK flags */
665 lustre_fid cr_pfid; /**< target parent fid */
666 lustre_fid cr_sfid; /**< source fid, or zero */
667 lustre_fid cr_spfid; /**< source parent fid, or zero */
668 char cr_name[0]; /**< last element */
669 } __attribute__((packed));
671 #define CHANGELOG_REC_EXTENDED(rec) \
672 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
674 static inline int changelog_rec_size(struct changelog_rec *rec)
676 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
680 static inline char *changelog_rec_name(struct changelog_rec *rec)
682 return CHANGELOG_REC_EXTENDED(rec) ?
683 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
686 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
688 LASSERT(CHANGELOG_REC_EXTENDED(rec));
689 return rec->cr_namelen - strlen(rec->cr_name) - 1;
692 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
694 LASSERT(CHANGELOG_REC_EXTENDED(rec));
695 return rec->cr_name + strlen(rec->cr_name) + 1;
698 struct ioc_changelog {
705 enum changelog_message_type {
706 CL_RECORD = 10, /* message is a changelog_rec */
707 CL_EOF = 11, /* at end of current changelog */
710 /********* Misc **********/
712 struct ioc_data_version {
714 __u64 idv_flags; /* See LL_DV_xxx */
716 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
717 version. Dirty caches are left unchanged. */
720 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
723 #define dot_lustre_name ".lustre"
726 /********* HSM **********/
728 /** HSM per-file state
729 * See HSM_FLAGS below.
732 HS_EXISTS = 0x00000001,
733 HS_DIRTY = 0x00000002,
734 HS_RELEASED = 0x00000004,
735 HS_ARCHIVED = 0x00000008,
736 HS_NORELEASE = 0x00000010,
737 HS_NOARCHIVE = 0x00000020,
738 HS_LOST = 0x00000040,
741 /* HSM user-setable flags. */
742 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
744 /* Other HSM flags. */
745 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
748 * All HSM-related possible flags that could be applied to a file.
749 * This should be kept in sync with hsm_states.
751 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
754 * HSMÂ request progress state
756 enum hsm_progress_states {
763 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
766 case HPS_WAITING: return "waiting";
767 case HPS_RUNNING: return "running";
768 case HPS_DONE: return "done";
769 default: return "unknown";
776 } __attribute__((packed));
779 * Current HSM states of a Lustre file.
781 * This structure purpose is to be sent to user-space mainly. It describes the
782 * current HSM flags and in-progress action.
784 struct hsm_user_state {
785 /** Current HSM states, from enum hsm_states. */
787 __u32 hus_archive_num;
788 /** The current undergoing action, if there is one */
789 __u32 hus_in_progress_state;
790 __u32 hus_in_progress_action;
791 struct hsm_extent hus_in_progress_location;
792 char hus_extended_info[];
795 struct hsm_state_set_ioc {
796 struct lu_fid hssi_fid;
798 __u64 hssi_clearmask;
801 /***** HSM user requests ******/
802 /* User-generated (lfs/ioctl) request types */
803 enum hsm_user_action {
804 HUA_NONE = 1, /* no action (noop) */
805 HUA_ARCHIVE = 10, /* copy to hsm */
806 HUA_RESTORE = 11, /* prestage */
807 HUA_RELEASE = 12, /* drop ost objects */
808 HUA_REMOVE = 13, /* remove from archive */
809 HUA_CANCEL = 14 /* cancel a request */
812 static inline char *hsm_user_action2name(enum hsm_user_action a)
815 case HUA_NONE: return "NOOP";
816 case HUA_ARCHIVE: return "ARCHIVE";
817 case HUA_RESTORE: return "RESTORE";
818 case HUA_RELEASE: return "RELEASE";
819 case HUA_REMOVE: return "REMOVE";
820 case HUA_CANCEL: return "CANCEL";
821 default: return "UNKNOWN";
825 struct hsm_user_item {
827 struct hsm_extent hui_extent;
828 } __attribute__((packed));
830 struct hsm_user_request {
831 __u32 hur_action; /* enum hsm_user_action */
832 __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
835 struct hsm_user_item hur_user_item[0];
836 /* extra data blob at end of struct (after all
837 * hur_user_items), only use helpers to access it
839 } __attribute__((packed));
841 /** Return pointer to data field in a hsm user request */
842 static inline void *hur_data(struct hsm_user_request *hur)
844 return &(hur->hur_user_item[hur->hur_itemcount]);
847 /** Compute the current length of the provided hsm_user_request. */
848 static inline int hur_len(struct hsm_user_request *hur)
852 data_offset = hur_data(hur) - (void *)hur;
853 return (data_offset + hur->hur_data_len);
856 /****** HSM RPCs to copytool *****/
857 /* Message types the copytool may receive */
858 enum hsm_message_type {
859 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
862 /* Actions the copytool may be instructed to take for a given action_item */
863 enum hsm_copytool_action {
864 HSMA_NONE = 10, /* no action */
865 HSMA_ARCHIVE = 20, /* arbitrary offset */
871 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
874 case HSMA_NONE: return "NOOP";
875 case HSMA_ARCHIVE: return "ARCHIVE";
876 case HSMA_RESTORE: return "RESTORE";
877 case HSMA_REMOVE: return "REMOVE";
878 case HSMA_CANCEL: return "CANCEL";
879 default: return "UNKNOWN";
883 /* Copytool item action description */
884 struct hsm_action_item {
885 __u32 hai_len; /* valid size of this struct */
886 __u32 hai_action; /* hsm_copytool_action, but use known size */
887 lustre_fid hai_fid; /* Lustre FID to operated on */
888 struct hsm_extent hai_extent; /* byte range to operate on */
889 __u64 hai_cookie; /* action cookie from coordinator */
890 __u64 hai_gid; /* grouplock id */
891 char hai_data[0]; /* variable length */
892 } __attribute__((packed));
895 * helper function which print in hexa the first bytes of
897 * \param hai [IN] record to print
898 * \param buffer [OUT] output buffer
899 * \param len [IN] max buffer len
902 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
903 char *buffer, int len)
910 data_len = hai->hai_len - sizeof(*hai);
911 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
915 cnt = snprintf(ptr, sz, "%.2X",
916 (unsigned char)hai->hai_data[i]);
924 /* Copytool action list */
925 #define HAL_VERSION 1
926 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
927 struct hsm_action_list {
929 __u32 hal_count; /* number of hai's to follow */
930 __u64 hal_compound_id; /* returned by coordinator */
931 __u32 hal_archive_num; /* which archive backend */
933 char hal_fsname[0]; /* null-terminated */
934 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
935 boundaries. See hai_zero */
936 } __attribute__((packed));
938 #ifndef HAVE_CFS_SIZE_ROUND
939 static inline int cfs_size_round (int val)
941 return (val + 7) & (~0x7);
943 #define HAVE_CFS_SIZE_ROUND
946 /* Return pointer to first hai in action list */
947 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
949 return (struct hsm_action_item *)(hal->hal_fsname +
950 cfs_size_round(strlen(hal-> \
953 /* Return pointer to next hai */
954 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
956 return (struct hsm_action_item *)((char *)hai +
957 cfs_size_round(hai->hai_len));
960 /* Return size of an hsm_action_list */
961 static inline int hal_size(struct hsm_action_list *hal)
964 struct hsm_action_item *hai;
966 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
968 for (i = 0 ; i < hal->hal_count ; i++) {
969 sz += cfs_size_round(hai->hai_len);
975 /* Copytool progress reporting */
976 #define HP_FLAG_COMPLETED 0x01
977 #define HP_FLAG_RETRY 0x02
979 struct hsm_progress {
982 struct hsm_extent hp_extent;
984 __u16 hp_errval; /* positive val */
985 } __attribute__((packed));
989 #endif /* _LUSTRE_USER_H */