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