Comment correction.
[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 # Previously, they had the following format:
10 #
11 #       routine-name    nnnn
12 #
13 # But that isn't enough for a number of reasons, the first on being that
14 # this format is (needlessly) very Win32-centric, and even then...
15 # One of the biggest problems is that there's no information about what
16 # routines should actually be used, which varies with what crypto algorithms
17 # are disabled.  Also, some operating systems (for example VMS with VAX C)
18 # need to keep track of the global variables as well as the functions.
19 #
20 # So, a remake of this script is done so as to include information on the
21 # kind of symbol it is (function or variable) and what algorithms they're
22 # part of.  This will allow easy translating to .def files or the corresponding
23 # file in other operating systems (a .opt file for VMS, possibly with a .mar
24 # file).
25 #
26 # The format now becomes:
27 #
28 #       routine-name    nnnn    info
29 #
30 # and the "info" part is actually a colon-separated string of fields with
31 # the following meaning:
32 #
33 #       existence:platform:kind:algorithms
34 #
35 # - "existence" can be "EXIST" or "NOEXIST" depending on if the symbol is
36 #   found somewhere in the source, 
37 # - "platforms" is empty if it exists on all platforms, otherwise it contains
38 #   comma-separated list of the platform, just as they are if the symbol exists
39 #   for those platforms, or prepended with a "!" if not.  This helps resolve
40 #   symbol name replacements for platforms where the names are too long for the
41 #   compiler or linker, or if the systems is case insensitive and there is a
42 #   clash.  This script assumes those redefinitions are place in the file
43 #   crypto/symhacks.h.
44 #   The semantics for the platforms list is a bit complicated.  The rule of
45 #   thumb is that the list is exclusive, but it seems to mean different things.
46 #   So, if the list is all negatives (like "!VMS,!WIN16"), the symbol exists
47 #   on all platforms except those listed.  If the list is all positives (like
48 #   "VMS,WIN16"), the symbol exists only on those platforms and nowhere else.
49 #   The combination of positives and negatives will act as if the positives
50 #   weren't there.
51 # - "kind" is "FUNCTION" or "VARIABLE".  The meaning of that is obvious.
52 # - "algorithms" is a comma-separated list of algorithm names.  This helps
53 #   exclude symbols that are part of an algorithm that some user wants to
54 #   exclude.
55 #
56
57 my $crypto_num= "util/libeay.num";
58 my $ssl_num=    "util/ssleay.num";
59
60 my $do_update = 0;
61 my $do_rewrite = 0;
62 my $do_crypto = 0;
63 my $do_ssl = 0;
64 my $do_ctest = 0;
65 my $do_ctestall = 0;
66 my $rsaref = 0;
67
68 my $VMS=0;
69 my $W32=0;
70 my $W16=0;
71 my $NT=0;
72 # Set this to make typesafe STACK definitions appear in DEF
73 my $safe_stack_def = 0;
74
75 my @known_platforms = ( "__FreeBSD__", "VMS", "WIN16", "WIN32",
76                         "WINNT", "PERL5", "NeXT" );
77 my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
78                          "CAST", "MD2", "MD4", "MD5", "SHA", "RIPEMD",
79                          "MDC2", "RSA", "DSA", "DH", "HMAC", "FP_API",
80                          "RIJNDAEL" );
81
82 my $options="";
83 open(IN,"<Makefile.ssl") || die "unable to open Makefile.ssl!\n";
84 while(<IN>) {
85     $options=$1 if (/^OPTIONS=(.*)$/);
86 }
87 close(IN);
88
89 # The following ciphers may be excluded (by Configure). This means functions
90 # defined with ifndef(NO_XXX) are not included in the .def file, and everything
91 # in directory xxx is ignored.
92 my $no_rc2; my $no_rc4; my $no_rc5; my $no_idea; my $no_des; my $no_bf;
93 my $no_cast;
94 my $no_md2; my $no_md4; my $no_md5; my $no_sha; my $no_ripemd; my $no_mdc2;
95 my $no_rsa; my $no_dsa; my $no_dh; my $no_hmac=0; my $no_rijndael;
96 my $no_fp_api;
97
98 foreach (@ARGV, split(/ /, $options))
99         {
100         $W32=1 if $_ eq "32";
101         $W16=1 if $_ eq "16";
102         if($_ eq "NT") {
103                 $W32 = 1;
104                 $NT = 1;
105         }
106         $VMS=1 if $_ eq "VMS";
107         #$rsaref=1 if $_ eq "rsaref";
108
109         $do_ssl=1 if $_ eq "ssleay";
110         $do_ssl=1 if $_ eq "ssl";
111         $do_crypto=1 if $_ eq "libeay";
112         $do_crypto=1 if $_ eq "crypto";
113         $do_update=1 if $_ eq "update";
114         $do_rewrite=1 if $_ eq "rewrite";
115         $do_ctest=1 if $_ eq "ctest";
116         $do_ctestall=1 if $_ eq "ctestall";
117         #$safe_stack_def=1 if $_ eq "-DDEBUG_SAFESTACK";
118
119         if    (/^no-rc2$/)      { $no_rc2=1; }
120         elsif (/^no-rc4$/)      { $no_rc4=1; }
121         elsif (/^no-rc5$/)      { $no_rc5=1; }
122         elsif (/^no-idea$/)     { $no_idea=1; }
123         elsif (/^no-des$/)      { $no_des=1; $no_mdc2=1; }
124         elsif (/^no-bf$/)       { $no_bf=1; }
125         elsif (/^no-cast$/)     { $no_cast=1; }
126         elsif (/^no-md2$/)      { $no_md2=1; }
127         elsif (/^no-md4$/)      { $no_md4=1; }
128         elsif (/^no-md5$/)      { $no_md5=1; }
129         elsif (/^no-sha$/)      { $no_sha=1; }
130         elsif (/^no-ripemd$/)   { $no_ripemd=1; }
131         elsif (/^no-mdc2$/)     { $no_mdc2=1; }
132         elsif (/^no-rsa$/)      { $no_rsa=1; }
133         elsif (/^no-dsa$/)      { $no_dsa=1; }
134         elsif (/^no-dh$/)       { $no_dh=1; }
135         elsif (/^no-hmac$/)     { $no_hmac=1; }
136         elsif (/^no-rijndael$/) { $no_rijndael=1; }
137         }
138
139
140 # If no platform is given, assume WIN32
141 if ($W32 + $W16 + $VMS == 0) {
142         $W32 = 1;
143 }
144
145 # Add extra knowledge
146 if ($W16) {
147         $no_fp_api=1;
148 }
149
150 if (!$do_ssl && !$do_crypto)
151         {
152         print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT ]\n";
153         exit(1);
154         }
155
156 %ssl_list=&load_numbers($ssl_num);
157 $max_ssl = $max_num;
158 %crypto_list=&load_numbers($crypto_num);
159 $max_crypto = $max_num;
160
161 my $ssl="ssl/ssl.h";
162
163 my $crypto ="crypto/crypto.h";
164 $crypto.=" crypto/des/des.h" unless $no_des;
165 $crypto.=" crypto/idea/idea.h" unless $no_idea;
166 $crypto.=" crypto/rc4/rc4.h" unless $no_rc4;
167 $crypto.=" crypto/rc5/rc5.h" unless $no_rc5;
168 $crypto.=" crypto/rc2/rc2.h" unless $no_rc2;
169 $crypto.=" crypto/bf/blowfish.h" unless $no_bf;
170 $crypto.=" crypto/cast/cast.h" unless $no_cast;
171 $crypto.=" crypto/md2/md2.h" unless $no_md2;
172 $crypto.=" crypto/md4/md4.h" unless $no_md4;
173 $crypto.=" crypto/md5/md5.h" unless $no_md5;
174 $crypto.=" crypto/mdc2/mdc2.h" unless $no_mdc2;
175 $crypto.=" crypto/sha/sha.h" unless $no_sha;
176 $crypto.=" crypto/ripemd/ripemd.h" unless $no_ripemd;
177 $crypto.=" crypto/rijndael/rijndael.h" unless $no_rijndael;
178 $crypto.=" crypto/rijndael/rd_fst.h" unless $no_rijndael;
179
180 $crypto.=" crypto/bn/bn.h";
181 $crypto.=" crypto/rsa/rsa.h" unless $no_rsa;
182 $crypto.=" crypto/dsa/dsa.h" unless $no_dsa;
183 $crypto.=" crypto/dh/dh.h" unless $no_dh;
184 $crypto.=" crypto/hmac/hmac.h" unless $no_hmac;
185
186 $crypto.=" crypto/engine/engine.h";
187 $crypto.=" crypto/stack/stack.h";
188 $crypto.=" crypto/buffer/buffer.h";
189 $crypto.=" crypto/bio/bio.h";
190 $crypto.=" crypto/dso/dso.h";
191 $crypto.=" crypto/lhash/lhash.h";
192 $crypto.=" crypto/conf/conf.h";
193 $crypto.=" crypto/txt_db/txt_db.h";
194
195 $crypto.=" crypto/evp/evp.h";
196 $crypto.=" crypto/objects/objects.h";
197 $crypto.=" crypto/pem/pem.h";
198 #$crypto.=" crypto/meth/meth.h";
199 $crypto.=" crypto/asn1/asn1.h";
200 $crypto.=" crypto/asn1/asn1t.h";
201 $crypto.=" crypto/asn1/asn1_mac.h";
202 $crypto.=" crypto/err/err.h";
203 $crypto.=" crypto/pkcs7/pkcs7.h";
204 $crypto.=" crypto/pkcs12/pkcs12.h";
205 $crypto.=" crypto/x509/x509.h";
206 $crypto.=" crypto/x509/x509_vfy.h";
207 $crypto.=" crypto/x509v3/x509v3.h";
208 $crypto.=" crypto/rand/rand.h";
209 $crypto.=" crypto/comp/comp.h";
210 $crypto.=" crypto/ocsp/ocsp.h";
211 $crypto.=" crypto/tmdiff.h";
212
213 my $symhacks="crypto/symhacks.h";
214
215 my @ssl_symbols = &do_defs("SSLEAY", $ssl, $symhacks);
216 my @crypto_symbols = &do_defs("LIBEAY", $crypto, $symhacks);
217
218 if ($do_update) {
219
220 if ($do_ssl == 1) {
221
222         &maybe_add_info("SSLEAY",*ssl_list,@ssl_symbols);
223         if ($do_rewrite == 1) {
224                 open(OUT, ">$ssl_num");
225                 &rewrite_numbers(*OUT,"SSLEAY",*ssl_list,@ssl_symbols);
226                 close OUT;
227         } else {
228                 open(OUT, ">>$ssl_num");
229         }
230         &update_numbers(*OUT,"SSLEAY",*ssl_list,$max_ssl,@ssl_symbols);
231         close OUT;
232 }
233
234 if($do_crypto == 1) {
235
236         &maybe_add_info("LIBEAY",*crypto_list,@crypto_symbols);
237         if ($do_rewrite == 1) {
238                 open(OUT, ">$crypto_num");
239                 &rewrite_numbers(*OUT,"LIBEAY",*crypto_list,@crypto_symbols);
240         } else {
241                 open(OUT, ">>$crypto_num");
242         }
243         &update_numbers(*OUT,"LIBEAY",*crypto_list,$max_crypto,@crypto_symbols);
244         close OUT;
245
246
247 } elsif ($do_ctest || $do_ctestall) {
248
249         print <<"EOF";
250
251 /* Test file to check all DEF file symbols are present by trying
252  * to link to all of them. This is *not* intended to be run!
253  */
254
255 int main()
256 {
257 EOF
258         &print_test_file(*STDOUT,"SSLEAY",*ssl_list,$do_ctestall,@ssl_symbols)
259                 if $do_ssl == 1;
260
261         &print_test_file(*STDOUT,"LIBEAY",*crypto_list,$do_ctestall,@crypto_symbols)
262                 if $do_crypto == 1;
263
264         print "}\n";
265
266 } else {
267
268         &print_def_file(*STDOUT,"SSLEAY",*ssl_list,@ssl_symbols)
269                 if $do_ssl == 1;
270
271         &print_def_file(*STDOUT,"LIBEAY",*crypto_list,@crypto_symbols)
272                 if $do_crypto == 1;
273
274 }
275
276
277 sub do_defs
278 {
279         my($name,$files,$symhacksfile)=@_;
280         my $file;
281         my @ret;
282         my %syms;
283         my %platform;           # For anything undefined, we assume ""
284         my %kind;               # For anything undefined, we assume "FUNCTION"
285         my %algorithm;          # For anything undefined, we assume ""
286         my %rename;
287         my $cpp;
288
289         foreach $file (split(/\s+/,$symhacksfile." ".$files))
290                 {
291                 open(IN,"<$file") || die "unable to open $file:$!\n";
292                 my $line = "", my $def= "";
293                 my %tag = (
294                         (map { $_ => 0 } @known_platforms),
295                         (map { "NO_".$_ => 0 } @known_algorithms),
296                         NOPROTO         => 0,
297                         PERL5           => 0,
298                         _WINDLL         => 0,
299                         CONST_STRICT    => 0,
300                         TRUE            => 1,
301                 );
302                 my $symhacking = $file eq $symhacksfile;
303                 while(<IN>) {
304                         last if (/BEGIN ERROR CODES/);
305                         if ($line ne '') {
306                                 $_ = $line . $_;
307                                 $line = '';
308                         }
309
310                         if (/\\$/) {
311                                 $line = $_;
312                                 next;
313                         }
314
315                         $cpp = 1 if /^\#.*ifdef.*cplusplus/;
316                         if ($cpp) {
317                                 $cpp = 0 if /^\#.*endif/;
318                                 next;
319                         }
320
321                         s/\/\*.*?\*\///gs;                   # ignore comments
322                         s/{[^{}]*}//gs;                      # ignore {} blocks
323                         if (/^\#\s*ifndef (.*)/) {
324                                 push(@tag,$1);
325                                 $tag{$1}=-1;
326                         } elsif (/^\#\s*if !defined\(([^\)]+)\)/) {
327                                 push(@tag,$1);
328                                 $tag{$1}=-1;
329                         } elsif (/^\#\s*ifdef (.*)/) {
330                                 push(@tag,$1);
331                                 $tag{$1}=1;
332                         } elsif (/^\#\s*if defined\(([^\)]+)\)/) {
333                                 push(@tag,$1);
334                                 $tag{$1}=1;
335                         } elsif (/^\#\s*error\s+(\w+) is disabled\./) {
336                                 if ($tag[$#tag] eq "NO_".$1) {
337                                         $tag{$tag[$#tag]}=2;
338                                 }
339                         } elsif (/^\#\s*endif/) {
340                                 if ($tag{$tag[$#tag]}==2) {
341                                         $tag{$tag[$#tag]}=-1;
342                                 } else {
343                                         $tag{$tag[$#tag]}=0;
344                                 }
345                                 pop(@tag);
346                         } elsif (/^\#\s*else/) {
347                                 my $t=$tag[$#tag];
348                                 $tag{$t}= -$tag{$t};
349                         } elsif (/^\#\s*if\s+1/) {
350                                 # Dummy tag
351                                 push(@tag,"TRUE");
352                                 $tag{"TRUE"}=1;
353                         } elsif (/^\#\s*if\s+0/) {
354                                 # Dummy tag
355                                 push(@tag,"TRUE");
356                                 $tag{"TRUE"}=-1;
357                         } elsif (/^\#\s*define\s+(\w+)\s+(\w+)/
358                                  && $symhacking) {
359                                 my $s = $1;
360                                 my $a =
361                                     $2.":".join(",", grep(!/^$/,
362                                                           map { $tag{$_} == 1 ?
363                                                                     $_ : "" }
364                                                           @known_platforms));
365                                 $rename{$s} = $a;
366                         }
367                         if (/^\#/) {
368                                 my @p = grep(!/^$/,
369                                              map { $tag{$_} == 1 ? $_ :
370                                                        $tag{$_} == -1 ? "!".$_  : "" }
371                                              @known_platforms);
372                                 my @a = grep(!/^$/,
373                                              map { $tag{"NO_".$_} == -1 ? $_ : "" }
374                                              @known_algorithms);
375                                 $def .= "#INFO:".join(',',@p).":".join(',',@a).";";
376                                 next;
377                         }
378                         if (/^\s*DECLARE_STACK_OF\s*\(\s*(\w*)\s*\)/) {
379                                 next;
380                         } elsif (/^\s*DECLARE_ASN1_FUNCTIONS\s*\(\s*(\w*)\s*\)/) {
381                                 $syms{"d2i_$1"} = 1;
382                                 $syms{"i2d_$1"} = 1;
383                                 $syms{"$1_new"} = 1;
384                                 $syms{"$1_free"} = 1;
385                                 $syms{"$1_it"} = 1;
386                                 $kind{"$1_it"} = "VARIABLE";
387                                 next;
388                         } elsif (/^\s*DECLARE_PKCS12_STACK_OF\s*\(\s*(\w*)\s*\)/) {
389                                 next;
390                         } elsif (/^\s*DECLARE_ASN1_SET_OF\s*\(\s*(\w*)\s*\)/) {
391                                 next;
392                         } elsif (/^DECLARE_PEM_rw\s*\(\s*(\w*)\s*,/ ||
393                                  /^DECLARE_PEM_rw_cb\s*\(\s*(\w*)\s*,/ ) {
394                                 # Things not in Win16
395                                 $syms{"PEM_read_${1}"} = 1;
396                                 $platform{"PEM_read_${1}"} = "!WIN16";
397                                 $syms{"PEM_write_${1}"} = 1;
398                                 $platform{"PEM_write_${1}"} = "!WIN16";
399                                 # Things that are everywhere
400                                 $syms{"PEM_read_bio_${1}"} = 1;
401                                 $syms{"PEM_write_bio_${1}"} = 1;
402                                 if ($1 eq "RSAPrivateKey" ||
403                                     $1 eq "RSAPublicKey" ||
404                                     $1 eq "RSA_PUBKEY") {
405                                         $algorithm{"PEM_read_${1}"} = "RSA";
406                                         $algorithm{"PEM_write_${1}"} = "RSA";
407                                         $algorithm{"PEM_read_bio_${1}"} = "RSA";
408                                         $algorithm{"PEM_write_bio_${1}"} = "RSA";
409                                 }
410                                 elsif ($1 eq "DSAPrivateKey" ||
411                                        $1 eq "DSAparams" ||
412                                        $1 eq "RSA_PUBKEY") {
413                                         $algorithm{"PEM_read_${1}"} = "DSA";
414                                         $algorithm{"PEM_write_${1}"} = "DSA";
415                                         $algorithm{"PEM_read_bio_${1}"} = "DSA";
416                                         $algorithm{"PEM_write_bio_${1}"} = "DSA";
417                                 }
418                                 elsif ($1 eq "DHparams") {
419                                         $algorithm{"PEM_read_${1}"} = "DH";
420                                         $algorithm{"PEM_write_${1}"} = "DH";
421                                         $algorithm{"PEM_read_bio_${1}"} = "DH";
422                                         $algorithm{"PEM_write_bio_${1}"} = "DH";
423                                 }
424                         } elsif (/^DECLARE_PEM_write\s*\(\s*(\w*)\s*,/ ||
425                                      /^DECLARE_PEM_write_cb\s*\(\s*(\w*)\s*,/ ) {
426                                 # Things not in Win16
427                                 $syms{"PEM_write_${1}"} = 1;
428                                 $platform{"PEM_write_${1}"} .= ",!WIN16";
429                                 # Things that are everywhere
430                                 $syms{"PEM_write_bio_${1}"} = 1;
431                                 if ($1 eq "RSAPrivateKey" ||
432                                     $1 eq "RSAPublicKey" ||
433                                     $1 eq "RSA_PUBKEY") {
434                                         $algorithm{"PEM_write_${1}"} = "RSA";
435                                         $algorithm{"PEM_write_bio_${1}"} = "RSA";
436                                 }
437                                 elsif ($1 eq "DSAPrivateKey" ||
438                                        $1 eq "DSAparams" ||
439                                        $1 eq "RSA_PUBKEY") {
440                                         $algorithm{"PEM_write_${1}"} = "DSA";
441                                         $algorithm{"PEM_write_bio_${1}"} = "DSA";
442                                 }
443                                 elsif ($1 eq "DHparams") {
444                                         $algorithm{"PEM_write_${1}"} = "DH";
445                                         $algorithm{"PEM_write_bio_${1}"} = "DH";
446                                 }
447                         } elsif (/^DECLARE_PEM_read\s*\(\s*(\w*)\s*,/ ||
448                                      /^DECLARE_PEM_read_cb\s*\(\s*(\w*)\s*,/ ) {
449                                 # Things not in Win16
450                                 $syms{"PEM_read_${1}"} = 1;
451                                 $platform{"PEM_read_${1}"} .= ",!WIN16";
452                                 # Things that are everywhere
453                                 $syms{"PEM_read_bio_${1}"} = 1;
454                         } elsif (
455                                 ($tag{'TRUE'} != -1)
456                                 && ($tag{'CONST_STRICT'} != 1)
457                                  )
458                                 {
459                                         if (/\{|\/\*|\([^\)]*$/) {
460                                                 $line = $_;
461                                         } else {
462                                                 $def .= $_;
463                                         }
464                                 }
465                         }
466                 close(IN);
467
468                 my $algs;
469                 my $plays;
470
471                 foreach (split /;/, $def) {
472                         my $s; my $k = "FUNCTION"; my $p; my $a;
473                         s/^[\n\s]*//g;
474                         s/[\n\s]*$//g;
475                         next if(/\#undef/);
476                         next if(/typedef\W/);
477                         next if(/\#define/);
478
479                         if (/^\#INFO:([^:]*):(.*)$/) {
480                                 $plats = $1;
481                                 $algs = $2;
482                                 next;
483                         } elsif (/^\s*OPENSSL_EXTERN\s.*?(\w+)(\[[0-9]*\])*\s*$/) {
484                                 $s = $1;
485                                 $k = "VARIABLE";
486                         } elsif (/\(\*(\w*)\([^\)]+/) {
487                                 $s = $1;
488                         } elsif (/\w+\W+(\w+)\W*\(\s*\)$/s) {
489                                 # K&R C
490                                 next;
491                         } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
492                                 while (not /\(\)$/s) {
493                                         s/[^\(\)]*\)$/\)/s;
494                                         s/\([^\(\)]*\)\)$/\)/s;
495                                 }
496                                 s/\(void\)//;
497                                 /(\w+)\W*\(\)/s;
498                                 $s = $1;
499                         } elsif (/\(/ and not (/=/)) {
500                                 print STDERR "File $file: cannot parse: $_;\n";
501                                 next;
502                         } else {
503                                 next;
504                         }
505
506                         $syms{$s} = 1;
507                         $kind{$s} = $k;
508
509                         $p = $plats;
510                         $a = $algs;
511                         $a .= ",BF" if($s =~ /EVP_bf/);
512                         $a .= ",CAST" if($s =~ /EVP_cast/);
513                         $a .= ",DES" if($s =~ /EVP_des/);
514                         $a .= ",DSA" if($s =~ /EVP_dss/);
515                         $a .= ",IDEA" if($s =~ /EVP_idea/);
516                         $a .= ",MD2" if($s =~ /EVP_md2/);
517                         $a .= ",MD4" if($s =~ /EVP_md4/);
518                         $a .= ",MD5" if($s =~ /EVP_md5/);
519                         $a .= ",RC2" if($s =~ /EVP_rc2/);
520                         $a .= ",RC4" if($s =~ /EVP_rc4/);
521                         $a .= ",RC5" if($s =~ /EVP_rc5/);
522                         $a .= ",RIPEMD" if($s =~ /EVP_ripemd/);
523                         $a .= ",SHA" if($s =~ /EVP_sha/);
524                         $a .= ",RSA" if($s =~ /EVP_(Open|Seal)(Final|Init)/);
525                         $a .= ",RSA" if($s =~ /PEM_Seal(Final|Init|Update)/);
526                         $a .= ",RSA" if($s =~ /RSAPrivateKey/);
527                         $a .= ",RSA" if($s =~ /SSLv23?_((client|server)_)?method/);
528
529                         $platform{$s} .= ','.$p;
530                         $algorithm{$s} .= ','.$a;
531
532                         if (defined($rename{$s})) {
533                                 (my $r, my $p) = split(/:/,$rename{$s});
534                                 my @ip = map { /^!(.*)$/ ? $1 : "!".$_ } split /,/, $p;
535                                 $syms{$r} = 1;
536                                 $kind{$r} = $kind{$s}."(".$s.")";
537                                 $algorithm{$r} = $algorithm{$s};
538                                 $platform{$r} = $platform{$s}.",".$p;
539                                 $platform{$s} .= ','.join(',', @ip).','.join(',', @ip);
540                         }
541                 }
542         }
543
544         # Prune the returned symbols
545
546         $platform{"crypt"} .= ",!PERL5,!__FreeBSD__,!NeXT";
547
548         delete $syms{"SSL_add_dir_cert_subjects_to_stack"};
549         delete $syms{"bn_dump1"};
550
551         $platform{"BIO_s_file_internal"} .= ",WIN16";
552         $platform{"BIO_new_file_internal"} .= ",WIN16";
553         $platform{"BIO_new_fp_internal"} .= ",WIN16";
554
555         $platform{"BIO_s_file"} .= ",!WIN16";
556         $platform{"BIO_new_file"} .= ",!WIN16";
557         $platform{"BIO_new_fp"} .= ",!WIN16";
558
559         $platform{"BIO_s_log"} .= ",!WIN32,!WIN16,!macintosh";
560
561         if(exists $syms{"ERR_load_CRYPTO_strings"}) {
562                 $platform{"ERR_load_CRYPTO_strings"} .= ",!VMS,!WIN16";
563                 $syms{"ERR_load_CRYPTOlib_strings"} = 1;
564                 $platform{"ERR_load_CRYPTOlib_strings"} .= ",VMS,WIN16";
565         }
566
567         # Info we know about
568
569         $platform{"RSA_PKCS1_RSAref"} = "RSAREF";
570         $algorithm{"RSA_PKCS1_RSAref"} = "RSA";
571
572         push @ret, map { $_."\\".&info_string($_,"EXIST",
573                                               $platform{$_},
574                                               $kind{$_},
575                                               $algorithm{$_}) } keys %syms;
576
577         return(@ret);
578 }
579
580 sub info_string {
581         (my $symbol, my $exist, my $platforms, my $kind, my $algorithms) = @_;
582
583         my %a = defined($algorithms) ?
584             map { $_ => 1 } split /,/, $algorithms : ();
585         my $pl = defined($platforms) ? $platforms : "";
586         my %p = map { $_ => 0 } split /,/, $pl;
587         my $k = defined($kind) ? $kind : "FUNCTION";
588         my $ret;
589
590         # We do this, because if there's code like the following, it really
591         # means the function exists in all cases and should therefore be
592         # everywhere.  By increasing and decreasing, we may attain 0:
593         #
594         # ifndef WIN16
595         #    int foo();
596         # else
597         #    int _fat foo();
598         # endif
599         foreach $platform (split /,/, $pl) {
600                 if ($platform =~ /^!(.*)$/) {
601                         $p{$1}--;
602                 } else {
603                         $p{$platform}++;
604                 }
605         }
606         foreach $platform (keys %p) {
607                 if ($p{$platform} == 0) { delete $p{$platform}; }
608         }
609
610         delete $p{""};
611         delete $a{""};
612
613         $ret = $exist;
614         $ret .= ":".join(',',map { $p{$_} < 0 ? "!".$_ : $_ } keys %p);
615         $ret .= ":".$k;
616         $ret .= ":".join(',',keys %a);
617         return $ret;
618 }
619
620 sub maybe_add_info {
621         (my $name, *nums, my @symbols) = @_;
622         my $sym;
623         my $new_info = 0;
624         my %syms=();
625
626         print STDERR "Updating $name info\n";
627         foreach $sym (@symbols) {
628                 (my $s, my $i) = split /\\/, $sym;
629                 $i =~ s/^(.*?:.*?:\w+)(\(\w+\))?/$1/;
630                 if (defined($nums{$s})) {
631                         (my $n, my $dummy) = split /\\/, $nums{$s};
632                         if (!defined($dummy) || $i ne $dummy) {
633                                 $nums{$s} = $n."\\".$i;
634                                 $new_info++;
635                                 #print STDERR "DEBUG: maybe_add_info for $s: \"$dummy\" => \"$i\"\n";
636                         }
637                 }
638                 $syms{sym} = 1;
639         }
640
641         my @s=sort { &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n") } keys %nums;
642         foreach $sym (@s) {
643                 (my $n, my $i) = split /\\/, $nums{$sym};
644                 if (!defined($syms{sym})) {
645                         $new_info++;
646                         #print STDERR "DEBUG: maybe_add_info for $sym: -> undefined\n";
647                 }
648         }
649         if ($new_info) {
650                 print STDERR "$new_info old symbols got an info update\n";
651                 if (!$do_rewrite) {
652                         print STDERR "You should do a rewrite to fix this.\n";
653                 }
654         } else {
655                 print STDERR "No old symbols needed info update\n";
656         }
657 }
658
659 sub print_test_file
660 {
661         (*OUT,my $name,*nums,my @symbols)=@_;
662         my $n = 1; my @e; my @r;
663         my $sym; my $prev = ""; my $prefSSLeay;
664
665         (@e)=grep(/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
666         (@r)=grep(/^\w+\\.*?:.*?:FUNCTION/ && !/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
667         @symbols=((sort @e),(sort @r));
668
669         foreach $sym (@symbols) {
670                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
671                 if ($s ne $prev) {
672                         if (!defined($nums{$sym})) {
673                                 printf STDERR "Warning: $sym does not have a number assigned\n"
674                                                 if(!$do_update);
675                         } else {
676                                 $n=$nums{$s};
677                                 print OUT "\t$s();\n";
678                         }
679                 }
680                 $prev = $s;     # To avoid duplicates...
681         }
682 }
683
684 sub print_def_file
685 {
686         (*OUT,my $name,*nums,my @symbols)=@_;
687         my $n = 1; my @e; my @r; my @v;
688
689         if ($W32)
690                 { $name.="32"; }
691         else
692                 { $name.="16"; }
693
694         print OUT <<"EOF";
695 ;
696 ; Definition file for the DLL version of the $name library from OpenSSL
697 ;
698
699 LIBRARY         $name
700
701 DESCRIPTION     'OpenSSL $name - http://www.openssl.org/'
702
703 EOF
704
705         if (!$W32) {
706                 print <<"EOF";
707 CODE            PRELOAD MOVEABLE
708 DATA            PRELOAD MOVEABLE SINGLE
709
710 EXETYPE         WINDOWS
711
712 HEAPSIZE        4096
713 STACKSIZE       8192
714
715 EOF
716         }
717
718         print "EXPORTS\n";
719
720         (@e)=grep(/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
721         (@r)=grep(/^\w+\\.*?:.*?:FUNCTION/ && !/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
722         (@v)=grep(/^\w+\\.*?:.*?:VARIABLE/,@symbols);
723         @symbols=((sort @e),(sort @r), (sort @v));
724
725
726         foreach $sym (@symbols) {
727                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
728                 my $v = 0;
729                 $v = 1 if $sym=~ /^\w+\\.*?:.*?:VARIABLE/;
730                 if (!defined($nums{$s})) {
731                         printf STDERR "Warning: $s does not have a number assigned\n"
732                                         if(!$do_update);
733                 } else {
734                         (my $n, my $i) = split /\\/, $nums{$s};
735                         my %pf = ();
736                         my @p = split(/,/, ($i =~ /^[^:]*:([^:]*):/,$1));
737                         my @a = split(/,/, ($i =~ /^[^:]*:[^:]*:[^:]*:([^:]*)/,$1));
738                         # @p_purged must contain hardware platforms only
739                         my @p_purged = ();
740                         foreach $ptmp (@p) {
741                                 next if $ptmp =~ /^!?RSAREF$/;
742                                 push @p_purged, $ptmp;
743                         }
744                         my $negatives = !!grep(/^!/,@p);
745                         # It is very important to check NT before W32
746                         if ((($NT && (!@p_purged
747                                       || (!$negatives && grep(/^WINNT$/,@p))
748                                       || ($negatives && !grep(/^!WINNT$/,@p))))
749                              || ($W32 && (!@p_purged
750                                           || (!$negatives && grep(/^WIN32$/,@p))
751                                           || ($negatives && !grep(/^!WIN32$/,@p))))
752                              || ($W16 && (!@p_purged
753                                           || (!$negatives && grep(/^WIN16$/,@p))
754                                           || ($negatives && !grep(/^!WIN16$/,@p)))))
755                             && (!@p
756                                 || (!$negatives
757                                     && ($rsaref || !grep(/^RSAREF$/,@p)))
758                                 || ($negatives
759                                     && (!$rsaref || !grep(/^!RSAREF$/,@p))))
760                             && (!@a || (!$no_rc2 || !grep(/^RC2$/,@a)))
761                             && (!@a || (!$no_rc4 || !grep(/^RC4$/,@a)))
762                             && (!@a || (!$no_rc5 || !grep(/^RC5$/,@a)))
763                             && (!@a || (!$no_idea || !grep(/^IDEA$/,@a)))
764                             && (!@a || (!$no_des || !grep(/^DES$/,@a)))
765                             && (!@a || (!$no_bf || !grep(/^BF$/,@a)))
766                             && (!@a || (!$no_cast || !grep(/^CAST$/,@a)))
767                             && (!@a || (!$no_md2 || !grep(/^MD2$/,@a)))
768                             && (!@a || (!$no_md4 || !grep(/^MD4$/,@a)))
769                             && (!@a || (!$no_md5 || !grep(/^MD5$/,@a)))
770                             && (!@a || (!$no_sha || !grep(/^SHA$/,@a)))
771                             && (!@a || (!$no_ripemd || !grep(/^RIPEMD$/,@a)))
772                             && (!@a || (!$no_mdc2 || !grep(/^MDC2$/,@a)))
773                             && (!@a || (!$no_rsa || !grep(/^RSA$/,@a)))
774                             && (!@a || (!$no_dsa || !grep(/^DSA$/,@a)))
775                             && (!@a || (!$no_dh || !grep(/^DH$/,@a)))
776                             && (!@a || (!$no_hmac || !grep(/^HMAC$/,@a)))
777                             && (!@a || (!$no_rijndael || !grep(/^RIJNDAEL$/,@a)))
778                             && (!@a || (!$no_fp_api || !grep(/^FP_API$/,@a)))
779                             ) {
780                                 if($v) {
781                                         printf OUT "    %s%-40s@%-8d DATA\n",($W32)?"":"_",$s,$n;
782                                 } else {
783                                         printf OUT "    %s%-40s@%d\n",($W32)?"":"_",$s,$n;
784                                 }
785 #                       } else {
786 #                               print STDERR "DEBUG: \"$sym\" (@p):",
787 #                               " rsaref:", !!(!@p
788 #                                              || (!$negatives
789 #                                                  && ($rsaref || !grep(/^RSAREF$/,@p)))
790 #                                              || ($negatives
791 #                                                  && (!$rsaref || !grep(/^!RSAREF$/,@p))))?1:0,
792 #                               " 16:", !!($W16 && (!@p_purged
793 #                                                   || (!$negatives && grep(/^WIN16$/,@p))
794 #                                                   || ($negatives && !grep(/^!WIN16$/,@p)))),
795 #                               " 32:", !!($W32 && (!@p_purged
796 #                                                   || (!$negatives && grep(/^WIN32$/,@p))
797 #                                                   || ($negatives && !grep(/^!WIN32$/,@p)))),
798 #                               " NT:", !!($NT && (!@p_purged
799 #                                                  || (!$negatives && grep(/^WINNT$/,@p))
800 #                                                  || ($negatives && !grep(/^!WINNT$/,@p)))),
801 #                               "\n";
802                         }
803                 }
804         }
805         printf OUT "\n";
806 }
807
808 sub load_numbers
809 {
810         my($name)=@_;
811         my(@a,%ret);
812
813         $max_num = 0;
814         $num_noinfo = 0;
815         $prev = "";
816
817         open(IN,"<$name") || die "unable to open $name:$!\n";
818         while (<IN>) {
819                 chop;
820                 s/#.*$//;
821                 next if /^\s*$/;
822                 @a=split;
823                 if (defined $ret{$a[0]}) {
824                         print STDERR "Warning: Symbol '",$a[0],"' redefined. old=",$ret{$a[0]},", new=",$a[1],"\n";
825                 }
826                 if ($max_num > $a[1]) {
827                         print STDERR "Warning: Number decreased from ",$max_num," to ",$a[1],"\n";
828                 }
829                 if ($max_num == $a[1]) {
830                         # This is actually perfectly OK
831                         #print STDERR "Warning: Symbol ",$a[0]," has same number as previous ",$prev,": ",$a[1],"\n";
832                 }
833                 if ($#a < 2) {
834                         # Existence will be proven later, in do_defs
835                         $ret{$a[0]}=$a[1];
836                         $num_noinfo++;
837                 } else {
838                         $ret{$a[0]}=$a[1]."\\".$a[2]; # \\ is a special marker
839                 }
840                 $max_num = $a[1] if $a[1] > $max_num;
841                 $prev=$a[0];
842         }
843         if ($num_noinfo) {
844                 print STDERR "Warning: $num_noinfo symbols were without info.";
845                 if ($do_rewrite) {
846                         printf STDERR "  The rewrite will fix this.\n";
847                 } else {
848                         printf STDERR "  You should do a rewrite to fix this.\n";
849                 }
850         }
851         close(IN);
852         return(%ret);
853 }
854
855 sub parse_number
856 {
857         (my $str, my $what) = @_;
858         (my $n, my $i) = split(/\\/,$str);
859         if ($what eq "n") {
860                 return $n;
861         } else {
862                 return $i;
863         }
864 }
865
866 sub rewrite_numbers
867 {
868         (*OUT,$name,*nums,@symbols)=@_;
869         my $thing;
870
871         print STDERR "Rewriting $name\n";
872
873         my @r = grep(/^\w+\\.*?:.*?:\w+\(\w+\)/,@symbols);
874         my $r; my %r; my %rsyms;
875         foreach $r (@r) {
876                 (my $s, my $i) = split /\\/, $r;
877                 my $a = $1 if $i =~ /^.*?:.*?:\w+\((\w+)\)/;
878                 $i =~ s/^(.*?:.*?:\w+)\(\w+\)/$1/;
879                 $r{$a} = $s."\\".$i;
880                 $rsyms{$s} = 1;
881         }
882
883         my %syms = ();
884         foreach $_ (@symbols) {
885                 (my $n, my $i) = split /\\/;
886                 $syms{$n} = 1;
887         }
888
889         my @s=sort { &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n") } keys %nums;
890         foreach $sym (@s) {
891                 (my $n, my $i) = split /\\/, $nums{$sym};
892                 next if defined($i) && $i =~ /^.*?:.*?:\w+\(\w+\)/;
893                 next if defined($rsyms{$sym});
894                 $i="NOEXIST::FUNCTION:"
895                         if !defined($i) || $i eq "" || !defined($syms{$sym});
896                 printf OUT "%s%-40s%d\t%s\n","",$sym,$n,$i;
897                 if (exists $r{$sym}) {
898                         (my $s, $i) = split /\\/,$r{$sym};
899                         printf OUT "%s%-40s%d\t%s\n","",$s,$n,$i;
900                 }
901         }
902 }
903
904 sub update_numbers
905 {
906         (*OUT,$name,*nums,my $start_num, my @symbols)=@_;
907         my $new_syms = 0;
908
909         print STDERR "Updating $name numbers\n";
910
911         my @r = grep(/^\w+\\.*?:.*?:\w+\(\w+\)/,@symbols);
912         my $r; my %r; my %rsyms;
913         foreach $r (@r) {
914                 (my $s, my $i) = split /\\/, $r;
915                 my $a = $1 if $i =~ /^.*?:.*?:\w+\((\w+)\)/;
916                 $i =~ s/^(.*?:.*?:\w+)\(\w+\)/$1/;
917                 $r{$a} = $s."\\".$i;
918                 $rsyms{$s} = 1;
919         }
920
921         foreach $sym (@symbols) {
922                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
923                 next if $i =~ /^.*?:.*?:\w+\(\w+\)/;
924                 next if defined($rsyms{$sym});
925                 die "ERROR: Symbol $sym had no info attached to it."
926                     if $i eq "";
927                 if (!exists $nums{$s}) {
928                         $new_syms++;
929                         printf OUT "%s%-40s%d\t%s\n","",$s, ++$start_num,$i;
930                         if (exists $r{$s}) {
931                                 ($s, $i) = split /\\/,$r{$s};
932                                 printf OUT "%s%-40s%d\t%s\n","",$s, $start_num,$i;
933                         }
934                 }
935         }
936         if($new_syms) {
937                 print STDERR "$new_syms New symbols added\n";
938         } else {
939                 print STDERR "No New symbols Added\n";
940         }
941 }
942
943 sub check_existing
944 {
945         (*nums, my @symbols)=@_;
946         my %existing; my @remaining;
947         @remaining=();
948         foreach $sym (@symbols) {
949                 (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
950                 $existing{$s}=1;
951         }
952         foreach $sym (keys %nums) {
953                 if (!exists $existing{$sym}) {
954                         push @remaining, $sym;
955                 }
956         }
957         if(@remaining) {
958                 print STDERR "The following symbols do not seem to exist:\n";
959                 foreach $sym (@remaining) {
960                         print STDERR "\t",$sym,"\n";
961                 }
962         }
963 }
964