ac9b79d85e319dd84c8f6352e8553f956652678e
[collectd.git] / src / disk.c
1 /**
2  * collectd - src/disk.c
3  * Copyright (C) 2005-2012  Florian octo Forster
4  * Copyright (C) 2009       Manuel Sanmartin
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; only version 2 of the License is applicable.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Florian octo Forster <octo at collectd.org>
21  *   Manuel Sanmartin
22  **/
23
24 #include "collectd.h"
25
26 #include "plugin.h"
27 #include "utils/common/common.h"
28 #include "utils/ignorelist/ignorelist.h"
29
30 #if HAVE_MACH_MACH_TYPES_H
31 #include <mach/mach_types.h>
32 #endif
33 #if HAVE_MACH_MACH_INIT_H
34 #include <mach/mach_init.h>
35 #endif
36 #if HAVE_MACH_MACH_ERROR_H
37 #include <mach/mach_error.h>
38 #endif
39 #if HAVE_MACH_MACH_PORT_H
40 #include <mach/mach_port.h>
41 #endif
42 #if HAVE_COREFOUNDATION_COREFOUNDATION_H
43 #include <CoreFoundation/CoreFoundation.h>
44 #endif
45 #if HAVE_IOKIT_IOKITLIB_H
46 #include <IOKit/IOKitLib.h>
47 #endif
48 #if HAVE_IOKIT_IOTYPES_H
49 #include <IOKit/IOTypes.h>
50 #endif
51 #if HAVE_IOKIT_STORAGE_IOBLOCKSTORAGEDRIVER_H
52 #include <IOKit/storage/IOBlockStorageDriver.h>
53 #endif
54 #if HAVE_IOKIT_IOBSD_H
55 #include <IOKit/IOBSD.h>
56 #endif
57 #if KERNEL_FREEBSD
58 #include <devstat.h>
59 #include <libgeom.h>
60 #endif
61
62 #ifndef UINT_MAX
63 #define UINT_MAX 4294967295U
64 #endif
65
66 #if HAVE_STATGRAB_H
67 #include <statgrab.h>
68 #endif
69
70 #if HAVE_PERFSTAT
71 #ifndef _AIXVERSION_610
72 #include <sys/systemcfg.h>
73 #endif
74 #include <libperfstat.h>
75 #include <sys/protosw.h>
76 #endif
77
78 #if HAVE_IOKIT_IOKITLIB_H
79 static mach_port_t io_master_port = MACH_PORT_NULL;
80 /* This defaults to false for backwards compatibility. Please fix in the next
81  * major version. */
82 static bool use_bsd_name;
83 /* #endif HAVE_IOKIT_IOKITLIB_H */
84
85 #elif KERNEL_LINUX
86 typedef struct diskstats {
87   char *name;
88
89   /* This overflows in roughly 1361 years */
90   unsigned int poll_count;
91
92   derive_t read_sectors;
93   derive_t write_sectors;
94
95   derive_t read_bytes;
96   derive_t write_bytes;
97
98   derive_t read_ops;
99   derive_t write_ops;
100   derive_t read_time;
101   derive_t write_time;
102
103   derive_t avg_read_time;
104   derive_t avg_write_time;
105
106   bool has_merged;
107   bool has_in_progress;
108   bool has_io_time;
109
110   struct diskstats *next;
111 } diskstats_t;
112
113 static diskstats_t *disklist;
114 /* #endif KERNEL_LINUX */
115 #elif KERNEL_FREEBSD
116 static struct gmesh geom_tree;
117 /* #endif KERNEL_FREEBSD */
118
119 #elif HAVE_LIBKSTAT
120 #if HAVE_KSTAT_H
121 #include <kstat.h>
122 #endif
123 #define MAX_NUMDISK 1024
124 extern kstat_ctl_t *kc;
125 static kstat_t *ksp[MAX_NUMDISK];
126 static int numdisk;
127 /* #endif HAVE_LIBKSTAT */
128
129 #elif defined(HAVE_LIBSTATGRAB)
130 /* #endif HAVE_LIBSTATGRAB */
131
132 #elif HAVE_PERFSTAT
133 static perfstat_disk_t *stat_disk;
134 static int numdisk;
135 static int pnumdisk;
136 /* #endif HAVE_PERFSTAT */
137
138 #else
139 #error "No applicable input method."
140 #endif
141
142 #if HAVE_LIBUDEV_H
143 #include <libudev.h>
144
145 static char *conf_udev_name_attr;
146 static struct udev *handle_udev;
147 #endif
148
149 static const char *config_keys[] = {"Disk", "UseBSDName", "IgnoreSelected",
150                                     "UdevNameAttr"};
151 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
152
153 static ignorelist_t *ignorelist;
154
155 static int disk_config(const char *key, const char *value) {
156   if (ignorelist == NULL)
157     ignorelist = ignorelist_create(/* invert = */ 1);
158   if (ignorelist == NULL)
159     return 1;
160
161   if (strcasecmp("Disk", key) == 0) {
162     ignorelist_add(ignorelist, value);
163   } else if (strcasecmp("IgnoreSelected", key) == 0) {
164     int invert = 1;
165     if (IS_TRUE(value))
166       invert = 0;
167     ignorelist_set_invert(ignorelist, invert);
168   } else if (strcasecmp("UseBSDName", key) == 0) {
169 #if HAVE_IOKIT_IOKITLIB_H
170     use_bsd_name = IS_TRUE(value);
171 #else
172     WARNING("disk plugin: The \"UseBSDName\" option is only supported "
173             "on Mach / Mac OS X and will be ignored.");
174 #endif
175   } else if (strcasecmp("UdevNameAttr", key) == 0) {
176 #if HAVE_LIBUDEV_H
177     if (conf_udev_name_attr != NULL) {
178       free(conf_udev_name_attr);
179       conf_udev_name_attr = NULL;
180     }
181     if ((conf_udev_name_attr = strdup(value)) == NULL)
182       return 1;
183 #else
184     WARNING("disk plugin: The \"UdevNameAttr\" option is only supported "
185             "if collectd is built with libudev support");
186 #endif
187   } else {
188     return -1;
189   }
190
191   return 0;
192 } /* int disk_config */
193
194 static int disk_init(void) {
195 #if HAVE_IOKIT_IOKITLIB_H
196   kern_return_t status;
197
198   if (io_master_port != MACH_PORT_NULL) {
199     mach_port_deallocate(mach_task_self(), io_master_port);
200     io_master_port = MACH_PORT_NULL;
201   }
202
203   status = IOMasterPort(MACH_PORT_NULL, &io_master_port);
204   if (status != kIOReturnSuccess) {
205     ERROR("IOMasterPort failed: %s", mach_error_string(status));
206     io_master_port = MACH_PORT_NULL;
207     return -1;
208   }
209 /* #endif HAVE_IOKIT_IOKITLIB_H */
210
211 #elif KERNEL_LINUX
212 #if HAVE_LIBUDEV_H
213   if (conf_udev_name_attr != NULL) {
214     handle_udev = udev_new();
215     if (handle_udev == NULL) {
216       ERROR("disk plugin: udev_new() failed!");
217       return -1;
218     }
219   }
220 #endif /* HAVE_LIBUDEV_H */
221 /* #endif KERNEL_LINUX */
222
223 #elif KERNEL_FREEBSD
224   int rv;
225
226   rv = geom_gettree(&geom_tree);
227   if (rv != 0) {
228     ERROR("geom_gettree() failed, returned %d", rv);
229     return -1;
230   }
231   rv = geom_stats_open();
232   if (rv != 0) {
233     ERROR("geom_stats_open() failed, returned %d", rv);
234     return -1;
235   }
236 /* #endif KERNEL_FREEBSD */
237
238 #elif HAVE_LIBKSTAT
239   kstat_t *ksp_chain;
240
241   numdisk = 0;
242
243   if (kc == NULL)
244     return -1;
245
246   for (numdisk = 0, ksp_chain = kc->kc_chain;
247        (numdisk < MAX_NUMDISK) && (ksp_chain != NULL);
248        ksp_chain = ksp_chain->ks_next) {
249     if (strncmp(ksp_chain->ks_class, "disk", 4) &&
250         strncmp(ksp_chain->ks_class, "partition", 9))
251       continue;
252     if (ksp_chain->ks_type != KSTAT_TYPE_IO)
253       continue;
254     ksp[numdisk++] = ksp_chain;
255   }
256 #endif /* HAVE_LIBKSTAT */
257
258   return 0;
259 } /* int disk_init */
260
261 static int disk_shutdown(void) {
262 #if KERNEL_LINUX
263 #if HAVE_LIBUDEV_H
264   if (handle_udev != NULL)
265     udev_unref(handle_udev);
266 #endif /* HAVE_LIBUDEV_H */
267 #endif /* KERNEL_LINUX */
268   return 0;
269 } /* int disk_shutdown */
270
271 static void disk_submit(const char *plugin_instance, const char *type,
272                         derive_t read, derive_t write) {
273   value_list_t vl = VALUE_LIST_INIT;
274   value_t values[] = {
275       {.derive = read}, {.derive = write},
276   };
277
278   vl.values = values;
279   vl.values_len = STATIC_ARRAY_SIZE(values);
280   sstrncpy(vl.plugin, "disk", sizeof(vl.plugin));
281   sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
282   sstrncpy(vl.type, type, sizeof(vl.type));
283
284   plugin_dispatch_values(&vl);
285 } /* void disk_submit */
286
287 #if KERNEL_FREEBSD || KERNEL_LINUX
288 static void submit_io_time(char const *plugin_instance, derive_t io_time,
289                            derive_t weighted_time) {
290   value_list_t vl = VALUE_LIST_INIT;
291   value_t values[] = {
292       {.derive = io_time}, {.derive = weighted_time},
293   };
294
295   vl.values = values;
296   vl.values_len = STATIC_ARRAY_SIZE(values);
297   sstrncpy(vl.plugin, "disk", sizeof(vl.plugin));
298   sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
299   sstrncpy(vl.type, "disk_io_time", sizeof(vl.type));
300
301   plugin_dispatch_values(&vl);
302 } /* void submit_io_time */
303
304 static void submit_in_progress(char const *disk_name, gauge_t in_progress) {
305   value_list_t vl = VALUE_LIST_INIT;
306
307   vl.values = &(value_t){.gauge = in_progress};
308   vl.values_len = 1;
309   sstrncpy(vl.plugin, "disk", sizeof(vl.plugin));
310   sstrncpy(vl.plugin_instance, disk_name, sizeof(vl.plugin_instance));
311   sstrncpy(vl.type, "pending_operations", sizeof(vl.type));
312
313   plugin_dispatch_values(&vl);
314 }
315 #endif /* KERNEL_FREEBSD || KERNEL_LINUX */
316
317 #if KERNEL_LINUX
318 static counter_t disk_calc_time_incr(counter_t delta_time,
319                                      counter_t delta_ops) {
320   double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval());
321   double avg_time = ((double)delta_time) / ((double)delta_ops);
322   double avg_time_incr = interval * avg_time;
323
324   return (counter_t)(avg_time_incr + .5);
325 }
326 #endif
327
328 #if HAVE_LIBUDEV_H
329 /**
330  * Attempt to provide an rename disk instance from an assigned udev attribute.
331  *
332  * On success, it returns a strduped char* to the desired attribute value.
333  * Otherwise it returns NULL.
334  */
335
336 static char *disk_udev_attr_name(struct udev *udev, char *disk_name,
337                                  const char *attr) {
338   struct udev_device *dev;
339   const char *prop;
340   char *output = NULL;
341
342   dev = udev_device_new_from_subsystem_sysname(udev, "block", disk_name);
343   if (dev != NULL) {
344     prop = udev_device_get_property_value(dev, attr);
345     if (prop) {
346       output = strdup(prop);
347       DEBUG("disk plugin: renaming %s => %s", disk_name, output);
348     }
349     udev_device_unref(dev);
350   }
351   return output;
352 }
353 #endif
354
355 #if HAVE_IOKIT_IOKITLIB_H
356 static signed long long dict_get_value(CFDictionaryRef dict, const char *key) {
357   signed long long val_int;
358   CFNumberRef val_obj;
359   CFStringRef key_obj;
360
361   /* `key_obj' needs to be released. */
362   key_obj = CFStringCreateWithCString(kCFAllocatorDefault, key,
363                                       kCFStringEncodingASCII);
364   if (key_obj == NULL) {
365     DEBUG("CFStringCreateWithCString (%s) failed.", key);
366     return -1LL;
367   }
368
369   /* get => we don't need to release (== free) the object */
370   val_obj = (CFNumberRef)CFDictionaryGetValue(dict, key_obj);
371
372   CFRelease(key_obj);
373
374   if (val_obj == NULL) {
375     DEBUG("CFDictionaryGetValue (%s) failed.", key);
376     return -1LL;
377   }
378
379   if (!CFNumberGetValue(val_obj, kCFNumberSInt64Type, &val_int)) {
380     DEBUG("CFNumberGetValue (%s) failed.", key);
381     return -1LL;
382   }
383
384   return val_int;
385 }
386 #endif /* HAVE_IOKIT_IOKITLIB_H */
387
388 static int disk_read(void) {
389 #if HAVE_IOKIT_IOKITLIB_H
390   io_registry_entry_t disk;
391   io_registry_entry_t disk_child;
392   io_iterator_t disk_list;
393   CFMutableDictionaryRef props_dict, child_dict;
394   CFDictionaryRef stats_dict;
395   CFStringRef tmp_cf_string_ref;
396   kern_return_t status;
397
398   signed long long read_ops, read_byt, read_tme;
399   signed long long write_ops, write_byt, write_tme;
400
401   int disk_major, disk_minor;
402   char disk_name[DATA_MAX_NAME_LEN];
403   char child_disk_name_bsd[DATA_MAX_NAME_LEN],
404       props_disk_name_bsd[DATA_MAX_NAME_LEN];
405
406   /* Get the list of all disk objects. */
407   if (IOServiceGetMatchingServices(
408           io_master_port, IOServiceMatching(kIOBlockStorageDriverClass),
409           &disk_list) != kIOReturnSuccess) {
410     ERROR("disk plugin: IOServiceGetMatchingServices failed.");
411     return -1;
412   }
413
414   while ((disk = IOIteratorNext(disk_list)) != 0) {
415     props_dict = NULL;
416     stats_dict = NULL;
417     child_dict = NULL;
418
419     /* get child of disk entry and corresponding property dictionary */
420     if ((status = IORegistryEntryGetChildEntry(
421              disk, kIOServicePlane, &disk_child)) != kIOReturnSuccess) {
422       /* This fails for example for DVD/CD drives, which we want to ignore
423        * anyway */
424       DEBUG("IORegistryEntryGetChildEntry (disk) failed: 0x%08x", status);
425       IOObjectRelease(disk);
426       continue;
427     }
428     if (IORegistryEntryCreateCFProperties(
429             disk_child, (CFMutableDictionaryRef *)&child_dict,
430             kCFAllocatorDefault, kNilOptions) != kIOReturnSuccess ||
431         child_dict == NULL) {
432       ERROR("disk plugin: IORegistryEntryCreateCFProperties (disk_child) "
433             "failed.");
434       IOObjectRelease(disk_child);
435       IOObjectRelease(disk);
436       continue;
437     }
438
439     /* extract name and major/minor numbers */
440     memset(child_disk_name_bsd, 0, sizeof(child_disk_name_bsd));
441     tmp_cf_string_ref =
442         (CFStringRef)CFDictionaryGetValue(child_dict, CFSTR(kIOBSDNameKey));
443     if (tmp_cf_string_ref) {
444       assert(CFGetTypeID(tmp_cf_string_ref) == CFStringGetTypeID());
445       CFStringGetCString(tmp_cf_string_ref, child_disk_name_bsd,
446                          sizeof(child_disk_name_bsd), kCFStringEncodingUTF8);
447     }
448     disk_major = (int)dict_get_value(child_dict, kIOBSDMajorKey);
449     disk_minor = (int)dict_get_value(child_dict, kIOBSDMinorKey);
450     DEBUG("disk plugin: child_disk_name_bsd=\"%s\" major=%d minor=%d",
451           child_disk_name_bsd, disk_major, disk_minor);
452     CFRelease(child_dict);
453     IOObjectRelease(disk_child);
454
455     /* get property dictionary of the disk entry itself */
456     if (IORegistryEntryCreateCFProperties(
457             disk, (CFMutableDictionaryRef *)&props_dict, kCFAllocatorDefault,
458             kNilOptions) != kIOReturnSuccess ||
459         props_dict == NULL) {
460       ERROR("disk-plugin: IORegistryEntryCreateCFProperties failed.");
461       IOObjectRelease(disk);
462       continue;
463     }
464
465     /* extract name and stats dictionary */
466     memset(props_disk_name_bsd, 0, sizeof(props_disk_name_bsd));
467     tmp_cf_string_ref =
468         (CFStringRef)CFDictionaryGetValue(props_dict, CFSTR(kIOBSDNameKey));
469     if (tmp_cf_string_ref) {
470       assert(CFGetTypeID(tmp_cf_string_ref) == CFStringGetTypeID());
471       CFStringGetCString(tmp_cf_string_ref, props_disk_name_bsd,
472                          sizeof(props_disk_name_bsd), kCFStringEncodingUTF8);
473     }
474     stats_dict = (CFDictionaryRef)CFDictionaryGetValue(
475         props_dict, CFSTR(kIOBlockStorageDriverStatisticsKey));
476     if (stats_dict == NULL) {
477       ERROR("disk plugin: CFDictionaryGetValue (%s) failed.",
478             kIOBlockStorageDriverStatisticsKey);
479       CFRelease(props_dict);
480       IOObjectRelease(disk);
481       continue;
482     }
483     DEBUG("disk plugin: props_disk_name_bsd=\"%s\"", props_disk_name_bsd);
484
485     /* choose name */
486     if (use_bsd_name) {
487       if (child_disk_name_bsd[0] != 0)
488         sstrncpy(disk_name, child_disk_name_bsd, sizeof(disk_name));
489       else if (props_disk_name_bsd[0] != 0)
490         sstrncpy(disk_name, props_disk_name_bsd, sizeof(disk_name));
491       else {
492         ERROR("disk plugin: can't find bsd disk name.");
493         ssnprintf(disk_name, sizeof(disk_name), "%i-%i", disk_major,
494                   disk_minor);
495       }
496     } else
497       ssnprintf(disk_name, sizeof(disk_name), "%i-%i", disk_major, disk_minor);
498
499     DEBUG("disk plugin: disk_name = \"%s\"", disk_name);
500
501     /* check the name against ignore list */
502     if (ignorelist_match(ignorelist, disk_name) != 0) {
503       CFRelease(props_dict);
504       IOObjectRelease(disk);
505       continue;
506     }
507
508     /* extract the stats */
509     read_ops =
510         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsReadsKey);
511     read_byt =
512         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsBytesReadKey);
513     read_tme = dict_get_value(stats_dict,
514                               kIOBlockStorageDriverStatisticsTotalReadTimeKey);
515     write_ops =
516         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsWritesKey);
517     write_byt = dict_get_value(stats_dict,
518                                kIOBlockStorageDriverStatisticsBytesWrittenKey);
519     write_tme = dict_get_value(
520         stats_dict, kIOBlockStorageDriverStatisticsTotalWriteTimeKey);
521     CFRelease(props_dict);
522     IOObjectRelease(disk);
523
524     /* and submit */
525     if ((read_byt != -1LL) || (write_byt != -1LL))
526       disk_submit(disk_name, "disk_octets", read_byt, write_byt);
527     if ((read_ops != -1LL) || (write_ops != -1LL))
528       disk_submit(disk_name, "disk_ops", read_ops, write_ops);
529     if ((read_tme != -1LL) || (write_tme != -1LL))
530       disk_submit(disk_name, "disk_time", read_tme / 1000, write_tme / 1000);
531   }
532   IOObjectRelease(disk_list);
533 /* #endif HAVE_IOKIT_IOKITLIB_H */
534
535 #elif KERNEL_FREEBSD
536   int retry, dirty;
537
538   void *snap = NULL;
539   struct devstat *snap_iter;
540
541   struct gident *geom_id;
542
543   const char *disk_name;
544   long double read_time, write_time, busy_time, total_duration;
545   uint64_t queue_length;
546
547   for (retry = 0, dirty = 1; retry < 5 && dirty == 1; retry++) {
548     if (snap != NULL)
549       geom_stats_snapshot_free(snap);
550
551     /* Get a fresh copy of stats snapshot */
552     snap = geom_stats_snapshot_get();
553     if (snap == NULL) {
554       ERROR("disk plugin: geom_stats_snapshot_get() failed.");
555       return -1;
556     }
557
558     /* Check if we have dirty read from this snapshot */
559     dirty = 0;
560     geom_stats_snapshot_reset(snap);
561     while ((snap_iter = geom_stats_snapshot_next(snap)) != NULL) {
562       if (snap_iter->id == NULL)
563         continue;
564       geom_id = geom_lookupid(&geom_tree, snap_iter->id);
565
566       /* New device? refresh GEOM tree */
567       if (geom_id == NULL) {
568         geom_deletetree(&geom_tree);
569         if (geom_gettree(&geom_tree) != 0) {
570           ERROR("disk plugin: geom_gettree() failed");
571           geom_stats_snapshot_free(snap);
572           return -1;
573         }
574         geom_id = geom_lookupid(&geom_tree, snap_iter->id);
575       }
576       /*
577        * This should be rare: the device come right before we take the
578        * snapshot and went away right after it.  We will handle this
579        * case later, so don't mark dirty but silently ignore it.
580        */
581       if (geom_id == NULL)
582         continue;
583
584       /* Only collect PROVIDER data */
585       if (geom_id->lg_what != ISPROVIDER)
586         continue;
587
588       /* Only collect data when rank is 1 (physical devices) */
589       if (((struct gprovider *)(geom_id->lg_ptr))->lg_geom->lg_rank != 1)
590         continue;
591
592       /* Check if this is a dirty read quit for another try */
593       if (snap_iter->sequence0 != snap_iter->sequence1) {
594         dirty = 1;
595         break;
596       }
597     }
598   }
599
600   /* Reset iterator */
601   geom_stats_snapshot_reset(snap);
602   for (;;) {
603     snap_iter = geom_stats_snapshot_next(snap);
604     if (snap_iter == NULL)
605       break;
606
607     if (snap_iter->id == NULL)
608       continue;
609     geom_id = geom_lookupid(&geom_tree, snap_iter->id);
610     if (geom_id == NULL)
611       continue;
612     if (geom_id->lg_what != ISPROVIDER)
613       continue;
614     if (((struct gprovider *)(geom_id->lg_ptr))->lg_geom->lg_rank != 1)
615       continue;
616     /* Skip dirty reads, if present */
617     if (dirty && (snap_iter->sequence0 != snap_iter->sequence1))
618       continue;
619
620     disk_name = ((struct gprovider *)geom_id->lg_ptr)->lg_name;
621
622     if (ignorelist_match(ignorelist, disk_name) != 0)
623       continue;
624
625     if ((snap_iter->bytes[DEVSTAT_READ] != 0) ||
626         (snap_iter->bytes[DEVSTAT_WRITE] != 0)) {
627       disk_submit(disk_name, "disk_octets",
628                   (derive_t)snap_iter->bytes[DEVSTAT_READ],
629                   (derive_t)snap_iter->bytes[DEVSTAT_WRITE]);
630     }
631
632     if ((snap_iter->operations[DEVSTAT_READ] != 0) ||
633         (snap_iter->operations[DEVSTAT_WRITE] != 0)) {
634       disk_submit(disk_name, "disk_ops",
635                   (derive_t)snap_iter->operations[DEVSTAT_READ],
636                   (derive_t)snap_iter->operations[DEVSTAT_WRITE]);
637     }
638
639     read_time = devstat_compute_etime(&snap_iter->duration[DEVSTAT_READ], NULL);
640     write_time =
641         devstat_compute_etime(&snap_iter->duration[DEVSTAT_WRITE], NULL);
642     if ((read_time != 0) || (write_time != 0)) {
643       disk_submit(disk_name, "disk_time", (derive_t)(read_time * 1000),
644                   (derive_t)(write_time * 1000));
645     }
646     if (devstat_compute_statistics(snap_iter, NULL, 1.0, DSM_TOTAL_BUSY_TIME,
647                                    &busy_time, DSM_TOTAL_DURATION,
648                                    &total_duration, DSM_QUEUE_LENGTH,
649                                    &queue_length, DSM_NONE) != 0) {
650       WARNING("%s", devstat_errbuf);
651     } else {
652       submit_io_time(disk_name, busy_time, total_duration);
653       submit_in_progress(disk_name, (gauge_t)queue_length);
654     }
655   }
656   geom_stats_snapshot_free(snap);
657
658 #elif KERNEL_LINUX
659   FILE *fh;
660   char buffer[1024];
661
662   char *fields[32];
663   static unsigned int poll_count = 0;
664
665   derive_t read_sectors = 0;
666   derive_t write_sectors = 0;
667
668   derive_t read_ops = 0;
669   derive_t read_merged = 0;
670   derive_t read_time = 0;
671   derive_t write_ops = 0;
672   derive_t write_merged = 0;
673   derive_t write_time = 0;
674   gauge_t in_progress = NAN;
675   derive_t io_time = 0;
676   derive_t weighted_time = 0;
677   int is_disk = 0;
678
679   diskstats_t *ds, *pre_ds;
680
681   if ((fh = fopen("/proc/diskstats", "r")) == NULL) {
682     ERROR("disk plugin: fopen(\"/proc/diskstats\"): %s", STRERRNO);
683     return -1;
684   }
685
686   poll_count++;
687   while (fgets(buffer, sizeof(buffer), fh) != NULL) {
688     int numfields = strsplit(buffer, fields, 32);
689
690     /* need either 7 fields (partition) or at least 14 fields */
691     if ((numfields != 7) && (numfields < 14))
692       continue;
693
694     char *disk_name = fields[2];
695
696     for (ds = disklist, pre_ds = disklist; ds != NULL;
697          pre_ds = ds, ds = ds->next)
698       if (strcmp(disk_name, ds->name) == 0)
699         break;
700
701     if (ds == NULL) {
702       if ((ds = calloc(1, sizeof(*ds))) == NULL)
703         continue;
704
705       if ((ds->name = strdup(disk_name)) == NULL) {
706         free(ds);
707         continue;
708       }
709
710       if (pre_ds == NULL)
711         disklist = ds;
712       else
713         pre_ds->next = ds;
714     }
715
716     is_disk = 0;
717     if (numfields == 7) {
718       /* Kernel 2.6, Partition */
719       read_ops = atoll(fields[3]);
720       read_sectors = atoll(fields[4]);
721       write_ops = atoll(fields[5]);
722       write_sectors = atoll(fields[6]);
723     } else {
724       assert(numfields >= 14);
725       read_ops = atoll(fields[3]);
726       write_ops = atoll(fields[7]);
727
728       read_sectors = atoll(fields[5]);
729       write_sectors = atoll(fields[9]);
730
731       is_disk = 1;
732       read_merged = atoll(fields[4]);
733       read_time = atoll(fields[6]);
734       write_merged = atoll(fields[8]);
735       write_time = atoll(fields[10]);
736
737       in_progress = atof(fields[11]);
738
739       io_time = atof(fields[12]);
740       weighted_time = atof(fields[13]);
741     }
742
743     {
744       derive_t diff_read_sectors;
745       derive_t diff_write_sectors;
746
747       /* If the counter wraps around, it's only 32 bits.. */
748       if (read_sectors < ds->read_sectors)
749         diff_read_sectors = 1 + read_sectors + (UINT_MAX - ds->read_sectors);
750       else
751         diff_read_sectors = read_sectors - ds->read_sectors;
752       if (write_sectors < ds->write_sectors)
753         diff_write_sectors = 1 + write_sectors + (UINT_MAX - ds->write_sectors);
754       else
755         diff_write_sectors = write_sectors - ds->write_sectors;
756
757       ds->read_bytes += 512 * diff_read_sectors;
758       ds->write_bytes += 512 * diff_write_sectors;
759       ds->read_sectors = read_sectors;
760       ds->write_sectors = write_sectors;
761     }
762
763     /* Calculate the average time an io-op needs to complete */
764     if (is_disk) {
765       derive_t diff_read_ops;
766       derive_t diff_write_ops;
767       derive_t diff_read_time;
768       derive_t diff_write_time;
769
770       if (read_ops < ds->read_ops)
771         diff_read_ops = 1 + read_ops + (UINT_MAX - ds->read_ops);
772       else
773         diff_read_ops = read_ops - ds->read_ops;
774       DEBUG("disk plugin: disk_name = %s; read_ops = %" PRIi64 "; "
775             "ds->read_ops = %" PRIi64 "; diff_read_ops = %" PRIi64 ";",
776             disk_name, read_ops, ds->read_ops, diff_read_ops);
777
778       if (write_ops < ds->write_ops)
779         diff_write_ops = 1 + write_ops + (UINT_MAX - ds->write_ops);
780       else
781         diff_write_ops = write_ops - ds->write_ops;
782
783       if (read_time < ds->read_time)
784         diff_read_time = 1 + read_time + (UINT_MAX - ds->read_time);
785       else
786         diff_read_time = read_time - ds->read_time;
787
788       if (write_time < ds->write_time)
789         diff_write_time = 1 + write_time + (UINT_MAX - ds->write_time);
790       else
791         diff_write_time = write_time - ds->write_time;
792
793       if (diff_read_ops != 0)
794         ds->avg_read_time += disk_calc_time_incr(diff_read_time, diff_read_ops);
795       if (diff_write_ops != 0)
796         ds->avg_write_time +=
797             disk_calc_time_incr(diff_write_time, diff_write_ops);
798
799       ds->read_ops = read_ops;
800       ds->read_time = read_time;
801       ds->write_ops = write_ops;
802       ds->write_time = write_time;
803
804       if (read_merged || write_merged)
805         ds->has_merged = true;
806
807       if (in_progress)
808         ds->has_in_progress = true;
809
810       if (io_time)
811         ds->has_io_time = true;
812
813     } /* if (is_disk) */
814
815     /* Skip first cycle for newly-added disk */
816     if (ds->poll_count == 0) {
817       DEBUG("disk plugin: (ds->poll_count = 0) => Skipping.");
818       ds->poll_count = poll_count;
819       continue;
820     }
821     ds->poll_count = poll_count;
822
823     if ((read_ops == 0) && (write_ops == 0)) {
824       DEBUG("disk plugin: ((read_ops == 0) && "
825             "(write_ops == 0)); => Not writing.");
826       continue;
827     }
828
829     char *output_name = disk_name;
830
831 #if HAVE_LIBUDEV_H
832     char *alt_name = NULL;
833     if (conf_udev_name_attr != NULL) {
834       alt_name =
835           disk_udev_attr_name(handle_udev, disk_name, conf_udev_name_attr);
836       if (alt_name != NULL)
837         output_name = alt_name;
838     }
839 #endif
840
841     if (ignorelist_match(ignorelist, output_name) != 0) {
842 #if HAVE_LIBUDEV_H
843       /* release udev-based alternate name, if allocated */
844       sfree(alt_name);
845 #endif
846       continue;
847     }
848
849     if ((ds->read_bytes != 0) || (ds->write_bytes != 0))
850       disk_submit(output_name, "disk_octets", ds->read_bytes, ds->write_bytes);
851
852     if ((ds->read_ops != 0) || (ds->write_ops != 0))
853       disk_submit(output_name, "disk_ops", read_ops, write_ops);
854
855     if ((ds->avg_read_time != 0) || (ds->avg_write_time != 0))
856       disk_submit(output_name, "disk_time", ds->avg_read_time,
857                   ds->avg_write_time);
858
859     if (is_disk) {
860       if (ds->has_merged)
861         disk_submit(output_name, "disk_merged", read_merged, write_merged);
862       if (ds->has_in_progress)
863         submit_in_progress(output_name, in_progress);
864       if (ds->has_io_time)
865         submit_io_time(output_name, io_time, weighted_time);
866     } /* if (is_disk) */
867
868 #if HAVE_LIBUDEV_H
869     /* release udev-based alternate name, if allocated */
870     sfree(alt_name);
871 #endif
872   } /* while (fgets (buffer, sizeof (buffer), fh) != NULL) */
873
874   /* Remove disks that have disappeared from diskstats */
875   for (ds = disklist, pre_ds = disklist; ds != NULL;) {
876     /* Disk exists */
877     if (ds->poll_count == poll_count) {
878       pre_ds = ds;
879       ds = ds->next;
880       continue;
881     }
882
883     /* Disk is missing, remove it */
884     diskstats_t *missing_ds = ds;
885     if (ds == disklist) {
886       pre_ds = disklist = ds->next;
887     } else {
888       pre_ds->next = ds->next;
889     }
890     ds = ds->next;
891
892     DEBUG("disk plugin: Disk %s disappeared.", missing_ds->name);
893     free(missing_ds->name);
894     free(missing_ds);
895   }
896   fclose(fh);
897 /* #endif defined(KERNEL_LINUX) */
898
899 #elif HAVE_LIBKSTAT
900 #if HAVE_KSTAT_IO_T_WRITES && HAVE_KSTAT_IO_T_NWRITES && HAVE_KSTAT_IO_T_WTIME
901 #define KIO_ROCTETS reads
902 #define KIO_WOCTETS writes
903 #define KIO_ROPS nreads
904 #define KIO_WOPS nwrites
905 #define KIO_RTIME rtime
906 #define KIO_WTIME wtime
907 #elif HAVE_KSTAT_IO_T_NWRITTEN && HAVE_KSTAT_IO_T_WRITES &&                    \
908     HAVE_KSTAT_IO_T_WTIME
909 #define KIO_ROCTETS nread
910 #define KIO_WOCTETS nwritten
911 #define KIO_ROPS reads
912 #define KIO_WOPS writes
913 #define KIO_RTIME rtime
914 #define KIO_WTIME wtime
915 #else
916 #error "kstat_io_t does not have the required members"
917 #endif
918   static kstat_io_t kio;
919
920   if (kc == NULL)
921     return -1;
922
923   for (int i = 0; i < numdisk; i++) {
924     if (kstat_read(kc, ksp[i], &kio) == -1)
925       continue;
926
927     if (strncmp(ksp[i]->ks_class, "disk", 4) == 0) {
928       if (ignorelist_match(ignorelist, ksp[i]->ks_name) != 0)
929         continue;
930
931       disk_submit(ksp[i]->ks_name, "disk_octets", kio.KIO_ROCTETS,
932                   kio.KIO_WOCTETS);
933       disk_submit(ksp[i]->ks_name, "disk_ops", kio.KIO_ROPS, kio.KIO_WOPS);
934       /* FIXME: Convert this to microseconds if necessary */
935       disk_submit(ksp[i]->ks_name, "disk_time", kio.KIO_RTIME, kio.KIO_WTIME);
936     } else if (strncmp(ksp[i]->ks_class, "partition", 9) == 0) {
937       if (ignorelist_match(ignorelist, ksp[i]->ks_name) != 0)
938         continue;
939
940       disk_submit(ksp[i]->ks_name, "disk_octets", kio.KIO_ROCTETS,
941                   kio.KIO_WOCTETS);
942       disk_submit(ksp[i]->ks_name, "disk_ops", kio.KIO_ROPS, kio.KIO_WOPS);
943     }
944   }
945 /* #endif defined(HAVE_LIBKSTAT) */
946
947 #elif defined(HAVE_LIBSTATGRAB)
948   sg_disk_io_stats *ds;
949 #if HAVE_LIBSTATGRAB_0_90
950   size_t disks;
951 #else
952   int disks;
953 #endif
954   char name[DATA_MAX_NAME_LEN];
955
956   if ((ds = sg_get_disk_io_stats(&disks)) == NULL)
957     return 0;
958
959   for (int counter = 0; counter < disks; counter++) {
960     strncpy(name, ds->disk_name, sizeof(name));
961     name[sizeof(name) - 1] =
962         '\0'; /* strncpy doesn't terminate longer strings */
963
964     if (ignorelist_match(ignorelist, name) != 0) {
965       ds++;
966       continue;
967     }
968
969     disk_submit(name, "disk_octets", ds->read_bytes, ds->write_bytes);
970     ds++;
971   }
972 /* #endif defined(HAVE_LIBSTATGRAB) */
973
974 #elif defined(HAVE_PERFSTAT)
975   derive_t read_sectors;
976   derive_t write_sectors;
977   derive_t read_time;
978   derive_t write_time;
979   derive_t read_ops;
980   derive_t write_ops;
981   perfstat_id_t firstpath;
982   int rnumdisk;
983
984   if ((numdisk = perfstat_disk(NULL, NULL, sizeof(perfstat_disk_t), 0)) < 0) {
985     WARNING("disk plugin: perfstat_disk: %s", STRERRNO);
986     return -1;
987   }
988
989   if (numdisk != pnumdisk || stat_disk == NULL) {
990     free(stat_disk);
991     stat_disk = calloc(numdisk, sizeof(*stat_disk));
992   }
993   pnumdisk = numdisk;
994
995   firstpath.name[0] = '\0';
996   if ((rnumdisk = perfstat_disk(&firstpath, stat_disk, sizeof(perfstat_disk_t),
997                                 numdisk)) < 0) {
998     WARNING("disk plugin: perfstat_disk : %s", STRERRNO);
999     return -1;
1000   }
1001
1002   for (int i = 0; i < rnumdisk; i++) {
1003     if (ignorelist_match(ignorelist, stat_disk[i].name) != 0)
1004       continue;
1005
1006     read_sectors = stat_disk[i].rblks * stat_disk[i].bsize;
1007     write_sectors = stat_disk[i].wblks * stat_disk[i].bsize;
1008     disk_submit(stat_disk[i].name, "disk_octets", read_sectors, write_sectors);
1009
1010     read_ops = stat_disk[i].xrate;
1011     write_ops = stat_disk[i].xfers - stat_disk[i].xrate;
1012     disk_submit(stat_disk[i].name, "disk_ops", read_ops, write_ops);
1013
1014     read_time = stat_disk[i].rserv;
1015     read_time *= ((double)(_system_configuration.Xint) /
1016                   (double)(_system_configuration.Xfrac)) /
1017                  1000000.0;
1018     write_time = stat_disk[i].wserv;
1019     write_time *= ((double)(_system_configuration.Xint) /
1020                    (double)(_system_configuration.Xfrac)) /
1021                   1000000.0;
1022     disk_submit(stat_disk[i].name, "disk_time", read_time, write_time);
1023   }
1024 #endif /* defined(HAVE_PERFSTAT) */
1025
1026   return 0;
1027 } /* int disk_read */
1028
1029 void module_register(void) {
1030   plugin_register_config("disk", disk_config, config_keys, config_keys_num);
1031   plugin_register_init("disk", disk_init);
1032   plugin_register_shutdown("disk", disk_shutdown);
1033   plugin_register_read("disk", disk_read);
1034 } /* void module_register */