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