Fix elf_parser.h and tests for ze_debug_info (#144)

* Fix `elf_parser.h` as a follow up to 99d428a
* Fix two more issues in static code analysis.
* Fix tests for `ze_debug_info` and add warning for out-dated sample.

Signed-off-by: Schilling, Matthew <[email protected]>

Author: mschilling0

VERSION

@@ -1 +1 @@
-0.49.26
+0.49.27

samples/cl_debug_info/README.md

@@ -131,4 +131,4 @@ Also one may need to add an actual path to IGA *.dll into PATH before sample run
 ```
 set PATH=%PATH%;<iga_dll_path>
 cl_debug_info.exe ..\..\cl_gemm\build\cl_gemm.exe
-```
+```

samples/cl_debug_info/cl_debug_info_collector.h

@@ -531,4 +531,4 @@ class ClDebugInfoCollector {
   KernelDebugInfoMap kernel_debug_info_map_;
 };
 
-#endif // PTI_SAMPLES_CL_DEBUG_INFO_CL_DEBUG_INFO_COLLECTOR_H_
+#endif // PTI_SAMPLES_CL_DEBUG_INFO_CL_DEBUG_INFO_COLLECTOR_H_

samples/ze_debug_info/README.md

@@ -98,6 +98,10 @@ As a result, listing like the following will be printed for each kernel (once pe
 - [Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver](https://github.com/intel/compute-runtime)
 
 ## Build and Run
+
+**Note**: This sample does not support IGC's latest binary format (ZEBinary).
+To use this sample, run `export IGC_EnableZEBinary=0` before running the sample.
+
 ### Linux
 Run the following commands to build the sample:
 ```sh
@@ -138,4 +142,4 @@ Also one may need to add an actual path to IGA *.dll into PATH before sample run
 ```
 set PATH=%PATH%;<iga_dll_path>
 ze_debug_info.exe ..\..\ze_gemm\build\ze_gemm.exe
-```
+```

samples/ze_debug_info/ze_debug_info_collector.h

@@ -43,6 +43,10 @@ using KernelDebugInfoMap = std::map<std::string, KernelDebugInfo>;
 class ZeDebugInfoCollector {
  public: // User Interface
   static ZeDebugInfoCollector* Create() {
+    std::cout << "[INFO] At the moment, this sample is incompatible with" <<
+      " IGC's ZE binary format." << std::endl;
+    std::cout << "Run `export IGC_EnableZEBinary=0` to use old format." << std::endl;
+
     ZeDebugInfoCollector* collector = new ZeDebugInfoCollector();
     PTI_ASSERT(collector != nullptr);
 
@@ -357,4 +361,4 @@ class ZeDebugInfoCollector {
   KernelDebugInfoMap kernel_debug_info_map_;
 };
 
-#endif // PTI_SAMPLES_ZE_DEBUG_INFO_ZE_DEBUG_INFO_COLLECTOR_H_
+#endif // PTI_SAMPLES_ZE_DEBUG_INFO_ZE_DEBUG_INFO_COLLECTOR_H_

tests/samples/ze_debug_info.py

@@ -43,6 +43,7 @@ def run(path, option):
   return None
 
 def main(option):
+  os.environ["IGC_EnableZEBinary"] = "0"
   path = utils.get_sample_build_path("ze_debug_info")
   if option == "dpc":
     log = dpc_gemm.main("gpu")
@@ -68,4 +69,4 @@ def main(option):
     option = "dpc"
   log = main(option)
   if log:
-    print(log)
+    print(log)

utils/debug_line_parser.h

@@ -9,6 +9,7 @@
 
 #include <string.h>
 
+#include <cstdint>
 #include <string>
 #include <vector>
 
@@ -87,6 +88,8 @@ class DebugLineParser {
 
     ptr += sizeof(Dwarf32LineNumberProgramHeader);
 
+    // Each decode parses sizeof(uint32_t) bytes and moves ptr
+    PTI_ASSERT(sizeof(uint32_t)*header->opcode_base < size_ + sizeof(uint32_t));
     // standard_opcode_lengths
     for (uint8_t i = 1; i < header->opcode_base; ++i) {
       uint32_t value = 0;
@@ -137,4 +140,4 @@ class DebugLineParser {
   uint32_t size_;
 };
 
-#endif // PTI_UTILS_DEBUG_LINE_PARSER_H_
+#endif // PTI_UTILS_DEBUG_LINE_PARSER_H_

utils/elf_parser.h

@@ -9,6 +9,7 @@
 
 #include <string.h>
 
+#include <limits>
 #include <vector>
 
 #include "elf.h"
@@ -21,7 +22,7 @@ class ElfParser {
   ElfParser(const uint8_t* data, uint32_t size) : data_(data), size_(size) {}
 
   bool IsValid() const {
-    if (data_ == nullptr || size_ != sizeof(Elf64Header)) {
+    if (data_ == nullptr || size_ < sizeof(Elf64Header)) {
       return false;
     }
 
@@ -150,12 +151,14 @@ class ElfParser {
                   const uint8_t** section,
                   uint64_t* section_size) const {
     PTI_ASSERT(section != nullptr && section_size != nullptr);
-    if (data_ == nullptr || size_ != sizeof(Elf64Header)) {
+    if (data_ == nullptr || size_ < sizeof(Elf64Header)) {
+      *section = nullptr;
+      *section_size = 0;
       return;
     }
 
     const Elf64Header* header = reinterpret_cast<const Elf64Header*>(data_);
-    PTI_ASSERT(data_ + (header->shoff*sizeof(Elf64SectionHeader)) <= data_ + size_);
+    PTI_ASSERT(data_ + header->shoff + sizeof(Elf64SectionHeader) <= data_ + size_);
     const Elf64SectionHeader* section_header =
       reinterpret_cast<const Elf64SectionHeader*>(data_ + header->shoff);
 

utils/gen_symbols_decoder.h

@@ -66,6 +66,8 @@ class GenSymbolsDecoder {
       reinterpret_cast<const iOpenCL::SProgramDebugDataHeaderIGC*>(ptr);
     ptr += sizeof(iOpenCL::SProgramDebugDataHeaderIGC);
 
+    PTI_ASSERT(header->NumberOfKernels <= IGC_MAX_VALUE);
+
     for (uint32_t i = 0; i < header->NumberOfKernels; ++i) {
       const iOpenCL::SKernelDebugDataHeaderIGC* kernel_header =
         reinterpret_cast<const iOpenCL::SKernelDebugDataHeaderIGC*>(ptr);
@@ -103,4 +105,4 @@ class GenSymbolsDecoder {
   size_t size_ = 0;
 };
 
-#endif // PTI_UTILS_GEN_SYMBOLS_DECODER_H_
+#endif // PTI_UTILS_GEN_SYMBOLS_DECODER_H_