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 unsigned char fsx_pad[16];
68 * Flags for the bs_xflags/fsx_xflags field
69 * There should be a one-to-one correspondence between these flags and the
72 #define XFS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
73 #define XFS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
74 #define XFS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
75 #define XFS_XFLAG_APPEND 0x00000010 /* all writes append */
76 #define XFS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
77 #define XFS_XFLAG_NOATIME 0x00000040 /* do not update access time */
78 #define XFS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
79 #define XFS_XFLAG_BARRIER 0x00004000 /* chroot() barrier */
80 #define XFS_XFLAG_IUNLINK 0x00008000 /* Immutable unlink */
81 #define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
84 * Structure for XFS_IOC_GETBMAP.
85 * On input, fill in bmv_offset and bmv_length of the first structure
86 * to indicate the area of interest in the file, and bmv_entry with the
87 * number of array elements given. The first structure is updated on
88 * return to give the offset and length for the next call.
92 __s64 bmv_offset; /* file offset of segment in blocks */
93 __s64 bmv_block; /* starting block (64-bit daddr_t) */
94 __s64 bmv_length; /* length of segment, blocks */
95 __s32 bmv_count; /* # of entries in array incl. 1st */
96 __s32 bmv_entries; /* # of entries filled in (output) */
101 * Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
102 * are used exactly as in the getbmap structure. The getbmapx structure
103 * has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
104 * is only used for the first structure. It contains input flags
105 * specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
106 * in by the XFS_IOC_GETBMAPX command for each returned structure after
109 #ifndef HAVE_GETBMAPX
111 __s64 bmv_offset; /* file offset of segment in blocks */
112 __s64 bmv_block; /* starting block (64-bit daddr_t) */
113 __s64 bmv_length; /* length of segment, blocks */
114 __s32 bmv_count; /* # of entries in array incl. 1st */
115 __s32 bmv_entries; /* # of entries filled in (output). */
116 __s32 bmv_iflags; /* input flags (1st structure) */
117 __s32 bmv_oflags; /* output flags (after 1st structure)*/
118 __s32 bmv_unused1; /* future use */
119 __s32 bmv_unused2; /* future use */
123 /* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
124 #define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
125 #define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
126 #define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
127 #define BMV_IF_VALID (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC)
129 #define BMV_IF_EXTENDED 0x40000000 /* getpmapx if set */
132 /* bmv_oflags values - returned for for each non-header segment */
133 #define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
135 /* Convert getbmap <-> getbmapx - move fields from p1 to p2. */
136 #define GETBMAP_CONVERT(p1,p2) { \
137 p2.bmv_offset = p1.bmv_offset; \
138 p2.bmv_block = p1.bmv_block; \
139 p2.bmv_length = p1.bmv_length; \
140 p2.bmv_count = p1.bmv_count; \
141 p2.bmv_entries = p1.bmv_entries; }
145 * Structure for XFS_IOC_FSSETDM.
146 * For use by backup and restore programs to set the XFS on-disk inode
147 * fields di_dmevmask and di_dmstate. These must be set to exactly and
148 * only values previously obtained via xfs_bulkstat! (Specifically the
149 * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
151 #ifndef HAVE_FSDMIDATA
153 __u32 fsd_dmevmask; /* corresponds to di_dmevmask */
155 __u16 fsd_dmstate; /* corresponds to di_dmstate */
160 * File segment locking set data type for 64 bit access.
161 * Also used for all the RESV/FREE interfaces.
163 typedef struct xfs_flock64 {
167 __s64 l_len; /* len == 0 means until end of file */
170 __s32 l_pad[4]; /* reserve area */
174 * Output for XFS_IOC_FSGEOMETRY_V1
176 typedef struct xfs_fsop_geom_v1 {
177 __u32 blocksize; /* filesystem (data) block size */
178 __u32 rtextsize; /* realtime extent size */
179 __u32 agblocks; /* fsblocks in an AG */
180 __u32 agcount; /* number of allocation groups */
181 __u32 logblocks; /* fsblocks in the log */
182 __u32 sectsize; /* (data) sector size, bytes */
183 __u32 inodesize; /* inode size in bytes */
184 __u32 imaxpct; /* max allowed inode space(%) */
185 __u64 datablocks; /* fsblocks in data subvolume */
186 __u64 rtblocks; /* fsblocks in realtime subvol */
187 __u64 rtextents; /* rt extents in realtime subvol*/
188 __u64 logstart; /* starting fsblock of the log */
189 unsigned char uuid[16]; /* unique id of the filesystem */
190 __u32 sunit; /* stripe unit, fsblocks */
191 __u32 swidth; /* stripe width, fsblocks */
192 __s32 version; /* structure version */
193 __u32 flags; /* superblock version flags */
194 __u32 logsectsize; /* log sector size, bytes */
195 __u32 rtsectsize; /* realtime sector size, bytes */
196 __u32 dirblocksize; /* directory block size, bytes */
197 } xfs_fsop_geom_v1_t;
200 * Output for XFS_IOC_FSGEOMETRY
202 typedef struct xfs_fsop_geom {
203 __u32 blocksize; /* filesystem (data) block size */
204 __u32 rtextsize; /* realtime extent size */
205 __u32 agblocks; /* fsblocks in an AG */
206 __u32 agcount; /* number of allocation groups */
207 __u32 logblocks; /* fsblocks in the log */
208 __u32 sectsize; /* (data) sector size, bytes */
209 __u32 inodesize; /* inode size in bytes */
210 __u32 imaxpct; /* max allowed inode space(%) */
211 __u64 datablocks; /* fsblocks in data subvolume */
212 __u64 rtblocks; /* fsblocks in realtime subvol */
213 __u64 rtextents; /* rt extents in realtime subvol*/
214 __u64 logstart; /* starting fsblock of the log */
215 unsigned char uuid[16]; /* unique id of the filesystem */
216 __u32 sunit; /* stripe unit, fsblocks */
217 __u32 swidth; /* stripe width, fsblocks */
218 __s32 version; /* structure version */
219 __u32 flags; /* superblock version flags */
220 __u32 logsectsize; /* log sector size, bytes */
221 __u32 rtsectsize; /* realtime sector size, bytes */
222 __u32 dirblocksize; /* directory block size, bytes */
223 __u32 logsunit; /* log stripe unit, bytes */
226 /* Output for XFS_FS_COUNTS */
227 typedef struct xfs_fsop_counts {
228 __u64 freedata; /* free data section blocks */
229 __u64 freertx; /* free rt extents */
230 __u64 freeino; /* free inodes */
231 __u64 allocino; /* total allocated inodes */
234 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
235 typedef struct xfs_fsop_resblks {
238 } xfs_fsop_resblks_t;
240 #define XFS_FSOP_GEOM_VERSION 0
242 #define XFS_FSOP_GEOM_FLAGS_ATTR 0x0001 /* attributes in use */
243 #define XFS_FSOP_GEOM_FLAGS_NLINK 0x0002 /* 32-bit nlink values */
244 #define XFS_FSOP_GEOM_FLAGS_QUOTA 0x0004 /* quotas enabled */
245 #define XFS_FSOP_GEOM_FLAGS_IALIGN 0x0008 /* inode alignment */
246 #define XFS_FSOP_GEOM_FLAGS_DALIGN 0x0010 /* large data alignment */
247 #define XFS_FSOP_GEOM_FLAGS_SHARED 0x0020 /* read-only shared */
248 #define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x0040 /* special extent flag */
249 #define XFS_FSOP_GEOM_FLAGS_DIRV2 0x0080 /* directory version 2 */
250 #define XFS_FSOP_GEOM_FLAGS_LOGV2 0x0100 /* log format version 2 */
251 #define XFS_FSOP_GEOM_FLAGS_SECTOR 0x0200 /* sector sizes >1BB */
255 * Minimum and maximum sizes need for growth checks
257 #define XFS_MIN_AG_BLOCKS 64
258 #define XFS_MIN_LOG_BLOCKS 512
259 #define XFS_MAX_LOG_BLOCKS (64 * 1024)
260 #define XFS_MIN_LOG_BYTES (256 * 1024)
261 #define XFS_MAX_LOG_BYTES (128 * 1024 * 1024)
264 * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
266 typedef struct xfs_growfs_data {
267 __u64 newblocks; /* new data subvol size, fsblocks */
268 __u32 imaxpct; /* new inode space percentage limit */
271 typedef struct xfs_growfs_log {
272 __u32 newblocks; /* new log size, fsblocks */
273 __u32 isint; /* 1 if new log is internal */
276 typedef struct xfs_growfs_rt {
277 __u64 newblocks; /* new realtime size, fsblocks */
278 __u32 extsize; /* new realtime extent size, fsblocks */
283 * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
285 typedef struct xfs_bstime {
286 time_t tv_sec; /* seconds */
287 __s32 tv_nsec; /* and nanoseconds */
290 typedef struct xfs_bstat {
291 __u64 bs_ino; /* inode number */
292 __u16 bs_mode; /* type and mode */
293 __u16 bs_nlink; /* number of links */
294 __u32 bs_uid; /* user id */
295 __u32 bs_gid; /* group id */
296 __u32 bs_rdev; /* device value */
297 __s32 bs_blksize; /* block size */
298 __s64 bs_size; /* file size */
299 xfs_bstime_t bs_atime; /* access time */
300 xfs_bstime_t bs_mtime; /* modify time */
301 xfs_bstime_t bs_ctime; /* inode change time */
302 int64_t bs_blocks; /* number of blocks */
303 __u32 bs_xflags; /* extended flags */
304 __s32 bs_extsize; /* extent size */
305 __s32 bs_extents; /* number of extents */
306 __u32 bs_gen; /* generation count */
307 __u16 bs_projid; /* project id */
308 unsigned char bs_pad[14]; /* pad space, unused */
309 __u32 bs_dmevmask; /* DMIG event mask */
310 __u16 bs_dmstate; /* DMIG state info */
311 __u16 bs_aextents; /* attribute number of extents */
315 * The user-level BulkStat Request interface structure.
317 typedef struct xfs_fsop_bulkreq {
318 __u64 *lastip; /* last inode # pointer */
319 __s32 icount; /* count of entries in buffer */
320 void *ubuffer; /* user buffer for inode desc. */
321 __s32 *ocount; /* output count pointer */
322 } xfs_fsop_bulkreq_t;
326 * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
328 typedef struct xfs_inogrp {
329 __u64 xi_startino; /* starting inode number */
330 __s32 xi_alloccount; /* # bits set in allocmask */
331 __u64 xi_allocmask; /* mask of allocated inodes */
338 typedef struct xfs_error_injection {
341 } xfs_error_injection_t;
345 * The user-level Handle Request interface structure.
347 typedef struct xfs_fsop_handlereq {
348 __u32 fd; /* fd for FD_TO_HANDLE */
349 void *path; /* user pathname */
350 __u32 oflags; /* open flags */
351 void *ihandle; /* user supplied handle */
352 __u32 ihandlen; /* user supplied length */
353 void *ohandle; /* user buffer for handle */
354 __u32 *ohandlen; /* user buffer length */
355 } xfs_fsop_handlereq_t;
358 * Compound structures for passing args through Handle Request interfaces
359 * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
360 * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
361 * XFS_IOC_ATTRMULTI_BY_HANDLE
364 typedef struct xfs_fsop_setdm_handlereq {
365 struct xfs_fsop_handlereq hreq; /* handle interface structure */
366 struct fsdmidata *data; /* DMAPI data to set */
367 } xfs_fsop_setdm_handlereq_t;
369 typedef struct xfs_attrlist_cursor {
371 } xfs_attrlist_cursor_t;
373 typedef struct xfs_fsop_attrlist_handlereq {
374 struct xfs_fsop_handlereq hreq; /* handle interface structure */
375 struct xfs_attrlist_cursor pos; /* opaque cookie, list offset */
376 __u32 flags; /* flags, use ROOT/USER names */
377 __u32 buflen; /* length of buffer supplied */
378 void *buffer; /* attrlist data to return */
379 } xfs_fsop_attrlist_handlereq_t;
381 typedef struct xfs_attr_multiop {
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 *ops; /* attr_multi data to get/set */
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 */
406 __u16 fid_len; /* length of data in bytes */
407 unsigned char fid_data[MAXFIDSZ]; /* data (fid_len worth) */
411 typedef struct xfs_fid {
412 __u16 xfs_fid_len; /* length of remainder */
414 __u32 xfs_fid_gen; /* generation number */
415 __u64 xfs_fid_ino; /* 64 bits inode number */
418 typedef struct xfs_fid2 {
419 __u16 fid_len; /* length of remainder */
420 __u16 fid_pad; /* padding, must be zero */
421 __u32 fid_gen; /* generation number */
422 __u64 fid_ino; /* inode number */
425 typedef struct xfs_handle {
427 __s64 align; /* force alignment of ha_fid */
428 xfs_fsid_t _ha_fsid; /* unique file system identifier */
430 xfs_fid_t ha_fid; /* file system specific file ID */
432 #define ha_fsid ha_u._ha_fsid
434 #define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.xfs_fid_pad \
435 - (char *) &(handle)) \
436 + (handle).ha_fid.xfs_fid_len)
438 #define XFS_HANDLE_CMP(h1, h2) memcmp(h1, h2, sizeof(xfs_handle_t))
440 #define FSHSIZE sizeof(fsid_t)
443 * Flags for going down operation
445 #define XFS_FSOP_GOING_FLAGS_DEFAULT 0x0 /* going down */
446 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
447 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
450 * ioctl commands that replace IRIX fcntl()'s
451 * For 'documentation' purposed more than anything else,
452 * the "cmd #" field reflects the IRIX fcntl number.
454 #define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
455 #define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
456 #define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
457 #define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
458 #define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
459 #define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
460 #define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
461 #define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
462 #define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
463 #define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
464 #define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
465 #define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
466 #define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
467 #define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
468 #define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
469 /* XFS_IOC_SETBIOSIZE ---- deprecated 46 */
470 /* XFS_IOC_GETBIOSIZE ---- deprecated 47 */
471 #define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
474 * ioctl commands that replace IRIX syssgi()'s
476 #define XFS_IOC_FSGEOMETRY_V1 _IOR ('X', 100, struct xfs_fsop_geom_v1)
477 #define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
478 #define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
479 #define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
480 #define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
481 #define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
482 #define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
483 #define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
484 #define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
485 #define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
486 #define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
487 #define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
488 #define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
489 #define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
490 #define XFS_IOC_SET_RESBLKS _IOWR('X', 114, struct xfs_fsop_resblks)
491 #define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
492 #define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
493 #define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
494 /* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
495 #define XFS_IOC_FREEZE _IOWR('X', 119, int)
496 #define XFS_IOC_THAW _IOWR('X', 120, int)
497 #define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
498 #define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
499 #define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
500 #define XFS_IOC_FSGEOMETRY _IOR ('X', 124, struct xfs_fsop_geom)
501 #define XFS_IOC_GOINGDOWN _IOR ('X', 125, __uint32_t)
502 /* XFS_IOC_GETFSUUID ---------- deprecated 140 */
505 #ifndef HAVE_BBMACROS
507 * Block I/O parameterization. A basic block (BB) is the lowest size of
508 * filesystem allocation, and must equal 512. Length units given to bio
509 * routines are in BB's.
512 #define BBSIZE (1<<BBSHIFT)
513 #define BBMASK (BBSIZE-1)
514 #define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
515 #define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
516 #define BBTOB(bbs) ((bbs) << BBSHIFT)
519 #endif /* __XFS_FS_H__ */