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)
25 #define XFS_NAME "xfs"
28 * Direct I/O attribute record used with XFS_IOC_DIOINFO
29 * d_miniosz is the min xfer size, xfer size multiple and file seek offset
34 __u32 d_mem
; /* data buffer memory alignment */
35 __u32 d_miniosz
; /* min xfer size */
36 __u32 d_maxiosz
; /* max xfer size */
41 * Structure for XFS_IOC_FSGETXATTR[A] and XFS_IOC_FSSETXATTR.
45 __u32 fsx_xflags
; /* xflags field value (get/set) */
46 __u32 fsx_extsize
; /* extsize field value (get/set)*/
47 __u32 fsx_nextents
; /* nextents field value (get) */
48 __u32 fsx_projid
; /* project identifier (get/set) */
49 unsigned char fsx_pad
[12];
54 * Flags for the bs_xflags/fsx_xflags field
55 * There should be a one-to-one correspondence between these flags and the
58 #define XFS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
59 #define XFS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
60 #define XFS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
61 #define XFS_XFLAG_APPEND 0x00000010 /* all writes append */
62 #define XFS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
63 #define XFS_XFLAG_NOATIME 0x00000040 /* do not update access time */
64 #define XFS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
65 #define XFS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
66 #define XFS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
67 #define XFS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
68 #define XFS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
69 #define XFS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
70 #define XFS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
71 #define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
74 * Structure for XFS_IOC_GETBMAP.
75 * On input, fill in bmv_offset and bmv_length of the first structure
76 * to indicate the area of interest in the file, and bmv_entries with
77 * the number of array elements given back. The first structure is
78 * updated on return to give the offset and length for the next call.
82 __s64 bmv_offset
; /* file offset of segment in blocks */
83 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
84 __s64 bmv_length
; /* length of segment, blocks */
85 __s32 bmv_count
; /* # of entries in array incl. 1st */
86 __s32 bmv_entries
; /* # of entries filled in (output) */
91 * Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
92 * are used exactly as in the getbmap structure. The getbmapx structure
93 * has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
94 * is only used for the first structure. It contains input flags
95 * specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
96 * in by the XFS_IOC_GETBMAPX command for each returned structure after
101 __s64 bmv_offset
; /* file offset of segment in blocks */
102 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
103 __s64 bmv_length
; /* length of segment, blocks */
104 __s32 bmv_count
; /* # of entries in array incl. 1st */
105 __s32 bmv_entries
; /* # of entries filled in (output). */
106 __s32 bmv_iflags
; /* input flags (1st structure) */
107 __s32 bmv_oflags
; /* output flags (after 1st structure)*/
108 __s32 bmv_unused1
; /* future use */
109 __s32 bmv_unused2
; /* future use */
113 /* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
114 #define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
115 #define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
116 #define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
117 #define BMV_IF_VALID (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC)
119 #define BMV_IF_EXTENDED 0x40000000 /* getpmapx if set */
122 /* bmv_oflags values - returned for for each non-header segment */
123 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
125 /* Convert getbmap <-> getbmapx - move fields from p1 to p2. */
126 #define GETBMAP_CONVERT(p1,p2) { \
127 p2.bmv_offset = p1.bmv_offset; \
128 p2.bmv_block = p1.bmv_block; \
129 p2.bmv_length = p1.bmv_length; \
130 p2.bmv_count = p1.bmv_count; \
131 p2.bmv_entries = p1.bmv_entries; }
135 * Structure for XFS_IOC_FSSETDM.
136 * For use by backup and restore programs to set the XFS on-disk inode
137 * fields di_dmevmask and di_dmstate. These must be set to exactly and
138 * only values previously obtained via xfs_bulkstat! (Specifically the
139 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
141 #ifndef HAVE_FSDMIDATA
143 __u32 fsd_dmevmask
; /* corresponds to di_dmevmask */
145 __u16 fsd_dmstate
; /* corresponds to di_dmstate */
150 * File segment locking set data type for 64 bit access.
151 * Also used for all the RESV/FREE interfaces.
153 typedef struct xfs_flock64
{
157 __s64 l_len
; /* len == 0 means until end of file */
160 __s32 l_pad
[4]; /* reserve area */
164 * Output for XFS_IOC_FSGEOMETRY_V1
166 typedef struct xfs_fsop_geom_v1
{
167 __u32 blocksize
; /* filesystem (data) block size */
168 __u32 rtextsize
; /* realtime extent size */
169 __u32 agblocks
; /* fsblocks in an AG */
170 __u32 agcount
; /* number of allocation groups */
171 __u32 logblocks
; /* fsblocks in the log */
172 __u32 sectsize
; /* (data) sector size, bytes */
173 __u32 inodesize
; /* inode size in bytes */
174 __u32 imaxpct
; /* max allowed inode space(%) */
175 __u64 datablocks
; /* fsblocks in data subvolume */
176 __u64 rtblocks
; /* fsblocks in realtime subvol */
177 __u64 rtextents
; /* rt extents in realtime subvol*/
178 __u64 logstart
; /* starting fsblock of the log */
179 unsigned char uuid
[16]; /* unique id of the filesystem */
180 __u32 sunit
; /* stripe unit, fsblocks */
181 __u32 swidth
; /* stripe width, fsblocks */
182 __s32 version
; /* structure version */
183 __u32 flags
; /* superblock version flags */
184 __u32 logsectsize
; /* log sector size, bytes */
185 __u32 rtsectsize
; /* realtime sector size, bytes */
186 __u32 dirblocksize
; /* directory block size, bytes */
187 } xfs_fsop_geom_v1_t
;
190 * Output for XFS_IOC_FSGEOMETRY
192 typedef struct xfs_fsop_geom
{
193 __u32 blocksize
; /* filesystem (data) block size */
194 __u32 rtextsize
; /* realtime extent size */
195 __u32 agblocks
; /* fsblocks in an AG */
196 __u32 agcount
; /* number of allocation groups */
197 __u32 logblocks
; /* fsblocks in the log */
198 __u32 sectsize
; /* (data) sector size, bytes */
199 __u32 inodesize
; /* inode size in bytes */
200 __u32 imaxpct
; /* max allowed inode space(%) */
201 __u64 datablocks
; /* fsblocks in data subvolume */
202 __u64 rtblocks
; /* fsblocks in realtime subvol */
203 __u64 rtextents
; /* rt extents in realtime subvol*/
204 __u64 logstart
; /* starting fsblock of the log */
205 unsigned char uuid
[16]; /* unique id of the filesystem */
206 __u32 sunit
; /* stripe unit, fsblocks */
207 __u32 swidth
; /* stripe width, fsblocks */
208 __s32 version
; /* structure version */
209 __u32 flags
; /* superblock version flags */
210 __u32 logsectsize
; /* log sector size, bytes */
211 __u32 rtsectsize
; /* realtime sector size, bytes */
212 __u32 dirblocksize
; /* directory block size, bytes */
213 __u32 logsunit
; /* log stripe unit, bytes */
216 /* Output for XFS_FS_COUNTS */
217 typedef struct xfs_fsop_counts
{
218 __u64 freedata
; /* free data section blocks */
219 __u64 freertx
; /* free rt extents */
220 __u64 freeino
; /* free inodes */
221 __u64 allocino
; /* total allocated inodes */
224 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
225 typedef struct xfs_fsop_resblks
{
228 } xfs_fsop_resblks_t
;
230 #define XFS_FSOP_GEOM_VERSION 0
232 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x0001 /* attributes in use */
233 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x0002 /* 32-bit nlink values */
234 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x0004 /* quotas enabled */
235 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x0008 /* inode alignment */
236 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x0010 /* large data alignment */
237 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x0020 /* read-only shared */
238 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x0040 /* special extent flag */
239 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x0080 /* directory version 2 */
240 #define XFS_FSOP_GEOM_FLAGS_LOGV2 0x0100 /* log format version 2 */
241 #define XFS_FSOP_GEOM_FLAGS_SECTOR 0x0200 /* sector sizes >1BB */
242 #define XFS_FSOP_GEOM_FLAGS_ATTR2 0x0400 /* inline attributes rework */
246 * Minimum and maximum sizes need for growth checks
248 #define XFS_MIN_AG_BLOCKS 64
249 #define XFS_MIN_LOG_BLOCKS 512
250 #define XFS_MAX_LOG_BLOCKS (64 * 1024)
251 #define XFS_MIN_LOG_BYTES (256 * 1024)
252 #define XFS_MAX_LOG_BYTES (128 * 1024 * 1024)
255 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
257 typedef struct xfs_growfs_data
{
258 __u64 newblocks
; /* new data subvol size, fsblocks */
259 __u32 imaxpct
; /* new inode space percentage limit */
262 typedef struct xfs_growfs_log
{
263 __u32 newblocks
; /* new log size, fsblocks */
264 __u32 isint
; /* 1 if new log is internal */
267 typedef struct xfs_growfs_rt
{
268 __u64 newblocks
; /* new realtime size, fsblocks */
269 __u32 extsize
; /* new realtime extent size, fsblocks */
274 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
276 typedef struct xfs_bstime
{
277 time_t tv_sec
; /* seconds */
278 __s32 tv_nsec
; /* and nanoseconds */
281 typedef struct xfs_bstat
{
282 __u64 bs_ino
; /* inode number */
283 __u16 bs_mode
; /* type and mode */
284 __u16 bs_nlink
; /* number of links */
285 __u32 bs_uid
; /* user id */
286 __u32 bs_gid
; /* group id */
287 __u32 bs_rdev
; /* device value */
288 __s32 bs_blksize
; /* block size */
289 __s64 bs_size
; /* file size */
290 xfs_bstime_t bs_atime
; /* access time */
291 xfs_bstime_t bs_mtime
; /* modify time */
292 xfs_bstime_t bs_ctime
; /* inode change time */
293 int64_t bs_blocks
; /* number of blocks */
294 __u32 bs_xflags
; /* extended flags */
295 __s32 bs_extsize
; /* extent size */
296 __s32 bs_extents
; /* number of extents */
297 __u32 bs_gen
; /* generation count */
298 __u16 bs_projid
; /* project id */
299 unsigned char bs_pad
[14]; /* pad space, unused */
300 __u32 bs_dmevmask
; /* DMIG event mask */
301 __u16 bs_dmstate
; /* DMIG state info */
302 __u16 bs_aextents
; /* attribute number of extents */
306 * The user-level BulkStat Request interface structure.
308 typedef struct xfs_fsop_bulkreq
{
309 __u64 __user
*lastip
; /* last inode # pointer */
310 __s32 icount
; /* count of entries in buffer */
311 void __user
*ubuffer
;/* user buffer for inode desc. */
312 __s32 __user
*ocount
; /* output count pointer */
313 } xfs_fsop_bulkreq_t
;
317 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
319 typedef struct xfs_inogrp
{
320 __u64 xi_startino
; /* starting inode number */
321 __s32 xi_alloccount
; /* # bits set in allocmask */
322 __u64 xi_allocmask
; /* mask of allocated inodes */
329 typedef struct xfs_error_injection
{
332 } xfs_error_injection_t
;
336 * The user-level Handle Request interface structure.
338 typedef struct xfs_fsop_handlereq
{
339 __u32 fd
; /* fd for FD_TO_HANDLE */
340 void __user
*path
; /* user pathname */
341 __u32 oflags
; /* open flags */
342 void __user
*ihandle
;/* user supplied handle */
343 __u32 ihandlen
; /* user supplied length */
344 void __user
*ohandle
;/* user buffer for handle */
345 __u32 __user
*ohandlen
;/* user buffer length */
346 } xfs_fsop_handlereq_t
;
349 * Compound structures for passing args through Handle Request interfaces
350 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
351 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
352 * XFS_IOC_ATTRMULTI_BY_HANDLE
355 typedef struct xfs_fsop_setdm_handlereq
{
356 struct xfs_fsop_handlereq hreq
; /* handle information */
357 struct fsdmidata __user
*data
; /* DMAPI data */
358 } xfs_fsop_setdm_handlereq_t
;
360 typedef struct xfs_attrlist_cursor
{
362 } xfs_attrlist_cursor_t
;
364 typedef struct xfs_fsop_attrlist_handlereq
{
365 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
366 struct xfs_attrlist_cursor pos
; /* opaque cookie, list offset */
367 __u32 flags
; /* which namespace to use */
368 __u32 buflen
; /* length of buffer supplied */
369 void __user
*buffer
; /* returned names */
370 } xfs_fsop_attrlist_handlereq_t
;
372 typedef struct xfs_attr_multiop
{
375 void __user
*am_attrname
;
376 void __user
*am_attrvalue
;
379 } xfs_attr_multiop_t
;
381 typedef struct xfs_fsop_attrmulti_handlereq
{
382 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
383 __u32 opcount
;/* count of following multiop */
384 struct xfs_attr_multiop __user
*ops
; /* attr_multi data */
385 } xfs_fsop_attrmulti_handlereq_t
;
388 * per machine unique filesystem identifier types.
390 typedef struct { __u32 val
[2]; } xfs_fsid_t
; /* file system id type */
397 __u16 fid_len
; /* length of data in bytes */
398 unsigned char fid_data
[MAXFIDSZ
]; /* data (fid_len worth) */
402 typedef struct xfs_fid
{
403 __u16 xfs_fid_len
; /* length of remainder */
405 __u32 xfs_fid_gen
; /* generation number */
406 __u64 xfs_fid_ino
; /* 64 bits inode number */
409 typedef struct xfs_fid2
{
410 __u16 fid_len
; /* length of remainder */
411 __u16 fid_pad
; /* padding, must be zero */
412 __u32 fid_gen
; /* generation number */
413 __u64 fid_ino
; /* inode number */
416 typedef struct xfs_handle
{
418 __s64 align
; /* force alignment of ha_fid */
419 xfs_fsid_t _ha_fsid
; /* unique file system identifier */
421 xfs_fid_t ha_fid
; /* file system specific file ID */
423 #define ha_fsid ha_u._ha_fsid
425 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.xfs_fid_pad \
426 - (char *) &(handle)) \
427 + (handle).ha_fid.xfs_fid_len)
429 #define XFS_HANDLE_CMP(h1, h2) memcmp(h1, h2, sizeof(xfs_handle_t))
431 #define FSHSIZE sizeof(fsid_t)
434 * Flags for going down operation
436 #define XFS_FSOP_GOING_FLAGS_DEFAULT 0x0 /* going down */
437 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
438 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
441 * ioctl commands that are used by Linux filesystems
443 #define XFS_IOC_GETXFLAGS _IOR('f', 1, long)
444 #define XFS_IOC_SETXFLAGS _IOW('f', 2, long)
445 #define XFS_IOC_GETVERSION _IOR('v', 1, long)
448 * ioctl commands that replace IRIX fcntl()'s
449 * For 'documentation' purposed more than anything else,
450 * the "cmd #" field reflects the IRIX fcntl number.
452 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
453 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
454 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
455 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
456 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
457 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
458 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
459 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
460 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
461 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
462 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
463 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
464 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
465 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
466 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
467 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
468 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
469 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
472 * ioctl commands that replace IRIX syssgi()'s
474 #define XFS_IOC_FSGEOMETRY_V1 _IOR ('X', 100, struct xfs_fsop_geom_v1)
475 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
476 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
477 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
478 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
479 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
480 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
481 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
482 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
483 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
484 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
485 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
486 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
487 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
488 #define XFS_IOC_SET_RESBLKS _IOWR('X', 114, struct xfs_fsop_resblks)
489 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
490 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
491 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
492 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
493 #define XFS_IOC_FREEZE _IOWR('X', 119, int)
494 #define XFS_IOC_THAW _IOWR('X', 120, int)
495 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
496 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
497 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
498 #define XFS_IOC_FSGEOMETRY _IOR ('X', 124, struct xfs_fsop_geom)
499 #define XFS_IOC_GOINGDOWN _IOR ('X', 125, __uint32_t)
500 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
503 #ifndef HAVE_BBMACROS
505 * Block I/O parameterization. A basic block (BB) is the lowest size of
506 * filesystem allocation, and must equal 512. Length units given to bio
507 * routines are in BB's.
510 #define BBSIZE (1<<BBSHIFT)
511 #define BBMASK (BBSIZE-1)
512 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
513 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
514 #define BBTOB(bbs) ((bbs) << BBSHIFT)
517 #endif /* __XFS_FS_H__ */