OpenSTA/liberty/TableModel.hh

462 lines
12 KiB
C++

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2019, Parallax Software, Inc.
//
// This program 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.
//
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
#ifndef STA_TABLE_MODEL_H
#define STA_TABLE_MODEL_H
#include <string>
#include "DisallowCopyAssign.hh"
#include "MinMax.hh"
#include "Vector.hh"
#include "Transition.hh"
#include "LibertyClass.hh"
#include "TimingModel.hh"
namespace sta {
using std::string;
class Unit;
class Units;
class Report;
class Table;
TableAxisVariable
stringTableAxisVariable(const char *variable);
const char *
tableVariableString(TableAxisVariable variable);
const Unit *
tableVariableUnit(TableAxisVariable variable,
const Units *units);
class GateTableModel : public GateTimingModel
{
public:
GateTableModel(TableModel *delay_model,
TableModel *delay_sigma_models[EarlyLate::index_count],
TableModel *slew_model,
TableModel *slew_sigma_models[EarlyLate::index_count]);
virtual ~GateTableModel();
virtual void gateDelay(const LibertyCell *cell,
const Pvt *pvt,
float in_slew,
float load_cap,
float related_out_cap,
bool pocv_enabled,
// Return values.
ArcDelay &gate_delay,
Slew &drvr_slew) const;
virtual void reportGateDelay(const LibertyCell *cell,
const Pvt *pvt,
float in_slew,
float load_cap,
float related_out_cap,
bool pocv_enabled,
int digits,
string *result) const;
virtual float driveResistance(const LibertyCell *cell,
const Pvt *pvt) const;
const TableModel *delayModel() const { return delay_model_; }
const TableModel *slewModel() const { return slew_model_; }
// Check the axes before making the model.
// Return true if the model axes are supported.
static bool checkAxes(const Table *table);
protected:
void maxCapSlew(const LibertyCell *cell,
float in_slew,
const Pvt *pvt,
float &slew,
float &cap) const;
virtual void setIsScaled(bool is_scaled);
float axisValue(TableAxis *axis,
float load_cap,
float in_slew,
float related_out_cap) const;
float findValue(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
const TableModel *model,
float in_slew,
float load_cap,
float related_out_cap) const;
void reportTableLookup(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
const TableModel *model,
float in_slew,
float load_cap,
float related_out_cap,
int digits,
string *result) const;
void findAxisValues(const TableModel *model,
float in_slew,
float load_cap,
float related_out_cap,
// Return values.
float &axis_value1,
float &axis_value2,
float &axis_value3) const;
void deleteSigmaModels(TableModel *models[EarlyLate::index_count]);
static bool checkAxis(TableAxis *axis);
TableModel *delay_model_;
TableModel *delay_sigma_models_[EarlyLate::index_count];
TableModel *slew_model_;
TableModel *slew_sigma_models_[EarlyLate::index_count];
private:
DISALLOW_COPY_AND_ASSIGN(GateTableModel);
};
class CheckTableModel : public CheckTimingModel
{
public:
explicit CheckTableModel(TableModel *model);
virtual ~CheckTableModel();
virtual void checkDelay(const LibertyCell *cell,
const Pvt *pvt,
float from_slew,
float to_slew,
float related_out_cap,
bool pocv_enabled,
// Return values.
ArcDelay &margin) const;
virtual void reportCheckDelay(const LibertyCell *cell,
const Pvt *pvt,
float from_slew,
const char *from_slew_annotation,
float to_slew,
float related_out_cap,
bool pocv_enabled,
int digits,
string *result) const;
// Check the axes before making the model.
// Return true if the model axes are supported.
static bool checkAxes(const Table *table);
protected:
virtual void setIsScaled(bool is_scaled);
float findValue(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
const TableModel *model,
float from_slew,
float to_slew,
float related_out_cap) const;
void findAxisValues(float from_slew,
float to_slew,
float related_out_cap,
// Return values.
float &axis_value1,
float &axis_value2,
float &axis_value3) const;
float axisValue(TableAxis *axis,
float load_cap,
float in_slew,
float related_out_cap) const;
void reportTableDelay(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
const TableModel *model,
float from_slew,
const char *from_slew_annotation,
float to_slew,
float related_out_cap,
int digits,
string *result) const;
static bool checkAxis(TableAxis *axis);
TableModel *model_;
TableModel *sigma_models_[EarlyLate::index_count];
private:
DISALLOW_COPY_AND_ASSIGN(CheckTableModel);
};
// Wrapper class for Table to apply scale factors.
class TableModel
{
public:
TableModel(Table *table,
ScaleFactorType scale_factor_type,
TransRiseFall *tr);
~TableModel();
void setScaleFactorType(ScaleFactorType type);
int order() const;
TableAxis *axis1() const;
TableAxis *axis2() const;
TableAxis *axis3() const;
void setIsScaled(bool is_scaled);
// Table interpolated lookup.
float findValue(float value1,
float value2,
float value3) const;
// Table interpolated lookup with scale factor.
float findValue(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
float value2,
float value3) const;
void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const;
void report(const Units *units,
Report *report) const;
protected:
float scaleFactor(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt) const;
void reportPvtScaleFactor(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
int digits,
string *result) const;
Table *table_;
// ScaleFactorType gcc barfs if this is dcl'd.
unsigned scale_factor_type_:scale_factor_bits;
unsigned tr_index_:TransRiseFall::index_bit_count;
bool is_scaled_:1;
private:
DISALLOW_COPY_AND_ASSIGN(TableModel);
};
// Abstract base class for tables.
class Table
{
public:
Table() {}
virtual ~Table() {}
void setScaleFactorType(ScaleFactorType type);
virtual int order() const = 0;
virtual TableAxis *axis1() const { return nullptr; }
virtual TableAxis *axis2() const { return nullptr; }
virtual TableAxis *axis3() const { return nullptr; }
void setIsScaled(bool is_scaled);
// Table interpolated lookup.
virtual float findValue(float value1,
float value2,
float value3) const = 0;
// Table interpolated lookup with scale factor.
float findValue(const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
float value2,
float value3) const;
virtual void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const = 0;
virtual void report(const Units *units,
Report *report) const = 0;
private:
DISALLOW_COPY_AND_ASSIGN(Table);
};
// Zero dimension (scalar) table.
class Table0 : public Table
{
public:
Table0(float value);
virtual int order() const { return 0; }
virtual float findValue(float value1,
float value2,
float value3) const;
virtual void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const;
virtual void report(const Units *units,
Report *report) const;
using Table::findValue;
private:
DISALLOW_COPY_AND_ASSIGN(Table0);
float value_;
};
// One dimensional table.
class Table1 : public Table
{
public:
Table1(FloatSeq *values,
TableAxis *axis1,
bool own_axis1);
virtual ~Table1();
virtual int order() const { return 1; }
virtual TableAxis *axis1() const { return axis1_; }
float tableValue(size_t index1) const;
virtual float findValue(float value1,
float value2,
float value3) const;
virtual void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const;
virtual void report(const Units *units,
Report *report) const;
using Table::findValue;
private:
DISALLOW_COPY_AND_ASSIGN(Table1);
FloatSeq *values_;
TableAxis *axis1_;
bool own_axis1_;
};
// Two dimensional table.
class Table2 : public Table
{
public:
Table2(FloatTable *values,
TableAxis *axis1,
bool own_axis1,
TableAxis *axis2,
bool own_axis2);
virtual ~Table2();
virtual int order() const { return 2; }
TableAxis *axis1() const { return axis1_; }
TableAxis *axis2() const { return axis2_; }
float tableValue(size_t index1,
size_t index2) const;
virtual float findValue(float value1,
float value2,
float value3) const;
virtual void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const;
virtual void report(const Units *units,
Report *report) const;
using Table::findValue;
protected:
DISALLOW_COPY_AND_ASSIGN(Table2);
FloatTable *values_;
// Row.
TableAxis *axis1_;
bool own_axis1_;
// Column.
TableAxis *axis2_;
bool own_axis2_;
};
// Three dimensional table.
class Table3 : public Table2
{
public:
Table3(FloatTable *values,
TableAxis *axis1,
bool own_axis1,
TableAxis *axis2,
bool own_axis2,
TableAxis *axis3,
bool own_axis3);
virtual ~Table3();
virtual int order() const { return 3; }
TableAxis *axis3() const { return axis3_; }
float tableValue(size_t index1,
size_t index2,
size_t index3) const;
virtual float findValue(float value1,
float value2,
float value3) const;
virtual void reportValue(const char *result_name,
const LibertyLibrary *library,
const LibertyCell *cell,
const Pvt *pvt,
float value1,
const char *comment1,
float value2,
float value3,
int digits,
string *result) const;
virtual void report(const Units *units,
Report *report) const;
using Table::findValue;
private:
DISALLOW_COPY_AND_ASSIGN(Table3);
TableAxis *axis3_;
bool own_axis3_;
};
class TableAxis
{
public:
TableAxis(TableAxisVariable variable,
FloatSeq *values);
~TableAxis();
TableAxisVariable variable() const { return variable_; }
size_t size() const { return values_->size(); }
float axisValue(size_t index) const { return (*values_)[index]; }
// Find the index for value such that axis[index] <= value < axis[index+1].
size_t findAxisIndex(float value) const;
private:
DISALLOW_COPY_AND_ASSIGN(TableAxis);
TableAxisVariable variable_;
FloatSeq *values_;
};
} // namespace
#endif