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