native_bootstrap.sh

#!/usr/bin/env bash

# This script is used to setup the Redox build system
# It installs Rustup, the recipe dependencies for cross-compilation
# and downloads the build system configuration files

set -e

##########################################################
# This function is simply a banner to introduce the script
##########################################################
banner()
{
    echo "|------------------------------------------|"
    echo "|----- Welcome to the Redox bootstrap -----|"
    echo "|------------------------------------------|"
}

############################################################################
# This function takes care of installing a dependency via package manager of
# choice for building Redox on BSDs (macOS, FreeBSD, etc.).
# @params:    $1 package manager
#             $2 package name
#             $3 binary name (optional)
############################################################################
install_bsd_pkg()
{
    PKG_MANAGER=$1
    PKG_NAME=$2
    BIN_NAME=$3
    if [ -z "$BIN_NAME" ]; then
        BIN_NAME=$PKG_NAME
    fi

    BIN_LOCATION=$(which $BIN_NAME || true)
    if [ -z "$BIN_LOCATION" ]; then
        echo "$PKG_MANAGER install $PKG_NAME"
        $PKG_MANAGER install "$PKG_NAME"
    else
        echo "$BIN_NAME already exists at $BIN_LOCATION, no need to install $PKG_NAME..."
    fi
}

install_macports_pkg()
{
    install_bsd_pkg "sudo port" "$1" "$2"
}

install_brew_pkg()
{
    install_bsd_pkg "brew" $@
}

install_brew_cask_pkg()
{
    install_bsd_pkg "brew cask" $@
}

install_freebsd_pkg()
{
    install_bsd_pkg "sudo pkg" $@
}

##############################################################################
# This function checks which of the supported package managers is available on
# the macOS host.
# If a supported package manager is found, it delegates the installing work to
# the relevant function.
# Otherwise this function will exit this script with an error.
##############################################################################
osx()
{
    if [ ! -z "$(which brew)" ]; then
        osx_homebrew $@
    elif [ ! -z "$(which port)" ]; then
        osx_macports $@
    else
        echo "Please install either Homebrew or MacPorts, if you wish to use this script"
        echo "Re-run this script once you installed one of those package managers"
        echo "Will not install, now exiting..."
        exit 1
    fi
}

############################################################################
# This function takes care of installing all dependencies using MacPorts for
# building Redox on macOS
# @params:    $1 the emulator to install, "virtualbox" or "qemu"
############################################################################
osx_macports()
{
    echo "MacPorts detected! Now updating..."
    sudo port -v selfupdate

    echo "Installing missing packages..."

    install_macports_pkg "git"

    if [ "$1" == "qemu" ]; then
        install_macports_pkg "qemu" "qemu-system-x86_64"
    elif [ "$1" == "virtualbox" ]; then
        install_macports_pkg "virtualbox"
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    install_macports_pkg "autoconf"
    install_macports_pkg "automake"
    install_macports_pkg "bison"
    install_macports_pkg "cmake"
    install_macports_pkg "coreutils"
    install_macports_pkg "curl"
    install_macports_pkg "doxygen"
    install_macports_pkg "expat"
    install_macports_pkg "file"
    install_macports_pkg "findutils"
    install_macports_pkg "flex"
    install_macports_pkg "gcc14"
    install_macports_pkg "gdb +multiarch"
    install_macports_pkg "gmake"
    install_macports_pkg "gmp"
    install_macports_pkg "gpatch"
    install_macports_pkg "jpeg"
    install_macports_pkg "libpng"
    install_macports_pkg "libsdl12"
    install_macports_pkg "libsdl2_ttf"
    install_macports_pkg "libtool"
    install_macports_pkg "m4"
    install_macports_pkg "meson"
    install_macports_pkg "nasm"
    install_macports_pkg "ninja"
    install_macports_pkg "openssl11"
    install_macports_pkg "openssl3"
    install_macports_pkg "osxfuse"
    install_macports_pkg "p5-html-parser"
    install_macports_pkg "patchelf"
    install_macports_pkg "perl5.24"
    install_macports_pkg "pkgconfig"
    install_macports_pkg "po4a"
    install_macports_pkg "protobuf-c"
    install_macports_pkg "py37-mako"
    install_macports_pkg "python311"
    install_macports_pkg "scons"
    install_macports_pkg "texinfo"
    install_macports_pkg "unzip"
    install_macports_pkg "wget"
    install_macports_pkg "x86_64-elf-gcc"
    install_macports_pkg "xdg-utils"
    install_macports_pkg "zip"
}

############################################################################
# This function takes care of installing all dependencies using Homebrew for
# building Redox on macOS
# @params:    $1 the emulator to install, "virtualbox" or "qemu"
############################################################################
osx_homebrew()
{
    echo "Homebrew detected! Now updating..."
    brew update

    echo "Installing missing packages..."

    install_brew_pkg "git"

    if [ "$1" == "qemu" ]; then
        install_brew_pkg "qemu" "qemu-system-x86_64"
    elif [ "$1" == "virtualbox" ]; then
        install_brew_pkg "virtualbox"
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    install_brew_pkg "ant"
    install_brew_pkg "autoconf"
    install_brew_pkg "automake"
    install_brew_pkg "bison"
    install_brew_pkg "cmake"
    install_brew_pkg "curl"
    install_brew_pkg "doxygen"
    install_brew_pkg "expat"
    install_brew_pkg "findutils"
    install_brew_pkg "flex"
    install_brew_pkg "gcc@14"
    install_brew_pkg "gdb"
    install_brew_pkg "gettext"
    install_brew_pkg "gmp"
    install_brew_pkg "gpatch"
    install_brew_pkg "jpeg"
    install_brew_pkg "libpng"
    install_brew_pkg "libtool"
    install_brew_pkg "llvm"
    install_brew_pkg "m4"
    install_brew_pkg "macfuse"
    install_brew_pkg "make"
    install_brew_pkg "meson"
    install_brew_pkg "nasm"
    install_brew_pkg "ninja"
    install_brew_pkg "openssl@1.1"
    install_brew_pkg "openssl@3.0"
    install_brew_pkg "patchelf"
    install_brew_pkg "perl"
    install_brew_pkg "pkg-config"
    install_brew_pkg "po4a"
    install_brew_pkg "protobuf"
    install_brew_pkg "python@3.11"
    install_brew_pkg "scons"
    install_brew_pkg "sdl12-compat"
    install_brew_pkg "sdl2_ttf"
    install_brew_pkg "texinfo"
    install_brew_pkg "unzip"
    install_brew_pkg "wget"
    install_brew_pkg "zip"

    install_brew_pkg "redox-os/gcc_cross_compilers/x86_64-elf-gcc" "x86_64-elf-gcc"
}

#######################################################################
# This function takes care of installing all dependencies using pkg for
# building Redox on FreeBSD
# @params:    $1 the emulator to install, "virtualbox" or "qemu"
#######################################################################
freebsd()
{
    set -x
    echo "FreeBSD detected!"
    echo "Installing missing packages..."

    install_freebsd_pkg "git"

    if [ "$1" == "qemu" ]; then
        install_freebsd_pkg "qemu" "qemu-system-x86_64"
    elif [ "$1" == "virtualbox" ]; then
        install_freebsd_pkg "virtualbox"
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    install_freebsd_pkg "autoconf"
    install_freebsd_pkg "automake"
    install_freebsd_pkg "bison"
    install_freebsd_pkg "cmake"
    install_freebsd_pkg "coreutils"
    install_freebsd_pkg "curl"
    install_freebsd_pkg "doxygen"
    install_freebsd_pkg "expat2"
    install_freebsd_pkg "file"
    install_freebsd_pkg "findutils"
    install_freebsd_pkg "flex"
    install_freebsd_pkg "fusefs-libs3"
    install_freebsd_pkg "gcc"
    install_freebsd_pkg "gdb"
    install_freebsd_pkg "gettext"
    install_freebsd_pkg "gmake"
    install_freebsd_pkg "gmp"
    install_freebsd_pkg "libjpeg-turbo"
    install_freebsd_pkg "libtool"
    install_freebsd_pkg "m4"
    install_freebsd_pkg "meson"
    install_freebsd_pkg "nasm"
    install_freebsd_pkg "ninja"
    install_freebsd_pkg "openssl"
    install_freebsd_pkg "p5-HTML-Parser"
    install_freebsd_pkg "patch"
    install_freebsd_pkg "patchelf"
    install_freebsd_pkg "perl5.36"
    install_freebsd_pkg "pkgconf"
    install_freebsd_pkg "png"
    install_freebsd_pkg "po4a"
    install_freebsd_pkg "py-protobuf-compiler"
    install_freebsd_pkg "python"
    install_freebsd_pkg "scons"
    install_freebsd_pkg "sdl12"
    install_freebsd_pkg "sdl2_ttf"
    install_freebsd_pkg "syslinux"
    install_freebsd_pkg "texinfo"
    install_freebsd_pkg "unzip"
    install_freebsd_pkg "wget"
    install_freebsd_pkg "xdg-utils"
    install_freebsd_pkg "zip"
    set +x
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Arch Linux
# @params:	$1 the emulator to install, "virtualbox" or "qemu"
# 		$2 install non-interactively, boolean
###############################################################################
archLinux()
{
    noninteractive=$2

    pacman_install="pacman -S --needed"
    if [ "$noninteractive" = true ]; then
        pacman_install+="  --noconfirm"
    fi

    echo "Detected Arch Linux"
    packages="ant \
    autoconf \
    automake \
    bison \
    cmake \
    curl \
    doxygen \
    expat \
    file \
    flex \
    fuse \
    gdb \
    git \
    gmp \
    libjpeg-turbo \
    libpng \
    libtool \
    m4 \
    make \
    meson \
    nasm \
    patch \
    patchelf \
    perl \
    perl-html-parser \
    pkgconf \
    po4a \
    protobuf \
    python \
    python-mako \
    rsync \
    scons \
    sdl12-compat \
    syslinux \
    texinfo \
    unzip \
    waf \
    wget \
    xdg-utils \
    zip"

    if [ "$1" == "qemu" ]; then
        packages="$packages qemu-system-x86 qemu-system-arm qemu-system-riscv"
    elif [ "$1" == "virtualbox" ]; then
        packages="$packages virtualbox"
    else
        echo "Unknown emulator: $1"
        exit 1
    fi
    # Scripts should not cause a system update in order to just install a
    #   couple of packages. If pacman -S --needed is going to fail, let it fail
    #   and the user will figure out the issues (without updating if required)
    #   and rerun the script.
    #echo "Updating system..."
    #sudo pacman -Syu

    echo "Installing packages $packages..."
    sudo $pacman_install $packages
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Debian-based Linux
# @params:	$1 the emulator to install, "virtualbox" or "qemu"
# 		$2 install non-interactively, boolean
#		$3 the package manager to use
###############################################################################
ubuntu()
{
    noninteractive=$2
    package_manager=$3
    echo "Detected Ubuntu/Debian"
    echo "Updating system..."
    sudo $package_manager update

    if [ $package_manager == "apt-get" ]; then
        if [ "$noninteractive" = true ]; then
            install_command+="DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes --quiet"
        else
            install_command="apt-get install"
        fi
    else
        install_command="$package_manager install"
    fi

    echo "Installing required packages..."
    pkgs="\
    ant \
    appstream \
    appstream-compose \
    autoconf \
    autoconf2.69 \
    automake \
    autopoint \
    bison \
    bsdextrautils \
    build-essential \
    clang \
    cmake \
    curl \
    dos2unix \
    doxygen \
    expect \
    file \
    flex \
    fuse3 \
    g++ \
    gdb-multiarch \
    genisoimage \
    git \
    git-lfs \
    gtk-doc-tools \
    help2man \
    intltool \
    libc6-dev-i386 \
    libfuse3-dev \
    libgdk-pixbuf2.0-bin \
    libglib2.0-dev-bin \
    libgmp-dev \
    libhtml-parser-perl \
    libjpeg-dev \
    libmpfr-dev \
    libparse-yapp-perl \
    libsdl1.2-dev \
    libsdl2-ttf-dev \
    llvm \
    lua5.4 \
    lzip \
    m4 \
    make \
    meson \
    nasm \
    ninja-build \
    patch \
    patchelf \
    perl \
    pkg-config \
    po4a \
    protobuf-compiler \
    python3 \
    python3-dev \
    python3-mako \
    python3-venv \
    rsync \
    ruby \
    scons \
    ssh \
    syslinux-utils \
    texinfo \
    unifdef \
    unzip \
    wget \
    xdg-utils \
    xfonts-utils \
    xorg-dev \
    xutils-dev \
    xxd \
    zip \
    zstd"
    # Not availible for at least ARM hosts
    case "$host_arch" in
        x86*|i?86) pkgs="$pkgs libc6-dev-i386 syslinux-utils";;
    esac
    sudo $install_command $pkgs
    if [ "$1" == "qemu" ]; then
        if [ -z "$(which qemu-system-x86_64)" ]; then
            echo "Installing QEMU..."
            sudo $install_command qemu-system-x86 qemu-kvm
            sudo $install_command qemu-system-arm qemu-efi-aarch64
            sudo $install_command qemu-system-riscv
        else
            echo "QEMU already installed!"
        fi
    elif [ "$1" == "virtualbox" ]; then
        if [ -z "$(which virtualbox)" ]; then
            if grep '^ID=debian$' /etc/os-release > /dev/null; then
                echo "Virtualbox is not in the official debian packages"
                echo "To install virtualbox on debian, see https://wiki.debian.org/VirtualBox"
                echo "Please install VirtualBox and re-run this script,"
                echo "or run with -e qemu"
                exit 1
            else
                echo "Installing VirtualBox..."
                sudo $install_command virtualbox
            fi
        else
            echo "VirtualBox already installed!"
        fi
    else
        echo "Unknown emulator: $1"
        exit 1
    fi
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Fedora Linux
# @params:	$1 the emulator to install, "virtualbox" or "qemu"
# 		$2 install non-interactively, boolean
###############################################################################
fedora()
{
    noninteractive=$2

    dnf_install="dnf install"
    if [ "$noninteractive" = true ]; then
        dnf_install+=" --assumeyes --quiet"
    fi

    echo "Detected Fedora"
    if [ -z "$(which git)" ]; then
        echo "Installing git..."
        sudo $dnf_install git-all
    fi

    if [ "$1" == "qemu" ]; then
        if [ -z "$(which qemu-system-x86_64)" ]; then
            echo "Installing QEMU..."
            sudo $dnf_install qemu-system-x86 qemu-kvm
            sudo $dnf_install qemu-system-arm edk2-aarch64
            sudo $dnf_install qemu-system-riscv
        else
            echo "QEMU already installed!"
        fi
    elif [ "$1" == "virtualbox" ]; then
        if [ -z "$(which virtualbox)" ]; then
            echo "Please install VirtualBox and re-run this script,"
            echo "or run with -e qemu"
            exit 1
        else
            echo "VirtualBox already installed!"
        fi
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    # Use rpm -q <package> to check if it's already installed
    PKGS=$(for pkg in @development-tools \
    ant \
    autoconf \
    automake \
    bison \
    cmake \
    curl \
    doxygen \
    expat \
    expat-devel \
    file \
    flex \
    fuse-devel \
    fuse3-devel \
    gcc \
    gcc-c++ \
    gdb \
    genisoimage \
    gettext-devel \
    glibc-devel.i686 \
    gmp-devel \
    help2man \
    libjpeg-turbo-devel \
    libpng-devel \
    libtool \
    lzip \
    m4 \
    make \
    meson \
    nasm \
    ninja-build \
    openssl \
    patch \
    patchelf \
    perl \
    perl-FindBin \
    perl-HTML-Parser \
    perl-Pod-Html \
    perl-Pod-Xhtml \
    pkgconf-pkg-config \
    po4a \
    protobuf-compiler \
    python3-mako \
    SDL2_ttf-devel \
    sdl12-compat-devel \
    syslinux \
    texinfo \
    unzip \
    vim \
    waf \
    zip \
    zstd ; do rpm -q $pkg > /dev/null || echo $pkg; done)
    # If the list of packages is not empty, install missing
    COUNT=$(echo $PKGS | wc -w)
    if [ $COUNT -ne 0 ]; then
        echo "Installing necessary build tools..."
        sudo $dnf_install $PKGS
    fi
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# *SUSE Linux
###############################################################################
suse()
{
    echo "Detected SUSE Linux"

    packages=(
    "ant"
    "autoconf"
    "automake"
    "bison"
    "cmake"
    "curl"
    "doxygen"
    "file"
    "flex"
    "fuse-devel"
    "gcc"
    "gcc-c++"
    "gdb-multiarch"
    "gettext-tools"
    "glibc-devel-32bit"
    "gmp-devel"
    "libexpat-devel"
    "libjpeg8-devel"
    "libpng16-devel"
    "libtool"
    "m4"
    "make"
    "meson"
    "nasm"
    "ninja"
    "openssl"
    "patch"
    "patchelf"
    "perl"
    "perl-HTML-Parser"
    "pkgconf"
    "po4a"
    "protobuf"
    "python-Mako"
    "scons"
    "syslinux-utils"
    "unzip"
    "wget"
    "xdg-utils"
    "zip"
    )

    if [ -z "$(which git)" ]; then
        echo "Will install git ..."
        packages+=(git)
    fi

    if [ "$1" == "qemu" ]; then
        if [ -z "$(which qemu-system-x86_64)" ]; then
            echo "Will install QEMU..."
            packages+=(qemu-x86 qemu-kvm)
        else
            echo "QEMU already installed!"
        fi
    elif [ "$1" == "virtualbox" ]; then
        if [ -z "$(which virtualbox)" ]; then
            echo "Please install VirtualBox and re-run this script,"
            echo "or run with -e qemu"
            exit 1
        else
            echo "VirtualBox already installed!"
        fi
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    echo "Installing necessary build tools..."

    # We could install all the packages in a single zypper command with:
    #
    #        zypper install package1 package2 package3
    #
    # But there is an issue with this: zypper returns a success code if at
    # least one of the packages was correctly installed, but we need it to fail
    # if any of the packages is missing.
    #
    # To confirm that the packages are available, we try to install them one by
    # one with --dry-run.
    # We still install all the packages in a single zypper command so that the
    # user has to confirm only once.
    for p in ${packages[@]}; do
        if rpm -q "${p}" > /dev/null ; then
            echo "${p} is already installed"
        else
            # Zypper shows a confirmation prompt and the "y" answer even with
            # --non-interactive and --no-confirm:
            #
            #   1 new package to install.
            #   Overall download size: 281.7 KiB. Already cached: 0 B.
            #   After the operation, additional 394.6 KiB will be used.
            #   Continue? [y/n/v/...? shows all options] (y): y
            #
            # That could make the user think that the package was installed,
            # when it was only a dry run.
            # To avoid the confusion, we hide the output unless there was an
            # error.
            if out="$(zypper --non-interactive install --no-confirm --dry-run --force-resolution ${p}  2>&1)"  ; then
                echo "${p} can be installed"
            else
                echo "no"
                echo ""
                echo "Zypper output:"
                echo ""
                echo "${out}"
                echo ""
                echo "Could not find how to install '${p}', try running:"
                echo ""
                echo "     zypper install ${p}"
                echo ""
                exit 1
            fi
        fi
    done

    zypper install ${packages[@]}
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Gentoo Linux
# @params:	$1 the emulator to install, "virtualbox" or "qemu"
###############################################################################
gentoo()
{
    echo "Detected Gentoo Linux"
    if [ -z "$(which nasm)" ]; then
        echo "Installing nasm..."
        sudo emerge dev-lang/nasm
    fi
    if [ -z "$(which git)" ]; then
        echo "Installing git..."
        sudo emerge dev-vcs/git
    fi
    if [ -z "$(which fusermount 2>/dev/null)" ] && [ -z "$(which fusermount3 2>/dev/null)" ]; then
        echo "Installing fuse..."
        sudo emerge sys-fs/fuse
    fi

    if [ "$1" == "qemu" ]; then
        if [ -z "$(which qemu-system-x86_64)" ]; then
            echo "Please install QEMU and re-run this script"
            echo "Step1. Add QEMU_SOFTMMU_TARGETS=\"x86_64\" to /etc/portage/make.conf"
            echo "Step2. Execute \"sudo emerge app-emulation/qemu\""
            exit 1
        else
            echo "QEMU already installed!"
        fi
    elif [ "$1" == "virtualbox" ]; then
        if [ -z "$(which virtualbox)" ]; then
            echo "Please install VirtualBox and re-run this script,"
            echo "or run with -e qemu"
            exit 1
        else
            echo "VirtualBox already installed!"
        fi
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    if [ -z "$(which cmake)" ]; then
        echo "Installing cmake..."
        sudo emerge dev-util/cmake
    fi
    if [ -z "$(ldconfig -p | grep fontconfig)" ]; then
        sudo emerge media-libs/fontconfig
    fi
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Solus
# @params:	$1 the emulator to install, "virtualbox" or "qemu"
###############################################################################
solus()
{
    echo "Detected Solus"

    if [ "$1" == "qemu" ]; then
        if [ -z "$(which qemu-system-x86_64)" ]; then
            sudo eopkg it qemu
        else
            echo "QEMU already installed!"
        fi
    elif [ "$1" == "virtualbox" ]; then
        if [ -z "$(which virtualbox)" ]; then
            echo "Please install VirtualBox and re-run this script,"
            echo "or run with -e qemu"
            exit 1
        else
            echo "VirtualBox already installed!"
        fi
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    echo "Installing necessary build tools..."
    #if guards are not necessary with eopkg since it does nothing if latest version is already installed
    sudo eopkg it autoconf \
    automake \
    binutils-gold \
    bison \
    cmake \
    flex \
    fuse-devel \
    fuse2-devel \
    g++ \
    gcc \
    glibc-devel \
    git \
    libgcc-32bit \
    libpng-devel \
    libstdc++-32bit \
    libtool-devel \
    linux-headers \
    m4 \
    make \
    nasm \
    patch \
    patchelf \
    perl-html-parser \
    pkg-config \
    po4a \
    rsync
}

###############################################################################
# Helper function to detect if we're running on Redox OS
# This needs to be checked before FreeBSD since both use 'pkg' package manager
###############################################################################
is_os_redox()
{
    [ "$(uname -s)" = "Redox" ]
}

###############################################################################
# This function takes care of installing all dependencies for building Redox on
# Redox OS itself (bootstrapping Redox on Redox)
# @params:    $1 the emulator to install, "virtualbox" or "qemu"
###############################################################################
redox()
{
    echo "Detected Redox OS"
    
    # Check if git is installed
    if [ -z "$(which git)" ]; then
        echo "Installing git..."
        sudo pkg install git
    fi

    # Handle emulator selection
    if [ "$1" == "qemu" ]; then
        echo "QEMU is not available on Redox OS yet, but it is mandatory for running the built system."
        echo "Please install QEMU manually on a compatible host or use another machine to run the emulator."
        exit 1
    elif [ "$1" == "virtualbox" ]; then
        echo "VirtualBox is not supported on Redox OS."
        exit 1
    else
        echo "Unknown emulator: $1"
        exit 1
    fi

    echo "Installing necessary build tools..."
    
    # Core development packages that are available on x86_64 Redox
    # This list is based on list of "cookbook" and "dev-essential" recipe
    packages="autoconf \
    automake \
    cbindgen \
    expat \
    gcc13 \
    gcc13.cxx \
    git \
    gnu-grep \
    gnu-make \
    installer \
    libgmp \
    libjpeg \
    libpng \
    nasm \
    patch \
    pkgar \
    pkg-config \
    python312 \
    rust \
    sdl1 \
    sdl2-ttf \
    vim"

    
    # Try to install packages, but don't fail if some are unavailable
    # since Redox package ecosystem is still developing
    for pkg in $PKGS; do
        if ! pkg list | grep -q "^${pkg}"; then
            echo "Attempting to install ${pkg}..."
            if ! sudo pkg install ${pkg} 2>/dev/null; then
                echo "Warning: ${pkg} could not be installed. It may not be available yet."
            fi
        else
            echo "${pkg} is already installed."
        fi
    done
    
    echo ""
    echo "Note: Building Redox on Redox itself is experimental."
    echo "Some dependencies may not be available yet in the Redox package repository."
    echo "For the best build experience, consider using podman_bootstrap.sh on another system."
}

######################################################################
# This function outlines the different options available for bootstrap
######################################################################
usage()
{
    echo "------------------------"
    echo "|Redox bootstrap script|"
    echo "------------------------"
    echo "Usage: ./native_bootstrap.sh"
    echo "OPTIONS:"
    echo
    echo "   -h,--help      Show this prompt"
    echo "   -u [branch]    Update git repo and update rust"
    echo "                  If blank defaults to master"
    echo "   -s             Check the status of the current travis build"
    echo "   -e [emulator]  Install specific emulator, virtualbox or qemu"
    echo "   -p [package    Choose an Ubuntu package manager, apt-fast or"
    echo "       manager]   aptitude"
    echo "   -d             Only install the dependencies, skip boot step"
    echo "   -y             Install non-interactively. Answer \"yes\" or"
    echo "                  select the default option for rustup and package"
    echo "					managers. Only the apt, dnf and pacman"
    echo "                  package managers are supported."
    echo "EXAMPLES:"
    echo
    echo "./native_bootstrap.sh -e qemu"
    exit
}

#############################################################
# Looks for and installs a cargo-managed binary or subcommand
#############################################################
cargoInstall()
{
    if is_os_redox ; then
        # in redox OS, cargo is not based on rustup. Packages are managed by pkg
        return 0
    fi
    if [[ "`cargo +stable install --list`" != *"$1 v$2"* ]]; then
        cargo +stable install --force --version "$2" "$1"
    else
        echo "You have $1 version $2 installed already!"
    fi
}

#############################################################################
# This function takes care of everything associated to rust, and the version
# manager that controls it, it can install rustup and uninstall multirust as
# well as making sure that the correct version of rustc is selected by rustup
# @params:	$1 install non-interactively, boolean
#############################################################################
rustInstall()
{
    if is_os_redox ; then
        # in redox OS, rustup is not available. Packages are managed by pkg
        return 0
    fi
    noninteractive=$1
    # Check to see if multirust is installed, we don't want it messing with rustup
    # In the future we can probably remove this but I believe it's good to have for now
    if [ -e /usr/local/lib/rustlib/uninstall.sh ] ; then
        echo "It appears that multirust is installed on your system."
        echo "This tool has been deprecated by the maintainer, and will cause issues."
        echo "This script can remove multirust from your system if you wish."
        printf "Uninstall multirust (y/N):"
        read multirust
        if echo "$multirust" | grep -iq "^y" ;then
            sudo /usr/local/lib/rustlib/uninstall.sh
        else
            echo "Please manually uninstall multirust and any other versions of rust, then re-run bootstrap."
            exit 1
        fi
    fi
    # If rustup is not installed we should offer to install it for them
    if [ -z "$(which rustup)" ]; then
        rustup_options="--default-toolchain stable"
        echo "You do not have rustup installed."
        if [ "$noninteractive" = true ]; then
            rustup="y"
            rustup_options+=" -y"
        else
            echo "We HIGHLY recommend using rustup."
            echo "Would you like to install it now?"
            echo "*WARNING* this involves a 'curl | sh' style command"
            printf "(y/N): "
            read rustup
        fi
        if echo "$rustup" | grep -iq "^y" ;then
            #install rustup
            curl https://sh.rustup.rs -sSf | sh -s -- $rustup_options
            # You have to add the rustup variables to the $PATH
            echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" >> ~/.bashrc
            # source the variables so that we can execute rustup commands in the current shell
            source ~/.cargo/env
        else
            echo "Rustup will not be installed!"
        fi
    fi

    if [ -z "$(which rustc)" ]; then
        echo "Rust is not installed"
        echo "Please either run the script again, accepting rustup install"
        echo "or install rustc stable manually (not recommended) via:"
        echo "\#curl -sSf https://static.rust-lang.org/rustup.sh | sh -s -- --channel=stable"
        exit 1
    else
        echo "Your Rust install looks good!"
    fi
}

####################################################################
# This function gets the current build status from travis and prints
# a message to the user
####################################################################
statusCheck()
{
    for i in $(echo "$(curl -sf https://api.travis-ci.org/repositories/redox-os/redox.json)" | tr "," "\n")
    do
        if echo "$i" | grep -iq "last_build_status" ;then
            if echo "$i" | grep -iq "0" ;then
                echo
                echo "********************************************"
                echo "Travis reports that the last build succeeded!"
                echo "Looks like you are good to go!"
                echo "********************************************"
            elif echo "$i" | grep -iq "null" ;then
                echo
                echo "******************************************************************"
                echo "The Travis build did not finish, this is an error with its config."
                echo "I cannot reliably determine whether the build is succeeding or not."
                echo "Consider checking for and maybe opening an issue on gitlab"
                echo "******************************************************************"
            else
                echo
                echo "**************************************************"
                echo "Travis reports that the last build *FAILED* :("
                echo "Might want to check out the issues before building"
                echo "**************************************************"
            fi
        fi
    done
}

###########################################################################
# This function is the main logic for the bootstrap; it clones the git repo
# then it installs the rust version manager and the latest version of rustc
###########################################################################
boot()
{
    echo "Cloning gitlab repo..."
    git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream
    echo "Creating .config with PODMAN_BUILD=0"
    echo 'PODMAN_BUILD?=0' > redox/.config
    echo "Cleaning up..."
    rm native_bootstrap.sh
    echo
    echo "---------------------------------------"
    echo "Well it looks like you are ready to go!"
    echo "---------------------------------------"
    statusCheck
    echo
    echo "** Be sure to update your path to include Rust - run the following command: **"
    echo 'source $HOME/.cargo/env'
    echo
    echo "Run the following commands to build Redox:"
    echo "cd redox"
    MAKE="make"
    if [[ "$(uname)" == "FreeBSD" ]]; then
        MAKE="gmake"
        echo "kldload fuse.ko # This loads the kernel module for FUSE"
    fi
    echo "$MAKE all"
    echo "$MAKE virtualbox or qemu"
    echo
    echo "      Good luck!"

    exit
}

if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then
    usage
elif [ "$1" == "-u" ]; then
    git pull upstream master
    exit
elif [ "$1" == "-s" ]; then
    statusCheck
    exit
fi

host_arch=$(uname -m)
emulator="qemu"
defpackman="apt-get"
dependenciesonly=false
update=false
noninteractive=false

while getopts ":e:p:udhys" opt
do
    case "$opt" in
        e) emulator="$OPTARG";;
        p) defpackman="$OPTARG";;
        d) dependenciesonly=true;;
        u) update=true;;
        h) usage;;
        y) noninteractive=true;;
        s) statusCheck && exit;;
        \?) echo "I don't know what to do with that option, try -h for help"; exit 1;;
    esac
done

banner

if [ "Darwin" == "$(uname -s)" ]; then
    echo "Detected macOS!"

    echo "WARNING: Building Redox OS on MacOS is not recommended, please use podman_bootstrap.sh instead."
    echo "WARNING: Our toolchain is not designed to work on MacOS and it relies on FUSE which requires kernel extensions."
    echo "WARNING: If you want to continue anyway, please wait for 3 seconds or cancel this script now!"
    sleep 3
fi

if [ "$update" == "true" ]; then
    git pull upstream master
    exit
fi

rustInstall "$noninteractive"

if [ "Darwin" == "$(uname -s)" ]; then
    osx "$emulator"
else
    # Here we will use package managers to determine which operating system the user is using.

    # Redox OS
    if is_os_redox; then
        redox "$emulator"
    # SUSE and derivatives
    elif hash 2>/dev/null zypper; then
        suse "$emulator"
    # Debian or any derivative of it
    elif hash 2>/dev/null apt-get; then
        ubuntu "$emulator" "$noninteractive" "$defpackman"
    # Fedora
    elif hash 2>/dev/null dnf; then
        fedora "$emulator" "$noninteractive"
    # Gentoo
    elif hash 2>/dev/null emerge; then
        gentoo "$emulator"
    # Solus
    elif hash 2>/dev/null eopkg; then
        solus "$emulator"
    # Arch Linux
    elif hash 2>/dev/null pacman; then
        archLinux "$emulator" "$noninteractive"
    # FreeBSD
    elif hash 2>/dev/null pkg; then
        freebsd "$emulator"
    # Unsupported platform
    else
        printf "\e[31;1mFatal error: \e[0;31mUnsupported platform, please open an issue\e[0m\n"
    fi
fi

cargoInstall just 1.42.4
cargoInstall cbindgen 0.29.0

if [ "$dependenciesonly" = false ]; then
    boot
fi

echo "Redox bootstrap complete!"