2 # Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
4 # Licensed under the Apache License 2.0 (the "License"). You may not use
5 # this file except in compliance with the License. You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
9 # Generate a linker version script suitable for the given platform
10 # from a given ordinals file.
17 use lib "$FindBin::Bin/perl";
19 use OpenSSL::Ordinals;
24 use File::Spec::Functions;
25 use lib catdir($config{sourcedir}, 'Configurations');
28 my $name = undef; # internal library/module name
29 my $ordinals_file = undef; # the ordinals file to use
30 my $version = undef; # the version to use for the library
31 my $OS = undef; # the operating system family
35 # For VMS, some modules may have case insensitive names
36 my $case_insensitive = 0;
38 GetOptions('name=s' => \$name,
39 'ordinals=s' => \$ordinals_file,
40 'version=s' => \$version,
43 'verbose' => \$verbose,
45 'case-insensitive' => \$case_insensitive)
46 or die "Error in command line arguments\n";
48 die "Please supply arguments\n"
49 unless $name && $ordinals_file && $OS;
51 # When building a "variant" shared library, with a custom SONAME, also customize
52 # all the symbol versions. This produces a shared object that can coexist
53 # without conflict in the same address space as a default build, or an object
54 # with a different variant tag.
56 # For example, with a target definition that includes:
58 # shlib_variant => "-opt",
60 # we build the following objects:
64 # if ($l = readlink) {
65 # printf "%s -> %s\n", $_, $l
70 # libcrypto-opt.so.1.1
71 # libcrypto.so -> libcrypto-opt.so.1.1
73 # libssl.so -> libssl-opt.so.1.1
75 # whose SONAMEs and dependencies are:
79 # readelf -d $l | egrep 'SONAME|NEEDED.*(ssl|crypto)'
82 # 0x000000000000000e (SONAME) Library soname: [libcrypto-opt.so.1.1]
84 # 0x0000000000000001 (NEEDED) Shared library: [libcrypto-opt.so.1.1]
85 # 0x000000000000000e (SONAME) Library soname: [libssl-opt.so.1.1]
87 # We case-fold the variant tag to upper case and replace all non-alnum
88 # characters with "_". This yields the following symbol versions:
90 # $ nm libcrypto.so | grep -w A
91 # 0000000000000000 A OPENSSL_OPT_1_1_0
92 # 0000000000000000 A OPENSSL_OPT_1_1_0a
93 # 0000000000000000 A OPENSSL_OPT_1_1_0c
94 # 0000000000000000 A OPENSSL_OPT_1_1_0d
95 # 0000000000000000 A OPENSSL_OPT_1_1_0f
96 # 0000000000000000 A OPENSSL_OPT_1_1_0g
97 # $ nm libssl.so | grep -w A
98 # 0000000000000000 A OPENSSL_OPT_1_1_0
99 # 0000000000000000 A OPENSSL_OPT_1_1_0d
101 (my $SO_VARIANT = uc($target{"shlib_variant"} // '')) =~ s/\W/_/g;
104 $apiv = sprintf "%x%02x%02x", split(/\./, $config{api})
107 my $libname = platform->sharedname($name);
110 solaris => { writer => \&writer_linux,
111 sort => sorter_linux(),
112 platforms => { UNIX => 1,
113 EXPORT_VAR_AS_FUNCTION => 0 } },
114 linux => 'solaris', # alias
115 "bsd-gcc" => 'solaris', # alias
116 aix => { writer => \&writer_aix,
117 sort => sorter_unix(),
118 platforms => { UNIX => 1,
119 EXPORT_VAR_AS_FUNCTION => 0 } },
120 VMS => { writer => \&writer_VMS,
121 sort => OpenSSL::Ordinals::by_number(),
122 platforms => { VMS => 1,
123 EXPORT_VAR_AS_FUNCTION => 0 } },
124 vms => 'VMS', # alias
125 WINDOWS => { writer => \&writer_windows,
126 sort => OpenSSL::Ordinals::by_name(),
127 platforms => { WIN32 => 1,
129 EXPORT_VAR_AS_FUNCTION => 1 } },
130 windows => 'WINDOWS', # alias
131 WIN32 => 'WINDOWS', # alias
132 win32 => 'WIN32', # alias
133 32 => 'WIN32', # alias
134 NT => 'WIN32', # alias
135 nt => 'WIN32', # alias
136 mingw => 'WINDOWS', # alias
140 die "Unknown operating system family $OS\n"
141 unless exists $OS_data{$OS};
143 } while(ref($OS) eq '');
145 my %disabled_uc = map { my $x = uc $_; $x =~ s|-|_|g; $x => 1 } keys %disabled;
147 my %ordinal_opts = ();
148 $ordinal_opts{sort} = $OS->{sort} if $OS->{sort};
149 $ordinal_opts{filter} =
154 && platform_filter($item)
155 && feature_filter($item);
157 my $ordinals = OpenSSL::Ordinals->new(from => $ordinals_file);
159 my $writer = $OS->{writer};
160 $writer = \&writer_ctest if $ctest;
162 $writer->($ordinals->items(%ordinal_opts));
166 sub platform_filter {
168 my %platforms = ( $item->platforms() );
170 # True if no platforms are defined
171 return 1 if scalar keys %platforms == 0;
173 # For any item platform tag, return the equivalence with the
174 # current platform settings if it exists there, return 0 otherwise
175 # if the item platform tag is true
176 for (keys %platforms) {
177 if (exists $OS->{platforms}->{$_}) {
178 return $platforms{$_} == $OS->{platforms}->{$_};
180 if ($platforms{$_}) {
185 # Found no match? Then it's a go
191 my @features = ( $item->features() );
193 # True if no features are defined
194 return 1 if scalar @features == 0;
196 my $verdict = ! grep { $disabled_uc{$_} } @features;
199 foreach (@features) {
200 next unless /^DEPRECATEDIN_(\d+)(?:_(\d+)_(\d+))?$/;
201 my $symdep = sprintf "%x%02x%02x", $1, ($2 // 0), ($3 // 0);
202 $verdict = 0 if $apiv ge $symdep;
210 my $by_name = OpenSSL::Ordinals::by_name();
220 my $verdict = $weight{$item1->type()} <=> $weight{$item2->type()};
222 $verdict = $by_name->($item1, $item2);
229 my $by_version = OpenSSL::Ordinals::by_version();
230 my $by_unix = sorter_unix();
236 my $verdict = $by_version->($item1, $item2);
238 $verdict = $by_unix->($item1, $item2);
245 my $thisversion = '';
246 my $currversion_s = '';
247 my $prevversion_s = '';
251 if ($thisversion && $_->version() ne $thisversion) {
252 die "$ordinals_file: It doesn't make sense to have both versioned ",
253 "and unversioned symbols"
254 if $thisversion eq '*';
258 $prevversion_s = " OPENSSL${SO_VARIANT}_$thisversion";
259 $thisversion = ''; # Trigger start of next section
261 unless ($thisversion) {
263 $thisversion = $_->version();
265 $currversion_s = "OPENSSL${SO_VARIANT}_$thisversion "
266 if $thisversion ne '*';
272 print ' ', $_->name(), ";\n";
283 print $_->name(),"\n";
290 ; Definition file for the DLL version of the $libname library from OpenSSL
298 print " ",$_->name(),"\n";
302 sub collect_VMS_mixedcase {
303 return [ 'SPARE', 'SPARE' ] unless @_;
309 return [ "$s=$type", 'SPARE' ] if $s_uc eq $s;
310 return [ "$s_uc/$s=$type", "$s=$type" ];
313 sub collect_VMS_uppercase {
314 return [ 'SPARE' ] unless @_;
320 return [ "$s_uc=$type" ];
324 my @slot_collection = ();
326 $case_insensitive ? \&collect_VMS_uppercase : \&collect_VMS_mixedcase;
330 while (++$last_num < $_->number()) {
331 push @slot_collection, $collector->(); # Just occupy a slot
334 FUNCTION => 'PROCEDURE',
337 push @slot_collection, $collector->($_->name(), $type);
340 print <<"_____" if defined $version;
341 IDENTIFICATION=$version
343 print <<"_____" unless $case_insensitive;
349 # It's uncertain how long aggregated lines the linker can handle,
350 # but it has been observed that at least 1024 characters is ok.
351 # Either way, this means that we need to keep track of the total
352 # line length of each "SYMBOL_VECTOR" statement. Fortunately, we
353 # can have more than one of those...
354 my $symvtextcount = 16; # The length of "SYMBOL_VECTOR=("
355 while (@slot_collection) {
356 my $set = shift @slot_collection;
357 my $settextlength = 0;
360 + 3 # two space indentation and comma
365 $settextlength--; # only one space indentation on the first one
366 my $firstcomma = ',';
368 if ($symvtextcount + $settextlength > 1024) {
373 $symvtextcount = 16; # The length of "SYMBOL_VECTOR=("
375 if ($symvtextcount == 16) {
379 my $indent = ' '.$firstcomma;
384 $symvtextcount += length($indent) + length($_) + 1;
392 if (defined $version) {
393 $version =~ /^(\d+)\.(\d+)\.(\d+)/;
395 my $libvminor = $2 * 100 + $3;
397 GSMATCH=LEQUAL,$libvmajor,$libvminor
405 * Test file to check all DEF file symbols are present by trying
406 * to link to all of them. This is *not* intended to be run!
414 if ($_->type() eq 'VARIABLE') {
415 print "\textern int ", $_->name(), '; /* type unknown */ /* ', $_->number(), ' ', $_->version(), " */\n";
417 print "\textern int ", $_->name(), '(); /* type unknown */ /* ', $_->number(), ' ', $_->version(), " */\n";