source: CLRX/CLRadeonExtender/trunk/amdbin/ROCmBinaries.cpp @ 3306

Last change on this file since 3306 was 3306, checked in by matszpk, 2 years ago

CLRadeonExtender: Added support for GFX901 (next RX VEGA with HBCC) device.

File size: 18.2 KB
Line 
1/*
2 *  CLRadeonExtender - Unofficial OpenCL Radeon Extensions Library
3 *  Copyright (C) 2014-2017 Mateusz Szpakowski
4 *
5 *  This library is free software; you can redistribute it and/or
6 *  modify it under the terms of the GNU Lesser General Public
7 *  License as published by the Free Software Foundation; either
8 *  version 2.1 of the License, or (at your option) any later version.
9 *
10 *  This library is distributed in the hope that it will be useful,
11 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 *  Lesser General Public License for more details.
14 *
15 *  You should have received a copy of the GNU Lesser General Public
16 *  License along with this library; if not, write to the Free Software
17 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18 */
19
20#include <CLRX/Config.h>
21#include <cassert>
22#include <cstdint>
23#include <algorithm>
24#include <utility>
25#include <CLRX/amdbin/ElfBinaries.h>
26#include <CLRX/utils/Utilities.h>
27#include <CLRX/utils/MemAccess.h>
28#include <CLRX/utils/InputOutput.h>
29#include <CLRX/utils/Containers.h>
30#include <CLRX/amdbin/ROCmBinaries.h>
31
32using namespace CLRX;
33
34/* TODO: add support for various kernel code offset (now only 256 is supported) */
35
36ROCmBinary::ROCmBinary(size_t binaryCodeSize, cxbyte* binaryCode, Flags creationFlags)
37        : ElfBinary64(binaryCodeSize, binaryCode, creationFlags),
38          regionsNum(0), codeSize(0), code(nullptr)
39{
40    cxuint textIndex = SHN_UNDEF;
41    try
42    { textIndex = getSectionIndex(".text"); }
43    catch(const Exception& ex)
44    { } // ignore failed
45    uint64_t codeOffset = 0;
46    if (textIndex!=SHN_UNDEF)
47    {
48        code = getSectionContent(textIndex);
49        const Elf64_Shdr& textShdr = getSectionHeader(textIndex);
50        codeSize = ULEV(textShdr.sh_size);
51        codeOffset = ULEV(textShdr.sh_offset);
52    }
53   
54    regionsNum = 0;
55    const size_t symbolsNum = getSymbolsNum();
56    for (size_t i = 0; i < symbolsNum; i++)
57    {   // count regions number
58        const Elf64_Sym& sym = getSymbol(i);
59        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
60        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
61        if (ULEV(sym.st_shndx)==textIndex &&
62            (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
63                (bind==STB_GLOBAL && symType==STT_OBJECT)))
64            regionsNum++;
65    }
66    if (code==nullptr && regionsNum!=0)
67        throw Exception("No code if regions number is not zero");
68    regions.reset(new ROCmRegion[regionsNum]);
69    size_t j = 0;
70    typedef std::pair<uint64_t, size_t> RegionOffsetEntry;
71    std::unique_ptr<RegionOffsetEntry[]> symOffsets(new RegionOffsetEntry[regionsNum]);
72   
73    for (size_t i = 0; i < symbolsNum; i++)
74    {
75        const Elf64_Sym& sym = getSymbol(i);
76        if (ULEV(sym.st_shndx)!=textIndex)
77            continue;   // if not in '.text' section
78        const size_t value = ULEV(sym.st_value);
79        if (value < codeOffset)
80            throw Exception("Region offset is too small!");
81        const size_t size = ULEV(sym.st_size);
82       
83        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
84        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
85        if (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
86                (bind==STB_GLOBAL && symType==STT_OBJECT))
87        {
88            ROCmRegionType type = ROCmRegionType::DATA;
89            if (symType==STT_GNU_IFUNC) 
90                type = ROCmRegionType::KERNEL;
91            else if (symType==STT_FUNC)
92                type = ROCmRegionType::FKERNEL;
93            symOffsets[j] = std::make_pair(value, j);
94            if (type!=ROCmRegionType::DATA && value+0x100 > codeOffset+codeSize)
95                throw Exception("Kernel or code offset is too big!");
96            regions[j++] = { getSymbolName(i), size, value, type };
97        }
98    }
99    std::sort(symOffsets.get(), symOffsets.get()+regionsNum,
100            [](const RegionOffsetEntry& a, const RegionOffsetEntry& b)
101            { return a.first < b.first; });
102    // checking distance between regions
103    for (size_t i = 1; i <= regionsNum; i++)
104    {
105        size_t end = (i<regionsNum) ? symOffsets[i].first : codeOffset+codeSize;
106        ROCmRegion& region = regions[symOffsets[i-1].second];
107        if (region.type==ROCmRegionType::KERNEL && symOffsets[i-1].first+0x100 > end)
108            throw Exception("Kernel size is too small!");
109       
110        const size_t regSize = end - symOffsets[i-1].first;
111        if (region.size==0)
112            region.size = regSize;
113        else
114            region.size = std::min(regSize, region.size);
115    }
116   
117    if (hasRegionMap())
118    {   // create region map
119        regionsMap.resize(regionsNum);
120        for (size_t i = 0; i < regionsNum; i++)
121            regionsMap[i] = std::make_pair(regions[i].regionName, i);
122        mapSort(regionsMap.begin(), regionsMap.end());
123    }
124}
125
126struct AMDGPUArchValuesEntry
127{
128    uint32_t major;
129    uint32_t minor;
130    uint32_t stepping;
131    GPUDeviceType deviceType;
132};
133
134static const AMDGPUArchValuesEntry amdGpuArchValuesTbl[] =
135{
136    { 0, 0, 0, GPUDeviceType::CAPE_VERDE },
137    { 7, 0, 0, GPUDeviceType::BONAIRE },
138    { 7, 0, 1, GPUDeviceType::HAWAII },
139    { 8, 0, 0, GPUDeviceType::ICELAND },
140    { 8, 0, 1, GPUDeviceType::CARRIZO },
141    { 8, 0, 2, GPUDeviceType::ICELAND },
142    { 8, 0, 3, GPUDeviceType::FIJI },
143    { 8, 0, 4, GPUDeviceType::FIJI },
144    { 8, 1, 0, GPUDeviceType::STONEY },
145    { 9, 0, 0, GPUDeviceType::GFX900 }
146};
147
148static const size_t amdGpuArchValuesNum = sizeof(amdGpuArchValuesTbl) /
149                sizeof(AMDGPUArchValuesEntry);
150
151
152GPUDeviceType ROCmBinary::determineGPUDeviceType(uint32_t& outArchMinor,
153                     uint32_t& outArchStepping) const
154{
155    uint32_t archMajor = 0;
156    uint32_t archMinor = 0;
157    uint32_t archStepping = 0;
158   
159    {
160        const cxbyte* noteContent = (const cxbyte*)getNotes();
161        if (noteContent==nullptr)
162            throw Exception("Missing notes in inner binary!");
163        size_t notesSize = getNotesSize();
164        // find note about AMDGPU
165        for (size_t offset = 0; offset < notesSize; )
166        {
167            const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
168            size_t namesz = ULEV(nhdr->n_namesz);
169            size_t descsz = ULEV(nhdr->n_descsz);
170            if (usumGt(offset, namesz+descsz, notesSize))
171                throw Exception("Note offset+size out of range");
172            if (ULEV(nhdr->n_type) == 0x3 && namesz==4 && descsz>=0x1a &&
173                ::strcmp((const char*)noteContent+offset+sizeof(Elf64_Nhdr), "AMD")==0)
174            {    // AMDGPU type
175                const uint32_t* content = (const uint32_t*)
176                        (noteContent+offset+sizeof(Elf64_Nhdr) + 4);
177                archMajor = ULEV(content[1]);
178                archMinor = ULEV(content[2]);
179                archStepping = ULEV(content[3]);
180            }
181            size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
182            offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
183        }
184    }
185    // determine device type
186    GPUDeviceType deviceType = GPUDeviceType::CAPE_VERDE;
187    if (archMajor==0)
188        deviceType = GPUDeviceType::CAPE_VERDE;
189    else if (archMajor==7)
190        deviceType = GPUDeviceType::BONAIRE;
191    else if (archMajor==8)
192        deviceType = GPUDeviceType::ICELAND;
193   
194    for (cxuint i = 0; i < amdGpuArchValuesNum; i++)
195        if (amdGpuArchValuesTbl[i].major==archMajor &&
196            amdGpuArchValuesTbl[i].minor==archMinor &&
197            amdGpuArchValuesTbl[i].stepping==archStepping)
198        {
199            deviceType = amdGpuArchValuesTbl[i].deviceType;
200            break;
201        }
202    outArchMinor = archMinor;
203    outArchStepping = archStepping;
204    return deviceType;
205}
206
207const ROCmRegion& ROCmBinary::getRegion(const char* name) const
208{
209    RegionMap::const_iterator it = binaryMapFind(regionsMap.begin(),
210                             regionsMap.end(), name);
211    if (it == regionsMap.end())
212        throw Exception("Can't find region name");
213    return regions[it->second];
214}
215
216bool CLRX::isROCmBinary(size_t binarySize, const cxbyte* binary)
217{
218    if (!isElfBinary(binarySize, binary))
219        return false;
220    if (binary[EI_CLASS] != ELFCLASS64)
221        return false;
222    const Elf64_Ehdr* ehdr = reinterpret_cast<const Elf64_Ehdr*>(binary);
223    if (ULEV(ehdr->e_machine) != 0xe0 || ULEV(ehdr->e_flags)!=0)
224        return false;
225    return true;
226}
227
228
229void ROCmInput::addEmptyKernel(const char* kernelName)
230{
231    symbols.push_back({ kernelName, 0, 0, ROCmRegionType::KERNEL });
232}
233/*
234 * ROCm Binary Generator
235 */
236
237ROCmBinGenerator::ROCmBinGenerator() : manageable(false), input(nullptr)
238{ }
239
240ROCmBinGenerator::ROCmBinGenerator(const ROCmInput* rocmInput)
241        : manageable(false), input(rocmInput)
242{ }
243
244ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
245        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
246        const std::vector<ROCmSymbolInput>& symbols)
247{
248    input = new ROCmInput{ deviceType, archMinor, archStepping, symbols, codeSize, code };
249}
250
251ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
252        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
253        std::vector<ROCmSymbolInput>&& symbols)
254{
255    input = new ROCmInput{ deviceType, archMinor, archStepping, std::move(symbols),
256                codeSize, code };
257}
258
259ROCmBinGenerator::~ROCmBinGenerator()
260{
261    if (manageable)
262        delete input;
263}
264
265void ROCmBinGenerator::setInput(const ROCmInput* input)
266{
267    if (manageable)
268        delete input;
269    manageable = false;
270    this->input = input;
271}
272
273static const cxbyte noteDescType1[8] =
274{ 2, 0, 0, 0, 1, 0, 0, 0 };
275
276static const cxbyte noteDescType3[27] =
277{ 4, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
278  'A', 'M', 'D', 0, 'A', 'M', 'D', 'G', 'P', 'U', 0 };
279
280// section index for symbol binding
281static const uint16_t mainBuiltinSectionTable[] =
282{
283    10, // ELFSECTID_SHSTRTAB
284    11, // ELFSECTID_STRTAB
285    9, // ELFSECTID_SYMTAB
286    3, // ELFSECTID_DYNSTR
287    1, // ELFSECTID_DYNSYM
288    4, // ELFSECTID_TEXT
289    SHN_UNDEF, // ELFSECTID_RODATA
290    SHN_UNDEF, // ELFSECTID_DATA
291    SHN_UNDEF, // ELFSECTID_BSS
292    8, // ELFSECTID_COMMENT
293    2, // ROCMSECTID_HASH
294    5, // ROCMSECTID_DYNAMIC
295    6, // ROCMSECTID_NOTE
296    7 // ROCMSECTID_GPUCONFIG
297};
298
299static const AMDGPUArchValues rocmAmdGpuArchValuesTbl[] =
300{
301    { 0, 0, 0 }, // GPUDeviceType::CAPE_VERDE
302    { 0, 0, 0 }, // GPUDeviceType::PITCAIRN
303    { 0, 0, 0 }, // GPUDeviceType::TAHITI
304    { 0, 0, 0 }, // GPUDeviceType::OLAND
305    { 7, 0, 0 }, // GPUDeviceType::BONAIRE
306    { 7, 0, 0 }, // GPUDeviceType::SPECTRE
307    { 7, 0, 0 }, // GPUDeviceType::SPOOKY
308    { 7, 0, 0 }, // GPUDeviceType::KALINDI
309    { 0, 0, 0 }, // GPUDeviceType::HAINAN
310    { 7, 0, 1 }, // GPUDeviceType::HAWAII
311    { 8, 0, 0 }, // GPUDeviceType::ICELAND
312    { 8, 0, 0 }, // GPUDeviceType::TONGA
313    { 7, 0, 0 }, // GPUDeviceType::MULLINS
314    { 8, 0, 3 }, // GPUDeviceType::FIJI
315    { 8, 0, 1 }, // GPUDeviceType::CARRIZO
316    { 8, 0, 1 }, // GPUDeviceType::DUMMY
317    { 8, 0, 4 }, // GPUDeviceType::GOOSE
318    { 8, 0, 4 }, // GPUDeviceType::HORSE
319    { 8, 0, 1 }, // GPUDeviceType::STONEY
320    { 8, 0, 4 }, // GPUDeviceType::ELLESMERE
321    { 8, 0, 4 }, // GPUDeviceType::BAFFIN
322    { 8, 0, 4 }, // GPUDeviceType::GFX804
323    { 9, 0, 0 }, // GPUDeviceType::GFX900
324    { 9, 0, 1 }  // GPUDeviceType::GFX901
325};
326
327void ROCmBinGenerator::generateInternal(std::ostream* osPtr, std::vector<char>* vPtr,
328             Array<cxbyte>* aPtr) const
329{
330    AMDGPUArchValues amdGpuArchValues = rocmAmdGpuArchValuesTbl[cxuint(input->deviceType)];
331    if (input->archMinor!=UINT32_MAX)
332        amdGpuArchValues.minor = input->archMinor;
333    if (input->archStepping!=UINT32_MAX)
334        amdGpuArchValues.stepping = input->archStepping;
335   
336    const char* comment = "CLRX ROCmBinGenerator " CLRX_VERSION;
337    uint32_t commentSize = ::strlen(comment);
338    if (input->comment!=nullptr)
339    {   // if comment, store comment section
340        comment = input->comment;
341        commentSize = input->commentSize;
342        if (commentSize==0)
343            commentSize = ::strlen(comment);
344    }
345   
346    ElfBinaryGen64 elfBinGen64({ 0U, 0U, 0x40, 0, ET_DYN,
347        0xe0, EV_CURRENT, UINT_MAX, 0, 0 }, true, true, true, PHREGION_FILESTART);
348    // add symbols
349    elfBinGen64.addSymbol(ElfSymbol64("_DYNAMIC", 5,
350                  ELF64_ST_INFO(STB_LOCAL, STT_NOTYPE), STV_HIDDEN, true, 0, 0));
351    for (const ROCmSymbolInput& symbol: input->symbols)
352    {
353        ElfSymbol64 elfsym;
354        switch (symbol.type)
355        {
356            case ROCmRegionType::KERNEL:
357                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
358                      ELF64_ST_INFO(STB_GLOBAL, STT_GNU_IFUNC), 0, true,
359                      symbol.offset, symbol.size);
360                break;
361            case ROCmRegionType::FKERNEL:
362                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
363                      ELF64_ST_INFO(STB_GLOBAL, STT_FUNC), 0, true,
364                      symbol.offset, symbol.size);
365                break;
366            case ROCmRegionType::DATA:
367                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
368                      ELF64_ST_INFO(STB_GLOBAL, STT_OBJECT), 0, true,
369                      symbol.offset, symbol.size);
370                break;
371            default:
372                break;
373        }
374        elfBinGen64.addSymbol(elfsym);
375        elfBinGen64.addDynSymbol(elfsym);
376    }
377   
378    static const int32_t dynTags[] = {
379        DT_SYMTAB, DT_SYMENT, DT_STRTAB, DT_STRSZ, DT_HASH };
380    elfBinGen64.addDynamics(sizeof(dynTags)/sizeof(int32_t), dynTags);
381    // elf program headers
382    elfBinGen64.addProgramHeader({ PT_PHDR, PF_R, 0, 1,
383                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
384    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R, PHREGION_FILESTART, 4,
385                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 0x1000 });
386    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_X, 4, 1,
387                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
388    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_W, 5, 1,
389                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
390    elfBinGen64.addProgramHeader({ PT_DYNAMIC, PF_R|PF_W, 5, 1,
391                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 8 });
392    elfBinGen64.addProgramHeader({ PT_GNU_RELRO, PF_R, 5, 1,
393                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 1 });
394    elfBinGen64.addProgramHeader({ PT_GNU_STACK, PF_R|PF_W, PHREGION_FILESTART, 0,
395                    true, 0, 0, 0 });
396   
397    // elf notes
398    elfBinGen64.addNote({"AMD", sizeof noteDescType1, noteDescType1, 1U});
399    std::unique_ptr<cxbyte[]> noteBuf(new cxbyte[0x1b]);
400    ::memcpy(noteBuf.get(), noteDescType3, 0x1b);
401    SULEV(*(uint32_t*)(noteBuf.get()+4), amdGpuArchValues.major);
402    SULEV(*(uint32_t*)(noteBuf.get()+8), amdGpuArchValues.minor);
403    SULEV(*(uint32_t*)(noteBuf.get()+12), amdGpuArchValues.stepping);
404    elfBinGen64.addNote({"AMD", 0x1b, noteBuf.get(), 3U});
405   
406    /// region and sections
407    elfBinGen64.addRegion(ElfRegion64::programHeaderTable());
408    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
409                ".dynsym", SHT_DYNSYM, SHF_ALLOC, 0, 1, Elf64Types::nobase));
410    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 4,
411                ".hash", SHT_HASH, SHF_ALLOC, 1, 0, Elf64Types::nobase));
412    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1, ".dynstr", SHT_STRTAB,
413                SHF_ALLOC, 0, 0, Elf64Types::nobase));
414    elfBinGen64.addRegion(ElfRegion64(input->codeSize, (const cxbyte*)input->code, 
415              0x1000, ".text", SHT_PROGBITS, SHF_ALLOC|SHF_EXECINSTR, 0, 0,
416              Elf64Types::nobase, 0, false, 256));
417    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 0x1000,
418                ".dynamic", SHT_DYNAMIC, SHF_ALLOC|SHF_WRITE, 3, 0,
419                Elf64Types::nobase, 0, false, 8));
420    elfBinGen64.addRegion(ElfRegion64::noteSection());
421    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1,
422                ".AMDGPU.config", SHT_PROGBITS, 0));
423    elfBinGen64.addRegion(ElfRegion64(commentSize, (const cxbyte*)comment, 1, ".comment",
424              SHT_PROGBITS, SHF_MERGE|SHF_STRINGS, 0, 0, 0, 1));
425    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
426                ".symtab", SHT_SYMTAB, 0, 0, 1));
427    elfBinGen64.addRegion(ElfRegion64::shstrtabSection());
428    elfBinGen64.addRegion(ElfRegion64::strtabSection());
429    elfBinGen64.addRegion(ElfRegion64::sectionHeaderTable());
430   
431    /* extra sections */
432    for (const BinSection& section: input->extraSections)
433        elfBinGen64.addRegion(ElfRegion64(section, mainBuiltinSectionTable,
434                         ROCMSECTID_MAX, 12));
435    /* extra symbols */
436    for (const BinSymbol& symbol: input->extraSymbols)
437        elfBinGen64.addSymbol(ElfSymbol64(symbol, mainBuiltinSectionTable,
438                         ROCMSECTID_MAX, 12));
439   
440    size_t binarySize = elfBinGen64.countSize();
441    /****
442     * prepare for write binary to output
443     ****/
444    std::unique_ptr<std::ostream> outStreamHolder;
445    std::ostream* os = nullptr;
446    if (aPtr != nullptr)
447    {
448        aPtr->resize(binarySize);
449        outStreamHolder.reset(
450                new ArrayOStream(binarySize, reinterpret_cast<char*>(aPtr->data())));
451        os = outStreamHolder.get();
452    }
453    else if (vPtr != nullptr)
454    {
455        vPtr->resize(binarySize);
456        outStreamHolder.reset(new VectorOStream(*vPtr));
457        os = outStreamHolder.get();
458    }
459    else // from argument
460        os = osPtr;
461   
462    const std::ios::iostate oldExceptions = os->exceptions();
463    try
464    {
465    os->exceptions(std::ios::failbit | std::ios::badbit);
466    /****
467     * write binary to output
468     ****/
469    FastOutputBuffer bos(256, *os);
470    elfBinGen64.generate(bos);
471    assert(bos.getWritten() == binarySize);
472    }
473    catch(...)
474    {
475        os->exceptions(oldExceptions);
476        throw;
477    }
478    os->exceptions(oldExceptions);
479}
480
481void ROCmBinGenerator::generate(Array<cxbyte>& array) const
482{
483    generateInternal(nullptr, nullptr, &array);
484}
485
486void ROCmBinGenerator::generate(std::ostream& os) const
487{
488    generateInternal(&os, nullptr, nullptr);
489}
490
491void ROCmBinGenerator::generate(std::vector<char>& v) const
492{
493    generateInternal(nullptr, &v, nullptr);
494}
Note: See TracBrowser for help on using the repository browser.