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