OpenSTA/include/sta/Debug.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 <string>
#include <cstdarg>
#include <map>
#include <mutex>

#include "StringUtil.hh"

namespace sta {

class Report;
class Pin;

using DebugMap = std::map<std::string, int>;

class Debug
{
public:
  Debug(Report *report);
  int level(const char *what);
  void setLevel(const char *what,
                int level);
  bool check(const char *what,
             int level) const;
  int statsLevel() const { return stats_level_; }
  void reportLine(const char *what,
                  const char *fmt,
                  ...)
    __attribute__((format (printf, 3, 4)));

protected:
  Report *report_;
  std::mutex buffer_lock_;
  bool debug_on_;
  DebugMap debug_map_;
  int stats_level_;
};

// Inlining a varargs function would eval the args, which can
// be expensive, so use a macro.
#define debugPrint(debug, what, level, ...) \
  if (debug->check(what, level)) {  \
    debug->reportLine(what __VA_OPT__(,) __VA_ARGS__); \
  }

} // namespace