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