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