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

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

CLRadeonExtender: ROCmBinaries: Add GFX901 to amdGpuArchValuesTbl.

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    { 9, 0, 1, GPUDeviceType::GFX901 }
147};
148
149static const size_t amdGpuArchValuesNum = sizeof(amdGpuArchValuesTbl) /
150                sizeof(AMDGPUArchValuesEntry);
151
152
153GPUDeviceType ROCmBinary::determineGPUDeviceType(uint32_t& outArchMinor,
154                     uint32_t& outArchStepping) const
155{
156    uint32_t archMajor = 0;
157    uint32_t archMinor = 0;
158    uint32_t archStepping = 0;
159   
160    {
161        const cxbyte* noteContent = (const cxbyte*)getNotes();
162        if (noteContent==nullptr)
163            throw Exception("Missing notes in inner binary!");
164        size_t notesSize = getNotesSize();
165        // find note about AMDGPU
166        for (size_t offset = 0; offset < notesSize; )
167        {
168            const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
169            size_t namesz = ULEV(nhdr->n_namesz);
170            size_t descsz = ULEV(nhdr->n_descsz);
171            if (usumGt(offset, namesz+descsz, notesSize))
172                throw Exception("Note offset+size out of range");
173            if (ULEV(nhdr->n_type) == 0x3 && namesz==4 && descsz>=0x1a &&
174                ::strcmp((const char*)noteContent+offset+sizeof(Elf64_Nhdr), "AMD")==0)
175            {    // AMDGPU type
176                const uint32_t* content = (const uint32_t*)
177                        (noteContent+offset+sizeof(Elf64_Nhdr) + 4);
178                archMajor = ULEV(content[1]);
179                archMinor = ULEV(content[2]);
180                archStepping = ULEV(content[3]);
181            }
182            size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
183            offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
184        }
185    }
186    // determine device type
187    GPUDeviceType deviceType = GPUDeviceType::CAPE_VERDE;
188    if (archMajor==0)
189        deviceType = GPUDeviceType::CAPE_VERDE;
190    else if (archMajor==7)
191        deviceType = GPUDeviceType::BONAIRE;
192    else if (archMajor==8)
193        deviceType = GPUDeviceType::ICELAND;
194   
195    for (cxuint i = 0; i < amdGpuArchValuesNum; i++)
196        if (amdGpuArchValuesTbl[i].major==archMajor &&
197            amdGpuArchValuesTbl[i].minor==archMinor &&
198            amdGpuArchValuesTbl[i].stepping==archStepping)
199        {
200            deviceType = amdGpuArchValuesTbl[i].deviceType;
201            break;
202        }
203    outArchMinor = archMinor;
204    outArchStepping = archStepping;
205    return deviceType;
206}
207
208const ROCmRegion& ROCmBinary::getRegion(const char* name) const
209{
210    RegionMap::const_iterator it = binaryMapFind(regionsMap.begin(),
211                             regionsMap.end(), name);
212    if (it == regionsMap.end())
213        throw Exception("Can't find region name");
214    return regions[it->second];
215}
216
217bool CLRX::isROCmBinary(size_t binarySize, const cxbyte* binary)
218{
219    if (!isElfBinary(binarySize, binary))
220        return false;
221    if (binary[EI_CLASS] != ELFCLASS64)
222        return false;
223    const Elf64_Ehdr* ehdr = reinterpret_cast<const Elf64_Ehdr*>(binary);
224    if (ULEV(ehdr->e_machine) != 0xe0 || ULEV(ehdr->e_flags)!=0)
225        return false;
226    return true;
227}
228
229
230void ROCmInput::addEmptyKernel(const char* kernelName)
231{
232    symbols.push_back({ kernelName, 0, 0, ROCmRegionType::KERNEL });
233}
234/*
235 * ROCm Binary Generator
236 */
237
238ROCmBinGenerator::ROCmBinGenerator() : manageable(false), input(nullptr)
239{ }
240
241ROCmBinGenerator::ROCmBinGenerator(const ROCmInput* rocmInput)
242        : manageable(false), input(rocmInput)
243{ }
244
245ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
246        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
247        const std::vector<ROCmSymbolInput>& symbols)
248{
249    input = new ROCmInput{ deviceType, archMinor, archStepping, symbols, codeSize, code };
250}
251
252ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
253        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
254        std::vector<ROCmSymbolInput>&& symbols)
255{
256    input = new ROCmInput{ deviceType, archMinor, archStepping, std::move(symbols),
257                codeSize, code };
258}
259
260ROCmBinGenerator::~ROCmBinGenerator()
261{
262    if (manageable)
263        delete input;
264}
265
266void ROCmBinGenerator::setInput(const ROCmInput* input)
267{
268    if (manageable)
269        delete input;
270    manageable = false;
271    this->input = input;
272}
273
274static const cxbyte noteDescType1[8] =
275{ 2, 0, 0, 0, 1, 0, 0, 0 };
276
277static const cxbyte noteDescType3[27] =
278{ 4, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
279  'A', 'M', 'D', 0, 'A', 'M', 'D', 'G', 'P', 'U', 0 };
280
281// section index for symbol binding
282static const uint16_t mainBuiltinSectionTable[] =
283{
284    10, // ELFSECTID_SHSTRTAB
285    11, // ELFSECTID_STRTAB
286    9, // ELFSECTID_SYMTAB
287    3, // ELFSECTID_DYNSTR
288    1, // ELFSECTID_DYNSYM
289    4, // ELFSECTID_TEXT
290    SHN_UNDEF, // ELFSECTID_RODATA
291    SHN_UNDEF, // ELFSECTID_DATA
292    SHN_UNDEF, // ELFSECTID_BSS
293    8, // ELFSECTID_COMMENT
294    2, // ROCMSECTID_HASH
295    5, // ROCMSECTID_DYNAMIC
296    6, // ROCMSECTID_NOTE
297    7 // ROCMSECTID_GPUCONFIG
298};
299
300static const AMDGPUArchValues rocmAmdGpuArchValuesTbl[] =
301{
302    { 0, 0, 0 }, // GPUDeviceType::CAPE_VERDE
303    { 0, 0, 0 }, // GPUDeviceType::PITCAIRN
304    { 0, 0, 0 }, // GPUDeviceType::TAHITI
305    { 0, 0, 0 }, // GPUDeviceType::OLAND
306    { 7, 0, 0 }, // GPUDeviceType::BONAIRE
307    { 7, 0, 0 }, // GPUDeviceType::SPECTRE
308    { 7, 0, 0 }, // GPUDeviceType::SPOOKY
309    { 7, 0, 0 }, // GPUDeviceType::KALINDI
310    { 0, 0, 0 }, // GPUDeviceType::HAINAN
311    { 7, 0, 1 }, // GPUDeviceType::HAWAII
312    { 8, 0, 0 }, // GPUDeviceType::ICELAND
313    { 8, 0, 0 }, // GPUDeviceType::TONGA
314    { 7, 0, 0 }, // GPUDeviceType::MULLINS
315    { 8, 0, 3 }, // GPUDeviceType::FIJI
316    { 8, 0, 1 }, // GPUDeviceType::CARRIZO
317    { 8, 0, 1 }, // GPUDeviceType::DUMMY
318    { 8, 0, 4 }, // GPUDeviceType::GOOSE
319    { 8, 0, 4 }, // GPUDeviceType::HORSE
320    { 8, 0, 1 }, // GPUDeviceType::STONEY
321    { 8, 0, 4 }, // GPUDeviceType::ELLESMERE
322    { 8, 0, 4 }, // GPUDeviceType::BAFFIN
323    { 8, 0, 4 }, // GPUDeviceType::GFX804
324    { 9, 0, 0 }, // GPUDeviceType::GFX900
325    { 9, 0, 1 }  // GPUDeviceType::GFX901
326};
327
328void ROCmBinGenerator::generateInternal(std::ostream* osPtr, std::vector<char>* vPtr,
329             Array<cxbyte>* aPtr) const
330{
331    AMDGPUArchValues amdGpuArchValues = rocmAmdGpuArchValuesTbl[cxuint(input->deviceType)];
332    if (input->archMinor!=UINT32_MAX)
333        amdGpuArchValues.minor = input->archMinor;
334    if (input->archStepping!=UINT32_MAX)
335        amdGpuArchValues.stepping = input->archStepping;
336   
337    const char* comment = "CLRX ROCmBinGenerator " CLRX_VERSION;
338    uint32_t commentSize = ::strlen(comment);
339    if (input->comment!=nullptr)
340    {   // if comment, store comment section
341        comment = input->comment;
342        commentSize = input->commentSize;
343        if (commentSize==0)
344            commentSize = ::strlen(comment);
345    }
346   
347    ElfBinaryGen64 elfBinGen64({ 0U, 0U, 0x40, 0, ET_DYN,
348        0xe0, EV_CURRENT, UINT_MAX, 0, 0 }, true, true, true, PHREGION_FILESTART);
349    // add symbols
350    elfBinGen64.addSymbol(ElfSymbol64("_DYNAMIC", 5,
351                  ELF64_ST_INFO(STB_LOCAL, STT_NOTYPE), STV_HIDDEN, true, 0, 0));
352    for (const ROCmSymbolInput& symbol: input->symbols)
353    {
354        ElfSymbol64 elfsym;
355        switch (symbol.type)
356        {
357            case ROCmRegionType::KERNEL:
358                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
359                      ELF64_ST_INFO(STB_GLOBAL, STT_GNU_IFUNC), 0, true,
360                      symbol.offset, symbol.size);
361                break;
362            case ROCmRegionType::FKERNEL:
363                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
364                      ELF64_ST_INFO(STB_GLOBAL, STT_FUNC), 0, true,
365                      symbol.offset, symbol.size);
366                break;
367            case ROCmRegionType::DATA:
368                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
369                      ELF64_ST_INFO(STB_GLOBAL, STT_OBJECT), 0, true,
370                      symbol.offset, symbol.size);
371                break;
372            default:
373                break;
374        }
375        elfBinGen64.addSymbol(elfsym);
376        elfBinGen64.addDynSymbol(elfsym);
377    }
378   
379    static const int32_t dynTags[] = {
380        DT_SYMTAB, DT_SYMENT, DT_STRTAB, DT_STRSZ, DT_HASH };
381    elfBinGen64.addDynamics(sizeof(dynTags)/sizeof(int32_t), dynTags);
382    // elf program headers
383    elfBinGen64.addProgramHeader({ PT_PHDR, PF_R, 0, 1,
384                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
385    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R, PHREGION_FILESTART, 4,
386                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 0x1000 });
387    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_X, 4, 1,
388                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
389    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_W, 5, 1,
390                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
391    elfBinGen64.addProgramHeader({ PT_DYNAMIC, PF_R|PF_W, 5, 1,
392                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 8 });
393    elfBinGen64.addProgramHeader({ PT_GNU_RELRO, PF_R, 5, 1,
394                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 1 });
395    elfBinGen64.addProgramHeader({ PT_GNU_STACK, PF_R|PF_W, PHREGION_FILESTART, 0,
396                    true, 0, 0, 0 });
397   
398    // elf notes
399    elfBinGen64.addNote({"AMD", sizeof noteDescType1, noteDescType1, 1U});
400    std::unique_ptr<cxbyte[]> noteBuf(new cxbyte[0x1b]);
401    ::memcpy(noteBuf.get(), noteDescType3, 0x1b);
402    SULEV(*(uint32_t*)(noteBuf.get()+4), amdGpuArchValues.major);
403    SULEV(*(uint32_t*)(noteBuf.get()+8), amdGpuArchValues.minor);
404    SULEV(*(uint32_t*)(noteBuf.get()+12), amdGpuArchValues.stepping);
405    elfBinGen64.addNote({"AMD", 0x1b, noteBuf.get(), 3U});
406   
407    /// region and sections
408    elfBinGen64.addRegion(ElfRegion64::programHeaderTable());
409    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
410                ".dynsym", SHT_DYNSYM, SHF_ALLOC, 0, 1, Elf64Types::nobase));
411    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 4,
412                ".hash", SHT_HASH, SHF_ALLOC, 1, 0, Elf64Types::nobase));
413    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1, ".dynstr", SHT_STRTAB,
414                SHF_ALLOC, 0, 0, Elf64Types::nobase));
415    elfBinGen64.addRegion(ElfRegion64(input->codeSize, (const cxbyte*)input->code, 
416              0x1000, ".text", SHT_PROGBITS, SHF_ALLOC|SHF_EXECINSTR, 0, 0,
417              Elf64Types::nobase, 0, false, 256));
418    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 0x1000,
419                ".dynamic", SHT_DYNAMIC, SHF_ALLOC|SHF_WRITE, 3, 0,
420                Elf64Types::nobase, 0, false, 8));
421    elfBinGen64.addRegion(ElfRegion64::noteSection());
422    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1,
423                ".AMDGPU.config", SHT_PROGBITS, 0));
424    elfBinGen64.addRegion(ElfRegion64(commentSize, (const cxbyte*)comment, 1, ".comment",
425              SHT_PROGBITS, SHF_MERGE|SHF_STRINGS, 0, 0, 0, 1));
426    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
427                ".symtab", SHT_SYMTAB, 0, 0, 1));
428    elfBinGen64.addRegion(ElfRegion64::shstrtabSection());
429    elfBinGen64.addRegion(ElfRegion64::strtabSection());
430    elfBinGen64.addRegion(ElfRegion64::sectionHeaderTable());
431   
432    /* extra sections */
433    for (const BinSection& section: input->extraSections)
434        elfBinGen64.addRegion(ElfRegion64(section, mainBuiltinSectionTable,
435                         ROCMSECTID_MAX, 12));
436    /* extra symbols */
437    for (const BinSymbol& symbol: input->extraSymbols)
438        elfBinGen64.addSymbol(ElfSymbol64(symbol, mainBuiltinSectionTable,
439                         ROCMSECTID_MAX, 12));
440   
441    size_t binarySize = elfBinGen64.countSize();
442    /****
443     * prepare for write binary to output
444     ****/
445    std::unique_ptr<std::ostream> outStreamHolder;
446    std::ostream* os = nullptr;
447    if (aPtr != nullptr)
448    {
449        aPtr->resize(binarySize);
450        outStreamHolder.reset(
451                new ArrayOStream(binarySize, reinterpret_cast<char*>(aPtr->data())));
452        os = outStreamHolder.get();
453    }
454    else if (vPtr != nullptr)
455    {
456        vPtr->resize(binarySize);
457        outStreamHolder.reset(new VectorOStream(*vPtr));
458        os = outStreamHolder.get();
459    }
460    else // from argument
461        os = osPtr;
462   
463    const std::ios::iostate oldExceptions = os->exceptions();
464    try
465    {
466    os->exceptions(std::ios::failbit | std::ios::badbit);
467    /****
468     * write binary to output
469     ****/
470    FastOutputBuffer bos(256, *os);
471    elfBinGen64.generate(bos);
472    assert(bos.getWritten() == binarySize);
473    }
474    catch(...)
475    {
476        os->exceptions(oldExceptions);
477        throw;
478    }
479    os->exceptions(oldExceptions);
480}
481
482void ROCmBinGenerator::generate(Array<cxbyte>& array) const
483{
484    generateInternal(nullptr, nullptr, &array);
485}
486
487void ROCmBinGenerator::generate(std::ostream& os) const
488{
489    generateInternal(&os, nullptr, nullptr);
490}
491
492void ROCmBinGenerator::generate(std::vector<char>& v) const
493{
494    generateInternal(nullptr, &v, nullptr);
495}
Note: See TracBrowser for help on using the repository browser.