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

Last change on this file since 4882 was 4882, checked in by matszpk, 4 months ago

CLRadeonExtender: ROCm: Add first stuff to parse MsgPack? metadata. Amd3: Add some stuff to Amd3.

File size: 94.1 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    { "HiddenMultiGridSyncArg", ROCmValueKind::HIDDEN_MULTIGRID_SYNC_ARG },
890    { "HiddenNone", ROCmValueKind::HIDDEN_NONE },
891    { "HiddenPrintfBuffer", ROCmValueKind::HIDDEN_PRINTF_BUFFER },
892    { "Image", ROCmValueKind::IMAGE },
893    { "Pipe", ROCmValueKind::PIPE },
894    { "Queue", ROCmValueKind::QUEUE },
895    { "Sampler", ROCmValueKind::SAMPLER }
896};
897
898static const size_t rocmValueKindNamesNum =
899        sizeof(rocmValueKindNamesMap) / sizeof(std::pair<const char*, ROCmValueKind>);
900
901static const std::pair<const char*, ROCmValueType> rocmValueTypeNamesMap[] =
902{
903    { "F16", ROCmValueType::FLOAT16 },
904    { "F32", ROCmValueType::FLOAT32 },
905    { "F64", ROCmValueType::FLOAT64 },
906    { "I16", ROCmValueType::INT16 },
907    { "I32", ROCmValueType::INT32 },
908    { "I64", ROCmValueType::INT64 },
909    { "I8", ROCmValueType::INT8 },
910    { "Struct", ROCmValueType::STRUCTURE },
911    { "U16", ROCmValueType::UINT16 },
912    { "U32", ROCmValueType::UINT32 },
913    { "U64", ROCmValueType::UINT64 },
914    { "U8", ROCmValueType::UINT8 }
915};
916
917static const size_t rocmValueTypeNamesNum =
918        sizeof(rocmValueTypeNamesMap) / sizeof(std::pair<const char*, ROCmValueType>);
919
920static const char* rocmAddrSpaceTypesTbl[] =
921{ "Private", "Global", "Constant", "Local", "Generic", "Region" };
922
923static const char* rocmAccessQualifierTbl[] =
924{ "Default", "ReadOnly", "WriteOnly", "ReadWrite" };
925
926static void parseROCmMetadata(size_t metadataSize, const char* metadata,
927                ROCmMetadata& metadataInfo)
928{
929    const char* ptr = metadata;
930    const char* end = metadata + metadataSize;
931    size_t lineNo = 1;
932    // init metadata info object
933    metadataInfo.kernels.clear();
934    metadataInfo.printfInfos.clear();
935    metadataInfo.version[0] = metadataInfo.version[1] = 0;
936   
937    std::vector<ROCmKernelMetadata>& kernels = metadataInfo.kernels;
938   
939    cxuint levels[6] = { UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX, UINT_MAX };
940    cxuint curLevel = 0;
941    bool inKernels = false;
942    bool inKernel = false;
943    bool inKernelArgs = false;
944    bool inKernelArg = false;
945    bool inKernelCodeProps = false;
946    bool inKernelAttrs = false;
947    bool canToNextLevel = false;
948   
949    size_t oldLineNo = 0;
950    while (ptr != end)
951    {
952        cxuint level = skipSpacesAndComments(ptr, end, lineNo);
953        if (ptr == end || lineNo == oldLineNo)
954            throw ParseException(lineNo, "Expected new line");
955       
956        if (levels[curLevel] == UINT_MAX)
957            levels[curLevel] = level;
958        else if (levels[curLevel] < level)
959        {
960            if (canToNextLevel)
961                // go to next nesting level
962                levels[++curLevel] = level;
963            else
964                throw ParseException(lineNo, "Unexpected nesting level");
965            canToNextLevel = false;
966        }
967        else if (levels[curLevel] > level)
968        {
969            while (curLevel != UINT_MAX && levels[curLevel] > level)
970                curLevel--;
971            if (curLevel == UINT_MAX)
972                throw ParseException(lineNo, "Indentation smaller than in main level");
973           
974            // pop from previous level
975            if (curLevel < 3)
976            {
977                if (inKernelArgs)
978                {
979                    // leave from kernel args
980                    inKernelArgs = false;
981                    inKernelArg = false;
982                }
983           
984                inKernelCodeProps = false;
985                inKernelAttrs = false;
986            }
987            if (curLevel < 1 && inKernels)
988            {
989                // leave from kernels
990                inKernels = false;
991                inKernel = false;
992            }
993           
994            if (levels[curLevel] != level)
995                throw ParseException(lineNo, "Unexpected nesting level");
996        }
997       
998        oldLineNo = lineNo;
999        if (curLevel == 0)
1000        {
1001            if (lineNo==1 && ptr+3 <= end && *ptr=='-' && ptr[1]=='-' && ptr[2]=='-' &&
1002                (ptr+3==end || (ptr+3 < end && ptr[3]=='\n')))
1003            {
1004                ptr += 3;
1005                if (ptr!=end)
1006                {
1007                    lineNo++;
1008                    ptr++; // to newline
1009                }
1010                continue; // skip document start
1011            }
1012           
1013            if (ptr+3 <= end && *ptr=='.' && ptr[1]=='.' && ptr[2]=='.' &&
1014                (ptr+3==end || (ptr+3 < end && ptr[3]=='\n')))
1015                break; // end of the document
1016           
1017            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1018                        mainMetadataKeywordsNum, mainMetadataKeywords);
1019           
1020            switch(keyIndex)
1021            {
1022                case ROCMMT_MAIN_KERNELS:
1023                    inKernels = true;
1024                    canToNextLevel = true;
1025                    break;
1026                case ROCMMT_MAIN_PRINTF:
1027                {
1028                    YAMLPrintfVectorConsumer consumer(metadataInfo.printfInfos);
1029                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer, true);
1030                    break;
1031                }
1032                case ROCMMT_MAIN_VERSION:
1033                {
1034                    YAMLIntArrayConsumer<uint32_t> consumer(2, metadataInfo.version);
1035                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer, true);
1036                    break;
1037                }
1038                default:
1039                    skipYAMLValue(ptr, end, lineNo, level);
1040                    break;
1041            }
1042        }
1043       
1044        if (curLevel==1 && inKernels)
1045        {
1046            // enter to kernel level
1047            if (ptr == end || *ptr != '-')
1048                throw ParseException(lineNo, "No '-' before kernel object");
1049            ptr++;
1050            const char* afterMinus = ptr;
1051            skipSpacesToLineEnd(ptr, end);
1052            levels[++curLevel] = level + 1 + ptr-afterMinus;
1053            level = levels[curLevel];
1054            inKernel = true;
1055           
1056            kernels.push_back(ROCmKernelMetadata());
1057            kernels.back().initialize();
1058        }
1059       
1060        if (curLevel==2 && inKernel)
1061        {
1062            // in kernel
1063            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1064                        kernelMetadataKeywordsNum, kernelMetadataKeywords);
1065           
1066            ROCmKernelMetadata& kernel = kernels.back();
1067            switch(keyIndex)
1068            {
1069                case ROCMMT_KERNEL_ARGS:
1070                    inKernelArgs = true;
1071                    canToNextLevel = true;
1072                    kernel.argInfos.clear();
1073                    break;
1074                case ROCMMT_KERNEL_ATTRS:
1075                    inKernelAttrs = true;
1076                    canToNextLevel = true;
1077                    // initialize kernel attributes values
1078                    kernel.reqdWorkGroupSize[0] = 0;
1079                    kernel.reqdWorkGroupSize[1] = 0;
1080                    kernel.reqdWorkGroupSize[2] = 0;
1081                    kernel.workGroupSizeHint[0] = 0;
1082                    kernel.workGroupSizeHint[1] = 0;
1083                    kernel.workGroupSizeHint[2] = 0;
1084                    kernel.runtimeHandle.clear();
1085                    kernel.vecTypeHint.clear();
1086                    break;
1087                case ROCMMT_KERNEL_CODEPROPS:
1088                    // initialize CodeProps values
1089                    kernel.kernargSegmentSize = BINGEN64_DEFAULT;
1090                    kernel.groupSegmentFixedSize = BINGEN64_DEFAULT;
1091                    kernel.privateSegmentFixedSize = BINGEN64_DEFAULT;
1092                    kernel.kernargSegmentAlign = BINGEN64_DEFAULT;
1093                    kernel.wavefrontSize = BINGEN_DEFAULT;
1094                    kernel.sgprsNum = BINGEN_DEFAULT;
1095                    kernel.vgprsNum = BINGEN_DEFAULT;
1096                    kernel.spilledSgprs = BINGEN_NOTSUPPLIED;
1097                    kernel.spilledVgprs = BINGEN_NOTSUPPLIED;
1098                    kernel.maxFlatWorkGroupSize = BINGEN64_DEFAULT;
1099                    kernel.fixedWorkGroupSize[0] = 0;
1100                    kernel.fixedWorkGroupSize[1] = 0;
1101                    kernel.fixedWorkGroupSize[2] = 0;
1102                    inKernelCodeProps = true;
1103                    canToNextLevel = true;
1104                    break;
1105                case ROCMMT_KERNEL_LANGUAGE:
1106                    kernel.language = parseYAMLStringValue(ptr, end, lineNo, level, true);
1107                    break;
1108                case ROCMMT_KERNEL_LANGUAGE_VERSION:
1109                {
1110                    YAMLIntArrayConsumer<uint32_t> consumer(2, kernel.langVersion);
1111                    parseYAMLValArray(ptr, end, lineNo, levels[curLevel], &consumer);
1112                    break;
1113                }
1114                case ROCMMT_KERNEL_NAME:
1115                    kernel.name = parseYAMLStringValue(ptr, end, lineNo, level, true);
1116                    break;
1117                case ROCMMT_KERNEL_SYMBOLNAME:
1118                    kernel.symbolName = parseYAMLStringValue(ptr, end, lineNo, level, true);
1119                    break;
1120                default:
1121                    skipYAMLValue(ptr, end, lineNo, level);
1122                    break;
1123            }
1124        }
1125       
1126        if (curLevel==3 && inKernelAttrs)
1127        {
1128            // in kernel attributes
1129            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1130                        kernelAttrMetadataKeywordsNum, kernelAttrMetadataKeywords);
1131           
1132            ROCmKernelMetadata& kernel = kernels.back();
1133            switch(keyIndex)
1134            {
1135                case ROCMMT_ATTRS_REQD_WORK_GROUP_SIZE:
1136                {
1137                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.reqdWorkGroupSize);
1138                    parseYAMLValArray(ptr, end, lineNo, level, &consumer);
1139                    break;
1140                }
1141                case ROCMMT_ATTRS_RUNTIME_HANDLE:
1142                    kernel.runtimeHandle = parseYAMLStringValue(
1143                                ptr, end, lineNo, level, true);
1144                    break;
1145                case ROCMMT_ATTRS_VECTYPEHINT:
1146                    kernel.vecTypeHint = parseYAMLStringValue(
1147                                ptr, end, lineNo, level, true);
1148                    break;
1149                case ROCMMT_ATTRS_WORK_GROUP_SIZE_HINT:
1150                {
1151                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.workGroupSizeHint);
1152                    parseYAMLValArray(ptr, end, lineNo, level, &consumer, true);
1153                    break;
1154                }
1155                default:
1156                    skipYAMLValue(ptr, end, lineNo, level);
1157                    break;
1158            }
1159        }
1160       
1161        if (curLevel==3 && inKernelCodeProps)
1162        {
1163            // in kernel codeProps
1164            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1165                        kernelCodePropsKeywordsNum, kernelCodePropsKeywords);
1166           
1167            ROCmKernelMetadata& kernel = kernels.back();
1168            switch(keyIndex)
1169            {
1170                case ROCMMT_CODEPROPS_FIXED_WORK_GROUP_SIZE:
1171                {
1172                    YAMLIntArrayConsumer<cxuint> consumer(3, kernel.fixedWorkGroupSize);
1173                    parseYAMLValArray(ptr, end, lineNo, level, &consumer);
1174                    break;
1175                }
1176                case ROCMMT_CODEPROPS_GROUP_SEGMENT_FIXED_SIZE:
1177                    kernel.groupSegmentFixedSize =
1178                                parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1179                    break;
1180                case ROCMMT_CODEPROPS_KERNARG_SEGMENT_ALIGN:
1181                    kernel.kernargSegmentAlign =
1182                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1183                    break;
1184                case ROCMMT_CODEPROPS_KERNARG_SEGMENT_SIZE:
1185                    kernel.kernargSegmentSize =
1186                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1187                    break;
1188                case ROCMMT_CODEPROPS_MAX_FLAT_WORK_GROUP_SIZE:
1189                    kernel.maxFlatWorkGroupSize =
1190                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1191                    break;
1192                case ROCMMT_CODEPROPS_NUM_SGPRS:
1193                    kernel.sgprsNum = parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1194                    break;
1195                case ROCMMT_CODEPROPS_NUM_SPILLED_SGPRS:
1196                    kernel.spilledSgprs =
1197                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1198                    break;
1199                case ROCMMT_CODEPROPS_NUM_SPILLED_VGPRS:
1200                    kernel.spilledVgprs =
1201                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1202                    break;
1203                case ROCMMT_CODEPROPS_NUM_VGPRS:
1204                    kernel.vgprsNum = parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1205                    break;
1206                case ROCMMT_CODEPROPS_PRIVATE_SEGMENT_FIXED_SIZE:
1207                    kernel.privateSegmentFixedSize =
1208                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1209                    break;
1210                case ROCMMT_CODEPROPS_WAVEFRONT_SIZE:
1211                    kernel.wavefrontSize =
1212                            parseYAMLIntValue<cxuint>(ptr, end, lineNo, true);
1213                    break;
1214                default:
1215                    skipYAMLValue(ptr, end, lineNo, level);
1216                    break;
1217            }
1218        }
1219       
1220        if (curLevel==3 && inKernelArgs)
1221        {
1222            // enter to kernel argument level
1223            if (ptr == end || *ptr != '-')
1224                throw ParseException(lineNo, "No '-' before argument object");
1225            ptr++;
1226            const char* afterMinus = ptr;
1227            skipSpacesToLineEnd(ptr, end);
1228            levels[++curLevel] = level + 1 + ptr-afterMinus;
1229            level = levels[curLevel];
1230            inKernelArg = true;
1231           
1232            kernels.back().argInfos.push_back(ROCmKernelArgInfo{});
1233        }
1234       
1235        if (curLevel==4 && inKernelArg)
1236        {
1237            // in kernel argument
1238            const size_t keyIndex = parseYAMLKey(ptr, end, lineNo,
1239                        kernelArgInfosKeywordsNum, kernelArgInfosKeywords);
1240           
1241            ROCmKernelArgInfo& kernelArg = kernels.back().argInfos.back();
1242           
1243            size_t valLineNo = lineNo;
1244            switch(keyIndex)
1245            {
1246                case ROCMMT_ARGS_ACCQUAL:
1247                case ROCMMT_ARGS_ACTUALACCQUAL:
1248                {
1249                    const std::string acc = trimStrSpaces(parseYAMLStringValue(
1250                                    ptr, end, lineNo, level, true));
1251                    size_t accIndex = 0;
1252                    for (; accIndex < 6; accIndex++)
1253                        if (::strcmp(rocmAccessQualifierTbl[accIndex], acc.c_str())==0)
1254                            break;
1255                    if (accIndex == 4)
1256                        throw ParseException(lineNo, "Wrong access qualifier");
1257                    if (keyIndex == ROCMMT_ARGS_ACCQUAL)
1258                        kernelArg.accessQual = ROCmAccessQual(accIndex);
1259                    else
1260                        kernelArg.actualAccessQual = ROCmAccessQual(accIndex);
1261                    break;
1262                }
1263                case ROCMMT_ARGS_ADDRSPACEQUAL:
1264                {
1265                    const std::string aspace = trimStrSpaces(parseYAMLStringValue(
1266                                    ptr, end, lineNo, level, true));
1267                    size_t aspaceIndex = 0;
1268                    for (; aspaceIndex < 6; aspaceIndex++)
1269                        if (::strcmp(rocmAddrSpaceTypesTbl[aspaceIndex],
1270                                    aspace.c_str())==0)
1271                            break;
1272                    if (aspaceIndex == 6)
1273                        throw ParseException(valLineNo, "Wrong address space");
1274                    kernelArg.addressSpace = ROCmAddressSpace(aspaceIndex+1);
1275                    break;
1276                }
1277                case ROCMMT_ARGS_ALIGN:
1278                    kernelArg.align = parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1279                    break;
1280                case ROCMMT_ARGS_ISCONST:
1281                    kernelArg.isConst = parseYAMLBoolValue(ptr, end, lineNo, true);
1282                    break;
1283                case ROCMMT_ARGS_ISPIPE:
1284                    kernelArg.isPipe = parseYAMLBoolValue(ptr, end, lineNo, true);
1285                    break;
1286                case ROCMMT_ARGS_ISRESTRICT:
1287                    kernelArg.isRestrict = parseYAMLBoolValue(ptr, end, lineNo, true);
1288                    break;
1289                case ROCMMT_ARGS_ISVOLATILE:
1290                    kernelArg.isVolatile = parseYAMLBoolValue(ptr, end, lineNo, true);
1291                    break;
1292                case ROCMMT_ARGS_NAME:
1293                    kernelArg.name = parseYAMLStringValue(ptr, end, lineNo, level, true);
1294                    break;
1295                case ROCMMT_ARGS_POINTEE_ALIGN:
1296                    kernelArg.pointeeAlign =
1297                                parseYAMLIntValue<uint64_t>(ptr, end, lineNo, true);
1298                    break;
1299                case ROCMMT_ARGS_SIZE:
1300                    kernelArg.size = parseYAMLIntValue<uint64_t>(ptr, end, lineNo);
1301                    break;
1302                case ROCMMT_ARGS_TYPENAME:
1303                    kernelArg.typeName =
1304                                parseYAMLStringValue(ptr, end, lineNo, level, true);
1305                    break;
1306                case ROCMMT_ARGS_VALUEKIND:
1307                {
1308                    const std::string vkind = trimStrSpaces(parseYAMLStringValue(
1309                                ptr, end, lineNo, level, true));
1310                    const size_t vkindIndex = binaryMapFind(rocmValueKindNamesMap,
1311                            rocmValueKindNamesMap + rocmValueKindNamesNum, vkind.c_str(),
1312                            CStringLess()) - rocmValueKindNamesMap;
1313                    // if unknown kind
1314                    if (vkindIndex == rocmValueKindNamesNum)
1315                        throw ParseException(valLineNo, "Wrong argument value kind");
1316                    kernelArg.valueKind = rocmValueKindNamesMap[vkindIndex].second;
1317                    break;
1318                }
1319                case ROCMMT_ARGS_VALUETYPE:
1320                {
1321                    const std::string vtype = trimStrSpaces(parseYAMLStringValue(
1322                                    ptr, end, lineNo, level, true));
1323                    const size_t vtypeIndex = binaryMapFind(rocmValueTypeNamesMap,
1324                            rocmValueTypeNamesMap + rocmValueTypeNamesNum, vtype.c_str(),
1325                            CStringLess()) - rocmValueTypeNamesMap;
1326                    // if unknown type
1327                    if (vtypeIndex == rocmValueTypeNamesNum)
1328                        throw ParseException(valLineNo, "Wrong argument value type");
1329                    kernelArg.valueType = rocmValueTypeNamesMap[vtypeIndex].second;
1330                    break;
1331                }
1332                default:
1333                    skipYAMLValue(ptr, end, lineNo, level);
1334                    break;
1335            }
1336        }
1337    }
1338}
1339
1340void ROCmMetadata::parse(size_t metadataSize, const char* metadata)
1341{
1342    parseROCmMetadata(metadataSize, metadata, *this);
1343}
1344
1345/*
1346 * ROCm metadata MsgPack parser
1347 */
1348
1349static void parseMsgPackNil(const cxbyte*& dataPtr, const cxbyte* dataEnd)
1350{
1351    if (dataPtr>=dataEnd || *dataPtr != 0xc0)
1352        throw ParseException("MsgPack: Can't parse nil value");
1353    dataPtr++;
1354}
1355
1356static bool parseMsgPackBool(const cxbyte*& dataPtr, const cxbyte* dataEnd)
1357{
1358    if (dataPtr>=dataEnd || ((*dataPtr)&0xfe) != 0xc2)
1359        throw ParseException("MsgPack: Can't parse bool value");
1360    const bool v = (*dataPtr==0xc3);
1361    dataPtr++;
1362    return v;
1363}
1364
1365enum: cxbyte {
1366    MSGPACK_WS_UNSIGNED = 0,  // only unsigned
1367    MSGPACK_WS_SIGNED = 1,  // only signed
1368    MSGPACK_WS_BOTH = 2  // both signed and unsigned range checking
1369};
1370
1371
1372static uint64_t parseMsgPackInteger(const cxbyte*& dataPtr, const cxbyte* dataEnd,
1373                cxbyte signess = MSGPACK_WS_BOTH)
1374{
1375    if (dataPtr>=dataEnd)
1376        throw ParseException("MsgPack: Can't parse integer value");
1377    uint64_t v = 0;
1378    if (*dataPtr < 0x80)
1379        v = *dataPtr++;
1380    else if (*dataPtr >= 0xe0)
1381        v = uint64_t(-32) + ((*dataPtr++) & 0x1f);
1382    else
1383    {
1384        const cxbyte code = *dataPtr++;
1385        switch(code)
1386        {
1387            case 0xcc:
1388            case 0xd0:
1389                if (dataPtr>=dataEnd)
1390                    throw ParseException("MsgPack: Can't parse integer value");
1391                v = *dataPtr++;
1392                break;
1393            case 0xcd:
1394            case 0xd1:
1395                if (dataPtr+1>=dataEnd)
1396                    throw ParseException("MsgPack: Can't parse integer value");
1397                v = *dataPtr++;
1398                v |= uint32_t(*dataPtr++)<<8;
1399                break;
1400            case 0xce:
1401            case 0xd2:
1402                if (dataPtr+3>=dataEnd)
1403                    throw ParseException("MsgPack: Can't parse integer value");
1404                for (cxuint i = 0; i < 32; i+=8)
1405                    v |= uint32_t(*dataPtr++)<<i;
1406                break;
1407            case 0xcf:
1408            case 0xd3:
1409                if (dataPtr+7>=dataEnd)
1410                    throw ParseException("MsgPack: Can't parse integer value");
1411                for (cxuint i = 0; i < 64; i+=8)
1412                    v |= uint64_t(*dataPtr++)<<i;
1413                break;
1414            default:
1415                throw ParseException("MsgPack: Can't parse integer value");
1416        }
1417       
1418        if (signess == MSGPACK_WS_UNSIGNED && code >= 0xd0 && v >= (1ULL<<63))
1419            throw ParseException("MsgPack: Negative value for unsigned integer");
1420        if (signess == MSGPACK_WS_SIGNED && code < 0xd0 && v >= (1ULL<<63))
1421            throw ParseException("MsgPack: Positive value out of range for signed integer");
1422    }
1423    return v;
1424}
1425
1426static double parseMsgPackFloat(const cxbyte*& dataPtr, const cxbyte* dataEnd)
1427{
1428    if (dataPtr>=dataEnd)
1429        throw ParseException("MsgPack: Can't parse float value");
1430    const cxbyte code = *dataPtr++;
1431    double vf = 0.0;
1432    if (code == 0xca)
1433    {
1434        uint32_t v = 0;
1435        if (dataPtr+3>=dataEnd)
1436            throw ParseException("MsgPack: Can't parse float value");
1437        for (cxuint i = 0; i < 32; i+=8)
1438            v |= uint32_t(*dataPtr++)<<i;
1439        vf = *reinterpret_cast<float*>(&v);
1440    }
1441    else if (code == 0xcb)
1442    {
1443        uint64_t v = 0;
1444        if (dataPtr+7>=dataEnd)
1445            throw ParseException("MsgPack: Can't parse float value");
1446        for (cxuint i = 0; i < 64; i+=8)
1447            v |= uint64_t(*dataPtr++)<<i;
1448        vf = *reinterpret_cast<double*>(&v);
1449    }
1450    else
1451        throw ParseException("MsgPack: Can't parse float value");
1452    return vf;
1453}
1454
1455static Array<cxbyte> parseMsgPackData(const cxbyte*& dataPtr, const cxbyte* dataEnd)
1456{
1457    if (dataPtr>=dataEnd)
1458        throw ParseException("MsgPack: Can't parse byte-array");
1459    const cxbyte code = *dataPtr++;
1460    size_t size = 0;
1461    switch (code)
1462    {
1463        case 0xc4:
1464            if (dataPtr>=dataEnd)
1465                throw ParseException("MsgPack: Can't parse byte-array size");
1466            size = *dataPtr++;
1467            break;
1468        case 0xc5:
1469            if (dataPtr+1>=dataEnd)
1470                throw ParseException("MsgPack: Can't parse byte-array size");
1471            size = *dataPtr++;
1472            size |= uint32_t(*dataPtr++)<<8;
1473            break;
1474        case 0xc6:
1475            if (dataPtr+3>=dataEnd)
1476                throw ParseException("MsgPack: Can't parse byte-array size");
1477            for (cxuint i = 0; i < 32; i+=8)
1478                size |= uint32_t(*dataPtr++)<<i;
1479            break;
1480        default:
1481            throw ParseException("MsgPack: Can't parse byte-array");
1482    }
1483   
1484    Array<cxbyte> out(size);
1485    if (dataPtr+size > dataEnd)
1486        throw ParseException("MsgPack: Can't parse byte-array");
1487    std::copy(dataPtr, dataPtr + size, out.begin());
1488    dataPtr += size;
1489    return out;
1490}
1491
1492static void parseROCmMetadataMsgPack(size_t metadataSize, const cxbyte* metadata,
1493                ROCmMetadata& metadataInfo)
1494{
1495    // init metadata info object
1496    metadataInfo.kernels.clear();
1497    metadataInfo.printfInfos.clear();
1498    metadataInfo.version[0] = metadataInfo.version[1] = 0;
1499   
1500    std::vector<ROCmKernelMetadata>& kernels = metadataInfo.kernels;
1501}
1502
1503void ROCmMetadata::parseMsgPack(size_t metadataSize, const cxbyte* metadata)
1504{
1505    parseROCmMetadataMsgPack(metadataSize, metadata, *this);
1506}
1507
1508/*
1509 * ROCm binary reader and generator
1510 */
1511
1512/* TODO: add support for various kernel code offset (now only 256 is supported) */
1513
1514ROCmBinary::ROCmBinary(size_t binaryCodeSize, cxbyte* binaryCode, Flags creationFlags)
1515        : ElfBinary64(binaryCodeSize, binaryCode, creationFlags),
1516          regionsNum(0), codeSize(0), code(nullptr),
1517          globalDataSize(0), globalData(nullptr), metadataSize(0), metadata(nullptr),
1518          newBinFormat(false)
1519{
1520    cxuint textIndex = SHN_UNDEF;
1521    try
1522    { textIndex = getSectionIndex(".text"); }
1523    catch(const Exception& ex)
1524    { } // ignore failed
1525    uint64_t codeOffset = 0;
1526    // find '.text' section
1527    if (textIndex!=SHN_UNDEF)
1528    {
1529        code = getSectionContent(textIndex);
1530        const Elf64_Shdr& textShdr = getSectionHeader(textIndex);
1531        codeSize = ULEV(textShdr.sh_size);
1532        codeOffset = ULEV(textShdr.sh_offset);
1533    }
1534   
1535    cxuint rodataIndex = SHN_UNDEF;
1536    try
1537    { rodataIndex = getSectionIndex(".rodata"); }
1538    catch(const Exception& ex)
1539    { } // ignore failed
1540    // find '.text' section
1541    if (rodataIndex!=SHN_UNDEF)
1542    {
1543        globalData = getSectionContent(rodataIndex);
1544        const Elf64_Shdr& rodataShdr = getSectionHeader(rodataIndex);
1545        globalDataSize = ULEV(rodataShdr.sh_size);
1546    }
1547   
1548    cxuint gpuConfigIndex = SHN_UNDEF;
1549    try
1550    { gpuConfigIndex = getSectionIndex(".AMDGPU.config"); }
1551    catch(const Exception& ex)
1552    { } // ignore failed
1553    newBinFormat = (gpuConfigIndex == SHN_UNDEF);
1554   
1555    cxuint relaDynIndex = SHN_UNDEF;
1556    try
1557    { relaDynIndex = getSectionIndex(".rela.dyn"); }
1558    catch(const Exception& ex)
1559    { } // ignore failed
1560   
1561    cxuint gotIndex = SHN_UNDEF;
1562    try
1563    { gotIndex = getSectionIndex(".got"); }
1564    catch(const Exception& ex)
1565    { } // ignore failed
1566   
1567    // counts regions (symbol or kernel)
1568    regionsNum = 0;
1569    const size_t symbolsNum = getSymbolsNum();
1570    for (size_t i = 0; i < symbolsNum; i++)
1571    {
1572        // count regions number
1573        const Elf64_Sym& sym = getSymbol(i);
1574        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
1575        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
1576        if (ULEV(sym.st_shndx)==textIndex &&
1577            (symType==STT_GNU_IFUNC || (symType==STT_FUNC && !newBinFormat) ||
1578                (bind==STB_GLOBAL && symType==STT_OBJECT)))
1579            regionsNum++;
1580    }
1581    if (code==nullptr && regionsNum!=0)
1582        throw BinException("No code if regions number is not zero");
1583    regions.reset(new ROCmRegion[regionsNum]);
1584    size_t j = 0;
1585    typedef std::pair<uint64_t, size_t> RegionOffsetEntry;
1586    std::unique_ptr<RegionOffsetEntry[]> symOffsets(new RegionOffsetEntry[regionsNum]);
1587   
1588    // get regions info
1589    for (size_t i = 0; i < symbolsNum; i++)
1590    {
1591        const Elf64_Sym& sym = getSymbol(i);
1592        if (ULEV(sym.st_shndx)!=textIndex)
1593            continue;   // if not in '.text' section
1594        const size_t value = ULEV(sym.st_value);
1595        if (value < codeOffset)
1596            throw BinException("Region offset is too small!");
1597        const size_t size = ULEV(sym.st_size);
1598       
1599        const cxbyte symType = ELF64_ST_TYPE(sym.st_info);
1600        const cxbyte bind = ELF64_ST_BIND(sym.st_info);
1601        if (symType==STT_GNU_IFUNC || symType==STT_FUNC ||
1602                (bind==STB_GLOBAL && symType==STT_OBJECT))
1603        {
1604            ROCmRegionType type = ROCmRegionType::DATA;
1605            // if kernel
1606            if (symType==STT_GNU_IFUNC) 
1607                type = ROCmRegionType::KERNEL;
1608            // if function kernel
1609            else if (symType==STT_FUNC)
1610            {
1611                if (newBinFormat)
1612                    continue;
1613                type = ROCmRegionType::FKERNEL;
1614            }
1615            symOffsets[j] = std::make_pair(value, j);
1616            if (type!=ROCmRegionType::DATA && value+0x100 > codeOffset+codeSize)
1617                throw BinException("Kernel or code offset is too big!");
1618            regions[j++] = { getSymbolName(i), size, value, type };
1619        }
1620    }
1621    // sort regions by offset
1622    std::sort(symOffsets.get(), symOffsets.get()+regionsNum,
1623            [](const RegionOffsetEntry& a, const RegionOffsetEntry& b)
1624            { return a.first < b.first; });
1625    // checking distance between regions
1626    for (size_t i = 1; i <= regionsNum; i++)
1627    {
1628        size_t end = (i<regionsNum) ? symOffsets[i].first : codeOffset+codeSize;
1629        ROCmRegion& region = regions[symOffsets[i-1].second];
1630        if (region.type==ROCmRegionType::KERNEL && symOffsets[i-1].first+0x100 > end)
1631            throw BinException("Kernel size is too small!");
1632       
1633        const size_t regSize = end - symOffsets[i-1].first;
1634        if (region.size==0)
1635            region.size = regSize;
1636        else
1637            region.size = std::min(regSize, region.size);
1638    }
1639   
1640    // load got symbols
1641    if (relaDynIndex != SHN_UNDEF && gotIndex != SHN_UNDEF)
1642    {
1643        const Elf64_Shdr& relaShdr = getSectionHeader(relaDynIndex);
1644        const Elf64_Shdr& gotShdr = getSectionHeader(gotIndex);
1645       
1646        size_t relaEntrySize = ULEV(relaShdr.sh_entsize);
1647        if (relaEntrySize==0)
1648            relaEntrySize = sizeof(Elf64_Rela);
1649        const size_t relaEntriesNum = ULEV(relaShdr.sh_size)/relaEntrySize;
1650        const size_t gotEntriesNum = ULEV(gotShdr.sh_size) >> 3;
1651        if (gotEntriesNum != relaEntriesNum)
1652            throw BinException("RelaDyn entries number and GOT entries "
1653                        "number doesn't match!");
1654       
1655        // initialize GOT symbols table
1656        gotSymbols.resize(gotEntriesNum);
1657        const cxbyte* relaDyn = getSectionContent(relaDynIndex);
1658        for (size_t i = 0; i < relaEntriesNum; i++)
1659        {
1660            const Elf64_Rela& rela = *reinterpret_cast<const Elf64_Rela*>(
1661                            relaDyn + relaEntrySize*i);
1662            // check rela entry fields
1663            if (ULEV(rela.r_offset) != ULEV(gotShdr.sh_offset) + i*8)
1664                throw BinException("Wrong dyn relocation offset");
1665            if (ULEV(rela.r_addend) != 0ULL)
1666                throw BinException("Wrong dyn relocation addend");
1667            size_t symIndex = ELF64_R_SYM(ULEV(rela.r_info));
1668            if (symIndex >= getDynSymbolsNum())
1669                throw BinException("Dyn relocation symbol index out of range");
1670            // just set in gotSymbols
1671            gotSymbols[i] = symIndex;
1672        }
1673    }
1674   
1675    // get metadata
1676    const size_t notesSize = getNotesSize();
1677    const cxbyte* noteContent = (const cxbyte*)getNotes();
1678   
1679    for (size_t offset = 0; offset < notesSize; )
1680    {
1681        const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
1682        size_t namesz = ULEV(nhdr->n_namesz);
1683        size_t descsz = ULEV(nhdr->n_descsz);
1684        if (usumGt(offset, namesz+descsz, notesSize))
1685            throw BinException("Note offset+size out of range");
1686       
1687        if (namesz==4 &&
1688            ::strcmp((const char*)noteContent+offset+ sizeof(Elf64_Nhdr), "AMD")==0)
1689        {
1690            const uint32_t noteType = ULEV(nhdr->n_type);
1691            if (noteType == 0xa)
1692            {
1693                metadata = (char*)(noteContent+offset+sizeof(Elf64_Nhdr) + 4);
1694                metadataSize = descsz;
1695            }
1696            else if (noteType == 0xb)
1697                target.assign((char*)(noteContent+offset+sizeof(Elf64_Nhdr) + 4), descsz);
1698        }
1699        size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
1700        offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
1701    }
1702   
1703    if (hasRegionMap())
1704    {
1705        // create region map
1706        regionsMap.resize(regionsNum);
1707        for (size_t i = 0; i < regionsNum; i++)
1708            regionsMap[i] = std::make_pair(regions[i].regionName, i);
1709        // sort region map
1710        mapSort(regionsMap.begin(), regionsMap.end());
1711    }
1712   
1713    if ((creationFlags & ROCMBIN_CREATE_METADATAINFO) != 0 &&
1714        metadata != nullptr && metadataSize != 0)
1715    {
1716        metadataInfo.reset(new ROCmMetadata());
1717        parseROCmMetadata(metadataSize, metadata, *metadataInfo);
1718       
1719        if (hasKernelInfoMap())
1720        {
1721            const std::vector<ROCmKernelMetadata>& kernels = metadataInfo->kernels;
1722            kernelInfosMap.resize(kernels.size());
1723            for (size_t i = 0; i < kernelInfosMap.size(); i++)
1724                kernelInfosMap[i] = std::make_pair(kernels[i].name, i);
1725            // sort region map
1726            mapSort(kernelInfosMap.begin(), kernelInfosMap.end());
1727        }
1728    }
1729}
1730
1731/// determint GPU device from ROCm notes
1732GPUDeviceType ROCmBinary::determineGPUDeviceType(uint32_t& outArchMinor,
1733                     uint32_t& outArchStepping) const
1734{
1735    uint32_t archMajor = 0;
1736    uint32_t archMinor = 0;
1737    uint32_t archStepping = 0;
1738   
1739    {
1740        const cxbyte* noteContent = (const cxbyte*)getNotes();
1741        if (noteContent==nullptr)
1742            throw BinException("Missing notes in inner binary!");
1743        size_t notesSize = getNotesSize();
1744        // find note about AMDGPU
1745        for (size_t offset = 0; offset < notesSize; )
1746        {
1747            const Elf64_Nhdr* nhdr = (const Elf64_Nhdr*)(noteContent + offset);
1748            size_t namesz = ULEV(nhdr->n_namesz);
1749            size_t descsz = ULEV(nhdr->n_descsz);
1750            if (usumGt(offset, namesz+descsz, notesSize))
1751                throw BinException("Note offset+size out of range");
1752            if (ULEV(nhdr->n_type) == 0x3 && namesz==4 && descsz>=0x1a &&
1753                ::strcmp((const char*)noteContent+offset+sizeof(Elf64_Nhdr), "AMD")==0)
1754            {    // AMDGPU type
1755                const uint32_t* content = (const uint32_t*)
1756                        (noteContent+offset+sizeof(Elf64_Nhdr) + 4);
1757                archMajor = ULEV(content[1]);
1758                archMinor = ULEV(content[2]);
1759                archStepping = ULEV(content[3]);
1760            }
1761            size_t align = (((namesz+descsz)&3)!=0) ? 4-((namesz+descsz)&3) : 0;
1762            offset += sizeof(Elf64_Nhdr) + namesz + descsz + align;
1763        }
1764    }
1765    // determine device type
1766    GPUDeviceType deviceType = getGPUDeviceTypeFromArchVersion(archMajor, archMinor,
1767                                    archStepping);
1768    outArchMinor = archMinor;
1769    outArchStepping = archStepping;
1770    return deviceType;
1771}
1772
1773const ROCmRegion& ROCmBinary::getRegion(const char* name) const
1774{
1775    RegionMap::const_iterator it = binaryMapFind(regionsMap.begin(),
1776                             regionsMap.end(), name);
1777    if (it == regionsMap.end())
1778        throw BinException("Can't find region name");
1779    return regions[it->second];
1780}
1781
1782const ROCmKernelMetadata& ROCmBinary::getKernelInfo(const char* name) const
1783{
1784    if (!hasMetadataInfo())
1785        throw BinException("Can't find kernel info name");
1786    RegionMap::const_iterator it = binaryMapFind(kernelInfosMap.begin(),
1787                             kernelInfosMap.end(), name);
1788    if (it == kernelInfosMap.end())
1789        throw BinException("Can't find kernel info name");
1790    return metadataInfo->kernels[it->second];
1791}
1792
1793// if ROCm binary
1794bool CLRX::isROCmBinary(size_t binarySize, const cxbyte* binary)
1795{
1796    if (!isElfBinary(binarySize, binary))
1797        return false;
1798    if (binary[EI_CLASS] != ELFCLASS64)
1799        return false;
1800    const Elf64_Ehdr* ehdr = reinterpret_cast<const Elf64_Ehdr*>(binary);
1801    if (ULEV(ehdr->e_machine) != 0xe0)
1802        return false;
1803    return true;
1804}
1805
1806
1807void ROCmInput::addEmptyKernel(const char* kernelName)
1808{
1809    symbols.push_back({ kernelName, 0, 0, ROCmRegionType::KERNEL });
1810}
1811
1812/*
1813 * ROCm YAML metadata generator
1814 */
1815
1816static const char* rocmValueKindNames[] =
1817{
1818    "ByValue", "GlobalBuffer", "DynamicSharedPointer", "Sampler", "Image", "Pipe", "Queue",
1819    "HiddenGlobalOffsetX", "HiddenGlobalOffsetY", "HiddenGlobalOffsetZ", "HiddenNone",
1820    "HiddenPrintfBuffer", "HiddenDefaultQueue", "HiddenCompletionAction",
1821    "HiddenMultiGridSyncArg"
1822};
1823
1824static const char* rocmValueTypeNames[] =
1825{
1826    "Struct", "I8", "U8", "I16", "U16", "F16", "I32", "U32", "F32", "I64", "U64", "F64"
1827};
1828
1829static void genArrayValue(cxuint n, const cxuint* values, std::string& output)
1830{
1831    char numBuf[24];
1832    output += "[ ";
1833    for (cxuint i = 0; i < n; i++)
1834    {
1835        itocstrCStyle(values[i], numBuf, 24);
1836        output += numBuf;
1837        output += (i+1<n) ? ", " : " ]\n";
1838    }
1839}
1840
1841// helper for checking whether value is supplied
1842static inline bool hasValue(cxuint value)
1843{ return value!=BINGEN_NOTSUPPLIED && value!=BINGEN_DEFAULT; }
1844
1845static inline bool hasValue(uint64_t value)
1846{ return value!=BINGEN64_NOTSUPPLIED && value!=BINGEN64_DEFAULT; }
1847
1848// get escaped YAML string if needed, otherwise get this same string
1849static std::string escapeYAMLString(const CString& input)
1850{
1851    bool toEscape = false;
1852    const char* s;
1853    for (s = input.c_str(); *s!=0; s++)
1854    {
1855        cxbyte c = *s;
1856        if (c < 0x20 || c >= 0x80 || c=='*' || c=='&' || c=='!' || c=='@' ||
1857            c=='\'' || c=='\"')
1858            toEscape = true;
1859    }
1860    // if spaces in begin and end
1861    if (isSpace(input[0]) || isDigit(input[0]) ||
1862        (!input.empty() && isSpace(s[-1])))
1863        toEscape = true;
1864   
1865    if (toEscape)
1866    {
1867        std::string out = "'";
1868        out += escapeStringCStyle(s-input.c_str(), input.c_str());
1869        out += "'";
1870        return out;
1871    }
1872    return input.c_str();
1873}
1874
1875static std::string escapePrintfFormat(const std::string& fmt)
1876{
1877    std::string out;
1878    out.reserve(fmt.size());
1879    for (char c: fmt)
1880        if (c!=':')
1881            out.push_back(c);
1882        else
1883            out += "\\72";
1884    return out;
1885}
1886
1887static void generateROCmMetadata(const ROCmMetadata& mdInfo,
1888                    const ROCmKernelConfig** kconfigs, std::string& output)
1889{
1890    output.clear();
1891    char numBuf[24];
1892    output += "---\n";
1893    // version
1894    output += "Version:         ";
1895    if (hasValue(mdInfo.version[0]))
1896        genArrayValue(2, mdInfo.version, output);
1897    else // default
1898        output += "[ 1, 0 ]\n";
1899    if (!mdInfo.printfInfos.empty())
1900        output += "Printf:          \n";
1901    // check print ids uniquness
1902    {
1903        std::unordered_set<cxuint> printfIds;
1904        for (const ROCmPrintfInfo& printfInfo: mdInfo.printfInfos)
1905            if (printfInfo.id!=BINGEN_DEFAULT)
1906                if (!printfIds.insert(printfInfo.id).second)
1907                    throw BinGenException("Duplicate of printf id");
1908        // printfs
1909        uint32_t freePrintfId = 1;
1910        for (const ROCmPrintfInfo& printfInfo: mdInfo.printfInfos)
1911        {
1912            // skip used printfids;
1913            uint32_t printfId = printfInfo.id;
1914            if (printfId == BINGEN_DEFAULT)
1915            {
1916                // skip used printfids
1917                for (; printfIds.find(freePrintfId) != printfIds.end(); ++freePrintfId);
1918                // just use this free printfid
1919                printfId = freePrintfId++;
1920            }
1921           
1922            output += "  - '";
1923            itocstrCStyle(printfId, numBuf, 24);
1924            output += numBuf;
1925            output += ':';
1926            itocstrCStyle(printfInfo.argSizes.size(), numBuf, 24);
1927            output += numBuf;
1928            output += ':';
1929            for (size_t argSize: printfInfo.argSizes)
1930            {
1931                itocstrCStyle(argSize, numBuf, 24);
1932                output += numBuf;
1933                output += ':';
1934            }
1935            // printf format
1936            std::string escapedFmt = escapeStringCStyle(printfInfo.format);
1937            escapedFmt = escapePrintfFormat(escapedFmt);
1938            output += escapedFmt;
1939            output += "'\n";
1940        }
1941    }
1942   
1943    if (!mdInfo.kernels.empty())
1944        output += "Kernels:         \n";
1945    // kernels
1946    for (size_t i = 0; i < mdInfo.kernels.size(); i++)
1947    {
1948        const ROCmKernelMetadata& kernel = mdInfo.kernels[i];
1949        output += "  - Name:            ";
1950        output.append(kernel.name.c_str(), kernel.name.size());
1951        output += "\n    SymbolName:      ";
1952        if (!kernel.symbolName.empty())
1953            output += escapeYAMLString(kernel.symbolName);
1954        else
1955        {
1956            // default is kernel name + '@kd'
1957            std::string symName = kernel.name.c_str();
1958            symName += "@kd";
1959            output += escapeYAMLString(symName);
1960        }
1961        output += "\n";
1962        if (!kernel.language.empty())
1963        {
1964            output += "    Language:        ";
1965            output += escapeYAMLString(kernel.language);
1966            output += "\n";
1967        }
1968        if (kernel.langVersion[0] != BINGEN_NOTSUPPLIED)
1969        {
1970            output += "    LanguageVersion: ";
1971            genArrayValue(2, kernel.langVersion, output);
1972        }
1973        // kernel attributes
1974        if (kernel.reqdWorkGroupSize[0] != 0 || kernel.reqdWorkGroupSize[1] != 0 ||
1975            kernel.reqdWorkGroupSize[2] != 0 ||
1976            kernel.workGroupSizeHint[0] != 0 || kernel.workGroupSizeHint[1] != 0 ||
1977            kernel.workGroupSizeHint[2] != 0 ||
1978            !kernel.vecTypeHint.empty() || !kernel.runtimeHandle.empty())
1979        {
1980            output += "    Attrs:           \n";
1981            if (kernel.workGroupSizeHint[0] != 0 || kernel.workGroupSizeHint[1] != 0 ||
1982                kernel.workGroupSizeHint[2] != 0)
1983            {
1984                output += "      WorkGroupSizeHint: ";
1985                genArrayValue(3, kernel.workGroupSizeHint, output);
1986            }
1987            if (kernel.reqdWorkGroupSize[0] != 0 || kernel.reqdWorkGroupSize[1] != 0 ||
1988                kernel.reqdWorkGroupSize[2] != 0)
1989            {
1990                output += "      ReqdWorkGroupSize: ";
1991                genArrayValue(3, kernel.reqdWorkGroupSize, output);
1992            }
1993            if (!kernel.vecTypeHint.empty())
1994            {
1995                output += "      VecTypeHint:     ";
1996                output += escapeYAMLString(kernel.vecTypeHint);
1997                output += "\n";
1998            }
1999            if (!kernel.runtimeHandle.empty())
2000            {
2001                output += "      RuntimeHandle:   ";
2002                output += escapeYAMLString(kernel.runtimeHandle);
2003                output += "\n";
2004            }
2005        }
2006        // kernel arguments
2007        if (!kernel.argInfos.empty())
2008            output += "    Args:            \n";
2009        for (const ROCmKernelArgInfo& argInfo: kernel.argInfos)
2010        {
2011            output += "      - ";
2012            if (!argInfo.name.empty())
2013            {
2014                output += "Name:            ";
2015                output += escapeYAMLString(argInfo.name);
2016                output += "\n        ";
2017            }
2018            if (!argInfo.typeName.empty())
2019            {
2020                output += "TypeName:        ";
2021                output += escapeYAMLString(argInfo.typeName);
2022                output += "\n        ";
2023            }
2024            output += "Size:            ";
2025            itocstrCStyle(argInfo.size, numBuf, 24);
2026            output += numBuf;
2027            output += "\n        Align:           ";
2028            itocstrCStyle(argInfo.align, numBuf, 24);
2029            output += numBuf;
2030            output += "\n        ValueKind:       ";
2031           
2032            if (argInfo.valueKind > ROCmValueKind::MAX_VALUE)
2033                throw BinGenException("Unknown ValueKind");
2034            output += rocmValueKindNames[cxuint(argInfo.valueKind)];
2035           
2036            if (argInfo.valueType > ROCmValueType::MAX_VALUE)
2037                throw BinGenException("Unknown ValueType");
2038            output += "\n        ValueType:       ";
2039            output += rocmValueTypeNames[cxuint(argInfo.valueType)];
2040            output += "\n";
2041           
2042            if (argInfo.valueKind == ROCmValueKind::DYN_SHARED_PTR)
2043            {
2044                output += "        PointeeAlign:    ";
2045                itocstrCStyle(argInfo.pointeeAlign, numBuf, 24);
2046                output += numBuf;
2047                output += "\n";
2048            }
2049            if (argInfo.valueKind == ROCmValueKind::DYN_SHARED_PTR ||
2050                argInfo.valueKind == ROCmValueKind::GLOBAL_BUFFER)
2051            {
2052                if (argInfo.addressSpace > ROCmAddressSpace::MAX_VALUE ||
2053                    argInfo.addressSpace == ROCmAddressSpace::NONE)
2054                    throw BinGenException("Unknown AddressSpace");
2055                output += "        AddrSpaceQual:   ";
2056                output += rocmAddrSpaceTypesTbl[cxuint(argInfo.addressSpace)-1];
2057                output += "\n";
2058            }
2059            if (argInfo.valueKind == ROCmValueKind::IMAGE ||
2060                argInfo.valueKind == ROCmValueKind::PIPE)
2061            {
2062                if (argInfo.accessQual> ROCmAccessQual::MAX_VALUE)
2063                    throw BinGenException("Unknown AccessQualifier");
2064                output += "        AccQual:         ";
2065                output += rocmAccessQualifierTbl[cxuint(argInfo.accessQual)];
2066                output += "\n";
2067            }
2068            if (argInfo.valueKind == ROCmValueKind::GLOBAL_BUFFER ||
2069                argInfo.valueKind == ROCmValueKind::IMAGE ||
2070                argInfo.valueKind == ROCmValueKind::PIPE)
2071            {
2072                if (argInfo.actualAccessQual> ROCmAccessQual::MAX_VALUE)
2073                    throw BinGenException("Unknown ActualAccessQualifier");
2074                output += "        ActualAccQual:   ";
2075                output += rocmAccessQualifierTbl[cxuint(argInfo.actualAccessQual)];
2076                output += "\n";
2077            }
2078            if (argInfo.isConst)
2079                output += "        IsConst:         true\n";
2080            if (argInfo.isRestrict)
2081                output += "        IsRestrict:      true\n";
2082            if (argInfo.isVolatile)
2083                output += "        IsVolatile:      true\n";
2084            if (argInfo.isPipe)
2085                output += "        IsPipe:          true\n";
2086        }
2087       
2088        // kernel code properties
2089        const ROCmKernelConfig& kconfig = *kconfigs[i];
2090       
2091        output += "    CodeProps:       \n";
2092        output += "      KernargSegmentSize: ";
2093        itocstrCStyle(hasValue(kernel.kernargSegmentSize) ?
2094                kernel.kernargSegmentSize : ULEV(kconfig.kernargSegmentSize),
2095                numBuf, 24);
2096        output += numBuf;
2097        output += "\n      GroupSegmentFixedSize: ";
2098        itocstrCStyle(hasValue(kernel.groupSegmentFixedSize) ?
2099                kernel.groupSegmentFixedSize :
2100                uint64_t(ULEV(kconfig.workgroupGroupSegmentSize)),
2101                numBuf, 24);
2102        output += numBuf;
2103        output += "\n      PrivateSegmentFixedSize: ";
2104        itocstrCStyle(hasValue(kernel.privateSegmentFixedSize) ?
2105                kernel.privateSegmentFixedSize :
2106                uint64_t(ULEV(kconfig.workitemPrivateSegmentSize)),
2107                numBuf, 24);
2108        output += numBuf;
2109        output += "\n      KernargSegmentAlign: ";
2110        itocstrCStyle(hasValue(kernel.kernargSegmentAlign) ?
2111                kernel.kernargSegmentAlign :
2112                uint64_t(1ULL<<kconfig.kernargSegmentAlignment),
2113                numBuf, 24);
2114        output += numBuf;
2115        output += "\n      WavefrontSize:   ";
2116        itocstrCStyle(hasValue(kernel.wavefrontSize) ? kernel.wavefrontSize :
2117                cxuint(1U<<kconfig.wavefrontSize), numBuf, 24);
2118        output += numBuf;
2119        output += "\n      NumSGPRs:        ";
2120        itocstrCStyle(hasValue(kernel.sgprsNum) ? kernel.sgprsNum :
2121                cxuint(ULEV(kconfig.wavefrontSgprCount)), numBuf, 24);
2122        output += numBuf;
2123        output += "\n      NumVGPRs:        ";
2124        itocstrCStyle(hasValue(kernel.vgprsNum) ? kernel.vgprsNum :
2125                cxuint(ULEV(kconfig.workitemVgprCount)), numBuf, 24);
2126        output += numBuf;
2127        // spilled registers
2128        if (hasValue(kernel.spilledSgprs))
2129        {
2130            output += "\n      NumSpilledSGPRs: ";
2131            itocstrCStyle(kernel.spilledSgprs, numBuf, 24);
2132            output += numBuf;
2133        }
2134        if (hasValue(kernel.spilledVgprs))
2135        {
2136            output += "\n      NumSpilledVGPRs: ";
2137            itocstrCStyle(kernel.spilledVgprs, numBuf, 24);
2138            output += numBuf;
2139        }
2140        output += "\n      MaxFlatWorkGroupSize: ";
2141        itocstrCStyle(hasValue(kernel.maxFlatWorkGroupSize) ?
2142                    kernel.maxFlatWorkGroupSize : uint64_t(256), numBuf, 24);
2143        output += numBuf;
2144        output += "\n";
2145        if (kernel.fixedWorkGroupSize[0] != 0 || kernel.fixedWorkGroupSize[1] != 0 ||
2146            kernel.fixedWorkGroupSize[2] != 0)
2147        {
2148            output += "      FixedWorkGroupSize:   ";
2149            genArrayValue(3, kernel.fixedWorkGroupSize, output);
2150        }
2151    }
2152    output += "...\n";
2153}
2154
2155/* ROCm section generators */
2156
2157class CLRX_INTERNAL ROCmGotGen: public ElfRegionContent
2158{
2159private:
2160    const ROCmInput* input;
2161public:
2162    explicit ROCmGotGen(const ROCmInput* _input) : input(_input)
2163    { }
2164   
2165    void operator()(FastOutputBuffer& fob) const
2166    {
2167        fob.fill(input->gotSymbols.size()*8, 0);
2168    }
2169};
2170
2171class CLRX_INTERNAL ROCmRelaDynGen: public ElfRegionContent
2172{
2173private:
2174    size_t gotOffset;
2175    const ROCmInput* input;
2176public:
2177    explicit ROCmRelaDynGen(const ROCmInput* _input) : gotOffset(0), input(_input)
2178    { }
2179   
2180    void setGotOffset(size_t _gotOffset)
2181    { gotOffset = _gotOffset; }
2182   
2183    void operator()(FastOutputBuffer& fob) const
2184    {
2185        for (size_t i = 0; i < input->gotSymbols.size(); i++)
2186        {
2187            size_t symIndex = input->gotSymbols[i];
2188            Elf64_Rela rela{};
2189            SLEV(rela.r_offset, gotOffset + 8*i);
2190            SLEV(rela.r_info, ELF64_R_INFO(symIndex + 1, 3));
2191            rela.r_addend = 0;
2192            fob.writeObject(rela);
2193        }
2194    }
2195};
2196
2197/*
2198 * ROCm Binary Generator
2199 */
2200
2201ROCmBinGenerator::ROCmBinGenerator() : manageable(false), input(nullptr)
2202{ }
2203
2204ROCmBinGenerator::ROCmBinGenerator(const ROCmInput* rocmInput)
2205        : manageable(false), input(rocmInput), rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2206{ }
2207
2208ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
2209        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
2210        size_t globalDataSize, const cxbyte* globalData,
2211        const std::vector<ROCmSymbolInput>& symbols) :
2212        rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2213{
2214    std::unique_ptr<ROCmInput> _input(new ROCmInput{});
2215    _input->deviceType = deviceType;
2216    _input->archMinor = archMinor;
2217    _input->archStepping = archStepping;
2218    _input->eflags = 0;
2219    _input->newBinFormat = false;
2220    _input->globalDataSize = globalDataSize;
2221    _input->globalData = globalData;
2222    _input->symbols = symbols;
2223    _input->codeSize = codeSize;
2224    _input->code = code;
2225    _input->commentSize = 0;
2226    _input->comment = nullptr;
2227    _input->target = "";
2228    _input->targetTripple = "";
2229    _input->metadataSize = 0;
2230    _input->metadata = nullptr;
2231    _input->useMetadataInfo = false;
2232    _input->metadataInfo = ROCmMetadata{};
2233    input = _input.release();
2234}
2235
2236ROCmBinGenerator::ROCmBinGenerator(GPUDeviceType deviceType,
2237        uint32_t archMinor, uint32_t archStepping, size_t codeSize, const cxbyte* code,
2238        size_t globalDataSize, const cxbyte* globalData,
2239        std::vector<ROCmSymbolInput>&& symbols) :
2240        rocmGotGen(nullptr), rocmRelaDynGen(nullptr)
2241{
2242    std::unique_ptr<ROCmInput> _input(new ROCmInput{});
2243    _input->deviceType = deviceType;
2244    _input->archMinor = archMinor;
2245    _input->archStepping = archStepping;
2246    _input->eflags = 0;
2247    _input->newBinFormat = false;
2248    _input->globalDataSize = globalDataSize;
2249    _input->globalData = globalData;
2250    _input->symbols = std::move(symbols);
2251    _input->codeSize = codeSize;
2252    _input->code = code;
2253    _input->commentSize = 0;
2254    _input->comment = nullptr;
2255    _input->target = "";
2256    _input->targetTripple = "";
2257    _input->metadataSize = 0;
2258    _input->metadata = nullptr;
2259    _input->useMetadataInfo = false;
2260    _input->metadataInfo = ROCmMetadata{};
2261    input = _input.release();
2262}
2263
2264ROCmBinGenerator::~ROCmBinGenerator()
2265{
2266    if (manageable)
2267        delete input;
2268    if (rocmGotGen!=nullptr)
2269        delete (ROCmGotGen*)rocmGotGen;
2270    if (rocmRelaDynGen!=nullptr)
2271        delete (ROCmRelaDynGen*)rocmRelaDynGen;
2272}
2273
2274void ROCmBinGenerator::setInput(const ROCmInput* input)
2275{
2276    if (manageable)
2277        delete input;
2278    manageable = false;
2279    this->input = input;
2280}
2281
2282// ELF notes contents
2283static const cxbyte noteDescType1[8] =
2284{ 2, 0, 0, 0, 1, 0, 0, 0 };
2285
2286static const cxbyte noteDescType3[27] =
2287{ 4, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2288  'A', 'M', 'D', 0, 'A', 'M', 'D', 'G', 'P', 'U', 0 };
2289
2290static inline void addMainSectionToTable(cxuint& sectionsNum, uint16_t* builtinTable,
2291                cxuint elfSectId)
2292{ builtinTable[elfSectId - ELFSECTID_START] = sectionsNum++; }
2293
2294void ROCmBinGenerator::prepareBinaryGen()
2295{
2296    AMDGPUArchVersion amdGpuArchValues = getGPUArchVersion(input->deviceType,
2297                GPUArchVersionTable::ROCM);
2298    if (input->archMinor!=UINT32_MAX)
2299        amdGpuArchValues.minor = input->archMinor;
2300    if (input->archStepping!=UINT32_MAX)
2301        amdGpuArchValues.stepping = input->archStepping;
2302   
2303    comment = "CLRX ROCmBinGenerator " CLRX_VERSION;
2304    commentSize = ::strlen(comment);
2305    if (input->comment!=nullptr)
2306    {
2307        // if comment, store comment section
2308        comment = input->comment;
2309        commentSize = input->commentSize;
2310        if (commentSize==0)
2311            commentSize = ::strlen(comment);
2312    }
2313   
2314    uint32_t eflags = input->newBinFormat ? 2 : 0;
2315    if (input->eflags != BINGEN_DEFAULT)
2316        eflags = input->eflags;
2317   
2318    std::fill(mainBuiltinSectTable,
2319              mainBuiltinSectTable + ROCMSECTID_MAX-ELFSECTID_START+1, SHN_UNDEF);
2320    mainSectionsNum = 1;
2321   
2322    // generate main builtin section table (for section id translation)
2323    if (input->newBinFormat)
2324        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_NOTE);
2325    if (input->globalData != nullptr)
2326        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_RODATA);
2327    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_DYNSYM);
2328    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_HASH);
2329    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_DYNSTR);
2330    if (!input->gotSymbols.empty())
2331        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_RELADYN);
2332    const cxuint execProgHeaderRegionIndex = mainSectionsNum;
2333    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_TEXT);
2334    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_DYNAMIC);
2335    if (!input->gotSymbols.empty())
2336        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_GOT);
2337    if (!input->newBinFormat)
2338    {
2339        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_NOTE);
2340        addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ROCMSECTID_GPUCONFIG);
2341    }
2342    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_COMMENT);
2343    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_SYMTAB);
2344    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_SHSTRTAB);
2345    addMainSectionToTable(mainSectionsNum, mainBuiltinSectTable, ELFSECTID_STRTAB);
2346   
2347    elfBinGen64.reset(new ElfBinaryGen64({ 0U, 0U, 0x40, 0, ET_DYN, 0xe0, EV_CURRENT,
2348            cxuint(input->newBinFormat ? execProgHeaderRegionIndex : UINT_MAX), 0, eflags },
2349            true, true, true, PHREGION_FILESTART));
2350   
2351    static const int32_t dynTags[] = {
2352        DT_SYMTAB, DT_SYMENT, DT_STRTAB, DT_STRSZ, DT_HASH };
2353    elfBinGen64->addDynamics(sizeof(dynTags)/sizeof(int32_t), dynTags);
2354   
2355    // elf program headers
2356    elfBinGen64->addProgramHeader({ PT_PHDR, PF_R, 0, 1,
2357                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2358    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R, PHREGION_FILESTART,
2359                    execProgHeaderRegionIndex,
2360                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 0x1000 });
2361    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R|PF_X, execProgHeaderRegionIndex, 1,
2362                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2363    elfBinGen64->addProgramHeader({ PT_LOAD, PF_R|PF_W, execProgHeaderRegionIndex+1,
2364                    cxuint(1 + (!input->gotSymbols.empty())),
2365                    true, Elf64Types::nobase, Elf64Types::nobase, 0 });
2366    elfBinGen64->addProgramHeader({ PT_DYNAMIC, PF_R|PF_W, execProgHeaderRegionIndex+1, 1,
2367                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 8 });
2368    elfBinGen64->addProgramHeader({ PT_GNU_RELRO, PF_R, execProgHeaderRegionIndex+1,
2369                    cxuint(1 + (!input->gotSymbols.empty())),
2370                    true, Elf64Types::nobase, Elf64Types::nobase, 0, 1 });
2371    elfBinGen64->addProgramHeader({ PT_GNU_STACK, PF_R|PF_W, PHREGION_FILESTART, 0,
2372                    true, 0, 0, 0 });
2373   
2374    if (input->newBinFormat)
2375        // program header for note (new binary format)
2376        elfBinGen64->addProgramHeader({ PT_NOTE, PF_R, 1, 1, true,
2377                    Elf64Types::nobase, Elf64Types::nobase, 0, 4 });
2378   
2379    target = input->target.c_str();
2380    if (target.empty() && !input->targetTripple.empty())
2381    {
2382        target = input->targetTripple.c_str();
2383        char dbuf[20];
2384        snprintf(dbuf, 20, "-gfx%u%u%u", amdGpuArchValues.major, amdGpuArchValues.minor,
2385                 amdGpuArchValues.stepping);
2386        target += dbuf;
2387    }
2388    // elf notes
2389    elfBinGen64->addNote({"AMD", sizeof noteDescType1, noteDescType1, 1U});
2390    noteBuf.reset(new cxbyte[0x1b]);
2391    ::memcpy(noteBuf.get(), noteDescType3, 0x1b);
2392    SULEV(*(uint32_t*)(noteBuf.get()+4), amdGpuArchValues.major);
2393    SULEV(*(uint32_t*)(noteBuf.get()+8), amdGpuArchValues.minor);
2394    SULEV(*(uint32_t*)(noteBuf.get()+12), amdGpuArchValues.stepping);
2395    elfBinGen64->addNote({"AMD", 0x1b, noteBuf.get(), 3U});
2396    if (!target.empty())
2397        elfBinGen64->addNote({"AMD", target.size(), (const cxbyte*)target.c_str(), 0xbU});
2398   
2399    metadataSize = input->metadataSize;
2400    metadata = input->metadata;
2401    if (input->useMetadataInfo)
2402    {
2403        // generate ROCm metadata
2404        std::vector<std::pair<CString, size_t> > symbolIndices(input->symbols.size());
2405        // create sorted indices of symbols by its name
2406        for (size_t k = 0; k < input->symbols.size(); k++)
2407            symbolIndices[k] = std::make_pair(input->symbols[k].symbolName, k);
2408        mapSort(symbolIndices.begin(), symbolIndices.end());
2409       
2410        const size_t mdKernelsNum = input->metadataInfo.kernels.size();
2411        std::unique_ptr<const ROCmKernelConfig*[]> kernelConfigPtrs(
2412                new const ROCmKernelConfig*[mdKernelsNum]);
2413        // generate ROCm kernel config pointers
2414        for (size_t k = 0; k < mdKernelsNum; k++)
2415        {
2416            auto it = binaryMapFind(symbolIndices.begin(), symbolIndices.end(), 
2417                        input->metadataInfo.kernels[k].name);
2418            if (it == symbolIndices.end() ||
2419                (input->symbols[it->second].type != ROCmRegionType::FKERNEL &&
2420                 input->symbols[it->second].type != ROCmRegionType::KERNEL))
2421                throw BinGenException("Kernel in metadata doesn't exists in code");
2422            kernelConfigPtrs[k] = reinterpret_cast<const ROCmKernelConfig*>(
2423                        input->code + input->symbols[it->second].offset);
2424        }
2425        // just generate ROCm metadata from info
2426        generateROCmMetadata(input->metadataInfo, kernelConfigPtrs.get(), metadataStr);
2427        metadataSize = metadataStr.size();
2428        metadata = metadataStr.c_str();
2429    }
2430   
2431    if (metadataSize != 0)
2432        elfBinGen64->addNote({"AMD", metadataSize, (const cxbyte*)metadata, 0xaU});
2433   
2434    /// region and sections
2435    elfBinGen64->addRegion(ElfRegion64::programHeaderTable());
2436    if (input->newBinFormat)
2437        elfBinGen64->addRegion(ElfRegion64::noteSection());
2438    if (input->globalData != nullptr)
2439        elfBinGen64->addRegion(ElfRegion64(input->globalDataSize, input->globalData, 4,
2440                ".rodata", SHT_PROGBITS, SHF_ALLOC, 0, 0, Elf64Types::nobase));
2441   
2442    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
2443                ".dynsym", SHT_DYNSYM, SHF_ALLOC, 0, BINGEN_DEFAULT, Elf64Types::nobase));
2444    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 4,
2445                ".hash", SHT_HASH, SHF_ALLOC,
2446                mainBuiltinSectTable[ELFSECTID_DYNSYM-ELFSECTID_START], 0,
2447                Elf64Types::nobase));
2448    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1, ".dynstr", SHT_STRTAB,
2449                SHF_ALLOC, 0, 0, Elf64Types::nobase));
2450    if (!input->gotSymbols.empty())
2451    {
2452        ROCmRelaDynGen* sgen = new ROCmRelaDynGen(input);
2453        rocmRelaDynGen = (void*)sgen;
2454        elfBinGen64->addRegion(ElfRegion64(input->gotSymbols.size()*sizeof(Elf64_Rela),
2455                sgen, 8, ".rela.dyn", SHT_RELA, SHF_ALLOC,
2456                mainBuiltinSectTable[ELFSECTID_DYNSYM-ELFSECTID_START], 0,
2457                Elf64Types::nobase, sizeof(Elf64_Rela)));
2458    }
2459    // '.text' with alignment=4096
2460    elfBinGen64->addRegion(ElfRegion64(input->codeSize, (const cxbyte*)input->code, 
2461              0x1000, ".text", SHT_PROGBITS, SHF_ALLOC|SHF_EXECINSTR, 0, 0,
2462              Elf64Types::nobase, 0, false, 256));
2463    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 0x1000,
2464                ".dynamic", SHT_DYNAMIC, SHF_ALLOC|SHF_WRITE,
2465                mainBuiltinSectTable[ELFSECTID_DYNSTR-ELFSECTID_START], 0,
2466                Elf64Types::nobase, 0, false, 8));
2467    if (!input->gotSymbols.empty())
2468    {
2469        ROCmGotGen* sgen = new ROCmGotGen(input);
2470        rocmGotGen = (void*)sgen;
2471        elfBinGen64->addRegion(ElfRegion64(input->gotSymbols.size()*8, sgen,
2472                8, ".got", SHT_PROGBITS,
2473                SHF_ALLOC|SHF_WRITE, 0, 0, Elf64Types::nobase));
2474    }
2475    if (!input->newBinFormat)
2476    {
2477        elfBinGen64->addRegion(ElfRegion64::noteSection());
2478        elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 1,
2479                    ".AMDGPU.config", SHT_PROGBITS, 0));
2480    }
2481    elfBinGen64->addRegion(ElfRegion64(commentSize, (const cxbyte*)comment, 1, ".comment",
2482              SHT_PROGBITS, SHF_MERGE|SHF_STRINGS, 0, 0, 0, 1));
2483    elfBinGen64->addRegion(ElfRegion64(0, (const cxbyte*)nullptr, 8,
2484                ".symtab", SHT_SYMTAB, 0, 0, BINGEN_DEFAULT));
2485    elfBinGen64->addRegion(ElfRegion64::shstrtabSection());
2486    elfBinGen64->addRegion(ElfRegion64::strtabSection());
2487    elfBinGen64->addRegion(ElfRegion64::sectionHeaderTable());
2488   
2489    /* extra sections */
2490    for (const BinSection& section: input->extraSections)
2491        elfBinGen64->addRegion(ElfRegion64(section, mainBuiltinSectTable,
2492                         ROCMSECTID_MAX, mainSectionsNum));
2493    updateSymbols();
2494    binarySize = elfBinGen64->countSize();
2495   
2496    if (rocmRelaDynGen != nullptr)
2497        ((ROCmRelaDynGen*)rocmRelaDynGen)->setGotOffset(
2498                elfBinGen64->getRegionOffset(
2499                        mainBuiltinSectTable[ROCMSECTID_GOT - ELFSECTID_START]));
2500}
2501
2502void ROCmBinGenerator::updateSymbols()
2503{
2504    elfBinGen64->clearSymbols();
2505    elfBinGen64->clearDynSymbols();
2506    // add symbols (kernels, function kernels and data symbols)
2507    elfBinGen64->addSymbol(ElfSymbol64("_DYNAMIC",
2508                  mainBuiltinSectTable[ROCMSECTID_DYNAMIC-ELFSECTID_START],
2509                  ELF64_ST_INFO(STB_LOCAL, STT_NOTYPE), STV_HIDDEN, true, 0, 0));
2510    const uint16_t textSectIndex = mainBuiltinSectTable[ELFSECTID_TEXT-ELFSECTID_START];
2511    for (const ROCmSymbolInput& symbol: input->symbols)
2512    {
2513        ElfSymbol64 elfsym;
2514        switch (symbol.type)
2515        {
2516            case ROCmRegionType::KERNEL:
2517                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2518                      ELF64_ST_INFO(STB_GLOBAL, STT_GNU_IFUNC), 0, true,
2519                      symbol.offset, symbol.size);
2520                break;
2521            case ROCmRegionType::FKERNEL:
2522                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2523                      ELF64_ST_INFO(STB_GLOBAL, STT_FUNC), 0, true,
2524                      symbol.offset, symbol.size);
2525                break;
2526            case ROCmRegionType::DATA:
2527                elfsym = ElfSymbol64(symbol.symbolName.c_str(), textSectIndex,
2528                      ELF64_ST_INFO(STB_GLOBAL, STT_OBJECT), 0, true,
2529                      symbol.offset, symbol.size);
2530                break;
2531            default:
2532                break;
2533        }
2534        // add to symbols and dynamic symbols table
2535        elfBinGen64->addSymbol(elfsym);
2536        elfBinGen64->addDynSymbol(elfsym);
2537    }
2538    /* extra symbols */
2539    for (const BinSymbol& symbol: input->extraSymbols)
2540    {
2541        ElfSymbol64 sym(symbol, mainBuiltinSectTable,
2542                         ROCMSECTID_MAX, mainSectionsNum);
2543        elfBinGen64->addSymbol(sym);
2544        elfBinGen64->addDynSymbol(sym);
2545    }
2546}
2547
2548void ROCmBinGenerator::generateInternal(std::ostream* osPtr, std::vector<char>* vPtr,
2549             Array<cxbyte>* aPtr)
2550{
2551    if (elfBinGen64 == nullptr)
2552        prepareBinaryGen();
2553    /****
2554     * prepare for write binary to output
2555     ****/
2556    std::unique_ptr<std::ostream> outStreamHolder;
2557    std::ostream* os = nullptr;
2558    if (aPtr != nullptr)
2559    {
2560        aPtr->resize(binarySize);
2561        outStreamHolder.reset(
2562                new ArrayOStream(binarySize, reinterpret_cast<char*>(aPtr->data())));
2563        os = outStreamHolder.get();
2564    }
2565    else if (vPtr != nullptr)
2566    {
2567        vPtr->resize(binarySize);
2568        outStreamHolder.reset(new VectorOStream(*vPtr));
2569        os = outStreamHolder.get();
2570    }
2571    else // from argument
2572        os = osPtr;
2573   
2574    const std::ios::iostate oldExceptions = os->exceptions();
2575    try
2576    {
2577    os->exceptions(std::ios::failbit | std::ios::badbit);
2578    /****
2579     * write binary to output
2580     ****/
2581    FastOutputBuffer bos(256, *os);
2582    elfBinGen64->generate(bos);
2583    assert(bos.getWritten() == binarySize);
2584   
2585    if (rocmGotGen != nullptr)
2586    {
2587        delete (ROCmGotGen*)rocmGotGen;
2588        rocmGotGen = nullptr;
2589    }
2590    if (rocmRelaDynGen != nullptr)
2591    {
2592        delete (ROCmGotGen*)rocmRelaDynGen;
2593        rocmRelaDynGen = nullptr;
2594    }
2595    }
2596    catch(...)
2597    {
2598        os->exceptions(oldExceptions);
2599        throw;
2600    }
2601    os->exceptions(oldExceptions);
2602}
2603
2604void ROCmBinGenerator::generate(Array<cxbyte>& array)
2605{
2606    generateInternal(nullptr, nullptr, &array);
2607}
2608
2609void ROCmBinGenerator::generate(std::ostream& os)
2610{
2611    generateInternal(&os, nullptr, nullptr);
2612}
2613
2614void ROCmBinGenerator::generate(std::vector<char>& v)
2615{
2616    generateInternal(nullptr, &v, nullptr);
2617}
Note: See TracBrowser for help on using the repository browser.