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