nasm/asm/pptok.pl
H. Peter Anvin 3fe5b3f5a1 preproc: distinguish between directives and functions
Some preprocessor functions have the same name as directives. In those
cases, they should be expanded as functions if and only if they are
followed by a left parenthesis. Although it is not inherently true that
either preprocessor functions require a paren nor that directives
cannot start with one, but it is true and will remain true for all
cases where there is a namespace collision.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2022-11-11 19:51:22 -08:00

354 lines
10 KiB
Perl
Executable File

#!/usr/bin/perl
## --------------------------------------------------------------------------
##
## Copyright 1996-2022 The NASM Authors - All Rights Reserved
## See the file AUTHORS included with the NASM distribution for
## the specific copyright holders.
##
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following
## conditions are met:
##
## * Redistributions of source code must retain the above copyright
## notice, this list of conditions and the following disclaimer.
## * Redistributions in binary form must reproduce the above
## copyright notice, this list of conditions and the following
## disclaimer in the documentation and/or other materials provided
## with the distribution.
##
## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
## CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
## INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
## DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
## NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
## LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
## HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
## CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
## OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
## EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
##
## --------------------------------------------------------------------------
#
# Produce pptok.c, pptok.h and pptok.ph from pptok.dat
#
require 'phash.ph';
my($what, $in, $out) = @ARGV;
#
# Read pptok.dat
#
open(IN, '<', $in) or die "$0: cannot open: $in\n";
while (defined($line = <IN>)) {
$line =~ s/\r?\n$//; # Remove trailing \r\n or \n
$line =~ s/^\s+//; # Remove leading whitespace
$line =~ s/\s*\#.*$//; # Remove comments and trailing whitespace
next if ($line eq '');
if ($line =~ /^\%(.*)\*$/) {
# Condition stem
push(@cctok, $1);
} elsif ($line =~ /^\%(.*\!.*)$/) {
# Directive with case insensitity "i" option
# Mnemonic: ! is "upside down i"
push(@ppitok, $1);
} elsif ($line =~ /^\%(.*)$/) {
# Other directive
push(@pptok, $1);
} elsif ($line =~ /^\*(.*)$/) {
# Condition tail
push(@cond, $1);
} elsif ($line =~ /^\@(.*)$/) {
# TASM compatibility directive
push(@tasm, $1);
}
}
close(IN);
# Always sort %if first
@cctok = sort { $a eq 'if' ? -1 : $b eq 'if' ? 1 : $a cmp $b } @cctok;
@cond = sort @cond;
@pptok = sort @pptok;
@ppitok = sort @ppitok;
@tasm = sort @tasm;
# Generate the expanded list including conditionals. The conditionals
# are at the beginning, padded to a power of 2, with the inverses
# following each group; this allows a simple mask to pick out the condition,
# polarity, and directive type.
while ((scalar @cond) & (scalar @cond)-1) {
push(@cond, sprintf("_COND_%d", scalar @cond));
}
@cptok = ();
foreach $ct (@cctok) {
foreach $cc (@cond) {
push(@cptok, $ct.$cc);
}
foreach $cc (@cond) {
push(@cptok, $ct.'n'.$cc);
}
}
$first_uncond = scalar @cptok;
@pptok = (@cptok, @pptok);
# Generate the list of case-specific tokens; these are in pairs
# with the -i- variant following the plain variant
if (scalar(@pptok) & 1) {
push(@pptok, 'CASE_PAD');
}
$first_itoken = scalar @pptok;
foreach $it (@ppitok) {
(my $at = $it) =~ s/\!//;
(my $bt = $it) =~ s/\!/i/;
push(@pptok, $at, $bt);
}
open(OUT, '>', $out) or die "$0: cannot open: $out\n";
#
# Output pptok.h
#
if ($what eq 'h') {
print OUT "/* Automatically generated from $in by $0 */\n";
print OUT "/* Do not edit */\n";
print OUT "\n";
print OUT "enum preproc_token {\n";
$n = 0;
my $maxlen = 0;
foreach $pt (@pptok) {
if (defined($pt)) {
printf OUT " %-24s = %3d,\n", "PP_\U$pt\E", $n;
$maxlen = length($pt) if (length($pt) > $maxlen);
}
$n++;
}
printf OUT " %-24s = %3d,\n", 'PP_count', $n;
printf OUT " %-24s = %3d\n", 'PP_invalid', -1;
print OUT "};\n";
print OUT "\n";
printf OUT "#define PP_COND(x) ((x) & 0x%x)\n",
(scalar(@cond)-1);
printf OUT "#define PP_IS_COND(x) ((unsigned int)(x) < PP_%s)\n",
uc($pptok[$first_uncond]);
printf OUT "#define PP_COND_NEGATIVE(x) (!!((x) & 0x%x))\n", scalar(@cond);
print OUT "\n";
printf OUT "#define PP_HAS_CASE(x) ((x) >= PP_%s)\n",
uc($pptok[$first_itoken]);
print OUT "#define PP_INSENSITIVE(x) ((x) & 1)\n";
# The +1 here is for the initial % sign
printf OUT "#define PP_TOKLEN_MAX %d\n", $maxlen+1;
print OUT "\n";
foreach $ct (@cctok) {
print OUT "#define CASE_PP_\U$ct\E";
$pref = " \\\n";
foreach $cc (@cond) {
print OUT "$pref\tcase PP_\U${ct}${cc}\E";
$pref = ":\\\n";
}
foreach $cc (@cond) {
print OUT "$pref\tcase PP_\U${ct}N${cc}\E";
$pref = ":\\\n";
}
print OUT "\n"; # No colon or newline on the last one
}
}
#
# Output pptok.c
#
if ($what eq 'c') {
print OUT "/* Automatically generated from $in by $0 */\n";
print OUT "/* Do not edit */\n";
print OUT "\n";
print OUT "#include \"compiler.h\"\n";
print OUT "#include \"nctype.h\"\n";
print OUT "#include \"nasmlib.h\"\n";
print OUT "#include \"hashtbl.h\"\n";
print OUT "#include \"preproc.h\"\n";
print OUT "\n";
# Note that this is global.
printf OUT "const char * const pp_directives[%d] = {\n", scalar(@pptok);
foreach $d (@pptok) {
if (defined($d) && $d !~ /[A-Z]/) {
print OUT " \"%$d\",\n";
} else {
print OUT " NULL,\n";
}
}
print OUT "};\n";
printf OUT "const uint8_t pp_directives_len[%d] = {\n", scalar(@pptok);
foreach $d (@pptok) {
printf OUT " %d,\n", defined($d) ? length($d)+1 : 0;
}
print OUT "};\n";
# Put a large value in unused hash slots. This makes it extremely
# unlikely that any combination that involves unused slot will
# pass the range test. This speeds up rejection of unrecognized
# tokens, i.e. identifiers.
print OUT "\n#define INVALID_HASH_ENTRY (65535/3)\n";
my %tokens = ();
my @tokendata = ();
my $n = 0;
foreach $pt (@pptok) {
# Upper case characters signify internal use tokens only
if (defined($pt) && $pt !~ /[A-Z]/) {
$tokens{'%'.$pt} = $n;
if ($pt =~ /[\@\[\]\\_]/) {
# Fail on characters which look like upper-case letters
# to the quick-and-dirty downcasing in the prehash
# (see below)
die "$in: invalid character in token: $pt";
}
}
$n++;
}
my @hashinfo = gen_perfect_hash(\%tokens);
if (!@hashinfo) {
die "$0: no hash found\n";
}
# Paranoia...
verify_hash_table(\%tokens, \@hashinfo);
($n, $sv, $g) = @hashinfo;
die if ($n & ($n-1));
$n <<= 1;
print OUT "\n\n/* Primary preprocessor token hash */\n\n";
print OUT "enum preproc_token pp_token_hash(const char *token)\n";
print OUT "{\n";
print OUT " static const int16_t hashdata[$n] = {\n";
for ($i = 0; $i < $n; $i++) {
my $h = ${$g}[$i];
print OUT " ", defined($h) ? $h : 'INVALID_HASH_ENTRY', ",\n";
}
print OUT " };\n";
print OUT " uint32_t k1, k2;\n";
print OUT " uint64_t crc;\n";
# For correct overflow behavior, "ix" should be unsigned of the same
# width as the hash arrays.
print OUT " uint16_t ix;\n";
print OUT "\n";
printf OUT " crc = crc64i(UINT64_C(0x%08x%08x), token);\n",
$$sv[0], $$sv[1];
printf OUT " k1 = ((uint32_t)crc & 0x%x) + 0;\n", $n-2;
printf OUT " k2 = ((uint32_t)(crc >> 32) & 0x%x) + 1;\n", $n-2;
print OUT "\n";
print OUT " ix = hashdata[k1] + hashdata[k2];\n";
printf OUT " if (ix >= %d)\n", scalar(@pptok);
print OUT " return PP_invalid;\n";
print OUT "\n";
print OUT " if (!pp_directives[ix] || nasm_stricmp(pp_directives[ix], token))\n";
print OUT " return PP_invalid;\n";
print OUT "\n";
print OUT " return ix;\n";
print OUT "}\n";
my %tasmtokens = ();
foreach $pt (@tasm) {
# TASM compatibility token
$nasmt = '%'.$pt;
if (!defined($tokens{$nasmt})) {
die "$in: TASM compat token $pt does not have a ".
"corresponding $nasmt\n";
}
$tasmtokens{$pt} = $tokens{$nasmt};
}
@hashinfo = gen_perfect_hash(\%tasmtokens);
if (!@hashinfo) {
die "$0: no hash found\n";
}
# Paranoia...
verify_hash_table(\%tasmtokens, \@hashinfo);
($n, $sv, $g) = @hashinfo;
die if ($n & ($n-1));
$n <<= 1;
print OUT "\n\n/* TASM compatibility preprocessor token hash */\n";
print OUT "enum preproc_token pp_tasm_token_hash(const char *token)\n";
print OUT "{\n";
print OUT " static const int16_t hashdata[$n] = {\n";
for ($i = 0; $i < $n; $i++) {
my $h = ${$g}[$i];
print OUT " ", defined($h) ? $h : 'INVALID_HASH_ENTRY', ",\n";
}
print OUT " };\n";
print OUT " uint32_t k1, k2;\n";
print OUT " uint64_t crc;\n";
# For correct overflow behavior, "ix" should be unsigned of the same
# width as the hash arrays.
print OUT " uint16_t ix;\n";
print OUT "\n";
printf OUT " crc = crc64i(UINT64_C(0x%08x%08x), token);\n",
$$sv[0], $$sv[1];
printf OUT " k1 = ((uint32_t)crc & 0x%x) + 0;\n", $n-2;
printf OUT " k2 = ((uint32_t)(crc >> 32) & 0x%x) + 1;\n", $n-2;
print OUT "\n";
printf OUT " ix = hashdata[k1] + hashdata[k2];\n", $n-1, $n-1;
# Comparing to pptok here is correct, because this hash produces
# an enum preproc_token value directly.
printf OUT " if (ix >= %d)\n", scalar(@pptok);
print OUT " return PP_invalid;\n";
print OUT "\n";
print OUT " if (!pp_directives[ix] || nasm_stricmp(pp_directives[ix]+1, token))\n";
print OUT " return PP_invalid;\n";
print OUT "\n";
print OUT " return ix;\n";
print OUT "}\n";
}
#
# Output pptok.ph
#
if ($what eq 'ph') {
print OUT "# Automatically generated from $in by $0\n";
print OUT "# Do not edit\n";
print OUT "\n\%pptok_hash = (\n";
$n = 0;
foreach $tok (@pptok) {
if (defined($tok)) {
printf OUT " '%%%s' => %d,\n", $tok, $n;
}
$n++;
}
print OUT ");\n";
print OUT "\n\@pptok_list = (\n";
foreach $tok (@pptok) {
print OUT " ", (defined($tok) ? "'\%$tok'" : 'undef'), ",\n";
}
print OUT ");\n";
print OUT "\n1;\n";
}