Add full LLVM 18 support (#1803)

Some methods and enums got renamed from LLVM 17 -> 18, etc.

Also some adjustment to warning messages about version mixing
between clang and llvm.

Signed-off-by: Larry Gritz <[email protected]>

Author: lgritz

INSTALL.md

@@ -47,7 +47,7 @@ NEW or CHANGED dependencies since the last major release are **bold**.
     $OpenImageIO_ROOT/lib to be in your LD_LIBRARY_PATH (or
     DYLD_LIBRARY_PATH on OS X).
 
-* [LLVM](http://www.llvm.org) 9, 10, 11, 12, 13, 14, 15, 16, or 17, including
+* [LLVM](http://www.llvm.org) 9, 10, 11, 12, 13, 14, 15, 16, 17, or 18, including
   clang libraries.
 
 * (optional) For GPU rendering on NVIDIA GPUs:
@@ -71,7 +71,7 @@ NEW or CHANGED dependencies since the last major release are **bold**.
   be operative.
 * (optional) Python: If you are building the Python bindings or running the
   testsuite:
-    * Python >= 2.7 (tested against 2.7, 3.7, 3.8, 3.9, 3.10, 3.11)
+    * Python >= 2.7 (tested against 2.7, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12)
       NOTE: It is likely that 1.13 is the last release that will support
       Python 2.7.
     * pybind11 >= 2.4.2 (Tested through 2.11. Note that pybind11 v2.10+ does

src/cmake/compiler.cmake

@@ -59,13 +59,17 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER MATCHES "[Cc]lan
         set (CMAKE_CXX_COMPILER_ID "AppleClang")
         set (CMAKE_COMPILER_IS_APPLECLANG 1)
         string (REGEX REPLACE ".* version ([0-9]+\\.[0-9]+).*" "\\1" APPLECLANG_VERSION_STRING ${clang_full_version_string})
+        set (ANY_CLANG_VERSION_STRING ${APPLECLANG_VERSION_STRING})
         message (VERBOSE "The compiler is Clang: ${CMAKE_CXX_COMPILER_ID} version ${APPLECLANG_VERSION_STRING}")
     elseif (CMAKE_CXX_COMPILER_ID MATCHES "IntelLLVM")
         set (CMAKE_COMPILER_IS_INTELCLANG 1)
         string (REGEX MATCH "[0-9]+(\\.[0-9]+)+" INTELCLANG_VERSION_STRING ${clang_full_version_string})
+        set (ANY_CLANG_VERSION_STRING ${INTELCLANG_VERSION_STRING})
         message (VERBOSE "The compiler is Intel Clang: ${CMAKE_CXX_COMPILER_ID} version ${INTELCLANG_VERSION_STRING}")
     else ()
+        set (CMAKE_COMPILER_IS_GENERICCLANG 1)
         string (REGEX REPLACE ".* version ([0-9]+\\.[0-9]+).*" "\\1" CLANG_VERSION_STRING ${clang_full_version_string})
+        set (ANY_CLANG_VERSION_STRING ${CLANG_VERSION_STRING})
         message (VERBOSE "The compiler is Clang: ${CMAKE_CXX_COMPILER_ID} version ${CLANG_VERSION_STRING}")
     endif ()
 elseif (CMAKE_CXX_COMPILER_ID MATCHES "Intel")

src/cmake/externalpackages.cmake

@@ -117,7 +117,7 @@ checked_find_package (pugixml REQUIRED
 # LLVM library setup
 checked_find_package (LLVM REQUIRED
                       VERSION_MIN 9.0
-                      VERSION_MAX 17.9
+                      VERSION_MAX 18.9
                       PRINT LLVM_SYSTEM_LIBRARIES CLANG_LIBRARIES)
 # ensure include directory is added (in case of non-standard locations
 include_directories (BEFORE SYSTEM "${LLVM_INCLUDES}")
@@ -139,9 +139,8 @@ if (APPLE AND LLVM_VERSION VERSION_EQUAL 10.0.1 AND EXISTS "/usr/local/Cellar/ll
              "    brew upgrade llvm \n"
              "${ColorReset}\n")
 endif ()
-if (LLVM_VERSION VERSION_GREATER_EQUAL 15.0
-    AND (   (CMAKE_COMPILER_IS_APPLECLANG AND APPLECLANG_VERSION_STRING VERSION_LESS 15.0)
-         OR (CMAKE_COMPILER_IS_CLANG AND CLANG_VERSION_STRING VERSION_LESS 15.0)))
+if (LLVM_VERSION VERSION_GREATER_EQUAL 15.0 AND CMAKE_COMPILER_IS_CLANG
+    AND ANY_CLANG_VERSION_STRING VERSION_LESS 15.0)
     message (WARNING
          "${ColorYellow}"
          "If you are using LLVM 15 or higher, you should also use clang version "
@@ -155,7 +154,8 @@ if (LLVM_VERSION VERSION_GREATER_EQUAL 16.0)
     if (CMAKE_COMPILER_IS_GNUCC AND (GCC_VERSION VERSION_LESS 7.0))
         message (WARNING "${ColorYellow}LLVM 16+ requires gcc 7.0 or higher.${ColorReset}\n")
     endif ()
-    if (CMAKE_COMPILER_IS_CLANG AND (CLANG_VERSION_STRING VERSION_LESS 5.0))
+    if (CMAKE_COMPILER_IS_CLANG AND (CLANG_VERSION_STRING VERSION_LESS 5.0
+                                     OR APPLE_CLANG_VERSION_STRING VERSION_LESS 5.0))
         message (WARNING "${ColorYellow}LLVM 16+ requires clang 5.0 or higher.${ColorReset}\n")
     endif ()
 endif ()

src/liboslexec/llvm_instance.cpp

@@ -482,6 +482,9 @@ BackendLLVM::build_offsets_of_ShaderGlobals(
     offset_by_index.push_back(offsetof(ShaderGlobals, flipHandedness));
     offset_by_index.push_back(offsetof(ShaderGlobals, backfacing));
 }
+
+
+
 void
 BackendLLVM::llvm_assign_initial_value(const Symbol& sym, bool force)
 {
@@ -1626,7 +1629,13 @@ BackendLLVM::prepare_module_for_cuda_jit()
     for (llvm::Function& fn : *ll.module()) {
         if (fn.hasFnAttribute("osl-lib-function")) {
             fn.setLinkage(llvm::GlobalValue::ExternalLinkage);
-        } else if (fn.getName().startswith(group().name().c_str())) {
+        }
+#if OSL_LLVM_VERSION >= 180
+        else if (fn.getName().starts_with(group().name().c_str()))
+#else
+        else if (fn.getName().startswith(group().name().c_str()))
+#endif
+        {
             fn.setLinkage(llvm::GlobalValue::PrivateLinkage);
         }
     }
@@ -1638,9 +1647,15 @@ BackendLLVM::prepare_module_for_cuda_jit()
         // Don't modify the inlining attribute for:
         //  * group entry functions
         //  * llvm library functions
+#if OSL_LLVM_VERSION >= 180
+        if (fn.getName().starts_with("__direct_callable__")
+            || fn.getName().starts_with("llvm."))
+            continue;
+#else
         if (fn.getName().startswith("__direct_callable__")
             || fn.getName().startswith("llvm."))
             continue;
+#endif
 
         // Merge layer functions which are only called from one place
         if (merge_layer_funcs && !fn.hasFnAttribute("osl-lib-function")

src/liboslexec/llvm_util.cpp

@@ -490,26 +490,20 @@ LLVM_Util::LLVM_Util(const PerThreadInfo& per_thread_info, int debuglevel,
     else
         m_llvm_type_addrint = (llvm::Type*)llvm::Type::getInt64Ty(
             *m_llvm_context);
-    m_llvm_type_int_ptr = (llvm::PointerType*)llvm::Type::getInt32PtrTy(
-        *m_llvm_context);
-    m_llvm_type_int8_ptr = (llvm::PointerType*)llvm::Type::getInt8PtrTy(
-        *m_llvm_context);
-    m_llvm_type_int64_ptr = (llvm::PointerType*)llvm::Type::getInt64PtrTy(
-        *m_llvm_context);
     m_llvm_type_bool     = (llvm::Type*)llvm::Type::getInt1Ty(*m_llvm_context);
-    m_llvm_type_bool_ptr = (llvm::PointerType*)llvm::Type::getInt1PtrTy(
-        *m_llvm_context);
     m_llvm_type_char     = (llvm::Type*)llvm::Type::getInt8Ty(*m_llvm_context);
     m_llvm_type_longlong = (llvm::Type*)llvm::Type::getInt64Ty(*m_llvm_context);
     m_llvm_type_void     = (llvm::Type*)llvm::Type::getVoidTy(*m_llvm_context);
-    m_llvm_type_char_ptr = (llvm::PointerType*)llvm::Type::getInt8PtrTy(
-        *m_llvm_context);
-    m_llvm_type_float_ptr = (llvm::PointerType*)llvm::Type::getFloatPtrTy(
-        *m_llvm_context);
-    m_llvm_type_longlong_ptr = (llvm::PointerType*)llvm::Type::getInt64PtrTy(
-        *m_llvm_context);
-    m_llvm_type_void_ptr   = m_llvm_type_char_ptr;
-    m_llvm_type_double_ptr = llvm::Type::getDoublePtrTy(*m_llvm_context);
+
+    m_llvm_type_int_ptr      = llvm::PointerType::get(m_llvm_type_int, 0);
+    m_llvm_type_int8_ptr     = llvm::PointerType::get(m_llvm_type_int8, 0);
+    m_llvm_type_int64_ptr    = llvm::PointerType::get(m_llvm_type_int64, 0);
+    m_llvm_type_bool_ptr     = llvm::PointerType::get(m_llvm_type_bool, 0);
+    m_llvm_type_char_ptr     = llvm::PointerType::get(m_llvm_type_char, 0);
+    m_llvm_type_void_ptr     = m_llvm_type_char_ptr;
+    m_llvm_type_float_ptr    = llvm::PointerType::get(m_llvm_type_float, 0);
+    m_llvm_type_longlong_ptr = llvm::PointerType::get(m_llvm_type_int64, 0);
+    m_llvm_type_double_ptr   = llvm::PointerType::get(m_llvm_type_double, 0);
 
     // A triple is a struct composed of 3 floats
     std::vector<llvm::Type*> triplefields(3, m_llvm_type_float);
@@ -563,7 +557,7 @@ void
 LLVM_Util::ustring_rep(UstringRep rep)
 {
     m_ustring_rep       = rep;
-    m_llvm_type_ustring = llvm::Type::getInt8PtrTy(*m_llvm_context);
+    m_llvm_type_ustring = m_llvm_type_int8_ptr;
     // ^^ When m_ustring_rep != UstringRep::charptr, we'd ideally want to make
     // it a uint directly, but that is wreaking havoc with function
     // signatures, so continue to disguise it as a pointer.
@@ -1514,8 +1508,14 @@ LLVM_Util::make_jit_execengine(std::string* err, TargetISA requestedISA,
         std::unique_ptr<llvm::RTDyldMemoryManager>(
             new MemoryManager(m_llvm_jitmm)));
 
+#if OSL_LLVM_VERSION >= 180
+    engine_builder.setOptLevel(jit_aggressive()
+                                   ? llvm::CodeGenOptLevel::Aggressive
+                                   : llvm::CodeGenOptLevel::Default);
+#else
     engine_builder.setOptLevel(jit_aggressive() ? llvm::CodeGenOpt::Aggressive
                                                 : llvm::CodeGenOpt::Default);
+#endif
 
     llvm::TargetOptions options;
     // Enables FMA's in IR generation.
@@ -1817,7 +1817,12 @@ LLVM_Util::nvptx_target_machine()
         m_nvptx_target_machine = llvm_target->createTargetMachine(
             ModuleTriple.str(), CUDA_TARGET_ARCH, "+ptx50", options,
             llvm::Reloc::Static, llvm::CodeModel::Small,
-            llvm::CodeGenOpt::Default);
+#if OSL_LLVM_VERSION >= 180
+            llvm::CodeGenOptLevel::Default
+#else
+            llvm::CodeGenOpt::Default
+#endif
+        );
 
         OSL_ASSERT(m_nvptx_target_machine
                    && "Unable to create TargetMachine for NVPTX");
@@ -2957,7 +2962,12 @@ LLVM_Util::prune_and_internalize_module(
                             || llvm::cast<llvm::GlobalValue>(val)
                                    ->hasLocalLinkage()) {
                             if (!debug()
-                                || !val->getName().startswith("llvm.dbg")) {
+#if OSL_LLVM_VERSION >= 180
+                                || !val->getName().starts_with("llvm.dbg")
+#else
+                                || !val->getName().startswith("llvm.dbg")
+#endif
+                            ) {
                                 __OSL_PRUNE_ONLY(
                                     std::cout
                                     << "remove symbol table for value:  "
@@ -6486,7 +6496,11 @@ LLVM_Util::ptx_compile_group(llvm::Module*, const std::string& name,
     llvm::raw_svector_ostream assembly_stream(assembly);
 
     // TODO: Make sure rounding modes, etc., are set correctly
-#    if OSL_LLVM_VERSION >= 100
+#    if OSL_LLVM_VERSION >= 180
+    target_machine->addPassesToEmitFile(mpm, assembly_stream,
+                                        nullptr,  // FIXME: Correct?
+                                        llvm::CodeGenFileType::AssemblyFile);
+#    elif OSL_LLVM_VERSION >= 100
     target_machine->addPassesToEmitFile(mpm, assembly_stream,
                                         nullptr,  // FIXME: Correct?
                                         llvm::CGFT_AssemblyFile);