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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_user.h
38 * Lustre public user-space interface definitions.
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
44 /** \defgroup lustreuser lustreuser
50 #include <libcfs/posix/posix-types.h>
52 #include <lustre/ll_fiemap.h>
53 #if defined(__linux__)
54 #include <linux/lustre_user.h>
55 #elif defined(__APPLE__)
56 #include <darwin/lustre_user.h>
57 #elif defined(__WINNT__)
58 #include <winnt/lustre_user.h>
60 #error Unsupported operating system.
64 #define LL_SUPER_MAGIC 0x0BD00BD0
66 #ifndef FSFILT_IOC_GETFLAGS
67 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
68 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
69 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
70 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
71 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
72 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
73 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
76 /* FIEMAP flags supported by Lustre */
77 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
79 enum obd_statfs_state {
80 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
81 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
82 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
83 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
84 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
98 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
112 * The ioctl naming rules:
113 * LL_* - works on the currently opened filehandle instead of parent dir
114 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
115 * *_MDC_* - gets/sets data related to MDC
116 * *_LOV_* - gets/sets data related to OSC/LOV
117 * *FILE* - called on parent dir and passes in a filename
118 * *STRIPE* - set/get lov_user_md
119 * *INFO - set/get lov_user_mds_data
121 /* see <lustre_lib.h> for ioctl numberss 101-150 */
122 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
123 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
124 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
125 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
126 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
127 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
128 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
129 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
130 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
131 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
132 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
133 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
134 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
135 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
136 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
137 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
138 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
139 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
140 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
141 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
142 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
143 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
144 #define LL_IOC_RMTACL _IOW ('f', 167, long)
145 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
146 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
147 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
148 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid)
149 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
150 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
151 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
152 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
153 #define LL_IOC_HSM_CT_START _IOW ('f', 176,struct lustre_kernelcomm)
154 /* see <lustre_lib.h> for ioctl numbers 177-210 */
156 #define LL_IOC_DATA_VERSION _IOR ('f', 218, struct ioc_data_version)
158 #define LL_STATFS_LMV 1
159 #define LL_STATFS_LOV 2
161 #define IOC_MDC_TYPE 'i'
162 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
163 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
164 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
165 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
167 /* Keep these for backward compartability. */
168 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
169 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
172 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
174 #define O_LOV_DELAY_CREATE 0100000000 /* hopefully this does not conflict */
176 #define LL_FILE_IGNORE_LOCK 0x00000001
177 #define LL_FILE_GROUP_LOCKED 0x00000002
178 #define LL_FILE_READAHEA 0x00000004
179 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
180 #define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */
181 #define LL_FILE_RMTACL 0x00000020
183 #define LOV_USER_MAGIC_V1 0x0BD10BD0
184 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
185 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
186 #define LOV_USER_MAGIC_V3 0x0BD30BD0
188 #define LOV_PATTERN_RAID0 0x001
189 #define LOV_PATTERN_RAID1 0x002
190 #define LOV_PATTERN_FIRST 0x100
192 #define LOV_MAXPOOLNAME 16
193 #define LOV_POOLNAMEF "%.16s"
195 #define lov_user_ost_data lov_user_ost_data_v1
196 struct lov_user_ost_data_v1 { /* per-stripe data structure */
197 __u64 l_object_id; /* OST object ID */
198 __u64 l_object_seq; /* OST object seq number */
199 __u32 l_ost_gen; /* generation of this OST index */
200 __u32 l_ost_idx; /* OST index in LOV */
201 } __attribute__((packed));
203 #define lov_user_md lov_user_md_v1
204 #define lmm_stripe_offset u.lum_stripe_offset
205 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
206 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
207 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
208 __u64 lmm_object_id; /* LOV object ID */
209 __u64 lmm_object_seq; /* LOV object seq */
210 __u32 lmm_stripe_size; /* size of stripe in bytes */
211 __u16 lmm_stripe_count; /* num stripes in use for this object */
213 __u16 lum_stripe_offset; /* starting stripe offset in
214 * lmm_objects, use when writing */
215 __u16 lum_layout_gen; /* layout generation number
216 * used when reading */
218 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
219 } __attribute__((packed, __may_alias__));
221 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
222 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
223 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
224 __u64 lmm_object_id; /* LOV object ID */
225 __u64 lmm_object_seq; /* LOV object seq */
226 __u32 lmm_stripe_size; /* size of stripe in bytes */
227 __u16 lmm_stripe_count; /* num stripes in use for this object */
229 __u16 lum_stripe_offset; /* starting stripe offset in
230 * lmm_objects, use when writing */
231 __u16 lum_layout_gen; /* layout generation number
232 * used when reading */
234 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
235 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
236 } __attribute__((packed));
238 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
239 * use this. It is unsafe to #define those values in this header as it
240 * is possible the application has already #included <sys/stat.h>. */
241 #ifdef HAVE_LOV_USER_MDS_DATA
242 #define lov_user_mds_data lov_user_mds_data_v1
243 struct lov_user_mds_data_v1 {
244 lstat_t lmd_st; /* MDS stat struct */
245 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
246 } __attribute__((packed));
248 struct lov_user_mds_data_v3 {
249 lstat_t lmd_st; /* MDS stat struct */
250 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
251 } __attribute__((packed));
254 struct ll_recreate_obj {
260 __u64 id; /* holds object id */
261 __u32 generation; /* holds object generation */
262 __u32 f_type; /* holds object type or stripe idx when passing it to
263 * OST for saving into EA. */
271 static inline int obd_uuid_equals(const struct obd_uuid *u1,
272 const struct obd_uuid *u2)
274 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
277 static inline int obd_uuid_empty(struct obd_uuid *uuid)
279 return uuid->uuid[0] == '\0';
282 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
284 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
285 uuid->uuid[sizeof(*uuid) - 1] = '\0';
288 /* For printf's only, make sure uuid is terminated */
289 static inline char *obd_uuid2str(struct obd_uuid *uuid)
291 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
292 /* Obviously not safe, but for printfs, no real harm done...
293 we're always null-terminated, even in a race. */
294 static char temp[sizeof(*uuid)];
295 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
296 temp[sizeof(*uuid) - 1] = '\0';
299 return (char *)(uuid->uuid);
302 /* Extract fsname from uuid (or target name) of a target
303 e.g. (myfs-OST0007_UUID -> myfs)
304 see also deuuidify. */
305 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
309 strncpy(buf, uuid, buflen - 1);
310 buf[buflen - 1] = '\0';
311 p = strrchr(buf, '-');
319 * FID is a cluster-wide unique identifier of a file or an object (stripe).
320 * FIDs are never reused.
324 * FID sequence. Sequence is a unit of migration: all files (objects)
325 * with FIDs from a given sequence are stored on the same server.
326 * Lustre should support 2^64 objects, so even if each sequence
327 * has only a single object we can still enumerate 2^64 objects.
330 /** FID number within sequence. */
333 * FID version, used to distinguish different versions (in the sense
334 * of snapshots, etc.) of the same file system object. Not currently
341 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
346 /* Userspace should treat lu_fid as opaque, and only use the following methods
347 to print or parse them. Other functions (e.g. compare, swab) could be moved
348 here from lustre_idl.h if needed. */
349 typedef struct lu_fid lustre_fid;
351 /* printf display format
352 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
353 #define DFID_NOBRACE LPX64":0x%x:0x%x"
354 #define DFID "["DFID_NOBRACE"]"
360 /* scanf input parse format -- strip '[' first.
361 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
362 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
363 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
364 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
366 #define SFID "0x"LPX64i":0x%x:0x%x"
373 /********* Quotas **********/
375 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
376 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
377 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
378 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
379 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
380 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
381 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
382 /* lustre-specific control commands */
383 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
384 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
386 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
388 struct if_quotacheck {
390 struct obd_uuid obd_uuid;
393 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
396 #define N_PERMS_MAX 64
398 struct perm_downcall_data {
404 struct identity_downcall_data {
411 struct perm_downcall_data idd_perms[N_PERMS_MAX];
415 /* for non-mapped uid/gid */
416 #define NOBODY_UID 99
417 #define NOBODY_GID 99
419 #define INVALID_ID (-1)
428 #ifdef NEED_QUOTA_DEFS
430 #define QIF_BLIMITS 1
432 #define QIF_ILIMITS 4
436 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
437 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
438 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
439 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
442 #endif /* !__KERNEL__ */
444 typedef enum lustre_quota_version {
446 } lustre_quota_version_t;
448 /* XXX: same as if_dqinfo struct in kernel */
456 /* XXX: same as if_dqblk struct in kernel, plus one padding */
458 __u64 dqb_bhardlimit;
459 __u64 dqb_bsoftlimit;
461 __u64 dqb_ihardlimit;
462 __u64 dqb_isoftlimit;
484 struct obd_dqinfo qc_dqinfo;
485 struct obd_dqblk qc_dqblk;
487 struct obd_uuid obd_uuid;
491 /********* Changelogs **********/
492 /** Changelog record types */
493 enum changelog_rec_type {
495 CL_CREATE = 1, /* namespace */
496 CL_MKDIR = 2, /* namespace */
497 CL_HARDLINK = 3, /* namespace */
498 CL_SOFTLINK = 4, /* namespace */
499 CL_MKNOD = 5, /* namespace */
500 CL_UNLINK = 6, /* namespace */
501 CL_RMDIR = 7, /* namespace */
502 CL_RENAME = 8, /* namespace */
503 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
504 CL_OPEN = 10, /* not currently used */
505 CL_CLOSE = 11, /* may be written to log only with mtime change */
510 CL_HSM = 16, /* HSM specific events, see flags */
511 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
517 static inline const char *changelog_type2str(int type) {
518 static const char *changelog_str[] = {
519 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
520 "RMDIR", "RNMFM", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
521 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME" };
522 if (type >= 0 && type < CL_LAST)
523 return changelog_str[type];
527 /* per-record flags */
528 #define CLF_VERSION 0x1000
529 #define CLF_FLAGMASK 0x0FFF
530 /* Anything under the flagmask may be per-type (if desired) */
531 /* Flags for unlink */
532 #define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */
533 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
534 /* HSM cleaning needed */
536 /* 12b used (from high weight to low weight):
541 #define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */
542 #define CLF_HSM_ERR_H 6
543 #define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */
544 #define CLF_HSM_EVENT_H 9
545 #define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */
546 #define CLF_HSM_FLAG_H 11
547 #define CLF_HSM_SPARE_L 12 /* 4 spare bits */
548 #define CLF_HSM_SPARE_H 15
549 #define CLF_HSM_LAST 15
551 /* Remove bits higher than _h, then extract the value
552 * between _h and _l by shifting lower weigth to bit 0. */
553 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
554 >> (CLF_HSM_LAST - _h + _l))
556 #define CLF_HSM_SUCCESS 0x00
557 #define CLF_HSM_MAXERROR 0x7E
558 #define CLF_HSM_ERROVERFLOW 0x7F
560 #define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */
562 /* 3 bits field => 8 values allowed */
574 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
576 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
579 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
581 *flags |= (he << CLF_HSM_EVENT_L);
584 static inline __u16 hsm_get_cl_flags(int flags)
586 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
589 static inline void hsm_set_cl_flags(int *flags, int bits)
591 *flags |= (bits << CLF_HSM_FLAG_L);
594 static inline int hsm_get_cl_error(int flags)
596 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
599 static inline void hsm_set_cl_error(int *flags, int error)
601 *flags |= (error << CLF_HSM_ERR_L);
604 #define CR_MAXSIZE (PATH_MAX + sizeof(struct changelog_rec))
605 struct changelog_rec {
607 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
608 __u32 cr_type; /**< \a changelog_rec_type */
609 __u64 cr_index; /**< changelog record number */
610 __u64 cr_prev; /**< last index for this target fid */
613 lustre_fid cr_tfid; /**< target fid */
614 __u32 cr_markerflags; /**< CL_MARK flags */
616 lustre_fid cr_pfid; /**< parent fid */
617 char cr_name[0]; /**< last element */
618 } __attribute__((packed));
620 struct ioc_changelog {
627 enum changelog_message_type {
628 CL_RECORD = 10, /* message is a changelog_rec */
629 CL_EOF = 11, /* at end of current changelog */
632 /********* Misc **********/
634 struct ioc_data_version {
636 __u64 idv_flags; /* See LL_DV_xxx */
638 #define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling
639 version. Dirty caches are left unchanged. */
642 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
645 #define dot_lustre_name ".lustre"
648 /********* HSM **********/
650 /** HSM per-file state
651 * See HSM_FLAGS below.
654 HS_EXISTS = 0x00000001,
655 HS_DIRTY = 0x00000002,
656 HS_RELEASED = 0x00000004,
657 HS_ARCHIVED = 0x00000008,
658 HS_NORELEASE = 0x00000010,
659 HS_NOARCHIVE = 0x00000020,
660 HS_LOST = 0x00000040,
663 /* HSM user-setable flags. */
664 #define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
666 /* Other HSM flags. */
667 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
670 * All HSM-related possible flags that could be applied to a file.
671 * This should be kept in sync with hsm_states.
673 #define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK)
676 * HSMÂ request progress state
678 enum hsm_progress_states {
685 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
688 case HPS_WAITING: return "waiting";
689 case HPS_RUNNING: return "running";
690 case HPS_DONE: return "done";
691 default: return "unknown";
698 } __attribute__((packed));
701 * Current HSM states of a Lustre file.
703 * This structure purpose is to be sent to user-space mainly. It describes the
704 * current HSM flags and in-progress action.
706 struct hsm_user_state {
707 /** Current HSM states, from enum hsm_states. */
709 __u32 hus_archive_num;
710 /** The current undergoing action, if there is one */
711 __u32 hus_in_progress_state;
712 __u32 hus_in_progress_action;
713 struct hsm_extent hus_in_progress_location;
714 char hus_extended_info[];
717 struct hsm_state_set_ioc {
718 struct lu_fid hssi_fid;
720 __u64 hssi_clearmask;
723 /***** HSM user requests ******/
724 /* User-generated (lfs/ioctl) request types */
725 enum hsm_user_action {
726 HUA_NONE = 1, /* no action (noop) */
727 HUA_ARCHIVE = 10, /* copy to hsm */
728 HUA_RESTORE = 11, /* prestage */
729 HUA_RELEASE = 12, /* drop ost objects */
730 HUA_REMOVE = 13, /* remove from archive */
731 HUA_CANCEL = 14 /* cancel a request */
734 static inline char *hsm_user_action2name(enum hsm_user_action a)
737 case HUA_NONE: return "NOOP";
738 case HUA_ARCHIVE: return "ARCHIVE";
739 case HUA_RESTORE: return "RESTORE";
740 case HUA_RELEASE: return "RELEASE";
741 case HUA_REMOVE: return "REMOVE";
742 case HUA_CANCEL: return "CANCEL";
743 default: return "UNKNOWN";
747 struct hsm_user_item {
749 struct hsm_extent hui_extent;
750 } __attribute__((packed));
752 struct hsm_user_request {
753 __u32 hur_action; /* enum hsm_user_action */
754 __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
757 struct hsm_user_item hur_user_item[0];
758 /* extra data blob at end of struct (after all
759 * hur_user_items), only use helpers to access it
761 } __attribute__((packed));
763 /** Return pointer to data field in a hsm user request */
764 static inline void *hur_data(struct hsm_user_request *hur)
766 return &(hur->hur_user_item[hur->hur_itemcount]);
769 /** Compute the current length of the provided hsm_user_request. */
770 static inline int hur_len(struct hsm_user_request *hur)
774 data_offset = hur_data(hur) - (void *)hur;
775 return (data_offset + hur->hur_data_len);
778 /****** HSM RPCs to copytool *****/
779 /* Message types the copytool may receive */
780 enum hsm_message_type {
781 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
784 /* Actions the copytool may be instructed to take for a given action_item */
785 enum hsm_copytool_action {
786 HSMA_NONE = 10, /* no action */
787 HSMA_ARCHIVE = 20, /* arbitrary offset */
793 static inline char *hsm_copytool_action2name(enum hsm_copytool_action a)
796 case HSMA_NONE: return "NOOP";
797 case HSMA_ARCHIVE: return "ARCHIVE";
798 case HSMA_RESTORE: return "RESTORE";
799 case HSMA_REMOVE: return "REMOVE";
800 case HSMA_CANCEL: return "CANCEL";
801 default: return "UNKNOWN";
805 /* Copytool item action description */
806 struct hsm_action_item {
807 __u32 hai_len; /* valid size of this struct */
808 __u32 hai_action; /* hsm_copytool_action, but use known size */
809 lustre_fid hai_fid; /* Lustre FID to operated on */
810 struct hsm_extent hai_extent; /* byte range to operate on */
811 __u64 hai_cookie; /* action cookie from coordinator */
812 __u64 hai_gid; /* grouplock id */
813 char hai_data[0]; /* variable length */
814 } __attribute__((packed));
817 * helper function which print in hexa the first bytes of
819 * \param hai [IN] record to print
820 * \param buffer [OUT] output buffer
821 * \param len [IN] max buffer len
824 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
825 char *buffer, int len)
832 data_len = hai->hai_len - sizeof(*hai);
833 for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
837 cnt = snprintf(ptr, sz, "%.2X",
838 (unsigned char)hai->hai_data[i]);
846 /* Copytool action list */
847 #define HAL_VERSION 1
848 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
849 struct hsm_action_list {
851 __u32 hal_count; /* number of hai's to follow */
852 __u64 hal_compound_id; /* returned by coordinator */
853 __u32 hal_archive_num; /* which archive backend */
855 char hal_fsname[0]; /* null-terminated */
856 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
857 boundaries. See hai_zero */
858 } __attribute__((packed));
860 #ifndef HAVE_CFS_SIZE_ROUND
861 static inline int cfs_size_round (int val)
863 return (val + 7) & (~0x7);
865 #define HAVE_CFS_SIZE_ROUND
868 /* Return pointer to first hai in action list */
869 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
871 return (struct hsm_action_item *)(hal->hal_fsname +
872 cfs_size_round(strlen(hal-> \
875 /* Return pointer to next hai */
876 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
878 return (struct hsm_action_item *)((char *)hai +
879 cfs_size_round(hai->hai_len));
882 /* Return size of an hsm_action_list */
883 static inline int hal_size(struct hsm_action_list *hal)
886 struct hsm_action_item *hai;
888 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
890 for (i = 0 ; i < hal->hal_count ; i++) {
891 sz += cfs_size_round(hai->hai_len);
897 /* Copytool progress reporting */
898 #define HP_FLAG_COMPLETED 0x01
899 #define HP_FLAG_RETRY 0x02
901 struct hsm_progress {
904 struct hsm_extent hp_extent;
906 __u16 hp_errval; /* positive val */
907 } __attribute__((packed));
911 #endif /* _LUSTRE_USER_H */