DirectXShaderCompiler/lib/Object/COFFObjectFile.cpp at main · microsoft/DirectXShaderCompiler · GitHub

History

1415 lines (1235 loc) · 48.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

//===- COFFObjectFile.cpp - COFF object file implementation -----*- C++ -*-===//

// The LLVM Compiler Infrastructure

// This file is distributed under the University of Illinois Open Source

// License. See LICENSE.TXT for details.

//===----------------------------------------------------------------------===//

// This file declares the COFFObjectFile class.

//===----------------------------------------------------------------------===//

#include "llvm/Object/COFF.h"

#include "llvm/ADT/ArrayRef.h"

#include "llvm/ADT/SmallString.h"

#include "llvm/ADT/StringSwitch.h"

#include "llvm/ADT/Triple.h"

#include "llvm/ADT/iterator_range.h"

#include "llvm/Support/COFF.h"

#include "llvm/Support/Debug.h"

#include "llvm/Support/raw_ostream.h"

#include <cctype>

#include <limits>

using namespace llvm;

using namespace object;

using support::ulittle16_t;

using support::ulittle32_t;

using support::ulittle64_t;

using support::little16_t;

// Returns false if size is greater than the buffer size. And sets ec.

static bool checkSize(MemoryBufferRef M, std::error_code &EC, uint64_t Size) {

if (M.getBufferSize() < Size) {

EC = object_error::unexpected_eof;

return false;

}

return true;

}

static std::error_code checkOffset(MemoryBufferRef M, uintptr_t Addr,

const uint64_t Size) {

if (Addr + Size < Addr || Addr + Size < Size ||

Addr + Size > uintptr_t(M.getBufferEnd()) ||

Addr < uintptr_t(M.getBufferStart())) {

return object_error::unexpected_eof;

}

return std::error_code();

}

// Sets Obj unless any bytes in [addr, addr + size) fall outsize of m.

// Returns unexpected_eof if error.

template <typename T>

static std::error_code getObject(const T *&Obj, MemoryBufferRef M,

const void *Ptr,

const uint64_t Size = sizeof(T)) {

uintptr_t Addr = uintptr_t(Ptr);

if (std::error_code EC = checkOffset(M, Addr, Size))

return EC;

Obj = reinterpret_cast<const T *>(Addr);

return std::error_code();

}

// Decode a string table entry in base 64 (//AAAAAA). Expects \arg Str without

// prefixed slashes.

static bool decodeBase64StringEntry(StringRef Str, uint32_t &Result) {

assert(Str.size() <= 6 && "String too long, possible overflow.");

if (Str.size() > 6)

return true;

uint64_t Value = 0;

while (!Str.empty()) {

unsigned CharVal;

if (Str[0] >= 'A' && Str[0] <= 'Z') // 0..25

CharVal = Str[0] - 'A';

else if (Str[0] >= 'a' && Str[0] <= 'z') // 26..51

CharVal = Str[0] - 'a' + 26;

else if (Str[0] >= '0' && Str[0] <= '9') // 52..61

CharVal = Str[0] - '0' + 52;

else if (Str[0] == '+') // 62

CharVal = 62;

else if (Str[0] == '/') // 63

CharVal = 63;

else

return true;

Value = (Value * 64) + CharVal;

Str = Str.substr(1);

}

if (Value > std::numeric_limits<uint32_t>::max())

return true;

Result = static_cast<uint32_t>(Value);

return false;

}

template <typename coff_symbol_type>

const coff_symbol_type *COFFObjectFile::toSymb(DataRefImpl Ref) const {

const coff_symbol_type *Addr =

reinterpret_cast<const coff_symbol_type *>(Ref.p);

assert(!checkOffset(Data, uintptr_t(Addr), sizeof(*Addr)));

#ifndef NDEBUG

// Verify that the symbol points to a valid entry in the symbol table.

uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base());

assert((Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 &&

"Symbol did not point to the beginning of a symbol");

#endif

return Addr;

}

const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const {

const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p);

# ifndef NDEBUG

// Verify that the section points to a valid entry in the section table.

if (Addr < SectionTable || Addr >= (SectionTable + getNumberOfSections()))

report_fatal_error("Section was outside of section table.");

uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable);

assert(Offset % sizeof(coff_section) == 0 &&

"Section did not point to the beginning of a section");

# endif

return Addr;

}

void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const {

auto End = reinterpret_cast<uintptr_t>(StringTable);

if (SymbolTable16) {

const coff_symbol16 *Symb = toSymb<coff_symbol16>(Ref);

Symb += 1 + Symb->NumberOfAuxSymbols;

Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);

} else if (SymbolTable32) {

const coff_symbol32 *Symb = toSymb<coff_symbol32>(Ref);

Symb += 1 + Symb->NumberOfAuxSymbols;

Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);

} else {

llvm_unreachable("no symbol table pointer!");

}

ErrorOr<StringRef> COFFObjectFile::getSymbolName(DataRefImpl Ref) const {

COFFSymbolRef Symb = getCOFFSymbol(Ref);

StringRef Result;

std::error_code EC = getSymbolName(Symb, Result);

if (EC)

return EC;

return Result;

}

uint64_t COFFObjectFile::getSymbolValueImpl(DataRefImpl Ref) const {

return getCOFFSymbol(Ref).getValue();

}

ErrorOr<uint64_t> COFFObjectFile::getSymbolAddress(DataRefImpl Ref) const {

uint64_t Result = getSymbolValue(Ref);

COFFSymbolRef Symb = getCOFFSymbol(Ref);

int32_t SectionNumber = Symb.getSectionNumber();

if (Symb.isAnyUndefined() || Symb.isCommon() ||

COFF::isReservedSectionNumber(SectionNumber))

return Result;

const coff_section *Section = nullptr;

if (std::error_code EC = getSection(SectionNumber, Section))

return EC;

Result += Section->VirtualAddress;

return Result;

}

SymbolRef::Type COFFObjectFile::getSymbolType(DataRefImpl Ref) const {

COFFSymbolRef Symb = getCOFFSymbol(Ref);

int32_t SectionNumber = Symb.getSectionNumber();

if (Symb.isAnyUndefined())

return SymbolRef::ST_Unknown;

if (Symb.isFunctionDefinition())

return SymbolRef::ST_Function;

if (Symb.isCommon())

return SymbolRef::ST_Data;

if (Symb.isFileRecord())

return SymbolRef::ST_File;

// TODO: perhaps we need a new symbol type ST_Section.

if (SectionNumber == COFF::IMAGE_SYM_DEBUG || Symb.isSectionDefinition())

return SymbolRef::ST_Debug;

if (!COFF::isReservedSectionNumber(SectionNumber))

return SymbolRef::ST_Data;

return SymbolRef::ST_Other;

}

uint32_t COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const {

COFFSymbolRef Symb = getCOFFSymbol(Ref);

uint32_t Result = SymbolRef::SF_None;

if (Symb.isExternal() || Symb.isWeakExternal())

Result |= SymbolRef::SF_Global;

if (Symb.isWeakExternal())

Result |= SymbolRef::SF_Weak;

if (Symb.getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE)

Result |= SymbolRef::SF_Absolute;

if (Symb.isFileRecord())

Result |= SymbolRef::SF_FormatSpecific;

if (Symb.isSectionDefinition())

Result |= SymbolRef::SF_FormatSpecific;

if (Symb.isCommon())

Result |= SymbolRef::SF_Common;

if (Symb.isAnyUndefined())

Result |= SymbolRef::SF_Undefined;

return Result;

}

uint64_t COFFObjectFile::getCommonSymbolSizeImpl(DataRefImpl Ref) const {

COFFSymbolRef Symb = getCOFFSymbol(Ref);

return Symb.getValue();

}

std::error_code

COFFObjectFile::getSymbolSection(DataRefImpl Ref,

section_iterator &Result) const {

COFFSymbolRef Symb = getCOFFSymbol(Ref);

if (COFF::isReservedSectionNumber(Symb.getSectionNumber())) {

Result = section_end();

} else {

const coff_section *Sec = nullptr;

if (std::error_code EC = getSection(Symb.getSectionNumber(), Sec))

return EC;

DataRefImpl Ref;

Ref.p = reinterpret_cast<uintptr_t>(Sec);

Result = section_iterator(SectionRef(Ref, this));

}

return std::error_code();

}

unsigned COFFObjectFile::getSymbolSectionID(SymbolRef Sym) const {

COFFSymbolRef Symb = getCOFFSymbol(Sym.getRawDataRefImpl());

return Symb.getSectionNumber();

}

void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const {

const coff_section *Sec = toSec(Ref);

Sec += 1;

Ref.p = reinterpret_cast<uintptr_t>(Sec);

}

std::error_code COFFObjectFile::getSectionName(DataRefImpl Ref,

StringRef &Result) const {

const coff_section *Sec = toSec(Ref);

return getSectionName(Sec, Result);

}

uint64_t COFFObjectFile::getSectionAddress(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

return Sec->VirtualAddress;

}

uint64_t COFFObjectFile::getSectionSize(DataRefImpl Ref) const {

return getSectionSize(toSec(Ref));

}

std::error_code COFFObjectFile::getSectionContents(DataRefImpl Ref,

StringRef &Result) const {

const coff_section *Sec = toSec(Ref);

ArrayRef<uint8_t> Res;

std::error_code EC = getSectionContents(Sec, Res);

Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());

return EC;

}

uint64_t COFFObjectFile::getSectionAlignment(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

return uint64_t(1) << (((Sec->Characteristics & 0x00F00000) >> 20) - 1);

}

bool COFFObjectFile::isSectionText(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

return Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;

}

bool COFFObjectFile::isSectionData(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

return Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;

}

bool COFFObjectFile::isSectionBSS(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

const uint32_t BssFlags = COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA |

COFF::IMAGE_SCN_MEM_READ |

COFF::IMAGE_SCN_MEM_WRITE;

return (Sec->Characteristics & BssFlags) == BssFlags;

}

unsigned COFFObjectFile::getSectionID(SectionRef Sec) const {

uintptr_t Offset =

uintptr_t(Sec.getRawDataRefImpl().p) - uintptr_t(SectionTable);

assert((Offset % sizeof(coff_section)) == 0);

return (Offset / sizeof(coff_section)) + 1;

}

bool COFFObjectFile::isSectionVirtual(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

// In COFF, a virtual section won't have any in-file

// content, so the file pointer to the content will be zero.

return Sec->PointerToRawData == 0;

}

static uint32_t getNumberOfRelocations(const coff_section *Sec,

MemoryBufferRef M, const uint8_t *base) {

// The field for the number of relocations in COFF section table is only

// 16-bit wide. If a section has more than 65535 relocations, 0xFFFF is set to

// NumberOfRelocations field, and the actual relocation count is stored in the

// VirtualAddress field in the first relocation entry.

if (Sec->hasExtendedRelocations()) {

const coff_relocation *FirstReloc;

if (getObject(FirstReloc, M, reinterpret_cast<const coff_relocation*>(

base + Sec->PointerToRelocations)))

return 0;

// -1 to exclude this first relocation entry.

return FirstReloc->VirtualAddress - 1;

}

return Sec->NumberOfRelocations;

}

static const coff_relocation *

getFirstReloc(const coff_section *Sec, MemoryBufferRef M, const uint8_t *Base) {

uint64_t NumRelocs = getNumberOfRelocations(Sec, M, Base);

if (!NumRelocs)

return nullptr;

auto begin = reinterpret_cast<const coff_relocation *>(

Base + Sec->PointerToRelocations);

if (Sec->hasExtendedRelocations()) {

// Skip the first relocation entry repurposed to store the number of

// relocations.

begin++;

}

if (checkOffset(M, uintptr_t(begin), sizeof(coff_relocation) * NumRelocs))

return nullptr;

return begin;

}

relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

const coff_relocation *begin = getFirstReloc(Sec, Data, base());

if (begin && Sec->VirtualAddress != 0)

report_fatal_error("Sections with relocations should have an address of 0");

DataRefImpl Ret;

Ret.p = reinterpret_cast<uintptr_t>(begin);

return relocation_iterator(RelocationRef(Ret, this));

}

relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const {

const coff_section *Sec = toSec(Ref);

const coff_relocation *I = getFirstReloc(Sec, Data, base());

if (I)

I += getNumberOfRelocations(Sec, Data, base());

DataRefImpl Ret;

Ret.p = reinterpret_cast<uintptr_t>(I);

return relocation_iterator(RelocationRef(Ret, this));

}

// Initialize the pointer to the symbol table.

std::error_code COFFObjectFile::initSymbolTablePtr() {

if (COFFHeader)

if (std::error_code EC = getObject(

SymbolTable16, Data, base() + getPointerToSymbolTable(),

(uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))

return EC;

if (COFFBigObjHeader)

if (std::error_code EC = getObject(

SymbolTable32, Data, base() + getPointerToSymbolTable(),

(uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))

return EC;

// Find string table. The first four byte of the string table contains the

// total size of the string table, including the size field itself. If the

// string table is empty, the value of the first four byte would be 4.

uint32_t StringTableOffset = getPointerToSymbolTable() +

getNumberOfSymbols() * getSymbolTableEntrySize();

const uint8_t *StringTableAddr = base() + StringTableOffset;

const ulittle32_t *StringTableSizePtr;

if (std::error_code EC = getObject(StringTableSizePtr, Data, StringTableAddr))

return EC;

StringTableSize = *StringTableSizePtr;

if (std::error_code EC =

getObject(StringTable, Data, StringTableAddr, StringTableSize))

return EC;

// Treat table sizes < 4 as empty because contrary to the PECOFF spec, some

// tools like cvtres write a size of 0 for an empty table instead of 4.

if (StringTableSize < 4)

StringTableSize = 4;

// Check that the string table is null terminated if has any in it.

if (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)

return object_error::parse_failed;

return std::error_code();

}

// Returns the file offset for the given VA.

std::error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const {

uint64_t ImageBase = PE32Header ? (uint64_t)PE32Header->ImageBase

: (uint64_t)PE32PlusHeader->ImageBase;

uint64_t Rva = Addr - ImageBase;

assert(Rva <= UINT32_MAX);

return getRvaPtr((uint32_t)Rva, Res);

}

// Returns the file offset for the given RVA.

std::error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const {

for (const SectionRef &S : sections()) {

const coff_section *Section = getCOFFSection(S);

uint32_t SectionStart = Section->VirtualAddress;

uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize;

if (SectionStart <= Addr && Addr < SectionEnd) {

uint32_t Offset = Addr - SectionStart;

Res = uintptr_t(base()) + Section->PointerToRawData + Offset;

return std::error_code();

}

return object_error::parse_failed;

}

// Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name

// table entry.

std::error_code COFFObjectFile::getHintName(uint32_t Rva, uint16_t &Hint,

StringRef &Name) const {

uintptr_t IntPtr = 0;

if (std::error_code EC = getRvaPtr(Rva, IntPtr))

return EC;

const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr);

Hint = *reinterpret_cast<const ulittle16_t *>(Ptr);

Name = StringRef(reinterpret_cast<const char *>(Ptr + 2));

return std::error_code();

}

// Find the import table.

std::error_code COFFObjectFile::initImportTablePtr() {

// First, we get the RVA of the import table. If the file lacks a pointer to

// the import table, do nothing.

const data_directory *DataEntry;

if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry))

return std::error_code();

// Do nothing if the pointer to import table is NULL.

if (DataEntry->RelativeVirtualAddress == 0)

return std::error_code();

uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress;

// -1 because the last entry is the null entry.

NumberOfImportDirectory = DataEntry->Size /

sizeof(import_directory_table_entry) - 1;

// Find the section that contains the RVA. This is needed because the RVA is

// the import table's memory address which is different from its file offset.

uintptr_t IntPtr = 0;

if (std::error_code EC = getRvaPtr(ImportTableRva, IntPtr))

return EC;

ImportDirectory = reinterpret_cast<

const import_directory_table_entry *>(IntPtr);

return std::error_code();

}

// Initializes DelayImportDirectory and NumberOfDelayImportDirectory.

std::error_code COFFObjectFile::initDelayImportTablePtr() {

const data_directory *DataEntry;

if (getDataDirectory(COFF::DELAY_IMPORT_DESCRIPTOR, DataEntry))

return std::error_code();

if (DataEntry->RelativeVirtualAddress == 0)

return std::error_code();

uint32_t RVA = DataEntry->RelativeVirtualAddress;

NumberOfDelayImportDirectory = DataEntry->Size /

sizeof(delay_import_directory_table_entry) - 1;

uintptr_t IntPtr = 0;

if (std::error_code EC = getRvaPtr(RVA, IntPtr))

return EC;

DelayImportDirectory = reinterpret_cast<

const delay_import_directory_table_entry *>(IntPtr);

return std::error_code();

}

// Find the export table.

std::error_code COFFObjectFile::initExportTablePtr() {

// First, we get the RVA of the export table. If the file lacks a pointer to

// the export table, do nothing.

const data_directory *DataEntry;

if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry))

return std::error_code();

// Do nothing if the pointer to export table is NULL.

if (DataEntry->RelativeVirtualAddress == 0)

return std::error_code();

uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress;

uintptr_t IntPtr = 0;

if (std::error_code EC = getRvaPtr(ExportTableRva, IntPtr))

return EC;

ExportDirectory =

reinterpret_cast<const export_directory_table_entry *>(IntPtr);

return std::error_code();

}

std::error_code COFFObjectFile::initBaseRelocPtr() {

const data_directory *DataEntry;

if (getDataDirectory(COFF::BASE_RELOCATION_TABLE, DataEntry))

return std::error_code();

if (DataEntry->RelativeVirtualAddress == 0)

return std::error_code();

uintptr_t IntPtr = 0;

if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr))

return EC;

BaseRelocHeader = reinterpret_cast<const coff_base_reloc_block_header *>(

IntPtr);

BaseRelocEnd = reinterpret_cast<coff_base_reloc_block_header *>(

IntPtr + DataEntry->Size);

return std::error_code();

}

COFFObjectFile::COFFObjectFile(MemoryBufferRef Object, std::error_code &EC)

: ObjectFile(Binary::ID_COFF, Object), COFFHeader(nullptr),

COFFBigObjHeader(nullptr), PE32Header(nullptr), PE32PlusHeader(nullptr),

DataDirectory(nullptr), SectionTable(nullptr), SymbolTable16(nullptr),

SymbolTable32(nullptr), StringTable(nullptr), StringTableSize(0),

ImportDirectory(nullptr), NumberOfImportDirectory(0),

DelayImportDirectory(nullptr), NumberOfDelayImportDirectory(0),

ExportDirectory(nullptr), BaseRelocHeader(nullptr),

BaseRelocEnd(nullptr) {

// Check that we at least have enough room for a header.

if (!checkSize(Data, EC, sizeof(coff_file_header)))

return;

// The current location in the file where we are looking at.

uint64_t CurPtr = 0;

// PE header is optional and is present only in executables. If it exists,

// it is placed right after COFF header.

bool HasPEHeader = false;

// Check if this is a PE/COFF file.

if (checkSize(Data, EC, sizeof(dos_header) + sizeof(COFF::PEMagic))) {

// PE/COFF, seek through MS-DOS compatibility stub and 4-byte

// PE signature to find 'normal' COFF header.

const auto *DH = reinterpret_cast<const dos_header *>(base());

if (DH->Magic[0] == 'M' && DH->Magic[1] == 'Z') {

CurPtr = DH->AddressOfNewExeHeader;

// Check the PE magic bytes. ("PE\0\0")

if (memcmp(base() + CurPtr, COFF::PEMagic, sizeof(COFF::PEMagic)) != 0) {

EC = object_error::parse_failed;

return;

}

CurPtr += sizeof(COFF::PEMagic); // Skip the PE magic bytes.

HasPEHeader = true;

}

if ((EC = getObject(COFFHeader, Data, base() + CurPtr)))

return;

// It might be a bigobj file, let's check. Note that COFF bigobj and COFF

// import libraries share a common prefix but bigobj is more restrictive.

if (!HasPEHeader && COFFHeader->Machine == COFF::IMAGE_FILE_MACHINE_UNKNOWN &&

COFFHeader->NumberOfSections == uint16_t(0xffff) &&

checkSize(Data, EC, sizeof(coff_bigobj_file_header))) {

if ((EC = getObject(COFFBigObjHeader, Data, base() + CurPtr)))

return;

// Verify that we are dealing with bigobj.

if (COFFBigObjHeader->Version >= COFF::BigObjHeader::MinBigObjectVersion &&

std::memcmp(COFFBigObjHeader->UUID, COFF::BigObjMagic,

sizeof(COFF::BigObjMagic)) == 0) {

COFFHeader = nullptr;

CurPtr += sizeof(coff_bigobj_file_header);

} else {

// It's not a bigobj.

COFFBigObjHeader = nullptr;

}

if (COFFHeader) {

// The prior checkSize call may have failed. This isn't a hard error

// because we were just trying to sniff out bigobj.

EC = std::error_code();

CurPtr += sizeof(coff_file_header);

if (COFFHeader->isImportLibrary())

return;

}

if (HasPEHeader) {

const pe32_header *Header;

if ((EC = getObject(Header, Data, base() + CurPtr)))

return;

const uint8_t *DataDirAddr;

uint64_t DataDirSize;

if (Header->Magic == COFF::PE32Header::PE32) {

PE32Header = Header;

DataDirAddr = base() + CurPtr + sizeof(pe32_header);

DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;

} else if (Header->Magic == COFF::PE32Header::PE32_PLUS) {

PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header);

DataDirAddr = base() + CurPtr + sizeof(pe32plus_header);

DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize;

} else {

// It's neither PE32 nor PE32+.

EC = object_error::parse_failed;

return;

}

if ((EC = getObject(DataDirectory, Data, DataDirAddr, DataDirSize)))

return;

CurPtr += COFFHeader->SizeOfOptionalHeader;

}

if ((EC = getObject(SectionTable, Data, base() + CurPtr,

(uint64_t)getNumberOfSections() * sizeof(coff_section))))

return;

// Initialize the pointer to the symbol table.

if (getPointerToSymbolTable() != 0) {

if ((EC = initSymbolTablePtr()))

return;

} else {

// We had better not have any symbols if we don't have a symbol table.

if (getNumberOfSymbols() != 0) {

EC = object_error::parse_failed;

return;

}

// Initialize the pointer to the beginning of the import table.

if ((EC = initImportTablePtr()))

return;

if ((EC = initDelayImportTablePtr()))

return;

// Initialize the pointer to the export table.

if ((EC = initExportTablePtr()))

return;

// Initialize the pointer to the base relocation table.

if ((EC = initBaseRelocPtr()))

return;

EC = std::error_code();

}

basic_symbol_iterator COFFObjectFile::symbol_begin_impl() const {

DataRefImpl Ret;

Ret.p = getSymbolTable();

return basic_symbol_iterator(SymbolRef(Ret, this));

}

basic_symbol_iterator COFFObjectFile::symbol_end_impl() const {

// The symbol table ends where the string table begins.

DataRefImpl Ret;

Ret.p = reinterpret_cast<uintptr_t>(StringTable);

return basic_symbol_iterator(SymbolRef(Ret, this));

}

import_directory_iterator COFFObjectFile::import_directory_begin() const {

return import_directory_iterator(

ImportDirectoryEntryRef(ImportDirectory, 0, this));

}

import_directory_iterator COFFObjectFile::import_directory_end() const {

return import_directory_iterator(

ImportDirectoryEntryRef(ImportDirectory, NumberOfImportDirectory, this));

}

delay_import_directory_iterator

COFFObjectFile::delay_import_directory_begin() const {

return delay_import_directory_iterator(

DelayImportDirectoryEntryRef(DelayImportDirectory, 0, this));

}

delay_import_directory_iterator

COFFObjectFile::delay_import_directory_end() const {

return delay_import_directory_iterator(

DelayImportDirectoryEntryRef(

DelayImportDirectory, NumberOfDelayImportDirectory, this));

}

export_directory_iterator COFFObjectFile::export_directory_begin() const {

return export_directory_iterator(

ExportDirectoryEntryRef(ExportDirectory, 0, this));

}

export_directory_iterator COFFObjectFile::export_directory_end() const {

if (!ExportDirectory)

return export_directory_iterator(ExportDirectoryEntryRef(nullptr, 0, this));

ExportDirectoryEntryRef Ref(ExportDirectory,

ExportDirectory->AddressTableEntries, this);

return export_directory_iterator(Ref);

}

section_iterator COFFObjectFile::section_begin() const {

DataRefImpl Ret;

Ret.p = reinterpret_cast<uintptr_t>(SectionTable);

return section_iterator(SectionRef(Ret, this));

}

section_iterator COFFObjectFile::section_end() const {

DataRefImpl Ret;

int NumSections =

COFFHeader && COFFHeader->isImportLibrary() ? 0 : getNumberOfSections();

Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);

return section_iterator(SectionRef(Ret, this));

}

base_reloc_iterator COFFObjectFile::base_reloc_begin() const {

return base_reloc_iterator(BaseRelocRef(BaseRelocHeader, this));

}

base_reloc_iterator COFFObjectFile::base_reloc_end() const {

return base_reloc_iterator(BaseRelocRef(BaseRelocEnd, this));

}

uint8_t COFFObjectFile::getBytesInAddress() const {

return getArch() == Triple::x86_64 ? 8 : 4;

}

StringRef COFFObjectFile::getFileFormatName() const {

switch(getMachine()) {

case COFF::IMAGE_FILE_MACHINE_I386:

return "COFF-i386";

case COFF::IMAGE_FILE_MACHINE_AMD64:

return "COFF-x86-64";

case COFF::IMAGE_FILE_MACHINE_ARMNT:

return "COFF-ARM";

default:

return "COFF-<unknown arch>";

}

unsigned COFFObjectFile::getArch() const {

switch (getMachine()) {

case COFF::IMAGE_FILE_MACHINE_I386:

return Triple::x86;

case COFF::IMAGE_FILE_MACHINE_AMD64:

return Triple::x86_64;

case COFF::IMAGE_FILE_MACHINE_ARMNT:

return Triple::thumb;

default:

return Triple::UnknownArch;

}

iterator_range<import_directory_iterator>

COFFObjectFile::import_directories() const {

return make_range(import_directory_begin(), import_directory_end());

}

iterator_range<delay_import_directory_iterator>

COFFObjectFile::delay_import_directories() const {

return make_range(delay_import_directory_begin(),

delay_import_directory_end());

}

iterator_range<export_directory_iterator>

COFFObjectFile::export_directories() const {

return make_range(export_directory_begin(), export_directory_end());

}

iterator_range<base_reloc_iterator> COFFObjectFile::base_relocs() const {

return make_range(base_reloc_begin(), base_reloc_end());

}

std::error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {

Res = PE32Header;

return std::error_code();

}

std::error_code

COFFObjectFile::getPE32PlusHeader(const pe32plus_header *&Res) const {

Res = PE32PlusHeader;

return std::error_code();

}

std::error_code

COFFObjectFile::getDataDirectory(uint32_t Index,

const data_directory *&Res) const {

// Error if if there's no data directory or the index is out of range.

if (!DataDirectory) {

Res = nullptr;

return object_error::parse_failed;

}

assert(PE32Header || PE32PlusHeader);

uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize

: PE32PlusHeader->NumberOfRvaAndSize;

if (Index >= NumEnt) {

Res = nullptr;

return object_error::parse_failed;

}

Res = &DataDirectory[Index];

return std::error_code();

}

std::error_code COFFObjectFile::getSection(int32_t Index,

const coff_section *&Result) const {

Result = nullptr;

if (COFF::isReservedSectionNumber(Index))

return std::error_code();

if (static_cast<uint32_t>(Index) <= getNumberOfSections()) {

// We already verified the section table data, so no need to check again.

Result = SectionTable + (Index - 1);

return std::error_code();

}

return object_error::parse_failed;

}

std::error_code COFFObjectFile::getString(uint32_t Offset,

StringRef &Result) const {

if (StringTableSize <= 4)

// Tried to get a string from an empty string table.

return object_error::parse_failed;

if (Offset >= StringTableSize)

return object_error::unexpected_eof;

Result = StringRef(StringTable + Offset);

return std::error_code();

}

std::error_code COFFObjectFile::getSymbolName(COFFSymbolRef Symbol,

StringRef &Res) const {

return getSymbolName(Symbol.getGeneric(), Res);

}

std::error_code COFFObjectFile::getSymbolName(const coff_symbol_generic *Symbol,

StringRef &Res) const {

// Check for string table entry. First 4 bytes are 0.

if (Symbol->Name.Offset.Zeroes == 0) {

if (std::error_code EC = getString(Symbol->Name.Offset.Offset, Res))

return EC;

return std::error_code();

}

if (Symbol->Name.ShortName[COFF::NameSize - 1] == 0)

// Null terminated, let ::strlen figure out the length.

Res = StringRef(Symbol->Name.ShortName);

else

// Not null terminated, use all 8 bytes.

Res = StringRef(Symbol->Name.ShortName, COFF::NameSize);

return std::error_code();

}

ArrayRef<uint8_t>

COFFObjectFile::getSymbolAuxData(COFFSymbolRef Symbol) const {

const uint8_t *Aux = nullptr;

size_t SymbolSize = getSymbolTableEntrySize();

if (Symbol.getNumberOfAuxSymbols() > 0) {

// AUX data comes immediately after the symbol in COFF

Aux = reinterpret_cast<const uint8_t *>(Symbol.getRawPtr()) + SymbolSize;

# ifndef NDEBUG

// Verify that the Aux symbol points to a valid entry in the symbol table.

uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());

if (Offset < getPointerToSymbolTable() ||

Offset >=

getPointerToSymbolTable() + (getNumberOfSymbols() * SymbolSize))

report_fatal_error("Aux Symbol data was outside of symbol table.");

assert((Offset - getPointerToSymbolTable()) % SymbolSize == 0 &&

"Aux Symbol data did not point to the beginning of a symbol");

# endif

}

return makeArrayRef(Aux, Symbol.getNumberOfAuxSymbols() * SymbolSize);

}

std::error_code COFFObjectFile::getSectionName(const coff_section *Sec,

StringRef &Res) const {

StringRef Name;

if (Sec->Name[COFF::NameSize - 1] == 0)

// Null terminated, let ::strlen figure out the length.

Name = Sec->Name;

else

// Not null terminated, use all 8 bytes.

Name = StringRef(Sec->Name, COFF::NameSize);

// Check for string table entry. First byte is '/'.

if (Name.startswith("/")) {

uint32_t Offset;

if (Name.startswith("//")) {

if (decodeBase64StringEntry(Name.substr(2), Offset))

return object_error::parse_failed;

} else {

if (Name.substr(1).getAsInteger(10, Offset))

return object_error::parse_failed;

}

if (std::error_code EC = getString(Offset, Name))

return EC;

}

Res = Name;

return std::error_code();

}

uint64_t COFFObjectFile::getSectionSize(const coff_section *Sec) const {

// SizeOfRawData and VirtualSize change what they represent depending on

// whether or not we have an executable image.

// For object files, SizeOfRawData contains the size of section's data;

// VirtualSize should be zero but isn't due to buggy COFF writers.

// For executables, SizeOfRawData *must* be a multiple of FileAlignment; the

// actual section size is in VirtualSize. It is possible for VirtualSize to

// be greater than SizeOfRawData; the contents past that point should be

// considered to be zero.

if (getDOSHeader())

return std::min(Sec->VirtualSize, Sec->SizeOfRawData);

return Sec->SizeOfRawData;

}

std::error_code

COFFObjectFile::getSectionContents(const coff_section *Sec,

ArrayRef<uint8_t> &Res) const {

// PointerToRawData and SizeOfRawData won't make sense for BSS sections,

// don't do anything interesting for them.

assert((Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) == 0 &&

"BSS sections don't have contents!");

// The only thing that we need to verify is that the contents is contained

// within the file bounds. We don't need to make sure it doesn't cover other

// data, as there's nothing that says that is not allowed.

uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;

uint32_t SectionSize = getSectionSize(Sec);

if (checkOffset(Data, ConStart, SectionSize))

return object_error::parse_failed;

Res = makeArrayRef(reinterpret_cast<const uint8_t *>(ConStart), SectionSize);

return std::error_code();

}

const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {

return reinterpret_cast<const coff_relocation*>(Rel.p);

}

void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const {

Rel.p = reinterpret_cast<uintptr_t>(

reinterpret_cast<const coff_relocation*>(Rel.p) + 1);

}

uint64_t COFFObjectFile::getRelocationOffset(DataRefImpl Rel) const {

const coff_relocation *R = toRel(Rel);

return R->VirtualAddress;

}

symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {

const coff_relocation *R = toRel(Rel);

DataRefImpl Ref;

if (R->SymbolTableIndex >= getNumberOfSymbols())

return symbol_end();

if (SymbolTable16)

Ref.p = reinterpret_cast<uintptr_t>(SymbolTable16 + R->SymbolTableIndex);

else if (SymbolTable32)

Ref.p = reinterpret_cast<uintptr_t>(SymbolTable32 + R->SymbolTableIndex);

else

llvm_unreachable("no symbol table pointer!");

return symbol_iterator(SymbolRef(Ref, this));

}

uint64_t COFFObjectFile::getRelocationType(DataRefImpl Rel) const {

const coff_relocation* R = toRel(Rel);

return R->Type;

}

const coff_section *

COFFObjectFile::getCOFFSection(const SectionRef &Section) const {

return toSec(Section.getRawDataRefImpl());

}

COFFSymbolRef COFFObjectFile::getCOFFSymbol(const DataRefImpl &Ref) const {

if (SymbolTable16)

return toSymb<coff_symbol16>(Ref);

if (SymbolTable32)

return toSymb<coff_symbol32>(Ref);

llvm_unreachable("no symbol table pointer!");

}

COFFSymbolRef COFFObjectFile::getCOFFSymbol(const SymbolRef &Symbol) const {

return getCOFFSymbol(Symbol.getRawDataRefImpl());

}

const coff_relocation *

COFFObjectFile::getCOFFRelocation(const RelocationRef &Reloc) const {

return toRel(Reloc.getRawDataRefImpl());

}

View remainder of file in raw view

DirectXShaderCompiler/lib/Object/COFFObjectFile.cpp at main · microsoft/DirectXShaderCompiler · GitHub

Uh oh!

Expand file tree

Breadcrumbs

COFFObjectFile.cpp

Latest commit

History

Breadcrumbs

COFFObjectFile.cpp

File metadata and controls