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