1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_user.h
38 * Lustre public user-space interface definitions.
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
44 /** \defgroup lustreuser lustreuser
49 #include <lustre/ll_fiemap.h>
50 #if defined(__linux__)
51 #include <linux/lustre_user.h>
52 #elif defined(__APPLE__)
53 #include <darwin/lustre_user.h>
54 #elif defined(__WINNT__)
55 #include <winnt/lustre_user.h>
57 #error Unsupported operating system.
61 #define LL_SUPER_MAGIC 0x0BD00BD0
63 #ifndef FSFILT_IOC_GETFLAGS
64 #define FSFILT_IOC_GETFLAGS _IOR('f', 1, long)
65 #define FSFILT_IOC_SETFLAGS _IOW('f', 2, long)
66 #define FSFILT_IOC_GETVERSION _IOR('f', 3, long)
67 #define FSFILT_IOC_SETVERSION _IOW('f', 4, long)
68 #define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long)
69 #define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long)
70 #define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap)
73 /* FIEMAP flags supported by Lustre */
74 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
76 enum obd_statfs_state {
77 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */
78 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */
79 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
80 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
81 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
95 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */
109 * The ioctl naming rules:
110 * LL_* - works on the currently opened filehandle instead of parent dir
111 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
112 * *_MDC_* - gets/sets data related to MDC
113 * *_LOV_* - gets/sets data related to OSC/LOV
114 * *FILE* - called on parent dir and passes in a filename
115 * *STRIPE* - set/get lov_user_md
116 * *INFO - set/get lov_user_mds_data
118 /* see <lustre_obd.h> for ioctl numberss 101-150 */
119 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
120 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
121 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
122 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
123 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
124 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
125 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
126 #define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid)
127 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
128 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
129 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
130 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
131 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl *)
132 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
133 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
134 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
135 #define LL_IOC_RMTACL _IOW ('f', 167, long)
136 #define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long)
137 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
138 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
139 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, long)
140 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
141 #define LL_IOC_PATH2FID _IOR ('f', 173, long)
142 #define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *)
143 #define LL_IOC_GET_MDTIDX _IOR ('f', 175, int)
144 #define LL_IOC_HSM_CT_START _IOW ('f', 176,struct lustre_kernelcomm)
145 /* see <lustre_obd.h> for ioctl numbers 177-210 */
148 #define LL_STATFS_MDC 1
149 #define LL_STATFS_LOV 2
151 #define IOC_MDC_TYPE 'i'
152 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
153 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
154 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
155 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
157 /* Keep these for backward compartability. */
158 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
159 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
161 #define O_LOV_DELAY_CREATE 0100000000 /* hopefully this does not conflict */
163 #define LL_FILE_IGNORE_LOCK 0x00000001
164 #define LL_FILE_GROUP_LOCKED 0x00000002
165 #define LL_FILE_READAHEAD 0x00000004
166 #define LL_FILE_RMTACL 0x00000008
168 #define LOV_USER_MAGIC_V1 0x0BD10BD0
169 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
170 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
171 #define LOV_USER_MAGIC_V3 0x0BD30BD0
173 #define LOV_PATTERN_RAID0 0x001
174 #define LOV_PATTERN_RAID1 0x002
175 #define LOV_PATTERN_FIRST 0x100
177 #define LOV_MAXPOOLNAME 16
178 #define LOV_POOLNAMEF "%.16s"
180 #define lov_user_ost_data lov_user_ost_data_v1
181 struct lov_user_ost_data_v1 { /* per-stripe data structure */
182 __u64 l_object_id; /* OST object ID */
183 __u64 l_object_seq; /* OST object seq number */
184 __u32 l_ost_gen; /* generation of this OST index */
185 __u32 l_ost_idx; /* OST index in LOV */
186 } __attribute__((packed));
188 #define lov_user_md lov_user_md_v1
189 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
190 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
191 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
192 __u64 lmm_object_id; /* LOV object ID */
193 __u64 lmm_object_seq; /* LOV object seq */
194 __u32 lmm_stripe_size; /* size of stripe in bytes */
195 __u16 lmm_stripe_count; /* num stripes in use for this object */
196 __u16 lmm_stripe_offset; /* starting stripe offset in lmm_objects */
197 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
198 } __attribute__((packed, __may_alias__));
200 struct lov_user_md_v3 { /* LOV EA user data (host-endian) */
201 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */
202 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
203 __u64 lmm_object_id; /* LOV object ID */
204 __u64 lmm_object_seq; /* LOV object seq */
205 __u32 lmm_stripe_size; /* size of stripe in bytes */
206 __u16 lmm_stripe_count; /* num stripes in use for this object */
207 __u16 lmm_stripe_offset; /* starting stripe offset in lmm_objects */
208 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
209 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
210 } __attribute__((packed));
212 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
213 * use this. It is unsafe to #define those values in this header as it
214 * is possible the application has already #included <sys/stat.h>. */
215 #ifdef HAVE_LOV_USER_MDS_DATA
216 #define lov_user_mds_data lov_user_mds_data_v1
217 struct lov_user_mds_data_v1 {
218 lstat_t lmd_st; /* MDS stat struct */
219 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */
220 } __attribute__((packed));
222 struct lov_user_mds_data_v3 {
223 lstat_t lmd_st; /* MDS stat struct */
224 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */
225 } __attribute__((packed));
228 struct ll_recreate_obj {
234 __u64 id; /* holds object id */
235 __u32 generation; /* holds object generation */
236 __u32 f_type; /* holds object type or stripe idx when passing it to
237 * OST for saving into EA. */
244 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
246 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
249 static inline int obd_uuid_empty(struct obd_uuid *uuid)
251 return uuid->uuid[0] == '\0';
254 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
256 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
257 uuid->uuid[sizeof(*uuid) - 1] = '\0';
260 /* For printf's only, make sure uuid is terminated */
261 static inline char *obd_uuid2str(struct obd_uuid *uuid)
263 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
264 /* Obviously not safe, but for printfs, no real harm done...
265 we're always null-terminated, even in a race. */
266 static char temp[sizeof(*uuid)];
267 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
268 temp[sizeof(*uuid) - 1] = '\0';
271 return (char *)(uuid->uuid);
274 /* Extract fsname from uuid (or target name) of a target
275 e.g. (myfs-OST0007_UUID -> myfs)
276 see also deuuidify. */
277 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
281 strncpy(buf, uuid, buflen - 1);
282 buf[buflen - 1] = '\0';
283 p = strrchr(buf, '-');
291 * FID is a cluster-wide unique identifier of a file or an object (stripe).
292 * FIDs are never reused.
296 * FID sequence. Sequence is a unit of migration: all files (objects)
297 * with FIDs from a given sequence are stored on the same server.
298 * Lustre should support 2^64 objects, so even if each sequence
299 * has only a single object we can still enumerate 2^64 objects.
302 /** FID number within sequence. */
305 * FID version, used to distinguish different versions (in the sense
306 * of snapshots, etc.) of the same file system object. Not currently
313 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */
318 /* Userspace should treat lu_fid as opaque, and only use the following methods
319 to print or parse them. Other functions (e.g. compare, swab) could be moved
320 here from lustre_idl.h if needed. */
321 typedef struct lu_fid lustre_fid;
323 /* printf display format
324 e.g. printf("file FID is "DFID"\n", PFID(fid)); */
325 #define DFID "["LPX64":0x%x:0x%x]"
331 /* scanf input parse format -- strip '[' first.
332 e.g. sscanf(fidstr, SFID, RFID(&fid)); */
333 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
334 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
335 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
337 #define SFID "0x"LPX64i":0x%x:0x%x"
344 /********* Quotas **********/
346 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
347 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
348 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
349 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
350 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
351 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
352 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
353 /* lustre-specific control commands */
354 #define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */
355 #define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */
357 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
359 struct if_quotacheck {
361 struct obd_uuid obd_uuid;
364 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
367 #define N_PERMS_MAX 64
369 struct perm_downcall_data {
374 struct identity_downcall_data {
380 struct perm_downcall_data idd_perms[N_PERMS_MAX];
385 /* for non-mapped uid/gid */
386 #define NOBODY_UID 99
387 #define NOBODY_GID 99
389 #define INVALID_ID (-1)
398 #ifdef NEED_QUOTA_DEFS
400 #define QIF_BLIMITS 1
402 #define QIF_ILIMITS 4
406 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
407 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
408 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
409 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
412 #endif /* !__KERNEL__ */
414 typedef enum lustre_quota_version {
416 } lustre_quota_version_t;
418 /* XXX: same as if_dqinfo struct in kernel */
426 /* XXX: same as if_dqblk struct in kernel, plus one padding */
428 __u64 dqb_bhardlimit;
429 __u64 dqb_bsoftlimit;
431 __u64 dqb_ihardlimit;
432 __u64 dqb_isoftlimit;
454 struct obd_dqinfo qc_dqinfo;
455 struct obd_dqblk qc_dqblk;
457 struct obd_uuid obd_uuid;
461 /********* Changelogs **********/
462 /** Changelog record types */
463 enum changelog_rec_type {
465 CL_CREATE = 1, /* namespace */
466 CL_MKDIR = 2, /* namespace */
467 CL_HARDLINK = 3, /* namespace */
468 CL_SOFTLINK = 4, /* namespace */
469 CL_MKNOD = 5, /* namespace */
470 CL_UNLINK = 6, /* namespace */
471 CL_RMDIR = 7, /* namespace */
472 CL_RENAME = 8, /* namespace */
473 CL_EXT = 9, /* namespace extended record (2nd half of rename) */
474 CL_OPEN = 10, /* not currently used */
475 CL_CLOSE = 11, /* may be written to log only with mtime change */
480 CL_HSM = 16, /* HSM specific events, see flags */
481 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */
487 static inline const char *changelog_type2str(int type) {
488 static const char *changelog_str[] = {
489 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
490 "RMDIR", "RNMFM", "RNMTO", "OPEN", "CLOSE", "IOCTL", "TRUNC",
491 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME" };
492 if (type >= 0 && type < CL_LAST)
493 return changelog_str[type];
497 /* per-record flags */
498 #define CLF_VERSION 0x1000
499 #define CLF_FLAGMASK 0x0FFF
500 /* Anything under the flagmask may be per-type (if desired) */
502 #define CR_MAXSIZE (PATH_MAX + sizeof(struct changelog_rec))
503 struct changelog_rec {
505 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
506 __u32 cr_type; /**< \a changelog_rec_type */
507 __u64 cr_index; /**< changelog record number */
508 __u64 cr_prev; /**< last index for this target fid */
511 lustre_fid cr_tfid; /**< target fid */
512 __u32 cr_markerflags; /**< CL_MARK flags */
514 lustre_fid cr_pfid; /**< parent fid */
515 char cr_name[0]; /**< last element */
516 } __attribute__((packed));
518 struct ioc_changelog {
525 enum changelog_message_type {
526 CL_RECORD = 10, /* message is a changelog_rec */
527 CL_EOF = 11, /* at end of current changelog */
530 /********* Misc **********/
533 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
536 #define dot_lustre_name ".lustre"
539 /********* HSM **********/
542 #define HSM_FLAGS_MASK 0
545 enum hsm_message_type {
546 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
549 /* User-generated (ioctl) request types */
551 HSMR_ARCHIVE = 10, /* copy to hsm */
552 HSMR_RESTORE = 11, /* prestage */
553 HSMR_RELEASE = 12, /* drop ost objects */
554 HSMR_REMOVE = 13, /* remove from archive */
558 /* Copytool commands */
560 HSMA_ARCHIVE = 20, /* arbitrary offset */
566 /* Copytool item action description */
567 struct hsm_action_item {
568 __u32 hai_len; /* valid size of this struct */
569 __u32 hai_action; /* enum actually, but use known size */
570 lustre_fid hai_fid; /* Lustre FID to operated on */
571 __u64 hai_cookie; /* action cookie from coordinator */
572 __u64 hai_extent_start; /* byte range to operate on */
573 __u64 hai_extent_end;
574 __u64 hai_gid; /* grouplock id */
575 char hai_data[0]; /* variable length */
576 } __attribute__((packed));
578 /* Copytool action list */
579 #define HAL_VERSION 1
580 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
581 struct hsm_action_list {
583 __u32 hal_count; /* number of hai's to follow */
584 __u32 hal_archive_num; /* which archive backend */
586 char hal_fsname[0]; /* null-terminated */
587 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
588 boundaries. See hai_zero */
589 } __attribute__((packed));
591 /* Return pointer to first hai in action list */
592 static __inline__ struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
594 return (struct hsm_action_item *)(hal->hal_fsname +
595 cfs_size_round(strlen(hal-> \
598 /* Return pointer to next hai */
599 static __inline__ struct hsm_action_item * hai_next(struct hsm_action_item *hai)
601 return (struct hsm_action_item *)((char *)hai +
602 cfs_size_round(hai->hai_len));
607 #endif /* _LUSTRE_USER_H */