cnstream/easydk/dist/include/profiler/pipeline_tracer.hpp

/*************************************************************************
 * Copyright (C) [2020] by Cambricon, Inc. All rights reserved
 *
 *  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
 *
 * 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 CNSTREAM_FRAMEWORK_CORE_INCLUDE_PROFILER_PIPELINE_TRACER_HPP_
#define CNSTREAM_FRAMEWORK_CORE_INCLUDE_PROFILER_PIPELINE_TRACER_HPP_

#include <chrono>
#include <memory>
#include <string>

#include "cnstream_common.hpp"
#include "profiler/trace.hpp"

/*!
 *  @file pipeline_tracer.hpp
 *
 *  This file contains a declaration of the PipelineTracer class.
 */
namespace cnstream {

template<typename T>
class CircularBuffer;

/*!
 * @class PipelineTracer
 *
 * @brief PipelineTracer is a class for recording trace events of the pipeline.
 */
class PipelineTracer : private NonCopyable {
 public:
  /*!
   * @brief Constructs a PipelineTracer object.
   *
   * @param[in] capacity The capacity to store trace events.
   *
   * @return No return value.
   */
  explicit PipelineTracer(size_t capacity = 100000);
  /*!
   * @brief Destructs a PipelineTracer object.
   *
   * @return No return value.
   */
  ~PipelineTracer();

  /*!
   * @brief Records a trace event using value reference semantics.
   *
   * @param[in] event The trace event.
   *
   * @return No return value.
   */
  void RecordEvent(const TraceEvent& event);

  /*!
   * @brief Records a trace event using move semantics.
   *
   * @param[in] event The trace event.
   *
   * @return No return value.
   */
  void RecordEvent(TraceEvent&& event);

  /*!
   * @brief Gets the trace data of the pipeline for a specified period of time.
   *
   * @param[in] start The start time.
   * @param[in] end The end time.
   *
   * @return Returns the trace data of the pipeline.
   */
  PipelineTrace GetTrace(const Time& start, const Time& end) const;

  /*!
   * @brief Gets the trace data of the pipeline for a specified period of time.
   *
   * @param[in] end The end time
   * @param[in] duration The duration in milliseconds. The start time is the end time minus duration.
   *
   * @return Returns the trace data of the pipeline.
   */
  PipelineTrace GetTraceBefore(const Time& end, const Duration& duration) const;

  /*!
   * @brief Gets the trace data of the pipeline for a specified period of time.
   *
   * @param[in] start The start time.
   * @param[in] duration The duration in milliseconds. The end time is the start time plus duration.
   *
   * @return Returns the trace data of the pipeline.
   */
  PipelineTrace GetTraceAfter(const Time& start, const Duration& duration) const;

 private:
  CircularBuffer<TraceEvent>* buffer_ = nullptr;
};  // class PipelineTracer

inline PipelineTrace PipelineTracer::GetTraceBefore(const Time& end, const Duration& duration) const {
  return GetTrace(std::chrono::time_point_cast<Clock::duration>(end - duration), end);
}

inline PipelineTrace PipelineTracer::GetTraceAfter(const Time& start, const Duration& duration) const {
  return GetTrace(start, std::chrono::time_point_cast<Clock::duration>(start + duration));
}

}  // namespace cnstream

#endif  // CNSTREAM_FRAMEWORK_CORE_INCLUDE_TRACER_PIPELINE_TRACER_HPP_