feat: glibc 2.17 and musl prebuilt binaries

closes #160

Author: Saghen

.github/workflows/release.yaml

@@ -14,24 +14,42 @@ jobs:
     strategy:
       matrix:
         include:
-          # Linux builds (statically linked for compatibility, have to use glibc for FFI)
-          # TODO: check if we still need glibc on mlua
+          ## Linux builds
+          # Glibc 2.31
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
             artifact_name: target/x86_64-unknown-linux-gnu/release/libblink_cmp_fuzzy.so
           - os: ubuntu-latest
             target: aarch64-unknown-linux-gnu
             artifact_name: target/aarch64-unknown-linux-gnu/release/libblink_cmp_fuzzy.so
+          # Glibc 2.17
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            target_name: x86_64-unknown-linux-gnu-legacy
+            legacy: true
+            artifact_name: target/x86_64-unknown-linux-gnu/release/libblink_cmp_fuzzy.so
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            target_name: aarch64-unknown-linux-gnu-legacy
+            legacy: true
+            artifact_name: target/aarch64-unknown-linux-gnu/release/libblink_cmp_fuzzy.so
+          # Musl 1.2.3
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            artifact_name: target/x86_64-unknown-linux-musl/release/libblink_cmp_fuzzy.so
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-musl
+            artifact_name: target/aarch64-unknown-linux-musl/release/libblink_cmp_fuzzy.so
 
-          # macOS builds
+          ## macOS builds
           - os: macos-latest
             target: x86_64-apple-darwin
             artifact_name: target/x86_64-apple-darwin/release/libblink_cmp_fuzzy.dylib
           - os: macos-latest
             target: aarch64-apple-darwin
             artifact_name: target/aarch64-apple-darwin/release/libblink_cmp_fuzzy.dylib
 
-          # Windows builds
+          ## Windows builds
           - os: windows-latest
             target: x86_64-pc-windows-msvc
             artifact_name: target/x86_64-pc-windows-msvc/release/blink_cmp_fuzzy.dll
@@ -46,16 +64,26 @@ jobs:
           rustup target add ${{ matrix.target }}
 
       - name: Build for Linux
-        if: contains(matrix.os, 'ubuntu')
+        if: contains(matrix.os, 'ubuntu') && !matrix.legacy
         run: |
           cargo install cross --git https://github.com/cross-rs/cross
-          RUSTFLAGS="-C target-feature=-crt-static" cross build --release --target ${{ matrix.target }}
+          cross build --release --target ${{ matrix.target }}
           mv "${{ matrix.artifact_name }}" "${{ matrix.target }}.so"
 
+      - name: Build for Linux (legacy)
+        if: contains(matrix.os, 'ubuntu') && matrix.legacy
+        run: |
+          echo "[target.aarch64-unknown-linux-gnu]" >> Cross.toml
+          echo "image = \"ghcr.io/cross-rs/${{ matrix.target }}:main-centos\"" >> Cross.toml
+
+          cargo install cross --git https://github.com/cross-rs/cross
+          cross build --release --target ${{ matrix.target }}
+          mv "${{ matrix.artifact_name }}" "${{ matrix.target_name || matrix.target }}.so"
+
       - name: Build for macOS
         if: contains(matrix.os, 'macos')
         run: |
-          # Ventura
+          # Ventura (https://en.wikipedia.org/wiki/MacOS_version_history#Releases)
           MACOSX_DEPLOYMENT_TARGET="13" cargo build --release --target ${{ matrix.target }}
           mv "${{ matrix.artifact_name }}" "${{ matrix.target }}.dylib"
 
@@ -68,8 +96,8 @@ jobs:
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ matrix.target }}
-          path: ${{ matrix.target }}.*
+          name: ${{ matrix.target_name || matrix.target }}
+          path: ${{ matrix.target_name || matrix.target }}.*
 
   release:
     name: Release

README.md

@@ -258,15 +258,20 @@ MiniDeps.add({
     -- controls which sorts to use and in which order, these three are currently the only allowed options
     sorts = { 'label', 'kind', 'score' },
 
-    prebuiltBinaries = {
+    prebuilt_binaries = {
       -- Whether or not to automatically download a prebuilt binary from github. If this is set to `false`
       -- you will need to manually build the fuzzy binary dependencies by running `cargo build --release`
       download = true,
-      -- When downloading a prebuilt binary force the downloader to resolve this version. If this is uset
+      -- When downloading a prebuilt binary, force the downloader to resolve this version. If this is unset
       -- then the downloader will attempt to infer the version from the checked out git tag (if any).
       --
       -- Beware that if the FFI ABI changes while tracking main then this may result in blink breaking.
-      forceVersion = nil,
+      force_version = nil,
+      -- When downloading a prebuilt binary, force the downloader to use this system triple. If this is unset
+      -- then the downloader will attempt to infer the system triple from `jit.os` and `jit.arch`.
+      --
+      -- Beware that if the FFI ABI changes while tracking main then this may result in blink breaking.
+      force_system_triple = nil,
     },
   },
 

lua/blink/cmp/config.lua

@@ -86,15 +86,16 @@
 
 --- @class blink.cmp.PrebuiltBinariesConfig
 --- @field download? boolean
---- @field forceVersion? string | nil
+--- @field force_version? string | nil
+--- @field force_system_triple? string | nil
 
 --- @class blink.cmp.FuzzyConfig
 --- @field use_typo_resistance? boolean
 --- @field use_frecency? boolean
 --- @field use_proximity? boolean
 --- @field max_items? number
 --- @field sorts? ("label" | "kind" | "score")[]
---- @field prebuiltBinaries? blink.cmp.PrebuiltBinariesConfig
+--- @field prebuilt_binaries? blink.cmp.PrebuiltBinariesConfig
 
 --- @class blink.cmp.WindowConfig
 --- @field autocomplete? blink.cmp.AutocompleteConfig
@@ -285,15 +286,20 @@ local config = {
     -- controls which sorts to use and in which order, these three are currently the only allowed options
     sorts = { 'label', 'kind', 'score' },
 
-    prebuiltBinaries = {
+    prebuilt_binaries = {
       -- Whether or not to automatically download a prebuilt binary from github. If this is set to `false`
       -- you will need to manually build the fuzzy binary dependencies by running `cargo build --release`
       download = true,
       -- When downloading a prebuilt binary force the downloader to resolve this version. If this is uset
       -- then the downloader will attempt to infer the version from the checked out git tag (if any).
       --
       -- Beware that if the FFI ABI changes while tracking main then this may result in blink breaking.
-      forceVersion = nil,
+      force_version = nil,
+      -- When downloading a prebuilt binary, force the downloader to use this system triple. If this is unset
+      -- then the downloader will attempt to infer the system triple from `jit.os` and `jit.arch`.
+      --
+      -- Beware that if the FFI ABI changes while tracking main then this may result in blink breaking.
+      force_system_triple = nil,
     },
   },
 

lua/blink/cmp/fuzzy/download.lua

@@ -1,4 +1,4 @@
-local download_config = require('blink.cmp.config').fuzzy.prebuiltBinaries
+local download_config = require('blink.cmp.config').fuzzy.prebuilt_binaries
 
 local download = {}
 
@@ -15,40 +15,40 @@ local version_path = root_dir .. '../../../../target/release/version.txt'
 
 --- @param callback fun(err: string | nil)
 function download.ensure_downloaded(callback)
-  local function cb(err)
-    vim.schedule(function() callback(err) end)
-  end
+  callback = vim.schedule_wrap(callback)
 
-  if not download_config.download then return cb() end
+  if not download_config.download then return callback() end
 
   download.get_git_tag(function(git_version_err, git_version)
-    if git_version_err then return cb(git_version_err) end
+    if git_version_err then return callback(git_version_err) end
 
     download.get_downloaded_version(function(version_err, version)
       download.is_downloaded(function(downloaded)
-        local target_version = download_config.forceVersion or git_version
+        local target_version = download_config.force_version or git_version
 
         -- not built locally, not a git tag, error
         if not downloaded and not target_version then
-          return cb(
-            "Can't download from github due to not being on a git tag and no fuzzy.prebuiltBinaries.forceVersion set, but found no built version of the library. "
-              .. 'Either run `cargo build --release` via your package manager, switch to a git tag, or set `fuzzy.prebuiltBinaries.forceVersion` in config. '
+          return callback(
+            "Can't download from github due to not being on a git tag and no fuzzy.prebuilt_binaries.force_version set, but found no built version of the library. "
+              .. 'Either run `cargo build --release` via your package manager, switch to a git tag, or set `fuzzy.prebuilt_binaries.force_version` in config. '
               .. 'See the README for more info.'
           )
         end
         -- built locally, ignore
-        if downloaded and (version_err or version == nil) then return cb() end
+        if downloaded and (version_err or version == nil) then return callback() end
         -- already downloaded and the correct version
-        if version == target_version and downloaded then return cb() end
+        if version == target_version and downloaded then return callback() end
         -- unknown state
-        if not target_version then return cb('Unknown error while getting pre-built binary. Consider re-installing') end
+        if not target_version then
+          return callback('Unknown error while getting pre-built binary. Consider re-installing')
+        end
 
         -- download from github and set version
         download.from_github(target_version, function(download_err)
-          if download_err then return cb(download_err) end
+          if download_err then return callback(download_err) end
           download.set_downloaded_version(target_version, function(set_err)
-            if set_err then return cb(set_err) end
-            cb()
+            if set_err then return callback(set_err) end
+            callback()
           end)
         end)
       end)
@@ -85,22 +85,23 @@ end
 --- @param tag string
 --- @param cb fun(err: string | nil)
 function download.from_github(tag, cb)
-  local system_triple = download.get_system_triple()
-  if not system_triple then
-    return cb(
-      'Your system is not supported by pre-built binaries. You must run cargo build --release via your package manager with rust nightly. See the README for more info.'
-    )
-  end
+  download.get_system_triple(function(system_triple)
+    if not system_triple then
+      return cb(
+        'Your system is not supported by pre-built binaries. You must run cargo build --release via your package manager with rust nightly. See the README for more info.'
+      )
+    end
 
-  local url = 'https://github.com/saghen/blink.cmp/releases/download/'
-    .. tag
-    .. '/'
-    .. system_triple
-    .. download.get_lib_extension()
+    local url = 'https://github.com/saghen/blink.cmp/releases/download/'
+      .. tag
+      .. '/'
+      .. system_triple
+      .. download.get_lib_extension()
 
-  vim.system({ 'curl', '--create-dirs', '-fLo', download.lib_path, url }, {}, function(out)
-    if out.code ~= 0 then cb('Failed to download pre-build binaries: ' .. out.stderr) end
-    cb()
+    vim.system({ 'curl', '--create-dirs', '-fLo', download.lib_path, url }, {}, function(out)
+      if out.code ~= 0 then cb('Failed to download pre-build binaries: ' .. out.stderr) end
+      cb()
+    end)
   end)
 end
 
@@ -129,18 +130,44 @@ function download.set_downloaded_version(version, cb)
   end)
 end
 
---- @return string | nil
-function download.get_system_triple()
+--- @param cb fun(triple: string | nil)
+function download.get_system_triple(cb)
+  if download_config.force_system_triple then return cb(download_config.force_system_triple) end
+
+  if jit.os:lower() == 'mac' or jit.os:lower() == 'osx' then
+    if jit.arch:lower():match('arm') then return cb('aarch64-apple-darwin') end
+    if jit.arch:lower():match('x64') then return cb('x86_64-apple-darwin') end
+  elseif jit.os:lower() == 'windows' then
+    if jit.arch:lower():match('x64') then return cb('x86_64-pc-windows-msvc') end
+  elseif jit.os:lower() == 'linux' then
+    vim.system({ 'uname', '-a' }, {}, function(out)
+      local libc = 'gnu'
+      if out.stdout:lower():match('alpine') then libc = 'musl' end
+
+      if jit.arch:lower():match('arm') then return cb('aarch64-unknown-linux-' .. libc) end
+      if jit.arch:lower():match('x64') then return cb('x86_64-unknown-linux-' .. libc) end
+      return cb(nil)
+    end)
+  else
+    return cb(nil)
+  end
+end
+
+function download.get_system_triple_sync()
+  if download_config.force_system_triple then return download_config.force_system_triple end
+
   if jit.os:lower() == 'mac' or jit.os:lower() == 'osx' then
     if jit.arch:lower():match('arm') then return 'aarch64-apple-darwin' end
     if jit.arch:lower():match('x64') then return 'x86_64-apple-darwin' end
-  end
-  if jit.os:lower() == 'windows' then
+  elseif jit.os:lower() == 'windows' then
     if jit.arch:lower():match('x64') then return 'x86_64-pc-windows-msvc' end
-  end
-  if jit.os:lower() ~= 'windows' then
-    if jit.arch:lower():match('arm') then return 'aarch64-unknown-linux-gnu' end
-    if jit.arch:lower():match('x64') then return 'x86_64-unknown-linux-gnu' end
+  elseif jit.os:lower() == 'linux' then
+    local libc = 'gnu'
+    local out = vim.system({ 'uname', '-a' }, {}):wait()
+    if out.stdout:lower():match('alpine') then libc = 'musl' end
+
+    if jit.arch:lower():match('arm') then return 'aarch64-unknown-linux-' .. libc end
+    if jit.arch:lower():match('x64') then return 'x86_64-unknown-linux-' .. libc end
   end
 end
 

lua/blink/cmp/health.lua

@@ -1,7 +1,7 @@
-local M = {}
+local health = {}
 local download = require('blink.cmp.fuzzy.download')
 
-M.check = function()
+health.check = function()
   vim.health.start('blink.cmp healthcheck')
 
   local required_executables = { 'curl', 'git' }
@@ -14,7 +14,7 @@ M.check = function()
   end
 
   -- check if os is supported
-  local system_triple = download.get_system_triple()
+  local system_triple = download.get_system_triple_sync()
   if system_triple then
     vim.health.ok('Your system is supported by pre-built binaries (' .. system_triple .. ')')
   else
@@ -32,4 +32,4 @@ M.check = function()
     vim.health.warn('blink_cmp_fuzzy lib is not downloaded/built')
   end
 end
-return M
+return health