Additional detail.

[openssl.git] / util / mkerr.pl

diff --git a/util/mkerr.pl b/util/mkerr.pl
index d8e6239e4269f8b484210d66015e4933c1fb8a16..d8053b092f633264cfd4c1db8f2ce0c2a550b7fc 100644 (file)
--- a/util/mkerr.pl
+++ b/util/mkerr.pl
@@ -1,6 +1,7 @@
 #!/usr/local/bin/perl -w
 
 my $config = "crypto/err/openssl.ec";
+my $hprefix = "openssl/";
 my $debug = 0;
 my $rebuild = 0;
 my $static = 1;
@@ -17,6 +18,9 @@ while (@ARGV) {
        if($arg eq "-conf") {
                shift @ARGV;
                $config = shift @ARGV;
+       } elsif($arg eq "-hprefix") {
+               shift @ARGV;
+               $hprefix = shift @ARGV;
        } elsif($arg eq "-debug") {
                $debug = 1;
                shift @ARGV;
@@ -65,6 +69,8 @@ while(<IN>)
                        $csrc{$1} = $3;
                        $fmax{$1} = 99;
                        $rmax{$1} = 99;
+                       $fassigned{$1} = ":";
+                       $rassigned{$1} = ":";
                        $fnew{$1} = 0;
                        $rnew{$1} = 0;
                }
@@ -103,15 +109,24 @@ while (($hdr, $lib) = each %libinc)
                    next;
                }
 
-               $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
+               if(/\/\*/) {
+                   if (not /\*\//) {           # multiline comment...
+                       $line = $_;             # ... just accumulate
+                       next; 
+                   } else {
+                       s/\/\*.*?\*\///gs;      # wipe it
+                   }
+               }
+
                if ($cpp) {
-                   $cpp = 0 if /^#.*endif/;
+                   $cpp++ if /^#\s*if/;
+                   $cpp-- if /^#\s*endif/;
                    next;
                }
+               $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
 
                next if (/^\#/);                      # skip preprocessor directives
 
-               s/\/\*.*?\*\///gs;                   # ignore comments
                s/{[^{}]*}//gs;                      # ignore {} blocks
 
                if (/\{|\/\*/) { # Add a } so editor works...
@@ -128,27 +143,28 @@ while (($hdr, $lib) = each %libinc)
            $defnr++;
            print STDERR "def: $defnr\r" if $debug;
 
+           # The goal is to collect function names from function declarations.
+
            s/^[\n\s]*//g;
            s/[\n\s]*$//g;
-           next if(/typedef\W/);
-           if (/\(\*(\w*)\([^\)]+/) {
-               my $name = $1;
-               $name =~ tr/[a-z]/[A-Z]/;
-               $ftrans{$name} = $1;
-           } elsif (/\w+\W+(\w+)\W*\(\s*\)(\s*__attribute__\(.*\)\s*)?$/s){
-               # K&R C
-               next ;
-           } elsif (/\w+\W+\w+\W*\(.*\)(\s*__attribute__\(.*\)\s*)?$/s) {
-               while (not /\(\)(\s*__attribute__\(.*\)\s*)?$/s) {
-                   s/[^\(\)]*\)(\s*__attribute__\(.*\)\s*)?$/\)/s;
-                   s/\([^\(\)]*\)\)(\s*__attribute__\(.*\)\s*)?$/\)/s;
-               }
-               s/\(void\)//;
-               /(\w+(\{[0-9]+\})?)\W*\(\)/s;
-               my $name = $1;
+
+           # Skip over recognized non-function declarations
+           next if(/typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/);
+
+           # Reduce argument lists to empty ()
+           # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
+           while(/\(.*\)/s) {
+               s/\([^\(\)]+\)/\{\}/gs;
+               s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;    #(*f{}) -> f
+           }
+           # pretend as we didn't use curly braces: {} -> ()
+           s/\{\}/\(\)/gs;
+
+           if (/(\w+)\s*\(\).*/s) {    # first token prior [first] () is
+               my $name = $1;          # a function name!
                $name =~ tr/[a-z]/[A-Z]/;
                $ftrans{$name} = $1;
-           } elsif (/\(/ and not (/=/ or /DECLARE_STACK/ or /TYPEDEF_D2I2D_OF/)) {
+           } elsif (/[\(\)]/ and not (/=/)) {
                print STDERR "Header $hdr: cannot parse: $_;\n";
            }
        }
@@ -161,7 +177,7 @@ while (($hdr, $lib) = each %libinc)
        # maximum code used.
 
        if ($gotfile) {
-           while(<IN>) {
+         while(<IN>) {
                if(/^\#define\s+(\S+)\s+(\S+)/) {
                        $name = $1;
                        $code = $2;
@@ -172,18 +188,49 @@ while (($hdr, $lib) = each %libinc)
                        }
                        if($1 eq "R") {
                                $rcodes{$name} = $code;
+                               if ($rassigned{$lib} =~ /:$code:/) {
+                                       print STDERR "!! ERROR: $lib reason code $code assigned twice\n";
+                               }
+                               $rassigned{$lib} .= "$code:";
                                if(!(exists $rextra{$name}) &&
                                         ($code > $rmax{$lib}) ) {
                                        $rmax{$lib} = $code;
                                }
                        } else {
+                               if ($fassigned{$lib} =~ /:$code:/) {
+                                       print STDERR "!! ERROR: $lib function code $code assigned twice\n";
+                               }
+                               $fassigned{$lib} .= "$code:";
                                if($code > $fmax{$lib}) {
                                        $fmax{$lib} = $code;
                                }
                                $fcodes{$name} = $code;
                        }
                }
-           }
+         }
+       }
+
+       if ($debug) {
+               if (defined($fmax{$lib})) {
+                       print STDERR "Max function code fmax" . "{" . "$lib" . "} = $fmax{$lib}\n";
+                       $fassigned{$lib} =~ m/^:(.*):$/;
+                       @fassigned = sort {$a <=> $b} split(":", $1);
+                       print STDERR "  @fassigned\n";
+               }
+               if (defined($rmax{$lib})) {
+                       print STDERR "Max reason code rmax" . "{" . "$lib" . "} = $rmax{$lib}\n";
+                       $rassigned{$lib} =~ m/^:(.*):$/;
+                       @rassigned = sort {$a <=> $b} split(":", $1);
+                       print STDERR "  @rassigned\n";
+               }
+       }
+
+       if ($lib eq "SSL") {
+               if ($rmax{$lib} >= 1000) {
+                       print STDERR "!! ERROR: SSL error codes 1000+ are reserved for alerts.\n";
+                       print STDERR "!!        Any new alerts must be added to $config.\n";
+                       print STDERR "\n";
+               }
        }
        close IN;
 }
@@ -200,11 +247,10 @@ while (($hdr, $lib) = each %libinc)
 # so all those unreferenced can be printed out.
 
 
-print STDERR "Files loaded: " if $debug;
 foreach $file (@source) {
        # Don't parse the error source file.
        next if exists $cskip{$file};
-       print STDERR $file if $debug;
+       print STDERR "File loaded: ".$file."\r" if $debug;
        open(IN, "<$file") || die "Can't open source file $file\n";
        while(<IN>) {
                if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
@@ -228,7 +274,7 @@ foreach $file (@source) {
        }
        close IN;
 }
-print STDERR "\n" if $debug;
+print STDERR "                                  \n" if $debug;
 
 # Now process each library in turn.
 
@@ -355,7 +401,16 @@ EOF
        foreach $i (@function) {
                $z=6-int(length($i)/8);
                if($fcodes{$i} eq "X") {
-                       $fcodes{$i} = ++$fmax{$lib};
+                       $fassigned{$lib} =~ m/^:([^:]*):/;
+                       $findcode = $1;
+                       if (!defined($findcode)) {
+                               $findcode = $fmax{$lib};
+                       }
+                       while ($fassigned{$lib} =~ m/:$findcode:/) {
+                               $findcode++;
+                       }
+                       $fcodes{$i} = $findcode;
+                       $fassigned{$lib} .= "$findcode:";
                        print STDERR "New Function code $i\n" if $debug;
                }
                printf OUT "#define $i%s $fcodes{$i}\n","\t" x $z;
@@ -366,7 +421,16 @@ EOF
        foreach $i (@reasons) {
                $z=6-int(length($i)/8);
                if($rcodes{$i} eq "X") {
-                       $rcodes{$i} = ++$rmax{$lib};
+                       $rassigned{$lib} =~ m/^:([^:]*):/;
+                       $findcode = $1;
+                       if (!defined($findcode)) {
+                               $findcode = $rmax{$lib};
+                       }
+                       while ($rassigned{$lib} =~ m/:$findcode:/) {
+                               $findcode++;
+                       }
+                       $rcodes{$i} = $findcode;
+                       $rassigned{$lib} .= "$findcode:";
                        print STDERR "New Reason code   $i\n" if $debug;
                }
                printf OUT "#define $i%s $rcodes{$i}\n","\t" x $z;
@@ -396,7 +460,7 @@ EOF
        my $hincf;
        if($static) {
                $hfile =~ /([^\/]+)$/;
-               $hincf = "<openssl/$1>";
+               $hincf = "<${hprefix}$1>";
        } else {
                $hincf = "\"$hfile\"";
        }