./util update, which covers various issues, but most importantly mkerr.pl
[openssl.git] / util / mkerr.pl
index fc481eec0a0844acbce3ea979087a38c87d54b4c..030899b7ab449f6cbfac737ef758477c4d1046d1 100644 (file)
@@ -9,6 +9,9 @@ my $reindex = 0;
 my $dowrite = 0;
 my $staticloader = "";
 
+my $pack_errcode;
+my $load_errcode;
+
 while (@ARGV) {
        my $arg = $ARGV[0];
        if($arg eq "-conf") {
@@ -82,38 +85,49 @@ while (($hdr, $lib) = each %libinc)
 {
        next if($hdr eq "NONE");
        print STDERR "Scanning header file $hdr\n" if $debug; 
-       open(IN, "<$hdr") || die "Can't open Header file $hdr\n";
-       my $line = "", $def= "", $linenr = 0;
-       while(<IN>) {
-           $linenr++;
-           print STDERR "line: $linenr\r" if $debug;
+       my $line = "", $def= "", $linenr = 0, $gotfile = 0;
+       if (open(IN, "<$hdr")) {
+           $gotfile = 1;
+           while(<IN>) {
+               $linenr++;
+               print STDERR "line: $linenr\r" if $debug;
+
+               last if(/BEGIN\s+ERROR\s+CODES/);
+               if ($line ne '') {
+                   $_ = $line . $_;
+                   $line = '';
+               }
 
-           last if(/BEGIN\s+ERROR\s+CODES/);
-           if ($line ne '') {
-               $_ = $line . $_;
-               $line = '';
-           }
+               if (/\\$/) {
+                   $line = $_;
+                   next;
+               }
 
-           if (/\\$/) {
-               $line = $_;
-               next;
-           }
+               if(/\/\*/) {
+                   if (not /\*\//) {           # multiline comment...
+                       $line = $_;             # ... just accumulate
+                       next; 
+                   } else {
+                       s/\/\*.*?\*\///gs;      # wipe it
+                   }
+               }
 
-           $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
-           if ($cpp) {
-               $cpp = 0 if /^#.*endif/;
-               next;
-           }
+               if ($cpp) {
+                   $cpp++ if /^#\s*if/;
+                   $cpp-- if /^#\s*endif/;
+                   next;
+               }
+               $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
 
-           next if (/^#/);                      # skip preprocessor directives
+               next if (/^\#/);                      # skip preprocessor directives
 
-           s/\/\*.*?\*\///gs;                   # ignore comments
-           s/{[^{}]*}//gs;                      # ignore {} blocks
+               s/{[^{}]*}//gs;                      # ignore {} blocks
 
-           if (/{|\/\*/) { # Add a } so editor works...
-               $line = $_;
-           } else {
-               $def .= $_;
+               if (/\{|\/\*/) { # Add a } so editor works...
+                   $line = $_;
+               } else {
+                   $def .= $_;
+               }
            }
        }
 
@@ -123,27 +137,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){
-               # K&R C
-               next ;
-           } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
-               while (not /\(\)$/s) {
-                   s/[^\(\)]*\)$/\)/s;
-                   s/\([^\(\)]*\)\)$/\)/s;
-               }
-               s/\(void\)//;
-               /(\w+)\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/)) {
+           } elsif (/[\(\)]/ and not (/=/)) {
                print STDERR "Header $hdr: cannot parse: $_;\n";
            }
        }
@@ -155,8 +170,9 @@ while (($hdr, $lib) = each %libinc)
        # Scan function and reason codes and store them: keep a note of the
        # maximum code used.
 
-       while(<IN>) {
-               if(/^#define\s+(\S+)\s+(\S+)/) {
+       if ($gotfile) {
+           while(<IN>) {
+               if(/^\#define\s+(\S+)\s+(\S+)/) {
                        $name = $1;
                        $code = $2;
                        next if $name =~ /^${lib}err/;
@@ -177,6 +193,7 @@ while (($hdr, $lib) = each %libinc)
                                $fcodes{$name} = $code;
                        }
                }
+           }
        }
        close IN;
 }
@@ -193,11 +210,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_]+))/) {
@@ -248,15 +264,74 @@ foreach $lib (keys %csrc)
 
        # Rewrite the header file
 
-       open(IN, "<$hfile") || die "Can't Open Header File $hfile\n";
-
-       # Copy across the old file
-       while(<IN>) {
+       if (open(IN, "<$hfile")) {
+           # Copy across the old file
+           while(<IN>) {
                push @out, $_;
                last if (/BEGIN ERROR CODES/);
+           }
+           close IN;
+       } else {
+           push @out,
+"/* ====================================================================\n",
+" * Copyright (c) 2001-2005 The OpenSSL Project.  All rights reserved.\n",
+" *\n",
+" * Redistribution and use in source and binary forms, with or without\n",
+" * modification, are permitted provided that the following conditions\n",
+" * are met:\n",
+" *\n",
+" * 1. Redistributions of source code must retain the above copyright\n",
+" *    notice, this list of conditions and the following disclaimer. \n",
+" *\n",
+" * 2. Redistributions in binary form must reproduce the above copyright\n",
+" *    notice, this list of conditions and the following disclaimer in\n",
+" *    the documentation and/or other materials provided with the\n",
+" *    distribution.\n",
+" *\n",
+" * 3. All advertising materials mentioning features or use of this\n",
+" *    software must display the following acknowledgment:\n",
+" *    \"This product includes software developed by the OpenSSL Project\n",
+" *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)\"\n",
+" *\n",
+" * 4. The names \"OpenSSL Toolkit\" and \"OpenSSL Project\" must not be used to\n",
+" *    endorse or promote products derived from this software without\n",
+" *    prior written permission. For written permission, please contact\n",
+" *    openssl-core\@openssl.org.\n",
+" *\n",
+" * 5. Products derived from this software may not be called \"OpenSSL\"\n",
+" *    nor may \"OpenSSL\" appear in their names without prior written\n",
+" *    permission of the OpenSSL Project.\n",
+" *\n",
+" * 6. Redistributions of any form whatsoever must retain the following\n",
+" *    acknowledgment:\n",
+" *    \"This product includes software developed by the OpenSSL Project\n",
+" *    for use in the OpenSSL Toolkit (http://www.openssl.org/)\"\n",
+" *\n",
+" * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY\n",
+" * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n",
+" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n",
+" * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR\n",
+" * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n",
+" * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\n",
+" * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n",
+" * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n",
+" * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\n",
+" * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n",
+" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\n",
+" * OF THE POSSIBILITY OF SUCH DAMAGE.\n",
+" * ====================================================================\n",
+" *\n",
+" * This product includes cryptographic software written by Eric Young\n",
+" * (eay\@cryptsoft.com).  This product includes software written by Tim\n",
+" * Hudson (tjh\@cryptsoft.com).\n",
+" *\n",
+" */\n",
+"\n",
+"#ifndef HEADER_${lib}_ERR_H\n",
+"#define HEADER_${lib}_ERR_H\n",
+"\n",
+"/* BEGIN ERROR CODES */\n";
        }
-       close IN;
-
        open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";
 
        print OUT @out;
@@ -335,13 +410,27 @@ EOF
                $hincf = "\"$hfile\"";
        }
 
+       # If static we know the error code at compile time so use it
+       # in error definitions.
+
+       if ($static)
+               {
+               $pack_errcode = "ERR_LIB_${lib}";
+               $load_errcode = "0";
+               }
+       else
+               {
+               $pack_errcode = "0";
+               $load_errcode = "ERR_LIB_${lib}";
+               }
+
 
        open (OUT,">$cfile") || die "Can't open $cfile for writing";
 
        print OUT <<"EOF";
 /* $cfile */
 /* ====================================================================
- * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
+ * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -405,6 +494,10 @@ EOF
 
 /* BEGIN ERROR CODES */
 #ifndef OPENSSL_NO_ERR
+
+#define ERR_FUNC(func) ERR_PACK($pack_errcode,func,0)
+#define ERR_REASON(reason) ERR_PACK($pack_errcode,0,reason)
+
 static ERR_STRING_DATA ${lib}_str_functs[]=
        {
 EOF
@@ -416,7 +509,8 @@ EOF
                if(exists $ftrans{$fn}) {
                        $fn = $ftrans{$fn};
                }
-               print OUT "{ERR_PACK(0,$i,0),\t\"$fn\"},\n";
+#              print OUT "{ERR_PACK($pack_errcode,$i,0),\t\"$fn\"},\n";
+               print OUT "{ERR_FUNC($i),\t\"$fn\"},\n";
        }
        print OUT <<"EOF";
 {0,NULL}
@@ -428,6 +522,7 @@ EOF
        # Add each reason code.
        foreach $i (@reasons) {
                my $rn;
+               my $rstr = "ERR_REASON($i)";
                my $nspc = 0;
                if (exists $err_reason_strings{$i}) {
                        $rn = $err_reason_strings{$i};
@@ -436,9 +531,9 @@ EOF
                        $rn = $1;
                        $rn =~ tr/_[A-Z]/ [a-z]/;
                }
-               $nspc = 40 - length($i) unless length($i) > 40;
+               $nspc = 40 - length($rstr) unless length($rstr) > 40;
                $nspc = " " x $nspc;
-               print OUT "{${i}${nspc},\"$rn\"},\n";
+               print OUT "{${rstr}${nspc},\"$rn\"},\n";
        }
 if($static) {
        print OUT <<"EOF";
@@ -455,8 +550,8 @@ ${staticloader}void ERR_load_${lib}_strings(void)
                {
                init=0;
 #ifndef OPENSSL_NO_ERR
-               ERR_load_strings(ERR_LIB_${lib},${lib}_str_functs);
-               ERR_load_strings(ERR_LIB_${lib},${lib}_str_reasons);
+               ERR_load_strings($load_errcode,${lib}_str_functs);
+               ERR_load_strings($load_errcode,${lib}_str_reasons);
 #endif
 
                }