hxprofiler.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
#if !(HX_USE_MACROS_WITH_MODULE)
 
// These are always included so the build doesn't break when the profiler is
// turned off.
#include "hxvector.hpp"
#include "hxthread.hpp"
 
HX_NS_BEGIN_

using hxcycles_t = size_t;

hxinline_constexpr double hxcycles_per_second = HX_CYCLES_PER_SECOND;

hxinline_constexpr double hxmilliseconds_per_cycle = 1.0e+3 / hxcycles_per_second;

hxinline_constexpr double hxmicroseconds_per_cycle = 1.0e+6 / hxcycles_per_second;

hxinline hxcycles_t hxtime_sample_cycles(void);
 
HX_NS_END_
 
#endif // !HX_USE_MACROS_WITH_MODULE

#define hxprofile_scope(label_string_literal_) \
    HX_PROFILE_ONLY_(const HX_NS_PREFIX_ hxdetail_::hxprofiler_scope_internal_<> \
        HX_APPEND_COUNTER(hxprofile_scope_)(label_string_literal_))

#define hxprofile_scope_min(label_string_literal_, min_cycles_) \
    HX_PROFILE_ONLY_(const HX_NS_PREFIX_ hxdetail_::hxprofiler_scope_internal_<min_cycles_> \
        HX_APPEND_COUNTER(hxprofile_scope_)(label_string_literal_))

#define hxprofiler_start() HX_PROFILE_ONLY_(HX_NS_PREFIX_ hxdetail_::hxg_profiler_.start_())

#define hxprofiler_stop() HX_PROFILE_ONLY_(HX_NS_PREFIX_ hxdetail_::hxg_profiler_.stop_())

#define hxprofiler_log() HX_PROFILE_ONLY_(HX_NS_PREFIX_ hxdetail_::hxg_profiler_.log_())
 
#if HX_USE_FILE_IO
#define hxprofiler_write_to_chrome_tracing(filename_) \
    HX_PROFILE_ONLY_(HX_NS_PREFIX_ hxdetail_::hxg_profiler_.write_to_chrome_tracing_(filename_))
#endif
#include "detail/hxprofiler_detail.hpp"