Merge remote-tracking branch 'upstream/main' into mux-tree

Author: QinYuan2000

.github/workflows/ci.yml

@@ -10,6 +10,10 @@ on:
   push:
     branches: ["main"]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   check-format:
     runs-on: ubuntu-latest

CMakeLists.txt

@@ -25,11 +25,12 @@ set(CMAKE_CXX_STANDARD_REQUIRED YES)
 if (MSVC)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHs-c- /GR-")
 else ()
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions -fno-rtti")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions -frtti")
 endif ()
 
 include(FindPackageHandleStandardArgs)
 find_package(Python3 3.6 REQUIRED COMPONENTS Interpreter)
+find_package(Boost REQUIRED COMPONENTS)
 
 # Build Dynamatic with ccache if the package is present
 set(DYNAMATIC_CCACHE_BUILD OFF CACHE BOOL "Set to ON for a ccache enabled build")
@@ -143,13 +144,62 @@ endfunction()
 find_package(GUROBI)
 if (GUROBI_FOUND)
   include_directories(${GUROBI_INCLUDE_DIRS})
+
+  # [START Check if the gurobi license is correctly set]
+  execute_process(
+      COMMAND gurobi_cl --license
+      OUTPUT_VARIABLE GRB_LICENSE_VERSION
+      RESULT_VARIABLE GRB_LICENSE_RESULT
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+
+  if(GRB_LICENSE_RESULT EQUAL 0)
+      message(STATUS "gurobi_cl found and the license is correctly set.")
+  else()
+      message(FATAL_ERROR "gurobi_cl not found or the license is not correctly
+      set. Please check out
+      https://github.com/EPFL-LAP/dynamatic/blob/main/docs/UserGuide/AdvancedBuild.md#1-gurobi")
+  endif()
+  # [END Check if the gurobi license is correctly set]
+
 else()
   message(WARNING "Gurobi wasn't found, the buffer placement algorithms \
                    that requires solving MILPs will not be built with the \
                    project.")
   add_compile_definitions(DYNAMATIC_GUROBI_NOT_INSTALLED)
 endif()
 
+#-------------------------------------------------------------------------------
+# CBC solver setup
+#-------------------------------------------------------------------------------
+
+# Find the CBC, Osi, Clp libraries
+find_package(PkgConfig REQUIRED)
+
+# Use pkg-config to get include dirs and libs
+# This command sets 
+# - *_INCLUDE_DIRS
+# - *_LIBRARY_DIRS
+# But these variable will not be automatically discovered by the target.
+pkg_check_modules(CBC REQUIRED cbc)
+pkg_check_modules(CLPCORE REQUIRED clp)
+pkg_check_modules(OSI REQUIRED osi)
+
+# This command makes the include directory of CBC discoverable
+include_directories(dynamatic-opt PRIVATE
+  ${CBC_INCLUDE_DIRS}
+  ${CLPCORE_INCLUDE_DIRS}
+  ${OSI_INCLUDE_DIRS}
+)
+
+# This command makes the link directory of CBC discoverable
+# Without this, -lCbc would not work on some distros
+link_directories(dynamatic-opt PRIVATE
+  ${CBC_LIBRARY_DIRS}
+  ${CLPCORE_LIBRARY_DIRS}
+  ${OSI_LIBRARY_DIRS}
+)
+
 #-------------------------------------------------------------------------------
 # XLS Integration (experimental)
 #-------------------------------------------------------------------------------
@@ -218,3 +268,4 @@ add_subdirectory(${DYNAMATIC_SOURCE_DIR}/lib)
 add_subdirectory(${DYNAMATIC_SOURCE_DIR}/test)
 add_subdirectory(${DYNAMATIC_SOURCE_DIR}/tools)
 add_subdirectory(${DYNAMATIC_SOURCE_DIR}/tutorials)
+add_subdirectory(${DYNAMATIC_SOURCE_DIR}/unittests)

Dockerfile

@@ -0,0 +1,57 @@
+# The Dockerfile for building the latest Dynamatic
+# 
+# Usage:
+#
+# 1. Creating a docker image:
+# 
+# ```bash 
+# $ docker build -t dynamatic-image .
+# ```
+#
+# 2. Running the docker image:
+# 
+# ```bash 
+# $ docker run -it -u dynamatic:dynamatic dynamatic-image /bin/bash
+# ```
+# 
+
+# [START Installing the dependency]
+FROM ubuntu:22.04
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get -y update && apt-get -y upgrade
+RUN \
+  apt-get install -y \
+  --option APT::Immediate-Configure=false \
+  clang lld ccache cmake \
+  ninja-build python3 openjdk-21-jdk \
+  graphviz git curl gzip libreadline-dev \
+  libboost-all-dev pkg-config coinor-cbc \
+  coinor-libcbc-dev
+# [END Installing the dependency]
+
+# [START Create a user called "dynamatic"]
+# Add a user
+RUN useradd -m dynamatic
+USER dynamatic
+ARG workdir="/home/dynamatic"
+WORKDIR $workdir
+# [END Create a user called "dynamatic"]
+
+# [START Install SBT]
+RUN \
+    curl -fL "https://github.com/coursier/coursier/releases/latest/download/cs-x86_64-pc-linux.gz" | \
+    gzip -d > cs && chmod +x cs && ./cs setup -y && rm cs
+
+ENV PATH="$PATH:$workdir/.local/share/coursier/bin"
+
+RUN sbt --version
+# [END Install SBT]
+
+# [START Clone and build the latest Dynamatic]
+RUN git clone \
+  --recurse-submodules \
+  "https://github.com/EPFL-LAP/dynamatic.git" "$workdir/dynamatic"
+
+RUN cd "$workdir/dynamatic" && \
+  bash "./build.sh" --release
+# [END Clone and build the latest Dynamatic]

build.sh

@@ -236,6 +236,7 @@ if [[ $SKIP_POLYGEIST -eq 0 ]]; then
     cmake -G Ninja ../llvm \
         -DLLVM_ENABLE_PROJECTS="mlir;clang;polly" \
         -DLLVM_TARGETS_TO_BUILD="host" \
+        -DLLVM_ENABLE_RTTI=ON \
         -DBUILD_SHARED_LIBS=ON \
         -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
         -DLLVM_PARALLEL_LINK_JOBS=$LLVM_PARALLEL_LINK_JOBS \