beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-22 23:50:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/CMakeLists.txt

266 lines
9.6 KiB
Text
Raw Normal View History

CMake: Bump cmake_minimum_required to 3.25 The SerenityOS platform files we upstreamed were first released in version 3.25.0
2022-12-10 20:40:24 +00:00
cmake_minimum_required(VERSION 3.25)
Meta: Add Meta/CMake to the CMAKE_MODULE_PATH for Serenity and Lagom This makes it so we don't need to specify the full path to all the helper scripts we include() from different places in the codebase and feels a lot cleaner.
2021-09-07 07:50:09 +00:00
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/Meta/CMake")
Build: Allow using CMake 3.16 Because apparently that's what a lot of people have, and they report it works fine.
2020-05-15 07:52:37 +00:00
project(SerenityOS C CXX ASM)
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
cmake: Make setting CMAKE_BUILD_TYPE an error. I tried setting it to Release, then noticed that it didn't build due to gcc's optimizer-level dependent warnings and -Werror, then started fixing the warnings for a bit (all false positives), then looked at the global CMakeLists.txt and realized that the default build is aleady using compiler optimizations. It looks like people aren't supposed to change this, so make that explicit to be friendly to people familiar with cmake but new to serenity.
2020-06-06 01:23:31 +00:00
if(NOT "${CMAKE_BUILD_TYPE}" STREQUAL "")
CMake: Fix message levels for error conditions during configuration Make messages which should be fatal, actually fail the build. - FATAL is not a valid mode keyword. The full list is available in the docs: https://cmake.org/cmake/help/v3.19/command/message.html - SEND_ERROR doesn't immediately stop processing, FATAL_ERROR does. We should immediately stop if the Toolchain is not present. - The app icon size validation was just a WARNING that is easy to overlook. We should promote it to a FATAL_ERROR so that people will not overlook the issue when adding a new application. We can only make the small icon message FATAL_ERROR, as there is currently one violation of the medium app icon validation.
2021-05-13 11:15:35 +00:00
message(FATAL_ERROR
cmake: Make setting CMAKE_BUILD_TYPE an error. I tried setting it to Release, then noticed that it didn't build due to gcc's optimizer-level dependent warnings and -Werror, then started fixing the warnings for a bit (all false positives), then looked at the global CMakeLists.txt and realized that the default build is aleady using compiler optimizations. It looks like people aren't supposed to change this, so make that explicit to be friendly to people familiar with cmake but new to serenity.
2020-06-06 01:23:31 +00:00
": Don't use CMAKE_BUILD_TYPE when building serenity.\n"
"The default build type is optimized with debug info and asserts enabled,\n"
"and that's all there is.")
endif()
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
if(NOT CMAKE_SYSTEM_NAME STREQUAL "SerenityOS")
message(FATAL_ERROR "System name is not SerenityOS, this is unsupported.\n"
"Please re-read the BuildInstructions documentation, and use the superbuild configuration\n")
CMake: Verify the GCC host version is new enough to build serenity There are lots of people who have issues building serenity because they don't read the build directions closely enough and have an unsupported GCC version as their host compiler. Instead of repeatedly having to answer these kinds of questions, lets just error out upfront.
2021-05-31 08:18:22 +00:00
endif()
Meta: Re-enable toolchain version checks These were removed in the Superbuild conversion. Re-add the checks that make sure that if there's a toolchain update, developers re-build their toolchain.
2022-01-03 08:26:13 +00:00
# Check for toolchain mismatch, user might need to rebuild toolchain
Toolchain+Ports: Update GCC to 13.2.0 This is a minor bugfix release, which to my knowledge contains nothing of importance to us. However, there is one QoL change to our patches. We no longer force `-fpic` in the compiler driver, and instead use the `--enable-default-pie` configure option to generate position-independent code suitable for executables. For building shared libraries, the `-fpic` flag must be specified explicitly.
2023-08-01 15:14:43 +00:00
set(GCC_VERSION "13.2.0")
Toolchain: Update LLVM to 18.1.3 Apart from bumping the toolchain Clang's and port's version, this commit completely overhauls the way LLVM toolchain is built. First, it gets rid of a complicated two-stage process of first compiling clang and compiler-rt builtins and then building libunwind, libc++abi, and libc++ -- it is possible to create a complete cross-compilation toolchain in a single CMake invocation with a modern LLVM. Moreover, the old method was inherently unsupported and subtly broken. Next, it utilizes full potential of the Stubs "framework". Now we are even able to compile Clang with -Wl,-z,defs which makes one of the patches obsolete and the whole installation less error-prone. Note that it comes at a cost of complicating the bootstrap process on a completely novel architecture but this hopefully won't happen often. Lastly, it fixes handling of the -no*lib* family of flags in the Serenity LLVM driver and correctly uses -nostartfiles in conjunction with stubs to make necessary CMake configure-time checks succeed.
2024-04-13 16:59:47 +00:00
set(LLVM_VERSION "18.1.3")
Meta: Re-enable toolchain version checks These were removed in the Superbuild conversion. Re-add the checks that make sure that if there's a toolchain update, developers re-build their toolchain.
2022-01-03 08:26:13 +00:00
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(EXPECTED_COMPILER_VERSION "${GCC_VERSION}")
else()
set(EXPECTED_COMPILER_VERSION "${LLVM_VERSION}")
endif()
if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL "${EXPECTED_COMPILER_VERSION}")
message(FATAL_ERROR "${CMAKE_CXX_COMPILER_ID} version (${CMAKE_CXX_COMPILER_VERSION}) does not match "
"expected compiler version (${EXPECTED_COMPILER_VERSION}).\n"
"Please rebuild the ${CMAKE_CXX_COMPILER_ID} Toolchain\n")
endif()
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
set(CMAKE_INSTALL_MESSAGE NEVER)
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
CMake: compile_commands.json output Problem: - CMake is not outputting `compile_commands.json`. - `compile_commands.json` is used by build integration tooling such as `clang-tidy`. Solution: - Enable `CMAKE_EXPORT_COMPILE_COMMANDS` option so that the file is output.
2020-11-11 22:59:06 +00:00
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
Meta: Move all options to targetname_options.cmake files This common strategy of having a serenity_option() macro defined in either the Lagom or top level CMakeLists.txt allows us to do two things: First, we can more clearly see which options are Serenity-specific, Lagom-specific, or common between the target and host builds. Second, it enables the upcoming SuperBuild changes to set() the options in the SuperBuild's CMake cache and forward each target's options to the corresponding ExternalProject.
2021-09-07 08:08:54 +00:00
if(NOT COMMAND serenity_option)
macro(serenity_option)
set(${ARGV})
endmacro()
endif()
CMake: Pass NO_POLICY_SCOPE to options cmake helpers Tell CMake to not create a new policy scope for the (lagom|serenity|common)_options.cmake helpers, and lets us set common policies for both projects in common_options.cmake that actually apply to the rest of the project, instead of just common_options.cmake itself.
2022-12-14 01:57:01 +00:00
include(serenity_options NO_POLICY_SCOPE)
Meta: Move all options to targetname_options.cmake files This common strategy of having a serenity_option() macro defined in either the Lagom or top level CMakeLists.txt allows us to do two things: First, we can more clearly see which options are Serenity-specific, Lagom-specific, or common between the target and host builds. Second, it enables the upcoming SuperBuild changes to set() the options in the SuperBuild's CMake cache and forward each target's options to the corresponding ExternalProject.
2021-09-07 08:08:54 +00:00
Meta: Separate ccache setup into its own component
2022-12-06 21:57:20 +00:00
include(setup_ccache)
Meta: Add Clang support to the CMake build scripts
2021-07-13 14:43:45 +00:00
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
if (NOT HACKSTUDIO_BUILD)
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
Meta: Error out on find_program errors with CMake less than 3.18 We have seen some cases where the build fails for folks, and they are missing unzip/tar/gzip etc. We can catch some of these in CMake itself, so lets make sure to handle that uniformly across the build system. The REQUIRED flag to `find_program` was only added on in CMake 3.18 and above, so we can't rely on that to actually halt the program execution.
2022-03-18 11:31:36 +00:00
include(check_for_dependencies)
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
# Host tools, required to generate files for the build
find_package(Lagom CONFIG REQUIRED)
Meta: Update jakt build support for fully bootstrapped compiler Remove the Corrosion dependency, and use the now-builtin add_jakt_executable function from the Jakt install rules to build our example application. By using find_package(Jakt), we now have to set ENABLE_JAKT manually on both serenity and Lagom at the same time, so the preferred method to do this for now is: cmake -B Build/superbuild<arch><toolchain> \ -S Meta/CMake/Superbuild \ -DENABLE_JAKT=ON \ -DJAKT_SOURCE_DIR=/path/to/jakt Where omitting JAKT_SOURCE_DIR will still pull from the main branch of SerenityOS/jakt. This can be done after runing Meta/serenity.sh run.
2022-08-28 23:47:03 +00:00
if (ENABLE_JAKT)
find_package(Jakt CONFIG REQUIRED
HINTS "${Lagom_DIR}/.."
)
Meta+Userland: Add jakt as an optional Lagom Tool We can now use ENABLE_JAKT to pull jakt as a host tool and use it to pre-process .jakt files into .cpp files for use in serenity applications
2022-05-20 05:46:36 +00:00
endif()
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
endif()
Meta: Run the Wasm spec tests in CI Since LibWasm is still not capable of passing all of the spec tests, ignore failing tests, only fail the build if some segfault/abort/etc occurs.
2021-05-26 18:34:52 +00:00
CMake: Add custom target to build only the generated sources This is needed so all headers and files exist on disk, so that the sonar cloud analyzer can find them when executing the compilation commands contained in compile_commands.json, without actually building. Co-authored-by: Andrew Kaster <akaster@serenityos.org>
2021-08-30 02:27:50 +00:00
# Meta target to run all code-gen steps in the build.
add_custom_target(all_generated)
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
add_custom_target(run
Meta: Replace run.sh by run.py A Python script is much easier to maintain than the organically grown variable mess that was run.sh. For now, the script inherits most environment variable modifiability from the shell script, but this is not a requirement. While porting this script, a couple of improvements have been made: - Spaces (especially in paths) cannot break most arguments anymore. Exceptions are environment variables specifying multiple arguments on purpose, these should be replaced in the future anyways. - Force control over virtualization is now possible with SERENITY_VIRTUALIZATION_SUPPORT. If set to 0, this variable was sometimes ignored before. - Handling Windows native QEMU is much more robust. Multiple incorrect checks for WSL, but not Windows native QEMU, were used before. This would also allow disabling native Windows QEMU much more easily in the future, which is necessary for GDB. - Various machine types had wrong or outdated arguments, such as qn. Co-Authored-By: Andrew Kaster <akaster@serenityos.org>
2023-11-24 16:28:23 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "${SerenityOS_SOURCE_DIR}/Meta/run.sh"
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
USES_TERMINAL
)
CMake: Add 'setup-and-run' target to perform all prereqs and run the image Running 'ninja install && ninja image && ninja run` is kind of annoying. I got tired, and came up with this instead, which does the right thing and I don't have to type out the incantation.
2021-02-14 23:59:20 +00:00
# This can currently only be implemented by ordered commands
# as cmake doesn't support inter dependency ordering, and we
# would like to avoid inject dependencies on the existing
# custom commands to allow people to run commands adhoc with
# out forcing re-builds when they might not want them.
add_custom_target(setup-and-run
COMMAND ${CMAKE_MAKE_PROGRAM} install
Meta+CMake: Remove "image" ninja target in favor of "qemu-image" "image" was an alias for "qemu-image". I want to add an `image` userland utility, which clashes with that shortname. So remove the existing "image" target. It was just an alias for "qemu-image". If you use serenity.sh to build, nothing changes. This only affects you if you run ninja manually -- you now have to say `ninja qemu-image` to build the disk image.
2023-03-12 01:12:37 +00:00
COMMAND ${CMAKE_MAKE_PROGRAM} qemu-image
CMake: Add 'setup-and-run' target to perform all prereqs and run the image Running 'ninja install && ninja image && ninja run` is kind of annoying. I got tired, and came up with this instead, which does the right thing and I don't have to type out the incantation.
2021-02-14 23:59:20 +00:00
COMMAND ${CMAKE_MAKE_PROGRAM} run
USES_TERMINAL
)
Build: rename `image` target => `qemu-image` Also add a new `image` target which is just an alias to `qemu-image`. This makes the CMakeLists.txt file more readable in my opinion.
2020-06-20 01:04:42 +00:00
add_custom_target(qemu-image
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "LLVM_VERSION=${CMAKE_CXX_COMPILER_VERSION}" "${SerenityOS_SOURCE_DIR}/Meta/build-image-qemu.sh"
Meta: Prefer SerenityOS_SOURCE_DIR to CMAKE_SOURCE_DIR By using SerenityOS_SOURCE_DIR we can make custom targets and commands agnostic to the actual location of the root CMakeLists directory. All we care about is the root of the SerenityOS project.
2021-08-08 00:32:49 +00:00
BYPRODUCTS "${CMAKE_BINARY_DIR}/_disk_image"
Build: rename `image` target => `qemu-image` Also add a new `image` target which is just an alias to `qemu-image`. This makes the CMakeLists.txt file more readable in my opinion.
2020-06-20 01:04:42 +00:00
USES_TERMINAL
)
Build: Add grub-image target to CMake
2020-05-26 21:51:18 +00:00
add_custom_target(grub-image
CMake: Quote all CMAKE_COMMAND occurences Building might fail if the cmake command path contains whitespace. See https://stackoverflow.com/a/35853080.
2022-09-02 18:59:45 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "LLVM_VERSION=${CMAKE_CXX_COMPILER_VERSION}" "${SerenityOS_SOURCE_DIR}/Meta/build-image-grub.sh"
Build: Use a separate byproduct name for the GRUB disk image (#2424) The grub-image target no longer conflicts with normal image target. This unbreaks using CMake with Ninja. Fixes #2423.
2020-05-28 08:08:38 +00:00
BYPRODUCTS ${CMAKE_BINARY_DIR}/grub_disk_image
Build: Add grub-image target to CMake
2020-05-26 21:51:18 +00:00
USES_TERMINAL
)
Meta: Add support for the Limine bootloader
2022-01-16 07:15:20 +00:00
add_custom_target(limine-image
CMake: Quote all CMAKE_COMMAND occurences Building might fail if the cmake command path contains whitespace. See https://stackoverflow.com/a/35853080.
2022-09-02 18:59:45 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "LLVM_VERSION=${CMAKE_CXX_COMPILER_VERSION}" "${SerenityOS_SOURCE_DIR}/Meta/build-image-limine.sh"
Meta: Add support for the Limine bootloader
2022-01-16 07:15:20 +00:00
BYPRODUCTS ${CMAKE_BINARY_DIR}/limine_disk_image
USES_TERMINAL
)
Build: Add extlinux-image target to CMake
2021-05-08 11:02:36 +00:00
add_custom_target(extlinux-image
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "LLVM_VERSION=${CMAKE_CXX_COMPILER_VERSION}" "${SerenityOS_SOURCE_DIR}/Meta/build-image-extlinux.sh"
Meta: Prefer SerenityOS_SOURCE_DIR to CMAKE_SOURCE_DIR By using SerenityOS_SOURCE_DIR we can make custom targets and commands agnostic to the actual location of the root CMakeLists directory. All we care about is the root of the SerenityOS project.
2021-08-08 00:32:49 +00:00
BYPRODUCTS "${CMAKE_BINARY_DIR}/extlinux_disk_image"
Build: Add extlinux-image target to CMake
2021-05-08 11:02:36 +00:00
USES_TERMINAL
)
Meta: Add install-native-partition CMake target installing to a real FS While playing around with getting serenity to run on my main desktop machine I wanted a way of easily updating my physical serenity partition. To use it you just need to: - Create and format your local partition to ext4 - Set `SERENITY_TARGET_INSTALL_PARTITION` to the partition /dev path. - Run the `install-native-partition` build target. Example: $ export SERENITY_TARGET_INSTALL_PARTITION=/dev/nvme1n1p3 $ cd serenity/Build/x86_64 $ ninja install-native-partition
2022-02-04 03:52:45 +00:00
add_custom_target(install-native-partition
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "LLVM_VERSION=${CMAKE_CXX_COMPILER_VERSION}" "${SerenityOS_SOURCE_DIR}/Meta/build-native-partition.sh"
USES_TERMINAL
)
Build: Add grub-image target to CMake
2020-05-26 21:51:18 +00:00
CMake: Add convenience targets to run lint-shell-scripts and check-style
2020-05-28 19:06:44 +00:00
add_custom_target(lint-shell-scripts
Meta: Prefer SerenityOS_SOURCE_DIR to CMAKE_SOURCE_DIR By using SerenityOS_SOURCE_DIR we can make custom targets and commands agnostic to the actual location of the root CMakeLists directory. All we care about is the root of the SerenityOS project.
2021-08-08 00:32:49 +00:00
COMMAND "${SerenityOS_SOURCE_DIR}/Meta/lint-shell-scripts.sh"
CMake: Add convenience targets to run lint-shell-scripts and check-style
2020-05-28 19:06:44 +00:00
USES_TERMINAL
)
add_custom_target(check-style
Meta: Prefer SerenityOS_SOURCE_DIR to CMAKE_SOURCE_DIR By using SerenityOS_SOURCE_DIR we can make custom targets and commands agnostic to the actual location of the root CMakeLists directory. All we care about is the root of the SerenityOS project.
2021-08-08 00:32:49 +00:00
COMMAND "${SerenityOS_SOURCE_DIR}/Meta/check-style.sh"
CMake: Add convenience targets to run lint-shell-scripts and check-style
2020-05-28 19:06:44 +00:00
USES_TERMINAL
)
Meta: Add install-ports CMake target install-ports copys the necessary files from Ports/ to /usr/Ports. Also refactor the compiler and destiation variables from .port_include.sh into .hosted_defs.sh. .hosted_defs.sh does not exists when ports are built in serenity
2021-04-03 03:53:41 +00:00
add_custom_target(install-ports
Meta: Switch to a SuperBuild that splits host and target builds Replace the old logic where we would start with a host build, and swap all the CMake compiler and target variables underneath it to trick CMake into building for Serenity after we configured and built the Lagom code generators. The SuperBuild creates two ExternalProjects, one for Lagom and one for Serenity. The Serenity project depends on the install stage for the Lagom build. The SuperBuild also generates a CMakeToolchain file for the Serenity build to use that replaces the old toolchain file that was only used for Ports. To ensure that code generators are rebuilt when core libraries such as AK and LibCore are modified, developers will need to direct their manual `ninja` invocations to the SuperBuild's binary directory instead of the Serenity binary directory. This commit includes warning coalescing and option style cleanup for the affected CMakeLists in the Kernel, top level, and runtime support libraries. A large part of the cleanup is replacing USE_CLANG_TOOLCHAIN with the proper CMAKE_CXX_COMPILER_ID variable, which will no longer be confused by a host clang compiler.
2021-09-07 08:21:36 +00:00
COMMAND "${CMAKE_COMMAND}" -E env "SERENITY_SOURCE_DIR=${SerenityOS_SOURCE_DIR}" "SERENITY_ARCH=${SERENITY_ARCH}" "SERENITY_TOOLCHAIN=${CMAKE_CXX_COMPILER_ID}" "${SerenityOS_SOURCE_DIR}/Meta/install-ports-tree.sh"
Meta: Add install-ports CMake target install-ports copys the necessary files from Ports/ to /usr/Ports. Also refactor the compiler and destiation variables from .port_include.sh into .hosted_defs.sh. .hosted_defs.sh does not exists when ports are built in serenity
2021-04-03 03:53:41 +00:00
USES_TERMINAL
)
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
if (NOT HACKSTUDIO_BUILD)
add_custom_target(configure-components
COMMAND "$<TARGET_FILE:Lagom::ConfigureComponents>"
USES_TERMINAL
)
add_dependencies(configure-components Lagom::ConfigureComponents)
endif()
Meta: Add the ConfigureComponents utility This adds a utility program which is essentially a command generator for CMake. It reads the 'components.ini' file generated by CMake in the build directory, prompts the user to select a build type and optionally customize it, generates and runs a CMake command as well as 'ninja clean' and 'rm -rf Root', which are needed to properly remove system components. The program uses whiptail(1) for user interaction.
2021-06-20 12:54:45 +00:00
Meta/CI: Add ENABLE_ALL_DEBUG_FACILITIES CMake option This option replaces the use of ENABLE_ALL_THE_DEBUG_MACROS in CI runs, and enables all debug options that might be broken by developers unintentionally that are only used in specific debugging situations.
2021-05-23 21:33:52 +00:00
if (ENABLE_ALL_DEBUG_FACILITIES)
set(ENABLE_ALL_THE_DEBUG_MACROS ON)
CMake: Hide KMALLOC_VERIFY_NO_SPINLOCK_HELD so folks don't find it Since I introduced this functionality there has been a steady stream of people building with `ALL_THE_DEBUG_MACROS` and trying to boot the system, and immediately hitting this assert. I have no idea why people try to build with all the debugging enabled, but I'm tired of seeing the bug reports about asserts we know are going to happen at this point. So I'm hiding this value under the new ENABLE_ALL_DEBUG_FACILITIES flag instead. This is only set by CI, and hopefully no-one will try to build with this thing (It's documented as not recommended). Fixes: #7527
2021-05-31 09:38:50 +00:00
# Immediately finds violations during boot, shouldn't be discoverable
# by people who aren't working on fixing issues. Use this check to make
# sure this code continues to build instead of all_debug_macros to avoid
# people filing bugs.
set(KMALLOC_VERIFY_NO_SPINLOCK_HELD ON)
Meta/CI: Add ENABLE_ALL_DEBUG_FACILITIES CMake option This option replaces the use of ENABLE_ALL_THE_DEBUG_MACROS in CI runs, and enables all debug options that might be broken by developers unintentionally that are only used in specific debugging situations.
2021-05-23 21:33:52 +00:00
endif()
CMake: Add public cmake option to document ENABLE_ALL_THE_DEBUG_MACROS - Making this an option makes this option visible to users and tooling. - Rename `ALL_THE_DEBUG_MACROS` -> `ENABLE_ALL_THE_DEBUG_MACROS`.
2021-01-01 10:26:52 +00:00
if (ENABLE_ALL_THE_DEBUG_MACROS)
Meta: Add Meta/CMake to the CMAKE_MODULE_PATH for Serenity and Lagom This makes it so we don't need to specify the full path to all the helper scripts we include() from different places in the codebase and feels a lot cleaner.
2021-09-07 07:50:09 +00:00
include(all_the_debug_macros)
CMake: Add public cmake option to document ENABLE_ALL_THE_DEBUG_MACROS - Making this an option makes this option visible to users and tooling. - Rename `ALL_THE_DEBUG_MACROS` -> `ENABLE_ALL_THE_DEBUG_MACROS`.
2021-01-01 10:26:52 +00:00
endif(ENABLE_ALL_THE_DEBUG_MACROS)
Meta: Provide option to build with ALL debug macros
2020-08-26 22:59:36 +00:00
Meta: Use CMAKE_INSTALL_FOODIR variables instead of hardcoding usr/foo In preparation for future refactoring of Lagom, let's use the variables from GNUInstallDirs as much as possible for the helper macros and other scripts used by the main build already.
2022-07-04 17:01:05 +00:00
set(CMAKE_STAGING_PREFIX "${CMAKE_BINARY_DIR}/Root")
set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/Root")
set(CMAKE_INSTALL_DATAROOTDIR res)
set(CMAKE_INSTALL_INCLUDEDIR usr/include)
set(CMAKE_INSTALL_LIBDIR usr/lib)
Everywhere: Use CMake to generate AK/Debug.h. This was done with the help of several scripts, I dump them here to easily find them later: awk '/#ifdef/ { print "#cmakedefine01 "$2 }' AK/Debug.h.in for debug_macro in $(awk '/#ifdef/ { print $2 }' AK/Debug.h.in) do find . \( -name '*.cpp' -o -name '*.h' -o -name '*.in' \) -not -path './Toolchain/*' -not -path './Build/*' -exec sed -i -E 's/#ifdef '$debug_macro'/#if '$debug_macro'/' {} \; done # Remember to remove WRAPPER_GERNERATOR_DEBUG from the list. awk '/#cmake/ { print "set("$2" ON)" }' AK/Debug.h.in
2021-01-23 22:29:11 +00:00
configure_file(AK/Debug.h.in AK/Debug.h @ONLY)
Meta: Use CMAKE_INSTALL_FOODIR variables instead of hardcoding usr/foo In preparation for future refactoring of Lagom, let's use the variables from GNUInstallDirs as much as possible for the helper macros and other scripts used by the main build already.
2022-07-04 17:01:05 +00:00
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/AK/Debug.h" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/AK")
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
CMake: set CMAKE_SKIP_RPATH everywhere Else, there's tons of "-- Set runtime path of" spam at build time, with apparently no way of disabling the build noise other than turning of rpaths. If the dynamic loader uses them at some point, we probably want to set them through cflags/ldflags instead of through cmake's built-in thing anyways, for that reason.
2021-01-06 23:55:01 +00:00
# We disable it completely because it makes cmake very spammy.
Meta: Disable rpath generation for MacOS
2020-12-27 23:04:29 +00:00
# This will need to be revisited when the Loader supports RPATH/RUN_PATH.
CMake: set CMAKE_SKIP_RPATH everywhere Else, there's tons of "-- Set runtime path of" spam at build time, with apparently no way of disabling the build noise other than turning of rpaths. If the dynamic loader uses them at some point, we probably want to set them through cflags/ldflags instead of through cmake's built-in thing anyways, for that reason.
2021-01-06 23:55:01 +00:00
set(CMAKE_SKIP_RPATH TRUE)
Meta: Disable rpath generation for MacOS
2020-12-27 23:04:29 +00:00
Meta: Move compiler flags into standalone CMake files This way we can have all of them in a single place, similar to how we structure options added via the serenity_option() macro.
2022-05-14 13:07:12 +00:00
include(serenity_compile_options)
Meta: Add Clang support to the CMake build scripts
2021-07-13 14:43:45 +00:00
Meta+LibC: Don't allow text relocations in SerenityOS libraries The `-z,text` linker flag causes the linker to reject shared libraries and PIE executables that have textrels. Our code mostly did not use these except in one place in LibC, which is changed in this commit. This makes GNU ld match LLD's behavior, which has this option enabled by default. TEXTRELs pose a security risk, as performing these relocations require executable pages to be written to by the dynamic linker. This can significantly weaken W^X hardening mitigations. Note that after this change, TEXTRELs can still be used in ports, as the dynamic loader code is not changed. There are also uses of it in the kernel, removing which are outside the scope of this PR. To allow those, `-z,notext` is added.
2021-08-18 15:39:04 +00:00
add_link_options(LINKER:-z,text)
Meta: Do not allow undefined symbols in executables and shared objects The `--allow-shlib-undefined` option is a bit of a misnomer. It actually controls whether we should be allowed to have undefined references after symbols from all dependencies have been resolved, so it applies both to shared libraries and executables. LLD defaults to allowing undefined references in shared libraries, but not in executables. Previously, we had to disable this check for executables too, as it caused a build failure due to the LibC-LibPthread-libc++ and the LibCore-LibCrypto circular dependencies. Now that those have been resolved, we can enable this warning, in the hopes that it will prevent us from introducing circular libraries and missing dependencies that might cause unexpected breakage.
2022-01-08 19:33:36 +00:00
add_link_options(LINKER:--no-allow-shlib-undefined)
Meta+LibC: Don't allow text relocations in SerenityOS libraries The `-z,text` linker flag causes the linker to reject shared libraries and PIE executables that have textrels. Our code mostly did not use these except in one place in LibC, which is changed in this commit. This makes GNU ld match LLD's behavior, which has this option enabled by default. TEXTRELs pose a security risk, as performing these relocations require executable pages to be written to by the dynamic linker. This can significantly weaken W^X hardening mitigations. Note that after this change, TEXTRELs can still be used in ports, as the dynamic loader code is not changed. There are also uses of it in the kernel, removing which are outside the scope of this PR. To allow those, `-z,notext` is added.
2021-08-18 15:39:04 +00:00
Meta+Documentation: Remove unused -DDEBUG from build
2021-07-12 07:31:47 +00:00
add_compile_definitions(SANITIZE_PTRS)
CMake: Remove some trailing whitespace from a few CMakeLists.txt files
2021-01-01 10:20:55 +00:00
AK: Rename {DBGLN_NO => ENABLE}_COMPILETIME_FORMAT_CHECK This is no longer limited to dbgln(). Also invert it to match all the other ENABLE_FOO options.
2021-02-23 17:14:04 +00:00
if (ENABLE_COMPILETIME_FORMAT_CHECK)
add_compile_definitions(ENABLE_COMPILETIME_FORMAT_CHECK)
Build: Allow setting DBGLN_NO_COMPILETIME_FORMAT_CHECK via CMake flag
2021-02-08 17:26:28 +00:00
endif()
AK+Toolchain: Make char and wchar_t behave on AARCH64 By default char and wchar_t are unsigned on AARCH64. This fixes a bunch of related compiler errors.
2022-10-12 20:00:21 +00:00
if("${SERENITY_ARCH}" STREQUAL "aarch64")
# FIXME: re-enable this warning
add_compile_options(-Wno-type-limits)
endif()
Meta: Add Clang support to the CMake build scripts
2021-07-13 14:43:45 +00:00
add_link_options(-Wno-unused-command-line-argument)
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
Everywhere: Move all host tools into the Lagom/Tools subdirectory This allows us to remove all the add_subdirectory calls from the top level CMakeLists.txt that referred to targets linking LagomCore. Segregating the host tools and Serenity targets helps us get to a place where the main Serenity build can simply use a CMake toolchain file rather than swapping all the compiler/sysroot variables after building host libraries and tools.
2021-08-08 07:31:23 +00:00
include_directories(.)
include_directories(Userland/Libraries)
LibC: Move crypt() and crypt_r() to the right header file According to POSIX.1 these should be in <crypt.h>.
2021-05-01 09:38:19 +00:00
include_directories(Userland/Libraries/LibCrypt)
Userland: Add LibSystem and funnel all syscalls through it This achieves two things: - Programs can now intentionally perform arbitrary syscalls by calling syscall(). This allows us to work on things like syscall fuzzing. - It restricts the ability of userspace to make syscalls to a single 4KB page of code. In order to call the kernel directly, an attacker must now locate this page and call through it.
2021-02-05 11:16:30 +00:00
include_directories(Userland/Libraries/LibSystem)
Services: Move to Userland/Services/
2021-01-12 11:23:01 +00:00
include_directories(Userland/Services)
Shell: Move to Userland/Shell/
2021-01-12 10:53:14 +00:00
include_directories(Userland)
TextEditor: Move the main window UI to JSON This is our first client of the new JSON GUI declaration thingy. The skeleton of the TextEditor app GUI is now declared separately from the C++ logic, and we use the Core::Object::name() of widgets to locate them once they have been instantiated by the GUI builder.
2020-09-14 10:51:12 +00:00
include_directories(${CMAKE_CURRENT_BINARY_DIR})
Services: Move to Userland/Services/
2021-01-12 11:23:01 +00:00
include_directories(${CMAKE_CURRENT_BINARY_DIR}/Userland/Services)
Libraries: Move to Userland/Libraries/
2021-01-12 11:17:30 +00:00
include_directories(${CMAKE_CURRENT_BINARY_DIR}/Userland/Libraries)
Shell: Move to Userland/Shell/
2021-01-12 10:53:14 +00:00
include_directories(${CMAKE_CURRENT_BINARY_DIR}/Userland)
Build: Switch to CMake :^) Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-06 15:40:06 +00:00
Meta: Add support for declaring components Components are a group of build targets that can be built and installed separately. Whether a component should be built can be configured with CMake arguments: -DBUILD_<NAME>=ON|OFF, where <NAME> is the name of the component (in all caps). Components can be marked as REQUIRED if they're necessary for a minimally functional base system or they can be marked as RECOMMENDED if they're not strictly necessary but are useful for most users. A component can have an optional description which isn't used by the build system but may be useful for a configuration UI. Components specify the TARGETS which should be built when the component is enabled. They can also specify other components which they depend on (with DEPENDS). This also adds the BUILD_EVERYTHING CMake variable which lets the user build all optional components. For now this defaults to ON to make the transition to the components-based build system easier. The list of components is exported as an INI file in the build directory (e.g. Build/i686/components.ini). Fixes #8048.
2021-06-15 13:07:25 +00:00
add_custom_target(components ALL)
option(BUILD_EVERYTHING "Build all optional components" ON)
Meta: Add Meta/CMake to the CMAKE_MODULE_PATH for Serenity and Lagom This makes it so we don't need to specify the full path to all the helper scripts we include() from different places in the codebase and feels a lot cleaner.
2021-09-07 07:50:09 +00:00
include(utils)
Meta+Tests: Allow running FLAC spec tests The FLAC "spec tests", or rather the test suite by xiph that exercises weird FLAC features and edge cases, can be found at https://github.com/ietf-wg-cellar/flac-test-files and is a good challenge for our FLAC decoder to become more spec compliant. Running these tests is similar to LibWasm spec tests, you need to pass INCLUDE_FLAC_SPEC_TESTS to CMake. As of integrating these tests, 23 out of 63 fail. :yakplus:
2022-07-25 11:28:16 +00:00
include(flac_spec_tests)
Meta: Add support for declaring components Components are a group of build targets that can be built and installed separately. Whether a component should be built can be configured with CMake arguments: -DBUILD_<NAME>=ON|OFF, where <NAME> is the name of the component (in all caps). Components can be marked as REQUIRED if they're necessary for a minimally functional base system or they can be marked as RECOMMENDED if they're not strictly necessary but are useful for most users. A component can have an optional description which isn't used by the build system but may be useful for a configuration UI. Components specify the TARGETS which should be built when the component is enabled. They can also specify other components which they depend on (with DEPENDS). This also adds the BUILD_EVERYTHING CMake variable which lets the user build all optional components. For now this defaults to ON to make the transition to the components-based build system easier. The list of components is exported as an INI file in the build directory (e.g. Build/i686/components.ini). Fixes #8048.
2021-06-15 13:07:25 +00:00
serenity_component(
Tests
RECOMMENDED
)
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
if (HACKSTUDIO_BUILD)
CMake: Modify include path when building from Hack Studio With regular builds, the generated IPC headers exist inside the Build directory. The path Userland/Services under the build directory is added to the include path. For in-system builds the IPC headers are installed at /usr/include/. To support this, we add /usr/include/Userland/Services to the build path when building from Hack Studio. Co-Authored-By: Andrew Kaster <akaster@serenityos.org>
2022-03-19 15:15:08 +00:00
include_directories(/usr/include/Userland/Services)
CMake: Add HACKSTUDIO_BUILD option for building from Hack Studio If this option is set, we will not build all components. Instead, we include an external CMake file passed in via a variable named HACKSTUDIO_BUILD_CMAKE_FILE. This will be used to build serenity components from Hack Studio.
2022-01-07 14:31:48 +00:00
include(${HACKSTUDIO_BUILD_CMAKE_FILE})
return()
endif()
CMake: Enable ClangPlugins for Serenity builds if ENABLE_CLANG_PLUGINS
2024-05-14 00:26:14 +00:00
add_library(GenericClangPlugin INTERFACE)
add_library(JSClangPlugin INTERFACE)
if (ENABLE_CLANG_PLUGINS AND CMAKE_CXX_COMPILER_ID MATCHES "Clang$")
target_link_libraries(GenericClangPlugin INTERFACE Lagom::GenericClangPlugin)
target_link_libraries(JSClangPlugin INTERFACE Lagom::JSClangPlugin)
endif()
Ports: Fix CMake-based ports The SDL port failed to build because the CMake toolchain filed pointed to the old root. Now the toolchain file assumes that the Root is in Build/Root. Additionally, the AK/ and Kernel/ headers need to be installed in the root too.
2020-05-26 18:20:24 +00:00
add_subdirectory(AK)
Meta: Enable RELR relocations Also add a check to serenity.sh to ensure that the toolchain is new enough for this feature to work.
2022-02-05 14:48:32 +00:00
CMake: Add `UNDEFINED_BEHAVIOR_IS_FATAL` configure option This is mainly intended for use on CI, as UBSan instrumentation results in a serious load and execution time penalty there. See the previous commit for more details. With this enabled, the size of LibWeb, built for x86-64 with Clang 17 as of 0b91d36a is reduced as follows: FILE SIZE VM SIZE -------------- -------------- +18% +2.99Mi [ = ] 0 .debug_info +14% +758Ki [ = ] 0 .debug_addr +2.6% +7.92Ki [ = ] 0 .debug_abbrev +129% +2.66Ki [ = ] 0 [Unmapped] -0.2% -208 -0.2% -208 .plt -0.2% -312 -0.2% -312 .rela.plt -0.1% -336 -0.1% -336 .dynsym -0.0% -647 -0.0% -513 [8 Others] -0.1% -1.14Ki -0.1% -1.14Ki .dynstr -20.1% -53.5Ki -20.1% -53.5Ki .eh_frame_hdr -7.2% -56.8Ki [ = ] 0 .debug_str_offsets -7.1% -156Ki [ = ] 0 .debug_str -15.0% -160Ki [ = ] 0 .symtab -63.6% -245Ki -63.6% -245Ki .relr.dyn -25.4% -357Ki -25.4% -357Ki .eh_frame -27.7% -1.09Mi [ = ] 0 .strtab -59.3% -10.0Mi [ = ] 0 .debug_rnglists -41.3% -11.0Mi [ = ] 0 .debug_line -70.0% -12.0Mi -70.0% -12.0Mi .rodata -65.2% -15.1Mi -65.2% -15.1Mi .data -53.0% -15.7Mi -53.0% -15.7Mi .text -41.7% -62.1Mi -57.7% -43.4Mi TOTAL
2023-08-12 13:39:22 +00:00
# FIXME: vptr sanitizing requires.. intense ABI wrangling of std::type_info
# And would be better served by porting ubsan_type_hash_itanium.cpp from compiler-rt
if (ENABLE_UNDEFINED_SANITIZER)
add_compile_options(-fsanitize=undefined -fno-sanitize=vptr)
add_link_options(-fsanitize=undefined -fno-sanitize=vptr)
if (UNDEFINED_BEHAVIOR_IS_FATAL)
add_compile_options(-fno-sanitize-recover=undefined)
endif()
endif()
Everywhere: Enable building userspace and test binaries on AARCH64 Surely this will just work once the kernel boots, right?
2022-10-12 20:19:51 +00:00
if (ENABLE_MOLD_LINKER)
add_link_options(-fuse-ld=mold)
endif()
CMake: Enable RELR relocations for Clang OR x86-64 While LLD and mold support RELR "packed" relocations on all architectures, the BFD linker currently only implements them on x86-64 and POWER. This fixes two issues: - The Kernel had it enabled even for AArch64 + GCC, which led to the following being printed: `warning: -z pack-relative-relocs ignored`. - The userland always had it disabled, even in the supported AArch64 + Clang/mold scenarios.
2023-08-11 10:55:45 +00:00
if (CMAKE_CXX_COMPILER_ID MATCHES "Clang$" OR ENABLE_MOLD_LINKER)
add_link_options(LINKER:--pack-dyn-relocs=relr)
elseif("${SERENITY_ARCH}" STREQUAL "x86_64")
# The BFD linker only supports RELR relocations on x86 and POWER.
add_link_options(LINKER:-z,pack-relative-relocs)
CMake: Don't build Userland and Tests in aarch64 builds for now
2021-08-28 16:56:51 +00:00
endif()
Everywhere: Enable building userspace and test binaries on AARCH64 Surely this will just work once the kernel boots, right?
2022-10-12 20:19:51 +00:00
add_subdirectory(Userland)
add_subdirectory(Tests)
HeaderCheck: It checks some of your headers
2021-01-21 20:41:48 +00:00
if (ENABLE_COMPILETIME_HEADER_CHECK)
add_subdirectory(Meta/HeaderCheck)
endif()
Base: Remove /res/pci.ids and download at build time instead This is an external file from https://pci-ids.ucw.cz that's being updated daily, which was imported a while ago but probably shouldn't live in the SerenityOS repository in the first place (or else would need manual maintenance). The legal aspects of redistributing this file as we currently do are not quite clear to me, they require either GPL (version 2 or later) or 3-clause BSD - Serenity is 2-clause BSD... The current version we use is 2019.08.08, so quite outdated - and while most of these devices are obviously not supported, we're still capable of *listing* them, so having an up-to-date version with recent additions and fixes would be nice. This updates the root CMakeLists.txt to check for existence of the file and download it if not found - effectively on every fresh build. Do note that this is not a critical file, and the system runs just fine should this ever fail. :^)
2021-02-06 23:52:40 +00:00
Meta: Add support for declaring components Components are a group of build targets that can be built and installed separately. Whether a component should be built can be configured with CMake arguments: -DBUILD_<NAME>=ON|OFF, where <NAME> is the name of the component (in all caps). Components can be marked as REQUIRED if they're necessary for a minimally functional base system or they can be marked as RECOMMENDED if they're not strictly necessary but are useful for most users. A component can have an optional description which isn't used by the build system but may be useful for a configuration UI. Components specify the TARGETS which should be built when the component is enabled. They can also specify other components which they depend on (with DEPENDS). This also adds the BUILD_EVERYTHING CMake variable which lets the user build all optional components. For now this defaults to ON to make the transition to the components-based build system easier. The list of components is exported as an INI file in the build directory (e.g. Build/i686/components.ini). Fixes #8048.
2021-06-15 13:07:25 +00:00
export_components("${CMAKE_BINARY_DIR}/components.ini")
Meta: Download uncompressed files instead of *.gz Problem: cmake cannot handle gzip files (see https://gitlab.kitware.com/cmake/cmake/-/issues/23054 for more details). Instead of downloading the compressed (*.gz) USB and PCI ids, we not download the raw uncompressed files. The sizes we "loose" due to downloading such files are meaningless. This are the file sizes: ``` diego@debian:~/$ ls -lh pci.ids{,.gz} usb.ids{,.gz} -rw-r--r-- 1 diego diego 1.3M Aug 7 04:15 pci.ids -rw-r--r-- 1 diego diego 300K Aug 7 04:15 pci.ids.gz -rw-r--r-- 1 diego diego 700K May 20 22:34 usb.ids -rw-r--r-- 1 diego diego 245K May 20 22:34 usb.ids.gz ```
2022-09-02 15:56:23 +00:00
# it seems like cmake cannot uncompress *.gz files... only ZIP/tar.gz.
Meta: Fix install path of usb.ids
2022-10-08 16:08:40 +00:00
# Lets download the uncompressed versions.
Meta: Download uncompressed files instead of *.gz Problem: cmake cannot handle gzip files (see https://gitlab.kitware.com/cmake/cmake/-/issues/23054 for more details). Instead of downloading the compressed (*.gz) USB and PCI ids, we not download the raw uncompressed files. The sizes we "loose" due to downloading such files are meaningless. This are the file sizes: ``` diego@debian:~/$ ls -lh pci.ids{,.gz} usb.ids{,.gz} -rw-r--r-- 1 diego diego 1.3M Aug 7 04:15 pci.ids -rw-r--r-- 1 diego diego 300K Aug 7 04:15 pci.ids.gz -rw-r--r-- 1 diego diego 700K May 20 22:34 usb.ids -rw-r--r-- 1 diego diego 245K May 20 22:34 usb.ids.gz ```
2022-09-02 15:56:23 +00:00
# https://gitlab.kitware.com/cmake/cmake/-/issues/23054
Build: Remove gzip -k usage in PCI/USB ID files and crypt for OpenBSD OpenBSD gzip does not have the -k flag to keep the original after extraction. Work around this by copying the original gzip to the dest and then extracting. A bit of a hack, but only needs to be done for the first-time or rebuilds OpenBSD provides crypt in libc, not libcrypt. Adjust if/else to check for either and proceed accordingly Remove outdated OpenBSD checks when building the toolchain
2021-12-23 00:32:00 +00:00
set(PCI_IDS_FILE pci.ids)
Meta: Download pci.ids and usb.ids to Build/caches This ensures we only need to download these files once for all build configurations. We similarly download the UCD, CLDR, and TZDB to this cache directory as well.
2023-03-14 21:52:06 +00:00
set(PCI_IDS_URL "https://pci-ids.ucw.cz/v2.2/${PCI_IDS_FILE}")
set(PCI_IDS_DOWNLOAD_PATH "${SERENITY_CACHE_DIR}/${PCI_IDS_FILE}")
Meta: Install PCI and USB ID files directly into /res The install() command used by 1e36d5449304226b097a4929a90f846c0ddf1d76 installs the provided file into the *directory* named by the DESTINATION parameter. So if we ask it to install pci.ids to /res/pci.ids, the final destination will be /res/pci.ids/pci.ids.
2023-03-31 19:00:41 +00:00
set(PCI_IDS_INSTALL_PATH "${CMAKE_STAGING_PREFIX}/${CMAKE_INSTALL_DATAROOTDIR}")
Build: Download and uncompress gzipped version of pci.ids Partially addresses #5611.
2021-03-03 22:50:25 +00:00
Meta: Install PCI and USB ID files directly into /res The install() command used by 1e36d5449304226b097a4929a90f846c0ddf1d76 installs the provided file into the *directory* named by the DESTINATION parameter. So if we ask it to install pci.ids to /res/pci.ids, the final destination will be /res/pci.ids/pci.ids.
2023-03-31 19:00:41 +00:00
if (ENABLE_PCI_IDS_DOWNLOAD AND NOT EXISTS "${PCI_IDS_INSTALL_PATH}/${PCI_IDS_FILE}")
Meta: Download pci.ids and usb.ids to Build/caches This ensures we only need to download these files once for all build configurations. We similarly download the UCD, CLDR, and TZDB to this cache directory as well.
2023-03-14 21:52:06 +00:00
download_file("${PCI_IDS_URL}" "${PCI_IDS_DOWNLOAD_PATH}")
Meta: Make sure directories for pci.ids and usb.ids exist `file(COPY_FILE ...)` fails if the target directory does not already exist, whereas `install(FILES ... DESTINATION ...)` happily creates all the required directories.
2023-03-15 15:50:57 +00:00
install(FILES "${PCI_IDS_DOWNLOAD_PATH}" DESTINATION "${PCI_IDS_INSTALL_PATH}")
Base: Remove /res/pci.ids and download at build time instead This is an external file from https://pci-ids.ucw.cz that's being updated daily, which was imported a while ago but probably shouldn't live in the SerenityOS repository in the first place (or else would need manual maintenance). The legal aspects of redistributing this file as we currently do are not quite clear to me, they require either GPL (version 2 or later) or 3-clause BSD - Serenity is 2-clause BSD... The current version we use is 2019.08.08, so quite outdated - and while most of these devices are obviously not supported, we're still capable of *listing* them, so having an up-to-date version with recent additions and fixes would be nice. This updates the root CMakeLists.txt to check for existence of the file and download it if not found - effectively on every fresh build. Do note that this is not a critical file, and the system runs just fine should this ever fail. :^)
2021-02-06 23:52:40 +00:00
endif()
Userland/Libraries: Add LibUSBDB library Simple clone of LibPCIDB to support USB IDs instead of PCI ones. The format is basically identical, besides a few changes of the double tab fields.
2021-06-09 14:24:04 +00:00
Build: Remove gzip -k usage in PCI/USB ID files and crypt for OpenBSD OpenBSD gzip does not have the -k flag to keep the original after extraction. Work around this by copying the original gzip to the dest and then extracting. A bit of a hack, but only needs to be done for the first-time or rebuilds OpenBSD provides crypt in libc, not libcrypt. Adjust if/else to check for either and proceed accordingly Remove outdated OpenBSD checks when building the toolchain
2021-12-23 00:32:00 +00:00
set(USB_IDS_FILE usb.ids)
Meta: Download pci.ids and usb.ids to Build/caches This ensures we only need to download these files once for all build configurations. We similarly download the UCD, CLDR, and TZDB to this cache directory as well.
2023-03-14 21:52:06 +00:00
set(USB_IDS_URL "http://www.linux-usb.org/${USB_IDS_FILE}")
set(USB_IDS_DOWNLOAD_PATH "${SERENITY_CACHE_DIR}/${USB_IDS_FILE}")
Meta: Install PCI and USB ID files directly into /res The install() command used by 1e36d5449304226b097a4929a90f846c0ddf1d76 installs the provided file into the *directory* named by the DESTINATION parameter. So if we ask it to install pci.ids to /res/pci.ids, the final destination will be /res/pci.ids/pci.ids.
2023-03-31 19:00:41 +00:00
set(USB_IDS_INSTALL_PATH "${CMAKE_STAGING_PREFIX}/${CMAKE_INSTALL_DATAROOTDIR}")
Userland/Libraries: Add LibUSBDB library Simple clone of LibPCIDB to support USB IDs instead of PCI ones. The format is basically identical, besides a few changes of the double tab fields.
2021-06-09 14:24:04 +00:00
Meta: Install PCI and USB ID files directly into /res The install() command used by 1e36d5449304226b097a4929a90f846c0ddf1d76 installs the provided file into the *directory* named by the DESTINATION parameter. So if we ask it to install pci.ids to /res/pci.ids, the final destination will be /res/pci.ids/pci.ids.
2023-03-31 19:00:41 +00:00
if (ENABLE_USB_IDS_DOWNLOAD AND NOT EXISTS "${USB_IDS_INSTALL_PATH}/${USB_IDS_FILE}")
Meta: Download pci.ids and usb.ids to Build/caches This ensures we only need to download these files once for all build configurations. We similarly download the UCD, CLDR, and TZDB to this cache directory as well.
2023-03-14 21:52:06 +00:00
download_file("${USB_IDS_URL}" "${USB_IDS_DOWNLOAD_PATH}")
Meta: Make sure directories for pci.ids and usb.ids exist `file(COPY_FILE ...)` fails if the target directory does not already exist, whereas `install(FILES ... DESTINATION ...)` happily creates all the required directories.
2023-03-15 15:50:57 +00:00
install(FILES "${USB_IDS_DOWNLOAD_PATH}" DESTINATION "${USB_IDS_INSTALL_PATH}")
Userland/Libraries: Add LibUSBDB library Simple clone of LibPCIDB to support USB IDs instead of PCI ones. The format is basically identical, besides a few changes of the double tab fields.
2021-06-09 14:24:04 +00:00
endif()
Reference in a new issue Copy permalink