123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753 |
- use strict;
- use warnings;
- use lib ".";
- use configdata;
- my $config = "crypto/err/openssl.ec";
- my $debug = 0;
- my $internal = 0;
- my $nowrite = 0;
- my $rebuild = 0;
- my $reindex = 0;
- my $static = 0;
- my $unref = 0;
- my %modules = ();
- my $errors = 0;
- my @t = localtime();
- my $YEAR = $t[5] + 1900;
- sub phase
- {
- my $text = uc(shift);
- print STDERR "\n---\n$text\n" if $debug;
- }
- sub help
- {
- print STDERR <<"EOF";
- mkerr.pl [options] [files...]
- Options:
- -conf FILE Use the named config file FILE instead of the default.
- -debug Verbose output debugging on stderr.
- -internal Generate code that is to be built as part of OpenSSL itself.
- Also scans internal list of files.
- -module M Only useful with -internal!
- Only write files for library module M. Whether files are
- actually written or not depends on other options, such as
- -rebuild.
- Note: this option is cumulative. If not given at all, all
- internal modules will be considered.
- -nowrite Do not write the header/source files, even if changed.
- -rebuild Rebuild all header and C source files, even if there
- were no changes.
- -reindex Ignore previously assigned values (except for R records in
- the config file) and renumber everything starting at 100.
- -static Make the load/unload functions static.
- -unref List all unreferenced function and reason codes on stderr;
- implies -nowrite.
- -help Show this help text.
- ... Additional arguments are added to the file list to scan,
- if '-internal' was NOT specified on the command line.
- EOF
- }
- while ( @ARGV ) {
- my $arg = $ARGV[0];
- last unless $arg =~ /-.*/;
- $arg = $1 if $arg =~ /-(-.*)/;
- if ( $arg eq "-conf" ) {
- $config = $ARGV[1];
- shift @ARGV;
- } elsif ( $arg eq "-debug" ) {
- $debug = 1;
- $unref = 1;
- } elsif ( $arg eq "-internal" ) {
- $internal = 1;
- } elsif ( $arg eq "-nowrite" ) {
- $nowrite = 1;
- } elsif ( $arg eq "-rebuild" ) {
- $rebuild = 1;
- } elsif ( $arg eq "-reindex" ) {
- $reindex = 1;
- } elsif ( $arg eq "-static" ) {
- $static = 1;
- } elsif ( $arg eq "-unref" ) {
- $unref = 1;
- $nowrite = 1;
- } elsif ( $arg eq "-module" ) {
- shift @ARGV;
- $modules{uc $ARGV[0]} = 1;
- } elsif ( $arg =~ /-*h(elp)?/ ) {
- &help();
- exit;
- } elsif ( $arg =~ /-.*/ ) {
- die "Unknown option $arg; use -h for help.\n";
- }
- shift @ARGV;
- }
- my @source;
- if ( $internal ) {
- die "Cannot mix -internal and -static\n" if $static;
- die "Extra parameters given.\n" if @ARGV;
- @source = ( glob('crypto/*.c'), glob('crypto/*/*.c'),
- glob('ssl/*.c'), glob('ssl/*/*.c') );
- } else {
- die "-module isn't useful without -internal\n" if scalar keys %modules > 0;
- @source = @ARGV;
- }
- my %hinc;
- my %libinc;
- my %cskip;
- my %errorfile;
- my %fmax;
- my %rmax;
- my %fassigned;
- my %rassigned;
- my %fnew;
- my %rnew;
- my %rextra;
- my %rcodes;
- my %ftrans;
- my %fcodes;
- my $statefile;
- my %strings;
- open(IN, "$config") || die "Can't open config file $config, $!,";
- while ( <IN> ) {
- next if /^
- if ( /^L\s+(\S+)\s+(\S+)\s+(\S+)/ ) {
- my $lib = $1;
- my $hdr = $2;
- my $err = $3;
- $hinc{$lib} = $hdr;
- $libinc{$hdr} = $lib;
- $cskip{$err} = $lib;
- next if $err eq 'NONE';
- $errorfile{$lib} = $err;
- $fmax{$lib} = 100;
- $rmax{$lib} = 100;
- $fassigned{$lib} = ":";
- $rassigned{$lib} = ":";
- $fnew{$lib} = 0;
- $rnew{$lib} = 0;
- } elsif ( /^R\s+(\S+)\s+(\S+)/ ) {
- $rextra{$1} = $2;
- $rcodes{$1} = $2;
- } elsif ( /^S\s+(\S+)/ ) {
- $statefile = $1;
- } else {
- die "Illegal config line $_\n";
- }
- }
- close IN;
- if ( ! $statefile ) {
- $statefile = $config;
- $statefile =~ s/.ec/.txt/;
- }
- &phase("Reading state");
- my $skippedstate = 0;
- if ( ! $reindex && $statefile ) {
- open(STATE, "<$statefile") || die "Can't open $statefile, $!";
-
-
- while ( <STATE> ) {
- next if /^
- my $name;
- my $code;
- if ( /^(.+):(\d+):\\$/ ) {
- $name = $1;
- $code = $2;
- my $next = <STATE>;
- $next =~ s/^\s*(.*)\s*$/$1/;
- die "Duplicate define $name" if exists $strings{$name};
- $strings{$name} = $next;
- } elsif ( /^(\S+):(\d+):(.*)$/ ) {
- $name = $1;
- $code = $2;
- die "Duplicate define $name" if exists $strings{$name};
- $strings{$name} = $3;
- } else {
- die "Bad line in $statefile:\n$_\n";
- }
- my $lib = $name;
- $lib =~ s/^((?:OSSL_|OPENSSL_)?[^_]{2,}).*$/$1/;
- $lib = "SSL" if $lib =~ /TLS/;
- if ( !defined $errorfile{$lib} ) {
- print "Skipping $_";
- $skippedstate++;
- next;
- }
- if ( $name =~ /^(?:OSSL_|OPENSSL_)?[A-Z0-9]{2,}_R_/ ) {
- die "$lib reason code $code collision at $name\n"
- if $rassigned{$lib} =~ /:$code:/;
- $rassigned{$lib} .= "$code:";
- if ( !exists $rextra{$name} ) {
- $rmax{$lib} = $code if $code > $rmax{$lib};
- }
- $rcodes{$name} = $code;
- } elsif ( $name =~ /^(?:OSSL_|OPENSSL_)?[A-Z0-9]{2,}_F_/ ) {
- die "$lib function code $code collision at $name\n"
- if $fassigned{$lib} =~ /:$code:/;
- $fassigned{$lib} .= "$code:";
- $fmax{$lib} = $code if $code > $fmax{$lib};
- $fcodes{$name} = $code;
- } else {
- die "Bad line in $statefile:\n$_\n";
- }
- }
- close(STATE);
- if ( $debug ) {
- foreach my $lib ( sort keys %rmax ) {
- print STDERR "Reason codes for ${lib}:\n";
- if ( $rassigned{$lib} =~ m/^:(.*):$/ ) {
- my @rassigned = sort { $a <=> $b } split( ":", $1 );
- print STDERR " ", join(' ', @rassigned), "\n";
- } else {
- print STDERR " --none--\n";
- }
- }
- print STDERR "\n";
- foreach my $lib ( sort keys %fmax ) {
- print STDERR "Function codes for ${lib}:\n";
- if ( $fassigned{$lib} =~ m/^:(.*):$/ ) {
- my @fassigned = sort { $a <=> $b } split( ":", $1 );
- print STDERR " ", join(' ', @fassigned), "\n";
- } else {
- print STDERR " --none--\n";
- }
- }
- }
- }
- &phase("Scanning headers");
- while ( ( my $hdr, my $lib ) = each %libinc ) {
- next if $hdr eq "NONE";
- print STDERR " ." if $debug;
- my $line = "";
- my $def = "";
- my $linenr = 0;
- my $cpp = 0;
- open(IN, "<$hdr") || die "Can't open $hdr, $!,";
- while ( <IN> ) {
- $linenr++;
- if ( $line ne '' ) {
- $_ = $line . $_;
- $line = '';
- }
- if ( /\\$/ ) {
- $line = $_;
- next;
- }
- if ( /\/\*/ ) {
- if ( not /\*\// ) {
- $line = $_;
- next;
- } else {
- s/\/\*.*?\*\///gs;
- }
- }
- if ( $cpp ) {
- $cpp++ if /^
- $cpp-- if /^
- next;
- }
- $cpp = 1 if /^
- next if /^\
- s/{[^{}]*}//gs;
- if ( /\{|\/\*/ ) {
- $line = $_;
- } else {
- $def .= $_;
- }
- }
-
- my $defnr = 0;
- $def =~ s/DECLARE_\w+\([\w,\s]+\)//gs;
- foreach ( split /;/, $def ) {
- $defnr++;
-
- s/^[\n\s]*//g;
- s/[\n\s]*$//g;
-
- next if /typedef\W/ or /DECLARE_STACK_OF/ or /TYPEDEF_.*_OF/;
-
- s/STACK_OF\(\w+\)/void/;
-
-
- while ( /\(.*\)/s ) {
- s/\([^\(\)]+\)/\{\}/gs;
- s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;
- }
-
- s/\{\}/\(\)/gs;
-
- if ( /(\w+)\s*\(\).*/s ) {
- my $name = $1;
- $name =~ tr/[a-z]/[A-Z]/;
- $ftrans{$name} = $1;
- } elsif ( /[\(\)]/ and not(/=/) ) {
- print STDERR "Header $hdr: cannot parse: $_;\n";
- }
- }
- next if $reindex;
- if ( $lib eq "SSL" && $rmax{$lib} >= 1000 ) {
- print STDERR "SSL error codes 1000+ are reserved for alerts.\n";
- print STDERR "Any new alerts must be added to $config.\n";
- $errors++;
- }
- close IN;
- }
- print STDERR "\n" if $debug;
- &phase("Scanning source");
- my %usedfuncs;
- my %usedreasons;
- foreach my $file ( @source ) {
-
- next if exists $cskip{$file};
- open( IN, "<$file" ) || die "Can't open $file, $!,";
- my $func;
- my $linenr = 0;
- print STDERR "$file:\n" if $debug;
- while ( <IN> ) {
-
- last if /^
- $linenr++;
- if ( !/;$/ && /^\**([a-zA-Z_].*[\s*])?([A-Za-z_0-9]+)\(.*([),]|$)/ ) {
- /^([^()]*(\([^()]*\)[^()]*)*)\(/;
- $1 =~ /([A-Za-z_0-9]*)$/;
- $func = $1;
- }
- if ( /(((?:OSSL_|OPENSSL_)?[A-Z0-9]{2,})_F_([A-Z0-9_]+))/ ) {
- next unless exists $errorfile{$2};
- next if $1 eq "BIO_F_BUFFER_CTX";
- $usedfuncs{$1} = 1;
- if ( !exists $fcodes{$1} ) {
- print STDERR " New function $1\n" if $debug;
- $fcodes{$1} = "X";
- $fnew{$2}++;
- }
- $ftrans{$3} = $func unless exists $ftrans{$3};
- if ( uc($func) ne $3 ) {
- print STDERR "ERROR: mismatch $file:$linenr $func:$3\n";
- $errors++;
- }
- print STDERR " Function $1 = $fcodes{$1}\n"
- if $debug;
- }
- if ( /(((?:OSSL_|OPENSSL_)?[A-Z0-9]{2,})_R_[A-Z0-9_]+)/ ) {
- next unless exists $errorfile{$2};
- $usedreasons{$1} = 1;
- if ( !exists $rcodes{$1} ) {
- print STDERR " New reason $1\n" if $debug;
- $rcodes{$1} = "X";
- $rnew{$2}++;
- }
- print STDERR " Reason $1 = $rcodes{$1}\n" if $debug;
- }
- }
- close IN;
- }
- print STDERR "\n" if $debug;
- &phase("Writing files");
- my $newstate = 0;
- foreach my $lib ( keys %errorfile ) {
- next if ! $fnew{$lib} && ! $rnew{$lib} && ! $rebuild;
- next if scalar keys %modules > 0 && !$modules{$lib};
- next if $nowrite;
- print STDERR "$lib: $fnew{$lib} new functions\n" if $fnew{$lib};
- print STDERR "$lib: $rnew{$lib} new reasons\n" if $rnew{$lib};
- $newstate = 1;
-
-
-
- my @function = sort grep( /^${lib}_/, keys %fcodes );
- my @reasons = sort grep( /^${lib}_/, keys %rcodes );
-
- my $indent = " ";
-
- my $hfile = $hinc{$lib};
- $hfile =~ s/.h$/err.h/ if $internal;
- open( OUT, ">$hfile" ) || die "Can't write to $hfile, $!,";
- print OUT <<"EOF";
- /*
- * Generated by util/mkerr.pl DO NOT EDIT
- * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
- *
- * Licensed under the OpenSSL license (the \"License\"). You may not use
- * this file except in compliance with the License. You can obtain a copy
- * in the file LICENSE in the source distribution or at
- * https://www.openssl.org/source/license.html
- */
- #ifndef HEADER_${lib}ERR_H
- # define HEADER_${lib}ERR_H
- # include <openssl/symhacks.h>
- EOF
- if ( $internal ) {
- # Declare the load function because the generate C file
- # includes "fooerr.h" not "foo.h"
- if ($lib ne "SSL" && $lib ne "ASYNC"
- && grep { $lib eq uc $_ } @disablables) {
- print OUT <<"EOF";
- # include <openssl/opensslconf.h>
- # ifndef OPENSSL_NO_${lib}
- EOF
- $indent = " ";
- }
- print OUT <<"EOF";
- #${indent}ifdef __cplusplus
- extern \"C\"
- #${indent}endif
- int ERR_load_${lib}_strings(void);
- EOF
- } else {
- print OUT <<"EOF";
- # define ${lib}err(f, r) ERR_${lib}_error((f), (r), OPENSSL_FILE, OPENSSL_LINE)
- EOF
- if ( ! $static ) {
- print OUT <<"EOF";
- # ifdef __cplusplus
- extern \"C\" {
- # endif
- int ERR_load_${lib}_strings(void);
- void ERR_unload_${lib}_strings(void);
- void ERR_${lib}_error(int function, int reason, char *file, int line);
- # ifdef __cplusplus
- }
- # endif
- EOF
- }
- }
- print OUT "\n/*\n * $lib function codes.\n */\n";
- foreach my $i ( @function ) {
- my $z = 48 - length($i);
- $z = 0 if $z < 0;
- if ( $fcodes{$i} eq "X" ) {
- $fassigned{$lib} =~ m/^:([^:]*):/;
- my $findcode = $1;
- $findcode = $fmax{$lib} if !defined $findcode;
- while ( $fassigned{$lib} =~ m/:$findcode:/ ) {
- $findcode++;
- }
- $fcodes{$i} = $findcode;
- $fassigned{$lib} .= "$findcode:";
- print STDERR "New Function code $i\n" if $debug;
- }
- printf OUT "#${indent}define $i%s $fcodes{$i}\n", " " x $z;
- }
- print OUT "\n/*\n * $lib reason codes.\n */\n";
- foreach my $i ( @reasons ) {
- my $z = 48 - length($i);
- $z = 0 if $z < 0;
- if ( $rcodes{$i} eq "X" ) {
- $rassigned{$lib} =~ m/^:([^:]*):/;
- my $findcode = $1;
- $findcode = $rmax{$lib} if !defined $findcode;
- while ( $rassigned{$lib} =~ m/:$findcode:/ ) {
- $findcode++;
- }
- $rcodes{$i} = $findcode;
- $rassigned{$lib} .= "$findcode:";
- print STDERR "New Reason code $i\n" if $debug;
- }
- printf OUT "#${indent}define $i%s $rcodes{$i}\n", " " x $z;
- }
- print OUT "\n";
- while (length($indent) > 0) {
- $indent = substr $indent, 0, -1;
- print OUT "#${indent}endif\n";
- }
- # Rewrite the C source file containing the error details.
- # First, read any existing reason string definitions:
- my $cfile = $errorfile{$lib};
- my $pack_lib = $internal ? "ERR_LIB_${lib}" : "0";
- my $hincf = $hfile;
- $hincf =~ s|.*include/||;
- if ( $hincf =~ m|^openssl/| ) {
- $hincf = "<${hincf}>";
- } else {
- $hincf = "\"${hincf}\"";
- }
- open( OUT, ">$cfile" )
- || die "Can't open $cfile for writing, $!, stopped";
- my $const = $internal ? 'const ' : '';
- print OUT <<"EOF";
- /*
- * Generated by util/mkerr.pl DO NOT EDIT
- * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
- *
- * Licensed under the OpenSSL license (the "License"). You may not use
- * this file except in compliance with the License. You can obtain a copy
- * in the file LICENSE in the source distribution or at
- * https://www.openssl.org/source/license.html
- */
- #include <openssl/err.h>
- static ${const}ERR_STRING_DATA ${lib}_str_functs[] = {
- EOF
-
- foreach my $i ( @function ) {
- my $fn;
- if ( exists $strings{$i} and $strings{$i} ne '' ) {
- $fn = $strings{$i};
- $fn = "" if $fn eq '*';
- } else {
- $i =~ /^${lib}_F_(\S+)$/;
- $fn = $1;
- $fn = $ftrans{$fn} if exists $ftrans{$fn};
- $strings{$i} = $fn;
- }
- my $short = " {ERR_PACK($pack_lib, $i, 0), \"$fn\"},";
- if ( length($short) <= 80 ) {
- print OUT "$short\n";
- } else {
- print OUT " {ERR_PACK($pack_lib, $i, 0),\n \"$fn\"},\n";
- }
- }
- print OUT <<"EOF";
- {0, NULL}
- };
- static ${const}ERR_STRING_DATA ${lib}_str_reasons[] = {
- EOF
-
- foreach my $i ( @reasons ) {
- my $rn;
- if ( exists $strings{$i} ) {
- $rn = $strings{$i};
- $rn = "" if $rn eq '*';
- } else {
- $i =~ /^${lib}_R_(\S+)$/;
- $rn = $1;
- $rn =~ tr/_[A-Z]/ [a-z]/;
- $strings{$i} = $rn;
- }
- my $short = " {ERR_PACK($pack_lib, 0, $i), \"$rn\"},";
- if ( length($short) <= 80 ) {
- print OUT "$short\n";
- } else {
- print OUT " {ERR_PACK($pack_lib, 0, $i),\n \"$rn\"},\n";
- }
- }
- print OUT <<"EOF";
- {0, NULL}
- };
- EOF
- if ( $internal ) {
- print OUT <<"EOF";
- int ERR_load_${lib}_strings(void)
- {
- if (ERR_func_error_string(${lib}_str_functs[0].error) == NULL) {
- ERR_load_strings_const(${lib}_str_functs);
- ERR_load_strings_const(${lib}_str_reasons);
- }
- return 1;
- }
- EOF
- } else {
- my $st = $static ? "static " : "";
- print OUT <<"EOF";
- static int lib_code = 0;
- static int error_loaded = 0;
- ${st}int ERR_load_${lib}_strings(void)
- {
- if (lib_code == 0)
- lib_code = ERR_get_next_error_library();
- if (!error_loaded) {
- ERR_load_strings(lib_code, ${lib}_str_functs);
- ERR_load_strings(lib_code, ${lib}_str_reasons);
- error_loaded = 1;
- }
- return 1;
- }
- ${st}void ERR_unload_${lib}_strings(void)
- {
- if (error_loaded) {
- ERR_unload_strings(lib_code, ${lib}_str_functs);
- ERR_unload_strings(lib_code, ${lib}_str_reasons);
- error_loaded = 0;
- }
- }
- ${st}void ERR_${lib}_error(int function, int reason, char *file, int line)
- {
- if (lib_code == 0)
- lib_code = ERR_get_next_error_library();
- ERR_PUT_error(lib_code, function, reason, file, line);
- }
- EOF
- }
- close OUT;
- }
- &phase("Ending");
- if ( $unref ) {
- my @funref;
- foreach ( keys %fcodes ) {
- push( @funref, $_ ) unless exists $usedfuncs{$_};
- }
- my @runref;
- foreach ( keys %rcodes ) {
- push( @runref, $_ ) unless exists $usedreasons{$_};
- }
- if ( @funref ) {
- print STDERR "The following function codes were not referenced:\n";
- foreach ( sort @funref ) {
- print STDERR " $_\n";
- }
- }
- if ( @runref ) {
- print STDERR "The following reason codes were not referenced:\n";
- foreach ( sort @runref ) {
- print STDERR " $_\n";
- }
- }
- }
- die "Found $errors errors, quitting" if $errors;
- if ( $newstate ) {
- open(OUT, ">$statefile.new")
- || die "Can't write $statefile.new, $!";
- print OUT <<"EOF";
- EOF
- print OUT "\n# Function codes\n";
- foreach my $i ( sort keys %fcodes ) {
- my $short = "$i:$fcodes{$i}:";
- my $t = exists $strings{$i} ? $strings{$i} : "";
- $t = "\\\n\t" . $t if length($short) + length($t) > 80;
- print OUT "$short$t\n";
- }
- print OUT "\n#Reason codes\n";
- foreach my $i ( sort keys %rcodes ) {
- my $short = "$i:$rcodes{$i}:";
- my $t = exists $strings{$i} ? "$strings{$i}" : "";
- $t = "\\\n\t" . $t if length($short) + length($t) > 80;
- print OUT "$short$t\n" if !exists $rextra{$i};
- }
- close(OUT);
- if ( $skippedstate ) {
- print "Skipped state, leaving update in $statefile.new";
- } else {
- rename "$statefile", "$statefile.old"
- || die "Can't backup $statefile to $statefile.old, $!";
- rename "$statefile.new", "$statefile"
- || die "Can't rename $statefile to $statefile.new, $!";
- }
- }
- exit;
|