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)
81 value_list_t vl = VALUE_LIST_INIT;
83 vl.values = &(value_t) { .gauge = value };
85 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
86 sstrncpy (vl.plugin, "battery", sizeof (vl.plugin));
87 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
88 sstrncpy (vl.type, type, sizeof (vl.type));
89 if (type_instance != NULL)
90 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
92 plugin_dispatch_values (&vl);
93 } /* }}} void battery_submit2 */
95 static void battery_submit (char const *plugin_instance, /* {{{ */
96 char const *type, gauge_t value)
98 battery_submit2 (plugin_instance, type, NULL, value);
99 } /* }}} void battery_submit */
101 static void submit_capacity (char const *plugin_instance, /* {{{ */
102 gauge_t capacity_charged,
103 gauge_t capacity_full,
104 gauge_t capacity_design)
106 if (report_percent && (capacity_charged > capacity_full))
108 if (report_degraded && (capacity_full > capacity_design))
113 gauge_t capacity_max;
116 capacity_max = capacity_design;
118 capacity_max = capacity_full;
120 battery_submit2 (plugin_instance, "percent", "charged",
121 100.0 * capacity_charged / capacity_max);
122 battery_submit2 (plugin_instance, "percent", "discharged",
123 100.0 * (capacity_full - capacity_charged) / capacity_max);
126 battery_submit2 (plugin_instance, "percent", "degraded",
127 100.0 * (capacity_design - capacity_full) / capacity_max);
129 else if (report_degraded) /* && !report_percent */
131 battery_submit2 (plugin_instance, "capacity", "charged",
133 battery_submit2 (plugin_instance, "capacity", "discharged",
134 (capacity_full - capacity_charged));
135 battery_submit2 (plugin_instance, "capacity", "degraded",
136 (capacity_design - capacity_full));
138 else /* !report_percent && !report_degraded */
140 battery_submit (plugin_instance, "capacity", capacity_charged);
142 } /* }}} void submit_capacity */
144 #if HAVE_IOKIT_PS_IOPOWERSOURCES_H || HAVE_IOKIT_IOKITLIB_H
145 static double dict_get_double (CFDictionaryRef dict, const char *key_string) /* {{{ */
152 key_obj = CFStringCreateWithCString (kCFAllocatorDefault, key_string,
153 kCFStringEncodingASCII);
156 DEBUG ("CFStringCreateWithCString (%s) failed.\n", key_string);
160 if ((val_obj = CFDictionaryGetValue (dict, key_obj)) == NULL)
162 DEBUG ("CFDictionaryGetValue (%s) failed.", key_string);
168 if (CFGetTypeID (val_obj) == CFNumberGetTypeID ())
170 if (CFNumberIsFloatType (val_obj))
172 CFNumberGetValue (val_obj,
178 CFNumberGetValue (val_obj,
179 kCFNumberLongLongType,
181 val_double = val_int;
186 DEBUG ("CFGetTypeID (val_obj) = %i", (int) CFGetTypeID (val_obj));
191 } /* }}} double dict_get_double */
193 # if HAVE_IOKIT_PS_IOPOWERSOURCES_H
194 static void get_via_io_power_sources (double *ret_charge, /* {{{ */
201 CFDictionaryRef ps_dict;
206 ps_raw = IOPSCopyPowerSourcesInfo ();
207 ps_array = IOPSCopyPowerSourcesList (ps_raw);
208 ps_array_len = CFArrayGetCount (ps_array);
210 DEBUG ("ps_array_len == %i", ps_array_len);
212 for (int i = 0; i < ps_array_len; i++)
214 ps_obj = CFArrayGetValueAtIndex (ps_array, i);
215 ps_dict = IOPSGetPowerSourceDescription (ps_raw, ps_obj);
219 DEBUG ("IOPSGetPowerSourceDescription failed.");
223 if (CFGetTypeID (ps_dict) != CFDictionaryGetTypeID ())
225 DEBUG ("IOPSGetPowerSourceDescription did not return a CFDictionaryRef");
229 /* FIXME: Check if this is really an internal battery */
231 if (isnan (*ret_charge))
233 /* This is the charge in percent. */
234 temp_double = dict_get_double (ps_dict,
235 kIOPSCurrentCapacityKey);
236 if (!isnan ((temp_double))
237 && (temp_double >= 0.0)
238 && (temp_double <= 100.0))
239 *ret_charge = temp_double;
242 if (isnan (*ret_current))
244 temp_double = dict_get_double (ps_dict,
246 if (!isnan (temp_double))
247 *ret_current = temp_double / 1000.0;
250 if (isnan (*ret_voltage))
252 temp_double = dict_get_double (ps_dict,
254 if (!isnan (temp_double))
255 *ret_voltage = temp_double / 1000.0;
261 } /* }}} void get_via_io_power_sources */
262 # endif /* HAVE_IOKIT_PS_IOPOWERSOURCES_H */
264 # if HAVE_IOKIT_IOKITLIB_H
265 static void get_via_generic_iokit (double *ret_capacity_full, /* {{{ */
266 double *ret_capacity_design,
270 kern_return_t status;
271 io_iterator_t iterator;
274 CFDictionaryRef bat_root_dict;
275 CFArrayRef bat_info_arry;
276 CFIndex bat_info_arry_len;
277 CFDictionaryRef bat_info_dict;
281 status = IOServiceGetMatchingServices (kIOMasterPortDefault,
282 IOServiceNameMatching ("battery"),
284 if (status != kIOReturnSuccess)
286 DEBUG ("IOServiceGetMatchingServices failed.");
290 while ((io_obj = IOIteratorNext (iterator)))
292 status = IORegistryEntryCreateCFProperties (io_obj,
293 (CFMutableDictionaryRef *) &bat_root_dict,
296 if (status != kIOReturnSuccess)
298 DEBUG ("IORegistryEntryCreateCFProperties failed.");
302 bat_info_arry = (CFArrayRef) CFDictionaryGetValue (bat_root_dict,
303 CFSTR ("IOBatteryInfo"));
304 if (bat_info_arry == NULL)
306 CFRelease (bat_root_dict);
309 bat_info_arry_len = CFArrayGetCount (bat_info_arry);
311 for (CFIndex bat_info_arry_pos = 0;
312 bat_info_arry_pos < bat_info_arry_len;
315 bat_info_dict = (CFDictionaryRef) CFArrayGetValueAtIndex (bat_info_arry, bat_info_arry_pos);
317 if (isnan (*ret_capacity_full))
319 temp_double = dict_get_double (bat_info_dict, "Capacity");
320 *ret_capacity_full = temp_double / 1000.0;
323 if (isnan (*ret_capacity_design))
325 temp_double = dict_get_double (bat_info_dict, "AbsoluteMaxCapacity");
326 *ret_capacity_design = temp_double / 1000.0;
329 if (isnan (*ret_current))
331 temp_double = dict_get_double (bat_info_dict, "Current");
332 *ret_current = temp_double / 1000.0;
335 if (isnan (*ret_voltage))
337 temp_double = dict_get_double (bat_info_dict, "Voltage");
338 *ret_voltage = temp_double / 1000.0;
342 CFRelease (bat_root_dict);
345 IOObjectRelease (iterator);
346 } /* }}} void get_via_generic_iokit */
347 # endif /* HAVE_IOKIT_IOKITLIB_H */
349 static int battery_read (void) /* {{{ */
351 gauge_t current = NAN; /* Current in A */
352 gauge_t voltage = NAN; /* Voltage in V */
354 /* We only get the charged capacity as a percentage from
355 * IOPowerSources. IOKit, on the other hand, only reports the full
356 * capacity. We use the two to calculate the current charged capacity. */
357 gauge_t charge_rel = NAN; /* Current charge in percent */
358 gauge_t capacity_charged; /* Charged capacity */
359 gauge_t capacity_full = NAN; /* Total capacity */
360 gauge_t capacity_design = NAN; /* Full design capacity */
363 return battery_read_statefs ();
365 #if HAVE_IOKIT_PS_IOPOWERSOURCES_H
366 get_via_io_power_sources (&charge_rel, ¤t, &voltage);
368 #if HAVE_IOKIT_IOKITLIB_H
369 get_via_generic_iokit (&capacity_full, &capacity_design, ¤t, &voltage);
372 capacity_charged = charge_rel * capacity_full / 100.0;
373 submit_capacity ("0", capacity_charged, capacity_full, capacity_design);
375 if (!isnan (current))
376 battery_submit ("0", "current", current);
377 if (!isnan (voltage))
378 battery_submit ("0", "voltage", voltage);
381 } /* }}} int battery_read */
382 /* #endif HAVE_IOKIT_IOKITLIB_H || HAVE_IOKIT_PS_IOPOWERSOURCES_H */
385 /* Reads a file which contains only a number (and optionally a trailing
386 * newline) and parses that number. */
387 static int sysfs_file_to_buffer(char const *dir, /* {{{ */
388 char const *power_supply,
389 char const *basename,
390 char *buffer, size_t buffer_size)
392 char filename[PATH_MAX];
395 ssnprintf (filename, sizeof (filename), "%s/%s/%s",
396 dir, power_supply, basename);
398 status = (int) read_file_contents (filename, buffer, buffer_size);
402 strstripnewline (buffer);
404 } /* }}} int sysfs_file_to_buffer */
406 /* Reads a file which contains only a number (and optionally a trailing
407 * newline) and parses that number. */
408 static int sysfs_file_to_gauge(char const *dir, /* {{{ */
409 char const *power_supply,
410 char const *basename, gauge_t *ret_value)
413 char buffer[32] = "";
415 status = sysfs_file_to_buffer (dir, power_supply, basename, buffer, sizeof (buffer));
419 return (strtogauge (buffer, ret_value));
420 } /* }}} sysfs_file_to_gauge */
422 static int read_sysfs_capacity (char const *dir, /* {{{ */
423 char const *power_supply,
424 char const *plugin_instance)
426 gauge_t capacity_charged = NAN;
427 gauge_t capacity_full = NAN;
428 gauge_t capacity_design = NAN;
431 status = sysfs_file_to_gauge (dir, power_supply, "energy_now", &capacity_charged);
435 status = sysfs_file_to_gauge (dir, power_supply, "energy_full", &capacity_full);
439 status = sysfs_file_to_gauge (dir, power_supply, "energy_full_design", &capacity_design);
443 submit_capacity (plugin_instance,
444 capacity_charged * SYSFS_FACTOR,
445 capacity_full * SYSFS_FACTOR,
446 capacity_design * SYSFS_FACTOR);
448 } /* }}} int read_sysfs_capacity */
450 static int read_sysfs_callback (char const *dir, /* {{{ */
451 char const *power_supply,
454 int *battery_index = user_data;
456 char const *plugin_instance;
459 _Bool discharging = 0;
462 /* Ignore non-battery directories, such as AC power. */
463 status = sysfs_file_to_buffer (dir, power_supply, "type", buffer, sizeof (buffer));
466 if (strcasecmp ("Battery", buffer) != 0)
469 (void) sysfs_file_to_buffer (dir, power_supply, "status", buffer, sizeof (buffer));
470 if (strcasecmp ("Discharging", buffer) == 0)
473 /* FIXME: This is a dirty hack for backwards compatibility: The battery
474 * plugin, for a very long time, has had the plugin_instance
475 * hard-coded to "0". So, to keep backwards compatibility, we'll use
476 * "0" for the first battery we find and the power_supply name for all
477 * following. This should be reverted in a future major version. */
478 plugin_instance = (*battery_index == 0) ? "0" : power_supply;
481 read_sysfs_capacity (dir, power_supply, plugin_instance);
483 if (sysfs_file_to_gauge (dir, power_supply, "power_now", &v) == 0)
487 battery_submit (plugin_instance, "power", v * SYSFS_FACTOR);
489 if (sysfs_file_to_gauge (dir, power_supply, "current_now", &v) == 0)
493 battery_submit (plugin_instance, "current", v * SYSFS_FACTOR);
496 if (sysfs_file_to_gauge (dir, power_supply, "voltage_now", &v) == 0)
497 battery_submit (plugin_instance, "voltage", v * SYSFS_FACTOR);
500 } /* }}} int read_sysfs_callback */
502 static int read_sysfs (void) /* {{{ */
505 int battery_counter = 0;
507 if (access (SYSFS_PATH, R_OK) != 0)
510 status = walk_directory (SYSFS_PATH, read_sysfs_callback,
511 /* user_data = */ &battery_counter,
512 /* include hidden */ 0);
514 } /* }}} int read_sysfs */
516 static int read_acpi_full_capacity (char const *dir, /* {{{ */
517 char const *power_supply,
518 gauge_t *ret_capacity_full,
519 gauge_t *ret_capacity_design)
522 char filename[PATH_MAX];
527 ssnprintf (filename, sizeof (filename), "%s/%s/info", dir, power_supply);
528 fh = fopen (filename, "r");
532 /* last full capacity: 40090 mWh */
533 while (fgets (buffer, sizeof (buffer), fh) != NULL)
540 if (strncmp ("last full capacity:", buffer, strlen ("last full capacity:")) == 0)
542 value_ptr = ret_capacity_full;
545 else if (strncmp ("design capacity:", buffer, strlen ("design capacity:")) == 0)
547 value_ptr = ret_capacity_design;
555 fields_num = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
556 if (fields_num <= index)
559 strtogauge (fields[index], value_ptr);
564 } /* }}} int read_acpi_full_capacity */
566 static int read_acpi_callback (char const *dir, /* {{{ */
567 char const *power_supply,
570 int *battery_index = user_data;
573 gauge_t voltage = NAN;
574 gauge_t capacity_charged = NAN;
575 gauge_t capacity_full = NAN;
576 gauge_t capacity_design = NAN;
578 _Bool is_current = 0;
580 char const *plugin_instance;
581 char filename[PATH_MAX];
586 ssnprintf (filename, sizeof (filename), "%s/%s/state", dir, power_supply);
587 fh = fopen (filename, "r");
590 if ((errno == EAGAIN) || (errno == EINTR) || (errno == ENOENT))
597 * [11:00] <@tokkee> $ cat /proc/acpi/battery/BAT1/state
598 * [11:00] <@tokkee> present: yes
599 * [11:00] <@tokkee> capacity state: ok
600 * [11:00] <@tokkee> charging state: charging
601 * [11:00] <@tokkee> present rate: 1724 mA
602 * [11:00] <@tokkee> remaining capacity: 4136 mAh
603 * [11:00] <@tokkee> present voltage: 12428 mV
605 while (fgets (buffer, sizeof (buffer), fh) != NULL)
610 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
614 if ((strcmp (fields[0], "charging") == 0)
615 && (strcmp (fields[1], "state:") == 0))
617 if (strcmp (fields[2], "charging") == 0)
624 /* The unit of "present rate" depends on the battery. Modern
625 * batteries export power (watts), older batteries (used to)
626 * export current (amperes). We check the fourth column and try
627 * to find old batteries this way. */
628 if ((strcmp (fields[0], "present") == 0)
629 && (strcmp (fields[1], "rate:") == 0))
631 strtogauge (fields[2], &power);
633 if ((numfields >= 4) && (strcmp ("mA", fields[3]) == 0))
636 else if ((strcmp (fields[0], "remaining") == 0)
637 && (strcmp (fields[1], "capacity:") == 0))
638 strtogauge (fields[2], &capacity_charged);
639 else if ((strcmp (fields[0], "present") == 0)
640 && (strcmp (fields[1], "voltage:") == 0))
641 strtogauge (fields[2], &voltage);
642 } /* while (fgets (buffer, sizeof (buffer), fh) != NULL) */
649 /* FIXME: This is a dirty hack for backwards compatibility: The battery
650 * plugin, for a very long time, has had the plugin_instance
651 * hard-coded to "0". So, to keep backwards compatibility, we'll use
652 * "0" for the first battery we find and the power_supply name for all
653 * following. This should be reverted in a future major version. */
654 plugin_instance = (*battery_index == 0) ? "0" : power_supply;
657 read_acpi_full_capacity (dir, power_supply, &capacity_full, &capacity_design);
659 submit_capacity (plugin_instance,
660 capacity_charged * PROC_ACPI_FACTOR,
661 capacity_full * PROC_ACPI_FACTOR,
662 capacity_design * PROC_ACPI_FACTOR);
664 battery_submit (plugin_instance,
665 is_current ? "current" : "power",
666 power * PROC_ACPI_FACTOR);
667 battery_submit (plugin_instance, "voltage", voltage * PROC_ACPI_FACTOR);
670 } /* }}} int read_acpi_callback */
672 static int read_acpi (void) /* {{{ */
675 int battery_counter = 0;
677 if (access (PROC_ACPI_PATH, R_OK) != 0)
680 status = walk_directory (PROC_ACPI_PATH, read_acpi_callback,
681 /* user_data = */ &battery_counter,
682 /* include hidden */ 0);
684 } /* }}} int read_acpi */
686 static int read_pmu (void) /* {{{ */
689 /* The upper limit here is just a safeguard. If there is a system with
690 * more than 100 batteries, this can easily be increased. */
696 char filename[PATH_MAX];
697 char plugin_instance[DATA_MAX_NAME_LEN];
699 gauge_t current = NAN;
700 gauge_t voltage = NAN;
701 gauge_t charge = NAN;
703 ssnprintf (filename, sizeof (filename), PROC_PMU_PATH_FORMAT, i);
704 if (access (filename, R_OK) != 0)
707 ssnprintf (plugin_instance, sizeof (plugin_instance), "%i", i);
709 fh = fopen (filename, "r");
714 else if ((errno == EAGAIN) || (errno == EINTR))
720 while (fgets (buffer, sizeof (buffer), fh) != NULL)
725 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
729 if (strcmp ("current", fields[0]) == 0)
730 strtogauge (fields[2], ¤t);
731 else if (strcmp ("voltage", fields[0]) == 0)
732 strtogauge (fields[2], &voltage);
733 else if (strcmp ("charge", fields[0]) == 0)
734 strtogauge (fields[2], &charge);
740 battery_submit (plugin_instance, "charge", charge / 1000.0);
741 battery_submit (plugin_instance, "current", current / 1000.0);
742 battery_submit (plugin_instance, "voltage", voltage / 1000.0);
748 } /* }}} int read_pmu */
750 static int battery_read (void) /* {{{ */
755 return battery_read_statefs ();
757 DEBUG ("battery plugin: Trying sysfs ...");
758 status = read_sysfs ();
762 DEBUG ("battery plugin: Trying acpi ...");
763 status = read_acpi ();
767 DEBUG ("battery plugin: Trying pmu ...");
768 status = read_pmu ();
772 ERROR ("battery plugin: Add available input methods failed.");
774 } /* }}} int battery_read */
775 #endif /* KERNEL_LINUX */
777 static int battery_config (oconfig_item_t *ci)
779 for (int i = 0; i < ci->children_num; i++)
781 oconfig_item_t *child = ci->children + i;
783 if (strcasecmp ("ValuesPercentage", child->key) == 0)
784 cf_util_get_boolean (child, &report_percent);
785 else if (strcasecmp ("ReportDegraded", child->key) == 0)
786 cf_util_get_boolean (child, &report_degraded);
787 else if (strcasecmp ("QueryStateFS", child->key) == 0)
788 cf_util_get_boolean (child, &query_statefs);
790 WARNING ("battery plugin: Ignoring unknown "
791 "configuration option \"%s\".",
796 } /* }}} int battery_config */
798 void module_register (void)
800 plugin_register_complex_config ("battery", battery_config);
801 plugin_register_read ("battery", battery_read);
802 } /* void module_register */