authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2022-08-19 22:06:15-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2022-08-28 17:07:21-07:00
log56129d26ebd8c54563e92a78b9dab20f69dbc646
tree47aaa1a38db6e91a8ab864927284f8f71ff56498
parent5bb8c03697fce798a966feb131f6d906863047ae

cmake: build stage3 by default

This is a simplification of the cmake build script which introduces a new "stage3" target that is built by default, which builds and installs a stage3 zig. It greatly simplifies the build instructions for Zig, making it conform to the regular cmake routine, while still producing a stage3 artifact.

4 files changed, 81 insertions(+), 148 deletions(-)

CMakeLists.txt+67-67
...@@ -12,7 +12,7 @@ if(NOT CMAKE_BUILD_TYPE)...@@ -12,7 +12,7 @@ if(NOT CMAKE_BUILD_TYPE)
12endif()12endif()
1313
14if(NOT CMAKE_INSTALL_PREFIX)14if(NOT CMAKE_INSTALL_PREFIX)
15 set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/stage2" CACHE STRING15 set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/stage3" CACHE STRING
16 "Directory to install zig to" FORCE)16 "Directory to install zig to" FORCE)
17endif()17endif()
1818
...@@ -65,6 +65,9 @@ if("${ZIG_VERSION}" STREQUAL "")...@@ -65,6 +65,9 @@ if("${ZIG_VERSION}" STREQUAL "")
65endif()65endif()
66message(STATUS "Configuring zig version ${ZIG_VERSION}")66message(STATUS "Configuring zig version ${ZIG_VERSION}")
6767
68set(ZIG_SKIP_INSTALL_LIB_FILES off CACHE BOOL
69 "Disable copying lib/ files to install prefix during the build phase")
70
68set(ZIG_STATIC off CACHE BOOL "Attempt to build a static zig executable (not compatible with glibc)")71set(ZIG_STATIC off CACHE BOOL "Attempt to build a static zig executable (not compatible with glibc)")
69set(ZIG_SHARED_LLVM off CACHE BOOL "Prefer linking against shared LLVM libraries")72set(ZIG_SHARED_LLVM off CACHE BOOL "Prefer linking against shared LLVM libraries")
70set(ZIG_STATIC_LLVM off CACHE BOOL "Prefer linking against static LLVM libraries")73set(ZIG_STATIC_LLVM off CACHE BOOL "Prefer linking against static LLVM libraries")
...@@ -333,7 +336,7 @@ set(ZIG_CONFIG_H_OUT "${CMAKE_BINARY_DIR}/config.h")...@@ -333,7 +336,7 @@ set(ZIG_CONFIG_H_OUT "${CMAKE_BINARY_DIR}/config.h")
333set(ZIG_CONFIG_ZIG_OUT "${CMAKE_BINARY_DIR}/config.zig")336set(ZIG_CONFIG_ZIG_OUT "${CMAKE_BINARY_DIR}/config.zig")
334337
335# This is our shim which will be replaced by stage1.zig.338# This is our shim which will be replaced by stage1.zig.
336set(ZIG0_SOURCES339set(ZIG1_SOURCES
337 "${CMAKE_SOURCE_DIR}/src/stage1/zig0.cpp"340 "${CMAKE_SOURCE_DIR}/src/stage1/zig0.cpp"
338)341)
339342
...@@ -373,9 +376,9 @@ set(ZIG_CPP_SOURCES...@@ -373,9 +376,9 @@ set(ZIG_CPP_SOURCES
373 # https://github.com/ziglang/zig/issues/6363376 # https://github.com/ziglang/zig/issues/6363
374 "${CMAKE_SOURCE_DIR}/src/windows_sdk.cpp"377 "${CMAKE_SOURCE_DIR}/src/windows_sdk.cpp"
375)378)
376# Needed because we use cmake, not the zig build system, to build zig1.o.379# Needed because we use cmake, not the zig build system, to build zig2.o.
377# This list is generated by building zig and then clearing the zig-cache directory,380# This list is generated by building zig and then clearing the zig-cache directory,
378# then manually running the build-obj command (see BUILD_ZIG1_ARGS), and then looking381# then manually running the build-obj command (see BUILD_ZIG2_ARGS), and then looking
379# in the zig-cache directory for the compiler-generated list of zig file dependencies.382# in the zig-cache directory for the compiler-generated list of zig file dependencies.
380set(ZIG_STAGE2_SOURCES383set(ZIG_STAGE2_SOURCES
381 "${ZIG_CONFIG_ZIG_OUT}"384 "${ZIG_CONFIG_ZIG_OUT}"
...@@ -942,40 +945,47 @@ if(MSVC OR MINGW)...@@ -942,40 +945,47 @@ if(MSVC OR MINGW)
942endif()945endif()
943946
944if("${ZIG_EXECUTABLE}" STREQUAL "")947if("${ZIG_EXECUTABLE}" STREQUAL "")
945 add_executable(zig0 ${ZIG0_SOURCES})948 add_executable(zig1 ${ZIG1_SOURCES})
946 set_target_properties(zig0 PROPERTIES949 set_target_properties(zig1 PROPERTIES
947 COMPILE_FLAGS ${EXE_CFLAGS}950 COMPILE_FLAGS ${EXE_CFLAGS}
948 LINK_FLAGS ${EXE_LDFLAGS}951 LINK_FLAGS ${EXE_LDFLAGS}
949 )952 )
950 target_link_libraries(zig0 zigstage1)953 target_link_libraries(zig1 zigstage1)
951endif()954endif()
952955
953if(MSVC)956if(MSVC)
954 set(ZIG1_OBJECT "${CMAKE_BINARY_DIR}/zig1.obj")957 set(ZIG2_OBJECT "${CMAKE_BINARY_DIR}/zig2.obj")
955else()958else()
956 set(ZIG1_OBJECT "${CMAKE_BINARY_DIR}/zig1.o")959 set(ZIG2_OBJECT "${CMAKE_BINARY_DIR}/zig2.o")
957endif()960endif()
958if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")961if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
959 set(ZIG1_RELEASE_ARG "")962 set(ZIG_RELEASE_ARG "")
963else()
964 set(ZIG_RELEASE_ARG -Drelease)
965endif()
966if(ZIG_SKIP_INSTALL_LIB_FILES)
967 set(ZIG_SKIP_INSTALL_LIB_FILES_ARG "-Dskip-install-lib-files")
960else()968else()
961 set(ZIG1_RELEASE_ARG -OReleaseFast --strip)969 set(ZIG_SKIP_INSTALL_LIB_FILES_ARG "-Dskip-install-lib-files=false")
962endif()970endif()
963if(ZIG_SINGLE_THREADED)971if(ZIG_SINGLE_THREADED)
964 set(ZIG1_SINGLE_THREADED_ARG "-fsingle-threaded")972 set(ZIG_SINGLE_THREADED_ARG "-fsingle-threaded")
965else()973else()
966 set(ZIG1_SINGLE_THREADED_ARG "")974 set(ZIG_SINGLE_THREADED_ARG "")
975endif()
976if(ZIG_STATIC)
977 set(ZIG_STATIC_ARG "-Duse-zig-libcxx")
978else()
979 set(ZIG_STATIC_ARG "")
967endif()980endif()
968981
969set(BUILD_ZIG1_ARGS982set(BUILD_ZIG2_ARGS
970 "src/stage1.zig"983 "src/stage1.zig"
971 -target "${ZIG_TARGET_TRIPLE}"984 --name zig2
972 "-mcpu=${ZIG_TARGET_MCPU}"
973 --name zig1
974 --zig-lib-dir "${CMAKE_SOURCE_DIR}/lib"985 --zig-lib-dir "${CMAKE_SOURCE_DIR}/lib"
975 "-femit-bin=${ZIG1_OBJECT}"986 "-femit-bin=${ZIG2_OBJECT}"
976 -fcompiler-rt987 -fcompiler-rt
977 "${ZIG1_RELEASE_ARG}"988 "${ZIG_SINGLE_THREADED_ARG}"
978 "${ZIG1_SINGLE_THREADED_ARG}"
979 -lc989 -lc
980 --pkg-begin build_options "${ZIG_CONFIG_ZIG_OUT}"990 --pkg-begin build_options "${ZIG_CONFIG_ZIG_OUT}"
981 --pkg-end991 --pkg-end
...@@ -985,68 +995,58 @@ set(BUILD_ZIG1_ARGS...@@ -985,68 +995,58 @@ set(BUILD_ZIG1_ARGS
985995
986if("${ZIG_EXECUTABLE}" STREQUAL "")996if("${ZIG_EXECUTABLE}" STREQUAL "")
987 add_custom_command(997 add_custom_command(
988 OUTPUT "${ZIG1_OBJECT}"998 OUTPUT "${ZIG2_OBJECT}"
989 COMMAND zig0 ${BUILD_ZIG1_ARGS}999 COMMAND zig1 ${BUILD_ZIG2_ARGS}
990 DEPENDS zig0 "${ZIG_STAGE2_SOURCES}"1000 DEPENDS zig1 "${ZIG_STAGE2_SOURCES}"
991 COMMENT STATUS "Building self-hosted component ${ZIG1_OBJECT}"1001 COMMENT STATUS "Building stage2 object ${ZIG2_OBJECT}"
992 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"1002 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
993 )1003 )
994 set(ZIG_EXECUTABLE "${zig_BINARY_DIR}/zig")
995 if (WIN32)1004 if (WIN32)
996 set(ZIG_EXECUTABLE "${ZIG_EXECUTABLE}.exe")1005 set(ZIG_EXECUTABLE "${zig2_BINARY_DIR}/zig2.exe")
1006 else()
1007 set(ZIG_EXECUTABLE "${zig2_BINARY_DIR}/zig2")
997 endif()1008 endif()
998else()1009else()
999 add_custom_command(1010 add_custom_command(
1000 OUTPUT "${ZIG1_OBJECT}"1011 OUTPUT "${ZIG2_OBJECT}"
1001 COMMAND "${ZIG_EXECUTABLE}" "build-obj" ${BUILD_ZIG1_ARGS}1012 COMMAND "${ZIG_EXECUTABLE}" "build-obj" ${BUILD_ZIG2_ARGS}
1002 DEPENDS ${ZIG_STAGE2_SOURCES}1013 DEPENDS ${ZIG_STAGE2_SOURCES}
1003 COMMENT STATUS "Building self-hosted component ${ZIG1_OBJECT}"1014 COMMENT STATUS "Building stage2 component ${ZIG2_OBJECT}"
1004 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"1015 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
1005 )1016 )
1006endif()1017endif()
10071018
1008# cmake won't let us configure an executable without C sources.1019# cmake won't let us configure an executable without C sources.
1009add_executable(zig "${CMAKE_SOURCE_DIR}/src/stage1/empty.cpp" "${ZIG1_OBJECT}")1020add_executable(zig2 "${CMAKE_SOURCE_DIR}/src/stage1/empty.cpp" "${ZIG2_OBJECT}")
10101021
1011set_target_properties(zig PROPERTIES1022set_target_properties(zig2 PROPERTIES
1012 COMPILE_FLAGS ${EXE_CFLAGS}1023 COMPILE_FLAGS ${EXE_CFLAGS}
1013 LINK_FLAGS ${EXE_LDFLAGS}1024 LINK_FLAGS ${EXE_LDFLAGS}
1014)1025)
1015target_link_libraries(zig zigstage1)1026target_link_libraries(zig2 zigstage1)
1016if(MSVC)1027if(MSVC)
1017 target_link_libraries(zig ntdll.lib)1028 target_link_libraries(zig2 ntdll.lib)
1018elseif(MINGW)1029elseif(MINGW)
1019 target_link_libraries(zig ntdll)1030 target_link_libraries(zig2 ntdll)
1020endif()1031endif()
10211032
1022install(TARGETS zig DESTINATION bin)1033set(ZIG_INSTALL_ARGS "build"
10231034 --zig-lib-dir "${CMAKE_SOURCE_DIR}/lib"
1024set(ZIG_SKIP_INSTALL_LIB_FILES off CACHE BOOL1035 --prefix "${CMAKE_INSTALL_PREFIX}"
1025 "Disable copying lib/ files to install prefix during the build phase")1036 "-Dconfig_h=${ZIG_CONFIG_H_OUT}"
10261037 "-Denable-llvm"
1027if(NOT ZIG_SKIP_INSTALL_LIB_FILES)1038 "-Denable-stage1"
1028 set(ZIG_INSTALL_ARGS "build"1039 "${ZIG_RELEASE_ARG}"
1029 --zig-lib-dir "${CMAKE_SOURCE_DIR}/lib"1040 "${ZIG_STATIC_ARG}"
1030 "-Dlib-files-only"1041 "${ZIG_SKIP_INSTALL_LIB_FILES_ARG}"
1031 --prefix "${CMAKE_INSTALL_PREFIX}"1042 "${ZIG_SINGLE_THREADED_ARG}"
1032 "-Dconfig_h=${ZIG_CONFIG_H_OUT}"1043 "-Dtarget=${ZIG_TARGET_TRIPLE}"
1033 install1044 "-Dcpu=${ZIG_TARGET_MCPU}"
1034 )1045)
10351046
1036 # CODE has no effect with Visual Studio build system generator, therefore1047add_custom_target(stage3 ALL
1037 # when using Visual Studio build system generator we resort to running1048 COMMAND zig2 ${ZIG_INSTALL_ARGS}
1038 # `zig build install` during the build phase.1049 DEPENDS zig2
1039 if(MSVC)1050 COMMENT STATUS "Building stage3"
1040 add_custom_target(zig_install_lib_files ALL1051 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
1041 COMMAND zig ${ZIG_INSTALL_ARGS}1052)
1042 DEPENDS zig
1043 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
1044 )
1045 else()
1046 get_target_property(zig_BINARY_DIR zig BINARY_DIR)
1047 install(CODE "set(zig_EXE \"${ZIG_EXECUTABLE}\")")
1048 install(CODE "set(ZIG_INSTALL_ARGS \"${ZIG_INSTALL_ARGS}\")")
1049 install(CODE "set(CMAKE_SOURCE_DIR \"${CMAKE_SOURCE_DIR}\")")
1050 install(SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/cmake/install.cmake)
1051 endif()
1052endif()
ci/zinc/linux_test_stage3_debug.sh+9-14
...@@ -20,12 +20,11 @@ export CXX="$OLD_ZIG c++ -target $TARGET -mcpu=$MCPU"...@@ -20,12 +20,11 @@ export CXX="$OLD_ZIG c++ -target $TARGET -mcpu=$MCPU"
20mkdir build-debug20mkdir build-debug
21cd build-debug21cd build-debug
22cmake .. \22cmake .. \
23 -DCMAKE_INSTALL_PREFIX="$DEBUG_STAGING" \23 -DCMAKE_INSTALL_PREFIX="$(pwd)/stage3" \
24 -DCMAKE_PREFIX_PATH="$DEPS_LOCAL" \24 -DCMAKE_PREFIX_PATH="$DEPS_LOCAL" \
25 -DCMAKE_BUILD_TYPE=Debug \25 -DCMAKE_BUILD_TYPE=Debug \
26 -DZIG_TARGET_TRIPLE="$TARGET" \
27 -DZIG_TARGET_MCPU="$MCPU" \
28 -DZIG_STATIC=ON \26 -DZIG_STATIC=ON \
27 -DZIG_USE_LLVM_CONFIG=OFF \
29 -GNinja28 -GNinja
3029
31# Now cmake will use zig as the C/C++ compiler. We reset the environment variables30# Now cmake will use zig as the C/C++ compiler. We reset the environment variables
...@@ -35,21 +34,17 @@ unset CXX...@@ -35,21 +34,17 @@ unset CXX
3534
36ninja install35ninja install
3736
38cd $WORKSPACE
39
40"$DEBUG_STAGING/bin/zig" build -p stage3 -Denable-stage1 -Dstatic-llvm -Dtarget=native-native-musl --search-prefix "$DEPS_LOCAL"
41
42# simultaneously test building self-hosted without LLVM and with 32-bit arm
43stage3/bin/zig build -Dtarget=arm-linux-musleabihf
44
45echo "Looking for non-conforming code formatting..."37echo "Looking for non-conforming code formatting..."
46stage3/bin/zig fmt --check . \38stage3/bin/zig fmt --check .. \
47 --exclude test/cases/ \39 --exclude ../test/cases/ \
48 --exclude build-debug \40 --exclude ../build-debug \
49 --exclude build-release \41 --exclude ../build-release \
50 --exclude "$ZIG_LOCAL_CACHE_DIR" \42 --exclude "$ZIG_LOCAL_CACHE_DIR" \
51 --exclude "$ZIG_GLOBAL_CACHE_DIR"43 --exclude "$ZIG_GLOBAL_CACHE_DIR"
5244
45# simultaneously test building self-hosted without LLVM and with 32-bit arm
46stage3/bin/zig build -Dtarget=arm-linux-musleabihf
47
53stage3/bin/zig build test \48stage3/bin/zig build test \
54 -fqemu \49 -fqemu \
55 -fwasmtime \50 -fwasmtime \
ci/zinc/linux_test_stage3_release.sh+5-30
...@@ -13,9 +13,8 @@ export CXX="$OLD_ZIG c++ -target $TARGET -mcpu=$MCPU"...@@ -13,9 +13,8 @@ export CXX="$OLD_ZIG c++ -target $TARGET -mcpu=$MCPU"
1313
14mkdir build-release14mkdir build-release
15cd build-release15cd build-release
16STAGE2_PREFIX="$(pwd)/stage2"
17cmake .. \16cmake .. \
18 -DCMAKE_INSTALL_PREFIX="$STAGE2_PREFIX" \17 -DCMAKE_INSTALL_PREFIX="$RELEASE_STAGING" \
19 -DCMAKE_PREFIX_PATH="$DEPS_LOCAL" \18 -DCMAKE_PREFIX_PATH="$DEPS_LOCAL" \
20 -DCMAKE_BUILD_TYPE=Release \19 -DCMAKE_BUILD_TYPE=Release \
21 -DZIG_TARGET_TRIPLE="$TARGET" \20 -DZIG_TARGET_TRIPLE="$TARGET" \
...@@ -30,31 +29,7 @@ unset CXX...@@ -30,31 +29,7 @@ unset CXX
3029
31ninja install30ninja install
3231
33# Here we rebuild zig but this time using the Zig binary we just now produced to32"$RELEASE_STAGING/bin/zig" build test docs \
34# build zig1.o rather than relying on the one built with stage0. See
35# https://github.com/ziglang/zig/issues/6830 for more details.
36cmake .. -DZIG_EXECUTABLE="$STAGE2_PREFIX/bin/zig"
37ninja install
38
39# This is the binary we will distribute. We intentionally test this one in this
40# script. If any test failures occur, hopefully they also occur in the debug
41# version of this script for easier troubleshooting. This prevents distribution
42# of a Zig binary that passes tests in debug mode but has a miscompilation in
43# release mode.
44"$STAGE2_PREFIX/bin/zig" build \
45 --prefix "$RELEASE_STAGING" \
46 --search-prefix "$DEPS_LOCAL" \
47 -Dstatic-llvm \
48 -Drelease \
49 -Dstrip \
50 -Dtarget="$TARGET" \
51 -Denable-stage1
52
53cd $WORKSPACE
54
55ZIG="$RELEASE_STAGING/bin/zig"
56
57$ZIG build test docs \
58 -fqemu \33 -fqemu \
59 -fwasmtime \34 -fwasmtime \
60 -Dstatic-llvm \35 -Dstatic-llvm \
...@@ -63,13 +38,13 @@ $ZIG build test docs \...@@ -63,13 +38,13 @@ $ZIG build test docs \
6338
64# Produce the experimental std lib documentation.39# Produce the experimental std lib documentation.
65mkdir -p "$RELEASE_STAGING/docs/std"40mkdir -p "$RELEASE_STAGING/docs/std"
66$ZIG test lib/std/std.zig \41"$RELEASE_STAGING/bin/zig" test ../lib/std/std.zig \
67 --zig-lib-dir lib \42 --zig-lib-dir lib \
68 -femit-docs=$RELEASE_STAGING/docs/std \43 -femit-docs=$RELEASE_STAGING/docs/std \
69 -fno-emit-bin44 -fno-emit-bin
7045
71cp LICENSE $RELEASE_STAGING/46cp ../LICENSE $RELEASE_STAGING/
72cp zig-cache/langref.html $RELEASE_STAGING/docs/47cp ../zig-cache/langref.html $RELEASE_STAGING/docs/
7348
74# Look for HTML errors.49# Look for HTML errors.
75tidy --drop-empty-elements no -qe $RELEASE_STAGING/docs/langref.html50tidy --drop-empty-elements no -qe $RELEASE_STAGING/docs/langref.html
cmake/install.cmake deleted-37
...@@ -1,37 +0,0 @@
1message("-- Installing: ${CMAKE_INSTALL_PREFIX}/lib")
2
3if(NOT EXISTS ${zig_EXE})
4 message("::")
5 message(":: ERROR: Executable not found")
6 message(":: (execute_process)")
7 message("::")
8 message(":: executable: ${zig_EXE}")
9 message("::")
10 message(FATAL_ERROR)
11endif()
12
13execute_process(COMMAND ${zig_EXE} ${ZIG_INSTALL_ARGS}
14 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
15 RESULT_VARIABLE _result
16)
17if(_result)
18 message("::")
19 message(":: ERROR: ${_result}")
20 message(":: (execute_process)")
21
22 string(REPLACE ";" " " s_INSTALL_LIBSTAGE2_ARGS "${ZIG_INSTALL_ARGS}")
23 message("::")
24 message(":: argv: ${zig_EXE} ${s_INSTALL_LIBSTAGE2_ARGS}")
25
26 set(_args ${zig_EXE} ${ZIG_INSTALL_ARGS})
27 list(LENGTH _args _len)
28 math(EXPR _len "${_len} - 1")
29 message("::")
30 foreach(_i RANGE 0 ${_len})
31 list(GET _args ${_i} _arg)
32 message(":: argv[${_i}]: ${_arg}")
33 endforeach()
34
35 message("::")
36 message(FATAL_ERROR)
37endif()