Refactor/services callbacks

[mitzimorris]

Submission Checklist

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

Summary

Adds a "dispatcher" object to stan::callbacks and utility function "configure_dispatcher" to stan::services::util, with unit tests for each.

The dispatcher object maps information types to callbacks. Because classes callbacks::writer and callbacks::structured_writer aren't compatible, it introduces a "channel" class which serves as a base type for all callbacks, with subclasses writer_channel and structured_writer_channel.

The dispatcher provides methods dispatch, begin_record and end_record. The first argument for all methods is the information type. For method dispatch the remaining args correspond to the callbacks::writer's operator () overloads and the callbacks::structured_writer's write methods. For methods begin_record and end_record, the remaing args correspond to the callbacks::structured_writer's begin_record and end_record, respectively.

The function configure_dispatcher is used by clients to add information_type, callback pairs to the dispatcher's internal channel map. This allows clients to specify which information to save, if any.

Intended Effect

This decouples the choice of outputs from the services layer API calls; instead of specifying output files the sample, the sampler diagnostics, and the adapted metric, etc., services calls take a single dispatcher object. The dispatcher introduces the base channel class which allows for the introduction of new kinds of callbacks, e.g., raw text writers, raw binary writers.

How to Verify

Unit tests

Side Effects

N/A

Documentation

code comments

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): Columbia University

By submitting this pull request, the copyright holder is agreeing to 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/)

[mitzimorris]

This PR replaces PR #3337.

PR 3337 updated the stan::services::util methods and stan::services::sample::hmc_nuts_diag_e_adapt sampler to use the dispatcher object. The proof-of-concept unit test is configured to capture the initial parameters on the unconstrained scale, as well as the metric, sample, and diagnostics. This PR anticipates further refactoring of the stan::services layer before trying to replace callback writers with a dispatcher.

[stan-buildbot]

---

Name	Old Result	New Result	Ratio	Performance change( 1 - new / old )
arma/arma.stan	0.34	0.32	1.05	4.42% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan	0.01	0.01	1.01	0.71% faster
gp_regr/gen_gp_data.stan	0.03	0.02	1.08	7.67% faster
gp_regr/gp_regr.stan	0.1	0.09	1.08	7.72% faster
sir/sir.stan	70.92	65.97	1.08	6.98% faster
irt_2pl/irt_2pl.stan	4.31	3.91	1.1	9.11% faster
eight_schools/eight_schools.stan	0.06	0.06	1.07	6.47% faster
pkpd/sim_one_comp_mm_elim_abs.stan	0.26	0.24	1.07	6.42% faster
pkpd/one_comp_mm_elim_abs.stan	19.72	18.37	1.07	6.84% faster
garch/garch.stan	0.47	0.4	1.19	15.83% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan	2.8	2.59	1.08	7.63% faster
arK/arK.stan	1.82	1.74	1.05	4.82% faster
gp_pois_regr/gp_pois_regr.stan	2.96	2.69	1.1	9.23% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan	9.17	8.3	1.1	9.5% faster
performance.compilation	184.62	180.77	1.02	2.08% faster
Mean result: 1.0770594761053522

---

Jenkins Console Log
Blue Ocean
Commit hash: dfc21285f1149f6ea7bcc073ecbf5129975375f2

---

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 Reg file data sampling: Not affected
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; BHI 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