Add a SONAME to shared libraries

[tamiko]

Ginkgo is written in C++ and does not guarantee any stable ABI.
Consequently, all shared libraries should be annotated by an appropriate
SONAME (this patch simply uses the release version). This ensures
conformity with best practices and library requirements for popular
Linux distributions (e.g., Debian/Ubuntu). It also prevents silent
breakage (at dynamic link time / run time) when the library ABI changed
and user code should have been recompiled.

[pratikvn]

@tamiko . Thank you for your contribution!

[pratikvn]

LGTM! Can you please add yourself to the contributors list as well ?

[tcojean]

LGTM! Thanks for your contribution.

[upsj]

Thanks for your contribution! For my understanding: When linking an executable with a library that provides a versioned SONAME, will CMake then correctly set the NEEDED entry to include the version number?

[tamiko]

@pratikvn
Added an entry to the contributors file.

@upsj

When linking an executable with a library that provides a versioned SONAME, will CMake then correctly set the NEEDED entry to include the version number?

Yes. By providing above target property CMake will create the shared library with a SONAME and set up appropriate symlinks:

% objdump -x libginkgo.so | grep SONAME
  SONAME               libginkgo.so.1.1.1
% ls -la libginkgo.so*
lrwxrwxrwx 1 root root      18 Apr 30 16:23 libginkgo.so -> libginkgo.so.1.1.1
-rwxr-xr-x 1 root root 7678896 Apr 30 16:23 libginkgo.so.1.1.1

The linker will now record libginkgo.so.1.1.1 in the dynamic section of executables and libraries linking against libginkgo.so:

% objdump -x libdeal_II.so | grep libginkgo.so
  NEEDED               libginkgo.so.1.1.1

The dynamic linker/loader will now search for a shared object file named libginkgo.so.1.1.1 instead of libginkgo.so:

% ldd libdeal_II.so | grep libginkgo.so
libginkgo.so.1.1.1 => /usr/lib64/libginkgo.so.1.1.1 (0x00007f4f59a4f000)

[upsj]

We seem to have some issues with the interaction of HIP and nvcc as a linker.
CI Pipeline

[tcojean]

Yes I saw that, I'm looking into it.

[thoasm]

LGTM!

[tcojean]

@tamiko Sorry for the delay, could you rebase this to the latest develop status? The HIP issue which this PR highlighted should now be fixed.

[tamiko]

@tcojean I rebased onto the current develop branch.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information

[codecov]

Codecov Report

Merging #524 into develop will decrease coverage by 0.11%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #524      +/-   ##
===========================================
- Coverage    88.71%   88.59%   -0.12%     
===========================================
  Files          276      276              
  Lines        17761    17724      -37     
===========================================
- Hits         15756    15703      -53     
- Misses        2005     2021      +16     

Impacted Files	Coverage Δ
omp/components/format_conversion.hpp	40.00% <0.00%> (-60.00%)	⬇️
include/ginkgo/core/matrix/hybrid.hpp	73.83% <0.00%> (-10.38%)	⬇️
include/ginkgo/core/matrix/sellp.hpp	81.81% <0.00%> (-8.43%)	⬇️
include/ginkgo/core/base/composition.hpp	89.28% <0.00%> (-3.31%)	⬇️
include/ginkgo/core/base/name_demangling.hpp	85.71% <0.00%> (-3.18%)	⬇️
include/ginkgo/core/base/math.hpp	94.11% <0.00%> (-2.86%)	⬇️
core/base/extended_float.hpp	92.30% <0.00%> (-1.10%)	⬇️
include/ginkgo/core/matrix/dense.hpp	97.70% <0.00%> (+2.29%)	⬆️
include/ginkgo/core/base/polymorphic_object.hpp	96.82% <0.00%> (+2.84%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fd146da...b155c66. Read the comment docs.