util/mkerr.pl

   1 #!/usr/local/bin/perl -w
   2
   3 my $config = "crypto/err/openssl.ec";
   4 my $hprefix = "openssl/";
   5 my $debug = 0;
   6 my $rebuild = 0;
   7 my $static = 1;
   8 my $recurse = 0;
   9 my $reindex = 0;
  10 my $dowrite = 0;
  11 my $staticloader = "";
  12
  13 my $pack_errcode;
  14 my $load_errcode;
  15
  16 my $errcount;
  17 my $year = (localtime)[5] + 1900;
  18
  19 while (@ARGV) {
  20         my $arg = $ARGV[0];
  21         if($arg eq "-conf") {
  22                 shift @ARGV;
  23                 $config = shift @ARGV;
  24         } elsif($arg eq "-hprefix") {
  25                 shift @ARGV;
  26                 $hprefix = shift @ARGV;
  27         } elsif($arg eq "-debug") {
  28                 $debug = 1;
  29                 shift @ARGV;
  30         } elsif($arg eq "-rebuild") {
  31                 $rebuild = 1;
  32                 shift @ARGV;
  33         } elsif($arg eq "-recurse") {
  34                 $recurse = 1;
  35                 shift @ARGV;
  36         } elsif($arg eq "-reindex") {
  37                 $reindex = 1;
  38                 shift @ARGV;
  39         } elsif($arg eq "-nostatic") {
  40                 $static = 0;
  41                 shift @ARGV;
  42         } elsif($arg eq "-staticloader") {
  43                 $staticloader = "static ";
  44                 shift @ARGV;
  45         } elsif($arg eq "-write") {
  46                 $dowrite = 1;
  47                 shift @ARGV;
  48         } elsif($arg eq "-help" || $arg eq "-h" || $arg eq "-?" || $arg eq "--help") {
  49                 print STDERR <<"EOF";
  50 mkerr.pl [options] ...
  51
  52 Options:
  53
  54   -conf F       Use the config file F instead of the default one:
  55                   crypto/err/openssl.ec
  56
  57   -hprefix P    Prepend the filenames in generated #include <header>
  58                 statements with prefix P. Default: 'openssl/' (without
  59                 the quotes, naturally)
  60
  61   -debug        Turn on debugging verbose output on stderr.
  62
  63   -rebuild      Rebuild all header and C source files, irrespective of the
  64                 fact if any error or function codes have been added/removed.
  65                 Default: only update files for libraries which saw change
  66                          (of course, this requires '-write' as well, or no
  67                           files will be touched!)
  68
  69   -recurse      scan a preconfigured set of directories / files for error and
  70                 function codes:
  71                   (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>, <apps/*.c>)
  72                 When this option is NOT specified, the filelist is taken from
  73                 the commandline instead. Here, wildcards may be embedded. (Be
  74                 sure to escape those to prevent the shell from expanding them
  75                 for you when you wish mkerr.pl to do so instead.)
  76                 Default: take file list to scan from the command line.
  77
  78   -reindex      Discard the numeric values previously assigned to the error
  79                 and function codes as extracted from the scanned header files;
  80                 instead renumber all of them starting from 100. (Note that
  81                 the numbers assigned through 'R' records in the config file
  82                 remain intact.)
  83                 Default: keep previously assigned numbers. (You are warned
  84                          when collisions are detected.)
  85
  86   -nostatic     Generates a different source code, where these additional
  87                 functions are generated for each library specified in the
  88                 config file:
  89                   void ERR_load_<LIB>_strings(void);
  90                   void ERR_unload_<LIB>_strings(void);
  91                   void ERR_<LIB>_error(int f, int r, char *fn, int ln);
  92                   #define <LIB>err(f,r) ERR_<LIB>_error(f,r,__FILE__,__LINE__)
  93                 while the code facilitates the use of these in an environment
  94                 where the error support routines are dynamically loaded at
  95                 runtime.
  96                 Default: 'static' code generation.
  97
  98   -staticloader Prefix generated functions with the 'static' scope modifier.
  99                 Default: don't write any scope modifier prefix.
 100
 101   -write        Actually (over)write the generated code to the header and C
 102                 source files as assigned to each library through the config
 103                 file.
 104                 Default: don't write.
 105
 106   -help / -h / -? / --help            Show this help text.
 107
 108   ...           Additional arguments are added to the file list to scan,
 109                 assuming '-recurse' was NOT specified on the command line.
 110
 111 EOF
 112                 exit 1;
 113         } else {
 114                 last;
 115         }
 116 }
 117
 118 if($recurse) {
 119         @source = ( <crypto/*.c>, <crypto/*/*.c>, <ssl/*.c> )
 120 } else {
 121         @source = @ARGV;
 122 }
 123
 124 # Read in the config file
 125
 126 open(IN, "<$config") || die "Can't open config file $config";
 127
 128 # Parse config file
 129
 130 while(<IN>)
 131 {
 132         if(/^L\s+(\S+)\s+(\S+)\s+(\S+)/) {
 133                 $hinc{$1} = $2;
 134                 $libinc{$2} = $1;
 135                 $cskip{$3} = $1;
 136                 if($3 ne "NONE") {
 137                         $csrc{$1} = $3;
 138                         $fmax{$1} = 100;
 139                         $rmax{$1} = 100;
 140                         $fassigned{$1} = ":";
 141                         $rassigned{$1} = ":";
 142                         $fnew{$1} = 0;
 143                         $rnew{$1} = 0;
 144                 }
 145         } elsif (/^F\s+(\S+)/) {
 146         # Add extra function with $1
 147         } elsif (/^R\s+(\S+)\s+(\S+)/) {
 148                 $rextra{$1} = $2;
 149                 $rcodes{$1} = $2;
 150         }
 151 }
 152
 153 close IN;
 154
 155 # Scan each header file in turn and make a list of error codes
 156 # and function names
 157
 158 while (($hdr, $lib) = each %libinc)
 159 {
 160         next if($hdr eq "NONE");
 161         print STDERR "Scanning header file $hdr\n" if $debug;
 162         my $line = "", $def= "", $linenr = 0, $gotfile = 0;
 163         if (open(IN, "<$hdr")) {
 164             $gotfile = 1;
 165             while(<IN>) {
 166                 $linenr++;
 167                 print STDERR "line: $linenr\r" if $debug;
 168
 169                 last if(/BEGIN\s+ERROR\s+CODES/);
 170                 if ($line ne '') {
 171                     $_ = $line . $_;
 172                     $line = '';
 173                 }
 174
 175                 if (/\\$/) {
 176                     $line = $_;
 177                     next;
 178                 }
 179
 180                 if(/\/\*/) {
 181                     if (not /\*\//) {           # multiline comment...
 182                         $line = $_;             # ... just accumulate
 183                         next;
 184                     } else {
 185                         s/\/\*.*?\*\///gs;      # wipe it
 186                     }
 187                 }
 188
 189                 if ($cpp) {
 190                     $cpp++ if /^#\s*if/;
 191                     $cpp-- if /^#\s*endif/;
 192                     next;
 193                 }
 194                 $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
 195
 196                 next if (/^\#/);                      # skip preprocessor directives
 197
 198                 s/{[^{}]*}//gs;                      # ignore {} blocks
 199
 200                 if (/\{|\/\*/) { # Add a } so editor works...
 201                     $line = $_;
 202                 } else {
 203                     $def .= $_;
 204                 }
 205             }
 206         }
 207
 208         print STDERR "                                  \r" if $debug;
 209         $defnr = 0;
 210         # Delete any DECLARE_ macros
 211         $def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
 212         foreach (split /;/, $def) {
 213             $defnr++;
 214             print STDERR "def: $defnr\r" if $debug;
 215
 216             # The goal is to collect function names from function declarations.
 217
 218             s/^[\n\s]*//g;
 219             s/[\n\s]*$//g;
 220
 221             # Skip over recognized non-function declarations
 222             next if(/typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/);
 223
 224             # Remove STACK_OF(foo)
 225             s/STACK_OF\(\w+\)/void/;
 226
 227             # Reduce argument lists to empty ()
 228             # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
 229             while(/\(.*\)/s) {
 230                 s/\([^\(\)]+\)/\{\}/gs;
 231                 s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;    #(*f{}) -> f
 232             }
 233             # pretend as we didn't use curly braces: {} -> ()
 234             s/\{\}/\(\)/gs;
 235
 236             if (/(\w+)\s*\(\).*/s) {    # first token prior [first] () is
 237                 my $name = $1;          # a function name!
 238                 $name =~ tr/[a-z]/[A-Z]/;
 239                 $ftrans{$name} = $1;
 240             } elsif (/[\(\)]/ and not (/=/)) {
 241                 print STDERR "Header $hdr: cannot parse: $_;\n";
 242             }
 243         }
 244
 245         print STDERR "                                  \r" if $debug;
 246
 247         next if $reindex;
 248
 249         # Scan function and reason codes and store them: keep a note of the
 250         # maximum code used.
 251
 252         if ($gotfile) {
 253           while(<IN>) {
 254                 if(/^\#\s*define\s+(\S+)\s+(\S+)/) {
 255                         $name = $1;
 256                         $code = $2;
 257                         next if $name =~ /^${lib}err/;
 258                         unless($name =~ /^${lib}_([RF])_(\w+)$/) {
 259                                 print STDERR "Invalid error code $name\n";
 260                                 next;
 261                         }
 262                         if($1 eq "R") {
 263                                 $rcodes{$name} = $code;
 264                                 if ($rassigned{$lib} =~ /:$code:/) {
 265                                         print STDERR "!! ERROR: $lib reason code $code assigned twice (collision at $name)\n";
 266                                         ++$errcount;
 267                                 }
 268                                 $rassigned{$lib} .= "$code:";
 269                                 if(!(exists $rextra{$name}) &&
 270                                          ($code > $rmax{$lib}) ) {
 271                                         $rmax{$lib} = $code;
 272                                 }
 273                         } else {
 274                                 if ($fassigned{$lib} =~ /:$code:/) {
 275                                         print STDERR "!! ERROR: $lib function code $code assigned twice (collision at $name)\n";
 276                                         ++$errcount;
 277                                 }
 278                                 $fassigned{$lib} .= "$code:";
 279                                 if($code > $fmax{$lib}) {
 280                                         $fmax{$lib} = $code;
 281                                 }
 282                                 $fcodes{$name} = $code;
 283                         }
 284                 }
 285           }
 286         }
 287
 288         if ($debug) {
 289                 if (defined($fmax{$lib})) {
 290                         print STDERR "Max function code fmax" . "{" . "$lib" . "} = $fmax{$lib}\n";
 291                         $fassigned{$lib} =~ m/^:(.*):$/;
 292                         @fassigned = sort {$a <=> $b} split(":", $1);
 293                         print STDERR "  @fassigned\n";
 294                 }
 295                 if (defined($rmax{$lib})) {
 296                         print STDERR "Max reason code rmax" . "{" . "$lib" . "} = $rmax{$lib}\n";
 297                         $rassigned{$lib} =~ m/^:(.*):$/;
 298                         @rassigned = sort {$a <=> $b} split(":", $1);
 299                         print STDERR "  @rassigned\n";
 300                 }
 301         }
 302
 303         if ($lib eq "SSL") {
 304                 if ($rmax{$lib} >= 1000) {
 305                         print STDERR "!! ERROR: SSL error codes 1000+ are reserved for alerts.\n";
 306                         print STDERR "!!        Any new alerts must be added to $config.\n";
 307                         ++$errcount;
 308                         print STDERR "\n";
 309                 }
 310         }
 311         close IN;
 312 }
 313
 314 # Scan each C source file and look for function and reason codes
 315 # This is done by looking for strings that "look like" function or
 316 # reason codes: basically anything consisting of all upper case and
 317 # numerics which has _F_ or _R_ in it and which has the name of an
 318 # error library at the start. This seems to work fine except for the
 319 # oddly named structure BIO_F_CTX which needs to be ignored.
 320 # If a code doesn't exist in list compiled from headers then mark it
 321 # with the value "X" as a place holder to give it a value later.
 322 # Store all function and reason codes found in %ufcodes and %urcodes
 323 # so all those unreferenced can be printed out.
 324
 325
 326 foreach $file (@source) {
 327         # Don't parse the error source file.
 328         next if exists $cskip{$file};
 329         print STDERR "File loaded: ".$file."\r" if $debug;
 330         open(IN, "<$file") || die "Can't open source file $file\n";
 331         my $func;
 332         my $linenr = 0;
 333         while(<IN>) {
 334                 # skip obsoleted source files entirely!
 335                 last if(/^#error\s+obsolete/);
 336                 $linenr++;
 337                 if (!/;$/ && /^\**([a-zA-Z_].*[\s*])?([A-Za-z_0-9]+)\(.*([),]|$)/)
 338                         {
 339                         /^([^()]*(\([^()]*\)[^()]*)*)\(/;
 340                         $1 =~ /([A-Za-z_0-9]*)$/;
 341                         $func = $1;
 342                         }
 343
 344                 if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
 345                         next unless exists $csrc{$2};
 346                         next if($1 eq "BIO_F_BUFFER_CTX");
 347                         $ufcodes{$1} = 1;
 348                         if(!exists $fcodes{$1}) {
 349                                 $fcodes{$1} = "X";
 350                                 $fnew{$2}++;
 351                         }
 352                         $ftrans{$3} = $func unless exists $ftrans{$3};
 353             if (uc $func ne $3) {
 354                 print STDERR "ERROR: mismatch $file:$linenr $func:$3\n";
 355                 $errcount++;
 356             }
 357                         print STDERR "Function: $1\t= $fcodes{$1} (lib: $2, name: $3)\n" if $debug;
 358                 }
 359                 if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
 360                         next unless exists $csrc{$2};
 361                         $urcodes{$1} = 1;
 362                         if(!exists $rcodes{$1}) {
 363                                 $rcodes{$1} = "X";
 364                                 $rnew{$2}++;
 365                         }
 366                         print STDERR "Reason: $1\t= $rcodes{$1} (lib: $2)\n" if $debug;
 367                 }
 368         }
 369         close IN;
 370 }
 371 print STDERR "                                  \n" if $debug;
 372
 373 # Now process each library in turn.
 374
 375 foreach $lib (keys %csrc)
 376 {
 377         my $hfile = $hinc{$lib};
 378         my $cfile = $csrc{$lib};
 379         if(!$fnew{$lib} && !$rnew{$lib}) {
 380                 print STDERR "$lib:\t\tNo new error codes\n";
 381                 next unless $rebuild;
 382         } else {
 383                 print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
 384                 print STDERR " $rnew{$lib} New Reasons.\n";
 385                 next unless $dowrite;
 386         }
 387
 388         # If we get here then we have some new error codes so we
 389         # need to rebuild the header file and C file.
 390
 391         # Make a sorted list of error and reason codes for later use.
 392
 393         my @function = sort grep(/^${lib}_/,keys %fcodes);
 394         my @reasons = sort grep(/^${lib}_/,keys %rcodes);
 395
 396         # Rewrite the header file
 397
 398         if (open(IN, "<$hfile")) {
 399             # Copy across the old file
 400             while(<IN>) {
 401                 push @out, $_;
 402                 last if (/BEGIN ERROR CODES/);
 403             }
 404             close IN;
 405         } else {
 406             push @out,
 407 "/* ====================================================================\n",
 408 " * Copyright (c) 2001-$year The OpenSSL Project.  All rights reserved.\n",
 409 " *\n",
 410 " * Redistribution and use in source and binary forms, with or without\n",
 411 " * modification, are permitted provided that the following conditions\n",
 412 " * are met:\n",
 413 " *\n",
 414 " * 1. Redistributions of source code must retain the above copyright\n",
 415 " *    notice, this list of conditions and the following disclaimer. \n",
 416 " *\n",
 417 " * 2. Redistributions in binary form must reproduce the above copyright\n",
 418 " *    notice, this list of conditions and the following disclaimer in\n",
 419 " *    the documentation and/or other materials provided with the\n",
 420 " *    distribution.\n",
 421 " *\n",
 422 " * 3. All advertising materials mentioning features or use of this\n",
 423 " *    software must display the following acknowledgment:\n",
 424 " *    \"This product includes software developed by the OpenSSL Project\n",
 425 " *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)\"\n",
 426 " *\n",
 427 " * 4. The names \"OpenSSL Toolkit\" and \"OpenSSL Project\" must not be used to\n",
 428 " *    endorse or promote products derived from this software without\n",
 429 " *    prior written permission. For written permission, please contact\n",
 430 " *    openssl-core\@openssl.org.\n",
 431 " *\n",
 432 " * 5. Products derived from this software may not be called \"OpenSSL\"\n",
 433 " *    nor may \"OpenSSL\" appear in their names without prior written\n",
 434 " *    permission of the OpenSSL Project.\n",
 435 " *\n",
 436 " * 6. Redistributions of any form whatsoever must retain the following\n",
 437 " *    acknowledgment:\n",
 438 " *    \"This product includes software developed by the OpenSSL Project\n",
 439 " *    for use in the OpenSSL Toolkit (http://www.openssl.org/)\"\n",
 440 " *\n",
 441 " * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY\n",
 442 " * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n",
 443 " * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n",
 444 " * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR\n",
 445 " * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n",
 446 " * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\n",
 447 " * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n",
 448 " * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n",
 449 " * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\n",
 450 " * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n",
 451 " * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\n",
 452 " * OF THE POSSIBILITY OF SUCH DAMAGE.\n",
 453 " * ====================================================================\n",
 454 " *\n",
 455 " * This product includes cryptographic software written by Eric Young\n",
 456 " * (eay\@cryptsoft.com).  This product includes software written by Tim\n",
 457 " * Hudson (tjh\@cryptsoft.com).\n",
 458 " *\n",
 459 " */\n",
 460 "\n",
 461 "#ifndef HEADER_${lib}_ERR_H\n",
 462 "#define HEADER_${lib}_ERR_H\n",
 463 "\n",
 464 "#ifdef  __cplusplus\n",
 465 "extern \"C\" {\n",
 466 "#endif\n",
 467 "\n",
 468 "/* BEGIN ERROR CODES */\n";
 469         }
 470         open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";
 471
 472         print OUT @out;
 473         undef @out;
 474         print OUT <<"EOF";
 475 /*
 476  * The following lines are auto generated by the script mkerr.pl. Any changes
 477  * made after this point may be overwritten when the script is next run.
 478  */
 479 EOF
 480         if($static) {
 481                 print OUT <<"EOF";
 482 ${staticloader}void ERR_load_${lib}_strings(void);
 483
 484 EOF
 485         } else {
 486                 print OUT <<"EOF";
 487 ${staticloader}void ERR_load_${lib}_strings(void);
 488 ${staticloader}void ERR_unload_${lib}_strings(void);
 489 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line);
 490 # define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
 491
 492 EOF
 493         }
 494         print OUT <<"EOF";
 495 /* Error codes for the $lib functions. */
 496
 497 /* Function codes. */
 498 EOF
 499
 500         foreach $i (@function) {
 501                 $z=48 - length($i);
 502                 if($fcodes{$i} eq "X") {
 503                         $fassigned{$lib} =~ m/^:([^:]*):/;
 504                         $findcode = $1;
 505                         if (!defined($findcode)) {
 506                                 $findcode = $fmax{$lib};
 507                         }
 508                         while ($fassigned{$lib} =~ m/:$findcode:/) {
 509                                 $findcode++;
 510                         }
 511                         $fcodes{$i} = $findcode;
 512                         $fassigned{$lib} .= "$findcode:";
 513                         print STDERR "New Function code $i\n" if $debug;
 514                 }
 515                 printf OUT "# define $i%s $fcodes{$i}\n"," " x $z;
 516         }
 517
 518         print OUT "\n/* Reason codes. */\n";
 519
 520         foreach $i (@reasons) {
 521                 $z=48 - length($i);
 522                 if($rcodes{$i} eq "X") {
 523                         $rassigned{$lib} =~ m/^:([^:]*):/;
 524                         $findcode = $1;
 525                         if (!defined($findcode)) {
 526                                 $findcode = $rmax{$lib};
 527                         }
 528                         while ($rassigned{$lib} =~ m/:$findcode:/) {
 529                                 $findcode++;
 530                         }
 531                         $rcodes{$i} = $findcode;
 532                         $rassigned{$lib} .= "$findcode:";
 533                         print STDERR "New Reason code   $i\n" if $debug;
 534                 }
 535                 printf OUT "# define $i%s $rcodes{$i}\n"," " x $z;
 536         }
 537         print OUT <<"EOF";
 538
 539 #ifdef  __cplusplus
 540 }
 541 #endif
 542 #endif
 543 EOF
 544         close OUT;
 545
 546         # Rewrite the C source file containing the error details.
 547
 548         # First, read any existing reason string definitions:
 549         my %err_reason_strings;
 550         if (open(IN,"<$cfile")) {
 551                 my $line = "";
 552                 while (<IN>) {
 553                         chomp;
 554                         $_ = $line . $_;
 555                         $line = "";
 556                         if (/{ERR_(FUNC|REASON)\(/) {
 557                                 if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
 558                                         $err_reason_strings{$1} = $2;
 559                                 } elsif (/\b${lib}_F_(\w*)\b.*\"(.*)\"/) {
 560                                         if (!exists $ftrans{$1} && ($1 ne $2)) {
 561                                                 print STDERR "WARNING: Mismatched function string $2\n";
 562                                                 $ftrans{$1} = $2;
 563                                         }
 564                                 } else {
 565                                         $line = $_;
 566                                 }
 567                         }
 568                 }
 569                 close(IN);
 570         }
 571
 572
 573         my $hincf;
 574         if($static) {
 575                 $hfile =~ /([^\/]+)$/;
 576                 $hincf = "<${hprefix}$1>";
 577         } else {
 578                 $hincf = "\"$hfile\"";
 579         }
 580
 581         # If static we know the error code at compile time so use it
 582         # in error definitions.
 583
 584         if ($static)
 585                 {
 586                 $pack_errcode = "ERR_LIB_${lib}";
 587                 $load_errcode = "0";
 588                 }
 589         else
 590                 {
 591                 $pack_errcode = "0";
 592                 $load_errcode = "ERR_LIB_${lib}";
 593                 }
 594
 595
 596         open (OUT,">$cfile") || die "Can't open $cfile for writing";
 597
 598         print OUT <<"EOF";
 599 /* $cfile */
 600 /* ====================================================================
 601  * Copyright (c) 1999-$year The OpenSSL Project.  All rights reserved.
 602  *
 603  * Redistribution and use in source and binary forms, with or without
 604  * modification, are permitted provided that the following conditions
 605  * are met:
 606  *
 607  * 1. Redistributions of source code must retain the above copyright
 608  *    notice, this list of conditions and the following disclaimer.
 609  *
 610  * 2. Redistributions in binary form must reproduce the above copyright
 611  *    notice, this list of conditions and the following disclaimer in
 612  *    the documentation and/or other materials provided with the
 613  *    distribution.
 614  *
 615  * 3. All advertising materials mentioning features or use of this
 616  *    software must display the following acknowledgment:
 617  *    "This product includes software developed by the OpenSSL Project
 618  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 619  *
 620  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 621  *    endorse or promote products derived from this software without
 622  *    prior written permission. For written permission, please contact
 623  *    openssl-core\@OpenSSL.org.
 624  *
 625  * 5. Products derived from this software may not be called "OpenSSL"
 626  *    nor may "OpenSSL" appear in their names without prior written
 627  *    permission of the OpenSSL Project.
 628  *
 629  * 6. Redistributions of any form whatsoever must retain the following
 630  *    acknowledgment:
 631  *    "This product includes software developed by the OpenSSL Project
 632  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 633  *
 634  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 635  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 636  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 637  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 638  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 639  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 640  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 641  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 642  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 643  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 644  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 645  * OF THE POSSIBILITY OF SUCH DAMAGE.
 646  * ====================================================================
 647  *
 648  * This product includes cryptographic software written by Eric Young
 649  * (eay\@cryptsoft.com).  This product includes software written by Tim
 650  * Hudson (tjh\@cryptsoft.com).
 651  *
 652  */
 653
 654 /*
 655  * NOTE: this file was auto generated by the mkerr.pl script: any changes
 656  * made to it will be overwritten when the script next updates this file,
 657  * only reason strings will be preserved.
 658  */
 659
 660 #include <stdio.h>
 661 #include <openssl/err.h>
 662 #include $hincf
 663
 664 /* BEGIN ERROR CODES */
 665 #ifndef OPENSSL_NO_ERR
 666
 667 # define ERR_FUNC(func) ERR_PACK($pack_errcode,func,0)
 668 # define ERR_REASON(reason) ERR_PACK($pack_errcode,0,reason)
 669
 670 static ERR_STRING_DATA ${lib}_str_functs[] = {
 671 EOF
 672         # Add each function code: if a function name is found then use it.
 673         foreach $i (@function) {
 674                 my $fn;
 675                 $i =~ /^${lib}_F_(\S+)$/;
 676                 $fn = $1;
 677                 if(exists $ftrans{$fn}) {
 678                         $fn = $ftrans{$fn};
 679                 }
 680 #               print OUT "{ERR_PACK($pack_errcode,$i,0),\t\"$fn\"},\n";
 681                 if(length($i) + length($fn) > 58) {
 682                         print OUT "    {ERR_FUNC($i),\n     \"$fn\"},\n";
 683                 } else {
 684                         print OUT "    {ERR_FUNC($i), \"$fn\"},\n";
 685                 }
 686         }
 687         print OUT <<"EOF";
 688     {0, NULL}
 689 };
 690
 691 static ERR_STRING_DATA ${lib}_str_reasons[] = {
 692 EOF
 693         # Add each reason code.
 694         foreach $i (@reasons) {
 695                 my $rn;
 696                 my $rstr = "ERR_REASON($i)";
 697                 if (exists $err_reason_strings{$i}) {
 698                         $rn = $err_reason_strings{$i};
 699                 } else {
 700                         $i =~ /^${lib}_R_(\S+)$/;
 701                         $rn = $1;
 702                         $rn =~ tr/_[A-Z]/ [a-z]/;
 703                 }
 704                 if(length($i) + length($rn) > 56) {
 705                         print OUT "    {${rstr},\n     \"$rn\"},\n";
 706                 } else {
 707                         print OUT "    {${rstr}, \"$rn\"},\n";
 708                 }
 709         }
 710 if($static) {
 711         print OUT <<"EOF";
 712     {0, NULL}
 713 };
 714
 715 #endif
 716
 717 ${staticloader}void ERR_load_${lib}_strings(void)
 718 {
 719 #ifndef OPENSSL_NO_ERR
 720
 721     if (ERR_func_error_string(${lib}_str_functs[0].error) == NULL) {
 722         ERR_load_strings($load_errcode, ${lib}_str_functs);
 723         ERR_load_strings($load_errcode, ${lib}_str_reasons);
 724     }
 725 #endif
 726 }
 727 EOF
 728 } else {
 729         print OUT <<"EOF";
 730     {0, NULL}
 731 };
 732
 733 #endif
 734
 735 #ifdef ${lib}_LIB_NAME
 736 static ERR_STRING_DATA ${lib}_lib_name[] = {
 737     {0, ${lib}_LIB_NAME},
 738     {0, NULL}
 739 };
 740 #endif
 741
 742 static int ${lib}_lib_error_code = 0;
 743 static int ${lib}_error_init = 1;
 744
 745 ${staticloader}void ERR_load_${lib}_strings(void)
 746 {
 747     if (${lib}_lib_error_code == 0)
 748         ${lib}_lib_error_code = ERR_get_next_error_library();
 749
 750     if (${lib}_error_init) {
 751         ${lib}_error_init = 0;
 752 #ifndef OPENSSL_NO_ERR
 753         ERR_load_strings(${lib}_lib_error_code, ${lib}_str_functs);
 754         ERR_load_strings(${lib}_lib_error_code, ${lib}_str_reasons);
 755 #endif
 756
 757 #ifdef ${lib}_LIB_NAME
 758         ${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code, 0, 0);
 759         ERR_load_strings(0, ${lib}_lib_name);
 760 #endif
 761     }
 762 }
 763
 764 ${staticloader}void ERR_unload_${lib}_strings(void)
 765 {
 766     if (${lib}_error_init == 0) {
 767 #ifndef OPENSSL_NO_ERR
 768         ERR_unload_strings(${lib}_lib_error_code, ${lib}_str_functs);
 769         ERR_unload_strings(${lib}_lib_error_code, ${lib}_str_reasons);
 770 #endif
 771
 772 #ifdef ${lib}_LIB_NAME
 773         ERR_unload_strings(0, ${lib}_lib_name);
 774 #endif
 775         ${lib}_error_init = 1;
 776     }
 777 }
 778
 779 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
 780 {
 781     if (${lib}_lib_error_code == 0)
 782         ${lib}_lib_error_code = ERR_get_next_error_library();
 783     ERR_PUT_error(${lib}_lib_error_code, function, reason, file, line);
 784 }
 785 EOF
 786
 787 }
 788
 789         close OUT;
 790         undef %err_reason_strings;
 791 }
 792
 793 if($debug && %notrans) {
 794         print STDERR "The following function codes were not translated:\n";
 795         foreach(sort keys %notrans)
 796         {
 797                 print STDERR "$_\n";
 798         }
 799 }
 800
 801 # Make a list of unreferenced function and reason codes
 802
 803 foreach (keys %fcodes) {
 804         push (@funref, $_) unless exists $ufcodes{$_};
 805 }
 806
 807 foreach (keys %rcodes) {
 808         push (@runref, $_) unless exists $urcodes{$_};
 809 }
 810
 811 if($debug && @funref) {
 812         print STDERR "The following function codes were not referenced:\n";
 813         foreach(sort @funref)
 814         {
 815                 print STDERR "$_\n";
 816         }
 817 }
 818
 819 if($debug && @runref) {
 820         print STDERR "The following reason codes were not referenced:\n";
 821         foreach(sort @runref)
 822         {
 823                 print STDERR "$_\n";
 824         }
 825 }
 826
 827 if($errcount) {
 828         print STDERR "There were errors, failing...\n\n";
 829         exit $errcount;
 830 }
 831