blob: 05eccba3c0f19b2a87ea6f1580474e35caac74e6 [file] [log] [blame]
Karl Schultz929a1002016-02-04 11:33:21 -07001/*
2 * Copyright (c) 2015-2016 The Khronos Group Inc.
3 * Copyright (c) 2015-2016 Valve Corporation
4 * Copyright (c) 2015-2016 LunarG, Inc.
5 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -06006 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
Karl Schultz929a1002016-02-04 11:33:21 -07009 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060010 * http://www.apache.org/licenses/LICENSE-2.0
Karl Schultz929a1002016-02-04 11:33:21 -070011 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060012 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
Karl Schultz929a1002016-02-04 11:33:21 -070017 *
18 * Author: Chia-I Wu <olvaffe@gmail.com>
19 * Author: Chris Forbes <chrisf@ijw.co.nz>
20 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
21 * Author: Mark Lobodzinski <mark@lunarg.com>
22 * Author: Mike Stroyan <mike@LunarG.com>
23 * Author: Tobin Ehlis <tobine@google.com>
24 * Author: Tony Barbour <tony@LunarG.com>
25 */
26
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060027#ifndef TEST_COMMON_H
28#define TEST_COMMON_H
29
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060030#include <assert.h>
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060031#include <stdbool.h>
32#include <stdio.h>
33#include <stdlib.h>
34#include <string.h>
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060035
Ian Elliottc11750d2015-10-30 13:24:12 -060036#ifdef _WIN32
Mark Lobodzinski450e4632015-11-24 12:04:15 -070037#define NOMINMAX
38// WinSock2.h must be included *BEFORE* windows.h
39#include <winsock2.h>
Ian Elliottc11750d2015-10-30 13:24:12 -060040#endif
Mark Lobodzinskifaa90812015-11-25 13:26:15 -070041
David Pinedo9316d3b2015-11-06 12:54:48 -070042#include <vulkan/vk_sdk_platform.h>
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060043#include <vulkan/vulkan.h>
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060044
Ian Elliottc11750d2015-10-30 13:24:12 -060045#ifdef _WIN32
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060046#pragma warning(push)
Courtney Goeltzenleuchter58f3eff2015-10-07 13:28:58 -060047/*
48 warnings 4251 and 4275 have to do with potential dll-interface mismatch
49 between library (gtest) and users. Since we build the gtest library
50 as part of the test build we know that the dll-interface will match and
51 can disable these warnings.
52 */
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060053#pragma warning(disable : 4251)
54#pragma warning(disable : 4275)
Courtney Goeltzenleuchter58f3eff2015-10-07 13:28:58 -060055#endif
Cody Northrop40354b82018-03-27 12:22:53 -060056
Mark Lobodzinski8bdb1f32018-03-27 17:14:34 -060057// GTest and Xlib collide due to redefinitions of "None" and "Bool"
58#ifdef VK_USE_PLATFORM_XLIB_KHR
59#pragma push_macro("None")
60#pragma push_macro("Bool")
61#undef None
62#undef Bool
63#endif
64
Cody Northrop40354b82018-03-27 12:22:53 -060065// Use the NDK's header on Android
66#ifndef __ANDROID__
Mark Lobodzinski1094a182018-05-09 09:40:32 -060067#include "googletest/googletest/include/gtest/gtest.h"
Mark Lobodzinski8bdb1f32018-03-27 17:14:34 -060068#else
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060069#include "gtest/gtest.h"
Mark Lobodzinski8bdb1f32018-03-27 17:14:34 -060070#endif
71
72// Redefine Xlib definitions
73#ifdef VK_USE_PLATFORM_XLIB_KHR
74#pragma pop_macro("Bool")
75#pragma pop_macro("None")
76#endif
Cody Northrop40354b82018-03-27 12:22:53 -060077
Ian Elliottc11750d2015-10-30 13:24:12 -060078#ifdef _WIN32
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060079#pragma warning(pop)
Courtney Goeltzenleuchter58f3eff2015-10-07 13:28:58 -060080#endif
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060081#include "vktestbinding.h"
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060082
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060083#define ASSERT_VK_SUCCESS(err) ASSERT_EQ(VK_SUCCESS, err) << vk_result_string(err)
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060084
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060085static inline const char *vk_result_string(VkResult err) {
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -060086 switch (err) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070087#define STR(r) \
88 case r: \
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -060089 return #r
90 STR(VK_SUCCESS);
91 STR(VK_NOT_READY);
92 STR(VK_TIMEOUT);
93 STR(VK_EVENT_SET);
94 STR(VK_EVENT_RESET);
95 STR(VK_ERROR_INITIALIZATION_FAILED);
96 STR(VK_ERROR_OUT_OF_HOST_MEMORY);
97 STR(VK_ERROR_OUT_OF_DEVICE_MEMORY);
98 STR(VK_ERROR_DEVICE_LOST);
99 STR(VK_ERROR_EXTENSION_NOT_PRESENT);
100 STR(VK_ERROR_LAYER_NOT_PRESENT);
101 STR(VK_ERROR_MEMORY_MAP_FAILED);
102 STR(VK_ERROR_INCOMPATIBLE_DRIVER);
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -0600103#undef STR
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700104 default:
105 return "UNKNOWN_RESULT";
Courtney Goeltzenleuchterb7f50502014-08-12 14:09:50 -0600106 }
107}
108
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600109static inline void test_error_callback(const char *expr, const char *file, unsigned int line, const char *function) {
Chia-I Wua9a506a2014-12-27 22:04:00 +0800110 ADD_FAILURE_AT(file, line) << "Assertion: `" << expr << "'";
111}
112
Karl Schultz2e5ed332017-12-12 10:33:01 -0500113#if defined(__linux__) || defined(__APPLE__)
Dave Houlton6c72f352018-02-06 17:49:16 -0700114 /* Linux-specific common code: */
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600115
116#include <pthread.h>
117
118// Threads:
119typedef pthread_t test_platform_thread;
120
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600121static inline int test_platform_thread_create(test_platform_thread *thread, void *(*func)(void *), void *data) {
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600122 pthread_attr_t thread_attr;
123 pthread_attr_init(&thread_attr);
124 return pthread_create(thread, &thread_attr, func, data);
125}
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600126static inline int test_platform_thread_join(test_platform_thread thread, void **retval) { return pthread_join(thread, retval); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600127
128// Thread IDs:
129typedef pthread_t test_platform_thread_id;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600130static inline test_platform_thread_id test_platform_get_thread_id() { return pthread_self(); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600131
132// Thread mutex:
133typedef pthread_mutex_t test_platform_thread_mutex;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600134static inline void test_platform_thread_create_mutex(test_platform_thread_mutex *pMutex) { pthread_mutex_init(pMutex, NULL); }
135static inline void test_platform_thread_lock_mutex(test_platform_thread_mutex *pMutex) { pthread_mutex_lock(pMutex); }
136static inline void test_platform_thread_unlock_mutex(test_platform_thread_mutex *pMutex) { pthread_mutex_unlock(pMutex); }
137static inline void test_platform_thread_delete_mutex(test_platform_thread_mutex *pMutex) { pthread_mutex_destroy(pMutex); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600138typedef pthread_cond_t test_platform_thread_cond;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600139static inline void test_platform_thread_init_cond(test_platform_thread_cond *pCond) { pthread_cond_init(pCond, NULL); }
140static inline void test_platform_thread_cond_wait(test_platform_thread_cond *pCond, test_platform_thread_mutex *pMutex) {
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600141 pthread_cond_wait(pCond, pMutex);
142}
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600143static inline void test_platform_thread_cond_broadcast(test_platform_thread_cond *pCond) { pthread_cond_broadcast(pCond); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600144
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700145#elif defined(_WIN32) // defined(__linux__)
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600146// Threads:
147typedef HANDLE test_platform_thread;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600148static inline int test_platform_thread_create(test_platform_thread *thread, void *(*func)(void *), void *data) {
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600149 DWORD threadID;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700150 *thread = CreateThread(NULL, // default security attributes
151 0, // use default stack size
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600152 (LPTHREAD_START_ROUTINE)func,
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700153 data, // thread function argument
154 0, // use default creation flags
155 &threadID); // returns thread identifier
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600156 return (*thread != NULL);
157}
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600158static inline int test_platform_thread_join(test_platform_thread thread, void **retval) {
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600159 return WaitForSingleObject(thread, INFINITE);
160}
161
162// Thread IDs:
163typedef DWORD test_platform_thread_id;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600164static test_platform_thread_id test_platform_get_thread_id() { return GetCurrentThreadId(); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600165
166// Thread mutex:
167typedef CRITICAL_SECTION test_platform_thread_mutex;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600168static void test_platform_thread_create_mutex(test_platform_thread_mutex *pMutex) { InitializeCriticalSection(pMutex); }
169static void test_platform_thread_lock_mutex(test_platform_thread_mutex *pMutex) { EnterCriticalSection(pMutex); }
170static void test_platform_thread_unlock_mutex(test_platform_thread_mutex *pMutex) { LeaveCriticalSection(pMutex); }
171static void test_platform_thread_delete_mutex(test_platform_thread_mutex *pMutex) { DeleteCriticalSection(pMutex); }
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600172typedef CONDITION_VARIABLE test_platform_thread_cond;
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600173static void test_platform_thread_init_cond(test_platform_thread_cond *pCond) { InitializeConditionVariable(pCond); }
174static void test_platform_thread_cond_wait(test_platform_thread_cond *pCond, test_platform_thread_mutex *pMutex) {
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600175 SleepConditionVariableCS(pCond, pMutex, INFINITE);
176}
Mark Lobodzinski6d4a6d92016-09-07 16:27:38 -0600177static void test_platform_thread_cond_broadcast(test_platform_thread_cond *pCond) { WakeAllConditionVariable(pCond); }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700178#else // defined(_WIN32)
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600179
180#error The "test_common.h" file must be modified for this OS.
181
Dave Houlton6c72f352018-02-06 17:49:16 -0700182 // NOTE: In order to support another OS, an #elif needs to be added (above the
183 // "#else // defined(_WIN32)") for that OS, and OS-specific versions of the
184 // contents of this file must be created.
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600185
Dave Houlton6c72f352018-02-06 17:49:16 -0700186 // NOTE: Other OS-specific changes are also needed for this OS. Search for
187 // files with "WIN32" in it, as a quick way to find files that must be changed.
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600188
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700189#endif // defined(_WIN32)
Mike Stroyan4268d1f2015-07-13 14:45:35 -0600190
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700191#endif // TEST_COMMON_H