ircmaxell/php-cfg

A Control Flow Graph implementation for PHP

v0.7.0 2022-05-02 18:14 UTC

Requires

• php: >=7.4
• nikic/php-parser: ^4.0
• phpdocumentor/graphviz: ^1.0.4

Requires (Dev)

• friendsofphp/php-cs-fixer: *
• phpunit/phpunit: ^8.0 || ^9.0

MIT

• Anthony Ferrara

README

PHP-CFG

Pure PHP implementation of a control flow graph (CFG) with instructions in static single assignment (SSA) form.

The used SSA construction algorithm is based on "Simple and Efficient Construction of Static Single Assignment Form" by Braun et al. This algorithm constructs SSA form directly from the abstract syntax tree, without going through a non-SSA IR first. If you're looking for dominance frontiers, you won't find them here...

The constructed SSA form is minimal and pure (or is supposed to be).

Usage

To bootstrap the parser, you need to give it a PhpParser instance:

$parser = new PHPCfg\Parser(
    (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7)
);

Then, just call parse on a block of code, giving it a filename:

$script = $parser->parse(file_get_contents(__FILE__), __FILE__);

To dump the graph, simply use the built-in dumper:

$dumper = new PHPCfg\Printer\Text();
echo $dumper->printScript($script);