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

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

#include <unistd.h>

#include <memory>
#include <stdexcept>
#include <vector>

#include "gtest/gtest.h"
#include "odb/db.h"
#include "odb/dbSet.h"
#include "odb/defin.h"
#include "odb/geom.h"
#include "tst/nangate45_fixture.h"
#include "utl/Logger.h"

namespace odb {

using tst::Nangate45Fixture;

TEST_F(Nangate45Fixture, PolygonalFloorplanCreatesBlockagesInNegativeSpace)
{
  // Act
  Polygon area({{0, 0},
                {0, 300000},
                {400000, 300000},
                {400000, 150000},
                {300000, 150000},
                {300000, 0}});

  block_->setDieArea(area);

  // Assert that there is one virtual blockage for this floorplan.
  // There's essentially 1 rectangle cut out of it.
  dbSet<dbBlockage> blockages = block_->getBlockages();
  std::vector<dbBlockage*> virtual_blockages;
  for (dbBlockage* blockage : blockages) {
    if (!blockage->isSystemReserved()) {
      continue;
    }
    virtual_blockages.push_back(blockage);
  }
  EXPECT_EQ(virtual_blockages.size(), 1);
  EXPECT_EQ(virtual_blockages[0]->getBBox()->getDX(), 100000);
  EXPECT_EQ(virtual_blockages[0]->getBBox()->getDY(), 150000);

  // 1 obstruction for each via and metal layer in Nangate 45
  // should be 21 including poly layers.
  dbSet<dbObstruction> obstructions = block_->getObstructions();
  std::vector<dbObstruction*> virtual_obstructions;
  for (dbObstruction* obstruction : obstructions) {
    if (!obstruction->isSystemReserved()) {
      continue;
    }
    virtual_obstructions.push_back(obstruction);
    EXPECT_EQ(obstruction->getBBox()->getDX(), 100000);
    EXPECT_EQ(obstruction->getBBox()->getDY(), 150000);
  }
  EXPECT_EQ(virtual_obstructions.size(), 21);
}

TEST_F(Nangate45Fixture, SettingTheFloorplanTwiceClearsSystemBlockages)
{
  // Act
  Polygon area({{0, 0},
                {0, 300000},
                {400000, 300000},
                {400000, 150000},
                {300000, 150000},
                {300000, 0}});
  block_->setDieArea(area);

  odb::Polygon new_die_area({{0, 0},
                             {0, 300000},
                             {400000, 300000},
                             {400000, 160000},
                             {300000, 160000},
                             {300000, 0}});

  block_->setDieArea(new_die_area);

  // Assert that there is one virtual blockage for this floorplan.
  // There's essentially 1 rectangle cut out of it.
  dbSet<dbBlockage> blockages = block_->getBlockages();
  std::vector<dbBlockage*> virtual_blockages;
  for (dbBlockage* blockage : blockages) {
    if (!blockage->isSystemReserved()) {
      continue;
    }
    virtual_blockages.push_back(blockage);
  }
  EXPECT_EQ(virtual_blockages.size(), 1);
  EXPECT_EQ(virtual_blockages[0]->getBBox()->getDX(), 100000);
  EXPECT_EQ(virtual_blockages[0]->getBBox()->getDY(), 160000);

  // 1 obstruction for each via and metal layer in Nangate 45
  // should be 21 including poly layers.
  dbSet<dbObstruction> obstructions = block_->getObstructions();
  std::vector<dbObstruction*> virtual_obstructions;
  for (dbObstruction* obstruction : obstructions) {
    if (!obstruction->isSystemReserved()) {
      continue;
    }
    virtual_obstructions.push_back(obstruction);
    EXPECT_EQ(obstruction->getBBox()->getDX(), 100000);
    EXPECT_EQ(obstruction->getBBox()->getDY(), 160000);
  }
  EXPECT_EQ(virtual_obstructions.size(), 21);
}

TEST_F(Nangate45Fixture, DeletingSystemBlockagesThrows)
{
  // Arrange
  Polygon area({{0, 0},
                {0, 300000},
                {400000, 300000},
                {400000, 150000},
                {300000, 150000},
                {300000, 0}});

  block_->setDieArea(area);

  // Assert that there is one virtual blockage for this floorplan.
  // There's essentially 1 rectangle cut out of it.
  dbSet<dbBlockage> blockages = block_->getBlockages();
  std::vector<dbBlockage*> virtual_blockages;
  for (dbBlockage* blockage : blockages) {
    if (!blockage->isSystemReserved()) {
      continue;
    }
    virtual_blockages.push_back(blockage);
  }
  EXPECT_EQ(virtual_blockages.size(), 1);

  // Act & Assert
  EXPECT_THROW(
      { dbBlockage::destroy(virtual_blockages[0]); }, std::runtime_error);
}

TEST_F(Nangate45Fixture, DeletingSystemObstructionsThrows)
{
  // Arrange
  Polygon area({{0, 0},
                {0, 300000},
                {400000, 300000},
                {400000, 150000},
                {300000, 150000},
                {300000, 0}});

  block_->setDieArea(area);

  // Assert that there is one virtual blockage for this floorplan.
  // There's essentially 1 rectangle cut out of it.
  dbSet<dbObstruction> obstructions = block_->getObstructions();
  std::vector<dbObstruction*> virtual_obstructions;
  for (dbObstruction* obstruction : obstructions) {
    if (!obstruction->isSystemReserved()) {
      continue;
    }
    virtual_obstructions.push_back(obstruction);
  }
  EXPECT_EQ(virtual_obstructions.size(), 21);

  // Act & Assert
  EXPECT_THROW(
      { dbObstruction::destroy(virtual_obstructions[0]); }, std::runtime_error);
}

}  // namespace odb