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