OpenSTA/include/sta/ClkNetwork.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 <map>

#include "GraphClass.hh"
#include "NetworkClass.hh"
#include "SdcClass.hh"
#include "StaState.hh"

namespace sta {

using PinClksMap = std::map<const Pin*, ClockSet>;
using ClkPinsMap = std::map<const Clock *, PinSet*>;

class Sta;

// Find clock network pins.
class ClkNetwork : public StaState
{
public:
  ClkNetwork(Mode *mode,
             StaState *sta);
  ~ClkNetwork() override;
  void ensureClkNetwork();
  void clear();
  bool isClock(const Pin *pin) const;
  bool isClock(const Vertex *vertex) const;
  bool isClock(const Net *net) const;
  bool isIdealClock(const Pin *pin) const;
  bool isIdealClock(const Vertex *vertex) const;
  bool isPropagatedClock(const Pin *pin) const;
  const ClockSet *clocks(const Pin *pin) const;
  const ClockSet *clocks(const Vertex *vertex) const;
  const ClockSet *idealClocks(const Pin *pin) const;
  const PinSet *pins(const Clock *clk);
  void clkPinsInvalid();
  float idealClkSlew(const Pin *pin,
                     const RiseFall *rf,
                     const MinMax *min_max) const;

protected:
  void deletePinBefore(const Pin *pin);
  void connectPinAfter(const Pin *pin);
  void disconnectPinBefore(const Pin *pin);
  friend class Sta;

private:
  Mode *mode_;

  void findClkPins();
  void findClkPins(bool ideal_only,
                   PinClksMap &pin_clks_map);

  bool clk_pins_valid_{false};
  // pin -> clks
  PinClksMap pin_clks_map_;
  // pin -> ideal clks
  PinClksMap pin_ideal_clks_map_;
  // clock -> pins
  ClkPinsMap clk_pins_map_;
};

} // namespace sta