Prepare to use gmm as dll on Windows

Since this commit neo on Windows can use static or shared gmm lib

Change-Id: I7db70d7f9bc969e8193ac77e8b6d65ecc57d0093

Author: JablonskiMateusz

CMakeLists.txt

@@ -240,8 +240,27 @@ if(NOT GMMUMD_LIB_NAME)
         endif()
     endif()
 endif()
+get_target_property(target_type ${GMMUMD_LIB_NAME} TYPE)
+
+if(target_type STREQUAL "STATIC_LIBRARY")
+  set(USE_STATIC_GMM TRUE)
+endif()
+
 set(UMKM_SHAREDDATA_INCLUDE_PATHS $<TARGET_PROPERTY:${GMMUMD_LIB_NAME},INTERFACE_INCLUDE_DIRECTORIES>)
 
+set(GMM_LIB_FILENAME "igdgmm${NEO_BITS}${CMAKE_SHARED_LIBRARY_SUFFIX}")
+
+macro(copy_gmm_dll_for target)
+  if(WIN32 AND NOT USE_STATIC_GMM)
+    add_dependencies(${target} ${GMMUMD_LIB_NAME})
+    add_custom_command(
+      TARGET ${target}
+      POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:${GMMUMD_LIB_NAME}> $<TARGET_FILE_DIR:${target}>
+    )
+  endif()
+endmacro()
+
 # Instrumentation detection
 if(NOT INSTRUMENTATION_LIB_NAME)
     if(INSTRUMENTATION_SOURCE_DIR)
@@ -534,3 +553,4 @@ include(package.cmake)
 configure_file(config.h.in ${IGDRCL_BUILD_DIR}/config.h)
 configure_file(compiler.config.h.in ${IGDRCL_BUILD_DIR}/compiler.config.h)
 configure_file(driver_version.h.in ${IGDRCL_BUILD_DIR}/driver_version.h) # Put Driver version into define
+configure_file(lib_names.h.in ${IGDRCL_BUILD_DIR}/lib_names.h)

lib_names.h.in

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef LIB_NAMES_H
+#define LIB_NAMES_H
+
+#cmakedefine GMM_LIB_FILENAME "${GMM_LIB_FILENAME}"
+
+#endif /* LIB_NAMES_H */

runtime/CMakeLists.txt

@@ -100,7 +100,11 @@ target_compile_definitions(${NEO_STATIC_LIB_NAME} PUBLIC DEFAULT_PLATFORM=${DEFA
 
 link_directories(${GMM_LIB_PATHS})
 
-target_link_libraries(${NEO_STATIC_LIB_NAME} ${GMMUMD_LIB_NAME})
+if(UNIX OR USE_STATIC_GMM)
+  target_link_libraries(${NEO_STATIC_LIB_NAME} ${GMMUMD_LIB_NAME})
+else()
+  target_compile_definitions(${NEO_STATIC_LIB_NAME} PUBLIC GMM_LIB_DLL)
+endif()
 
 if(INSTRUMENTATION_LIB_NAME)
   add_dependencies(${NEO_STATIC_LIB_NAME} ${INSTRUMENTATION_LIB_NAME})
@@ -134,6 +138,7 @@ if(${GENERATE_EXECUTABLE})
   add_library(${NEO_DYNAMIC_LIB_NAME} SHARED
     ${NEO_DYNAMIC_LIB__TARGET_OBJECTS}
   )
+  add_dependencies(${NEO_DYNAMIC_LIB_NAME} ${GMMUMD_LIB_NAME})
 
   if(GTPIN_HEADERS_DIR)
     macro(macro_for_each_gen)

runtime/dll/windows/options.cpp

@@ -19,6 +19,7 @@
  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  */
+#include "lib_names.h"
 
 namespace Os {
 #if defined(_WIN64)
@@ -30,4 +31,5 @@ const char *igcDllName = "igc32.dll";
 #endif
 
 const char *gdiDllName = "gdi32.dll";
+const char *gmmDllName = GMM_LIB_FILENAME;
 } // namespace Os

runtime/gmm_helper/gmm_helper.cpp

@@ -31,28 +31,6 @@
 #include "runtime/helpers/hw_info.h"
 #include "runtime/sku_info/operations/sku_info_transfer.h"
 
-extern "C" {
-
-void GMMDebugBreak(const char *file, const char *function, const int line) {
-}
-
-void GMMPrintMessage(uint32_t debugLevel, const char *debugMessageFmt, ...) {
-}
-
-typedef struct GfxDebugControlRec {
-    uint32_t Version;
-    uint32_t Size;
-    uint32_t AssertEnableMask;
-    uint32_t EnableDebugFileDump;
-    uint32_t DebugEnableMask;
-    uint32_t RingBufDbgMask;
-    uint32_t ReportAssertEnable;
-    uint32_t AssertBreakDisable;
-
-} GFX_DEBUG_CONTROL, *PGFX_DEBUG_CONTROL;
-PGFX_DEBUG_CONTROL pDebugControl;
-}
-
 namespace OCLRT {
 void Gmm::create() {
     if (resourceParams.BaseWidth >= maxPossiblePitch) {
@@ -71,19 +49,21 @@ bool Gmm::initContext(const PLATFORM *pPlatform,
         _WA_TABLE gmmWaTable = {};
         SkuInfoTransfer::transferFtrTableForGmm(&gmmFtrTable, pSkuTable);
         SkuInfoTransfer::transferWaTableForGmm(&gmmWaTable, pWaTable);
-
-        bool success = GMM_SUCCESS == GmmInitGlobalContext(*pPlatform, &gmmFtrTable, &gmmWaTable, pGtSysInfo, GMM_CLIENT::GMM_OCL_VISTA);
+        if (!isLoaded) {
+            loadLib();
+        }
+        bool success = GMM_SUCCESS == initGlobalContextFunc(*pPlatform, &gmmFtrTable, &gmmWaTable, pGtSysInfo, GMM_CLIENT::GMM_OCL_VISTA);
         UNRECOVERABLE_IF(!success);
-        Gmm::gmmClientContext = GmmCreateClientContext(GMM_CLIENT::GMM_OCL_VISTA);
+        Gmm::gmmClientContext = createClientContextFunc(GMM_CLIENT::GMM_OCL_VISTA);
     }
     return Gmm::gmmClientContext != nullptr;
 }
 
 void Gmm::destroyContext() {
     if (Gmm::gmmClientContext) {
-        GmmDeleteClientContext(Gmm::gmmClientContext);
+        deleteClientContextFunc(Gmm::gmmClientContext);
         Gmm::gmmClientContext = nullptr;
-        GmmDestroyGlobalContext();
+        destroyGlobalContextFunc();
     }
 }
 
@@ -414,5 +394,6 @@ bool Gmm::unifiedAuxTranslationCapable() const {
 
 bool Gmm::useSimplifiedMocsTable = false;
 GMM_CLIENT_CONTEXT *Gmm::gmmClientContext = nullptr;
+bool Gmm::isLoaded = false;
 
 } // namespace OCLRT

runtime/gmm_helper/gmm_helper.h

@@ -27,12 +27,6 @@
 #include "runtime/gmm_helper/gmm_lib.h"
 #include "runtime/api/cl_types.h"
 
-extern "C" {
-void GMMDebugBreak(const char *file, const char *function, const int line);
-
-void GMMPrintMessage(uint32_t debugLevel, const char *debugMessageFmt, ...);
-}
-
 namespace OCLRT {
 struct HardwareInfo;
 struct FeatureTable;
@@ -63,6 +57,7 @@ class Gmm {
     static Gmm *create(GMM_RESOURCE_INFO *inputGmm);
 
     static bool initContext(const PLATFORM *pPlatform, const FeatureTable *pSkuTable, const WorkaroundTable *pWaTable, const GT_SYSTEM_INFO *pGtSysInfo);
+    static void loadLib();
     static void destroyContext();
 
     static uint32_t getMOCS(uint32_t type);
@@ -97,8 +92,14 @@ class Gmm {
     GMM_RESCREATE_PARAMS resourceParams = {};
     std::unique_ptr<GmmResourceInfo> gmmResourceInfo;
 
+    static decltype(&GmmInitGlobalContext) initGlobalContextFunc;
+    static decltype(&GmmDestroyGlobalContext) destroyGlobalContextFunc;
+    static decltype(&GmmCreateClientContext) createClientContextFunc;
+    static decltype(&GmmDeleteClientContext) deleteClientContextFunc;
+
     bool isRenderCompressed = false;
     static bool useSimplifiedMocsTable;
     static GMM_CLIENT_CONTEXT *gmmClientContext;
+    static bool isLoaded;
 };
 } // namespace OCLRT

runtime/gmm_helper/gmm_memory_base.cpp

@@ -46,7 +46,7 @@ bool GmmMemoryBase::configureDeviceAddressSpace(GMM_ESCAPE_HANDLE hAdapter,
 }
 
 uintptr_t GmmMemoryBase::getInternalGpuVaRangeLimit() {
-    return static_cast<uintptr_t>(pGmmGlobalContext->GetInternalGpuVaRangeLimit());
+    return static_cast<uintptr_t>(Gmm::gmmClientContext->GetInternalGpuVaRangeLimit());
 }
 
 }; // namespace OCLRT

runtime/gmm_helper/page_table_mngr.cpp

@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2017, Intel Corporation
+* Copyright (c) 2017 - 2018, Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
@@ -24,7 +24,7 @@
 #include "runtime/gmm_helper/page_table_mngr.h"
 
 namespace OCLRT {
-GmmPageTableMngr *GmmPageTableMngr::create(GMM_DEVICE_CALLBACKS *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb) {
+GmmPageTableMngr *GmmPageTableMngr::create(GMM_DEVICE_CALLBACKS_INT *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb) {
     return new GmmPageTableMngr(deviceCb, translationTableFlags, translationTableCb);
 }
 

runtime/gmm_helper/page_table_mngr.h

@@ -30,7 +30,7 @@ class GmmPageTableMngr {
   public:
     MOCKABLE_VIRTUAL ~GmmPageTableMngr() = default;
 
-    static GmmPageTableMngr *create(GMM_DEVICE_CALLBACKS *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb);
+    static GmmPageTableMngr *create(GMM_DEVICE_CALLBACKS_INT *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb);
 
     MOCKABLE_VIRTUAL GMM_STATUS initContextAuxTableRegister(HANDLE initialBBHandle, GMM_ENGINE_TYPE engineType) {
         return pageTableManager->InitContextAuxTableRegister(initialBBHandle, engineType);
@@ -50,7 +50,7 @@ class GmmPageTableMngr {
 
     GmmPageTableMngr() = default;
 
-    GmmPageTableMngr(GMM_DEVICE_CALLBACKS *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb);
+    GmmPageTableMngr(GMM_DEVICE_CALLBACKS_INT *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb);
 
     UniquePtrType pageTableManager;
 };

runtime/gmm_helper/page_table_mngr_impl.cpp

@@ -28,7 +28,7 @@ void GmmPageTableMngr::customDeleter(GMM_PAGETABLE_MGR *gmmPageTableManager) {
     Gmm::gmmClientContext->DestroyPageTblMgrObject(gmmPageTableManager);
 }
 
-GmmPageTableMngr::GmmPageTableMngr(GMM_DEVICE_CALLBACKS *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb) {
+GmmPageTableMngr::GmmPageTableMngr(GMM_DEVICE_CALLBACKS_INT *deviceCb, unsigned int translationTableFlags, GMM_TRANSLATIONTABLE_CALLBACKS *translationTableCb) {
     auto pageTableMngrPtr = Gmm::gmmClientContext->CreatePageTblMgrObject(deviceCb, translationTableCb, translationTableFlags);
     this->pageTableManager = UniquePtrType(pageTableMngrPtr, GmmPageTableMngr::customDeleter);
 }