Adding FreeBSD build support. #460

LadySerenaKitty · 2024-01-31T07:32:57Z

Making all changes required to build on FreeBSD. Some CMake entries for Linux may have changed, but their functionality remains unchanged.

BuildTools/FormatValidation/validate_format_freebsd_implementation.sh

BuildTools/FormatValidation/validate_format_freebsd.sh

BuildTools/CMake/BuildUtils.cmake

CMakeLists.txt

Platforms/Linux/src/LinuxPlatformMisc.cpp

TheMostDiligent · 2024-01-31T18:36:50Z

ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h

@@ -342,7 +342,9 @@
 #define __stdcall
 #define __vectorcall
 #define __thiscall
+#ifndef PLATFORM_FREEBSD
 #define __fastcall


Is __fastcall a recognized keyword when compiling on FreeBSD?

On this one, the compiler was complaining about fastcall being redefined, as FreeBSD's headers already define fastcall.

Which compiler are you using?

Believe it or not, the entirety of DiligentEngine was built using the compiler provided by the base system: clang 16.0.6.

It is actually strange why it only complains about __fastcall. It also recognized all other attributes
https://clang.llvm.org/docs/AttributeReference.html#target-version

Can you post the error that the compiler produces?

This is what happens without skipping __fastcall:

[ 35%] Building CXX object DiligentCore/Graphics/ShaderTools/CMakeFiles/Diligent-ShaderTools.dir/src/DXCompiler.cpp.o In file included from /usr/home/jlhawkwell/Projects/DiligentEngine/DiligentCore/Graphics/ShaderTools/src/DXCompiler.cpp:42: In file included from /usr/home/jlhawkwell/Projects/DiligentEngine/DiligentCore/Graphics/ShaderTools/include/DXCompilerBaseLinux.hpp:31: In file included from /usr/home/jlhawkwell/Projects/DiligentEngine/DiligentCore/Graphics/ShaderTools/../../ThirdParty/DirectXShaderCompiler/dxc/dxcapi.h:37: /usr/home/jlhawkwell/Projects/DiligentEngine/DiligentCore/Graphics/ShaderTools/../../ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h:345:9: error: '__fastcall' macro redefined [-Werror,-Wmacro-redefined] #define __fastcall ^ /usr/include/sys/cdefs.h:365:9: note: previous definition is here #define __fastcall __attribute__((__fastcall__)) ^ 1 error generated. gmake[2]: *** [DiligentCore/Graphics/ShaderTools/CMakeFiles/Diligent-ShaderTools.dir/build.make:122: DiligentCore/Graphics/ShaderTools/CMakeFiles/Diligent-ShaderTools.dir/src/DXCompiler.cpp.o] Error 1 gmake[1]: *** [CMakeFiles/Makefile2:3521: DiligentCore/Graphics/ShaderTools/CMakeFiles/Diligent-ShaderTools.dir/all] Error 2 gmake: *** [Makefile:156: all] Error 2

I updated DXC headers, so this should work now - please try the latest version

A better way to fix this is to check

#ifndef __fastcall

Though I do really not understand why it only complains about __fastcall. All other macros are defined in the same way.

The __fastcall macro is already defined in /usr/include/sys/cdefs.h on line 365.

What I suggested is to use the #ifndef __fastcall guard instead of #ifndef PLATFORM_FREEBSD.
Also note that this file is a third-party header so with the next update, it may break again.

CMakeLists.txt

BuildTools/FormatValidation/validate_format_freebsd_implementation.sh

BuildTools/CMakeLists.txt

CMakeLists.txt

Graphics/Archiver/CMakeLists.txt

TheMostDiligent · 2024-02-01T07:32:26Z

ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h

@@ -342,7 +342,9 @@
 #define __stdcall
 #define __vectorcall
 #define __thiscall
+#ifndef PLATFORM_FREEBSD
 #define __fastcall


Which compiler are you using?

TheMostDiligent

I updated core module, so that format validation will be disabled on platforms that don't have the script.
Can you update to the latest version and try it?

LadySerenaKitty · 2024-02-01T18:47:35Z

I updated core module, so that format validation will be disabled on platforms that don't have the script. Can you update to the latest version and try it?

Format validation is successfully skipped (tested after deleting the scripts I added). Would you like a new push with the scripts removed?

TheMostDiligent · 2024-02-01T18:57:57Z

Would you like a new push with the scripts removed?

You can force-push to the same branch - the PR will be updated.

BuildTools/CMake/BuildUtils.cmake

BuildTools/CMakeLists.txt

Graphics/Archiver/CMakeLists.txt

Graphics/GraphicsEngineOpenGL/CMakeLists.txt

TheMostDiligent · 2024-02-05T23:17:50Z

ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h

@@ -342,7 +342,9 @@
 #define __stdcall
 #define __vectorcall
 #define __thiscall
+#ifndef PLATFORM_FREEBSD
 #define __fastcall


I updated DXC headers, so this should work now - please try the latest version

TheMostDiligent · 2024-02-05T23:18:56Z

CMakeLists.txt

@@ -513,6 +522,9 @@ else()
    set(DILIGENT_INSTALL_PDB OFF)
 endif()

+if(PLATFORM_FREEBSD AND EXISTS /usr/local/include)
+	target_include_directories(Diligent-BuildSettings SYSTEM AFTER INTERFACE /usr/local/include)


What errors do you get without this include?
This change does not seem right

It is quite correct. Without this, anything that isn't part of base will not be found.

FreeBSD! "base" is short for "base operating system" and is the stuff that's made by the FreeBSD Project - kernel and world. This includes everything outside of /usr/home and /usr/local, which isn't much.

A mirror of the source repo is available here, so you can see what all is part of FreeBSD's base: https://github.com/freebsd/freebsd-src

TheMostDiligent · 2024-02-19T06:15:31Z

CMakeLists.txt

@@ -520,6 +528,10 @@ else()
    set(DILIGENT_INSTALL_PDB OFF)
 endif()

+if(PLATFORM_FREEBSD AND EXISTS /usr/local/include)
+    target_include_directories(Diligent-BuildSettings SYSTEM AFTER INTERFACE /usr/local/include)


I tried to find some info about this problem, and I think that the right way to fix this is to set CMAKE_REQUIRED_INCLUDES at your project's CMake level:

dotnet/runtime#4073

Did you try setting the CMAKE_REQUIRED_INCLUDES in your project CMake?

TheMostDiligent

Sorry for a long delay with response.

Platforms/Linux/src/LinuxPlatformMisc.cpp

TheMostDiligent · 2024-02-19T06:18:19Z

ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h

@@ -342,7 +342,9 @@
 #define __stdcall
 #define __vectorcall
 #define __thiscall
+#ifndef PLATFORM_FREEBSD
 #define __fastcall


A better way to fix this is to check

#ifndef __fastcall

Though I do really not understand why it only complains about __fastcall. All other macros are defined in the same way.

TheMostDiligent · 2024-02-24T06:09:11Z

ThirdParty/DirectXShaderCompiler/dxc/WinAdapter.h

@@ -342,7 +342,9 @@
 #define __stdcall
 #define __vectorcall
 #define __thiscall
+#ifndef PLATFORM_FREEBSD
 #define __fastcall


What I suggested is to use the #ifndef __fastcall guard instead of #ifndef PLATFORM_FREEBSD.
Also note that this file is a third-party header so with the next update, it may break again.

TheMostDiligent · 2024-02-24T06:11:13Z

CMakeLists.txt

@@ -520,6 +528,10 @@ else()
    set(DILIGENT_INSTALL_PDB OFF)
 endif()

+if(PLATFORM_FREEBSD AND EXISTS /usr/local/include)
+    target_include_directories(Diligent-BuildSettings SYSTEM AFTER INTERFACE /usr/local/include)


Did you try setting the CMAKE_REQUIRED_INCLUDES in your project CMake?

LadySerenaKitty requested a review from TheMostDiligent as a code owner January 31, 2024 07:32

TheMostDiligent reviewed Jan 31, 2024

View reviewed changes

TheMostDiligent reviewed Feb 1, 2024

View reviewed changes

TheMostDiligent requested changes Feb 1, 2024

View reviewed changes

TheMostDiligent reviewed Feb 1, 2024

View reviewed changes

BuildTools/CMake/BuildUtils.cmake Outdated Show resolved Hide resolved

LadySerenaKitty force-pushed the master branch 2 times, most recently from d41441e to 73ac8e7 Compare February 2, 2024 17:48

LadySerenaKitty commented Feb 2, 2024

View reviewed changes

BuildTools/CMakeLists.txt Show resolved Hide resolved

TheMostDiligent requested changes Feb 5, 2024

View reviewed changes

LadySerenaKitty force-pushed the master branch from f526296 to 12cdfe3 Compare February 6, 2024 10:05

TheMostDiligent reviewed Feb 19, 2024

View reviewed changes

TheMostDiligent requested changes Feb 19, 2024

View reviewed changes

These things here work on FreeBSD

f72ae4c

TheMostDiligent force-pushed the master branch from 12cdfe3 to f72ae4c Compare February 19, 2024 06:19

TheMostDiligent requested changes Feb 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding FreeBSD build support. #460

Adding FreeBSD build support. #460

LadySerenaKitty commented Jan 31, 2024

TheMostDiligent Jan 31, 2024

LadySerenaKitty Jan 31, 2024

TheMostDiligent Feb 1, 2024

LadySerenaKitty Feb 1, 2024

TheMostDiligent Feb 2, 2024

LadySerenaKitty Feb 2, 2024

TheMostDiligent Feb 5, 2024

TheMostDiligent Feb 19, 2024

LadySerenaKitty Feb 19, 2024

TheMostDiligent Feb 24, 2024

TheMostDiligent Feb 1, 2024

TheMostDiligent left a comment

LadySerenaKitty commented Feb 1, 2024

TheMostDiligent commented Feb 1, 2024

TheMostDiligent Feb 5, 2024

TheMostDiligent Feb 5, 2024

LadySerenaKitty Feb 6, 2024

TheMostDiligent Feb 6, 2024

LadySerenaKitty Feb 6, 2024

TheMostDiligent Feb 19, 2024

TheMostDiligent Feb 24, 2024

TheMostDiligent left a comment

TheMostDiligent Feb 19, 2024

TheMostDiligent Feb 24, 2024

TheMostDiligent Feb 24, 2024

Adding FreeBSD build support. #460

Are you sure you want to change the base?

Adding FreeBSD build support. #460

Conversation

LadySerenaKitty commented Jan 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheMostDiligent left a comment

Choose a reason for hiding this comment

LadySerenaKitty commented Feb 1, 2024

TheMostDiligent commented Feb 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheMostDiligent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment