3 # Programs returning != 0 will not cause script to exit
6 # Case insensitive string comparison
14 GIT_PROTOCOL=${GIT_PROTOCOL:="git"}
15 GIT_URL=${GIT_URL:=$GIT_PROTOCOL"://github.com/factor/factor.git"}
18 REQUIRE_CLANG_VERSION=3.1
21 test_program_installed() {
22 if ! [[ -n $(type -p $1) ]] ; then
29 test_programs_installed() {
31 $ECHO -n "Checking for all($*)..."
34 test_program_installed $i
35 if [[ $? -eq 1 ]]; then
36 installed=$(( $installed + 1 ))
39 if [[ $installed -eq $# ]] ; then
43 $ECHO "all not found."
49 if [[ $FIND_MAKE_TARGET = true ]] ; then
50 # Must be echo not $ECHO
56 ensure_program_installed() {
58 $ECHO -n "Checking for any($*)..."
61 test_program_installed $i
62 if [[ $? -eq 1 ]]; then
64 installed=$(( $installed + 1 ))
70 if [[ $# -eq 1 ]] ; then
73 $ECHO -n "any of [ $* ]"
75 $ECHO " and try again."
76 if [[ $OS == macosx ]] ; then
77 $ECHO "If you have Xcode 4.3 or higher installed, you must install the"
78 $ECHO "Command Line Tools from Xcode Preferences > Downloads in order"
79 $ECHO "to build Factor."
86 if [[ $RET -ne 0 ]] ; then
93 test_program_installed wget
94 if [[ $? -ne 0 ]] ; then
99 test_program_installed curl
100 if [[ $? -ne 0 ]] ; then
101 DOWNLOADER="curl -L -f -O"
105 $ECHO "error: wget or curl required"
110 test_program_installed md5sum
111 if [[ $? -ne 0 ]] ; then
119 RE_SEMVER="^([0-9]*)\.([0-9]*)\.([0-9]*)-?(.*)?$" # 3.3.3-5
120 CLANG_RE_OLD="^([0-9]*)\.([0-9]*)-?(.*)?$" # 3.3-5
121 if [[ $1 =~ $RE_SEMVER ]] ; then
122 export "$2=${BASH_REMATCH[1]}"
123 export "$3=${BASH_REMATCH[2]}"
124 export "$4=${BASH_REMATCH[3]}"
125 export "$5=${BASH_REMATCH[4]}"
126 elif [[ $1 =~ $CLANG_RE_OLD ]] ; then
127 export "$2=${BASH_REMATCH[1]}"
128 export "$3=${BASH_REMATCH[2]}"
130 export "$5=${BASH_REMATCH[3]}"
132 echo "unsupported version number, please report a bug: $1"
138 CLANG_VERSION=$(clang --version | head -n1)
139 CLANG_VERSION_RE='^[a-zA-Z0-9 ]* version (.*)$' # 3.3-5
140 if [[ $CLANG_VERSION =~ $CLANG_VERSION_RE ]] ; then
141 export "CLANG_VERSION=${BASH_REMATCH[1]}"
142 local CLANG_MAJOR CLANG_MINOR CLANG_PATCH CLANG_SPECIAL
143 semver_into "$CLANG_VERSION" CLANG_MAJOR CLANG_MINOR CLANG_PATCH CLANG_SPECIAL
144 if [[ $CLANG_MAJOR -lt 3
145 || ( $CLANG_MAJOR -eq 3 && $CLANG_MINOR -le 1 )
147 echo "clang version required >= $REQUIRE_CLANG_VERSION, got $CLANG_VERSION"
157 # on Cygwin we MUST use the MinGW "cross-compiler", therefore check these first
158 # furthermore, we prefer 64 bit over 32 bit versions if both are available
160 # we need this condition so we don't find a mingw32 compiler on linux
161 if [[ $OS == windows ]] ; then
162 test_programs_installed x86_64-w64-mingw32-gcc x86_64-w64-mingw32-g++
163 if [[ $? -ne 0 ]] ; then
164 [ -z "$CC" ] && CC=x86_64-w64-mingw32-gcc
165 [ -z "$CXX" ] && CXX=x86_64-w64-mingw32-g++
169 test_programs_installed i686-w64-mingw32-gcc i686-w64-mingw32-g++
170 if [[ $? -ne 0 ]] ; then
171 [ -z "$CC" ] && CC=i686-w64-mingw32-gcc
172 [ -z "$CXX" ] && CXX=i686-w64-mingw32-g++
177 test_programs_installed clang clang++
178 if [[ $? -ne 0 ]] && clang_version_ok ; then
179 [ -z "$CC" ] && CC=clang
180 [ -z "$CXX" ] && CXX=clang++
184 # gcc and g++ will fail to correctly build Factor on Cygwin
185 test_programs_installed gcc g++
186 if [[ $? -ne 0 ]] ; then
187 [ -z "$CC" ] && CC=gcc
188 [ -z "$CXX" ] && CXX=g++
192 $ECHO "error: high enough version of either (clang/clang++) or (gcc/g++) required!"
198 freebsd) MAKE=gmake ;;
201 if [[ $MAKE = 'gmake' ]] ; then
202 ensure_program_installed gmake
206 check_installed_programs() {
207 ensure_program_installed chmod
208 ensure_program_installed uname
209 ensure_program_installed git
210 ensure_program_installed wget curl
211 ensure_program_installed clang x86_64-w64-mingw32-gcc i686-w64-mingw32-gcc gcc
212 ensure_program_installed clang++ x86_64-w64-mingw32-g++ i686-w64-mingw32-g++ g++ cl
213 ensure_program_installed make gmake
214 ensure_program_installed md5sum md5
215 ensure_program_installed cut
218 check_library_exists() {
219 GCC_TEST=factor-library-test.c
220 GCC_OUT=factor-library-test.out
221 $ECHO -n "Checking for library $1..."
222 $ECHO "int main(){return 0;}" > $GCC_TEST
223 $CC $GCC_TEST -o $GCC_OUT -l $1 2>&-
224 if [[ $? -ne 0 ]] ; then
235 check_X11_libraries() {
236 check_library_exists GL
237 check_library_exists X11
238 check_library_exists pango-1.0
241 check_gtk_libraries() {
242 check_library_exists gobject-2.0
243 check_library_exists gtk-x11-2.0
244 check_library_exists gdk-x11-2.0
245 check_library_exists gdk_pixbuf-2.0
246 check_library_exists gtkglext-x11-1.0
247 check_library_exists atk-1.0
248 check_library_exists gio-2.0
249 check_library_exists gdkglext-x11-1.0
250 check_library_exists pango-1.0
256 linux) check_X11_libraries
257 check_gtk_libraries;;
258 unix) check_gtk_libraries;;
262 check_factor_exists() {
263 if [[ -d "factor" ]] ; then
264 $ECHO "A directory called 'factor' already exists."
265 $ECHO "Rename or delete it and try again."
271 if [[ -n $OS ]] ; then return; fi
272 $ECHO "Finding OS..."
273 local uname_s=$(uname -s)
276 CYGWIN_NT-5.2-WOW64) OS=windows;;
277 *CYGWIN_NT*) OS=windows;;
278 *CYGWIN*) OS=windows;;
279 MINGW32*) OS=windows;;
280 MINGW64*) OS=windows;;
281 MSYS_NT*) OS=windows;;
282 *darwin*) OS=macosx;;
283 *Darwin*) OS=macosx;;
286 FreeBSD) OS=freebsd;;
291 find_architecture() {
292 if [[ -n $ARCH ]] ; then return; fi
293 $ECHO "Finding ARCH..."
304 aarch64) ARCH=arm64;;
305 iPhone5*[3-9]) ARCH=arm64;;
306 iPhone[6-9]*) ARCH=arm64;;
307 iPhone[1-9][0-9]*) ARCH=arm64;;
308 iPad[4-9]*) ARCH=arm64;;
309 iPad[1-9][0-9]*) ARCH=arm64;;
310 AppleTV[5-9]*) ARCH=arm64;;
311 AppleTV[1-9][0-9]*) ARCH=arm64;;
312 "Power Macintosh") ARCH=ppc;;
317 $ECHO "Finding num cores..."
322 CYGWIN_NT-5.2-WOW64 | *CYGWIN_NT* | *CYGWIN* | MINGW32*) NUM_CORES=$NUMBER_OF_PROCESSORS;;
323 *linux* | *Linux*) NUM_CORES=$(getconf _NPROCESSORS_ONLN || nproc);;
324 *darwin* | *Darwin* | freebsd) NUM_CORES=$(sysctl -n hw.ncpu);;
328 echo_test_program() {
330 echo -e "int main(){ return (long)(8*sizeof(void*)); }"
334 $ECHO "Finding WORD..."
335 C_WORD="factor-word-size"
336 echo_test_program | $CC -o $C_WORD -xc -
344 echo "Word size should be 32/64, got $WORD"
351 intel_macosx_word_size() {
352 ensure_program_installed sysctl
353 $ECHO -n "Testing if your Intel Mac supports 64bit binaries..."
354 sysctl machdep.cpu.extfeatures | grep EM64T >/dev/null
355 if [[ $? -eq 0 ]] ; then
365 if [[ -n $WORD ]] ; then return; fi
366 if [[ $OS == macosx && $ARCH == x86 ]] ; then
367 intel_macosx_word_size
369 WORD=$(find_word_size_cpp || c_find_word_size)
373 find_word_size_cpp() {
374 SIXTY_FOUR='defined(__aarch64__) || defined(__x86_64__) || defined(_M_AMD64) || defined(__PPC64__) || defined(__64BIT__)'
375 THIRTY_TWO='defined(i386) || defined(__i386) || defined(__i386__) || defined(_MIX86)'
376 cc -E -xc <(echo -e "#if ${SIXTY_FOUR}\n64\n#elif ${THIRTY_TWO}\n32\n#endif") | tail -1
379 set_factor_binary() {
381 windows) FACTOR_BINARY=factor.com;;
382 *) FACTOR_BINARY=factor;;
386 set_factor_library() {
388 windows) FACTOR_LIBRARY=factor.dll;;
389 macosx) FACTOR_LIBRARY=libfactor.dylib;;
390 *) FACTOR_LIBRARY=libfactor.a;;
395 FACTOR_IMAGE=factor.image
396 FACTOR_IMAGE_FRESH=factor.image.fresh
402 $ECHO NUM_CORES=$NUM_CORES
405 $ECHO REPRODUCIBLE=$REPRODUCIBLE
406 $ECHO CURRENT_BRANCH=$CURRENT_BRANCH
407 $ECHO FACTOR_BINARY=$FACTOR_BINARY
408 $ECHO FACTOR_LIBRARY=$FACTOR_LIBRARY
409 $ECHO FACTOR_IMAGE=$FACTOR_IMAGE
410 $ECHO MAKE_TARGET=$MAKE_TARGET
411 $ECHO BOOT_IMAGE=$BOOT_IMAGE
412 $ECHO MAKE_IMAGE_TARGET=$MAKE_IMAGE_TARGET
413 $ECHO GIT_PROTOCOL=$GIT_PROTOCOL
414 $ECHO GIT_URL=$GIT_URL
415 $ECHO DOWNLOADER=$DOWNLOADER
423 check_os_arch_word() {
424 if ! [[ -n $OS && -n $ARCH && -n $WORD ]] ; then
428 $ECHO "OS, ARCH, or WORD is empty. Please report this."
437 if [[ $OS == linux && $ARCH == ppc ]] ; then
438 MAKE_IMAGE_TARGET=linux-ppc.32
439 MAKE_TARGET=linux-ppc-32
440 elif [[ $OS == windows && $ARCH == x86 && $WORD == 64 ]] ; then
441 MAKE_IMAGE_TARGET=windows-x86.64
442 MAKE_TARGET=windows-x86-64
443 elif [[ $OS == windows && $ARCH == x86 && $WORD == 32 ]] ; then
444 MAKE_IMAGE_TARGET=windows-x86.32
445 MAKE_TARGET=windows-x86-32
446 elif [[ $ARCH == x86 && $WORD == 64 ]] ; then
447 MAKE_IMAGE_TARGET=unix-x86.64
448 MAKE_TARGET=$OS-x86-64
449 elif [[ $ARCH == x86 && $WORD == 32 ]] ; then
450 MAKE_IMAGE_TARGET=unix-x86.32
451 MAKE_TARGET=$OS-x86-32
453 MAKE_IMAGE_TARGET=$ARCH.$WORD
454 MAKE_TARGET=$OS-$ARCH-$WORD
456 BOOT_IMAGE=boot.$MAKE_IMAGE_TARGET.image
460 ensure_program_installed cut
461 $ECHO "Parsing make target from command line: $1"
462 OS=$(echo $1 | cut -d '-' -f 1)
463 ARCH=$(echo $1 | cut -d '-' -f 2)
464 WORD=$(echo $1 | cut -d '-' -f 3)
466 if [[ $OS == linux && $ARCH == ppc ]] ; then WORD=32; fi
467 if [[ $OS == linux && $ARCH == arm ]] ; then WORD=32; fi
468 if [[ $OS == macosx && $ARCH == ppc ]] ; then WORD=32; fi
497 $ECHO "Downloading the git repository from github.com..."
498 invoke_git clone $GIT_URL
501 update_script_name() {
502 $ECHO "$(dirname $0)/_update.sh"
506 local -r update_script=$(update_script_name)
507 local -r bash_path=$(which bash)
508 $ECHO "updating from ${CURRENT_BRANCH}"
509 $ECHO "#!$bash_path" >"$update_script"
510 $ECHO "git pull \"$GIT_URL\" ${CURRENT_BRANCH}" >>"$update_script"
511 $ECHO "if [[ \$? -eq 0 ]]; then exec \"$0\" $SCRIPT_ARGS; else echo \"git pull failed\"; exit 2; fi" \
513 $ECHO "exit 0" >>"$update_script"
515 chmod 755 "$update_script"
516 exec "$update_script"
519 update_script_changed() {
520 invoke_git diff --stat "$(invoke_git merge-base HEAD FETCH_HEAD)" FETCH_HEAD | grep 'build\.sh' >/dev/null
524 $ECHO "Fetching the git repository from github.com..."
527 rm -f "$(update_script_name)"
528 $ECHO git fetch "$GIT_URL" "${CURRENT_BRANCH}"
529 invoke_git fetch "$GIT_URL" "${CURRENT_BRANCH}"
531 if update_script_changed; then
532 $ECHO "Updating and restarting the build.sh script..."
535 $ECHO "Updating the working tree..."
536 invoke_git pull "$GIT_URL" "${CURRENT_BRANCH}"
560 $ECHO "Backing up factor..."
561 $COPY $FACTOR_BINARY $FACTOR_BINARY.bak
562 $COPY $FACTOR_LIBRARY $FACTOR_LIBRARY.bak
563 $COPY $BOOT_IMAGE $BOOT_IMAGE.bak
564 $COPY $FACTOR_IMAGE $FACTOR_IMAGE.bak
565 $ECHO "Done with backup."
568 check_makefile_exists() {
569 if [[ ! -e "GNUmakefile" ]] ; then
571 $ECHO "***GNUmakefile not found***"
572 $ECHO "You are likely in the wrong directory."
573 $ECHO "Run this script from your factor directory:"
580 check_makefile_exists
581 $MAKE $MAKE_OPTS "$@"
590 $ECHO "Building factor with $NUM_CORES cores"
591 invoke_make CC=$CC CXX=$CXX $MAKE_TARGET -j$NUM_CORES
594 make_clean_factor() {
599 current_git_branch() {
600 # git rev-parse --abbrev-ref HEAD # outputs HEAD for detached head
601 # outputs nothing for detached HEAD, which is fine for ``git fetch``
602 git describe --all --exact-match 2>/dev/null | sed 's=.*/=='
606 if [[ $DOWNLOADER_NAME == 'wget' ]]; then
607 if [[ $(wget -S --spider $1 2>&1 | grep 'HTTP/1.1 200 OK') ]]; then
612 elif [[ $DOWNLOADER_NAME == 'curl' ]]; then
613 local code=$(curl -sL -w "%{http_code}\\n" "$1" -o /dev/null)
614 if [[ $code -eq 200 ]]; then return 0; else return 1; fi
616 $ECHO "error: wget or curl required in check_url"
621 # If we are on a branch, first try to get a boot image for that branch.
622 # Otherwise, just use `master`
623 set_boot_image_vars() {
625 local url="http://downloads.factorcode.org/images/${CURRENT_BRANCH}/checksums.txt"
627 if [[ $? -eq 0 ]]; then
629 BOOT_IMAGE_URL="http://downloads.factorcode.org/images/${CURRENT_BRANCH}/${BOOT_IMAGE}"
631 $ECHO "boot image for branch \`${CURRENT_BRANCH}\` is not on server, trying master instead"
632 $ECHO " tried nonexistent url: ${url}"
633 CHECKSUM_URL="http://downloads.factorcode.org/images/master/checksums.txt"
634 BOOT_IMAGE_URL="http://downloads.factorcode.org/images/master/${BOOT_IMAGE}"
638 set_current_branch() {
639 if [ -n "${CI_BRANCH}" ]; then
640 CURRENT_BRANCH="${CI_BRANCH}"
642 CURRENT_BRANCH=$(current_git_branch)
646 update_boot_image() {
648 $ECHO "Deleting old images..."
649 $DELETE checksums.txt* > /dev/null 2>&1
650 # delete boot images with one or two characters after the dot
651 $DELETE $BOOT_IMAGE.{?,??} > /dev/null 2>&1
652 $DELETE temp/staging.*.image > /dev/null 2>&1
653 if [[ -f $BOOT_IMAGE ]] ; then
654 get_url $CHECKSUM_URL
655 local factorcode_md5=$(cat checksums.txt | grep $BOOT_IMAGE | cut -f2 -d' ')
657 local disk_md5=$($MD5SUM $BOOT_IMAGE | cut -f1 -d' ')
658 $ECHO "Factorcode md5: $factorcode_md5";
659 $ECHO "Disk md5: $disk_md5";
660 if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
661 $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
663 $DELETE $BOOT_IMAGE > /dev/null 2>&1
672 $ECHO "Downloading boot image $BOOT_IMAGE."
673 get_url "${BOOT_IMAGE_URL}"
677 if [[ -z $DOWNLOADER ]] ; then
680 $ECHO $DOWNLOADER $1 ;
682 check_ret $DOWNLOADER
687 check_installed_programs
692 $ECHO "Copying $FACTOR_IMAGE to $FACTOR_IMAGE_FRESH..."
693 $COPY $FACTOR_IMAGE $FACTOR_IMAGE_FRESH
697 ./$FACTOR_BINARY -i=$BOOT_IMAGE
719 download_and_bootstrap() {
724 net_bootstrap_no_pull() {
727 download_and_bootstrap
731 ./$FACTOR_BINARY -e="USING: vocabs.loader vocabs.refresh system memory ; refresh-all save 0 exit"
736 ./$FACTOR_BINARY -run="bootstrap.image" "$MAKE_IMAGE_TARGET"
741 sudo apt install --yes libc6-dev libpango1.0-dev libx11-dev xorg-dev libgtk2.0-dev gtk2-engines-pixbuf libgtkglext1-dev wget git git-doc rlwrap clang make screen tmux libssl-dev
745 install_deps_pacman() {
746 sudo pacman --noconfirm -Syu gcc clang make rlwrap git wget pango glibc gtk2 gtk3 gtkglext gtk-engines gdk-pixbuf2 libx11 screen tmux
751 sudo dnf --assumeyes install gcc gcc-c++ glibc-devel binutils libX11-devel pango-devel gtk3-devel gdk-pixbuf2-devel gtkglext-devel tmux rlwrap wget
756 sudo pkg install --yes git gmake gcc rlwrap ripgrep curl gmake x11-toolkits/gtk30 x11-toolkits/gtkglext pango cairo vim
760 install_deps_macosx() {
761 test_program_installed git
762 if [[ $? -ne 1 ]] ; then
763 ensure_program_installed yes
764 $ECHO "git not found."
765 $ECHO "This script requires either git-core or port."
766 $ECHO "If it fails, install git-core or port and try again."
767 ensure_program_installed port
768 $ECHO "Installing git-core with port...this will take awhile."
769 yes | sudo port install git-core
774 $ECHO "usage: $0 command [optional-target]"
775 $ECHO " install - git clone, compile, bootstrap"
776 $ECHO " deps-apt - install required packages for Factor on Linux using apt"
777 $ECHO " deps-pacman - install required packages for Factor on Linux using pacman"
778 $ECHO " deps-dnf - install required packages for Factor on Linux using dnf"
779 $ECHO " deps-pkg - install required packages for Factor on FreeBSD using pkg"
780 $ECHO " deps-macosx - install git on MacOSX using port"
781 $ECHO " self-update - git pull, recompile, make local boot image, bootstrap"
782 $ECHO " quick-update - git pull, refresh-all, save"
783 $ECHO " update|latest - git pull, recompile, download a boot image, bootstrap"
784 $ECHO " compile - compile the binary"
785 $ECHO " recompile - recompile the binary"
786 $ECHO " bootstrap - bootstrap with existing boot image"
787 $ECHO " net-bootstrap - recompile, download a boot image, bootstrap"
788 $ECHO " make-target - find and print the os-arch-cpu string"
789 $ECHO " report|info - print the build variables"
790 $ECHO " update-boot-image - get the boot image for the current branch"
792 $ECHO "If you are behind a firewall, invoke as:"
793 $ECHO "env GIT_PROTOCOL=http $0 <command>"
795 $ECHO "Example for overriding the default target:"
796 $ECHO " $0 update macosx-x86-32"
801 # -n is nonzero length, -z is zero length
802 if [[ -n "$2" ]] ; then
806 if [ "$#" -gt 3 ]; then
808 $ECHO "error: too many arguments"
818 deps-apt) install_deps_apt ;;
819 deps-pacman) install_deps_pacman ;;
820 deps-macosx) install_deps_macosx ;;
821 deps-dnf) install_deps_dnf ;;
822 deps-pkg) install_deps_pkg ;;
823 self-bootstrap) get_config_info; make_boot_image; bootstrap;;
824 self-update) update; make_boot_image; bootstrap;;
825 quick-update) update; refresh_image ;;
826 update|latest) update; download_and_bootstrap ;;
827 compile) find_build_info; make_factor ;;
828 recompile) find_build_info; make_clean; make_factor ;;
829 bootstrap) get_config_info; bootstrap ;;
830 net-bootstrap) net_bootstrap_no_pull ;;
831 make-target) FIND_MAKE_TARGET=true; ECHO=false; find_build_info; exit_script ;;
832 report|info) find_build_info ;;
833 full-report) find_build_info; check_installed_programs; check_libraries ;;
834 update-boot-image) find_build_info; check_installed_programs; update_boot_image;;