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, 2016, 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/types.h>
48 # include <linux/fs.h>
49 # include <linux/quota.h>
50 # include <linux/string.h> /* snprintf() */
51 # include <linux/version.h>
52 #else /* !__KERNEL__ */
55 # include <stdio.h> /* snprintf() */
57 # define NEED_QUOTA_DEFS
58 /* # include <sys/quota.h> - this causes complaints about caddr_t */
59 # include <sys/stat.h>
60 #endif /* __KERNEL__ */
61 #include <lustre/ll_fiemap.h>
64 * This is a temporary solution of adding quota type.
65 * Should be removed as soon as system header is updated.
68 #define LL_MAXQUOTAS 3
70 #define INITQFNAMES { \
71 "user", /* USRQUOTA */ \
72 "group", /* GRPQUOTA */ \
73 "project", /* PRJQUOTA */ \
86 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
87 defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
89 typedef struct stat lstat_t;
90 # define lstat_f lstat
91 # define fstat_f fstat
92 # define fstatat_f fstatat
93 # define HAVE_LOV_USER_MDS_DATA
94 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
95 typedef struct stat64 lstat_t;
96 # define lstat_f lstat64
97 # define fstat_f fstat64
98 # define fstatat_f fstatat64
99 # define HAVE_LOV_USER_MDS_DATA
102 #define LUSTRE_EOF 0xffffffffffffffffULL
105 #define LL_SUPER_MAGIC 0x0BD00BD0
107 #ifndef FSFILT_IOC_GETFLAGS
108 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
109 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
110 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
111 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
112 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
113 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, 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 */
138 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
139 __u32 os_fprecreated; /* objs available now to the caller */
140 /* used in QoS code to find preferred
155 * FID is a cluster-wide unique identifier of a file or an object (stripe).
156 * FIDs are never reused.
160 * FID sequence. Sequence is a unit of migration: all files (objects)
161 * with FIDs from a given sequence are stored on the same server.
162 * Lustre should support 2^64 objects, so even if each sequence
163 * has only a single object we can still enumerate 2^64 objects.
166 /* FID number within sequence. */
169 * FID version, used to distinguish different versions (in the sense
170 * of snapshots, etc.) of the same file system object. Not currently
176 static inline bool fid_is_zero(const struct lu_fid *fid)
178 return fid->f_seq == 0 && fid->f_oid == 0;
181 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
182 * MDT-object's FID::f_ver, instead it is the OST-object index in its
183 * parent MDT-object's layout EA. */
184 #define f_stripe_idx f_ver
187 __u32 ol_stripe_size;
188 __u32 ol_stripe_count;
192 } __attribute__((packed));
194 /* keep this one for compatibility */
195 struct filter_fid_old {
196 struct lu_fid ff_parent;
202 struct lu_fid ff_parent;
203 struct ost_layout ff_layout;
204 } __attribute__((packed));
206 /* Userspace should treat lu_fid as opaque, and only use the following methods
207 * to print or parse them. Other functions (e.g. compare, swab) could be moved
208 * here from lustre_idl.h if needed. */
209 typedef struct lu_fid lustre_fid;
212 LMAC_HSM = 0x00000001,
213 /* LMAC_SOM = 0x00000002, obsolete since 2.8.0 */
214 LMAC_NOT_IN_OI = 0x00000004, /* the object does NOT need OI mapping */
215 LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
216 * under /O/<seq>/d<x>. */
217 LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
218 LMAC_COMP_INFO = 0x00000020, /* Component info in the LMA EA. */
222 * Masks for all features that should be supported by a Lustre version to
223 * access a specific file.
224 * This information is stored in lustre_mdt_attrs::lma_incompat.
227 LMAI_RELEASED = 0x00000001, /* file is released */
228 LMAI_AGENT = 0x00000002, /* agent inode */
229 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
230 is on the remote MDT */
231 LMAI_STRIPED = 0x00000008, /* striped directory inode */
232 LMAI_ORPHAN = 0x00000010, /* inode is orphan */
233 LMA_INCOMPAT_SUPP = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
234 LMAI_STRIPED | LMAI_ORPHAN)
239 * Following struct for object attributes, that will be kept inode's EA.
240 * Introduced in 2.0 release (please see b15993, for details)
241 * Added to all objects since Lustre 2.4 as contains self FID
243 struct lustre_mdt_attrs {
245 * Bitfield for supported data in this structure. From enum lma_compat.
246 * lma_self_fid and lma_flags are always available.
250 * Per-file incompat feature list. Lustre version should support all
251 * flags set in this field. The supported feature mask is available in
255 /** FID of this inode */
256 struct lu_fid lma_self_fid;
259 struct lustre_ost_attrs {
260 /* Use lustre_mdt_attrs directly for now, need a common header
261 * structure if want to change lustre_mdt_attrs in future. */
262 struct lustre_mdt_attrs loa_lma;
264 /* Below five elements are for OST-object's PFID EA, the
265 * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
266 * and the stripe_index (low 16 bits), the size should not exceed
267 * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
268 * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
269 * are valid; if the flag LMAC_COMP_INFO is set, then the next three
270 * loa_comp_* elements are valid. */
271 struct lu_fid loa_parent_fid;
272 __u32 loa_stripe_size;
274 __u64 loa_comp_start;
279 * Prior to 2.4, the LMA structure also included SOM attributes which has since
280 * been moved to a dedicated xattr
281 * lma_flags was also removed because of lma_compat/incompat fields.
283 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
286 * OST object IDentifier.
294 struct lu_fid oi_fid;
298 #define DOSTID "%#llx:%llu"
299 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
300 ((unsigned long long)ostid_id(oi))
302 struct ll_futimes_3 {
304 __u64 lfu_atime_nsec;
306 __u64 lfu_mtime_nsec;
308 __u64 lfu_ctime_nsec;
312 * The ioctl naming rules:
313 * LL_* - works on the currently opened filehandle instead of parent dir
314 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
315 * *_MDC_* - gets/sets data related to MDC
316 * *_LOV_* - gets/sets data related to OSC/LOV
317 * *FILE* - called on parent dir and passes in a filename
318 * *STRIPE* - set/get lov_user_md
319 * *INFO - set/get lov_user_mds_data
321 /* lustre_ioctl.h 101-150 */
322 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
323 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
324 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
325 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
326 #define LL_IOC_LOV_SETSTRIPE_NEW _IOWR('f', 154, struct lov_user_md)
327 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
328 #define LL_IOC_LOV_GETSTRIPE_NEW _IOR('f', 155, struct lov_user_md)
329 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
330 /* LL_IOC_RECREATE_OBJ 157 obsolete */
331 /* LL_IOC_RECREATE_FID 157 obsolete */
332 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
333 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
334 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
335 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
336 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
337 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
338 /* IOC_LOV_GETINFO 165 obsolete */
339 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
340 /* LL_IOC_RMTACL 167 obsolete */
341 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
342 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
343 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
344 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
345 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
346 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
347 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
348 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
349 #define LL_IOC_FUTIMES_3 _IOWR('f', 176, struct ll_futimes_3)
350 /* lustre_ioctl.h 177-210 */
351 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
352 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
353 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
354 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
355 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
356 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
357 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
358 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
359 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
360 struct lustre_swap_layouts)
361 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
362 struct hsm_current_action)
363 /* lustre_ioctl.h 221-232 */
364 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
365 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
366 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
367 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
368 #define LL_IOC_GET_LEASE _IO('f', 244)
369 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
370 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
371 #define LL_IOC_MIGRATE _IOR('f', 247, int)
372 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
373 #define LL_IOC_GETPARENT _IOWR('f', 249, struct getparent)
374 #define LL_IOC_LADVISE _IOR('f', 250, struct llapi_lu_ladvise)
376 #ifndef FS_IOC_FSGETXATTR
378 * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
381 __u32 fsx_xflags; /* xflags field value (get/set) */
382 __u32 fsx_extsize; /* extsize field value (get/set)*/
383 __u32 fsx_nextents; /* nextents field value (get) */
384 __u32 fsx_projid; /* project identifier (get/set) */
385 unsigned char fsx_pad[12];
387 #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
388 #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
390 #define LL_IOC_FSGETXATTR FS_IOC_FSGETXATTR
391 #define LL_IOC_FSSETXATTR FS_IOC_FSSETXATTR
392 #define LL_PROJINHERIT_FL 0x20000000
395 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
397 LL_LEASE_RDLCK = 0x1,
398 LL_LEASE_WRLCK = 0x2,
399 LL_LEASE_UNLCK = 0x4,
402 #define LL_STATFS_LMV 1
403 #define LL_STATFS_LOV 2
404 #define LL_STATFS_NODELAY 4
406 #define IOC_MDC_TYPE 'i'
407 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
408 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
409 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
410 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
412 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
414 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
415 * files, but are unlikely to be used in practice and are not harmful if
416 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
417 * devices and are safe for use on new files. See LU-4209. */
418 /* To be compatible with old statically linked binary we keep the check for
419 * the older 0100000000 flag. This is already removed upstream. LU-812. */
420 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
422 #define FASYNC 00020000 /* fcntl, for BSD compatibility */
424 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
425 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
426 O_LOV_DELAY_CREATE_MASK)
428 #define LL_FILE_IGNORE_LOCK 0x00000001
429 #define LL_FILE_GROUP_LOCKED 0x00000002
430 #define LL_FILE_READAHEA 0x00000004
431 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
432 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
434 #define LOV_USER_MAGIC_V1 0x0BD10BD0
435 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
436 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
437 #define LOV_USER_MAGIC_V3 0x0BD30BD0
438 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
439 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0 /* for specific OSTs */
440 #define LOV_USER_MAGIC_COMP_V1 0x0BD60BD0
442 #define LMV_USER_MAGIC 0x0CD30CD0 /* default lmv magic */
443 #define LMV_USER_MAGIC_V0 0x0CD20CD0 /* old default lmv magic */
445 #define LOV_PATTERN_NONE 0x000
446 #define LOV_PATTERN_RAID0 0x001
447 #define LOV_PATTERN_RAID1 0x002
448 #define LOV_PATTERN_FIRST 0x100
449 #define LOV_PATTERN_CMOBD 0x200
451 #define LOV_PATTERN_F_MASK 0xffff0000
452 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
453 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
454 #define LOV_PATTERN_DEFAULT 0xffffffff
456 static inline bool lov_pattern_supported(__u32 pattern)
458 return pattern == LOV_PATTERN_RAID0 ||
459 pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_F_RELEASED);
462 #define LOV_MAXPOOLNAME 15
463 #define LOV_POOLNAMEF "%.15s"
465 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
466 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
467 #define LOV_MAX_STRIPE_COUNT_OLD 160
468 /* This calculation is crafted so that input of 4096 will result in 160
469 * which in turn is equal to old maximal stripe count.
470 * XXX: In fact this is too simpified for now, what it also need is to get
471 * ea_type argument to clearly know how much space each stripe consumes.
473 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
474 * allocation that is sufficient for the current generation of systems.
476 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
477 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
478 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
479 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
481 #define XATTR_LUSTRE_PREFIX "lustre."
482 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
484 #define lov_user_ost_data lov_user_ost_data_v1
485 struct lov_user_ost_data_v1 { /* per-stripe data structure */
486 struct ost_id l_ost_oi; /* OST object ID */
487 __u32 l_ost_gen; /* generation of this OST index */
488 __u32 l_ost_idx; /* OST index in LOV */
489 } __attribute__((packed));
491 #define lov_user_md lov_user_md_v1
492 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
493 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
494 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
495 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
496 __u32 lmm_stripe_size; /* size of stripe in bytes */
497 __u16 lmm_stripe_count; /* num stripes in use for this object */
499 __u16 lmm_stripe_offset; /* starting stripe offset in
500 * lmm_objects, use when writing */
501 __u16 lmm_layout_gen; /* layout generation number
502 * used when reading */
504 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
505 } __attribute__((packed, __may_alias__));
507 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
508 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
509 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
510 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
511 __u32 lmm_stripe_size; /* size of stripe in bytes */
512 __u16 lmm_stripe_count; /* num stripes in use for this object */
514 __u16 lmm_stripe_offset; /* starting stripe offset in
515 * lmm_objects, use when writing */
516 __u16 lmm_layout_gen; /* layout generation number
517 * used when reading */
519 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
520 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
521 } __attribute__((packed));
528 #define DEXT "[ %#llx , %#llx )"
529 #define PEXT(ext) (ext)->e_start, (ext)->e_end
531 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
532 struct lu_extent *e2)
534 return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
537 enum lov_comp_md_entry_flags {
538 LCME_FL_PRIMARY = 0x00000001, /* Not used */
539 LCME_FL_STALE = 0x00000002, /* Not used */
540 LCME_FL_OFFLINE = 0x00000004, /* Not used */
541 LCME_FL_PREFERRED = 0x00000008, /* Not used */
542 LCME_FL_INIT = 0x00000010, /* instantiated */
543 LCME_FL_NEG = 0x80000000 /* used to indicate a negative flag,
544 won't be stored on disk */
547 #define LCME_KNOWN_FLAGS (LCME_FL_NEG | LCME_FL_INIT)
549 /* lcme_id can be specified as certain flags, and the the first
550 * bit of lcme_id is used to indicate that the ID is representing
551 * certain LCME_FL_* but not a real ID. Which implies we can have
552 * at most 31 flags (see LCME_FL_XXX). */
555 LCME_ID_MAX = 0x7FFFFFFF,
556 LCME_ID_ALL = 0xFFFFFFFF,
557 LCME_ID_NOT_ID = LCME_FL_NEG
560 #define LCME_ID_MASK LCME_ID_MAX
562 struct lov_comp_md_entry_v1 {
563 __u32 lcme_id; /* unique id of component */
564 __u32 lcme_flags; /* LCME_FL_XXX */
565 struct lu_extent lcme_extent; /* file extent for component */
566 __u32 lcme_offset; /* offset of component blob,
567 start from lov_comp_md_v1 */
568 __u32 lcme_size; /* size of component blob */
569 __u64 lcme_padding[2];
570 } __attribute__((packed));
572 enum lov_comp_md_flags;
574 struct lov_comp_md_v1 {
575 __u32 lcm_magic; /* LOV_USER_MAGIC_COMP_V1 */
576 __u32 lcm_size; /* overall size including this struct */
577 __u32 lcm_layout_gen;
579 __u16 lcm_entry_count;
582 struct lov_comp_md_entry_v1 lcm_entries[0];
583 } __attribute__((packed));
585 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
587 if (stripes == (__u16)-1)
590 if (lmm_magic == LOV_USER_MAGIC_V1)
591 return sizeof(struct lov_user_md_v1) +
592 stripes * sizeof(struct lov_user_ost_data_v1);
593 return sizeof(struct lov_user_md_v3) +
594 stripes * sizeof(struct lov_user_ost_data_v1);
597 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
598 * use this. It is unsafe to #define those values in this header as it
599 * is possible the application has already #included <sys/stat.h>. */
600 #ifdef HAVE_LOV_USER_MDS_DATA
601 #define lov_user_mds_data lov_user_mds_data_v1
602 struct lov_user_mds_data_v1 {
603 lstat_t lmd_st; /* MDS stat struct */
604 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
605 } __attribute__((packed));
607 struct lov_user_mds_data_v3 {
608 lstat_t lmd_st; /* MDS stat struct */
609 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
610 } __attribute__((packed));
613 struct lmv_user_mds_data {
614 struct lu_fid lum_fid;
620 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
621 LMV_HASH_TYPE_ALL_CHARS = 1,
622 LMV_HASH_TYPE_FNV_1A_64 = 2,
626 #define LMV_HASH_NAME_ALL_CHARS "all_char"
627 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
629 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
631 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
632 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
633 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
634 #define lmv_user_md lmv_user_md_v1
635 struct lmv_user_md_v1 {
636 __u32 lum_magic; /* must be the first field */
637 __u32 lum_stripe_count; /* dirstripe count */
638 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
639 __u32 lum_hash_type; /* Dir stripe policy */
640 __u32 lum_type; /* LMV type: default or normal */
644 char lum_pool_name[LOV_MAXPOOLNAME + 1];
645 struct lmv_user_mds_data lum_objects[0];
646 } __attribute__((packed));
648 static inline int lmv_user_md_size(int stripes, int lmm_magic)
650 return sizeof(struct lmv_user_md) +
651 stripes * sizeof(struct lmv_user_mds_data);
654 struct ll_recreate_obj {
660 __u64 id; /* holds object id */
661 __u32 generation; /* holds object generation */
662 __u32 f_type; /* holds object type or stripe idx when passing it to
663 * OST for saving into EA. */
671 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
672 const struct obd_uuid *u2)
674 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
677 static inline int obd_uuid_empty(struct obd_uuid *uuid)
679 return uuid->uuid[0] == '\0';
682 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
684 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
685 uuid->uuid[sizeof(*uuid) - 1] = '\0';
688 /* For printf's only, make sure uuid is terminated */
689 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
694 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
695 /* Obviously not safe, but for printfs, no real harm done...
696 we're always null-terminated, even in a race. */
697 static char temp[sizeof(*uuid)];
698 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
699 temp[sizeof(*uuid) - 1] = '\0';
702 return (char *)(uuid->uuid);
705 #define LUSTRE_MAXFSNAME 8
707 /* Extract fsname from uuid (or target name) of a target
708 e.g. (myfs-OST0007_UUID -> myfs)
709 see also deuuidify. */
710 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
714 strncpy(buf, uuid, buflen - 1);
715 buf[buflen - 1] = '\0';
716 p = strrchr(buf, '-');
721 /* printf display format for Lustre FIDs
722 * usage: printf("file FID is "DFID"\n", PFID(fid)); */
723 #define FID_NOBRACE_LEN 40
724 #define FID_LEN (FID_NOBRACE_LEN + 2)
725 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
726 #define DFID "["DFID_NOBRACE"]"
727 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
729 /* scanf input parse format for fids in DFID_NOBRACE format
730 * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
731 * usage: sscanf(fidstr, SFID, RFID(&fid)); */
732 #define SFID "0x%llx:0x%x:0x%x"
733 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
735 /********* Quotas **********/
737 #define LUSTRE_QUOTABLOCK_BITS 10
738 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
740 static inline __u64 lustre_stoqb(size_t space)
742 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
745 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
746 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
747 #define Q_GETOINFO 0x800102 /* get obd quota info */
748 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
749 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
751 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
752 #define LUSTRE_Q_QUOTAON 0x800002 /* deprecated as of 2.4 */
753 #define LUSTRE_Q_QUOTAOFF 0x800003 /* deprecated as of 2.4 */
754 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
755 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
756 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
757 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
758 /* lustre-specific control commands */
759 #define LUSTRE_Q_INVALIDATE 0x80000b /* deprecated as of 2.4 */
760 #define LUSTRE_Q_FINVALIDATE 0x80000c /* deprecated as of 2.4 */
762 #define ALLQUOTA 255 /* set all quota */
763 static inline char *qtype_name(int qtype)
776 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
779 #define N_PERMS_MAX 64
781 struct perm_downcall_data {
787 struct identity_downcall_data {
794 struct perm_downcall_data idd_perms[N_PERMS_MAX];
798 #ifdef NEED_QUOTA_DEFS
800 #define QIF_BLIMITS 1
802 #define QIF_ILIMITS 4
806 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
807 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
808 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
809 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
812 #endif /* !__KERNEL__ */
814 /* lustre volatile file support
815 * file name header: .^L^S^T^R:volatile"
817 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
818 #define LUSTRE_VOLATILE_HDR_LEN 14
820 typedef enum lustre_quota_version {
822 } lustre_quota_version_t;
824 /* XXX: same as if_dqinfo struct in kernel */
832 /* XXX: same as if_dqblk struct in kernel, plus one padding */
834 __u64 dqb_bhardlimit;
835 __u64 dqb_bsoftlimit;
837 __u64 dqb_ihardlimit;
838 __u64 dqb_isoftlimit;
860 struct obd_dqinfo qc_dqinfo;
861 struct obd_dqblk qc_dqblk;
863 struct obd_uuid obd_uuid;
866 /* swap layout flags */
867 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
868 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
869 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
870 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
871 #define SWAP_LAYOUTS_CLOSE (1 << 4)
873 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
874 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
875 struct lustre_swap_layouts {
884 /********* Changelogs **********/
885 /** Changelog record types */
886 enum changelog_rec_type {
888 CL_CREATE = 1, /* namespace */
889 CL_MKDIR = 2, /* namespace */
890 CL_HARDLINK = 3, /* namespace */
891 CL_SOFTLINK = 4, /* namespace */
892 CL_MKNOD = 5, /* namespace */
893 CL_UNLINK = 6, /* namespace */
894 CL_RMDIR = 7, /* namespace */
895 CL_RENAME = 8, /* namespace */
896 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
897 CL_OPEN = 10, /* not currently used */
898 CL_CLOSE = 11, /* may be written to log only with mtime change */
899 CL_LAYOUT = 12, /* file layout/striping modified */
903 CL_HSM = 16, /* HSM specific events, see flags */
904 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
911 static inline const char *changelog_type2str(int type) {
912 static const char *changelog_str[] = {
913 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
914 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
915 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "MIGRT"
918 if (type >= 0 && type < CL_LAST)
919 return changelog_str[type];
923 /* per-record flags */
924 #define CLF_FLAGSHIFT 12
925 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
926 #define CLF_VERMASK (~CLF_FLAGMASK)
927 enum changelog_rec_flags {
928 CLF_VERSION = 0x1000,
931 CLF_SUPPORTED = CLF_VERSION | CLF_RENAME | CLF_JOBID
935 /* Anything under the flagmask may be per-type (if desired) */
936 /* Flags for unlink */
937 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
938 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
939 /* HSM cleaning needed */
940 /* Flags for rename */
941 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
943 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
944 * has an archive in backend */
947 /* 12b used (from high weight to low weight):
952 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
953 #define CLF_HSM_ERR_H 6
954 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
955 #define CLF_HSM_EVENT_H 9
956 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
957 #define CLF_HSM_FLAG_H 11
958 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
959 #define CLF_HSM_SPARE_H 15
960 #define CLF_HSM_LAST 15
962 /* Remove bits higher than _h, then extract the value
963 * between _h and _l by shifting lower weigth to bit 0. */
964 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
965 >> (CLF_HSM_LAST - _h + _l))
967 #define CLF_HSM_SUCCESS 0x00
968 #define CLF_HSM_MAXERROR 0x7E
969 #define CLF_HSM_ERROVERFLOW 0x7F
971 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
973 /* 3 bits field => 8 values allowed */
985 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
987 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
991 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
993 *flags |= (he << CLF_HSM_EVENT_L);
996 static inline __u16 hsm_get_cl_flags(int flags)
998 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1001 static inline void hsm_set_cl_flags(int *flags, int bits)
1003 *flags |= (bits << CLF_HSM_FLAG_L);
1006 static inline int hsm_get_cl_error(int flags)
1008 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1011 static inline void hsm_set_cl_error(int *flags, int error)
1013 *flags |= (error << CLF_HSM_ERR_L);
1016 enum changelog_send_flag {
1017 /* Not yet implemented */
1018 CHANGELOG_FLAG_FOLLOW = 0x01,
1019 /* Blocking IO makes sense in case of slow user parsing of the records,
1020 * but it also prevents us from cleaning up if the records are not
1022 CHANGELOG_FLAG_BLOCK = 0x02,
1023 /* Pack jobid into the changelog records if available. */
1024 CHANGELOG_FLAG_JOBID = 0x04,
1027 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
1028 changelog_rec_offset(CLF_SUPPORTED))
1030 /* 31 usable bytes string + null terminator. */
1031 #define LUSTRE_JOBID_SIZE 32
1033 /* This is the minimal changelog record. It can contain extensions
1034 * such as rename fields or process jobid. Its exact content is described
1037 * Extensions are packed in the same order as their corresponding flags.
1039 struct changelog_rec {
1041 __u16 cr_flags; /**< \a changelog_rec_flags */
1042 __u32 cr_type; /**< \a changelog_rec_type */
1043 __u64 cr_index; /**< changelog record number */
1044 __u64 cr_prev; /**< last index for this target fid */
1047 lustre_fid cr_tfid; /**< target fid */
1048 __u32 cr_markerflags; /**< CL_MARK flags */
1050 lustre_fid cr_pfid; /**< parent fid */
1053 /* Changelog extension for RENAME. */
1054 struct changelog_ext_rename {
1055 lustre_fid cr_sfid; /**< source fid, or zero */
1056 lustre_fid cr_spfid; /**< source parent fid, or zero */
1059 /* Changelog extension to include JOBID. */
1060 struct changelog_ext_jobid {
1061 char cr_jobid[LUSTRE_JOBID_SIZE]; /**< zero-terminated string. */
1065 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
1067 size_t size = sizeof(struct changelog_rec);
1069 if (crf & CLF_RENAME)
1070 size += sizeof(struct changelog_ext_rename);
1072 if (crf & CLF_JOBID)
1073 size += sizeof(struct changelog_ext_jobid);
1078 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1080 return changelog_rec_offset(rec->cr_flags);
1083 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1085 return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1089 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1091 enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1093 return (struct changelog_ext_rename *)((char *)rec +
1094 changelog_rec_offset(crf));
1097 /* The jobid follows the rename extension, if present */
1099 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1101 enum changelog_rec_flags crf = rec->cr_flags &
1102 (CLF_VERSION | CLF_RENAME);
1104 return (struct changelog_ext_jobid *)((char *)rec +
1105 changelog_rec_offset(crf));
1108 /* The name follows the rename and jobid extensions, if present */
1109 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1111 return (char *)rec + changelog_rec_offset(rec->cr_flags &
1115 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1117 return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1120 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1122 char *cr_name = changelog_rec_name(rec);
1124 return cr_name + strlen(cr_name) + 1;
1128 * Remap a record to the desired format as specified by the crf flags.
1129 * The record must be big enough to contain the final remapped version.
1130 * Superfluous extension fields are removed and missing ones are added
1131 * and zeroed. The flags of the record are updated accordingly.
1133 * The jobid and rename extensions can be added to a record, to match the
1134 * format an application expects, typically. In this case, the newly added
1135 * fields will be zeroed.
1136 * The Jobid field can be removed, to guarantee compatibility with older
1137 * clients that don't expect this field in the records they process.
1139 * The following assumptions are being made:
1140 * - CLF_RENAME will not be removed
1141 * - CLF_JOBID will not be added without CLF_RENAME being added too
1143 * @param[in,out] rec The record to remap.
1144 * @param[in] crf_wanted Flags describing the desired extensions.
1146 static inline void changelog_remap_rec(struct changelog_rec *rec,
1147 enum changelog_rec_flags crf_wanted)
1152 crf_wanted &= CLF_SUPPORTED;
1154 if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
1157 /* First move the variable-length name field */
1158 memmove((char *)rec + changelog_rec_offset(crf_wanted),
1159 changelog_rec_name(rec), rec->cr_namelen);
1161 /* Locations of jobid and rename extensions in the remapped record */
1162 jid_mov = (char *)rec +
1163 changelog_rec_offset(crf_wanted & ~CLF_JOBID);
1164 rnm_mov = (char *)rec +
1165 changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
1167 /* Move the extension fields to the desired positions */
1168 if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1169 memmove(jid_mov, changelog_rec_jobid(rec),
1170 sizeof(struct changelog_ext_jobid));
1172 if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1173 memmove(rnm_mov, changelog_rec_rename(rec),
1174 sizeof(struct changelog_ext_rename));
1176 /* Clear newly added fields */
1177 if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1178 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1180 if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1181 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1183 /* Update the record's flags accordingly */
1184 rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1187 enum changelog_message_type {
1188 CL_RECORD = 10, /* message is a changelog_rec */
1189 CL_EOF = 11, /* at end of current changelog */
1192 /********* Misc **********/
1194 struct ioc_data_version {
1196 __u64 idv_flags; /* See LL_DV_xxx */
1198 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1199 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1202 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
1205 #define dot_lustre_name ".lustre"
1208 /********* HSM **********/
1210 /** HSM per-file state
1211 * See HSM_FLAGS below.
1214 HS_NONE = 0x00000000,
1215 HS_EXISTS = 0x00000001,
1216 HS_DIRTY = 0x00000002,
1217 HS_RELEASED = 0x00000004,
1218 HS_ARCHIVED = 0x00000008,
1219 HS_NORELEASE = 0x00000010,
1220 HS_NOARCHIVE = 0x00000020,
1221 HS_LOST = 0x00000040,
1224 /* HSM user-setable flags. */
1225 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1227 /* Other HSM flags. */
1228 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1231 * All HSM-related possible flags that could be applied to a file.
1232 * This should be kept in sync with hsm_states.
1234 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
1237 * HSMÂ request progress state
1239 enum hsm_progress_states {
1246 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1249 case HPS_WAITING: return "waiting";
1250 case HPS_RUNNING: return "running";
1251 case HPS_DONE: return "done";
1252 default: return "unknown";
1259 } __attribute__((packed));
1262 * Current HSM states of a Lustre file.
1264 * This structure purpose is to be sent to user-space mainly. It describes the
1265 * current HSM flags and in-progress action.
1267 struct hsm_user_state {
1268 /** Current HSM states, from enum hsm_states. */
1270 __u32 hus_archive_id;
1271 /** The current undergoing action, if there is one */
1272 __u32 hus_in_progress_state;
1273 __u32 hus_in_progress_action;
1274 struct hsm_extent hus_in_progress_location;
1275 char hus_extended_info[];
1278 struct hsm_state_set_ioc {
1279 struct lu_fid hssi_fid;
1281 __u64 hssi_clearmask;
1285 * This structure describes the current in-progress action for a file.
1286 * it is retuned to user space and send over the wire
1288 struct hsm_current_action {
1289 /** The current undergoing action, if there is one */
1290 /* state is one of hsm_progress_states */
1292 /* action is one of hsm_user_action */
1294 struct hsm_extent hca_location;
1297 /***** HSM user requests ******/
1298 /* User-generated (lfs/ioctl) request types */
1299 enum hsm_user_action {
1300 HUA_NONE = 1, /* no action (noop) */
1301 HUA_ARCHIVE = 10, /* copy to hsm */
1302 HUA_RESTORE = 11, /* prestage */
1303 HUA_RELEASE = 12, /* drop ost objects */
1304 HUA_REMOVE = 13, /* remove from archive */
1305 HUA_CANCEL = 14 /* cancel a request */
1308 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1311 case HUA_NONE: return "NOOP";
1312 case HUA_ARCHIVE: return "ARCHIVE";
1313 case HUA_RESTORE: return "RESTORE";
1314 case HUA_RELEASE: return "RELEASE";
1315 case HUA_REMOVE: return "REMOVE";
1316 case HUA_CANCEL: return "CANCEL";
1317 default: return "UNKNOWN";
1322 * List of hr_flags (bit field)
1324 #define HSM_FORCE_ACTION 0x0001
1325 /* used by CT, cannot be set by user */
1326 #define HSM_GHOST_COPY 0x0002
1329 * Contains all the fixed part of struct hsm_user_request.
1332 struct hsm_request {
1333 __u32 hr_action; /* enum hsm_user_action */
1334 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1335 __u64 hr_flags; /* request flags */
1336 __u32 hr_itemcount; /* item count in hur_user_item vector */
1340 struct hsm_user_item {
1342 struct hsm_extent hui_extent;
1343 } __attribute__((packed));
1345 struct hsm_user_request {
1346 struct hsm_request hur_request;
1347 struct hsm_user_item hur_user_item[0];
1348 /* extra data blob at end of struct (after all
1349 * hur_user_items), only use helpers to access it
1351 } __attribute__((packed));
1353 /** Return pointer to data field in a hsm user request */
1354 static inline void *hur_data(struct hsm_user_request *hur)
1356 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1360 * Compute the current length of the provided hsm_user_request. This returns -1
1361 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1363 * return -1 on bounds check error.
1365 static inline ssize_t hur_len(struct hsm_user_request *hur)
1369 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1370 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1371 (__u64)hur->hur_request.hr_itemcount *
1372 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1374 if (size != (ssize_t)size)
1380 /****** HSM RPCs to copytool *****/
1381 /* Message types the copytool may receive */
1382 enum hsm_message_type {
1383 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1386 /* Actions the copytool may be instructed to take for a given action_item */
1387 enum hsm_copytool_action {
1388 HSMA_NONE = 10, /* no action */
1389 HSMA_ARCHIVE = 20, /* arbitrary offset */
1395 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1398 case HSMA_NONE: return "NOOP";
1399 case HSMA_ARCHIVE: return "ARCHIVE";
1400 case HSMA_RESTORE: return "RESTORE";
1401 case HSMA_REMOVE: return "REMOVE";
1402 case HSMA_CANCEL: return "CANCEL";
1403 default: return "UNKNOWN";
1407 /* Copytool item action description */
1408 struct hsm_action_item {
1409 __u32 hai_len; /* valid size of this struct */
1410 __u32 hai_action; /* hsm_copytool_action, but use known size */
1411 lustre_fid hai_fid; /* Lustre FID to operate on */
1412 lustre_fid hai_dfid; /* fid used for data access */
1413 struct hsm_extent hai_extent; /* byte range to operate on */
1414 __u64 hai_cookie; /* action cookie from coordinator */
1415 __u64 hai_gid; /* grouplock id */
1416 char hai_data[0]; /* variable length */
1417 } __attribute__((packed));
1420 * helper function which print in hexa the first bytes of
1423 * \param hai [IN] record to print
1424 * \param buffer [IN,OUT] buffer to write the hex string to
1425 * \param len [IN] max buffer length
1429 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1430 char *buffer, size_t len)
1437 data_len = hai->hai_len - sizeof(*hai);
1438 for (i = 0; (i < data_len) && (len > 2); i++) {
1439 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1449 /* Copytool action list */
1450 #define HAL_VERSION 1
1451 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1452 struct hsm_action_list {
1454 __u32 hal_count; /* number of hai's to follow */
1455 __u64 hal_compound_id; /* returned by coordinator */
1457 __u32 hal_archive_id; /* which archive backend */
1459 char hal_fsname[0]; /* null-terminated */
1460 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1461 boundaries. See hai_zero */
1462 } __attribute__((packed));
1464 #ifndef HAVE_CFS_SIZE_ROUND
1465 static inline int cfs_size_round (int val)
1467 return (val + 7) & (~0x7);
1469 #define HAVE_CFS_SIZE_ROUND
1472 /* Return pointer to first hai in action list */
1473 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1475 return (struct hsm_action_item *)(hal->hal_fsname +
1476 cfs_size_round(strlen(hal-> \
1480 /* Return pointer to next hai */
1481 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1483 return (struct hsm_action_item *)((char *)hai +
1484 cfs_size_round(hai->hai_len));
1487 /* Return size of an hsm_action_list */
1488 static inline size_t hal_size(struct hsm_action_list *hal)
1492 struct hsm_action_item *hai;
1494 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1495 hai = hai_first(hal);
1496 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1497 sz += cfs_size_round(hai->hai_len);
1503 * describe the attributes to be set on imported file
1505 struct hsm_user_import {
1514 __u32 hui_archive_id;
1517 /* Copytool progress reporting */
1518 #define HP_FLAG_COMPLETED 0x01
1519 #define HP_FLAG_RETRY 0x02
1521 struct hsm_progress {
1524 struct hsm_extent hp_extent;
1526 __u16 hp_errval; /* positive val */
1531 __u64 hc_data_version;
1533 __u16 hc_errval; /* positive val */
1535 struct hsm_action_item hc_hai;
1539 enum llapi_json_types {
1540 LLAPI_JSON_INTEGER = 1,
1546 struct llapi_json_item {
1555 struct llapi_json_item *lji_next;
1558 struct llapi_json_item_list {
1559 int ljil_item_count;
1560 struct llapi_json_item *ljil_items;
1563 enum lu_ladvise_type {
1564 LU_LADVISE_INVALID = 0,
1565 LU_LADVISE_WILLREAD = 1,
1566 LU_LADVISE_DONTNEED = 2,
1569 #define LU_LADVISE_NAMES { \
1570 [LU_LADVISE_WILLREAD] = "willread", \
1571 [LU_LADVISE_DONTNEED] = "dontneed", \
1574 /* This is the userspace argument for ladvise. It is currently the same as
1575 * what goes on the wire (struct lu_ladvise), but is defined separately as we
1576 * may need info which is only used locally. */
1577 struct llapi_lu_ladvise {
1578 __u16 lla_advice; /* advice type */
1579 __u16 lla_value1; /* values for different advice types */
1581 __u64 lla_start; /* first byte of extent for advice */
1582 __u64 lla_end; /* last byte of extent for advice */
1588 LF_ASYNC = 0x00000001,
1591 #define LADVISE_MAGIC 0x1ADF1CE0
1592 #define LF_MASK LF_ASYNC
1594 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1595 * is used on the wire. It is defined separately as we may need info which is
1596 * only used locally. */
1597 struct llapi_ladvise_hdr {
1598 __u32 lah_magic; /* LADVISE_MAGIC */
1599 __u32 lah_count; /* number of advices */
1600 __u64 lah_flags; /* from enum ladvise_flag */
1601 __u32 lah_value1; /* unused */
1602 __u32 lah_value2; /* unused */
1603 __u64 lah_value3; /* unused */
1604 struct llapi_lu_ladvise lah_advise[0]; /* advices in this header */
1607 #define LAH_COUNT_MAX (1024)
1611 SK_CRYPT_INVALID = -1,
1613 SK_CRYPT_AES256_CTR = 1,
1618 SK_HMAC_INVALID = -1,
1625 struct sk_crypt_type {
1630 struct sk_hmac_type {
1635 /** @} lustreuser */
1636 #endif /* _LUSTRE_USER_H */