Show the plaform triplet in each warning and error from the auditor

Makes it a bit easier to nail down which platforms are producing the warnings.

Author: JamesWrigley

src/Auditor.jl

@@ -84,7 +84,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
             readmeta(f) do oh
                 if !is_for_platform(oh, platform)
                     if verbose
-                        @warn("Skipping binary analysis of $(relpath(f, prefix.path)) (incorrect platform)")
+                        @warn("Skipping binary analysis of $(relpath(f, prefix.path)) (incorrect platform)", platform=triplet(platform))
                     end
                 else
                     # Check that the ISA isn't too high
@@ -97,7 +97,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
                     # should be done when autofix=true, but we have to run this fix on MKL
                     # for Windows, for which however we have to set autofix=false:
                     # https://github.com/JuliaPackaging/Yggdrasil/pull/922.
-                    all_ok &= ensure_executability(oh; verbose, silent)
+                    all_ok &= ensure_executability(oh, platform; verbose, silent)
 
                     # If this is a dynamic object, do the dynamic checks
                     if isdynamic(oh)
@@ -168,7 +168,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
                 # TODO: Use the relevant ObjFileBase packages to inspect why
                 # this file is being nasty to us.
                 if !silent
-                    @warn("$(relpath(f, prefix.path)) cannot be dlopen()'ed")
+                    @warn("$(relpath(f, prefix.path)) cannot be dlopen()'ed", platform=triplet(platform))
                 end
                 all_ok = false
             end
@@ -181,7 +181,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
         end
 
         # Ensure that this library is available at its own SONAME
-        all_ok &= symlink_soname_lib(f; verbose=verbose, autofix=autofix)
+        all_ok &= symlink_soname_lib(f, platform; verbose=verbose, autofix=autofix)
     end
 
     # remove *.la files generated by GNU libtool
@@ -228,7 +228,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
         lib_dll_files =  filter(f -> valid_library_path(f, platform), collect_files(joinpath(prefix, "lib"), predicate))
         for f in lib_dll_files
             if !silent
-                @warn("$(relpath(f, prefix.path)) should be in `bin`!")
+                @warn("$(relpath(f, prefix.path)) should be in `bin`!", platform=triplet(platform))
             end
         end
 
@@ -239,7 +239,7 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
         outside_dll_files = [f for f in shlib_files if !(f in lib_dll_files)]
         if autofix && !isempty(lib_dll_files) && isempty(outside_dll_files)
             if !silent
-                @warn("Simple buildsystem detected; Moving all `.dll` files to `bin`!")
+                @warn("Simple buildsystem detected; Moving all `.dll` files to `bin`!", platform=triplet(platform))
             end
 
             mkpath(joinpath(prefix, "bin"))
@@ -269,10 +269,10 @@ function audit(prefix::Prefix, src_name::AbstractString = "";
     all_files = collect_files(prefix, predicate)
 
     # Search for absolute paths in this prefix
-    all_ok &= check_absolute_paths(prefix, all_files; silent=silent)
+    all_ok &= check_absolute_paths(prefix, platform, all_files; silent=silent)
 
     # Search for case-sensitive ambiguities
-    all_ok &= check_case_sensitivity(prefix)
+    all_ok &= check_case_sensitivity(prefix, platform)
     return all_ok
 end
 
@@ -320,7 +320,7 @@ function check_isa(oh, platform, prefix;
             Minimum instruction set detected for $(relpath(path(oh), prefix.path)) is
             $(detected_march), not $(last(platform_marchs)) as desired.
             """, '\n' => ' ')
-            @warn(strip(msg))
+            @warn(strip(msg), platform=triplet(platform))
         end
         return false
     elseif detected_march != last(platform_marchs)
@@ -334,7 +334,7 @@ function check_isa(oh, platform, prefix;
             $(detected_march), not $(last(platform_marchs)) as desired.
             You may be missing some optimization flags during compilation.
             """, '\n' => ' ')
-            @warn(strip(msg))
+            @warn(strip(msg), platform=triplet(platform))
         end
     end
     return true
@@ -392,22 +392,22 @@ function check_dynamic_linkage(oh, prefix, bin_files;
                         end
                     else
                         if !silent
-                            @warn("Linked library $(libname) could not be resolved and could not be auto-mapped")
+                            @warn("Linked library $(libname) could not be resolved and could not be auto-mapped", platform=triplet(platform))
                             if is_troublesome_library_link(libname, platform)
-                                @warn("Depending on $(libname) is known to cause problems at runtime, make sure to link against the JLL library instead")
+                                @warn("Depending on $(libname) is known to cause problems at runtime, make sure to link against the JLL library instead", platform=triplet(platform))
                             end
                         end
                         all_ok = false
                     end
                 else
                     if !silent
-                        @warn("Linked library $(libname) could not be resolved within the given prefix")
+                        @warn("Linked library $(libname) could not be resolved within the given prefix", platform=triplet(platform))
                     end
                     all_ok = false
                 end
             elseif !startswith(libs[libname], prefix.path)
                 if !silent
-                    @warn("Linked library $(libname) (resolved path $(libs[libname])) is not within the given prefix")
+                    @warn("Linked library $(libname) (resolved path $(libs[libname])) is not within the given prefix", platform=triplet(platform))
                 end
                 all_ok = false
             end

src/AutoBuild.jl

@@ -958,7 +958,7 @@ function autobuild(dir::AbstractString,
             products_info[p] = Dict("path" => relpath(product_path, dest_prefix.path))
             if p isa LibraryProduct || p isa FrameworkProduct
                 products_info[p]["soname"] = something(
-                    Auditor.get_soname(product_path),
+                    Auditor.get_soname(product_path, platform),
                     basename(product_path),
                 )
             end
@@ -969,7 +969,7 @@ function autobuild(dir::AbstractString,
         cleanup_dependencies(prefix, target_artifact_paths, concrete_platform)
 
         # Search for dead links in dest_prefix; raise warnings about them.
-        Auditor.warn_deadlinks(dest_prefix.path)
+        Auditor.warn_deadlinks(dest_prefix.path, platform)
 
         # Cull empty directories, for neatness' sake, unless auditing is disabled
         if !skip_audit
@@ -1216,7 +1216,7 @@ function rebuild_jll_package(name::String, build_version::VersionNumber, sources
                 products_info[p] = Dict("path" => relpath(product_path, dest_prefix))
                 if p isa LibraryProduct || p isa FrameworkProduct
                     products_info[p]["soname"] = something(
-                        Auditor.get_soname(product_path),
+                        Auditor.get_soname(product_path, platform),
                         basename(product_path),
                     )
                 end

src/auditor/compiler_abi.jl

@@ -37,7 +37,7 @@ function check_libgfortran_version(oh::ObjectHandle, platform::AbstractPlatform;
         if isa(e, InterruptException)
             rethrow(e)
         end
-        @warn "$(path(oh)) could not be scanned for libgfortran dependency!" exception=(e, catch_backtrace())
+        @warn "$(path(oh)) could not be scanned for libgfortran dependency!" platform=triplet(platform) exception=(e, catch_backtrace())
         return true
     end
 
@@ -57,7 +57,7 @@ function check_libgfortran_version(oh::ObjectHandle, platform::AbstractPlatform;
         definition in your `build_tarballs.jl` file, add the line:
         """, '\n' => ' '))
         msg *= "\n\n    platforms = expand_gfortran_versions(platforms)"
-        @warn(msg)
+        @warn(msg, platform=triplet(platform))
         return false
     end
 
@@ -67,7 +67,7 @@ function check_libgfortran_version(oh::ObjectHandle, platform::AbstractPlatform;
         for libgfortran$(libgfortran_version(platform).major). This usually indicates that
         the build system is somehow ignoring our choice of compiler!
         """, '\n' => ' '))
-        @warn(msg)
+        @warn(msg, platform=triplet(platform))
         return false
     end
     return true
@@ -87,7 +87,7 @@ function check_csl_libs(oh::ObjectHandle, platform::AbstractPlatform; verbose::B
         if isa(e, InterruptException)
             rethrow(e)
         end
-        @warn "$(path(oh)) could not be scanned for $(lib) dependency!" exception=(e, catch_backtrace())
+        @warn "$(path(oh)) could not be scanned for $(lib) dependency!" platform=triplet(platform) exception=(e, catch_backtrace())
         return true
     end
 
@@ -140,7 +140,7 @@ function check_libstdcxx_version(oh::ObjectHandle, platform::AbstractPlatform; v
         if isa(e, InterruptException)
             rethrow(e)
         end
-        @warn "$(path(oh)) could not be scanned for libstdcxx dependency!" exception=(e, catch_backtrace())
+        @warn "$(path(oh)) could not be scanned for libstdcxx dependency!" platform=triplet(platform) exception=(e, catch_backtrace())
         return true
     end
 
@@ -216,7 +216,7 @@ function detect_cxxstring_abi(oh::ObjectHandle, platform::AbstractPlatform)
         if isa(e, InterruptException)
             rethrow(e)
         end
-        @warn "$(path(oh)) could not be scanned for cxx11 ABI!" exception=(e, catch_backtrace())
+        @warn "$(path(oh)) could not be scanned for cxx11 ABI!" platform=triplet(platform) exception=(e, catch_backtrace())
     end
     return nothing
 end
@@ -244,7 +244,7 @@ function check_cxxstring_abi(oh::ObjectHandle, platform::AbstractPlatform; io::I
         definition in your `build_tarballs.jl` file, add the line:
         """, '\n' => ' '))
         msg *= "\n\n    platforms = expand_cxxstring_abis(platforms)"
-        @warn(msg)
+        @warn(msg, platform=triplet(platform))
         return false
     end
 
@@ -255,7 +255,7 @@ function check_cxxstring_abi(oh::ObjectHandle, platform::AbstractPlatform; io::I
         indicates that the build system is somehow ignoring our choice of compiler, as we manually
         insert the correct compiler flags for this ABI choice!
         """, '\n' => ' '))
-        @warn(msg)
+        @warn(msg, platform=triplet(platform))
         return false
     end
     return true

src/auditor/extra_checks.jl

@@ -13,7 +13,7 @@ function check_os_abi(oh::ObjectHandle, p::AbstractPlatform, rest...; verbose::B
                 $(basename(path(oh))) has an ELF header OS/ABI value that is not set to FreeBSD
                 ($(ELF.ELFOSABI_FREEBSD)), this may be an issue at link time
                 """, '\n' => ' ')
-                @warn(strip(msg))
+                @warn(strip(msg), platform=triplet(p))
             end
             return false
         end
@@ -24,7 +24,7 @@ function check_os_abi(oh::ObjectHandle, p::AbstractPlatform, rest...; verbose::B
         # means "no specific float ABI", `0x400` == EF_ARM_ABI_FLOAT_HARD.
         if header(oh).e_flags & 0xF00 ∉ (0x000, 0x400)
             if verbose
-                @error("$(basename(path(oh))) does not match the hard-float ABI")
+                @error("$(basename(path(oh))) does not match the hard-float ABI", platform=triplet(p))
             end
             return false
         end

src/auditor/filesystems.jl

@@ -1,12 +1,12 @@
-function check_case_sensitivity(prefix::Prefix)
+function check_case_sensitivity(prefix::Prefix, platform::AbstractPlatform)
     all_ok = true
 
     function check_set(root, list)
         lowered = Set()
         for f in list
             lf = lowercase(f)
             if lf in lowered
-                @warn("$(relpath(joinpath(root, f), prefix.path)) causes a case-sensitivity ambiguity!")
+                @warn("$(relpath(joinpath(root, f), prefix.path)) causes a case-sensitivity ambiguity!", platform=triplet(platform))
                 all_ok = false
             end
             push!(lowered, lf)
@@ -22,7 +22,7 @@ function check_case_sensitivity(prefix::Prefix)
 end
 
 
-function check_absolute_paths(prefix::Prefix, all_files::Vector; silent::Bool = false)
+function check_absolute_paths(prefix::Prefix, platform::AbstractPlatform, all_files::Vector; silent::Bool = false)
     # Finally, check for absolute paths in any files.  This is not a "fatal"
     # offense, as many files have absolute paths.  We want to know about it
     # though, so we'll still warn the user.
@@ -31,20 +31,20 @@ function check_absolute_paths(prefix::Prefix, all_files::Vector; silent::Bool =
             file_contents = String(read(f))
             if occursin(prefix.path, file_contents)
                 if !silent
-                    @warn("$(relpath(f, prefix.path)) contains an absolute path")
+                    @warn("$(relpath(f, prefix.path)) contains an absolute path", platform=triplet(platform))
                 end
             end
         catch
             if !silent
-                @warn("Skipping abspath scanning of $(f), as we can't open it")
+                @warn("Skipping abspath scanning of $(f), as we can't open it", platform=triplet(platform))
             end
         end
     end
 
     return true
 end
 
-function ensure_executability(oh::ObjectHandle; verbose::Bool=false, silent::Bool=false)
+function ensure_executability(oh::ObjectHandle, platform::AbstractPlatform; verbose::Bool=false, silent::Bool=false)
     old_mode = filemode(path(oh))
     # Execution permissions only for users who can read the file
     read_mask = (old_mode & 0o444) >> 2
@@ -61,7 +61,7 @@ function ensure_executability(oh::ObjectHandle; verbose::Bool=false, silent::Boo
                 rethrow(e)
             end
             if !silent
-                @warn "$(path(oh)) could not be made executable!" exception=(e, catch_backtrace())
+                @warn "$(path(oh)) could not be made executable!" platform=triplet(platform) exception=(e, catch_backtrace())
             end
         end
     end

src/auditor/instruction_set.jl

@@ -160,7 +160,7 @@ function analyze_instruction_set(oh::ObjectHandle, platform::AbstractPlatform; v
             the proper instruction set internally.  Would have chosen
             $(min_march), instead choosing $(generic_march(platform)).
             """, '\n' => ' ')
-            @warn(strip(msg))
+            @warn(strip(msg), platform=triplet(platform))
         end
         return generic_march(platform)
     end

src/auditor/soname_matching.jl

@@ -2,11 +2,11 @@
 get_soname(oh::ObjectHandle) = nothing
 
 # Auto-open a path into an ObjectHandle
-function get_soname(path::AbstractString)
+function get_soname(path::AbstractString, platform::AbstractPlatform)
     try
         readmeta(get_soname, path)
     catch e
-        @warn "Could not probe $(path) for an SONAME!" exception=(e, catch_backtrace())
+        @warn "Could not probe $(path) for an SONAME!" platform=triplet(platform) exception=(e, catch_backtrace())
         return nothing
     end
 end
@@ -47,7 +47,7 @@ function ensure_soname(prefix::Prefix, path::AbstractString, platform::AbstractP
 
     # Skip if this file already contains an SONAME
     rel_path = relpath(realpath(path), realpath(prefix.path))
-    soname = get_soname(path)
+    soname = get_soname(path, platform)
     if soname != nothing
         if verbose
             @info("$(rel_path) already has SONAME \"$(soname)\"")
@@ -80,14 +80,14 @@ function ensure_soname(prefix::Prefix, path::AbstractString, platform::AbstractP
     end
 
     if !retval
-        @warn("Unable to set SONAME on $(rel_path)")
+        @warn("Unable to set SONAME on $(rel_path)", platform=triplet(platform))
         return false
     end
 
     # Read the SONAME back in and ensure it's set properly
-    new_soname = get_soname(path)
+    new_soname = get_soname(path, platform)
     if new_soname != soname
-        @warn("Set SONAME on $(rel_path) to $(soname), but read back $(string(new_soname))!")
+        @warn("Set SONAME on $(rel_path) to $(soname), but read back $(string(new_soname))!", platform=triplet(platform))
         return false
     end
 
@@ -99,16 +99,16 @@ function ensure_soname(prefix::Prefix, path::AbstractString, platform::AbstractP
 end
 
 """
-    symlink_soname_lib(path::AbstractString)
+    symlink_soname_lib(path::AbstractString, platform::AbstractPlatform)
 
 We require that all shared libraries are accessible on disk through their
 SONAME (if it exists).  While this is almost always true in practice, it
 doesn't hurt to make doubly sure.
 """
-function symlink_soname_lib(path::AbstractString; verbose::Bool = false,
-                                                  autofix::Bool = false)
+function symlink_soname_lib(path::AbstractString, platform::AbstractPlatform;
+                            verbose::Bool = false, autofix::Bool = false)
     # If this library doesn't have an SONAME, then just quit out immediately
-    soname = get_soname(path)
+    soname = get_soname(path, platform)
     if soname === nothing
         return true
     end

src/auditor/symlink_translator.jl

@@ -20,14 +20,14 @@ function translate_symlinks(root::AbstractString; verbose::Bool=false)
 end
 
 """
-    warn_deadlinks(root::AbstractString)
+    warn_deadlinks(root::AbstractString, platform::AbstractPlatform)
 
 Walks through the given `root` directory, finding broken symlinks and warning
 the user about them.  This is used to catch instances such as a build recipe
 copying a symlink that points to a dependency; by doing so, it implicitly
 breaks relocatability.
 """
-function warn_deadlinks(root::AbstractString)
+function warn_deadlinks(root::AbstractString, platform::AbstractPlatform)
     for f in collect_files(root, islink; exclude_externalities=false)
         link_target = readlink(f)
         if !startswith(link_target, "/")
@@ -39,7 +39,7 @@ function warn_deadlinks(root::AbstractString)
             link_target = joinpath(dirname(f), link_target)
         end
         if !ispath(link_target)
-            @warn("Broken symlink: $(relpath(f, root))")
+            @warn("Broken symlink: $(relpath(f, root))", platform=triplet(platform))
         end
     end
 end

test/auditing.jl

@@ -459,7 +459,7 @@ end
 
         # Test that `audit()` warns about broken symlinks
         @test_logs (:warn, r"Broken symlink: bin/libzmq.dll.a") match_mode=:any begin
-            Auditor.warn_deadlinks(build_path)
+            Auditor.warn_deadlinks(build_path, HostPlatform())
         end
     end
 end