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__ */
53 # define NEED_QUOTA_DEFS
56 # include <stdio.h> /* snprintf() */
58 # include <sys/quota.h>
59 # include <sys/stat.h>
60 #endif /* __KERNEL__ */
61 #include <lustre/ll_fiemap.h>
63 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
64 defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
66 typedef struct stat lstat_t;
67 # define lstat_f lstat
68 # define fstat_f fstat
69 # define fstatat_f fstatat
70 # define HAVE_LOV_USER_MDS_DATA
71 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
72 typedef struct stat64 lstat_t;
73 # define lstat_f lstat64
74 # define fstat_f fstat64
75 # define fstatat_f fstatat64
76 # define HAVE_LOV_USER_MDS_DATA
79 #define LUSTRE_EOF 0xffffffffffffffffULL
82 #define LL_SUPER_MAGIC 0x0BD00BD0
84 #ifndef FSFILT_IOC_GETFLAGS
85 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
86 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
87 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
88 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
89 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
90 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
93 /* FIEMAP flags supported by Lustre */
94 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
96 enum obd_statfs_state {
97 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
98 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
99 OS_STATE_ENOSPC = 0x00000020, /**< not enough free space */
100 OS_STATE_ENOINO = 0x00000040, /**< not enough inodes */
114 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
115 __u32 os_fprecreated; /* objs available now to the caller */
116 /* used in QoS code to find preferred
131 * FID is a cluster-wide unique identifier of a file or an object (stripe).
132 * FIDs are never reused.
136 * FID sequence. Sequence is a unit of migration: all files (objects)
137 * with FIDs from a given sequence are stored on the same server.
138 * Lustre should support 2^64 objects, so even if each sequence
139 * has only a single object we can still enumerate 2^64 objects.
142 /* FID number within sequence. */
145 * FID version, used to distinguish different versions (in the sense
146 * of snapshots, etc.) of the same file system object. Not currently
152 static inline bool fid_is_zero(const struct lu_fid *fid)
154 return fid->f_seq == 0 && fid->f_oid == 0;
157 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
158 * MDT-object's FID::f_ver, instead it is the OST-object index in its
159 * parent MDT-object's layout EA. */
160 #define f_stripe_idx f_ver
163 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
166 /* keep this one for compatibility */
167 struct filter_fid_old {
168 struct lu_fid ff_parent;
173 /* Userspace should treat lu_fid as opaque, and only use the following methods
174 * to print or parse them. Other functions (e.g. compare, swab) could be moved
175 * here from lustre_idl.h if needed. */
176 typedef struct lu_fid lustre_fid;
179 * Following struct for object attributes, that will be kept inode's EA.
180 * Introduced in 2.0 release (please see b15993, for details)
181 * Added to all objects since Lustre 2.4 as contains self FID
183 struct lustre_mdt_attrs {
185 * Bitfield for supported data in this structure. From enum lma_compat.
186 * lma_self_fid and lma_flags are always available.
190 * Per-file incompat feature list. Lustre version should support all
191 * flags set in this field. The supported feature mask is available in
195 /** FID of this inode */
196 struct lu_fid lma_self_fid;
200 * Prior to 2.4, the LMA structure also included SOM attributes which has since
201 * been moved to a dedicated xattr
202 * lma_flags was also removed because of lma_compat/incompat fields.
204 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
207 * OST object IDentifier.
215 struct lu_fid oi_fid;
219 #define DOSTID "%#llx:%llu"
220 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
221 ((unsigned long long)ostid_id(oi))
223 struct ll_futimes_3 {
225 __u64 lfu_atime_nsec;
227 __u64 lfu_mtime_nsec;
229 __u64 lfu_ctime_nsec;
233 * The ioctl naming rules:
234 * LL_* - works on the currently opened filehandle instead of parent dir
235 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
236 * *_MDC_* - gets/sets data related to MDC
237 * *_LOV_* - gets/sets data related to OSC/LOV
238 * *FILE* - called on parent dir and passes in a filename
239 * *STRIPE* - set/get lov_user_md
240 * *INFO - set/get lov_user_mds_data
242 /* lustre_ioctl.h 101-150 */
243 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
244 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
245 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
246 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
247 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
248 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
249 /* LL_IOC_RECREATE_OBJ 157 obsolete */
250 /* LL_IOC_RECREATE_FID 157 obsolete */
251 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
252 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
253 /* LL_IOC_QUOTACHECK 160 OBD_IOC_QUOTACHECK */
254 /* LL_IOC_POLL_QUOTACHECK 161 OBD_IOC_POLL_QUOTACHECK */
255 /* LL_IOC_QUOTACTL 162 OBD_IOC_QUOTACTL */
256 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
257 /* IOC_LOV_GETINFO 165 obsolete */
258 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
259 /* LL_IOC_RMTACL 167 obsolete */
260 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
261 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
262 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
263 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
264 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
265 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
266 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
267 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
268 #define LL_IOC_FUTIMES_3 _IOWR('f', 176, struct ll_futimes_3)
269 /* lustre_ioctl.h 177-210 */
270 #define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state)
271 #define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set)
272 #define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm)
273 #define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *)
274 #define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *)
275 #define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request)
276 #define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request)
277 #define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version)
278 #define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \
279 struct lustre_swap_layouts)
280 #define LL_IOC_HSM_ACTION _IOR('f', 220, \
281 struct hsm_current_action)
282 /* lustre_ioctl.h 221-232 */
283 #define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md)
284 #define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md)
285 #define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64)
286 #define LL_IOC_SET_LEASE _IOWR('f', 243, long)
287 #define LL_IOC_GET_LEASE _IO('f', 244)
288 #define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import)
289 #define LL_IOC_LMV_SET_DEFAULT_STRIPE _IOWR('f', 246, struct lmv_user_md)
290 #define LL_IOC_MIGRATE _IOR('f', 247, int)
291 #define LL_IOC_FID2MDTIDX _IOWR('f', 248, struct lu_fid)
292 #define LL_IOC_GETPARENT _IOWR('f', 249, struct getparent)
293 #define LL_IOC_LADVISE _IOR('f', 250, struct llapi_lu_ladvise)
295 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
297 LL_LEASE_RDLCK = 0x1,
298 LL_LEASE_WRLCK = 0x2,
299 LL_LEASE_UNLCK = 0x4,
302 #define LL_STATFS_LMV 1
303 #define LL_STATFS_LOV 2
304 #define LL_STATFS_NODELAY 4
306 #define IOC_MDC_TYPE 'i'
307 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
308 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
309 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
310 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
312 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
314 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
315 * files, but are unlikely to be used in practice and are not harmful if
316 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character
317 * devices and are safe for use on new files. See LU-4209. */
318 /* To be compatible with old statically linked binary we keep the check for
319 * the older 0100000000 flag. This is already removed upstream. LU-812. */
320 #define O_LOV_DELAY_CREATE_1_8 0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
321 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
322 #define O_LOV_DELAY_CREATE (O_LOV_DELAY_CREATE_1_8 | \
323 O_LOV_DELAY_CREATE_MASK)
325 #define LL_FILE_IGNORE_LOCK 0x00000001
326 #define LL_FILE_GROUP_LOCKED 0x00000002
327 #define LL_FILE_READAHEA 0x00000004
328 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
329 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
331 #define LOV_USER_MAGIC_V1 0x0BD10BD0
332 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
333 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
334 #define LOV_USER_MAGIC_V3 0x0BD30BD0
335 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
336 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0 /* for specific OSTs */
337 #define LOV_USER_MAGIC_COMP_V1 0x0BD60BD0
339 #define LMV_USER_MAGIC 0x0CD30CD0 /*default lmv magic*/
341 #define LOV_PATTERN_RAID0 0x001
342 #define LOV_PATTERN_RAID1 0x002
343 #define LOV_PATTERN_FIRST 0x100
344 #define LOV_PATTERN_CMOBD 0x200
346 #define LOV_PATTERN_F_MASK 0xffff0000
347 #define LOV_PATTERN_F_HOLE 0x40000000 /* there is hole in LOV EA */
348 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
350 static inline bool lov_pattern_supported(__u32 pattern)
352 return pattern == LOV_PATTERN_RAID0 ||
353 pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_F_RELEASED);
356 #define LOV_MAXPOOLNAME 15
357 #define LOV_POOLNAMEF "%.15s"
359 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
360 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
361 #define LOV_MAX_STRIPE_COUNT_OLD 160
362 /* This calculation is crafted so that input of 4096 will result in 160
363 * which in turn is equal to old maximal stripe count.
364 * XXX: In fact this is too simpified for now, what it also need is to get
365 * ea_type argument to clearly know how much space each stripe consumes.
367 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
368 * allocation that is sufficient for the current generation of systems.
370 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
371 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
372 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
373 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
375 #define XATTR_LUSTRE_PREFIX "lustre."
376 #define XATTR_LUSTRE_LOV XATTR_LUSTRE_PREFIX"lov"
378 #define lov_user_ost_data lov_user_ost_data_v1
379 struct lov_user_ost_data_v1 { /* per-stripe data structure */
380 struct ost_id l_ost_oi; /* OST object ID */
381 __u32 l_ost_gen; /* generation of this OST index */
382 __u32 l_ost_idx; /* OST index in LOV */
383 } __attribute__((packed));
385 #define lov_user_md lov_user_md_v1
386 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
387 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
388 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
389 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
390 __u32 lmm_stripe_size; /* size of stripe in bytes */
391 __u16 lmm_stripe_count; /* num stripes in use for this object */
393 __u16 lmm_stripe_offset; /* starting stripe offset in
394 * lmm_objects, use when writing */
395 __u16 lmm_layout_gen; /* layout generation number
396 * used when reading */
398 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
399 } __attribute__((packed, __may_alias__));
401 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
402 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
403 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
404 struct ost_id lmm_oi; /* MDT parent inode id/seq (id/0 for 1.x) */
405 __u32 lmm_stripe_size; /* size of stripe in bytes */
406 __u16 lmm_stripe_count; /* num stripes in use for this object */
408 __u16 lmm_stripe_offset; /* starting stripe offset in
409 * lmm_objects, use when writing */
410 __u16 lmm_layout_gen; /* layout generation number
411 * used when reading */
413 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
414 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
415 } __attribute__((packed));
422 #define DEXT "[ %#llx , %#llx )"
423 #define PEXT(ext) (ext)->e_start, (ext)->e_end
425 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
426 struct lu_extent *e2)
428 return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
431 enum lov_comp_md_entry_flags {
432 LCME_FL_PRIMARY = 0x00000001, /* Not used */
433 LCME_FL_STALE = 0x00000002, /* Not used */
434 LCME_FL_OFFLINE = 0x00000004, /* Not used */
435 LCME_FL_PREFERRED = 0x00000008, /* Not used */
436 LCME_FL_INIT = 0x00000010, /* instantiated */
439 #define LCME_KNOWN_FLAGS LCME_FL_INIT
441 /* lcme_id can be specified as certain flags, and the the first
442 * bit of lcme_id is used to indicate that the ID is representing
443 * certain LCME_FL_* but not a real ID. Which implies we can have
444 * at most 31 flags (see LCME_FL_XXX). */
447 LCME_ID_MAX = 0x7FFFFFFF,
448 LCME_ID_ALL = 0xFFFFFFFF,
449 LCME_ID_NONE = 0x80000000
452 #define LCME_ID_MASK LCME_ID_MAX
454 struct lov_comp_md_entry_v1 {
455 __u32 lcme_id; /* unique id of component */
456 __u32 lcme_flags; /* LCME_FL_XXX */
457 struct lu_extent lcme_extent; /* file extent for component */
458 __u32 lcme_offset; /* offset of component blob,
459 start from lov_comp_md_v1 */
460 __u32 lcme_size; /* size of component blob */
461 __u64 lcme_padding[2];
462 } __attribute__((packed));
464 enum lov_comp_md_flags;
466 struct lov_comp_md_v1 {
467 __u32 lcm_magic; /* LOV_USER_MAGIC_COMP_V1 */
468 __u32 lcm_size; /* overall size including this struct */
469 __u32 lcm_layout_gen;
471 __u16 lcm_entry_count;
474 struct lov_comp_md_entry_v1 lcm_entries[0];
475 } __attribute__((packed));
477 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
479 if (lmm_magic == LOV_USER_MAGIC_V1)
480 return sizeof(struct lov_user_md_v1) +
481 stripes * sizeof(struct lov_user_ost_data_v1);
482 return sizeof(struct lov_user_md_v3) +
483 stripes * sizeof(struct lov_user_ost_data_v1);
486 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
487 * use this. It is unsafe to #define those values in this header as it
488 * is possible the application has already #included <sys/stat.h>. */
489 #ifdef HAVE_LOV_USER_MDS_DATA
490 #define lov_user_mds_data lov_user_mds_data_v1
491 struct lov_user_mds_data_v1 {
492 lstat_t lmd_st; /* MDS stat struct */
493 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
494 } __attribute__((packed));
496 struct lov_user_mds_data_v3 {
497 lstat_t lmd_st; /* MDS stat struct */
498 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
499 } __attribute__((packed));
502 struct lmv_user_mds_data {
503 struct lu_fid lum_fid;
509 LMV_HASH_TYPE_UNKNOWN = 0, /* 0 is reserved for testing purpose */
510 LMV_HASH_TYPE_ALL_CHARS = 1,
511 LMV_HASH_TYPE_FNV_1A_64 = 2,
515 #define LMV_HASH_NAME_ALL_CHARS "all_char"
516 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
518 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
520 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
521 * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
522 #define LMV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
523 #define lmv_user_md lmv_user_md_v1
524 struct lmv_user_md_v1 {
525 __u32 lum_magic; /* must be the first field */
526 __u32 lum_stripe_count; /* dirstripe count */
527 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */
528 __u32 lum_hash_type; /* Dir stripe policy */
529 __u32 lum_type; /* LMV type: default or normal */
533 char lum_pool_name[LOV_MAXPOOLNAME + 1];
534 struct lmv_user_mds_data lum_objects[0];
535 } __attribute__((packed));
537 static inline int lmv_user_md_size(int stripes, int lmm_magic)
539 return sizeof(struct lmv_user_md) +
540 stripes * sizeof(struct lmv_user_mds_data);
543 struct ll_recreate_obj {
549 __u64 id; /* holds object id */
550 __u32 generation; /* holds object generation */
551 __u32 f_type; /* holds object type or stripe idx when passing it to
552 * OST for saving into EA. */
560 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
561 const struct obd_uuid *u2)
563 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
566 static inline int obd_uuid_empty(struct obd_uuid *uuid)
568 return uuid->uuid[0] == '\0';
571 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
573 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
574 uuid->uuid[sizeof(*uuid) - 1] = '\0';
577 /* For printf's only, make sure uuid is terminated */
578 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
583 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
584 /* Obviously not safe, but for printfs, no real harm done...
585 we're always null-terminated, even in a race. */
586 static char temp[sizeof(*uuid)];
587 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
588 temp[sizeof(*uuid) - 1] = '\0';
591 return (char *)(uuid->uuid);
594 /* Extract fsname from uuid (or target name) of a target
595 e.g. (myfs-OST0007_UUID -> myfs)
596 see also deuuidify. */
597 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
601 strncpy(buf, uuid, buflen - 1);
602 buf[buflen - 1] = '\0';
603 p = strrchr(buf, '-');
608 /* printf display format for Lustre FIDs
609 * usage: printf("file FID is "DFID"\n", PFID(fid)); */
610 #define FID_NOBRACE_LEN 40
611 #define FID_LEN (FID_NOBRACE_LEN + 2)
612 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
613 #define DFID "["DFID_NOBRACE"]"
614 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
616 /* scanf input parse format for fids in DFID_NOBRACE format
617 * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
618 * usage: sscanf(fidstr, SFID, RFID(&fid)); */
619 #define SFID "0x%llx:0x%x:0x%x"
620 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
622 /********* Quotas **********/
624 #define LUSTRE_QUOTABLOCK_BITS 10
625 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
627 static inline __u64 lustre_stoqb(size_t space)
629 return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
632 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
633 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
634 #define Q_GETOINFO 0x800102 /* get obd quota info */
635 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
636 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
638 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
639 #define LUSTRE_Q_QUOTAON 0x800002 /* deprecated as of 2.4 */
640 #define LUSTRE_Q_QUOTAOFF 0x800003 /* deprecated as of 2.4 */
641 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
642 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
643 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
644 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
645 /* lustre-specific control commands */
646 #define LUSTRE_Q_INVALIDATE 0x80000b /* deprecated as of 2.4 */
647 #define LUSTRE_Q_FINVALIDATE 0x80000c /* deprecated as of 2.4 */
649 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
651 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
654 #define N_PERMS_MAX 64
656 struct perm_downcall_data {
662 struct identity_downcall_data {
669 struct perm_downcall_data idd_perms[N_PERMS_MAX];
673 #ifdef NEED_QUOTA_DEFS
675 #define QIF_BLIMITS 1
677 #define QIF_ILIMITS 4
681 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
682 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
683 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
684 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
687 #endif /* !__KERNEL__ */
689 /* lustre volatile file support
690 * file name header: .^L^S^T^R:volatile"
692 #define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE"
693 #define LUSTRE_VOLATILE_HDR_LEN 14
695 typedef enum lustre_quota_version {
697 } lustre_quota_version_t;
699 /* XXX: same as if_dqinfo struct in kernel */
707 /* XXX: same as if_dqblk struct in kernel, plus one padding */
709 __u64 dqb_bhardlimit;
710 __u64 dqb_bsoftlimit;
712 __u64 dqb_ihardlimit;
713 __u64 dqb_isoftlimit;
735 struct obd_dqinfo qc_dqinfo;
736 struct obd_dqblk qc_dqblk;
738 struct obd_uuid obd_uuid;
741 /* swap layout flags */
742 #define SWAP_LAYOUTS_CHECK_DV1 (1 << 0)
743 #define SWAP_LAYOUTS_CHECK_DV2 (1 << 1)
744 #define SWAP_LAYOUTS_KEEP_MTIME (1 << 2)
745 #define SWAP_LAYOUTS_KEEP_ATIME (1 << 3)
746 #define SWAP_LAYOUTS_CLOSE (1 << 4)
748 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
749 #define SWAP_LAYOUTS_MDS_HSM (1 << 31)
750 struct lustre_swap_layouts {
759 /********* Changelogs **********/
760 /** Changelog record types */
761 enum changelog_rec_type {
763 CL_CREATE = 1, /* namespace */
764 CL_MKDIR = 2, /* namespace */
765 CL_HARDLINK = 3, /* namespace */
766 CL_SOFTLINK = 4, /* namespace */
767 CL_MKNOD = 5, /* namespace */
768 CL_UNLINK = 6, /* namespace */
769 CL_RMDIR = 7, /* namespace */
770 CL_RENAME = 8, /* namespace */
771 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
772 CL_OPEN = 10, /* not currently used */
773 CL_CLOSE = 11, /* may be written to log only with mtime change */
774 CL_LAYOUT = 12, /* file layout/striping modified */
778 CL_HSM = 16, /* HSM specific events, see flags */
779 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
786 static inline const char *changelog_type2str(int type) {
787 static const char *changelog_str[] = {
788 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
789 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC",
790 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", "MIGRT"
793 if (type >= 0 && type < CL_LAST)
794 return changelog_str[type];
798 /* per-record flags */
799 #define CLF_FLAGSHIFT 12
800 #define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1)
801 #define CLF_VERMASK (~CLF_FLAGMASK)
802 enum changelog_rec_flags {
803 CLF_VERSION = 0x1000,
806 CLF_SUPPORTED = CLF_VERSION | CLF_RENAME | CLF_JOBID
810 /* Anything under the flagmask may be per-type (if desired) */
811 /* Flags for unlink */
812 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
813 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
814 /* HSM cleaning needed */
815 /* Flags for rename */
816 #define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink
818 #define CLF_RENAME_LAST_EXISTS 0x0002 /* rename unlink last hardlink of target
819 * has an archive in backend */
822 /* 12b used (from high weight to low weight):
827 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
828 #define CLF_HSM_ERR_H 6
829 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
830 #define CLF_HSM_EVENT_H 9
831 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
832 #define CLF_HSM_FLAG_H 11
833 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
834 #define CLF_HSM_SPARE_H 15
835 #define CLF_HSM_LAST 15
837 /* Remove bits higher than _h, then extract the value
838 * between _h and _l by shifting lower weigth to bit 0. */
839 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
840 >> (CLF_HSM_LAST - _h + _l))
842 #define CLF_HSM_SUCCESS 0x00
843 #define CLF_HSM_MAXERROR 0x7E
844 #define CLF_HSM_ERROVERFLOW 0x7F
846 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
848 /* 3 bits field => 8 values allowed */
860 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
862 return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
866 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
868 *flags |= (he << CLF_HSM_EVENT_L);
871 static inline __u16 hsm_get_cl_flags(int flags)
873 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
876 static inline void hsm_set_cl_flags(int *flags, int bits)
878 *flags |= (bits << CLF_HSM_FLAG_L);
881 static inline int hsm_get_cl_error(int flags)
883 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
886 static inline void hsm_set_cl_error(int *flags, int error)
888 *flags |= (error << CLF_HSM_ERR_L);
891 enum changelog_send_flag {
892 /* Not yet implemented */
893 CHANGELOG_FLAG_FOLLOW = 0x01,
894 /* Blocking IO makes sense in case of slow user parsing of the records,
895 * but it also prevents us from cleaning up if the records are not
897 CHANGELOG_FLAG_BLOCK = 0x02,
898 /* Pack jobid into the changelog records if available. */
899 CHANGELOG_FLAG_JOBID = 0x04,
902 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
903 changelog_rec_offset(CLF_SUPPORTED))
905 /* 31 usable bytes string + null terminator. */
906 #define LUSTRE_JOBID_SIZE 32
908 /* This is the minimal changelog record. It can contain extensions
909 * such as rename fields or process jobid. Its exact content is described
912 * Extensions are packed in the same order as their corresponding flags.
914 struct changelog_rec {
916 __u16 cr_flags; /**< \a changelog_rec_flags */
917 __u32 cr_type; /**< \a changelog_rec_type */
918 __u64 cr_index; /**< changelog record number */
919 __u64 cr_prev; /**< last index for this target fid */
922 lustre_fid cr_tfid; /**< target fid */
923 __u32 cr_markerflags; /**< CL_MARK flags */
925 lustre_fid cr_pfid; /**< parent fid */
928 /* Changelog extension for RENAME. */
929 struct changelog_ext_rename {
930 lustre_fid cr_sfid; /**< source fid, or zero */
931 lustre_fid cr_spfid; /**< source parent fid, or zero */
934 /* Changelog extension to include JOBID. */
935 struct changelog_ext_jobid {
936 char cr_jobid[LUSTRE_JOBID_SIZE]; /**< zero-terminated string. */
940 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
942 size_t size = sizeof(struct changelog_rec);
944 if (crf & CLF_RENAME)
945 size += sizeof(struct changelog_ext_rename);
948 size += sizeof(struct changelog_ext_jobid);
953 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
955 return changelog_rec_offset(rec->cr_flags);
958 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
960 return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
964 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
966 enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
968 return (struct changelog_ext_rename *)((char *)rec +
969 changelog_rec_offset(crf));
972 /* The jobid follows the rename extension, if present */
974 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
976 enum changelog_rec_flags crf = rec->cr_flags &
977 (CLF_VERSION | CLF_RENAME);
979 return (struct changelog_ext_jobid *)((char *)rec +
980 changelog_rec_offset(crf));
983 /* The name follows the rename and jobid extensions, if present */
984 static inline char *changelog_rec_name(const struct changelog_rec *rec)
986 return (char *)rec + changelog_rec_offset(rec->cr_flags &
990 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
992 return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
995 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
997 char *cr_name = changelog_rec_name(rec);
999 return cr_name + strlen(cr_name) + 1;
1003 * Remap a record to the desired format as specified by the crf flags.
1004 * The record must be big enough to contain the final remapped version.
1005 * Superfluous extension fields are removed and missing ones are added
1006 * and zeroed. The flags of the record are updated accordingly.
1008 * The jobid and rename extensions can be added to a record, to match the
1009 * format an application expects, typically. In this case, the newly added
1010 * fields will be zeroed.
1011 * The Jobid field can be removed, to guarantee compatibility with older
1012 * clients that don't expect this field in the records they process.
1014 * The following assumptions are being made:
1015 * - CLF_RENAME will not be removed
1016 * - CLF_JOBID will not be added without CLF_RENAME being added too
1018 * @param[in,out] rec The record to remap.
1019 * @param[in] crf_wanted Flags describing the desired extensions.
1021 static inline void changelog_remap_rec(struct changelog_rec *rec,
1022 enum changelog_rec_flags crf_wanted)
1027 crf_wanted &= CLF_SUPPORTED;
1029 if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
1032 /* First move the variable-length name field */
1033 memmove((char *)rec + changelog_rec_offset(crf_wanted),
1034 changelog_rec_name(rec), rec->cr_namelen);
1036 /* Locations of jobid and rename extensions in the remapped record */
1037 jid_mov = (char *)rec +
1038 changelog_rec_offset(crf_wanted & ~CLF_JOBID);
1039 rnm_mov = (char *)rec +
1040 changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
1042 /* Move the extension fields to the desired positions */
1043 if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1044 memmove(jid_mov, changelog_rec_jobid(rec),
1045 sizeof(struct changelog_ext_jobid));
1047 if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1048 memmove(rnm_mov, changelog_rec_rename(rec),
1049 sizeof(struct changelog_ext_rename));
1051 /* Clear newly added fields */
1052 if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1053 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1055 if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1056 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1058 /* Update the record's flags accordingly */
1059 rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1062 struct ioc_changelog {
1069 enum changelog_message_type {
1070 CL_RECORD = 10, /* message is a changelog_rec */
1071 CL_EOF = 11, /* at end of current changelog */
1074 /********* Misc **********/
1076 struct ioc_data_version {
1078 __u64 idv_flags; /* See LL_DV_xxx */
1080 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1081 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1084 #define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
1087 #define dot_lustre_name ".lustre"
1090 /********* HSM **********/
1092 /** HSM per-file state
1093 * See HSM_FLAGS below.
1096 HS_NONE = 0x00000000,
1097 HS_EXISTS = 0x00000001,
1098 HS_DIRTY = 0x00000002,
1099 HS_RELEASED = 0x00000004,
1100 HS_ARCHIVED = 0x00000008,
1101 HS_NORELEASE = 0x00000010,
1102 HS_NOARCHIVE = 0x00000020,
1103 HS_LOST = 0x00000040,
1106 /* HSM user-setable flags. */
1107 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1109 /* Other HSM flags. */
1110 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1113 * All HSM-related possible flags that could be applied to a file.
1114 * This should be kept in sync with hsm_states.
1116 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
1119 * HSMÂ request progress state
1121 enum hsm_progress_states {
1128 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1131 case HPS_WAITING: return "waiting";
1132 case HPS_RUNNING: return "running";
1133 case HPS_DONE: return "done";
1134 default: return "unknown";
1141 } __attribute__((packed));
1144 * Current HSM states of a Lustre file.
1146 * This structure purpose is to be sent to user-space mainly. It describes the
1147 * current HSM flags and in-progress action.
1149 struct hsm_user_state {
1150 /** Current HSM states, from enum hsm_states. */
1152 __u32 hus_archive_id;
1153 /** The current undergoing action, if there is one */
1154 __u32 hus_in_progress_state;
1155 __u32 hus_in_progress_action;
1156 struct hsm_extent hus_in_progress_location;
1157 char hus_extended_info[];
1160 struct hsm_state_set_ioc {
1161 struct lu_fid hssi_fid;
1163 __u64 hssi_clearmask;
1167 * This structure describes the current in-progress action for a file.
1168 * it is retuned to user space and send over the wire
1170 struct hsm_current_action {
1171 /** The current undergoing action, if there is one */
1172 /* state is one of hsm_progress_states */
1174 /* action is one of hsm_user_action */
1176 struct hsm_extent hca_location;
1179 /***** HSM user requests ******/
1180 /* User-generated (lfs/ioctl) request types */
1181 enum hsm_user_action {
1182 HUA_NONE = 1, /* no action (noop) */
1183 HUA_ARCHIVE = 10, /* copy to hsm */
1184 HUA_RESTORE = 11, /* prestage */
1185 HUA_RELEASE = 12, /* drop ost objects */
1186 HUA_REMOVE = 13, /* remove from archive */
1187 HUA_CANCEL = 14 /* cancel a request */
1190 static inline const char *hsm_user_action2name(enum hsm_user_action a)
1193 case HUA_NONE: return "NOOP";
1194 case HUA_ARCHIVE: return "ARCHIVE";
1195 case HUA_RESTORE: return "RESTORE";
1196 case HUA_RELEASE: return "RELEASE";
1197 case HUA_REMOVE: return "REMOVE";
1198 case HUA_CANCEL: return "CANCEL";
1199 default: return "UNKNOWN";
1204 * List of hr_flags (bit field)
1206 #define HSM_FORCE_ACTION 0x0001
1207 /* used by CT, cannot be set by user */
1208 #define HSM_GHOST_COPY 0x0002
1211 * Contains all the fixed part of struct hsm_user_request.
1214 struct hsm_request {
1215 __u32 hr_action; /* enum hsm_user_action */
1216 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */
1217 __u64 hr_flags; /* request flags */
1218 __u32 hr_itemcount; /* item count in hur_user_item vector */
1222 struct hsm_user_item {
1224 struct hsm_extent hui_extent;
1225 } __attribute__((packed));
1227 struct hsm_user_request {
1228 struct hsm_request hur_request;
1229 struct hsm_user_item hur_user_item[0];
1230 /* extra data blob at end of struct (after all
1231 * hur_user_items), only use helpers to access it
1233 } __attribute__((packed));
1235 /** Return pointer to data field in a hsm user request */
1236 static inline void *hur_data(struct hsm_user_request *hur)
1238 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1242 * Compute the current length of the provided hsm_user_request. This returns -1
1243 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1245 * return -1 on bounds check error.
1247 static inline ssize_t hur_len(struct hsm_user_request *hur)
1251 /* can't overflow a __u64 since hr_itemcount is only __u32 */
1252 size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1253 (__u64)hur->hur_request.hr_itemcount *
1254 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1256 if (size != (ssize_t)size)
1262 /****** HSM RPCs to copytool *****/
1263 /* Message types the copytool may receive */
1264 enum hsm_message_type {
1265 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1268 /* Actions the copytool may be instructed to take for a given action_item */
1269 enum hsm_copytool_action {
1270 HSMA_NONE = 10, /* no action */
1271 HSMA_ARCHIVE = 20, /* arbitrary offset */
1277 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action a)
1280 case HSMA_NONE: return "NOOP";
1281 case HSMA_ARCHIVE: return "ARCHIVE";
1282 case HSMA_RESTORE: return "RESTORE";
1283 case HSMA_REMOVE: return "REMOVE";
1284 case HSMA_CANCEL: return "CANCEL";
1285 default: return "UNKNOWN";
1289 /* Copytool item action description */
1290 struct hsm_action_item {
1291 __u32 hai_len; /* valid size of this struct */
1292 __u32 hai_action; /* hsm_copytool_action, but use known size */
1293 lustre_fid hai_fid; /* Lustre FID to operate on */
1294 lustre_fid hai_dfid; /* fid used for data access */
1295 struct hsm_extent hai_extent; /* byte range to operate on */
1296 __u64 hai_cookie; /* action cookie from coordinator */
1297 __u64 hai_gid; /* grouplock id */
1298 char hai_data[0]; /* variable length */
1299 } __attribute__((packed));
1302 * helper function which print in hexa the first bytes of
1305 * \param hai [IN] record to print
1306 * \param buffer [IN,OUT] buffer to write the hex string to
1307 * \param len [IN] max buffer length
1311 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1312 char *buffer, size_t len)
1319 data_len = hai->hai_len - sizeof(*hai);
1320 for (i = 0; (i < data_len) && (len > 2); i++) {
1321 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1331 /* Copytool action list */
1332 #define HAL_VERSION 1
1333 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1334 struct hsm_action_list {
1336 __u32 hal_count; /* number of hai's to follow */
1337 __u64 hal_compound_id; /* returned by coordinator */
1339 __u32 hal_archive_id; /* which archive backend */
1341 char hal_fsname[0]; /* null-terminated */
1342 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1343 boundaries. See hai_zero */
1344 } __attribute__((packed));
1346 #ifndef HAVE_CFS_SIZE_ROUND
1347 static inline int cfs_size_round (int val)
1349 return (val + 7) & (~0x7);
1351 #define HAVE_CFS_SIZE_ROUND
1354 /* Return pointer to first hai in action list */
1355 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1357 return (struct hsm_action_item *)(hal->hal_fsname +
1358 cfs_size_round(strlen(hal-> \
1362 /* Return pointer to next hai */
1363 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1365 return (struct hsm_action_item *)((char *)hai +
1366 cfs_size_round(hai->hai_len));
1369 /* Return size of an hsm_action_list */
1370 static inline size_t hal_size(struct hsm_action_list *hal)
1374 struct hsm_action_item *hai;
1376 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1377 hai = hai_first(hal);
1378 for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1379 sz += cfs_size_round(hai->hai_len);
1385 * describe the attributes to be set on imported file
1387 struct hsm_user_import {
1396 __u32 hui_archive_id;
1399 /* Copytool progress reporting */
1400 #define HP_FLAG_COMPLETED 0x01
1401 #define HP_FLAG_RETRY 0x02
1403 struct hsm_progress {
1406 struct hsm_extent hp_extent;
1408 __u16 hp_errval; /* positive val */
1413 __u64 hc_data_version;
1415 __u16 hc_errval; /* positive val */
1417 struct hsm_action_item hc_hai;
1421 enum llapi_json_types {
1422 LLAPI_JSON_INTEGER = 1,
1428 struct llapi_json_item {
1437 struct llapi_json_item *lji_next;
1440 struct llapi_json_item_list {
1441 int ljil_item_count;
1442 struct llapi_json_item *ljil_items;
1445 enum lu_ladvise_type {
1446 LU_LADVISE_INVALID = 0,
1447 LU_LADVISE_WILLREAD = 1,
1448 LU_LADVISE_DONTNEED = 2,
1451 #define LU_LADVISE_NAMES { \
1452 [LU_LADVISE_WILLREAD] = "willread", \
1453 [LU_LADVISE_DONTNEED] = "dontneed", \
1456 /* This is the userspace argument for ladvise. It is currently the same as
1457 * what goes on the wire (struct lu_ladvise), but is defined separately as we
1458 * may need info which is only used locally. */
1459 struct llapi_lu_ladvise {
1460 __u16 lla_advice; /* advice type */
1461 __u16 lla_value1; /* values for different advice types */
1463 __u64 lla_start; /* first byte of extent for advice */
1464 __u64 lla_end; /* last byte of extent for advice */
1470 LF_ASYNC = 0x00000001,
1473 #define LADVISE_MAGIC 0x1ADF1CE0
1474 #define LF_MASK LF_ASYNC
1476 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1477 * is used on the wire. It is defined separately as we may need info which is
1478 * only used locally. */
1479 struct llapi_ladvise_hdr {
1480 __u32 lah_magic; /* LADVISE_MAGIC */
1481 __u32 lah_count; /* number of advices */
1482 __u64 lah_flags; /* from enum ladvise_flag */
1483 __u32 lah_value1; /* unused */
1484 __u32 lah_value2; /* unused */
1485 __u64 lah_value3; /* unused */
1486 struct llapi_lu_ladvise lah_advise[0]; /* advices in this header */
1489 #define LAH_COUNT_MAX (1024)
1493 SK_CRYPT_INVALID = -1,
1495 SK_CRYPT_AES256_CTR = 1,
1499 struct sk_crypt_type {
1501 unsigned int cht_key;
1502 unsigned int cht_bytes;
1505 /** @} lustreuser */
1506 #endif /* _LUSTRE_USER_H */