/usr/share/pyshared/ClusterShell/Engine/EPoll.py is in clustershell 1.6-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | #
# Copyright CEA/DAM/DIF (2009, 2010, 2011)
# Contributor: Stephane THIELL <stephane.thiell@cea.fr>
#
# This file is part of the ClusterShell library.
#
# This software is governed by the CeCILL-C license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL-C
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL-C license and that you accept its terms.
"""
A ClusterShell Engine using epoll, an I/O event notification facility.
The epoll event distribution interface is available on Linux 2.6, and
has been included in Python 2.6.
"""
import errno
import select
import time
from ClusterShell.Engine.Engine import Engine
from ClusterShell.Engine.Engine import EngineNotSupportedError
from ClusterShell.Engine.Engine import EngineTimeoutException
from ClusterShell.Worker.EngineClient import EngineClientEOF
class EngineEPoll(Engine):
"""
EPoll Engine
ClusterShell Engine class using the select.epoll mechanism.
"""
identifier = "epoll"
def __init__(self, info):
"""
Initialize Engine.
"""
Engine.__init__(self, info)
try:
# get an epoll object
self.epolling = select.epoll()
except AttributeError:
raise EngineNotSupportedError(EngineEPoll.identifier)
def _register_specific(self, fd, event):
"""
Engine-specific fd registering. Called by Engine register.
"""
if event & (Engine.E_READ | Engine.E_ERROR):
eventmask = select.EPOLLIN
elif event == Engine.E_WRITE:
eventmask = select.EPOLLOUT
self.epolling.register(fd, eventmask)
def _unregister_specific(self, fd, ev_is_set):
"""
Engine-specific fd unregistering. Called by Engine unregister.
"""
self._debug("UNREGSPEC fd=%d ev_is_set=%x"% (fd, ev_is_set))
if ev_is_set:
self.epolling.unregister(fd)
def _modify_specific(self, fd, event, setvalue):
"""
Engine-specific modifications after a interesting event change for
a file descriptor. Called automatically by Engine set_events().
For the epoll engine, it modifies the event mask associated to a file
descriptor.
"""
self._debug("MODSPEC fd=%d event=%x setvalue=%d" % (fd, event,
setvalue))
eventmask = 0
if setvalue:
if event & (Engine.E_READ | Engine.E_ERROR):
eventmask = select.EPOLLIN
elif event == Engine.E_WRITE:
eventmask = select.EPOLLOUT
self.epolling.register(fd, eventmask)
else:
self.epolling.unregister(fd)
def runloop(self, timeout):
"""
Run epoll main loop.
"""
if timeout == 0:
timeout = -1
start_time = time.time()
# run main event loop...
while self.evlooprefcnt > 0:
self._debug("LOOP evlooprefcnt=%d (reg_clifds=%s) (timers=%d)" % \
(self.evlooprefcnt, self.reg_clifds.keys(),
len(self.timerq)))
try:
timeo = self.timerq.nextfire_delay()
if timeout > 0 and timeo >= timeout:
# task timeout may invalidate clients timeout
self.timerq.clear()
timeo = timeout
elif timeo == -1:
timeo = timeout
self._current_loopcnt += 1
evlist = self.epolling.poll(timeo + 0.001)
except IOError, ex:
# might get interrupted by a signal
if ex.errno == errno.EINTR:
continue
for fd, event in evlist:
# get client instance
client, fdev = self._fd2client(fd)
if client is None:
continue
# set as current processed client
self._current_client = client
# check for poll error condition of some sort
if event & select.EPOLLERR:
self._debug("EPOLLERR %s" % client)
client._close_writer()
self._current_client = None
continue
# check for data to read
if event & select.EPOLLIN:
#self._debug("EPOLLIN fd=%d %s" % (fd, client))
assert fdev & (Engine.E_READ | Engine.E_ERROR)
assert client._events & fdev
self.modify(client, 0, fdev)
try:
if fdev & Engine.E_READ:
client._handle_read()
else:
client._handle_error()
except EngineClientEOF:
self._debug("EngineClientEOF %s" % client)
if fdev & Engine.E_READ:
self.remove(client)
self._current_client = None
continue
# or check for end of stream (do not handle both at the same
# time because handle_read() may perform a partial read)
elif event & select.EPOLLHUP:
self._debug("EPOLLHUP fd=%d %s (r%s,e%s,w%s)" % (fd,
client.__class__.__name__, client.fd_reader,
client.fd_error, client.fd_writer))
if fdev & Engine.E_READ:
if client._events & Engine.E_ERROR:
self.modify(client, 0, fdev)
else:
self.remove(client)
else:
if client._events & Engine.E_READ:
self.modify(client, 0, fdev)
else:
self.remove(client)
# check for writing
if event & select.EPOLLOUT:
self._debug("EPOLLOUT fd=%d %s (r%s,e%s,w%s)" % (fd,
client.__class__.__name__, client.fd_reader,
client.fd_error, client.fd_writer))
assert fdev == Engine.E_WRITE
assert client._events & fdev
self.modify(client, 0, fdev)
client._handle_write()
self._current_client = None
# apply any changes occured during processing
if client.registered:
self.set_events(client, client._new_events)
# check for task runloop timeout
if timeout > 0 and time.time() >= start_time + timeout:
raise EngineTimeoutException()
# process clients timeout
self.fire_timers()
self._debug("LOOP EXIT evlooprefcnt=%d (reg_clifds=%s) (timers=%d)" % \
(self.evlooprefcnt, self.reg_clifds, len(self.timerq)))
|