Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compile sundials with -fPIC to allow shared libraries to link #3076

Closed
wants to merge 1 commit into from

Conversation

andrjohns
Copy link
Collaborator

Summary

When exposing Stan functions or model methods (log_prob, etc) in cmdstanr, R compiles a shared object and links to the CmdStan-built libraries.

However this causes an error on Linux system where -fPIC is required for linking static libraries to shared libraries, and the user needs SUNDIALS/CVODES functions:

sunmatrix_band.c:(.text+0x87c): dangerous relocation: unsupported relocation
/usr/bin/ld: /root/.cmdstan/cmdstan-2.34.1/stan/lib/stan_math/lib/sundials_6.1.1/lib/libsundials_kinsol.a(sunmatrix_band.o): relocation R_AARCH64_ADR_PREL_PG_HI21 against symbol `SUNMatClone_Band' which may bind externally can not be used when making a shared object; recompile with -fPIC

Tests

N/A

Side Effects

N/A

Release notes

Added -fPIC to SUNDIALS compilation flags so that downstream shared libraries can link against them

Checklist

  • Copyright holder: Andrew Johnson

    The copyright holder is typically you or your assignee, such as a university or company. By submitting this pull request, the copyright holder is agreeing to the license the submitted work under the following licenses:
    - Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
    - Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

  • the basic tests are passing

    • unit tests pass (to run, use: ./runTests.py test/unit)
    • header checks pass, (make test-headers)
    • dependencies checks pass, (make test-math-dependencies)
    • docs build, (make doxygen)
    • code passes the built in C++ standards checks (make cpplint)
  • the code is written in idiomatic C++ and changes are documented in the doxygen

  • the new changes are tested

@WardBrian
Copy link
Member

We also ran into this in BridgeStan

I am not sure if doing it universally is the right thing to do, however, since for usages like CmdStan it is not necessary and can supposedly lead to slower assembly being generated

@stan-buildbot
Copy link
Contributor


Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.34 0.35 0.96 -4.5% slower
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.97 -2.92% slower
gp_regr/gen_gp_data.stan 0.03 0.03 0.99 -1.19% slower
gp_regr/gp_regr.stan 0.1 0.11 0.99 -1.01% slower
sir/sir.stan 77.69 76.88 1.01 1.04% faster
irt_2pl/irt_2pl.stan 4.78 4.37 1.09 8.57% faster
eight_schools/eight_schools.stan 0.06 0.06 1.02 2.07% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.27 0.26 1.02 1.92% faster
pkpd/one_comp_mm_elim_abs.stan 21.17 20.9 1.01 1.28% faster
garch/garch.stan 0.5 0.49 1.03 2.63% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 2.94 2.91 1.01 1.14% faster
arK/arK.stan 1.95 1.89 1.03 2.99% faster
gp_pois_regr/gp_pois_regr.stan 3.98 3.08 1.29 22.53% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 9.58 9.33 1.03 2.62% faster
performance.compilation 200.08 201.25 0.99 -0.58% slower
Mean result: 1.0297261462621967

Jenkins Console Log
Blue Ocean
Commit hash: 3f7e09209b23151b1bc3551fb3b85a64d7f53210


Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 3322.349
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS, IBPB conditional, STIBP conditional, RSB filling, PBRSB-eIBRS Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@andrjohns
Copy link
Collaborator Author

We also ran into this in BridgeStan

I am not sure if doing it universally is the right thing to do, however, since for usages like CmdStan it is not necessary and can supposedly lead to slower assembly being generated

Ah yeah I see. I've updated cmdstanr to check for the flag and add/rebuild if necessary, so we can close this if it's preferable

@WardBrian
Copy link
Member

If that works for you I think that's how we should proceed for now

@WardBrian WardBrian closed this May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants