xref: /openbmc/linux/fs/xfs/libxfs/xfs_fs.h (revision 9b93eb47)
1 // SPDX-License-Identifier: LGPL-2.1
2 /*
3  * Copyright (c) 1995-2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef __XFS_FS_H__
7 #define __XFS_FS_H__
8 
9 /*
10  * SGI's XFS filesystem's major stuff (constants, structures)
11  */
12 
13 /*
14  * Direct I/O attribute record used with XFS_IOC_DIOINFO
15  * d_miniosz is the min xfer size, xfer size multiple and file seek offset
16  * alignment.
17  */
18 #ifndef HAVE_DIOATTR
19 struct dioattr {
20 	__u32		d_mem;		/* data buffer memory alignment */
21 	__u32		d_miniosz;	/* min xfer size		*/
22 	__u32		d_maxiosz;	/* max xfer size		*/
23 };
24 #endif
25 
26 /*
27  * Structure for XFS_IOC_GETBMAP.
28  * On input, fill in bmv_offset and bmv_length of the first structure
29  * to indicate the area of interest in the file, and bmv_entries with
30  * the number of array elements given back.  The first structure is
31  * updated on return to give the offset and length for the next call.
32  */
33 #ifndef HAVE_GETBMAP
34 struct getbmap {
35 	__s64		bmv_offset;	/* file offset of segment in blocks */
36 	__s64		bmv_block;	/* starting block (64-bit daddr_t)  */
37 	__s64		bmv_length;	/* length of segment, blocks	    */
38 	__s32		bmv_count;	/* # of entries in array incl. 1st  */
39 	__s32		bmv_entries;	/* # of entries filled in (output)  */
40 };
41 #endif
42 
43 /*
44  *	Structure for XFS_IOC_GETBMAPX.	 Fields bmv_offset through bmv_entries
45  *	are used exactly as in the getbmap structure.  The getbmapx structure
46  *	has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
47  *	is only used for the first structure.  It contains input flags
48  *	specifying XFS_IOC_GETBMAPX actions.  The bmv_oflags field is filled
49  *	in by the XFS_IOC_GETBMAPX command for each returned structure after
50  *	the first.
51  */
52 #ifndef HAVE_GETBMAPX
53 struct getbmapx {
54 	__s64		bmv_offset;	/* file offset of segment in blocks */
55 	__s64		bmv_block;	/* starting block (64-bit daddr_t)  */
56 	__s64		bmv_length;	/* length of segment, blocks	    */
57 	__s32		bmv_count;	/* # of entries in array incl. 1st  */
58 	__s32		bmv_entries;	/* # of entries filled in (output). */
59 	__s32		bmv_iflags;	/* input flags (1st structure)	    */
60 	__s32		bmv_oflags;	/* output flags (after 1st structure)*/
61 	__s32		bmv_unused1;	/* future use			    */
62 	__s32		bmv_unused2;	/* future use			    */
63 };
64 #endif
65 
66 /*	bmv_iflags values - set by XFS_IOC_GETBMAPX caller.	*/
67 #define BMV_IF_ATTRFORK		0x1	/* return attr fork rather than data */
68 #define BMV_IF_NO_DMAPI_READ	0x2	/* Do not generate DMAPI read event  */
69 #define BMV_IF_PREALLOC		0x4	/* rtn status BMV_OF_PREALLOC if req */
70 #define BMV_IF_DELALLOC		0x8	/* rtn status BMV_OF_DELALLOC if req */
71 #define BMV_IF_NO_HOLES		0x10	/* Do not return holes */
72 #define BMV_IF_COWFORK		0x20	/* return CoW fork rather than data */
73 #define BMV_IF_VALID	\
74 	(BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC|	\
75 	 BMV_IF_DELALLOC|BMV_IF_NO_HOLES|BMV_IF_COWFORK)
76 
77 /*	bmv_oflags values - returned for each non-header segment */
78 #define BMV_OF_PREALLOC		0x1	/* segment = unwritten pre-allocation */
79 #define BMV_OF_DELALLOC		0x2	/* segment = delayed allocation */
80 #define BMV_OF_LAST		0x4	/* segment is the last in the file */
81 #define BMV_OF_SHARED		0x8	/* segment shared with another file */
82 
83 /*	fmr_owner special values for FS_IOC_GETFSMAP */
84 #define XFS_FMR_OWN_FREE	FMR_OWN_FREE      /* free space */
85 #define XFS_FMR_OWN_UNKNOWN	FMR_OWN_UNKNOWN   /* unknown owner */
86 #define XFS_FMR_OWN_FS		FMR_OWNER('X', 1) /* static fs metadata */
87 #define XFS_FMR_OWN_LOG		FMR_OWNER('X', 2) /* journalling log */
88 #define XFS_FMR_OWN_AG		FMR_OWNER('X', 3) /* per-AG metadata */
89 #define XFS_FMR_OWN_INOBT	FMR_OWNER('X', 4) /* inode btree blocks */
90 #define XFS_FMR_OWN_INODES	FMR_OWNER('X', 5) /* inodes */
91 #define XFS_FMR_OWN_REFC	FMR_OWNER('X', 6) /* refcount tree */
92 #define XFS_FMR_OWN_COW		FMR_OWNER('X', 7) /* cow staging */
93 #define XFS_FMR_OWN_DEFECTIVE	FMR_OWNER('X', 8) /* bad blocks */
94 
95 /*
96  * Structure for XFS_IOC_FSSETDM.
97  * For use by backup and restore programs to set the XFS on-disk inode
98  * fields di_dmevmask and di_dmstate.  These must be set to exactly and
99  * only values previously obtained via xfs_bulkstat!  (Specifically the
100  * xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
101  */
102 #ifndef HAVE_FSDMIDATA
103 struct fsdmidata {
104 	__u32		fsd_dmevmask;	/* corresponds to di_dmevmask */
105 	__u16		fsd_padding;
106 	__u16		fsd_dmstate;	/* corresponds to di_dmstate  */
107 };
108 #endif
109 
110 /*
111  * File segment locking set data type for 64 bit access.
112  * Also used for all the RESV/FREE interfaces.
113  */
114 typedef struct xfs_flock64 {
115 	__s16		l_type;
116 	__s16		l_whence;
117 	__s64		l_start;
118 	__s64		l_len;		/* len == 0 means until end of file */
119 	__s32		l_sysid;
120 	__u32		l_pid;
121 	__s32		l_pad[4];	/* reserve area			    */
122 } xfs_flock64_t;
123 
124 /*
125  * Output for XFS_IOC_FSGEOMETRY_V1
126  */
127 struct xfs_fsop_geom_v1 {
128 	__u32		blocksize;	/* filesystem (data) block size */
129 	__u32		rtextsize;	/* realtime extent size		*/
130 	__u32		agblocks;	/* fsblocks in an AG		*/
131 	__u32		agcount;	/* number of allocation groups	*/
132 	__u32		logblocks;	/* fsblocks in the log		*/
133 	__u32		sectsize;	/* (data) sector size, bytes	*/
134 	__u32		inodesize;	/* inode size in bytes		*/
135 	__u32		imaxpct;	/* max allowed inode space(%)	*/
136 	__u64		datablocks;	/* fsblocks in data subvolume	*/
137 	__u64		rtblocks;	/* fsblocks in realtime subvol	*/
138 	__u64		rtextents;	/* rt extents in realtime subvol*/
139 	__u64		logstart;	/* starting fsblock of the log	*/
140 	unsigned char	uuid[16];	/* unique id of the filesystem	*/
141 	__u32		sunit;		/* stripe unit, fsblocks	*/
142 	__u32		swidth;		/* stripe width, fsblocks	*/
143 	__s32		version;	/* structure version		*/
144 	__u32		flags;		/* superblock version flags	*/
145 	__u32		logsectsize;	/* log sector size, bytes	*/
146 	__u32		rtsectsize;	/* realtime sector size, bytes	*/
147 	__u32		dirblocksize;	/* directory block size, bytes	*/
148 };
149 
150 /*
151  * Output for XFS_IOC_FSGEOMETRY_V4
152  */
153 struct xfs_fsop_geom_v4 {
154 	__u32		blocksize;	/* filesystem (data) block size */
155 	__u32		rtextsize;	/* realtime extent size		*/
156 	__u32		agblocks;	/* fsblocks in an AG		*/
157 	__u32		agcount;	/* number of allocation groups	*/
158 	__u32		logblocks;	/* fsblocks in the log		*/
159 	__u32		sectsize;	/* (data) sector size, bytes	*/
160 	__u32		inodesize;	/* inode size in bytes		*/
161 	__u32		imaxpct;	/* max allowed inode space(%)	*/
162 	__u64		datablocks;	/* fsblocks in data subvolume	*/
163 	__u64		rtblocks;	/* fsblocks in realtime subvol	*/
164 	__u64		rtextents;	/* rt extents in realtime subvol*/
165 	__u64		logstart;	/* starting fsblock of the log	*/
166 	unsigned char	uuid[16];	/* unique id of the filesystem	*/
167 	__u32		sunit;		/* stripe unit, fsblocks	*/
168 	__u32		swidth;		/* stripe width, fsblocks	*/
169 	__s32		version;	/* structure version		*/
170 	__u32		flags;		/* superblock version flags	*/
171 	__u32		logsectsize;	/* log sector size, bytes	*/
172 	__u32		rtsectsize;	/* realtime sector size, bytes	*/
173 	__u32		dirblocksize;	/* directory block size, bytes	*/
174 	__u32		logsunit;	/* log stripe unit, bytes	*/
175 };
176 
177 /*
178  * Output for XFS_IOC_FSGEOMETRY
179  */
180 struct xfs_fsop_geom {
181 	__u32		blocksize;	/* filesystem (data) block size */
182 	__u32		rtextsize;	/* realtime extent size		*/
183 	__u32		agblocks;	/* fsblocks in an AG		*/
184 	__u32		agcount;	/* number of allocation groups	*/
185 	__u32		logblocks;	/* fsblocks in the log		*/
186 	__u32		sectsize;	/* (data) sector size, bytes	*/
187 	__u32		inodesize;	/* inode size in bytes		*/
188 	__u32		imaxpct;	/* max allowed inode space(%)	*/
189 	__u64		datablocks;	/* fsblocks in data subvolume	*/
190 	__u64		rtblocks;	/* fsblocks in realtime subvol	*/
191 	__u64		rtextents;	/* rt extents in realtime subvol*/
192 	__u64		logstart;	/* starting fsblock of the log	*/
193 	unsigned char	uuid[16];	/* unique id of the filesystem	*/
194 	__u32		sunit;		/* stripe unit, fsblocks	*/
195 	__u32		swidth;		/* stripe width, fsblocks	*/
196 	__s32		version;	/* structure version		*/
197 	__u32		flags;		/* superblock version flags	*/
198 	__u32		logsectsize;	/* log sector size, bytes	*/
199 	__u32		rtsectsize;	/* realtime sector size, bytes	*/
200 	__u32		dirblocksize;	/* directory block size, bytes	*/
201 	__u32		logsunit;	/* log stripe unit, bytes	*/
202 	uint32_t	sick;		/* o: unhealthy fs & rt metadata */
203 	uint32_t	checked;	/* o: checked fs & rt metadata	*/
204 	__u64		reserved[17];	/* reserved space		*/
205 };
206 
207 #define XFS_FSOP_GEOM_SICK_COUNTERS	(1 << 0)  /* summary counters */
208 #define XFS_FSOP_GEOM_SICK_UQUOTA	(1 << 1)  /* user quota */
209 #define XFS_FSOP_GEOM_SICK_GQUOTA	(1 << 2)  /* group quota */
210 #define XFS_FSOP_GEOM_SICK_PQUOTA	(1 << 3)  /* project quota */
211 #define XFS_FSOP_GEOM_SICK_RT_BITMAP	(1 << 4)  /* realtime bitmap */
212 #define XFS_FSOP_GEOM_SICK_RT_SUMMARY	(1 << 5)  /* realtime summary */
213 
214 /* Output for XFS_FS_COUNTS */
215 typedef struct xfs_fsop_counts {
216 	__u64	freedata;	/* free data section blocks */
217 	__u64	freertx;	/* free rt extents */
218 	__u64	freeino;	/* free inodes */
219 	__u64	allocino;	/* total allocated inodes */
220 } xfs_fsop_counts_t;
221 
222 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
223 typedef struct xfs_fsop_resblks {
224 	__u64  resblks;
225 	__u64  resblks_avail;
226 } xfs_fsop_resblks_t;
227 
228 #define XFS_FSOP_GEOM_VERSION		0
229 #define XFS_FSOP_GEOM_VERSION_V5	5
230 
231 #define XFS_FSOP_GEOM_FLAGS_ATTR	(1 << 0)  /* attributes in use	   */
232 #define XFS_FSOP_GEOM_FLAGS_NLINK	(1 << 1)  /* 32-bit nlink values   */
233 #define XFS_FSOP_GEOM_FLAGS_QUOTA	(1 << 2)  /* quotas enabled	   */
234 #define XFS_FSOP_GEOM_FLAGS_IALIGN	(1 << 3)  /* inode alignment	   */
235 #define XFS_FSOP_GEOM_FLAGS_DALIGN	(1 << 4)  /* large data alignment  */
236 #define XFS_FSOP_GEOM_FLAGS_SHARED	(1 << 5)  /* read-only shared	   */
237 #define XFS_FSOP_GEOM_FLAGS_EXTFLG	(1 << 6)  /* special extent flag   */
238 #define XFS_FSOP_GEOM_FLAGS_DIRV2	(1 << 7)  /* directory version 2   */
239 #define XFS_FSOP_GEOM_FLAGS_LOGV2	(1 << 8)  /* log format version 2  */
240 #define XFS_FSOP_GEOM_FLAGS_SECTOR	(1 << 9)  /* sector sizes >1BB	   */
241 #define XFS_FSOP_GEOM_FLAGS_ATTR2	(1 << 10) /* inline attributes rework */
242 #define XFS_FSOP_GEOM_FLAGS_PROJID32	(1 << 11) /* 32-bit project IDs	   */
243 #define XFS_FSOP_GEOM_FLAGS_DIRV2CI	(1 << 12) /* ASCII only CI names   */
244 	/*  -- Do not use --		(1 << 13)    SGI parent pointers   */
245 #define XFS_FSOP_GEOM_FLAGS_LAZYSB	(1 << 14) /* lazy superblock counters */
246 #define XFS_FSOP_GEOM_FLAGS_V5SB	(1 << 15) /* version 5 superblock  */
247 #define XFS_FSOP_GEOM_FLAGS_FTYPE	(1 << 16) /* inode directory types */
248 #define XFS_FSOP_GEOM_FLAGS_FINOBT	(1 << 17) /* free inode btree	   */
249 #define XFS_FSOP_GEOM_FLAGS_SPINODES	(1 << 18) /* sparse inode chunks   */
250 #define XFS_FSOP_GEOM_FLAGS_RMAPBT	(1 << 19) /* reverse mapping btree */
251 #define XFS_FSOP_GEOM_FLAGS_REFLINK	(1 << 20) /* files can share blocks */
252 
253 /*
254  * Minimum and maximum sizes need for growth checks.
255  *
256  * Block counts are in units of filesystem blocks, not basic blocks.
257  */
258 #define XFS_MIN_AG_BLOCKS	64
259 #define XFS_MIN_LOG_BLOCKS	512ULL
260 #define XFS_MAX_LOG_BLOCKS	(1024 * 1024ULL)
261 #define XFS_MIN_LOG_BYTES	(10 * 1024 * 1024ULL)
262 
263 /*
264  * Limits on sb_agblocks/sb_agblklog -- mkfs won't format AGs smaller than
265  * 16MB or larger than 1TB.
266  */
267 #define XFS_MIN_AG_BYTES	(1ULL << 24)	/* 16 MB */
268 #define XFS_MAX_AG_BYTES	(1ULL << 40)	/* 1 TB */
269 
270 /* keep the maximum size under 2^31 by a small amount */
271 #define XFS_MAX_LOG_BYTES \
272 	((2 * 1024 * 1024 * 1024ULL) - XFS_MIN_LOG_BYTES)
273 
274 /* Used for sanity checks on superblock */
275 #define XFS_MAX_DBLOCKS(s) ((xfs_rfsblock_t)(s)->sb_agcount * (s)->sb_agblocks)
276 #define XFS_MIN_DBLOCKS(s) ((xfs_rfsblock_t)((s)->sb_agcount - 1) *	\
277 			 (s)->sb_agblocks + XFS_MIN_AG_BLOCKS)
278 
279 /*
280  * Output for XFS_IOC_AG_GEOMETRY
281  */
282 struct xfs_ag_geometry {
283 	uint32_t	ag_number;	/* i/o: AG number */
284 	uint32_t	ag_length;	/* o: length in blocks */
285 	uint32_t	ag_freeblks;	/* o: free space */
286 	uint32_t	ag_icount;	/* o: inodes allocated */
287 	uint32_t	ag_ifree;	/* o: inodes free */
288 	uint32_t	ag_sick;	/* o: sick things in ag */
289 	uint32_t	ag_checked;	/* o: checked metadata in ag */
290 	uint32_t	ag_reserved32;	/* o: zero */
291 	uint64_t	ag_reserved[12];/* o: zero */
292 };
293 #define XFS_AG_GEOM_SICK_SB	(1 << 0)  /* superblock */
294 #define XFS_AG_GEOM_SICK_AGF	(1 << 1)  /* AGF header */
295 #define XFS_AG_GEOM_SICK_AGFL	(1 << 2)  /* AGFL header */
296 #define XFS_AG_GEOM_SICK_AGI	(1 << 3)  /* AGI header */
297 #define XFS_AG_GEOM_SICK_BNOBT	(1 << 4)  /* free space by block */
298 #define XFS_AG_GEOM_SICK_CNTBT	(1 << 5)  /* free space by length */
299 #define XFS_AG_GEOM_SICK_INOBT	(1 << 6)  /* inode index */
300 #define XFS_AG_GEOM_SICK_FINOBT	(1 << 7)  /* free inode index */
301 #define XFS_AG_GEOM_SICK_RMAPBT	(1 << 8)  /* reverse mappings */
302 #define XFS_AG_GEOM_SICK_REFCNTBT (1 << 9)  /* reference counts */
303 
304 /*
305  * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
306  */
307 typedef struct xfs_growfs_data {
308 	__u64		newblocks;	/* new data subvol size, fsblocks */
309 	__u32		imaxpct;	/* new inode space percentage limit */
310 } xfs_growfs_data_t;
311 
312 typedef struct xfs_growfs_log {
313 	__u32		newblocks;	/* new log size, fsblocks */
314 	__u32		isint;		/* 1 if new log is internal */
315 } xfs_growfs_log_t;
316 
317 typedef struct xfs_growfs_rt {
318 	__u64		newblocks;	/* new realtime size, fsblocks */
319 	__u32		extsize;	/* new realtime extent size, fsblocks */
320 } xfs_growfs_rt_t;
321 
322 
323 /*
324  * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
325  */
326 typedef struct xfs_bstime {
327 	time_t		tv_sec;		/* seconds		*/
328 	__s32		tv_nsec;	/* and nanoseconds	*/
329 } xfs_bstime_t;
330 
331 typedef struct xfs_bstat {
332 	__u64		bs_ino;		/* inode number			*/
333 	__u16		bs_mode;	/* type and mode		*/
334 	__u16		bs_nlink;	/* number of links		*/
335 	__u32		bs_uid;		/* user id			*/
336 	__u32		bs_gid;		/* group id			*/
337 	__u32		bs_rdev;	/* device value			*/
338 	__s32		bs_blksize;	/* block size			*/
339 	__s64		bs_size;	/* file size			*/
340 	xfs_bstime_t	bs_atime;	/* access time			*/
341 	xfs_bstime_t	bs_mtime;	/* modify time			*/
342 	xfs_bstime_t	bs_ctime;	/* inode change time		*/
343 	int64_t		bs_blocks;	/* number of blocks		*/
344 	__u32		bs_xflags;	/* extended flags		*/
345 	__s32		bs_extsize;	/* extent size			*/
346 	__s32		bs_extents;	/* number of extents		*/
347 	__u32		bs_gen;		/* generation count		*/
348 	__u16		bs_projid_lo;	/* lower part of project id	*/
349 #define	bs_projid	bs_projid_lo	/* (previously just bs_projid)	*/
350 	__u16		bs_forkoff;	/* inode fork offset in bytes	*/
351 	__u16		bs_projid_hi;	/* higher part of project id	*/
352 	uint16_t	bs_sick;	/* sick inode metadata		*/
353 	uint16_t	bs_checked;	/* checked inode metadata	*/
354 	unsigned char	bs_pad[2];	/* pad space, unused		*/
355 	__u32		bs_cowextsize;	/* cow extent size		*/
356 	__u32		bs_dmevmask;	/* DMIG event mask		*/
357 	__u16		bs_dmstate;	/* DMIG state info		*/
358 	__u16		bs_aextents;	/* attribute number of extents	*/
359 } xfs_bstat_t;
360 
361 /* bs_sick flags */
362 #define XFS_BS_SICK_INODE	(1 << 0)  /* inode core */
363 #define XFS_BS_SICK_BMBTD	(1 << 1)  /* data fork */
364 #define XFS_BS_SICK_BMBTA	(1 << 2)  /* attr fork */
365 #define XFS_BS_SICK_BMBTC	(1 << 3)  /* cow fork */
366 #define XFS_BS_SICK_DIR		(1 << 4)  /* directory */
367 #define XFS_BS_SICK_XATTR	(1 << 5)  /* extended attributes */
368 #define XFS_BS_SICK_SYMLINK	(1 << 6)  /* symbolic link remote target */
369 #define XFS_BS_SICK_PARENT	(1 << 7)  /* parent pointers */
370 
371 /*
372  * Project quota id helpers (previously projid was 16bit only
373  * and using two 16bit values to hold new 32bit projid was choosen
374  * to retain compatibility with "old" filesystems).
375  */
376 static inline uint32_t
377 bstat_get_projid(struct xfs_bstat *bs)
378 {
379 	return (uint32_t)bs->bs_projid_hi << 16 | bs->bs_projid_lo;
380 }
381 
382 /*
383  * The user-level BulkStat Request interface structure.
384  */
385 typedef struct xfs_fsop_bulkreq {
386 	__u64		__user *lastip;	/* last inode # pointer		*/
387 	__s32		icount;		/* count of entries in buffer	*/
388 	void		__user *ubuffer;/* user buffer for inode desc.	*/
389 	__s32		__user *ocount;	/* output count pointer		*/
390 } xfs_fsop_bulkreq_t;
391 
392 
393 /*
394  * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
395  */
396 typedef struct xfs_inogrp {
397 	__u64		xi_startino;	/* starting inode number	*/
398 	__s32		xi_alloccount;	/* # bits set in allocmask	*/
399 	__u64		xi_allocmask;	/* mask of allocated inodes	*/
400 } xfs_inogrp_t;
401 
402 
403 /*
404  * Error injection.
405  */
406 typedef struct xfs_error_injection {
407 	__s32		fd;
408 	__s32		errtag;
409 } xfs_error_injection_t;
410 
411 
412 /*
413  * Speculative preallocation trimming.
414  */
415 #define XFS_EOFBLOCKS_VERSION		1
416 struct xfs_fs_eofblocks {
417 	__u32		eof_version;
418 	__u32		eof_flags;
419 	uid_t		eof_uid;
420 	gid_t		eof_gid;
421 	prid_t		eof_prid;
422 	__u32		pad32;
423 	__u64		eof_min_file_size;
424 	__u64		pad64[12];
425 };
426 
427 /* eof_flags values */
428 #define XFS_EOF_FLAGS_SYNC		(1 << 0) /* sync/wait mode scan */
429 #define XFS_EOF_FLAGS_UID		(1 << 1) /* filter by uid */
430 #define XFS_EOF_FLAGS_GID		(1 << 2) /* filter by gid */
431 #define XFS_EOF_FLAGS_PRID		(1 << 3) /* filter by project id */
432 #define XFS_EOF_FLAGS_MINFILESIZE	(1 << 4) /* filter by min file size */
433 #define XFS_EOF_FLAGS_UNION		(1 << 5) /* union filter algorithm;
434 						  * kernel only, not included in
435 						  * valid mask */
436 #define XFS_EOF_FLAGS_VALID	\
437 	(XFS_EOF_FLAGS_SYNC |	\
438 	 XFS_EOF_FLAGS_UID |	\
439 	 XFS_EOF_FLAGS_GID |	\
440 	 XFS_EOF_FLAGS_PRID |	\
441 	 XFS_EOF_FLAGS_MINFILESIZE)
442 
443 
444 /*
445  * The user-level Handle Request interface structure.
446  */
447 typedef struct xfs_fsop_handlereq {
448 	__u32		fd;		/* fd for FD_TO_HANDLE		*/
449 	void		__user *path;	/* user pathname		*/
450 	__u32		oflags;		/* open flags			*/
451 	void		__user *ihandle;/* user supplied handle		*/
452 	__u32		ihandlen;	/* user supplied length		*/
453 	void		__user *ohandle;/* user buffer for handle	*/
454 	__u32		__user *ohandlen;/* user buffer length		*/
455 } xfs_fsop_handlereq_t;
456 
457 /*
458  * Compound structures for passing args through Handle Request interfaces
459  * xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
460  * - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
461  *	     XFS_IOC_ATTRMULTI_BY_HANDLE
462  */
463 
464 typedef struct xfs_fsop_setdm_handlereq {
465 	struct xfs_fsop_handlereq	hreq;	/* handle information	*/
466 	struct fsdmidata		__user *data;	/* DMAPI data	*/
467 } xfs_fsop_setdm_handlereq_t;
468 
469 typedef struct xfs_attrlist_cursor {
470 	__u32		opaque[4];
471 } xfs_attrlist_cursor_t;
472 
473 typedef struct xfs_fsop_attrlist_handlereq {
474 	struct xfs_fsop_handlereq	hreq; /* handle interface structure */
475 	struct xfs_attrlist_cursor	pos; /* opaque cookie, list offset */
476 	__u32				flags;	/* which namespace to use */
477 	__u32				buflen;	/* length of buffer supplied */
478 	void				__user *buffer;	/* returned names */
479 } xfs_fsop_attrlist_handlereq_t;
480 
481 typedef struct xfs_attr_multiop {
482 	__u32		am_opcode;
483 #define ATTR_OP_GET	1	/* return the indicated attr's value */
484 #define ATTR_OP_SET	2	/* set/create the indicated attr/value pair */
485 #define ATTR_OP_REMOVE	3	/* remove the indicated attr */
486 	__s32		am_error;
487 	void		__user *am_attrname;
488 	void		__user *am_attrvalue;
489 	__u32		am_length;
490 	__u32		am_flags;
491 } xfs_attr_multiop_t;
492 
493 typedef struct xfs_fsop_attrmulti_handlereq {
494 	struct xfs_fsop_handlereq	hreq; /* handle interface structure */
495 	__u32				opcount;/* count of following multiop */
496 	struct xfs_attr_multiop		__user *ops; /* attr_multi data */
497 } xfs_fsop_attrmulti_handlereq_t;
498 
499 /*
500  * per machine unique filesystem identifier types.
501  */
502 typedef struct { __u32 val[2]; } xfs_fsid_t; /* file system id type */
503 
504 typedef struct xfs_fid {
505 	__u16	fid_len;		/* length of remainder	*/
506 	__u16	fid_pad;
507 	__u32	fid_gen;		/* generation number	*/
508 	__u64	fid_ino;		/* 64 bits inode number */
509 } xfs_fid_t;
510 
511 typedef struct xfs_handle {
512 	union {
513 		__s64	    align;	/* force alignment of ha_fid	 */
514 		xfs_fsid_t  _ha_fsid;	/* unique file system identifier */
515 	} ha_u;
516 	xfs_fid_t	ha_fid;		/* file system specific file ID	 */
517 } xfs_handle_t;
518 #define ha_fsid ha_u._ha_fsid
519 
520 /*
521  * Structure passed to XFS_IOC_SWAPEXT
522  */
523 typedef struct xfs_swapext
524 {
525 	int64_t		sx_version;	/* version */
526 #define XFS_SX_VERSION		0
527 	int64_t		sx_fdtarget;	/* fd of target file */
528 	int64_t		sx_fdtmp;	/* fd of tmp file */
529 	xfs_off_t	sx_offset;	/* offset into file */
530 	xfs_off_t	sx_length;	/* leng from offset */
531 	char		sx_pad[16];	/* pad space, unused */
532 	xfs_bstat_t	sx_stat;	/* stat of target b4 copy */
533 } xfs_swapext_t;
534 
535 /*
536  * Flags for going down operation
537  */
538 #define XFS_FSOP_GOING_FLAGS_DEFAULT		0x0	/* going down */
539 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH		0x1	/* flush log but not data */
540 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH		0x2	/* don't flush log nor data */
541 
542 /* metadata scrubbing */
543 struct xfs_scrub_metadata {
544 	__u32 sm_type;		/* What to check? */
545 	__u32 sm_flags;		/* flags; see below. */
546 	__u64 sm_ino;		/* inode number. */
547 	__u32 sm_gen;		/* inode generation. */
548 	__u32 sm_agno;		/* ag number. */
549 	__u64 sm_reserved[5];	/* pad to 64 bytes */
550 };
551 
552 /*
553  * Metadata types and flags for scrub operation.
554  */
555 
556 /* Scrub subcommands. */
557 #define XFS_SCRUB_TYPE_PROBE	0	/* presence test ioctl */
558 #define XFS_SCRUB_TYPE_SB	1	/* superblock */
559 #define XFS_SCRUB_TYPE_AGF	2	/* AG free header */
560 #define XFS_SCRUB_TYPE_AGFL	3	/* AG free list */
561 #define XFS_SCRUB_TYPE_AGI	4	/* AG inode header */
562 #define XFS_SCRUB_TYPE_BNOBT	5	/* freesp by block btree */
563 #define XFS_SCRUB_TYPE_CNTBT	6	/* freesp by length btree */
564 #define XFS_SCRUB_TYPE_INOBT	7	/* inode btree */
565 #define XFS_SCRUB_TYPE_FINOBT	8	/* free inode btree */
566 #define XFS_SCRUB_TYPE_RMAPBT	9	/* reverse mapping btree */
567 #define XFS_SCRUB_TYPE_REFCNTBT	10	/* reference count btree */
568 #define XFS_SCRUB_TYPE_INODE	11	/* inode record */
569 #define XFS_SCRUB_TYPE_BMBTD	12	/* data fork block mapping */
570 #define XFS_SCRUB_TYPE_BMBTA	13	/* attr fork block mapping */
571 #define XFS_SCRUB_TYPE_BMBTC	14	/* CoW fork block mapping */
572 #define XFS_SCRUB_TYPE_DIR	15	/* directory */
573 #define XFS_SCRUB_TYPE_XATTR	16	/* extended attribute */
574 #define XFS_SCRUB_TYPE_SYMLINK	17	/* symbolic link */
575 #define XFS_SCRUB_TYPE_PARENT	18	/* parent pointers */
576 #define XFS_SCRUB_TYPE_RTBITMAP	19	/* realtime bitmap */
577 #define XFS_SCRUB_TYPE_RTSUM	20	/* realtime summary */
578 #define XFS_SCRUB_TYPE_UQUOTA	21	/* user quotas */
579 #define XFS_SCRUB_TYPE_GQUOTA	22	/* group quotas */
580 #define XFS_SCRUB_TYPE_PQUOTA	23	/* project quotas */
581 #define XFS_SCRUB_TYPE_FSCOUNTERS 24	/* fs summary counters */
582 
583 /* Number of scrub subcommands. */
584 #define XFS_SCRUB_TYPE_NR	25
585 
586 /* i: Repair this metadata. */
587 #define XFS_SCRUB_IFLAG_REPAIR		(1 << 0)
588 
589 /* o: Metadata object needs repair. */
590 #define XFS_SCRUB_OFLAG_CORRUPT		(1 << 1)
591 
592 /*
593  * o: Metadata object could be optimized.  It's not corrupt, but
594  *    we could improve on it somehow.
595  */
596 #define XFS_SCRUB_OFLAG_PREEN		(1 << 2)
597 
598 /* o: Cross-referencing failed. */
599 #define XFS_SCRUB_OFLAG_XFAIL		(1 << 3)
600 
601 /* o: Metadata object disagrees with cross-referenced metadata. */
602 #define XFS_SCRUB_OFLAG_XCORRUPT	(1 << 4)
603 
604 /* o: Scan was not complete. */
605 #define XFS_SCRUB_OFLAG_INCOMPLETE	(1 << 5)
606 
607 /* o: Metadata object looked funny but isn't corrupt. */
608 #define XFS_SCRUB_OFLAG_WARNING		(1 << 6)
609 
610 /*
611  * o: IFLAG_REPAIR was set but metadata object did not need fixing or
612  *    optimization and has therefore not been altered.
613  */
614 #define XFS_SCRUB_OFLAG_NO_REPAIR_NEEDED (1 << 7)
615 
616 #define XFS_SCRUB_FLAGS_IN	(XFS_SCRUB_IFLAG_REPAIR)
617 #define XFS_SCRUB_FLAGS_OUT	(XFS_SCRUB_OFLAG_CORRUPT | \
618 				 XFS_SCRUB_OFLAG_PREEN | \
619 				 XFS_SCRUB_OFLAG_XFAIL | \
620 				 XFS_SCRUB_OFLAG_XCORRUPT | \
621 				 XFS_SCRUB_OFLAG_INCOMPLETE | \
622 				 XFS_SCRUB_OFLAG_WARNING | \
623 				 XFS_SCRUB_OFLAG_NO_REPAIR_NEEDED)
624 #define XFS_SCRUB_FLAGS_ALL	(XFS_SCRUB_FLAGS_IN | XFS_SCRUB_FLAGS_OUT)
625 
626 /*
627  * ioctl limits
628  */
629 #ifdef XATTR_LIST_MAX
630 #  define XFS_XATTR_LIST_MAX XATTR_LIST_MAX
631 #else
632 #  define XFS_XATTR_LIST_MAX 65536
633 #endif
634 
635 
636 /*
637  * ioctl commands that are used by Linux filesystems
638  */
639 #define XFS_IOC_GETXFLAGS	FS_IOC_GETFLAGS
640 #define XFS_IOC_SETXFLAGS	FS_IOC_SETFLAGS
641 #define XFS_IOC_GETVERSION	FS_IOC_GETVERSION
642 
643 /*
644  * ioctl commands that replace IRIX fcntl()'s
645  * For 'documentation' purposed more than anything else,
646  * the "cmd #" field reflects the IRIX fcntl number.
647  */
648 #define XFS_IOC_ALLOCSP		_IOW ('X', 10, struct xfs_flock64)
649 #define XFS_IOC_FREESP		_IOW ('X', 11, struct xfs_flock64)
650 #define XFS_IOC_DIOINFO		_IOR ('X', 30, struct dioattr)
651 #define XFS_IOC_FSGETXATTR	FS_IOC_FSGETXATTR
652 #define XFS_IOC_FSSETXATTR	FS_IOC_FSSETXATTR
653 #define XFS_IOC_ALLOCSP64	_IOW ('X', 36, struct xfs_flock64)
654 #define XFS_IOC_FREESP64	_IOW ('X', 37, struct xfs_flock64)
655 #define XFS_IOC_GETBMAP		_IOWR('X', 38, struct getbmap)
656 #define XFS_IOC_FSSETDM		_IOW ('X', 39, struct fsdmidata)
657 #define XFS_IOC_RESVSP		_IOW ('X', 40, struct xfs_flock64)
658 #define XFS_IOC_UNRESVSP	_IOW ('X', 41, struct xfs_flock64)
659 #define XFS_IOC_RESVSP64	_IOW ('X', 42, struct xfs_flock64)
660 #define XFS_IOC_UNRESVSP64	_IOW ('X', 43, struct xfs_flock64)
661 #define XFS_IOC_GETBMAPA	_IOWR('X', 44, struct getbmap)
662 #define XFS_IOC_FSGETXATTRA	_IOR ('X', 45, struct fsxattr)
663 /*	XFS_IOC_SETBIOSIZE ---- deprecated 46	   */
664 /*	XFS_IOC_GETBIOSIZE ---- deprecated 47	   */
665 #define XFS_IOC_GETBMAPX	_IOWR('X', 56, struct getbmap)
666 #define XFS_IOC_ZERO_RANGE	_IOW ('X', 57, struct xfs_flock64)
667 #define XFS_IOC_FREE_EOFBLOCKS	_IOR ('X', 58, struct xfs_fs_eofblocks)
668 /*	XFS_IOC_GETFSMAP ------ hoisted 59         */
669 #define XFS_IOC_SCRUB_METADATA	_IOWR('X', 60, struct xfs_scrub_metadata)
670 #define XFS_IOC_AG_GEOMETRY	_IOWR('X', 61, struct xfs_ag_geometry)
671 
672 /*
673  * ioctl commands that replace IRIX syssgi()'s
674  */
675 #define XFS_IOC_FSGEOMETRY_V1	     _IOR ('X', 100, struct xfs_fsop_geom_v1)
676 #define XFS_IOC_FSBULKSTAT	     _IOWR('X', 101, struct xfs_fsop_bulkreq)
677 #define XFS_IOC_FSBULKSTAT_SINGLE    _IOWR('X', 102, struct xfs_fsop_bulkreq)
678 #define XFS_IOC_FSINUMBERS	     _IOWR('X', 103, struct xfs_fsop_bulkreq)
679 #define XFS_IOC_PATH_TO_FSHANDLE     _IOWR('X', 104, struct xfs_fsop_handlereq)
680 #define XFS_IOC_PATH_TO_HANDLE	     _IOWR('X', 105, struct xfs_fsop_handlereq)
681 #define XFS_IOC_FD_TO_HANDLE	     _IOWR('X', 106, struct xfs_fsop_handlereq)
682 #define XFS_IOC_OPEN_BY_HANDLE	     _IOWR('X', 107, struct xfs_fsop_handlereq)
683 #define XFS_IOC_READLINK_BY_HANDLE   _IOWR('X', 108, struct xfs_fsop_handlereq)
684 #define XFS_IOC_SWAPEXT		     _IOWR('X', 109, struct xfs_swapext)
685 #define XFS_IOC_FSGROWFSDATA	     _IOW ('X', 110, struct xfs_growfs_data)
686 #define XFS_IOC_FSGROWFSLOG	     _IOW ('X', 111, struct xfs_growfs_log)
687 #define XFS_IOC_FSGROWFSRT	     _IOW ('X', 112, struct xfs_growfs_rt)
688 #define XFS_IOC_FSCOUNTS	     _IOR ('X', 113, struct xfs_fsop_counts)
689 #define XFS_IOC_SET_RESBLKS	     _IOWR('X', 114, struct xfs_fsop_resblks)
690 #define XFS_IOC_GET_RESBLKS	     _IOR ('X', 115, struct xfs_fsop_resblks)
691 #define XFS_IOC_ERROR_INJECTION	     _IOW ('X', 116, struct xfs_error_injection)
692 #define XFS_IOC_ERROR_CLEARALL	     _IOW ('X', 117, struct xfs_error_injection)
693 /*	XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118	 */
694 
695 #define XFS_IOC_FREEZE		     _IOWR('X', 119, int)	/* aka FIFREEZE */
696 #define XFS_IOC_THAW		     _IOWR('X', 120, int)	/* aka FITHAW */
697 
698 #define XFS_IOC_FSSETDM_BY_HANDLE    _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
699 #define XFS_IOC_ATTRLIST_BY_HANDLE   _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
700 #define XFS_IOC_ATTRMULTI_BY_HANDLE  _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
701 #define XFS_IOC_FSGEOMETRY_V4	     _IOR ('X', 124, struct xfs_fsop_geom_v4)
702 #define XFS_IOC_GOINGDOWN	     _IOR ('X', 125, uint32_t)
703 #define XFS_IOC_FSGEOMETRY	     _IOR ('X', 126, struct xfs_fsop_geom)
704 /*	XFS_IOC_GETFSUUID ---------- deprecated 140	 */
705 
706 
707 #ifndef HAVE_BBMACROS
708 /*
709  * Block I/O parameterization.	A basic block (BB) is the lowest size of
710  * filesystem allocation, and must equal 512.  Length units given to bio
711  * routines are in BB's.
712  */
713 #define BBSHIFT		9
714 #define BBSIZE		(1<<BBSHIFT)
715 #define BBMASK		(BBSIZE-1)
716 #define BTOBB(bytes)	(((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
717 #define BTOBBT(bytes)	((__u64)(bytes) >> BBSHIFT)
718 #define BBTOB(bbs)	((bbs) << BBSHIFT)
719 #endif
720 
721 #endif	/* __XFS_FS_H__ */
722