sky130/custom/scripts/rename_cells.py

#!/usr/bin/env python3
#
# rename_cells ---
#
# This script renames include paths from SPICE files in the cells
# (libs.ref/sky130_fd_pr) directory that point to other cells
# directories, to point to the correct location in libs.ref/sky130_fd_pr/spice/
# (or libs.ref/spi/sky130_fd_pr, if -ef_format is specified).
#
#
# This script is a filter to be run by setting the name of this script as
# the value to "filter=" for the model install in the sky130 Makefile.

import re
import os
import sys

def filter(inname, outname):

    # Read input
    try:
        with open(inname, 'r') as inFile:
            spitext = inFile.read()
            spilines = spitext.splitlines()
    except:
        print('rename_cells.py: failed to open ' + inname + ' for reading.', file=sys.stderr)
        return 1

    # Process input with regexp

    fixedlines = []
    modified = False

    for line in spilines:

        # These substitutions are for files originating from cells/*/*.spice
        fixedline = re.sub('\.\./\.\./models/', '../../../libs.tech/ngspice/', line)
        fixedline = re.sub('\.\./[^/\.]+/', '', fixedline)

        # This substitution fixes a single error in the file
        # sky130_fd_pr__nfet_05v0_nvt.pm3.spice
        fixedline = re.sub('^include.*', '', fixedline)

        # This subsitution makes SPICE files compatible with Xyce without
        # breaking ngspice compatibility ('$' comments changed to ';')
        fixedline = re.sub('(.*[ \t]+)\$([ \t+].*)', '\g<1>;\g<2>', fixedline)

        # This substitution originally from patch file sky130_fd_pr.patch.
        # Find ".param" lines with "nf = (value)" and move it to the front
        # of the parameter list.
        fixedline = re.sub('^(\.param.*)( ad = )(.*)( nf = 1.0)(.*)',
			'\g<1>\g<4>\g<2>\g<3>\g<5>', fixedline)
        fixedline = re.sub('^(\.param.*)( ad = )(.*)( nf = 1)(.*)',
			'\g<1>\g<4>\g<2>\g<3>\g<5>', fixedline)

        # This substitution originally from patch file sky130_fd_pr.patch.
        # Find "msky..." lines with "nf = {nf}" and move it to the front
        # of the parameter list.
        fixedline = re.sub('^(msky130_.*)( ad = )(.*)( nf = \{nf\})(.*)',
			'\g<1>\g<4>\g<2>\g<3>\g<5>', fixedline)

        # This substitution originally from patch file sky130_fd_pr.patch.
        # Find "xmain1" lines # and add "nf=nf" before "ad=0"
        fixedline = re.sub('^(xmain1 .*)( ad=0 .*)', '\g<1> nf=nf\g<2>', fixedline)

        # This substitution originally from patch file sky130_fd_pr.patch.
        # Find ".subckt" lines with "mf=1" and add "nf=1" before "ad=0"
        # and remove "mf=1".
        fixedline = re.sub('^(.subckt .*)( ad=0 .*)( mf=1)(.*)',
			'\g<1> nf=1\g<2>\g<4>', fixedline)

        fixedlines.append(fixedline)
        if fixedline != line:
            modified = True

    # Write output
    if outname == None:
        for i in fixedlines:
            print(i)
    else:
        # If the output is a symbolic link but no modifications have been made,
        # then leave it alone.  If it was modified, then remove the symbolic
        # link before writing.
        if os.path.islink(outname):
            if not modified:
                return 0
            else:
                os.unlink(outname)
        try:
            with open(outname, 'w') as outFile:
                for i in fixedlines:
                    print(i, file=outFile)
        except:
            print('rename_cells.py: failed to open ' + outname + ' for writing.', file=sys.stderr)
            return 1


if __name__ == '__main__':

    # This script expects to get one or two arguments.  One argument is
    # mandatory and is the input file.  The other argument is optional and
    # is the output file.  The output file and input file may be the same
    # name, in which case the original input is overwritten.

    options = []
    arguments = []
    for item in sys.argv[1:]:
        if item.find('-', 0) == 0:
            options.append(item[1:])
        else:
            arguments.append(item)

    if len(arguments) > 0:
        infilename = arguments[0]

    if len(arguments) > 1:
        outfilename = arguments[1]
    else:
        outfilename = None

    result = filter(infilename, outfilename)
    sys.exit(result)