COFF: Move .rsrc to the end of the list of non-discardable sections.

[pcc]

Summary

The Win32 UpdateResource function can change the contents of .rsrc. It
will move the sections that come after, but if any of those sections
contain references to sections before .rsrc or vice versa (such as
call or PC-relative lea instructions), or if references to those
sections appear in the PE header (such as the entry point), those
references will break. This was found by a test in Chromium.

[pcc]

We went with D45260.

lld/COFF/Writer.cpp

void Writer::assignAddresses() {
   SizeOfHeaders = DOSStubSize + sizeof(PEMagic) + sizeof(coff_file_header) +
                   sizeof(data_directory) * NumberfOfDataDirectory +
                   sizeof(coff_section) * OutputSections.size();
   SizeOfHeaders +=
       Config->is64() ? sizeof(pe32plus_header) : sizeof(pe32_header);
   SizeOfHeaders = alignTo(SizeOfHeaders, SectorSize);
   uint64_t RVA = PageSize; // The first page is kept unmapped.
   FileSize = SizeOfHeaders;
-  // Move DISCARDABLE (or non-memory-mapped) sections to the end of file because
-  // the loader cannot handle holes.
-  std::stable_partition(
-      OutputSections.begin(), OutputSections.end(), [](OutputSection *S) {
-        return (S->getPermissions() & IMAGE_SCN_MEM_DISCARDABLE) == 0;
+
+  // There are two constraints on section ordering:
+  // 1) DISCARDABLE (or non-memory-mapped) sections need to be at the end of
+  //    the file because the loader cannot handle holes.
+  // 2) The .rsrc section needs to appear at the end of the list of
+  //    non-discardable sections because the UpdateResource function may change
+  //    its size.
+  auto sectionOrder = [](OutputSection *S) {
+    if (S->getPermissions() & IMAGE_SCN_MEM_DISCARDABLE)
+      return 2;
+    if (S->Name == ".rsrc")
+      return 1;
+    return 0;
+  };
+  std::stable_sort(OutputSections.begin(), OutputSections.end(),
+                   [&](OutputSection *S1, OutputSection *S2) {
+                     return sectionOrder(S1) < sectionOrder(S2);
                    });
+
   for (OutputSection *Sec : OutputSections) {
     if (Sec->Name == ".reloc")
       addBaserels(Sec);
     uint64_t RawSize = 0, VirtualSize = 0;
     Sec->Header.VirtualAddress = RVA;
     for (Chunk *C : Sec->getChunks()) {
       VirtualSize = alignTo(VirtualSize, C->Alignment);
       C->setRVA(RVA + VirtualSize);

lld/test/COFF/combined-resources.test

 // Check that lld properly handles merging multiple .res files.
 // The inputs were generated with the following commands, using the original
 // Windows rc.exe
 // > rc /fo combined-resources.res /nologo combined-resources.rc
 // > rc /fo combined-resources-2.res /nologo combined-resources-2.rc
 
 # RUN: yaml2obj < %p/Inputs/ret42.yaml > %t.obj
 # RUN: lld-link /out:%t.exe /entry:main %t.obj %p/Inputs/resource.res \
 # RUN:   %p/Inputs/combined-resources.res %p/Inputs/combined-resources-2.res
 
 # RUN: llvm-readobj -coff-resources -file-headers -section-data %t.exe | \
 # RUN:   FileCheck %s
 
-CHECK:      ResourceTableRVA: 0x1000
+CHECK:      ResourceTableRVA: 0x2000
 CHECK-NEXT: ResourceTableSize: 0xC1C
 CHECK-DAG:  Resources [
 CHECK-NEXT:   Total Number of Resources: 13
 CHECK-DAG:  .rsrc Data (
 CHECK-NEXT: 0000: 00000000 00000000 00000000 01000600  |................|
 CHECK-NEXT: 0010: 38030080 48000080 02000000 60000080  |8...H.......`...|
 CHECK-NEXT: 0020: 04000000 80000080 05000000 A0000080  |................|
 CHECK-NEXT: 0030: 06000000 B8000080 09000000 D0000080  |................|

 CHECK-NEXT: 0190: 09040000 60020000 00000000 00000000  |....`...........|
 CHECK-NEXT: 01A0: 00000000 00000100 09040000 70020000  |............p...|
 CHECK-NEXT: 01B0: 00000000 00000000 00000000 00000200  |................|
 CHECK-NEXT: 01C0: 09040000 80020000 04080000 90020000  |................|
 CHECK-NEXT: 01D0: 00000000 00000000 00000000 00000100  |................|
 CHECK-NEXT: 01E0: 09040000 A0020000 00000000 00000000  |................|
 CHECK-NEXT: 01F0: 00000000 00000300 09040000 B0020000  |................|
 CHECK-NEXT: 0200: 04080000 C0020000 07100000 D0020000  |................|
-CHECK-NEXT: 0210: FC1A0000 39000000 00000000 00000000  |....9...........|
-CHECK-NEXT: 0220: C4130000 28030000 00000000 00000000  |....(...........|
-CHECK-NEXT: 0230: EC160000 28030000 00000000 00000000  |....(...........|
-CHECK-NEXT: 0240: CC1A0000 30000000 00000000 00000000  |....0...........|
-CHECK-NEXT: 0250: 141A0000 2E000000 00000000 00000000  |................|
-CHECK-NEXT: 0260: 441A0000 6C000000 00000000 00000000  |D...l...........|
-CHECK-NEXT: 0270: 7C130000 2A000000 00000000 00000000  ||...*...........|
-CHECK-NEXT: 0280: AC130000 18000000 00000000 00000000  |................|
-CHECK-NEXT: 0290: 041C0000 18000000 00000000 00000000  |................|
-CHECK-NEXT: 02A0: B41A0000 18000000 00000000 00000000  |................|
-CHECK-NEXT: 02B0: 3C1B0000 36000000 00000000 00000000  |<...6...........|
-CHECK-NEXT: 02C0: 741B0000 43000000 00000000 00000000  |t...C...........|
-CHECK-NEXT: 02D0: BC1B0000 42000000 00000000 00000000  |....B...........|
+CHECK-NEXT: 0210: FC2A0000 39000000 00000000 00000000  |.*..9...........|
+CHECK-NEXT: 0220: C4230000 28030000 00000000 00000000  |.#..(...........|
+CHECK-NEXT: 0230: EC260000 28030000 00000000 00000000  |.&..(...........|
+CHECK-NEXT: 0240: CC2A0000 30000000 00000000 00000000  |.*..0...........|
+CHECK-NEXT: 0250: 142A0000 2E000000 00000000 00000000  |.*..............|
+CHECK-NEXT: 0260: 442A0000 6C000000 00000000 00000000  |D*..l...........|
+CHECK-NEXT: 0270: 7C230000 2A000000 00000000 00000000  ||#..*...........|
+CHECK-NEXT: 0280: AC230000 18000000 00000000 00000000  |.#..............|
+CHECK-NEXT: 0290: 042C0000 18000000 00000000 00000000  |.,..............|
+CHECK-NEXT: 02A0: B42A0000 18000000 00000000 00000000  |.*..............|
+CHECK-NEXT: 02B0: 3C2B0000 36000000 00000000 00000000  |<+..6...........|
+CHECK-NEXT: 02C0: 742B0000 43000000 00000000 00000000  |t+..C...........|
+CHECK-NEXT: 02D0: BC2B0000 42000000 00000000 00000000  |.+..B...........|
 CHECK-NEXT: 02E0: 0E004D00 59004100 43004300 45004C00  |..M.Y.A.C.C.E.L.|
 CHECK-NEXT: 02F0: 45005200 41005400 4F005200 53000600  |E.R.A.T.O.R.S...|
 CHECK-NEXT: 0300: 43005500 52005300 4F005200 04004F00  |C.U.R.S.O.R...O.|
 CHECK-NEXT: 0310: 4B004100 59000A00 54004500 53005400  |K.A.Y...T.E.S.T.|
 CHECK-NEXT: 0320: 44004900 41004C00 4F004700 05002200  |D.I.A.L.O.G...".|
 CHECK-NEXT: 0330: 45004100 54002200 0B005300 54005200  |E.A.T."...S.T.R.|
 CHECK-NEXT: 0340: 49004E00 47004100 52005200 41005900  |I.N.G.A.R.R.A.Y.|
 CHECK-NEXT: 0350: 0A004D00 59005200 45005300 4F005500  |..M.Y.R.E.S.O.U.|

lld/test/COFF/manifestinput.test

 # REQUIRES: manifest_tool
 
 # RUN: yaml2obj %p/Inputs/ret42.yaml > %t.obj
 # RUN: lld-link /out:%t.exe /entry:main \
 # RUN:   /manifest:embed \
 # RUN:   /manifestuac:"level='requireAdministrator'" \
 # RUN:   /manifestinput:%p/Inputs/manifestinput.test %t.obj
 # RUN: llvm-readobj -coff-resources -file-headers %t.exe | FileCheck %s \
 # RUN:   -check-prefix TEST_EMBED
 
-TEST_EMBED:          ResourceTableRVA: 0x1000
+TEST_EMBED:          ResourceTableRVA: 0x2000
 TEST_EMBED-NEXT:     ResourceTableSize: 0x298
 TEST_EMBED-DAG:      Resources [
 TEST_EMBED-NEXT:       Total Number of Resources: 1
 TEST_EMBED-DAG:        Number of String Entries: 0
 TEST_EMBED-NEXT:       Number of ID Entries: 1
 TEST_EMBED-NEXT:       Type: kRT_MANIFEST (ID 24) [
 TEST_EMBED-NEXT:         Table Offset: 0x18
 TEST_EMBED-NEXT:         Number of String Entries: 0
 TEST_EMBED-NEXT:         Number of ID Entries: 1
 TEST_EMBED-NEXT:         Name: (ID 1) [
 TEST_EMBED-NEXT:           Table Offset: 0x30
 TEST_EMBED-NEXT:           Number of String Entries: 0
 TEST_EMBED-NEXT:           Number of ID Entries: 1
 TEST_EMBED-NEXT:           Language: (ID 1033) [
 TEST_EMBED-NEXT:             Entry Offset: 0x48

lld/test/COFF/resource.test

 # RUN: yaml2obj < %p/Inputs/ret42.yaml > %t.obj
 # RUN: lld-link /out:%t.exe /entry:main %t.obj %p/Inputs/resource.res
 
 # Check if the binary contains UTF-16LE string "Hello" copied from resource.res.
 # RUN: FileCheck --check-prefix=EXE %s < %t.exe
 
 EXE: {{H.e.l.l.o}}
 
 # Verify the resource tree layout in the final executable.
 # RUN: llvm-readobj -file-headers -coff-resources -section-data %t.exe | \
 # RUN:   FileCheck --check-prefix=RESOURCE_INFO %s
 
-RESOURCE_INFO:      ResourceTableRVA: 0x1000
+RESOURCE_INFO:      ResourceTableRVA: 0x2000
 RESOURCE_INFO-NEXT: ResourceTableSize: 0x88
 RESOURCE_INFO-DAG:  Resources [
 RESOURCE_INFO-NEXT:   Total Number of Resources: 1
-RESOURCE_INFO-NEXT:   Base Table Address: 0x400
+RESOURCE_INFO-NEXT:   Base Table Address: 0x600
 RESOURCE_INFO-DAG:    Number of String Entries: 0
 RESOURCE_INFO-NEXT:   Number of ID Entries: 1
 RESOURCE_INFO-NEXT:   Type: kRT_STRING (ID 6) [
 RESOURCE_INFO-NEXT:     Table Offset: 0x18
 RESOURCE_INFO-NEXT:     Number of String Entries: 0
 RESOURCE_INFO-NEXT:     Number of ID Entries: 1
 RESOURCE_INFO-NEXT:     Name: (ID 1) [
 RESOURCE_INFO-NEXT:       Table Offset: 0x30
 RESOURCE_INFO-NEXT:       Number of String Entries: 0
 RESOURCE_INFO-NEXT:       Number of ID Entries: 1
 RESOURCE_INFO-NEXT:       Language: (ID 1033) [
 RESOURCE_INFO-NEXT:         Entry Offset: 0x48
 RESOURCE_INFO-NEXT:         Time/Date Stamp: 1970-01-01 00:00:00 (0x0)
 RESOURCE_INFO-NEXT:         Major Version: 0
 RESOURCE_INFO-NEXT:         Minor Version: 0
 RESOURCE_INFO-NEXT:         Characteristics: 0
 RESOURCE_INFO-DAG: .rsrc Data (
 RESOURCE_INFO-NEXT: 0000: 00000000 00000000 00000000 00000100  |................|
 RESOURCE_INFO-NEXT: 0010: 06000000 18000080 00000000 00000000  |................|
 RESOURCE_INFO-NEXT: 0020: 00000000 00000100 01000000 30000080  |............0...|
 RESOURCE_INFO-NEXT: 0030: 00000000 00000000 00000000 00000100  |................|
-RESOURCE_INFO-NEXT: 0040: 09040000 48000000 58100000 2A000000  |....H...X...*...|
+RESOURCE_INFO-NEXT: 0040: 09040000 48000000 58200000 2A000000  |....H...X ..*...|
 RESOURCE_INFO-NEXT: 0050: 00000000 00000000 00000500 48006500  |............H.e.|
 RESOURCE_INFO-NEXT: 0060: 6C006C00 6F000000 00000000 00000000  |l.l.o...........|
 RESOURCE_INFO-NEXT: 0070: 00000000 00000000 00000000 00000000  |................|
 RESOURCE_INFO-NEXT: 0080: 00000000 00000000                    |........|
 RESOURCE_INFO-NEXT: )