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