def test_colours(self):
"""
Test that we can log with and without colour.
"""
msg = "This is a test message" # type: str
log = HammerVLSILogging.context("test")
HammerVLSILogging.enable_buffering = True # we need this for test
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(HammerVLSILogging.callback_buffering)
HammerVLSILogging.enable_colour = True
log.info(msg)
self.assertEqual(HammerVLSILogging.get_colour_escape(Level.INFO) + "[test] " + msg + HammerVLSILogging.COLOUR_CLEAR, HammerVLSILogging.get_buffer()[0])
HammerVLSILogging.enable_colour = False
log.info(msg)
self.assertEqual("[test] " + msg, HammerVLSILogging.get_buffer()[0])
def test_colours(self):
"""
Test that we can log with and without colour.
"""
msg = "This is a test message" # type: str
log = HammerVLSILogging.context("test")
HammerVLSILogging.enable_buffering = True # we need this for test
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(HammerVLSILogging.callback_buffering)
HammerVLSILogging.enable_colour = True
log.info(msg)
self.assertEqual(HammerVLSILogging.get_colour_escape(Level.INFO) + "[test] " + msg + HammerVLSILogging.COLOUR_CLEAR, HammerVLSILogging.get_buffer()[0])
HammerVLSILogging.enable_colour = False
log.info(msg)
self.assertEqual("[test] " + msg, HammerVLSILogging.get_buffer()[0])
def test_file_logging(self):
fd, path = tempfile.mkstemp(".log")
os.close(fd) # Don't leak file descriptors
filelogger = HammerVLSIFileLogger(path)
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(filelogger.callback)
log = HammerVLSILogging.context()
log.info("Hello world")
log.info("Eternal voyage to the edge of the universe")
filelogger.close()
with open(path, 'r') as f:
self.assertEqual(f.read().strip(), """
[<global>] Level.INFO: Hello world
[<global>] Level.INFO: Eternal voyage to the edge of the universe
""".strip())
# Remove temp file
os.remove(path)
def test_file_logging(self):
fd, path = tempfile.mkstemp(".log")
os.close(fd) # Don't leak file descriptors
filelogger = HammerVLSIFileLogger(path)
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(filelogger.callback)
log = HammerVLSILogging.context()
log.info("Hello world")
log.info("Eternal voyage to the edge of the universe")
filelogger.close()
with open(path, 'r') as f:
self.assertEqual(f.read().strip(), """
[<global>] Level.INFO: Hello world
[<global>] Level.INFO: Eternal voyage to the edge of the universe
""".strip())
# Remove temp file
os.remove(path)
def test_subcontext(self):
HammerVLSILogging.enable_colour = False
HammerVLSILogging.enable_tag = True
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(HammerVLSILogging.callback_buffering)
# Get top context
log = HammerVLSILogging.context("top")
# Create sub-contexts.
logA = log.context("A")
logB = log.context("B")
msgA = "Hello world from A"
msgB = "Hello world from B"
logA.info(msgA)
logB.error(msgB)
self.assertEqual(HammerVLSILogging.get_buffer(),
['[top] [A] ' + msgA, '[top] [B] ' + msgB])
def test_subcontext(self):
HammerVLSILogging.enable_colour = False
HammerVLSILogging.enable_tag = True
HammerVLSILogging.clear_callbacks()
HammerVLSILogging.add_callback(HammerVLSILogging.callback_buffering)
# Get top context
log = HammerVLSILogging.context("top")
# Create sub-contexts.
logA = log.context("A")
logB = log.context("B")
msgA = "Hello world from A"
msgB = "Hello world from B"
logA.info(msgA)
logB.error(msgB)
self.assertEqual(HammerVLSILogging.get_buffer(),
['[top] [A] ' + msgA, '[top] [B] ' + msgB]
)
def __init__(self,
options: HammerDriverOptions,
extra_project_config: dict = {}) -> None:
"""
Create a hammer-vlsi driver, which is a higher level convenience function
for quickly using hammer-vlsi. It imports and uses the hammer-vlsi blocks.
Set up logging, databases, context, etc.
:param options: Driver options.
:param extra_project_config: An extra flattened config for the project. Optional.
"""
# Create global logging context.
file_logger = HammerVLSIFileLogger(options.log_file)
HammerVLSILogging.add_callback(file_logger.callback)
self.log = HammerVLSILogging.context(
) # type: HammerVLSILoggingContext
# Create a new hammer database.
self.database = hammer_config.HammerDatabase(
) # type: hammer_config.HammerDatabase
self.log.info("Loading hammer-vlsi libraries and reading settings")
# Store the run dir.
self.obj_dir = options.obj_dir # type: str
# Load in builtins.
self.database.update_builtins([
hammer_config.load_config_from_file(os.path.join(
HammerVLSISettings.hammer_vlsi_path, "builtins.yml"),
strict=True),
HammerVLSISettings.get_config()
])
# Read in core defaults.
self.database.update_core(
hammer_config.load_config_from_defaults(
HammerVLSISettings.hammer_vlsi_path))
# Read in the environment config for paths to CAD tools, etc.
for config in options.environment_configs:
if not os.path.exists(config):
self.log.error("Environment config %s does not exist!" %
(config))
self.database.update_environment(
hammer_config.load_config_from_paths(options.environment_configs,
strict=True))
# Read in the project config to find the syn, par, and tech.
project_configs = hammer_config.load_config_from_paths(
options.project_configs, strict=True)
project_configs.append(extra_project_config)
self.project_configs = [] # type: List[dict]
self.update_project_configs(project_configs)
# Get the technology and load technology settings.
self.tech = None # type: Optional[hammer_tech.HammerTechnology]
self.load_technology()
# Keep track of what the synthesis and par configs are since
# update_tools() just takes a whole list.
self.tool_configs = {} # type: Dict[str, List[dict]]
# Initialize tool fields.
self.syn_tool = None # type: Optional[HammerSynthesisTool]
self.par_tool = None # type: Optional[HammerPlaceAndRouteTool]
# Initialize tool hooks. Used to specify resume/pause hooks after custom hooks have been registered.
self.post_custom_syn_tool_hooks = [
] # type: List[HammerToolHookAction]
self.post_custom_par_tool_hooks = [
] # type: List[HammerToolHookAction]
def __init__(self, options: HammerDriverOptions, extra_project_config: dict = {}) -> None:
"""
Create a hammer-vlsi driver, which is a higher level convenience function
for quickly using hammer-vlsi. It imports and uses the hammer-vlsi blocks.
Set up logging, databases, context, etc.
:param options: Driver options.
:param extra_project_config: An extra flattened config for the project. Optional.
"""
# Create global logging context.
file_logger = HammerVLSIFileLogger(options.log_file)
HammerVLSILogging.add_callback(file_logger.callback)
self.log = HammerVLSILogging.context() # type: HammerVLSILoggingContext
# Create a new hammer database.
self.database = hammer_config.HammerDatabase() # type: hammer_config.HammerDatabase
self.log.info("Loading hammer-vlsi libraries and reading settings")
# Store the run dir.
self.obj_dir = options.obj_dir # type: str
# Load builtins and core into the database.
HammerVLSISettings.load_builtins_and_core(self.database)
# Read in the environment config for paths to CAD tools, etc.
for config in options.environment_configs:
if not os.path.exists(config):
self.log.error("Environment config %s does not exist!" % (config))
self.database.update_environment(hammer_config.load_config_from_paths(options.environment_configs, strict=True))
# Read in the project config to find the syn, par, and tech.
project_configs = hammer_config.load_config_from_paths(options.project_configs, strict=True)
project_configs.append(extra_project_config)
self.project_configs = [] # type: List[dict]
self.update_project_configs(project_configs)
# Get the technology and load technology settings.
self.tech = None # type: Optional[hammer_tech.HammerTechnology]
self.load_technology()
# Keep track of what the synthesis and par configs are since
# update_tools() just takes a whole list.
self.tool_configs = {} # type: Dict[str, List[dict]]
# Initialize tool fields.
self.syn_tool = None # type: Optional[HammerSynthesisTool]
self.par_tool = None # type: Optional[HammerPlaceAndRouteTool]
self.drc_tool = None # type: Optional[HammerDRCTool]
self.lvs_tool = None # type: Optional[HammerLVSTool]
self.sram_generator_tool = None # type: Optional[HammerSRAMGeneratorTool]
# Initialize tool hooks. Used to specify resume/pause hooks after custom hooks have been registered.
self.post_custom_syn_tool_hooks = [] # type: List[HammerToolHookAction]
self.post_custom_par_tool_hooks = [] # type: List[HammerToolHookAction]
self.post_custom_drc_tool_hooks = [] # type: List[HammerToolHookAction]
self.post_custom_lvs_tool_hooks = [] # type: List[HammerToolHookAction]
self.post_custom_sram_generator_tool_hooks = [] # type: List[HammerToolHookAction]
self.post_custom_pcb_tool_hooks = [] # type: List[HammerToolHookAction]