opcode.pl

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