-
Notifications
You must be signed in to change notification settings - Fork 138
/
OpsFile.pm
801 lines (594 loc) · 18.8 KB
/
OpsFile.pm
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
#! perl -w
# Copyright: 2001-2006 The Perl Foundation. All Rights Reserved.
# $Id$
=head1 NAME
Parrot::OpsFile - Ops To C Code Generation
=head1 SYNOPSIS
use Parrot::OpsFile;
=head1 DESCRIPTION
C<Parrot::OpsFile> takes one or more files of op functions and
creates real C code for them.
This class is used by F<tools/build/ops2c.pl>,
F<tools/build/ops2pm.pl> and F<tools/build/pbc2c.pl>.
=head2 Op Functions
For ops that have trivial bodies (such as just a call to some other
function and a C<return> statement), opcode functions are in the format:
inline op opname (args) :class,flags {
... body of function ...
}
Note that currently the C<inline> op type is ignored.
Alternately, for opcode functions that have more internal complexity the
format is:
op opname (args) :class,flags {
... body of function ...
}
There may be more than one C<return>.
In both cases the closing brace B<must> be on its own line.
=head2 Op Arguments
Op arguments are a comma-separated list of direction and type pairs.
Argument direction is one of:
in the argument passes a value into the op
out the argument passes a value out of the op
inout the argument passes a value into and out of the op
inconst the argument passes a constant value into the op
invar the argument passes a variable value into the op
label an in argument containing a branch offset or address
labelconst an invar argument containing a branch offset or address
labelvar an inconst argument containing a branch offset or address
Argument direction is used to determine the life times of symbols and
their related register allocations. When an argument is passed into an
op a register is read from, when it's passed out of an op a register is
written to.
Argument type is one of:
INT the argument is an integer
NUM the argument is an numeric
STR the argument is an string
PMC the argument is an PMC
KEY the argument is an aggregate PMC key
INTKEY the argument is an aggregate PMC integer key
The size of the return offset is determined from the op function's
signature.
=head2 Op Classification and Flags
The op classification and flags are optional hints which provide
information about the op.
The classification of ops is intended to facilitate the selection of
suitable ops for a Parrot safe mode, or for inclusion in miniparrot.
=head2 Op Body (Macro Substitutions)
In the following macro descriptions, C<PC> and C<PC'> are the current
and next position within the Parrot code.
=over 4
=item C<goto OFFSET(X)>
Transforms to C<PC' = PC + X>. This is used for branches.
=item C<goto NEXT()>
Transforms to C<PC' = PC + S>, where C<S> is the size of an op.
=item C<goto ADDRESS(X)>
Transforms to C<PC' = X>. This is used for absolute jumps.
=item C<goto POP()>
Transforms to C<< PC' = <pop> >>. Pops the address off control stack.
=item C<expr OFFSET(X)>
Transforms to C<PC + X>. This is used to give a relative address.
=item C<expr NEXT()>
Transforms to C<PC + S>, the position of the next op.
=item C<expr ADDRESS(X)>
Transforms to C<X>, an absolute address.
=item C<OP_SIZE>
Transforms to C<S>, the size of an op.
=item C<HALT()>
Transforms to C<PC' = 0>. Halts run loop, and resets the current
position to the start of the Parrot code, without resuming.
=item C<restart OFFSET(X)>
Transforms to C<PC' = 0> and restarts at C<PC + X>.
=item C<restart NEXT()>
Transforms to C<PC' = 0> and restarts at C<PC + S>.
=item C<$n>
Transforms to the op function's nth argument. C<$0> is the opcode itself.
=back
Note that, for ease of parsing, if the argument to one of the above
notations in a ops file contains parentheses, then double the enclosing
parentheses and add a space around the argument, like so:
goto OFFSET(( (void*)interpreter->happy_place ))
=head2 Class Methods
=over 4
=cut
package Parrot::OpsFile;
use strict;
use warnings;
use Parrot::Op;
use Parrot::Config;
BEGIN {
use Exporter;
use vars qw(%op_body @EXPORT @ISA);
@ISA = qw(Exporter);
@EXPORT = qw(%op_body);
};
# private sub _trim()
#
# Trim leading and trailing spaces.
sub _trim
{
my $value = shift;
$value =~ s/^\s+//;
$value =~ s/\s+$//;
return $value;
}
=item C<new(@files)>
Returns a new instance initialized by calling C<read_ops()> on each of
the specified op files.
=cut
sub new
{
my ($class, $files, $nolines) = @_;
my $self = bless { PREAMBLE => '' }, $class;
$self->read_ops($_, $nolines) for @{$files};
# FILE holds a space separated list of opsfile name
if ($self->{FILE}) {
$self->{FILE}=~s/, $//;
$self->{FILE}=~s/, $//;
}
return $self;
}
=back
=head2 Instance Methods
=over 4
=item C<read_ops($file,$nolines)>
Reads in the specified .ops file, gathering information about the ops.
=cut
sub read_ops
{
my ($self, $file, $nolines) = @_;
my $ops_file = "src/" . $file;
die "Parrot::OpFunc::init(): No file specified!\n" unless defined $file;
$self->{FILE} .= $file . ', ';
my $orig = $file;
open my $OPS, '<', $file or die "Can't open $file, $!/$^E";
if ( ! ($file =~ s/\.ops$/.c/) )
{
$file .= ".c";
}
#
# Read through the file, creating and storing Parrot::Op objects:
#
my $count = 0;
my ($name, $footer);
my $type;
my $body;
my $short_name;
my $args;
my @args;
my @argdirs;
my $seen_pod;
my $seen_op;
my $line;
my $flags;
my @labels;
while (<$OPS>)
{
$seen_pod = 1 if m|^=|;
unless ($seen_op or m|^(inline\s+)?op\s+|)
{
if (m/^\s*VERSION\s*=\s*"(\d+\.\d+\.\d+)"\s*;\s*$/)
{
if (exists $self->{VERSION})
{
#die "VERSION MULTIPLY DEFINED!";
}
$self->version($1);
$_ = '';
}
elsif (m/^\s*VERSION\s*=\s*PARROT_VERSION\s*;\s*$/)
{
if (exists $self->{VERSION})
{
#die "VERSION MULTIPLY DEFINED!";
}
$self->version($PConfig{VERSION});
$_ = '';
}
$self->{PREAMBLE} .= $_
unless $seen_pod or $count; # Lines up to first op def.
next;
}
die "No 'VERSION = ...;' line found before beginning of ops in file '$orig'!\n"
unless defined $self->version;
#
# Handle start-of-op:
#
# We create a new Parrot::Op instance based on the type, name and args.
# We query the Parrot::Op for the op size, etc., which we use later.
#
# Either of these two forms work:
#
# inline op name (args) {
# op name (args) {
#
# The args are a comma-separated list of items from this table of argument
# types (even if no formal args are specified, there will be a single 'o'
# entry):
#
# op The opcode
#
# i Integer register index
# n Number register index
# p PMC register index
# s String register index
#
# ic Integer constant (in-line)
# nc Number constant index
# pc PMC constant index
# sc String constant index
# kc Key constant index
# kic Integer Key constant index (in-line)
#
if (/^(inline\s+)?op\s+([a-zA-Z]\w*)\s*\((.*)\)\s*(\S*)?\s*{/)
{
if ($seen_op)
{
die "$ops_file [$.]: Cannot define an op within an op definition!\n";
}
$type = defined($1) ? 'inline' : 'function';
$short_name = $2;
$args = _trim(lc $3);
$flags = $4 ? _trim(lc $4) : "";
@args = split(/\s*,\s*/, $args);
@argdirs = ();
@labels = ();
$body = '';
$seen_op = 1;
$line = $.+1;
my @temp = ();
foreach my $arg (@args)
{
my ($use, $type) = $arg =~
m/^(in|out|inout|inconst|invar|label|labelconst|labelvar)
\s+
(INT|NUM|STR|PMC|KEY|INTKEY)$/ix;
die "Unrecognized arg format '$arg' in '$_'!" unless defined($use) and defined($type);
if ($type =~ /^INTKEY$/i)
{
$type = "ki";
}
else
{
$type = lc substr($type, 0, 1);
}
# convert e.g. "labelvar" to "invar" and remember labels
if ($use =~ /label(\w*)/)
{
push @labels, 1;
$use = "in$1";
}
else
{
push @labels, 0;
}
if ($use eq 'in')
{
push @temp, ($type eq 'p') ? 'p' : "$type|${type}c";
push @argdirs, 'i';
}
elsif ($use eq 'invar')
{
push @temp, $type;
push @argdirs, 'i';
}
elsif ($use eq 'inconst')
{
push @temp, "${type}c";
push @argdirs, 'i';
}
elsif ($use eq 'inout')
{
push @temp, $type;
push @argdirs, 'io';
}
else
{
push @temp, $type;
push @argdirs, 'o';
}
}
@args = @temp;
next;
}
#
# Handle end-of-op:
#
# We stash the accumulated body of source code in the Parrot::Op, push the
# Parrot::Op onto our op array, and forget the op so we can start the next
# one.
#
if (/^}\s*$/)
{
$count += $self->make_op($count, $type, $short_name, $body, \@args,
\@argdirs, $line, $orig, \@labels, $flags, $nolines);
$seen_op = 0;
next;
}
#
# Accumulate the code into the op's body:
#
if ($seen_op)
{
$body .= $_;
}
else
{
die "Parrot::OpsFile: Unrecognized line: '$_'!\n";
}
}
if ($seen_op)
{
die "Parrot::OpsFile: File ended with incomplete op definition!\n";
}
close $OPS or die "Could not close ops file '$file' ($!)!";
return;
}
# Extends a string containing an or expression "0" .. "A" .. "A|B" etc.
sub or_flag
{
my ($flag, $value) = @_;
if ($$flag eq '0')
{
$$flag = $value;
}
else
{
$$flag .= "|$value";
}
}
=item C<make_op($code,
$type, $short_name, $body, $args, $argdirs, $line, $file, $labels, $flags, $nolines)>
Returns a new C<Parrot::Op> instance for the specified arguments.
=cut
sub make_op
{
my ($self, $code, $type, $short_name, $body, $args, $argdirs,
$line, $file, $labels, $flags, $nolines) = @_;
my $counter = 0;
my $absolute = 0;
my $branch = 0;
my $pop = 0;
my $next = 0;
my $restart = 0;
foreach my $variant (expand_args(@$args))
{
my (@fixedargs)=split(/,/,$variant);
my $op = Parrot::Op->new($code++, $type, $short_name,
[ @fixedargs ], [ @$argdirs ], [ @$labels ], $flags);
my $op_size = $op->size;
my $jumps = "0";
#
# Macro substitutions:
#
# We convert the following notations:
#
# .ops file Op body Meaning Comment
# ----------------- ------- ------------ ----------------------------------
# goto OFFSET(X) {{+=X}} PC' = PC + X Used for branches
# goto NEXT() {{+=S}} PC' = PC + S Where S is op size
# goto ADDRESS(X) {{=X}} PC' = X Used for absolute jumps
# goto POP() {{=*}} PC' = <pop> Pop address off control stack
# expr OFFSET(X) {{^+X}} PC + X Relative address
# expr NEXT() {{^+S}} PC + S Where S is op size
# expr ADDRESS(X) {{^X}} X Absolute address
# OP_SIZE {{^S}} S op size
#
# HALT() {{=0}} PC' = 0 Halts run_ops loop, no resume
#
# restart OFFSET(X) {{=0,+=X}} PC' = 0 Restarts at PC + X
# restart NEXT() {{=0,+=S}} PC' = 0 Restarts at PC + S
#
# $X {{@X}} Argument X $0 is opcode, $1 is first arg
#
# For ease of parsing, if the argument to one of the above
# notations in a .ops file contains parentheses, then double the
# enclosing parentheses and add a space around the argument,
# like so:
#
# goto OFFSET(( (void*)interpreter->happy_place ))
#
# Later transformations turn the Op body notations into C code, based
# on the mode of operation (function calls, switch statements, gotos
# with labels, etc.).
#
# TODO: Complain about using, e.g. $3 in an op with only 2 args.
#
$branch ||= $body =~ s/\bgoto\s+OFFSET\(\( (.*?) \)\)/{{+=$1}}/mg;
$absolute ||= $body =~ s/\bgoto\s+ADDRESS\(\( (.*?) \)\)/{{=$1}}/mg;
$body =~ s/\bexpr\s+OFFSET\(\( (.*?) \)\)/{{^+$1}}/mg;
$body =~ s/\bexpr\s+ADDRESS\(\( (.*?) \)\)/{{^$1}}/mg;
$body =~ s/\bOP_SIZE\b/{{^$op_size}}/mg;
$branch ||= $body =~ s/\bgoto\s+OFFSET\((.*?)\)/{{+=$1}}/mg;
$body =~ s/\bgoto\s+NEXT\(\)/{{+=$op_size}}/mg;
$absolute ||= $body =~ s/\bgoto\s+ADDRESS\((.*?)\)/{{=$1}}/mg;
$pop ||= $body =~ s/\bgoto\s+POP\(\)/{{=*}}/mg;
$body =~ s/\bexpr\s+OFFSET\((.*?)\)/{{^+$1}}/mg;
$next ||= $body =~ s/\bexpr\s+NEXT\(\)/{{^+$op_size}}/mg;
$body =~ s/\bexpr\s+ADDRESS\((.*?)\)/{{^$1}}/mg;
$body =~ s/\bexpr\s+POP\(\)/{{^*}}/mg;
$body =~ s/\bHALT\(\)/{{=0}}/mg;
$branch ||= $short_name =~ /runinterp/;
$next ||= $short_name =~ /runinterp/;
if ($body =~ s/\brestart\s+OFFSET\((.*?)\)/{{=0,+=$1}}/mg)
{
$branch = 1;
$restart = 1;
}
elsif($body =~ s/\brestart\s+NEXT\(\)/{{=0,+=$op_size}}/mg)
{
$restart = 1;
$next = 1;
}
elsif($short_name eq 'branch_cs' || $short_name eq 'returncc')
{
$restart = 1; # dest may be NULL to leave run-loop
}
elsif ($body =~ s/\brestart\s+ADDRESS\((.*?)\)/{{=$1}}/mg)
{
$next = 0;
$restart = 1;
}
$body =~ s/\$(\d+)/{{\@$1}}/mg;
my $file_escaped = $file;
$file_escaped =~ s|(\\)|$1$1|g; # escape backslashes
$op->body( $nolines ? $body : qq{#line $line "$file_escaped"\n$body} );
# Constants here are defined in include/parrot/op.h
or_flag(\$jumps, "PARROT_JUMP_RELATIVE") if ($branch);
or_flag(\$jumps, "PARROT_JUMP_ADDRESS") if ($absolute);
or_flag(\$jumps, "PARROT_JUMP_POP") if ($pop);
or_flag(\$jumps, "PARROT_JUMP_ENEXT") if ($next);
# I'm assuming the op branches to the value in the last argument.
or_flag(\$jumps, "PARROT_JUMP_GNEXT") if (($jumps) && ($fixedargs[@fixedargs - 1]) && ($fixedargs[@fixedargs - 1] eq 'i'));
or_flag(\$jumps, "PARROT_JUMP_RESTART") if ($restart);
$op->jump($jumps);
$self->push_op($op);
$counter++;
}
return $counter;
}
=item C<expand_args(@args)>
Given an argument list, returns a list of all the possible argument
combinations.
=cut
sub expand_args
{
my (@args) = @_;
return "" if (!scalar(@args));
my $arg = shift(@args);
my @var = split(/\|/,$arg);
if (!scalar(@args))
{
return @var;
}
else
{
my @list = expand_args(@args);
my @results;
foreach my $l (@list)
{
foreach my $v (@var)
{
push(@results,"$v,$l");
}
}
return @results;
}
}
=item C<ops()>
Returns the C<Parrot::Op> instances found in the file(s).
=cut
sub ops
{
my ($self) = @_;
return @{$self->{OPS}};
}
=item C<op($index)>
Returns the op at C<$index>.
=cut
sub op
{
my ($self, $index) = @_;
return $self->{OPS}[$index];
}
=item C<preamble()>
=item C<preamble($trans)>
Returns any lines found prior to first op definition.
If C<$trans> (an C<Parrot::OpTrans> subclass) is supplied then
substitutions are made.
=cut
sub preamble
{
my($self, $trans) = @_;
local $_ = $self->{PREAMBLE};
if ($trans)
{
s/goto\s+OFFSET\((.*)\)/{{+=$1}}/mg;
#s/goto\s+NEXT\(\)/{{+=$op_size}}/mg; #not supported--dependent on op size
s/goto\s+ADDRESS\((.*)\)/{{=$1}}/mg;
s/goto\s+POP\(\)/{{=*}}/mg;
s/HALT\(\)/{{=0}}/mg;
# FIXME: This ought to throw errors when attempting to rewrite $n
# argument accesses and other things that make no sense in the
# preamble.
$_ = Parrot::Op->rewrite_body($_, $trans);
}
return $_;
}
=item C<version($major, $minor, $patch)>
=item C<version($version)>
=item C<version()>
Sets/gets the version number.
=cut
sub version
{
my $self = shift;
if (@_ == 1)
{
$self->{VERSION} = shift;
}
elsif (@_ == 3)
{
$self->{VERSION} = join('.', @_);
}
elsif (@_ == 0)
{
if (wantarray)
{
return split(/\./, $self->{VERSION});
}
else
{
return $self->{VERSION};
}
}
else
{
die "Parrot::OpsFile::version(): Illegal argument count" . scalar(@_) . "!";
}
}
=item C<major_version()>
Returns the major version number.
=cut
sub major_version
{
my $self = shift;
$self->{VERSION} =~ m/^(\d+)\./;
return $1;
}
=item C<minor_version()>
Returns the minor version number.
=cut
sub minor_version
{
my $self = shift;
$self->{VERSION} =~ m/^\d+\.(\d+)\./;
return $1;
}
=item C<patch_version()>
Returns the patch version number.
=cut
sub patch_version
{
my $self = shift;
$self->{VERSION} =~ m/^\d+\.\d+\.(\d+)/;
return $1;
}
=item C<push_op($op)>
Adds C<$op> to the end of the op list.
=cut
sub push_op
{
my ($self, $op) = @_;
push @{$self->{OPS}}, $op;
}
=back
=head1 SEE ALSO
=over 4
=item C<Parrot::Op>
=item C<Parrot::OpTrans>
=item F<tools/build/ops2c.pl>
=item F<tools/build/ops2pm.pl>
=item F<tools/build/pbc2c.pl>
=back
=cut
1;