Add a test for the wrong version number in a record
[openssl.git] / util / mkerr.pl
index fd5e774e74b669102fda0e1fb0ef40220d9974e2..4645658e993a73c3797725d049f2b0621f3f17da 100644 (file)
@@ -7,7 +7,6 @@
 # https://www.openssl.org/source/license.html
 
 my $config = "crypto/err/openssl.ec";
-my $hprefix = "openssl/";
 my $debug = 0;
 my $unref = 0;
 my $rebuild = 0;
@@ -16,6 +15,8 @@ my $recurse = 0;
 my $reindex = 0;
 my $dowrite = 0;
 my $staticloader = "";
+my @t = localtime();
+my $YEAR = @t[5] + 1900;
 
 my $pack_errcode;
 my $load_errcode;
@@ -68,6 +69,8 @@ Options:
   -hprefix P    Prepend the filenames in generated #include <header>
                 statements with prefix P. Default: 'openssl/' (without
                 the quotes, naturally)
+                NOTE: not used any more because our include directory
+                structure has changed.
 
   -debug        Turn on debugging verbose output on stderr.
 
@@ -94,7 +97,7 @@ Options:
                 Default: keep previously assigned numbers. (You are warned
                          when collisions are detected.)
 
-  -nostatic     Generates a different source code, where these additional 
+  -nostatic     Generates a different source code, where these additional
                 functions are generated for each library specified in the
                 config file:
                   void ERR_load_<LIB>_strings(void);
@@ -102,7 +105,7 @@ Options:
                   void ERR_<LIB>_error(int f, int r, char *fn, int ln);
                   #define <LIB>err(f,r) ERR_<LIB>_error(f,r,OPENSSL_FILE,OPENSSL_LINE)
                 while the code facilitates the use of these in an environment
-                where the error support routines are dynamically loaded at 
+                where the error support routines are dynamically loaded at
                 runtime.
                 Default: 'static' code generation.
 
@@ -111,8 +114,8 @@ Options:
 
   -unref        Print out unreferenced function and reason codes.
 
-  -write        Actually (over)write the generated code to the header and C 
-                source files as assigned to each library through the config 
+  -write        Actually (over)write the generated code to the header and C
+                source files as assigned to each library through the config
                 file.
                 Default: don't write.
 
@@ -171,8 +174,8 @@ close IN;
 while (($hdr, $lib) = each %libinc)
 {
        next if($hdr eq "NONE");
-       print STDERR "Scanning header file $hdr\n" if $debug; 
-       my $line = "", $def= "", $linenr = 0, $gotfile = 0;
+       print STDERR "Scanning header file $hdr\n" if $debug;
+       my $line = "", $def= "", $linenr = 0, $gotfile = 0, $cpp = 0;
        if (open(IN, "<$hdr")) {
            $gotfile = 1;
            while(<IN>) {
@@ -193,7 +196,7 @@ while (($hdr, $lib) = each %libinc)
                if(/\/\*/) {
                    if (not /\*\//) {           # multiline comment...
                        $line = $_;             # ... just accumulate
-                       next; 
+                       next;
                    } else {
                        s/\/\*.*?\*\///gs;      # wipe it
                    }
@@ -367,7 +370,7 @@ foreach $file (@source) {
                 print STDERR "ERROR: mismatch $file:$linenr $func:$3\n";
                 $errcount++;
             }
-                       print STDERR "Function: $1\t= $fcodes{$1} (lib: $2, name: $3)\n" if $debug; 
+                       print STDERR "Function: $1\t= $fcodes{$1} (lib: $2, name: $3)\n" if $debug;
                }
                if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
                        next unless exists $csrc{$2};
@@ -376,8 +379,8 @@ foreach $file (@source) {
                                $rcodes{$1} = "X";
                                $rnew{$2}++;
                        }
-                       print STDERR "Reason: $1\t= $rcodes{$1} (lib: $2)\n" if $debug; 
-               } 
+                       print STDERR "Reason: $1\t= $rcodes{$1} (lib: $2)\n" if $debug;
+               }
        }
        close IN;
 }
@@ -407,17 +410,24 @@ foreach $lib (keys %csrc)
 
        # Rewrite the header file
 
+       $cpp = 0;
+       $cplusplus = 0;
        if (open(IN, "<$hfile")) {
            # Copy across the old file
            while(<IN>) {
+               $cplusplus = $cpp if /^#.*ifdef.*cplusplus/;
+               $cpp++ if /^#\s*if/;
+               $cpp-- if /^#\s*endif/;
                push @out, $_;
                last if (/BEGIN ERROR CODES/);
            }
            close IN;
        } else {
+           $cpp = 1;
+           $cplusplus = 1;
            push @out,
 "/*\n",
-" * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.\n",
+" * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.\n",
 " *\n",
 " * Licensed under the OpenSSL license (the \"License\").  You may not use\n",
 " * this file except in compliance with the License.  You can obtain a copy\n",
@@ -426,11 +436,11 @@ foreach $lib (keys %csrc)
 " */\n",
 "\n",
 "#ifndef HEADER_${lib}_ERR_H\n",
-"#define HEADER_${lib}_ERR_H\n",
+"# define HEADER_${lib}_ERR_H\n",
 "\n",
-"#ifdef  __cplusplus\n",
+"# ifdef  __cplusplus\n",
 "extern \"C\" {\n",
-"#endif\n",
+"# endif\n",
 "\n",
 "/* BEGIN ERROR CODES */\n";
        }
@@ -443,15 +453,16 @@ 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);
+${staticloader}int ERR_load_${lib}_strings(void);
 
 EOF
        } else {
                print OUT <<"EOF";
-${staticloader}void ERR_load_${lib}_strings(void);
+${staticloader}int 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),OPENSSL_FILE,OPENSSL_LINE)
@@ -503,11 +514,17 @@ EOF
        }
        print OUT <<"EOF";
 
-#ifdef  __cplusplus
-}
-#endif
-#endif
 EOF
+       do {
+           if ($cplusplus == $cpp) {
+               print OUT "#", " "x$cpp, "ifdef  __cplusplus\n";
+               print OUT "}\n";
+               print OUT "#", " "x$cpp, "endif\n";
+           }
+           if ($cpp-- > 0) {
+               print OUT "#", " "x$cpp, "endif\n";
+           }
+       } while ($cpp);
        close OUT;
 
        # Rewrite the C source file containing the error details.
@@ -539,8 +556,13 @@ EOF
 
        my $hincf;
        if($static) {
-               $hfile =~ /([^\/]+)$/;
-               $hincf = "<${hprefix}$1>";
+               $hincf = $hfile;
+               $hincf =~ s|.*include/||;
+               if ($hincf =~ m|^openssl/|) {
+                       $hincf = "<${hincf}>";
+               } else {
+                       $hincf = "\"${hincf}\"";
+               }
        } else {
                $hincf = "\"$hfile\"";
        }
@@ -564,18 +586,13 @@ EOF
 
        print OUT <<"EOF";
 /*
- * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Generated by util/mkerr.pl DO NOT EDIT
+ * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
  *
  * Licensed under the OpenSSL license (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
  * in the file LICENSE in the source distribution or at
  * https://www.openssl.org/source/license.html
-*/
-
-/*
- * 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,
- * only reason strings will be preserved.
  */
 
 #include <stdio.h>
@@ -599,7 +616,7 @@ EOF
                        $fn = $ftrans{$fn};
                }
 #              print OUT "{ERR_PACK($pack_errcode,$i,0),\t\"$fn\"},\n";
-               if(length($i) + length($fn) > 58) {
+               if(length($i) + length($fn) > 57) {
                        print OUT "    {ERR_FUNC($i),\n     \"$fn\"},\n";
                } else {
                        print OUT "    {ERR_FUNC($i), \"$fn\"},\n";
@@ -622,7 +639,7 @@ EOF
                        $rn = $1;
                        $rn =~ tr/_[A-Z]/ [a-z]/;
                }
-               if(length($i) + length($rn) > 56) {
+               if(length($i) + length($rn) > 55) {
                        print OUT "    {${rstr},\n     \"$rn\"},\n";
                } else {
                        print OUT "    {${rstr}, \"$rn\"},\n";
@@ -635,7 +652,7 @@ if($static) {
 
 #endif
 
-${staticloader}void ERR_load_${lib}_strings(void)
+${staticloader}int ERR_load_${lib}_strings(void)
 {
 #ifndef OPENSSL_NO_ERR
 
@@ -644,6 +661,7 @@ ${staticloader}void ERR_load_${lib}_strings(void)
         ERR_load_strings($load_errcode, ${lib}_str_reasons);
     }
 #endif
+    return 1;
 }
 EOF
 } else {
@@ -663,7 +681,7 @@ static ERR_STRING_DATA ${lib}_lib_name[] = {
 static int ${lib}_lib_error_code = 0;
 static int ${lib}_error_init = 1;
 
-${staticloader}void ERR_load_${lib}_strings(void)
+${staticloader}int ERR_load_${lib}_strings(void)
 {
     if (${lib}_lib_error_code == 0)
         ${lib}_lib_error_code = ERR_get_next_error_library();
@@ -680,6 +698,7 @@ ${staticloader}void ERR_load_${lib}_strings(void)
         ERR_load_strings(0, ${lib}_lib_name);
 #endif
     }
+    return 1;
 }
 
 ${staticloader}void ERR_unload_${lib}_strings(void)