odatix 3.0.1__tar.gz

odatix-3.0.1/MANIFEST.in

@@ -0,0 +1,7 @@
+include requirements.txt
+include README.md
+include odatix/version.txt
+recursive-include odatix/explorer/assets *
+recursive-include odatix/eda_tools *
+recursive-include odatix_examples *
+recursive-include odatix_init *

odatix-3.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: odatix
+Version: 3.0.1
+Summary: A FPGA/ASIC toolbox for design space exploration
+Home-page: https://github.com/jsaussereau/Asterism
+Author: Jonathan Saussereau
+Author-email: jonathan.saussereau@ims-bordeaux.fr
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: dash
+Requires-Dist: Flask
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: plotly
+Requires-Dist: PyYAML
+Requires-Dist: waitress

odatix-3.0.1/odatix/components/clean.py

@@ -0,0 +1,142 @@
+# ********************************************************************** #
+#                                Odatix                                  #
+# ********************************************************************** #
+#
+# Copyright (C) 2022 Jonathan Saussereau
+#
+# This file is part of Odatix.
+# Odatix is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Odatix is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Odatix. If not, see <https://www.gnu.org/licenses/>.
+#
+
+import os
+import sys
+import yaml
+import glob
+import shutil
+import argparse
+
+import odatix.lib.printc as printc
+from odatix.lib.utils import read_from_list, KeyNotInListError, BadValueInListError
+from odatix.lib.settings import OdatixSettings
+
+script_name = os.path.basename(__file__)
+
+DANGEROUS_PATHS = ["/", "./", "./*", "*", "~", ".", ".."]
+
+######################################
+# Parse Arguments
+######################################
+
+def add_arguments(parser):
+  parser.add_argument("-i", "--input", default=OdatixSettings.DEFAULT_CLEAN_SETTINGS_FILE, help="input settings file (default: " + OdatixSettings.DEFAULT_CLEAN_SETTINGS_FILE + ")")
+  parser.add_argument("-f", "--force", action="store_true", help="force delete (dangerous!)")
+  parser.add_argument("-v", "--verbose", action="store_true", help="print extra details")
+  parser.add_argument("-q", "--quiet", action="store_true", help="do not print anything, except errors")
+
+def parse_arguments():
+  parser = argparse.ArgumentParser(description="Clean up current directory")
+  add_arguments(parser)
+  return parser.parse_args()
+
+######################################
+# Helper Functions
+######################################
+
+def remove_path(path, force=False, verbose=False, quiet=False):
+      
+  cwd = os.getcwd()
+  full_path = os.path.realpath(os.path.join(cwd, path))
+
+  if path in DANGEROUS_PATHS or full_path in DANGEROUS_PATHS:
+    if not force:
+      if not quiet:
+        printc.warning("Deleting \"" + full_path + "\" seams dangerous! Use --force to force deletion (use at your own risks!)", script_name=script_name)
+      return
+
+  # Handle asterisks
+  paths_to_remove = glob.glob(full_path)
+
+  # Check if the lis is empty
+  if not paths_to_remove:
+    if verbose:
+      printc.warning("Path \"" + full_path + "\" does not exist or is not accessible.", script_name=script_name)
+    return
+
+  # Remove path
+  for p in paths_to_remove:
+    try:
+      if os.path.isfile(p) or os.path.islink(p):
+        os.remove(p)
+        if not quiet:
+          printc.say("Removed \"" + p + "\" (file)", script_name=script_name)
+      elif os.path.isdir(p):
+        shutil.rmtree(p)
+        if not quiet:
+          printc.say("Removed \"" + p + "\" (directory)", script_name=script_name)
+      else:
+        if verbose:
+          printc.warning("Path \"" + p + "\" does not exist or is not accessible.", script_name=script_name)
+    except Exception as e:
+      printc.error("Failed to remove \"" + p + "\".", script_name=script_name)
+      printc.cyan("error details: ", end="", script_name=script_name)
+      print(str(e))
+
+######################################
+# Clean
+######################################
+
+def clean(settings_filename, force=False, verbose=False, quiet=False):
+  if not os.path.isfile(settings_filename):
+    if not quiet:
+      printc.note("There is no clean settings file \"" + settings_filename + "\" in \"" + os.path.realpath(".") + "\". Using default Odatix clean settings file", script_name)
+    settings_filename = os.path.join(OdatixSettings.odatix_path, OdatixSettings.DEFAULT_CLEAN_SETTINGS_FILE)
+    if not os.path.isfile(settings_filename):
+      printc.error("There is no default Odatix clean settings file \"" + settings_filename, script_name)
+      sys.exit(-1)
+  with open(settings_filename, "r") as f:
+    try:
+      settings_data = yaml.load(f, Loader=yaml.loader.SafeLoader)
+    except Exception as e:
+      printc.error("Settings file \"" + settings_filename + "\" is not a valid YAML file", script_name)
+      printc.cyan("error details: ", end="", script_name=script_name)
+      print(str(e))
+      sys.exit(-1)
+    try:
+      remove_list = read_from_list("remove_list", settings_data, settings_filename, script_name=script_name)
+    except (KeyNotInListError, BadValueInListError):
+      sys.exit(-1)
+
+    if not isinstance(remove_list, list):
+      printc.error("\"remove_list\" from settings file \"" + settings_filename + "\" is not a list", script_name)
+      printc.note("Are you missing dashes (-)?", script_name)
+      sys.exit(-1)
+
+    for path in remove_list:
+      remove_path(path, force, verbose, quiet)
+
+######################################
+# Main
+######################################
+
+def main(args):
+  clean(
+    settings_filename=args.input,
+    force=args.force,
+    verbose=args.verbose,
+    quiet=args.quiet
+  )
+
+if __name__ == "__main__":
+  args = parse_arguments()
+  main(args)

odatix-3.0.1/odatix/components/export_benchmark.py

@@ -0,0 +1,176 @@
+# ********************************************************************** #
+#                                Odatix                                  #
+# ********************************************************************** #
+#
+# Copyright (C) 2022 Jonathan Saussereau
+#
+# This file is part of Odatix.
+# Odatix is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Odatix is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Odatix. If not, see <https://www.gnu.org/licenses/>.
+#
+
+import os
+import re
+import sys
+import yaml
+import argparse
+
+from odatix.lib.settings import OdatixSettings
+import odatix.lib.re_helper as rh
+import odatix.lib.printc as printc
+
+######################################
+# Settings
+######################################
+
+DEFAULT_BENCHMARK = "dhrystone"
+DEFAULT_SIM_FILE = "log/sim.log"
+
+status_done = 'Done: 100%'
+
+script_name = os.path.basename(__file__)
+
+dmips_per_mhz_pattern = re.compile("(.*)DMIPS_Per_MHz: ([0-9.]+)")
+bad_value = None
+
+######################################
+# Parse Arguments
+######################################
+
+def add_arguments(parser):
+  parser.add_argument('-b', '--benchmark', default=DEFAULT_BENCHMARK, help='benchmark to parse (default: ' + DEFAULT_BENCHMARK + ')')
+  parser.add_argument('-S', '--sim_file', default=DEFAULT_SIM_FILE, help='simulation log file (default: ' + DEFAULT_SIM_FILE + ')')
+  parser.add_argument('-B', '--benchmark_file', help='output benchmark file')
+  parser.add_argument('-w', '--work', help='simulation work directory')
+  parser.add_argument('-c', '--config', default=OdatixSettings.DEFAULT_SETTINGS_FILE, help='global settings file for Odatix (default: ' + OdatixSettings.DEFAULT_SETTINGS_FILE + ')')
+
+def parse_arguments():
+  parser = argparse.ArgumentParser(description='Process benchmark results')
+  add_arguments(parser)
+  return parser.parse_args()
+
+######################################
+# Misc functions
+######################################
+
+def corrupted_directory(variant):
+  printc.warning(variant + " => synthesis has not finished or directory has been corrupted", script_name)
+
+def safe_cast(val, to_type, default=None):
+  try:
+      return to_type(val)
+  except (ValueError, TypeError):
+      return default
+
+######################################
+# Parsing functions
+######################################
+
+def get_dmips_per_mhz(file):
+  return rh.get_re_group_from_file(file, dmips_per_mhz_pattern, group_id=2)
+
+######################################
+# Format functions
+######################################
+
+def cast_to_int(input):
+  if input == bad_value:
+    return '/'
+  else:
+    return safe_cast(input, int, 0)
+
+def cast_to_float(input):
+  if input == bad_value:
+    return '/'
+  else:
+    return safe_cast(input, float, 0.0)
+
+def write_to_yaml(input, sim_file, output_file):
+  yaml_data = {}
+
+  for arch in sorted(next(os.walk(input))[1]):
+    yaml_data[arch] = {}
+    for variant in sorted(next(os.walk(os.path.join(input, arch)))[1]):
+      cur_path = os.path.join(input, arch, variant)
+      cur_sim_file = os.path.join(cur_path, sim_file)
+
+      if not os.path.exists(cur_sim_file):
+        corrupted_directory(arch + '/' + variant)
+        continue
+
+      dmips_per_mhz = get_dmips_per_mhz(cur_sim_file)
+      dmips_per_mhz = cast_to_float(dmips_per_mhz) if dmips_per_mhz != ' /  ' else ""
+      yaml_data[arch][variant] = {
+        'DMIPS_per_MHz': dmips_per_mhz,
+      }
+
+  output_path = os.path.dirname(output_file)
+  if not os.path.exists(output_path):
+    os.makedirs(output_path, exist_ok=True)
+  try:
+    with open(output_file, 'w') as file:
+      yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
+      printc.say("Results written to \"" + output_file + "\"", script_name=script_name)
+  except Exception as e:
+    printc.error("Could not write results to \"" + output_file + "\"", script_name=script_name)
+    printc.cyan("error details: ", end="", script_name=script_name)
+    print(str(e))
+
+######################################
+# Export Results
+######################################
+
+def export_benchmark(input, output, benchmark, sim_file):
+  print(printc.colors.CYAN + "Export " +  benchmark + " results" + printc.colors.ENDC)
+  input = os.path.join(input, benchmark)
+  if not os.path.isdir(input):
+    printc.error("input directory \"" + input + "\" does not exist", script_name)
+    sys.exit(1)
+
+  #if format in ['yml']:
+  write_to_yaml(input, sim_file, output)
+
+  print()
+
+######################################
+# Main
+######################################
+
+def main(args, settings=None):
+
+  # Get settings
+  if settings is None:
+    settings = OdatixSettings(args.config)
+    if not settings.valid:
+      sys.exit(-1)
+
+  if args.benchmark_file is not None:
+    benchmark_file  = args.benchmark_file
+  else:
+    benchmark_file = settings.benchmark_file
+
+  if args.work is not None:
+    work = args.work
+  else:
+    work = settings.sim_work_path
+
+  export_benchmark(
+    input=work,
+    output=benchmark_file,
+    benchmark=args.benchmark,
+    sim_file=args.sim_file
+  )
+
+if __name__ == "__main__":
+  args = parse_arguments()
+  main(args)