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

Last change on this file since 3443 was 3443, checked in by matszpk, 18 months ago

CLRadeonExtender: Move tables with arch values (arch versions) to GPUId.

File size: 16.4 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    // find '.text' section
47    if (textIndex!=SHN_UNDEF)
48    {
49        code = getSectionContent(textIndex);
50        const Elf64_Shdr& textShdr = getSectionHeader(textIndex);
51        codeSize = ULEV(textShdr.sh_size);
52        codeOffset = ULEV(textShdr.sh_offset);
53    }
54   
55    // counts regions (symbol or kernel)
56    regionsNum = 0;
57    const size_t symbolsNum = getSymbolsNum();
58    for (size_t i = 0; i < symbolsNum; i++)
59    {
60        // count regions number
61        const Elf64_Sym& sym = getSymbol(i);
62        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
63        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
64        if (ULEV(sym.st_shndx)==textIndex &&
65            (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
66                (bind==STB_GLOBAL && symType==STT_OBJECT)))
67            regionsNum++;
68    }
69    if (code==nullptr && regionsNum!=0)
70        throw Exception("No code if regions number is not zero");
71    regions.reset(new ROCmRegion[regionsNum]);
72    size_t j = 0;
73    typedef std::pair<uint64_t, size_t> RegionOffsetEntry;
74    std::unique_ptr<RegionOffsetEntry[]> symOffsets(new RegionOffsetEntry[regionsNum]);
75   
76    // get regions info
77    for (size_t i = 0; i < symbolsNum; i++)
78    {
79        const Elf64_Sym& sym = getSymbol(i);
80        if (ULEV(sym.st_shndx)!=textIndex)
81            continue;   // if not in '.text' section
82        const size_t value = ULEV(sym.st_value);
83        if (value < codeOffset)
84            throw Exception("Region offset is too small!");
85        const size_t size = ULEV(sym.st_size);
86       
87        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
88        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
89        if (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
90                (bind==STB_GLOBAL && symType==STT_OBJECT))
91        {
92            ROCmRegionType type = ROCmRegionType::DATA;
93            // if kernel
94            if (symType==STT_GNU_IFUNC) 
95                type = ROCmRegionType::KERNEL;
96            // if function kernel
97            else if (symType==STT_FUNC)
98                type = ROCmRegionType::FKERNEL;
99            symOffsets[j] = std::make_pair(value, j);
100            if (type!=ROCmRegionType::DATA && value+0x100 > codeOffset+codeSize)
101                throw Exception("Kernel or code offset is too big!");
102            regions[j++] = { getSymbolName(i), size, value, type };
103        }
104    }
105    // sort regions by offset
106    std::sort(symOffsets.get(), symOffsets.get()+regionsNum,
107            [](const RegionOffsetEntry& a, const RegionOffsetEntry& b)
108            { return a.first < b.first; });
109    // checking distance between regions
110    for (size_t i = 1; i <= regionsNum; i++)
111    {
112        size_t end = (i<regionsNum) ? symOffsets[i].first : codeOffset+codeSize;
113        ROCmRegion& region = regions[symOffsets[i-1].second];
114        if (region.type==ROCmRegionType::KERNEL && symOffsets[i-1].first+0x100 > end)
115            throw Exception("Kernel size is too small!");
116       
117        const size_t regSize = end - symOffsets[i-1].first;
118        if (region.size==0)
119            region.size = regSize;
120        else
121            region.size = std::min(regSize, region.size);
122    }
123   
124    if (hasRegionMap())
125    {
126        // create region map
127        regionsMap.resize(regionsNum);
128        for (size_t i = 0; i < regionsNum; i++)
129            regionsMap[i] = std::make_pair(regions[i].regionName, i);
130        // sort region map
131        mapSort(regionsMap.begin(), regionsMap.end());
132    }
133}
134
135/// determint GPU device from ROCm notes
136GPUDeviceType ROCmBinary::determineGPUDeviceType(uint32_t& outArchMinor,
137                     uint32_t& outArchStepping) const
138{
139    uint32_t archMajor = 0;
140    uint32_t archMinor = 0;
141    uint32_t archStepping = 0;
142   
143    {
144        const cxbyte* noteContent = (const cxbyte*)getNotes();
145        if (noteContent==nullptr)
146            throw Exception("Missing notes in inner binary!");
147        size_t notesSize = getNotesSize();
148        // find note about AMDGPU
149        for (size_t offset = 0; offset < notesSize; )
150        {
151            const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
152            size_t namesz = ULEV(nhdr->n_namesz);
153            size_t descsz = ULEV(nhdr->n_descsz);
154            if (usumGt(offset, namesz+descsz, notesSize))
155                throw Exception("Note offset+size out of range");
156            if (ULEV(nhdr->n_type) == 0x3 && namesz==4 && descsz>=0x1a &&
157                ::strcmp((const char*)noteContent+offset+sizeof(Elf64_Nhdr), "AMD")==0)
158            {    // AMDGPU type
159                const uint32_t* content = (const uint32_t*)
160                        (noteContent+offset+sizeof(Elf64_Nhdr) + 4);
161                archMajor = ULEV(content[1]);
162                archMinor = ULEV(content[2]);
163                archStepping = ULEV(content[3]);
164            }
165            size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
166            offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
167        }
168    }
169    // determine device type
170    GPUDeviceType deviceType = getGPUDeviceTypeFromArchValues(archMajor, archMinor,
171                                    archStepping);
172    outArchMinor = archMinor;
173    outArchStepping = archStepping;
174    return deviceType;
175}
176
177const ROCmRegion& ROCmBinary::getRegion(const char* name) const
178{
179    RegionMap::const_iterator it = binaryMapFind(regionsMap.begin(),
180                             regionsMap.end(), name);
181    if (it == regionsMap.end())
182        throw Exception("Can't find region name");
183    return regions[it->second];
184}
185
186// if ROCm binary
187bool CLRX::isROCmBinary(size_t binarySize, const cxbyte* binary)
188{
189    if (!isElfBinary(binarySize, binary))
190        return false;
191    if (binary[EI_CLASS] != ELFCLASS64)
192        return false;
193    const Elf64_Ehdr* ehdr = reinterpret_cast<const Elf64_Ehdr*>(binary);
194    if (ULEV(ehdr->e_machine) != 0xe0 || ULEV(ehdr->e_flags)!=0)
195        return false;
196    return true;
197}
198
199
200void ROCmInput::addEmptyKernel(const char* kernelName)
201{
202    symbols.push_back({ kernelName, 0, 0, ROCmRegionType::KERNEL });
203}
204/*
205 * ROCm Binary Generator
206 */
207
208ROCmBinGenerator::ROCmBinGenerator() : manageable(false), input(nullptr)
209{ }
210
211ROCmBinGenerator::ROCmBinGenerator(const ROCmInput* rocmInput)
212        : manageable(false), input(rocmInput)
213{ }
214
215ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
216        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
217        const std::vector<ROCmSymbolInput>& symbols)
218{
219    input = new ROCmInput{ deviceType, archMinor, archStepping, symbols, codeSize, code };
220}
221
222ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
223        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
224        std::vector<ROCmSymbolInput>&& symbols)
225{
226    input = new ROCmInput{ deviceType, archMinor, archStepping, std::move(symbols),
227                codeSize, code };
228}
229
230ROCmBinGenerator::~ROCmBinGenerator()
231{
232    if (manageable)
233        delete input;
234}
235
236void ROCmBinGenerator::setInput(const ROCmInput* input)
237{
238    if (manageable)
239        delete input;
240    manageable = false;
241    this->input = input;
242}
243
244// ELF notes contents
245static const cxbyte noteDescType1[8] =
246{ 2, 0, 0, 0, 1, 0, 0, 0 };
247
248static const cxbyte noteDescType3[27] =
249{ 4, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
250  'A', 'M', 'D', 0, 'A', 'M', 'D', 'G', 'P', 'U', 0 };
251
252// section index for symbol binding
253static const uint16_t mainBuiltinSectionTable[] =
254{
255    10, // ELFSECTID_SHSTRTAB
256    11, // ELFSECTID_STRTAB
257    9, // ELFSECTID_SYMTAB
258    3, // ELFSECTID_DYNSTR
259    1, // ELFSECTID_DYNSYM
260    4, // ELFSECTID_TEXT
261    SHN_UNDEF, // ELFSECTID_RODATA
262    SHN_UNDEF, // ELFSECTID_DATA
263    SHN_UNDEF, // ELFSECTID_BSS
264    8, // ELFSECTID_COMMENT
265    2, // ROCMSECTID_HASH
266    5, // ROCMSECTID_DYNAMIC
267    6, // ROCMSECTID_NOTE
268    7 // ROCMSECTID_GPUCONFIG
269};
270
271void ROCmBinGenerator::generateInternal(std::ostream* osPtr, std::vector<char>* vPtr,
272             Array<cxbyte>* aPtr) const
273{
274    AMDGPUArchValues amdGpuArchValues = getGPUArchValues(input->deviceType,
275                GPUArchValuesTable::OPENSOURCE);
276    if (input->archMinor!=UINT32_MAX)
277        amdGpuArchValues.minor = input->archMinor;
278    if (input->archStepping!=UINT32_MAX)
279        amdGpuArchValues.stepping = input->archStepping;
280   
281    const char* comment = "CLRX ROCmBinGenerator " CLRX_VERSION;
282    uint32_t commentSize = ::strlen(comment);
283    if (input->comment!=nullptr)
284    {
285        // if comment, store comment section
286        comment = input->comment;
287        commentSize = input->commentSize;
288        if (commentSize==0)
289            commentSize = ::strlen(comment);
290    }
291   
292    ElfBinaryGen64 elfBinGen64({ 0U, 0U, 0x40, 0, ET_DYN,
293        0xe0, EV_CURRENT, UINT_MAX, 0, 0 }, true, true, true, PHREGION_FILESTART);
294    // add symbols (kernels, function kernels and data symbols)
295    elfBinGen64.addSymbol(ElfSymbol64("_DYNAMIC", 5,
296                  ELF64_ST_INFO(STB_LOCAL, STT_NOTYPE), STV_HIDDEN, true, 0, 0));
297    for (const ROCmSymbolInput& symbol: input->symbols)
298    {
299        ElfSymbol64 elfsym;
300        switch (symbol.type)
301        {
302            case ROCmRegionType::KERNEL:
303                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
304                      ELF64_ST_INFO(STB_GLOBAL, STT_GNU_IFUNC), 0, true,
305                      symbol.offset, symbol.size);
306                break;
307            case ROCmRegionType::FKERNEL:
308                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
309                      ELF64_ST_INFO(STB_GLOBAL, STT_FUNC), 0, true,
310                      symbol.offset, symbol.size);
311                break;
312            case ROCmRegionType::DATA:
313                elfsym = ElfSymbol64(symbol.symbolName.c_str(), 4,
314                      ELF64_ST_INFO(STB_GLOBAL, STT_OBJECT), 0, true,
315                      symbol.offset, symbol.size);
316                break;
317            default:
318                break;
319        }
320        // add to symbols and dynamic symbols table
321        elfBinGen64.addSymbol(elfsym);
322        elfBinGen64.addDynSymbol(elfsym);
323    }
324   
325    static const int32_t dynTags[] = {
326        DT_SYMTAB, DT_SYMENT, DT_STRTAB, DT_STRSZ, DT_HASH };
327    elfBinGen64.addDynamics(sizeof(dynTags)/sizeof(int32_t), dynTags);
328    // elf program headers
329    elfBinGen64.addProgramHeader({ PT_PHDR, PF_R, 0, 1,
330                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
331    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R, PHREGION_FILESTART, 4,
332                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 0x1000 });
333    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_X, 4, 1,
334                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
335    elfBinGen64.addProgramHeader({ PT_LOAD, PF_R|PF_W, 5, 1,
336                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
337    elfBinGen64.addProgramHeader({ PT_DYNAMIC, PF_R|PF_W, 5, 1,
338                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 8 });
339    elfBinGen64.addProgramHeader({ PT_GNU_RELRO, PF_R, 5, 1,
340                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 1 });
341    elfBinGen64.addProgramHeader({ PT_GNU_STACK, PF_R|PF_W, PHREGION_FILESTART, 0,
342                    true, 0, 0, 0 });
343   
344    // elf notes
345    elfBinGen64.addNote({"AMD", sizeof noteDescType1, noteDescType1, 1U});
346    std::unique_ptr<cxbyte[]> noteBuf(new cxbyte[0x1b]);
347    ::memcpy(noteBuf.get(), noteDescType3, 0x1b);
348    SULEV(*(uint32_t*)(noteBuf.get()+4), amdGpuArchValues.major);
349    SULEV(*(uint32_t*)(noteBuf.get()+8), amdGpuArchValues.minor);
350    SULEV(*(uint32_t*)(noteBuf.get()+12), amdGpuArchValues.stepping);
351    elfBinGen64.addNote({"AMD", 0x1b, noteBuf.get(), 3U});
352   
353    /// region and sections
354    elfBinGen64.addRegion(ElfRegion64::programHeaderTable());
355    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
356                ".dynsym", SHT_DYNSYM, SHF_ALLOC, 0, 1, Elf64Types::nobase));
357    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 4,
358                ".hash", SHT_HASH, SHF_ALLOC, 1, 0, Elf64Types::nobase));
359    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1, ".dynstr", SHT_STRTAB,
360                SHF_ALLOC, 0, 0, Elf64Types::nobase));
361    // '.text' with alignment=4096
362    elfBinGen64.addRegion(ElfRegion64(input->codeSize, (const cxbyte*)input->code, 
363              0x1000, ".text", SHT_PROGBITS, SHF_ALLOC|SHF_EXECINSTR, 0, 0,
364              Elf64Types::nobase, 0, false, 256));
365    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 0x1000,
366                ".dynamic", SHT_DYNAMIC, SHF_ALLOC|SHF_WRITE, 3, 0,
367                Elf64Types::nobase, 0, false, 8));
368    elfBinGen64.addRegion(ElfRegion64::noteSection());
369    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1,
370                ".AMDGPU.config", SHT_PROGBITS, 0));
371    elfBinGen64.addRegion(ElfRegion64(commentSize, (const cxbyte*)comment, 1, ".comment",
372              SHT_PROGBITS, SHF_MERGE|SHF_STRINGS, 0, 0, 0, 1));
373    elfBinGen64.addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
374                ".symtab", SHT_SYMTAB, 0, 0, 1));
375    elfBinGen64.addRegion(ElfRegion64::shstrtabSection());
376    elfBinGen64.addRegion(ElfRegion64::strtabSection());
377    elfBinGen64.addRegion(ElfRegion64::sectionHeaderTable());
378   
379    /* extra sections */
380    for (const BinSection& section: input->extraSections)
381        elfBinGen64.addRegion(ElfRegion64(section, mainBuiltinSectionTable,
382                         ROCMSECTID_MAX, 12));
383    /* extra symbols */
384    for (const BinSymbol& symbol: input->extraSymbols)
385        elfBinGen64.addSymbol(ElfSymbol64(symbol, mainBuiltinSectionTable,
386                         ROCMSECTID_MAX, 12));
387   
388    size_t binarySize = elfBinGen64.countSize();
389    /****
390     * prepare for write binary to output
391     ****/
392    std::unique_ptr<std::ostream> outStreamHolder;
393    std::ostream* os = nullptr;
394    if (aPtr != nullptr)
395    {
396        aPtr->resize(binarySize);
397        outStreamHolder.reset(
398                new ArrayOStream(binarySize, reinterpret_cast<char*>(aPtr->data())));
399        os = outStreamHolder.get();
400    }
401    else if (vPtr != nullptr)
402    {
403        vPtr->resize(binarySize);
404        outStreamHolder.reset(new VectorOStream(*vPtr));
405        os = outStreamHolder.get();
406    }
407    else // from argument
408        os = osPtr;
409   
410    const std::ios::iostate oldExceptions = os->exceptions();
411    try
412    {
413    os->exceptions(std::ios::failbit | std::ios::badbit);
414    /****
415     * write binary to output
416     ****/
417    FastOutputBuffer bos(256, *os);
418    elfBinGen64.generate(bos);
419    assert(bos.getWritten() == binarySize);
420    }
421    catch(...)
422    {
423        os->exceptions(oldExceptions);
424        throw;
425    }
426    os->exceptions(oldExceptions);
427}
428
429void ROCmBinGenerator::generate(Array<cxbyte>& array) const
430{
431    generateInternal(nullptr, nullptr, &array);
432}
433
434void ROCmBinGenerator::generate(std::ostream& os) const
435{
436    generateInternal(&os, nullptr, nullptr);
437}
438
439void ROCmBinGenerator::generate(std::vector<char>& v) const
440{
441    generateInternal(nullptr, &v, nullptr);
442}
Note: See TracBrowser for help on using the repository browser.