Difficulties building OpenROAD locally on M1 Pro Mac

[CooperDeng]

Hello guys, was trying to build OpenROAD locally on my M1 (Pro, not sure if it makes a difference) Mac, but was running into some difficulties in installing dependencies.

Was doing the following commands:

(base) [my_userid] OpenROAD % ./etc/DependencyInstaller.sh: ./etc/DependencyInstaller.sh

The output was really weird, specifically indicating how there were syntax inssues within my soplex module (output attached)
output.txt

I have tried reinstalling soplex module but it did not work either, also the lemon-graph module installation is kinda funky (cannot be installed ude to the same error).

Plus here is an attachement for outptu from my brew doctor command.
doctor_output.txt

Any help is appreciated, thanks a lot!

Update:

Tried the commands below:

brew untap the-openroad-project/lemon-graph
brew tap the-openroad-project/lemon-graph
brew reinstall lemon-graph

Ended up with the following output by reinstalling lemon-graph:

brew reinstall lemon-graph
==> Fetching the-openroad-project/lemon-graph/lemon-graph
==> Downloading https://github.com/The-OpenROAD-Project/lemon-graph/archive
Already downloaded: /Users/cooperdeng/Library/Caches/Homebrew/downloads/8cd49562d55d98cf2eee71a84193ad5d47cbb5285d6682f8252b3e921b1dec2e--lemon-graph-1.3.1.tar.gz
==> Reinstalling the-openroad-project/lemon-graph/lemon-graph 
==> cmake -B build .
==> cmake --build build -j --target install
Last 15 lines from /Users/cooperdeng/Library/Logs/Homebrew/lemon-graph/02.cmake:
In file included from /opt/homebrew/include/boost/lexical_cast.hpp:30:
/opt/homebrew/include/boost/lexical_cast/detail/buffer_view.hpp:27:34: error: expected '(' for function-style cast or type construction
   27 |         return buffer_view<CharT>{begin, end};
      |                ~~~~~~~~~~~~~~~~~~^
/opt/homebrew/include/boost/lexical_cast/detail/buffer_view.hpp:31:33: error: expected '(' for function-style cast or type construction
   31 |         return buffer_view<char>{
      |                ~~~~~~~~~~~~~~~~~^
/opt/homebrew/include/boost/lexical_cast/detail/buffer_view.hpp:38:33: error: expected '(' for function-style cast or type construction
   38 |         return buffer_view<char>{
      |                ~~~~~~~~~~~~~~~~~^
fatal error: too many errors emitted, stopping now [-ferror-limit=]
20 errors generated.
make[2]: *** [lemon/CMakeFiles/lemon.dir/soplex.cc.o] Error 1
make[1]: *** [lemon/CMakeFiles/lemon.dir/all] Error 2
make: *** [all] Error 2

If reporting this issue please do so at (not Homebrew/brew or Homebrew/homebrew-core):
  https://github.com/the-openroad-project/homebrew-lemon-graph/issues

[stefanottili]

DependencyInstaller worked just a couple of days ago for me (M1 MacBook).
Faild today.

brew reinstall lemon-graph
==> Fetching the-openroad-project/lemon-graph/lemon-graph
==> Downloading https://github.com/The-OpenROAD-Project/lemon-graph/archive/refs/tags/1.3.1.tar.gz
==> Downloading from https://codeload.github.com/The-OpenROAD-Project/lemon-graph/tar.gz/refs/tags/1.3.1
            -=O=-              #          #            #             #                                                                                                                     
Error: SHA256 mismatch
Expected: ff00cc1b7aafd8481bf8a1b13303de79ec4dec485e41c807f9e95f369b917d78
  Actual: f829a87c357b193a97987293030cb086b8fc7ef000eac24899efd3b822f383d8
    File: .../Library/Caches/Homebrew/downloads/8cd49562d55d98cf2eee71a84193ad5d47cbb5285d6682f8252b3e921b1dec2e--lemon-graph-1.3.1.tar.gz
To retry an incomplete download, remove the file above.

In case you get that to work, here are the three things I needed to get OR to compile:

1. since I don't know how to install tclreadline with homebrew I had to comment out TCLRL_VERSION_STR in src/Main.cc
   385 set path [file join $folder "tclreadline)" //TCLRL_VERSION_STR
2. a recent commit broke the compile on M1, works if this commit is reverted
   https://github.com/The-OpenROAD-Project/OpenROAD/commit/5f20e59807e0dc647c48afb75a9450bbf799da8f
   git revert -m 1 5f20e59
3. OR doesn't compile with the default tcl-tk 9.0, use 'brew install tcl-tk@8; brew link tcl-tk@8' to get tcl-tk 8.6
   MacOS brew upgrade: tcl-tk 9.0 breaks compile/linking #6139

[stefanottili]

6. the compile issue with boost 1.87 was fixed by in boost 1.87 io_service has been removed, use io_context instead #6373

[CooperDeng]

Thanks, I tried updating to the latest commit of OR but still hitting no luck.

Terminal Saved Output.txt

Here is a dump of my terminal output, which I have tried installing lemon-graph standalone. It is still giving the same errors, specifically, could this be a result of downloading from

==> Downloading https://github.com/The-OpenROAD-Project/lemon-graph/archive/refs/tags/1.3.1.tar.gz

Below is the output of DependencyInstaller.sh:

Dependencyinstaller output.txt

[stefanottili]

A local "git clone" of the openroad lemon-graph repository can be built on M1 when disabling soplex.
@maliberty gave the all important hint.

cmake -DLEMON_ENABLE_SOPLEX=FALSE -B build .

What's needed now is a hint on how to disable soplex when installing lemon-graph using the DependencyInstaller.sh.

[stefanottili]

The formula to install lemon-graph with brew has been updated.
The DependencyInstaller.sh works on apple silicon macOS for me.
Please give it a try.
https://github.com/The-OpenROAD-Project/homebrew-lemon-graph

[maliberty]

Thanks @stefanottili for figuring this out!

[stefanottili]

4. as of the 2nd week of Jan 2025 I get a link error in src/odb/test/cpp/OdbGTests
   I've disabled compiling tests and got openroad to build.
   There might be a more elegant way of doing this, I just commented out line 28 in src/odb/CMakeLists.txt

27 if(ENABLE_TESTS)
28 #  add_subdirectory(test)
29 endif()

[maliberty]

What is the error?

[stefanottili]

with regard to 4. the error is

[ 80%] Linking CXX executable OdbGTests
Undefined symbols for architecture arm64:
  "testing::internal::MakeAndRegisterTestInfo(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, char const*, char const*, char const*, testing::internal::CodeLocation, void const*, void (*)(), void (*)(), testing::internal::TestFactoryBase*)", referenced from:
      __GLOBAL__sub_I_TestDbWire.cc in TestDbWire.cc.o
      __GLOBAL__sub_I_TestDbWire.cc in TestDbWire.cc.o
      __GLOBAL__sub_I_TestAbstractLef.cc in TestAbstractLef.cc.o
      __GLOBAL__sub_I_TestAbstractLef.cc in TestAbstractLef.cc.o
      __GLOBAL__sub_I_TestAbstractLef.cc in TestAbstractLef.cc.o
ld: symbol(s) not found for architecture arm64
clang++: error: linker command failed with exit code 1 (use -v to see invocation)
make[2]: *** [src/odb/test/cpp/OdbGTests] Error 1
make[1]: *** [src/odb/test/cpp/CMakeFiles/OdbGTests.dir/all] Error 2
make[1]: *** Waiting for unfinished jobs....

When I uninstall lemon-graph, I also get the compile error related to a boost include that @CooperDeng reported at the start of this discussion.

[QuantamHD]

I'm pretty sure this is a googletest linking error.

rant: @maliberty really wish we could go back to not relying on system deps...

[stefanottili]

7. As of Jan 30th 2025 115dd78 the compile failed without flex/include, worked before and works when setting the CMAKE_INCLUDE_PATH.

export CMAKE_INCLUDE_PATH="/opt/homebrew/opt/flex/include"
export CMAKE_LIBRARY_PATH="/opt/homebrew/opt/flex/lib;/opt/homebrew/opt/bison/lib"
export PATH="$(brew --prefix bison)/bin:$(brew --prefix flex)/bin:$(brew --prefix tcl-tk)/bin:${PATH}"

[tnguy19]

Thanks for the response. I checked and my cmake version is 4.1.2. Should I downgrade cmake, or is there another workaround?

[maliberty]

I'm not sure where the cmake < 3.5 is coming from I'm using 3.31.9 fwiw. Do you see which dependency has that requirement? It might be that it could be moved forward.

[tnguy19]

The error is with the lemongraph dependency when I install with Homebrew using the command
./etc/DependencyInstaller.sh -all

This is the error message from the log:

[INFO] Installing lemon-graph...... ✖
==> Auto-updating Homebrew...
Adjust how often this is run with `$HOMEBREW_AUTO_UPDATE_SECS` or disable with
`$HOMEBREW_NO_AUTO_UPDATE=1`. Hide these hints with `$HOMEBREW_NO_ENV_HINTS=1` (see `man brew`).
==> Fetching downloads for: lemon-graph
==> Fetching the-openroad-project/lemon-graph/lemon-graph
==> Downloading https://github.com/The-OpenROAD-Project/lemon-graph/archive/refs/tags/1.3.1.tar.gz
Already downloaded: /Users/nguyenphucthinh/Library/Caches/Homebrew/downloads/8cd49562d55d98cf2eee71a84193ad5d47cbb5285d6682f8252b3e921b1dec2e--lemon-graph-1.3.1.tar.gz
==> Installing lemon-graph from the-openroad-project/lemon-graph
==> cmake -B build -DLEMON_ENABLE_SOPLEX=FALSE .
Last 15 lines from /Users/nguyenphucthinh/Library/Logs/Homebrew/lemon-graph/01.cmake.log:
-DLEMON_ENABLE_SOPLEX=FALSE
-DCMAKE_INSTALL_PREFIX=/opt/homebrew/Cellar/lemon-graph/1.3.1
.

CMake Error at CMakeLists.txt:1 (CMAKE_MINIMUM_REQUIRED):
  Compatibility with CMake < 3.5 has been removed from CMake.

  Update the VERSION argument <min> value.  Or, use the <min>...<max> syntax
  to tell CMake that the project requires at least <min> but has been updated
  to work with policies introduced by <max> or earlier.

  Or, add -DCMAKE_POLICY_VERSION_MINIMUM=3.5 to try configuring anyway.


-- Configuring incomplete, errors occurred!

[maliberty]

Try changing https://github.com/The-OpenROAD-Project/lemon-graph/blob/f871b10396270cfd09ffddc4b6ead07722e9c232/CMakeLists.txt#L1 to a later version and see if that works.

[tnguy19]

Hello,
So I manually changed the lemon-graph dependency file CMakeList.txt file line 1 CMAKE_MINIMUM_REQUIRED(VERSION 2.8) to CMAKE_MINIMUM_REQUIRED(VERSION 3.10) and deleted line 3 CMAKE_POLICY(SET CMP0048 OLD) and installed the file manually.

I was able to run DependencyInstaller.sh successfully.
However later when I run cmake.. in the build directory I got the following errors:

-- TCL header: TCL_HEADER-NOTFOUND
-- Found OpenMP: TRUE (found version "5.1")
-- Found OpenMP: TRUE (found version "5.1")
-- QT5 not found. GUI is disabled
-- Could NOT find VTune (missing: VTune_LIBRARIES VTune_INCLUDE_DIRS) 
-- TCL library: TCL_LIBRARY-NOTFOUND
-- TCL header: TCL_HEADER-NOTFOUND
CMake Error at /opt/homebrew/lib/cmake/Boost-1.89.0/BoostConfig.cmake:141 (find_package):
  Could not find a package configuration file provided by "boost_system"
  (requested version 1.89.0) with any of the following names:

    boost_systemConfig.cmake
    boost_system-config.cmake

  Add the installation prefix of "boost_system" to CMAKE_PREFIX_PATH or set
  "boost_system_DIR" to a directory containing one of the above files.  If
  "boost_system" provides a separate development package or SDK, be sure it
  has been installed.
Call Stack (most recent call first):
  /opt/homebrew/lib/cmake/Boost-1.89.0/BoostConfig.cmake:262 (boost_find_component)
  src/dst/CMakeLists.txt:12 (find_package)

-- Configuring incomplete, errors occurred!

I have tried brew link tcl-tk and it shows that i was successfully linked and I have also set the environment variables for PATH and CMAKE_PREFIX_PATH. My tcl-tk version is stable 9.0.2 and my boost version is stable 1.89.0.

[stefanottili]

These four workarounds work for me on macOS Tahoe using a MacBook M1

brew uninstall --ignore-dependencies [email protected]
brew install [email protected]
brew link [email protected]

ln -s /opt/homebrew/opt/tcl-tk@8 /opt/homebrew/opt/tcl-tk

Manually linking tcl-tk@8 is clearly just a "hack", there has to be a better way to deal with both tcl-tk@8 and @9 installed.
This link interferes with brew and has to be undone for other "brew install .." to work.

Add the following lines around the "add_compile_options" in src/CMakeList.txt:165 to be able to compile/link

link_directories(/opt/homebrew/opt/zstd/lib)
link_directories(/opt/homebrew/opt/icu4c/lib)
link_directories(/opt/homebrew/opt/yaml-cpp/lib)

add_compile_options(
  -D_GNU_SOURCE

run cmake with the option to disable the tests, they don't link against gtest.

cd build
cmake -DENABLE_TESTS=OFF ..
make -j8 install

[tnguy19]

Thanks for all the help. I tried the workarounds and was able to resolve the Boost and TCl library issues, but got new errors with cudd and other dependencies at around 61% of the build.
I have since switched to using Ubuntu on a Windows laptop, and the installation worked smoothly there. I will continue with that setup instead.
Thanks again for your time!

[stefanottili]

Don't give up, you're so close.

I ran the DependencyInstaller a while back and since then "just" had to add a few (cudd, yaml-cpp, zlib come to mind) packages "by hand". All packages needed to build OpenROAD are installed via brew.