[DWARFYAML] Make the include_directories, file_names and opcodes fields of the line table optional.

[Higuoxing]

Summary

This patch makes the include_directories, file_names and opcodes fields
of the line table optional. This helps us simplify some tests.

[jhenderson]

I might be missing it, but do you have direct testing showing that the default for IncludeDirs\Files\Opcodes is an empty output, when the output is written? I think it's important that this is tested.

[Higuoxing]

In D87878#2281189, @jhenderson wrote:

I might be missing it, but do you have direct testing showing that the default for IncludeDirs\Files\Opcodes is an empty output, when the output is written? I think it's important that this is tested.

Sorry, I didn't test it.

Add test case (k) in llvm/test/tools/yaml2obj/ELF/DWARF/debug-line.yaml.

[jhenderson]

LGTM!

lldb/unittests/Symbol/Inputs/inlined-functions.yaml

- Length:          202
       PrologueLength:  45
       MinInstLength:   1
       MaxOpsPerInst:   1
       DefaultIsStmt:   1
       LineBase:        251
       LineRange:       14
       OpcodeBase:      13
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-      IncludeDirs:     []
       Files:           
         - Name:            inlined-functions.cpp
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:         
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

llvm/lib/ObjectYAML/DWARFYAML.cpp

void MappingTraits<DWARFYAML::LineTable>::mapping(
   IO.mapRequired("MinInstLength", LineTable.MinInstLength);
   if(LineTable.Version >= 4)
     IO.mapRequired("MaxOpsPerInst", LineTable.MaxOpsPerInst);
   IO.mapRequired("DefaultIsStmt", LineTable.DefaultIsStmt);
   IO.mapRequired("LineBase", LineTable.LineBase);
   IO.mapRequired("LineRange", LineTable.LineRange);
   IO.mapRequired("OpcodeBase", LineTable.OpcodeBase);
   IO.mapRequired("StandardOpcodeLengths", LineTable.StandardOpcodeLengths);
-  IO.mapRequired("IncludeDirs", LineTable.IncludeDirs);
-  IO.mapRequired("Files", LineTable.Files);
-  IO.mapRequired("Opcodes", LineTable.Opcodes);
+  IO.mapOptional("IncludeDirs", LineTable.IncludeDirs);
+  IO.mapOptional("Files", LineTable.Files);
+  IO.mapOptional("Opcodes", LineTable.Opcodes);
 }
 
 void MappingTraits<DWARFYAML::SegAddrPair>::mapping(
     IO &IO, DWARFYAML::SegAddrPair &SegAddrPair) {
   IO.mapOptional("Segment", SegAddrPair.Segment, 0);
   IO.mapOptional("Address", SegAddrPair.Address, 0);
 }
 

llvm/test/ObjectYAML/MachO/DWARF-debug_info.yaml

- Length:          65
         - 1
         - 0
         - 0
         - 0
         - 1
         - 0
         - 0
         - 1
-      IncludeDirs:     
       Files:           
         - Name:            hello_world.c
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:         
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

llvm/test/ObjectYAML/MachO/DWARF-debug_line.yaml

- Length:          65
       Version:         2
       PrologueLength:  36
       MinInstLength:   1
       DefaultIsStmt:   1
       LineBase:        251
       LineRange:       14
       OpcodeBase:      13
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-      IncludeDirs:     
       Files:           
         - Name:            hello_world.c
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:         
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

 # CHECK-NEXT:     Version:         2
 # CHECK-NEXT:     PrologueLength:  36
 # CHECK-NEXT:     MinInstLength:   1
 # CHECK-NEXT:     DefaultIsStmt:   1
 # CHECK-NEXT:     LineBase:        251
 # CHECK-NEXT:     LineRange:       14
 # CHECK-NEXT:     OpcodeBase:      13
 # CHECK-NEXT:     StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-# CHECK-NEXT:     IncludeDirs:
 # CHECK-NEXT:     Files:
 # CHECK-NEXT:       - Name:            hello_world.c
 # CHECK-NEXT:         DirIdx:          0
 # CHECK-NEXT:         ModTime:         0
 # CHECK-NEXT:         Length:          0
 # CHECK-NEXT:     Opcodes:
 # CHECK-NEXT:       - Opcode:          DW_LNS_extended_op
 # CHECK-NEXT:         ExtLen:          9

llvm/test/ObjectYAML/MachO/DWARF5-debug_info.yaml

- Length:          65
         - 1
         - 0
         - 0
         - 0
         - 1
         - 0
         - 0
         - 1
-      IncludeDirs:     
       Files:           
         - Name:            hello_world.c
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:         
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

llvm/test/tools/llvm-dwarfdump/X86/verify_attr_file_indexes.yaml

- Length:          40
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
       IncludeDirs:
         - '/tmp'
       Files:
         - Name:            main.c
           DirIdx:          1
           ModTime:         0
           Length:          0
-      Opcodes:         []
 ...

llvm/test/tools/llvm-dwarfdump/X86/verify_attr_file_indexes_no_files.yaml

- Length:          30
       MinInstLength:   1
       DefaultIsStmt:   1
       LineBase:        251
       LineRange:       14
       OpcodeBase:      13
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
       IncludeDirs:
         - '/tmp'
-      Files:
-      Opcodes:         []
 ...

llvm/test/tools/llvm-gsymutil/ARM_AArch64/fat-macho-dwarf.yaml

DWARF:
           PrologueLength:  32
           MinInstLength:   1
           MaxOpsPerInst:   1
           DefaultIsStmt:   1
           LineBase:        251
           LineRange:       14
           OpcodeBase:      13
           StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-          IncludeDirs:     []
           Files:
             - Name:            main.cpp
               DirIdx:          0
               ModTime:         0
               Length:          0
           Opcodes:
             - Opcode:          DW_LNS_extended_op
               ExtLen:          5
DWARF:
           PrologueLength:  32
           MinInstLength:   1
           MaxOpsPerInst:   1
           DefaultIsStmt:   1
           LineBase:        251
           LineRange:       14
           OpcodeBase:      13
           StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-          IncludeDirs:     []
           Files:
             - Name:            main.cpp
               DirIdx:          0
               ModTime:         0
               Length:          0
           Opcodes:
             - Opcode:          DW_LNS_extended_op
               ExtLen:          9

llvm/test/tools/llvm-gsymutil/X86/mach-dwarf.yaml

- Length:          102
       PrologueLength:  32
       MinInstLength:   1
       MaxOpsPerInst:   1
       DefaultIsStmt:   1
       LineBase:        251
       LineRange:       14
       OpcodeBase:      13
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-      IncludeDirs:     []
       Files:
         - Name:            main.cpp
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

llvm/test/tools/llvm-objcopy/MachO/Inputs/strip-all-with-dwarf.yaml

- Length:          74
       PrologueLength:  36
       MinInstLength:   1
       MaxOpsPerInst:   1
       DefaultIsStmt:   1
       LineBase:        251
       LineRange:       14
       OpcodeBase:      13
       StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
-      IncludeDirs:     []
       Files:
         - Name:            strip-test.c
           DirIdx:          0
           ModTime:         0
           Length:          0
       Opcodes:
         - Opcode:          DW_LNS_extended_op
           ExtLen:          9

llvm/test/tools/yaml2obj/ELF/DWARF/debug-line.yaml

- Length:         0x70
         - Name:    "a.c"
           DirIdx:  1
           ModTime: 2
           Length:  3
         - Name:    "b.c"
           DirIdx:  2
           ModTime: 3
           Length:  4
-      Opcodes: []
 
 ## Generate and verify a big endian DWARF32 .debug_line section.
 
 # RUN: yaml2obj --docnum=1 -DENDIAN=ELFDATA2MSB %s -o %t1.be.o
 # RUN: llvm-readobj --sections --section-data %t1.be.o | \
 # RUN:   FileCheck %s -DSIZE=50 -DADDRALIGN=1 --check-prefixes=SHDR,DWARF-BE-CONTENT
 
 # DWARF-BE-CONTENT-NEXT: SectionData (
- Length:                0x70
       Version:               2
       PrologueLength:        50
       MinInstLength:         1
       DefaultIsStmt:         1
       LineBase:              1
       LineRange:             14
       OpcodeBase:            13
       StandardOpcodeLengths: []
-      IncludeDirs:           []
-      Files:                 []
-      Opcodes:               []
 
 ## e) Test that yaml2obj emits an error message when both the "Content" and the
 ## "debug_line" entry are specified at the same time.
 
 # RUN: not yaml2obj --docnum=5 %s 2>&1 | FileCheck %s --check-prefix=ERROR
 
 --- !ELF
 FileHeader:
- Length:                0x70
       Version:               2
       PrologueLength:        50
       MinInstLength:         1
       DefaultIsStmt:         1
       LineBase:              1
       LineRange:             14
       OpcodeBase:            13
       StandardOpcodeLengths: []
-      IncludeDirs:           []
-      Files:                 []
-      Opcodes:               []
 
 ## f) Test that all the properties can be overridden by the section header when
 ## the "debug_line" entry doesn't exist.
 
 # RUN: yaml2obj --docnum=6 %s -o %t6.o
 # RUN: llvm-readelf --sections %t6.o | FileCheck %s --check-prefix=OVERRIDDEN
 
 #      OVERRIDDEN: [Nr] Name        Type   Address          Off    Size   ES Flg Lk Inf Al
- Length:                0x70
       Version:               2
       PrologueLength:        50
       MinInstLength:         1
       DefaultIsStmt:         1
       LineBase:              1
       LineRange:             14
       OpcodeBase:            13
       StandardOpcodeLengths: []
-      IncludeDirs:           []
-      Files:                 []
-      Opcodes:               []
 
 ## h) Test that the address size is inferred from the target machine.
 
 # RUN: yaml2obj --docnum=8 -DBITS=64 -DADDR=0x1234567890abcdef %s -o %t8.64-bit.o
 # RUN: llvm-readelf --hex-dump=.debug_line %t8.64-bit.o | \
 # RUN:   FileCheck %s --check-prefix=ADDRSIZE -DADDR="efcdab90 78563412"
 
 #      ADDRSIZE: Hex dump of section '.debug_line':
- Length:                0x1234
       Version:               2
       PrologueLength:        0x1234
       MinInstLength:         1
       DefaultIsStmt:         1
       LineBase:              1
       LineRange:             14
       OpcodeBase:            13
       StandardOpcodeLengths: []
-      IncludeDirs:           []
-      Files:                 []
       Opcodes:
         - Opcode:    DW_LNS_extended_op
           ExtLen:    9
           SubOpcode: DW_LNE_set_address
           Data:      [[ADDR]]
 
 ## i) Test that yaml2obj is able to emit correct opcodes.
 
- Length:                0x1234
       PrologueLength:        0x1234
       MinInstLength:         1
       MaxOpsPerInst:         1
       DefaultIsStmt:         1
       LineBase:              1
       LineRange:             14
       OpcodeBase:            13
       StandardOpcodeLengths: []
-      IncludeDirs:           []
-      Files:                 []
       Opcodes:
         - Opcode:    DW_LNS_copy
         - Opcode:    DW_LNS_advance_pc
           Data:      0x1234
         - Opcode:    DW_LNS_advance_line
           SData:     0x1234
         - Opcode:    DW_LNS_set_file
           Data:      0x1234
- Format:                DWARF64
         - Name:    c.c
           DirIdx:  1
           ModTime: 0
           Length:  0
       Opcodes:
         - Opcode:    DW_LNS_extended_op
           ExtLen:    1
           SubOpcode: DW_LNE_end_sequence
+
+## k) Test that we can omit the include_directories, file_names and opcodes
+## fields of the line table.
+
+# RUN: yaml2obj --docnum=11 %s -o %t11.o
+# RUN: llvm-readelf --hex-dump=.debug_line %t11.o | \
+# RUN:   FileCheck %s --check-prefix=OMIT-FIELDS
+
+#      OMIT-FIELDS: Hex dump of section '.debug_line':
+# OMIT-FIELDS-NEXT: 0x00000000 11000000 04000b00 00000101 01fb0e04 ................
+##                             ^-------                            unit_length (4-byte)
+##                                      ^---                       version (2-byte)
+##                                          ^--------              header_length (4-byte)
+##                                                   ^-            minimum_instruction_length (1-byte)
+##                                                     ^-          maximum_operations_per_instruction (1-byte)
+##                                                        ^-       default_is_stmt (1-byte)
+##                                                          ^-     line_base (1-byte) -5
+##                                                            ^-   line_range (1-byte)
+##                                                              ^- opcode_base (1-byte)
+# OMIT-FIELDS-NEXT: 0x00000010 00010100 00                         .....
+##                             ^-----                              standard_opcode_lengths (3-byte)
+##                                   ^-                            include_directories null byte (1-byte)
+##                                      ^-                         file_names null byte (1-byte)
+
+--- !ELF
+FileHeader:
+  Class: ELFCLASS64
+  Data:  ELFDATA2LSB
+  Type:  ET_EXEC
+DWARF:
+  debug_line:
+    - Version:               4
+      MinInstLength:         1
+      MaxOpsPerInst:         1
+      DefaultIsStmt:         1
+      LineBase:              251
+      LineRange:             14
+      OpcodeBase:            4
+      StandardOpcodeLengths: [ 0, 1, 1 ]