Merge lp:~sforshee/powerd/low-battery-shutdown into lp:powerd

[Seth Forshee]

Add shutdown on critically low battery, using upower for battery information (LP: 1123387)

Add shutdown on critically low battery, using upower for battery information (LP: 1123387)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:71
http://jenkins.qa.ubuntu.com/job/powerd-ci/90/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/powerd-saucy-armhf-ci/44
        deb: http://jenkins.qa.ubuntu.com/job/powerd-saucy-armhf-ci/44/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/powerd-ci/90/rebuild

review: Approve (continuous-integration)

[Matt Fischer (mfisch)]

124 + /*
125 + * Android shuts down when percentage reaches 0. We
126 + * use 1% to leave a little more headroom.
127 + */

Do we know how much less life this gives us?

134 + if (shutdown) {
135 + powerd_warn("Initiating emergency shutdown");
136 + powerd_shutdown();
137 + }

Can we or someone pop-up a GUI warning?

Can we add this to the test plan?

148 + ret = up_client_enumerate_devices_sync(up_client, NULL, NULL);
Does this delay initialization? Should we use async instead or do we need to delay other stuff on this finishing. My guess is we could use async but I don't know how much it gains us.

How often is the device changed CB Called? every percent, every 0.1 percent?

[Seth Forshee (sforshee)]

> 124 + /*
> 125 + * Android shuts down when percentage reaches 0. We
> 126 + * use 1% to leave a little more headroom.
> 127 + */
>
> Do we know how much less life this gives us?

No. It depends on too many factors, namely the size of the battery and what the system seems to be doing at the time you ask the question. upower tries to estimate time-to-empty, but I collected a lot of data and found that the estimate jumps around too much to really be all that useful for deciding when to shut down. The only thing that appeared to be even somewhat reliable was percent capacity remaining.

> 134 + if (shutdown) {
> 135 + powerd_warn("Initiating emergency shutdown");
> 136 + powerd_shutdown();
> 137 + }
>
> Can we or someone pop-up a GUI warning?

Well, powerd can't. What I expect this to be is the "oh crap" option. I.e., something higher level should do the nicey-nice, prompt the user shutdown before it gets this far. When this shutdown is triggered we just need to get it done.

> Can we add this to the test plan?

Sure.

> 148 + ret = up_client_enumerate_devices_sync(up_client, NULL, NULL);
> Does this delay initialization? Should we use async instead or do we need to
> delay other stuff on this finishing. My guess is we could use async but I
> don't know how much it gains us.

There is no async option, afaict. Unless the library is going to take care of it for us if we don't call this function. I couldn't tell because the documentation really isn't very informative.

> How often is the device changed CB Called? every percent, every 0.1 percent?

I suspect this mostly depends on how often the data from the drivers change. Empirically I can say that it varies from device to device. One device had big batches of changes at high frequency, but on an on-going basis I never saw updates happening more frequently than once every few seconds.

[Matt Fischer (mfisch)]

My only thought is that in the future we may want to adjust the threshold. Is it worth making a gsetting for now? Can you do half percentages?

But per discussion on IRC, we can skip this for now, until it is needed.

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-07-02 16:43:23 +0000
+++ CMakeLists.txt	2013-07-15 20:52:30 +0000
@@ -22,6 +22,7 @@
 pkg_check_modules(GIO gio-2.0)
 pkg_check_modules(GIO-UNIX gio-unix-2.0)
 pkg_check_modules(LIBUDEV libudev)
+pkg_check_modules(UPOWER_GLIB upower-glib)
 pkg_check_modules(UUID uuid)
 
 set(POWERD_GENERATED_SOURCES
@@ -42,6 +43,7 @@
   src/log.c
   src/powerd-object.c
   src/power-request.c
+  src/power-source.c
   src/powerd-sensors.cpp
   src/util.c
   src/${GDBUS_NAME}.c
@@ -52,6 +54,7 @@
   ${GIO_LIBRARY_DIRS}
   ${GIO-UNIX_LIBRARY_DIRS}
   ${LIBUDEV_LIBRARY_DIRS}
+  ${UPOWER_GLIB_LIBRARY_DIRS}
   ${UUID_LIBRARY_DIRS}
 )
 
@@ -60,6 +63,7 @@
   ${GIO_INCLUDE_DIRS}
   ${GIO-UNIX_INCLUDE_DIRS}
   ${LIBUDEV_INCLUDE_DIRS}
+  ${UPOWER_GLIB_INCLUDE_DIRS}
   ${UUID_INCLUDE_DIRS}
   ${PROJECT_SOURCE_DIR}/libsuspend
   ${CMAKE_CURRENT_BINARY_DIR}/src
@@ -99,6 +103,7 @@
   ${PHABLET_LIBRARIES}
   "-lubuntu_application_api"
   ${LIBUDEV_LIBRARIES}
+  ${UPOWER_GLIB_LIBRARIES}
   ${UUID_LIBRARIES}
 )
 

=== modified file 'debian/control'
--- debian/control	2013-07-02 13:07:44 +0000
+++ debian/control	2013-07-15 20:52:30 +0000
@@ -10,6 +10,7 @@
                libudev-dev,
                python,
                libplatform-api1-dev,
+               libupower-glib-dev,
                uuid-dev,
 Standards-Version: 3.9.4
 Homepage: https://launchpad.net/powerd
@@ -19,7 +20,7 @@
 
 Package: powerd
 Architecture: any
-Depends: ${misc:Depends}, ${shlibs:Depends}
+Depends: ${misc:Depends}, ${shlibs:Depends}, upower
 Recommends: ofono
 Description: Power daemon to monitor and control system and display power state
  This daemon monitors and controls system and display power states for Ubuntu

=== added file 'src/power-source.c'
--- src/power-source.c	1970-01-01 00:00:00 +0000
+++ src/power-source.c	2013-07-15 20:52:30 +0000
@@ -0,0 +1,91 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This file is part of powerd.
+ *
+ * powerd is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * powerd is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <errno.h>
+#include <glib.h>
+#include <libupower-glib/upower.h>
+
+#include "powerd-internal.h"
+#include "log.h"
+
+static UpClient *up_client;
+
+static void up_device_changed_cb(UpClient *client, UpDevice *device,
+                                 gpointer unused)
+{
+    gboolean on_battery;
+    GPtrArray *devices;
+    int i;
+    gboolean shutdown = TRUE;
+
+    g_object_get(up_client,
+                 "on_battery", &on_battery,
+                 NULL);
+    if (!on_battery)
+        return;
+    devices = up_client_get_devices(up_client);
+    for (i = 0; i < devices->len; i++) {
+        UpDevice *device = g_ptr_array_index(devices, i);
+        UpDeviceKind kind;
+        gboolean is_present;
+        g_object_get(device,
+                     "kind", &kind,
+                     "is-present", &is_present,
+                     NULL);
+        if (kind == UP_DEVICE_KIND_BATTERY && is_present) {
+            double percentage;
+            g_object_get(device,
+                         "percentage", &percentage,
+                         NULL);
+            /*
+             * Android shuts down when percentage reaches 0. We
+             * use 1% to leave a little more headroom.
+             */
+            if (percentage > 1.0) {
+                shutdown = FALSE;
+                break;
+            }
+        }
+    }
+    if (shutdown) {
+        powerd_warn("Initiating emergency shutdown");
+        powerd_shutdown();
+    }
+}
+
+int powerd_ps_init(void)
+{
+    gboolean ret;
+    up_client = up_client_new();
+    if (!up_client) {
+        powerd_warn("Could not allocate upower client");
+        return -ENODEV;
+    }
+    ret = up_client_enumerate_devices_sync(up_client, NULL, NULL);
+    if (!ret)
+        powerd_warn("Could not enumerate upower devices");
+    g_signal_connect(up_client, "device-changed",
+                     G_CALLBACK(up_device_changed_cb), NULL);
+    return 0;
+}
+
+void powerd_ps_deinit(void)
+{
+    if (up_client)
+        g_object_unref(up_client);
+}

=== modified file 'src/powerd-internal.h'
--- src/powerd-internal.h	2013-07-10 19:12:51 +0000
+++ src/powerd-internal.h	2013-07-15 20:52:30 +0000
@@ -57,6 +57,7 @@
     GSList *uuids;
 };
 
+void powerd_shutdown(void);
 void powerd_exit(int exit_code);
 void powerd_reset_activity_timer(int add);
 void powerd_dbus_init_complete(void);
@@ -150,6 +151,10 @@
 void powerd_sensors_proximity_enable(void);
 void powerd_sensors_proximity_disable(void);
 
+/* Power source functions */
+int powerd_ps_init(void);
+void powerd_ps_deinit(void);
+
 /* Utility functions */
 int powerd_run_mainloop_sync(int (*func)(gpointer), gpointer data);
 guint powerd_uuid_hash(gconstpointer key);

=== modified file 'src/powerd.cpp'
--- src/powerd.cpp	2013-07-10 23:27:14 +0000
+++ src/powerd.cpp	2013-07-15 20:52:30 +0000
@@ -123,15 +123,11 @@
 
 gboolean call_shutdown(gpointer data)
 {
-    static char poweroff_cmd[] = "poweroff";
-    gchar   *argv[] = {poweroff_cmd,
-                        NULL};
-
     if (button_state == BUTTON_DOWN) {
         button_state = SHUTDOWN;
         powerd_set_brightness(0);
         sf_blank(0);
-        g_spawn_async(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL, NULL, NULL);
+        powerd_shutdown();
     }
 
     return FALSE;
@@ -416,6 +412,13 @@
     return (g_thread_self() == powerd_mainloop_thread);
 }
 
+void powerd_shutdown(void)
+{
+    static char poweroff_cmd[] = "poweroff";
+    char *argv[] = {poweroff_cmd, NULL};
+    g_spawn_async(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL, NULL, NULL);
+}
+
 void powerd_exit(int exit_code)
 {
     g_exit_code = exit_code;
@@ -476,6 +479,7 @@
     powerd_backlight_init();
     powerd_display_init();
     powerd_sensors_init();
+    powerd_ps_init();
 
     main_loop = g_main_loop_new (NULL, FALSE);
     signal(SIGTERM, sigterm_quit);
@@ -502,6 +506,7 @@
     android_input_stack_stop();
     android_input_stack_shutdown();
 
+    powerd_ps_deinit();
     dbus_name_watch_deinit();
     powerd_backlight_deinit();
     display_request_deinit();