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
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
115 * FID is a cluster-wide unique identifier of a file or an object (stripe).
116 * FIDs are never reused.
120 * FID sequence. Sequence is a unit of migration: all files (objects)
121 * with FIDs from a given sequence are stored on the same server.
122 * Lustre should support 2^64 objects, so even if each sequence
123 * has only a single object we can still enumerate 2^64 objects.
126 /* FID number within sequence. */
129 * FID version, used to distinguish different versions (in the sense
130 * of snapshots, etc.) of the same file system object. Not currently
137 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
140 /* keep this one for compatibility */
141 struct filter_fid_old {
142 struct lu_fid ff_parent;
147 /* Userspace should treat lu_fid as opaque, and only use the following methods
148 * to print or parse them. Other functions (e.g. compare, swab) could be moved
149 * here from lustre_idl.h if needed. */
150 typedef struct lu_fid lustre_fid;
153 * Following struct for object attributes, that will be kept inode's EA.
154 * Introduced in 2.0 release (please see b15993, for details)
155 * Added to all objects since Lustre 2.4 as contains self FID
157 struct lustre_mdt_attrs {
159 * Bitfield for supported data in this structure. From enum lma_compat.
160 * lma_self_fid and lma_flags are always available.
164 * Per-file incompat feature list. Lustre version should support all
165 * flags set in this field. The supported feature mask is available in
169 /** FID of this inode */
170 struct lu_fid lma_self_fid;
174 * Prior to 2.4, the LMA structure also included SOM attributes which has since
175 * been moved to a dedicated xattr
176 * lma_flags was also removed because of lma_compat/incompat fields.
178 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
181 * OST object IDentifier.
189 struct lu_fid oi_fid;
193 #define DOSTID LPX64":"LPU64
194 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
197 * The ioctl naming rules:
198 * LL_* - works on the currently opened filehandle instead of parent dir
199 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
200 * *_MDC_* - gets/sets data related to MDC
201 * *_LOV_* - gets/sets data related to OSC/LOV
202 * *FILE* - called on parent dir and passes in a filename
203 * *STRIPE* - set/get lov_user_md
204 * *INFO - set/get lov_user_mds_data
206 /* see <lustre_lib.h> for ioctl numberss 101-150 */
207 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
208 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
209 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
210 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
211 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
212 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
213 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
214 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
215 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
216 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
217 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
218 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
219 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
220 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
221 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
222 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
223 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
224 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
225 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
226 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
227 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
228 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
229 #define LL_IOC_RMTACL _IOW ('f', 167, long)
230 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
231 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
232 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
233 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
234 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
235 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
236 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
237 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
239 /* see <lustre_lib.h> for ioctl numbers 177-210 */
241 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
242 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
243 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
244 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
245 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
246 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
247 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
248 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
249 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
250 struct lustre_swap_layouts)
251 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
252 struct hsm_current_action)
253 /* see <lustre_lib.h> for ioctl numbers 221-232 */
255 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
256 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
257 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
259 #define LL_STATFS_LMV 1
260 #define LL_STATFS_LOV 2
261 #define LL_STATFS_NODELAY 4
263 #define IOC_MDC_TYPE 'i'
264 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
265 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
266 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
267 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
269 /* Keep these for backward compartability. */
270 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
271 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
274 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
276 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
277 * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
278 * which was added since kernel 2.6.36, so we redefine it as 020000000.
279 * To be compatible with old version's statically linked binary, finally we
280 * define it as (020000000 | 0100000000).
282 #define O_LOV_DELAY_CREATE 0120000000
284 #define LL_FILE_IGNORE_LOCK 0x00000001
285 #define LL_FILE_GROUP_LOCKED 0x00000002
286 #define LL_FILE_READAHEA 0x00000004
287 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
288 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
289 #define LL_FILE_RMTACL 0x00000020
291 #define LOV_USER_MAGIC_V1 0x0BD10BD0
292 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
293 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
294 #define LOV_USER_MAGIC_V3 0x0BD30BD0
296 #define LMV_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */
297 #define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/
299 #define LOV_PATTERN_RAID0 0x001
300 #define LOV_PATTERN_RAID1 0x002
301 #define LOV_PATTERN_FIRST 0x100
303 #define LOV_MAXPOOLNAME 16
304 #define LOV_POOLNAMEF "%.16s"
306 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
307 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
308 #define LOV_MAX_STRIPE_COUNT_OLD 160
309 /* This calculation is crafted so that input of 4096 will result in 160
310 * which in turn is equal to old maximal stripe count.
311 * XXX: In fact this is too simpified for now, what it also need is to get
312 * ea_type argument to clearly know how much space each stripe consumes.
314 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
315 * allocation that is sufficient for the current generation of systems.
317 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
318 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
319 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
320 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
322 #define lov_user_ost_data lov_user_ost_data_v1
323 struct lov_user_ost_data_v1 { /* per-stripe data structure */
324 struct ost_id l_ost_oi; /* OST object ID */
325 __u32 l_ost_gen; /* generation of this OST index */
326 __u32 l_ost_idx; /* OST index in LOV */
327 } __attribute__((packed));
329 #define lov_user_md lov_user_md_v1
330 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
331 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
332 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
333 struct ost_id lmm_oi; /* LOV object ID */
334 __u32 lmm_stripe_size; /* size of stripe in bytes */
335 __u16 lmm_stripe_count; /* num stripes in use for this object */
337 __u16 lmm_stripe_offset; /* starting stripe offset in
338 * lmm_objects, use when writing */
339 __u16 lmm_layout_gen; /* layout generation number
340 * used when reading */
342 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
343 } __attribute__((packed, __may_alias__));
345 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
346 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
347 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
348 struct ost_id lmm_oi; /* LOV object ID */
349 __u32 lmm_stripe_size; /* size of stripe in bytes */
350 __u16 lmm_stripe_count; /* num stripes in use for this object */
352 __u16 lmm_stripe_offset; /* starting stripe offset in
353 * lmm_objects, use when writing */
354 __u16 lmm_layout_gen; /* layout generation number
355 * used when reading */
357 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
358 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
359 } __attribute__((packed));
361 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
362 * use this. It is unsafe to #define those values in this header as it
363 * is possible the application has already #included <sys/stat.h>. */
364 #ifdef HAVE_LOV_USER_MDS_DATA
365 #define lov_user_mds_data lov_user_mds_data_v1
366 struct lov_user_mds_data_v1 {
367 lstat_t lmd_st; /* MDS stat struct */
368 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
369 } __attribute__((packed));
371 struct lov_user_mds_data_v3 {
372 lstat_t lmd_st; /* MDS stat struct */
373 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
374 } __attribute__((packed));
377 /* keep this to be the same size as lov_user_ost_data_v1 */
378 struct lmv_user_mds_data {
379 struct lu_fid lum_fid;
387 LMV_DEFAULT_TYPE = 1,
390 #define lmv_user_md lmv_user_md_v1
391 struct lmv_user_md_v1 {
392 __u32 lum_magic; /* must be the first field */
393 __u32 lum_stripe_count; /* dirstripe count */
394 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
395 __u32 lum_hash_type; /* Dir stripe policy */
396 __u32 lum_type; /* LMV type: default or normal */
400 char lum_pool_name[LOV_MAXPOOLNAME];
401 struct lmv_user_mds_data lum_objects[0];
404 static inline int lmv_user_md_size(int stripes, int lmm_magic)
406 return sizeof(struct lmv_user_md) +
407 stripes * sizeof(struct lmv_user_mds_data);
410 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
412 struct ll_recreate_obj {
418 __u64 id; /* holds object id */
419 __u32 generation; /* holds object generation */
420 __u32 f_type; /* holds object type or stripe idx when passing it to
421 * OST for saving into EA. */
429 static inline int obd_uuid_equals(const struct obd_uuid *u1,
430 const struct obd_uuid *u2)
432 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
435 static inline int obd_uuid_empty(struct obd_uuid *uuid)
437 return uuid->uuid[0] == '\0';
440 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
442 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
443 uuid->uuid[sizeof(*uuid) - 1] = '\0';
446 /* For printf's only, make sure uuid is terminated */
447 static inline char *obd_uuid2str(struct obd_uuid *uuid)
449 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
450 /* Obviously not safe, but for printfs, no real harm done...
451 we're always null-terminated, even in a race. */
452 static char temp[sizeof(*uuid)];
453 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
454 temp[sizeof(*uuid) - 1] = '\0';
457 return (char *)(uuid->uuid);
460 /* Extract fsname from uuid (or target name) of a target
461 e.g. (myfs-OST0007_UUID -> myfs)
462 see also deuuidify. */
463 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
467 strncpy(buf, uuid, buflen - 1);
468 buf[buflen - 1] = '\0';
469 p = strrchr(buf, '-');
474 /* printf display format
475 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
476 #define DFID_NOBRACE LPX64":0x%x:0x%x"
477 #define DFID "["DFID_NOBRACE"]"
483 /* scanf input parse format -- strip '[' first.
484 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
485 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
486 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
487 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
489 #define SFID "0x"LPX64i":0x%x:0x%x"
496 /********* Quotas **********/
498 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
499 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
500 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
501 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
502 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
503 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
504 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
505 /* lustre-specific control commands */
506 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
507 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
509 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
511 struct if_quotacheck {
513 struct obd_uuid obd_uuid;
516 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
519 #define N_PERMS_MAX 64
521 struct perm_downcall_data {
527 struct identity_downcall_data {
534 struct perm_downcall_data idd_perms[N_PERMS_MAX];
538 /* for non-mapped uid/gid */
539 #define NOBODY_UID 99
540 #define NOBODY_GID 99
542 #define INVALID_ID (-1)
551 #ifdef NEED_QUOTA_DEFS
553 #define QIF_BLIMITS 1
555 #define QIF_ILIMITS 4
559 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
560 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
561 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
562 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
565 #endif /* !__KERNEL__ */
567 /* lustre volatile file support
568 * file name header: .^L^S^T^R:volatile"
570 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
571 #define LUSTRE_VOLATILE_HDR_LEN 14
572 /* hdr + MDT index */
573 #define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:"
575 typedef enum lustre_quota_version {
577 } lustre_quota_version_t;
579 /* XXX: same as if_dqinfo struct in kernel */
587 /* XXX: same as if_dqblk struct in kernel, plus one padding */
589 __u64 dqb_bhardlimit;
590 __u64 dqb_bsoftlimit;
592 __u64 dqb_ihardlimit;
593 __u64 dqb_isoftlimit;
615 struct obd_dqinfo qc_dqinfo;
616 struct obd_dqblk qc_dqblk;
618 struct obd_uuid obd_uuid;
621 /* swap layout flags */
622 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
623 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
624 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
625 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
626 struct lustre_swap_layouts {
635 /********* Changelogs **********/
636 /** Changelog record types */
637 enum changelog_rec_type {
639 CL_CREATE = 1, /* namespace */
640 CL_MKDIR = 2, /* namespace */
641 CL_HARDLINK = 3, /* namespace */
642 CL_SOFTLINK = 4, /* namespace */
643 CL_MKNOD = 5, /* namespace */
644 CL_UNLINK = 6, /* namespace */
645 CL_RMDIR = 7, /* namespace */
646 CL_RENAME = 8, /* namespace */
647 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
648 CL_OPEN = 10, /* not currently used */
649 CL_CLOSE = 11, /* may be written to log only with mtime change */
650 CL_LAYOUT = 12, /* file layout/striping modified */
654 CL_HSM = 16, /* HSM specific events, see flags */
655 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
661 static inline const char *changelog_type2str(int type) {
662 static const char *changelog_str[] = {
663 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
664 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
665 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME",
668 if (type >= 0 && type < CL_LAST)
669 return changelog_str[type];
673 /* per-record flags */
674 #define CLF_VERSION 0x1000
675 #define CLF_EXT_VERSION 0x2000
676 #define CLF_FLAGSHIFT 12
677 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
678 #define CLF_VERMASK (~CLF_FLAGMASK)
679 /* Anything under the flagmask may be per-type (if desired) */
680 /* Flags for unlink */
681 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
682 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
683 /* HSM cleaning needed */
684 /* Flags for rename */
685 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */
688 /* 12b used (from high weight to low weight):
693 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
694 #define CLF_HSM_ERR_H 6
695 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
696 #define CLF_HSM_EVENT_H 9
697 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
698 #define CLF_HSM_FLAG_H 11
699 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
700 #define CLF_HSM_SPARE_H 15
701 #define CLF_HSM_LAST 15
703 /* Remove bits higher than _h, then extract the value
704 * between _h and _l by shifting lower weigth to bit 0. */
705 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
706 >> (CLF_HSM_LAST - _h + _l))
708 #define CLF_HSM_SUCCESS 0x00
709 #define CLF_HSM_MAXERROR 0x7E
710 #define CLF_HSM_ERROVERFLOW 0x7F
712 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
714 /* 3 bits field => 8 values allowed */
726 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
728 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
731 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
733 *flags |= (he << CLF_HSM_EVENT_L);
736 static inline __u16 hsm_get_cl_flags(int flags)
738 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
741 static inline void hsm_set_cl_flags(int *flags, int bits)
743 *flags |= (bits << CLF_HSM_FLAG_L);
746 static inline int hsm_get_cl_error(int flags)
748 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
751 static inline void hsm_set_cl_error(int *flags, int error)
753 *flags |= (error << CLF_HSM_ERR_L);
756 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
757 sizeof(struct changelog_ext_rec))
759 struct changelog_rec {
761 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
762 __u32 cr_type; /**< \a changelog_rec_type */
763 __u64 cr_index; /**< changelog record number */
764 __u64 cr_prev; /**< last index for this target fid */
767 lustre_fid cr_tfid; /**< target fid */
768 __u32 cr_markerflags; /**< CL_MARK flags */
770 lustre_fid cr_pfid; /**< parent fid */
771 char cr_name[0]; /**< last element */
772 } __attribute__((packed));
774 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
775 * space, only rename uses changelog_ext_rec, while others use changelog_rec to
778 struct changelog_ext_rec {
780 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) |
782 __u32 cr_type; /**< \a changelog_rec_type */
783 __u64 cr_index; /**< changelog record number */
784 __u64 cr_prev; /**< last index for this target fid */
787 lustre_fid cr_tfid; /**< target fid */
788 __u32 cr_markerflags; /**< CL_MARK flags */
790 lustre_fid cr_pfid; /**< target parent fid */
791 lustre_fid cr_sfid; /**< source fid, or zero */
792 lustre_fid cr_spfid; /**< source parent fid, or zero */
793 char cr_name[0]; /**< last element */
794 } __attribute__((packed));
796 #define CHANGELOG_REC_EXTENDED(rec) \
797 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
799 static inline int changelog_rec_size(struct changelog_rec *rec)
801 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
805 static inline char *changelog_rec_name(struct changelog_rec *rec)
807 return CHANGELOG_REC_EXTENDED(rec) ?
808 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
811 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
813 return rec->cr_namelen - strlen(rec->cr_name) - 1;
816 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
818 return rec->cr_name + strlen(rec->cr_name) + 1;
821 struct ioc_changelog {
828 enum changelog_message_type {
829 CL_RECORD = 10, /* message is a changelog_rec */
830 CL_EOF = 11, /* at end of current changelog */
833 /********* Misc **********/
835 struct ioc_data_version {
837 __u64 idv_flags; /* See LL_DV_xxx */
839 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
840 version. Dirty caches are left unchanged. */
843 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
846 #define dot_lustre_name ".lustre"
849 /********* HSM **********/
851 /** HSM per-file state
852 * See HSM_FLAGS below.
855 HS_EXISTS = 0x00000001,
856 HS_DIRTY = 0x00000002,
857 HS_RELEASED = 0x00000004,
858 HS_ARCHIVED = 0x00000008,
859 HS_NORELEASE = 0x00000010,
860 HS_NOARCHIVE = 0x00000020,
861 HS_LOST = 0x00000040,
864 /* HSM user-setable flags. */
865 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
867 /* Other HSM flags. */
868 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
871 * All HSM-related possible flags that could be applied to a file.
872 * This should be kept in sync with hsm_states.
874 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
877 * HSMÂ request progress state
879 enum hsm_progress_states {
886 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
889 case HPS_WAITING: return "waiting";
890 case HPS_RUNNING: return "running";
891 case HPS_DONE: return "done";
892 default: return "unknown";
899 } __attribute__((packed));
902 * Current HSM states of a Lustre file.
904 * This structure purpose is to be sent to user-space mainly. It describes the
905 * current HSM flags and in-progress action.
907 struct hsm_user_state {
908 /** Current HSM states, from enum hsm_states. */
910 __u32 hus_archive_id;
911 /** The current undergoing action, if there is one */
912 __u32 hus_in_progress_state;
913 __u32 hus_in_progress_action;
914 struct hsm_extent hus_in_progress_location;
915 char hus_extended_info[];
918 struct hsm_state_set_ioc {
919 struct lu_fid hssi_fid;
921 __u64 hssi_clearmask;
925 * This structure describes the current in-progress action for a file.
926 * it is retuned to user space and send over the wire
928 struct hsm_current_action {
929 /** The current undergoing action, if there is one */
930 /* state is one of hsm_progress_states */
932 /* action is one of hsm_user_action */
934 struct hsm_extent hca_location;
937 /***** HSM user requests ******/
938 /* User-generated (lfs/ioctl) request types */
939 enum hsm_user_action {
940 HUA_NONE = 1, /* no action (noop) */
941 HUA_ARCHIVE = 10, /* copy to hsm */
942 HUA_RESTORE = 11, /* prestage */
943 HUA_RELEASE = 12, /* drop ost objects */
944 HUA_REMOVE = 13, /* remove from archive */
945 HUA_CANCEL = 14 /* cancel a request */
948 static inline char *hsm_user_action2name(enum hsm_user_action a)
951 case HUA_NONE: return "NOOP";
952 case HUA_ARCHIVE: return "ARCHIVE";
953 case HUA_RESTORE: return "RESTORE";
954 case HUA_RELEASE: return "RELEASE";
955 case HUA_REMOVE: return "REMOVE";
956 case HUA_CANCEL: return "CANCEL";
957 default: return "UNKNOWN";
962 * List of hr_flags (bit field)
964 #define HSM_FORCE_ACTION 0x0001
965 /* used by CT, connot be set by user */
966 #define HSM_GHOST_COPY 0x0002
969 * Contains all the fixed part of struct hsm_user_request.
973 __u32 hr_action; /* enum hsm_user_action */
974 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
975 __u64 hr_flags; /* request flags */
976 __u32 hr_itemcount; /* item count in hur_user_item vector */
980 struct hsm_user_item {
982 struct hsm_extent hui_extent;
983 } __attribute__((packed));
985 struct hsm_user_request {
986 struct hsm_request hur_request;
987 struct hsm_user_item hur_user_item[0];
988 /* extra data blob at end of struct (after all
989 * hur_user_items), only use helpers to access it
991 } __attribute__((packed));
993 /** Return pointer to data field in a hsm user request */
994 static inline void *hur_data(struct hsm_user_request *hur)
996 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
999 /** Compute the current length of the provided hsm_user_request. */
1000 static inline int hur_len(struct hsm_user_request *hur)
1002 return offsetof(struct hsm_user_request,
1003 hur_user_item[hur->hur_request.hr_itemcount]) +
1004 hur->hur_request.hr_data_len;
1007 /****** HSM RPCs to copytool *****/
1008 /* Message types the copytool may receive */
1009 enum hsm_message_type {
1010 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1013 /* Actions the copytool may be instructed to take for a given action_item */
1014 enum hsm_copytool_action {
1015 HSMA_NONE = 10, /* no action */
1016 HSMA_ARCHIVE = 20, /* arbitrary offset */
1022 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
1025 case HSMA_NONE: return "NOOP";
1026 case HSMA_ARCHIVE: return "ARCHIVE";
1027 case HSMA_RESTORE: return "RESTORE";
1028 case HSMA_REMOVE: return "REMOVE";
1029 case HSMA_CANCEL: return "CANCEL";
1030 default: return "UNKNOWN";
1034 /* Copytool item action description */
1035 struct hsm_action_item {
1036 __u32 hai_len; /* valid size of this struct */
1037 __u32 hai_action; /* hsm_copytool_action, but use known size */
1038 lustre_fid hai_fid; /* Lustre FID to operated on */
1039 lustre_fid hai_dfid; /* fid used for data access */
1040 struct hsm_extent hai_extent; /* byte range to operate on */
1041 __u64 hai_cookie; /* action cookie from coordinator */
1042 __u64 hai_gid; /* grouplock id */
1043 char hai_data[0]; /* variable length */
1044 } __attribute__((packed));
1047 * helper function which print in hexa the first bytes of
1049 * \param hai [IN] record to print
1050 * \param buffer [OUT] output buffer
1051 * \param len [IN] max buffer len
1054 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
1055 char *buffer, int len)
1057 int i, sz, data_len;
1062 data_len = hai->hai_len - sizeof(*hai);
1063 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1067 cnt = snprintf(ptr, sz, "%.2X",
1068 (unsigned char)hai->hai_data[i]);
1076 /* Copytool action list */
1077 #define HAL_VERSION 1
1078 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1079 struct hsm_action_list {
1081 __u32 hal_count; /* number of hai's to follow */
1082 __u64 hal_compound_id; /* returned by coordinator */
1084 __u32 hal_archive_id; /* which archive backend */
1086 char hal_fsname[0]; /* null-terminated */
1087 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1088 boundaries. See hai_zero */
1089 } __attribute__((packed));
1091 #ifndef HAVE_CFS_SIZE_ROUND
1092 static inline int cfs_size_round (int val)
1094 return (val + 7) & (~0x7);
1096 #define HAVE_CFS_SIZE_ROUND
1099 /* Return pointer to first hai in action list */
1100 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
1102 return (struct hsm_action_item *)(hal->hal_fsname +
1103 cfs_size_round(strlen(hal-> \
1106 /* Return pointer to next hai */
1107 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1109 return (struct hsm_action_item *)((char *)hai +
1110 cfs_size_round(hai->hai_len));
1113 /* Return size of an hsm_action_list */
1114 static inline int hal_size(struct hsm_action_list *hal)
1117 struct hsm_action_item *hai;
1119 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1120 hai = hai_zero(hal);
1121 for (i = 0 ; i < hal->hal_count ; i++) {
1122 sz += cfs_size_round(hai->hai_len);
1123 hai = hai_next(hai);
1128 /* Copytool progress reporting */
1129 #define HP_FLAG_COMPLETED 0x01
1130 #define HP_FLAG_RETRY 0x02
1132 struct hsm_progress {
1135 struct hsm_extent hp_extent;
1137 __u16 hp_errval; /* positive val */
1142 * Use by copytool during any hsm request they handled.
1143 * This structure is initialized by llapi_hsm_copy_start()
1144 * which is an helper over the ioctl() interface
1145 * Store Lustre, internal use only, data.
1148 __u64 hc_data_version;
1150 __u16 hc_errval; /* positive val */
1152 struct hsm_action_item hc_hai;
1155 /** @} lustreuser */
1157 #endif /* _LUSTRE_USER_H */