3 # Programs returning != 0 will not cause script to exit
6 # Case insensitive string comparison
14 GIT_PROTOCOL=${GIT_PROTOCOL:="https"}
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."
85 # Can't execute any commands before saving $?
86 # $1 is the name of the command we are checking
88 if [[ $RET -ne 0 ]] ; then
95 test_program_installed wget
96 if [[ $? -ne 0 ]] ; then
97 DOWNLOADER="wget -nd --prefer-family=IPv4"
101 test_program_installed curl
102 if [[ $? -ne 0 ]] ; then
103 DOWNLOADER="curl -L -f -O"
107 $ECHO "error: wget or curl required"
112 test_program_installed md5sum
113 if [[ $? -ne 0 ]] ; then
121 RE_SEMVER="^([0-9]*)\.([0-9]*)\.([0-9]*)-?(.*)?$" # 3.3.3-5
122 CLANG_RE_OLD="^([0-9]*)\.([0-9]*)-?(.*)?$" # 3.3-5
123 if [[ $1 =~ $RE_SEMVER ]] ; then
124 export "$2=${BASH_REMATCH[1]}"
125 export "$3=${BASH_REMATCH[2]}"
126 export "$4=${BASH_REMATCH[3]}"
127 export "$5=${BASH_REMATCH[4]}"
128 elif [[ $1 =~ $CLANG_RE_OLD ]] ; then
129 export "$2=${BASH_REMATCH[1]}"
130 export "$3=${BASH_REMATCH[2]}"
132 export "$5=${BASH_REMATCH[3]}"
134 echo "unsupported version number, please report a bug: $1"
140 CLANG_VERSION=$(clang --version | head -n1)
141 CLANG_VERSION_RE='^[a-zA-Z0-9 ]* version (.*)$' # 3.3-5
142 if [[ $CLANG_VERSION =~ $CLANG_VERSION_RE ]] ; then
143 export "CLANG_VERSION=${BASH_REMATCH[1]}"
144 local CLANG_MAJOR CLANG_MINOR CLANG_PATCH CLANG_SPECIAL
145 semver_into "$CLANG_VERSION" CLANG_MAJOR CLANG_MINOR CLANG_PATCH CLANG_SPECIAL
146 if [[ $CLANG_MAJOR -lt 3
147 || ( $CLANG_MAJOR -eq 3 && $CLANG_MINOR -le 1 )
149 echo "clang version required >= $REQUIRE_CLANG_VERSION, got $CLANG_VERSION"
159 # on Cygwin we MUST use the MinGW "cross-compiler", therefore check these first
160 # furthermore, we prefer 64 bit over 32 bit versions if both are available
162 # we need this condition so we don't find a mingw32 compiler on linux
163 if [[ $OS == windows ]] ; then
164 test_programs_installed x86_64-w64-mingw32-gcc x86_64-w64-mingw32-g++
165 if [[ $? -ne 0 ]] ; then
166 [ -z "$CC" ] && CC=x86_64-w64-mingw32-gcc
167 [ -z "$CXX" ] && CXX=x86_64-w64-mingw32-g++
171 test_programs_installed i686-w64-mingw32-gcc i686-w64-mingw32-g++
172 if [[ $? -ne 0 ]] ; then
173 [ -z "$CC" ] && CC=i686-w64-mingw32-gcc
174 [ -z "$CXX" ] && CXX=i686-w64-mingw32-g++
179 test_programs_installed clang clang++
180 if [[ $? -ne 0 ]] && clang_version_ok ; then
181 [ -z "$CC" ] && CC=clang
182 [ -z "$CXX" ] && CXX=clang++
186 # gcc and g++ will fail to correctly build Factor on Cygwin
187 test_programs_installed gcc g++
188 if [[ $? -ne 0 ]] ; then
189 [ -z "$CC" ] && CC=gcc
190 [ -z "$CXX" ] && CXX=g++
194 $ECHO "error: high enough version of either (clang/clang++) or (gcc/g++) required!"
200 freebsd) MAKE=gmake ;;
203 if [[ $MAKE = 'gmake' ]] ; then
204 ensure_program_installed gmake
208 check_installed_programs() {
209 ensure_program_installed chmod
210 ensure_program_installed uname
211 ensure_program_installed git
212 ensure_program_installed wget curl
213 ensure_program_installed clang x86_64-w64-mingw32-gcc i686-w64-mingw32-gcc gcc
214 ensure_program_installed clang++ x86_64-w64-mingw32-g++ i686-w64-mingw32-g++ g++ cl
215 ensure_program_installed make gmake
216 ensure_program_installed md5sum md5
217 ensure_program_installed cut
220 check_library_exists() {
221 GCC_TEST=factor-library-test.c
222 GCC_OUT=factor-library-test.out
223 $ECHO -n "Checking for library $1..."
224 $ECHO "int main(){return 0;}" > $GCC_TEST
225 $CC $GCC_TEST -o $GCC_OUT -l $1 2>&-
226 if [[ $? -ne 0 ]] ; then
237 check_X11_libraries() {
238 check_library_exists GL
239 check_library_exists X11
240 check_library_exists pango-1.0
243 check_gtk_libraries() {
244 check_library_exists gobject-2.0
245 check_library_exists gtk-x11-2.0
246 check_library_exists gdk-x11-2.0
247 check_library_exists gdk_pixbuf-2.0
248 check_library_exists gtkglext-x11-1.0
249 check_library_exists atk-1.0
250 check_library_exists gio-2.0
251 check_library_exists gdkglext-x11-1.0
252 check_library_exists pango-1.0
258 linux) check_X11_libraries
259 check_gtk_libraries ;;
260 unix) check_gtk_libraries ;;
264 check_factor_exists() {
265 if [[ -d "factor" ]] ; then
266 $ECHO "A directory called 'factor' already exists."
267 $ECHO "Rename or delete it and try again."
273 if [[ -n $OS ]] ; then return; fi
274 $ECHO "Finding OS..."
275 local uname_s=$(uname -s)
278 CYGWIN_NT-5.2-WOW64) OS=windows ;;
279 *CYGWIN_NT*) OS=windows ;;
280 *CYGWIN*) OS=windows ;;
281 MINGW32*) OS=windows ;;
282 MINGW64*) OS=windows ;;
283 MSYS_NT*) OS=windows ;;
284 *darwin*) OS=macosx ;;
285 *Darwin*) OS=macosx ;;
288 FreeBSD) OS=freebsd ;;
293 find_architecture() {
294 if [[ -n $ARCH ]] ; then return; fi
295 $ECHO "Finding ARCH..."
306 aarch64) ARCH=arm64 ;;
308 iPhone5*[3-9]) ARCH=arm64 ;;
309 iPhone[6-9]*) ARCH=arm64 ;;
310 iPhone[1-9][0-9]*) ARCH=arm64 ;;
311 iPad[4-9]*) ARCH=arm64 ;;
312 iPad[1-9][0-9]*) ARCH=arm64 ;;
313 AppleTV[5-9]*) ARCH=arm64 ;;
314 AppleTV[1-9][0-9]*) ARCH=arm64 ;;
315 "Power Macintosh") ARCH=ppc ;;
320 $ECHO "Finding NUM_CORES..."
325 CYGWIN_NT-5.2-WOW64 | *CYGWIN_NT* | *CYGWIN* | MINGW32*) NUM_CORES=$NUMBER_OF_PROCESSORS ;;
326 *linux* | *Linux*) NUM_CORES=$(getconf _NPROCESSORS_ONLN || nproc) ;;
327 *darwin* | *Darwin* | freebsd) NUM_CORES=$(sysctl -n hw.ncpu) ;;
332 if [[ -n $WORD ]] ; then return; fi
333 $ECHO "Finding WORD..."
334 WORD=$(getconf LONG_BIT || find_word_size_cpp || find_word_size_c)
337 find_word_size_cpp() {
338 SIXTY_FOUR='defined(__aarch64__) || defined(__x86_64__) || defined(_M_AMD64) || defined(__PPC64__) || defined(__64BIT__)'
339 THIRTY_TWO='defined(i386) || defined(__i386) || defined(__i386__) || defined(_MIX86)'
340 $CC -E -xc <(echo -e "#if ${SIXTY_FOUR}\n64\n#elif ${THIRTY_TWO}\n32\n#endif") | tail -1
344 C_WORD="factor-word-size"
345 TEST_PROGRAM="int main(){ return (long)(8*sizeof(void*)); }"
346 echo $TEST_PROGRAM | $CC -o $C_WORD -xc -
354 echo "Word size should be 32/64, got '$WORD_OUT'"
361 set_factor_binary() {
363 windows) FACTOR_BINARY=factor.com ;;
364 *) FACTOR_BINARY=factor ;;
368 set_factor_library() {
370 windows) FACTOR_LIBRARY=factor.dll ;;
371 macosx) FACTOR_LIBRARY=libfactor.dylib ;;
372 *) FACTOR_LIBRARY=libfactor.a ;;
377 FACTOR_IMAGE=factor.image
378 FACTOR_IMAGE_FRESH=factor.image.fresh
384 $ECHO NUM_CORES=$NUM_CORES
387 $ECHO REPRODUCIBLE=$REPRODUCIBLE
388 $ECHO CURRENT_BRANCH=$CURRENT_BRANCH
389 $ECHO FACTOR_BINARY=$FACTOR_BINARY
390 $ECHO FACTOR_LIBRARY=$FACTOR_LIBRARY
391 $ECHO FACTOR_IMAGE=$FACTOR_IMAGE
392 $ECHO MAKE_TARGET=$MAKE_TARGET
393 $ECHO BOOT_IMAGE=$BOOT_IMAGE
394 $ECHO MAKE_IMAGE_TARGET=$MAKE_IMAGE_TARGET
395 $ECHO GIT_PROTOCOL=$GIT_PROTOCOL
396 $ECHO GIT_URL=$GIT_URL
397 $ECHO CHECKSUM_URL=$CHECKSUM_URL
398 $ECHO BOOT_IMAGE_URL=$BOOT_IMAGE_URL
399 $ECHO DOWNLOADER=$DOWNLOADER
407 check_os_arch_word() {
408 if ! [[ -n $OS && -n $ARCH && -n $WORD ]] ; then
412 $ECHO "OS, ARCH, or WORD is empty. Please report this."
421 if [[ $OS == linux && $ARCH == ppc ]] ; then
422 MAKE_IMAGE_TARGET=linux-ppc.32
423 MAKE_TARGET=linux-ppc-32
424 elif [[ $OS == linux && $ARCH == arm64 ]] ; then
425 MAKE_IMAGE_TARGET=unix-arm.64
426 MAKE_TARGET=linux-arm-64
427 elif [[ $OS == macosx && $ARCH == arm64 ]] ; then
428 MAKE_IMAGE_TARGET=unix-arm.64
429 MAKE_TARGET=macosx-arm64
430 elif [[ $OS == windows && $ARCH == x86 && $WORD == 64 ]] ; then
431 MAKE_IMAGE_TARGET=windows-x86.64
432 MAKE_TARGET=windows-x86-64
433 elif [[ $OS == windows && $ARCH == x86 && $WORD == 32 ]] ; then
434 MAKE_IMAGE_TARGET=windows-x86.32
435 MAKE_TARGET=windows-x86-32
436 elif [[ $ARCH == x86 && $WORD == 64 ]] ; then
437 MAKE_IMAGE_TARGET=unix-x86.64
438 MAKE_TARGET=$OS-x86-64
439 elif [[ $ARCH == x86 && $WORD == 32 ]] ; then
440 MAKE_IMAGE_TARGET=unix-x86.32
441 MAKE_TARGET=$OS-x86-32
443 MAKE_IMAGE_TARGET=$ARCH.$WORD
444 MAKE_TARGET=$OS-$ARCH-$WORD
446 BOOT_IMAGE=boot.$MAKE_IMAGE_TARGET.image
450 ensure_program_installed cut
451 $ECHO "Parsing make target from command line: $1"
452 OS=$(echo $1 | cut -d '-' -f 1)
453 ARCH=$(echo $1 | cut -d '-' -f 2)
454 WORD=$(echo $1 | cut -d '-' -f 3)
456 if [[ $OS == linux && $ARCH == ppc ]] ; then WORD=32; fi
457 if [[ $OS == linux && $ARCH == arm ]] ; then WORD=32; fi
458 if [[ $OS == macosx && $ARCH == ppc ]] ; then WORD=32; fi
488 $ECHO "Downloading the git repository from github.com..."
489 invoke_git clone $GIT_URL
492 update_script_name() {
493 $ECHO "$(dirname $0)/_update.sh"
497 local -r update_script=$(update_script_name)
498 local -r bash_path=$(which bash)
499 $ECHO "updating from ${CURRENT_BRANCH}"
500 $ECHO "#!$bash_path" >"$update_script"
501 $ECHO "git pull \"$GIT_URL\" ${CURRENT_BRANCH}" >>"$update_script"
502 $ECHO "if [[ \$? -eq 0 ]]; then exec \"$0\" $SCRIPT_ARGS; else echo \"git pull failed\"; exit 2; fi" \
504 $ECHO "exit 0" >>"$update_script"
506 chmod 755 "$update_script"
507 exec "$update_script"
510 update_script_changed() {
511 invoke_git diff --stat "$(invoke_git merge-base HEAD FETCH_HEAD)" FETCH_HEAD | grep 'build\.sh' >/dev/null
515 $ECHO "Fetching the git repository from github.com..."
518 rm -f "$(update_script_name)"
519 $ECHO git fetch "$GIT_URL" "${CURRENT_BRANCH}"
520 invoke_git fetch "$GIT_URL" "${CURRENT_BRANCH}"
522 if update_script_changed; then
523 $ECHO "Updating and restarting the build.sh script..."
526 $ECHO "Updating the working tree..."
527 invoke_git pull "$GIT_URL" "${CURRENT_BRANCH}"
545 windows) DELETE=rm ;;
551 $ECHO "Backing up factor..."
552 $COPY $FACTOR_BINARY $FACTOR_BINARY.bak
553 $COPY $FACTOR_LIBRARY $FACTOR_LIBRARY.bak
554 $COPY $BOOT_IMAGE $BOOT_IMAGE.bak
555 $COPY $FACTOR_IMAGE $FACTOR_IMAGE.bak
556 $ECHO "Done with backup."
559 check_makefile_exists() {
560 if [[ ! -e "GNUmakefile" ]] ; then
562 $ECHO "***GNUmakefile not found***"
563 $ECHO "You are likely in the wrong directory."
564 $ECHO "Run this script from your factor directory:"
571 check_makefile_exists
572 $MAKE $MAKE_OPTS "$@"
581 $ECHO "Building factor with $NUM_CORES cores"
582 invoke_make CC=$CC CXX=$CXX $MAKE_TARGET -j$NUM_CORES
585 make_clean_factor() {
590 current_git_branch() {
591 # git rev-parse --abbrev-ref HEAD # outputs HEAD for detached head
592 # outputs nothing for detached HEAD, which is fine for ``git fetch``
593 git describe --all --exact-match 2>/dev/null | sed 's=.*/=='
597 if [[ $DOWNLOADER_NAME == 'wget' ]]; then
598 if [[ $(wget -S --spider --prefer-family=IPv4 $1 2>&1 | grep 'HTTP/1.1 200 OK') ]]; then
603 elif [[ $DOWNLOADER_NAME == 'curl' ]]; then
604 local code=$(curl -sL -w "%{http_code}\\n" "$1" -o /dev/null)
605 if [[ $code -eq 200 ]]; then return 0; else return 1; fi
607 $ECHO "error: wget or curl required in check_url"
612 # If we are on a branch, first try to get a boot image for that branch.
613 # Otherwise, just use `master`
614 set_boot_image_vars() {
616 local url="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/checksums.txt"
617 $ECHO "Getting checksum from ${url}"
619 $ECHO "got checksum!"
620 if [[ $? -eq 0 ]]; then
622 BOOT_IMAGE_URL="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/${BOOT_IMAGE}"
624 $ECHO "boot image for branch \`${CURRENT_BRANCH}\` is not on server, trying master instead"
625 $ECHO " tried nonexistent url: ${url}"
626 CHECKSUM_URL="https://downloads.factorcode.org/images/master/checksums.txt"
627 BOOT_IMAGE_URL="https://downloads.factorcode.org/images/master/${BOOT_IMAGE}"
631 set_current_branch() {
632 if [ -n "${CI_BRANCH}" ]; then
633 CURRENT_BRANCH="${CI_BRANCH}"
635 CURRENT_BRANCH=$(current_git_branch)
639 update_boot_image() {
641 $ECHO "Deleting old images..."
642 $DELETE checksums.txt* > /dev/null 2>&1
643 # delete boot images with one or two characters after the dot
644 $DELETE $BOOT_IMAGE.{?,??} > /dev/null 2>&1
645 $DELETE temp/staging.*.image > /dev/null 2>&1
646 if [[ -f $BOOT_IMAGE ]] ; then
647 get_url $CHECKSUM_URL
648 local factorcode_md5=$(cat checksums.txt | grep $BOOT_IMAGE | cut -f2 -d' ')
650 local disk_md5=$($MD5SUM $BOOT_IMAGE | cut -f1 -d' ')
651 $ECHO "Factorcode md5: $factorcode_md5";
652 $ECHO "Disk md5: $disk_md5";
653 if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
654 $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
656 $DELETE $BOOT_IMAGE > /dev/null 2>&1
665 $ECHO "Downloading boot image $BOOT_IMAGE."
666 get_url "${BOOT_IMAGE_URL}"
670 if [[ -z $DOWNLOADER ]] ; then
673 $ECHO $DOWNLOADER $1 ;
675 check_ret $DOWNLOADER
680 check_installed_programs
685 $ECHO "Copying $FACTOR_IMAGE to $FACTOR_IMAGE_FRESH..."
686 $COPY $FACTOR_IMAGE $FACTOR_IMAGE_FRESH
690 ./$FACTOR_BINARY -i=$BOOT_IMAGE
691 check_ret "./$FACTOR_BINARY bootstrap failed"
713 download_and_bootstrap() {
718 net_bootstrap_no_pull() {
721 download_and_bootstrap
725 ./$FACTOR_BINARY -e="USING: vocabs.loader vocabs.refresh system memory ; refresh-all save 0 exit"
730 ./$FACTOR_BINARY -run="bootstrap.image" "$MAKE_IMAGE_TARGET"
735 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
739 install_deps_pacman() {
740 sudo pacman --noconfirm -Syu gcc clang make rlwrap git wget pango glibc gtk2 gtk3 gtkglext gtk-engines gdk-pixbuf2 libx11 screen tmux
745 sudo dnf --assumeyes install gcc gcc-c++ glibc-devel binutils libX11-devel pango-devel gtk3-devel gdk-pixbuf2-devel gtkglext-devel tmux rlwrap wget
750 sudo pkg install --yes bash git gmake gcc rlwrap ripgrep curl gmake x11-toolkits/gtk30 x11-toolkits/gtkglext pango cairo vim
754 install_deps_macosx() {
755 test_program_installed git
756 if [[ $? -ne 1 ]] ; then
757 ensure_program_installed yes
758 $ECHO "git not found."
759 $ECHO "This script requires either git-core or port."
760 $ECHO "If it fails, install git-core or port and try again."
761 ensure_program_installed port
762 $ECHO "Installing git-core with port...this will take awhile."
763 yes | sudo port install git-core
768 $ECHO "usage: $0 command [optional-target]"
769 $ECHO " install - git clone, compile, bootstrap"
770 $ECHO " deps-apt - install required packages for Factor on Linux using apt"
771 $ECHO " deps-pacman - install required packages for Factor on Linux using pacman"
772 $ECHO " deps-dnf - install required packages for Factor on Linux using dnf"
773 $ECHO " deps-pkg - install required packages for Factor on FreeBSD using pkg"
774 $ECHO " deps-macosx - install git on MacOSX using port"
775 $ECHO " self-bootstrap - make local boot image, bootstrap"
776 $ECHO " self-update - git pull, recompile, make local boot image, bootstrap"
777 $ECHO " quick-update - git pull, refresh-all, save"
778 $ECHO " update|latest - git pull, recompile, download a boot image, bootstrap"
779 $ECHO " compile - compile the binary"
780 $ECHO " recompile - recompile the binary"
781 $ECHO " bootstrap - bootstrap with existing boot image"
782 $ECHO " net-bootstrap - recompile, download a boot image, bootstrap"
783 $ECHO " make-target - find and print the os-arch-cpu string"
784 $ECHO " report|info - print the build variables"
785 $ECHO " full-report - print the build variables, check programs and libraries"
786 $ECHO " update-boot-image - get the boot image for the current branch"
788 $ECHO "If you are behind a firewall, invoke as:"
789 $ECHO "env GIT_PROTOCOL=http $0 <command>"
791 $ECHO "Example for overriding the default target:"
792 $ECHO " $0 update macosx-x86-32"
797 # -n is nonzero length, -z is zero length
798 if [[ -n "$2" ]] ; then
802 if [ "$#" -gt 3 ]; then
804 $ECHO "error: too many arguments"
814 deps-apt) install_deps_apt ;;
815 deps-pacman) install_deps_pacman ;;
816 deps-macosx) install_deps_macosx ;;
817 deps-dnf) install_deps_dnf ;;
818 deps-pkg) install_deps_pkg ;;
819 self-bootstrap) get_config_info; make_boot_image; bootstrap ;;
820 self-update) update; make_boot_image; bootstrap ;;
821 quick-update) update; refresh_image ;;
822 update|latest) update; download_and_bootstrap ;;
823 compile) find_build_info; make_factor ;;
824 recompile) find_build_info; make_clean; make_factor ;;
825 bootstrap) get_config_info; bootstrap ;;
826 net-bootstrap) net_bootstrap_no_pull ;;
827 make-target) FIND_MAKE_TARGET=true; ECHO=false; find_build_info; exit_script ;;
828 report|info) find_build_info ;;
829 full-report) find_build_info; check_installed_programs; check_libraries ;;
830 update-boot-image) find_build_info; check_installed_programs; update_boot_image ;;