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

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

CLRadeonExtender: BinGen?: Change BinGen? constructors to be more portable and easier modifiable.

File size: 88.6 KB
Line 
1/*
2 *  CLRadeonExtender - Unofficial OpenCL Radeon Extensions Library
3 *  Copyright (C) 2014-2018 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 <cstdio>
23#include <cstring>
24#include <cstdint>
25#include <string>
26#include <vector>
27#include <algorithm>
28#include <utility>
29#include <memory>
30#include <unordered_set>
31#include <CLRX/amdbin/ElfBinaries.h>
32#include <CLRX/utils/Utilities.h>
33#include <CLRX/utils/MemAccess.h>
34#include <CLRX/utils/InputOutput.h>
35#include <CLRX/utils/Containers.h>
36#include <CLRX/amdbin/ROCmBinaries.h>
37
38using namespace CLRX;
39
40/*
41 * ROCm metadata YAML parser
42 */
43
44void ROCmKernelMetadata::initialize()
45{
46    langVersion[0] = langVersion[1] = BINGEN_NOTSUPPLIED;
47    reqdWorkGroupSize[0] = reqdWorkGroupSize[1] = reqdWorkGroupSize[2] = 0;
48    workGroupSizeHint[0] = workGroupSizeHint[1] = workGroupSizeHint[2] = 0;
49    kernargSegmentSize = BINGEN64_NOTSUPPLIED;
50    groupSegmentFixedSize = BINGEN64_NOTSUPPLIED;
51    privateSegmentFixedSize = BINGEN64_NOTSUPPLIED;
52    kernargSegmentAlign = BINGEN64_NOTSUPPLIED;
53    wavefrontSize = BINGEN_NOTSUPPLIED;
54    sgprsNum = BINGEN_NOTSUPPLIED;
55    vgprsNum = BINGEN_NOTSUPPLIED;
56    maxFlatWorkGroupSize = BINGEN64_NOTSUPPLIED;
57    fixedWorkGroupSize[0] = fixedWorkGroupSize[1] = fixedWorkGroupSize[2] = 0;
58    spilledSgprs = BINGEN_NOTSUPPLIED;
59    spilledVgprs = BINGEN_NOTSUPPLIED;
60}
61
62void ROCmMetadata::initialize()
63{
64    version[0] = 1;
65    version[1] = 0;
66}
67
68// return trailing spaces
69static size_t skipSpacesAndComments(const char*& ptr, const char* end, size_t& lineNo)
70{
71    const char* lineStart = ptr;
72    while (ptr != end)
73    {
74        lineStart = ptr;
75        while (ptr != end && *ptr!='\n' && isSpace(*ptr)) ptr++;
76        if (ptr == end)
77            break; // end of stream
78        if (*ptr=='#')
79        {
80            // skip comment
81            while (ptr != end && *ptr!='\n') ptr++;
82            if (ptr == end)
83                return 0; // no trailing spaces and end
84        }
85        else if (*ptr!='\n')
86            break; // no comment and no end of line
87        else
88        {
89            ptr++;
90            lineNo++; // next line
91        }
92    }
93    return ptr - lineStart;
94}
95
96static inline void skipSpacesToLineEnd(const char*& ptr, const char* end)
97{
98    while (ptr != end && *ptr!='\n' && isSpace(*ptr)) ptr++;
99}
100
101static void skipSpacesToNextLine(const char*& ptr, const char* end, size_t& lineNo)
102{
103    skipSpacesToLineEnd(ptr, end);
104    if (ptr != end && *ptr != '\n' && *ptr!='#')
105        throw ParseException(lineNo, "Garbages at line");
106    if (ptr != end && *ptr == '#')
107        // skip comment at end of line
108        while (ptr!=end && *ptr!='\n') ptr++;
109    if (ptr!=end)
110    {   // newline
111        ptr++;
112        lineNo++;
113    }
114}
115
116enum class YAMLValType
117{
118    NONE,
119    NIL,
120    BOOL,
121    INT,
122    FLOAT,
123    STRING,
124    SEQ
125};
126
127static YAMLValType parseYAMLType(const char*& ptr, const char* end, size_t lineNo)
128{
129    if (ptr+2>end || *ptr!='!' || ptr[1]!='!')
130        return YAMLValType::NONE; // no type
131    if (ptr+7 && ::strncmp(ptr+2, "null", 4)==0 && isSpace(ptr[6]) && ptr[6]!='\n')
132    {
133        ptr += 6;
134        return YAMLValType::NIL;
135    }
136    else if (ptr+7 && ::strncmp(ptr+2, "bool", 4)==0 && isSpace(ptr[6]) && ptr[6]!='\n')
137    {
138        ptr += 6;
139        return YAMLValType::BOOL;
140    }
141    else if (ptr+6 && ::strncmp(ptr+2, "int", 3)==0 && isSpace(ptr[5]) && ptr[5]!='\n')
142    {
143        ptr += 5;
144        return YAMLValType::INT;
145    }
146    else if (ptr+8 && ::strncmp(ptr+2, "float", 5)==0 && isSpace(ptr[7]) && ptr[7]!='\n')
147    {
148        ptr += 7;
149        return YAMLValType::FLOAT;
150    }
151    else if (ptr+6 && ::strncmp(ptr+2, "str", 3)==0 && isSpace(ptr[5]) && ptr[5]!='\n')
152    {
153        ptr += 5;
154        return YAMLValType::STRING;
155    }
156    else if (ptr+6 && ::strncmp(ptr+2, "seq", 3)==0 && isSpace(ptr[5]) && ptr[5]!='\n')
157    {
158        ptr += 5;
159        return YAMLValType::SEQ;
160    }
161    throw ParseException(lineNo, "Unknown YAML value type");
162}
163
164// parse YAML key (keywords - recognized keys)
165static size_t parseYAMLKey(const char*& ptr, const char* end, size_t lineNo,
166            size_t keywordsNum, const char** keywords)
167{
168    const char* keyPtr = ptr;
169    while (ptr != end && (isAlnum(*ptr) || *ptr=='_')) ptr++;
170    if (keyPtr == end)
171        throw ParseException(lineNo, "Expected key name");
172    const char* keyEnd = ptr;
173    skipSpacesToLineEnd(ptr, end);
174    if (ptr == end || *ptr!=':')
175        throw ParseException(lineNo, "Expected colon");
176    ptr++;
177    const char* afterColon = ptr;
178    skipSpacesToLineEnd(ptr, end);
179    if (afterColon == ptr && ptr != end && *ptr!='\n')
180        // only if not immediate newline
181        throw ParseException(lineNo, "After key and colon must be space");
182    CString keyword(keyPtr, keyEnd);
183    const size_t index = binaryFind(keywords, keywords+keywordsNum,
184                        keyword.c_str(), CStringLess()) - keywords;
185    return index;
186}
187
188// parse YAML integer value
189template<typename T>
190static T parseYAMLIntValue(const char*& ptr, const char* end, size_t& lineNo,
191                bool singleValue = false)
192{
193    skipSpacesToLineEnd(ptr, end);
194    if (ptr == end || *ptr=='\n')
195        throw ParseException(lineNo, "Expected integer value");
196   
197    // skip !!int
198    YAMLValType valType = parseYAMLType(ptr, end, lineNo);
199    if (valType == YAMLValType::INT)
200    {   // if
201        skipSpacesToLineEnd(ptr, end);
202        if (ptr == end || *ptr=='\n')
203            throw ParseException(lineNo, "Expected integer value");
204    }
205    else if (valType != YAMLValType::NONE)
206        throw ParseException(lineNo, "Expected value of integer type");
207   
208    T value = 0;
209    try
210    { value = cstrtovCStyle<T>(ptr, end, ptr); }
211    catch(const ParseException& ex)
212    { throw ParseException(lineNo, ex.what()); }
213   
214    if (singleValue)
215        skipSpacesToNextLine(ptr, end, lineNo);
216    return value;
217}
218
219// parse YAML boolean value
220static bool parseYAMLBoolValue(const char*& ptr, const char* end, size_t& lineNo,
221        bool singleValue = false)
222{
223    skipSpacesToLineEnd(ptr, end);
224    if (ptr == end || *ptr=='\n')
225        throw ParseException(lineNo, "Expected boolean value");
226   
227    // skip !!bool
228    YAMLValType valType = parseYAMLType(ptr, end, lineNo);
229    if (valType == YAMLValType::BOOL)
230    {   // if
231        skipSpacesToLineEnd(ptr, end);
232        if (ptr == end || *ptr=='\n')
233            throw ParseException(lineNo, "Expected boolean value");
234    }
235    else if (valType != YAMLValType::NONE)
236        throw ParseException(lineNo, "Expected value of boolean type");
237   
238    const char* wordPtr = ptr;
239    while(ptr != end && isAlnum(*ptr)) ptr++;
240    CString word(wordPtr, ptr);
241   
242    bool value = false;
243    bool isSet = false;
244    for (const char* v: { "1", "true", "t", "on", "yes", "y"})
245        if (::strcasecmp(word.c_str(), v) == 0)
246        {
247            isSet = true;
248            value = true;
249            break;
250        }
251    if (!isSet)
252        for (const char* v: { "0", "false", "f", "off", "no", "n"})
253            if (::strcasecmp(word.c_str(), v) == 0)
254            {
255                isSet = true;
256                value = false;
257                break;
258            }
259    if (!isSet)
260        throw ParseException(lineNo, "This is not boolean value");
261   
262    if (singleValue)
263        skipSpacesToNextLine(ptr, end, lineNo);
264    return value;
265}
266
267// trim spaces (remove spaces from start and end)
268static std::string trimStrSpaces(const std::string& str)
269{
270    size_t i = 0;
271    const size_t sz = str.size();
272    while (i!=sz && isSpace(str[i])) i++;
273    if (i == sz) return "";
274    size_t j = sz-1;
275    while (j>i && isSpace(str[j])) j--;
276    return str.substr(i, j-i+1);
277}
278
279static std::string parseYAMLString(const char*& linePtr, const char* end,
280            size_t& lineNo)
281{
282    std::string strarray;
283    if (linePtr == end || (*linePtr != '"' && *linePtr != '\''))
284    {
285        while (linePtr != end && !isSpace(*linePtr) && *linePtr != ',') linePtr++;
286        throw ParseException(lineNo, "Expected string");
287    }
288    const char termChar = *linePtr;
289    linePtr++;
290   
291    // main loop, where is character parsing
292    while (linePtr != end && *linePtr != termChar)
293    {
294        if (*linePtr == '\\')
295        {
296            // escape
297            linePtr++;
298            uint16_t value;
299            if (linePtr == end)
300                throw ParseException(lineNo, "Unterminated character of string");
301            if (*linePtr == 'x')
302            {
303                // hex literal
304                linePtr++;
305                if (linePtr == end)
306                    throw ParseException(lineNo, "Unterminated character of string");
307                value = 0;
308                if (isXDigit(*linePtr))
309                    for (; linePtr != end; linePtr++)
310                    {
311                        cxuint digit;
312                        if (*linePtr >= '0' && *linePtr <= '9')
313                            digit = *linePtr-'0';
314                        else if (*linePtr >= 'a' && *linePtr <= 'f')
315                            digit = *linePtr-'a'+10;
316                        else if (*linePtr >= 'A' && *linePtr <= 'F')
317                            digit = *linePtr-'A'+10;
318                        else
319                            break;
320                        value = (value<<4) + digit;
321                    }
322                else
323                    throw ParseException(lineNo, "Expected hexadecimal character code");
324                value &= 0xff;
325            }
326            else if (isODigit(*linePtr))
327            {
328                // octal literal
329                value = 0;
330                for (cxuint i = 0; linePtr != end && i < 3; i++, linePtr++)
331                {
332                    if (!isODigit(*linePtr))
333                        break;
334                    value = (value<<3) + uint64_t(*linePtr-'0');
335                    // checking range
336                    if (value > 255)
337                        throw ParseException(lineNo, "Octal code out of range");
338                }
339            }
340            else
341            {
342                // normal escapes
343                const char c = *linePtr++;
344                switch (c)
345                {
346                    case 'a':
347                        value = '\a';
348                        break;
349                    case 'b':
350                        value = '\b';
351                        break;
352                    case 'r':
353                        value = '\r';
354                        break;
355                    case 'n':
356                        value = '\n';
357                        break;
358                    case 'f':
359                        value = '\f';
360                        break;
361                    case 'v':
362                        value = '\v';
363                        break;
364                    case 't':
365                        value = '\t';
366                        break;
367                    case '\\':
368                        value = '\\';
369                        break;
370                    case '\'':
371                        value = '\'';
372                        break;
373                    case '\"':
374                        value = '\"';
375                        break;
376                    default:
377                        value = c;
378                }
379            }
380            strarray.push_back(value);
381        }
382        else // regular character
383        {
384            if (*linePtr=='\n')
385                lineNo++;
386            strarray.push_back(*linePtr++);
387        }
388    }
389    if (linePtr == end)
390        throw ParseException(lineNo, "Unterminated string");
391    linePtr++;
392    return strarray;
393}
394
395static std::string parseYAMLStringValue(const char*& ptr, const char* end, size_t& lineNo,
396                    cxuint prevIndent, bool singleValue = false, bool blockAccept = true)
397{
398    skipSpacesToLineEnd(ptr, end);
399    if (ptr == end)
400        return "";
401   
402    // skip !!str
403    YAMLValType valType = parseYAMLType(ptr, end, lineNo);
404    if (valType == YAMLValType::STRING)
405    {   // if
406        skipSpacesToLineEnd(ptr, end);
407        if (ptr == end)
408            return "";
409    }
410    else if (valType != YAMLValType::NONE)
411        throw ParseException(lineNo, "Expected value of string type");
412   
413    std::string buf;
414    if (*ptr=='"' || *ptr== '\'')
415        buf = parseYAMLString(ptr, end, lineNo);
416    // otherwise parse stream
417    else if (*ptr == '|' || *ptr == '>')
418    {
419        if (!blockAccept)
420            throw ParseException(lineNo, "Illegal block string start");
421        // multiline
422        bool newLineFold = *ptr=='>';
423        ptr++;
424        skipSpacesToLineEnd(ptr, end);
425        if (ptr!=end && *ptr!='\n')
426            throw ParseException(lineNo, "Garbages at string block");
427        if (ptr == end)
428            return ""; // end
429        lineNo++;
430        ptr++; // skip newline
431        const char* lineStart = ptr;
432        skipSpacesToLineEnd(ptr, end);
433        size_t indent = ptr - lineStart;
434        if (indent <= prevIndent)
435            throw ParseException(lineNo, "Unindented string block");
436       
437        std::string buf;
438        while(ptr != end)
439        {
440            const char* strStart = ptr;
441            while (ptr != end && *ptr!='\n') ptr++;
442            buf.append(strStart, ptr);
443           
444            if (ptr != end) // if new line
445            {
446                lineNo++;
447                ptr++;
448            }
449            else // end of stream
450                break;
451           
452            const char* lineStart = ptr;
453            skipSpacesToLineEnd(ptr, end);
454            bool emptyLines = false;
455            while (size_t(ptr - lineStart) <= indent)
456            {
457                if (ptr != end && *ptr=='\n')
458                {
459                    // empty line
460                    buf.append("\n");
461                    ptr++;
462                    lineNo++;
463                    lineStart = ptr;
464                    skipSpacesToLineEnd(ptr, end);
465                    emptyLines = true;
466                    continue;
467                }
468                // if smaller indent
469                if (size_t(ptr - lineStart) < indent)
470                {
471                    buf.append("\n"); // always add newline at last line
472                    if (ptr != end)
473                        ptr = lineStart;
474                    return buf;
475                }
476                else // if this same and not end of line
477                    break;
478            }
479           
480            if (!emptyLines || !newLineFold)
481                // add missing newline after line with text
482                // only if no emptyLines or no newLineFold
483                buf.append(newLineFold ? " " : "\n");
484            // to indent
485            ptr = lineStart + indent;
486        }
487        return buf;
488    }
489    else
490    {
491        // single line string (unquoted)
492        const char* strStart = ptr;
493        // automatically trim spaces at ends
494        const char* strEnd = ptr;
495        while (ptr != end && *ptr!='\n' && *ptr!='#')
496        {
497            if (!isSpace(*ptr))
498                strEnd = ptr; // to trim at end
499            ptr++;
500        }
501        if (strEnd != end && !isSpace(*strEnd))
502            strEnd++;
503       
504        buf.assign(strStart, strEnd);
505    }
506   
507    if (singleValue)
508        skipSpacesToNextLine(ptr, end, lineNo);
509    return buf;
510}
511
512/// element consumer class
513class CLRX_INTERNAL YAMLElemConsumer
514{
515public:
516    virtual void consume(const char*& ptr, const char* end, size_t& lineNo,
517                cxuint prevIndent, bool singleValue, bool blockAccept) = 0;
518};
519
520static void parseYAMLValArray(const char*& ptr, const char* end, size_t& lineNo,
521            size_t prevIndent, YAMLElemConsumer* elemConsumer, bool singleValue = false)
522{
523    skipSpacesToLineEnd(ptr, end);
524    if (ptr == end)
525        return;
526   
527    // skip !!int
528    YAMLValType valType = parseYAMLType(ptr, end, lineNo);
529    if (valType == YAMLValType::SEQ)
530    {   // if
531        skipSpacesToLineEnd(ptr, end);
532        if (ptr == end)
533            return;
534    }
535    else if (valType != YAMLValType::NONE)
536        throw ParseException(lineNo, "Expected value of sequence type");
537   
538    if (*ptr == '[')
539    {
540        // parse array []
541        ptr++;
542        skipSpacesAndComments(ptr, end, lineNo);
543        while (ptr != end)
544        {
545            // parse in line
546            elemConsumer->consume(ptr, end, lineNo, 0, false, false);
547            skipSpacesAndComments(ptr, end, lineNo);
548            if (ptr!=end && *ptr==']')
549                // just end
550                break;
551            else if (ptr==end || *ptr!=',')
552                throw ParseException(lineNo, "Expected ','");
553            ptr++;
554            skipSpacesAndComments(ptr, end, lineNo);
555        }
556        if (ptr == end)
557            throw ParseException(lineNo, "Unterminated array");
558        ptr++;
559       
560        if (singleValue)
561            skipSpacesToNextLine(ptr, end, lineNo);
562        return;
563    }
564    // parse sequence
565    size_t oldLineNo = lineNo;
566    size_t indent0 = skipSpacesAndComments(ptr, end, lineNo);
567    if (ptr == end || lineNo == oldLineNo)
568        throw ParseException(lineNo, "Expected sequence of values");
569   
570    if (indent0 < prevIndent)
571        throw ParseException(lineNo, "Unindented sequence of objects");
572   
573    // main loop to parse sequence
574    while (ptr != end)
575    {
576        if (*ptr != '-')
577            throw ParseException(lineNo, "No '-' before element value");
578        ptr++;
579        const char* afterMinus = ptr;
580        skipSpacesToLineEnd(ptr, end);
581        if (afterMinus == ptr)
582            throw ParseException(lineNo, "No spaces after '-'");
583        elemConsumer->consume(ptr, end, lineNo, indent0, true, true);
584       
585        size_t indent = skipSpacesAndComments(ptr, end, lineNo);
586        if (indent < indent0)
587        {
588            // if parent level
589            ptr -= indent;
590            break;
591        }
592        if (indent != indent0)
593            throw ParseException(lineNo, "Wrong indentation of element");
594    }
595}
596
597// integer element consumer
598template<typename T>
599class CLRX_INTERNAL YAMLIntArrayConsumer: public YAMLElemConsumer
600{
601private:
602    size_t elemsNum;
603    size_t requiredElemsNum;
604public:
605    T* array;
606   
607    YAMLIntArrayConsumer(size_t reqElemsNum, T* _array)
608            : elemsNum(0), requiredElemsNum(reqElemsNum), array(_array)
609    { }
610   
611    virtual void consume(const char*& ptr, const char* end, size_t& lineNo,
612                cxuint prevIndent, bool singleValue, bool blockAccept)
613    {
614        if (elemsNum == requiredElemsNum)
615            throw ParseException(lineNo, "Too many elements");
616        try
617        { array[elemsNum] = cstrtovCStyle<T>(ptr, end, ptr); }
618        catch(const ParseException& ex)
619        { throw ParseException(lineNo, ex.what()); }
620        elemsNum++;
621        if (singleValue)
622            skipSpacesToNextLine(ptr, end, lineNo);
623    }
624};
625
626// printf info string consumer
627class CLRX_INTERNAL YAMLPrintfVectorConsumer: public YAMLElemConsumer
628{
629private:
630    std::unordered_set<cxuint> printfIds;
631public:
632    std::vector<ROCmPrintfInfo>& printfInfos;
633   
634    YAMLPrintfVectorConsumer(std::vector<ROCmPrintfInfo>& _printInfos)
635        : printfInfos(_printInfos)
636    { }
637   
638    virtual void consume(const char*& ptr, const char* end, size_t& lineNo,
639                cxuint prevIndent, bool singleValue, bool blockAccept)
640    {
641        const size_t oldLineNo = lineNo;
642        std::string str = parseYAMLStringValue(ptr, end, lineNo, prevIndent,
643                                singleValue, blockAccept);
644        // parse printf string
645        ROCmPrintfInfo printfInfo{};
646       
647        const char* ptr2 = str.c_str();
648        const char* end2 = str.c_str() + str.size();
649        skipSpacesToLineEnd(ptr2, end2);
650        try
651        { printfInfo.id = cstrtovCStyle<uint32_t>(ptr2, end2, ptr2); }
652        catch(const ParseException& ex)
653        { throw ParseException(oldLineNo, ex.what()); }
654       
655        // check printf id uniqueness
656        if (!printfIds.insert(printfInfo.id).second)
657            throw ParseException(oldLineNo, "Duplicate of printf id");
658       
659        skipSpacesToLineEnd(ptr2, end2);
660        if (ptr2==end || *ptr2!=':')
661            throw ParseException(oldLineNo, "No colon after printf callId");
662        ptr2++;
663        skipSpacesToLineEnd(ptr2, end2);
664        uint32_t argsNum = cstrtovCStyle<uint32_t>(ptr2, end2, ptr2);
665        skipSpacesToLineEnd(ptr2, end2);
666        if (ptr2==end || *ptr2!=':')
667            throw ParseException(oldLineNo, "No colon after printf argsNum");
668        ptr2++;
669       
670        printfInfo.argSizes.resize(argsNum);
671       
672        // parse arg sizes
673        for (size_t i = 0; i < argsNum; i++)
674        {
675            skipSpacesToLineEnd(ptr2, end2);
676            printfInfo.argSizes[i] = cstrtovCStyle<uint32_t>(ptr2, end2, ptr2);
677            skipSpacesToLineEnd(ptr2, end2);
678            if (ptr2==end || *ptr2!=':')
679                throw ParseException(lineNo, "No colon after printf argsNum");
680            ptr2++;
681        }
682        // format
683        printfInfo.format.assign(ptr2, end2);
684       
685        printfInfos.push_back(printfInfo);
686    }
687};
688
689// skip YAML value after key
690static void skipYAMLValue(const char*& ptr, const char* end, size_t& lineNo,
691                cxuint prevIndent, bool singleValue = true)
692{
693    skipSpacesToLineEnd(ptr, end);
694    if (ptr+2 >= end && ptr[0]=='!' && ptr[1]=='!')
695    {   // skip !!xxxxx
696        ptr+=2;
697        while (ptr!=end && isAlpha(*ptr)) ptr++;
698        skipSpacesToLineEnd(ptr, end);
699    }
700   
701    if (ptr==end || (*ptr!='\'' && *ptr!='"' && *ptr!='|' && *ptr!='>' && *ptr !='[' &&
702                *ptr!='#' && *ptr!='\n'))
703    {
704        while (ptr!=end && *ptr!='\n') ptr++;
705        skipSpacesToNextLine(ptr, end, lineNo);
706        return;
707    }
708    // string
709    if (*ptr=='\'' || *ptr=='"')
710    {
711        const char delim = *ptr++;
712        bool escape = false;
713        while(ptr!=end && (escape || *ptr!=delim))
714        {
715            if (!escape && *ptr=='\\')
716                escape = true;
717            else if (escape)
718                escape = false;
719            if (*ptr=='\n') lineNo++;
720            ptr++;
721        }
722        if (ptr==end)
723            throw ParseException(lineNo, "Unterminated string");
724        ptr++;
725        if (singleValue)
726            skipSpacesToNextLine(ptr, end, lineNo);
727    }
728    else if (*ptr=='[')
729    {   // otherwise [array]
730        ptr++;
731        skipSpacesAndComments(ptr, end, lineNo);
732        while (ptr != end)
733        {
734            // parse in line
735            if (ptr!=end && (*ptr=='\'' || *ptr=='"'))
736                // skip YAML string
737                skipYAMLValue(ptr, end, lineNo, 0, false);
738            else
739                while (ptr!=end && *ptr!='\n' &&
740                            *ptr!='#' && *ptr!=',' && *ptr!=']') ptr++;
741            skipSpacesAndComments(ptr, end, lineNo);
742           
743            if (ptr!=end && *ptr==']')
744                // just end
745                break;
746            else if (ptr!=end && *ptr!=',')
747                throw ParseException(lineNo, "Expected ','");
748            ptr++;
749            skipSpacesAndComments(ptr, end, lineNo);
750        }
751        if (ptr == end)
752            throw ParseException(lineNo, "Unterminated array");
753        ptr++;
754        skipSpacesToNextLine(ptr, end, lineNo);
755    }
756    else
757    {   // block value
758        bool blockValue = false;
759        if (ptr!=end && (*ptr=='|' || *ptr=='>'))
760        {
761            ptr++; // skip '|' or '>'
762            blockValue = true;
763        }
764        if (ptr!=end && *ptr=='#')
765            while (ptr!=end && *ptr!='\n') ptr++;
766        else
767            skipSpacesToLineEnd(ptr, end);
768        if (ptr!=end && *ptr!='\n')
769            throw ParseException(lineNo, "Garbages before block or children");
770        ptr++;
771        lineNo++;
772        // skip all lines indented beyound previous level
773        while (ptr != end)
774        {
775            const char* lineStart = ptr;
776            skipSpacesToLineEnd(ptr, end);
777            if (ptr == end)
778            {
779                ptr++;
780                lineNo++;
781                continue;
782            }
783            if (size_t(ptr-lineStart) <= prevIndent && *ptr!='\n' &&
784                (blockValue || *ptr!='#'))
785                // if indent is short and not empty line (same spaces) or
786                // or with only comment and not blockValue
787            {
788                ptr = lineStart;
789                break;
790            }
791           
792            while (ptr!=end && *ptr!='\n') ptr++;
793            if (ptr!=end)
794            {
795                lineNo++;
796                ptr++;
797            }
798        }
799    }
800}
801
802enum {
803    ROCMMT_MAIN_KERNELS = 0, ROCMMT_MAIN_PRINTF,  ROCMMT_MAIN_VERSION
804};
805
806static const char* mainMetadataKeywords[] =
807{
808    "Kernels", "Printf", "Version"
809};
810
811static const size_t mainMetadataKeywordsNum =
812        sizeof(mainMetadataKeywords) / sizeof(const char*);
813
814enum {
815    ROCMMT_KERNEL_ARGS = 0, ROCMMT_KERNEL_ATTRS, ROCMMT_KERNEL_CODEPROPS,
816    ROCMMT_KERNEL_LANGUAGE, ROCMMT_KERNEL_LANGUAGE_VERSION,
817    ROCMMT_KERNEL_NAME, ROCMMT_KERNEL_SYMBOLNAME
818};
819
820static const char* kernelMetadataKeywords[] =
821{
822    "Args", "Attrs", "CodeProps", "Language", "LanguageVersion", "Name", "SymbolName"
823};
824
825static const size_t kernelMetadataKeywordsNum =
826        sizeof(kernelMetadataKeywords) / sizeof(const char*);
827
828enum {
829    ROCMMT_ATTRS_REQD_WORK_GROUP_SIZE = 0, ROCMMT_ATTRS_RUNTIME_HANDLE,
830    ROCMMT_ATTRS_VECTYPEHINT, ROCMMT_ATTRS_WORK_GROUP_SIZE_HINT
831};
832
833static const char* kernelAttrMetadataKeywords[] =
834{
835    "ReqdWorkGroupSize", "RuntimeHandle", "VecTypeHint", "WorkGroupSizeHint"
836};
837
838static const size_t kernelAttrMetadataKeywordsNum =
839        sizeof(kernelAttrMetadataKeywords) / sizeof(const char*);
840
841enum {
842    ROCMMT_CODEPROPS_FIXED_WORK_GROUP_SIZE = 0, ROCMMT_CODEPROPS_GROUP_SEGMENT_FIXED_SIZE,
843    ROCMMT_CODEPROPS_KERNARG_SEGMENT_ALIGN, ROCMMT_CODEPROPS_KERNARG_SEGMENT_SIZE,
844    ROCMMT_CODEPROPS_MAX_FLAT_WORK_GROUP_SIZE, ROCMMT_CODEPROPS_NUM_SGPRS,
845    ROCMMT_CODEPROPS_NUM_SPILLED_SGPRS, ROCMMT_CODEPROPS_NUM_SPILLED_VGPRS,
846    ROCMMT_CODEPROPS_NUM_VGPRS, ROCMMT_CODEPROPS_PRIVATE_SEGMENT_FIXED_SIZE,
847    ROCMMT_CODEPROPS_WAVEFRONT_SIZE
848};
849
850static const char* kernelCodePropsKeywords[] =
851{
852    "FixedWorkGroupSize", "GroupSegmentFixedSize", "KernargSegmentAlign",
853    "KernargSegmentSize", "MaxFlatWorkGroupSize", "NumSGPRs",
854    "NumSpilledSGPRs", "NumSpilledVGPRs", "NumVGPRs", "PrivateSegmentFixedSize",
855    "WavefrontSize"
856};
857
858static const size_t kernelCodePropsKeywordsNum =
859        sizeof(kernelCodePropsKeywords) / sizeof(const char*);
860
861enum {
862    ROCMMT_ARGS_ACCQUAL = 0, ROCMMT_ARGS_ACTUALACCQUAL, ROCMMT_ARGS_ADDRSPACEQUAL,
863    ROCMMT_ARGS_ALIGN, ROCMMT_ARGS_ISCONST, ROCMMT_ARGS_ISPIPE, ROCMMT_ARGS_ISRESTRICT,
864    ROCMMT_ARGS_ISVOLATILE, ROCMMT_ARGS_NAME, ROCMMT_ARGS_POINTEE_ALIGN,
865    ROCMMT_ARGS_SIZE, ROCMMT_ARGS_TYPENAME, ROCMMT_ARGS_VALUEKIND,
866    ROCMMT_ARGS_VALUETYPE
867};
868
869static const char* kernelArgInfosKeywords[] =
870{
871    "AccQual", "ActualAccQual", "AddrSpaceQual", "Align", "IsConst", "IsPipe",
872    "IsRestrict", "IsVolatile", "Name", "PointeeAlign", "Size", "TypeName",
873    "ValueKind", "ValueType"
874};
875
876static const size_t kernelArgInfosKeywordsNum =
877        sizeof(kernelArgInfosKeywords) / sizeof(const char*);
878
879static const std::pair<const char*, ROCmValueKind> rocmValueKindNamesMap[] =
880{
881    { "ByValue", ROCmValueKind::BY_VALUE },
882    { "DynamicSharedPointer", ROCmValueKind::DYN_SHARED_PTR },
883    { "GlobalBuffer", ROCmValueKind::GLOBAL_BUFFER },
884    { "HiddenCompletionAction", ROCmValueKind::HIDDEN_COMPLETION_ACTION },
885    { "HiddenDefaultQueue", ROCmValueKind::HIDDEN_DEFAULT_QUEUE },
886    { "HiddenGlobalOffsetX", ROCmValueKind::HIDDEN_GLOBAL_OFFSET_X },
887    { "HiddenGlobalOffsetY", ROCmValueKind::HIDDEN_GLOBAL_OFFSET_Y },
888    { "HiddenGlobalOffsetZ", ROCmValueKind::HIDDEN_GLOBAL_OFFSET_Z },
889    { "HiddenNone", ROCmValueKind::HIDDEN_NONE },
890    { "HiddenPrintfBuffer", ROCmValueKind::HIDDEN_PRINTF_BUFFER },
891    { "Image", ROCmValueKind::IMAGE },
892    { "Pipe", ROCmValueKind::PIPE },
893    { "Queue", ROCmValueKind::QUEUE },
894    { "Sampler", ROCmValueKind::SAMPLER }
895};
896
897static const size_t rocmValueKindNamesNum =
898        sizeof(rocmValueKindNamesMap) / sizeof(std::pair<const char*, ROCmValueKind>);
899
900static const std::pair<const char*, ROCmValueType> rocmValueTypeNamesMap[] =
901{
902    { "F16", ROCmValueType::FLOAT16 },
903    { "F32", ROCmValueType::FLOAT32 },
904    { "F64", ROCmValueType::FLOAT64 },
905    { "I16", ROCmValueType::INT16 },
906    { "I32", ROCmValueType::INT32 },
907    { "I64", ROCmValueType::INT64 },
908    { "I8", ROCmValueType::INT8 },
909    { "Struct", ROCmValueType::STRUCTURE },
910    { "U16", ROCmValueType::UINT16 },
911    { "U32", ROCmValueType::UINT32 },
912    { "U64", ROCmValueType::UINT64 },
913    { "U8", ROCmValueType::UINT8 }
914};
915
916static const size_t rocmValueTypeNamesNum =
917        sizeof(rocmValueTypeNamesMap) / sizeof(std::pair<const char*, ROCmValueType>);
918
919static const char* rocmAddrSpaceTypesTbl[] =
920{ "Private", "Global", "Constant", "Local", "Generic", "Region" };
921
922static const char* rocmAccessQualifierTbl[] =
923{ "Default", "ReadOnly", "WriteOnly", "ReadWrite" };
924
925static void parseROCmMetadata(size_t metadataSize, const char* metadata,
926                ROCmMetadata& metadataInfo)
927{
928    const char* ptr = metadata;
929    const char* end = metadata + metadataSize;
930    size_t lineNo = 1;
931    // init metadata info object
932    metadataInfo.kernels.clear();
933    metadataInfo.printfInfos.clear();
934    metadataInfo.version[0] = metadataInfo.version[1] = 0;
935   
936    std::vector<ROCmKernelMetadata>& kernels = metadataInfo.kernels;
937   
938    cxuint levels[6] = { UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX };
939    cxuint curLevel = 0;
940    bool inKernels = false;
941    bool inKernel = false;
942    bool inKernelArgs = false;
943    bool inKernelArg = false;
944    bool inKernelCodeProps = false;
945    bool inKernelAttrs = false;
946    bool canToNextLevel = false;
947   
948    size_t oldLineNo = 0;
949    while (ptr != end)
950    {
951        cxuint level = skipSpacesAndComments(ptr, end, lineNo);
952        if (ptr == end || lineNo == oldLineNo)
953            throw ParseException(lineNo, "Expected new line");
954       
955        if (levels[curLevel] == UINT_MAX)
956            levels[curLevel] = level;
957        else if (levels[curLevel] < level)
958        {
959            if (canToNextLevel)
960                // go to next nesting level
961                levels[++curLevel] = level;
962            else
963                throw ParseException(lineNo, "Unexpected nesting level");
964            canToNextLevel = false;
965        }
966        else if (levels[curLevel] > level)
967        {
968            while (curLevel != UINT_MAX && levels[curLevel] > level)
969                curLevel--;
970            if (curLevel == UINT_MAX)
971                throw ParseException(lineNo, "Indentation smaller than in main level");
972           
973            // pop from previous level
974            if (curLevel < 3)
975            {
976                if (inKernelArgs)
977                {
978                    // leave from kernel args
979                    inKernelArgs = false;
980                    inKernelArg = false;
981                }
982           
983                inKernelCodeProps = false;
984                inKernelAttrs = false;
985            }
986            if (curLevel < 1 && inKernels)
987            {
988                // leave from kernels
989                inKernels = false;
990                inKernel = false;
991            }
992           
993            if (levels[curLevel] != level)
994                throw ParseException(lineNo, "Unexpected nesting level");
995        }
996       
997        oldLineNo = lineNo;
998        if (curLevel == 0)
999        {
1000            if (lineNo==1 && ptr+3 <= end && *ptr=='-' && ptr[1]=='-' && ptr[2]=='-' &&
1001                (ptr+3==end || (ptr+3 < end && ptr[3]=='\n')))
1002            {
1003                ptr += 3;
1004                if (ptr!=end)
1005                {
1006                    lineNo++;
1007                    ptr++; // to newline
1008                }
1009                continue; // skip document start
1010            }
1011           
1012            if (ptr+3 <= end && *ptr=='.' && ptr[1]=='.' && ptr[2]=='.' &&
1013                (ptr+3==end || (ptr+3 < end && ptr[3]=='\n')))
1014                break; // end of the document
1015           
1016            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1017                        mainMetadataKeywordsNum, mainMetadataKeywords);
1018           
1019            switch(keyIndex)
1020            {
1021                case ROCMMT_MAIN_KERNELS:
1022                    inKernels = true;
1023                    canToNextLevel = true;
1024                    break;
1025                case ROCMMT_MAIN_PRINTF:
1026                {
1027                    YAMLPrintfVectorConsumer consumer(metadataInfo.printfInfos);
1028                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer, true);
1029                    break;
1030                }
1031                case ROCMMT_MAIN_VERSION:
1032                {
1033                    YAMLIntArrayConsumer<uint32_t> consumer(2, metadataInfo.version);
1034                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer, true);
1035                    break;
1036                }
1037                default:
1038                    skipYAMLValue(ptr, end, lineNo, level);
1039                    break;
1040            }
1041        }
1042       
1043        if (curLevel==1 && inKernels)
1044        {
1045            // enter to kernel level
1046            if (ptr == end || *ptr != '-')
1047                throw ParseException(lineNo, "No '-' before kernel object");
1048            ptr++;
1049            const char* afterMinus = ptr;
1050            skipSpacesToLineEnd(ptr, end);
1051            levels[++curLevel] = level + 1 + ptr-afterMinus;
1052            level = levels[curLevel];
1053            inKernel = true;
1054           
1055            kernels.push_back(ROCmKernelMetadata());
1056            kernels.back().initialize();
1057        }
1058       
1059        if (curLevel==2 && inKernel)
1060        {
1061            // in kernel
1062            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1063                        kernelMetadataKeywordsNum, kernelMetadataKeywords);
1064           
1065            ROCmKernelMetadata& kernel = kernels.back();
1066            switch(keyIndex)
1067            {
1068                case ROCMMT_KERNEL_ARGS:
1069                    inKernelArgs = true;
1070                    canToNextLevel = true;
1071                    kernel.argInfos.clear();
1072                    break;
1073                case ROCMMT_KERNEL_ATTRS:
1074                    inKernelAttrs = true;
1075                    canToNextLevel = true;
1076                    // initialize kernel attributes values
1077                    kernel.reqdWorkGroupSize[0] = 0;
1078                    kernel.reqdWorkGroupSize[1] = 0;
1079                    kernel.reqdWorkGroupSize[2] = 0;
1080                    kernel.workGroupSizeHint[0] = 0;
1081                    kernel.workGroupSizeHint[1] = 0;
1082                    kernel.workGroupSizeHint[2] = 0;
1083                    kernel.runtimeHandle.clear();
1084                    kernel.vecTypeHint.clear();
1085                    break;
1086                case ROCMMT_KERNEL_CODEPROPS:
1087                    // initialize CodeProps values
1088                    kernel.kernargSegmentSize = BINGEN64_DEFAULT;
1089                    kernel.groupSegmentFixedSize = BINGEN64_DEFAULT;
1090                    kernel.privateSegmentFixedSize = BINGEN64_DEFAULT;
1091                    kernel.kernargSegmentAlign = BINGEN64_DEFAULT;
1092                    kernel.wavefrontSize = BINGEN_DEFAULT;
1093                    kernel.sgprsNum = BINGEN_DEFAULT;
1094                    kernel.vgprsNum = BINGEN_DEFAULT;
1095                    kernel.spilledSgprs = BINGEN_NOTSUPPLIED;
1096                    kernel.spilledVgprs = BINGEN_NOTSUPPLIED;
1097                    kernel.maxFlatWorkGroupSize = BINGEN64_DEFAULT;
1098                    kernel.fixedWorkGroupSize[0] = 0;
1099                    kernel.fixedWorkGroupSize[1] = 0;
1100                    kernel.fixedWorkGroupSize[2] = 0;
1101                    inKernelCodeProps = true;
1102                    canToNextLevel = true;
1103                    break;
1104                case ROCMMT_KERNEL_LANGUAGE:
1105                    kernel.language = parseYAMLStringValue(ptr, end, lineNo, level, true);
1106                    break;
1107                case ROCMMT_KERNEL_LANGUAGE_VERSION:
1108                {
1109                    YAMLIntArrayConsumer<uint32_t> consumer(2, kernel.langVersion);
1110                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer);
1111                    break;
1112                }
1113                case ROCMMT_KERNEL_NAME:
1114                    kernel.name = parseYAMLStringValue(ptr, end, lineNo, level, true);
1115                    break;
1116                case ROCMMT_KERNEL_SYMBOLNAME:
1117                    kernel.symbolName = parseYAMLStringValue(ptr, end, lineNo, level, true);
1118                    break;
1119                default:
1120                    skipYAMLValue(ptr, end, lineNo, level);
1121                    break;
1122            }
1123        }
1124       
1125        if (curLevel==3 && inKernelAttrs)
1126        {
1127            // in kernel attributes
1128            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1129                        kernelAttrMetadataKeywordsNum, kernelAttrMetadataKeywords);
1130           
1131            ROCmKernelMetadata& kernel = kernels.back();
1132            switch(keyIndex)
1133            {
1134                case ROCMMT_ATTRS_REQD_WORK_GROUP_SIZE:
1135                {
1136                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.reqdWorkGroupSize);
1137                    parseYAMLValArray(ptr, end, lineNo, level, &consumer);
1138                    break;
1139                }
1140                case ROCMMT_ATTRS_RUNTIME_HANDLE:
1141                    kernel.runtimeHandle = parseYAMLStringValue(
1142                                ptr, end, lineNo, level, true);
1143                    break;
1144                case ROCMMT_ATTRS_VECTYPEHINT:
1145                    kernel.vecTypeHint = parseYAMLStringValue(
1146                                ptr, end, lineNo, level, true);
1147                    break;
1148                case ROCMMT_ATTRS_WORK_GROUP_SIZE_HINT:
1149                {
1150                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.workGroupSizeHint);
1151                    parseYAMLValArray(ptr, end, lineNo, level, &consumer, true);
1152                    break;
1153                }
1154                default:
1155                    skipYAMLValue(ptr, end, lineNo, level);
1156                    break;
1157            }
1158        }
1159       
1160        if (curLevel==3 && inKernelCodeProps)
1161        {
1162            // in kernel codeProps
1163            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1164                        kernelCodePropsKeywordsNum, kernelCodePropsKeywords);
1165           
1166            ROCmKernelMetadata& kernel = kernels.back();
1167            switch(keyIndex)
1168            {
1169                case ROCMMT_CODEPROPS_FIXED_WORK_GROUP_SIZE:
1170                {
1171                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.fixedWorkGroupSize);
1172                    parseYAMLValArray(ptr, end, lineNo, level, &consumer);
1173                    break;
1174                }
1175                case ROCMMT_CODEPROPS_GROUP_SEGMENT_FIXED_SIZE:
1176                    kernel.groupSegmentFixedSize =
1177                                parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1178                    break;
1179                case ROCMMT_CODEPROPS_KERNARG_SEGMENT_ALIGN:
1180                    kernel.kernargSegmentAlign =
1181                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1182                    break;
1183                case ROCMMT_CODEPROPS_KERNARG_SEGMENT_SIZE:
1184                    kernel.kernargSegmentSize =
1185                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1186                    break;
1187                case ROCMMT_CODEPROPS_MAX_FLAT_WORK_GROUP_SIZE:
1188                    kernel.maxFlatWorkGroupSize =
1189                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1190                    break;
1191                case ROCMMT_CODEPROPS_NUM_SGPRS:
1192                    kernel.sgprsNum = parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1193                    break;
1194                case ROCMMT_CODEPROPS_NUM_SPILLED_SGPRS:
1195                    kernel.spilledSgprs =
1196                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1197                    break;
1198                case ROCMMT_CODEPROPS_NUM_SPILLED_VGPRS:
1199                    kernel.spilledVgprs =
1200                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1201                    break;
1202                case ROCMMT_CODEPROPS_NUM_VGPRS:
1203                    kernel.vgprsNum = parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1204                    break;
1205                case ROCMMT_CODEPROPS_PRIVATE_SEGMENT_FIXED_SIZE:
1206                    kernel.privateSegmentFixedSize =
1207                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1208                    break;
1209                case ROCMMT_CODEPROPS_WAVEFRONT_SIZE:
1210                    kernel.wavefrontSize =
1211                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1212                    break;
1213                default:
1214                    skipYAMLValue(ptr, end, lineNo, level);
1215                    break;
1216            }
1217        }
1218       
1219        if (curLevel==3 && inKernelArgs)
1220        {
1221            // enter to kernel argument level
1222            if (ptr == end || *ptr != '-')
1223                throw ParseException(lineNo, "No '-' before argument object");
1224            ptr++;
1225            const char* afterMinus = ptr;
1226            skipSpacesToLineEnd(ptr, end);
1227            levels[++curLevel] = level + 1 + ptr-afterMinus;
1228            level = levels[curLevel];
1229            inKernelArg = true;
1230           
1231            kernels.back().argInfos.push_back(ROCmKernelArgInfo{});
1232        }
1233       
1234        if (curLevel==4 && inKernelArg)
1235        {
1236            // in kernel argument
1237            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1238                        kernelArgInfosKeywordsNum, kernelArgInfosKeywords);
1239           
1240            ROCmKernelArgInfo& kernelArg = kernels.back().argInfos.back();
1241           
1242            size_t valLineNo = lineNo;
1243            switch(keyIndex)
1244            {
1245                case ROCMMT_ARGS_ACCQUAL:
1246                case ROCMMT_ARGS_ACTUALACCQUAL:
1247                {
1248                    const std::string acc = trimStrSpaces(parseYAMLStringValue(
1249                                    ptr, end, lineNo, level, true));
1250                    size_t accIndex = 0;
1251                    for (; accIndex < 6; accIndex++)
1252                        if (::strcmp(rocmAccessQualifierTbl[accIndex], acc.c_str())==0)
1253                            break;
1254                    if (accIndex == 4)
1255                        throw ParseException(lineNo, "Wrong access qualifier");
1256                    if (keyIndex == ROCMMT_ARGS_ACCQUAL)
1257                        kernelArg.accessQual = ROCmAccessQual(accIndex);
1258                    else
1259                        kernelArg.actualAccessQual = ROCmAccessQual(accIndex);
1260                    break;
1261                }
1262                case ROCMMT_ARGS_ADDRSPACEQUAL:
1263                {
1264                    const std::string aspace = trimStrSpaces(parseYAMLStringValue(
1265                                    ptr, end, lineNo, level, true));
1266                    size_t aspaceIndex = 0;
1267                    for (; aspaceIndex < 6; aspaceIndex++)
1268                        if (::strcmp(rocmAddrSpaceTypesTbl[aspaceIndex],
1269                                    aspace.c_str())==0)
1270                            break;
1271                    if (aspaceIndex == 6)
1272                        throw ParseException(valLineNo, "Wrong address space");
1273                    kernelArg.addressSpace = ROCmAddressSpace(aspaceIndex+1);
1274                    break;
1275                }
1276                case ROCMMT_ARGS_ALIGN:
1277                    kernelArg.align = parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1278                    break;
1279                case ROCMMT_ARGS_ISCONST:
1280                    kernelArg.isConst = parseYAMLBoolValue(ptr, end, lineNo, true);
1281                    break;
1282                case ROCMMT_ARGS_ISPIPE:
1283                    kernelArg.isPipe = parseYAMLBoolValue(ptr, end, lineNo, true);
1284                    break;
1285                case ROCMMT_ARGS_ISRESTRICT:
1286                    kernelArg.isRestrict = parseYAMLBoolValue(ptr, end, lineNo, true);
1287                    break;
1288                case ROCMMT_ARGS_ISVOLATILE:
1289                    kernelArg.isVolatile = parseYAMLBoolValue(ptr, end, lineNo, true);
1290                    break;
1291                case ROCMMT_ARGS_NAME:
1292                    kernelArg.name = parseYAMLStringValue(ptr, end, lineNo, level, true);
1293                    break;
1294                case ROCMMT_ARGS_POINTEE_ALIGN:
1295                    kernelArg.pointeeAlign =
1296                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1297                    break;
1298                case ROCMMT_ARGS_SIZE:
1299                    kernelArg.size = parseYAMLIntValue<uint64_t>(ptr, end, lineNo);
1300                    break;
1301                case ROCMMT_ARGS_TYPENAME:
1302                    kernelArg.typeName =
1303                                parseYAMLStringValue(ptr, end, lineNo, level, true);
1304                    break;
1305                case ROCMMT_ARGS_VALUEKIND:
1306                {
1307                    const std::string vkind = trimStrSpaces(parseYAMLStringValue(
1308                                ptr, end, lineNo, level, true));
1309                    const size_t vkindIndex = binaryMapFind(rocmValueKindNamesMap,
1310                            rocmValueKindNamesMap + rocmValueKindNamesNum, vkind.c_str(),
1311                            CStringLess()) - rocmValueKindNamesMap;
1312                    // if unknown kind
1313                    if (vkindIndex == rocmValueKindNamesNum)
1314                        throw ParseException(valLineNo, "Wrong argument value kind");
1315                    kernelArg.valueKind = rocmValueKindNamesMap[vkindIndex].second;
1316                    break;
1317                }
1318                case ROCMMT_ARGS_VALUETYPE:
1319                {
1320                    const std::string vtype = trimStrSpaces(parseYAMLStringValue(
1321                                    ptr, end, lineNo, level, true));
1322                    const size_t vtypeIndex = binaryMapFind(rocmValueTypeNamesMap,
1323                            rocmValueTypeNamesMap + rocmValueTypeNamesNum, vtype.c_str(),
1324                            CStringLess()) - rocmValueTypeNamesMap;
1325                    // if unknown type
1326                    if (vtypeIndex == rocmValueTypeNamesNum)
1327                        throw ParseException(valLineNo, "Wrong argument value type");
1328                    kernelArg.valueType = rocmValueTypeNamesMap[vtypeIndex].second;
1329                    break;
1330                }
1331                default:
1332                    skipYAMLValue(ptr, end, lineNo, level);
1333                    break;
1334            }
1335        }
1336    }
1337}
1338
1339void ROCmMetadata::parse(size_t metadataSize, const char* metadata)
1340{
1341    parseROCmMetadata(metadataSize, metadata, *this);
1342}
1343
1344/*
1345 * ROCm binary reader and generator
1346 */
1347
1348/* TODO: add support for various kernel code offset (now only 256 is supported) */
1349
1350ROCmBinary::ROCmBinary(size_t binaryCodeSize, cxbyte* binaryCode, Flags creationFlags)
1351        : ElfBinary64(binaryCodeSize, binaryCode, creationFlags),
1352          regionsNum(0), codeSize(0), code(nullptr),
1353          globalDataSize(0), globalData(nullptr), metadataSize(0), metadata(nullptr),
1354          newBinFormat(false)
1355{
1356    cxuint textIndex = SHN_UNDEF;
1357    try
1358    { textIndex = getSectionIndex(".text"); }
1359    catch(const Exception& ex)
1360    { } // ignore failed
1361    uint64_t codeOffset = 0;
1362    // find '.text' section
1363    if (textIndex!=SHN_UNDEF)
1364    {
1365        code = getSectionContent(textIndex);
1366        const Elf64_Shdr& textShdr = getSectionHeader(textIndex);
1367        codeSize = ULEV(textShdr.sh_size);
1368        codeOffset = ULEV(textShdr.sh_offset);
1369    }
1370   
1371    cxuint rodataIndex = SHN_UNDEF;
1372    try
1373    { rodataIndex = getSectionIndex(".rodata"); }
1374    catch(const Exception& ex)
1375    { } // ignore failed
1376    // find '.text' section
1377    if (rodataIndex!=SHN_UNDEF)
1378    {
1379        globalData = getSectionContent(rodataIndex);
1380        const Elf64_Shdr& rodataShdr = getSectionHeader(rodataIndex);
1381        globalDataSize = ULEV(rodataShdr.sh_size);
1382    }
1383   
1384    cxuint gpuConfigIndex = SHN_UNDEF;
1385    try
1386    { gpuConfigIndex = getSectionIndex(".AMDGPU.config"); }
1387    catch(const Exception& ex)
1388    { } // ignore failed
1389    newBinFormat = (gpuConfigIndex == SHN_UNDEF);
1390   
1391    cxuint relaDynIndex = SHN_UNDEF;
1392    try
1393    { relaDynIndex = getSectionIndex(".rela.dyn"); }
1394    catch(const Exception& ex)
1395    { } // ignore failed
1396   
1397    cxuint gotIndex = SHN_UNDEF;
1398    try
1399    { gotIndex = getSectionIndex(".got"); }
1400    catch(const Exception& ex)
1401    { } // ignore failed
1402   
1403    // counts regions (symbol or kernel)
1404    regionsNum = 0;
1405    const size_t symbolsNum = getSymbolsNum();
1406    for (size_t i = 0; i < symbolsNum; i++)
1407    {
1408        // count regions number
1409        const Elf64_Sym& sym = getSymbol(i);
1410        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
1411        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
1412        if (ULEV(sym.st_shndx)==textIndex &&
1413            (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
1414                (bind==STB_GLOBAL && symType==STT_OBJECT)))
1415            regionsNum++;
1416    }
1417    if (code==nullptr && regionsNum!=0)
1418        throw BinException("No code if regions number is not zero");
1419    regions.reset(new ROCmRegion[regionsNum]);
1420    size_t j = 0;
1421    typedef std::pair<uint64_t, size_t> RegionOffsetEntry;
1422    std::unique_ptr<RegionOffsetEntry[]> symOffsets(new RegionOffsetEntry[regionsNum]);
1423   
1424    // get regions info
1425    for (size_t i = 0; i < symbolsNum; i++)
1426    {
1427        const Elf64_Sym& sym = getSymbol(i);
1428        if (ULEV(sym.st_shndx)!=textIndex)
1429            continue;   // if not in '.text' section
1430        const size_t value = ULEV(sym.st_value);
1431        if (value < codeOffset)
1432            throw BinException("Region offset is too small!");
1433        const size_t size = ULEV(sym.st_size);
1434       
1435        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
1436        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
1437        if (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
1438                (bind==STB_GLOBAL && symType==STT_OBJECT))
1439        {
1440            ROCmRegionType type = ROCmRegionType::DATA;
1441            // if kernel
1442            if (symType==STT_GNU_IFUNC) 
1443                type = ROCmRegionType::KERNEL;
1444            // if function kernel
1445            else if (symType==STT_FUNC)
1446                type = ROCmRegionType::FKERNEL;
1447            symOffsets[j] = std::make_pair(value, j);
1448            if (type!=ROCmRegionType::DATA && value+0x100 > codeOffset+codeSize)
1449                throw BinException("Kernel or code offset is too big!");
1450            regions[j++] = { getSymbolName(i), size, value, type };
1451        }
1452    }
1453    // sort regions by offset
1454    std::sort(symOffsets.get(), symOffsets.get()+regionsNum,
1455            [](const RegionOffsetEntry& a, const RegionOffsetEntry& b)
1456            { return a.first < b.first; });
1457    // checking distance between regions
1458    for (size_t i = 1; i <= regionsNum; i++)
1459    {
1460        size_t end = (i<regionsNum) ? symOffsets[i].first : codeOffset+codeSize;
1461        ROCmRegion& region = regions[symOffsets[i-1].second];
1462        if (region.type==ROCmRegionType::KERNEL && symOffsets[i-1].first+0x100 > end)
1463            throw BinException("Kernel size is too small!");
1464       
1465        const size_t regSize = end - symOffsets[i-1].first;
1466        if (region.size==0)
1467            region.size = regSize;
1468        else
1469            region.size = std::min(regSize, region.size);
1470    }
1471   
1472    // load got symbols
1473    if (relaDynIndex != SHN_UNDEF && gotIndex != SHN_UNDEF)
1474    {
1475        const Elf64_Shdr& relaShdr = getSectionHeader(relaDynIndex);
1476        const Elf64_Shdr& gotShdr = getSectionHeader(gotIndex);
1477       
1478        size_t relaEntrySize = ULEV(relaShdr.sh_entsize);
1479        if (relaEntrySize==0)
1480            relaEntrySize = sizeof(Elf64_Rela);
1481        const size_t relaEntriesNum = ULEV(relaShdr.sh_size)/relaEntrySize;
1482        const size_t gotEntriesNum = ULEV(gotShdr.sh_size) >> 3;
1483        if (gotEntriesNum != relaEntriesNum)
1484            throw BinException("RelaDyn entries number and GOT entries "
1485                        "number doesn't match!");
1486       
1487        // initialize GOT symbols table
1488        gotSymbols.resize(gotEntriesNum);
1489        const cxbyte* relaDyn = getSectionContent(relaDynIndex);
1490        for (size_t i = 0; i < relaEntriesNum; i++)
1491        {
1492            const Elf64_Rela& rela = *reinterpret_cast<const Elf64_Rela*>(
1493                            relaDyn + relaEntrySize*i);
1494            // check rela entry fields
1495            if (ULEV(rela.r_offset) != ULEV(gotShdr.sh_offset) + i*8)
1496                throw BinException("Wrong dyn relocation offset");
1497            if (ULEV(rela.r_addend) != 0ULL)
1498                throw BinException("Wrong dyn relocation addend");
1499            size_t symIndex = ELF64_R_SYM(ULEV(rela.r_info));
1500            if (symIndex >= getDynSymbolsNum())
1501                throw BinException("Dyn relocation symbol index out of range");
1502            // just set in gotSymbols
1503            gotSymbols[i] = symIndex;
1504        }
1505    }
1506   
1507    // get metadata
1508    const size_t notesSize = getNotesSize();
1509    const cxbyte* noteContent = (const cxbyte*)getNotes();
1510   
1511    for (size_t offset = 0; offset < notesSize; )
1512    {
1513        const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
1514        size_t namesz = ULEV(nhdr->n_namesz);
1515        size_t descsz = ULEV(nhdr->n_descsz);
1516        if (usumGt(offset, namesz+descsz, notesSize))
1517            throw BinException("Note offset+size out of range");
1518       
1519        if (namesz==4 &&
1520            ::strcmp((const char*)noteContent+offset+ sizeof(Elf64_Nhdr), "AMD")==0)
1521        {
1522            const uint32_t noteType = ULEV(nhdr->n_type);
1523            if (noteType == 0xa)
1524            {
1525                metadata = (char*)(noteContent+offset+sizeof(Elf64_Nhdr) + 4);
1526                metadataSize = descsz;
1527            }
1528            else if (noteType == 0xb)
1529                target.assign((char*)(noteContent+offset+sizeof(Elf64_Nhdr) + 4), descsz);
1530        }
1531        size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
1532        offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
1533    }
1534   
1535    if (hasRegionMap())
1536    {
1537        // create region map
1538        regionsMap.resize(regionsNum);
1539        for (size_t i = 0; i < regionsNum; i++)
1540            regionsMap[i] = std::make_pair(regions[i].regionName, i);
1541        // sort region map
1542        mapSort(regionsMap.begin(), regionsMap.end());
1543    }
1544   
1545    if ((creationFlags & ROCMBIN_CREATE_METADATAINFO) != 0 &&
1546        metadata != nullptr && metadataSize != 0)
1547    {
1548        metadataInfo.reset(new ROCmMetadata());
1549        parseROCmMetadata(metadataSize, metadata, *metadataInfo);
1550       
1551        if (hasKernelInfoMap())
1552        {
1553            const std::vector<ROCmKernelMetadata>& kernels = metadataInfo->kernels;
1554            kernelInfosMap.resize(kernels.size());
1555            for (size_t i = 0; i < kernelInfosMap.size(); i++)
1556                kernelInfosMap[i] = std::make_pair(kernels[i].name, i);
1557            // sort region map
1558            mapSort(kernelInfosMap.begin(), kernelInfosMap.end());
1559        }
1560    }
1561}
1562
1563/// determint GPU device from ROCm notes
1564GPUDeviceType ROCmBinary::determineGPUDeviceType(uint32_t& outArchMinor,
1565                     uint32_t& outArchStepping) const
1566{
1567    uint32_t archMajor = 0;
1568    uint32_t archMinor = 0;
1569    uint32_t archStepping = 0;
1570   
1571    {
1572        const cxbyte* noteContent = (const cxbyte*)getNotes();
1573        if (noteContent==nullptr)
1574            throw BinException("Missing notes in inner binary!");
1575        size_t notesSize = getNotesSize();
1576        // find note about AMDGPU
1577        for (size_t offset = 0; offset < notesSize; )
1578        {
1579            const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
1580            size_t namesz = ULEV(nhdr->n_namesz);
1581            size_t descsz = ULEV(nhdr->n_descsz);
1582            if (usumGt(offset, namesz+descsz, notesSize))
1583                throw BinException("Note offset+size out of range");
1584            if (ULEV(nhdr->n_type) == 0x3 && namesz==4 && descsz>=0x1a &&
1585                ::strcmp((const char*)noteContent+offset+sizeof(Elf64_Nhdr), "AMD")==0)
1586            {    // AMDGPU type
1587                const uint32_t* content = (const uint32_t*)
1588                        (noteContent+offset+sizeof(Elf64_Nhdr) + 4);
1589                archMajor = ULEV(content[1]);
1590                archMinor = ULEV(content[2]);
1591                archStepping = ULEV(content[3]);
1592            }
1593            size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
1594            offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
1595        }
1596    }
1597    // determine device type
1598    GPUDeviceType deviceType = getGPUDeviceTypeFromArchVersion(archMajor, archMinor,
1599                                    archStepping);
1600    outArchMinor = archMinor;
1601    outArchStepping = archStepping;
1602    return deviceType;
1603}
1604
1605const ROCmRegion& ROCmBinary::getRegion(const char* name) const
1606{
1607    RegionMap::const_iterator it = binaryMapFind(regionsMap.begin(),
1608                             regionsMap.end(), name);
1609    if (it == regionsMap.end())
1610        throw BinException("Can't find region name");
1611    return regions[it->second];
1612}
1613
1614const ROCmKernelMetadata& ROCmBinary::getKernelInfo(const char* name) const
1615{
1616    if (!hasMetadataInfo())
1617        throw BinException("Can't find kernel info name");
1618    RegionMap::const_iterator it = binaryMapFind(kernelInfosMap.begin(),
1619                             kernelInfosMap.end(), name);
1620    if (it == kernelInfosMap.end())
1621        throw BinException("Can't find kernel info name");
1622    return metadataInfo->kernels[it->second];
1623}
1624
1625// if ROCm binary
1626bool CLRX::isROCmBinary(size_t binarySize, const cxbyte* binary)
1627{
1628    if (!isElfBinary(binarySize, binary))
1629        return false;
1630    if (binary[EI_CLASS] != ELFCLASS64)
1631        return false;
1632    const Elf64_Ehdr* ehdr = reinterpret_cast<const Elf64_Ehdr*>(binary);
1633    if (ULEV(ehdr->e_machine) != 0xe0)
1634        return false;
1635    return true;
1636}
1637
1638
1639void ROCmInput::addEmptyKernel(const char* kernelName)
1640{
1641    symbols.push_back({ kernelName, 0, 0, ROCmRegionType::KERNEL });
1642}
1643
1644/*
1645 * ROCm YAML metadata generator
1646 */
1647
1648static const char* rocmValueKindNames[] =
1649{
1650    "ByValue", "GlobalBuffer", "DynamicSharedPointer", "Sampler", "Image", "Pipe", "Queue",
1651    "HiddenGlobalOffsetX", "HiddenGlobalOffsetY", "HiddenGlobalOffsetZ", "HiddenNone",
1652    "HiddenPrintfBuffer", "HiddenDefaultQueue", "HiddenCompletionAction"
1653};
1654
1655static const char* rocmValueTypeNames[] =
1656{
1657    "Struct", "I8", "U8", "I16", "U16", "F16", "I32", "U32", "F32", "I64", "U64", "F64"
1658};
1659
1660static void genArrayValue(cxuint n, const cxuint* values, std::string& output)
1661{
1662    char numBuf[24];
1663    output += "[ ";
1664    for (cxuint i = 0; i < n; i++)
1665    {
1666        itocstrCStyle(values[i], numBuf, 24);
1667        output += numBuf;
1668        output += (i+1<n) ? ", " : " ]\n";
1669    }
1670}
1671
1672// helper for checking whether value is supplied
1673static inline bool hasValue(cxuint value)
1674{ return value!=BINGEN_NOTSUPPLIED && value!=BINGEN_DEFAULT; }
1675
1676static inline bool hasValue(uint64_t value)
1677{ return value!=BINGEN64_NOTSUPPLIED && value!=BINGEN64_DEFAULT; }
1678
1679// get escaped YAML string if needed, otherwise get this same string
1680static std::string escapeYAMLString(const CString& input)
1681{
1682    bool toEscape = false;
1683    const char* s;
1684    for (s = input.c_str(); *s!=0; s++)
1685    {
1686        cxbyte c = *s;
1687        if (c < 0x20 || c >= 0x80 || c=='*' || c=='&' || c=='!' || c=='@' ||
1688            c=='\'' || c=='\"')
1689            toEscape = true;
1690    }
1691    // if spaces in begin and end
1692    if (isSpace(input[0]) || isDigit(input[0]) ||
1693        (!input.empty() && isSpace(s[-1])))
1694        toEscape = true;
1695   
1696    if (toEscape)
1697    {
1698        std::string out = "'";
1699        out += escapeStringCStyle(s-input.c_str(), input.c_str());
1700        out += "'";
1701        return out;
1702    }
1703    return input.c_str();
1704}
1705
1706static std::string escapePrintfFormat(const std::string& fmt)
1707{
1708    std::string out;
1709    out.reserve(fmt.size());
1710    for (char c: fmt)
1711        if (c!=':')
1712            out.push_back(c);
1713        else
1714            out += "\\72";
1715    return out;
1716}
1717
1718static void generateROCmMetadata(const ROCmMetadata& mdInfo,
1719                    const ROCmKernelConfig** kconfigs, std::string& output)
1720{
1721    output.clear();
1722    char numBuf[24];
1723    output += "---\n";
1724    // version
1725    output += "Version:         ";
1726    if (hasValue(mdInfo.version[0]))
1727        genArrayValue(2, mdInfo.version, output);
1728    else // default
1729        output += "[ 1, 0 ]\n";
1730    if (!mdInfo.printfInfos.empty())
1731        output += "Printf:          \n";
1732    // check print ids uniquness
1733    {
1734        std::unordered_set<cxuint> printfIds;
1735        for (const ROCmPrintfInfo& printfInfo: mdInfo.printfInfos)
1736            if (printfInfo.id!=BINGEN_DEFAULT)
1737                if (!printfIds.insert(printfInfo.id).second)
1738                    throw BinGenException("Duplicate of printf id");
1739        // printfs
1740        uint32_t freePrintfId = 1;
1741        for (const ROCmPrintfInfo& printfInfo: mdInfo.printfInfos)
1742        {
1743            // skip used printfids;
1744            uint32_t printfId = printfInfo.id;
1745            if (printfId == BINGEN_DEFAULT)
1746            {
1747                // skip used printfids
1748                for (; printfIds.find(freePrintfId) != printfIds.end(); ++freePrintfId);
1749                // just use this free printfid
1750                printfId = freePrintfId++;
1751            }
1752           
1753            output += "  - '";
1754            itocstrCStyle(printfId, numBuf, 24);
1755            output += numBuf;
1756            output += ':';
1757            itocstrCStyle(printfInfo.argSizes.size(), numBuf, 24);
1758            output += numBuf;
1759            output += ':';
1760            for (size_t argSize: printfInfo.argSizes)
1761            {
1762                itocstrCStyle(argSize, numBuf, 24);
1763                output += numBuf;
1764                output += ':';
1765            }
1766            // printf format
1767            std::string escapedFmt = escapeStringCStyle(printfInfo.format);
1768            escapedFmt = escapePrintfFormat(escapedFmt);
1769            output += escapedFmt;
1770            output += "'\n";
1771        }
1772    }
1773   
1774    if (!mdInfo.kernels.empty())
1775        output += "Kernels:         \n";
1776    // kernels
1777    for (size_t i = 0; i < mdInfo.kernels.size(); i++)
1778    {
1779        const ROCmKernelMetadata& kernel = mdInfo.kernels[i];
1780        output += "  - Name:            ";
1781        output.append(kernel.name.c_str(), kernel.name.size());
1782        output += "\n    SymbolName:      ";
1783        if (!kernel.symbolName.empty())
1784            output += escapeYAMLString(kernel.symbolName);
1785        else
1786        {
1787            // default is kernel name + '@kd'
1788            std::string symName = kernel.name.c_str();
1789            symName += "@kd";
1790            output += escapeYAMLString(symName);
1791        }
1792        output += "\n";
1793        if (!kernel.language.empty())
1794        {
1795            output += "    Language:        ";
1796            output += escapeYAMLString(kernel.language);
1797            output += "\n";
1798        }
1799        if (kernel.langVersion[0] != BINGEN_NOTSUPPLIED)
1800        {
1801            output += "    LanguageVersion: ";
1802            genArrayValue(2, kernel.langVersion, output);
1803        }
1804        // kernel attributes
1805        if (kernel.reqdWorkGroupSize[0] != 0 || kernel.reqdWorkGroupSize[1] != 0 ||
1806            kernel.reqdWorkGroupSize[2] != 0 ||
1807            kernel.workGroupSizeHint[0] != 0 || kernel.workGroupSizeHint[1] != 0 ||
1808            kernel.workGroupSizeHint[2] != 0 ||
1809            !kernel.vecTypeHint.empty() || !kernel.runtimeHandle.empty())
1810        {
1811            output += "    Attrs:           \n";
1812            if (kernel.workGroupSizeHint[0] != 0 || kernel.workGroupSizeHint[1] != 0 ||
1813                kernel.workGroupSizeHint[2] != 0)
1814            {
1815                output += "      WorkGroupSizeHint: ";
1816                genArrayValue(3, kernel.workGroupSizeHint, output);
1817            }
1818            if (kernel.reqdWorkGroupSize[0] != 0 || kernel.reqdWorkGroupSize[1] != 0 ||
1819                kernel.reqdWorkGroupSize[2] != 0)
1820            {
1821                output += "      ReqdWorkGroupSize: ";
1822                genArrayValue(3, kernel.reqdWorkGroupSize, output);
1823            }
1824            if (!kernel.vecTypeHint.empty())
1825            {
1826                output += "      VecTypeHint:     ";
1827                output += escapeYAMLString(kernel.vecTypeHint);
1828                output += "\n";
1829            }
1830            if (!kernel.runtimeHandle.empty())
1831            {
1832                output += "      RuntimeHandle:   ";
1833                output += escapeYAMLString(kernel.runtimeHandle);
1834                output += "\n";
1835            }
1836        }
1837        // kernel arguments
1838        if (!kernel.argInfos.empty())
1839            output += "    Args:            \n";
1840        for (const ROCmKernelArgInfo& argInfo: kernel.argInfos)
1841        {
1842            output += "      - ";
1843            if (!argInfo.name.empty())
1844            {
1845                output += "Name:            ";
1846                output += escapeYAMLString(argInfo.name);
1847                output += "\n        ";
1848            }
1849            if (!argInfo.typeName.empty())
1850            {
1851                output += "TypeName:        ";
1852                output += escapeYAMLString(argInfo.typeName);
1853                output += "\n        ";
1854            }
1855            output += "Size:            ";
1856            itocstrCStyle(argInfo.size, numBuf, 24);
1857            output += numBuf;
1858            output += "\n        Align:           ";
1859            itocstrCStyle(argInfo.align, numBuf, 24);
1860            output += numBuf;
1861            output += "\n        ValueKind:       ";
1862           
1863            if (argInfo.valueKind > ROCmValueKind::MAX_VALUE)
1864                throw BinGenException("Unknown ValueKind");
1865            output += rocmValueKindNames[cxuint(argInfo.valueKind)];
1866           
1867            if (argInfo.valueType > ROCmValueType::MAX_VALUE)
1868                throw BinGenException("Unknown ValueType");
1869            output += "\n        ValueType:       ";
1870            output += rocmValueTypeNames[cxuint(argInfo.valueType)];
1871            output += "\n";
1872           
1873            if (argInfo.valueKind == ROCmValueKind::DYN_SHARED_PTR)
1874            {
1875                output += "        PointeeAlign:    ";
1876                itocstrCStyle(argInfo.pointeeAlign, numBuf, 24);
1877                output += numBuf;
1878                output += "\n";
1879            }
1880            if (argInfo.valueKind == ROCmValueKind::DYN_SHARED_PTR ||
1881                argInfo.valueKind == ROCmValueKind::GLOBAL_BUFFER)
1882            {
1883                if (argInfo.addressSpace > ROCmAddressSpace::MAX_VALUE ||
1884                    argInfo.addressSpace == ROCmAddressSpace::NONE)
1885                    throw BinGenException("Unknown AddressSpace");
1886                output += "        AddrSpaceQual:   ";
1887                output += rocmAddrSpaceTypesTbl[cxuint(argInfo.addressSpace)-1];
1888                output += "\n";
1889            }
1890            if (argInfo.valueKind == ROCmValueKind::IMAGE ||
1891                argInfo.valueKind == ROCmValueKind::PIPE)
1892            {
1893                if (argInfo.accessQual> ROCmAccessQual::MAX_VALUE)
1894                    throw BinGenException("Unknown AccessQualifier");
1895                output += "        AccQual:         ";
1896                output += rocmAccessQualifierTbl[cxuint(argInfo.accessQual)];
1897                output += "\n";
1898            }
1899            if (argInfo.valueKind == ROCmValueKind::GLOBAL_BUFFER ||
1900                argInfo.valueKind == ROCmValueKind::IMAGE ||
1901                argInfo.valueKind == ROCmValueKind::PIPE)
1902            {
1903                if (argInfo.actualAccessQual> ROCmAccessQual::MAX_VALUE)
1904                    throw BinGenException("Unknown ActualAccessQualifier");
1905                output += "        ActualAccQual:   ";
1906                output += rocmAccessQualifierTbl[cxuint(argInfo.actualAccessQual)];
1907                output += "\n";
1908            }
1909            if (argInfo.isConst)
1910                output += "        IsConst:         true\n";
1911            if (argInfo.isRestrict)
1912                output += "        IsRestrict:      true\n";
1913            if (argInfo.isVolatile)
1914                output += "        IsVolatile:      true\n";
1915            if (argInfo.isPipe)
1916                output += "        IsPipe:          true\n";
1917        }
1918       
1919        // kernel code properties
1920        const ROCmKernelConfig& kconfig = *kconfigs[i];
1921       
1922        output += "    CodeProps:       \n";
1923        output += "      KernargSegmentSize: ";
1924        itocstrCStyle(hasValue(kernel.kernargSegmentSize) ?
1925                kernel.kernargSegmentSize : ULEV(kconfig.kernargSegmentSize),
1926                numBuf, 24);
1927        output += numBuf;
1928        output += "\n      GroupSegmentFixedSize: ";
1929        itocstrCStyle(hasValue(kernel.groupSegmentFixedSize) ?
1930                kernel.groupSegmentFixedSize :
1931                uint64_t(ULEV(kconfig.workgroupGroupSegmentSize)),
1932                numBuf, 24);
1933        output += numBuf;
1934        output += "\n      PrivateSegmentFixedSize: ";
1935        itocstrCStyle(hasValue(kernel.privateSegmentFixedSize) ?
1936                kernel.privateSegmentFixedSize :
1937                uint64_t(ULEV(kconfig.workitemPrivateSegmentSize)),
1938                numBuf, 24);
1939        output += numBuf;
1940        output += "\n      KernargSegmentAlign: ";
1941        itocstrCStyle(hasValue(kernel.kernargSegmentAlign) ?
1942                kernel.kernargSegmentAlign :
1943                uint64_t(1ULL<<kconfig.kernargSegmentAlignment),
1944                numBuf, 24);
1945        output += numBuf;
1946        output += "\n      WavefrontSize:   ";
1947        itocstrCStyle(hasValue(kernel.wavefrontSize) ? kernel.wavefrontSize :
1948                cxuint(1U<<kconfig.wavefrontSize), numBuf, 24);
1949        output += numBuf;
1950        output += "\n      NumSGPRs:        ";
1951        itocstrCStyle(hasValue(kernel.sgprsNum) ? kernel.sgprsNum :
1952                cxuint(ULEV(kconfig.wavefrontSgprCount)), numBuf, 24);
1953        output += numBuf;
1954        output += "\n      NumVGPRs:        ";
1955        itocstrCStyle(hasValue(kernel.vgprsNum) ? kernel.vgprsNum :
1956                cxuint(ULEV(kconfig.workitemVgprCount)), numBuf, 24);
1957        output += numBuf;
1958        // spilled registers
1959        if (hasValue(kernel.spilledSgprs))
1960        {
1961            output += "\n      NumSpilledSGPRs: ";
1962            itocstrCStyle(kernel.spilledSgprs, numBuf, 24);
1963            output += numBuf;
1964        }
1965        if (hasValue(kernel.spilledVgprs))
1966        {
1967            output += "\n      NumSpilledVGPRs: ";
1968            itocstrCStyle(kernel.spilledVgprs, numBuf, 24);
1969            output += numBuf;
1970        }
1971        output += "\n      MaxFlatWorkGroupSize: ";
1972        itocstrCStyle(hasValue(kernel.maxFlatWorkGroupSize) ?
1973                    kernel.maxFlatWorkGroupSize : uint64_t(256), numBuf, 24);
1974        output += numBuf;
1975        output += "\n";
1976        if (kernel.fixedWorkGroupSize[0] != 0 || kernel.fixedWorkGroupSize[1] != 0 ||
1977            kernel.fixedWorkGroupSize[2] != 0)
1978        {
1979            output += "      FixedWorkGroupSize:   ";
1980            genArrayValue(3, kernel.fixedWorkGroupSize, output);
1981        }
1982    }
1983    output += "...\n";
1984}
1985
1986/* ROCm section generators */
1987
1988class CLRX_INTERNAL ROCmGotGen: public ElfRegionContent
1989{
1990private:
1991    const ROCmInput* input;
1992public:
1993    explicit ROCmGotGen(const ROCmInput* _input) : input(_input)
1994    { }
1995   
1996    void operator()(FastOutputBuffer& fob) const
1997    {
1998        fob.fill(input->gotSymbols.size()*8, 0);
1999    }
2000};
2001
2002class CLRX_INTERNAL ROCmRelaDynGen: public ElfRegionContent
2003{
2004private:
2005    size_t gotOffset;
2006    const ROCmInput* input;
2007public:
2008    explicit ROCmRelaDynGen(const ROCmInput* _input) : gotOffset(0), input(_input)
2009    { }
2010   
2011    void setGotOffset(size_t _gotOffset)
2012    { gotOffset = _gotOffset; }
2013   
2014    void operator()(FastOutputBuffer& fob) const
2015    {
2016        for (size_t i = 0; i < input->gotSymbols.size(); i++)
2017        {
2018            size_t symIndex = input->gotSymbols[i];
2019            Elf64_Rela rela{};
2020            SLEV(rela.r_offset, gotOffset + 8*i);
2021            SLEV(rela.r_info, ELF64_R_INFO(symIndex + 1, 3));
2022            rela.r_addend = 0;
2023            fob.writeObject(rela);
2024        }
2025    }
2026};
2027
2028/*
2029 * ROCm Binary Generator
2030 */
2031
2032ROCmBinGenerator::ROCmBinGenerator() : manageable(false), input(nullptr)
2033{ }
2034
2035ROCmBinGenerator::ROCmBinGenerator(const ROCmInput* rocmInput)
2036        : manageable(false), input(rocmInput), rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2037{ }
2038
2039ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
2040        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
2041        size_t globalDataSize, const cxbyte* globalData,
2042        const std::vector<ROCmSymbolInput>& symbols) :
2043        rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2044{
2045    std::unique_ptr<ROCmInput> _input(new ROCmInput{});
2046    _input->deviceType = deviceType;
2047    _input->archMinor = archMinor;
2048    _input->archStepping = archStepping;
2049    _input->eflags = 0;
2050    _input->newBinFormat = false;
2051    _input->globalDataSize = globalDataSize;
2052    _input->globalData = globalData;
2053    _input->symbols = symbols;
2054    _input->codeSize = codeSize;
2055    _input->code = code;
2056    _input->commentSize = 0;
2057    _input->comment = nullptr;
2058    _input->target = "";
2059    _input->targetTripple = "";
2060    _input->metadataSize = 0;
2061    _input->metadata = nullptr;
2062    _input->useMetadataInfo = false;
2063    _input->metadataInfo = ROCmMetadata{};
2064    input = _input.release();
2065}
2066
2067ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
2068        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
2069        size_t globalDataSize, const cxbyte* globalData,
2070        std::vector<ROCmSymbolInput>&& symbols) :
2071        rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2072{
2073    std::unique_ptr<ROCmInput> _input(new ROCmInput{});
2074    _input->deviceType = deviceType;
2075    _input->archMinor = archMinor;
2076    _input->archStepping = archStepping;
2077    _input->eflags = 0;
2078    _input->newBinFormat = false;
2079    _input->globalDataSize = globalDataSize;
2080    _input->globalData = globalData;
2081    _input->symbols = std::move(symbols);
2082    _input->codeSize = codeSize;
2083    _input->code = code;
2084    _input->commentSize = 0;
2085    _input->comment = nullptr;
2086    _input->target = "";
2087    _input->targetTripple = "";
2088    _input->metadataSize = 0;
2089    _input->metadata = nullptr;
2090    _input->useMetadataInfo = false;
2091    _input->metadataInfo = ROCmMetadata{};
2092    input = _input.release();
2093}
2094
2095ROCmBinGenerator::~ROCmBinGenerator()
2096{
2097    if (manageable)
2098        delete input;
2099    if (rocmGotGen!=nullptr)
2100        delete (ROCmGotGen*)rocmGotGen;
2101    if (rocmRelaDynGen!=nullptr)
2102        delete (ROCmRelaDynGen*)rocmRelaDynGen;
2103}
2104
2105void ROCmBinGenerator::setInput(const ROCmInput* input)
2106{
2107    if (manageable)
2108        delete input;
2109    manageable = false;
2110    this->input = input;
2111}
2112
2113// ELF notes contents
2114static const cxbyte noteDescType1[8] =
2115{ 2, 0, 0, 0, 1, 0, 0, 0 };
2116
2117static const cxbyte noteDescType3[27] =
2118{ 4, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2119  'A', 'M', 'D', 0, 'A', 'M', 'D', 'G', 'P', 'U', 0 };
2120
2121static inline void addMainSectionToTable(cxuint& sectionsNum, uint16_t* builtinTable,
2122                cxuint elfSectId)
2123{ builtinTable[elfSectId - ELFSECTID_START] = sectionsNum++; }
2124
2125void ROCmBinGenerator::prepareBinaryGen()
2126{
2127    AMDGPUArchVersion amdGpuArchValues = getGPUArchVersion(input->deviceType,
2128                GPUArchVersionTable::ROCM);
2129    if (input->archMinor!=UINT32_MAX)
2130        amdGpuArchValues.minor = input->archMinor;
2131    if (input->archStepping!=UINT32_MAX)
2132        amdGpuArchValues.stepping = input->archStepping;
2133   
2134    comment = "CLRX ROCmBinGenerator " CLRX_VERSION;
2135    commentSize = ::strlen(comment);
2136    if (input->comment!=nullptr)
2137    {
2138        // if comment, store comment section
2139        comment = input->comment;
2140        commentSize = input->commentSize;
2141        if (commentSize==0)
2142            commentSize = ::strlen(comment);
2143    }
2144   
2145    uint32_t eflags = input->newBinFormat ? 2 : 0;
2146    if (input->eflags != BINGEN_DEFAULT)
2147        eflags = input->eflags;
2148   
2149    std::fill(mainBuiltinSectTable,
2150              mainBuiltinSectTable + ROCMSECTID_MAX-ELFSECTID_START+1, SHN_UNDEF);
2151    mainSectionsNum = 1;
2152   
2153    // generate main builtin section table (for section id translation)
2154    if (input->newBinFormat)
2155        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_NOTE);
2156    if (input->globalData != nullptr)
2157        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_RODATA);
2158    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_DYNSYM);
2159    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_HASH);
2160    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_DYNSTR);
2161    if (!input->gotSymbols.empty())
2162        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_RELADYN);
2163    const cxuint execProgHeaderRegionIndex = mainSectionsNum;
2164    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_TEXT);
2165    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_DYNAMIC);
2166    if (!input->gotSymbols.empty())
2167        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_GOT);
2168    if (!input->newBinFormat)
2169    {
2170        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_NOTE);
2171        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_GPUCONFIG);
2172    }
2173    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_COMMENT);
2174    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_SYMTAB);
2175    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_SHSTRTAB);
2176    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_STRTAB);
2177   
2178    elfBinGen64.reset(new ElfBinaryGen64({ 0U, 0U, 0x40, 0, ET_DYN, 0xe0, EV_CURRENT,
2179            cxuint(input->newBinFormat ? execProgHeaderRegionIndex : UINT_MAX), 0, eflags },
2180            true, true, true, PHREGION_FILESTART));
2181   
2182    static const int32_t dynTags[] = {
2183        DT_SYMTAB, DT_SYMENT, DT_STRTAB, DT_STRSZ, DT_HASH };
2184    elfBinGen64->addDynamics(sizeof(dynTags)/sizeof(int32_t), dynTags);
2185   
2186    // elf program headers
2187    elfBinGen64->addProgramHeader({ PT_PHDR, PF_R, 0, 1,
2188                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2189    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R, PHREGION_FILESTART,
2190                    execProgHeaderRegionIndex,
2191                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 0x1000 });
2192    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R|PF_X, execProgHeaderRegionIndex, 1,
2193                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2194    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R|PF_W, execProgHeaderRegionIndex+1,
2195                    cxuint(1 + (!input->gotSymbols.empty())),
2196                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2197    elfBinGen64->addProgramHeader({ PT_DYNAMIC, PF_R|PF_W, execProgHeaderRegionIndex+1, 1,
2198                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 8 });
2199    elfBinGen64->addProgramHeader({ PT_GNU_RELRO, PF_R, execProgHeaderRegionIndex+1,
2200                    cxuint(1 + (!input->gotSymbols.empty())),
2201                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 1 });
2202    elfBinGen64->addProgramHeader({ PT_GNU_STACK, PF_R|PF_W, PHREGION_FILESTART, 0,
2203                    true, 0, 0, 0 });
2204   
2205    if (input->newBinFormat)
2206        // program header for note (new binary format)
2207        elfBinGen64->addProgramHeader({ PT_NOTE, PF_R, 1, 1, true,
2208                    Elf64Types::nobase, Elf64Types::nobase, 0, 4 });
2209   
2210    target = input->target.c_str();
2211    if (target.empty() && !input->targetTripple.empty())
2212    {
2213        target = input->targetTripple.c_str();
2214        char dbuf[20];
2215        snprintf(dbuf, 20, "-gfx%u%u%u", amdGpuArchValues.major, amdGpuArchValues.minor,
2216                 amdGpuArchValues.stepping);
2217        target += dbuf;
2218    }
2219    // elf notes
2220    elfBinGen64->addNote({"AMD", sizeof noteDescType1, noteDescType1, 1U});
2221    noteBuf.reset(new cxbyte[0x1b]);
2222    ::memcpy(noteBuf.get(), noteDescType3, 0x1b);
2223    SULEV(*(uint32_t*)(noteBuf.get()+4), amdGpuArchValues.major);
2224    SULEV(*(uint32_t*)(noteBuf.get()+8), amdGpuArchValues.minor);
2225    SULEV(*(uint32_t*)(noteBuf.get()+12), amdGpuArchValues.stepping);
2226    elfBinGen64->addNote({"AMD", 0x1b, noteBuf.get(), 3U});
2227    if (!target.empty())
2228        elfBinGen64->addNote({"AMD", target.size(), (const cxbyte*)target.c_str(), 0xbU});
2229   
2230    metadataSize = input->metadataSize;
2231    metadata = input->metadata;
2232    if (input->useMetadataInfo)
2233    {
2234        // generate ROCm metadata
2235        std::vector<std::pair<CString, size_t> > symbolIndices(input->symbols.size());
2236        // create sorted indices of symbols by its name
2237        for (size_t k = 0; k < input->symbols.size(); k++)
2238            symbolIndices[k] = std::make_pair(input->symbols[k].symbolName, k);
2239        mapSort(symbolIndices.begin(), symbolIndices.end());
2240       
2241        const size_t mdKernelsNum = input->metadataInfo.kernels.size();
2242        std::unique_ptr<const ROCmKernelConfig*[]> kernelConfigPtrs(
2243                new const ROCmKernelConfig*[mdKernelsNum]);
2244        // generate ROCm kernel config pointers
2245        for (size_t k = 0; k < mdKernelsNum; k++)
2246        {
2247            auto it = binaryMapFind(symbolIndices.begin(), symbolIndices.end(), 
2248                        input->metadataInfo.kernels[k].name);
2249            if (it == symbolIndices.end() ||
2250                (input->symbols[it->second].type != ROCmRegionType::FKERNEL &&
2251                 input->symbols[it->second].type != ROCmRegionType::KERNEL))
2252                throw BinGenException("Kernel in metadata doesn't exists in code");
2253            kernelConfigPtrs[k] = reinterpret_cast<const ROCmKernelConfig*>(
2254                        input->code + input->symbols[it->second].offset);
2255        }
2256        // just generate ROCm metadata from info
2257        generateROCmMetadata(input->metadataInfo, kernelConfigPtrs.get(), metadataStr);
2258        metadataSize = metadataStr.size();
2259        metadata = metadataStr.c_str();
2260    }
2261   
2262    if (metadataSize != 0)
2263        elfBinGen64->addNote({"AMD", metadataSize, (const cxbyte*)metadata, 0xaU});
2264   
2265    /// region and sections
2266    elfBinGen64->addRegion(ElfRegion64::programHeaderTable());
2267    if (input->newBinFormat)
2268        elfBinGen64->addRegion(ElfRegion64::noteSection());
2269    if (input->globalData != nullptr)
2270        elfBinGen64->addRegion(ElfRegion64(input->globalDataSize, input->globalData, 4,
2271                ".rodata", SHT_PROGBITS, SHF_ALLOC, 0, 0, Elf64Types::nobase));
2272   
2273    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
2274                ".dynsym", SHT_DYNSYM, SHF_ALLOC, 0, BINGEN_DEFAULT, Elf64Types::nobase));
2275    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 4,
2276                ".hash", SHT_HASH, SHF_ALLOC,
2277                mainBuiltinSectTable[ELFSECTID_DYNSYM-ELFSECTID_START], 0,
2278                Elf64Types::nobase));
2279    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1, ".dynstr", SHT_STRTAB,
2280                SHF_ALLOC, 0, 0, Elf64Types::nobase));
2281    if (!input->gotSymbols.empty())
2282    {
2283        ROCmRelaDynGen* sgen = new ROCmRelaDynGen(input);
2284        rocmRelaDynGen = (void*)sgen;
2285        elfBinGen64->addRegion(ElfRegion64(input->gotSymbols.size()*sizeof(Elf64_Rela),
2286                sgen, 8, ".rela.dyn", SHT_RELA, SHF_ALLOC,
2287                mainBuiltinSectTable[ELFSECTID_DYNSYM-ELFSECTID_START], 0,
2288                Elf64Types::nobase, sizeof(Elf64_Rela)));
2289    }
2290    // '.text' with alignment=4096
2291    elfBinGen64->addRegion(ElfRegion64(input->codeSize, (const cxbyte*)input->code, 
2292              0x1000, ".text", SHT_PROGBITS, SHF_ALLOC|SHF_EXECINSTR, 0, 0,
2293              Elf64Types::nobase, 0, false, 256));
2294    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 0x1000,
2295                ".dynamic", SHT_DYNAMIC, SHF_ALLOC|SHF_WRITE,
2296                mainBuiltinSectTable[ELFSECTID_DYNSTR-ELFSECTID_START], 0,
2297                Elf64Types::nobase, 0, false, 8));
2298    if (!input->gotSymbols.empty())
2299    {
2300        ROCmGotGen* sgen = new ROCmGotGen(input);
2301        rocmGotGen = (void*)sgen;
2302        elfBinGen64->addRegion(ElfRegion64(input->gotSymbols.size()*8, sgen,
2303                8, ".got", SHT_PROGBITS,
2304                SHF_ALLOC|SHF_WRITE, 0, 0, Elf64Types::nobase));
2305    }
2306    if (!input->newBinFormat)
2307    {
2308        elfBinGen64->addRegion(ElfRegion64::noteSection());
2309        elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1,
2310                    ".AMDGPU.config", SHT_PROGBITS, 0));
2311    }
2312    elfBinGen64->addRegion(ElfRegion64(commentSize, (const cxbyte*)comment, 1, ".comment",
2313              SHT_PROGBITS, SHF_MERGE|SHF_STRINGS, 0, 0, 0, 1));
2314    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
2315                ".symtab", SHT_SYMTAB, 0, 0, BINGEN_DEFAULT));
2316    elfBinGen64->addRegion(ElfRegion64::shstrtabSection());
2317    elfBinGen64->addRegion(ElfRegion64::strtabSection());
2318    elfBinGen64->addRegion(ElfRegion64::sectionHeaderTable());
2319   
2320    /* extra sections */
2321    for (const BinSection& section: input->extraSections)
2322        elfBinGen64->addRegion(ElfRegion64(section, mainBuiltinSectTable,
2323                         ROCMSECTID_MAX, mainSectionsNum));
2324    updateSymbols();
2325    binarySize = elfBinGen64->countSize();
2326   
2327    if (rocmRelaDynGen != nullptr)
2328        ((ROCmRelaDynGen*)rocmRelaDynGen)->setGotOffset(
2329                elfBinGen64->getRegionOffset(
2330                        mainBuiltinSectTable[ROCMSECTID_GOT - ELFSECTID_START]));
2331}
2332
2333void ROCmBinGenerator::updateSymbols()
2334{
2335    elfBinGen64->clearSymbols();
2336    elfBinGen64->clearDynSymbols();
2337    // add symbols (kernels, function kernels and data symbols)
2338    elfBinGen64->addSymbol(ElfSymbol64("_DYNAMIC",
2339                  mainBuiltinSectTable[ROCMSECTID_DYNAMIC-ELFSECTID_START],
2340                  ELF64_ST_INFO(STB_LOCAL, STT_NOTYPE), STV_HIDDEN, true, 0, 0));
2341    const uint16_t textSectIndex = mainBuiltinSectTable[ELFSECTID_TEXT-ELFSECTID_START];
2342    for (const ROCmSymbolInput& symbol: input->symbols)
2343    {
2344        ElfSymbol64 elfsym;
2345        switch (symbol.type)
2346        {
2347            case ROCmRegionType::KERNEL:
2348                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2349                      ELF64_ST_INFO(STB_GLOBAL, STT_GNU_IFUNC), 0, true,
2350                      symbol.offset, symbol.size);
2351                break;
2352            case ROCmRegionType::FKERNEL:
2353                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2354                      ELF64_ST_INFO(STB_GLOBAL, STT_FUNC), 0, true,
2355                      symbol.offset, symbol.size);
2356                break;
2357            case ROCmRegionType::DATA:
2358                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2359                      ELF64_ST_INFO(STB_GLOBAL, STT_OBJECT), 0, true,
2360                      symbol.offset, symbol.size);
2361                break;
2362            default:
2363                break;
2364        }
2365        // add to symbols and dynamic symbols table
2366        elfBinGen64->addSymbol(elfsym);
2367        elfBinGen64->addDynSymbol(elfsym);
2368    }
2369    /* extra symbols */
2370    for (const BinSymbol& symbol: input->extraSymbols)
2371    {
2372        ElfSymbol64 sym(symbol, mainBuiltinSectTable,
2373                         ROCMSECTID_MAX, mainSectionsNum);
2374        elfBinGen64->addSymbol(sym);
2375        elfBinGen64->addDynSymbol(sym);
2376    }
2377}
2378
2379void ROCmBinGenerator::generateInternal(std::ostream* osPtr, std::vector<char>* vPtr,
2380             Array<cxbyte>* aPtr)
2381{
2382    if (elfBinGen64 == nullptr)
2383        prepareBinaryGen();
2384    /****
2385     * prepare for write binary to output
2386     ****/
2387    std::unique_ptr<std::ostream> outStreamHolder;
2388    std::ostream* os = nullptr;
2389    if (aPtr != nullptr)
2390    {
2391        aPtr->resize(binarySize);
2392        outStreamHolder.reset(
2393                new ArrayOStream(binarySize, reinterpret_cast<char*>(aPtr->data())));
2394        os = outStreamHolder.get();
2395    }
2396    else if (vPtr != nullptr)
2397    {
2398        vPtr->resize(binarySize);
2399        outStreamHolder.reset(new VectorOStream(*vPtr));
2400        os = outStreamHolder.get();
2401    }
2402    else // from argument
2403        os = osPtr;
2404   
2405    const std::ios::iostate oldExceptions = os->exceptions();
2406    try
2407    {
2408    os->exceptions(std::ios::failbit | std::ios::badbit);
2409    /****
2410     * write binary to output
2411     ****/
2412    FastOutputBuffer bos(256, *os);
2413    elfBinGen64->generate(bos);
2414    assert(bos.getWritten() == binarySize);
2415   
2416    if (rocmGotGen != nullptr)
2417    {
2418        delete (ROCmGotGen*)rocmGotGen;
2419        rocmGotGen = nullptr;
2420    }
2421    if (rocmRelaDynGen != nullptr)
2422    {
2423        delete (ROCmGotGen*)rocmRelaDynGen;
2424        rocmRelaDynGen = nullptr;
2425    }
2426    }
2427    catch(...)
2428    {
2429        os->exceptions(oldExceptions);
2430        throw;
2431    }
2432    os->exceptions(oldExceptions);
2433}
2434
2435void ROCmBinGenerator::generate(Array<cxbyte>& array)
2436{
2437    generateInternal(nullptr, nullptr, &array);
2438}
2439
2440void ROCmBinGenerator::generate(std::ostream& os)
2441{
2442    generateInternal(&os, nullptr, nullptr);
2443}
2444
2445void ROCmBinGenerator::generate(std::vector<char>& v)
2446{
2447    generateInternal(nullptr, &v, nullptr);
2448}
Note: See TracBrowser for help on using the repository browser.