mkerr.pl 23.5 KB
Newer Older
1 2 3
#!/usr/local/bin/perl -w

my $config = "crypto/err/openssl.ec";
4
my $hprefix = "openssl/";
5
my $debug = 0;
D
Dr. Stephen Henson 已提交
6
my $unref = 0;
7
my $rebuild = 0;
8
my $static = 1;
9 10
my $recurse = 0;
my $reindex = 0;
11
my $dowrite = 0;
12
my $staticloader = "";
13

14 15 16
my $pack_errcode;
my $load_errcode;

B
Ben Laurie 已提交
17
my $errcount;
18
my $year = (localtime)[5] + 1900;
B
Ben Laurie 已提交
19

20 21 22 23 24
while (@ARGV) {
	my $arg = $ARGV[0];
	if($arg eq "-conf") {
		shift @ARGV;
		$config = shift @ARGV;
25 26 27
	} elsif($arg eq "-hprefix") {
		shift @ARGV;
		$hprefix = shift @ARGV;
28 29
	} elsif($arg eq "-debug") {
		$debug = 1;
D
Dr. Stephen Henson 已提交
30
		$unref = 1;
31 32 33 34 35 36 37 38 39 40
		shift @ARGV;
	} elsif($arg eq "-rebuild") {
		$rebuild = 1;
		shift @ARGV;
	} elsif($arg eq "-recurse") {
		$recurse = 1;
		shift @ARGV;
	} elsif($arg eq "-reindex") {
		$reindex = 1;
		shift @ARGV;
41 42 43
	} elsif($arg eq "-nostatic") {
		$static = 0;
		shift @ARGV;
44 45 46
	} elsif($arg eq "-staticloader") {
		$staticloader = "static ";
		shift @ARGV;
D
Dr. Stephen Henson 已提交
47 48 49
	} elsif($arg eq "-unref") {
		$unref = 1;
		shift @ARGV;
50 51
	} elsif($arg eq "-write") {
		$dowrite = 1;
52
		shift @ARGV;
D
Dr. Stephen Henson 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
	} elsif($arg eq "-help" || $arg eq "-h" || $arg eq "-?" || $arg eq "--help") {
		print STDERR <<"EOF";
mkerr.pl [options] ...

Options:

  -conf F       Use the config file F instead of the default one:
                  crypto/err/openssl.ec

  -hprefix P    Prepend the filenames in generated #include <header>
                statements with prefix P. Default: 'openssl/' (without
                the quotes, naturally)

  -debug        Turn on debugging verbose output on stderr.

  -rebuild      Rebuild all header and C source files, irrespective of the
                fact if any error or function codes have been added/removed.
                Default: only update files for libraries which saw change
                         (of course, this requires '-write' as well, or no
                          files will be touched!)

  -recurse      scan a preconfigured set of directories / files for error and
                function codes:
                  (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>, <apps/*.c>)
                When this option is NOT specified, the filelist is taken from
                the commandline instead. Here, wildcards may be embedded. (Be
                sure to escape those to prevent the shell from expanding them
                for you when you wish mkerr.pl to do so instead.)
                Default: take file list to scan from the command line.

  -reindex      Discard the numeric values previously assigned to the error
                and function codes as extracted from the scanned header files;
                instead renumber all of them starting from 100. (Note that
                the numbers assigned through 'R' records in the config file
                remain intact.)
                Default: keep previously assigned numbers. (You are warned
                         when collisions are detected.)

  -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);
                  void ERR_unload_<LIB>_strings(void);
                  void ERR_<LIB>_error(int f, int r, char *fn, int ln);
                  #define <LIB>err(f,r) ERR_<LIB>_error(f,r,__FILE__,__LINE__)
                while the code facilitates the use of these in an environment
                where the error support routines are dynamically loaded at 
                runtime.
                Default: 'static' code generation.

  -staticloader Prefix generated functions with the 'static' scope modifier.
                Default: don't write any scope modifier prefix.

D
Dr. Stephen Henson 已提交
106 107
  -unref        Print out unreferenced function and reason codes.

D
Dr. Stephen Henson 已提交
108 109 110 111 112 113 114 115 116 117 118 119
  -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.

  -help / -h / -? / --help            Show this help text.

  ...           Additional arguments are added to the file list to scan,
                assuming '-recurse' was NOT specified on the command line.

EOF
		exit 1;
120 121 122 123 124 125
	} else {
		last;
	}
}

if($recurse) {
126
	@source = ( <crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>, <ssl/*/*.c> )
127 128 129 130 131 132 133 134 135 136 137 138 139 140
} else {
	@source = @ARGV;
}

# Read in the config file

open(IN, "<$config") || die "Can't open config file $config";

# Parse config file

while(<IN>)
{
	if(/^L\s+(\S+)\s+(\S+)\s+(\S+)/) {
		$hinc{$1} = $2;
141
		$libinc{$2} = $1;
142 143 144
		$cskip{$3} = $1;
		if($3 ne "NONE") {
			$csrc{$1} = $3;
D
Dr. Stephen Henson 已提交
145 146
			$fmax{$1} = 100;
			$rmax{$1} = 100;
B
Bodo Möller 已提交
147 148
			$fassigned{$1} = ":";
			$rassigned{$1} = ":";
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
			$fnew{$1} = 0;
			$rnew{$1} = 0;
		}
	} elsif (/^F\s+(\S+)/) {
	# Add extra function with $1
	} elsif (/^R\s+(\S+)\s+(\S+)/) {
		$rextra{$1} = $2;
		$rcodes{$1} = $2;
	}
}

close IN;

# Scan each header file in turn and make a list of error codes
# and function names

165
while (($hdr, $lib) = each %libinc)
166 167 168
{
	next if($hdr eq "NONE");
	print STDERR "Scanning header file $hdr\n" if $debug; 
169 170 171 172 173 174 175 176 177 178 179 180
	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 = '';
		}
181

182 183 184 185
		if (/\\$/) {
		    $line = $_;
		    next;
		}
186

187 188 189 190 191 192 193 194 195
		if(/\/\*/) {
		    if (not /\*\//) {		# multiline comment...
			$line = $_;		# ... just accumulate
			next; 
		    } else {
			s/\/\*.*?\*\///gs;	# wipe it
		    }
		}

196
		if ($cpp) {
197 198
		    $cpp++ if /^#\s*if/;
		    $cpp-- if /^#\s*endif/;
199 200
		    next;
		}
201
		$cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
202

203
		next if (/^\#/);                      # skip preprocessor directives
204

205
		s/{[^{}]*}//gs;                      # ignore {} blocks
206

207 208 209 210 211
		if (/\{|\/\*/) { # Add a } so editor works...
		    $line = $_;
		} else {
		    $def .= $_;
		}
212 213 214
	    }
	}

215 216
	print STDERR "                                  \r" if $debug;
        $defnr = 0;
217 218
	# Delete any DECLARE_ macros
	$def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
219
	foreach (split /;/, $def) {
220 221 222
	    $defnr++;
	    print STDERR "def: $defnr\r" if $debug;

223 224
	    # The goal is to collect function names from function declarations.

225
	    s/^[\n\s]*//g;
226
	    s/[\n\s]*$//g;
227 228

	    # Skip over recognized non-function declarations
229
	    next if(/typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/);
230

231 232 233
	    # Remove STACK_OF(foo)
	    s/STACK_OF\(\w+\)/void/;

234 235
	    # Reduce argument lists to empty ()
	    # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
236 237 238 239
	    while(/\(.*\)/s) {
		s/\([^\(\)]+\)/\{\}/gs;
		s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;	#(*f{}) -> f
	    }
240 241 242 243 244
	    # pretend as we didn't use curly braces: {} -> ()
	    s/\{\}/\(\)/gs;

	    if (/(\w+)\s*\(\).*/s) {	# first token prior [first] () is
		my $name = $1;		# a function name!
245 246
		$name =~ tr/[a-z]/[A-Z]/;
		$ftrans{$name} = $1;
247
	    } elsif (/[\(\)]/ and not (/=/)) {
248 249 250 251
		print STDERR "Header $hdr: cannot parse: $_;\n";
	    }
	}

252 253
	print STDERR "                                  \r" if $debug;

254 255 256 257 258
	next if $reindex;

	# Scan function and reason codes and store them: keep a note of the
	# maximum code used.

259
	if ($gotfile) {
B
Bodo Möller 已提交
260
	  while(<IN>) {
M
Matt Caswell 已提交
261
		if(/^\#\s*define\s+(\S+)\s+(\S+)/) {
262 263
			$name = $1;
			$code = $2;
264
			next if $name =~ /^${lib}err/;
265 266 267 268 269 270
			unless($name =~ /^${lib}_([RF])_(\w+)$/) {
				print STDERR "Invalid error code $name\n";
				next;
			}
			if($1 eq "R") {
				$rcodes{$name} = $code;
B
Bodo Möller 已提交
271
				if ($rassigned{$lib} =~ /:$code:/) {
D
Dr. Stephen Henson 已提交
272
					print STDERR "!! ERROR: $lib reason code $code assigned twice (collision at $name)\n";
B
Ben Laurie 已提交
273
					++$errcount;
B
Bodo Möller 已提交
274 275
				}
				$rassigned{$lib} .= "$code:";
276 277 278 279 280
				if(!(exists $rextra{$name}) &&
					 ($code > $rmax{$lib}) ) {
					$rmax{$lib} = $code;
				}
			} else {
B
Bodo Möller 已提交
281
				if ($fassigned{$lib} =~ /:$code:/) {
D
Dr. Stephen Henson 已提交
282
					print STDERR "!! ERROR: $lib function code $code assigned twice (collision at $name)\n";
B
Ben Laurie 已提交
283
					++$errcount;
B
Bodo Möller 已提交
284 285
				}
				$fassigned{$lib} .= "$code:";
286 287 288 289 290 291
				if($code > $fmax{$lib}) {
					$fmax{$lib} = $code;
				}
				$fcodes{$name} = $code;
			}
		}
B
Bodo Möller 已提交
292
	  }
293
	}
294 295 296 297

	if ($debug) {
		if (defined($fmax{$lib})) {
			print STDERR "Max function code fmax" . "{" . "$lib" . "} = $fmax{$lib}\n";
B
Bodo Möller 已提交
298 299 300 301 302 303 304 305 306
			$fassigned{$lib} =~ m/^:(.*):$/;
			@fassigned = sort {$a <=> $b} split(":", $1);
			print STDERR "  @fassigned\n";
		}
		if (defined($rmax{$lib})) {
			print STDERR "Max reason code rmax" . "{" . "$lib" . "} = $rmax{$lib}\n";
			$rassigned{$lib} =~ m/^:(.*):$/;
			@rassigned = sort {$a <=> $b} split(":", $1);
			print STDERR "  @rassigned\n";
307 308 309
		}
	}

310 311 312 313
	if ($lib eq "SSL") {
		if ($rmax{$lib} >= 1000) {
			print STDERR "!! ERROR: SSL error codes 1000+ are reserved for alerts.\n";
			print STDERR "!!        Any new alerts must be added to $config.\n";
B
Ben Laurie 已提交
314
			++$errcount;
315 316 317
			print STDERR "\n";
		}
	}
318 319 320 321 322 323 324 325 326 327 328
	close IN;
}

# Scan each C source file and look for function and reason codes
# This is done by looking for strings that "look like" function or
# reason codes: basically anything consisting of all upper case and
# numerics which has _F_ or _R_ in it and which has the name of an
# error library at the start. This seems to work fine except for the
# 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.
329 330
# Store all function and reason codes found in %ufcodes and %urcodes
# so all those unreferenced can be printed out.
331 332 333 334 335


foreach $file (@source) {
	# Don't parse the error source file.
	next if exists $cskip{$file};
336
	print STDERR "File loaded: ".$file."\r" if $debug;
337
	open(IN, "<$file") || die "Can't open source file $file\n";
338 339
	my $func;
	my $linenr = 0;
340
	while(<IN>) {
D
Dr. Stephen Henson 已提交
341 342
		# skip obsoleted source files entirely!
		last if(/^#error\s+obsolete/);
343 344 345 346 347 348 349
		$linenr++;
		if (!/;$/ && /^\**([a-zA-Z_].*[\s*])?([A-Za-z_0-9]+)\(.*([),]|$)/)
			{
			/^([^()]*(\([^()]*\)[^()]*)*)\(/;
			$1 =~ /([A-Za-z_0-9]*)$/;
			$func = $1;
			}
D
Dr. Stephen Henson 已提交
350

351
		if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
352 353
			next unless exists $csrc{$2};
			next if($1 eq "BIO_F_BUFFER_CTX");
354
			$ufcodes{$1} = 1;
355 356 357 358
			if(!exists $fcodes{$1}) {
				$fcodes{$1} = "X";
				$fnew{$2}++;
			}
359 360 361 362 363
			$ftrans{$3} = $func unless exists $ftrans{$3};
            if (uc $func ne $3) {
                print STDERR "ERROR: mismatch $file:$linenr $func:$3\n";
                $errcount++;
            }
D
Dr. Stephen Henson 已提交
364
			print STDERR "Function: $1\t= $fcodes{$1} (lib: $2, name: $3)\n" if $debug; 
365 366 367
		}
		if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
			next unless exists $csrc{$2};
368
			$urcodes{$1} = 1;
369 370 371 372
			if(!exists $rcodes{$1}) {
				$rcodes{$1} = "X";
				$rnew{$2}++;
			}
D
Dr. Stephen Henson 已提交
373
			print STDERR "Reason: $1\t= $rcodes{$1} (lib: $2)\n" if $debug; 
374 375 376 377
		} 
	}
	close IN;
}
378
print STDERR "                                  \n" if $debug;
379 380 381 382 383 384 385 386 387 388 389 390

# Now process each library in turn.

foreach $lib (keys %csrc)
{
	my $hfile = $hinc{$lib};
	my $cfile = $csrc{$lib};
	if(!$fnew{$lib} && !$rnew{$lib}) {
		next unless $rebuild;
	} else {
		print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
		print STDERR " $rnew{$lib} New Reasons.\n";
391
		next unless $dowrite;
392 393 394 395 396 397 398 399 400 401 402 403
	}

	# If we get here then we have some new error codes so we
	# need to rebuild the header file and C file.

	# Make a sorted list of error and reason codes for later use.

	my @function = sort grep(/^${lib}_/,keys %fcodes);
	my @reasons = sort grep(/^${lib}_/,keys %rcodes);

	# Rewrite the header file

404 405 406
	if (open(IN, "<$hfile")) {
	    # Copy across the old file
	    while(<IN>) {
407 408
		push @out, $_;
		last if (/BEGIN ERROR CODES/);
409 410 411 412 413
	    }
	    close IN;
	} else {
	    push @out,
"/* ====================================================================\n",
414
" * Copyright (c) 2001-$year The OpenSSL Project.  All rights reserved.\n",
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
" *\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",
470 471 472 473
"#ifdef  __cplusplus\n",
"extern \"C\" {\n",
"#endif\n",
"\n",
474
"/* BEGIN ERROR CODES */\n";
475 476 477 478 479 480
	}
	open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";

	print OUT @out;
	undef @out;
	print OUT <<"EOF";
M
Matt Caswell 已提交
481 482
/*
 * The following lines are auto generated by the script mkerr.pl. Any changes
483 484
 * made after this point may be overwritten when the script is next run.
 */
485 486 487 488
EOF
	if($static) {
		print OUT <<"EOF";
${staticloader}void ERR_load_${lib}_strings(void);
489

490 491 492 493 494 495
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);
M
Matt Caswell 已提交
496
# define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
497

498 499 500
EOF
	}
	print OUT <<"EOF";
501 502 503 504 505 506
/* Error codes for the $lib functions. */

/* Function codes. */
EOF

	foreach $i (@function) {
M
Matt Caswell 已提交
507
		$z=48 - length($i);
508
		if($fcodes{$i} eq "X") {
B
Bodo Möller 已提交
509 510 511 512 513 514 515 516 517 518
			$fassigned{$lib} =~ m/^:([^:]*):/;
			$findcode = $1;
			if (!defined($findcode)) {
				$findcode = $fmax{$lib};
			}
			while ($fassigned{$lib} =~ m/:$findcode:/) {
				$findcode++;
			}
			$fcodes{$i} = $findcode;
			$fassigned{$lib} .= "$findcode:";
519 520
			print STDERR "New Function code $i\n" if $debug;
		}
M
Matt Caswell 已提交
521
		printf OUT "# define $i%s $fcodes{$i}\n"," " x $z;
522 523 524 525 526
	}

	print OUT "\n/* Reason codes. */\n";

	foreach $i (@reasons) {
M
Matt Caswell 已提交
527
		$z=48 - length($i);
528
		if($rcodes{$i} eq "X") {
B
Bodo Möller 已提交
529 530 531 532 533 534 535 536 537 538
			$rassigned{$lib} =~ m/^:([^:]*):/;
			$findcode = $1;
			if (!defined($findcode)) {
				$findcode = $rmax{$lib};
			}
			while ($rassigned{$lib} =~ m/:$findcode:/) {
				$findcode++;
			}
			$rcodes{$i} = $findcode;
			$rassigned{$lib} .= "$findcode:";
539 540
			print STDERR "New Reason code   $i\n" if $debug;
		}
M
Matt Caswell 已提交
541
		printf OUT "# define $i%s $rcodes{$i}\n"," " x $z;
542 543 544 545 546 547 548 549 550 551 552 553
	}
	print OUT <<"EOF";

#ifdef  __cplusplus
}
#endif
#endif
EOF
	close OUT;

	# Rewrite the C source file containing the error details.

554 555 556
	# First, read any existing reason string definitions:
	my %err_reason_strings;
	if (open(IN,"<$cfile")) {
557
		my $line = "";
558
		while (<IN>) {
559
			s|\R$||; # Better chomp
560 561 562 563 564 565 566 567 568 569 570 571
			$_ = $line . $_;
			$line = "";
			if (/{ERR_(FUNC|REASON)\(/) {
				if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
					$err_reason_strings{$1} = $2;
				} elsif (/\b${lib}_F_(\w*)\b.*\"(.*)\"/) {
					if (!exists $ftrans{$1} && ($1 ne $2)) {
						print STDERR "WARNING: Mismatched function string $2\n";
						$ftrans{$1} = $2;
					}
				} else {
					$line = $_;
572 573
				}
			}
574 575 576 577
		}
		close(IN);
	}

578

579 580 581
	my $hincf;
	if($static) {
		$hfile =~ /([^\/]+)$/;
582
		$hincf = "<${hprefix}$1>";
583 584 585 586
	} else {
		$hincf = "\"$hfile\"";
	}

587 588 589 590 591 592 593 594 595 596 597 598 599 600
	# 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}";
		}

601 602 603 604 605

	open (OUT,">$cfile") || die "Can't open $cfile for writing";

	print OUT <<"EOF";
/* ====================================================================
606
 * Copyright (c) 1999-$year The OpenSSL Project.  All rights reserved.
607 608 609 610 611 612
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
M
Matt Caswell 已提交
613
 *    notice, this list of conditions and the following disclaimer.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    openssl-core\@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay\@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh\@cryptsoft.com).
 *
 */

M
Matt Caswell 已提交
659 660
/*
 * NOTE: this file was auto generated by the mkerr.pl script: any changes
661 662
 * made to it will be overwritten when the script next updates this file,
 * only reason strings will be preserved.
663 664 665 666
 */

#include <stdio.h>
#include <openssl/err.h>
667
#include $hincf
668 669

/* BEGIN ERROR CODES */
670
#ifndef OPENSSL_NO_ERR
671

M
Matt Caswell 已提交
672 673
# define ERR_FUNC(func) ERR_PACK($pack_errcode,func,0)
# define ERR_REASON(reason) ERR_PACK($pack_errcode,0,reason)
674

M
Matt Caswell 已提交
675
static ERR_STRING_DATA ${lib}_str_functs[] = {
676 677 678 679 680 681 682 683 684
EOF
	# Add each function code: if a function name is found then use it.
	foreach $i (@function) {
		my $fn;
		$i =~ /^${lib}_F_(\S+)$/;
		$fn = $1;
		if(exists $ftrans{$fn}) {
			$fn = $ftrans{$fn};
		}
685
#		print OUT "{ERR_PACK($pack_errcode,$i,0),\t\"$fn\"},\n";
M
Matt Caswell 已提交
686 687 688 689 690
		if(length($i) + length($fn) > 58) {
			print OUT "    {ERR_FUNC($i),\n     \"$fn\"},\n";
		} else {
			print OUT "    {ERR_FUNC($i), \"$fn\"},\n";
		}
691 692
	}
	print OUT <<"EOF";
M
Matt Caswell 已提交
693 694
    {0, NULL}
};
695

M
Matt Caswell 已提交
696
static ERR_STRING_DATA ${lib}_str_reasons[] = {
697 698 699 700
EOF
	# Add each reason code.
	foreach $i (@reasons) {
		my $rn;
701
		my $rstr = "ERR_REASON($i)";
702 703 704 705 706 707 708
		if (exists $err_reason_strings{$i}) {
			$rn = $err_reason_strings{$i};
		} else {
			$i =~ /^${lib}_R_(\S+)$/;
			$rn = $1;
			$rn =~ tr/_[A-Z]/ [a-z]/;
		}
M
Matt Caswell 已提交
709 710 711 712 713
		if(length($i) + length($rn) > 56) {
			print OUT "    {${rstr},\n     \"$rn\"},\n";
		} else {
			print OUT "    {${rstr}, \"$rn\"},\n";
		}
714 715 716
	}
if($static) {
	print OUT <<"EOF";
M
Matt Caswell 已提交
717 718
    {0, NULL}
};
719 720 721

#endif

722
${staticloader}void ERR_load_${lib}_strings(void)
M
Matt Caswell 已提交
723
{
724
#ifndef OPENSSL_NO_ERR
725

M
Matt Caswell 已提交
726 727 728 729
    if (ERR_func_error_string(${lib}_str_functs[0].error) == NULL) {
        ERR_load_strings($load_errcode, ${lib}_str_functs);
        ERR_load_strings($load_errcode, ${lib}_str_reasons);
    }
730
#endif
M
Matt Caswell 已提交
731
}
732 733 734
EOF
} else {
	print OUT <<"EOF";
M
Matt Caswell 已提交
735 736
    {0, NULL}
};
737 738 739 740

#endif

#ifdef ${lib}_LIB_NAME
M
Matt Caswell 已提交
741 742 743 744
static ERR_STRING_DATA ${lib}_lib_name[] = {
    {0, ${lib}_LIB_NAME},
    {0, NULL}
};
745 746
#endif

M
Matt Caswell 已提交
747 748
static int ${lib}_lib_error_code = 0;
static int ${lib}_error_init = 1;
749

750
${staticloader}void ERR_load_${lib}_strings(void)
M
Matt Caswell 已提交
751 752 753
{
    if (${lib}_lib_error_code == 0)
        ${lib}_lib_error_code = ERR_get_next_error_library();
754

M
Matt Caswell 已提交
755 756
    if (${lib}_error_init) {
        ${lib}_error_init = 0;
757
#ifndef OPENSSL_NO_ERR
M
Matt Caswell 已提交
758 759
        ERR_load_strings(${lib}_lib_error_code, ${lib}_str_functs);
        ERR_load_strings(${lib}_lib_error_code, ${lib}_str_reasons);
760 761 762
#endif

#ifdef ${lib}_LIB_NAME
M
Matt Caswell 已提交
763 764
        ${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code, 0, 0);
        ERR_load_strings(0, ${lib}_lib_name);
765
#endif
M
Matt Caswell 已提交
766 767
    }
}
768

769
${staticloader}void ERR_unload_${lib}_strings(void)
M
Matt Caswell 已提交
770 771
{
    if (${lib}_error_init == 0) {
772
#ifndef OPENSSL_NO_ERR
M
Matt Caswell 已提交
773 774
        ERR_unload_strings(${lib}_lib_error_code, ${lib}_str_functs);
        ERR_unload_strings(${lib}_lib_error_code, ${lib}_str_reasons);
775 776 777
#endif

#ifdef ${lib}_LIB_NAME
M
Matt Caswell 已提交
778
        ERR_unload_strings(0, ${lib}_lib_name);
779
#endif
M
Matt Caswell 已提交
780 781 782
        ${lib}_error_init = 1;
    }
}
783 784

${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
M
Matt Caswell 已提交
785 786 787 788 789
{
    if (${lib}_lib_error_code == 0)
        ${lib}_lib_error_code = ERR_get_next_error_library();
    ERR_PUT_error(${lib}_lib_error_code, function, reason, file, line);
}
790 791 792 793 794
EOF

}

	close OUT;
795
	undef %err_reason_strings;
796 797
}

D
Dr. Stephen Henson 已提交
798
if($debug && %notrans) {
799
	print STDERR "The following function codes were not translated:\n";
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
	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{$_};
}

D
Dr. Stephen Henson 已提交
816
if($unref && @funref) {
817 818 819 820 821 822 823
	print STDERR "The following function codes were not referenced:\n";
	foreach(sort @funref)
	{
		print STDERR "$_\n";
	}
}

D
Dr. Stephen Henson 已提交
824
if($unref && @runref) {
825 826
	print STDERR "The following reason codes were not referenced:\n";
	foreach(sort @runref)
827 828 829 830
	{
		print STDERR "$_\n";
	}
}
B
Ben Laurie 已提交
831 832 833 834 835 836

if($errcount) {
	print STDERR "There were errors, failing...\n\n";
	exit $errcount;
}