tim::settings Struct Reference

#include "timemory/settings/settings.hpp"

Collaboration diagram for tim::settings:

Public Types
using	data_type_list_t = tim::type_list< bool, string_t, int16_t, int32_t, int64_t, uint16_t, uint32_t, uint64_t, size_t, float, double >
using	strvector_t = std::vector< std::string >
using	value_type = std::shared_ptr< vsettings >
using	data_type = std::unordered_map< string_view_t, value_type >
using	iterator = typename data_type::iterator
using	const_iterator = typename data_type::const_iterator
using	pointer_t = std::shared_ptr< settings >
template<typename Tp , typename Vp >
using	tsetting_pointer_t = std::shared_ptr< tsettings< Tp, Vp > >

Public Member Functions
	settings ()
	~settings ()=default
	settings (const settings &)
	settings (settings &&) noexcept=default
settings &	operator= (const settings &)
settings &	operator= (settings &&) noexcept=default
void	initialize ()
void	set_tag (std::string _v)
	the "tag" for settings should generally be the basename of exe More...
std::string	get_tag () const
	the "tag" for settings should generally be the basename of exe More...
bool	get_initialized () const
	returns whether timemory_init has been invoked More...
	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, config_file) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing	TIMEMORY_SETTINGS_MEMBER_DECL (bool, suppress_config) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled	TIMEMORY_SETTINGS_MEMBER_DECL (bool, auto_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output	TIMEMORY_SETTINGS_MEMBER_DECL (bool, file_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output	TIMEMORY_SETTINGS_MEMBER_DECL (bool, json_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output	TIMEMORY_SETTINGS_MEMBER_DECL (bool, dart_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output	TIMEMORY_SETTINGS_MEMBER_DECL (bool, plot_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output	TIMEMORY_SETTINGS_MEMBER_DECL (bool, flamegraph_output) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes	TIMEMORY_SETTINGS_MEMBER_DECL (int, verbose) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug	TIMEMORY_SETTINGS_MEMBER_DECL (bool, banner) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads	TIMEMORY_SETTINGS_MEMBER_DECL (bool, collapse_processes) TIMEMORY_SETTINGS_MEMBER_DECL(uint16_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, time_format) TIMEMORY_SETTINGS_MEMBER_DECL(int16_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision	TIMEMORY_SETTINGS_MEMBER_DECL (int16_t, width) TIMEMORY_SETTINGS_MEMBER_DECL(int32_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width	TIMEMORY_SETTINGS_MEMBER_DECL (bool, scientific) TIMEMORY_SETTINGS_MEMBER_DECL(int16_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision	TIMEMORY_SETTINGS_MEMBER_DECL (int16_t, timing_width) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units	TIMEMORY_SETTINGS_MEMBER_DECL (bool, timing_scientific) TIMEMORY_SETTINGS_MEMBER_DECL(int16_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision	TIMEMORY_SETTINGS_MEMBER_DECL (int16_t, memory_width) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units	TIMEMORY_SETTINGS_MEMBER_DECL (bool, memory_scientific) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, output_prefix) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, input_prefix) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, dart_type) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count	TIMEMORY_SETTINGS_MEMBER_DECL (bool, dart_label) TIMEMORY_SETTINGS_MEMBER_DECL(size_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks	TIMEMORY_SETTINGS_MEMBER_DECL (bool, cpu_affinity) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing	TIMEMORY_SETTINGS_MEMBER_DECL (bool, add_secondary) TIMEMORY_SETTINGS_MEMBER_DECL(size_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count	TIMEMORY_SETTINGS_MEMBER_DECL (size_t, throttle_value) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, tuple_components) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, ompt_components) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, ncclp_components) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, profiler_components) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, components) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init	TIMEMORY_SETTINGS_MEMBER_DECL (bool, mpi_finalize) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, mpi_thread_type) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init	TIMEMORY_SETTINGS_MEMBER_DECL (bool, upcxx_finalize) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading	TIMEMORY_SETTINGS_MEMBER_DECL (bool, papi_multiplexing) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error	TIMEMORY_SETTINGS_MEMBER_DECL (bool, papi_quiet) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events	TIMEMORY_SETTINGS_MEMBER_DECL (bool, papi_attach) TIMEMORY_SETTINGS_MEMBER_DECL(int
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, cuda_event_batch_size) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync	TIMEMORY_SETTINGS_MEMBER_DECL (int32_t, cupti_activity_level) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, cupti_events) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics	TIMEMORY_SETTINGS_MEMBER_DECL (int, cupti_device) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, cpu_roofline_mode) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, cpu_roofline_events) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events	TIMEMORY_SETTINGS_MEMBER_DECL (bool, roofline_type_labels) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu	TIMEMORY_SETTINGS_MEMBER_DECL (bool, roofline_type_labels_gpu) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_num_threads) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_num_threads_gpu) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_grid_size) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_alignment) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_min_working_size_cpu) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_max_data_size) TIMEMORY_SETTINGS_MEMBER_DECL(uint64_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu	TIMEMORY_SETTINGS_MEMBER_DECL (uint64_t, ert_max_data_size_gpu) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops	TIMEMORY_SETTINGS_MEMBER_DECL (string_t, craypat_categories) TIMEMORY_SETTINGS_MEMBER_DECL(int32_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count	TIMEMORY_SETTINGS_MEMBER_DECL (bool, destructor_report) TIMEMORY_SETTINGS_MEMBER_DECL(string_t
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe	TIMEMORY_SETTINGS_MEMBER_DECL (int64_t, separator_frequency) TIMEMORY_SETTINGS_MEMBER_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe enable_signal_handler	TIMEMORY_SETTINGS_REFERENCE_DECL (bool, allow_signal_handler) TIMEMORY_SETTINGS_REFERENCE_DECL(bool
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe enable_signal_handler enable_all_signals	TIMEMORY_SETTINGS_REFERENCE_DECL (bool, disable_all_signals) TIMEMORY_SETTINGS_REFERENCE_DECL(bool
strvector_t &	get_command_line ()
strvector_t &	get_environment ()
	TIMEMORY_STATIC_ACCESSOR (bool, use_output_suffix, get_env< bool >("TIMEMORY_USE_OUTPUT_SUFFIX", false)) TIMEMORY_STATIC_ACCESSOR(int32_t
	process::get_id ()) static strvector_t get_global_environment()
template<typename Archive >
void	load (Archive &ar, unsigned int)
template<typename Archive >
void	save (Archive &ar, unsigned int) const
bool	read (const string_t &)
	read a configuration file More...
bool	read (std::istream &, string_t="")
void	init_config (bool search_default=true)
auto	ordering () const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
template<typename Sp = string_t>
auto	find (Sp &&_key, bool _exact=true)
template<typename Tp , typename Sp = string_t>
Tp	get (Sp &&_key, bool _exact=true)
template<typename Tp , typename Sp = string_t>
bool	get (Sp &&_key, Tp &_val, bool _exact)
template<typename Tp , typename Sp = string_t>
bool	set (Sp &&_key, Tp &&_val, bool _exact=true)
bool	update (const std::string &_key, const std::string &_val, bool _exact=false)
	Update a setting via a string. Returns whether a matching setting for the identifier was found (NOT whether the value was actually updated) More...
template<typename Tp , typename Vp , typename Sp , typename... Args>
auto	insert (Sp &&_env, const std::string &_name, const std::string &_desc, Vp _init, Args &&... _args)
template<typename Tp , typename Vp , typename Sp = string_t>
auto	insert (tsetting_pointer_t< Tp, Vp > _ptr, Sp &&_env={})
template<typename Tag >
std::shared_ptr< settings > &	private_shared_instance (enable_if_t< std::is_same< Tag, TIMEMORY_API >::value, int >)
template<typename Tag >
std::shared_ptr< settings > &	private_shared_instance (enable_if_t<!std::is_same< Tag, TIMEMORY_API >::value, long >)
template<typename Tag >
std::shared_ptr< settings >	push ()
template<typename Tag >
std::shared_ptr< settings >	pop ()
template<typename Tag >
std::shared_ptr< settings >	shared_instance ()

Static Public Member Functions
template<typename Tag = TIMEMORY_API>
static std::time_t *	get_launch_time (Tag={})
template<typename Tag >
static pointer_t	shared_instance ()
template<typename Tag >
static settings *	instance ()
static pointer_t	shared_instance ()
static settings *	instance ()
static std::string	get_fallback_tag ()
	if the tag is not explicitly set, try to compute it. Otherwise use the TIMEMORY_SETTINGS_PREFIX_ More...
suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe enable_signal_handler enable_all_signals flat_profile static TIMEMORY_SETTINGS_REFERENCE_DECL(bool, timeline_profile) TIMEMORY_SETTINGS_REFERENCE_DECL(process strvector_t &	environment ()
static string_t	tolower (string_t str)
static string_t	toupper (string_t str)
static string_t	get_global_input_prefix ()
static string_t	get_global_output_prefix (bool _make_dir=false)
static void	store_command_line (int argc, char **argv)
static string_t	compose_output_filename (string_t _tag, string_t _ext, bool _use_suffix=use_output_suffix(), int32_t _suffix=default_process_suffix(), bool _make_dir=false, std::string _explicit={})
static string_t	compose_input_filename (string_t _tag, string_t _ext, bool _use_suffix=use_output_suffix(), int32_t _suffix=default_process_suffix(), std::string _explicit={})
static void	parse (settings *=instance< TIMEMORY_API >())
static void	parse (const std::shared_ptr< settings > &)
static std::string	format (std::string _fpath, const std::string &_tag)
static std::string	format (std::string _prefix, std::string _tag, std::string _suffix, std::string _ext)
template<typename Archive >
static void	serialize_settings (Archive &)
template<typename Archive >
static void	serialize_settings (Archive &, settings &)
template<size_t Idx = 0>
static int64_t	indent_width (int64_t _w=settings::width())
template<typename Tp , size_t Idx = 0>
static int64_t	indent_width (int64_t _w=indent_width< Idx >())
template<typename Tag >
static pointer_t	push ()
	Make a copy of the current settings and return a new instance whose values can be modified, used, and then discarded. The values modified do not change any settings accessed through static methods or the non-templated instance method. E.g. tim::settings::enabled() will not be affected by changes to settings instance returned by this method. More...
template<typename Tag >
static pointer_t	pop ()
	Restore the settings from a previous push operations. More...

Public Attributes
	default_process_suffix

Protected Member Functions
template<typename Archive , typename Tp >
auto	get_serialize_pair () const
template<typename Archive , typename... Tail>
auto	get_serialize_map (tim::type_list< Tail... >) const

Friends
class	manager
void	timemory_init (int, char **, const std::string &, const std::string &)
	initialization (creates manager and configures output path) More...
void	timemory_finalize ()
	finalization of the specified types More...

Detailed Description

Definition at line 70 of file settings.hpp.

Member Typedef Documentation

const_iterator

using tim::settings::const_iterator = typename data_type::const_iterator

Definition at line 84 of file settings.hpp.

data_type

using tim::settings::data_type = std::unordered_map<string_view_t, value_type>

Definition at line 82 of file settings.hpp.

data_type_list_t

using tim::settings::data_type_list_t = tim::type_list<bool, string_t, int16_t, int32_t, int64_t, uint16_t, uint32_t, uint64_t, size_t, float, double>

Definition at line 76 of file settings.hpp.

iterator

using tim::settings::iterator = typename data_type::iterator

Definition at line 83 of file settings.hpp.

pointer_t

using tim::settings::pointer_t = std::shared_ptr<settings>

Definition at line 85 of file settings.hpp.

strvector_t

using tim::settings::strvector_t = std::vector<std::string>

Definition at line 80 of file settings.hpp.

tsetting_pointer_t

template<typename Tp , typename Vp >

using tim::settings::tsetting_pointer_t = std::shared_ptr<tsettings<Tp, Vp> >

Definition at line 88 of file settings.hpp.

value_type

using tim::settings::value_type = std::shared_ptr<vsettings>

Definition at line 81 of file settings.hpp.

Constructor & Destructor Documentation

settings() [1/3]

TIMEMORY_SETTINGS_INLINE tim::settings::settings

(

)

Definition at line 438 of file settings.cpp.

: m_data(data_type{})
{
    // PRINT_HERE("%s", "");
    initialize();
}

References initialize().

~settings()

tim::settings::~settings ( )

default

settings() [2/3]

TIMEMORY_SETTINGS_INLINE tim::settings::settings

(

const settings &

rhs

)

Definition at line 448 of file settings.cpp.

: m_data(data_type{})
, m_order(rhs.m_order)
, m_command_line(rhs.m_command_line)
, m_environment(rhs.m_environment)
{
    for(const auto& itr : rhs.m_data)
        m_data.emplace(itr.first, itr.second->clone());
    for(auto& itr : m_order)
    {
        if(m_data.find(itr) == m_data.end())
        {
            auto ritr = rhs.m_data.find(itr);
            if(ritr == rhs.m_data.end())
            {
                TIMEMORY_EXCEPTION(string_t("Error! Missing ordered entry: ") + itr)
            }
            else
            {
                m_data.emplace(itr, ritr->second->clone());
            }
        }
    }
}

References TIMEMORY_EXCEPTION.

settings() [3/3]

tim::settings::settings ( settings &&  )

defaultnoexcept

Member Function Documentation

begin() [1/2]

iterator tim::settings::begin ( )

inline

Definition at line 320 of file settings.hpp.

{ return m_data.begin(); }

Referenced by find().

begin() [2/2]

const_iterator tim::settings::begin ( ) const

inline

Definition at line 322 of file settings.hpp.

{ return m_data.cbegin(); }

cbegin()

const_iterator tim::settings::cbegin ( ) const

inline

Definition at line 324 of file settings.hpp.

{ return m_data.cbegin(); }

cend()

const_iterator tim::settings::cend ( ) const

inline

Definition at line 325 of file settings.hpp.

{ return m_data.cend(); }

compose_input_filename()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::compose_input_filename ( string_t  _tag, string_t  _ext, bool  _use_suffix = use_output_suffix(), int32_t  _suffix = default_process_suffix(), std::string  _explicit = {}  )

static

Definition at line 363 of file settings.cpp.

{
    if(settings::input_path().empty())
        settings::input_path() = settings::output_path();
 
    if(settings::input_prefix().empty())
        settings::input_prefix() = settings::output_prefix();
 
    auto _prefix =
        (_explicit.length() > 0) ? std::move(_explicit) : get_global_input_prefix();
 
    auto only_ascii = [](char c) { return isascii(c) == 0; };
 
    _prefix.erase(std::remove_if(_prefix.begin(), _prefix.end(), only_ascii),
                  _prefix.end());
 
    auto _suffix = (_use_suffix && _output_suffix >= 0)
                       ? (std::string("-") + std::to_string(_output_suffix))
                       : std::string("");
 
    // create the path
    std::string _fpath = format(_prefix, std::move(_tag), _suffix, std::move(_ext));
 
    return filepath::osrepr(_fpath);
}

References tim::_prefix, tim::_suffix, format(), get_global_input_prefix(), tim::input_path, tim::input_prefix, tim::output_path, and tim::output_prefix.

Referenced by tim::operation::finalize::print< Tp, true >::setup().

compose_output_filename()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::compose_output_filename ( string_t  _tag, string_t  _ext, bool  _use_suffix = use_output_suffix(), int32_t  _suffix = default_process_suffix(), bool  _make_dir = false, std::string  _explicit = {}  )

static

Definition at line 322 of file settings.cpp.

{
    bool _is_explicit = (!_explicit.empty());
    // if there isn't an explicit prefix, get the <OUTPUT_PATH>/<OUTPUT_PREFIX>
    auto _prefix =
        (!_explicit.empty()) ? std::move(_explicit) : get_global_output_prefix(_make_dir);
 
    // return on empty
    if(_prefix.empty())
        return "";
 
    auto only_ascii = [](char c) { return isascii(c) == 0; };
 
    _prefix.erase(std::remove_if(_prefix.begin(), _prefix.end(), only_ascii),
                  _prefix.end());
 
    // if explicit prefix is provided, then make the directory
    if(_is_explicit && _make_dir)
    {
        auto ret = makedir(_prefix);
        if(ret != 0)
            _prefix = filepath::osrepr(std::string("./"));
    }
 
    // add the mpi rank if not root
    auto _suffix = (_use_suffix && _output_suffix >= 0)
                       ? (std::string("-") + std::to_string(_output_suffix))
                       : std::string("");
 
    // create the path
    std::string _fpath = format(_prefix, std::move(_tag), _suffix, std::move(_ext));
 
    return filepath::osrepr(_fpath);
}

References tim::_prefix, tim::_suffix, format(), get_global_output_prefix(), and tim::makedir().

Referenced by tim::operation::finalize::flamegraph< Type >::flamegraph(), tim::component::perfetto_trace::global_finalize(), tim::operation::finalize::ctest_notes_deleter::operator()(), tim::plotting::operation::plot(), tim::ert::serialize(), tim::operation::finalize::print< Tp, true >::setup(), tim::component::gperftools_cpu_profiler::start(), and tim::component::gperftools_heap_profiler::start().

end() [1/2]

iterator tim::settings::end ( )

inline

Definition at line 321 of file settings.hpp.

{ return m_data.end(); }

Referenced by find().

end() [2/2]

const_iterator tim::settings::end ( ) const

inline

Definition at line 323 of file settings.hpp.

{ return m_data.cend(); }

environment()

TIMEMORY_SETTINGS_INLINE settings::strvector_t & tim::settings::environment ( )

static

Definition at line 91 of file settings.cpp.

{
    return instance()->get_environment();
}

References get_environment(), and instance().

find()

template<typename Sp >

auto tim::settings::find ( Sp &&  _key, bool  _exact = true  )

inline

Definition at line 652 of file settings.hpp.

{
    // exact match to map key
    auto itr = m_data.find(std::forward<Sp>(_key));
    if(itr != m_data.end())
        return itr;
 
    // match against env_name, name, command-line options
    for(auto ditr = begin(); ditr != end(); ++ditr)
    {
        if(ditr->second && ditr->second->matches(std::forward<Sp>(_key), _exact))
            return ditr;
    }
 
    // not found
    return m_data.end();
}

References begin(), and end().

Referenced by get(), set(), and update().

format() [1/2]

TIMEMORY_SETTINGS_INLINE std::string tim::settings::format ( std::string  _fpath, const std::string &  _tag  )

static

Definition at line 222 of file settings.cpp.

{
    auto&       _cmdline     = command_line();
    std::string _arg0_string = {};    // only the first cmdline arg
    std::string _argv_string = {};    // entire argv cmd
    std::string _args_string = {};    // cmdline args
    std::string _argt_string = _tag;  // prefix + cmdline args
    std::string _tag0_string = _tag;  // only the basic prefix
    if(!_cmdline.empty())
    {
        _arg0_string += _cmdline.at(0);
        _argv_string += _cmdline.at(0);
        for(size_t i = 1; i < _cmdline.size(); ++i)
        {
            _argv_string += _cmdline.at(i);
            _argt_string += _cmdline.at(i);
            _args_string += _cmdline.at(i);
        }
    }
 
    auto _dmp_size      = TIMEMORY_JOIN("", dmp::size());
    auto _dmp_rank      = TIMEMORY_JOIN("", dmp::rank());
    auto _proc_id       = TIMEMORY_JOIN("", process::get_id());
    auto _slurm_job_id  = get_env<std::string>("SLURM_JOB_ID", "0", false);
    auto _slurm_proc_id = get_env<std::string>("SLURM_PROCID", _dmp_rank, false);
 
    auto _replace = [&_fpath](const auto& itr) {
        auto pos = std::string::npos;
        while((pos = _fpath.find(itr.first)) != std::string::npos)
            _fpath.replace(pos, itr.first.length(), itr.second);
    };
    using strpairinit_t = std::initializer_list<std::pair<std::string, std::string>>;
    for(auto&& itr : strpairinit_t{ { "--", "-" }, { "__", "_" }, { "//", "/" } })
    {
        _replace(itr);
    }
 
    if(_fpath.find('%') == std::string::npos)
        return _fpath;
 
    for(auto&& itr : strpairinit_t{ { "%arg0%", _arg0_string },
                                    { "%arg0_hash%", md5::compute_md5(_arg0_string) },
                                    { "%argv%", _arg0_string },
                                    { "%argv_hash%", md5::compute_md5(_argv_string) },
                                    { "%argt%", _argt_string },
                                    { "%argt_hash%", md5::compute_md5(_argt_string) },
                                    { "%args%", _args_string },
                                    { "%args_hash%", md5::compute_md5(_args_string) },
                                    { "%tag%", _tag0_string },
                                    { "%tag_hash%", md5::compute_md5(_tag0_string) },
                                    { "%pid%", _proc_id },
                                    { "%job%", _slurm_job_id },
                                    { "%rank%", _slurm_proc_id },
                                    { "%size%", _dmp_size },
                                    { "%m", md5::compute_md5(_argt_string) },
                                    { "%p", _proc_id },
                                    { "%j", _slurm_job_id },
                                    { "%r", _slurm_proc_id },
                                    { "%s", _dmp_size } })
    {
        _replace(itr);
    }
    return _fpath;
}

References tim::md5::compute_md5(), tim::pos, process::get_id(), and TIMEMORY_JOIN.

Referenced by compose_input_filename(), compose_output_filename(), and format().

format() [2/2]

TIMEMORY_SETTINGS_INLINE std::string tim::settings::format ( std::string  _prefix, std::string  _tag, std::string  _suffix, std::string  _ext  )

static

Definition at line 291 of file settings.cpp.

{
    // add period before extension
    if(_ext.find('.') != 0)
        _ext = std::string(".") + _ext;
 
    // if the tag contains the extension, remove it
    auto _ext_pos = _tag.length() - _ext.length();
    if(_tag.find(_ext) == _ext_pos)
        _tag = _tag.substr(0, _ext_pos);
 
    auto plast = static_cast<intmax_t>(_prefix.length()) - 1;
    // add dash if not empty, not ends in '/', and last char is alphanumeric
    if(!_prefix.empty() && _prefix[plast] != '/' && isalnum(_prefix[plast]) != 0)
        _prefix += "-";
 
    settings*   _instance   = instance();
    std::string _global_tag = {};
    if(_instance)
        _global_tag = _instance->get_tag();
    else
        _global_tag = get_fallback_tag();
 
    return format(_prefix + _tag + std::move(_suffix) + _ext, _global_tag);
}

References tim::_prefix, tim::_suffix, format(), get_fallback_tag(), get_tag(), and instance().

get() [1/2]

template<typename Tp , typename Sp >

Tp tim::settings::get	(	Sp &&	_key,
		bool	_exact = true
	)

Definition at line 674 of file settings.hpp.

{
    auto itr = find(std::forward<Sp>(_key), _exact);
    if(itr != m_data.end() && itr->second)
    {
        auto _vptr = itr->second;
        auto _tidx = std::type_index(typeid(Tp));
        auto _vidx = std::type_index(typeid(Tp&));
        if(_vptr->get_type_index() == _tidx && _vptr->get_value_index() == _tidx)
            return static_cast<tsettings<Tp, Tp>*>(_vptr.get())->get();
        if(_vptr->get_type_index() == _tidx && _vptr->get_value_index() == _vidx)
            return static_cast<tsettings<Tp, Tp&>*>(_vptr.get())->get();
    }
    return Tp{};
}

References find(), and get().

Referenced by get(), and instance().

get() [2/2]

template<typename Tp , typename Sp >

bool tim::settings::get	(	Sp &&	_key,
		Tp &	_val,
		bool	_exact
	)

Definition at line 694 of file settings.hpp.

{
    auto itr = find(std::forward<Sp>(_key), _exact);
    if(itr != m_data.end() && itr->second)
    {
        auto _vptr = itr->second;
        auto _tidx = std::type_index(typeid(Tp));
        auto _vidx = std::type_index(typeid(Tp&));
        if(_vptr->get_type_index() == _tidx && _vptr->get_value_index() == _tidx)
            return ((_val = static_cast<tsettings<Tp, Tp>*>(_vptr.get())->get()), true);
        if(_vptr->get_type_index() == _tidx && _vptr->get_value_index() == _vidx)
            return ((_val = static_cast<tsettings<Tp, Tp&>*>(_vptr.get())->get()), true);
    }
    return false;
}

References find(), and tim::tsettings< Tp, Vp >::get().

get_command_line()

strvector_t & tim::settings::get_command_line ( )

inline

Definition at line 249 of file settings.hpp.

{ return m_command_line; }

get_environment()

strvector_t & tim::settings::get_environment ( )

inline

Definition at line 250 of file settings.hpp.

{ return m_environment; }

Referenced by environment().

get_fallback_tag()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::get_fallback_tag ( )

static

if the tag is not explicitly set, try to compute it. Otherwise use the TIMEMORY_SETTINGS_PREFIX_

Definition at line 510 of file settings.cpp.

{
    std::string _tag = {};
 
    if(command_line().empty())
        command_line() = read_command_line(process::get_id());
 
    if(command_line().empty())
    {
        _tag      = std::string{ TIMEMORY_SETTINGS_PREFIX };
        auto _pos = std::string::npos;
        while((_pos = _tag.find_last_of('_')) == _tag.length() - 1)
            _tag = _tag.substr(0, _tag.length() - 1);
        return _tag;
    }
 
    _tag = command_line().front();
 
    while(_tag.find('\\') != std::string::npos)
        _tag = _tag.substr(_tag.find_last_of('\\') + 1);
 
    while(_tag.find('/') != std::string::npos)
        _tag = _tag.substr(_tag.find_last_of('/') + 1);
 
    for(auto&& itr : { std::string{ ".py" }, std::string{ ".exe" } })
    {
        if(_tag.find(itr) != std::string::npos)
            _tag.erase(_tag.find(itr), itr.length() + 1);
    }
 
    return _tag;
}

References process::get_id(), tim::read_command_line(), and TIMEMORY_SETTINGS_PREFIX.

Referenced by format(), and get_tag().

get_global_input_prefix()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::get_global_input_prefix ( )

static

Definition at line 157 of file settings.cpp.

{
    auto _dir    = input_path();
    auto _prefix = input_prefix();
 
    return filepath::osrepr(_dir + std::string("/") + _prefix);
}

References tim::plotting::_dir, tim::_prefix, tim::input_path, and tim::input_prefix.

Referenced by compose_input_filename().

get_global_output_prefix()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::get_global_output_prefix ( bool  _make_dir = false )

static

Definition at line 169 of file settings.cpp.

{
    static auto* _settings = instance();
 
    auto _dir = (_settings)
                    ? _settings->get_output_path()
                    : get_env<std::string>(TIMEMORY_SETTINGS_KEY("OUTPUT_PATH"), ".");
    auto _prefix = (_settings)
                       ? _settings->get_output_prefix()
                       : get_env<std::string>(TIMEMORY_SETTINGS_KEY("OUTPUT_PREFIX"), "");
    auto _time_output = (_settings)
                            ? _settings->get_time_output()
                            : get_env<bool>(TIMEMORY_SETTINGS_KEY("TIME_OUTPUT"), false);
    auto _time_format =
        (_settings)
            ? _settings->get_time_format()
            : get_env<std::string>(TIMEMORY_SETTINGS_KEY("TIME_FORMAT"), "%F_%I.%M_%p");
 
    if(_time_output)
    {
        // get the statically stored launch time
        auto* _launch_time    = get_launch_time(TIMEMORY_API{});
        auto  _local_datetime = get_local_datetime(_time_format.c_str(), _launch_time);
        if(_dir.find(_local_datetime) == std::string::npos)
        {
            if(_dir.length() > 0 && _dir[_dir.length() - 1] != '/')
                _dir += "/";
            _dir += _local_datetime;
        }
    }
 
    // always return zero if not making dir. if makedir failed, don't prefix with
    // directory
    auto ret = (_make_dir) ? makedir(_dir) : 0;
    return (ret == 0) ? filepath::osrepr(_dir + std::string("/") + _prefix)
                      : filepath::osrepr(std::string("./") + _prefix);
}

References tim::plotting::_dir, tim::_prefix, tim::_settings, get_launch_time(), tim::get_local_datetime(), instance(), tim::makedir(), TIMEMORY_API, and tim::TIMEMORY_SETTINGS_KEY().

Referenced by tim::manager::add_finalizer(), and compose_output_filename().

get_initialized()

bool tim::settings::get_initialized ( ) const

inline

returns whether timemory_init has been invoked

Definition at line 121 of file settings.hpp.

{ return m_initialized; }

Referenced by insert().

get_launch_time()

template<typename Tag >

std::time_t * tim::settings::get_launch_time ( Tag  = {} )

static

Definition at line 456 of file settings.hpp.

{
    // statically store the launch time, intentional memory leak
    static std::time_t* _time = new std::time_t{ std::time(nullptr) };
    return _time;
}

Referenced by get_global_output_prefix(), and tim::get_local_datetime().

get_serialize_map()

template<typename Archive , typename... Tail>

auto tim::settings::get_serialize_map ( tim::type_list< Tail... >  ) const

inlineprotected

Definition at line 394 of file settings.hpp.

    {
        using serialize_func_t = std::function<void(Archive&, value_type)>;
        using serialize_map_t  = std::map<std::type_index, serialize_func_t>;
 
        serialize_map_t _val{};
        TIMEMORY_FOLD_EXPRESSION(_val.insert(get_serialize_pair<Archive, Tail>()));
        return _val;
    }

References TIMEMORY_FOLD_EXPRESSION.

get_serialize_pair()

template<typename Archive , typename Tp >

auto tim::settings::get_serialize_pair ( ) const

inlineprotected

Definition at line 379 of file settings.hpp.

    {
        using serialize_func_t = std::function<void(Archive&, value_type)>;
        using serialize_pair_t = std::pair<std::type_index, serialize_func_t>;
 
        auto _func = [](Archive& _ar, value_type _val) {
            using Up = tsettings<Tp>;
            if(!_val)
                _val = std::make_shared<Up>();
            _ar(cereal::make_nvp(_val->get_env_name(), *static_cast<Up*>(_val.get())));
        };
        return serialize_pair_t{ std::type_index(typeid(Tp)), _func };
    }

get_tag()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::get_tag

(

)

const

the "tag" for settings should generally be the basename of exe

Definition at line 547 of file settings.cpp.

{
    if(m_tag.empty())
    {
        if(command_line().empty() && !m_command_line.empty())
            command_line() = m_command_line;
 
        const_cast<settings*>(this)->m_tag = get_fallback_tag();
    }
 
    return m_tag;
}

References get_fallback_tag().

Referenced by format().

indent_width() [1/2]

template<typename Tp , size_t Idx>

int64_t tim::settings::indent_width ( int64_t  _w = indent_width<Idx>() )

static

Definition at line 557 of file settings.hpp.

{
    auto        _tidx = std::type_index{ typeid(Tp) };
    auto_lock_t _lk{ type_mutex<settings, TIMEMORY_API>() };
    auto&       _itr = indent_width_map()[Idx][_tidx];
    return (_itr = std::max<int64_t>(_itr, _w));
}

indent_width() [2/2]

template<size_t Idx>

int64_t tim::settings::indent_width ( int64_t  _w = settings::width() )

static

Definition at line 545 of file settings.hpp.

{
    auto        _tidx = std::type_index{ typeid(TIMEMORY_API) };
    auto_lock_t _lk{ type_mutex<settings, TIMEMORY_API>() };
    auto&       _itr = indent_width_map()[Idx][_tidx];
    return (_itr = std::max<int64_t>(_itr, _w));
}

References TIMEMORY_API.

init_config()

TIMEMORY_SETTINGS_INLINE void tim::settings::init_config

(

bool

search_default = true

)

Definition at line 1573 of file settings.cpp.

{
    if(get_debug() || get_verbose() > 3)
        PRINT_HERE("%s", "");
 
    static const auto _dcfgs = std::set<std::string>{
        get_env<string_t>("HOME") + std::string("/.timemory.cfg"),
        get_env<string_t>("HOME") + std::string("/.timemory.json"),
        get_env<string_t>("HOME") + std::string("/.config/timemory.cfg"),
        get_env<string_t>("HOME") + std::string("/.config/timemory.json")
    };
 
    auto _cfg   = get_config_file();
    auto _files = tim::delimit(_cfg, ",;:");
    for(const auto& citr : _files)
    {
        // a previous config file may have suppressed it
        if(get_suppress_config())
            break;
 
        // skip defaults
        if(!_search_default && _dcfgs.find(citr) != _dcfgs.end())
            continue;
 
        if(m_read_configs.find(citr) != m_read_configs.end())
            continue;
 
        std::ifstream ifs{ citr };
        if(ifs)
        {
            if(read(ifs, citr))
                m_read_configs.emplace(citr);
        }
        else if(_dcfgs.find(citr) == _dcfgs.end())
        {
            TIMEMORY_EXCEPTION(std::string("Error reading configuration file: ") + citr);
        }
    }
}

References tim::delimit(), PRINT_HERE, read(), and TIMEMORY_EXCEPTION.

initialize()

TIMEMORY_SETTINGS_INLINE void tim::settings::initialize

(

)

Definition at line 1303 of file settings.cpp.

{
    // m_data.clear();
    if(m_data.empty())
        m_data.reserve(160);
 
    initialize_core();
    initialize_components();
    initialize_io();
    initialize_format();
    initialize_parallel();
    initialize_tpls();
    initialize_roofline();
    initialize_miscellaneous();
    initialize_ert();
    initialize_dart();
}

Referenced by settings().

insert() [1/2]

template<typename Tp , typename Vp , typename Sp , typename... Args>

auto tim::settings::insert	(	Sp &&	_env,
		const std::string &	_name,
		const std::string &	_desc,
		Vp	_init,
		Args &&...	_args
	)

Template Parameters

Tp	Data-type of the setting
Vp	Value-type of the setting (Tp or Tp&)
Sp	String-type

Definition at line 764 of file settings.hpp.

{
    static_assert(is_one_of<Tp, data_type_list_t>::value,
                  "Error! Data type is not supported. See settings::data_type_list_t");
    static_assert(std::is_same<decay_t<Tp>, decay_t<Vp>>::value,
                  "Error! Initializing value is not the same as the declared type");
 
    auto _sid = std::string{ std::forward<Sp>(_env) };
    if(get_initialized())  // don't set env before timemory_init
        set_env(_sid, _init, 0);
    m_order.push_back(_sid);
    return m_data.insert(
        { string_view_t{ m_order.back() },
          std::make_shared<tsettings<Tp, Vp>>(_init, _name, _sid, _desc,
                                              std::forward<Args>(_args)...) });
}

References tim::_args, get_initialized(), and tim::set_env().

insert() [2/2]

template<typename Tp , typename Vp , typename Sp >

auto tim::settings::insert	(	tsetting_pointer_t< Tp, Vp >	_ptr,
		Sp &&	_env = {}
	)

Template Parameters

Tp	Data-type of the setting
Vp	Value-type of the setting (Tp or Tp&)
Sp	String-type

Definition at line 786 of file settings.hpp.

{
    static_assert(is_one_of<Tp, data_type_list_t>::value,
                  "Error! Data type is not supported. See settings::data_type_list_t");
    if(_ptr)
    {
        auto _sid = std::string{ std::forward<Sp>(_env) };
        if(_sid.empty())
            _sid = _ptr->get_env_name();
        if(!_sid.empty())
        {
            if(get_initialized())  // don't set env before timemory_init
                set_env(_sid, _ptr->as_string(), 0);
            m_order.push_back(_sid);
            return m_data.insert({ string_view_t{ m_order.back() }, _ptr });
        }
    }
 
    return std::make_pair(m_data.end(), false);
}

References get_initialized(), and tim::set_env().

instance() [1/2]

template<typename Tag >

settings * tim::settings::instance

static

Definition at line 536 of file settings.hpp.

{
    return shared_instance<Tag>().get();
}

References get().

Referenced by tim::operation::finalize::merge< Type, true >::merge(), environment(), format(), tim::env::get_bundle_components(), get_global_output_prefix(), tim::component::network_stats::get_interfaces(), tim::operation::finalize::ctest_notes_deleter::operator()(), push(), and serialize_settings().

instance() [2/2]

TIMEMORY_SETTINGS_INLINE settings * tim::settings::instance ( )

static

Definition at line 70 of file settings.cpp.

{
    // do not take reference to ensure push/pop w/o template parameters do not change
    // the settings
    static auto _instance = shared_instance();
    return _instance.get();
}

References shared_instance().

load()

template<typename Archive >

void tim::settings::load	(	Archive &	ar,
		unsigned int
	)

Definition at line 588 of file settings.hpp.

{
#if !defined(TIMEMORY_DISABLE_SETTINGS_SERIALIZATION)
    using map_type = std::map<std::string, std::shared_ptr<vsettings>>;
    map_type _data;
    for(const auto& itr : m_data)
        _data.insert({ std::string{ itr.first }, itr.second->clone() });
    auto _map = get_serialize_map<Archive>(data_type_list_t{});
    for(const auto& itr : _data)
    {
        auto mitr = _map.find(itr.second->get_type_index());
        if(mitr != _map.end())
            mitr->second(ar, itr.second);
    }
    ar(cereal::make_nvp("command_line", m_command_line),
       cereal::make_nvp("environment", m_environment));
    for(const auto& itr : _data)
    {
        auto ditr = m_data.find(itr.first);
        if(ditr != m_data.end())
        {
            ditr->second->clone(itr.second);
        }
        else
        {
            m_order.push_back(itr.first);
            m_data.insert({ m_order.back(), itr.second });
        }
    }
#else
    consume_parameters(ar);
#endif
}

References tim::consume_parameters().

operator=() [1/2]

TIMEMORY_SETTINGS_INLINE settings & tim::settings::operator=

(

const settings &

rhs

)

Definition at line 477 of file settings.cpp.

{
    // PRINT_HERE("%s", "");
    if(this == &rhs)
        return *this;
 
    for(const auto& itr : rhs.m_data)
        m_data[itr.first] = itr.second->clone();
    m_order        = rhs.m_order;
    m_command_line = rhs.m_command_line;
    m_environment  = rhs.m_environment;
    for(auto& itr : m_order)
    {
        if(m_data.find(itr) == m_data.end())
        {
            auto ritr = rhs.m_data.find(itr);
            if(ritr == rhs.m_data.end())
            {
                TIMEMORY_EXCEPTION(string_t("Error! Missing ordered entry: ") + itr)
            }
            else
            {
                m_data.emplace(itr, ritr->second->clone());
            }
        }
    }
    return *this;
}

References TIMEMORY_EXCEPTION.

operator=() [2/2]

settings & tim::settings::operator= ( settings &&  )

defaultnoexcept

ordering()

auto tim::settings::ordering ( ) const

inline

Definition at line 319 of file settings.hpp.

{ return m_order; }

parse() [1/2]

TIMEMORY_SETTINGS_INLINE void tim::settings::parse ( const std::shared_ptr< settings > &  _settings )

static

Definition at line 394 of file settings.cpp.

{
    if(_settings)
        parse(_settings.get());
}

References tim::_settings, tim::argparse::argument_parser::get(), and parse().

parse() [2/2]

TIMEMORY_SETTINGS_INLINE void tim::settings::parse ( settings *  _settings = instance<TIMEMORY_API>() )

static

Definition at line 410 of file settings.cpp.

{
    if(!_settings)
    {
        PRINT_HERE("%s", "nullptr to tim::settings");
        return;
    }
 
    if(_settings->get_suppress_parsing())
    {
        static auto _once = false;
        if(!_once)
        {
            PRINT_HERE("%s", "settings parsing has been suppressed");
            _once = true;
        }
        return;
    }
 
    for(const auto& itr : *_settings)
    {
        itr.second->parse();
    }
}

References tim::_settings, and PRINT_HERE.

Referenced by tim::if(), parse(), timemory_set_environ(), and timemory_trace_set_env().

pop() [1/2]

template<typename Tag >

static pointer_t tim::settings::pop ( )

static

Restore the settings from a previous push operations.

Template Parameters

API	Tagged type

pop() [2/2]

template<typename Tag >

std::shared_ptr< settings > tim::settings::pop

(

)

Definition at line 507 of file settings.hpp.

{
    auto& _stack = get_stack<Tag>();
    if(_stack.empty())
    {
        PRINT_HERE("%s", "Ignoring settings::pop() on empty stack");
        return shared_instance<Tag>();
    }
 
    auto _top                      = _stack.top();
    private_shared_instance<Tag>() = _top;
    _stack.pop();
    return _top;
}

References PRINT_HERE.

private_shared_instance() [1/2]

template<typename Tag >

std::shared_ptr< settings > & tim::settings::private_shared_instance

(

enable_if_t< std::is_same< Tag, TIMEMORY_API >::value, int >

)

Definition at line 466 of file settings.hpp.

{
    // this is the original
    static std::shared_ptr<settings> _instance = std::make_shared<settings>();
    return _instance;
}

private_shared_instance() [2/2]

template<typename Tag >

std::shared_ptr< settings > & tim::settings::private_shared_instance

(

enable_if_t<!std::is_same< Tag, TIMEMORY_API >::value, long >

)

Definition at line 477 of file settings.hpp.

{
    // make a copy of the original
    static std::shared_ptr<settings> _instance =
        std::make_shared<settings>(*private_shared_instance<TIMEMORY_API>());
    return _instance;
}

process::get_id()

tim::settings::process::get_id

(

)

Referenced by format(), and get_fallback_tag().

push() [1/2]

template<typename Tag >

static pointer_t tim::settings::push ( )

static

Make a copy of the current settings and return a new instance whose values can be modified, used, and then discarded. The values modified do not change any settings accessed through static methods or the non-templated instance method. E.g. tim::settings::enabled() will not be affected by changes to settings instance returned by this method.

Template Parameters

API	Tagged type

push() [2/2]

template<typename Tag >

std::shared_ptr< settings > tim::settings::push

(

)

Definition at line 490 of file settings.hpp.

{
    // ensure the non-template methods have their own static copies
    static auto* _discard_ptr  = instance();
    static auto* _discard_sptr = instance<TIMEMORY_API>();
    consume_parameters(_discard_ptr, _discard_sptr);
 
    auto _old = shared_instance<Tag>();
    get_stack<Tag>().push(_old);
    private_shared_instance<Tag>() = std::make_shared<settings>(*_old);
    return private_shared_instance<Tag>();
}

References tim::consume_parameters(), and instance().

read() [1/2]

TIMEMORY_SETTINGS_INLINE bool tim::settings::read

(

const string_t &

inp

)

read a configuration file

Definition at line 1325 of file settings.cpp.

{
#if defined(TIMEMORY_UNIX)
    auto file_exists = [](const std::string& _fname) {
        struct stat _buffer;
        if(stat(_fname.c_str(), &_buffer) == 0)
            return (S_ISREG(_buffer.st_mode) != 0 || S_ISLNK(_buffer.st_mode) != 0);
        return false;
    };
#else
    auto file_exists = [](const std::string&) { return true; };
#endif
 
    if(file_exists(inp))
    {
        std::ifstream ifs{ inp };
        if(ifs.is_open())
        {
            return read(ifs, inp);
        }
        else
        {
            TIMEMORY_EXCEPTION(string_t("Error reading configuration file: ") + inp)
        }
    }
    return false;
}

References read(), and TIMEMORY_EXCEPTION.

Referenced by init_config(), and read().

read() [2/2]

TIMEMORY_SETTINGS_INLINE bool tim::settings::read	(	std::istream &	ifs,
		string_t	inp = ""
	)

Definition at line 1357 of file settings.cpp.

{
    if(m_read_configs.find(inp) != m_read_configs.end())
    {
        PRINT_HERE("Warning! Re-reading config file: %s", inp.c_str());
    }
    m_read_configs.emplace(inp);
 
    if(inp.find(".json") != std::string::npos || inp == "json")
    {
        using policy_type = policy::input_archive<cereal::JSONInputArchive, TIMEMORY_API>;
        auto ia           = policy_type::get(ifs);
        try
        {
            ia->setNextName("timemory");
            ia->startNode();
            {
                try
                {
                    ia->setNextName("metadata");
                    ia->startNode();
                    // settings
                    (*ia)(cereal::make_nvp("settings", *this));
                    ia->finishNode();
                } catch(...)
                {
                    // settings
                    (*ia)(cereal::make_nvp("settings", *this));
                }
            }
            ia->finishNode();
        } catch(tim::cereal::Exception& e)
        {
            PRINT_HERE("Exception reading %s :: %s", inp.c_str(), e.what());
#if defined(TIMEMORY_INTERNAL_TESTING)
            TIMEMORY_CONDITIONAL_DEMANGLED_BACKTRACE(true, 8);
#endif
            return false;
        }
        return true;
    }
#if defined(TIMEMORY_USE_XML)
    else if(inp.find(".xml") != std::string::npos || inp == "xml")
    {
        using policy_type = policy::input_archive<cereal::XMLInputArchive, TIMEMORY_API>;
        auto ia           = policy_type::get(ifs);
        ia->setNextName("timemory");
        ia->startNode();
        {
            try
            {
                ia->setNextName("metadata");
                ia->startNode();
                // settings
                (*ia)(cereal::make_nvp("settings", *this));
                ia->finishNode();
            } catch(...)
            {
                // settings
                (*ia)(cereal::make_nvp("settings", *this));
            }
        }
        ia->finishNode();
        return true;
    }
#endif
    else
    {
        if(inp.empty())
            inp = "text";
 
        auto _is_comment = [](std::string _s) {
            if(_s.empty())
                return true;
            {
                auto _spos = _s.find_first_of(" \t\n\r\v\f");
                auto _cpos = _s.find_first_not_of(" \t\n\r\v\f");
                if(_spos < _cpos && _cpos != std::string::npos)
                    _s = _s.substr(_cpos);
                if(_s.empty())
                    return true;
            }
            std::locale _lc{};
            for(const auto& itr : _s)
            {
                // if graphical character is # then it a comment
                if(std::isgraph(itr, _lc))
                    return (itr == '#');
            }
            // if there were no printable characters, treat as comment
            return true;
        };
 
        int                                expected = 0;
        int                                valid    = 0;
        std::map<std::string, std::string> _variables{};
 
        std::function<std::string(std::string)> _resolve_variable{};
        _resolve_variable = [&](std::string _v) {
            if(_v.empty())
                return _v;
            if(_v.at(0) != '$')
                return _v;
            static const char* _env_syntax = "$env:";
            if(_v.find(_env_syntax) == 0)
                return _resolve_variable(
                    get_env<std::string>(_v.substr(strlen(_env_syntax)), ""));
            auto vitr = _variables.find(_v);
            if(vitr != _variables.end())
                return _resolve_variable(vitr->second);
            if(_v.at(0) == '$')
                _v = _v.substr(1);
            for(const auto& itr : *this)
            {
                if(itr.second->matches(_v))
                    return _resolve_variable(itr.second->as_string());
            }
            return _v;
        };
 
        while(ifs)
        {
            std::string line = {};
            std::getline(ifs, line);
            if(!ifs || line.empty())
                continue;
            if(line.empty())
                continue;
            if(get_debug() || get_verbose() > 4)
                fprintf(stderr, "[timemory::settings]['%s']> %s\n", inp.c_str(),
                        line.c_str());
            if(_is_comment(line))
                continue;
            ++expected;
            // tokenize the string
            auto delim = tim::delimit(line, "\n\t=,; ");
            if(!delim.empty())
            {
                string_t key = delim.front();
                string_t val = {};
                // combine into another string separated by commas
                for(size_t i = 1; i < delim.size(); ++i)
                {
                    if(delim.empty() || delim.at(i) == "#" || delim.at(i).at(0) == '#')
                        continue;
                    val += "," + _resolve_variable(delim.at(i));
                }
                // if there was any fields, remove the leading comma
                if(val.length() > 0)
                    val = val.substr(1);
                // extremely unlikely
                if(key.empty())
                    continue;
                // handle comment
                if(key == "#" || key.at(0) == '#')
                    continue;
                // this is a variable, e.g.:
                // $MYVAR = ON      # this is a variable
                // TIMEMORY_PRINT_STATS = $MYVAR
                // TIMEMORY_PRINT_MIN   = $MYVAR
                if(key.at(0) == '$')
                {
                    _variables.emplace(key, val);
                    continue;
                }
 
                auto incr = valid;
                for(const auto& itr : *this)
                {
                    if(itr.second->matches(key))
                    {
                        if(get_debug() || get_verbose() > 0)
                            fprintf(stderr, "[timemory::settings]['%s']> %-30s :: %s\n",
                                    inp.c_str(), key.c_str(), val.c_str());
                        ++valid;
                        itr.second->parse(val);
                    }
                }
 
                if(incr == valid)
                {
                    auto _key = key;
                    for(auto& itr : _key)
                        itr = std::toupper(itr);
                    if(_key.find(TIMEMORY_SETTINGS_PREFIX) == 0)
                    {
                        if(get_debug() || get_verbose() > 0)
                        {
                            fprintf(stderr,
                                    "[timemory::settings]['%s']> Unknown setting with "
                                    "recognized prefix ('%s') exported to environment: "
                                    "'%s' (value = '%s')\n",
                                    inp.c_str(), TIMEMORY_SETTINGS_PREFIX, _key.c_str(),
                                    val.c_str());
                        }
                        tim::set_env(key, val, 0);
                    }
                    else
                    {
                        fprintf(stderr,
                                "[timemory::settings]['%s']> WARNING! Unknown setting "
                                "ignored: '%s' (value = '%s')\n",
                                inp.c_str(), key.c_str(), val.c_str());
                    }
                }
            }
        }
        return (expected == valid);
    }
    return false;
}

References tim::delimit(), tim::get(), PRINT_HERE, tim::set_env(), TIMEMORY_CONDITIONAL_DEMANGLED_BACKTRACE, and TIMEMORY_SETTINGS_PREFIX.

save()

template<typename Archive >

void tim::settings::save	(	Archive &	ar,
		unsigned int
	)		const

Definition at line 626 of file settings.hpp.

{
#if !defined(TIMEMORY_DISABLE_SETTINGS_SERIALIZATION)
    using map_type = std::map<std::string, std::shared_ptr<vsettings>>;
    map_type _data;
    for(const auto& itr : m_data)
        _data.insert({ std::string{ itr.first }, itr.second->clone() });
 
    auto _map = get_serialize_map<Archive>(data_type_list_t{});
    for(const auto& itr : _data)
    {
        auto mitr = _map.find(itr.second->get_type_index());
        if(mitr != _map.end())
            mitr->second(ar, itr.second);
    }
    ar(cereal::make_nvp("command_line", m_command_line),
       cereal::make_nvp("environment", m_environment));
#else
    consume_parameters(ar);
#endif
}

References tim::consume_parameters().

serialize_settings() [1/2]

template<typename Archive >

void tim::settings::serialize_settings ( Archive &  ar )

static

Definition at line 569 of file settings.hpp.

{
    if(settings::instance())
        ar(cereal::make_nvp("settings", *settings::instance()));
}

References instance().

serialize_settings() [2/2]

template<typename Archive >

void tim::settings::serialize_settings ( Archive &  ar, settings &  _obj  )

static

Definition at line 579 of file settings.hpp.

{
    ar(cereal::make_nvp("settings", _obj));
}

set()

template<typename Tp , typename Sp >

bool tim::settings::set	(	Sp &&	_key,
		Tp &&	_val,
		bool	_exact = true
	)

Definition at line 714 of file settings.hpp.

{
    auto itr = find(std::forward<Sp>(_key), _exact);
    if(itr != m_data.end() && itr->second)
    {
        using Up   = decay_t<Tp>;
        auto _tidx = std::type_index(typeid(Up));
        auto _vidx = std::type_index(typeid(Up&));
        auto _tobj = dynamic_cast<tsettings<Up>*>(itr->second.get());
        auto _robj = dynamic_cast<tsettings<Up, Up&>*>(itr->second.get());
        if(itr->second->get_type_index() == _tidx &&
           itr->second->get_value_index() == _tidx && _tobj)
        {
            return (_tobj->set(std::forward<Tp>(_val)), true);
        }
        else if(itr->second->get_type_index() == _tidx &&
                itr->second->get_value_index() == _vidx && _robj)
        {
            return (_robj->set(std::forward<Tp>(_val)), true);
        }
        else
        {
            throw std::runtime_error(std::string{ "tim::settings::set(" } +
                                     std::string{ _key } + ", ...) failed");
        }
    }
    return false;
}

References find(), and tim::tsettings< Tp, Vp >::set().

set_tag()

void tim::settings::set_tag ( std::string  _v )

inline

the "tag" for settings should generally be the basename of exe

Definition at line 111 of file settings.hpp.

{ m_tag = std::move(_v); }

shared_instance() [1/3]

template<typename Tag >

static pointer_t tim::settings::shared_instance ( )

static

Referenced by instance().

shared_instance() [2/3]

TIMEMORY_SETTINGS_INLINE std::shared_ptr< settings > tim::settings::shared_instance ( )

static

Definition at line 58 of file settings.cpp.

{
    // do not take reference to ensure push/pop w/o template parameters do not change
    // the settings
    static auto _instance = shared_instance<TIMEMORY_API>();
    return _instance;
}

shared_instance() [3/3]

template<typename Tag >

std::shared_ptr< settings > tim::settings::shared_instance

(

)

Definition at line 526 of file settings.hpp.

{
    static std::shared_ptr<settings>& _instance = private_shared_instance<Tag>();
    return _instance;
}

store_command_line()

TIMEMORY_SETTINGS_INLINE void tim::settings::store_command_line ( int  argc, char **  argv  )

static

Definition at line 211 of file settings.cpp.

{
    auto& _cmdline = command_line();
    _cmdline.clear();
    for(int i = 0; i < argc; ++i)
        _cmdline.emplace_back(std::string(argv[i]));
}

References tim::argv.

Referenced by tim::if().

TIMEMORY_SETTINGS_MEMBER_DECL() [1/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		add_secondary
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [2/54]

suppress_parsing enabled tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		auto_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [3/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		banner
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [4/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		collapse_processes
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [5/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		cpu_affinity
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [6/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		dart_label
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [7/54]

suppress_parsing enabled cout_output text_output tree_output tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		dart_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [8/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		destructor_report
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [9/54]

suppress_parsing enabled cout_output tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		file_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [10/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		flamegraph_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [11/54]

suppress_parsing enabled cout_output text_output tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		json_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [12/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		memory_scientific
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [13/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		mpi_finalize
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [14/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		papi_attach
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [15/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		papi_multiplexing
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [16/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		papi_quiet
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [17/54]

suppress_parsing enabled cout_output text_output tree_output time_output tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		plot_output
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [18/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		roofline_type_labels
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [19/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		roofline_type_labels_gpu
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [20/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		scientific
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [21/54]

suppress_parsing tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		suppress_config
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [22/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		timing_scientific
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [23/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	bool	,
		upcxx_finalize
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [24/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int	,
		cupti_device
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [25/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int	,
		verbose
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [26/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int16_t	,
		memory_width
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [27/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int16_t	,
		timing_width
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [28/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int16_t	,
		width
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [29/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int32_t	,
		cupti_activity_level
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [30/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	int64_t	,
		separator_frequency
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [31/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	size_t	,
		throttle_value
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [32/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		components
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [33/54]

tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		config_file
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [34/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		cpu_roofline_events
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [35/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		cpu_roofline_mode
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [36/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		craypat_categories
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [37/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		cupti_events
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [38/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		dart_type
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [39/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		input_prefix
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [40/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		mpi_thread_type
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [41/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		ncclp_components
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [42/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		ompt_components
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [43/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		output_prefix
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [44/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		profiler_components
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [45/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		time_format
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [46/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	string_t	,
		tuple_components
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [47/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		cuda_event_batch_size
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [48/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_alignment
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [49/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_grid_size
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [50/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_max_data_size
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [51/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_max_data_size_gpu
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [52/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_min_working_size_cpu
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [53/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_num_threads
	)

TIMEMORY_SETTINGS_MEMBER_DECL() [54/54]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu tim::settings::TIMEMORY_SETTINGS_MEMBER_DECL	(	uint64_t	,
		ert_num_threads_gpu
	)

TIMEMORY_SETTINGS_REFERENCE_DECL() [1/2]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe enable_signal_handler tim::settings::TIMEMORY_SETTINGS_REFERENCE_DECL	(	bool	,
		allow_signal_handler
	)

TIMEMORY_SETTINGS_REFERENCE_DECL() [2/2]

suppress_parsing enabled cout_output text_output tree_output time_output diff_output ctest_notes debug collapse_threads max_depth precision max_width timing_precision timing_units memory_precision memory_units output_path input_path input_extensions dart_count max_thread_bookmarks stack_clearing throttle_count global_components list_components mpip_components trace_components kokkos_components mpi_init mpi_thread upcxx_init papi_threading papi_fail_on_error papi_events papi_overflow nvtx_marker_device_sync cupti_activity_kinds cupti_metrics roofline_mode gpu_roofline_mode gpu_roofline_events roofline_type_labels_cpu instruction_roofline ert_num_threads_cpu ert_num_streams ert_block_size ert_min_working_size ert_min_working_size_gpu ert_max_data_size_cpu ert_skip_ops node_count python_exe enable_signal_handler enable_all_signals tim::settings::TIMEMORY_SETTINGS_REFERENCE_DECL	(	bool	,
		disable_all_signals
	)

TIMEMORY_STATIC_ACCESSOR()

tim::settings::TIMEMORY_STATIC_ACCESSOR	(	bool	,
		use_output_suffix	,
		get_env< bool >	"TIMEMORY_USE_OUTPUT_SUFFIX", false
	)

tolower()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::tolower ( string_t  str )

static

Definition at line 135 of file settings.cpp.

{
    for(auto& itr : str)
        itr = ::tolower(itr);
    return str;
}

References tolower().

Referenced by tim::runtime::enumerate(), and tolower().

toupper()

TIMEMORY_SETTINGS_INLINE std::string tim::settings::toupper ( string_t  str )

static

Definition at line 146 of file settings.cpp.

{
    for(auto& itr : str)
        itr = ::toupper(itr);
    return str;
}

References toupper().

Referenced by toupper().

update()

bool tim::settings::update ( const std::string &  key, const std::string &  val, bool  exact = false  )

inline

Update a setting via a string. Returns whether a matching setting for the identifier was found (NOT whether the value was actually updated)

Parameters

key	Identifier for the setting. Either name, env-name, or command-line opt
val	Update value
exact	If true, match only options

Definition at line 746 of file settings.hpp.

{
    auto itr = find(_key, _exact);
    if(itr == m_data.end())
    {
        if(get_verbose() > 0 || get_debug())
            PRINT_HERE("Key: \"%s\" did not match any known setting", _key.c_str());
        return false;
    }
 
    itr->second->parse(_val);
    return true;
}

References find(), and PRINT_HERE.

Friends And Related Function Documentation

manager

friend class manager

friend

Definition at line 79 of file settings.hpp.

timemory_finalize

void timemory_finalize ( )

friend

finalization of the specified types

timemory_init

void timemory_init ( int  , char **  , const std::string &  , const std::string &    )

friend

initialization (creates manager and configures output path)

Member Data Documentation

default_process_suffix

tim::settings::default_process_suffix

Definition at line 258 of file settings.hpp.

---

The documentation for this struct was generated from the following files:

• timemory/settings/settings.hpp
• timemory/settings/settings.cpp