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

Last change on this file since 2710 was 2710, checked in by matszpk, 3 years ago

CLRadeonExtender: ROCmBin: Move detection device type (from binary) code to ROCmBinaries module.

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