util/mkerr.pl

   1 #!/usr/local/bin/perl -w
   2
   3 my $config = "crypto/err/openssl.ec";
   4 my $debug = 0;
   5 my $rebuild = 0;
   6 my $static = 1;
   7 my $recurse = 0;
   8 my $reindex = 0;
   9 my $dowrite = 0;
  10 my $staticloader = "";
  11
  12 while (@ARGV) {
  13         my $arg = $ARGV[0];
  14         if($arg eq "-conf") {
  15                 shift @ARGV;
  16                 $config = shift @ARGV;
  17         } elsif($arg eq "-debug") {
  18                 $debug = 1;
  19                 shift @ARGV;
  20         } elsif($arg eq "-rebuild") {
  21                 $rebuild = 1;
  22                 shift @ARGV;
  23         } elsif($arg eq "-recurse") {
  24                 $recurse = 1;
  25                 shift @ARGV;
  26         } elsif($arg eq "-reindex") {
  27                 $reindex = 1;
  28                 shift @ARGV;
  29         } elsif($arg eq "-nostatic") {
  30                 $static = 0;
  31                 shift @ARGV;
  32         } elsif($arg eq "-staticloader") {
  33                 $staticloader = "static ";
  34                 shift @ARGV;
  35         } elsif($arg eq "-write") {
  36                 $dowrite = 1;
  37                 shift @ARGV;
  38         } else {
  39                 last;
  40         }
  41 }
  42
  43 if($recurse) {
  44         @source = (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>);
  45 } else {
  46         @source = @ARGV;
  47 }
  48
  49 # Read in the config file
  50
  51 open(IN, "<$config") || die "Can't open config file $config";
  52
  53 # Parse config file
  54
  55 while(<IN>)
  56 {
  57         if(/^L\s+(\S+)\s+(\S+)\s+(\S+)/) {
  58                 $hinc{$1} = $2;
  59                 $libinc{$2} = $1;
  60                 $cskip{$3} = $1;
  61                 if($3 ne "NONE") {
  62                         $csrc{$1} = $3;
  63                         $fmax{$1} = 99;
  64                         $rmax{$1} = 99;
  65                         $fnew{$1} = 0;
  66                         $rnew{$1} = 0;
  67                 }
  68         } elsif (/^F\s+(\S+)/) {
  69         # Add extra function with $1
  70         } elsif (/^R\s+(\S+)\s+(\S+)/) {
  71                 $rextra{$1} = $2;
  72                 $rcodes{$1} = $2;
  73         }
  74 }
  75
  76 close IN;
  77
  78 # Scan each header file in turn and make a list of error codes
  79 # and function names
  80
  81 while (($hdr, $lib) = each %libinc)
  82 {
  83         next if($hdr eq "NONE");
  84         print STDERR "Scanning header file $hdr\n" if $debug;
  85         open(IN, "<$hdr") || die "Can't open Header file $hdr\n";
  86         my $line = "", $def= "", $linenr = 0;
  87         while(<IN>) {
  88             $linenr++;
  89             print STDERR "line: $linenr\r" if $debug;
  90
  91             last if(/BEGIN\s+ERROR\s+CODES/);
  92             if ($line ne '') {
  93                 $_ = $line . $_;
  94                 $line = '';
  95             }
  96
  97             if (/\\$/) {
  98                 $line = $_;
  99                 next;
 100             }
 101
 102             $cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
 103             if ($cpp) {
 104                 $cpp = 0 if /^#.*endif/;
 105                 next;
 106             }
 107
 108             next if (/^#/);                      # skip preprocessor directives
 109
 110             s/\/\*.*?\*\///gs;                   # ignore comments
 111             s/{[^{}]*}//gs;                      # ignore {} blocks
 112
 113             if (/{|\/\*/) { # Add a } so editor works...
 114                 $line = $_;
 115             } else {
 116                 $def .= $_;
 117             }
 118         }
 119
 120         print STDERR "                                  \r" if $debug;
 121         $defnr = 0;
 122         foreach (split /;/, $def) {
 123             $defnr++;
 124             print STDERR "def: $defnr\r" if $debug;
 125
 126             s/^[\n\s]*//g;
 127             s/[\n\s]*$//g;
 128             next if(/typedef\W/);
 129             if (/\(\*(\w*)\([^\)]+/) {
 130                 my $name = $1;
 131                 $name =~ tr/[a-z]/[A-Z]/;
 132                 $ftrans{$name} = $1;
 133             } elsif (/\w+\W+(\w+)\W*\(\s*\)$/s){
 134                 # K&R C
 135                 next ;
 136             } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
 137                 while (not /\(\)$/s) {
 138                     s/[^\(\)]*\)$/\)/s;
 139                     s/\([^\(\)]*\)\)$/\)/s;
 140                 }
 141                 s/\(void\)//;
 142                 /(\w+)\W*\(\)/s;
 143                 my $name = $1;
 144                 $name =~ tr/[a-z]/[A-Z]/;
 145                 $ftrans{$name} = $1;
 146             } elsif (/\(/ and not (/=/ or /DECLARE_STACK/)) {
 147                 print STDERR "Header $hdr: cannot parse: $_;\n";
 148             }
 149         }
 150
 151         print STDERR "                                  \r" if $debug;
 152
 153         next if $reindex;
 154
 155         # Scan function and reason codes and store them: keep a note of the
 156         # maximum code used.
 157
 158         while(<IN>) {
 159                 if(/^#define\s+(\S+)\s+(\S+)/) {
 160                         $name = $1;
 161                         $code = $2;
 162                         next if $name =~ /^${lib}err/;
 163                         unless($name =~ /^${lib}_([RF])_(\w+)$/) {
 164                                 print STDERR "Invalid error code $name\n";
 165                                 next;
 166                         }
 167                         if($1 eq "R") {
 168                                 $rcodes{$name} = $code;
 169                                 if(!(exists $rextra{$name}) &&
 170                                          ($code > $rmax{$lib}) ) {
 171                                         $rmax{$lib} = $code;
 172                                 }
 173                         } else {
 174                                 if($code > $fmax{$lib}) {
 175                                         $fmax{$lib} = $code;
 176                                 }
 177                                 $fcodes{$name} = $code;
 178                         }
 179                 }
 180         }
 181         close IN;
 182 }
 183
 184 # Scan each C source file and look for function and reason codes
 185 # This is done by looking for strings that "look like" function or
 186 # reason codes: basically anything consisting of all upper case and
 187 # numerics which has _F_ or _R_ in it and which has the name of an
 188 # error library at the start. This seems to work fine except for the
 189 # oddly named structure BIO_F_CTX which needs to be ignored.
 190 # If a code doesn't exist in list compiled from headers then mark it
 191 # with the value "X" as a place holder to give it a value later.
 192 # Store all function and reason codes found in %ufcodes and %urcodes
 193 # so all those unreferenced can be printed out.
 194
 195
 196 print STDERR "Files loaded: " if $debug;
 197 foreach $file (@source) {
 198         # Don't parse the error source file.
 199         next if exists $cskip{$file};
 200         print STDERR $file if $debug;
 201         open(IN, "<$file") || die "Can't open source file $file\n";
 202         while(<IN>) {
 203                 if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
 204                         next unless exists $csrc{$2};
 205                         next if($1 eq "BIO_F_BUFFER_CTX");
 206                         $ufcodes{$1} = 1;
 207                         if(!exists $fcodes{$1}) {
 208                                 $fcodes{$1} = "X";
 209                                 $fnew{$2}++;
 210                         }
 211                         $notrans{$1} = 1 unless exists $ftrans{$3};
 212                 }
 213                 if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
 214                         next unless exists $csrc{$2};
 215                         $urcodes{$1} = 1;
 216                         if(!exists $rcodes{$1}) {
 217                                 $rcodes{$1} = "X";
 218                                 $rnew{$2}++;
 219                         }
 220                 }
 221         }
 222         close IN;
 223 }
 224 print STDERR "\n" if $debug;
 225
 226 # Now process each library in turn.
 227
 228 foreach $lib (keys %csrc)
 229 {
 230         my $hfile = $hinc{$lib};
 231         my $cfile = $csrc{$lib};
 232         if(!$fnew{$lib} && !$rnew{$lib}) {
 233                 print STDERR "$lib:\t\tNo new error codes\n";
 234                 next unless $rebuild;
 235         } else {
 236                 print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
 237                 print STDERR " $rnew{$lib} New Reasons.\n";
 238                 next unless $dowrite;
 239         }
 240
 241         # If we get here then we have some new error codes so we
 242         # need to rebuild the header file and C file.
 243
 244         # Make a sorted list of error and reason codes for later use.
 245
 246         my @function = sort grep(/^${lib}_/,keys %fcodes);
 247         my @reasons = sort grep(/^${lib}_/,keys %rcodes);
 248
 249         # Rewrite the header file
 250
 251         open(IN, "<$hfile") || die "Can't Open Header File $hfile\n";
 252
 253         # Copy across the old file
 254         while(<IN>) {
 255                 push @out, $_;
 256                 last if (/BEGIN ERROR CODES/);
 257         }
 258         close IN;
 259
 260         open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";
 261
 262         print OUT @out;
 263         undef @out;
 264         print OUT <<"EOF";
 265 /* The following lines are auto generated by the script mkerr.pl. Any changes
 266  * made after this point may be overwritten when the script is next run.
 267  */
 268 EOF
 269         if($static) {
 270                 print OUT <<"EOF";
 271 ${staticloader}void ERR_load_${lib}_strings(void);
 272
 273 EOF
 274         } else {
 275                 print OUT <<"EOF";
 276 ${staticloader}void ERR_load_${lib}_strings(void);
 277 ${staticloader}void ERR_unload_${lib}_strings(void);
 278 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line);
 279 #define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
 280
 281 EOF
 282         }
 283         print OUT <<"EOF";
 284 /* Error codes for the $lib functions. */
 285
 286 /* Function codes. */
 287 EOF
 288
 289         foreach $i (@function) {
 290                 $z=6-int(length($i)/8);
 291                 if($fcodes{$i} eq "X") {
 292                         $fcodes{$i} = ++$fmax{$lib};
 293                         print STDERR "New Function code $i\n" if $debug;
 294                 }
 295                 printf OUT "#define $i%s $fcodes{$i}\n","\t" x $z;
 296         }
 297
 298         print OUT "\n/* Reason codes. */\n";
 299
 300         foreach $i (@reasons) {
 301                 $z=6-int(length($i)/8);
 302                 if($rcodes{$i} eq "X") {
 303                         $rcodes{$i} = ++$rmax{$lib};
 304                         print STDERR "New Reason code   $i\n" if $debug;
 305                 }
 306                 printf OUT "#define $i%s $rcodes{$i}\n","\t" x $z;
 307         }
 308         print OUT <<"EOF";
 309
 310 #ifdef  __cplusplus
 311 }
 312 #endif
 313 #endif
 314 EOF
 315         close OUT;
 316
 317         # Rewrite the C source file containing the error details.
 318
 319         # First, read any existing reason string definitions:
 320         my %err_reason_strings;
 321         if (open(IN,"<$cfile")) {
 322                 while (<IN>) {
 323                         if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
 324                                 $err_reason_strings{$1} = $2;
 325                         }
 326                 }
 327                 close(IN);
 328         }
 329
 330         my $hincf;
 331         if($static) {
 332                 $hfile =~ /([^\/]+)$/;
 333                 $hincf = "<openssl/$1>";
 334         } else {
 335                 $hincf = "\"$hfile\"";
 336         }
 337
 338
 339         open (OUT,">$cfile") || die "Can't open $cfile for writing";
 340
 341         print OUT <<"EOF";
 342 /* $cfile */
 343 /* ====================================================================
 344  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
 345  *
 346  * Redistribution and use in source and binary forms, with or without
 347  * modification, are permitted provided that the following conditions
 348  * are met:
 349  *
 350  * 1. Redistributions of source code must retain the above copyright
 351  *    notice, this list of conditions and the following disclaimer.
 352  *
 353  * 2. Redistributions in binary form must reproduce the above copyright
 354  *    notice, this list of conditions and the following disclaimer in
 355  *    the documentation and/or other materials provided with the
 356  *    distribution.
 357  *
 358  * 3. All advertising materials mentioning features or use of this
 359  *    software must display the following acknowledgment:
 360  *    "This product includes software developed by the OpenSSL Project
 361  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 362  *
 363  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 364  *    endorse or promote products derived from this software without
 365  *    prior written permission. For written permission, please contact
 366  *    openssl-core\@OpenSSL.org.
 367  *
 368  * 5. Products derived from this software may not be called "OpenSSL"
 369  *    nor may "OpenSSL" appear in their names without prior written
 370  *    permission of the OpenSSL Project.
 371  *
 372  * 6. Redistributions of any form whatsoever must retain the following
 373  *    acknowledgment:
 374  *    "This product includes software developed by the OpenSSL Project
 375  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 376  *
 377  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 378  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 379  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 380  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 381  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 382  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 383  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 384  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 385  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 386  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 387  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 388  * OF THE POSSIBILITY OF SUCH DAMAGE.
 389  * ====================================================================
 390  *
 391  * This product includes cryptographic software written by Eric Young
 392  * (eay\@cryptsoft.com).  This product includes software written by Tim
 393  * Hudson (tjh\@cryptsoft.com).
 394  *
 395  */
 396
 397 /* NOTE: this file was auto generated by the mkerr.pl script: any changes
 398  * made to it will be overwritten when the script next updates this file,
 399  * only reason strings will be preserved.
 400  */
 401
 402 #include <stdio.h>
 403 #include <openssl/err.h>
 404 #include $hincf
 405
 406 /* BEGIN ERROR CODES */
 407 #ifndef OPENSSL_NO_ERR
 408 static ERR_STRING_DATA ${lib}_str_functs[]=
 409         {
 410 EOF
 411         # Add each function code: if a function name is found then use it.
 412         foreach $i (@function) {
 413                 my $fn;
 414                 $i =~ /^${lib}_F_(\S+)$/;
 415                 $fn = $1;
 416                 if(exists $ftrans{$fn}) {
 417                         $fn = $ftrans{$fn};
 418                 }
 419                 print OUT "{ERR_PACK(0,$i,0),\t\"$fn\"},\n";
 420         }
 421         print OUT <<"EOF";
 422 {0,NULL}
 423         };
 424
 425 static ERR_STRING_DATA ${lib}_str_reasons[]=
 426         {
 427 EOF
 428         # Add each reason code.
 429         foreach $i (@reasons) {
 430                 my $rn;
 431                 my $nspc = 0;
 432                 if (exists $err_reason_strings{$i}) {
 433                         $rn = $err_reason_strings{$i};
 434                 } else {
 435                         $i =~ /^${lib}_R_(\S+)$/;
 436                         $rn = $1;
 437                         $rn =~ tr/_[A-Z]/ [a-z]/;
 438                 }
 439                 $nspc = 40 - length($i) unless length($i) > 40;
 440                 $nspc = " " x $nspc;
 441                 print OUT "{${i}${nspc},\"$rn\"},\n";
 442         }
 443 if($static) {
 444         print OUT <<"EOF";
 445 {0,NULL}
 446         };
 447
 448 #endif
 449
 450 ${staticloader}void ERR_load_${lib}_strings(void)
 451         {
 452         static int init=1;
 453
 454         if (init)
 455                 {
 456                 init=0;
 457 #ifndef OPENSSL_NO_ERR
 458                 ERR_load_strings(ERR_LIB_${lib},${lib}_str_functs);
 459                 ERR_load_strings(ERR_LIB_${lib},${lib}_str_reasons);
 460 #endif
 461
 462                 }
 463         }
 464 EOF
 465 } else {
 466         print OUT <<"EOF";
 467 {0,NULL}
 468         };
 469
 470 #endif
 471
 472 #ifdef ${lib}_LIB_NAME
 473 static ERR_STRING_DATA ${lib}_lib_name[]=
 474         {
 475 {0      ,${lib}_LIB_NAME},
 476 {0,NULL}
 477         };
 478 #endif
 479
 480
 481 static int ${lib}_lib_error_code=0;
 482 static int ${lib}_error_init=1;
 483
 484 ${staticloader}void ERR_load_${lib}_strings(void)
 485         {
 486         if (${lib}_lib_error_code == 0)
 487                 ${lib}_lib_error_code=ERR_get_next_error_library();
 488
 489         if (${lib}_error_init)
 490                 {
 491                 ${lib}_error_init=0;
 492 #ifndef OPENSSL_NO_ERR
 493                 ERR_load_strings(${lib}_lib_error_code,${lib}_str_functs);
 494                 ERR_load_strings(${lib}_lib_error_code,${lib}_str_reasons);
 495 #endif
 496
 497 #ifdef ${lib}_LIB_NAME
 498                 ${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code,0,0);
 499                 ERR_load_strings(0,${lib}_lib_name);
 500 #endif
 501                 }
 502         }
 503
 504 ${staticloader}void ERR_unload_${lib}_strings(void)
 505         {
 506         if (${lib}_error_init == 0)
 507                 {
 508 #ifndef OPENSSL_NO_ERR
 509                 ERR_unload_strings(${lib}_lib_error_code,${lib}_str_functs);
 510                 ERR_unload_strings(${lib}_lib_error_code,${lib}_str_reasons);
 511 #endif
 512
 513 #ifdef ${lib}_LIB_NAME
 514                 ERR_unload_strings(0,${lib}_lib_name);
 515 #endif
 516                 ${lib}_error_init=1;
 517                 }
 518         }
 519
 520 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
 521         {
 522         if (${lib}_lib_error_code == 0)
 523                 ${lib}_lib_error_code=ERR_get_next_error_library();
 524         ERR_PUT_error(${lib}_lib_error_code,function,reason,file,line);
 525         }
 526 EOF
 527
 528 }
 529
 530         close OUT;
 531         undef %err_reason_strings;
 532 }
 533
 534 if($debug && defined(%notrans)) {
 535         print STDERR "The following function codes were not translated:\n";
 536         foreach(sort keys %notrans)
 537         {
 538                 print STDERR "$_\n";
 539         }
 540 }
 541
 542 # Make a list of unreferenced function and reason codes
 543
 544 foreach (keys %fcodes) {
 545         push (@funref, $_) unless exists $ufcodes{$_};
 546 }
 547
 548 foreach (keys %rcodes) {
 549         push (@runref, $_) unless exists $urcodes{$_};
 550 }
 551
 552 if($debug && defined(@funref) ) {
 553         print STDERR "The following function codes were not referenced:\n";
 554         foreach(sort @funref)
 555         {
 556                 print STDERR "$_\n";
 557         }
 558 }
 559
 560 if($debug && defined(@runref) ) {
 561         print STDERR "The following reason codes were not referenced:\n";
 562         foreach(sort @runref)
 563         {
 564                 print STDERR "$_\n";
 565         }
 566 }