OpenSTA/include/sta/PowerClass.hh

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, 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/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#pragma once

#include <utility>
#include <vector>

namespace sta {

class Power;
class Instance;

enum class PwrActivityOrigin
{
 global,
 input,
 user,
 vcd,
 saif,
 propagated,
 clock,
 constant,
 unknown
};

class PwrActivity
{
public:
  PwrActivity() = default;
  PwrActivity(float density,
              float duty,
              PwrActivityOrigin origin);
  void init();
  float density() const { return density_; }
  void setDensity(float density);
  float duty() const { return duty_; }
  void setDuty(float duty);
  PwrActivityOrigin origin() const { return origin_; }
  void setOrigin(PwrActivityOrigin origin);
  const std::string &originName() const;
  void set(float density,
           float duty,
           PwrActivityOrigin origin);
  bool isSet() const;

private:
  void check();

  float density_{0.0};          // transitions / second
  float duty_{0.0};             // probability signal is high
  PwrActivityOrigin origin_{PwrActivityOrigin::unknown};

  static constexpr float min_density = 1E-10;
};

class PowerResult
{
public:
  PowerResult() = default;
  void clear();
  float internal() const { return internal_; }
  float switching() const { return switching_; }
  float leakage() const { return leakage_; }
  float total() const;
  void incr(PowerResult &result);
  void incrInternal(float pwr);
  void incrSwitching(float pwr);
  void incrLeakage(float pwr);

private:
  float internal_{0.0};
  float switching_{0.0};
  float leakage_{0.0};
};

using InstPower = std::pair<const Instance*, PowerResult>;
using InstPowers = std::vector<InstPower>;

} // namespace sta