Merge FCL and IGC flag parsing and dump path logic

- Remove ~300 lines of duplicated flag/registry code from clang_tb.cpp
- Add igc_dump_paths.cpp/hpp with shared dump path logic
- Add ExtractIGCOptsFromOptions() to igc_regkeys.cpp for reusable
  -igc_opts parsing
- Update CMakeLists for common, OCLFE, and UniversalAdapter
- Add ocloc lit test for shader dumps via env vars and -igc_opts

FCL previously had its own registry/env reading and per-flag accessors
duplicating igc_regkeys logic. It now calls LoadRegistryKeys() and uses
IGC_IS_FLAG_ENABLED / IGC_GET_REGKEYSTRING directly.

Dump path functions (GetBaseIGCOutputFolder, GetShaderOutputFolder,
SetShaderOutputFolder) are extracted from customApi.cpp into shared
igc_dump_paths files that compile in both FCL and IGC contexts.
AdaptorCommon/customApi.hpp and Debug::SetDebugFlag calls are guarded
behind #ifndef IGC_FCL_BUILD.

Author: fda0

IGC/AdaptorCommon/customApi.cpp

@@ -79,7 +79,6 @@ static struct {
 } g_dumpFlags[static_cast<int>(IGC::Debug::DumpType::END)] = {};
 
 std::string g_shaderCorpusName;
-std::string g_shaderOutputFolder;
 std::string g_shaderOutputName;
 
 } // namespace
@@ -295,101 +294,8 @@ void IGC_DEBUG_API_CALL SetShaderCorpusName(CorpusName name) { g_shaderCorpusNam
 
 CorpusName IGC_DEBUG_API_CALL GetShaderCorpusName() { return g_shaderCorpusName.c_str(); }
 
-void IGC_DEBUG_API_CALL SetShaderOutputFolder(OutputFolderName name) { g_shaderOutputFolder = name; }
 void IGC_DEBUG_API_CALL SetShaderOutputName(OutputName name) { g_shaderOutputName = name; }
 
-bool needMkDir() {
-  return IGC_IS_FLAG_ENABLED(DumpLLVMIR) || IGC_IS_FLAG_ENABLED(EnableCosDump) ||
-         IGC_IS_FLAG_ENABLED(EnableVISAOutput) || IGC_IS_FLAG_ENABLED(EnableVISABinary) ||
-         IGC_IS_FLAG_ENABLED(EnableVISADumpCommonISA) ||
-         GetDebugFlag(DebugFlag::DUMP_AFTER_PASSES) || GetDebugFlag(DebugFlag::VISA_OUTPUT) ||
-         GetDebugFlag(DebugFlag::VISA_BINARY) || GetDebugFlag(DebugFlag::VISA_DUMPCOMMONISA) ||
-         IGC_IS_FLAG_ENABLED(EnableCapsDump) || IGC_IS_FLAG_ENABLED(ShaderOverride) ||
-         IGC_IS_FLAG_ENABLED(GenerateOptionsFile);
-}
-
-OutputFolderName IGC_DEBUG_API_CALL GetBaseIGCOutputFolder() {
-  static std::mutex m;
-  std::lock_guard<std::mutex> lck(m);
-  static std::string IGCBaseFolder;
-  if (IGCBaseFolder != "") {
-    return IGCBaseFolder.c_str();
-  }
-#if defined(_WIN64) || defined(_WIN32)
-  if (!IGC_IS_FLAG_ENABLED(DumpToCurrentDir) && !IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    bool needMkdir = needMkDir();
-
-    char dumpPath[256];
-
-    sprintf_s(dumpPath, "c:\\Intel\\");
-    if (GetFileAttributesA(dumpPath) != FILE_ATTRIBUTE_DIRECTORY && needMkdir) {
-      _mkdir(dumpPath);
-    }
-
-    sprintf_s(dumpPath, "c:\\Intel\\IGC\\");
-    if (GetFileAttributesA(dumpPath) != FILE_ATTRIBUTE_DIRECTORY && needMkdir) {
-      _mkdir(dumpPath);
-    }
-
-    // Make sure we can write in the dump folder as the app may be sandboxed
-    if (needMkdir) {
-      int tmp_id = _getpid();
-      std::string testFilename = std::string(dumpPath) + "testfile" + std::to_string(tmp_id);
-      HANDLE testFile =
-          CreateFileA(testFilename.c_str(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_FLAG_DELETE_ON_CLOSE, NULL);
-      if (testFile == INVALID_HANDLE_VALUE) {
-        char temppath[256];
-        if (GetTempPathA(sizeof(temppath), temppath) != 0) {
-          sprintf_s(dumpPath, "%sIGC\\", temppath);
-        }
-      } else {
-        CloseHandle(testFile);
-      }
-    }
-
-    if (GetFileAttributesA(dumpPath) != FILE_ATTRIBUTE_DIRECTORY && needMkdir) {
-      _mkdir(dumpPath);
-    }
-
-    IGCBaseFolder = dumpPath;
-  } else if (IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    std::string dumpPath = "c:\\Intel\\IGC\\"; // default if something goes wrong
-    const char *custom_dir = IGC_GET_REGKEYSTRING(DumpToCustomDir);
-    if (custom_dir != nullptr && strlen(custom_dir) > 0) {
-      dumpPath = custom_dir;
-    }
-
-    char pathBuf[256];
-    iSTD::CreateAppOutputDir(pathBuf, 256, dumpPath.c_str(), false, false, false);
-
-    IGCBaseFolder = pathBuf;
-  }
-#elif defined ANDROID
-
-  if (IGC_IS_FLAG_ENABLED(DumpToCurrentDir))
-    return "";
-  IGCBaseFolder = "/sdcard/intel/igc/";
-
-#elif defined __linux__
-  if (!IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    IGCBaseFolder = "/tmp/IntelIGC/";
-  } else {
-    std::string dumpPath = "/tmp/IntelIGC/"; // default if something goes wrong
-    const char *custom_dir = IGC_GET_REGKEYSTRING(DumpToCustomDir);
-    if (custom_dir != nullptr && strlen(custom_dir) > 0) {
-      dumpPath = custom_dir;
-      dumpPath += "/";
-    }
-
-    char pathBuf[256];
-    iSTD::CreateAppOutputDir(pathBuf, 256, dumpPath.c_str(), false, false, false);
-
-    IGCBaseFolder = pathBuf;
-  }
-#endif
-  return IGCBaseFolder.c_str();
-}
-
 std::string &GetShaderOverridePathString() {
   static std::string path = []() -> std::string {
     if (IGC_IS_FLAG_DISABLED(ShaderOverride)) {
@@ -425,82 +331,6 @@ OutputFolderName IGC_DEBUG_API_CALL GetShaderOverridePath() {
   return overridePath.c_str();
 }
 
-OutputFolderName IGC_DEBUG_API_CALL GetShaderOutputFolder() {
-  static std::mutex m;
-  std::lock_guard<std::mutex> lck(m);
-  if (g_shaderOutputFolder != "" && doesRegexMatch(g_shaderOutputFolder, IGC_GET_REGKEYSTRING(ShaderDumpRegexFilter))) {
-    return g_shaderOutputFolder.c_str();
-  }
-#if defined(_WIN64) || defined(_WIN32)
-  if (!IGC_IS_FLAG_ENABLED(DumpToCurrentDir) && !IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    char dumpPath[256];
-    sprintf_s(dumpPath, "%s", GetBaseIGCOutputFolder());
-    char appPath[MAX_PATH] = {0};
-    // check a process id and make an adequate directory for it:
-
-    if (::GetModuleFileNameA(NULL, appPath, sizeof(appPath) - 1)) {
-      std::string appPathStr = std::string(appPath);
-      int pos = appPathStr.find_last_of("\\") + 1;
-
-      if (IGC_IS_FLAG_ENABLED(ShaderDumpPidDisable)) {
-        sprintf_s(dumpPath, "%s%s\\", dumpPath, appPathStr.substr(pos, MAX_PATH).c_str());
-      } else {
-        sprintf_s(dumpPath, "%s%s_%d\\", dumpPath, appPathStr.substr(pos, MAX_PATH).c_str(), _getpid());
-      }
-    } else {
-      sprintf_s(dumpPath, "%sunknownProcess_%d\\", dumpPath, _getpid());
-    }
-
-    if (needMkDir() && doesRegexMatch(dumpPath, IGC_GET_REGKEYSTRING(ShaderDumpRegexFilter))) {
-      if (GetFileAttributesA(dumpPath) != FILE_ATTRIBUTE_DIRECTORY) {
-        _mkdir(dumpPath);
-      }
-      g_shaderOutputFolder = dumpPath;
-    } else {
-      // To make the path always invalid.
-      g_shaderOutputFolder = "NUL\\";
-    }
-  } else if (IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    char pathBuf[256];
-    iSTD::CreateAppOutputDir(pathBuf, 256, GetBaseIGCOutputFolder(), false, true,
-                             !IGC_IS_FLAG_ENABLED(ShaderDumpPidDisable));
-    g_shaderOutputFolder = pathBuf;
-  }
-#elif defined ANDROID
-
-  if (IGC_IS_FLAG_ENABLED(DumpToCurrentDir))
-    return "";
-
-  if (!SysUtils::CreateDir(GetBaseIGCOutputFolder(), true, IGC_IS_FLAG_DISABLED(ShaderDumpPidDisable),
-                           &g_shaderOutputFolder))
-
-    g_shaderOutputFolder = "";
-
-#elif defined __linux__
-  if (!IGC_IS_FLAG_ENABLED(DumpToCurrentDir) && g_shaderOutputFolder == "" && !IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    bool needMkdir =
-        needMkDir() && doesRegexMatch(GetBaseIGCOutputFolder(), IGC_GET_REGKEYSTRING(ShaderDumpRegexFilter));
-
-    char path[MAX_PATH] = {0};
-    bool pidEnabled = IGC_IS_FLAG_DISABLED(ShaderDumpPidDisable);
-
-    if (needMkdir) {
-      iSTD::CreateAppOutputDir(path, MAX_PATH, GetBaseIGCOutputFolder(), false, true, pidEnabled);
-      g_shaderOutputFolder = path;
-    } else {
-      // To make the path always invalid.
-      g_shaderOutputFolder = "/dev/null/";
-    }
-  } else if (IGC_IS_FLAG_ENABLED(DumpToCustomDir)) {
-    char pathBuf[256];
-    iSTD::CreateAppOutputDir(pathBuf, 256, GetBaseIGCOutputFolder(), false, false, false);
-    g_shaderOutputFolder = pathBuf;
-  }
-
-#endif
-  return g_shaderOutputFolder.c_str();
-}
-
 OutputName IGC_DEBUG_API_CALL GetFunctionDebugFile() {
   if (IGC_GET_FLAG_VALUE(SelectiveFunctionControl) != 0) {
     static std::mutex m;

IGC/AdaptorCommon/customApi.hpp

@@ -11,31 +11,12 @@ SPDX-License-Identifier: MIT
 #include "usc.h"
 #include "API/igc.h"
 #include "common/igc_regkeys.hpp"
+#include "common/igc_dump_paths.hpp"
 
 #if !defined(IGC_DEBUG_VARIABLES)
 #include <stdio.h>
 #endif
 
-// In _RELEASE builds, make these api functions available for internal use,
-// but do not export them in the dll.
-#if defined(IGC_DEBUG_VARIABLES)
-#if defined(_WIN32)
-#if defined(IGC_EXPORTS)
-#define IGC_DEBUG_API_CALL __declspec(dllexport)
-#else
-#define IGC_DEBUG_API_CALL __declspec(dllimport)
-#endif
-#else
-#if defined(IGC_EXPORTS)
-#define IGC_DEBUG_API_CALL __attribute__((visibility("default")))
-#else
-#define IGC_DEBUG_API_CALL
-#endif
-#endif
-#else
-#define IGC_DEBUG_API_CALL
-#endif
-
 namespace IGC {
 namespace Debug {
 /// enum to set the compiler flags from the custom API
@@ -181,15 +162,10 @@ void IGC_DEBUG_API_CALL SetShaderCorpusName(CorpusName name);
 /// Get the name for the to-be-compiled set of shaders
 CorpusName IGC_DEBUG_API_CALL GetShaderCorpusName();
 
-/// Set a name for the output folder
-void IGC_DEBUG_API_CALL SetShaderOutputFolder(OutputFolderName name);
-
 void IGC_DEBUG_API_CALL SetShaderOutputName(OutputName name);
 
 void IGC_DEBUG_API_CALL SetShaderOverridePath(OutputFolderName pOutputFolderName);
 OutputFolderName IGC_DEBUG_API_CALL GetShaderOverridePath();
-/// Get the name for the output folder
-OutputFolderName IGC_DEBUG_API_CALL GetShaderOutputFolder();
 
 OutputName IGC_DEBUG_API_CALL GetShaderOutputName();
 
@@ -282,12 +258,7 @@ inline void IGC_DEBUG_API_CALL SetShaderCorpusName(CorpusName name) { (void)name
 /// Returns empty string in _RELEASE builds
 inline CorpusName IGC_DEBUG_API_CALL GetShaderCorpusName() { return ""; }
 
-/// Does nothing in _RELEASE builds
-inline void IGC_DEBUG_API_CALL SetShaderOutputFolder(OutputFolderName name) { (void)name; }
 inline void IGC_DEBUG_API_CALL SetShaderOutputName(OutputName name) { (void)name; }
-
-/// Returns empty string in _RELEASE builds
-inline OutputFolderName IGC_DEBUG_API_CALL GetShaderOutputFolder() { return ""; }
 inline OutputName IGC_DEBUG_API_CALL GetShaderOutputName() { return ""; }
 
 inline void IGC_DEBUG_API_CALL SetShaderOverridePath(OutputFolderName pOutputFolderName) { (void)pOutputFolderName; }

IGC/AdaptorOCL/ocl_igc_interface/impl/fcl_ocl_translation_ctx_impl.cpp

@@ -7,7 +7,7 @@ SPDX-License-Identifier: MIT
 ============================= end_copyright_notice ===========================*/
 
 #include "ocl_igc_interface/impl/fcl_ocl_translation_ctx_impl.h"
-#include "AdaptorCommon/customApi.hpp"
+#include "common/igc_regkeys.hpp"
 #include "common/StringMacros.hpp"
 #include "common/VCPlatformSelector.hpp"
 #include "common/debug/Dump.hpp"
@@ -130,7 +130,7 @@ std::optional<FeShaderDumpData> getShaderDumpData(PLATFORM *Platform, const char
                                                   CIF::Builtins::BufferSimple *InternalOptions,
                                                   CIF::Builtins::BufferSimple *TracingOptions) {
 #if defined(_DEBUG) || defined(_INTERNAL)
-  if (!FCL_IGC_IS_FLAG_ENABLED(ShaderDumpEnable))
+  if (!IGC_IS_FLAG_ENABLED(ShaderDumpEnable))
     return {};
 
   return FeShaderDumpData(Platform, Selected, Stepping, Src, Options, InternalOptions, TracingOptions);

IGC/AdaptorOCL/ocl_igc_interface/impl/igc_ocl_translation_ctx_impl.h

@@ -237,27 +237,11 @@ CIF_DECLARE_INTERFACE_PIMPL(IgcOclTranslationCtx) : CIF::PimplBase {
     USC::SShaderStageBTLayout zeroLayout = USC::g_cZeroShaderStageBTLayout;
     IGC::COCLBTILayout oclLayout(&zeroLayout);
 
-    std::string RegKeysFlagsFromOptions;
-    if (inputArgs.pOptions != nullptr) {
-      std::string_view optionsWithFlags = inputArgs.pOptions;
-
-      // check if there are more instances of '-igc_opts'
-      while (!optionsWithFlags.empty()) {
-        std::size_t found = optionsWithFlags.find("-igc_opts");
-        if (found == std::string::npos)
-          break;
-
-        std::size_t foundFirstSingleQuote = optionsWithFlags.find('\'', found);
-        std::size_t foundSecondSingleQuote = optionsWithFlags.find('\'', foundFirstSingleQuote + 1);
-        if (foundFirstSingleQuote == std::string::npos || foundSecondSingleQuote == std::string::npos) {
-          outputInterface->GetImpl()->SetError(TranslationErrorType::Unused, "Missing single quotes for -igc_opts");
-          return outputInterface.release();
-        }
-        RegKeysFlagsFromOptions +=
-            optionsWithFlags.substr(foundFirstSingleQuote + 1, (foundSecondSingleQuote - foundFirstSingleQuote - 1));
-        RegKeysFlagsFromOptions = RegKeysFlagsFromOptions + ',';
-        optionsWithFlags = optionsWithFlags.substr(foundSecondSingleQuote + 1, optionsWithFlags.length());
-      }
+    std::string igcOptsError;
+    std::string RegKeysFlagsFromOptions = ExtractIGCOptsFromOptions(inputArgs.pOptions, igcOptsError);
+    if (!igcOptsError.empty()) {
+      outputInterface->GetImpl()->SetError(TranslationErrorType::Unused, igcOptsError.c_str());
+      return outputInterface.release();
     }
     bool RegFlagNameError = 0;
     LoadRegistryKeys(RegKeysFlagsFromOptions, &RegFlagNameError);

IGC/CMakeLists.txt

@@ -1816,6 +1816,9 @@ if (FCL_ENABLED)
   set_target_properties("${IGC_BUILD__PROJ__fcl_dll}" PROPERTIES FOLDER "Libraries")
 
   add_dependencies("${IGC_BUILD__PROJ__fcl_dll}" opencl-clang-lib)
+
+  target_compile_definitions("${IGC_BUILD__PROJ__fcl_dll}" PRIVATE
+      IGC_FCL_BUILD)
 endif()
 
 set(IGC_BUILD__HDR__IGC__igc_lib

IGC/OCLFE/CMakeLists.txt

@@ -31,6 +31,8 @@ set(IGC_BUILD__SRC__FCL
   "${CMAKE_CURRENT_SOURCE_DIR}/igd_fcl_mcl/source/clang_tb.cpp"
   "${CMAKE_CURRENT_SOURCE_DIR}/igd_fcl_mcl/source/clang_debug.cpp"
   "${CMAKE_CURRENT_SOURCE_DIR}/igd_fcl_mcl/source/LoadBuffer.cpp"
+  "${CMAKE_CURRENT_SOURCE_DIR}/../common/igc_regkeys.cpp"
+  "${CMAKE_CURRENT_SOURCE_DIR}/../common/igc_dump_paths.cpp"
   "${IGC_BUILD__SRC__IGC_Common_CLElfLib}"
 )
 

IGC/OCLFE/igd_fcl_mcl/headers/clang_tb.h

@@ -11,6 +11,7 @@ SPDX-License-Identifier: MIT
 #include "GlobalData.h"
 #include "igfxfmid.h"
 #include "TranslationBlock.h"
+#include "common/igc_dump_paths.hpp"
 #include <string>
 #include <memory>
 #include <vector>
@@ -137,22 +138,8 @@ class CClangTranslationBlock : public CTranslationBlock {
 
 namespace FCL {
 
-// type for name of output folder
-using OutputFolderName = const char *;
+using IGC::Debug::GetBaseIGCOutputFolder;
+using IGC::Debug::GetShaderOutputFolder;
+using IGC::Debug::OutputFolderName;
 
-// function returns full path where to dump shaders for FCL
-OutputFolderName GetShaderOutputFolder();
-
-// different register-dependent functions
-bool GetFCLShaderDumpEnable();
-bool GetFCLShaderDumpPidDisable();
-bool GetFCLDumpToCurrentDir();
-bool GetFCLDumpToCustomDir();
-bool GetFCLEnableKernelNamesBasedHash();
-#if LLVM_VERSION_MAJOR < 17
-bool GetFCLEnableOpaquePointersBackend();
-#endif
 } // namespace FCL
-
-// convenient macro to check FCL flags
-#define FCL_IGC_IS_FLAG_ENABLED(name) FCL::GetFCL##name()