// OpenSTA, Static Timing Analyzer
// Copyright (c) 2024, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program 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 for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

#include "ClkInfo.hh"

#include "Network.hh"
#include "Graph.hh"
#include "Sdc.hh"
#include "Corner.hh"
#include "Search.hh"
#include "Tag.hh"
#include "PathAnalysisPt.hh"

namespace sta {

static bool
clkInfoEqual(const ClkInfo *clk_info1,
	     const ClkInfo *clk_info2,
	     const StaState *sta);
static int
clkInfoCmp(const ClkInfo *clk_info1,
	   const ClkInfo *clk_info2,
	   const StaState *sta);

ClkInfo::ClkInfo(const ClockEdge *clk_edge,
		 const Pin *clk_src,
		 bool is_propagated,
                 const Pin *gen_clk_src,
		 bool is_gen_clk_src_path,
		 const RiseFall *pulse_clk_sense,
		 Arrival insertion,
		 float latency,
		 ClockUncertainties *uncertainties,
                 PathAPIndex path_ap_index,
		 PathVertexRep &crpr_clk_path,
		 const StaState *sta) :
  clk_edge_(clk_edge),
  clk_src_(clk_src),
  gen_clk_src_(gen_clk_src),
  crpr_clk_path_(crpr_clk_path),
  uncertainties_(uncertainties),
  insertion_(insertion),
  latency_(latency),
  is_propagated_(is_propagated),
  is_gen_clk_src_path_(is_gen_clk_src_path),
  is_pulse_clk_(pulse_clk_sense != nullptr),
  pulse_clk_sense_(pulse_clk_sense ? pulse_clk_sense->index() : 0),
  path_ap_index_(path_ap_index)
{
  findHash(sta);
}

ClkInfo::~ClkInfo()
{
}

void
ClkInfo::findHash(const StaState *sta)
{
  hash_ = hash_init_value;
  if (clk_edge_)
    hashIncr(hash_, clk_edge_->index());

  const Network *network = sta->network();
  if (clk_src_)
    hashIncr(hash_, network->vertexId(clk_src_));
  if (gen_clk_src_)
    hashIncr(hash_, network->vertexId(gen_clk_src_));
  hashIncr(hash_, crprClkVertexId());
  if (uncertainties_) {
    float uncertainty;
    bool exists;
    uncertainties_->value(MinMax::min(), uncertainty, exists);
    if (exists)
      hashIncr(hash_, uncertainty * 1E+12F);
    uncertainties_->value(MinMax::max(), uncertainty, exists);
    if (exists)
      hashIncr(hash_, uncertainty * 1E+12F);
  }
  hashIncr(hash_, latency_ * 1E+12F);
  hashIncr(hash_, delayAsFloat(insertion_) * 1E+12F);
  hashIncr(hash_, is_propagated_);
  hashIncr(hash_, is_gen_clk_src_path_);
  hashIncr(hash_, is_pulse_clk_);
  hashIncr(hash_, pulse_clk_sense_);
  hashIncr(hash_, path_ap_index_);
}

VertexId
ClkInfo::crprClkVertexId() const
{
  if (crpr_clk_path_.isNull())
    return 0;
  else
    return crpr_clk_path_.vertexId();
}

const char *
ClkInfo::asString(const StaState *sta) const
{
  Network *network = sta->network();
  Corners *corners = sta->corners();
  string result;

  PathAnalysisPt *path_ap = corners->findPathAnalysisPt(path_ap_index_);
  result += path_ap->pathMinMax()->asString();
  result += "/";
  result += std::to_string(path_ap_index_);

  if (clk_edge_)
    result += clk_edge_->name();
  else
    result += "unclocked";

  if (clk_src_) {
    result += " clk_src ";
    result += network->pathName(clk_src_);
  }

  if (!crpr_clk_path_.isNull()) {
    const Pin *crpr_clk_pin = crpr_clk_path_.vertex(sta)->pin();
    result += " crpr_pin ";
    result += network->pathName(crpr_clk_pin);
  }

  if (is_gen_clk_src_path_)
    result += " genclk";

  char *tmp = makeTmpString(result.size() + 1);
  strcpy(tmp, result.c_str());
  return tmp;
}

const Clock *
ClkInfo::clock() const
{
  if (clk_edge_)
    return clk_edge_->clock();
  else
    return nullptr;
}

RiseFall *
ClkInfo::pulseClkSense() const
{
  if (is_pulse_clk_)
    return RiseFall::find(pulse_clk_sense_);
  else
    return nullptr;
}

bool
ClkInfo::refsFilter(const StaState *sta) const
{
  return !crpr_clk_path_.isNull()
    && crpr_clk_path_.tag(sta)->isFilter();
}

////////////////////////////////////////////////////////////////

size_t
ClkInfoHash::operator()(const ClkInfo *clk_info) const
{
  return clk_info->hash();
}

////////////////////////////////////////////////////////////////

ClkInfoEqual::ClkInfoEqual(const StaState *sta) :
  sta_(sta)
{
}

bool
ClkInfoEqual::operator()(const ClkInfo *clk_info1,
			 const ClkInfo *clk_info2) const
{
  return clkInfoEqual(clk_info1, clk_info2, sta_);
}

static bool
clkInfoEqual(const ClkInfo *clk_info1,
	     const ClkInfo *clk_info2,
	     const StaState *sta)
{
  bool crpr_on = sta->sdc()->crprActive();
  ClockUncertainties *uncertainties1 = clk_info1->uncertainties();
  ClockUncertainties *uncertainties2 = clk_info2->uncertainties();
  return clk_info1->clkEdge() == clk_info2->clkEdge()
    && clk_info1->pathAPIndex() == clk_info2->pathAPIndex()
    && clk_info1->clkSrc() == clk_info2->clkSrc()
    && clk_info1->genClkSrc() == clk_info2->genClkSrc()
    && (!crpr_on
	|| (PathVertexRep::equal(clk_info1->crprClkPath(),
				 clk_info2->crprClkPath())))
    && ((uncertainties1 == nullptr
	 && uncertainties2 == nullptr)
	|| (uncertainties1 && uncertainties2
	    && MinMaxValues<float>::equal(uncertainties1,
					  uncertainties2)))
    && clk_info1->insertion() == clk_info2->insertion()
    && clk_info1->latency() == clk_info2->latency()
    && clk_info1->isPropagated() == clk_info2->isPropagated()
    && clk_info1->isGenClkSrcPath() == clk_info2->isGenClkSrcPath()
    && clk_info1->isPulseClk() == clk_info2->isPulseClk()
    && clk_info1->pulseClkSenseTrIndex() == clk_info2->pulseClkSenseTrIndex();
}

////////////////////////////////////////////////////////////////

ClkInfoLess::ClkInfoLess(const StaState *sta) :
  sta_(sta)
{
}

bool
ClkInfoLess::operator()(const ClkInfo *clk_info1,
			const ClkInfo *clk_info2) const
{
  return clkInfoCmp(clk_info1, clk_info2, sta_) < 0;
}

static int
clkInfoCmp(const ClkInfo *clk_info1,
	   const ClkInfo *clk_info2,
	   const StaState *sta)
{
  const ClockEdge *clk_edge1 = clk_info1->clkEdge();
  const ClockEdge *clk_edge2 = clk_info2->clkEdge();
  int edge_index1 = clk_edge1 ? clk_edge1->index() : -1;
  int edge_index2 = clk_edge2 ? clk_edge2->index() : -1;
  if (edge_index1 < edge_index2)
    return -1;
  if (edge_index1 > edge_index2)
    return 1;

  PathAPIndex path_ap_index1 = clk_info1->pathAPIndex();
  PathAPIndex path_ap_index2 = clk_info2->pathAPIndex();
  if (path_ap_index1 < path_ap_index2)
    return -1;
  if (path_ap_index1 > path_ap_index2)
    return 1;

  const Pin *clk_src1 = clk_info1->clkSrc();
  const Pin *clk_src2 = clk_info2->clkSrc();
  if (clk_src1 < clk_src2)
    return -1;
  if (clk_src1 > clk_src2)
    return 1;

  const Pin *gen_clk_src1 = clk_info1->genClkSrc();
  const Pin *gen_clk_src2 = clk_info2->genClkSrc();
  if (gen_clk_src1 < gen_clk_src2)
    return -1;
  if (gen_clk_src1 > gen_clk_src2)
    return 1;

  bool crpr_on = sta->sdc()->crprActive();
  if (crpr_on) {
    const PathVertexRep &crpr_path1 = clk_info1->crprClkPath();
    const PathVertexRep &crpr_path2 = clk_info2->crprClkPath();
    int path_cmp = PathVertexRep::cmp(crpr_path1, crpr_path2);
    if (path_cmp != 0)
      return path_cmp;
  }

  const ClockUncertainties *uncertainties1 = clk_info1->uncertainties();
  const ClockUncertainties *uncertainties2 = clk_info2->uncertainties();
  if (uncertainties1 < uncertainties2)
    return -1;
  if (uncertainties1 > uncertainties2)
    return 1;

  const Arrival &insert1 = clk_info1->insertion();
  const Arrival &insert2 = clk_info2->insertion();
  if (delayLess(insert1, insert2, sta))
    return -1;
  if (delayGreater(insert1, insert2, sta))
    return 1;

  float latency1 = clk_info1->latency();
  float latency2 = clk_info2->latency();
  if (latency1 < latency2)
    return -1;
  if (latency1 > latency2)
    return 1;

  bool is_propagated1 = clk_info1->isPropagated();
  bool is_propagated2 = clk_info2->isPropagated();
  if (!is_propagated1 && is_propagated2)
    return -1;
  if (is_propagated1 && !is_propagated2)
    return 1;

  bool is_gen_clk_src_path1 = clk_info1->isGenClkSrcPath();
  bool is_gen_clk_src_path2 = clk_info2->isGenClkSrcPath();
  if (!is_gen_clk_src_path1 && is_gen_clk_src_path2)
    return -1;
  if (is_gen_clk_src_path1 && !is_gen_clk_src_path2)
    return 1;

  bool is_pulse_clk1 = clk_info1->isPulseClk();
  bool is_pulse_clk2 = clk_info2->isPulseClk();
  if (!is_pulse_clk1 && is_pulse_clk2)
    return -1;
  if (is_pulse_clk1 && !is_pulse_clk2)
    return 1;

  int pulse_clk_sense_index1 = clk_info1->pulseClkSenseTrIndex();
  int pulse_clk_sense_index2 = clk_info2->pulseClkSenseTrIndex();
  if (pulse_clk_sense_index1 < pulse_clk_sense_index2)
    return -1;
  if (pulse_clk_sense_index1 > pulse_clk_sense_index2)
    return 1;
  else
    return 0;
}

} // namespace