Skip to content

Commit 2030e7d

Browse files
vchuravyKristofferC
authored andcommitted
Turn Method Overwritten Error into a PrecompileError -- turning off caching (#52214)
Fixes #52213 Overwritting methods during cache creation is currently not something that the system can support and can lead to surprising, counter-intuitive and fatal errors. In 1.10 we turned it from a warning to a strong error, with this PR it remains a strong error, but the precompilation system recognizes it and essentially sets `__precompile__(false)` for this module and all modules that depend on it. Before: ``` julia> using OverwriteMethodError [ Info: Precompiling OverwriteMethodError [top-level] WARNING: Method definition +(Bool, Bool) in module Base at bool.jl:166 overwritten in module OverwriteMethodError at /home/vchuravy/src/julia2/OverwriteMethodError.jl:2. ERROR: LoadError: Method overwriting is not permitted during Module precompile. Stacktrace: [1] top-level scope @ ~/src/julia2/OverwriteMethodError.jl:2 [2] include @ Base ./Base.jl:489 [inlined] [3] include_package_for_output(pkg::Base.PkgId, input::String, depot_path::Vector{String}, dl_load_path::Vector{String}, load_path::Vector{String}, concrete_deps::Vector{Pair{Base.PkgId, UInt128}}, source::Nothing) @ Base ./loading.jl:2216 [4] top-level scope @ stdin:3 in expression starting at /home/vchuravy/src/julia2/OverwriteMethodError.jl:1 in expression starting at stdin:3 ERROR: Failed to precompile OverwriteMethodError [top-level] to "/home/vchuravy/.julia/compiled/v1.10/jl_guiuCQ". Stacktrace: [1] error(s::String) @ Base ./error.jl:35 [2] compilecache(pkg::Base.PkgId, path::String, internal_stderr::IO, internal_stdout::IO, keep_loaded_modules::Bool) @ Base ./loading.jl:2462 [3] compilecache @ Base ./loading.jl:2334 [inlined] [4] (::Base.var"#968#969"{Base.PkgId})() @ Base ./loading.jl:1968 [5] mkpidlock(f::Base.var"#968#969"{Base.PkgId}, at::String, pid::Int32; kwopts::@kwargs{stale_age::Int64, wait::Bool}) @ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:93 [6] #mkpidlock#6 @ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:88 [inlined] [7] trymkpidlock(::Function, ::Vararg{Any}; kwargs::@kwargs{stale_age::Int64}) @ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:111 [8] #invokelatest#2 @ Base ./essentials.jl:889 [inlined] [9] invokelatest @ Base ./essentials.jl:884 [inlined] [10] maybe_cachefile_lock(f::Base.var"#968#969"{Base.PkgId}, pkg::Base.PkgId, srcpath::String; stale_age::Int64) @ Base ./loading.jl:2977 [11] maybe_cachefile_lock @ Base ./loading.jl:2974 [inlined] [12] _require(pkg::Base.PkgId, env::String) @ Base ./loading.jl:1964 [13] __require_prelocked(uuidkey::Base.PkgId, env::String) @ Base ./loading.jl:1806 [14] #invoke_in_world#3 @ Base ./essentials.jl:921 [inlined] [15] invoke_in_world @ Base ./essentials.jl:918 [inlined] [16] _require_prelocked(uuidkey::Base.PkgId, env::String) @ Base ./loading.jl:1797 [17] macro expansion @ Base ./loading.jl:1784 [inlined] [18] macro expansion @ Base ./lock.jl:267 [inlined] [19] __require(into::Module, mod::Symbol) @ Base ./loading.jl:1747 [20] #invoke_in_world#3 @ Base ./essentials.jl:921 [inlined] [21] invoke_in_world @ Base ./essentials.jl:918 [inlined] [22] require(into::Module, mod::Symbol) @ Base ./loading.jl:1740 ``` After: ``` julia> using OverwriteMethodError ┌ Info: Precompiling OverwriteMethodError [top-level] └ @ Base loading.jl:2486 WARNING: Method definition +(Bool, Bool) in module Base at bool.jl:166 overwritten in module OverwriteMethodError at /home/vchuravy/src/julia2/OverwriteMethodError.jl:2. ERROR: Method overwriting is not permitted during Module precompile. ┌ Info: Skipping precompilation since __precompile__(false). Importing OverwriteMethodError [top-level]. └ @ Base loading.jl:2084 ``` --------- Co-authored-by: Kristoffer Carlsson <[email protected]> (cherry picked from commit 9e8fe68)
1 parent 9c097b6 commit 2030e7d

8 files changed

+23
-4
lines changed

base/boot.jl

+2
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,8 @@ struct InitError <: WrappedException
370370
error
371371
end
372372

373+
struct PrecompilableError <: Exception end
374+
373375
String(s::String) = s # no constructor yet
374376

375377
const Cvoid = Nothing

base/loading.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -1686,7 +1686,7 @@ function include_dependency(path::AbstractString)
16861686
end
16871687

16881688
# we throw PrecompilableError when a module doesn't want to be precompiled
1689-
struct PrecompilableError <: Exception end
1689+
import Core: PrecompilableError
16901690
function show(io::IO, ex::PrecompilableError)
16911691
print(io, "Declaring __precompile__(false) is not allowed in files that are being precompiled.")
16921692
end

src/gf.c

+4-2
Original file line numberDiff line numberDiff line change
@@ -1568,8 +1568,10 @@ static void method_overwrite(jl_typemap_entry_t *newentry, jl_method_t *oldvalue
15681568
jl_printf(s, ".\n");
15691569
jl_uv_flush(s);
15701570
}
1571-
if (jl_generating_output())
1572-
jl_error("Method overwriting is not permitted during Module precompile.");
1571+
if (jl_generating_output()) {
1572+
jl_printf(JL_STDERR, "ERROR: Method overwriting is not permitted during Module precompilation. Use `__precompile__(false)` to opt-out of precompilation.\n");
1573+
jl_throw(jl_precompilable_error);
1574+
}
15731575
}
15741576

15751577
static void update_max_args(jl_methtable_t *mt, jl_value_t *type)

src/jl_exported_data.inc

+1
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@
126126
XX(jl_voidpointer_type) \
127127
XX(jl_void_type) \
128128
XX(jl_weakref_type) \
129+
XX(jl_precompilable_error) \
129130

130131
// Data symbols that are defined inside the public libjulia
131132
#define JL_EXPORTED_DATA_SYMBOLS(XX) \

src/jltypes.c

+1
Original file line numberDiff line numberDiff line change
@@ -3410,6 +3410,7 @@ void post_boot_hooks(void)
34103410
jl_methoderror_type = (jl_datatype_t*)core("MethodError");
34113411
jl_loaderror_type = (jl_datatype_t*)core("LoadError");
34123412
jl_initerror_type = (jl_datatype_t*)core("InitError");
3413+
jl_precompilable_error = jl_new_struct_uninit((jl_datatype_t*)core("PrecompilableError"));
34133414
jl_pair_type = core("Pair");
34143415
jl_kwcall_func = core("kwcall");
34153416
jl_kwcall_mt = ((jl_datatype_t*)jl_typeof(jl_kwcall_func))->name->mt;

src/julia.h

+1
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,7 @@ extern JL_DLLIMPORT jl_value_t *jl_readonlymemory_exception JL_GLOBALLY_ROOTED;
829829
extern JL_DLLIMPORT jl_value_t *jl_diverror_exception JL_GLOBALLY_ROOTED;
830830
extern JL_DLLIMPORT jl_value_t *jl_undefref_exception JL_GLOBALLY_ROOTED;
831831
extern JL_DLLIMPORT jl_value_t *jl_interrupt_exception JL_GLOBALLY_ROOTED;
832+
extern JL_DLLIMPORT jl_value_t *jl_precompilable_error JL_GLOBALLY_ROOTED;
832833
extern JL_DLLIMPORT jl_datatype_t *jl_boundserror_type JL_GLOBALLY_ROOTED;
833834
extern JL_DLLIMPORT jl_value_t *jl_an_empty_vec_any JL_GLOBALLY_ROOTED;
834835
extern JL_DLLIMPORT jl_value_t *jl_an_empty_string JL_GLOBALLY_ROOTED;

src/staticdata.c

+2-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ extern "C" {
9999
// TODO: put WeakRefs on the weak_refs list during deserialization
100100
// TODO: handle finalizers
101101

102-
#define NUM_TAGS 158
102+
#define NUM_TAGS 159
103103

104104
// An array of references that need to be restored from the sysimg
105105
// This is a manually constructed dual of the gvars array, which would be produced by codegen for Julia code, for C.
@@ -224,6 +224,7 @@ jl_value_t **const*const get_tags(void) {
224224
INSERT_TAG(jl_undefref_exception);
225225
INSERT_TAG(jl_readonlymemory_exception);
226226
INSERT_TAG(jl_atomicerror_type);
227+
INSERT_TAG(jl_precompilable_error);
227228

228229
// other special values
229230
INSERT_TAG(jl_emptysvec);

test/precompile.jl

+11
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,17 @@ precompile_test_harness(false) do dir
504504
""")
505505

506506
@test Base.compilecache(Base.PkgId("Baz")) == Base.PrecompilableError() # due to __precompile__(false)
507+
508+
OverwriteMethodError_file = joinpath(dir, "OverwriteMethodError.jl")
509+
write(OverwriteMethodError_file,
510+
"""
511+
module OverwriteMethodError
512+
Base.:(+)(x::Bool, y::Bool) = false
513+
end
514+
""")
515+
516+
@test Base.compilecache(Base.PkgId("OverwriteMethodError")) == Base.PrecompilableError() # due to piracy
517+
507518
@eval using Baz
508519
@test Base.invokelatest(Baz.baz) == 1
509520

0 commit comments

Comments
 (0)