Merge pull request #58 from JuliaMath/sf/ilp64_accelerate

Use LBT to forward BLAS and LAPACK calls to Accelerate

Author: ViralBShah

.github/workflows/CI.yml

@@ -16,9 +16,9 @@ jobs:
           - '1'
           - 'nightly'
         os:
+          - macOS-13
           - ubuntu-latest
-          - macOS-12
-#          - windows-latest
+          - windows-latest
         arch:
           - x64
     steps:

Project.toml

@@ -1,19 +1,30 @@
 name = "AppleAccelerate"
 uuid = "13e28ba4-7ad8-5781-acae-3021b1ed3924"
-version = "0.3.3"
+version = "0.4.0"
 
 [deps]
+LAPACK32_jll = "17f450c3-bd24-55df-bb84-8c51b4b939e3"
+LAPACK_jll = "51474c39-65e3-53ba-86ba-03b1b862ec14"
 Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 
 [compat]
-julia = "1.6"
+julia = "1.9"
+LAPACK32_jll = "3.11"
+LAPACK_jll = "3.11"
 
 [extras]
-DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
-LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
+DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["DSP", "Statistics", "LinearAlgebra", "Test", "Random"]
+test = ["Dates", "Distributed", "Printf", "Random", "REPL", "Sockets", "SparseArrays", "SpecialFunctions", "DSP", "Statistics", "Test"]

README.md

@@ -10,7 +10,7 @@ functions, though there does appear to be some reduced accuracy.
 
 ## OS Requirements
 
-MacOS 12 is required in order to run AppleAccelerate.jl. On older MacOS versions, your mileage may vary.
+MacOS 13.3 is required in order to run AppleAccelerate.jl. On older MacOS versions, your mileage may vary.
 
 ## Supported Functions
 

src/AppleAccelerate.jl

@@ -1,23 +1,100 @@
 module AppleAccelerate
 
-using Libdl
+using LinearAlgebra
+using Libdl, LAPACK_jll, LAPACK32_jll
 
-if Sys.isapple()
+# For now, only use BLAS from Accelerate (that is to say, vecLib)
+global const libacc = "/System/Library/Frameworks/Accelerate.framework/Accelerate"
+global const libacc_info_plist = "/System/Library/Frameworks/Accelerate.framework/Versions/Current/Resources/Info.plist"
+
+function forward_accelerate(interface::Symbol;
+                            new_lapack::Bool = interface == :ilp64,
+                            clear::Bool = false,
+                            verbose::Bool = false)
+    kwargs = Dict{Symbol,String}()
+    if new_lapack
+        if interface == :ilp64
+            kwargs[:suffix_hint] = "\x1a\$NEWLAPACK\$ILP64"
+        else
+            kwargs[:suffix_hint] = "\x1a\$NEWLAPACK"
+        end
+    else
+        if interface == :ilp64
+            throw(ArgumentError("ILP64 accelerate requires new_lapack"))
+        end
+    end
+    BLAS.lbt_forward(libacc; clear, verbose, kwargs...)
+end
+
+"""
+    load_accelerate(;clear = true, verbose = false)
+
+Load Accelerate, replacing the current LBT forwarding tables if `clear` is `true`.
+Attempts to load the ILP64 symbols if `load_ilp64` is `true`, and errors out if unable.
+"""
+function load_accelerate(;clear::Bool = true, verbose::Bool = false, load_ilp64::Bool = true, use_external_lapack::Bool = true)
+    # Silently exit on non-Accelerate-capable platforms
+    @static if !Sys.isapple()
+        return
+    end
+    libacc_hdl = dlopen_e(libacc)
+    if libacc_hdl == C_NULL
+        return
+    end
+
+    # Check to see if we can load ILP64 symbols
+    if load_ilp64 && dlsym_e(libacc_hdl, "dgemm\$NEWLAPACK\$ILP64") == C_NULL
+        error("Unable to load ILP64 interface from '$(libacc)'; You are running macOS version $(get_macos_version()), you need v13.3+")
+    end
+
+    # First, load :lp64 symbols, optionally clearing the current LBT forwarding tables
+    forward_accelerate(:lp64; new_lapack=true, clear, verbose)
+    if load_ilp64
+        forward_accelerate(:ilp64; new_lapack=true, verbose)
+    end
 
-    try
-        global const libacc = "/System/Library/Frameworks/Accelerate.framework/Accelerate"
-        let accel_lib = dlopen(libacc)
-            dlclose(accel_lib)
+    # Next, load an external LAPACK, if requested
+    if use_external_lapack
+        if load_ilp64
+            BLAS.lbt_forward(LAPACK_jll.liblapack_path; suffix_hint="64_", verbose)
         end
-    catch
-        error("Accelerate framework not found.")
+        BLAS.lbt_forward(LAPACK32_jll.liblapack32_path; verbose)
+    end
+end
+
+function get_macos_version()
+    @static if !Sys.isapple()
+        return nothing
     end
 
+    plist_lines = split(String(read("/System/Library/CoreServices/SystemVersion.plist")), "\n")
+    vers_idx = findfirst(l -> occursin("ProductVersion", l), plist_lines)
+    if vers_idx === nothing
+        return nothing
+    end
+
+    m = match(r">([\d\.]+)<", plist_lines[vers_idx+1])
+    if m === nothing
+        return nothing
+    end
 
+    return VersionNumber(only(m.captures))
+end
+
+function __init__()
+    # Default to loading the ILP64 interface on macOS 13.3+
+    ver = get_macos_version()
+    ver == nothing && return
+    load_ilp64 = ver >= v"13.3"
+    # dsptrf has a bug in the initial release of the $NEWLAPACK symbols, so if we're
+    # on a version older than macOS 13.4, use an external LAPACK:
+    load_accelerate(; load_ilp64, use_external_lapack = ver < v"13.4")
+end
+
+if Sys.isapple()
     include("Array.jl")
     include("DSP.jl")
     include("Util.jl")
-
 end
 
 end # module