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"}
17 test_program_installed() {
18 command -v "$1" >/dev/null 2>&1
22 test_programs_installed() {
24 $ECHO -n "Checking for all($*)..."
27 if test_program_installed "$cmd"; then
31 if [[ $installed -eq $# ]] ; then
39 if [[ $FIND_MAKE_TARGET = true ]] ; then
46 ensure_program_installed() {
48 $ECHO -n "Checking for any($*)..."
51 if test_program_installed "$cmd"; then
59 if [[ $# -eq 1 ]] ; then
62 $ECHO -n "any of [ $* ]"
64 $ECHO " and try again."
65 if [[ $OS == macosx ]] ; then
66 $ECHO "If you have Xcode 4.3 or higher installed, you must install the"
67 $ECHO "Command Line Tools from Xcode Preferences > Downloads in order"
68 $ECHO "to build Factor."
74 # Can't execute any commands before saving $?
75 # $1 is the name of the command we are checking
77 if [[ $RET -ne 0 ]] ; then
84 if test_program_installed wget; then
85 DOWNLOADER="wget -nd --prefer-family=IPv4"
89 if test_program_installed curl; then
90 DOWNLOADER="curl -L -f -O"
94 $ECHO "error: wget or curl required"
99 if test_program_installed md5sum; then
107 # on Cygwin we MUST use the MinGW "cross-compiler", therefore check these first
108 # furthermore, we prefer 64 bit over 32 bit versions if both are available
110 # we need this condition so we don't find a mingw32 compiler on linux
111 if [[ $OS == windows ]] ; then
112 if test_programs_installed x86_64-w64-mingw32-gcc x86_64-w64-mingw32-g++; then
113 [ -z "$CC" ] && CC=x86_64-w64-mingw32-gcc
114 [ -z "$CXX" ] && CXX=x86_64-w64-mingw32-g++
118 if test_programs_installed i686-w64-mingw32-gcc i686-w64-mingw32-g++; then
119 [ -z "$CC" ] && CC=i686-w64-mingw32-gcc
120 [ -z "$CXX" ] && CXX=i686-w64-mingw32-g++
125 if test_programs_installed clang clang++ ; then
126 [ -z "$CC" ] && CC=clang
127 [ -z "$CXX" ] && CXX=clang++
131 # gcc and g++ will fail to correctly build Factor on Cygwin
132 if test_programs_installed gcc g++ ; then
133 [ -z "$CC" ] && CC=gcc
134 [ -z "$CXX" ] && CXX=g++
138 $ECHO "error: high enough version of either (clang/clang++) or (gcc/g++) required!"
144 freebsd) MAKE="gmake" ;;
147 if [[ $MAKE = "gmake" ]] ; then
148 ensure_program_installed gmake
152 check_installed_programs() {
153 ensure_program_installed chmod
154 ensure_program_installed uname
155 ensure_program_installed git
156 ensure_program_installed wget curl
157 ensure_program_installed clang x86_64-w64-mingw32-gcc i686-w64-mingw32-gcc gcc
158 ensure_program_installed clang++ x86_64-w64-mingw32-g++ i686-w64-mingw32-g++ g++ cl
159 ensure_program_installed make gmake
160 ensure_program_installed md5sum md5
161 ensure_program_installed cut
164 check_library_exists() {
165 GCC_TEST=factor-library-test.c
166 GCC_OUT=factor-library-test.out
167 $ECHO -n "Checking for library $1..."
168 $ECHO "int main(){return 0;}" > $GCC_TEST
169 if $CC $GCC_TEST -o $GCC_OUT -l "$1" 2>&- ; then
180 check_X11_libraries() {
181 check_library_exists GL
182 check_library_exists X11
183 check_library_exists pango-1.0
186 check_gtk_libraries() {
187 check_library_exists gobject-2.0
188 check_library_exists gtk-x11-2.0
189 check_library_exists gdk-x11-2.0
190 check_library_exists gdk_pixbuf-2.0
191 check_library_exists gtkglext-x11-1.0
192 check_library_exists atk-1.0
193 check_library_exists gio-2.0
194 check_library_exists gdkglext-x11-1.0
195 check_library_exists pango-1.0
201 linux) check_X11_libraries
202 check_gtk_libraries ;;
203 unix) check_gtk_libraries ;;
207 check_factor_exists() {
208 if [[ -d "factor" ]] ; then
209 $ECHO "A directory called 'factor' already exists."
210 $ECHO "Rename or delete it and try again."
216 if [[ -n $OS ]] ; then return; fi
217 $ECHO "Finding OS..."
222 CYGWIN_NT-5.2-WOW64) OS=windows ;;
223 *CYGWIN_NT*) OS=windows ;;
224 *CYGWIN*) OS=windows ;;
225 MINGW32*) OS=windows ;;
226 MINGW64*) OS=windows ;;
227 MSYS_NT*) OS=windows ;;
228 *darwin*) OS=macosx ;;
229 *Darwin*) OS=macosx ;;
232 FreeBSD) OS=freebsd ;;
237 find_architecture() {
238 if [[ -n $ARCH ]] ; then return; fi
239 $ECHO "Finding ARCH..."
252 iPhone5*[3-9]) ARCH=arm ;;
253 iPhone[6-9]*) ARCH=arm ;;
254 iPhone[1-9][0-9]*) ARCH=arm ;;
255 iPad[4-9]*) ARCH=arm ;;
256 iPad[1-9][0-9]*) ARCH=arm ;;
257 AppleTV[5-9]*) ARCH=arm ;;
258 AppleTV[1-9][0-9]*) ARCH=arm ;;
259 "Power Macintosh") ARCH=ppc ;;
264 $ECHO "Finding NUM_CORES..."
269 CYGWIN_NT-5.2-WOW64 | *CYGWIN_NT* | *CYGWIN* | MINGW32*) NUM_CORES=$NUMBER_OF_PROCESSORS ;;
270 *linux* | *Linux*) NUM_CORES=$(getconf _NPROCESSORS_ONLN || nproc) ;;
271 *darwin* | *Darwin* | freebsd) NUM_CORES=$(sysctl -n hw.ncpu) ;;
276 if [[ -n $WORD ]] ; then return; fi
277 $ECHO "Finding WORD..."
278 WORD=$(getconf LONG_BIT || find_word_size_cpp || find_word_size_c)
281 find_word_size_cpp() {
282 SIXTY_FOUR='defined(__aarch64__) || defined(__x86_64__) || defined(_M_AMD64) || defined(__PPC64__) || defined(__64BIT__)'
283 THIRTY_TWO='defined(i386) || defined(__i386) || defined(__i386__) || defined(_MIX86)'
284 $CC -E -xc <(echo -e "#if ${SIXTY_FOUR}\n64\n#elif ${THIRTY_TWO}\n32\n#endif") | tail -1
288 C_WORD="factor-word-size"
289 TEST_PROGRAM="int main(){ return (long)(8*sizeof(void*)); }"
290 echo "$TEST_PROGRAM" | $CC -o $C_WORD -xc -
298 echo "Word size should be 32/64, got '$WORD_OUT'"
305 set_factor_binary() {
307 windows) FACTOR_BINARY=factor.com ;;
308 *) FACTOR_BINARY=factor ;;
312 set_factor_library() {
314 windows) FACTOR_LIBRARY=factor.dll ;;
315 macosx) FACTOR_LIBRARY=libfactor.dylib ;;
316 *) FACTOR_LIBRARY=libfactor.a ;;
321 FACTOR_IMAGE=factor.image
322 FACTOR_IMAGE_FRESH=factor.image.fresh
328 $ECHO "NUM_CORES=$NUM_CORES"
331 $ECHO "REPRODUCIBLE=$REPRODUCIBLE"
332 $ECHO "CURRENT_BRANCH=$CURRENT_BRANCH"
333 $ECHO "CURRENT_BRANCH_FULL=$CURRENT_BRANCH_FULL"
334 $ECHO "FACTOR_BINARY=$FACTOR_BINARY"
335 $ECHO "FACTOR_LIBRARY=$FACTOR_LIBRARY"
336 $ECHO "FACTOR_IMAGE=$FACTOR_IMAGE"
337 $ECHO "MAKE_TARGET=$MAKE_TARGET"
338 $ECHO "BOOT_IMAGE=$BOOT_IMAGE"
339 $ECHO "MAKE_IMAGE_TARGET=$MAKE_IMAGE_TARGET"
340 $ECHO "GIT_PROTOCOL=$GIT_PROTOCOL"
341 $ECHO "GIT_URL=$GIT_URL"
342 $ECHO "CHECKSUM_URL=$CHECKSUM_URL"
343 $ECHO "BOOT_IMAGE_URL=$BOOT_IMAGE_URL"
344 $ECHO "DOWNLOADER=$DOWNLOADER"
350 check_os_arch_word() {
351 if ! [[ -n $OS && -n $ARCH && -n $WORD ]] ; then
355 $ECHO "OS, ARCH, or WORD is empty. Please report this."
364 if [[ $OS == "windows" ]] ; then
365 MAKE_IMAGE_TARGET=windows-$ARCH.$WORD
366 MAKE_TARGET=$OS-$ARCH-$WORD
368 MAKE_IMAGE_TARGET=unix-$ARCH.$WORD
369 MAKE_TARGET=$OS-$ARCH-$WORD
371 BOOT_IMAGE=boot.$MAKE_IMAGE_TARGET.image
375 ensure_program_installed cut
376 $ECHO "Parsing make target from command line: $1"
377 OS=$(echo "$1" | cut -d '-' -f 1)
378 ARCH=$(echo "$1" | cut -d '-' -f 2)
379 WORD=$(echo "$1" | cut -d '-' -f 3)
381 if [[ $OS == linux && $ARCH == ppc ]] ; then WORD=32; fi
382 if [[ $OS == linux && $ARCH == arm ]] ; then WORD=32; fi
383 if [[ $OS == macosx && $ARCH == ppc ]] ; then WORD=32; fi
390 prepare_build_info() {
417 $ECHO "Downloading the git repository from github.com..."
418 invoke_git clone "$GIT_URL"
421 update_script_name() {
422 $ECHO "$(dirname "$0")/_update.sh"
427 local -r update_script=$(update_script_name)
428 local -r shell_path="$SHELL"
432 echo "git pull ${GIT_URL} ${CURRENT_BRANCH}"
435 chmod 755 "$update_script"
436 $ECHO "Running the build.sh updater script: $update_script"
437 exec "$update_script"
440 update_script_changed() {
441 invoke_git diff --stat "$(invoke_git merge-base HEAD FETCH_HEAD)" FETCH_HEAD | grep "build.sh" >/dev/null
445 $ECHO "Fetching the git repository from github.com..."
448 rm -f "$(update_script_name)"
449 $ECHO git fetch "$GIT_URL" "${CURRENT_BRANCH}"
450 invoke_git fetch "$GIT_URL" "${CURRENT_BRANCH}"
452 if update_script_changed; then
453 $ECHO "Updating and restarting the build.sh script..."
456 $ECHO "Updating the working tree..."
457 invoke_git pull "$GIT_URL" "${CURRENT_BRANCH}"
462 cd "factor" || exit 12
467 $ECHO "Backing up factor..."
468 cp "$FACTOR_BINARY" "$FACTOR_BINARY.bak"
469 cp "$FACTOR_LIBRARY" "$FACTOR_LIBRARY.bak"
470 cp "$BOOT_IMAGE" "$BOOT_IMAGE.bak"
471 cp "$FACTOR_IMAGE" "$FACTOR_IMAGE.bak"
472 $ECHO "Done with backup."
475 check_makefile_exists() {
476 if [[ ! -e "GNUmakefile" ]] ; then
478 $ECHO "***GNUmakefile not found***"
479 $ECHO "You are likely in the wrong directory."
480 $ECHO "Run this script from your factor directory:"
487 check_makefile_exists
488 if [ -n "$MAKE_OPTS" ]; then
489 "$MAKE" "$MAKE_OPTS" "$@"
501 $ECHO "Building factor with $NUM_CORES cores"
502 invoke_make "CC=$CC" "CXX=$CXX" "$MAKE_TARGET" "-j$NUM_CORES"
505 make_clean_factor() {
510 current_git_branch() {
511 # git rev-parse --abbrev-ref HEAD # outputs HEAD for detached head
512 # outputs nothing for detached HEAD, which is fine for ``git fetch``
513 git describe --all --exact-match 2>/dev/null
517 if [[ $DOWNLOADER_NAME == 'wget' ]]; then
518 if wget -S --spider --prefer-family=IPv4 "$1" 2>&1 | grep -q 'HTTP/1.1 200 OK'; then
523 elif [[ $DOWNLOADER_NAME == 'curl' ]]; then
525 code=$(curl -4 -sL -w "%{http_code}\\n" "$1" -o /dev/null)
526 if [[ $code -eq 200 ]]; then return 0; else return 1; fi
528 $ECHO "error: wget or curl required in check_url"
533 # If we are on a branch, first try to get a boot image for that branch.
534 # Otherwise, just use `master`
535 set_boot_image_vars() {
537 local url="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/checksums.txt"
538 $ECHO "Getting checksum from ${url}"
540 if check_url "$url"; then
541 $ECHO "got checksum!"
543 BOOT_IMAGE_URL="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/${BOOT_IMAGE}"
545 $ECHO "boot image for branch \`${CURRENT_BRANCH}\` is not on server, trying master instead"
546 $ECHO " tried nonexistent url: ${url}"
547 CHECKSUM_URL="https://downloads.factorcode.org/images/master/checksums.txt"
548 BOOT_IMAGE_URL="https://downloads.factorcode.org/images/master/${BOOT_IMAGE}"
552 set_current_branch() {
553 if [ -n "${CI_BRANCH}" ]; then
554 CURRENT_BRANCH="${CI_BRANCH}"
556 CURRENT_BRANCH_FULL=$(current_git_branch)
557 CURRENT_BRANCH=$($ECHO "$CURRENT_BRANCH_FULL" | sed 's=heads/==;s=remotes/==')
561 update_boot_image() {
563 $ECHO "Deleting old images..."
564 rm -f checksums.txt* > /dev/null 2>&1
565 rm -f "$BOOT_IMAGE".{?,??} > /dev/null 2>&1
566 rm -f temp/staging.*.image > /dev/null 2>&1
567 if [[ -f $BOOT_IMAGE ]] ; then
568 get_url "$CHECKSUM_URL"
570 factorcode_md5=$(grep "$BOOT_IMAGE" checksums.txt | cut -f2 -d' ')
573 disk_md5=$($MD5SUM "$BOOT_IMAGE" | cut -f1 -d' ')
574 $ECHO "Factorcode md5: $factorcode_md5"
575 $ECHO "Disk md5: $disk_md5"
576 if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
577 $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
579 rm -f "$BOOT_IMAGE" > /dev/null 2>&1
588 $ECHO "Downloading boot image $BOOT_IMAGE."
589 get_url "${BOOT_IMAGE_URL}"
593 if [[ -z $DOWNLOADER ]] ; then
596 $ECHO "$DOWNLOADER" "$1" ;
598 check_ret "$DOWNLOADER"
603 check_installed_programs
608 $ECHO "Copying $FACTOR_IMAGE to $FACTOR_IMAGE_FRESH..."
609 cp "$FACTOR_IMAGE" "$FACTOR_IMAGE_FRESH"
612 check_launch_factor() {
614 check_ret "Could not launch ./$FACTOR_BINARY"
617 is_boot_image_outdated() {
618 ./$FACTOR_BINARY "-e=USE: system \"\" to-refresh 2drop length 0 > 1 0 ? exit"
624 if [[ -f $BOOT_IMAGE ]] ; then
625 get_url "$CHECKSUM_URL"
627 factorcode_md5=$(grep "$BOOT_IMAGE" checksums.txt | cut -f2 -d' ')
630 disk_md5=$($MD5SUM "$BOOT_IMAGE" | cut -f1 -d' ')
631 $ECHO "Boot image @factorcode.org md5: $factorcode_md5";
632 $ECHO "Boot image @local disk md5: $disk_md5";
633 if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
634 $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
636 $ECHO "Your disk boot image and the one on downloads.factorcode.org mismatch"
641 is_boot_image_outdated
642 if [[ $? -eq 0 ]]; then
643 $ECHO "Your disk boot image is up-to-date"
645 $ECHO "Your disk boot image needs to be updated"
650 ./$FACTOR_BINARY -i="$BOOT_IMAGE"
651 check_ret "./$FACTOR_BINARY bootstrap failed"
673 download_and_bootstrap() {
678 net_bootstrap_no_pull() {
681 download_and_bootstrap
685 ./$FACTOR_BINARY -e="USING: vocabs.loader vocabs.refresh system memory ; refresh-all save 0 exit"
690 ./$FACTOR_BINARY -run="bootstrap.image" "$MAKE_IMAGE_TARGET"
695 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
699 install_deps_pacman() {
700 sudo pacman --noconfirm -Syu gcc clang make rlwrap git wget pango glibc gtk2 gtk3 gtkglext gtk-engines gdk-pixbuf2 libx11 screen tmux
705 sudo dnf --assumeyes install gcc gcc-c++ glibc-devel binutils libX11-devel pango-devel gtk3-devel gdk-pixbuf2-devel gtkglext-devel tmux rlwrap wget
710 sudo pkg install --yes bash git gmake gcc rlwrap ripgrep curl gmake x11-toolkits/gtk30 x11-toolkits/gtkglext pango cairo vim
714 install_deps_macosx() {
715 if test_program_installed git; then
716 ensure_program_installed yes
717 $ECHO "git not found."
718 $ECHO "This script requires either git-core or port."
719 $ECHO "If it fails, install git-core or port and try again."
720 ensure_program_installed port
721 $ECHO "Installing git-core with port...this will take awhile."
722 yes | sudo port install git-core
727 $ECHO "usage: $0 command [optional-target]"
728 $ECHO " install - git clone, compile, bootstrap"
729 $ECHO " deps-apt - install required packages for Factor on Linux using apt"
730 $ECHO " deps-pacman - install required packages for Factor on Linux using pacman"
731 $ECHO " deps-dnf - install required packages for Factor on Linux using dnf"
732 $ECHO " deps-pkg - install required packages for Factor on FreeBSD using pkg"
733 $ECHO " deps-macosx - install git on MacOSX using port"
734 $ECHO " info-boot-image - print remote and disk boot image MD5, status disk boot image"
735 $ECHO " self-bootstrap - make local boot image, bootstrap"
736 $ECHO " self-update - git pull, recompile, make local boot image, bootstrap"
737 $ECHO " quick-update - git pull, refresh-all, save"
738 $ECHO " update|latest - git pull, recompile, download a boot image, bootstrap"
739 $ECHO " compile - compile the binary"
740 $ECHO " recompile - recompile the binary"
741 $ECHO " bootstrap - bootstrap with existing boot image"
742 $ECHO " net-bootstrap - recompile, download a boot image, bootstrap"
743 $ECHO " make-target - find and print the os-arch-cpu string"
744 $ECHO " report|info - print the build variables"
745 $ECHO " full-report - print the build variables, check programs and libraries"
746 $ECHO " update-boot-image - get the boot image for the current branch"
748 $ECHO "If you are behind a firewall, invoke as:"
749 $ECHO "env GIT_PROTOCOL=http $0 <command>"
751 $ECHO "Example for overriding the default target:"
752 $ECHO " $0 update macosx-x86-32"
757 # -n is nonzero length, -z is zero length
758 if [[ -n "$2" ]] ; then
759 parse_build_info "$2"
762 if [ "$#" -gt 3 ]; then
764 $ECHO "error: too many arguments"
770 deps-apt) install_deps_apt ;;
771 deps-pacman) install_deps_pacman ;;
772 deps-macosx) install_deps_macosx ;;
773 deps-dnf) install_deps_dnf ;;
774 deps-pkg) install_deps_pkg ;;
775 info-boot-image) info_boot_image ;;
776 self-bootstrap) get_config_info; make_boot_image; bootstrap ;;
777 self-update) update; make_boot_image; bootstrap ;;
778 quick-update) update; refresh_image ;;
779 update|latest) update; download_and_bootstrap ;;
780 compile) find_build_info; make_factor ;;
781 recompile) find_build_info; make_clean; make_factor ;;
782 bootstrap) get_config_info; bootstrap ;;
783 net-bootstrap) net_bootstrap_no_pull ;;
784 make-target) FIND_MAKE_TARGET=true; ECHO=false; find_build_info; exit_script 0;;
785 report|info) find_build_info ;;
786 full-report) find_build_info; check_installed_programs; check_libraries ;;
787 update-boot-image) find_build_info; check_installed_programs; update_boot_image ;;
788 update-script) update_script ;;