forked from nodejs/node-v0.x-archive
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
timers: don't mutate unref list while iterating it
Commit 934bfe2 had introduced a regression where node would crash trying to access a null unref timer if a given unref timer's callback would remove other unref timers set to fire in the future. More generally, it makes the unrefTimeout function more solid by not mutating the unrefList while traversing it. Fixes nodejs#8897. Reviewed-By: Timothy J Fontaine <tjfontaine@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
- Loading branch information
Showing
4 changed files
with
221 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
test/simple/test-timers-socket-timeout-removes-other-socket-unref-timer.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
// Copyright Joyent, Inc. and other Node contributors. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a | ||
// copy of this software and associated documentation files (the | ||
// "Software"), to deal in the Software without restriction, including | ||
// without limitation the rights to use, copy, modify, merge, publish, | ||
// distribute, sublicense, and/or sell copies of the Software, and to permit | ||
// persons to whom the Software is furnished to do so, subject to the | ||
// following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included | ||
// in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN | ||
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE | ||
// USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
/* | ||
* This test is a regression test for joyent/node#8897. | ||
*/ | ||
|
||
var common = require('../common'); | ||
var assert = require('assert'); | ||
var net = require('net'); | ||
|
||
var clients = []; | ||
|
||
var server = net.createServer(function onClient(client) { | ||
clients.push(client); | ||
|
||
if (clients.length === 2) { | ||
/* | ||
* Enroll two timers, and make the one supposed to fire first | ||
* unenroll the other one supposed to fire later. This mutates | ||
* the list of unref timers when traversing it, and exposes the | ||
* original issue in joyent/node#8897. | ||
*/ | ||
clients[0].setTimeout(1, function onTimeout() { | ||
clients[1].setTimeout(0); | ||
clients[0].end(); | ||
clients[1].end(); | ||
}); | ||
|
||
// Use a delay that is higher than the lowest timer resolution accross all | ||
// supported platforms, so that the two timers don't fire at the same time. | ||
clients[1].setTimeout(50); | ||
} | ||
}); | ||
|
||
server.listen(common.PORT, '127.0.0.1', function() { | ||
var nbClientsEnded = 0; | ||
|
||
function addEndedClient(client) { | ||
++nbClientsEnded; | ||
if (nbClientsEnded === 2) { | ||
server.close(); | ||
} | ||
} | ||
|
||
var client1 = net.connect({ port: common.PORT }) | ||
client1.on('end', addEndedClient); | ||
|
||
var client2 = net.connect({ port: common.PORT }); | ||
client2.on('end', addEndedClient); | ||
}); |
59 changes: 59 additions & 0 deletions
59
test/simple/test-timers-unref-remove-other-unref-timers-only-one-fires.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
// Copyright Joyent, Inc. and other Node contributors. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a | ||
// copy of this software and associated documentation files (the | ||
// "Software"), to deal in the Software without restriction, including | ||
// without limitation the rights to use, copy, modify, merge, publish, | ||
// distribute, sublicense, and/or sell copies of the Software, and to permit | ||
// persons to whom the Software is furnished to do so, subject to the | ||
// following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included | ||
// in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN | ||
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE | ||
// USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
/* | ||
* The goal of this test is to make sure that, after the regression introduced | ||
* by 934bfe23a16556d05bfb1844ef4d53e8c9887c3d, the fix preserves the following | ||
* behavior of unref timers: if two timers are scheduled to fire at the same | ||
* time, if one unenrolls the other one in its _onTimeout callback, the other | ||
* one will *not* fire. | ||
* | ||
* This behavior is a private implementation detail and should not be | ||
* considered public interface. | ||
*/ | ||
var timers = require('timers'); | ||
var assert = require('assert'); | ||
|
||
var nbTimersFired = 0; | ||
|
||
var foo = new function() { | ||
this._onTimeout = function() { | ||
++nbTimersFired; | ||
timers.unenroll(bar); | ||
}; | ||
}(); | ||
|
||
var bar = new function() { | ||
this._onTimeout = function() { | ||
++nbTimersFired; | ||
timers.unenroll(foo); | ||
}; | ||
}(); | ||
|
||
timers.enroll(bar, 1); | ||
timers._unrefActive(bar); | ||
|
||
timers.enroll(foo, 1); | ||
timers._unrefActive(foo); | ||
|
||
setTimeout(function() { | ||
assert.notEqual(nbTimersFired, 2); | ||
}, 20); |
49 changes: 49 additions & 0 deletions
49
test/simple/test-timers-unref-remove-other-unref-timers.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
// Copyright Joyent, Inc. and other Node contributors. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a | ||
// copy of this software and associated documentation files (the | ||
// "Software"), to deal in the Software without restriction, including | ||
// without limitation the rights to use, copy, modify, merge, publish, | ||
// distribute, sublicense, and/or sell copies of the Software, and to permit | ||
// persons to whom the Software is furnished to do so, subject to the | ||
// following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included | ||
// in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN | ||
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE | ||
// USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
/* | ||
* This test is a regression test for joyent/node#8897. | ||
* | ||
* It tests some private implementation details that should not be | ||
* considered public interface. | ||
*/ | ||
var timers = require('timers'); | ||
|
||
var foo = new function() { | ||
this._onTimeout = function() {}; | ||
}(); | ||
|
||
var bar = new function() { | ||
this._onTimeout = function() { | ||
timers.unenroll(foo); | ||
}; | ||
}(); | ||
|
||
// We use timers with expiration times that are sufficiently apart to make | ||
// sure that they're not fired at the same time on platforms where the timer | ||
// resolution is a bit coarse (e.g Windows with a default resolution of ~15ms). | ||
timers.enroll(bar, 1); | ||
timers._unrefActive(bar); | ||
|
||
timers.enroll(foo, 50); | ||
timers._unrefActive(foo); | ||
|
||
setTimeout(function() {}, 100); |