src/zfs_arc.c

   1 /**
   2  * collectd - src/zfs_arc.c
   3  * Copyright (C) 2009  Anthony Dewhurst
   4  * Copyright (C) 2012  Aurelien Rougemont
   5  * Copyright (C) 2013  Xin Li
   6  * Copyright (C) 2014  Marc Fournier
   7  * Copyright (C) 2014  Wilfried Goesgens
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; only version 2 of the License is applicable.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  *
  22  * Authors:
  23  *   Anthony Dewhurst <dewhurst at gmail>
  24  *   Aurelien Rougemont <beorn at gandi.net>
  25  *   Xin Li <delphij at FreeBSD.org>
  26  *   Marc Fournier <marc.fournier at camptocamp.com>
  27  *   Wilfried Goesgens <dothebart at citadel.org>
  28  **/
  29
  30 #include "collectd.h"
  31
  32 #include "common.h"
  33 #include "plugin.h"
  34
  35 /*
  36  * Global variables
  37  */
  38
  39 #if defined(KERNEL_LINUX)
  40 #include "utils_llist.h"
  41 #define ZOL_ARCSTATS_FILE "/proc/spl/kstat/zfs/arcstats"
  42
  43 typedef llist_t kstat_t;
  44
  45 static int put_zfs_value (kstat_t *ksp, char const *k, value_t v)
  46 {
  47         llentry_t *e;
  48         char *k_copy;
  49         value_t *v_copy;
  50
  51         k_copy = strdup (k);
  52         if (k_copy == NULL)
  53                 return ENOMEM;
  54
  55         v_copy = malloc (sizeof (*v_copy));
  56         if (v_copy == NULL)
  57         {
  58                 sfree (k_copy);
  59                 return ENOMEM;
  60         }
  61         *v_copy = v;
  62
  63         e = llentry_create (k_copy, v_copy);
  64         if (e == NULL)
  65         {
  66                 sfree (v_copy);
  67                 sfree (k_copy);
  68                 return ENOMEM;
  69         }
  70
  71         llist_append (ksp, e);
  72         return 0;
  73 }
  74
  75 static long long get_zfs_value(kstat_t *ksp, const char *key)
  76 {
  77         llentry_t *e;
  78         value_t *v;
  79
  80         e = llist_search (ksp, key);
  81         if (e == NULL)
  82         {
  83                 ERROR ("zfs_arc plugin: `llist_search` failed for key: '%s'.", key);
  84                 return (-1);
  85         }
  86
  87         v = e->value;
  88         return ((long long) v->derive);
  89 }
  90
  91 static void free_zfs_values (kstat_t *ksp)
  92 {
  93         if (ksp == NULL)
  94                 return;
  95
  96         for (llentry_t *e = llist_head (ksp); e != NULL; e = e->next)
  97         {
  98                 sfree (e->key);
  99                 sfree (e->value);
 100         }
 101
 102         llist_destroy (ksp);
 103 }
 104
 105 #elif defined(KERNEL_SOLARIS)
 106 extern kstat_ctl_t *kc;
 107
 108 static long long get_zfs_value(kstat_t *ksp, char *name)
 109 {
 110
 111         return (get_kstat_value(ksp, name));
 112 }
 113 #elif defined(KERNEL_FREEBSD)
 114 #include <sys/types.h>
 115 #include <sys/sysctl.h>
 116
 117 const char zfs_arcstat[] = "kstat.zfs.misc.arcstats.";
 118
 119 #if !defined(kstat_t)
 120 typedef void kstat_t;
 121 #endif
 122
 123 static long long get_zfs_value(kstat_t *dummy __attribute__((unused)),
 124                 char const *name)
 125 {
 126         char buffer[256];
 127         long long value;
 128         size_t valuelen = sizeof(value);
 129         int rv;
 130
 131         ssnprintf (buffer, sizeof (buffer), "%s%s", zfs_arcstat, name);
 132         rv = sysctlbyname (buffer, (void *) &value, &valuelen,
 133                         /* new value = */ NULL, /* new length = */ (size_t) 0);
 134         if (rv == 0)
 135                 return (value);
 136
 137         return (-1);
 138 }
 139 #endif
 140
 141 static void za_submit (const char* type, const char* type_instance, value_t* values, size_t values_len)
 142 {
 143         value_list_t vl = VALUE_LIST_INIT;
 144
 145         vl.values = values;
 146         vl.values_len = values_len;
 147
 148         sstrncpy (vl.plugin, "zfs_arc", sizeof (vl.plugin));
 149         sstrncpy (vl.type, type, sizeof (vl.type));
 150         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 151
 152         plugin_dispatch_values (&vl);
 153 }
 154
 155 static void za_submit_gauge (const char* type, const char* type_instance, gauge_t value)
 156 {
 157         za_submit (type, type_instance, &(value_t) { .gauge = value }, 1);
 158 }
 159
 160 static int za_read_derive (kstat_t *ksp, const char *kstat_value,
 161     const char *type, const char *type_instance)
 162 {
 163   long long tmp = get_zfs_value (ksp, (char *)kstat_value);
 164   if (tmp == -1LL)
 165   {
 166     WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
 167     return (-1);
 168   }
 169
 170   za_submit (type, type_instance, &(value_t) { .derive = (derive_t) tmp }, /* values_num = */ 1);
 171   return (0);
 172 }
 173
 174 static int za_read_gauge (kstat_t *ksp, const char *kstat_value,
 175     const char *type, const char *type_instance)
 176 {
 177   long long tmp = get_zfs_value (ksp, (char *)kstat_value);
 178   if (tmp == -1LL)
 179   {
 180     WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
 181     return (-1);
 182   }
 183
 184   za_submit (type, type_instance, &(value_t) { .gauge = (gauge_t) tmp }, /* values_num = */ 1);
 185   return (0);
 186 }
 187
 188 static void za_submit_ratio (const char* type_instance, gauge_t hits, gauge_t misses)
 189 {
 190         gauge_t ratio = NAN;
 191
 192         if (!isfinite (hits) || (hits < 0.0))
 193                 hits = 0.0;
 194         if (!isfinite (misses) || (misses < 0.0))
 195                 misses = 0.0;
 196
 197         if ((hits != 0.0) || (misses != 0.0))
 198                 ratio = hits / (hits + misses);
 199
 200         za_submit_gauge ("cache_ratio", type_instance, ratio);
 201 }
 202
 203 static int za_read (void)
 204 {
 205         gauge_t  arc_hits, arc_misses, l2_hits, l2_misses;
 206         kstat_t  *ksp   = NULL;
 207
 208 #if defined(KERNEL_LINUX)
 209         FILE *fh;
 210         char buffer[1024];
 211
 212         fh = fopen (ZOL_ARCSTATS_FILE, "r");
 213         if (fh == NULL)
 214         {
 215                 char errbuf[1024];
 216                 ERROR ("zfs_arc plugin: Opening \"%s\" failed: %s", ZOL_ARCSTATS_FILE,
 217                        sstrerror (errno, errbuf, sizeof (errbuf)));
 218                 return (-1);
 219         }
 220
 221         ksp = llist_create ();
 222         if (ksp == NULL)
 223         {
 224                 ERROR ("zfs_arc plugin: `llist_create' failed.");
 225                 fclose (fh);
 226                 return (-1);
 227         }
 228
 229         while (fgets (buffer, sizeof (buffer), fh) != NULL)
 230         {
 231                 char *fields[3];
 232                 value_t v;
 233                 int status;
 234
 235                 status = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
 236                 if (status != 3)
 237                         continue;
 238
 239                 status = parse_value (fields[2], &v, DS_TYPE_DERIVE);
 240                 if (status != 0)
 241                         continue;
 242
 243                 put_zfs_value (ksp, fields[0], v);
 244         }
 245
 246         fclose (fh);
 247
 248 #elif defined(KERNEL_SOLARIS)
 249         get_kstat (&ksp, "zfs", 0, "arcstats");
 250         if (ksp == NULL)
 251         {
 252                 ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
 253                 return (-1);
 254         }
 255 #endif
 256
 257         /* Sizes */
 258         za_read_gauge (ksp, "anon_size",      "cache_size", "anon_size");
 259         za_read_gauge (ksp, "c",              "cache_size", "c");
 260         za_read_gauge (ksp, "c_max",          "cache_size", "c_max");
 261         za_read_gauge (ksp, "c_min",          "cache_size", "c_min");
 262         za_read_gauge (ksp, "hdr_size",       "cache_size", "hdr_size");
 263         za_read_gauge (ksp, "metadata_size",  "cache_size", "metadata_size");
 264         za_read_gauge (ksp, "mfu_ghost_size", "cache_size", "mfu_ghost_size");
 265         za_read_gauge (ksp, "mfu_size",       "cache_size", "mfu_size");
 266         za_read_gauge (ksp, "mru_ghost_size", "cache_size", "mru_ghost_size");
 267         za_read_gauge (ksp, "mru_size",       "cache_size", "mru_size");
 268         za_read_gauge (ksp, "other_size",     "cache_size", "other_size");
 269         za_read_gauge (ksp, "p",              "cache_size", "p");
 270         za_read_gauge (ksp, "size",           "cache_size", "arc");
 271
 272         /* The "l2_size" value has disappeared from Solaris some time in
 273          * early 2013, and has only reappeared recently in Solaris 11.2.
 274          * Stop trying if we ever fail to read it, so we don't spam the log.
 275          */
 276         static int l2_size_avail = 1;
 277         if (l2_size_avail && za_read_gauge (ksp, "l2_size", "cache_size", "L2") != 0)
 278                 l2_size_avail = 0;
 279
 280         /* Operations */
 281         za_read_derive (ksp, "deleted",  "cache_operation", "deleted");
 282 #if defined(KERNEL_FREEBSD)
 283         za_read_derive (ksp, "allocated","cache_operation", "allocated");
 284 #endif
 285
 286         /* Issue indicators */
 287         za_read_derive (ksp, "mutex_miss", "mutex_operations", "miss");
 288         za_read_derive (ksp, "hash_collisions", "hash_collisions", "");
 289         za_read_derive (ksp, "memory_throttle_count", "memory_throttle_count", "");
 290
 291         /* Evictions */
 292         za_read_derive (ksp, "evict_l2_cached",     "cache_eviction", "cached");
 293         za_read_derive (ksp, "evict_l2_eligible",   "cache_eviction", "eligible");
 294         za_read_derive (ksp, "evict_l2_ineligible", "cache_eviction", "ineligible");
 295
 296         /* Hits / misses */
 297         za_read_derive (ksp, "demand_data_hits",         "cache_result", "demand_data-hit");
 298         za_read_derive (ksp, "demand_metadata_hits",     "cache_result", "demand_metadata-hit");
 299         za_read_derive (ksp, "prefetch_data_hits",       "cache_result", "prefetch_data-hit");
 300         za_read_derive (ksp, "prefetch_metadata_hits",   "cache_result", "prefetch_metadata-hit");
 301         za_read_derive (ksp, "demand_data_misses",       "cache_result", "demand_data-miss");
 302         za_read_derive (ksp, "demand_metadata_misses",   "cache_result", "demand_metadata-miss");
 303         za_read_derive (ksp, "prefetch_data_misses",     "cache_result", "prefetch_data-miss");
 304         za_read_derive (ksp, "prefetch_metadata_misses", "cache_result", "prefetch_metadata-miss");
 305         za_read_derive (ksp, "mfu_hits",                 "cache_result", "mfu-hit");
 306         za_read_derive (ksp, "mfu_ghost_hits",           "cache_result", "mfu_ghost-hit");
 307         za_read_derive (ksp, "mru_hits",                 "cache_result", "mru-hit");
 308         za_read_derive (ksp, "mru_ghost_hits",           "cache_result", "mru_ghost-hit");
 309         za_read_derive (ksp, "prefetch_metadata_misses", "cache_result", "prefetch_metadata-miss");
 310
 311         /* Ratios */
 312         arc_hits   = (gauge_t) get_zfs_value(ksp, "hits");
 313         arc_misses = (gauge_t) get_zfs_value(ksp, "misses");
 314         l2_hits    = (gauge_t) get_zfs_value(ksp, "l2_hits");
 315         l2_misses  = (gauge_t) get_zfs_value(ksp, "l2_misses");
 316
 317         za_submit_ratio ("arc", arc_hits, arc_misses);
 318         za_submit_ratio ("L2", l2_hits, l2_misses);
 319
 320         /* I/O */
 321         value_t  l2_io[] = {
 322                 { .derive = (derive_t) get_zfs_value(ksp, "l2_read_bytes") },
 323                 { .derive = (derive_t) get_zfs_value(ksp, "l2_write_bytes") },
 324         };
 325         za_submit ("io_octets", "L2", l2_io, STATIC_ARRAY_SIZE (l2_io));
 326
 327 #if defined(KERNEL_LINUX)
 328         free_zfs_values (ksp);
 329 #endif
 330
 331         return (0);
 332 } /* int za_read */
 333
 334 static int za_init (void) /* {{{ */
 335 {
 336 #if defined(KERNEL_SOLARIS)
 337         /* kstats chain already opened by update_kstat (using *kc), verify everything went fine. */
 338         if (kc == NULL)
 339         {
 340                 ERROR ("zfs_arc plugin: kstat chain control structure not available.");
 341                 return (-1);
 342         }
 343 #endif
 344
 345         return (0);
 346 } /* }}} int za_init */
 347
 348 void module_register (void)
 349 {
 350         plugin_register_init ("zfs_arc", za_init);
 351         plugin_register_read ("zfs_arc", za_read);
 352 } /* void module_register */
 353
 354 /* vmi: set sw=8 noexpandtab fdm=marker : */