sys_statvfs.h(7POSIX)

📦 version 2017a, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 sys_statvfs.h 💖 — like, the whole VFS filesystem-info situation

okay bestie, welcome to sys_statvfs.h from the POSIX Programmer's Manual (yes, the POSIX one, the 7POSIX section, we love her). This is the header that tells you everything about how much room your filesystem has and how it's vibing. 🦋

🌸 PROLOG 🌸

okay so first things first, real talk: this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so like, go read the corresponding Linux manual page for the deets on Linux behavior), or honestly the interface may not even be implemented on Linux at all. Not me warning you upfront. 😭

✨ NAME ✨

sys/statvfs.h — VFS File System information structure. that's it, that's the whole name, iconic.

🎀 SYNOPSIS 🎀

#include <sys/statvfs.h>

periodt. that's the include, go off. 💅

👑 DESCRIPTION 👑

so the <sys/statvfs.h> header shall define the statvfs structure, and that structure shall include at least these members:

unsigned long f_bsize    File system block size.
unsigned long f_frsize   Fundamental file system block size.
fsblkcnt_t    f_blocks   Total number of blocks on file system in units of f_frsize.
fsblkcnt_t    f_bfree    Total number of free blocks.
fsblkcnt_t    f_bavail   Number of free blocks available to
                         non-privileged process.
fsfilcnt_t    f_files    Total number of file serial numbers.
fsfilcnt_t    f_ffree    Total number of free file serial numbers.
fsfilcnt_t    f_favail   Number of file serial numbers available to
                         non-privileged process.
unsigned long f_fsid     File system ID.
unsigned long f_flag     Bit mask of f_flag values.
unsigned long f_namemax  Maximum filename length.

like look at her. every single field. we stan a thorough struct. 🌟

and also!! the <sys/statvfs.h> header shall define the fsblkcnt_t and fsfilcnt_t types as described in <sys/types.h>. so if you're confused about those, that's a different page, bestie, go look it up. 🫶

next up, the <sys/statvfs.h> header shall define these symbolic constants for the f_flag member:

  • ST_RDONLY — read-only file system. it's giving "look but don't touch." 🙈
  • ST_NOSUID — does not support the semantics of the ST_ISUID and ST_ISGID file mode bits. like, those setuid/setgid vibes? not here, she said no. 💀

and then the following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided (so you actually get the signatures, no gatekeeping):

int fstatvfs(int, struct statvfs *);
int statvfs(const char *restrict, struct statvfs *restrict);

the restrict keywords are doing the most and honestly, good for them. ✨

heads up bestie: the following sections are informative. so like, they're the commentary track, not the main plot. 📝

🌈 APPLICATION USAGE 🌈

None.

(yeah. literally nothing. she said "no notes." 💅)

🧚 RATIONALE 🧚

None.

(nothing here either, the reasoning is a mystery, we respect her privacy. 🎀)

⭐ FUTURE DIRECTIONS ⭐

None.

(no planned glow-up, she's perfect as she is, periodt. 👑)

🦋 SEE ALSO 🦋

  • <sys_types.h>
  • The System Interfaces volume of POSIX.1‐2017, fstatvfs()

go read those if you want the full lore, iykyk. 📚

okay so legally speaking (and we gotta be respectful about this): portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group.

and in the event of any discrepancy between this version and the original IEEE and The Open Group Standard — the original IEEE and The Open Group Standard is the referee document. like, they're the main character here, we're just the group chat. 💯 The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

and that's the whole page, bestie!! 🫶✨ this absolute baddie of a manpage was brought to you by IEEE/The Open Group, 2017, filed under sys_statvfs.h(7POSIX). go check your disk space, mwah 💋🌸

📦 where this page comes from