Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions docs/contrib/CodingPractices.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ needs.
// or writing it.
#include <odb/defout.h>
#include <odb/lefin.h>
#include "db_sta/dbNetwork.hh"
#include "db_sta/dbSta.hh"
#include "src/dbSta/include/db_sta/dbNetwork.hh"
#include "src/dbSta/include/db_sta/dbSta.hh"
```

Note this example also incorrectly uses `<>'s` around OpenROAD headers.
Expand Down Expand Up @@ -383,7 +383,7 @@ reduce the code the compiler has to process.
``` cpp
class Network;
// instead of
#include "Network.hh"
#include "src/sta/include/sta/Network.hh"
```

### Practice #25
Expand Down
4 changes: 2 additions & 2 deletions docs/getPatch.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ def swap_prefix(file, old, new):
# modify ../src/OpenROAD.cc
swap_prefix(
"../src/OpenRoad.cc",
'#include "utl/MakeLogger.h"',
'#include "utl/MakeLogger.h"\n#include "tool/MakeTool.hh"',
'#include "src/utl/include/utl/MakeLogger.h"',
'#include "src/utl/include/utl/MakeLogger.h"\n#include "tool/MakeTool.hh"',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The added include #include "tool/MakeTool.hh" should be updated to use a fully qualified path, consistent with the rest of the refactoring (e.g., src/tool/include/tool/MakeTool.hh). If the include paths are restricted to the root directory, this relative path will likely cause build failures.

Suggested change
'#include "src/utl/include/utl/MakeLogger.h"\n#include "tool/MakeTool.hh"',
'#include "src/utl/include/utl/MakeLogger.h"\n#include "src/tool/include/tool/MakeTool.hh"',

)

swap_prefix(
Expand Down
10 changes: 5 additions & 5 deletions include/ord/Timing.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
#include <utility>
#include <vector>

#include "sta/Clock.hh"
#include "sta/Graph.hh"
#include "sta/PatternMatch.hh"
#include "sta/Sdc.hh"
#include "sta/SdcClass.hh"
#include "src/sta/include/sta/Clock.hh"
#include "src/sta/include/sta/Graph.hh"
#include "src/sta/include/sta/PatternMatch.hh"
#include "src/sta/include/sta/Sdc.hh"
#include "src/sta/include/sta/SdcClass.hh"

namespace odb {
class dbMaster;
Expand Down
22 changes: 11 additions & 11 deletions src/Design.cc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2022-2025, The OpenROAD Authors

#include "ord/Design.h"
#include "include/ord/Design.h"

#include <algorithm>
#include <cmath>
Expand All @@ -13,18 +13,18 @@
#include "absl/base/attributes.h"
#include "absl/base/const_init.h"
#include "absl/synchronization/mutex.h"
#include "ant/AntennaChecker.hh"
#include "db_sta/dbNetwork.hh"
#include "db_sta/dbSta.hh"
#include "grt/GlobalRouter.h"
#include "ifp/InitFloorplan.hh"
#include "odb/db.h"
#include "ord/OpenRoad.hh"
#include "ord/Tech.h"
#include "sta/Sta.hh"
#include "include/ord/OpenRoad.hh"
#include "include/ord/Tech.h"
#include "src/ant/include/ant/AntennaChecker.hh"
#include "src/dbSta/include/db_sta/dbNetwork.hh"
#include "src/dbSta/include/db_sta/dbSta.hh"
#include "src/grt/include/grt/GlobalRouter.h"
#include "src/ifp/include/ifp/InitFloorplan.hh"
#include "src/odb/include/odb/db.h"
#include "src/sta/include/sta/Sta.hh"
#include "src/utl/include/utl/Logger.h"
#include "tcl.h"
#include "tclDecls.h"
#include "utl/Logger.h"

namespace ord {

Expand Down
6 changes: 3 additions & 3 deletions src/Exception-py.i
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#include <sstream>

#include "boost/stacktrace/stacktrace.hpp"
#include "utl/Logger.h"
#include "src/utl/include/utl/Logger.h"
%}
#else
%{
Expand All @@ -17,8 +17,8 @@
#include <sstream>

#include "boost/stacktrace/stacktrace.hpp"
#include "ord/OpenRoad.hh"
#include "utl/Logger.h"
#include "include/ord/OpenRoad.hh"
#include "src/utl/include/utl/Logger.h"
%}
#endif

Expand Down
4 changes: 2 additions & 2 deletions src/Exception.i
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
#include <sstream>

#include "boost/stacktrace/stacktrace.hpp"
#include "ord/OpenRoad.hh"
#include "utl/Logger.h"
#include "include/ord/OpenRoad.hh"
#include "src/utl/include/utl/Logger.h"
%}

%exception {
Expand Down
24 changes: 12 additions & 12 deletions src/Main.cc
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@
#include <tclExtend.h>
#endif

#include "cut/abc_init.h"
#include "gui/gui.h"
#include "ord/Design.h"
#include "ord/InitOpenRoad.hh"
#include "ord/OpenRoad.hh"
#include "ord/Tech.h"
#include "sta/StaMain.hh"
#include "sta/StringUtil.hh"
#include "utl/Logger.h"
#include "utl/decode.h"
#include "web/web.h"
#include "include/ord/Design.h"
#include "include/ord/InitOpenRoad.hh"
#include "include/ord/OpenRoad.hh"
#include "include/ord/Tech.h"
#include "src/cut/include/cut/abc_init.h"
#include "src/gui/include/gui/gui.h"
#include "src/sta/include/sta/StaMain.hh"
#include "src/sta/include/sta/StringUtil.hh"
#include "src/utl/include/utl/Logger.h"
#include "src/utl/include/utl/decode.h"
#include "src/web/include/web/web.h"

#ifdef BAZEL_CURRENT_REPOSITORY
#include "bazel/tcl_library_init.h"
#endif

#include "tcl_readline_setup.h"
#include "src/tcl_readline_setup.h"

using sta::findCmdLineFlag;
using sta::findCmdLineKey;
Expand Down
10 changes: 5 additions & 5 deletions src/OpenRoad-py.i
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

%{

#include "odb/db.h"
#include "ord/Tech.h"
#include "ord/Design.h"
#include "ord/Timing.h"
#include "ifp/InitFloorplan.hh"
#include "src/odb/include/odb/db.h"
#include "include/ord/Tech.h"
#include "include/ord/Design.h"
#include "include/ord/Timing.h"
#include "src/ifp/include/ifp/InitFloorplan.hh"

using odb::dbDatabase;
using odb::dbBlock;
Expand Down
146 changes: 73 additions & 73 deletions src/OpenRoad.cc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2019-2025, The OpenROAD Authors

#include "ord/OpenRoad.hh"
#include "include/ord/OpenRoad.hh"

#include <cstdlib>
#include <cstring>
Expand All @@ -13,85 +13,85 @@
#include <thread>
#include <vector>

#include "ord/Version.hh"
#include "include/ord/Version.hh"
#include "tcl.h"
#include "tclDecls.h"
#ifdef ENABLE_PYTHON3
#define PY_SSIZE_T_CLEAN
#include "Python.h"
#endif

#include "ant/AntennaChecker.hh"
#include "ant/MakeAntennaChecker.hh"
#include "cgt/ClockGating.h"
#include "cgt/MakeClockGating.h"
#include "cts/MakeTritoncts.h"
#include "cts/TritonCTS.h"
#include "db_sta/MakeDbSta.hh"
#include "db_sta/dbNetwork.hh"
#include "db_sta/dbReadVerilog.hh"
#include "db_sta/dbSta.hh"
#include "dft/Dft.hh"
#include "dft/MakeDft.hh"
#include "dpl/MakeOpendp.h"
#include "dpl/Opendp.h"
#include "drt/MakeTritonRoute.h"
#include "drt/TritonRoute.h"
#include "dst/Distributed.h"
#include "dst/MakeDistributed.h"
#include "est/EstimateParasitics.h"
#include "est/MakeEstimateParasitics.h"
#include "exa/MakeExample.h"
#include "exa/example.h"
#include "fin/Finale.h"
#include "fin/MakeFinale.h"
#include "gpl/MakeReplace.h"
#include "gpl/Replace.h"
#include "grt/GlobalRouter.h"
#include "grt/MakeGlobalRouter.h"
#include "gui/MakeGui.h"
#include "ifp/MakeInitFloorplan.hh"
#include "mpl/MakeMacroPlacer.h"
#include "mpl/rtl_mp.h"
#include "odb/3dblox.h"
#include "odb/MakeOdb.h"
#include "odb/cdl.h"
#include "odb/db.h"
#include "odb/defin.h"
#include "odb/defout.h"
#include "odb/lefin.h"
#include "odb/lefout.h"
#include "ord/InitOpenRoad.hh"
#include "pad/MakeICeWall.h"
#include "par/MakePartitionMgr.h"
#include "par/PartitionMgr.h"
#include "pdn/MakePdnGen.hh"
#include "pdn/PdnGen.hh"
#include "ppl/IOPlacer.h"
#include "ppl/MakeIoplacer.h"
#include "psm/MakePDNSim.hh"
#include "psm/pdnsim.h"
#include "ram/MakeRam.h"
#include "ram/ram.h"
#include "rcx/MakeOpenRCX.h"
#include "rcx/ext.h"
#include "rmp/MakeRestructure.h"
#include "rmp/Restructure.h"
#include "rsz/MakeResizer.hh"
#include "rsz/Resizer.hh"
#include "sta/VerilogReader.hh"
#include "stt/MakeSteinerTreeBuilder.h"
#include "tap/MakeTapcell.h"
#include "tap/tapcell.h"
#include "upf/MakeUpf.h"
#include "utl/Logger.h"
#include "utl/MakeLogger.h"
#include "utl/Progress.h"
#include "utl/ScopedTemporaryFile.h"
#include "utl/ServiceRegistry.h"
#include "utl/decode.h"
#include "web/MakeWeb.h"
#include "web/web.h"
#include "include/ord/InitOpenRoad.hh"
#include "src/ant/include/ant/AntennaChecker.hh"
#include "src/ant/include/ant/MakeAntennaChecker.hh"
#include "src/cgt/include/cgt/ClockGating.h"
#include "src/cgt/include/cgt/MakeClockGating.h"
#include "src/cts/include/cts/MakeTritoncts.h"
#include "src/cts/include/cts/TritonCTS.h"
#include "src/dbSta/include/db_sta/MakeDbSta.hh"
#include "src/dbSta/include/db_sta/dbNetwork.hh"
#include "src/dbSta/include/db_sta/dbReadVerilog.hh"
#include "src/dbSta/include/db_sta/dbSta.hh"
#include "src/dft/include/dft/Dft.hh"
#include "src/dft/include/dft/MakeDft.hh"
#include "src/dpl/include/dpl/MakeOpendp.h"
#include "src/dpl/include/dpl/Opendp.h"
#include "src/drt/include/drt/MakeTritonRoute.h"
#include "src/drt/include/drt/TritonRoute.h"
#include "src/dst/include/dst/Distributed.h"
#include "src/dst/include/dst/MakeDistributed.h"
#include "src/est/include/est/EstimateParasitics.h"
#include "src/est/include/est/MakeEstimateParasitics.h"
#include "src/exa/include/exa/MakeExample.h"
#include "src/exa/include/exa/example.h"
#include "src/fin/include/fin/Finale.h"
#include "src/fin/include/fin/MakeFinale.h"
#include "src/gpl/include/gpl/MakeReplace.h"
#include "src/gpl/include/gpl/Replace.h"
#include "src/grt/include/grt/GlobalRouter.h"
#include "src/grt/include/grt/MakeGlobalRouter.h"
#include "src/gui/include/gui/MakeGui.h"
#include "src/ifp/include/ifp/MakeInitFloorplan.hh"
#include "src/mpl/include/mpl/MakeMacroPlacer.h"
#include "src/mpl/include/mpl/rtl_mp.h"
#include "src/odb/include/odb/3dblox.h"
#include "src/odb/include/odb/MakeOdb.h"
#include "src/odb/include/odb/cdl.h"
#include "src/odb/include/odb/db.h"
#include "src/odb/include/odb/defin.h"
#include "src/odb/include/odb/defout.h"
#include "src/odb/include/odb/lefin.h"
#include "src/odb/include/odb/lefout.h"
#include "src/pad/include/pad/MakeICeWall.h"
#include "src/par/include/par/MakePartitionMgr.h"
#include "src/par/include/par/PartitionMgr.h"
#include "src/pdn/include/pdn/MakePdnGen.hh"
#include "src/pdn/include/pdn/PdnGen.hh"
#include "src/ppl/include/ppl/IOPlacer.h"
#include "src/ppl/include/ppl/MakeIoplacer.h"
#include "src/psm/include/psm/MakePDNSim.hh"
#include "src/psm/include/psm/pdnsim.h"
#include "src/ram/include/ram/MakeRam.h"
#include "src/ram/include/ram/ram.h"
#include "src/rcx/include/rcx/MakeOpenRCX.h"
#include "src/rcx/include/rcx/ext.h"
#include "src/rmp/include/rmp/MakeRestructure.h"
#include "src/rmp/include/rmp/Restructure.h"
#include "src/rsz/include/rsz/MakeResizer.hh"
#include "src/rsz/include/rsz/Resizer.hh"
#include "src/sta/include/sta/VerilogReader.hh"
#include "src/stt/include/stt/MakeSteinerTreeBuilder.h"
#include "src/tap/include/tap/MakeTapcell.h"
#include "src/tap/include/tap/tapcell.h"
#include "src/upf/include/upf/MakeUpf.h"
#include "src/utl/include/utl/Logger.h"
#include "src/utl/include/utl/MakeLogger.h"
#include "src/utl/include/utl/Progress.h"
#include "src/utl/include/utl/ScopedTemporaryFile.h"
#include "src/utl/include/utl/ServiceRegistry.h"
#include "src/utl/include/utl/decode.h"
#include "src/web/include/web/MakeWeb.h"
#include "src/web/include/web/web.h"

namespace ord {
extern const char* ord_tcl_inits[];
Expand Down
20 changes: 10 additions & 10 deletions src/OpenRoad.i
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@

%{

#include "odb/db.h"
#include "odb/defout.h"
#include "sta/Report.hh"
#include "sta/Network.hh"
#include "db_sta/dbSta.hh"
#include "db_sta/dbNetwork.hh"
#include "db_sta/dbReadVerilog.hh"
#include "utl/Logger.h"
#include "ord/OpenRoad.hh"
#include "odb/util.h"
#include "src/odb/include/odb/db.h"
#include "src/odb/include/odb/defout.h"
#include "src/sta/include/sta/Report.hh"
#include "src/sta/include/sta/Network.hh"
#include "src/dbSta/include/db_sta/dbSta.hh"
#include "src/dbSta/include/db_sta/dbNetwork.hh"
#include "src/dbSta/include/db_sta/dbReadVerilog.hh"
#include "src/utl/include/utl/Logger.h"
#include "include/ord/OpenRoad.hh"
#include "src/odb/include/odb/util.h"

#include <thread>
#include <vector>
Expand Down
18 changes: 9 additions & 9 deletions src/Tech.cc
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2022-2025, The OpenROAD Authors

#include "ord/Tech.h"
#include "include/ord/Tech.h"

#include <string>

#include "db_sta/dbNetwork.hh"
#include "db_sta/dbSta.hh"
#include "odb/db.h"
#include "ord/OpenRoad.hh"
#include "sta/Liberty.hh"
#include "sta/MinMax.hh"
#include "sta/Scene.hh"
#include "sta/Units.hh"
#include "include/ord/OpenRoad.hh"
#include "src/dbSta/include/db_sta/dbNetwork.hh"
#include "src/dbSta/include/db_sta/dbSta.hh"
#include "src/odb/include/odb/db.h"
#include "src/sta/include/sta/Liberty.hh"
#include "src/sta/include/sta/MinMax.hh"
#include "src/sta/include/sta/Scene.hh"
#include "src/sta/include/sta/Units.hh"
#include "tcl.h"

namespace ord {
Expand Down
Loading