2 #===-- test-release.sh - Test the LLVM release candidates ------------------===#
4 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 # See https://llvm.org/LICENSE.txt for license information.
6 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
8 #===------------------------------------------------------------------------===#
10 # Download, build, and test the release candidate for an LLVM release.
12 #===------------------------------------------------------------------------===#
16 if [ "$System" = "FreeBSD" ]; then
21 generator
="Unix Makefiles"
46 ExtraConfigureFlags
=""
51 if [ "$System" = "Linux" ]; then
53 x86_64 | arm64 | aarch64
)
60 echo "usage: `basename $0` -release X.Y.Z -rc NUM [OPTIONS]"
62 echo " -release X.Y.Z The release version to test."
63 echo " -rc NUM The pre-release candidate number."
64 echo " -final The final release candidate."
65 echo " -triple TRIPLE The target triple for this machine."
66 echo " -j NUM Number of compile jobs to run. [default: 3]"
67 echo " -build-dir DIR Directory to perform testing in. [default: pwd]"
68 echo " -no-checkout Don't checkout the sources from SVN."
69 echo " -test-debug Test the debug build. [default: no]"
70 echo " -test-asserts Test with asserts on. [default: no]"
71 echo " -no-compare-files Don't test that phase 2 and 3 files are identical."
72 echo " -use-gzip Use gzip instead of xz."
73 echo " -use-ninja Use ninja instead of make/gmake."
74 echo " -configure-flags FLAGS Extra flags to pass to the configure step."
75 echo " -git-ref sha Use the specified git ref for testing instead of a release."
76 echo " -no-rt Disable check-out & build Compiler-RT"
77 echo " -no-clang-tools Disable check-out & build clang-tools-extra"
78 echo " -no-libs Disable check-out & build libcxx/libcxxabi/libunwind"
79 echo " -no-libcxxabi Disable check-out & build libcxxabi"
80 echo " -no-libunwind Disable check-out & build libunwind"
81 echo " -no-test-suite Disable check-out & build test-suite"
82 echo " -no-openmp Disable check-out & build libomp"
83 echo " -no-lld Disable check-out & build lld"
84 echo " -lldb Enable check-out & build lldb"
85 echo " -no-lldb Disable check-out & build lldb (default)"
86 echo " -no-polly Disable check-out & build Polly"
87 echo " -no-mlir Disable check-out & build MLIR"
88 echo " -no-flang Disable check-out & build Flang"
89 echo " -silent-log Don't output build logs to stdout"
90 echo " -use-cmake-cache Build using a CMake cache file"
93 while [ $# -gt 0 ]; do
95 -release |
--release )
98 Release_no_dot
="`echo $1 | sed -e 's,\.,,g'`"
100 -rc |
--rc |
-RC |
--RC )
107 -git-ref |
--git-ref )
110 Release_no_dot
="test"
112 RC
="`echo $ExportBranch | sed -e 's,/,_,g'`"
114 echo "WARNING: Using the ref $git_ref instead of a release tag"
115 echo " This is intended to aid new packagers in trialing "
116 echo " builds without requiring a tag to be created first"
122 -configure-flags |
--configure-flags )
124 ExtraConfigureFlags
="$1"
127 NumJobs
="`echo $1 | sed -e 's,-j\([0-9]*\),\1,g'`"
128 if [ -z "$NumJobs" ]; then
137 -build-dir |
--build-dir |
-builddir |
--builddir )
141 -no-checkout |
--no-checkout )
144 -test-debug |
--test-debug )
147 -test-asserts |
--test-asserts )
150 -no-compare-files |
--no-compare-files )
153 -use-gzip |
--use-gzip )
204 -use-cmake-cache |
--use-cmake-cache )
207 -help |
--help |
-h |
--h |
-\? )
212 echo "unknown option: $1"
220 if [ $do_mlir = "no" ] && [ $do_flang = "yes" ]; then
221 echo "error: cannot build Flang without MLIR"
225 # Check required arguments.
226 if [ -z "$Release" ]; then
227 echo "error: no release number specified"
230 if [ -z "$RC" ]; then
231 echo "error: no release candidate number specified"
234 if [ -z "$ExportBranch" ]; then
235 ExportBranch
="tags/RELEASE_$Release_no_dot/$RC"
237 if [ -z "$Triple" ]; then
238 echo "error: no target triple specified"
242 if [ "$Release" != "test" ]; then
243 if [ -n "$git_ref" ]; then
244 echo "error: can't specify both -release and -git-ref"
247 git_ref
=llvmorg-
$Release
248 if [ "$RC" != "final" ]; then
249 git_ref
="$git_ref-$RC"
253 UserNumJobs
="$NumJobs"
255 # Figure out how many make processes to run.
256 if [ -z "$NumJobs" ]; then
257 NumJobs
=`sysctl -n hw.activecpu 2> /dev/null || true`
259 if [ -z "$NumJobs" ]; then
260 NumJobs
=`sysctl -n hw.ncpu 2> /dev/null || true`
262 if [ -z "$NumJobs" ]; then
263 NumJobs
=`grep -c processor /proc/cpuinfo 2> /dev/null || true`
265 if [ -z "$NumJobs" ]; then
269 if [ "$MAKE" = "ninja" ] && [ -z "$UserNumJobs" ]; then
270 # Rely on default ninja job numbers
277 projects
="llvm;clang"
278 if [ $do_clang_tools = "yes" ]; then
279 projects
="${projects:+$projects;}clang-tools-extra"
282 if [ $do_rt = "yes" ]; then
283 runtimes
="${runtimes:+$runtimes;}compiler-rt"
285 if [ $do_libs = "yes" ]; then
286 runtimes
="${runtimes:+$runtimes;}libcxx"
287 if [ $do_libcxxabi = "yes" ]; then
288 runtimes
="${runtimes:+$runtimes;}libcxxabi"
290 if [ $do_libunwind = "yes" ]; then
291 runtimes
="${runtimes:+$runtimes;}libunwind"
294 if [ $do_openmp = "yes" ]; then
295 projects
="${projects:+$projects;}openmp"
297 if [ $do_bolt = "yes" ]; then
298 projects
="${projects:+$projects;}bolt"
300 if [ $do_lld = "yes" ]; then
301 projects
="${projects:+$projects;}lld"
303 if [ $do_lldb = "yes" ]; then
304 projects
="${projects:+$projects;}lldb"
306 if [ $do_polly = "yes" ]; then
307 projects
="${projects:+$projects;}polly"
309 if [ $do_mlir = "yes" ]; then
310 projects
="${projects:+$projects;}mlir"
312 if [ $do_flang = "yes" ]; then
313 projects
="${projects:+$projects;}flang"
316 # Go to the build directory (may be different from CWD)
317 BuildDir
=$BuildDir/$RC
321 # Location of log files.
322 LogDir
=$BuildDir/logs
325 # Final package name.
326 Package
=clang
+llvm-
$Release
327 if [ $RC != "final" ]; then
330 Package
=$Package-$Triple
332 # Errors to be highlighted at the end are written to this file.
333 echo -n > $LogDir/deferred_errors.log
336 if [ $do_silent_log == "yes" ]; then
337 echo "# Silencing build logs because of -silent-log flag..."
342 function build_with_cmake_cache
() {
344 CMakeBuildDir
=$BuildDir/build
345 SrcDir
=$BuildDir/llvm-project
/
346 InstallDir
=$BuildDir/install
348 rm -rf $CMakeBuildDir
350 # FIXME: Would be nice if the commands were echoed to the log file too.
353 env CC
="$c_compiler" CXX
="$cxx_compiler" \
354 cmake
-G "$generator" -B $CMakeBuildDir -S $SrcDir/llvm \
355 -C $SrcDir/clang
/cmake
/caches
/Release.cmake \
356 -DCLANG_BOOTSTRAP_PASSTHROUGH="LLVM_LIT_ARGS" \
357 -DLLVM_LIT_ARGS="-j $NumJobs $LitVerbose" \
359 2>&1 |
tee $LogDir/llvm.configure-
$Flavor.log
361 ${MAKE} $J_ARG $Verbose -C $CMakeBuildDir stage2-check-all \
362 2>&1 |
tee $LogDir/llvm.make-
$Flavor.log
> $redir
364 DESTDIR
="${InstallDir}" \
365 ${MAKE} -C $CMakeBuildDir stage2-install \
366 2>&1 |
tee $LogDir/llvm.install-
$Flavor.log
> $redir
368 mkdir
-p $BuildDir/Release
369 pushd $BuildDir/Release
370 mv $InstallDir/usr
/local $Package
371 if [ "$use_gzip" = "yes" ]; then
372 tar cf
- $Package |
gzip -9c > $BuildDir/$Package.
tar.gz
374 tar cf
- $Package | xz
-9ce -T $NumJobs > $BuildDir/$Package.
tar.xz
376 mv $Package $InstallDir/usr
/local
378 ) 2>&1 |
tee $LogDir/testing.
$Release-$RC.log
383 function deferred_error
() {
387 echo "[${Flavor} Phase${Phase}] ${Msg}" |
tee -a $LogDir/deferred_errors.log
390 # Make sure that a required program is available
391 function check_program_exists
() {
393 if ! type -P $program > /dev
/null
2>&1 ; then
394 echo "program '$1' not found !"
399 if [ "$System" != "Darwin" ] && [ "$System" != "SunOS" ] && [ "$System" != "AIX" ]; then
400 check_program_exists
'chrpath'
403 if [ "$System" != "Darwin" ]; then
404 check_program_exists
'file'
405 check_program_exists
'objdump'
408 check_program_exists
${MAKE}
410 # Export sources to the build directory.
411 function export_sources
() {
412 SrcDir
=$BuildDir/llvm-project
414 echo "# Using git ref: $git_ref"
416 # GitHub allows you to download a tarball of any commit using the URL:
417 # https://github.com/$organization/$repo/archive/$ref.tar.gz
418 curl
-L https
://github.com
/llvm
/llvm-project
/archive
/$git_ref.
tar.gz | \
419 tar -C $SrcDir --strip-components=1 -xzf -
421 if [ "$do_test_suite" = "yes" ]; then
422 TestSuiteSrcDir
=$BuildDir/llvm-test-suite
423 mkdir
-p $TestSuiteSrcDir
425 # We can only use named refs, like branches and tags, that exist in
426 # both the llvm-project and test-suite repos if we want to run the
428 # If the test-suite fails to download assume we are using a ref that
429 # doesn't exist in the test suite and disable it.
431 curl
-L https
://github.com
/llvm
/test-suite
/archive
/$git_ref.
tar.gz | \
432 tar -C $TestSuiteSrcDir --strip-components=1 -xzf -
433 if [ $?
-ne -0 ]; then
434 echo "$git_ref not found in test-suite repo, test-suite disabled."
443 function configure_llvmCore
() {
462 echo "# Invalid flavor '$Flavor'"
468 # During the first two phases, there is no need to build any of the projects
469 # except clang, since these phases are only meant to produce a bootstrapped
470 # clang compiler, capable of building the third phase.
471 if [ "$Phase" -lt "3" ]; then
474 project_list
="$projects"
476 # During the first phase, there is no need to build any of the runtimes,
477 # since this phase is only meant to get a clang compiler, capable of
478 # building itself and any selected runtimes in the second phase.
479 if [ "$Phase" -lt "2" ]; then
481 # compiler-rt builtins is needed on AIX to have a functional Phase 1 clang.
482 if [ "$System" = "AIX" ]; then
483 runtime_list
="compiler-rt"
486 runtime_list
="$runtimes"
489 echo "# Using C compiler: $c_compiler"
490 echo "# Using C++ compiler: $cxx_compiler"
493 echo "# Configuring llvm $Release-$RC $Flavor"
495 echo "#" env CC
="$c_compiler" CXX
="$cxx_compiler" \
496 cmake
-G "$generator" \
497 -DCMAKE_BUILD_TYPE=$BuildType -DLLVM_ENABLE_ASSERTIONS=$Assertions \
498 -DCMAKE_POSITION_INDEPENDENT_CODE=ON \
499 -DLLVM_ENABLE_PROJECTS="$project_list" \
500 -DLLVM_LIT_ARGS="-j $NumJobs $LitVerbose" \
501 -DLLVM_ENABLE_RUNTIMES="$runtime_list" \
502 $ExtraConfigureFlags $BuildDir/llvm-project
/llvm \
503 2>&1 |
tee $LogDir/llvm.configure-Phase
$Phase-$Flavor.log
504 env CC
="$c_compiler" CXX
="$cxx_compiler" \
505 cmake
-G "$generator" \
506 -DCMAKE_BUILD_TYPE=$BuildType -DLLVM_ENABLE_ASSERTIONS=$Assertions \
507 -DCMAKE_POSITION_INDEPENDENT_CODE=ON \
508 -DLLVM_ENABLE_PROJECTS="$project_list" \
509 -DLLVM_LIT_ARGS="-j $NumJobs $LitVerbose" \
510 -DLLVM_ENABLE_RUNTIMES="$runtime_list" \
511 $ExtraConfigureFlags $BuildDir/llvm-project
/llvm \
512 2>&1 |
tee $LogDir/llvm.configure-Phase
$Phase-$Flavor.log
517 function build_llvmCore
() {
524 if [ ${MAKE} = 'ninja' ]; then
529 InstallTarget
="install"
530 if [ "$Phase" -lt "3" ]; then
532 InstallTarget
="install-clang install-clang-resource-headers"
533 # compiler-rt builtins is needed on AIX to have a functional Phase 1 clang.
534 if [ "$System" = "AIX" ]; then
535 BuildTarget
="$BuildTarget runtimes"
536 InstallTarget
="$InstallTarget install-builtins"
539 if [ "$Phase" -eq "3" ]; then
540 # Build everything at once, with the proper parallelism and verbosity,
546 echo "# Compiling llvm $Release-$RC $Flavor"
547 echo "# ${MAKE} $J_ARG $Verbose"
548 ${MAKE} $J_ARG $Verbose $BuildTarget \
549 2>&1 |
tee $LogDir/llvm.make-Phase
$Phase-$Flavor.log
> $redir
551 echo "# Installing llvm $Release-$RC $Flavor"
552 echo "# ${MAKE} install"
553 DESTDIR
="${DestDir}" ${MAKE} $InstallTarget \
554 2>&1 |
tee $LogDir/llvm.install-Phase
$Phase-$Flavor.log
> $redir
558 function test_llvmCore
() {
564 if [ ${MAKE} = 'ninja' ]; then
565 # Ninja doesn't have a documented "keep-going-forever" mode, we need to
566 # set a limit on how many jobs can fail before we give up.
571 if ! ( ${MAKE} $J_ARG $KeepGoing $Verbose check-all \
572 2>&1 |
tee $LogDir/llvm.check-Phase
$Phase-$Flavor.log
) ; then
573 deferred_error
$Phase $Flavor "check-all failed"
576 if [ $do_test_suite = 'yes' ]; then
577 cd $TestSuiteBuildDir
578 env CC
="$c_compiler" CXX
="$cxx_compiler" \
579 cmake
$TestSuiteSrcDir -G "$generator" -DTEST_SUITE_LIT=$Lit \
580 -DTEST_SUITE_HOST_CC=$build_compiler
582 if ! ( ${MAKE} $J_ARG $KeepGoing $Verbose check \
583 2>&1 |
tee $LogDir/llvm.check-Phase
$Phase-$Flavor.log
) ; then
584 deferred_error
$Phase $Flavor "test suite failed"
590 # Clean RPATH. Libtool adds the build directory to the search path, which is
591 # not necessary --- and even harmful --- for the binary packages we release.
592 function clean_RPATH
() {
593 if [ "$System" = "Darwin" ] ||
[ "$System" = "SunOS" ] ||
[ "$System" = "AIX" ]; then
596 local InstallPath
="$1"
597 for Candidate
in `find $InstallPath/{bin,lib} -type f`; do
598 if file $Candidate |
grep ELF |
egrep 'executable|shared object' > /dev
/null
2>&1 ; then
599 if rpath
=`objdump -x $Candidate | grep 'RPATH'` ; then
600 rpath
=`echo $rpath | sed -e's/^ *RPATH *//'`
601 if [ -n "$rpath" ]; then
602 newrpath
=`echo $rpath | sed -e's/.*\(\$ORIGIN[^:]*\).*/\1/'`
603 chrpath
-r $newrpath $Candidate 2>&1 > /dev
/null
2>&1
610 # Create a package of the release binaries.
611 function package_release
() {
613 cd $BuildDir/Phase
3/Release
614 mv llvmCore-
$Release-$RC.install
/usr
/local $Package
615 if [ "$use_gzip" = "yes" ]; then
616 tar cf
- $Package |
gzip -9c > $BuildDir/$Package.
tar.gz
618 tar cf
- $Package | xz
-9ce -T $NumJobs > $BuildDir/$Package.
tar.xz
620 mv $Package llvmCore-
$Release-$RC.install
/usr
/local
624 # Exit if any command fails
625 # Note: pipefail is necessary for running build commands through
626 # a pipe (i.e. it changes the output of ``false | tee /dev/null ; echo $?``)
630 # Turn off core dumps, as some test cases can easily fill up even the largest
634 if [ "$do_checkout" = "yes" ]; then
638 # Setup the test-suite. Do this early so we can catch failures before
639 # we do the full 3 stage build.
640 if [ $do_test_suite = "yes" ]; then
641 check_program_exists
'python3'
642 venv
="python3 -m venv"
644 SandboxDir
="$BuildDir/sandbox"
645 Lit
=$SandboxDir/bin
/lit
646 TestSuiteBuildDir
="$BuildDir/test-suite-build"
647 TestSuiteSrcDir
="$BuildDir/llvm-test-suite"
650 $SandboxDir/bin
/python
-m pip
install $BuildDir/llvm-project
/llvm
/utils
/lit
651 mkdir
-p $TestSuiteBuildDir
654 if [ "$do_cmake_cache" = "yes" ]; then
655 build_with_cmake_cache
662 if [ "$do_debug" = "yes" ]; then
663 Flavors
="Debug $Flavors"
665 if [ "$do_asserts" = "yes" ]; then
666 Flavors
="$Flavors Release+Asserts"
669 for Flavor
in $Flavors ; do
672 echo "********************************************************************************"
673 echo " Release: $Release-$RC"
674 echo " Build: $Flavor"
675 echo " System Info: "
677 echo "********************************************************************************"
683 [[ -z "$build_compiler" ]] && build_compiler
="cc"
684 llvmCore_phase1_objdir
=$BuildDir/Phase
1/$Flavor/llvmCore-
$Release-$RC.obj
685 llvmCore_phase1_destdir
=$BuildDir/Phase
1/$Flavor/llvmCore-
$Release-$RC.
install
687 llvmCore_phase2_objdir
=$BuildDir/Phase
2/$Flavor/llvmCore-
$Release-$RC.obj
688 llvmCore_phase2_destdir
=$BuildDir/Phase
2/$Flavor/llvmCore-
$Release-$RC.
install
690 llvmCore_phase3_objdir
=$BuildDir/Phase
3/$Flavor/llvmCore-
$Release-$RC.obj
691 llvmCore_phase3_destdir
=$BuildDir/Phase
3/$Flavor/llvmCore-
$Release-$RC.
install
693 rm -rf $llvmCore_phase1_objdir
694 rm -rf $llvmCore_phase1_destdir
696 rm -rf $llvmCore_phase2_objdir
697 rm -rf $llvmCore_phase2_destdir
699 rm -rf $llvmCore_phase3_objdir
700 rm -rf $llvmCore_phase3_destdir
702 mkdir
-p $llvmCore_phase1_objdir
703 mkdir
-p $llvmCore_phase1_destdir
705 mkdir
-p $llvmCore_phase2_objdir
706 mkdir
-p $llvmCore_phase2_destdir
708 mkdir
-p $llvmCore_phase3_objdir
709 mkdir
-p $llvmCore_phase3_destdir
711 ############################################################################
712 # Phase 1: Build llvmCore and clang
713 echo "# Phase 1: Building llvmCore"
714 configure_llvmCore
1 $Flavor $llvmCore_phase1_objdir
715 build_llvmCore
1 $Flavor \
716 $llvmCore_phase1_objdir $llvmCore_phase1_destdir
717 clean_RPATH
$llvmCore_phase1_destdir/usr
/local
719 ########################################################################
720 # Phase 2: Build llvmCore with newly built clang from phase 1.
721 c_compiler
=$llvmCore_phase1_destdir/usr
/local
/bin
/clang
722 cxx_compiler
=$llvmCore_phase1_destdir/usr
/local
/bin
/clang
++
723 echo "# Phase 2: Building llvmCore"
724 configure_llvmCore
2 $Flavor $llvmCore_phase2_objdir
725 build_llvmCore
2 $Flavor \
726 $llvmCore_phase2_objdir $llvmCore_phase2_destdir
727 clean_RPATH
$llvmCore_phase2_destdir/usr
/local
729 ########################################################################
730 # Phase 3: Build llvmCore with newly built clang from phase 2.
731 c_compiler
=$llvmCore_phase2_destdir/usr
/local
/bin
/clang
732 cxx_compiler
=$llvmCore_phase2_destdir/usr
/local
/bin
/clang
++
733 echo "# Phase 3: Building llvmCore"
734 configure_llvmCore
3 $Flavor $llvmCore_phase3_objdir
735 build_llvmCore
3 $Flavor \
736 $llvmCore_phase3_objdir $llvmCore_phase3_destdir
737 clean_RPATH
$llvmCore_phase3_destdir/usr
/local
739 ########################################################################
740 # Testing: Test phase 3
741 c_compiler
=$llvmCore_phase3_destdir/usr
/local
/bin
/clang
742 cxx_compiler
=$llvmCore_phase3_destdir/usr
/local
/bin
/clang
++
743 echo "# Testing - built with clang"
744 test_llvmCore
3 $Flavor $llvmCore_phase3_objdir
746 ########################################################################
747 # Compare .o files between Phase2 and Phase3 and report which ones
749 if [ "$do_compare" = "yes" ]; then
751 echo "# Comparing Phase 2 and Phase 3 files"
752 for p2
in `find $llvmCore_phase2_objdir -name '*.o'` ; do
753 p3
=`echo $p2 | sed -e 's,Phase2,Phase3,'`
754 # Substitute 'Phase2' for 'Phase3' in the Phase 2 object file in
755 # case there are build paths in the debug info. Do the same sub-
756 # stitution on both files in case the string occurrs naturally.
758 <(env LC_ALL
=C
sed -e 's,Phase1,Phase2,g' -e 's,Phase2,Phase3,g' $p2) \
759 <(env LC_ALL
=C
sed -e 's,Phase1,Phase2,g' -e 's,Phase2,Phase3,g' $p3) \
761 echo "file `basename $p2` differs between phase 2 and phase 3"
767 ) 2>&1 |
tee $LogDir/testing.
$Release-$RC.log
769 if [ "$use_gzip" = "yes" ]; then
770 echo "# Packaging the release as $Package.tar.gz"
772 echo "# Packaging the release as $Package.tar.xz"
779 echo "### Testing Finished ###"
780 echo "### Logs: $LogDir"
783 if [ -s "$LogDir/deferred_errors.log" ]; then
784 cat "$LogDir/deferred_errors.log"