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