Reland ZEBIN: Add NT_INTELGT_ZEBIN_VERSION for whole ELF versioning.

The description of the new ELF note NT_INTELGT_ZEBIN_VERSION represents
the ZEBIN ELF file version that reflects the attribute and section
changes. The content is stored in a nul-terminated string and the format
is "<Major number>.<Minor number>". For example, it's "1.16\0" with this
change.

Currently the version information is in both .ze_info and the new ELF
note in order not to break any existing tools. After switching to the
ELF note, we can decide if we want to remove the version in .ze_info or
keep the redundant info in both places.

Also separate version information as a version.md from zeinfo md file
because now it should reflect all ELF section and zeinfo attribute
changes.

Author: petechou

IGC/ZEBinWriter/zebin/source/ZEELF.h

@@ -46,9 +46,16 @@ enum R_TYPE_ZEBIN
 
 // ELF note type for INTELGT
 enum {
+    // The description is the Product family stored in a 4-byte ELF word
     NT_INTELGT_PRODUCT_FAMILY = 1,
+    // The description is the GFXCORE family stored in a 4-byte ELF word
     NT_INTELGT_GFXCORE_FAMILY = 2,
+    // The description is the TargetMetadata structure defined below
     NT_INTELGT_TARGET_METADATA = 3,
+    // The description represents the ZEBIN ELF file version that reflects the
+    // attribute and section changes. The content is stored in a nul-terminated
+    // string and the format is "<Major number>.<Minor number>".
+    NT_INTELGT_ZEBIN_VERSION = 4,
 };
 
 struct TargetMetadata {

IGC/ZEBinWriter/zebin/source/ZEELFObjectBuilder.cpp

@@ -591,6 +591,16 @@ std::pair<uint64_t, uint64_t> ELFWriter::writeCompatibilityNote() {
         padToRequiredAlign();
     };
 
+    auto writeOneStrNote = [&](StringRef owner, StringRef desc, uint32_t type) {
+        m_W.write<uint32_t>(owner.size() + 1);
+        m_W.write<uint32_t>(desc.size() + 1);
+        m_W.write<uint32_t>(type);
+        m_W.OS << owner << '\0';
+        padToRequiredAlign();
+        m_W.OS << desc << '\0';
+        padToRequiredAlign();
+    };
+
     // Align the section offset to the required alignment first.
     // TODO: Handle the section alignment in a more generic place..
     padToRequiredAlign();
@@ -609,6 +619,11 @@ std::pair<uint64_t, uint64_t> ELFWriter::writeCompatibilityNote() {
     writeOneNote("IntelGT",
                  m_ObjBuilder.m_metadata.packed,
                  NT_INTELGT_TARGET_METADATA);
+
+    // write NT_INTELGT_ZEBIN_VERSION
+    writeOneStrNote("IntelGT",
+                    PreDefinedAttrGetter::getVersionNumber(),
+                    NT_INTELGT_ZEBIN_VERSION);
     return std::make_pair(start_off, m_W.OS.tell() - start_off);
 }
 

IGC/ZEBinWriter/zebin/source/autogen/ZEInfo.hpp

@@ -179,7 +179,7 @@ struct zeInfoContainer
     HostAccessesTy global_host_access_table;
 };
 struct PreDefinedAttrGetter{
-    static zeinfo_str_t getVersionNumber() { return "1.15"; }
+    static zeinfo_str_t getVersionNumber() { return "1.16"; }
 
     enum class ArgThreadSchedulingMode {
         age_based,

IGC/ZEBinWriter/zebin/spec/elf.md

@@ -7,6 +7,8 @@ SPDX-License-Identifier: MIT
 ============================= end_copyright_notice ==========================-->
 
 # ELF Layout
+The version information of ZEBIN can be found in version.md. ELF changes should
+be documented properly in version.md.
 
 | Contents | Description | Section Type |
 | ------ | ------ |  ------ |
@@ -102,9 +104,16 @@ recognize both the owner name (INTELGT) and the type of an ELF note entry to
 interpret its description.
 ~~~
 enum {
-    NT_INTELGT_PRODUCT_FAMILY = 1, // the description is the Product family stored in a 4-byte ELF word
-    NT_INTELGT_GFXCORE_FAMILY = 2, // the description is the GFXCORE family stored in a 4-byte ELF word
-    NT_INTELGT_TARGET_METADATA = 3, // the description is the TargetMetadata structure defined below
+    // The description is the Product family stored in a 4-byte ELF word
+    NT_INTELGT_PRODUCT_FAMILY = 1,
+    // The description is the GFXCORE family stored in a 4-byte ELF word
+    NT_INTELGT_GFXCORE_FAMILY = 2,
+    // The description is the TargetMetadata structure defined below
+    NT_INTELGT_TARGET_METADATA = 3,
+    // The description represents the ZEBIN ELF file version that reflects the
+    // attribute and section changes. The content is stored in a nul-terminated
+    // string and the format is "<Major number>.<Minor number>".
+    NT_INTELGT_ZEBIN_VERSION = 4,
 };
 ~~~
 

IGC/ZEBinWriter/zebin/spec/version.md

@@ -0,0 +1,34 @@
+<!---======================= begin_copyright_notice ============================
+
+Copyright (C) 2022 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ==========================-->
+
+# ZEBIN Version
+Version 1.16
+
+## Versioning
+Format: \<_Major number_\>.\<_Minor number_\>
+- Major number: Increase when non-backward-compatible features are added. For example, rename attributes or remove attributes.
+- Minor number: Increase when backward-compatible features are added. For example, add new attributes.
+
+## Change Note
+- **Version 1.16**: Add NT_INTELGT_ZEBIN_VERSION note to represent the ZEBIN ELF file version.
+- **Version 1.15**: Add image_type, image_transformable, and sampler_type attributes to payload argument. Add new image and sampler argument types.
+- **Version 1.14**: Add slm_alignment to payload argument.
+- **Version 1.13**: Add functions with the name and execution env.
+- **Version 1.12**: Add global_host_access_table to container.
+- **Version 1.11**: Add require_disable_eufusion attribute.
+- **Version 1.10**: Add thread_scheduling_mode to execution_env.
+- **Version 1.9**: Add source_offset to payload argument.
+- **Version 1.8**: Add inline_data_payload_size to execution_env.
+- **Version 1.7**: Add debug_env to kernel.
+- **Version 1.6**: Remove actual_kernel_start_offset from execution environment.
+- **Version 1.5**: Add payload_argument type work_dimensions.
+- **Version 1.4**: Add sampler_index to payload arguments.
+- **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.

IGC/ZEBinWriter/zebin/spec/zeinfo.md

@@ -6,8 +6,9 @@ SPDX-License-Identifier: MIT
 
 ============================= end_copyright_notice ==========================-->
 
-# ZE Info
-Version 1.15
+## Version
+The version information of ZEBIN can be found in version.md. ZEINFO changes
+should be documented properly in version.md.
 
 ## Grammar
 
@@ -353,25 +354,3 @@ This section defines mapping between device and host name of a global variable.
 | host_name | str | User-specified global variable name derived from HostAccesINTEL decoration. Used to access global variable from host API calls. |
 <!--- HostAccess HostAccesses --->
 
-## Versioning
-Format: \<_Major number_\>.\<_Minor number_\>
-- Major number: Increase when non-backward-compatible features are added. For example, rename attributes or remove attributes.
-- Minor number: Increase when backward-compatible features are added. For example, add new attributes.
-
-## Change Note
-- **Version 1.15**: Add image_type, image_transformable, and sampler_type attributes to payload argument. Add new image and sampler argument types.
-- **Version 1.14**: Add slm_alignment to payload argument.
-- **Version 1.13**: Add functions with the name and execution env.
-- **Version 1.12**: Add global_host_access_table to container.
-- **Version 1.11**: Add require_disable_eufusion attribute.
-- **Version 1.10**: Add thread_scheduling_mode to execution_env.
-- **Version 1.9**: Add source_offset to payload argument.
-- **Version 1.8**: Add inline_data_payload_size to execution_env.
-- **Version 1.7**: Add debug_env to kernel.
-- **Version 1.6**: Remove actual_kernel_start_offset from execution environment.
-- **Version 1.5**: Add payload_argument type work_dimensions.
-- **Version 1.4**: Add sampler_index to payload arguments.
-- **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.