[LLVM] Basic scalable vector support draft

CMakeLists.txt

@@ -14,16 +14,19 @@ project(
 # =============================================================================
 # CMake common project settings
 # =============================================================================
-set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)
 
 # =============================================================================
 # Build options for NMODL
 # =============================================================================
-option(NMODL_ENABLE_PYTHON_BINDINGS "Enable pybind11 based python bindings" ON)
+option(NMODL_ENABLE_PYTHON_BINDINGS "Enable pybind11 based python bindings" OFF)
 option(NMODL_ENABLE_LEGACY_UNITS "Use original faraday, R, etc. instead of 2019 nist constants" OFF)
+option(NMODL_ENABLE_LLVM "Enable LLVM based code generation" ON)
+option(NMODL_ENABLE_JIT_EVENT_LISTENERS "Enable JITEventListener for Perf and Vtune" OFF)
+
 if(NMODL_ENABLE_LEGACY_UNITS)
   add_definitions(-DUSE_LEGACY_UNITS)
 endif()
@@ -140,6 +143,15 @@ find_python_module(sympy 1.2 REQUIRED)
 find_python_module(textwrap 0.9 REQUIRED)
 find_python_module(yaml 3.12 REQUIRED)
 
+# =============================================================================
+# Find LLVM dependencies
+# =============================================================================
+if(NMODL_ENABLE_LLVM)
+  include(LLVMHelper)
+  include_directories(${LLVM_INCLUDE_DIRS})
+  add_definitions(-DNMODL_LLVM_BACKEND)
+endif()
+
 # =============================================================================
 # Compiler specific flags for external submodules
 # =============================================================================
@@ -173,6 +185,7 @@ set(MEMORYCHECK_COMMAND_OPTIONS
 # do not enable tests if nmodl is used as submodule
 if(NOT NMODL_AS_SUBPROJECT)
   include(CTest)
+  add_subdirectory(test/benchmark)
   add_subdirectory(test/unit)
 endif()
 
@@ -228,34 +241,40 @@ endif()
 message(STATUS "")
 message(STATUS "Configured NMODL ${PROJECT_VERSION} (${GIT_REVISION})")
 message(STATUS "")
-string(TOLOWER "${CMAKE_GENERATOR}" cmake_generator_tolower)
-if(cmake_generator_tolower MATCHES "makefile")
-  message(STATUS "Some things you can do now:")
-  message(STATUS "--------------------+--------------------------------------------------------")
-  message(STATUS "Command             |   Description")
-  message(STATUS "--------------------+--------------------------------------------------------")
-  message(STATUS "make                | Build the project")
-  message(STATUS "make test           | Run unit tests")
-  message(STATUS "make install        | Will install NMODL to: ${CMAKE_INSTALL_PREFIX}")
-  message(STATUS "--------------------+--------------------------------------------------------")
-  message(STATUS " Build option       | Status")
-  message(STATUS "--------------------+--------------------------------------------------------")
-  message(STATUS "CXX COMPILER        | ${CMAKE_CXX_COMPILER}")
-  message(STATUS "COMPILE FLAGS       | ${COMPILER_FLAGS}")
-  message(STATUS "Build Type          | ${CMAKE_BUILD_TYPE}")
-  message(STATUS "Legacy Units        | ${NMODL_ENABLE_LEGACY_UNITS}")
-  message(STATUS "Python Bindings     | ${NMODL_ENABLE_PYTHON_BINDINGS}")
-  message(STATUS "Flex                | ${FLEX_EXECUTABLE}")
-  message(STATUS "Bison               | ${BISON_EXECUTABLE}")
-  message(STATUS "Python              | ${PYTHON_EXECUTABLE}")
-  if(NMODL_CLANG_FORMAT)
-    message(STATUS "Clang Format        | ${ClangFormat_EXECUTABLE}")
-  endif()
-  if(NMODL_CMAKE_FORMAT)
-    message(STATUS "Cmake Format        | ${CMakeFormat_EXECUTABLE}")
-  endif()
-  message(STATUS "--------------+--------------------------------------------------------------")
-  message(STATUS " See documentation : https://github.com/BlueBrain/nmodl/")
-  message(STATUS "--------------+--------------------------------------------------------------")
+
+message(STATUS "Some things you can do now:")
+message(STATUS "--------------------+--------------------------------------------------------")
+message(STATUS "Command             |   Description")
+message(STATUS "--------------------+--------------------------------------------------------")
+message(STATUS "make                | Build the project")
+message(STATUS "make test           | Run unit tests")
+message(STATUS "make install        | Will install NMODL to: ${CMAKE_INSTALL_PREFIX}")
+message(STATUS "--------------------+--------------------------------------------------------")
+message(STATUS " Build option       | Status")
+message(STATUS "--------------------+--------------------------------------------------------")
+message(STATUS "CXX COMPILER        | ${CMAKE_CXX_COMPILER}")
+message(STATUS "COMPILE FLAGS       | ${COMPILER_FLAGS}")
+message(STATUS "Build Type          | ${CMAKE_BUILD_TYPE}")
+message(STATUS "Legacy Units        | ${NMODL_ENABLE_LEGACY_UNITS}")
+message(STATUS "Python Bindings     | ${NMODL_ENABLE_PYTHON_BINDINGS}")
+message(STATUS "Flex                | ${FLEX_EXECUTABLE}")
+message(STATUS "Bison               | ${BISON_EXECUTABLE}")
+message(STATUS "Python              | ${PYTHON_EXECUTABLE}")
+message(STATUS "LLVM Codegen        | ${NMODL_ENABLE_LLVM}")
+if(NMODL_ENABLE_LLVM)
+  message(STATUS "  VERSION           | ${LLVM_PACKAGE_VERSION}")
+  message(STATUS "  INCLUDE           | ${LLVM_INCLUDE_DIRS}")
+  message(STATUS "  CMAKE             | ${LLVM_CMAKE_DIR}")
+  message(STATUS "  JIT LISTENERS     | ${NMODL_ENABLE_JIT_EVENT_LISTENERS}")
+endif()
+if(NMODL_CLANG_FORMAT)
+  message(STATUS "Clang Format        | ${ClangFormat_EXECUTABLE}")
 endif()
+if(NMODL_CMAKE_FORMAT)
+  message(STATUS "Cmake Format        | ${CMakeFormat_EXECUTABLE}")
+endif()
+message(STATUS "--------------+--------------------------------------------------------------")
+message(STATUS " See documentation : https://github.com/BlueBrain/nmodl/")
+message(STATUS "--------------+--------------------------------------------------------------")
+
 message(STATUS "")

INSTALL.md

@@ -31,7 +31,7 @@ Typically the versions of bison and flex provided by the system are outdated and
 To get recent version of all dependencies we recommend using [homebrew](https://brew.sh/):
 
 ```sh
-brew install flex bison cmake python3
+brew install flex bison cmake python3 llvm
 ```
 
 The necessary Python packages can then easily be added using the pip3 command.
@@ -57,7 +57,7 @@ export PATH=/opt/homebrew/opt/flex/bin:/opt/homebrew/opt/bison/bin:$PATH
 On Ubuntu (>=18.04) flex/bison versions are recent enough and are installed along with the system toolchain:
 
 ```sh
-apt-get install flex bison gcc python3 python3-pip
+apt-get install flex bison gcc python3 python3-pip llvm-dev llvm-runtime llvm clang-format clang
 ```
 
 The Python dependencies are installed using:
@@ -79,6 +79,15 @@ cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/nmodl
 make -j && make install
 ```
 
+If `llvm-config` is not in PATH then set LLVM_DIR as:
+
+```sh
+cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DLLVM_DIR=/path/to/llvm/install/lib/cmake/llvm
+
+# on OSX
+cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DLLVM_DIR=`brew --prefix llvm`/lib/cmake/llvm
+```
+
 And set PYTHONPATH as:
 
 ```sh

azure-pipelines.yml

@@ -47,6 +47,11 @@ jobs:
       url="https://github.com/ispc/ispc/releases/download/${ispc_version}/ispc-${ispc_version}${ispc_version_suffix}-${url_os}.tar.gz";
       mkdir $(pwd)/$CMAKE_PKG/ispc
       wget --output-document=- $url | tar -xvzf - -C $(pwd)/$CMAKE_PKG/ispc --strip 1;
+      # install llvm nightly (future v13)
+      wget https://apt.llvm.org/llvm.sh
+      chmod +x llvm.sh
+      sudo ./llvm.sh 13
+
     env:
       CMAKE_PKG: 'cmake-3.10.2-Linux-x86_64'
     displayName: 'Install Dependencies'
@@ -56,7 +61,7 @@ jobs:
       mkdir -p $(Build.Repository.LocalPath)/build
       cd $(Build.Repository.LocalPath)/build
       cmake --version
-      cmake .. -DPYTHON_EXECUTABLE=$(which python3.7) -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DCMAKE_BUILD_TYPE=Release
+      cmake .. -DPYTHON_EXECUTABLE=$(which python3.7) -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DCMAKE_BUILD_TYPE=Release -DNMODL_ENABLE_LLVM=ON -DLLVM_DIR=/usr/lib/llvm-13/share/llvm/cmake/
       make -j 2
       if [ $? -ne 0 ]
       then
@@ -115,24 +120,27 @@ jobs:
     env:
       CMAKE_PKG: 'cmake-3.10.2-Linux-x86_64'
     displayName: 'Build CoreNEURON and Run Integration Tests with ISPC compiler'
-- job: 'osx1014'
+- job: 'osx1015'
   pool:
-    vmImage: 'macOS-10.14'
-  displayName: 'MacOS (10.14), AppleClang 10.0'
+    vmImage: 'macOS-10.15'
+  displayName: 'MacOS (10.15), AppleClang 11.0'
   steps:
   - checkout: self
     submodules: True
   - script: |
-      brew install flex cmake python@3
-      brew install bison
+      brew install flex bison cmake python@3 llvm
       python3 -m pip install -U pip setuptools
       python3 -m pip install --user 'Jinja2>=2.9.3' 'PyYAML>=3.13' pytest pytest-cov numpy 'sympy>=1.3'
     displayName: 'Install Dependencies'
+  - script: |
+      cd $HOME
+      git clone --depth 1 https://github.com/pramodk/llvm-nightly.git
+    displayName: 'Setup LLVM v13'
   - script: |
       export PATH=/usr/local/opt/flex/bin:/usr/local/opt/bison/bin:$PATH;
       mkdir -p $(Build.Repository.LocalPath)/build
       cd $(Build.Repository.LocalPath)/build
-      cmake .. -DPYTHON_EXECUTABLE=$(which python3) -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DCMAKE_BUILD_TYPE=RelWithDebInfo -DNMODL_ENABLE_PYTHON_BINDINGS=OFF
+      cmake .. -DPYTHON_EXECUTABLE=$(which python3) -DCMAKE_INSTALL_PREFIX=$HOME/nmodl -DCMAKE_BUILD_TYPE=RelWithDebInfo -DNMODL_ENABLE_PYTHON_BINDINGS=OFF -DLLVM_DIR=$HOME/llvm-nightly/0621/osx/lib/cmake/llvm -DNMODL_ENABLE_LLVM=ON
       make -j 2
       if [ $? -ne 0 ]
       then
@@ -171,6 +179,7 @@ jobs:
     displayName: 'Build Neuron and Run Integration Tests'
 - job: 'manylinux_wheels'
   timeoutInMinutes: 45
+  condition: eq(1,2)
   pool:
     vmImage: 'ubuntu-18.04'
   strategy:
@@ -220,6 +229,7 @@ jobs:
   - template: ci/upload-wheels.yml
 - job: 'macos_wheels'
   timeoutInMinutes: 45
+  condition: eq(1,2)
   pool:
     vmImage: 'macOS-10.15'
   strategy:

ci/bb5-pr.sh

@@ -7,7 +7,7 @@ git show HEAD
 source /gpfs/bbp.cscs.ch/apps/hpc/jenkins/config/modules.sh
 module use /gpfs/bbp.cscs.ch/apps/tools/modules/tcl/linux-rhel7-x86_64/
 
-module load archive/2020-10 cmake bison flex python-dev doxygen
+module load unstable cmake bison flex python-dev doxygen
 module list
 
 function bb5_pr_setup_virtualenv() {
@@ -41,7 +41,8 @@ function build_with() {
              -DPYTHON_EXECUTABLE=$(which python3) \
              -DNMODL_FORMATTING:BOOL=ON \
              -DClangFormat_EXECUTABLE=$clang_format_exe \
-             -DLLVM_DIR=/gpfs/bbp.cscs.ch/apps/hpc/jenkins/merge/deploy/externals/latest/linux-rhel7-x86_64/gcc-9.3.0/llvm-11.0.0-kzl4o5/lib/cmake/llvm
+             -DNMODL_ENABLE_JIT_EVENT_LISTENERS=ON \
+             -DLLVM_DIR=/gpfs/bbp.cscs.ch/apps/hpc/llvm-install/0621/lib/cmake/llvm
     make -j6
     popd
 }
@@ -79,7 +80,7 @@ function bb5_pr_build_intel() {
 }
 
 function bb5_pr_build_pgi() {
-    build_with pgi
+    build_with nvhpc
 }
 
 function bb5_pr_test_gcc() {
@@ -91,7 +92,7 @@ function bb5_pr_test_intel() {
 }
 
 function bb5_pr_test_pgi() {
-    test_with pgi
+    test_with nvhpc
 }
 
 function bb5_pr_build_llvm() {

cmake/LLVMHelper.cmake

@@ -0,0 +1,69 @@
+# =============================================================================
+# LLVM/Clang needs to be linked with either libc++ or libstdc++
+# =============================================================================
+
+find_package(LLVM REQUIRED CONFIG)
+
+# include LLVM libraries
+set(NMODL_LLVM_COMPONENTS
+    analysis
+    codegen
+    core
+    executionengine
+    instcombine
+    ipo
+    mc
+    native
+    orcjit
+    target
+    transformutils
+    scalaropts
+    support)
+
+if(NMODL_ENABLE_JIT_EVENT_LISTENERS)
+  list(APPEND NMODL_LLVM_COMPONENTS inteljitevents perfjitevents)
+endif()
+
+llvm_map_components_to_libnames(LLVM_LIBS_TO_LINK ${NMODL_LLVM_COMPONENTS})
+
+set(CMAKE_REQUIRED_INCLUDES ${LLVM_INCLUDE_DIRS})
+set(CMAKE_REQUIRED_LIBRARIES ${LLVM_LIBS_TO_LINK})
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NMODL_ENABLE_LLVM)
+  include(CheckCXXSourceCompiles)
+
+  # simple code to test LLVM library linking
+  set(CODE_TO_TEST
+      "
+    #include <llvm/IR/IRBuilder.h>
+    using namespace llvm;
+    int main(int argc, char* argv[]) {
+        std::unique_ptr<IRBuilder<>> Builder;
+    }")
+
+  # first compile without any flags
+  check_cxx_source_compiles("${CODE_TO_TEST}" LLVM_LIB_LINK_TEST)
+
+  # if standard compilation fails
+  if(NOT LLVM_LIB_LINK_TEST)
+    # try libstdc++ first
+    set(CMAKE_REQUIRED_FLAGS "-stdlib=libstdc++")
+    check_cxx_source_compiles("${CODE_TO_TEST}" LLVM_LIBSTDCPP_TEST)
+    # on failure, try libc++
+    if(NOT LLVM_LIBSTDCPP_TEST)
+      set(CMAKE_REQUIRED_FLAGS "-stdlib=libc++")
+      check_cxx_source_compiles("${CODE_TO_TEST}" LLVM_LIBCPP_TEST)
+    endif()
+    # if either library works then add it to CXX flags
+    if(LLVM_LIBSTDCPP_TEST OR LLVM_LIBCPP_TEST)
+      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_REQUIRED_FLAGS}")
+      message(
+        STATUS
+          "Adding ${CMAKE_REQUIRED_FLAGS} to CMAKE_CXX_FLAGS, required to link with LLVM libraries")
+    else()
+      message(
+        STATUS
+          "WARNING : -stdlib=libstdcx++ or -stdlib=libc++ didn't work to link with LLVM library")
+    endif()
+  endif()
+endif()

setup.py

@@ -97,7 +97,7 @@ def _config_exe(exe_name):
 ]
 
 
-cmake_args = ["-DPYTHON_EXECUTABLE=" + sys.executable]
+cmake_args = ["-DPYTHON_EXECUTABLE=" + sys.executable, "-DNMODL_ENABLE_LLVM=OFF", "-DNMODL_ENABLE_PYTHON_BINDINGS=ON"]
 if "bdist_wheel" in sys.argv:
     cmake_args.append("-DLINK_AGAINST_PYTHON=FALSE")
 

src/CMakeLists.txt

@@ -28,6 +28,9 @@ target_link_libraries(
   util
   lexer
   ${NMODL_WRAPPER_LIBS})
+if(NMODL_ENABLE_LLVM)
+  target_link_libraries(nmodl llvm_codegen llvm_benchmark benchmark_data ${LLVM_LIBS_TO_LINK})
+endif()
 
 # =============================================================================
 # Add dependency with nmodl pytnon module (for consumer projects)