2 # Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
4 # Licensed under the OpenSSL license (the "License"). You may not use
5 # this file except in compliance with the License. You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
12 my $config = "crypto/err/openssl.ec";
24 my $YEAR = $t[5] + 1900;
29 print STDERR "\n---\n$text\n" if $debug;
35 mkerr.pl [options] [files...]
39 -conf FILE Use the named config file FILE instead of the default.
41 -debug Verbose output debugging on stderr.
43 -internal Generate code that is to be built as part of OpenSSL itself.
44 Also scans internal list of files.
46 -module M Only useful with -internal!
47 Only write files for library module M. Whether files are
48 actually written or not depends on other options, such as
50 Note: this option is cumulative. If not given at all, all
51 internal modules will be considered.
53 -nowrite Do not write the header/source files, even if changed.
55 -rebuild Rebuild all header and C source files, even if there
58 -reindex Ignore previously assigned values (except for R records in
59 the config file) and renumber everything starting at 100.
61 -static Make the load/unload functions static.
63 -unref List all unreferenced function and reason codes on stderr;
66 -help Show this help text.
68 ... Additional arguments are added to the file list to scan,
69 if '-internal' was NOT specified on the command line.
76 last unless $arg =~ /-.*/;
77 $arg = $1 if $arg =~ /-(-.*)/;
78 if ( $arg eq "-conf" ) {
81 } elsif ( $arg eq "-debug" ) {
84 } elsif ( $arg eq "-internal" ) {
86 } elsif ( $arg eq "-nowrite" ) {
88 } elsif ( $arg eq "-rebuild" ) {
90 } elsif ( $arg eq "-reindex" ) {
92 } elsif ( $arg eq "-static" ) {
94 } elsif ( $arg eq "-unref" ) {
97 } elsif ( $arg eq "-module" ) {
99 $modules{uc $ARGV[0]} = 1;
100 } elsif ( $arg =~ /-*h(elp)?/ ) {
103 } elsif ( $arg =~ /-.*/ ) {
104 die "Unknown option $arg; use -h for help.\n";
111 die "Cannot mix -internal and -static\n" if $static;
112 die "Extra parameters given.\n" if @ARGV;
113 @source = ( glob('crypto/*.c'), glob('crypto/*/*.c'),
114 glob('ssl/*.c'), glob('ssl/*/*.c') );
116 die "-module isn't useful without -internal\n" if scalar keys %modules > 0;
120 # Data parsed out of the config and state files.
121 my %hinc; # lib -> header
122 my %libinc; # header -> lib
123 my %cskip; # error_file -> lib
124 my %errorfile; # lib -> error file name
125 my %fmax; # lib -> max assigned function code
126 my %rmax; # lib -> max assigned reason code
127 my %fassigned; # lib -> colon-separated list of assigned function codes
128 my %rassigned; # lib -> colon-separated list of assigned reason codes
129 my %fnew; # lib -> count of new function codes
130 my %rnew; # lib -> count of new reason codes
131 my %rextra; # "extra" reason code -> lib
132 my %rcodes; # reason-name -> value
133 my %ftrans; # old name -> #define-friendly name (all caps)
134 my %fcodes; # function-name -> value
135 my $statefile; # state file with assigned reason and function codes
136 my %strings; # define -> text
138 # Read and parse the config file
139 open(IN, "$config") || die "Can't open config file $config, $!,";
141 next if /^#/ || /^$/;
142 if ( /^L\s+(\S+)\s+(\S+)\s+(\S+)/ ) {
147 $libinc{$hdr} = $lib;
149 next if $err eq 'NONE';
150 $errorfile{$lib} = $err;
153 $fassigned{$lib} = ":";
154 $rassigned{$lib} = ":";
157 } elsif ( /^R\s+(\S+)\s+(\S+)/ ) {
160 } elsif ( /^S\s+(\S+)/ ) {
163 die "Illegal config line $_\n";
168 my $statefile_prolog = '';
169 if ( ! $statefile ) {
170 $statefile = $config;
171 $statefile =~ s/.ec/.txt/;
174 # The statefile has all the previous assignments.
175 &phase("Reading state");
176 my $skippedstate = 0;
177 if ( ! $reindex && $statefile ) {
178 open(STATE, "<$statefile") || die "Can't open $statefile, $!";
180 # Scan function and reason codes and store them: keep a note of the
184 $statefile_prolog .= $_ if $collecting && ( /^#/ || /^$/ );
185 next if /^#/ || /^$/;
188 if ( /^(.+):(\d+):\\$/ ) {
192 $next =~ s/^\s*(.*)\s*$/$1/;
193 die "Duplicate define $name" if exists $strings{$name};
194 $strings{$name} = $next;
195 } elsif ( /^(\S+):(\d+):(.*)$/ ) {
198 die "Duplicate define $name" if exists $strings{$name};
199 $strings{$name} = $3;
201 die "Bad line in $statefile:\n$_\n";
206 $lib = "SSL" if $lib =~ /TLS/;
207 if ( !defined $errorfile{$lib} ) {
212 if ( $name =~ /^[A-Z0-9]+_R_/ ) {
213 die "$lib reason code $code collision at $name\n"
214 if $rassigned{$lib} =~ /:$code:/;
215 $rassigned{$lib} .= "$code:";
216 if ( !exists $rextra{$name} ) {
217 $rmax{$lib} = $code if $code > $rmax{$lib};
219 $rcodes{$name} = $code;
220 } elsif ( $name =~ /^[A-Z0-9]+_F_/ ) {
221 die "$lib function code $code collision at $name\n"
222 if $fassigned{$lib} =~ /:$code:/;
223 $fassigned{$lib} .= "$code:";
224 $fmax{$lib} = $code if $code > $fmax{$lib};
225 $fcodes{$name} = $code;
227 die "Bad line in $statefile:\n$_\n";
233 foreach my $lib ( sort keys %rmax ) {
234 print STDERR "Reason codes for ${lib}:\n";
235 if ( $rassigned{$lib} =~ m/^:(.*):$/ ) {
236 my @rassigned = sort { $a <=> $b } split( ":", $1 );
237 print STDERR " ", join(' ', @rassigned), "\n";
239 print STDERR " --none--\n";
243 foreach my $lib ( sort keys %fmax ) {
244 print STDERR "Function codes for ${lib}:\n";
245 if ( $fassigned{$lib} =~ m/^:(.*):$/ ) {
246 my @fassigned = sort { $a <=> $b } split( ":", $1 );
247 print STDERR " ", join(' ', @fassigned), "\n";
249 print STDERR " --none--\n";
255 # Scan each header file and make a list of error codes
257 &phase("Scanning headers");
258 while ( ( my $hdr, my $lib ) = each %libinc ) {
259 next if $hdr eq "NONE";
260 print STDERR " ." if $debug;
266 open(IN, "<$hdr") || die "Can't open $hdr, $!,";
281 if ( not /\*\// ) { # multiline comment...
282 $line = $_; # ... just accumulate
285 s/\/\*.*?\*\///gs; # wipe it
291 $cpp-- if /^#\s*endif/;
294 $cpp = 1 if /^#.*ifdef.*cplusplus/; # skip "C" declaration
296 next if /^\#/; # skip preprocessor directives
298 s/{[^{}]*}//gs; # ignore {} blocks
300 if ( /\{|\/\*/ ) { # Add a so editor works...
307 # Delete any DECLARE_ macros
309 $def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
310 foreach ( split /;/, $def ) {
312 # The goal is to collect function names from function declarations.
317 # Skip over recognized non-function declarations
318 next if /typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/;
320 # Remove STACK_OF(foo)
321 s/STACK_OF\(\w+\)/void/;
323 # Reduce argument lists to empty ()
324 # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
325 while ( /\(.*\)/s ) {
326 s/\([^\(\)]+\)/\{\}/gs;
327 s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs; #(*f{}) -> f
330 # pretend as we didn't use curly braces: {} -> ()
333 # Last token just before the first () is a function name.
334 if ( /(\w+)\s*\(\).*/s ) {
336 $name =~ tr/[a-z]/[A-Z]/;
338 } elsif ( /[\(\)]/ and not(/=/) ) {
339 print STDERR "Header $hdr: cannot parse: $_;\n";
345 if ( $lib eq "SSL" && $rmax{$lib} >= 1000 ) {
346 print STDERR "SSL error codes 1000+ are reserved for alerts.\n";
347 print STDERR "Any new alerts must be added to $config.\n";
352 print STDERR "\n" if $debug;
354 # Scan each C source file and look for function and reason codes
355 # This is done by looking for strings that "look like" function or
356 # reason codes: basically anything consisting of all upper case and
357 # numerics which has _F_ or _R_ in it and which has the name of an
358 # error library at the start. This seems to work fine except for the
359 # oddly named structure BIO_F_CTX which needs to be ignored.
360 # If a code doesn't exist in list compiled from headers then mark it
361 # with the value "X" as a place holder to give it a value later.
362 # Store all function and reason codes found in %usedfuncs and %usedreasons
363 # so all those unreferenced can be printed out.
364 &phase("Scanning source");
367 foreach my $file ( @source ) {
368 # Don't parse the error source file.
369 next if exists $cskip{$file};
370 open( IN, "<$file" ) || die "Can't open $file, $!,";
373 print STDERR "$file:\n" if $debug;
376 # skip obsoleted source files entirely!
377 last if /^#error\s+obsolete/;
379 if ( !/;$/ && /^\**([a-zA-Z_].*[\s*])?([A-Za-z_0-9]+)\(.*([),]|$)/ ) {
380 /^([^()]*(\([^()]*\)[^()]*)*)\(/;
381 $1 =~ /([A-Za-z_0-9]*)$/;
385 if ( /(([A-Z0-9]+)_F_([A-Z0-9_]+))/ ) {
386 next unless exists $errorfile{$2};
387 next if $1 eq "BIO_F_BUFFER_CTX";
389 if ( !exists $fcodes{$1} ) {
390 print STDERR " New function $1\n" if $debug;
394 $ftrans{$3} = $func unless exists $ftrans{$3};
395 if ( uc($func) ne $3 ) {
396 print STDERR "ERROR: mismatch $file:$linenr $func:$3\n";
399 print STDERR " Function $1 = $fcodes{$1}\n"
402 if ( /(([A-Z0-9]+)_R_[A-Z0-9_]+)/ ) {
403 next unless exists $errorfile{$2};
404 $usedreasons{$1} = 1;
405 if ( !exists $rcodes{$1} ) {
406 print STDERR " New reason $1\n" if $debug;
410 print STDERR " Reason $1 = $rcodes{$1}\n" if $debug;
415 print STDERR "\n" if $debug;
417 # Now process each library in turn.
418 &phase("Writing files");
420 foreach my $lib ( keys %errorfile ) {
421 if ( ! $fnew{$lib} && ! $rnew{$lib} ) {
422 next unless $rebuild;
424 next if scalar keys %modules > 0 && !$modules{$lib};
426 print STDERR "$lib: $fnew{$lib} new functions\n" if $fnew{$lib};
427 print STDERR "$lib: $rnew{$lib} new reasons\n" if $rnew{$lib};
430 # If we get here then we have some new error codes so we
431 # need to rebuild the header file and C file.
433 # Make a sorted list of error and reason codes for later use.
434 my @function = sort grep( /^${lib}_/, keys %fcodes );
435 my @reasons = sort grep( /^${lib}_/, keys %rcodes );
437 # Rewrite the header file
439 my $hfile = $hinc{$lib};
440 $hfile =~ s/.h$/err.h/ if $internal;
441 open( OUT, ">$hfile" ) || die "Can't write to $hfile, $!,";
444 * Generated by util/mkerr.pl DO NOT EDIT
445 * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
447 * Licensed under the OpenSSL license (the \"License\"). You may not use
448 * this file except in compliance with the License. You can obtain a copy
449 * in the file LICENSE in the source distribution or at
450 * https://www.openssl.org/source/license.html
453 #ifndef HEADER_${lib}ERR_H
454 # define HEADER_${lib}ERR_H
458 # Declare the load function because the generate C file
459 # includes "fooerr.h" not "foo.h"
464 int ERR_load_${lib}_strings(void);
471 # define ${lib}err(f, r) ERR_${lib}_error((f), (r), OPENSSL_FILE, OPENSSL_LINE)
480 int ERR_load_${lib}_strings(void);
481 void ERR_unload_${lib}_strings(void);
482 void ERR_${lib}_error(int function, int reason, char *file, int line);
490 print OUT "\n/*\n * $lib function codes.\n */\n";
491 foreach my $i ( @function ) {
492 my $z = 48 - length($i);
493 if ( $fcodes{$i} eq "X" ) {
494 $fassigned{$lib} =~ m/^:([^:]*):/;
496 $findcode = $fmax{$lib} if !defined $findcode;
497 while ( $fassigned{$lib} =~ m/:$findcode:/ ) {
500 $fcodes{$i} = $findcode;
501 $fassigned{$lib} .= "$findcode:";
502 print STDERR "New Function code $i\n" if $debug;
504 printf OUT "# define $i%s $fcodes{$i}\n", " " x $z;
507 print OUT "\n/*\n * $lib reason codes.\n */\n";
508 foreach my $i ( @reasons ) {
509 my $z = 48 - length($i);
510 if ( $rcodes{$i} eq "X" ) {
511 $rassigned{$lib} =~ m/^:([^:]*):/;
513 $findcode = $rmax{$lib} if !defined $findcode;
514 while ( $rassigned{$lib} =~ m/:$findcode:/ ) {
517 $rcodes{$i} = $findcode;
518 $rassigned{$lib} .= "$findcode:";
519 print STDERR "New Reason code $i\n" if $debug;
521 printf OUT "# define $i%s $rcodes{$i}\n", " " x $z;
525 print OUT "#endif\n";
527 # Rewrite the C source file containing the error details.
529 # First, read any existing reason string definitions:
530 my $cfile = $errorfile{$lib};
531 my $pack_lib = $internal ? "ERR_LIB_${lib}" : "0";
533 $hincf =~ s|.*include/||;
534 if ( $hincf =~ m|^openssl/| ) {
535 $hincf = "<${hincf}>";
537 $hincf = "\"${hincf}\"";
540 open( OUT, ">$cfile" )
541 || die "Can't open $cfile for writing, $!, stopped";
543 my $const = $internal ? 'const ' : '';
547 * Generated by util/mkerr.pl DO NOT EDIT
548 * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
550 * Licensed under the OpenSSL license (the "License"). You may not use
551 * this file except in compliance with the License. You can obtain a copy
552 * in the file LICENSE in the source distribution or at
553 * https://www.openssl.org/source/license.html
556 #include <openssl/err.h>
559 #ifndef OPENSSL_NO_ERR
561 static ${const}ERR_STRING_DATA ${lib}_str_functs[] = {
564 # Add each function code: if a function name is found then use it.
565 foreach my $i ( @function ) {
567 if ( exists $strings{$i} and $strings{$i} ne '' ) {
569 $fn = "" if $fn eq '*';
571 $i =~ /^${lib}_F_(\S+)$/;
573 $fn = $ftrans{$fn} if exists $ftrans{$fn};
576 my $short = " {ERR_PACK($pack_lib, $i, 0), \"$fn\"},";
577 if ( length($short) <= 80 ) {
578 print OUT "$short\n";
580 print OUT " {ERR_PACK($pack_lib, $i, 0),\n \"$fn\"},\n";
587 static ${const}ERR_STRING_DATA ${lib}_str_reasons[] = {
590 # Add each reason code.
591 foreach my $i ( @reasons ) {
593 if ( exists $strings{$i} ) {
595 $rn = "" if $rn eq '*';
597 $i =~ /^${lib}_R_(\S+)$/;
599 $rn =~ tr/_[A-Z]/ [a-z]/;
602 my $short = " {ERR_PACK($pack_lib, 0, $i), \"$rn\"},";
603 if ( length($short) <= 80 ) {
604 print OUT "$short\n";
606 print OUT " {ERR_PACK($pack_lib, 0, $i),\n \"$rn\"},\n";
618 int ERR_load_${lib}_strings(void)
620 #ifndef OPENSSL_NO_ERR
621 if (ERR_func_error_string(${lib}_str_functs[0].error) == NULL) {
622 ERR_load_strings_const(${lib}_str_functs);
623 ERR_load_strings_const(${lib}_str_reasons);
630 my $st = $static ? "static " : "";
633 static int lib_code = 0;
634 static int error_loaded = 0;
636 ${st}int ERR_load_${lib}_strings(void)
639 lib_code = ERR_get_next_error_library();
642 #ifndef OPENSSL_NO_ERR
643 ERR_load_strings(lib_code, ${lib}_str_functs);
644 ERR_load_strings(lib_code, ${lib}_str_reasons);
651 ${st}void ERR_unload_${lib}_strings(void)
654 #ifndef OPENSSL_NO_ERR
655 ERR_unload_strings(lib_code, ${lib}_str_functs);
656 ERR_unload_strings(lib_code, ${lib}_str_reasons);
662 ${st}void ERR_${lib}_error(int function, int reason, char *file, int line)
665 lib_code = ERR_get_next_error_library();
666 ERR_PUT_error(lib_code, function, reason, file, line);
676 # Make a list of unreferenced function and reason codes
679 foreach ( keys %fcodes ) {
680 push( @funref, $_ ) unless exists $usedfuncs{$_};
683 foreach ( keys %rcodes ) {
684 push( @runref, $_ ) unless exists $usedreasons{$_};
687 print STDERR "The following function codes were not referenced:\n";
688 foreach ( sort @funref ) {
689 print STDERR " $_\n";
693 print STDERR "The following reason codes were not referenced:\n";
694 foreach ( sort @runref ) {
695 print STDERR " $_\n";
700 die "Found $errors errors, quitting" if $errors;
702 # Update the state file
704 open(OUT, ">$statefile.new")
705 || die "Can't write $statefile.new, $!";
706 print OUT $statefile_prolog;
707 print OUT "# Function codes\n";
708 foreach my $i ( sort keys %fcodes ) {
709 my $short = "$i:$fcodes{$i}:";
710 my $t = exists $strings{$i} ? $strings{$i} : "";
711 $t = "\\\n\t" . $t if length($short) + length($t) > 80;
712 print OUT "$short$t\n";
714 print OUT "\n#Reason codes\n";
715 foreach my $i ( sort keys %rcodes ) {
716 my $short = "$i:$rcodes{$i}:";
717 my $t = exists $strings{$i} ? "$strings{$i}" : "";
718 $t = "\\\n\t" . $t if length($short) + length($t) > 80;
719 print OUT "$short$t\n" if !exists $rextra{$i};
722 if ( $skippedstate ) {
723 print "Skipped state, leaving update in $statefile.new";
725 rename "$statefile", "$statefile.old"
726 || die "Can't backup $statefile to $statefile.old, $!";
727 rename "$statefile.new", "$statefile"
728 || die "Can't rename $statefile to $statefile.new, $!";