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 {
365 * The ioctl naming rules:
366 * LL_* - works on the currently opened filehandle instead of parent dir
367 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
368 * *_MDC_* - gets/sets data related to MDC
369 * *_LOV_* - gets/sets data related to OSC/LOV
370 * *FILE* - called on parent dir and passes in a filename
371 * *STRIPE* - set/get lov_user_md
372 * *INFO - set/get lov_user_mds_data
374 /* lustre_ioctl.h 101-150 */
375 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
376 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
377 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
378 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
379 #define LL_IOC_LOV_SETSTRIPE_NEW _IOWR('f', 154, struct lov_user_md)
380 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
381 #define LL_IOC_LOV_GETSTRIPE_NEW _IOR('f', 155, struct lov_user_md)
382 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
383 /* LL_IOC_RECREATE_OBJ 157 obsolete */
384 /* LL_IOC_RECREATE_FID 157 obsolete */
385 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
386 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
387 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
388 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
389 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
390 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
391 /* IOC_LOV_GETINFO 165 obsolete */
392 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
393 /* LL_IOC_RMTACL 167 obsolete */
394 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
395 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
396 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
397 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
398 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
399 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
400 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
401 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
402 #define LL_IOC_FUTIMES_3 _IOWR('f', 176, struct ll_futimes_3)
403 #define LL_IOC_FLR_SET_MIRROR _IOW ('f', 177, long)
404 /* lustre_ioctl.h 177-210 */
405 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
406 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
407 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
408 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
409 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
410 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
411 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
412 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
413 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
414 struct lustre_swap_layouts)
415 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
416 struct hsm_current_action)
417 /* lustre_ioctl.h 221-232 */
418 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
419 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
420 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
421 #define LL_IOC_SET_LEASE _IOWR('f', 243, struct ll_ioc_lease)
422 #define LL_IOC_SET_LEASE_OLD _IOWR('f', 243, long)
423 #define LL_IOC_GET_LEASE _IO('f', 244)
424 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
425 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
426 #define LL_IOC_MIGRATE _IOR('f', 247, int)
427 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
428 #define LL_IOC_GETPARENT _IOWR('f', 249, struct getparent)
429 #define LL_IOC_LADVISE _IOR('f', 250, struct llapi_lu_ladvise)
431 #ifndef FS_IOC_FSGETXATTR
433 * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
436 __u32 fsx_xflags; /* xflags field value (get/set) */
437 __u32 fsx_extsize; /* extsize field value (get/set)*/
438 __u32 fsx_nextents; /* nextents field value (get) */
439 __u32 fsx_projid; /* project identifier (get/set) */
440 unsigned char fsx_pad[12];
442 #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
443 #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
445 #define LL_IOC_FSGETXATTR FS_IOC_FSGETXATTR
446 #define LL_IOC_FSSETXATTR FS_IOC_FSSETXATTR
447 #ifndef FS_XFLAG_PROJINHERIT
448 #define FS_XFLAG_PROJINHERIT 0x00000200
452 #define LL_STATFS_LMV 1
453 #define LL_STATFS_LOV 2
454 #define LL_STATFS_NODELAY 4
456 #define IOC_MDC_TYPE 'i'
457 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
458 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
459 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
460 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
462 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
464 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
465 * files, but are unlikely to be used in practice and are not harmful if
466 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
467 * devices and are safe for use on new files. See LU-4209. */
468 /* To be compatible with old statically linked binary we keep the check for
469 * the older 0100000000 flag. This is already removed upstream. LU-812. */
470 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
471 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
472 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
473 O_LOV_DELAY_CREATE_MASK)
475 #define LL_FILE_IGNORE_LOCK 0x00000001
476 #define LL_FILE_GROUP_LOCKED 0x00000002
477 #define LL_FILE_READAHEA 0x00000004
478 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
479 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
481 #define LOV_USER_MAGIC_V1 0x0BD10BD0
482 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
483 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
484 #define LOV_USER_MAGIC_V3 0x0BD30BD0
485 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
486 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0 /* for specific OSTs */
487 #define LOV_USER_MAGIC_COMP_V1 0x0BD60BD0
489 #define LMV_USER_MAGIC 0x0CD30CD0 /* default lmv magic */
490 #define LMV_USER_MAGIC_V0 0x0CD20CD0 /* old default lmv magic*/
491 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
493 #define LOV_PATTERN_NONE 0x000
494 #define LOV_PATTERN_RAID0 0x001
495 #define LOV_PATTERN_RAID1 0x002
496 #define LOV_PATTERN_MDT 0x100
497 #define LOV_PATTERN_CMOBD 0x200
499 #define LOV_PATTERN_F_MASK 0xffff0000
500 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
501 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
502 #define LOV_PATTERN_DEFAULT 0xffffffff
504 static inline bool lov_pattern_supported(__u32 pattern)
506 return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
507 (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
510 #define LOV_MAXPOOLNAME 15
511 #define LOV_POOLNAMEF "%.15s"
513 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
514 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
515 #define LOV_MAX_STRIPE_COUNT_OLD 160
516 /* This calculation is crafted so that input of 4096 will result in 160
517 * which in turn is equal to old maximal stripe count.
518 * XXX: In fact this is too simpified for now, what it also need is to get
519 * ea_type argument to clearly know how much space each stripe consumes.
521 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
522 * allocation that is sufficient for the current generation of systems.
524 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
525 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
526 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
527 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
529 #define XATTR_LUSTRE_PREFIX "lustre."
530 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
532 #define lov_user_ost_data lov_user_ost_data_v1
533 struct lov_user_ost_data_v1 { /* per-stripe data structure */
534 struct ost_id l_ost_oi; /* OST object ID */
535 __u32 l_ost_gen; /* generation of this OST index */
536 __u32 l_ost_idx; /* OST index in LOV */
537 } __attribute__((packed));
539 #define lov_user_md lov_user_md_v1
540 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
541 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
542 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
543 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
544 __u32 lmm_stripe_size; /* size of stripe in bytes */
545 __u16 lmm_stripe_count; /* num stripes in use for this object */
547 __u16 lmm_stripe_offset; /* starting stripe offset in
548 * lmm_objects, use when writing */
549 __u16 lmm_layout_gen; /* layout generation number
550 * used when reading */
552 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
553 } __attribute__((packed, __may_alias__));
555 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
556 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
557 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
558 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
559 __u32 lmm_stripe_size; /* size of stripe in bytes */
560 __u16 lmm_stripe_count; /* num stripes in use for this object */
562 __u16 lmm_stripe_offset; /* starting stripe offset in
563 * lmm_objects, use when writing */
564 __u16 lmm_layout_gen; /* layout generation number
565 * used when reading */
567 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
568 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
569 } __attribute__((packed));
576 #define DEXT "[%#llx, %#llx)"
577 #define PEXT(ext) (ext)->e_start, (ext)->e_end
579 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
580 struct lu_extent *e2)
582 return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
585 static inline bool lu_extent_is_whole(struct lu_extent *e)
587 return e->e_start == 0 && e->e_end == LUSTRE_EOF;
590 enum lov_comp_md_entry_flags {
591 LCME_FL_STALE = 0x00000001, /* FLR: stale data */
592 LCME_FL_PREF_RD = 0x00000002, /* FLR: preferred for reading */
593 LCME_FL_PREF_WR = 0x00000004, /* FLR: preferred for writing */
594 LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
595 LCME_FL_OFFLINE = 0x00000008, /* Not used */
596 LCME_FL_INIT = 0x00000010, /* instantiated */
597 LCME_FL_NEG = 0x80000000 /* used to indicate a negative flag,
598 won't be stored on disk */
601 #define LCME_KNOWN_FLAGS (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
603 /* The flags can be set by users at mirror creation time. */
604 #define LCME_USER_FLAGS (LCME_FL_PREF_RW)
606 /* the highest bit in obdo::o_layout_version is used to mark if the file is
608 #define LU_LAYOUT_RESYNC LCME_FL_NEG
610 /* lcme_id can be specified as certain flags, and the the first
611 * bit of lcme_id is used to indicate that the ID is representing
612 * certain LCME_FL_* but not a real ID. Which implies we can have
613 * at most 31 flags (see LCME_FL_XXX). */
616 LCME_ID_MAX = 0x7FFFFFFF,
617 LCME_ID_ALL = 0xFFFFFFFF,
618 LCME_ID_NOT_ID = LCME_FL_NEG
621 #define LCME_ID_MASK LCME_ID_MAX
623 struct lov_comp_md_entry_v1 {
624 __u32 lcme_id; /* unique id of component */
625 __u32 lcme_flags; /* LCME_FL_XXX */
626 struct lu_extent lcme_extent; /* file extent for component */
627 __u32 lcme_offset; /* offset of component blob,
628 start from lov_comp_md_v1 */
629 __u32 lcme_size; /* size of component blob */
630 __u32 lcme_layout_gen;
631 __u32 lcme_padding_1;
632 __u64 lcme_padding_2;
633 } __attribute__((packed));
635 #define SEQ_ID_MAX 0x0000FFFF
636 #define SEQ_ID_MASK SEQ_ID_MAX
637 /* bit 30:16 of lcme_id is used to store mirror id */
638 #define MIRROR_ID_MASK 0x7FFF0000
639 #define MIRROR_ID_SHIFT 16
641 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
643 return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
646 static inline __u16 mirror_id_of(__u32 id)
648 return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
652 * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
654 enum lov_comp_md_flags {
655 /* the least 2 bits are used by FLR to record file state */
658 LCM_FL_WRITE_PENDING = 2,
659 LCM_FL_SYNC_PENDING = 3,
660 LCM_FL_FLR_MASK = 0x3,
663 struct lov_comp_md_v1 {
664 __u32 lcm_magic; /* LOV_USER_MAGIC_COMP_V1 */
665 __u32 lcm_size; /* overall size including this struct */
666 __u32 lcm_layout_gen;
668 __u16 lcm_entry_count;
669 /* lcm_mirror_count stores the number of actual mirrors minus 1,
670 * so that non-flr files will have value 0 meaning 1 mirror. */
671 __u16 lcm_mirror_count;
672 __u16 lcm_padding1[3];
674 struct lov_comp_md_entry_v1 lcm_entries[0];
675 } __attribute__((packed));
677 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
679 if (stripes == (__u16)-1)
682 if (lmm_magic == LOV_USER_MAGIC_V1)
683 return sizeof(struct lov_user_md_v1) +
684 stripes * sizeof(struct lov_user_ost_data_v1);
685 return sizeof(struct lov_user_md_v3) +
686 stripes * sizeof(struct lov_user_ost_data_v1);
689 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
690 * use this. It is unsafe to #define those values in this header as it
691 * is possible the application has already #included <sys/stat.h>. */
692 #ifdef HAVE_LOV_USER_MDS_DATA
693 #define lov_user_mds_data lov_user_mds_data_v1
694 struct lov_user_mds_data_v1 {
695 lstat_t lmd_st; /* MDS stat struct */
696 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
697 } __attribute__((packed));
700 struct lmv_user_mds_data {
701 struct lu_fid lum_fid;
707 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
708 LMV_HASH_TYPE_ALL_CHARS = 1,
709 LMV_HASH_TYPE_FNV_1A_64 = 2,
713 #define LMV_HASH_NAME_ALL_CHARS "all_char"
714 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
716 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
718 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
719 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
720 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
721 #define lmv_user_md lmv_user_md_v1
722 struct lmv_user_md_v1 {
723 __u32 lum_magic; /* must be the first field */
724 __u32 lum_stripe_count; /* dirstripe count */
725 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
726 __u32 lum_hash_type; /* Dir stripe policy */
727 __u32 lum_type; /* LMV type: default or normal */
731 char lum_pool_name[LOV_MAXPOOLNAME + 1];
732 struct lmv_user_mds_data lum_objects[0];
733 } __attribute__((packed));
735 static inline int lmv_user_md_size(int stripes, int lmm_magic)
737 int size = sizeof(struct lmv_user_md);
739 if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
740 size += stripes * sizeof(struct lmv_user_mds_data);
745 struct ll_recreate_obj {
751 __u64 id; /* holds object id */
752 __u32 generation; /* holds object generation */
753 __u32 f_type; /* holds object type or stripe idx when passing it to
754 * OST for saving into EA. */
762 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
763 const struct obd_uuid *u2)
765 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
768 static inline int obd_uuid_empty(struct obd_uuid *uuid)
770 return uuid->uuid[0] == '\0';
773 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
775 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
776 uuid->uuid[sizeof(*uuid) - 1] = '\0';
779 /* For printf's only, make sure uuid is terminated */
780 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
785 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
786 /* Obviously not safe, but for printfs, no real harm done...
787 we're always null-terminated, even in a race. */
788 static char temp[sizeof(*uuid)];
789 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
790 temp[sizeof(*uuid) - 1] = '\0';
793 return (char *)(uuid->uuid);
796 #define LUSTRE_MAXFSNAME 8
798 /* Extract fsname from uuid (or target name) of a target
799 e.g. (myfs-OST0007_UUID -> myfs)
800 see also deuuidify. */
801 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
805 strncpy(buf, uuid, buflen - 1);
806 buf[buflen - 1] = '\0';
807 p = strrchr(buf, '-');
812 /* printf display format for Lustre FIDs
813 * usage: printf("file FID is "DFID"\n", PFID(fid)); */
814 #define FID_NOBRACE_LEN 40
815 #define FID_LEN (FID_NOBRACE_LEN + 2)
816 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
817 #define DFID "["DFID_NOBRACE"]"
818 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
820 /* scanf input parse format for fids in DFID_NOBRACE format
821 * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
822 * usage: sscanf(fidstr, SFID, RFID(&fid)); */
823 #define SFID "0x%llx:0x%x:0x%x"
824 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
826 /********* Quotas **********/
828 #define LUSTRE_QUOTABLOCK_BITS 10
829 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
831 static inline __u64 lustre_stoqb(size_t space)
833 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
836 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
837 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
838 #define Q_GETOINFO 0x800102 /* get obd quota info */
839 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
840 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
842 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
843 #define LUSTRE_Q_QUOTAON 0x800002 /* deprecated as of 2.4 */
844 #define LUSTRE_Q_QUOTAOFF 0x800003 /* deprecated as of 2.4 */
845 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
846 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
847 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
848 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
849 /* lustre-specific control commands */
850 #define LUSTRE_Q_INVALIDATE 0x80000b /* deprecated as of 2.4 */
851 #define LUSTRE_Q_FINVALIDATE 0x80000c /* deprecated as of 2.4 */
852 #define LUSTRE_Q_GETDEFAULT 0x80000d /* get default quota */
853 #define LUSTRE_Q_SETDEFAULT 0x80000e /* set default quota */
855 /* In the current Lustre implementation, the grace time is either the time
856 * or the timestamp to be used after some quota ID exceeds the soft limt,
857 * 48 bits should be enough, its high 16 bits can be used as quota flags.
859 #define LQUOTA_GRACE_BITS 48
860 #define LQUOTA_GRACE_MASK ((1ULL << LQUOTA_GRACE_BITS) - 1)
861 #define LQUOTA_GRACE_MAX LQUOTA_GRACE_MASK
862 #define LQUOTA_GRACE(t) (t & LQUOTA_GRACE_MASK)
863 #define LQUOTA_FLAG(t) (t >> LQUOTA_GRACE_BITS)
864 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
866 /* different quota flags */
868 /* the default quota flag, the corresponding quota ID will use the default
869 * quota setting, the hardlimit and softlimit of its quota record in the global
870 * quota file will be set to 0, the low 48 bits of the grace will be set to 0
871 * and high 16 bits will contain this flag (see above comment).
873 #define LQUOTA_FLAG_DEFAULT 0x0001
875 #define ALLQUOTA 255 /* set all quota */
876 static inline char *qtype_name(int qtype)
889 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
892 #define N_PERMS_MAX 64
894 struct perm_downcall_data {
900 struct identity_downcall_data {
907 struct perm_downcall_data idd_perms[N_PERMS_MAX];
911 #ifdef NEED_QUOTA_DEFS
913 #define QIF_BLIMITS 1
915 #define QIF_ILIMITS 4
919 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
920 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
921 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
922 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
925 #endif /* !__KERNEL__ */
927 /* lustre volatile file support
928 * file name header: ".^L^S^T^R:volatile"
930 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
931 #define LUSTRE_VOLATILE_HDR_LEN 14
933 enum lustre_quota_version {
937 /* XXX: same as if_dqinfo struct in kernel */
945 /* XXX: same as if_dqblk struct in kernel, plus one padding */
947 __u64 dqb_bhardlimit;
948 __u64 dqb_bsoftlimit;
950 __u64 dqb_ihardlimit;
951 __u64 dqb_isoftlimit;
973 struct obd_dqinfo qc_dqinfo;
974 struct obd_dqblk qc_dqblk;
976 struct obd_uuid obd_uuid;
979 /* swap layout flags */
980 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
981 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
982 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
983 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
984 #define SWAP_LAYOUTS_CLOSE (1 << 4)
986 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
987 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
988 struct lustre_swap_layouts {
996 /** Bit-mask of valid attributes */
997 /* The LA_* flags are written to disk as part of the ChangeLog records
998 * so they are part of the on-disk and network protocol, and cannot be changed.
999 * Only the first 12 bits are currently saved.
1014 LA_BLKSIZE = 1 << 12,
1015 LA_KILL_SUID = 1 << 13,
1016 LA_KILL_SGID = 1 << 14,
1017 LA_PROJID = 1 << 15,
1018 LA_LAYOUT_VERSION = 1 << 16,
1020 LA_LBLOCKS = 1 << 18,
1022 * Attributes must be transmitted to OST objects
1024 LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1027 #define MDS_FMODE_READ 00000001
1028 #define MDS_FMODE_WRITE 00000002
1030 #define MDS_FMODE_CLOSED 00000000
1031 #define MDS_FMODE_EXEC 00000004
1032 /* MDS_FMODE_EPOCH 01000000 obsolete since 2.8.0 */
1033 /* MDS_FMODE_TRUNC 02000000 obsolete since 2.8.0 */
1034 /* MDS_FMODE_SOM 04000000 obsolete since 2.8.0 */
1036 #define MDS_OPEN_CREATED 00000010
1037 #define MDS_OPEN_CROSS 00000020
1039 #define MDS_OPEN_CREAT 00000100
1040 #define MDS_OPEN_EXCL 00000200
1041 #define MDS_OPEN_TRUNC 00001000
1042 #define MDS_OPEN_APPEND 00002000
1043 #define MDS_OPEN_SYNC 00010000
1044 #define MDS_OPEN_DIRECTORY 00200000
1046 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
1047 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1048 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1049 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1050 * We do not support JOIN FILE
1051 * anymore, reserve this flags
1052 * just for preventing such bit
1055 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1056 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1057 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1058 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1059 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1061 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
1063 #define MDS_OPEN_LEASE 01000000000000ULL /* Open the file and grant lease
1064 * delegation, succeed if it's not
1065 * being opened with conflict mode.
1067 #define MDS_OPEN_RELEASE 02000000000000ULL /* Open the file for HSM release */
1069 #define MDS_OPEN_RESYNC 04000000000000ULL /* FLR: file resync */
1071 /* lustre internal open flags, which should not be set from user space */
1072 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS | \
1073 MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK | \
1074 MDS_OPEN_BY_FID | MDS_OPEN_LEASE | \
1075 MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1078 /********* Changelogs **********/
1079 /** Changelog record types */
1080 enum changelog_rec_type {
1082 CL_CREATE = 1, /* namespace */
1083 CL_MKDIR = 2, /* namespace */
1084 CL_HARDLINK = 3, /* namespace */
1085 CL_SOFTLINK = 4, /* namespace */
1086 CL_MKNOD = 5, /* namespace */
1087 CL_UNLINK = 6, /* namespace */
1088 CL_RMDIR = 7, /* namespace */
1089 CL_RENAME = 8, /* namespace */
1090 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
1091 CL_OPEN = 10, /* not currently used */
1092 CL_CLOSE = 11, /* may be written to log only with mtime change */
1093 CL_LAYOUT = 12, /* file layout/striping modified */
1097 CL_XATTR = CL_SETXATTR, /* Deprecated name */
1098 CL_HSM = 16, /* HSM specific events, see flags */
1099 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
1103 CL_FLRW = 21, /* FLR: file was firstly written */
1104 CL_RESYNC = 22, /* FLR: file was resync-ed */
1106 CL_DN_OPEN = 24, /* denied open */
1110 static inline const char *changelog_type2str(int type) {
1111 static const char *changelog_str[] = {
1112 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1113 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
1114 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "MIGRT",
1115 "FLRW", "RESYNC","GXATR", "NOPEN",
1118 if (type >= 0 && type < CL_LAST)
1119 return changelog_str[type];
1123 /* per-record flags */
1124 #define CLF_FLAGSHIFT 12
1125 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
1126 #define CLF_VERMASK (~CLF_FLAGMASK)
1127 enum changelog_rec_flags {
1128 CLF_VERSION = 0x1000,
1129 CLF_RENAME = 0x2000,
1131 CLF_EXTRA_FLAGS = 0x8000,
1132 CLF_SUPPORTED = CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS
1136 /* Anything under the flagmask may be per-type (if desired) */
1137 /* Flags for unlink */
1138 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
1139 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1140 /* HSM cleaning needed */
1141 /* Flags for rename */
1142 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
1144 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
1145 * has an archive in backend */
1148 /* 12b used (from high weight to low weight):
1153 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
1154 #define CLF_HSM_ERR_H 6
1155 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
1156 #define CLF_HSM_EVENT_H 9
1157 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
1158 #define CLF_HSM_FLAG_H 11
1159 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
1160 #define CLF_HSM_SPARE_H 15
1161 #define CLF_HSM_LAST 15
1163 /* Remove bits higher than _h, then extract the value
1164 * between _h and _l by shifting lower weigth to bit 0. */
1165 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1166 >> (CLF_HSM_LAST - _h + _l))
1168 #define CLF_HSM_SUCCESS 0x00
1169 #define CLF_HSM_MAXERROR 0x7E
1170 #define CLF_HSM_ERROVERFLOW 0x7F
1172 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
1174 /* 3 bits field => 8 values allowed */
1186 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1188 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1192 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
1194 *flags |= (he << CLF_HSM_EVENT_L);
1197 static inline __u16 hsm_get_cl_flags(int flags)
1199 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1202 static inline void hsm_set_cl_flags(int *flags, int bits)
1204 *flags |= (bits << CLF_HSM_FLAG_L);
1207 static inline int hsm_get_cl_error(int flags)
1209 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1212 static inline void hsm_set_cl_error(int *flags, int error)
1214 *flags |= (error << CLF_HSM_ERR_L);
1217 enum changelog_rec_extra_flags {
1219 CLFE_UIDGID = 0x0001,
1222 CLFE_XATTR = 0x0008,
1223 CLFE_SUPPORTED = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1226 enum changelog_send_flag {
1227 /* Not yet implemented */
1228 CHANGELOG_FLAG_FOLLOW = 0x01,
1229 /* Blocking IO makes sense in case of slow user parsing of the records,
1230 * but it also prevents us from cleaning up if the records are not
1232 CHANGELOG_FLAG_BLOCK = 0x02,
1233 /* Pack jobid into the changelog records if available. */
1234 CHANGELOG_FLAG_JOBID = 0x04,
1235 /* Pack additional flag bits into the changelog record */
1236 CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1239 enum changelog_send_extra_flag {
1240 /* Pack uid/gid into the changelog record */
1241 CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1242 /* Pack nid into the changelog record */
1243 CHANGELOG_EXTRA_FLAG_NID = 0x02,
1244 /* Pack open mode into the changelog record */
1245 CHANGELOG_EXTRA_FLAG_OMODE = 0x04,
1246 /* Pack xattr name into the changelog record */
1247 CHANGELOG_EXTRA_FLAG_XATTR = 0x08,
1250 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1251 changelog_rec_offset(CLF_SUPPORTED, \
1254 /* 31 usable bytes string + null terminator. */
1255 #define LUSTRE_JOBID_SIZE 32
1257 /* This is the minimal changelog record. It can contain extensions
1258 * such as rename fields or process jobid. Its exact content is described
1259 * by the cr_flags and cr_extra_flags.
1261 * Extensions are packed in the same order as their corresponding flags,
1262 * then in the same order as their corresponding extra flags.
1264 struct changelog_rec {
1266 __u16 cr_flags; /**< \a changelog_rec_flags */
1267 __u32 cr_type; /**< \a changelog_rec_type */
1268 __u64 cr_index; /**< changelog record number */
1269 __u64 cr_prev; /**< last index for this target fid */
1272 struct lu_fid cr_tfid; /**< target fid */
1273 __u32 cr_markerflags; /**< CL_MARK flags */
1275 struct lu_fid cr_pfid; /**< parent fid */
1278 /* Changelog extension for RENAME. */
1279 struct changelog_ext_rename {
1280 struct lu_fid cr_sfid; /**< source fid, or zero */
1281 struct lu_fid cr_spfid; /**< source parent fid, or zero */
1284 /* Changelog extension to include JOBID. */
1285 struct changelog_ext_jobid {
1286 char cr_jobid[LUSTRE_JOBID_SIZE]; /**< zero-terminated string. */
1289 /* Changelog extension to include additional flags. */
1290 struct changelog_ext_extra_flags {
1291 __u64 cr_extra_flags; /* Additional CLFE_* flags */
1294 /* Changelog extra extension to include UID/GID. */
1295 struct changelog_ext_uidgid {
1300 /* Changelog extra extension to include NID. */
1301 struct changelog_ext_nid {
1302 /* have __u64 instead of lnet_nid_t type for use by client api */
1304 /* for use when IPv6 support is added */
1309 /* Changelog extra extension to include OPEN mode. */
1310 struct changelog_ext_openmode {
1314 /* Changelog extra extension to include xattr */
1315 struct changelog_ext_xattr {
1316 char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1319 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1320 const struct changelog_rec *rec);
1322 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1323 enum changelog_rec_extra_flags cref)
1325 size_t size = sizeof(struct changelog_rec);
1327 if (crf & CLF_RENAME)
1328 size += sizeof(struct changelog_ext_rename);
1330 if (crf & CLF_JOBID)
1331 size += sizeof(struct changelog_ext_jobid);
1333 if (crf & CLF_EXTRA_FLAGS) {
1334 size += sizeof(struct changelog_ext_extra_flags);
1335 if (cref & CLFE_UIDGID)
1336 size += sizeof(struct changelog_ext_uidgid);
1337 if (cref & CLFE_NID)
1338 size += sizeof(struct changelog_ext_nid);
1339 if (cref & CLFE_OPEN)
1340 size += sizeof(struct changelog_ext_openmode);
1341 if (cref & CLFE_XATTR)
1342 size += sizeof(struct changelog_ext_xattr);
1348 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1350 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1352 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1353 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1355 return changelog_rec_offset(rec->cr_flags, cref);
1358 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1360 return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1364 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1366 enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1368 return (struct changelog_ext_rename *)((char *)rec +
1369 changelog_rec_offset(crf,
1373 /* The jobid follows the rename extension, if present */
1375 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1377 enum changelog_rec_flags crf = rec->cr_flags &
1378 (CLF_VERSION | CLF_RENAME);
1380 return (struct changelog_ext_jobid *)((char *)rec +
1381 changelog_rec_offset(crf,
1385 /* The additional flags follow the rename and jobid extensions, if present */
1387 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1388 const struct changelog_rec *rec)
1390 enum changelog_rec_flags crf = rec->cr_flags &
1391 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1393 return (struct changelog_ext_extra_flags *)((char *)rec +
1394 changelog_rec_offset(crf,
1398 /* The uid/gid is the first extra extension */
1400 struct changelog_ext_uidgid *changelog_rec_uidgid(
1401 const struct changelog_rec *rec)
1403 enum changelog_rec_flags crf = rec->cr_flags &
1404 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1406 return (struct changelog_ext_uidgid *)((char *)rec +
1407 changelog_rec_offset(crf,
1411 /* The nid is the second extra extension */
1413 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1415 enum changelog_rec_flags crf = rec->cr_flags &
1416 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1417 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1419 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1420 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1423 return (struct changelog_ext_nid *)((char *)rec +
1424 changelog_rec_offset(crf, cref));
1427 /* The OPEN mode is the third extra extension */
1429 struct changelog_ext_openmode *changelog_rec_openmode(
1430 const struct changelog_rec *rec)
1432 enum changelog_rec_flags crf = rec->cr_flags &
1433 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1434 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1436 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1437 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1438 (CLFE_UIDGID | CLFE_NID);
1440 return (struct changelog_ext_openmode *)((char *)rec +
1441 changelog_rec_offset(crf, cref));
1444 /* The xattr name is the fourth extra extension */
1446 struct changelog_ext_xattr *changelog_rec_xattr(
1447 const struct changelog_rec *rec)
1449 enum changelog_rec_flags crf = rec->cr_flags &
1450 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1451 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1453 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1454 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1455 (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1457 return (struct changelog_ext_xattr *)((char *)rec +
1458 changelog_rec_offset(crf, cref));
1461 /* The name follows the rename, jobid and extra flags extns, if present */
1462 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1464 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1466 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1467 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1469 return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1470 cref & CLFE_SUPPORTED);
1473 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1475 return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1478 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1480 char *cr_name = changelog_rec_name(rec);
1482 return cr_name + strlen(cr_name) + 1;
1486 * Remap a record to the desired format as specified by the crf flags.
1487 * The record must be big enough to contain the final remapped version.
1488 * Superfluous extension fields are removed and missing ones are added
1489 * and zeroed. The flags of the record are updated accordingly.
1491 * The jobid and rename extensions can be added to a record, to match the
1492 * format an application expects, typically. In this case, the newly added
1493 * fields will be zeroed.
1494 * The Jobid field can be removed, to guarantee compatibility with older
1495 * clients that don't expect this field in the records they process.
1497 * The following assumptions are being made:
1498 * - CLF_RENAME will not be removed
1499 * - CLF_JOBID will not be added without CLF_RENAME being added too
1500 * - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1502 * @param[in,out] rec The record to remap.
1503 * @param[in] crf_wanted Flags describing the desired extensions.
1504 * @param[in] cref_want Flags describing the desired extra extensions.
1506 static inline void changelog_remap_rec(struct changelog_rec *rec,
1507 enum changelog_rec_flags crf_wanted,
1508 enum changelog_rec_extra_flags cref_want)
1510 char *xattr_mov = NULL;
1511 char *omd_mov = NULL;
1512 char *nid_mov = NULL;
1513 char *uidgid_mov = NULL;
1517 enum changelog_rec_extra_flags cref = CLFE_INVALID;
1519 crf_wanted &= CLF_SUPPORTED;
1520 cref_want &= CLFE_SUPPORTED;
1522 if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1523 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1524 (rec->cr_flags & CLF_EXTRA_FLAGS &&
1525 (changelog_rec_extra_flags(rec)->cr_extra_flags &
1531 /* First move the variable-length name field */
1532 memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1533 changelog_rec_name(rec), rec->cr_namelen);
1535 /* Locations of extensions in the remapped record */
1536 if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1537 xattr_mov = (char *)rec +
1538 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1539 cref_want & ~CLFE_XATTR);
1540 omd_mov = (char *)rec +
1541 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1542 cref_want & ~(CLFE_OPEN |
1544 nid_mov = (char *)rec +
1545 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1546 cref_want & ~(CLFE_NID |
1549 uidgid_mov = (char *)rec +
1550 changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1551 cref_want & ~(CLFE_UIDGID |
1555 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1558 ef_mov = (char *)rec +
1559 changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1561 jid_mov = (char *)rec +
1562 changelog_rec_offset(crf_wanted &
1563 ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1565 rnm_mov = (char *)rec +
1566 changelog_rec_offset(crf_wanted &
1572 /* Move the extension fields to the desired positions */
1573 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1574 (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1575 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1576 memmove(xattr_mov, changelog_rec_xattr(rec),
1577 sizeof(struct changelog_ext_xattr));
1579 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1580 memmove(omd_mov, changelog_rec_openmode(rec),
1581 sizeof(struct changelog_ext_openmode));
1583 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1584 memmove(nid_mov, changelog_rec_nid(rec),
1585 sizeof(struct changelog_ext_nid));
1587 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1588 memmove(uidgid_mov, changelog_rec_uidgid(rec),
1589 sizeof(struct changelog_ext_uidgid));
1591 memmove(ef_mov, changelog_rec_extra_flags(rec),
1592 sizeof(struct changelog_ext_extra_flags));
1595 if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1596 memmove(jid_mov, changelog_rec_jobid(rec),
1597 sizeof(struct changelog_ext_jobid));
1599 if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1600 memmove(rnm_mov, changelog_rec_rename(rec),
1601 sizeof(struct changelog_ext_rename));
1603 /* Clear newly added fields */
1604 if (xattr_mov && (cref_want & CLFE_XATTR) &&
1605 !(cref & CLFE_XATTR))
1606 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1608 if (omd_mov && (cref_want & CLFE_OPEN) &&
1609 !(cref & CLFE_OPEN))
1610 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1612 if (nid_mov && (cref_want & CLFE_NID) &&
1614 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1616 if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1617 !(cref & CLFE_UIDGID))
1618 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1620 if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1621 !(rec->cr_flags & CLF_EXTRA_FLAGS))
1622 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1624 if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1625 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1627 if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1628 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1630 /* Update the record's flags accordingly */
1631 rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1632 if (rec->cr_flags & CLF_EXTRA_FLAGS)
1633 changelog_rec_extra_flags(rec)->cr_extra_flags =
1634 changelog_rec_extra_flags(rec)->cr_extra_flags |
1638 enum changelog_message_type {
1639 CL_RECORD = 10, /* message is a changelog_rec */
1640 CL_EOF = 11, /* at end of current changelog */
1643 /********* Misc **********/
1645 struct ioc_data_version {
1647 __u32 idv_layout_version; /* FLR: layout version for OST objects */
1648 __u32 idv_flags; /* enum ioc_data_version_flags */
1651 enum ioc_data_version_flags {
1652 LL_DV_RD_FLUSH = (1 << 0), /* Flush dirty pages from clients */
1653 LL_DV_WR_FLUSH = (1 << 1), /* Flush all caching pages from clients */
1657 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
1660 #define dot_lustre_name ".lustre"
1663 /********* HSM **********/
1665 /** HSM per-file state
1666 * See HSM_FLAGS below.
1669 HS_NONE = 0x00000000,
1670 HS_EXISTS = 0x00000001,
1671 HS_DIRTY = 0x00000002,
1672 HS_RELEASED = 0x00000004,
1673 HS_ARCHIVED = 0x00000008,
1674 HS_NORELEASE = 0x00000010,
1675 HS_NOARCHIVE = 0x00000020,
1676 HS_LOST = 0x00000040,
1679 /* HSM user-setable flags. */
1680 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1682 /* Other HSM flags. */
1683 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1686 * All HSM-related possible flags that could be applied to a file.
1687 * This should be kept in sync with hsm_states.
1689 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
1692 * HSM request progress state
1694 enum hsm_progress_states {
1701 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1704 case HPS_WAITING: return "waiting";
1705 case HPS_RUNNING: return "running";
1706 case HPS_DONE: return "done";
1707 default: return "unknown";
1714 } __attribute__((packed));
1717 * Current HSM states of a Lustre file.
1719 * This structure purpose is to be sent to user-space mainly. It describes the
1720 * current HSM flags and in-progress action.
1722 struct hsm_user_state {
1723 /** Current HSM states, from enum hsm_states. */
1725 __u32 hus_archive_id;
1726 /** The current undergoing action, if there is one */
1727 __u32 hus_in_progress_state;
1728 __u32 hus_in_progress_action;
1729 struct hsm_extent hus_in_progress_location;
1730 char hus_extended_info[];
1733 struct hsm_state_set_ioc {
1734 struct lu_fid hssi_fid;
1736 __u64 hssi_clearmask;
1740 * This structure describes the current in-progress action for a file.
1741 * it is retuned to user space and send over the wire
1743 struct hsm_current_action {
1744 /** The current undergoing action, if there is one */
1745 /* state is one of hsm_progress_states */
1747 /* action is one of hsm_user_action */
1749 struct hsm_extent hca_location;
1752 /***** HSM user requests ******/
1753 /* User-generated (lfs/ioctl) request types */
1754 enum hsm_user_action {
1755 HUA_NONE = 1, /* no action (noop) */
1756 HUA_ARCHIVE = 10, /* copy to hsm */
1757 HUA_RESTORE = 11, /* prestage */
1758 HUA_RELEASE = 12, /* drop ost objects */
1759 HUA_REMOVE = 13, /* remove from archive */
1760 HUA_CANCEL = 14 /* cancel a request */
1763 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1766 case HUA_NONE: return "NOOP";
1767 case HUA_ARCHIVE: return "ARCHIVE";
1768 case HUA_RESTORE: return "RESTORE";
1769 case HUA_RELEASE: return "RELEASE";
1770 case HUA_REMOVE: return "REMOVE";
1771 case HUA_CANCEL: return "CANCEL";
1772 default: return "UNKNOWN";
1777 * List of hr_flags (bit field)
1779 #define HSM_FORCE_ACTION 0x0001
1780 /* used by CT, cannot be set by user */
1781 #define HSM_GHOST_COPY 0x0002
1784 * Contains all the fixed part of struct hsm_user_request.
1787 struct hsm_request {
1788 __u32 hr_action; /* enum hsm_user_action */
1789 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1790 __u64 hr_flags; /* request flags */
1791 __u32 hr_itemcount; /* item count in hur_user_item vector */
1795 struct hsm_user_item {
1796 struct lu_fid hui_fid;
1797 struct hsm_extent hui_extent;
1798 } __attribute__((packed));
1800 struct hsm_user_request {
1801 struct hsm_request hur_request;
1802 struct hsm_user_item hur_user_item[0];
1803 /* extra data blob at end of struct (after all
1804 * hur_user_items), only use helpers to access it
1806 } __attribute__((packed));
1808 /** Return pointer to data field in a hsm user request */
1809 static inline void *hur_data(struct hsm_user_request *hur)
1811 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1815 * Compute the current length of the provided hsm_user_request. This returns -1
1816 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1818 * return -1 on bounds check error.
1820 static inline ssize_t hur_len(struct hsm_user_request *hur)
1824 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1825 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1826 (__u64)hur->hur_request.hr_itemcount *
1827 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1829 if (size != (ssize_t)size)
1835 /****** HSM RPCs to copytool *****/
1836 /* Message types the copytool may receive */
1837 enum hsm_message_type {
1838 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1841 /* Actions the copytool may be instructed to take for a given action_item */
1842 enum hsm_copytool_action {
1843 HSMA_NONE = 10, /* no action */
1844 HSMA_ARCHIVE = 20, /* arbitrary offset */
1850 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1853 case HSMA_NONE: return "NOOP";
1854 case HSMA_ARCHIVE: return "ARCHIVE";
1855 case HSMA_RESTORE: return "RESTORE";
1856 case HSMA_REMOVE: return "REMOVE";
1857 case HSMA_CANCEL: return "CANCEL";
1858 default: return "UNKNOWN";
1862 /* Copytool item action description */
1863 struct hsm_action_item {
1864 __u32 hai_len; /* valid size of this struct */
1865 __u32 hai_action; /* hsm_copytool_action, but use known size */
1866 struct lu_fid hai_fid; /* Lustre FID to operate on */
1867 struct lu_fid hai_dfid; /* fid used for data access */
1868 struct hsm_extent hai_extent; /* byte range to operate on */
1869 __u64 hai_cookie; /* action cookie from coordinator */
1870 __u64 hai_gid; /* grouplock id */
1871 char hai_data[0]; /* variable length */
1872 } __attribute__((packed));
1875 * helper function which print in hexa the first bytes of
1878 * \param hai [IN] record to print
1879 * \param buffer [IN,OUT] buffer to write the hex string to
1880 * \param len [IN] max buffer length
1884 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1885 char *buffer, size_t len)
1892 data_len = hai->hai_len - sizeof(*hai);
1893 for (i = 0; (i < data_len) && (len > 2); i++) {
1894 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1904 /* Copytool action list */
1905 #define HAL_VERSION 1
1906 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1907 struct hsm_action_list {
1909 __u32 hal_count; /* number of hai's to follow */
1910 __u64 hal_compound_id; /* returned by coordinator, ignored */
1912 __u32 hal_archive_id; /* which archive backend */
1914 char hal_fsname[0]; /* null-terminated */
1915 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1916 boundaries. See hai_zero */
1917 } __attribute__((packed));
1919 /* Return pointer to first hai in action list */
1920 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1922 size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1924 return (struct hsm_action_item *)(hal->hal_fsname + offset);
1927 /* Return pointer to next hai */
1928 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1930 size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
1932 return (struct hsm_action_item *)((char *)hai + offset);
1935 /* Return size of an hsm_action_list */
1936 static inline size_t hal_size(struct hsm_action_list *hal)
1940 struct hsm_action_item *hai;
1942 sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1943 hai = hai_first(hal);
1944 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1945 sz += __ALIGN_KERNEL(hai->hai_len, 8);
1951 * describe the attributes to be set on imported file
1953 struct hsm_user_import {
1962 __u32 hui_archive_id;
1965 /* Copytool progress reporting */
1966 #define HP_FLAG_COMPLETED 0x01
1967 #define HP_FLAG_RETRY 0x02
1969 struct hsm_progress {
1970 struct lu_fid hp_fid;
1972 struct hsm_extent hp_extent;
1974 __u16 hp_errval; /* positive val */
1979 __u64 hc_data_version;
1981 __u16 hc_errval; /* positive val */
1983 struct hsm_action_item hc_hai;
1987 enum llapi_json_types {
1988 LLAPI_JSON_INTEGER = 1,
1994 struct llapi_json_item {
2003 struct llapi_json_item *lji_next;
2006 struct llapi_json_item_list {
2007 int ljil_item_count;
2008 struct llapi_json_item *ljil_items;
2011 enum lu_ladvise_type {
2012 LU_LADVISE_INVALID = 0,
2013 LU_LADVISE_WILLREAD = 1,
2014 LU_LADVISE_DONTNEED = 2,
2015 LU_LADVISE_LOCKNOEXPAND = 3,
2016 LU_LADVISE_LOCKAHEAD = 4,
2020 #define LU_LADVISE_NAMES { \
2021 [LU_LADVISE_WILLREAD] = "willread", \
2022 [LU_LADVISE_DONTNEED] = "dontneed", \
2023 [LU_LADVISE_LOCKNOEXPAND] = "locknoexpand", \
2024 [LU_LADVISE_LOCKAHEAD] = "lockahead", \
2027 /* This is the userspace argument for ladvise. It is currently the same as
2028 * what goes on the wire (struct lu_ladvise), but is defined separately as we
2029 * may need info which is only used locally. */
2030 struct llapi_lu_ladvise {
2031 __u16 lla_advice; /* advice type */
2032 __u16 lla_value1; /* values for different advice types */
2034 __u64 lla_start; /* first byte of extent for advice */
2035 __u64 lla_end; /* last byte of extent for advice */
2041 LF_ASYNC = 0x00000001,
2042 LF_UNSET = 0x00000002,
2045 #define LADVISE_MAGIC 0x1ADF1CE0
2046 /* Masks of valid flags for each advice */
2047 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2048 /* Flags valid for all advices not explicitly specified */
2049 #define LF_DEFAULT_MASK LF_ASYNC
2051 #define LF_MASK (LF_ASYNC | LF_UNSET)
2053 #define lla_lockahead_mode lla_value1
2054 #define lla_peradvice_flags lla_value2
2055 #define lla_lockahead_result lla_value3
2057 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2058 * is used on the wire. It is defined separately as we may need info which is
2059 * only used locally. */
2060 struct llapi_ladvise_hdr {
2061 __u32 lah_magic; /* LADVISE_MAGIC */
2062 __u32 lah_count; /* number of advices */
2063 __u64 lah_flags; /* from enum ladvise_flag */
2064 __u32 lah_value1; /* unused */
2065 __u32 lah_value2; /* unused */
2066 __u64 lah_value3; /* unused */
2067 struct llapi_lu_ladvise lah_advise[0]; /* advices in this header */
2070 #define LAH_COUNT_MAX (1024)
2074 SK_CRYPT_INVALID = -1,
2076 SK_CRYPT_AES256_CTR = 1,
2081 SK_HMAC_INVALID = -1,
2088 struct sk_crypt_type {
2093 struct sk_hmac_type {
2098 enum lock_mode_user {
2104 #define LOCK_MODE_NAMES { \
2105 [MODE_READ_USER] = "READ",\
2106 [MODE_WRITE_USER] = "WRITE"\
2109 enum lockahead_results {
2110 LLA_RESULT_SENT = 0,
2111 LLA_RESULT_DIFFERENT,
2115 #if defined(__cplusplus)
2119 /** @} lustreuser */
2121 #endif /* _LUSTRE_USER_H */