Clean-ups.

Author: maleadt

src/interface.jl

@@ -429,12 +429,6 @@ the check-and-compile sequence (all back-ends already do, e.g. `mtlfunction_lock
 """
 function cached_results end
 
-# Relocation types and the backend lowering hook live in relocation.jl.
-#
-# Job results attached to CodeInstances are serialized into package images. Store only
-# session-portable data there. Generated code is portable iff `supports_relocatable_ir()`
-# and the backend preserves relocations with patchable- or imported-symbol lowering. Backends
-# using baked lowering must keep generated code in a session-local cache or recompile it.
 @static if HAS_INTEGRATED_CACHE
 
 """

src/mcgen.jl

@@ -1,31 +1,27 @@
 # machine code generation
 
-# GlobalOpt/DCE cleanup, run before slot collection and again after lowering.
-function run_cleanup_pipeline!(@nospecialize(job::CompilerJob), mod::LLVM.Module)
-    @dispose pb=NewPMPassBuilder() begin
-        add!(pb, RecomputeGlobalsAAPass())
-        add!(pb, GlobalOptPass())
-        add!(pb, GlobalDCEPass())
-        add!(pb, StripDeadPrototypesPass())
-        run!(pb, mod, llvm_machine(job.config.target))
-    end
-    return
-end
-
-# Final preparations for the module to be compiled to machine code. These passes should not
-# be run when e.g. compiling to write to disk.
+# Finalize the module for backend emission by collecting and lowering all live relocations.
 function prepare_execution!(@nospecialize(job::CompilerJob), mod::LLVM.Module,
                             relocs::Relocations=Relocations())
     # Clean up first so only live relocations get lowered.
-    run_cleanup_pipeline!(job, mod)
+    function cleanup()
+        @dispose pb=NewPMPassBuilder() begin
+            add!(pb, RecomputeGlobalsAAPass())
+            add!(pb, GlobalOptPass())
+            add!(pb, GlobalDCEPass())
+            add!(pb, StripDeadPrototypesPass())
+            run!(pb, mod, llvm_machine(job.config.target))
+        end
+    end
+    cleanup()
     prune_dead_relocations!(mod, relocs)
 
     collect_cglobal_relocations!(mod, relocs)
     lower_relocations!(job, mod, relocs)
 
-    # Fold constants exposed by eager lowering, and discard slots made dead by either
-    # lowering strategy.
-    run_cleanup_pipeline!(job, mod)
+    # Fold constants exposed by eager lowering, and discard slots made dead by
+    # either lowering strategy.
+    cleanup()
     prune_dead_relocations!(mod, relocs)
 
     has_unresolved_cglobal_loads(mod, relocs) &&

src/relocation.jl

@@ -1,27 +1,31 @@
 # Relocation model
 #
 # A relocation is a site => target pair. Targets are Julia object identities
-# (`JuliaValueRef`, like codegen's identity-keyed `global_targets`) or named libjulia
-# globals (`CGlobalRef`, like JuliaVariables). Every site names a word at a byte offset in a
-# global. Dedicated sites use offset zero in a word-sized declaration (like
-# `jl_sysimg_gvars`); other sites are inside defined globals (like
-# `gctags_list`/`relocs_list`). Declarations can be baked, patched, or imported; sites in
-# definitions can only be baked or patched.
+# (`JuliaValueRef`, like codegen's identity-keyed `global_targets`) or named
+# libjulia globals (`CGlobalRef`, like JuliaVariables). Every site names a word
+# at a byte offset in a global. Dedicated sites use offset zero in a word-sized
+# declaration (like `jl_sysimg_gvars`); other sites are inside defined globals
+# (like `gctags_list`/`relocs_list`). Declarations can be baked, patched, or
+# imported; sites in definitions can only be baked or patched.
 #
 #   produce ──▶ merge (on link) ──▶ prune (after DCE) ──▶ lower (at emit_asm)
 #
-# Lowering strategy                  Loader contract                    Julia analog
-# `bake_relocations!`               none; current-session words baked  JIT address folding
-# `emit_patchable_relocations!`      patch named globals after load     sysimage gvars
+# Lowering strategy              Loader contract                    Julia analog
+# -----------------              ---------------                    ------------
+# `bake_relocations!`            none; current-session words baked  JIT address folding
+# `emit_patchable_relocations!`  patch named globals after load     sysimage gvars
 #
 # The producers are `collect_julia_value_relocations!` during IR generation and
-# `collect_cglobal_relocations!` immediately before backend lowering. Names are globally
-# unique and assigned once, so linking can merge IR and metadata without renaming.
+# `collect_cglobal_relocations!` immediately before backend lowering. Names are
+# globally unique and assigned once, so linking can merge IR and metadata
+# without renaming.
 #
-# Generated code is portable only when `supports_relocatable_ir()` and the backend preserves
-# these relocations for its loader. The default lowering bakes current-session values.
+# Generated code is portable only when `supports_relocatable_ir()` and the
+# backend preserves these relocations for its loader. The default lowering bakes
+# current-session values.
 
-## Targets
+
+## targets
 
 """
     JuliaValueRef(value)
@@ -79,7 +83,8 @@ function resolve_relocation_target(target::CGlobalRef)
     return unsafe_load(address)
 end
 
-## The table
+
+## the table
 
 """
     RelocationSite(name, offset)
@@ -172,7 +177,8 @@ function foreach_relocation(f, mod::LLVM.Module, relocs::Relocations)
     return
 end
 
-## Producers
+
+## producers
 
 function collect_julia_value_relocations!(mod::LLVM.Module,
                                          gv_to_value::Dict{String, Ptr{Cvoid}})
@@ -364,7 +370,8 @@ function has_unresolved_cglobal_loads(mod::LLVM.Module, relocs::Relocations)
     return false
 end
 
-## Bookkeeping
+
+## bookkeeping
 
 function link_relocatable!(dest_mod::LLVM.Module, dest_relocs::Relocations,
                             src_mod::LLVM.Module, src_relocs::Relocations;
@@ -422,7 +429,8 @@ function prune_dead_relocations!(mod::LLVM.Module, relocs::Relocations)
     return
 end
 
-## Lowering
+
+## lowering
 
 """
     lower_relocations!(job, mod, relocs)
@@ -487,7 +495,8 @@ function emit_patchable_relocations!(mod::LLVM.Module, relocs::Relocations)
     return
 end
 
-## Introspection
+
+## introspection
 
 function referenced_object(value, relocs::Relocations)
     # This is best-effort: optimized shapes fall back to the unknown-binding error path.