[lld][COFF]llvm-readobj COFFDumper print PEHeader CheckSum

[Qfrost911]

Summary

In PEHeader, a field named "CheckSum" is not printed by llvm-readobj.

Previously, lld did not implement the PE-Checksum feature, I have implemented it in my version D139184, so I think it is necessary to output the value of this field via llvm-readobj.

And I will use it to achieve tests about this feature.

[aganea]

I think you might need to update some other tests. Have you ran ninja check-all? I see at least llvm/test/tools/llvm-readobj/COFF/file-headers.test might fail because of this change, there could be others. Ideally you could use cmake with -DLLVM_ENABLE_PROJECTS="llvm;clang;lld;clang-tools-extra;mlir"to ensure you have good coverage for ninja check-all.

[Qfrost911]

Oh, right, but I see there is only an error which in file-headers.test can be raised.

[Qfrost911]

fix

[aganea]

llvm/tools/llvm-readobj/COFFDumper.cpp

740

I would call W.printHex(...) here instead.

[Qfrost911]

Thanks, I think it's a good idea.

[Qfrost911]

fix

[thieta]

lld/test/COFF/hello32.test

45

Why is this line empty here and 0x0 below? Does this mean that the header isn't there?

I think I like it to either NOT be included if the header is missing or just 0x0 so it's a bit consistent in the output. Can't see any other field just being a empty line.

[mstorsjo]

lld/test/COFF/hello32.test

45

Leaving out the value can be a common practice for tests, when you want to span all lines with <CHECK>-NEXT lines, but you don't want to literally check all the contents of those lines - i.e. any checksum value (zero or nonzero) would be fine.

But for the purposes of this particular test, I guess the value should always be zero so spelling out the CheckSum: 0x0 probably is fine too.

[Qfrost911]

Oh, previously I leave blank because I would add other checksum test sets.

[aganea]

LGTM.

Do you have commit access? If yes, please wait a few days before commiting, in case other reviewers have anything to add. If you don’t have commit access, I could commit it for you, please provide the git author information.

[Qfrost911]

In D140555#4019479, @aganea wrote:

LGTM.

Do you have commit access? If yes, please wait a few days before commiting, in case other reviewers have anything to add. If you don’t have commit access, I could commit it for you, please provide the git author information.

Thanks. I have commit access. I wait a few days.

lld/test/COFF/hello32.test

 HEADER-NEXT:   MajorOperatingSystemVersion: 6
 HEADER-NEXT:   MinorOperatingSystemVersion: 0
 HEADER-NEXT:   MajorImageVersion: 0
 HEADER-NEXT:   MinorImageVersion: 0
 HEADER-NEXT:   MajorSubsystemVersion: 6
 HEADER-NEXT:   MinorSubsystemVersion: 0
 HEADER-NEXT:   SizeOfImage: 20480
 HEADER-NEXT:   SizeOfHeaders: 1024
+HEADER-NEXT:   CheckSum: 0x0
 HEADER-NEXT:   Subsystem: IMAGE_SUBSYSTEM_WINDOWS_CUI (0x3)
 HEADER-NEXT:   Characteristics [ (0x9140)
 HEADER-NEXT:     IMAGE_DLL_CHARACTERISTICS_APPCONTAINER (0x1000)
 HEADER-NEXT:     IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE (0x40)
 HEADER-NEXT:     IMAGE_DLL_CHARACTERISTICS_NX_COMPAT (0x100)
 HEADER-NEXT:     IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE (0x8000)
 HEADER-NEXT:   ]
 HEADER-NEXT:   SizeOfStackReserve: 1048576

llvm/test/tools/llvm-readobj/COFF/file-headers.test

 # I386-CUSTOM-HEADER-NEXT:  MajorOperatingSystemVersion: 6
 # I386-CUSTOM-HEADER-NEXT:  MinorOperatingSystemVersion: 0
 # I386-CUSTOM-HEADER-NEXT:  MajorImageVersion: 0
 # I386-CUSTOM-HEADER-NEXT:  MinorImageVersion: 0
 # I386-CUSTOM-HEADER-NEXT:  MajorSubsystemVersion: 6
 # I386-CUSTOM-HEADER-NEXT:  MinorSubsystemVersion: 0
 # I386-CUSTOM-HEADER-NEXT:  SizeOfImage: 4096
 # I386-CUSTOM-HEADER-NEXT:  SizeOfHeaders: 512
+# I386-CUSTOM-HEADER-NEXT:  CheckSum: 0x0
 # I386-CUSTOM-HEADER-NEXT:  Subsystem: IMAGE_SUBSYSTEM_WINDOWS_CUI (0x3)
 # I386-CUSTOM-HEADER-NEXT:  Characteristics [ (0x8140)
 # I386-CUSTOM-HEADER-NEXT:    IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE (0x40)
 # I386-CUSTOM-HEADER-NEXT:    IMAGE_DLL_CHARACTERISTICS_NX_COMPAT (0x100)
 # I386-CUSTOM-HEADER-NEXT:    IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE (0x8000)
 # I386-CUSTOM-HEADER-NEXT:  ]
 # I386-CUSTOM-HEADER-NEXT:  SizeOfStackReserve: 1048576
 # I386-CUSTOM-HEADER-NEXT:  SizeOfStackCommit: 4096

llvm/tools/llvm-readobj/COFFDumper.cpp

void COFFDumper::printPEHeader(const PEHeader *Hdr) {
   W.printNumber("MinorOperatingSystemVersion",
                 Hdr->MinorOperatingSystemVersion);
   W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
   W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
   W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
   W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
   W.printNumber("SizeOfImage", Hdr->SizeOfImage);
   W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
+  W.printHex   ("CheckSum", Hdr->CheckSum);
   W.printEnum  ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
   W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
                 makeArrayRef(PEDLLCharacteristics));
   W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
   W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
   W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
   W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
   W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);