Whamcloud - gitweb
952c2649a2ac3e3af9485ebf5554892c2724e36d
[fs/lustre-release.git] / lustre / include / lustre / lustre_user.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2010, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre/lustre_user.h
37  *
38  * Lustre public user-space interface definitions.
39  */
40
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
43
44 /** \defgroup lustreuser lustreuser
45  *
46  * @{
47  */
48
49 #ifndef __KERNEL__
50 #include <libcfs/posix/posix-types.h>
51 #endif
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>
59 #else
60 #error Unsupported operating system.
61 #endif
62
63 /* for statfs() */
64 #define LL_SUPER_MAGIC 0x0BD00BD0
65
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)
74 #endif
75
76 /* FIEMAP flags supported by Lustre */
77 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
78
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 */
85 };
86
87 struct obd_statfs {
88         __u64           os_type;
89         __u64           os_blocks;
90         __u64           os_bfree;
91         __u64           os_bavail;
92         __u64           os_files;
93         __u64           os_ffree;
94         __u8            os_fsid[40];
95         __u32           os_bsize;
96         __u32           os_namelen;
97         __u64           os_maxbytes;
98         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
99         __u32           os_fprecreated; /* objs available now to the caller */
100                                         /* used in QoS code to find preferred
101                                          * OSTs */
102         __u32           os_spare2;
103         __u32           os_spare3;
104         __u32           os_spare4;
105         __u32           os_spare5;
106         __u32           os_spare6;
107         __u32           os_spare7;
108         __u32           os_spare8;
109         __u32           os_spare9;
110 };
111
112 /**
113  * File IDentifier.
114  *
115  * FID is a cluster-wide unique identifier of a file or an object (stripe).
116  * FIDs are never reused.
117  **/
118 struct lu_fid {
119        /**
120         * FID sequence. Sequence is a unit of migration: all files (objects)
121         * with FIDs from a given sequence are stored on the same server.
122         * Lustre should support 2^64 objects, so even if each sequence
123         * has only a single object we can still enumerate 2^64 objects.
124         **/
125         __u64 f_seq;
126         /* FID number within sequence. */
127         __u32 f_oid;
128         /**
129          * FID version, used to distinguish different versions (in the sense
130          * of snapshots, etc.) of the same file system object. Not currently
131          * used.
132          **/
133         __u32 f_ver;
134 };
135
136 struct filter_fid {
137         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
138 };
139
140 /* keep this one for compatibility */
141 struct filter_fid_old {
142         struct lu_fid   ff_parent;
143         __u64           ff_objid;
144         __u64           ff_seq;
145 };
146
147 /* Userspace should treat lu_fid as opaque, and only use the following methods
148  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
149  * here from lustre_idl.h if needed. */
150 typedef struct lu_fid lustre_fid;
151
152 /**
153  * Following struct for object attributes, that will be kept inode's EA.
154  * Introduced in 2.0 release (please see b15993, for details)
155  * Added to all objects since Lustre 2.4 as contains self FID
156  */
157 struct lustre_mdt_attrs {
158         /**
159          * Bitfield for supported data in this structure. From enum lma_compat.
160          * lma_self_fid and lma_flags are always available.
161          */
162         __u32   lma_compat;
163         /**
164          * Per-file incompat feature list. Lustre version should support all
165          * flags set in this field. The supported feature mask is available in
166          * LMA_INCOMPAT_SUPP.
167          */
168         __u32   lma_incompat;
169         /** FID of this inode */
170         struct lu_fid  lma_self_fid;
171 };
172
173 /**
174  * Prior to 2.4, the LMA structure also included SOM attributes which has since
175  * been moved to a dedicated xattr
176  * lma_flags was also removed because of lma_compat/incompat fields.
177  */
178 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
179
180 /**
181  * OST object IDentifier.
182  */
183 struct ost_id {
184         union {
185                 struct ostid {
186                         __u64   oi_id;
187                         __u64   oi_seq;
188                 } oi;
189                 struct lu_fid oi_fid;
190         };
191 };
192
193 #define DOSTID LPX64":"LPU64
194 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
195
196 /*
197  * The ioctl naming rules:
198  * LL_*     - works on the currently opened filehandle instead of parent dir
199  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
200  * *_MDC_*  - gets/sets data related to MDC
201  * *_LOV_*  - gets/sets data related to OSC/LOV
202  * *FILE*   - called on parent dir and passes in a filename
203  * *STRIPE* - set/get lov_user_md
204  * *INFO    - set/get lov_user_mds_data
205  */
206 /* see <lustre_lib.h> for ioctl numberss 101-150 */
207 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
208 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
209 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
210 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
211 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
212 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
213 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
214 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
215 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
216 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
217 #define LL_IOC_RECREATE_FID             _IOW ('f', 157, struct lu_fid)
218 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
219 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
220 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
221 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
222 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
223 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
224 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
225 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl)
226 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
227 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
228 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
229 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
230 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
231 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
232 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
233 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
234 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
235 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
236 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
237 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
238
239 /* see <lustre_lib.h> for ioctl numbers 177-210 */
240
241 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
242 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
243 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
244 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
245 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
246 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
247 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
248 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
249 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
250                                                 struct lustre_swap_layouts)
251 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
252                                                 struct hsm_current_action)
253 /* see <lustre_lib.h> for ioctl numbers 221-232 */
254
255 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
256 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
257 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
258
259 #define LL_IOC_SET_LEASE                _IOWR('f', 243, long)
260 #define LL_IOC_GET_LEASE                _IO('f', 244)
261
262 #define LL_STATFS_LMV           1
263 #define LL_STATFS_LOV           2
264 #define LL_STATFS_NODELAY       4
265
266 #define IOC_MDC_TYPE            'i'
267 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
268 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
269 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
270 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
271
272 /* Keep these for backward compartability. */
273 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
274 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
275
276
277 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
278
279 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
280  * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
281  * which was added since kernel 2.6.36, so we redefine it as 020000000.
282  * To be compatible with old version's statically linked binary, finally we
283  * define it as (020000000 | 0100000000).
284  * */
285 #define O_LOV_DELAY_CREATE      0120000000
286
287 #define LL_FILE_IGNORE_LOCK     0x00000001
288 #define LL_FILE_GROUP_LOCKED    0x00000002
289 #define LL_FILE_READAHEA        0x00000004
290 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
291 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
292 #define LL_FILE_RMTACL          0x00000020
293
294 #define LOV_USER_MAGIC_V1 0x0BD10BD0
295 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
296 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
297 #define LOV_USER_MAGIC_V3 0x0BD30BD0
298
299 #define LMV_MAGIC_V1      0x0CD10CD0    /*normal stripe lmv magic */
300 #define LMV_USER_MAGIC    0x0CD20CD0    /*default lmv magic*/
301
302 #define LOV_PATTERN_RAID0 0x001
303 #define LOV_PATTERN_RAID1 0x002
304 #define LOV_PATTERN_FIRST 0x100
305
306 #define LOV_MAXPOOLNAME 16
307 #define LOV_POOLNAMEF "%.16s"
308
309 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
310 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
311 #define LOV_MAX_STRIPE_COUNT_OLD 160
312 /* This calculation is crafted so that input of 4096 will result in 160
313  * which in turn is equal to old maximal stripe count.
314  * XXX: In fact this is too simpified for now, what it also need is to get
315  * ea_type argument to clearly know how much space each stripe consumes.
316  *
317  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
318  * allocation that is sufficient for the current generation of systems.
319  *
320  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
321 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
322 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
323 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
324
325 #define lov_user_ost_data lov_user_ost_data_v1
326 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
327         struct ost_id l_ost_oi;   /* OST object ID */
328         __u32 l_ost_gen;          /* generation of this OST index */
329         __u32 l_ost_idx;          /* OST index in LOV */
330 } __attribute__((packed));
331
332 #define lov_user_md lov_user_md_v1
333 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
334         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
335         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
336         struct ost_id lmm_oi;     /* LOV object ID */
337         __u32 lmm_stripe_size;    /* size of stripe in bytes */
338         __u16 lmm_stripe_count;   /* num stripes in use for this object */
339         union {
340                 __u16 lmm_stripe_offset;  /* starting stripe offset in
341                                            * lmm_objects, use when writing */
342                 __u16 lmm_layout_gen;     /* layout generation number
343                                            * used when reading */
344         };
345         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
346 } __attribute__((packed,  __may_alias__));
347
348 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
349         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
350         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
351         struct ost_id lmm_oi;     /* LOV object ID */
352         __u32 lmm_stripe_size;    /* size of stripe in bytes */
353         __u16 lmm_stripe_count;   /* num stripes in use for this object */
354         union {
355                 __u16 lmm_stripe_offset;  /* starting stripe offset in
356                                            * lmm_objects, use when writing */
357                 __u16 lmm_layout_gen;     /* layout generation number
358                                            * used when reading */
359         };
360         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
361         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
362 } __attribute__((packed));
363
364 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
365 {
366         if (lmm_magic == LOV_USER_MAGIC_V3)
367                 return sizeof(struct lov_user_md_v3) +
368                                 stripes * sizeof(struct lov_user_ost_data_v1);
369         else
370                 return sizeof(struct lov_user_md_v1) +
371                                 stripes * sizeof(struct lov_user_ost_data_v1);
372 }
373
374 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
375  * use this.  It is unsafe to #define those values in this header as it
376  * is possible the application has already #included <sys/stat.h>. */
377 #ifdef HAVE_LOV_USER_MDS_DATA
378 #define lov_user_mds_data lov_user_mds_data_v1
379 struct lov_user_mds_data_v1 {
380         lstat_t lmd_st;                 /* MDS stat struct */
381         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
382 } __attribute__((packed));
383
384 struct lov_user_mds_data_v3 {
385         lstat_t lmd_st;                 /* MDS stat struct */
386         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
387 } __attribute__((packed));
388 #endif
389
390 /* keep this to be the same size as lov_user_ost_data_v1 */
391 struct lmv_user_mds_data {
392         struct lu_fid   lum_fid;
393         __u32           lum_padding;
394         __u32           lum_mds;
395 };
396
397 /* lum_type */
398 enum {
399         LMV_STRIPE_TYPE = 0,
400         LMV_DEFAULT_TYPE = 1,
401 };
402
403 #define lmv_user_md lmv_user_md_v1
404 struct lmv_user_md_v1 {
405         __u32   lum_magic;       /* must be the first field */
406         __u32   lum_stripe_count;  /* dirstripe count */
407         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
408         __u32   lum_hash_type;     /* Dir stripe policy */
409         __u32   lum_type;         /* LMV type: default or normal */
410         __u32   lum_padding1;
411         __u32   lum_padding2;
412         __u32   lum_padding3;
413         char    lum_pool_name[LOV_MAXPOOLNAME];
414         struct  lmv_user_mds_data  lum_objects[0];
415 };
416
417 static inline int lmv_user_md_size(int stripes, int lmm_magic)
418 {
419         return sizeof(struct lmv_user_md) +
420                       stripes * sizeof(struct lmv_user_mds_data);
421 }
422
423 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
424
425 struct ll_recreate_obj {
426         __u64 lrc_id;
427         __u32 lrc_ost_idx;
428 };
429
430 struct ll_fid {
431         __u64 id;         /* holds object id */
432         __u32 generation; /* holds object generation */
433         __u32 f_type;     /* holds object type or stripe idx when passing it to
434                            * OST for saving into EA. */
435 };
436
437 #define UUID_MAX        40
438 struct obd_uuid {
439         char uuid[UUID_MAX];
440 };
441
442 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
443                                    const struct obd_uuid *u2)
444 {
445         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
446 }
447
448 static inline int obd_uuid_empty(struct obd_uuid *uuid)
449 {
450         return uuid->uuid[0] == '\0';
451 }
452
453 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
454 {
455         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
456         uuid->uuid[sizeof(*uuid) - 1] = '\0';
457 }
458
459 /* For printf's only, make sure uuid is terminated */
460 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
461 {
462         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
463                 /* Obviously not safe, but for printfs, no real harm done...
464                    we're always null-terminated, even in a race. */
465                 static char temp[sizeof(*uuid)];
466                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
467                 temp[sizeof(*uuid) - 1] = '\0';
468                 return temp;
469         }
470         return (char *)(uuid->uuid);
471 }
472
473 /* Extract fsname from uuid (or target name) of a target
474    e.g. (myfs-OST0007_UUID -> myfs)
475    see also deuuidify. */
476 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
477 {
478         char *p;
479
480         strncpy(buf, uuid, buflen - 1);
481         buf[buflen - 1] = '\0';
482         p = strrchr(buf, '-');
483         if (p)
484            *p = '\0';
485 }
486
487 /* printf display format
488    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
489 #define FID_NOBRACE_LEN 40
490 #define FID_LEN (FID_NOBRACE_LEN + 2)
491 #define DFID_NOBRACE LPX64":0x%x:0x%x"
492 #define DFID "["DFID_NOBRACE"]"
493 #define PFID(fid)     \
494         (fid)->f_seq, \
495         (fid)->f_oid, \
496         (fid)->f_ver
497
498 /* scanf input parse format -- strip '[' first.
499    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
500 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
501 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
502 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
503 */
504 #define SFID "0x"LPX64i":0x%x:0x%x"
505 #define RFID(fid)     \
506         &((fid)->f_seq), \
507         &((fid)->f_oid), \
508         &((fid)->f_ver)
509
510
511 /********* Quotas **********/
512
513 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
514 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
515 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
516 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
517 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
518 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
519 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
520 /* lustre-specific control commands */
521 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
522 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
523
524 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
525
526 struct if_quotacheck {
527         char                    obd_type[16];
528         struct obd_uuid         obd_uuid;
529 };
530
531 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
532
533 /* permission */
534 #define N_PERMS_MAX      64
535
536 struct perm_downcall_data {
537         __u64 pdd_nid;
538         __u32 pdd_perm;
539         __u32 pdd_padding;
540 };
541
542 struct identity_downcall_data {
543         __u32                            idd_magic;
544         __u32                            idd_err;
545         __u32                            idd_uid;
546         __u32                            idd_gid;
547         __u32                            idd_nperms;
548         __u32                            idd_ngroups;
549         struct perm_downcall_data idd_perms[N_PERMS_MAX];
550         __u32                            idd_groups[0];
551 };
552
553 /* for non-mapped uid/gid */
554 #define NOBODY_UID      99
555 #define NOBODY_GID      99
556
557 #define INVALID_ID      (-1)
558
559 enum {
560         RMT_LSETFACL    = 1,
561         RMT_LGETFACL    = 2,
562         RMT_RSETFACL    = 3,
563         RMT_RGETFACL    = 4
564 };
565
566 #ifdef NEED_QUOTA_DEFS
567 #ifndef QIF_BLIMITS
568 #define QIF_BLIMITS     1
569 #define QIF_SPACE       2
570 #define QIF_ILIMITS     4
571 #define QIF_INODES      8
572 #define QIF_BTIME       16
573 #define QIF_ITIME       32
574 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
575 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
576 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
577 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
578 #endif
579
580 #endif /* !__KERNEL__ */
581
582 /* lustre volatile file support
583  * file name header: .^L^S^T^R:volatile"
584  */
585 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
586 #define LUSTRE_VOLATILE_HDR_LEN 14
587 /* hdr + MDT index */
588 #define LUSTRE_VOLATILE_IDX     LUSTRE_VOLATILE_HDR":%.4X:"
589
590 typedef enum lustre_quota_version {
591         LUSTRE_QUOTA_V2 = 1
592 } lustre_quota_version_t;
593
594 /* XXX: same as if_dqinfo struct in kernel */
595 struct obd_dqinfo {
596         __u64 dqi_bgrace;
597         __u64 dqi_igrace;
598         __u32 dqi_flags;
599         __u32 dqi_valid;
600 };
601
602 /* XXX: same as if_dqblk struct in kernel, plus one padding */
603 struct obd_dqblk {
604         __u64 dqb_bhardlimit;
605         __u64 dqb_bsoftlimit;
606         __u64 dqb_curspace;
607         __u64 dqb_ihardlimit;
608         __u64 dqb_isoftlimit;
609         __u64 dqb_curinodes;
610         __u64 dqb_btime;
611         __u64 dqb_itime;
612         __u32 dqb_valid;
613         __u32 dqb_padding;
614 };
615
616 enum {
617         QC_GENERAL      = 0,
618         QC_MDTIDX       = 1,
619         QC_OSTIDX       = 2,
620         QC_UUID         = 3
621 };
622
623 struct if_quotactl {
624         __u32                   qc_cmd;
625         __u32                   qc_type;
626         __u32                   qc_id;
627         __u32                   qc_stat;
628         __u32                   qc_valid;
629         __u32                   qc_idx;
630         struct obd_dqinfo       qc_dqinfo;
631         struct obd_dqblk        qc_dqblk;
632         char                    obd_type[16];
633         struct obd_uuid         obd_uuid;
634 };
635
636 /* swap layout flags */
637 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
638 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
639 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
640 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
641
642 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
643 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
644 struct lustre_swap_layouts {
645         __u64   sl_flags;
646         __u32   sl_fd;
647         __u32   sl_gid;
648         __u64   sl_dv1;
649         __u64   sl_dv2;
650 };
651
652
653 /********* Changelogs **********/
654 /** Changelog record types */
655 enum changelog_rec_type {
656         CL_MARK     = 0,
657         CL_CREATE   = 1,  /* namespace */
658         CL_MKDIR    = 2,  /* namespace */
659         CL_HARDLINK = 3,  /* namespace */
660         CL_SOFTLINK = 4,  /* namespace */
661         CL_MKNOD    = 5,  /* namespace */
662         CL_UNLINK   = 6,  /* namespace */
663         CL_RMDIR    = 7,  /* namespace */
664         CL_RENAME   = 8,  /* namespace */
665         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
666         CL_OPEN     = 10, /* not currently used */
667         CL_CLOSE    = 11, /* may be written to log only with mtime change */
668         CL_LAYOUT   = 12, /* file layout/striping modified */
669         CL_TRUNC    = 13,
670         CL_SETATTR  = 14,
671         CL_XATTR    = 15,
672         CL_HSM      = 16, /* HSM specific events, see flags */
673         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
674         CL_CTIME    = 18,
675         CL_ATIME    = 19,
676         CL_LAST
677 };
678
679 static inline const char *changelog_type2str(int type) {
680         static const char *changelog_str[] = {
681                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
682                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
683                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME",
684         };
685
686         if (type >= 0 && type < CL_LAST)
687                 return changelog_str[type];
688         return NULL;
689 }
690
691 /* per-record flags */
692 #define CLF_VERSION     0x1000
693 #define CLF_EXT_VERSION 0x2000
694 #define CLF_FLAGSHIFT   12
695 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
696 #define CLF_VERMASK     (~CLF_FLAGMASK)
697 /* Anything under the flagmask may be per-type (if desired) */
698 /* Flags for unlink */
699 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
700 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
701                                      /* HSM cleaning needed */
702 /* Flags for rename */
703 #define CLF_RENAME_LAST       0x0001 /* rename unlink last hardlink of target */
704
705 /* Flags for HSM */
706 /* 12b used (from high weight to low weight):
707  * 2b for flags
708  * 3b for event
709  * 7b for error code
710  */
711 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
712 #define CLF_HSM_ERR_H        6
713 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
714 #define CLF_HSM_EVENT_H      9
715 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
716 #define CLF_HSM_FLAG_H      11
717 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
718 #define CLF_HSM_SPARE_H     15
719 #define CLF_HSM_LAST        15
720
721 /* Remove bits higher than _h, then extract the value
722  * between _h and _l by shifting lower weigth to bit 0. */
723 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
724                                    >> (CLF_HSM_LAST - _h + _l))
725
726 #define CLF_HSM_SUCCESS      0x00
727 #define CLF_HSM_MAXERROR     0x7E
728 #define CLF_HSM_ERROVERFLOW  0x7F
729
730 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
731
732 /* 3 bits field => 8 values allowed */
733 enum hsm_event {
734         HE_ARCHIVE      = 0,
735         HE_RESTORE      = 1,
736         HE_CANCEL       = 2,
737         HE_RELEASE      = 3,
738         HE_REMOVE       = 4,
739         HE_STATE        = 5,
740         HE_SPARE1       = 6,
741         HE_SPARE2       = 7,
742 };
743
744 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
745 {
746         return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
747 }
748
749 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
750 {
751         *flags |= (he << CLF_HSM_EVENT_L);
752 }
753
754 static inline __u16 hsm_get_cl_flags(int flags)
755 {
756         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
757 }
758
759 static inline void hsm_set_cl_flags(int *flags, int bits)
760 {
761         *flags |= (bits << CLF_HSM_FLAG_L);
762 }
763
764 static inline int hsm_get_cl_error(int flags)
765 {
766         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
767 }
768
769 static inline void hsm_set_cl_error(int *flags, int error)
770 {
771         *flags |= (error << CLF_HSM_ERR_L);
772 }
773
774 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
775
776 struct changelog_rec {
777         __u16                 cr_namelen;
778         __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
779         __u32                 cr_type;  /**< \a changelog_rec_type */
780         __u64                 cr_index; /**< changelog record number */
781         __u64                 cr_prev;  /**< last index for this target fid */
782         __u64                 cr_time;
783         union {
784                 lustre_fid    cr_tfid;        /**< target fid */
785                 __u32         cr_markerflags; /**< CL_MARK flags */
786         };
787         lustre_fid            cr_pfid;        /**< parent fid */
788         char                  cr_name[0];     /**< last element */
789 } __attribute__((packed));
790
791 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
792  * space, only rename uses changelog_ext_rec, while others use changelog_rec to
793  * store records.
794  */
795 struct changelog_ext_rec {
796         __u16                   cr_namelen;
797         __u16                   cr_flags; /**< (flags & CLF_FLAGMASK) |
798                                                 CLF_EXT_VERSION */
799         __u32                   cr_type;  /**< \a changelog_rec_type */
800         __u64                   cr_index; /**< changelog record number */
801         __u64                   cr_prev;  /**< last index for this target fid */
802         __u64                   cr_time;
803         union {
804                 lustre_fid      cr_tfid;        /**< target fid */
805                 __u32           cr_markerflags; /**< CL_MARK flags */
806         };
807         lustre_fid              cr_pfid;        /**< target parent fid */
808         lustre_fid              cr_sfid;        /**< source fid, or zero */
809         lustre_fid              cr_spfid;       /**< source parent fid, or zero */
810         char                    cr_name[0];     /**< last element */
811 } __attribute__((packed));
812
813 #define CHANGELOG_REC_EXTENDED(rec) \
814         (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
815
816 static inline int changelog_rec_size(struct changelog_rec *rec)
817 {
818         return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
819                                              sizeof(*rec);
820 }
821
822 static inline char *changelog_rec_name(struct changelog_rec *rec)
823 {
824         return CHANGELOG_REC_EXTENDED(rec) ?
825                 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
826 }
827
828 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
829 {
830         return rec->cr_namelen - strlen(rec->cr_name) - 1;
831 }
832
833 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
834 {
835         return rec->cr_name + strlen(rec->cr_name) + 1;
836 }
837
838 struct ioc_changelog {
839         __u64 icc_recno;
840         __u32 icc_mdtindex;
841         __u32 icc_id;
842         __u32 icc_flags;
843 };
844
845 enum changelog_message_type {
846         CL_RECORD = 10, /* message is a changelog_rec */
847         CL_EOF    = 11, /* at end of current changelog */
848 };
849
850 /********* Misc **********/
851
852 struct ioc_data_version {
853         __u64 idv_version;
854         __u64 idv_flags;     /* See LL_DV_xxx */
855 };
856 #define LL_DV_NOFLUSH 0x01   /* Do not take READ EXTENT LOCK before sampling
857                                 version. Dirty caches are left unchanged. */
858
859 #ifndef offsetof
860 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
861 #endif
862
863 #define dot_lustre_name ".lustre"
864
865
866 /********* HSM **********/
867
868 /** HSM per-file state
869  * See HSM_FLAGS below.
870  */
871 enum hsm_states {
872         HS_EXISTS       = 0x00000001,
873         HS_DIRTY        = 0x00000002,
874         HS_RELEASED     = 0x00000004,
875         HS_ARCHIVED     = 0x00000008,
876         HS_NORELEASE    = 0x00000010,
877         HS_NOARCHIVE    = 0x00000020,
878         HS_LOST         = 0x00000040,
879 };
880
881 /* HSM user-setable flags. */
882 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
883
884 /* Other HSM flags. */
885 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
886
887 /*
888  * All HSM-related possible flags that could be applied to a file.
889  * This should be kept in sync with hsm_states.
890  */
891 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
892
893 /**
894  * HSM request progress state
895  */
896 enum hsm_progress_states {
897         HPS_WAITING     = 1,
898         HPS_RUNNING     = 2,
899         HPS_DONE        = 3,
900 };
901 #define HPS_NONE        0
902
903 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
904 {
905         switch  (s) {
906         case HPS_WAITING:       return "waiting";
907         case HPS_RUNNING:       return "running";
908         case HPS_DONE:          return "done";
909         default:                return "unknown";
910         }
911 }
912
913 struct hsm_extent {
914         __u64 offset;
915         __u64 length;
916 } __attribute__((packed));
917
918 /**
919  * Current HSM states of a Lustre file.
920  *
921  * This structure purpose is to be sent to user-space mainly. It describes the
922  * current HSM flags and in-progress action.
923  */
924 struct hsm_user_state {
925         /** Current HSM states, from enum hsm_states. */
926         __u32                   hus_states;
927         __u32                   hus_archive_id;
928         /**  The current undergoing action, if there is one */
929         __u32                   hus_in_progress_state;
930         __u32                   hus_in_progress_action;
931         struct hsm_extent       hus_in_progress_location;
932         char                    hus_extended_info[];
933 };
934
935 struct hsm_state_set_ioc {
936         struct lu_fid   hssi_fid;
937         __u64           hssi_setmask;
938         __u64           hssi_clearmask;
939 };
940
941 /*
942  * This structure describes the current in-progress action for a file.
943  * it is retuned to user space and send over the wire
944  */
945 struct hsm_current_action {
946         /**  The current undergoing action, if there is one */
947         /* state is one of hsm_progress_states */
948         __u32                   hca_state;
949         /* action is one of hsm_user_action */
950         __u32                   hca_action;
951         struct hsm_extent       hca_location;
952 };
953
954 /***** HSM user requests ******/
955 /* User-generated (lfs/ioctl) request types */
956 enum hsm_user_action {
957         HUA_NONE    =  1, /* no action (noop) */
958         HUA_ARCHIVE = 10, /* copy to hsm */
959         HUA_RESTORE = 11, /* prestage */
960         HUA_RELEASE = 12, /* drop ost objects */
961         HUA_REMOVE  = 13, /* remove from archive */
962         HUA_CANCEL  = 14  /* cancel a request */
963 };
964
965 static inline char *hsm_user_action2name(enum hsm_user_action  a)
966 {
967         switch  (a) {
968         case HUA_NONE:    return "NOOP";
969         case HUA_ARCHIVE: return "ARCHIVE";
970         case HUA_RESTORE: return "RESTORE";
971         case HUA_RELEASE: return "RELEASE";
972         case HUA_REMOVE:  return "REMOVE";
973         case HUA_CANCEL:  return "CANCEL";
974         default:          return "UNKNOWN";
975         }
976 }
977
978 /*
979  * List of hr_flags (bit field)
980  */
981 #define HSM_FORCE_ACTION 0x0001
982 /* used by CT, connot be set by user */
983 #define HSM_GHOST_COPY   0x0002
984
985 /**
986  * Contains all the fixed part of struct hsm_user_request.
987  *
988  */
989 struct hsm_request {
990         __u32 hr_action;        /* enum hsm_user_action */
991         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
992         __u64 hr_flags;         /* request flags */
993         __u32 hr_itemcount;     /* item count in hur_user_item vector */
994         __u32 hr_data_len;
995 };
996
997 struct hsm_user_item {
998        lustre_fid        hui_fid;
999        struct hsm_extent hui_extent;
1000 } __attribute__((packed));
1001
1002 struct hsm_user_request {
1003         struct hsm_request      hur_request;
1004         struct hsm_user_item    hur_user_item[0];
1005         /* extra data blob at end of struct (after all
1006          * hur_user_items), only use helpers to access it
1007          */
1008 } __attribute__((packed));
1009
1010 /** Return pointer to data field in a hsm user request */
1011 static inline void *hur_data(struct hsm_user_request *hur)
1012 {
1013         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1014 }
1015
1016 /** Compute the current length of the provided hsm_user_request. */
1017 static inline int hur_len(struct hsm_user_request *hur)
1018 {
1019         return offsetof(struct hsm_user_request,
1020                         hur_user_item[hur->hur_request.hr_itemcount]) +
1021                 hur->hur_request.hr_data_len;
1022 }
1023
1024 /****** HSM RPCs to copytool *****/
1025 /* Message types the copytool may receive */
1026 enum hsm_message_type {
1027         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1028 };
1029
1030 /* Actions the copytool may be instructed to take for a given action_item */
1031 enum hsm_copytool_action {
1032         HSMA_NONE    = 10, /* no action */
1033         HSMA_ARCHIVE = 20, /* arbitrary offset */
1034         HSMA_RESTORE = 21,
1035         HSMA_REMOVE  = 22,
1036         HSMA_CANCEL  = 23
1037 };
1038
1039 static inline char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1040 {
1041         switch  (a) {
1042         case HSMA_NONE:    return "NOOP";
1043         case HSMA_ARCHIVE: return "ARCHIVE";
1044         case HSMA_RESTORE: return "RESTORE";
1045         case HSMA_REMOVE:  return "REMOVE";
1046         case HSMA_CANCEL:  return "CANCEL";
1047         default:           return "UNKNOWN";
1048         }
1049 }
1050
1051 /* Copytool item action description */
1052 struct hsm_action_item {
1053         __u32      hai_len;     /* valid size of this struct */
1054         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1055         lustre_fid hai_fid;     /* Lustre FID to operated on */
1056         lustre_fid hai_dfid;    /* fid used for data access */
1057         struct hsm_extent hai_extent;  /* byte range to operate on */
1058         __u64      hai_cookie;  /* action cookie from coordinator */
1059         __u64      hai_gid;     /* grouplock id */
1060         char       hai_data[0]; /* variable length */
1061 } __attribute__((packed));
1062
1063 /*
1064  * helper function which print in hexa the first bytes of
1065  * hai opaque field
1066  * \param hai [IN] record to print
1067  * \param buffer [OUT] output buffer
1068  * \param len [IN] max buffer len
1069  * \retval buffer
1070  */
1071 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
1072                                         char *buffer, int len)
1073 {
1074         int i, sz, data_len;
1075         char *ptr;
1076
1077         ptr = buffer;
1078         sz = len;
1079         data_len = hai->hai_len - sizeof(*hai);
1080         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1081         {
1082                 int cnt;
1083
1084                 cnt = snprintf(ptr, sz, "%.2X",
1085                                (unsigned char)hai->hai_data[i]);
1086                 ptr += cnt;
1087                 sz -= cnt;
1088         }
1089         *ptr = '\0';
1090         return buffer;
1091 }
1092
1093 /* Copytool action list */
1094 #define HAL_VERSION 1
1095 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1096 struct hsm_action_list {
1097         __u32 hal_version;
1098         __u32 hal_count;       /* number of hai's to follow */
1099         __u64 hal_compound_id; /* returned by coordinator */
1100         __u64 hal_flags;
1101         __u32 hal_archive_id; /* which archive backend */
1102         __u32 padding1;
1103         char  hal_fsname[0];   /* null-terminated */
1104         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1105            boundaries. See hai_zero */
1106 } __attribute__((packed));
1107
1108 #ifndef HAVE_CFS_SIZE_ROUND
1109 static inline int cfs_size_round (int val)
1110 {
1111         return (val + 7) & (~0x7);
1112 }
1113 #define HAVE_CFS_SIZE_ROUND
1114 #endif
1115
1116 /* Return pointer to first hai in action list */
1117 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
1118 {
1119         return (struct hsm_action_item *)(hal->hal_fsname +
1120                                           cfs_size_round(strlen(hal-> \
1121                                                                 hal_fsname)));
1122 }
1123 /* Return pointer to next hai */
1124 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1125 {
1126         return (struct hsm_action_item *)((char *)hai +
1127                                           cfs_size_round(hai->hai_len));
1128 }
1129
1130 /* Return size of an hsm_action_list */
1131 static inline int hal_size(struct hsm_action_list *hal)
1132 {
1133         int i, sz;
1134         struct hsm_action_item *hai;
1135
1136         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1137         hai = hai_zero(hal);
1138         for (i = 0 ; i < hal->hal_count ; i++, hai = hai_next(hai))
1139                 sz += cfs_size_round(hai->hai_len);
1140
1141         return sz;
1142 }
1143
1144 /* Copytool progress reporting */
1145 #define HP_FLAG_COMPLETED 0x01
1146 #define HP_FLAG_RETRY     0x02
1147
1148 struct hsm_progress {
1149         lustre_fid              hp_fid;
1150         __u64                   hp_cookie;
1151         struct hsm_extent       hp_extent;
1152         __u16                   hp_flags;
1153         __u16                   hp_errval; /* positive val */
1154         __u32                   padding;
1155 };
1156
1157 /**
1158  * Use by copytool during any hsm request they handled.
1159  * This structure is initialized by llapi_hsm_copy_start()
1160  * which is an helper over the ioctl() interface
1161  * Store Lustre, internal use only, data.
1162  */
1163 struct hsm_copy {
1164         __u64                   hc_data_version;
1165         __u16                   hc_flags;
1166         __u16                   hc_errval; /* positive val */
1167         __u32                   padding;
1168         struct hsm_action_item  hc_hai;
1169 };
1170
1171 /** @} lustreuser */
1172
1173 #endif /* _LUSTRE_USER_H */