Merge remote-tracking branch 'upstream/master' into gpl-instance-removal

Author: gudeh

bazel/tcl_encode_or.bzl

@@ -13,6 +13,7 @@ def _tcl_encode_or_impl(ctx):
     output_file = ctx.actions.declare_file(outfile_name)
 
     args = ctx.actions.args()
+    args.add(ctx.executable._encode_script)
     args.add_all("--inputs", ctx.files.srcs)
     args.add("--output", output_file)
     args.add("--varname", ctx.attr.char_array_name)
@@ -22,8 +23,8 @@ def _tcl_encode_or_impl(ctx):
         outputs = [output_file],
         inputs = ctx.files.srcs,
         arguments = [args],
-        #tools = [ctx.executable._tclsh, ctx.file._encode_script],
-        executable = ctx.executable._encode_script,
+        tools = [ctx.executable._encode_script],
+        executable = ctx.toolchains["@rules_python//python:toolchain_type"].py3_runtime.interpreter,
     )
     return [DefaultInfo(files = depset([output_file]))]
 
@@ -53,4 +54,5 @@ tcl_encode = rule(
             cfg = "exec",
         ),
     },
+    toolchains = ["@rules_python//python:toolchain_type"],
 )

src/dbSta/include/db_sta/dbSta.hh

@@ -25,7 +25,6 @@ namespace sta {
 class dbSta;
 class dbNetwork;
 class dbStaReport;
-class dbStaHistogram;
 class dbStaCbk;
 class PatternMatch;
 class TestCell;

src/dbSta/src/dbSta.cc

@@ -44,6 +44,7 @@
 #include "sta/StaMain.hh"
 #include "sta/Units.hh"
 #include "utl/Logger.h"
+#include "utl/histogram.h"
 
 ////////////////////////////////////////////////////////////////
 
@@ -151,36 +152,6 @@ class dbStaReport : public sta::ReportTcl
   Logger* logger_ = nullptr;
 };
 
-// Helper class for histogram reporting.
-class dbStaHistogram
-{
- public:
-  dbStaHistogram(Sta* sta, dbNetwork* network, Logger* logger);
-
-  // Loads data_ with the slack value for each constrained endpoint.
-  void loadSlackData(const MinMax* min_max);
-  // Loads data_ with the logic depth for each constrained endpoint.
-  void loadLogicDepthData(bool exclude_buffers, bool exclude_inverters);
-  // Populates bins_ using the current data_, which must be loaded first.
-  void populateHistogramBins(int num_bins);
-  // Prints the histogram to the log. Width and precision are used to control
-  // the number of digits when displaying each bin's range.
-  void reportHistogram(int width, int precision) const;
-
- private:
-  std::vector<float> data_;
-  // Bins are defined in bins_ as equally sized windows of width bin_width_
-  // starting with smallest value min_val_ at the start of bin 0.
-  std::vector<int> bins_;
-  float min_val_ = 0.0;
-  float bin_width_ = 0.0;
-  bool integer_bins_ = false;  // Enforce int bin width (for discrete metrics).
-
-  Sta* sta_;
-  dbNetwork* network_;
-  Logger* logger_;
-};
-
 class dbStaCbk : public dbBlockCallBackObj
 {
  public:
@@ -680,28 +651,28 @@ void dbSta::reportCellUsage(odb::dbModule* module,
   }
 }
 
-dbStaHistogram::dbStaHistogram(Sta* sta, dbNetwork* network, Logger* logger)
-    : sta_(sta), network_(network), logger_(logger)
+void dbSta::reportTimingHistogram(int num_bins, const MinMax* min_max) const
 {
-}
+  utl::Histogram<float> histogram(logger_);
 
-void dbStaHistogram::loadSlackData(const MinMax* min_max)
-{
-  data_.clear();
   sta::Unit* time_unit = sta_->units()->timeUnit();
   for (sta::Vertex* vertex : *sta_->endpoints()) {
     float slack = sta_->vertexSlack(vertex, min_max);
     if (slack != sta::INF) {  // Ignore unconstrained paths.
-      data_.push_back(time_unit->staToUser(slack));
+      histogram.addData(time_unit->staToUser(slack));
     }
   }
-  integer_bins_ = false;
+
+  histogram.generateBins(num_bins);
+  histogram.report(/*precision=*/3);
 }
 
-void dbStaHistogram::loadLogicDepthData(bool exclude_buffers,
-                                        bool exclude_inverters)
+void dbSta::reportLogicDepthHistogram(int num_bins,
+                                      bool exclude_buffers,
+                                      bool exclude_inverters) const
 {
-  data_.clear();
+  utl::Histogram<int> histogram(logger_);
+
   sta_->worstSlack(MinMax::max());  // Update timing.
   for (sta::Vertex* vertex : *sta_->endpoints()) {
     int path_length = 0;
@@ -710,103 +681,22 @@ void dbStaHistogram::loadLogicDepthData(bool exclude_buffers,
     while (path) {
       Pin* pin = path->vertex(sta_)->pin();
       Instance* sta_inst = sta_->cmdNetwork()->instance(pin);
-      dbInst* inst = network_->staToDb(sta_inst);
+      dbInst* inst = db_network_->staToDb(sta_inst);
       if (!network_->isTopLevelPort(pin) && inst != prev_inst) {
         prev_inst = inst;
-        LibertyCell* lib_cell = network_->libertyCell(inst);
+        LibertyCell* lib_cell = db_network_->libertyCell(inst);
         if (lib_cell && (!exclude_buffers || !lib_cell->isBuffer())
             && (!exclude_inverters || !lib_cell->isInverter())) {
           path_length++;
         }
       }
       path = path->prevPath();
     }
-    data_.push_back(path_length);
+    histogram.addData(path_length);
   }
-  integer_bins_ = true;
-}
 
-void dbStaHistogram::populateHistogramBins(int num_bins)
-{
-  if (num_bins <= 0) {
-    logger_->error(STA, 70, "The number of bins must be positive.");
-    return;
-  }
-  if (data_.empty()) {
-    logger_->error(STA, 71, "No data for the histogram has been loaded.");
-    return;
-  }
-  std::sort(data_.begin(), data_.end());
-
-  // Populate each bin with count.
-  bins_.resize(num_bins, 0);
-  min_val_ = data_.front();
-  bin_width_ = (data_.back() - min_val_) / num_bins;
-  if (bin_width_ == 0) {  // Special case for no variation in the data.
-    bins_[0] = data_.size();
-    return;
-  }
-  if (integer_bins_) {
-    bin_width_ = std::ceil(bin_width_);
-  }
-  for (const float& val : data_) {
-    int bin = static_cast<int>((val - min_val_) / bin_width_);
-    if (bin >= num_bins) {  // Special case for val with the maximum value.
-      bin = num_bins - 1;
-    }
-    bins_[bin]++;
-  }
-}
-
-void dbStaHistogram::reportHistogram(int width, int precision) const
-{
-  constexpr int max_bin_width = 50;  // Max number of chars to print for a bin.
-  if (data_.empty()) {
-    logger_->error(STA, 72, "No data for the histogram has been loaded.");
-    return;
-  }
-  const int num_bins = bins_.size();
-  const int largest_bin = *std::max_element(bins_.begin(), bins_.end());
-
-  // Print the histogram.
-  for (int bin = 0; bin < num_bins; ++bin) {
-    const float bin_start = min_val_ + bin * bin_width_;
-    const float bin_end = min_val_ + (bin + 1) * bin_width_;
-    int bar_length  // Round the bar length to its closest value.
-        = (max_bin_width * bins_[bin] + largest_bin / 2) / largest_bin;
-    if (bar_length == 0 && bins_[bin] > 0) {
-      bar_length = 1;  // Better readability when non-zero bins have a bar.
-    }
-    logger_->report("[{:>{}.{}f}, {:>{}.{}f}{}: {} ({})",
-                    bin_start,
-                    width,
-                    precision,
-                    bin_end,
-                    width,
-                    precision,
-                    // The final bin is also closed from the right.
-                    bin == num_bins - 1 ? "]" : ")",
-                    std::string(bar_length, '*'),
-                    bins_[bin]);
-  }
-}
-
-void dbSta::reportTimingHistogram(int num_bins, const MinMax* min_max) const
-{
-  dbStaHistogram histogram(sta_, db_network_, logger_);
-  histogram.loadSlackData(min_max);
-  histogram.populateHistogramBins(num_bins);
-  histogram.reportHistogram(/*width=*/6, /*precision=*/3);
-}
-
-void dbSta::reportLogicDepthHistogram(int num_bins,
-                                      bool exclude_buffers,
-                                      bool exclude_inverters) const
-{
-  dbStaHistogram histogram(sta_, db_network_, logger_);
-  histogram.loadLogicDepthData(exclude_buffers, exclude_inverters);
-  histogram.populateHistogramBins(num_bins);
-  histogram.reportHistogram(/*width=*/3, /*precision=*/0);
+  histogram.generateBins(num_bins);
+  histogram.report();
 }
 
 BufferUse dbSta::getBufferUse(sta::LibertyCell* buffer)

src/dbSta/test/report_logic_depth_histogram.ok

@@ -5,26 +5,26 @@
 [INFO ODB-0132]     Created 2 special nets and 24 connections.
 [INFO ODB-0133]     Created 15 nets and 28 connections.
 report_logic_depth_histogram -num_bins 5
-[  0,   1): ********************************* (2)
-[  1,   2):  (0)
-[  2,   3):  (0)
-[  3,   4): ***************** (1)
-[  4,   5]: ************************************************** (3)
+[0, 1): ********************************* (2)
+[1, 2):  (0)
+[2, 3):  (0)
+[3, 4): ***************** (1)
+[4, 5]: ************************************************** (3)
 report_logic_depth_histogram -num_bins 5 -exclude_buffers
-[  0,   1): ************************************************** (2)
-[  1,   2): ************************* (1)
-[  2,   3): ************************* (1)
-[  3,   4): ************************* (1)
-[  4,   5]: ************************* (1)
+[0, 1): ************************************************** (2)
+[1, 2): ************************* (1)
+[2, 3): ************************* (1)
+[3, 4): ************************* (1)
+[4, 5]: ************************* (1)
 report_logic_depth_histogram -num_bins 5 -exclude_inverters
-[  0,   1): ************************************************** (2)
-[  1,   2): ************************* (1)
-[  2,   3):  (0)
-[  3,   4): ************************* (1)
-[  4,   5]: ************************************************** (2)
+[0, 1): ************************************************** (2)
+[1, 2): ************************* (1)
+[2, 3):  (0)
+[3, 4): ************************* (1)
+[4, 5]: ************************************************** (2)
 report_logic_depth_histogram -num_bins 5 -exclude_buffers -exclude_inverters
-[  0,   1): ************************************************** (2)
-[  1,   2): ************************************************** (2)
-[  2,   3): ************************* (1)
-[  3,   4): ************************* (1)
-[  4,   5]:  (0)
+[0, 1): ************************************************** (2)
+[1, 2): ************************************************** (2)
+[2, 3): ************************* (1)
+[3, 4): ************************* (1)
+[4, 5]:  (0)

src/dbSta/test/report_timing_histogram.ok

@@ -4,22 +4,22 @@
 [INFO ODB-0131]     Created 5 components and 24 component-terminals.
 [INFO ODB-0132]     Created 2 special nets and 10 connections.
 [INFO ODB-0133]     Created 10 nets and 14 connections.
-[ 9.433,  9.516): ************************* (1)
-[ 9.516,  9.600):  (0)
-[ 9.600,  9.684):  (0)
-[ 9.684,  9.767): ************************* (1)
-[ 9.767,  9.851]: ************************************************** (2)
+[9.433, 9.516): ************************* (1)
+[9.516, 9.600):  (0)
+[9.600, 9.684):  (0)
+[9.684, 9.767): ************************* (1)
+[9.767, 9.851]: ************************************************** (2)
 Setup
-[ 9.433,  9.474): ************************* (1)
-[ 9.474,  9.516):  (0)
-[ 9.516,  9.558):  (0)
-[ 9.558,  9.600):  (0)
-[ 9.600,  9.642):  (0)
-[ 9.642,  9.684):  (0)
-[ 9.684,  9.726): ************************* (1)
-[ 9.726,  9.767):  (0)
-[ 9.767,  9.809):  (0)
-[ 9.809,  9.851]: ************************************************** (2)
+[9.433, 9.474): ************************* (1)
+[9.474, 9.516):  (0)
+[9.516, 9.558):  (0)
+[9.558, 9.600):  (0)
+[9.600, 9.642):  (0)
+[9.642, 9.684):  (0)
+[9.684, 9.726): ************************* (1)
+[9.726, 9.767):  (0)
+[9.767, 9.809):  (0)
+[9.809, 9.851]: ************************************************** (2)
 Hold
 [-0.006,  0.026): ************************************************** (2)
 [ 0.026,  0.059):  (0)