VFS_STATFS(9)

💅 VFS_STATFS(9) — it's giving kernel developer's manual ✨

okay so bestie, welcome to VFS_STATFS(9), section 9 of the Kernel Developer's Manual. this is the page where we spill the tea on how the kernel peeks at a file system and reports back everything it knows. no cap. 🫶

🌸 NAME 🌸

VFS_STATFS — return file system status 💖

✨ SYNOPSIS ✨

#include <sys/param.h>
#include <sys/mount.h>
#include <sys/vnode.h>

int
VFS_STATFS(struct mount *mp, struct statfs *sbp);

🎀 DESCRIPTION 🎀

The VFS_STATFS() macro returns various pieces of information about the file system, including recommended I/O sizes, free space, free inodes, etc. like it's literally the receipts of your filesystem, periodt. 💅

The arguments it expects are:

• mp — The file system. (the main character we're asking about 👑)
• sbp — A statfs structure, as defined by <sys/mount.h>, into which information is placed about the file system. (this is where the answers get dropped off 🎀)

The fields of struct statfs related to the file system are as follows:

• f_type — Type of file system.
• f_flags — A copy of mount exported flags.
• f_bsize — Fragment size.
• f_iosize — Optimal transfer block size.
• f_blocks — The total number of data blocks in the file system.
• f_bfree — The number of free blocks in the file system.
• f_bavail — The number of free blocks available to non-superuser processes.
• f_files — The total number of file nodes in the file system.
• f_ffree — The number of free nodes available to non-superuser processes.
• f_syncwrites — The number of synchronous writes since the file system was mounted.
• f_asyncwrites — The number of asynchronous writes since the file system was mounted.
• f_syncreads — The number of synchronous reads since the file system was mounted.
• f_asyncreads — The number of asynchronous reads since the file system was mounted.
• f_namemax — The maximum file name length for this file system.
• f_owner — The user ID of the user that mounted the file system.
• f_fsid — Unique file system ID.
• f_fstypename — The file system type name; a string of at most MFSNAMELEN bytes.
• f_mntfromname — The device name the file system was mounted from; a string of at most MNAMELEN bytes.
• f_mntonname — The name of the directory on which the file system is mounted; a string of at most MNAMELEN bytes.

ngl the way that struct is just ✨full✨ of lore. every field is a little piece of the filesystem's autobiography fr fr. 🦋

🌈 SEE ALSO 🌈

• VFS(9)
• vnode(9)

👑 AUTHORS 👑

This manual page was written by Doug Rabson. iconic behaviour honestly, we stan a manpage author 💜

okay bestie that's the whole vibe check ✅ this Debian edition dropped on May 23, 2009 and it still eats, no crumbs. go forth and statfs responsibly. mwah 💖🎀✨