This file is indexed.

/usr/share/doc/rakudo/architecture.html is in rakudo 2015.11-2build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<html>
<head>
    <title>How Rakudo compiles a Perl 6 program</title>
</head>
<body style="margin:2ex">

<h1>How Rakudo compiles a Perl 6 program</h1>

<object 
    style="margin:2ex; float:left"
    data="architecture.svg"
    type="image/svg+xml"
    alt="Rakudo flow chart"
    >
    </object>

<a id="action-methods" />
<h2 id="parser" >Parser and Action Methods</h2>

<p>The Perl 6 source code is transformed in various stages, of which the first two are the Parser and Action Method stages. The Parser creates a parse tree out of the Perl 6 source code and then gives control to appropriate action methods that annotate the parse tree, incrementally turning it into an Abstract Syntax Tree (AST). When an action method is done annotating, control is handed back to the parser, which then continues parsing the Perl 6 code and "fire off" new action methods as it goes.</p>

<p>The result of these two stages interacting is an "improved PAST" (Perl 6 Abstract Syntax Tree) called QAST. This tree is then passed on to the QAST compiler.</p>

<p>The parser and action methods are implemented in "Not Quite Perl 6" (NQP) and are part of Rakudo and hosted in the Rakudo repository at <a href="../src/Perl6/Grammar.pm">src/Perl6/Grammar.pm</a> and <a href="../src/Perl6/Actions.pm">src/Perl6/Actions.pm</a>.</p>

<h2 id="the-world">The World</h2>

<p>The World is where the parser and the action methods store any declarations they encounter during their runs, including Classes, Types, Signatures, Constants, Subs and Methods.</p>


<h2 id="qast-compiler">QAST compiler</h2>

<p>The QAST compiler transforms the abstract syntax tree into a PIRT (Parrot Intermediate Representation Tree). To do this, the QAST compiler does a series of translations on the AST, creating PIRT nodes that implement the operations specified by the QAST nodes.</p>

<p>In addition, the QAST compiler is responsible for serializing <em>The World</em> in such a way that later stages can get access to the declarations stored there during the parser and action methods stages.</p>

<p>There's also opportunity to apply some VM-specific optimizations at this point. When this is done, the resulting PIRT is passed to the PIRT serializer.</p>

<p>This stage is described in the different files in the <a href="../nqp/src/QAST/">nqp/src/QAST/</a> directory.</p>

<h2 id="pirt-serializer">PIRT serializer</h2>

<p>The PIRT serializer "squashes" the PIR Tree into a format that can be passed to Parrot itself and it's IMCC (InterMediate Code Compiler) stage.</p>

<p>You can read more about this at <a href="../nqp/src/QAST/PIRT.nqp">nqp/src/QAST/PIRT.nqp</a>.</p>


<a id="parrot-runtime" />
<h2 id="imcc">IMCC and Parrot runtime</h2>

<p>The IMCC (InterMediate Code Compiler) receives the PIR code from the PIRT serializer and then transforms it into Parrot Byte Code (PBC). IMCC is parrot's PIR compiler, written in C and statically linked into parrot. The byte code can then be stored to disk or executed in memory by one of the <em>run cores</em> available as part of the Parrot runtime. This is in some sense the heart of Parrot - or one of the hearts; There are several different cores available, including one for just-in-time compilation (JIT), one for debugging and others.</p>

<p>You can find out more about the IMCC in the <a href="../parrot/docs/imcc/">parrot/docs/imcc/</a> directory, and about the different run cores in the <a href="../parrot/docs/running.pod">parrot/docs/running.pod</a></p>

<h2 id="pmc-dynops">PMCs and dynops</h2>

<p>There are also some supporting custom types and operations in Rakudo called <em>dynamic PMCs</em> and <em>dynamic ops</em> (dynops) which are written in C, and helper functions written in NQP and PIR. These supporting libraries exist for adding features to Parrot that are needed to handle special features in Perl 6.</p>

<h2 id="core-setting">Core setting library</h2>

<p>The core settings library is the library containing the methods, classes and almost all other features that make up the Rakudo Perl 6 implementation. This library is tightly coupled with the <code>perl6</code> binary, and loaded by default every time <code>perl6</code> is run.</p>

<h2 id="glossary">Glossary</h2>

<dl>
    <dt>NQP</dt>
    <dd>Not Quite Perl 6, a small subset of Perl 6 that is used for tree transformations in compilers.</dd>

    <dt>PIR</dt>
    <dd>Parrot Intermediate Representation, the most commonly used for of parrot assembly (which is still high-level enough to be written by humans).</dd>

    <dt>IMCC</dt>
    <dd>InterMediate Code Compiler, the part of parrot that compiles PIR into byte code.</dd>

    <dt>PBC</dt>
    <dd>Parrot Byte Code, the binary form to which all parrot programs are compiled in the end.</dd>

    <dt>Core setting</dt>
    <dd>The core setting is the Perl 6 standard library. It is part of the perl6 executable, and contains all the standard features available in Perl 6.</dd>

    <dt>QAST</dt>
    <dd>The "improved" Abstract Syntax Tree used in Rakudo Perl 6. It contains information about how the program is structured, and what it is supposed to do.</dd>

    <dt>PIRT</dt>
    <dd>Parrot Intermediate Representation Tree.</dd>

</dl>

</body>
</html>
<!-- 
    vim: ft=html spell sw=4 ts=4 expandtab tw=75
-->