mediawiki-extensions-Scribunto/tests/engines/LuaStandalone/LuaStandaloneInterpreterTest.php
Brad Jorsch 84d96e843c LuaStandalone: Release functions when no longer referenced
The LuaStandalone interpreter needs to keep a mapping from integers
returned to PHP to the corresponding function. But if it never releases
these functions when PHP no longer has any reference to them, it can
result in Lua running out of memory if a module with a large number of
functions is invoked many times in one page.

The fix here is to track which function ids are referenced from PHP, and
periodically send the list to Lua so it can remove any that are no
longer used from its cache.

This also takes care of another issue where having multiple interpreter
instances and passing function objects from one into another could call
the wrong function in Lua.

Bug: 51886
Change-Id: I4f15841051f7748d1d6df24080949e5cbd88f217
2014-02-25 22:59:05 +00:00

132 lines
4.5 KiB
PHP

<?php
if ( PHP_SAPI !== 'cli' ) exit;
require_once( dirname( __FILE__ ) .'/../LuaCommon/LuaInterpreterTest.php' );
/**
* @group Lua
* @group LuaStandalone
*/
class Scribunto_LuaStandaloneInterpreterTest extends Scribunto_LuaInterpreterTest {
var $stdOpts = array(
'errorFile' => null,
'luaPath' => null,
'memoryLimit' => 50000000,
'cpuLimit' => 30,
);
function getVsize( $pid ) {
$size = wfShellExec( wfEscapeShellArg( 'ps', '-p', $pid, '-o', 'vsz', '--no-headers' ) );
return $size * 1024;
}
function newInterpreter( $opts = array() ) {
$opts = $opts + $this->stdOpts;
$engine = new Scribunto_LuaStandaloneEngine( $this->stdOpts );
return new Scribunto_LuaStandaloneInterpreter( $engine, $opts );
}
function testGetStatus() {
$startTime = microtime( true );
if ( php_uname( 's' ) !== 'Linux' ) {
$this->markTestSkipped( "getStatus() not supported on platforms other than Linux" );
return;
}
$interpreter = $this->newInterpreter();
$status = $interpreter->getStatus();
$pid = $status['pid'];
$this->assertInternalType( 'integer', $status['pid'] );
$initialVsize = $this->getVsize( $pid );
$this->assertGreaterThan( 0, $initialVsize, 'Initial vsize' );
$chunk = $this->getBusyLoop( $interpreter );
while ( microtime( true ) - $startTime < 1 ) {
$interpreter->callFunction( $chunk, 100 );
}
$status = $interpreter->getStatus();
$vsize = $this->getVsize( $pid );
$time = $status['time'] / $interpreter->engine->getClockTick();
$this->assertGreaterThan( 0.1, $time, 'getStatus() time usage' );
$this->assertLessThan( 1.5, $time, 'getStatus() time usage' );
$this->assertEquals( $vsize, $status['vsize'], 'vsize', $vsize * 0.1 );
}
function testFreeFunctions() {
$interpreter = $this->newInterpreter();
// Test #1: Make sure freeing actually works
$ret = $interpreter->callFunction(
$interpreter->loadString( 'return function() return "testFreeFunction #1" end', 'test' )
);
$id = $ret[0]->id;
$interpreter->cleanupLuaChunks();
$this->assertEquals(
array( 'testFreeFunction #1' ), $interpreter->callFunction( $ret[0] ),
'Test that function #1 was not freed while a reference exists'
);
$ret = null;
$interpreter->cleanupLuaChunks();
$testfunc = new Scribunto_LuaStandaloneInterpreterFunction( $interpreter->id, $id );
try {
$interpreter->callFunction( $testfunc );
$this->fail( "Expected exception because function #1 should have been freed" );
} catch ( Scribunto_LuaError $e ) {
$this->assertEquals(
"Lua error: function id $id does not exist.", $e->getMessage(),
'Testing for expected error when calling a freed function #1'
);
}
// Test #2: Make sure constructing a new copy of the function works
$ret = $interpreter->callFunction(
$interpreter->loadString( 'return function() return "testFreeFunction #2" end', 'test' )
);
$id = $ret[0]->id;
$func = new Scribunto_LuaStandaloneInterpreterFunction( $interpreter->id, $id );
$ret = null;
$interpreter->cleanupLuaChunks();
$this->assertEquals(
array( 'testFreeFunction #2' ), $interpreter->callFunction( $func ),
'Test that function #2 was not freed while a reference exists'
);
$func = null;
$interpreter->cleanupLuaChunks();
$testfunc = new Scribunto_LuaStandaloneInterpreterFunction( $interpreter->id, $id );
try {
$interpreter->callFunction( $testfunc );
$this->fail( "Expected exception because function #2 should have been freed" );
} catch ( Scribunto_LuaError $e ) {
$this->assertEquals(
"Lua error: function id $id does not exist.", $e->getMessage(),
'Testing for expected error when calling a freed function #2'
);
}
// Test #3: Make sure cloning works
$ret = $interpreter->callFunction(
$interpreter->loadString( 'return function() return "testFreeFunction #3" end', 'test' )
);
$id = $ret[0]->id;
$func = clone $ret[0];
$ret = null;
$interpreter->cleanupLuaChunks();
$this->assertEquals(
array( 'testFreeFunction #3' ), $interpreter->callFunction( $func ),
'Test that function #3 was not freed while a reference exists'
);
$func = null;
$interpreter->cleanupLuaChunks();
$testfunc = new Scribunto_LuaStandaloneInterpreterFunction( $interpreter->id, $id );
try {
$interpreter->callFunction( $testfunc );
$this->fail( "Expected exception because function #3 should have been freed" );
} catch ( Scribunto_LuaError $e ) {
$this->assertEquals(
"Lua error: function id $id does not exist.", $e->getMessage(),
'Testing for expected error when calling a freed function #3'
);
}
}
}