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