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