tracer_base.h

// Copyright (c) 2022 PaddlePaddle Authors. 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
//
// 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.

#pragma once

#include "paddle/fluid/platform/profiler/trace_event_collector.h"

namespace paddle {
namespace platform {

class TracerBase {
 public:
  // The state machine for a Tracer.
  enum class TracerState { UNINITED, READY, STARTED, STOPED };

  virtual void PrepareTracing() { state_ = TracerState::READY; }

  virtual void StartTracing() = 0;

  virtual void StopTracing() = 0;

  virtual void CollectTraceData(TraceEventCollector* collector) = 0;

  virtual ~TracerBase() {}

 protected:
  TracerState state_ = TracerState::UNINITED;
};

}  // namespace platform
}  // namespace paddle