cmake: deeply rewrite the NaCl toolchains

Author: illwieckz

CMakeLists.txt

@@ -289,6 +289,7 @@ endif()
 # meaning we have to detect useless engine compiler to set
 # useless engine flags when only building vms.
 include(DaemonFlags)
+include(DaemonNaclFlags)
 
 # FIXME: Once engine flags would be only set when building the engine
 # this would be likely unused by vms as they are built by DaemonGame.
@@ -460,7 +461,6 @@ endif()
 # LIBS_BASE, LIBS_ENGINE_BASE LIBS_ENGINE, LIBS_BASECLIENT, LIBS_CLIENT
 
 # Native client
-include(DaemonNacl)
 if (YOKAI_TARGET_SYSTEM_NACL)
     add_library(srclibs-nacl-module EXCLUDE_FROM_ALL ${NACLLIST_MODULE})
     set(LIBS_BASE ${LIBS_BASE} srclibs-nacl-module)
@@ -481,16 +481,6 @@ elseif (YOKAI_TARGET_SYSTEM_NACL)
     find_library(NACL_EXCEPTION nacl_exception)
     find_library(NACL_MINIDUMP minidump_generator)
 
-    # HACK: To be removed when Saigo is repackaged properly.
-    if (NOT NACL_MINIDUMP
-    # NACL_TARGET is specific to Saigo, PNaCl target is le32 and doesn't set NACL_TARGET.
-    AND "${NACL_TARGET}" STREQUAL "i686"
-    # x86_64-nacl/lib32 is specific to Google build, other builds may provide i686-nacl/lib instead.
-    AND EXISTS "${DEPS_DIR}/saigo_newlib/x86_64-nacl/lib32")
-        set(NACL_EXCEPTION "${DEPS_DIR}/saigo_newlib/x86_64-nacl/lib32/libnacl_exception.a")
-        set(NACL_MINIDUMP "${DEPS_DIR}/saigo_newlib/x86_64-nacl/lib32/libminidump_generator.a")
-    endif()
-
     set(LIBS_BASE ${LIBS_BASE} ${NACL_MINIDUMP} ${NACL_EXCEPTION})
 else()
     find_library(LIBM m)

cmake/DaemonGame.cmake

@@ -44,9 +44,9 @@ include(Yokai/All)
 
 # Do not report unused native compiler if native vms are not built.
 # If only NACL vms are built, this will be reported in chainloaded build.
-if (BUILD_GAME_NATIVE_DLL OR BUILD_GAME_NATIVE_EXE OR NACL)
-    include(DaemonNacl)
+if (BUILD_GAME_NATIVE_DLL OR BUILD_GAME_NATIVE_EXE OR GAME_BUILD_SUBINVOCATION)
     include(DaemonFlags)
+    include(DaemonNaclFlags)
 endif()
 
 # Source lists for src/shared
@@ -68,7 +68,11 @@ set(SHAREDLIST_sgame
 # Function to setup all the Sgame/Cgame libraries
 include(CMakeParseArguments)
 
-if (NOT FORK EQUAL 2)
+list(APPEND NACL_ALL_TARGETS "amd64" "i686" "armhf")
+
+if (NOT GAME_BUILD_SUBINVOCATION)
+	option(USE_NACL_SAIGO "Use the Saigo toolchain to build NaCl executables" OFF)
+
 	if (USE_NACL_SAIGO)
 		set(HAS_NACL_SDK ON)
 	elseif (CMAKE_SYSTEM_NAME STREQUAL CMAKE_HOST_SYSTEM_NAME
@@ -83,7 +87,6 @@ if (NOT FORK EQUAL 2)
 		# can be loaded by daemon with vm.[sc]game.type 0 or 1
 		option(BUILD_GAME_NACL "Build the NaCl \"pexe\" and \"nexe\" gamelogic modules for enabled architecture targets, required to host mods." OFF)
 
-		set(NACL_ALL_TARGETS "amd64;i686;armhf")
 		set(BUILD_GAME_NACL_TARGETS "all" CACHE STRING "Enabled NaCl \"nexe\" architecture targets, values: ${NACL_ALL_TARGETS};all;native;none")
 		mark_as_advanced(BUILD_GAME_NACL_TARGETS)
 
@@ -147,7 +150,7 @@ function(buildGameModule module_slug)
 	if (module_slug STREQUAL "nacl")
 		set_target_properties(${module_target} PROPERTIES
 			OUTPUT_NAME "${GAMEMODULE_NAME}"
-			SUFFIX "${PLATFORM_EXE_SUFFIX}")
+			SUFFIX "${NACL_EXECUTABLE_SUFFIX}")
 
 		target_link_libraries(${module_target} ${GAMEMODULE_LIBS} ${LIBS_BASE})
 	else()
@@ -163,13 +166,13 @@ function(gameSubProject)
 		BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/${NACL_VMS_PROJECT}
 		CMAKE_GENERATOR ${VM_GENERATOR}
 		CMAKE_ARGS
-			-DFORK=2
-			-DDAEMON_DIR=${Daemon_SOURCE_DIR}
-			-DDEPS_DIR=${DEPS_DIR}
+			"-DDAEMON_DIR=${Daemon_SOURCE_DIR}"
+			"-DDEPS_DIR=${DEPS_DIR}"
 			-DBUILD_CLIENT=OFF
 			-DBUILD_TTY_CLIENT=OFF
 			-DBUILD_SERVER=OFF
-			-DBUILD_DUMMY_GAMELOGIC=${BUILD_DUMMY_GAMELOGIC}
+			"-DBUILD_DUMMY_GAMELOGIC=${BUILD_DUMMY_GAMELOGIC}"
+			-DGAME_BUILD_SUBINVOCATION=ON
 			${ARGV}
 			${INHERITED_OPTION_ARGS}
 		INSTALL_COMMAND ""
@@ -199,8 +202,9 @@ function(GAMEMODULE)
 		buildGameModule("native-exe")
 	endif()
 
-	if (NOT FORK) # create the nacl-vms target only the first time that GAMEMODULE is called
-		set(FORK 1 PARENT_SCOPE)
+	if (NOT NACL_VMS_TARGET_CREATED AND NOT GAME_BUILD_SUBINVOCATION)
+		# Create the nacl-vms target only the first time that GAMEMODULE is called.
+		set(NACL_VMS_TARGET_CREATED ON PARENT_SCOPE)
 
 		if (CMAKE_GENERATOR MATCHES "Visual Studio")
 			set(VM_GENERATOR "NMake Makefiles")
@@ -215,33 +219,27 @@ function(GAMEMODULE)
 				"-D${inherited_option}=${${inherited_option}}")
 		endforeach(inherited_option)
 
-		if (BUILD_GAME_NACL)
+		if (BUILD_GAME_NACL AND NOT YOKAI_TARGET_SYSTEM_NACL)
 			if (USE_NACL_SAIGO)
 				add_custom_target(nacl-vms ALL)
 				unset(NACL_VMS_PROJECTS)
 
-				foreach(NACL_TARGET IN LISTS NACL_TARGETS)
-					if (NACL_TARGET STREQUAL "i686")
-						set(SAIGO_ARCH "i686")
-					elseif (NACL_TARGET STREQUAL "amd64")
-						set(SAIGO_ARCH "x86_64")
-					elseif (NACL_TARGET STREQUAL "armhf")
-						set(SAIGO_ARCH "arm")
-					else()
+				foreach(nacl_target IN LISTS NACL_TARGETS)
+					if (NOT nacl_target IN_LIST NACL_ALL_TARGETS)
 						message(FATAL_ERROR "Unknown NaCl architecture ${NACL_TARGET}")
 					endif()
 
-					set(NACL_VMS_PROJECT nacl-vms-${NACL_TARGET})
+					set(NACL_VMS_PROJECT nacl-vms-${nacl_target})
 					list(APPEND NACL_VMS_PROJECTS ${NACL_VMS_PROJECT})
 					add_dependencies(nacl-vms ${NACL_VMS_PROJECT})
 
+					# TODO: Remove USE_NACL_SAIGO once the game uses YOKAI_TARGET_SYSTEM_NACL.
 					gameSubProject(
-						-DCMAKE_TOOLCHAIN_FILE=${Daemon_SOURCE_DIR}/cmake/toolchain-saigo.cmake
+						"-DCMAKE_TOOLCHAIN_FILE=${Daemon_SOURCE_DIR}/cmake/cross-toolchain-saigo-${nacl_target}.cmake"
+						"-DPREFIX_SAIGO=${DEPS_DIR}/saigo_newlib"
 						-DBUILD_GAME_NACL=ON
 						-DBUILD_GAME_NATIVE_DLL=OFF
 						-DBUILD_GAME_NATIVE_EXE=OFF
-						-DSAIGO_ARCH=${SAIGO_ARCH}
-						-DNACL_TARGET=${NACL_TARGET}
 						-DUSE_NACL_SAIGO=ON
 					)
 				endforeach()
@@ -253,19 +251,20 @@ function(GAMEMODULE)
 				string(REPLACE ";" "," NACL_TARGETS_STRING "${NACL_TARGETS}")
 
 				gameSubProject(
-					-DCMAKE_TOOLCHAIN_FILE=${Daemon_SOURCE_DIR}/cmake/toolchain-pnacl.cmake
+					"-DCMAKE_TOOLCHAIN_FILE=${Daemon_SOURCE_DIR}/cmake/cross-toolchain-pnacl.cmake"
+					"-DPREFIX_PNACL=${DEPS_DIR}/pnacl"
 					-DBUILD_GAME_NACL=ON
 					-DBUILD_GAME_NATIVE_DLL=OFF
 					-DBUILD_GAME_NATIVE_EXE=OFF
-					-DNACL_TARGETS_STRING=${NACL_TARGETS_STRING}
+					"-DNACL_TARGETS_STRING=${NACL_TARGETS_STRING}"
 				)
 			endif()
 		endif()
 
 		set(NACL_VMS_PROJECTS ${NACL_VMS_PROJECTS} PARENT_SCOPE)
-	elseif (FORK EQUAL 2) # we are in the CMake sub-invocation for NaCl
+	elseif (GAME_BUILD_SUBINVOCATION)
 		if (BUILD_GAME_NACL)
-			if (USE_NACL_SAIGO)
+			if (YOKAI_CXX_COMPILER_SAIGO)
 				set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 			else()
 				# Put the .nexe and .pexe files in the same directory as the engine.
@@ -274,16 +273,28 @@ function(GAMEMODULE)
 
 			buildGameModule("nacl")
 
-			if (USE_NACL_SAIGO)
+			if (YOKAI_CXX_COMPILER_SAIGO)
+				include(DaemonSaigoFinalize)
+
 				# Finalize NaCl executables for supported architectures.
-				saigo_finalize(${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/.. ${GAMEMODULE_NAME} ${NACL_TARGET})
+				saigo_finalize(
+					"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}"
+					"${GAMEMODULE_NAME}"
+					"${YOKAI_TARGET_ARCH_NAME}"
+				)
 			else()
+				include(DaemonPNaClFinalize)
+
 				# Revert a workaround for a bug where CMake ExternalProject lists-as-args are cut on first “;”
 				string(REPLACE "," ";" NACL_TARGETS "${NACL_TARGETS_STRING}")
 
 				# Generate NaCl executables for supported architectures.
-				foreach(NACL_TARGET ${NACL_TARGETS})
-					pnacl_finalize(${CMAKE_RUNTIME_OUTPUT_DIRECTORY} ${GAMEMODULE_NAME} ${NACL_TARGET})
+				foreach(nacl_target ${NACL_TARGETS})
+					pnacl_finalize(
+						"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}"
+						"${GAMEMODULE_NAME}"
+						"${nacl_target}"
+					)
 				endforeach()
 			endif()
 		endif()

cmake/DaemonNacl.cmake

@@ -0,0 +1,75 @@
+# Daemon BSD Source Code
+# Copyright (c) 2013-2026, Daemon Developers
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#  * Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+#  * Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#  * Neither the name of the Daemon developers nor the
+#    names of its contributors may be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL DAEMON DEVELOPERS BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Native Client build configuration.
+
+if (YOKAI_TARGET_SYSTEM_NACL)
+	# Build nexe binary.
+
+	if (YOKAI_CXX_COMPILER_SAIGO)
+		if (YOKAI_TARGET_ARCH_AMD64)
+			add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=64)
+		elseif (YOKAI_TARGET_ARCH_I686)
+			add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=32)
+		elseif (YOKAI_TARGET_ARCH_ARMHF)
+			add_definitions(-DNACL_BUILD_ARCH=arm)
+		else()
+			message(FATAL_ERROR "Unsupported architecture ${NACL_TARGET}")
+		endif()
+	else()
+		# Those defines looks to be meaningless to produce arch-independent pexe
+		# with PNaCl but they must be set to anything supported by native builds.
+		# This requirement looks to be a PNaCl bug.
+		add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=64)
+	endif()
+else()
+	# Build native dll or native exe.
+
+	if (YOKAI_TARGET_SYSTEM_MACOS)
+		add_definitions(-DNACL_WINDOWS=0 -DNACL_LINUX=0 -DNACL_ANDROID=0 -DNACL_FREEBSD=0 -DNACL_OSX=1)
+	elseif (YOKAI_TARGET_SYSTEM_LINUX)
+		add_definitions(-DNACL_WINDOWS=0 -DNACL_LINUX=1 -DNACL_ANDROID=0 -DNACL_FREEBSD=0 -DNACL_OSX=0)
+	elseif (YOKAI_TARGET_SYSTEM_FREEBSD)
+		add_definitions(-DNACL_WINDOWS=0 -DNACL_LINUX=0 -DNACL_ANDROID=0 -DNACL_FREEBSD=1 -DNACL_OSX=0)
+	elseif (YOKAI_TARGET_SYSTEM_WINDOWS)
+		add_definitions(-DNACL_WINDOWS=1 -DNACL_LINUX=0 -DNACL_ANDROID=0 -DNACL_FREEBSD=0 -DNACL_OSX=0)
+	endif()
+
+	if (YOKAI_TARGET_ARCH_AMD64)
+		add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=64)
+	elseif (YOKAI_TARGET_ARCH_I686)
+		add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=32)
+	elseif (YOKAI_TARGET_ARCH_ARMHF)
+		add_definitions(-DNACL_BUILD_ARCH=arm)
+	else()
+		# NaCl does not support this architecture natively, but these defines must
+		# be set because nacl_config.h is included unconditionally. Use dummy x86
+		# values as PNaCl does for architecture-independent builds.
+		add_definitions(-DNACL_BUILD_ARCH=x86 -DNACL_BUILD_SUBARCH=64)
+	endif()
+endif()
+
+include_directories(${LIB_DIR}/nacl)