Added library link check and addressed review comments
[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 "common.h"
27 #include "plugin.h"
28 #include "utils_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 #if HAVE_LIMITS_H
63 #include <limits.h>
64 #endif
65 #ifndef UINT_MAX
66 #define UINT_MAX 4294967295U
67 #endif
68
69 #if HAVE_STATGRAB_H
70 #include <statgrab.h>
71 #endif
72
73 #if HAVE_PERFSTAT
74 #ifndef _AIXVERSION_610
75 #include <sys/systemcfg.h>
76 #endif
77 #include <libperfstat.h>
78 #include <sys/protosw.h>
79 #endif
80
81 #if HAVE_IOKIT_IOKITLIB_H
82 static mach_port_t io_master_port = MACH_PORT_NULL;
83 /* This defaults to false for backwards compatibility. Please fix in the next
84  * major version. */
85 static _Bool use_bsd_name = 0;
86 /* #endif HAVE_IOKIT_IOKITLIB_H */
87
88 #elif KERNEL_LINUX
89 typedef struct diskstats {
90   char *name;
91
92   /* This overflows in roughly 1361 years */
93   unsigned int poll_count;
94
95   derive_t read_sectors;
96   derive_t write_sectors;
97
98   derive_t read_bytes;
99   derive_t write_bytes;
100
101   derive_t read_ops;
102   derive_t write_ops;
103   derive_t read_time;
104   derive_t write_time;
105
106   derive_t avg_read_time;
107   derive_t avg_write_time;
108
109   _Bool has_merged;
110   _Bool has_in_progress;
111   _Bool has_io_time;
112
113   struct diskstats *next;
114 } diskstats_t;
115
116 static diskstats_t *disklist;
117 /* #endif KERNEL_LINUX */
118 #elif KERNEL_FREEBSD
119 static struct gmesh geom_tree;
120 /* #endif KERNEL_FREEBSD */
121
122 #elif HAVE_LIBKSTAT
123 #define MAX_NUMDISK 1024
124 extern kstat_ctl_t *kc;
125 static kstat_t *ksp[MAX_NUMDISK];
126 static int numdisk = 0;
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_UDEV_H
143 #include <libudev.h>
144
145 static char *conf_udev_name_attr = NULL;
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 = NULL;
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) ? 1 : 0;
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_UDEV_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_UDEV_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_UDEV_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_UDEV_H
264   if (handle_udev != NULL)
265     udev_unref(handle_udev);
266 #endif /* HAVE_UDEV_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 #endif /* KERNEL_FREEBSD || KERNEL_LINUX */
304
305 #if KERNEL_LINUX
306 static void submit_in_progress(char const *disk_name, gauge_t in_progress) {
307   value_list_t vl = VALUE_LIST_INIT;
308
309   vl.values = &(value_t){.gauge = in_progress};
310   vl.values_len = 1;
311   sstrncpy(vl.plugin, "disk", sizeof(vl.plugin));
312   sstrncpy(vl.plugin_instance, disk_name, sizeof(vl.plugin_instance));
313   sstrncpy(vl.type, "pending_operations", sizeof(vl.type));
314
315   plugin_dispatch_values(&vl);
316 }
317
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_UDEV_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         snprintf(disk_name, sizeof(disk_name), "%i-%i", disk_major, disk_minor);
494       }
495     } else
496       snprintf(disk_name, sizeof(disk_name), "%i-%i", disk_major, disk_minor);
497
498     DEBUG("disk plugin: disk_name = \"%s\"", disk_name);
499
500     /* check the name against ignore list */
501     if (ignorelist_match(ignorelist, disk_name) != 0) {
502       CFRelease(props_dict);
503       IOObjectRelease(disk);
504       continue;
505     }
506
507     /* extract the stats */
508     read_ops =
509         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsReadsKey);
510     read_byt =
511         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsBytesReadKey);
512     read_tme = dict_get_value(stats_dict,
513                               kIOBlockStorageDriverStatisticsTotalReadTimeKey);
514     write_ops =
515         dict_get_value(stats_dict, kIOBlockStorageDriverStatisticsWritesKey);
516     write_byt = dict_get_value(stats_dict,
517                                kIOBlockStorageDriverStatisticsBytesWrittenKey);
518     write_tme = dict_get_value(
519         stats_dict, kIOBlockStorageDriverStatisticsTotalWriteTimeKey);
520     CFRelease(props_dict);
521     IOObjectRelease(disk);
522
523     /* and submit */
524     if ((read_byt != -1LL) || (write_byt != -1LL))
525       disk_submit(disk_name, "disk_octets", read_byt, write_byt);
526     if ((read_ops != -1LL) || (write_ops != -1LL))
527       disk_submit(disk_name, "disk_ops", read_ops, write_ops);
528     if ((read_tme != -1LL) || (write_tme != -1LL))
529       disk_submit(disk_name, "disk_time", read_tme / 1000, write_tme / 1000);
530   }
531   IOObjectRelease(disk_list);
532 /* #endif HAVE_IOKIT_IOKITLIB_H */
533
534 #elif KERNEL_FREEBSD
535   int retry, dirty;
536
537   void *snap = NULL;
538   struct devstat *snap_iter;
539
540   struct gident *geom_id;
541
542   const char *disk_name;
543   long double read_time, write_time, busy_time, total_duration;
544
545   for (retry = 0, dirty = 1; retry < 5 && dirty == 1; retry++) {
546     if (snap != NULL)
547       geom_stats_snapshot_free(snap);
548
549     /* Get a fresh copy of stats snapshot */
550     snap = geom_stats_snapshot_get();
551     if (snap == NULL) {
552       ERROR("disk plugin: geom_stats_snapshot_get() failed.");
553       return -1;
554     }
555
556     /* Check if we have dirty read from this snapshot */
557     dirty = 0;
558     geom_stats_snapshot_reset(snap);
559     while ((snap_iter = geom_stats_snapshot_next(snap)) != NULL) {
560       if (snap_iter->id == NULL)
561         continue;
562       geom_id = geom_lookupid(&geom_tree, snap_iter->id);
563
564       /* New device? refresh GEOM tree */
565       if (geom_id == NULL) {
566         geom_deletetree(&geom_tree);
567         if (geom_gettree(&geom_tree) != 0) {
568           ERROR("disk plugin: geom_gettree() failed");
569           geom_stats_snapshot_free(snap);
570           return -1;
571         }
572         geom_id = geom_lookupid(&geom_tree, snap_iter->id);
573       }
574       /*
575        * This should be rare: the device come right before we take the
576        * snapshot and went away right after it.  We will handle this
577        * case later, so don't mark dirty but silently ignore it.
578        */
579       if (geom_id == NULL)
580         continue;
581
582       /* Only collect PROVIDER data */
583       if (geom_id->lg_what != ISPROVIDER)
584         continue;
585
586       /* Only collect data when rank is 1 (physical devices) */
587       if (((struct gprovider *)(geom_id->lg_ptr))->lg_geom->lg_rank != 1)
588         continue;
589
590       /* Check if this is a dirty read quit for another try */
591       if (snap_iter->sequence0 != snap_iter->sequence1) {
592         dirty = 1;
593         break;
594       }
595     }
596   }
597
598   /* Reset iterator */
599   geom_stats_snapshot_reset(snap);
600   for (;;) {
601     snap_iter = geom_stats_snapshot_next(snap);
602     if (snap_iter == NULL)
603       break;
604
605     if (snap_iter->id == NULL)
606       continue;
607     geom_id = geom_lookupid(&geom_tree, snap_iter->id);
608     if (geom_id == NULL)
609       continue;
610     if (geom_id->lg_what != ISPROVIDER)
611       continue;
612     if (((struct gprovider *)(geom_id->lg_ptr))->lg_geom->lg_rank != 1)
613       continue;
614     /* Skip dirty reads, if present */
615     if (dirty && (snap_iter->sequence0 != snap_iter->sequence1))
616       continue;
617
618     disk_name = ((struct gprovider *)geom_id->lg_ptr)->lg_name;
619
620     if (ignorelist_match(ignorelist, disk_name) != 0)
621       continue;
622
623     if ((snap_iter->bytes[DEVSTAT_READ] != 0) ||
624         (snap_iter->bytes[DEVSTAT_WRITE] != 0)) {
625       disk_submit(disk_name, "disk_octets",
626                   (derive_t)snap_iter->bytes[DEVSTAT_READ],
627                   (derive_t)snap_iter->bytes[DEVSTAT_WRITE]);
628     }
629
630     if ((snap_iter->operations[DEVSTAT_READ] != 0) ||
631         (snap_iter->operations[DEVSTAT_WRITE] != 0)) {
632       disk_submit(disk_name, "disk_ops",
633                   (derive_t)snap_iter->operations[DEVSTAT_READ],
634                   (derive_t)snap_iter->operations[DEVSTAT_WRITE]);
635     }
636
637     read_time = devstat_compute_etime(&snap_iter->duration[DEVSTAT_READ], NULL);
638     write_time =
639         devstat_compute_etime(&snap_iter->duration[DEVSTAT_WRITE], NULL);
640     if ((read_time != 0) || (write_time != 0)) {
641       disk_submit(disk_name, "disk_time", (derive_t)(read_time * 1000),
642                   (derive_t)(write_time * 1000));
643     }
644     if (devstat_compute_statistics(snap_iter, NULL, 1.0, DSM_TOTAL_BUSY_TIME,
645                                    &busy_time, DSM_TOTAL_DURATION,
646                                    &total_duration, DSM_NONE) != 0) {
647       WARNING("%s", devstat_errbuf);
648     } else {
649       submit_io_time(disk_name, busy_time, total_duration);
650     }
651   }
652   geom_stats_snapshot_free(snap);
653
654 #elif KERNEL_LINUX
655   FILE *fh;
656   char buffer[1024];
657
658   char *fields[32];
659   int numfields;
660   int fieldshift = 0;
661
662   int minor = 0;
663
664   derive_t read_sectors = 0;
665   derive_t write_sectors = 0;
666
667   derive_t read_ops = 0;
668   derive_t read_merged = 0;
669   derive_t read_time = 0;
670   derive_t write_ops = 0;
671   derive_t write_merged = 0;
672   derive_t write_time = 0;
673   gauge_t in_progress = NAN;
674   derive_t io_time = 0;
675   derive_t weighted_time = 0;
676   int is_disk = 0;
677
678   diskstats_t *ds, *pre_ds;
679
680   if ((fh = fopen("/proc/diskstats", "r")) == NULL) {
681     fh = fopen("/proc/partitions", "r");
682     if (fh == NULL) {
683       ERROR("disk plugin: fopen (/proc/{diskstats,partitions}) failed.");
684       return -1;
685     }
686
687     /* Kernel is 2.4.* */
688     fieldshift = 1;
689   }
690
691   while (fgets(buffer, sizeof(buffer), fh) != NULL) {
692     char *disk_name;
693     char *output_name;
694
695     numfields = strsplit(buffer, fields, 32);
696
697     if ((numfields != (14 + fieldshift)) && (numfields != 7))
698       continue;
699
700     minor = atoll(fields[1]);
701
702     disk_name = fields[2 + fieldshift];
703
704     for (ds = disklist, pre_ds = disklist; ds != NULL;
705          pre_ds = ds, ds = ds->next)
706       if (strcmp(disk_name, ds->name) == 0)
707         break;
708
709     if (ds == NULL) {
710       if ((ds = (diskstats_t *)calloc(1, sizeof(diskstats_t))) == NULL)
711         continue;
712
713       if ((ds->name = strdup(disk_name)) == NULL) {
714         free(ds);
715         continue;
716       }
717
718       if (pre_ds == NULL)
719         disklist = ds;
720       else
721         pre_ds->next = ds;
722     }
723
724     is_disk = 0;
725     if (numfields == 7) {
726       /* Kernel 2.6, Partition */
727       read_ops = atoll(fields[3]);
728       read_sectors = atoll(fields[4]);
729       write_ops = atoll(fields[5]);
730       write_sectors = atoll(fields[6]);
731     } else if (numfields == (14 + fieldshift)) {
732       read_ops = atoll(fields[3 + fieldshift]);
733       write_ops = atoll(fields[7 + fieldshift]);
734
735       read_sectors = atoll(fields[5 + fieldshift]);
736       write_sectors = atoll(fields[9 + fieldshift]);
737
738       if ((fieldshift == 0) || (minor == 0)) {
739         is_disk = 1;
740         read_merged = atoll(fields[4 + fieldshift]);
741         read_time = atoll(fields[6 + fieldshift]);
742         write_merged = atoll(fields[8 + fieldshift]);
743         write_time = atoll(fields[10 + fieldshift]);
744
745         in_progress = atof(fields[11 + fieldshift]);
746
747         io_time = atof(fields[12 + fieldshift]);
748         weighted_time = atof(fields[13 + fieldshift]);
749       }
750     } else {
751       DEBUG("numfields = %i; => unknown file format.", numfields);
752       continue;
753     }
754
755     {
756       derive_t diff_read_sectors;
757       derive_t diff_write_sectors;
758
759       /* If the counter wraps around, it's only 32 bits.. */
760       if (read_sectors < ds->read_sectors)
761         diff_read_sectors = 1 + read_sectors + (UINT_MAX - ds->read_sectors);
762       else
763         diff_read_sectors = read_sectors - ds->read_sectors;
764       if (write_sectors < ds->write_sectors)
765         diff_write_sectors = 1 + write_sectors + (UINT_MAX - ds->write_sectors);
766       else
767         diff_write_sectors = write_sectors - ds->write_sectors;
768
769       ds->read_bytes += 512 * diff_read_sectors;
770       ds->write_bytes += 512 * diff_write_sectors;
771       ds->read_sectors = read_sectors;
772       ds->write_sectors = write_sectors;
773     }
774
775     /* Calculate the average time an io-op needs to complete */
776     if (is_disk) {
777       derive_t diff_read_ops;
778       derive_t diff_write_ops;
779       derive_t diff_read_time;
780       derive_t diff_write_time;
781
782       if (read_ops < ds->read_ops)
783         diff_read_ops = 1 + read_ops + (UINT_MAX - ds->read_ops);
784       else
785         diff_read_ops = read_ops - ds->read_ops;
786       DEBUG("disk plugin: disk_name = %s; read_ops = %" PRIi64 "; "
787             "ds->read_ops = %" PRIi64 "; diff_read_ops = %" PRIi64 ";",
788             disk_name, read_ops, ds->read_ops, diff_read_ops);
789
790       if (write_ops < ds->write_ops)
791         diff_write_ops = 1 + write_ops + (UINT_MAX - ds->write_ops);
792       else
793         diff_write_ops = write_ops - ds->write_ops;
794
795       if (read_time < ds->read_time)
796         diff_read_time = 1 + read_time + (UINT_MAX - ds->read_time);
797       else
798         diff_read_time = read_time - ds->read_time;
799
800       if (write_time < ds->write_time)
801         diff_write_time = 1 + write_time + (UINT_MAX - ds->write_time);
802       else
803         diff_write_time = write_time - ds->write_time;
804
805       if (diff_read_ops != 0)
806         ds->avg_read_time += disk_calc_time_incr(diff_read_time, diff_read_ops);
807       if (diff_write_ops != 0)
808         ds->avg_write_time +=
809             disk_calc_time_incr(diff_write_time, diff_write_ops);
810
811       ds->read_ops = read_ops;
812       ds->read_time = read_time;
813       ds->write_ops = write_ops;
814       ds->write_time = write_time;
815
816       if (read_merged || write_merged)
817         ds->has_merged = 1;
818
819       if (in_progress)
820         ds->has_in_progress = 1;
821
822       if (io_time)
823         ds->has_io_time = 1;
824
825     } /* if (is_disk) */
826
827     /* Don't write to the RRDs if we've just started.. */
828     ds->poll_count++;
829     if (ds->poll_count <= 2) {
830       DEBUG("disk plugin: (ds->poll_count = %i) <= "
831             "(min_poll_count = 2); => Not writing.",
832             ds->poll_count);
833       continue;
834     }
835
836     if ((read_ops == 0) && (write_ops == 0)) {
837       DEBUG("disk plugin: ((read_ops == 0) && "
838             "(write_ops == 0)); => Not writing.");
839       continue;
840     }
841
842     output_name = disk_name;
843
844 #if HAVE_UDEV_H
845     char *alt_name = NULL;
846     if (conf_udev_name_attr != NULL) {
847       alt_name =
848           disk_udev_attr_name(handle_udev, disk_name, conf_udev_name_attr);
849       if (alt_name != NULL)
850         output_name = alt_name;
851     }
852 #endif
853
854     if (ignorelist_match(ignorelist, output_name) != 0) {
855 #if HAVE_UDEV_H
856       /* release udev-based alternate name, if allocated */
857       sfree(alt_name);
858 #endif
859       continue;
860     }
861
862     if ((ds->read_bytes != 0) || (ds->write_bytes != 0))
863       disk_submit(output_name, "disk_octets", ds->read_bytes, ds->write_bytes);
864
865     if ((ds->read_ops != 0) || (ds->write_ops != 0))
866       disk_submit(output_name, "disk_ops", read_ops, write_ops);
867
868     if ((ds->avg_read_time != 0) || (ds->avg_write_time != 0))
869       disk_submit(output_name, "disk_time", ds->avg_read_time,
870                   ds->avg_write_time);
871
872     if (is_disk) {
873       if (ds->has_merged)
874         disk_submit(output_name, "disk_merged", read_merged, write_merged);
875       if (ds->has_in_progress)
876         submit_in_progress(output_name, in_progress);
877       if (ds->has_io_time)
878         submit_io_time(output_name, io_time, weighted_time);
879     } /* if (is_disk) */
880
881 #if HAVE_UDEV_H
882     /* release udev-based alternate name, if allocated */
883     sfree(alt_name);
884 #endif
885   } /* while (fgets (buffer, sizeof (buffer), fh) != NULL) */
886
887   fclose(fh);
888 /* #endif defined(KERNEL_LINUX) */
889
890 #elif HAVE_LIBKSTAT
891 #if HAVE_KSTAT_IO_T_WRITES && HAVE_KSTAT_IO_T_NWRITES && HAVE_KSTAT_IO_T_WTIME
892 #define KIO_ROCTETS reads
893 #define KIO_WOCTETS writes
894 #define KIO_ROPS nreads
895 #define KIO_WOPS nwrites
896 #define KIO_RTIME rtime
897 #define KIO_WTIME wtime
898 #elif HAVE_KSTAT_IO_T_NWRITTEN && HAVE_KSTAT_IO_T_WRITES &&                    \
899     HAVE_KSTAT_IO_T_WTIME
900 #define KIO_ROCTETS nread
901 #define KIO_WOCTETS nwritten
902 #define KIO_ROPS reads
903 #define KIO_WOPS writes
904 #define KIO_RTIME rtime
905 #define KIO_WTIME wtime
906 #else
907 #error "kstat_io_t does not have the required members"
908 #endif
909   static kstat_io_t kio;
910
911   if (kc == NULL)
912     return -1;
913
914   for (int i = 0; i < numdisk; i++) {
915     if (kstat_read(kc, ksp[i], &kio) == -1)
916       continue;
917
918     if (strncmp(ksp[i]->ks_class, "disk", 4) == 0) {
919       if (ignorelist_match(ignorelist, ksp[i]->ks_name) != 0)
920         continue;
921
922       disk_submit(ksp[i]->ks_name, "disk_octets", kio.KIO_ROCTETS,
923                   kio.KIO_WOCTETS);
924       disk_submit(ksp[i]->ks_name, "disk_ops", kio.KIO_ROPS, kio.KIO_WOPS);
925       /* FIXME: Convert this to microseconds if necessary */
926       disk_submit(ksp[i]->ks_name, "disk_time", kio.KIO_RTIME, kio.KIO_WTIME);
927     } else if (strncmp(ksp[i]->ks_class, "partition", 9) == 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     }
935   }
936 /* #endif defined(HAVE_LIBKSTAT) */
937
938 #elif defined(HAVE_LIBSTATGRAB)
939   sg_disk_io_stats *ds;
940 #if HAVE_LIBSTATGRAB_0_90
941   size_t disks;
942 #else
943   int disks;
944 #endif
945   char name[DATA_MAX_NAME_LEN];
946
947   if ((ds = sg_get_disk_io_stats(&disks)) == NULL)
948     return 0;
949
950   for (int counter = 0; counter < disks; counter++) {
951     strncpy(name, ds->disk_name, sizeof(name));
952     name[sizeof(name) - 1] =
953         '\0'; /* strncpy doesn't terminate longer strings */
954
955     if (ignorelist_match(ignorelist, name) != 0) {
956       ds++;
957       continue;
958     }
959
960     disk_submit(name, "disk_octets", ds->read_bytes, ds->write_bytes);
961     ds++;
962   }
963 /* #endif defined(HAVE_LIBSTATGRAB) */
964
965 #elif defined(HAVE_PERFSTAT)
966   derive_t read_sectors;
967   derive_t write_sectors;
968   derive_t read_time;
969   derive_t write_time;
970   derive_t read_ops;
971   derive_t write_ops;
972   perfstat_id_t firstpath;
973   int rnumdisk;
974
975   if ((numdisk = perfstat_disk(NULL, NULL, sizeof(perfstat_disk_t), 0)) < 0) {
976     WARNING("disk plugin: perfstat_disk: %s", STRERRNO);
977     return -1;
978   }
979
980   if (numdisk != pnumdisk || stat_disk == NULL) {
981     if (stat_disk != NULL)
982       free(stat_disk);
983     stat_disk = (perfstat_disk_t *)calloc(numdisk, sizeof(perfstat_disk_t));
984   }
985   pnumdisk = numdisk;
986
987   firstpath.name[0] = '\0';
988   if ((rnumdisk = perfstat_disk(&firstpath, stat_disk, sizeof(perfstat_disk_t),
989                                 numdisk)) < 0) {
990     WARNING("disk plugin: perfstat_disk : %s", STRERRNO);
991     return -1;
992   }
993
994   for (int i = 0; i < rnumdisk; i++) {
995     if (ignorelist_match(ignorelist, stat_disk[i].name) != 0)
996       continue;
997
998     read_sectors = stat_disk[i].rblks * stat_disk[i].bsize;
999     write_sectors = stat_disk[i].wblks * stat_disk[i].bsize;
1000     disk_submit(stat_disk[i].name, "disk_octets", read_sectors, write_sectors);
1001
1002     read_ops = stat_disk[i].xrate;
1003     write_ops = stat_disk[i].xfers - stat_disk[i].xrate;
1004     disk_submit(stat_disk[i].name, "disk_ops", read_ops, write_ops);
1005
1006     read_time = stat_disk[i].rserv;
1007     read_time *= ((double)(_system_configuration.Xint) /
1008                   (double)(_system_configuration.Xfrac)) /
1009                  1000000.0;
1010     write_time = stat_disk[i].wserv;
1011     write_time *= ((double)(_system_configuration.Xint) /
1012                    (double)(_system_configuration.Xfrac)) /
1013                   1000000.0;
1014     disk_submit(stat_disk[i].name, "disk_time", read_time, write_time);
1015   }
1016 #endif /* defined(HAVE_PERFSTAT) */
1017
1018   return 0;
1019 } /* int disk_read */
1020
1021 void module_register(void) {
1022   plugin_register_config("disk", disk_config, config_keys, config_keys_num);
1023   plugin_register_init("disk", disk_init);
1024   plugin_register_shutdown("disk", disk_shutdown);
1025   plugin_register_read("disk", disk_read);
1026 } /* void module_register */