Merge pull request #59 from spicyjpeg/psxmdec

IRQ handler fix, .STR playback example, multiple library builds (v0.21)

1 files changed, 156 insertions, 129 deletions

diff --git a/libpsn00b/cmake/internal_setup.cmake b/libpsn00b/cmake/internal_setup.cmake
index d293127..e78355f 100644
--- a/libpsn00b/cmake/internal_setup.cmake
+++ b/libpsn00b/cmake/internal_setup.cmake
@@ -1,12 +1,29 @@
 # PSn00bSDK internal setup script for CMake
-# (C) 2021 spicyjpeg - MPL licensed
+# (C) 2021-2022 spicyjpeg - MPL licensed
 
 # This script is included automatically when using the toolchain file and
 # defines helper functions.
 
-cmake_minimum_required(VERSION 3.20)
+cmake_minimum_required(VERSION 3.21)
 include(GNUInstallDirs)
 
+## CMake configuration
+
+# Setting these variables and properties would technically be the toolchain
+# script's responsibility, however they are overridden by project() so their
+# setting is deferred to this script.
+set(CMAKE_EXECUTABLE_SUFFIX     ".elf")
+set(CMAKE_STATIC_LIBRARY_PREFIX "lib")
+set(CMAKE_STATIC_LIBRARY_SUFFIX ".a")
+set(CMAKE_SHARED_LIBRARY_PREFIX "")
+set(CMAKE_SHARED_LIBRARY_SUFFIX ".so")
+set(CMAKE_SHARED_MODULE_PREFIX  "")
+set(CMAKE_SHARED_MODULE_SUFFIX  ".so")
+
+set_property(GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS ON)
+
+## PSn00bSDK initialization
+
 # Fetch SDK version information from build.json.
 if(NOT DEFINED PSN00BSDK_VERSION)
 	file(READ ${CMAKE_CURRENT_LIST_DIR}/../build.json _json)
@@ -17,13 +34,10 @@ if(NOT DEFINED PSN00BSDK_VERSION)
 	string(JSON PSN00BSDK_GIT_COMMIT GET ${_json} git_commit)
 endif()
 
-## Settings (can be overridden by projects)
-
-set(PSN00BSDK_EXECUTABLE_SUFFIX     ".exe")
-set(PSN00BSDK_SHARED_LIBRARY_SUFFIX ".dll")
-set(PSN00BSDK_SYMBOL_MAP_SUFFIX     ".map")
-
-## SDK libraries
+include(${CMAKE_CURRENT_LIST_DIR}/../libpsn00b.cmake OPTIONAL)
+if(TARGET psn00bsdk)
+	link_libraries(psn00bsdk)
+endif()
 
 # DON'T CHANGE THE ORDER or you'll break the libraries' internal dependencies.
 set(
@@ -40,33 +54,33 @@ set(
 		c
 )
 
-include(${CMAKE_CURRENT_LIST_DIR}/libpsn00b.cmake OPTIONAL)
-include(${CMAKE_CURRENT_LIST_DIR}/flags.cmake)
+## Settings (can be overridden by projects)
 
-# Use the toolchain path to find libgcc (used to build libpsn00b). Of course
-# different installers, packages and distros have different opinions when it
-# comes to deciding where to install toolchains, so we have to bruteforce
-# multiple combinations of paths.
-if(CMAKE_C_COMPILER_VERSION)
-	string(REGEX MATCH "^([0-9]+)\." _dummy ${CMAKE_C_COMPILER_VERSION})
+set(PSN00BSDK_EXECUTABLE_LINK_LIBRARIES     ${PSN00BSDK_LIBRARIES})
+set(PSN00BSDK_SHARED_LIBRARY_LINK_LIBRARIES "")
 
-	find_library(
-		PSN00BSDK_LIBGCC gcc
-		HINTS
-			${PSN00BSDK_TC}/lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
-			${PSN00BSDK_TC}/lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
-			${PSN00BSDK_TC}/lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
-			${PSN00BSDK_TC}/lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
-			${PSN00BSDK_TC}/../lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
-			${PSN00BSDK_TC}/../lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
-			${PSN00BSDK_TC}/../lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
-			${PSN00BSDK_TC}/../lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
-		NO_DEFAULT_PATH
-		DOC "Path to libgcc (bundled with the GCC toolchain)"
-	)
+set(PSN00BSDK_EXECUTABLE_SUFFIX     ".exe")
+set(PSN00BSDK_SHARED_LIBRARY_SUFFIX ".dll")
+set(PSN00BSDK_SYMBOL_MAP_SUFFIX     ".map")
+
+define_property(
+	TARGET PROPERTY PSN00BSDK_TARGET_TYPE
+	BRIEF_DOCS      "Type of this target (EXECUTABLE_GPREL, EXECUTABLE_NOGPREL or SHARED_LIBRARY)"
+	FULL_DOCS       "Type of this target (if executable or DLL) or of the executable/DLL this target is going to be linked to (if static library)"
+)
+
+## Include paths
+
+set(PSN00BSDK_LDSCRIPTS ${CMAKE_CURRENT_LIST_DIR}/../ldscripts)
+if(IS_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../include)
+	set(PSN00BSDK_INCLUDE ${CMAKE_CURRENT_LIST_DIR}/../include)
+else()
+	set(PSN00BSDK_INCLUDE ${CMAKE_CURRENT_LIST_DIR}/../../../include/libpsn00b)
 endif()
 
-## Tools
+include_directories(AFTER ${PSN00BSDK_INCLUDE})
+
+## Tool paths
 
 set(
 	PSN00BSDK_TOOLS
@@ -80,24 +94,49 @@ find_program(SMXLINK  smxlink  HINTS ${PSN00BSDK_TOOLS})
 find_program(LZPACK   lzpack   HINTS ${PSN00BSDK_TOOLS})
 find_program(MKPSXISO mkpsxiso HINTS ${PSN00BSDK_TOOLS})
 
-## Helper functions for executables
+## libgcc
 
-set(PSN00BSDK_LDSCRIPTS ${CMAKE_CURRENT_LIST_DIR}/../ldscripts)
-if(IS_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../include)
-	set(PSN00BSDK_INCLUDE ${CMAKE_CURRENT_LIST_DIR}/../include)
-else()
-	set(PSN00BSDK_INCLUDE ${CMAKE_CURRENT_LIST_DIR}/../../../include/libpsn00b)
+# Use the toolchain path to find libgcc. Of course different installers,
+# packages and distros have different opinions when it comes to deciding where
+# to install toolchains, so we have to bruteforce multiple combinations of
+# paths.
+if(CMAKE_C_COMPILER_VERSION)
+	string(REGEX MATCH "^([0-9]+)\." _dummy ${CMAKE_C_COMPILER_VERSION})
+
+	find_library(
+		PSN00BSDK_LIBGCC gcc #REQUIRED
+		HINTS
+			${PSN00BSDK_TC}/lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
+			${PSN00BSDK_TC}/lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
+			${PSN00BSDK_TC}/lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
+			${PSN00BSDK_TC}/lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
+			${PSN00BSDK_TC}/../lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
+			${PSN00BSDK_TC}/../lib/gcc-cross/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
+			${PSN00BSDK_TC}/../lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_C_COMPILER_VERSION}
+			${PSN00BSDK_TC}/../lib/gcc/${PSN00BSDK_TARGET}/${CMAKE_MATCH_1}
+		NO_DEFAULT_PATH
+		DOC "Path to libgcc (bundled with the GCC toolchain)"
+	)
+	if(PSN00BSDK_LIBGCC STREQUAL "PSN00BSDK_LIBGCC-NOTFOUND")
+		message(FATAL_ERROR "Failed to find libgcc in the GCC toolchain's files. Check your toolchain settings, or set the path to libgcc using -DPSN00BSDK_LIBGCC.")
+	endif()
+
+	add_library          (gcc STATIC IMPORTED)
+	set_target_properties(gcc PROPERTIES IMPORTED_LOCATION ${PSN00BSDK_LIBGCC})
+	link_libraries       (gcc)
 endif()
 
-# psn00bsdk_add_executable(
-#   <target name> <STATIC|DYNAMIC>
-#   [EXCLUDE_FROM_ALL]
-#   <sources> ...
-# )
+## Target helpers
+
 function(psn00bsdk_add_executable name type)
-	string(TOLOWER ${type} _type)
-	if(NOT ${_type} MATCHES "^(static|dynamic)$")
-		message(FATAL_ERROR "Invalid executable type: ${type} (must be STATIC or DYNAMIC)")
+	string(TOUPPER ${type} _type)
+
+	if(_type MATCHES "^(STATIC|GPREL)$")
+		set(_type EXECUTABLE_GPREL)
+	elseif(_type MATCHES "^(DYNAMIC|NOGPREL)$")
+		set(_type EXECUTABLE_NOGPREL)
+	else()
+		message(FATAL_ERROR "Invalid executable type: ${type} (must be STATIC, GPREL, DYNAMIC or NOGPREL)")
 	endif()
 
 	# Throw an error if elf2x was not found (which should never happen if the
@@ -107,111 +146,79 @@ function(psn00bsdk_add_executable name type)
 	endif()
 
 	add_executable       (${name} ${ARGN})
-	target_link_libraries(${name} psn00bsdk_${_type}_exe ${PSN00BSDK_LIBRARIES})
-	set_target_properties(${name} PROPERTIES PREFIX "" SUFFIX ".elf")
-	target_link_options  (${name} PRIVATE -T${PSN00BSDK_LDSCRIPTS}/exe.ld)
-
-	target_include_directories(${name} PRIVATE ${PSN00BSDK_INCLUDE})
+	set_target_properties(${name} PROPERTIES PSN00BSDK_TARGET_TYPE ${_type})
+	target_link_libraries(${name} PRIVATE ${PSN00BSDK_EXECUTABLE_LINK_LIBRARIES})
+	target_link_options  (${name} PRIVATE -T$<SHELL_PATH:${PSN00BSDK_LDSCRIPTS}/exe.ld>)
 
 	# Add post-build steps to generate the .exe and symbol map once the
 	# executable is built.
+	# FIXME: CMake does not (yet) allow target-dependent generator expressions
+	# to specify the byproducts, so we have to make sure the generated files
+	# have no prefix/suffix and are in the current build directory.
+	#set(_repl PATH:REPLACE_EXTENSION,LAST_ONLY,$<TARGET_FILE:${name}>)
 	add_custom_command(
-		TARGET     ${name} POST_BUILD
-		COMMAND    ${ELF2X} -q ${name}.elf ${name}${PSN00BSDK_EXECUTABLE_SUFFIX}
-		COMMAND    ${TOOLCHAIN_NM} -f posix -l -n ${name}.elf $<ANGLE-R>${name}${PSN00BSDK_SYMBOL_MAP_SUFFIX}
-		BYPRODUCTS ${name}${PSN00BSDK_EXECUTABLE_SUFFIX} ${name}${PSN00BSDK_SYMBOL_MAP_SUFFIX}
+		TARGET ${name} POST_BUILD
+		COMMAND
+			${ELF2X} -q
+			$<SHELL_PATH:$<TARGET_FILE:${name}>>
+			#$<SHELL_PATH:$<${_repl},${PSN00BSDK_EXECUTABLE_SUFFIX}>>
+			$<SHELL_PATH:${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_EXECUTABLE_SUFFIX}>
+		COMMAND
+			${TOOLCHAIN_NM} -f posix -l -n
+			$<SHELL_PATH:$<TARGET_FILE:${name}>>
+			#$<ANGLE-R>$<SHELL_PATH:$<${_repl},${PSN00BSDK_SYMBOL_MAP_SUFFIX}>>
+			$<ANGLE-R>$<SHELL_PATH:${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_SYMBOL_MAP_SUFFIX}>
+		BYPRODUCTS
+			#$<${_repl},${PSN00BSDK_EXECUTABLE_SUFFIX}>
+			#$<${_repl},${PSN00BSDK_SYMBOL_MAP_SUFFIX}>
+			${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_EXECUTABLE_SUFFIX}
+			${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_SYMBOL_MAP_SUFFIX}
 	)
 endfunction()
 
-# psn00bsdk_add_library(
-#   <target name> <STATIC|SHARED|MODULE>
-#   [EXCLUDE_FROM_ALL]
-#   <sources> ...
-# )
-# Note that SHARED and MODULE have the same meaning (both will create a DLL).
-# SDK libraries are NOT statically linked in by default; if you need to link
-# something, use target_link_libraries() manually.
 function(psn00bsdk_add_library name type)
-	string(TOUPPER ${type} _type_upper)
-	string(TOLOWER ${type} _type)
-	if(NOT ${_type} MATCHES "^(static|object|shared|module)$")
-		message(FATAL_ERROR "Invalid library type: ${type} (must be STATIC, OBJECT, SHARED or MODULE)")
-	endif()
+	string(TOUPPER ${type} _type)
 
-	add_library          (${name} ${_type_upper} ${ARGN})
-	target_link_libraries(${name} psn00bsdk_${_type}_lib)
-
-	target_include_directories(${name} PRIVATE ${PSN00BSDK_INCLUDE})
-
-	if(${_type} MATCHES "^(shared|module)$")
-		set_target_properties(${name} PROPERTIES PREFIX "" SUFFIX ".so")
-		target_link_options  (${name} PRIVATE -T${PSN00BSDK_LDSCRIPTS}/dll.ld)
+	if(_type MATCHES "^(STATIC|OBJECT)$")
+		add_library          (${name} ${_type} ${ARGN})
+		#target_link_libraries(${name} PRIVATE psn00bsdk)
+	elseif(_type MATCHES "^(SHARED|MODULE)$")
+		add_library          (${name} ${_type} ${ARGN})
+		set_target_properties(${name} PROPERTIES PSN00BSDK_TARGET_TYPE SHARED_LIBRARY)
+		target_link_libraries(${name} PRIVATE ${PSN00BSDK_SHARED_LIBRARY_LINK_LIBRARIES})
+		target_link_options  (${name} PRIVATE -T$<SHELL_PATH:${PSN00BSDK_LDSCRIPTS}/dll.ld>)
 
 		# Add a post-build step to dump the DLL's raw contents into a new file
 		# separate from the built ELF.
+		#set(_repl PATH:REPLACE_EXTENSION,LAST_ONLY,$<TARGET_FILE:${name}>)
 		add_custom_command(
-			TARGET     ${name} POST_BUILD
-			COMMAND    ${CMAKE_OBJCOPY} -O binary ${name}.so ${name}${PSN00BSDK_SHARED_LIBRARY_SUFFIX}
-			BYPRODUCTS ${name}${PSN00BSDK_SHARED_LIBRARY_SUFFIX}
+			TARGET ${name} POST_BUILD
+			COMMAND
+				${CMAKE_OBJCOPY} -O binary
+				$<SHELL_PATH:$<TARGET_FILE:${name}>>
+				#$<SHELL_PATH:$<${_repl},${PSN00BSDK_SHARED_LIBRARY_SUFFIX}>>
+				$<SHELL_PATH:${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_SHARED_LIBRARY_SUFFIX}>
+			#BYPRODUCTS $<${_repl},${PSN00BSDK_SHARED_LIBRARY_SUFFIX}>
+			BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/${name}${PSN00BSDK_SHARED_LIBRARY_SUFFIX}
 		)
 	else()
-		set_target_properties(${name} PROPERTIES PREFIX "lib" SUFFIX ".a")
-
-		# Remove virtual target dependencies to make sure linking against the
-		# library does not also propagate static library flags.
-		set_target_properties(${name} PROPERTIES INTERFACE_LINK_LIBRARIES "")
-	endif()
-endfunction()
-
-# psn00bsdk_add_cd_image(
-#   <target name>
-#   <image file name>
-#   <mkpsxiso config template>
-#   [DEPENDS <dependencies> ...]
-#   [additional options passed to add_custom_target()]
-# )
-function(psn00bsdk_add_cd_image name image_name config_file)
-	# Throw an error if mkpsxiso was not found. Performing this check manually
-	# (instead of just marking mkpsxiso as required) allows simple projects to
-	# be built even if mkpsxiso is not installed.
-	if(MKPSXISO STREQUAL "MKPSXISO-NOTFOUND")
-		message(FATAL_ERROR "Failed to locate mkpsxiso. If mkpsxiso wasn't installed alongside the SDK, check your PATH environment variable.")
+		message(FATAL_ERROR "Invalid library type: ${type} (must be STATIC, OBJECT, SHARED or MODULE)")
 	endif()
-
-	cmake_path(HASH config_file _hash)
-
-	set(CD_IMAGE_NAME  ${image_name})
-	set(CD_CONFIG_FILE cd_image_${_hash}.xml)
-	configure_file(${config_file} ${CD_CONFIG_FILE})
-
-	add_custom_target(
-		${name} ALL
-		COMMAND    ${MKPSXISO} -y ${CD_CONFIG_FILE}
-		BYPRODUCTS ${image_name}.bin ${image_name}.cue
-		COMMENT    "Building CD image ${image_name}"
-		${ARGN}
-	)
 endfunction()
 
-## Helper functions for assets
+## Linking helpers
 
-# psn00bsdk_target_incbin_a(
-#   <existing target name> <PRIVATE|PUBLIC|INTERFACE>
-#   <data symbol name>
-#   <size symbol name>
-#   <path to binary file>
-#   <linker section name>
-#   <alignment>
-# )
 function(psn00bsdk_target_incbin_a name type symbol_name size_name path section align)
 	string(MAKE_C_IDENTIFIER ${symbol_name} _id)
 	string(MAKE_C_IDENTIFIER ${size_name}   _size)
 	cmake_path(ABSOLUTE_PATH path OUTPUT_VARIABLE _path)
 
+	string(SHA1 _hash "${name} ${_id}")
+	set(_asm_file ${CMAKE_CURRENT_BINARY_DIR}/incbin_${_hash}.s)
+
 	# Generate an assembly source file that includes the binary file and add it
 	# to the target's sources. The file is also added as a depedency to ensure
 	# CMake builds it before the target (if it's not a static file).
-	set(_asm_file ${PROJECT_BINARY_DIR}/incbin_${name}_${_id}.s)
 	file(
 		CONFIGURE
 		OUTPUT  ${_asm_file}
@@ -246,11 +253,6 @@ ${_size}:
 	set_source_files_properties(${_asm_file} PROPERTIES OBJECT_DEPENDS ${_path})
 endfunction()
 
-# psn00bsdk_target_incbin(
-#   <existing target name> <PRIVATE|PUBLIC|INTERFACE>
-#   <symbol name>
-#   <path to binary file>
-# )
 function(psn00bsdk_target_incbin name type symbol_name path)
 	string(MAKE_C_IDENTIFIER ${symbol_name} _id)
 
@@ -264,3 +266,28 @@ function(psn00bsdk_target_incbin name type symbol_name path)
 		4
 	)
 endfunction()
+
+## CD image and asset helpers
+
+function(psn00bsdk_add_cd_image name image_name config_file)
+	# Throw an error if mkpsxiso was not found. Performing this check manually
+	# (instead of just marking mkpsxiso as required) allows simple projects to
+	# be built even if mkpsxiso is not installed.
+	if(MKPSXISO STREQUAL "MKPSXISO-NOTFOUND")
+		message(FATAL_ERROR "Failed to locate mkpsxiso. If mkpsxiso wasn't installed alongside the SDK, check your PATH environment variable.")
+	endif()
+
+	cmake_path(HASH config_file _hash)
+
+	set(CD_IMAGE_NAME  ${image_name})
+	set(CD_CONFIG_FILE cd_image_${_hash}.xml)
+	configure_file(${config_file} ${CD_CONFIG_FILE})
+
+	add_custom_target(
+		${name} ALL
+		COMMAND    ${MKPSXISO} -y ${CD_CONFIG_FILE}
+		BYPRODUCTS ${image_name}.bin ${image_name}.cue
+		COMMENT    "Building CD image ${image_name}"
+		${ARGN}
+	)
+endfunction()