2 * Copyright (c) 1995-2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * SGI's XFS filesystem's major stuff (constants, structures)
26 * Direct I/O attribute record used with XFS_IOC_DIOINFO
27 * d_miniosz is the min xfer size, xfer size multiple and file seek offset
32 __u32 d_mem; /* data buffer memory alignment */
33 __u32 d_miniosz; /* min xfer size */
34 __u32 d_maxiosz; /* max xfer size */
39 * Structure for XFS_IOC_FSGETXATTR[A] and XFS_IOC_FSSETXATTR.
43 __u32 fsx_xflags; /* xflags field value (get/set) */
44 __u32 fsx_extsize; /* extsize field value (get/set)*/
45 __u32 fsx_nextents; /* nextents field value (get) */
46 __u32 fsx_projid; /* project identifier (get/set) */
47 unsigned char fsx_pad[12];
52 * Flags for the bs_xflags/fsx_xflags field
53 * There should be a one-to-one correspondence between these flags and the
56 #define XFS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
57 #define XFS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
58 #define XFS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
59 #define XFS_XFLAG_APPEND 0x00000010 /* all writes append */
60 #define XFS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
61 #define XFS_XFLAG_NOATIME 0x00000040 /* do not update access time */
62 #define XFS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
63 #define XFS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
64 #define XFS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
65 #define XFS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
66 #define XFS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
67 #define XFS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
68 #define XFS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
69 #define XFS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */
70 #define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
73 * Structure for XFS_IOC_GETBMAP.
74 * On input, fill in bmv_offset and bmv_length of the first structure
75 * to indicate the area of interest in the file, and bmv_entries with
76 * the number of array elements given back. The first structure is
77 * updated on return to give the offset and length for the next call.
81 __s64 bmv_offset; /* file offset of segment in blocks */
82 __s64 bmv_block; /* starting block (64-bit daddr_t) */
83 __s64 bmv_length; /* length of segment, blocks */
84 __s32 bmv_count; /* # of entries in array incl. 1st */
85 __s32 bmv_entries; /* # of entries filled in (output) */
90 * Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
91 * are used exactly as in the getbmap structure. The getbmapx structure
92 * has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
93 * is only used for the first structure. It contains input flags
94 * specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
95 * in by the XFS_IOC_GETBMAPX command for each returned structure after
100 __s64 bmv_offset; /* file offset of segment in blocks */
101 __s64 bmv_block; /* starting block (64-bit daddr_t) */
102 __s64 bmv_length; /* length of segment, blocks */
103 __s32 bmv_count; /* # of entries in array incl. 1st */
104 __s32 bmv_entries; /* # of entries filled in (output). */
105 __s32 bmv_iflags; /* input flags (1st structure) */
106 __s32 bmv_oflags; /* output flags (after 1st structure)*/
107 __s32 bmv_unused1; /* future use */
108 __s32 bmv_unused2; /* future use */
112 /* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
113 #define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
114 #define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
115 #define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
116 #define BMV_IF_DELALLOC 0x8 /* rtn status BMV_OF_DELALLOC if req */
117 #define BMV_IF_NO_HOLES 0x10 /* Do not return holes */
118 #define BMV_IF_VALID \
119 (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC| \
120 BMV_IF_DELALLOC|BMV_IF_NO_HOLES)
122 /* bmv_oflags values - returned for each non-header segment */
123 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
124 #define BMV_OF_DELALLOC 0x2 /* segment = delayed allocation */
125 #define BMV_OF_LAST 0x4 /* segment is the last in the file */
128 * Structure for XFS_IOC_FSSETDM.
129 * For use by backup and restore programs to set the XFS on-disk inode
130 * fields di_dmevmask and di_dmstate. These must be set to exactly and
131 * only values previously obtained via xfs_bulkstat! (Specifically the
132 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
134 #ifndef HAVE_FSDMIDATA
136 __u32 fsd_dmevmask; /* corresponds to di_dmevmask */
138 __u16 fsd_dmstate; /* corresponds to di_dmstate */
143 * File segment locking set data type for 64 bit access.
144 * Also used for all the RESV/FREE interfaces.
146 typedef struct xfs_flock64 {
150 __s64 l_len; /* len == 0 means until end of file */
153 __s32 l_pad[4]; /* reserve area */
157 * Output for XFS_IOC_FSGEOMETRY_V1
159 typedef struct xfs_fsop_geom_v1 {
160 __u32 blocksize; /* filesystem (data) block size */
161 __u32 rtextsize; /* realtime extent size */
162 __u32 agblocks; /* fsblocks in an AG */
163 __u32 agcount; /* number of allocation groups */
164 __u32 logblocks; /* fsblocks in the log */
165 __u32 sectsize; /* (data) sector size, bytes */
166 __u32 inodesize; /* inode size in bytes */
167 __u32 imaxpct; /* max allowed inode space(%) */
168 __u64 datablocks; /* fsblocks in data subvolume */
169 __u64 rtblocks; /* fsblocks in realtime subvol */
170 __u64 rtextents; /* rt extents in realtime subvol*/
171 __u64 logstart; /* starting fsblock of the log */
172 unsigned char uuid[16]; /* unique id of the filesystem */
173 __u32 sunit; /* stripe unit, fsblocks */
174 __u32 swidth; /* stripe width, fsblocks */
175 __s32 version; /* structure version */
176 __u32 flags; /* superblock version flags */
177 __u32 logsectsize; /* log sector size, bytes */
178 __u32 rtsectsize; /* realtime sector size, bytes */
179 __u32 dirblocksize; /* directory block size, bytes */
180 } xfs_fsop_geom_v1_t;
183 * Output for XFS_IOC_FSGEOMETRY
185 typedef struct xfs_fsop_geom {
186 __u32 blocksize; /* filesystem (data) block size */
187 __u32 rtextsize; /* realtime extent size */
188 __u32 agblocks; /* fsblocks in an AG */
189 __u32 agcount; /* number of allocation groups */
190 __u32 logblocks; /* fsblocks in the log */
191 __u32 sectsize; /* (data) sector size, bytes */
192 __u32 inodesize; /* inode size in bytes */
193 __u32 imaxpct; /* max allowed inode space(%) */
194 __u64 datablocks; /* fsblocks in data subvolume */
195 __u64 rtblocks; /* fsblocks in realtime subvol */
196 __u64 rtextents; /* rt extents in realtime subvol*/
197 __u64 logstart; /* starting fsblock of the log */
198 unsigned char uuid[16]; /* unique id of the filesystem */
199 __u32 sunit; /* stripe unit, fsblocks */
200 __u32 swidth; /* stripe width, fsblocks */
201 __s32 version; /* structure version */
202 __u32 flags; /* superblock version flags */
203 __u32 logsectsize; /* log sector size, bytes */
204 __u32 rtsectsize; /* realtime sector size, bytes */
205 __u32 dirblocksize; /* directory block size, bytes */
206 __u32 logsunit; /* log stripe unit, bytes */
209 /* Output for XFS_FS_COUNTS */
210 typedef struct xfs_fsop_counts {
211 __u64 freedata; /* free data section blocks */
212 __u64 freertx; /* free rt extents */
213 __u64 freeino; /* free inodes */
214 __u64 allocino; /* total allocated inodes */
217 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
218 typedef struct xfs_fsop_resblks {
221 } xfs_fsop_resblks_t;
223 #define XFS_FSOP_GEOM_VERSION 0
225 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x0001 /* attributes in use */
226 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x0002 /* 32-bit nlink values */
227 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x0004 /* quotas enabled */
228 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x0008 /* inode alignment */
229 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x0010 /* large data alignment */
230 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x0020 /* read-only shared */
231 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x0040 /* special extent flag */
232 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x0080 /* directory version 2 */
233 #define XFS_FSOP_GEOM_FLAGS_LOGV2 0x0100 /* log format version 2 */
234 #define XFS_FSOP_GEOM_FLAGS_SECTOR 0x0200 /* sector sizes >1BB */
235 #define XFS_FSOP_GEOM_FLAGS_ATTR2 0x0400 /* inline attributes rework */
236 #define XFS_FSOP_GEOM_FLAGS_DIRV2CI 0x1000 /* ASCII only CI names */
237 #define XFS_FSOP_GEOM_FLAGS_LAZYSB 0x4000 /* lazy superblock counters */
241 * Minimum and maximum sizes need for growth checks
243 #define XFS_MIN_AG_BLOCKS 64
244 #define XFS_MIN_LOG_BLOCKS 512ULL
245 #define XFS_MAX_LOG_BLOCKS (1024 * 1024ULL)
246 #define XFS_MIN_LOG_BYTES (10 * 1024 * 1024ULL)
248 /* keep the maximum size under 2^31 by a small amount */
249 #define XFS_MAX_LOG_BYTES \
250 ((2 * 1024 * 1024 * 1024ULL) - XFS_MIN_LOG_BYTES)
252 /* Used for sanity checks on superblock */
253 #define XFS_MAX_DBLOCKS(s) ((xfs_drfsbno_t)(s)->sb_agcount * (s)->sb_agblocks)
254 #define XFS_MIN_DBLOCKS(s) ((xfs_drfsbno_t)((s)->sb_agcount - 1) * \
255 (s)->sb_agblocks + XFS_MIN_AG_BLOCKS)
258 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
260 typedef struct xfs_growfs_data {
261 __u64 newblocks; /* new data subvol size, fsblocks */
262 __u32 imaxpct; /* new inode space percentage limit */
265 typedef struct xfs_growfs_log {
266 __u32 newblocks; /* new log size, fsblocks */
267 __u32 isint; /* 1 if new log is internal */
270 typedef struct xfs_growfs_rt {
271 __u64 newblocks; /* new realtime size, fsblocks */
272 __u32 extsize; /* new realtime extent size, fsblocks */
277 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
279 typedef struct xfs_bstime {
280 time_t tv_sec; /* seconds */
281 __s32 tv_nsec; /* and nanoseconds */
284 typedef struct xfs_bstat {
285 __u64 bs_ino; /* inode number */
286 __u16 bs_mode; /* type and mode */
287 __u16 bs_nlink; /* number of links */
288 __u32 bs_uid; /* user id */
289 __u32 bs_gid; /* group id */
290 __u32 bs_rdev; /* device value */
291 __s32 bs_blksize; /* block size */
292 __s64 bs_size; /* file size */
293 xfs_bstime_t bs_atime; /* access time */
294 xfs_bstime_t bs_mtime; /* modify time */
295 xfs_bstime_t bs_ctime; /* inode change time */
296 int64_t bs_blocks; /* number of blocks */
297 __u32 bs_xflags; /* extended flags */
298 __s32 bs_extsize; /* extent size */
299 __s32 bs_extents; /* number of extents */
300 __u32 bs_gen; /* generation count */
301 __u16 bs_projid_lo; /* lower part of project id */
302 #define bs_projid bs_projid_lo /* (previously just bs_projid) */
303 __u16 bs_forkoff; /* inode fork offset in bytes */
304 __u16 bs_projid_hi; /* higher part of project id */
305 unsigned char bs_pad[10]; /* pad space, unused */
306 __u32 bs_dmevmask; /* DMIG event mask */
307 __u16 bs_dmstate; /* DMIG state info */
308 __u16 bs_aextents; /* attribute number of extents */
312 * The user-level BulkStat Request interface structure.
314 typedef struct xfs_fsop_bulkreq {
315 __u64 __user *lastip; /* last inode # pointer */
316 __s32 icount; /* count of entries in buffer */
317 void __user *ubuffer;/* user buffer for inode desc. */
318 __s32 __user *ocount; /* output count pointer */
319 } xfs_fsop_bulkreq_t;
323 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
325 typedef struct xfs_inogrp {
326 __u64 xi_startino; /* starting inode number */
327 __s32 xi_alloccount; /* # bits set in allocmask */
328 __u64 xi_allocmask; /* mask of allocated inodes */
335 typedef struct xfs_error_injection {
338 } xfs_error_injection_t;
342 * The user-level Handle Request interface structure.
344 typedef struct xfs_fsop_handlereq {
345 __u32 fd; /* fd for FD_TO_HANDLE */
346 void __user *path; /* user pathname */
347 __u32 oflags; /* open flags */
348 void __user *ihandle;/* user supplied handle */
349 __u32 ihandlen; /* user supplied length */
350 void __user *ohandle;/* user buffer for handle */
351 __u32 __user *ohandlen;/* user buffer length */
352 } xfs_fsop_handlereq_t;
355 * Compound structures for passing args through Handle Request interfaces
356 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
357 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
358 * XFS_IOC_ATTRMULTI_BY_HANDLE
361 typedef struct xfs_fsop_setdm_handlereq {
362 struct xfs_fsop_handlereq hreq; /* handle information */
363 struct fsdmidata __user *data; /* DMAPI data */
364 } xfs_fsop_setdm_handlereq_t;
366 typedef struct xfs_attrlist_cursor {
368 } xfs_attrlist_cursor_t;
370 typedef struct xfs_fsop_attrlist_handlereq {
371 struct xfs_fsop_handlereq hreq; /* handle interface structure */
372 struct xfs_attrlist_cursor pos; /* opaque cookie, list offset */
373 __u32 flags; /* which namespace to use */
374 __u32 buflen; /* length of buffer supplied */
375 void __user *buffer; /* returned names */
376 } xfs_fsop_attrlist_handlereq_t;
378 typedef struct xfs_attr_multiop {
380 #define ATTR_OP_GET 1 /* return the indicated attr's value */
381 #define ATTR_OP_SET 2 /* set/create the indicated attr/value pair */
382 #define ATTR_OP_REMOVE 3 /* remove the indicated attr */
384 void __user *am_attrname;
385 void __user *am_attrvalue;
388 } xfs_attr_multiop_t;
390 typedef struct xfs_fsop_attrmulti_handlereq {
391 struct xfs_fsop_handlereq hreq; /* handle interface structure */
392 __u32 opcount;/* count of following multiop */
393 struct xfs_attr_multiop __user *ops; /* attr_multi data */
394 } xfs_fsop_attrmulti_handlereq_t;
397 * per machine unique filesystem identifier types.
399 typedef struct { __u32 val[2]; } xfs_fsid_t; /* file system id type */
401 typedef struct xfs_fid {
402 __u16 fid_len; /* length of remainder */
404 __u32 fid_gen; /* generation number */
405 __u64 fid_ino; /* 64 bits inode number */
408 typedef struct xfs_handle {
410 __s64 align; /* force alignment of ha_fid */
411 xfs_fsid_t _ha_fsid; /* unique file system identifier */
413 xfs_fid_t ha_fid; /* file system specific file ID */
415 #define ha_fsid ha_u._ha_fsid
417 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.fid_pad \
418 - (char *) &(handle)) \
419 + (handle).ha_fid.fid_len)
422 * Flags for going down operation
424 #define XFS_FSOP_GOING_FLAGS_DEFAULT 0x0 /* going down */
425 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
426 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
429 * ioctl commands that are used by Linux filesystems
431 #define XFS_IOC_GETXFLAGS FS_IOC_GETFLAGS
432 #define XFS_IOC_SETXFLAGS FS_IOC_SETFLAGS
433 #define XFS_IOC_GETVERSION FS_IOC_GETVERSION
436 * ioctl commands that replace IRIX fcntl()'s
437 * For 'documentation' purposed more than anything else,
438 * the "cmd #" field reflects the IRIX fcntl number.
440 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
441 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
442 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
443 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
444 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
445 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
446 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
447 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
448 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
449 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
450 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
451 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
452 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
453 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
454 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
455 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
456 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
457 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
458 #define XFS_IOC_ZERO_RANGE _IOW ('X', 57, struct xfs_flock64)
461 * ioctl commands that replace IRIX syssgi()'s
463 #define XFS_IOC_FSGEOMETRY_V1 _IOR ('X', 100, struct xfs_fsop_geom_v1)
464 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
465 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
466 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
467 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
468 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
469 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
470 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
471 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
472 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
473 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
474 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
475 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
476 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
477 #define XFS_IOC_SET_RESBLKS _IOWR('X', 114, struct xfs_fsop_resblks)
478 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
479 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
480 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
481 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
482 /* XFS_IOC_FREEZE -- FIFREEZE 119 */
483 /* XFS_IOC_THAW -- FITHAW 120 */
484 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
485 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
486 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
487 #define XFS_IOC_FSGEOMETRY _IOR ('X', 124, struct xfs_fsop_geom)
488 #define XFS_IOC_GOINGDOWN _IOR ('X', 125, __uint32_t)
489 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
492 #ifndef HAVE_BBMACROS
494 * Block I/O parameterization. A basic block (BB) is the lowest size of
495 * filesystem allocation, and must equal 512. Length units given to bio
496 * routines are in BB's.
499 #define BBSIZE (1<<BBSHIFT)
500 #define BBMASK (BBSIZE-1)
501 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
502 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
503 #define BBTOB(bbs) ((bbs) << BBSHIFT)
506 #endif /* __XFS_FS_H__ */