Initial checkin for arith-stats plugin.

Signed-off-by: Tim Callahan <[email protected]>

Author: tcal-x

Makefile

@@ -14,7 +14,8 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-PLUGIN_LIST := fasm xdc params sdc ql-iob design_introspection integrateinv ql-qlf systemverilog uhdm dsp-ff
+PLUGIN_LIST := fasm xdc params sdc ql-iob design_introspection \
+	       integrateinv ql-qlf systemverilog uhdm dsp-ff arith-stats
 PLUGINS := $(foreach plugin,$(PLUGIN_LIST),$(plugin).so)
 PLUGINS_INSTALL := $(foreach plugin,$(PLUGIN_LIST),install_$(plugin))
 PLUGINS_CLEAN := $(foreach plugin,$(PLUGIN_LIST),clean_$(plugin))

arith-stats-plugin/Makefile

@@ -0,0 +1,21 @@
+# Copyright 2020-2022 F4PGA Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+CXXFLAGS := -std=c++17
+
+NAME = arith-stats
+SOURCES = arith-stats.cc
+include ../Makefile_plugin.common

arith-stats-plugin/arith-stats.cc

@@ -0,0 +1,84 @@
+#include <stdlib.h>
+
+#include <algorithm>
+#include <string>
+
+#include "kernel/celltypes.h"
+#include "kernel/log.h"
+#include "kernel/register.h"
+#include "kernel/rtlil.h"
+#include "kernel/sigtools.h"
+#include "kernel/yosys.h"
+
+USING_YOSYS_NAMESPACE
+PRIVATE_NAMESPACE_BEGIN
+
+struct ArithStats : public Pass {
+  ArithStats()
+      : Pass("arith_stats",
+             "Print out information about arithmetic operators in design.") {}
+
+  void help() override {
+    //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
+    log("\n");
+    log("    arith_stats\n");
+    log("\n");
+    log("Print out information about arithmetic operators in design.\n");
+    log("\n");
+  }
+
+  void execute(std::vector<std::string> args, RTLIL::Design *design) override {
+    (void)args;  // no args / not used
+    log("Executing 'arith_stats' command.");
+    for (const RTLIL::Module *module : design->selected_modules()) {
+      std::map<RTLIL::IdString, std::map<int, int>> histos_by_type;
+      std::map<RTLIL::IdString, int> tot_counts;
+
+      // === COLLECT data for this module
+      for (const RTLIL::Cell *cell : module->selected_cells()) {
+        if (!cell->type.in(ID($add), ID($sub), ID($neg), ID($alu), ID($fa),
+                           ID($macc), ID($mul), ID($div), ID($lt), ID($le),
+                           ID($gt), ID($ge))) {
+          continue;
+        }
+
+        // Get the width of the arith cell
+        int width = 0;
+        if (cell->type.in(ID($fa))) {
+          width = std::max(width, cell->parameters.at(ID::WIDTH).as_int());
+        } else {
+          width = std::max(width, cell->parameters.at(ID::A_WIDTH).as_int());
+          if (!cell->type.in(ID($neg))) {
+            width = std::max(width, cell->parameters.at(ID::B_WIDTH).as_int());
+          }
+          width = std::max(width, cell->parameters.at(ID::Y_WIDTH).as_int());
+        }
+
+        // update total counts by type
+        const auto typ = cell->type;
+        tot_counts[typ] = (tot_counts.count(typ) ? tot_counts[typ] : 0) + 1;
+
+        // update width historgram
+        auto &histo = histos_by_type[typ];
+        histo[width] = (histo.count(width) ? histo[width] : 0) + 1;
+      }
+
+      // === DISPLAY info for this module
+      if (!histos_by_type.empty()) {
+        log("\nCounting arithmetic cells in module %s:\n",
+            module->name.c_str());
+      }
+      for (const auto &[typ, histo] : histos_by_type) {
+        log("\n%s: total %d instances\n", typ.c_str(), tot_counts[typ]);
+        log("    %10s : %-10s\n", "bitwidth", "count");
+        for (const auto &[width, count] : histo) {
+          log("    %10d : %-10d\n", width, count);
+        }
+      }
+    }
+  }
+};
+
+static struct ArithStats *instance = new struct ArithStats();
+
+PRIVATE_NAMESPACE_END