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