Include error library value in C error source files instead of fixing up
[openssl.git] / util / mkerr.pl
index 062619de50d9965cc178c58715a8bd7ac74c9a90..4b1b1531a3df157e08e532c46dc6f0ba6fc0d2bc 100644 (file)
@@ -3,10 +3,14 @@
 my $config = "crypto/err/openssl.ec";
 my $debug = 0;
 my $rebuild = 0;
-my $static = 0;
+my $static = 1;
 my $recurse = 0;
 my $reindex = 0;
+my $dowrite = 0;
+my $staticloader = "";
 
+my $pack_errcode;
+my $load_errcode;
 
 while (@ARGV) {
        my $arg = $ARGV[0];
@@ -25,8 +29,14 @@ while (@ARGV) {
        } elsif($arg eq "-reindex") {
                $reindex = 1;
                shift @ARGV;
-       } elsif($arg eq "-static") {
-               $static = 1;
+       } elsif($arg eq "-nostatic") {
+               $static = 0;
+               shift @ARGV;
+       } elsif($arg eq "-staticloader") {
+               $staticloader = "static ";
+               shift @ARGV;
+       } elsif($arg eq "-write") {
+               $dowrite = 1;
                shift @ARGV;
        } else {
                last;
@@ -34,7 +44,7 @@ while (@ARGV) {
 }
 
 if($recurse) {
-       @source = (<crypto/*.c>, <crypto/*/*.c>, ,<rsaref/*.c>, <ssl/*.c>);
+       @source = (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>);
 } else {
        @source = @ARGV;
 }
@@ -49,6 +59,7 @@ while(<IN>)
 {
        if(/^L\s+(\S+)\s+(\S+)\s+(\S+)/) {
                $hinc{$1} = $2;
+               $libinc{$2} = $1;
                $cskip{$3} = $1;
                if($3 ne "NONE") {
                        $csrc{$1} = $3;
@@ -62,7 +73,6 @@ while(<IN>)
        } elsif (/^R\s+(\S+)\s+(\S+)/) {
                $rextra{$1} = $2;
                $rcodes{$1} = $2;
-       # Add extra reason with $1, value $2
        }
 }
 
@@ -71,73 +81,91 @@ close IN;
 # Scan each header file in turn and make a list of error codes
 # and function names
 
-while (($lib, $hdr) = each %hinc)
+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= "";
-       while(<IN>) {
-           last if(/BEGIN\s+ERROR\s+CODES/);
-           if ($line ne '') {
-               $_ = $line . $_;
-               $line = '';
-           }
+       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 = '';
+               }
 
-           if (/\\$/) {
-               $line = $_;
-               next;
-           }
+               if (/\\$/) {
+                   $line = $_;
+                   next;
+               }
 
-           $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
-           if ($cpp) {
-               $cpp = 0 if /^#.*endif/;
-               next;
-           }
+               $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
+               if ($cpp) {
+                   $cpp = 0 if /^#.*endif/;
+                   next;
+               }
 
-           next if (/^#/);                      # skip preprocessor directives
+               next if (/^\#/);                      # skip preprocessor directives
 
-           s/\/\*.*?\*\///gs;                   # ignore comments
-           s/{[^{}]*}//gs;                      # ignore {} blocks
+               s/\/\*.*?\*\///gs;                   # ignore comments
+               s/{[^{}]*}//gs;                      # ignore {} blocks
 
-           if (/{|\/\*/) { # Add a } so editor works...
-               $line = $_;
-           } else {
-               $def .= $_;
+               if (/\{|\/\*/) { # Add a } so editor works...
+                   $line = $_;
+               } else {
+                   $def .= $_;
+               }
            }
        }
 
+       print STDERR "                                  \r" if $debug;
+        $defnr = 0;
        foreach (split /;/, $def) {
+           $defnr++;
+           print STDERR "def: $defnr\r" if $debug;
+
            s/^[\n\s]*//g;
            s/[\n\s]*$//g;
-           next if (/\w+\W+(\w+)\W*\(\s*\)$/s); # K&R C
-           next if (/\(\*(\w*)\([^\)]+/);
-           if (/\w+\W+\w+\W*\(.*\)$/s) {
-               while (not /\(\)$/s) {
-                   s/[^\(\)]*\)$/\)/s;
-                   s/\([^\(\)]*\)\)$/\)/s;
+           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+)\W*\(\)/s;
-               next if(/typedef\W/);
+               /(\w+(\{[0-9]+\})?)\W*\(\)/s;
                my $name = $1;
                $name =~ tr/[a-z]/[A-Z]/;
                $ftrans{$name} = $1;
-               
            } elsif (/\(/ and not (/=/ or /DECLARE_STACK/)) {
                print STDERR "Header $hdr: cannot parse: $_;\n";
            }
        }
 
+       print STDERR "                                  \r" if $debug;
+
        next if $reindex;
 
        # 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/;
                        unless($name =~ /^${lib}_([RF])_(\w+)$/) {
                                print STDERR "Invalid error code $name\n";
                                next;
@@ -155,6 +183,7 @@ while (($lib, $hdr) = each %hinc)
                                $fcodes{$name} = $code;
                        }
                }
+           }
        }
        close IN;
 }
@@ -167,23 +196,30 @@ while (($lib, $hdr) = each %hinc)
 # oddly named structure BIO_F_CTX which needs to be ignored.
 # If a code doesn't exist in list compiled from headers then mark it
 # with the value "X" as a place holder to give it a value later.
+# Store all function and reason codes found in %ufcodes and %urcodes
+# 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;
        open(IN, "<$file") || die "Can't open source file $file\n";
        while(<IN>) {
-               if(/(([A-Z0-9]+)_F_[A-Z0-9_]+)/) {
+               if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
                        next unless exists $csrc{$2};
                        next if($1 eq "BIO_F_BUFFER_CTX");
+                       $ufcodes{$1} = 1;
                        if(!exists $fcodes{$1}) {
                                $fcodes{$1} = "X";
                                $fnew{$2}++;
                        }
+                       $notrans{$1} = 1 unless exists $ftrans{$3};
                }
                if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
                        next unless exists $csrc{$2};
+                       $urcodes{$1} = 1;
                        if(!exists $rcodes{$1}) {
                                $rcodes{$1} = "X";
                                $rnew{$2}++;
@@ -192,6 +228,7 @@ foreach $file (@source) {
        }
        close IN;
 }
+print STDERR "\n" if $debug;
 
 # Now process each library in turn.
 
@@ -205,7 +242,7 @@ foreach $lib (keys %csrc)
        } else {
                print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
                print STDERR " $rnew{$lib} New Reasons.\n";
-
+               next unless $dowrite;
        }
 
        # If we get here then we have some new error codes so we
@@ -218,15 +255,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;
@@ -235,7 +331,22 @@ foreach $lib (keys %csrc)
 /* The following lines are auto generated by the script mkerr.pl. Any changes
  * made after this point may be overwritten when the script is next run.
  */
+EOF
+       if($static) {
+               print OUT <<"EOF";
+${staticloader}void ERR_load_${lib}_strings(void);
 
+EOF
+       } else {
+               print OUT <<"EOF";
+${staticloader}void ERR_load_${lib}_strings(void);
+${staticloader}void ERR_unload_${lib}_strings(void);
+${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line);
+#define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
+
+EOF
+       }
+       print OUT <<"EOF";
 /* Error codes for the $lib functions. */
 
 /* Function codes. */
@@ -266,21 +377,51 @@ EOF
 }
 #endif
 #endif
-
 EOF
        close OUT;
 
        # Rewrite the C source file containing the error details.
 
-       $hfile =~ /([^\/]+)$/;
-       my $hincf = $1;
+       # First, read any existing reason string definitions:
+       my %err_reason_strings;
+       if (open(IN,"<$cfile")) {
+               while (<IN>) {
+                       if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
+                               $err_reason_strings{$1} = $2;
+                       }
+               }
+               close(IN);
+       }
+
+       my $hincf;
+       if($static) {
+               $hfile =~ /([^\/]+)$/;
+               $hincf = "<openssl/$1>";
+       } else {
+               $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
@@ -334,15 +475,20 @@ EOF
  */
 
 /* NOTE: this file was auto generated by the mkerr.pl script: any changes
- * made to it will be overwritten when the script next updates this file.
+ * made to it will be overwritten when the script next updates this file,
+ * only reason strings will be preserved.
  */
 
 #include <stdio.h>
 #include <openssl/err.h>
-#include <openssl/$hincf>
+#include $hincf
 
 /* BEGIN ERROR CODES */
-#ifndef NO_ERR
+#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
@@ -353,10 +499,9 @@ EOF
                $fn = $1;
                if(exists $ftrans{$fn}) {
                        $fn = $ftrans{$fn};
-               } else {
-                       push @notrans, $i;
                }
-               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}
@@ -368,13 +513,18 @@ EOF
        # Add each reason code.
        foreach $i (@reasons) {
                my $rn;
+               my $rstr = "ERR_REASON($i)";
                my $nspc = 0;
-               $i =~ /^${lib}_R_(\S+)$/;
-               $rn = $1;
-               $rn =~ tr/_[A-Z]/ [a-z]/;
-               $nspc = 40 - length($i) unless length($i) > 40;
+               if (exists $err_reason_strings{$i}) {
+                       $rn = $err_reason_strings{$i};
+               } else {
+                       $i =~ /^${lib}_R_(\S+)$/;
+                       $rn = $1;
+                       $rn =~ tr/_[A-Z]/ [a-z]/;
+               }
+               $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";
@@ -383,16 +533,16 @@ if($static) {
 
 #endif
 
-void ERR_load_${lib}_strings(void)
+${staticloader}void ERR_load_${lib}_strings(void)
        {
        static int init=1;
 
        if (init)
                {
                init=0;
-#ifndef NO_ERR
-               ERR_load_strings(ERR_LIB_${lib},${lib}_str_functs);
-               ERR_load_strings(ERR_LIB_${lib},${lib}_str_reasons);
+#ifndef OPENSSL_NO_ERR
+               ERR_load_strings($load_errcode,${lib}_str_functs);
+               ERR_load_strings($load_errcode,${lib}_str_reasons);
 #endif
 
                }
@@ -414,19 +564,18 @@ static ERR_STRING_DATA ${lib}_lib_name[]=
 #endif
 
 
-int ${lib}_lib_error_code=0;
+static int ${lib}_lib_error_code=0;
+static int ${lib}_error_init=1;
 
-void ERR_load_${lib}_strings(void)
+${staticloader}void ERR_load_${lib}_strings(void)
        {
-       static int init=1;
-
        if (${lib}_lib_error_code == 0)
                ${lib}_lib_error_code=ERR_get_next_error_library();
 
-       if (init)
+       if (${lib}_error_init)
                {
-               init=0;
-#ifndef NO_ERR
+               ${lib}_error_init=0;
+#ifndef OPENSSL_NO_ERR
                ERR_load_strings(${lib}_lib_error_code,${lib}_str_functs);
                ERR_load_strings(${lib}_lib_error_code,${lib}_str_reasons);
 #endif
@@ -434,11 +583,27 @@ void ERR_load_${lib}_strings(void)
 #ifdef ${lib}_LIB_NAME
                ${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code,0,0);
                ERR_load_strings(0,${lib}_lib_name);
-#endif;
+#endif
+               }
+       }
+
+${staticloader}void ERR_unload_${lib}_strings(void)
+       {
+       if (${lib}_error_init == 0)
+               {
+#ifndef OPENSSL_NO_ERR
+               ERR_unload_strings(${lib}_lib_error_code,${lib}_str_functs);
+               ERR_unload_strings(${lib}_lib_error_code,${lib}_str_reasons);
+#endif
+
+#ifdef ${lib}_LIB_NAME
+               ERR_unload_strings(0,${lib}_lib_name);
+#endif
+               ${lib}_error_init=1;
                }
        }
 
-void ERR_${lib}_error(int function, int reason, char *file, int line)
+${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
        {
        if (${lib}_lib_error_code == 0)
                ${lib}_lib_error_code=ERR_get_next_error_library();
@@ -449,12 +614,38 @@ EOF
 }
 
        close OUT;
-
+       undef %err_reason_strings;
 }
 
-if($debug && defined(@notrans)) {
+if($debug && defined(%notrans)) {
        print STDERR "The following function codes were not translated:\n";
-       foreach(@notrans)
+       foreach(sort keys %notrans)
+       {
+               print STDERR "$_\n";
+       }
+}
+
+# Make a list of unreferenced function and reason codes
+
+foreach (keys %fcodes) {
+       push (@funref, $_) unless exists $ufcodes{$_};
+}
+
+foreach (keys %rcodes) {
+       push (@runref, $_) unless exists $urcodes{$_};
+}
+
+if($debug && defined(@funref) ) {
+       print STDERR "The following function codes were not referenced:\n";
+       foreach(sort @funref)
+       {
+               print STDERR "$_\n";
+       }
+}
+
+if($debug && defined(@runref) ) {
+       print STDERR "The following reason codes were not referenced:\n";
+       foreach(sort @runref)
        {
                print STDERR "$_\n";
        }