1 //===-- PPCELFObjectWriter.cpp - PPC ELF Writer ---------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "MCTargetDesc/PPCFixupKinds.h" 10 #include "MCTargetDesc/PPCMCExpr.h" 11 #include "MCTargetDesc/PPCMCTargetDesc.h" 12 #include "llvm/ADT/STLExtras.h" 13 #include "llvm/MC/MCELFObjectWriter.h" 14 #include "llvm/MC/MCExpr.h" 15 #include "llvm/MC/MCObjectWriter.h" 16 #include "llvm/MC/MCSymbolELF.h" 17 #include "llvm/MC/MCValue.h" 18 #include "llvm/Support/ErrorHandling.h" 19 20 using namespace llvm; 21 22 namespace { 23 class PPCELFObjectWriter : public MCELFObjectTargetWriter { 24 public: 25 PPCELFObjectWriter(bool Is64Bit, uint8_t OSABI); 26 27 protected: 28 unsigned getRelocType(MCContext &Ctx, const MCValue &Target, 29 const MCFixup &Fixup, bool IsPCRel) const override; 30 31 bool needsRelocateWithSymbol(const MCSymbol &Sym, 32 unsigned Type) const override; 33 }; 34 } 35 36 PPCELFObjectWriter::PPCELFObjectWriter(bool Is64Bit, uint8_t OSABI) 37 : MCELFObjectTargetWriter(Is64Bit, OSABI, 38 Is64Bit ? ELF::EM_PPC64 : ELF::EM_PPC, 39 /*HasRelocationAddend*/ true) {} 40 41 static MCSymbolRefExpr::VariantKind getAccessVariant(const MCValue &Target, 42 const MCFixup &Fixup) { 43 const MCExpr *Expr = Fixup.getValue(); 44 45 if (Expr->getKind() != MCExpr::Target) 46 return Target.getAccessVariant(); 47 48 switch (cast<PPCMCExpr>(Expr)->getKind()) { 49 case PPCMCExpr::VK_PPC_None: 50 return MCSymbolRefExpr::VK_None; 51 case PPCMCExpr::VK_PPC_LO: 52 return MCSymbolRefExpr::VK_PPC_LO; 53 case PPCMCExpr::VK_PPC_HI: 54 return MCSymbolRefExpr::VK_PPC_HI; 55 case PPCMCExpr::VK_PPC_HA: 56 return MCSymbolRefExpr::VK_PPC_HA; 57 case PPCMCExpr::VK_PPC_HIGH: 58 return MCSymbolRefExpr::VK_PPC_HIGH; 59 case PPCMCExpr::VK_PPC_HIGHA: 60 return MCSymbolRefExpr::VK_PPC_HIGHA; 61 case PPCMCExpr::VK_PPC_HIGHERA: 62 return MCSymbolRefExpr::VK_PPC_HIGHERA; 63 case PPCMCExpr::VK_PPC_HIGHER: 64 return MCSymbolRefExpr::VK_PPC_HIGHER; 65 case PPCMCExpr::VK_PPC_HIGHEST: 66 return MCSymbolRefExpr::VK_PPC_HIGHEST; 67 case PPCMCExpr::VK_PPC_HIGHESTA: 68 return MCSymbolRefExpr::VK_PPC_HIGHESTA; 69 } 70 llvm_unreachable("unknown PPCMCExpr kind"); 71 } 72 73 unsigned PPCELFObjectWriter::getRelocType(MCContext &Ctx, const MCValue &Target, 74 const MCFixup &Fixup, 75 bool IsPCRel) const { 76 MCFixupKind Kind = Fixup.getKind(); 77 if (Kind >= FirstLiteralRelocationKind) 78 return Kind - FirstLiteralRelocationKind; 79 MCSymbolRefExpr::VariantKind Modifier = getAccessVariant(Target, Fixup); 80 81 // determine the type of the relocation 82 unsigned Type; 83 if (IsPCRel) { 84 switch (Fixup.getTargetKind()) { 85 default: 86 llvm_unreachable("Unimplemented"); 87 case PPC::fixup_ppc_br24: 88 case PPC::fixup_ppc_br24abs: 89 case PPC::fixup_ppc_br24_notoc: 90 switch (Modifier) { 91 default: llvm_unreachable("Unsupported Modifier"); 92 case MCSymbolRefExpr::VK_None: 93 Type = ELF::R_PPC_REL24; 94 break; 95 case MCSymbolRefExpr::VK_PLT: 96 Type = ELF::R_PPC_PLTREL24; 97 break; 98 case MCSymbolRefExpr::VK_PPC_LOCAL: 99 Type = ELF::R_PPC_LOCAL24PC; 100 break; 101 case MCSymbolRefExpr::VK_PPC_NOTOC: 102 Type = ELF::R_PPC64_REL24_NOTOC; 103 break; 104 } 105 break; 106 case PPC::fixup_ppc_brcond14: 107 case PPC::fixup_ppc_brcond14abs: 108 Type = ELF::R_PPC_REL14; 109 break; 110 case PPC::fixup_ppc_half16: 111 switch (Modifier) { 112 default: llvm_unreachable("Unsupported Modifier"); 113 case MCSymbolRefExpr::VK_None: 114 Type = ELF::R_PPC_REL16; 115 break; 116 case MCSymbolRefExpr::VK_PPC_LO: 117 Type = ELF::R_PPC_REL16_LO; 118 break; 119 case MCSymbolRefExpr::VK_PPC_HI: 120 Type = ELF::R_PPC_REL16_HI; 121 break; 122 case MCSymbolRefExpr::VK_PPC_HA: 123 Type = ELF::R_PPC_REL16_HA; 124 break; 125 } 126 break; 127 case PPC::fixup_ppc_half16ds: 128 Target.print(errs()); 129 errs() << '\n'; 130 report_fatal_error("Invalid PC-relative half16ds relocation"); 131 case PPC::fixup_ppc_pcrel34: 132 switch (Modifier) { 133 default: 134 llvm_unreachable("Unsupported Modifier for fixup_ppc_pcrel34"); 135 case MCSymbolRefExpr::VK_PCREL: 136 Type = ELF::R_PPC64_PCREL34; 137 break; 138 case MCSymbolRefExpr::VK_PPC_GOT_PCREL: 139 Type = ELF::R_PPC64_GOT_PCREL34; 140 break; 141 case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_PCREL: 142 Type = ELF::R_PPC64_GOT_TLSGD_PCREL34; 143 break; 144 } 145 break; 146 case FK_Data_4: 147 case FK_PCRel_4: 148 Type = ELF::R_PPC_REL32; 149 break; 150 case FK_Data_8: 151 case FK_PCRel_8: 152 Type = ELF::R_PPC64_REL64; 153 break; 154 } 155 } else { 156 switch (Fixup.getTargetKind()) { 157 default: llvm_unreachable("invalid fixup kind!"); 158 case PPC::fixup_ppc_br24abs: 159 Type = ELF::R_PPC_ADDR24; 160 break; 161 case PPC::fixup_ppc_brcond14abs: 162 Type = ELF::R_PPC_ADDR14; // XXX: or BRNTAKEN?_ 163 break; 164 case PPC::fixup_ppc_half16: 165 switch (Modifier) { 166 default: llvm_unreachable("Unsupported Modifier"); 167 case MCSymbolRefExpr::VK_None: 168 Type = ELF::R_PPC_ADDR16; 169 break; 170 case MCSymbolRefExpr::VK_PPC_LO: 171 Type = ELF::R_PPC_ADDR16_LO; 172 break; 173 case MCSymbolRefExpr::VK_PPC_HI: 174 Type = ELF::R_PPC_ADDR16_HI; 175 break; 176 case MCSymbolRefExpr::VK_PPC_HA: 177 Type = ELF::R_PPC_ADDR16_HA; 178 break; 179 case MCSymbolRefExpr::VK_PPC_HIGH: 180 Type = ELF::R_PPC64_ADDR16_HIGH; 181 break; 182 case MCSymbolRefExpr::VK_PPC_HIGHA: 183 Type = ELF::R_PPC64_ADDR16_HIGHA; 184 break; 185 case MCSymbolRefExpr::VK_PPC_HIGHER: 186 Type = ELF::R_PPC64_ADDR16_HIGHER; 187 break; 188 case MCSymbolRefExpr::VK_PPC_HIGHERA: 189 Type = ELF::R_PPC64_ADDR16_HIGHERA; 190 break; 191 case MCSymbolRefExpr::VK_PPC_HIGHEST: 192 Type = ELF::R_PPC64_ADDR16_HIGHEST; 193 break; 194 case MCSymbolRefExpr::VK_PPC_HIGHESTA: 195 Type = ELF::R_PPC64_ADDR16_HIGHESTA; 196 break; 197 case MCSymbolRefExpr::VK_GOT: 198 Type = ELF::R_PPC_GOT16; 199 break; 200 case MCSymbolRefExpr::VK_PPC_GOT_LO: 201 Type = ELF::R_PPC_GOT16_LO; 202 break; 203 case MCSymbolRefExpr::VK_PPC_GOT_HI: 204 Type = ELF::R_PPC_GOT16_HI; 205 break; 206 case MCSymbolRefExpr::VK_PPC_GOT_HA: 207 Type = ELF::R_PPC_GOT16_HA; 208 break; 209 case MCSymbolRefExpr::VK_PPC_TOC: 210 Type = ELF::R_PPC64_TOC16; 211 break; 212 case MCSymbolRefExpr::VK_PPC_TOC_LO: 213 Type = ELF::R_PPC64_TOC16_LO; 214 break; 215 case MCSymbolRefExpr::VK_PPC_TOC_HI: 216 Type = ELF::R_PPC64_TOC16_HI; 217 break; 218 case MCSymbolRefExpr::VK_PPC_TOC_HA: 219 Type = ELF::R_PPC64_TOC16_HA; 220 break; 221 case MCSymbolRefExpr::VK_TPREL: 222 Type = ELF::R_PPC_TPREL16; 223 break; 224 case MCSymbolRefExpr::VK_PPC_TPREL_LO: 225 Type = ELF::R_PPC_TPREL16_LO; 226 break; 227 case MCSymbolRefExpr::VK_PPC_TPREL_HI: 228 Type = ELF::R_PPC_TPREL16_HI; 229 break; 230 case MCSymbolRefExpr::VK_PPC_TPREL_HA: 231 Type = ELF::R_PPC_TPREL16_HA; 232 break; 233 case MCSymbolRefExpr::VK_PPC_TPREL_HIGH: 234 Type = ELF::R_PPC64_TPREL16_HIGH; 235 break; 236 case MCSymbolRefExpr::VK_PPC_TPREL_HIGHA: 237 Type = ELF::R_PPC64_TPREL16_HIGHA; 238 break; 239 case MCSymbolRefExpr::VK_PPC_TPREL_HIGHER: 240 Type = ELF::R_PPC64_TPREL16_HIGHER; 241 break; 242 case MCSymbolRefExpr::VK_PPC_TPREL_HIGHERA: 243 Type = ELF::R_PPC64_TPREL16_HIGHERA; 244 break; 245 case MCSymbolRefExpr::VK_PPC_TPREL_HIGHEST: 246 Type = ELF::R_PPC64_TPREL16_HIGHEST; 247 break; 248 case MCSymbolRefExpr::VK_PPC_TPREL_HIGHESTA: 249 Type = ELF::R_PPC64_TPREL16_HIGHESTA; 250 break; 251 case MCSymbolRefExpr::VK_DTPREL: 252 Type = ELF::R_PPC64_DTPREL16; 253 break; 254 case MCSymbolRefExpr::VK_PPC_DTPREL_LO: 255 Type = ELF::R_PPC64_DTPREL16_LO; 256 break; 257 case MCSymbolRefExpr::VK_PPC_DTPREL_HI: 258 Type = ELF::R_PPC64_DTPREL16_HI; 259 break; 260 case MCSymbolRefExpr::VK_PPC_DTPREL_HA: 261 Type = ELF::R_PPC64_DTPREL16_HA; 262 break; 263 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGH: 264 Type = ELF::R_PPC64_DTPREL16_HIGH; 265 break; 266 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHA: 267 Type = ELF::R_PPC64_DTPREL16_HIGHA; 268 break; 269 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHER: 270 Type = ELF::R_PPC64_DTPREL16_HIGHER; 271 break; 272 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHERA: 273 Type = ELF::R_PPC64_DTPREL16_HIGHERA; 274 break; 275 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHEST: 276 Type = ELF::R_PPC64_DTPREL16_HIGHEST; 277 break; 278 case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHESTA: 279 Type = ELF::R_PPC64_DTPREL16_HIGHESTA; 280 break; 281 case MCSymbolRefExpr::VK_PPC_GOT_TLSGD: 282 if (is64Bit()) 283 Type = ELF::R_PPC64_GOT_TLSGD16; 284 else 285 Type = ELF::R_PPC_GOT_TLSGD16; 286 break; 287 case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_LO: 288 Type = ELF::R_PPC64_GOT_TLSGD16_LO; 289 break; 290 case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_HI: 291 Type = ELF::R_PPC64_GOT_TLSGD16_HI; 292 break; 293 case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_HA: 294 Type = ELF::R_PPC64_GOT_TLSGD16_HA; 295 break; 296 case MCSymbolRefExpr::VK_PPC_GOT_TLSLD: 297 if (is64Bit()) 298 Type = ELF::R_PPC64_GOT_TLSLD16; 299 else 300 Type = ELF::R_PPC_GOT_TLSLD16; 301 break; 302 case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_LO: 303 Type = ELF::R_PPC64_GOT_TLSLD16_LO; 304 break; 305 case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_HI: 306 Type = ELF::R_PPC64_GOT_TLSLD16_HI; 307 break; 308 case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_HA: 309 Type = ELF::R_PPC64_GOT_TLSLD16_HA; 310 break; 311 case MCSymbolRefExpr::VK_PPC_GOT_TPREL: 312 /* We don't have R_PPC64_GOT_TPREL16, but since GOT offsets 313 are always 4-aligned, we can use R_PPC64_GOT_TPREL16_DS. */ 314 Type = ELF::R_PPC64_GOT_TPREL16_DS; 315 break; 316 case MCSymbolRefExpr::VK_PPC_GOT_TPREL_LO: 317 /* We don't have R_PPC64_GOT_TPREL16_LO, but since GOT offsets 318 are always 4-aligned, we can use R_PPC64_GOT_TPREL16_LO_DS. */ 319 Type = ELF::R_PPC64_GOT_TPREL16_LO_DS; 320 break; 321 case MCSymbolRefExpr::VK_PPC_GOT_TPREL_HI: 322 Type = ELF::R_PPC64_GOT_TPREL16_HI; 323 break; 324 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL: 325 /* We don't have R_PPC64_GOT_DTPREL16, but since GOT offsets 326 are always 4-aligned, we can use R_PPC64_GOT_DTPREL16_DS. */ 327 Type = ELF::R_PPC64_GOT_DTPREL16_DS; 328 break; 329 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_LO: 330 /* We don't have R_PPC64_GOT_DTPREL16_LO, but since GOT offsets 331 are always 4-aligned, we can use R_PPC64_GOT_DTPREL16_LO_DS. */ 332 Type = ELF::R_PPC64_GOT_DTPREL16_LO_DS; 333 break; 334 case MCSymbolRefExpr::VK_PPC_GOT_TPREL_HA: 335 Type = ELF::R_PPC64_GOT_TPREL16_HA; 336 break; 337 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_HI: 338 Type = ELF::R_PPC64_GOT_DTPREL16_HI; 339 break; 340 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_HA: 341 Type = ELF::R_PPC64_GOT_DTPREL16_HA; 342 break; 343 } 344 break; 345 case PPC::fixup_ppc_half16ds: 346 switch (Modifier) { 347 default: llvm_unreachable("Unsupported Modifier"); 348 case MCSymbolRefExpr::VK_None: 349 Type = ELF::R_PPC64_ADDR16_DS; 350 break; 351 case MCSymbolRefExpr::VK_PPC_LO: 352 Type = ELF::R_PPC64_ADDR16_LO_DS; 353 break; 354 case MCSymbolRefExpr::VK_GOT: 355 Type = ELF::R_PPC64_GOT16_DS; 356 break; 357 case MCSymbolRefExpr::VK_PPC_GOT_LO: 358 Type = ELF::R_PPC64_GOT16_LO_DS; 359 break; 360 case MCSymbolRefExpr::VK_PPC_TOC: 361 Type = ELF::R_PPC64_TOC16_DS; 362 break; 363 case MCSymbolRefExpr::VK_PPC_TOC_LO: 364 Type = ELF::R_PPC64_TOC16_LO_DS; 365 break; 366 case MCSymbolRefExpr::VK_TPREL: 367 Type = ELF::R_PPC64_TPREL16_DS; 368 break; 369 case MCSymbolRefExpr::VK_PPC_TPREL_LO: 370 Type = ELF::R_PPC64_TPREL16_LO_DS; 371 break; 372 case MCSymbolRefExpr::VK_DTPREL: 373 Type = ELF::R_PPC64_DTPREL16_DS; 374 break; 375 case MCSymbolRefExpr::VK_PPC_DTPREL_LO: 376 Type = ELF::R_PPC64_DTPREL16_LO_DS; 377 break; 378 case MCSymbolRefExpr::VK_PPC_GOT_TPREL: 379 Type = ELF::R_PPC64_GOT_TPREL16_DS; 380 break; 381 case MCSymbolRefExpr::VK_PPC_GOT_TPREL_LO: 382 Type = ELF::R_PPC64_GOT_TPREL16_LO_DS; 383 break; 384 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL: 385 Type = ELF::R_PPC64_GOT_DTPREL16_DS; 386 break; 387 case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_LO: 388 Type = ELF::R_PPC64_GOT_DTPREL16_LO_DS; 389 break; 390 } 391 break; 392 case PPC::fixup_ppc_nofixup: 393 switch (Modifier) { 394 default: llvm_unreachable("Unsupported Modifier"); 395 case MCSymbolRefExpr::VK_PPC_TLSGD: 396 if (is64Bit()) 397 Type = ELF::R_PPC64_TLSGD; 398 else 399 Type = ELF::R_PPC_TLSGD; 400 break; 401 case MCSymbolRefExpr::VK_PPC_TLSLD: 402 if (is64Bit()) 403 Type = ELF::R_PPC64_TLSLD; 404 else 405 Type = ELF::R_PPC_TLSLD; 406 break; 407 case MCSymbolRefExpr::VK_PPC_TLS: 408 if (is64Bit()) 409 Type = ELF::R_PPC64_TLS; 410 else 411 Type = ELF::R_PPC_TLS; 412 break; 413 } 414 break; 415 case PPC::fixup_ppc_imm34: 416 report_fatal_error("Unsupported Modifier for fixup_ppc_imm34."); 417 break; 418 case FK_Data_8: 419 switch (Modifier) { 420 default: llvm_unreachable("Unsupported Modifier"); 421 case MCSymbolRefExpr::VK_PPC_TOCBASE: 422 Type = ELF::R_PPC64_TOC; 423 break; 424 case MCSymbolRefExpr::VK_None: 425 Type = ELF::R_PPC64_ADDR64; 426 break; 427 case MCSymbolRefExpr::VK_PPC_DTPMOD: 428 Type = ELF::R_PPC64_DTPMOD64; 429 break; 430 case MCSymbolRefExpr::VK_TPREL: 431 Type = ELF::R_PPC64_TPREL64; 432 break; 433 case MCSymbolRefExpr::VK_DTPREL: 434 Type = ELF::R_PPC64_DTPREL64; 435 break; 436 } 437 break; 438 case FK_Data_4: 439 Type = ELF::R_PPC_ADDR32; 440 break; 441 case FK_Data_2: 442 Type = ELF::R_PPC_ADDR16; 443 break; 444 } 445 } 446 return Type; 447 } 448 449 bool PPCELFObjectWriter::needsRelocateWithSymbol(const MCSymbol &Sym, 450 unsigned Type) const { 451 switch (Type) { 452 default: 453 return false; 454 455 case ELF::R_PPC_REL24: 456 case ELF::R_PPC64_REL24_NOTOC: 457 // If the target symbol has a local entry point, we must keep the 458 // target symbol to preserve that information for the linker. 459 // The "other" values are stored in the last 6 bits of the second byte. 460 // The traditional defines for STO values assume the full byte and thus 461 // the shift to pack it. 462 unsigned Other = cast<MCSymbolELF>(Sym).getOther() << 2; 463 return (Other & ELF::STO_PPC64_LOCAL_MASK) != 0; 464 } 465 } 466 467 std::unique_ptr<MCObjectTargetWriter> 468 llvm::createPPCELFObjectWriter(bool Is64Bit, uint8_t OSABI) { 469 return std::make_unique<PPCELFObjectWriter>(Is64Bit, OSABI); 470 } 471