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