util/mkerr.pl

   1 #! /usr/bin/env perl
   2 # Copyright 1999-2018 The OpenSSL Project Authors. All Rights Reserved.
   3 #
   4 # Licensed under the Apache License 2.0 (the "License").  You may not use
   5 # this file except in compliance with the License.  You can obtain a copy
   6 # in the file LICENSE in the source distribution or at
   7 # https://www.openssl.org/source/license.html
   8
   9 use strict;
  10 use warnings;
  11
  12 use lib ".";
  13 use configdata;
  14
  15 my $config       = "crypto/err/openssl.ec";
  16 my $debug        = 0;
  17 my $internal     = 0;
  18 my $nowrite      = 0;
  19 my $rebuild      = 0;
  20 my $reindex      = 0;
  21 my $static       = 0;
  22 my $unref        = 0;
  23 my %modules         = ();
  24
  25 my $errors       = 0;
  26 my @t            = localtime();
  27 my $YEAR         = $t[5] + 1900;
  28
  29 sub phase
  30 {
  31     my $text = uc(shift);
  32     print STDERR "\n---\n$text\n" if $debug;
  33 }
  34
  35 sub help
  36 {
  37     print STDERR <<"EOF";
  38 mkerr.pl [options] [files...]
  39
  40 Options:
  41
  42     -conf FILE  Use the named config file FILE instead of the default.
  43
  44     -debug      Verbose output debugging on stderr.
  45
  46     -internal   Generate code that is to be built as part of OpenSSL itself.
  47                 Also scans internal list of files.
  48
  49     -module M   Only useful with -internal!
  50                 Only write files for library module M.  Whether files are
  51                 actually written or not depends on other options, such as
  52                 -rebuild.
  53                 Note: this option is cumulative.  If not given at all, all
  54                 internal modules will be considered.
  55
  56     -nowrite    Do not write the header/source files, even if changed.
  57
  58     -rebuild    Rebuild all header and C source files, even if there
  59                 were no changes.
  60
  61     -reindex    Ignore previously assigned values (except for R records in
  62                 the config file) and renumber everything starting at 100.
  63
  64     -static     Make the load/unload functions static.
  65
  66     -unref      List all unreferenced function and reason codes on stderr;
  67                 implies -nowrite.
  68
  69     -help       Show this help text.
  70
  71     ...         Additional arguments are added to the file list to scan,
  72                 if '-internal' was NOT specified on the command line.
  73
  74 EOF
  75 }
  76
  77 while ( @ARGV ) {
  78     my $arg = $ARGV[0];
  79     last unless $arg =~ /-.*/;
  80     $arg = $1 if $arg =~ /-(-.*)/;
  81     if ( $arg eq "-conf" ) {
  82         $config = $ARGV[1];
  83         shift @ARGV;
  84     } elsif ( $arg eq "-debug" ) {
  85         $debug = 1;
  86         $unref = 1;
  87     } elsif ( $arg eq "-internal" ) {
  88         $internal = 1;
  89     } elsif ( $arg eq "-nowrite" ) {
  90         $nowrite = 1;
  91     } elsif ( $arg eq "-rebuild" ) {
  92         $rebuild = 1;
  93     } elsif ( $arg eq "-reindex" ) {
  94         $reindex = 1;
  95     } elsif ( $arg eq "-static" ) {
  96         $static = 1;
  97     } elsif ( $arg eq "-unref" ) {
  98         $unref = 1;
  99         $nowrite = 1;
 100     } elsif ( $arg eq "-module" ) {
 101         shift @ARGV;
 102         $modules{uc $ARGV[0]} = 1;
 103     } elsif ( $arg =~ /-*h(elp)?/ ) {
 104         &help();
 105         exit;
 106     } elsif ( $arg =~ /-.*/ ) {
 107         die "Unknown option $arg; use -h for help.\n";
 108     }
 109     shift @ARGV;
 110 }
 111
 112 my @source;
 113 if ( $internal ) {
 114     die "Cannot mix -internal and -static\n" if $static;
 115     die "Extra parameters given.\n" if @ARGV;
 116     @source = ( glob('crypto/*.c'), glob('crypto/*/*.c'),
 117                 glob('ssl/*.c'), glob('ssl/*/*.c'), glob('providers/*.c'),
 118                 glob('providers/*/*.c'), glob('providers/*/*/*.c') );
 119 } else {
 120     die "-module isn't useful without -internal\n" if scalar keys %modules > 0;
 121     @source = @ARGV;
 122 }
 123
 124 # Data parsed out of the config and state files.
 125 # We always map function-code values to zero, so items marked below with
 126 # an asterisk could eventually be removed.  TODO(4.0)
 127 my %hinc;       # lib -> header
 128 my %libinc;     # header -> lib
 129 my %cskip;      # error_file -> lib
 130 my %errorfile;  # lib -> error file name
 131 my %fmax;       # lib -> max assigned function code*
 132 my %rmax;       # lib -> max assigned reason code
 133 my %fassigned;  # lib -> colon-separated list of assigned function codes*
 134 my %rassigned;  # lib -> colon-separated list of assigned reason codes
 135 my %fnew;       # lib -> count of new function codes*
 136 my %rnew;       # lib -> count of new reason codes
 137 my %rextra;     # "extra" reason code -> lib
 138 my %rcodes;     # reason-name -> value
 139 my %ftrans;     # old name -> #define-friendly name (all caps)*
 140 my %fcodes;     # function-name -> value*
 141 my $statefile;  # state file with assigned reason and function codes
 142 my %strings;    # define -> text
 143
 144 # Read and parse the config file
 145 open(IN, "$config") || die "Can't open config file $config, $!,";
 146 while ( <IN> ) {
 147     next if /^#/ || /^$/;
 148     if ( /^L\s+(\S+)\s+(\S+)\s+(\S+)/ ) {
 149         my $lib = $1;
 150         my $hdr = $2;
 151         my $err = $3;
 152         $hinc{$lib}   = $hdr;
 153         $libinc{$hdr} = $lib;
 154         $cskip{$err}  = $lib;
 155         next if $err eq 'NONE';
 156         $errorfile{$lib} = $err;
 157         $fmax{$lib}      = 100;
 158         $rmax{$lib}      = 100;
 159         $fassigned{$lib} = ":";
 160         $rassigned{$lib} = ":";
 161         $fnew{$lib}      = 0;
 162         $rnew{$lib}      = 0;
 163     } elsif ( /^R\s+(\S+)\s+(\S+)/ ) {
 164         $rextra{$1} = $2;
 165         $rcodes{$1} = $2;
 166     } elsif ( /^S\s+(\S+)/ ) {
 167         $statefile = $1;
 168     } else {
 169         die "Illegal config line $_\n";
 170     }
 171 }
 172 close IN;
 173
 174 if ( ! $statefile ) {
 175     $statefile = $config;
 176     $statefile =~ s/.ec/.txt/;
 177 }
 178
 179 # The statefile has all the previous assignments.
 180 &phase("Reading state");
 181 my $skippedstate = 0;
 182 if ( ! $reindex && $statefile ) {
 183     open(STATE, "<$statefile") || die "Can't open $statefile, $!";
 184
 185     # Scan function and reason codes and store them: keep a note of the
 186     # maximum code used.
 187     while ( <STATE> ) {
 188         next if /^#/ || /^$/;
 189         my $name;
 190         my $code;
 191         if ( /^(.+):(\d+):\\$/ ) {
 192             $name = $1;
 193             $code = $2;
 194             my $next = <STATE>;
 195             $next =~ s/^\s*(.*)\s*$/$1/;
 196             die "Duplicate define $name" if exists $strings{$name};
 197             $strings{$name} = $next;
 198         } elsif ( /^(\S+):(\d+):(.*)$/ ) {
 199             $name = $1;
 200             $code = $2;
 201             die "Duplicate define $name" if exists $strings{$name};
 202             $strings{$name} = $3;
 203         } else {
 204             die "Bad line in $statefile:\n$_\n";
 205         }
 206         my $lib = $name;
 207         $lib =~ s/^((?:OSSL_|OPENSSL_)?[^_]{2,}).*$/$1/;
 208         $lib = "SSL" if $lib =~ /TLS/;
 209         if ( !defined $errorfile{$lib} ) {
 210             print "Skipping $_";
 211             $skippedstate++;
 212             next;
 213         } elsif ( $hinc{$lib} eq 'NONE' ) {
 214             # When the header is NONE but the err file is specified,
 215             # it signifies that the err file should be conserved but
 216             # remain untouched, and the same goes for the symbols in
 217             # the state file.
 218             next;
 219         }
 220         if ( $name =~ /^(?:OSSL_|OPENSSL_)?[A-Z0-9]{2,}_R_/ ) {
 221             die "$lib reason code $code collision at $name\n"
 222                 if $rassigned{$lib} =~ /:$code:/;
 223             $rassigned{$lib} .= "$code:";
 224             if ( !exists $rextra{$name} ) {
 225                 $rmax{$lib} = $code if $code > $rmax{$lib};
 226             }
 227             $rcodes{$name} = $code;
 228         } elsif ( $name =~ /^(?:OSSL_|OPENSSL_)?[A-Z0-9]{2,}_F_/ ) {
 229             $fassigned{$lib} .= "$code:";
 230             $fmax{$lib} = $code if $code > $fmax{$lib};
 231             $fcodes{$name} = $code;
 232         } else {
 233             die "Bad line in $statefile:\n$_\n";
 234         }
 235     }
 236     close(STATE);
 237
 238     if ( $debug ) {
 239         foreach my $lib ( sort keys %rmax ) {
 240             print STDERR "Reason codes for ${lib}:\n";
 241             if ( $rassigned{$lib} =~ m/^:(.*):$/ ) {
 242                 my @rassigned = sort { $a <=> $b } split( ":", $1 );
 243                 print STDERR "  ", join(' ', @rassigned), "\n";
 244             } else {
 245                 print STDERR "  --none--\n";
 246             }
 247         }
 248         print STDERR "\n";
 249         foreach my $lib ( sort keys %fmax ) {
 250             print STDERR "Function codes for ${lib}:\n";
 251             if ( $fassigned{$lib} =~ m/^:(.*):$/ ) {
 252                 my @fassigned = sort { $a <=> $b } split( ":", $1 );
 253                 print STDERR "  ", join(' ', @fassigned), "\n";
 254             } else {
 255                 print STDERR "  --none--\n";
 256             }
 257         }
 258     }
 259 }
 260
 261 # Scan each header file and make a list of error codes
 262 # and function names
 263 &phase("Scanning headers");
 264 while ( ( my $hdr, my $lib ) = each %libinc ) {
 265     next if $hdr eq "NONE";
 266     print STDERR " ." if $debug;
 267     my $line = "";
 268     my $def = "";
 269     my $linenr = 0;
 270     my $cpp = 0;
 271
 272     open(IN, "<$hdr") || die "Can't open $hdr, $!,";
 273     while ( <IN> ) {
 274         $linenr++;
 275
 276         if ( $line ne '' ) {
 277             $_    = $line . $_;
 278             $line = '';
 279         }
 280
 281         if ( /\\$/ ) {
 282             $line = $_;
 283             next;
 284         }
 285
 286         if ( /\/\*/ ) {
 287             if ( not /\*\// ) {    # multiline comment...
 288                 $line = $_;        # ... just accumulate
 289                 next;
 290             } else {
 291                 s/\/\*.*?\*\///gs;    # wipe it
 292             }
 293         }
 294
 295         if ( $cpp ) {
 296             $cpp++ if /^#\s*if/;
 297             $cpp-- if /^#\s*endif/;
 298             next;
 299         }
 300         $cpp = 1 if /^#.*ifdef.*cplusplus/;    # skip "C" declaration
 301
 302         next if /^\#/;    # skip preprocessor directives
 303
 304         s/{[^{}]*}//gs;     # ignore {} blocks
 305
 306         if ( /\{|\/\*/ ) {    # Add a so editor works...
 307             $line = $_;
 308         } else {
 309             $def .= $_;
 310         }
 311     }
 312
 313     # Delete any DECLARE_ macros
 314     my $defnr = 0;
 315     $def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
 316     foreach ( split /;/, $def ) {
 317         $defnr++;
 318         # The goal is to collect function names from function declarations.
 319
 320         s/^[\n\s]*//g;
 321         s/[\n\s]*$//g;
 322
 323         # Skip over recognized non-function declarations
 324         next if /typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/;
 325
 326         # Remove STACK_OF(foo)
 327         s/STACK_OF\(\w+\)/void/;
 328
 329         # Reduce argument lists to empty ()
 330         # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
 331         while ( /\(.*\)/s ) {
 332             s/\([^\(\)]+\)/\{\}/gs;
 333             s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;    #(*f{}) -> f
 334         }
 335
 336         # pretend as we didn't use curly braces: {} -> ()
 337         s/\{\}/\(\)/gs;
 338
 339         # Last token just before the first () is a function name.
 340         if ( /(\w+)\s*\(\).*/s ) {
 341             my $name = $1;
 342             $name =~ tr/[a-z]/[A-Z]/;
 343             $ftrans{$name} = $1;
 344         } elsif ( /[\(\)]/ and not(/=/) ) {
 345             print STDERR "Header $hdr: cannot parse: $_;\n";
 346         }
 347     }
 348
 349     next if $reindex;
 350
 351     if ( $lib eq "SSL" && $rmax{$lib} >= 1000 ) {
 352         print STDERR "SSL error codes 1000+ are reserved for alerts.\n";
 353         print STDERR "Any new alerts must be added to $config.\n";
 354         $errors++;
 355     }
 356     close IN;
 357 }
 358 print STDERR "\n" if $debug;
 359
 360 # Scan each C source file and look for function and reason codes
 361 # This is done by looking for strings that "look like" function or
 362 # reason codes: basically anything consisting of all upper case and
 363 # numerics which has _F_ or _R_ in it and which has the name of an
 364 # error library at the start.  This seems to work fine except for the
 365 # oddly named structure BIO_F_CTX which needs to be ignored.
 366 # If a code doesn't exist in list compiled from headers then mark it
 367 # with the value "X" as a place holder to give it a value later.
 368 # Store all function and reason codes found in %usedfuncs and %usedreasons
 369 # so all those unreferenced can be printed out.
 370 &phase("Scanning source");
 371 my %usedfuncs;
 372 my %usedreasons;
 373 foreach my $file ( @source ) {
 374     # Don't parse the error source file.
 375     next if exists $cskip{$file};
 376     open( IN, "<$file" ) || die "Can't open $file, $!,";
 377     my $func;
 378     my $linenr = 0;
 379     print STDERR "$file:\n" if $debug;
 380     while ( <IN> ) {
 381
 382         # skip obsoleted source files entirely!
 383         last if /^#error\s+obsolete/;
 384         $linenr++;
 385         if ( !/;$/ && /^\**([a-zA-Z_].*[\s*])?([A-Za-z_0-9]+)\(.*([),]|$)/ ) {
 386             /^([^()]*(\([^()]*\)[^()]*)*)\(/;
 387             $1 =~ /([A-Za-z_0-9]*)$/;
 388             $func = $1;
 389         }
 390
 391         if ( /(((?:OSSL_|OPENSSL_)?[A-Z0-9]{2,})_F_([A-Z0-9_]+))/ ) {
 392             next unless exists $errorfile{$2};
 393             next if $1 eq "BIO_F_BUFFER_CTX";
 394             $usedfuncs{$1} = 1;
 395             if ( !exists $fcodes{$1} ) {
 396                 print STDERR "  New function $1\n" if $debug;
 397                 $fcodes{$1} = "X";
 398                 $fnew{$2}++;
 399             }
 400             $ftrans{$3} = $func unless exists $ftrans{$3};
 401             print STDERR "  Function $1 = $fcodes{$1}\n"
 402               if $debug;
 403         }
 404         if ( /(((?:OSSL_|OPENSSL_)?[A-Z0-9]{2,})_R_[A-Z0-9_]+)/ ) {
 405             next unless exists $errorfile{$2};
 406             $usedreasons{$1} = 1;
 407             if ( !exists $rcodes{$1} ) {
 408                 print STDERR "  New reason $1\n" if $debug;
 409                 $rcodes{$1} = "X";
 410                 $rnew{$2}++;
 411             }
 412             print STDERR "  Reason $1 = $rcodes{$1}\n" if $debug;
 413         }
 414     }
 415     close IN;
 416 }
 417 print STDERR "\n" if $debug;
 418
 419 # Now process each library in turn.
 420 &phase("Writing files");
 421 my $newstate = 0;
 422 foreach my $lib ( keys %errorfile ) {
 423     next if ! $fnew{$lib} && ! $rnew{$lib} && ! $rebuild;
 424     next if scalar keys %modules > 0 && !$modules{$lib};
 425     next if $nowrite;
 426     next if $hinc{$lib} eq 'NONE';
 427     print STDERR "$lib: $fnew{$lib} new functions\n" if $fnew{$lib};
 428     print STDERR "$lib: $rnew{$lib} new reasons\n" if $rnew{$lib};
 429     $newstate = 1;
 430
 431     # If we get here then we have some new error codes so we
 432     # need to rebuild the header file and C file.
 433
 434     # Make a sorted list of error and reason codes for later use.
 435     my @function = sort grep( /^${lib}_/, keys %fcodes );
 436     my @reasons  = sort grep( /^${lib}_/, keys %rcodes );
 437
 438     # indent level for innermost preprocessor lines
 439     my $indent = " ";
 440
 441     # Rewrite the header file
 442
 443     my $hfile = $hinc{$lib};
 444     $hfile =~ s/.h$/err.h/ if $internal;
 445     open( OUT, ">$hfile" ) || die "Can't write to $hfile, $!,";
 446     print OUT <<"EOF";
 447 /*
 448  * Generated by util/mkerr.pl DO NOT EDIT
 449  * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
 450  *
 451  * Licensed under the Apache License 2.0 (the \"License\").  You may not use
 452  * this file except in compliance with the License.  You can obtain a copy
 453  * in the file LICENSE in the source distribution or at
 454  * https://www.openssl.org/source/license.html
 455  */
 456
 457 #ifndef OPENSSL_${lib}ERR_H
 458 # define OPENSSL_${lib}ERR_H
 459
 460 # include <openssl/opensslconf.h>
 461 # include <openssl/symhacks.h>
 462
 463
 464 EOF
 465     if ( $internal ) {
 466         # Declare the load function because the generate C file
 467         # includes "fooerr.h" not "foo.h"
 468         if ($lib ne "SSL" && $lib ne "ASYNC"
 469                 && (grep { $lib eq uc $_ } @disablables, @disablables_int)) {
 470             print OUT <<"EOF";
 471 # include <openssl/opensslconf.h>
 472
 473 # ifndef OPENSSL_NO_${lib}
 474
 475 EOF
 476             $indent = "  ";
 477         }
 478         print OUT <<"EOF";
 479 #${indent}ifdef  __cplusplus
 480 extern \"C\"
 481 #${indent}endif
 482 int ERR_load_${lib}_strings(void);
 483 EOF
 484     } else {
 485         print OUT <<"EOF";
 486 # define ${lib}err(f, r) ERR_${lib}_error(0, (r), OPENSSL_FILE, OPENSSL_LINE)
 487
 488 EOF
 489         if ( ! $static ) {
 490             print OUT <<"EOF";
 491
 492 # ifdef  __cplusplus
 493 extern \"C\" {
 494 # endif
 495 int ERR_load_${lib}_strings(void);
 496 void ERR_unload_${lib}_strings(void);
 497 void ERR_${lib}_error(int function, int reason, char *file, int line);
 498 # ifdef  __cplusplus
 499 }
 500 # endif
 501 EOF
 502         }
 503     }
 504
 505     print OUT "\n/*\n * $lib function codes.\n */\n";
 506     print OUT "# ifndef OPENSSL_NO_DEPRECATED_3_0\n";
 507     foreach my $i ( @function ) {
 508         my $z = 48 - length($i);
 509         $z = 0 if $z < 0;
 510         if ( $fcodes{$i} eq "X" ) {
 511             $fassigned{$lib} =~ m/^:([^:]*):/;
 512             my $findcode = $1;
 513             $findcode = $fmax{$lib} if !defined $findcode;
 514             while ( $fassigned{$lib} =~ m/:$findcode:/ ) {
 515                 $findcode++;
 516             }
 517             $fcodes{$i} = $findcode;
 518             $fassigned{$lib} .= "$findcode:";
 519             print STDERR "New Function code $i\n" if $debug;
 520         }
 521         printf OUT "#${indent} define $i%s 0\n", " " x $z;
 522     }
 523     print OUT "# endif\n";
 524
 525     print OUT "\n/*\n * $lib reason codes.\n */\n";
 526     foreach my $i ( @reasons ) {
 527         my $z = 48 - length($i);
 528         $z = 0 if $z < 0;
 529         if ( $rcodes{$i} eq "X" ) {
 530             $rassigned{$lib} =~ m/^:([^:]*):/;
 531             my $findcode = $1;
 532             $findcode = $rmax{$lib} if !defined $findcode;
 533             while ( $rassigned{$lib} =~ m/:$findcode:/ ) {
 534                 $findcode++;
 535             }
 536             $rcodes{$i} = $findcode;
 537             $rassigned{$lib} .= "$findcode:";
 538             print STDERR "New Reason code $i\n" if $debug;
 539         }
 540         printf OUT "#${indent}define $i%s $rcodes{$i}\n", " " x $z;
 541     }
 542     print OUT "\n";
 543
 544     while (length($indent) > 0) {
 545         $indent = substr $indent, 0, -1;
 546         print OUT "#${indent}endif\n";
 547     }
 548
 549     # Rewrite the C source file containing the error details.
 550
 551     # First, read any existing reason string definitions:
 552     my $cfile = $errorfile{$lib};
 553     my $pack_lib = $internal ? "ERR_LIB_${lib}" : "0";
 554     my $hincf = $hfile;
 555     $hincf =~ s|.*include/||;
 556     if ( $hincf =~ m|^openssl/| ) {
 557         $hincf = "<${hincf}>";
 558     } else {
 559         $hincf = "\"${hincf}\"";
 560     }
 561
 562     open( OUT, ">$cfile" )
 563         || die "Can't open $cfile for writing, $!, stopped";
 564
 565     my $const = $internal ? 'const ' : '';
 566
 567     print OUT <<"EOF";
 568 /*
 569  * Generated by util/mkerr.pl DO NOT EDIT
 570  * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
 571  *
 572  * Licensed under the Apache License 2.0 (the "License").  You may not use
 573  * this file except in compliance with the License.  You can obtain a copy
 574  * in the file LICENSE in the source distribution or at
 575  * https://www.openssl.org/source/license.html
 576  */
 577
 578 #include <openssl/err.h>
 579 #include $hincf
 580
 581 #ifndef OPENSSL_NO_ERR
 582
 583 static ${const}ERR_STRING_DATA ${lib}_str_reasons[] = {
 584 EOF
 585
 586     # Add each reason code.
 587     foreach my $i ( @reasons ) {
 588         my $rn;
 589         if ( exists $strings{$i} ) {
 590             $rn = $strings{$i};
 591             $rn = "" if $rn eq '*';
 592         } else {
 593             $i =~ /^${lib}_R_(\S+)$/;
 594             $rn = $1;
 595             $rn =~ tr/_[A-Z]/ [a-z]/;
 596             $strings{$i} = $rn;
 597         }
 598         my $short = "    {ERR_PACK($pack_lib, 0, $i), \"$rn\"},";
 599         if ( length($short) <= 80 ) {
 600             print OUT "$short\n";
 601         } else {
 602             print OUT "    {ERR_PACK($pack_lib, 0, $i),\n    \"$rn\"},\n";
 603         }
 604     }
 605     print OUT <<"EOF";
 606     {0, NULL}
 607 };
 608
 609 #endif
 610 EOF
 611     if ( $internal ) {
 612         print OUT <<"EOF";
 613
 614 int ERR_load_${lib}_strings(void)
 615 {
 616 #ifndef OPENSSL_NO_ERR
 617     if (ERR_reason_error_string(${lib}_str_reasons[0].error) == NULL)
 618         ERR_load_strings_const(${lib}_str_reasons);
 619 #endif
 620     return 1;
 621 }
 622 EOF
 623     } else {
 624         my $st = $static ? "static " : "";
 625         print OUT <<"EOF";
 626
 627 static int lib_code = 0;
 628 static int error_loaded = 0;
 629
 630 ${st}int ERR_load_${lib}_strings(void)
 631 {
 632     if (lib_code == 0)
 633         lib_code = ERR_get_next_error_library();
 634
 635     if (!error_loaded) {
 636 #ifndef OPENSSL_NO_ERR
 637         ERR_load_strings(lib_code, ${lib}_str_reasons);
 638 #endif
 639         error_loaded = 1;
 640     }
 641     return 1;
 642 }
 643
 644 ${st}void ERR_unload_${lib}_strings(void)
 645 {
 646     if (error_loaded) {
 647 #ifndef OPENSSL_NO_ERR
 648         ERR_unload_strings(lib_code, ${lib}_str_reasons);
 649 #endif
 650         error_loaded = 0;
 651     }
 652 }
 653
 654 ${st}void ERR_${lib}_error(int function, int reason, char *file, int line)
 655 {
 656     if (lib_code == 0)
 657         lib_code = ERR_get_next_error_library();
 658     ERR_raise(lib_code, reason);
 659     ERR_set_debug(file, line, NULL);
 660 }
 661 EOF
 662
 663     }
 664
 665     close OUT;
 666 }
 667
 668 &phase("Ending");
 669 # Make a list of unreferenced function and reason codes
 670 if ( $unref ) {
 671     my @funref;
 672     foreach ( keys %fcodes ) {
 673         push( @funref, $_ ) unless exists $usedfuncs{$_};
 674     }
 675     my @runref;
 676     foreach ( keys %rcodes ) {
 677         push( @runref, $_ ) unless exists $usedreasons{$_};
 678     }
 679     if ( @funref ) {
 680         print STDERR "The following function codes were not referenced:\n";
 681         foreach ( sort @funref ) {
 682             print STDERR "  $_\n";
 683         }
 684     }
 685     if ( @runref ) {
 686         print STDERR "The following reason codes were not referenced:\n";
 687         foreach ( sort @runref ) {
 688             print STDERR "  $_\n";
 689         }
 690     }
 691 }
 692
 693 die "Found $errors errors, quitting" if $errors;
 694
 695 # Update the state file
 696 if ( $newstate )  {
 697     open(OUT, ">$statefile.new")
 698         || die "Can't write $statefile.new, $!";
 699     print OUT <<"EOF";
 700 # Copyright 1999-$YEAR The OpenSSL Project Authors. All Rights Reserved.
 701 #
 702 # Licensed under the Apache License 2.0 (the "License").  You may not use
 703 # this file except in compliance with the License.  You can obtain a copy
 704 # in the file LICENSE in the source distribution or at
 705 # https://www.openssl.org/source/license.html
 706 EOF
 707     print OUT "\n# Function codes\n";
 708     foreach my $i ( sort keys %fcodes ) {
 709         my $short = "$i:$fcodes{$i}:";
 710         my $t = exists $strings{$i} ? $strings{$i} : "";
 711         $t = "\\\n\t" . $t if length($short) + length($t) > 80;
 712         print OUT "$short$t\n";
 713     }
 714     print OUT "\n#Reason codes\n";
 715     foreach my $i ( sort keys %rcodes ) {
 716         my $short = "$i:$rcodes{$i}:";
 717         my $t = exists $strings{$i} ? "$strings{$i}" : "";
 718         $t = "\\\n\t" . $t if length($short) + length($t) > 80;
 719         print OUT "$short$t\n" if !exists $rextra{$i};
 720     }
 721     close(OUT);
 722     if ( $skippedstate ) {
 723         print "Skipped state, leaving update in $statefile.new";
 724     } else {
 725         rename "$statefile", "$statefile.old"
 726             || die "Can't backup $statefile to $statefile.old, $!";
 727         rename "$statefile.new", "$statefile"
 728             || die "Can't rename $statefile to $statefile.new, $!";
 729     }
 730 }
 731
 732 exit;