Add apps/progs.h to gitignore
[openssl.git] / util / mkdef.pl
1 #! /usr/bin/env perl
2 # Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
3 #
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
8
9 #
10 # generate a .def file
11 #
12 # It does this by parsing the header files and looking for the
13 # prototyped functions: it then prunes the output.
14 #
15 # Intermediary files are created, call libcrypto.num and libssl.num,
16 # The format of these files is:
17 #
18 #       routine-name    nnnn    vers    info
19 #
20 # The "nnnn" and "vers" fields are the numeric id and version for the symbol
21 # respectively. The "info" part is actually a colon-separated string of fields
22 # with the following meaning:
23 #
24 #       existence:platform:kind:algorithms
25 #
26 # - "existence" can be "EXIST" or "NOEXIST" depending on if the symbol is
27 #   found somewhere in the source,
28 # - "platforms" is empty if it exists on all platforms, otherwise it contains
29 #   comma-separated list of the platform, just as they are if the symbol exists
30 #   for those platforms, or prepended with a "!" if not.  This helps resolve
31 #   symbol name variants for platforms where the names are too long for the
32 #   compiler or linker, or if the systems is case insensitive and there is a
33 #   clash, or the symbol is implemented differently (see
34 #   EXPORT_VAR_AS_FUNCTION).  This script assumes renaming of symbols is found
35 #   in the file crypto/symhacks.h.
36 #   The semantics for the platforms is that every item is checked against the
37 #   environment.  For the negative items ("!FOO"), if any of them is false
38 #   (i.e. "FOO" is true) in the environment, the corresponding symbol can't be
39 #   used.  For the positive itms, if all of them are false in the environment,
40 #   the corresponding symbol can't be used.  Any combination of positive and
41 #   negative items are possible, and of course leave room for some redundancy.
42 # - "kind" is "FUNCTION" or "VARIABLE".  The meaning of that is obvious.
43 # - "algorithms" is a comma-separated list of algorithm names.  This helps
44 #   exclude symbols that are part of an algorithm that some user wants to
45 #   exclude.
46 #
47
48 use lib ".";
49 use configdata;
50 use File::Spec::Functions;
51 use File::Basename;
52 use if $^O ne "VMS", 'File::Glob' => qw/glob/;
53
54 my $debug=0;
55
56 my $crypto_num= catfile($config{sourcedir},"util","libcrypto.num");
57 my $ssl_num=    catfile($config{sourcedir},"util","libssl.num");
58 my $libname;
59
60 my $do_update = 0;
61 my $do_rewrite = 1;
62 my $do_crypto = 0;
63 my $do_ssl = 0;
64 my $do_ctest = 0;
65 my $do_ctestall = 0;
66 my $do_checkexist = 0;
67
68 my $VMS=0;
69 my $W32=0;
70 my $NT=0;
71 my $linux=0;
72 # Set this to make typesafe STACK definitions appear in DEF
73 my $safe_stack_def = 0;
74
75 my @known_platforms = ( "__FreeBSD__", "PERL5",
76                         "EXPORT_VAR_AS_FUNCTION", "ZLIB", "_WIN32"
77                         );
78 my @known_ossl_platforms = ( "VMS", "WIN32", "WINNT", "OS2" );
79 my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
80                          "CAST", "MD2", "MD4", "MD5", "SHA", "SHA0", "SHA1",
81                          "SHA256", "SHA512", "RMD160",
82                          "MDC2", "WHIRLPOOL", "RSA", "DSA", "DH", "EC", "EC2M",
83                          "HMAC", "AES", "CAMELLIA", "SEED", "GOST", "ARIA",
84                          "SCRYPT", "CHACHA", "POLY1305", "BLAKE2",
85                          "SIPHASH",
86                          # EC_NISTP_64_GCC_128
87                          "EC_NISTP_64_GCC_128",
88                          # Envelope "algorithms"
89                          "EVP", "X509", "ASN1_TYPEDEFS",
90                          # Helper "algorithms"
91                          "BIO", "COMP", "BUFFER", "LHASH", "STACK", "ERR",
92                          "LOCKING",
93                          # External "algorithms"
94                          "FP_API", "STDIO", "SOCK", "DGRAM",
95                          "CRYPTO_MDEBUG",
96                          # Engines
97                          "STATIC_ENGINE", "ENGINE", "HW", "GMP",
98                          # Entropy Gathering
99                          "EGD",
100                          # Certificate Transparency
101                          "CT",
102                          # RFC3779
103                          "RFC3779",
104                          # TLS
105                          "PSK", "SRP", "HEARTBEATS",
106                          # CMS
107                          "CMS",
108                          "OCSP",
109                          # CryptoAPI Engine
110                          "CAPIENG",
111                          # SSL methods
112                          "SSL3_METHOD", "TLS1_METHOD", "TLS1_1_METHOD", "TLS1_2_METHOD", "DTLS1_METHOD", "DTLS1_2_METHOD",
113                          # NEXTPROTONEG
114                          "NEXTPROTONEG",
115                          # Deprecated functions
116                          "DEPRECATEDIN_0_9_8",
117                          "DEPRECATEDIN_1_0_0",
118                          "DEPRECATEDIN_1_1_0",
119                          "DEPRECATEDIN_1_2_0",
120                          # SCTP
121                          "SCTP",
122                          # SRTP
123                          "SRTP",
124                          # SSL TRACE
125                          "SSL_TRACE",
126                          # Unit testing
127                          "UNIT_TEST",
128                          # User Interface
129                          "UI",
130                          #
131                          "TS",
132                          # OCB mode
133                          "OCB",
134                          "CMAC",
135                          # APPLINK (win build feature?)
136                          "APPLINK"
137                      );
138
139 my %disabled_algorithms;
140
141 foreach (@known_algorithms) {
142     $disabled_algorithms{$_} = 0;
143 }
144 # disabled by default
145 $disabled_algorithms{"STATIC_ENGINE"} = 1;
146
147 my $apiv = sprintf "%x%02x%02x", split(/\./, $config{api});
148 foreach (keys %disabled_algorithms) {
149         if (/^DEPRECATEDIN_(\d+)_(\d+)_(\d+)$/) {
150                 my $depv = sprintf "%x%02x%02x", $1, $2, $3;
151                 $disabled_algorithms{$_} = 1 if $apiv ge $depv;
152         }
153 }
154
155 my $zlib;
156
157 foreach (@ARGV, split(/ /, $config{options}))
158         {
159         $debug=1 if $_ eq "debug";
160         $W32=1 if $_ eq "32";
161         die "win16 not supported" if $_ eq "16";
162         if($_ eq "NT") {
163                 $W32 = 1;
164                 $NT = 1;
165         }
166         if ($_ eq "linux") {
167                 $linux=1;
168         }
169         $VMS=1 if $_ eq "VMS";
170         if ($_ eq "zlib" || $_ eq "enable-zlib" || $_ eq "zlib-dynamic"
171                          || $_ eq "enable-zlib-dynamic") {
172                 $zlib = 1;
173         }
174
175         $do_ssl=1 if $_ eq "libssl";
176         if ($_ eq "ssl") {
177                 $do_ssl=1;
178                 $libname=$_
179         }
180         $do_crypto=1 if $_ eq "libcrypto";
181         if ($_ eq "crypto") {
182                 $do_crypto=1;
183                 $libname=$_;
184         }
185         $do_update=1 if $_ eq "update";
186         $do_rewrite=1 if $_ eq "rewrite";
187         $do_ctest=1 if $_ eq "ctest";
188         $do_ctestall=1 if $_ eq "ctestall";
189         $do_checkexist=1 if $_ eq "exist";
190         if (/^(enable|disable|no)-(.*)$/) {
191                 my $alg = uc $2;
192                 $alg =~ tr/-/_/;
193                 if (exists $disabled_algorithms{$alg}) {
194                         $disabled_algorithms{$alg} = $1 eq "enable" ? 0 : 1;
195                 }
196         }
197
198         }
199
200 if (!$libname) {
201         if ($do_ssl) {
202                 $libname="LIBSSL";
203         }
204         if ($do_crypto) {
205                 $libname="LIBCRYPTO";
206         }
207 }
208
209 # If no platform is given, assume WIN32
210 if ($W32 + $VMS + $linux == 0) {
211         $W32 = 1;
212 }
213 die "Please, only one platform at a time"
214     if ($W32 + $VMS + $linux > 1);
215
216 if (!$do_ssl && !$do_crypto)
217         {
218         print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT | OS2 | linux | VMS ]\n";
219         exit(1);
220         }
221
222 %ssl_list=&load_numbers($ssl_num);
223 $max_ssl = $max_num;
224 %crypto_list=&load_numbers($crypto_num);
225 $max_crypto = $max_num;
226
227 my $ssl="include/openssl/ssl.h";
228 $ssl.=" include/openssl/sslerr.h";
229 $ssl.=" include/openssl/tls1.h";
230 $ssl.=" include/openssl/srtp.h";
231
232 # When scanning include/openssl, skip all SSL files and some internal ones.
233 my %skipthese;
234 foreach my $f ( split(/\s+/, $ssl) ) {
235     $skipthese{$f} = 1;
236 }
237 $skipthese{'include/openssl/conf_api.h'} = 1;
238 $skipthese{'include/openssl/ebcdic.h'} = 1;
239 $skipthese{'include/openssl/opensslconf.h'} = 1;
240
241 # We use headers found in include/openssl and include/internal only.
242 # The latter is needed so libssl.so/.dll/.exe can link properly.
243 my $crypto ="include/internal/dso.h";
244 $crypto.=" include/internal/o_dir.h";
245 $crypto.=" include/internal/o_str.h";
246 $crypto.=" include/internal/err.h";
247 foreach my $f ( glob(catfile($config{sourcedir},'include/openssl/*.h')) ) {
248     my $fn = "include/openssl/" . lc(basename($f));
249     $crypto .= " $fn" if !defined $skipthese{$fn} && $f !~ m@/[a-z]+err\.h$@;
250 }
251
252 my $symhacks="include/openssl/symhacks.h";
253
254 my @ssl_symbols = &do_defs("LIBSSL", $ssl, $symhacks);
255 my @crypto_symbols = &do_defs("LIBCRYPTO", $crypto, $symhacks);
256
257 if ($do_update) {
258
259 if ($do_ssl == 1) {
260
261         &maybe_add_info("LIBSSL",*ssl_list,@ssl_symbols);
262         if ($do_rewrite == 1) {
263                 open(OUT, ">$ssl_num");
264                 &rewrite_numbers(*OUT,"LIBSSL",*ssl_list,@ssl_symbols);
265         } else {
266                 open(OUT, ">>$ssl_num");
267         }
268         &update_numbers(*OUT,"LIBSSL",*ssl_list,$max_ssl,@ssl_symbols);
269         close OUT;
270 }
271
272 if($do_crypto == 1) {
273
274         &maybe_add_info("LIBCRYPTO",*crypto_list,@crypto_symbols);
275         if ($do_rewrite == 1) {
276                 open(OUT, ">$crypto_num");
277                 &rewrite_numbers(*OUT,"LIBCRYPTO",*crypto_list,@crypto_symbols);
278         } else {
279                 open(OUT, ">>$crypto_num");
280         }
281         &update_numbers(*OUT,"LIBCRYPTO",*crypto_list,$max_crypto,@crypto_symbols);
282         close OUT;
283 }
284
285 } elsif ($do_checkexist) {
286         &check_existing(*ssl_list, @ssl_symbols)
287                 if $do_ssl == 1;
288         &check_existing(*crypto_list, @crypto_symbols)
289                 if $do_crypto == 1;
290 } elsif ($do_ctest || $do_ctestall) {
291
292         print <<"EOF";
293
294 /* Test file to check all DEF file symbols are present by trying
295  * to link to all of them. This is *not* intended to be run!
296  */
297
298 int main()
299 {
300 EOF
301         &print_test_file(*STDOUT,"LIBSSL",*ssl_list,$do_ctestall,@ssl_symbols)
302                 if $do_ssl == 1;
303
304         &print_test_file(*STDOUT,"LIBCRYPTO",*crypto_list,$do_ctestall,@crypto_symbols)
305                 if $do_crypto == 1;
306
307         print "}\n";
308
309 } else {
310
311         &print_def_file(*STDOUT,$libname,*ssl_list,@ssl_symbols)
312                 if $do_ssl == 1;
313
314         &print_def_file(*STDOUT,$libname,*crypto_list,@crypto_symbols)
315                 if $do_crypto == 1;
316
317 }
318
319
320 sub do_defs
321 {
322         my($name,$files,$symhacksfile)=@_;
323         my $file;
324         my @ret;
325         my %syms;
326         my %platform;           # For anything undefined, we assume ""
327         my %kind;               # For anything undefined, we assume "FUNCTION"
328         my %algorithm;          # For anything undefined, we assume ""
329         my %variant;
330         my %variant_cnt;        # To be able to allocate "name{n}" if "name"
331                                 # is the same name as the original.
332         my $cpp;
333         my %unknown_algorithms = ();
334         my $parens = 0;
335
336         foreach $file (split(/\s+/,$symhacksfile." ".$files))
337                 {
338                 my $fn = catfile($config{sourcedir},$file);
339                 print STDERR "DEBUG: starting on $fn:\n" if $debug;
340                 open(IN,"<$fn") || die "Can't open $fn, $!,";
341                 my $line = "", my $def= "";
342                 my %tag = (
343                         (map { $_ => 0 } @known_platforms),
344                         (map { "OPENSSL_SYS_".$_ => 0 } @known_ossl_platforms),
345                         (map { "OPENSSL_NO_".$_ => 0 } @known_algorithms),
346                         (map { "OPENSSL_USE_".$_ => 0 } @known_algorithms),
347                         (grep /^DEPRECATED_/, @known_algorithms),
348                         NOPROTO         => 0,
349                         PERL5           => 0,
350                         _WINDLL         => 0,
351                         CONST_STRICT    => 0,
352                         TRUE            => 1,
353                 );
354                 my $symhacking = $file eq $symhacksfile;
355                 my @current_platforms = ();
356                 my @current_algorithms = ();
357
358                 # params: symbol, alias, platforms, kind
359                 # The reason to put this subroutine in a variable is that
360                 # it will otherwise create it's own, unshared, version of
361                 # %tag and %variant...
362                 my $make_variant = sub
363                 {
364                         my ($s, $a, $p, $k) = @_;
365                         my ($a1, $a2);
366
367                         print STDERR "DEBUG: make_variant: Entered with ",$s,", ",$a,", ",(defined($p)?$p:""),", ",(defined($k)?$k:""),"\n" if $debug;
368                         if (defined($p))
369                         {
370                                 $a1 = join(",",$p,
371                                            grep(!/^$/,
372                                                 map { $tag{$_} == 1 ? $_ : "" }
373                                                 @known_platforms));
374                         }
375                         else
376                         {
377                                 $a1 = join(",",
378                                            grep(!/^$/,
379                                                 map { $tag{$_} == 1 ? $_ : "" }
380                                                 @known_platforms));
381                         }
382                         $a2 = join(",",
383                                    grep(!/^$/,
384                                         map { $tag{"OPENSSL_SYS_".$_} == 1 ? $_ : "" }
385                                         @known_ossl_platforms));
386                         print STDERR "DEBUG: make_variant: a1 = $a1; a2 = $a2\n" if $debug;
387                         if ($a1 eq "") { $a1 = $a2; }
388                         elsif ($a1 ne "" && $a2 ne "") { $a1 .= ",".$a2; }
389                         if ($a eq $s)
390                         {
391                                 if (!defined($variant_cnt{$s}))
392                                 {
393                                         $variant_cnt{$s} = 0;
394                                 }
395                                 $variant_cnt{$s}++;
396                                 $a .= "{$variant_cnt{$s}}";
397                         }
398                         my $toadd = $a.":".$a1.(defined($k)?":".$k:"");
399                         my $togrep = $s.'(\{[0-9]+\})?:'.$a1.(defined($k)?":".$k:"");
400                         if (!grep(/^$togrep$/,
401                                   split(/;/, defined($variant{$s})?$variant{$s}:""))) {
402                                 if (defined($variant{$s})) { $variant{$s} .= ";"; }
403                                 $variant{$s} .= $toadd;
404                         }
405                         print STDERR "DEBUG: make_variant: Exit with variant of ",$s," = ",$variant{$s},"\n" if $debug;
406                 };
407
408                 print STDERR "DEBUG: parsing ----------\n" if $debug;
409                 while(<IN>) {
410                         if($parens > 0) {
411                                 #Inside a DEPRECATEDIN
412                                 $stored_multiline .= $_;
413                                 $stored_multiline =~ s|\R$||; # Better chomp
414                                 print STDERR "DEBUG: Continuing multiline DEPRECATEDIN: $stored_multiline\n" if $debug;
415                                 $parens = count_parens($stored_multiline);
416                                 if ($parens == 0) {
417                                         $def .= do_deprecated($stored_multiline,
418                                                         \@current_platforms,
419                                                         \@current_algorithms);
420                                 }
421                                 next;
422                         }
423                         if (/\/\* Error codes for the \w+ functions\. \*\//)
424                                 {
425                                 undef @tag;
426                                 last;
427                                 }
428                         if ($line ne '') {
429                                 $_ = $line . $_;
430                                 $line = '';
431                         }
432
433                         if (/\\$/) {
434                                 $line = $`; # keep what was before the backslash
435                                 next;
436                         }
437
438                         if(/\/\*/) {
439                                 if (not /\*\//) {       # multiline comment...
440                                         $line = $_;     # ... just accumulate
441                                         next;
442                                 } else {
443                                         s/\/\*.*?\*\///gs;# wipe it
444                                 }
445                         }
446
447                         if ($cpp) {
448                                 $cpp++ if /^#\s*if/;
449                                 $cpp-- if /^#\s*endif/;
450                                 next;
451                         }
452                         if (/^#.*ifdef.*cplusplus/) {
453                                 $cpp = 1;
454                                 next;
455                         }
456
457                         s/{[^{}]*}//gs;                      # ignore {} blocks
458                         print STDERR "DEBUG: \$def=\"$def\"\n" if $debug && $def ne "";
459                         print STDERR "DEBUG: \$_=\"$_\"\n" if $debug;
460                         if (/^\#\s*if\s+OPENSSL_API_COMPAT\s*(\S)\s*(0x[0-9a-fA-F]{8})L\s*$/) {
461                                 my $op = $1;
462                                 my $v = hex($2);
463                                 if ($op ne '<' && $op ne '>=') {
464                                     die "$file unacceptable operator $op: $_\n";
465                                 }
466                                 my ($one, $major, $minor) =
467                                     ( ($v >> 28) & 0xf,
468                                       ($v >> 20) & 0xff,
469                                       ($v >> 12) & 0xff );
470                                 my $t = "DEPRECATEDIN_${one}_${major}_${minor}";
471                                 push(@tag,"-");
472                                 push(@tag,$t);
473                                 $tag{$t}=($op eq '<' ? 1 : -1);
474                                 print STDERR "DEBUG: $file: found tag $t = $tag{$t}\n" if $debug;
475                         } elsif (/^\#\s*ifndef\s+(.*)/) {
476                                 push(@tag,"-");
477                                 push(@tag,$1);
478                                 $tag{$1}=-1;
479                                 print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
480                         } elsif (/^\#\s*if\s+!defined\(([^\)]+)\)/) {
481                                 push(@tag,"-");
482                                 if (/^\#\s*if\s+(!defined\(([^\)]+)\)(\s+\&\&\s+!defined\(([^\)]+)\))*)$/) {
483                                         my $tmp_1 = $1;
484                                         my $tmp_;
485                                         foreach $tmp_ (split '\&\&',$tmp_1) {
486                                                 $tmp_ =~ /!defined\(([^\)]+)\)/;
487                                                 print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
488                                                 push(@tag,$1);
489                                                 $tag{$1}=-1;
490                                         }
491                                 } else {
492                                         print STDERR "Warning: $file: complicated expression: $_" if $debug; # because it is O...
493                                         print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
494                                         push(@tag,$1);
495                                         $tag{$1}=-1;
496                                 }
497                         } elsif (/^\#\s*ifdef\s+(\S*)/) {
498                                 push(@tag,"-");
499                                 push(@tag,$1);
500                                 $tag{$1}=1;
501                                 print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
502                         } elsif (/^\#\s*if\s+defined\(([^\)]+)\)/) {
503                                 push(@tag,"-");
504                                 if (/^\#\s*if\s+(defined\(([^\)]+)\)(\s+\|\|\s+defined\(([^\)]+)\))*)$/) {
505                                         my $tmp_1 = $1;
506                                         my $tmp_;
507                                         foreach $tmp_ (split '\|\|',$tmp_1) {
508                                                 $tmp_ =~ /defined\(([^\)]+)\)/;
509                                                 print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
510                                                 push(@tag,$1);
511                                                 $tag{$1}=1;
512                                         }
513                                 } else {
514                                         print STDERR "Warning: $file: complicated expression: $_\n" if $debug; # because it is O...
515                                         print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
516                                         push(@tag,$1);
517                                         $tag{$1}=1;
518                                 }
519                         } elsif (/^\#\s*error\s+(\w+) is disabled\./) {
520                                 my $tag_i = $#tag;
521                                 while($tag[$tag_i] ne "-") {
522                                         if ($tag[$tag_i] eq "OPENSSL_NO_".$1) {
523                                                 $tag{$tag[$tag_i]}=2;
524                                                 print STDERR "DEBUG: $file: chaged tag $1 = 2\n" if $debug;
525                                         }
526                                         $tag_i--;
527                                 }
528                         } elsif (/^\#\s*endif/) {
529                                 my $tag_i = $#tag;
530                                 while($tag_i > 0 && $tag[$tag_i] ne "-") {
531                                         my $t=$tag[$tag_i];
532                                         print STDERR "DEBUG: \$t=\"$t\"\n" if $debug;
533                                         if ($tag{$t}==2) {
534                                                 $tag{$t}=-1;
535                                         } else {
536                                                 $tag{$t}=0;
537                                         }
538                                         print STDERR "DEBUG: $file: changed tag ",$t," = ",$tag{$t},"\n" if $debug;
539                                         pop(@tag);
540                                         if ($t =~ /^OPENSSL_NO_([A-Z0-9_]+)$/) {
541                                                 $t=$1;
542                                         } elsif($t =~ /^OPENSSL_USE_([A-Z0-9_]+)$/) {
543                                                 $t=$1;
544                                         } else {
545                                                 $t="";
546                                         }
547                                         if ($t ne ""
548                                             && !grep(/^$t$/, @known_algorithms)) {
549                                                 $unknown_algorithms{$t} = 1;
550                                                 #print STDERR "DEBUG: Added as unknown algorithm: $t\n" if $debug;
551                                         }
552                                         $tag_i--;
553                                 }
554                                 pop(@tag);
555                         } elsif (/^\#\s*else/) {
556                                 my $tag_i = $#tag;
557                                 die "$file unmatched else\n" if $tag_i < 0;
558                                 while($tag[$tag_i] ne "-") {
559                                         my $t=$tag[$tag_i];
560                                         $tag{$t}= -$tag{$t};
561                                         print STDERR "DEBUG: $file: changed tag ",$t," = ",$tag{$t},"\n" if $debug;
562                                         $tag_i--;
563                                 }
564                         } elsif (/^\#\s*if\s+1/) {
565                                 push(@tag,"-");
566                                 # Dummy tag
567                                 push(@tag,"TRUE");
568                                 $tag{"TRUE"}=1;
569                                 print STDERR "DEBUG: $file: found 1\n" if $debug;
570                         } elsif (/^\#\s*if\s+0/) {
571                                 push(@tag,"-");
572                                 # Dummy tag
573                                 push(@tag,"TRUE");
574                                 $tag{"TRUE"}=-1;
575                                 print STDERR "DEBUG: $file: found 0\n" if $debug;
576                         } elsif (/^\#\s*if\s+/) {
577                                 #Some other unrecognized "if" style
578                                 push(@tag,"-");
579                         } elsif (/^\#\s*define\s+(\w+)\s+(\w+)/
580                                  && $symhacking && $tag{'TRUE'} != -1) {
581                                 # This is for aliasing.  When we find an alias,
582                                 # we have to invert
583                                 &$make_variant($1,$2);
584                                 print STDERR "DEBUG: $file: defined $1 = $2\n" if $debug;
585                         }
586                         if (/^\#/) {
587                                 @current_platforms =
588                                     grep(!/^$/,
589                                          map { $tag{$_} == 1 ? $_ :
590                                                    $tag{$_} == -1 ? "!".$_  : "" }
591                                          @known_platforms);
592                                 push @current_platforms
593                                     , grep(!/^$/,
594                                            map { $tag{"OPENSSL_SYS_".$_} == 1 ? $_ :
595                                                      $tag{"OPENSSL_SYS_".$_} == -1 ? "!".$_  : "" }
596                                            @known_ossl_platforms);
597                                 @current_algorithms = ();
598                                 @current_algorithms =
599                                     grep(!/^$/,
600                                          map { $tag{"OPENSSL_NO_".$_} == -1 ? $_ : "" }
601                                          @known_algorithms);
602                                 push @current_algorithms
603                                     , grep(!/^$/,
604                                          map { $tag{"OPENSSL_USE_".$_} == 1 ? $_ : "" }
605                                          @known_algorithms);
606                                 push @current_algorithms,
607                                     grep { /^DEPRECATEDIN_/ && $tag{$_} == 1 }
608                                     @known_algorithms;
609                                 $def .=
610                                     "#INFO:"
611                                         .join(',',@current_platforms).":"
612                                             .join(',',@current_algorithms).";";
613                                 next;
614                         }
615                         if ($tag{'TRUE'} != -1) {
616                                 if (/^\s*DEFINE_STACK_OF\s*\(\s*(\w*)\s*\)/
617                                                 || /^\s*DEFINE_STACK_OF_CONST\s*\(\s*(\w*)\s*\)/) {
618                                         next;
619                                 } elsif (/^\s*DECLARE_ASN1_ENCODE_FUNCTIONS\s*\(\s*(\w*)\s*,\s*(\w*)\s*,\s*(\w*)\s*\)/) {
620                                         $def .= "int d2i_$3(void);";
621                                         $def .= "int i2d_$3(void);";
622                                         # Variant for platforms that do not
623                                         # have to access globale variables
624                                         # in shared libraries through functions
625                                         $def .=
626                                             "#INFO:"
627                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
628                                                     .join(',',@current_algorithms).";";
629                                         $def .= "OPENSSL_EXTERN int $2_it;";
630                                         $def .=
631                                             "#INFO:"
632                                                 .join(',',@current_platforms).":"
633                                                     .join(',',@current_algorithms).";";
634                                         # Variant for platforms that have to
635                                         # access globale variables in shared
636                                         # libraries through functions
637                                         &$make_variant("$2_it","$2_it",
638                                                       "EXPORT_VAR_AS_FUNCTION",
639                                                       "FUNCTION");
640                                         next;
641                                 } elsif (/^\s*DECLARE_ASN1_FUNCTIONS_fname\s*\(\s*(\w*)\s*,\s*(\w*)\s*,\s*(\w*)\s*\)/) {
642                                         $def .= "int d2i_$3(void);";
643                                         $def .= "int i2d_$3(void);";
644                                         $def .= "int $3_free(void);";
645                                         $def .= "int $3_new(void);";
646                                         # Variant for platforms that do not
647                                         # have to access globale variables
648                                         # in shared libraries through functions
649                                         $def .=
650                                             "#INFO:"
651                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
652                                                     .join(',',@current_algorithms).";";
653                                         $def .= "OPENSSL_EXTERN int $2_it;";
654                                         $def .=
655                                             "#INFO:"
656                                                 .join(',',@current_platforms).":"
657                                                     .join(',',@current_algorithms).";";
658                                         # Variant for platforms that have to
659                                         # access globale variables in shared
660                                         # libraries through functions
661                                         &$make_variant("$2_it","$2_it",
662                                                       "EXPORT_VAR_AS_FUNCTION",
663                                                       "FUNCTION");
664                                         next;
665                                 } elsif (/^\s*DECLARE_ASN1_FUNCTIONS\s*\(\s*(\w*)\s*\)/ ||
666                                          /^\s*DECLARE_ASN1_FUNCTIONS_const\s*\(\s*(\w*)\s*\)/) {
667                                         $def .= "int d2i_$1(void);";
668                                         $def .= "int i2d_$1(void);";
669                                         $def .= "int $1_free(void);";
670                                         $def .= "int $1_new(void);";
671                                         # Variant for platforms that do not
672                                         # have to access globale variables
673                                         # in shared libraries through functions
674                                         $def .=
675                                             "#INFO:"
676                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
677                                                     .join(',',@current_algorithms).";";
678                                         $def .= "OPENSSL_EXTERN int $1_it;";
679                                         $def .=
680                                             "#INFO:"
681                                                 .join(',',@current_platforms).":"
682                                                     .join(',',@current_algorithms).";";
683                                         # Variant for platforms that have to
684                                         # access globale variables in shared
685                                         # libraries through functions
686                                         &$make_variant("$1_it","$1_it",
687                                                       "EXPORT_VAR_AS_FUNCTION",
688                                                       "FUNCTION");
689                                         next;
690                                 } elsif (/^\s*DECLARE_ASN1_ENCODE_FUNCTIONS_const\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
691                                         $def .= "int d2i_$2(void);";
692                                         $def .= "int i2d_$2(void);";
693                                         # Variant for platforms that do not
694                                         # have to access globale variables
695                                         # in shared libraries through functions
696                                         $def .=
697                                             "#INFO:"
698                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
699                                                     .join(',',@current_algorithms).";";
700                                         $def .= "OPENSSL_EXTERN int $2_it;";
701                                         $def .=
702                                             "#INFO:"
703                                                 .join(',',@current_platforms).":"
704                                                     .join(',',@current_algorithms).";";
705                                         # Variant for platforms that have to
706                                         # access globale variables in shared
707                                         # libraries through functions
708                                         &$make_variant("$2_it","$2_it",
709                                                       "EXPORT_VAR_AS_FUNCTION",
710                                                       "FUNCTION");
711                                         next;
712                                 } elsif (/^\s*DECLARE_ASN1_ALLOC_FUNCTIONS\s*\(\s*(\w*)\s*\)/) {
713                                         $def .= "int $1_free(void);";
714                                         $def .= "int $1_new(void);";
715                                         next;
716                                 } elsif (/^\s*DECLARE_ASN1_FUNCTIONS_name\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
717                                         $def .= "int d2i_$2(void);";
718                                         $def .= "int i2d_$2(void);";
719                                         $def .= "int $2_free(void);";
720                                         $def .= "int $2_new(void);";
721                                         # Variant for platforms that do not
722                                         # have to access globale variables
723                                         # in shared libraries through functions
724                                         $def .=
725                                             "#INFO:"
726                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
727                                                     .join(',',@current_algorithms).";";
728                                         $def .= "OPENSSL_EXTERN int $2_it;";
729                                         $def .=
730                                             "#INFO:"
731                                                 .join(',',@current_platforms).":"
732                                                     .join(',',@current_algorithms).";";
733                                         # Variant for platforms that have to
734                                         # access globale variables in shared
735                                         # libraries through functions
736                                         &$make_variant("$2_it","$2_it",
737                                                       "EXPORT_VAR_AS_FUNCTION",
738                                                       "FUNCTION");
739                                         next;
740                                 } elsif (/^\s*DECLARE_ASN1_ITEM\s*\(\s*(\w*)\s*\)/) {
741                                         # Variant for platforms that do not
742                                         # have to access globale variables
743                                         # in shared libraries through functions
744                                         $def .=
745                                             "#INFO:"
746                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
747                                                     .join(',',@current_algorithms).";";
748                                         $def .= "OPENSSL_EXTERN int $1_it;";
749                                         $def .=
750                                             "#INFO:"
751                                                 .join(',',@current_platforms).":"
752                                                     .join(',',@current_algorithms).";";
753                                         # Variant for platforms that have to
754                                         # access globale variables in shared
755                                         # libraries through functions
756                                         &$make_variant("$1_it","$1_it",
757                                                       "EXPORT_VAR_AS_FUNCTION",
758                                                       "FUNCTION");
759                                         next;
760                                 } elsif (/^\s*DECLARE_ASN1_NDEF_FUNCTION\s*\(\s*(\w*)\s*\)/) {
761                                         $def .= "int i2d_$1_NDEF(void);";
762                                 } elsif (/^\s*DECLARE_ASN1_SET_OF\s*\(\s*(\w*)\s*\)/) {
763                                         next;
764                                 } elsif (/^\s*DECLARE_ASN1_PRINT_FUNCTION\s*\(\s*(\w*)\s*\)/) {
765                                         $def .= "int $1_print_ctx(void);";
766                                         next;
767                                 } elsif (/^\s*DECLARE_ASN1_PRINT_FUNCTION_name\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
768                                         $def .= "int $2_print_ctx(void);";
769                                         next;
770                                 } elsif (/^\s*DECLARE_PKCS12_STACK_OF\s*\(\s*(\w*)\s*\)/) {
771                                         next;
772                                 } elsif (/^DECLARE_PEM_rw\s*\(\s*(\w*)\s*,/ ||
773                                          /^DECLARE_PEM_rw_cb\s*\(\s*(\w*)\s*,/ ||
774                                          /^DECLARE_PEM_rw_const\s*\(\s*(\w*)\s*,/ ) {
775                                         $def .=
776                                             "#INFO:"
777                                                 .join(',',@current_platforms).":"
778                                                     .join(',',"STDIO",@current_algorithms).";";
779                                         $def .= "int PEM_read_$1(void);";
780                                         $def .= "int PEM_write_$1(void);";
781                                         $def .=
782                                             "#INFO:"
783                                                 .join(',',@current_platforms).":"
784                                                     .join(',',@current_algorithms).";";
785                                         # Things that are everywhere
786                                         $def .= "int PEM_read_bio_$1(void);";
787                                         $def .= "int PEM_write_bio_$1(void);";
788                                         next;
789                                 } elsif (/^DECLARE_PEM_write\s*\(\s*(\w*)\s*,/ ||
790                                         /^DECLARE_PEM_write_const\s*\(\s*(\w*)\s*,/ ||
791                                          /^DECLARE_PEM_write_cb\s*\(\s*(\w*)\s*,/ ) {
792                                         $def .=
793                                             "#INFO:"
794                                                 .join(',',@current_platforms).":"
795                                                     .join(',',"STDIO",@current_algorithms).";";
796                                         $def .= "int PEM_write_$1(void);";
797                                         $def .=
798                                             "#INFO:"
799                                                 .join(',',@current_platforms).":"
800                                                     .join(',',@current_algorithms).";";
801                                         # Things that are everywhere
802                                         $def .= "int PEM_write_bio_$1(void);";
803                                         next;
804                                 } elsif (/^DECLARE_PEM_read\s*\(\s*(\w*)\s*,/ ||
805                                          /^DECLARE_PEM_read_cb\s*\(\s*(\w*)\s*,/ ) {
806                                         $def .=
807                                             "#INFO:"
808                                                 .join(',',@current_platforms).":"
809                                                     .join(',',"STDIO",@current_algorithms).";";
810                                         $def .= "int PEM_read_$1(void);";
811                                         $def .=
812                                             "#INFO:"
813                                                 .join(',',@current_platforms).":"
814                                                     .join(',',"STDIO",@current_algorithms).";";
815                                         # Things that are everywhere
816                                         $def .= "int PEM_read_bio_$1(void);";
817                                         next;
818                                 } elsif (/^OPENSSL_DECLARE_GLOBAL\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
819                                         # Variant for platforms that do not
820                                         # have to access globale variables
821                                         # in shared libraries through functions
822                                         $def .=
823                                             "#INFO:"
824                                                 .join(',',"!EXPORT_VAR_AS_FUNCTION",@current_platforms).":"
825                                                     .join(',',@current_algorithms).";";
826                                         $def .= "OPENSSL_EXTERN int _shadow_$2;";
827                                         $def .=
828                                             "#INFO:"
829                                                 .join(',',@current_platforms).":"
830                                                     .join(',',@current_algorithms).";";
831                                         # Variant for platforms that have to
832                                         # access globale variables in shared
833                                         # libraries through functions
834                                         &$make_variant("_shadow_$2","_shadow_$2",
835                                                       "EXPORT_VAR_AS_FUNCTION",
836                                                       "FUNCTION");
837                                 } elsif (/^\s*DEPRECATEDIN/) {
838                                         $parens = count_parens($_);
839                                         if ($parens == 0) {
840                                                 $def .= do_deprecated($_,
841                                                         \@current_platforms,
842                                                         \@current_algorithms);
843                                         } else {
844                                                 $stored_multiline = $_;
845                                                 $stored_multiline =~ s|\R$||;
846                                                 print STDERR "DEBUG: Found multiline DEPRECATEDIN starting with: $stored_multiline\n" if $debug;
847                                                 next;
848                                         }
849                                 } elsif ($tag{'CONST_STRICT'} != 1) {
850                                         if (/\{|\/\*|\([^\)]*$/) {
851                                                 $line = $_;
852                                         } else {
853                                                 $def .= $_;
854                                         }
855                                 }
856                         }
857                 }
858                 close(IN);
859                 die "$file: Unmatched tags\n" if $#tag >= 0;
860
861                 my $algs;
862                 my $plays;
863
864                 print STDERR "DEBUG: postprocessing ----------\n" if $debug;
865                 foreach (split /;/, $def) {
866                         my $s; my $k = "FUNCTION"; my $p; my $a;
867                         s/^[\n\s]*//g;
868                         s/[\n\s]*$//g;
869                         next if(/\#undef/);
870                         next if(/typedef\W/);
871                         next if(/\#define/);
872
873                         # Reduce argument lists to empty ()
874                         # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
875                         while(/\(.*\)/s) {
876                                 s/\([^\(\)]+\)/\{\}/gs;
877                                 s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;    #(*f{}) -> f
878                         }
879                         # pretend as we didn't use curly braces: {} -> ()
880                         s/\{\}/\(\)/gs;
881
882                         s/STACK_OF\(\)/void/gs;
883                         s/LHASH_OF\(\)/void/gs;
884
885                         print STDERR "DEBUG: \$_ = \"$_\"\n" if $debug;
886                         if (/^\#INFO:([^:]*):(.*)$/) {
887                                 $plats = $1;
888                                 $algs = $2;
889                                 print STDERR "DEBUG: found info on platforms ($plats) and algorithms ($algs)\n" if $debug;
890                                 next;
891                         } elsif (/^\s*OPENSSL_EXTERN\s.*?(\w+(\{[0-9]+\})?)(\[[0-9]*\])*\s*$/) {
892                                 $s = $1;
893                                 $k = "VARIABLE";
894                                 print STDERR "DEBUG: found external variable $s\n" if $debug;
895                         } elsif (/TYPEDEF_\w+_OF/s) {
896                                 next;
897                         } elsif (/(\w+)\s*\(\).*/s) {   # first token prior [first] () is
898                                 $s = $1;                # a function name!
899                                 print STDERR "DEBUG: found function $s\n" if $debug;
900                         } elsif (/\(/ and not (/=/)) {
901                                 print STDERR "File $file: cannot parse: $_;\n";
902                                 next;
903                         } else {
904                                 next;
905                         }
906
907                         $syms{$s} = 1;
908                         $kind{$s} = $k;
909
910                         $p = $plats;
911                         $a = $algs;
912
913                         $platform{$s} =
914                             &reduce_platforms((defined($platform{$s})?$platform{$s}.',':"").$p);
915                         $algorithm{$s} .= ','.$a;
916
917                         if (defined($variant{$s})) {
918                                 foreach $v (split /;/,$variant{$s}) {
919                                         (my $r, my $p, my $k) = split(/:/,$v);
920                                         my $ip = join ',',map({ /^!(.*)$/ ? $1 : "!".$_ } split /,/, $p);
921                                         $syms{$r} = 1;
922                                         if (!defined($k)) { $k = $kind{$s}; }
923                                         $kind{$r} = $k."(".$s.")";
924                                         $algorithm{$r} = $algorithm{$s};
925                                         $platform{$r} = &reduce_platforms($platform{$s}.",".$p.",".$p);
926                                         $platform{$s} = &reduce_platforms($platform{$s}.','.$ip.','.$ip);
927                                         print STDERR "DEBUG: \$variant{\"$s\"} = ",$v,"; \$r = $r; \$p = ",$platform{$r},"; \$a = ",$algorithm{$r},"; \$kind = ",$kind{$r},"\n" if $debug;
928                                 }
929                         }
930                         print STDERR "DEBUG: \$s = $s; \$p = ",$platform{$s},"; \$a = ",$algorithm{$s},"; \$kind = ",$kind{$s},"\n" if $debug;
931                 }
932         }
933
934         # Prune the returned symbols
935
936         delete $syms{"bn_dump1"};
937         $platform{"BIO_s_log"} .= ",!WIN32,!macintosh";
938
939         $platform{"PEM_read_NS_CERT_SEQ"} = "VMS";
940         $platform{"PEM_write_NS_CERT_SEQ"} = "VMS";
941         $platform{"PEM_read_P8_PRIV_KEY_INFO"} = "VMS";
942         $platform{"PEM_write_P8_PRIV_KEY_INFO"} = "VMS";
943
944         # Info we know about
945
946         push @ret, map { $_."\\".&info_string($_,"EXIST",
947                                               $platform{$_},
948                                               $kind{$_},
949                                               $algorithm{$_}) } keys %syms;
950
951         if (keys %unknown_algorithms) {
952                 print STDERR "WARNING: mkdef.pl doesn't know the following algorithms:\n";
953                 print STDERR "\t",join("\n\t",keys %unknown_algorithms),"\n";
954         }
955         return(@ret);
956 }
957
958 # Param: string of comma-separated platform-specs.
959 sub reduce_platforms
960 {
961         my ($platforms) = @_;
962         my $pl = defined($platforms) ? $platforms : "";
963         my %p = map { $_ => 0 } split /,/, $pl;
964         my $ret;
965
966         print STDERR "DEBUG: Entered reduce_platforms with \"$platforms\"\n"
967             if $debug;
968         # We do this, because if there's code like the following, it really
969         # means the function exists in all cases and should therefore be
970         # everywhere.  By increasing and decreasing, we may attain 0:
971         #
972         # ifndef WIN16
973         #    int foo();
974         # else
975         #    int _fat foo();
976         # endif
977         foreach $platform (split /,/, $pl) {
978                 if ($platform =~ /^!(.*)$/) {
979                         $p{$1}--;
980                 } else {
981                         $p{$platform}++;
982                 }
983         }
984         foreach $platform (keys %p) {
985                 if ($p{$platform} == 0) { delete $p{$platform}; }
986         }
987
988         delete $p{""};
989
990         $ret = join(',',sort(map { $p{$_} < 0 ? "!".$_ : $_ } keys %p));
991         print STDERR "DEBUG: Exiting reduce_platforms with \"$ret\"\n"
992             if $debug;
993         return $ret;
994 }
995
996 sub info_string
997 {
998         (my $symbol, my $exist, my $platforms, my $kind, my $algorithms) = @_;
999
1000         my %a = defined($algorithms) ?
1001             map { $_ => 1 } split /,/, $algorithms : ();
1002         my $k = defined($kind) ? $kind : "FUNCTION";
1003         my $ret;
1004         my $p = &reduce_platforms($platforms);
1005
1006         delete $a{""};
1007
1008         $ret = $exist;
1009         $ret .= ":".$p;
1010         $ret .= ":".$k;
1011         $ret .= ":".join(',',sort keys %a);
1012         return $ret;
1013 }
1014
1015 sub maybe_add_info
1016 {
1017         (my $name, *nums, my @symbols) = @_;
1018         my $sym;
1019         my $new_info = 0;
1020         my %syms=();
1021
1022         foreach $sym (@symbols) {
1023                 (my $s, my $i) = split /\\/, $sym;
1024                 if (defined($nums{$s})) {
1025                         $i =~ s/^(.*?:.*?:\w+)(\(\w+\))?/$1/;
1026                         (my $n, my $vers, my $dummy) = split /\\/, $nums{$s};
1027                         if (!defined($dummy) || $i ne $dummy) {
1028                                 $nums{$s} = $n."\\".$vers."\\".$i;
1029                                 $new_info++;
1030                                 print STDERR "DEBUG: maybe_add_info for $s: \"$dummy\" => \"$i\"\n" if $debug;
1031                         }
1032                 }
1033                 $syms{$s} = 1;
1034         }
1035
1036         my @s=sort { &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n") } keys %nums;
1037         foreach $sym (@s) {
1038                 (my $n, my $vers, my $i) = split /\\/, $nums{$sym};
1039                 if (!defined($syms{$sym}) && $i !~ /^NOEXIST:/) {
1040                         $new_info++;
1041                         print STDERR "DEBUG: maybe_add_info for $sym: -> undefined\n" if $debug;
1042                 }
1043         }
1044         if ($new_info) {
1045                 print STDERR "$name: $new_info old symbols have updated info\n";
1046                 if (!$do_rewrite) {
1047                         print STDERR "You should do a rewrite to fix this.\n";
1048                 }
1049         } else {
1050         }
1051 }
1052
1053 # Param: string of comma-separated keywords, each possibly prefixed with a "!"
1054 sub is_valid
1055 {
1056         my ($keywords_txt,$platforms) = @_;
1057         my (@keywords) = split /,/,$keywords_txt;
1058         my ($falsesum, $truesum) = (0, 1);
1059
1060         # Param: one keyword
1061         sub recognise
1062         {
1063                 my ($keyword,$platforms) = @_;
1064
1065                 if ($platforms) {
1066                         # platforms
1067                         if ($keyword eq "VMS" && $VMS) { return 1; }
1068                         if ($keyword eq "WIN32" && $W32) { return 1; }
1069                         if ($keyword eq "_WIN32" && $W32) { return 1; }
1070                         if ($keyword eq "WINNT" && $NT) { return 1; }
1071                         # Special platforms:
1072                         # EXPORT_VAR_AS_FUNCTION means that global variables
1073                         # will be represented as functions.
1074                         if ($keyword eq "EXPORT_VAR_AS_FUNCTION" && $W32) {
1075                                 return 1;
1076                         }
1077                         if ($keyword eq "ZLIB" && $zlib) { return 1; }
1078                         return 0;
1079                 } else {
1080                         # algorithms
1081                         if ($disabled_algorithms{$keyword} == 1) { return 0;}
1082
1083                         # Nothing recognise as true
1084                         return 1;
1085                 }
1086         }
1087
1088         foreach $k (@keywords) {
1089                 if ($k =~ /^!(.*)$/) {
1090                         $falsesum += &recognise($1,$platforms);
1091                 } else {
1092                         $truesum *= &recognise($k,$platforms);
1093                 }
1094         }
1095         print STDERR "DEBUG: [",$#keywords,",",$#keywords < 0,"] is_valid($keywords_txt) => (\!$falsesum) && $truesum = ",(!$falsesum) && $truesum,"\n" if $debug;
1096         return (!$falsesum) && $truesum;
1097 }
1098
1099 sub print_test_file
1100 {
1101         (*OUT,my $name,*nums,my $testall,my @symbols)=@_;
1102         my $n = 1; my @e; my @r;
1103         my $sym; my $prev = ""; my $prefSSLeay;
1104
1105         (@e)=grep(/^SSLeay(\{[0-9]+\})?\\.*?:.*?:.*/,@symbols);
1106         (@r)=grep(/^\w+(\{[0-9]+\})?\\.*?:.*?:.*/ && !/^SSLeay(\{[0-9]+\})?\\.*?:.*?:.*/,@symbols);
1107         @symbols=((sort @e),(sort @r));
1108
1109         foreach $sym (@symbols) {
1110                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
1111                 my $v = 0;
1112                 $v = 1 if $i=~ /^.*?:.*?:VARIABLE/;
1113                 my $p = ($i =~ /^[^:]*:([^:]*):/,$1);
1114                 my $a = ($i =~ /^[^:]*:[^:]*:[^:]*:([^:]*)/,$1);
1115                 if (!defined($nums{$s})) {
1116                         print STDERR "Warning: $s does not have a number assigned\n"
1117                             if(!$do_update);
1118                 } elsif (is_valid($p,1) && is_valid($a,0)) {
1119                         my $s2 = ($s =~ /^(.*?)(\{[0-9]+\})?$/, $1);
1120                         if ($prev eq $s2) {
1121                                 print OUT "\t/* The following has already appeared previously */\n";
1122                                 print STDERR "Warning: Symbol '",$s2,"' redefined. old=",($nums{$prev} =~ /^(.*?)\\/,$1),", new=",($nums{$s2} =~ /^(.*?)\\/,$1),"\n";
1123                         }
1124                         $prev = $s2;    # To warn about duplicates...
1125
1126                         (my $nn, my $vers, my $ni) = split /\\/, $nums{$s2};
1127                         if ($v) {
1128                                 print OUT "\textern int $s2; /* type unknown */ /* $nn $ni */\n";
1129                         } else {
1130                                 print OUT "\textern int $s2(); /* type unknown */ /* $nn $ni */\n";
1131                         }
1132                 }
1133         }
1134 }
1135
1136 sub get_version
1137 {
1138    return $config{version};
1139 }
1140
1141 sub print_def_file
1142 {
1143         (*OUT,my $name,*nums,my @symbols)=@_;
1144         my $n = 1; my @e; my @r; my @v; my $prev="";
1145         my $liboptions="";
1146         my $libname = $name;
1147         my $http_vendor = 'www.openssl.org/';
1148         my $version = get_version();
1149         my $what = "OpenSSL: implementation of Secure Socket Layer";
1150         my $description = "$what $version, $name - http://$http_vendor";
1151         my $prevsymversion = "", $prevprevsymversion = "";
1152         # For VMS
1153         my $prevnum = 0;
1154         my $symvtextcount = 0;
1155
1156         if ($W32)
1157                 { $libname.="32"; }
1158
1159         if ($W32)
1160                 {
1161                 print OUT <<"EOF";
1162 ;
1163 ; Definition file for the DLL version of the $name library from OpenSSL
1164 ;
1165
1166 LIBRARY         $libname        $liboptions
1167
1168 EOF
1169
1170                 print "EXPORTS\n";
1171                 }
1172         elsif ($VMS)
1173                 {
1174                 print OUT <<"EOF";
1175 CASE_SENSITIVE=YES
1176 SYMBOL_VECTOR=(-
1177 EOF
1178                 $symvtextcount = 16; # length of "SYMBOL_VECTOR=(-"
1179                 }
1180
1181         (@r)=grep(/^\w+(\{[0-9]+\})?\\.*?:.*?:FUNCTION/,@symbols);
1182         (@v)=grep(/^\w+(\{[0-9]+\})?\\.*?:.*?:VARIABLE/,@symbols);
1183         if ($VMS) {
1184             # VMS needs to have the symbols on slot number order
1185             @symbols=(map { $_->[1] }
1186                       sort { $a->[0] <=> $b->[0] }
1187                       map { (my $s, my $i) = $_ =~ /^(.*?)\\(.*)$/;
1188                             die "Error: $s doesn't have a number assigned\n"
1189                                 if !defined($nums{$s});
1190                             (my $n, my @rest) = split /\\/, $nums{$s};
1191                             [ $n, $_ ] } (@e, @r, @v));
1192         } else {
1193             @symbols=((sort @e),(sort @r), (sort @v));
1194         }
1195
1196         my ($baseversion, $currversion) = get_openssl_version();
1197         my $thisversion;
1198         do {
1199                 if (!defined($thisversion)) {
1200                         $thisversion = $baseversion;
1201                 } else {
1202                         $thisversion = get_next_version($thisversion);
1203                 }
1204                 foreach $sym (@symbols) {
1205                         (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
1206                         my $v = 0;
1207                         $v = 1 if $i =~ /^.*?:.*?:VARIABLE/;
1208                         if (!defined($nums{$s})) {
1209                                 die "Error: $s does not have a number assigned\n"
1210                                         if(!$do_update);
1211                         } else {
1212                                 (my $n, my $symversion, my $dummy) = split /\\/, $nums{$s};
1213                                 next if $symversion ne $thisversion;
1214                                 my %pf = ();
1215                                 my $p = ($i =~ /^[^:]*:([^:]*):/,$1);
1216                                 my $a = ($i =~ /^[^:]*:[^:]*:[^:]*:([^:]*)/,$1);
1217                                 if (is_valid($p,1) && is_valid($a,0)) {
1218                                         my $s2 = ($s =~ /^(.*?)(\{[0-9]+\})?$/, $1);
1219                                         if ($prev eq $s2) {
1220                                                 print STDERR "Warning: Symbol '",$s2,
1221                                                         "' redefined. old=",($nums{$prev} =~ /^(.*?)\\/,$1),
1222                                                         ", new=",($nums{$s2} =~ /^(.*?)\\/,$1),"\n";
1223                                         }
1224                                         $prev = $s2;    # To warn about duplicates...
1225                                         if($linux) {
1226                                                 if ($symversion ne $prevsymversion) {
1227                                                         if ($prevsymversion ne "") {
1228                                                                 if ($prevprevsymversion ne "") {
1229                                                                         print OUT "} OPENSSL_"
1230                                                                                                 ."$prevprevsymversion;\n\n";
1231                                                                 } else {
1232                                                                         print OUT "};\n\n";
1233                                                                 }
1234                                                         }
1235                                                         print OUT "OPENSSL_$symversion {\n    global:\n";
1236                                                         $prevprevsymversion = $prevsymversion;
1237                                                         $prevsymversion = $symversion;
1238                                                 }
1239                                                 print OUT "        $s2;\n";
1240                                         } elsif ($VMS) {
1241                                             while(++$prevnum < $n) {
1242                                                 my $symline=" ,SPARE -\n  ,SPARE -\n";
1243                                                 if ($symvtextcount + length($symline) - 2 > 1024) {
1244                                                     print OUT ")\nSYMBOL_VECTOR=(-\n";
1245                                                     $symvtextcount = 16; # length of "SYMBOL_VECTOR=(-"
1246                                                 }
1247                                                 if ($symvtextcount == 16) {
1248                                                     # Take away first comma
1249                                                     $symline =~ s/,//;
1250                                                 }
1251                                                 print OUT $symline;
1252                                                 $symvtextcount += length($symline) - 2;
1253                                             }
1254                                             (my $s_uc = $s) =~ tr/a-z/A-Z/;
1255                                             my $symtype=
1256                                                 $v ? "DATA" : "PROCEDURE";
1257                                             my $symline=
1258                                                 ($s_uc ne $s
1259                                                  ? " ,$s_uc/$s=$symtype -\n  ,$s=$symtype -\n"
1260                                                  : " ,$s=$symtype -\n  ,SPARE -\n");
1261                                             if ($symvtextcount + length($symline) - 2 > 1024) {
1262                                                 print OUT ")\nSYMBOL_VECTOR=(-\n";
1263                                                 $symvtextcount = 16; # length of "SYMBOL_VECTOR=(-"
1264                                             }
1265                                             if ($symvtextcount == 16) {
1266                                                 # Take away first comma
1267                                                 $symline =~ s/,//;
1268                                             }
1269                                             print OUT $symline;
1270                                             $symvtextcount += length($symline) - 2;
1271                                         } elsif($v) {
1272                                                 printf OUT "    %s%-39s DATA\n",
1273                                                                 ($W32)?"":"_",$s2;
1274                                         } else {
1275                                                 printf OUT "    %s%s\n",
1276                                                                 ($W32)?"":"_",$s2;
1277                                         }
1278                                 }
1279                         }
1280                 }
1281         } while ($thisversion ne $currversion);
1282         if ($linux) {
1283                 if ($prevprevsymversion ne "") {
1284                         print OUT "    local: *;\n} OPENSSL_$prevprevsymversion;\n\n";
1285                 } else {
1286                         print OUT "    local: *;\n};\n\n";
1287                 }
1288         } elsif ($VMS) {
1289             print OUT ")\n";
1290             (my $libvmaj, my $libvmin, my $libvedit) =
1291                 $currversion =~ /^(\d+)_(\d+)_(\d+)$/;
1292             # The reason to multiply the edit number with 100 is to make space
1293             # for the possibility that we want to encode the patch letters
1294             print OUT "GSMATCH=LEQUAL,",($libvmaj * 100 + $libvmin),",",($libvedit * 100),"\n";
1295         }
1296         printf OUT "\n";
1297 }
1298
1299 sub load_numbers
1300 {
1301         my($name)=@_;
1302         my(@a,%ret);
1303         my $prevversion;
1304
1305         $max_num = 0;
1306         $num_noinfo = 0;
1307         $prev = "";
1308         $prev_cnt = 0;
1309
1310         my ($baseversion, $currversion) = get_openssl_version();
1311
1312         open(IN,"<$name") || die "unable to open $name:$!\n";
1313         while (<IN>) {
1314                 s|\R$||;        # Better chomp
1315                 s/#.*$//;
1316                 next if /^\s*$/;
1317                 @a=split;
1318                 if (defined $ret{$a[0]}) {
1319                         # This is actually perfectly OK
1320                         #print STDERR "Warning: Symbol '",$a[0],"' redefined. old=",$ret{$a[0]},", new=",$a[1],"\n";
1321                 }
1322                 if ($max_num > $a[1]) {
1323                         print STDERR "Warning: Number decreased from ",$max_num," to ",$a[1],"\n";
1324                 }
1325                 elsif ($max_num == $a[1]) {
1326                         # This is actually perfectly OK
1327                         #print STDERR "Warning: Symbol ",$a[0]," has same number as previous ",$prev,": ",$a[1],"\n";
1328                         if ($a[0] eq $prev) {
1329                                 $prev_cnt++;
1330                                 $a[0] .= "{$prev_cnt}";
1331                         }
1332                 }
1333                 else {
1334                         $prev_cnt = 0;
1335                 }
1336                 if ($#a < 2) {
1337                         # Existence will be proven later, in do_defs
1338                         $ret{$a[0]}=$a[1];
1339                         $num_noinfo++;
1340                 } else {
1341                         #Sanity check the version number
1342                         if (defined $prevversion) {
1343                                 check_version_lte($prevversion, $a[2]);
1344                         }
1345                         check_version_lte($a[2], $currversion);
1346                         $prevversion = $a[2];
1347                         $ret{$a[0]}=$a[1]."\\".$a[2]."\\".$a[3]; # \\ is a special marker
1348                 }
1349                 $max_num = $a[1] if $a[1] > $max_num;
1350                 $prev=$a[0];
1351         }
1352         if ($num_noinfo) {
1353                 print STDERR "Warning: $num_noinfo symbols were without info.";
1354                 if ($do_rewrite) {
1355                         printf STDERR "  The rewrite will fix this.\n";
1356                 } else {
1357                         printf STDERR "  You should do a rewrite to fix this.\n";
1358                 }
1359         }
1360         close(IN);
1361         return(%ret);
1362 }
1363
1364 sub parse_number
1365 {
1366         (my $str, my $what) = @_;
1367         (my $n, my $v, my $i) = split(/\\/,$str);
1368         if ($what eq "n") {
1369                 return $n;
1370         } else {
1371                 return $i;
1372         }
1373 }
1374
1375 sub rewrite_numbers
1376 {
1377         (*OUT,$name,*nums,@symbols)=@_;
1378         my $thing;
1379
1380         my @r = grep(/^\w+(\{[0-9]+\})?\\.*?:.*?:\w+\(\w+\)/,@symbols);
1381         my $r; my %r; my %rsyms;
1382         foreach $r (@r) {
1383                 (my $s, my $i) = split /\\/, $r;
1384                 my $a = $1 if $i =~ /^.*?:.*?:\w+\((\w+)\)/;
1385                 $i =~ s/^(.*?:.*?:\w+)\(\w+\)/$1/;
1386                 $r{$a} = $s."\\".$i;
1387                 $rsyms{$s} = 1;
1388         }
1389
1390         my %syms = ();
1391         foreach $_ (@symbols) {
1392                 (my $n, my $i) = split /\\/;
1393                 $syms{$n} = 1;
1394         }
1395
1396         my @s=sort {
1397             &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n")
1398             || $a cmp $b
1399         } keys %nums;
1400         foreach $sym (@s) {
1401                 (my $n, my $vers, my $i) = split /\\/, $nums{$sym};
1402                 next if defined($i) && $i =~ /^.*?:.*?:\w+\(\w+\)/;
1403                 next if defined($rsyms{$sym});
1404                 print STDERR "DEBUG: rewrite_numbers for sym = ",$sym,": i = ",$i,", n = ",$n,", rsym{sym} = ",$rsyms{$sym},"syms{sym} = ",$syms{$sym},"\n" if $debug;
1405                 $i="NOEXIST::FUNCTION:"
1406                         if !defined($i) || $i eq "" || !defined($syms{$sym});
1407                 my $s2 = $sym;
1408                 $s2 =~ s/\{[0-9]+\}$//;
1409                 printf OUT "%s%-39s %d\t%s\t%s\n","",$s2,$n,$vers,$i;
1410                 if (exists $r{$sym}) {
1411                         (my $s, $i) = split /\\/,$r{$sym};
1412                         my $s2 = $s;
1413                         $s2 =~ s/\{[0-9]+\}$//;
1414                         printf OUT "%s%-39s %d\t%s\t%s\n","",$s2,$n,$vers,$i;
1415                 }
1416         }
1417 }
1418
1419 sub update_numbers
1420 {
1421         (*OUT,$name,*nums,my $start_num, my @symbols)=@_;
1422         my $new_syms = 0;
1423         my $basevers;
1424         my $vers;
1425
1426         ($basevers, $vers) = get_openssl_version();
1427
1428         my @r = grep(/^\w+(\{[0-9]+\})?\\.*?:.*?:\w+\(\w+\)/,@symbols);
1429         my $r; my %r; my %rsyms;
1430         foreach $r (@r) {
1431                 (my $s, my $i) = split /\\/, $r;
1432                 my $a = $1 if $i =~ /^.*?:.*?:\w+\((\w+)\)/;
1433                 $i =~ s/^(.*?:.*?:\w+)\(\w+\)/$1/;
1434                 $r{$a} = $s."\\".$i;
1435                 $rsyms{$s} = 1;
1436         }
1437
1438         foreach $sym (@symbols) {
1439                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
1440                 next if $i =~ /^.*?:.*?:\w+\(\w+\)/;
1441                 next if defined($rsyms{$sym});
1442                 die "ERROR: Symbol $sym had no info attached to it."
1443                     if $i eq "";
1444                 if (!exists $nums{$s}) {
1445                         $new_syms++;
1446                         my $s2 = $s;
1447                         $s2 =~ s/\{[0-9]+\}$//;
1448                         printf OUT "%s%-39s %d\t%s\t%s\n","",$s2, ++$start_num,$vers,$i;
1449                         if (exists $r{$s}) {
1450                                 ($s, $i) = split /\\/,$r{$s};
1451                                 $s =~ s/\{[0-9]+\}$//;
1452                                 printf OUT "%s%-39s %d\t%s\t%s\n","",$s, $start_num,$vers,$i;
1453                         }
1454                 }
1455         }
1456         if($new_syms) {
1457                 print STDERR "$name: Added $new_syms new symbols\n";
1458         } else {
1459                 print STDERR "$name: No new symbols added\n";
1460         }
1461 }
1462
1463 sub check_existing
1464 {
1465         (*nums, my @symbols)=@_;
1466         my %existing; my @remaining;
1467         @remaining=();
1468         foreach $sym (@symbols) {
1469                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
1470                 $existing{$s}=1;
1471         }
1472         foreach $sym (keys %nums) {
1473                 if (!exists $existing{$sym}) {
1474                         push @remaining, $sym;
1475                 }
1476         }
1477         if(@remaining) {
1478                 print STDERR "The following symbols do not seem to exist:\n";
1479                 foreach $sym (@remaining) {
1480                         print STDERR "\t",$sym,"\n";
1481                 }
1482         }
1483 }
1484
1485 sub count_parens
1486 {
1487         my $line = shift(@_);
1488
1489         my $open = $line =~ tr/\(//;
1490         my $close = $line =~ tr/\)//;
1491
1492         return $open - $close;
1493 }
1494
1495 #Parse opensslv.h to get the current version number. Also work out the base
1496 #version, i.e. the lowest version number that is binary compatible with this
1497 #version
1498 sub get_openssl_version()
1499 {
1500         my $fn = catfile($config{sourcedir},"include","openssl","opensslv.h");
1501         open (IN, "$fn") || die "Can't open opensslv.h";
1502
1503         while(<IN>) {
1504                 if (/OPENSSL_VERSION_TEXT\s+"OpenSSL (\d\.\d\.)(\d[a-z]*)(-| )/) {
1505                         my $suffix = $2;
1506                         (my $baseversion = $1) =~ s/\./_/g;
1507                         close IN;
1508                         return ($baseversion."0", $baseversion.$suffix);
1509                 }
1510         }
1511         die "Can't find OpenSSL version number\n";
1512 }
1513
1514 #Given an OpenSSL version number, calculate the next version number. If the
1515 #version number gets to a.b.czz then we go to a.b.(c+1)
1516 sub get_next_version()
1517 {
1518         my $thisversion = shift;
1519
1520         my ($base, $letter) = $thisversion =~ /^(\d_\d_\d)([a-z]{0,2})$/;
1521
1522         if ($letter eq "zz") {
1523                 my $lastnum = substr($base, -1);
1524                 return substr($base, 0, length($base)-1).(++$lastnum);
1525         }
1526         return $base.get_next_letter($letter);
1527 }
1528
1529 #Given the letters off the end of an OpenSSL version string, calculate what
1530 #the letters for the next release would be.
1531 sub get_next_letter()
1532 {
1533         my $thisletter = shift;
1534         my $baseletter = "";
1535         my $endletter;
1536
1537         if ($thisletter eq "") {
1538                 return "a";
1539         }
1540         if ((length $thisletter) > 1) {
1541                 ($baseletter, $endletter) = $thisletter =~ /([a-z]+)([a-z])/;
1542         } else {
1543                 $endletter = $thisletter;
1544         }
1545
1546         if ($endletter eq "z") {
1547                 return $thisletter."a";
1548         } else {
1549                 return $baseletter.(++$endletter);
1550         }
1551 }
1552
1553 #Check if a version is less than or equal to the current version. Its a fatal
1554 #error if not. They must also only differ in letters, or the last number (i.e.
1555 #the first two numbers must be the same)
1556 sub check_version_lte()
1557 {
1558         my ($testversion, $currversion) = @_;
1559         my $lentv;
1560         my $lencv;
1561         my $cvbase;
1562
1563         my ($cvnums) = $currversion =~ /^(\d_\d_\d)[a-z]*$/;
1564         my ($tvnums) = $testversion =~ /^(\d_\d_\d)[a-z]*$/;
1565
1566         #Die if we can't parse the version numbers or they don't look sane
1567         die "Invalid version number: $testversion and $currversion\n"
1568                 if (!defined($cvnums) || !defined($tvnums)
1569                         || length($cvnums) != 5
1570                         || length($tvnums) != 5);
1571
1572         #If the base versions (without letters) don't match check they only differ
1573         #in the last number
1574         if ($cvnums ne $tvnums) {
1575                 die "Invalid version number: $testversion "
1576                         ."for current version $currversion\n"
1577                         if (substr($cvnums, 0, 4) ne substr($tvnums, 0, 4));
1578                 return;
1579         }
1580         #If we get here then the base version (i.e. the numbers) are the same - they
1581         #only differ in the letters
1582
1583         $lentv = length $testversion;
1584         $lencv = length $currversion;
1585
1586         #If the testversion has more letters than the current version then it must
1587         #be later (or malformed)
1588         if ($lentv > $lencv) {
1589                 die "Invalid version number: $testversion "
1590                         ."is greater than $currversion\n";
1591         }
1592
1593         #Get the last letter from the current version
1594         my ($cvletter) = $currversion =~ /([a-z])$/;
1595         if (defined $cvletter) {
1596                 ($cvbase) = $currversion =~ /(\d_\d_\d[a-z]*)$cvletter$/;
1597         } else {
1598                 $cvbase = $currversion;
1599         }
1600         die "Unable to parse version number $currversion" if (!defined $cvbase);
1601         my $tvbase;
1602         my ($tvletter) = $testversion =~ /([a-z])$/;
1603         if (defined $tvletter) {
1604                 ($tvbase) = $testversion =~ /(\d_\d_\d[a-z]*)$tvletter$/;
1605         } else {
1606                 $tvbase = $testversion;
1607         }
1608         die "Unable to parse version number $testversion" if (!defined $tvbase);
1609
1610         if ($lencv > $lentv) {
1611                 #If current version has more letters than testversion then testversion
1612                 #minus the final letter must be a substring of the current version
1613                 die "Invalid version number $testversion "
1614                         ."is greater than $currversion or is invalid\n"
1615                         if (index($cvbase, $tvbase) != 0);
1616         } else {
1617                 #If both versions have the same number of letters then they must be
1618                 #equal up to the last letter, and the last letter in testversion must
1619                 #be less than or equal to the last letter in current version.
1620                 die "Invalid version number $testversion "
1621                         ."is greater than $currversion\n"
1622                         if (($cvbase ne $tvbase) && ($tvletter gt $cvletter));
1623         }
1624 }
1625
1626 sub do_deprecated()
1627 {
1628         my ($decl, $plats, $algs) = @_;
1629         $decl =~ /^\s*(DEPRECATEDIN_\d+_\d+_\d+)\s*\((.*)\)\s*$/
1630             or die "Bad DEPRECTEDIN: $decl\n";
1631         my $info1 .= "#INFO:";
1632         $info1 .= join(',', @{$plats}) . ":";
1633         my $info2 = $info1;
1634         $info1 .= join(',',@{$algs}, $1) . ";";
1635         $info2 .= join(',',@{$algs}) . ";";
1636         return $info1 . $2 . ";" . $info2;
1637 }