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

source code of linux/fs/xfs/libxfs/xfs_fs.h