diff --git a/.gitignore b/.gitignore index 682effd..6b11edc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,11 @@ # cmake files /build -# cargo files -/ui/target - -# ide/lsp files +# ide /.zed /.vscode + +# tools /.clangd /.cache /.ccls diff --git a/CMakeLists.txt b/CMakeLists.txt index a2020e9..59fd525 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,81 +1,33 @@ cmake_minimum_required(VERSION 3.10) +project(lsfg-vk LANGUAGES CXX) -set(CMAKE_SKIP_RPATH ON) +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) -if(NOT LSFGVK_EXCESS_DEBUG) - set(CMAKE_C_VISIBILITY_PRESET "hidden") - set(CMAKE_CXX_VISIBILITY_PRESET "hidden") -endif() - -# subprojects -add_compile_options(-fPIC - -Wno-deprecated-declarations - -Wno-unused-template) - -add_subdirectory(framegen) - -if(LSFGVK_EXCESS_DEBUG) - add_subdirectory(test) -endif() - -# main project -project(lsfg-vk - DESCRIPTION "Lossless Scaling Frame Generation on Linux" - LANGUAGES CXX) - -file(GLOB SOURCES - "src/config/*.cpp" - "src/extract/*.cpp" - "src/mini/*.cpp" - "src/utils/*.cpp" - "src/*.cpp" -) - -add_library(lsfg-vk SHARED ${SOURCES}) - -# target -set_target_properties(lsfg-vk PROPERTIES - CXX_STANDARD 20 - CXX_STANDARD_REQUIRED ON) -target_include_directories(lsfg-vk SYSTEM - PUBLIC include/thirdparty) -target_include_directories(lsfg-vk - PUBLIC include) -target_link_libraries(lsfg-vk PUBLIC - lsfg-vk-framegen) - -# diagnostics if(CMAKE_BUILD_TYPE STREQUAL "Debug") - set_target_properties(lsfg-vk PROPERTIES - EXPORT_COMPILE_COMMANDS ON) + set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + + if(NOT CMAKE_CXX_COMPILER_ID STREQUAL "Clang") + message(WARNING "Debug builds should use Clang for better diagnostics") + else() + message(STATUS "Building with further diagnostics") + + set(CMAKE_CXX_CLANG_TIDY clang-tidy) + + add_compile_options( + -Weverything + # disable incompatible warnings + -Wno-pre-c++20-compat-pedantic + -Wno-c++98-compat + -Wno-switch-default + -Wno-switch-enum + # disable noisy warnings + -Wno-missing-designated-field-initializers + -Wno-cast-function-type-strict + -Wno-padded + -Wno-shadow + ) + endif() endif() -if(LSFGVK_EXCESS_DEBUG) - message(STATUS "LSFGVK_EXCESS_DEBUG is only compatible with clang") - target_compile_options(lsfg-vk PRIVATE - -Weverything - # disable compat c++ flags - -Wno-pre-c++20-compat-pedantic - -Wno-pre-c++17-compat - -Wno-c++98-compat-pedantic - -Wno-c++98-compat - # disable other flags - -Wno-missing-designated-field-initializers - -Wno-shadow # allow shadowing - -Wno-switch-enum # ignore missing cases - -Wno-switch-default # ignore missing default - -Wno-padded # ignore automatic padding - -Wno-exit-time-destructors # allow globals - -Wno-global-constructors # allow globals - -Wno-cast-function-type-strict # for vulkan - ) - - set_target_properties(lsfg-vk PROPERTIES - CXX_CLANG_TIDY clang-tidy) -endif() - -# install -install(FILES "${CMAKE_BINARY_DIR}/liblsfg-vk.so" - DESTINATION lib) -install(FILES "${CMAKE_SOURCE_DIR}/VkLayer_LS_frame_generation.json" - DESTINATION share/vulkan/implicit_layer.d) +add_subdirectory(lsfg-vk-common) diff --git a/LICENSE.md b/LICENSE.md index b5c8a3e..496acdb 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,21 +1,675 @@ -## MIT License +# GNU GENERAL PUBLIC LICENSE -Copyright (c) 2025 lsfg-vk +Version 3, 29 June 2007 -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: +Copyright (C) 2007 Free Software Foundation, Inc. + -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. -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. +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/framegen/include/common/exception.hpp b/framegen/include/common/exception.hpp deleted file mode 100644 index a0e6a35..0000000 --- a/framegen/include/common/exception.hpp +++ /dev/null @@ -1,62 +0,0 @@ -#pragma once - -#include - -#include -#include -#include - -namespace LSFG { - - /// Simple exception class for Vulkan errors. - class vulkan_error : public std::runtime_error { - public: - /// - /// Construct a vulkan_error with a message and a Vulkan result code. - /// - /// @param result The Vulkan result code associated with the error. - /// @param message The error message. - /// - explicit vulkan_error(VkResult result, const std::string& message); - - /// Get the Vulkan result code associated with this error. - [[nodiscard]] VkResult error() const { return this->result; } - - // Trivially copyable, moveable and destructible - vulkan_error(const vulkan_error&) = default; - vulkan_error(vulkan_error&&) = default; - vulkan_error& operator=(const vulkan_error&) = default; - vulkan_error& operator=(vulkan_error&&) = default; - ~vulkan_error() noexcept override; - private: - VkResult result; - }; - - /// Simple exception class for stacking errors. - class rethrowable_error : public std::runtime_error { - public: - /// - /// Construct a new rethrowable_error with a message. - /// - /// @param message The error message. - /// @param exe The original exception to rethrow. - /// - explicit rethrowable_error(const std::string& message, - const std::exception& exe); - - /// Get the exception as a string. - [[nodiscard]] const char* what() const noexcept override { - return message.c_str(); - } - - // Trivially copyable, moveable and destructible - rethrowable_error(const rethrowable_error&) = default; - rethrowable_error(rethrowable_error&&) = default; - rethrowable_error& operator=(const rethrowable_error&) = default; - rethrowable_error& operator=(rethrowable_error&&) = default; - ~rethrowable_error() noexcept override; - private: - std::string message; - }; - -} diff --git a/framegen/include/core/buffer.hpp b/framegen/include/core/buffer.hpp deleted file mode 100644 index 1aa1b49..0000000 --- a/framegen/include/core/buffer.hpp +++ /dev/null @@ -1,71 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan buffer. - /// - /// This class manages the lifetime of a Vulkan buffer. - /// - class Buffer { - public: - Buffer() noexcept = default; - - /// - /// Create the buffer. - /// - /// @param device Vulkan device - /// @param data Initial data for the buffer, also specifies the size of the buffer. - /// @param usage Usage flags for the buffer - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - template - Buffer(const Core::Device& device, const T& data, VkBufferUsageFlags usage) - : size(sizeof(T)) { - construct(device, reinterpret_cast(&data), usage); - } - - /// - /// Create the buffer. - /// - /// @param device Vulkan device - /// @param data Initial data for the buffer - /// @param size Size of the buffer in bytes - /// @param usage Usage flags for the buffer - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Buffer(const Core::Device& device, const void* data, size_t size, VkBufferUsageFlags usage) - : size(size) { - construct(device, data, usage); - } - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->buffer; } - /// Get the size of the buffer. - [[nodiscard]] size_t getSize() const { return this->size; } - - /// Trivially copyable, moveable and destructible - Buffer(const Buffer&) noexcept = default; - Buffer& operator=(const Buffer&) noexcept = default; - Buffer(Buffer&&) noexcept = default; - Buffer& operator=(Buffer&&) noexcept = default; - ~Buffer() = default; - private: - void construct(const Core::Device& device, const void* data, VkBufferUsageFlags usage); - - std::shared_ptr buffer; - std::shared_ptr memory; - - size_t size{}; - }; - -} diff --git a/framegen/include/core/commandbuffer.hpp b/framegen/include/core/commandbuffer.hpp deleted file mode 100644 index 35eeb57..0000000 --- a/framegen/include/core/commandbuffer.hpp +++ /dev/null @@ -1,112 +0,0 @@ -#pragma once - -#include "core/commandpool.hpp" -#include "core/fence.hpp" -#include "core/semaphore.hpp" -#include "core/device.hpp" - -#include - -#include -#include -#include -#include - -namespace LSFG::Core { - - /// State of the command buffer. - enum class CommandBufferState { - /// Command buffer is not initialized or has been destroyed. - Invalid, - /// Command buffer has been created. - Empty, - /// Command buffer recording has started. - Recording, - /// Command buffer recording has ended. - Full, - /// Command buffer has been submitted to a queue. - Submitted - }; - - /// - /// C++ wrapper class for a Vulkan command buffer. - /// - /// This class manages the lifetime of a Vulkan command buffer. - /// - class CommandBuffer { - public: - CommandBuffer() noexcept = default; - - /// - /// Create the command buffer. - /// - /// @param device Vulkan device - /// @param pool Vulkan command pool - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - CommandBuffer(const Core::Device& device, const CommandPool& pool); - - /// - /// Begin recording commands in the command buffer. - /// - /// @throws std::logic_error if the command buffer is in Empty state - /// @throws LSFG::vulkan_error if beginning the command buffer fails. - /// - void begin(); - - /// - /// Dispatch a compute command. - /// - /// @param x Number of groups in the X dimension - /// @param y Number of groups in the Y dimension - /// @param z Number of groups in the Z dimension - /// - /// @throws std::logic_error if the command buffer is not in Recording state - /// - void dispatch(uint32_t x, uint32_t y, uint32_t z) const; - - /// - /// End recording commands in the command buffer. - /// - /// @throws std::logic_error if the command buffer is not in Recording state - /// @throws LSFG::vulkan_error if ending the command buffer fails. - /// - void end(); - - /// - /// Submit the command buffer to a queue. - /// - /// @param queue Vulkan queue to submit to - /// @param fence Optional fence to signal when the command buffer has finished executing - /// @param waitSemaphores Semaphores to wait on before executing the command buffer - /// @param waitSemaphoreValues Values for the semaphores to wait on - /// @param signalSemaphores Semaphores to signal after executing the command buffer - /// @param signalSemaphoreValues Values for the semaphores to signal - /// - /// @throws std::logic_error if the command buffer is not in Full state. - /// @throws LSFG::vulkan_error if submission fails. - /// - void submit(VkQueue queue, std::optional fence, - const std::vector& waitSemaphores = {}, - std::optional> waitSemaphoreValues = std::nullopt, - const std::vector& signalSemaphores = {}, - std::optional> signalSemaphoreValues = std::nullopt); - - /// Get the state of the command buffer. - [[nodiscard]] CommandBufferState getState() const { return *this->state; } - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->commandBuffer; } - - /// Trivially copyable, moveable and destructible - CommandBuffer(const CommandBuffer&) noexcept = default; - CommandBuffer& operator=(const CommandBuffer&) noexcept = default; - CommandBuffer(CommandBuffer&&) noexcept = default; - CommandBuffer& operator=(CommandBuffer&&) noexcept = default; - ~CommandBuffer() = default; - private: - std::shared_ptr state; - std::shared_ptr commandBuffer; - }; - -} diff --git a/framegen/include/core/commandpool.hpp b/framegen/include/core/commandpool.hpp deleted file mode 100644 index 7f4539d..0000000 --- a/framegen/include/core/commandpool.hpp +++ /dev/null @@ -1,42 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan command pool. - /// - /// This class manages the lifetime of a Vulkan command pool. - /// - class CommandPool { - public: - CommandPool() noexcept = default; - - /// - /// Create the command pool. - /// - /// @param device Vulkan device - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - CommandPool(const Core::Device& device); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->commandPool; } - - /// Trivially copyable, moveable and destructible - CommandPool(const CommandPool&) noexcept = default; - CommandPool& operator=(const CommandPool&) noexcept = default; - CommandPool(CommandPool&&) noexcept = default; - CommandPool& operator=(CommandPool&&) noexcept = default; - ~CommandPool() = default; - private: - std::shared_ptr commandPool; - }; - -} diff --git a/framegen/include/core/descriptorpool.hpp b/framegen/include/core/descriptorpool.hpp deleted file mode 100644 index 792f843..0000000 --- a/framegen/include/core/descriptorpool.hpp +++ /dev/null @@ -1,42 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan descriptor pool. - /// - /// This class manages the lifetime of a Vulkan descriptor pool. - /// - class DescriptorPool { - public: - DescriptorPool() noexcept = default; - - /// - /// Create the descriptor pool. - /// - /// @param device Vulkan device - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - DescriptorPool(const Core::Device& device); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->descriptorPool; } - - /// Trivially copyable, moveable and destructible - DescriptorPool(const DescriptorPool&) noexcept = default; - DescriptorPool& operator=(const DescriptorPool&) noexcept = default; - DescriptorPool(DescriptorPool&&) noexcept = default; - DescriptorPool& operator=(DescriptorPool&&) noexcept = default; - ~DescriptorPool() = default; - private: - std::shared_ptr descriptorPool; - }; - -} diff --git a/framegen/include/core/descriptorset.hpp b/framegen/include/core/descriptorset.hpp deleted file mode 100644 index 86fb20a..0000000 --- a/framegen/include/core/descriptorset.hpp +++ /dev/null @@ -1,128 +0,0 @@ -#pragma once - -#include "core/buffer.hpp" -#include "core/commandbuffer.hpp" -#include "core/descriptorpool.hpp" -#include "core/image.hpp" -#include "core/pipeline.hpp" -#include "core/sampler.hpp" -#include "core/shadermodule.hpp" -#include "core/device.hpp" - -#include - -#include -#include -#include -#include -#include - -namespace LSFG::Core { - - class DescriptorSetUpdateBuilder; - - /// - /// C++ wrapper class for a Vulkan descriptor set. - /// - /// This class manages the lifetime of a Vulkan descriptor set. - /// - class DescriptorSet { - public: - DescriptorSet() noexcept = default; - - /// - /// Create the descriptor set. - /// - /// @param device Vulkan device - /// @param pool Descriptor pool to allocate from - /// @param shaderModule Shader module to use for the descriptor set - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - DescriptorSet(const Core::Device& device, - const DescriptorPool& pool, const ShaderModule& shaderModule); - - /// - /// Update the descriptor set with resources. - /// - /// @param device Vulkan device - /// - [[nodiscard]] DescriptorSetUpdateBuilder update(const Core::Device& device) const; - - /// - /// Bind a descriptor set to a command buffer. - /// - /// @param commandBuffer Command buffer to bind the descriptor set to. - /// @param pipeline Pipeline to bind the descriptor set to. - /// - void bind(const CommandBuffer& commandBuffer, const Pipeline& pipeline) const; - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->descriptorSet; } - - /// Trivially copyable, moveable and destructible - DescriptorSet(const DescriptorSet&) noexcept = default; - DescriptorSet& operator=(const DescriptorSet&) noexcept = default; - DescriptorSet(DescriptorSet&&) noexcept = default; - DescriptorSet& operator=(DescriptorSet&&) noexcept = default; - ~DescriptorSet() = default; - private: - std::shared_ptr descriptorSet; - }; - - /// - /// Builder class for updating a descriptor set. - /// - class DescriptorSetUpdateBuilder { - friend class DescriptorSet; - public: - /// Add a resource to the descriptor set update. - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const Image& image); - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const Sampler& sampler); - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const Buffer& buffer); - DescriptorSetUpdateBuilder& add(VkDescriptorType type); // empty entry - - /// Add a list of resources to the descriptor set update. - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::vector& images) { - for (const auto& image : images) this->add(type, image); return *this; } - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::vector& samplers) { - for (const auto& sampler : samplers) this->add(type, sampler); return *this; } - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::vector& buffers) { - for (const auto& buffer : buffers) this->add(type, buffer); return *this; } - - /// Add an array of resources - template - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::array& images) { - for (const auto& image : images) this->add(type, image); return *this; } - template - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::array& samplers) { - for (const auto& sampler : samplers) this->add(type, sampler); return *this; } - template - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::array& buffers) { - for (const auto& buffer : buffers) this->add(type, buffer); return *this; } - - /// Add an optional resource to the descriptor set update. - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::optional& image) { - if (image.has_value()) this->add(type, *image); else this->add(type); return *this; } - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::optional& sampler) { - if (sampler.has_value()) this->add(type, *sampler); else this->add(type); return *this; } - DescriptorSetUpdateBuilder& add(VkDescriptorType type, const std::optional& buffer) { - if (buffer.has_value()) this->add(type, *buffer); else this->add(type); return *this; } - - /// Finish building the descriptor set update. - void build(); - private: - const DescriptorSet* descriptorSet; - const Core::Device* device; - - DescriptorSetUpdateBuilder(const DescriptorSet& descriptorSet, const Core::Device& device) - : descriptorSet(&descriptorSet), device(&device) {} - - std::vector entries; - size_t bufferIdx{0}; - size_t samplerIdx{16}; - size_t inputIdx{32}; - size_t outputIdx{48}; - }; - -} diff --git a/framegen/include/core/device.hpp b/framegen/include/core/device.hpp deleted file mode 100644 index a913a42..0000000 --- a/framegen/include/core/device.hpp +++ /dev/null @@ -1,57 +0,0 @@ -#pragma once - -#include "core/instance.hpp" - -#include - -#include -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan device. - /// - /// This class manages the lifetime of a Vulkan device. - /// - class Device { - public: - /// - /// Create the device. - /// - /// @param instance Vulkan instance - /// @param deviceUUID The UUID of the Vulkan device to use. - /// @param forceDisableFp16 Force-disable FP16 shaders. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Device(const Instance& instance, uint64_t deviceUUID, bool forceDisableFp16); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->device; } - /// Get the physical device associated with this logical device. - [[nodiscard]] VkPhysicalDevice getPhysicalDevice() const { return this->physicalDevice; } - /// Get the compute queue family index. - [[nodiscard]] uint32_t getComputeFamilyIdx() const { return this->computeFamilyIdx; } - /// Get the compute queue. - [[nodiscard]] VkQueue getComputeQueue() const { return this->computeQueue; } - /// Check if the device supports FP16. - [[nodiscard]] bool getFP16Support() const { return this->supportsFP16; } - - // Trivially copyable, moveable and destructible - Device(const Core::Device&) noexcept = default; - Device& operator=(const Core::Device&) noexcept = default; - Device(Device&&) noexcept = default; - Device& operator=(Device&&) noexcept = default; - ~Device() = default; - private: - std::shared_ptr device; - VkPhysicalDevice physicalDevice{}; - - uint32_t computeFamilyIdx{0}; - bool supportsFP16{false}; - - VkQueue computeQueue{}; - }; - -} diff --git a/framegen/include/core/fence.hpp b/framegen/include/core/fence.hpp deleted file mode 100644 index 1739220..0000000 --- a/framegen/include/core/fence.hpp +++ /dev/null @@ -1,63 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan fence. - /// - /// This class manages the lifetime of a Vulkan fence. - /// - class Fence { - public: - Fence() noexcept = default; - - /// - /// Create the fence. - /// - /// @param device Vulkan device - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Fence(const Core::Device& device); - - /// - /// Reset the fence to an unsignaled state. - /// - /// @param device Vulkan device - /// - /// @throws LSFG::vulkan_error if resetting fails. - /// - void reset(const Core::Device& device) const; - - /// - /// Wait for the fence - /// - /// @param device Vulkan device - /// @param timeout The timeout in nanoseconds, or UINT64_MAX for no timeout. - /// @returns true if the fence signaled, false if it timed out. - /// - /// @throws LSFG::vulkan_error if waiting fails. - /// - [[nodiscard]] bool wait(const Core::Device& device, uint64_t timeout = UINT64_MAX) const; - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->fence; } - - // Trivially copyable, moveable and destructible - Fence(const Fence&) noexcept = default; - Fence& operator=(const Fence&) noexcept = default; - Fence(Fence&&) noexcept = default; - Fence& operator=(Fence&&) noexcept = default; - ~Fence() = default; - private: - std::shared_ptr fence; - }; - -} diff --git a/framegen/include/core/image.hpp b/framegen/include/core/image.hpp deleted file mode 100644 index b89fea5..0000000 --- a/framegen/include/core/image.hpp +++ /dev/null @@ -1,102 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan image. - /// - /// This class manages the lifetime of a Vulkan image. - /// - class Image { - public: - Image() noexcept = default; - - /// - /// Create the image. - /// - /// @param device Vulkan device - /// @param extent Extent of the image in pixels. - /// @param format Vulkan format of the image - /// @param usage Usage flags for the image - /// @param aspectFlags Aspect flags for the image view - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Image(const Core::Device& device, VkExtent2D extent, - VkFormat format = VK_FORMAT_R8G8B8A8_UNORM, - VkImageUsageFlags usage = VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_SAMPLED_BIT, - VkImageAspectFlags aspectFlags = VK_IMAGE_ASPECT_COLOR_BIT); - - /// - /// Create the image with shared backing memory. - /// - /// @param device Vulkan device - /// @param extent Extent of the image in pixels. - /// @param format Vulkan format of the image - /// @param usage Usage flags for the image - /// @param aspectFlags Aspect flags for the image view - /// @param fd File descriptor for shared memory. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Image(const Core::Device& device, VkExtent2D extent, VkFormat format, - VkImageUsageFlags usage, VkImageAspectFlags aspectFlags, int fd); - - /// - /// Create the image and export the backing fd - /// - /// @param device Vulkan device - /// @param extent Extent of the image in pixels. - /// @param format Vulkan format of the image - /// @param usage Usage flags for the image - /// @param aspectFlags Aspect flags for the image view - /// @param fd Pointer to an integer where the file descriptor will be stored. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Image(const Core::Device& device, VkExtent2D extent, VkFormat format, - VkImageUsageFlags usage, VkImageAspectFlags aspectFlags, int* fd); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->image; } - /// Get the Vulkan device memory handle. - [[nodiscard]] auto getMemory() const { return *this->memory; } - /// Get the Vulkan image view handle. - [[nodiscard]] auto getView() const { return *this->view; } - /// Get the extent of the image. - [[nodiscard]] VkExtent2D getExtent() const { return this->extent; } - /// Get the format of the image. - [[nodiscard]] VkFormat getFormat() const { return this->format; } - /// Get the aspect flags of the image. - [[nodiscard]] VkImageAspectFlags getAspectFlags() const { return this->aspectFlags; } - - /// Set the layout of the image. - void setLayout(VkImageLayout layout) { *this->layout = layout; } - /// Get the current layout of the image. - [[nodiscard]] VkImageLayout getLayout() const { return *this->layout; } - - /// Trivially copyable, moveable and destructible - Image(const Image&) noexcept = default; - Image& operator=(const Image&) noexcept = default; - Image(Image&&) noexcept = default; - Image& operator=(Image&&) noexcept = default; - ~Image() = default; - private: - std::shared_ptr image; - std::shared_ptr memory; - std::shared_ptr view; - - std::shared_ptr layout; - - VkExtent2D extent{}; - VkFormat format{}; - VkImageAspectFlags aspectFlags{}; - }; - -} diff --git a/framegen/include/core/instance.hpp b/framegen/include/core/instance.hpp deleted file mode 100644 index 24cba8a..0000000 --- a/framegen/include/core/instance.hpp +++ /dev/null @@ -1,36 +0,0 @@ -#pragma once - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan instance. - /// - /// This class manages the lifetime of a Vulkan instance. - /// - class Instance { - public: - /// - /// Create the instance. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Instance(); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return this->instance ? *this->instance : VK_NULL_HANDLE; } - - /// Trivially copyable, moveable and destructible - Instance(const Instance&) noexcept = default; - Instance& operator=(const Instance&) noexcept = default; - Instance(Instance&&) noexcept = default; - Instance& operator=(Instance&&) noexcept = default; - ~Instance() = default; - private: - std::shared_ptr instance; - }; - -} diff --git a/framegen/include/core/pipeline.hpp b/framegen/include/core/pipeline.hpp deleted file mode 100644 index 6eddb5a..0000000 --- a/framegen/include/core/pipeline.hpp +++ /dev/null @@ -1,55 +0,0 @@ -#pragma once - -#include "core/commandbuffer.hpp" -#include "core/shadermodule.hpp" -#include "core/device.hpp" - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan pipeline. - /// - /// This class manages the lifetime of a Vulkan pipeline. - /// - class Pipeline { - public: - Pipeline() noexcept = default; - - /// - /// Create a compute pipeline. - /// - /// @param device Vulkan device - /// @param shader Shader module to use for the pipeline. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Pipeline(const Core::Device& device, const ShaderModule& shader); - - /// - /// Bind the pipeline to a command buffer. - /// - /// @param commandBuffer Command buffer to bind the pipeline to. - /// - void bind(const CommandBuffer& commandBuffer) const; - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->pipeline; } - /// Get the pipeline layout. - [[nodiscard]] auto getLayout() const { return *this->layout; } - - /// Trivially copyable, moveable and destructible - Pipeline(const Pipeline&) noexcept = default; - Pipeline& operator=(const Pipeline&) noexcept = default; - Pipeline(Pipeline&&) noexcept = default; - Pipeline& operator=(Pipeline&&) noexcept = default; - ~Pipeline() = default; - private: - std::shared_ptr pipeline; - std::shared_ptr layout; - }; - -} diff --git a/framegen/include/core/sampler.hpp b/framegen/include/core/sampler.hpp deleted file mode 100644 index 981077c..0000000 --- a/framegen/include/core/sampler.hpp +++ /dev/null @@ -1,48 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan sampler. - /// - /// This class manages the lifetime of a Vulkan sampler. - /// - class Sampler { - public: - Sampler() noexcept = default; - - /// - /// Create the sampler. - /// - /// @param device Vulkan device - /// @param mode Address mode for the sampler. - /// @param compare Compare operation for the sampler. - /// @param isWhite Whether the border color is white. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Sampler(const Core::Device& device, - VkSamplerAddressMode mode, - VkCompareOp compare, - bool isWhite); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->sampler; } - - /// Trivially copyable, moveable and destructible - Sampler(const Sampler&) noexcept = default; - Sampler& operator=(const Sampler&) noexcept = default; - Sampler(Sampler&&) noexcept = default; - Sampler& operator=(Sampler&&) noexcept = default; - ~Sampler() = default; - private: - std::shared_ptr sampler; - }; - -} diff --git a/framegen/include/core/semaphore.hpp b/framegen/include/core/semaphore.hpp deleted file mode 100644 index 773ca0c..0000000 --- a/framegen/include/core/semaphore.hpp +++ /dev/null @@ -1,80 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include -#include -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan semaphore. - /// - /// This class manages the lifetime of a Vulkan semaphore. - /// - class Semaphore { - public: - Semaphore() noexcept = default; - - /// - /// Create the semaphore. - /// - /// @param device Vulkan device - /// @param initial Optional initial value for creating a timeline semaphore. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Semaphore(const Core::Device& device, std::optional initial = std::nullopt); - - /// - /// Import a semaphore. - /// - /// @param device Vulkan device - /// @param fd File descriptor to import the semaphore from. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - Semaphore(const Core::Device& device, int fd); - - /// - /// Signal the semaphore to a specific value. - /// - /// @param device Vulkan device - /// @param value The value to signal the semaphore to. - /// - /// @throws std::logic_error if the semaphore is not a timeline semaphore. - /// @throws LSFG::vulkan_error if signaling fails. - /// - void signal(const Core::Device& device, uint64_t value) const; - - /// - /// Wait for the semaphore to reach a specific value. - /// - /// @param device Vulkan device - /// @param value The value to wait for. - /// @param timeout The timeout in nanoseconds, or UINT64_MAX for no timeout. - /// @returns true if the semaphore reached the value, false if it timed out. - /// - /// @throws std::logic_error if the semaphore is not a timeline semaphore. - /// @throws LSFG::vulkan_error if waiting fails. - /// - [[nodiscard]] bool wait(const Core::Device& device, uint64_t value, uint64_t timeout = UINT64_MAX) const; - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->semaphore; } - - // Trivially copyable, moveable and destructible - Semaphore(const Semaphore&) noexcept = default; - Semaphore& operator=(const Semaphore&) noexcept = default; - Semaphore(Semaphore&&) noexcept = default; - Semaphore& operator=(Semaphore&&) noexcept = default; - ~Semaphore() = default; - private: - std::shared_ptr semaphore; - bool isTimeline{}; - }; - -} diff --git a/framegen/include/core/shadermodule.hpp b/framegen/include/core/shadermodule.hpp deleted file mode 100644 index ac38234..0000000 --- a/framegen/include/core/shadermodule.hpp +++ /dev/null @@ -1,52 +0,0 @@ -#pragma once - -#include "core/device.hpp" - -#include - -#include -#include -#include -#include -#include - -namespace LSFG::Core { - - /// - /// C++ wrapper class for a Vulkan shader module. - /// - /// This class manages the lifetime of a Vulkan shader module. - /// - class ShaderModule { - public: - ShaderModule() noexcept = default; - - /// - /// Create the shader module. - /// - /// @param device Vulkan device - /// @param code SPIR-V bytecode for the shader. - /// @param descriptorTypes Descriptor types used in the shader. - /// - /// @throws LSFG::vulkan_error if object creation fails. - /// - ShaderModule(const Core::Device& device, const std::vector& code, - const std::vector>& descriptorTypes); - - /// Get the Vulkan handle. - [[nodiscard]] auto handle() const { return *this->shaderModule; } - /// Get the descriptor set layout. - [[nodiscard]] auto getLayout() const { return *this->descriptorSetLayout; } - - /// Trivially copyable, moveable and destructible - ShaderModule(const ShaderModule&) noexcept = default; - ShaderModule& operator=(const ShaderModule&) noexcept = default; - ShaderModule(ShaderModule&&) noexcept = default; - ShaderModule& operator=(ShaderModule&&) noexcept = default; - ~ShaderModule() = default; - private: - std::shared_ptr shaderModule; - std::shared_ptr descriptorSetLayout; - }; - -} diff --git a/framegen/src/common/exception.cpp b/framegen/src/common/exception.cpp deleted file mode 100644 index 5ea7b0d..0000000 --- a/framegen/src/common/exception.cpp +++ /dev/null @@ -1,24 +0,0 @@ -#include "common/exception.hpp" - -#include - -#include -#include -#include -#include -#include - -using namespace LSFG; - -vulkan_error::vulkan_error(VkResult result, const std::string& message) - : std::runtime_error(std::format("{} (error {})", message, static_cast(result))), - result(result) {} - -vulkan_error::~vulkan_error() noexcept = default; - -rethrowable_error::rethrowable_error(const std::string& message, const std::exception& exe) - : std::runtime_error(message) { - this->message = std::format("{}\n- {}", message, exe.what()); -} - -rethrowable_error::~rethrowable_error() noexcept = default; diff --git a/framegen/src/core/buffer.cpp b/framegen/src/core/buffer.cpp deleted file mode 100644 index 319c829..0000000 --- a/framegen/src/core/buffer.cpp +++ /dev/null @@ -1,86 +0,0 @@ -#include -#include - -#include "core/buffer.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include -#include -#include - -using namespace LSFG::Core; - -void Buffer::construct(const Core::Device& device, const void* data, VkBufferUsageFlags usage) { - // create buffer - const VkBufferCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, - .size = this->size, - .usage = usage, - .sharingMode = VK_SHARING_MODE_EXCLUSIVE - }; - VkBuffer bufferHandle{}; - auto res = vkCreateBuffer(device.handle(), &desc, nullptr, &bufferHandle); - if (res != VK_SUCCESS || bufferHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create Vulkan buffer"); - - // find memory type - VkPhysicalDeviceMemoryProperties memProps; - vkGetPhysicalDeviceMemoryProperties(device.getPhysicalDevice(), &memProps); - - VkMemoryRequirements memReqs; - vkGetBufferMemoryRequirements(device.handle(), bufferHandle, &memReqs); - -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" - std::optional memType{}; - for (uint32_t i = 0; i < memProps.memoryTypeCount; ++i) { - if ((memReqs.memoryTypeBits & (1 << i)) && // NOLINTBEGIN - (memProps.memoryTypes[i].propertyFlags & - (VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT))) { - memType.emplace(i); - break; - } // NOLINTEND - } - if (!memType.has_value()) - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unable to find memory type for buffer"); -#pragma clang diagnostic pop - - // allocate and bind memory - const VkMemoryAllocateInfo allocInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, - .allocationSize = memReqs.size, - .memoryTypeIndex = memType.value() - }; - VkDeviceMemory memoryHandle{}; - res = vkAllocateMemory(device.handle(), &allocInfo, nullptr, &memoryHandle); - if (res != VK_SUCCESS || memoryHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to allocate memory for Vulkan buffer"); - - res = vkBindBufferMemory(device.handle(), bufferHandle, memoryHandle, 0); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to bind memory to Vulkan buffer"); - - // upload data to buffer - uint8_t* buf{}; - res = vkMapMemory(device.handle(), memoryHandle, 0, this->size, 0, reinterpret_cast(&buf)); - if (res != VK_SUCCESS || buf == nullptr) - throw LSFG::vulkan_error(res, "Failed to map memory for Vulkan buffer"); - std::copy_n(reinterpret_cast(data), this->size, buf); - vkUnmapMemory(device.handle(), memoryHandle); - - // store buffer and memory in shared ptr - this->buffer = std::shared_ptr( - new VkBuffer(bufferHandle), - [dev = device.handle()](VkBuffer* img) { - vkDestroyBuffer(dev, *img, nullptr); - } - ); - this->memory = std::shared_ptr( - new VkDeviceMemory(memoryHandle), - [dev = device.handle()](VkDeviceMemory* mem) { - vkFreeMemory(dev, *mem, nullptr); - } - ); -} diff --git a/framegen/src/core/commandbuffer.cpp b/framegen/src/core/commandbuffer.cpp deleted file mode 100644 index 7deea63..0000000 --- a/framegen/src/core/commandbuffer.cpp +++ /dev/null @@ -1,125 +0,0 @@ -#include -#include - -#include "core/commandbuffer.hpp" -#include "core/device.hpp" -#include "core/commandpool.hpp" -#include "core/fence.hpp" -#include "core/semaphore.hpp" -#include "common/exception.hpp" - -#include -#include -#include -#include -#include - -using namespace LSFG::Core; - -CommandBuffer::CommandBuffer(const Core::Device& device, const CommandPool& pool) { - // create command buffer - const VkCommandBufferAllocateInfo desc{ - .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO, - .commandPool = pool.handle(), - .level = VK_COMMAND_BUFFER_LEVEL_PRIMARY, - .commandBufferCount = 1 - }; - VkCommandBuffer commandBufferHandle{}; - auto res = vkAllocateCommandBuffers(device.handle(), &desc, &commandBufferHandle); - if (res != VK_SUCCESS || commandBufferHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to allocate command buffer"); - - // store command buffer in shared ptr - this->state = std::make_shared(CommandBufferState::Empty); - this->commandBuffer = std::shared_ptr( - new VkCommandBuffer(commandBufferHandle), - [dev = device.handle(), pool = pool.handle()](VkCommandBuffer* cmdBuffer) { - vkFreeCommandBuffers(dev, pool, 1, cmdBuffer); - } - ); -} - -void CommandBuffer::begin() { - if (*this->state != CommandBufferState::Empty) - throw std::logic_error("Command buffer is not in Empty state"); - - const VkCommandBufferBeginInfo beginInfo = { - .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO, - .flags = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT - }; - auto res = vkBeginCommandBuffer(*this->commandBuffer, &beginInfo); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to begin command buffer"); - - *this->state = CommandBufferState::Recording; -} - -void CommandBuffer::dispatch(uint32_t x, uint32_t y, uint32_t z) const { - if (*this->state != CommandBufferState::Recording) - throw std::logic_error("Command buffer is not in Recording state"); - - vkCmdDispatch(*this->commandBuffer, x, y, z); -} - -void CommandBuffer::end() { - if (*this->state != CommandBufferState::Recording) - throw std::logic_error("Command buffer is not in Recording state"); - - auto res = vkEndCommandBuffer(*this->commandBuffer); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to end command buffer"); - - *this->state = CommandBufferState::Full; -} - -void CommandBuffer::submit(VkQueue queue, std::optional fence, - const std::vector& waitSemaphores, - std::optional> waitSemaphoreValues, - const std::vector& signalSemaphores, - std::optional> signalSemaphoreValues) { - if (*this->state != CommandBufferState::Full) - throw std::logic_error("Command buffer is not in Full state"); - - const std::vector waitStages(waitSemaphores.size(), - VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT); - VkTimelineSemaphoreSubmitInfo timelineInfo{ - .sType = VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO, - }; - if (waitSemaphoreValues.has_value()) { - timelineInfo.waitSemaphoreValueCount = - static_cast(waitSemaphoreValues->size()); - timelineInfo.pWaitSemaphoreValues = waitSemaphoreValues->data(); - } - if (signalSemaphoreValues.has_value()) { - timelineInfo.signalSemaphoreValueCount = - static_cast(signalSemaphoreValues->size()); - timelineInfo.pSignalSemaphoreValues = signalSemaphoreValues->data(); - } - - std::vector waitSemaphoresHandles; - waitSemaphoresHandles.reserve(waitSemaphores.size()); - for (const auto& semaphore : waitSemaphores) - waitSemaphoresHandles.push_back(semaphore.handle()); - std::vector signalSemaphoresHandles; - signalSemaphoresHandles.reserve(signalSemaphores.size()); - for (const auto& semaphore : signalSemaphores) - signalSemaphoresHandles.push_back(semaphore.handle()); - - const VkSubmitInfo submitInfo{ - .sType = VK_STRUCTURE_TYPE_SUBMIT_INFO, - .pNext = (waitSemaphoreValues.has_value() || signalSemaphoreValues.has_value()) - ? &timelineInfo : nullptr, - .waitSemaphoreCount = static_cast(waitSemaphores.size()), - .pWaitSemaphores = waitSemaphoresHandles.data(), - .pWaitDstStageMask = waitStages.data(), - .commandBufferCount = 1, - .pCommandBuffers = &(*this->commandBuffer), - .signalSemaphoreCount = static_cast(signalSemaphores.size()), - .pSignalSemaphores = signalSemaphoresHandles.data() - }; - auto res = vkQueueSubmit(queue, 1, &submitInfo, fence ? fence->handle() : VK_NULL_HANDLE); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to submit command buffer"); - - *this->state = CommandBufferState::Submitted; -} diff --git a/framegen/src/core/commandpool.cpp b/framegen/src/core/commandpool.cpp deleted file mode 100644 index 2ff457f..0000000 --- a/framegen/src/core/commandpool.cpp +++ /dev/null @@ -1,30 +0,0 @@ -#include -#include - -#include "core/commandpool.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include - -using namespace LSFG::Core; - -CommandPool::CommandPool(const Core::Device& device) { - // create command pool - const VkCommandPoolCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO, - .queueFamilyIndex = device.getComputeFamilyIdx() - }; - VkCommandPool commandPoolHandle{}; - auto res = vkCreateCommandPool(device.handle(), &desc, nullptr, &commandPoolHandle); - if (res != VK_SUCCESS || commandPoolHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create command pool"); - - // store command pool in shared ptr - this->commandPool = std::shared_ptr( - new VkCommandPool(commandPoolHandle), - [dev = device.handle()](VkCommandPool* commandPoolHandle) { - vkDestroyCommandPool(dev, *commandPoolHandle, nullptr); - } - ); -} diff --git a/framegen/src/core/descriptorpool.cpp b/framegen/src/core/descriptorpool.cpp deleted file mode 100644 index eea5bb2..0000000 --- a/framegen/src/core/descriptorpool.cpp +++ /dev/null @@ -1,41 +0,0 @@ -#include -#include - -#include "core/descriptorpool.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include -#include - -using namespace LSFG::Core; - -DescriptorPool::DescriptorPool(const Core::Device& device) { - // create descriptor pool - const std::array pools{{ // arbitrary limits - { .type = VK_DESCRIPTOR_TYPE_SAMPLER, .descriptorCount = 4096 }, - { .type = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, .descriptorCount = 4096 }, - { .type = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, .descriptorCount = 4096 }, - { .type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, .descriptorCount = 4096 } - }}; - const VkDescriptorPoolCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO, - .flags = VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT, - .maxSets = 16384, - .poolSizeCount = static_cast(pools.size()), - .pPoolSizes = pools.data() - }; - VkDescriptorPool poolHandle{}; - auto res = vkCreateDescriptorPool(device.handle(), &desc, nullptr, &poolHandle); - if (res != VK_SUCCESS || poolHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create descriptor pool"); - - // store pool in shared ptr - this->descriptorPool = std::shared_ptr( - new VkDescriptorPool(poolHandle), - [dev = device.handle()](VkDescriptorPool* poolHandle) { - vkDestroyDescriptorPool(dev, *poolHandle, nullptr); - } - ); -} diff --git a/framegen/src/core/descriptorset.cpp b/framegen/src/core/descriptorset.cpp deleted file mode 100644 index 62e9017..0000000 --- a/framegen/src/core/descriptorset.cpp +++ /dev/null @@ -1,150 +0,0 @@ -#include -#include - -#include "core/descriptorset.hpp" -#include "core/device.hpp" -#include "core/descriptorpool.hpp" -#include "core/shadermodule.hpp" -#include "core/commandbuffer.hpp" -#include "core/pipeline.hpp" -#include "core/image.hpp" -#include "core/sampler.hpp" -#include "core/buffer.hpp" -#include "common/exception.hpp" - -#include -#include -#include - -using namespace LSFG::Core; - -DescriptorSet::DescriptorSet(const Core::Device& device, - const DescriptorPool& pool, const ShaderModule& shaderModule) { - // create descriptor set - VkDescriptorSetLayout layout = shaderModule.getLayout(); - const VkDescriptorSetAllocateInfo desc{ - .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO, - .descriptorPool = pool.handle(), - .descriptorSetCount = 1, - .pSetLayouts = &layout - }; - VkDescriptorSet descriptorSetHandle{}; - auto res = vkAllocateDescriptorSets(device.handle(), &desc, &descriptorSetHandle); - if (res != VK_SUCCESS || descriptorSetHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to allocate descriptor set"); - - /// store set in shared ptr - this->descriptorSet = std::shared_ptr( - new VkDescriptorSet(descriptorSetHandle), - [dev = device.handle(), pool = pool](VkDescriptorSet* setHandle) { - vkFreeDescriptorSets(dev, pool.handle(), 1, setHandle); - } - ); -} - -DescriptorSetUpdateBuilder DescriptorSet::update(const Core::Device& device) const { - return { *this, device }; -} - -void DescriptorSet::bind(const CommandBuffer& commandBuffer, const Pipeline& pipeline) const { - VkDescriptorSet descriptorSetHandle = this->handle(); - vkCmdBindDescriptorSets(commandBuffer.handle(), - VK_PIPELINE_BIND_POINT_COMPUTE, pipeline.getLayout(), - 0, 1, &descriptorSetHandle, 0, nullptr); -} - -// updater class - -DescriptorSetUpdateBuilder& DescriptorSetUpdateBuilder::add(VkDescriptorType type, const Image& image) { - size_t* idx{type == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE ? &this->outputIdx : &this->inputIdx}; - this->entries.push_back({ - .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, - .dstSet = this->descriptorSet->handle(), - .dstBinding = static_cast(*idx), - .descriptorCount = 1, - .descriptorType = type, - .pImageInfo = new VkDescriptorImageInfo { - .imageView = image.getView(), - .imageLayout = VK_IMAGE_LAYOUT_GENERAL - }, - .pBufferInfo = nullptr - }); - (*idx)++; - return *this; -} - -DescriptorSetUpdateBuilder& DescriptorSetUpdateBuilder::add(VkDescriptorType type, const Sampler& sampler) { - this->entries.push_back({ - .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, - .dstSet = this->descriptorSet->handle(), - .dstBinding = static_cast(this->samplerIdx++), - .descriptorCount = 1, - .descriptorType = type, - .pImageInfo = new VkDescriptorImageInfo { - .sampler = sampler.handle(), - }, - .pBufferInfo = nullptr - }); - return *this; -} - -DescriptorSetUpdateBuilder& DescriptorSetUpdateBuilder::add(VkDescriptorType type, const Buffer& buffer) { - this->entries.push_back({ - .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, - .dstSet = this->descriptorSet->handle(), - .dstBinding = static_cast(this->bufferIdx++), - .descriptorCount = 1, - .descriptorType = type, - .pImageInfo = nullptr, - .pBufferInfo = new VkDescriptorBufferInfo { - .buffer = buffer.handle(), - .range = buffer.getSize() - } - }); - return *this; -} - -DescriptorSetUpdateBuilder& DescriptorSetUpdateBuilder::add(VkDescriptorType type) { - size_t* idx{}; - switch (type) { - case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE: - idx = &this->inputIdx; - break; - case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: - idx = &this->outputIdx; - break; - case VK_DESCRIPTOR_TYPE_SAMPLER: - idx = &this->samplerIdx; - break; - case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER: - idx = &this->bufferIdx; - break; - default: - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unsupported descriptor type"); - } - this->entries.push_back({ - .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, - .dstSet = this->descriptorSet->handle(), - .dstBinding = static_cast(*idx), - .descriptorCount = 1, - .descriptorType = type, - .pImageInfo = new VkDescriptorImageInfo { - }, - .pBufferInfo = nullptr - }); - (*idx)++; - return *this; -} - -void DescriptorSetUpdateBuilder::build() { - vkUpdateDescriptorSets(this->device->handle(), - static_cast(this->entries.size()), - this->entries.data(), 0, nullptr); - - // NOLINTBEGIN - for (const auto& entry : this->entries) { - delete entry.pImageInfo; - delete entry.pBufferInfo; - } - // NOLINTEND -} diff --git a/framegen/src/core/device.cpp b/framegen/src/core/device.cpp deleted file mode 100644 index acb802b..0000000 --- a/framegen/src/core/device.cpp +++ /dev/null @@ -1,134 +0,0 @@ -#include -#include -#include - -#include "core/device.hpp" -#include "core/instance.hpp" -#include "common/exception.hpp" - -#include -#include -#include -#include - -using namespace LSFG::Core; - -const std::vector requiredExtensions = { - "VK_KHR_external_memory_fd", - "VK_KHR_external_semaphore_fd", - "VK_EXT_robustness2" -}; - -Device::Device(const Instance& instance, uint64_t deviceUUID, bool forceDisableFp16) { - // get all physical devices - uint32_t deviceCount{}; - auto res = vkEnumeratePhysicalDevices(instance.handle(), &deviceCount, nullptr); - if (res != VK_SUCCESS || deviceCount == 0) - throw LSFG::vulkan_error(res, "Failed to enumerate physical devices"); - - std::vector devices(deviceCount); - res = vkEnumeratePhysicalDevices(instance.handle(), &deviceCount, devices.data()); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to get physical devices"); - - // get device by uuid - std::optional physicalDevice; - for (const auto& device : devices) { - VkPhysicalDeviceProperties properties; - vkGetPhysicalDeviceProperties(device, &properties); - - const uint64_t uuid = - static_cast(properties.vendorID) << 32 | properties.deviceID; - if (deviceUUID == uuid || deviceUUID == 0x1463ABAC) { - physicalDevice = device; - break; - } - } - if (!physicalDevice) - throw LSFG::vulkan_error(VK_ERROR_INITIALIZATION_FAILED, - "Could not find physical device with UUID"); - - // find queue family indices - uint32_t familyCount{}; - vkGetPhysicalDeviceQueueFamilyProperties(*physicalDevice, &familyCount, nullptr); - - std::vector queueFamilies(familyCount); - vkGetPhysicalDeviceQueueFamilyProperties(*physicalDevice, &familyCount, queueFamilies.data()); - - std::optional computeFamilyIdx; - for (uint32_t i = 0; i < familyCount; ++i) { - if (queueFamilies[i].queueFlags & VK_QUEUE_COMPUTE_BIT) - computeFamilyIdx = i; - } - if (!computeFamilyIdx) - throw LSFG::vulkan_error(VK_ERROR_INITIALIZATION_FAILED, "No compute queue family found"); - - // check if physical device supports float16 - VkPhysicalDeviceVulkan12Features supported12Features{ - .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_FEATURES - }; - VkPhysicalDeviceFeatures2 supportedFeatures{ - .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2, - .pNext = &supported12Features - }; - vkGetPhysicalDeviceFeatures2(*physicalDevice, &supportedFeatures); - this->supportsFP16 = !forceDisableFp16 && supported12Features.shaderFloat16; - if (this->supportsFP16) - std::cerr << "lsfg-vk: Using FP16 acceleration" << '\n'; - else if (!forceDisableFp16) - std::cerr << "lsfg-vk: FP16 acceleration not supported, using FP32" << '\n'; - - // create logical device - const float queuePriority{1.0F}; // highest priority - VkPhysicalDeviceRobustness2FeaturesEXT robustness2{ - .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ROBUSTNESS_2_FEATURES_EXT, - .nullDescriptor = VK_TRUE - }; - VkPhysicalDeviceVulkan13Features features13{ - .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_3_FEATURES, - .pNext = &robustness2, - .synchronization2 = VK_TRUE - }; - const VkPhysicalDeviceVulkan12Features features12{ - .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_FEATURES, - .pNext = &features13, - .shaderFloat16 = this->supportsFP16, - .timelineSemaphore = VK_TRUE, - .vulkanMemoryModel = VK_TRUE - }; - const VkDeviceQueueCreateInfo computeQueueDesc{ - .sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO, - .queueFamilyIndex = *computeFamilyIdx, - .queueCount = 1, - .pQueuePriorities = &queuePriority - }; - const VkDeviceCreateInfo deviceCreateInfo{ - .sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO, - .pNext = &features12, - .queueCreateInfoCount = 1, - .pQueueCreateInfos = &computeQueueDesc, - .enabledExtensionCount = static_cast(requiredExtensions.size()), - .ppEnabledExtensionNames = requiredExtensions.data() - }; - VkDevice deviceHandle{}; - res = vkCreateDevice(*physicalDevice, &deviceCreateInfo, nullptr, &deviceHandle); - if (res != VK_SUCCESS | deviceHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create logical device"); - - volkLoadDevice(deviceHandle); - - // get compute queue - VkQueue queueHandle{}; - vkGetDeviceQueue(deviceHandle, *computeFamilyIdx, 0, &queueHandle); - - // store in shared ptr - this->computeQueue = queueHandle; - this->computeFamilyIdx = *computeFamilyIdx; - this->physicalDevice = *physicalDevice; - this->device = std::shared_ptr( - new VkDevice(deviceHandle), - [](VkDevice* device) { - vkDestroyDevice(*device, nullptr); - } - ); -} diff --git a/framegen/src/core/fence.cpp b/framegen/src/core/fence.cpp deleted file mode 100644 index 0284f08..0000000 --- a/framegen/src/core/fence.cpp +++ /dev/null @@ -1,46 +0,0 @@ -#include -#include - -#include "core/fence.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include - -using namespace LSFG::Core; - -Fence::Fence(const Core::Device& device) { - // create fence - const VkFenceCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO - }; - VkFence fenceHandle{}; - auto res = vkCreateFence(device.handle(), &desc, nullptr, &fenceHandle); - if (res != VK_SUCCESS || fenceHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create fence"); - - // store fence in shared ptr - this->fence = std::shared_ptr( - new VkFence(fenceHandle), - [dev = device.handle()](VkFence* fenceHandle) { - vkDestroyFence(dev, *fenceHandle, nullptr); - } - ); -} - -void Fence::reset(const Core::Device& device) const { - VkFence fenceHandle = this->handle(); - auto res = vkResetFences(device.handle(), 1, &fenceHandle); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to reset fence"); -} - -bool Fence::wait(const Core::Device& device, uint64_t timeout) const { - VkFence fenceHandle = this->handle(); - auto res = vkWaitForFences(device.handle(), 1, &fenceHandle, VK_TRUE, timeout); - if (res != VK_SUCCESS && res != VK_TIMEOUT) - throw LSFG::vulkan_error(res, "Unable to wait for fence"); - - return res == VK_SUCCESS; -} diff --git a/framegen/src/core/image.cpp b/framegen/src/core/image.cpp deleted file mode 100644 index b9c4f17..0000000 --- a/framegen/src/core/image.cpp +++ /dev/null @@ -1,375 +0,0 @@ -#include -#include - -#include "core/image.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include -#include - -using namespace LSFG::Core; - -Image::Image(const Core::Device& device, VkExtent2D extent, VkFormat format, - VkImageUsageFlags usage, VkImageAspectFlags aspectFlags) - : extent(extent), format(format), aspectFlags(aspectFlags) { - // create image - const VkImageCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, - .imageType = VK_IMAGE_TYPE_2D, - .format = format, - .extent = { - .width = extent.width, - .height = extent.height, - .depth = 1 - }, - .mipLevels = 1, - .arrayLayers = 1, - .samples = VK_SAMPLE_COUNT_1_BIT, - .usage = usage, - .sharingMode = VK_SHARING_MODE_EXCLUSIVE - }; - VkImage imageHandle{}; - auto res = vkCreateImage(device.handle(), &desc, nullptr, &imageHandle); - if (res != VK_SUCCESS || imageHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create Vulkan image"); - - // find memory type - VkPhysicalDeviceMemoryProperties memProps; - vkGetPhysicalDeviceMemoryProperties(device.getPhysicalDevice(), &memProps); - - VkMemoryRequirements memReqs; - vkGetImageMemoryRequirements(device.handle(), imageHandle, &memReqs); - -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" - std::optional memType{}; - for (uint32_t i = 0; i < memProps.memoryTypeCount; ++i) { - if ((memReqs.memoryTypeBits & (1 << i)) && // NOLINTBEGIN - (memProps.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT)) { - memType.emplace(i); - break; - } // NOLINTEND - } - if (!memType.has_value()) - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unable to find memory type for image"); -#pragma clang diagnostic pop - - // allocate and bind memory - const VkMemoryAllocateInfo allocInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, - .allocationSize = memReqs.size, - .memoryTypeIndex = memType.value() - }; - VkDeviceMemory memoryHandle{}; - res = vkAllocateMemory(device.handle(), &allocInfo, nullptr, &memoryHandle); - if (res != VK_SUCCESS || memoryHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to allocate memory for Vulkan image"); - - res = vkBindImageMemory(device.handle(), imageHandle, memoryHandle, 0); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to bind memory to Vulkan image"); - - // create image view - const VkImageViewCreateInfo viewDesc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO, - .image = imageHandle, - .viewType = VK_IMAGE_VIEW_TYPE_2D, - .format = format, - .components = { - .r = VK_COMPONENT_SWIZZLE_IDENTITY, - .g = VK_COMPONENT_SWIZZLE_IDENTITY, - .b = VK_COMPONENT_SWIZZLE_IDENTITY, - .a = VK_COMPONENT_SWIZZLE_IDENTITY - }, - .subresourceRange = { - .aspectMask = aspectFlags, - .levelCount = 1, - .layerCount = 1 - } - }; - - VkImageView viewHandle{}; - res = vkCreateImageView(device.handle(), &viewDesc, nullptr, &viewHandle); - if (res != VK_SUCCESS || viewHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create image view"); - - // store objects in shared ptr - this->layout = std::make_shared(VK_IMAGE_LAYOUT_UNDEFINED); - this->image = std::shared_ptr( - new VkImage(imageHandle), - [dev = device.handle()](VkImage* img) { - vkDestroyImage(dev, *img, nullptr); - } - ); - this->memory = std::shared_ptr( - new VkDeviceMemory(memoryHandle), - [dev = device.handle()](VkDeviceMemory* mem) { - vkFreeMemory(dev, *mem, nullptr); - } - ); - this->view = std::shared_ptr( - new VkImageView(viewHandle), - [dev = device.handle()](VkImageView* imgView) { - vkDestroyImageView(dev, *imgView, nullptr); - } - ); -} - -// shared memory constructor - -Image::Image(const Core::Device& device, VkExtent2D extent, VkFormat format, - VkImageUsageFlags usage, VkImageAspectFlags aspectFlags, int fd) - : extent(extent), format(format), aspectFlags(aspectFlags) { - // create image - const VkExternalMemoryImageCreateInfo externalInfo{ - .sType = VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO, - .handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR - }; - const VkImageCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, - .pNext = &externalInfo, - .imageType = VK_IMAGE_TYPE_2D, - .format = format, - .extent = { - .width = extent.width, - .height = extent.height, - .depth = 1 - }, - .mipLevels = 1, - .arrayLayers = 1, - .samples = VK_SAMPLE_COUNT_1_BIT, - .usage = usage, - .sharingMode = VK_SHARING_MODE_EXCLUSIVE - }; - VkImage imageHandle{}; - auto res = vkCreateImage(device.handle(), &desc, nullptr, &imageHandle); - if (res != VK_SUCCESS || imageHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create Vulkan image"); - - // find memory type - VkPhysicalDeviceMemoryProperties memProps; - vkGetPhysicalDeviceMemoryProperties(device.getPhysicalDevice(), &memProps); - - VkMemoryRequirements memReqs; - vkGetImageMemoryRequirements(device.handle(), imageHandle, &memReqs); - -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" - std::optional memType{}; - for (uint32_t i = 0; i < memProps.memoryTypeCount; ++i) { - if ((memReqs.memoryTypeBits & (1 << i)) && // NOLINTBEGIN - (memProps.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT)) { - memType.emplace(i); - break; - } // NOLINTEND - } - if (!memType.has_value()) - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unable to find memory type for image"); -#pragma clang diagnostic pop - - // ~~allocate~~ and bind memory - const VkMemoryDedicatedAllocateInfoKHR dedicatedInfo2{ - .sType = VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO_KHR, - .image = imageHandle, - }; - const VkImportMemoryFdInfoKHR importInfo{ - .sType = VK_STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR, - .pNext = &dedicatedInfo2, - .handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR, - .fd = fd // closes the fd - }; - const VkMemoryAllocateInfo allocInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, - .pNext = fd == -1 ? nullptr : &importInfo, - .allocationSize = memReqs.size, - .memoryTypeIndex = memType.value() - }; - VkDeviceMemory memoryHandle{}; - res = vkAllocateMemory(device.handle(), &allocInfo, nullptr, &memoryHandle); - if (res != VK_SUCCESS || memoryHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to allocate memory for Vulkan image"); - - res = vkBindImageMemory(device.handle(), imageHandle, memoryHandle, 0); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to bind memory to Vulkan image"); - - // create image view - const VkImageViewCreateInfo viewDesc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO, - .image = imageHandle, - .viewType = VK_IMAGE_VIEW_TYPE_2D, - .format = format, - .components = { - .r = VK_COMPONENT_SWIZZLE_IDENTITY, - .g = VK_COMPONENT_SWIZZLE_IDENTITY, - .b = VK_COMPONENT_SWIZZLE_IDENTITY, - .a = VK_COMPONENT_SWIZZLE_IDENTITY - }, - .subresourceRange = { - .aspectMask = aspectFlags, - .levelCount = 1, - .layerCount = 1 - } - }; - - VkImageView viewHandle{}; - res = vkCreateImageView(device.handle(), &viewDesc, nullptr, &viewHandle); - if (res != VK_SUCCESS || viewHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create image view"); - - // store objects in shared ptr - this->layout = std::make_shared(VK_IMAGE_LAYOUT_UNDEFINED); - this->image = std::shared_ptr( - new VkImage(imageHandle), - [dev = device.handle()](VkImage* img) { - vkDestroyImage(dev, *img, nullptr); - } - ); - this->memory = std::shared_ptr( - new VkDeviceMemory(memoryHandle), - [dev = device.handle()](VkDeviceMemory* mem) { - vkFreeMemory(dev, *mem, nullptr); - } - ); - this->view = std::shared_ptr( - new VkImageView(viewHandle), - [dev = device.handle()](VkImageView* imgView) { - vkDestroyImageView(dev, *imgView, nullptr); - } - ); -} - -// second shared memory constructors - -Image::Image(const Core::Device& device, VkExtent2D extent, VkFormat format, - VkImageUsageFlags usage, VkImageAspectFlags aspectFlags, int* fd) - : extent(extent), format(format), aspectFlags(aspectFlags) { - // create image - const VkExternalMemoryImageCreateInfo externalInfo{ - .sType = VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO, - .handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR - }; - const VkImageCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, - .pNext = &externalInfo, - .imageType = VK_IMAGE_TYPE_2D, - .format = format, - .extent = { - .width = extent.width, - .height = extent.height, - .depth = 1 - }, - .mipLevels = 1, - .arrayLayers = 1, - .samples = VK_SAMPLE_COUNT_1_BIT, - .usage = usage, - .sharingMode = VK_SHARING_MODE_EXCLUSIVE - }; - VkImage imageHandle{}; - auto res = vkCreateImage(device.handle(), &desc, nullptr, &imageHandle); - if (res != VK_SUCCESS || imageHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create Vulkan image"); - - // find memory type - VkPhysicalDeviceMemoryProperties memProps; - vkGetPhysicalDeviceMemoryProperties(device.getPhysicalDevice(), &memProps); - - VkMemoryRequirements memReqs; - vkGetImageMemoryRequirements(device.handle(), imageHandle, &memReqs); - -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" - std::optional memType{}; - for (uint32_t i = 0; i < memProps.memoryTypeCount; ++i) { - if ((memReqs.memoryTypeBits & (1 << i)) && // NOLINTBEGIN - (memProps.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT)) { - memType.emplace(i); - break; - } // NOLINTEND - } - if (!memType.has_value()) - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unable to find memory type for image"); -#pragma clang diagnostic pop - - // allocate and bind memory - const VkMemoryDedicatedAllocateInfoKHR dedicatedInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO_KHR, - .image = imageHandle, - }; - const VkExportMemoryAllocateInfo exportInfo{ - .sType = VK_STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO, - .pNext = &dedicatedInfo, - .handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR - }; - const VkMemoryAllocateInfo allocInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, - .pNext = &exportInfo, - .allocationSize = memReqs.size, - .memoryTypeIndex = memType.value() - }; - VkDeviceMemory memoryHandle{}; - res = vkAllocateMemory(device.handle(), &allocInfo, nullptr, &memoryHandle); - if (res != VK_SUCCESS || memoryHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to allocate memory for Vulkan image"); - - res = vkBindImageMemory(device.handle(), imageHandle, memoryHandle, 0); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to bind memory to Vulkan image"); - - // obtain the sharing fd - const VkMemoryGetFdInfoKHR fdInfo{ - .sType = VK_STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR, - .memory = memoryHandle, - .handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR, - }; - res = vkGetMemoryFdKHR(device.handle(), &fdInfo, fd); - if (res != VK_SUCCESS || *fd < 0) - throw LSFG::vulkan_error(res, "Failed to obtain sharing fd for Vulkan image"); - - // create image view - const VkImageViewCreateInfo viewDesc{ - .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO, - .image = imageHandle, - .viewType = VK_IMAGE_VIEW_TYPE_2D, - .format = format, - .components = { - .r = VK_COMPONENT_SWIZZLE_IDENTITY, - .g = VK_COMPONENT_SWIZZLE_IDENTITY, - .b = VK_COMPONENT_SWIZZLE_IDENTITY, - .a = VK_COMPONENT_SWIZZLE_IDENTITY - }, - .subresourceRange = { - .aspectMask = aspectFlags, - .levelCount = 1, - .layerCount = 1 - } - }; - - VkImageView viewHandle{}; - res = vkCreateImageView(device.handle(), &viewDesc, nullptr, &viewHandle); - if (res != VK_SUCCESS || viewHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Failed to create image view"); - - // store objects in shared ptr - this->layout = std::make_shared(VK_IMAGE_LAYOUT_UNDEFINED); - this->image = std::shared_ptr( - new VkImage(imageHandle), - [dev = device.handle()](VkImage* img) { - vkDestroyImage(dev, *img, nullptr); - } - ); - this->memory = std::shared_ptr( - new VkDeviceMemory(memoryHandle), - [dev = device.handle()](VkDeviceMemory* mem) { - vkFreeMemory(dev, *mem, nullptr); - } - ); - this->view = std::shared_ptr( - new VkImageView(viewHandle), - [dev = device.handle()](VkImageView* imgView) { - vkDestroyImageView(dev, *imgView, nullptr); - } - ); -} diff --git a/framegen/src/core/instance.cpp b/framegen/src/core/instance.cpp deleted file mode 100644 index 981e634..0000000 --- a/framegen/src/core/instance.cpp +++ /dev/null @@ -1,49 +0,0 @@ -#include -#include - -#include "core/instance.hpp" -#include "common/exception.hpp" - -#include -#include -#include - -using namespace LSFG::Core; - -const std::vector requiredExtensions = { - -}; - -Instance::Instance() { - volkInitialize(); - - // create Vulkan instance - const VkApplicationInfo appInfo{ - .sType = VK_STRUCTURE_TYPE_APPLICATION_INFO, - .pApplicationName = "lsfg-vk-base", - .applicationVersion = VK_MAKE_VERSION(0, 0, 1), - .pEngineName = "lsfg-vk-base", - .engineVersion = VK_MAKE_VERSION(0, 0, 1), - .apiVersion = VK_API_VERSION_1_3 - }; - const VkInstanceCreateInfo createInfo{ - .sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO, - .pApplicationInfo = &appInfo, - .enabledExtensionCount = static_cast(requiredExtensions.size()), - .ppEnabledExtensionNames = requiredExtensions.data() - }; - VkInstance instanceHandle{}; - auto res = vkCreateInstance(&createInfo, nullptr, &instanceHandle); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Failed to create Vulkan instance"); - - volkLoadInstance(instanceHandle); - - // store in shared ptr - this->instance = std::shared_ptr( - new VkInstance(instanceHandle), - [](VkInstance* instance) { - vkDestroyInstance(*instance, nullptr); - } - ); -} diff --git a/framegen/src/core/pipeline.cpp b/framegen/src/core/pipeline.cpp deleted file mode 100644 index c2a6375..0000000 --- a/framegen/src/core/pipeline.cpp +++ /dev/null @@ -1,62 +0,0 @@ -#include -#include - -#include "core/pipeline.hpp" -#include "core/device.hpp" -#include "core/shadermodule.hpp" -#include "core/commandbuffer.hpp" -#include "common/exception.hpp" - -#include - -using namespace LSFG::Core; - -Pipeline::Pipeline(const Core::Device& device, const ShaderModule& shader) { - // create pipeline layout - VkDescriptorSetLayout shaderLayout = shader.getLayout(); - const VkPipelineLayoutCreateInfo layoutDesc{ - .sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO, - .setLayoutCount = 1, - .pSetLayouts = &shaderLayout, - }; - VkPipelineLayout layoutHandle{}; - auto res = vkCreatePipelineLayout(device.handle(), &layoutDesc, nullptr, &layoutHandle); - if (res != VK_SUCCESS || !layoutHandle) - throw LSFG::vulkan_error(res, "Failed to create pipeline layout"); - - // create pipeline - const VkPipelineShaderStageCreateInfo shaderStageInfo{ - .sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO, - .stage = VK_SHADER_STAGE_COMPUTE_BIT, - .module = shader.handle(), - .pName = "main", - }; - const VkComputePipelineCreateInfo pipelineDesc{ - .sType = VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO, - .stage = shaderStageInfo, - .layout = layoutHandle, - }; - VkPipeline pipelineHandle{}; - res = vkCreateComputePipelines(device.handle(), - VK_NULL_HANDLE, 1, &pipelineDesc, nullptr, &pipelineHandle); - if (res != VK_SUCCESS || !pipelineHandle) - throw LSFG::vulkan_error(res, "Failed to create compute pipeline"); - - // store layout and pipeline in shared ptr - this->layout = std::shared_ptr( - new VkPipelineLayout(layoutHandle), - [dev = device.handle()](VkPipelineLayout* layout) { - vkDestroyPipelineLayout(dev, *layout, nullptr); - } - ); - this->pipeline = std::shared_ptr( - new VkPipeline(pipelineHandle), - [dev = device.handle()](VkPipeline* pipeline) { - vkDestroyPipeline(dev, *pipeline, nullptr); - } - ); -} - -void Pipeline::bind(const CommandBuffer& commandBuffer) const { - vkCmdBindPipeline(commandBuffer.handle(), VK_PIPELINE_BIND_POINT_COMPUTE, *this->pipeline); -} diff --git a/framegen/src/core/sampler.cpp b/framegen/src/core/sampler.cpp deleted file mode 100644 index 2e8f4eb..0000000 --- a/framegen/src/core/sampler.cpp +++ /dev/null @@ -1,43 +0,0 @@ -#include -#include - -#include "core/sampler.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include - -using namespace LSFG::Core; - -Sampler::Sampler(const Core::Device& device, - VkSamplerAddressMode mode, - VkCompareOp compare, - bool isWhite) { - // create sampler - const VkSamplerCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO, - .magFilter = VK_FILTER_LINEAR, - .minFilter = VK_FILTER_LINEAR, - .mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR, - .addressModeU = mode, - .addressModeV = mode, - .addressModeW = mode, - .compareOp = compare, - .maxLod = VK_LOD_CLAMP_NONE, - .borderColor = - isWhite ? VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE - : VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK - }; - VkSampler samplerHandle{}; - auto res = vkCreateSampler(device.handle(), &desc, nullptr, &samplerHandle); - if (res != VK_SUCCESS || samplerHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create sampler"); - - // store sampler in shared ptr - this->sampler = std::shared_ptr( - new VkSampler(samplerHandle), - [dev = device.handle()](VkSampler* samplerHandle) { - vkDestroySampler(dev, *samplerHandle, nullptr); - } - ); -} diff --git a/framegen/src/core/semaphore.cpp b/framegen/src/core/semaphore.cpp deleted file mode 100644 index 102898a..0000000 --- a/framegen/src/core/semaphore.cpp +++ /dev/null @@ -1,110 +0,0 @@ -#include -#include - -#include "core/semaphore.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include -#include -#include - -using namespace LSFG::Core; - -Semaphore::Semaphore(const Core::Device& device, std::optional initial) { - // create semaphore - const VkSemaphoreTypeCreateInfo typeInfo{ - .sType = VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO, - .semaphoreType = VK_SEMAPHORE_TYPE_TIMELINE, - .initialValue = initial.value_or(0) - }; - const VkSemaphoreCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, - .pNext = initial.has_value() ? &typeInfo : nullptr, - }; - VkSemaphore semaphoreHandle{}; - auto res = vkCreateSemaphore(device.handle(), &desc, nullptr, &semaphoreHandle); - if (res != VK_SUCCESS || semaphoreHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create semaphore"); - - // store semaphore in shared ptr - this->isTimeline = initial.has_value(); - this->semaphore = std::shared_ptr( - new VkSemaphore(semaphoreHandle), - [dev = device.handle()](VkSemaphore* semaphoreHandle) { - vkDestroySemaphore(dev, *semaphoreHandle, nullptr); - } - ); -} - -Semaphore::Semaphore(const Core::Device& device, int fd) { - // create semaphore - const VkExportSemaphoreCreateInfo exportInfo{ - .sType = VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO, - .handleTypes = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT - }; - const VkSemaphoreCreateInfo desc{ - .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, - .pNext = &exportInfo - }; - VkSemaphore semaphoreHandle{}; - auto res = vkCreateSemaphore(device.handle(), &desc, nullptr, &semaphoreHandle); - if (res != VK_SUCCESS || semaphoreHandle == VK_NULL_HANDLE) - throw LSFG::vulkan_error(res, "Unable to create semaphore"); - - // import semaphore from fd - auto vkImportSemaphoreFdKHR = reinterpret_cast( - vkGetDeviceProcAddr(device.handle(), "vkImportSemaphoreFdKHR")); - - const VkImportSemaphoreFdInfoKHR importInfo{ - .sType = VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR, - .semaphore = semaphoreHandle, - .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, - .fd = fd // closes the fd - }; - res = vkImportSemaphoreFdKHR(device.handle(), &importInfo); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to import semaphore from fd"); - - // store semaphore in shared ptr - this->isTimeline = false; - this->semaphore = std::shared_ptr( - new VkSemaphore(semaphoreHandle), - [dev = device.handle()](VkSemaphore* semaphoreHandle) { - vkDestroySemaphore(dev, *semaphoreHandle, nullptr); - } - ); -} - -void Semaphore::signal(const Core::Device& device, uint64_t value) const { - if (!this->isTimeline) - throw std::logic_error("Invalid timeline semaphore"); - - const VkSemaphoreSignalInfo signalInfo{ - .sType = VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO, - .semaphore = this->handle(), - .value = value - }; - auto res = vkSignalSemaphore(device.handle(), &signalInfo); - if (res != VK_SUCCESS) - throw LSFG::vulkan_error(res, "Unable to signal semaphore"); -} - -bool Semaphore::wait(const Core::Device& device, uint64_t value, uint64_t timeout) const { - if (!this->isTimeline) - throw std::logic_error("Invalid timeline semaphore"); - - VkSemaphore semaphore = this->handle(); - const VkSemaphoreWaitInfo waitInfo{ - .sType = VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO, - .semaphoreCount = 1, - .pSemaphores = &semaphore, - .pValues = &value - }; - auto res = vkWaitSemaphores(device.handle(), &waitInfo, timeout); - if (res != VK_SUCCESS && res != VK_TIMEOUT) - throw LSFG::vulkan_error(res, "Unable to wait for semaphore"); - - return res == VK_SUCCESS; -} diff --git a/framegen/src/core/shadermodule.cpp b/framegen/src/core/shadermodule.cpp deleted file mode 100644 index e2135e9..0000000 --- a/framegen/src/core/shadermodule.cpp +++ /dev/null @@ -1,89 +0,0 @@ -#include -#include - -#include "core/shadermodule.hpp" -#include "core/device.hpp" -#include "common/exception.hpp" - -#include -#include -#include -#include -#include - -using namespace LSFG::Core; - -ShaderModule::ShaderModule(const Core::Device& device, const std::vector& code, - const std::vector>& descriptorTypes) { - // create shader module - const uint8_t* data_ptr = code.data(); - const VkShaderModuleCreateInfo createInfo{ - .sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO, - .codeSize = code.size(), - .pCode = reinterpret_cast(data_ptr) - }; - VkShaderModule shaderModuleHandle{}; - auto res = vkCreateShaderModule(device.handle(), &createInfo, nullptr, &shaderModuleHandle); - if (res != VK_SUCCESS || !shaderModuleHandle) - throw LSFG::vulkan_error(res, "Failed to create shader module"); - - // create descriptor set layout - std::vector layoutBindings; - size_t bufferIdx{0}; - size_t samplerIdx{16}; - size_t inputIdx{32}; - size_t outputIdx{48}; - for (const auto &[count, type] : descriptorTypes) - for (size_t i = 0; i < count; i++) { - size_t* bindIdx{}; - switch (type) { - case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER: - bindIdx = &bufferIdx; - break; - case VK_DESCRIPTOR_TYPE_SAMPLER: - bindIdx = &samplerIdx; - break; - case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE: - bindIdx = &inputIdx; - break; - case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: - bindIdx = &outputIdx; - break; - default: - throw LSFG::vulkan_error(VK_ERROR_UNKNOWN, "Unsupported descriptor type"); - } - - layoutBindings.emplace_back(VkDescriptorSetLayoutBinding { - .binding = static_cast(*bindIdx), - .descriptorType = type, - .descriptorCount = 1, - .stageFlags = VK_SHADER_STAGE_COMPUTE_BIT - }); - - (*bindIdx)++; - } - - const VkDescriptorSetLayoutCreateInfo layoutDesc{ - .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO, - .bindingCount = static_cast(layoutBindings.size()), - .pBindings = layoutBindings.data() - }; - VkDescriptorSetLayout descriptorSetLayout{}; - res = vkCreateDescriptorSetLayout(device.handle(), &layoutDesc, nullptr, &descriptorSetLayout); - if (res != VK_SUCCESS || !descriptorSetLayout) - throw LSFG::vulkan_error(res, "Failed to create descriptor set layout"); - - // store module and layout in shared ptr - this->shaderModule = std::shared_ptr( - new VkShaderModule(shaderModuleHandle), - [dev = device.handle()](VkShaderModule* shaderModuleHandle) { - vkDestroyShaderModule(dev, *shaderModuleHandle, nullptr); - } - ); - this->descriptorSetLayout = std::shared_ptr( - new VkDescriptorSetLayout(descriptorSetLayout), - [dev = device.handle()](VkDescriptorSetLayout* layout) { - vkDestroyDescriptorSetLayout(dev, *layout, nullptr); - } - ); -} diff --git a/.clang-tidy b/lsfg-vk-common/.clang-tidy similarity index 85% rename from .clang-tidy rename to lsfg-vk-common/.clang-tidy index b4010e0..9567cc4 100644 --- a/.clang-tidy +++ b/lsfg-vk-common/.clang-tidy @@ -22,9 +22,8 @@ Checks: # configure cppcoreguidelines - "cppcoreguidelines-*" - "-cppcoreguidelines-avoid-magic-numbers" -- "-cppcoreguidelines-pro-type-reinterpret-cast" # allows reinterpret_cast -- "-cppcoreguidelines-avoid-non-const-global-variables" -- "-cppcoreguidelines-pro-type-union-access" +- "-cppcoreguidelines-pro-type-reinterpret-cast" +- "-cppcoreguidelines-macro-usage" # disable slow and pointless checks - "-modernize-use-std-numbers" - "-modernize-type-traits" diff --git a/lsfg-vk-common/CMakeLists.txt b/lsfg-vk-common/CMakeLists.txt new file mode 100644 index 0000000..5ae6514 --- /dev/null +++ b/lsfg-vk-common/CMakeLists.txt @@ -0,0 +1,19 @@ +set(COMMON_SOURCES + "src/helpers/errors.cpp" + "src/vulkan/buffer.cpp" + "src/vulkan/image.cpp" + "src/vulkan/sampler.cpp" + "src/vulkan/fence.cpp" + "src/vulkan/semaphore.cpp" + "src/vulkan/timeline_semaphore.cpp" + "src/vulkan/command_buffer.cpp" + "src/vulkan/descriptor_set.cpp" + "src/vulkan/shader.cpp" + "src/vulkan/vulkan.cpp") + +add_library(lsfg-vk-common STATIC ${COMMON_SOURCES}) + +target_include_directories(lsfg-vk-common + PUBLIC include) +target_link_libraries(lsfg-vk-common + vulkan) diff --git a/lsfg-vk-common/include/lsfg-vk-common/helpers/errors.hpp b/lsfg-vk-common/include/lsfg-vk-common/helpers/errors.hpp new file mode 100644 index 0000000..fc671b5 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/helpers/errors.hpp @@ -0,0 +1,30 @@ +#pragma once + +#include +#include + +#include + +namespace ls { + /// simple vulkan error type + class vulkan_error : public std::runtime_error { + public: + /// construct a vulkan_error + /// @param result the Vulkan result code + /// @param msg the error message + explicit vulkan_error(VkResult result, const std::string& msg) + : std::runtime_error(msg + " (error " + std::to_string(result) + ")"), + result(result) {} + + /// construct a vulkan_error + /// @param msg the error message + explicit vulkan_error(const std::string& msg) + : vulkan_error(VK_ERROR_INITIALIZATION_FAILED, msg) {} + + /// get the Vulkan result code associated with this error + [[nodiscard]] virtual VkResult error() const; + + private: + VkResult result; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/helpers/pointers.hpp b/lsfg-vk-common/include/lsfg-vk-common/helpers/pointers.hpp new file mode 100644 index 0000000..c11372e --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/helpers/pointers.hpp @@ -0,0 +1,76 @@ +#pragma once + +#include +#include + +namespace ls { + /// helper alias for std::reference_wrapper + template + using R = std::reference_wrapper; + + /// simplified alternative to std::optional + template + class owned_ptr { + public: + /// default constructor + owned_ptr() = default; + + /// construct from raw pointer + /// @param ptr raw pointer to own, must be valid for object lifetime + /// @param deleter custom deleter function, called only on owned instances + explicit owned_ptr(T* ptr, std::function deleter) + : ptr(ptr), deleter(std::move(deleter)) {} + + /// get reference to owned object + /// @throws std::runtime_error if no object is owned + T& get() const { + if (!ptr) + throw std::runtime_error("owned_ptr: no object owned"); + return *ptr; + } + + // operator overloads + T& operator*() const { return this->get(); } + T* operator->() const { return &this->get(); } + + // moveable + owned_ptr(owned_ptr&& other) noexcept : ptr(other.ptr) { + other.ptr = nullptr; + } + owned_ptr& operator=(owned_ptr&& other) noexcept { + if (this != &other) { + ptr = other.ptr; + other.ptr = nullptr; + } + + return *this; + } + + // non-copyable + owned_ptr(const owned_ptr&) = delete; + owned_ptr& operator=(const owned_ptr&) = delete; + + // destructor + ~owned_ptr() { + if (ptr && deleter) { + deleter(*ptr); + delete ptr; + } + } + private: + T* ptr{}; + std::function deleter{}; + }; + + /// turn a vector of images into a vector of references + template + std::vector> refs(const std::vector& images) { + std::vector> result; + result.reserve(images.size()); + + for (const auto& img : images) + result.push_back(std::ref(img)); + + return result; + } +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/buffer.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/buffer.hpp new file mode 100644 index 0000000..69f13dc --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/buffer.hpp @@ -0,0 +1,40 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +#include + +namespace vk { + /// vulkan buffer + class Buffer { + public: + /// create a buffer + /// @param vk the vulkan instance + /// @param data initial data uploaded to the buffer + /// @throws ls::vulkan_error on failure + template + Buffer(const vk::Vulkan& vk, const T& data) + : Buffer(vk, reinterpret_cast(&data), sizeof(T)) {} + + /// create a buffer + /// @param vk the vulkan instance + /// @param data initial data uploaded to the buffer + /// @param size size of the buffer in bytes + /// @throws ls::vulkan_error on failure + Buffer(const vk::Vulkan& vk, const void* data, size_t size); + + /// get the buffer handle + /// @return the buffer handle + [[nodiscard]] const auto& handle() const { return this->buffer.get(); } + /// get the size of the buffer + /// @return the size of the buffer in bytes + [[nodiscard]] size_t length() const { return this->size; } + private: + ls::owned_ptr buffer; + ls::owned_ptr memory; + size_t size; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/command_buffer.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/command_buffer.hpp new file mode 100644 index 0000000..ca95c5b --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/command_buffer.hpp @@ -0,0 +1,23 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +namespace vk { + /// vulkan command buffer + class CommandBuffer { + public: + /// create a command buffer + /// @param vk the vulkan instance + /// @throws ls::vulkan_error on failure + CommandBuffer(const vk::Vulkan& vk); + + /// submit the command buffer + /// @throws ls::vulkan_error on failure + void submit(); // FIXME: method needs to actually submit, depending on needs + private: + ls::owned_ptr commandBuffer; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/descriptor_set.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/descriptor_set.hpp new file mode 100644 index 0000000..170b650 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/descriptor_set.hpp @@ -0,0 +1,35 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "buffer.hpp" +#include "image.hpp" +#include "sampler.hpp" +#include "shader.hpp" +#include "vulkan.hpp" + +#include + +#include + +namespace vk { + /// vulkan descriptor set + class DescriptorSet { + public: + /// create a descriptor set + /// @param vk the vulkan instance + /// @param shader the shader module this descriptor set is for + /// @param sampledImages the sampled images to bind + /// @param storageImages the storage images to bind + /// @param samplers the samplers to bind + /// @param buffers the buffers to bind + /// @throws ls::vulkan_error on failure + DescriptorSet(const vk::Vulkan& vk, + const vk::Shader& shader, + const std::vector>& sampledImages, + const std::vector>& storageImages, + const std::vector>& samplers, + const std::vector>& buffers); + private: + ls::owned_ptr descriptorSet; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/fence.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/fence.hpp new file mode 100644 index 0000000..e2d8819 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/fence.hpp @@ -0,0 +1,33 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +#include + +namespace vk { + /// vulkan fence + class Fence { + public: + /// create a fence + /// @param vk the vulkan instance + /// @throws ls::vulkan_error on failure + Fence(const vk::Vulkan& vk); + + /// reset the fence + /// @param vk the vulkan instance + /// @throws ls::vulkan_error on failure + void reset(const vk::Vulkan& vk) const; + + /// wait for the fence + /// @param vk the vulkan instance + /// @param timeout the timeout in nanoseconds, or UINT64_MAX for no timeout + /// @returns true if the fence signaled, false if it timed out + /// @throws ls::vulkan_error on failure + [[nodiscard]] bool wait(const vk::Vulkan& vk, uint64_t timeout = UINT64_MAX) const; + private: + ls::owned_ptr fence; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/image.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/image.hpp new file mode 100644 index 0000000..b67b6e9 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/image.hpp @@ -0,0 +1,40 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +#include + +namespace vk { + /// vulkan image + class Image { + public: + /// create an image + /// @param vk the vulkan instance + /// @param extent extent of the image in pixels + /// @param format vulkan format of the image + /// @param usage usage flags + /// @param importFd optional file descriptor for shared memory + /// @param exportFd optional pointer to an integer where the file descriptor will be stored + /// @throws ls::vulkan_error on failure + Image(const vk::Vulkan& vk, + VkExtent2D extent, + VkFormat format = VK_FORMAT_R8G8B8A8_UNORM, + VkImageUsageFlags usage = VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_SAMPLED_BIT, + std::optional importFd = std::nullopt, + std::optional exportFd = std::nullopt); + + /// get the image handle + /// @return the image handle + [[nodiscard]] const auto& handle() const { return this->image.get(); } + /// get the image view handle + /// @return the image view handle + [[nodiscard]] const auto& imageview() const { return this->view.get(); } + private: + ls::owned_ptr image; + ls::owned_ptr memory; + ls::owned_ptr view; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/sampler.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/sampler.hpp new file mode 100644 index 0000000..e63e54a --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/sampler.hpp @@ -0,0 +1,27 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +namespace vk { + /// vulkan sampler + class Sampler { + public: + /// create a sampler + /// @param vk the vulkan instance + /// @param mode address mode + /// @param compare compare operation + /// @param white whether the border color is white + /// @throws ls::vulkan_error on failure + Sampler(const vk::Vulkan& vk, + VkSamplerAddressMode mode, VkCompareOp compare, bool white); + + /// get the sampler handle + /// @return the sampler handle + [[nodiscard]] const auto& handle() const { return this->sampler.get(); } + private: + ls::owned_ptr sampler; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/semaphore.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/semaphore.hpp new file mode 100644 index 0000000..780db97 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/semaphore.hpp @@ -0,0 +1,22 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include + +#include + +namespace vk { + /// vulkan semaphore + class Semaphore { + public: + /// create a semaphore + /// @param vk the vulkan instance + /// @param fd optional file descriptor to import the semaphore from + /// @throws ls::vulkan_error on failure + Semaphore(const vk::Vulkan& vk, std::optional fd = std::nullopt); + private: + ls::owned_ptr semaphore; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/shader.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/shader.hpp new file mode 100644 index 0000000..d0ffcd0 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/shader.hpp @@ -0,0 +1,37 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include +#include + +#include + +namespace vk { + /// vulkan shadermodule & pipeline wrapper + class Shader { + public: + /// create a vulkan shader + /// @param vk the vulkan instance + /// @param code the SPIR-V bytecode + /// @param sampledImages number of sampled images + /// @param storageImages number of storage images + /// @param buffers number of buffers + /// @param samplers number of samplers + /// @throws ls::vulkan_error on failure + Shader(const vk::Vulkan& vk, const std::vector& code, + size_t sampledImages, size_t storageImages, + size_t buffers, size_t samplers); + + /// get the descriptor set layout + /// @returns the descriptor set layout + [[nodiscard]] const auto& descriptorlayout() const { return *this->descriptorLayout; } + private: + ls::owned_ptr shaderModule; + ls::owned_ptr descriptorLayout; + + ls::owned_ptr pipelineLayout; + ls::owned_ptr pipeline; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/timeline_semaphore.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/timeline_semaphore.hpp new file mode 100644 index 0000000..e8c88e8 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/timeline_semaphore.hpp @@ -0,0 +1,40 @@ +#pragma once + +#include "../helpers/pointers.hpp" +#include "vulkan.hpp" + +#include +#include + +#include + +namespace vk { + /// vulkan timeline semaphore + class TimelineSemaphore { + public: + /// create a timeline semaphore + /// @param vk the vulkan instance + /// @param initial initial value of the timeline semaphore + /// @param fd optional file descriptor to import the semaphore from + /// @throws ls::vulkan_error on failure + TimelineSemaphore(const vk::Vulkan& vk, uint32_t initial, + std::optional fd = std::nullopt); + + /// signal the timeline semaphore + /// @param vk the vulkan instance + /// @param value the value to signal to + /// @throws ls::vulkan_error on failure + void signal(const vk::Vulkan& vk, uint64_t value) const; + + /// wait for the timeline semaphore + /// @param vk the vulkan instance + /// @param value the value to wait for + /// @param timeout the timeout in nanoseconds, or UINT64_MAX for no timeout + /// @returns true if the semaphore reached the value, false if it timed out + /// @throws ls::vulkan_error on failure + [[nodiscard]] bool wait(const vk::Vulkan& vk, + uint64_t value, uint64_t timeout = UINT64_MAX) const; + private: + ls::owned_ptr semaphore; + }; +} diff --git a/lsfg-vk-common/include/lsfg-vk-common/vulkan/vulkan.hpp b/lsfg-vk-common/include/lsfg-vk-common/vulkan/vulkan.hpp new file mode 100644 index 0000000..7be3f88 --- /dev/null +++ b/lsfg-vk-common/include/lsfg-vk-common/vulkan/vulkan.hpp @@ -0,0 +1,83 @@ +#pragma once + +#include "../helpers/pointers.hpp" + +#include +#include +#include +#include +#include +#include + +#include + +namespace vk { + using PhysicalDeviceSelector = const std::function< + VkPhysicalDevice(const std::vector&) + >&; + + /// vulkan version wrapper + class version { + public: + /// construct from version numbers + version(uint8_t major, uint8_t minor, uint8_t patch) + : major(major), minor(minor), patch(patch) {} + + /// convert to Vulkan version + [[nodiscard]] uint32_t into() const { + return VK_MAKE_VERSION(major, minor, patch); + } + private: + uint8_t major{}; + uint8_t minor{}; + uint8_t patch{}; + }; + + /// vulkan instance + class Vulkan { + public: + /// create a vulkan instance + /// @param appName name of the application + /// @param appVersion version of the application + /// @param engineName name of the engine + /// @param engineVersion version of the engine + /// @param selectPhysicalDevice function to select the physical device + /// @throws ls::vulkan_error on failure + Vulkan(const std::string& appName, version appVersion, + const std::string& engineName, version engineVersion, + PhysicalDeviceSelector selectPhysicalDevice); + + /// find a memory type index + /// @param validTypes bitset of valid memory types + /// @param hostVisibility whether the memory should be host visible + /// @return the memory type index + [[nodiscard]] std::optional findMemoryTypeIndex( + std::bitset<32> validTypes, bool hostVisibility) const; + + /// get the vulkan device + /// @return the device handle + [[nodiscard]] const auto& dev() const { return this->device.get(); } + /// get the command pool + /// @return the command pool handle + [[nodiscard]] const auto& cmdpool() const { return this->cmdPool.get(); } + /// get the descriptor pool + /// @return the descriptor pool handle + [[nodiscard]] const auto& descpool() const { return this->descPool.get(); } + + /// check if fp16 is supported + /// @return true if fp16 is supported + [[nodiscard]] bool supportsFP16() const { return this->fp16; } + private: + ls::owned_ptr instance; + + VkPhysicalDevice physdev; + uint32_t computeFamilyIdx; + bool fp16; + + ls::owned_ptr device; + VkQueue computeQueue; + + ls::owned_ptr cmdPool; + ls::owned_ptr descPool; + }; +} diff --git a/lsfg-vk-common/src/helpers/errors.cpp b/lsfg-vk-common/src/helpers/errors.cpp new file mode 100644 index 0000000..6495c9d --- /dev/null +++ b/lsfg-vk-common/src/helpers/errors.cpp @@ -0,0 +1,9 @@ +#include "lsfg-vk-common/helpers/errors.hpp" + +#include + +using namespace ls; + +VkResult vulkan_error::error() const { + return this->result; +} diff --git a/lsfg-vk-common/src/vulkan/buffer.cpp b/lsfg-vk-common/src/vulkan/buffer.cpp new file mode 100644 index 0000000..b6d100a --- /dev/null +++ b/lsfg-vk-common/src/vulkan/buffer.cpp @@ -0,0 +1,96 @@ +#include "lsfg-vk-common/vulkan/buffer.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include +#include +#include +#include +#include + +#include + +using namespace vk; + +namespace { + /// create a buffer + ls::owned_ptr createBuffer(const vk::Vulkan& vk, size_t size) { + VkBuffer handle{}; + + const VkBufferCreateInfo bufferInfo{ + .sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, + .size = size, + .usage = VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, + .sharingMode = VK_SHARING_MODE_EXCLUSIVE + }; + auto res = vkCreateBuffer(vk.dev(), &bufferInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateBuffer() failed"); + + return ls::owned_ptr( + new VkBuffer(handle), + [dev = vk.dev()](VkBuffer& buffer) { + vkDestroyBuffer(dev, buffer, nullptr); + } + ); + } + /// allocate memory for a buffer + ls::owned_ptr allocateMemory(const vk::Vulkan& vk, VkBuffer buffer) { + VkDeviceMemory handle{}; + + VkMemoryRequirements reqs{}; + vkGetBufferMemoryRequirements(vk.dev(), buffer, &reqs); + + auto mti = vk.findMemoryTypeIndex( + reqs.memoryTypeBits, + true + ); + if (!mti.has_value()) + throw ls::vulkan_error("no suitable memory type found for buffer"); + + const VkMemoryAllocateInfo memoryInfo{ + .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, + .allocationSize = reqs.size, + .memoryTypeIndex = *mti + }; + auto res = vkAllocateMemory(vk.dev(), &memoryInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkAllocateMemory() failed"); + + res = vkBindBufferMemory(vk.dev(), buffer, handle, 0); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkBindBufferMemory() failed"); + + return ls::owned_ptr( + new VkDeviceMemory(handle), + [dev = vk.dev()](VkDeviceMemory& memory) { + vkFreeMemory(dev, memory, nullptr); + } + ); + } + /// copy data to a buffer + void copyDataToBuffer(const vk::Vulkan& vk, + VkDeviceMemory memory, const void* data, size_t size) { + void* buf{}; + + auto res = vkMapMemory(vk.dev(), memory, 0, size, 0, &buf); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkMapMemory() failed"); + + std::copy_n( + reinterpret_cast(data), + size, + reinterpret_cast(buf) + ); + + vkUnmapMemory(vk.dev(), memory); + } +} + +Buffer::Buffer(const vk::Vulkan& vk, const void* data, size_t size) : + buffer(createBuffer(vk, size)), + memory(allocateMemory(vk, *this->buffer)), + size(size) { + copyDataToBuffer(vk, *this->memory, data, size); +} diff --git a/lsfg-vk-common/src/vulkan/command_buffer.cpp b/lsfg-vk-common/src/vulkan/command_buffer.cpp new file mode 100644 index 0000000..bcc408f --- /dev/null +++ b/lsfg-vk-common/src/vulkan/command_buffer.cpp @@ -0,0 +1,50 @@ +#include "lsfg-vk-common/vulkan/command_buffer.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include + +using namespace vk; + +namespace { + /// create a command buffer + ls::owned_ptr createCommandBuffer(const vk::Vulkan& vk) { + VkCommandBuffer handle{}; + + const VkCommandBufferAllocateInfo commandBufferInfo{ + .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO, + .commandPool = vk.cmdpool(), + .level = VK_COMMAND_BUFFER_LEVEL_PRIMARY, + .commandBufferCount = 1 + }; + auto res = vkAllocateCommandBuffers(vk.dev(), &commandBufferInfo, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkAllocateCommandBuffers() failed"); + + return ls::owned_ptr( + new VkCommandBuffer(handle), + [dev = vk.dev(), pool = vk.cmdpool()](VkCommandBuffer& commandBufferModule) { + vkFreeCommandBuffers(dev, pool, 1, &commandBufferModule); + } + ); + } +} + +CommandBuffer::CommandBuffer(const vk::Vulkan& vk) + : commandBuffer(createCommandBuffer(vk)) { + + const VkCommandBufferBeginInfo beginInfo = { + .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO, + .flags = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT + }; + auto res = vkBeginCommandBuffer(*this->commandBuffer, &beginInfo); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkBeginCommandBuffer() failed"); +} + +void CommandBuffer::submit() { + auto res = vkEndCommandBuffer(*this->commandBuffer); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkEndCommandBuffer() failed"); +} diff --git a/lsfg-vk-common/src/vulkan/descriptor_set.cpp b/lsfg-vk-common/src/vulkan/descriptor_set.cpp new file mode 100644 index 0000000..d1555d2 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/descriptor_set.cpp @@ -0,0 +1,124 @@ +#include "lsfg-vk-common/vulkan/descriptor_set.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/buffer.hpp" +#include "lsfg-vk-common/vulkan/image.hpp" +#include "lsfg-vk-common/vulkan/sampler.hpp" +#include "lsfg-vk-common/vulkan/shader.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include +#include +#include +#include + +using namespace vk; + +namespace { + /// create a descriptor set + ls::owned_ptr createDescriptorSet(const vk::Vulkan& vk, + const vk::Shader& shader) { + VkDescriptorSet handle{}; + + auto* layout = shader.descriptorlayout(); + const VkDescriptorSetAllocateInfo setInfo{ + .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO, + .descriptorPool = vk.descpool(), + .descriptorSetCount = 1, + .pSetLayouts = &layout + }; + auto res = vkAllocateDescriptorSets(vk.dev(), &setInfo, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkAllocateDescriptorSets() failed"); + + return ls::owned_ptr( + new VkDescriptorSet(handle), + [dev = vk.dev(), pool = vk.descpool()](VkDescriptorSet& commandBufferModule) { + vkFreeDescriptorSets(dev, pool, 1, &commandBufferModule); + } + ); + } +} + +DescriptorSet::DescriptorSet(const vk::Vulkan& vk, + const vk::Shader& shader, + const std::vector>& sampledImages, + const std::vector>& storageImages, + const std::vector>& samplers, + const std::vector>& buffers) + : descriptorSet(createDescriptorSet(vk, shader)) { + // update descriptor set + const size_t bindingCount = + samplers.size() + + sampledImages.size() + + storageImages.size() + + buffers.size(); + + std::vector entries; + entries.reserve(bindingCount); + + std::vector bufferInfos; + bufferInfos.reserve(buffers.size()); + + size_t bufferIdx{0}; + for (const auto& buf : buffers) + entries.push_back({ + .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, + .dstSet = *this->descriptorSet, + .dstBinding = static_cast(bufferIdx++), + .descriptorCount = 1, + .descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, + .pBufferInfo = &(bufferInfos.emplace_back(VkDescriptorBufferInfo{ + .buffer = buf.get().handle(), + .range = buf.get().length() + })) + }); + + std::vector imageInfos; + imageInfos.reserve(bindingCount); + + size_t samplerIdx{16}; + for (const auto& samp : samplers) + entries.push_back({ + .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, + .dstSet = *this->descriptorSet, + .dstBinding = static_cast(samplerIdx++), + .descriptorCount = 1, + .descriptorType = VK_DESCRIPTOR_TYPE_SAMPLER, + .pImageInfo = &(imageInfos.emplace_back(VkDescriptorImageInfo{ + .sampler = samp.get().handle(), + })) + }); + + size_t sampledIdx{32}; + for (const auto& img : sampledImages) { + entries.push_back({ + .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, + .dstSet = *this->descriptorSet, + .dstBinding = static_cast(sampledIdx++), + .descriptorCount = 1, + .descriptorType = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, + .pImageInfo = &(imageInfos.emplace_back(VkDescriptorImageInfo{ + .imageView = img.get().imageview(), + .imageLayout = VK_IMAGE_LAYOUT_GENERAL + })) + }); + } + + size_t storageIdx{48}; + for (const auto& img : storageImages) + entries.push_back({ + .sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, + .dstSet = *this->descriptorSet, + .dstBinding = static_cast(storageIdx++), + .descriptorCount = 1, + .descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, + .pImageInfo = &(imageInfos.emplace_back(VkDescriptorImageInfo{ + .imageView = img.get().imageview(), + .imageLayout = VK_IMAGE_LAYOUT_GENERAL + })) + }); + + vkUpdateDescriptorSets(vk.dev(), + static_cast(entries.size()), entries.data(), 0, nullptr); +} diff --git a/lsfg-vk-common/src/vulkan/fence.cpp b/lsfg-vk-common/src/vulkan/fence.cpp new file mode 100644 index 0000000..2397fa9 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/fence.cpp @@ -0,0 +1,50 @@ +#include "lsfg-vk-common/vulkan/fence.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include + +#include + +using namespace vk; + +namespace { + /// create a fence + ls::owned_ptr createFence(const vk::Vulkan& vk) { + VkFence handle{}; + + const VkFenceCreateInfo fenceInfo{ + .sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO + }; + auto res = vkCreateFence(vk.dev(), &fenceInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateFence() failed"); + + return ls::owned_ptr( + new VkFence(handle), + [dev = vk.dev()](VkFence& fence) { + vkDestroyFence(dev, fence, nullptr); + } + ); + } +} + +Fence::Fence(const vk::Vulkan& vk) + : fence(createFence(vk)) {} + +void Fence::reset(const vk::Vulkan& vk) const { + VkFence fence = *this->fence; + auto res = vkResetFences(vk.dev(), 1, &fence); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkResetFences() failed"); +} + +bool Fence::wait(const vk::Vulkan& vk, uint64_t timeout) const { + VkFence fence = *this->fence; + auto res = vkWaitForFences(vk.dev(), 1, &fence, VK_TRUE, timeout); + if (res != VK_SUCCESS && res != VK_TIMEOUT) + throw ls::vulkan_error(res, "vkWaitForFences() failed"); + + return res == VK_SUCCESS; +} diff --git a/lsfg-vk-common/src/vulkan/image.cpp b/lsfg-vk-common/src/vulkan/image.cpp new file mode 100644 index 0000000..b69ff35 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/image.cpp @@ -0,0 +1,172 @@ +#include "lsfg-vk-common/vulkan/image.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include +#include + +#include + +using namespace vk; + +namespace { + /// create a image + ls::owned_ptr createImage(const vk::Vulkan& vk, + VkExtent2D extent, VkFormat format, VkImageUsageFlags usage, + bool external) { + VkImage handle{}; + + const VkExternalMemoryImageCreateInfo externalInfo{ + .sType = VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO, + .handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR + }; + const VkImageCreateInfo imageInfo{ + .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, + .pNext = external ? &externalInfo : nullptr, + .imageType = VK_IMAGE_TYPE_2D, + .format = format, + .extent = { + .width = extent.width, + .height = extent.height, + .depth = 1 + }, + .mipLevels = 1, + .arrayLayers = 1, + .samples = VK_SAMPLE_COUNT_1_BIT, + .usage = usage, + .sharingMode = VK_SHARING_MODE_EXCLUSIVE + }; + auto res = vkCreateImage(vk.dev(), &imageInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateImage() failed"); + + return ls::owned_ptr( + new VkImage(handle), + [dev = vk.dev()](VkImage& image) { + vkDestroyImage(dev, image, nullptr); + } + ); + } + /// allocate memory for a image + ls::owned_ptr allocateMemory(const vk::Vulkan& vk, VkImage image, + std::optional importFd, std::optional exportFd) { + VkDeviceMemory handle{}; + + VkMemoryRequirements reqs{}; + vkGetImageMemoryRequirements(vk.dev(), image, &reqs); + + auto mti = vk.findMemoryTypeIndex( + reqs.memoryTypeBits, + true + ); + if (!mti.has_value()) + throw ls::vulkan_error("no suitable memory type found for image"); + + const VkMemoryDedicatedAllocateInfoKHR dedicatedInfo{ + .sType = VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO_KHR, + .image = image, + }; + const VkImportMemoryFdInfoKHR importInfo{ + .sType = VK_STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR, + .pNext = &dedicatedInfo, + .handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR, + .fd = importFd.value_or(-1) + }; + const VkExportMemoryAllocateInfo exportInfo{ + .sType = VK_STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO, + .pNext = &dedicatedInfo, + .handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR + }; + const void* pNextAlloc{}; + if (importFd.has_value()) + pNextAlloc = &importInfo; + else if (exportFd.has_value()) + pNextAlloc = &exportInfo; + const VkMemoryAllocateInfo memoryInfo{ + .sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, + .pNext = pNextAlloc, + .allocationSize = reqs.size, + .memoryTypeIndex = *mti + }; + auto res = vkAllocateMemory(vk.dev(), &memoryInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkAllocateMemory() failed"); + + res = vkBindImageMemory(vk.dev(), image, handle, 0); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkBindImageMemory() failed"); + + if (exportFd.has_value()) { + auto vkGetMemoryFdKHR = reinterpret_cast( + vkGetDeviceProcAddr(vk.dev(), "vkGetMemoryFdKHR")); // TODO: cache + + const VkMemoryGetFdInfoKHR fdInfo{ + .sType = VK_STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR, + .memory = handle, + .handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR + }; + int fd{}; + res = vkGetMemoryFdKHR(vk.dev(), &fdInfo, &fd); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkGetMemoryFdKHR() failed"); + **exportFd = fd; + } + + return ls::owned_ptr( + new VkDeviceMemory(handle), + [dev = vk.dev()](VkDeviceMemory& memory) { + vkFreeMemory(dev, memory, nullptr); + } + ); + } + /// create an image view + ls::owned_ptr createImageView(const vk::Vulkan& vk, + VkImage image, VkFormat format) { + VkImageView handle{}; + + const VkImageViewCreateInfo viewInfo{ + .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO, + .image = image, + .viewType = VK_IMAGE_VIEW_TYPE_2D, + .format = format, + .subresourceRange = { + .aspectMask = VK_IMAGE_ASPECT_COLOR_BIT, + .baseMipLevel = 0, + .levelCount = 1, + .baseArrayLayer = 0, + .layerCount = 1 + } + }; + auto res = vkCreateImageView(vk.dev(), &viewInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateImageView() failed"); + + return ls::owned_ptr( + new VkImageView(handle), + [dev = vk.dev()](VkImageView& view) { + vkDestroyImageView(dev, view, nullptr); + } + ); + } +} + +Image::Image(const vk::Vulkan& vk, + VkExtent2D extent, + VkFormat format, + VkImageUsageFlags usage, + std::optional importFd, + std::optional exportFd) : + image(createImage(vk, + extent, format, usage, + importFd.has_value() || exportFd.has_value() + )), + memory(allocateMemory(vk, + *this->image, + importFd, exportFd + )), + view(createImageView(vk, + *this->image, + format + )) { +} diff --git a/lsfg-vk-common/src/vulkan/sampler.cpp b/lsfg-vk-common/src/vulkan/sampler.cpp new file mode 100644 index 0000000..99711ae --- /dev/null +++ b/lsfg-vk-common/src/vulkan/sampler.cpp @@ -0,0 +1,44 @@ +#include "lsfg-vk-common/vulkan/sampler.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include + +using namespace vk; + +namespace { + /// create a sampler + ls::owned_ptr createSampler(const vk::Vulkan& vk, + VkSamplerAddressMode mode, VkCompareOp compare, bool white) { + VkSampler handle{}; + + const VkSamplerCreateInfo samplerInfo{ + .sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO, + .magFilter = VK_FILTER_LINEAR, + .minFilter = VK_FILTER_LINEAR, + .mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR, + .addressModeU = mode, + .addressModeV = mode, + .addressModeW = mode, + .compareOp = compare, + .maxLod = VK_LOD_CLAMP_NONE, + .borderColor = + white ? VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE + : VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK + }; + auto res = vkCreateSampler(vk.dev(), &samplerInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateSampler() failed"); + + return ls::owned_ptr( + new VkSampler(handle), + [dev = vk.dev()](VkSampler& sampler) { + vkDestroySampler(dev, sampler, nullptr); + } + ); + } +} + +Sampler::Sampler(const vk::Vulkan& vk, VkSamplerAddressMode mode, VkCompareOp compare, bool white) + : sampler(createSampler(vk, mode, compare, white)) {} diff --git a/lsfg-vk-common/src/vulkan/semaphore.cpp b/lsfg-vk-common/src/vulkan/semaphore.cpp new file mode 100644 index 0000000..59c1e92 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/semaphore.cpp @@ -0,0 +1,55 @@ +#include "lsfg-vk-common/vulkan/semaphore.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include + +#include + +using namespace vk; + +namespace { + /// create a semaphore + ls::owned_ptr createSemaphore(const vk::Vulkan& vk, std::optional fd) { + VkSemaphore handle{}; + + const VkExportSemaphoreCreateInfo exportInfo{ + .sType = VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO, + .handleTypes = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT + }; + const VkSemaphoreCreateInfo semaphoreInfo{ + .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, + .pNext = fd.has_value() ? &exportInfo : nullptr + }; + auto res = vkCreateSemaphore(vk.dev(), &semaphoreInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateSemaphore() failed"); + + if (fd.has_value()) { + // import semaphore from fd + auto vkImportSemaphoreFdKHR = reinterpret_cast( + vkGetDeviceProcAddr(vk.dev(), "vkImportSemaphoreFdKHR")); // TODO: cache + + const VkImportSemaphoreFdInfoKHR importInfo{ + .sType = VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR, + .semaphore = handle, + .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, + .fd = *fd // closes the fd + }; + res = vkImportSemaphoreFdKHR(vk.dev(), &importInfo); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkImportSemaphoreFdKHR() failed"); + } + + return ls::owned_ptr( + new VkSemaphore(handle), + [dev = vk.dev()](VkSemaphore& semaphore) { + vkDestroySemaphore(dev, semaphore, nullptr); + } + ); + } +} + +Semaphore::Semaphore(const vk::Vulkan& vk, std::optional fd) + : semaphore(createSemaphore(vk, fd)) {} diff --git a/lsfg-vk-common/src/vulkan/shader.cpp b/lsfg-vk-common/src/vulkan/shader.cpp new file mode 100644 index 0000000..8aeedf8 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/shader.cpp @@ -0,0 +1,166 @@ +#include "lsfg-vk-common/vulkan/shader.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include +#include +#include + +#include + +using namespace vk; + +namespace { + /// create a shader module + ls::owned_ptr createShaderModule( + const vk::Vulkan& vk, + const uint8_t* data, size_t data_len) { + VkShaderModule handle{}; + + const VkShaderModuleCreateInfo shaderModuleInfo{ + .sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO, + .codeSize = data_len, + .pCode = reinterpret_cast(data) + }; + auto res = vkCreateShaderModule(vk.dev(), &shaderModuleInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateShaderModule() failed"); + + return ls::owned_ptr( + new VkShaderModule(handle), + [dev = vk.dev()](VkShaderModule& shaderModule) { + vkDestroyShaderModule(dev, shaderModule, nullptr); + } + ); + } + /// create a descriptor set layout + ls::owned_ptr createDescriptorSetLayout( + const vk::Vulkan& vk, + size_t sampledImages, size_t storageImages, + size_t buffers, size_t samplers) { + VkDescriptorSetLayout handle{}; + + std::vector bindings; + bindings.reserve(buffers + samplers + sampledImages + storageImages); + + for (size_t i = 0; i < buffers; i++) + bindings.push_back({ + .binding = static_cast(i), + .descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, + .descriptorCount = 1, + .stageFlags = VK_SHADER_STAGE_COMPUTE_BIT + }); + for (size_t i = 0; i < samplers; i++) + bindings.push_back({ + .binding = static_cast(i + 16), + .descriptorType = VK_DESCRIPTOR_TYPE_SAMPLER, + .descriptorCount = 1, + .stageFlags = VK_SHADER_STAGE_COMPUTE_BIT + }); + for (size_t i = 0; i < sampledImages; i++) + bindings.push_back({ + .binding = static_cast(i + 32), + .descriptorType = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, + .descriptorCount = 1, + .stageFlags = VK_SHADER_STAGE_COMPUTE_BIT + }); + for (size_t i = 0; i < storageImages; i++) + bindings.push_back({ + .binding = static_cast(i + 48), + .descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, + .descriptorCount = 1, + .stageFlags = VK_SHADER_STAGE_COMPUTE_BIT + }); + + const VkDescriptorSetLayoutCreateInfo descriptorLayoutInfo{ + .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO, + .bindingCount = static_cast(bindings.size()), + .pBindings = bindings.data() + }; + auto res = vkCreateDescriptorSetLayout(vk.dev(), &descriptorLayoutInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateDescriptorSetLayout() failed"); + + return ls::owned_ptr( + new VkDescriptorSetLayout(handle), + [dev = vk.dev()](VkDescriptorSetLayout& layout) { + vkDestroyDescriptorSetLayout(dev, layout, nullptr); + } + ); + } + /// create a pipeline layout + ls::owned_ptr createPipelineLayout( + const vk::Vulkan& vk, + VkDescriptorSetLayout descriptorLayout) { + VkPipelineLayout handle{}; + + const VkPipelineLayoutCreateInfo layoutInfo{ + .sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO, + .setLayoutCount = 1, + .pSetLayouts = &descriptorLayout + }; + auto res = vkCreatePipelineLayout(vk.dev(), &layoutInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreatePipelineLayout() failed"); + + return ls::owned_ptr( + new VkPipelineLayout(handle), + [dev = vk.dev()](VkPipelineLayout& layout) { + vkDestroyPipelineLayout(dev, layout, nullptr); + } + ); + } + /// create a compute pipeline + ls::owned_ptr createComputePipeline( + const vk::Vulkan& vk, + VkShaderModule shaderModule, + VkPipelineLayout pipelineLayout) { + VkPipeline handle{}; + + const VkPipelineShaderStageCreateInfo shaderStageInfo{ + .sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO, + .stage = VK_SHADER_STAGE_COMPUTE_BIT, + .module = shaderModule, + .pName = "main" + }; + const VkComputePipelineCreateInfo pipelineInfo{ + .sType = VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO, + .stage = shaderStageInfo, + .layout = pipelineLayout + }; + auto res = vkCreateComputePipelines(vk.dev(), + VK_NULL_HANDLE, 1, &pipelineInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateComputePipelines() failed"); + + // TODO: ponder pipeline cache + + return ls::owned_ptr( + new VkPipeline(handle), + [dev = vk.dev()](VkPipeline& pipeline) { + vkDestroyPipeline(dev, pipeline, nullptr); + } + ); + } +} + +Shader::Shader(const vk::Vulkan& vk, const std::vector& code, + size_t sampledImages, size_t storageImages, + size_t buffers, size_t samplers) : + shaderModule(createShaderModule(vk, + code.data(), code.size() + )), + descriptorLayout(createDescriptorSetLayout(vk, + sampledImages, storageImages, + buffers, samplers + )), + pipelineLayout(createPipelineLayout(vk, + *this->descriptorLayout + )), + pipeline(createComputePipeline(vk, + *this->shaderModule, + *this->pipelineLayout + )) { + +} diff --git a/lsfg-vk-common/src/vulkan/timeline_semaphore.cpp b/lsfg-vk-common/src/vulkan/timeline_semaphore.cpp new file mode 100644 index 0000000..74a0e81 --- /dev/null +++ b/lsfg-vk-common/src/vulkan/timeline_semaphore.cpp @@ -0,0 +1,89 @@ +#include "lsfg-vk-common/vulkan/timeline_semaphore.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" +#include "lsfg-vk-common/vulkan/vulkan.hpp" + +#include +#include + +#include + +using namespace vk; + +namespace { + /// create a timeline semaphore + ls::owned_ptr createTimelineSemaphore(const vk::Vulkan& vk, uint32_t initial, + std::optional fd) { + VkSemaphore handle{}; + + const VkExportSemaphoreCreateInfo exportInfo{ + .sType = VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO, + .handleTypes = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT + }; + const VkSemaphoreTypeCreateInfo typeInfo{ + .sType = VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO, + .pNext = fd.has_value() ? &exportInfo : nullptr, + .semaphoreType = VK_SEMAPHORE_TYPE_TIMELINE, + .initialValue = initial + }; + const VkSemaphoreCreateInfo semaphoreInfo{ + .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, + .pNext = &typeInfo, + }; + auto res = vkCreateSemaphore(vk.dev(), &semaphoreInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateSemaphore() failed"); + + if (fd.has_value()) { + // import semaphore from fd + auto vkImportSemaphoreFdKHR = reinterpret_cast( + vkGetDeviceProcAddr(vk.dev(), "vkImportSemaphoreFdKHR")); // TODO: cache + + const VkImportSemaphoreFdInfoKHR importInfo{ + .sType = VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR, + .semaphore = handle, + .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, + .fd = *fd // closes the fd + }; + res = vkImportSemaphoreFdKHR(vk.dev(), &importInfo); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkImportSemaphoreFdKHR() failed"); + } + + return ls::owned_ptr( + new VkSemaphore(handle), + [dev = vk.dev()](VkSemaphore& semaphore) { + vkDestroySemaphore(dev, semaphore, nullptr); + } + ); + } +} + +TimelineSemaphore::TimelineSemaphore(const vk::Vulkan& vk, uint32_t initial, std::optional fd) + : semaphore(createTimelineSemaphore(vk, initial, fd)) {} + +void TimelineSemaphore::signal(const vk::Vulkan& vk, uint64_t value) const { + const VkSemaphoreSignalInfo signalInfo{ + .sType = VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO, + .semaphore = *this->semaphore, + .value = value + }; + auto res = vkSignalSemaphore(vk.dev(), &signalInfo); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkSignalSemaphore() failed"); +} + +bool TimelineSemaphore::wait(const vk::Vulkan& vk, uint64_t value, uint64_t timeout) const { + VkSemaphore semaphore = *this->semaphore; + const VkSemaphoreWaitInfo waitInfo{ + .sType = VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO, + .semaphoreCount = 1, + .pSemaphores = &semaphore, + .pValues = &value + }; + auto res = vkWaitSemaphores(vk.dev(), &waitInfo, timeout); + if (res != VK_SUCCESS && res != VK_TIMEOUT) + throw ls::vulkan_error(res, "vkWaitSemaphores() failed"); + + return res == VK_SUCCESS; +} diff --git a/lsfg-vk-common/src/vulkan/vulkan.cpp b/lsfg-vk-common/src/vulkan/vulkan.cpp new file mode 100644 index 0000000..31dacfd --- /dev/null +++ b/lsfg-vk-common/src/vulkan/vulkan.cpp @@ -0,0 +1,240 @@ +#include "lsfg-vk-common/vulkan/vulkan.hpp" +#include "lsfg-vk-common/helpers/errors.hpp" +#include "lsfg-vk-common/helpers/pointers.hpp" + +#include +#include +#include +#include +#include +#include + +#include + +using namespace vk; + +namespace { + /// create a vulkan instance + ls::owned_ptr createInstance( + const std::string& appName, version appVersion, + const std::string& engineName, version engineVersion) { + VkInstance handle{}; + + const VkApplicationInfo appInfo{ + .sType = VK_STRUCTURE_TYPE_APPLICATION_INFO, + .pApplicationName = appName.c_str(), + .applicationVersion = appVersion.into(), + .pEngineName = engineName.c_str(), + .engineVersion = engineVersion.into(), + .apiVersion = VK_API_VERSION_1_2 // seems Vulkan 1.2 is supported on all Vulkan-capable GPUs + }; + const VkInstanceCreateInfo instanceInfo{ + .sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO, + .pApplicationInfo = &appInfo + }; + auto res = vkCreateInstance(&instanceInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateInstance() failed"); + + return ls::owned_ptr( + new VkInstance(handle), + [](VkInstance& instance) { + vkDestroyInstance(instance, nullptr); + } + ); + } + + /// filter for a physical device + VkPhysicalDevice findPhysicalDevice( + VkInstance instance, + PhysicalDeviceSelector filter) { + uint32_t phydevCount{}; + auto res = vkEnumeratePhysicalDevices(instance, &phydevCount, nullptr); + if (res != VK_SUCCESS || phydevCount == 0) + throw ls::vulkan_error(res, "vkEnumeratePhysicalDevices() failed"); + + std::vector phydevs(phydevCount); + res = vkEnumeratePhysicalDevices(instance, &phydevCount, phydevs.data()); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkEnumeratePhysicalDevices() failed"); + + VkPhysicalDevice selected = filter(phydevs); + if (!selected) + throw ls::vulkan_error("no suitable physical device found"); + + return selected; + } + + /// find the queue family index with given flags + uint32_t findQFI(VkPhysicalDevice physdev, VkQueueFlags flags) { + uint32_t queueCount{}; + vkGetPhysicalDeviceQueueFamilyProperties(physdev, &queueCount, nullptr); + + std::vector queues(queueCount); + vkGetPhysicalDeviceQueueFamilyProperties(physdev, &queueCount, queues.data()); + + for (uint32_t i = 0; i < queueCount; ++i) { + if ((queues[i].queueFlags & flags) == flags) + return i; + } + + throw ls::vulkan_error("no queue family with requested flags found"); + } + + /// check for fp16 support + bool checkFP16(VkPhysicalDevice physdev) { + VkPhysicalDeviceVulkan12Features supportedFeaturesVulkan12{ + .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_FEATURES + }; + VkPhysicalDeviceFeatures2 supportedFeatures{ + .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2, + .pNext = &supportedFeaturesVulkan12 + }; + vkGetPhysicalDeviceFeatures2(physdev, &supportedFeatures); + return supportedFeaturesVulkan12.shaderFloat16 == VK_TRUE; + } + + /// create a logical device + ls::owned_ptr createLogicalDevice(VkPhysicalDevice physdev, uint32_t cfi, bool fp16) { + VkDevice handle{}; + + const float queuePriority{1.0F}; // highest priority + const VkPhysicalDeviceVulkan12Features requestedFeaturesVulkan12{ + .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_FEATURES, + .shaderFloat16 = fp16, + .timelineSemaphore = VK_TRUE, + .vulkanMemoryModel = VK_TRUE + }; + const VkDeviceQueueCreateInfo requestedQueueInfo{ + .sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO, + .queueFamilyIndex = cfi, + .queueCount = 1, + .pQueuePriorities = &queuePriority + }; + const std::vector requestedExtensions{ + VK_KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME, + VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME, + VK_KHR_FORMAT_FEATURE_FLAGS_2_EXTENSION_NAME // TODO: possibly attempt to get rid of + }; + const VkDeviceCreateInfo deviceInfo{ + .sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO, + .pNext = &requestedFeaturesVulkan12, + .queueCreateInfoCount = 1, + .pQueueCreateInfos = &requestedQueueInfo, + .enabledExtensionCount = static_cast(requestedExtensions.size()), + .ppEnabledExtensionNames = requestedExtensions.data() + }; + auto res = vkCreateDevice(physdev, &deviceInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateDevice() failed"); + + return ls::owned_ptr( + new VkDevice(handle), + [](VkDevice& device) { + vkDestroyDevice(device, nullptr); + } + ); + } + + /// get a queue from the logical device + VkQueue getQueue(VkDevice device, uint32_t cfi) { + VkQueue queue{}; + + vkGetDeviceQueue(device, cfi, 0, &queue); + return queue; + } + + /// create a command pool + ls::owned_ptr createCommandPool(VkDevice device, uint32_t cfi) { + VkCommandPool handle{}; + + const VkCommandPoolCreateInfo cmdpoolInfo{ + .sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO, + .queueFamilyIndex = cfi + }; + auto res = vkCreateCommandPool(device, &cmdpoolInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateCommandPool() failed"); + + return ls::owned_ptr( + new VkCommandPool(handle), + [dev = device](VkCommandPool& pool) { + vkDestroyCommandPool(dev, pool, nullptr); + } + ); + } + + /// create a descriptor pool + ls::owned_ptr createDescriptorPool(VkDevice device) { + VkDescriptorPool handle{}; + + const std::array poolCounts{{ // FIXME: arbitrary limits + { .type = VK_DESCRIPTOR_TYPE_SAMPLER, .descriptorCount = 4096 }, + { .type = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, .descriptorCount = 4096 }, + { .type = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, .descriptorCount = 4096 }, + { .type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, .descriptorCount = 4096 } + }}; + const VkDescriptorPoolCreateInfo descpoolInfo{ + .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO, + .flags = VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT, + .maxSets = 16384, + .poolSizeCount = static_cast(poolCounts.size()), + .pPoolSizes = poolCounts.data() + }; + auto res = vkCreateDescriptorPool(device, &descpoolInfo, nullptr, &handle); + if (res != VK_SUCCESS) + throw ls::vulkan_error(res, "vkCreateDescriptorPool() failed"); + + return ls::owned_ptr( + new VkDescriptorPool(handle), + [dev = device](VkDescriptorPool& pool) { + vkDestroyDescriptorPool(dev, pool, nullptr); + } + ); + } +} + +Vulkan::Vulkan(const std::string& appName, version appVersion, + const std::string& engineName, version engineVersion, + PhysicalDeviceSelector selectPhysicalDevice) : + instance(createInstance( + appName, appVersion, + engineName, engineVersion + )), + physdev(findPhysicalDevice( + *this->instance, + selectPhysicalDevice + )), + computeFamilyIdx(findQFI(this->physdev, VK_QUEUE_COMPUTE_BIT)), + fp16(checkFP16(this->physdev)), + device(createLogicalDevice( + this->physdev, + this->computeFamilyIdx, + this->fp16 + )), + computeQueue(getQueue(*this->device, this->computeFamilyIdx)), + cmdPool(createCommandPool( + *this->device, + this->computeFamilyIdx + )), + descPool(createDescriptorPool( + *this->device + )) { +} + +std::optional Vulkan::findMemoryTypeIndex( + std::bitset<32> validTypes, bool hostVisibility) const { + const VkMemoryPropertyFlags desiredProps = hostVisibility ? + (VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT) : + VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT; + + VkPhysicalDeviceMemoryProperties props; + vkGetPhysicalDeviceMemoryProperties(this->physdev, &props); + + std::array memTypes = std::to_array(props.memoryTypes); + for (uint32_t i = 0; i < props.memoryTypeCount; ++i) + if (validTypes.test(i) && (memTypes.at(i).propertyFlags & desiredProps) == desiredProps) + return i; + + return std::nullopt; +}