packages/deriver/tests/Unit/Deriver/Lowerer/InstructionEmitterTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Lowerer;
6
7use Deriver\Deriver;
8use Deriver\Deriver\Candidate\ResultRef;
9use Deriver\Deriver\Candidate\Snapshot;
10use Deriver\Deriver\Candidate\Statistics;
11use Deriver\Deriver\Contributions;
12use Deriver\Deriver\DeriverConfig;
13use Deriver\Deriver\Evaluator\Call\Evaluators;
14use Deriver\Deriver\Evaluator\Call\Extensions;
15use Deriver\Deriver\Evaluator\Call\Registrations;
16use Deriver\Deriver\Evaluator\Call\StateRegistry;
17use Deriver\Deriver\Evaluator\EvaluatorConfig;
18use Deriver\Deriver\Evaluator\Evidence\Frontier;
19use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
20use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
21use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
22use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
23use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
24use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
25use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
26use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
27use Deriver\Deriver\Evaluator\Execution\Constraints;
28use Deriver\Deriver\Evaluator\Execution\Context;
29use Deriver\Deriver\Evaluator\Execution\Control\LoopConvergence;
30use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
31use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
32use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
33use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
34use Deriver\Deriver\Evaluator\Execution\Demand\Components;
35use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
36use Deriver\Deriver\Evaluator\Execution\Demand\Key;
37use Deriver\Deriver\Evaluator\Execution\Demand\Table;
38use Deriver\Deriver\Evaluator\Execution\Dependencies;
39use Deriver\Deriver\Evaluator\Execution\Evaluator;
40use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
41use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
42use Deriver\Deriver\Evaluator\Execution\Memory\Location;
43use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
44use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
45use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
46use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
47use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
48use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
49use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
50use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
51use Deriver\Deriver\Evaluator\Execution\State;
52use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
53use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
54use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
55use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
56use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
57use Deriver\Deriver\Evaluator\Execution\Transfer\CompoundAssignment;
58use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
59use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
60use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
61use Deriver\Deriver\Evaluator\Request\Budget;
62use Deriver\Deriver\Evaluator\Request\EntryPoint;
63use Deriver\Deriver\Evaluator\Request\QueryScope;
64use Deriver\Deriver\Evaluator\Request\ReturnQuery;
65use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
66use Deriver\Deriver\Evaluator\Scalar\Comparison;
67use Deriver\Deriver\Evaluator\Scalar\Identity;
68use Deriver\Deriver\Evaluator\Scalar\Increment;
69use Deriver\Deriver\Evaluator\Scalar\Operations;
70use Deriver\Deriver\Evaluator\TargetProfile;
71use Deriver\Deriver\Evaluator\Term as EvaluatorTerm;
72use Deriver\Deriver\Execution\DerivationResult;
73use Deriver\Deriver\Execution\QueryExecution;
74use Deriver\Deriver\Execution\ResultAssessment;
75use Deriver\Deriver\Identity\QueryEncoding;
76use Deriver\Deriver\Identity\ValueGraph;
77use Deriver\Deriver\Lowerer\AssignmentLowering;
78use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
79use Deriver\Deriver\Lowerer\Control\LoopLowering;
80use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
81use Deriver\Deriver\Lowerer\Declaration\CallableSource;
82use Deriver\Deriver\Lowerer\Declaration\Index;
83use Deriver\Deriver\Lowerer\Declaration\Indexer;
84use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
85use Deriver\Deriver\Lowerer\EffectInspection;
86use Deriver\Deriver\Lowerer\ExpressionLowering;
87use Deriver\Deriver\Lowerer\Graph\BasicBlock;
88use Deriver\Deriver\Lowerer\Graph\CallableGraph;
89use Deriver\Deriver\Lowerer\Graph\Instruction;
90use Deriver\Deriver\Lowerer\Graph\Literal as Term;
91use Deriver\Deriver\Lowerer\Graph\Terminator;
92use Deriver\Deriver\Lowerer\Graph\TerminatorKind;
93use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
94use Deriver\Deriver\Lowerer\InstructionEmitter;
95use Deriver\Deriver\Lowerer\Lowerer;
96use Deriver\Deriver\Lowerer\LoweringScope;
97use Deriver\Deriver\Lowerer\StatementLowering;
98use Deriver\Deriver\MicroEvaluatorConversion;
99use Deriver\Deriver\Parser\Node\File;
100use Deriver\Deriver\Parser\Parser;
101use Deriver\Deriver\Parser\ParserConfig;
102use Deriver\Deriver\Parser\TargetSyntax;
103use Deriver\Deriver\Providers\ProviderExpansion;
104use Deriver\Deriver\Resolver\AssignmentPatterns;
105use Deriver\Deriver\Resolver\ClassScope;
106use Deriver\Deriver\Resolver\ExpressionValidation;
107use Deriver\Deriver\Resolver\MagicContext;
108use Deriver\Deriver\Resolver\Resolver;
109use Deriver\Deriver\Selection\QueryValidation;
110use Deriver\Deriver\SnapshotIdentity;
111use Deriver\Deriver\Sources\LineMap;
112use Deriver\Deriver\Sources\Path;
113use Deriver\Deriver\Sources\Source;
114use Deriver\Deriver\Sources\SourceRef;
115use Deriver\Deriver\Sources\Sources;
116use Deriver\Exception\ParserException;
117use Deriver\Exception\ResolutionException;
118use PhpParser\Node\Scalar\Int_;
119use PHPUnit\Framework\Attributes\CoversClass;
120use PHPUnit\Framework\Attributes\Small;
121use PHPUnit\Framework\Attributes\UsesClass;
122use PHPUnit\Framework\TestCase;
123
124#[UsesClass(Resolver::class)]
125#[UsesClass(ExpressionValidation::class)]
126#[UsesClass(ResolutionException::class)]
127#[UsesClass(ParserConfig::class)]
128#[UsesClass(ParserException::class)]
129#[CoversClass(InstructionEmitter::class)]
130#[UsesClass(QueryExecution::class)]
131#[UsesClass(QueryValidation::class)]
132#[UsesClass(ResultAssessment::class)]
133#[UsesClass(Deriver::class)]
134#[UsesClass(Constraints::class)]
135#[UsesClass(BasicBlock::class)]
136#[UsesClass(CallableGraph::class)]
137#[UsesClass(CallableIdentity::class)]
138#[UsesClass(Instruction::class)]
139#[UsesClass(Terminator::class)]
140#[UsesClass(ArgumentBinding::class)]
141#[UsesClass(ArgumentOrder::class)]
142#[UsesClass(Dispatch::class)]
143#[UsesClass(TypeBinding::class)]
144#[UsesClass(TypeCheck::class)]
145#[UsesClass(Completion::class)]
146#[UsesClass(Context::class)]
147#[UsesClass(LoopConvergence::class)]
148#[UsesClass(ObservationLimit::class)]
149#[UsesClass(StateJoin::class)]
150#[UsesClass(Unwinding::class)]
151#[UsesClass(Cell::class)]
152#[UsesClass(Components::class)]
153#[UsesClass(Discovery::class)]
154#[UsesClass(Key::class)]
155#[UsesClass(Table::class)]
156#[UsesClass(Dependencies::class)]
157#[UsesClass(InstructionTransfer::class)]
158#[UsesClass(Evaluator::class)]
159#[UsesClass(SlotReference::class)]
160#[UsesClass(ObservationCollector::class)]
161#[UsesClass(Conversions::class)]
162#[UsesClass(ScalarErrors::class)]
163#[UsesClass(State::class)]
164#[UsesClass(CompletionRecord::class)]
165#[UsesClass(Evaluation::class)]
166#[UsesClass(Invocation::class)]
167#[UsesClass(Isolation::class)]
168#[UsesClass(CompoundAssignment::class)]
169#[UsesClass(MemoryStep::class)]
170#[UsesClass(PureStep::class)]
171#[UsesClass(ReferenceAssignment::class)]
172#[UsesClass(Location::class)]
173#[UsesClass(Materialization::class)]
174#[UsesClass(Memory::class)]
175#[UsesClass(ReferenceConstraint::class)]
176#[UsesClass(StorageCapture::class)]
177#[UsesClass(Extensions::class)]
178#[UsesClass(ProviderExpansion::class)]
179#[UsesClass(Evaluators::class)]
180#[UsesClass(StateRegistry::class)]
181#[UsesClass(DeriverConfig::class)]
182#[UsesClass(EntryPoint::class)]
183#[UsesClass(Sources::class)]
184#[UsesClass(Path::class)]
185#[UsesClass(Snapshot::class)]
186#[UsesClass(Source::class)]
187#[UsesClass(TargetProfile::class)]
188#[UsesClass(Budget::class)]
189#[UsesClass(QueryScope::class)]
190#[UsesClass(ReturnQuery::class)]
191#[UsesClass(ResultRef::class)]
192#[UsesClass(SourceRef::class)]
193#[UsesClass(Alternative::class)]
194#[UsesClass(Assessment::class)]
195#[UsesClass(Derivation::class)]
196#[UsesClass(DerivationResult::class)]
197#[UsesClass(QueryEncoding::class)]
198#[UsesClass(ValueGraph::class)]
199#[UsesClass(Statistics::class)]
200#[UsesClass(StorageSnapshot::class)]
201#[UsesClass(Parser::class)]
202#[UsesClass(File::class)]
203#[UsesClass(AssignmentLowering::class)]
204#[UsesClass(Lowerer::class)]
205#[UsesClass(DestructuringLowering::class)]
206#[UsesClass(LoopLowering::class)]
207#[UsesClass(EffectInspection::class)]
208#[UsesClass(ExpressionLowering::class)]
209#[UsesClass(LoweringScope::class)]
210#[UsesClass(StatementLowering::class)]
211#[UsesClass(CallableSource::class)]
212#[UsesClass(Indexer::class)]
213#[UsesClass(Index::class)]
214#[UsesClass(Composition::class)]
215#[UsesClass(LineMap::class)]
216#[UsesClass(MagicContext::class)]
217#[UsesClass(AssignmentPatterns::class)]
218#[UsesClass(ClassScope::class)]
219#[UsesClass(TargetSyntax::class)]
220#[UsesClass(Arithmetic::class)]
221#[UsesClass(Comparison::class)]
222#[UsesClass(Identity::class)]
223#[UsesClass(Increment::class)]
224#[UsesClass(Operations::class)]
225#[UsesClass(Term::class)]
226#[Small]
227final class InstructionEmitterTest extends TestCase
228{
229    public function testBlockPreservesTheSemanticContract(): void
230    {
231        $source = '<?php function target(){$s="";for($i=0;$i<3;$i++){$s.="x";}return $s;}';
232        $symbol = 'target';
233        $input = new Sources([new Source('fixture.php', $source)]);
234        $configuration = new DeriverConfig();
235        $contributions = new Contributions();
236        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
237        $providers = new ProviderExpansion($input, array_map(EvaluatorTerm::fromNative(...), $configuration->environment), $contributions);
238        $contributions1 = $providers->contributions;
239        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
240        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
241        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
242        $snapshotId = $identity->id;
243        $input1 = $providers->input;
244        $parser = new Parser(new ParserConfig($target->version));
245        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
246        $program = new Index($snapshotId, $trees);
247        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
248        self::assertSame('xxx', $result->normalOutcomes[0]->values['return']->native());
249        self::assertSame([], $result->frontiers);
250        self::assertSame([], $result->exceptionalOutcomes);
251    }
252    public function testEmitAllocatesDistinctDefinitionsAndRetainsOperands(): void
253    {
254        $graph = new InstructionEmitter('s', 'f.php', '<?php 1;');
255        $node = new Int_(1, ['startFilePos' => 6, 'endFilePos' => 6]);
256        $a = $graph->emit($node, 'constant', constant: Term::constant(1));
257        $b = $graph->emit($node, 'copy', [$a]);
258        self::assertNotSame($a, $b);
259        self::assertSame([$a], $graph->instructions[0][1]->operands);
260    }
261    public function testSourceUsesHalfOpenByteRangesAndByteColumns(): void
262    {
263        $graph = new InstructionEmitter('s', 'f.php', "<?php\n  17;");
264        $source = $graph->source(new Int_(17, ['startFilePos' => 8, 'endFilePos' => 9, 'startLine' => 2]));
265        self::assertSame([8, 10, 2, 3], [$source->start, $source->end, $source->line, $source->column]);
266    }
267    public function testEndPreservesTheReturnOperand(): void
268    {
269        $graph = new InstructionEmitter('s', 'f.php', '');
270        $graph->end(new Terminator(TerminatorKind::Return, 'r1'));
271        self::assertSame('r1', $graph->finish()[0]->terminator->operand);
272    }
273    public function testJumpDoesNotReplaceAnExistingCompletion(): void
274    {
275        $graph = new InstructionEmitter('s', 'f.php', '');
276        $graph->end(new Terminator(TerminatorKind::Throw, 'r1'));
277        $graph->jump($graph->block());
278        self::assertSame(TerminatorKind::Throw, $graph->finish()[0]->terminator->kind);
279    }
280    public function testFinishInsertsAnImplicitNullReturnForFallthrough(): void
281    {
282        $graph = new InstructionEmitter('s', 'f.php', '');
283        $loop = $graph->block(true);
284        self::assertTrue($graph->finish()[$loop]->loopHeader);
285        self::assertSame(TerminatorKind::Return, $graph->finish()[0]->terminator->kind);
286    }
287}
288