################################################################################################
# Copyright 2022 GlobalFoundries PDK Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################################

#===========================================================================================================================
#------------------------------------------- GF 0.18um MCU DRC RULE DECK --------------------------------------------------
#===========================================================================================================================
require 'time'
require "logger"

exec_start_time = Time.now

logger = Logger.new(STDOUT)

logger.formatter = proc do |severity, datetime, progname, msg|
  "#{datetime}: Memory Usage (" + `pmap #{Process.pid} | tail -1`[10,40].strip + ") : #{msg}
"
end

#================================================
#----------------- FILE SETUP -------------------
#================================================

# optional for a batch launch :   klayout -b -r gf_018mcu.drc -rd input=design.gds -rd report=gp180_drc.lyrdb

logger.info("Starting running GF180MCU Klayout DRC runset on %s" % [$input])
logger.info("Ruby Version for klayout: %s" % [RUBY_VERSION])

if $input
    if $topcell
        source($input, $topcell)
    else
        source($input)
    end
end

if $table_name
  table_name = $table_name
else
  table_name = "main"
end


logger.info("Loading database to memory is complete.")

if $report
    logger.info("GF180MCU Klayout DRC runset output at: %s" % [$report])
    report("DRC Run Report at", $report)
else
    logger.info("GF180MCU Klayout DRC runset output at default location." % [File.join(File.dirname(RBA::CellView::active.filename), "gf180_drc.lyrdb")])
    report("DRC Run Report at", File.join(File.dirname(RBA::CellView::active.filename), "gf180_drc.lyrdb"))
end

#================================================
#------------------ SWITCHES --------------------
#================================================
logger.info("Evaluate switches.")

# connectivity rules
if $conn_drc == "true"
  CONNECTIVITY_RULES = $conn_drc
  logger.info("connectivity rules are enabled.")
else
  CONNECTIVITY_RULES = false
  logger.info("connectivity rules are disabled.")
end # connectivity rules

# WEDGE
if $wedge == "false"
  WEDGE = $wedge
else
  WEDGE = "true"
end # WEDGE

logger.info("Wedge enabled  %s" % [WEDGE])

# BALL
if $ball == "false"
  BALL = $ball
else
  BALL = "true"
end # BALL

logger.info("Ball enabled  %s" % [BALL])

# GOLD
if $gold == "false"
  GOLD = $gold
else
  GOLD = "true"
end # GOLD

logger.info("Gold enabled  %s" % [GOLD])

if $mim_option
  MIM_OPTION = $mim_option
else
  MIM_OPTION = "B"
end

logger.info("MIM Option selected %s" % [MIM_OPTION])

# OFFGRID
if $offgrid == "false"
  OFFGRID = false
else
  OFFGRID = true
end # OFFGRID

logger.info("Offgrid enabled  %s" % [OFFGRID])

if $thr
    threads($thr)
    logger.info("Number of threads to use %s" % [$thr])
else
    threads(%x("nproc"))
    logger.info("Number of threads to use #{%x("nproc")}")
end

#=== PRINT DETAILS ===
if $verbose == "true"
  logger.info("Verbose mode: #{$verbose}")
  verbose(true)
else
  verbose(false)
  logger.info("Verbose mode: false")
end

# === TILING MODE ===
if $run_mode == "tiling"
  tiles(500.um)
  tile_borders(10.um)
  logger.info("Tiling  mode is enabled.")

elsif $run_mode == "deep"
  #=== HIER MODE ===
  deep
  logger.info("deep  mode is enabled.")
else
  #=== FLAT MODE ===
  flat
  logger.info("flat  mode is enabled.")
end # run_mode

# METAL_TOP
if $metal_top
  METAL_TOP = $metal_top
else
  METAL_TOP = "9K"
end # METAL_TOP

logger.info("METAL_TOP Selected is %s" % [METAL_TOP])

# METAL_LEVEL
if $metal_level
  METAL_LEVEL = $metal_level
else
  METAL_LEVEL = "5LM"
end # METAL_LEVEL

logger.info("METAL_STACK Selected is %s" % [METAL_LEVEL])

# FEOL
if $feol == "false"
  FEOL = $feol
  logger.info("FEOL is disabled.")
else
  FEOL = "true"
  logger.info("FEOL is enabled.")
end # FEOL

# BEOL
if $beol == "false"
  BEOL = $beol
  logger.info("BEOL is disabled.")
else
  BEOL = "true"
  logger.info("BEOL is enabled.")
end # BEOL

#================================================
#------------- LAYERS DEFINITIONS ---------------
#================================================
polygons_count = 0
logger.info("Read in polygons from layers.")

def get_polygons(l, d)
  if $run_mode == "deep"
    polygons(l, d)
  else
    polygons(l, d).merged
  end
end

comp           = get_polygons(22 , 0 )
count = comp.count()
logger.info("comp has %d polygons" % [count])
polygons_count += count

dnwell         = get_polygons(12 , 0 )
count   = dnwell.count()
logger.info("dnwell has %d polygons" % [count])
polygons_count  += count

nwell          = get_polygons(21 , 0 )
count   = nwell.count()
logger.info("nwell has %d polygons" % [count])
polygons_count  += count

lvpwell        = get_polygons(204, 0 )
count   = lvpwell.count()
logger.info("lvpwell has %d polygons" % [count])
polygons_count  += count

dualgate       = get_polygons(55 , 0 )
count   = dualgate.count()
logger.info("dualgate has %d polygons" % [count])
polygons_count  += count

poly2          = get_polygons(30 , 0 )
count   = poly2.count()
logger.info("poly2 has %d polygons" % [count])
polygons_count  += count

nplus          = get_polygons(32 , 0 )
count   = nplus.count()
logger.info("nplus has %d polygons" % [count])
polygons_count  += count

pplus          = get_polygons(31 , 0 )
count   = pplus.count()
logger.info("pplus has %d polygons" % [count])
polygons_count  += count

sab            = get_polygons(49 , 0 )
count   = sab.count()
logger.info("sab has %d polygons" % [count])
polygons_count  += count

esd            = get_polygons(24 , 0 )
count   = esd.count()
logger.info("esd has %d polygons" % [count])
polygons_count  += count

resistor       = get_polygons(62 , 0 )
count   = resistor.count()
logger.info("resistor has %d polygons" % [count])
polygons_count  += count

fhres          = get_polygons(227, 0 )
count   = fhres.count()
logger.info("fhres has %d polygons" % [count])
polygons_count  += count

fusetop        = get_polygons(75 , 0 )
count   = fusetop.count()
logger.info("fusetop has %d polygons" % [count])
polygons_count  += count

fusewindow_d   = get_polygons(96 , 1 )
count   = fusewindow_d.count()
logger.info("fusewindow_d has %d polygons" % [count])
polygons_count  += count

polyfuse       = get_polygons(220, 0 )
count   = polyfuse.count()
logger.info("polyfuse has %d polygons" % [count])
polygons_count  += count

mvsd           = get_polygons(210, 0 )
count   = mvsd.count()
logger.info("mvsd has %d polygons" % [count])
polygons_count  += count

mvpsd          = get_polygons(11 , 39)
count   = mvpsd.count()
logger.info("mvpsd has %d polygons" % [count])
polygons_count  += count

nat            = get_polygons(5  , 0 )
count   = nat.count()
logger.info("nat has %d polygons" % [count])
polygons_count  += count

comp_dummy     = get_polygons(22 , 4 )
count   = comp_dummy.count()
logger.info("comp_dummy has %d polygons" % [count])
polygons_count  += count

poly2_dummy    = get_polygons(30 , 4 )
count   = poly2_dummy.count()
logger.info("poly2_dummy has %d polygons" % [count])
polygons_count  += count

schottky_diode = get_polygons(241, 0 )
count   = schottky_diode.count()
logger.info("schottky_diode has %d polygons" % [count])
polygons_count  += count

zener          = get_polygons(178, 0 )
count   = zener.count()
logger.info("zener has %d polygons" % [count])
polygons_count  += count

res_mk         = get_polygons(110, 5 )
count   = res_mk.count()
logger.info("res_mk has %d polygons" % [count])
polygons_count  += count

opc_drc        = get_polygons(124, 5 )
count   = opc_drc.count()
logger.info("opc_drc has %d polygons" % [count])
polygons_count  += count

ndmy           = get_polygons(111, 5 )
count   = ndmy.count()
logger.info("ndmy has %d polygons" % [count])
polygons_count  += count

pmndmy         = get_polygons(152, 5 )
count   = pmndmy.count()
logger.info("pmndmy has %d polygons" % [count])
polygons_count  += count

v5_xtor        = get_polygons(112, 1 )
count   = v5_xtor.count()
logger.info("v5_xtor has %d polygons" % [count])
polygons_count  += count

cap_mk         = get_polygons(117, 5 )
count   = cap_mk.count()
logger.info("cap_mk has %d polygons" % [count])
polygons_count  += count

mos_cap_mk     = get_polygons(166, 5 )
count   = mos_cap_mk.count()
logger.info("mos_cap_mk has %d polygons" % [count])
polygons_count  += count

ind_mk         = get_polygons(151, 5 )
count   = ind_mk.count()
logger.info("ind_mk has %d polygons" % [count])
polygons_count  += count

diode_mk       = get_polygons(115, 5 )
count   = diode_mk.count()
logger.info("diode_mk has %d polygons" % [count])
polygons_count  += count

drc_bjt        = get_polygons(127, 5 )
count   = drc_bjt.count()
logger.info("drc_bjt has %d polygons" % [count])
polygons_count  += count

lvs_bjt        = get_polygons(118, 5 )
count   = lvs_bjt.count()
logger.info("lvs_bjt has %d polygons" % [count])
polygons_count  += count

mim_l_mk       = get_polygons(117, 10)
count   = mim_l_mk.count()
logger.info("mim_l_mk has %d polygons" % [count])
polygons_count  += count

latchup_mk     = get_polygons(137, 5 )
count   = latchup_mk.count()
logger.info("latchup_mk has %d polygons" % [count])
polygons_count  += count

guard_ring_mk  = get_polygons(167, 5 )
count   = guard_ring_mk.count()
logger.info("guard_ring_mk has %d polygons" % [count])
polygons_count  += count

otp_mk         = get_polygons(173, 5 )
count   = otp_mk.count()
logger.info("otp_mk has %d polygons" % [count])
polygons_count  += count

mtpmark        = get_polygons(122, 5 )
count   = mtpmark.count()
logger.info("mtpmark has %d polygons" % [count])
polygons_count  += count

neo_ee_mk      = get_polygons(88 , 17)
count   = neo_ee_mk.count()
logger.info("neo_ee_mk has %d polygons" % [count])
polygons_count  += count

sramcore       = get_polygons(108, 5 )
count   = sramcore.count()
logger.info("sramcore has %d polygons" % [count])
polygons_count  += count

lvs_rf         = get_polygons(100, 5 )
count   = lvs_rf.count()
logger.info("lvs_rf has %d polygons" % [count])
polygons_count  += count

lvs_drain      = get_polygons(100, 7 )
count   = lvs_drain.count()
logger.info("lvs_drain has %d polygons" % [count])
polygons_count  += count

ind_mk         = get_polygons(151, 5 )
count   = ind_mk.count()
logger.info("ind_mk has %d polygons" % [count])
polygons_count  += count

hvpolyrs       = get_polygons(123, 5 )
count   = hvpolyrs.count()
logger.info("hvpolyrs has %d polygons" % [count])
polygons_count  += count

lvs_io         = get_polygons(119, 5 )
count   = lvs_io.count()
logger.info("lvs_io has %d polygons" % [count])
polygons_count  += count

probe_mk       = get_polygons(13 , 17)
count   = probe_mk.count()
logger.info("probe_mk has %d polygons" % [count])
polygons_count  += count

esd_mk         = get_polygons(24 , 5 )
count   = esd_mk.count()
logger.info("esd_mk has %d polygons" % [count])
polygons_count  += count

lvs_source     = get_polygons(100, 8 )
count   = lvs_source.count()
logger.info("lvs_source has %d polygons" % [count])
polygons_count  += count

well_diode_mk  = get_polygons(153, 51)
count   = well_diode_mk.count()
logger.info("well_diode_mk has %d polygons" % [count])
polygons_count  += count

ldmos_xtor     = get_polygons(226, 0 )
count   = ldmos_xtor.count()
logger.info("ldmos_xtor has %d polygons" % [count])
polygons_count  += count

plfuse         = get_polygons(125, 5 )
count   = plfuse.count()
logger.info("plfuse has %d polygons" % [count])
polygons_count  += count

efuse_mk       = get_polygons(80 , 5 )
count   = efuse_mk.count()
logger.info("efuse_mk has %d polygons" % [count])
polygons_count  += count

mcell_feol_mk  = get_polygons(11 , 17)
count   = mcell_feol_mk.count()
logger.info("mcell_feol_mk has %d polygons" % [count])
polygons_count  += count

ymtp_mk        = get_polygons(86 , 17)
count   = ymtp_mk.count()
logger.info("ymtp_mk has %d polygons" % [count])
polygons_count  += count

dev_wf_mk      = get_polygons(128, 17)
count   = dev_wf_mk.count()
logger.info("dev_wf_mk has %d polygons" % [count])
polygons_count  += count

comp_label     = get_polygons(22 , 10)
count   = comp_label.count()
logger.info("comp_label has %d polygons" % [count])
polygons_count  += count

poly2_label    = get_polygons(30 , 10)
count   = poly2_label.count()
logger.info("poly2_label has %d polygons" % [count])
polygons_count  += count

mdiode         = get_polygons(116, 5 )
count   = mdiode.count()
logger.info("mdiode has %d polygons" % [count])
polygons_count  += count

contact        = get_polygons(33 , 0 )
count   = contact.count()
logger.info("contact has %d polygons" % [count])
polygons_count  += count

metal1_drawn   = get_polygons(34 , 0 )
count   = metal1_drawn.count()
logger.info("metal1_drawn has %d polygons" % [count])
polygons_count  += count

metal1_dummy   = get_polygons(34 , 4 )
count   = metal1_dummy.count()
logger.info("metal1_dummy has %d polygons" % [count])
polygons_count  += count

metal1         = metal1_drawn + metal1_dummy

metal1_label   = get_polygons(34 , 10)
count   = metal1_label.count()
logger.info("metal1_label has %d polygons" % [count])
polygons_count  += count

metal1_slot    = get_polygons(34 , 3 )
count   = metal1_slot.count()
logger.info("metal1_slot has %d polygons" % [count])
polygons_count  += count

metal1_blk     = get_polygons(34 , 5 )
count   = metal1_blk.count()
logger.info("metal1_blk has %d polygons" % [count])
polygons_count  += count

via1           = get_polygons(35 , 0 )
count   = via1.count()
logger.info("via1 has %d polygons" % [count])
polygons_count  += count


if METAL_LEVEL == "2LM"
  metal2_drawn  = get_polygons(36 , 0 )
  count   = metal2_drawn.count()
  logger.info("metal2_drawn has %d polygons" % [count])
  polygons_count  += count

  metal2_dummy  = get_polygons(36 , 4 )
  count   = metal2_dummy.count()
  logger.info("metal2_dummy has %d polygons" % [count])
  polygons_count  += count

  metal2        = metal2_drawn + metal2_drawn

  metal2_label  = get_polygons(36 , 10)
  count   = metal2_label.count()
  logger.info("metal2_label has %d polygons" % [count])
  polygons_count  += count

  metal2_slot   = get_polygons(36 , 3 )
  count   = metal2_slot.count()
  logger.info("metal2_slot has %d polygons" % [count])
  polygons_count  += count

  metal2_blk    = get_polygons(36 , 5 )
  count   = metal2_blk.count()
  logger.info("metal2_blk has %d polygons" % [count])
  polygons_count  += count
  
  top_via       = via1
  topmin1_via   = contact
  top_metal     = metal2
  topmin1_metal = metal1
  
else
  metal2_drawn   = get_polygons(36 , 0 )
  count   = metal2_drawn.count()
  logger.info("metal2_drawn has %d polygons" % [count])
  polygons_count  += count

  metal2_dummy   = get_polygons(36 , 4 )
  count   = metal2_dummy.count()
  logger.info("metal2_dummy has %d polygons" % [count])
  polygons_count  += count

  metal2         = metal2_drawn + metal2_dummy

  metal2_label   = get_polygons(36 , 10)
  count   = metal2_label.count()
  logger.info("metal2_label has %d polygons" % [count])
  polygons_count  += count

  metal2_slot    = get_polygons(36 , 3 )
  count   = metal2_slot.count()
  logger.info("metal2_slot has %d polygons" % [count])
  polygons_count  += count

  metal2_blk     = get_polygons(36 , 5 )
  count   = metal2_blk.count()
  logger.info("metal2_blk has %d polygons" % [count])
  polygons_count  += count
  
  via2           = get_polygons(38 , 0 )
  count   = via2.count()
  logger.info("via2 has %d polygons" % [count])
  polygons_count  += count
  
  if METAL_LEVEL == "3LM"
    metal3_drawn  = get_polygons(42 , 0 )
    count   = metal3_drawn.count()
    logger.info("metal3_drawn has %d polygons" % [count])
    polygons_count  += count

    metal3_dummy  = get_polygons(42 , 4 )
    count   = metal3_dummy.count()
    logger.info("metal3_dummy has %d polygons" % [count])
    polygons_count  += count

    metal3        = metal3_drawn + metal3_dummy

    metal3_label  = get_polygons(42 , 10)
    count   = metal3_label.count()
    logger.info("metal3_label has %d polygons" % [count])
    polygons_count  += count
    
    metal3_slot   = get_polygons(42 , 3 )
    count   = metal3_slot.count()
    logger.info("metal3_slot has %d polygons" % [count])
    polygons_count  += count

    metal3_blk    = get_polygons(42 , 5 )
    count   = metal3_blk.count()
    logger.info("metal3_blk has %d polygons" % [count])
    polygons_count  += count
    
    top_via       = via2
    topmin1_via   = via1
    top_metal     = metal3
    topmin1_metal = metal2
  else
    metal3_drawn  = get_polygons(42 , 0 )
    count   = metal3_drawn.count()
    logger.info("metal3_drawn has %d polygons" % [count])
    polygons_count  += count

    metal3_dummy  = get_polygons(42 , 4 )
    count   = metal3_dummy.count()
    logger.info("metal3_dummy has %d polygons" % [count])
    polygons_count  += count

    metal3        = metal3_drawn + metal3_dummy

    metal3_label  = get_polygons(42 , 10)
    count   = metal3_label.count()
    logger.info("metal3_label has %d polygons" % [count])
    polygons_count  += count

    metal3_slot   = get_polygons(42 , 3 )
    count   = metal3_slot.count()
    logger.info("metal3_slot has %d polygons" % [count])
    polygons_count  += count

    metal3_blk    = get_polygons(42 , 5 )
    count   = metal3_blk.count()
    logger.info("metal3_blk has %d polygons" % [count])
    polygons_count  += count

    via3           = get_polygons(40 , 0 )

    if METAL_LEVEL == "4LM"
      metal4_drawn  = get_polygons(46 , 0 )
      count   = metal4_drawn.count()
      logger.info("metal4_drawn has %d polygons" % [count])
      polygons_count  += count

      metal4_dummy  = get_polygons(46 , 4 )
      count   = metal4_dummy.count()
      logger.info("metal4_dummy has %d polygons" % [count])
      polygons_count  += count

      metal4        = metal4_drawn + metal4_dummy
      
      metal4_label  = get_polygons(46 , 10)
      count   = metal4_label.count()
      logger.info("metal4_label has %d polygons" % [count])
      polygons_count  += count
      
      metal4_slot   = get_polygons(46 , 3 )
      count   = metal4_slot.count()
      logger.info("metal4_slot has %d polygons" % [count])
      polygons_count  += count

      metal4_blk    = get_polygons(46 , 5 )
      count   = metal4_blk.count()
      logger.info("metal4_blk has %d polygons" % [count])
      polygons_count  += count
      
      top_via       = via3
      topmin1_via   = via2
      top_metal     = metal4
      topmin1_metal = metal3
    else
      metal4_drawn  = get_polygons(46 , 0 )
      count   = metal4_drawn.count()
      logger.info("metal4_drawn has %d polygons" % [count])
      polygons_count  += count

      metal4_dummy  = get_polygons(46 , 4 )
      count   = metal4_dummy.count()
      logger.info("metal4_dummy has %d polygons" % [count])
      polygons_count  += count

      metal4        = metal4_drawn + metal4_dummy

      metal4_label  = get_polygons(46 , 10)
      count   = metal4_label.count()
      logger.info("metal4_label has %d polygons" % [count])
      polygons_count  += count

      metal4_slot   = get_polygons(46 , 3 )
      count   = metal4_slot.count()
      logger.info("metal4_slot has %d polygons" % [count])
      polygons_count  += count

      metal4_blk    = get_polygons(46 , 5 )
      count   = metal4_blk.count()
      logger.info("metal4_blk has %d polygons" % [count])
      polygons_count  += count

      via4          = get_polygons(41 , 0 )
      count   = via4.count()
      logger.info("via4 has %d polygons" % [count])
      polygons_count  += count

      if METAL_LEVEL == "5LM"
        metal5_drawn  = get_polygons(81 , 0 )
        count   = metal5_drawn.count()
        logger.info("metal5_drawn has %d polygons" % [count])
        polygons_count  += count

        metal5_dummy  = get_polygons(81 , 4 )
        count   = metal5_dummy.count()
        logger.info("metal5_dummy has %d polygons" % [count])
        polygons_count  += count

        metal5        = metal5_drawn + metal5_dummy

        metal5_label  = get_polygons(81 , 10)
        count   = metal5_label.count()
        logger.info("metal5_label has %d polygons" % [count])
        polygons_count  += count
      
        metal5_slot   = get_polygons(81 , 3 )
        count   = metal5_slot.count()
        logger.info("metal5_slot has %d polygons" % [count])
        polygons_count  += count

        metal5_blk    = get_polygons(81 , 5 )
        count   = metal5_blk.count()
        logger.info("metal5_blk has %d polygons" % [count])
        polygons_count  += count

        top_via       = via4
        topmin1_via   = via3
        top_metal     = metal5
        topmin1_metal = metal4
      else 
        ## 6LM
        metal5_drawn   = get_polygons(81 , 0 )
        count   = metal5_drawn.count()
        logger.info("metal5_drawn has %d polygons" % [count])
        polygons_count  += count

        metal5_dummy   = get_polygons(81 , 4 )
        count   = metal5_dummy.count()
        logger.info("metal5_dummy has %d polygons" % [count])
        polygons_count  += count

        metal5         = metal5_drawn + metal5_dummy

        metal5_label   = get_polygons(81 , 10)
        count   = metal5_label.count()
        logger.info("metal5_label has %d polygons" % [count])
        polygons_count  += count

        metal5_slot    = get_polygons(81 , 3 )
        count   = metal5_slot.count()
        logger.info("metal5_slot has %d polygons" % [count])
        polygons_count  += count

        metal5_blk     = get_polygons(81 , 5 )
        count   = metal5_blk.count()
        logger.info("metal5_blk has %d polygons" % [count])
        polygons_count  += count

        via5           = get_polygons(82 , 0 )
        count   = via5.count()
        logger.info("via5 has %d polygons" % [count])
        polygons_count  += count


        metaltop_drawn = get_polygons(53 , 0 )
        count   = metaltop_drawn.count()
        logger.info("metaltop_drawn has %d polygons" % [count])
        polygons_count  += count

        metaltop_dummy = get_polygons(53 , 4 )
        count   = metaltop_dummy.count()
        logger.info("metaltop_dummy has %d polygons" % [count])
        polygons_count  += count

        metaltop       = metaltop_drawn + metaltop_dummy

        metaltop_label = get_polygons(53 , 10)
        count   = metaltop_label.count()
        logger.info("metaltop_label has %d polygons" % [count])
        polygons_count  += count

        metaltop_slot  = get_polygons(53 , 3 )
        count   = metaltop_slot.count()
        logger.info("metaltop_slot has %d polygons" % [count])
        polygons_count  += count

        metalt_blk     = get_polygons(53 , 5 )
        count   = metalt_blk.count()
        logger.info("metalt_blk has %d polygons" % [count])
        polygons_count  += count

        top_via       = via5
        topmin1_via   = via4
        top_metal     = metaltop
        topmin1_metal = metal5
      end
    end
  end
end

pad            = get_polygons(37 , 0 )
count   = pad.count()
logger.info("pad has %d polygons" % [count])
polygons_count  += count

ubmpperi       = get_polygons(183, 0 )
count   = ubmpperi.count()
logger.info("ubmpperi has %d polygons" % [count])
polygons_count  += count

ubmparray      = get_polygons(184, 0 )
count   = ubmparray.count()
logger.info("ubmparray has %d polygons" % [count])
polygons_count  += count

ubmeplate      = get_polygons(185, 0 )
count   = ubmeplate.count()
logger.info("ubmeplate has %d polygons" % [count])
polygons_count  += count

metal1_res     = get_polygons(110, 11)
count   = metal1_res.count()
logger.info("metal1_res has %d polygons" % [count])
polygons_count  += count

metal2_res     = get_polygons(110, 12)
count   = metal2_res.count()
logger.info("metal2_res has %d polygons" % [count])
polygons_count  += count

metal3_res     = get_polygons(110, 13)
count   = metal3_res.count()
logger.info("metal3_res has %d polygons" % [count])
polygons_count  += count

metal4_res     = get_polygons(110, 14)
count   = metal4_res.count()
logger.info("metal4_res has %d polygons" % [count])
polygons_count  += count

metal5_res     = get_polygons(110, 15)
count   = metal5_res.count()
logger.info("metal5_res has %d polygons" % [count])
polygons_count  += count

metal6_res     = get_polygons(110, 16)
count   = metal6_res.count()
logger.info("metal6_res has %d polygons" % [count])
polygons_count  += count

pr_bndry       = get_polygons(0  , 0 )
count   = pr_bndry.count()
logger.info("pr_bndry has %d polygons" % [count])
polygons_count  += count

border         = get_polygons(63 , 0 )
count   = border.count()
logger.info("border has %d polygons" % [count])
polygons_count  += count
logger.info("Total no. of polygons in the design is #{polygons_count}")

logger.info("Starting deriving base layers.")
#=====================================================
#------------- BASE LAYERS DERIVATIONS ---------------
#=====================================================

ncomp      =  comp      & nplus
pcomp      =  comp      & pplus
tgate      =  poly2     & comp
ngate      =  nplus     & tgate
pgate      =  pplus     & tgate
natcompsd	 = (nat       & comp.interacting(poly2)) - tgate

nom_gate = tgate.not(dualgate)
thick_gate = tgate.and(dualgate)

ngate_56V = ngate.and(dualgate)
pgate_56V = pgate.and(dualgate)

ngate_5V = ngate_56V.and(v5_xtor)
pgate_5V = pgate_56V.and(v5_xtor)

ngate_6V = ngate_56V.not(v5_xtor)
pgate_6V = pgate_56V.not(v5_xtor)

lvpwell_dn = lvpwell.interacting(dnwell)
lvpwell_out = lvpwell.not_interacting(dnwell)


#================================================
#------------- LAYERS CONNECTIONS ---------------
#================================================

if CONNECTIVITY_RULES

  logger.info("Construct connectivity for the design.")

  connect(dnwell,  ncomp)
  connect(ncomp,  contact)
  connect(pcomp,  contact)

  connect(lvpwell_out,  pcomp)
  connect(lvpwell_dn, pcomp)

  connect(nwell,  ncomp)
  connect(natcompsd,  contact)
  connect(mvsd,  ncomp)
  connect(mvpsd,  pcomp)
  connect(contact,  metal1)
  connect(metal1,  via1)
  connect(via1,    metal2)
  if METAL_LEVEL != "2LM"
    connect(metal2,  via2)
    connect(via2,    metal3)

    if METAL_LEVEL != "3LM"
      connect(metal3,  via3)
      connect(via3,    metal4)
      
      if METAL_LEVEL != "4LM"
        connect(metal4,  via4)
        connect(via4,    metal5)

        if METAL_LEVEL != "5LM"
          connect(metal5,  via5)
          connect(via5,    metaltop)
        end
      end
    end
  end

end #CONNECTIVITY_RULES

#================================================
#------------ PRE-DEFINED FUNCTIONS -------------
#================================================

def conn_space(layer,conn_val,not_conn_val, mode)
  if conn_val > not_conn_val
    raise "ERROR : Wrong connectivity implementation"
  end
  connected_output = layer.space(conn_val.um, mode).polygons(0.001)
  unconnected_errors_unfiltered = layer.space(not_conn_val.um, mode)
  singularity_errors = layer.space(0.001.um)
  # Filter out the errors arising from the same net
  unconnected_errors = DRC::DRCLayer::new(self, RBA::EdgePairs::new)
  unconnected_errors_unfiltered.data.each do |ep|
    net1 = l2n_data.probe_net(layer.data, ep.first.p1)
    net2 = l2n_data.probe_net(layer.data, ep.second.p1)
    if !net1 || !net2
      puts "Should not happen ..."
    elsif net1.circuit != net2.circuit || net1.cluster_id != net2.cluster_id
      # unconnected
      unconnected_errors.data.insert(ep)
    end
  end
  unconnected_output = unconnected_errors.polygons.or(singularity_errors.polygons(0.001))
  return connected_output, unconnected_output
end

def conn_separation(layer1, layer2, conn_val,not_conn_val, mode)
  if conn_val > not_conn_val
    raise "ERROR : Wrong connectivity implementation"
  end
  connected_output = layer1.separation(layer2, conn_val.um, mode).polygons(0.001)
  unconnected_errors_unfiltered = layer1.separation(layer2, not_conn_val.um, mode)
  # Filter out the errors arising from the same net
  unconnected_errors = DRC::DRCLayer::new(self, RBA::EdgePairs::new)
  unconnected_errors_unfiltered.data.each do |ep|
    net1 = l2n_data.probe_net(layer1.data, ep.first.p1)
    net2 = l2n_data.probe_net(layer2.data, ep.second.p1)
    if !net1 || !net2
      puts "Should not happen ..."
    elsif net1.circuit != net2.circuit || net1.cluster_id != net2.cluster_id
      # unconnected
      unconnected_errors.data.insert(ep)
    end
  end
  unconnected_output = unconnected_errors.polygons(0.001)
  return connected_output, unconnected_output
end

# === IMPLICIT EXTRACTION ===
if CONNECTIVITY_RULES
  logger.info("Connectivity rules enabled, Netlist object will be generated.")
  netlist
end #CONNECTIVITY_RULES

# === LAYOUT EXTENT ===
CHIP = extent.sized(0.0)
logger.info("Total area of the design is #{CHIP.area()} um^2.")

#================================================
#----------------- MAIN RUNSET ------------------
#================================================

logger.info("Starting GF180MCU DRC rules.")
if FEOL
  logger.info("Running all FEOL rules")
end #FEOL

if BEOL
  logger.info("Running all BEOL rules")
end #BEOL


################################################################################################
# Copyright 2022 GlobalFoundries PDK Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################################

if FEOL
    #================================================
    #---------------------NPLUS----------------------
    #================================================

    # Rule NP.1: min. nplus width is 0.4µm
    logger.info("Executing rule NP.1")
    np1_l1  = nplus.width(0.4.um, euclidian).polygons(0.001)
    np1_l1.output("NP.1", "NP.1 : min. nplus width : 0.4µm")
    np1_l1.forget

    # Rule NP.2: min. nplus spacing is 0.4µm
    logger.info("Executing rule NP.2")
    np2_l1  = nplus.space(0.4.um, euclidian).polygons(0.001)
    np2_l1.output("NP.2", "NP.2 : min. nplus spacing : 0.4µm")
    np2_l1.forget

    # Rule NP.3a: Space to PCOMP for PCOMP: (1) Inside Nwell (2) Outside LVPWELL but inside DNWELL. is 0.16µm
    logger.info("Executing rule NP.3a")
    np3a_l1  = nplus.separation((pcomp.inside(nwell)).or(pcomp.outside(lvpwell).inside(dnwell)), 0.16.um, euclidian).polygons(0.001)
    np3a_l1.output("NP.3a", "NP.3a : Space to PCOMP for PCOMP: (1) Inside Nwell (2) Outside LVPWELL but inside DNWELL. : 0.16µm")
    np3a_l1.forget

    np_3bi_extend = lvpwell.inside(dnwell).sized(-0.429.um)
    np_3bi = pcomp.edges.and(lvpwell.inside(dnwell).not(np_3bi_extend))
    # Rule NP.3bi: Space to PCOMP: For Inside DNWELL, inside LVPWELL:(i) For PCOMP overlap by LVPWELL < 0.43um. is 0.16µm
    logger.info("Executing rule NP.3bi")
    np3bi_l1  = nplus.not_outside(lvpwell).inside(dnwell).edges.separation(np_3bi, 0.16.um, euclidian).polygons(0.001)
    np3bi_l1.output("NP.3bi", "NP.3bi : Space to PCOMP: For Inside DNWELL, inside LVPWELL:(i) For PCOMP overlap by LVPWELL < 0.43um. : 0.16µm")
    np3bi_l1.forget

    np_3bi_extend.forget

    np_3bi.forget

    np_3bii_extend = lvpwell.inside(dnwell).sized(-0.429.um)
    np_3bii = pcomp.edges.and(np_3bii_extend)
    # Rule NP.3bii: Space to PCOMP: For Inside DNWELL, inside LVPWELL:(ii) For PCOMP overlap by LVPWELL >= 0.43um. is 0.08µm
    logger.info("Executing rule NP.3bii")
    np3bii_l1  = nplus.not_outside(lvpwell).inside(dnwell).edges.separation(np_3bii, 0.08.um, euclidian).polygons(0.001)
    np3bii_l1.output("NP.3bii", "NP.3bii : Space to PCOMP: For Inside DNWELL, inside LVPWELL:(ii) For PCOMP overlap by LVPWELL >= 0.43um. : 0.08µm")
    np3bii_l1.forget

    np_3bii_extend.forget

    np_3bii.forget

    np_3ci = pcomp.edges.and(nwell.outside(dnwell).sized(0.429.um))
    # Rule NP.3ci: Space to PCOMP: For Outside DNWELL:(i) For PCOMP space to Nwell < 0.43um. is 0.16µm
    logger.info("Executing rule NP.3ci")
    np3ci_l1 = nplus.outside(dnwell).edges.separation(np_3ci, 0.16.um, euclidian).polygons
    np3ci_l1.output("NP.3ci", "NP.3ci : Space to PCOMP: For Outside DNWELL:(i) For PCOMP space to Nwell < 0.43um. : 0.16µm")
    np3ci_l1.forget

    np_3ci.forget

    np_3cii = pcomp.edges.not(nwell.outside(dnwell).sized(0.429.um))
    # Rule NP.3cii: Space to PCOMP: For Outside DNWELL:(ii) For PCOMP space to Nwell >= 0.43um. is 0.08µm
    logger.info("Executing rule NP.3cii")
    np3cii_l1 = nplus.outside(dnwell).edges.separation(np_3cii, 0.08.um, euclidian).polygons
    np3cii_l1.output("NP.3cii", "NP.3cii : Space to PCOMP: For Outside DNWELL:(ii) For PCOMP space to Nwell >= 0.43um. : 0.08µm")
    np3cii_l1.forget

    np_3cii.forget

    # Rule NP.3d: Min/max space to a butted PCOMP.
    logger.info("Executing rule NP.3d")
    np3d_l1 = nplus.not_outside(pcomp)
    np3d_l1.output("NP.3d", "NP.3d : Min/max space to a butted PCOMP.")
    np3d_l1.forget

    # Rule NP.3e: Space to related PCOMP edge adjacent to a butting edge.
    logger.info("Executing rule NP.3e")
    np3e_l1 = nplus.not_outside(pcomp)
    np3e_l1.output("NP.3e", "NP.3e : Space to related PCOMP edge adjacent to a butting edge.")
    np3e_l1.forget

    # Rule NP.4a: Space to related P-channel gate at a butting edge parallel to gate. is 0.32µm
    logger.info("Executing rule NP.4a")
    np4a_l1 = nplus.edges.and(pcomp.edges).separation(pgate.edges, 0.32.um, projection).polygons(0.001)
    np4a_l1.output("NP.4a", "NP.4a : Space to related P-channel gate at a butting edge parallel to gate. : 0.32µm")
    np4a_l1.forget

    np_4b_poly = poly2.edges.interacting(pgate.edges.not(pcomp.edges)).centers(0, 0.99).and(pgate.sized(0.32.um))
    # Rule NP.4b: Within 0.32um of channel, space to P-channel gate extension perpendicular to the direction of Poly2.
    logger.info("Executing rule NP.4b")
    np4b_l1 = nplus.interacting(nplus.edges.separation(np_4b_poly, 0.22.um, projection).polygons(0.001))
    np4b_l1.output("NP.4b", "NP.4b : Within 0.32um of channel, space to P-channel gate extension perpendicular to the direction of Poly2.")
    np4b_l1.forget

    np_4b_poly.forget

    # Rule NP.5a: Overlap of N-channel gate. is 0.23µm
    logger.info("Executing rule NP.5a")
    np5a_l1 = nplus.enclosing(ngate, 0.23.um, euclidian).polygons(0.001)
    np5a_l2 = ngate.not_outside(nplus).not(nplus)
    np5a_l  = np5a_l1.or(np5a_l2)
    np5a_l.output("NP.5a", "NP.5a : Overlap of N-channel gate. : 0.23µm")
    np5a_l1.forget
    np5a_l2.forget
    np5a_l.forget

    # Rule NP.5b: Extension beyond COMP for the COMP (1) inside LVPWELL (2) outside Nwell and DNWELL. is 0.16µm
    logger.info("Executing rule NP.5b")
    np5b_l1 = nplus.not_outside(lvpwell).or(nplus.outside(nwell).outside(dnwell)).edges.not(pplus).enclosing(comp.edges, 0.16.um, euclidian).polygons(0.001)
    np5b_l1.output("NP.5b", "NP.5b : Extension beyond COMP for the COMP (1) inside LVPWELL (2) outside Nwell and DNWELL. : 0.16µm")
    np5b_l1.forget

    np_5ci_background = nplus.not_inside(lvpwell).inside(dnwell).edges
    np_5ci_foreground = ncomp.not_inside(lvpwell).inside(dnwell).edges.not(pplus.edges).and(lvpwell.inside(dnwell).sized(0.429.um))
    # Rule NP.5ci: Extension beyond COMP: For Inside DNWELL: (i)For Nplus < 0.43um from LVPWELL edge for Nwell or DNWELL tap inside DNWELL. is 0.16µm
    logger.info("Executing rule NP.5ci")
    np5ci_l1 = np_5ci_background.enclosing(np_5ci_foreground, 0.16.um, projection).polygons(0.001)
    np5ci_l1.output("NP.5ci", "NP.5ci : Extension beyond COMP: For Inside DNWELL: (i)For Nplus < 0.43um from LVPWELL edge for Nwell or DNWELL tap inside DNWELL. : 0.16µm")
    np5ci_l1.forget

    np_5ci_background.forget

    np_5ci_foreground.forget

    np_5cii_background = nplus.not_inside(lvpwell).inside(dnwell).edges
    np_5cii_foreground = ncomp.not_inside(lvpwell).inside(dnwell).edges.not(pplus.edges).not(lvpwell.inside(dnwell).sized(0.429.um))
    # Rule NP.5cii: Extension beyond COMP: For Inside DNWELL: (ii) For Nplus >= 0.43um from LVPWELL edge for Nwell or DNWELL tap inside DNWELL. is 0.02µm
    logger.info("Executing rule NP.5cii")
    np5cii_l1 = np_5cii_background.enclosing(np_5cii_foreground, 0.02.um, projection).polygons(0.001)
    np5cii_l1.output("NP.5cii", "NP.5cii : Extension beyond COMP: For Inside DNWELL: (ii) For Nplus >= 0.43um from LVPWELL edge for Nwell or DNWELL tap inside DNWELL. : 0.02µm")
    np5cii_l1.forget

    np_5cii_background.forget

    np_5cii_foreground.forget

    np_5di_background = nplus.not_outside(nwell).outside(dnwell).edges
    np_5di_extend     = nwell.outside(dnwell).not(nwell.outside(dnwell).sized(-0.429.um))
    np_5di_foreground = ncomp.not_outside(nwell).outside(dnwell).edges.not(pplus.edges).and(np_5di_extend)
    # Rule NP.5di: Extension beyond COMP: For Outside DNWELL, inside Nwell: (i) For Nwell overlap of Nplus < 0.43um. is 0.16µm
    logger.info("Executing rule NP.5di")
    np5di_l1 = np_5di_background.enclosing(np_5di_foreground, 0.16.um, projection).polygons(0.001)
    np5di_l1.output("NP.5di", "NP.5di : Extension beyond COMP: For Outside DNWELL, inside Nwell: (i) For Nwell overlap of Nplus < 0.43um. : 0.16µm")
    np5di_l1.forget

    np_5di_background.forget

    np_5di_extend.forget

    np_5di_foreground.forget

    np_5dii_background = nplus.not_outside(nwell).outside(dnwell).edges.not(pplus.edges)
    np_5dii_extend     = nwell.outside(dnwell).sized(-0.429.um)
    np_5dii_foreground = ncomp.not_outside(nwell).outside(dnwell).edges.not(pplus.edges).and(np_5dii_extend)
    # Rule NP.5dii: Extension beyond COMP: For Outside DNWELL, inside Nwell: (ii) For Nwell overlap of Nplus >= 0.43um. is 0.02µm
    logger.info("Executing rule NP.5dii")
    np5dii_l1 = np_5dii_background.enclosing(np_5dii_foreground, 0.02.um, euclidian).polygons(0.001)
    np5dii_l1.output("NP.5dii", "NP.5dii : Extension beyond COMP: For Outside DNWELL, inside Nwell: (ii) For Nwell overlap of Nplus >= 0.43um. : 0.02µm")
    np5dii_l1.forget

    np_5dii_background.forget

    np_5dii_extend.forget

    np_5dii_foreground.forget

    # Rule NP.6: Overlap with NCOMP butted to PCOMP. is 0.22µm
    logger.info("Executing rule NP.6")
    np6_l1 = comp.interacting(nplus).enclosing(pcomp.interacting(nplus), 0.22.um, projection).polygons
    np6_l1.output("NP.6", "NP.6 : Overlap with NCOMP butted to PCOMP. : 0.22µm")
    np6_l1.forget

    # Rule NP.7: Space to unrelated unsalicided Poly2. is 0.18µm
    logger.info("Executing rule NP.7")
    np7_l1  = nplus.separation(poly2.and(sab), 0.18.um, euclidian).polygons(0.001)
    np7_l1.output("NP.7", "NP.7 : Space to unrelated unsalicided Poly2. : 0.18µm")
    np7_l1.forget

    # Rule NP.8a: Minimum Nplus area (um2). is 0.35µm²
    logger.info("Executing rule NP.8a")
    np8a_l1  = nplus.with_area(nil, 0.35.um)
    np8a_l1.output("NP.8a", "NP.8a : Minimum Nplus area (um2). : 0.35µm²")
    np8a_l1.forget

    # Rule NP.8b: Minimum area enclosed by Nplus (um2). is 0.35µm²
    logger.info("Executing rule NP.8b")
    np8b_l1  = nplus.holes.with_area(nil, 0.35.um)
    np8b_l1.output("NP.8b", "NP.8b : Minimum area enclosed by Nplus (um2). : 0.35µm²")
    np8b_l1.forget

    # Rule NP.9: Overlap of unsalicided Poly2. is 0.18µm
    logger.info("Executing rule NP.9")
    np9_l1 = nplus.enclosing(poly2.and(sab), 0.18.um, euclidian).polygons(0.001)
    np9_l2 = poly2.and(sab).not_outside(nplus).not(nplus)
    np9_l  = np9_l1.or(np9_l2)
    np9_l.output("NP.9", "NP.9 : Overlap of unsalicided Poly2. : 0.18µm")
    np9_l1.forget
    np9_l2.forget
    np9_l.forget

    # Rule NP.10: Overlap of unsalicided COMP. is 0.18µm
    logger.info("Executing rule NP.10")
    np10_l1 = nplus.enclosing(comp.and(sab), 0.18.um, euclidian).polygons(0.001)
    np10_l1.output("NP.10", "NP.10 : Overlap of unsalicided COMP. : 0.18µm")
    np10_l1.forget

    np_11_in_dnwell = nplus.interacting(nplus.edges.and(pcomp.edges).and(lvpwell.inside(dnwell).not(lvpwell.inside(dnwell).sized(-0.429.um))))
    np_11_out_dnwell = nplus.interacting(nplus.edges.and(pcomp.edges).and(nwell.outside(dnwell).sized(0.429.um)))
    # Rule NP.11: Butting Nplus and PCOMP is forbidden within 0.43um of Nwell edge (for outside DNWELL) and of LVPWELL edge (for inside DNWELL case).
    logger.info("Executing rule NP.11")
    np11_l1 = np_11_in_dnwell.or(np_11_out_dnwell)
    np11_l1.output("NP.11", "NP.11 : Butting Nplus and PCOMP is forbidden within 0.43um of Nwell edge (for outside DNWELL) and of LVPWELL edge (for inside DNWELL case).")
    np11_l1.forget

    np_11_in_dnwell.forget

    np_11_out_dnwell.forget

    # Rule NP.12: Overlap with P-channel poly2 gate extension is forbidden within 0.32um of P-channel gate.
    logger.info("Executing rule NP.12")
    np12_l1 = nplus.interacting(nplus.edges.separation(pgate.edges.and(pcomp.edges), 0.32.um, euclidian).polygons(0.001))
    np12_l1.output("NP.12", "NP.12 : Overlap with P-channel poly2 gate extension is forbidden within 0.32um of P-channel gate.")
    np12_l1.forget
end #FEOL
################################################################################################
# Copyright 2022 GlobalFoundries PDK Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################################


exec_end_time = Time.now
run_time = exec_end_time - exec_start_time
logger.info("%s DRC Total Run time %f seconds" % [table_name, run_time])