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

set static const values to static constexpr #2830

Merged
merged 48 commits into from
Feb 19, 2024
Merged

Conversation

SteveBronder
Copy link
Collaborator

Summary

This is to fix a bug where some static initialization fiascos can happen when compiling at -O0. I went through and set many of the values from static const to static constexpr. This should only affect things when compiling at -O0 since all the other optimizations levels treat static const values as known at compile time.

Tests

No new tests

Side Effects

Nope. Though I'm away from my desktop atm so these might fail the OpenCL tests as I was not able to test them locally.

Release notes

replaces static const objects with static constexpr when available.

Checklist

  • Math issue #(issue number)

  • Copyright holder: Steve Bronder

    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

SteveBronder and others added 25 commits October 20, 2022 12:03
…imization still treats them as known as compile time
@andrjohns
Copy link
Collaborator

@SteveBronder is this ready for review?

Copy link
Collaborator

@andrjohns andrjohns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few q's and comments

@@ -12,7 +12,7 @@ namespace math {
namespace opencl_kernels {

// \cond
static const std::string add_batch_kernel_code = STRINGIFY(
static constexpr const char *add_batch_kernel_code = STRINGIFY(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr const char *add_batch_kernel_code = STRINGIFY(
static constexpr const char* add_batch_kernel_code = STRINGIFY(

For consistency

@@ -10,7 +10,7 @@ namespace stan {
namespace math {
namespace opencl_kernels {
// \cond
static const std::string is_symmetric_kernel_code = STRINGIFY(
static constexpr const char *is_symmetric_kernel_code = STRINGIFY(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr const char *is_symmetric_kernel_code = STRINGIFY(
static constexpr const char* is_symmetric_kernel_code = STRINGIFY(

@@ -12,7 +12,7 @@ namespace math {
namespace opencl_kernels {

// \cond
static const char *cumulative_sum1_kernel_code = STRINGIFY(
static constexpr const char *cumulative_sum1_kernel_code = STRINGIFY(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr const char *cumulative_sum1_kernel_code = STRINGIFY(
static constexpr const char* cumulative_sum1_kernel_code = STRINGIFY(

@@ -62,7 +62,7 @@ static const char *cumulative_sum1_kernel_code = STRINGIFY(
// \endcond

// \cond
static const char *cumulative_sum2_kernel_code = STRINGIFY(
static constexpr const char *cumulative_sum2_kernel_code = STRINGIFY(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr const char *cumulative_sum2_kernel_code = STRINGIFY(
static constexpr const char* cumulative_sum2_kernel_code = STRINGIFY(

Comment on lines 80 to 81
static constexpr double LOG_PI
= 1.14472988584940017414342735135305871164729481291531157151362;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit of a departure from how we've stored these constants so far, and not something I'm a huge fan of tbh, is it an essential change here?

Not a blocking comment if there's no alternative, just personal preference

Copy link
Collaborator

@andrjohns andrjohns May 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually! We can do this directly using boost's constants:

static constexpr double LOG_PI = 2 * boost::math::constants::log_root_two_pi<double>() - LOG_TWO;

Comment on lines 79 to 80
static constexpr double inf = std::numeric_limits<double>::infinity();
static constexpr double nan = std::numeric_limits<double>::quiet_NaN();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This header should just use the NOT_A_NUMBER and INFTY constants directly

@@ -67,7 +67,7 @@ namespace internal {
*/
template <typename V>
inline std::complex<V> complex_log10(const std::complex<V>& z) {
static const double inv_log_10 = 1 / std::log(10);
static constexpr double inv_log_10 = 1 / 2.30258509299404568401799145468;
Copy link
Collaborator

@andrjohns andrjohns May 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr double inv_log_10 = 1 / 2.30258509299404568401799145468;
static constexpr double inv_log_10 = 1 / LOG_TEN;

Comment on lines 143 to 144
static constexpr double LOG_PI_LOG_WIENER_ERR
= LOG_PI + -13.81551055796427410410794872810618524;
Copy link
Collaborator

@andrjohns andrjohns May 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr double LOG_PI_LOG_WIENER_ERR
= LOG_PI + -13.81551055796427410410794872810618524;
static constexpr double LOG_PI_LOG_WIENER_ERR
= LOG_PI - 6 * LOG_TEN;

Comment on lines 150 to 151
static constexpr double SQUARE_PI_OVER_TWO
= 9.869604401089358618834490999876151135 * 0.5;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr double SQUARE_PI_OVER_TWO
= 9.869604401089358618834490999876151135 * 0.5;
static constexpr double SQUARE_PI_OVER_TWO = (pi() * pi()) / 2;

Comment on lines 111 to 112
static constexpr double LOG_SQRT_PI
= 0.5723649429247000870717136756765293558236474064576557857568115357;
Copy link
Collaborator

@andrjohns andrjohns May 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static constexpr double LOG_SQRT_PI
= 0.5723649429247000870717136756765293558236474064576557857568115357;
static constexpr double LOG_SQRT_PI = LOG_PI / 2;

One more simplification I thought of

@stan-buildbot
Copy link
Contributor


Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.3 0.21 1.43 30.04% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 1.01 0.64% faster
gp_regr/gen_gp_data.stan 0.03 0.03 0.95 -4.99% slower
gp_regr/gp_regr.stan 0.13 0.12 1.06 5.65% faster
sir/sir.stan 86.53 83.2 1.04 3.85% faster
irt_2pl/irt_2pl.stan 4.56 4.19 1.09 8.3% faster
eight_schools/eight_schools.stan 0.06 0.05 1.07 6.72% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.29 0.26 1.15 12.75% faster
pkpd/one_comp_mm_elim_abs.stan 24.26 18.79 1.29 22.53% faster
garch/garch.stan 0.62 0.49 1.27 21.32% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 3.13 3.01 1.04 3.79% faster
arK/arK.stan 1.98 2.09 0.95 -5.35% slower
gp_pois_regr/gp_pois_regr.stan 2.76 2.65 1.04 3.95% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 9.96 9.63 1.03 3.28% faster
performance.compilation 196.48 200.74 0.98 -2.17% slower
Mean result: 1.093415632208503

Jenkins Console Log
Blue Ocean
Commit hash: e0626a595a3bddd83ac6d0ec401fba4e39c8c5ea


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: 3328.328
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 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 andrjohns merged commit c12fff9 into develop Feb 19, 2024
8 checks passed
@SteveBronder
Copy link
Collaborator Author

@andrjohns thank you for taking this over the finish line!

@SteveBronder SteveBronder deleted the fix/constexpr-constants branch February 19, 2024 19:45
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

4 participants