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

Remove support for ~/.config makefile inclusion #3295

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

WardBrian
Copy link
Member

Submission Checklist

  • Run unit tests: ./runTests.py src/test/unit
  • Run cpplint: make cpplint
  • Declare copyright holder and open-source license: see below

Summary

Counterpart to stan-dev/math#3090

Intended Effect

How to Verify

Side Effects

Documentation

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@WardBrian WardBrian requested a review from SteveBronder June 27, 2024 13:46
@stan-buildbot
Copy link
Contributor


Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.46 0.46 0.99 -0.94% slower
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.02 0.61 -64.55% slower
gp_regr/gen_gp_data.stan 0.05 0.02 2.07 51.62% faster
gp_regr/gp_regr.stan 0.14 0.12 1.15 12.73% faster
sir/sir.stan 96.96 91.29 1.06 5.86% faster
irt_2pl/irt_2pl.stan 5.81 5.36 1.08 7.77% faster
eight_schools/eight_schools.stan 0.09 0.08 1.16 13.43% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.36 0.33 1.11 10.22% faster
pkpd/one_comp_mm_elim_abs.stan 28.62 24.96 1.15 12.79% faster
garch/garch.stan 0.63 0.55 1.14 12.1% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 3.82 3.41 1.12 10.74% faster
arK/arK.stan 2.46 2.43 1.01 1.35% faster
gp_pois_regr/gp_pois_regr.stan 3.99 3.55 1.12 10.98% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 12.07 11.13 1.08 7.77% faster
performance.compilation 253.36 264.34 0.96 -4.34% slower
Mean result: 1.1207432350134816

Jenkins Console Log
Blue Ocean
Commit hash: 38acfff7b8804fe620d45a50072b99a39ce01a3b


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: 2400.000
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

@wds15
Copy link
Contributor

wds15 commented Jun 29, 2024

How come you want to remove this functionality? I have used this a few times to set things from my home dir as I am not allowed on my cluster to edit the cmdstan install dir. So how can users set stan makefile matters in the future from a user writable directory (meaning their home)? I do have to use the cmdstan installed into the system for compliance reasons.

@WardBrian
Copy link
Member Author

Hi @wds15 -

Some explanation was given in stan-dev/math#3088, but in short there are 3 main reasons:

  • This 'feature' is almost completely undocumented. There were ~two mentions of it in the math developer documentation, none in the users guides.
  • It causes issues on Windows machines
  • Global config is in general hard to debug and having only one place that users can include special variables makes it easier to find config issues when they arise

If you are in a situation, as you describe, where the HOME folder behavior is desirable, you should ask the system administrators to add a make/local which defers to user's folders. For example, just adding the line this PR removes:

-include $(HOME)/.config/stan/make.local 

to the global installation's make/local would opt back in to this behavior while not requiring the project as a whole to support it.

@wds15
Copy link
Contributor

wds15 commented Jul 2, 2024

I see. Thanks for the explanation and the workaround to get the old behaviour.

Could the workaround be added to the example make/local which is distributed possibly? If not enabled, then at least in a commented out variant?

I consider it standard behaviour that programs respect config files residing it in users home directories...but you are right in that this specific option was not documented and I took it from the source.

Copy link
Member

@mitzimorris mitzimorris left a comment

Choose a reason for hiding this comment

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

lgtm!

@WardBrian WardBrian merged commit a582c80 into develop Aug 26, 2024
3 checks passed
@WardBrian WardBrian deleted the fix/remove-HOME-makefile-inclusion branch August 26, 2024 12:25
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.

4 participants