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