[ObjectYAML] Handle SHF_COMPRESSED

[smeenai]

Summary

This was previously being silently dropped by obj2yaml and caused
parsing errors with yaml2obj.

[davide]

lgtm

[davide]

FWIW, the fact we're dropping flags we don't know about it a little annoying.
We should error instead.

[smeenai]

To clarify, it's dropped silently by obj2yaml, but yaml2obj complains if it doesn't recognize a flag value. I'll update the commit message before committing.

I was contemplating adding a test for obj2yaml as well to ensure its output didn't drop SHF_COMPRESSED, but I figured it would be slightly redundant, since obj2yaml and yaml2obj use the same flags handling logic.

[davide]

In D38490#886700, @smeenai wrote:

To clarify, it's dropped silently by obj2yaml, but yaml2obj complains if it doesn't recognize a flag value. I'll update the commit message before committing.

Thanks for clarifying.

I was contemplating adding a test for obj2yaml as well to ensure its output didn't drop SHF_COMPRESSED, but I figured it would be slightly redundant, since obj2yaml and yaml2obj use the same flags handling logic.

Probably it doesn't matter.

[davide]

test/tools/yaml2obj/shf-compressed.yaml

1–2 ↗

(On Diff #117467)

if you really want to make this test slightly fancier, you can test that the outputs of yaml2obj and obj2yaml are the same up to isomorphism (for some very relaxed definition of isomorphism, as you're not guaranteed that converting and then converting back will give you the original object for a series of reason).

[smeenai]

Clarify description and test obj2yaml

[smeenai]

Argh, totally didn't mean to remove the accept.

test/tools/yaml2obj/shf-compressed.yaml

1–2 ↗

(On Diff #117467)

I didn't go that fancy, but I did add verification that the obj2yaml output includes the flag.

[davide]

lgtm, thanks Shoaib.

lib/ObjectYAML/ELFYAML.cpp

#define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
   BCase(SHF_EXECINSTR);
   BCase(SHF_MERGE);
   BCase(SHF_STRINGS);
   BCase(SHF_INFO_LINK);
   BCase(SHF_LINK_ORDER);
   BCase(SHF_OS_NONCONFORMING);
   BCase(SHF_GROUP);
   BCase(SHF_TLS);
+  BCase(SHF_COMPRESSED);
   switch (Object->Header.Machine) {
   case ELF::EM_ARM:
     BCase(SHF_ARM_PURECODE);
     break;
   case ELF::EM_HEXAGON:
     BCase(SHF_HEX_GPREL);
     break;
   case ELF::EM_MIPS:

test/ObjectYAML/ELF/shf-compressed.yaml

+# RUN: yaml2obj %s -o %t
+# RUN: llvm-readobj -sections %t | FileCheck -check-prefix=OBJ %s
+# RUN: obj2yaml %t | FileCheck -check-prefix=YAML %s
+
+--- !ELF
+FileHeader:
+  Class:           ELFCLASS32
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_386
+Sections:
+  - Name:            .debug_line
+    Type:            SHT_PROGBITS
+    Flags:           [ SHF_COMPRESSED ]
+
+# OBJ:      Sections [
+# OBJ:        Section {
+# OBJ:          Index: 1
+# OBJ-NEXT:     Name: .debug_line (1)
+# OBJ-NEXT:     Type: SHT_PROGBITS (0x1)
+# OBJ-NEXT:     Flags [ (0x800)
+# OBJ-NEXT:       SHF_COMPRESSED (0x800)
+# OBJ-NEXT:     ]
+
+# YAML:      Sections:
+# YAML-NEXT:   - Name:            .debug_line
+# YAML-NEXT:     Type:            SHT_PROGBITS
+# YAML-NEXT:     Flags:           [ SHF_COMPRESSED ]