Skip to content

Refactor and simplify signal handling logic #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 6, 2018
Merged

Refactor and simplify signal handling logic #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6c7785
Simplify removing signal handlers
clue Jan 15, 2018
8afd1f3
Simplify adding signal handlers
clue Jan 15, 2018
3e4421b
Simplify checking signal watchers and remove circular reference
clue Jan 20, 2018
f261f47
Avoid cyclic callback references
clue Jan 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions src/ExtEventLoop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,7 @@ public function __construct(EventBaseConfig $config = null)
$this->eventBase = new EventBase($config);
$this->futureTickQueue = new FutureTickQueue();
$this->timerEvents = new SplObjectStorage();

$this->signals = new SignalsHandler(
$this,
function ($signal) {
$this->signalEvents[$signal] = Event::signal($this->eventBase, $signal, $f = function () use ($signal, &$f) {
$this->signals->call($signal);
// Ensure there are two copies of the callable around until it has been executed.
// For more information see: https://bugs.php.net/bug.php?id=62452
// Only an issue for PHP 5, this hack can be removed once PHP 5 support has been dropped.
$g = $f;
$f = $g;
});
$this->signalEvents[$signal]->add();
},
function ($signal) {
if ($this->signals->count($signal) === 0) {
$this->signalEvents[$signal]->free();
unset($this->signalEvents[$signal]);
}
}
);
$this->signals = new SignalsHandler();

$this->createTimerCallback();
$this->createStreamCallback();
Expand Down Expand Up @@ -167,11 +147,21 @@ public function futureTick($listener)
public function addSignal($signal, $listener)
{
$this->signals->add($signal, $listener);

if (!isset($this->signalEvents[$signal])) {
$this->signalEvents[$signal] = Event::signal($this->eventBase, $signal, array($this->signals, 'call'));
$this->signalEvents[$signal]->add();
}
}

public function removeSignal($signal, $listener)
{
$this->signals->remove($signal, $listener);

if (isset($this->signalEvents[$signal]) && $this->signals->count($signal) === 0) {
$this->signalEvents[$signal]->free();
unset($this->signalEvents[$signal]);
}
}

public function run()
Expand All @@ -184,7 +174,7 @@ public function run()
$flags = EventBase::LOOP_ONCE;
if (!$this->running || !$this->futureTickQueue->isEmpty()) {
$flags |= EventBase::LOOP_NONBLOCK;
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count()) {
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count() && $this->signals->isEmpty()) {
break;
}

Expand Down
38 changes: 15 additions & 23 deletions src/ExtLibevLoop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,28 +39,7 @@ public function __construct()
$this->loop = new EventLoop();
$this->futureTickQueue = new FutureTickQueue();
$this->timerEvents = new SplObjectStorage();

$this->signals = new SignalsHandler(
$this,
function ($signal) {
$this->signalEvents[$signal] = new SignalEvent($f = function () use ($signal, &$f) {
$this->signals->call($signal);
// Ensure there are two copies of the callable around until it has been executed.
// For more information see: https://bugs.php.net/bug.php?id=62452
// Only an issue for PHP 5, this hack can be removed once PHP 5 support has been dropped.
$g = $f;
$f = $g;
}, $signal);
$this->loop->add($this->signalEvents[$signal]);
},
function ($signal) {
if ($this->signals->count($signal) === 0) {
$this->signalEvents[$signal]->stop();
$this->loop->remove($this->signalEvents[$signal]);
unset($this->signalEvents[$signal]);
}
}
);
$this->signals = new SignalsHandler();
}

public function addReadStream($stream, $listener)
Expand Down Expand Up @@ -167,11 +146,24 @@ public function futureTick($listener)
public function addSignal($signal, $listener)
{
$this->signals->add($signal, $listener);

if (!isset($this->signalEvents[$signal])) {
$this->signalEvents[$signal] = new SignalEvent(function () use ($signal) {
$this->signals->call($signal);
}, $signal);
$this->loop->add($this->signalEvents[$signal]);
}
}

public function removeSignal($signal, $listener)
{
$this->signals->remove($signal, $listener);

if (isset($this->signalEvents[$signal]) && $this->signals->count($signal) === 0) {
$this->signalEvents[$signal]->stop();
$this->loop->remove($this->signalEvents[$signal]);
unset($this->signalEvents[$signal]);
}
}

public function run()
Expand All @@ -184,7 +176,7 @@ public function run()
$flags = EventLoop::RUN_ONCE;
if (!$this->running || !$this->futureTickQueue->isEmpty()) {
$flags |= EventLoop::RUN_NOWAIT;
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count()) {
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count() && $this->signals->isEmpty()) {
break;
}

Expand Down
40 changes: 15 additions & 25 deletions src/ExtLibeventLoop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,30 +55,7 @@ public function __construct()
$this->eventBase = event_base_new();
$this->futureTickQueue = new FutureTickQueue();
$this->timerEvents = new SplObjectStorage();

$this->signals = new SignalsHandler(
$this,
function ($signal) {
$this->signalEvents[$signal] = event_new();
event_set($this->signalEvents[$signal], $signal, EV_PERSIST | EV_SIGNAL, $f = function () use ($signal, &$f) {
$this->signals->call($signal);
// Ensure there are two copies of the callable around until it has been executed.
// For more information see: https://bugs.php.net/bug.php?id=62452
// Only an issue for PHP 5, this hack can be removed once PHP 5 support has been dropped.
$g = $f;
$f = $g;
});
event_base_set($this->signalEvents[$signal], $this->eventBase);
event_add($this->signalEvents[$signal]);
},
function ($signal) {
if ($this->signals->count($signal) === 0) {
event_del($this->signalEvents[$signal]);
event_free($this->signalEvents[$signal]);
unset($this->signalEvents[$signal]);
}
}
);
$this->signals = new SignalsHandler();

$this->createTimerCallback();
$this->createStreamCallback();
Expand Down Expand Up @@ -185,11 +162,24 @@ public function futureTick($listener)
public function addSignal($signal, $listener)
{
$this->signals->add($signal, $listener);

if (!isset($this->signalEvents[$signal])) {
$this->signalEvents[$signal] = event_new();
event_set($this->signalEvents[$signal], $signal, EV_PERSIST | EV_SIGNAL, array($this->signals, 'call'));
event_base_set($this->signalEvents[$signal], $this->eventBase);
event_add($this->signalEvents[$signal]);
}
}

public function removeSignal($signal, $listener)
{
$this->signals->remove($signal, $listener);

if (isset($this->signalEvents[$signal]) && $this->signals->count($signal) === 0) {
event_del($this->signalEvents[$signal]);
event_free($this->signalEvents[$signal]);
unset($this->signalEvents[$signal]);
}
}

public function run()
Expand All @@ -202,7 +192,7 @@ public function run()
$flags = EVLOOP_ONCE;
if (!$this->running || !$this->futureTickQueue->isEmpty()) {
$flags |= EVLOOP_NONBLOCK;
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count()) {
} elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count() && $this->signals->isEmpty()) {
break;
}

Expand Down
42 changes: 5 additions & 37 deletions src/SignalsHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,12 @@
*/
final class SignalsHandler
{
private $loop;
private $timer;
private $signals = [];
private $on;
private $off;

public function __construct(LoopInterface $loop, $on, $off)
{
$this->loop = $loop;
$this->on = $on;
$this->off = $off;
}

public function __destruct()
{
$off = $this->off;
foreach ($this->signals as $signal => $listeners) {
$off($signal);
}
}

public function add($signal, $listener)
{
if (empty($this->signals) && $this->timer === null) {
/**
* Timer to keep the loop alive as long as there are any signal handlers registered
*/
$this->timer = $this->loop->addPeriodicTimer(300, function () {});
}

if (!isset($this->signals[$signal])) {
$this->signals[$signal] = [];

$on = $this->on;
$on($signal);
}

if (in_array($listener, $this->signals[$signal])) {
Expand All @@ -62,14 +33,6 @@ public function remove($signal, $listener)

if (isset($this->signals[$signal]) && \count($this->signals[$signal]) === 0) {
unset($this->signals[$signal]);

$off = $this->off;
$off($signal);
}

if (empty($this->signals) && $this->timer instanceof TimerInterface) {
$this->loop->cancelTimer($this->timer);
$this->timer = null;
}
}

Expand All @@ -92,4 +55,9 @@ public function count($signal)

return \count($this->signals[$signal]);
}

public function isEmpty()
{
return !$this->signals;
}
}
36 changes: 16 additions & 20 deletions src/StreamSelectLoop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,24 +69,7 @@ public function __construct()
$this->futureTickQueue = new FutureTickQueue();
$this->timers = new Timers();
$this->pcntl = extension_loaded('pcntl');
$this->signals = new SignalsHandler(
$this,
function ($signal) {
\pcntl_signal($signal, $f = function ($signal) use (&$f) {
$this->signals->call($signal);
// Ensure there are two copies of the callable around until it has been executed.
// For more information see: https://bugs.php.net/bug.php?id=62452
// Only an issue for PHP 5, this hack can be removed once PHP 5 support has been dropped.
$g = $f;
$f = $g;
});
},
function ($signal) {
if ($this->signals->count($signal) === 0) {
\pcntl_signal($signal, SIG_DFL);
}
}
);
$this->signals = new SignalsHandler();
}

public function addReadStream($stream, $listener)
Expand Down Expand Up @@ -163,12 +146,25 @@ public function addSignal($signal, $listener)
throw new \BadMethodCallException('Event loop feature "signals" isn\'t supported by the "StreamSelectLoop"');
}

$first = $this->signals->count($signal) === 0;
$this->signals->add($signal, $listener);

if ($first) {
\pcntl_signal($signal, array($this->signals, 'call'));
}
}

public function removeSignal($signal, $listener)
{
if (!$this->signals->count($signal)) {
return;
}

$this->signals->remove($signal, $listener);

if ($this->signals->count($signal) === 0) {
\pcntl_signal($signal, SIG_DFL);
}
}

public function run()
Expand Down Expand Up @@ -197,8 +193,8 @@ public function run()
$timeout = $timeout > PHP_INT_MAX ? PHP_INT_MAX : (int)$timeout;
}

// The only possible event is stream activity, so wait forever ...
} elseif ($this->readStreams || $this->writeStreams) {
// The only possible event is stream or signal activity, so wait forever ...
} elseif ($this->readStreams || $this->writeStreams || !$this->signals->isEmpty()) {
$timeout = null;

// There's nothing left to do ...
Expand Down
6 changes: 6 additions & 0 deletions tests/AbstractLoopTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,12 @@ function () {
$this->loop->run();
}

public function testRemoveSignalNotRegisteredIsNoOp()
{
$this->loop->removeSignal(SIGINT, function () { });
$this->assertTrue(true);
}

public function testSignal()
{
if (!function_exists('posix_kill') || !function_exists('posix_getpid')) {
Expand Down
Loading