Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 1 | /* |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 2 | * |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 3 | * Copyright (c) 2015-2016 The Khronos Group Inc. |
| 4 | * Copyright (c) 2015-2016 Valve Corporation |
| 5 | * Copyright (c) 2015-2016 LunarG, Inc. |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 6 | * |
Jon Ashburn | 3ebf125 | 2016-04-19 11:30:31 -0600 | [diff] [blame] | 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | * you may not use this file except in compliance with the License. |
| 9 | * You may obtain a copy of the License at |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 10 | * |
Jon Ashburn | 3ebf125 | 2016-04-19 11:30:31 -0600 | [diff] [blame] | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 12 | * |
Jon Ashburn | 3ebf125 | 2016-04-19 11:30:31 -0600 | [diff] [blame] | 13 | * Unless required by applicable law or agreed to in writing, software |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | * See the License for the specific language governing permissions and |
| 17 | * limitations under the License. |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 18 | * |
| 19 | * Author: Ian Elliot <ian@lunarg.com> |
| 20 | * Author: Jon Ashburn <jon@lunarg.com> |
Courtney Goeltzenleuchter | 0555952 | 2015-10-30 11:14:30 -0600 | [diff] [blame] | 21 | * |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 22 | */ |
Jon Ashburn | 3f8c300 | 2015-10-15 13:47:58 -0600 | [diff] [blame] | 23 | #pragma once |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 24 | |
Mark Lobodzinski | 450e463 | 2015-11-24 12:04:15 -0700 | [diff] [blame] | 25 | #if defined(_WIN32) |
| 26 | // WinSock2.h must be included *BEFORE* windows.h |
Mark Lobodzinski | 450e463 | 2015-11-24 12:04:15 -0700 | [diff] [blame] | 27 | #include <WinSock2.h> |
| 28 | #endif // _WIN32 |
| 29 | |
David Pinedo | 9316d3b | 2015-11-06 12:54:48 -0700 | [diff] [blame] | 30 | #include "vulkan/vk_platform.h" |
| 31 | #include "vulkan/vk_sdk_platform.h" |
Cody Northrop | 33fa041 | 2015-07-08 16:48:37 -0600 | [diff] [blame] | 32 | |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 33 | #if defined(__linux__) |
| 34 | /* Linux-specific common code: */ |
| 35 | |
| 36 | // Headers: |
| 37 | //#define _GNU_SOURCE 1 |
| 38 | // TBD: Are the contents of the following file used? |
| 39 | #include <unistd.h> |
| 40 | // Note: The following file is for dynamic loading: |
| 41 | #include <dlfcn.h> |
| 42 | #include <pthread.h> |
| 43 | #include <assert.h> |
Jon Ashburn | fc1031e | 2015-11-17 15:31:02 -0700 | [diff] [blame] | 44 | #include <string.h> |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 45 | #include <stdbool.h> |
Michael Lentine | 695f2c2 | 2015-09-09 12:39:13 -0700 | [diff] [blame] | 46 | #include <stdlib.h> |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 47 | #include <libgen.h> |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 48 | |
Courtney Goeltzenleuchter | d8e229c | 2015-04-08 15:36:08 -0600 | [diff] [blame] | 49 | // VK Library Filenames, Paths, etc.: |
Ian Elliott | 457810e | 2015-02-04 11:22:39 -0700 | [diff] [blame] | 50 | #define PATH_SEPERATOR ':' |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 51 | #define DIRECTORY_SYMBOL '/' |
| 52 | |
John Drinkwater | 9ac3f4f | 2016-08-01 17:00:00 +0100 | [diff] [blame] | 53 | #define VULKAN_DIR "/vulkan/" |
| 54 | #define VULKAN_ICDCONF_DIR "icd.d" |
| 55 | #define VULKAN_ICD_DIR "icd" |
| 56 | #define VULKAN_ELAYERCONF_DIR "explicit_layer.d" |
| 57 | #define VULKAN_ILAYERCONF_DIR "implicit_layer.d" |
| 58 | #define VULKAN_LAYER_DIR "layer" |
James Jones | c28b0a1 | 2015-07-23 17:39:37 -0700 | [diff] [blame] | 59 | |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 60 | #if defined(EXTRASYSCONFDIR) |
| 61 | #define EXTRA_DRIVERS_SYSCONFDIR_INFO ":" \ |
| 62 | EXTRASYSCONFDIR VULKAN_DIR VULKAN_ICDCONF_DIR |
| 63 | #define EXTRA_ELAYERS_SYSCONFDIR_INFO ":" \ |
| 64 | EXTRASYSCONFDIR VULKAN_DIR VULKAN_ELAYERCONF_DIR |
| 65 | #define EXTRA_ILAYERS_SYSCONFDIR_INFO ":" \ |
| 66 | EXTRASYSCONFDIR VULKAN_DIR VULKAN_ILAYERCONF_DIR |
James Jones | c28b0a1 | 2015-07-23 17:39:37 -0700 | [diff] [blame] | 67 | #else |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 68 | #define EXTRA_DRIVERS_SYSCONFDIR_INFO |
| 69 | #define EXTRA_ELAYERS_SYSCONFDIR_INFO |
| 70 | #define EXTRA_ILAYERS_SYSCONFDIR_INFO |
| 71 | #endif |
| 72 | |
| 73 | #if defined(EXTRADATADIR) |
| 74 | #define EXTRA_DRIVERS_DATADIR_INFO ":" \ |
| 75 | EXTRADATADIR VULKAN_DIR VULKAN_ICDCONF_DIR |
| 76 | #define EXTRA_ELAYERS_DATADIR_INFO ":" \ |
| 77 | EXTRADATADIR VULKAN_DIR VULKAN_ELAYERCONF_DIR |
| 78 | #define EXTRA_ILAYERS_DATADIR_INFO ":" \ |
| 79 | EXTRADATADIR VULKAN_DIR VULKAN_ILAYERCONF_DIR |
| 80 | #else |
| 81 | #define EXTRA_DRIVERS_DATADIR_INFO |
| 82 | #define EXTRA_ELAYERS_DATADIR_INFO |
| 83 | #define EXTRA_ILAYERS_DATADIR_INFO |
James Jones | c28b0a1 | 2015-07-23 17:39:37 -0700 | [diff] [blame] | 84 | #endif |
| 85 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 86 | #define DEFAULT_VK_DRIVERS_INFO \ |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 87 | SYSCONFDIR VULKAN_DIR VULKAN_ICDCONF_DIR ":" \ |
| 88 | DATADIR VULKAN_DIR VULKAN_ICDCONF_DIR \ |
| 89 | EXTRA_DRIVERS_SYSCONFDIR_INFO \ |
| 90 | EXTRA_DRIVERS_DATADIR_INFO |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 91 | #define DEFAULT_VK_ELAYERS_INFO \ |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 92 | SYSCONFDIR VULKAN_DIR VULKAN_ELAYERCONF_DIR ":" \ |
| 93 | DATADIR VULKAN_DIR VULKAN_ELAYERCONF_DIR \ |
| 94 | EXTRA_ELAYERS_SYSCONFDIR_INFO \ |
| 95 | EXTRA_ELAYERS_DATADIR_INFO |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 96 | #define DEFAULT_VK_ILAYERS_INFO \ |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 97 | SYSCONFDIR VULKAN_DIR VULKAN_ILAYERCONF_DIR ":" \ |
| 98 | DATADIR VULKAN_DIR VULKAN_ILAYERCONF_DIR \ |
| 99 | EXTRA_ILAYERS_SYSCONFDIR_INFO \ |
| 100 | EXTRA_ILAYERS_DATADIR_INFO |
| 101 | |
| 102 | #define DEFAULT_VK_DRIVERS_PATH "" |
Jamie Madill | 2fcbd15 | 2016-04-27 16:33:23 -0400 | [diff] [blame] | 103 | #define DEFAULT_VK_LAYERS_PATH "" |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 104 | |
Jamie Madill | 00c3c91 | 2016-04-06 18:26:46 -0400 | [diff] [blame] | 105 | #if !defined(LAYERS_SOURCE_PATH) |
| 106 | #define LAYERS_SOURCE_PATH NULL |
| 107 | #endif |
Jon Ashburn | 1b95822 | 2015-08-06 11:22:33 -0600 | [diff] [blame] | 108 | #define LAYERS_PATH_ENV "VK_LAYER_PATH" |
Dor Askayo | a120bb3 | 2016-10-22 22:20:29 +0300 | [diff] [blame] | 109 | |
John Drinkwater | 9ac3f4f | 2016-08-01 17:00:00 +0100 | [diff] [blame] | 110 | #define HOME_VK_DRIVERS_INFO VULKAN_DIR VULKAN_ICDCONF_DIR |
| 111 | #define HOME_VK_ELAYERS_INFO VULKAN_DIR VULKAN_ELAYERCONF_DIR |
| 112 | #define HOME_VK_ILAYERS_INFO VULKAN_DIR VULKAN_ILAYERCONF_DIR |
Ian Elliott | 457810e | 2015-02-04 11:22:39 -0700 | [diff] [blame] | 113 | |
Ian Elliott | e536946 | 2015-02-12 16:44:56 -0700 | [diff] [blame] | 114 | // C99: |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 115 | #define PRINTF_SIZE_T_SPECIFIER "%zu" |
Tobin Ehlis | b049785 | 2015-02-11 14:24:02 -0700 | [diff] [blame] | 116 | |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 117 | // File IO |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 118 | static inline bool loader_platform_file_exists(const char *path) { |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 119 | if (access(path, F_OK)) |
| 120 | return false; |
| 121 | else |
| 122 | return true; |
| 123 | } |
| 124 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 125 | static inline bool loader_platform_is_path_absolute(const char *path) { |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 126 | if (path[0] == '/') |
| 127 | return true; |
| 128 | else |
| 129 | return false; |
| 130 | } |
| 131 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 132 | static inline char *loader_platform_dirname(char *path) { |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 133 | return dirname(path); |
| 134 | } |
| 135 | |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 136 | // Dynamic Loading of libraries: |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 137 | typedef void *loader_platform_dl_handle; |
| 138 | static inline loader_platform_dl_handle |
| 139 | loader_platform_open_library(const char *libPath) { |
Chia-I Wu | 6a21834 | 2015-02-18 14:39:54 -0700 | [diff] [blame] | 140 | return dlopen(libPath, RTLD_LAZY | RTLD_LOCAL); |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 141 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 142 | static inline const char * |
| 143 | loader_platform_open_library_error(const char *libPath) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 144 | return dlerror(); |
| 145 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 146 | static inline void |
| 147 | loader_platform_close_library(loader_platform_dl_handle library) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 148 | dlclose(library); |
| 149 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 150 | static inline void * |
| 151 | loader_platform_get_proc_address(loader_platform_dl_handle library, |
| 152 | const char *name) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 153 | assert(library); |
| 154 | assert(name); |
| 155 | return dlsym(library, name); |
| 156 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 157 | static inline const char * |
| 158 | loader_platform_get_proc_address_error(const char *name) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 159 | return dlerror(); |
| 160 | } |
| 161 | |
| 162 | // Threads: |
| 163 | typedef pthread_t loader_platform_thread; |
Jon Ashburn | 87d6aa9 | 2015-08-28 15:19:27 -0600 | [diff] [blame] | 164 | #define THREAD_LOCAL_DECL __thread |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 165 | #define LOADER_PLATFORM_THREAD_ONCE_DECLARATION(var) \ |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 166 | pthread_once_t var = PTHREAD_ONCE_INIT; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 167 | #define LOADER_PLATFORM_THREAD_ONCE_DEFINITION(var) pthread_once_t var; |
| 168 | static inline void loader_platform_thread_once(pthread_once_t *ctl, |
| 169 | void (*func)(void)) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 170 | assert(func != NULL); |
| 171 | assert(ctl != NULL); |
Michael Lentine | 695f2c2 | 2015-09-09 12:39:13 -0700 | [diff] [blame] | 172 | pthread_once(ctl, func); |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | // Thread IDs: |
| 176 | typedef pthread_t loader_platform_thread_id; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 177 | static inline loader_platform_thread_id loader_platform_get_thread_id() { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 178 | return pthread_self(); |
| 179 | } |
| 180 | |
| 181 | // Thread mutex: |
| 182 | typedef pthread_mutex_t loader_platform_thread_mutex; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 183 | static inline void |
| 184 | loader_platform_thread_create_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 185 | pthread_mutex_init(pMutex, NULL); |
| 186 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 187 | static inline void |
| 188 | loader_platform_thread_lock_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 189 | pthread_mutex_lock(pMutex); |
| 190 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 191 | static inline void |
| 192 | loader_platform_thread_unlock_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 193 | pthread_mutex_unlock(pMutex); |
| 194 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 195 | static inline void |
| 196 | loader_platform_thread_delete_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 197 | pthread_mutex_destroy(pMutex); |
| 198 | } |
Mike Stroyan | ed238bb | 2015-05-15 08:50:57 -0600 | [diff] [blame] | 199 | typedef pthread_cond_t loader_platform_thread_cond; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 200 | static inline void |
| 201 | loader_platform_thread_init_cond(loader_platform_thread_cond *pCond) { |
Mike Stroyan | ed238bb | 2015-05-15 08:50:57 -0600 | [diff] [blame] | 202 | pthread_cond_init(pCond, NULL); |
| 203 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 204 | static inline void |
| 205 | loader_platform_thread_cond_wait(loader_platform_thread_cond *pCond, |
| 206 | loader_platform_thread_mutex *pMutex) { |
Mike Stroyan | ed238bb | 2015-05-15 08:50:57 -0600 | [diff] [blame] | 207 | pthread_cond_wait(pCond, pMutex); |
| 208 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 209 | static inline void |
| 210 | loader_platform_thread_cond_broadcast(loader_platform_thread_cond *pCond) { |
Mike Stroyan | ed238bb | 2015-05-15 08:50:57 -0600 | [diff] [blame] | 211 | pthread_cond_broadcast(pCond); |
| 212 | } |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 213 | |
Courtney Goeltzenleuchter | 7f5aafc | 2015-07-05 11:28:29 -0600 | [diff] [blame] | 214 | #define loader_stack_alloc(size) alloca(size) |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 215 | |
| 216 | #elif defined(_WIN32) // defined(__linux__) |
| 217 | /* Windows-specific common code: */ |
Tobin Ehlis | 890adf1 | 2015-11-02 15:45:19 -0700 | [diff] [blame] | 218 | // WinBase.h defines CreateSemaphore and synchapi.h defines CreateEvent |
| 219 | // undefine them to avoid conflicts with VkLayerDispatchTable struct members. |
| 220 | #ifdef CreateSemaphore |
| 221 | #undef CreateSemaphore |
| 222 | #endif |
| 223 | #ifdef CreateEvent |
| 224 | #undef CreateEvent |
| 225 | #endif |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 226 | #include <assert.h> |
Tony Barbour | 1d825c7 | 2015-06-18 16:29:32 -0600 | [diff] [blame] | 227 | #include <stdio.h> |
Jon Ashburn | fc1031e | 2015-11-17 15:31:02 -0700 | [diff] [blame] | 228 | #include <string.h> |
Jon Ashburn | ffad94d | 2015-06-30 14:46:22 -0700 | [diff] [blame] | 229 | #include <io.h> |
| 230 | #include <stdbool.h> |
Cody Northrop | 33fa041 | 2015-07-08 16:48:37 -0600 | [diff] [blame] | 231 | #include <shlwapi.h> |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 232 | #ifdef __cplusplus |
| 233 | #include <iostream> |
| 234 | #include <string> |
| 235 | using namespace std; |
| 236 | #endif // __cplusplus |
| 237 | |
Courtney Goeltzenleuchter | d8e229c | 2015-04-08 15:36:08 -0600 | [diff] [blame] | 238 | // VK Library Filenames, Paths, etc.: |
Ian Elliott | 457810e | 2015-02-04 11:22:39 -0700 | [diff] [blame] | 239 | #define PATH_SEPERATOR ';' |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 240 | #define DIRECTORY_SYMBOL '\\' |
Jon Ashburn | ffad94d | 2015-06-30 14:46:22 -0700 | [diff] [blame] | 241 | #define DEFAULT_VK_REGISTRY_HIVE HKEY_LOCAL_MACHINE |
Lenny Komow | 367c4ea | 2016-11-07 11:40:00 -0700 | [diff] [blame^] | 242 | #define DEFAULT_VK_DRIVERS_INFO "SOFTWARE\\Khronos\\" API_NAME "\\Drivers" |
Jamie Madill | 2fcbd15 | 2016-04-27 16:33:23 -0400 | [diff] [blame] | 243 | #define DEFAULT_VK_DRIVERS_PATH "" |
Lenny Komow | 367c4ea | 2016-11-07 11:40:00 -0700 | [diff] [blame^] | 244 | #define DEFAULT_VK_ELAYERS_INFO "SOFTWARE\\Khronos\\" API_NAME "\\ExplicitLayers" |
| 245 | #define DEFAULT_VK_ILAYERS_INFO "SOFTWARE\\Khronos\\" API_NAME "\\ImplicitLayers" |
Jamie Madill | 00c3c91 | 2016-04-06 18:26:46 -0400 | [diff] [blame] | 246 | #if !defined(DEFAULT_VK_LAYERS_PATH) |
Jamie Madill | 2fcbd15 | 2016-04-27 16:33:23 -0400 | [diff] [blame] | 247 | #define DEFAULT_VK_LAYERS_PATH "" |
Jamie Madill | 00c3c91 | 2016-04-06 18:26:46 -0400 | [diff] [blame] | 248 | #endif |
| 249 | #if !defined(LAYERS_SOURCE_PATH) |
| 250 | #define LAYERS_SOURCE_PATH NULL |
| 251 | #endif |
Jon Ashburn | 1b95822 | 2015-08-06 11:22:33 -0600 | [diff] [blame] | 252 | #define LAYERS_PATH_ENV "VK_LAYER_PATH" |
Jon Ashburn | 8365786 | 2016-02-17 13:18:08 -0700 | [diff] [blame] | 253 | #define HOME_VK_DRIVERS_INFO "" |
| 254 | #define HOME_VK_ELAYERS_INFO "" |
| 255 | #define HOME_VK_ILAYERS_INFO "" |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 256 | #define PRINTF_SIZE_T_SPECIFIER "%Iu" |
Courtney Goeltzenleuchter | 22d8d79 | 2015-10-07 17:03:42 -0600 | [diff] [blame] | 257 | |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 258 | // File IO |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 259 | static bool loader_platform_file_exists(const char *path) { |
Jon Ashburn | ffad94d | 2015-06-30 14:46:22 -0700 | [diff] [blame] | 260 | if ((_access(path, 0)) == -1) |
Jon Ashburn | 2077e38 | 2015-06-29 11:25:34 -0600 | [diff] [blame] | 261 | return false; |
| 262 | else |
| 263 | return true; |
| 264 | } |
| 265 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 266 | static bool loader_platform_is_path_absolute(const char *path) { |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 267 | return !PathIsRelative(path); |
| 268 | } |
| 269 | |
| 270 | // WIN32 runtime doesn't have dirname(). |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 271 | static inline char *loader_platform_dirname(char *path) { |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 272 | char *current, *next; |
| 273 | |
| 274 | // TODO/TBD: Do we need to deal with the Windows's ":" character? |
| 275 | |
| 276 | for (current = path; *current != '\0'; current = next) { |
| 277 | next = strchr(current, DIRECTORY_SYMBOL); |
| 278 | if (next == NULL) { |
| 279 | if (current != path) |
| 280 | *(current - 1) = '\0'; |
| 281 | return path; |
| 282 | } else { |
| 283 | // Point one character past the DIRECTORY_SYMBOL: |
| 284 | next++; |
| 285 | } |
| 286 | } |
| 287 | return path; |
| 288 | } |
| 289 | |
| 290 | // WIN32 runtime doesn't have basename(). |
| 291 | // Microsoft also doesn't have basename(). Paths are different on Windows, and |
| 292 | // so this is just a temporary solution in order to get us compiling, so that we |
| 293 | // can test some scenarios, and develop the correct solution for Windows. |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 294 | // TODO: Develop a better, permanent solution for Windows, to replace this |
| 295 | // temporary code: |
| 296 | static char *loader_platform_basename(char *pathname) { |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 297 | char *current, *next; |
| 298 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 299 | // TODO/TBD: Do we need to deal with the Windows's ":" character? |
Jon Ashburn | 1531517 | 2015-07-07 15:06:25 -0600 | [diff] [blame] | 300 | |
| 301 | for (current = pathname; *current != '\0'; current = next) { |
| 302 | next = strchr(current, DIRECTORY_SYMBOL); |
| 303 | if (next == NULL) { |
| 304 | // No more DIRECTORY_SYMBOL's so return p: |
| 305 | return current; |
| 306 | } else { |
| 307 | // Point one character past the DIRECTORY_SYMBOL: |
| 308 | next++; |
| 309 | } |
| 310 | } |
| 311 | // We shouldn't get to here, but this makes the compiler happy: |
| 312 | return current; |
| 313 | } |
| 314 | |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 315 | // Dynamic Loading: |
| 316 | typedef HMODULE loader_platform_dl_handle; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 317 | static loader_platform_dl_handle |
| 318 | loader_platform_open_library(const char *libPath) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 319 | return LoadLibrary(libPath); |
| 320 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 321 | static char *loader_platform_open_library_error(const char *libPath) { |
Tobin Ehlis | b2dfb55 | 2016-06-07 06:07:13 -0600 | [diff] [blame] | 322 | static char errorMsg[164]; |
| 323 | snprintf(errorMsg, 163, "Failed to open dynamic library \"%s\"", libPath); |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 324 | return errorMsg; |
| 325 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 326 | static void loader_platform_close_library(loader_platform_dl_handle library) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 327 | FreeLibrary(library); |
| 328 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 329 | static void *loader_platform_get_proc_address(loader_platform_dl_handle library, |
| 330 | const char *name) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 331 | assert(library); |
| 332 | assert(name); |
| 333 | return GetProcAddress(library, name); |
| 334 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 335 | static char *loader_platform_get_proc_address_error(const char *name) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 336 | static char errorMsg[120]; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 337 | snprintf(errorMsg, 119, "Failed to find function \"%s\" in dynamic library", |
| 338 | name); |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 339 | return errorMsg; |
| 340 | } |
| 341 | |
| 342 | // Threads: |
| 343 | typedef HANDLE loader_platform_thread; |
Jon Ashburn | 87d6aa9 | 2015-08-28 15:19:27 -0600 | [diff] [blame] | 344 | #define THREAD_LOCAL_DECL __declspec(thread) |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 345 | #define LOADER_PLATFORM_THREAD_ONCE_DECLARATION(var) \ |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 346 | INIT_ONCE var = INIT_ONCE_STATIC_INIT; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 347 | #define LOADER_PLATFORM_THREAD_ONCE_DEFINITION(var) INIT_ONCE var; |
| 348 | static BOOL CALLBACK |
| 349 | InitFuncWrapper(PINIT_ONCE InitOnce, PVOID Parameter, PVOID *Context) { |
Piers Daniell | 4da523a | 2015-02-23 16:23:13 -0700 | [diff] [blame] | 350 | void (*func)(void) = (void (*)(void))Parameter; |
| 351 | func(); |
| 352 | return TRUE; |
| 353 | } |
| 354 | |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 355 | static void loader_platform_thread_once(void *ctl, void (*func)(void)) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 356 | assert(func != NULL); |
| 357 | assert(ctl != NULL); |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 358 | InitOnceExecuteOnce((PINIT_ONCE)ctl, InitFuncWrapper, func, NULL); |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 359 | } |
| 360 | |
| 361 | // Thread IDs: |
| 362 | typedef DWORD loader_platform_thread_id; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 363 | static loader_platform_thread_id loader_platform_get_thread_id() { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 364 | return GetCurrentThreadId(); |
| 365 | } |
| 366 | |
| 367 | // Thread mutex: |
| 368 | typedef CRITICAL_SECTION loader_platform_thread_mutex; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 369 | static void |
| 370 | loader_platform_thread_create_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 371 | InitializeCriticalSection(pMutex); |
| 372 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 373 | static void |
| 374 | loader_platform_thread_lock_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 375 | EnterCriticalSection(pMutex); |
| 376 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 377 | static void |
| 378 | loader_platform_thread_unlock_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 379 | LeaveCriticalSection(pMutex); |
| 380 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 381 | static void |
| 382 | loader_platform_thread_delete_mutex(loader_platform_thread_mutex *pMutex) { |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 383 | DeleteCriticalSection(pMutex); |
| 384 | } |
Mike Stroyan | c3d9833 | 2015-05-15 17:34:51 -0600 | [diff] [blame] | 385 | typedef CONDITION_VARIABLE loader_platform_thread_cond; |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 386 | static void |
| 387 | loader_platform_thread_init_cond(loader_platform_thread_cond *pCond) { |
Mike Stroyan | c3d9833 | 2015-05-15 17:34:51 -0600 | [diff] [blame] | 388 | InitializeConditionVariable(pCond); |
| 389 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 390 | static void |
| 391 | loader_platform_thread_cond_wait(loader_platform_thread_cond *pCond, |
| 392 | loader_platform_thread_mutex *pMutex) { |
Mike Stroyan | c3d9833 | 2015-05-15 17:34:51 -0600 | [diff] [blame] | 393 | SleepConditionVariableCS(pCond, pMutex, INFINITE); |
| 394 | } |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 395 | static void |
| 396 | loader_platform_thread_cond_broadcast(loader_platform_thread_cond *pCond) { |
Mike Stroyan | c3d9833 | 2015-05-15 17:34:51 -0600 | [diff] [blame] | 397 | WakeAllConditionVariable(pCond); |
| 398 | } |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 399 | |
Ian Elliott | 5aa4ea2 | 2015-03-31 15:32:41 -0600 | [diff] [blame] | 400 | // Windows Registry: |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 401 | char *loader_get_registry_string(const HKEY hive, const LPCTSTR sub_key, |
Ian Elliott | 5aa4ea2 | 2015-03-31 15:32:41 -0600 | [diff] [blame] | 402 | const char *value); |
| 403 | |
Jon Ashburn | 3f8c300 | 2015-10-15 13:47:58 -0600 | [diff] [blame] | 404 | #define loader_stack_alloc(size) _alloca(size) |
Ian Elliott | 2d4ab1e | 2015-01-13 17:52:38 -0700 | [diff] [blame] | 405 | #else // defined(_WIN32) |
| 406 | |
| 407 | #error The "loader_platform.h" file must be modified for this OS. |
| 408 | |
| 409 | // NOTE: In order to support another OS, an #elif needs to be added (above the |
| 410 | // "#else // defined(_WIN32)") for that OS, and OS-specific versions of the |
| 411 | // contents of this file must be created. |
| 412 | |
| 413 | // NOTE: Other OS-specific changes are also needed for this OS. Search for |
| 414 | // files with "WIN32" in it, as a quick way to find files that must be changed. |
| 415 | |
| 416 | #endif // defined(_WIN32) |
| 417 | |
jon | 547bbee | 2015-10-29 14:57:03 -0600 | [diff] [blame] | 418 | // returns true if the given string appears to be a relative or absolute |
| 419 | // path, as opposed to a bare filename. |
Jon Ashburn | 23d36b1 | 2016-02-02 17:47:28 -0700 | [diff] [blame] | 420 | static inline bool loader_platform_is_path(const char *path) { |
jon | 547bbee | 2015-10-29 14:57:03 -0600 | [diff] [blame] | 421 | return strchr(path, DIRECTORY_SYMBOL) != NULL; |
| 422 | } |