Avoid hardcoding paths in Profile and Sys (JuliaLang#59998)

Current code fails when using custom paths. Save directory where Julia
source is stored during build in `SOURCEDIR` instead of assuming it can
be computed from `BINDIR` (new name chosen to avoid confusing with
`build_dir` which is different). Use `DATAROOTDIR` and `DATAROOT`
instead of hardcoding `usr/share/` and `share/`.

Fix/continuation of JuliaLang#56601, JuliaLang#56627.

Author: nalimilan

base/Makefile

@@ -71,6 +71,7 @@ endif
 	@printf "%s\n" "const PRIVATE_LIBDIR = "$(call shell_escape,$(call julia_escape,$(call normalize_path,$(private_libdir_rel)))) >> $@
 	@printf "%s\n" "const PRIVATE_LIBEXECDIR = "$(call shell_escape,$(call julia_escape,$(call normalize_path,$(private_libexecdir_rel)))) >> $@
 	@printf "%s\n" "const INCLUDEDIR = "$(call shell_escape,$(call julia_escape,$(call normalize_path,$(includedir_rel)))) >> $@
+	@printf "%s\n" "const SOURCEDIR = "$(call shell_escape,$(call julia_escape,$(call normalize_path,$(shell echo $(call cygpath_w,$(JULIAHOME)))))) >> $@
 ifeq ($(DARWIN_FRAMEWORK), 1)
 	@printf "%s\n" "const DARWIN_FRAMEWORK = true" >> $@
 	@printf "%s\n" "const DARWIN_FRAMEWORK_NAME = \"$(FRAMEWORK_NAME)\"" >> $@

base/initdefs.jl

@@ -97,7 +97,7 @@ const DEPOT_PATH = String[]
 function append_bundled_depot_path!(DEPOT_PATH)
     path = abspath(Sys.BINDIR, "..", "local", "share", "julia")
     path in DEPOT_PATH || push!(DEPOT_PATH, path)
-    path = abspath(Sys.BINDIR, "..", "share", "julia")
+    path = abspath(Sys.BINDIR, Base.DATAROOTDIR, "julia")
     path in DEPOT_PATH || push!(DEPOT_PATH, path)
     return DEPOT_PATH
 end

base/methodshow.jl

@@ -140,7 +140,7 @@ function fixup_stdlib_path(path::String)
         if isdefined(@__MODULE__, :Core) && isdefined(Core, :Compiler)
             compiler_folder = dirname(String(Base.moduleloc(Core.Compiler).file))
             if dirname(path) == compiler_folder
-                return abspath(Sys.STDLIB, "..", "..", "Compiler", "src", basename(path))
+                return abspath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "Compiler", "src", basename(path))
             end
         end
     end

base/sysinfo.jl

@@ -40,7 +40,7 @@ export BINDIR,
        which,
        detectwsl
 
-import ..Base: show
+import ..Base: DATAROOTDIR, show
 
 """
     Sys.BINDIR::String
@@ -54,12 +54,10 @@ global BINDIR::String = ccall(:jl_get_julia_bindir, Any, ())::String
 
 A string containing the full path to the directory containing the `stdlib` packages.
 """
-global STDLIB::String = "$BINDIR/../share/julia/stdlib/v$(VERSION.major).$(VERSION.minor)" # for bootstrap
+global STDLIB::String = "$BINDIR/$DATAROOTDIR/julia/stdlib/v$(VERSION.major).$(VERSION.minor)" # for bootstrap
 # In case STDLIB change after julia is built, the variable below can be used
 # to update cached method locations to updated ones.
 const BUILD_STDLIB_PATH = STDLIB
-# Similarly, this is the root of the julia repo directory that julia was built from
-const BUILD_ROOT_PATH = "$BINDIR/../.."
 
 # helper to avoid triggering precompile warnings
 
@@ -178,7 +176,7 @@ end
 function __init_build()
     global BINDIR = ccall(:jl_get_julia_bindir, Any, ())::String
     vers = "v$(string(VERSION.major)).$(string(VERSION.minor))"
-    global STDLIB = abspath(BINDIR, "..", "share", "julia", "stdlib", vers)
+    global STDLIB = abspath(BINDIR, DATAROOTDIR, "julia", "stdlib", vers)
     nothing
 end
 

doc/make.jl

@@ -4,7 +4,7 @@ empty!(LOAD_PATH)
 push!(LOAD_PATH, @__DIR__, "@stdlib")
 empty!(DEPOT_PATH)
 push!(DEPOT_PATH, joinpath(@__DIR__, "deps"))
-push!(DEPOT_PATH, abspath(Sys.BINDIR, "..", "share", "julia"))
+push!(DEPOT_PATH, abspath(Sys.BINDIR, Base.DATAROOTDIR, "julia"))
 using Pkg
 Pkg.instantiate()
 

doc/src/devdocs/EscapeAnalysis.md

@@ -22,7 +22,7 @@ defines the convenience entries `code_escapes` and `@code_escapes` for testing a
 ```@repl EAUtils
 # InteractiveUtils.@activate Compiler # to use the stdlib version of the Compiler
 
-let JULIA_DIR = normpath(Sys.BINDIR, "..", "share", "julia")
+let JULIA_DIR = normpath(Sys.BINDIR, Base.DATAROOTDIR, "julia")
     include(normpath(JULIA_DIR, "Compiler", "test", "EAUtils.jl"))
     using .EAUtils
 end

stdlib/CRC32c/test/runtests.jl

@@ -3,7 +3,7 @@
 using Test, Random
 using CRC32c
 
-const BASE_TEST_PATH = joinpath(Sys.BINDIR, "..", "share", "julia", "test")
+const BASE_TEST_PATH = joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "test")
 isdefined(Main, :OffsetArrays) || @eval Main include(joinpath($(BASE_TEST_PATH), "testhelpers", "OffsetArrays.jl"))
 using .Main.OffsetArrays: Origin
 

stdlib/Dates/test/io.jl

@@ -5,7 +5,7 @@ module IOTests
 using Test
 using Dates
 
-const BASE_TEST_PATH = joinpath(Sys.BINDIR, "..", "share", "julia", "test")
+const BASE_TEST_PATH = joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "test")
 include(joinpath(BASE_TEST_PATH, "testhelpers", "withlocales.jl"))
 
 @testset "string/show representation of Date" begin

stdlib/LibGit2/test/libgit2-tests.jl

@@ -7,7 +7,7 @@ using LibGit2_jll
 using Test
 using Random, Serialization, Sockets
 
-const BASE_TEST_PATH = joinpath(Sys.BINDIR, "..", "share", "julia", "test")
+const BASE_TEST_PATH = joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "test")
 isdefined(Main, :ChallengePrompts) || @eval Main include(joinpath($(BASE_TEST_PATH), "testhelpers", "ChallengePrompts.jl"))
 using .Main.ChallengePrompts: challenge_prompt as basic_challenge_prompt
 

stdlib/Profile/src/Profile.jl

@@ -538,8 +538,7 @@ function flatten(data::Vector, lidict::LineInfoDict)
     return (newdata, newdict)
 end
 
-const SRC_DIR = normpath(joinpath(Sys.BUILD_ROOT_PATH, "src"))
-const COMPILER_DIR = "../usr/share/julia/Compiler/"
+const SRC_DIR = normpath(Base.SOURCEDIR, "src")
 
 # Take a file-system path and try to form a concise representation of it
 # based on the package ecosystem
@@ -548,17 +547,18 @@ function short_path(spath::Symbol, filenamecache::Dict{Symbol, Tuple{String,Stri
     return get!(filenamecache, spath) do
         path = Base.fixup_stdlib_path(string(spath))
         path_norm = normpath(path)
-        possible_base_path = normpath(joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "base", path))
+        possible_base_path = normpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "base", path)
         lib_dir = abspath(Sys.BINDIR, Base.LIBDIR)
+        compiler_dir = normpath(Base.DATAROOT, "julia", "Compiler/")
         if startswith(path_norm, SRC_DIR)
             remainder = only(split(path_norm, SRC_DIR, keepempty=false))
             return (isfile(path_norm) ? path_norm : ""), "@juliasrc", remainder
         elseif startswith(path_norm, lib_dir)
             remainder = only(split(path_norm, lib_dir, keepempty=false))
             return (isfile(path_norm) ? path_norm : ""), "@julialib", remainder
-        elseif contains(path, COMPILER_DIR)
-            remainder = split(path, COMPILER_DIR, keepempty=false)[end]
-            possible_compiler_path = normpath(joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "Compiler", remainder))
+        elseif startswith(path_norm, compiler_dir)
+            remainder = split(path_norm, compiler_dir, keepempty=false)[end]
+            possible_compiler_path = normpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "Compiler", remainder)
             return (isfile(possible_compiler_path) ? possible_compiler_path : ""), "@Compiler", remainder
         elseif isabspath(path)
             if ispath(path)
@@ -586,11 +586,10 @@ function short_path(spath::Symbol, filenamecache::Dict{Symbol, Tuple{String,Stri
         elseif isfile(possible_base_path)
             # do the same mechanic for Base (or Core/Compiler) files as above,
             # but they start from a relative path
-            return possible_base_path, "@Base", normpath(path)
+            return possible_base_path, "@Base", path_norm
         else
             # for non-existent relative paths (such as "REPL[1]"), just consider simplifying them
-            path = normpath(path)
-            return "", "", path # drop leading "./"
+            return "", "", path_norm # drop leading "./"
         end
     end
 end