tracer.h

Go to the documentation of this file.

// === tracer.h ========================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_KERNEL_TRACER_H
#define SEN_KERNEL_TRACER_H
 
// sen
#include "sen/core/base/compiler_macros.h"
#include "sen/core/base/numbers.h"
#include "sen/core/base/scope_guard.h"
#include "sen/core/base/source_location.h"
 
// std
#include <functional>
#include <memory>
#include <string_view>
 
namespace sen::kernel
{

class Tracer
{
  SEN_NOCOPY_NOMOVE(Tracer)
 
public:
  Tracer() = default;
  virtual ~Tracer() = default;
 
public:  // for scoped (RAII) zones
  [[nodiscard]] auto makeScopedZone(const SourceLocation& location);

  [[nodiscard]] auto makeScopedZone(std::string_view name, const SourceLocation& location);
 
public:  // for frame-based tracers
  virtual void frameStart(std::string_view name) = 0;

  virtual void frameEnd(std::string_view name) = 0;
 
public:  // messages
  virtual void message(std::string_view name) = 0;

  virtual void plot(std::string_view name, float64_t value) = 0;

  virtual void plot(std::string_view name, int64_t value) = 0;
 
protected:
  virtual void zoneStart(std::string_view name, const SourceLocation& location) = 0;
  virtual void zoneEnd() = 0;
};

using TracerFactory = std::function<std::unique_ptr<Tracer>(std::string_view)>;

[[nodiscard]] TracerFactory getDefaultTracerFactory();
 
// clang-format off
#define SEN_TRACE_ZONE_NAMED(tracer, name) static constexpr auto __senSourceLocation ## __LINE__ = SEN_SL(); auto __senScopedZone ## __LINE__ = (tracer).makeScopedZone(name, __senSourceLocation ## __LINE__)

#define SEN_TRACE_ZONE(tracer) static constexpr auto __senSourceLocation ## __LINE__ = SEN_SL(); auto __senScopedZone ## __LINE__ = (tracer).makeScopedZone(__senSourceLocation ## __LINE__)
// clang-format on
 
//--------------------------------------------------------------------------------------------------------------
// Inline method implementation
//--------------------------------------------------------------------------------------------------------------
 
inline auto Tracer::makeScopedZone(std::string_view name, const SourceLocation& location)
{
  zoneStart(std::move(name), location);
  return makeScopeGuard([this]() { zoneEnd(); });
}
 
inline auto Tracer::makeScopedZone(const SourceLocation& location) { return makeScopedZone({}, location); }
 
}  // namespace sen::kernel
 
#endif  // SEN_KERNEL_TRACER_H