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