Skip to content

Commit a7c5056

Browse files
fattenederfatteneder
authored
relocation: account for trailing path separator in depot paths (#55355)
Fixes #55340
1 parent bb25910 commit a7c5056

4 files changed

Lines changed: 72 additions & 25 deletions

File tree

‎base/loading.jl‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3165,23 +3165,29 @@ mutable struct CacheHeaderIncludes
31653165
const modpath::Vector{String} # seemingly not needed in Base, but used by Revise
31663166
end
31673167

3168-
function replace_depot_path(path::AbstractString)
3169-
for depot in DEPOT_PATH
3170-
!isdir(depot) && continue
3171-
3172-
# Strip extraneous pathseps through normalization.
3173-
if isdirpath(depot)
3174-
depot = dirname(depot)
3175-
end
3176-
3177-
if startswith(path, depot)
3168+
function replace_depot_path(path::AbstractString, depots::Vector{String}=normalize_depots_for_relocation())
3169+
for depot in depots
3170+
if startswith(path, string(depot, Filesystem.pathsep())) || path == depot
31783171
path = replace(path, depot => "@depot"; count=1)
31793172
break
31803173
end
31813174
end
31823175
return path
31833176
end
31843177

3178+
function normalize_depots_for_relocation()
3179+
depots = String[]
3180+
sizehint!(depots, length(DEPOT_PATH))
3181+
for d in DEPOT_PATH
3182+
isdir(d) || continue
3183+
if isdirpath(d)
3184+
d = dirname(d)
3185+
end
3186+
push!(depots, abspath(d))
3187+
end
3188+
return depots
3189+
end
3190+
31853191
function restore_depot_path(path::AbstractString, depot::AbstractString)
31863192
replace(path, r"^@depot" => depot; count=1)
31873193
end

‎src/precompile.c‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,17 @@ void write_srctext(ios_t *f, jl_array_t *udeps, int64_t srctextpos) {
3939
static jl_value_t *replace_depot_func = NULL;
4040
if (!replace_depot_func)
4141
replace_depot_func = jl_get_global(jl_base_module, jl_symbol("replace_depot_path"));
42+
static jl_value_t *normalize_depots_func = NULL;
43+
if (!normalize_depots_func)
44+
normalize_depots_func = jl_get_global(jl_base_module, jl_symbol("normalize_depots_for_relocation"));
4245
ios_t srctext;
43-
jl_value_t *deptuple = NULL;
44-
JL_GC_PUSH2(&deptuple, &udeps);
46+
jl_value_t *deptuple = NULL, *depots = NULL;
47+
JL_GC_PUSH3(&deptuple, &udeps, &depots);
48+
jl_task_t *ct = jl_current_task;
49+
size_t last_age = ct->world_age;
50+
ct->world_age = jl_atomic_load_acquire(&jl_world_counter);
51+
depots = jl_apply(&normalize_depots_func, 1);
52+
ct->world_age = last_age;
4553
for (size_t i = 0; i < len; i++) {
4654
deptuple = jl_array_ptr_ref(udeps, i);
4755
jl_value_t *depmod = jl_fieldref(deptuple, 0); // module
@@ -60,13 +68,14 @@ void write_srctext(ios_t *f, jl_array_t *udeps, int64_t srctextpos) {
6068
}
6169

6270
jl_value_t **replace_depot_args;
63-
JL_GC_PUSHARGS(replace_depot_args, 2);
71+
JL_GC_PUSHARGS(replace_depot_args, 3);
6472
replace_depot_args[0] = replace_depot_func;
6573
replace_depot_args[1] = abspath;
74+
replace_depot_args[2] = depots;
6675
jl_task_t *ct = jl_current_task;
6776
size_t last_age = ct->world_age;
6877
ct->world_age = jl_atomic_load_acquire(&jl_world_counter);
69-
jl_value_t *depalias = (jl_value_t*)jl_apply(replace_depot_args, 2);
78+
jl_value_t *depalias = (jl_value_t*)jl_apply(replace_depot_args, 3);
7079
ct->world_age = last_age;
7180
JL_GC_POP();
7281

‎src/staticdata_utils.c‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -753,6 +753,16 @@ static int64_t write_dependency_list(ios_t *s, jl_array_t* worklist, jl_array_t
753753
static jl_value_t *replace_depot_func = NULL;
754754
if (!replace_depot_func)
755755
replace_depot_func = jl_get_global(jl_base_module, jl_symbol("replace_depot_path"));
756+
static jl_value_t *normalize_depots_func = NULL;
757+
if (!normalize_depots_func)
758+
normalize_depots_func = jl_get_global(jl_base_module, jl_symbol("normalize_depots_for_relocation"));
759+
760+
jl_value_t *depots = NULL, *prefs_hash = NULL, *prefs_list = NULL;
761+
JL_GC_PUSH2(&depots, &prefs_list);
762+
last_age = ct->world_age;
763+
ct->world_age = jl_atomic_load_acquire(&jl_world_counter);
764+
depots = jl_apply(&normalize_depots_func, 1);
765+
ct->world_age = last_age;
756766

757767
// write a placeholder for total size so that we can quickly seek past all of the
758768
// dependencies if we don't need them
@@ -765,13 +775,14 @@ static int64_t write_dependency_list(ios_t *s, jl_array_t* worklist, jl_array_t
765775

766776
if (replace_depot_func) {
767777
jl_value_t **replace_depot_args;
768-
JL_GC_PUSHARGS(replace_depot_args, 2);
778+
JL_GC_PUSHARGS(replace_depot_args, 3);
769779
replace_depot_args[0] = replace_depot_func;
770780
replace_depot_args[1] = deppath;
781+
replace_depot_args[2] = depots;
771782
ct = jl_current_task;
772783
size_t last_age = ct->world_age;
773784
ct->world_age = jl_atomic_load_acquire(&jl_world_counter);
774-
deppath = (jl_value_t*)jl_apply(replace_depot_args, 2);
785+
deppath = (jl_value_t*)jl_apply(replace_depot_args, 3);
775786
ct->world_age = last_age;
776787
JL_GC_POP();
777788
}
@@ -804,9 +815,6 @@ static int64_t write_dependency_list(ios_t *s, jl_array_t* worklist, jl_array_t
804815
write_int32(s, 0); // terminator, for ease of reading
805816

806817
// Calculate Preferences hash for current package.
807-
jl_value_t *prefs_hash = NULL;
808-
jl_value_t *prefs_list = NULL;
809-
JL_GC_PUSH1(&prefs_list);
810818
if (jl_base_module) {
811819
// Toplevel module is the module we're currently compiling, use it to get our preferences hash
812820
jl_value_t * toplevel = (jl_value_t*)jl_get_global(jl_base_module, jl_symbol("__toplevel__"));
@@ -853,7 +861,7 @@ static int64_t write_dependency_list(ios_t *s, jl_array_t* worklist, jl_array_t
853861
write_int32(s, 0);
854862
write_uint64(s, 0);
855863
}
856-
JL_GC_POP(); // for prefs_list
864+
JL_GC_POP(); // for depots, prefs_list
857865

858866
// write a dummy file position to indicate the beginning of the source-text
859867
pos = ios_pos(s);

‎test/relocatedepot.jl‎

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is a part of Julia. License is MIT: https://julialang.org/license
2+
13
using Test
24

35

@@ -26,26 +28,48 @@ end
2628

2729
if !test_relocated_depot
2830

29-
@testset "insert @depot tag in path" begin
31+
@testset "edge cases when inserting @depot tag in path" begin
3032

33+
# insert @depot only once for first match
3134
test_harness() do
3235
mktempdir() do dir
3336
pushfirst!(DEPOT_PATH, dir)
34-
path = dir*dir
35-
@test Base.replace_depot_path(path) == "@depot"*dir
37+
if Sys.iswindows()
38+
# dirs start with a drive letter instead of a path separator
39+
path = dir*Base.Filesystem.pathsep()*dir
40+
@test Base.replace_depot_path(path) == "@depot"*Base.Filesystem.pathsep()*dir
41+
else
42+
path = dir*dir
43+
@test Base.replace_depot_path(path) == "@depot"*dir
44+
end
45+
end
46+
47+
# 55340
48+
empty!(DEPOT_PATH)
49+
mktempdir() do dir
50+
jlrc = joinpath(dir, "julia-rc2")
51+
jl = joinpath(dir, "julia")
52+
mkdir(jl)
53+
push!(DEPOT_PATH, jl)
54+
@test Base.replace_depot_path(jl) == "@depot"
55+
@test Base.replace_depot_path(string(jl,Base.Filesystem.pathsep())) ==
56+
string("@depot",Base.Filesystem.pathsep())
57+
@test Base.replace_depot_path(jlrc) != "@depot-rc2"
58+
@test Base.replace_depot_path(jlrc) == jlrc
3659
end
3760
end
3861

62+
# deal with and without trailing path separators
3963
test_harness() do
4064
mktempdir() do dir
4165
pushfirst!(DEPOT_PATH, dir)
4266
path = joinpath(dir, "foo")
4367
if isdirpath(DEPOT_PATH[1])
4468
DEPOT_PATH[1] = dirname(DEPOT_PATH[1]) # strip trailing pathsep
4569
end
46-
tag = joinpath("@depot", "") # append a pathsep
70+
tag = string("@depot", Base.Filesystem.pathsep())
4771
@test startswith(Base.replace_depot_path(path), tag)
48-
DEPOT_PATH[1] = joinpath(DEPOT_PATH[1], "") # append a pathsep
72+
DEPOT_PATH[1] = string(DEPOT_PATH[1], Base.Filesystem.pathsep())
4973
@test startswith(Base.replace_depot_path(path), tag)
5074
popfirst!(DEPOT_PATH)
5175
@test !startswith(Base.replace_depot_path(path), tag)

0 commit comments

Comments
 (0)