Určitě je vám známo, že PHP runtime je vybaven podobně jako řada dalších jazyků garbage collectorem, který se stará o automatickou správu paměti, takže vývojáři PHP aplikace odpadá starost o to, jak a kdy PHP runtime provede uvolnění paměti pro tu kterou proměnnou. Až do nedávna existovala minimálně jedna výjimka a tou jsou právě kruhové reference. Článek je volným překladem blogpostu Paul M. Jonese, hlavního vývojáře PHP frameworku Solar.

Kruhové reference se vyskytují v různých typech úloh a vývojáři se s nimi setkávají poměrně často, zejména při vytváření stromových hierarchií typu rodič-potomek, kdy rodič má referenci na potomka a potomek na rodiče.

class Foo {
    function __construct()
    {
        $this->bar = new Bar($this);
    }
}
 
class Bar {
    function __construct($foo = null)
    {
        $this->foo = $foo;
    }
}
 
while (true) {
    $foo = new Foo();
    unset($foo);
    echo number_format(memory_get_usage()) . "\n";
}

Pokud si pustíte tento skript v konzoli, tak budete jen chvíli koukat, a pak dostanete asi něco takovéto

	33,551,616
	33,551,976
	33,552,336
	33,552,696
	PHP Fatal error:  Allowed memory size of 33554432 bytes exhausted
	(tried to allocate 16 bytes) in memleak.php on line 17

pěkný je také případ, který uvádí Derick Rethans

$tree = array( 'one' );
$tree[] = $tree;
unset($tree)

Teď trochu odbočka, pokud jste někdy psali nějakou aplikaci v C/C++ a narazili jste na kruhové reference, tak Vám jistě nebylo úplně lehce, člověk se musí dost snažit, aby mu při dealokování a rušení různých nodů v té výše zmíněné hierarchii neutekla nějaká paměť. V PHP je to v podstatě každému fuk, protože nějaký ten leak při requestu na web aplikaci se za chvíli ztratí, ale nedejbože abychom začali psát nějaké testy, případně command line/desktop aplikace, to pak pěkně narazíme.

Problém je v garbage collectoru v PHP, ten si s kruhovými referencemi prostě neporadí, zjednodušeně při unsetu nám tam ta jedna kruhová reference zůstane a runtime paměť neuvolní, nicméně žádná proměnná, která by jí využívala už neexistuje a leak je na světě. Co tedy s tím?

Userland řešení

class Foo {
    function __construct()
    {
        $this->bar = new Bar($this);
    }
    function __destruct()
    {
        unset($this->bar);
    }
}
 
class Bar {
    function __construct($foo = null)
    {
        $this->foo = $foo;
    }
}
 
while (true) {
    $foo = new Foo();
    $foo->__destruct();
    unset($foo);
    echo number_format(memory_get_usage()) . "\n";
}

Internals řešení