---

WKFUtils.h File Reference

Cross-platform APIs for high-precision timers and status messaging. More...

Go to the source code of this file.

Compounds
struct	wkfmsgtimer
Defines
#define	WKF_UTILS_INC   1
Typedefs
typedef void *	wkf_timerhandle
	a timer handle. More...
Functions
wkf_timerhandle	wkf_timer_create (void)
	create a timer (clears timer). More...
void	wkf_timer_destroy (wkf_timerhandle)
	create a timer (clears timer). More...
void	wkf_timer_start (wkf_timerhandle)
	start a timer (clears timer). More...
void	wkf_timer_stop (wkf_timerhandle)
	stop a timer. More...
double	wkf_timer_time (wkf_timerhandle)
	report elapsed time in seconds. More...
double	wkf_timer_timenow (wkf_timerhandle)
	report elapsed time in seconds. More...
double	wkf_timer_start_time (wkf_timerhandle)
	report wall starting time. More...
double	wkf_timer_stop_time (wkf_timerhandle)
	report wall stopping time. More...
wkfmsgtimer *	wkf_msg_timer_create (double updatetime)
	initialize periodic status message timer. More...
int	wkf_msg_timer_timeout (wkfmsgtimer *time)
	return true if it's time to print a status update message. More...
void	wkf_msg_timer_destroy (wkfmsgtimer *mt)
	destroy message timer. More...

---

Detailed Description

Cross-platform APIs for high-precision timers and status messaging.

Revision:

1.2

Date:

2020/02/26 06:23:21

Author:

John E. Stone - john.stone@gmail.com \copyright This trivial code is made available under the "new" 3-clause BSD license, and/or any of the GPL licenses you prefer. Feel free to use the code and modify as you see fit.

Definition in file WKFUtils.h.

---

Define Documentation

#define WKF_UTILS_INC   1

Definition at line 56 of file WKFUtils.h.

---

Typedef Documentation

typedef void* wkf_timerhandle

a timer handle. Definition at line 62 of file WKFUtils.h. Referenced by BaseMolecule::analyze, CUDAQuickSurf::calc_surf, Orbital::calculate_mo, VolMapCreateILS::compute, VolMapCreate::compute_all, ComputeOccupancyMap_calculate_slab, cuda_occupancy_thread, cudabusbw, cudaenergythread, cudamaddgflops, energythread, VolumeTexture::generateColorScaleTexture, gpu_ooc_bench, Symmetry::guess, measure_rmsdmat_qcp, measure_rmsdmat_qcp_ooc, openclenergythread, qcp_soa_gpu_ooc, Segmentation::segment, stream_bench, vmd_cuda_calc_density, vmd_cuda_cc_calc, vmd_cuda_compare_sel_refmap, vmd_cuda_devpool_latency, vmd_cuda_gaussdensity_calc, vmd_cuda_vol_cpotential, vmd_opencl_vol_cpotential, vmdbench_analyze_selection, vmdbench_minmax_1fv, vmdbench_minmax_3fv, vmdbench_minmaxmean_1fv, vmddevpoolcudalatencythread, vol_cpotential, vol_cpotential_cpu, Watershed::watershed, wkf_timer_create, wkf_timer_destroy, wkf_timer_start, wkf_timer_start_time, wkf_timer_stop, wkf_timer_stop_time, wkf_timer_time, and wkf_timer_timenow.

---

Function Documentation

wkfmsgtimer* wkf_msg_timer_create (  double    updatetime )

initialize periodic status message timer. Definition at line 191 of file WKFUtils.C. Referenced by bondsearchthread, cudaenergythread, energythread, measure_cluster, measure_gofr, openclenergythread, and vmd_gridsearch1.

void wkf_msg_timer_destroy (  wkfmsgtimer *    mt )

destroy message timer. Definition at line 217 of file WKFUtils.C. Referenced by bondsearchthread, cudaenergythread, energythread, measure_cluster, measure_gofr, openclenergythread, and vmd_gridsearch1.

int wkf_msg_timer_timeout (  wkfmsgtimer *    time )

return true if it's time to print a status update message. Definition at line 203 of file WKFUtils.C. Referenced by bondsearchthread, cudaenergythread, energythread, measure_cluster, measure_gofr_orth, openclenergythread, and vmd_gridsearch1.

wkf_timerhandle wkf_timer_create (  void    )

create a timer (clears timer). Definition at line 174 of file WKFUtils.C.

void wkf_timer_destroy (  wkf_timerhandle    )

create a timer (clears timer). Definition at line 181 of file WKFUtils.C. Referenced by BaseMolecule::analyze, CUDAQuickSurf::calc_surf, Orbital::calculate_mo, VolMapCreateILS::compute, VolMapCreate::compute_all, ComputeOccupancyMap_calculate_slab, cuda_occupancy_thread, cudabusbw, cudaenergythread, cudamaddgflops, energythread, VolumeTexture::generateColorScaleTexture, Symmetry::guess, measure_rmsdmat_qcp, measure_rmsdmat_qcp_ooc, openclenergythread, Segmentation::segment, stream_bench, vmd_cuda_calc_density, vmd_cuda_cc_calc, vmd_cuda_compare_sel_refmap, vmd_cuda_devpool_latency, vmd_cuda_gaussdensity_calc, vmd_cuda_vol_cpotential, vmd_opencl_vol_cpotential, vmdbench_analyze_selection, vmdbench_minmax_1fv, vmdbench_minmax_3fv, vmdbench_minmaxmean_1fv, vmddevpoolcudalatencythread, vol_cpotential, vol_cpotential_cpu, Watershed::watershed, wkf_msg_timer_destroy, ANARIDisplayDevice::~ANARIDisplayDevice, ANARIRender::~ANARIRender, CoorPluginData::~CoorPluginData, LibTachyonDisplayDevice::~LibTachyonDisplayDevice, Mobile::~Mobile, OptiXDisplayDevice::~OptiXDisplayDevice, OptiXRenderer::~OptiXRenderer, OSPRay2DisplayDevice::~OSPRay2DisplayDevice, OSPRay2Renderer::~OSPRay2Renderer, OSPRayDisplayDevice::~OSPRayDisplayDevice, OSPRayRenderer::~OSPRayRenderer, QuickSurf::~QuickSurf, and VideoStream::~VideoStream.

void wkf_timer_start (  wkf_timerhandle    )

start a timer (clears timer). Definition at line 137 of file WKFUtils.C. Referenced by BaseMolecule::analyze, ANARIRender::ANARIRender, QuickSurf::calc_surf, CUDAQuickSurf::calc_surf, Orbital::calculate_mo, Mobile::check_event, VolMapCreateILS::compute, VolMapCreate::compute_all, ComputeOccupancyMap_calculate_slab, CoorPluginData::CoorPluginData, cuda_occupancy_thread, cudabusbw, cudaenergythread, cudamaddgflops, energythread, VolumeTexture::generateColorScaleTexture, gpu_ooc_bench, Symmetry::guess, measure_rmsdmat_qcp, measure_rmsdmat_qcp_ooc, Mobile::Mobile, openclenergythread, OptiXRenderer::OptiXRenderer, OSPRay2Renderer::OSPRay2Renderer, OSPRayRenderer::OSPRayRenderer, qcp_soa_gpu_ooc, Segmentation::segment, stream_bench, OSPRayRenderer::update_rendering_state, OSPRay2Renderer::update_rendering_state, OptiXRenderer::update_rendering_state, ANARIRender::update_rendering_state, VideoStream::VideoStream, vmd_cuda_calc_density, vmd_cuda_cc_calc, vmd_cuda_compare_sel_refmap, vmd_cuda_devpool_latency, vmd_cuda_gaussdensity_calc, vmd_cuda_vol_cpotential, vmd_opencl_vol_cpotential, vmdbench_analyze_selection, vmdbench_minmax_1fv, vmdbench_minmax_3fv, vmdbench_minmaxmean_1fv, vmddevpoolcudalatencythread, vol_cpotential, vol_cpotential_cpu, Watershed::watershed, wkf_msg_timer_create, wkf_msg_timer_timeout, OSPRayDisplayDevice::write_header, OSPRay2DisplayDevice::write_header, OptiXDisplayDevice::write_header, LibTachyonDisplayDevice::write_header, and ANARIDisplayDevice::write_header.

double wkf_timer_start_time (  wkf_timerhandle    )

report wall starting time. Definition at line 155 of file WKFUtils.C.

void wkf_timer_stop (  wkf_timerhandle    )

stop a timer. Definition at line 142 of file WKFUtils.C. Referenced by CUDAQuickSurf::calc_surf, Orbital::calculate_mo, VolMapCreate::compute_all, cudabusbw, cudamaddgflops, VolumeTexture::generateColorScaleTexture, gpu_ooc_bench, Symmetry::guess, qcp_soa_gpu_ooc, Segmentation::segment, stream_bench, vmd_cuda_cc_calc, vmd_cuda_devpool_latency, vmd_cuda_gaussdensity_calc, vmd_cuda_vol_cpotential, vmd_opencl_vol_cpotential, vmdbench_analyze_selection, vmdbench_minmax_1fv, vmdbench_minmax_3fv, vmdbench_minmaxmean_1fv, vmddevpoolcudalatencythread, vol_cpotential_cpu, Watershed::watershed, wkf_timer_timenow, OSPRayDisplayDevice::write_trailer, OSPRay2DisplayDevice::write_trailer, OptiXDisplayDevice::write_trailer, LibTachyonDisplayDevice::write_trailer, and ANARIDisplayDevice::write_trailer.

double wkf_timer_stop_time (  wkf_timerhandle    )

report wall stopping time. Definition at line 163 of file WKFUtils.C.

double wkf_timer_time (  wkf_timerhandle    )

report elapsed time in seconds. Definition at line 147 of file WKFUtils.C. Referenced by CUDAQuickSurf::calc_surf, Orbital::calculate_mo, VolMapCreate::compute_all, cudabusbw, cudamaddgflops, VolumeTexture::generateColorScaleTexture, gpu_ooc_bench, Symmetry::guess, qcp_soa_gpu_ooc, Segmentation::segment, stream_bench, vmd_cuda_cc_calc, vmd_cuda_devpool_latency, vmd_cuda_gaussdensity_calc, vmd_cuda_vol_cpotential, vmd_opencl_vol_cpotential, vmdbench_analyze_selection, vmdbench_minmax_1fv, vmdbench_minmax_3fv, vmdbench_minmaxmean_1fv, vmddevpoolcudalatencythread, vol_cpotential_cpu, Watershed::watershed, wkf_timer_timenow, OSPRayDisplayDevice::write_trailer, OSPRay2DisplayDevice::write_trailer, OptiXDisplayDevice::write_trailer, LibTachyonDisplayDevice::write_trailer, and ANARIDisplayDevice::write_trailer.

double wkf_timer_timenow (  wkf_timerhandle    )

report elapsed time in seconds. Definition at line 185 of file WKFUtils.C. Referenced by BaseMolecule::analyze, ANARIRender::ANARIRender, QuickSurf::calc_surf, CUDAQuickSurf::calc_surf, VideoStream::check_event, Mobile::check_event, VideoStream::cli_connect, VolMapCreateILS::compute, ComputeOccupancyMap_calculate_slab, OptiXRenderer::create_context, cuda_occupancy_thread, cudaenergythread, OSPRayRenderer::destroy_scene, OSPRay2Renderer::destroy_scene, OptiXRenderer::destroy_scene, ANARIRender::destroy_scene, energythread, measure_rmsdmat_qcp, measure_rmsdmat_qcp_ooc, CoorPluginData::next, openclenergythread, OSPRay2Renderer::OSPRay2Renderer, OSPRayRenderer::OSPRayRenderer, OSPRayRenderer::render_compile_and_validate, OSPRay2Renderer::render_compile_and_validate, OptiXRenderer::render_compile_and_validate, ANARIRender::render_compile_and_validate, OSPRayRenderer::render_to_file, OSPRay2Renderer::render_to_file, OptiXRenderer::render_to_file, ANARIRender::render_to_file, OptiXRenderer::render_to_videostream, OSPRayRenderer::setup_context, OSPRay2Renderer::setup_context, OptiXRenderer::setup_context, ANARIRender::setup_context, VideoStream::srv_connect, VideoStream::srv_send_frame, VideoStream::VideoStream, vmd_cuda_calc_density, vmd_cuda_cc_calc, vmd_cuda_compare_sel_refmap, vmd_cuda_gaussdensity_calc, vol_cpotential, wkf_msg_timer_timeout, OSPRayDisplayDevice::write_trailer, OSPRay2DisplayDevice::write_trailer, OptiXDisplayDevice::write_trailer, and ANARIDisplayDevice::write_trailer.

---