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
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.
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.
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
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>
38 static value_to_rate_state_t arc_hits_state;
39 static value_to_rate_state_t arc_misses_state;
40 static value_to_rate_state_t l2_hits_state;
41 static value_to_rate_state_t l2_misses_state;
43 #if defined(KERNEL_LINUX)
44 #include "utils_llist.h"
45 #define ZOL_ARCSTATS_FILE "/proc/spl/kstat/zfs/arcstats"
47 typedef llist_t kstat_t;
49 static int put_zfs_value(kstat_t *ksp, char const *k, value_t v) {
58 v_copy = malloc(sizeof(*v_copy));
65 e = llentry_create(k_copy, v_copy);
76 static long long get_zfs_value(kstat_t *ksp, const char *key) {
80 e = llist_search(ksp, key);
86 return (long long)v->derive;
89 static void free_zfs_values(kstat_t *ksp) {
93 for (llentry_t *e = llist_head(ksp); e != NULL; e = e->next) {
101 #elif defined(KERNEL_SOLARIS)
107 extern kstat_ctl_t *kc;
109 static long long get_zfs_value(kstat_t *ksp, char *name) {
111 return get_kstat_value(ksp, name);
113 #elif defined(KERNEL_FREEBSD)
114 #include <sys/sysctl.h>
115 #include <sys/types.h>
117 const char zfs_arcstat[] = "kstat.zfs.misc.arcstats.";
119 #if !defined(kstat_t)
120 typedef void kstat_t;
123 static long long get_zfs_value(kstat_t *dummy __attribute__((unused)),
127 size_t valuelen = sizeof(value);
130 snprintf(buffer, sizeof(buffer), "%s%s", zfs_arcstat, name);
131 rv = sysctlbyname(buffer, (void *)&value, &valuelen,
132 /* new value = */ NULL, /* new length = */ (size_t)0);
140 static void za_submit(const char *type, const char *type_instance,
141 value_t *values, size_t values_len) {
142 value_list_t vl = VALUE_LIST_INIT;
145 vl.values_len = values_len;
147 sstrncpy(vl.plugin, "zfs_arc", sizeof(vl.plugin));
148 sstrncpy(vl.type, type, sizeof(vl.type));
149 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
151 plugin_dispatch_values(&vl);
154 static void za_submit_gauge(const char *type, const char *type_instance,
156 za_submit(type, type_instance, &(value_t){.gauge = value}, 1);
159 static int za_read_derive(kstat_t *ksp, const char *kstat_value,
160 const char *type, const char *type_instance) {
161 long long tmp = get_zfs_value(ksp, (char *)kstat_value);
163 DEBUG("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
167 za_submit(type, type_instance, &(value_t){.derive = (derive_t)tmp},
168 /* values_num = */ 1);
172 static int za_read_gauge(kstat_t *ksp, const char *kstat_value,
173 const char *type, const char *type_instance) {
174 long long tmp = get_zfs_value(ksp, (char *)kstat_value);
176 DEBUG("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
180 za_submit(type, type_instance, &(value_t){.gauge = (gauge_t)tmp},
181 /* values_num = */ 1);
185 static void za_submit_ratio(const char *type_instance, gauge_t hits,
189 if (!isfinite(hits) || (hits < 0.0))
191 if (!isfinite(misses) || (misses < 0.0))
194 if ((hits != 0.0) || (misses != 0.0))
195 ratio = hits / (hits + misses);
197 za_submit_gauge("cache_ratio", type_instance, ratio);
200 static int za_read(void) {
201 gauge_t arc_hits, arc_misses, l2_hits, l2_misses;
204 #if defined(KERNEL_LINUX)
208 fh = fopen(ZOL_ARCSTATS_FILE, "r");
211 ERROR("zfs_arc plugin: Opening \"%s\" failed: %s", ZOL_ARCSTATS_FILE,
212 sstrerror(errno, errbuf, sizeof(errbuf)));
216 /* Ignore the first two lines because they contain information about the rest
218 * See kstat_seq_show_headers module/spl/spl-kstat.c of the spl kernel module.
220 if ((fgets(buffer, sizeof(buffer), fh) == NULL) ||
221 (fgets(buffer, sizeof(buffer), fh) == NULL)) {
222 ERROR("zfs_arc plugin: \"%s\" does not contain at least two lines.",
228 ksp = llist_create();
230 ERROR("zfs_arc plugin: `llist_create' failed.");
235 // Ignore the first two lines because they contain information about
236 // the rest of the file.
237 // See kstat_seq_show_headers module/spl/spl-kstat.c of the spl kernel
239 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
240 ERROR("zfs_arc plugin: \"%s\" does not contain a single line.",
245 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
246 ERROR("zfs_arc plugin: \"%s\" does not contain at least two lines.",
252 while (fgets(buffer, sizeof(buffer), fh) != NULL) {
257 status = strsplit(buffer, fields, STATIC_ARRAY_SIZE(fields));
261 status = parse_value(fields[2], &v, DS_TYPE_DERIVE);
265 put_zfs_value(ksp, fields[0], v);
270 #elif defined(KERNEL_SOLARIS)
271 get_kstat(&ksp, "zfs", 0, "arcstats");
273 ERROR("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
279 za_read_gauge(ksp, "anon_size", "cache_size", "anon_size");
280 za_read_gauge(ksp, "c", "cache_size", "c");
281 za_read_gauge(ksp, "c_max", "cache_size", "c_max");
282 za_read_gauge(ksp, "c_min", "cache_size", "c_min");
283 za_read_gauge(ksp, "hdr_size", "cache_size", "hdr_size");
284 za_read_gauge(ksp, "metadata_size", "cache_size", "metadata_size");
285 za_read_gauge(ksp, "mfu_ghost_size", "cache_size", "mfu_ghost_size");
286 za_read_gauge(ksp, "mfu_size", "cache_size", "mfu_size");
287 za_read_gauge(ksp, "mru_ghost_size", "cache_size", "mru_ghost_size");
288 za_read_gauge(ksp, "mru_size", "cache_size", "mru_size");
289 za_read_gauge(ksp, "other_size", "cache_size", "other_size");
290 za_read_gauge(ksp, "p", "cache_size", "p");
291 za_read_gauge(ksp, "size", "cache_size", "arc");
293 /* The "l2_size" value has disappeared from Solaris some time in
294 * early 2013, and has only reappeared recently in Solaris 11.2.
295 * Stop trying if we ever fail to read it, so we don't spam the log.
297 static int l2_size_avail = 1;
298 if (l2_size_avail && za_read_gauge(ksp, "l2_size", "cache_size", "L2") != 0)
302 za_read_derive(ksp, "deleted", "cache_operation", "deleted");
303 #if defined(KERNEL_FREEBSD)
304 za_read_derive(ksp, "allocated", "cache_operation", "allocated");
307 /* Issue indicators */
308 za_read_derive(ksp, "mutex_miss", "mutex_operations", "miss");
309 za_read_derive(ksp, "hash_collisions", "hash_collisions", "");
310 za_read_derive(ksp, "memory_throttle_count", "memory_throttle_count", "");
313 za_read_derive(ksp, "evict_l2_cached", "cache_eviction", "cached");
314 za_read_derive(ksp, "evict_l2_eligible", "cache_eviction", "eligible");
315 za_read_derive(ksp, "evict_l2_ineligible", "cache_eviction", "ineligible");
318 za_read_derive(ksp, "demand_data_hits", "cache_result", "demand_data-hit");
319 za_read_derive(ksp, "demand_metadata_hits", "cache_result",
320 "demand_metadata-hit");
321 za_read_derive(ksp, "prefetch_data_hits", "cache_result",
322 "prefetch_data-hit");
323 za_read_derive(ksp, "prefetch_metadata_hits", "cache_result",
324 "prefetch_metadata-hit");
325 za_read_derive(ksp, "demand_data_misses", "cache_result", "demand_data-miss");
326 za_read_derive(ksp, "demand_metadata_misses", "cache_result",
327 "demand_metadata-miss");
328 za_read_derive(ksp, "prefetch_data_misses", "cache_result",
329 "prefetch_data-miss");
330 za_read_derive(ksp, "prefetch_metadata_misses", "cache_result",
331 "prefetch_metadata-miss");
332 za_read_derive(ksp, "mfu_hits", "cache_result", "mfu-hit");
333 za_read_derive(ksp, "mfu_ghost_hits", "cache_result", "mfu_ghost-hit");
334 za_read_derive(ksp, "mru_hits", "cache_result", "mru-hit");
335 za_read_derive(ksp, "mru_ghost_hits", "cache_result", "mru_ghost-hit");
337 cdtime_t now = cdtime();
340 if ((value_to_rate(&arc_hits, (value_t){.derive = get_zfs_value(ksp, "hits")},
341 DS_TYPE_DERIVE, now, &arc_hits_state) == 0) &&
342 (value_to_rate(&arc_misses,
343 (value_t){.derive = get_zfs_value(ksp, "misses")},
344 DS_TYPE_DERIVE, now, &arc_misses_state) == 0)) {
345 za_submit_ratio("arc", arc_hits, arc_misses);
348 if ((value_to_rate(&l2_hits,
349 (value_t){.derive = get_zfs_value(ksp, "l2_hits")},
350 DS_TYPE_DERIVE, now, &l2_hits_state) == 0) &&
351 (value_to_rate(&l2_misses,
352 (value_t){.derive = get_zfs_value(ksp, "l2_misses")},
353 DS_TYPE_DERIVE, now, &l2_misses_state) == 0)) {
354 za_submit_ratio("L2", l2_hits, l2_misses);
359 {.derive = (derive_t)get_zfs_value(ksp, "l2_read_bytes")},
360 {.derive = (derive_t)get_zfs_value(ksp, "l2_write_bytes")},
362 za_submit("io_octets", "L2", l2_io, STATIC_ARRAY_SIZE(l2_io));
364 #if defined(KERNEL_LINUX)
365 free_zfs_values(ksp);
371 static int za_init(void) /* {{{ */
373 #if defined(KERNEL_SOLARIS)
374 /* kstats chain already opened by update_kstat (using *kc), verify everything
377 ERROR("zfs_arc plugin: kstat chain control structure not available.");
383 } /* }}} int za_init */
385 void module_register(void) {
386 plugin_register_init("zfs_arc", za_init);
387 plugin_register_read("zfs_arc", za_read);
388 } /* void module_register */
390 /* vmi: set sw=8 noexpandtab fdm=marker : */