llvm/test/tools/llvm-readobj/ELF/bb-addr-map.test

   1 ## This test checks how we handle the --bb-addr-map option.
   2
   3 ## Fails on windows (https://github.com/llvm/llvm-project/issues/60013).
   4 # UNSUPPORTED: system-windows
   5
   6 ## Check 64-bit:
   7 # RUN: yaml2obj --docnum=1 %s -DBITS=64 -DADDR=0x999999999 -o %t1.x64.o
   8 # RUN: llvm-readobj %t1.x64.o --bb-addr-map 2>&1 | FileCheck %s -DADDR=0x999999999 -DFILE=%t1.x64.o --check-prefix=CHECK
   9 # RUN: llvm-readelf %t1.x64.o --bb-addr-map | FileCheck %s --check-prefix=GNU
  10
  11 ## Check 64-bit:
  12 # RUN: yaml2obj --docnum=1 %s -DBITS=64 -DADDR=0x999999999 -o %t1.v1.x64.o
  13 # RUN: llvm-readobj %t1.v1.x64.o --bb-addr-map 2>&1 | FileCheck %s -DADDR=0x999999999 -DFILE=%t1.v1.x64.o --check-prefix=CHECK
  14
  15 ## Check 32-bit:
  16 # RUN: yaml2obj --docnum=1 %s -DBITS=32 -o %t1.x32.o
  17 # RUN: llvm-readobj %t1.x32.o --bb-addr-map 2>&1 | FileCheck -DADDR=0x11111 %s -DFILE=%t1.x32.o --check-prefix=CHECK
  18 # RUN: llvm-readelf %t1.x32.o --bb-addr-map | FileCheck %s --check-prefix=GNU
  19
  20 ## Check that a malformed section can be handled.
  21 # RUN: yaml2obj --docnum=1 %s -DBITS=32 -DSIZE=6 -o %t2.o
  22 # RUN: llvm-readobj %t2.o --bb-addr-map 2>&1 | FileCheck %s -DOFFSET=0x00000006 -DFILE=%t2.o --check-prefix=TRUNCATED
  23
  24 ## Check that invalid metadata can be handled.
  25 # RUN: yaml2obj --docnum=1 %s -DBITS=32 -DMETADATA=0xF000002 -o %t3.o
  26 # RUN: llvm-readobj %t3.o --bb-addr-map 2>&1 | FileCheck %s -DFILE=%t3.o --check-prefix=INVALIDMD
  27
  28 # CHECK:      BBAddrMap [
  29 # CHECK-NEXT:   Function {
  30 # CHECK-NEXT:     At: [[ADDR]]
  31 # CHECK-NEXT: warning: '[[FILE]]': could not identify function symbol for address ([[ADDR]]) in SHT_LLVM_BB_ADDR_MAP section with index 3
  32 # CHECK-NEXT:     Name: <?>
  33 # CHECK-NEXT:     BB entries [
  34 # CHECK-NEXT:       {
  35 # CHECK-NEXT:         ID: 0
  36 # CHECK-NEXT:         Offset: 0x0
  37 # CHECK-NEXT:         Size: 0x1
  38 # CHECK-NEXT:         HasReturn: No
  39 # CHECK-NEXT:         HasTailCall: Yes
  40 # CHECK-NEXT:         IsEHPad: No
  41 # CHECK-NEXT:         CanFallThrough: No
  42 # CHECK-NEXT:         HasIndirectBranch: No
  43 # CHECK-NEXT:       }
  44 # CHECK-NEXT:       {
  45 # CHECK-NEXT:         ID: 2
  46 # CHECK-NEXT:         Offset: 0x4
  47 # CHECK-NEXT:         Size: 0x4
  48 # CHECK-NEXT:         HasReturn: Yes
  49 # CHECK-NEXT:         HasTailCall: No
  50 # CHECK-NEXT:         IsEHPad: Yes
  51 # CHECK-NEXT:         CanFallThrough: No
  52 # CHECK-NEXT:         HasIndirectBranch: Yes
  53 # CHECK-NEXT:       }
  54 # CHECK-NEXT:     ]
  55 # CHECK-NEXT:   }
  56 # CHECK-NEXT:   Function {
  57 # CHECK-NEXT:     At: 0x22222
  58 # CHECK-NEXT:     Name: foo
  59 # CHECK-NEXT:     BB entries [
  60 # CHECK-NEXT:       {
  61 # CHECK-NEXT:         ID: 4
  62 # CHECK-NEXT:         Offset: 0x6
  63 # CHECK-NEXT:         Size: 0x7
  64 # CHECK-NEXT:         HasReturn: No
  65 # CHECK-NEXT:         HasTailCall: No
  66 # CHECK-NEXT:         IsEHPad: No
  67 # CHECK-NEXT:         CanFallThrough: Yes
  68 # CHECK-NEXT:         HasIndirectBranch: No
  69 # CHECK-NEXT:       }
  70 # CHECK-NEXT:     ]
  71 # CHECK-NEXT:   }
  72 # CHECK-NEXT: ]
  73
  74 # GNU: GNUStyle::printBBAddrMaps not implemented
  75
  76 # TRUNCATED:      BBAddrMap [
  77 # TRUNCATED-NEXT:   warning: '[[FILE]]': unable to dump SHT_LLVM_BB_ADDR_MAP section with index 3: unable to decode LEB128 at offset [[OFFSET]]: malformed uleb128, extends past end
  78 # TRUNCATED-NEXT: ]
  79 ## Check that the other valid section is properly dumped.
  80 # TRUNCATED-NEXT: BBAddrMap [
  81 # TRUNCATED-NEXT:   Function {
  82 # TRUNCATED-NEXT:     At: 0x33333
  83 # TRUNCATED-NEXT:     Name: bar
  84 # TRUNCATED-NEXT:     BB entries [
  85 # TRUNCATED-NEXT:       {
  86 # TRUNCATED-NEXT:         ID: 6
  87 # TRUNCATED-NEXT:         Offset: 0x9
  88 # TRUNCATED-NEXT:         Size: 0xA
  89 # TRUNCATED-NEXT:         HasReturn: Yes
  90 # TRUNCATED-NEXT:         HasTailCall: Yes
  91 # TRUNCATED-NEXT:         IsEHPad: No
  92 # TRUNCATED-NEXT:         CanFallThrough: Yes
  93 # TRUNCATED-NEXT:         HasIndirectBranch: Yes
  94 # TRUNCATED-NEXT:       }
  95 # TRUNCATED-NEXT:       {
  96 # TRUNCATED-NEXT:         ID: 7
  97 # TRUNCATED-NEXT:         Offset: 0x1F
  98 # TRUNCATED-NEXT:         Size: 0xD
  99 # TRUNCATED-NEXT:         HasReturn: No
 100 # TRUNCATED-NEXT:         HasTailCall: Yes
 101 # TRUNCATED-NEXT:         IsEHPad: Yes
 102 # TRUNCATED-NEXT:         CanFallThrough: Yes
 103 # TRUNCATED-NEXT:         HasIndirectBranch: No
 104 # TRUNCATED-NEXT:       }
 105 # TRUNCATED-NEXT:     ]
 106 # TRUNCATED-NEXT:   }
 107 # TRUNCATED-NEXT: ]
 108
 109 # INVALIDMD:      BBAddrMap [
 110 # INVALIDMD-NEXT:   warning: '[[FILE]]': unable to dump SHT_LLVM_BB_ADDR_MAP section with index 3: invalid encoding for BBEntry::Metadata: 0xf000002
 111
 112 --- !ELF
 113 FileHeader:
 114   Class: ELFCLASS[[BITS]]
 115   Data:  ELFDATA2LSB
 116   Type:  ET_EXEC
 117 Sections:
 118   - Name:   .text
 119     Type:   SHT_PROGBITS
 120     Flags:  [SHF_ALLOC]
 121   - Name:   .text.bar
 122     Type:   SHT_PROGBITS
 123     Flags:  [SHF_ALLOC]
 124   - Name:   .llvm_bb_addr_map
 125     Type:   SHT_LLVM_BB_ADDR_MAP
 126     ShSize: [[SIZE=<none>]]
 127     Link:   .text
 128     Entries:
 129       - Version: 2
 130         Address: [[ADDR=0x11111]]
 131         BBEntries:
 132           - ID:            0
 133             AddressOffset: 0x0
 134             Size:          0x1
 135             Metadata:      [[METADATA=0x2]]
 136           - ID:            2
 137             AddressOffset: 0x3
 138             Size:          0x4
 139             Metadata:      0x15
 140       - Version: 2
 141         Address: 0x22222
 142         BBEntries:
 143           - ID:            4
 144             AddressOffset: 0x6
 145             Size:          0x7
 146             Metadata:      0x8
 147   - Name: dummy_section
 148     Type: SHT_PROGBITS
 149     Size: 16
 150   - Name: '.llvm_bb_addr_map (1)'
 151     Type: SHT_LLVM_BB_ADDR_MAP
 152     Link: .text.bar
 153     Entries:
 154       - Version: 2
 155         Address: 0x33333
 156         BBEntries:
 157           - ID:            6
 158             AddressOffset: 0x9
 159             Size:          0xa
 160             Metadata:      0x1b
 161           - ID:            7
 162             AddressOffset: 0xc
 163             Size:          0xd
 164             Metadata:      0xe
 165 Symbols:
 166   - Name:    foo
 167     Section: .text
 168     Type:    STT_FUNC
 169     Value:   0x22222
 170   - Name:    bar
 171     Section: .text.bar
 172     Type:    STT_FUNC
 173     Value:   0x33333
 174
 175 ## Check that using the SHT_LLVM_BB_ADDR_MAP_V0 section type generates the same
 176 ## result as using the SHT_LLVM_BB_ADDR_MAP section type with Version=0.
 177 ## The Version field is required even for SHT_LLVM_BB_ADDR_MAP_V0 but it
 178 ## should not impact the result. This unideal behavior will be gone once
 179 ## SHT_LLVM_BB_ADDR_MAP_V0 is deprecated.
 180
 181 # RUN: yaml2obj --docnum=2 %s -DVERSION=255 -DSECTION_TYPE=SHT_LLVM_BB_ADDR_MAP_V0 -o %t2.type0
 182 # RUN: llvm-readobj %t2.type0 --bb-addr-map 2>&1 | FileCheck %s --check-prefix=V0
 183
 184 # RUN: yaml2obj --docnum=2 %s -DVERSION=0 -DSECTION_TYPE=SHT_LLVM_BB_ADDR_MAP -o %t2.version0
 185 # RUN: llvm-readobj %t2.version0 --bb-addr-map 2>&1 | FileCheck %s --check-prefix=V0
 186
 187 # V0:      BBAddrMap [
 188 # V0-NEXT:   Function {
 189 # V0-NEXT:     At:   0x11111
 190 # V0-NEXT:     Name: foo
 191 # V0-NEXT:     BB entries [
 192 # V0-NEXT:       {
 193 # V0-NEXT:         ID: 0
 194 # V0-NEXT:         Offset: 0x1
 195 # V0-NEXT:         Size: 0x2
 196 # V0-NEXT:         HasReturn:
 197 # V0-NEXT:         HasTailCall:
 198 # V0-NEXT:         IsEHPad:
 199 # V0-NEXT:         CanFallThrough:
 200 # V0-NEXT:         HasIndirectBranch:
 201 # V0-NEXT:       }
 202 # V0-NEXT:       {
 203 # V0-NEXT:         ID: 1
 204 # V0-NEXT:         Offset: 0x4
 205 # V0-NEXT:         Size: 0x5
 206 # V0-NEXT:         HasReturn:
 207 # V0-NEXT:         HasTailCall:
 208 # V0-NEXT:         IsEHPad:
 209 # V0-NEXT:         CanFallThrough:
 210 # V0-NEXT:         HasIndirectBranch:
 211 # V0-NEXT:       }
 212 # V0-NEXT:     ]
 213 # V0-NEXT:   }
 214
 215 ## Check version 1 (without BB IDs).
 216 # RUN: yaml2obj --docnum=2 %s -DVERSION=1 -DSECTION_TYPE=SHT_LLVM_BB_ADDR_MAP -o %t3
 217 # RUN: llvm-readobj %t3 --bb-addr-map 2>&1 | FileCheck %s --check-prefix=V1
 218
 219 # V1:      BBAddrMap [
 220 # V1-NEXT:   Function {
 221 # V1-NEXT:     At:   0x11111
 222 # V1-NEXT:     Name: foo
 223 # V1-NEXT:     BB entries [
 224 # V1-NEXT:       {
 225 # V1-NEXT:         ID: 0
 226 # V1-NEXT:         Offset: 0x1
 227 # V1-NEXT:         Size: 0x2
 228 # V1-NEXT:         HasReturn:
 229 # V1-NEXT:         HasTailCall:
 230 # V1-NEXT:         IsEHPad:
 231 # V1-NEXT:         CanFallThrough:
 232 # V1-NEXT:         HasIndirectBranch:
 233 # V1-NEXT:       }
 234 # V1-NEXT:       {
 235 # V1-NEXT:         ID: 1
 236 # V1-NEXT:         Offset: 0x7
 237 # V1-NEXT:         Size: 0x5
 238 # V1-NEXT:         HasReturn:
 239 # V1-NEXT:         HasTailCall:
 240 # V1-NEXT:         IsEHPad:
 241 # V1-NEXT:         CanFallThrough:
 242 # V1-NEXT:         HasIndirectBranch:
 243 # V1-NEXT:       }
 244 # V1-NEXT:     ]
 245 # V1-NEXT:   }
 246
 247 --- !ELF
 248 FileHeader:
 249   Class: ELFCLASS64
 250   Data:  ELFDATA2LSB
 251   Type:  ET_EXEC
 252 Sections:
 253   - Name:  .text.foo
 254     Type:  SHT_PROGBITS
 255     Flags: [SHF_ALLOC]
 256   - Name:  .llvm_bb_addr_map
 257     Type:  [[SECTION_TYPE]]
 258     Link:  .text.foo
 259     Entries:
 260       - Version: [[VERSION]]
 261         Address: 0x11111
 262         BBEntries:
 263           - AddressOffset: 0x1
 264             Size:          0x2
 265             Metadata:      0x3
 266           - AddressOffset: 0x4
 267             Size:          0x5
 268             Metadata:      0x6
 269 Symbols:
 270   - Name:    foo
 271     Section: .text.foo
 272     Type:    STT_FUNC
 273     Value:   0x11111