najaeda 0.1.6__cp312-cp312-macosx_11_0_arm64.whl → 0.1.8__cp312-cp312-macosx_11_0_arm64.whl

najaeda/stats.py

@@ -0,0 +1,320 @@
+# SPDX-FileCopyrightText: 2024 The Naja authors <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+from najaeda import netlist
+
+
+class DesignsStats:
+    def __init__(self):
+        self.blackboxes = dict()
+        self.hier_designs = dict()
+
+
+class DesignStats:
+    def __init__(self):
+        self.name = ""
+        self.assigns = 0
+        self.flat_assigns = 0
+        self.basic_primitives = dict()
+        self.primitives = dict()
+        self.flat_basic_primitives = dict()
+        self.flat_primitives = dict()
+        self.blackboxes = dict()
+        self.flat_blackboxes = dict()
+        self.ins = dict()
+        self.flat_ins = dict()
+        self.terms = dict()
+        self.bit_terms = dict()
+        self.net_stats = dict()
+
+    def add_ins_stats(self, ins_stats):
+        self.flat_assigns += ins_stats.flat_assigns
+        for ins, nb in ins_stats.flat_ins.items():
+            self.flat_ins[ins] = self.flat_ins.get(ins, 0) + nb
+        for ins, nb in ins_stats.flat_blackboxes.items():
+            self.flat_blackboxes[ins] = self.flat_blackboxes.get(ins, 0) + nb
+        for primitive, nb in ins_stats.flat_primitives.items():
+            self.flat_primitives[primitive] = (
+                self.flat_primitives.get(primitive, 0) + nb
+            )
+        for primitive, nb in ins_stats.flat_basic_primitives.items():
+            self.flat_basic_primitives[primitive] = (
+                self.flat_basic_primitives.get(primitive, 0) + nb
+            )
+
+
+def is_basic_primitive(design):
+    return (
+        design.is_const0() or design.is_const1() or design.is_buf() or design.is_inv()
+    )
+
+
+def compute_design_stats(design, designs_stats):
+    if design.get_model_id() in designs_stats.hier_designs:
+        return designs_stats.hier_designs.get(design.get_model_id())
+    design_stats = DesignStats()
+    design_stats.name = design.get_model_name()
+    for ins in design.get_child_instances():
+        model_id = ins.get_model_id()
+        if ins.is_assign():
+            design_stats.assigns += 1
+            design_stats.flat_assigns += 1
+        elif ins.is_primitive():
+            if is_basic_primitive(ins):
+                design_stats.basic_primitives[model_id] = (
+                    design_stats.basic_primitives.get(model_id, 0) + 1
+                )
+                design_stats.flat_basic_primitives[model_id] = (
+                    design_stats.flat_basic_primitives.get(model_id, 0) + 1
+                )
+            else:
+                design_stats.primitives[model_id] = (
+                    design_stats.primitives.get(model_id, 0) + 1
+                )
+                design_stats.flat_primitives[model_id] = (
+                    design_stats.flat_primitives.get(model_id, 0) + 1
+                )
+        elif ins.is_blackbox():
+            design_stats.blackboxes[model_id] = (
+                design_stats.blackboxes.get(model_id, 0) + 1
+            )
+            design_stats.flat_blackboxes[model_id] = (
+                design_stats.flat_blackboxes.get(model_id, 0) + 1
+            )
+            if model_id not in designs_stats.blackboxes:
+                designs_stats.blackboxes[model_id] = dict()
+                compute_design_terms(model_id, designs_stats.blackboxes[model_id])
+        else:
+            if model_id in designs_stats.hier_designs:
+                model_stats = designs_stats.hier_designs[model_id]
+            else:
+                model_stats = compute_design_stats(ins, designs_stats)
+            design_stats.ins[model_id] = design_stats.ins.get(model_id, 0) + 1
+            design_stats.flat_ins[model_id] = design_stats.flat_ins.get(model_id, 0) + 1
+            design_stats.add_ins_stats(model_stats)
+    compute_design_terms(design, design_stats)
+    compute_design_net_stats(design, design_stats)
+    designs_stats.hier_designs[design.get_model_id()] = design_stats
+    return design_stats
+
+
+def compute_design_terms(design, design_stats):
+    for term in design.get_terms():
+        if term.get_direction() == netlist.Term.INPUT:
+            design_stats.terms["inputs"] = design_stats.terms.get("inputs", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["inputs"] = (
+                design_stats.bit_terms.get("inputs", 0) + bit_terms
+            )
+        elif term.get_direction() == netlist.Term.OUTPUT:
+            design_stats.terms["outputs"] = design_stats.terms.get("outputs", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["outputs"] = (
+                design_stats.bit_terms.get("outputs", 0) + bit_terms
+            )
+        elif term.get_direction() == netlist.Term.INOUT:
+            design_stats.terms["inouts"] = design_stats.terms.get("inouts", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["inouts"] = (
+                design_stats.bit_terms.get("inouts", 0) + bit_terms
+            )
+        else:
+            design_stats.terms["unknowns"] = design_stats.terms.get("unknowns", 0) + 1
+            bit_terms = sum(1 for _ in term.get_bits())
+            design_stats.bit_terms["unknowns"] = (
+                design_stats.bit_terms.get("unknowns", 0) + bit_terms
+            )
+
+
+def compute_design_net_stats(design, design_stats):
+    for net in design.get_flat_nets():
+        if net.is_const():
+            pass
+        nb_components = sum(1 for c in net.get_terms())
+        design_stats.net_stats[nb_components] = (
+            design_stats.net_stats.get(nb_components, 0) + 1
+        )
+        design_stats.net_stats = dict(sorted(design_stats.net_stats.items()))
+
+
+def dump_instances(stats_file, title, instances):
+    if len(instances) == 0:
+        return
+    sorted_instances = sorted(
+        instances.items(), key=lambda item: netlist.get_model_name(item[0])
+    )
+    stats_file.write(title + " " + str(sum(j for i, j in sorted_instances)) + "\n")
+    line_char = 0
+    for instance in sorted_instances:
+        model_name = netlist.get_model_name(instance[0])
+        if line_char != 0:
+            stats_file.write(",")
+            line_char += 1
+        if line_char > 80:
+            stats_file.write("\n")
+            line_char = 0
+        elif line_char != 0:
+            stats_file.write(" ")
+            line_char += 1
+        instance_char = model_name + ":" + str(instance[1])
+        line_char += len(instance_char)
+        stats_file.write(instance_char)
+    stats_file.write("\n\n")
+
+
+def dump_blackboxes_stats(stats_file, design_stats):
+    if len(design_stats.blackboxes) > 0:
+        stats_file.write("*** BlackBoxes ***\n")
+        for bbox in design_stats.blackboxes.items():
+            design = bbox[0]
+            design_terms = bbox[1]
+            stats_file.write("*** " + design.getName() + " ***\n")
+            if len(design_terms) > 0:
+                stats_file.write("Terms: ")
+                first = True
+                for terms in design_terms.items():
+                    if not first:
+                        stats_file.write(", ")
+                    else:
+                        first = False
+                    stats_file.write(terms[0] + ":" + str(terms[1]))
+                stats_file.write("\n")
+            stats_file.write("\n")
+
+
+def dump_stats(design, stats_file, designs_stats, dumped_models):
+    if design.is_primitive() or design.is_blackbox():
+        return
+    if design in dumped_models:
+        return
+    dumped_models.add(design)
+    stats_file.write("*** " + design.get_name() + " ***\n")
+    design_stats = designs_stats.hier_designs.get(design.get_model_id())
+    if design_stats is None:
+        print("Cannot find " + str(design) + " in design_stats")
+        raise
+    if len(design_stats.terms) > 0:
+        stats_file.write("Terms: ")
+        first = True
+        for terms in design_stats.terms.items():
+            if not first:
+                stats_file.write(", ")
+            else:
+                first = False
+            stats_file.write(terms[0] + ":" + str(terms[1]))
+        stats_file.write("\n")
+
+    dump_instances(stats_file, "Instances:", design_stats.ins)
+    nb_primitives = sum(design_stats.basic_primitives.values()) + sum(
+        design_stats.primitives.values()
+    )
+    if nb_primitives > 1:
+        stats_file.write("Primitives: " + str(nb_primitives) + "\n")
+    dump_instances(stats_file, "Simple Primitives:", design_stats.basic_primitives)
+    dump_instances(stats_file, "Other Primitives:", design_stats.primitives)
+    dump_instances(stats_file, "Blackboxes:", design_stats.blackboxes)
+    if design_stats.assigns > 0:
+        stats_file.write("Assigns: " + str(design_stats.assigns) + "\n")
+    dump_instances(stats_file, "Flat Instances:", design_stats.flat_ins)
+    dump_instances(stats_file, "Flat Blackboxes:", design_stats.flat_blackboxes)
+    nb_primitives = sum(design_stats.flat_basic_primitives.values()) + sum(
+        design_stats.flat_primitives.values()
+    )
+    if nb_primitives > 1:
+        stats_file.write("Flat Primitives: " + str(nb_primitives) + "\n")
+    dump_instances(
+        stats_file, "Flat Simple Primitives:", design_stats.flat_basic_primitives
+    )
+    dump_instances(stats_file, "Flat Other Primitives:", design_stats.flat_primitives)
+    if design_stats.flat_assigns > 0:
+        stats_file.write("Flat Assigns: " + str(design_stats.flat_assigns) + "\n")
+    stats_file.write("\n")
+    for ins in design.get_child_instances():
+        dump_stats(ins, stats_file, designs_stats, dumped_models)
+
+
+# def dump_pandas(designs_stats):
+#  import pandas
+#  import matplotlib.pyplot as plt
+#
+#  #create a figures directory erase the previous one
+#  if os.path.exists('figures'):
+#    import shutil
+#    shutil.rmtree('figures')
+#  os.makedirs('figures')
+#
+#  data = []
+#  for design, design_stats in designs_stats.hier_designs.items():
+#    data.append([
+#      design.getName(),
+#      sum(design_stats.terms.values()),
+#      sum(design_stats.bit_terms.values()),
+#      sum(design_stats.basic_primitives.values()),
+#      sum(design_stats.primitives.values()),
+#      sum(design_stats.blackboxes.values()),
+#      sum(design_stats.ins.values()),
+#      sum(design_stats.flat_ins.values()),
+#      sum(design_stats.flat_blackboxes.values()),
+#      sum(design_stats.flat_basic_primitives.values()),
+#      sum(design_stats.flat_primitives.values())])
+#  df = pandas.DataFrame(data, columns=[
+#    'Design', 'Terms', 'Bit Terms',
+#    'Basic Primitives', 'Primitives', 'Blackboxes', 'Instances',
+#    'Flat Instances', 'Flat Blackboxes',
+#    'Flat Basic Primitives', 'Flat Primitives'])
+#  df.to_csv('figures/designs_stats.csv', index=False)
+#
+#  net_series = pandas.Series(design_stats.net_stats)
+#  nets_plot = net_series.plot(kind='bar',
+#      title='Number of nets with a given number of components for\n' + design.getName(),
+#      xlabel='number of components', ylabel='number of nets')
+#  nets_plot.set_yscale('log')
+#  nets_plot.xaxis.set_major_locator(plt.MaxNLocator(100))
+#  nets_figure = nets_plot.get_figure()
+#  nets_figure.tight_layout()
+#  nets_figure.savefig('figures/nets_' + design.getName() + '.png')
+#
+#  flat_primitives_series = pandas.Series(design_stats.flat_primitives)
+#  primitives_plot = flat_primitives_series.plot(kind='bar',
+#                  title='Number of  primitives for\n' + design.getName(),
+#                  xlabel='primitive', ylabel='number of flat instances')
+#  primitives_plot.set_yscale('log')
+#  primitives_figure = primitives_plot.get_figure()
+#  primitives_figure.tight_layout()
+#  primitives_figure.savefig('figures/flat_primitives_' + design.getName() + '.png')
+
+
+def compute_and_dump_design_stats(design, stats_file, with_pandas=False):
+    designs_stats = DesignsStats()
+    compute_design_stats(design, designs_stats)
+    dumped_models = set()
+    dump_stats(design, stats_file, designs_stats, dumped_models)
+    dump_blackboxes_stats(stats_file, designs_stats)
+    # if with_pandas:
+    #   dump_pandas(designs_stats)
+
+
+def dump_constants(design, analyzed_models):
+    if design.isPrimitive():
+        return
+    if design in analyzed_models:
+        return
+    analyzed_models.add(design)
+    for bitnet in design.getBitNets():
+        if bitnet.isConstant():
+            message = f"In design {design.getName()}, \
+                    constant net {bitnet.getName()} \
+                    of type {bitnet.getTypeAsString()}"
+            logging.info(message)
+            if all(False for _ in bitnet.getComponents()):
+                logging.info(" with zero connections\n")
+            else:
+                logging.info(" connected to:\n")
+                for component in bitnet.getComponents():
+                    logging.info(str(component) + "\n")
+
+    for ins in design.getInstances():
+        model = ins.getModel()
+        dump_constants(model, analyzed_models)

{najaeda-0.1.6.dist-info → najaeda-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: najaeda
-Version: 0.1.6
+Version: 0.1.8
 Summary: Naja EDA Python package
 Author-Email: Naja Authors <contact@keplertech.io>
 License: Apache License 2.0
@@ -54,6 +54,11 @@ Install Naja EDA using pip:
 
     pip install najaeda
 
+Documentation
+-------------
+
+Naja EDA online documentation is available `here <https://najaeda.readthedocs.io/en/latest/index.html>`_.
+
 Examples
 --------
 
@@ -92,7 +97,7 @@ easily extended in the future. Don't hesitate to reach out if you need help.
 
     netlist.load_primitives('xilinx')
     benchmarks = path.join('..','benchmarks')
-    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'arm_core_netlist.v')])
+    top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'vexriscv.v')])
 
 Print all the instances in the netlist
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -144,6 +149,37 @@ This specific use case shows how to count the number of leaf instances in a netl
     print(f"nb constants={leaves['constants']}")
     print(f"nb other leaves={leaves['count']}")
 
+DLE (Dead Logic Elimination)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This example demonstrates how to perform Dead Logic Elimination (DLE) on a netlist.
+
+.. code-block:: python
+
+    def apply_dle(top):
+        # Trace back from design outputs
+        visited = set()
+        output_terms = top.get_flat_output_terms()
+        for termToTrace in output_terms:
+            queue = deque([termToTrace])
+            while queue:
+                term = queue.popleft()
+                if term in visited:
+                    continue
+                visited.add(term)
+                equipotential = term.get_equipotential()
+                leaf_drivers = equipotential.get_leaf_drivers()
+                for driver in leaf_drivers:
+                    instance = driver.get_instance()
+                    instances.add(instance)
+                    input_terms = instance.get_flat_input_terms()
+                    queue.extend(input_terms)
+        
+        leaf_children = top.get_leaf_children()
+        to_delete = [leaf for leaf in leaf_children if leaf not in instances]
+        for leaf in to_delete:
+            leaf.delete()
+        return to_delete
+
 Documentation
 -------------
 Naja EDA is a work in progress, and the documentation is still under development.

najaeda-0.1.8.dist-info/RECORD

@@ -0,0 +1,25 @@
+najaeda-0.1.8.dist-info/RECORD,,
+najaeda-0.1.8.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
+najaeda-0.1.8.dist-info/METADATA,sha256=Gs7f1HbI7hS--g6TbdjGTvnIa85u8WDsmFnAHdslz2g,6880
+najaeda-0.1.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.1.8.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
+najaeda/netlist.py,sha256=xcn-v5Vhjt1di8yDJV5T9SKpKIkyXKRnodBzP50RiCw,37044
+najaeda/libnaja_snl_python.dylib,sha256=rrnm_iwb4e4P9AWHpz3mJTkIeFvAI32_okrVfZoz_0E,808208
+najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/libnaja_snl.dylib,sha256=AFqR64aX6KnzkX6lrLGCuscx2f5E07umNC_7E9cNrT0,574272
+najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
+najaeda/stats.py,sha256=9taIJ2ns8E8W_Cm9xThq9-S6Gr6TMPb7qLTJPfx4jFk,12891
+najaeda/instance_visitor.py,sha256=2HnQ5y8-0tSOKd9nS4WYiypccQWLJgKfs84wp357Tls,1781
+najaeda/docs/requirements.txt,sha256=1XIBGTIplm2arC9HhDCfLuAjozGdVSXkqmOj8ybuT6U,121
+najaeda/docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
+najaeda/docs/make.bat,sha256=L4I5T7uDUIjwGyMRJ-y9FoT61sxIyCuaYuJyLt8c-nA,804
+najaeda/docs/.readthedocs.yaml,sha256=TL2hK9gR25hw-7_gMeywIqBikAP0mVPRB-O4wGfrdPU,900
+najaeda/docs/source/index.rst,sha256=nYkctDLuoue7UMQi5gV-PARChvJDb_3P4e_9NTqzJtc,367
+najaeda/docs/source/instance.rst,sha256=uqyHR7dN9po3sN_APC3C8vk7W2MT0ca49memgtFpzCk,517
+najaeda/docs/source/conf.py,sha256=GIJ89oFBSXucgDBXLcyyWC-cU_lC3GvfswnmLxm9pVM,1387
+najaeda/docs/source/term.rst,sha256=Xh4xis6lR_Oe26Qm3vCt7ziU3PR0cKBBGO8OmCHWt0M,341
+najaeda/docs/source/net.rst,sha256=QNkCZp1bp8_h_fUcf4jwPF4DByZmMtiSb56gOki0wSI,331
+najaeda/docs/source/equipotential.rst,sha256=1wG1sbwexs9JhxxSY2z9XucsLE0SfopVK7VIty0r3mw,431
+najaeda/docs/source/api.rst,sha256=P_-1jiVrIajvFCqP1Wx2W1l6a4T2RHXlWG00rls1qF0,159
+najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947

najaeda-0.1.6.dist-info/RECORD

@@ -1,18 +0,0 @@
-najaeda/netlist.py,sha256=Lg0JHaYD1xJl-tOFxdUorkev8TonBP8RNqDnxViOsxg,25751
-najaeda/libnaja_snl_python.dylib,sha256=B-L2hEAoNpBVgg5DVp0jXNPkDZfyGZ9UC6e_CZcIyYw,740160
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/libnaja_snl.dylib,sha256=8Ei7KKU0b14IqlvH_8yQSSCpH0rjbxpeRaXgyfSemMY,574112
-najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
-najaeda/instance_visitor.py,sha256=2HnQ5y8-0tSOKd9nS4WYiypccQWLJgKfs84wp357Tls,1781
-najaeda/docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
-najaeda/docs/make.bat,sha256=L4I5T7uDUIjwGyMRJ-y9FoT61sxIyCuaYuJyLt8c-nA,804
-najaeda/docs/source/index.rst,sha256=VBWfJySZ9v8mWfWt3kuSCZh7Gp0zUrFjXGQH7tZZfy0,323
-najaeda/docs/source/conf.py,sha256=3qkykCg12ZYqawHl8VEg2Fti6rc3G-soGYM0L6zL3CU,1387
-najaeda/docs/source/api.rst,sha256=H2Bw0JmHS9z-NhQARepmH74wsWHzjSVPbeXppSmtgCQ,141
-najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947
-najaeda-0.1.6.dist-info/RECORD,,
-najaeda-0.1.6.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
-najaeda-0.1.6.dist-info/METADATA,sha256=BNHiU6acY0ppMEC7I66Q34H4oDDalUoepVBas2Oqr5E,5608
-najaeda-0.1.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.1.6.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377