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_VALID \
118 (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC|BMV_IF_DELALLOC)
120 /* bmv_oflags values - returned for each non-header segment */
121 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
122 #define BMV_OF_DELALLOC 0x2 /* segment = delayed allocation */
123 #define BMV_OF_LAST 0x4 /* segment is the last in the file */
126 * Structure for XFS_IOC_FSSETDM.
127 * For use by backup and restore programs to set the XFS on-disk inode
128 * fields di_dmevmask and di_dmstate. These must be set to exactly and
129 * only values previously obtained via xfs_bulkstat! (Specifically the
130 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
132 #ifndef HAVE_FSDMIDATA
134 __u32 fsd_dmevmask
; /* corresponds to di_dmevmask */
136 __u16 fsd_dmstate
; /* corresponds to di_dmstate */
141 * File segment locking set data type for 64 bit access.
142 * Also used for all the RESV/FREE interfaces.
144 typedef struct xfs_flock64
{
148 __s64 l_len
; /* len == 0 means until end of file */
151 __s32 l_pad
[4]; /* reserve area */
155 * Output for XFS_IOC_FSGEOMETRY_V1
157 typedef struct xfs_fsop_geom_v1
{
158 __u32 blocksize
; /* filesystem (data) block size */
159 __u32 rtextsize
; /* realtime extent size */
160 __u32 agblocks
; /* fsblocks in an AG */
161 __u32 agcount
; /* number of allocation groups */
162 __u32 logblocks
; /* fsblocks in the log */
163 __u32 sectsize
; /* (data) sector size, bytes */
164 __u32 inodesize
; /* inode size in bytes */
165 __u32 imaxpct
; /* max allowed inode space(%) */
166 __u64 datablocks
; /* fsblocks in data subvolume */
167 __u64 rtblocks
; /* fsblocks in realtime subvol */
168 __u64 rtextents
; /* rt extents in realtime subvol*/
169 __u64 logstart
; /* starting fsblock of the log */
170 unsigned char uuid
[16]; /* unique id of the filesystem */
171 __u32 sunit
; /* stripe unit, fsblocks */
172 __u32 swidth
; /* stripe width, fsblocks */
173 __s32 version
; /* structure version */
174 __u32 flags
; /* superblock version flags */
175 __u32 logsectsize
; /* log sector size, bytes */
176 __u32 rtsectsize
; /* realtime sector size, bytes */
177 __u32 dirblocksize
; /* directory block size, bytes */
178 } xfs_fsop_geom_v1_t
;
181 * Output for XFS_IOC_FSGEOMETRY
183 typedef struct xfs_fsop_geom
{
184 __u32 blocksize
; /* filesystem (data) block size */
185 __u32 rtextsize
; /* realtime extent size */
186 __u32 agblocks
; /* fsblocks in an AG */
187 __u32 agcount
; /* number of allocation groups */
188 __u32 logblocks
; /* fsblocks in the log */
189 __u32 sectsize
; /* (data) sector size, bytes */
190 __u32 inodesize
; /* inode size in bytes */
191 __u32 imaxpct
; /* max allowed inode space(%) */
192 __u64 datablocks
; /* fsblocks in data subvolume */
193 __u64 rtblocks
; /* fsblocks in realtime subvol */
194 __u64 rtextents
; /* rt extents in realtime subvol*/
195 __u64 logstart
; /* starting fsblock of the log */
196 unsigned char uuid
[16]; /* unique id of the filesystem */
197 __u32 sunit
; /* stripe unit, fsblocks */
198 __u32 swidth
; /* stripe width, fsblocks */
199 __s32 version
; /* structure version */
200 __u32 flags
; /* superblock version flags */
201 __u32 logsectsize
; /* log sector size, bytes */
202 __u32 rtsectsize
; /* realtime sector size, bytes */
203 __u32 dirblocksize
; /* directory block size, bytes */
204 __u32 logsunit
; /* log stripe unit, bytes */
207 /* Output for XFS_FS_COUNTS */
208 typedef struct xfs_fsop_counts
{
209 __u64 freedata
; /* free data section blocks */
210 __u64 freertx
; /* free rt extents */
211 __u64 freeino
; /* free inodes */
212 __u64 allocino
; /* total allocated inodes */
215 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
216 typedef struct xfs_fsop_resblks
{
219 } xfs_fsop_resblks_t
;
221 #define XFS_FSOP_GEOM_VERSION 0
223 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x0001 /* attributes in use */
224 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x0002 /* 32-bit nlink values */
225 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x0004 /* quotas enabled */
226 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x0008 /* inode alignment */
227 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x0010 /* large data alignment */
228 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x0020 /* read-only shared */
229 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x0040 /* special extent flag */
230 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x0080 /* directory version 2 */
231 #define XFS_FSOP_GEOM_FLAGS_LOGV2 0x0100 /* log format version 2 */
232 #define XFS_FSOP_GEOM_FLAGS_SECTOR 0x0200 /* sector sizes >1BB */
233 #define XFS_FSOP_GEOM_FLAGS_ATTR2 0x0400 /* inline attributes rework */
234 #define XFS_FSOP_GEOM_FLAGS_DIRV2CI 0x1000 /* ASCII only CI names */
235 #define XFS_FSOP_GEOM_FLAGS_LAZYSB 0x4000 /* lazy superblock counters */
239 * Minimum and maximum sizes need for growth checks
241 #define XFS_MIN_AG_BLOCKS 64
242 #define XFS_MIN_LOG_BLOCKS 512ULL
243 #define XFS_MAX_LOG_BLOCKS (1024 * 1024ULL)
244 #define XFS_MIN_LOG_BYTES (10 * 1024 * 1024ULL)
246 /* keep the maximum size under 2^31 by a small amount */
247 #define XFS_MAX_LOG_BYTES \
248 ((2 * 1024 * 1024 * 1024ULL) - XFS_MIN_LOG_BYTES)
251 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
253 typedef struct xfs_growfs_data
{
254 __u64 newblocks
; /* new data subvol size, fsblocks */
255 __u32 imaxpct
; /* new inode space percentage limit */
258 typedef struct xfs_growfs_log
{
259 __u32 newblocks
; /* new log size, fsblocks */
260 __u32 isint
; /* 1 if new log is internal */
263 typedef struct xfs_growfs_rt
{
264 __u64 newblocks
; /* new realtime size, fsblocks */
265 __u32 extsize
; /* new realtime extent size, fsblocks */
270 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
272 typedef struct xfs_bstime
{
273 time_t tv_sec
; /* seconds */
274 __s32 tv_nsec
; /* and nanoseconds */
277 typedef struct xfs_bstat
{
278 __u64 bs_ino
; /* inode number */
279 __u16 bs_mode
; /* type and mode */
280 __u16 bs_nlink
; /* number of links */
281 __u32 bs_uid
; /* user id */
282 __u32 bs_gid
; /* group id */
283 __u32 bs_rdev
; /* device value */
284 __s32 bs_blksize
; /* block size */
285 __s64 bs_size
; /* file size */
286 xfs_bstime_t bs_atime
; /* access time */
287 xfs_bstime_t bs_mtime
; /* modify time */
288 xfs_bstime_t bs_ctime
; /* inode change time */
289 int64_t bs_blocks
; /* number of blocks */
290 __u32 bs_xflags
; /* extended flags */
291 __s32 bs_extsize
; /* extent size */
292 __s32 bs_extents
; /* number of extents */
293 __u32 bs_gen
; /* generation count */
294 __u16 bs_projid
; /* project id */
295 __u16 bs_forkoff
; /* inode fork offset in bytes */
296 unsigned char bs_pad
[12]; /* pad space, unused */
297 __u32 bs_dmevmask
; /* DMIG event mask */
298 __u16 bs_dmstate
; /* DMIG state info */
299 __u16 bs_aextents
; /* attribute number of extents */
303 * The user-level BulkStat Request interface structure.
305 typedef struct xfs_fsop_bulkreq
{
306 __u64 __user
*lastip
; /* last inode # pointer */
307 __s32 icount
; /* count of entries in buffer */
308 void __user
*ubuffer
;/* user buffer for inode desc. */
309 __s32 __user
*ocount
; /* output count pointer */
310 } xfs_fsop_bulkreq_t
;
314 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
316 typedef struct xfs_inogrp
{
317 __u64 xi_startino
; /* starting inode number */
318 __s32 xi_alloccount
; /* # bits set in allocmask */
319 __u64 xi_allocmask
; /* mask of allocated inodes */
326 typedef struct xfs_error_injection
{
329 } xfs_error_injection_t
;
333 * The user-level Handle Request interface structure.
335 typedef struct xfs_fsop_handlereq
{
336 __u32 fd
; /* fd for FD_TO_HANDLE */
337 void __user
*path
; /* user pathname */
338 __u32 oflags
; /* open flags */
339 void __user
*ihandle
;/* user supplied handle */
340 __u32 ihandlen
; /* user supplied length */
341 void __user
*ohandle
;/* user buffer for handle */
342 __u32 __user
*ohandlen
;/* user buffer length */
343 } xfs_fsop_handlereq_t
;
346 * Compound structures for passing args through Handle Request interfaces
347 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
348 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
349 * XFS_IOC_ATTRMULTI_BY_HANDLE
352 typedef struct xfs_fsop_setdm_handlereq
{
353 struct xfs_fsop_handlereq hreq
; /* handle information */
354 struct fsdmidata __user
*data
; /* DMAPI data */
355 } xfs_fsop_setdm_handlereq_t
;
357 typedef struct xfs_attrlist_cursor
{
359 } xfs_attrlist_cursor_t
;
361 typedef struct xfs_fsop_attrlist_handlereq
{
362 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
363 struct xfs_attrlist_cursor pos
; /* opaque cookie, list offset */
364 __u32 flags
; /* which namespace to use */
365 __u32 buflen
; /* length of buffer supplied */
366 void __user
*buffer
; /* returned names */
367 } xfs_fsop_attrlist_handlereq_t
;
369 typedef struct xfs_attr_multiop
{
371 #define ATTR_OP_GET 1 /* return the indicated attr's value */
372 #define ATTR_OP_SET 2 /* set/create the indicated attr/value pair */
373 #define ATTR_OP_REMOVE 3 /* remove the indicated attr */
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 */
392 typedef struct xfs_fid
{
393 __u16 fid_len
; /* length of remainder */
395 __u32 fid_gen
; /* generation number */
396 __u64 fid_ino
; /* 64 bits inode number */
399 typedef struct xfs_handle
{
401 __s64 align
; /* force alignment of ha_fid */
402 xfs_fsid_t _ha_fsid
; /* unique file system identifier */
404 xfs_fid_t ha_fid
; /* file system specific file ID */
406 #define ha_fsid ha_u._ha_fsid
408 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.fid_pad \
409 - (char *) &(handle)) \
410 + (handle).ha_fid.fid_len)
413 * Flags for going down operation
415 #define XFS_FSOP_GOING_FLAGS_DEFAULT 0x0 /* going down */
416 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
417 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
420 * ioctl commands that are used by Linux filesystems
422 #define XFS_IOC_GETXFLAGS FS_IOC_GETFLAGS
423 #define XFS_IOC_SETXFLAGS FS_IOC_SETFLAGS
424 #define XFS_IOC_GETVERSION FS_IOC_GETVERSION
427 * ioctl commands that replace IRIX fcntl()'s
428 * For 'documentation' purposed more than anything else,
429 * the "cmd #" field reflects the IRIX fcntl number.
431 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
432 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
433 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
434 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
435 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
436 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
437 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
438 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
439 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
440 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
441 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
442 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
443 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
444 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
445 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
446 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
447 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
448 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
451 * ioctl commands that replace IRIX syssgi()'s
453 #define XFS_IOC_FSGEOMETRY_V1 _IOR ('X', 100, struct xfs_fsop_geom_v1)
454 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
455 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
456 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
457 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
458 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
459 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
460 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
461 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
462 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
463 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
464 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
465 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
466 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
467 #define XFS_IOC_SET_RESBLKS _IOWR('X', 114, struct xfs_fsop_resblks)
468 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
469 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
470 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
471 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
472 /* XFS_IOC_FREEZE -- FIFREEZE 119 */
473 /* XFS_IOC_THAW -- FITHAW 120 */
474 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
475 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
476 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
477 #define XFS_IOC_FSGEOMETRY _IOR ('X', 124, struct xfs_fsop_geom)
478 #define XFS_IOC_GOINGDOWN _IOR ('X', 125, __uint32_t)
479 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
482 #ifndef HAVE_BBMACROS
484 * Block I/O parameterization. A basic block (BB) is the lowest size of
485 * filesystem allocation, and must equal 512. Length units given to bio
486 * routines are in BB's.
489 #define BBSIZE (1<<BBSHIFT)
490 #define BBMASK (BBSIZE-1)
491 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
492 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
493 #define BBTOB(bbs) ((bbs) << BBSHIFT)
496 #endif /* __XFS_FS_H__ */