diff --git a/CMakeLists.txt b/CMakeLists.txt index f07566c044..15d8254498 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -133,8 +133,8 @@ if(APPLE) option(POSTPROCESS_BUNDLE "Postprocess bundle for redistributability" OFF) # Enable adhoc code signing by default (otherwise makefile builds on ARM will not work) option(MACOS_CODE_SIGNING "Enable codesigning" ON) - option(USE_BUNDLED_MOLTENVK "Build MoltenVK from Externals with Dolphin-specific patches" ON) set(MACOS_CODE_SIGNING_IDENTITY "-" CACHE STRING "The identity used for codesigning.") + option(ENABLE_KOSMICKRISP "Enables the KosmicKrisp Vulkan driver." ON) endif() if(CMAKE_SYSTEM_NAME STREQUAL "Linux") @@ -636,13 +636,31 @@ if(WIN32 OR APPLE) endif() add_subdirectory(Externals/tinygltf) +if(APPLE AND ENABLE_VULKAN) + find_package(Vulkan) + + if(NOT VULKAN_FOUND) + message(WARNING "Could not find Vulkan SDK, disabling Vulkan support") + set(ENABLE_VULKAN OFF) + endif() + + get_filename_component(VULKAN_ROOT_DIR "${Vulkan_INCLUDE_DIR}" DIRECTORY) +endif() + if(ENABLE_VULKAN) add_definitions(-DHAS_VULKAN) - if(APPLE AND USE_BUNDLED_MOLTENVK) - add_subdirectory(Externals/MoltenVK) - endif() + if(APPLE) + set(CMAKE_FIND_FRAMEWORK NEVER) + # Find Vulkan driver dylibs + find_library(MOLTENVK_LIBRARY NAMES libMoltenVK.dylib HINTS "${VULKAN_ROOT_DIR}/lib" REQUIRED) + if(ENABLE_KOSMICKRISP) + find_library(KOSMICKRISP_LIBRARY NAMES libvulkan_kosmickrisp.dylib HINTS "${VULKAN_ROOT_DIR}/lib") + endif() + + unset(CMAKE_FIND_FRAMEWORK) + endif() if (ANDROID AND _M_ARM_64) add_subdirectory(Externals/libadrenotools) diff --git a/Externals/MoltenVK/CMakeLists.txt b/Externals/MoltenVK/CMakeLists.txt deleted file mode 100644 index d4e92ea0dc..0000000000 --- a/Externals/MoltenVK/CMakeLists.txt +++ /dev/null @@ -1,22 +0,0 @@ -include(ExternalProject) - -set(MOLTENVK_VERSION "v1.2.8") - -ExternalProject_Add(MoltenVK - GIT_REPOSITORY https://github.com/KhronosGroup/MoltenVK.git - GIT_TAG ${MOLTENVK_VERSION} - - CONFIGURE_COMMAND ${CMAKE_CURRENT_LIST_DIR}/configure.sh ${MOLTENVK_VERSION} - - PATCH_COMMAND ${CMAKE_CURRENT_LIST_DIR}/patch.sh ${CMAKE_SOURCE_DIR}/Externals/MoltenVK/patches/ ${MOLTENVK_VERSION} - - BUILD_COMMAND make -C macos - BUILD_IN_SOURCE ON - BUILD_BYPRODUCTS /Package/Release/MoltenVK/dynamic/dylib/macOS/libMoltenVK.dylib - - INSTALL_COMMAND "" - - LOG_CONFIGURE ON - LOG_BUILD ON - LOG_OUTPUT_ON_FAILURE ON -) diff --git a/Externals/MoltenVK/LICENSE b/Externals/MoltenVK/LICENSE deleted file mode 100644 index d645695673..0000000000 --- a/Externals/MoltenVK/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. diff --git a/Externals/MoltenVK/configure.sh b/Externals/MoltenVK/configure.sh deleted file mode 100755 index 5049026117..0000000000 --- a/Externals/MoltenVK/configure.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/bash - -# To lower build times, we avoid running the fetchDependencies script if the MoltenVK -# version didn't change. The last-built MoltenVK version is stored inside a file in -# the timestamp directory. If the file doesn't exist or the file contains a different -# MoltenVK version, fetchDependencies is ran. -# -# Usage: configure.sh -# - -set -e - -VERSION_PATH="$1/MoltenVK-last-version.txt" -CURRENT_VERSION="$3" -LAST_VERSION=$(cat "$VERSION_PATH" || true) - -if ! [ "$LAST_VERSION" = "$3" ]; then - $2/fetchDependencies --macos - echo $CURRENT_VERSION > $VERSION_PATH -fi diff --git a/Externals/MoltenVK/patch.sh b/Externals/MoltenVK/patch.sh deleted file mode 100755 index 2a40d7eda9..0000000000 --- a/Externals/MoltenVK/patch.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -# Applies all patches in the "patches" folder to the cloned MoltenVK git repository. -# -# Usage: patch.sh -# - -set -e - -# Reset the git repository first to ensure that it's in the base state. -git reset --hard $2 - -git apply $1/*.patch diff --git a/Externals/MoltenVK/patches/0001-SPIRVToMSLConverter-Enable-use_framebuffer_fetch_sub.patch b/Externals/MoltenVK/patches/0001-SPIRVToMSLConverter-Enable-use_framebuffer_fetch_sub.patch deleted file mode 100644 index 095b40f52e..0000000000 --- a/Externals/MoltenVK/patches/0001-SPIRVToMSLConverter-Enable-use_framebuffer_fetch_sub.patch +++ /dev/null @@ -1,24 +0,0 @@ -From b005336f0424de785967e4a67cc5fb7b46e5b321 Mon Sep 17 00:00:00 2001 -From: OatmealDome -Date: Tue, 18 Oct 2022 17:49:12 -0400 -Subject: [PATCH] SPIRVToMSLConverter: Enable use_framebuffer_fetch_subpasses - ---- - .../MoltenVKShaderConverter/SPIRVToMSLConverter.cpp | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp -index 6853b91c..e0155090 100644 ---- a/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp -+++ b/MoltenVKShaderConverter/MoltenVKShaderConverter/SPIRVToMSLConverter.cpp -@@ -92,6 +92,7 @@ MVK_PUBLIC_SYMBOL SPIRVToMSLConversionOptions::SPIRVToMSLConversionOptions() { - #endif - - mslOptions.pad_fragment_output_components = true; -+ mslOptions.use_framebuffer_fetch_subpasses = true; - } - - MVK_PUBLIC_SYMBOL bool mvk::MSLShaderInterfaceVariable::matches(const mvk::MSLShaderInterfaceVariable& other) const { --- -2.32.1 (Apple Git-133) - diff --git a/Externals/Vulkan-Headers b/Externals/Vulkan-Headers index 39f924b810..387259ecf4 160000 --- a/Externals/Vulkan-Headers +++ b/Externals/Vulkan-Headers @@ -1 +1 @@ -Subproject commit 39f924b810e561fd86b2558b6711ca68d4363f68 +Subproject commit 387259ecf4b0fe0cfac161b1d0b0a74e42796710 diff --git a/Source/Core/DolphinQt/CMakeLists.txt b/Source/Core/DolphinQt/CMakeLists.txt index 02700d1c18..6217e1156d 100644 --- a/Source/Core/DolphinQt/CMakeLists.txt +++ b/Source/Core/DolphinQt/CMakeLists.txt @@ -662,21 +662,36 @@ if(APPLE) include(DolphinInjectVersionInfo) dolphin_inject_version_info(dolphin-emu) - # Copy MoltenVK into the bundle + # Copy the Vulkan dylibs into the bundle if(ENABLE_VULKAN) - if(USE_BUNDLED_MOLTENVK) - add_dependencies(dolphin-emu MoltenVK) - ExternalProject_Get_Property(MoltenVK SOURCE_DIR) - target_sources(dolphin-emu PRIVATE "${SOURCE_DIR}/Package/Release/MoltenVK/dynamic/dylib/macOS/libMoltenVK.dylib") - set_source_files_properties("${SOURCE_DIR}/Package/Release/MoltenVK/dynamic/dylib/macOS/libMoltenVK.dylib" PROPERTIES MACOSX_PACKAGE_LOCATION Frameworks GENERATED ON) - else() - find_file(MOLTENVK_DYLIB NAMES libMoltenVK.dylib PATH_SUFFIXES lib) - if(NOT MOLTENVK_DYLIB) - message(FATAL_ERROR "Couldn't find libMoltenVK.dylib. Enable USE_BUNDLED_MOLTENVK?") - endif() - target_sources(dolphin-emu PRIVATE ${MOLTENVK_DYLIB}) - set_source_files_properties(${MOLTENVK_DYLIB} PROPERTIES MACOSX_PACKAGE_LOCATION Frameworks) + set(vulkan_dylibs "${Vulkan_LIBRARY}" "${MOLTENVK_LIBRARY}") + set(vulkan_icds "MoltenVK") + + if(KOSMICKRISP_LIBRARY) + list(APPEND vulkan_dylibs "${KOSMICKRISP_LIBRARY}") + list(APPEND vulkan_icds "libkosmickrisp") endif() + + foreach(dylib ${vulkan_dylibs}) + target_sources(dolphin-emu PRIVATE "${dylib}") + set_source_files_properties("${dylib}" PROPERTIES MACOSX_PACKAGE_LOCATION Frameworks) + endforeach() + + foreach(icd ${vulkan_icds}) + set(icd_path "${CMAKE_CURRENT_BINARY_DIR}/${icd}_icd.json") + + # Patch the ICD to use the correct directory for dylibs in the bundle + file(READ "${VULKAN_ROOT_DIR}/share/vulkan/icd.d/${icd}_icd.json" icd_content) + string(REPLACE "../../../lib/" "../../../Frameworks/" icd_content_fixed "${icd_content}") + file(WRITE "${icd_path}" "${icd_content_fixed}") + + target_sources(dolphin-emu PRIVATE "${icd_path}") + set_source_files_properties("${icd_path}" PROPERTIES + MACOSX_PACKAGE_LOCATION "Resources/vulkan/icd.d" + GENERATED ON + ) + source_group("Resources" FILES "${icd_path}") + endforeach() endif() if(POSTPROCESS_BUNDLE) diff --git a/Source/Core/VideoBackends/Vulkan/VulkanContext.cpp b/Source/Core/VideoBackends/Vulkan/VulkanContext.cpp index d388300b6e..8d0ec6db03 100644 --- a/Source/Core/VideoBackends/Vulkan/VulkanContext.cpp +++ b/Source/Core/VideoBackends/Vulkan/VulkanContext.cpp @@ -259,6 +259,13 @@ VkInstance VulkanContext::CreateVulkanInstance(WindowSystemType wstype, bool ena instance_create_info.ppEnabledLayerNames = &VALIDATION_LAYER_NAME; } +#if defined(VK_USE_PLATFORM_METAL_EXT) + if (wstype == WindowSystemType::MacOS || wstype == WindowSystemType::Headless) + { + instance_create_info.flags |= VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR; + } +#endif + VkInstance instance; VkResult res = vkCreateInstance(&instance_create_info, nullptr, &instance); if (res != VK_SUCCESS) @@ -374,6 +381,14 @@ bool VulkanContext::SelectInstanceExtensions(std::vector* extension { return false; } + + if (wstype == WindowSystemType::MacOS || wstype == WindowSystemType::Headless) + { + if (!AddExtension(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME, true)) + { + return false; + } + } #endif AddExtension(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, false); @@ -467,9 +482,44 @@ void VulkanContext::PopulateBackendInfoAdapters(BackendInfo* backend_info, const backend_info->Adapters.clear(); for (VkPhysicalDevice physical_device : gpu_list) { - VkPhysicalDeviceProperties properties; + VkPhysicalDeviceVulkan12Properties properties_vk12 = {}; + properties_vk12.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_PROPERTIES; + properties_vk12.pNext = nullptr; + + VkPhysicalDeviceProperties2 properties2 = {}; + properties2.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2; + properties2.pNext = &properties_vk12; + + VkPhysicalDeviceProperties& properties = properties2.properties; vkGetPhysicalDeviceProperties(physical_device, &properties); - backend_info->Adapters.push_back(properties.deviceName); + +#if defined(VK_USE_PLATFORM_METAL_EXT) + if (vkGetPhysicalDeviceProperties2 && properties.apiVersion >= VK_API_VERSION_1_2) + { + vkGetPhysicalDeviceProperties2(physical_device, &properties2); + + std::string driver; + if (properties_vk12.driverID == VK_DRIVER_ID_MOLTENVK) + { + driver = "MoltenVK"; + } + else if (properties_vk12.driverID == VK_DRIVER_ID_MESA_KOSMICKRISP) + { + driver = "KosmicKrisp"; + } + else + { + driver = fmt::format("driver ID {}", fmt::underlying(properties_vk12.driverID)); + } + + const std::string device_name = fmt::format("{} ({})", properties.deviceName, driver); + backend_info->Adapters.push_back(device_name); + } + else +#endif + { + backend_info->Adapters.push_back(properties.deviceName); + } } } @@ -943,6 +993,7 @@ static bool DriverIsMesa(VkDriverId driver_id) case VK_DRIVER_ID_MESA_NVK: case VK_DRIVER_ID_IMAGINATION_OPEN_SOURCE_MESA: case VK_DRIVER_ID_MESA_HONEYKRISP: + case VK_DRIVER_ID_MESA_KOSMICKRISP: return true; default: return false; diff --git a/Source/Core/VideoBackends/Vulkan/VulkanLoader.cpp b/Source/Core/VideoBackends/Vulkan/VulkanLoader.cpp index a761a81a3e..79ded596e8 100644 --- a/Source/Core/VideoBackends/Vulkan/VulkanLoader.cpp +++ b/Source/Core/VideoBackends/Vulkan/VulkanLoader.cpp @@ -49,8 +49,8 @@ static bool OpenVulkanLibrary(bool force_system_library) if (libvulkan_env && s_vulkan_module.Open(libvulkan_env)) return true; - // Use the libMoltenVK.dylib from the application bundle. - std::string filename = File::GetBundleDirectory() + "/Contents/Frameworks/libMoltenVK.dylib"; + // Use the libvulkan.dylib from the application bundle. + std::string filename = File::GetBundleDirectory() + "/Contents/Frameworks/libvulkan.dylib"; return s_vulkan_module.Open(filename.c_str()); #else