4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2010, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_user.h
38 * Lustre public user-space interface definitions.
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
44 /** \defgroup lustreuser lustreuser
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)
156 /* see <lustre_lib.h> for ioctl numbers 177-210 */
158 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
159 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
160 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
161 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
162 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
163 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
164 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
165 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
166 /* 219 is reserved for swap layouts */
167 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
168 struct hsm_current_action)
169 /* see <lustre_lib.h> for ioctl numbers 221-232 */
171 #define LL_STATFS_LMV 1
172 #define LL_STATFS_LOV 2
173 #define LL_STATFS_NODELAY 4
175 #define IOC_MDC_TYPE 'i'
176 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
177 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
178 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
179 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
181 /* Keep these for backward compartability. */
182 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
183 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
186 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
188 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
189 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
190 * which was added since kernel 2.6.36, so we redefine it as 020000000.
191 * To be compatible with old version's statically linked binary, finally we
192 * define it as (020000000 | 0100000000).
194 #define O_LOV_DELAY_CREATE 0120000000
196 #define LL_FILE_IGNORE_LOCK 0x00000001
197 #define LL_FILE_GROUP_LOCKED 0x00000002
198 #define LL_FILE_READAHEA 0x00000004
199 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
200 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
201 #define LL_FILE_RMTACL 0x00000020
203 #define LOV_USER_MAGIC_V1 0x0BD10BD0
204 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
205 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
206 #define LOV_USER_MAGIC_V3 0x0BD30BD0
208 #define LOV_PATTERN_RAID0 0x001
209 #define LOV_PATTERN_RAID1 0x002
210 #define LOV_PATTERN_FIRST 0x100
212 #define LOV_MAXPOOLNAME 16
213 #define LOV_POOLNAMEF "%.16s"
215 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
216 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
217 #define LOV_MAX_STRIPE_COUNT_OLD 160
218 /* This calculation is crafted so that input of 4096 will result in 160
219 * which in turn is equal to old maximal stripe count.
220 * XXX: In fact this is too simpified for now, what it also need is to get
221 * ea_type argument to clearly know how much space each stripe consumes.
223 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
224 * allocation that is sufficient for the current generation of systems.
226 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
227 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
228 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
229 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
231 #define lov_user_ost_data lov_user_ost_data_v1
232 struct lov_user_ost_data_v1 { /* per-stripe data structure */
233 __u64 l_object_id; /* OST object ID */
234 __u64 l_object_seq; /* OST object seq number */
235 __u32 l_ost_gen; /* generation of this OST index */
236 __u32 l_ost_idx; /* OST index in LOV */
237 } __attribute__((packed));
239 #define lov_user_md lov_user_md_v1
240 #define lmm_stripe_offset u.lum_stripe_offset
241 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
242 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
243 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
244 __u64 lmm_object_id; /* LOV object ID */
245 __u64 lmm_object_seq; /* LOV object seq */
246 __u32 lmm_stripe_size; /* size of stripe in bytes */
247 __u16 lmm_stripe_count; /* num stripes in use for this object */
249 __u16 lum_stripe_offset; /* starting stripe offset in
250 * lmm_objects, use when writing */
251 __u16 lum_layout_gen; /* layout generation number
252 * used when reading */
254 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
255 } __attribute__((packed, __may_alias__));
257 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
258 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
259 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
260 __u64 lmm_object_id; /* LOV object ID */
261 __u64 lmm_object_seq; /* LOV object seq */
262 __u32 lmm_stripe_size; /* size of stripe in bytes */
263 __u16 lmm_stripe_count; /* num stripes in use for this object */
265 __u16 lum_stripe_offset; /* starting stripe offset in
266 * lmm_objects, use when writing */
267 __u16 lum_layout_gen; /* layout generation number
268 * used when reading */
270 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
271 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
272 } __attribute__((packed));
274 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
275 * use this. It is unsafe to #define those values in this header as it
276 * is possible the application has already #included <sys/stat.h>. */
277 #ifdef HAVE_LOV_USER_MDS_DATA
278 #define lov_user_mds_data lov_user_mds_data_v1
279 struct lov_user_mds_data_v1 {
280 lstat_t lmd_st; /* MDS stat struct */
281 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
282 } __attribute__((packed));
284 struct lov_user_mds_data_v3 {
285 lstat_t lmd_st; /* MDS stat struct */
286 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
287 } __attribute__((packed));
290 struct ll_recreate_obj {
296 __u64 id; /* holds object id */
297 __u32 generation; /* holds object generation */
298 __u32 f_type; /* holds object type or stripe idx when passing it to
299 * OST for saving into EA. */
307 static inline int obd_uuid_equals(const struct obd_uuid *u1,
308 const struct obd_uuid *u2)
310 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
313 static inline int obd_uuid_empty(struct obd_uuid *uuid)
315 return uuid->uuid[0] == '\0';
318 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
320 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
321 uuid->uuid[sizeof(*uuid) - 1] = '\0';
324 /* For printf's only, make sure uuid is terminated */
325 static inline char *obd_uuid2str(struct obd_uuid *uuid)
327 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
328 /* Obviously not safe, but for printfs, no real harm done...
329 we're always null-terminated, even in a race. */
330 static char temp[sizeof(*uuid)];
331 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
332 temp[sizeof(*uuid) - 1] = '\0';
335 return (char *)(uuid->uuid);
338 /* Extract fsname from uuid (or target name) of a target
339 e.g. (myfs-OST0007_UUID -> myfs)
340 see also deuuidify. */
341 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
345 strncpy(buf, uuid, buflen - 1);
346 buf[buflen - 1] = '\0';
347 p = strrchr(buf, '-');
355 * FID is a cluster-wide unique identifier of a file or an object (stripe).
356 * FIDs are never reused.
360 * FID sequence. Sequence is a unit of migration: all files (objects)
361 * with FIDs from a given sequence are stored on the same server.
362 * Lustre should support 2^64 objects, so even if each sequence
363 * has only a single object we can still enumerate 2^64 objects.
366 /** FID number within sequence. */
369 * FID version, used to distinguish different versions (in the sense
370 * of snapshots, etc.) of the same file system object. Not currently
377 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
382 /* Userspace should treat lu_fid as opaque, and only use the following methods
383 to print or parse them. Other functions (e.g. compare, swab) could be moved
384 here from lustre_idl.h if needed. */
385 typedef struct lu_fid lustre_fid;
387 /* printf display format
388 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
389 #define DFID_NOBRACE LPX64":0x%x:0x%x"
390 #define DFID "["DFID_NOBRACE"]"
396 /* scanf input parse format -- strip '[' first.
397 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
398 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
399 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
400 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
402 #define SFID "0x"LPX64i":0x%x:0x%x"
409 /********* Quotas **********/
411 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
412 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
413 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
414 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
415 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
416 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
417 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
418 /* lustre-specific control commands */
419 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
420 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
422 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
424 struct if_quotacheck {
426 struct obd_uuid obd_uuid;
429 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
432 #define N_PERMS_MAX 64
434 struct perm_downcall_data {
440 struct identity_downcall_data {
447 struct perm_downcall_data idd_perms[N_PERMS_MAX];
451 /* for non-mapped uid/gid */
452 #define NOBODY_UID 99
453 #define NOBODY_GID 99
455 #define INVALID_ID (-1)
464 #ifdef NEED_QUOTA_DEFS
466 #define QIF_BLIMITS 1
468 #define QIF_ILIMITS 4
472 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
473 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
474 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
475 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
478 #endif /* !__KERNEL__ */
480 /* lustre volatile file support
481 * file name header: .^L^S^T^R:volatile"
483 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
484 #define LUSTRE_VOLATILE_HDR_LEN 14
485 /* hdr + MDT index */
486 #define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:"
488 typedef enum lustre_quota_version {
490 } lustre_quota_version_t;
492 /* XXX: same as if_dqinfo struct in kernel */
500 /* XXX: same as if_dqblk struct in kernel, plus one padding */
502 __u64 dqb_bhardlimit;
503 __u64 dqb_bsoftlimit;
505 __u64 dqb_ihardlimit;
506 __u64 dqb_isoftlimit;
528 struct obd_dqinfo qc_dqinfo;
529 struct obd_dqblk qc_dqblk;
531 struct obd_uuid obd_uuid;
535 /********* Changelogs **********/
536 /** Changelog record types */
537 enum changelog_rec_type {
539 CL_CREATE = 1, /* namespace */
540 CL_MKDIR = 2, /* namespace */
541 CL_HARDLINK = 3, /* namespace */
542 CL_SOFTLINK = 4, /* namespace */
543 CL_MKNOD = 5, /* namespace */
544 CL_UNLINK = 6, /* namespace */
545 CL_RMDIR = 7, /* namespace */
546 CL_RENAME = 8, /* namespace */
547 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
548 CL_OPEN = 10, /* not currently used */
549 CL_CLOSE = 11, /* may be written to log only with mtime change */
554 CL_HSM = 16, /* HSM specific events, see flags */
555 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
561 static inline const char *changelog_type2str(int type) {
562 static const char *changelog_str[] = {
563 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
564 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
565 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME" };
566 if (type >= 0 && type < CL_LAST)
567 return changelog_str[type];
571 /* per-record flags */
572 #define CLF_VERSION 0x1000
573 #define CLF_EXT_VERSION 0x2000
574 #define CLF_FLAGSHIFT 12
575 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
576 #define CLF_VERMASK (~CLF_FLAGMASK)
577 /* Anything under the flagmask may be per-type (if desired) */
578 /* Flags for unlink */
579 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
580 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
581 /* HSM cleaning needed */
582 /* Flags for rename */
583 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */
586 /* 12b used (from high weight to low weight):
591 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
592 #define CLF_HSM_ERR_H 6
593 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
594 #define CLF_HSM_EVENT_H 9
595 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
596 #define CLF_HSM_FLAG_H 11
597 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
598 #define CLF_HSM_SPARE_H 15
599 #define CLF_HSM_LAST 15
601 /* Remove bits higher than _h, then extract the value
602 * between _h and _l by shifting lower weigth to bit 0. */
603 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
604 >> (CLF_HSM_LAST - _h + _l))
606 #define CLF_HSM_SUCCESS 0x00
607 #define CLF_HSM_MAXERROR 0x7E
608 #define CLF_HSM_ERROVERFLOW 0x7F
610 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
612 /* 3 bits field => 8 values allowed */
624 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
626 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
629 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
631 *flags |= (he << CLF_HSM_EVENT_L);
634 static inline __u16 hsm_get_cl_flags(int flags)
636 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
639 static inline void hsm_set_cl_flags(int *flags, int bits)
641 *flags |= (bits << CLF_HSM_FLAG_L);
644 static inline int hsm_get_cl_error(int flags)
646 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
649 static inline void hsm_set_cl_error(int *flags, int error)
651 *flags |= (error << CLF_HSM_ERR_L);
654 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
656 struct changelog_rec {
658 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
659 __u32 cr_type; /**< \a changelog_rec_type */
660 __u64 cr_index; /**< changelog record number */
661 __u64 cr_prev; /**< last index for this target fid */
664 lustre_fid cr_tfid; /**< target fid */
665 __u32 cr_markerflags; /**< CL_MARK flags */
667 lustre_fid cr_pfid; /**< parent fid */
668 char cr_name[0]; /**< last element */
669 } __attribute__((packed));
671 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
672 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
675 struct changelog_ext_rec {
677 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
679 __u32 cr_type; /**< \a changelog_rec_type */
680 __u64 cr_index; /**< changelog record number */
681 __u64 cr_prev; /**< last index for this target fid */
684 lustre_fid cr_tfid; /**< target fid */
685 __u32 cr_markerflags; /**< CL_MARK flags */
687 lustre_fid cr_pfid; /**< target parent fid */
688 lustre_fid cr_sfid; /**< source fid, or zero */
689 lustre_fid cr_spfid; /**< source parent fid, or zero */
690 char cr_name[0]; /**< last element */
691 } __attribute__((packed));
693 #define CHANGELOG_REC_EXTENDED(rec) \
694 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
696 static inline int changelog_rec_size(struct changelog_rec *rec)
698 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
702 static inline char *changelog_rec_name(struct changelog_rec *rec)
704 return CHANGELOG_REC_EXTENDED(rec) ?
705 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
708 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
710 return rec->cr_namelen - strlen(rec->cr_name) - 1;
713 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
715 return rec->cr_name + strlen(rec->cr_name) + 1;
718 struct ioc_changelog {
725 enum changelog_message_type {
726 CL_RECORD = 10, /* message is a changelog_rec */
727 CL_EOF = 11, /* at end of current changelog */
730 /********* Misc **********/
732 struct ioc_data_version {
734 __u64 idv_flags; /* See LL_DV_xxx */
736 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
737 version. Dirty caches are left unchanged. */
740 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
743 #define dot_lustre_name ".lustre"
746 /********* HSM **********/
748 /** HSM per-file state
749 * See HSM_FLAGS below.
752 HS_EXISTS = 0x00000001,
753 HS_DIRTY = 0x00000002,
754 HS_RELEASED = 0x00000004,
755 HS_ARCHIVED = 0x00000008,
756 HS_NORELEASE = 0x00000010,
757 HS_NOARCHIVE = 0x00000020,
758 HS_LOST = 0x00000040,
761 /* HSM user-setable flags. */
762 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
764 /* Other HSM flags. */
765 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
768 * All HSM-related possible flags that could be applied to a file.
769 * This should be kept in sync with hsm_states.
771 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
774 * HSMÂ request progress state
776 enum hsm_progress_states {
783 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
786 case HPS_WAITING: return "waiting";
787 case HPS_RUNNING: return "running";
788 case HPS_DONE: return "done";
789 default: return "unknown";
796 } __attribute__((packed));
799 * Current HSM states of a Lustre file.
801 * This structure purpose is to be sent to user-space mainly. It describes the
802 * current HSM flags and in-progress action.
804 struct hsm_user_state {
805 /** Current HSM states, from enum hsm_states. */
807 __u32 hus_archive_id;
808 /** The current undergoing action, if there is one */
809 __u32 hus_in_progress_state;
810 __u32 hus_in_progress_action;
811 struct hsm_extent hus_in_progress_location;
812 char hus_extended_info[];
815 struct hsm_state_set_ioc {
816 struct lu_fid hssi_fid;
818 __u64 hssi_clearmask;
822 * This structure describes the current in-progress action for a file.
823 * it is retuned to user space and send over the wire
825 struct hsm_current_action {
826 /** The current undergoing action, if there is one */
827 /* state is one of hsm_progress_states */
829 /* action is one of hsm_user_action */
831 struct hsm_extent hca_location;
834 /***** HSM user requests ******/
835 /* User-generated (lfs/ioctl) request types */
836 enum hsm_user_action {
837 HUA_NONE = 1, /* no action (noop) */
838 HUA_ARCHIVE = 10, /* copy to hsm */
839 HUA_RESTORE = 11, /* prestage */
840 HUA_RELEASE = 12, /* drop ost objects */
841 HUA_REMOVE = 13, /* remove from archive */
842 HUA_CANCEL = 14 /* cancel a request */
845 static inline char *hsm_user_action2name(enum hsm_user_action a)
848 case HUA_NONE: return "NOOP";
849 case HUA_ARCHIVE: return "ARCHIVE";
850 case HUA_RESTORE: return "RESTORE";
851 case HUA_RELEASE: return "RELEASE";
852 case HUA_REMOVE: return "REMOVE";
853 case HUA_CANCEL: return "CANCEL";
854 default: return "UNKNOWN";
858 struct hsm_user_item {
860 struct hsm_extent hui_extent;
861 } __attribute__((packed));
863 struct hsm_user_request {
864 __u32 hur_action; /* enum hsm_user_action */
865 __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
868 struct hsm_user_item hur_user_item[0];
869 /* extra data blob at end of struct (after all
870 * hur_user_items), only use helpers to access it
872 } __attribute__((packed));
874 /** Return pointer to data field in a hsm user request */
875 static inline void *hur_data(struct hsm_user_request *hur)
877 return &(hur->hur_user_item[hur->hur_itemcount]);
880 /** Compute the current length of the provided hsm_user_request. */
881 static inline int hur_len(struct hsm_user_request *hur)
885 data_offset = hur_data(hur) - (void *)hur;
886 return (data_offset + hur->hur_data_len);
889 /****** HSM RPCs to copytool *****/
890 /* Message types the copytool may receive */
891 enum hsm_message_type {
892 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
895 /* Actions the copytool may be instructed to take for a given action_item */
896 enum hsm_copytool_action {
897 HSMA_NONE = 10, /* no action */
898 HSMA_ARCHIVE = 20, /* arbitrary offset */
904 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
907 case HSMA_NONE: return "NOOP";
908 case HSMA_ARCHIVE: return "ARCHIVE";
909 case HSMA_RESTORE: return "RESTORE";
910 case HSMA_REMOVE: return "REMOVE";
911 case HSMA_CANCEL: return "CANCEL";
912 default: return "UNKNOWN";
916 /* Copytool item action description */
917 struct hsm_action_item {
918 __u32 hai_len; /* valid size of this struct */
919 __u32 hai_action; /* hsm_copytool_action, but use known size */
920 lustre_fid hai_fid; /* Lustre FID to operated on */
921 lustre_fid hai_dfid; /* fid used for data access */
922 struct hsm_extent hai_extent; /* byte range to operate on */
923 __u64 hai_cookie; /* action cookie from coordinator */
924 __u64 hai_gid; /* grouplock id */
925 char hai_data[0]; /* variable length */
926 } __attribute__((packed));
929 * helper function which print in hexa the first bytes of
931 * \param hai [IN] record to print
932 * \param buffer [OUT] output buffer
933 * \param len [IN] max buffer len
936 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
937 char *buffer, int len)
944 data_len = hai->hai_len - sizeof(*hai);
945 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
949 cnt = snprintf(ptr, sz, "%.2X",
950 (unsigned char)hai->hai_data[i]);
958 /* Copytool action list */
959 #define HAL_VERSION 1
960 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
961 struct hsm_action_list {
963 __u32 hal_count; /* number of hai's to follow */
964 __u64 hal_compound_id; /* returned by coordinator */
966 __u32 hal_archive_num; /* which archive backend */
968 char hal_fsname[0]; /* null-terminated */
969 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
970 boundaries. See hai_zero */
971 } __attribute__((packed));
973 #ifndef HAVE_CFS_SIZE_ROUND
974 static inline int cfs_size_round (int val)
976 return (val + 7) & (~0x7);
978 #define HAVE_CFS_SIZE_ROUND
981 /* Return pointer to first hai in action list */
982 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
984 return (struct hsm_action_item *)(hal->hal_fsname +
985 cfs_size_round(strlen(hal-> \
988 /* Return pointer to next hai */
989 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
991 return (struct hsm_action_item *)((char *)hai +
992 cfs_size_round(hai->hai_len));
995 /* Return size of an hsm_action_list */
996 static inline int hal_size(struct hsm_action_list *hal)
999 struct hsm_action_item *hai;
1001 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1002 hai = hai_zero(hal);
1003 for (i = 0 ; i < hal->hal_count ; i++) {
1004 sz += cfs_size_round(hai->hai_len);
1005 hai = hai_next(hai);
1010 /* Copytool progress reporting */
1011 #define HP_FLAG_COMPLETED 0x01
1012 #define HP_FLAG_RETRY 0x02
1014 struct hsm_progress {
1017 struct hsm_extent hp_extent;
1019 __u16 hp_errval; /* positive val */
1024 * Use by copytool during any hsm request they handled.
1025 * This structure is initialized by llapi_hsm_copy_start()
1026 * which is an helper over the ioctl() interface
1027 * Store Lustre, internal use only, data.
1030 __u64 hc_data_version;
1032 __u16 hc_errval; /* positive val */
1034 struct hsm_action_item hc_hai;
1037 /** @} lustreuser */
1039 #endif /* _LUSTRE_USER_H */