Whamcloud - gitweb
1051c9ab1d039800ec7edd166399ac2adee72650
[fs/lustre-release.git] / lustre / include / 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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2010, 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre/lustre_user.h
37  *
38  * Lustre public user-space interface definitions.
39  */
40
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
43
44 /** \defgroup lustreuser lustreuser
45  *
46  * @{
47  */
48
49 #ifndef __KERNEL__
50 #include <libcfs/posix/posix-types.h>
51 #endif
52 #include <lustre/ll_fiemap.h>
53 #if defined(__linux__)
54 #include <linux/lustre_user.h>
55 #elif defined(__APPLE__)
56 #include <darwin/lustre_user.h>
57 #elif defined(__WINNT__)
58 #include <winnt/lustre_user.h>
59 #else
60 #error Unsupported operating system.
61 #endif
62
63 /* for statfs() */
64 #define LL_SUPER_MAGIC 0x0BD00BD0
65
66 #ifndef FSFILT_IOC_GETFLAGS
67 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
68 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
69 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
70 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
71 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
72 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
73 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
74 #endif
75
76 /* FIEMAP flags supported by Lustre */
77 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
78
79 enum obd_statfs_state {
80         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
81         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
82         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
83         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
84         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
85 };
86
87 struct obd_statfs {
88         __u64           os_type;
89         __u64           os_blocks;
90         __u64           os_bfree;
91         __u64           os_bavail;
92         __u64           os_files;
93         __u64           os_ffree;
94         __u8            os_fsid[40];
95         __u32           os_bsize;
96         __u32           os_namelen;
97         __u64           os_maxbytes;
98         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
99         __u32           os_fprecreated; /* objs available now to the caller */
100                                         /* used in QoS code to find preferred
101                                          * OSTs */
102         __u32           os_spare2;
103         __u32           os_spare3;
104         __u32           os_spare4;
105         __u32           os_spare5;
106         __u32           os_spare6;
107         __u32           os_spare7;
108         __u32           os_spare8;
109         __u32           os_spare9;
110 };
111
112 /**
113  * File IDentifier.
114  *
115  * FID is a cluster-wide unique identifier of a file or an object (stripe).
116  * FIDs are never reused.
117  **/
118 struct lu_fid {
119        /**
120         * FID sequence. Sequence is a unit of migration: all files (objects)
121         * with FIDs from a given sequence are stored on the same server.
122         * Lustre should support 2^64 objects, so even if each sequence
123         * has only a single object we can still enumerate 2^64 objects.
124         **/
125         __u64 f_seq;
126         /* FID number within sequence. */
127         __u32 f_oid;
128         /**
129          * FID version, used to distinguish different versions (in the sense
130          * of snapshots, etc.) of the same file system object. Not currently
131          * used.
132          **/
133         __u32 f_ver;
134 };
135
136 struct filter_fid {
137         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
138         __u64      ff_objid;
139         __u64      ff_seq;
140 };
141
142 /* Userspace should treat lu_fid as opaque, and only use the following methods
143  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
144  * here from lustre_idl.h if needed. */
145 typedef struct lu_fid lustre_fid;
146
147 /*
148  * The ioctl naming rules:
149  * LL_*     - works on the currently opened filehandle instead of parent dir
150  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
151  * *_MDC_*  - gets/sets data related to MDC
152  * *_LOV_*  - gets/sets data related to OSC/LOV
153  * *FILE*   - called on parent dir and passes in a filename
154  * *STRIPE* - set/get lov_user_md
155  * *INFO    - set/get lov_user_mds_data
156  */
157 /* see <lustre_lib.h> for ioctl numberss 101-150 */
158 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
159 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
160 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
161 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
162 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
163 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
164 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
165 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
166 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
167 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
168 #define LL_IOC_RECREATE_FID             _IOW ('f', 157, struct lu_fid)
169 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
170 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
171 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
172 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
173 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
174 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
175 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
176 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl)
177 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
178 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
179 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
180 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
181 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
182 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
183 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
184 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
185 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
186 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
187 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
188 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
189
190 /* see <lustre_lib.h> for ioctl numbers 177-210 */
191
192 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
193 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
194 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
195 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
196 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
197 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
198 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
199 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
200 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
201                                                 struct lustre_swap_layouts)
202 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
203                                                 struct hsm_current_action)
204 /* see <lustre_lib.h> for ioctl numbers 221-232 */
205
206 #define LL_IOC_LMV_SETSTRIPE        _IOWR('f', 240, struct lmv_user_md)
207 #define LL_IOC_LMV_GETSTRIPE        _IOWR('f', 241, struct lmv_user_md)
208 #define LL_IOC_REMOVE_ENTRY         _IOWR('f', 242, __u64)
209
210 #define LL_STATFS_LMV           1
211 #define LL_STATFS_LOV           2
212 #define LL_STATFS_NODELAY       4
213
214 #define IOC_MDC_TYPE            'i'
215 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
216 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
217 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
218 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
219
220 /* Keep these for backward compartability. */
221 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
222 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
223
224
225 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
226
227 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
228  * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
229  * which was added since kernel 2.6.36, so we redefine it as 020000000.
230  * To be compatible with old version's statically linked binary, finally we
231  * define it as (020000000 | 0100000000).
232  * */
233 #define O_LOV_DELAY_CREATE      0120000000
234
235 #define LL_FILE_IGNORE_LOCK     0x00000001
236 #define LL_FILE_GROUP_LOCKED    0x00000002
237 #define LL_FILE_READAHEA        0x00000004
238 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
239 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
240 #define LL_FILE_RMTACL          0x00000020
241
242 #define LOV_USER_MAGIC_V1 0x0BD10BD0
243 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
244 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
245 #define LOV_USER_MAGIC_V3 0x0BD30BD0
246
247 #define LMV_MAGIC_V1      0x0CD10CD0    /*normal stripe lmv magic */
248 #define LMV_USER_MAGIC    0x0CD20CD0    /*default lmv magic*/
249
250 #define LOV_PATTERN_RAID0 0x001
251 #define LOV_PATTERN_RAID1 0x002
252 #define LOV_PATTERN_FIRST 0x100
253
254 #define LOV_MAXPOOLNAME 16
255 #define LOV_POOLNAMEF "%.16s"
256
257 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
258 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
259 #define LOV_MAX_STRIPE_COUNT_OLD 160
260 /* This calculation is crafted so that input of 4096 will result in 160
261  * which in turn is equal to old maximal stripe count.
262  * XXX: In fact this is too simpified for now, what it also need is to get
263  * ea_type argument to clearly know how much space each stripe consumes.
264  *
265  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
266  * allocation that is sufficient for the current generation of systems.
267  *
268  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
269 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
270 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
271 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
272
273 #define lov_user_ost_data lov_user_ost_data_v1
274 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
275         __u64 l_object_id;        /* OST object ID */
276         __u64 l_object_seq;       /* OST object seq number */
277         __u32 l_ost_gen;          /* generation of this OST index */
278         __u32 l_ost_idx;          /* OST index in LOV */
279 } __attribute__((packed));
280
281 #define lov_user_md lov_user_md_v1
282 #define lmm_stripe_offset u.lum_stripe_offset
283 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
284         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
285         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
286         __u64 lmm_object_id;      /* LOV object ID */
287         __u64 lmm_object_seq;     /* LOV object seq */
288         __u32 lmm_stripe_size;    /* size of stripe in bytes */
289         __u16 lmm_stripe_count;   /* num stripes in use for this object */
290         union {
291                 __u16 lum_stripe_offset;  /* starting stripe offset in
292                                            * lmm_objects, use when writing */
293                 __u16 lum_layout_gen;     /* layout generation number
294                                            * used when reading */
295         } u;
296         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
297 } __attribute__((packed,  __may_alias__));
298
299 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
300         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
301         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
302         __u64 lmm_object_id;      /* LOV object ID */
303         __u64 lmm_object_seq;     /* LOV object seq */
304         __u32 lmm_stripe_size;    /* size of stripe in bytes */
305         __u16 lmm_stripe_count;   /* num stripes in use for this object */
306         union {
307                 __u16 lum_stripe_offset;  /* starting stripe offset in
308                                            * lmm_objects, use when writing */
309                 __u16 lum_layout_gen;     /* layout generation number
310                                            * used when reading */
311         } u;
312         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
313         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
314 } __attribute__((packed));
315
316 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
317  * use this.  It is unsafe to #define those values in this header as it
318  * is possible the application has already #included <sys/stat.h>. */
319 #ifdef HAVE_LOV_USER_MDS_DATA
320 #define lov_user_mds_data lov_user_mds_data_v1
321 struct lov_user_mds_data_v1 {
322         lstat_t lmd_st;                 /* MDS stat struct */
323         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
324 } __attribute__((packed));
325
326 struct lov_user_mds_data_v3 {
327         lstat_t lmd_st;                 /* MDS stat struct */
328         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
329 } __attribute__((packed));
330 #endif
331
332 /* keep this to be the same size as lov_user_ost_data_v1 */
333 struct lmv_user_mds_data {
334         struct lu_fid   lum_fid;
335         __u32           lum_padding;
336         __u32           lum_mds;
337 };
338
339 /* lum_type */
340 enum {
341         LMV_STRIPE_TYPE = 0,
342         LMV_DEFAULT_TYPE = 1,
343 };
344
345 #define lmv_user_md lmv_user_md_v1
346 struct lmv_user_md_v1 {
347         __u32   lum_magic;       /* must be the first field */
348         __u32   lum_stripe_count;  /* dirstripe count */
349         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
350         __u32   lum_hash_type;     /* Dir stripe policy */
351         __u32   lum_type;         /* LMV type: default or normal */
352         __u32   lum_padding1;
353         __u32   lum_padding2;
354         __u32   lum_padding3;
355         char    lum_pool_name[LOV_MAXPOOLNAME];
356         struct  lmv_user_mds_data  lum_objects[0];
357 };
358
359 static inline int lmv_user_md_size(int stripes, int lmm_magic)
360 {
361         return sizeof(struct lmv_user_md) +
362                       stripes * sizeof(struct lmv_user_mds_data);
363 }
364
365 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
366
367 struct ll_recreate_obj {
368         __u64 lrc_id;
369         __u32 lrc_ost_idx;
370 };
371
372 struct ll_fid {
373         __u64 id;         /* holds object id */
374         __u32 generation; /* holds object generation */
375         __u32 f_type;     /* holds object type or stripe idx when passing it to
376                            * OST for saving into EA. */
377 };
378
379 #define UUID_MAX        40
380 struct obd_uuid {
381         char uuid[UUID_MAX];
382 };
383
384 static inline int obd_uuid_equals(const struct obd_uuid *u1,
385                                   const struct obd_uuid *u2)
386 {
387         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
388 }
389
390 static inline int obd_uuid_empty(struct obd_uuid *uuid)
391 {
392         return uuid->uuid[0] == '\0';
393 }
394
395 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
396 {
397         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
398         uuid->uuid[sizeof(*uuid) - 1] = '\0';
399 }
400
401 /* For printf's only, make sure uuid is terminated */
402 static inline char *obd_uuid2str(struct obd_uuid *uuid)
403 {
404         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
405                 /* Obviously not safe, but for printfs, no real harm done...
406                    we're always null-terminated, even in a race. */
407                 static char temp[sizeof(*uuid)];
408                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
409                 temp[sizeof(*uuid) - 1] = '\0';
410                 return temp;
411         }
412         return (char *)(uuid->uuid);
413 }
414
415 /* Extract fsname from uuid (or target name) of a target
416    e.g. (myfs-OST0007_UUID -> myfs)
417    see also deuuidify. */
418 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
419 {
420         char *p;
421
422         strncpy(buf, uuid, buflen - 1);
423         buf[buflen - 1] = '\0';
424         p = strrchr(buf, '-');
425         if (p)
426            *p = '\0';
427 }
428
429 /* printf display format
430    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
431 #define DFID_NOBRACE LPX64":0x%x:0x%x"
432 #define DFID "["DFID_NOBRACE"]"
433 #define PFID(fid)     \
434         (fid)->f_seq, \
435         (fid)->f_oid, \
436         (fid)->f_ver
437
438 /* scanf input parse format -- strip '[' first.
439    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
440 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
441 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
442 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
443 */
444 #define SFID "0x"LPX64i":0x%x:0x%x"
445 #define RFID(fid)     \
446         &((fid)->f_seq), \
447         &((fid)->f_oid), \
448         &((fid)->f_ver)
449
450
451 /********* Quotas **********/
452
453 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
454 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
455 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
456 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
457 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
458 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
459 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
460 /* lustre-specific control commands */
461 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
462 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
463
464 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
465
466 struct if_quotacheck {
467         char                    obd_type[16];
468         struct obd_uuid         obd_uuid;
469 };
470
471 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
472
473 /* permission */
474 #define N_PERMS_MAX      64
475
476 struct perm_downcall_data {
477         __u64 pdd_nid;
478         __u32 pdd_perm;
479         __u32 pdd_padding;
480 };
481
482 struct identity_downcall_data {
483         __u32                            idd_magic;
484         __u32                            idd_err;
485         __u32                            idd_uid;
486         __u32                            idd_gid;
487         __u32                            idd_nperms;
488         __u32                            idd_ngroups;
489         struct perm_downcall_data idd_perms[N_PERMS_MAX];
490         __u32                            idd_groups[0];
491 };
492
493 /* for non-mapped uid/gid */
494 #define NOBODY_UID      99
495 #define NOBODY_GID      99
496
497 #define INVALID_ID      (-1)
498
499 enum {
500         RMT_LSETFACL    = 1,
501         RMT_LGETFACL    = 2,
502         RMT_RSETFACL    = 3,
503         RMT_RGETFACL    = 4
504 };
505
506 #ifdef NEED_QUOTA_DEFS
507 #ifndef QIF_BLIMITS
508 #define QIF_BLIMITS     1
509 #define QIF_SPACE       2
510 #define QIF_ILIMITS     4
511 #define QIF_INODES      8
512 #define QIF_BTIME       16
513 #define QIF_ITIME       32
514 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
515 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
516 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
517 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
518 #endif
519
520 #endif /* !__KERNEL__ */
521
522 /* lustre volatile file support
523  * file name header: .^L^S^T^R:volatile"
524  */
525 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
526 #define LUSTRE_VOLATILE_HDR_LEN 14
527 /* hdr + MDT index */
528 #define LUSTRE_VOLATILE_IDX     LUSTRE_VOLATILE_HDR":%.4X:"
529
530 typedef enum lustre_quota_version {
531         LUSTRE_QUOTA_V2 = 1
532 } lustre_quota_version_t;
533
534 /* XXX: same as if_dqinfo struct in kernel */
535 struct obd_dqinfo {
536         __u64 dqi_bgrace;
537         __u64 dqi_igrace;
538         __u32 dqi_flags;
539         __u32 dqi_valid;
540 };
541
542 /* XXX: same as if_dqblk struct in kernel, plus one padding */
543 struct obd_dqblk {
544         __u64 dqb_bhardlimit;
545         __u64 dqb_bsoftlimit;
546         __u64 dqb_curspace;
547         __u64 dqb_ihardlimit;
548         __u64 dqb_isoftlimit;
549         __u64 dqb_curinodes;
550         __u64 dqb_btime;
551         __u64 dqb_itime;
552         __u32 dqb_valid;
553         __u32 dqb_padding;
554 };
555
556 enum {
557         QC_GENERAL      = 0,
558         QC_MDTIDX       = 1,
559         QC_OSTIDX       = 2,
560         QC_UUID         = 3
561 };
562
563 struct if_quotactl {
564         __u32                   qc_cmd;
565         __u32                   qc_type;
566         __u32                   qc_id;
567         __u32                   qc_stat;
568         __u32                   qc_valid;
569         __u32                   qc_idx;
570         struct obd_dqinfo       qc_dqinfo;
571         struct obd_dqblk        qc_dqblk;
572         char                    obd_type[16];
573         struct obd_uuid         obd_uuid;
574 };
575
576 struct lustre_swap_layouts {
577         __u64   sl_flags;
578         __u32   sl_fd;
579         __u32   sl_gid;
580 };
581
582
583 /********* Changelogs **********/
584 /** Changelog record types */
585 enum changelog_rec_type {
586         CL_MARK     = 0,
587         CL_CREATE   = 1,  /* namespace */
588         CL_MKDIR    = 2,  /* namespace */
589         CL_HARDLINK = 3,  /* namespace */
590         CL_SOFTLINK = 4,  /* namespace */
591         CL_MKNOD    = 5,  /* namespace */
592         CL_UNLINK   = 6,  /* namespace */
593         CL_RMDIR    = 7,  /* namespace */
594         CL_RENAME   = 8,  /* namespace */
595         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
596         CL_OPEN     = 10, /* not currently used */
597         CL_CLOSE    = 11, /* may be written to log only with mtime change */
598         CL_IOCTL    = 12,
599         CL_TRUNC    = 13,
600         CL_SETATTR  = 14,
601         CL_XATTR    = 15,
602         CL_HSM      = 16, /* HSM specific events, see flags */
603         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
604         CL_CTIME    = 18,
605         CL_ATIME    = 19,
606         CL_LAST
607 };
608
609 static inline const char *changelog_type2str(int type) {
610         static const char *changelog_str[] = {
611                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
612                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "IOCTL", "TRUNC",
613                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME"  };
614         if (type >= 0 && type < CL_LAST)
615                 return changelog_str[type];
616         return NULL;
617 }
618
619 /* per-record flags */
620 #define CLF_VERSION     0x1000
621 #define CLF_EXT_VERSION 0x2000
622 #define CLF_FLAGSHIFT   12
623 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
624 #define CLF_VERMASK     (~CLF_FLAGMASK)
625 /* Anything under the flagmask may be per-type (if desired) */
626 /* Flags for unlink */
627 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
628 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
629                                      /* HSM cleaning needed */
630 /* Flags for rename */
631 #define CLF_RENAME_LAST       0x0001 /* rename unlink last hardlink of target */
632
633 /* Flags for HSM */
634 /* 12b used (from high weight to low weight):
635  * 2b for flags
636  * 3b for event
637  * 7b for error code
638  */
639 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
640 #define CLF_HSM_ERR_H        6
641 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
642 #define CLF_HSM_EVENT_H      9
643 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
644 #define CLF_HSM_FLAG_H      11
645 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
646 #define CLF_HSM_SPARE_H     15
647 #define CLF_HSM_LAST        15
648
649 /* Remove bits higher than _h, then extract the value
650  * between _h and _l by shifting lower weigth to bit 0. */
651 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
652                                    >> (CLF_HSM_LAST - _h + _l))
653
654 #define CLF_HSM_SUCCESS      0x00
655 #define CLF_HSM_MAXERROR     0x7E
656 #define CLF_HSM_ERROVERFLOW  0x7F
657
658 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
659
660 /* 3 bits field => 8 values allowed */
661 enum hsm_event {
662         HE_ARCHIVE      = 0,
663         HE_RESTORE      = 1,
664         HE_CANCEL       = 2,
665         HE_RELEASE      = 3,
666         HE_REMOVE       = 4,
667         HE_STATE        = 5,
668         HE_SPARE1       = 6,
669         HE_SPARE2       = 7,
670 };
671
672 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
673 {
674         return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
675 }
676
677 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
678 {
679         *flags |= (he << CLF_HSM_EVENT_L);
680 }
681
682 static inline __u16 hsm_get_cl_flags(int flags)
683 {
684         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
685 }
686
687 static inline void hsm_set_cl_flags(int *flags, int bits)
688 {
689         *flags |= (bits << CLF_HSM_FLAG_L);
690 }
691
692 static inline int hsm_get_cl_error(int flags)
693 {
694         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
695 }
696
697 static inline void hsm_set_cl_error(int *flags, int error)
698 {
699         *flags |= (error << CLF_HSM_ERR_L);
700 }
701
702 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
703
704 struct changelog_rec {
705         __u16                 cr_namelen;
706         __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
707         __u32                 cr_type;  /**< \a changelog_rec_type */
708         __u64                 cr_index; /**< changelog record number */
709         __u64                 cr_prev;  /**< last index for this target fid */
710         __u64                 cr_time;
711         union {
712                 lustre_fid    cr_tfid;        /**< target fid */
713                 __u32         cr_markerflags; /**< CL_MARK flags */
714         };
715         lustre_fid            cr_pfid;        /**< parent fid */
716         char                  cr_name[0];     /**< last element */
717 } __attribute__((packed));
718
719 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
720  * space, only rename uses changelog_ext_rec, while others use changelog_rec to
721  * store records.
722  */
723 struct changelog_ext_rec {
724         __u16                   cr_namelen;
725         __u16                   cr_flags; /**< (flags & CLF_FLAGMASK) |
726                                                 CLF_EXT_VERSION */
727         __u32                   cr_type;  /**< \a changelog_rec_type */
728         __u64                   cr_index; /**< changelog record number */
729         __u64                   cr_prev;  /**< last index for this target fid */
730         __u64                   cr_time;
731         union {
732                 lustre_fid      cr_tfid;        /**< target fid */
733                 __u32           cr_markerflags; /**< CL_MARK flags */
734         };
735         lustre_fid              cr_pfid;        /**< target parent fid */
736         lustre_fid              cr_sfid;        /**< source fid, or zero */
737         lustre_fid              cr_spfid;       /**< source parent fid, or zero */
738         char                    cr_name[0];     /**< last element */
739 } __attribute__((packed));
740
741 #define CHANGELOG_REC_EXTENDED(rec) \
742         (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
743
744 static inline int changelog_rec_size(struct changelog_rec *rec)
745 {
746         return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
747                                              sizeof(*rec);
748 }
749
750 static inline char *changelog_rec_name(struct changelog_rec *rec)
751 {
752         return CHANGELOG_REC_EXTENDED(rec) ?
753                 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
754 }
755
756 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
757 {
758         return rec->cr_namelen - strlen(rec->cr_name) - 1;
759 }
760
761 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
762 {
763         return rec->cr_name + strlen(rec->cr_name) + 1;
764 }
765
766 struct ioc_changelog {
767         __u64 icc_recno;
768         __u32 icc_mdtindex;
769         __u32 icc_id;
770         __u32 icc_flags;
771 };
772
773 enum changelog_message_type {
774         CL_RECORD = 10, /* message is a changelog_rec */
775         CL_EOF    = 11, /* at end of current changelog */
776 };
777
778 /********* Misc **********/
779
780 struct ioc_data_version {
781         __u64 idv_version;
782         __u64 idv_flags;     /* See LL_DV_xxx */
783 };
784 #define LL_DV_NOFLUSH 0x01   /* Do not take READ EXTENT LOCK before sampling
785                                 version. Dirty caches are left unchanged. */
786
787 #ifndef offsetof
788 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
789 #endif
790
791 #define dot_lustre_name ".lustre"
792
793
794 /********* HSM **********/
795
796 /** HSM per-file state
797  * See HSM_FLAGS below.
798  */
799 enum hsm_states {
800         HS_EXISTS       = 0x00000001,
801         HS_DIRTY        = 0x00000002,
802         HS_RELEASED     = 0x00000004,
803         HS_ARCHIVED     = 0x00000008,
804         HS_NORELEASE    = 0x00000010,
805         HS_NOARCHIVE    = 0x00000020,
806         HS_LOST         = 0x00000040,
807 };
808
809 /* HSM user-setable flags. */
810 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
811
812 /* Other HSM flags. */
813 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
814
815 /*
816  * All HSM-related possible flags that could be applied to a file.
817  * This should be kept in sync with hsm_states.
818  */
819 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
820
821 /**
822  * HSM request progress state
823  */
824 enum hsm_progress_states {
825         HPS_WAITING     = 1,
826         HPS_RUNNING     = 2,
827         HPS_DONE        = 3,
828 };
829 #define HPS_NONE        0
830
831 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
832 {
833         switch  (s) {
834         case HPS_WAITING:       return "waiting";
835         case HPS_RUNNING:       return "running";
836         case HPS_DONE:          return "done";
837         default:                return "unknown";
838         }
839 }
840
841 struct hsm_extent {
842         __u64 offset;
843         __u64 length;
844 } __attribute__((packed));
845
846 /**
847  * Current HSM states of a Lustre file.
848  *
849  * This structure purpose is to be sent to user-space mainly. It describes the
850  * current HSM flags and in-progress action.
851  */
852 struct hsm_user_state {
853         /** Current HSM states, from enum hsm_states. */
854         __u32                   hus_states;
855         __u32                   hus_archive_id;
856         /**  The current undergoing action, if there is one */
857         __u32                   hus_in_progress_state;
858         __u32                   hus_in_progress_action;
859         struct hsm_extent       hus_in_progress_location;
860         char                    hus_extended_info[];
861 };
862
863 struct hsm_state_set_ioc {
864         struct lu_fid   hssi_fid;
865         __u64           hssi_setmask;
866         __u64           hssi_clearmask;
867 };
868
869 /*
870  * This structure describes the current in-progress action for a file.
871  * it is retuned to user space and send over the wire
872  */
873 struct hsm_current_action {
874         /**  The current undergoing action, if there is one */
875         /* state is one of hsm_progress_states */
876         __u32                   hca_state;
877         /* action is one of hsm_user_action */
878         __u32                   hca_action;
879         struct hsm_extent       hca_location;
880 };
881
882 /***** HSM user requests ******/
883 /* User-generated (lfs/ioctl) request types */
884 enum hsm_user_action {
885         HUA_NONE    =  1, /* no action (noop) */
886         HUA_ARCHIVE = 10, /* copy to hsm */
887         HUA_RESTORE = 11, /* prestage */
888         HUA_RELEASE = 12, /* drop ost objects */
889         HUA_REMOVE  = 13, /* remove from archive */
890         HUA_CANCEL  = 14  /* cancel a request */
891 };
892
893 static inline char *hsm_user_action2name(enum hsm_user_action  a)
894 {
895         switch  (a) {
896         case HUA_NONE:    return "NOOP";
897         case HUA_ARCHIVE: return "ARCHIVE";
898         case HUA_RESTORE: return "RESTORE";
899         case HUA_RELEASE: return "RELEASE";
900         case HUA_REMOVE:  return "REMOVE";
901         case HUA_CANCEL:  return "CANCEL";
902         default:          return "UNKNOWN";
903         }
904 }
905
906 /*
907  * List of hr_flags (bit field)
908  */
909 #define HSM_FORCE_ACTION 0x0001
910 /* used by CT, connot be set by user */
911 #define HSM_GHOST_COPY   0x0002
912
913 /**
914  * Contains all the fixed part of struct hsm_user_request.
915  *
916  */
917 struct hsm_request {
918         __u32 hr_action;        /* enum hsm_user_action */
919         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
920         __u64 hr_flags;         /* request flags */
921         __u32 hr_itemcount;     /* item count in hur_user_item vector */
922         __u32 hr_data_len;
923 };
924
925 struct hsm_user_item {
926        lustre_fid        hui_fid;
927        struct hsm_extent hui_extent;
928 } __attribute__((packed));
929
930 struct hsm_user_request {
931         struct hsm_request      hur_request;
932         struct hsm_user_item    hur_user_item[0];
933         /* extra data blob at end of struct (after all
934          * hur_user_items), only use helpers to access it
935          */
936 } __attribute__((packed));
937
938 /** Return pointer to data field in a hsm user request */
939 static inline void *hur_data(struct hsm_user_request *hur)
940 {
941         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
942 }
943
944 /** Compute the current length of the provided hsm_user_request. */
945 static inline int hur_len(struct hsm_user_request *hur)
946 {
947         int data_offset;
948
949         data_offset = hur_data(hur) - (void *)hur;
950         data_offset += hur->hur_request.hr_data_len;
951         return data_offset;
952 }
953
954 /****** HSM RPCs to copytool *****/
955 /* Message types the copytool may receive */
956 enum hsm_message_type {
957         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
958 };
959
960 /* Actions the copytool may be instructed to take for a given action_item */
961 enum hsm_copytool_action {
962         HSMA_NONE    = 10, /* no action */
963         HSMA_ARCHIVE = 20, /* arbitrary offset */
964         HSMA_RESTORE = 21,
965         HSMA_REMOVE  = 22,
966         HSMA_CANCEL  = 23
967 };
968
969 static inline char *hsm_copytool_action2name(enum hsm_copytool_action  a)
970 {
971         switch  (a) {
972         case HSMA_NONE:    return "NOOP";
973         case HSMA_ARCHIVE: return "ARCHIVE";
974         case HSMA_RESTORE: return "RESTORE";
975         case HSMA_REMOVE:  return "REMOVE";
976         case HSMA_CANCEL:  return "CANCEL";
977         default:           return "UNKNOWN";
978         }
979 }
980
981 /* Copytool item action description */
982 struct hsm_action_item {
983         __u32      hai_len;     /* valid size of this struct */
984         __u32      hai_action;  /* hsm_copytool_action, but use known size */
985         lustre_fid hai_fid;     /* Lustre FID to operated on */
986         lustre_fid hai_dfid;    /* fid used for data access */
987         struct hsm_extent hai_extent;  /* byte range to operate on */
988         __u64      hai_cookie;  /* action cookie from coordinator */
989         __u64      hai_gid;     /* grouplock id */
990         char       hai_data[0]; /* variable length */
991 } __attribute__((packed));
992
993 /*
994  * helper function which print in hexa the first bytes of
995  * hai opaque field
996  * \param hai [IN] record to print
997  * \param buffer [OUT] output buffer
998  * \param len [IN] max buffer len
999  * \retval buffer
1000  */
1001 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
1002                                         char *buffer, int len)
1003 {
1004         int i, sz, data_len;
1005         char *ptr;
1006
1007         ptr = buffer;
1008         sz = len;
1009         data_len = hai->hai_len - sizeof(*hai);
1010         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1011         {
1012                 int cnt;
1013
1014                 cnt = snprintf(ptr, sz, "%.2X",
1015                                (unsigned char)hai->hai_data[i]);
1016                 ptr += cnt;
1017                 sz -= cnt;
1018         }
1019         *ptr = '\0';
1020         return buffer;
1021 }
1022
1023 /* Copytool action list */
1024 #define HAL_VERSION 1
1025 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1026 struct hsm_action_list {
1027         __u32 hal_version;
1028         __u32 hal_count;       /* number of hai's to follow */
1029         __u64 hal_compound_id; /* returned by coordinator */
1030         __u64 hal_flags;
1031         __u32 hal_archive_id; /* which archive backend */
1032         __u32 padding1;
1033         char  hal_fsname[0];   /* null-terminated */
1034         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1035            boundaries. See hai_zero */
1036 } __attribute__((packed));
1037
1038 #ifndef HAVE_CFS_SIZE_ROUND
1039 static inline int cfs_size_round (int val)
1040 {
1041         return (val + 7) & (~0x7);
1042 }
1043 #define HAVE_CFS_SIZE_ROUND
1044 #endif
1045
1046 /* Return pointer to first hai in action list */
1047 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
1048 {
1049         return (struct hsm_action_item *)(hal->hal_fsname +
1050                                           cfs_size_round(strlen(hal-> \
1051                                                                 hal_fsname)));
1052 }
1053 /* Return pointer to next hai */
1054 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1055 {
1056         return (struct hsm_action_item *)((char *)hai +
1057                                           cfs_size_round(hai->hai_len));
1058 }
1059
1060 /* Return size of an hsm_action_list */
1061 static inline int hal_size(struct hsm_action_list *hal)
1062 {
1063         int i, sz;
1064         struct hsm_action_item *hai;
1065
1066         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
1067         hai = hai_zero(hal);
1068         for (i = 0 ; i < hal->hal_count ; i++) {
1069                 sz += cfs_size_round(hai->hai_len);
1070                 hai = hai_next(hai);
1071         }
1072         return(sz);
1073 }
1074
1075 /* Copytool progress reporting */
1076 #define HP_FLAG_COMPLETED 0x01
1077 #define HP_FLAG_RETRY     0x02
1078
1079 struct hsm_progress {
1080         lustre_fid              hp_fid;
1081         __u64                   hp_cookie;
1082         struct hsm_extent       hp_extent;
1083         __u16                   hp_flags;
1084         __u16                   hp_errval; /* positive val */
1085         __u32                   padding;
1086 };
1087
1088 /**
1089  * Use by copytool during any hsm request they handled.
1090  * This structure is initialized by llapi_hsm_copy_start()
1091  * which is an helper over the ioctl() interface
1092  * Store Lustre, internal use only, data.
1093  */
1094 struct hsm_copy {
1095         __u64                   hc_data_version;
1096         __u16                   hc_flags;
1097         __u16                   hc_errval; /* positive val */
1098         __u32                   padding;
1099         struct hsm_action_item  hc_hai;
1100 };
1101
1102 /** @} lustreuser */
1103
1104 #endif /* _LUSTRE_USER_H */