Unix::S...fs_stats(3)

📦 version 0.112, in fedora 43

✨ Unix::S...fs_stats(3) ✨

okay bestie, pull up a chair 🫶 this is a User Contributed Perl Documentation page, and it's literally just the whole rundown on Unix::S...fs_stats(3). no cap, it's giving "container energy". let's go 💅

🌸 NAME 🌸

Unix::Statgrab::sg_fs_stats — a container for libstatgrab filesystem statistics. it's the lil box where all your fs numbers live 📦✨

🦋 DESCRIPTION 🦋

Unix::Statgrab::sg_fs_stats is a Perl package name that hands you accessors to the bundled libstatgrab sg_fs_stats filesystem statistics 💖

the docs for that live over at http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html — iykyk, go peek if you want the deep lore 👑

🎀 METHODS 🎀

nentries

returns the number of entries in the container. that's it, that's the whole vibe. count 'em 🔢

systime

returns the seconds since Epoch — which is 0:00:00 on January, 1st 1970, for the record — of the time measure the filesystem statistics. so it's the timestamp of when the stats were taken ⏰

as_list

Deprecated alias of fetchall_hash ⚠️ like, it still exists, but it's the old way. use fetchall_hash, bestie.

fetchall_hash

returns all records from the sg_fs_stats container as a list of hash, where each datum name is the key and the datum is the value 🗂️ (link: http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html)

fetchall_array

returns all records from the sg_fs_stats container as a list of arrays, with the values in this exact order 📋 (link: http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html):

(device_name fs_type mnt_point device_type size used free avail
 total_inodes used_inodes free_inodes avail_inodes
 io_size block_size
 total_blocks used_blocks free_blocks avail_blocks
 systime)

in that order, without leading headline. no header row, we're going straight in 💅

fetchall_table

returns all records from the sg_fs_stats container as a list of arrays, same order as above 📋 (link: http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html):

(device_name fs_type mnt_point device_type size used free avail
 total_inodes used_inodes free_inodes avail_inodes
 io_size block_size
 total_blocks used_blocks free_blocks avail_blocks
 systime)

in that order, including leading headline. so this one DOES come with the header, okay bestie, that's the difference ✨

fetchrow_arrayref($row = 0)

returns one row as an array, containing values as above. defaults to row 0 if you don't pass anything 🎯

fetchall_arrayref

returns all records from the sg_fs_stats container as an array of arrays, without header 🙈 (link: http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html)

fetchrow_hashref($row = 0)

returns one row as a hash containing { device_name => $self.device_name($row), fs_type => ... } 🍓 defaults to row 0.

fetchall_hashref

returns all records from the sg_fs_stats container as an array of hashes 💜 (link: http://www.i-scream.org/libstatgrab/docs/sg_get_fs_stats.3.html)

colnames

returns the list of column names, and here they are, all of them, in order:

(device_name fs_type mnt_point device_type size used free avail total_inodes used_inodes free_inodes avail_inodes io_size block_size total_blocks used_blocks free_blocks avail_blocks systime)

slay, that's the whole lineup 👑

and now for the accessors, the main characters themselves 🌈

  • device_name — Name of the device the filesystem statistics belong to
  • device_canonical — Canonical name of the device the filesystem statistics belong to
  • fs_type — Filesystem type (as string), e.g. zfs
  • mnt_point — Path name of mount point for the file system
  • device_type — Bitwise combination of sg_fs_regular sg_fs_special sg_fs_loopback sg_fs_remote, usually one of
  • size — Size of filesystem, in bytes
  • used — Used bytes of filesystem
  • free — Free bytes in filesystem
  • avail — Available bytes in filesystem (free - reserved)
  • total_inodes — Total number of inodes in filesystem
  • used_inodes — Used number of inodes in filesystem
  • free_inodes — Free number of inodes in filesystem
  • avail_inodes — Available inodes in filesystem (free - reserved)
  • io_size — Optimal size for I/O for this filesystem in bytes
  • block_size — Size of blocks in bytes
  • total_blocks — Total number of blocks in filesystem
  • used_blocks — Used number of blocks in filesystem
  • free_blocks — Free number of blocks in filesystem
  • avail_blocks — Available blocks in filesystem (free - reserved)

get_fs_stats_diff

gives you the difference between the last measurement and the recent one 🔥 so you can see what changed between then and now:

$recent->get_fs_stats_diff($last);

⭐ CONSTANTS ⭐

here's the whole squad of constants, no notes:

sg_fs_unknown sg_fs_regular sg_fs_special sg_fs_loopback sg_fs_remote
sg_fs_local sg_fs_alltypes

💜 AUTHOR 💜

Jens Rehsack, <rehsack AT cpan.org> — shoutout to the icon who wrote this 👑

Copyright (C) 2012-2018 by Jens Rehsack

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

fr fr, that's the actual license text, don't skip it 💖

and that's the whole page bestie, we ate and left no crumbs 💅✨ this was perl v5.42.0, dated 2025-07-25, and the page is Unix::S...fs_stats(3) — catch you on the next man page 🦋🎀

📦 where this page comes from