/*
 * Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

#ifndef SHARE_GC_Z_ZTRACER_HPP
#define SHARE_GC_Z_ZTRACER_HPP

#include "gc/shared/gcTrace.hpp"
#include "gc/z/zGenerationId.hpp"

class ZStatCounter;
class ZStatPhase;
class ZStatSampler;

class ZTracer : AllStatic {
private:
  static void send_stat_counter(const ZStatCounter& counter, uint64_t increment, uint64_t value);
  static void send_stat_sampler(const ZStatSampler& sampler, uint64_t value);
  static void send_thread_phase(const char* name, const Ticks& start, const Ticks& end);
  static void send_thread_debug(const char* name, const Ticks& start, const Ticks& end);

public:
  static void initialize();

  static void report_stat_counter(const ZStatCounter& counter, uint64_t increment, uint64_t value);
  static void report_stat_sampler(const ZStatSampler& sampler, uint64_t value);
  static void report_thread_phase(const char* name, const Ticks& start, const Ticks& end);
  static void report_thread_debug(const char* name, const Ticks& start, const Ticks& end);
};

class ZMinorTracer : public GCTracer {
public:
  ZMinorTracer();
};

class ZMajorTracer : public GCTracer {
public:
  ZMajorTracer();
};

class ZGenerationTracer {
protected:
  Ticks _start;

public:
  ZGenerationTracer()
    : _start() {}

  void report_start(const Ticks& timestamp);
  virtual void report_end(const Ticks& timestamp) = 0;
};

class ZYoungTracer : public ZGenerationTracer {
public:
  void report_end(const Ticks& timestamp) override;
};

class ZOldTracer : public ZGenerationTracer {
public:
  void report_end(const Ticks& timestamp) override;
};

// For temporary latency measurements during development and debugging
class ZTraceThreadDebug : public StackObj {
private:
  const Ticks       _start;
  const char* const _name;

public:
  ZTraceThreadDebug(const char* name);
  ~ZTraceThreadDebug();
};

#endif // SHARE_GC_Z_ZTRACER_HPP