Add the PlatformNativeImage flag as spec'd in #120584

Author: jkoritzinsky

docs/design/coreclr/botr/readytorun-format.md

@@ -135,6 +135,7 @@ struct READYTORUN_CORE_HEADER
 | READYTORUN_FLAG_COMPONENT                  | 0x00000020 | This is a component assembly of a composite R2R image
 | READYTORUN_FLAG_MULTIMODULE_VERSION_BUBBLE | 0x00000040 | This R2R module has multiple modules within its version bubble (For versions before version 6.3, all modules are assumed to possibly have this characteristic)
 | READYTORUN_FLAG_UNRELATED_R2R_CODE         | 0x00000080 | This R2R module has code in it that would not be naturally encoded into this module
+| READYTORUN_FLAG_PLATFORM_NATIVE_IMAGE              | 0x00000100 | The owning composite executable is in the platform native format
 
 ## READYTORUN_SECTION
 

src/coreclr/inc/readytorun.h

@@ -20,7 +20,7 @@
 // If you update this, ensure you run `git grep MINIMUM_READYTORUN_MAJOR_VERSION`
 // and handle pending work.
 #define READYTORUN_MAJOR_VERSION 16
-#define READYTORUN_MINOR_VERSION 0x0000
+#define READYTORUN_MINOR_VERSION 0x0001
 
 #define MINIMUM_READYTORUN_MAJOR_VERSION 16
 
@@ -47,6 +47,8 @@
 // R2R Version 14 changed x86 code generation to use funclets
 // R2R Version 15 removes double to int/uint helper calls
 // R2R Version 16 replaces the compression format for debug boundaries with a new format that is smaller and more efficient to parse
+//     R2R 16 is not backward compatible with 15.x or earlier.
+// R2R Version 16.1 adds the READYTORUN_FLAG_PLATFORM_NATIVE_IMAGE flag to specify that the R2R image pointed to by OwnerCompositeExecutable is in the platform native format.
 
 struct READYTORUN_CORE_HEADER
 {
@@ -83,6 +85,7 @@ enum ReadyToRunFlag
     READYTORUN_FLAG_COMPONENT                   = 0x00000020,   // This is the header describing a component assembly of composite R2R
     READYTORUN_FLAG_MULTIMODULE_VERSION_BUBBLE  = 0x00000040,   // This R2R module has multiple modules within its version bubble (For versions before version 6.2, all modules are assumed to possibly have this characteristic)
     READYTORUN_FLAG_UNRELATED_R2R_CODE          = 0x00000080,   // This R2R module has code in it that would not be naturally encoded into this module
+    READYTORUN_FLAG_PLATFORM_NATIVE_IMAGE         = 0x00000100,   // The owning composite executable is in the platform native format
 };
 
 enum class ReadyToRunSectionType : uint32_t

src/coreclr/nativeaot/Runtime/inc/ModuleHeaders.h

@@ -12,7 +12,7 @@ struct ReadyToRunHeaderConstants
     static const uint32_t Signature = 0x00525452; // 'RTR'
 
     static const uint32_t CurrentMajorVersion = 16;
-    static const uint32_t CurrentMinorVersion = 0;
+    static const uint32_t CurrentMinorVersion = 1;
 };
 
 struct ReadyToRunHeader

src/coreclr/tools/Common/Internal/Runtime/ModuleHeaders.cs

@@ -16,7 +16,7 @@ internal struct ReadyToRunHeaderConstants
         public const uint Signature = 0x00525452; // 'RTR'
 
         public const ushort CurrentMajorVersion = 16;
-        public const ushort CurrentMinorVersion = 0;
+        public const ushort CurrentMinorVersion = 1;
     }
 #if READYTORUN
 #pragma warning disable 0169

src/coreclr/tools/Common/Internal/Runtime/ReadyToRunConstants.cs

@@ -17,8 +17,9 @@ public enum ReadyToRunFlags
         READYTORUN_FLAG_NonSharedPInvokeStubs = 0x00000008,     // PInvoke stubs compiled into image are non-shareable (no secret parameter)
         READYTORUN_FLAG_EmbeddedMSIL = 0x00000010,              // MSIL is embedded in the composite R2R executable
         READYTORUN_FLAG_Component = 0x00000020,                 // This is the header describing a component assembly of composite R2R
-        READYTORUN_FLAG_MultiModuleVersionBubble = 0x00000040,   // This R2R module has multiple modules within its version bubble
+        READYTORUN_FLAG_MultiModuleVersionBubble = 0x00000040,  // This R2R module has multiple modules within its version bubble
         READYTORUN_FLAG_UnrelatedR2RCode = 0x00000080,          // This R2R module has generic code in it that would not be naturally encoded into this module
+        READYTORUN_FLAG_PlatformNativeImage = 0x00000100,       // The owning composite executable is in the platform native format
     }
 
     public enum ReadyToRunImportSectionType : byte

src/coreclr/tools/aot/ILCompiler.ReadyToRun/CodeGen/ReadyToRunObjectWriter.cs

@@ -179,43 +179,12 @@ public void EmitReadyToRunObjects(ReadyToRunContainerFormat format, Logger logge
             {
                 var stopwatch = Stopwatch.StartNew();
 
-                Debug.Assert(format == ReadyToRunContainerFormat.PE);
-
-                int? timeDateStamp;
-
-                if (_nodeFactory.CompilationModuleGroup.IsCompositeBuildMode && _componentModule == null)
-                {
-                    timeDateStamp = null;
-                }
-                else
-                {
-                    PEReader inputPeReader = (_componentModule != null ? _componentModule.PEReader : _nodeFactory.CompilationModuleGroup.CompilationModuleSet.First().PEReader);
-                    timeDateStamp = inputPeReader.PEHeaders.CoffHeader.TimeDateStamp;
-                }
-
-                ObjectWriter.ObjectWriter objectWriter;
-
-                if (format == ReadyToRunContainerFormat.PE)
+                ObjectWriter.ObjectWriter objectWriter = format switch
                 {
-                    PEObjectWriter peWriter = new(_nodeFactory, ObjectWritingOptions.None, _outputInfoBuilder, _objectFilePath, _customPESectionAlignment, timeDateStamp);
-
-                    if (_nodeFactory.CompilationModuleGroup.IsCompositeBuildMode && _componentModule == null)
-                    {
-                        peWriter.AddExportedSymbol("RTR_HEADER");
-                    }
-                    objectWriter = peWriter;
-                }
-                else if (format == ReadyToRunContainerFormat.MachO)
-                {
-                    // Use the base symbol name emitted into .dylib files,
-                    // with the expectation that the R2R object will be linked into
-                    // a dylib.
-                    objectWriter = new MachObjectWriter(_nodeFactory, ObjectWritingOptions.None, _outputInfoBuilder, baseSymbolName: "__mh_dylib_header");
-                }
-                else
-                {
-                    throw new UnreachableException();
-                }
+                    ReadyToRunContainerFormat.PE => CreatePEObjectWriter(),
+                    ReadyToRunContainerFormat.MachO => CreateMachObjectWriter(),
+                    _ => throw new UnreachableException()
+                };
 
                 using FileStream stream = new FileStream(_objectFilePath, FileMode.Create);
                 objectWriter.EmitObject(stream, _nodes, dumper: null, logger);
@@ -300,6 +269,34 @@ public void EmitReadyToRunObjects(ReadyToRunContainerFormat format, Logger logge
             }
         }
 
+        private PEObjectWriter CreatePEObjectWriter()
+        {
+            int? timeDateStamp;
+
+            if (_nodeFactory.CompilationModuleGroup.IsCompositeBuildMode && _componentModule == null)
+            {
+                timeDateStamp = null;
+            }
+            else
+            {
+                PEReader inputPeReader = (_componentModule != null ? _componentModule.PEReader : _nodeFactory.CompilationModuleGroup.CompilationModuleSet.First().PEReader);
+                timeDateStamp = inputPeReader.PEHeaders.CoffHeader.TimeDateStamp;
+            }
+
+            PEObjectWriter objectWriter = new(_nodeFactory, ObjectWritingOptions.None, _outputInfoBuilder, _objectFilePath, _customPESectionAlignment, timeDateStamp);
+
+            if (_nodeFactory.CompilationModuleGroup.IsCompositeBuildMode && _componentModule == null)
+            {
+                objectWriter.AddExportedSymbol("RTR_HEADER");
+            }
+            return objectWriter;
+        }
+
+        private MachObjectWriter CreateMachObjectWriter()
+        {
+            return new MachObjectWriter(_nodeFactory, ObjectWritingOptions.None, _outputInfoBuilder, baseSymbolName: "__mh_dylib_header");
+        }
+
         public static void EmitObject(
             string objectFilePath,
             EcmaModule componentModule,
@@ -319,7 +316,7 @@ public static void EmitObject(
             int customPESectionAlignment,
             Logger logger)
         {
-            Console.WriteLine($@"Emitting R2R PE file: {objectFilePath}");
+            Console.WriteLine($@"Emitting R2R {format} file: {objectFilePath}");
             ReadyToRunObjectWriter objectWriter = new ReadyToRunObjectWriter(
                 objectFilePath,
                 componentModule,

src/coreclr/tools/aot/ILCompiler.ReadyToRun/Compiler/ReadyToRunCodegenCompilation.cs

@@ -469,6 +469,21 @@ private void RewriteComponentFile(string inputFile, string outputFile, string ow
 
             flags |= _nodeFactory.CompilationModuleGroup.GetReadyToRunFlags() & ReadyToRunFlags.READYTORUN_FLAG_MultiModuleVersionBubble;
 
+            bool isNativeCompositeImage = false;
+            if (NodeFactory.Target.IsWindows && NodeFactory.Format == ReadyToRunContainerFormat.PE)
+            {
+                isNativeCompositeImage = true;
+            }
+            else if (NodeFactory.Target.IsApplePlatform && NodeFactory.Format == ReadyToRunContainerFormat.MachO)
+            {
+                isNativeCompositeImage = true;
+            }
+
+            if (isNativeCompositeImage)
+            {
+                flags |= ReadyToRunFlags.READYTORUN_FLAG_PlatformNativeImage;
+            }
+
             CopiedCorHeaderNode copiedCorHeader = new CopiedCorHeaderNode(inputModule);
             // Re-written components shouldn't have any additional diagnostic information - only information about the forwards.
             // Even with all of this, we might be modifying the image in a silly manner - adding a directory when if didn't have one.