Whamcloud - gitweb
80dbc0bbf0667d26671d9e6d090887b7302a712d
[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 /*      LL_IOC_RMTACL                   167 obsolete */
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
335 #define LOV_USER_MAGIC_V1       0x0BD10BD0
336 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
337 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
338 #define LOV_USER_MAGIC_V3       0x0BD30BD0
339 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
340 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
341
342 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
343
344 #define LOV_PATTERN_RAID0       0x001
345 #define LOV_PATTERN_RAID1       0x002
346 #define LOV_PATTERN_FIRST       0x100
347 #define LOV_PATTERN_CMOBD       0x200
348
349 #define LOV_PATTERN_F_MASK      0xffff0000
350 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
351 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
352
353 #define LOV_MAXPOOLNAME 15
354 #define LOV_POOLNAMEF "%.15s"
355
356 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
357 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
358 #define LOV_MAX_STRIPE_COUNT_OLD 160
359 /* This calculation is crafted so that input of 4096 will result in 160
360  * which in turn is equal to old maximal stripe count.
361  * XXX: In fact this is too simpified for now, what it also need is to get
362  * ea_type argument to clearly know how much space each stripe consumes.
363  *
364  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
365  * allocation that is sufficient for the current generation of systems.
366  *
367  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
368 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
369 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
370 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
371
372 #define XATTR_LUSTRE_PREFIX     "lustre."
373 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
374
375 #define lov_user_ost_data lov_user_ost_data_v1
376 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
377         struct ost_id l_ost_oi;   /* OST object ID */
378         __u32 l_ost_gen;          /* generation of this OST index */
379         __u32 l_ost_idx;          /* OST index in LOV */
380 } __attribute__((packed));
381
382 #define lov_user_md lov_user_md_v1
383 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
384         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
385         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
386         struct ost_id lmm_oi;     /* LOV object ID */
387         __u32 lmm_stripe_size;    /* size of stripe in bytes */
388         __u16 lmm_stripe_count;   /* num stripes in use for this object */
389         union {
390                 __u16 lmm_stripe_offset;  /* starting stripe offset in
391                                            * lmm_objects, use when writing */
392                 __u16 lmm_layout_gen;     /* layout generation number
393                                            * used when reading */
394         };
395         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
396 } __attribute__((packed,  __may_alias__));
397
398 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
399         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
400         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
401         struct ost_id lmm_oi;     /* LOV object ID */
402         __u32 lmm_stripe_size;    /* size of stripe in bytes */
403         __u16 lmm_stripe_count;   /* num stripes in use for this object */
404         union {
405                 __u16 lmm_stripe_offset;  /* starting stripe offset in
406                                            * lmm_objects, use when writing */
407                 __u16 lmm_layout_gen;     /* layout generation number
408                                            * used when reading */
409         };
410         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
411         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
412 } __attribute__((packed));
413
414 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
415 {
416         if (lmm_magic == LOV_USER_MAGIC_V1)
417                 return sizeof(struct lov_user_md_v1) +
418                               stripes * sizeof(struct lov_user_ost_data_v1);
419         return sizeof(struct lov_user_md_v3) +
420                                 stripes * sizeof(struct lov_user_ost_data_v1);
421 }
422
423 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
424  * use this.  It is unsafe to #define those values in this header as it
425  * is possible the application has already #included <sys/stat.h>. */
426 #ifdef HAVE_LOV_USER_MDS_DATA
427 #define lov_user_mds_data lov_user_mds_data_v1
428 struct lov_user_mds_data_v1 {
429         lstat_t lmd_st;                 /* MDS stat struct */
430         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
431 } __attribute__((packed));
432
433 struct lov_user_mds_data_v3 {
434         lstat_t lmd_st;                 /* MDS stat struct */
435         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
436 } __attribute__((packed));
437 #endif
438
439 struct lmv_user_mds_data {
440         struct lu_fid   lum_fid;
441         __u32           lum_padding;
442         __u32           lum_mds;
443 };
444
445 enum lmv_hash_type {
446         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
447         LMV_HASH_TYPE_ALL_CHARS = 1,
448         LMV_HASH_TYPE_FNV_1A_64 = 2,
449 };
450
451 #define LMV_HASH_NAME_ALL_CHARS "all_char"
452 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
453
454 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
455  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
456 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
457 #define lmv_user_md lmv_user_md_v1
458 struct lmv_user_md_v1 {
459         __u32   lum_magic;       /* must be the first field */
460         __u32   lum_stripe_count;  /* dirstripe count */
461         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
462         __u32   lum_hash_type;     /* Dir stripe policy */
463         __u32   lum_type;         /* LMV type: default or normal */
464         __u32   lum_padding1;
465         __u32   lum_padding2;
466         __u32   lum_padding3;
467         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
468         struct  lmv_user_mds_data  lum_objects[0];
469 } __attribute__((packed));
470
471 static inline int lmv_user_md_size(int stripes, int lmm_magic)
472 {
473         return sizeof(struct lmv_user_md) +
474                       stripes * sizeof(struct lmv_user_mds_data);
475 }
476
477 struct ll_recreate_obj {
478         __u64 lrc_id;
479         __u32 lrc_ost_idx;
480 };
481
482 struct ll_fid {
483         __u64 id;         /* holds object id */
484         __u32 generation; /* holds object generation */
485         __u32 f_type;     /* holds object type or stripe idx when passing it to
486                            * OST for saving into EA. */
487 };
488
489 #define UUID_MAX        40
490 struct obd_uuid {
491         char uuid[UUID_MAX];
492 };
493
494 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
495                                    const struct obd_uuid *u2)
496 {
497         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
498 }
499
500 static inline int obd_uuid_empty(struct obd_uuid *uuid)
501 {
502         return uuid->uuid[0] == '\0';
503 }
504
505 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
506 {
507         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
508         uuid->uuid[sizeof(*uuid) - 1] = '\0';
509 }
510
511 /* For printf's only, make sure uuid is terminated */
512 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
513 {
514         if (uuid == NULL)
515                 return NULL;
516
517         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
518                 /* Obviously not safe, but for printfs, no real harm done...
519                    we're always null-terminated, even in a race. */
520                 static char temp[sizeof(*uuid)];
521                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
522                 temp[sizeof(*uuid) - 1] = '\0';
523                 return temp;
524         }
525         return (char *)(uuid->uuid);
526 }
527
528 /* Extract fsname from uuid (or target name) of a target
529    e.g. (myfs-OST0007_UUID -> myfs)
530    see also deuuidify. */
531 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
532 {
533         char *p;
534
535         strncpy(buf, uuid, buflen - 1);
536         buf[buflen - 1] = '\0';
537         p = strrchr(buf, '-');
538         if (p != NULL)
539                 *p = '\0';
540 }
541
542 /* printf display format for Lustre FIDs
543  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
544 #define FID_NOBRACE_LEN 40
545 #define FID_LEN (FID_NOBRACE_LEN + 2)
546 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
547 #define DFID "["DFID_NOBRACE"]"
548 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
549
550 /* scanf input parse format for fids in DFID_NOBRACE format
551  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
552  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
553 #define SFID "0x%llx:0x%x:0x%x"
554 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
555
556 /********* Quotas **********/
557
558 #define LUSTRE_QUOTABLOCK_BITS 10
559 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
560
561 static inline __u64 lustre_stoqb(size_t space)
562 {
563         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
564 }
565
566 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
567 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
568 #define Q_GETOINFO      0x800102 /* get obd quota info */
569 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
570 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
571
572 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
573 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
574 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
575 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
576 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
577 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
578 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
579 /* lustre-specific control commands */
580 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
581 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
582
583 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
584
585 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
586
587 /* permission */
588 #define N_PERMS_MAX      64
589
590 struct perm_downcall_data {
591         __u64 pdd_nid;
592         __u32 pdd_perm;
593         __u32 pdd_padding;
594 };
595
596 struct identity_downcall_data {
597         __u32                            idd_magic;
598         __u32                            idd_err;
599         __u32                            idd_uid;
600         __u32                            idd_gid;
601         __u32                            idd_nperms;
602         __u32                            idd_ngroups;
603         struct perm_downcall_data idd_perms[N_PERMS_MAX];
604         __u32                            idd_groups[0];
605 };
606
607 #ifdef NEED_QUOTA_DEFS
608 #ifndef QIF_BLIMITS
609 #define QIF_BLIMITS     1
610 #define QIF_SPACE       2
611 #define QIF_ILIMITS     4
612 #define QIF_INODES      8
613 #define QIF_BTIME       16
614 #define QIF_ITIME       32
615 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
616 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
617 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
618 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
619 #endif
620
621 #endif /* !__KERNEL__ */
622
623 /* lustre volatile file support
624  * file name header: .^L^S^T^R:volatile"
625  */
626 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
627 #define LUSTRE_VOLATILE_HDR_LEN 14
628
629 typedef enum lustre_quota_version {
630         LUSTRE_QUOTA_V2 = 1
631 } lustre_quota_version_t;
632
633 /* XXX: same as if_dqinfo struct in kernel */
634 struct obd_dqinfo {
635         __u64 dqi_bgrace;
636         __u64 dqi_igrace;
637         __u32 dqi_flags;
638         __u32 dqi_valid;
639 };
640
641 /* XXX: same as if_dqblk struct in kernel, plus one padding */
642 struct obd_dqblk {
643         __u64 dqb_bhardlimit;
644         __u64 dqb_bsoftlimit;
645         __u64 dqb_curspace;
646         __u64 dqb_ihardlimit;
647         __u64 dqb_isoftlimit;
648         __u64 dqb_curinodes;
649         __u64 dqb_btime;
650         __u64 dqb_itime;
651         __u32 dqb_valid;
652         __u32 dqb_padding;
653 };
654
655 enum {
656         QC_GENERAL      = 0,
657         QC_MDTIDX       = 1,
658         QC_OSTIDX       = 2,
659         QC_UUID         = 3
660 };
661
662 struct if_quotactl {
663         __u32                   qc_cmd;
664         __u32                   qc_type;
665         __u32                   qc_id;
666         __u32                   qc_stat;
667         __u32                   qc_valid;
668         __u32                   qc_idx;
669         struct obd_dqinfo       qc_dqinfo;
670         struct obd_dqblk        qc_dqblk;
671         char                    obd_type[16];
672         struct obd_uuid         obd_uuid;
673 };
674
675 /* swap layout flags */
676 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
677 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
678 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
679 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
680 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
681
682 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
683 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
684 struct lustre_swap_layouts {
685         __u64   sl_flags;
686         __u32   sl_fd;
687         __u32   sl_gid;
688         __u64   sl_dv1;
689         __u64   sl_dv2;
690 };
691
692
693 /********* Changelogs **********/
694 /** Changelog record types */
695 enum changelog_rec_type {
696         CL_MARK     = 0,
697         CL_CREATE   = 1,  /* namespace */
698         CL_MKDIR    = 2,  /* namespace */
699         CL_HARDLINK = 3,  /* namespace */
700         CL_SOFTLINK = 4,  /* namespace */
701         CL_MKNOD    = 5,  /* namespace */
702         CL_UNLINK   = 6,  /* namespace */
703         CL_RMDIR    = 7,  /* namespace */
704         CL_RENAME   = 8,  /* namespace */
705         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
706         CL_OPEN     = 10, /* not currently used */
707         CL_CLOSE    = 11, /* may be written to log only with mtime change */
708         CL_LAYOUT   = 12, /* file layout/striping modified */
709         CL_TRUNC    = 13,
710         CL_SETATTR  = 14,
711         CL_XATTR    = 15,
712         CL_HSM      = 16, /* HSM specific events, see flags */
713         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
714         CL_CTIME    = 18,
715         CL_ATIME    = 19,
716         CL_MIGRATE  = 20,
717         CL_LAST
718 };
719
720 static inline const char *changelog_type2str(int type) {
721         static const char *changelog_str[] = {
722                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
723                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
724                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT"
725         };
726
727         if (type >= 0 && type < CL_LAST)
728                 return changelog_str[type];
729         return NULL;
730 }
731
732 /* per-record flags */
733 #define CLF_FLAGSHIFT   12
734 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
735 #define CLF_VERMASK     (~CLF_FLAGMASK)
736 enum changelog_rec_flags {
737         CLF_VERSION     = 0x1000,
738         CLF_RENAME      = 0x2000,
739         CLF_JOBID       = 0x4000,
740         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
741 };
742
743
744 /* Anything under the flagmask may be per-type (if desired) */
745 /* Flags for unlink */
746 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
747 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
748                                      /* HSM cleaning needed */
749 /* Flags for rename */
750 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
751                                         * of target */
752 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
753                                         * has an archive in backend */
754
755 /* Flags for HSM */
756 /* 12b used (from high weight to low weight):
757  * 2b for flags
758  * 3b for event
759  * 7b for error code
760  */
761 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
762 #define CLF_HSM_ERR_H        6
763 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
764 #define CLF_HSM_EVENT_H      9
765 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
766 #define CLF_HSM_FLAG_H      11
767 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
768 #define CLF_HSM_SPARE_H     15
769 #define CLF_HSM_LAST        15
770
771 /* Remove bits higher than _h, then extract the value
772  * between _h and _l by shifting lower weigth to bit 0. */
773 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
774                                    >> (CLF_HSM_LAST - _h + _l))
775
776 #define CLF_HSM_SUCCESS      0x00
777 #define CLF_HSM_MAXERROR     0x7E
778 #define CLF_HSM_ERROVERFLOW  0x7F
779
780 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
781
782 /* 3 bits field => 8 values allowed */
783 enum hsm_event {
784         HE_ARCHIVE      = 0,
785         HE_RESTORE      = 1,
786         HE_CANCEL       = 2,
787         HE_RELEASE      = 3,
788         HE_REMOVE       = 4,
789         HE_STATE        = 5,
790         HE_SPARE1       = 6,
791         HE_SPARE2       = 7,
792 };
793
794 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
795 {
796         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
797                                             CLF_HSM_EVENT_L);
798 }
799
800 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
801 {
802         *flags |= (he << CLF_HSM_EVENT_L);
803 }
804
805 static inline __u16 hsm_get_cl_flags(int flags)
806 {
807         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
808 }
809
810 static inline void hsm_set_cl_flags(int *flags, int bits)
811 {
812         *flags |= (bits << CLF_HSM_FLAG_L);
813 }
814
815 static inline int hsm_get_cl_error(int flags)
816 {
817         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
818 }
819
820 static inline void hsm_set_cl_error(int *flags, int error)
821 {
822         *flags |= (error << CLF_HSM_ERR_L);
823 }
824
825 enum changelog_send_flag {
826         /* Not yet implemented */
827         CHANGELOG_FLAG_FOLLOW   = 0x01,
828         /* Blocking IO makes sense in case of slow user parsing of the records,
829          * but it also prevents us from cleaning up if the records are not
830          * consumed. */
831         CHANGELOG_FLAG_BLOCK    = 0x02,
832         /* Pack jobid into the changelog records if available. */
833         CHANGELOG_FLAG_JOBID    = 0x04,
834 };
835
836 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
837                                   changelog_rec_offset(CLF_SUPPORTED))
838
839 /* 31 usable bytes string + null terminator. */
840 #define LUSTRE_JOBID_SIZE       32
841
842 /* This is the minimal changelog record. It can contain extensions
843  * such as rename fields or process jobid. Its exact content is described
844  * by the cr_flags.
845  *
846  * Extensions are packed in the same order as their corresponding flags.
847  */
848 struct changelog_rec {
849         __u16                   cr_namelen;
850         __u16                   cr_flags; /**< \a changelog_rec_flags */
851         __u32                   cr_type;  /**< \a changelog_rec_type */
852         __u64                   cr_index; /**< changelog record number */
853         __u64                   cr_prev;  /**< last index for this target fid */
854         __u64                   cr_time;
855         union {
856                 lustre_fid      cr_tfid;        /**< target fid */
857                 __u32           cr_markerflags; /**< CL_MARK flags */
858         };
859         lustre_fid              cr_pfid;        /**< parent fid */
860 };
861
862 /* Changelog extension for RENAME. */
863 struct changelog_ext_rename {
864         lustre_fid              cr_sfid;     /**< source fid, or zero */
865         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
866 };
867
868 /* Changelog extension to include JOBID. */
869 struct changelog_ext_jobid {
870         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
871 };
872
873
874 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
875 {
876         size_t size = sizeof(struct changelog_rec);
877
878         if (crf & CLF_RENAME)
879                 size += sizeof(struct changelog_ext_rename);
880
881         if (crf & CLF_JOBID)
882                 size += sizeof(struct changelog_ext_jobid);
883
884         return size;
885 }
886
887 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
888 {
889         return changelog_rec_offset(rec->cr_flags);
890 }
891
892 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
893 {
894         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
895 }
896
897 static inline
898 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
899 {
900         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
901
902         return (struct changelog_ext_rename *)((char *)rec +
903                                                changelog_rec_offset(crf));
904 }
905
906 /* The jobid follows the rename extension, if present */
907 static inline
908 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
909 {
910         enum changelog_rec_flags crf = rec->cr_flags &
911                                         (CLF_VERSION | CLF_RENAME);
912
913         return (struct changelog_ext_jobid *)((char *)rec +
914                                               changelog_rec_offset(crf));
915 }
916
917 /* The name follows the rename and jobid extensions, if present */
918 static inline char *changelog_rec_name(const struct changelog_rec *rec)
919 {
920         return (char *)rec + changelog_rec_offset(rec->cr_flags &
921                                                   CLF_SUPPORTED);
922 }
923
924 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
925 {
926         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
927 }
928
929 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
930 {
931         char *cr_name = changelog_rec_name(rec);
932
933         return cr_name + strlen(cr_name) + 1;
934 }
935
936 /**
937  * Remap a record to the desired format as specified by the crf flags.
938  * The record must be big enough to contain the final remapped version.
939  * Superfluous extension fields are removed and missing ones are added
940  * and zeroed. The flags of the record are updated accordingly.
941  *
942  * The jobid and rename extensions can be added to a record, to match the
943  * format an application expects, typically. In this case, the newly added
944  * fields will be zeroed.
945  * The Jobid field can be removed, to guarantee compatibility with older
946  * clients that don't expect this field in the records they process.
947  *
948  * The following assumptions are being made:
949  *   - CLF_RENAME will not be removed
950  *   - CLF_JOBID will not be added without CLF_RENAME being added too
951  *
952  * @param[in,out]  rec         The record to remap.
953  * @param[in]      crf_wanted  Flags describing the desired extensions.
954  */
955 static inline void changelog_remap_rec(struct changelog_rec *rec,
956                                        enum changelog_rec_flags crf_wanted)
957 {
958         char *jid_mov;
959         char *rnm_mov;
960
961         crf_wanted &= CLF_SUPPORTED;
962
963         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
964                 return;
965
966         /* First move the variable-length name field */
967         memmove((char *)rec + changelog_rec_offset(crf_wanted),
968                 changelog_rec_name(rec), rec->cr_namelen);
969
970         /* Locations of jobid and rename extensions in the remapped record */
971         jid_mov = (char *)rec +
972                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
973         rnm_mov = (char *)rec +
974                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
975
976         /* Move the extension fields to the desired positions */
977         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
978                 memmove(jid_mov, changelog_rec_jobid(rec),
979                         sizeof(struct changelog_ext_jobid));
980
981         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
982                 memmove(rnm_mov, changelog_rec_rename(rec),
983                         sizeof(struct changelog_ext_rename));
984
985         /* Clear newly added fields */
986         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
987                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
988
989         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
990                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
991
992         /* Update the record's flags accordingly */
993         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
994 }
995
996 struct ioc_changelog {
997         __u64 icc_recno;
998         __u32 icc_mdtindex;
999         __u32 icc_id;
1000         __u32 icc_flags;
1001 };
1002
1003 enum changelog_message_type {
1004         CL_RECORD = 10, /* message is a changelog_rec */
1005         CL_EOF    = 11, /* at end of current changelog */
1006 };
1007
1008 /********* Misc **********/
1009
1010 struct ioc_data_version {
1011         __u64 idv_version;
1012         __u64 idv_flags;     /* See LL_DV_xxx */
1013 };
1014 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1015 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1016
1017 #ifndef offsetof
1018 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1019 #endif
1020
1021 #define dot_lustre_name ".lustre"
1022
1023
1024 /********* HSM **********/
1025
1026 /** HSM per-file state
1027  * See HSM_FLAGS below.
1028  */
1029 enum hsm_states {
1030         HS_NONE         = 0x00000000,
1031         HS_EXISTS       = 0x00000001,
1032         HS_DIRTY        = 0x00000002,
1033         HS_RELEASED     = 0x00000004,
1034         HS_ARCHIVED     = 0x00000008,
1035         HS_NORELEASE    = 0x00000010,
1036         HS_NOARCHIVE    = 0x00000020,
1037         HS_LOST         = 0x00000040,
1038 };
1039
1040 /* HSM user-setable flags. */
1041 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1042
1043 /* Other HSM flags. */
1044 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1045
1046 /*
1047  * All HSM-related possible flags that could be applied to a file.
1048  * This should be kept in sync with hsm_states.
1049  */
1050 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1051
1052 /**
1053  * HSM request progress state
1054  */
1055 enum hsm_progress_states {
1056         HPS_WAITING     = 1,
1057         HPS_RUNNING     = 2,
1058         HPS_DONE        = 3,
1059 };
1060 #define HPS_NONE        0
1061
1062 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1063 {
1064         switch  (s) {
1065         case HPS_WAITING:       return "waiting";
1066         case HPS_RUNNING:       return "running";
1067         case HPS_DONE:          return "done";
1068         default:                return "unknown";
1069         }
1070 }
1071
1072 struct hsm_extent {
1073         __u64 offset;
1074         __u64 length;
1075 } __attribute__((packed));
1076
1077 /**
1078  * Current HSM states of a Lustre file.
1079  *
1080  * This structure purpose is to be sent to user-space mainly. It describes the
1081  * current HSM flags and in-progress action.
1082  */
1083 struct hsm_user_state {
1084         /** Current HSM states, from enum hsm_states. */
1085         __u32                   hus_states;
1086         __u32                   hus_archive_id;
1087         /**  The current undergoing action, if there is one */
1088         __u32                   hus_in_progress_state;
1089         __u32                   hus_in_progress_action;
1090         struct hsm_extent       hus_in_progress_location;
1091         char                    hus_extended_info[];
1092 };
1093
1094 struct hsm_state_set_ioc {
1095         struct lu_fid   hssi_fid;
1096         __u64           hssi_setmask;
1097         __u64           hssi_clearmask;
1098 };
1099
1100 /*
1101  * This structure describes the current in-progress action for a file.
1102  * it is retuned to user space and send over the wire
1103  */
1104 struct hsm_current_action {
1105         /**  The current undergoing action, if there is one */
1106         /* state is one of hsm_progress_states */
1107         __u32                   hca_state;
1108         /* action is one of hsm_user_action */
1109         __u32                   hca_action;
1110         struct hsm_extent       hca_location;
1111 };
1112
1113 /***** HSM user requests ******/
1114 /* User-generated (lfs/ioctl) request types */
1115 enum hsm_user_action {
1116         HUA_NONE    =  1, /* no action (noop) */
1117         HUA_ARCHIVE = 10, /* copy to hsm */
1118         HUA_RESTORE = 11, /* prestage */
1119         HUA_RELEASE = 12, /* drop ost objects */
1120         HUA_REMOVE  = 13, /* remove from archive */
1121         HUA_CANCEL  = 14  /* cancel a request */
1122 };
1123
1124 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1125 {
1126         switch  (a) {
1127         case HUA_NONE:    return "NOOP";
1128         case HUA_ARCHIVE: return "ARCHIVE";
1129         case HUA_RESTORE: return "RESTORE";
1130         case HUA_RELEASE: return "RELEASE";
1131         case HUA_REMOVE:  return "REMOVE";
1132         case HUA_CANCEL:  return "CANCEL";
1133         default:          return "UNKNOWN";
1134         }
1135 }
1136
1137 /*
1138  * List of hr_flags (bit field)
1139  */
1140 #define HSM_FORCE_ACTION 0x0001
1141 /* used by CT, cannot be set by user */
1142 #define HSM_GHOST_COPY   0x0002
1143
1144 /**
1145  * Contains all the fixed part of struct hsm_user_request.
1146  *
1147  */
1148 struct hsm_request {
1149         __u32 hr_action;        /* enum hsm_user_action */
1150         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1151         __u64 hr_flags;         /* request flags */
1152         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1153         __u32 hr_data_len;
1154 };
1155
1156 struct hsm_user_item {
1157        lustre_fid        hui_fid;
1158        struct hsm_extent hui_extent;
1159 } __attribute__((packed));
1160
1161 struct hsm_user_request {
1162         struct hsm_request      hur_request;
1163         struct hsm_user_item    hur_user_item[0];
1164         /* extra data blob at end of struct (after all
1165          * hur_user_items), only use helpers to access it
1166          */
1167 } __attribute__((packed));
1168
1169 /** Return pointer to data field in a hsm user request */
1170 static inline void *hur_data(struct hsm_user_request *hur)
1171 {
1172         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1173 }
1174
1175 /**
1176  * Compute the current length of the provided hsm_user_request.  This returns -1
1177  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1178  *
1179  * return -1 on bounds check error.
1180  */
1181 static inline ssize_t hur_len(struct hsm_user_request *hur)
1182 {
1183         __u64   size;
1184
1185         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1186         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1187                 (__u64)hur->hur_request.hr_itemcount *
1188                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1189
1190         if (size != (ssize_t)size)
1191                 return -1;
1192
1193         return size;
1194 }
1195
1196 /****** HSM RPCs to copytool *****/
1197 /* Message types the copytool may receive */
1198 enum hsm_message_type {
1199         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1200 };
1201
1202 /* Actions the copytool may be instructed to take for a given action_item */
1203 enum hsm_copytool_action {
1204         HSMA_NONE    = 10, /* no action */
1205         HSMA_ARCHIVE = 20, /* arbitrary offset */
1206         HSMA_RESTORE = 21,
1207         HSMA_REMOVE  = 22,
1208         HSMA_CANCEL  = 23
1209 };
1210
1211 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1212 {
1213         switch  (a) {
1214         case HSMA_NONE:    return "NOOP";
1215         case HSMA_ARCHIVE: return "ARCHIVE";
1216         case HSMA_RESTORE: return "RESTORE";
1217         case HSMA_REMOVE:  return "REMOVE";
1218         case HSMA_CANCEL:  return "CANCEL";
1219         default:           return "UNKNOWN";
1220         }
1221 }
1222
1223 /* Copytool item action description */
1224 struct hsm_action_item {
1225         __u32      hai_len;     /* valid size of this struct */
1226         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1227         lustre_fid hai_fid;     /* Lustre FID to operate on */
1228         lustre_fid hai_dfid;    /* fid used for data access */
1229         struct hsm_extent hai_extent;  /* byte range to operate on */
1230         __u64      hai_cookie;  /* action cookie from coordinator */
1231         __u64      hai_gid;     /* grouplock id */
1232         char       hai_data[0]; /* variable length */
1233 } __attribute__((packed));
1234
1235 /**
1236  * helper function which print in hexa the first bytes of
1237  * hai opaque field
1238  *
1239  * \param hai [IN]        record to print
1240  * \param buffer [IN,OUT] buffer to write the hex string to
1241  * \param len [IN]        max buffer length
1242  *
1243  * \retval buffer
1244  */
1245 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1246                                         char *buffer, size_t len)
1247 {
1248         int i;
1249         int data_len;
1250         char *ptr;
1251
1252         ptr = buffer;
1253         data_len = hai->hai_len - sizeof(*hai);
1254         for (i = 0; (i < data_len) && (len > 2); i++) {
1255                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1256                 ptr += 2;
1257                 len -= 2;
1258         }
1259
1260         *ptr = '\0';
1261
1262         return buffer;
1263 }
1264
1265 /* Copytool action list */
1266 #define HAL_VERSION 1
1267 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1268 struct hsm_action_list {
1269         __u32 hal_version;
1270         __u32 hal_count;       /* number of hai's to follow */
1271         __u64 hal_compound_id; /* returned by coordinator */
1272         __u64 hal_flags;
1273         __u32 hal_archive_id; /* which archive backend */
1274         __u32 padding1;
1275         char  hal_fsname[0];   /* null-terminated */
1276         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1277            boundaries. See hai_zero */
1278 } __attribute__((packed));
1279
1280 #ifndef HAVE_CFS_SIZE_ROUND
1281 static inline int cfs_size_round (int val)
1282 {
1283         return (val + 7) & (~0x7);
1284 }
1285 #define HAVE_CFS_SIZE_ROUND
1286 #endif
1287
1288 /* Return pointer to first hai in action list */
1289 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1290 {
1291         return (struct hsm_action_item *)(hal->hal_fsname +
1292                                           cfs_size_round(strlen(hal-> \
1293                                                                 hal_fsname)
1294                                                          + 1));
1295 }
1296 /* Return pointer to next hai */
1297 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1298 {
1299         return (struct hsm_action_item *)((char *)hai +
1300                                           cfs_size_round(hai->hai_len));
1301 }
1302
1303 /* Return size of an hsm_action_list */
1304 static inline size_t hal_size(struct hsm_action_list *hal)
1305 {
1306         __u32 i;
1307         size_t sz;
1308         struct hsm_action_item *hai;
1309
1310         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1311         hai = hai_first(hal);
1312         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1313                 sz += cfs_size_round(hai->hai_len);
1314
1315         return sz;
1316 }
1317
1318 /* HSM file import
1319  * describe the attributes to be set on imported file
1320  */
1321 struct hsm_user_import {
1322         __u64           hui_size;
1323         __u64           hui_atime;
1324         __u64           hui_mtime;
1325         __u32           hui_atime_ns;
1326         __u32           hui_mtime_ns;
1327         __u32           hui_uid;
1328         __u32           hui_gid;
1329         __u32           hui_mode;
1330         __u32           hui_archive_id;
1331 };
1332
1333 /* Copytool progress reporting */
1334 #define HP_FLAG_COMPLETED 0x01
1335 #define HP_FLAG_RETRY     0x02
1336
1337 struct hsm_progress {
1338         lustre_fid              hp_fid;
1339         __u64                   hp_cookie;
1340         struct hsm_extent       hp_extent;
1341         __u16                   hp_flags;
1342         __u16                   hp_errval; /* positive val */
1343         __u32                   padding;
1344 };
1345
1346 struct hsm_copy {
1347         __u64                   hc_data_version;
1348         __u16                   hc_flags;
1349         __u16                   hc_errval; /* positive val */
1350         __u32                   padding;
1351         struct hsm_action_item  hc_hai;
1352 };
1353
1354 /* JSON objects */
1355 enum llapi_json_types {
1356         LLAPI_JSON_INTEGER = 1,
1357         LLAPI_JSON_BIGNUM,
1358         LLAPI_JSON_REAL,
1359         LLAPI_JSON_STRING
1360 };
1361
1362 struct llapi_json_item {
1363         char                    *lji_key;
1364         __u32                   lji_type;
1365         union {
1366                 int     lji_integer;
1367                 __u64   lji_u64;
1368                 double  lji_real;
1369                 char    *lji_string;
1370         };
1371         struct llapi_json_item  *lji_next;
1372 };
1373
1374 struct llapi_json_item_list {
1375         int                     ljil_item_count;
1376         struct llapi_json_item  *ljil_items;
1377 };
1378
1379 enum lu_ladvise_type {
1380         LU_LADVISE_INVALID      = 0,
1381 };
1382
1383 #define LU_LADVISE_NAMES {                                              \
1384 }
1385
1386 struct lu_ladvise {
1387         __u64 lla_advice;
1388         __u64 lla_start;
1389         __u64 lla_end;
1390         __u64 lla_padding;
1391 };
1392
1393 enum ladvise_flag {
1394         LF_ASYNC        = 0x00000001,
1395 };
1396
1397 #define LADVISE_MAGIC 0x1ADF1CE0
1398 #define LF_MASK LF_ASYNC
1399
1400 struct ladvise_hdr {
1401         __u32                   lah_magic;      /* LADVISE_MAGIC */
1402         __u32                   lah_count;      /* number of advices */
1403         __u64                   lah_flags;      /* from enum ladvise_flag */
1404         __u64                   lah_padding1;   /* unused */
1405         __u64                   lah_padding2;   /* unused */
1406         struct lu_ladvise       lah_advise[0];
1407 };
1408
1409 #define LAH_COUNT_MAX   (1024)
1410
1411 /* Shared key */
1412 enum sk_crypt_alg {
1413         SK_CRYPT_INVALID        = -1,
1414         SK_CRYPT_EMPTY          = 0,
1415         SK_CRYPT_AES256_CTR     = 1,
1416         SK_CRYPT_MAX            = 2,
1417 };
1418
1419 enum sk_hmac_alg {
1420         SK_HMAC_INVALID = -1,
1421         SK_HMAC_EMPTY   = 0,
1422         SK_HMAC_SHA256  = 1,
1423         SK_HMAC_SHA512  = 2,
1424         SK_HMAC_MAX     = 3,
1425 };
1426
1427 struct sk_crypt_type {
1428         char    *sct_name;
1429         size_t   sct_bytes;
1430 };
1431
1432 struct sk_hmac_type {
1433         char    *sht_name;
1434         size_t   sht_bytes;
1435 };
1436
1437 /** @} lustreuser */
1438 #endif /* _LUSTRE_USER_H */