Whamcloud - gitweb
LU-3289 gss: Add Shared key and GSS Null functionality
[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, 2015, 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 #include <linux/types.h>
50
51 #ifdef __KERNEL__
52 # include <linux/quota.h>
53 # include <linux/string.h> /* snprintf() */
54 # include <linux/version.h>
55 #else /* !__KERNEL__ */
56 # define NEED_QUOTA_DEFS
57 # include <limits.h>
58 # include <stdbool.h>
59 # include <stdio.h> /* snprintf() */
60 # include <string.h>
61 # include <sys/quota.h>
62 # include <sys/stat.h>
63 #endif /* __KERNEL__ */
64 #include <lustre/ll_fiemap.h>
65
66 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
67     defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
68     defined(__aarch64__)
69 typedef struct stat     lstat_t;
70 # define lstat_f        lstat
71 # define fstat_f        fstat
72 # define fstatat_f      fstatat
73 # define HAVE_LOV_USER_MDS_DATA
74 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
75 typedef struct stat64   lstat_t;
76 # define lstat_f        lstat64
77 # define fstat_f        fstat64
78 # define fstatat_f      fstatat64
79 # define HAVE_LOV_USER_MDS_DATA
80 #endif
81
82 #define LUSTRE_EOF 0xffffffffffffffffULL
83
84 /* for statfs() */
85 #define LL_SUPER_MAGIC 0x0BD00BD0
86
87 #ifndef FSFILT_IOC_GETFLAGS
88 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
89 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
90 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
91 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
92 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
93 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
94 #endif
95
96 /* FIEMAP flags supported by Lustre */
97 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
98
99 enum obd_statfs_state {
100         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
101         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
102         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
103         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
104         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
105 };
106
107 struct obd_statfs {
108         __u64           os_type;
109         __u64           os_blocks;
110         __u64           os_bfree;
111         __u64           os_bavail;
112         __u64           os_files;
113         __u64           os_ffree;
114         __u8            os_fsid[40];
115         __u32           os_bsize;
116         __u32           os_namelen;
117         __u64           os_maxbytes;
118         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
119         __u32           os_fprecreated; /* objs available now to the caller */
120                                         /* used in QoS code to find preferred
121                                          * OSTs */
122         __u32           os_spare2;
123         __u32           os_spare3;
124         __u32           os_spare4;
125         __u32           os_spare5;
126         __u32           os_spare6;
127         __u32           os_spare7;
128         __u32           os_spare8;
129         __u32           os_spare9;
130 };
131
132 /**
133  * File IDentifier.
134  *
135  * FID is a cluster-wide unique identifier of a file or an object (stripe).
136  * FIDs are never reused.
137  **/
138 struct lu_fid {
139        /**
140         * FID sequence. Sequence is a unit of migration: all files (objects)
141         * with FIDs from a given sequence are stored on the same server.
142         * Lustre should support 2^64 objects, so even if each sequence
143         * has only a single object we can still enumerate 2^64 objects.
144         **/
145         __u64 f_seq;
146         /* FID number within sequence. */
147         __u32 f_oid;
148         /**
149          * FID version, used to distinguish different versions (in the sense
150          * of snapshots, etc.) of the same file system object. Not currently
151          * used.
152          **/
153         __u32 f_ver;
154 };
155
156 static inline bool fid_is_zero(const struct lu_fid *fid)
157 {
158         return fid->f_seq == 0 && fid->f_oid == 0;
159 }
160
161 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
162  * MDT-object's FID::f_ver, instead it is the OST-object index in its
163  * parent MDT-object's layout EA. */
164 #define f_stripe_idx f_ver
165
166 struct filter_fid {
167         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
168 };
169
170 /* keep this one for compatibility */
171 struct filter_fid_old {
172         struct lu_fid   ff_parent;
173         __u64           ff_objid;
174         __u64           ff_seq;
175 };
176
177 /* Userspace should treat lu_fid as opaque, and only use the following methods
178  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
179  * here from lustre_idl.h if needed. */
180 typedef struct lu_fid lustre_fid;
181
182 /**
183  * Following struct for object attributes, that will be kept inode's EA.
184  * Introduced in 2.0 release (please see b15993, for details)
185  * Added to all objects since Lustre 2.4 as contains self FID
186  */
187 struct lustre_mdt_attrs {
188         /**
189          * Bitfield for supported data in this structure. From enum lma_compat.
190          * lma_self_fid and lma_flags are always available.
191          */
192         __u32   lma_compat;
193         /**
194          * Per-file incompat feature list. Lustre version should support all
195          * flags set in this field. The supported feature mask is available in
196          * LMA_INCOMPAT_SUPP.
197          */
198         __u32   lma_incompat;
199         /** FID of this inode */
200         struct lu_fid  lma_self_fid;
201 };
202
203 /**
204  * Prior to 2.4, the LMA structure also included SOM attributes which has since
205  * been moved to a dedicated xattr
206  * lma_flags was also removed because of lma_compat/incompat fields.
207  */
208 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
209
210 /**
211  * OST object IDentifier.
212  */
213 struct ost_id {
214         union {
215                 struct {
216                         __u64   oi_id;
217                         __u64   oi_seq;
218                 } oi;
219                 struct lu_fid oi_fid;
220         };
221 };
222
223 #define DOSTID "%#llx:%llu"
224 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
225                    ((unsigned long long)ostid_id(oi))
226
227 struct ll_futimes_3 {
228         __u64 lfu_atime_sec;
229         __u64 lfu_atime_nsec;
230         __u64 lfu_mtime_sec;
231         __u64 lfu_mtime_nsec;
232         __u64 lfu_ctime_sec;
233         __u64 lfu_ctime_nsec;
234 };
235
236 /*
237  * The ioctl naming rules:
238  * LL_*     - works on the currently opened filehandle instead of parent dir
239  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
240  * *_MDC_*  - gets/sets data related to MDC
241  * *_LOV_*  - gets/sets data related to OSC/LOV
242  * *FILE*   - called on parent dir and passes in a filename
243  * *STRIPE* - set/get lov_user_md
244  * *INFO    - set/get lov_user_mds_data
245  */
246 /*      lustre_ioctl.h                  101-150 */
247 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
248 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
249 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
250 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
251 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
252 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
253 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
254 /*      LL_IOC_RECREATE_FID             157 obsolete */
255 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
256 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
257 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
258 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
259 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
260 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
261 /*      IOC_LOV_GETINFO                 165 obsolete */
262 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
263 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
264 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
265 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
266 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
267 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
268 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
269 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
270 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
271 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
272 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
273 /*      lustre_ioctl.h                  177-210 */
274 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
275 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
276 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
277 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
278 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
279 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
280 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
281 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
282 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
283                                                 struct lustre_swap_layouts)
284 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
285                                                 struct hsm_current_action)
286 /*      lustre_ioctl.h                  221-232 */
287 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
288 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
289 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
290 #define LL_IOC_SET_LEASE                _IOWR('f', 243, long)
291 #define LL_IOC_GET_LEASE                _IO('f', 244)
292 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
293 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
294 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
295 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
296 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
297 #define LL_IOC_LADVISE                  _IOR('f', 250, struct lu_ladvise)
298
299 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
300 enum ll_lease_type {
301         LL_LEASE_RDLCK  = 0x1,
302         LL_LEASE_WRLCK  = 0x2,
303         LL_LEASE_UNLCK  = 0x4,
304 };
305
306 #define LL_STATFS_LMV           1
307 #define LL_STATFS_LOV           2
308 #define LL_STATFS_NODELAY       4
309
310 #define IOC_MDC_TYPE            'i'
311 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
312 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
313 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
314 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
315
316 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
317
318 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
319  * files, but are unlikely to be used in practice and are not harmful if
320  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
321  * devices and are safe for use on new files. See LU-4209. */
322 /* To be compatible with old statically linked binary we keep the check for
323  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
324 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
325 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
326 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
327                                          O_LOV_DELAY_CREATE_MASK)
328
329 #define LL_FILE_IGNORE_LOCK     0x00000001
330 #define LL_FILE_GROUP_LOCKED    0x00000002
331 #define LL_FILE_READAHEA        0x00000004
332 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
333 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
334 #define LL_FILE_RMTACL          0x00000020
335
336 #define LOV_USER_MAGIC_V1       0x0BD10BD0
337 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
338 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
339 #define LOV_USER_MAGIC_V3       0x0BD30BD0
340 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
341 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
342
343 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
344
345 #define LOV_PATTERN_RAID0       0x001
346 #define LOV_PATTERN_RAID1       0x002
347 #define LOV_PATTERN_FIRST       0x100
348 #define LOV_PATTERN_CMOBD       0x200
349
350 #define LOV_PATTERN_F_MASK      0xffff0000
351 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
352 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
353
354 #define LOV_MAXPOOLNAME 15
355 #define LOV_POOLNAMEF "%.15s"
356
357 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
358 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
359 #define LOV_MAX_STRIPE_COUNT_OLD 160
360 /* This calculation is crafted so that input of 4096 will result in 160
361  * which in turn is equal to old maximal stripe count.
362  * XXX: In fact this is too simpified for now, what it also need is to get
363  * ea_type argument to clearly know how much space each stripe consumes.
364  *
365  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
366  * allocation that is sufficient for the current generation of systems.
367  *
368  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
369 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
370 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
371 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
372
373 #define XATTR_LUSTRE_PREFIX     "lustre."
374 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
375
376 #define lov_user_ost_data lov_user_ost_data_v1
377 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
378         struct ost_id l_ost_oi;   /* OST object ID */
379         __u32 l_ost_gen;          /* generation of this OST index */
380         __u32 l_ost_idx;          /* OST index in LOV */
381 } __attribute__((packed));
382
383 #define lov_user_md lov_user_md_v1
384 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
385         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
386         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
387         struct ost_id lmm_oi;     /* LOV object ID */
388         __u32 lmm_stripe_size;    /* size of stripe in bytes */
389         __u16 lmm_stripe_count;   /* num stripes in use for this object */
390         union {
391                 __u16 lmm_stripe_offset;  /* starting stripe offset in
392                                            * lmm_objects, use when writing */
393                 __u16 lmm_layout_gen;     /* layout generation number
394                                            * used when reading */
395         };
396         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
397 } __attribute__((packed,  __may_alias__));
398
399 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
400         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
401         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
402         struct ost_id lmm_oi;     /* LOV object ID */
403         __u32 lmm_stripe_size;    /* size of stripe in bytes */
404         __u16 lmm_stripe_count;   /* num stripes in use for this object */
405         union {
406                 __u16 lmm_stripe_offset;  /* starting stripe offset in
407                                            * lmm_objects, use when writing */
408                 __u16 lmm_layout_gen;     /* layout generation number
409                                            * used when reading */
410         };
411         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
412         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
413 } __attribute__((packed));
414
415 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
416 {
417         if (lmm_magic == LOV_USER_MAGIC_V1)
418                 return sizeof(struct lov_user_md_v1) +
419                               stripes * sizeof(struct lov_user_ost_data_v1);
420         return sizeof(struct lov_user_md_v3) +
421                                 stripes * sizeof(struct lov_user_ost_data_v1);
422 }
423
424 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
425  * use this.  It is unsafe to #define those values in this header as it
426  * is possible the application has already #included <sys/stat.h>. */
427 #ifdef HAVE_LOV_USER_MDS_DATA
428 #define lov_user_mds_data lov_user_mds_data_v1
429 struct lov_user_mds_data_v1 {
430         lstat_t lmd_st;                 /* MDS stat struct */
431         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
432 } __attribute__((packed));
433
434 struct lov_user_mds_data_v3 {
435         lstat_t lmd_st;                 /* MDS stat struct */
436         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
437 } __attribute__((packed));
438 #endif
439
440 struct lmv_user_mds_data {
441         struct lu_fid   lum_fid;
442         __u32           lum_padding;
443         __u32           lum_mds;
444 };
445
446 enum lmv_hash_type {
447         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
448         LMV_HASH_TYPE_ALL_CHARS = 1,
449         LMV_HASH_TYPE_FNV_1A_64 = 2,
450 };
451
452 #define LMV_HASH_NAME_ALL_CHARS "all_char"
453 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
454
455 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
456  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
457 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
458 #define lmv_user_md lmv_user_md_v1
459 struct lmv_user_md_v1 {
460         __u32   lum_magic;       /* must be the first field */
461         __u32   lum_stripe_count;  /* dirstripe count */
462         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
463         __u32   lum_hash_type;     /* Dir stripe policy */
464         __u32   lum_type;         /* LMV type: default or normal */
465         __u32   lum_padding1;
466         __u32   lum_padding2;
467         __u32   lum_padding3;
468         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
469         struct  lmv_user_mds_data  lum_objects[0];
470 } __attribute__((packed));
471
472 static inline int lmv_user_md_size(int stripes, int lmm_magic)
473 {
474         return sizeof(struct lmv_user_md) +
475                       stripes * sizeof(struct lmv_user_mds_data);
476 }
477
478 struct ll_recreate_obj {
479         __u64 lrc_id;
480         __u32 lrc_ost_idx;
481 };
482
483 struct ll_fid {
484         __u64 id;         /* holds object id */
485         __u32 generation; /* holds object generation */
486         __u32 f_type;     /* holds object type or stripe idx when passing it to
487                            * OST for saving into EA. */
488 };
489
490 #define UUID_MAX        40
491 struct obd_uuid {
492         char uuid[UUID_MAX];
493 };
494
495 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
496                                    const struct obd_uuid *u2)
497 {
498         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
499 }
500
501 static inline int obd_uuid_empty(struct obd_uuid *uuid)
502 {
503         return uuid->uuid[0] == '\0';
504 }
505
506 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
507 {
508         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
509         uuid->uuid[sizeof(*uuid) - 1] = '\0';
510 }
511
512 /* For printf's only, make sure uuid is terminated */
513 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
514 {
515         if (uuid == NULL)
516                 return NULL;
517
518         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
519                 /* Obviously not safe, but for printfs, no real harm done...
520                    we're always null-terminated, even in a race. */
521                 static char temp[sizeof(*uuid)];
522                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
523                 temp[sizeof(*uuid) - 1] = '\0';
524                 return temp;
525         }
526         return (char *)(uuid->uuid);
527 }
528
529 /* Extract fsname from uuid (or target name) of a target
530    e.g. (myfs-OST0007_UUID -> myfs)
531    see also deuuidify. */
532 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
533 {
534         char *p;
535
536         strncpy(buf, uuid, buflen - 1);
537         buf[buflen - 1] = '\0';
538         p = strrchr(buf, '-');
539         if (p != NULL)
540                 *p = '\0';
541 }
542
543 /* printf display format for Lustre FIDs
544  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
545 #define FID_NOBRACE_LEN 40
546 #define FID_LEN (FID_NOBRACE_LEN + 2)
547 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
548 #define DFID "["DFID_NOBRACE"]"
549 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
550
551 /* scanf input parse format for fids in DFID_NOBRACE format
552  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
553  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
554 #define SFID "0x%llx:0x%x:0x%x"
555 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
556
557 /********* Quotas **********/
558
559 #define LUSTRE_QUOTABLOCK_BITS 10
560 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
561
562 static inline __u64 lustre_stoqb(size_t space)
563 {
564         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
565 }
566
567 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
568 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
569 #define Q_GETOINFO      0x800102 /* get obd quota info */
570 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
571 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
572
573 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
574 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
575 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
576 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
577 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
578 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
579 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
580 /* lustre-specific control commands */
581 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
582 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
583
584 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
585
586 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
587
588 /* permission */
589 #define N_PERMS_MAX      64
590
591 struct perm_downcall_data {
592         __u64 pdd_nid;
593         __u32 pdd_perm;
594         __u32 pdd_padding;
595 };
596
597 struct identity_downcall_data {
598         __u32                            idd_magic;
599         __u32                            idd_err;
600         __u32                            idd_uid;
601         __u32                            idd_gid;
602         __u32                            idd_nperms;
603         __u32                            idd_ngroups;
604         struct perm_downcall_data idd_perms[N_PERMS_MAX];
605         __u32                            idd_groups[0];
606 };
607
608 /* for non-mapped uid/gid */
609 #define NOBODY_UID      99
610 #define NOBODY_GID      99
611
612 #define INVALID_ID      (-1)
613
614 enum {
615         RMT_LSETFACL    = 1,
616         RMT_LGETFACL    = 2,
617         RMT_RSETFACL    = 3,
618         RMT_RGETFACL    = 4
619 };
620
621 #ifdef NEED_QUOTA_DEFS
622 #ifndef QIF_BLIMITS
623 #define QIF_BLIMITS     1
624 #define QIF_SPACE       2
625 #define QIF_ILIMITS     4
626 #define QIF_INODES      8
627 #define QIF_BTIME       16
628 #define QIF_ITIME       32
629 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
630 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
631 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
632 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
633 #endif
634
635 #endif /* !__KERNEL__ */
636
637 /* lustre volatile file support
638  * file name header: .^L^S^T^R:volatile"
639  */
640 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
641 #define LUSTRE_VOLATILE_HDR_LEN 14
642
643 typedef enum lustre_quota_version {
644         LUSTRE_QUOTA_V2 = 1
645 } lustre_quota_version_t;
646
647 /* XXX: same as if_dqinfo struct in kernel */
648 struct obd_dqinfo {
649         __u64 dqi_bgrace;
650         __u64 dqi_igrace;
651         __u32 dqi_flags;
652         __u32 dqi_valid;
653 };
654
655 /* XXX: same as if_dqblk struct in kernel, plus one padding */
656 struct obd_dqblk {
657         __u64 dqb_bhardlimit;
658         __u64 dqb_bsoftlimit;
659         __u64 dqb_curspace;
660         __u64 dqb_ihardlimit;
661         __u64 dqb_isoftlimit;
662         __u64 dqb_curinodes;
663         __u64 dqb_btime;
664         __u64 dqb_itime;
665         __u32 dqb_valid;
666         __u32 dqb_padding;
667 };
668
669 enum {
670         QC_GENERAL      = 0,
671         QC_MDTIDX       = 1,
672         QC_OSTIDX       = 2,
673         QC_UUID         = 3
674 };
675
676 struct if_quotactl {
677         __u32                   qc_cmd;
678         __u32                   qc_type;
679         __u32                   qc_id;
680         __u32                   qc_stat;
681         __u32                   qc_valid;
682         __u32                   qc_idx;
683         struct obd_dqinfo       qc_dqinfo;
684         struct obd_dqblk        qc_dqblk;
685         char                    obd_type[16];
686         struct obd_uuid         obd_uuid;
687 };
688
689 /* swap layout flags */
690 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
691 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
692 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
693 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
694 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
695
696 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
697 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
698 struct lustre_swap_layouts {
699         __u64   sl_flags;
700         __u32   sl_fd;
701         __u32   sl_gid;
702         __u64   sl_dv1;
703         __u64   sl_dv2;
704 };
705
706
707 /********* Changelogs **********/
708 /** Changelog record types */
709 enum changelog_rec_type {
710         CL_MARK     = 0,
711         CL_CREATE   = 1,  /* namespace */
712         CL_MKDIR    = 2,  /* namespace */
713         CL_HARDLINK = 3,  /* namespace */
714         CL_SOFTLINK = 4,  /* namespace */
715         CL_MKNOD    = 5,  /* namespace */
716         CL_UNLINK   = 6,  /* namespace */
717         CL_RMDIR    = 7,  /* namespace */
718         CL_RENAME   = 8,  /* namespace */
719         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
720         CL_OPEN     = 10, /* not currently used */
721         CL_CLOSE    = 11, /* may be written to log only with mtime change */
722         CL_LAYOUT   = 12, /* file layout/striping modified */
723         CL_TRUNC    = 13,
724         CL_SETATTR  = 14,
725         CL_XATTR    = 15,
726         CL_HSM      = 16, /* HSM specific events, see flags */
727         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
728         CL_CTIME    = 18,
729         CL_ATIME    = 19,
730         CL_MIGRATE  = 20,
731         CL_LAST
732 };
733
734 static inline const char *changelog_type2str(int type) {
735         static const char *changelog_str[] = {
736                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
737                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
738                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT"
739         };
740
741         if (type >= 0 && type < CL_LAST)
742                 return changelog_str[type];
743         return NULL;
744 }
745
746 /* per-record flags */
747 #define CLF_FLAGSHIFT   12
748 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
749 #define CLF_VERMASK     (~CLF_FLAGMASK)
750 enum changelog_rec_flags {
751         CLF_VERSION     = 0x1000,
752         CLF_RENAME      = 0x2000,
753         CLF_JOBID       = 0x4000,
754         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
755 };
756
757
758 /* Anything under the flagmask may be per-type (if desired) */
759 /* Flags for unlink */
760 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
761 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
762                                      /* HSM cleaning needed */
763 /* Flags for rename */
764 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
765                                         * of target */
766 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
767                                         * has an archive in backend */
768
769 /* Flags for HSM */
770 /* 12b used (from high weight to low weight):
771  * 2b for flags
772  * 3b for event
773  * 7b for error code
774  */
775 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
776 #define CLF_HSM_ERR_H        6
777 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
778 #define CLF_HSM_EVENT_H      9
779 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
780 #define CLF_HSM_FLAG_H      11
781 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
782 #define CLF_HSM_SPARE_H     15
783 #define CLF_HSM_LAST        15
784
785 /* Remove bits higher than _h, then extract the value
786  * between _h and _l by shifting lower weigth to bit 0. */
787 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
788                                    >> (CLF_HSM_LAST - _h + _l))
789
790 #define CLF_HSM_SUCCESS      0x00
791 #define CLF_HSM_MAXERROR     0x7E
792 #define CLF_HSM_ERROVERFLOW  0x7F
793
794 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
795
796 /* 3 bits field => 8 values allowed */
797 enum hsm_event {
798         HE_ARCHIVE      = 0,
799         HE_RESTORE      = 1,
800         HE_CANCEL       = 2,
801         HE_RELEASE      = 3,
802         HE_REMOVE       = 4,
803         HE_STATE        = 5,
804         HE_SPARE1       = 6,
805         HE_SPARE2       = 7,
806 };
807
808 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
809 {
810         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
811                                             CLF_HSM_EVENT_L);
812 }
813
814 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
815 {
816         *flags |= (he << CLF_HSM_EVENT_L);
817 }
818
819 static inline __u16 hsm_get_cl_flags(int flags)
820 {
821         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
822 }
823
824 static inline void hsm_set_cl_flags(int *flags, int bits)
825 {
826         *flags |= (bits << CLF_HSM_FLAG_L);
827 }
828
829 static inline int hsm_get_cl_error(int flags)
830 {
831         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
832 }
833
834 static inline void hsm_set_cl_error(int *flags, int error)
835 {
836         *flags |= (error << CLF_HSM_ERR_L);
837 }
838
839 enum changelog_send_flag {
840         /* Not yet implemented */
841         CHANGELOG_FLAG_FOLLOW   = 0x01,
842         /* Blocking IO makes sense in case of slow user parsing of the records,
843          * but it also prevents us from cleaning up if the records are not
844          * consumed. */
845         CHANGELOG_FLAG_BLOCK    = 0x02,
846         /* Pack jobid into the changelog records if available. */
847         CHANGELOG_FLAG_JOBID    = 0x04,
848 };
849
850 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
851                                   changelog_rec_offset(CLF_SUPPORTED))
852
853 /* 31 usable bytes string + null terminator. */
854 #define LUSTRE_JOBID_SIZE       32
855
856 /* This is the minimal changelog record. It can contain extensions
857  * such as rename fields or process jobid. Its exact content is described
858  * by the cr_flags.
859  *
860  * Extensions are packed in the same order as their corresponding flags.
861  */
862 struct changelog_rec {
863         __u16                   cr_namelen;
864         __u16                   cr_flags; /**< \a changelog_rec_flags */
865         __u32                   cr_type;  /**< \a changelog_rec_type */
866         __u64                   cr_index; /**< changelog record number */
867         __u64                   cr_prev;  /**< last index for this target fid */
868         __u64                   cr_time;
869         union {
870                 lustre_fid      cr_tfid;        /**< target fid */
871                 __u32           cr_markerflags; /**< CL_MARK flags */
872         };
873         lustre_fid              cr_pfid;        /**< parent fid */
874 };
875
876 /* Changelog extension for RENAME. */
877 struct changelog_ext_rename {
878         lustre_fid              cr_sfid;     /**< source fid, or zero */
879         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
880 };
881
882 /* Changelog extension to include JOBID. */
883 struct changelog_ext_jobid {
884         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
885 };
886
887
888 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
889 {
890         size_t size = sizeof(struct changelog_rec);
891
892         if (crf & CLF_RENAME)
893                 size += sizeof(struct changelog_ext_rename);
894
895         if (crf & CLF_JOBID)
896                 size += sizeof(struct changelog_ext_jobid);
897
898         return size;
899 }
900
901 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
902 {
903         return changelog_rec_offset(rec->cr_flags);
904 }
905
906 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
907 {
908         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
909 }
910
911 static inline
912 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
913 {
914         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
915
916         return (struct changelog_ext_rename *)((char *)rec +
917                                                changelog_rec_offset(crf));
918 }
919
920 /* The jobid follows the rename extension, if present */
921 static inline
922 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
923 {
924         enum changelog_rec_flags crf = rec->cr_flags &
925                                         (CLF_VERSION | CLF_RENAME);
926
927         return (struct changelog_ext_jobid *)((char *)rec +
928                                               changelog_rec_offset(crf));
929 }
930
931 /* The name follows the rename and jobid extensions, if present */
932 static inline char *changelog_rec_name(const struct changelog_rec *rec)
933 {
934         return (char *)rec + changelog_rec_offset(rec->cr_flags &
935                                                   CLF_SUPPORTED);
936 }
937
938 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
939 {
940         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
941 }
942
943 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
944 {
945         char *cr_name = changelog_rec_name(rec);
946
947         return cr_name + strlen(cr_name) + 1;
948 }
949
950 /**
951  * Remap a record to the desired format as specified by the crf flags.
952  * The record must be big enough to contain the final remapped version.
953  * Superfluous extension fields are removed and missing ones are added
954  * and zeroed. The flags of the record are updated accordingly.
955  *
956  * The jobid and rename extensions can be added to a record, to match the
957  * format an application expects, typically. In this case, the newly added
958  * fields will be zeroed.
959  * The Jobid field can be removed, to guarantee compatibility with older
960  * clients that don't expect this field in the records they process.
961  *
962  * The following assumptions are being made:
963  *   - CLF_RENAME will not be removed
964  *   - CLF_JOBID will not be added without CLF_RENAME being added too
965  *
966  * @param[in,out]  rec         The record to remap.
967  * @param[in]      crf_wanted  Flags describing the desired extensions.
968  */
969 static inline void changelog_remap_rec(struct changelog_rec *rec,
970                                        enum changelog_rec_flags crf_wanted)
971 {
972         char *jid_mov;
973         char *rnm_mov;
974
975         crf_wanted &= CLF_SUPPORTED;
976
977         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
978                 return;
979
980         /* First move the variable-length name field */
981         memmove((char *)rec + changelog_rec_offset(crf_wanted),
982                 changelog_rec_name(rec), rec->cr_namelen);
983
984         /* Locations of jobid and rename extensions in the remapped record */
985         jid_mov = (char *)rec +
986                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
987         rnm_mov = (char *)rec +
988                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
989
990         /* Move the extension fields to the desired positions */
991         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
992                 memmove(jid_mov, changelog_rec_jobid(rec),
993                         sizeof(struct changelog_ext_jobid));
994
995         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
996                 memmove(rnm_mov, changelog_rec_rename(rec),
997                         sizeof(struct changelog_ext_rename));
998
999         /* Clear newly added fields */
1000         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1001                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1002
1003         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1004                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1005
1006         /* Update the record's flags accordingly */
1007         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1008 }
1009
1010 struct ioc_changelog {
1011         __u64 icc_recno;
1012         __u32 icc_mdtindex;
1013         __u32 icc_id;
1014         __u32 icc_flags;
1015 };
1016
1017 enum changelog_message_type {
1018         CL_RECORD = 10, /* message is a changelog_rec */
1019         CL_EOF    = 11, /* at end of current changelog */
1020 };
1021
1022 /********* Misc **********/
1023
1024 struct ioc_data_version {
1025         __u64 idv_version;
1026         __u64 idv_flags;     /* See LL_DV_xxx */
1027 };
1028 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1029 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1030
1031 #ifndef offsetof
1032 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1033 #endif
1034
1035 #define dot_lustre_name ".lustre"
1036
1037
1038 /********* HSM **********/
1039
1040 /** HSM per-file state
1041  * See HSM_FLAGS below.
1042  */
1043 enum hsm_states {
1044         HS_NONE         = 0x00000000,
1045         HS_EXISTS       = 0x00000001,
1046         HS_DIRTY        = 0x00000002,
1047         HS_RELEASED     = 0x00000004,
1048         HS_ARCHIVED     = 0x00000008,
1049         HS_NORELEASE    = 0x00000010,
1050         HS_NOARCHIVE    = 0x00000020,
1051         HS_LOST         = 0x00000040,
1052 };
1053
1054 /* HSM user-setable flags. */
1055 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1056
1057 /* Other HSM flags. */
1058 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1059
1060 /*
1061  * All HSM-related possible flags that could be applied to a file.
1062  * This should be kept in sync with hsm_states.
1063  */
1064 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1065
1066 /**
1067  * HSM request progress state
1068  */
1069 enum hsm_progress_states {
1070         HPS_WAITING     = 1,
1071         HPS_RUNNING     = 2,
1072         HPS_DONE        = 3,
1073 };
1074 #define HPS_NONE        0
1075
1076 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1077 {
1078         switch  (s) {
1079         case HPS_WAITING:       return "waiting";
1080         case HPS_RUNNING:       return "running";
1081         case HPS_DONE:          return "done";
1082         default:                return "unknown";
1083         }
1084 }
1085
1086 struct hsm_extent {
1087         __u64 offset;
1088         __u64 length;
1089 } __attribute__((packed));
1090
1091 /**
1092  * Current HSM states of a Lustre file.
1093  *
1094  * This structure purpose is to be sent to user-space mainly. It describes the
1095  * current HSM flags and in-progress action.
1096  */
1097 struct hsm_user_state {
1098         /** Current HSM states, from enum hsm_states. */
1099         __u32                   hus_states;
1100         __u32                   hus_archive_id;
1101         /**  The current undergoing action, if there is one */
1102         __u32                   hus_in_progress_state;
1103         __u32                   hus_in_progress_action;
1104         struct hsm_extent       hus_in_progress_location;
1105         char                    hus_extended_info[];
1106 };
1107
1108 struct hsm_state_set_ioc {
1109         struct lu_fid   hssi_fid;
1110         __u64           hssi_setmask;
1111         __u64           hssi_clearmask;
1112 };
1113
1114 /*
1115  * This structure describes the current in-progress action for a file.
1116  * it is retuned to user space and send over the wire
1117  */
1118 struct hsm_current_action {
1119         /**  The current undergoing action, if there is one */
1120         /* state is one of hsm_progress_states */
1121         __u32                   hca_state;
1122         /* action is one of hsm_user_action */
1123         __u32                   hca_action;
1124         struct hsm_extent       hca_location;
1125 };
1126
1127 /***** HSM user requests ******/
1128 /* User-generated (lfs/ioctl) request types */
1129 enum hsm_user_action {
1130         HUA_NONE    =  1, /* no action (noop) */
1131         HUA_ARCHIVE = 10, /* copy to hsm */
1132         HUA_RESTORE = 11, /* prestage */
1133         HUA_RELEASE = 12, /* drop ost objects */
1134         HUA_REMOVE  = 13, /* remove from archive */
1135         HUA_CANCEL  = 14  /* cancel a request */
1136 };
1137
1138 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1139 {
1140         switch  (a) {
1141         case HUA_NONE:    return "NOOP";
1142         case HUA_ARCHIVE: return "ARCHIVE";
1143         case HUA_RESTORE: return "RESTORE";
1144         case HUA_RELEASE: return "RELEASE";
1145         case HUA_REMOVE:  return "REMOVE";
1146         case HUA_CANCEL:  return "CANCEL";
1147         default:          return "UNKNOWN";
1148         }
1149 }
1150
1151 /*
1152  * List of hr_flags (bit field)
1153  */
1154 #define HSM_FORCE_ACTION 0x0001
1155 /* used by CT, cannot be set by user */
1156 #define HSM_GHOST_COPY   0x0002
1157
1158 /**
1159  * Contains all the fixed part of struct hsm_user_request.
1160  *
1161  */
1162 struct hsm_request {
1163         __u32 hr_action;        /* enum hsm_user_action */
1164         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1165         __u64 hr_flags;         /* request flags */
1166         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1167         __u32 hr_data_len;
1168 };
1169
1170 struct hsm_user_item {
1171        lustre_fid        hui_fid;
1172        struct hsm_extent hui_extent;
1173 } __attribute__((packed));
1174
1175 struct hsm_user_request {
1176         struct hsm_request      hur_request;
1177         struct hsm_user_item    hur_user_item[0];
1178         /* extra data blob at end of struct (after all
1179          * hur_user_items), only use helpers to access it
1180          */
1181 } __attribute__((packed));
1182
1183 /** Return pointer to data field in a hsm user request */
1184 static inline void *hur_data(struct hsm_user_request *hur)
1185 {
1186         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1187 }
1188
1189 /**
1190  * Compute the current length of the provided hsm_user_request.  This returns -1
1191  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1192  *
1193  * return -1 on bounds check error.
1194  */
1195 static inline ssize_t hur_len(struct hsm_user_request *hur)
1196 {
1197         __u64   size;
1198
1199         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1200         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1201                 (__u64)hur->hur_request.hr_itemcount *
1202                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1203
1204         if (size != (ssize_t)size)
1205                 return -1;
1206
1207         return size;
1208 }
1209
1210 /****** HSM RPCs to copytool *****/
1211 /* Message types the copytool may receive */
1212 enum hsm_message_type {
1213         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1214 };
1215
1216 /* Actions the copytool may be instructed to take for a given action_item */
1217 enum hsm_copytool_action {
1218         HSMA_NONE    = 10, /* no action */
1219         HSMA_ARCHIVE = 20, /* arbitrary offset */
1220         HSMA_RESTORE = 21,
1221         HSMA_REMOVE  = 22,
1222         HSMA_CANCEL  = 23
1223 };
1224
1225 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1226 {
1227         switch  (a) {
1228         case HSMA_NONE:    return "NOOP";
1229         case HSMA_ARCHIVE: return "ARCHIVE";
1230         case HSMA_RESTORE: return "RESTORE";
1231         case HSMA_REMOVE:  return "REMOVE";
1232         case HSMA_CANCEL:  return "CANCEL";
1233         default:           return "UNKNOWN";
1234         }
1235 }
1236
1237 /* Copytool item action description */
1238 struct hsm_action_item {
1239         __u32      hai_len;     /* valid size of this struct */
1240         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1241         lustre_fid hai_fid;     /* Lustre FID to operate on */
1242         lustre_fid hai_dfid;    /* fid used for data access */
1243         struct hsm_extent hai_extent;  /* byte range to operate on */
1244         __u64      hai_cookie;  /* action cookie from coordinator */
1245         __u64      hai_gid;     /* grouplock id */
1246         char       hai_data[0]; /* variable length */
1247 } __attribute__((packed));
1248
1249 /*
1250  * helper function which print in hexa the first bytes of
1251  * hai opaque field
1252  * \param hai [IN] record to print
1253  * \param buffer [OUT] output buffer
1254  * \param len [IN] max buffer len
1255  * \retval buffer
1256  */
1257 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1258                                         char *buffer, int len)
1259 {
1260         int i, sz, data_len;
1261         char *ptr;
1262
1263         ptr = buffer;
1264         sz = len;
1265         data_len = hai->hai_len - sizeof(*hai);
1266         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1267         {
1268                 int cnt;
1269
1270                 cnt = snprintf(ptr, sz, "%.2X",
1271                                (unsigned char)hai->hai_data[i]);
1272                 ptr += cnt;
1273                 sz -= cnt;
1274         }
1275         *ptr = '\0';
1276         return buffer;
1277 }
1278
1279 /* Copytool action list */
1280 #define HAL_VERSION 1
1281 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1282 struct hsm_action_list {
1283         __u32 hal_version;
1284         __u32 hal_count;       /* number of hai's to follow */
1285         __u64 hal_compound_id; /* returned by coordinator */
1286         __u64 hal_flags;
1287         __u32 hal_archive_id; /* which archive backend */
1288         __u32 padding1;
1289         char  hal_fsname[0];   /* null-terminated */
1290         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1291            boundaries. See hai_zero */
1292 } __attribute__((packed));
1293
1294 #ifndef HAVE_CFS_SIZE_ROUND
1295 static inline int cfs_size_round (int val)
1296 {
1297         return (val + 7) & (~0x7);
1298 }
1299 #define HAVE_CFS_SIZE_ROUND
1300 #endif
1301
1302 /* Return pointer to first hai in action list */
1303 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1304 {
1305         return (struct hsm_action_item *)(hal->hal_fsname +
1306                                           cfs_size_round(strlen(hal-> \
1307                                                                 hal_fsname)
1308                                                          + 1));
1309 }
1310 /* Return pointer to next hai */
1311 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1312 {
1313         return (struct hsm_action_item *)((char *)hai +
1314                                           cfs_size_round(hai->hai_len));
1315 }
1316
1317 /* Return size of an hsm_action_list */
1318 static inline size_t hal_size(struct hsm_action_list *hal)
1319 {
1320         __u32 i;
1321         size_t sz;
1322         struct hsm_action_item *hai;
1323
1324         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1325         hai = hai_first(hal);
1326         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1327                 sz += cfs_size_round(hai->hai_len);
1328
1329         return sz;
1330 }
1331
1332 /* HSM file import
1333  * describe the attributes to be set on imported file
1334  */
1335 struct hsm_user_import {
1336         __u64           hui_size;
1337         __u64           hui_atime;
1338         __u64           hui_mtime;
1339         __u32           hui_atime_ns;
1340         __u32           hui_mtime_ns;
1341         __u32           hui_uid;
1342         __u32           hui_gid;
1343         __u32           hui_mode;
1344         __u32           hui_archive_id;
1345 };
1346
1347 /* Copytool progress reporting */
1348 #define HP_FLAG_COMPLETED 0x01
1349 #define HP_FLAG_RETRY     0x02
1350
1351 struct hsm_progress {
1352         lustre_fid              hp_fid;
1353         __u64                   hp_cookie;
1354         struct hsm_extent       hp_extent;
1355         __u16                   hp_flags;
1356         __u16                   hp_errval; /* positive val */
1357         __u32                   padding;
1358 };
1359
1360 struct hsm_copy {
1361         __u64                   hc_data_version;
1362         __u16                   hc_flags;
1363         __u16                   hc_errval; /* positive val */
1364         __u32                   padding;
1365         struct hsm_action_item  hc_hai;
1366 };
1367
1368 /* JSON objects */
1369 enum llapi_json_types {
1370         LLAPI_JSON_INTEGER = 1,
1371         LLAPI_JSON_BIGNUM,
1372         LLAPI_JSON_REAL,
1373         LLAPI_JSON_STRING
1374 };
1375
1376 struct llapi_json_item {
1377         char                    *lji_key;
1378         __u32                   lji_type;
1379         union {
1380                 int     lji_integer;
1381                 __u64   lji_u64;
1382                 double  lji_real;
1383                 char    *lji_string;
1384         };
1385         struct llapi_json_item  *lji_next;
1386 };
1387
1388 struct llapi_json_item_list {
1389         int                     ljil_item_count;
1390         struct llapi_json_item  *ljil_items;
1391 };
1392
1393 enum lu_ladvise_type {
1394         LU_LADVISE_INVALID      = 0,
1395 };
1396
1397 #define LU_LADVISE_NAMES {                                              \
1398 }
1399
1400 struct lu_ladvise {
1401         __u64 lla_advice;
1402         __u64 lla_start;
1403         __u64 lla_end;
1404         __u64 lla_padding;
1405 };
1406
1407 enum ladvise_flag {
1408         LF_ASYNC        = 0x00000001,
1409 };
1410
1411 #define LADVISE_MAGIC 0x1ADF1CE0
1412 #define LF_MASK LF_ASYNC
1413
1414 struct ladvise_hdr {
1415         __u32                   lah_magic;      /* LADVISE_MAGIC */
1416         __u32                   lah_count;      /* number of advices */
1417         __u64                   lah_flags;      /* from enum ladvise_flag */
1418         __u64                   lah_padding1;   /* unused */
1419         __u64                   lah_padding2;   /* unused */
1420         struct lu_ladvise       lah_advise[0];
1421 };
1422
1423 #define LAH_COUNT_MAX   (1024)
1424
1425 /* Shared key */
1426 enum sk_crypt_alg {
1427         SK_CRYPT_AES_CTR        = 0,
1428         SK_CRYPT_MAX            = 1,
1429 };
1430
1431 enum sk_hmac_alg {
1432         SK_HMAC_SHA256  = 0,
1433         SK_HMAC_SHA512  = 1,
1434         SK_HMAC_MAX     = 2,
1435 };
1436
1437 struct sk_crypt_type {
1438         char    *sct_name;
1439         size_t   sct_bytes;
1440 };
1441
1442 struct sk_hmac_type {
1443         char    *sht_name;
1444         size_t   sht_bytes;
1445 };
1446
1447 /** @} lustreuser */
1448 #endif /* _LUSTRE_USER_H */