Add ms-hotpatch flag. Proof of concept only working on x86/x64.

rust-lang · May 10, 2024 · e7d7c62 · e7d7c62
1 parent a6e87c5
commit e7d7c62
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 0 deletions.
diff --git a/compiler/rustc_codegen_llvm/src/attributes.rs b/compiler/rustc_codegen_llvm/src/attributes.rs
@@ -341,6 +341,15 @@ pub fn from_fn_attrs<'ll, 'tcx>(
         to_add.push(llvm::CreateAttrString(cx.llcx, "use-sample-profile"));
     }
 
+    // patchable-function is only implemented on x86 on LLVM
+    if cx.sess().opts.unstable_opts.ms_hotpatch && cx.sess().target.is_x86() {
+        to_add.push(llvm::CreateAttrStringValue(
+            cx.llcx,
+            "patchable-function",
+            "prologue-short-redirect",
+        ));
+    }
+
     // FIXME: none of these functions interact with source level attributes.
     to_add.extend(frame_pointer_type_attr(cx));
     to_add.extend(function_return_attr(cx));

diff --git a/compiler/rustc_codegen_llvm/src/back/owned_target_machine.rs b/compiler/rustc_codegen_llvm/src/back/owned_target_machine.rs
@@ -36,6 +36,7 @@ impl OwnedTargetMachine {
         emit_stack_size_section: bool,
         relax_elf_relocations: bool,
         use_init_array: bool,
+        use_hotpatch: bool,
         split_dwarf_file: &CStr,
         output_obj_file: &CStr,
         debug_info_compression: &CStr,
@@ -68,6 +69,7 @@ impl OwnedTargetMachine {
                 emit_stack_size_section,
                 relax_elf_relocations,
                 use_init_array,
+                use_hotpatch,
                 split_dwarf_file.as_ptr(),
                 output_obj_file.as_ptr(),
                 debug_info_compression.as_ptr(),

diff --git a/compiler/rustc_codegen_llvm/src/back/write.rs b/compiler/rustc_codegen_llvm/src/back/write.rs
@@ -220,6 +220,10 @@ pub fn target_machine_factory(
     let use_init_array =
         !sess.opts.unstable_opts.use_ctors_section.unwrap_or(sess.target.use_ctors_section);
 
+    // this annotes in the debug file that code is hotpatchable. In addtion without it -functionpadmin will be ignored.
+    // See: https://github.com/llvm/llvm-project/blob/d703b922961e0d02a5effdd4bfbb23ad50a3cc9f/lld/COFF/Writer.cpp#L1298
+    let use_hotpatch = sess.opts.unstable_opts.ms_hotpatch && sess.target.is_x86();
+
     let path_mapping = sess.source_map().path_mapping().clone();
 
     let use_emulated_tls = matches!(sess.tls_model(), TlsModel::Emulated);
@@ -292,6 +296,7 @@ pub fn target_machine_factory(
             emit_stack_size_section,
             relax_elf_relocations,
             use_init_array,
+            use_hotpatch,
             &split_dwarf_file,
             &output_obj_file,
             &debuginfo_compression,

diff --git a/compiler/rustc_codegen_llvm/src/llvm/ffi.rs b/compiler/rustc_codegen_llvm/src/llvm/ffi.rs
@@ -2189,6 +2189,7 @@ extern "C" {
         EmitStackSizeSection: bool,
         RelaxELFRelocations: bool,
         UseInitArray: bool,
+        UseHotpatch: bool,
         SplitDwarfFile: *const c_char,
         OutputObjFile: *const c_char,
         DebugInfoCompression: *const c_char,

diff --git a/compiler/rustc_interface/src/tests.rs b/compiler/rustc_interface/src/tests.rs
@@ -798,6 +798,7 @@ fn test_unstable_options_tracking_hash() {
     tracked!(mir_keep_place_mention, true);
     tracked!(mir_opt_level, Some(4));
     tracked!(move_size_limit, Some(4096));
+    tracked!(ms_hotpatch, true);
     tracked!(mutable_noalias, false);
     tracked!(
         next_solver,

diff --git a/compiler/rustc_llvm/llvm-wrapper/PassWrapper.cpp b/compiler/rustc_llvm/llvm-wrapper/PassWrapper.cpp
@@ -405,6 +405,7 @@ extern "C" LLVMTargetMachineRef LLVMRustCreateTargetMachine(
     bool EmitStackSizeSection,
     bool RelaxELFRelocations,
     bool UseInitArray,
+    bool UseHotpatch,
     const char *SplitDwarfFile,
     const char *OutputObjFile,
     const char *DebugInfoCompression,
@@ -436,6 +437,7 @@ extern "C" LLVMTargetMachineRef LLVMRustCreateTargetMachine(
   Options.MCOptions.AsmVerbose = AsmComments;
   Options.MCOptions.PreserveAsmComments = AsmComments;
   Options.MCOptions.ABIName = ABIStr;
+  Options.Hotpatch = UseHotpatch;
   if (SplitDwarfFile) {
       Options.MCOptions.SplitDwarfFile = SplitDwarfFile;
   }

diff --git a/compiler/rustc_session/src/options.rs b/compiler/rustc_session/src/options.rs
@@ -1813,6 +1813,10 @@ options! {
         "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
     move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
         "the size at which the `large_assignments` lint starts to be emitted"),
+    ms_hotpatch: bool = (false, parse_bool, [TRACKED],
+        "ensures hotpatching is always possible by ensuring that the first instruction of \
+        each function is at least two bytes, and no jump within the function goes to the first instruction. \
+        Should be combined with link-arg passing -functionpadmin to the linker. Currently only supported for x86 (default: false)"),
     mutable_noalias: bool = (true, parse_bool, [TRACKED],
         "emit noalias metadata for mutable references (default: yes)"),
     next_solver: Option<NextSolverConfig> = (None, parse_next_solver_config, [TRACKED],

diff --git a/compiler/rustc_target/src/spec/mod.rs b/compiler/rustc_target/src/spec/mod.rs
@@ -1910,6 +1910,9 @@ impl Target {
 
         Ok(dl)
     }
+    pub fn is_x86(&self) -> bool {
+        ["x86", "x86_64"].contains(&&self.arch[..])
+    }
 }
 
 pub trait HasTargetSpec {

diff --git a/tests/codegen/ms-hotpatch.rs b/tests/codegen/ms-hotpatch.rs
@@ -0,0 +1,12 @@
+//@ revisions: x32 x64
+//@[x32] only-x86
+//@[x64] only-x86_64
+//@ compile-flags: -Z ms-hotpatch
+
+#![crate_type = "lib"]
+
+#[no_mangle]
+pub fn foo() {}
+
+// CHECK: @foo() unnamed_addr #0
+// CHECK: attributes #0 = { {{.*}} "patchable-function"="prologue-short-redirect" {{.*}}}