// Copyright 2014 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "src/compiler/pipeline-statistics.h"

#include <memory>

#include "src/codegen/optimized-compilation-info.h"
#include "src/compiler/turboshaft/phase.h"
#include "src/compiler/zone-stats.h"
#include "src/objects/shared-function-info.h"

namespace v8 {
namespace internal {
namespace compiler {

void PipelineStatisticsBase::CommonStats::Begin(
    PipelineStatisticsBase* pipeline_stats) {
  DCHECK(!scope_);
  scope_.reset(new ZoneStats::StatsScope(pipeline_stats->zone_stats_));
  outer_zone_initial_size_ = pipeline_stats->OuterZoneSize();
  allocated_bytes_at_start_ =
      outer_zone_initial_size_ -
      pipeline_stats->total_stats_.outer_zone_initial_size_ +
      pipeline_stats->zone_stats_->GetCurrentAllocatedBytes();
  // TODO(pthier): Move turboshaft specifics out of common class.
  // TODO(nicohartmann): This is a bit more difficult to do cleanly here without
  // the use of contextual variables. Add proper Turboshaft statistics in a
  // follow up CL.
  //
  // if (turboshaft::PipelineData::HasScope()) {
  //   graph_size_at_start_ =
  //       turboshaft::PipelineData::Get().graph().number_of_operations();
  // }
  timer_.Start();
}

void PipelineStatisticsBase::CommonStats::End(
    PipelineStatisticsBase* pipeline_stats,
    CompilationStatistics::BasicStats* diff) {
  DCHECK(scope_);
  diff->function_name_ = pipeline_stats->function_name_;
  diff->delta_ = timer_.Elapsed();
  size_t outer_zone_diff =
      pipeline_stats->OuterZoneSize() - outer_zone_initial_size_;
  diff->max_allocated_bytes_ = outer_zone_diff + scope_->GetMaxAllocatedBytes();
  diff->absolute_max_allocated_bytes_ =
      diff->max_allocated_bytes_ + allocated_bytes_at_start_;
  diff->total_allocated_bytes_ =
      outer_zone_diff + scope_->GetTotalAllocatedBytes();
  diff->input_graph_size_ = graph_size_at_start_;
  // TODO(nicohartmann): This is a bit more difficult to do cleanly here without
  // the use of contextual variables. Add proper Turboshaft statistics in a
  // follow up CL.
  //
  // if (turboshaft::PipelineData::HasScope()) {
  //   diff->output_graph_size_ =
  //       turboshaft::PipelineData::Get().graph().number_of_operations();
  // }
  scope_.reset();
  timer_.Stop();
}

PipelineStatisticsBase::PipelineStatisticsBase(
    Zone* outer_zone, ZoneStats* zone_stats,
    std::shared_ptr<CompilationStatistics> compilation_stats,
    CodeKind code_kind)
    : outer_zone_(outer_zone),
      zone_stats_(zone_stats),
      compilation_stats_(compilation_stats),
      code_kind_(code_kind) {
  total_stats_.Begin(this);
}

PipelineStatisticsBase::~PipelineStatisticsBase() {
  CompilationStatistics::BasicStats diff;
  total_stats_.End(this, &diff);
  compilation_stats_->RecordTotalStats(diff);
}

void PipelineStatisticsBase::BeginPhaseKind(const char* phase_kind_name) {
  DCHECK(!InPhase());
  phase_kind_name_ = phase_kind_name;
  phase_kind_stats_.Begin(this);
}

void PipelineStatisticsBase::EndPhaseKind(
    CompilationStatistics::BasicStats* diff) {
  DCHECK(!InPhase());
  phase_kind_stats_.End(this, diff);
  compilation_stats_->RecordPhaseKindStats(phase_kind_name_, *diff);
}

void PipelineStatisticsBase::BeginPhase(const char* phase_name) {
  DCHECK(InPhaseKind());
  phase_name_ = phase_name;
  phase_stats_.Begin(this);
}

void PipelineStatisticsBase::EndPhase(CompilationStatistics::BasicStats* diff) {
  DCHECK(InPhaseKind());
  phase_stats_.End(this, diff);
  compilation_stats_->RecordPhaseStats(phase_kind_name_, phase_name_, *diff);
}

constexpr char TurbofanPipelineStatistics::kTraceCategory[];

TurbofanPipelineStatistics::TurbofanPipelineStatistics(
    OptimizedCompilationInfo* info,
    std::shared_ptr<CompilationStatistics> compilation_stats,
    ZoneStats* zone_stats)
    : Base(info->zone(), zone_stats, compilation_stats, info->code_kind()) {
  if (info->has_shared_info()) {
    set_function_name(info->shared_info()->DebugNameCStr().get());
  }
}

TurbofanPipelineStatistics::~TurbofanPipelineStatistics() {
  if (Base::InPhaseKind()) EndPhaseKind();
}

void TurbofanPipelineStatistics::BeginPhaseKind(const char* name) {
  if (Base::InPhaseKind()) EndPhaseKind();
  Base::BeginPhaseKind(name);
  TRACE_EVENT_BEGIN1(kTraceCategory, name, "kind",
                     CodeKindToString(code_kind()));
}

void TurbofanPipelineStatistics::EndPhaseKind() {
  CompilationStatistics::BasicStats diff;
  Base::EndPhaseKind(&diff);
  TRACE_EVENT_END2(kTraceCategory, phase_kind_name(), "kind",
                   CodeKindToString(code_kind()), "stats",
                   TRACE_STR_COPY(diff.AsJSON().c_str()));
}

void TurbofanPipelineStatistics::BeginPhase(const char* name) {
  Base::BeginPhase(name);
  TRACE_EVENT_BEGIN1(kTraceCategory, phase_name(), "kind",
                     CodeKindToString(code_kind()));
}

void TurbofanPipelineStatistics::EndPhase() {
  CompilationStatistics::BasicStats diff;
  Base::EndPhase(&diff);
  TRACE_EVENT_END2(kTraceCategory, phase_name(), "kind",
                   CodeKindToString(code_kind()), "stats",
                   TRACE_STR_COPY(diff.AsJSON().c_str()));
}

}  // namespace compiler
}  // namespace internal
}  // namespace v8