Update LLVM to 16 (#793)

* Make phasar compile with LLVM 16. One test (DIBasedTypeHierarchyTest) still fails

* Get rid of deprecation warnings due to LLVM 16

* Fix DIBasedTypeHierarchyTest with LLVM 16

* bump llvm version in dependency installation script

* bump llvm version in bootstrap script

TODO: The bootstrap script urgently needs to be updated! (see the different ways of installing llvm/boost, etc.)

* Start adding LLVM-17 compatibility

* Add some deprecations for LLVM-17 compatibility

* Fix removal of public Function::getBasicBlockList() in LLVM 16

* minor

* Fix compilation after merge

Author: fabianbs96

.github/workflows/deploy-docs.yml

@@ -28,8 +28,8 @@ jobs:
       - name: Build Doxygen Docs
         shell: bash
         env:
-          CXX: clang++-15
-          CC: clang-15
+          CXX: clang++-16
+          CC: clang-16
         run: |
            cmake -S . -B build -DPHASAR_BUILD_DOC=ON
            cmake --build ./build --target doc_doxygen

CMakeLists.txt

@@ -335,7 +335,7 @@ option(USE_LLVM_FAT_LIB  "Link against libLLVM.so instead of the individual LLVM
 
 # LLVM
 if (NOT PHASAR_LLVM_VERSION)
-  set(PHASAR_LLVM_VERSION 15)
+  set(PHASAR_LLVM_VERSION 16)
 endif()
 include(add_llvm)
 add_llvm()

bootstrap.sh

@@ -6,10 +6,10 @@ source ./utils/safeCommandsSet.sh
 
 readonly PHASAR_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 PHASAR_INSTALL_DIR="/usr/local/phasar"
-LLVM_INSTALL_DIR="/usr/local/llvm-15"
+LLVM_INSTALL_DIR="/usr/local/llvm-16"
 
 NUM_THREADS=$(nproc)
-LLVM_RELEASE=llvmorg-15.0.7
+LLVM_RELEASE=llvmorg-16.0.6
 DO_UNIT_TEST=true
 DO_INSTALL=false
 BUILD_TYPE=Release

cmake/phasar_macros.cmake

@@ -86,7 +86,7 @@ function(generate_ll_file)
         NAMES clang++-${PHASAR_LLVM_VERSION} clang++
         HINTS ${binary_hint_paths})
       find_program(opt REQUIRED
-        NAMES opt-${PHASAR_LLVM_VERSION}4 opt
+        NAMES opt-${PHASAR_LLVM_VERSION} opt
         HINTS ${binary_hint_paths})
 
       set(IS_VALID_VERSION "")
@@ -212,7 +212,7 @@ function(generate_ll_file)
       add_custom_command(
       OUTPUT ${test_code_ll_file}
       COMMAND ${GEN_CMD} ${test_code_file_path} -o ${test_code_ll_file}
-      COMMAND ${CMAKE_CXX_COMPILER_LAUNCHER} ${opt} -mem2reg -S ${test_code_ll_file} -o ${test_code_ll_file}
+      COMMAND ${CMAKE_CXX_COMPILER_LAUNCHER} ${opt} -p mem2reg -S ${test_code_ll_file} -o ${test_code_ll_file}
       COMMENT ${GEN_CMD_COMMENT}
       DEPENDS ${GEN_LL_FILE}
       VERBATIM

include/phasar/ControlFlow/CallGraphData.h

@@ -11,6 +11,7 @@
 #define PHASAR_PHASARLLVM_CONTROLFLOW_CALLGRAPHDATA_H
 
 #include "llvm/ADT/StringRef.h"
+#include "llvm/ADT/Twine.h"
 #include "llvm/Support/raw_ostream.h"
 
 #include <string>

include/phasar/DataFlow/IfdsIde/EdgeFunctionUtils.h

@@ -351,7 +351,7 @@ template <typename L, uint8_t N> struct JoinEdgeFunction {
       if (const auto *Join = llvm::dyn_cast<JoinEdgeFunction>(EF)) {
         return {Join->OtherEF, Join->Seed};
       }
-      return {llvm::makeArrayRef(EF), JLattice::top()};
+      return {llvm::ArrayRef(EF), JLattice::top()};
     };
 
     auto [LVec, LSeed] = GetEFArrayAndSeed(LHS);

include/phasar/PhasarLLVM/DB/LLVMProjectIRDB.h

@@ -45,8 +45,17 @@ class LLVMProjectIRDB : public ProjectIRDBBase<LLVMProjectIRDB> {
   /// Reads and parses the given LLVM IR file and owns the resulting IR Module.
   /// If an error occurs, an error message is written to stderr and subsequent
   /// calls to isValid() return false.
+  explicit LLVMProjectIRDB(const llvm::Twine &IRFileName);
+
+  /// Reads and parses the given LLVM IR file and owns the resulting IR Module.
+  /// If an error occurs, an error message is written to stderr and subsequent
+  /// calls to isValid() return false.
+  [[deprecated("When moving to the next LLVM version, opaque pointers support "
+               "is removed completely. Please use one of the other "
+               "constructors of LLVMProjectIRDB.")]]
   explicit LLVMProjectIRDB(const llvm::Twine &IRFileName,
-                           bool EnableOpaquePointers = LLVM_VERSION_MAJOR > 14);
+                           bool EnableOpaquePointers);
+
   /// Initializes the new ProjectIRDB with the given IR Module _without_ taking
   /// ownership. The module is optionally being preprocessed.
   ///
@@ -68,8 +77,16 @@ class LLVMProjectIRDB : public ProjectIRDBBase<LLVMProjectIRDB> {
   /// Parses the given LLVM IR file and owns the resulting IR Module.
   /// If an error occurs, an error message is written to stderr and subsequent
   /// calls to isValid() return false.
+  explicit LLVMProjectIRDB(llvm::MemoryBufferRef Buf);
+
+  /// Parses the given LLVM IR file and owns the resulting IR Module.
+  /// If an error occurs, an error message is written to stderr and subsequent
+  /// calls to isValid() return false.
+  [[deprecated("When moving to the next LLVM version, opaque pointers support "
+               "is removed completely. Please use one of the other "
+               "constructors of LLVMProjectIRDB.")]]
   explicit LLVMProjectIRDB(llvm::MemoryBufferRef Buf,
-                           bool EnableOpaquePointers = LLVM_VERSION_MAJOR > 14);
+                           bool EnableOpaquePointers);
 
   LLVMProjectIRDB(const LLVMProjectIRDB &) = delete;
   LLVMProjectIRDB &operator=(const LLVMProjectIRDB &) = delete;
@@ -87,12 +104,12 @@ class LLVMProjectIRDB : public ProjectIRDBBase<LLVMProjectIRDB> {
                          llvm::LLVMContext &Ctx) noexcept;
 
   [[nodiscard]] static llvm::ErrorOr<LLVMProjectIRDB>
-  load(const llvm::Twine &IRFileName,
-       bool EnableOpaquePointers = LLVM_VERSION_MAJOR > 14);
+  load(const llvm::Twine &IRFileName);
+
+  [[nodiscard]] static LLVMProjectIRDB loadOrExit(const llvm::Twine &IRFileName,
+                                                  int ErrorExitCode = 1);
   [[nodiscard]] static LLVMProjectIRDB
-  loadOrExit(const llvm::Twine &IRFileName,
-             bool EnableOpaquePointers = LLVM_VERSION_MAJOR > 14,
-             int ErrorExitCode = 1);
+  loadOrExit(const llvm::Twine &IRFileName, bool EnableOpaquePointers) = delete;
 
   /// Also use the const overload
   using ProjectIRDBBase::getFunction;
@@ -165,7 +182,7 @@ class LLVMProjectIRDB : public ProjectIRDBBase<LLVMProjectIRDB> {
 
   [[nodiscard]] auto getAllInstructionsImpl() const noexcept {
     return llvm::map_range(
-        llvm::makeArrayRef(IdToInst).drop_front(IdOffset),
+        llvm::ArrayRef(IdToInst).drop_front(IdOffset),
         [](const llvm::Value *V) { return llvm::cast<llvm::Instruction>(V); });
   }
 

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEFeatureTaintAnalysis.h

@@ -22,8 +22,8 @@
 #include "phasar/Utils/TypeTraits.h"
 
 #include "llvm/ADT/FunctionExtras.h"
-#include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/SmallBitVector.h"
+#include "llvm/ADT/bit.h"
 
 #include <cstdint>
 #include <functional>
@@ -48,7 +48,7 @@ struct IDEFeatureTaintEdgeFact {
     }
 #endif
 
-    llvm::SmallBitVector Ret(llvm::findLastSet(Bits) + 1);
+    llvm::SmallBitVector Ret(llvm::bit_width(Bits));
     Ret.setBitsInMask((const uint32_t *)&Bits, sizeof(Bits));
     return Ret;
   }
@@ -62,7 +62,7 @@ struct IDEFeatureTaintEdgeFact {
   explicit IDEFeatureTaintEdgeFact() noexcept { Taints.invalid(); }
 
   void unionWith(uintptr_t Facts) {
-    auto RequiredSize = llvm::findLastSet(Facts) + 1;
+    size_t RequiredSize = llvm::bit_width(Facts);
     if (RequiredSize > Taints.size()) {
       Taints.resize(RequiredSize);
     }
@@ -247,7 +247,7 @@ class FeatureTaintGenerator {
   FeatureTaintGenerator(EdgeFactGenerator &&EFGen)
       : FeatureTaintGenerator(
             [EFGen](InstOrGlobal IG) {
-              return !llvm::empty(std::invoke(EFGen, IG));
+              return !std::empty(std::invoke(EFGen, IG));
             },
             std::forward<EdgeFactGenerator>(EFGen)) {}
 

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEGeneralizedLCA/EdgeValue.h

@@ -18,6 +18,7 @@
 #include "llvm/Support/raw_os_ostream.h"
 #include "llvm/Support/raw_ostream.h"
 
+#include <cmath>
 #include <variant>
 
 namespace psr::glca {

include/phasar/PhasarLLVM/HelperAnalyses.h

@@ -15,6 +15,8 @@
 #include "phasar/PhasarLLVM/HelperAnalysisConfig.h"
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasSetData.h"
 
+#include "llvm/ADT/Twine.h"
+
 #include <memory>
 #include <optional>
 #include <vector>