2 * collectd - src/battery.c
3 * Copyright (C) 2006-2014 Florian octo Forster
4 * Copyright (C) 2008 Michał Mirosław
5 * Copyright (C) 2014 Andy Parkins
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at collectd.org>
22 * Michał Mirosław <mirq-linux at rere.qmqm.pl>
23 * Andy Parkins <andyp at fussylogic.co.uk>
31 #if HAVE_MACH_MACH_TYPES_H
32 # include <mach/mach_types.h>
34 #if HAVE_MACH_MACH_INIT_H
35 # include <mach/mach_init.h>
37 #if HAVE_MACH_MACH_ERROR_H
38 # include <mach/mach_error.h>
40 #if HAVE_COREFOUNDATION_COREFOUNDATION_H
41 # include <CoreFoundation/CoreFoundation.h>
43 #if HAVE_IOKIT_IOKITLIB_H
44 # include <IOKit/IOKitLib.h>
46 #if HAVE_IOKIT_IOTYPES_H
47 # include <IOKit/IOTypes.h>
49 #if HAVE_IOKIT_PS_IOPOWERSOURCES_H
50 # include <IOKit/ps/IOPowerSources.h>
52 #if HAVE_IOKIT_PS_IOPSKEYS_H
53 # include <IOKit/ps/IOPSKeys.h>
56 #if !HAVE_IOKIT_IOKITLIB_H && !HAVE_IOKIT_PS_IOPOWERSOURCES_H && !KERNEL_LINUX
57 # error "No applicable input method."
60 #if HAVE_IOKIT_IOKITLIB_H || HAVE_IOKIT_PS_IOPOWERSOURCES_H
61 /* No global variables */
62 /* #endif HAVE_IOKIT_IOKITLIB_H || HAVE_IOKIT_PS_IOPOWERSOURCES_H */
65 # define PROC_PMU_PATH_FORMAT "/proc/pmu/battery_%i"
66 # define PROC_ACPI_PATH "/proc/acpi/battery"
67 # define PROC_ACPI_FACTOR 0.001
68 # define SYSFS_PATH "/sys/class/power_supply"
69 # define SYSFS_FACTOR 0.000001
70 #endif /* KERNEL_LINUX */
72 int battery_read_statefs (void); /* defined in battery_statefs; used by StateFS backend */
74 static _Bool report_percent = 0;
75 static _Bool report_degraded = 0;
76 static _Bool query_statefs = 0;
78 static void battery_submit2 (char const *plugin_instance, /* {{{ */
79 char const *type, char const *type_instance, gauge_t value)
82 value_list_t vl = VALUE_LIST_INIT;
84 values[0].gauge = value;
88 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
89 sstrncpy (vl.plugin, "battery", sizeof (vl.plugin));
90 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
91 sstrncpy (vl.type, type, sizeof (vl.type));
92 if (type_instance != NULL)
93 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
95 plugin_dispatch_values (&vl);
96 } /* }}} void battery_submit2 */
98 static void battery_submit (char const *plugin_instance, /* {{{ */
99 char const *type, gauge_t value)
101 battery_submit2 (plugin_instance, type, NULL, value);
102 } /* }}} void battery_submit */
104 static void submit_capacity (char const *plugin_instance, /* {{{ */
105 gauge_t capacity_charged,
106 gauge_t capacity_full,
107 gauge_t capacity_design)
109 if (report_percent && (capacity_charged > capacity_full))
111 if (report_degraded && (capacity_full > capacity_design))
116 gauge_t capacity_max;
119 capacity_max = capacity_design;
121 capacity_max = capacity_full;
123 battery_submit2 (plugin_instance, "percent", "charged",
124 100.0 * capacity_charged / capacity_max);
125 battery_submit2 (plugin_instance, "percent", "discharged",
126 100.0 * (capacity_full - capacity_charged) / capacity_max);
129 battery_submit2 (plugin_instance, "percent", "degraded",
130 100.0 * (capacity_design - capacity_full) / capacity_max);
132 else if (report_degraded) /* && !report_percent */
134 battery_submit2 (plugin_instance, "capacity", "charged",
136 battery_submit2 (plugin_instance, "capacity", "discharged",
137 (capacity_full - capacity_charged));
138 battery_submit2 (plugin_instance, "capacity", "degraded",
139 (capacity_design - capacity_full));
141 else /* !report_percent && !report_degraded */
143 battery_submit (plugin_instance, "capacity", capacity_charged);
145 } /* }}} void submit_capacity */
147 #if HAVE_IOKIT_PS_IOPOWERSOURCES_H || HAVE_IOKIT_IOKITLIB_H
148 static double dict_get_double (CFDictionaryRef dict, const char *key_string) /* {{{ */
155 key_obj = CFStringCreateWithCString (kCFAllocatorDefault, key_string,
156 kCFStringEncodingASCII);
159 DEBUG ("CFStringCreateWithCString (%s) failed.\n", key_string);
163 if ((val_obj = CFDictionaryGetValue (dict, key_obj)) == NULL)
165 DEBUG ("CFDictionaryGetValue (%s) failed.", key_string);
171 if (CFGetTypeID (val_obj) == CFNumberGetTypeID ())
173 if (CFNumberIsFloatType (val_obj))
175 CFNumberGetValue (val_obj,
181 CFNumberGetValue (val_obj,
182 kCFNumberLongLongType,
184 val_double = val_int;
189 DEBUG ("CFGetTypeID (val_obj) = %i", (int) CFGetTypeID (val_obj));
194 } /* }}} double dict_get_double */
196 # if HAVE_IOKIT_PS_IOPOWERSOURCES_H
197 static void get_via_io_power_sources (double *ret_charge, /* {{{ */
204 CFDictionaryRef ps_dict;
209 ps_raw = IOPSCopyPowerSourcesInfo ();
210 ps_array = IOPSCopyPowerSourcesList (ps_raw);
211 ps_array_len = CFArrayGetCount (ps_array);
213 DEBUG ("ps_array_len == %i", ps_array_len);
215 for (int i = 0; i < ps_array_len; i++)
217 ps_obj = CFArrayGetValueAtIndex (ps_array, i);
218 ps_dict = IOPSGetPowerSourceDescription (ps_raw, ps_obj);
222 DEBUG ("IOPSGetPowerSourceDescription failed.");
226 if (CFGetTypeID (ps_dict) != CFDictionaryGetTypeID ())
228 DEBUG ("IOPSGetPowerSourceDescription did not return a CFDictionaryRef");
232 /* FIXME: Check if this is really an internal battery */
234 if (isnan (*ret_charge))
236 /* This is the charge in percent. */
237 temp_double = dict_get_double (ps_dict,
238 kIOPSCurrentCapacityKey);
239 if (!isnan ((temp_double))
240 && (temp_double >= 0.0)
241 && (temp_double <= 100.0))
242 *ret_charge = temp_double;
245 if (isnan (*ret_current))
247 temp_double = dict_get_double (ps_dict,
249 if (!isnan (temp_double))
250 *ret_current = temp_double / 1000.0;
253 if (isnan (*ret_voltage))
255 temp_double = dict_get_double (ps_dict,
257 if (!isnan (temp_double))
258 *ret_voltage = temp_double / 1000.0;
264 } /* }}} void get_via_io_power_sources */
265 # endif /* HAVE_IOKIT_PS_IOPOWERSOURCES_H */
267 # if HAVE_IOKIT_IOKITLIB_H
268 static void get_via_generic_iokit (double *ret_capacity_full, /* {{{ */
269 double *ret_capacity_design,
273 kern_return_t status;
274 io_iterator_t iterator;
277 CFDictionaryRef bat_root_dict;
278 CFArrayRef bat_info_arry;
279 CFIndex bat_info_arry_len;
280 CFDictionaryRef bat_info_dict;
284 status = IOServiceGetMatchingServices (kIOMasterPortDefault,
285 IOServiceNameMatching ("battery"),
287 if (status != kIOReturnSuccess)
289 DEBUG ("IOServiceGetMatchingServices failed.");
293 while ((io_obj = IOIteratorNext (iterator)))
295 status = IORegistryEntryCreateCFProperties (io_obj,
296 (CFMutableDictionaryRef *) &bat_root_dict,
299 if (status != kIOReturnSuccess)
301 DEBUG ("IORegistryEntryCreateCFProperties failed.");
305 bat_info_arry = (CFArrayRef) CFDictionaryGetValue (bat_root_dict,
306 CFSTR ("IOBatteryInfo"));
307 if (bat_info_arry == NULL)
309 CFRelease (bat_root_dict);
312 bat_info_arry_len = CFArrayGetCount (bat_info_arry);
314 for (CFIndex bat_info_arry_pos = 0;
315 bat_info_arry_pos < bat_info_arry_len;
318 bat_info_dict = (CFDictionaryRef) CFArrayGetValueAtIndex (bat_info_arry, bat_info_arry_pos);
320 if (isnan (*ret_capacity_full))
322 temp_double = dict_get_double (bat_info_dict, "Capacity");
323 *ret_capacity_full = temp_double / 1000.0;
326 if (isnan (*ret_capacity_design))
328 temp_double = dict_get_double (bat_info_dict, "AbsoluteMaxCapacity");
329 *ret_capacity_design = temp_double / 1000.0;
332 if (isnan (*ret_current))
334 temp_double = dict_get_double (bat_info_dict, "Current");
335 *ret_current = temp_double / 1000.0;
338 if (isnan (*ret_voltage))
340 temp_double = dict_get_double (bat_info_dict, "Voltage");
341 *ret_voltage = temp_double / 1000.0;
345 CFRelease (bat_root_dict);
348 IOObjectRelease (iterator);
349 } /* }}} void get_via_generic_iokit */
350 # endif /* HAVE_IOKIT_IOKITLIB_H */
352 static int battery_read (void) /* {{{ */
354 gauge_t current = NAN; /* Current in A */
355 gauge_t voltage = NAN; /* Voltage in V */
357 /* We only get the charged capacity as a percentage from
358 * IOPowerSources. IOKit, on the other hand, only reports the full
359 * capacity. We use the two to calculate the current charged capacity. */
360 gauge_t charge_rel = NAN; /* Current charge in percent */
361 gauge_t capacity_charged; /* Charged capacity */
362 gauge_t capacity_full = NAN; /* Total capacity */
363 gauge_t capacity_design = NAN; /* Full design capacity */
366 return battery_read_statefs ();
368 #if HAVE_IOKIT_PS_IOPOWERSOURCES_H
369 get_via_io_power_sources (&charge_rel, ¤t, &voltage);
371 #if HAVE_IOKIT_IOKITLIB_H
372 get_via_generic_iokit (&capacity_full, &capacity_design, ¤t, &voltage);
375 capacity_charged = charge_rel * capacity_full / 100.0;
376 submit_capacity ("0", capacity_charged, capacity_full, capacity_design);
378 if (!isnan (current))
379 battery_submit ("0", "current", current);
380 if (!isnan (voltage))
381 battery_submit ("0", "voltage", voltage);
384 } /* }}} int battery_read */
385 /* #endif HAVE_IOKIT_IOKITLIB_H || HAVE_IOKIT_PS_IOPOWERSOURCES_H */
388 /* Reads a file which contains only a number (and optionally a trailing
389 * newline) and parses that number. */
390 static int sysfs_file_to_buffer(char const *dir, /* {{{ */
391 char const *power_supply,
392 char const *basename,
393 char *buffer, size_t buffer_size)
397 char filename[PATH_MAX];
399 ssnprintf (filename, sizeof (filename), "%s/%s/%s",
400 dir, power_supply, basename);
402 /* No file isn't the end of the world -- not every system will be
403 * reporting the same set of statistics */
404 if (access (filename, R_OK) != 0)
407 fp = fopen (filename, "r");
411 if (status != ENOENT)
414 WARNING ("battery plugin: fopen (%s) failed: %s", filename,
415 sstrerror (status, errbuf, sizeof (errbuf)));
420 if (fgets (buffer, buffer_size, fp) == NULL)
423 if (status != ENODEV)
426 WARNING ("battery plugin: fgets (%s) failed: %s", filename,
427 sstrerror (status, errbuf, sizeof (errbuf)));
433 strstripnewline (buffer);
437 } /* }}} int sysfs_file_to_buffer */
439 /* Reads a file which contains only a number (and optionally a trailing
440 * newline) and parses that number. */
441 static int sysfs_file_to_gauge(char const *dir, /* {{{ */
442 char const *power_supply,
443 char const *basename, gauge_t *ret_value)
446 char buffer[32] = "";
448 status = sysfs_file_to_buffer (dir, power_supply, basename, buffer, sizeof (buffer));
452 return (strtogauge (buffer, ret_value));
453 } /* }}} sysfs_file_to_gauge */
455 static int read_sysfs_capacity (char const *dir, /* {{{ */
456 char const *power_supply,
457 char const *plugin_instance)
459 gauge_t capacity_charged = NAN;
460 gauge_t capacity_full = NAN;
461 gauge_t capacity_design = NAN;
464 status = sysfs_file_to_gauge (dir, power_supply, "energy_now", &capacity_charged);
468 status = sysfs_file_to_gauge (dir, power_supply, "energy_full", &capacity_full);
472 status = sysfs_file_to_gauge (dir, power_supply, "energy_full_design", &capacity_design);
476 submit_capacity (plugin_instance,
477 capacity_charged * SYSFS_FACTOR,
478 capacity_full * SYSFS_FACTOR,
479 capacity_design * SYSFS_FACTOR);
481 } /* }}} int read_sysfs_capacity */
483 static int read_sysfs_callback (char const *dir, /* {{{ */
484 char const *power_supply,
487 int *battery_index = user_data;
489 char const *plugin_instance;
492 _Bool discharging = 0;
495 /* Ignore non-battery directories, such as AC power. */
496 status = sysfs_file_to_buffer (dir, power_supply, "type", buffer, sizeof (buffer));
499 if (strcasecmp ("Battery", buffer) != 0)
502 (void) sysfs_file_to_buffer (dir, power_supply, "status", buffer, sizeof (buffer));
503 if (strcasecmp ("Discharging", buffer) == 0)
506 /* FIXME: This is a dirty hack for backwards compatibility: The battery
507 * plugin, for a very long time, has had the plugin_instance
508 * hard-coded to "0". So, to keep backwards compatibility, we'll use
509 * "0" for the first battery we find and the power_supply name for all
510 * following. This should be reverted in a future major version. */
511 plugin_instance = (*battery_index == 0) ? "0" : power_supply;
514 read_sysfs_capacity (dir, power_supply, plugin_instance);
516 if (sysfs_file_to_gauge (dir, power_supply, "power_now", &v) == 0)
520 battery_submit (plugin_instance, "power", v * SYSFS_FACTOR);
522 if (sysfs_file_to_gauge (dir, power_supply, "current_now", &v) == 0)
526 battery_submit (plugin_instance, "current", v * SYSFS_FACTOR);
529 if (sysfs_file_to_gauge (dir, power_supply, "voltage_now", &v) == 0)
530 battery_submit (plugin_instance, "voltage", v * SYSFS_FACTOR);
533 } /* }}} int read_sysfs_callback */
535 static int read_sysfs (void) /* {{{ */
538 int battery_counter = 0;
540 if (access (SYSFS_PATH, R_OK) != 0)
543 status = walk_directory (SYSFS_PATH, read_sysfs_callback,
544 /* user_data = */ &battery_counter,
545 /* include hidden */ 0);
547 } /* }}} int read_sysfs */
549 static int read_acpi_full_capacity (char const *dir, /* {{{ */
550 char const *power_supply,
551 gauge_t *ret_capacity_full,
552 gauge_t *ret_capacity_design)
555 char filename[PATH_MAX];
560 ssnprintf (filename, sizeof (filename), "%s/%s/info", dir, power_supply);
561 fh = fopen (filename, "r");
565 /* last full capacity: 40090 mWh */
566 while (fgets (buffer, sizeof (buffer), fh) != NULL)
573 if (strncmp ("last full capacity:", buffer, strlen ("last full capacity:")) == 0)
575 value_ptr = ret_capacity_full;
578 else if (strncmp ("design capacity:", buffer, strlen ("design capacity:")) == 0)
580 value_ptr = ret_capacity_design;
588 fields_num = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
589 if (fields_num <= index)
592 strtogauge (fields[index], value_ptr);
597 } /* }}} int read_acpi_full_capacity */
599 static int read_acpi_callback (char const *dir, /* {{{ */
600 char const *power_supply,
603 int *battery_index = user_data;
606 gauge_t voltage = NAN;
607 gauge_t capacity_charged = NAN;
608 gauge_t capacity_full = NAN;
609 gauge_t capacity_design = NAN;
611 _Bool is_current = 0;
613 char const *plugin_instance;
614 char filename[PATH_MAX];
619 ssnprintf (filename, sizeof (filename), "%s/%s/state", dir, power_supply);
620 fh = fopen (filename, "r");
623 if ((errno == EAGAIN) || (errno == EINTR) || (errno == ENOENT))
630 * [11:00] <@tokkee> $ cat /proc/acpi/battery/BAT1/state
631 * [11:00] <@tokkee> present: yes
632 * [11:00] <@tokkee> capacity state: ok
633 * [11:00] <@tokkee> charging state: charging
634 * [11:00] <@tokkee> present rate: 1724 mA
635 * [11:00] <@tokkee> remaining capacity: 4136 mAh
636 * [11:00] <@tokkee> present voltage: 12428 mV
638 while (fgets (buffer, sizeof (buffer), fh) != NULL)
643 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
647 if ((strcmp (fields[0], "charging") == 0)
648 && (strcmp (fields[1], "state:") == 0))
650 if (strcmp (fields[2], "charging") == 0)
657 /* The unit of "present rate" depends on the battery. Modern
658 * batteries export power (watts), older batteries (used to)
659 * export current (amperes). We check the fourth column and try
660 * to find old batteries this way. */
661 if ((strcmp (fields[0], "present") == 0)
662 && (strcmp (fields[1], "rate:") == 0))
664 strtogauge (fields[2], &power);
666 if ((numfields >= 4) && (strcmp ("mA", fields[3]) == 0))
669 else if ((strcmp (fields[0], "remaining") == 0)
670 && (strcmp (fields[1], "capacity:") == 0))
671 strtogauge (fields[2], &capacity_charged);
672 else if ((strcmp (fields[0], "present") == 0)
673 && (strcmp (fields[1], "voltage:") == 0))
674 strtogauge (fields[2], &voltage);
675 } /* while (fgets (buffer, sizeof (buffer), fh) != NULL) */
682 /* FIXME: This is a dirty hack for backwards compatibility: The battery
683 * plugin, for a very long time, has had the plugin_instance
684 * hard-coded to "0". So, to keep backwards compatibility, we'll use
685 * "0" for the first battery we find and the power_supply name for all
686 * following. This should be reverted in a future major version. */
687 plugin_instance = (*battery_index == 0) ? "0" : power_supply;
690 read_acpi_full_capacity (dir, power_supply, &capacity_full, &capacity_design);
692 submit_capacity (plugin_instance,
693 capacity_charged * PROC_ACPI_FACTOR,
694 capacity_full * PROC_ACPI_FACTOR,
695 capacity_design * PROC_ACPI_FACTOR);
697 battery_submit (plugin_instance,
698 is_current ? "current" : "power",
699 power * PROC_ACPI_FACTOR);
700 battery_submit (plugin_instance, "voltage", voltage * PROC_ACPI_FACTOR);
703 } /* }}} int read_acpi_callback */
705 static int read_acpi (void) /* {{{ */
708 int battery_counter = 0;
710 if (access (PROC_ACPI_PATH, R_OK) != 0)
713 status = walk_directory (PROC_ACPI_PATH, read_acpi_callback,
714 /* user_data = */ &battery_counter,
715 /* include hidden */ 0);
717 } /* }}} int read_acpi */
719 static int read_pmu (void) /* {{{ */
722 /* The upper limit here is just a safeguard. If there is a system with
723 * more than 100 batteries, this can easily be increased. */
729 char filename[PATH_MAX];
730 char plugin_instance[DATA_MAX_NAME_LEN];
732 gauge_t current = NAN;
733 gauge_t voltage = NAN;
734 gauge_t charge = NAN;
736 ssnprintf (filename, sizeof (filename), PROC_PMU_PATH_FORMAT, i);
737 if (access (filename, R_OK) != 0)
740 ssnprintf (plugin_instance, sizeof (plugin_instance), "%i", i);
742 fh = fopen (filename, "r");
747 else if ((errno == EAGAIN) || (errno == EINTR))
753 while (fgets (buffer, sizeof (buffer), fh) != NULL)
758 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
762 if (strcmp ("current", fields[0]) == 0)
763 strtogauge (fields[2], ¤t);
764 else if (strcmp ("voltage", fields[0]) == 0)
765 strtogauge (fields[2], &voltage);
766 else if (strcmp ("charge", fields[0]) == 0)
767 strtogauge (fields[2], &charge);
773 battery_submit (plugin_instance, "charge", charge / 1000.0);
774 battery_submit (plugin_instance, "current", current / 1000.0);
775 battery_submit (plugin_instance, "voltage", voltage / 1000.0);
781 } /* }}} int read_pmu */
783 static int battery_read (void) /* {{{ */
788 return battery_read_statefs ();
790 DEBUG ("battery plugin: Trying sysfs ...");
791 status = read_sysfs ();
795 DEBUG ("battery plugin: Trying acpi ...");
796 status = read_acpi ();
800 DEBUG ("battery plugin: Trying pmu ...");
801 status = read_pmu ();
805 ERROR ("battery plugin: Add available input methods failed.");
807 } /* }}} int battery_read */
808 #endif /* KERNEL_LINUX */
810 static int battery_config (oconfig_item_t *ci)
812 for (int i = 0; i < ci->children_num; i++)
814 oconfig_item_t *child = ci->children + i;
816 if (strcasecmp ("ValuesPercentage", child->key) == 0)
817 cf_util_get_boolean (child, &report_percent);
818 else if (strcasecmp ("ReportDegraded", child->key) == 0)
819 cf_util_get_boolean (child, &report_degraded);
820 else if (strcasecmp ("QueryStateFS", child->key) == 0)
821 cf_util_get_boolean (child, &query_statefs);
823 WARNING ("battery plugin: Ignoring unknown "
824 "configuration option \"%s\".",
829 } /* }}} int battery_config */
831 void module_register (void)
833 plugin_register_complex_config ("battery", battery_config);
834 plugin_register_read ("battery", battery_read);
835 } /* void module_register */