Whamcloud - gitweb
7997d39c913382dcc34f262d1464566979ca28d0
[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, 2017, 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/kernel.h>
46 #include <linux/types.h>
47
48 #ifdef __KERNEL__
49 # include <linux/fs.h>
50 # include <linux/quota.h>
51 # include <linux/string.h> /* snprintf() */
52 # include <linux/version.h>
53 # include <uapi/linux/lustre/lustre_fiemap.h>
54 #else /* !__KERNEL__ */
55 # include <limits.h>
56 # include <stdbool.h>
57 # include <stdio.h> /* snprintf() */
58 # include <string.h>
59 # define NEED_QUOTA_DEFS
60 /* # include <sys/quota.h> - this causes complaints about caddr_t */
61 # include <sys/stat.h>
62 # include <linux/lustre/lustre_fiemap.h>
63 #endif /* __KERNEL__ */
64
65 /* Handle older distros */
66 #ifndef __ALIGN_KERNEL
67 # define __ALIGN_KERNEL(x, a)   __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
68 # define __ALIGN_KERNEL_MASK(x, mask)   (((x) + (mask)) & ~(mask))
69 #endif
70
71 #if defined(__cplusplus)
72 extern "C" {
73 #endif
74
75 /*
76  * This is a temporary solution of adding quota type.
77  * Should be removed as soon as system header is updated.
78  */
79 #undef LL_MAXQUOTAS
80 #define LL_MAXQUOTAS 3
81 #undef INITQFNAMES
82 #define INITQFNAMES { \
83     "user",     /* USRQUOTA */ \
84     "group",    /* GRPQUOTA */ \
85     "project",  /* PRJQUOTA */ \
86     "undefined", \
87 };
88 #ifndef USRQUOTA
89 #define USRQUOTA 0
90 #endif
91 #ifndef GRPQUOTA
92 #define GRPQUOTA 1
93 #endif
94 #ifndef PRJQUOTA
95 #define PRJQUOTA 2
96 #endif
97
98 /*
99  * We need to always use 64bit version because the structure
100  * is shared across entire cluster where 32bit and 64bit machines
101  * are co-existing.
102  */
103 #if __BITS_PER_LONG != 64 || defined(__ARCH_WANT_STAT64)
104 typedef struct stat64   lstat_t;
105 #define lstat_f  lstat64
106 #define fstat_f         fstat64
107 #define fstatat_f       fstatat64
108 #else
109 typedef struct stat     lstat_t;
110 #define lstat_f  lstat
111 #define fstat_f         fstat
112 #define fstatat_f       fstatat
113 #endif
114
115 #define HAVE_LOV_USER_MDS_DATA
116
117 #define LUSTRE_EOF 0xffffffffffffffffULL
118
119 /* for statfs() */
120 #define LL_SUPER_MAGIC 0x0BD00BD0
121
122 #define FSFILT_IOC_GETVERSION           _IOR('f', 3, long)
123
124 /* FIEMAP flags supported by Lustre */
125 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
126
127 enum obd_statfs_state {
128         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
129         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
130         OS_STATE_NOPRECREATE    = 0x00000004, /**< no object precreation */
131         OS_STATE_ENOSPC         = 0x00000020, /**< not enough free space */
132         OS_STATE_ENOINO         = 0x00000040, /**< not enough inodes */
133         OS_STATE_SUM            = 0x00000100, /**< aggregated for all tagrets */
134 };
135
136 /** filesystem statistics/attributes for target device */
137 struct obd_statfs {
138         __u64           os_type;        /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
139         __u64           os_blocks;      /* total size in #os_bsize blocks */
140         __u64           os_bfree;       /* number of unused blocks */
141         __u64           os_bavail;      /* blocks available for allocation */
142         __u64           os_files;       /* total number of objects */
143         __u64           os_ffree;       /* # objects that could be created */
144         __u8            os_fsid[40];    /* identifier for filesystem */
145         __u32           os_bsize;       /* block size in bytes for os_blocks */
146         __u32           os_namelen;     /* maximum length of filename in bytes*/
147         __u64           os_maxbytes;    /* maximum object size in bytes */
148         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
149         __u32           os_fprecreated; /* objs available now to the caller */
150                                         /* used in QoS code to find preferred
151                                          * OSTs */
152         __u32           os_granted;     /* space granted for MDS */
153         __u32           os_spare3;      /* Unused padding fields.  Remember */
154         __u32           os_spare4;      /* to fix lustre_swab_obd_statfs() */
155         __u32           os_spare5;
156         __u32           os_spare6;
157         __u32           os_spare7;
158         __u32           os_spare8;
159         __u32           os_spare9;
160 };
161
162 /**
163  * File IDentifier.
164  *
165  * FID is a cluster-wide unique identifier of a file or an object (stripe).
166  * FIDs are never reused.
167  **/
168 struct lu_fid {
169        /**
170         * FID sequence. Sequence is a unit of migration: all files (objects)
171         * with FIDs from a given sequence are stored on the same server.
172         * Lustre should support 2^64 objects, so even if each sequence
173         * has only a single object we can still enumerate 2^64 objects.
174         **/
175         __u64 f_seq;
176         /* FID number within sequence. */
177         __u32 f_oid;
178         /**
179          * FID version, used to distinguish different versions (in the sense
180          * of snapshots, etc.) of the same file system object. Not currently
181          * used.
182          **/
183         __u32 f_ver;
184 };
185
186 static inline bool fid_is_zero(const struct lu_fid *fid)
187 {
188         return fid->f_seq == 0 && fid->f_oid == 0;
189 }
190
191 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
192  * MDT-object's FID::f_ver, instead it is the OST-object index in its
193  * parent MDT-object's layout EA. */
194 #define f_stripe_idx f_ver
195
196 struct ost_layout {
197         __u32   ol_stripe_size;
198         __u32   ol_stripe_count;
199         __u64   ol_comp_start;
200         __u64   ol_comp_end;
201         __u32   ol_comp_id;
202 } __attribute__((packed));
203
204 /* keep this one for compatibility */
205 struct filter_fid_old {
206         struct lu_fid   ff_parent;
207         __u64           ff_objid;
208         __u64           ff_seq;
209 };
210
211 struct filter_fid {
212         struct lu_fid           ff_parent;
213         struct ost_layout       ff_layout;
214         __u32                   ff_layout_version;
215         __u32                   ff_range; /* range of layout version that
216                                            * write are allowed */
217 } __attribute__((packed));
218
219 /* Userspace should treat lu_fid as opaque, and only use the following methods
220  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
221  * here from lustre_idl.h if needed. */
222 struct lu_fid;
223
224 enum lma_compat {
225         LMAC_HSM         = 0x00000001,
226 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
227         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
228         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
229                                        * under /O/<seq>/d<x>. */
230         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
231         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
232         LMAC_IDX_BACKUP  = 0x00000040, /* Has index backup. */
233 };
234
235 /**
236  * Masks for all features that should be supported by a Lustre version to
237  * access a specific file.
238  * This information is stored in lustre_mdt_attrs::lma_incompat.
239  */
240 enum lma_incompat {
241         LMAI_RELEASED           = 0x00000001, /* file is released */
242         LMAI_AGENT              = 0x00000002, /* agent inode */
243         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
244                                                  is on the remote MDT */
245         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
246         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
247         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
248                                    LMAI_STRIPED | LMAI_ORPHAN)
249 };
250
251
252 /**
253  * Following struct for object attributes, that will be kept inode's EA.
254  * Introduced in 2.0 release (please see b15993, for details)
255  * Added to all objects since Lustre 2.4 as contains self FID
256  */
257 struct lustre_mdt_attrs {
258         /**
259          * Bitfield for supported data in this structure. From enum lma_compat.
260          * lma_self_fid and lma_flags are always available.
261          */
262         __u32   lma_compat;
263         /**
264          * Per-file incompat feature list. Lustre version should support all
265          * flags set in this field. The supported feature mask is available in
266          * LMA_INCOMPAT_SUPP.
267          */
268         __u32   lma_incompat;
269         /** FID of this inode */
270         struct lu_fid  lma_self_fid;
271 };
272
273 struct lustre_ost_attrs {
274         /* Use lustre_mdt_attrs directly for now, need a common header
275          * structure if want to change lustre_mdt_attrs in future. */
276         struct lustre_mdt_attrs loa_lma;
277
278         /* Below five elements are for OST-object's PFID EA, the
279          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
280          * and the stripe_index (low 16 bits), the size should not exceed
281          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
282          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
283          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
284          * loa_comp_* elements are valid. */
285         struct lu_fid   loa_parent_fid;
286         __u32           loa_stripe_size;
287         __u32           loa_comp_id;
288         __u64           loa_comp_start;
289         __u64           loa_comp_end;
290 };
291
292 /**
293  * Prior to 2.4, the LMA structure also included SOM attributes which has since
294  * been moved to a dedicated xattr
295  * lma_flags was also removed because of lma_compat/incompat fields.
296  */
297 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
298
299 enum lustre_som_flags {
300         /* Unknow or no SoM data, must get size from OSTs. */
301         SOM_FL_UNKNOWN  = 0x0000,
302         /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
303         SOM_FL_STRICT   = 0x0001,
304         /* Known stale - was right at some point in the past, but it is
305          * known (or likely) to be incorrect now (e.g. opened for write). */
306         SOM_FL_STALE    = 0x0002,
307         /* Approximate, may never have been strictly correct,
308          * need to sync SOM data to achieve eventual consistency. */
309         SOM_FL_LAZY     = 0x0004,
310 };
311
312 struct lustre_som_attrs {
313         __u16   lsa_valid;
314         __u16   lsa_reserved[3];
315         __u64   lsa_size;
316         __u64   lsa_blocks;
317 };
318
319 /**
320  * OST object IDentifier.
321  */
322 struct ost_id {
323         union {
324                 struct {
325                         __u64   oi_id;
326                         __u64   oi_seq;
327                 } oi;
328                 struct lu_fid oi_fid;
329         };
330 };
331
332 #define DOSTID "%#llx:%llu"
333 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
334                    ((unsigned long long)ostid_id(oi))
335
336 struct ll_futimes_3 {
337         __u64 lfu_atime_sec;
338         __u64 lfu_atime_nsec;
339         __u64 lfu_mtime_sec;
340         __u64 lfu_mtime_nsec;
341         __u64 lfu_ctime_sec;
342         __u64 lfu_ctime_nsec;
343 };
344
345 /*
346  * Maximum number of mirrors currently implemented.
347  */
348 #define LUSTRE_MIRROR_COUNT_MAX         16
349
350 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
351 enum ll_lease_mode {
352         LL_LEASE_RDLCK  = 0x01,
353         LL_LEASE_WRLCK  = 0x02,
354         LL_LEASE_UNLCK  = 0x04,
355 };
356
357 enum ll_lease_flags {
358         LL_LEASE_RESYNC         = 0x1,
359         LL_LEASE_RESYNC_DONE    = 0x2,
360         LL_LEASE_LAYOUT_MERGE   = 0x4,
361         LL_LEASE_LAYOUT_SPLIT   = 0x8,
362 };
363
364 #define IOC_IDS_MAX     4096
365 struct ll_ioc_lease {
366         __u32           lil_mode;
367         __u32           lil_flags;
368         __u32           lil_count;
369         __u32           lil_ids[0];
370 };
371
372 struct ll_ioc_lease_id {
373         __u32           lil_mode;
374         __u32           lil_flags;
375         __u32           lil_count;
376         __u16           lil_mirror_id;
377         __u16           lil_padding1;
378         __u64           lil_padding2;
379         __u32           lil_ids[0];
380 };
381
382 /*
383  * The ioctl naming rules:
384  * LL_*     - works on the currently opened filehandle instead of parent dir
385  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
386  * *_MDC_*  - gets/sets data related to MDC
387  * *_LOV_*  - gets/sets data related to OSC/LOV
388  * *FILE*   - called on parent dir and passes in a filename
389  * *STRIPE* - set/get lov_user_md
390  * *INFO    - set/get lov_user_mds_data
391  */
392 /*      lustre_ioctl.h                  101-150 */
393 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
394 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
395 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
396 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
397 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
398 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
399 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
400 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
401 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
402 /*      LL_IOC_RECREATE_FID             157 obsolete */
403 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
404 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
405 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
406 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
407 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
408 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
409 /*      IOC_LOV_GETINFO                 165 obsolete */
410 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
411 /*      LL_IOC_RMTACL                   167 obsolete */
412 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
413 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
414 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
415 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
416 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
417 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
418 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
419 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
420 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
421 #define LL_IOC_FLR_SET_MIRROR           _IOW ('f', 177, long)
422 /*      lustre_ioctl.h                  177-210 */
423 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
424 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
425 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
426 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
427 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
428 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
429 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
430 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
431 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
432                                                 struct lustre_swap_layouts)
433 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
434                                                 struct hsm_current_action)
435 /*      lustre_ioctl.h                  221-232 */
436 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
437 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
438 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
439 #define LL_IOC_SET_LEASE                _IOWR('f', 243, struct ll_ioc_lease)
440 #define LL_IOC_SET_LEASE_OLD            _IOWR('f', 243, long)
441 #define LL_IOC_GET_LEASE                _IO('f', 244)
442 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
443 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
444 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
445 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
446 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
447 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
448
449 #ifndef FS_IOC_FSGETXATTR
450 /*
451  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
452 */
453 struct fsxattr {
454         __u32           fsx_xflags;     /* xflags field value (get/set) */
455         __u32           fsx_extsize;    /* extsize field value (get/set)*/
456         __u32           fsx_nextents;   /* nextents field value (get)   */
457         __u32           fsx_projid;     /* project identifier (get/set) */
458         unsigned char   fsx_pad[12];
459 };
460 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
461 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
462 #endif
463 #define LL_IOC_FSGETXATTR               FS_IOC_FSGETXATTR
464 #define LL_IOC_FSSETXATTR               FS_IOC_FSSETXATTR
465 #ifndef FS_XFLAG_PROJINHERIT
466 #define FS_XFLAG_PROJINHERIT            0x00000200
467 #endif
468
469
470 #define LL_STATFS_LMV           1
471 #define LL_STATFS_LOV           2
472 #define LL_STATFS_NODELAY       4
473
474 #define IOC_MDC_TYPE            'i'
475 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
476 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
477 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
478 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
479
480 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
481
482 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
483  * files, but are unlikely to be used in practice and are not harmful if
484  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
485  * devices and are safe for use on new files. See LU-4209. */
486 /* To be compatible with old statically linked binary we keep the check for
487  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
488 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
489 #ifndef FASYNC
490 #define FASYNC                  00020000   /* fcntl, for BSD compatibility */
491 #endif
492 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
493 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
494                                          O_LOV_DELAY_CREATE_MASK)
495
496 #define LL_FILE_IGNORE_LOCK     0x00000001
497 #define LL_FILE_GROUP_LOCKED    0x00000002
498 #define LL_FILE_READAHEA        0x00000004
499 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
500 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
501
502 #define LOV_USER_MAGIC_V1       0x0BD10BD0
503 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
504 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
505 #define LOV_USER_MAGIC_V3       0x0BD30BD0
506 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
507 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
508 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
509
510 #define LMV_USER_MAGIC          0x0CD30CD0    /* default lmv magic */
511 #define LMV_USER_MAGIC_V0       0x0CD20CD0    /* old default lmv magic*/
512 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
513
514 #define LOV_PATTERN_NONE        0x000
515 #define LOV_PATTERN_RAID0       0x001
516 #define LOV_PATTERN_RAID1       0x002
517 #define LOV_PATTERN_MDT         0x100
518 #define LOV_PATTERN_CMOBD       0x200
519
520 #define LOV_PATTERN_F_MASK      0xffff0000
521 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
522 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
523 #define LOV_PATTERN_DEFAULT     0xffffffff
524
525 static inline bool lov_pattern_supported(__u32 pattern)
526 {
527         return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
528                (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
529 }
530
531 #define LOV_MAXPOOLNAME 15
532 #define LOV_POOLNAMEF "%.15s"
533
534 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
535 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
536 #define LOV_MAX_STRIPE_COUNT_OLD 160
537 /* This calculation is crafted so that input of 4096 will result in 160
538  * which in turn is equal to old maximal stripe count.
539  * XXX: In fact this is too simpified for now, what it also need is to get
540  * ea_type argument to clearly know how much space each stripe consumes.
541  *
542  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
543  * allocation that is sufficient for the current generation of systems.
544  *
545  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
546 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
547 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
548 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
549
550 #define XATTR_LUSTRE_PREFIX     "lustre."
551 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
552
553 #define lov_user_ost_data lov_user_ost_data_v1
554 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
555         struct ost_id l_ost_oi;   /* OST object ID */
556         __u32 l_ost_gen;          /* generation of this OST index */
557         __u32 l_ost_idx;          /* OST index in LOV */
558 } __attribute__((packed));
559
560 #define lov_user_md lov_user_md_v1
561 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
562         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
563         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
564         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
565         __u32 lmm_stripe_size;    /* size of stripe in bytes */
566         __u16 lmm_stripe_count;   /* num stripes in use for this object */
567         union {
568                 __u16 lmm_stripe_offset;  /* starting stripe offset in
569                                            * lmm_objects, use when writing */
570                 __u16 lmm_layout_gen;     /* layout generation number
571                                            * used when reading */
572         };
573         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
574 } __attribute__((packed,  __may_alias__));
575
576 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
577         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
578         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
579         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
580         __u32 lmm_stripe_size;    /* size of stripe in bytes */
581         __u16 lmm_stripe_count;   /* num stripes in use for this object */
582         union {
583                 __u16 lmm_stripe_offset;  /* starting stripe offset in
584                                            * lmm_objects, use when writing */
585                 __u16 lmm_layout_gen;     /* layout generation number
586                                            * used when reading */
587         };
588         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
589         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
590 } __attribute__((packed));
591
592 struct lu_extent {
593         __u64   e_start;
594         __u64   e_end;
595 };
596
597 #define DEXT "[%#llx, %#llx)"
598 #define PEXT(ext) (ext)->e_start, (ext)->e_end
599
600 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
601                                            struct lu_extent *e2)
602 {
603         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
604 }
605
606 static inline bool lu_extent_is_whole(struct lu_extent *e)
607 {
608         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
609 }
610
611 enum lov_comp_md_entry_flags {
612         LCME_FL_STALE   = 0x00000001,   /* FLR: stale data */
613         LCME_FL_PREF_RD = 0x00000002,   /* FLR: preferred for reading */
614         LCME_FL_PREF_WR = 0x00000004,   /* FLR: preferred for writing */
615         LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
616         LCME_FL_OFFLINE = 0x00000008,   /* Not used */
617         LCME_FL_INIT    = 0x00000010,   /* instantiated */
618         LCME_FL_NOSYNC  = 0x00000020,   /* FLR: no sync for the mirror */
619         LCME_FL_NEG     = 0x80000000    /* used to indicate a negative flag,
620                                            won't be stored on disk */
621 };
622
623 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
624                                  LCME_FL_PREF_RW | LCME_FL_NOSYNC)
625 /* The flags can be set by users at mirror creation time. */
626 #define LCME_USER_FLAGS         (LCME_FL_PREF_RW)
627
628 /* The flags are for mirrors */
629 #define LCME_MIRROR_FLAGS       (LCME_FL_NOSYNC)
630
631 /* These flags have meaning when set in a default layout and will be inherited
632  * from the default/template layout set on a directory.
633  */
634 #define LCME_TEMPLATE_FLAGS     (LCME_FL_PREF_RW | LCME_FL_NOSYNC)
635
636 /* the highest bit in obdo::o_layout_version is used to mark if the file is
637  * being resynced. */
638 #define LU_LAYOUT_RESYNC        LCME_FL_NEG
639
640 /* lcme_id can be specified as certain flags, and the the first
641  * bit of lcme_id is used to indicate that the ID is representing
642  * certain LCME_FL_* but not a real ID. Which implies we can have
643  * at most 31 flags (see LCME_FL_XXX). */
644 enum lcme_id {
645         LCME_ID_INVAL   = 0x0,
646         LCME_ID_MAX     = 0x7FFFFFFF,
647         LCME_ID_ALL     = 0xFFFFFFFF,
648         LCME_ID_NOT_ID  = LCME_FL_NEG
649 };
650
651 #define LCME_ID_MASK    LCME_ID_MAX
652
653 struct lov_comp_md_entry_v1 {
654         __u32                   lcme_id;        /* unique id of component */
655         __u32                   lcme_flags;     /* LCME_FL_XXX */
656         struct lu_extent        lcme_extent;    /* file extent for component */
657         __u32                   lcme_offset;    /* offset of component blob,
658                                                    start from lov_comp_md_v1 */
659         __u32                   lcme_size;      /* size of component blob */
660         __u32                   lcme_layout_gen;
661         __u64                   lcme_timestamp; /* snapshot time if applicable*/
662         __u32                   lcme_padding_1;
663 } __attribute__((packed));
664
665 #define SEQ_ID_MAX              0x0000FFFF
666 #define SEQ_ID_MASK             SEQ_ID_MAX
667 /* bit 30:16 of lcme_id is used to store mirror id */
668 #define MIRROR_ID_MASK          0x7FFF0000
669 #define MIRROR_ID_SHIFT         16
670
671 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
672 {
673         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
674 }
675
676 static inline __u16 mirror_id_of(__u32 id)
677 {
678         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
679 }
680
681 /**
682  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
683  */
684 enum lov_comp_md_flags {
685         /* the least 2 bits are used by FLR to record file state */
686         LCM_FL_NONE          = 0,
687         LCM_FL_RDONLY           = 1,
688         LCM_FL_WRITE_PENDING    = 2,
689         LCM_FL_SYNC_PENDING     = 3,
690         LCM_FL_FLR_MASK         = 0x3,
691 };
692
693 struct lov_comp_md_v1 {
694         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
695         __u32   lcm_size;       /* overall size including this struct */
696         __u32   lcm_layout_gen;
697         __u16   lcm_flags;
698         __u16   lcm_entry_count;
699         /* lcm_mirror_count stores the number of actual mirrors minus 1,
700          * so that non-flr files will have value 0 meaning 1 mirror. */
701         __u16   lcm_mirror_count;
702         __u16   lcm_padding1[3];
703         __u64   lcm_padding2;
704         struct lov_comp_md_entry_v1 lcm_entries[0];
705 } __attribute__((packed));
706
707 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
708 {
709         if (stripes == (__u16)-1)
710                 stripes = 0;
711
712         if (lmm_magic == LOV_USER_MAGIC_V1)
713                 return sizeof(struct lov_user_md_v1) +
714                               stripes * sizeof(struct lov_user_ost_data_v1);
715         return sizeof(struct lov_user_md_v3) +
716                                 stripes * sizeof(struct lov_user_ost_data_v1);
717 }
718
719 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
720  * use this.  It is unsafe to #define those values in this header as it
721  * is possible the application has already #included <sys/stat.h>. */
722 #ifdef HAVE_LOV_USER_MDS_DATA
723 #define lov_user_mds_data lov_user_mds_data_v1
724 struct lov_user_mds_data_v1 {
725         lstat_t lmd_st;                 /* MDS stat struct */
726         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
727 } __attribute__((packed));
728 #endif
729
730 struct lmv_user_mds_data {
731         struct lu_fid   lum_fid;
732         __u32           lum_padding;
733         __u32           lum_mds;
734 };
735
736 enum lmv_hash_type {
737         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
738         LMV_HASH_TYPE_ALL_CHARS = 1,
739         LMV_HASH_TYPE_FNV_1A_64 = 2,
740         LMV_HASH_TYPE_MAX,
741 };
742
743 #define LMV_HASH_NAME_ALL_CHARS "all_char"
744 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
745
746 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
747
748 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
749  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
750 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
751 #define lmv_user_md lmv_user_md_v1
752 struct lmv_user_md_v1 {
753         __u32   lum_magic;       /* must be the first field */
754         __u32   lum_stripe_count;  /* dirstripe count */
755         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
756         __u32   lum_hash_type;     /* Dir stripe policy */
757         __u32   lum_type;         /* LMV type: default or normal */
758         __u32   lum_padding1;
759         __u32   lum_padding2;
760         __u32   lum_padding3;
761         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
762         struct  lmv_user_mds_data  lum_objects[0];
763 } __attribute__((packed));
764
765 static inline int lmv_user_md_size(int stripes, int lmm_magic)
766 {
767         int size = sizeof(struct lmv_user_md);
768
769         if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
770                 size += stripes * sizeof(struct lmv_user_mds_data);
771
772         return size;
773 }
774
775 struct ll_recreate_obj {
776         __u64 lrc_id;
777         __u32 lrc_ost_idx;
778 };
779
780 struct ll_fid {
781         __u64 id;         /* holds object id */
782         __u32 generation; /* holds object generation */
783         __u32 f_type;     /* holds object type or stripe idx when passing it to
784                            * OST for saving into EA. */
785 };
786
787 #define UUID_MAX        40
788 struct obd_uuid {
789         char uuid[UUID_MAX];
790 };
791
792 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
793                                    const struct obd_uuid *u2)
794 {
795         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
796 }
797
798 static inline int obd_uuid_empty(struct obd_uuid *uuid)
799 {
800         return uuid->uuid[0] == '\0';
801 }
802
803 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
804 {
805         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
806         uuid->uuid[sizeof(*uuid) - 1] = '\0';
807 }
808
809 /* For printf's only, make sure uuid is terminated */
810 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
811 {
812         if (uuid == NULL)
813                 return NULL;
814
815         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
816                 /* Obviously not safe, but for printfs, no real harm done...
817                    we're always null-terminated, even in a race. */
818                 static char temp[sizeof(*uuid)];
819                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
820                 temp[sizeof(*uuid) - 1] = '\0';
821                 return temp;
822         }
823         return (char *)(uuid->uuid);
824 }
825
826 #define LUSTRE_MAXFSNAME 8
827
828 /* Extract fsname from uuid (or target name) of a target
829    e.g. (myfs-OST0007_UUID -> myfs)
830    see also deuuidify. */
831 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
832 {
833         char *p;
834
835         strncpy(buf, uuid, buflen - 1);
836         buf[buflen - 1] = '\0';
837         p = strrchr(buf, '-');
838         if (p != NULL)
839                 *p = '\0';
840 }
841
842 /* printf display format for Lustre FIDs
843  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
844 #define FID_NOBRACE_LEN 40
845 #define FID_LEN (FID_NOBRACE_LEN + 2)
846 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
847 #define DFID "["DFID_NOBRACE"]"
848 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
849
850 /* scanf input parse format for fids in DFID_NOBRACE format
851  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
852  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
853 #define SFID "0x%llx:0x%x:0x%x"
854 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
855
856 /********* Quotas **********/
857
858 #define LUSTRE_QUOTABLOCK_BITS 10
859 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
860
861 static inline __u64 lustre_stoqb(size_t space)
862 {
863         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
864 }
865
866 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
867 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
868 #define Q_GETOINFO      0x800102 /* get obd quota info */
869 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
870 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
871
872 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
873 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
874 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
875 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
876 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
877 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
878 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
879 /* lustre-specific control commands */
880 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
881 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
882 #define LUSTRE_Q_GETDEFAULT  0x80000d     /* get default quota */
883 #define LUSTRE_Q_SETDEFAULT  0x80000e     /* set default quota */
884
885 /* In the current Lustre implementation, the grace time is either the time
886  * or the timestamp to be used after some quota ID exceeds the soft limt,
887  * 48 bits should be enough, its high 16 bits can be used as quota flags.
888  * */
889 #define LQUOTA_GRACE_BITS       48
890 #define LQUOTA_GRACE_MASK       ((1ULL << LQUOTA_GRACE_BITS) - 1)
891 #define LQUOTA_GRACE_MAX        LQUOTA_GRACE_MASK
892 #define LQUOTA_GRACE(t)         (t & LQUOTA_GRACE_MASK)
893 #define LQUOTA_FLAG(t)          (t >> LQUOTA_GRACE_BITS)
894 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
895
896 /* different quota flags */
897
898 /* the default quota flag, the corresponding quota ID will use the default
899  * quota setting, the hardlimit and softlimit of its quota record in the global
900  * quota file will be set to 0, the low 48 bits of the grace will be set to 0
901  * and high 16 bits will contain this flag (see above comment).
902  * */
903 #define LQUOTA_FLAG_DEFAULT     0x0001
904
905 #define ALLQUOTA 255       /* set all quota */
906 static inline char *qtype_name(int qtype)
907 {
908         switch (qtype) {
909         case USRQUOTA:
910                 return "usr";
911         case GRPQUOTA:
912                 return "grp";
913         case PRJQUOTA:
914                 return "prj";
915         }
916         return "unknown";
917 }
918
919 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
920
921 /* permission */
922 #define N_PERMS_MAX      64
923
924 struct perm_downcall_data {
925         __u64 pdd_nid;
926         __u32 pdd_perm;
927         __u32 pdd_padding;
928 };
929
930 struct identity_downcall_data {
931         __u32                            idd_magic;
932         __u32                            idd_err;
933         __u32                            idd_uid;
934         __u32                            idd_gid;
935         __u32                            idd_nperms;
936         __u32                            idd_ngroups;
937         struct perm_downcall_data idd_perms[N_PERMS_MAX];
938         __u32                            idd_groups[0];
939 };
940
941 #ifdef NEED_QUOTA_DEFS
942 #ifndef QIF_BLIMITS
943 #define QIF_BLIMITS     1
944 #define QIF_SPACE       2
945 #define QIF_ILIMITS     4
946 #define QIF_INODES      8
947 #define QIF_BTIME       16
948 #define QIF_ITIME       32
949 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
950 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
951 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
952 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
953 #endif
954
955 #endif /* !__KERNEL__ */
956
957 /* lustre volatile file support
958  * file name header: ".^L^S^T^R:volatile"
959  */
960 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
961 #define LUSTRE_VOLATILE_HDR_LEN 14
962
963 enum lustre_quota_version {
964         LUSTRE_QUOTA_V2 = 1
965 };
966
967 /* XXX: same as if_dqinfo struct in kernel */
968 struct obd_dqinfo {
969         __u64 dqi_bgrace;
970         __u64 dqi_igrace;
971         __u32 dqi_flags;
972         __u32 dqi_valid;
973 };
974
975 /* XXX: same as if_dqblk struct in kernel, plus one padding */
976 struct obd_dqblk {
977         __u64 dqb_bhardlimit;
978         __u64 dqb_bsoftlimit;
979         __u64 dqb_curspace;
980         __u64 dqb_ihardlimit;
981         __u64 dqb_isoftlimit;
982         __u64 dqb_curinodes;
983         __u64 dqb_btime;
984         __u64 dqb_itime;
985         __u32 dqb_valid;
986         __u32 dqb_padding;
987 };
988
989 enum {
990         QC_GENERAL      = 0,
991         QC_MDTIDX       = 1,
992         QC_OSTIDX       = 2,
993         QC_UUID         = 3
994 };
995
996 struct if_quotactl {
997         __u32                   qc_cmd;
998         __u32                   qc_type;
999         __u32                   qc_id;
1000         __u32                   qc_stat;
1001         __u32                   qc_valid;
1002         __u32                   qc_idx;
1003         struct obd_dqinfo       qc_dqinfo;
1004         struct obd_dqblk        qc_dqblk;
1005         char                    obd_type[16];
1006         struct obd_uuid         obd_uuid;
1007 };
1008
1009 /* swap layout flags */
1010 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1011 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1012 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1013 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1014 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1015
1016 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1017 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1018 struct lustre_swap_layouts {
1019         __u64   sl_flags;
1020         __u32   sl_fd;
1021         __u32   sl_gid;
1022         __u64   sl_dv1;
1023         __u64   sl_dv2;
1024 };
1025
1026 /** Bit-mask of valid attributes */
1027 /* The LA_* flags are written to disk as part of the ChangeLog records
1028  * so they are part of the on-disk and network protocol, and cannot be changed.
1029  * Only the first 12 bits are currently saved.
1030  */
1031 enum la_valid {
1032         LA_ATIME = 1 << 0,
1033         LA_MTIME = 1 << 1,
1034         LA_CTIME = 1 << 2,
1035         LA_SIZE  = 1 << 3,
1036         LA_MODE  = 1 << 4,
1037         LA_UID   = 1 << 5,
1038         LA_GID   = 1 << 6,
1039         LA_BLOCKS = 1 << 7,
1040         LA_TYPE   = 1 << 8,
1041         LA_FLAGS  = 1 << 9,
1042         LA_NLINK  = 1 << 10,
1043         LA_RDEV   = 1 << 11,
1044         LA_BLKSIZE = 1 << 12,
1045         LA_KILL_SUID = 1 << 13,
1046         LA_KILL_SGID = 1 << 14,
1047         LA_PROJID    = 1 << 15,
1048         LA_LAYOUT_VERSION = 1 << 16,
1049         LA_LSIZE = 1 << 17,
1050         LA_LBLOCKS = 1 << 18,
1051         /**
1052          * Attributes must be transmitted to OST objects
1053          */
1054         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1055 };
1056
1057 #define MDS_FMODE_READ           00000001
1058 #define MDS_FMODE_WRITE          00000002
1059
1060 #define MDS_FMODE_CLOSED         00000000
1061 #define MDS_FMODE_EXEC           00000004
1062 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1063 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1064 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1065
1066 #define MDS_OPEN_CREATED         00000010
1067 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1068
1069 #define MDS_OPEN_CREAT           00000100
1070 #define MDS_OPEN_EXCL            00000200
1071 #define MDS_OPEN_TRUNC           00001000
1072 #define MDS_OPEN_APPEND          00002000
1073 #define MDS_OPEN_SYNC            00010000
1074 #define MDS_OPEN_DIRECTORY       00200000
1075
1076 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1077 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1078 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1079 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1080                                            * We do not support JOIN FILE
1081                                            * anymore, reserve this flags
1082                                            * just for preventing such bit
1083                                            * to be reused. */
1084
1085 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1086 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1087 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1088 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1089 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1090                                               * hsm restore) */
1091 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1092                                                 unlinked */
1093 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1094                                               * delegation, succeed if it's not
1095                                               * being opened with conflict mode.
1096                                               */
1097 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1098
1099 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1100
1101 /* lustre internal open flags, which should not be set from user space */
1102 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1103                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1104                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1105                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1106
1107
1108 /********* Changelogs **********/
1109 /** Changelog record types */
1110 enum changelog_rec_type {
1111         CL_NONE     = -1,
1112         CL_MARK     = 0,
1113         CL_CREATE   = 1,  /* namespace */
1114         CL_MKDIR    = 2,  /* namespace */
1115         CL_HARDLINK = 3,  /* namespace */
1116         CL_SOFTLINK = 4,  /* namespace */
1117         CL_MKNOD    = 5,  /* namespace */
1118         CL_UNLINK   = 6,  /* namespace */
1119         CL_RMDIR    = 7,  /* namespace */
1120         CL_RENAME   = 8,  /* namespace */
1121         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1122         CL_OPEN     = 10, /* not currently used */
1123         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1124         CL_LAYOUT   = 12, /* file layout/striping modified */
1125         CL_TRUNC    = 13,
1126         CL_SETATTR  = 14,
1127         CL_SETXATTR = 15,
1128         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1129         CL_HSM      = 16, /* HSM specific events, see flags */
1130         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1131         CL_CTIME    = 18,
1132         CL_ATIME    = 19,
1133         CL_MIGRATE  = 20,
1134         CL_FLRW     = 21, /* FLR: file was firstly written */
1135         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1136         CL_GETXATTR = 23,
1137         CL_DN_OPEN  = 24, /* denied open */
1138         CL_LAST
1139 };
1140
1141 static inline const char *changelog_type2str(int type) {
1142         static const char *changelog_str[] = {
1143                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1144                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1145                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1146                 "FLRW",  "RESYNC","GXATR", "NOPEN",
1147         };
1148
1149         if (type >= 0 && type < CL_LAST)
1150                 return changelog_str[type];
1151         return NULL;
1152 }
1153
1154 /* 12 bits of per-record data can be stored in the bottom of the flags */
1155 #define CLF_FLAGSHIFT   12
1156 enum changelog_rec_flags {
1157         CLF_VERSION     = 0x1000,
1158         CLF_RENAME      = 0x2000,
1159         CLF_JOBID       = 0x4000,
1160         CLF_EXTRA_FLAGS = 0x8000,
1161         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1162                           CLF_EXTRA_FLAGS,
1163         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1164         CLF_VERMASK     = ~CLF_FLAGMASK,
1165 };
1166
1167
1168 /* Anything under the flagmask may be per-type (if desired) */
1169 /* Flags for unlink */
1170 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1171 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1172                                      /* HSM cleaning needed */
1173 /* Flags for rename */
1174 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1175                                         * of target */
1176 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1177                                         * has an archive in backend */
1178
1179 /* Flags for HSM */
1180 /* 12b used (from high weight to low weight):
1181  * 2b for flags
1182  * 3b for event
1183  * 7b for error code
1184  */
1185 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1186 #define CLF_HSM_ERR_H        6
1187 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1188 #define CLF_HSM_EVENT_H      9
1189 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1190 #define CLF_HSM_FLAG_H      11
1191 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1192 #define CLF_HSM_SPARE_H     15
1193 #define CLF_HSM_LAST        15
1194
1195 /* Remove bits higher than _h, then extract the value
1196  * between _h and _l by shifting lower weigth to bit 0. */
1197 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1198                                    >> (CLF_HSM_LAST - _h + _l))
1199
1200 #define CLF_HSM_SUCCESS      0x00
1201 #define CLF_HSM_MAXERROR     0x7E
1202 #define CLF_HSM_ERROVERFLOW  0x7F
1203
1204 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1205
1206 /* 3 bits field => 8 values allowed */
1207 enum hsm_event {
1208         HE_ARCHIVE      = 0,
1209         HE_RESTORE      = 1,
1210         HE_CANCEL       = 2,
1211         HE_RELEASE      = 3,
1212         HE_REMOVE       = 4,
1213         HE_STATE        = 5,
1214         HE_SPARE1       = 6,
1215         HE_SPARE2       = 7,
1216 };
1217
1218 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1219 {
1220         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1221                                             CLF_HSM_EVENT_L);
1222 }
1223
1224 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1225                                     enum hsm_event he)
1226 {
1227         *clf_flags |= (he << CLF_HSM_EVENT_L);
1228 }
1229
1230 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1231 {
1232         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1233 }
1234
1235 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1236                                     unsigned int bits)
1237 {
1238         *clf_flags |= (bits << CLF_HSM_FLAG_L);
1239 }
1240
1241 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1242 {
1243         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1244 }
1245
1246 static inline void hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1247                                     unsigned int error)
1248 {
1249         *clf_flags |= (error << CLF_HSM_ERR_L);
1250 }
1251
1252 enum changelog_rec_extra_flags {
1253         CLFE_INVALID    = 0,
1254         CLFE_UIDGID     = 0x0001,
1255         CLFE_NID        = 0x0002,
1256         CLFE_OPEN       = 0x0004,
1257         CLFE_XATTR      = 0x0008,
1258         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1259 };
1260
1261 enum changelog_send_flag {
1262         /* Not yet implemented */
1263         CHANGELOG_FLAG_FOLLOW      = 0x01,
1264         /* Blocking IO makes sense in case of slow user parsing of the records,
1265          * but it also prevents us from cleaning up if the records are not
1266          * consumed. */
1267         CHANGELOG_FLAG_BLOCK       = 0x02,
1268         /* Pack jobid into the changelog records if available. */
1269         CHANGELOG_FLAG_JOBID       = 0x04,
1270         /* Pack additional flag bits into the changelog record */
1271         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1272 };
1273
1274 enum changelog_send_extra_flag {
1275         /* Pack uid/gid into the changelog record */
1276         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1277         /* Pack nid into the changelog record */
1278         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1279         /* Pack open mode into the changelog record */
1280         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1281         /* Pack xattr name into the changelog record */
1282         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1283 };
1284
1285 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1286                                   changelog_rec_offset(CLF_SUPPORTED, \
1287                                                        CLFE_SUPPORTED), 8)
1288
1289 /* 31 usable bytes string + null terminator. */
1290 #define LUSTRE_JOBID_SIZE       32
1291
1292 /* This is the minimal changelog record. It can contain extensions
1293  * such as rename fields or process jobid. Its exact content is described
1294  * by the cr_flags and cr_extra_flags.
1295  *
1296  * Extensions are packed in the same order as their corresponding flags,
1297  * then in the same order as their corresponding extra flags.
1298  */
1299 struct changelog_rec {
1300         __u16                   cr_namelen;
1301         __u16                   cr_flags; /**< \a changelog_rec_flags */
1302         __u32                   cr_type;  /**< \a changelog_rec_type */
1303         __u64                   cr_index; /**< changelog record number */
1304         __u64                   cr_prev;  /**< last index for this target fid */
1305         __u64                   cr_time;
1306         union {
1307                 struct lu_fid   cr_tfid;        /**< target fid */
1308                 __u32           cr_markerflags; /**< CL_MARK flags */
1309         };
1310         struct lu_fid           cr_pfid;        /**< parent fid */
1311 };
1312
1313 /* Changelog extension for RENAME. */
1314 struct changelog_ext_rename {
1315         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1316         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1317 };
1318
1319 /* Changelog extension to include JOBID. */
1320 struct changelog_ext_jobid {
1321         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1322 };
1323
1324 /* Changelog extension to include additional flags. */
1325 struct changelog_ext_extra_flags {
1326         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1327 };
1328
1329 /* Changelog extra extension to include UID/GID. */
1330 struct changelog_ext_uidgid {
1331         __u64   cr_uid;
1332         __u64   cr_gid;
1333 };
1334
1335 /* Changelog extra extension to include NID. */
1336 struct changelog_ext_nid {
1337         /* have __u64 instead of lnet_nid_t type for use by client api */
1338         __u64 cr_nid;
1339         /* for use when IPv6 support is added */
1340         __u64 extra;
1341         __u32 padding;
1342 };
1343
1344 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1345 struct changelog_ext_openmode {
1346         __u32 cr_openflags;
1347 };
1348
1349 /* Changelog extra extension to include xattr */
1350 struct changelog_ext_xattr {
1351         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1352 };
1353
1354 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1355         const struct changelog_rec *rec);
1356
1357 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1358                                           enum changelog_rec_extra_flags cref)
1359 {
1360         size_t size = sizeof(struct changelog_rec);
1361
1362         if (crf & CLF_RENAME)
1363                 size += sizeof(struct changelog_ext_rename);
1364
1365         if (crf & CLF_JOBID)
1366                 size += sizeof(struct changelog_ext_jobid);
1367
1368         if (crf & CLF_EXTRA_FLAGS) {
1369                 size += sizeof(struct changelog_ext_extra_flags);
1370                 if (cref & CLFE_UIDGID)
1371                         size += sizeof(struct changelog_ext_uidgid);
1372                 if (cref & CLFE_NID)
1373                         size += sizeof(struct changelog_ext_nid);
1374                 if (cref & CLFE_OPEN)
1375                         size += sizeof(struct changelog_ext_openmode);
1376                 if (cref & CLFE_XATTR)
1377                         size += sizeof(struct changelog_ext_xattr);
1378         }
1379
1380         return size;
1381 }
1382
1383 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1384 {
1385         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1386
1387         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1388                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1389
1390         return changelog_rec_offset(rec->cr_flags, cref);
1391 }
1392
1393 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1394 {
1395         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1396 }
1397
1398 static inline
1399 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1400 {
1401         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1402
1403         return (struct changelog_ext_rename *)((char *)rec +
1404                                                changelog_rec_offset(crf,
1405                                                                  CLFE_INVALID));
1406 }
1407
1408 /* The jobid follows the rename extension, if present */
1409 static inline
1410 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1411 {
1412         enum changelog_rec_flags crf = rec->cr_flags &
1413                                         (CLF_VERSION | CLF_RENAME);
1414
1415         return (struct changelog_ext_jobid *)((char *)rec +
1416                                               changelog_rec_offset(crf,
1417                                                                  CLFE_INVALID));
1418 }
1419
1420 /* The additional flags follow the rename and jobid extensions, if present */
1421 static inline
1422 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1423         const struct changelog_rec *rec)
1424 {
1425         enum changelog_rec_flags crf = rec->cr_flags &
1426                 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1427
1428         return (struct changelog_ext_extra_flags *)((char *)rec +
1429                                                  changelog_rec_offset(crf,
1430                                                                  CLFE_INVALID));
1431 }
1432
1433 /* The uid/gid is the first extra extension */
1434 static inline
1435 struct changelog_ext_uidgid *changelog_rec_uidgid(
1436         const struct changelog_rec *rec)
1437 {
1438         enum changelog_rec_flags crf = rec->cr_flags &
1439                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1440
1441         return (struct changelog_ext_uidgid *)((char *)rec +
1442                                                changelog_rec_offset(crf,
1443                                                                  CLFE_INVALID));
1444 }
1445
1446 /* The nid is the second extra extension */
1447 static inline
1448 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1449 {
1450         enum changelog_rec_flags crf = rec->cr_flags &
1451                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1452         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1453
1454         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1455                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1456                        CLFE_UIDGID;
1457
1458         return (struct changelog_ext_nid *)((char *)rec +
1459                                             changelog_rec_offset(crf, cref));
1460 }
1461
1462 /* The OPEN mode is the third extra extension */
1463 static inline
1464 struct changelog_ext_openmode *changelog_rec_openmode(
1465         const struct changelog_rec *rec)
1466 {
1467         enum changelog_rec_flags crf = rec->cr_flags &
1468                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1469         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1470
1471         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1472                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1473                        (CLFE_UIDGID | CLFE_NID);
1474
1475         return (struct changelog_ext_openmode *)((char *)rec +
1476                                                changelog_rec_offset(crf, cref));
1477 }
1478
1479 /* The xattr name is the fourth extra extension */
1480 static inline
1481 struct changelog_ext_xattr *changelog_rec_xattr(
1482         const struct changelog_rec *rec)
1483 {
1484         enum changelog_rec_flags crf = rec->cr_flags &
1485                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1486         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1487
1488         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1489                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1490                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1491
1492         return (struct changelog_ext_xattr *)((char *)rec +
1493                                               changelog_rec_offset(crf, cref));
1494 }
1495
1496 /* The name follows the rename, jobid  and extra flags extns, if present */
1497 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1498 {
1499         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1500
1501         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1502                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1503
1504         return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1505                                                   cref & CLFE_SUPPORTED);
1506 }
1507
1508 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1509 {
1510         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1511 }
1512
1513 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1514 {
1515         char *cr_name = changelog_rec_name(rec);
1516
1517         return cr_name + strlen(cr_name) + 1;
1518 }
1519
1520 /**
1521  * Remap a record to the desired format as specified by the crf flags.
1522  * The record must be big enough to contain the final remapped version.
1523  * Superfluous extension fields are removed and missing ones are added
1524  * and zeroed. The flags of the record are updated accordingly.
1525  *
1526  * The jobid and rename extensions can be added to a record, to match the
1527  * format an application expects, typically. In this case, the newly added
1528  * fields will be zeroed.
1529  * The Jobid field can be removed, to guarantee compatibility with older
1530  * clients that don't expect this field in the records they process.
1531  *
1532  * The following assumptions are being made:
1533  *   - CLF_RENAME will not be removed
1534  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1535  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1536  *
1537  * @param[in,out]  rec         The record to remap.
1538  * @param[in]      crf_wanted  Flags describing the desired extensions.
1539  * @param[in]      cref_want   Flags describing the desired extra extensions.
1540  */
1541 static inline void changelog_remap_rec(struct changelog_rec *rec,
1542                                        enum changelog_rec_flags crf_wanted,
1543                                        enum changelog_rec_extra_flags cref_want)
1544 {
1545         char *xattr_mov = NULL;
1546         char *omd_mov = NULL;
1547         char *nid_mov = NULL;
1548         char *uidgid_mov = NULL;
1549         char *ef_mov;
1550         char *jid_mov;
1551         char *rnm_mov;
1552         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1553
1554         crf_wanted &= CLF_SUPPORTED;
1555         cref_want &= CLFE_SUPPORTED;
1556
1557         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1558                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1559                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
1560                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1561                                                         CLFE_SUPPORTED) ==
1562                                                                      cref_want))
1563                         return;
1564         }
1565
1566         /* First move the variable-length name field */
1567         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1568                 changelog_rec_name(rec), rec->cr_namelen);
1569
1570         /* Locations of extensions in the remapped record */
1571         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1572                 xattr_mov = (char *)rec +
1573                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1574                                              cref_want & ~CLFE_XATTR);
1575                 omd_mov = (char *)rec +
1576                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1577                                              cref_want & ~(CLFE_OPEN |
1578                                                            CLFE_XATTR));
1579                 nid_mov = (char *)rec +
1580                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1581                                              cref_want & ~(CLFE_NID |
1582                                                            CLFE_OPEN |
1583                                                            CLFE_XATTR));
1584                 uidgid_mov = (char *)rec +
1585                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1586                                              cref_want & ~(CLFE_UIDGID |
1587                                                            CLFE_NID |
1588                                                            CLFE_OPEN |
1589                                                            CLFE_XATTR));
1590                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1591         }
1592
1593         ef_mov  = (char *)rec +
1594                   changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1595                                        CLFE_INVALID);
1596         jid_mov = (char *)rec +
1597                   changelog_rec_offset(crf_wanted &
1598                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1599                                        CLFE_INVALID);
1600         rnm_mov = (char *)rec +
1601                   changelog_rec_offset(crf_wanted &
1602                                        ~(CLF_EXTRA_FLAGS |
1603                                          CLF_JOBID |
1604                                          CLF_RENAME),
1605                                        CLFE_INVALID);
1606
1607         /* Move the extension fields to the desired positions */
1608         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1609             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1610                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1611                         memmove(xattr_mov, changelog_rec_xattr(rec),
1612                                 sizeof(struct changelog_ext_xattr));
1613
1614                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1615                         memmove(omd_mov, changelog_rec_openmode(rec),
1616                                 sizeof(struct changelog_ext_openmode));
1617
1618                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1619                         memmove(nid_mov, changelog_rec_nid(rec),
1620                                 sizeof(struct changelog_ext_nid));
1621
1622                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1623                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
1624                                 sizeof(struct changelog_ext_uidgid));
1625
1626                 memmove(ef_mov, changelog_rec_extra_flags(rec),
1627                         sizeof(struct changelog_ext_extra_flags));
1628         }
1629
1630         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1631                 memmove(jid_mov, changelog_rec_jobid(rec),
1632                         sizeof(struct changelog_ext_jobid));
1633
1634         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1635                 memmove(rnm_mov, changelog_rec_rename(rec),
1636                         sizeof(struct changelog_ext_rename));
1637
1638         /* Clear newly added fields */
1639         if (xattr_mov && (cref_want & CLFE_XATTR) &&
1640             !(cref & CLFE_XATTR))
1641                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1642
1643         if (omd_mov && (cref_want & CLFE_OPEN) &&
1644             !(cref & CLFE_OPEN))
1645                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1646
1647         if (nid_mov && (cref_want & CLFE_NID) &&
1648             !(cref & CLFE_NID))
1649                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1650
1651         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1652             !(cref & CLFE_UIDGID))
1653                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1654
1655         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1656             !(rec->cr_flags & CLF_EXTRA_FLAGS))
1657                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1658
1659         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1660                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1661
1662         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1663                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1664
1665         /* Update the record's flags accordingly */
1666         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1667         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1668                 changelog_rec_extra_flags(rec)->cr_extra_flags =
1669                         changelog_rec_extra_flags(rec)->cr_extra_flags |
1670                         cref_want;
1671 }
1672
1673 enum changelog_message_type {
1674         CL_RECORD = 10, /* message is a changelog_rec */
1675         CL_EOF    = 11, /* at end of current changelog */
1676 };
1677
1678 /********* Misc **********/
1679
1680 struct ioc_data_version {
1681         __u64   idv_version;
1682         __u32   idv_layout_version; /* FLR: layout version for OST objects */
1683         __u32   idv_flags;      /* enum ioc_data_version_flags */
1684 };
1685
1686 enum ioc_data_version_flags {
1687         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
1688         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
1689 };
1690
1691 #ifndef offsetof
1692 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1693 #endif
1694
1695 #define dot_lustre_name ".lustre"
1696
1697
1698 /********* HSM **********/
1699
1700 /** HSM per-file state
1701  * See HSM_FLAGS below.
1702  */
1703 enum hsm_states {
1704         HS_NONE         = 0x00000000,
1705         HS_EXISTS       = 0x00000001,
1706         HS_DIRTY        = 0x00000002,
1707         HS_RELEASED     = 0x00000004,
1708         HS_ARCHIVED     = 0x00000008,
1709         HS_NORELEASE    = 0x00000010,
1710         HS_NOARCHIVE    = 0x00000020,
1711         HS_LOST         = 0x00000040,
1712 };
1713
1714 /* HSM user-setable flags. */
1715 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1716
1717 /* Other HSM flags. */
1718 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1719
1720 /*
1721  * All HSM-related possible flags that could be applied to a file.
1722  * This should be kept in sync with hsm_states.
1723  */
1724 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1725
1726 /**
1727  * HSM request progress state
1728  */
1729 enum hsm_progress_states {
1730         HPS_NONE        = 0,
1731         HPS_WAITING     = 1,
1732         HPS_RUNNING     = 2,
1733         HPS_DONE        = 3,
1734 };
1735
1736 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1737 {
1738         switch  (s) {
1739         case HPS_WAITING:       return "waiting";
1740         case HPS_RUNNING:       return "running";
1741         case HPS_DONE:          return "done";
1742         default:                return "unknown";
1743         }
1744 }
1745
1746 struct hsm_extent {
1747         __u64 offset;
1748         __u64 length;
1749 } __attribute__((packed));
1750
1751 /**
1752  * Current HSM states of a Lustre file.
1753  *
1754  * This structure purpose is to be sent to user-space mainly. It describes the
1755  * current HSM flags and in-progress action.
1756  */
1757 struct hsm_user_state {
1758         /** Current HSM states, from enum hsm_states. */
1759         __u32                   hus_states;
1760         __u32                   hus_archive_id;
1761         /**  The current undergoing action, if there is one */
1762         __u32                   hus_in_progress_state;
1763         __u32                   hus_in_progress_action;
1764         struct hsm_extent       hus_in_progress_location;
1765         char                    hus_extended_info[];
1766 };
1767
1768 struct hsm_state_set_ioc {
1769         struct lu_fid   hssi_fid;
1770         __u64           hssi_setmask;
1771         __u64           hssi_clearmask;
1772 };
1773
1774 /*
1775  * This structure describes the current in-progress action for a file.
1776  * it is retuned to user space and send over the wire
1777  */
1778 struct hsm_current_action {
1779         /**  The current undergoing action, if there is one */
1780         /* state is one of hsm_progress_states */
1781         __u32                   hca_state;
1782         /* action is one of hsm_user_action */
1783         __u32                   hca_action;
1784         struct hsm_extent       hca_location;
1785 };
1786
1787 /***** HSM user requests ******/
1788 /* User-generated (lfs/ioctl) request types */
1789 enum hsm_user_action {
1790         HUA_NONE    =  1, /* no action (noop) */
1791         HUA_ARCHIVE = 10, /* copy to hsm */
1792         HUA_RESTORE = 11, /* prestage */
1793         HUA_RELEASE = 12, /* drop ost objects */
1794         HUA_REMOVE  = 13, /* remove from archive */
1795         HUA_CANCEL  = 14  /* cancel a request */
1796 };
1797
1798 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1799 {
1800         switch  (a) {
1801         case HUA_NONE:    return "NOOP";
1802         case HUA_ARCHIVE: return "ARCHIVE";
1803         case HUA_RESTORE: return "RESTORE";
1804         case HUA_RELEASE: return "RELEASE";
1805         case HUA_REMOVE:  return "REMOVE";
1806         case HUA_CANCEL:  return "CANCEL";
1807         default:          return "UNKNOWN";
1808         }
1809 }
1810
1811 /*
1812  * List of hr_flags (bit field)
1813  */
1814 #define HSM_FORCE_ACTION 0x0001
1815 /* used by CT, cannot be set by user */
1816 #define HSM_GHOST_COPY   0x0002
1817
1818 /**
1819  * Contains all the fixed part of struct hsm_user_request.
1820  *
1821  */
1822 struct hsm_request {
1823         __u32 hr_action;        /* enum hsm_user_action */
1824         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1825         __u64 hr_flags;         /* request flags */
1826         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1827         __u32 hr_data_len;
1828 };
1829
1830 struct hsm_user_item {
1831        struct lu_fid        hui_fid;
1832        struct hsm_extent hui_extent;
1833 } __attribute__((packed));
1834
1835 struct hsm_user_request {
1836         struct hsm_request      hur_request;
1837         struct hsm_user_item    hur_user_item[0];
1838         /* extra data blob at end of struct (after all
1839          * hur_user_items), only use helpers to access it
1840          */
1841 } __attribute__((packed));
1842
1843 /** Return pointer to data field in a hsm user request */
1844 static inline void *hur_data(struct hsm_user_request *hur)
1845 {
1846         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1847 }
1848
1849 /**
1850  * Compute the current length of the provided hsm_user_request.  This returns -1
1851  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1852  *
1853  * return -1 on bounds check error.
1854  */
1855 static inline ssize_t hur_len(struct hsm_user_request *hur)
1856 {
1857         __u64   size;
1858
1859         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1860         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1861                 (__u64)hur->hur_request.hr_itemcount *
1862                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1863
1864         if (size != (ssize_t)size)
1865                 return -1;
1866
1867         return size;
1868 }
1869
1870 /****** HSM RPCs to copytool *****/
1871 /* Message types the copytool may receive */
1872 enum hsm_message_type {
1873         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1874 };
1875
1876 /* Actions the copytool may be instructed to take for a given action_item */
1877 enum hsm_copytool_action {
1878         HSMA_NONE    = 10, /* no action */
1879         HSMA_ARCHIVE = 20, /* arbitrary offset */
1880         HSMA_RESTORE = 21,
1881         HSMA_REMOVE  = 22,
1882         HSMA_CANCEL  = 23
1883 };
1884
1885 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1886 {
1887         switch  (a) {
1888         case HSMA_NONE:    return "NOOP";
1889         case HSMA_ARCHIVE: return "ARCHIVE";
1890         case HSMA_RESTORE: return "RESTORE";
1891         case HSMA_REMOVE:  return "REMOVE";
1892         case HSMA_CANCEL:  return "CANCEL";
1893         default:           return "UNKNOWN";
1894         }
1895 }
1896
1897 /* Copytool item action description */
1898 struct hsm_action_item {
1899         __u32      hai_len;     /* valid size of this struct */
1900         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1901         struct lu_fid hai_fid;     /* Lustre FID to operate on */
1902         struct lu_fid hai_dfid;    /* fid used for data access */
1903         struct hsm_extent hai_extent;  /* byte range to operate on */
1904         __u64      hai_cookie;  /* action cookie from coordinator */
1905         __u64      hai_gid;     /* grouplock id */
1906         char       hai_data[0]; /* variable length */
1907 } __attribute__((packed));
1908
1909 /**
1910  * helper function which print in hexa the first bytes of
1911  * hai opaque field
1912  *
1913  * \param hai [IN]        record to print
1914  * \param buffer [IN,OUT] buffer to write the hex string to
1915  * \param len [IN]        max buffer length
1916  *
1917  * \retval buffer
1918  */
1919 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1920                                         char *buffer, size_t len)
1921 {
1922         int i;
1923         int data_len;
1924         char *ptr;
1925
1926         ptr = buffer;
1927         data_len = hai->hai_len - sizeof(*hai);
1928         for (i = 0; (i < data_len) && (len > 2); i++) {
1929                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1930                 ptr += 2;
1931                 len -= 2;
1932         }
1933
1934         *ptr = '\0';
1935
1936         return buffer;
1937 }
1938
1939 /* Copytool action list */
1940 #define HAL_VERSION 1
1941 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1942 struct hsm_action_list {
1943         __u32 hal_version;
1944         __u32 hal_count;       /* number of hai's to follow */
1945         __u64 hal_compound_id; /* returned by coordinator, ignored */
1946         __u64 hal_flags;
1947         __u32 hal_archive_id; /* which archive backend */
1948         __u32 padding1;
1949         char  hal_fsname[0];   /* null-terminated */
1950         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1951            boundaries. See hai_zero */
1952 } __attribute__((packed));
1953
1954 /* Return pointer to first hai in action list */
1955 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1956 {
1957         size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1958
1959         return (struct hsm_action_item *)(hal->hal_fsname + offset);
1960 }
1961
1962 /* Return pointer to next hai */
1963 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1964 {
1965         size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
1966
1967         return (struct hsm_action_item *)((char *)hai + offset);
1968 }
1969
1970 /* Return size of an hsm_action_list */
1971 static inline size_t hal_size(struct hsm_action_list *hal)
1972 {
1973         __u32 i;
1974         size_t sz;
1975         struct hsm_action_item *hai;
1976
1977         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1978         hai = hai_first(hal);
1979         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1980                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
1981
1982         return sz;
1983 }
1984
1985 /* HSM file import
1986  * describe the attributes to be set on imported file
1987  */
1988 struct hsm_user_import {
1989         __u64           hui_size;
1990         __u64           hui_atime;
1991         __u64           hui_mtime;
1992         __u32           hui_atime_ns;
1993         __u32           hui_mtime_ns;
1994         __u32           hui_uid;
1995         __u32           hui_gid;
1996         __u32           hui_mode;
1997         __u32           hui_archive_id;
1998 };
1999
2000 /* Copytool progress reporting */
2001 #define HP_FLAG_COMPLETED 0x01
2002 #define HP_FLAG_RETRY     0x02
2003
2004 struct hsm_progress {
2005         struct lu_fid           hp_fid;
2006         __u64                   hp_cookie;
2007         struct hsm_extent       hp_extent;
2008         __u16                   hp_flags;
2009         __u16                   hp_errval; /* positive val */
2010         __u32                   padding;
2011 };
2012
2013 struct hsm_copy {
2014         __u64                   hc_data_version;
2015         __u16                   hc_flags;
2016         __u16                   hc_errval; /* positive val */
2017         __u32                   padding;
2018         struct hsm_action_item  hc_hai;
2019 };
2020
2021 /* JSON objects */
2022 enum llapi_json_types {
2023         LLAPI_JSON_INTEGER = 1,
2024         LLAPI_JSON_BIGNUM,
2025         LLAPI_JSON_REAL,
2026         LLAPI_JSON_STRING
2027 };
2028
2029 struct llapi_json_item {
2030         char                    *lji_key;
2031         __u32                   lji_type;
2032         union {
2033                 int     lji_integer;
2034                 __u64   lji_u64;
2035                 double  lji_real;
2036                 char    *lji_string;
2037         };
2038         struct llapi_json_item  *lji_next;
2039 };
2040
2041 struct llapi_json_item_list {
2042         int                     ljil_item_count;
2043         struct llapi_json_item  *ljil_items;
2044 };
2045
2046 enum lu_ladvise_type {
2047         LU_LADVISE_INVALID      = 0,
2048         LU_LADVISE_WILLREAD     = 1,
2049         LU_LADVISE_DONTNEED     = 2,
2050         LU_LADVISE_LOCKNOEXPAND = 3,
2051         LU_LADVISE_LOCKAHEAD    = 4,
2052         LU_LADVISE_MAX
2053 };
2054
2055 #define LU_LADVISE_NAMES {                                              \
2056         [LU_LADVISE_WILLREAD]           = "willread",                   \
2057         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2058         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2059         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2060 }
2061
2062 /* This is the userspace argument for ladvise.  It is currently the same as
2063  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2064  * may need info which is only used locally. */
2065 struct llapi_lu_ladvise {
2066         __u16 lla_advice;       /* advice type */
2067         __u16 lla_value1;       /* values for different advice types */
2068         __u32 lla_value2;
2069         __u64 lla_start;        /* first byte of extent for advice */
2070         __u64 lla_end;          /* last byte of extent for advice */
2071         __u32 lla_value3;
2072         __u32 lla_value4;
2073 };
2074
2075 enum ladvise_flag {
2076         LF_ASYNC        = 0x00000001,
2077         LF_UNSET        = 0x00000002,
2078 };
2079
2080 #define LADVISE_MAGIC 0x1ADF1CE0
2081 /* Masks of valid flags for each advice */
2082 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2083 /* Flags valid for all advices not explicitly specified */
2084 #define LF_DEFAULT_MASK LF_ASYNC
2085 /* All flags */
2086 #define LF_MASK (LF_ASYNC | LF_UNSET)
2087
2088 #define lla_lockahead_mode   lla_value1
2089 #define lla_peradvice_flags    lla_value2
2090 #define lla_lockahead_result lla_value3
2091
2092 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2093  * is used on the wire.  It is defined separately as we may need info which is
2094  * only used locally. */
2095 struct llapi_ladvise_hdr {
2096         __u32                   lah_magic;      /* LADVISE_MAGIC */
2097         __u32                   lah_count;      /* number of advices */
2098         __u64                   lah_flags;      /* from enum ladvise_flag */
2099         __u32                   lah_value1;     /* unused */
2100         __u32                   lah_value2;     /* unused */
2101         __u64                   lah_value3;     /* unused */
2102         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2103 };
2104
2105 #define LAH_COUNT_MAX   (1024)
2106
2107 /* Shared key */
2108 enum sk_crypt_alg {
2109         SK_CRYPT_INVALID        = -1,
2110         SK_CRYPT_EMPTY          = 0,
2111         SK_CRYPT_AES256_CTR     = 1,
2112 };
2113
2114 enum sk_hmac_alg {
2115         SK_HMAC_INVALID = -1,
2116         SK_HMAC_EMPTY   = 0,
2117         SK_HMAC_SHA256  = 1,
2118         SK_HMAC_SHA512  = 2,
2119 };
2120
2121 struct sk_crypt_type {
2122         const char     *sct_name;
2123         int             sct_type;
2124 };
2125
2126 struct sk_hmac_type {
2127         const char     *sht_name;
2128         int             sht_type;
2129 };
2130
2131 enum lock_mode_user {
2132         MODE_READ_USER = 1,
2133         MODE_WRITE_USER,
2134         MODE_MAX_USER,
2135 };
2136
2137 #define LOCK_MODE_NAMES { \
2138         [MODE_READ_USER]  = "READ",\
2139         [MODE_WRITE_USER] = "WRITE"\
2140 }
2141
2142 enum lockahead_results {
2143         LLA_RESULT_SENT = 0,
2144         LLA_RESULT_DIFFERENT,
2145         LLA_RESULT_SAME,
2146 };
2147
2148 #if defined(__cplusplus)
2149 }
2150 #endif
2151
2152 /** @} lustreuser */
2153
2154 #endif /* _LUSTRE_USER_H */