The-OpenROAD-Project_OpenROAD/src/drt/test/gcTest.cpp

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2020-2026, The OpenROAD Authors

#include <cstdint>
#include <map>
#include <memory>
#include <tuple>
#include <utility>
#include <vector>

#include "db/obj/frMarker.h"
#include "db/obj/frNet.h"
#include "db/tech/frConstraint.h"
#include "db/tech/frViaDef.h"
#include "fixture.h"
#include "frBaseTypes.h"
#include "frDesign.h"
#include "gc/FlexGC.h"
#include "gtest/gtest.h"
#include "odb/db.h"
#include "odb/dbTypes.h"
#include "odb/geom.h"

using odb::dbTechLayerType;

namespace drt {

// Fixture for GC tests
struct GCFixture : public Fixture
{
  GCFixture() : worker(design->getTech(), logger.get(), router_cfg.get()) {}

  void testMarker(frMarker* marker,
                  frLayerNum layer_num,
                  frConstraintTypeEnum type,
                  const odb::Rect& expected_bbox)
  {
    odb::Rect bbox = marker->getBBox();

    EXPECT_EQ(marker->getLayerNum(), layer_num);
    EXPECT_TRUE(marker->getConstraint());
    EXPECT_EQ(marker->getConstraint()->typeId(), type);

    EXPECT_EQ(bbox, expected_bbox);
  }

  void runGC()
  {
    // Needs to be run after all the objects are created but before gc
    initRegionQuery();

    // Run the GC engine
    const odb::Rect work(0, 0, 2000, 2000);
    worker.setExtBox(work);
    worker.setDrcBox(work);

    worker.init(design.get());
    worker.main();
  }

  FlexGCWorker worker;
};

template <typename T>
class FixtureWithParam : public GCFixture,
                         public ::testing::WithParamInterface<T>
{
};

// Two touching metal shape from different nets generate a short
TEST_F(GCFixture, metal_short)
{
  // Setup
  frNet* n1 = makeNet("n1");
  frNet* n2 = makeNet("n2");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n2, 2, {500, 0}, {1000, 0});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcShortConstraint,
             odb::Rect(499, -50, 501, 50));
}

/*
 *
 *                     |---------------|(750,200)
 *                     |               |
 *                     |               |
 *                     |     i1        |
 *                     |     OBS       |
 *                     |               |
 *                     |****|(550,90)  |
 *                     | in |          |
 * --------------------|----|--(600,50)|
 * |           (450,40)|****| |        |
 * |         n1        |      |        |
 * --------------------|---------------|
 * (0,-50)        (450,-50)
 */
// short with obs
TEST_F(GCFixture, metal_short_obs)
{
  // Setup
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {600, 0});
  auto [block, master] = makeMacro("OBS");
  makeMacroObs(block, 450, -50, 750, 200, 2);
  makeMacroPin(block, "in", 450, 40, 550, 90, 2);
  auto i1 = makeInst("i1", block, master);
  auto instTerm = i1->getInstTerms()[0].get();
  instTerm->addToNet(n1);

  n1->addInstTerm(instTerm);
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 3);
  // short of pin+net (450,-50), (550,90)
  // with obs 450,-50), (750,200)
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcShortConstraint,
             odb::Rect(450, -50, 550, 40));

  // shorts of net (0,-50), (600,50)
  // with obs (450,-50), (750,200)
  // 2 max rectangles generated
  testMarker(markers[1].get(),
             2,
             frConstraintTypeEnum::frcShortConstraint,
             odb::Rect(550, -50, 600, 50));
  testMarker(markers[2].get(),
             2,
             frConstraintTypeEnum::frcShortConstraint,
             odb::Rect(450, -50, 600, 40));
}

// Two touching metal shape from the same net must have sufficient
// overlap
TEST_F(GCFixture, metal_non_sufficient)
{
  // Setup
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {0, 500});
  makePathseg(n1, 2, {0, 0}, {500, 0});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcNonSufficientMetalConstraint,
             odb::Rect(0, 0, 50, 50));
}

// Path seg less than min width flags a violation
using MinCutFixture = FixtureWithParam<std::pair<int, bool>>;

TEST_P(MinCutFixture, min_cut)
{
  const auto [spacing, legal] = GetParam();
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeMinimumCut(2, 200, 200, spacing);
  frNet* n1 = makeNet("n1");
  frViaDef* vd1 = makeViaDef("v1", 3, {0, 0}, {200, 200});
  makeVia(vd1, n1, {0, 0});
  makePathseg(n1, 2, {0, 100}, {200, 100}, 200);
  makePathseg(n1, 2, {200, 100}, {400, 100}, 100);
  frViaDef* vd2 = makeViaDef("v2", 3, {0, 0}, {100, 100});
  makeVia(vd2, n1, {400, 50});
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcMinimumcutConstraint,
               odb::Rect(200, 50, 400, 150));
  }
}

INSTANTIATE_TEST_SUITE_P(MinCutSuite,
                         MinCutFixture,
                         testing::Values(std::make_pair(1000, false),
                                         std::make_pair(199, true)));

// Path seg less than min width flags a violation
TEST_F(GCFixture, min_width)
{
  // Setup
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0}, 60);

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcMinWidthConstraint,
             odb::Rect(0, -30, 500, 30));
}

// Abutting Path seg less than min width don't flag a violation
// as their combined width is ok
TEST_F(GCFixture, min_width_combines_shapes)
{
  // Setup
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0}, 60);
  makePathseg(n1, 2, {0, 60}, {500, 60}, 60);

  runGC();

  // Test the results
  EXPECT_EQ(worker.getMarkers().size(), 0);
}

// Check violation for off-grid points
TEST_F(GCFixture, off_grid)
{
  // Setup
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {1, 1}, {501, 1});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(worker.getMarkers().size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcOffGridConstraint,
             odb::Rect(1, -49, 501, 51));
}

// Check violation for corner spacing
TEST_F(GCFixture, corner_basic)
{
  // Setup
  makeCornerConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {500, 200}, {1000, 200});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(worker.getMarkers().size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58CornerSpacingConstraint,
             odb::Rect(500, 50, 500, 150));
}

// Check no violation for corner spacing with EOL spacing
// (same as corner_basic but for eol)
TEST_F(GCFixture, corner_eol_no_violation)
{
  // Setup
  makeCornerConstraint(2, 200);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {500, 200}, {1000, 200});

  runGC();

  // Test the results
  EXPECT_EQ(worker.getMarkers().size(), 0);
}

// Check no violation for corner spacing with PRL > 0
// (same as corner_basic but for n2's pathseg begin pt)
TEST_F(GCFixture, corner_prl_no_violation)
{
  // Setup
  makeCornerConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {400, 200}, {1000, 200});

  runGC();

  // Test the results
  EXPECT_EQ(worker.getMarkers().size(), 0);
}

using CornerToCornerFixture = FixtureWithParam<bool>;

TEST_P(CornerToCornerFixture, corner_to_corner)
{
  const bool legal = GetParam();
  // Setup
  auto con = makeCornerConstraint(2);
  con->setCornerToCorner(legal);

  frNet* n1 = makeNet("n1");
  makePathseg(n1, 2, {0, 0}, {200, 0});
  makePathseg(n1, 2, {350, 250}, {1000, 250});

  runGC();

  // Test the results
  EXPECT_EQ(worker.getMarkers().size(), (legal ? 0 : 1));
}

INSTANTIATE_TEST_SUITE_P(CornerToCornerSuite,
                         CornerToCornerFixture,
                         testing::Values(true, false));

// Check violation for corner spacing on a concave corner
TEST_F(GCFixture, DISABLED_corner_concave)
{
  // Setup
  makeCornerConstraint(2, /* no eol */ -1, frCornerTypeEnum::CONCAVE);

  frNet* n1 = makeNet("n1");

  makePathsegExt(n1, 2, {0, 0}, {500, 0});
  makePathsegExt(n1, 2, {0, 0}, {0, 500});
  makePathseg(n1, 2, {200, 200}, {1000, 200});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(worker.getMarkers().size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58CornerSpacingConstraint,
             odb::Rect(50, 50, 200, 200));
}

// Check violation for parallel-run-length (PRL) spacing tables
// This test runs over a variety of width / prl / spacing values
// where the spacing is both legal or illegal.
using SpacingPrlFixture = FixtureWithParam<std::tuple<int, int, int, bool>>;

TEST_P(SpacingPrlFixture, spacing_prl)
{
  const auto [width, prl, spacing, legal] = GetParam();
  // Setup
  makeSpacingConstraint(2);

  frNet* n1 = makeNet("n1");
  frNet* n2 = makeNet("n2");

  frCoord y = /* n2_width / 2 */ 50 + spacing + width / 2;
  if (!legal) {
    /* move too close making a violation */
    y -= 10;
  }
  makePathseg(n1, 2, {0, y}, {prl, y}, width);
  makePathseg(n2, 2, {0, 0}, {500, 0}, 100);

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  if (legal) {
    EXPECT_EQ(worker.getMarkers().size(), 0);
  } else {
    EXPECT_EQ(worker.getMarkers().size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcSpacingTablePrlConstraint,
               odb::Rect(0, 50, prl, y - width / 2));
  }
}

INSTANTIATE_TEST_SUITE_P(
    SpacingPrlSuite,
    SpacingPrlFixture,
    testing::Values(std::make_tuple(100, 300, 100, true),
                    std::make_tuple(100, 500, 200, true),
                    std::make_tuple(220, 300, 300, true),
                    std::make_tuple(220, 500, 400, true),
                    std::make_tuple(100, 300, 100, false),
                    std::make_tuple(100, 500, 200, false),
                    std::make_tuple(220, 300, 300, false),
                    std::make_tuple(220, 500, 400, false)));

// Check violation for spacing two widths with design rule width on macro
// obstruction

using DesignRuleWidthFixture = FixtureWithParam<bool>;

TEST_P(DesignRuleWidthFixture, design_rule_width)
{
  const bool legal = GetParam();
  // Setup
  auto dbLayer = db_tech->findLayer("m1");
  dbLayer->initTwoWidths(2);
  dbLayer->addTwoWidthsIndexEntry(90);
  dbLayer->addTwoWidthsIndexEntry(190);
  dbLayer->addTwoWidthsSpacingTableEntry(0, 0, 0);
  dbLayer->addTwoWidthsSpacingTableEntry(0, 1, 50);
  dbLayer->addTwoWidthsSpacingTableEntry(1, 0, 50);
  dbLayer->addTwoWidthsSpacingTableEntry(1, 1, 150);
  makeSpacingTableTwConstraint(2, {90, 190}, {-1, -1}, {{0, 50}, {50, 100}});
  /*
  WIDTH  90     0      50
  WIDTH 190     50    150
  */
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {500, 50}, 100);
  auto [block, master] = makeMacro("DRW");
  makeMacroObs(block, 0, 140, 500, 340, 2, legal ? 100 : -1);
  makeInst("i1", block, master);
  /*
  If DESIGNRULEWIDTH is 100
    width(n1) = 100      width(obs) = 100 : reqSpcVal = 0
  legal

  if DESIGNRULEWIDTH is -1 (undefined)
    width(n1) = 100      width(obs) = 200 : reqSpcVal = 100
  illegal
  */
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcSpacingTableTwConstraint,
               odb::Rect(0, 100, 500, 140));
  }
}

INSTANTIATE_TEST_SUITE_P(DesignRuleWidthSuite,
                         DesignRuleWidthFixture,
                         testing::Bool());

// Check for a min step violation.
TEST_F(GCFixture, min_step)
{
  // Setup
  makeMinStepConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {200, 0});
  makePathseg(n1, 2, {100, 20}, {200, 20});

  runGC();

  // Test the results
  EXPECT_EQ(worker.getMarkers().size(), 1);
}

// Check for a lef58 style min step violation.  The checker is very
// limited and just supports NOBETWEENEOL style.
TEST_F(GCFixture, min_step58_nobetweeneol)
{
  // Setup
  auto con = makeMinStep58Constraint(2);
  con->setEolWidth(200);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {200, 20}, {300, 20});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58MinStepConstraint,
             odb::Rect(200, 50, 300, 70));
}

// Check for a lef58 style min step violation.  The checker is very
// limited and just supports NOBETWEENEOL style.
TEST_F(GCFixture, min_step58_minadjlength)
{
  // Setup
  auto con = makeMinStep58Constraint(2);
  con->setMinAdjacentLength(100);
  con->setNoAdjEol(200);
  con->setMaxEdges(1);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {200, -30}, {200, 70});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 2);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58MinStepConstraint,
             odb::Rect(150, 50, 500, 70));
  testMarker(markers[1].get(),
             2,
             frConstraintTypeEnum::frcLef58MinStepConstraint,
             odb::Rect(0, 50, 250, 70));
}

// Check for a lef58 rect only violation.  The markers are
// the concave corners expanded by min-width and intersected
// with the metal shapes.
TEST_F(GCFixture, rect_only)
{
  // Setup
  makeRectOnlyConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 0}, {500, 0});
  makePathseg(n1, 2, {200, 0}, {200, 100});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 3);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58RectOnlyConstraint,
             odb::Rect(150, -50, 250, 100));
  testMarker(markers[1].get(),
             2,
             frConstraintTypeEnum::frcLef58RectOnlyConstraint,
             odb::Rect(150, -50, 350, 50));
  testMarker(markers[2].get(),
             2,
             frConstraintTypeEnum::frcLef58RectOnlyConstraint,
             odb::Rect(50, -50, 250, 50));
}

// Check for a min enclosed area violation.
TEST_F(GCFixture, min_enclosed_area)
{
  // Setup
  makeMinEnclosedAreaConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathsegExt(n1, 2, {0, 0}, {200, 0});
  makePathsegExt(n1, 2, {0, 0}, {0, 200});
  makePathsegExt(n1, 2, {0, 200}, {200, 200});
  makePathsegExt(n1, 2, {200, 0}, {200, 200});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcMinEnclosedAreaConstraint,
             odb::Rect(50, 50, 150, 150));
}

using Lef58AreaFixture = FixtureWithParam<bool>;

TEST_P(Lef58AreaFixture, lef58_area)
{
  const bool legal = GetParam();
  // The wire below provides 200 x 100 = 20000 DBU^2.  Require just under that
  // when legal and just over it when illegal.
  makeLef58AreaConstraint(2, /* area */ legal ? 20000 : 30000);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 100}, {200, 100});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58AreaConstraint,
               odb::Rect(0, 50, 200, 150));
  }
}

INSTANTIATE_TEST_SUITE_P(Lef58AreaSuite, Lef58AreaFixture, testing::Bool());

// Check the LEF58 area EXCEPTRECTANGLE option: the rule is ignored for a
// single-rectangle shape but still applies to a non-rectangular one.  The
// required area is set high so both shapes are below it; only the shape
// decides whether a marker is produced.
using Lef58AreaExceptRectFixture = FixtureWithParam<bool>;

TEST_P(Lef58AreaExceptRectFixture, lef58_area_except_rectangle)
{
  const bool rectangular = GetParam();
  makeLef58AreaConstraint(
      2, /* area */ 100000, /* rect_width */ -1, /* except_rectangle */ true);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 100}, {200, 100});
  if (!rectangular) {
    // Add a stem to turn the wire into a (non-rectangular) T-shape.
    makePathseg(n1, 2, {100, 50}, {100, 300});
  }

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (rectangular) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58AreaConstraint,
               odb::Rect(0, 50, 200, 300));
  }
}

INSTANTIATE_TEST_SUITE_P(Lef58AreaExceptRectSuite,
                         Lef58AreaExceptRectFixture,
                         testing::Bool());

// Same rectangle below the required area, varying only EXCEPTRECTANGLE: with
// it set the rectangle is excepted (no marker); without it the rule applies.
using Lef58AreaExceptRectRectFixture = FixtureWithParam<bool>;

TEST_P(Lef58AreaExceptRectRectFixture, lef58_area_except_rectangle_rect)
{
  const bool except_rectangle = GetParam();
  makeLef58AreaConstraint(
      2, /* area */ 30000, /* rect_width */ -1, except_rectangle);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 100}, {200, 100});  // rectangle, area 20000

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (except_rectangle) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58AreaConstraint,
               odb::Rect(0, 50, 200, 150));
  }
}

INSTANTIATE_TEST_SUITE_P(Lef58AreaExceptRectRectSuite,
                         Lef58AreaExceptRectRectFixture,
                         testing::Bool());

// Check for a spacing table influence violation.
TEST_F(GCFixture, spacing_table_infl_vertical)
{
  // Setup
  makeSpacingTableInfluenceConstraint(2, {10}, {{200, 100}});

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {50, 0}, {50, 200});
  makePathseg(n1, 2, {0, 100}, {350, 100});
  makePathseg(n1, 2, {0, 250}, {350, 250});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcSpacingTableInfluenceConstraint,
             odb::Rect(100, 150, 300, 200));
}
// Check for a spacing table influence violation.
TEST_F(GCFixture, spacing_table_infl_horizontal)
{
  // Setup
  makeSpacingTableInfluenceConstraint(2, {10}, {{200, 150}});

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 500}, {500, 500});
  makePathseg(n1, 2, {100, 0}, {100, 500});
  makePathseg(n1, 2, {300, 0}, {300, 500});
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcSpacingTableInfluenceConstraint,
             odb::Rect(150, 250, 250, 450));
}

// Check for a spacing table twowidths violation.
TEST_F(GCFixture, spacing_table_twowidth)
{
  // Setup
  auto dbLayer = db_tech->findLayer("m1");
  dbLayer->initTwoWidths(2);
  dbLayer->addTwoWidthsIndexEntry(90);
  dbLayer->addTwoWidthsIndexEntry(190);
  dbLayer->addTwoWidthsSpacingTableEntry(0, 0, 0);
  dbLayer->addTwoWidthsSpacingTableEntry(0, 1, 50);
  dbLayer->addTwoWidthsSpacingTableEntry(1, 0, 50);
  dbLayer->addTwoWidthsSpacingTableEntry(1, 1, 150);
  makeSpacingTableTwConstraint(2, {90, 190}, {-1, -1}, {{0, 50}, {50, 100}});

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {500, 50}, 100);
  makePathseg(n1, 2, {0, 240}, {500, 240}, 200);

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcSpacingTableTwConstraint,
             odb::Rect(0, 100, 500, 140));
}

// Check for a SPACING RANGE violation.
using SpacingRangeFixture = FixtureWithParam<std::tuple<int, int, bool>>;

TEST_P(SpacingRangeFixture, spacing_range)
{
  const auto [minWidth, y, legal] = GetParam();
  // Setup
  makeSpacingRangeConstraint(2, 500, minWidth, 400);

  frNet* n1 = makeNet("n1");
  frNet* n2 = makeNet("n2");

  makePathseg(n1, 2, {0, 50}, {1000, 50});
  makePathseg(n2, 2, {0, y}, {1000, y});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    if (y == 100) {
      EXPECT_EQ(markers[0]->getConstraint()->typeId(),
                frConstraintTypeEnum::frcShortConstraint);
    } else {
      testMarker(markers[0].get(),
                 2,
                 frConstraintTypeEnum::frcSpacingRangeConstraint,
                 odb::Rect(0, 100, 1000, y - 50));
    }
  }
}

INSTANTIATE_TEST_SUITE_P(SpacingRangeSuite,
                         SpacingRangeFixture,
                         testing::Values(std::make_tuple(0, 200, false),
                                         std::make_tuple(200, 200, true),
                                         std::make_tuple(200, 100, false)));

// Check for a SPACING RANGE SAME/DIFF net violation.

using SpacingRangeSameDiffNetFixture = FixtureWithParam<std::pair<bool, bool>>;

TEST_P(SpacingRangeSameDiffNetFixture, spacing_range_same_diff_net)
{
  const auto [samenet, legal] = GetParam();
  // Setup
  makeSpacingRangeConstraint(2, 500, 0, 400);

  frNet* n1 = makeNet("n1");
  frNet* n2 = n1;
  if (!samenet) {
    n2 = makeNet("n2");
  }

  makePathseg(n1, 2, {0, 50}, {1000, 50});
  makePathseg(n2, 2, {0, 200}, {1000, 200});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcSpacingRangeConstraint,
               odb::Rect(0, 100, 1000, 150));
  }
}

INSTANTIATE_TEST_SUITE_P(SpacingRangeSameDiffNetSuite,
                         SpacingRangeSameDiffNetFixture,
                         testing::Values(std::make_pair(false, false),
                                         std::make_pair(true, true)));

// Check for a basic end-of-line (EOL) spacing violation.
using EolBasicFixture = FixtureWithParam<bool>;

TEST_P(EolBasicFixture, eol_basic)
{
  const bool lef58 = GetParam();
  // Setup
  if (lef58) {
    makeLef58SpacingEolConstraint(2);
  } else {
    makeSpacingEndOfLineConstraint(2);
  }

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  makePathseg(n1, 2, {0, 700}, {1000, 700});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             lef58 ? frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint
                   : frConstraintTypeEnum::frcSpacingEndOfLineConstraint,
             odb::Rect(450, 500, 550, 650));
}

INSTANTIATE_TEST_SUITE_P(EolBasicSuite, EolBasicFixture, testing::Bool());

// Check for a basic end-of-line (EOL) spacing violation.
TEST_F(GCFixture, eol_endtoend)
{
  // Setup
  auto con = makeLef58SpacingEolConstraint(2);
  auto endToEnd
      = std::make_shared<frLef58SpacingEndOfLineWithinEndToEndConstraint>();
  con->getWithinConstraint()->setEndToEndConstraint(endToEnd);
  endToEnd->setEndToEndSpace(300);
  con->getWithinConstraint()->setSameMask(true);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {100, 50});
  makePathseg(n1, 2, {350, 50}, {1000, 50});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
             odb::Rect(100, 0, 350, 100));
}
// Check for a basic end-of-line (EOL) spacing violation with extension.
TEST_F(GCFixture, eol_endtoend_ext)
{
  // Setup
  auto con = makeLef58SpacingEolConstraint(2);
  auto endToEnd
      = std::make_shared<frLef58SpacingEndOfLineWithinEndToEndConstraint>();
  endToEnd->setEndToEndSpace(300);
  endToEnd->setExtension(50);
  con->getWithinConstraint()->setEndToEndConstraint(endToEnd);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {100, 50});
  makePathseg(n1, 2, {350, 200}, {1000, 200});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
             odb::Rect(100, 100, 350, 150));
}

TEST_F(GCFixture, eol_wrongdirspc)
{
  // Setup
  auto con = makeLef58SpacingEolConstraint(2);
  con->setWrongDirSpace(100);
  db_tech->findLayer("m1")->setDirection(odb::dbTechLayerDir::VERTICAL);
  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {100, 50});
  makePathseg(n1, 2, {250, 50}, {1000, 50});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 0);
}

using EolExtBasicFixture = FixtureWithParam<std::pair<int, bool>>;

TEST_P(EolExtBasicFixture, eol_ext_basic)
{
  const auto [ext, legal] = GetParam();
  // Setup
  makeEolExtensionConstraint(2, 100, {51, 101}, {20, ext}, false);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 100}, {500, 100});
  makePathseg(n1, 2, {690, 100}, {1000, 100});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    if (markers.size() == 1) {
      testMarker(markers[0].get(),
                 2,
                 frConstraintTypeEnum::frcLef58EolExtensionConstraint,
                 odb::Rect(500, 50, 690, 150));
    }
  }
}

INSTANTIATE_TEST_SUITE_P(EolExtBasicSuite,
                         EolExtBasicFixture,
                         testing::Values(std::make_pair(30, true),
                                         std::make_pair(50, false)));

TEST_F(GCFixture, eol_prlend)
{
  // Setup
  makeLef58SpacingEolConstraint(2,    // layer_num
                                200,  // space
                                200,  // width
                                50,   // within
                                400,  // end_prl_spacing
                                50);  // end_prl

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 50}, {100, 50});
  makePathseg(n1, 2, {320, 100}, {1000, 100});

  // Test if you have a non-prl case when you have prl rule
  // this yields no violation
  makePathseg(n1, 2, {0, 500}, {100, 500});
  makePathseg(n1, 2, {320, 500}, {1000, 500});

  // Test if you have a non-prl case when you have prl rule
  // this still yields a violation
  makePathseg(n1, 2, {0, 1000}, {100, 1000});
  makePathseg(n1, 2, {220, 1000}, {1000, 1000});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 2);
  testMarker(markers[0].get(),
             2,
             frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
             odb::Rect(100, 50, 320, 100));
  testMarker(markers[1].get(),
             2,
             frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
             odb::Rect(100, 950, 220, 1050));
}

using EolExtParOnlyFixture = FixtureWithParam<bool>;

TEST_P(EolExtParOnlyFixture, eol_ext_paronly)
{
  const bool parOnly = GetParam();
  // Setup
  makeEolExtensionConstraint(2, 100, {101}, {50}, parOnly);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {0, 100}, {500, 100});
  makePathseg(n1, 2, {520, 290}, {910, 290});
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (parOnly) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58EolExtensionConstraint,
               odb::Rect(500, 150, 520, 240));
  }
}

INSTANTIATE_TEST_SUITE_P(EolExtParOnlySuite,
                         EolExtParOnlyFixture,
                         testing::Bool());

// Check for eol keepout violation.
using EolKeepoutFixture = FixtureWithParam<bool>;

TEST_P(EolKeepoutFixture, eol_keepout)
{
  const bool legal = GetParam();
  // Setup
  makeLef58EolKeepOutConstraint(2);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  frCoord x_extra = 0;
  if (legal) {
    x_extra = 200;
  }
  makePathseg(n1, 2, {400 + x_extra, 700}, {700 + x_extra, 700});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58EolKeepOutConstraint,
               odb::Rect(450, 500, 550, 650));
  }
}

INSTANTIATE_TEST_SUITE_P(EolKeepoutSuite, EolKeepoutFixture, testing::Bool());

TEST_F(GCFixture, eol_keepout_except_within)
{
  // Setup
  makeLef58EolKeepOutConstraint(2, false, true);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  makePathseg(n1, 2, {400, 700}, {700, 700});

  runGC();

  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 0);
}

// Check for eol keepout violation CORNERONLY.
using EolKeepoutCornerFixture = FixtureWithParam<std::tuple<bool, bool>>;

TEST_P(EolKeepoutCornerFixture, eol_keepout_corner)
{
  const auto [concave, legal] = GetParam();
  // Setup
  makeLef58EolKeepOutConstraint(2, true);

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  frCoord x_extra = 0;
  if (concave && !legal) {
    makePathseg(n1, 2, {360, 400}, {360, 750});
  }
  if (!concave && !legal) {
    x_extra = 10;
  }
  makePathseg(n1, 2, {400 + x_extra, 700}, {600 + x_extra, 700});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58EolKeepOutConstraint,
               odb::Rect(410, 500, 450, 650));
  }
}

INSTANTIATE_TEST_SUITE_P(EolKeepoutCornerSuite,
                         EolKeepoutCornerFixture,
                         testing::Combine(testing::Bool(), testing::Bool()));

// Check for an end-of-line (EOL) spacing violation involving one
// parallel edge
using EolParallelEdgeFixture = FixtureWithParam<bool>;
TEST_P(EolParallelEdgeFixture, eol_parallel_edge)
{
  const bool lef58 = GetParam();
  // Setup
  if (lef58) {
    makeLef58SpacingEolParEdgeConstraint(
        makeLef58SpacingEolConstraint(2), 200, 200);
  } else {
    makeSpacingEndOfLineConstraint(
        2, /* par_space */ 200, /* par_within */ 200);
  }

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  makePathseg(n1, 2, {0, 700}, {1000, 700});
  makePathseg(n1, 2, {300, 0}, {300, 450});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             lef58 ? frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint
                   : frConstraintTypeEnum::frcSpacingEndOfLineConstraint,
             odb::Rect(450, 500, 550, 650));
}

INSTANTIATE_TEST_SUITE_P(EolParallelEdgeSuite,
                         EolParallelEdgeFixture,
                         testing::Bool());

// Check for an end-of-line (EOL) spacing violation involving two
// parallel edges
using EolParallelTwoEdgeFixture = FixtureWithParam<bool>;
TEST_P(EolParallelTwoEdgeFixture, eol_parallel_two_edge)
{
  const bool lef58 = GetParam();
  // Setup
  if (lef58) {
    makeLef58SpacingEolParEdgeConstraint(
        makeLef58SpacingEolConstraint(2), 200, 200, true);
  } else {
    makeSpacingEndOfLineConstraint(2,
                                   /* par_space */ 200,
                                   /* par_within */ 200,
                                   /* two_edges */ true);
  }

  frNet* n1 = makeNet("n1");

  makePathseg(n1, 2, {500, 0}, {500, 500});
  makePathseg(n1, 2, {0, 700}, {1000, 700});
  makePathseg(n1, 2, {300, 0}, {300, 450});
  makePathseg(n1, 2, {700, 0}, {700, 450});

  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             2,
             lef58 ? frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint
                   : frConstraintTypeEnum::frcSpacingEndOfLineConstraint,
             odb::Rect(450, 500, 550, 650));
}

INSTANTIATE_TEST_SUITE_P(EolParallelTwoEdgeSuite,
                         EolParallelTwoEdgeFixture,
                         testing::Bool());

using EolMinMaxFixture = FixtureWithParam<std::tuple<bool, bool, bool>>;

TEST_P(EolMinMaxFixture, eol_min_max)
{
  const auto [max, twoSides, legal] = GetParam();
  makeLef58SpacingEolMinMaxLenConstraint(
      makeLef58SpacingEolConstraint(2), 500, max, twoSides);
  frNet* n1 = makeNet("n1");
  frCoord y = 500;
  if (twoSides)  // both sides need to meet minMax for eolSpacing to be
                 // triggered and one of them need to violate minMax for
                 // eolSpacing to be neglected
  {
    if (max && legal) {
      y += 10;  // right(510) > std::max(500) --> minMax violated --> legal
    } else if (!max && !legal) {
      y += 100;  // right(600) & left(500) >= std::min(500) --> minMax is met
                 // --> illegal
    }
  } else if (legal)  // both sides need to violate minMax to have no
                     // eolSpacing violations
  {
    if (max) {
      y += 110;  // right(610) & left(510) > std::max(500)
    } else {
      y -= 10;  // right(490) & left(390) < std::min(500)
    }
  }
  makePathseg(n1, 2, {500, 0}, {500, y});
  makePathseg(n1, 2, {0, 700}, {1000, 700});

  makePathseg(n1, 2, {0, 50}, {450, 50});
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    if (markers.size() == 1) {
      testMarker(markers[0].get(),
                 2,
                 frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
                 odb::Rect(450, y, 550, 650));
    }
  }
}

INSTANTIATE_TEST_SUITE_P(EolMinMaxSuite,
                         EolMinMaxFixture,
                         testing::Combine(testing::Bool(),
                                          testing::Bool(),
                                          testing::Bool()));

using EolEncloseCutFixture = FixtureWithParam<std::pair<int, bool>>;
TEST_P(EolEncloseCutFixture, eol_enclose_cut)
{
  const auto [y, legal] = GetParam();
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeLef58SpacingEolCutEncloseConstraint(makeLef58SpacingEolConstraint(4));
  frNet* n1 = makeNet("n1");
  frViaDef* vd = makeViaDef("v", 3, {0, 0}, {100, 100});

  makePathseg(n1, 4, {500, 0}, {500, 500});
  makePathseg(n1, 4, {0, 700}, {1000, 700});
  makeVia(vd, n1, {400, y});
  runGC();
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
    if (markers.size() == 1) {
      testMarker(markers[0].get(),
                 4,
                 frConstraintTypeEnum::frcLef58SpacingEndOfLineConstraint,
                 odb::Rect(450, 500, 550, 650));
    }
  }
}

INSTANTIATE_TEST_SUITE_P(EolEncloseCutSuite,
                         EolEncloseCutFixture,
                         testing::Values(std::make_pair(0, true),
                                         std::make_pair(350, false)));

using CutSpcTblFixture = FixtureWithParam<bool>;
TEST_P(CutSpcTblFixture, cut_spc_tbl)
{
  const bool viol = GetParam();
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeCutClass(3, "Vx", 100, 200);
  auto layer = db_tech->findLayer("v2");
  auto dbRule = odb::dbTechLayerCutSpacingTableDefRule::create(layer);
  dbRule->setDefault(100);
  dbRule->setVertical(true);
  std::map<std::string, uint32_t> row_map;
  std::map<std::string, uint32_t> col_map;
  std::vector<std::vector<std::pair<int, int>>> table;
  row_map["Vx/SIDE"] = 1;
  row_map["Vx/END"] = 0;
  col_map["Vx/SIDE"] = 1;
  col_map["Vx/END"] = 0;
  if (viol) {
    table.push_back({{300, 300}, {300, 300}});
    table.push_back({{300, 300}, {300, 301}});
  } else {
    table.push_back({{301, 301}, {301, 301}});
    table.push_back({{301, 301}, {301, 300}});
  }

  dbRule->setSpacingTable(table, row_map, col_map);
  makeLef58CutSpcTbl(3, dbRule);
  frNet* n1 = makeNet("n1");

  frViaDef* vd = makeViaDef("v", 3, {0, 0}, {200, 100});

  makeVia(vd, n1, {0, 0});
  makeVia(vd, n1, {0, 400});

  runGC();
  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), (viol ? 1 : 0));
}

INSTANTIATE_TEST_SUITE_P(CutSpcTblSuite, CutSpcTblFixture, testing::Bool());

using CutSpcTblExAlignedFixture = FixtureWithParam<std::pair<int, int>>;
TEST_P(CutSpcTblExAlignedFixture, cut_spc_tbl_ex_aligned)
{
  const auto [x, viol] = GetParam();
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeCutClass(3, "Vx", 100, 100);
  auto layer = db_tech->findLayer("v2");
  auto dbRule = odb::dbTechLayerCutSpacingTableDefRule::create(layer);
  dbRule->setDefault(200);
  dbRule->addExactElignedEntry("Vx", 250);
  dbRule->setVertical(true);
  makeLef58CutSpcTbl(3, dbRule);
  frNet* n1 = makeNet("n1");

  frViaDef* vd = makeViaDef("v", 3, {0, 0}, {100, 100});

  makeVia(vd, n1, {0, 0});
  makeVia(vd, n1, {x, 300});

  runGC();
  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), viol);
}

INSTANTIATE_TEST_SUITE_P(CutSpcTblExAlignedSuite,
                         CutSpcTblExAlignedFixture,
                         testing::Values(std::make_pair(0, 1),
                                         std::make_pair(10, 0)));

TEST_F(GCFixture, metal_width_via_map)
{
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  frViaDef* vd_bar = makeViaDef("V2_BAR", 3, {0, 0}, {100, 100});
  frViaDef* vd_large = makeViaDef("V2_LARGE", 3, {0, 0}, {200, 200});

  auto db_layer = db_tech->findLayer("v2");
  auto dbRule = odb::dbMetalWidthViaMap::create(db_tech);
  dbRule->setAboveLayerWidthLow(300);
  dbRule->setAboveLayerWidthHigh(300);
  dbRule->setBelowLayerWidthLow(300);
  dbRule->setBelowLayerWidthHigh(300);
  dbRule->setCutLayer(db_layer);
  dbRule->setViaName("V2_LARGE");

  makeMetalWidthViaMap(3, dbRule);

  frNet* n1 = makeNet("n1");
  makePathseg(n1, 2, {0, 150}, {1000, 150}, 300);
  makePathseg(n1, 4, {0, 150}, {1000, 150}, 300);
  makeVia(vd_bar, n1, {100, 0});
  makeVia(vd_large, n1, {300, 0});
  runGC();

  // Test the results
  auto& markers = worker.getMarkers();

  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             3,
             frConstraintTypeEnum::frcMetalWidthViaConstraint,
             odb::Rect(100, 0, 200, 100));
}

using CutSpcParallelOverlapFixture = FixtureWithParam<std::pair<int, int>>;
TEST_P(CutSpcParallelOverlapFixture, cut_spc_parallel_overlap)
{
  const auto [spacing, legal] = GetParam();
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  frViaDef* vd_bar = makeViaDef("V2_BAR", 3, {0, 0}, {100, 100});

  makeLef58CutSpacingConstraint_parallelOverlap(3, spacing);

  frNet* n1 = makeNet("n1");
  frNet* n2 = makeNet("n2");
  makeVia(vd_bar, n1, {0, 0});
  makeVia(vd_bar, n2, {150, 0});
  runGC();

  // // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
  }
  if (!markers.empty()) {
    testMarker(markers[0].get(),
               3,
               frConstraintTypeEnum::frcLef58CutSpacingConstraint,
               odb::Rect(100, 0, 150, 100));
  }
}

INSTANTIATE_TEST_SUITE_P(CutSpcParallelOverlapSuite,
                         CutSpcParallelOverlapFixture,
                         testing::Values(std::make_pair(100, false),
                                         std::make_pair(50, true)));

using CutSpcAdjacentCutsFixture = FixtureWithParam<bool>;
TEST_P(CutSpcAdjacentCutsFixture, cut_spc_adjacent_cuts)
{
  const bool lef58 = GetParam();
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeCutClass(3, "VA", 110, 110);
  if (lef58) {
    makeLef58CutSpacingConstraint_adjacentCut(3, 190, 3, 1, 200);
    frNet* n1 = makeNet("n1");
    frNet* n2 = makeNet("n2");
    frNet* n3 = makeNet("n3");
    frNet* n4 = makeNet("n4");
    frViaDef* vd = makeViaDef("v", 3, {0, 0}, {110, 110});

    makeVia(vd, n1, {1000, 1000});
    makeVia(vd, n2, {1000, 820});
    makeVia(vd, n3, {820, 1000});
    makeVia(vd, n4, {1000, 1180});

    runGC();

    // Test the results
    auto& markers = worker.getMarkers();

    EXPECT_EQ(markers.size(), 3);
  }
}

INSTANTIATE_TEST_SUITE_P(CutSpcAdjacentCutsSuite,
                         CutSpcAdjacentCutsFixture,
                         testing::Bool());

TEST_F(GCFixture, cut_keepoutzone)
{
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  frViaDef* vd_bar = makeViaDef("V2_BAR", 3, {0, 0}, {200, 150});
  makeCutClass(3, "Vx", 150, 200);

  auto db_layer = db_tech->findLayer("v2");
  auto dbRule = odb::dbTechLayerKeepOutZoneRule::create(db_layer);
  dbRule->setFirstCutClass("Vx");
  dbRule->setEndSideExtension(51);
  dbRule->setEndForwardExtension(51);
  dbRule->setSideSideExtension(51);
  dbRule->setSideForwardExtension(51);
  makeKeepOutZoneRule(3, dbRule);

  frNet* n1 = makeNet("n1");
  makeVia(vd_bar, n1, {0, 0});
  makeVia(vd_bar, n1, {150, 200});
  runGC();

  // // Test the results
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  testMarker(markers[0].get(),
             3,
             frConstraintTypeEnum::frcLef58KeepOutZoneConstraint,
             odb::Rect(150, 150, 200, 200));
}

using RouteWrongDirectionSpcFixture
    = FixtureWithParam<std::tuple<int, bool, bool, int, int>>;
TEST_P(RouteWrongDirectionSpcFixture, route_wrong_direction_spc)
{
  const auto [spacing, legal, noneolValid, noneolWidth, prlLength] = GetParam();
  // Setup
  auto db_layer = db_tech->findLayer("m1");
  db_layer->setDirection(odb::dbTechLayerDir::VERTICAL);
  auto dbRule = odb::dbTechLayerWrongDirSpacingRule::create(db_layer);
  dbRule->setWrongdirSpace(spacing);
  if (noneolValid) {
    dbRule->setNoneolValid(noneolValid);
    dbRule->setNoneolWidth(noneolWidth);
  }
  if (prlLength != 0) {
    dbRule->setPrlLength(prlLength);
  }

  makeLef58WrongDirSpcConstraint(2, dbRule);

  frNet* n1 = makeNet("n1");
  frNet* n2 = makeNet("n2");
  makePathseg(n1, 2, {0, 50}, {100, 50}, 100);
  if (prlLength != 0) {
    makePathseg(n2, 2, {50, 200}, {150, 200}, 100);
  } else {
    makePathseg(n2, 2, {0, 200}, {100, 200}, 100);
  }

  runGC();

  // // Test the results
  auto& markers = worker.getMarkers();
  if (legal) {
    EXPECT_EQ(markers.size(), 0);
  } else {
    EXPECT_EQ(markers.size(), 1);
  }
  if (!markers.empty()) {
    testMarker(markers[0].get(),
               2,
               frConstraintTypeEnum::frcLef58SpacingWrongDirConstraint,
               odb::Rect(0, 100, 100, 150));
  }
}

INSTANTIATE_TEST_SUITE_P(
    RouteWrongDirectionSpcSuite,
    RouteWrongDirectionSpcFixture,
    testing::Values(std::make_tuple(100, false, false, 150, 0),
                    std::make_tuple(50, true, false, 150, 0),
                    std::make_tuple(100, true, true, 150, 0),
                    std::make_tuple(100, true, false, 150, 50)));

TEST_F(GCFixture, twowires_forbidden_spc)
{
  // Setup
  auto db_layer = db_tech->findLayer("m1");
  auto rule = odb::dbTechLayerTwoWiresForbiddenSpcRule::create(db_layer);
  rule->setMinSpacing(0);
  rule->setMaxSpacing(300);
  rule->setMinSpanLength(0);
  rule->setMaxSpanLength(500);
  rule->setPrl(0);
  makeLef58TwoWiresForbiddenSpc(2, rule);
  frNet* n1 = makeNet("n1");
  makePathseg(n1, 2, {0, 50}, {500, 50});
  makePathseg(n1, 2, {0, 200}, {500, 200});

  runGC();

  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
}

TEST_F(GCFixture, forbidden_spc)
{
  // Setup
  auto db_layer = db_tech->findLayer("m1");
  auto rule = odb::dbTechLayerForbiddenSpacingRule::create(db_layer);
  rule->setForbiddenSpacing({550, 800});
  rule->setPrl(1);
  rule->setWidth(300);
  rule->setTwoEdges(300);
  makeLef58ForbiddenSpc(2, rule);
  frNet* n1 = makeNet("n1");
  makePathseg(n1, 2, {0, 50}, {500, 50});
  makePathseg(n1, 2, {0, 700}, {500, 700});
  // wire in between
  makePathseg(n1, 2, {0, 300}, {500, 300});
  // wire above
  makePathseg(n1, 2, {0, 900}, {500, 900});

  runGC();

  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
}

TEST_F(GCFixture, lef58_enclosure)
{
  // Setup
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeCutClass(3, "Vx", 100, 200);
  makeLef58EnclosureConstrainut(3, 0, 0, 0, 0);
  makeLef58EnclosureConstrainut(3, 0, 200, 100, 50);

  frViaDef* vd = makeViaDef("v", 3, {0, 0}, {200, 100});

  frNet* n1 = makeNet("n1");
  makeVia(vd, n1, {0, 0});
  makePathseg(n1, 4, {-50, 50}, {250, 50}, 200);

  runGC();
  // BELOW ENC VALID, ABOVE ENCLOSURE VIOLATING
  auto& markers = worker.getMarkers();
  EXPECT_EQ(markers.size(), 1);
  if (!markers.empty()) {
    testMarker(markers[0].get(),
               4,
               frConstraintTypeEnum::frcLef58EnclosureConstraint,
               odb::Rect(0, 0, 200, 100));
  }
}

using CutSpcTblOrthFixture = FixtureWithParam<std::pair<bool, int>>;
TEST_P(CutSpcTblOrthFixture, cut_spc_tbl_orth)
{
  const auto [violating, y] = GetParam();
  addLayer(design->getTech(), "v2", dbTechLayerType::CUT);
  addLayer(design->getTech(), "m2", dbTechLayerType::ROUTING);
  makeSpacingTableOrthConstraint(3, 150, 50);
  frViaDef* vd = makeViaDef("v", 3, {0, 0}, {100, 100});
  frNet* n1 = makeNet("n1");
  makeVia(vd, n1, {0, 0});
  makeVia(vd, n1, {0, 240});
  makeVia(vd, n1, {y, 110});
  runGC();
  auto& markers = worker.getMarkers();
  if (violating) {
    EXPECT_EQ(markers.size(), 1);
  } else {
    EXPECT_EQ(markers.size(), 0);
  }
}

INSTANTIATE_TEST_SUITE_P(CutSpcTblOrthSuite,
                         CutSpcTblOrthFixture,
                         testing::Values(std::make_pair(true, 140),
                                         std::make_pair(false, 150)));

using WidthTblOrthFixture = FixtureWithParam<std::tuple<int, int>>;
TEST_P(WidthTblOrthFixture, width_tbl_orth)
{
  const auto [horz_spc, vert_spc] = GetParam();
  makeWidthTblOrthConstraint(2, horz_spc, vert_spc);
  design->getTech()->getLayer(2)->setMinWidth(
      10);  // to ignore NSMetal violations
  frNet* n1 = makeNet("n1");
  makePathseg(n1, 2, {0, 100}, {200, 100}, 100);
  makePathseg(n1, 2, {150, 50}, {350, 50}, 100);
  const frCoord dx = 50;
  const frCoord dy = 50;
  const bool violating = dx < horz_spc && dy < vert_spc;
  runGC();
  auto& markers = worker.getMarkers();
  if (violating) {
    EXPECT_EQ(markers.size(), 1);
  } else {
    EXPECT_EQ(markers.size(), 0);
  }
}
INSTANTIATE_TEST_SUITE_P(WidthTblOrthSuite,
                         WidthTblOrthFixture,
                         testing::Combine(testing::Values(40, 50, 60),
                                          testing::Values(40, 50, 60)));

// Macro OBS with SPACING 0 (minSpacing=0) must not produce a short/abutting
// violation when a metal segment's edge exactly touches the OBS edge.
// Verifies the rects_abut path in checkMetalSpacing_short_obs
// (FlexGC_main.cpp): when rects_abut=true and reqSpcVal==0 the short check
// is suppressed.  A layer spacing rule is required so that a plain OBS
// (minSpacing=-1) yields reqSpcVal>0 and the baseline violation fires,
// confirming the fix case (minSpacing=0 → reqSpcVal=0 → return) is the
// only reason the check is suppressed.
using ShortObsMinSpacingFixture = FixtureWithParam<bool>;
TEST_P(ShortObsMinSpacingFixture, short_obs_min_spacing)
{
  const bool has_min_spacing = GetParam();
  // Add spacing rule: width=100 + PRL=0 → reqSpcVal=100 for a plain OBS.
  makeSpacingConstraint(2);
  frNet* n1 = makeNet("n1");
  // Horizontal path ending at x=500; OBS west face starts at x=500
  // → shapes abut (distX=distY=0, prlX=0, prlY=100 → rects_abut=true).
  makePathseg(n1, 2, {0, 0}, {500, 0});
  auto [block, master] = makeMacro("OBS");
  auto blk = makeMacroObs(block, 500, -50, 1000, 50, 2);
  if (has_min_spacing) {
    blk->setMinSpacing(0);  // SPACING 0 in LEF OBS → reqSpcVal=0 → suppressed
  }
  makeInst("i1", block, master);
  runGC();
  EXPECT_EQ(worker.getMarkers().size(), has_min_spacing ? 0u : 1u);
}
INSTANTIATE_TEST_SUITE_P(ShortObsMinSpacingSuite,
                         ShortObsMinSpacingFixture,
                         testing::Bool());

}  // namespace drt