Make BLAKE3 a component library

[thakis]

Summary

It's unusual that BLAKE3/CMakeLists.txt just defines a list of
files that it injects into its parent scope. The list should either
be defined in llvm/lib/Support/CMakeLists.txt, or
llvm/lib/Support/BLAKE3/CMakeLists.txt should define an object
library.

This does the latter. It makes llvm/lib/Support/BLAKE3/CMakeLists.txt
more self-contained.

No behavior change.

[MaskRay]

llvm/lib/Support/BLAKE3/CMakeLists.txt

53

Should this be named LLVMSupportBlake3 to match the prevailing library naming convention and BUILD.gn?

[thakis]

comments

llvm/lib/Support/BLAKE3/CMakeLists.txt

53

I can change it (done), but since it's an object library it doesn't really make it to disk (other than the name of the directory containing the .o files). So it doesn't matter too much either way I think.

[akyrtzi]

Thank you! 🙇🏻‍♂️

llvm/lib/Support/BLAKE3/CMakeLists.txt

 set(LLVM_BLAKE3_FILES
-  BLAKE3/blake3.c
-  BLAKE3/blake3_dispatch.c
-  BLAKE3/blake3_portable.c
+  blake3.c
+  blake3_dispatch.c
+  blake3_portable.c
 )
 
 # The BLAKE3 team recommends using the assembly versions, from the README:
 #
 # "For each of the x86 SIMD instruction sets, four versions are available:
 # three flavors of assembly (Unix, Windows MSVC, and Windows GNU) and one
 # version using C intrinsics. The assembly versions are generally
 # preferred. They perform better, they perform more consistently across
 # different compilers, and they build more quickly."
 # FIXME: Figure out what is wrong with the builders when using the assembly files and neon.
+if (MSVC)
+  enable_language(ASM_MASM)
+endif()
+
 if (FALSE)#CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|AMD64)$")
   if (MSVC)
     list(APPEND LLVM_BLAKE3_FILES
-      BLAKE3/blake3_sse2_x86-64_windows_msvc.asm
-      BLAKE3/blake3_sse41_x86-64_windows_msvc.asm
-      BLAKE3/blake3_avx2_x86-64_windows_msvc.asm
-      BLAKE3/blake3_avx512_x86-64_windows_msvc.asm
+      blake3_sse2_x86-64_windows_msvc.asm
+      blake3_sse41_x86-64_windows_msvc.asm
+      blake3_avx2_x86-64_windows_msvc.asm
+      blake3_avx512_x86-64_windows_msvc.asm
     )
   elseif(WIN32)
     list(APPEND LLVM_BLAKE3_FILES
-      BLAKE3/blake3_sse2_x86-64_windows_gnu.S
-      BLAKE3/blake3_sse41_x86-64_windows_gnu.S
-      BLAKE3/blake3_avx2_x86-64_windows_gnu.S
-      BLAKE3/blake3_avx512_x86-64_windows_gnu.S
+      blake3_sse2_x86-64_windows_gnu.S
+      blake3_sse41_x86-64_windows_gnu.S
+      blake3_avx2_x86-64_windows_gnu.S
+      blake3_avx512_x86-64_windows_gnu.S
     )
   else()
     list(APPEND LLVM_BLAKE3_FILES
-      BLAKE3/blake3_sse2_x86-64_unix.S
-      BLAKE3/blake3_sse41_x86-64_unix.S
-      BLAKE3/blake3_avx2_x86-64_unix.S
-      BLAKE3/blake3_avx512_x86-64_unix.S
+      blake3_sse2_x86-64_unix.S
+      blake3_sse41_x86-64_unix.S
+      blake3_avx2_x86-64_unix.S
+      blake3_avx512_x86-64_unix.S
     )
   endif()
 endif()
 
 if (FALSE)#CMAKE_SYSTEM_PROCESSOR MATCHES "^(arm|aarch)")
   list(APPEND LLVM_BLAKE3_FILES
-    BLAKE3/blake3_neon.c
+    blake3_neon.c
   )
 endif()
 
-set(LLVM_BLAKE3_FILES
-  ${LLVM_BLAKE3_FILES}
-  PARENT_SCOPE
-)
+# FIXME: Figure out what is wrong with the builders when using the assembly files.
+add_definitions(-DBLAKE3_NO_AVX512 -DBLAKE3_NO_AVX2 -DBLAKE3_NO_SSE41 -DBLAKE3_NO_SSE2 -DBLAKE3_USE_NEON=0)
+
+add_library(LLVMSupportBlake3 OBJECT EXCLUDE_FROM_ALL ${LLVM_BLAKE3_FILES})
+llvm_update_compile_flags(LLVMSupportBlake3)

llvm/lib/Support/CMakeLists.txt

elseif(LLVM_INTEGRATED_CRT_ALLOC MATCHES "mimalloc$")
     set(MIMALLOC_LIB "${LLVM_INTEGRATED_CRT_ALLOC}/out/msvc-x64/Release/mimalloc-static.lib")
     if(NOT EXISTS "${MIMALLOC_LIB}")
     message(FATAL_ERROR "Cannot find the mimalloc static library. To build it, first apply the patch from https://github.com/microsoft/mimalloc/issues/268 then build the Release x64 target through ${LLVM_INTEGRATED_CRT_ALLOC}\\ide\\vs2019\\mimalloc.sln")
     endif()
     set(system_libs ${system_libs} "${MIMALLOC_LIB}" "-INCLUDE:malloc")
   endif()
 endif()
 
-# Sets up the LLVM_BLAKE3_FILES variable with the files to compile.
 add_subdirectory(BLAKE3)
-if (MSVC)
-  enable_language(ASM_MASM)
-endif()
-# FIXME: Figure out what is wrong with the builders when using the assembly files.
-add_definitions(-DBLAKE3_NO_AVX512 -DBLAKE3_NO_AVX2 -DBLAKE3_NO_SSE41 -DBLAKE3_NO_SSE2 -DBLAKE3_USE_NEON=0)
-
 
 add_llvm_component_library(LLVMSupport
   AArch64TargetParser.cpp
   ABIBreak.cpp
   ARMTargetParser.cpp
   AMDGPUMetadata.cpp
   APFixedPoint.cpp
   APFloat.cpp
add_llvm_component_library(LLVMSupport
   regerror.c
   regexec.c
   regfree.c
   regstrlcpy.c
   xxhash.cpp
   Z3Solver.cpp
 
   ${ALLOCATOR_FILES}
-  ${LLVM_BLAKE3_FILES}
+  $<TARGET_OBJECTS:LLVMSupportBlake3>
 
 # System
   Atomic.cpp
   DynamicLibrary.cpp
   Errno.cpp
   Host.cpp
   Memory.cpp
   Path.cpp

llvm/utils/gn/secondary/llvm/lib/Support/BLAKE3/BUILD.gn

 static_library("BLAKE3") {
   output_name = "LLVMSupportBlake3"
-  sources = [ "blake3.c", "blake3_dispatch.c", "blake3_portable.c" ]
+  sources = [
+    "blake3.c",
+    "blake3_dispatch.c",
+    "blake3_portable.c",
+  ]
   defines = [
    "BLAKE3_NO_AVX512",
    "BLAKE3_NO_AVX2",
    "BLAKE3_NO_SSE41",
    "BLAKE3_NO_SSE2",
    "BLAKE3_USE_NEON=0",
   ]
 }
 
 source_set("hack") {
   sources = [
-    "BLAKE3/blake3.c",
-    "BLAKE3/blake3_avx2_x86-64_unix.S",
-    "BLAKE3/blake3_avx2_x86-64_windows_gnu.S",
-    "BLAKE3/blake3_avx512_x86-64_unix.S",
-    "BLAKE3/blake3_avx512_x86-64_windows_gnu.S",
-    "BLAKE3/blake3_dispatch.c",
-    "BLAKE3/blake3_neon.c",
-    "BLAKE3/blake3_portable.c",
-    "BLAKE3/blake3_sse2_x86-64_unix.S",
-    "BLAKE3/blake3_sse2_x86-64_windows_gnu.S",
-    "BLAKE3/blake3_sse41_x86-64_unix.S",
-    "BLAKE3/blake3_sse41_x86-64_windows_gnu.S",
+    "blake3_avx2_x86-64_unix.S",
+    "blake3_avx2_x86-64_windows_gnu.S",
+    "blake3_avx512_x86-64_unix.S",
+    "blake3_avx512_x86-64_windows_gnu.S",
+    "blake3_neon.c",
+    "blake3_sse2_x86-64_unix.S",
+    "blake3_sse2_x86-64_windows_gnu.S",
+    "blake3_sse41_x86-64_unix.S",
+    "blake3_sse41_x86-64_windows_gnu.S",
   ]
 }