time_profiler.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of spla project                                              */
/* https://github.com/SparseLinearAlgebra/spla                                    */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2023 SparseLinearAlgebra                                         */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* The above copyright notice and this permission notice shall be included in all */
/* copies or substantial portions of the Software.                                */
/*                                                                                */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
/* SOFTWARE.                                                                      */
/**********************************************************************************/
 
#ifndef SPLA_TIME_PROFILER_HPP
#define SPLA_TIME_PROFILER_HPP
 
#include <atomic>
#include <chrono>
#include <map>
#include <ostream>
#include <string>
 
namespace spla {
 
    struct TimeProfilerLabel {
        TimeProfilerLabel(TimeProfilerLabel* in_parent, const char* in_name, const char* in_file, const char* in_function);
 
        std::string          name;
        const char*          file;
        const char*          function;
        int                  child_count = 0;
        std::atomic_uint64_t nano;
        std::uint64_t        queued_nano   = 0;
        std::uint64_t        executed_nano = 0;
        TimeProfilerLabel*   parent;
    };
 
    struct TimeProfilerScope {
        explicit TimeProfilerScope(TimeProfilerLabel* in_label);
        ~TimeProfilerScope();
 
        TimeProfilerLabel*                    label;
        std::chrono::steady_clock::time_point start;
        std::chrono::steady_clock::time_point end;
    };
 
    class TimeProfiler final {
    public:
        void add_label(TimeProfilerLabel* label);
        void dump(std::ostream& where);
        void reset();
 
    private:
        std::map<std::string, TimeProfilerLabel*> m_labels;
    };
 
#ifndef SPLA_RELEASE
    #define TIME_PROFILE_LABEL    __auto_profile_label
    #define TIME_PROFILE_SUBLABEL __auto_profile_sublabel
 
    #define TIME_PROFILE_SUBSCOPE(name)                                                                      \
        static TimeProfilerLabel TIME_PROFILE_SUBLABEL(&__auto_profile_label, name, __FILE__, __FUNCTION__); \
        TimeProfilerScope        __auto_profile_subscope(&TIME_PROFILE_SUBLABEL);
 
    #define TIME_PROFILE_SCOPE(name)                                                        \
        static TimeProfilerLabel TIME_PROFILE_LABEL(nullptr, name, __FILE__, __FUNCTION__); \
        TimeProfilerScope        __auto_profile_scope(&TIME_PROFILE_LABEL);
#else
    #define TIME_PROFILE_LABEL
    #define TIME_PROFILE_SUBLABEL
    #define TIME_PROFILE_SCOPE(name)
    #define TIME_PROFILE_SUBSCOPE(name)
#endif
 
}// namespace spla
 
#endif//SPLA_TIME_PROFILER_HPP