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 */
127 /** filesystem statistics/attributes for target device */
129 __u64 os_type; /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
130 __u64 os_blocks; /* total size in #os_bsize blocks */
131 __u64 os_bfree; /* number of unused blocks */
132 __u64 os_bavail; /* blocks available for allocation */
133 __u64 os_files; /* total number of objects */
134 __u64 os_ffree; /* # objects that could be created */
135 __u8 os_fsid[40]; /* identifier for filesystem */
136 __u32 os_bsize; /* block size in bytes for os_blocks */
137 __u32 os_namelen; /* maximum length of filename in bytes*/
138 __u64 os_maxbytes; /* maximum object size in bytes */
139 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
140 __u32 os_fprecreated; /* objs available now to the caller */
141 /* used in QoS code to find preferred
143 __u32 os_spare2; /* Unused padding fields. Remember */
144 __u32 os_spare3; /* to fix lustre_swab_obd_statfs() */
156 * FID is a cluster-wide unique identifier of a file or an object (stripe).
157 * FIDs are never reused.
161 * FID sequence. Sequence is a unit of migration: all files (objects)
162 * with FIDs from a given sequence are stored on the same server.
163 * Lustre should support 2^64 objects, so even if each sequence
164 * has only a single object we can still enumerate 2^64 objects.
167 /* FID number within sequence. */
170 * FID version, used to distinguish different versions (in the sense
171 * of snapshots, etc.) of the same file system object. Not currently
177 static inline bool fid_is_zero(const struct lu_fid *fid)
179 return fid->f_seq == 0 && fid->f_oid == 0;
182 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
183 * MDT-object's FID::f_ver, instead it is the OST-object index in its
184 * parent MDT-object's layout EA. */
185 #define f_stripe_idx f_ver
188 __u32 ol_stripe_size;
189 __u32 ol_stripe_count;
193 } __attribute__((packed));
195 /* keep this one for compatibility */
196 struct filter_fid_old {
197 struct lu_fid ff_parent;
203 struct lu_fid ff_parent;
204 struct ost_layout ff_layout;
205 __u32 ff_layout_version;
206 __u32 ff_range; /* range of layout version that
207 * write are allowed */
208 } __attribute__((packed));
210 /* Userspace should treat lu_fid as opaque, and only use the following methods
211 * to print or parse them. Other functions (e.g. compare, swab) could be moved
212 * here from lustre_idl.h if needed. */
216 LMAC_HSM = 0x00000001,
217 /* LMAC_SOM = 0x00000002, obsolete since 2.8.0 */
218 LMAC_NOT_IN_OI = 0x00000004, /* the object does NOT need OI mapping */
219 LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
220 * under /O/<seq>/d<x>. */
221 LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
222 LMAC_COMP_INFO = 0x00000020, /* Component info in the LMA EA. */
223 LMAC_IDX_BACKUP = 0x00000040, /* Has index backup. */
227 * Masks for all features that should be supported by a Lustre version to
228 * access a specific file.
229 * This information is stored in lustre_mdt_attrs::lma_incompat.
232 LMAI_RELEASED = 0x00000001, /* file is released */
233 LMAI_AGENT = 0x00000002, /* agent inode */
234 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
235 is on the remote MDT */
236 LMAI_STRIPED = 0x00000008, /* striped directory inode */
237 LMAI_ORPHAN = 0x00000010, /* inode is orphan */
238 LMA_INCOMPAT_SUPP = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
239 LMAI_STRIPED | LMAI_ORPHAN)
244 * Following struct for object attributes, that will be kept inode's EA.
245 * Introduced in 2.0 release (please see b15993, for details)
246 * Added to all objects since Lustre 2.4 as contains self FID
248 struct lustre_mdt_attrs {
250 * Bitfield for supported data in this structure. From enum lma_compat.
251 * lma_self_fid and lma_flags are always available.
255 * Per-file incompat feature list. Lustre version should support all
256 * flags set in this field. The supported feature mask is available in
260 /** FID of this inode */
261 struct lu_fid lma_self_fid;
264 struct lustre_ost_attrs {
265 /* Use lustre_mdt_attrs directly for now, need a common header
266 * structure if want to change lustre_mdt_attrs in future. */
267 struct lustre_mdt_attrs loa_lma;
269 /* Below five elements are for OST-object's PFID EA, the
270 * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
271 * and the stripe_index (low 16 bits), the size should not exceed
272 * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
273 * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
274 * are valid; if the flag LMAC_COMP_INFO is set, then the next three
275 * loa_comp_* elements are valid. */
276 struct lu_fid loa_parent_fid;
277 __u32 loa_stripe_size;
279 __u64 loa_comp_start;
284 * Prior to 2.4, the LMA structure also included SOM attributes which has since
285 * been moved to a dedicated xattr
286 * lma_flags was also removed because of lma_compat/incompat fields.
288 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
290 enum lustre_som_flags {
291 /* Unknow or no SoM data, must get size from OSTs. */
292 SOM_FL_UNKNOWN = 0x0000,
293 /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
294 SOM_FL_STRICT = 0x0001,
295 /* Known stale - was right at some point in the past, but it is
296 * known (or likely) to be incorrect now (e.g. opened for write). */
297 SOM_FL_STALE = 0x0002,
298 /* Approximate, may never have been strictly correct,
299 * need to sync SOM data to achieve eventual consistency. */
300 SOM_FL_LAZY = 0x0004,
303 struct lustre_som_attrs {
305 __u16 lsa_reserved[3];
311 * OST object IDentifier.
319 struct lu_fid oi_fid;
323 #define DOSTID "%#llx:%llu"
324 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
325 ((unsigned long long)ostid_id(oi))
327 struct ll_futimes_3 {
329 __u64 lfu_atime_nsec;
331 __u64 lfu_mtime_nsec;
333 __u64 lfu_ctime_nsec;
337 * Maximum number of mirrors currently implemented.
339 #define LUSTRE_MIRROR_COUNT_MAX 16
341 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
343 LL_LEASE_RDLCK = 0x01,
344 LL_LEASE_WRLCK = 0x02,
345 LL_LEASE_UNLCK = 0x04,
348 enum ll_lease_flags {
349 LL_LEASE_RESYNC = 0x1,
350 LL_LEASE_RESYNC_DONE = 0x2,
351 LL_LEASE_LAYOUT_MERGE = 0x4,
352 LL_LEASE_LAYOUT_SPLIT = 0x8,
355 #define IOC_IDS_MAX 4096
356 struct ll_ioc_lease {
364 * The ioctl naming rules:
365 * LL_* - works on the currently opened filehandle instead of parent dir
366 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
367 * *_MDC_* - gets/sets data related to MDC
368 * *_LOV_* - gets/sets data related to OSC/LOV
369 * *FILE* - called on parent dir and passes in a filename
370 * *STRIPE* - set/get lov_user_md
371 * *INFO - set/get lov_user_mds_data
373 /* lustre_ioctl.h 101-150 */
374 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
375 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
376 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
377 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
378 #define LL_IOC_LOV_SETSTRIPE_NEW _IOWR('f', 154, struct lov_user_md)
379 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
380 #define LL_IOC_LOV_GETSTRIPE_NEW _IOR('f', 155, struct lov_user_md)
381 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
382 /* LL_IOC_RECREATE_OBJ 157 obsolete */
383 /* LL_IOC_RECREATE_FID 157 obsolete */
384 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
385 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
386 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
387 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
388 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
389 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
390 /* IOC_LOV_GETINFO 165 obsolete */
391 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
392 /* LL_IOC_RMTACL 167 obsolete */
393 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
394 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
395 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
396 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
397 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
398 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
399 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
400 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
401 #define LL_IOC_FUTIMES_3 _IOWR('f', 176, struct ll_futimes_3)
402 #define LL_IOC_FLR_SET_MIRROR _IOW ('f', 177, long)
403 /* lustre_ioctl.h 177-210 */
404 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
405 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
406 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
407 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
408 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
409 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
410 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
411 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
412 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
413 struct lustre_swap_layouts)
414 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
415 struct hsm_current_action)
416 /* lustre_ioctl.h 221-232 */
417 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
418 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
419 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
420 #define LL_IOC_SET_LEASE _IOWR('f', 243, struct ll_ioc_lease)
421 #define LL_IOC_SET_LEASE_OLD _IOWR('f', 243, long)
422 #define LL_IOC_GET_LEASE _IO('f', 244)
423 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
424 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
425 #define LL_IOC_MIGRATE _IOR('f', 247, int)
426 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
427 #define LL_IOC_GETPARENT _IOWR('f', 249, struct getparent)
428 #define LL_IOC_LADVISE _IOR('f', 250, struct llapi_lu_ladvise)
430 #ifndef FS_IOC_FSGETXATTR
432 * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
435 __u32 fsx_xflags; /* xflags field value (get/set) */
436 __u32 fsx_extsize; /* extsize field value (get/set)*/
437 __u32 fsx_nextents; /* nextents field value (get) */
438 __u32 fsx_projid; /* project identifier (get/set) */
439 unsigned char fsx_pad[12];
441 #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
442 #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
444 #define LL_IOC_FSGETXATTR FS_IOC_FSGETXATTR
445 #define LL_IOC_FSSETXATTR FS_IOC_FSSETXATTR
446 #ifndef FS_XFLAG_PROJINHERIT
447 #define FS_XFLAG_PROJINHERIT 0x00000200
451 #define LL_STATFS_LMV 1
452 #define LL_STATFS_LOV 2
453 #define LL_STATFS_NODELAY 4
455 #define IOC_MDC_TYPE 'i'
456 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
457 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
458 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
459 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
461 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
463 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
464 * files, but are unlikely to be used in practice and are not harmful if
465 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
466 * devices and are safe for use on new files. See LU-4209. */
467 /* To be compatible with old statically linked binary we keep the check for
468 * the older 0100000000 flag. This is already removed upstream. LU-812. */
469 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
470 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
471 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
472 O_LOV_DELAY_CREATE_MASK)
474 #define LL_FILE_IGNORE_LOCK 0x00000001
475 #define LL_FILE_GROUP_LOCKED 0x00000002
476 #define LL_FILE_READAHEA 0x00000004
477 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
478 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
480 #define LOV_USER_MAGIC_V1 0x0BD10BD0
481 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
482 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
483 #define LOV_USER_MAGIC_V3 0x0BD30BD0
484 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
485 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0 /* for specific OSTs */
486 #define LOV_USER_MAGIC_COMP_V1 0x0BD60BD0
488 #define LMV_USER_MAGIC 0x0CD30CD0 /* default lmv magic */
489 #define LMV_USER_MAGIC_V0 0x0CD20CD0 /* old default lmv magic*/
490 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
492 #define LOV_PATTERN_NONE 0x000
493 #define LOV_PATTERN_RAID0 0x001
494 #define LOV_PATTERN_RAID1 0x002
495 #define LOV_PATTERN_MDT 0x100
496 #define LOV_PATTERN_CMOBD 0x200
498 #define LOV_PATTERN_F_MASK 0xffff0000
499 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
500 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
501 #define LOV_PATTERN_DEFAULT 0xffffffff
503 static inline bool lov_pattern_supported(__u32 pattern)
505 return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
506 (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
509 #define LOV_MAXPOOLNAME 15
510 #define LOV_POOLNAMEF "%.15s"
512 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
513 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
514 #define LOV_MAX_STRIPE_COUNT_OLD 160
515 /* This calculation is crafted so that input of 4096 will result in 160
516 * which in turn is equal to old maximal stripe count.
517 * XXX: In fact this is too simpified for now, what it also need is to get
518 * ea_type argument to clearly know how much space each stripe consumes.
520 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
521 * allocation that is sufficient for the current generation of systems.
523 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
524 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
525 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
526 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
528 #define XATTR_LUSTRE_PREFIX "lustre."
529 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
531 #define lov_user_ost_data lov_user_ost_data_v1
532 struct lov_user_ost_data_v1 { /* per-stripe data structure */
533 struct ost_id l_ost_oi; /* OST object ID */
534 __u32 l_ost_gen; /* generation of this OST index */
535 __u32 l_ost_idx; /* OST index in LOV */
536 } __attribute__((packed));
538 #define lov_user_md lov_user_md_v1
539 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
540 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
541 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
542 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
543 __u32 lmm_stripe_size; /* size of stripe in bytes */
544 __u16 lmm_stripe_count; /* num stripes in use for this object */
546 __u16 lmm_stripe_offset; /* starting stripe offset in
547 * lmm_objects, use when writing */
548 __u16 lmm_layout_gen; /* layout generation number
549 * used when reading */
551 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
552 } __attribute__((packed, __may_alias__));
554 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
555 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
556 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
557 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
558 __u32 lmm_stripe_size; /* size of stripe in bytes */
559 __u16 lmm_stripe_count; /* num stripes in use for this object */
561 __u16 lmm_stripe_offset; /* starting stripe offset in
562 * lmm_objects, use when writing */
563 __u16 lmm_layout_gen; /* layout generation number
564 * used when reading */
566 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
567 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
568 } __attribute__((packed));
575 #define DEXT "[%#llx, %#llx)"
576 #define PEXT(ext) (ext)->e_start, (ext)->e_end
578 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
579 struct lu_extent *e2)
581 return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
584 static inline bool lu_extent_is_whole(struct lu_extent *e)
586 return e->e_start == 0 && e->e_end == LUSTRE_EOF;
589 enum lov_comp_md_entry_flags {
590 LCME_FL_STALE = 0x00000001, /* FLR: stale data */
591 LCME_FL_PREF_RD = 0x00000002, /* FLR: preferred for reading */
592 LCME_FL_PREF_WR = 0x00000004, /* FLR: preferred for writing */
593 LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
594 LCME_FL_OFFLINE = 0x00000008, /* Not used */
595 LCME_FL_INIT = 0x00000010, /* instantiated */
596 LCME_FL_NEG = 0x80000000 /* used to indicate a negative flag,
597 won't be stored on disk */
600 #define LCME_KNOWN_FLAGS (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
602 /* The flags can be set by users at mirror creation time. */
603 #define LCME_USER_FLAGS (LCME_FL_PREF_RW)
605 /* the highest bit in obdo::o_layout_version is used to mark if the file is
607 #define LU_LAYOUT_RESYNC LCME_FL_NEG
609 /* lcme_id can be specified as certain flags, and the the first
610 * bit of lcme_id is used to indicate that the ID is representing
611 * certain LCME_FL_* but not a real ID. Which implies we can have
612 * at most 31 flags (see LCME_FL_XXX). */
615 LCME_ID_MAX = 0x7FFFFFFF,
616 LCME_ID_ALL = 0xFFFFFFFF,
617 LCME_ID_NOT_ID = LCME_FL_NEG
620 #define LCME_ID_MASK LCME_ID_MAX
622 struct lov_comp_md_entry_v1 {
623 __u32 lcme_id; /* unique id of component */
624 __u32 lcme_flags; /* LCME_FL_XXX */
625 struct lu_extent lcme_extent; /* file extent for component */
626 __u32 lcme_offset; /* offset of component blob,
627 start from lov_comp_md_v1 */
628 __u32 lcme_size; /* size of component blob */
629 __u32 lcme_layout_gen;
630 __u32 lcme_padding_1;
631 __u64 lcme_padding_2;
632 } __attribute__((packed));
634 #define SEQ_ID_MAX 0x0000FFFF
635 #define SEQ_ID_MASK SEQ_ID_MAX
636 /* bit 30:16 of lcme_id is used to store mirror id */
637 #define MIRROR_ID_MASK 0x7FFF0000
638 #define MIRROR_ID_SHIFT 16
640 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
642 return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
645 static inline __u16 mirror_id_of(__u32 id)
647 return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
651 * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
653 enum lov_comp_md_flags {
654 /* the least 2 bits are used by FLR to record file state */
657 LCM_FL_WRITE_PENDING = 2,
658 LCM_FL_SYNC_PENDING = 3,
659 LCM_FL_FLR_MASK = 0x3,
662 struct lov_comp_md_v1 {
663 __u32 lcm_magic; /* LOV_USER_MAGIC_COMP_V1 */
664 __u32 lcm_size; /* overall size including this struct */
665 __u32 lcm_layout_gen;
667 __u16 lcm_entry_count;
668 /* lcm_mirror_count stores the number of actual mirrors minus 1,
669 * so that non-flr files will have value 0 meaning 1 mirror. */
670 __u16 lcm_mirror_count;
671 __u16 lcm_padding1[3];
673 struct lov_comp_md_entry_v1 lcm_entries[0];
674 } __attribute__((packed));
676 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
678 if (stripes == (__u16)-1)
681 if (lmm_magic == LOV_USER_MAGIC_V1)
682 return sizeof(struct lov_user_md_v1) +
683 stripes * sizeof(struct lov_user_ost_data_v1);
684 return sizeof(struct lov_user_md_v3) +
685 stripes * sizeof(struct lov_user_ost_data_v1);
688 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
689 * use this. It is unsafe to #define those values in this header as it
690 * is possible the application has already #included <sys/stat.h>. */
691 #ifdef HAVE_LOV_USER_MDS_DATA
692 #define lov_user_mds_data lov_user_mds_data_v1
693 struct lov_user_mds_data_v1 {
694 lstat_t lmd_st; /* MDS stat struct */
695 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
696 } __attribute__((packed));
699 struct lmv_user_mds_data {
700 struct lu_fid lum_fid;
706 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
707 LMV_HASH_TYPE_ALL_CHARS = 1,
708 LMV_HASH_TYPE_FNV_1A_64 = 2,
712 #define LMV_HASH_NAME_ALL_CHARS "all_char"
713 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
715 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
717 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
718 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
719 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
720 #define lmv_user_md lmv_user_md_v1
721 struct lmv_user_md_v1 {
722 __u32 lum_magic; /* must be the first field */
723 __u32 lum_stripe_count; /* dirstripe count */
724 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
725 __u32 lum_hash_type; /* Dir stripe policy */
726 __u32 lum_type; /* LMV type: default or normal */
730 char lum_pool_name[LOV_MAXPOOLNAME + 1];
731 struct lmv_user_mds_data lum_objects[0];
732 } __attribute__((packed));
734 static inline int lmv_user_md_size(int stripes, int lmm_magic)
736 int size = sizeof(struct lmv_user_md);
738 if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
739 size += stripes * sizeof(struct lmv_user_mds_data);
744 struct ll_recreate_obj {
750 __u64 id; /* holds object id */
751 __u32 generation; /* holds object generation */
752 __u32 f_type; /* holds object type or stripe idx when passing it to
753 * OST for saving into EA. */
761 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
762 const struct obd_uuid *u2)
764 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
767 static inline int obd_uuid_empty(struct obd_uuid *uuid)
769 return uuid->uuid[0] == '\0';
772 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
774 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
775 uuid->uuid[sizeof(*uuid) - 1] = '\0';
778 /* For printf's only, make sure uuid is terminated */
779 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
784 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
785 /* Obviously not safe, but for printfs, no real harm done...
786 we're always null-terminated, even in a race. */
787 static char temp[sizeof(*uuid)];
788 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
789 temp[sizeof(*uuid) - 1] = '\0';
792 return (char *)(uuid->uuid);
795 #define LUSTRE_MAXFSNAME 8
797 /* Extract fsname from uuid (or target name) of a target
798 e.g. (myfs-OST0007_UUID -> myfs)
799 see also deuuidify. */
800 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
804 strncpy(buf, uuid, buflen - 1);
805 buf[buflen - 1] = '\0';
806 p = strrchr(buf, '-');
811 /* printf display format for Lustre FIDs
812 * usage: printf("file FID is "DFID"\n", PFID(fid)); */
813 #define FID_NOBRACE_LEN 40
814 #define FID_LEN (FID_NOBRACE_LEN + 2)
815 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
816 #define DFID "["DFID_NOBRACE"]"
817 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
819 /* scanf input parse format for fids in DFID_NOBRACE format
820 * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
821 * usage: sscanf(fidstr, SFID, RFID(&fid)); */
822 #define SFID "0x%llx:0x%x:0x%x"
823 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
825 /********* Quotas **********/
827 #define LUSTRE_QUOTABLOCK_BITS 10
828 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
830 static inline __u64 lustre_stoqb(size_t space)
832 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
835 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
836 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
837 #define Q_GETOINFO 0x800102 /* get obd quota info */
838 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
839 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
841 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
842 #define LUSTRE_Q_QUOTAON 0x800002 /* deprecated as of 2.4 */
843 #define LUSTRE_Q_QUOTAOFF 0x800003 /* deprecated as of 2.4 */
844 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
845 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
846 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
847 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
848 /* lustre-specific control commands */
849 #define LUSTRE_Q_INVALIDATE 0x80000b /* deprecated as of 2.4 */
850 #define LUSTRE_Q_FINVALIDATE 0x80000c /* deprecated as of 2.4 */
851 #define LUSTRE_Q_GETDEFAULT 0x80000d /* get default quota */
852 #define LUSTRE_Q_SETDEFAULT 0x80000e /* set default quota */
854 /* In the current Lustre implementation, the grace time is either the time
855 * or the timestamp to be used after some quota ID exceeds the soft limt,
856 * 48 bits should be enough, its high 16 bits can be used as quota flags.
858 #define LQUOTA_GRACE_BITS 48
859 #define LQUOTA_GRACE_MASK ((1ULL << LQUOTA_GRACE_BITS) - 1)
860 #define LQUOTA_GRACE_MAX LQUOTA_GRACE_MASK
861 #define LQUOTA_GRACE(t) (t & LQUOTA_GRACE_MASK)
862 #define LQUOTA_FLAG(t) (t >> LQUOTA_GRACE_BITS)
863 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
865 /* different quota flags */
867 /* the default quota flag, the corresponding quota ID will use the default
868 * quota setting, the hardlimit and softlimit of its quota record in the global
869 * quota file will be set to 0, the low 48 bits of the grace will be set to 0
870 * and high 16 bits will contain this flag (see above comment).
872 #define LQUOTA_FLAG_DEFAULT 0x0001
874 #define ALLQUOTA 255 /* set all quota */
875 static inline char *qtype_name(int qtype)
888 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
891 #define N_PERMS_MAX 64
893 struct perm_downcall_data {
899 struct identity_downcall_data {
906 struct perm_downcall_data idd_perms[N_PERMS_MAX];
910 #ifdef NEED_QUOTA_DEFS
912 #define QIF_BLIMITS 1
914 #define QIF_ILIMITS 4
918 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
919 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
920 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
921 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
924 #endif /* !__KERNEL__ */
926 /* lustre volatile file support
927 * file name header: ".^L^S^T^R:volatile"
929 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
930 #define LUSTRE_VOLATILE_HDR_LEN 14
932 enum lustre_quota_version {
936 /* XXX: same as if_dqinfo struct in kernel */
944 /* XXX: same as if_dqblk struct in kernel, plus one padding */
946 __u64 dqb_bhardlimit;
947 __u64 dqb_bsoftlimit;
949 __u64 dqb_ihardlimit;
950 __u64 dqb_isoftlimit;
972 struct obd_dqinfo qc_dqinfo;
973 struct obd_dqblk qc_dqblk;
975 struct obd_uuid obd_uuid;
978 /* swap layout flags */
979 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
980 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
981 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
982 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
983 #define SWAP_LAYOUTS_CLOSE (1 << 4)
985 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
986 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
987 struct lustre_swap_layouts {
995 /** Bit-mask of valid attributes */
996 /* The LA_* flags are written to disk as part of the ChangeLog records
997 * so they are part of the on-disk and network protocol, and cannot be changed.
998 * Only the first 12 bits are currently saved.
1013 LA_BLKSIZE = 1 << 12,
1014 LA_KILL_SUID = 1 << 13,
1015 LA_KILL_SGID = 1 << 14,
1016 LA_PROJID = 1 << 15,
1017 LA_LAYOUT_VERSION = 1 << 16,
1019 LA_LBLOCKS = 1 << 18,
1021 * Attributes must be transmitted to OST objects
1023 LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1026 #define MDS_FMODE_READ 00000001
1027 #define MDS_FMODE_WRITE 00000002
1029 #define MDS_FMODE_CLOSED 00000000
1030 #define MDS_FMODE_EXEC 00000004
1031 /* MDS_FMODE_EPOCH 01000000 obsolete since 2.8.0 */
1032 /* MDS_FMODE_TRUNC 02000000 obsolete since 2.8.0 */
1033 /* MDS_FMODE_SOM 04000000 obsolete since 2.8.0 */
1035 #define MDS_OPEN_CREATED 00000010
1036 #define MDS_OPEN_CROSS 00000020
1038 #define MDS_OPEN_CREAT 00000100
1039 #define MDS_OPEN_EXCL 00000200
1040 #define MDS_OPEN_TRUNC 00001000
1041 #define MDS_OPEN_APPEND 00002000
1042 #define MDS_OPEN_SYNC 00010000
1043 #define MDS_OPEN_DIRECTORY 00200000
1045 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
1046 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1047 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1048 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1049 * We do not support JOIN FILE
1050 * anymore, reserve this flags
1051 * just for preventing such bit
1054 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1055 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1056 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1057 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1058 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1060 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
1062 #define MDS_OPEN_LEASE 01000000000000ULL /* Open the file and grant lease
1063 * delegation, succeed if it's not
1064 * being opened with conflict mode.
1066 #define MDS_OPEN_RELEASE 02000000000000ULL /* Open the file for HSM release */
1068 #define MDS_OPEN_RESYNC 04000000000000ULL /* FLR: file resync */
1070 /* lustre internal open flags, which should not be set from user space */
1071 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS | \
1072 MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK | \
1073 MDS_OPEN_BY_FID | MDS_OPEN_LEASE | \
1074 MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1077 /********* Changelogs **********/
1078 /** Changelog record types */
1079 enum changelog_rec_type {
1081 CL_CREATE = 1, /* namespace */
1082 CL_MKDIR = 2, /* namespace */
1083 CL_HARDLINK = 3, /* namespace */
1084 CL_SOFTLINK = 4, /* namespace */
1085 CL_MKNOD = 5, /* namespace */
1086 CL_UNLINK = 6, /* namespace */
1087 CL_RMDIR = 7, /* namespace */
1088 CL_RENAME = 8, /* namespace */
1089 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
1090 CL_OPEN = 10, /* not currently used */
1091 CL_CLOSE = 11, /* may be written to log only with mtime change */
1092 CL_LAYOUT = 12, /* file layout/striping modified */
1096 CL_XATTR = CL_SETXATTR, /* Deprecated name */
1097 CL_HSM = 16, /* HSM specific events, see flags */
1098 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
1102 CL_FLRW = 21, /* FLR: file was firstly written */
1103 CL_RESYNC = 22, /* FLR: file was resync-ed */
1105 CL_DN_OPEN = 24, /* denied open */
1109 static inline const char *changelog_type2str(int type) {
1110 static const char *changelog_str[] = {
1111 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1112 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
1113 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "MIGRT",
1114 "FLRW", "RESYNC","GXATR", "NOPEN",
1117 if (type >= 0 && type < CL_LAST)
1118 return changelog_str[type];
1122 /* per-record flags */
1123 #define CLF_FLAGSHIFT 12
1124 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
1125 #define CLF_VERMASK (~CLF_FLAGMASK)
1126 enum changelog_rec_flags {
1127 CLF_VERSION = 0x1000,
1128 CLF_RENAME = 0x2000,
1130 CLF_EXTRA_FLAGS = 0x8000,
1131 CLF_SUPPORTED = CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS
1135 /* Anything under the flagmask may be per-type (if desired) */
1136 /* Flags for unlink */
1137 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
1138 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1139 /* HSM cleaning needed */
1140 /* Flags for rename */
1141 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
1143 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
1144 * has an archive in backend */
1147 /* 12b used (from high weight to low weight):
1152 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
1153 #define CLF_HSM_ERR_H 6
1154 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
1155 #define CLF_HSM_EVENT_H 9
1156 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
1157 #define CLF_HSM_FLAG_H 11
1158 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
1159 #define CLF_HSM_SPARE_H 15
1160 #define CLF_HSM_LAST 15
1162 /* Remove bits higher than _h, then extract the value
1163 * between _h and _l by shifting lower weigth to bit 0. */
1164 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1165 >> (CLF_HSM_LAST - _h + _l))
1167 #define CLF_HSM_SUCCESS 0x00
1168 #define CLF_HSM_MAXERROR 0x7E
1169 #define CLF_HSM_ERROVERFLOW 0x7F
1171 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
1173 /* 3 bits field => 8 values allowed */
1185 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1187 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1191 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
1193 *flags |= (he << CLF_HSM_EVENT_L);
1196 static inline __u16 hsm_get_cl_flags(int flags)
1198 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1201 static inline void hsm_set_cl_flags(int *flags, int bits)
1203 *flags |= (bits << CLF_HSM_FLAG_L);
1206 static inline int hsm_get_cl_error(int flags)
1208 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1211 static inline void hsm_set_cl_error(int *flags, int error)
1213 *flags |= (error << CLF_HSM_ERR_L);
1216 enum changelog_rec_extra_flags {
1218 CLFE_UIDGID = 0x0001,
1221 CLFE_XATTR = 0x0008,
1222 CLFE_SUPPORTED = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1225 enum changelog_send_flag {
1226 /* Not yet implemented */
1227 CHANGELOG_FLAG_FOLLOW = 0x01,
1228 /* Blocking IO makes sense in case of slow user parsing of the records,
1229 * but it also prevents us from cleaning up if the records are not
1231 CHANGELOG_FLAG_BLOCK = 0x02,
1232 /* Pack jobid into the changelog records if available. */
1233 CHANGELOG_FLAG_JOBID = 0x04,
1234 /* Pack additional flag bits into the changelog record */
1235 CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1238 enum changelog_send_extra_flag {
1239 /* Pack uid/gid into the changelog record */
1240 CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1241 /* Pack nid into the changelog record */
1242 CHANGELOG_EXTRA_FLAG_NID = 0x02,
1243 /* Pack open mode into the changelog record */
1244 CHANGELOG_EXTRA_FLAG_OMODE = 0x04,
1245 /* Pack xattr name into the changelog record */
1246 CHANGELOG_EXTRA_FLAG_XATTR = 0x08,
1249 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1250 changelog_rec_offset(CLF_SUPPORTED, \
1253 /* 31 usable bytes string + null terminator. */
1254 #define LUSTRE_JOBID_SIZE 32
1256 /* This is the minimal changelog record. It can contain extensions
1257 * such as rename fields or process jobid. Its exact content is described
1258 * by the cr_flags and cr_extra_flags.
1260 * Extensions are packed in the same order as their corresponding flags,
1261 * then in the same order as their corresponding extra flags.
1263 struct changelog_rec {
1265 __u16 cr_flags; /**< \a changelog_rec_flags */
1266 __u32 cr_type; /**< \a changelog_rec_type */
1267 __u64 cr_index; /**< changelog record number */
1268 __u64 cr_prev; /**< last index for this target fid */
1271 struct lu_fid cr_tfid; /**< target fid */
1272 __u32 cr_markerflags; /**< CL_MARK flags */
1274 struct lu_fid cr_pfid; /**< parent fid */
1277 /* Changelog extension for RENAME. */
1278 struct changelog_ext_rename {
1279 struct lu_fid cr_sfid; /**< source fid, or zero */
1280 struct lu_fid cr_spfid; /**< source parent fid, or zero */
1283 /* Changelog extension to include JOBID. */
1284 struct changelog_ext_jobid {
1285 char cr_jobid[LUSTRE_JOBID_SIZE]; /**< zero-terminated string. */
1288 /* Changelog extension to include additional flags. */
1289 struct changelog_ext_extra_flags {
1290 __u64 cr_extra_flags; /* Additional CLFE_* flags */
1293 /* Changelog extra extension to include UID/GID. */
1294 struct changelog_ext_uidgid {
1299 /* Changelog extra extension to include NID. */
1300 struct changelog_ext_nid {
1301 /* have __u64 instead of lnet_nid_t type for use by client api */
1303 /* for use when IPv6 support is added */
1308 /* Changelog extra extension to include OPEN mode. */
1309 struct changelog_ext_openmode {
1313 /* Changelog extra extension to include xattr */
1314 struct changelog_ext_xattr {
1315 char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1318 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1319 const struct changelog_rec *rec);
1321 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1322 enum changelog_rec_extra_flags cref)
1324 size_t size = sizeof(struct changelog_rec);
1326 if (crf & CLF_RENAME)
1327 size += sizeof(struct changelog_ext_rename);
1329 if (crf & CLF_JOBID)
1330 size += sizeof(struct changelog_ext_jobid);
1332 if (crf & CLF_EXTRA_FLAGS) {
1333 size += sizeof(struct changelog_ext_extra_flags);
1334 if (cref & CLFE_UIDGID)
1335 size += sizeof(struct changelog_ext_uidgid);
1336 if (cref & CLFE_NID)
1337 size += sizeof(struct changelog_ext_nid);
1338 if (cref & CLFE_OPEN)
1339 size += sizeof(struct changelog_ext_openmode);
1340 if (cref & CLFE_XATTR)
1341 size += sizeof(struct changelog_ext_xattr);
1347 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1349 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1351 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1352 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1354 return changelog_rec_offset(rec->cr_flags, cref);
1357 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1359 return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1363 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1365 enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1367 return (struct changelog_ext_rename *)((char *)rec +
1368 changelog_rec_offset(crf,
1372 /* The jobid follows the rename extension, if present */
1374 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1376 enum changelog_rec_flags crf = rec->cr_flags &
1377 (CLF_VERSION | CLF_RENAME);
1379 return (struct changelog_ext_jobid *)((char *)rec +
1380 changelog_rec_offset(crf,
1384 /* The additional flags follow the rename and jobid extensions, if present */
1386 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1387 const struct changelog_rec *rec)
1389 enum changelog_rec_flags crf = rec->cr_flags &
1390 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1392 return (struct changelog_ext_extra_flags *)((char *)rec +
1393 changelog_rec_offset(crf,
1397 /* The uid/gid is the first extra extension */
1399 struct changelog_ext_uidgid *changelog_rec_uidgid(
1400 const struct changelog_rec *rec)
1402 enum changelog_rec_flags crf = rec->cr_flags &
1403 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1405 return (struct changelog_ext_uidgid *)((char *)rec +
1406 changelog_rec_offset(crf,
1410 /* The nid is the second extra extension */
1412 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1414 enum changelog_rec_flags crf = rec->cr_flags &
1415 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1416 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1418 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1419 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1422 return (struct changelog_ext_nid *)((char *)rec +
1423 changelog_rec_offset(crf, cref));
1426 /* The OPEN mode is the third extra extension */
1428 struct changelog_ext_openmode *changelog_rec_openmode(
1429 const struct changelog_rec *rec)
1431 enum changelog_rec_flags crf = rec->cr_flags &
1432 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1433 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1435 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1436 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1437 (CLFE_UIDGID | CLFE_NID);
1439 return (struct changelog_ext_openmode *)((char *)rec +
1440 changelog_rec_offset(crf, cref));
1443 /* The xattr name is the fourth extra extension */
1445 struct changelog_ext_xattr *changelog_rec_xattr(
1446 const struct changelog_rec *rec)
1448 enum changelog_rec_flags crf = rec->cr_flags &
1449 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1450 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1452 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1453 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1454 (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1456 return (struct changelog_ext_xattr *)((char *)rec +
1457 changelog_rec_offset(crf, cref));
1460 /* The name follows the rename, jobid and extra flags extns, if present */
1461 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1463 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1465 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1466 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1468 return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1469 cref & CLFE_SUPPORTED);
1472 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1474 return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1477 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1479 char *cr_name = changelog_rec_name(rec);
1481 return cr_name + strlen(cr_name) + 1;
1485 * Remap a record to the desired format as specified by the crf flags.
1486 * The record must be big enough to contain the final remapped version.
1487 * Superfluous extension fields are removed and missing ones are added
1488 * and zeroed. The flags of the record are updated accordingly.
1490 * The jobid and rename extensions can be added to a record, to match the
1491 * format an application expects, typically. In this case, the newly added
1492 * fields will be zeroed.
1493 * The Jobid field can be removed, to guarantee compatibility with older
1494 * clients that don't expect this field in the records they process.
1496 * The following assumptions are being made:
1497 * - CLF_RENAME will not be removed
1498 * - CLF_JOBID will not be added without CLF_RENAME being added too
1499 * - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1501 * @param[in,out] rec The record to remap.
1502 * @param[in] crf_wanted Flags describing the desired extensions.
1503 * @param[in] cref_want Flags describing the desired extra extensions.
1505 static inline void changelog_remap_rec(struct changelog_rec *rec,
1506 enum changelog_rec_flags crf_wanted,
1507 enum changelog_rec_extra_flags cref_want)
1509 char *xattr_mov = NULL;
1510 char *omd_mov = NULL;
1511 char *nid_mov = NULL;
1512 char *uidgid_mov = NULL;
1516 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1518 crf_wanted &= CLF_SUPPORTED;
1519 cref_want &= CLFE_SUPPORTED;
1521 if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1522 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1523 (rec->cr_flags & CLF_EXTRA_FLAGS &&
1524 (changelog_rec_extra_flags(rec)->cr_extra_flags &
1530 /* First move the variable-length name field */
1531 memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1532 changelog_rec_name(rec), rec->cr_namelen);
1534 /* Locations of extensions in the remapped record */
1535 if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1536 xattr_mov = (char *)rec +
1537 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1538 cref_want & ~CLFE_XATTR);
1539 omd_mov = (char *)rec +
1540 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1541 cref_want & ~(CLFE_OPEN |
1543 nid_mov = (char *)rec +
1544 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1545 cref_want & ~(CLFE_NID |
1548 uidgid_mov = (char *)rec +
1549 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1550 cref_want & ~(CLFE_UIDGID |
1554 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1557 ef_mov = (char *)rec +
1558 changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1560 jid_mov = (char *)rec +
1561 changelog_rec_offset(crf_wanted &
1562 ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1564 rnm_mov = (char *)rec +
1565 changelog_rec_offset(crf_wanted &
1571 /* Move the extension fields to the desired positions */
1572 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1573 (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1574 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1575 memmove(xattr_mov, changelog_rec_xattr(rec),
1576 sizeof(struct changelog_ext_xattr));
1578 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1579 memmove(omd_mov, changelog_rec_openmode(rec),
1580 sizeof(struct changelog_ext_openmode));
1582 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1583 memmove(nid_mov, changelog_rec_nid(rec),
1584 sizeof(struct changelog_ext_nid));
1586 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1587 memmove(uidgid_mov, changelog_rec_uidgid(rec),
1588 sizeof(struct changelog_ext_uidgid));
1590 memmove(ef_mov, changelog_rec_extra_flags(rec),
1591 sizeof(struct changelog_ext_extra_flags));
1594 if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1595 memmove(jid_mov, changelog_rec_jobid(rec),
1596 sizeof(struct changelog_ext_jobid));
1598 if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1599 memmove(rnm_mov, changelog_rec_rename(rec),
1600 sizeof(struct changelog_ext_rename));
1602 /* Clear newly added fields */
1603 if (xattr_mov && (cref_want & CLFE_XATTR) &&
1604 !(cref & CLFE_XATTR))
1605 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1607 if (omd_mov && (cref_want & CLFE_OPEN) &&
1608 !(cref & CLFE_OPEN))
1609 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1611 if (nid_mov && (cref_want & CLFE_NID) &&
1613 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1615 if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1616 !(cref & CLFE_UIDGID))
1617 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1619 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1620 !(rec->cr_flags & CLF_EXTRA_FLAGS))
1621 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1623 if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1624 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1626 if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1627 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1629 /* Update the record's flags accordingly */
1630 rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1631 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1632 changelog_rec_extra_flags(rec)->cr_extra_flags =
1633 changelog_rec_extra_flags(rec)->cr_extra_flags |
1637 enum changelog_message_type {
1638 CL_RECORD = 10, /* message is a changelog_rec */
1639 CL_EOF = 11, /* at end of current changelog */
1642 /********* Misc **********/
1644 struct ioc_data_version {
1646 __u32 idv_layout_version; /* FLR: layout version for OST objects */
1647 __u32 idv_flags; /* enum ioc_data_version_flags */
1650 enum ioc_data_version_flags {
1651 LL_DV_RD_FLUSH = (1 << 0), /* Flush dirty pages from clients */
1652 LL_DV_WR_FLUSH = (1 << 1), /* Flush all caching pages from clients */
1656 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
1659 #define dot_lustre_name ".lustre"
1662 /********* HSM **********/
1664 /** HSM per-file state
1665 * See HSM_FLAGS below.
1668 HS_NONE = 0x00000000,
1669 HS_EXISTS = 0x00000001,
1670 HS_DIRTY = 0x00000002,
1671 HS_RELEASED = 0x00000004,
1672 HS_ARCHIVED = 0x00000008,
1673 HS_NORELEASE = 0x00000010,
1674 HS_NOARCHIVE = 0x00000020,
1675 HS_LOST = 0x00000040,
1678 /* HSM user-setable flags. */
1679 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1681 /* Other HSM flags. */
1682 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1685 * All HSM-related possible flags that could be applied to a file.
1686 * This should be kept in sync with hsm_states.
1688 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
1691 * HSM request progress state
1693 enum hsm_progress_states {
1700 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1703 case HPS_WAITING: return "waiting";
1704 case HPS_RUNNING: return "running";
1705 case HPS_DONE: return "done";
1706 default: return "unknown";
1713 } __attribute__((packed));
1716 * Current HSM states of a Lustre file.
1718 * This structure purpose is to be sent to user-space mainly. It describes the
1719 * current HSM flags and in-progress action.
1721 struct hsm_user_state {
1722 /** Current HSM states, from enum hsm_states. */
1724 __u32 hus_archive_id;
1725 /** The current undergoing action, if there is one */
1726 __u32 hus_in_progress_state;
1727 __u32 hus_in_progress_action;
1728 struct hsm_extent hus_in_progress_location;
1729 char hus_extended_info[];
1732 struct hsm_state_set_ioc {
1733 struct lu_fid hssi_fid;
1735 __u64 hssi_clearmask;
1739 * This structure describes the current in-progress action for a file.
1740 * it is retuned to user space and send over the wire
1742 struct hsm_current_action {
1743 /** The current undergoing action, if there is one */
1744 /* state is one of hsm_progress_states */
1746 /* action is one of hsm_user_action */
1748 struct hsm_extent hca_location;
1751 /***** HSM user requests ******/
1752 /* User-generated (lfs/ioctl) request types */
1753 enum hsm_user_action {
1754 HUA_NONE = 1, /* no action (noop) */
1755 HUA_ARCHIVE = 10, /* copy to hsm */
1756 HUA_RESTORE = 11, /* prestage */
1757 HUA_RELEASE = 12, /* drop ost objects */
1758 HUA_REMOVE = 13, /* remove from archive */
1759 HUA_CANCEL = 14 /* cancel a request */
1762 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1765 case HUA_NONE: return "NOOP";
1766 case HUA_ARCHIVE: return "ARCHIVE";
1767 case HUA_RESTORE: return "RESTORE";
1768 case HUA_RELEASE: return "RELEASE";
1769 case HUA_REMOVE: return "REMOVE";
1770 case HUA_CANCEL: return "CANCEL";
1771 default: return "UNKNOWN";
1776 * List of hr_flags (bit field)
1778 #define HSM_FORCE_ACTION 0x0001
1779 /* used by CT, cannot be set by user */
1780 #define HSM_GHOST_COPY 0x0002
1783 * Contains all the fixed part of struct hsm_user_request.
1786 struct hsm_request {
1787 __u32 hr_action; /* enum hsm_user_action */
1788 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1789 __u64 hr_flags; /* request flags */
1790 __u32 hr_itemcount; /* item count in hur_user_item vector */
1794 struct hsm_user_item {
1795 struct lu_fid hui_fid;
1796 struct hsm_extent hui_extent;
1797 } __attribute__((packed));
1799 struct hsm_user_request {
1800 struct hsm_request hur_request;
1801 struct hsm_user_item hur_user_item[0];
1802 /* extra data blob at end of struct (after all
1803 * hur_user_items), only use helpers to access it
1805 } __attribute__((packed));
1807 /** Return pointer to data field in a hsm user request */
1808 static inline void *hur_data(struct hsm_user_request *hur)
1810 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1814 * Compute the current length of the provided hsm_user_request. This returns -1
1815 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1817 * return -1 on bounds check error.
1819 static inline ssize_t hur_len(struct hsm_user_request *hur)
1823 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1824 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1825 (__u64)hur->hur_request.hr_itemcount *
1826 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1828 if (size != (ssize_t)size)
1834 /****** HSM RPCs to copytool *****/
1835 /* Message types the copytool may receive */
1836 enum hsm_message_type {
1837 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1840 /* Actions the copytool may be instructed to take for a given action_item */
1841 enum hsm_copytool_action {
1842 HSMA_NONE = 10, /* no action */
1843 HSMA_ARCHIVE = 20, /* arbitrary offset */
1849 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1852 case HSMA_NONE: return "NOOP";
1853 case HSMA_ARCHIVE: return "ARCHIVE";
1854 case HSMA_RESTORE: return "RESTORE";
1855 case HSMA_REMOVE: return "REMOVE";
1856 case HSMA_CANCEL: return "CANCEL";
1857 default: return "UNKNOWN";
1861 /* Copytool item action description */
1862 struct hsm_action_item {
1863 __u32 hai_len; /* valid size of this struct */
1864 __u32 hai_action; /* hsm_copytool_action, but use known size */
1865 struct lu_fid hai_fid; /* Lustre FID to operate on */
1866 struct lu_fid hai_dfid; /* fid used for data access */
1867 struct hsm_extent hai_extent; /* byte range to operate on */
1868 __u64 hai_cookie; /* action cookie from coordinator */
1869 __u64 hai_gid; /* grouplock id */
1870 char hai_data[0]; /* variable length */
1871 } __attribute__((packed));
1874 * helper function which print in hexa the first bytes of
1877 * \param hai [IN] record to print
1878 * \param buffer [IN,OUT] buffer to write the hex string to
1879 * \param len [IN] max buffer length
1883 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1884 char *buffer, size_t len)
1891 data_len = hai->hai_len - sizeof(*hai);
1892 for (i = 0; (i < data_len) && (len > 2); i++) {
1893 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1903 /* Copytool action list */
1904 #define HAL_VERSION 1
1905 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1906 struct hsm_action_list {
1908 __u32 hal_count; /* number of hai's to follow */
1909 __u64 hal_compound_id; /* returned by coordinator, ignored */
1911 __u32 hal_archive_id; /* which archive backend */
1913 char hal_fsname[0]; /* null-terminated */
1914 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1915 boundaries. See hai_zero */
1916 } __attribute__((packed));
1918 /* Return pointer to first hai in action list */
1919 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1921 size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1923 return (struct hsm_action_item *)(hal->hal_fsname + offset);
1926 /* Return pointer to next hai */
1927 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1929 size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
1931 return (struct hsm_action_item *)((char *)hai + offset);
1934 /* Return size of an hsm_action_list */
1935 static inline size_t hal_size(struct hsm_action_list *hal)
1939 struct hsm_action_item *hai;
1941 sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1942 hai = hai_first(hal);
1943 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1944 sz += __ALIGN_KERNEL(hai->hai_len, 8);
1950 * describe the attributes to be set on imported file
1952 struct hsm_user_import {
1961 __u32 hui_archive_id;
1964 /* Copytool progress reporting */
1965 #define HP_FLAG_COMPLETED 0x01
1966 #define HP_FLAG_RETRY 0x02
1968 struct hsm_progress {
1969 struct lu_fid hp_fid;
1971 struct hsm_extent hp_extent;
1973 __u16 hp_errval; /* positive val */
1978 __u64 hc_data_version;
1980 __u16 hc_errval; /* positive val */
1982 struct hsm_action_item hc_hai;
1986 enum llapi_json_types {
1987 LLAPI_JSON_INTEGER = 1,
1993 struct llapi_json_item {
2002 struct llapi_json_item *lji_next;
2005 struct llapi_json_item_list {
2006 int ljil_item_count;
2007 struct llapi_json_item *ljil_items;
2010 enum lu_ladvise_type {
2011 LU_LADVISE_INVALID = 0,
2012 LU_LADVISE_WILLREAD = 1,
2013 LU_LADVISE_DONTNEED = 2,
2014 LU_LADVISE_LOCKNOEXPAND = 3,
2015 LU_LADVISE_LOCKAHEAD = 4,
2019 #define LU_LADVISE_NAMES { \
2020 [LU_LADVISE_WILLREAD] = "willread", \
2021 [LU_LADVISE_DONTNEED] = "dontneed", \
2022 [LU_LADVISE_LOCKNOEXPAND] = "locknoexpand", \
2023 [LU_LADVISE_LOCKAHEAD] = "lockahead", \
2026 /* This is the userspace argument for ladvise. It is currently the same as
2027 * what goes on the wire (struct lu_ladvise), but is defined separately as we
2028 * may need info which is only used locally. */
2029 struct llapi_lu_ladvise {
2030 __u16 lla_advice; /* advice type */
2031 __u16 lla_value1; /* values for different advice types */
2033 __u64 lla_start; /* first byte of extent for advice */
2034 __u64 lla_end; /* last byte of extent for advice */
2040 LF_ASYNC = 0x00000001,
2041 LF_UNSET = 0x00000002,
2044 #define LADVISE_MAGIC 0x1ADF1CE0
2045 /* Masks of valid flags for each advice */
2046 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2047 /* Flags valid for all advices not explicitly specified */
2048 #define LF_DEFAULT_MASK LF_ASYNC
2050 #define LF_MASK (LF_ASYNC | LF_UNSET)
2052 #define lla_lockahead_mode lla_value1
2053 #define lla_peradvice_flags lla_value2
2054 #define lla_lockahead_result lla_value3
2056 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2057 * is used on the wire. It is defined separately as we may need info which is
2058 * only used locally. */
2059 struct llapi_ladvise_hdr {
2060 __u32 lah_magic; /* LADVISE_MAGIC */
2061 __u32 lah_count; /* number of advices */
2062 __u64 lah_flags; /* from enum ladvise_flag */
2063 __u32 lah_value1; /* unused */
2064 __u32 lah_value2; /* unused */
2065 __u64 lah_value3; /* unused */
2066 struct llapi_lu_ladvise lah_advise[0]; /* advices in this header */
2069 #define LAH_COUNT_MAX (1024)
2073 SK_CRYPT_INVALID = -1,
2075 SK_CRYPT_AES256_CTR = 1,
2080 SK_HMAC_INVALID = -1,
2087 struct sk_crypt_type {
2092 struct sk_hmac_type {
2097 enum lock_mode_user {
2103 #define LOCK_MODE_NAMES { \
2104 [MODE_READ_USER] = "READ",\
2105 [MODE_WRITE_USER] = "WRITE"\
2108 enum lockahead_results {
2109 LLA_RESULT_SENT = 0,
2110 LLA_RESULT_DIFFERENT,
2114 #if defined(__cplusplus)
2118 /** @} lustreuser */
2120 #endif /* _LUSTRE_USER_H */