mirror of
https://github.com/ggml-org/llama.cpp.git
synced 2026-10-03 03:17:32 -05:00
Aleksander Grygier
25f3c82768
Make the source build fallback (priority 3 in scripts/ui-assets.cmake) download llama-<version>-ui.tar.gz from GH Releases, verified against the asset digest from the GitHub API (available for all releases, including existing ones). When the exact version is not found, fall back to the most recent bNNNN release, resolved via the API (the releases are marked as prereleases, so /releases/latest does not match them). GH_TOKEN/GITHUB_TOKEN can be used for authenticated downloads. Remove LLAMA_UI_HF_BUCKET and the HF_UI_VERSION env var; the UI version is now always derived from LLAMA_BUILD_NUMBER. Assisted-by: pi:Kimi-K3
456 lines
16 KiB
CMake
456 lines
16 KiB
CMake
# Provision UI assets and generate ui.cpp/ui.h.
|
|
#
|
|
# Asset provisioning priority:
|
|
# 1. Pre-built assets in SRC_DIST_DIR (manually built by user)
|
|
# 2. If BUILD_UI=ON: npm build
|
|
# 3. If above did not produce assets and PREBUILT_ENABLED=ON: GH Releases
|
|
# download of llama-<version>-ui.tar.gz (verified against the asset digest)
|
|
|
|
cmake_minimum_required(VERSION 3.18)
|
|
|
|
set(UI_SOURCE_DIR "" CACHE STRING "UI source directory (to run npm build)")
|
|
set(UI_BINARY_DIR "" CACHE STRING "UI binary directory (to store generated files)")
|
|
set(LLAMA_SOURCE_DIR "" CACHE STRING "Project source root (to resolve version from git)")
|
|
set(UI_VERSION "" CACHE STRING "Version to download (empty = resolve from git)")
|
|
set(PREBUILT_ENABLED "" CACHE STRING "Whether to allow GH Releases download (ON/OFF)")
|
|
set(BUILD_UI "" CACHE STRING "Build UI via npm (ON/OFF)")
|
|
set(LLAMA_UI_EMBED "" CACHE STRING "Path to llama-ui-embed helper")
|
|
set(LLAMA_UI_GZIP "" CACHE STRING "Apply gzip compress to assets to save bandwidth")
|
|
|
|
set(DIST_DIR "${UI_BINARY_DIR}/dist")
|
|
set(SRC_DIST_DIR "${UI_SOURCE_DIR}/dist")
|
|
set(WORK_DIR "${UI_BINARY_DIR}/ui-src")
|
|
set(STAMP_FILE "${UI_BINARY_DIR}/.ui-stamp")
|
|
set(UI_CPP "${UI_BINARY_DIR}/ui.cpp")
|
|
set(UI_H "${UI_BINARY_DIR}/ui.h")
|
|
|
|
function(npm_build_should_skip out_var)
|
|
set(${out_var} FALSE PARENT_SCOPE)
|
|
|
|
if(NOT EXISTS "${DIST_DIR}/index.html")
|
|
return()
|
|
endif()
|
|
|
|
if(EXISTS "${STAMP_FILE}")
|
|
return()
|
|
endif()
|
|
|
|
if(NOT EXISTS "${UI_SOURCE_DIR}/sources.cmake")
|
|
return()
|
|
endif()
|
|
include("${UI_SOURCE_DIR}/sources.cmake")
|
|
|
|
set(globs "")
|
|
foreach(g ${UI_SOURCE_GLOBS})
|
|
list(APPEND globs "${UI_SOURCE_DIR}/${g}")
|
|
endforeach()
|
|
file(GLOB_RECURSE sources ${globs})
|
|
foreach(f ${UI_SOURCE_FILES})
|
|
list(APPEND sources "${UI_SOURCE_DIR}/${f}")
|
|
endforeach()
|
|
|
|
file(TIMESTAMP "${DIST_DIR}/index.html" out_ts)
|
|
|
|
foreach(s ${sources})
|
|
if(NOT EXISTS "${s}")
|
|
continue()
|
|
endif()
|
|
file(TIMESTAMP "${s}" s_ts)
|
|
if(s_ts STRGREATER out_ts)
|
|
return()
|
|
endif()
|
|
endforeach()
|
|
|
|
set(${out_var} TRUE PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
function(stage_sources)
|
|
if(EXISTS "${WORK_DIR}")
|
|
file(GLOB staged RELATIVE "${WORK_DIR}" "${WORK_DIR}/*")
|
|
list(REMOVE_ITEM staged "node_modules")
|
|
foreach(entry ${staged})
|
|
file(REMOVE_RECURSE "${WORK_DIR}/${entry}")
|
|
endforeach()
|
|
endif()
|
|
|
|
file(COPY "${UI_SOURCE_DIR}/"
|
|
DESTINATION "${WORK_DIR}"
|
|
NO_SOURCE_PERMISSIONS
|
|
PATTERN "node_modules" EXCLUDE
|
|
)
|
|
endfunction()
|
|
|
|
function(npm_build out_var)
|
|
set(${out_var} FALSE PARENT_SCOPE)
|
|
|
|
if(NOT EXISTS "${UI_SOURCE_DIR}/package.json")
|
|
message(STATUS "UI: ${UI_SOURCE_DIR}/package.json not found, skipping npm")
|
|
return()
|
|
endif()
|
|
|
|
npm_build_should_skip(skip)
|
|
if(skip)
|
|
message(STATUS "UI: npm output up-to-date, skipping build")
|
|
set(${out_var} TRUE PARENT_SCOPE)
|
|
return()
|
|
endif()
|
|
|
|
if(CMAKE_HOST_WIN32)
|
|
find_program(NPM_EXECUTABLE NAMES npm.cmd npm.bat npm)
|
|
else()
|
|
find_program(NPM_EXECUTABLE npm)
|
|
endif()
|
|
if(NOT NPM_EXECUTABLE)
|
|
message(STATUS "UI: npm not found, skipping npm build")
|
|
return()
|
|
endif()
|
|
|
|
stage_sources()
|
|
|
|
# npm writes node_modules/.package-lock.json on every successful install,
|
|
# so a package-lock.json newer than this marker means node_modules is stale
|
|
set(NPM_MARKER "${WORK_DIR}/node_modules/.package-lock.json")
|
|
set(need_install FALSE)
|
|
if(NOT EXISTS "${NPM_MARKER}")
|
|
set(need_install TRUE)
|
|
else()
|
|
file(TIMESTAMP "${WORK_DIR}/package-lock.json" lock_ts)
|
|
file(TIMESTAMP "${NPM_MARKER}" marker_ts)
|
|
if(lock_ts STRGREATER marker_ts)
|
|
set(need_install TRUE)
|
|
endif()
|
|
endif()
|
|
|
|
if(need_install)
|
|
message(STATUS "UI: running npm ci")
|
|
execute_process(
|
|
COMMAND ${NPM_EXECUTABLE} ci
|
|
WORKING_DIRECTORY "${WORK_DIR}"
|
|
RESULT_VARIABLE rc
|
|
ERROR_VARIABLE err
|
|
)
|
|
if(NOT rc EQUAL 0)
|
|
message(STATUS "UI: npm ci failed (${rc})")
|
|
message(STATUS " stderr: ${err}")
|
|
return()
|
|
endif()
|
|
endif()
|
|
|
|
file(MAKE_DIRECTORY "${DIST_DIR}")
|
|
|
|
message(STATUS "UI: running npm run build, output -> ${DIST_DIR}")
|
|
execute_process(
|
|
COMMAND ${CMAKE_COMMAND} -E env "LLAMA_UI_OUT_DIR=${DIST_DIR}" "LLAMA_BUILD_NUMBER=${LLAMA_BUILD_NUMBER}"
|
|
${NPM_EXECUTABLE} run build
|
|
WORKING_DIRECTORY "${WORK_DIR}"
|
|
RESULT_VARIABLE rc
|
|
ERROR_VARIABLE err
|
|
)
|
|
if(NOT rc EQUAL 0)
|
|
message(STATUS "UI: npm run build failed (${rc})")
|
|
message(STATUS " stderr: ${err}")
|
|
return()
|
|
endif()
|
|
|
|
if(NOT EXISTS "${DIST_DIR}/index.html")
|
|
message(STATUS "UI: npm build finished but assets missing in ${DIST_DIR}")
|
|
return()
|
|
endif()
|
|
|
|
message(STATUS "UI: npm build succeeded")
|
|
file(REMOVE "${STAMP_FILE}")
|
|
set(${out_var} TRUE PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
function(resolve_version out_var)
|
|
if(NOT "${UI_VERSION}" STREQUAL "")
|
|
set(${out_var} "${UI_VERSION}" PARENT_SCOPE)
|
|
return()
|
|
endif()
|
|
|
|
if(EXISTS "${LLAMA_SOURCE_DIR}/cmake/build-info.cmake")
|
|
include("${LLAMA_SOURCE_DIR}/cmake/build-info.cmake")
|
|
if(NOT "${BUILD_NUMBER}" STREQUAL "" AND NOT BUILD_NUMBER EQUAL 0)
|
|
set(${out_var} "b${BUILD_NUMBER}" PARENT_SCOPE)
|
|
return()
|
|
endif()
|
|
endif()
|
|
|
|
set(${out_var} "" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
# Resolve the most recent bNNNN release tag. The /releases/latest endpoint
|
|
# does not work here because the releases are marked as prereleases.
|
|
function(gh_latest_tag out_var)
|
|
set(${out_var} "" PARENT_SCOPE)
|
|
|
|
set(auth_headers "")
|
|
if(DEFINED ENV{GH_TOKEN} AND NOT "$ENV{GH_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GH_TOKEN}")
|
|
elseif(DEFINED ENV{GITHUB_TOKEN} AND NOT "$ENV{GITHUB_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GITHUB_TOKEN}")
|
|
endif()
|
|
|
|
set(json_file "${UI_BINARY_DIR}/gh-releases.json")
|
|
file(DOWNLOAD "https://api.github.com/repos/ggml-org/llama.cpp/releases?per_page=30" "${json_file}"
|
|
STATUS status TIMEOUT 30 ${auth_headers}
|
|
)
|
|
list(GET status 0 rc)
|
|
if(NOT rc EQUAL 0)
|
|
list(GET status 1 errmsg)
|
|
message(STATUS "UI: failed to query GH releases: ${errmsg}")
|
|
return()
|
|
endif()
|
|
|
|
file(READ "${json_file}" json)
|
|
file(REMOVE "${json_file}")
|
|
string(REGEX MATCHALL "\"tag_name\"[ \t]*:[ \t]*\"b[0-9]+\"" tags "${json}")
|
|
|
|
set(best 0)
|
|
set(best_tag "")
|
|
foreach(t ${tags})
|
|
string(REGEX MATCH "b[0-9]+" tag "${t}")
|
|
string(SUBSTRING "${tag}" 1 -1 num)
|
|
if(num GREATER best)
|
|
set(best ${num})
|
|
set(best_tag "${tag}")
|
|
endif()
|
|
endforeach()
|
|
|
|
set(${out_var} "${best_tag}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
# Get the sha256 digest of the UI asset of a release tag via the GH API.
|
|
# Available for all assets, including ones from older releases.
|
|
function(gh_asset_digest tag out_var)
|
|
set(${out_var} "" PARENT_SCOPE)
|
|
|
|
set(auth_headers "")
|
|
if(DEFINED ENV{GH_TOKEN} AND NOT "$ENV{GH_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GH_TOKEN}")
|
|
elseif(DEFINED ENV{GITHUB_TOKEN} AND NOT "$ENV{GITHUB_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GITHUB_TOKEN}")
|
|
endif()
|
|
|
|
set(json_file "${UI_BINARY_DIR}/gh-release-${tag}.json")
|
|
file(DOWNLOAD "https://api.github.com/repos/ggml-org/llama.cpp/releases/tags/${tag}" "${json_file}"
|
|
STATUS status TIMEOUT 30 ${auth_headers}
|
|
)
|
|
list(GET status 0 rc)
|
|
if(NOT rc EQUAL 0)
|
|
list(GET status 1 errmsg)
|
|
message(STATUS "UI: failed to query release ${tag}: ${errmsg}")
|
|
file(REMOVE "${json_file}")
|
|
return()
|
|
endif()
|
|
|
|
file(READ "${json_file}" json)
|
|
file(REMOVE "${json_file}")
|
|
|
|
# the digest of an asset is the first digest after its name in the response
|
|
string(FIND "${json}" "\"llama-${tag}-ui.tar.gz\"" pos)
|
|
if(pos EQUAL -1)
|
|
message(STATUS "UI: release ${tag} has no UI asset")
|
|
return()
|
|
endif()
|
|
string(SUBSTRING "${json}" ${pos} -1 rest)
|
|
string(REGEX MATCH "\"digest\"[ \t]*:[ \t]*\"sha256:([0-9a-f]+)\"" match "${rest}")
|
|
if(NOT match)
|
|
message(STATUS "UI: no digest found for the UI asset of ${tag}")
|
|
return()
|
|
endif()
|
|
|
|
set(${out_var} "${CMAKE_MATCH_1}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
function(gh_download version out_var out_resolved)
|
|
set(${out_var} FALSE PARENT_SCOPE)
|
|
set(${out_resolved} "" PARENT_SCOPE)
|
|
|
|
set(archive "${UI_BINARY_DIR}/ui.tar.gz")
|
|
|
|
# Use GH_TOKEN to benefit from higher rate limits
|
|
set(auth_headers "")
|
|
if(DEFINED ENV{GH_TOKEN} AND NOT "$ENV{GH_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GH_TOKEN}")
|
|
elseif(DEFINED ENV{GITHUB_TOKEN} AND NOT "$ENV{GITHUB_TOKEN}" STREQUAL "")
|
|
list(APPEND auth_headers "HTTPHEADER" "Authorization: Bearer $ENV{GITHUB_TOKEN}")
|
|
endif()
|
|
|
|
set(candidates "")
|
|
if(NOT "${version}" STREQUAL "")
|
|
list(APPEND candidates "${version}")
|
|
endif()
|
|
gh_latest_tag(latest_tag)
|
|
if(NOT "${latest_tag}" STREQUAL "")
|
|
list(APPEND candidates "${latest_tag}")
|
|
endif()
|
|
list(REMOVE_DUPLICATES candidates)
|
|
|
|
foreach(resolved ${candidates})
|
|
set(base "https://github.com/ggml-org/llama.cpp/releases/download/${resolved}")
|
|
set(asset "llama-${resolved}-ui.tar.gz")
|
|
|
|
gh_asset_digest(${resolved} expected)
|
|
if("${expected}" STREQUAL "")
|
|
continue()
|
|
endif()
|
|
|
|
message(STATUS "UI: downloading ${base}/${asset}")
|
|
|
|
file(DOWNLOAD "${base}/${asset}" "${archive}"
|
|
STATUS status TIMEOUT 300 ${auth_headers}
|
|
)
|
|
list(GET status 0 rc)
|
|
if(NOT rc EQUAL 0)
|
|
list(GET status 1 errmsg)
|
|
message(STATUS "UI: download ${asset} failed: ${errmsg}")
|
|
continue()
|
|
endif()
|
|
|
|
# Validate against the release asset digest
|
|
file(SHA256 "${archive}" actual)
|
|
if(NOT "${actual}" STREQUAL "${expected}")
|
|
message(STATUS "UI: checksum mismatch for ${asset}")
|
|
continue()
|
|
endif()
|
|
|
|
# The release archive wraps the assets in a llama-<tag>/ directory
|
|
set(extract_dir "${UI_BINARY_DIR}/ui-extract")
|
|
file(REMOVE_RECURSE "${extract_dir}")
|
|
file(MAKE_DIRECTORY "${extract_dir}")
|
|
file(ARCHIVE_EXTRACT INPUT "${archive}" DESTINATION "${extract_dir}")
|
|
|
|
if(NOT EXISTS "${extract_dir}/llama-${resolved}/index.html")
|
|
message(STATUS "UI: archive ${asset} is missing required assets")
|
|
continue()
|
|
endif()
|
|
|
|
# Clear DIST_DIR to remove stale files first
|
|
file(REMOVE_RECURSE "${DIST_DIR}")
|
|
file(RENAME "${extract_dir}/llama-${resolved}" "${DIST_DIR}")
|
|
file(REMOVE_RECURSE "${extract_dir}")
|
|
|
|
message(STATUS "UI: archive verified and extracted")
|
|
set(${out_var} TRUE PARENT_SCOPE)
|
|
set(${out_resolved} "${resolved}" PARENT_SCOPE)
|
|
return()
|
|
endforeach()
|
|
endfunction()
|
|
|
|
function(emit_files dist_dir)
|
|
# If gzip is requested, compress every asset into a parallel _gzip/ tree
|
|
# the structure stays the same; for ex: /abc/def --> /_gzip/abc/def
|
|
# embed.cpp will check for _gzip and will pick it up
|
|
if(LLAMA_UI_GZIP AND EXISTS "${dist_dir}/index.html")
|
|
find_program(GZIP_EXECUTABLE gzip)
|
|
if(NOT GZIP_EXECUTABLE)
|
|
message(WARNING "UI: LLAMA_UI_GZIP requested but gzip not found, embedding uncompressed")
|
|
else()
|
|
set(gzip_dir "${dist_dir}/_gzip")
|
|
file(REMOVE_RECURSE "${gzip_dir}")
|
|
file(GLOB_RECURSE all_files RELATIVE "${dist_dir}" "${dist_dir}/*")
|
|
foreach(f ${all_files})
|
|
get_filename_component(dst_dir "${gzip_dir}/${f}" DIRECTORY)
|
|
file(MAKE_DIRECTORY "${dst_dir}")
|
|
execute_process(
|
|
COMMAND "${GZIP_EXECUTABLE}" -c "${dist_dir}/${f}"
|
|
OUTPUT_FILE "${gzip_dir}/${f}"
|
|
RESULT_VARIABLE gz_rc
|
|
)
|
|
if(NOT gz_rc EQUAL 0)
|
|
message(FATAL_ERROR "UI: gzip failed for ${f}")
|
|
endif()
|
|
endforeach()
|
|
message(STATUS "UI: gzip compression applied (${gzip_dir})")
|
|
endif()
|
|
endif()
|
|
|
|
set(args "${UI_CPP}" "${UI_H}")
|
|
if(EXISTS "${dist_dir}/index.html")
|
|
list(APPEND args "${dist_dir}")
|
|
endif()
|
|
|
|
execute_process(
|
|
COMMAND "${LLAMA_UI_EMBED}" ${args}
|
|
RESULT_VARIABLE rc
|
|
)
|
|
if(NOT rc EQUAL 0)
|
|
message(FATAL_ERROR "UI: llama-ui-embed failed (${rc})")
|
|
endif()
|
|
endfunction()
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# 1. Priority 1: pre-built assets supplied in tools/ui/dist
|
|
# ---------------------------------------------------------------------------
|
|
if(EXISTS "${SRC_DIST_DIR}/index.html")
|
|
message(STATUS "UI: using pre-built assets from ${SRC_DIST_DIR}")
|
|
emit_files("${SRC_DIST_DIR}")
|
|
return()
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# 2. Priority 2: npm build (if BUILD_UI=ON)
|
|
# ---------------------------------------------------------------------------
|
|
set(provisioned FALSE)
|
|
|
|
if(BUILD_UI)
|
|
# Resolve version from git build-info if not explicitly set
|
|
resolve_version(UI_VERSION)
|
|
npm_build(NPM_OK)
|
|
if(NPM_OK)
|
|
set(provisioned TRUE)
|
|
endif()
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# 3. Priority 3: GH Releases download (if npm did not produce assets and PREBUILT_ENABLED=ON)
|
|
# ---------------------------------------------------------------------------
|
|
if(NOT provisioned AND PREBUILT_ENABLED)
|
|
resolve_version(VERSION)
|
|
|
|
set(stamp_ok FALSE)
|
|
if(EXISTS "${STAMP_FILE}" AND NOT "${VERSION}" STREQUAL "")
|
|
file(READ "${STAMP_FILE}" stamped)
|
|
string(STRIP "${stamped}" stamped)
|
|
if("${stamped}" STREQUAL "${VERSION}")
|
|
set(stamp_ok TRUE)
|
|
endif()
|
|
endif()
|
|
|
|
set(have_assets FALSE)
|
|
if(EXISTS "${DIST_DIR}/index.html")
|
|
set(have_assets TRUE)
|
|
endif()
|
|
if(stamp_ok AND have_assets)
|
|
message(STATUS "UI: stamp '${stamped}' matches version, skipping GH Releases fetch")
|
|
set(provisioned TRUE)
|
|
else()
|
|
gh_download("${VERSION}" GH_OK GH_RESOLVED)
|
|
if(GH_OK)
|
|
file(WRITE "${STAMP_FILE}" "${GH_RESOLVED}")
|
|
message(STATUS "UI: GH Releases download succeeded, stamp updated (${GH_RESOLVED})")
|
|
set(provisioned TRUE)
|
|
else()
|
|
message(STATUS "UI: GH Releases download failed")
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# 4. Fallback: warn about stale or missing assets, then emit whatever we have
|
|
# ---------------------------------------------------------------------------
|
|
if(NOT provisioned)
|
|
if(EXISTS "${DIST_DIR}/index.html")
|
|
message(WARNING "UI: provisioning failed; embedding stale assets from ${DIST_DIR}")
|
|
else()
|
|
message(WARNING "UI: no assets available - building without an embedded UI. "
|
|
"In a disconnected environment, download llama-<version>-ui.tar.gz "
|
|
"from a llama.cpp release at "
|
|
"https://github.com/ggml-org/llama.cpp/releases and "
|
|
"extract to tools/ui/dist.")
|
|
endif()
|
|
endif()
|
|
|
|
emit_files("${DIST_DIR}")
|