1 #!/usr/local/bin/perl -w
3 my $config = "crypto/err/openssl.ec";
10 my $staticloader = "";
16 $config = shift @ARGV;
17 } elsif($arg eq "-debug") {
20 } elsif($arg eq "-rebuild") {
23 } elsif($arg eq "-recurse") {
26 } elsif($arg eq "-reindex") {
29 } elsif($arg eq "-nostatic") {
32 } elsif($arg eq "-staticloader") {
33 $staticloader = "static ";
35 } elsif($arg eq "-write") {
44 @source = (<crypto/*.c>, <crypto/*/*.c>, <ssl/*.c>);
49 # Read in the config file
51 open(IN, "<$config") || die "Can't open config file $config";
57 if(/^L\s+(\S+)\s+(\S+)\s+(\S+)/) {
68 } elsif (/^F\s+(\S+)/) {
69 # Add extra function with $1
70 } elsif (/^R\s+(\S+)\s+(\S+)/) {
78 # Scan each header file in turn and make a list of error codes
81 while (($hdr, $lib) = each %libinc)
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;
89 print STDERR "line: $linenr\r" if $debug;
91 last if(/BEGIN\s+ERROR\s+CODES/);
102 $cpp = 1 if /^#.*ifdef.*cplusplus/; # skip "C" declaration
104 $cpp = 0 if /^#.*endif/;
108 next if (/^#/); # skip preprocessor directives
110 s/\/\*.*?\*\///gs; # ignore comments
111 s/{[^{}]*}//gs; # ignore {} blocks
113 if (/{|\/\*/) { # Add a } so editor works...
120 print STDERR " \r" if $debug;
122 foreach (split /;/, $def) {
124 print STDERR "def: $defnr\r" if $debug;
128 next if(/typedef\W/);
129 if (/\(\*(\w*)\([^\)]+/) {
131 $name =~ tr/[a-z]/[A-Z]/;
133 } elsif (/\w+\W+(\w+)\W*\(\s*\)$/s){
136 } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
137 while (not /\(\)$/s) {
139 s/\([^\(\)]*\)\)$/\)/s;
144 $name =~ tr/[a-z]/[A-Z]/;
146 } elsif (/\(/ and not (/=/ or /DECLARE_STACK/)) {
147 print STDERR "Header $hdr: cannot parse: $_;\n";
151 print STDERR " \r" if $debug;
155 # Scan function and reason codes and store them: keep a note of the
159 if(/^#define\s+(\S+)\s+(\S+)/) {
162 next if $name =~ /^${lib}err/;
163 unless($name =~ /^${lib}_([RF])_(\w+)$/) {
164 print STDERR "Invalid error code $name\n";
168 $rcodes{$name} = $code;
169 if(!(exists $rextra{$name}) &&
170 ($code > $rmax{$lib}) ) {
174 if($code > $fmax{$lib}) {
177 $fcodes{$name} = $code;
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.
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";
203 if(/(([A-Z0-9]+)_F_([A-Z0-9_]+))/) {
204 next unless exists $csrc{$2};
205 next if($1 eq "BIO_F_BUFFER_CTX");
207 if(!exists $fcodes{$1}) {
211 $notrans{$1} = 1 unless exists $ftrans{$3};
213 if(/(([A-Z0-9]+)_R_[A-Z0-9_]+)/) {
214 next unless exists $csrc{$2};
216 if(!exists $rcodes{$1}) {
224 print STDERR "\n" if $debug;
226 # Now process each library in turn.
228 foreach $lib (keys %csrc)
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;
236 print STDERR "$lib:\t\t$fnew{$lib} New Functions,";
237 print STDERR " $rnew{$lib} New Reasons.\n";
238 next unless $dowrite;
241 # If we get here then we have some new error codes so we
242 # need to rebuild the header file and C file.
244 # Make a sorted list of error and reason codes for later use.
246 my @function = sort grep(/^${lib}_/,keys %fcodes);
247 my @reasons = sort grep(/^${lib}_/,keys %rcodes);
249 # Rewrite the header file
251 open(IN, "<$hfile") || die "Can't Open Header File $hfile\n";
253 # Copy across the old file
256 last if (/BEGIN ERROR CODES/);
260 open (OUT, ">$hfile") || die "Can't Open File $hfile for writing\n";
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.
271 ${staticloader}void ERR_load_${lib}_strings(void);
275 ${staticloader}void ERR_load_${lib}_strings(void);
276 ${staticloader}void ERR_unload_${lib}_strings(void);
277 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line);
278 #define ${lib}err(f,r) ERR_${lib}_error((f),(r),__FILE__,__LINE__)
282 /* Error codes for the $lib functions. */
284 /* Function codes. */
287 foreach $i (@function) {
288 $z=6-int(length($i)/8);
289 if($fcodes{$i} eq "X") {
290 $fcodes{$i} = ++$fmax{$lib};
291 print STDERR "New Function code $i\n" if $debug;
293 printf OUT "#define $i%s $fcodes{$i}\n","\t" x $z;
296 print OUT "\n/* Reason codes. */\n";
298 foreach $i (@reasons) {
299 $z=6-int(length($i)/8);
300 if($rcodes{$i} eq "X") {
301 $rcodes{$i} = ++$rmax{$lib};
302 print STDERR "New Reason code $i\n" if $debug;
304 printf OUT "#define $i%s $rcodes{$i}\n","\t" x $z;
315 # Rewrite the C source file containing the error details.
317 # First, read any existing reason string definitions:
318 my %err_reason_strings;
319 if (open(IN,"<$cfile")) {
321 if (/\b(${lib}_R_\w*)\b.*\"(.*)\"/) {
322 $err_reason_strings{$1} = $2;
330 $hfile =~ /([^\/]+)$/;
331 $hincf = "<openssl/$1>";
333 $hincf = "\"$hfile\"";
337 open (OUT,">$cfile") || die "Can't open $cfile for writing";
341 /* ====================================================================
342 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
344 * Redistribution and use in source and binary forms, with or without
345 * modification, are permitted provided that the following conditions
348 * 1. Redistributions of source code must retain the above copyright
349 * notice, this list of conditions and the following disclaimer.
351 * 2. Redistributions in binary form must reproduce the above copyright
352 * notice, this list of conditions and the following disclaimer in
353 * the documentation and/or other materials provided with the
356 * 3. All advertising materials mentioning features or use of this
357 * software must display the following acknowledgment:
358 * "This product includes software developed by the OpenSSL Project
359 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
361 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
362 * endorse or promote products derived from this software without
363 * prior written permission. For written permission, please contact
364 * openssl-core\@OpenSSL.org.
366 * 5. Products derived from this software may not be called "OpenSSL"
367 * nor may "OpenSSL" appear in their names without prior written
368 * permission of the OpenSSL Project.
370 * 6. Redistributions of any form whatsoever must retain the following
372 * "This product includes software developed by the OpenSSL Project
373 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
375 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
376 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
377 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
378 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
379 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
380 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
381 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
382 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
383 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
384 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
385 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
386 * OF THE POSSIBILITY OF SUCH DAMAGE.
387 * ====================================================================
389 * This product includes cryptographic software written by Eric Young
390 * (eay\@cryptsoft.com). This product includes software written by Tim
391 * Hudson (tjh\@cryptsoft.com).
395 /* NOTE: this file was auto generated by the mkerr.pl script: any changes
396 * made to it will be overwritten when the script next updates this file,
397 * only reason strings will be preserved.
401 #include <openssl/err.h>
404 /* BEGIN ERROR CODES */
405 #ifndef OPENSSL_NO_ERR
406 static ERR_STRING_DATA ${lib}_str_functs[]=
409 # Add each function code: if a function name is found then use it.
410 foreach $i (@function) {
412 $i =~ /^${lib}_F_(\S+)$/;
414 if(exists $ftrans{$fn}) {
417 print OUT "{ERR_PACK(0,$i,0),\t\"$fn\"},\n";
423 static ERR_STRING_DATA ${lib}_str_reasons[]=
426 # Add each reason code.
427 foreach $i (@reasons) {
430 if (exists $err_reason_strings{$i}) {
431 $rn = $err_reason_strings{$i};
433 $i =~ /^${lib}_R_(\S+)$/;
435 $rn =~ tr/_[A-Z]/ [a-z]/;
437 $nspc = 40 - length($i) unless length($i) > 40;
439 print OUT "{${i}${nspc},\"$rn\"},\n";
448 ${staticloader}void ERR_load_${lib}_strings(void)
455 #ifndef OPENSSL_NO_ERR
456 ERR_load_strings(ERR_LIB_${lib},${lib}_str_functs);
457 ERR_load_strings(ERR_LIB_${lib},${lib}_str_reasons);
470 #ifdef ${lib}_LIB_NAME
471 static ERR_STRING_DATA ${lib}_lib_name[]=
473 {0 ,${lib}_LIB_NAME},
479 static int ${lib}_lib_error_code=0;
480 static int ${lib}_error_init=1;
482 ${staticloader}void ERR_load_${lib}_strings(void)
484 if (${lib}_lib_error_code == 0)
485 ${lib}_lib_error_code=ERR_get_next_error_library();
487 if (${lib}_error_init)
490 #ifndef OPENSSL_NO_ERR
491 ERR_load_strings(${lib}_lib_error_code,${lib}_str_functs);
492 ERR_load_strings(${lib}_lib_error_code,${lib}_str_reasons);
495 #ifdef ${lib}_LIB_NAME
496 ${lib}_lib_name->error = ERR_PACK(${lib}_lib_error_code,0,0);
497 ERR_load_strings(0,${lib}_lib_name);
502 ${staticloader}void ERR_unload_${lib}_strings(void)
504 if (${lib}_error_init == 0)
506 #ifndef OPENSSL_NO_ERR
507 ERR_unload_strings(${lib}_lib_error_code,${lib}_str_functs);
508 ERR_unload_strings(${lib}_lib_error_code,${lib}_str_reasons);
511 #ifdef ${lib}_LIB_NAME
512 ERR_unload_strings(0,${lib}_lib_name);
518 ${staticloader}void ERR_${lib}_error(int function, int reason, char *file, int line)
520 if (${lib}_lib_error_code == 0)
521 ${lib}_lib_error_code=ERR_get_next_error_library();
522 ERR_PUT_error(${lib}_lib_error_code,function,reason,file,line);
529 undef %err_reason_strings;
532 if($debug && defined(%notrans)) {
533 print STDERR "The following function codes were not translated:\n";
534 foreach(sort keys %notrans)
540 # Make a list of unreferenced function and reason codes
542 foreach (keys %fcodes) {
543 push (@funref, $_) unless exists $ufcodes{$_};
546 foreach (keys %rcodes) {
547 push (@runref, $_) unless exists $urcodes{$_};
550 if($debug && defined(@funref) ) {
551 print STDERR "The following function codes were not referenced:\n";
552 foreach(sort @funref)
558 if($debug && defined(@runref) ) {
559 print STDERR "The following reason codes were not referenced:\n";
560 foreach(sort @runref)