Upgrade to LLVM 17 (#193)

Closes #132. Upgrade the qss-compiler to LLVM 17.0.5. This is a major
change and has a corresponding significant diff. Work to be done before
coming out of draft

- [x] Building
- [x] Tests passing
- [x] Tested internally with hardware

Author: taalexander

CMakeLists.txt

@@ -246,7 +246,6 @@ list(APPEND RUN_CLANG_TIDY_BIN_ARGS
     -clang-apply-replacements-binary ${CLANG_AR_BIN}
     -style=file
     -quiet
-    -header-filter="${CMAKE_SOURCE_DIR}/[^b].*"
 )
 
 # run clang-tidy linter only when compiling with clang (compiler flags may be

cmake/AddQSSC.cmake

@@ -349,14 +349,3 @@ macro(package_add_test_with_libs TESTNAME)
     package_add_test(${TESTNAME} ${ARG_UNPARSED_ARGUMENTS})
     target_link_libraries(${TESTNAME} GTest::gtest_main GTest::gtest ${ARG_LIBRARIES})
 endmacro()
-
-
-# Version adapter for add_mlir_doc during transition from LLVM 12 to newer
-# (order of parameters differs)
-function(qssc_add_mlir_doc doc_filename output_file output_directory command)
-    if("${LLVM_VERSION_MAJOR}" EQUAL "12")
-        add_mlir_doc(${doc_filename} ${command} ${output_file} ${output_directory})
-    else()
-        add_mlir_doc(${doc_filename} ${output_file} ${output_directory} ${command})
-    endif()
-endfunction()

cmake/apple-clang.cmake

@@ -17,6 +17,16 @@ set (CXX_FLAGS
     -fno-omit-frame-pointer
     -Werror
 )
+
+option(DETECT_TARGET_TRIPLE "Automatically detect the target triple for clang" ON)
+if (DETECT_TARGET_TRIPLE)
+execute_process (
+    COMMAND bash -c "llvm-config --host-target | tr -d '\n'"
+    OUTPUT_VARIABLE LLVM_TARGET_TRIPLE
+)
+list(APPEND CXX_FLAGS "-target ${LLVM_TARGET_TRIPLE}")
+endif()
+
 list (JOIN CXX_FLAGS " " CXX_FLAGS_STR)
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_STR}")
 

cmake/llvm-clang.cmake

@@ -19,6 +19,16 @@ set (CXX_FLAGS
 
     -Werror
 )
+
+option(DETECT_TARGET_TRIPLE "Automatically detect the target triple for clang" ON)
+if (DETECT_TARGET_TRIPLE)
+execute_process (
+    COMMAND bash -c "llvm-config --host-target | tr -d '\n'"
+    OUTPUT_VARIABLE LLVM_TARGET_TRIPLE
+)
+list(APPEND CXX_FLAGS "-target ${LLVM_TARGET_TRIPLE}")
+endif()
+
 list (JOIN CXX_FLAGS " " CXX_FLAGS_STR)
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_STR}")
 

conan/clang-tools-extra/conanfile.py

@@ -20,12 +20,12 @@
 import os
 import shutil
 
-LLVM_TAG = "llvmorg-14.0.6"
+LLVM_TAG = "llvmorg-17.0.5"
 
 
 class ClangToolsExtraConan(ConanFile):
     name = "clang-tools-extra"
-    version = "14.0.6"
+    version = "17.0.5-0"
     description = "A toolkit for analysis of c++ projects."
     license = "Apache-2.0 WITH LLVM-exception"
     topics = ("conan", "llvm", "clang-tools-extra")

conan/llvm/conanfile.py

@@ -21,12 +21,12 @@
 
 from conan.tools.apple import is_apple_os
 
-LLVM_TAG = "llvmorg-14.0.6"
+LLVM_TAG = "llvmorg-17.0.5"
 
 
 class LLVMConan(ConanFile):
     name = "llvm"
-    version = "14.0.6-2"
+    version = "17.0.5-0"
     description = (
         "A toolkit for the construction of highly optimized compilers,"
         "optimizers, and runtime environments."

conandata.yml

@@ -2,8 +2,9 @@ requirements:
   - gtest/1.11.0
   - libzip/1.10.1
   - zlib/1.2.13
+  - zstd/1.5.5
   - nlohmann_json/3.9.1
   - pybind11/2.10.1
-  - clang-tools-extra/14.0.6@
-  - llvm/14.0.6-2@
+  - clang-tools-extra/17.0.5-0@
+  - llvm/17.0.5-0@
   - qasm/0.3.0@qss/stable

conanfile.py

@@ -34,7 +34,7 @@ class QSSCompilerConan(ConanFile):
     author = "IBM Quantum development team"
     topics = ("Compiler", "Scheduler", "OpenQASM3")
     description = "An LLVM- and MLIR-based Quantum compiler that consumes OpenQASM 3.0"
-    generators = ["CMakeToolchain", "CMakeDeps"]
+    generators = ["CMakeToolchain", "CMakeDeps", "VirtualBuildEnv"]
     exports_sources = "*"
 
     def requirements(self):
@@ -46,6 +46,10 @@ def configure(self):
         if self.settings.os == "Macos":
             self.options["qasm"].shared = True
 
+        # LLVM prefers ZSTD shared libraries by default now so we force building
+        # https://github.com/llvm/llvm-project/commit/fc1da043f4f9198303abd6f643cf23439115ce73
+        self.options["zstd"].shared = True
+
     def build_requirements(self):
         tool_pkgs = ["llvm", "clang-tools-extra"]
         # Add packages necessary for build.

include/Arguments/Arguments.h

@@ -34,7 +34,7 @@
 
 namespace qssc::arguments {
 
-using ArgumentType = std::variant<llvm::Optional<double>>;
+using ArgumentType = std::variant<std::optional<double>>;
 using OptDiagnosticCallback = std::optional<qssc::DiagnosticCallback>;
 
 class ArgumentSource {

include/Arguments/Signature.h

@@ -29,6 +29,7 @@
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Error.h"
 
+#include <map>
 #include <string>
 #include <vector>
 
@@ -58,7 +59,8 @@ using PatchPointVector = std::vector<PatchPoint>;
 
 struct Signature {
   // TODO consider deduplicating strings by using UniqueStringSaver
-  llvm::StringMap<std::vector<PatchPoint>> patchPointsByBinary;
+  // Use std::map instead of StringMap to preserve order
+  std::map<std::string, std::vector<PatchPoint>> patchPointsByBinary;
 
 public:
   void addParameterPatchPoint(llvm::StringRef expression,