Coverage for klayout_pex/magic/magic

2# --------------------------------------------------------------------------------

3# SPDX-FileCopyrightText: 2024 Martin Jan Köhler and Harald Pretl

4# Johannes Kepler University, Institute for Integrated Circuits.

6# This file is part of KPEX

7# (see https://github.com/martinjankoehler/klayout-pex).

9# This program is free software: you can redistribute it and/or modify

10# it under the terms of the GNU General Public License as published by

11# the Free Software Foundation, either version 3 of the License, or

12# (at your option) any later version.

13#

14# This program is distributed in the hope that it will be useful,

15# but WITHOUT ANY WARRANTY; without even the implied warranty of

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

17# GNU General Public License for more details.

18#

19# You should have received a copy of the GNU General Public License

20# along with this program. If not, see <http://www.gnu.org/licenses/>.

21# SPDX-License-Identifier: GPL-3.0-or-later

22# --------------------------------------------------------------------------------

23#

24from enum import StrEnum

25import time

26from typing import *

28import os

29import subprocess

31from ..log import (

32 info,

33 # warning,

34 rule,

35 subproc,

36)

37from ..version import __version__

40class MagicPEXMode(StrEnum):

41 CC = "CC"

42 RC = "RC"

43 R = "R"

44 DEFAULT = CC

47class MagicShortMode(StrEnum):

48 NONE = "none"

49 RESISTOR = "resistor"

50 VOLTAGE = "voltage"

51 DEFAULT = NONE

54class MagicMergeMode(StrEnum):

55 NONE = "none" # don't merge parallel devices

56 CONSERVATIVE = "conservative" # merge devices with same L, W

57 AGGRESSIVE = "aggressive" # merge devices with same L

58 DEFAULT = NONE

61def prepare_magic_script(gds_path: str,

62 cell_name: str,

63 run_dir_path: str,

64 script_path: str,

65 output_netlist_path: str,

66 pex_mode: MagicPEXMode,

67 c_threshold: float,

68 r_threshold: float,

69 tolerance: float,

70 halo: Optional[float],

71 short_mode: MagicShortMode,

72 merge_mode: MagicMergeMode):

73 gds_path = os.path.abspath(gds_path)

74 run_dir_path = os.path.abspath(run_dir_path)

75 output_netlist_path = os.path.abspath(output_netlist_path)

77 halo_scale = 200.0

78 halo_decl = '' if halo is None else f"\nextract halo {round(halo * halo_scale)}"

80 script: str = ""

81 match pex_mode:

82 case MagicPEXMode.CC:

83 script = f"""# Generated by kpex {__version__}

84crashbackups stop

85drc off

86gds read {gds_path}

87load {cell_name}

88select top cell

89flatten {cell_name}_flat

90load {cell_name}_flat

91cellname delete {cell_name} -noprompt

92cellname rename {cell_name}_flat {cell_name}

93select top cell

94extract path {run_dir_path}{halo_decl}

95extract all

96ext2spice short {short_mode}

97ext2spice merge {merge_mode}

98ext2spice cthresh {c_threshold}

99ext2spice subcircuits top on

100ext2spice format ngspice

101ext2spice -p {run_dir_path} -o {output_netlist_path}

102quit -noprompt"""

103 case MagicPEXMode.RC:

104 script = f"""# Generated by kpex {__version__}

105crashbackups stop

106drc off

107gds read {gds_path}

108load {cell_name}

109select top cell

110flatten {cell_name}_flat

111load {cell_name}_flat

112cellname delete {cell_name} -noprompt

113cellname rename {cell_name}_flat {cell_name}

114select top cell

115extract path {run_dir_path}{halo_decl}

116extract do resistance

117extract all

118ext2sim labels on

119ext2sim

120extresist tolerance {tolerance}

121extresist all

122ext2spice short {short_mode}

123ext2spice merge {merge_mode}

124ext2spice cthresh {c_threshold}

125ext2spice rthresh {r_threshold}

126ext2spice extresist on

127ext2spice subcircuits top on

128ext2spice format ngspice

129ext2spice -p {run_dir_path} -o {output_netlist_path}

130quit -noprompt

131"""

132 case MagicPEXMode.R:

133 script = f"""# Generated by kpex {__version__}

134crashbackups stop

135drc off

136gds read {gds_path}

137load {cell_name}

138select top cell

139flatten {cell_name}_flat

140load {cell_name}_flat

141cellname delete {cell_name} -noprompt

142cellname rename {cell_name}_flat {cell_name}

143select top cell

144extract path {run_dir_path}{halo_decl}

145extract do resistance

146extract no capacitance

147extract no coupling

148extract all

149ext2sim labels on

150ext2sim

151extresist tolerance {tolerance}

152extresist all

153ext2spice short {short_mode}

154ext2spice merge {merge_mode}

155ext2spice rthresh {r_threshold}

156ext2spice extresist on

157ext2spice subcircuits top on

158ext2spice format ngspice

159ext2spice -p {run_dir_path} -o {output_netlist_path}

160quit -noprompt

161"""

162

163 with open(script_path, 'w') as f:

164 f.write(script)

165

166def run_magic(exe_path: str,

167 magicrc_path: str,

168 script_path: str,

169 log_path: str):

170 args = [

171 exe_path,

172 '-dnull', #

173 '-noconsole', #

174 '-rcfile', #

175 magicrc_path, #

176 script_path, # TCL script

177 ]

178

179 info('Calling MAGIC')

180 subproc(f"{' '.join(args)}, output file: {log_path}")

181

182 rule('MAGIC Output')

183

184 start = time.time()

185

186 proc = subprocess.Popen(args,

187 stdin=subprocess.DEVNULL,

188 stdout=subprocess.PIPE,

189 stderr=subprocess.STDOUT,

190 universal_newlines=True,

191 text=True)

192 with open(log_path, 'w') as f:

193 while True:

194 line = proc.stdout.readline()

195 if not line:

196 break

197 subproc(line[:-1]) # remove newline

198 f.writelines([line])

199 proc.wait()

200

201 duration = time.time() - start

202

203 rule()

204

205 if proc.returncode == 0:

206 info(f"MAGIC succeeded after {'%.4g' % duration}s")

207 else:

208 raise Exception(f"MAGIC failed with status code {proc.returncode} after {'%.4g' % duration}s, "

209 f"see log file: {log_path}")

210

Coverage for klayout_pex/magic/magic_runner.py: 41%

58 statements