xref: /freebsd-src/contrib/llvm-project/llvm/lib/MC/MCDXContainerWriter.cpp (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
181ad6265SDimitry Andric //===- llvm/MC/MCDXContainerWriter.cpp - DXContainer Writer -----*- C++ -*-===//
281ad6265SDimitry Andric //
381ad6265SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
481ad6265SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
581ad6265SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
681ad6265SDimitry Andric //
781ad6265SDimitry Andric //===----------------------------------------------------------------------===//
881ad6265SDimitry Andric 
981ad6265SDimitry Andric #include "llvm/MC/MCDXContainerWriter.h"
1081ad6265SDimitry Andric #include "llvm/BinaryFormat/DXContainer.h"
1181ad6265SDimitry Andric #include "llvm/MC/MCAssembler.h"
1281ad6265SDimitry Andric #include "llvm/MC/MCContext.h"
1381ad6265SDimitry Andric #include "llvm/MC/MCSection.h"
1481ad6265SDimitry Andric #include "llvm/MC/MCValue.h"
1581ad6265SDimitry Andric #include "llvm/Support/Alignment.h"
1681ad6265SDimitry Andric #include "llvm/Support/EndianStream.h"
1781ad6265SDimitry Andric 
1881ad6265SDimitry Andric using namespace llvm;
1981ad6265SDimitry Andric 
2081ad6265SDimitry Andric MCDXContainerTargetWriter::~MCDXContainerTargetWriter() {}
2181ad6265SDimitry Andric 
2281ad6265SDimitry Andric namespace {
2381ad6265SDimitry Andric class DXContainerObjectWriter : public MCObjectWriter {
2481ad6265SDimitry Andric   ::support::endian::Writer W;
2581ad6265SDimitry Andric 
2681ad6265SDimitry Andric   /// The target specific DXContainer writer instance.
2781ad6265SDimitry Andric   std::unique_ptr<MCDXContainerTargetWriter> TargetObjectWriter;
2881ad6265SDimitry Andric 
2981ad6265SDimitry Andric public:
3081ad6265SDimitry Andric   DXContainerObjectWriter(std::unique_ptr<MCDXContainerTargetWriter> MOTW,
3181ad6265SDimitry Andric                           raw_pwrite_stream &OS)
325f757f3fSDimitry Andric       : W(OS, llvm::endianness::little), TargetObjectWriter(std::move(MOTW)) {}
3381ad6265SDimitry Andric 
3481ad6265SDimitry Andric   ~DXContainerObjectWriter() override {}
3581ad6265SDimitry Andric 
3681ad6265SDimitry Andric private:
37*0fca6ea1SDimitry Andric   void recordRelocation(MCAssembler &Asm, const MCFragment *Fragment,
38*0fca6ea1SDimitry Andric                         const MCFixup &Fixup, MCValue Target,
39*0fca6ea1SDimitry Andric                         uint64_t &FixedValue) override {}
4081ad6265SDimitry Andric 
41*0fca6ea1SDimitry Andric   uint64_t writeObject(MCAssembler &Asm) override;
4281ad6265SDimitry Andric };
4381ad6265SDimitry Andric } // namespace
4481ad6265SDimitry Andric 
45*0fca6ea1SDimitry Andric uint64_t DXContainerObjectWriter::writeObject(MCAssembler &Asm) {
4681ad6265SDimitry Andric   // Start the file size as the header plus the size of the part offsets.
4781ad6265SDimitry Andric   // Presently DXContainer files usually contain 7-10 parts. Reserving space for
4881ad6265SDimitry Andric   // 16 part offsets gives us a little room for growth.
4981ad6265SDimitry Andric   llvm::SmallVector<uint64_t, 16> PartOffsets;
5081ad6265SDimitry Andric   uint64_t PartOffset = 0;
5181ad6265SDimitry Andric   for (const MCSection &Sec : Asm) {
52*0fca6ea1SDimitry Andric     uint64_t SectionSize = Asm.getSectionAddressSize(Sec);
5381ad6265SDimitry Andric     // Skip empty sections.
5481ad6265SDimitry Andric     if (SectionSize == 0)
5581ad6265SDimitry Andric       continue;
5681ad6265SDimitry Andric 
5781ad6265SDimitry Andric     assert(SectionSize < std::numeric_limits<uint32_t>::max() &&
5881ad6265SDimitry Andric            "Section size too large for DXContainer");
5981ad6265SDimitry Andric 
6081ad6265SDimitry Andric     PartOffsets.push_back(PartOffset);
6181ad6265SDimitry Andric     PartOffset += sizeof(dxbc::PartHeader) + SectionSize;
6281ad6265SDimitry Andric     PartOffset = alignTo(PartOffset, Align(4ul));
63bdd1243dSDimitry Andric     // The DXIL part also writes a program header, so we need to include its
64bdd1243dSDimitry Andric     // size when computing the offset for a part after the DXIL part.
65bdd1243dSDimitry Andric     if (Sec.getName() == "DXIL")
66bdd1243dSDimitry Andric       PartOffset += sizeof(dxbc::ProgramHeader);
6781ad6265SDimitry Andric   }
6881ad6265SDimitry Andric   assert(PartOffset < std::numeric_limits<uint32_t>::max() &&
6981ad6265SDimitry Andric          "Part data too large for DXContainer");
7081ad6265SDimitry Andric 
7181ad6265SDimitry Andric   uint64_t PartStart =
7281ad6265SDimitry Andric       sizeof(dxbc::Header) + (PartOffsets.size() * sizeof(uint32_t));
7381ad6265SDimitry Andric   uint64_t FileSize = PartStart + PartOffset;
7481ad6265SDimitry Andric   assert(FileSize < std::numeric_limits<uint32_t>::max() &&
7581ad6265SDimitry Andric          "File size too large for DXContainer");
7681ad6265SDimitry Andric 
7781ad6265SDimitry Andric   // Write the header.
7881ad6265SDimitry Andric   W.write<char>({'D', 'X', 'B', 'C'});
7981ad6265SDimitry Andric   // Write 16-bytes of 0's for the hash.
8081ad6265SDimitry Andric   W.OS.write_zeros(16);
8181ad6265SDimitry Andric   // Write 1.0 for file format version.
8281ad6265SDimitry Andric   W.write<uint16_t>(1u);
8381ad6265SDimitry Andric   W.write<uint16_t>(0u);
8481ad6265SDimitry Andric   // Write the file size.
8581ad6265SDimitry Andric   W.write<uint32_t>(static_cast<uint32_t>(FileSize));
8681ad6265SDimitry Andric   // Write the number of parts.
8781ad6265SDimitry Andric   W.write<uint32_t>(static_cast<uint32_t>(PartOffsets.size()));
8881ad6265SDimitry Andric   // Write the offsets for the part headers for each part.
8981ad6265SDimitry Andric   for (uint64_t Offset : PartOffsets)
9081ad6265SDimitry Andric     W.write<uint32_t>(static_cast<uint32_t>(PartStart + Offset));
9181ad6265SDimitry Andric 
9281ad6265SDimitry Andric   for (const MCSection &Sec : Asm) {
93*0fca6ea1SDimitry Andric     uint64_t SectionSize = Asm.getSectionAddressSize(Sec);
9481ad6265SDimitry Andric     // Skip empty sections.
9581ad6265SDimitry Andric     if (SectionSize == 0)
9681ad6265SDimitry Andric       continue;
9781ad6265SDimitry Andric 
9881ad6265SDimitry Andric     unsigned Start = W.OS.tell();
9981ad6265SDimitry Andric     // Write section header.
10081ad6265SDimitry Andric     W.write<char>(ArrayRef<char>(Sec.getName().data(), 4));
10181ad6265SDimitry Andric 
102bdd1243dSDimitry Andric     uint64_t PartSize = SectionSize;
10381ad6265SDimitry Andric 
10481ad6265SDimitry Andric     if (Sec.getName() == "DXIL")
10581ad6265SDimitry Andric       PartSize += sizeof(dxbc::ProgramHeader);
10681ad6265SDimitry Andric     // DXContainer parts should be 4-byte aligned.
10781ad6265SDimitry Andric     PartSize = alignTo(PartSize, Align(4));
10881ad6265SDimitry Andric     W.write<uint32_t>(static_cast<uint32_t>(PartSize));
10981ad6265SDimitry Andric     if (Sec.getName() == "DXIL") {
11081ad6265SDimitry Andric       dxbc::ProgramHeader Header;
11181ad6265SDimitry Andric       memset(reinterpret_cast<void *>(&Header), 0, sizeof(dxbc::ProgramHeader));
11281ad6265SDimitry Andric 
11381ad6265SDimitry Andric       const Triple &TT = Asm.getContext().getTargetTriple();
11481ad6265SDimitry Andric       VersionTuple Version = TT.getOSVersion();
115*0fca6ea1SDimitry Andric       uint8_t MajorVersion = static_cast<uint8_t>(Version.getMajor());
116*0fca6ea1SDimitry Andric       uint8_t MinorVersion =
117*0fca6ea1SDimitry Andric           static_cast<uint8_t>(Version.getMinor().value_or(0));
118*0fca6ea1SDimitry Andric       Header.Version =
119*0fca6ea1SDimitry Andric           dxbc::ProgramHeader::getVersion(MajorVersion, MinorVersion);
12081ad6265SDimitry Andric       if (TT.hasEnvironment())
12181ad6265SDimitry Andric         Header.ShaderKind =
12281ad6265SDimitry Andric             static_cast<uint16_t>(TT.getEnvironment() - Triple::Pixel);
12381ad6265SDimitry Andric 
12481ad6265SDimitry Andric       // The program header's size field is in 32-bit words.
12581ad6265SDimitry Andric       Header.Size = (SectionSize + sizeof(dxbc::ProgramHeader) + 3) / 4;
12681ad6265SDimitry Andric       memcpy(Header.Bitcode.Magic, "DXIL", 4);
127*0fca6ea1SDimitry Andric       VersionTuple DXILVersion = TT.getDXILVersion();
128*0fca6ea1SDimitry Andric       Header.Bitcode.MajorVersion = DXILVersion.getMajor();
129*0fca6ea1SDimitry Andric       Header.Bitcode.MinorVersion = DXILVersion.getMinor().value_or(0);
13081ad6265SDimitry Andric       Header.Bitcode.Offset = sizeof(dxbc::BitcodeHeader);
13181ad6265SDimitry Andric       Header.Bitcode.Size = SectionSize;
13281ad6265SDimitry Andric       if (sys::IsBigEndianHost)
13381ad6265SDimitry Andric         Header.swapBytes();
13481ad6265SDimitry Andric       W.write<char>(ArrayRef<char>(reinterpret_cast<char *>(&Header),
13581ad6265SDimitry Andric                                    sizeof(dxbc::ProgramHeader)));
13681ad6265SDimitry Andric     }
137*0fca6ea1SDimitry Andric     Asm.writeSectionData(W.OS, &Sec);
13881ad6265SDimitry Andric     unsigned Size = W.OS.tell() - Start;
13981ad6265SDimitry Andric     W.OS.write_zeros(offsetToAlignment(Size, Align(4)));
14081ad6265SDimitry Andric   }
14181ad6265SDimitry Andric   return 0;
14281ad6265SDimitry Andric }
14381ad6265SDimitry Andric 
14481ad6265SDimitry Andric std::unique_ptr<MCObjectWriter> llvm::createDXContainerObjectWriter(
14581ad6265SDimitry Andric     std::unique_ptr<MCDXContainerTargetWriter> MOTW, raw_pwrite_stream &OS) {
14681ad6265SDimitry Andric   return std::make_unique<DXContainerObjectWriter>(std::move(MOTW), OS);
14781ad6265SDimitry Andric }
148