|
| 1 | +#!/usr/bin/env ruby |
| 2 | +# |
| 3 | +# Generates the KLayout layer map file from the Virtuoso Stream Layer Map File |
| 4 | +# It's really here to map from the Virtuoso purpose name to KLayout's LEF |
| 5 | +# purpose name |
| 6 | +# |
| 7 | +# Virtuoso Stream Layer Map File Format: |
| 8 | +# layer_name purpose_name gds_layer gds_datatype |
| 9 | +# |
| 10 | +# KLayout Layer Map File Format: |
| 11 | +# layer_name lef_purpose_name gds_layer gds_datatype |
| 12 | +# |
| 13 | +# Usage: KLayoutLayerMapGenerator.rb -i <input_file> -o <output_file> |
| 14 | +# [-m <layer_name_mapper_ruby_file>] |
| 15 | +# |
| 16 | +# layer_name_mapper is the path to a file that implements LayerNameMapper for |
| 17 | +# custom layer name mapping |
| 18 | +# |
| 19 | +# File needs to be located in ~/.klayout/ruby |
| 20 | +# |
| 21 | + |
| 22 | +require 'optparse' |
| 23 | + |
| 24 | +# |
| 25 | +# Class to generate the layer map from the Virtuoso Stream Layer Map file |
| 26 | +# |
| 27 | +class KLayoutLayerMapGenerator |
| 28 | + # |
| 29 | + # Structs used to store data |
| 30 | + # |
| 31 | + VirtuosoLayerInfo = Struct.new(:cds_lpp, :gds) |
| 32 | + VirtuosoLayerPurposePair = Struct.new(:layer_name, :purpose_name) |
| 33 | + GDSLayerDataType = Struct.new(:layer, :datatype) |
| 34 | + |
| 35 | + # |
| 36 | + # Initializer |
| 37 | + # |
| 38 | + # layer_map: Stores mapping from layer name to VirtuosoLayerInfo object |
| 39 | + # |
| 40 | + def initialize(layer_name_mapper_file) |
| 41 | + @layer_map = {} |
| 42 | + # load in layer_name_mapper dynamically |
| 43 | + load layer_name_mapper_file |
| 44 | + @layer_name_mapper = LayerNameMapper.new() |
| 45 | + end |
| 46 | + |
| 47 | + # |
| 48 | + # Reads the Virtuoso Layer Map file |
| 49 | + # |
| 50 | + def read_virtuoso_layer_map_file(file_name) |
| 51 | + fh = File.open(file_name, chomp: true) |
| 52 | + if fh |
| 53 | + read(fh) |
| 54 | + fh.close |
| 55 | + else |
| 56 | + puts "Error: can't open " + file_name |
| 57 | + end |
| 58 | + end |
| 59 | + |
| 60 | + # |
| 61 | + # Reads the content from a stream |
| 62 | + # |
| 63 | + # For each layer in the layer mapping file, add an entry into layer_map. |
| 64 | + # The key is the mapped layer name and the value is a list of |
| 65 | + # VirtuosoLayerInfo objects. The value is a list since there can be multiple |
| 66 | + # entries for the same mapped layer name in the Virtuoso map |
| 67 | + # |
| 68 | + def read(fh) |
| 69 | + layer_re = /(\S+)\s+(\S+)\s+(\d+)\s+(\d+)([^#]*)\#\s*(\S+)?/ |
| 70 | + fh.each_line do | line | |
| 71 | + if not line.match(/^#/) |
| 72 | + result = line.match(layer_re) |
| 73 | + if result |
| 74 | + layer_name = result[1] |
| 75 | + purpose_name = result[2] |
| 76 | + gds_layer = result[3].to_i |
| 77 | + gds_datatype = result[4].to_i |
| 78 | + design_manual_layer_name = result[6] |
| 79 | + key = map_layer_name(design_manual_layer_name, layer_name, |
| 80 | + purpose_name) |
| 81 | + cds_lpp = VirtuosoLayerPurposePair.new(layer_name, purpose_name) |
| 82 | + gds = GDSLayerDataType.new(gds_layer, gds_datatype) |
| 83 | + layer_info = VirtuosoLayerInfo.new(cds_lpp, gds) |
| 84 | + if @layer_map[key] |
| 85 | + @layer_map[key] << layer_info |
| 86 | + else |
| 87 | + @layer_map[key] = [layer_info] |
| 88 | + end |
| 89 | + else |
| 90 | + if line != "\n" |
| 91 | + puts "Skipping: " + line |
| 92 | + end |
| 93 | + end |
| 94 | + end |
| 95 | + end |
| 96 | + end |
| 97 | + |
| 98 | + # |
| 99 | + # Maps layers to the desired name in the layer map |
| 100 | + # |
| 101 | + def map_layer_name(design_manual_layer_name, cds_layer_name, cds_purpose_name) |
| 102 | + return @layer_name_mapper.map_layer_name(design_manual_layer_name, cds_layer_name, cds_purpose_name) |
| 103 | + end |
| 104 | + |
| 105 | + # |
| 106 | + # Writes the layer map to a file |
| 107 | + # |
| 108 | + def write_layer_map_file(file_name) |
| 109 | + out_fh = File.open(file_name, "w") do |out_fh| |
| 110 | + write_layer_map(out_fh) |
| 111 | + end |
| 112 | + end |
| 113 | + |
| 114 | + # |
| 115 | + # Writes the layer map to a file handle |
| 116 | + # |
| 117 | + def write_layer_map(outfh) |
| 118 | + layer_map = get_map() |
| 119 | + layer_map.each { | layer_name, layer_list | |
| 120 | + layer_list.each { | layer_info | |
| 121 | + gds_info = layer_info.gds |
| 122 | + outfh.printf("%s %d %d\n", layer_name, gds_info.layer, |
| 123 | + gds_info.datatype) |
| 124 | + } |
| 125 | + } |
| 126 | + end |
| 127 | + |
| 128 | + # |
| 129 | + # Accessor to return a hash sorted by the gds layer |
| 130 | + # |
| 131 | + def get_map |
| 132 | + sorted_hash = @layer_map.sort_by {|key, value| value[0].gds.layer } |
| 133 | + sorted_hash = Hash[sorted_hash] |
| 134 | + return sorted_hash |
| 135 | + end |
| 136 | + |
| 137 | + # |
| 138 | + # Standalone main driver |
| 139 | + # |
| 140 | + def KLayoutLayerMapGenerator.main |
| 141 | + options = {"layer_name_mapper": "GenericLayerNameMapper.rb"} |
| 142 | + OptionParser.new do |opts| |
| 143 | + opts.banner = "Usage: KLayoutLayerMapGenerator.rb -i input_file -o output_file" |
| 144 | + opts.on("-iINPUT_FILE", "--input_file=INPUT_FILE") do |input_file| |
| 145 | + options[:input_file] = input_file |
| 146 | + end |
| 147 | + opts.on("-oOUTPUT_FILE", "--output_file=OUTPUT_FILE") do |output_file| |
| 148 | + options[:output_file] = output_file |
| 149 | + end |
| 150 | + opts.on("-mLAYER_NAME_MAPPER", "--layer_name_mapper=LAYER_NAME_MAPPER") do |layer_name_mapper_ruby_file| |
| 151 | + options[:layer_name_mapper_ruby_file] = layer_name_mapper_ruby_file |
| 152 | + end |
| 153 | + end.parse! |
| 154 | + |
| 155 | + if options[:input_file] && options[:output_file] |
| 156 | + rep = KLayoutLayerMapGenerator.new(options[:layer_name_mapper_ruby_file]) |
| 157 | + rep.read_virtuoso_layer_map_file(options[:input_file]) |
| 158 | + rep.write_layer_map_file(options[:output_file]) |
| 159 | + else |
| 160 | + puts "Usage: KLayoutLayerMapGenerator.rb -i input_file -o output_file [-m layer_name_mapper]" |
| 161 | + exit 1 |
| 162 | + end |
| 163 | + end |
| 164 | +end |
| 165 | + |
| 166 | +# |
| 167 | +# Only call the main driver if we're calling this as a script |
| 168 | +# |
| 169 | +if __FILE__ == $0 |
| 170 | + KLayoutLayerMapGenerator.main() |
| 171 | +end |
0 commit comments