2 * Copyright (c) 1995, 2001-2002 Silicon Graphics, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2.1 of the GNU Lesser General Public License
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this program; if not, write the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307,
24 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
25 * Mountain View, CA 94043, or:
29 * For further information regarding this notice, see:
31 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
33 #ifndef _LINUX_XFS_FS_H
34 #define _LINUX_XFS_FS_H
36 #include <linux/types.h>
37 #include <asm/ioctl.h>
41 * SGI's XFS filesystem's major stuff (constants, structures)
44 #define XFS_SUPER_MAGIC 0x58465342
45 #define XFS_NAME "xfs"
48 * Direct I/O attribute record used with XFS_IOC_DIOINFO
49 * d_miniosz is the min xfer size, xfer size multiple and file seek offset
53 __u32 d_mem
; /* data buffer memory alignment */
54 __u32 d_miniosz
; /* min xfer size */
55 __u32 d_maxiosz
; /* max xfer size */
59 * Structure for XFS_IOC_FSGETXATTR[A] and XFS_IOC_FSSETXATTR.
62 __u32 fsx_xflags
; /* xflags field value (get/set) */
63 __u32 fsx_extsize
; /* extsize field value (get/set)*/
64 __u32 fsx_nextents
; /* nextents field value (get) */
65 unsigned char fsx_pad
[16];
69 * Flags for the bs_xflags/fsx_xflags field
70 * There should be a one-to-one correspondence between these flags and the
73 #define XFS_XFLAG_REALTIME 0x00000001
74 #define XFS_XFLAG_PREALLOC 0x00000002
75 #define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
76 #define XFS_XFLAG_ALL \
77 ( XFS_XFLAG_REALTIME|XFS_XFLAG_PREALLOC|XFS_XFLAG_HASATTR )
81 * Structure for XFS_IOC_GETBMAP.
82 * On input, fill in bmv_offset and bmv_length of the first structure
83 * to indicate the area of interest in the file, and bmv_entry with the
84 * number of array elements given. The first structure is updated on
85 * return to give the offset and length for the next call.
88 __s64 bmv_offset
; /* file offset of segment in blocks */
89 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
90 __s64 bmv_length
; /* length of segment, blocks */
91 __s32 bmv_count
; /* # of entries in array incl. 1st */
92 __s32 bmv_entries
; /* # of entries filled in (output) */
96 * Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
97 * are used exactly as in the getbmap structure. The getbmapx structure
98 * has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
99 * is only used for the first structure. It contains input flags
100 * specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
101 * in by the XFS_IOC_GETBMAPX command for each returned structure after
105 __s64 bmv_offset
; /* file offset of segment in blocks */
106 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
107 __s64 bmv_length
; /* length of segment, blocks */
108 __s32 bmv_count
; /* # of entries in array incl. 1st */
109 __s32 bmv_entries
; /* # of entries filled in (output). */
110 __s32 bmv_iflags
; /* input flags (1st structure) */
111 __s32 bmv_oflags
; /* output flags (after 1st structure)*/
112 __s32 bmv_unused1
; /* future use */
113 __s32 bmv_unused2
; /* future use */
116 /* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
117 #define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
118 #define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
119 #define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
120 #define BMV_IF_VALID (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC)
122 #define BMV_IF_EXTENDED 0x40000000 /* getpmapx if set */
125 /* bmv_oflags values - returned for for each non-header segment */
126 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
128 /* Convert getbmap <-> getbmapx - move fields from p1 to p2. */
129 #define GETBMAP_CONVERT(p1,p2) { \
130 p2.bmv_offset = p1.bmv_offset; \
131 p2.bmv_block = p1.bmv_block; \
132 p2.bmv_length = p1.bmv_length; \
133 p2.bmv_count = p1.bmv_count; \
134 p2.bmv_entries = p1.bmv_entries; }
138 * Structure for XFS_IOC_FSSETDM.
139 * For use by backup and restore programs to set the XFS on-disk inode
140 * fields di_dmevmask and di_dmstate. These must be set to exactly and
141 * only values previously obtained via xfs_bulkstat! (Specifically the
142 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
145 __u32 fsd_dmevmask
; /* corresponds to di_dmevmask */
147 __u16 fsd_dmstate
; /* corresponds to di_dmstate */
151 * File segment locking set data type for 64 bit access.
152 * Also used for all the RESV/FREE interfaces.
154 typedef struct xfs_flock64
{
158 __s64 l_len
; /* len == 0 means until end of file */
161 __s32 l_pad
[4]; /* reserve area */
165 * Output for XFS_IOC_FSGEOMETRY
167 typedef struct xfs_fsop_geom
{
168 __u32 blocksize
; /* filesystem (data) block size */
169 __u32 rtextsize
; /* realtime extent size */
170 __u32 agblocks
; /* fsblocks in an AG */
171 __u32 agcount
; /* number of allocation groups */
172 __u32 logblocks
; /* fsblocks in the log */
173 __u32 sectsize
; /* (data) sector size, bytes */
174 __u32 inodesize
; /* inode size in bytes */
175 __u32 imaxpct
; /* max allowed inode space(%) */
176 __u64 datablocks
; /* fsblocks in data subvolume */
177 __u64 rtblocks
; /* fsblocks in realtime subvol */
178 __u64 rtextents
; /* rt extents in realtime subvol*/
179 __u64 logstart
; /* starting fsblock of the log */
180 unsigned char uuid
[16]; /* unique id of the filesystem */
181 __u32 sunit
; /* stripe unit, fsblocks */
182 __u32 swidth
; /* stripe width, fsblocks */
183 __s32 version
; /* structure version */
184 __u32 flags
; /* superblock version flags */
185 __u32 logsectsize
; /* log sector size, bytes */
186 __u32 rtsectsize
; /* realtime sector size, bytes */
187 __u32 dirblocksize
; /* directory block size, bytes */
190 /* Output for XFS_FS_COUNTS */
191 typedef struct xfs_fsop_counts
{
192 __u64 freedata
; /* free data section blocks */
193 __u64 freertx
; /* free rt extents */
194 __u64 freeino
; /* free inodes */
195 __u64 allocino
; /* total allocated inodes */
198 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
199 typedef struct xfs_fsop_resblks
{
202 } xfs_fsop_resblks_t
;
204 #define XFS_FSOP_GEOM_VERSION 0
206 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x01 /* attributes in use */
207 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x02 /* 32-bit nlink values */
208 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x04 /* quotas enabled */
209 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x08 /* inode alignment */
210 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x10 /* large data alignment */
211 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x20 /* read-only shared */
212 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x40 /* special extent flag */
213 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x80 /* directory version 2 */
217 * Minimum and maximum sizes need for growth checks
219 #define XFS_MIN_AG_BLOCKS 64
220 #define XFS_MIN_LOG_BLOCKS 512
221 #define XFS_MAX_LOG_BLOCKS (64 * 1024)
222 #define XFS_MIN_LOG_BYTES (256 * 1024)
223 #define XFS_MAX_LOG_BYTES (128 * 1024 * 1024)
226 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
228 typedef struct xfs_growfs_data
{
229 __u64 newblocks
; /* new data subvol size, fsblocks */
230 __u32 imaxpct
; /* new inode space percentage limit */
233 typedef struct xfs_growfs_log
{
234 __u32 newblocks
; /* new log size, fsblocks */
235 __u32 isint
; /* 1 if new log is internal */
238 typedef struct xfs_growfs_rt
{
239 __u64 newblocks
; /* new realtime size, fsblocks */
240 __u32 extsize
; /* new realtime extent size, fsblocks */
245 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
247 typedef struct xfs_bstime
{
248 time_t tv_sec
; /* seconds */
249 __s32 tv_nsec
; /* and nanoseconds */
252 typedef struct xfs_bstat
{
253 __u64 bs_ino
; /* inode number */
254 __u16 bs_mode
; /* type and mode */
255 __u16 bs_nlink
; /* number of links */
256 __u32 bs_uid
; /* user id */
257 __u32 bs_gid
; /* group id */
258 __u32 bs_rdev
; /* device value */
259 __s32 bs_blksize
; /* block size */
260 __s64 bs_size
; /* file size */
261 xfs_bstime_t bs_atime
; /* access time */
262 xfs_bstime_t bs_mtime
; /* modify time */
263 xfs_bstime_t bs_ctime
; /* inode change time */
264 int64_t bs_blocks
; /* number of blocks */
265 __u32 bs_xflags
; /* extended flags */
266 __s32 bs_extsize
; /* extent size */
267 __s32 bs_extents
; /* number of extents */
268 __u32 bs_gen
; /* generation count */
269 __u16 bs_projid
; /* project id */
270 unsigned char bs_pad
[14]; /* pad space, unused */
271 __u32 bs_dmevmask
; /* DMIG event mask */
272 __u16 bs_dmstate
; /* DMIG state info */
273 __u16 bs_aextents
; /* attribute number of extents */
277 * The user-level BulkStat Request interface structure.
279 typedef struct xfs_fsop_bulkreq
{
280 __u64
*lastip
; /* last inode # pointer */
281 __s32 icount
; /* count of entries in buffer */
282 void *ubuffer
; /* user buffer for inode desc. */
283 __s32
*ocount
; /* output count pointer */
284 } xfs_fsop_bulkreq_t
;
288 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
290 typedef struct xfs_inogrp
{
291 __u64 xi_startino
; /* starting inode number */
292 __s32 xi_alloccount
; /* # bits set in allocmask */
293 __u64 xi_allocmask
; /* mask of allocated inodes */
300 typedef struct xfs_error_injection
{
303 } xfs_error_injection_t
;
307 * The user-level Handle Request interface structure.
309 typedef struct xfs_fsop_handlereq
{
310 __u32 fd
; /* fd for FD_TO_HANDLE */
311 void *path
; /* user pathname */
312 __u32 oflags
; /* open flags */
313 void *ihandle
; /* user supplied handle */
314 __u32 ihandlen
; /* user supplied length */
315 void *ohandle
; /* user buffer for handle */
316 __u32
*ohandlen
; /* user buffer length */
317 } xfs_fsop_handlereq_t
;
320 * Compound structures for passing args through Handle Request interfaces
321 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
322 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
323 * XFS_IOC_ATTRMULTI_BY_HANDLE
326 typedef struct xfs_fsop_setdm_handlereq
{
327 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
328 struct fsdmidata
*data
; /* DMAPI data to set */
329 } xfs_fsop_setdm_handlereq_t
;
331 typedef struct xfs_attrlist_cursor
{
333 } xfs_attrlist_cursor_t
;
335 typedef struct xfs_fsop_attrlist_handlereq
{
336 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
337 struct xfs_attrlist_cursor pos
; /* opaque cookie, list offset */
338 __u32 flags
; /* flags, use ROOT/USER names */
339 __u32 buflen
; /* length of buffer supplied */
340 void *buffer
; /* attrlist data to return */
341 } xfs_fsop_attrlist_handlereq_t
;
343 typedef struct xfs_attr_multiop
{
350 } xfs_attr_multiop_t
;
352 typedef struct xfs_fsop_attrmulti_handlereq
{
353 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
354 __u32 opcount
; /* count of following multiop */
355 struct xfs_attr_multiop
*ops
; /* attr_multi data to get/set */
356 } xfs_fsop_attrmulti_handlereq_t
;
359 * File system identifier. Should be unique (at least per machine).
362 __u32 val
[2]; /* file system id type */
366 * File identifier. Should be unique per filesystem on a single machine.
367 * This is typically called by a stateless file server in order to generate
372 __u16 fid_len
; /* length of data in bytes */
373 unsigned char fid_data
[MAXFIDSZ
]; /* data (variable length) */
376 typedef struct xfs_fid
{
377 __u16 xfs_fid_len
; /* length of remainder */
379 __u32 xfs_fid_gen
; /* generation number */
380 __u64 xfs_fid_ino
; /* 64 bits inode number */
383 typedef struct xfs_fid2
{
384 __u16 fid_len
; /* length of remainder */
385 __u16 fid_pad
; /* padding, must be zero */
386 __u32 fid_gen
; /* generation number */
387 __u64 fid_ino
; /* inode number */
390 typedef struct xfs_handle
{
392 __s64 align
; /* force alignment of ha_fid */
393 xfs_fsid_t _ha_fsid
; /* unique file system identifier */
395 xfs_fid_t ha_fid
; /* file system specific file ID */
397 #define ha_fsid ha_u._ha_fsid
399 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.xfs_fid_pad \
400 - (char *) &(handle)) \
401 + (handle).ha_fid.xfs_fid_len)
403 #define XFS_HANDLE_CMP(h1, h2) bcmp(h1, h2, sizeof (xfs_handle_t))
405 #define FSHSIZE sizeof (fsid_t)
409 * ioctl commands that replace IRIX fcntl()'s
410 * For 'documentation' purposed more than anything else,
411 * the "cmd #" field reflects the IRIX fcntl number.
413 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
414 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
415 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
416 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
417 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
418 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
419 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
420 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
421 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
422 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
423 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
424 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
425 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
426 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
427 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
428 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
429 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
430 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
433 * ioctl commands that replace IRIX syssgi()'s
435 #define XFS_IOC_FSGEOMETRY _IOR ('X', 100, struct xfs_fsop_geom)
436 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
437 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
438 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
439 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
440 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
441 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
442 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
443 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
444 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
445 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
446 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
447 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
448 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
449 #define XFS_IOC_SET_RESBLKS _IOR ('X', 114, struct xfs_fsop_resblks)
450 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
451 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
452 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
453 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
454 #define XFS_IOC_FREEZE _IOWR('X', 119, int)
455 #define XFS_IOC_THAW _IOWR('X', 120, int)
456 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
457 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
458 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
459 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
463 * Block I/O parameterization. A basic block (BB) is the lowest size of
464 * filesystem allocation, and must equal 512. Length units given to bio
465 * routines are in BB's.
468 #define BBSIZE (1<<BBSHIFT)
469 #define BBMASK (BBSIZE-1)
470 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
471 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
472 #define BBTOB(bbs) ((bbs) << BBSHIFT)
473 #define OFFTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
474 #define OFFTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
475 #define BBTOOFF(bbs) ((__u64)(bbs) << BBSHIFT)
477 #define SEEKLIMIT32 0x7fffffff
478 #define BBSEEKLIMIT32 BTOBBT(SEEKLIMIT32)
479 #define SEEKLIMIT 0x7fffffffffffffffLL
480 #define BBSEEKLIMIT OFFTOBBT(SEEKLIMIT)
482 #endif /* _LINUX_XFS_FS_H */