IOCTL-XFS-FSBULKSTAT(2)

💅 IOCTL-XFS-FSBULKSTAT — the XFS bulk inode stat tea ☕

okay bestie, welcome to ioctl_xfs_fsbulkstat, straight outta the System Calls Manual section, and no cap this one is giving vintage. It's an ioctl, it's XFS-only, and it wants to hand you stat info for a whole lil squad of inodes at once. Let's get into it. 🦋

---

✨ NAME ✨

ioctl_xfs_fsbulkstat — query information for a batch of XFS inodes 🫶

---

🌸 SYNOPSIS 🌸

#include <xfs/xfs_fs.h>

int ioctl(int fd, XFS_IOC_FSBULKSTAT, struct xfs_fsop_bulkreq *arg);
int ioctl(int fd, XFS_IOC_FSBULKSTAT_SINGLE, struct xfs_fsop_bulkreq
*arg);

two flavors, one vibe: one for a batch of inodes, one for a single inode. pick your fighter. ✨

---

💖 DESCRIPTION 💖

So basically: you're querying stat information for a group of XFS inodes. That's the whole assignment. 💅

NOTE: this ioctl has been superseded. please go read the ioctl_xfs_bulkstat(2) manpage for info about its replacement. like, it still works (presumably) but it's giving "we don't do that here anymore," iykyk. 🙈

These ioctls use struct xfs_fsop_bulkreq to set up a bulk transfer with the kernel:

struct xfs_fsop_bulkreq {
     __u64             *lastip;
     __s32             count;
     void              *ubuffer;
     __s32             *ocount;
};

lastip points to a value that will receive the number of the "last inode." This cannot be NULL. periodt.

• For FSBULKSTAT, this should be set to one less than the number of the first inode for which the caller wants information, or zero to start with the first inode in the filesystem.
• For FSBULKSTAT_SINGLE, this should be set to the number of the inode for which the caller wants information.

After the call, this value will be set to the number of the last inode for which information was supplied. 🎀

⚠️ This field will not be updated if ocount is NULL. noted bestie.

count is the number of elements in the ubuffer array and therefore the number of inodes for which to return stat information. This value must be set to 1 for FSBULKSTAT_SINGLE. one. uno. single. 🌸

ocount points to a value that will receive the number of records returned. If this value is NULL, then neither ocount nor lastip will be updated. (yes babe, they're a package deal 💀)

ubuffer points to a memory buffer into which inode stat information will be copied. This buffer must be an array of struct xfs_bstat which is described below. The array must have at least count elements.

struct xfs_bstat {
     __u64             bs_ino;
     __u16             bs_mode;
     __u16             bs_nlink;
     __u32             bs_uid;
     __u32             bs_gid;
     __u32             bs_rdev;
     __s32             bs_blksize;
     __s64             bs_size;
     struct xfs_bstime bs_atime;
     struct xfs_bstime bs_mtime;
     struct xfs_bstime bs_ctime;
     int64_t           bs_blocks;
     __u32             bs_xflags;
     __s32             bs_extsize;
     __s32             bs_extents;
     __u32             bs_gen;
     __u16             bs_projid_lo;
     __u16             bs_forkoff;
     __u16             bs_projid_hi;
     uint16_t          bs_sick;
     uint16_t          bs_checked;
     unsigned char     bs_pad[2];
     __u32             bs_cowextsize;
     __u32             bs_dmevmask;
     __u16             bs_dmstate;
     __u16             bs_aextents;
};

🧚 the structure members, one by one 🧚

• bs_ino is the inode number for this record.
• bs_mode is the file type and mode.
• bs_nlink is the number of hard links to this inode.
• bs_uid is the user id.
• bs_gid is the group id.
• bs_rdev is the encoded device id if this is a special file.
• bs_blksize is the size of a data block for this file, in units of bytes.
• bs_size is the size of the file, in bytes.
• bs_atime is the last time this file was accessed.
• bs_mtime is the last time the contents of this file were modified.
• bs_ctime is the last time this inode record was modified.
• bs_blocks is the number of filesystem blocks allocated to this file, including metadata.
• bs_xflags contains the extended flags that are set on this inode. These flags are the same values as those defined in the XFS INODE FLAGS section of the ioctl_xfs_fsgetxattr(2) manpage. (go look there, we're not re-typing them 💅)
• bs_extsize is the extent size hint for this file, in bytes.
• bs_extents is the number of storage mappings associated with this file's data.
• bs_gen is the generation number of the inode record.
• bs_projid_lo is the lower 16-bits of the project id.
• bs_forkoff is the offset of the attribute fork in the inode record, in bytes.
• bs_projid_hi is the upper 16-bits of the project id.
• bs_pad[6] is zeroed.
• bs_cowextsize is the Copy on Write extent size hint for this file, in bytes.
• bs_dmevmask is unused on Linux.
• bs_dmstate is unused on Linux.
• bs_aextents is the number of storage mappings associated with this file's extended attributes.

---

🌈 the health check section (vibe check for metadata) 🌈

The fields bs_sick and bs_checked indicate the relative health of various inode metadata. it's literally a doctor's appointment for your inodes, no cap:

• If a given sick flag is set in bs_sick, then that piece of metadata has been observed to be damaged. The same bit should be set in bs_checked. (double-confirmed, it's sick fr 😭)
• If a given sick flag is set in bs_checked but is not set in bs_sick, then that piece of metadata has been checked and is not faulty. she's healthy bestie 💖
• If a given sick flag is not set in bs_checked, then no conclusion can be made. we simply do not know. shrug.

⭐ the flags that apply to these fields ⭐

• XFS_BS_SICK_INODE — the inode's record itself.
• XFS_BS_SICK_BMBTD — file data extent mappings.
• XFS_BS_SICK_BMBTA — extended attribute extent mappings.
• XFS_BS_SICK_BMBTC — Copy on Write staging extent mappings.
• XFS_BS_SICK_DIR — directory information.
• XFS_BS_SICK_XATTR — extended attribute data.
• XFS_BS_SICK_SYMLINK — symbolic link target.
• XFS_BS_SICK_PARENT — parent pointers.
• XFS_BS_SICK_DIRTREE — directory is the source of corruption in the directory tree. 🚨

---

🔥 RETURN VALUE 🔥

On error, -1 is returned, and errno is set to indicate the error. classic. 👑

---

💀 ERRORS 💀

Error codes can be one of, but are not limited to, the following:

• EFAULT — the kernel was not able to copy into the userspace buffer. (rude of it tbh)
• EFSBADCRC — metadata checksum validation failed while performing the query.
• EFSCORRUPTED — metadata corruption was encountered while performing the query.
• EINVAL — one of the arguments was not valid. check ur args babe 🙈
• EIO — an I/O error was encountered while performing the query.
• ENOMEM — there was insufficient memory to perform the query.

---

🎀 CONFORMING TO 🎀

This API is specific to XFS filesystem on the Linux kernel. Linux girlies only. 🐧

---

🫶 SEE ALSO 🫶

• ioctl(2)
• ioctl_xfs_fsgetxattr(2)

---

and that's the whole page bestie!! this one's from XFS, dated 2019-06-17, living its life as IOCTL-XFS-FSBULKSTAT(2) in the System Calls Manual. superseded but still iconic, honestly. go forth and bulk-stat responsibly. slay. 💜✨🦋