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