webgui/emhttp/plugins/dynamix/scripts/ssd_trim

#!/usr/bin/php -q
<?PHP
/* Copyright 2005-2023, Lime Technology
 * Copyright 2012-2023, Bergware International.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2,
 * as published by the Free Software Foundation.
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */
?>
<?
$docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp');
require_once "$docroot/webGui/include/Wrappers.php";
extract(parse_plugin_cfg('dynamix',true));

// cron operation
if ($argc==2 && $argv[1]=='cron') {
  // trim btrfs, xfs
  xfs_btrfs_trim(false);
  // trim zfs
  zfs_trim(false);
  exit(0);
}

// add translations
$_SERVER['REQUEST_URI'] = 'settings';
$login_locale = _var($display,'locale');
require_once "$docroot/webGui/include/Translations.php";
require_once "$docroot/webGui/include/publish.php";

function write(...$messages){
  foreach ($messages as $message) {
    publish('plugins', $message,1,false);
  }
}

/*  Check if the disk is an HDD based on rotational flag */
function is_hdd($disk) {
    /* Ensure $disk is properly extracted */
    $disk = trim($disk);

    /* Extract the last part of the path */
    $disk = explode('/', $disk);
    $disk = preg_replace('/^(sd[a-z]+|nvme[0-9]+n1)p?1$/', '$1', end($disk));

    /* Validate the extracted disk name */
    if (strpos($disk, ' ') !== false || empty($disk)) {
        return false;
    }

    $file = "/sys/block/$disk/queue/rotational";
    $result = false;

    if (file_exists($file)) {
        $result = trim(file_get_contents($file)) == '1';
    }

    return $result;
}

function zfs_info($name) {
  $trim = preg_replace('/(.$)/',' $1',exec("zfs list -Ho used $name"))."iB";
  $bytes = exec("zfs list -Hpo used $name");
  exec("zpool list -vHP $name|grep -Po '^\s+\K/\S+'",$devs);
  foreach ($devs as &$dev) if (is_hdd($dev)) $dev = '';
  return "/mnt/$name: $trim ($bytes bytes) trimmed on ".implode(', ',array_filter($devs));
}

function zfs_trim($write) {
  if (!file_exists('/proc/spl/kstat/zfs/arcstats')) return;
  exec("zfs list -d0 -Ho name",$pools);
  foreach ($pools as $name) {
    if ($write) {
      write("/mnt/$name: ... <i class='fa fa-spin fa-circle-o-notch'></i>\r");
      if (exec("zpool trim -w $name 2>&1")=='') write(zfs_info($name)."\r","\n"); else write("\r");
    } else {
      if (exec("zpool trim -w $name 2>&1")=='') echo zfs_info($name)."\n";
    }
  }
}

/* Perform fstrim on XFS and Btrfs filesystems */
function xfs_btrfs_trim($write) {
  /* Use findmnt with JSON output and jq to ensure accurate parsing */
  exec("findmnt -lnt btrfs,xfs -J | jq -r '.filesystems[] | select(.source | test(\"^/dev/\")) | \"\\(.target)\\t\\(.source)\"'", $mounts);

  foreach ($mounts as $mount) {
    /* Split using tab as the delimiter */
    $parts = explode("\t", $mount, 2);

    /* Ensure we have both target and source */
    if (count($parts) < 2) continue;

    [$target, $source] = $parts;
    $target_escaped = escapeshellarg($target);

    /* Ensure $source is valid */
    if (empty($source)) continue;

    /* Resolve the actual device backing the mount */
    $device = trim(exec("findmnt -no SOURCE " . escapeshellarg($target)));

    /* Skip if we cannot resolve a device */
    if (empty($device)) continue;

    /* Check if the device is an HDD */
    if (is_hdd($device)) continue;

    if ($write) write("$target: ... <i class='fa fa-spin fa-circle-o-notch'></i>\r");

    $trim = exec("fstrim -v $target_escaped 2>/dev/null");

    /* Handle output based on mode (write or echo) */
    if ($write) {
      if ($trim) {
        write("$trim on $source\r", "\n");
      } else {
        write("\r");
      }
    } else {
      if ($trim) {
        echo("$trim on $source\n");
      }
    }
  }
}

write(_("TRIM operation started")."\n","\n","\n");
// trim btrfs, xfs
xfs_btrfs_trim(true);
// trim zfs
zfs_trim(true);
write(_("Finished")."\n",'_DONE_','');
?>