Merge pull request #1066 from asuessenbach/DispatchLoaderStatic

Introduce getDispatchLoaderStatic() to prevent dangling pointers in debug builds.

VulkanHppGenerator.cpp

@@ -16343,20 +16343,29 @@ int main( int argc, char ** argv )
 #  endif
 #endif
 
-#if !defined(VULKAN_HPP_DEFAULT_DISPATCHER)
+#if !defined( VULKAN_HPP_DEFAULT_DISPATCHER )
 #  if VULKAN_HPP_DISPATCH_LOADER_DYNAMIC == 1
 #    define VULKAN_HPP_DEFAULT_DISPATCHER ::VULKAN_HPP_NAMESPACE::defaultDispatchLoaderDynamic
-#  define VULKAN_HPP_DEFAULT_DISPATCH_LOADER_DYNAMIC_STORAGE namespace VULKAN_HPP_NAMESPACE { VULKAN_HPP_STORAGE_API DispatchLoaderDynamic defaultDispatchLoaderDynamic; }
+#    define VULKAN_HPP_DEFAULT_DISPATCH_LOADER_DYNAMIC_STORAGE                     \
+      namespace VULKAN_HPP_NAMESPACE                                               \
+      {                                                                            \
+        VULKAN_HPP_STORAGE_API DispatchLoaderDynamic defaultDispatchLoaderDynamic; \
+      }
   extern VULKAN_HPP_STORAGE_API DispatchLoaderDynamic defaultDispatchLoaderDynamic;
 #  else
-#  define VULKAN_HPP_DEFAULT_DISPATCHER ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic()
+  static ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic & getDispatchLoaderStatic()
+  {
+    static ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic dls;
+    return dls;
+  }
+#    define VULKAN_HPP_DEFAULT_DISPATCHER ::VULKAN_HPP_NAMESPACE::getDispatchLoaderStatic()
 #    define VULKAN_HPP_DEFAULT_DISPATCH_LOADER_DYNAMIC_STORAGE
 #  endif
 #endif
 
-#if !defined(VULKAN_HPP_DEFAULT_DISPATCHER_TYPE)
+#if !defined( VULKAN_HPP_DEFAULT_DISPATCHER_TYPE )
 #  if VULKAN_HPP_DISPATCH_LOADER_DYNAMIC == 1
-  #define VULKAN_HPP_DEFAULT_DISPATCHER_TYPE ::VULKAN_HPP_NAMESPACE::DispatchLoaderDynamic
+#    define VULKAN_HPP_DEFAULT_DISPATCHER_TYPE ::VULKAN_HPP_NAMESPACE::DispatchLoaderDynamic
 #  else
 #    define VULKAN_HPP_DEFAULT_DISPATCHER_TYPE ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic
 #  endif

tests/ArrayProxy/ArrayProxy.cpp

@@ -30,6 +30,9 @@ int main( int /*argc*/, char ** /*argv*/ )
 {
   try
   {
+    // to prevent a warning on unreferenced function vk::getDispatchLoaderStatic, use just one arbitrary vk-function
+    vk::enumerateInstanceVersion();
+
     // nullptr_t
     fct( nullptr );
     fctc( nullptr );

tests/ArrayProxyNoTemporaries/ArrayProxyNoTemporaries.cpp

@@ -66,6 +66,9 @@ int main( int /*argc*/, char ** /*argv*/ )
 {
   try
   {
+    // to prevent a warning on unreferenced function vk::getDispatchLoaderStatic, use just one arbitrary vk-function
+    vk::enumerateInstanceVersion();
+
     // nullptr_t
     fct(nullptr);
     fctc(nullptr);

tests/DesignatedInitializers/DesignatedInitializers.cpp

@@ -50,6 +50,9 @@ MyVulkanTest::MyVulkanTest()
 
 int main( int /*argc*/, char ** /*argv*/ )
 {
+  // to prevent a warning on unreferenced function vk::getDispatchLoaderStatic, use just one arbitrary vk-function
+  vk::enumerateInstanceVersion();
+
   char const * appName       = "DesignatedInitializers";
   uint32_t     appVersion    = 1;
   char const * engineName    = "Vulkan.hpp";

tests/DispatchLoaderStatic/CMakeLists.txt

@@ -0,0 +1,44 @@
+# Copyright(c) 2018, NVIDIA CORPORATION. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+cmake_minimum_required(VERSION 3.2)
+
+if (NOT TESTS_BUILD_ONLY_DYNAMIC)
+
+  project(DispatchLoaderStatic)
+
+  set(HEADERS
+  )
+
+  set(SOURCES
+    DispatchLoaderStatic.cpp
+  )
+
+  source_group(headers FILES ${HEADERS})
+  source_group(sources FILES ${SOURCES})
+
+  add_executable(DispatchLoaderStatic
+    ${HEADERS}
+    ${SOURCES}
+    )
+
+  if (UNIX)
+    target_link_libraries(DispatchLoaderStatic "-ldl")
+  endif()
+
+  target_link_libraries(DispatchLoaderStatic "${Vulkan_LIBRARIES}")
+
+  set_target_properties(DispatchLoaderStatic PROPERTIES FOLDER "Tests")
+
+endif()

tests/DispatchLoaderStatic/DispatchLoaderStatic.cpp

@@ -0,0 +1,49 @@
+// Copyright(c) 2018, NVIDIA CORPORATION. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// VulkanHpp Samples : DispatchLoaderStatic
+//                     Compile test on DispatchLoaderStatic functions
+
+#include "vulkan/vulkan.hpp"
+
+#include <iostream>
+#include <map>
+
+int main( int /*argc*/, char ** /*argv*/ )
+{
+  try
+  {
+    vk::Instance instance = vk::createInstance( {} );
+
+    std::vector<vk::PhysicalDevice> physicalDevices = instance.enumeratePhysicalDevices();
+    assert( !physicalDevices.empty() );
+
+    vk::Device device = physicalDevices[0].createDevice( {} );
+
+    device.destroy();
+    instance.destroy();
+  }
+  catch ( vk::SystemError const & err )
+  {
+    std::cout << "vk::SystemError: " << err.what() << std::endl;
+    exit( -1 );
+  }
+  catch ( ... )
+  {
+    std::cout << "unknown error\n";
+    exit( -1 );
+  }
+
+  return 0;
+}

vulkan/vulkan.hpp

@@ -5634,7 +5634,12 @@ namespace VULKAN_HPP_NAMESPACE
       }
   extern VULKAN_HPP_STORAGE_API DispatchLoaderDynamic defaultDispatchLoaderDynamic;
 #  else
-#    define VULKAN_HPP_DEFAULT_DISPATCHER ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic()
+  static ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic & getDispatchLoaderStatic()
+  {
+    static ::VULKAN_HPP_NAMESPACE::DispatchLoaderStatic dls;
+    return dls;
+  }
+#    define VULKAN_HPP_DEFAULT_DISPATCHER ::VULKAN_HPP_NAMESPACE::getDispatchLoaderStatic()
 #    define VULKAN_HPP_DEFAULT_DISPATCH_LOADER_DYNAMIC_STORAGE
 #  endif
 #endif