[llvm-libtool-darwin] Add constant CPU_TYPE_ARM64_V8

[sameerarora101]

Summary

Add support for constant MachO::CPU_SUBTYPE_ARM64_V8. This constant is
needed so as to match llvm-libtool-darwin's behavior to that of
cctools' libtool when -arch_only flag is passed in on command line.
Here is the diff of llvm-libtool-darwin adding arch_only option for
reference: https://reviews.llvm.org/D84770.

[alexander-shaposhnikov]

I'd probably add a simple test for llvm-readobj as well.

[MaskRay]

llvm/test/tools/llvm-objdump/MachO/AArch64/macho-arm64-v8.test

1 ↗

(On Diff #282295)

Usually RUN and CHECK lines should use the same comment marker. Either you include the comment marker or leave the comment marker for both RUN and CHECK

[jhenderson]

In D85041#2188548, @alexshap wrote:

I'd probably add a simple test for llvm-readobj as well.

+1. Whilst you're at it. You might as well test the other types too in that enum (assuming they aren't already tested). You can use yaml2obj's -D to reuse the YAML for each input file.

llvm/test/tools/llvm-objdump/MachO/AArch64/Inputs/arm64_v8.macho.yaml

1 ↗

(On Diff #282295)

As this input is only used in one place, you can put it inline with the test that uses it. You'll need to use '#' for the RUN/CHECKs in the test then.

llvm/tools/llvm-objdump/MachODump.cpp

2108

Are there tests for these other cases too? If not, perhaps we should make the new test more generic, and test them all in one test?

[sameerarora101]

llvm/tools/llvm-objdump/MachODump.cpp

2108

Under llvm-objdump, for CPU-TYPE CPU_TYPE_ARM64,

• there is one test case for subtype CPU_SUBTYPE_ARM64E (macho-arm64e.test)
• one test case (which I added above) for CPU_SUBTYPE_ARM64_V8 (macho-arm64-v8.test)
• all remaining tests are for subtype CPU_SUBTYPE_ARM64_ALL

[sameerarora101]

Add test for llvm-readobj

[jhenderson]

llvm/test/tools/llvm-objdump/MachO/AArch64/macho-arm64-v8.test

1 ↗

(On Diff #282692)

Rather than add a test nearly identical to macho-arm64e.test, what do you think about renaming that test to macho-arm64-subtypes.test (or something similar) and merging the two (optionally with an explicit testing of the ALL subtype, but that's not so important since there's coverage elsewhere)

llvm/test/tools/llvm-readobj/MachO/file-headers-arm64.test

29–44

Rather than duplicating all these CHECKs just for the sake of one different one, you could use FileCheck's -D option or --check-prefixes option to share them.

Example using -D:

# RUN:   | FileCheck %s -DSUBTYPE="CPU_SUBTYPE_ARM64_ALL (0x0)" ...

#      CHECK:File: [[FILE]]
...
# CHECK-NEXT:  CpuSubType: [[SUBTYPE]]
...

# RUN:   | FileCheck %s -DSUBTYPE="CPU_SUBTYPE_ARM64_V8 (0x1)" ...
# RUN:   | FileCheck %s -DSUBTYPE="CPU_SUBTYPE_ARM64E (0x2)" ...

Using --check-prefixes:

# RUN:   | FileCheck %s --check-prefixes="COMMON,ALL" ...
...
# RUN:   | FileCheck %s --check-prefixes="COMMON,V8" ...
...
# RUN:   | FileCheck %s --check-prefixes="COMMON,E" ...

#      COMMON:File: [[FILE]]
...
# COMMON-NEXT:  CpuType: Arm64 (0x100000C)
#    ALL-NEXT:  CpuSubType: CPU_SUBTYPE_ARM64_ALL (0x0)
#     V8-NEXT:  CpuSubType: CPU_SUBTYPE_ARM64_V8 (0x1)
#      E-NEXT:  CpuSubType: CPU_SUBTYPE_ARM64E (0x2)
# COMMON-NEXT:  FileType: Relocatable (0x1)
...

llvm/tools/llvm-objdump/MachODump.cpp

2112–2115

This code-path doesn't seem to have any testing? The new objdump test only covers the other change in this file by my reading.

[sameerarora101]

llvm/test/tools/llvm-objdump/MachO/AArch64/macho-arm64-v8.test

1 ↗

(On Diff #282692)

Yeah, I agree. Updated it now, thanks!

llvm/tools/llvm-objdump/MachODump.cpp

2112–2115

True. Added a test for them while printing universal headers now (similar to universal-x86_64.i386.test) Thanks.

[sameerarora101]

Update tests.

[smeenai]

LGTM, but please wait for @jhenderson too.

[jhenderson]

LGTM, with optional nit.

llvm/test/tools/llvm-objdump/MachO/universal-arm64.test

6

Nit: as you only have one check prefix in this file, you can get rid of --check-prefix and just use the default CHECK

[sameerarora101]

Remove --check-prefix=FAT.

llvm/include/llvm/BinaryFormat/MachO.h

enum CPUSubTypeARM {
   CPU_SUBTYPE_ARM_V7K = 12,
   CPU_SUBTYPE_ARM_V6M = 14,
   CPU_SUBTYPE_ARM_V7M = 15,
   CPU_SUBTYPE_ARM_V7EM = 16
 };
 
 enum CPUSubTypeARM64 {
   CPU_SUBTYPE_ARM64_ALL = 0,
+  CPU_SUBTYPE_ARM64_V8 = 1,
   CPU_SUBTYPE_ARM64E = 2,
 };
 
 enum CPUSubTypeARM64_32 { CPU_SUBTYPE_ARM64_32_V8 = 1 };
 
 enum CPUSubTypeSPARC { CPU_SUBTYPE_SPARC_ALL = 0 };
 
 enum CPUSubTypePowerPC {

llvm/test/tools/llvm-objdump/MachO/AArch64/macho-arm64-subtypes.test

+# RUN: yaml2obj %s -o %tarm64-all.o -DSUBTYPE=0x0
+# RUN: llvm-objdump -p %tarm64-all.o | FileCheck --strict-whitespace %s --check-prefixes="COMMON,ALL"
+
+# RUN: yaml2obj %s -o %tarm64-v8.o -DSUBTYPE=0x1
+# RUN: llvm-objdump -p %tarm64-v8.o | FileCheck --strict-whitespace %s --check-prefixes="COMMON,V8"
+
+# RUN: yaml2obj %s -o %tarm64e.o -DSUBTYPE=0x2
+# RUN: llvm-objdump -p %tarm64e.o | FileCheck --strict-whitespace %s --check-prefixes="COMMON,E"
+
+# COMMON:      Mach header
+# COMMON-NEXT:       magic cputype cpusubtype  caps    filetype ncmds sizeofcmds      flags
+# ALL-NEXT:    MH_MAGIC_64   ARM64        ALL  0x00      OBJECT     0          0 0x00000000
+# V8-NEXT:     MH_MAGIC_64   ARM64         V8  0x00      OBJECT     0          0 0x00000000
+# E-NEXT:      MH_MAGIC_64   ARM64          E  0x00      OBJECT     0          0 0x00000000
+
+--- !mach-o
+FileHeader:
+  magic:           0xFEEDFACF
+  cputype:         0x0100000C
+  cpusubtype:      [[SUBTYPE]]
+  filetype:        0x00000001
+  ncmds:           0
+  sizeofcmds:      0
+  flags:           0x00000000
+  reserved:        0x00000000
+...

llvm/test/tools/llvm-objdump/MachO/AArch64/macho-arm64e.test

-// RUN: yaml2obj %p/Inputs/arm64e.macho.yaml -o %tarm64e.o
-// RUN: llvm-objdump -p %tarm64e.o | FileCheck --strict-whitespace %s
-
-CHECK:      Mach header
-CHECK-NEXT:       magic cputype cpusubtype  caps    filetype ncmds sizeofcmds      flags
-CHECK-NEXT: MH_MAGIC_64   ARM64          E  0x00      OBJECT     0          0 0x00000000

llvm/test/tools/llvm-objdump/MachO/universal-arm64.test

+## This test checks that the CPUTypes are printed correctly for the subtypes of
+## ARM64.
+
+# RUN: yaml2obj %s -o %tarm.o
+# RUN: llvm-objdump %tarm.o --universal-headers --macho | \
+# RUN:   FileCheck %s --check-prefix=FAT --match-full-lines
+
+# FAT:      Fat headers
+# FAT-NEXT: fat_magic FAT_MAGIC
+# FAT-NEXT: nfat_arch 3
+# FAT-NEXT: architecture arm64
+# FAT-NEXT:     cputype CPU_TYPE_ARM64
+# FAT-NEXT:     cpusubtype CPU_SUBTYPE_ARM64_ALL
+# FAT-NEXT:     capabilities 0x0
+# FAT-NEXT:     offset 4096
+# FAT-NEXT:     size 352
+# FAT-NEXT:     align 2^12 (4096)
+# FAT-NEXT: architecture
+# FAT-NEXT:     cputype CPU_TYPE_ARM64
+# FAT-NEXT:     cpusubtype CPU_SUBTYPE_ARM64_V8
+# FAT-NEXT:     capabilities 0x0
+# FAT-NEXT:     offset 16384
+# FAT-NEXT:     size 384
+# FAT-NEXT:     align 2^14 (16384)
+# FAT-NEXT: architecture
+# FAT-NEXT:     cputype CPU_TYPE_ARM64
+# FAT-NEXT:     cpusubtype CPU_SUBTYPE_ARM64E
+# FAT-NEXT:     capabilities 0x0
+# FAT-NEXT:     offset 28672
+# FAT-NEXT:     size 384
+# FAT-NEXT:     align 2^12 (4096)
+# FAT-NOT:{{.}}
+
+--- !fat-mach-o
+FatHeader:
+  magic:           0xCAFEBABE
+  nfat_arch:       3
+FatArchs:
+  - cputype:         0x0100000C
+    cpusubtype:      0x00000000
+    offset:          0x0000000000001000
+    size:            352
+    align:           12
+  - cputype:         0x0100000C
+    cpusubtype:      0x00000001
+    offset:          0x0000000000004000
+    size:            384
+    align:           14
+  - cputype:         0x0100000C
+    cpusubtype:      0x00000002
+    offset:          0x0000000000007000
+    size:            384
+    align:           12
+Slices:
+  - !mach-o
+    FileHeader:
+      magic:           0xFEEDFACF
+      cputype:         0x0100000C
+      cpusubtype:      0x00000000
+      filetype:        0x00000001
+      ncmds:           0
+      sizeofcmds:      0
+      flags:           0x00000000
+      reserved:        0x00000000
+  - !mach-o
+    FileHeader:
+      magic:           0xFEEDFACF
+      cputype:         0x0100000C
+      cpusubtype:      0x00000001
+      filetype:        0x00000001
+      ncmds:           0
+      sizeofcmds:      0
+      flags:           0x00000000
+      reserved:        0x00000000
+  - !mach-o
+    FileHeader:
+      magic:           0xFEEDFACF
+      cputype:         0x0100000C
+      cpusubtype:      0x00000002
+      filetype:        0x00000001
+      ncmds:           0
+      sizeofcmds:      0
+      flags:           0x00000000
+      reserved:        0x00000000
+...

llvm/test/tools/llvm-readobj/MachO/file-headers-arm64.test

+## Check subtype Arm64-ALL:
+# RUN: yaml2obj %s -o %t.arm64-all -DSUBTYPE=0x0
+# RUN: llvm-readobj -h %t.arm64-all \
+# RUN:  | FileCheck %s --strict-whitespace --match-full-lines -DFILE=%t.arm64-all --check-prefix=ARM64 -DSUBTYPE="CPU_SUBTYPE_ARM64_ALL (0x0)"
+
+## Check subtype Arm64-V8:
+# RUN: yaml2obj %s -o %t.arm64-v8 -DSUBTYPE=0x1
+# RUN: llvm-readobj -h %t.arm64-v8 \
+# RUN:  | FileCheck %s --strict-whitespace --match-full-lines -DFILE=%t.arm64-v8 --check-prefix=ARM64 -DSUBTYPE="CPU_SUBTYPE_ARM64_V8 (0x1)"
+
+## Check subtype Arm64E:
+# RUN: yaml2obj %s -o %t.arm64e -DSUBTYPE=0x2
+# RUN: llvm-readobj -h %t.arm64e \
+# RUN:  | FileCheck %s --strict-whitespace --match-full-lines -DFILE=%t.arm64e --check-prefix=ARM64 -DSUBTYPE="CPU_SUBTYPE_ARM64E (0x2)"
+
+#      ARM64:File: [[FILE]]
+# ARM64-NEXT:Format: Mach-O arm64
+# ARM64-NEXT:Arch: aarch64
+# ARM64-NEXT:AddressSize: 64bit
+# ARM64-NEXT:MachHeader {
+# ARM64-NEXT:  Magic: Magic64 (0xFEEDFACF)
+# ARM64-NEXT:  CpuType: Arm64 (0x100000C)
+# ARM64-NEXT:  CpuSubType: [[SUBTYPE]]
+# ARM64-NEXT:  FileType: Relocatable (0x1)
+# ARM64-NEXT:  NumOfLoadCommands: 0
+# ARM64-NEXT:  SizeOfLoadCommands: 0
+# ARM64-NEXT:  Flags [ (0x0)
+# ARM64-NEXT:  ]
+# ARM64-NEXT:  Reserved: 0x0
+# ARM64-NEXT:}
+# ARM64-NOT:{{.}}
+
+--- !mach-o
+FileHeader:
+  magic:           0xFEEDFACF
+  cputype:         0x0100000C
+  cpusubtype:      [[SUBTYPE]]
+  filetype:        0x00000001
+  ncmds:           0
+  sizeofcmds:      0
+  flags:           0x00000000
+  reserved:        0x00000000
+...

llvm/tools/llvm-objdump/MachODump.cpp

case MachO::CPU_SUBTYPE_ARM_V7S:
       break;
     default:
       printUnknownCPUType(cputype, cpusubtype);
       break;
     }
     break;
   case MachO::CPU_TYPE_ARM64:
     switch (cpusubtype & ~MachO::CPU_SUBTYPE_MASK) {
     case MachO::CPU_SUBTYPE_ARM64_ALL:
       outs() << "    cputype CPU_TYPE_ARM64\n";
       outs() << "    cpusubtype CPU_SUBTYPE_ARM64_ALL\n";
       break;
+    case MachO::CPU_SUBTYPE_ARM64_V8:
+      outs() << "    cputype CPU_TYPE_ARM64\n";
+      outs() << "    cpusubtype CPU_SUBTYPE_ARM64_V8\n";
+      break;
     case MachO::CPU_SUBTYPE_ARM64E:
       outs() << "    cputype CPU_TYPE_ARM64\n";
       outs() << "    cpusubtype CPU_SUBTYPE_ARM64E\n";
       break;
     default:
       printUnknownCPUType(cputype, cpusubtype);
       break;
     }
case MachO::CPU_TYPE_ARM:
       }
       break;
     case MachO::CPU_TYPE_ARM64:
       outs() << "   ARM64";
       switch (cpusubtype & ~MachO::CPU_SUBTYPE_MASK) {
       case MachO::CPU_SUBTYPE_ARM64_ALL:
         outs() << "        ALL";
         break;
+      case MachO::CPU_SUBTYPE_ARM64_V8:
+        outs() << "         V8";
+        break;
       case MachO::CPU_SUBTYPE_ARM64E:
         outs() << "          E";
         break;
       default:
         outs() << format(" %10d", cpusubtype & ~MachO::CPU_SUBTYPE_MASK);
         break;
       }
       break;

llvm/tools/llvm-readobj/MachODumper.cpp

static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM[] = {
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7S),
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7K),
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6M),
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7M),
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7EM),
 };
 
 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM64[] = {
     LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_ALL),
+    LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_V8),
     LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64E),
 };
 
 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesSPARC[] = {
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_SPARC_ALL),
 };
 
 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesPPC[] = {
   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_ALL),