Be more precise about what a runtime_file is

For versioned libraries, it's now always the file that the dynamic loader will
load (e.g. the soname).

Author: jimporter

bfg9000/builtins/install.py

@@ -36,8 +36,8 @@ def _add_implicit(self, item, directory):
                 self.host[src] = h
                 self.target[src] = t
 
-            for dep in src.install_deps:
-                self._add_implicit(dep, directory)
+                for dep in src.install_deps:
+                    self._add_implicit(dep, directory)
 
         return target
 

bfg9000/file_types.py

@@ -276,15 +276,31 @@ def __init__(self, path, library, **kwargs):
 
     @property
     def runtime_file(self):
-        return self.library
+        return self.library.runtime_file
+
+
+class LoadLibrary(LinkLibrary):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.runtime_deps = [self.library]
+
+    @property
+    def runtime_file(self):
+        return self
 
 
 class VersionedSharedLibrary(SharedLibrary):
     def __init__(self, path, format, lang, soname_path, linkname_path,
                  **kwargs):
         super().__init__(path, format, lang, **kwargs)
-        self.soname = LinkLibrary(soname_path, self, parent=self)
+        self.soname = LoadLibrary(soname_path, self, parent=self)
         self.link = LinkLibrary(linkname_path, self.soname, parent=self)
+        # At runtime, the loader will look for the soname for this library.
+        self.runtime_deps = [self.soname]
+
+    @property
+    def runtime_file(self):
+        return self.soname
 
 
 class StaticLibrary(Library):
@@ -322,6 +338,10 @@ def __init__(self, path, format, lang, import_path, export_path=None, *,
         self.export_file = (ExportFile(export_path, parent=self)
                             if export_path else None)
 
+    @property
+    def runtime_file(self):
+        return self
+
 
 class DualUseLibrary(BaseFile):
     def __init__(self, shared, static):

test/unit/test_file_types.py

@@ -226,6 +226,19 @@ def test_clone_recursive(self):
                          LinkLibrary(Path('a'), dstlib), recursive=True)
 
 
+class TestLoadLibrary(FileTest):
+    def test_clone(self):
+        lib = SharedLibrary(Path('a.so', Root.srcdir), 'elf', 'c')
+        self.assertClone(LoadLibrary(Path('a', Root.srcdir), lib),
+                         LoadLibrary(Path('a'), lib))
+
+    def test_clone_recursive(self):
+        srclib = SharedLibrary(Path('a.so', Root.srcdir), 'elf', 'c')
+        dstlib = SharedLibrary(Path('a.so'), 'elf', 'c')
+        self.assertClone(LoadLibrary(Path('a', Root.srcdir), srclib),
+                         LoadLibrary(Path('a'), dstlib), recursive=True)
+
+
 class TestVersionedSharedLibrary(FileTest):
     def test_clone(self):
         src = VersionedSharedLibrary(
@@ -236,12 +249,14 @@ def test_clone(self):
             Path('a.1.2.3'), 'elf', 'c',
             Path('a.1', Root.srcdir), Path('a', Root.srcdir)
         )
-        dst.soname.library = dst.soname.linktime_deps[0] = src
+        dst.soname.library = src
+        dst.soname.runtime_deps[0] = dst.soname.linktime_deps[0] = src
         dst.link.library = dst.link.linktime_deps[0] = src.soname
         dst.soname.parent = dst.link.parent = src
+        dst.runtime_deps[0] = src.soname
         self.assertClone(src, dst)
 
-        dst_soname = LinkLibrary(Path('a.1'), src)
+        dst_soname = LoadLibrary(Path('a.1'), src)
         self.assertClone(src.soname, dst_soname)
 
         dst_link = LinkLibrary(Path('a'), src.soname)

test/unit/tools/cc/test_linker.py

@@ -11,6 +11,7 @@
 from bfg9000.tools.cc import CcBuilder
 from bfg9000.packages import Framework
 from bfg9000.path import abspath, InstallRoot, Path, Root
+from bfg9000.versioning import Version
 
 
 class TestCcLinker(CrossPlatformTestCase):
@@ -100,6 +101,8 @@ def test_flags_lib_dir(self):
         lib = self.Path('/path/to/lib/libfoo.a')
         srclibdir = self.Path('.', Root.srcdir)
         srclib = self.Path('libfoo.a', Root.srcdir)
+        srcverlib = self.Path('libfoo.so.1.2.3', Root.srcdir)
+        srcsoname = self.Path('libfoo.so.1', Root.srcdir)
 
         if self.shared:
             output = SharedLibrary(self.Path('out'), 'native')
@@ -134,6 +137,12 @@ def test_flags_lib_dir(self):
             opts.lib(SharedLibrary(srclib, 'native'))
         ), output=output), ['-L' + srclibdir] + srcdir_rpath + soname)
 
+        # Versioned library
+        self.assertEqual(self.linker.flags(opts.option_list(
+            opts.lib(VersionedSharedLibrary(srcverlib, 'native', 'c',
+                                            srcsoname, srclib))
+        ), output=output), ['-L' + srclibdir] + srcdir_rpath + soname)
+
         if self.env.target_platform.genus == 'linux':
             libdir2 = self.Path('foo')
             lib2 = self.Path('foo/libbar.a')
@@ -149,6 +158,22 @@ def test_flags_lib_dir(self):
                 ['-L' + libdir2, '-Wl,-rpath,$ORIGIN/foo'] + soname
             )
 
+            # Make sure we handle rpath-link for broken BFD-based ld. See
+            # `bfg9000/tools/cc/linker.py`
+            class BrokenBfdLinker:
+                brand = 'bfd'
+                version = Version('2.27')
+            with mock.patch('bfg9000.tools.cc.CcBuilder.linker',
+                            return_value=BrokenBfdLinker()):
+                s = SharedLibrary(srclib, 'native')
+                s.runtime_deps = [SharedLibrary(lib2, 'native')]
+                self.assertEqual(
+                    self.linker.flags(opts.option_list(opts.lib(s)),
+                                      output=output),
+                    (['-L' + srclibdir] + srcdir_rpath +
+                     ['-Wl,-rpath-link,' + libdir2] + soname)
+                )
+
         # Static library
         self.assertEqual(self.linker.flags(opts.option_list(
             opts.lib(StaticLibrary(lib, 'native'))