summaryrefslogtreecommitdiff
path: root/buildscripts/resmokelib/utils/scheduler.py
blob: 04abafcd330ca8cd9e4cb746227450a999f98fe4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
"""Thread-safe version of sched.scheduler; the class wasn't made thread-safe until Python 3.3."""

from __future__ import absolute_import

import heapq
import sched
import threading


class Scheduler(sched.scheduler):
    """A thread-safe, general purpose event scheduler."""

    def __init__(self, timefunc, delayfunc):
        """Initialize Scheduler."""
        sched.scheduler.__init__(self, timefunc, delayfunc)

        # We use a recursive lock because sched.scheduler.enter() calls sched.scheduler.enterabs().
        self._queue_lock = threading.RLock()

    def enterabs(self, time, priority, action, argument):
        """Enterabs."""
        with self._queue_lock:
            return sched.scheduler.enterabs(self, time, priority, action, argument)

    def enter(self, delay, priority, action, argument):
        """Enter."""
        with self._queue_lock:
            return sched.scheduler.enter(self, delay, priority, action, argument)

    def cancel(self, event):
        """Cancel."""
        with self._queue_lock:
            return sched.scheduler.cancel(self, event)

    def empty(self):
        """Empty."""
        with self._queue_lock:
            return sched.scheduler.empty(self)

    # The implementation for the run() method was adapted from sched.scheduler.run() in Python 3.6.
    def run(self):
        """Run."""
        while True:
            with self._queue_lock:
                if not self._queue:
                    break

                now = self.timefunc()
                event = self._queue[0]

                should_execute = event.time <= now
                if should_execute:
                    heapq.heappop(self._queue)

            if should_execute:
                event.action(*event.argument)

                # sched.scheduler calls delayfunc(0) in order to yield the CPU and let other threads
                # run, so we do the same here.
                self.delayfunc(0)
            else:
                self.delayfunc(event.time - now)

    @property
    def queue(self):
        """Get Queue."""
        with self._queue_lock:
            return sched.scheduler.queue.fget(self)