OpenSTA/sdc/DataCheck.cc

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, 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/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#include "DataCheck.hh"

#include "Clock.hh"
#include "Network.hh"

namespace sta {

DataCheck::DataCheck(Pin *from,
                     Pin *to,
                     Clock *clk) :
  from_(from),
  to_(to),
  clk_(clk)
{
}

void
DataCheck::margin(const RiseFall *from_rf,
                  const RiseFall *to_rf,
                  const SetupHold *setup_hold,
                  // Return values.
                  float &margin,
                  bool &exists) const
{
  margins_[from_rf->index()].value(to_rf, setup_hold,
                                   margin, exists);
}

void
DataCheck::setMargin(const RiseFallBoth *from_rf,
                     const RiseFallBoth *to_rf,
                     const SetupHoldAll *setup_hold,
                     float margin)
{
  for (auto from_rf_index : from_rf->rangeIndex())
    margins_[from_rf_index].setValue(to_rf, setup_hold, margin);
}

void
DataCheck::removeMargin(const RiseFallBoth *from_rf,
                        const RiseFallBoth *to_rf,
                        const SetupHoldAll *setup_hold)
{
  for (int from_rf_index : from_rf->rangeIndex())
    margins_[from_rf_index].removeValue(to_rf, setup_hold);
}

bool
DataCheck::empty() const
{
  for (int tr_index : RiseFall::rangeIndex()) {
    if (!margins_[tr_index].empty())
      return false;
  }
  return true;
}

void
DataCheck::marginIsOneValue(const SetupHold *setup_hold,
                            // Return values.
                            float &value,
                            bool &one_value) const
{
  float value1, value2;
  if (margins_[RiseFall::riseIndex()].isOneValue(setup_hold, value1)
      && margins_[RiseFall::fallIndex()].isOneValue(setup_hold, value2)
      && value1 == value2) {
    value = value1;
    one_value = true;
  }
  else
    one_value = false;
}

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

DataCheckLess::DataCheckLess(const Network *network) :
  network_(network)
{
}

bool
DataCheckLess::operator()(const DataCheck *check1,
                          const DataCheck *check2) const
{
  const Pin *from1 = check1->from();
  const Pin *from2 = check2->from();
  const Pin *to1 = check1->to();
  const Pin *to2 = check2->to();
  const Clock *clk1 = check1->clk();
  const Clock *clk2 = check2->clk();
  return network_->id(from1) < network_->id(from2)
    || (from1 == from2
        && (network_->id(to1) < network_->id(to2)
            || (to1 == to2
                && clkCmp(clk1, clk2) < 0)));
}

} // namespace sta