Support augment_platform in JLLWrappers

.github/workflows/ci.yml

@@ -17,7 +17,8 @@ jobs:
           - "1.3"
           - "1.4"
           - "1.5"
-          - "^1.6.0-0"
+          - "1.6"
+          - "1.7"
           - "nightly"
         os:
           - ubuntu-latest

Project.toml

@@ -1,7 +1,7 @@
 name = "JLLWrappers"
 uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
 authors = ["Mosè Giordano", "Elliot Saba"]
-version = "1.3.0"
+version = "1.4.0"
 
 [deps]
 Preferences = "21216c6a-2e73-6563-6e65-726566657250"

src/toplevel_generators.jl

@@ -74,7 +74,6 @@ This method generates the toplevel definitions common to all JLL packages, such
 `is_available()`, the `PATH` and `LIBPATH` symbols, etc....
 """
 function generate_toplevel_definitions(src_name, __source__)
-    pkg_dir = dirname(String(__source__.file))
     return quote
         """
             is_available()
@@ -120,6 +119,12 @@ function generate_wrapper_load(src_name, pkg_uuid, __source__)
         # Load Artifacts.toml file and select best platform at compile-time, since this is
         # running at toplevel, and therefore will be run completely at compile-time.  We use
         # a `let` block here to avoid storing unnecessary data in our `.ji` files
+
+        if @isdefined(augment_platform!)
+            const host_platform = augment_platform!(HostPlatform())
+        else
+            const host_platform = nothing
+        end
         best_wrapper = let
             artifacts_toml = joinpath($(pkg_dir), "..", "Artifacts.toml")
             valid_wrappers = Dict{Platform,String}()
@@ -158,13 +163,19 @@ function generate_wrapper_load(src_name, pkg_uuid, __source__)
                 end
 
                 # From the available options, choose the best wrapper script
-                select_platform(valid_wrappers)
+                # The two argument `select_platform` is notably slower, so micro-optimize this by
+                # only calling it when necessary.
+                if host_platform !== nothing
+                    select_platform(valid_wrappers, host_platform)
+                else
+                    select_platform(valid_wrappers)
+                end
             end
         end
 
         # Load in the wrapper, if it's not `nothing`!
         if best_wrapper === nothing
-            @debug(string("Unable to load ", $(src_name), "; unsupported platform ", triplet(HostPlatform())))
+            @debug(string("Unable to load ", $(src_name), "; unsupported platform ", triplet(host_platform)))
             is_available() = false
         else
             Base.include($(Symbol("$(src_name)_jll")), best_wrapper)

src/wrapper_generators.jl

@@ -9,6 +9,8 @@ macro generate_wrapper_header(src_name)
             # We determine at compile-time whether our JLL package has been dev'ed and overridden
             @static if isdir(joinpath(dirname($(pkg_dir)), "override"))
                 return joinpath(dirname($(pkg_dir)), "override")
+            elseif @isdefined(augment_platform!) && VERSION >= v"1.6"
+                $(Expr(:macrocall, Symbol("@artifact_str"), __source__, src_name, :(host_platform)))
             else
                 # We explicitly use `macrocall` here so that we can manually pass the `__source__`
                 # argument, to avoid `@artifact_str` trying to lookup `Artifacts.toml` here.
@@ -24,8 +26,8 @@ macro generate_init_header(dependencies...)
     if !isempty(dependencies)
         for dep in dependencies
             push!(deps_path_add, quote
-                append!(PATH_list, $(dep).PATH_list)
-                append!(LIBPATH_list, $(dep).LIBPATH_list)
+                isdefined($(dep), :PATH_list) && append!(PATH_list, $(dep).PATH_list)
+                isdefined($(dep), :LIBPATH_list) && append!(LIBPATH_list, $(dep).LIBPATH_list)
             end)
         end
     end

test/LAMMPS_jll/.pkg/platform_augmentation.jl

@@ -0,0 +1,11 @@
+using Base.BinaryPlatforms
+
+function augment_platform!(platform)
+    # Can't use Preferences since we might be running this very early with a non-existing Manifest
+    LAMMPS_UUID = Base.UUID("5b3ab26d-9607-527c-88ea-8fe5ba57cafe")
+    abi = get(Base.get_preferences(LAMMPS_UUID), "abi", Sys.iswindows() ? "microsoftmpi" : "mpich")
+    if !haskey(platform, "mpi")
+        platform["mpi"] = abi
+    end
+    return platform
+end

test/LAMMPS_jll/.pkg/select_artifacts.jl

@@ -0,0 +1,22 @@
+# Note: This file is executed from `Pkg` in an isolated environment.
+# Warn: Since this is executed in a sandbox, the current preferences are not
+#       propagated and thus no decision can be made based on them.
+#       Use LazyArtifacts in this case.
+#       Fixed in https://github.com/JuliaLang/Pkg.jl/pull/2920
+
+push!(Base.LOAD_PATH, dirname(@__DIR__))
+using TOML, Artifacts, Base.BinaryPlatforms
+include("./platform_augmentation.jl")
+artifacts_toml = joinpath(dirname(@__DIR__), "Artifacts.toml")
+
+# Get "target triplet" from ARGS, if given (defaulting to the host triplet otherwise)
+target_triplet = get(ARGS, 1, Base.BinaryPlatforms.host_triplet())
+
+# Augment this platform object with any special tags we require
+platform = augment_platform!(HostPlatform(parse(Platform, target_triplet)))
+
+# Select all downloadable artifacts that match that platform
+artifacts = select_downloadable_artifacts(artifacts_toml; platform, include_lazy = true)
+
+#Output the result to `stdout` as a TOML dictionary
+TOML.print(stdout, artifacts)