xref: /linux/fs/xfs/libxfs/xfs_fs.h (revision 3fd6c59042dbba50391e30862beac979491145fe)
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  * NOTE: This file must be compile-able with C++ compilers.
12  */
13 
14 /*
15  * Direct I/O attribute record used with XFS_IOC_DIOINFO
16  * d_miniosz is the min xfer size, xfer size multiple and file seek offset
17  * alignment.
18  */
19 #ifndef HAVE_DIOATTR
20 struct dioattr {
21 	__u32		d_mem;		/* data buffer memory alignment */
22 	__u32		d_miniosz;	/* min xfer size		*/
23 	__u32		d_maxiosz;	/* max xfer size		*/
24 };
25 #endif
26 
27 /*
28  * Structure for XFS_IOC_GETBMAP.
29  * On input, fill in bmv_offset and bmv_length of the first structure
30  * to indicate the area of interest in the file, and bmv_entries with
31  * the number of array elements given back.  The first structure is
32  * updated on return to give the offset and length for the next call.
33  */
34 #ifndef HAVE_GETBMAP
35 struct getbmap {
36 	__s64		bmv_offset;	/* file offset of segment in blocks */
37 	__s64		bmv_block;	/* starting block (64-bit daddr_t)  */
38 	__s64		bmv_length;	/* length of segment, blocks	    */
39 	__s32		bmv_count;	/* # of entries in array incl. 1st  */
40 	__s32		bmv_entries;	/* # of entries filled in (output)  */
41 };
42 #endif
43 
44 /*
45  *	Structure for XFS_IOC_GETBMAPX.	 Fields bmv_offset through bmv_entries
46  *	are used exactly as in the getbmap structure.  The getbmapx structure
47  *	has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
48  *	is only used for the first structure.  It contains input flags
49  *	specifying XFS_IOC_GETBMAPX actions.  The bmv_oflags field is filled
50  *	in by the XFS_IOC_GETBMAPX command for each returned structure after
51  *	the first.
52  */
53 #ifndef HAVE_GETBMAPX
54 struct getbmapx {
55 	__s64		bmv_offset;	/* file offset of segment in blocks */
56 	__s64		bmv_block;	/* starting block (64-bit daddr_t)  */
57 	__s64		bmv_length;	/* length of segment, blocks	    */
58 	__s32		bmv_count;	/* # of entries in array incl. 1st  */
59 	__s32		bmv_entries;	/* # of entries filled in (output). */
60 	__s32		bmv_iflags;	/* input flags (1st structure)	    */
61 	__s32		bmv_oflags;	/* output flags (after 1st structure)*/
62 	__s32		bmv_unused1;	/* future use			    */
63 	__s32		bmv_unused2;	/* future use			    */
64 };
65 #endif
66 
67 /*	bmv_iflags values - set by XFS_IOC_GETBMAPX caller.	*/
68 #define BMV_IF_ATTRFORK		0x1	/* return attr fork rather than data */
69 #define BMV_IF_NO_DMAPI_READ	0x2	/* Deprecated */
70 #define BMV_IF_PREALLOC		0x4	/* rtn status BMV_OF_PREALLOC if req */
71 #define BMV_IF_DELALLOC		0x8	/* rtn status BMV_OF_DELALLOC if req */
72 #define BMV_IF_NO_HOLES		0x10	/* Do not return holes */
73 #define BMV_IF_COWFORK		0x20	/* return CoW fork rather than data */
74 #define BMV_IF_VALID	\
75 	(BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC|	\
76 	 BMV_IF_DELALLOC|BMV_IF_NO_HOLES|BMV_IF_COWFORK)
77 
78 /*	bmv_oflags values - returned for each non-header segment */
79 #define BMV_OF_PREALLOC		0x1	/* segment = unwritten pre-allocation */
80 #define BMV_OF_DELALLOC		0x2	/* segment = delayed allocation */
81 #define BMV_OF_LAST		0x4	/* segment is the last in the file */
82 #define BMV_OF_SHARED		0x8	/* segment shared with another file */
83 
84 /*	fmr_owner special values for FS_IOC_GETFSMAP */
85 #define XFS_FMR_OWN_FREE	FMR_OWN_FREE      /* free space */
86 #define XFS_FMR_OWN_UNKNOWN	FMR_OWN_UNKNOWN   /* unknown owner */
87 #define XFS_FMR_OWN_FS		FMR_OWNER('X', 1) /* static fs metadata */
88 #define XFS_FMR_OWN_LOG		FMR_OWNER('X', 2) /* journalling log */
89 #define XFS_FMR_OWN_AG		FMR_OWNER('X', 3) /* per-AG metadata */
90 #define XFS_FMR_OWN_INOBT	FMR_OWNER('X', 4) /* inode btree blocks */
91 #define XFS_FMR_OWN_INODES	FMR_OWNER('X', 5) /* inodes */
92 #define XFS_FMR_OWN_REFC	FMR_OWNER('X', 6) /* refcount tree */
93 #define XFS_FMR_OWN_COW		FMR_OWNER('X', 7) /* cow staging */
94 #define XFS_FMR_OWN_DEFECTIVE	FMR_OWNER('X', 8) /* bad blocks */
95 
96 /*
97  * File segment locking set data type for 64 bit access.
98  * Also used for all the RESV/FREE interfaces.
99  */
100 typedef struct xfs_flock64 {
101 	__s16		l_type;
102 	__s16		l_whence;
103 	__s64		l_start;
104 	__s64		l_len;		/* len == 0 means until end of file */
105 	__s32		l_sysid;
106 	__u32		l_pid;
107 	__s32		l_pad[4];	/* reserve area			    */
108 } xfs_flock64_t;
109 
110 /*
111  * Output for XFS_IOC_FSGEOMETRY_V1
112  */
113 struct xfs_fsop_geom_v1 {
114 	__u32		blocksize;	/* filesystem (data) block size */
115 	__u32		rtextsize;	/* realtime extent size		*/
116 	__u32		agblocks;	/* fsblocks in an AG		*/
117 	__u32		agcount;	/* number of allocation groups	*/
118 	__u32		logblocks;	/* fsblocks in the log		*/
119 	__u32		sectsize;	/* (data) sector size, bytes	*/
120 	__u32		inodesize;	/* inode size in bytes		*/
121 	__u32		imaxpct;	/* max allowed inode space(%)	*/
122 	__u64		datablocks;	/* fsblocks in data subvolume	*/
123 	__u64		rtblocks;	/* fsblocks in realtime subvol	*/
124 	__u64		rtextents;	/* rt extents in realtime subvol*/
125 	__u64		logstart;	/* starting fsblock of the log	*/
126 	unsigned char	uuid[16];	/* unique id of the filesystem	*/
127 	__u32		sunit;		/* stripe unit, fsblocks	*/
128 	__u32		swidth;		/* stripe width, fsblocks	*/
129 	__s32		version;	/* structure version		*/
130 	__u32		flags;		/* superblock version flags	*/
131 	__u32		logsectsize;	/* log sector size, bytes	*/
132 	__u32		rtsectsize;	/* realtime sector size, bytes	*/
133 	__u32		dirblocksize;	/* directory block size, bytes	*/
134 };
135 
136 /*
137  * Output for XFS_IOC_FSGEOMETRY_V4
138  */
139 struct xfs_fsop_geom_v4 {
140 	__u32		blocksize;	/* filesystem (data) block size */
141 	__u32		rtextsize;	/* realtime extent size		*/
142 	__u32		agblocks;	/* fsblocks in an AG		*/
143 	__u32		agcount;	/* number of allocation groups	*/
144 	__u32		logblocks;	/* fsblocks in the log		*/
145 	__u32		sectsize;	/* (data) sector size, bytes	*/
146 	__u32		inodesize;	/* inode size in bytes		*/
147 	__u32		imaxpct;	/* max allowed inode space(%)	*/
148 	__u64		datablocks;	/* fsblocks in data subvolume	*/
149 	__u64		rtblocks;	/* fsblocks in realtime subvol	*/
150 	__u64		rtextents;	/* rt extents in realtime subvol*/
151 	__u64		logstart;	/* starting fsblock of the log	*/
152 	unsigned char	uuid[16];	/* unique id of the filesystem	*/
153 	__u32		sunit;		/* stripe unit, fsblocks	*/
154 	__u32		swidth;		/* stripe width, fsblocks	*/
155 	__s32		version;	/* structure version		*/
156 	__u32		flags;		/* superblock version flags	*/
157 	__u32		logsectsize;	/* log sector size, bytes	*/
158 	__u32		rtsectsize;	/* realtime sector size, bytes	*/
159 	__u32		dirblocksize;	/* directory block size, bytes	*/
160 	__u32		logsunit;	/* log stripe unit, bytes	*/
161 };
162 
163 /*
164  * Output for XFS_IOC_FSGEOMETRY
165  */
166 struct xfs_fsop_geom {
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 	__u32		logsunit;	/* log stripe unit, bytes	*/
188 	uint32_t	sick;		/* o: unhealthy fs & rt metadata */
189 	uint32_t	checked;	/* o: checked fs & rt metadata	*/
190 	__u32		rgextents;	/* rt extents in a realtime group */
191 	__u32		rgcount;	/* number of realtime groups	*/
192 	__u64		reserved[16];	/* reserved space		*/
193 };
194 
195 #define XFS_FSOP_GEOM_SICK_COUNTERS	(1 << 0)  /* summary counters */
196 #define XFS_FSOP_GEOM_SICK_UQUOTA	(1 << 1)  /* user quota */
197 #define XFS_FSOP_GEOM_SICK_GQUOTA	(1 << 2)  /* group quota */
198 #define XFS_FSOP_GEOM_SICK_PQUOTA	(1 << 3)  /* project quota */
199 #define XFS_FSOP_GEOM_SICK_RT_BITMAP	(1 << 4)  /* realtime bitmap */
200 #define XFS_FSOP_GEOM_SICK_RT_SUMMARY	(1 << 5)  /* realtime summary */
201 #define XFS_FSOP_GEOM_SICK_QUOTACHECK	(1 << 6)  /* quota counts */
202 #define XFS_FSOP_GEOM_SICK_NLINKS	(1 << 7)  /* inode link counts */
203 #define XFS_FSOP_GEOM_SICK_METADIR	(1 << 8)  /* metadata directory */
204 #define XFS_FSOP_GEOM_SICK_METAPATH	(1 << 9)  /* metadir tree path */
205 
206 /* Output for XFS_FS_COUNTS */
207 typedef struct xfs_fsop_counts {
208 	__u64	freedata;	/* free data section blocks */
209 	__u64	freertx;	/* free rt extents */
210 	__u64	freeino;	/* free inodes */
211 	__u64	allocino;	/* total allocated inodes */
212 } xfs_fsop_counts_t;
213 
214 /* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
215 typedef struct xfs_fsop_resblks {
216 	__u64  resblks;
217 	__u64  resblks_avail;
218 } xfs_fsop_resblks_t;
219 
220 #define XFS_FSOP_GEOM_VERSION		0
221 #define XFS_FSOP_GEOM_VERSION_V5	5
222 
223 #define XFS_FSOP_GEOM_FLAGS_ATTR	(1 << 0)  /* attributes in use	   */
224 #define XFS_FSOP_GEOM_FLAGS_NLINK	(1 << 1)  /* 32-bit nlink values   */
225 #define XFS_FSOP_GEOM_FLAGS_QUOTA	(1 << 2)  /* quotas enabled	   */
226 #define XFS_FSOP_GEOM_FLAGS_IALIGN	(1 << 3)  /* inode alignment	   */
227 #define XFS_FSOP_GEOM_FLAGS_DALIGN	(1 << 4)  /* large data alignment  */
228 #define XFS_FSOP_GEOM_FLAGS_SHARED	(1 << 5)  /* read-only shared	   */
229 #define XFS_FSOP_GEOM_FLAGS_EXTFLG	(1 << 6)  /* special extent flag   */
230 #define XFS_FSOP_GEOM_FLAGS_DIRV2	(1 << 7)  /* directory version 2   */
231 #define XFS_FSOP_GEOM_FLAGS_LOGV2	(1 << 8)  /* log format version 2  */
232 #define XFS_FSOP_GEOM_FLAGS_SECTOR	(1 << 9)  /* sector sizes >1BB	   */
233 #define XFS_FSOP_GEOM_FLAGS_ATTR2	(1 << 10) /* inline attributes rework */
234 #define XFS_FSOP_GEOM_FLAGS_PROJID32	(1 << 11) /* 32-bit project IDs	   */
235 #define XFS_FSOP_GEOM_FLAGS_DIRV2CI	(1 << 12) /* ASCII only CI names   */
236 	/*  -- Do not use --		(1 << 13)    SGI parent pointers   */
237 #define XFS_FSOP_GEOM_FLAGS_LAZYSB	(1 << 14) /* lazy superblock counters */
238 #define XFS_FSOP_GEOM_FLAGS_V5SB	(1 << 15) /* version 5 superblock  */
239 #define XFS_FSOP_GEOM_FLAGS_FTYPE	(1 << 16) /* inode directory types */
240 #define XFS_FSOP_GEOM_FLAGS_FINOBT	(1 << 17) /* free inode btree	   */
241 #define XFS_FSOP_GEOM_FLAGS_SPINODES	(1 << 18) /* sparse inode chunks   */
242 #define XFS_FSOP_GEOM_FLAGS_RMAPBT	(1 << 19) /* reverse mapping btree */
243 #define XFS_FSOP_GEOM_FLAGS_REFLINK	(1 << 20) /* files can share blocks */
244 #define XFS_FSOP_GEOM_FLAGS_BIGTIME	(1 << 21) /* 64-bit nsec timestamps */
245 #define XFS_FSOP_GEOM_FLAGS_INOBTCNT	(1 << 22) /* inobt btree counter */
246 #define XFS_FSOP_GEOM_FLAGS_NREXT64	(1 << 23) /* large extent counters */
247 #define XFS_FSOP_GEOM_FLAGS_EXCHANGE_RANGE (1 << 24) /* exchange range */
248 #define XFS_FSOP_GEOM_FLAGS_PARENT	(1 << 25) /* linux parent pointers */
249 #define XFS_FSOP_GEOM_FLAGS_METADIR	(1 << 26) /* metadata directories */
250 
251 /*
252  * Minimum and maximum sizes need for growth checks.
253  *
254  * Block counts are in units of filesystem blocks, not basic blocks.
255  */
256 #define XFS_MIN_AG_BLOCKS	64
257 #define XFS_MIN_LOG_BLOCKS	512ULL
258 #define XFS_MAX_LOG_BLOCKS	(1024 * 1024ULL)
259 #define XFS_MIN_LOG_BYTES	(10 * 1024 * 1024ULL)
260 
261 /*
262  * Limits on sb_agblocks/sb_agblklog -- mkfs won't format AGs smaller than
263  * 16MB or larger than 1TB.
264  */
265 #define XFS_MIN_AG_BYTES	(1ULL << 24)	/* 16 MB */
266 #define XFS_MAX_AG_BYTES	(1ULL << 40)	/* 1 TB */
267 #define XFS_MAX_AG_BLOCKS	(XFS_MAX_AG_BYTES / XFS_MIN_BLOCKSIZE)
268 #define XFS_MAX_CRC_AG_BLOCKS	(XFS_MAX_AG_BYTES / XFS_MIN_CRC_BLOCKSIZE)
269 
270 #define XFS_MAX_AGNUMBER	((xfs_agnumber_t)(NULLAGNUMBER - 1))
271 
272 /* keep the maximum size under 2^31 by a small amount */
273 #define XFS_MAX_LOG_BYTES \
274 	((2 * 1024 * 1024 * 1024ULL) - XFS_MIN_LOG_BYTES)
275 
276 /* Used for sanity checks on superblock */
277 #define XFS_MAX_DBLOCKS(s) ((xfs_rfsblock_t)(s)->sb_agcount * (s)->sb_agblocks)
278 #define XFS_MIN_DBLOCKS(s) ((xfs_rfsblock_t)((s)->sb_agcount - 1) *	\
279 			 (s)->sb_agblocks + XFS_MIN_AG_BLOCKS)
280 
281 /*
282  * Output for XFS_IOC_AG_GEOMETRY
283  */
284 struct xfs_ag_geometry {
285 	uint32_t	ag_number;	/* i/o: AG number */
286 	uint32_t	ag_length;	/* o: length in blocks */
287 	uint32_t	ag_freeblks;	/* o: free space */
288 	uint32_t	ag_icount;	/* o: inodes allocated */
289 	uint32_t	ag_ifree;	/* o: inodes free */
290 	uint32_t	ag_sick;	/* o: sick things in ag */
291 	uint32_t	ag_checked;	/* o: checked metadata in ag */
292 	uint32_t	ag_flags;	/* i/o: flags for this ag */
293 	uint64_t	ag_reserved[12];/* o: zero */
294 };
295 #define XFS_AG_GEOM_SICK_SB	(1 << 0)  /* superblock */
296 #define XFS_AG_GEOM_SICK_AGF	(1 << 1)  /* AGF header */
297 #define XFS_AG_GEOM_SICK_AGFL	(1 << 2)  /* AGFL header */
298 #define XFS_AG_GEOM_SICK_AGI	(1 << 3)  /* AGI header */
299 #define XFS_AG_GEOM_SICK_BNOBT	(1 << 4)  /* free space by block */
300 #define XFS_AG_GEOM_SICK_CNTBT	(1 << 5)  /* free space by length */
301 #define XFS_AG_GEOM_SICK_INOBT	(1 << 6)  /* inode index */
302 #define XFS_AG_GEOM_SICK_FINOBT	(1 << 7)  /* free inode index */
303 #define XFS_AG_GEOM_SICK_RMAPBT	(1 << 8)  /* reverse mappings */
304 #define XFS_AG_GEOM_SICK_REFCNTBT (1 << 9)  /* reference counts */
305 #define XFS_AG_GEOM_SICK_INODES	(1 << 10) /* bad inodes were seen */
306 
307 /*
308  * Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
309  */
310 typedef struct xfs_growfs_data {
311 	__u64		newblocks;	/* new data subvol size, fsblocks */
312 	__u32		imaxpct;	/* new inode space percentage limit */
313 } xfs_growfs_data_t;
314 
315 typedef struct xfs_growfs_log {
316 	__u32		newblocks;	/* new log size, fsblocks */
317 	__u32		isint;		/* 1 if new log is internal */
318 } xfs_growfs_log_t;
319 
320 typedef struct xfs_growfs_rt {
321 	__u64		newblocks;	/* new realtime size, fsblocks */
322 	__u32		extsize;	/* new realtime extent size, fsblocks */
323 } xfs_growfs_rt_t;
324 
325 
326 /*
327  * Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
328  */
329 typedef struct xfs_bstime {
330 	__kernel_long_t tv_sec;		/* seconds		*/
331 	__s32		tv_nsec;	/* and nanoseconds	*/
332 } xfs_bstime_t;
333 
334 struct xfs_bstat {
335 	__u64		bs_ino;		/* inode number			*/
336 	__u16		bs_mode;	/* type and mode		*/
337 	__u16		bs_nlink;	/* number of links		*/
338 	__u32		bs_uid;		/* user id			*/
339 	__u32		bs_gid;		/* group id			*/
340 	__u32		bs_rdev;	/* device value			*/
341 	__s32		bs_blksize;	/* block size			*/
342 	__s64		bs_size;	/* file size			*/
343 	xfs_bstime_t	bs_atime;	/* access time			*/
344 	xfs_bstime_t	bs_mtime;	/* modify time			*/
345 	xfs_bstime_t	bs_ctime;	/* inode change time		*/
346 	int64_t		bs_blocks;	/* number of blocks		*/
347 	__u32		bs_xflags;	/* extended flags		*/
348 	__s32		bs_extsize;	/* extent size			*/
349 	__s32		bs_extents;	/* number of extents		*/
350 	__u32		bs_gen;		/* generation count		*/
351 	__u16		bs_projid_lo;	/* lower part of project id	*/
352 #define	bs_projid	bs_projid_lo	/* (previously just bs_projid)	*/
353 	__u16		bs_forkoff;	/* inode fork offset in bytes	*/
354 	__u16		bs_projid_hi;	/* higher part of project id	*/
355 	uint16_t	bs_sick;	/* sick inode metadata		*/
356 	uint16_t	bs_checked;	/* checked inode metadata	*/
357 	unsigned char	bs_pad[2];	/* pad space, unused		*/
358 	__u32		bs_cowextsize;	/* cow extent size		*/
359 	__u32		bs_dmevmask;	/* DMIG event mask		*/
360 	__u16		bs_dmstate;	/* DMIG state info		*/
361 	__u16		bs_aextents;	/* attribute number of extents	*/
362 };
363 
364 /* New bulkstat structure that reports v5 features and fixes padding issues */
365 struct xfs_bulkstat {
366 	uint64_t	bs_ino;		/* inode number			*/
367 	uint64_t	bs_size;	/* file size			*/
368 
369 	uint64_t	bs_blocks;	/* number of blocks		*/
370 	uint64_t	bs_xflags;	/* extended flags		*/
371 
372 	int64_t		bs_atime;	/* access time, seconds		*/
373 	int64_t		bs_mtime;	/* modify time, seconds		*/
374 
375 	int64_t		bs_ctime;	/* inode change time, seconds	*/
376 	int64_t		bs_btime;	/* creation time, seconds	*/
377 
378 	uint32_t	bs_gen;		/* generation count		*/
379 	uint32_t	bs_uid;		/* user id			*/
380 	uint32_t	bs_gid;		/* group id			*/
381 	uint32_t	bs_projectid;	/* project id			*/
382 
383 	uint32_t	bs_atime_nsec;	/* access time, nanoseconds	*/
384 	uint32_t	bs_mtime_nsec;	/* modify time, nanoseconds	*/
385 	uint32_t	bs_ctime_nsec;	/* inode change time, nanoseconds */
386 	uint32_t	bs_btime_nsec;	/* creation time, nanoseconds	*/
387 
388 	uint32_t	bs_blksize;	/* block size			*/
389 	uint32_t	bs_rdev;	/* device value			*/
390 	uint32_t	bs_cowextsize_blks; /* cow extent size hint, blocks */
391 	uint32_t	bs_extsize_blks; /* extent size hint, blocks	*/
392 
393 	uint32_t	bs_nlink;	/* number of links		*/
394 	uint32_t	bs_extents;	/* 32-bit data fork extent counter */
395 	uint32_t	bs_aextents;	/* attribute number of extents	*/
396 	uint16_t	bs_version;	/* structure version		*/
397 	uint16_t	bs_forkoff;	/* inode fork offset in bytes	*/
398 
399 	uint16_t	bs_sick;	/* sick inode metadata		*/
400 	uint16_t	bs_checked;	/* checked inode metadata	*/
401 	uint16_t	bs_mode;	/* type and mode		*/
402 	uint16_t	bs_pad2;	/* zeroed			*/
403 	uint64_t	bs_extents64;	/* 64-bit data fork extent counter */
404 
405 	uint64_t	bs_pad[6];	/* zeroed			*/
406 };
407 
408 #define XFS_BULKSTAT_VERSION_V1	(1)
409 #define XFS_BULKSTAT_VERSION_V5	(5)
410 
411 /* bs_sick flags */
412 #define XFS_BS_SICK_INODE	(1 << 0)  /* inode core */
413 #define XFS_BS_SICK_BMBTD	(1 << 1)  /* data fork */
414 #define XFS_BS_SICK_BMBTA	(1 << 2)  /* attr fork */
415 #define XFS_BS_SICK_BMBTC	(1 << 3)  /* cow fork */
416 #define XFS_BS_SICK_DIR		(1 << 4)  /* directory */
417 #define XFS_BS_SICK_XATTR	(1 << 5)  /* extended attributes */
418 #define XFS_BS_SICK_SYMLINK	(1 << 6)  /* symbolic link remote target */
419 #define XFS_BS_SICK_PARENT	(1 << 7)  /* parent pointers */
420 #define XFS_BS_SICK_DIRTREE	(1 << 8)  /* directory tree structure */
421 
422 /*
423  * Project quota id helpers (previously projid was 16bit only
424  * and using two 16bit values to hold new 32bit projid was chosen
425  * to retain compatibility with "old" filesystems).
426  */
427 static inline uint32_t
bstat_get_projid(const struct xfs_bstat * bs)428 bstat_get_projid(const struct xfs_bstat *bs)
429 {
430 	return (uint32_t)bs->bs_projid_hi << 16 | bs->bs_projid_lo;
431 }
432 
433 /*
434  * The user-level BulkStat Request interface structure.
435  */
436 struct xfs_fsop_bulkreq {
437 	__u64		__user *lastip;	/* last inode # pointer		*/
438 	__s32		icount;		/* count of entries in buffer	*/
439 	void		__user *ubuffer;/* user buffer for inode desc.	*/
440 	__s32		__user *ocount;	/* output count pointer		*/
441 };
442 
443 /*
444  * Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
445  */
446 struct xfs_inogrp {
447 	__u64		xi_startino;	/* starting inode number	*/
448 	__s32		xi_alloccount;	/* # bits set in allocmask	*/
449 	__u64		xi_allocmask;	/* mask of allocated inodes	*/
450 };
451 
452 /* New inumbers structure that reports v5 features and fixes padding issues */
453 struct xfs_inumbers {
454 	uint64_t	xi_startino;	/* starting inode number	*/
455 	uint64_t	xi_allocmask;	/* mask of allocated inodes	*/
456 	uint8_t		xi_alloccount;	/* # bits set in allocmask	*/
457 	uint8_t		xi_version;	/* version			*/
458 	uint8_t		xi_padding[6];	/* zero				*/
459 };
460 
461 #define XFS_INUMBERS_VERSION_V1	(1)
462 #define XFS_INUMBERS_VERSION_V5	(5)
463 
464 /* Header for bulk inode requests. */
465 struct xfs_bulk_ireq {
466 	uint64_t	ino;		/* I/O: start with this inode	*/
467 	uint32_t	flags;		/* I/O: operation flags		*/
468 	uint32_t	icount;		/* I: count of entries in buffer */
469 	uint32_t	ocount;		/* O: count of entries filled out */
470 	uint32_t	agno;		/* I: see comment for IREQ_AGNO	*/
471 	uint64_t	reserved[5];	/* must be zero			*/
472 };
473 
474 /*
475  * Only return results from the specified @agno.  If @ino is zero, start
476  * with the first inode of @agno.
477  */
478 #define XFS_BULK_IREQ_AGNO	(1U << 0)
479 
480 /*
481  * Return bulkstat information for a single inode, where @ino value is a
482  * special value, not a literal inode number.  See the XFS_BULK_IREQ_SPECIAL_*
483  * values below.  Not compatible with XFS_BULK_IREQ_AGNO.
484  */
485 #define XFS_BULK_IREQ_SPECIAL	(1U << 1)
486 
487 /*
488  * Return data fork extent count via xfs_bulkstat->bs_extents64 field and assign
489  * 0 to xfs_bulkstat->bs_extents when the flag is set.  Otherwise, use
490  * xfs_bulkstat->bs_extents for returning data fork extent count and set
491  * xfs_bulkstat->bs_extents64 to 0. In the second case, return -EOVERFLOW and
492  * assign 0 to xfs_bulkstat->bs_extents if data fork extent count is larger than
493  * XFS_MAX_EXTCNT_DATA_FORK_OLD.
494  */
495 #define XFS_BULK_IREQ_NREXT64	(1U << 2)
496 
497 /*
498  * Allow bulkstat to return information about metadata directories.  This
499  * enables xfs_scrub to find them for scanning, as they are otherwise ordinary
500  * directories.
501  */
502 #define XFS_BULK_IREQ_METADIR	(1U << 3)
503 
504 #define XFS_BULK_IREQ_FLAGS_ALL	(XFS_BULK_IREQ_AGNO |	 \
505 				 XFS_BULK_IREQ_SPECIAL | \
506 				 XFS_BULK_IREQ_NREXT64 | \
507 				 XFS_BULK_IREQ_METADIR)
508 
509 /* Operate on the root directory inode. */
510 #define XFS_BULK_IREQ_SPECIAL_ROOT	(1)
511 
512 /*
513  * ioctl structures for v5 bulkstat and inumbers requests
514  */
515 struct xfs_bulkstat_req {
516 	struct xfs_bulk_ireq	hdr;
517 	struct xfs_bulkstat	bulkstat[];
518 };
519 #define XFS_BULKSTAT_REQ_SIZE(nr)	(sizeof(struct xfs_bulkstat_req) + \
520 					 (nr) * sizeof(struct xfs_bulkstat))
521 
522 struct xfs_inumbers_req {
523 	struct xfs_bulk_ireq	hdr;
524 	struct xfs_inumbers	inumbers[];
525 };
526 #define XFS_INUMBERS_REQ_SIZE(nr)	(sizeof(struct xfs_inumbers_req) + \
527 					 (nr) * sizeof(struct xfs_inumbers))
528 
529 /*
530  * Error injection.
531  */
532 typedef struct xfs_error_injection {
533 	__s32		fd;
534 	__s32		errtag;
535 } xfs_error_injection_t;
536 
537 
538 /*
539  * Speculative preallocation trimming.
540  */
541 #define XFS_EOFBLOCKS_VERSION		1
542 struct xfs_fs_eofblocks {
543 	__u32		eof_version;
544 	__u32		eof_flags;
545 	uid_t		eof_uid;
546 	gid_t		eof_gid;
547 	prid_t		eof_prid;
548 	__u32		pad32;
549 	__u64		eof_min_file_size;
550 	__u64		pad64[12];
551 };
552 
553 /* eof_flags values */
554 #define XFS_EOF_FLAGS_SYNC		(1 << 0) /* sync/wait mode scan */
555 #define XFS_EOF_FLAGS_UID		(1 << 1) /* filter by uid */
556 #define XFS_EOF_FLAGS_GID		(1 << 2) /* filter by gid */
557 #define XFS_EOF_FLAGS_PRID		(1 << 3) /* filter by project id */
558 #define XFS_EOF_FLAGS_MINFILESIZE	(1 << 4) /* filter by min file size */
559 #define XFS_EOF_FLAGS_UNION		(1 << 5) /* union filter algorithm;
560 						  * kernel only, not included in
561 						  * valid mask */
562 #define XFS_EOF_FLAGS_VALID	\
563 	(XFS_EOF_FLAGS_SYNC |	\
564 	 XFS_EOF_FLAGS_UID |	\
565 	 XFS_EOF_FLAGS_GID |	\
566 	 XFS_EOF_FLAGS_PRID |	\
567 	 XFS_EOF_FLAGS_MINFILESIZE)
568 
569 
570 /*
571  * The user-level Handle Request interface structure.
572  */
573 typedef struct xfs_fsop_handlereq {
574 	__u32		fd;		/* fd for FD_TO_HANDLE		*/
575 	void		__user *path;	/* user pathname		*/
576 	__u32		oflags;		/* open flags			*/
577 	void		__user *ihandle;/* user supplied handle		*/
578 	__u32		ihandlen;	/* user supplied length		*/
579 	void		__user *ohandle;/* user buffer for handle	*/
580 	__u32		__user *ohandlen;/* user buffer length		*/
581 } xfs_fsop_handlereq_t;
582 
583 /*
584  * Compound structures for passing args through Handle Request interfaces
585  * xfs_attrlist_by_handle, xfs_attrmulti_by_handle
586  * - ioctls: XFS_IOC_ATTRLIST_BY_HANDLE, and XFS_IOC_ATTRMULTI_BY_HANDLE
587  */
588 
589 /*
590  * Flags passed in xfs_attr_multiop.am_flags for the attr ioctl interface.
591  *
592  * NOTE: Must match the values declared in libattr without the XFS_IOC_ prefix.
593  */
594 #define XFS_IOC_ATTR_ROOT	0x0002	/* use attrs in root namespace */
595 #define XFS_IOC_ATTR_SECURE	0x0008	/* use attrs in security namespace */
596 #define XFS_IOC_ATTR_CREATE	0x0010	/* fail if attr already exists */
597 #define XFS_IOC_ATTR_REPLACE	0x0020	/* fail if attr does not exist */
598 
599 typedef struct xfs_attrlist_cursor {
600 	__u32		opaque[4];
601 } xfs_attrlist_cursor_t;
602 
603 /*
604  * Define how lists of attribute names are returned to userspace from the
605  * XFS_IOC_ATTRLIST_BY_HANDLE ioctl.  struct xfs_attrlist is the header at the
606  * beginning of the returned buffer, and a each entry in al_offset contains the
607  * relative offset of an xfs_attrlist_ent containing the actual entry.
608  *
609  * NOTE: struct xfs_attrlist must match struct attrlist defined in libattr, and
610  * struct xfs_attrlist_ent must match struct attrlist_ent defined in libattr.
611  */
612 struct xfs_attrlist {
613 	__s32	al_count;	/* number of entries in attrlist */
614 	__s32	al_more;	/* T/F: more attrs (do call again) */
615 	__s32	al_offset[];	/* byte offsets of attrs [var-sized] */
616 };
617 
618 struct xfs_attrlist_ent {	/* data from attr_list() */
619 	__u32	a_valuelen;	/* number bytes in value of attr */
620 	char	a_name[];	/* attr name (NULL terminated) */
621 };
622 
623 typedef struct xfs_fsop_attrlist_handlereq {
624 	struct xfs_fsop_handlereq	hreq; /* handle interface structure */
625 	struct xfs_attrlist_cursor	pos; /* opaque cookie, list offset */
626 	__u32				flags;	/* which namespace to use */
627 	__u32				buflen;	/* length of buffer supplied */
628 	void				__user *buffer;	/* returned names */
629 } xfs_fsop_attrlist_handlereq_t;
630 
631 typedef struct xfs_attr_multiop {
632 	__u32		am_opcode;
633 #define ATTR_OP_GET	1	/* return the indicated attr's value */
634 #define ATTR_OP_SET	2	/* set/create the indicated attr/value pair */
635 #define ATTR_OP_REMOVE	3	/* remove the indicated attr */
636 	__s32		am_error;
637 	void		__user *am_attrname;
638 	void		__user *am_attrvalue;
639 	__u32		am_length;
640 	__u32		am_flags; /* XFS_IOC_ATTR_* */
641 } xfs_attr_multiop_t;
642 
643 typedef struct xfs_fsop_attrmulti_handlereq {
644 	struct xfs_fsop_handlereq	hreq; /* handle interface structure */
645 	__u32				opcount;/* count of following multiop */
646 	struct xfs_attr_multiop		__user *ops; /* attr_multi data */
647 } xfs_fsop_attrmulti_handlereq_t;
648 
649 /*
650  * per machine unique filesystem identifier types.
651  */
652 typedef struct xfs_fsid {
653 	__u32	val[2];			/* file system id type */
654 } xfs_fsid_t;
655 
656 typedef struct xfs_fid {
657 	__u16	fid_len;		/* length of remainder	*/
658 	__u16	fid_pad;
659 	__u32	fid_gen;		/* generation number	*/
660 	__u64	fid_ino;		/* 64 bits inode number */
661 } xfs_fid_t;
662 
663 typedef struct xfs_handle {
664 	union {
665 		__s64	    align;	/* force alignment of ha_fid	 */
666 		xfs_fsid_t  _ha_fsid;	/* unique file system identifier */
667 	} ha_u;
668 	xfs_fid_t	ha_fid;		/* file system specific file ID	 */
669 } xfs_handle_t;
670 #define ha_fsid ha_u._ha_fsid
671 
672 /*
673  * Structure passed to XFS_IOC_SWAPEXT
674  */
675 typedef struct xfs_swapext
676 {
677 	int64_t		sx_version;	/* version */
678 #define XFS_SX_VERSION		0
679 	int64_t		sx_fdtarget;	/* fd of target file */
680 	int64_t		sx_fdtmp;	/* fd of tmp file */
681 	xfs_off_t	sx_offset;	/* offset into file */
682 	xfs_off_t	sx_length;	/* leng from offset */
683 	char		sx_pad[16];	/* pad space, unused */
684 	struct xfs_bstat sx_stat;	/* stat of target b4 copy */
685 } xfs_swapext_t;
686 
687 /*
688  * Flags for going down operation
689  */
690 #define XFS_FSOP_GOING_FLAGS_DEFAULT		0x0	/* going down */
691 #define XFS_FSOP_GOING_FLAGS_LOGFLUSH		0x1	/* flush log but not data */
692 #define XFS_FSOP_GOING_FLAGS_NOLOGFLUSH		0x2	/* don't flush log nor data */
693 
694 /* metadata scrubbing */
695 struct xfs_scrub_metadata {
696 	__u32 sm_type;		/* What to check? */
697 	__u32 sm_flags;		/* flags; see below. */
698 	__u64 sm_ino;		/* inode number. */
699 	__u32 sm_gen;		/* inode generation. */
700 	__u32 sm_agno;		/* ag number. */
701 	__u64 sm_reserved[5];	/* pad to 64 bytes */
702 };
703 
704 /*
705  * Metadata types and flags for scrub operation.
706  */
707 
708 /* Scrub subcommands. */
709 #define XFS_SCRUB_TYPE_PROBE	0	/* presence test ioctl */
710 #define XFS_SCRUB_TYPE_SB	1	/* superblock */
711 #define XFS_SCRUB_TYPE_AGF	2	/* AG free header */
712 #define XFS_SCRUB_TYPE_AGFL	3	/* AG free list */
713 #define XFS_SCRUB_TYPE_AGI	4	/* AG inode header */
714 #define XFS_SCRUB_TYPE_BNOBT	5	/* freesp by block btree */
715 #define XFS_SCRUB_TYPE_CNTBT	6	/* freesp by length btree */
716 #define XFS_SCRUB_TYPE_INOBT	7	/* inode btree */
717 #define XFS_SCRUB_TYPE_FINOBT	8	/* free inode btree */
718 #define XFS_SCRUB_TYPE_RMAPBT	9	/* reverse mapping btree */
719 #define XFS_SCRUB_TYPE_REFCNTBT	10	/* reference count btree */
720 #define XFS_SCRUB_TYPE_INODE	11	/* inode record */
721 #define XFS_SCRUB_TYPE_BMBTD	12	/* data fork block mapping */
722 #define XFS_SCRUB_TYPE_BMBTA	13	/* attr fork block mapping */
723 #define XFS_SCRUB_TYPE_BMBTC	14	/* CoW fork block mapping */
724 #define XFS_SCRUB_TYPE_DIR	15	/* directory */
725 #define XFS_SCRUB_TYPE_XATTR	16	/* extended attribute */
726 #define XFS_SCRUB_TYPE_SYMLINK	17	/* symbolic link */
727 #define XFS_SCRUB_TYPE_PARENT	18	/* parent pointers */
728 #define XFS_SCRUB_TYPE_RTBITMAP	19	/* realtime bitmap */
729 #define XFS_SCRUB_TYPE_RTSUM	20	/* realtime summary */
730 #define XFS_SCRUB_TYPE_UQUOTA	21	/* user quotas */
731 #define XFS_SCRUB_TYPE_GQUOTA	22	/* group quotas */
732 #define XFS_SCRUB_TYPE_PQUOTA	23	/* project quotas */
733 #define XFS_SCRUB_TYPE_FSCOUNTERS 24	/* fs summary counters */
734 #define XFS_SCRUB_TYPE_QUOTACHECK 25	/* quota counters */
735 #define XFS_SCRUB_TYPE_NLINKS	26	/* inode link counts */
736 #define XFS_SCRUB_TYPE_HEALTHY	27	/* everything checked out ok */
737 #define XFS_SCRUB_TYPE_DIRTREE	28	/* directory tree structure */
738 #define XFS_SCRUB_TYPE_METAPATH	29	/* metadata directory tree paths */
739 #define XFS_SCRUB_TYPE_RGSUPER	30	/* realtime superblock */
740 
741 /* Number of scrub subcommands. */
742 #define XFS_SCRUB_TYPE_NR	31
743 
744 /*
745  * This special type code only applies to the vectored scrub implementation.
746  *
747  * If any of the previous scrub vectors recorded runtime errors or have
748  * sv_flags bits set that match the OFLAG bits in the barrier vector's
749  * sv_flags, set the barrier's sv_ret to -ECANCELED and return to userspace.
750  */
751 #define XFS_SCRUB_TYPE_BARRIER	(0xFFFFFFFF)
752 
753 /* i: Repair this metadata. */
754 #define XFS_SCRUB_IFLAG_REPAIR		(1u << 0)
755 
756 /* o: Metadata object needs repair. */
757 #define XFS_SCRUB_OFLAG_CORRUPT		(1u << 1)
758 
759 /*
760  * o: Metadata object could be optimized.  It's not corrupt, but
761  *    we could improve on it somehow.
762  */
763 #define XFS_SCRUB_OFLAG_PREEN		(1u << 2)
764 
765 /* o: Cross-referencing failed. */
766 #define XFS_SCRUB_OFLAG_XFAIL		(1u << 3)
767 
768 /* o: Metadata object disagrees with cross-referenced metadata. */
769 #define XFS_SCRUB_OFLAG_XCORRUPT	(1u << 4)
770 
771 /* o: Scan was not complete. */
772 #define XFS_SCRUB_OFLAG_INCOMPLETE	(1u << 5)
773 
774 /* o: Metadata object looked funny but isn't corrupt. */
775 #define XFS_SCRUB_OFLAG_WARNING		(1u << 6)
776 
777 /*
778  * o: IFLAG_REPAIR was set but metadata object did not need fixing or
779  *    optimization and has therefore not been altered.
780  */
781 #define XFS_SCRUB_OFLAG_NO_REPAIR_NEEDED (1u << 7)
782 
783 /* i: Rebuild the data structure. */
784 #define XFS_SCRUB_IFLAG_FORCE_REBUILD	(1u << 8)
785 
786 #define XFS_SCRUB_FLAGS_IN	(XFS_SCRUB_IFLAG_REPAIR | \
787 				 XFS_SCRUB_IFLAG_FORCE_REBUILD)
788 #define XFS_SCRUB_FLAGS_OUT	(XFS_SCRUB_OFLAG_CORRUPT | \
789 				 XFS_SCRUB_OFLAG_PREEN | \
790 				 XFS_SCRUB_OFLAG_XFAIL | \
791 				 XFS_SCRUB_OFLAG_XCORRUPT | \
792 				 XFS_SCRUB_OFLAG_INCOMPLETE | \
793 				 XFS_SCRUB_OFLAG_WARNING | \
794 				 XFS_SCRUB_OFLAG_NO_REPAIR_NEEDED)
795 #define XFS_SCRUB_FLAGS_ALL	(XFS_SCRUB_FLAGS_IN | XFS_SCRUB_FLAGS_OUT)
796 
797 /* Vectored scrub calls to reduce the number of kernel transitions. */
798 
799 struct xfs_scrub_vec {
800 	__u32 sv_type;		/* XFS_SCRUB_TYPE_* */
801 	__u32 sv_flags;		/* XFS_SCRUB_FLAGS_* */
802 	__s32 sv_ret;		/* 0 or a negative error code */
803 	__u32 sv_reserved;	/* must be zero */
804 };
805 
806 /* Vectored metadata scrub control structure. */
807 struct xfs_scrub_vec_head {
808 	__u64 svh_ino;		/* inode number. */
809 	__u32 svh_gen;		/* inode generation. */
810 	__u32 svh_agno;		/* ag number. */
811 	__u32 svh_flags;	/* XFS_SCRUB_VEC_FLAGS_* */
812 	__u16 svh_rest_us;	/* wait this much time between vector items */
813 	__u16 svh_nr;		/* number of svh_vectors */
814 	__u64 svh_reserved;	/* must be zero */
815 	__u64 svh_vectors;	/* pointer to buffer of xfs_scrub_vec */
816 };
817 
818 #define XFS_SCRUB_VEC_FLAGS_ALL		(0)
819 
820 /*
821  * i: sm_ino values for XFS_SCRUB_TYPE_METAPATH to select a metadata file for
822  * path checking.
823  */
824 #define XFS_SCRUB_METAPATH_PROBE	(0)  /* do we have a metapath scrubber? */
825 #define XFS_SCRUB_METAPATH_RTDIR	(1)  /* rtrgroups metadir */
826 #define XFS_SCRUB_METAPATH_RTBITMAP	(2)  /* per-rtg bitmap */
827 #define XFS_SCRUB_METAPATH_RTSUMMARY	(3)  /* per-rtg summary */
828 #define XFS_SCRUB_METAPATH_QUOTADIR	(4)  /* quota metadir */
829 #define XFS_SCRUB_METAPATH_USRQUOTA	(5)  /* user quota */
830 #define XFS_SCRUB_METAPATH_GRPQUOTA	(6)  /* group quota */
831 #define XFS_SCRUB_METAPATH_PRJQUOTA	(7)  /* project quota */
832 
833 /* Number of metapath sm_ino values */
834 #define XFS_SCRUB_METAPATH_NR		(8)
835 
836 /*
837  * ioctl limits
838  */
839 #ifdef XATTR_LIST_MAX
840 #  define XFS_XATTR_LIST_MAX XATTR_LIST_MAX
841 #else
842 #  define XFS_XATTR_LIST_MAX 65536
843 #endif
844 
845 /*
846  * Exchange part of file1 with part of the file that this ioctl that is being
847  * called against (which we'll call file2).  Filesystems must be able to
848  * restart and complete the operation even after the system goes down.
849  */
850 struct xfs_exchange_range {
851 	__s32		file1_fd;
852 	__u32		pad;		/* must be zeroes */
853 	__u64		file1_offset;	/* file1 offset, bytes */
854 	__u64		file2_offset;	/* file2 offset, bytes */
855 	__u64		length;		/* bytes to exchange */
856 
857 	__u64		flags;		/* see XFS_EXCHANGE_RANGE_* below */
858 };
859 
860 /*
861  * Using the same definition of file2 as struct xfs_exchange_range, commit the
862  * contents of file1 into file2 if file2 has the same inode number, mtime, and
863  * ctime as the arguments provided to the call.  The old contents of file2 will
864  * be moved to file1.
865  *
866  * Returns -EBUSY if there isn't an exact match for the file2 fields.
867  *
868  * Filesystems must be able to restart and complete the operation even after
869  * the system goes down.
870  */
871 struct xfs_commit_range {
872 	__s32		file1_fd;
873 	__u32		pad;		/* must be zeroes */
874 	__u64		file1_offset;	/* file1 offset, bytes */
875 	__u64		file2_offset;	/* file2 offset, bytes */
876 	__u64		length;		/* bytes to exchange */
877 
878 	__u64		flags;		/* see XFS_EXCHANGE_RANGE_* below */
879 
880 	/* opaque file2 metadata for freshness checks */
881 	__u64		file2_freshness[6];
882 };
883 
884 /*
885  * Exchange file data all the way to the ends of both files, and then exchange
886  * the file sizes.  This flag can be used to replace a file's contents with a
887  * different amount of data.  length will be ignored.
888  */
889 #define XFS_EXCHANGE_RANGE_TO_EOF	(1ULL << 0)
890 
891 /* Flush all changes in file data and file metadata to disk before returning. */
892 #define XFS_EXCHANGE_RANGE_DSYNC	(1ULL << 1)
893 
894 /* Dry run; do all the parameter verification but do not change anything. */
895 #define XFS_EXCHANGE_RANGE_DRY_RUN	(1ULL << 2)
896 
897 /*
898  * Exchange only the parts of the two files where the file allocation units
899  * mapped to file1's range have been written to.  This can accelerate
900  * scatter-gather atomic writes with a temp file if all writes are aligned to
901  * the file allocation unit.
902  */
903 #define XFS_EXCHANGE_RANGE_FILE1_WRITTEN (1ULL << 3)
904 
905 #define XFS_EXCHANGE_RANGE_ALL_FLAGS	(XFS_EXCHANGE_RANGE_TO_EOF | \
906 					 XFS_EXCHANGE_RANGE_DSYNC | \
907 					 XFS_EXCHANGE_RANGE_DRY_RUN | \
908 					 XFS_EXCHANGE_RANGE_FILE1_WRITTEN)
909 
910 /* Iterating parent pointers of files. */
911 
912 /* target was the root directory */
913 #define XFS_GETPARENTS_OFLAG_ROOT	(1U << 0)
914 
915 /* Cursor is done iterating pptrs */
916 #define XFS_GETPARENTS_OFLAG_DONE	(1U << 1)
917 
918 #define XFS_GETPARENTS_OFLAGS_ALL	(XFS_GETPARENTS_OFLAG_ROOT | \
919 					 XFS_GETPARENTS_OFLAG_DONE)
920 
921 #define XFS_GETPARENTS_IFLAGS_ALL	(0)
922 
923 struct xfs_getparents_rec {
924 	struct xfs_handle	gpr_parent; /* Handle to parent */
925 	__u32			gpr_reclen; /* Length of entire record */
926 	__u32			gpr_reserved; /* zero */
927 	char			gpr_name[]; /* Null-terminated filename */
928 };
929 
930 /* Iterate through this file's directory parent pointers */
931 struct xfs_getparents {
932 	/*
933 	 * Structure to track progress in iterating the parent pointers.
934 	 * Must be initialized to zeroes before the first ioctl call, and
935 	 * not touched by callers after that.
936 	 */
937 	struct xfs_attrlist_cursor	gp_cursor;
938 
939 	/* Input flags: XFS_GETPARENTS_IFLAG* */
940 	__u16				gp_iflags;
941 
942 	/* Output flags: XFS_GETPARENTS_OFLAG* */
943 	__u16				gp_oflags;
944 
945 	/* Size of the gp_buffer in bytes */
946 	__u32				gp_bufsize;
947 
948 	/* Must be set to zero */
949 	__u64				gp_reserved;
950 
951 	/* Pointer to a buffer in which to place xfs_getparents_rec */
952 	__u64				gp_buffer;
953 };
954 
955 static inline struct xfs_getparents_rec *
xfs_getparents_first_rec(struct xfs_getparents * gp)956 xfs_getparents_first_rec(struct xfs_getparents *gp)
957 {
958 	return (struct xfs_getparents_rec *)(uintptr_t)gp->gp_buffer;
959 }
960 
961 static inline struct xfs_getparents_rec *
xfs_getparents_next_rec(struct xfs_getparents * gp,struct xfs_getparents_rec * gpr)962 xfs_getparents_next_rec(struct xfs_getparents *gp,
963 			struct xfs_getparents_rec *gpr)
964 {
965 	void *next = ((char *)gpr + gpr->gpr_reclen);
966 	void *end = (void *)(uintptr_t)(gp->gp_buffer + gp->gp_bufsize);
967 
968 	if (next >= end)
969 		return NULL;
970 
971 	return (struct xfs_getparents_rec *)next;
972 }
973 
974 /* Iterate through this file handle's directory parent pointers. */
975 struct xfs_getparents_by_handle {
976 	/* Handle to file whose parents we want. */
977 	struct xfs_handle		gph_handle;
978 
979 	struct xfs_getparents		gph_request;
980 };
981 
982 /*
983  * Output for XFS_IOC_RTGROUP_GEOMETRY
984  */
985 struct xfs_rtgroup_geometry {
986 	__u32 rg_number;	/* i/o: rtgroup number */
987 	__u32 rg_length;	/* o: length in blocks */
988 	__u32 rg_sick;		/* o: sick things in ag */
989 	__u32 rg_checked;	/* o: checked metadata in ag */
990 	__u32 rg_flags;		/* i/o: flags for this ag */
991 	__u32 rg_reserved[27];	/* o: zero */
992 };
993 #define XFS_RTGROUP_GEOM_SICK_SUPER	(1U << 0)  /* superblock */
994 #define XFS_RTGROUP_GEOM_SICK_BITMAP	(1U << 1)  /* rtbitmap */
995 #define XFS_RTGROUP_GEOM_SICK_SUMMARY	(1U << 2)  /* rtsummary */
996 
997 /*
998  * ioctl commands that are used by Linux filesystems
999  */
1000 #define XFS_IOC_GETXFLAGS	FS_IOC_GETFLAGS
1001 #define XFS_IOC_SETXFLAGS	FS_IOC_SETFLAGS
1002 #define XFS_IOC_GETVERSION	FS_IOC_GETVERSION
1003 
1004 /*
1005  * ioctl commands that replace IRIX fcntl()'s
1006  * For 'documentation' purposed more than anything else,
1007  * the "cmd #" field reflects the IRIX fcntl number.
1008  */
1009 /*	XFS_IOC_ALLOCSP ------- deprecated 10	 */
1010 /*	XFS_IOC_FREESP -------- deprecated 11	 */
1011 #define XFS_IOC_DIOINFO		_IOR ('X', 30, struct dioattr)
1012 #define XFS_IOC_FSGETXATTR	FS_IOC_FSGETXATTR
1013 #define XFS_IOC_FSSETXATTR	FS_IOC_FSSETXATTR
1014 /*	XFS_IOC_ALLOCSP64 ----- deprecated 36	 */
1015 /*	XFS_IOC_FREESP64 ------ deprecated 37	 */
1016 #define XFS_IOC_GETBMAP		_IOWR('X', 38, struct getbmap)
1017 /*      XFS_IOC_FSSETDM ------- deprecated 39    */
1018 #define XFS_IOC_RESVSP		_IOW ('X', 40, struct xfs_flock64)
1019 #define XFS_IOC_UNRESVSP	_IOW ('X', 41, struct xfs_flock64)
1020 #define XFS_IOC_RESVSP64	_IOW ('X', 42, struct xfs_flock64)
1021 #define XFS_IOC_UNRESVSP64	_IOW ('X', 43, struct xfs_flock64)
1022 #define XFS_IOC_GETBMAPA	_IOWR('X', 44, struct getbmap)
1023 #define XFS_IOC_FSGETXATTRA	_IOR ('X', 45, struct fsxattr)
1024 /*	XFS_IOC_SETBIOSIZE ---- deprecated 46	   */
1025 /*	XFS_IOC_GETBIOSIZE ---- deprecated 47	   */
1026 #define XFS_IOC_GETBMAPX	_IOWR('X', 56, struct getbmap)
1027 #define XFS_IOC_ZERO_RANGE	_IOW ('X', 57, struct xfs_flock64)
1028 #define XFS_IOC_FREE_EOFBLOCKS	_IOR ('X', 58, struct xfs_fs_eofblocks)
1029 /*	XFS_IOC_GETFSMAP ------ hoisted 59         */
1030 #define XFS_IOC_SCRUB_METADATA	_IOWR('X', 60, struct xfs_scrub_metadata)
1031 #define XFS_IOC_AG_GEOMETRY	_IOWR('X', 61, struct xfs_ag_geometry)
1032 #define XFS_IOC_GETPARENTS	_IOWR('X', 62, struct xfs_getparents)
1033 #define XFS_IOC_GETPARENTS_BY_HANDLE _IOWR('X', 63, struct xfs_getparents_by_handle)
1034 #define XFS_IOC_SCRUBV_METADATA	_IOWR('X', 64, struct xfs_scrub_vec_head)
1035 #define XFS_IOC_RTGROUP_GEOMETRY _IOWR('X', 65, struct xfs_rtgroup_geometry)
1036 
1037 /*
1038  * ioctl commands that replace IRIX syssgi()'s
1039  */
1040 #define XFS_IOC_FSGEOMETRY_V1	     _IOR ('X', 100, struct xfs_fsop_geom_v1)
1041 #define XFS_IOC_FSBULKSTAT	     _IOWR('X', 101, struct xfs_fsop_bulkreq)
1042 #define XFS_IOC_FSBULKSTAT_SINGLE    _IOWR('X', 102, struct xfs_fsop_bulkreq)
1043 #define XFS_IOC_FSINUMBERS	     _IOWR('X', 103, struct xfs_fsop_bulkreq)
1044 #define XFS_IOC_PATH_TO_FSHANDLE     _IOWR('X', 104, struct xfs_fsop_handlereq)
1045 #define XFS_IOC_PATH_TO_HANDLE	     _IOWR('X', 105, struct xfs_fsop_handlereq)
1046 #define XFS_IOC_FD_TO_HANDLE	     _IOWR('X', 106, struct xfs_fsop_handlereq)
1047 #define XFS_IOC_OPEN_BY_HANDLE	     _IOWR('X', 107, struct xfs_fsop_handlereq)
1048 #define XFS_IOC_READLINK_BY_HANDLE   _IOWR('X', 108, struct xfs_fsop_handlereq)
1049 #define XFS_IOC_SWAPEXT		     _IOWR('X', 109, struct xfs_swapext)
1050 #define XFS_IOC_FSGROWFSDATA	     _IOW ('X', 110, struct xfs_growfs_data)
1051 #define XFS_IOC_FSGROWFSLOG	     _IOW ('X', 111, struct xfs_growfs_log)
1052 #define XFS_IOC_FSGROWFSRT	     _IOW ('X', 112, struct xfs_growfs_rt)
1053 #define XFS_IOC_FSCOUNTS	     _IOR ('X', 113, struct xfs_fsop_counts)
1054 #define XFS_IOC_SET_RESBLKS	     _IOWR('X', 114, struct xfs_fsop_resblks)
1055 #define XFS_IOC_GET_RESBLKS	     _IOR ('X', 115, struct xfs_fsop_resblks)
1056 #define XFS_IOC_ERROR_INJECTION	     _IOW ('X', 116, struct xfs_error_injection)
1057 #define XFS_IOC_ERROR_CLEARALL	     _IOW ('X', 117, struct xfs_error_injection)
1058 /*	XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118	 */
1059 
1060 #define XFS_IOC_FREEZE		     _IOWR('X', 119, int)	/* aka FIFREEZE */
1061 #define XFS_IOC_THAW		     _IOWR('X', 120, int)	/* aka FITHAW */
1062 
1063 /*      XFS_IOC_FSSETDM_BY_HANDLE -- deprecated 121      */
1064 #define XFS_IOC_ATTRLIST_BY_HANDLE   _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
1065 #define XFS_IOC_ATTRMULTI_BY_HANDLE  _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
1066 #define XFS_IOC_FSGEOMETRY_V4	     _IOR ('X', 124, struct xfs_fsop_geom_v4)
1067 #define XFS_IOC_GOINGDOWN	     _IOR ('X', 125, uint32_t)
1068 #define XFS_IOC_FSGEOMETRY	     _IOR ('X', 126, struct xfs_fsop_geom)
1069 #define XFS_IOC_BULKSTAT	     _IOR ('X', 127, struct xfs_bulkstat_req)
1070 #define XFS_IOC_INUMBERS	     _IOR ('X', 128, struct xfs_inumbers_req)
1071 #define XFS_IOC_EXCHANGE_RANGE	     _IOW ('X', 129, struct xfs_exchange_range)
1072 #define XFS_IOC_START_COMMIT	     _IOR ('X', 130, struct xfs_commit_range)
1073 #define XFS_IOC_COMMIT_RANGE	     _IOW ('X', 131, struct xfs_commit_range)
1074 /*	XFS_IOC_GETFSUUID ---------- deprecated 140	 */
1075 
1076 
1077 #ifndef HAVE_BBMACROS
1078 /*
1079  * Block I/O parameterization.	A basic block (BB) is the lowest size of
1080  * filesystem allocation, and must equal 512.  Length units given to bio
1081  * routines are in BB's.
1082  */
1083 #define BBSHIFT		9
1084 #define BBSIZE		(1<<BBSHIFT)
1085 #define BBMASK		(BBSIZE-1)
1086 #define BTOBB(bytes)	(((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
1087 #define BTOBBT(bytes)	((__u64)(bytes) >> BBSHIFT)
1088 #define BBTOB(bbs)	((bbs) << BBSHIFT)
1089 #endif
1090 
1091 #endif	/* __XFS_FS_H__ */
1092