-
Notifications
You must be signed in to change notification settings - Fork 138
/
Compiler.pm
727 lines (584 loc) · 21.2 KB
/
Compiler.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
# Copyright (C) 2001-2008, Parrot Foundation.
# $Id$
=head1 NAME
Parrot::Configure::Compiler - C-Related methods for configuration
=head1 DESCRIPTION
The Parrot::Configure::Compiler module provides methods inherited by
Parrot::Configure which prepare and/or run C programs during
compilation.
=head2 Methods
=over 4
=cut
package Parrot::Configure::Compiler;
use strict;
use warnings;
use base qw( Exporter );
use Carp;
use File::Spec;
use lib ("lib");
use Parrot::Configure::Utils qw(
prompt copy_if_diff move_if_diff integrate
capture_output check_progs _slurp
_run_command _build_compile_command
move_if_diff
);
# report the makefile and lineno
sub makecroak {
my ($conf, $error) = @_;
my ($file, $line) = ($conf->{_compiler_file}, $conf->{_compiler_line});
die "$error at $file line $line\n";
}
our %file_types_info = (
makefile => {
comment_type => '#',
},
c => {
comment_type => '/*',
},
pmc => {
comment_type => '/*',
},
perl => {
comment_type => '#',
},
pir => {
comment_type => '#',
},
);
=item C<cc_gen()>
$conf->cc_gen($source)
Generates F<test_$$.c> from the specified source file.
=cut
sub cc_gen {
my $conf = shift;
my $source = shift;
$conf->genfile( $source, "test_$$.c", file_type => 'c' );
}
=item C<cc_build()>
$conf->cc_build($cc_args, $link_args)
These items are used from current config settings:
$cc, $ccflags, $ldout, $o, $link, $linkflags, $cc_exe_out, $exe, $libs
Calls the compiler and linker on F<test_$$.c>.
=cut
sub cc_build {
my $conf = shift;
my ( $cc_args, $link_args ) = @_;
$cc_args = '' unless defined $cc_args;
$link_args = '' unless defined $link_args;
my $verbose = $conf->options->get('verbose');
my ( $cc, $ccflags, $ldout, $o, $link, $linkflags, $cc_exe_out, $exe, $libs ) =
$conf->data->get(qw(cc ccflags ld_out o link linkflags cc_exe_out exe libs));
# unique test file name for parallel builds
my $test = 'test_' . $$;
my $compile_command = _build_compile_command( $cc, $ccflags, $cc_args );
my $compile_result = _run_command( $compile_command, "$test.cco", "$test.cco", $verbose );
if ($compile_result) {
confess "C compiler failed (see $test.cco)";
return $compile_result;
}
my $link_result =
_run_command( "$link $linkflags $test$o $link_args ${cc_exe_out}${test}${exe} $libs",
"$test.ldo", "$test.ldo", $verbose )
and confess "Linker failed (see $test.ldo)";
if ($link_result) {
return $link_result;
}
}
=item C<cc_run()>
$conf->cc_run();
Calls the F<test> (or F<test.exe>) executable. Any output is directed to
F<test.out>.
=cut
sub cc_run {
my $conf = shift;
my $exe = $conf->data->get('exe');
my $slash = $conf->data->get('slash');
my $verbose = $conf->options->get('verbose');
my $test = 'test_' . $$;
my $test_exe = ".${slash}${test}${exe}";
my $run_error;
if ( defined( $_[0] ) && length( $_[0] ) ) {
local $" = ' ';
$run_error = _run_command( "$test_exe @_", "./$test.out", undef, $verbose );
}
else {
$run_error = _run_command( $test_exe, "./$test.out", undef, $verbose );
}
my $output = _slurp("./$test.out");
return $output;
}
=item C<cc_run_capture()>
$conf->cc_run_capture();
Same as C<cc_run()> except that warnings and errors are also directed to
F<test.out>.
=cut
sub cc_run_capture {
my $conf = shift;
my $exe = $conf->data->get('exe');
my $slash = $conf->data->get('slash');
my $verbose = $conf->options->get('verbose');
my $test = 'test_' . $$;
if ( defined( $_[0] ) && length( $_[0] ) ) {
local $" = ' ';
_run_command( ".${slash}$test${exe} @_", "./$test.out", "./$test.out", $verbose );
}
else {
_run_command( ".${slash}$test${exe}", "./$test.out", "./$test.out", $verbose );
}
my $output = _slurp("./$test.out");
return $output;
}
=item C<cc_clean()>
$conf->cc_clean();
Cleans up all files in the root folder that match the glob F<test.*>.
=cut
sub cc_clean { ## no critic Subroutines::RequireFinalReturn
my $conf = shift;
unlink map "test_${$}$_", qw( .c .cco .ldo .out ),
$conf->data->get(qw( o exe )),
# MSVC
qw( .exe.manifest .ilk .pdb );
}
=item C<genfile()>
$conf->genfile($source, $target, %options);
Takes the specified source file, replacing entries like C<@FOO@> with
C<FOO>'s value from the configuration system's data, and writes the results
to specified target file.
Respects the following options when manipulating files (Note: most of the
replacement syntax assumes the source text is on a single line.)
=over 4
=item file_type
If set to a C<makefile>, C<c> or C<perl> value, C<comment_type> will be set
to corresponding value.
Moreover, when set to a C<makefile> value, it will set C<replace_slashes> to
enabled, and C<conditioned_lines> to enabled.
Its value will be detected automatically by target file name unless you set
it to a special value C<none>.
=item conditioned_lines #IF #UNLESS #ELSIF #ELSE
If conditioned_lines is true, then lines beginning in #IF, #UNLESS, #ELSIF, and
#ELSE are evaluated conditionally, and the content after the C<:> is included
or excluded, dependending on the evaluation of the expression.
Lines beginning with C<#IF(expr):> are skipped if the expr condition is false,
otherwise the content after the C<:> is inserted. Lines beginning with
C<#UNLESS(expr):> are skipped if the expr condition is true, otherwise the
content after the C<:> is inserted. Lines beginning with C<#ELSIF(expr):> or
C<#ELSE:> are evaluated if the preceding C<#IF(expr):> evaluated to false.
A condition expr may be:
* A single key, which is true if a config key is true,
* Equal to the platform name or the osname - case-sensitive,
* A C<key==value> expression, which is trun if the config key has the
expected value, or
* A logical combination of C<|>, C<OR>, C<&>, C<AND>, C<!>, C<NOT>.
A key must only consist of the characters A-Z a-z 0-9 _ -, and is checked
case-sensitively against the configuration key or the platform name. Truth is
defined as any value that is not 0, an empty string, or C<undef>.
The value in C<key==value> expressions may not contain spaces. Quotes in
values are not supported.
The word ops C<AND>, C<OR> and C<NOT> are case-insensitive. C<!> and C<NOT>
bind closer than C<&>, C<AND>, C<|>, and C<OR>. The order of precedence for
C<AND> and C<OR> is undefined.
For instance:
#IF(win32): $(SRC_DIR)/atomic/gcc_x86$(O)
will be included if the platform is win32.
#IF(cpuarch==i386): $(SRC_DIR)/atomic/gcc_x86$(O)
will be included if the value of the config key "cpuarch" is "i386".
#IF(cpuarch==i386): $(SRC_DIR)/atomic/gcc_x86$(O)
#ELSIF(cpuarch==sparcv9): $(SRC_DIR)/atomic/sparc_v9.s
#ELSE:
will include " $(SRC_DIR)/atomic/gcc_x86$(O)" if the config key "cpuarch" is
ste to "i386", will include " $(SRC_DIR)/atomic/sparc_v9.s" instead if
"cpuarch" is set to "sparcv9", and will include an empty line otherwise.
#IF(win32 and glut and not cygwin):
will be used on "win32" and if "glut" is defined, but not on "cygwin".
B<Legacy Syntax:>
The old syntax #CONDITIONED_LINE(var): and
#INVERSE_CONDITIONED_LINE(var): is still supported, but is deprecated.
=item comment_type
This option takes has two possible values, C<#> or C</*>. If present and
set to one of these two values, the generated file will contain a
generated header that is commented out appropriately.
=item ignore_pattern
A regular expression. Any lines in the file matching this expression are
ignored when determining if the target file has changed (and should therefore
be overwritten with a new copy).
=item feature_file
When feature_file is set to a true value, a lines beginning with C<#perl>
forces the remaining lines of the file to be evaluated as perl code. Before
this evaluation occurs, any substitution of @@ values is performed on the
original text.
=item replace_slashes
If set to a true value, this causes any C</>s in the file to automatically
be replaced with an architecture appropriate slash. C</> or C<\>. This is
a very helpful option when writing Makefiles.
=item expand_gmake_syntax
If set to a true value, then certain types of I<gmake> syntax will be expanded
into their full equivalents. For example:
$(wildcard PATTERN)
Will be replaced B<at config time> with the list of files that match this
pattern. Note! Be very careful when determining whether or not to disable
this expansion during config time and letting I<gmake> evaluate these: the
config system itself may change state of the filesystem, causing the
directives to expand differently depending on when they're run. Another
potential issue to consider there is that most makefiles, while generated
from the root directory, are B<run> from a subdirectory. So relative path names
become an issue.
The I<gmake> replacements are done repeatedly on a single line, so nested
syntax works ok.
=over 4
=item addprefix
=item basename
=item wildcard
=item notdir
=back
=back
=back
=cut
sub genfile {
my $conf = shift;
my ( $source, $target, %options ) = @_;
my $calling_sub = (caller(1))[3] || q{};
if ( $calling_sub !~ /cc_gen$/ ) {
$conf->append_configure_log($target);
}
open my $in, '<', $source or die "Can't open $source: $!";
open my $out, '>', "$target.tmp" or die "Can't open $target.tmp: $!";
if ( !exists $options{file_type}) {
if ( $target =~ m/makefile$/i ) {
$options{file_type} = 'makefile';
}
elsif ($target =~ m/\.p[lm]$/i ) {
$options{file_type} = 'perl';
}
elsif ($target =~ m/\.[hc]$/ ) {
$options{file_type} = 'c';
}
elsif ($target =~ m/\.pmc$/ ) {
$options{file_type} = 'pmc';
}
elsif ($target =~ m/\.pir$/ ) {
$options{file_type} = 'pir';
}
} elsif ( $options{file_type} eq 'none' ) {
delete $options{file_type};
}
if ( $options{file_type} ) {
unless ( exists $file_types_info{$options{file_type}} ) {
die "Unknown file_type '$options{file_type}'";
}
unless ( exists $options{comment_type} ) {
$options{comment_type} =
$file_types_info{$options{file_type}}{comment_type};
}
if ( $options{file_type} eq 'makefile' ) {
$options{replace_slashes} = 1;
$options{conditioned_lines} = 1;
$options{no_simply_expanded_var} = ! $conf->data->get('gmake_version');
}
}
if ( $options{comment_type} ) {
my @comment = ( 'ex: set ro:',
'DO NOT EDIT THIS FILE',
'Generated by ' . __PACKAGE__ . " from $source" );
if ( $options{comment_type} eq '#' ) {
foreach my $line (@comment) {
$line = "# $line\n";
}
}
elsif ( $options{comment_type} eq '/*' ) {
foreach my $line (@comment) {
$line = " * $line\n";
}
$comment[0] =~ s{^}{/*\n}; # '/*'
$comment[-1] =~ s{$}{\n */}; # ' */'
}
else {
die "Unknown comment type '$options{comment_type}'";
}
print {$out} @comment, "\n"; # extra newline after header
}
if ($target eq 'CFLAGS') {
$options{conditioned_lines} = 1;
}
# this loop can not be implemented as a foreach loop as the body
# is dependent on <IN> being evaluated lazily
$conf->{_compiler_file} = $source;
my $former_truth = -1;
LINE:
while ( my $line = <$in> ) {
$conf->{_compiler_line} = $.;
# everything after the line starting with #perl is eval'ed
if ( $line =~ /^#perl/ && $options{feature_file} ) {
# OUT was/is used at the output filehandle in eval'ed scripts
# e.g. feature.pl or feature_h.in
no warnings 'once';
local *OUT = $out;
use warnings;
my $text = do { local $/; <$in> };
# interpolate @foo@ values
$text =~ s{ \@ (\w+) \@ }{\$conf->data->get("$1")}gx;
eval $text;
croak $@ if $@;
last LINE;
}
if ( $options{conditioned_lines} ) {
my ($op, $expr, $rest);
# allow multiple keys and nested parens here
if (($op,$expr,$rest)=($line =~ m/^#(IF|UNLESS|ELSIF)\((.+)\):(.*)/s)) {
if (($op eq 'ELSIF') and $former_truth) {
next LINE; # no useless check if former IF was true
}
my $truth = cond_eval($conf, $expr);
if ($op eq 'IF') {
$former_truth = $truth;
next LINE unless $truth;
}
elsif ($op eq 'UNLESS') {
$former_truth = !$truth;
next LINE if $truth;
}
elsif ($op eq 'ELSIF') {
$former_truth = $truth;
next LINE unless $truth;
}
$line = $rest;
}
elsif ( $former_truth != -1 and $line =~ m/^#ELSE:(.*)/s ) {
next LINE if $former_truth;
$line = $1;
}
# Legacy, DEPRECATED.
elsif (($expr,$rest)=($line =~ m/^#CONDITIONED_LINE\(([^)]+)\):(.*)/s)) {
next LINE unless cond_eval($conf, $expr);
$line = $rest;
}
elsif (($expr,$rest)=($line =~ m/^#INVERSE_CONDITIONED_LINE\(([^)]+)\):(.*)/s )) {
next LINE if cond_eval($conf, $expr);
$line = $rest;
}
else { # reset
$former_truth = -1; # ELSE must immediately follow a conditional.
}
}
# interpolate gmake-ish expansions..
if ( $options{expand_gmake_syntax} ) {
my $any_gmake;
GMAKES:
$any_gmake = 0;
if (
$line =~ s{\$ \( wildcard \s+ ([^)]+) \)}{
join (' ', glob $1)
}egx
)
{
$any_gmake++;
}
if (
$line =~ s{\$ \( notdir \s+ ([^)]+) \)}{
join (' ',
map { (File::Spec->splitpath($_))[2] }
split(' ', $1)
)
}egx
)
{
$any_gmake++;
}
# documented as removing any .-based suffix
if (
$line =~ s{\$ \( basename \s+ ([^)]+) \)}{
join (' ',
map {
my @split = File::Spec->splitpath($_);
$split[2] =~ s/\.[^.]*$//;
File::Spec->catpath(@split);
} split(' ', $1)
)
}egx
)
{
$any_gmake++;
}
if (
$line =~ s{\$ \( addprefix \s+ ([^,]+) \s* , \s* ([^)]+) \)}{
my ($prefix,$list) = ($1, $2);
join (' ',
map { $_ = $prefix . $_ }
split(' ', $list)
)
}egx
)
{
$any_gmake++;
}
# we might have only gotten the innermost expression. try again.
goto GMAKES if $any_gmake;
}
# interpolate @foo@ values
$line =~ s{ \@ (\w+) \@ }{
if(defined(my $val=$conf->data->get($1))) {
#use Data::Dumper;warn Dumper("val for $1 is ",$val);
$val;
}
else {
warn "value for '$1' in $source is undef";
'';
}
}egx;
if ( $options{replace_slashes} ) {
if ( $line =~ m{/$} ) {
croak "$source:$.: line ends in a slash\n";
}
$line =~ s{(/+)}{
my $len = length $1;
my $slash = $conf->data->get('slash');
'/' x ($len/2) . ($len%2 ? $slash : '');
}eg;
# replace \* with \\*, so make will not eat the \
$line =~ s{(\\\*)}{\\$1}g;
}
if ( $options{no_simply_expanded_var} ) {
# replace := with =
$line =~ s{:=}{=};
}
print $out $line;
}
close($in) or die "Can't close $source: $!";
close($out) or die "Can't close $target: $!";
move_if_diff( "$target.tmp", $target, $options{ignore_pattern} );
}
# Return the next subexpression from the expression in $_[0]
# and remove it from the input expression.
# Allowed chars: A-Z a-z 0-9 _ -, so let's take [-\w].
# E.g. "(not win32 and has_glut)"
# => not win32 => has_glut
# "(!win32&has_glut)|cygwin" - perl-style
# !win32&has_glut => !win32 => &has_glut => |cygwin
sub next_expr {
my $s = $_[0];
return "" unless $s;
# start of a subexpression?
if ($s =~ /^\((.+)\)\s*(.*)/o) { # longest match to matching closing paren
$_[0] = $2 ? $2 : ""; # modify the 2nd arg
return $1;
}
else {
$s =~ s/^\s+//; # left-trim to make it more robust
if ($s =~ m/^([-\w=]+)\s*(.*)?/o) { # shortest match to next non-word char
# start with word expr
$_[0] = $2 ? $2 : ""; # modify the 2nd arg expr in the caller
return $1;
}
else {
# special case: start with non-word op (perl-syntax only)
$s =~ m/^([|&!])\s*(.*)?/o; # shortest match to next word char
$_[0] = $2 ? $2 : ""; # modify the 2nd arg expr in the caller
return $1;
}
}
}
# Checks the logical truth of the hash value: exists and not empty.
# Also check the platform name, the 'osname' key, if the hash key does not exist.
# Also check for key==value, like #IF(ld==gcc)
sub cond_eval_single {
my $conf = $_[0];
my $key = $_[1];
return unless defined $key;
if ($key =~ /^([-\w]+)==(.+)$/) {
return ($2 eq $conf->data->get($1));
}
else {
return exists($conf->data->{c}->{$key})
? ($conf->data()->get($key) ? 1 : 0)
: $key eq $conf->data()->get('osname');
}
}
sub truth { $_[0] ? "true" : "false"; }
# Recursively evaluate boolean expressions with multiple keys and | & ! ops.
# Order of precedence: Just "!" and "NOT" binds tighter than AND and OR.
# There's no precedence for AND over OR defined, just left to right.
sub cond_eval {
my $conf = $_[0];
my $expr = $_[1];
my @count = split /[\s!&|\(]+/, $expr; # optimizable with tr
if (@count > 1) { # multiple keys: recurse into
my $truth = 0;
my $prevtruth = 0;
my $key = next_expr($expr);
my $op = '';
LOOP:
while ($key) {
if (($key eq '!') or (uc($key) eq 'NOT')) {
# bind next key immediately
$op = 'NOT';
$key = next_expr($expr);
}
elsif ($truth and ($op eq 'OR')) {
# true OR: => true
last LOOP;
}
$prevtruth = $truth;
if (!$truth and ($op eq 'AND')) { # false AND: => false, skip rest
last LOOP;
}
$truth = cond_eval($conf, $key);
if ($op eq 'NOT') { # NOT *: invert
$truth = $truth ? 0 : 1;
}
elsif ($op eq 'AND' and !$truth) { # * AND false: => false
last LOOP;
}
# * OR false => * (keep $truth). true OR * already handled before
my $prevexpr = $expr;
$op = next_expr($expr);
if ($op) {
if ($op eq '|' or uc($op) eq 'OR') {
$op = 'OR';
}
elsif ($op eq '&' or uc($op) eq 'AND') {
$op = 'AND';
}
elsif ($op eq '!' or uc($op) eq 'NOT') {
$op = 'NOT';
}
else {
makecroak($conf, "invalid op \"$op\" in \"$_[1]\" at \"$prevexpr\"");
}
$key = next_expr($expr);
}
elsif ($prevexpr) {
makecroak($conf, "Makefile conditional syntax error: missing op in \"$_[1]\" at \"$prevexpr\"");
}
else {
last LOOP; # end of expr, nothing left
}
if ($prevexpr eq $expr) {
makecroak($conf, "Makefile conditional parser error in \"$_[1]\" at \"$prevexpr\"");
}
}
return $truth;
}
cond_eval_single($conf, $expr);
}
sub append_configure_log {
my $conf = shift;
my $target = shift;
if ( $conf->{active_configuration} ) {
my $generated_log = 'MANIFEST.configure.generated';
open my $GEN, '>>', $generated_log
or die "Can't open $generated_log for appending: $!";
print $GEN "$target\n";
close $GEN or die "Can't close $generated_log after appending: $!";
}
}
=head1 SEE ALSO
=over 4
=item F<docs/configuration.pod>
=back
=cut
1;
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 100
# End:
# vim: expandtab shiftwidth=4: