The-OpenROAD-Project_OpenROAD/src/odb/test/cpp/TestDbWire.cc

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

#include <unistd.h>

#include <memory>

#include "gtest/gtest.h"
#include "odb/db.h"
#include "odb/dbShape.h"
#include "odb/dbWireCodec.h"
#include "odb/lefin.h"
#include "tst/fixture.h"
#include "utl/Logger.h"

namespace odb {
class OdbMultiPatternedTest : public tst::Fixture
{
 protected:
  void SetUp() override
  {
    lib_ = loadTechAndLib(
        "multipatterned",
        "multipatterned",
        "_main/src/odb/test/data/sky130hd/sky130hd_multi_patterned.tlef");

    chip_ = odb::dbChip::create(db_.get(), db_->getTech());
    block_ = odb::dbBlock::create(chip_, "top");
    block_->setDefUnits(lib_->getTech()->getLefUnits());
    block_->setDieArea(odb::Rect(0, 0, 1000, 1000));
  }

  odb::dbLib* lib_;
  odb::dbChip* chip_;
  odb::dbBlock* block_;
};

TEST_F(OdbMultiPatternedTest, NdrWidth)
{
  dbTechLayer* met1 = lib_->getTech()->findLayer("met1");
  ASSERT_NE(met1, nullptr);

  // Setup an NDR
  dbTechNonDefaultRule* ndr = dbTechNonDefaultRule::create(block_, "ndr");
  dbTechLayerRule* rule = dbTechLayerRule::create(ndr, met1);
  const int width = 42;
  rule->setWidth(width);

  // Apply it to some routing
  dbNet* net = dbNet::create(block_, "net");
  dbWire* wire = dbWire::create(net);
  dbWireEncoder encoder;
  encoder.begin(wire);
  encoder.newPath(met1, dbWireType::ROUTED, rule);
  encoder.addPoint(0, 0);
  encoder.addPoint(0, 100000);
  encoder.addPoint(100000, 100000);
  encoder.end();

  // Check the width in both directions is correct
  int shape_cnt = 0;
  odb::dbWireShapeItr it;
  it.begin(wire);
  odb::dbShape shape;
  while (it.next(shape)) {
    EXPECT_EQ(shape.getBox().minDXDY(), width);
    ++shape_cnt;
  }
  EXPECT_EQ(shape_cnt, 2);
}

TEST_F(OdbMultiPatternedTest, CanColorColoredLayer)
{
  // Arrange
  dbNet* net = dbNet::create(block_, "net0");
  dbTech* tech = lib_->getTech();
  dbTechLayer* met1 = tech->findLayer("met1");
  dbWire* wire = dbWire::create(net);

  // Wire shape
  // (50,50) ----------(color 1)-----------(100,50)

  dbWireEncoder encoder;
  encoder.begin(wire);
  encoder.newPath(met1, dbWireType::ROUTED);
  encoder.addPoint(50, 50);
  encoder.setColor(/*mask_color=*/1);
  encoder.addPoint(100, 50);
  encoder.end();

  // Act & Assert
  dbWireDecoder decoder;
  decoder.begin(wire);
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::PATH);
  EXPECT_FALSE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_FALSE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_TRUE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.getColor().value(), /*mask_color=*/1);
}

TEST_F(OdbMultiPatternedTest, WireColorIsClearedOnNewPath)
{
  // Arrange
  dbNet* net = dbNet::create(block_, "net0");
  dbTech* tech = lib_->getTech();
  dbTechLayer* met1 = tech->findLayer("met1");
  dbTechVia* met1_met2 = tech->findVia("M1M2_PR_MR");
  dbWire* wire = dbWire::create(net);

  // Wire shape
  //                                       M2
  //                                    (100, 50)--(color 2)---(130,50)
  //                                       |
  //                                       |
  //                                   VIA=(M1M2_PR_MR)
  //                                       |
  //                      M1               |
  // (50,50) ----------(color 1)--------(100,50)(junction_1)

  dbWireEncoder encoder;
  encoder.begin(wire);
  encoder.newPath(met1, dbWireType::ROUTED);
  encoder.addPoint(50, 50);
  encoder.setColor(/*mask_color=*/1);
  int junction_1 = encoder.addPoint(100, 50);
  encoder.addTechVia(met1_met2);
  encoder.newPath(junction_1);
  encoder.setColor(/*mask_color=*/2);
  encoder.addPoint(130, 50);
  encoder.end();

  // Act & Assert
  dbWireDecoder decoder;
  decoder.begin(wire);
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::PATH);
  EXPECT_FALSE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_FALSE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_TRUE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.getColor().value(), /*mask_color=*/1);
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::TECH_VIA);
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::JUNCTION);
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_FALSE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.next(), dbWireDecoder::OpCode::POINT);
  EXPECT_TRUE(decoder.getColor().has_value());
  EXPECT_EQ(decoder.getColor().value(), /*mask_color=*/2);
}

// For a wire with two segments connected by a kColinear junction
// with extensions, check if the shape of the second segment is
// correctly computed.
TEST_F(OdbMultiPatternedTest, GetSegmentWithColinearExtension)
{
  dbTech* tech = lib_->getTech();
  dbTechLayer* metal1 = tech->findLayer("met1");
  ASSERT_NE(metal1, nullptr);

  dbNet* net = dbNet::create(block_, "net");
  dbWire* wire = dbWire::create(net);
  dbWireEncoder encoder;
  encoder.begin(wire);

  // Create segment A.
  const int junction_x = 50000;
  const int junction_y = 10000;
  encoder.newPath(metal1, dbWireType::ROUTED);
  encoder.addPoint(0, junction_y);
  const int junction_id = encoder.addPoint(junction_x, junction_y);

  // Create segment B.
  const int extension = 800;
  encoder.newPathExt(junction_id, extension);  // Inserts kColinear junction.
  const int segment_b_length = 500;
  const int segment_b_shape_id
      = encoder.addPoint(junction_x + segment_b_length, junction_y);
  encoder.end();

  dbShape shape;
  wire->getSegment(segment_b_shape_id, shape);

  const int half_width = metal1->getWidth() / 2;
  const odb::Rect expected(junction_x - extension,
                           junction_y - half_width,
                           junction_x + segment_b_length + half_width,
                           junction_y + half_width);

  EXPECT_EQ(shape.getBox(), expected);
}

}  // namespace odb