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;
103 my $libname = platform->sharedname($name);
106 solaris => { writer => \&writer_linux,
107 sort => sorter_linux(),
108 platforms => { UNIX => 1 } },
109 linux => 'solaris', # alias
110 "bsd-gcc" => 'solaris', # alias
111 aix => { writer => \&writer_aix,
112 sort => sorter_unix(),
113 platforms => { UNIX => 1 } },
114 VMS => { writer => \&writer_VMS,
115 sort => OpenSSL::Ordinals::by_number(),
116 platforms => { VMS => 1 } },
117 vms => 'VMS', # alias
118 WINDOWS => { writer => \&writer_windows,
119 sort => OpenSSL::Ordinals::by_name(),
120 platforms => { WIN32 => 1,
122 windows => 'WINDOWS', # alias
123 WIN32 => 'WINDOWS', # alias
124 win32 => 'WIN32', # alias
125 32 => 'WIN32', # alias
126 NT => 'WIN32', # alias
127 nt => 'WIN32', # alias
128 mingw => 'WINDOWS', # alias
132 die "Unknown operating system family $OS\n"
133 unless exists $OS_data{$OS};
135 } while(ref($OS) eq '');
137 my %disabled_uc = map { my $x = uc $_; $x =~ s|-|_|g; $x => 1 } keys %disabled;
139 my %ordinal_opts = ();
140 $ordinal_opts{sort} = $OS->{sort} if $OS->{sort};
141 $ordinal_opts{filter} =
146 && platform_filter($item)
147 && feature_filter($item);
149 my $ordinals = OpenSSL::Ordinals->new(from => $ordinals_file);
151 my $writer = $OS->{writer};
152 $writer = \&writer_ctest if $ctest;
154 $writer->($ordinals->items(%ordinal_opts));
158 sub platform_filter {
160 my %platforms = ( $item->platforms() );
162 # True if no platforms are defined
163 return 1 if scalar keys %platforms == 0;
165 # For any item platform tag, return the equivalence with the
166 # current platform settings if it exists there, return 0 otherwise
167 # if the item platform tag is true
168 for (keys %platforms) {
169 if (exists $OS->{platforms}->{$_}) {
170 return $platforms{$_} == $OS->{platforms}->{$_};
172 if ($platforms{$_}) {
177 # Found no match? Then it's a go
183 my @features = ( $item->features() );
185 # True if no features are defined
186 return 1 if scalar @features == 0;
188 my $verdict = ! grep { $disabled_uc{$_} } @features;
190 if ($disabled{deprecated}) {
191 foreach (@features) {
192 next unless /^DEPRECATEDIN_(\d+)_(\d+)(?:_(\d+))?$/;
193 my $symdep = $1 * 10000 + $2 * 100 + ($3 // 0);
194 $verdict = 0 if $config{api} >= $symdep;
195 print STDERR "DEBUG: \$symdep = $symdep, \$verdict = $verdict\n"
204 my $by_name = OpenSSL::Ordinals::by_name();
214 my $verdict = $weight{$item1->type()} <=> $weight{$item2->type()};
216 $verdict = $by_name->($item1, $item2);
223 my $by_version = OpenSSL::Ordinals::by_version();
224 my $by_unix = sorter_unix();
230 my $verdict = $by_version->($item1, $item2);
232 $verdict = $by_unix->($item1, $item2);
239 my $thisversion = '';
240 my $currversion_s = '';
241 my $prevversion_s = '';
245 if ($thisversion && $_->version() ne $thisversion) {
246 die "$ordinals_file: It doesn't make sense to have both versioned ",
247 "and unversioned symbols"
248 if $thisversion eq '*';
252 $prevversion_s = " OPENSSL${SO_VARIANT}_$thisversion";
253 $thisversion = ''; # Trigger start of next section
255 unless ($thisversion) {
257 $thisversion = $_->version();
259 $currversion_s = "OPENSSL${SO_VARIANT}_$thisversion "
260 if $thisversion ne '*';
266 print ' ', $_->name(), ";\n";
277 print $_->name(),"\n";
284 ; Definition file for the DLL version of the $libname library from OpenSSL
292 print " ",$_->name(),"\n";
296 sub collect_VMS_mixedcase {
297 return [ 'SPARE', 'SPARE' ] unless @_;
303 return [ "$s=$type", 'SPARE' ] if $s_uc eq $s;
304 return [ "$s_uc/$s=$type", "$s=$type" ];
307 sub collect_VMS_uppercase {
308 return [ 'SPARE' ] unless @_;
314 return [ "$s_uc=$type" ];
318 my @slot_collection = ();
320 $case_insensitive ? \&collect_VMS_uppercase : \&collect_VMS_mixedcase;
324 my $this_num = $_->number();
325 $this_num = $last_num + 1 if $this_num =~ m|^\?|;
327 while (++$last_num < $this_num) {
328 push @slot_collection, $collector->(); # Just occupy a slot
331 FUNCTION => 'PROCEDURE',
334 push @slot_collection, $collector->($_->name(), $type);
337 print <<"_____" if defined $version;
338 IDENTIFICATION=$version
340 print <<"_____" unless $case_insensitive;
346 # It's uncertain how long aggregated lines the linker can handle,
347 # but it has been observed that at least 1024 characters is ok.
348 # Either way, this means that we need to keep track of the total
349 # line length of each "SYMBOL_VECTOR" statement. Fortunately, we
350 # can have more than one of those...
351 my $symvtextcount = 16; # The length of "SYMBOL_VECTOR=("
352 while (@slot_collection) {
353 my $set = shift @slot_collection;
354 my $settextlength = 0;
357 + 3 # two space indentation and comma
362 $settextlength--; # only one space indentation on the first one
363 my $firstcomma = ',';
365 if ($symvtextcount + $settextlength > 1024) {
370 $symvtextcount = 16; # The length of "SYMBOL_VECTOR=("
372 if ($symvtextcount == 16) {
376 my $indent = ' '.$firstcomma;
381 $symvtextcount += length($indent) + length($_) + 1;
389 if (defined $version) {
390 $version =~ /^(\d+)\.(\d+)\.(\d+)/;
392 my $libvminor = $2 * 100 + $3;
394 GSMATCH=LEQUAL,$libvmajor,$libvminor
402 * Test file to check all DEF file symbols are present by trying
403 * to link to all of them. This is *not* intended to be run!
412 my $this_num = $_->number();
413 $this_num = $last_num + 1 if $this_num =~ m|^\?|;
415 if ($_->type() eq 'VARIABLE') {
416 print "\textern int ", $_->name(), '; /* type unknown */ /* ',
417 $this_num, ' ', $_->version(), " */\n";
419 print "\textern int ", $_->name(), '(); /* type unknown */ /* ',
420 $this_num, ' ', $_->version(), " */\n";
423 $last_num = $this_num;