/usr/lib/python2.7/dist-packages/parallax/manager.py is in python-parallax 1.0.3-1.
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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 | # Copyright (c) 2009-2012, Andrew McNabb
# Copyright (c) 2013, Kristoffer Gronlund
from errno import EINTR
import os
import select
import signal
import sys
import threading
import copy
import fcntl
try:
import queue
except ImportError:
import Queue as queue
from parallax.askpass_server import PasswordServer
from parallax import psshutil
from parallax import DEFAULT_PARALLELISM, DEFAULT_TIMEOUT
from parallax.callbacks import DefaultCallbacks
READ_SIZE = 1 << 16
class FatalError(RuntimeError):
"""A fatal error in the Parallax SSH Manager."""
pass
class Manager(object):
"""Executes tasks concurrently.
Tasks are added with add_task() and executed in parallel with run().
Returns a list of the exit statuses of the processes.
Arguments:
limit: Maximum number of commands running at once.
timeout: Maximum allowed execution time in seconds.
"""
def __init__(self,
limit=DEFAULT_PARALLELISM,
timeout=DEFAULT_TIMEOUT,
askpass=False,
outdir=None,
errdir=None,
callbacks=DefaultCallbacks()):
# Backwards compatibility with old __init__
# format: Only argument is an options dict
if not isinstance(limit, int):
if hasattr(limit, 'limit'):
self.limit = limit.limit
elif hasattr(limit, 'par'):
self.limit = limit.par
else:
self.limit = DEFAULT_PARALLELISM
if hasattr(limit, 'timeout'):
self.timeout = limit.timeout
else:
self.timeout = DEFAULT_TIMEOUT
if hasattr(limit, 'askpass'):
self.askpass = limit.askpass
else:
self.askpass = False
if hasattr(limit, 'outdir'):
self.outdir = limit.outdir
else:
self.outdir = None
if hasattr(limit, 'errdir'):
self.errdir = limit.errdir
else:
self.errdir = None
else:
self.limit = limit
self.timeout = timeout
self.askpass = askpass
self.outdir = outdir
self.errdir = errdir
self.iomap = make_iomap()
self.callbacks = callbacks
self.taskcount = 0
self.tasks = []
self.save_tasks = []
self.running = []
self.done = []
self.askpass_socket = None
def run(self):
"""Processes tasks previously added with add_task."""
self.save_tasks = copy.copy(self.tasks)
try:
if self.outdir or self.errdir:
writer = Writer(self.outdir, self.errdir)
writer.start()
else:
writer = None
if self.askpass:
pass_server = PasswordServer()
pass_server.start(self.iomap, self.limit)
self.askpass_socket = pass_server.address
self.set_sigchld_handler()
try:
self.update_tasks(writer)
wait = None
while self.running or self.tasks:
# Opt for efficiency over subsecond timeout accuracy.
if wait is None or wait < 1:
wait = 1
self.iomap.poll(wait)
self.update_tasks(writer)
wait = self.check_timeout()
except KeyboardInterrupt:
# This exception handler tries to clean things up and prints
# out a nice status message for each interrupted host.
self.interrupted()
except KeyboardInterrupt:
# This exception handler doesn't print out any fancy status
# information--it just stops.
pass
if writer:
writer.signal_quit()
writer.join()
return self.callbacks.result(self)
def clear_sigchld_handler(self):
signal.signal(signal.SIGCHLD, signal.SIG_DFL)
def set_sigchld_handler(self):
# TODO: find out whether set_wakeup_fd still works if the default
# signal handler is used (I'm pretty sure it doesn't work if the
# signal is ignored).
signal.signal(signal.SIGCHLD, self.handle_sigchld)
# This should keep reads and writes from getting EINTR.
if hasattr(signal, 'siginterrupt'):
signal.siginterrupt(signal.SIGCHLD, False)
def handle_sigchld(self, number, frame):
"""Apparently we need a sigchld handler to make set_wakeup_fd work."""
# Write to the signal pipe (only for Python <2.5, where the
# set_wakeup_fd method doesn't exist).
if self.iomap.wakeup_writefd:
os.write(self.iomap.wakeup_writefd, '\0')
for task in self.running:
if task.proc:
task.proc.poll()
# Apparently some UNIX systems automatically reset the SIGCHLD
# handler to SIG_DFL. Reset it just in case.
self.set_sigchld_handler()
def add_task(self, task):
"""Adds a Task to be processed with run()."""
self.tasks.append(task)
def update_tasks(self, writer):
"""Reaps tasks and starts as many new ones as allowed."""
# Mask signals to work around a Python bug:
# http://bugs.python.org/issue1068268
# Since sigprocmask isn't in the stdlib, clear the SIGCHLD handler.
# Since signals are masked, reap_tasks needs to be called once for
# each loop.
keep_running = True
while keep_running:
self.clear_sigchld_handler()
self._start_tasks_once(writer)
self.set_sigchld_handler()
keep_running = self.reap_tasks()
def _start_tasks_once(self, writer):
"""Starts tasks once.
Due to http://bugs.python.org/issue1068268, signals must be masked
when this method is called.
"""
while self.tasks and len(self.running) < self.limit:
task = self.tasks.pop(0)
self.running.append(task)
task.start(self.taskcount, self.iomap, writer, self.askpass_socket)
self.taskcount += 1
def reap_tasks(self):
"""Checks to see if any tasks have terminated.
After cleaning up, returns the number of tasks that finished.
"""
still_running = []
finished_count = 0
for task in self.running:
if task.running():
still_running.append(task)
else:
self.finished(task)
finished_count += 1
self.running = still_running
return finished_count
def check_timeout(self):
"""Kills timed-out processes and returns the lowest time left."""
if self.timeout <= 0:
return None
min_timeleft = None
for task in self.running:
timeleft = self.timeout - task.elapsed()
if timeleft <= 0:
task.timedout()
continue
if min_timeleft is None or timeleft < min_timeleft:
min_timeleft = timeleft
if min_timeleft is None:
return 0
return max(0, min_timeleft)
def interrupted(self):
"""Cleans up after a keyboard interrupt."""
for task in self.running:
task.interrupted()
self.finished(task)
for task in self.tasks:
task.cancel()
self.finished(task)
def finished(self, task):
"""Marks a task as complete and reports its status as finished."""
self.done.append(task)
n = len(self.done)
self.callbacks.finished(task, n)
class IOMap(object):
"""A manager for file descriptors and their associated handlers.
The poll method dispatches events to the appropriate handlers.
"""
def __init__(self):
self.readmap = {}
self.writemap = {}
# Setup the wakeup file descriptor to avoid hanging on lost signals.
wakeup_readfd, wakeup_writefd = os.pipe()
fcntl.fcntl(wakeup_writefd, fcntl.F_SETFL, os.O_NONBLOCK)
self.register_read(wakeup_readfd, self.wakeup_handler)
# TODO: remove test when we stop supporting Python <2.5
if hasattr(signal, 'set_wakeup_fd'):
signal.set_wakeup_fd(wakeup_writefd)
self.wakeup_writefd = None
else:
self.wakeup_writefd = wakeup_writefd
def register_read(self, fd, handler):
"""Registers an IO handler for a file descriptor for reading."""
self.readmap[fd] = handler
def register_write(self, fd, handler):
"""Registers an IO handler for a file descriptor for writing."""
self.writemap[fd] = handler
def unregister(self, fd):
"""Unregisters the given file descriptor."""
if fd in self.readmap:
del self.readmap[fd]
if fd in self.writemap:
del self.writemap[fd]
def poll(self, timeout=None):
"""Performs a poll and dispatches the resulting events."""
if not self.readmap and not self.writemap:
return
rlist = list(self.readmap)
wlist = list(self.writemap)
try:
rlist, wlist, _ = select.select(rlist, wlist, [], timeout)
except select.error:
_, e, _ = sys.exc_info()
errno = e.args[0]
if errno == EINTR:
return
else:
raise
for fd in rlist:
handler = self.readmap[fd]
handler(fd, self)
for fd in wlist:
handler = self.writemap[fd]
handler(fd, self)
def wakeup_handler(self, fd, iomap):
"""Handles read events on the signal wakeup pipe.
This ensures that SIGCHLD signals aren't lost.
"""
try:
os.read(fd, READ_SIZE)
except (OSError, IOError):
_, e, _ = sys.exc_info()
errno, message = e.args
if errno != EINTR:
sys.stderr.write('Fatal error reading from wakeup pipe: %s\n'
% message)
raise FatalError
class PollIOMap(IOMap):
"""A manager for file descriptors and their associated handlers.
The poll method dispatches events to the appropriate handlers.
Note that `select.poll` is not available on all operating systems.
"""
def __init__(self):
self._poller = select.poll()
super(PollIOMap, self).__init__()
def register_read(self, fd, handler):
"""Registers an IO handler for a file descriptor for reading."""
super(PollIOMap, self).register_read(fd, handler)
self._poller.register(fd, select.POLLIN)
def register_write(self, fd, handler):
"""Registers an IO handler for a file descriptor for writing."""
super(PollIOMap, self).register_write(fd, handler)
self._poller.register(fd, select.POLLOUT)
def unregister(self, fd):
"""Unregisters the given file descriptor."""
super(PollIOMap, self).unregister(fd)
self._poller.unregister(fd)
def poll(self, timeout=None):
"""Performs a poll and dispatches the resulting events."""
if not self.readmap and not self.writemap:
return
try:
event_list = self._poller.poll(timeout)
except select.error:
_, e, _ = sys.exc_info()
errno = e.args[0]
if errno == EINTR:
return
else:
raise
for fd, event in event_list:
if event & (select.POLLIN | select.POLLHUP):
handler = self.readmap[fd]
handler(fd, self)
if event & (select.POLLOUT | select.POLLERR):
handler = self.writemap[fd]
handler(fd, self)
def make_iomap():
"""Return a new IOMap or PollIOMap as appropriate.
Since `select.poll` is not implemented on all platforms, this ensures that
the most appropriate implementation is used.
"""
if hasattr(select, 'poll'):
return PollIOMap()
return IOMap()
class Writer(threading.Thread):
"""Thread that writes to files by processing requests from a Queue.
Until AIO becomes widely available, it is impossible to make a nonblocking
write to an ordinary file. The Writer thread processes all writing to
ordinary files so that the main thread can work without blocking.
"""
OPEN = object()
EOF = object()
ABORT = object()
def __init__(self, outdir, errdir):
threading.Thread.__init__(self)
# A daemon thread automatically dies if the program is terminated.
self.setDaemon(True)
self.queue = queue.Queue()
self.outdir = outdir
self.errdir = errdir
self.host_counts = {}
self.files = {}
def run(self):
while True:
filename, data = self.queue.get()
if filename == self.ABORT:
return
if data == self.OPEN:
self.files[filename] = open(filename, 'wb', buffering=1)
psshutil.set_cloexec(self.files[filename])
else:
dest = self.files[filename]
if data == self.EOF:
dest.close()
else:
dest.write(data)
dest.flush()
def open_files(self, host):
"""Called from another thread to create files for stdout and stderr.
Returns a pair of filenames (outfile, errfile). These filenames are
used as handles for future operations. Either or both may be None if
outdir or errdir or not set.
"""
outfile = errfile = None
if self.outdir or self.errdir:
count = self.host_counts.get(host, 0)
self.host_counts[host] = count + 1
if count:
filename = "%s.%s" % (host, count)
else:
filename = host
if self.outdir:
outfile = os.path.join(self.outdir, filename)
self.queue.put((outfile, self.OPEN))
if self.errdir:
errfile = os.path.join(self.errdir, filename)
self.queue.put((errfile, self.OPEN))
return outfile, errfile
def write(self, filename, data):
"""Called from another thread to enqueue a write."""
self.queue.put((filename, data))
def close(self, filename):
"""Called from another thread to close the given file."""
self.queue.put((filename, self.EOF))
def signal_quit(self):
"""Called from another thread to request the Writer to quit."""
self.queue.put((self.ABORT, None))
|