time_utils.h

Go to the documentation of this file.

/* * NRP Core - Backend infrastructure to synchronize simulations
 *
 * Copyright 2020-2023 NRP Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This project has received funding from the European Union’s Horizon 2020
 * Framework Programme for Research and Innovation under the Specific Grant
 * Agreement No. 945539 (Human Brain Project SGA3).
 */
 
#ifndef TIME_UTILS_H
#define TIME_UTILS_H
 
#include <chrono>
#include <map>
#include <fstream>
#include <filesystem>
#include <unistd.h>
 
using SimulationTime = std::chrono::nanoseconds;
 
template <class vartype, class ratio>
static SimulationTime toSimulationTime(vartype time)
{
    return std::chrono::duration_cast<SimulationTime>(std::chrono::duration<vartype, ratio>(time));
}
 
SimulationTime toSimulationTimeFromSeconds(double time);
 
template <class vartype, class ratio>
static vartype fromSimulationTime(SimulationTime time)
{
    return std::chrono::duration_cast<std::chrono::duration<vartype, ratio>>(time).count();
}
 
 
double getRoundedRunTimeMs(const SimulationTime runTime, const float simulationResolutionMs);
 
std::string getTimestamp();
 
 
 
#ifdef TIME_PROFILE
 
// macro used to generate unique (within a file) anonymous var names
#define _CONCAT_(x,y) x ## y
#define CONCAT(x,y) _CONCAT_(x,y)
#define ANONYMOUS_VAR CONCAT(_anonymous, __LINE__)
 
#define NRP_LOG_TIME_SET_START TimeProfiler::setStartTime()
 
#define NRP_LOG_TIME(filename) TimeProfiler::recordTimePoint(filename)
#define NRP_LOG_TIME_WITH_COMMENT(filename, comment) TimeProfiler::recordTimePoint(filename, comment)
 
#define NRP_LOG_TIME_BLOCK(filename) auto ANONYMOUS_VAR = BlockProfiler(filename)
#define NRP_LOG_TIME_BLOCK_WITH_COMMENT(filename, comment) auto ANONYMOUS_VAR = BlockProfiler(filename, comment)
 
struct TimeProfiler {
 
    static std::map<std::string,  std::ofstream> files;
    static std::chrono::time_point<std::chrono::high_resolution_clock> start;
    static std::string timeLogsDir;
 
    static void setStartTime();
 
    static void recordTimePoint(const std::string& filename, const std::string& comment = "", bool newLine = true);
 
    static void recordDuration(const std::string& filename, const std::chrono::microseconds& duration, const std::string& comment = "", bool newLine = true);
};
 
struct BlockProfiler {
    BlockProfiler() = delete;
 
    BlockProfiler(const std::string& filename, const std::string& comment="");
 
    ~BlockProfiler();
 
    std::chrono::time_point<std::chrono::high_resolution_clock> _start;
    std::string _filename;
    std::string _comment;
};
 
#else
#define NRP_LOG_TIME_SET_START
#define NRP_LOG_TIME(filename)
#define NRP_LOG_TIME_WITH_COMMENT(filename, comment)
#define NRP_LOG_TIME_BLOCK(filename)
#define NRP_LOG_TIME_BLOCK_WITH_COMMENT(filename, comment)
#endif
 
#endif // TIME_UTILS_H
 
// EOF