libssh2_sftp_statvfs(3)

💖 libssh2_sftp_statvfs — get file system statistics 💖

okay so bestie, you know how statvfs(2) tells you all the juicy numbers about a file system? yeah. this is that, but over SFTP. it's part of the libssh2 manual, and it lives in <libssh2.h> and <libssh2_sftp.h> — two icons fr fr. let's get into it 💅

---

✨ SYNOPSIS ✨

#include <libssh2.h>
#include <libssh2_sftp.h>

int
libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, const char *path,
                     size_t path_len, LIBSSH2_SFTP_STATVFS *st);

int
libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle,
                      LIBSSH2_SFTP_STATVFS *st)

two functions, one vibe. libssh2_sftp_statvfs goes by path, libssh2_sftp_fstatvfs goes by handle. pick your fighter 🫶

---

🌸 DESCRIPTION 🌸

so these functions give you statvfs(2)-like operations, but — and this is the important part, no cap — they require statvfs@openssh.com and fstatvfs@openssh.com extension support on the server. if your server doesn't speak that language? nothing's happening. it's giving unsupported. 😭

here's who's who in the cast:

• sftp — the SFTP instance you got back from libssh2_sftp_init(3). your main character.
• handle — the SFTP File Handle you got back from libssh2_sftp_open_ex(3).
• path — full path of any file within the mounted file system. any file, bestie, you just need to be inside the fs.
• path_len — the length of that full path. yes you have to tell it. it's that kind of API.
• st — pointer to a LIBSSH2_SFTP_STATVFS structure where the file system statistics get placed. that's where the numbers go 🎀

---

🦋 DATA TYPES 🦋

LIBSSH2_SFTP_STATVFS is a typedefed struct, and here's exactly what it looks like:

struct _LIBSSH2_SFTP_STATVFS {
    libssh2_uint64_t  f_bsize;    /* file system block size */
    libssh2_uint64_t  f_frsize;   /* fragment size */
    libssh2_uint64_t  f_blocks;   /* size of fs in f_frsize units */
    libssh2_uint64_t  f_bfree;    /* # free blocks */
    libssh2_uint64_t  f_bavail;   /* # free blocks for non-root */
    libssh2_uint64_t  f_files;    /* # inodes */
    libssh2_uint64_t  f_ffree;    /* # free inodes */
    libssh2_uint64_t  f_favail;   /* # free inodes for non-root */
    libssh2_uint64_t  f_fsid;     /* file system ID */
    libssh2_uint64_t  f_flag;     /* mount flags */
    libssh2_uint64_t  f_namemax;  /* maximum filename length */
};

heads up bestie: it is unspecified whether all members of the returned struct have meaningful values on all file systems. so like... don't assume every field is loaded. some of them might be ghosting you. 💀

the field f_flag is a bit mask, and the bits are defined like this:

• LIBSSH2_SFTP_ST_RDONLY — Read-only file system. can't write, won't write, periodt.
• LIBSSH2_SFTP_ST_NOSUID — Set-user-ID/set-group-ID bits are ignored by exec(3). the bits are literally getting ignored, it's giving disrespect ngl.

---

⭐ RETURN VALUE ⭐

Returns 0 on success, or negative on failure. classic.

if you're using it in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. and yes, while LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se — it's just the function saying "not right now babe, come back later." don't panic. 🙈

---

🔥 ERRORS 🔥

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed. the malloc said no. 😭
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket.
• LIBSSH2_ERROR_SOCKET_TIMEOUT — (no description given, it just is what it is 💀)
• LIBSSH2_ERROR_SFTP_PROTOCOL — an invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. messy behavior all around.

---

👑 AVAILABILITY 👑

Added in libssh2 1.2.6. so if you're on something older than that... bestie. it's not there. it never was. upgrade era. ✨

---

🌈 SEE ALSO 🌈

• libssh2_sftp_open_ex(3)

---

and that's the whole page, no notes. this manual came from libssh2 and it's dated 22 May 2010 — yeah, it's an elder, but it still ate. go get those file system stats, you absolute legend 🫶💖✨