Skip to content

Commit

Permalink
Fetch slang-llvm.so from correct release (shader-slang#4847)
Browse files Browse the repository at this point in the history
* Fetch slang-llvm.so from correct release

Closes shader-slang#4648
Should close shader-slang#4812

* Update docs

* Correct documentation on cmake option

* Neaten cmake script

* Fix fetching on windows

---------

Co-authored-by: Yong He <yonghe@outlook.com>
  • Loading branch information
expipiplus1 and csyonghe authored Aug 20, 2024
1 parent d286ff5 commit 579d59c
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 12 deletions.
26 changes: 14 additions & 12 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ include(Glob)
include(LLVM)
include(SlangTarget)
include(AutoOption)
include(GitHubRelease)

#
# Options
Expand Down Expand Up @@ -125,25 +126,26 @@ enum_option(
"How to get or build slang-llvm:"
# Options
FETCH_BINARY
"Use a binary distribution of the slang-llvm library instead of building or using LLVM (default for Windows)"
"Use a binary distribution of the slang-llvm library instead of building or using LLVM (default)"
USE_SYSTEM_LLVM
"Build slang-llvm using system-provided LLVM and Clang binaries (default for non-Windows hosts)"
"Build slang-llvm using system-provided LLVM and Clang binaries"
DISABLE
"Do not build llvm or fetch slang-llvm"
)
macro(slang_llvm_binary_url_option version filename)

if(SLANG_SLANG_LLVM_FLAVOR MATCHES FETCH_BINARY)
# If the user didn't specify a URL, find the best one now
if(NOT SLANG_SLANG_LLVM_BINARY_URL)
get_best_slang_binary_release_url(url)
if(NOT url)
message(FATAL_ERROR "Unable to find binary release for slang-llvm, please set a different SLANG_SLANG_LLVM_FLAVOR or set SLANG_SLANG_LLVM_BINARY_URL manually")
endif()
endif()
set(SLANG_SLANG_LLVM_BINARY_URL
"https://github.com/shader-slang/slang-llvm/releases/download/${version}/${filename}"
${url}
CACHE STRING
"URL specifying the location of the slang-llvm prebuilt library"
)
endmacro()
if(CMAKE_SYSTEM_NAME MATCHES "Windows")
slang_llvm_binary_url_option("v13.x-43" "slang-llvm-13.x-43-win64.zip")
elseif(CMAKE_SYSTEM_NAME MATCHES "Darwin")
slang_llvm_binary_url_option("v13.x-43" "slang-llvm-v13.x-43-macosx-x86_64-release.zip")
else()
slang_llvm_binary_url_option("v13.x-43" "slang-llvm-v13.x-43-linux-x86_64-release.zip")
endif()

#
Expand Down Expand Up @@ -392,7 +394,7 @@ if(SLANG_SLANG_LLVM_FLAVOR STREQUAL "FETCH_BINARY")
endif()

set(slang_llvm_dest_object
${CMAKE_BINARY_DIR}/$<CONFIG>/${runtime_subdir}/${slang_llvm_filename}
${CMAKE_BINARY_DIR}/$<CONFIG>/${module_subdir}/${slang_llvm_filename}
)
add_custom_command(
OUTPUT ${slang_llvm_dest_object}
Expand Down
99 changes: 99 additions & 0 deletions cmake/GitHubRelease.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
function(check_release_and_get_latest owner repo version os arch out_var)
# Construct the URL for the specified version's release API endpoint
set(version_url "https://api.github.com/repos/${owner}/${repo}/releases/tags/v${version}")

set(json_output_file "${CMAKE_CURRENT_BINARY_DIR}/${owner}_${repo}_release_info.json")

function(check_assets_for_file json_content filename found_var)
string(JSON asset_count LENGTH "${json_content}" "assets")
set(found "FALSE")
foreach(i RANGE 0 ${asset_count})
string(JSON asset_name GET "${json_content}" "assets" ${i} "name")
if("${asset_name}" STREQUAL "${filename}")
set(found "TRUE")
break()
endif()
endforeach()
set(${found_var} "${found}" PARENT_SCOPE)
endfunction()

# Download the specified release info from GitHub
file(DOWNLOAD "${version_url}" "${json_output_file}" STATUS download_statuses)
list(GET download_statuses 0 status_code)
if(status_code EQUAL 0)
file(READ "${json_output_file}" json_content)

# Check if the specified version contains the expected ZIP file
set(desired_zip "${repo}-${version}-${os}-${arch}.zip")
check_assets_for_file("${json_content}" "${desired_zip}" file_found)

if(file_found)
set(${out_var} "${version}" PARENT_SCOPE)
return()
endif()
message(WARNING "Failed to find ${desired_zip} in release assets for ${version} from ${version_url}.\nFalling back to latest version if it differs")
else()
message(WARNING "Failed to download release info for version ${version} from ${version_url}.\nFalling back to latest version if it differs")
endif()


# If not found, get the latest release tag
set(latest_release_url "https://api.github.com/repos/${owner}/${repo}/releases/latest")
file(DOWNLOAD "${latest_release_url}" "${json_output_file}" STATUS download_status)
list(GET download_status 0 status_code)
if(NOT status_code EQUAL 0)
message(WARNING "Failed to download latest release info from ${latest_release_url}")
return()
endif()

# Get the tag from this release json file
file(READ "${json_output_file}" latest_json_content)
string(JSON latest_release_tag GET "${latest_json_content}" "tag_name")
string(REGEX REPLACE "^v" "" latest_version "${latest_release_tag}")

if(latest_version EQUAL version)
# The versions are the same
message(WARNING "No release binary for ${os}-${arch} exists for ${version}")
return()
endif()

# Check if the expected ZIP file is in the latest release
set(desired_zip "${repo}-${latest_version}-${os}-${arch}.zip")
check_assets_for_file("${latest_json_content}" "${desired_zip}" file_found_latest)

if(file_found_latest)
# If we got it, we found a good version
set(${out_var} "${latest_version}" PARENT_SCOPE)
else()
message(WARNING "No release binary for ${os}-${arch} exists for ${version} or the latest version ${latest_version}")
endif()
endfunction()

function(get_best_slang_binary_release_url out_var)
if(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64")
set(arch "x86_64")
elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|ARM64|arm64")
set(arch "aarch64")
else()
message(WARNING "Unsupported architecture for slang binary releases: ${CMAKE_SYSTEM_PROCESSOR}")
return()
endif()

if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(os "windows")
elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
set(os "macos")
elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
set(os "linux")
else()
message(WARNING "Unsupported operating system for slang binary releases: ${CMAKE_SYSTEM_NAME}")
return()
endif()

set(owner "shader-slang")
set(repo "slang")

check_release_and_get_latest(${owner} ${repo} ${SLANG_VERSION_NUMERIC} ${os} ${arch} release_version)

set(${out_var} "https://github.com/${owner}/${repo}/releases/download/v${release_version}/slang-${release_version}-${os}-${arch}.zip" PARENT_SCOPE)
endfunction()
4 changes: 4 additions & 0 deletions docs/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ There are several options for getting llvm-support:
- You can set `SLANG_SLANG_LLVM_BINARY_URL` to point to a local
`libslang-llvm.so/slang-llvm.dll` or set it to a URL of an zip/archive
containing such a file
- If this isn't set then the build system tries to download it from the
release on github matching the current tag. If such a tag doesn't exist
or doesn't have the correct os*arch combination then the latest release
will be tried.
- Use a system supplied LLVM: `-DSLANG_SLANG_LLVM_FLAVOR=USE_SYSTEM_LLVM`, you
must have llvm-13.0 and a matching libclang installed. It's important that
either:
Expand Down

0 comments on commit 579d59c

Please sign in to comment.