Re: [PATCH] sv.c: consting
[p5sagit/p5-mst-13.2.git] / opcode.pl
1 #!/usr/bin/perl -w
2 use strict;
3
4 BEGIN {
5     # Get function prototypes
6     require 'regen_lib.pl';
7 }
8
9 my $opcode_new = 'opcode.h-new';
10 my $opname_new = 'opnames.h-new';
11 open(OC, ">$opcode_new") || die "Can't create $opcode_new: $!\n";
12 binmode OC;
13 open(ON, ">$opname_new") || die "Can't create $opname_new: $!\n";
14 binmode ON;
15 select OC;
16
17 # Read data.
18
19 my %seen;
20 my (@ops, %desc, %check, %ckname, %flags, %args);
21
22 while (<DATA>) {
23     chop;
24     next unless $_;
25     next if /^#/;
26     my ($key, $desc, $check, $flags, $args) = split(/\t+/, $_, 5);
27     $args = '' unless defined $args;
28
29     warn qq[Description "$desc" duplicates $seen{$desc}\n] if $seen{$desc};
30     die qq[Opcode "$key" duplicates $seen{$key}\n] if $seen{$key};
31     $seen{$desc} = qq[description of opcode "$key"];
32     $seen{$key} = qq[opcode "$key"];
33
34     push(@ops, $key);
35     $desc{$key} = $desc;
36     $check{$key} = $check;
37     $ckname{$check}++;
38     $flags{$key} = $flags;
39     $args{$key} = $args;
40 }
41
42 # Set up aliases
43
44 my %alias;
45
46 # Format is "this function" => "does these op names"
47 my @raw_alias = (
48                  Perl_do_kv => [qw( keys values )],
49                  Perl_unimplemented_op => [qw(padany mapstart custom)],
50                  # All the ops with a body of { return NORMAL; }
51                  Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
52
53                  Perl_pp_goto => ['dump'],
54                  Perl_pp_require => ['dofile'],
55                  Perl_pp_untie => ['dbmclose'],
56                  Perl_pp_sysread => [qw(read recv)],
57                  Perl_pp_sysseek => ['seek'],
58                  Perl_pp_ioctl => ['fcntl'],
59                  Perl_pp_ssockopt => ['gsockopt'],
60                  Perl_pp_getpeername => ['getsockname'],
61                  Perl_pp_stat => ['lstat'],
62                  Perl_pp_ftrowned => [qw(fteowned ftzero ftsock ftchr ftblk
63                                          ftfile ftdir ftpipe ftsuid ftsgid
64                                          ftsvtx)],
65                  Perl_pp_fttext => ['ftbinary'],
66                  Perl_pp_gmtime => ['localtime'],
67                  Perl_pp_semget => [qw(shmget msgget)],
68                  Perl_pp_semctl => [qw(shmctl msgctl)],
69                  Perl_pp_ghostent => [qw(ghbyname ghbyaddr)],
70                  Perl_pp_gnetent => [qw(gnbyname gnbyaddr)],
71                  Perl_pp_gprotoent => [qw(gpbyname gpbynumber)],
72                  Perl_pp_gservent => [qw(gsbyname gsbyport)],
73                  Perl_pp_gpwent => [qw(gpwnam gpwuid)],
74                  Perl_pp_ggrent => [qw(ggrnam ggrgid)],
75                  Perl_pp_ftis => [qw(ftsize ftmtime ftatime ftctime)],
76                  Perl_pp_chown => [qw(unlink chmod utime kill)],
77                  Perl_pp_link => ['symlink'],
78                  Perl_pp_ftrread => [qw(ftrwrite ftrexec fteread ftewrite
79                                         fteexec)],
80                  Perl_pp_shmwrite => [qw(shmread msgsnd msgrcv semop)],
81                  Perl_pp_send => ['syswrite'],
82                  Perl_pp_defined => [qw(dor dorassign)],
83                  Perl_pp_and => ['andassign'],
84                  Perl_pp_or => ['orassign'],
85                  Perl_pp_ucfirst => ['lcfirst'],
86                  Perl_pp_sle => [qw(slt sgt sge)],
87                  Perl_pp_print => ['say'],
88                  Perl_pp_index => ['rindex'],
89                  Perl_pp_oct => ['hex'],
90                  Perl_pp_shift => ['pop'],
91                  Perl_pp_sin => [qw(cos exp log sqrt)],
92                  Perl_pp_bit_or => ['bit_xor'],
93                  Perl_pp_rv2av => ['rv2hv'],
94                  Perl_pp_akeys => ['avalues'],
95                 );
96
97 while (my ($func, $names) = splice @raw_alias, 0, 2) {
98     $alias{$_} = $func for @$names;
99 }
100
101 # Emit defines.
102
103 print <<"END";
104 /* -*- buffer-read-only: t -*-
105  *
106  *    opcode.h
107  *
108  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
109  *    2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
110  *
111  *    You may distribute under the terms of either the GNU General Public
112  *    License or the Artistic License, as specified in the README file.
113  *
114  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
115  *  This file is built by opcode.pl from its data.  Any changes made here
116  *  will be lost!
117  */
118
119 #ifndef PERL_GLOBAL_STRUCT_INIT
120
121 #define Perl_pp_i_preinc Perl_pp_preinc
122 #define Perl_pp_i_predec Perl_pp_predec
123 #define Perl_pp_i_postinc Perl_pp_postinc
124 #define Perl_pp_i_postdec Perl_pp_postdec
125
126 PERL_PPDEF(Perl_unimplemented_op)
127
128 END
129
130 print ON <<"END";
131 /* -*- buffer-read-only: t -*-
132  *
133  *    opnames.h
134  *
135  *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
136  *    2007 by Larry Wall and others
137  *
138  *    You may distribute under the terms of either the GNU General Public
139  *    License or the Artistic License, as specified in the README file.
140  *
141  *
142  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
143  *  This file is built by opcode.pl from its data.  Any changes made here
144  *  will be lost!
145  */
146
147 typedef enum opcode {
148 END
149
150 my $i = 0;
151 for (@ops) {
152     print ON "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
153 }
154 print ON "\t", &tab(3,"OP_max"), "\n";
155 print ON "} opcode;\n";
156 print ON "\n#define MAXO ", scalar @ops, "\n";
157 print ON "#define OP_phoney_INPUT_ONLY -1\n";
158 print ON "#define OP_phoney_OUTPUT_ONLY -2\n\n";
159
160 # Emit op names and descriptions.
161
162 print <<END;
163 START_EXTERN_C
164
165 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM ? custom_op_name(o) : \\
166                     PL_op_name[(o)->op_type])
167 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM ? custom_op_desc(o) : \\
168                     PL_op_desc[(o)->op_type])
169
170 #ifndef DOINIT
171 EXTCONST char* const PL_op_name[];
172 #else
173 EXTCONST char* const PL_op_name[] = {
174 END
175
176 for (@ops) {
177     print qq(\t"$_",\n);
178 }
179
180 print <<END;
181 };
182 #endif
183
184 END
185
186 print <<END;
187 #ifndef DOINIT
188 EXTCONST char* const PL_op_desc[];
189 #else
190 EXTCONST char* const PL_op_desc[] = {
191 END
192
193 for (@ops) {
194     my($safe_desc) = $desc{$_};
195
196     # Have to escape double quotes and escape characters.
197     $safe_desc =~ s/(^|[^\\])([\\"])/$1\\$2/g;
198
199     print qq(\t"$safe_desc",\n);
200 }
201
202 print <<END;
203 };
204 #endif
205
206 END_EXTERN_C
207
208 #endif /* !PERL_GLOBAL_STRUCT_INIT */
209 END
210
211 # Emit function declarations.
212
213 #for (sort keys %ckname) {
214 #    print "OP *\t", &tab(3,$_),"(pTHX_ OP* o);\n";
215 #}
216 #
217 #print "\n";
218 #
219 #for (@ops) {
220 #    print "OP *\t", &tab(3, "pp_$_"), "(pTHX);\n";
221 #}
222
223 # Emit ppcode switch array.
224
225 print <<END;
226
227 START_EXTERN_C
228
229 #ifdef PERL_GLOBAL_STRUCT_INIT
230 #  define PERL_PPADDR_INITED
231 static const Perl_ppaddr_t Gppaddr[]
232 #else
233 #  ifndef PERL_GLOBAL_STRUCT
234 #    define PERL_PPADDR_INITED
235 EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
236 #  endif
237 #endif /* PERL_GLOBAL_STRUCT */
238 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
239 #  define PERL_PPADDR_INITED
240 = {
241 END
242
243 for (@ops) {
244     if (my $name = $alias{$_}) {
245         print "\tMEMBER_TO_FPTR($name),\t/* Perl_pp_$_ */\n";
246     }
247     else {
248         print "\tMEMBER_TO_FPTR(Perl_pp_$_),\n";
249     }
250 }
251
252 print <<END;
253 }
254 #endif
255 #ifdef PERL_PPADDR_INITED
256 ;
257 #endif
258
259 END
260
261 # Emit check routines.
262
263 print <<END;
264 #ifdef PERL_GLOBAL_STRUCT_INIT
265 #  define PERL_CHECK_INITED
266 static const Perl_check_t Gcheck[]
267 #else
268 #  ifndef PERL_GLOBAL_STRUCT
269 #    define PERL_CHECK_INITED
270 EXT Perl_check_t PL_check[] /* or perlvars.h */
271 #  endif
272 #endif
273 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
274 #  define PERL_CHECK_INITED
275 = {
276 END
277
278 for (@ops) {
279     print "\t", &tab(3, "MEMBER_TO_FPTR(Perl_$check{$_}),"), "\t/* $_ */\n";
280 }
281
282 print <<END;
283 }
284 #endif
285 #ifdef PERL_CHECK_INITED
286 ;
287 #endif /* #ifdef PERL_CHECK_INITED */
288
289 END
290
291 # Emit allowed argument types.
292
293 my $ARGBITS = 32;
294
295 print <<END;
296 #ifndef PERL_GLOBAL_STRUCT_INIT
297
298 #ifndef DOINIT
299 EXTCONST U32 PL_opargs[];
300 #else
301 EXTCONST U32 PL_opargs[] = {
302 END
303
304 my %argnum = (
305     'S',  1,            # scalar
306     'L',  2,            # list
307     'A',  3,            # array value
308     'H',  4,            # hash value
309     'C',  5,            # code value
310     'F',  6,            # file value
311     'R',  7,            # scalar reference
312 );
313
314 my %opclass = (
315     '0',  0,            # baseop
316     '1',  1,            # unop
317     '2',  2,            # binop
318     '|',  3,            # logop
319     '@',  4,            # listop
320     '/',  5,            # pmop
321     '$',  6,            # svop_or_padop
322     '#',  7,            # padop
323     '"',  8,            # pvop_or_svop
324     '{',  9,            # loop
325     ';',  10,           # cop
326     '%',  11,           # baseop_or_unop
327     '-',  12,           # filestatop
328     '}',  13,           # loopexop
329 );
330
331 my %opflags = (
332     'm' =>   1,         # needs stack mark
333     'f' =>   2,         # fold constants
334     's' =>   4,         # always produces scalar
335     't' =>   8,         # needs target scalar
336     'T' =>   8 | 256,   # ... which may be lexical
337     'i' =>  16,         # always produces integer
338     'I' =>  32,         # has corresponding int op
339     'd' =>  64,         # danger, unknown side effects
340     'u' => 128,         # defaults to $_
341 );
342
343 my %OP_IS_SOCKET;
344 my %OP_IS_FILETEST;
345 my $OCSHIFT = 9;
346 my $OASHIFT = 13;
347
348 for my $op (@ops) {
349     my $argsum = 0;
350     my $flags = $flags{$op};
351     for my $flag (keys %opflags) {
352         if ($flags =~ s/$flag//) {
353             die "Flag collision for '$op' ($flags{$op}, $flag)"
354                 if $argsum & $opflags{$flag};
355             $argsum |= $opflags{$flag};
356         }
357     }
358     die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)]
359         unless exists $opclass{$flags};
360     $argsum |= $opclass{$flags} << $OCSHIFT;
361     my $argshift = $OASHIFT;
362     for my $arg (split(' ',$args{$op})) {
363         if ($arg =~ /^F/) {
364            $OP_IS_SOCKET{$op}   = 1 if $arg =~ s/s//;
365            $OP_IS_FILETEST{$op} = 1 if $arg =~ s/-//;
366         }
367         my $argnum = ($arg =~ s/\?//) ? 8 : 0;
368         die "op = $op, arg = $arg\n"
369             unless exists $argnum{$arg};
370         $argnum += $argnum{$arg};
371         die "Argument overflow for '$op'\n"
372             if $argshift >= $ARGBITS ||
373                $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
374         $argsum += $argnum << $argshift;
375         $argshift += 4;
376     }
377     $argsum = sprintf("0x%08x", $argsum);
378     print "\t", &tab(3, "$argsum,"), "/* $op */\n";
379 }
380
381 print <<END;
382 };
383 #endif
384
385 #endif /* !PERL_GLOBAL_STRUCT_INIT */
386
387 END_EXTERN_C
388
389 END
390
391 if (keys %OP_IS_SOCKET) {
392     print ON "\n#define OP_IS_SOCKET(op)        \\\n\t(";
393     print ON join(" || \\\n\t ",
394                map { "(op) == OP_" . uc() } sort keys %OP_IS_SOCKET);
395     print ON ")\n\n";
396 }
397
398 if (keys %OP_IS_FILETEST) {
399     print ON "\n#define OP_IS_FILETEST(op)      \\\n\t(";
400     print ON join(" || \\\n\t ",
401                map { "(op) == OP_" . uc() } sort keys %OP_IS_FILETEST);
402     print ON ")\n\n";
403 }
404
405 print OC "/* ex: set ro: */\n";
406 print ON "/* ex: set ro: */\n";
407
408 close OC or die "Error closing opcode.h: $!";
409 close ON or die "Error closing opnames.h: $!";
410
411 foreach ('opcode.h', 'opnames.h') {
412     safer_rename_silent $_, "$_-old";
413 }
414 safer_rename $opcode_new, 'opcode.h';
415 safer_rename $opname_new, 'opnames.h';
416
417 my $pp_proto_new = 'pp_proto.h-new';
418 my $pp_sym_new  = 'pp.sym-new';
419
420 open PP, ">$pp_proto_new" or die "Error creating $pp_proto_new: $!";
421 binmode PP;
422 open PPSYM, ">$pp_sym_new" or die "Error creating $pp_sym_new: $!";
423 binmode PPSYM;
424
425 print PP <<"END";
426 /* -*- buffer-read-only: t -*-
427    !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
428    This file is built by opcode.pl from its data.  Any changes made here
429    will be lost!
430 */
431
432 END
433
434 print PPSYM <<"END";
435 # -*- buffer-read-only: t -*-
436 #
437 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
438 #   This file is built by opcode.pl from its data.  Any changes made here
439 #   will be lost!
440 #
441
442 END
443
444
445 for (sort keys %ckname) {
446     print PP "PERL_CKDEF(Perl_$_)\n";
447     print PPSYM "Perl_$_\n";
448 #OP *\t", &tab(3,$_),"(OP* o);\n";
449 }
450
451 print PP "\n\n";
452
453 for (@ops) {
454     next if /^i_(pre|post)(inc|dec)$/;
455     next if /^custom$/;
456     print PP "PERL_PPDEF(Perl_pp_$_)\n";
457     print PPSYM "Perl_pp_$_\n";
458 }
459 print PP "\n/* ex: set ro: */\n";
460 print PPSYM "\n# ex: set ro:\n";
461
462 close PP or die "Error closing pp_proto.h: $!";
463 close PPSYM or die "Error closing pp.sym: $!";
464
465 foreach ('pp_proto.h', 'pp.sym') {
466     safer_rename_silent $_, "$_-old";
467 }
468 safer_rename $pp_proto_new, 'pp_proto.h';
469 safer_rename $pp_sym_new, 'pp.sym';
470
471 END {
472   foreach ('opcode.h', 'opnames.h', 'pp_proto.h', 'pp.sym') {
473     1 while unlink "$_-old";
474   }
475 }
476
477 ###########################################################################
478 sub tab {
479     my ($l, $t) = @_;
480     $t .= "\t" x ($l - (length($t) + 1) / 8);
481     $t;
482 }
483 ###########################################################################
484
485 # Some comments about 'T' opcode classifier:
486
487 # Safe to set if the ppcode uses:
488 #       tryAMAGICbin, tryAMAGICun, SETn, SETi, SETu, PUSHn, PUSHTARG, SETTARG,
489 #       SETs(TARG), XPUSHn, XPUSHu,
490
491 # Unsafe to set if the ppcode uses dTARG or [X]RETPUSH[YES|NO|UNDEF]
492
493 # lt and friends do SETs (including ncmp, but not scmp)
494
495 # Additional mode of failure: the opcode can modify TARG before it "used"
496 # all the arguments (or may call an external function which does the same).
497 # If the target coincides with one of the arguments ==> kaboom.
498
499 # pp.c  pos substr each not OK (RETPUSHUNDEF)
500 #       substr vec also not OK due to LV to target (are they???)
501 #       ref not OK (RETPUSHNO)
502 #       trans not OK (dTARG; TARG = sv_newmortal();)
503 #       ucfirst etc not OK: TMP arg processed inplace
504 #       quotemeta not OK (unsafe when TARG == arg)
505 #       each repeat not OK too due to list context
506 #       pack split - unknown whether they are safe
507 #       sprintf: is calling do_sprintf(TARG,...) which can act on TARG
508 #         before other args are processed.
509
510 #       Suspicious wrt "additional mode of failure" (and only it):
511 #       schop, chop, postinc/dec, bit_and etc, negate, complement.
512
513 #       Also suspicious: 4-arg substr, sprintf, uc/lc (POK_only), reverse, pack.
514
515 #       substr/vec: doing TAINT_off()???
516
517 # pp_hot.c
518 #       readline - unknown whether it is safe
519 #       match subst not OK (dTARG)
520 #       grepwhile not OK (not always setting)
521 #       join not OK (unsafe when TARG == arg)
522
523 #       Suspicious wrt "additional mode of failure": concat (dealt with
524 #       in ck_sassign()), join (same).
525
526 # pp_ctl.c
527 #       mapwhile flip caller not OK (not always setting)
528
529 # pp_sys.c
530 #       backtick glob warn die not OK (not always setting)
531 #       warn not OK (RETPUSHYES)
532 #       open fileno getc sysread syswrite ioctl accept shutdown
533 #        ftsize(etc) readlink telldir fork alarm getlogin not OK (RETPUSHUNDEF)
534 #       umask select not OK (XPUSHs(&PL_sv_undef);)
535 #       fileno getc sysread syswrite tell not OK (meth("FILENO" "GETC"))
536 #       sselect shm* sem* msg* syscall - unknown whether they are safe
537 #       gmtime not OK (list context)
538
539 #       Suspicious wrt "additional mode of failure": warn, die, select.
540
541 __END__
542
543 # New ops always go at the end
544 # The restriction on having custom as the last op has been removed
545
546 # A recapitulation of the format of this file:
547 # The file consists of five columns: the name of the op, an English
548 # description, the name of the "check" routine used to optimize this
549 # operation, some flags, and a description of the operands.
550
551 # The flags consist of options followed by a mandatory op class signifier
552
553 # The classes are:
554 # baseop      - 0            unop     - 1            binop      - 2
555 # logop       - |            listop   - @            pmop       - /
556 # padop/svop  - $            padop    - # (unused)   loop       - {
557 # baseop/unop - %            loopexop - }            filestatop - -
558 # pvop/svop   - "            cop      - ;
559
560 # Other options are:
561 #   needs stack mark                    - m
562 #   needs constant folding              - f
563 #   produces a scalar                   - s
564 #   produces an integer                 - i
565 #   needs a target                      - t
566 #   target can be in a pad              - T
567 #   has a corresponding integer version - I
568 #   has side effects                    - d
569 #   uses $_ if no argument given        - u
570
571 # Values for the operands are:
572 # scalar      - S            list     - L            array     - A
573 # hash        - H            sub (CV) - C            file      - F
574 # socket      - Fs           filetest - F-           reference - R
575 # "?" denotes an optional operand.
576
577 # Nothing.
578
579 null            null operation          ck_null         0       
580 stub            stub                    ck_null         0
581 scalar          scalar                  ck_fun          s%      S
582
583 # Pushy stuff.
584
585 pushmark        pushmark                ck_null         s0      
586 wantarray       wantarray               ck_null         is0     
587
588 const           constant item           ck_svconst      s$      
589
590 gvsv            scalar variable         ck_null         ds$     
591 gv              glob value              ck_null         ds$     
592 gelem           glob elem               ck_null         d2      S S
593 padsv           private variable        ck_null         ds0
594 padav           private array           ck_null         d0
595 padhv           private hash            ck_null         d0
596 padany          private value           ck_null         d0
597
598 pushre          push regexp             ck_null         d/
599
600 # References and stuff.
601
602 rv2gv           ref-to-glob cast        ck_rvconst      ds1     
603 rv2sv           scalar dereference      ck_rvconst      ds1     
604 av2arylen       array length            ck_null         is1     
605 rv2cv           subroutine dereference  ck_rvconst      d1
606 anoncode        anonymous subroutine    ck_anoncode     $       
607 prototype       subroutine prototype    ck_null         s%      S
608 refgen          reference constructor   ck_spair        m1      L
609 srefgen         single ref constructor  ck_null         fs1     S
610 ref             reference-type operator ck_fun          stu%    S?
611 bless           bless                   ck_fun          s@      S S?
612
613 # Pushy I/O.
614
615 backtick        quoted execution (``, qx)       ck_open         tu%     S?
616 # glob defaults its first arg to $_
617 glob            glob                    ck_glob         t@      S?
618 readline        <HANDLE>                ck_readline     t%      F?
619 rcatline        append I/O operator     ck_null         t$
620
621 # Bindable operators.
622
623 regcmaybe       regexp internal guard   ck_fun          s1      S
624 regcreset       regexp internal reset   ck_fun          s1      S
625 regcomp         regexp compilation      ck_null         s|      S
626 match           pattern match (m//)     ck_match        d/
627 qr              pattern quote (qr//)    ck_match        s/
628 subst           substitution (s///)     ck_match        dis/    S
629 substcont       substitution iterator   ck_null         dis|    
630 trans           transliteration (tr///) ck_match        is"     S
631
632 # Lvalue operators.
633 # sassign is special-cased for op class
634
635 sassign         scalar assignment       ck_sassign      s0
636 aassign         list assignment         ck_null         t2      L L
637
638 chop            chop                    ck_spair        mts%    L
639 schop           scalar chop             ck_null         stu%    S?
640 chomp           chomp                   ck_spair        mTs%    L
641 schomp          scalar chomp            ck_null         sTu%    S?
642 defined         defined operator        ck_defined      isu%    S?
643 undef           undef operator          ck_lfun         s%      S?
644 study           study                   ck_fun          su%     S?
645 pos             match position          ck_lfun         stu%    S?
646
647 preinc          preincrement (++)               ck_lfun         dIs1    S
648 i_preinc        integer preincrement (++)       ck_lfun         dis1    S
649 predec          predecrement (--)               ck_lfun         dIs1    S
650 i_predec        integer predecrement (--)       ck_lfun         dis1    S
651 postinc         postincrement (++)              ck_lfun         dIst1   S
652 i_postinc       integer postincrement (++)      ck_lfun         disT1   S
653 postdec         postdecrement (--)              ck_lfun         dIst1   S
654 i_postdec       integer postdecrement (--)      ck_lfun         disT1   S
655
656 # Ordinary operators.
657
658 pow             exponentiation (**)     ck_null         fsT2    S S
659
660 multiply        multiplication (*)      ck_null         IfsT2   S S
661 i_multiply      integer multiplication (*)      ck_null         ifsT2   S S
662 divide          division (/)            ck_null         IfsT2   S S
663 i_divide        integer division (/)    ck_null         ifsT2   S S
664 modulo          modulus (%)             ck_null         IifsT2  S S
665 i_modulo        integer modulus (%)     ck_null         ifsT2   S S
666 repeat          repeat (x)              ck_repeat       mt2     L S
667
668 add             addition (+)            ck_null         IfsT2   S S
669 i_add           integer addition (+)    ck_null         ifsT2   S S
670 subtract        subtraction (-)         ck_null         IfsT2   S S
671 i_subtract      integer subtraction (-) ck_null         ifsT2   S S
672 concat          concatenation (.) or string     ck_concat       fsT2    S S
673 stringify       string                  ck_fun          fsT@    S
674
675 left_shift      left bitshift (<<)      ck_bitop        fsT2    S S
676 right_shift     right bitshift (>>)     ck_bitop        fsT2    S S
677
678 lt              numeric lt (<)          ck_null         Iifs2   S S
679 i_lt            integer lt (<)          ck_null         ifs2    S S
680 gt              numeric gt (>)          ck_null         Iifs2   S S
681 i_gt            integer gt (>)          ck_null         ifs2    S S
682 le              numeric le (<=)         ck_null         Iifs2   S S
683 i_le            integer le (<=)         ck_null         ifs2    S S
684 ge              numeric ge (>=)         ck_null         Iifs2   S S
685 i_ge            integer ge (>=)         ck_null         ifs2    S S
686 eq              numeric eq (==)         ck_null         Iifs2   S S
687 i_eq            integer eq (==)         ck_null         ifs2    S S
688 ne              numeric ne (!=)         ck_null         Iifs2   S S
689 i_ne            integer ne (!=)         ck_null         ifs2    S S
690 ncmp            numeric comparison (<=>)        ck_null         Iifst2  S S
691 i_ncmp          integer comparison (<=>)        ck_null         ifst2   S S
692
693 slt             string lt               ck_null         ifs2    S S
694 sgt             string gt               ck_null         ifs2    S S
695 sle             string le               ck_null         ifs2    S S
696 sge             string ge               ck_null         ifs2    S S
697 seq             string eq               ck_null         ifs2    S S
698 sne             string ne               ck_null         ifs2    S S
699 scmp            string comparison (cmp) ck_null         ifst2   S S
700
701 bit_and         bitwise and (&)         ck_bitop        fst2    S S
702 bit_xor         bitwise xor (^)         ck_bitop        fst2    S S
703 bit_or          bitwise or (|)          ck_bitop        fst2    S S
704
705 negate          negation (-)            ck_null         Ifst1   S
706 i_negate        integer negation (-)    ck_null         ifsT1   S
707 not             not                     ck_null         ifs1    S
708 complement      1's complement (~)      ck_bitop        fst1    S
709
710 smartmatch      smart match             ck_smartmatch   s2
711
712 # High falutin' math.
713
714 atan2           atan2                   ck_fun          fsT@    S S
715 sin             sin                     ck_fun          fsTu%   S?
716 cos             cos                     ck_fun          fsTu%   S?
717 rand            rand                    ck_fun          sT%     S?
718 srand           srand                   ck_fun          s%      S?
719 exp             exp                     ck_fun          fsTu%   S?
720 log             log                     ck_fun          fsTu%   S?
721 sqrt            sqrt                    ck_fun          fsTu%   S?
722
723 # Lowbrow math.
724
725 int             int                     ck_fun          fsTu%   S?
726 hex             hex                     ck_fun          fsTu%   S?
727 oct             oct                     ck_fun          fsTu%   S?
728 abs             abs                     ck_fun          fsTu%   S?
729
730 # String stuff.
731
732 length          length                  ck_lengthconst  isTu%   S?
733 substr          substr                  ck_substr       st@     S S S? S?
734 vec             vec                     ck_fun          ist@    S S S
735
736 index           index                   ck_index        isT@    S S S?
737 rindex          rindex                  ck_index        isT@    S S S?
738
739 sprintf         sprintf                 ck_fun          mst@    S L
740 formline        formline                ck_fun          ms@     S L
741 ord             ord                     ck_fun          ifsTu%  S?
742 chr             chr                     ck_fun          fsTu%   S?
743 crypt           crypt                   ck_fun          fsT@    S S
744 ucfirst         ucfirst                 ck_fun          fstu%   S?
745 lcfirst         lcfirst                 ck_fun          fstu%   S?
746 uc              uc                      ck_fun          fstu%   S?
747 lc              lc                      ck_fun          fstu%   S?
748 quotemeta       quotemeta               ck_fun          fstu%   S?
749
750 # Arrays.
751
752 rv2av           array dereference       ck_rvconst      dt1     
753 aelemfast       constant array element  ck_null         s$      A S
754 aelem           array element           ck_null         s2      A S
755 aslice          array slice             ck_null         m@      A L
756
757 aeach           each on array           ck_each         %       A
758 akeys           keys on array           ck_each         t%      A
759 avalues         values on array         ck_each         t%      A
760
761 # Hashes.
762
763 each            each                    ck_each         %       H
764 values          values                  ck_each         t%      H
765 keys            keys                    ck_each         t%      H
766 delete          delete                  ck_delete       %       S
767 exists          exists                  ck_exists       is%     S
768 rv2hv           hash dereference        ck_rvconst      dt1     
769 helem           hash element            ck_null         s2      H S
770 hslice          hash slice              ck_null         m@      H L
771
772 # Explosives and implosives.
773
774 unpack          unpack                  ck_unpack       @       S S?
775 pack            pack                    ck_fun          mst@    S L
776 split           split                   ck_split        t@      S S S
777 join            join or string          ck_join         mst@    S L
778
779 # List operators.
780
781 list            list                    ck_null         m@      L
782 lslice          list slice              ck_null         2       H L L
783 anonlist        anonymous list ([])     ck_fun          ms@     L
784 anonhash        anonymous hash ({})     ck_fun          ms@     L
785
786 splice          splice                  ck_fun          m@      A S? S? L
787 push            push                    ck_fun          imsT@   A L
788 pop             pop                     ck_shift        s%      A?
789 shift           shift                   ck_shift        s%      A?
790 unshift         unshift                 ck_fun          imsT@   A L
791 sort            sort                    ck_sort         dm@     C? L
792 reverse         reverse                 ck_fun          mt@     L
793
794 grepstart       grep                    ck_grep         dm@     C L
795 grepwhile       grep iterator           ck_null         dt|     
796
797 mapstart        map                     ck_grep         dm@     C L
798 mapwhile        map iterator            ck_null         dt|
799
800 # Range stuff.
801
802 range           flipflop                ck_null         |       S S
803 flip            range (or flip)         ck_null         1       S S
804 flop            range (or flop)         ck_null         1
805
806 # Control.
807
808 and             logical and (&&)                ck_null         |       
809 or              logical or (||)                 ck_null         |       
810 xor             logical xor                     ck_null         fs2     S S     
811 dor             defined or (//)                 ck_null         |
812 cond_expr       conditional expression          ck_null         d|      
813 andassign       logical and assignment (&&=)    ck_null         s|      
814 orassign        logical or assignment (||=)     ck_null         s|      
815 dorassign       defined or assignment (//=)     ck_null         s|
816
817 method          method lookup           ck_method       d1
818 entersub        subroutine entry        ck_subr         dmt1    L
819 leavesub        subroutine exit         ck_null         1       
820 leavesublv      lvalue subroutine return        ck_null         1       
821 caller          caller                  ck_fun          t%      S?
822 warn            warn                    ck_fun          imst@   L
823 die             die                     ck_die          dimst@  L
824 reset           symbol reset            ck_fun          is%     S?
825
826 lineseq         line sequence           ck_null         @       
827 nextstate       next statement          ck_null         s;      
828 dbstate         debug next statement    ck_null         s;      
829 unstack         iteration finalizer     ck_null         s0
830 enter           block entry             ck_null         0       
831 leave           block exit              ck_null         @       
832 scope           block                   ck_null         @       
833 enteriter       foreach loop entry      ck_null         d{      
834 iter            foreach loop iterator   ck_null         0       
835 enterloop       loop entry              ck_null         d{      
836 leaveloop       loop exit               ck_null         2       
837 return          return                  ck_return       dm@     L
838 last            last                    ck_null         ds}     
839 next            next                    ck_null         ds}     
840 redo            redo                    ck_null         ds}     
841 dump            dump                    ck_null         ds}     
842 goto            goto                    ck_null         ds}     
843 exit            exit                    ck_exit         ds%     S?
844 method_named    method with known name  ck_null         d$
845
846 entergiven      given()                 ck_null         d|
847 leavegiven      leave given block       ck_null         1
848 enterwhen       when()                  ck_null         d|
849 leavewhen       leave when block        ck_null         1
850 break           break                   ck_null         0
851 continue        continue                ck_null         0
852
853 # I/O.
854
855 open            open                    ck_open         ismt@   F S? L
856 close           close                   ck_fun          is%     F?
857 pipe_op         pipe                    ck_fun          is@     F F
858
859 fileno          fileno                  ck_fun          ist%    F
860 umask           umask                   ck_fun          ist%    S?
861 binmode         binmode                 ck_fun          s@      F S?
862
863 tie             tie                     ck_fun          idms@   R S L
864 untie           untie                   ck_fun          is%     R
865 tied            tied                    ck_fun          s%      R
866 dbmopen         dbmopen                 ck_fun          is@     H S S
867 dbmclose        dbmclose                ck_fun          is%     H
868
869 sselect         select system call      ck_select       t@      S S S S
870 select          select                  ck_select       st@     F?
871
872 getc            getc                    ck_eof          st%     F?
873 read            read                    ck_fun          imst@   F R S S?
874 enterwrite      write                   ck_fun          dis%    F?
875 leavewrite      write exit              ck_null         1       
876
877 prtf            printf                  ck_listiob      ims@    F? L
878 print           print                   ck_listiob      ims@    F? L
879 say             say                     ck_listiob      ims@    F? L
880
881 sysopen         sysopen                 ck_fun          s@      F S S S?
882 sysseek         sysseek                 ck_fun          s@      F S S
883 sysread         sysread                 ck_fun          imst@   F R S S?
884 syswrite        syswrite                ck_fun          imst@   F S S? S?
885
886 send            send                    ck_fun          imst@   Fs S S S?
887 recv            recv                    ck_fun          imst@   Fs R S S
888
889 eof             eof                     ck_eof          is%     F?
890 tell            tell                    ck_fun          st%     F?
891 seek            seek                    ck_fun          s@      F S S
892 # truncate really behaves as if it had both "S S" and "F S"
893 truncate        truncate                ck_trunc        is@     S S
894
895 fcntl           fcntl                   ck_fun          st@     F S S
896 ioctl           ioctl                   ck_fun          st@     F S S
897 flock           flock                   ck_fun          isT@    F S
898
899 # Sockets.
900
901 socket          socket                  ck_fun          is@     Fs S S S
902 sockpair        socketpair              ck_fun          is@     Fs Fs S S S
903
904 bind            bind                    ck_fun          is@     Fs S
905 connect         connect                 ck_fun          is@     Fs S
906 listen          listen                  ck_fun          is@     Fs S
907 accept          accept                  ck_fun          ist@    Fs Fs
908 shutdown        shutdown                ck_fun          ist@    Fs S
909
910 gsockopt        getsockopt              ck_fun          is@     Fs S S
911 ssockopt        setsockopt              ck_fun          is@     Fs S S S
912
913 getsockname     getsockname             ck_fun          is%     Fs
914 getpeername     getpeername             ck_fun          is%     Fs
915
916 # Stat calls.
917
918 lstat           lstat                   ck_ftst         u-      F
919 stat            stat                    ck_ftst         u-      F
920 ftrread         -R                      ck_ftst         isu-    F-
921 ftrwrite        -W                      ck_ftst         isu-    F-
922 ftrexec         -X                      ck_ftst         isu-    F-
923 fteread         -r                      ck_ftst         isu-    F-
924 ftewrite        -w                      ck_ftst         isu-    F-
925 fteexec         -x                      ck_ftst         isu-    F-
926 ftis            -e                      ck_ftst         isu-    F-
927 ftsize          -s                      ck_ftst         istu-   F-
928 ftmtime         -M                      ck_ftst         stu-    F-
929 ftatime         -A                      ck_ftst         stu-    F-
930 ftctime         -C                      ck_ftst         stu-    F-
931 ftrowned        -O                      ck_ftst         isu-    F-
932 fteowned        -o                      ck_ftst         isu-    F-
933 ftzero          -z                      ck_ftst         isu-    F-
934 ftsock          -S                      ck_ftst         isu-    F-
935 ftchr           -c                      ck_ftst         isu-    F-
936 ftblk           -b                      ck_ftst         isu-    F-
937 ftfile          -f                      ck_ftst         isu-    F-
938 ftdir           -d                      ck_ftst         isu-    F-
939 ftpipe          -p                      ck_ftst         isu-    F-
940 ftsuid          -u                      ck_ftst         isu-    F-
941 ftsgid          -g                      ck_ftst         isu-    F-
942 ftsvtx          -k                      ck_ftst         isu-    F-
943 ftlink          -l                      ck_ftst         isu-    F-
944 fttty           -t                      ck_ftst         is-     F-
945 fttext          -T                      ck_ftst         isu-    F-
946 ftbinary        -B                      ck_ftst         isu-    F-
947
948 # File calls.
949
950 # chdir really behaves as if it had both "S?" and "F?"
951 chdir           chdir                   ck_chdir        isT%    S?
952 chown           chown                   ck_fun          imsT@   L
953 chroot          chroot                  ck_fun          isTu%   S?
954 unlink          unlink                  ck_fun          imsTu@  L
955 chmod           chmod                   ck_fun          imsT@   L
956 utime           utime                   ck_fun          imsT@   L
957 rename          rename                  ck_fun          isT@    S S
958 link            link                    ck_fun          isT@    S S
959 symlink         symlink                 ck_fun          isT@    S S
960 readlink        readlink                ck_fun          stu%    S?
961 mkdir           mkdir                   ck_fun          isTu@   S? S?
962 rmdir           rmdir                   ck_fun          isTu%   S?
963
964 # Directory calls.
965
966 open_dir        opendir                 ck_fun          is@     F S
967 readdir         readdir                 ck_fun          %       F
968 telldir         telldir                 ck_fun          st%     F
969 seekdir         seekdir                 ck_fun          s@      F S
970 rewinddir       rewinddir               ck_fun          s%      F
971 closedir        closedir                ck_fun          is%     F
972
973 # Process control.
974
975 fork            fork                    ck_null         ist0    
976 wait            wait                    ck_null         isT0    
977 waitpid         waitpid                 ck_fun          isT@    S S
978 system          system                  ck_exec         imsT@   S? L
979 exec            exec                    ck_exec         dimsT@  S? L
980 kill            kill                    ck_fun          dimsT@  L
981 getppid         getppid                 ck_null         isT0    
982 getpgrp         getpgrp                 ck_fun          isT%    S?
983 setpgrp         setpgrp                 ck_fun          isT@    S? S?
984 getpriority     getpriority             ck_fun          isT@    S S
985 setpriority     setpriority             ck_fun          isT@    S S S
986
987 # Time calls.
988
989 # NOTE: MacOS patches the 'i' of time() away later when the interpreter
990 # is created because in MacOS time() is already returning times > 2**31-1,
991 # that is, non-integers.
992
993 time            time                    ck_null         isT0    
994 tms             times                   ck_null         0       
995 localtime       localtime               ck_fun          t%      S?
996 gmtime          gmtime                  ck_fun          t%      S?
997 alarm           alarm                   ck_fun          istu%   S?
998 sleep           sleep                   ck_fun          isT%    S?
999
1000 # Shared memory.
1001
1002 shmget          shmget                  ck_fun          imst@   S S S
1003 shmctl          shmctl                  ck_fun          imst@   S S S
1004 shmread         shmread                 ck_fun          imst@   S S S S
1005 shmwrite        shmwrite                ck_fun          imst@   S S S S
1006
1007 # Message passing.
1008
1009 msgget          msgget                  ck_fun          imst@   S S
1010 msgctl          msgctl                  ck_fun          imst@   S S S
1011 msgsnd          msgsnd                  ck_fun          imst@   S S S
1012 msgrcv          msgrcv                  ck_fun          imst@   S S S S S
1013
1014 # Semaphores.
1015
1016 semop           semop                   ck_fun          imst@   S S
1017 semget          semget                  ck_fun          imst@   S S S
1018 semctl          semctl                  ck_fun          imst@   S S S S
1019
1020 # Eval.
1021
1022 require         require                 ck_require      du%     S?
1023 dofile          do "file"               ck_fun          d1      S
1024 entereval       eval "string"           ck_eval         d%      S
1025 leaveeval       eval "string" exit      ck_null         1       S
1026 #evalonce       eval constant string    ck_null         d1      S
1027 entertry        eval {block}            ck_null         |       
1028 leavetry        eval {block} exit       ck_null         @       
1029
1030 # Get system info.
1031
1032 ghbyname        gethostbyname           ck_fun          %       S
1033 ghbyaddr        gethostbyaddr           ck_fun          @       S S
1034 ghostent        gethostent              ck_null         0       
1035 gnbyname        getnetbyname            ck_fun          %       S
1036 gnbyaddr        getnetbyaddr            ck_fun          @       S S
1037 gnetent         getnetent               ck_null         0       
1038 gpbyname        getprotobyname          ck_fun          %       S
1039 gpbynumber      getprotobynumber        ck_fun          @       S
1040 gprotoent       getprotoent             ck_null         0       
1041 gsbyname        getservbyname           ck_fun          @       S S
1042 gsbyport        getservbyport           ck_fun          @       S S
1043 gservent        getservent              ck_null         0       
1044 shostent        sethostent              ck_fun          is%     S
1045 snetent         setnetent               ck_fun          is%     S
1046 sprotoent       setprotoent             ck_fun          is%     S
1047 sservent        setservent              ck_fun          is%     S
1048 ehostent        endhostent              ck_null         is0     
1049 enetent         endnetent               ck_null         is0     
1050 eprotoent       endprotoent             ck_null         is0     
1051 eservent        endservent              ck_null         is0     
1052 gpwnam          getpwnam                ck_fun          %       S
1053 gpwuid          getpwuid                ck_fun          %       S
1054 gpwent          getpwent                ck_null         0       
1055 spwent          setpwent                ck_null         is0     
1056 epwent          endpwent                ck_null         is0     
1057 ggrnam          getgrnam                ck_fun          %       S
1058 ggrgid          getgrgid                ck_fun          %       S
1059 ggrent          getgrent                ck_null         0       
1060 sgrent          setgrent                ck_null         is0     
1061 egrent          endgrent                ck_null         is0     
1062 getlogin        getlogin                ck_null         st0     
1063
1064 # Miscellaneous.
1065
1066 syscall         syscall                 ck_fun          imst@   S L
1067
1068 # For multi-threading
1069 lock            lock                    ck_rfun         s%      R
1070
1071 # For state support
1072
1073 once            once                    ck_null         |       
1074
1075 custom          unknown custom operator         ck_null         0