2 * collectd - src/disk.c
3 * Copyright (C) 2005-2008 Florian octo Forster
4 * Copyright (C) 2009 Manuel Sanmartin
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.
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.
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
20 * Florian octo Forster <octo at verplant.org>
27 #include "utils_ignorelist.h"
29 #if HAVE_MACH_MACH_TYPES_H
30 # include <mach/mach_types.h>
32 #if HAVE_MACH_MACH_INIT_H
33 # include <mach/mach_init.h>
35 #if HAVE_MACH_MACH_ERROR_H
36 # include <mach/mach_error.h>
38 #if HAVE_MACH_MACH_PORT_H
39 # include <mach/mach_port.h>
41 #if HAVE_COREFOUNDATION_COREFOUNDATION_H
42 # include <CoreFoundation/CoreFoundation.h>
44 #if HAVE_IOKIT_IOKITLIB_H
45 # include <IOKit/IOKitLib.h>
47 #if HAVE_IOKIT_IOTYPES_H
48 # include <IOKit/IOTypes.h>
50 #if HAVE_IOKIT_STORAGE_IOBLOCKSTORAGEDRIVER_H
51 # include <IOKit/storage/IOBlockStorageDriver.h>
53 #if HAVE_IOKIT_IOBSD_H
54 # include <IOKit/IOBSD.h>
61 # define UINT_MAX 4294967295U
65 # include <statgrab.h>
69 # ifndef _AIXVERSION_610
70 # include <sys/systemcfg.h>
72 # include <sys/protosw.h>
73 # include <libperfstat.h>
76 #if HAVE_IOKIT_IOKITLIB_H
77 static mach_port_t io_master_port = MACH_PORT_NULL;
78 /* #endif HAVE_IOKIT_IOKITLIB_H */
81 typedef struct diskstats
85 /* This overflows in roughly 1361 years */
86 unsigned int poll_count;
88 counter_t read_sectors;
89 counter_t write_sectors;
92 counter_t write_bytes;
99 counter_t avg_read_time;
100 counter_t avg_write_time;
102 struct diskstats *next;
105 static diskstats_t *disklist;
106 /* #endif KERNEL_LINUX */
109 #define MAX_NUMDISK 256
110 extern kstat_ctl_t *kc;
111 static kstat_t *ksp[MAX_NUMDISK];
112 static int numdisk = 0;
113 /* #endif HAVE_LIBKSTAT */
115 #elif defined(HAVE_LIBSTATGRAB)
116 /* #endif HAVE_LIBKSTATGRAB */
119 static perfstat_disk_t * stat_disk;
122 /* #endif HAVE_PERFSTAT */
125 # error "No applicable input method."
128 static const char *config_keys[] =
133 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
135 static ignorelist_t *ignorelist = NULL;
137 static int disk_config (const char *key, const char *value)
139 if (ignorelist == NULL)
140 ignorelist = ignorelist_create (/* invert = */ 1);
141 if (ignorelist == NULL)
144 if (strcasecmp ("Disk", key) == 0)
146 ignorelist_add (ignorelist, value);
148 else if (strcasecmp ("IgnoreSelected", key) == 0)
153 ignorelist_set_invert (ignorelist, invert);
161 } /* int disk_config */
163 static int disk_init (void)
165 #if HAVE_IOKIT_IOKITLIB_H
166 kern_return_t status;
168 if (io_master_port != MACH_PORT_NULL)
170 mach_port_deallocate (mach_task_self (),
172 io_master_port = MACH_PORT_NULL;
175 status = IOMasterPort (MACH_PORT_NULL, &io_master_port);
176 if (status != kIOReturnSuccess)
178 ERROR ("IOMasterPort failed: %s",
179 mach_error_string (status));
180 io_master_port = MACH_PORT_NULL;
183 /* #endif HAVE_IOKIT_IOKITLIB_H */
187 /* #endif KERNEL_LINUX */
197 for (numdisk = 0, ksp_chain = kc->kc_chain;
198 (numdisk < MAX_NUMDISK) && (ksp_chain != NULL);
199 ksp_chain = ksp_chain->ks_next)
201 if (strncmp (ksp_chain->ks_class, "disk", 4)
202 && strncmp (ksp_chain->ks_class, "partition", 9))
204 if (ksp_chain->ks_type != KSTAT_TYPE_IO)
206 ksp[numdisk++] = ksp_chain;
208 #endif /* HAVE_LIBKSTAT */
211 } /* int disk_init */
213 static void disk_submit (const char *plugin_instance,
215 counter_t read, counter_t write)
218 value_list_t vl = VALUE_LIST_INIT;
220 /* Both `ignorelist' and `plugin_instance' may be NULL. */
221 if (ignorelist_match (ignorelist, plugin_instance) != 0)
224 values[0].counter = read;
225 values[1].counter = write;
229 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
230 sstrncpy (vl.plugin, "disk", sizeof (vl.plugin));
231 sstrncpy (vl.plugin_instance, plugin_instance,
232 sizeof (vl.plugin_instance));
233 sstrncpy (vl.type, type, sizeof (vl.type));
235 plugin_dispatch_values (&vl);
236 } /* void disk_submit */
238 #if HAVE_IOKIT_IOKITLIB_H
239 static signed long long dict_get_value (CFDictionaryRef dict, const char *key)
241 signed long long val_int;
245 /* `key_obj' needs to be released. */
246 key_obj = CFStringCreateWithCString (kCFAllocatorDefault, key,
247 kCFStringEncodingASCII);
250 DEBUG ("CFStringCreateWithCString (%s) failed.", key);
254 /* get => we don't need to release (== free) the object */
255 val_obj = (CFNumberRef) CFDictionaryGetValue (dict, key_obj);
261 DEBUG ("CFDictionaryGetValue (%s) failed.", key);
265 if (!CFNumberGetValue (val_obj, kCFNumberSInt64Type, &val_int))
267 DEBUG ("CFNumberGetValue (%s) failed.", key);
273 #endif /* HAVE_IOKIT_IOKITLIB_H */
275 static int disk_read (void)
277 #if HAVE_IOKIT_IOKITLIB_H
278 io_registry_entry_t disk;
279 io_registry_entry_t disk_child;
280 io_iterator_t disk_list;
281 CFDictionaryRef props_dict;
282 CFDictionaryRef stats_dict;
283 CFDictionaryRef child_dict;
284 kern_return_t status;
286 signed long long read_ops;
287 signed long long read_byt;
288 signed long long read_tme;
289 signed long long write_ops;
290 signed long long write_byt;
291 signed long long write_tme;
297 /* Get the list of all disk objects. */
298 if (IOServiceGetMatchingServices (io_master_port,
299 IOServiceMatching (kIOBlockStorageDriverClass),
300 &disk_list) != kIOReturnSuccess)
302 ERROR ("disk plugin: IOServiceGetMatchingServices failed.");
306 while ((disk = IOIteratorNext (disk_list)) != 0)
312 /* `disk_child' must be released */
313 if ((status = IORegistryEntryGetChildEntry (disk, kIOServicePlane, &disk_child))
316 /* This fails for example for DVD/CD drives.. */
317 DEBUG ("IORegistryEntryGetChildEntry (disk) failed: 0x%08x", status);
318 IOObjectRelease (disk);
322 /* We create `props_dict' => we need to release it later */
323 if (IORegistryEntryCreateCFProperties (disk,
324 (CFMutableDictionaryRef *) &props_dict,
329 ERROR ("disk-plugin: IORegistryEntryCreateCFProperties failed.");
330 IOObjectRelease (disk_child);
331 IOObjectRelease (disk);
335 if (props_dict == NULL)
337 DEBUG ("IORegistryEntryCreateCFProperties (disk) failed.");
338 IOObjectRelease (disk_child);
339 IOObjectRelease (disk);
343 stats_dict = (CFDictionaryRef) CFDictionaryGetValue (props_dict,
344 CFSTR (kIOBlockStorageDriverStatisticsKey));
346 if (stats_dict == NULL)
348 DEBUG ("CFDictionaryGetValue (%s) failed.",
349 kIOBlockStorageDriverStatisticsKey);
350 CFRelease (props_dict);
351 IOObjectRelease (disk_child);
352 IOObjectRelease (disk);
356 if (IORegistryEntryCreateCFProperties (disk_child,
357 (CFMutableDictionaryRef *) &child_dict,
362 DEBUG ("IORegistryEntryCreateCFProperties (disk_child) failed.");
363 IOObjectRelease (disk_child);
364 CFRelease (props_dict);
365 IOObjectRelease (disk);
370 disk_major = (int) dict_get_value (child_dict,
372 disk_minor = (int) dict_get_value (child_dict,
374 read_ops = dict_get_value (stats_dict,
375 kIOBlockStorageDriverStatisticsReadsKey);
376 read_byt = dict_get_value (stats_dict,
377 kIOBlockStorageDriverStatisticsBytesReadKey);
378 read_tme = dict_get_value (stats_dict,
379 kIOBlockStorageDriverStatisticsTotalReadTimeKey);
380 write_ops = dict_get_value (stats_dict,
381 kIOBlockStorageDriverStatisticsWritesKey);
382 write_byt = dict_get_value (stats_dict,
383 kIOBlockStorageDriverStatisticsBytesWrittenKey);
384 /* This property describes the number of nanoseconds spent
385 * performing writes since the block storage driver was
386 * instantiated. It is one of the statistic entries listed
387 * under the top-level kIOBlockStorageDriverStatisticsKey
388 * property table. It has an OSNumber value. */
389 write_tme = dict_get_value (stats_dict,
390 kIOBlockStorageDriverStatisticsTotalWriteTimeKey);
392 if (ssnprintf (disk_name, sizeof (disk_name),
393 "%i-%i", disk_major, disk_minor) >= sizeof (disk_name))
395 DEBUG ("snprintf (major, minor) failed.");
396 CFRelease (child_dict);
397 IOObjectRelease (disk_child);
398 CFRelease (props_dict);
399 IOObjectRelease (disk);
402 DEBUG ("disk_name = %s", disk_name);
404 if ((read_byt != -1LL) || (write_byt != -1LL))
405 disk_submit (disk_name, "disk_octets", read_byt, write_byt);
406 if ((read_ops != -1LL) || (write_ops != -1LL))
407 disk_submit (disk_name, "disk_ops", read_ops, write_ops);
408 if ((read_tme != -1LL) || (write_tme != -1LL))
409 disk_submit (disk_name, "disk_time",
413 CFRelease (child_dict);
414 IOObjectRelease (disk_child);
415 CFRelease (props_dict);
416 IOObjectRelease (disk);
418 IOObjectRelease (disk_list);
419 /* #endif HAVE_IOKIT_IOKITLIB_H */
432 counter_t read_sectors = 0;
433 counter_t write_sectors = 0;
435 counter_t read_ops = 0;
436 counter_t read_merged = 0;
437 counter_t read_time = 0;
438 counter_t write_ops = 0;
439 counter_t write_merged = 0;
440 counter_t write_time = 0;
443 diskstats_t *ds, *pre_ds;
445 if ((fh = fopen ("/proc/diskstats", "r")) == NULL)
447 fh = fopen ("/proc/partitions", "r");
450 ERROR ("disk plugin: fopen (/proc/{diskstats,partitions}) failed.");
454 /* Kernel is 2.4.* */
458 while (fgets (buffer, sizeof (buffer), fh) != NULL)
462 numfields = strsplit (buffer, fields, 32);
464 if ((numfields != (14 + fieldshift)) && (numfields != 7))
467 major = atoll (fields[0]);
468 minor = atoll (fields[1]);
470 disk_name = fields[2 + fieldshift];
472 for (ds = disklist, pre_ds = disklist; ds != NULL; pre_ds = ds, ds = ds->next)
473 if (strcmp (disk_name, ds->name) == 0)
478 if ((ds = (diskstats_t *) calloc (1, sizeof (diskstats_t))) == NULL)
481 if ((ds->name = strdup (disk_name)) == NULL)
496 /* Kernel 2.6, Partition */
497 read_ops = atoll (fields[3]);
498 read_sectors = atoll (fields[4]);
499 write_ops = atoll (fields[5]);
500 write_sectors = atoll (fields[6]);
502 else if (numfields == (14 + fieldshift))
504 read_ops = atoll (fields[3 + fieldshift]);
505 write_ops = atoll (fields[7 + fieldshift]);
507 read_sectors = atoll (fields[5 + fieldshift]);
508 write_sectors = atoll (fields[9 + fieldshift]);
510 if ((fieldshift == 0) || (minor == 0))
513 read_merged = atoll (fields[4 + fieldshift]);
514 read_time = atoll (fields[6 + fieldshift]);
515 write_merged = atoll (fields[8 + fieldshift]);
516 write_time = atoll (fields[10+ fieldshift]);
521 DEBUG ("numfields = %i; => unknown file format.", numfields);
526 counter_t diff_read_sectors;
527 counter_t diff_write_sectors;
529 /* If the counter wraps around, it's only 32 bits.. */
530 if (read_sectors < ds->read_sectors)
531 diff_read_sectors = 1 + read_sectors
532 + (UINT_MAX - ds->read_sectors);
534 diff_read_sectors = read_sectors - ds->read_sectors;
535 if (write_sectors < ds->write_sectors)
536 diff_write_sectors = 1 + write_sectors
537 + (UINT_MAX - ds->write_sectors);
539 diff_write_sectors = write_sectors - ds->write_sectors;
541 ds->read_bytes += 512 * diff_read_sectors;
542 ds->write_bytes += 512 * diff_write_sectors;
543 ds->read_sectors = read_sectors;
544 ds->write_sectors = write_sectors;
547 /* Calculate the average time an io-op needs to complete */
550 counter_t diff_read_ops;
551 counter_t diff_write_ops;
552 counter_t diff_read_time;
553 counter_t diff_write_time;
555 if (read_ops < ds->read_ops)
556 diff_read_ops = 1 + read_ops
557 + (UINT_MAX - ds->read_ops);
559 diff_read_ops = read_ops - ds->read_ops;
560 DEBUG ("disk plugin: disk_name = %s; read_ops = %llu; "
561 "ds->read_ops = %llu; diff_read_ops = %llu;",
563 read_ops, ds->read_ops, diff_read_ops);
565 if (write_ops < ds->write_ops)
566 diff_write_ops = 1 + write_ops
567 + (UINT_MAX - ds->write_ops);
569 diff_write_ops = write_ops - ds->write_ops;
571 if (read_time < ds->read_time)
572 diff_read_time = 1 + read_time
573 + (UINT_MAX - ds->read_time);
575 diff_read_time = read_time - ds->read_time;
577 if (write_time < ds->write_time)
578 diff_write_time = 1 + write_time
579 + (UINT_MAX - ds->write_time);
581 diff_write_time = write_time - ds->write_time;
583 if (diff_read_ops != 0)
584 ds->avg_read_time += (diff_read_time
585 + (diff_read_ops / 2))
587 if (diff_write_ops != 0)
588 ds->avg_write_time += (diff_write_time
589 + (diff_write_ops / 2))
592 ds->read_ops = read_ops;
593 ds->read_time = read_time;
594 ds->write_ops = write_ops;
595 ds->write_time = write_time;
598 /* Don't write to the RRDs if we've just started.. */
600 if (ds->poll_count <= 2)
602 DEBUG ("disk plugin: (ds->poll_count = %i) <= "
603 "(min_poll_count = 2); => Not writing.",
608 if ((read_ops == 0) && (write_ops == 0))
610 DEBUG ("disk plugin: ((read_ops == 0) && "
611 "(write_ops == 0)); => Not writing.");
615 if ((ds->read_bytes != 0) || (ds->write_bytes != 0))
616 disk_submit (disk_name, "disk_octets",
617 ds->read_bytes, ds->write_bytes);
619 if ((ds->read_ops != 0) || (ds->write_ops != 0))
620 disk_submit (disk_name, "disk_ops",
621 read_ops, write_ops);
623 if ((ds->avg_read_time != 0) || (ds->avg_write_time != 0))
624 disk_submit (disk_name, "disk_time",
625 ds->avg_read_time, ds->avg_write_time);
629 disk_submit (disk_name, "disk_merged",
630 read_merged, write_merged);
632 } /* while (fgets (buffer, sizeof (buffer), fh) != NULL) */
635 /* #endif defined(KERNEL_LINUX) */
638 # if HAVE_KSTAT_IO_T_WRITES && HAVE_KSTAT_IO_T_NWRITES && HAVE_KSTAT_IO_T_WTIME
639 # define KIO_ROCTETS reads
640 # define KIO_WOCTETS writes
641 # define KIO_ROPS nreads
642 # define KIO_WOPS nwrites
643 # define KIO_RTIME rtime
644 # define KIO_WTIME wtime
645 # elif HAVE_KSTAT_IO_T_NWRITTEN && HAVE_KSTAT_IO_T_WRITES && HAVE_KSTAT_IO_T_WTIME
646 # define KIO_ROCTETS nread
647 # define KIO_WOCTETS nwritten
648 # define KIO_ROPS reads
649 # define KIO_WOPS writes
650 # define KIO_RTIME rtime
651 # define KIO_WTIME wtime
653 # error "kstat_io_t does not have the required members"
655 static kstat_io_t kio;
661 for (i = 0; i < numdisk; i++)
663 if (kstat_read (kc, ksp[i], &kio) == -1)
666 if (strncmp (ksp[i]->ks_class, "disk", 4) == 0)
668 disk_submit (ksp[i]->ks_name, "disk_octets",
669 kio.KIO_ROCTETS, kio.KIO_WOCTETS);
670 disk_submit (ksp[i]->ks_name, "disk_ops",
671 kio.KIO_ROPS, kio.KIO_WOPS);
672 /* FIXME: Convert this to microseconds if necessary */
673 disk_submit (ksp[i]->ks_name, "disk_time",
674 kio.KIO_RTIME, kio.KIO_WTIME);
676 else if (strncmp (ksp[i]->ks_class, "partition", 9) == 0)
678 disk_submit (ksp[i]->ks_name, "disk_octets",
679 kio.KIO_ROCTETS, kio.KIO_WOCTETS);
680 disk_submit (ksp[i]->ks_name, "disk_ops",
681 kio.KIO_ROPS, kio.KIO_WOPS);
684 /* #endif defined(HAVE_LIBKSTAT) */
686 #elif defined(HAVE_LIBSTATGRAB)
687 sg_disk_io_stats *ds;
689 char name[DATA_MAX_NAME_LEN];
691 if ((ds = sg_get_disk_io_stats(&disks)) == NULL)
694 for (counter=0; counter < disks; counter++) {
695 strncpy(name, ds->disk_name, sizeof(name));
696 name[sizeof(name)-1] = '\0'; /* strncpy doesn't terminate longer strings */
697 disk_submit (name, "disk_octets", ds->read_bytes, ds->write_bytes);
700 /* #endif defined(HAVE_LIBSTATGRAB) */
702 #elif defined(HAVE_PERFSTAT)
703 counter_t read_sectors;
704 counter_t write_sectors;
706 counter_t write_time;
709 perfstat_id_t firstpath;
713 if ((numdisk = perfstat_disk(NULL, NULL, sizeof(perfstat_disk_t), 0)) < 0)
716 WARNING ("disk plugin: perfstat_disk: %s",
717 sstrerror (errno, errbuf, sizeof (errbuf)));
721 if (numdisk != pnumdisk || stat_disk==NULL) {
724 stat_disk = (perfstat_disk_t *)calloc(numdisk, sizeof(perfstat_disk_t));
728 firstpath.name[0]='\0';
729 if ((rnumdisk = perfstat_disk(&firstpath, stat_disk, sizeof(perfstat_disk_t), numdisk)) < 0)
732 WARNING ("disk plugin: perfstat_disk : %s",
733 sstrerror (errno, errbuf, sizeof (errbuf)));
737 for (i = 0; i < rnumdisk; i++)
739 read_sectors = stat_disk[i].rblks*stat_disk[i].bsize;
740 write_sectors = stat_disk[i].wblks*stat_disk[i].bsize;
741 disk_submit (stat_disk[i].name, "disk_octets", read_sectors, write_sectors);
743 read_ops = stat_disk[i].xrate;
744 write_ops = stat_disk[i].xfers - stat_disk[i].xrate;
745 disk_submit (stat_disk[i].name, "disk_ops", read_ops, write_ops);
747 read_time = stat_disk[i].rserv;
748 read_time *= ((double)(_system_configuration.Xint)/(double)(_system_configuration.Xfrac)) / 1000000.0;
749 write_time = stat_disk[i].wserv;
750 write_time *= ((double)(_system_configuration.Xint)/(double)(_system_configuration.Xfrac)) / 1000000.0;
751 disk_submit (stat_disk[i].name, "disk_time", read_time, write_time);
753 #endif /* defined(HAVE_PERFSTAT) */
756 } /* int disk_read */
758 void module_register (void)
760 plugin_register_config ("disk", disk_config,
761 config_keys, config_keys_num);
762 plugin_register_init ("disk", disk_init);
763 plugin_register_read ("disk", disk_read);
764 } /* void module_register */