This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
3db9c416c1bde0ee9b221b3ce6b52b006df0e388
[perl5.git] / regen / embed.pl
1 #!/usr/bin/perl -w
2
3 # Regenerate (overwriting only if changed):
4 #
5 #    embed.h
6 #    embedvar.h
7 #    perlapi.c
8 #    perlapi.h
9 #    proto.h
10 #
11 # from information stored in
12 #
13 #    embed.fnc
14 #    intrpvar.h
15 #    perlvars.h
16 #    regen/opcodes
17 #
18 # Accepts the standard regen_lib -q and -v args.
19 #
20 # This script is normally invoked from regen.pl.
21
22 require 5.004;  # keep this compatible, an old perl is all we may have before
23                 # we build the new one
24
25 use strict;
26
27 BEGIN {
28     # Get function prototypes
29     require 'regen/regen_lib.pl';
30     require 'regen/embed_lib.pl';
31 }
32
33 my $SPLINT = 0; # Turn true for experimental splint support http://www.splint.org
34 my $unflagged_pointers;
35
36 #
37 # See database of global and static function prototypes in embed.fnc
38 # This is used to generate prototype headers under various configurations,
39 # export symbols lists for different platforms, and macros to provide an
40 # implicit interpreter context argument.
41 #
42
43 sub full_name ($$) { # Returns the function name with potentially the
44                      # prefixes 'S_' or 'Perl_'
45     my ($func, $flags) = @_;
46
47     return "S_$func" if $flags =~ /[si]/;
48     return "Perl_$func" if $flags =~ /[bp]/;
49     return $func;
50 }
51
52 sub open_print_header {
53     my ($file, $quote) = @_;
54
55     return open_new($file, '>',
56                     { file => $file, style => '*', by => 'regen/embed.pl',
57                       from => ['data in embed.fnc', 'regen/embed.pl',
58                                'regen/opcodes', 'intrpvar.h', 'perlvars.h'],
59                       final => "\nEdit those files and run 'make regen_headers' to effect changes.\n",
60                       copyright => [1993 .. 2009], quote => $quote });
61 }
62
63 my ($embed, $core, $ext, $api) = setup_embed();
64
65 # generate proto.h
66 {
67     my $pr = open_print_header("proto.h");
68     print $pr "START_EXTERN_C\n";
69     my $ret;
70
71     foreach (@$embed) {
72         if (@$_ == 1) {
73             print $pr "$_->[0]\n";
74             next;
75         }
76
77         my ($flags,$retval,$plain_func,@args) = @$_;
78         my @nonnull;
79         my $has_context = ( $flags !~ /n/ );
80         my $never_returns = ( $flags =~ /r/ );
81         my $commented_out = ( $flags =~ /m/ );
82         my $binarycompat = ( $flags =~ /b/ );
83         my $is_malloc = ( $flags =~ /a/ );
84         my $can_ignore = ( $flags !~ /R/ ) && !$is_malloc;
85         my @names_of_nn;
86         my $func;
87
88         if (! $can_ignore && $retval eq 'void') {
89             warn "It is nonsensical to require the return value of a void function ($plain_func) to be checked";
90         }
91
92         my $scope_type_flag_count = 0;
93         $scope_type_flag_count++ if $flags =~ /s/;
94         $scope_type_flag_count++ if $flags =~ /i/;
95         $scope_type_flag_count++ if $flags =~ /p/;
96         warn "$plain_func: i, p, and s flags are all mutually exclusive"
97                                                    if $scope_type_flag_count > 1;
98         my $splint_flags = "";
99         if ( $SPLINT && !$commented_out ) {
100             $splint_flags .= '/*@noreturn@*/ ' if $never_returns;
101             if ($can_ignore && ($retval ne 'void') && ($retval !~ /\*/)) {
102                 $retval .= " /*\@alt void\@*/";
103             }
104         }
105
106         if ($flags =~ /([si])/) {
107             my $type;
108             if ($never_returns) {
109                 $type = $1 eq 's' ? "PERL_STATIC_NO_RET" : "PERL_STATIC_INLINE_NO_RET";
110             }
111             else {
112                 $type = $1 eq 's' ? "STATIC" : "PERL_STATIC_INLINE";
113             }
114             $retval = "$type $splint_flags$retval";
115         }
116         else {
117             if ($never_returns) {
118                 $retval = "PERL_CALLCONV_NO_RET $splint_flags$retval";
119             }
120             else {
121                 $retval = "PERL_CALLCONV $splint_flags$retval";
122             }
123         }
124         $func = full_name($plain_func, $flags);
125         $ret = "$retval\t$func(";
126         if ( $has_context ) {
127             $ret .= @args ? "pTHX_ " : "pTHX";
128         }
129         if (@args) {
130             my $n;
131             for my $arg ( @args ) {
132                 ++$n;
133                 if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
134                     warn "$func: $arg needs NN or NULLOK\n";
135                     ++$unflagged_pointers;
136                 }
137                 my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
138                 push( @nonnull, $n ) if $nn;
139
140                 my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect
141
142                 # Make sure each arg has at least a type and a var name.
143                 # An arg of "int" is valid C, but want it to be "int foo".
144                 my $temp_arg = $arg;
145                 $temp_arg =~ s/\*//g;
146                 $temp_arg =~ s/\s*\bstruct\b\s*/ /g;
147                 if ( ($temp_arg ne "...")
148                      && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
149                     warn "$func: $arg ($n) doesn't have a name\n";
150                 }
151                 if ( $SPLINT && $nullok && !$commented_out ) {
152                     $arg = '/*@null@*/ ' . $arg;
153                 }
154                 if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
155                     push @names_of_nn, $1;
156                 }
157             }
158             $ret .= join ", ", @args;
159         }
160         else {
161             $ret .= "void" if !$has_context;
162         }
163         $ret .= ")";
164         my @attrs;
165         if ( $flags =~ /r/ ) {
166             push @attrs, "__attribute__noreturn__";
167         }
168         if ( $flags =~ /D/ ) {
169             push @attrs, "__attribute__deprecated__";
170         }
171         if ( $is_malloc ) {
172             push @attrs, "__attribute__malloc__";
173         }
174         if ( !$can_ignore ) {
175             push @attrs, "__attribute__warn_unused_result__";
176         }
177         if ( $flags =~ /P/ ) {
178             push @attrs, "__attribute__pure__";
179         }
180         if( $flags =~ /f/ ) {
181             my $prefix  = $has_context ? 'pTHX_' : '';
182             my ($args, $pat);
183             if ($args[-1] eq '...') {
184                 $args   = scalar @args;
185                 $pat    = $args - 1;
186                 $args   = $prefix . $args;
187             }
188             else {
189                 # don't check args, and guess which arg is the pattern
190                 # (one of 'fmt', 'pat', 'f'),
191                 $args = 0;
192                 my @fmts = grep $args[$_] =~ /\b(f|pat|fmt)$/, 0..$#args;
193                 if (@fmts != 1) {
194                     die "embed.pl: '$plain_func': can't determine pattern arg\n";
195                 }
196                 $pat = $fmts[0] + 1;
197             }
198             my $macro   = grep($_ == $pat, @nonnull)
199                                 ? '__attribute__format__'
200                                 : '__attribute__format__null_ok__';
201             if ($plain_func =~ /strftime/) {
202                 push @attrs, sprintf "%s(__strftime__,%s1,0)", $macro, $prefix;
203             }
204             else {
205                 push @attrs, sprintf "%s(__printf__,%s%d,%s)", $macro,
206                                     $prefix, $pat, $args;
207             }
208         }
209         if ( @attrs ) {
210             $ret .= "\n";
211             $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
212         }
213         $ret .= ";";
214         $ret = "/* $ret */" if $commented_out;
215         if (@names_of_nn) {
216             $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E\t\\\n\t"
217                 . join '; ', map "assert($_)", @names_of_nn;
218         }
219         $ret .= @attrs ? "\n\n" : "\n";
220
221         print $pr $ret;
222     }
223
224     print $pr <<'EOF';
225 #ifdef PERL_CORE
226 #  include "pp_proto.h"
227 #endif
228 END_EXTERN_C
229 EOF
230
231     read_only_bottom_close_and_rename($pr);
232 }
233
234 warn "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;
235
236 sub readvars {
237     my ($file, $pre) = @_;
238     local (*FILE, $_);
239     my %seen;
240     open(FILE, "< $file")
241         or die "embed.pl: Can't open $file: $!\n";
242     while (<FILE>) {
243         s/[ \t]*#.*//;          # Delete comments.
244         if (/PERLVARA?I?C?\($pre,\s*(\w+)/) {
245             warn "duplicate symbol $1 while processing $file line $.\n"
246                 if $seen{$1}++;
247         }
248     }
249     close(FILE);
250     return sort keys %seen;
251 }
252
253 my @intrp = readvars 'intrpvar.h','I';
254 my @globvar = readvars 'perlvars.h','G';
255
256 sub hide {
257     my ($from, $to, $indent) = @_;
258     $indent = '' unless defined $indent;
259     my $t = int(length("$indent$from") / 8);
260     "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
261 }
262
263 sub multon ($$$) {
264     my ($sym,$pre,$ptr) = @_;
265     hide("PL_$sym", "($ptr$pre$sym)");
266 }
267
268 my $em = open_print_header('embed.h');
269
270 print $em <<'END';
271 /* (Doing namespace management portably in C is really gross.) */
272
273 /* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
274  * (like warn instead of Perl_warn) for the API are not defined.
275  * Not defining the short forms is a good thing for cleaner embedding. */
276
277 #ifndef PERL_NO_SHORT_NAMES
278
279 /* Hide global symbols */
280
281 END
282
283 my @az = ('a'..'z');
284
285 sub embed_h {
286     my ($guard, $funcs) = @_;
287     print $em "$guard\n" if $guard;
288
289     my $lines;
290     foreach (@$funcs) {
291         if (@$_ == 1) {
292             my $cond = $_->[0];
293             # Indent the conditionals if we are wrapped in an #if/#endif pair.
294             $cond =~ s/#(.*)/#  $1/ if $guard;
295             $lines .= "$cond\n";
296             next;
297         }
298         my $ret = "";
299         my ($flags,$retval,$func,@args) = @$_;
300         unless ($flags =~ /[om]/) {
301             my $args = scalar @args;
302             if ($flags =~ /n/) {
303                 $ret = hide($func, full_name($func, $flags));
304             }
305             elsif ($args and $args[$args-1] =~ /\.\.\./) {
306                 if ($flags =~ /p/) {
307                     # we're out of luck for varargs functions under CPP
308                     # So we can only do these macros for no implicit context:
309                     $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
310                         . hide($func, full_name($func, $flags)) . "#endif\n";
311                 }
312             }
313             else {
314                 my $alist = join(",", @az[0..$args-1]);
315                 $ret = "#define $func($alist)";
316                 my $t = int(length($ret) / 8);
317                 $ret .=  "\t" x ($t < 4 ? 4 - $t : 1);
318                 $ret .= full_name($func, $flags) . "(aTHX";
319                 $ret .= "_ " if $alist;
320                 $ret .= $alist . ")\n";
321             }
322         }
323         $lines .= $ret;
324     }
325     # Prune empty #if/#endif pairs.
326     while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
327     }
328     # Merge adjacent blocks.
329     while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
330 [^\n]+
331 )#endif
332 #ifndef PERL_IMPLICIT_CONTEXT
333 /$1/) {
334     }
335
336     print $em $lines;
337     print $em "#endif\n" if $guard;
338 }
339
340 embed_h('', $api);
341 embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', $ext);
342 embed_h('#ifdef PERL_CORE', $core);
343
344 print $em <<'END';
345
346 #endif  /* #ifndef PERL_NO_SHORT_NAMES */
347
348 /* Compatibility stubs.  Compile extensions with -DPERL_NOCOMPAT to
349    disable them.
350  */
351
352 #if !defined(PERL_CORE)
353 #  define sv_setptrobj(rv,ptr,name)     sv_setref_iv(rv,name,PTR2IV(ptr))
354 #  define sv_setptrref(rv,ptr)          sv_setref_iv(rv,NULL,PTR2IV(ptr))
355 #endif
356
357 #if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)
358
359 /* Compatibility for various misnamed functions.  All functions
360    in the API that begin with "perl_" (not "Perl_") take an explicit
361    interpreter context pointer.
362    The following are not like that, but since they had a "perl_"
363    prefix in previous versions, we provide compatibility macros.
364  */
365 #  define perl_atexit(a,b)              call_atexit(a,b)
366 END
367
368 foreach (@$embed) {
369     my ($flags, $retval, $func, @args) = @$_;
370     next unless $func;
371     next unless $flags =~ /O/;
372
373     my $alist = join ",", @az[0..$#args];
374     my $ret = "#  define perl_$func($alist)";
375     my $t = (length $ret) >> 3;
376     $ret .=  "\t" x ($t < 5 ? 5 - $t : 1);
377     print $em "$ret$func($alist)\n";
378 }
379
380 my @nocontext;
381 {
382     my (%has_va, %has_nocontext);
383     foreach (@$embed) {
384         next unless @$_ > 1;
385         ++$has_va{$_->[2]} if $_->[-1] =~ /\.\.\./;
386         ++$has_nocontext{$1} if $_->[2] =~ /(.*)_nocontext/;
387     }
388
389     @nocontext = sort grep {
390         $has_nocontext{$_}
391             && !/printf/ # Not clear to me why these are skipped but they are.
392     } keys %has_va;
393 }
394
395 print $em <<'END';
396
397 /* varargs functions can't be handled with CPP macros. :-(
398    This provides a set of compatibility functions that don't take
399    an extra argument but grab the context pointer using the macro
400    dTHX.
401  */
402 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
403 END
404
405 foreach (@nocontext) {
406     print $em hide($_, "Perl_${_}_nocontext", "  ");
407 }
408
409 print $em <<'END';
410 #endif
411
412 #endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */
413
414 #if !defined(PERL_IMPLICIT_CONTEXT)
415 /* undefined symbols, point them back at the usual ones */
416 END
417
418 foreach (@nocontext) {
419     print $em hide("Perl_${_}_nocontext", "Perl_$_", "  ");
420 }
421
422 print $em <<'END';
423 #endif
424 END
425
426 read_only_bottom_close_and_rename($em);
427
428 $em = open_print_header('embedvar.h');
429
430 print $em <<'END';
431 /* (Doing namespace management portably in C is really gross.) */
432
433 /*
434    The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
435    are supported:
436      1) none
437      2) MULTIPLICITY    # supported for compatibility
438      3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT
439
440    All other combinations of these flags are errors.
441
442    only #3 is supported directly, while #2 is a special
443    case of #3 (supported by redefining vTHX appropriately).
444 */
445
446 #if defined(MULTIPLICITY)
447 /* cases 2 and 3 above */
448
449 #  if defined(PERL_IMPLICIT_CONTEXT)
450 #    define vTHX        aTHX
451 #  else
452 #    define vTHX        PERL_GET_INTERP
453 #  endif
454
455 END
456
457 my $sym;
458
459 for $sym (@intrp) {
460     if ($sym eq 'sawampersand') {
461         print $em "#ifndef PL_sawampersand\n";
462     }
463     print $em multon($sym,'I','vTHX->');
464     if ($sym eq 'sawampersand') {
465         print $em "#endif\n";
466     }
467 }
468
469 print $em <<'END';
470
471 #endif  /* MULTIPLICITY */
472
473 #if defined(PERL_GLOBAL_STRUCT)
474
475 END
476
477 for $sym (@globvar) {
478     print $em "#ifdef OS2\n" if $sym eq 'sh_path';
479     print $em multon($sym,   'G','my_vars->');
480     print $em multon("G$sym",'', 'my_vars->');
481     print $em "#endif\n" if $sym eq 'sh_path';
482 }
483
484 print $em <<'END';
485
486 #endif /* PERL_GLOBAL_STRUCT */
487 END
488
489 read_only_bottom_close_and_rename($em);
490
491 my $capih = open_print_header('perlapi.h');
492
493 print $capih <<'EOT';
494 /* declare accessor functions for Perl variables */
495 #ifndef __perlapi_h__
496 #define __perlapi_h__
497
498 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
499
500 START_EXTERN_C
501
502 #undef PERLVAR
503 #undef PERLVARA
504 #undef PERLVARI
505 #undef PERLVARIC
506 #define PERLVAR(p,v,t)  EXTERN_C t* Perl_##p##v##_ptr(pTHX);
507 #define PERLVARA(p,v,n,t)       typedef t PL_##v##_t[n];                \
508                         EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
509 #define PERLVARI(p,v,t,i)       PERLVAR(p,v,t)
510 #define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)
511
512 #include "perlvars.h"
513
514 #undef PERLVAR
515 #undef PERLVARA
516 #undef PERLVARI
517 #undef PERLVARIC
518
519 END_EXTERN_C
520
521 #if defined(PERL_CORE)
522
523 /* accessor functions for Perl "global" variables */
524
525 /* these need to be mentioned here, or most linkers won't put them in
526    the perl executable */
527
528 #ifndef PERL_NO_FORCE_LINK
529
530 START_EXTERN_C
531
532 #ifndef DOINIT
533 EXTCONST void * const PL_force_link_funcs[];
534 #else
535 EXTCONST void * const PL_force_link_funcs[] = {
536 #undef PERLVAR
537 #undef PERLVARA
538 #undef PERLVARI
539 #undef PERLVARIC
540 #define PERLVAR(p,v,t)          (void*)Perl_##p##v##_ptr,
541 #define PERLVARA(p,v,n,t)       PERLVAR(p,v,t)
542 #define PERLVARI(p,v,t,i)       PERLVAR(p,v,t)
543 #define PERLVARIC(p,v,t,i)      PERLVAR(p,v,t)
544
545 /* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
546  * cannot cast between void pointers and function pointers without
547  * info level warnings.  The PL_force_link_funcs[] would cause a few
548  * hundred of those warnings.  In code one can circumnavigate this by using
549  * unions that overlay the different pointers, but in declarations one
550  * cannot use this trick.  Therefore we just disable the warning here
551  * for the duration of the PL_force_link_funcs[] declaration. */
552
553 #if defined(__DECC) && defined(__osf__)
554 #pragma message save
555 #pragma message disable (nonstandcast)
556 #endif
557
558 #include "perlvars.h"
559
560 #if defined(__DECC) && defined(__osf__)
561 #pragma message restore
562 #endif
563
564 #undef PERLVAR
565 #undef PERLVARA
566 #undef PERLVARI
567 #undef PERLVARIC
568 };
569 #endif  /* DOINIT */
570
571 END_EXTERN_C
572
573 #endif  /* PERL_NO_FORCE_LINK */
574
575 #else   /* !PERL_CORE */
576
577 EOT
578
579 foreach $sym (@globvar) {
580     print $capih
581         "#undef  PL_$sym\n" . hide("PL_$sym", "(*Perl_G${sym}_ptr(NULL))");
582 }
583
584 print $capih <<'EOT';
585
586 #endif /* !PERL_CORE */
587 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
588
589 #endif /* __perlapi_h__ */
590 EOT
591
592 read_only_bottom_close_and_rename($capih);
593
594 my $capi = open_print_header('perlapi.c', <<'EOQ');
595  *
596  *
597  * Up to the threshold of the door there mounted a flight of twenty-seven
598  * broad stairs, hewn by some unknown art of the same black stone.  This
599  * was the only entrance to the tower; ...
600  *
601  *     [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
602  *
603  */
604 EOQ
605
606 print $capi <<'EOT';
607 #include "EXTERN.h"
608 #include "perl.h"
609 #include "perlapi.h"
610
611 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
612
613 /* accessor functions for Perl "global" variables */
614 START_EXTERN_C
615
616 #undef PERLVARI
617 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
618
619 #undef PERLVAR
620 #undef PERLVARA
621 #define PERLVAR(p,v,t)          t* Perl_##p##v##_ptr(pTHX)              \
622                         { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
623 #define PERLVARA(p,v,n,t)       PL_##v##_t* Perl_##p##v##_ptr(pTHX)     \
624                         { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
625 #undef PERLVARIC
626 #define PERLVARIC(p,v,t,i)      \
627                         const t* Perl_##p##v##_ptr(pTHX)                \
628                         { PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
629 #include "perlvars.h"
630
631 #undef PERLVAR
632 #undef PERLVARA
633 #undef PERLVARI
634 #undef PERLVARIC
635
636 END_EXTERN_C
637
638 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
639 EOT
640
641 read_only_bottom_close_and_rename($capi);
642
643 # ex: set ts=8 sts=4 sw=4 noet: