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