zfs_arc: derive hit/miss stats for ratio calculations
[collectd.git] / 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   llentry_t *e;
47   char *k_copy;
48   value_t *v_copy;
49
50   k_copy = strdup(k);
51   if (k_copy == NULL)
52     return ENOMEM;
53
54   v_copy = malloc(sizeof(*v_copy));
55   if (v_copy == NULL) {
56     sfree(k_copy);
57     return ENOMEM;
58   }
59   *v_copy = v;
60
61   e = llentry_create(k_copy, v_copy);
62   if (e == NULL) {
63     sfree(v_copy);
64     sfree(k_copy);
65     return ENOMEM;
66   }
67
68   llist_append(ksp, e);
69   return 0;
70 }
71
72 static long long get_zfs_value(kstat_t *ksp, const char *key) {
73   llentry_t *e;
74   value_t *v;
75
76   e = llist_search(ksp, key);
77   if (e == NULL) {
78     return -1;
79   }
80
81   v = e->value;
82   return (long long)v->derive;
83 }
84
85 static void free_zfs_values(kstat_t *ksp) {
86   if (ksp == NULL)
87     return;
88
89   for (llentry_t *e = llist_head(ksp); e != NULL; e = e->next) {
90     sfree(e->key);
91     sfree(e->value);
92   }
93
94   llist_destroy(ksp);
95 }
96
97 #elif defined(KERNEL_SOLARIS)
98 extern kstat_ctl_t *kc;
99
100 static long long get_zfs_value(kstat_t *ksp, char *name) {
101
102   return get_kstat_value(ksp, name);
103 }
104 #elif defined(KERNEL_FREEBSD)
105 #include <sys/sysctl.h>
106 #include <sys/types.h>
107
108 const char zfs_arcstat[] = "kstat.zfs.misc.arcstats.";
109
110 #if !defined(kstat_t)
111 typedef void kstat_t;
112 #endif
113
114 static long long get_zfs_value(kstat_t *dummy __attribute__((unused)),
115                                char const *name) {
116   char buffer[256];
117   long long value;
118   size_t valuelen = sizeof(value);
119   int rv;
120
121   snprintf(buffer, sizeof(buffer), "%s%s", zfs_arcstat, name);
122   rv = sysctlbyname(buffer, (void *)&value, &valuelen,
123                     /* new value = */ NULL, /* new length = */ (size_t)0);
124   if (rv == 0)
125     return value;
126
127   return -1;
128 }
129 #endif
130
131 static void za_submit(const char *type, const char *type_instance,
132                       value_t *values, size_t values_len) {
133   value_list_t vl = VALUE_LIST_INIT;
134
135   vl.values = values;
136   vl.values_len = values_len;
137
138   sstrncpy(vl.plugin, "zfs_arc", sizeof(vl.plugin));
139   sstrncpy(vl.type, type, sizeof(vl.type));
140   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
141
142   plugin_dispatch_values(&vl);
143 }
144
145 static void za_submit_gauge(const char *type, const char *type_instance,
146                             gauge_t value) {
147   za_submit(type, type_instance, &(value_t){.gauge = value}, 1);
148 }
149
150 static int za_read_derive(kstat_t *ksp, const char *kstat_value,
151                           const char *type, const char *type_instance) {
152   long long tmp = get_zfs_value(ksp, (char *)kstat_value);
153   if (tmp == -1LL) {
154     DEBUG("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
155     return -1;
156   }
157
158   za_submit(type, type_instance, &(value_t){.derive = (derive_t)tmp},
159             /* values_num = */ 1);
160   return 0;
161 }
162
163 static int za_read_gauge(kstat_t *ksp, const char *kstat_value,
164                          const char *type, const char *type_instance) {
165   long long tmp = get_zfs_value(ksp, (char *)kstat_value);
166   if (tmp == -1LL) {
167     DEBUG("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
168     return -1;
169   }
170
171   za_submit(type, type_instance, &(value_t){.gauge = (gauge_t)tmp},
172             /* values_num = */ 1);
173   return 0;
174 }
175
176 static void za_submit_ratio(const char *type_instance, gauge_t hits,
177                             gauge_t misses) {
178   gauge_t ratio = NAN;
179
180   if (!isfinite(hits) || (hits < 0.0))
181     hits = 0.0;
182   if (!isfinite(misses) || (misses < 0.0))
183     misses = 0.0;
184
185   if ((hits != 0.0) || (misses != 0.0))
186     ratio = hits / (hits + misses);
187
188   za_submit_gauge("cache_ratio", type_instance, ratio);
189 }
190
191 static value_to_rate_state_t arc_hits_state, arc_misses_state, l2_hits_state,
192     l2_misses_state;
193
194 static int za_read(void) {
195   gauge_t arc_hits, arc_misses, l2_hits, l2_misses;
196   kstat_t *ksp = NULL;
197
198 #if defined(KERNEL_LINUX)
199   FILE *fh;
200   char buffer[1024];
201
202   fh = fopen(ZOL_ARCSTATS_FILE, "r");
203   if (fh == NULL) {
204     char errbuf[1024];
205     ERROR("zfs_arc plugin: Opening \"%s\" failed: %s", ZOL_ARCSTATS_FILE,
206           sstrerror(errno, errbuf, sizeof(errbuf)));
207     return -1;
208   }
209
210   ksp = llist_create();
211   if (ksp == NULL) {
212     ERROR("zfs_arc plugin: `llist_create' failed.");
213     fclose(fh);
214     return -1;
215   }
216
217   // Ignore the first two lines because they contain information about
218   // the rest of the file.
219   // See kstat_seq_show_headers module/spl/spl-kstat.c of the spl kernel
220   // module.
221   if (fgets(buffer, sizeof(buffer), fh) == NULL) {
222     ERROR("zfs_arc plugin: \"%s\" does not contain a single line.",
223           ZOL_ARCSTATS_FILE);
224     fclose(fh);
225     return -1;
226   }
227   if (fgets(buffer, sizeof(buffer), fh) == NULL) {
228     ERROR("zfs_arc plugin: \"%s\" does not contain at least two lines.",
229           ZOL_ARCSTATS_FILE);
230     fclose(fh);
231     return -1;
232   }
233
234   while (fgets(buffer, sizeof(buffer), fh) != NULL) {
235     char *fields[3];
236     value_t v;
237     int status;
238
239     status = strsplit(buffer, fields, STATIC_ARRAY_SIZE(fields));
240     if (status != 3)
241       continue;
242
243     status = parse_value(fields[2], &v, DS_TYPE_DERIVE);
244     if (status != 0)
245       continue;
246
247     put_zfs_value(ksp, fields[0], v);
248   }
249
250   fclose(fh);
251
252 #elif defined(KERNEL_SOLARIS)
253   get_kstat(&ksp, "zfs", 0, "arcstats");
254   if (ksp == NULL) {
255     ERROR("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
256     return -1;
257   }
258 #endif
259
260   /* Sizes */
261   za_read_gauge(ksp, "anon_size", "cache_size", "anon_size");
262   za_read_gauge(ksp, "c", "cache_size", "c");
263   za_read_gauge(ksp, "c_max", "cache_size", "c_max");
264   za_read_gauge(ksp, "c_min", "cache_size", "c_min");
265   za_read_gauge(ksp, "hdr_size", "cache_size", "hdr_size");
266   za_read_gauge(ksp, "metadata_size", "cache_size", "metadata_size");
267   za_read_gauge(ksp, "mfu_ghost_size", "cache_size", "mfu_ghost_size");
268   za_read_gauge(ksp, "mfu_size", "cache_size", "mfu_size");
269   za_read_gauge(ksp, "mru_ghost_size", "cache_size", "mru_ghost_size");
270   za_read_gauge(ksp, "mru_size", "cache_size", "mru_size");
271   za_read_gauge(ksp, "other_size", "cache_size", "other_size");
272   za_read_gauge(ksp, "p", "cache_size", "p");
273   za_read_gauge(ksp, "size", "cache_size", "arc");
274
275   /* The "l2_size" value has disappeared from Solaris some time in
276    * early 2013, and has only reappeared recently in Solaris 11.2.
277    * Stop trying if we ever fail to read it, so we don't spam the log.
278    */
279   static int l2_size_avail = 1;
280   if (l2_size_avail && za_read_gauge(ksp, "l2_size", "cache_size", "L2") != 0)
281     l2_size_avail = 0;
282
283   /* Operations */
284   za_read_derive(ksp, "deleted", "cache_operation", "deleted");
285 #if defined(KERNEL_FREEBSD)
286   za_read_derive(ksp, "allocated", "cache_operation", "allocated");
287 #endif
288
289   /* Issue indicators */
290   za_read_derive(ksp, "mutex_miss", "mutex_operations", "miss");
291   za_read_derive(ksp, "hash_collisions", "hash_collisions", "");
292   za_read_derive(ksp, "memory_throttle_count", "memory_throttle_count", "");
293
294   /* Evictions */
295   za_read_derive(ksp, "evict_l2_cached", "cache_eviction", "cached");
296   za_read_derive(ksp, "evict_l2_eligible", "cache_eviction", "eligible");
297   za_read_derive(ksp, "evict_l2_ineligible", "cache_eviction", "ineligible");
298
299   /* Hits / misses */
300   za_read_derive(ksp, "demand_data_hits", "cache_result", "demand_data-hit");
301   za_read_derive(ksp, "demand_metadata_hits", "cache_result",
302                  "demand_metadata-hit");
303   za_read_derive(ksp, "prefetch_data_hits", "cache_result",
304                  "prefetch_data-hit");
305   za_read_derive(ksp, "prefetch_metadata_hits", "cache_result",
306                  "prefetch_metadata-hit");
307   za_read_derive(ksp, "demand_data_misses", "cache_result", "demand_data-miss");
308   za_read_derive(ksp, "demand_metadata_misses", "cache_result",
309                  "demand_metadata-miss");
310   za_read_derive(ksp, "prefetch_data_misses", "cache_result",
311                  "prefetch_data-miss");
312   za_read_derive(ksp, "prefetch_metadata_misses", "cache_result",
313                  "prefetch_metadata-miss");
314   za_read_derive(ksp, "mfu_hits", "cache_result", "mfu-hit");
315   za_read_derive(ksp, "mfu_ghost_hits", "cache_result", "mfu_ghost-hit");
316   za_read_derive(ksp, "mru_hits", "cache_result", "mru-hit");
317   za_read_derive(ksp, "mru_ghost_hits", "cache_result", "mru_ghost-hit");
318
319   cdtime_t now = cdtime();
320
321   /* Ratios */
322   if ((value_to_rate(&arc_hits, (value_t){.derive = get_zfs_value(ksp, "hits")},
323                      DS_TYPE_DERIVE, now, &arc_hits_state) == 0) &&
324       (value_to_rate(&arc_misses,
325                      (value_t){.derive = get_zfs_value(ksp, "misses")},
326                      DS_TYPE_DERIVE, now, &arc_misses_state) == 0)) {
327     za_submit_ratio("arc", arc_hits, arc_misses);
328   }
329
330   if ((value_to_rate(&l2_hits,
331                      (value_t){.derive = get_zfs_value(ksp, "l2_hits")},
332                      DS_TYPE_DERIVE, now, &l2_hits_state) == 0) &&
333       (value_to_rate(&l2_misses,
334                      (value_t){.derive = get_zfs_value(ksp, "l2_misses")},
335                      DS_TYPE_DERIVE, now, &l2_misses_state) == 0)) {
336     za_submit_ratio("L2", l2_hits, l2_misses);
337   }
338
339   /* I/O */
340   value_t l2_io[] = {
341       {.derive = (derive_t)get_zfs_value(ksp, "l2_read_bytes")},
342       {.derive = (derive_t)get_zfs_value(ksp, "l2_write_bytes")},
343   };
344   za_submit("io_octets", "L2", l2_io, STATIC_ARRAY_SIZE(l2_io));
345
346 #if defined(KERNEL_LINUX)
347   free_zfs_values(ksp);
348 #endif
349
350   return 0;
351 } /* int za_read */
352
353 static int za_init(void) /* {{{ */
354 {
355 #if defined(KERNEL_SOLARIS)
356   /* kstats chain already opened by update_kstat (using *kc), verify everything
357    * went fine. */
358   if (kc == NULL) {
359     ERROR("zfs_arc plugin: kstat chain control structure not available.");
360     return -1;
361   }
362 #endif
363
364   memset(&arc_hits_state, 0, sizeof(arc_hits_state));
365   memset(&arc_misses_state, 0, sizeof(arc_misses_state));
366   memset(&l2_hits_state, 0, sizeof(l2_hits_state));
367   memset(&l2_misses_state, 0, sizeof(l2_misses_state));
368
369   return 0;
370 } /* }}} int za_init */
371
372 void module_register(void) {
373   plugin_register_init("zfs_arc", za_init);
374   plugin_register_read("zfs_arc", za_read);
375 } /* void module_register */
376
377 /* vmi: set sw=8 noexpandtab fdm=marker : */