Merge lp:~chipaca/ubuntuone-client/holy-reactionary-reactors-batman into lp:ubuntuone-client

[John Lenton]

Use a subclass of Gtk2Reactor that uses low-res timers, for lower power consumption.

[John Lenton (chipaca)]

This subclasses twisted.internet.gtk2reactor.Gtk2Reactor so we use timeout_add_seconds instead of timeout_add. This lowers the wakeups-per-second of both ubuntuone-syncdaemon and the applet by ONE MILLION THREE HUNDRED THOUSAND AND THIRTY EIGHT PERCENT.

Dobey quite rightly points out that for the applet, the right fix would be to fix oauthdesktop to use SimpleHTTPServer instead of the twisted server. He's right, as is usually the case, but he gets this for free, today.

[Elliot Murphy (statik)]

the percentage convinced me.

review: Approve

[Guillermo Gonzalez (verterok)]

+1
I want to run syncdaemon on my smartphone (once I buy it :p )

review: Approve

=== modified file 'bin/ubuntuone-client-applet'
--- bin/ubuntuone-client-applet	2009-08-12 20:50:32 +0000
+++ bin/ubuntuone-client-applet	2009-08-14 19:05:13 +0000
@@ -69,8 +69,8 @@
 
       def __init__(self, *args, **kw):
             """Initializes the child threads and dbus monitor."""
-            from twisted.internet import gtk2reactor
-            gtk2reactor.install()
+            from ubuntuone.syncdaemon import sdreactor
+            sdreactor.install(use_gtk=True)
             login = Login(dbus.service.BusName(DBUS_IFACE_AUTH_NAME,
                                                bus=dbus.SessionBus()))
 

=== modified file 'bin/ubuntuone-syncdaemon'
--- bin/ubuntuone-syncdaemon	2009-08-13 02:46:53 +0000
+++ bin/ubuntuone-syncdaemon	2009-08-14 19:05:13 +0000
@@ -18,8 +18,8 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from twisted.internet import glib2reactor
-glib2reactor.install()
+from ubuntuone.syncdaemon import sdreactor
+sdreactor.install(use_gtk=False)
 
 import atexit
 import dbus

=== added file 'ubuntuone/syncdaemon/sdreactor.py'
--- ubuntuone/syncdaemon/sdreactor.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/syncdaemon/sdreactor.py	2009-08-14 19:52:25 +0000
@@ -0,0 +1,79 @@
+"""
+The SyncDaemon reactor -- a less power-hungry version of twisted's gtk2reactor
+"""
+#
+# This is the quickest way to make twisted's Gtk2Reactor use
+# timeout_add_seconds instead of timeout_add; the former uses high-resolution
+# timers, which are more power-intensive.
+# It's pretty much verbatim from their source.
+
+from twisted.python import log
+from twisted.internet.main import installReactor
+from twisted.internet.gtk2reactor import Gtk2Reactor
+import gobject
+
+class SyncDaemonReactor(Gtk2Reactor):
+    """
+    This is twisted.internet.Gtk2Reactor, but using timeout_add_seconds
+    instead of timeout_add.
+    """
+    def __init__(self, use_gtk):
+        Gtk2Reactor.__init__(self, use_gtk)
+        # ugh... why would somebody make these private?
+        self.__iteration = self._Gtk2Reactor__iteration
+        self.__pending = self._Gtk2Reactor__pending
+        self.__run = self._Gtk2Reactor__run
+
+    def doIteration(self, delay):
+        """
+        Process some events
+        """
+        log.msg(channel='system', event='iteration', reactor=self)
+        if self.__pending():
+            self.__iteration(0)
+            return
+        # nothing to do, must delay
+        if delay == 0:
+            return # shouldn't delay, so just return
+        self.doIterationTimer = gobject.timeout_add_seconds(
+            int(delay), self.doIterationTimeout)
+        # This will either wake up from IO or from a timeout.
+        self.__iteration(1) # block
+        # note: with the .simulate timer below, delays > 0.1 will always be
+        # woken up by the .simulate timer
+        if self.doIterationTimer:
+            # if woken by IO, need to cancel the timer
+            gobject.source_remove(self.doIterationTimer)
+            self.doIterationTimer = None
+
+    def run(self, installSignalHandlers=1):
+        """
+        See IReactorCore.run
+        """
+        self.startRunning(installSignalHandlers=installSignalHandlers)
+        gobject.timeout_add_seconds(0, self.simulate)
+        if self._started:
+            self.__run()
+
+
+    def simulate(self):
+        """
+        Run simulation loops and reschedule callbacks.
+        """
+        if self._simtag is not None:
+            gobject.source_remove(self._simtag)
+        self.runUntilCurrent()
+        timeout = min(self.timeout(), 0.1)
+        if timeout is None:
+            timeout = 0.1
+        # grumble
+        self._simtag = gobject.timeout_add_seconds(int(timeout * 1010/1000),
+                                                   self.simulate)
+
+
+def install(use_gtk):
+    """
+    Configure the twisted mainloop to be run inside the glib mainloop.
+    If use_gtk, then use the gtk mainloop instead.
+    """
+    installReactor(SyncDaemonReactor(use_gtk))