Statically link libstdc++ on Linux #3002
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
imphil
force-pushed
the
static-libstdcpp
branch
2 times, most recently
from
61eb389
to
ecdc32f
Compare
|
Fixes #386 for real. |
Codecov Report
@@ Coverage Diff @@
## master #3002 +/- ##
=======================================
Coverage 66.24% 66.24%
=======================================
Files 48 48
Lines 8689 8689
Branches 1467 1467
=======================================
Hits 5756 5756
Misses 2526 2526
Partials 407 407 Continue to review full report at Codecov.
|
imphil
changed the title
ktbarrett
approved these changes
Jun 15, 2022
The binary sizes increase slightly by around 20% overall from 12 to 15 MB on my machine. Looks like (sorry for the inconsistent sorting below) Before: After |
|
I'm guessing it's taking advantage of transitive linking, libgpilog is the root of the link tree for most objects. So NBD. |
Some simulators, e.g. Questa, ship with their own copy of libstdc++.
When loading cocotb, which is linked against libstdc++, the version of
libstdc++ cocotb was compiled with must not be newer than the version of
libstdc++ shipped with the simulator. Since is this something we cannot
guarantee, it leads to user-visible problems where cocotb's VPI/VHPI/FLI
library fails to load.
For example, in Questa or Modelsim, the error looks like this when
running vcom on a system with libstdc++ 6.0.30 (GCC 12.1):
```
# Loading /home/philipp/src/cocotb/cocotb/libs/libcocotbvhpi_modelsim.so
# ** Error (suppressible): (vsim-3197) Load of "/home/philipp/src/cocotb/cocotb/libs/libcocotbvhpi_modelsim.so" failed: /path/to/questasim/gcc-7.4.0-linux_x86_64/lib64/libstdc++.so.6: version `GLIBCXX_3.4.29' not found (required by /home/philipp/src/cocotb/cocotb/libs/libcocotbvhpi_modelsim.so).
# ** Warning: (vsim-FLI-3160) Failed to load FLI object file "/home/philipp/src/cocotb/cocotb/libs/libcocotbvhpi_modelsim.so".
```
To make cocotb resilient even if a simulator (or anything else in the
environment) provides an incompatible libstdc++, this patch statically
links libstdc++ into all cocotb libraries.
Before:
```
❯ ldd /home/philipp/src/cocotb/cocotb/libs/libcocotbvhpi_modelsim.so
linux-vdso.so.1 (0x00007fff7c122000)
libgpi.so => /home/philipp/src/cocotb/cocotb/libs/libgpi.so (0x00007fd7be8aa000)
libgpilog.so => /home/philipp/src/cocotb/cocotb/libs/libgpilog.so (0x00007fd7be8a2000)
libstdc++.so.6 => /lib64/libstdc++.so.6 (0x00007fd7be600000)
libm.so.6 => /lib64/libm.so.6 (0x00007fd7be51a000)
libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x00007fd7be860000)
libc.so.6 => /lib64/libc.so.6 (0x00007fd7be200000)
libcocotbutils.so => /home/philipp/src/cocotb/cocotb/libs/libcocotbutils.so (0x00007fd7be858000)
libembed.so => /home/philipp/src/cocotb/cocotb/libs/libembed.so (0x00007fd7be850000)
/lib64/ld-linux-x86-64.so.2 (0x00007fd7be8ec000)
```
After:
```
❯ ldd ./cocotb/libs/libcocotbvpi_modelsim.so
linux-vdso.so.1 (0x00007fff8078d000)
libgpi.so => /home/philipp/src/cocotb/./cocotb/libs/libgpi.so (0x00007f496f1a0000)
libgpilog.so => /home/philipp/src/cocotb/./cocotb/libs/libgpilog.so (0x00007f496f162000)
libm.so.6 => /lib64/libm.so.6 (0x00007f496f05d000)
libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x00007f496f03a000)
libc.so.6 => /lib64/libc.so.6 (0x00007f496ee00000)
libcocotbutils.so => /home/philipp/src/cocotb/./cocotb/libs/libcocotbutils.so (0x00007f496f032000)
libembed.so => /home/philipp/src/cocotb/./cocotb/libs/libembed.so (0x00007f496edf8000)
/lib64/ld-linux-x86-64.so.2 (0x00007f496f1df000)
```
|
Updated to include a newsfragment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some simulators, e.g. Questa, ship with their own copy of libstdc++.
When loading cocotb, which is linked against libstdc++, the version of
libstdc++ cocotb was compiled with must not be newer than the version of
libstdc++ shipped with the simulator. Since is this something we cannot
guarantee, it leads to user-visible problems where cocotb's VPI/VHPI/FLI
library fails to load.
For example, in Questa or Modelsim, the error looks like this when
running vcom on a system with libstdc++ 6.0.30 (GCC 12.1):
To make cocotb resilient even if a simulator (or anything else in the
environment) provides an incompatible libstdc++, this patch statically
links libstdc++ into all cocotb libraries.
Before:
After: