layers: Add threading checking layer
New layer checks for use of objects from multiple threads.
diff --git a/layers/CMakeLists.txt b/layers/CMakeLists.txt
index 92f6b2d..f5ad8f9 100644
--- a/layers/CMakeLists.txt
+++ b/layers/CMakeLists.txt
@@ -90,6 +90,7 @@
run_vk_layer_generate(Generic generic_layer.c)
run_vk_layer_generate(APIDump api_dump.cpp)
run_vk_layer_generate(ObjectTracker object_track.c)
+run_vk_layer_generate(Threading threading.cpp)
add_library(layer_utils SHARED layers_config.cpp)
if (WIN32)
@@ -108,3 +109,4 @@
add_vk_layer(APIDump api_dump.cpp)
add_vk_layer(ObjectTracker object_track.c)
add_vk_layer(ParamChecker param_checker.cpp)
+add_vk_layer(ThreadingChecker threading.cpp)
diff --git a/layers/README.md b/layers/README.md
index 449f892..8198e98 100644
--- a/layers/README.md
+++ b/layers/README.md
@@ -53,6 +53,9 @@
### Check parameters
<build dir>/layer/param_checker.c (name=ParamChecker) - Check the input parameters to API calls for validity. Currently this only checks ENUM params directly passed to API calls and ENUMs embedded in struct params. If a Dbg callback function is registered, this layer will use callback function(s) for reporting, otherwise uses stdout.
+### Check threading
+<build dir>/layer/threading.c (name=Threading) - Check multithreading of API calls for validity. Currently this checks that only one thread at a time uses an object in free-threaded API calls. If a Dbg callback function is registered, this layer will use callback function(s) for reporting, otherwise uses stdout.
+
## Using Layers
1. Build VK loader and i965 icd driver using normal steps (cmake and make)
diff --git a/layers/threading.h b/layers/threading.h
new file mode 100644
index 0000000..8426e39
--- /dev/null
+++ b/layers/threading.h
@@ -0,0 +1,32 @@
+/*
+ * Vulkan
+ *
+ * Copyright (C) 2015 LunarG, Inc.
+ *
+ * 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.
+ */
+
+// Draw State ERROR codes
+typedef enum _THREADING_CHECKER_ERROR
+{
+ THREADING_CHECKER_NONE, // Used for INFO & other non-error messages
+ THREADING_CHECKER_MULTIPLE_THREADS, // Object used simultaneously by multiple threads
+ THREADING_CHECKER_SINGLE_THREAD_REUSE, // Object used simultaneously by recursion in single thread
+} THREADING_CHECKER_ERROR;
+
diff --git a/tests/run_all_tests_with_layers.sh b/tests/run_all_tests_with_layers.sh
index 7a585d6..269106d 100755
--- a/tests/run_all_tests_with_layers.sh
+++ b/tests/run_all_tests_with_layers.sh
@@ -3,7 +3,7 @@
# Run all the regression tests with validation layers enabled
# enable layers
-export LIBVK_LAYER_NAMES=DrawState:MemTracker:ParamChecker:ObjectTracker
+export LIBVK_LAYER_NAMES=DrawState:MemTracker:ParamChecker:ObjectTracker:Threading
# Save any existing settings file
RESTORE_SETTINGS="false"
SETTINGS_NAME="vk_layer_settings.txt"
@@ -21,6 +21,7 @@
echo "DrawStateReportLevel = $OUTPUT_LEVEL" >> $SETTINGS_NAME
echo "ObjectTrackerReportLevel = $OUTPUT_LEVEL" >> $SETTINGS_NAME
echo "ParamCheckerReportLevel = $OUTPUT_LEVEL" >> $SETTINGS_NAME
+echo "ThreadingReportLevel = $OUTPUT_LEVEL" >> $SETTINGS_NAME
# vkbase tests that basic VK calls are working (don't return an error).
./vkbase
diff --git a/vk-layer-generate.py b/vk-layer-generate.py
index 03a089c..8c6f255 100755
--- a/vk-layer-generate.py
+++ b/vk-layer-generate.py
@@ -187,7 +187,7 @@
ur_body.append(' if (g_actionIsDefault)')
ur_body.append(' g_debugAction = VK_DBG_LAYER_ACTION_LOG_MSG;')
ur_body.append(' else')
- ur_body.append(' g_debugAction &= ~VK_DBG_LAYER_ACTION_CALLBACK;')
+ ur_body.append(' g_debugAction = (VK_LAYER_DBG_ACTION)(g_debugAction & ~((uint32_t)VK_DBG_LAYER_ACTION_CALLBACK));')
ur_body.append(' }')
ur_body.append(' VkResult result = nextTable.DbgUnregisterMsgCallback(instance, pfnMsgCallback);')
ur_body.append(' return result;')
@@ -437,7 +437,7 @@
'{\n'
' PFN_vkGetProcAddr fpNextGPA;\n'
' fpNextGPA = pCurObj->pGPA;\n'
- ' assert(fpNextGPA);\n' % self.layer_name);
+ ' assert(fpNextGPA);\n' % self.layer_name)
func_body.append(" layer_initialize_dispatch_table(&nextTable, fpNextGPA, (VkPhysicalGpu) pCurObj->nextObject);\n")
func_body.append(" if (!printLockInitialized)")
@@ -1304,6 +1304,128 @@
return "\n\n".join(body)
+class ThreadingSubcommand(Subcommand):
+ def generate_header(self):
+ header_txt = []
+ header_txt.append('#include <stdio.h>')
+ header_txt.append('#include <stdlib.h>')
+ header_txt.append('#include <string.h>')
+ header_txt.append('#include <unordered_map>')
+ header_txt.append('#include "loader_platform.h"')
+ header_txt.append('#include "vkLayer.h"')
+ header_txt.append('#include "threading.h"')
+ header_txt.append('#include "layers_config.h"')
+ header_txt.append('#include "vk_enum_validate_helper.h"')
+ header_txt.append('#include "vk_struct_validate_helper.h"')
+ header_txt.append('//The following is #included again to catch certain OS-specific functions being used:')
+ header_txt.append('#include "loader_platform.h"\n')
+ header_txt.append('#include "layers_msg.h"\n')
+ header_txt.append('static VkLayerDispatchTable nextTable;')
+ header_txt.append('static VkBaseLayerObject *pCurObj;')
+ header_txt.append('static LOADER_PLATFORM_THREAD_ONCE_DECLARATION(tabOnce);\n')
+ header_txt.append('using namespace std;')
+ header_txt.append('static unordered_map<int, void*> proxy_objectsInUse;\n')
+ header_txt.append('static unordered_map<VkObject, loader_platform_thread_id> objectsInUse;\n')
+ header_txt.append('static int threadingLockInitialized = 0;')
+ header_txt.append('static loader_platform_thread_mutex threadingLock;')
+ header_txt.append('static int printLockInitialized = 0;')
+ header_txt.append('static loader_platform_thread_mutex printLock;\n')
+ header_txt.append('')
+ header_txt.append('static void useObject(VkObject object, const char* type)')
+ header_txt.append('{')
+ header_txt.append(' loader_platform_thread_id tid = loader_platform_get_thread_id();')
+ header_txt.append(' loader_platform_thread_lock_mutex(&threadingLock);')
+ header_txt.append(' if (objectsInUse.find(object) == objectsInUse.end()) {')
+ header_txt.append(' objectsInUse[object] = tid;')
+ header_txt.append(' } else {')
+ header_txt.append(' if (objectsInUse[object] == tid) {')
+ header_txt.append(' char str[1024];')
+ header_txt.append(' sprintf(str, "THREADING ERROR : object of type %s is simultaneously used in thread %ld and thread %ld", type, objectsInUse[object], tid);')
+ header_txt.append(' layerCbMsg(VK_DBG_MSG_ERROR, VK_VALIDATION_LEVEL_0, 0, 0, THREADING_CHECKER_MULTIPLE_THREADS, "THREADING", str);')
+ header_txt.append(' } else {')
+ header_txt.append(' char str[1024];')
+ header_txt.append(' sprintf(str, "THREADING ERROR : object of type %s is recursively used in thread %ld", type, tid);')
+ header_txt.append(' layerCbMsg(VK_DBG_MSG_ERROR, VK_VALIDATION_LEVEL_0, 0, 0, THREADING_CHECKER_SINGLE_THREAD_REUSE, "THREADING", str);')
+ header_txt.append(' }')
+ header_txt.append(' }')
+ header_txt.append(' loader_platform_thread_unlock_mutex(&threadingLock);')
+ header_txt.append('}')
+ header_txt.append('static void finishUsingObject(VkObject object)')
+ header_txt.append('{')
+ header_txt.append(' // Object is no longer in use')
+ header_txt.append(' loader_platform_thread_lock_mutex(&threadingLock);')
+ header_txt.append(' objectsInUse.erase(object);')
+ header_txt.append(' loader_platform_thread_unlock_mutex(&threadingLock);')
+ header_txt.append('}')
+ return "\n".join(header_txt)
+
+ def generate_intercept(self, proto, qual):
+ if proto.name in [ 'DbgRegisterMsgCallback', 'DbgUnregisterMsgCallback' ]:
+ # use default version
+ return None
+ decl = proto.c_func(prefix="vk", attr="VKAPI")
+ ret_val = ''
+ stmt = ''
+ funcs = []
+ if proto.ret != "void":
+ ret_val = "VkResult result = "
+ stmt = " return result;\n"
+ if proto.name == "EnumerateLayers":
+ funcs.append('%s%s\n'
+ '{\n'
+ ' char str[1024];\n'
+ ' if (gpu != NULL) {\n'
+ ' pCurObj = (VkBaseLayerObject *) %s;\n'
+ ' loader_platform_thread_once(&tabOnce, init%s);\n'
+ ' %snextTable.%s;\n'
+ ' fflush(stdout);\n'
+ ' %s'
+ ' } else {\n'
+ ' if (pOutLayerCount == NULL || pOutLayers == NULL || pOutLayers[0] == NULL)\n'
+ ' return VK_ERROR_INVALID_POINTER;\n'
+ ' // This layer compatible with all GPUs\n'
+ ' *pOutLayerCount = 1;\n'
+ ' strncpy((char *) pOutLayers[0], "%s", maxStringSize);\n'
+ ' return VK_SUCCESS;\n'
+ ' }\n'
+ '}' % (qual, decl, proto.params[0].name, self.layer_name, ret_val, proto.c_call(), stmt, self.layer_name))
+ # All functions that do a Get are thread safe
+ elif 'Get' in proto.name:
+ return None
+ # All Wsi functions are thread safe
+ elif 'WsiX11' in proto.name:
+ return None
+ # All functions that start with a device parameter are thread safe
+ elif proto.params[0].ty in { "VkDevice" }:
+ return None
+ # Only watch core objects passed as first parameter
+ elif proto.params[0].ty not in vulkan.core.objects:
+ return None
+ elif proto.params[0].ty != "VkPhysicalGpu":
+ funcs.append('%s%s\n'
+ '{\n'
+ ' useObject((VkObject) %s, "%s");\n'
+ ' %snextTable.%s;\n'
+ ' finishUsingObject((VkObject) %s);\n'
+ '%s'
+ '}' % (qual, decl, proto.params[0].name, proto.params[0].ty, ret_val, proto.c_call(), proto.params[0].name, stmt))
+ else:
+ funcs.append('%s%s\n'
+ '{\n'
+ ' pCurObj = (VkBaseLayerObject *) %s;\n'
+ ' loader_platform_thread_once(&tabOnce, init%s);\n'
+ ' %snextTable.%s;\n'
+ '%s'
+ '}' % (qual, decl, proto.params[0].name, self.layer_name, ret_val, proto.c_call(), stmt))
+ return "\n\n".join(funcs)
+
+ def generate_body(self):
+ self.layer_name = "Threading"
+ body = [self._generate_layer_initialization(True, lockname='threading'),
+ self._generate_dispatch_entrypoints("VK_LAYER_EXPORT"),
+ self._generate_layer_gpa_function()]
+ return "\n\n".join(body)
+
def main():
subcommands = {
"layer-funcs" : LayerFuncsSubcommand,
@@ -1311,6 +1433,7 @@
"Generic" : GenericLayerSubcommand,
"APIDump" : APIDumpSubcommand,
"ObjectTracker" : ObjectTrackerSubcommand,
+ "Threading" : ThreadingSubcommand,
}
if len(sys.argv) < 3 or sys.argv[1] not in subcommands or not os.path.exists(sys.argv[2]):