mirror of https://github.com/VLSIDA/OpenRAM.git
399 lines
14 KiB
Python
399 lines
14 KiB
Python
# See LICENSE for licensing information.
|
|
#
|
|
# Copyright (c) 2016-2019 Regents of the University of California and The Board
|
|
# of Regents for the Oklahoma Agricultural and Mechanical College
|
|
# (acting for and on behalf of Oklahoma State University)
|
|
# All rights reserved.
|
|
#
|
|
"""
|
|
This is a DRC/LVS interface for calibre. It implements completely
|
|
independently three functions: run_drc, run_lvs, run_pex, that perform these
|
|
functions in batch mode and will return true/false if the result
|
|
passes. All of the setup (the rules, temp dirs, etc.) should be
|
|
contained in this file. Replacing with another DRC/LVS tool involves
|
|
rewriting this code to work properly. Porting to a new technology in
|
|
Calibre means pointing the code to the proper DRC and LVS rule files.
|
|
|
|
"""
|
|
|
|
|
|
import os
|
|
import shutil
|
|
import re
|
|
import debug
|
|
from globals import OPTS
|
|
from run_script import run_script
|
|
|
|
# Keep track of statistics
|
|
num_drc_runs = 0
|
|
num_lvs_runs = 0
|
|
num_pex_runs = 0
|
|
|
|
|
|
def write_calibre_drc_script(cell_name, extract, final_verification, gds_name):
|
|
""" Write a Calibre runset file and script to run DRC """
|
|
# the runset file contains all the options to run calibre
|
|
from tech import drc
|
|
drc_rules = drc["drc_rules"]
|
|
|
|
drc_runset = {
|
|
'drcRulesFile': drc_rules,
|
|
'drcRunDir': OPTS.openram_temp,
|
|
'drcLayoutPaths': gds_name,
|
|
'drcLayoutPrimary': cell_name,
|
|
'drcLayoutSystem': 'GDSII',
|
|
'drcResultsformat': 'ASCII',
|
|
'drcResultsFile': cell_name + ".drc.results",
|
|
'drcSummaryFile': cell_name + ".drc.summary",
|
|
'cmnFDILayerMapFile': drc["layer_map"],
|
|
'cmnFDIUseLayerMap': 1
|
|
}
|
|
|
|
# write the runset file
|
|
f = open(OPTS.openram_temp + "drc_runset", "w")
|
|
for k in sorted(iter(drc_runset.keys())):
|
|
f.write("*{0}: {1}\n".format(k, drc_runset[k]))
|
|
f.close()
|
|
|
|
# Create an auxiliary script to run calibre with the runset
|
|
run_file = OPTS.openram_temp + "run_drc.sh"
|
|
f = open(run_file, "w")
|
|
f.write("#!/bin/sh\n")
|
|
cmd = "{0} -gui -drc {1}drc_runset -batch".format(OPTS.drc_exe[1],
|
|
OPTS.openram_temp)
|
|
f.write(cmd)
|
|
f.write("\n")
|
|
f.close()
|
|
os.system("chmod u+x {}".format(run_file))
|
|
return drc_runset
|
|
|
|
|
|
def write_calibre_lvs_script(cell_name, final_verification, gds_name, sp_name):
|
|
""" Write a Calibre runset file and script to run LVS """
|
|
|
|
from tech import drc
|
|
lvs_rules = drc["lvs_rules"]
|
|
lvs_runset = {
|
|
'lvsRulesFile': lvs_rules,
|
|
'lvsRunDir': OPTS.openram_temp,
|
|
'lvsLayoutPaths': gds_name,
|
|
'lvsLayoutPrimary': cell_name,
|
|
'lvsSourcePath': sp_name,
|
|
'lvsSourcePrimary': cell_name,
|
|
'lvsSourceSystem': 'SPICE',
|
|
'lvsSpiceFile': "{}.spice".format(cell_name),
|
|
'lvsPowerNames': 'vdd',
|
|
'lvsGroundNames': 'gnd',
|
|
'lvsIncludeSVRFCmds': 1,
|
|
'lvsIgnorePorts': 1,
|
|
'lvsERCDatabase': cell_name + ".erc.results",
|
|
'lvsERCSummaryFile': cell_name + ".erc.summary",
|
|
'lvsReportFile': cell_name + ".lvs.report",
|
|
'lvsMaskDBFile': cell_name + ".maskdb",
|
|
'cmnFDILayerMapFile': drc["layer_map"],
|
|
'cmnFDIUseLayerMap': 1,
|
|
'cmnTranscriptFile': './lvs.log',
|
|
'cmnTranscriptEchoToFile': 1,
|
|
'lvsRecognizeGates': 'NONE',
|
|
}
|
|
# FIXME: Remove when vdd/gnd connected
|
|
#'cmnVConnectNamesState' : 'ALL', #connects all nets with the same namee
|
|
# FIXME: Remove when vdd/gnd connected
|
|
#'lvsAbortOnSupplyError' : 0
|
|
|
|
if not final_verification:
|
|
lvs_runset['cmnVConnectReport']=1
|
|
lvs_runset['cmnVConnectNamesState']='SOME'
|
|
lvs_runset['cmnVConnectNames']='vdd gnd'
|
|
else:
|
|
lvs_runset['lvsAbortOnSupplyError']=1
|
|
|
|
|
|
|
|
# write the runset file
|
|
f = open(OPTS.openram_temp + "lvs_runset", "w")
|
|
for k in sorted(iter(lvs_runset.keys())):
|
|
f.write("*{0}: {1}\n".format(k, lvs_runset[k]))
|
|
f.close()
|
|
|
|
# Create an auxiliary script to run calibre with the runset
|
|
run_file = OPTS.openram_temp + "run_lvs.sh"
|
|
f = open(run_file, "w")
|
|
f.write("#!/bin/sh\n")
|
|
PDK_DIR=os.environ.get("PDK_DIR")
|
|
f.write("export PDK_DIR={}\n".format(PDK_DIR))
|
|
cmd = "{0} -gui -lvs {1}lvs_runset -batch".format(OPTS.lvs_exe[1],
|
|
OPTS.openram_temp)
|
|
f.write(cmd)
|
|
f.write("\n")
|
|
f.close()
|
|
os.system("chmod u+x {}".format(run_file))
|
|
|
|
return lvs_runset
|
|
|
|
|
|
def write_calibre_pex_script(cell_name, extract, output, final_verification):
|
|
""" Write a pex script that can either just extract the netlist or the netlist+parasitics """
|
|
if output == None:
|
|
output = cell_name + ".pex.sp"
|
|
|
|
# check if lvs report has been done
|
|
# if not run drc and lvs
|
|
if not os.path.isfile(OPTS.openram_temp + cell_name + ".lvs.report"):
|
|
gds_name = OPTS.openram_temp +"/"+ cell_name + ".gds"
|
|
sp_name = OPTS.openram_temp +"/"+ cell_name + ".sp"
|
|
run_drc(cell_name, gds_name)
|
|
run_lvs(cell_name, gds_name, sp_name)
|
|
|
|
from tech import drc
|
|
pex_rules = drc["xrc_rules"]
|
|
pex_runset = {
|
|
'pexRulesFile': pex_rules,
|
|
'pexRunDir': OPTS.openram_temp,
|
|
'pexLayoutPaths': cell_name + ".gds",
|
|
'pexLayoutPrimary': cell_name,
|
|
'pexSourcePath': cell_name + ".sp",
|
|
'pexSourcePrimary': cell_name,
|
|
'pexReportFile': cell_name + ".pex.report",
|
|
'pexPexNetlistFile': output,
|
|
'pexPexReportFile': cell_name + ".pex.report",
|
|
'pexMaskDBFile': cell_name + ".maskdb",
|
|
'cmnFDIDEFLayoutPath': cell_name + ".def",
|
|
}
|
|
|
|
# write the runset file
|
|
f = open(OPTS.openram_temp + "pex_runset", "w")
|
|
for k in sorted(iter(pex_runset.keys())):
|
|
f.write("*{0}: {1}\n".format(k, pex_runset[k]))
|
|
f.close()
|
|
|
|
# Create an auxiliary script to run calibre with the runset
|
|
run_file = OPTS.openram_temp + "run_pex.sh"
|
|
f = open(run_file, "w")
|
|
f.write("#!/bin/sh\n")
|
|
cmd = "{0} -gui -pex {1}pex_runset -batch".format(OPTS.pex_exe[1],
|
|
OPTS.openram_temp)
|
|
f.write(cmd)
|
|
f.write("\n")
|
|
f.close()
|
|
os.system("chmod u+x {}".format(run_file))
|
|
|
|
return pex_runset
|
|
|
|
|
|
def run_drc(cell_name, gds_name, extract=False, final_verification=False):
|
|
"""Run DRC check on a given top-level name which is
|
|
implemented in gds_name."""
|
|
|
|
global num_drc_runs
|
|
num_drc_runs += 1
|
|
|
|
# Filter the layouts through magic as a GDS filter for nsdm/psdm/nwell merging
|
|
if OPTS.tech_name == "sky130" and False:
|
|
shutil.copy(gds_name, OPTS.openram_temp + "temp.gds")
|
|
from magic import filter_gds
|
|
filter_gds(cell_name, OPTS.openram_temp + "temp.gds", OPTS.openram_temp + cell_name + ".gds")
|
|
else:
|
|
# Copy file to local dir if it isn't already
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(gds_name)):
|
|
shutil.copy(gds_name, OPTS.openram_temp)
|
|
|
|
drc_runset = write_calibre_drc_script(cell_name, extract, final_verification, gds_name)
|
|
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(gds_name)):
|
|
shutil.copy(gds_name, OPTS.openram_temp + os.path.basename(gds_name))
|
|
|
|
(outfile, errfile, resultsfile) = run_script(cell_name, "drc")
|
|
|
|
# check the result for these lines in the summary:
|
|
# TOTAL Original Layer Geometries: 106 (157)
|
|
# TOTAL DRC RuleChecks Executed: 156
|
|
# TOTAL DRC Results Generated: 0 (0)
|
|
try:
|
|
f = open(OPTS.openram_temp + drc_runset['drcSummaryFile'], "r")
|
|
except:
|
|
debug.error("Unable to retrieve DRC results file. Is calibre set up?",1)
|
|
results = f.readlines()
|
|
f.close()
|
|
# those lines should be the last 3
|
|
results = results[-3:]
|
|
geometries = int(re.split(r'\W+', results[0])[5])
|
|
rulechecks = int(re.split(r'\W+', results[1])[4])
|
|
errors = int(re.split(r'\W+', results[2])[5])
|
|
|
|
# always display this summary
|
|
result_str = "{0}\tGeometries: {1}\tChecks: {2}\tErrors: {3}".format(cell_name,
|
|
geometries,
|
|
rulechecks,
|
|
errors)
|
|
if errors > 0:
|
|
debug.warning(result_str)
|
|
else:
|
|
debug.info(1, result_str)
|
|
return errors
|
|
|
|
|
|
def run_lvs(cell_name, gds_name, sp_name, final_verification=False):
|
|
"""Run LVS check on a given top-level name which is
|
|
implemented in gds_name and sp_name. Final verification will
|
|
ensure that there are no remaining virtual conections. """
|
|
|
|
global num_lvs_runs
|
|
num_lvs_runs += 1
|
|
|
|
lvs_runset = write_calibre_lvs_script(cell_name, final_verification, gds_name, sp_name)
|
|
|
|
# Copy file to local dir if it isn't already
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(gds_name)):
|
|
shutil.copy(gds_name, OPTS.openram_temp)
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(sp_name)):
|
|
shutil.copy(sp_name, OPTS.openram_temp)
|
|
|
|
(outfile, errfile, resultsfile) = run_script(cell_name, "lvs")
|
|
|
|
# check the result for these lines in the summary:
|
|
f = open(OPTS.openram_temp + lvs_runset['lvsReportFile'], "r")
|
|
results = f.readlines()
|
|
f.close()
|
|
|
|
# NOT COMPARED
|
|
# CORRECT
|
|
# INCORRECT
|
|
test = re.compile("# CORRECT #")
|
|
correct = list(filter(test.search, results))
|
|
test = re.compile("NOT COMPARED")
|
|
notcompared = list(filter(test.search, results))
|
|
test = re.compile("# INCORRECT #")
|
|
incorrect = list(filter(test.search, results))
|
|
|
|
# Errors begin with "Error:"
|
|
test = re.compile(r'\s+Error:')
|
|
errors = list(filter(test.search, results))
|
|
for e in errors:
|
|
debug.error(e.strip("\n"))
|
|
|
|
summary_errors = len(notcompared) + len(incorrect) + len(errors)
|
|
|
|
# also check the extraction summary file
|
|
f = open(OPTS.openram_temp + lvs_runset['lvsReportFile'] + ".ext", "r")
|
|
results = f.readlines()
|
|
f.close()
|
|
|
|
test = re.compile("ERROR:")
|
|
exterrors = list(filter(test.search, results))
|
|
for e in exterrors:
|
|
debug.error(e.strip("\n"))
|
|
|
|
test = re.compile("WARNING:")
|
|
extwarnings = list(filter(test.search, results))
|
|
for e in extwarnings:
|
|
debug.warning(e.strip("\n"))
|
|
|
|
# MRG - 9/26/17 - Change this to exclude warnings because of
|
|
# multiple labels on different pins in column mux.
|
|
ext_errors = len(exterrors)
|
|
ext_warnings = len(extwarnings)
|
|
|
|
# also check the output file
|
|
f = open(outfile, "r")
|
|
results = f.readlines()
|
|
f.close()
|
|
|
|
# Errors begin with "ERROR:"
|
|
test = re.compile("ERROR:")
|
|
stdouterrors = list(filter(test.search, results))
|
|
for e in stdouterrors:
|
|
debug.error(e.strip("\n"))
|
|
|
|
out_errors = len(stdouterrors)
|
|
total_errors = summary_errors + out_errors + ext_errors
|
|
|
|
# always display this summary
|
|
result_str = "{0}\tSummary: {1}\tOutput: {2}\tExtraction: {3}".format(cell_name,
|
|
summary_errors,
|
|
out_errors,
|
|
ext_errors)
|
|
if total_errors > 0:
|
|
debug.warning(result_str)
|
|
else:
|
|
debug.info(1, result_str)
|
|
|
|
return total_errors
|
|
|
|
|
|
def run_pex(cell_name, gds_name, sp_name, output=None, final_verification=False):
|
|
"""Run pex on a given top-level name which is
|
|
implemented in gds_name and sp_name. """
|
|
|
|
global num_pex_runs
|
|
num_pex_runs += 1
|
|
|
|
write_calibre_pex_script(cell_name, True, output, final_verification)
|
|
|
|
# Copy file to local dir if it isn't already
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(gds_name)):
|
|
shutil.copy(gds_name, OPTS.openram_temp)
|
|
if not os.path.isfile(OPTS.openram_temp + os.path.basename(sp_name)):
|
|
shutil.copy(sp_name, OPTS.openram_temp)
|
|
|
|
(outfile, errfile, resultsfile) = run_script(cell_name, "pex")
|
|
|
|
|
|
# also check the output file
|
|
f = open(outfile, "r")
|
|
results = f.readlines()
|
|
f.close()
|
|
|
|
# Errors begin with "ERROR:"
|
|
test = re.compile("ERROR:")
|
|
stdouterrors = list(filter(test.search, results))
|
|
for e in stdouterrors:
|
|
debug.error(e.strip("\n"))
|
|
|
|
out_errors = len(stdouterrors)
|
|
|
|
assert(os.path.isfile(output))
|
|
correct_port(cell_name, output, sp_name)
|
|
|
|
return out_errors
|
|
|
|
|
|
def correct_port(name, output_file_name, ref_file_name):
|
|
pex_file = open(output_file_name, "r")
|
|
contents = pex_file.read()
|
|
# locate the start of circuit definition line
|
|
match = re.search(".subckt " + str(name) + ".*", contents)
|
|
match_index_start = match.start()
|
|
pex_file.seek(match_index_start)
|
|
rest_text = pex_file.read()
|
|
# locate the end of circuit definition line
|
|
match = re.search(r'\* \n', rest_text)
|
|
match_index_end = match.start()
|
|
# store the unchanged part of pex file in memory
|
|
pex_file.seek(0)
|
|
part1 = pex_file.read(match_index_start)
|
|
pex_file.seek(match_index_start + match_index_end)
|
|
part2 = pex_file.read()
|
|
pex_file.close()
|
|
|
|
# obtain the correct definition line from the original spice file
|
|
sp_file = open(ref_file_name, "r")
|
|
contents = sp_file.read()
|
|
circuit_title = re.search(".SUBCKT " + str(name) + ".*\n", contents)
|
|
circuit_title = circuit_title.group()
|
|
sp_file.close()
|
|
|
|
# write the new pex file with info in the memory
|
|
output_file = open(output_file_name, "w")
|
|
output_file.write(part1)
|
|
output_file.write(circuit_title)
|
|
output_file.write(part2)
|
|
output_file.close()
|
|
|
|
def print_drc_stats():
|
|
debug.info(1,"DRC runs: {0}".format(num_drc_runs))
|
|
def print_lvs_stats():
|
|
debug.info(1,"LVS runs: {0}".format(num_lvs_runs))
|
|
def print_pex_stats():
|
|
debug.info(1,"PEX runs: {0}".format(num_pex_runs))
|