ZEBinary printf support

DianaChen · igcbot · commit 242dc4adf0c9 · 2021-03-10T22:46:50.000+01:00
- create symbols for string literals those defined in .data.const.string
- Spec update: add new payload_argument type "printf_buffer" for implicit argument printf buffer
diff --git a/IGC/AdaptorOCL/OCL/sp/zebin_builder.cpp b/IGC/AdaptorOCL/OCL/sp/zebin_builder.cpp
@@ -137,8 +137,7 @@ void ZEBinaryBuilder::addGlobalConstants(const IGC::SOpenCLProgramInfo& annotati
         return;
 
     // create a data section for global constant variables
-    // Two constant data sections: general constants and string literals
-    IGC_ASSERT(annotations.m_initConstantAnnotation.size() >= 1);
+    // There could be two constant data sections: general constants and string literals
 
     // General constants
     // create a data section for global constant variables
@@ -177,9 +176,12 @@ void ZEBinaryBuilder::addGlobalConstants(const IGC::SOpenCLProgramInfo& annotati
         }
     }
 
-    if (annotations.m_initConstantAnnotation.size() != 2)
+    if (annotations.m_initConstantAnnotation.size() < 2)
       return;
 
+    // At most two const global buffers: general and string literals
+    IGC_ASSERT(annotations.m_initConstantAnnotation.size() == 2);
+
     // String literals
     auto& caString = annotations.m_initConstantAnnotation[1];
     if (caString->InlineData.size() > 0)
@@ -392,6 +394,12 @@ void ZEBinaryBuilder::addSymbols(
             getSymbolElfBinding(sym), getSymbolElfType(sym),
             (sym.s_type == vISA::GenSymType::S_UNDEF) ? -1 : mGlobalConstSectID);
 
+    // add symbols defined in global string constant section
+    for (auto sym : symbols.globalStringConst)
+        mBuilder.addSymbol(sym.s_name, sym.s_offset, sym.s_size,
+            getSymbolElfBinding(sym), getSymbolElfType(sym),
+            (sym.s_type == vISA::GenSymType::S_UNDEF) ? -1 : mConstStringSectID);
+
     // add symbols defined in global section
     for (auto sym : symbols.global)
         mBuilder.addSymbol(sym.s_name, sym.s_offset, sym.s_size,
diff --git a/IGC/Compiler/CISACodeGen/CISABuilder.cpp b/IGC/Compiler/CISACodeGen/CISABuilder.cpp
@@ -4865,12 +4865,20 @@ namespace IGC
                     sEntry.s_size = int_cast<uint32_t>(pModule->getDataLayout().getTypeAllocSize(pGlobal->getType()->getPointerElementType()));
                     sEntry.s_offset = static_cast<uint32_t>(global.second);
                     // symbols for ZEBinary
-                    if (sEntry.s_type == vISA::GenSymType::S_GLOBAL_VAR)
+                    if (sEntry.s_type == vISA::GenSymType::S_GLOBAL_VAR) {
                         symbols.global.emplace_back((vISA::GenSymType)sEntry.s_type,
                             sEntry.s_offset, sEntry.s_size, name.str());
-                    else
-                        symbols.globalConst.emplace_back((vISA::GenSymType)sEntry.s_type,
-                            sEntry.s_offset, sEntry.s_size, name.str());
+                    } else {
+                        // Global constants and string literals
+                        Constant * initializer = pGlobal->getInitializer();
+                        ConstantDataSequential * cds = dyn_cast<ConstantDataSequential>(initializer);
+                        if (cds && (cds->isCString() || cds->isString()))
+                            symbols.globalStringConst.emplace_back((vISA::GenSymType)sEntry.s_type,
+                                sEntry.s_offset, sEntry.s_size, name.str());
+                        else
+                            symbols.globalConst.emplace_back((vISA::GenSymType)sEntry.s_type,
+                                sEntry.s_offset, sEntry.s_size, name.str());
+                    }
                 }
                 symbolTable.push_back(sEntry);
             }
diff --git a/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.cpp b/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.cpp
@@ -490,7 +490,6 @@ namespace IGC
     {
         switch (kernelArg->getArgType()) {
 
-        // Implicit args
         case KernelArg::ArgType::IMPLICIT_PAYLOAD_HEADER:{
             // PayloadHeader contains global work offset x,y,z and local size x,y,z
             // global work offset, size is int32x3
@@ -701,6 +700,12 @@ namespace IGC
         }
         break;
 
+        case KernelArg::ArgType::IMPLICIT_PRINTF_BUFFER:
+            zebin::ZEInfoBuilder::addPayloadArgumentImplicit(m_kernelInfo.m_zePayloadArgs,
+                zebin::PreDefinedAttrGetter::ArgType::printf_buffer,
+                payloadPosition, kernelArg->getAllocateSize());
+            break;
+
         // We don't need these in ZEBinary, can safely skip them
         case KernelArg::ArgType::IMPLICIT_R0:
         case KernelArg::ArgType::R1:
diff --git a/IGC/Compiler/CodeGenPublic.h b/IGC/Compiler/CodeGenPublic.h
@@ -95,11 +95,12 @@ namespace IGC
         typedef std::vector<vISA::ZERelocEntry> RelocListTy;
         typedef std::vector<vISA::ZEFuncAttribEntry> FuncAttrListTy;
         struct SymbolLists {
-            SymbolListTy function;    // function symbols
-            SymbolListTy global;      // global symbols
-            SymbolListTy globalConst; // global constant symbols
-            SymbolListTy sampler;     // sampler symbols
-            SymbolListTy local;       // local symbols
+            SymbolListTy function;          // function symbols
+            SymbolListTy global;            // global symbols
+            SymbolListTy globalConst;       // global constant symbols
+            SymbolListTy globalStringConst; // global string constant symbols
+            SymbolListTy sampler;           // sampler symbols
+            SymbolListTy local;             // local symbols
         };
 
     public:
diff --git a/IGC/ZEBinWriter/zebin/source/autogen/ZEInfo.hpp b/IGC/ZEBinWriter/zebin/source/autogen/ZEInfo.hpp
@@ -122,7 +122,7 @@ struct zeInfoContainer
     KernelsTy kernels;
 };
 struct PreDefinedAttrGetter{
-    static zeinfo_str_t getVersionNumber() { return "1.2"; }
+    static zeinfo_str_t getVersionNumber() { return "1.3"; }
 
     enum class ArgType {
         packed_local_ids,
@@ -134,6 +134,7 @@ struct PreDefinedAttrGetter{
         global_id_offset,
         private_base_stateless,
         buffer_offset,
+        printf_buffer,
         arg_byvalue,
         arg_bypointer
     };
@@ -185,6 +186,8 @@ struct PreDefinedAttrGetter{
             return "private_base_stateless";
         case ArgType::buffer_offset:
             return "buffer_offset";
+        case ArgType::printf_buffer:
+            return "printf_buffer";
         case ArgType::arg_byvalue:
             return "arg_byvalue";
         case ArgType::arg_bypointer:
diff --git a/IGC/ZEBinWriter/zebin/spec/zeinfo.md b/IGC/ZEBinWriter/zebin/spec/zeinfo.md
@@ -23,7 +23,7 @@ IN THE SOFTWARE.
 ============================= end_copyright_notice ==========================-->
 
 # ZE Info
-Version 1.2
+Version 1.3
 
 ## Grammar
 
@@ -157,6 +157,7 @@ Supported <argument_type> of payload_arguments or per_thread_payload_arguments.
 | global_id_offset | int32x3 | |
 | private_base_stateless | int64 | The base address of private buffer specified at per_thread_memory_buffers |
 | buffer_offset | | The extra offset for buffer reference to satisfy the alignment requirement of stateful memory access. |
+| printf_buffer | | The address of printf_buffer which holds the prtinf strings information. |
 | arg_byvalue | | Explicit kernel argument |
 | arg_bypointer | | Explicit kernel argument |
 <!--- <argument_type> ArgType -->
@@ -269,6 +270,7 @@ Format: \<_Major number_\>.\<_Minor number_\>
 - Minor number: Increase when backward-compatible features are added. For example, add new attributes.
 
 ## Change Note
+- **Version 1.3**: Add printf_buffer to argument_type.
 - **Version 1.2**: Add buffer_offset to argument_type.
 - **Version 1.1**: Add experimental_properties to kernel.
 - **Version 1.0**: Add version number. Add slot to per_thread_memory_buffers. Rename shared_local_memory to slm in memory_addressing_mode.
