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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2010, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/include/lustre/lustre_user.h
34 * Lustre public user-space interface definitions.
37 #ifndef _LUSTRE_USER_H
38 #define _LUSTRE_USER_H
40 /** \defgroup lustreuser lustreuser
45 #include <linux/kernel.h>
46 #include <linux/types.h>
49 # include <linux/fs.h>
50 # include <linux/quota.h>
51 # include <linux/string.h> /* snprintf() */
52 # include <linux/version.h>
53 # include <uapi/linux/lustre/lustre_fiemap.h>
54 #else /* !__KERNEL__ */
55 # define NEED_QUOTA_DEFS
58 # include <stdio.h> /* snprintf() */
60 # include <sys/quota.h>
61 # include <sys/stat.h>
62 # include <linux/lustre/lustre_fiemap.h>
63 #endif /* __KERNEL__ */
65 /* Handle older distros */
66 #ifndef __ALIGN_KERNEL
67 # define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
68 # define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
71 #if defined(__cplusplus)
76 * This is a temporary solution of adding quota type.
77 * Should be removed as soon as system header is updated.
80 #define LL_MAXQUOTAS 3
82 #define INITQFNAMES { \
83 "user", /* USRQUOTA */ \
84 "group", /* GRPQUOTA */ \
85 "project", /* PRJQUOTA */ \
91 * We need to always use 64bit version because the structure
92 * is shared across entire cluster where 32bit and 64bit machines
95 #if __BITS_PER_LONG != 64 || defined(__ARCH_WANT_STAT64)
96 typedef struct stat64 lstat_t;
97 #define lstat_f lstat64
98 #define fstat_f fstat64
99 #define fstatat_f fstatat64
101 typedef struct stat lstat_t;
102 #define lstat_f lstat
103 #define fstat_f fstat
104 #define fstatat_f fstatat
107 #define HAVE_LOV_USER_MDS_DATA
109 #define LUSTRE_EOF 0xffffffffffffffffULL
112 #define LL_SUPER_MAGIC 0x0BD00BD0
114 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
116 /* FIEMAP flags supported by Lustre */
117 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
119 enum obd_statfs_state {
120 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
121 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
122 OS_STATE_NOPRECREATE = 0x00000004, /**< no object precreation */
123 OS_STATE_ENOSPC = 0x00000020, /**< not enough free space */
124 OS_STATE_ENOINO = 0x00000040, /**< not enough inodes */
125 OS_STATE_SUM = 0x00000100, /**< aggregated for all tagrets */
128 /** filesystem statistics/attributes for target device */
130 __u64 os_type; /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
131 __u64 os_blocks; /* total size in #os_bsize blocks */
132 __u64 os_bfree; /* number of unused blocks */
133 __u64 os_bavail; /* blocks available for allocation */
134 __u64 os_files; /* total number of objects */
135 __u64 os_ffree; /* # objects that could be created */
136 __u8 os_fsid[40]; /* identifier for filesystem */
137 __u32 os_bsize; /* block size in bytes for os_blocks */
138 __u32 os_namelen; /* maximum length of filename in bytes*/
139 __u64 os_maxbytes; /* maximum object size in bytes */
140 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
141 __u32 os_fprecreated; /* objs available now to the caller */
142 /* used in QoS code to find preferred
144 __u32 os_granted; /* space granted for MDS */
145 __u32 os_spare3; /* Unused padding fields. Remember */
146 __u32 os_spare4; /* to fix lustre_swab_obd_statfs() */
157 * FID is a cluster-wide unique identifier of a file or an object (stripe).
158 * FIDs are never reused.
162 * FID sequence. Sequence is a unit of migration: all files (objects)
163 * with FIDs from a given sequence are stored on the same server.
164 * Lustre should support 2^64 objects, so even if each sequence
165 * has only a single object we can still enumerate 2^64 objects.
168 /* FID number within sequence. */
171 * FID version, used to distinguish different versions (in the sense
172 * of snapshots, etc.) of the same file system object. Not currently
178 static inline bool fid_is_zero(const struct lu_fid *fid)
180 return fid->f_seq == 0 && fid->f_oid == 0;
183 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
184 * MDT-object's FID::f_ver, instead it is the OST-object index in its
185 * parent MDT-object's layout EA. */
186 #define f_stripe_idx f_ver
189 __u32 ol_stripe_size;
190 __u32 ol_stripe_count;
194 } __attribute__((packed));
196 /* keep this one for compatibility */
197 struct filter_fid_old {
198 struct lu_fid ff_parent;
204 struct lu_fid ff_parent;
205 struct ost_layout ff_layout;
206 __u32 ff_layout_version;
207 __u32 ff_range; /* range of layout version that
208 * write are allowed */
209 } __attribute__((packed));
211 /* Userspace should treat lu_fid as opaque, and only use the following methods
212 * to print or parse them. Other functions (e.g. compare, swab) could be moved
213 * here from lustre_idl.h if needed. */
217 LMAC_HSM = 0x00000001,
218 /* LMAC_SOM = 0x00000002, obsolete since 2.8.0 */
219 LMAC_NOT_IN_OI = 0x00000004, /* the object does NOT need OI mapping */
220 LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
221 * under /O/<seq>/d<x>. */
222 LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
223 LMAC_COMP_INFO = 0x00000020, /* Component info in the LMA EA. */
224 LMAC_IDX_BACKUP = 0x00000040, /* Has index backup. */
228 * Masks for all features that should be supported by a Lustre version to
229 * access a specific file.
230 * This information is stored in lustre_mdt_attrs::lma_incompat.
233 LMAI_RELEASED = 0x00000001, /* file is released */
234 LMAI_AGENT = 0x00000002, /* agent inode */
235 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
236 is on the remote MDT */
237 LMAI_STRIPED = 0x00000008, /* striped directory inode */
238 LMAI_ORPHAN = 0x00000010, /* inode is orphan */
239 LMA_INCOMPAT_SUPP = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
240 LMAI_STRIPED | LMAI_ORPHAN)
245 * Following struct for object attributes, that will be kept inode's EA.
246 * Introduced in 2.0 release (please see b15993, for details)
247 * Added to all objects since Lustre 2.4 as contains self FID
249 struct lustre_mdt_attrs {
251 * Bitfield for supported data in this structure. From enum lma_compat.
252 * lma_self_fid and lma_flags are always available.
256 * Per-file incompat feature list. Lustre version should support all
257 * flags set in this field. The supported feature mask is available in
261 /** FID of this inode */
262 struct lu_fid lma_self_fid;
265 struct lustre_ost_attrs {
266 /* Use lustre_mdt_attrs directly for now, need a common header
267 * structure if want to change lustre_mdt_attrs in future. */
268 struct lustre_mdt_attrs loa_lma;
270 /* Below five elements are for OST-object's PFID EA, the
271 * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
272 * and the stripe_index (low 16 bits), the size should not exceed
273 * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
274 * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
275 * are valid; if the flag LMAC_COMP_INFO is set, then the next three
276 * loa_comp_* elements are valid. */
277 struct lu_fid loa_parent_fid;
278 __u32 loa_stripe_size;
280 __u64 loa_comp_start;
285 * Prior to 2.4, the LMA structure also included SOM attributes which has since
286 * been moved to a dedicated xattr
287 * lma_flags was also removed because of lma_compat/incompat fields.
289 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
291 enum lustre_som_flags {
292 /* Unknow or no SoM data, must get size from OSTs. */
293 SOM_FL_UNKNOWN = 0x0000,
294 /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
295 SOM_FL_STRICT = 0x0001,
296 /* Known stale - was right at some point in the past, but it is
297 * known (or likely) to be incorrect now (e.g. opened for write). */
298 SOM_FL_STALE = 0x0002,
299 /* Approximate, may never have been strictly correct,
300 * need to sync SOM data to achieve eventual consistency. */
301 SOM_FL_LAZY = 0x0004,
304 struct lustre_som_attrs {
306 __u16 lsa_reserved[3];
312 * OST object IDentifier.
320 struct lu_fid oi_fid;
324 #define DOSTID "%#llx:%llu"
325 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
326 ((unsigned long long)ostid_id(oi))
328 struct ll_futimes_3 {
330 __u64 lfu_atime_nsec;
332 __u64 lfu_mtime_nsec;
334 __u64 lfu_ctime_nsec;
338 * Maximum number of mirrors currently implemented.
340 #define LUSTRE_MIRROR_COUNT_MAX 16
342 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
344 LL_LEASE_RDLCK = 0x01,
345 LL_LEASE_WRLCK = 0x02,
346 LL_LEASE_UNLCK = 0x04,
349 enum ll_lease_flags {
350 LL_LEASE_RESYNC = 0x1,
351 LL_LEASE_RESYNC_DONE = 0x2,
352 LL_LEASE_LAYOUT_MERGE = 0x4,
353 LL_LEASE_LAYOUT_SPLIT = 0x8,
356 #define IOC_IDS_MAX 4096
357 struct ll_ioc_lease {
364 struct ll_ioc_lease_id {
375 * The ioctl naming rules:
376 * LL_* - works on the currently opened filehandle instead of parent dir
377 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
378 * *_MDC_* - gets/sets data related to MDC
379 * *_LOV_* - gets/sets data related to OSC/LOV
380 * *FILE* - called on parent dir and passes in a filename
381 * *STRIPE* - set/get lov_user_md
382 * *INFO - set/get lov_user_mds_data
384 /* lustre_ioctl.h 101-150 */
385 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
386 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
387 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
388 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
389 #define LL_IOC_LOV_SETSTRIPE_NEW _IOWR('f', 154, struct lov_user_md)
390 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
391 #define LL_IOC_LOV_GETSTRIPE_NEW _IOR('f', 155, struct lov_user_md)
392 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
393 /* LL_IOC_RECREATE_OBJ 157 obsolete */
394 /* LL_IOC_RECREATE_FID 157 obsolete */
395 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
396 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
397 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
398 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
399 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
400 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
401 /* IOC_LOV_GETINFO 165 obsolete */
402 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
403 /* LL_IOC_RMTACL 167 obsolete */
404 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
405 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
406 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
407 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
408 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
409 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
410 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
411 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
412 #define LL_IOC_FUTIMES_3 _IOWR('f', 176, struct ll_futimes_3)
413 #define LL_IOC_FLR_SET_MIRROR _IOW ('f', 177, long)
414 /* lustre_ioctl.h 177-210 */
415 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
416 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
417 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
418 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
419 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
420 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
421 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
422 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
423 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
424 struct lustre_swap_layouts)
425 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
426 struct hsm_current_action)
427 /* lustre_ioctl.h 221-232 */
428 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
429 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
430 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
431 #define LL_IOC_SET_LEASE _IOWR('f', 243, struct ll_ioc_lease)
432 #define LL_IOC_SET_LEASE_OLD _IOWR('f', 243, long)
433 #define LL_IOC_GET_LEASE _IO('f', 244)
434 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
435 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
436 #define LL_IOC_MIGRATE _IOR('f', 247, int)
437 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
438 #define LL_IOC_GETPARENT _IOWR('f', 249, struct getparent)
439 #define LL_IOC_LADVISE _IOR('f', 250, struct llapi_lu_ladvise)
441 #ifndef FS_IOC_FSGETXATTR
443 * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
446 __u32 fsx_xflags; /* xflags field value (get/set) */
447 __u32 fsx_extsize; /* extsize field value (get/set)*/
448 __u32 fsx_nextents; /* nextents field value (get) */
449 __u32 fsx_projid; /* project identifier (get/set) */
450 unsigned char fsx_pad[12];
452 #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
453 #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
455 #define LL_IOC_FSGETXATTR FS_IOC_FSGETXATTR
456 #define LL_IOC_FSSETXATTR FS_IOC_FSSETXATTR
457 #ifndef FS_XFLAG_PROJINHERIT
458 #define FS_XFLAG_PROJINHERIT 0x00000200
462 #define LL_STATFS_LMV 1
463 #define LL_STATFS_LOV 2
464 #define LL_STATFS_NODELAY 4
466 #define IOC_MDC_TYPE 'i'
467 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
468 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
469 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
470 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
472 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
474 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
475 * files, but are unlikely to be used in practice and are not harmful if
476 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
477 * devices and are safe for use on new files. See LU-4209. */
478 /* To be compatible with old statically linked binary we keep the check for
479 * the older 0100000000 flag. This is already removed upstream. LU-812. */
480 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
481 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
482 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
483 O_LOV_DELAY_CREATE_MASK)
485 #define LL_FILE_IGNORE_LOCK 0x00000001
486 #define LL_FILE_GROUP_LOCKED 0x00000002
487 #define LL_FILE_READAHEA 0x00000004
488 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
489 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
491 #define LOV_USER_MAGIC_V1 0x0BD10BD0
492 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
493 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
494 #define LOV_USER_MAGIC_V3 0x0BD30BD0
495 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
496 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0 /* for specific OSTs */
497 #define LOV_USER_MAGIC_COMP_V1 0x0BD60BD0
499 #define LMV_USER_MAGIC 0x0CD30CD0 /* default lmv magic */
500 #define LMV_USER_MAGIC_V0 0x0CD20CD0 /* old default lmv magic*/
501 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
503 #define LOV_PATTERN_NONE 0x000
504 #define LOV_PATTERN_RAID0 0x001
505 #define LOV_PATTERN_RAID1 0x002
506 #define LOV_PATTERN_MDT 0x100
507 #define LOV_PATTERN_CMOBD 0x200
509 #define LOV_PATTERN_F_MASK 0xffff0000
510 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
511 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
512 #define LOV_PATTERN_DEFAULT 0xffffffff
514 static inline bool lov_pattern_supported(__u32 pattern)
516 return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
517 (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
520 #define LOV_MAXPOOLNAME 15
521 #define LOV_POOLNAMEF "%.15s"
523 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
524 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
525 #define LOV_MAX_STRIPE_COUNT_OLD 160
526 /* This calculation is crafted so that input of 4096 will result in 160
527 * which in turn is equal to old maximal stripe count.
528 * XXX: In fact this is too simpified for now, what it also need is to get
529 * ea_type argument to clearly know how much space each stripe consumes.
531 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
532 * allocation that is sufficient for the current generation of systems.
534 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
535 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
536 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
537 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
539 #define XATTR_LUSTRE_PREFIX "lustre."
540 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
542 #define lov_user_ost_data lov_user_ost_data_v1
543 struct lov_user_ost_data_v1 { /* per-stripe data structure */
544 struct ost_id l_ost_oi; /* OST object ID */
545 __u32 l_ost_gen; /* generation of this OST index */
546 __u32 l_ost_idx; /* OST index in LOV */
547 } __attribute__((packed));
549 #define lov_user_md lov_user_md_v1
550 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
551 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
552 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
553 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
554 __u32 lmm_stripe_size; /* size of stripe in bytes */
555 __u16 lmm_stripe_count; /* num stripes in use for this object */
557 __u16 lmm_stripe_offset; /* starting stripe offset in
558 * lmm_objects, use when writing */
559 __u16 lmm_layout_gen; /* layout generation number
560 * used when reading */
562 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
563 } __attribute__((packed, __may_alias__));
565 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
566 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
567 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
568 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
569 __u32 lmm_stripe_size; /* size of stripe in bytes */
570 __u16 lmm_stripe_count; /* num stripes in use for this object */
572 __u16 lmm_stripe_offset; /* starting stripe offset in
573 * lmm_objects, use when writing */
574 __u16 lmm_layout_gen; /* layout generation number
575 * used when reading */
577 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
578 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
579 } __attribute__((packed));
586 #define DEXT "[%#llx, %#llx)"
587 #define PEXT(ext) (ext)->e_start, (ext)->e_end
589 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
590 struct lu_extent *e2)
592 return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
595 static inline bool lu_extent_is_whole(struct lu_extent *e)
597 return e->e_start == 0 && e->e_end == LUSTRE_EOF;
600 enum lov_comp_md_entry_flags {
601 LCME_FL_STALE = 0x00000001, /* FLR: stale data */
602 LCME_FL_PREF_RD = 0x00000002, /* FLR: preferred for reading */
603 LCME_FL_PREF_WR = 0x00000004, /* FLR: preferred for writing */
604 LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
605 LCME_FL_OFFLINE = 0x00000008, /* Not used */
606 LCME_FL_INIT = 0x00000010, /* instantiated */
607 LCME_FL_NOSYNC = 0x00000020, /* FLR: no sync for the mirror */
608 LCME_FL_NEG = 0x80000000 /* used to indicate a negative flag,
609 won't be stored on disk */
612 #define LCME_KNOWN_FLAGS (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
613 LCME_FL_PREF_RW | LCME_FL_NOSYNC)
614 /* The flags can be set by users at mirror creation time. */
615 #define LCME_USER_FLAGS (LCME_FL_PREF_RW)
617 /* The flags are for mirrors */
618 #define LCME_MIRROR_FLAGS (LCME_FL_NOSYNC)
620 /* These flags have meaning when set in a default layout and will be inherited
621 * from the default/template layout set on a directory.
623 #define LCME_TEMPLATE_FLAGS (LCME_FL_PREF_RW | LCME_FL_NOSYNC)
625 /* the highest bit in obdo::o_layout_version is used to mark if the file is
627 #define LU_LAYOUT_RESYNC LCME_FL_NEG
629 /* lcme_id can be specified as certain flags, and the the first
630 * bit of lcme_id is used to indicate that the ID is representing
631 * certain LCME_FL_* but not a real ID. Which implies we can have
632 * at most 31 flags (see LCME_FL_XXX). */
635 LCME_ID_MAX = 0x7FFFFFFF,
636 LCME_ID_ALL = 0xFFFFFFFF,
637 LCME_ID_NOT_ID = LCME_FL_NEG
640 #define LCME_ID_MASK LCME_ID_MAX
642 struct lov_comp_md_entry_v1 {
643 __u32 lcme_id; /* unique id of component */
644 __u32 lcme_flags; /* LCME_FL_XXX */
645 struct lu_extent lcme_extent; /* file extent for component */
646 __u32 lcme_offset; /* offset of component blob,
647 start from lov_comp_md_v1 */
648 __u32 lcme_size; /* size of component blob */
649 __u32 lcme_layout_gen;
650 __u64 lcme_timestamp; /* snapshot time if applicable*/
651 __u32 lcme_padding_1;
652 } __attribute__((packed));
654 #define SEQ_ID_MAX 0x0000FFFF
655 #define SEQ_ID_MASK SEQ_ID_MAX
656 /* bit 30:16 of lcme_id is used to store mirror id */
657 #define MIRROR_ID_MASK 0x7FFF0000
658 #define MIRROR_ID_SHIFT 16
660 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
662 return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
665 static inline __u16 mirror_id_of(__u32 id)
667 return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
671 * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
673 enum lov_comp_md_flags {
674 /* the least 2 bits are used by FLR to record file state */
677 LCM_FL_WRITE_PENDING = 2,
678 LCM_FL_SYNC_PENDING = 3,
679 LCM_FL_FLR_MASK = 0x3,
682 struct lov_comp_md_v1 {
683 __u32 lcm_magic; /* LOV_USER_MAGIC_COMP_V1 */
684 __u32 lcm_size; /* overall size including this struct */
685 __u32 lcm_layout_gen;
687 __u16 lcm_entry_count;
688 /* lcm_mirror_count stores the number of actual mirrors minus 1,
689 * so that non-flr files will have value 0 meaning 1 mirror. */
690 __u16 lcm_mirror_count;
691 __u16 lcm_padding1[3];
693 struct lov_comp_md_entry_v1 lcm_entries[0];
694 } __attribute__((packed));
696 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
698 if (stripes == (__u16)-1)
701 if (lmm_magic == LOV_USER_MAGIC_V1)
702 return sizeof(struct lov_user_md_v1) +
703 stripes * sizeof(struct lov_user_ost_data_v1);
704 return sizeof(struct lov_user_md_v3) +
705 stripes * sizeof(struct lov_user_ost_data_v1);
708 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
709 * use this. It is unsafe to #define those values in this header as it
710 * is possible the application has already #included <sys/stat.h>. */
711 #ifdef HAVE_LOV_USER_MDS_DATA
712 #define lov_user_mds_data lov_user_mds_data_v1
713 struct lov_user_mds_data_v1 {
714 lstat_t lmd_st; /* MDS stat struct */
715 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
716 } __attribute__((packed));
719 struct lmv_user_mds_data {
720 struct lu_fid lum_fid;
726 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
727 LMV_HASH_TYPE_ALL_CHARS = 1,
728 LMV_HASH_TYPE_FNV_1A_64 = 2,
732 #define LMV_HASH_NAME_ALL_CHARS "all_char"
733 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
735 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
737 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
738 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
739 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
740 #define lmv_user_md lmv_user_md_v1
741 struct lmv_user_md_v1 {
742 __u32 lum_magic; /* must be the first field */
743 __u32 lum_stripe_count; /* dirstripe count */
744 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
745 __u32 lum_hash_type; /* Dir stripe policy */
746 __u32 lum_type; /* LMV type: default or normal */
750 char lum_pool_name[LOV_MAXPOOLNAME + 1];
751 struct lmv_user_mds_data lum_objects[0];
752 } __attribute__((packed));
754 static inline int lmv_user_md_size(int stripes, int lmm_magic)
756 int size = sizeof(struct lmv_user_md);
758 if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
759 size += stripes * sizeof(struct lmv_user_mds_data);
764 struct ll_recreate_obj {
770 __u64 id; /* holds object id */
771 __u32 generation; /* holds object generation */
772 __u32 f_type; /* holds object type or stripe idx when passing it to
773 * OST for saving into EA. */
781 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
782 const struct obd_uuid *u2)
784 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
787 static inline int obd_uuid_empty(struct obd_uuid *uuid)
789 return uuid->uuid[0] == '\0';
792 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
794 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
795 uuid->uuid[sizeof(*uuid) - 1] = '\0';
798 /* For printf's only, make sure uuid is terminated */
799 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
804 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
805 /* Obviously not safe, but for printfs, no real harm done...
806 we're always null-terminated, even in a race. */
807 static char temp[sizeof(*uuid)];
808 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
809 temp[sizeof(*uuid) - 1] = '\0';
812 return (char *)(uuid->uuid);
815 #define LUSTRE_MAXFSNAME 8
817 /* Extract fsname from uuid (or target name) of a target
818 e.g. (myfs-OST0007_UUID -> myfs)
819 see also deuuidify. */
820 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
824 strncpy(buf, uuid, buflen - 1);
825 buf[buflen - 1] = '\0';
826 p = strrchr(buf, '-');
831 /* printf display format for Lustre FIDs
832 * usage: printf("file FID is "DFID"\n", PFID(fid)); */
833 #define FID_NOBRACE_LEN 40
834 #define FID_LEN (FID_NOBRACE_LEN + 2)
835 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
836 #define DFID "["DFID_NOBRACE"]"
837 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
839 /* scanf input parse format for fids in DFID_NOBRACE format
840 * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
841 * usage: sscanf(fidstr, SFID, RFID(&fid)); */
842 #define SFID "0x%llx:0x%x:0x%x"
843 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
845 /********* Quotas **********/
847 #define LUSTRE_QUOTABLOCK_BITS 10
848 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
850 static inline __u64 lustre_stoqb(size_t space)
852 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
855 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
856 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
857 #define Q_GETOINFO 0x800102 /* get obd quota info */
858 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
859 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
861 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
862 #define LUSTRE_Q_QUOTAON 0x800002 /* deprecated as of 2.4 */
863 #define LUSTRE_Q_QUOTAOFF 0x800003 /* deprecated as of 2.4 */
864 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
865 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
866 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
867 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
868 /* lustre-specific control commands */
869 #define LUSTRE_Q_INVALIDATE 0x80000b /* deprecated as of 2.4 */
870 #define LUSTRE_Q_FINVALIDATE 0x80000c /* deprecated as of 2.4 */
871 #define LUSTRE_Q_GETDEFAULT 0x80000d /* get default quota */
872 #define LUSTRE_Q_SETDEFAULT 0x80000e /* set default quota */
874 /* In the current Lustre implementation, the grace time is either the time
875 * or the timestamp to be used after some quota ID exceeds the soft limt,
876 * 48 bits should be enough, its high 16 bits can be used as quota flags.
878 #define LQUOTA_GRACE_BITS 48
879 #define LQUOTA_GRACE_MASK ((1ULL << LQUOTA_GRACE_BITS) - 1)
880 #define LQUOTA_GRACE_MAX LQUOTA_GRACE_MASK
881 #define LQUOTA_GRACE(t) (t & LQUOTA_GRACE_MASK)
882 #define LQUOTA_FLAG(t) (t >> LQUOTA_GRACE_BITS)
883 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
885 /* different quota flags */
887 /* the default quota flag, the corresponding quota ID will use the default
888 * quota setting, the hardlimit and softlimit of its quota record in the global
889 * quota file will be set to 0, the low 48 bits of the grace will be set to 0
890 * and high 16 bits will contain this flag (see above comment).
892 #define LQUOTA_FLAG_DEFAULT 0x0001
894 #define ALLQUOTA 255 /* set all quota */
895 static inline char *qtype_name(int qtype)
908 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
911 #define N_PERMS_MAX 64
913 struct perm_downcall_data {
919 struct identity_downcall_data {
926 struct perm_downcall_data idd_perms[N_PERMS_MAX];
930 #ifdef NEED_QUOTA_DEFS
932 #define QIF_BLIMITS 1
934 #define QIF_ILIMITS 4
938 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
939 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
940 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
941 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
944 #endif /* !__KERNEL__ */
946 /* lustre volatile file support
947 * file name header: ".^L^S^T^R:volatile"
949 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
950 #define LUSTRE_VOLATILE_HDR_LEN 14
952 enum lustre_quota_version {
956 /* XXX: same as if_dqinfo struct in kernel */
964 /* XXX: same as if_dqblk struct in kernel, plus one padding */
966 __u64 dqb_bhardlimit;
967 __u64 dqb_bsoftlimit;
969 __u64 dqb_ihardlimit;
970 __u64 dqb_isoftlimit;
992 struct obd_dqinfo qc_dqinfo;
993 struct obd_dqblk qc_dqblk;
995 struct obd_uuid obd_uuid;
998 /* swap layout flags */
999 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
1000 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
1001 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
1002 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
1003 #define SWAP_LAYOUTS_CLOSE (1 << 4)
1005 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1006 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
1007 struct lustre_swap_layouts {
1015 /** Bit-mask of valid attributes */
1016 /* The LA_* flags are written to disk as part of the ChangeLog records
1017 * so they are part of the on-disk and network protocol, and cannot be changed.
1018 * Only the first 12 bits are currently saved.
1033 LA_BLKSIZE = 1 << 12,
1034 LA_KILL_SUID = 1 << 13,
1035 LA_KILL_SGID = 1 << 14,
1036 LA_PROJID = 1 << 15,
1037 LA_LAYOUT_VERSION = 1 << 16,
1039 LA_LBLOCKS = 1 << 18,
1041 * Attributes must be transmitted to OST objects
1043 LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1046 #define MDS_FMODE_READ 00000001
1047 #define MDS_FMODE_WRITE 00000002
1049 #define MDS_FMODE_CLOSED 00000000
1050 #define MDS_FMODE_EXEC 00000004
1051 /* MDS_FMODE_EPOCH 01000000 obsolete since 2.8.0 */
1052 /* MDS_FMODE_TRUNC 02000000 obsolete since 2.8.0 */
1053 /* MDS_FMODE_SOM 04000000 obsolete since 2.8.0 */
1055 #define MDS_OPEN_CREATED 00000010
1056 /* MDS_OPEN_CROSS 00000020 obsolete in 2.12, internal use only */
1058 #define MDS_OPEN_CREAT 00000100
1059 #define MDS_OPEN_EXCL 00000200
1060 #define MDS_OPEN_TRUNC 00001000
1061 #define MDS_OPEN_APPEND 00002000
1062 #define MDS_OPEN_SYNC 00010000
1063 #define MDS_OPEN_DIRECTORY 00200000
1065 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
1066 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1067 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1068 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1069 * We do not support JOIN FILE
1070 * anymore, reserve this flags
1071 * just for preventing such bit
1074 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1075 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1076 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1077 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1078 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1080 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
1082 #define MDS_OPEN_LEASE 01000000000000ULL /* Open the file and grant lease
1083 * delegation, succeed if it's not
1084 * being opened with conflict mode.
1086 #define MDS_OPEN_RELEASE 02000000000000ULL /* Open the file for HSM release */
1088 #define MDS_OPEN_RESYNC 04000000000000ULL /* FLR: file resync */
1090 /* lustre internal open flags, which should not be set from user space */
1091 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS | \
1092 MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK | \
1093 MDS_OPEN_BY_FID | MDS_OPEN_LEASE | \
1094 MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1097 /********* Changelogs **********/
1098 /** Changelog record types */
1099 enum changelog_rec_type {
1102 CL_CREATE = 1, /* namespace */
1103 CL_MKDIR = 2, /* namespace */
1104 CL_HARDLINK = 3, /* namespace */
1105 CL_SOFTLINK = 4, /* namespace */
1106 CL_MKNOD = 5, /* namespace */
1107 CL_UNLINK = 6, /* namespace */
1108 CL_RMDIR = 7, /* namespace */
1109 CL_RENAME = 8, /* namespace */
1110 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
1111 CL_OPEN = 10, /* not currently used */
1112 CL_CLOSE = 11, /* may be written to log only with mtime change */
1113 CL_LAYOUT = 12, /* file layout/striping modified */
1117 CL_XATTR = CL_SETXATTR, /* Deprecated name */
1118 CL_HSM = 16, /* HSM specific events, see flags */
1119 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
1123 CL_FLRW = 21, /* FLR: file was firstly written */
1124 CL_RESYNC = 22, /* FLR: file was resync-ed */
1126 CL_DN_OPEN = 24, /* denied open */
1130 static inline const char *changelog_type2str(int type) {
1131 static const char *changelog_str[] = {
1132 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1133 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
1134 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "MIGRT",
1135 "FLRW", "RESYNC","GXATR", "NOPEN",
1138 if (type >= 0 && type < CL_LAST)
1139 return changelog_str[type];
1143 /* 12 bits of per-record data can be stored in the bottom of the flags */
1144 #define CLF_FLAGSHIFT 12
1145 enum changelog_rec_flags {
1146 CLF_VERSION = 0x1000,
1147 CLF_RENAME = 0x2000,
1149 CLF_EXTRA_FLAGS = 0x8000,
1150 CLF_SUPPORTED = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1152 CLF_FLAGMASK = (1U << CLF_FLAGSHIFT) - 1,
1153 CLF_VERMASK = ~CLF_FLAGMASK,
1157 /* Anything under the flagmask may be per-type (if desired) */
1158 /* Flags for unlink */
1159 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
1160 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1161 /* HSM cleaning needed */
1162 /* Flags for rename */
1163 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
1165 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
1166 * has an archive in backend */
1169 /* 12b used (from high weight to low weight):
1174 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
1175 #define CLF_HSM_ERR_H 6
1176 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
1177 #define CLF_HSM_EVENT_H 9
1178 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
1179 #define CLF_HSM_FLAG_H 11
1180 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
1181 #define CLF_HSM_SPARE_H 15
1182 #define CLF_HSM_LAST 15
1184 /* Remove bits higher than _h, then extract the value
1185 * between _h and _l by shifting lower weigth to bit 0. */
1186 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1187 >> (CLF_HSM_LAST - _h + _l))
1189 #define CLF_HSM_SUCCESS 0x00
1190 #define CLF_HSM_MAXERROR 0x7E
1191 #define CLF_HSM_ERROVERFLOW 0x7F
1193 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
1195 /* 3 bits field => 8 values allowed */
1207 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1209 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1213 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1216 *clf_flags |= (he << CLF_HSM_EVENT_L);
1219 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1221 return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1224 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1227 *clf_flags |= (bits << CLF_HSM_FLAG_L);
1230 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1232 return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1235 static inline void hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1238 *clf_flags |= (error << CLF_HSM_ERR_L);
1241 enum changelog_rec_extra_flags {
1243 CLFE_UIDGID = 0x0001,
1246 CLFE_XATTR = 0x0008,
1247 CLFE_SUPPORTED = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1250 enum changelog_send_flag {
1251 /* Not yet implemented */
1252 CHANGELOG_FLAG_FOLLOW = 0x01,
1253 /* Blocking IO makes sense in case of slow user parsing of the records,
1254 * but it also prevents us from cleaning up if the records are not
1256 CHANGELOG_FLAG_BLOCK = 0x02,
1257 /* Pack jobid into the changelog records if available. */
1258 CHANGELOG_FLAG_JOBID = 0x04,
1259 /* Pack additional flag bits into the changelog record */
1260 CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1263 enum changelog_send_extra_flag {
1264 /* Pack uid/gid into the changelog record */
1265 CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1266 /* Pack nid into the changelog record */
1267 CHANGELOG_EXTRA_FLAG_NID = 0x02,
1268 /* Pack open mode into the changelog record */
1269 CHANGELOG_EXTRA_FLAG_OMODE = 0x04,
1270 /* Pack xattr name into the changelog record */
1271 CHANGELOG_EXTRA_FLAG_XATTR = 0x08,
1274 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1275 changelog_rec_offset(CLF_SUPPORTED, \
1278 /* 31 usable bytes string + null terminator. */
1279 #define LUSTRE_JOBID_SIZE 32
1281 /* This is the minimal changelog record. It can contain extensions
1282 * such as rename fields or process jobid. Its exact content is described
1283 * by the cr_flags and cr_extra_flags.
1285 * Extensions are packed in the same order as their corresponding flags,
1286 * then in the same order as their corresponding extra flags.
1288 struct changelog_rec {
1290 __u16 cr_flags; /**< \a changelog_rec_flags */
1291 __u32 cr_type; /**< \a changelog_rec_type */
1292 __u64 cr_index; /**< changelog record number */
1293 __u64 cr_prev; /**< last index for this target fid */
1296 struct lu_fid cr_tfid; /**< target fid */
1297 __u32 cr_markerflags; /**< CL_MARK flags */
1299 struct lu_fid cr_pfid; /**< parent fid */
1302 /* Changelog extension for RENAME. */
1303 struct changelog_ext_rename {
1304 struct lu_fid cr_sfid; /**< source fid, or zero */
1305 struct lu_fid cr_spfid; /**< source parent fid, or zero */
1308 /* Changelog extension to include JOBID. */
1309 struct changelog_ext_jobid {
1310 char cr_jobid[LUSTRE_JOBID_SIZE]; /**< zero-terminated string. */
1313 /* Changelog extension to include additional flags. */
1314 struct changelog_ext_extra_flags {
1315 __u64 cr_extra_flags; /* Additional CLFE_* flags */
1318 /* Changelog extra extension to include UID/GID. */
1319 struct changelog_ext_uidgid {
1324 /* Changelog extra extension to include NID. */
1325 struct changelog_ext_nid {
1326 /* have __u64 instead of lnet_nid_t type for use by client api */
1328 /* for use when IPv6 support is added */
1333 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1334 struct changelog_ext_openmode {
1338 /* Changelog extra extension to include xattr */
1339 struct changelog_ext_xattr {
1340 char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1343 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1344 const struct changelog_rec *rec);
1346 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1347 enum changelog_rec_extra_flags cref)
1349 size_t size = sizeof(struct changelog_rec);
1351 if (crf & CLF_RENAME)
1352 size += sizeof(struct changelog_ext_rename);
1354 if (crf & CLF_JOBID)
1355 size += sizeof(struct changelog_ext_jobid);
1357 if (crf & CLF_EXTRA_FLAGS) {
1358 size += sizeof(struct changelog_ext_extra_flags);
1359 if (cref & CLFE_UIDGID)
1360 size += sizeof(struct changelog_ext_uidgid);
1361 if (cref & CLFE_NID)
1362 size += sizeof(struct changelog_ext_nid);
1363 if (cref & CLFE_OPEN)
1364 size += sizeof(struct changelog_ext_openmode);
1365 if (cref & CLFE_XATTR)
1366 size += sizeof(struct changelog_ext_xattr);
1372 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1374 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1376 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1377 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1379 return changelog_rec_offset(rec->cr_flags, cref);
1382 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1384 return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1388 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1390 enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1392 return (struct changelog_ext_rename *)((char *)rec +
1393 changelog_rec_offset(crf,
1397 /* The jobid follows the rename extension, if present */
1399 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1401 enum changelog_rec_flags crf = rec->cr_flags &
1402 (CLF_VERSION | CLF_RENAME);
1404 return (struct changelog_ext_jobid *)((char *)rec +
1405 changelog_rec_offset(crf,
1409 /* The additional flags follow the rename and jobid extensions, if present */
1411 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1412 const struct changelog_rec *rec)
1414 enum changelog_rec_flags crf = rec->cr_flags &
1415 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1417 return (struct changelog_ext_extra_flags *)((char *)rec +
1418 changelog_rec_offset(crf,
1422 /* The uid/gid is the first extra extension */
1424 struct changelog_ext_uidgid *changelog_rec_uidgid(
1425 const struct changelog_rec *rec)
1427 enum changelog_rec_flags crf = rec->cr_flags &
1428 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1430 return (struct changelog_ext_uidgid *)((char *)rec +
1431 changelog_rec_offset(crf,
1435 /* The nid is the second extra extension */
1437 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1439 enum changelog_rec_flags crf = rec->cr_flags &
1440 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1441 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1443 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1444 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1447 return (struct changelog_ext_nid *)((char *)rec +
1448 changelog_rec_offset(crf, cref));
1451 /* The OPEN mode is the third extra extension */
1453 struct changelog_ext_openmode *changelog_rec_openmode(
1454 const struct changelog_rec *rec)
1456 enum changelog_rec_flags crf = rec->cr_flags &
1457 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1458 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1460 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1461 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1462 (CLFE_UIDGID | CLFE_NID);
1464 return (struct changelog_ext_openmode *)((char *)rec +
1465 changelog_rec_offset(crf, cref));
1468 /* The xattr name is the fourth extra extension */
1470 struct changelog_ext_xattr *changelog_rec_xattr(
1471 const struct changelog_rec *rec)
1473 enum changelog_rec_flags crf = rec->cr_flags &
1474 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1475 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1477 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1478 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1479 (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1481 return (struct changelog_ext_xattr *)((char *)rec +
1482 changelog_rec_offset(crf, cref));
1485 /* The name follows the rename, jobid and extra flags extns, if present */
1486 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1488 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1490 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1491 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1493 return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1494 cref & CLFE_SUPPORTED);
1497 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1499 return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1502 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1504 char *cr_name = changelog_rec_name(rec);
1506 return cr_name + strlen(cr_name) + 1;
1510 * Remap a record to the desired format as specified by the crf flags.
1511 * The record must be big enough to contain the final remapped version.
1512 * Superfluous extension fields are removed and missing ones are added
1513 * and zeroed. The flags of the record are updated accordingly.
1515 * The jobid and rename extensions can be added to a record, to match the
1516 * format an application expects, typically. In this case, the newly added
1517 * fields will be zeroed.
1518 * The Jobid field can be removed, to guarantee compatibility with older
1519 * clients that don't expect this field in the records they process.
1521 * The following assumptions are being made:
1522 * - CLF_RENAME will not be removed
1523 * - CLF_JOBID will not be added without CLF_RENAME being added too
1524 * - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1526 * @param[in,out] rec The record to remap.
1527 * @param[in] crf_wanted Flags describing the desired extensions.
1528 * @param[in] cref_want Flags describing the desired extra extensions.
1530 static inline void changelog_remap_rec(struct changelog_rec *rec,
1531 enum changelog_rec_flags crf_wanted,
1532 enum changelog_rec_extra_flags cref_want)
1534 char *xattr_mov = NULL;
1535 char *omd_mov = NULL;
1536 char *nid_mov = NULL;
1537 char *uidgid_mov = NULL;
1541 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1543 crf_wanted &= CLF_SUPPORTED;
1544 cref_want &= CLFE_SUPPORTED;
1546 if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1547 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1548 (rec->cr_flags & CLF_EXTRA_FLAGS &&
1549 (changelog_rec_extra_flags(rec)->cr_extra_flags &
1555 /* First move the variable-length name field */
1556 memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1557 changelog_rec_name(rec), rec->cr_namelen);
1559 /* Locations of extensions in the remapped record */
1560 if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1561 xattr_mov = (char *)rec +
1562 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1563 cref_want & ~CLFE_XATTR);
1564 omd_mov = (char *)rec +
1565 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1566 cref_want & ~(CLFE_OPEN |
1568 nid_mov = (char *)rec +
1569 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1570 cref_want & ~(CLFE_NID |
1573 uidgid_mov = (char *)rec +
1574 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1575 cref_want & ~(CLFE_UIDGID |
1579 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1582 ef_mov = (char *)rec +
1583 changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1585 jid_mov = (char *)rec +
1586 changelog_rec_offset(crf_wanted &
1587 ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1589 rnm_mov = (char *)rec +
1590 changelog_rec_offset(crf_wanted &
1596 /* Move the extension fields to the desired positions */
1597 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1598 (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1599 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1600 memmove(xattr_mov, changelog_rec_xattr(rec),
1601 sizeof(struct changelog_ext_xattr));
1603 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1604 memmove(omd_mov, changelog_rec_openmode(rec),
1605 sizeof(struct changelog_ext_openmode));
1607 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1608 memmove(nid_mov, changelog_rec_nid(rec),
1609 sizeof(struct changelog_ext_nid));
1611 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1612 memmove(uidgid_mov, changelog_rec_uidgid(rec),
1613 sizeof(struct changelog_ext_uidgid));
1615 memmove(ef_mov, changelog_rec_extra_flags(rec),
1616 sizeof(struct changelog_ext_extra_flags));
1619 if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1620 memmove(jid_mov, changelog_rec_jobid(rec),
1621 sizeof(struct changelog_ext_jobid));
1623 if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1624 memmove(rnm_mov, changelog_rec_rename(rec),
1625 sizeof(struct changelog_ext_rename));
1627 /* Clear newly added fields */
1628 if (xattr_mov && (cref_want & CLFE_XATTR) &&
1629 !(cref & CLFE_XATTR))
1630 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1632 if (omd_mov && (cref_want & CLFE_OPEN) &&
1633 !(cref & CLFE_OPEN))
1634 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1636 if (nid_mov && (cref_want & CLFE_NID) &&
1638 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1640 if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1641 !(cref & CLFE_UIDGID))
1642 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1644 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1645 !(rec->cr_flags & CLF_EXTRA_FLAGS))
1646 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1648 if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1649 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1651 if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1652 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1654 /* Update the record's flags accordingly */
1655 rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1656 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1657 changelog_rec_extra_flags(rec)->cr_extra_flags =
1658 changelog_rec_extra_flags(rec)->cr_extra_flags |
1662 enum changelog_message_type {
1663 CL_RECORD = 10, /* message is a changelog_rec */
1664 CL_EOF = 11, /* at end of current changelog */
1667 /********* Misc **********/
1669 struct ioc_data_version {
1671 __u32 idv_layout_version; /* FLR: layout version for OST objects */
1672 __u32 idv_flags; /* enum ioc_data_version_flags */
1675 enum ioc_data_version_flags {
1676 LL_DV_RD_FLUSH = (1 << 0), /* Flush dirty pages from clients */
1677 LL_DV_WR_FLUSH = (1 << 1), /* Flush all caching pages from clients */
1681 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
1684 #define dot_lustre_name ".lustre"
1687 /********* HSM **********/
1689 /** HSM per-file state
1690 * See HSM_FLAGS below.
1693 HS_NONE = 0x00000000,
1694 HS_EXISTS = 0x00000001,
1695 HS_DIRTY = 0x00000002,
1696 HS_RELEASED = 0x00000004,
1697 HS_ARCHIVED = 0x00000008,
1698 HS_NORELEASE = 0x00000010,
1699 HS_NOARCHIVE = 0x00000020,
1700 HS_LOST = 0x00000040,
1703 /* HSM user-setable flags. */
1704 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1706 /* Other HSM flags. */
1707 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1710 * All HSM-related possible flags that could be applied to a file.
1711 * This should be kept in sync with hsm_states.
1713 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
1716 * HSM request progress state
1718 enum hsm_progress_states {
1725 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1728 case HPS_WAITING: return "waiting";
1729 case HPS_RUNNING: return "running";
1730 case HPS_DONE: return "done";
1731 default: return "unknown";
1738 } __attribute__((packed));
1741 * Current HSM states of a Lustre file.
1743 * This structure purpose is to be sent to user-space mainly. It describes the
1744 * current HSM flags and in-progress action.
1746 struct hsm_user_state {
1747 /** Current HSM states, from enum hsm_states. */
1749 __u32 hus_archive_id;
1750 /** The current undergoing action, if there is one */
1751 __u32 hus_in_progress_state;
1752 __u32 hus_in_progress_action;
1753 struct hsm_extent hus_in_progress_location;
1754 char hus_extended_info[];
1757 struct hsm_state_set_ioc {
1758 struct lu_fid hssi_fid;
1760 __u64 hssi_clearmask;
1764 * This structure describes the current in-progress action for a file.
1765 * it is retuned to user space and send over the wire
1767 struct hsm_current_action {
1768 /** The current undergoing action, if there is one */
1769 /* state is one of hsm_progress_states */
1771 /* action is one of hsm_user_action */
1773 struct hsm_extent hca_location;
1776 /***** HSM user requests ******/
1777 /* User-generated (lfs/ioctl) request types */
1778 enum hsm_user_action {
1779 HUA_NONE = 1, /* no action (noop) */
1780 HUA_ARCHIVE = 10, /* copy to hsm */
1781 HUA_RESTORE = 11, /* prestage */
1782 HUA_RELEASE = 12, /* drop ost objects */
1783 HUA_REMOVE = 13, /* remove from archive */
1784 HUA_CANCEL = 14 /* cancel a request */
1787 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1790 case HUA_NONE: return "NOOP";
1791 case HUA_ARCHIVE: return "ARCHIVE";
1792 case HUA_RESTORE: return "RESTORE";
1793 case HUA_RELEASE: return "RELEASE";
1794 case HUA_REMOVE: return "REMOVE";
1795 case HUA_CANCEL: return "CANCEL";
1796 default: return "UNKNOWN";
1801 * List of hr_flags (bit field)
1803 #define HSM_FORCE_ACTION 0x0001
1804 /* used by CT, cannot be set by user */
1805 #define HSM_GHOST_COPY 0x0002
1808 * Contains all the fixed part of struct hsm_user_request.
1811 struct hsm_request {
1812 __u32 hr_action; /* enum hsm_user_action */
1813 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1814 __u64 hr_flags; /* request flags */
1815 __u32 hr_itemcount; /* item count in hur_user_item vector */
1819 struct hsm_user_item {
1820 struct lu_fid hui_fid;
1821 struct hsm_extent hui_extent;
1822 } __attribute__((packed));
1824 struct hsm_user_request {
1825 struct hsm_request hur_request;
1826 struct hsm_user_item hur_user_item[0];
1827 /* extra data blob at end of struct (after all
1828 * hur_user_items), only use helpers to access it
1830 } __attribute__((packed));
1832 /** Return pointer to data field in a hsm user request */
1833 static inline void *hur_data(struct hsm_user_request *hur)
1835 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1839 * Compute the current length of the provided hsm_user_request. This returns -1
1840 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1842 * return -1 on bounds check error.
1844 static inline ssize_t hur_len(struct hsm_user_request *hur)
1848 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1849 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1850 (__u64)hur->hur_request.hr_itemcount *
1851 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1853 if (size != (ssize_t)size)
1859 /****** HSM RPCs to copytool *****/
1860 /* Message types the copytool may receive */
1861 enum hsm_message_type {
1862 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1865 /* Actions the copytool may be instructed to take for a given action_item */
1866 enum hsm_copytool_action {
1867 HSMA_NONE = 10, /* no action */
1868 HSMA_ARCHIVE = 20, /* arbitrary offset */
1874 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1877 case HSMA_NONE: return "NOOP";
1878 case HSMA_ARCHIVE: return "ARCHIVE";
1879 case HSMA_RESTORE: return "RESTORE";
1880 case HSMA_REMOVE: return "REMOVE";
1881 case HSMA_CANCEL: return "CANCEL";
1882 default: return "UNKNOWN";
1886 /* Copytool item action description */
1887 struct hsm_action_item {
1888 __u32 hai_len; /* valid size of this struct */
1889 __u32 hai_action; /* hsm_copytool_action, but use known size */
1890 struct lu_fid hai_fid; /* Lustre FID to operate on */
1891 struct lu_fid hai_dfid; /* fid used for data access */
1892 struct hsm_extent hai_extent; /* byte range to operate on */
1893 __u64 hai_cookie; /* action cookie from coordinator */
1894 __u64 hai_gid; /* grouplock id */
1895 char hai_data[0]; /* variable length */
1896 } __attribute__((packed));
1899 * helper function which print in hexa the first bytes of
1902 * \param hai [IN] record to print
1903 * \param buffer [IN,OUT] buffer to write the hex string to
1904 * \param len [IN] max buffer length
1908 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1909 char *buffer, size_t len)
1916 data_len = hai->hai_len - sizeof(*hai);
1917 for (i = 0; (i < data_len) && (len > 2); i++) {
1918 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1928 /* Copytool action list */
1929 #define HAL_VERSION 1
1930 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1931 struct hsm_action_list {
1933 __u32 hal_count; /* number of hai's to follow */
1934 __u64 hal_compound_id; /* returned by coordinator, ignored */
1936 __u32 hal_archive_id; /* which archive backend */
1938 char hal_fsname[0]; /* null-terminated */
1939 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1940 boundaries. See hai_zero */
1941 } __attribute__((packed));
1943 /* Return pointer to first hai in action list */
1944 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1946 size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1948 return (struct hsm_action_item *)(hal->hal_fsname + offset);
1951 /* Return pointer to next hai */
1952 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1954 size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
1956 return (struct hsm_action_item *)((char *)hai + offset);
1959 /* Return size of an hsm_action_list */
1960 static inline size_t hal_size(struct hsm_action_list *hal)
1964 struct hsm_action_item *hai;
1966 sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1967 hai = hai_first(hal);
1968 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1969 sz += __ALIGN_KERNEL(hai->hai_len, 8);
1975 * describe the attributes to be set on imported file
1977 struct hsm_user_import {
1986 __u32 hui_archive_id;
1989 /* Copytool progress reporting */
1990 #define HP_FLAG_COMPLETED 0x01
1991 #define HP_FLAG_RETRY 0x02
1993 struct hsm_progress {
1994 struct lu_fid hp_fid;
1996 struct hsm_extent hp_extent;
1998 __u16 hp_errval; /* positive val */
2003 __u64 hc_data_version;
2005 __u16 hc_errval; /* positive val */
2007 struct hsm_action_item hc_hai;
2011 enum llapi_json_types {
2012 LLAPI_JSON_INTEGER = 1,
2018 struct llapi_json_item {
2027 struct llapi_json_item *lji_next;
2030 struct llapi_json_item_list {
2031 int ljil_item_count;
2032 struct llapi_json_item *ljil_items;
2035 enum lu_ladvise_type {
2036 LU_LADVISE_INVALID = 0,
2037 LU_LADVISE_WILLREAD = 1,
2038 LU_LADVISE_DONTNEED = 2,
2039 LU_LADVISE_LOCKNOEXPAND = 3,
2040 LU_LADVISE_LOCKAHEAD = 4,
2044 #define LU_LADVISE_NAMES { \
2045 [LU_LADVISE_WILLREAD] = "willread", \
2046 [LU_LADVISE_DONTNEED] = "dontneed", \
2047 [LU_LADVISE_LOCKNOEXPAND] = "locknoexpand", \
2048 [LU_LADVISE_LOCKAHEAD] = "lockahead", \
2051 /* This is the userspace argument for ladvise. It is currently the same as
2052 * what goes on the wire (struct lu_ladvise), but is defined separately as we
2053 * may need info which is only used locally. */
2054 struct llapi_lu_ladvise {
2055 __u16 lla_advice; /* advice type */
2056 __u16 lla_value1; /* values for different advice types */
2058 __u64 lla_start; /* first byte of extent for advice */
2059 __u64 lla_end; /* last byte of extent for advice */
2065 LF_ASYNC = 0x00000001,
2066 LF_UNSET = 0x00000002,
2069 #define LADVISE_MAGIC 0x1ADF1CE0
2070 /* Masks of valid flags for each advice */
2071 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2072 /* Flags valid for all advices not explicitly specified */
2073 #define LF_DEFAULT_MASK LF_ASYNC
2075 #define LF_MASK (LF_ASYNC | LF_UNSET)
2077 #define lla_lockahead_mode lla_value1
2078 #define lla_peradvice_flags lla_value2
2079 #define lla_lockahead_result lla_value3
2081 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2082 * is used on the wire. It is defined separately as we may need info which is
2083 * only used locally. */
2084 struct llapi_ladvise_hdr {
2085 __u32 lah_magic; /* LADVISE_MAGIC */
2086 __u32 lah_count; /* number of advices */
2087 __u64 lah_flags; /* from enum ladvise_flag */
2088 __u32 lah_value1; /* unused */
2089 __u32 lah_value2; /* unused */
2090 __u64 lah_value3; /* unused */
2091 struct llapi_lu_ladvise lah_advise[0]; /* advices in this header */
2094 #define LAH_COUNT_MAX (1024)
2098 SK_CRYPT_INVALID = -1,
2100 SK_CRYPT_AES256_CTR = 1,
2104 SK_HMAC_INVALID = -1,
2110 struct sk_crypt_type {
2111 const char *sct_name;
2115 struct sk_hmac_type {
2116 const char *sht_name;
2120 enum lock_mode_user {
2126 #define LOCK_MODE_NAMES { \
2127 [MODE_READ_USER] = "READ",\
2128 [MODE_WRITE_USER] = "WRITE"\
2131 enum lockahead_results {
2132 LLA_RESULT_SENT = 0,
2133 LLA_RESULT_DIFFERENT,
2137 #if defined(__cplusplus)
2141 /** @} lustreuser */
2143 #endif /* _LUSTRE_USER_H */