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

my $config = "crypto/err/openssl.ec";
4
my $hprefix = "openssl/";
5 6
my $debug = 0;
my $rebuild = 0;
7
my $static = 1;
8 9
my $recurse = 0;
my $reindex = 0;
10
my $dowrite = 0;
11
my $staticloader = "";
12

13 14 15
my $pack_errcode;
my $load_errcode;

B
Ben Laurie 已提交
16 17
my $errcount;

18 19 20 21 22
while (@ARGV) {
	my $arg = $ARGV[0];
	if($arg eq "-conf") {
		shift @ARGV;
		$config = shift @ARGV;
23 24 25
	} elsif($arg eq "-hprefix") {
		shift @ARGV;
		$hprefix = shift @ARGV;
26 27 28 29 30 31 32 33 34 35 36 37
	} elsif($arg eq "-debug") {
		$debug = 1;
		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;
38 39 40
	} elsif($arg eq "-nostatic") {
		$static = 0;
		shift @ARGV;
41 42 43
	} elsif($arg eq "-staticloader") {
		$staticloader = "static ";
		shift @ARGV;
44 45
	} elsif($arg eq "-write") {
		$dowrite = 1;
46
		shift @ARGV;
D
Dr. Stephen Henson 已提交
47 48 49 50 51 52 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 106 107 108 109 110 111
	} 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.

  -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;
112 113 114 115 116 117
	} else {
		last;
	}
}

if($recurse) {
118
	@source = (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>);
119 120 121 122 123 124 125 126 127 128 129 130 131 132
} 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;
133
		$libinc{$2} = $1;
134 135 136
		$cskip{$3} = $1;
		if($3 ne "NONE") {
			$csrc{$1} = $3;
D
Dr. Stephen Henson 已提交
137 138
			$fmax{$1} = 100;
			$rmax{$1} = 100;
B
Bodo Möller 已提交
139 140
			$fassigned{$1} = ":";
			$rassigned{$1} = ":";
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
			$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

157
while (($hdr, $lib) = each %libinc)
158 159 160
{
	next if($hdr eq "NONE");
	print STDERR "Scanning header file $hdr\n" if $debug; 
161 162 163 164 165 166 167 168 169 170 171 172
	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 = '';
		}
173

174 175 176 177
		if (/\\$/) {
		    $line = $_;
		    next;
		}
178

179 180 181 182 183 184 185 186 187
		if(/\/\*/) {
		    if (not /\*\//) {		# multiline comment...
			$line = $_;		# ... just accumulate
			next; 
		    } else {
			s/\/\*.*?\*\///gs;	# wipe it
		    }
		}

188
		if ($cpp) {
189 190
		    $cpp++ if /^#\s*if/;
		    $cpp-- if /^#\s*endif/;
191 192
		    next;
		}
193
		$cpp = 1 if /^#.*ifdef.*cplusplus/;  # skip "C" declaration
194

195
		next if (/^\#/);                      # skip preprocessor directives
196

197
		s/{[^{}]*}//gs;                      # ignore {} blocks
198

199 200 201 202 203
		if (/\{|\/\*/) { # Add a } so editor works...
		    $line = $_;
		} else {
		    $def .= $_;
		}
204 205 206
	    }
	}

207 208
	print STDERR "                                  \r" if $debug;
        $defnr = 0;
209 210
	# Delete any DECLARE_ macros
	$def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
211
	foreach (split /;/, $def) {
212 213 214
	    $defnr++;
	    print STDERR "def: $defnr\r" if $debug;

215 216
	    # The goal is to collect function names from function declarations.

217
	    s/^[\n\s]*//g;
218
	    s/[\n\s]*$//g;
219 220

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

223 224 225
	    # Remove STACK_OF(foo)
	    s/STACK_OF\(\w+\)/void/;

226 227
	    # Reduce argument lists to empty ()
	    # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
228 229 230 231
	    while(/\(.*\)/s) {
		s/\([^\(\)]+\)/\{\}/gs;
		s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;	#(*f{}) -> f
	    }
232 233 234 235 236
	    # 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!
237 238
		$name =~ tr/[a-z]/[A-Z]/;
		$ftrans{$name} = $1;
239
	    } elsif (/[\(\)]/ and not (/=/)) {
240 241 242 243
		print STDERR "Header $hdr: cannot parse: $_;\n";
	    }
	}

244 245
	print STDERR "                                  \r" if $debug;

246 247 248 249 250
	next if $reindex;

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

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

	if ($debug) {
		if (defined($fmax{$lib})) {
			print STDERR "Max function code fmax" . "{" . "$lib" . "} = $fmax{$lib}\n";
B
Bodo Möller 已提交
290 291 292 293 294 295 296 297 298
			$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";
299 300 301
		}
	}

302 303 304 305
	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 已提交
306
			++$errcount;
307 308 309
			print STDERR "\n";
		}
	}
310 311 312 313 314 315 316 317 318 319 320
	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.
321 322
# Store all function and reason codes found in %ufcodes and %urcodes
# so all those unreferenced can be printed out.
323 324 325 326 327


foreach $file (@source) {
	# Don't parse the error source file.
	next if exists $cskip{$file};
328
	print STDERR "File loaded: ".$file."\r" if $debug;
329
	open(IN, "<$file") || die "Can't open source file $file\n";
330
	while(<IN>) {
D
Dr. Stephen Henson 已提交
331 332 333
		# skip obsoleted source files entirely!
		last if(/^#error\s+obsolete/);

334
		if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
335 336
			next unless exists $csrc{$2};
			next if($1 eq "BIO_F_BUFFER_CTX");
337
			$ufcodes{$1} = 1;
338 339 340 341
			if(!exists $fcodes{$1}) {
				$fcodes{$1} = "X";
				$fnew{$2}++;
			}
342
			$notrans{$1} = 1 unless exists $ftrans{$3};
D
Dr. Stephen Henson 已提交
343
			print STDERR "Function: $1\t= $fcodes{$1} (lib: $2, name: $3)\n" if $debug; 
344 345 346
		}
		if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
			next unless exists $csrc{$2};
347
			$urcodes{$1} = 1;
348 349 350 351
			if(!exists $rcodes{$1}) {
				$rcodes{$1} = "X";
				$rnew{$2}++;
			}
D
Dr. Stephen Henson 已提交
352
			print STDERR "Reason: $1\t= $rcodes{$1} (lib: $2)\n" if $debug; 
353 354 355 356
		} 
	}
	close IN;
}
357
print STDERR "                                  \n" if $debug;
358 359 360 361 362 363 364 365 366 367 368 369 370

# Now process each library in turn.

foreach $lib (keys %csrc)
{
	my $hfile = $hinc{$lib};
	my $cfile = $csrc{$lib};
	if(!$fnew{$lib} && !$rnew{$lib}) {
		print STDERR "$lib:\t\tNo new error codes\n";
		next unless $rebuild;
	} else {
		print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
		print STDERR " $rnew{$lib} New Reasons.\n";
371
		next unless $dowrite;
372 373 374 375 376 377 378 379 380 381 382 383
	}

	# 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

384 385 386
	if (open(IN, "<$hfile")) {
	    # Copy across the old file
	    while(<IN>) {
387 388
		push @out, $_;
		last if (/BEGIN ERROR CODES/);
389 390 391 392 393
	    }
	    close IN;
	} else {
	    push @out,
"/* ====================================================================\n",
D
Dr. Stephen Henson 已提交
394
" * Copyright (c) 2001-2010 The OpenSSL Project.  All rights reserved.\n",
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 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
" *\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",
450 451 452 453
"#ifdef  __cplusplus\n",
"extern \"C\" {\n",
"#endif\n",
"\n",
454
"/* BEGIN ERROR CODES */\n";
455 456 457 458 459 460 461 462 463
	}
	open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";

	print OUT @out;
	undef @out;
	print OUT <<"EOF";
/* The following lines are auto generated by the script mkerr.pl. Any changes
 * made after this point may be overwritten when the script is next run.
 */
464 465 466 467
EOF
	if($static) {
		print OUT <<"EOF";
${staticloader}void ERR_load_${lib}_strings(void);
468

469 470 471 472 473 474 475
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);
#define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
476

477 478 479
EOF
	}
	print OUT <<"EOF";
480 481 482 483 484 485 486 487
/* Error codes for the $lib functions. */

/* Function codes. */
EOF

	foreach $i (@function) {
		$z=6-int(length($i)/8);
		if($fcodes{$i} eq "X") {
B
Bodo Möller 已提交
488 489 490 491 492 493 494 495 496 497
			$fassigned{$lib} =~ m/^:([^:]*):/;
			$findcode = $1;
			if (!defined($findcode)) {
				$findcode = $fmax{$lib};
			}
			while ($fassigned{$lib} =~ m/:$findcode:/) {
				$findcode++;
			}
			$fcodes{$i} = $findcode;
			$fassigned{$lib} .= "$findcode:";
498 499 500 501 502 503 504 505 506 507
			print STDERR "New Function code $i\n" if $debug;
		}
		printf OUT "#define $i%s $fcodes{$i}\n","\t" x $z;
	}

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

	foreach $i (@reasons) {
		$z=6-int(length($i)/8);
		if($rcodes{$i} eq "X") {
B
Bodo Möller 已提交
508 509 510 511 512 513 514 515 516 517
			$rassigned{$lib} =~ m/^:([^:]*):/;
			$findcode = $1;
			if (!defined($findcode)) {
				$findcode = $rmax{$lib};
			}
			while ($rassigned{$lib} =~ m/:$findcode:/) {
				$findcode++;
			}
			$rcodes{$i} = $findcode;
			$rassigned{$lib} .= "$findcode:";
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
			print STDERR "New Reason code   $i\n" if $debug;
		}
		printf OUT "#define $i%s $rcodes{$i}\n","\t" x $z;
	}
	print OUT <<"EOF";

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

	# Rewrite the C source file containing the error details.

533 534 535 536 537 538 539
	# First, read any existing reason string definitions:
	my %err_reason_strings;
	if (open(IN,"<$cfile")) {
		while (<IN>) {
			if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
				$err_reason_strings{$1} = $2;
			}
540 541 542 543 544 545
			if (/\b${lib}_F_(\w*)\b.*\"(.*)\"/) {
				if (!exists $ftrans{$1} && ($1 ne $2)) {
					print STDERR "WARNING: Mismatched function string $2\n";
					$ftrans{$1} = $2;
				}
			}
546 547 548 549
		}
		close(IN);
	}

550

551 552 553
	my $hincf;
	if($static) {
		$hfile =~ /([^\/]+)$/;
554
		$hincf = "<${hprefix}$1>";
555 556 557 558
	} else {
		$hincf = "\"$hfile\"";
	}

559 560 561 562 563 564 565 566 567 568 569 570 571 572
	# 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}";
		}

573 574 575 576 577 578

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

	print OUT <<"EOF";
/* $cfile */
/* ====================================================================
D
Dr. Stephen Henson 已提交
579
 * Copyright (c) 1999-2010 The OpenSSL Project.  All rights reserved.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
 *
 * 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
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 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).
 *
 */

/* NOTE: this file was auto generated by the mkerr.pl script: any changes
633 634
 * made to it will be overwritten when the script next updates this file,
 * only reason strings will be preserved.
635 636 637 638
 */

#include <stdio.h>
#include <openssl/err.h>
639
#include $hincf
640 641

/* BEGIN ERROR CODES */
642
#ifndef OPENSSL_NO_ERR
643 644 645 646

#define ERR_FUNC(func) ERR_PACK($pack_errcode,func,0)
#define ERR_REASON(reason) ERR_PACK($pack_errcode,0,reason)

647 648 649 650 651 652 653 654 655 656 657
static ERR_STRING_DATA ${lib}_str_functs[]=
	{
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};
		}
658 659
#		print OUT "{ERR_PACK($pack_errcode,$i,0),\t\"$fn\"},\n";
		print OUT "{ERR_FUNC($i),\t\"$fn\"},\n";
660 661 662 663 664 665 666 667 668 669 670
	}
	print OUT <<"EOF";
{0,NULL}
	};

static ERR_STRING_DATA ${lib}_str_reasons[]=
	{
EOF
	# Add each reason code.
	foreach $i (@reasons) {
		my $rn;
671
		my $rstr = "ERR_REASON($i)";
672
		my $nspc = 0;
673 674 675 676 677 678 679
		if (exists $err_reason_strings{$i}) {
			$rn = $err_reason_strings{$i};
		} else {
			$i =~ /^${lib}_R_(\S+)$/;
			$rn = $1;
			$rn =~ tr/_[A-Z]/ [a-z]/;
		}
680
		$nspc = 40 - length($rstr) unless length($rstr) > 40;
681
		$nspc = " " x $nspc;
682
		print OUT "{${rstr}${nspc},\"$rn\"},\n";
683 684 685 686 687 688 689 690
	}
if($static) {
	print OUT <<"EOF";
{0,NULL}
	};

#endif

691
${staticloader}void ERR_load_${lib}_strings(void)
692
	{
693
#ifndef OPENSSL_NO_ERR
694

695
	if (ERR_func_error_string(${lib}_str_functs[0].error) == NULL)
696
		{
697 698
		ERR_load_strings($load_errcode,${lib}_str_functs);
		ERR_load_strings($load_errcode,${lib}_str_reasons);
699
		}
700
#endif
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
	}
EOF
} else {
	print OUT <<"EOF";
{0,NULL}
	};

#endif

#ifdef ${lib}_LIB_NAME
static ERR_STRING_DATA ${lib}_lib_name[]=
        {
{0	,${lib}_LIB_NAME},
{0,NULL}
	};
#endif


719 720
static int ${lib}_lib_error_code=0;
static int ${lib}_error_init=1;
721

722
${staticloader}void ERR_load_${lib}_strings(void)
723 724 725 726
	{
	if (${lib}_lib_error_code == 0)
		${lib}_lib_error_code=ERR_get_next_error_library();

727
	if (${lib}_error_init)
728
		{
729
		${lib}_error_init=0;
730
#ifndef OPENSSL_NO_ERR
731 732 733 734 735 736 737
		ERR_load_strings(${lib}_lib_error_code,${lib}_str_functs);
		ERR_load_strings(${lib}_lib_error_code,${lib}_str_reasons);
#endif

#ifdef ${lib}_LIB_NAME
		${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code,0,0);
		ERR_load_strings(0,${lib}_lib_name);
738
#endif
739 740 741
		}
	}

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
${staticloader}void ERR_unload_${lib}_strings(void)
	{
	if (${lib}_error_init == 0)
		{
#ifndef OPENSSL_NO_ERR
		ERR_unload_strings(${lib}_lib_error_code,${lib}_str_functs);
		ERR_unload_strings(${lib}_lib_error_code,${lib}_str_reasons);
#endif

#ifdef ${lib}_LIB_NAME
		ERR_unload_strings(0,${lib}_lib_name);
#endif
		${lib}_error_init=1;
		}
	}

${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
759 760 761 762 763 764 765 766 767 768
	{
	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);
	}
EOF

}

	close OUT;
769
	undef %err_reason_strings;
770 771
}

772
if($debug && defined(%notrans)) {
773
	print STDERR "The following function codes were not translated:\n";
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
	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{$_};
}

if($debug && defined(@funref) ) {
	print STDERR "The following function codes were not referenced:\n";
	foreach(sort @funref)
	{
		print STDERR "$_\n";
	}
}

if($debug && defined(@runref) ) {
	print STDERR "The following reason codes were not referenced:\n";
	foreach(sort @runref)
801 802 803 804
	{
		print STDERR "$_\n";
	}
}
B
Ben Laurie 已提交
805 806 807 808 809 810

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