2 * Copyright (c) 1995-2003 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/
37 * SGI's XFS filesystem's major stuff (constants, structures)
40 #define XFS_NAME "xfs"
43 * Direct I/O attribute record used with XFS_IOC_DIOINFO
44 * d_miniosz is the min xfer size, xfer size multiple and file seek offset
49 __u32 d_mem
; /* data buffer memory alignment */
50 __u32 d_miniosz
; /* min xfer size */
51 __u32 d_maxiosz
; /* max xfer size */
56 * Structure for XFS_IOC_FSGETXATTR[A] and XFS_IOC_FSSETXATTR.
60 __u32 fsx_xflags
; /* xflags field value (get/set) */
61 __u32 fsx_extsize
; /* extsize field value (get/set)*/
62 __u32 fsx_nextents
; /* nextents field value (get) */
63 __u32 fsx_projid
; /* project identifier (get/set) */
64 unsigned char fsx_pad
[12];
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 /* data in realtime volume */
74 #define XFS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
75 #define XFS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
76 #define XFS_XFLAG_APPEND 0x00000010 /* all writes append */
77 #define XFS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
78 #define XFS_XFLAG_NOATIME 0x00000040 /* do not update access time */
79 #define XFS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
80 #define XFS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
81 #define XFS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
82 #define XFS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
83 #define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
86 * Structure for XFS_IOC_GETBMAP.
87 * On input, fill in bmv_offset and bmv_length of the first structure
88 * to indicate the area of interest in the file, and bmv_entry with the
89 * number of array elements given. The first structure is updated on
90 * return to give the offset and length for the next call.
94 __s64 bmv_offset
; /* file offset of segment in blocks */
95 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
96 __s64 bmv_length
; /* length of segment, blocks */
97 __s32 bmv_count
; /* # of entries in array incl. 1st */
98 __s32 bmv_entries
; /* # of entries filled in (output) */
103 * Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
104 * are used exactly as in the getbmap structure. The getbmapx structure
105 * has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
106 * is only used for the first structure. It contains input flags
107 * specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
108 * in by the XFS_IOC_GETBMAPX command for each returned structure after
111 #ifndef HAVE_GETBMAPX
113 __s64 bmv_offset
; /* file offset of segment in blocks */
114 __s64 bmv_block
; /* starting block (64-bit daddr_t) */
115 __s64 bmv_length
; /* length of segment, blocks */
116 __s32 bmv_count
; /* # of entries in array incl. 1st */
117 __s32 bmv_entries
; /* # of entries filled in (output). */
118 __s32 bmv_iflags
; /* input flags (1st structure) */
119 __s32 bmv_oflags
; /* output flags (after 1st structure)*/
120 __s32 bmv_unused1
; /* future use */
121 __s32 bmv_unused2
; /* future use */
125 /* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
126 #define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
127 #define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
128 #define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
129 #define BMV_IF_VALID (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC)
131 #define BMV_IF_EXTENDED 0x40000000 /* getpmapx if set */
134 /* bmv_oflags values - returned for for each non-header segment */
135 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
137 /* Convert getbmap <-> getbmapx - move fields from p1 to p2. */
138 #define GETBMAP_CONVERT(p1,p2) { \
139 p2.bmv_offset = p1.bmv_offset; \
140 p2.bmv_block = p1.bmv_block; \
141 p2.bmv_length = p1.bmv_length; \
142 p2.bmv_count = p1.bmv_count; \
143 p2.bmv_entries = p1.bmv_entries; }
147 * Structure for XFS_IOC_FSSETDM.
148 * For use by backup and restore programs to set the XFS on-disk inode
149 * fields di_dmevmask and di_dmstate. These must be set to exactly and
150 * only values previously obtained via xfs_bulkstat! (Specifically the
151 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
153 #ifndef HAVE_FSDMIDATA
155 __u32 fsd_dmevmask
; /* corresponds to di_dmevmask */
157 __u16 fsd_dmstate
; /* corresponds to di_dmstate */
162 * File segment locking set data type for 64 bit access.
163 * Also used for all the RESV/FREE interfaces.
165 typedef struct xfs_flock64
{
169 __s64 l_len
; /* len == 0 means until end of file */
172 __s32 l_pad
[4]; /* reserve area */
176 * Output for XFS_IOC_FSGEOMETRY_V1
178 typedef struct xfs_fsop_geom_v1
{
179 __u32 blocksize
; /* filesystem (data) block size */
180 __u32 rtextsize
; /* realtime extent size */
181 __u32 agblocks
; /* fsblocks in an AG */
182 __u32 agcount
; /* number of allocation groups */
183 __u32 logblocks
; /* fsblocks in the log */
184 __u32 sectsize
; /* (data) sector size, bytes */
185 __u32 inodesize
; /* inode size in bytes */
186 __u32 imaxpct
; /* max allowed inode space(%) */
187 __u64 datablocks
; /* fsblocks in data subvolume */
188 __u64 rtblocks
; /* fsblocks in realtime subvol */
189 __u64 rtextents
; /* rt extents in realtime subvol*/
190 __u64 logstart
; /* starting fsblock of the log */
191 unsigned char uuid
[16]; /* unique id of the filesystem */
192 __u32 sunit
; /* stripe unit, fsblocks */
193 __u32 swidth
; /* stripe width, fsblocks */
194 __s32 version
; /* structure version */
195 __u32 flags
; /* superblock version flags */
196 __u32 logsectsize
; /* log sector size, bytes */
197 __u32 rtsectsize
; /* realtime sector size, bytes */
198 __u32 dirblocksize
; /* directory block size, bytes */
199 } xfs_fsop_geom_v1_t
;
202 * Output for XFS_IOC_FSGEOMETRY
204 typedef struct xfs_fsop_geom
{
205 __u32 blocksize
; /* filesystem (data) block size */
206 __u32 rtextsize
; /* realtime extent size */
207 __u32 agblocks
; /* fsblocks in an AG */
208 __u32 agcount
; /* number of allocation groups */
209 __u32 logblocks
; /* fsblocks in the log */
210 __u32 sectsize
; /* (data) sector size, bytes */
211 __u32 inodesize
; /* inode size in bytes */
212 __u32 imaxpct
; /* max allowed inode space(%) */
213 __u64 datablocks
; /* fsblocks in data subvolume */
214 __u64 rtblocks
; /* fsblocks in realtime subvol */
215 __u64 rtextents
; /* rt extents in realtime subvol*/
216 __u64 logstart
; /* starting fsblock of the log */
217 unsigned char uuid
[16]; /* unique id of the filesystem */
218 __u32 sunit
; /* stripe unit, fsblocks */
219 __u32 swidth
; /* stripe width, fsblocks */
220 __s32 version
; /* structure version */
221 __u32 flags
; /* superblock version flags */
222 __u32 logsectsize
; /* log sector size, bytes */
223 __u32 rtsectsize
; /* realtime sector size, bytes */
224 __u32 dirblocksize
; /* directory block size, bytes */
225 __u32 logsunit
; /* log stripe unit, bytes */
228 /* Output for XFS_FS_COUNTS */
229 typedef struct xfs_fsop_counts
{
230 __u64 freedata
; /* free data section blocks */
231 __u64 freertx
; /* free rt extents */
232 __u64 freeino
; /* free inodes */
233 __u64 allocino
; /* total allocated inodes */
236 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
237 typedef struct xfs_fsop_resblks
{
240 } xfs_fsop_resblks_t
;
242 #define XFS_FSOP_GEOM_VERSION 0
244 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x0001 /* attributes in use */
245 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x0002 /* 32-bit nlink values */
246 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x0004 /* quotas enabled */
247 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x0008 /* inode alignment */
248 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x0010 /* large data alignment */
249 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x0020 /* read-only shared */
250 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x0040 /* special extent flag */
251 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x0080 /* directory version 2 */
252 #define XFS_FSOP_GEOM_FLAGS_LOGV2 0x0100 /* log format version 2 */
253 #define XFS_FSOP_GEOM_FLAGS_SECTOR 0x0200 /* sector sizes >1BB */
257 * Minimum and maximum sizes need for growth checks
259 #define XFS_MIN_AG_BLOCKS 64
260 #define XFS_MIN_LOG_BLOCKS 512
261 #define XFS_MAX_LOG_BLOCKS (64 * 1024)
262 #define XFS_MIN_LOG_BYTES (256 * 1024)
263 #define XFS_MAX_LOG_BYTES (128 * 1024 * 1024)
266 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
268 typedef struct xfs_growfs_data
{
269 __u64 newblocks
; /* new data subvol size, fsblocks */
270 __u32 imaxpct
; /* new inode space percentage limit */
273 typedef struct xfs_growfs_log
{
274 __u32 newblocks
; /* new log size, fsblocks */
275 __u32 isint
; /* 1 if new log is internal */
278 typedef struct xfs_growfs_rt
{
279 __u64 newblocks
; /* new realtime size, fsblocks */
280 __u32 extsize
; /* new realtime extent size, fsblocks */
285 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
287 typedef struct xfs_bstime
{
288 time_t tv_sec
; /* seconds */
289 __s32 tv_nsec
; /* and nanoseconds */
292 typedef struct xfs_bstat
{
293 __u64 bs_ino
; /* inode number */
294 __u16 bs_mode
; /* type and mode */
295 __u16 bs_nlink
; /* number of links */
296 __u32 bs_uid
; /* user id */
297 __u32 bs_gid
; /* group id */
298 __u32 bs_rdev
; /* device value */
299 __s32 bs_blksize
; /* block size */
300 __s64 bs_size
; /* file size */
301 xfs_bstime_t bs_atime
; /* access time */
302 xfs_bstime_t bs_mtime
; /* modify time */
303 xfs_bstime_t bs_ctime
; /* inode change time */
304 int64_t bs_blocks
; /* number of blocks */
305 __u32 bs_xflags
; /* extended flags */
306 __s32 bs_extsize
; /* extent size */
307 __s32 bs_extents
; /* number of extents */
308 __u32 bs_gen
; /* generation count */
309 __u16 bs_projid
; /* project id */
310 unsigned char bs_pad
[14]; /* pad space, unused */
311 __u32 bs_dmevmask
; /* DMIG event mask */
312 __u16 bs_dmstate
; /* DMIG state info */
313 __u16 bs_aextents
; /* attribute number of extents */
317 * The user-level BulkStat Request interface structure.
319 typedef struct xfs_fsop_bulkreq
{
320 __u64 __user
*lastip
; /* last inode # pointer */
321 __s32 icount
; /* count of entries in buffer */
322 void __user
*ubuffer
;/* user buffer for inode desc. */
323 __s32 __user
*ocount
; /* output count pointer */
324 } xfs_fsop_bulkreq_t
;
328 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
330 typedef struct xfs_inogrp
{
331 __u64 xi_startino
; /* starting inode number */
332 __s32 xi_alloccount
; /* # bits set in allocmask */
333 __u64 xi_allocmask
; /* mask of allocated inodes */
340 typedef struct xfs_error_injection
{
343 } xfs_error_injection_t
;
347 * The user-level Handle Request interface structure.
349 typedef struct xfs_fsop_handlereq
{
350 __u32 fd
; /* fd for FD_TO_HANDLE */
351 void __user
*path
; /* user pathname */
352 __u32 oflags
; /* open flags */
353 void __user
*ihandle
;/* user supplied handle */
354 __u32 ihandlen
; /* user supplied length */
355 void __user
*ohandle
;/* user buffer for handle */
356 __u32 __user
*ohandlen
;/* user buffer length */
357 } xfs_fsop_handlereq_t
;
360 * Compound structures for passing args through Handle Request interfaces
361 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
362 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
363 * XFS_IOC_ATTRMULTI_BY_HANDLE
366 typedef struct xfs_fsop_setdm_handlereq
{
367 struct xfs_fsop_handlereq hreq
; /* handle information */
368 struct fsdmidata __user
*data
; /* DMAPI data */
369 } xfs_fsop_setdm_handlereq_t
;
371 typedef struct xfs_attrlist_cursor
{
373 } xfs_attrlist_cursor_t
;
375 typedef struct xfs_fsop_attrlist_handlereq
{
376 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
377 struct xfs_attrlist_cursor pos
; /* opaque cookie, list offset */
378 __u32 flags
; /* which namespace to use */
379 __u32 buflen
; /* length of buffer supplied */
380 void __user
*buffer
; /* returned names */
381 } xfs_fsop_attrlist_handlereq_t
;
383 typedef struct xfs_attr_multiop
{
386 void __user
*am_attrname
;
387 void __user
*am_attrvalue
;
390 } xfs_attr_multiop_t
;
392 typedef struct xfs_fsop_attrmulti_handlereq
{
393 struct xfs_fsop_handlereq hreq
; /* handle interface structure */
394 __u32 opcount
;/* count of following multiop */
395 struct xfs_attr_multiop __user
*ops
; /* attr_multi data */
396 } xfs_fsop_attrmulti_handlereq_t
;
399 * per machine unique filesystem identifier types.
401 typedef struct { __u32 val
[2]; } xfs_fsid_t
; /* file system id type */
408 __u16 fid_len
; /* length of data in bytes */
409 unsigned char fid_data
[MAXFIDSZ
]; /* data (fid_len worth) */
413 typedef struct xfs_fid
{
414 __u16 xfs_fid_len
; /* length of remainder */
416 __u32 xfs_fid_gen
; /* generation number */
417 __u64 xfs_fid_ino
; /* 64 bits inode number */
420 typedef struct xfs_fid2
{
421 __u16 fid_len
; /* length of remainder */
422 __u16 fid_pad
; /* padding, must be zero */
423 __u32 fid_gen
; /* generation number */
424 __u64 fid_ino
; /* inode number */
427 typedef struct xfs_handle
{
429 __s64 align
; /* force alignment of ha_fid */
430 xfs_fsid_t _ha_fsid
; /* unique file system identifier */
432 xfs_fid_t ha_fid
; /* file system specific file ID */
434 #define ha_fsid ha_u._ha_fsid
436 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.xfs_fid_pad \
437 - (char *) &(handle)) \
438 + (handle).ha_fid.xfs_fid_len)
440 #define XFS_HANDLE_CMP(h1, h2) memcmp(h1, h2, sizeof(xfs_handle_t))
442 #define FSHSIZE sizeof(fsid_t)
445 * Flags for going down operation
447 #define XFS_FSOP_GOING_FLAGS_DEFAULT 0x0 /* going down */
448 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
449 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
452 * ioctl commands that are used by Linux filesystems
454 #define XFS_IOC_GETXFLAGS _IOR('f', 1, long)
455 #define XFS_IOC_SETXFLAGS _IOW('f', 2, long)
456 #define XFS_IOC_GETVERSION _IOR('v', 1, long)
459 * ioctl commands that replace IRIX fcntl()'s
460 * For 'documentation' purposed more than anything else,
461 * the "cmd #" field reflects the IRIX fcntl number.
463 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
464 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
465 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
466 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
467 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
468 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
469 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
470 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
471 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
472 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
473 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
474 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
475 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
476 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
477 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
478 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
479 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
480 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
483 * ioctl commands that replace IRIX syssgi()'s
485 #define XFS_IOC_FSGEOMETRY_V1 _IOR ('X', 100, struct xfs_fsop_geom_v1)
486 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
487 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
488 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
489 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
490 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
491 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
492 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
493 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
494 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
495 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
496 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
497 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
498 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
499 #define XFS_IOC_SET_RESBLKS _IOWR('X', 114, struct xfs_fsop_resblks)
500 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
501 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
502 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
503 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
504 #define XFS_IOC_FREEZE _IOWR('X', 119, int)
505 #define XFS_IOC_THAW _IOWR('X', 120, int)
506 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
507 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
508 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
509 #define XFS_IOC_FSGEOMETRY _IOR ('X', 124, struct xfs_fsop_geom)
510 #define XFS_IOC_GOINGDOWN _IOR ('X', 125, __uint32_t)
511 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
514 #ifndef HAVE_BBMACROS
516 * Block I/O parameterization. A basic block (BB) is the lowest size of
517 * filesystem allocation, and must equal 512. Length units given to bio
518 * routines are in BB's.
521 #define BBSIZE (1<<BBSHIFT)
522 #define BBMASK (BBSIZE-1)
523 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
524 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
525 #define BBTOB(bbs) ((bbs) << BBSHIFT)
528 #endif /* __XFS_FS_H__ */