Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/uraimo/buildSwiftOnARM

All you need to build Swift on a RaspberryPi or other ARM boards, updated to Swift 5.1.5
https://github.com/uraimo/buildSwiftOnARM
arm debian raspberrypi raspbian swift ubuntu
Last synced: about 1 month ago
JSON representation
All you need to build Swift on a RaspberryPi or other ARM boards, updated to Swift 5.1.5
Host: GitHub
URL: https://github.com/uraimo/buildSwiftOnARM
Owner: uraimo
Created: 2016-12-17T20:52:10.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2021-12-08T11:14:03.000Z (about 3 years ago)
Last Synced: 2024-06-20T05:49:21.135Z (6 months ago)
Topics: arm, debian, raspberrypi, raspbian, swift, ubuntu
Language: Shell
Homepage:
Size: 427 KB
Stars: 487
Watchers: 30
Forks: 36
Open Issues: 8
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

awesome-embedded-swift - buildSwiftOnARM - 🛠All you need to build Swift on a RaspberryPi or other ARM boards, updated to Swift 5.1.1 (Single Board Computers)
README

        




Scripts to clone, configure, patch and build Swift 5.4 on Linux ARM devices. 



For precompiled Swift 5.4 binaries see the *[Prebuilt binaries](#prebuilt-binaries)* section, if you want to build Swift on your own instead, check out the *[Building on ARM](#building-on-arm)* section and the step-by-step instructions.

### Summary

- [Supported Architectures](#supported-architectures)

- [Prebuilt binaries](#prebuilt-binaries)

- [Usage](#usage)

    - [Dependencies](#dependencies) 

- [Building on ARM](#building-on-arm)

    - [Step by step instructions](#step-by-step-instructions)

    - [Setup your own build infrastructure](#setup-your-own-build-infrastructure)

- [GitHub CI on ARM](#github-ci-on-arm)

- [REPL Issues](#repl-issues)

- [Acknowledgments](#acknowledgments) 

- [Previous Releases](#previous-releases)

## Supported Architectures

* ✅  ARMv6 32bit: _Original RaspberryPi, Pi Zero, etc..._

* ✅  ARMv7/8 32bit: _All versions of RaspberryPi 2/3, OrangePi, ODroid, CHIP, etc..._

* ✅  aarch64: _RaspberryPis or other ARMv8 boards with a 64 bit OS, Pine64, etc..._

## Prebuilt binaries

| OS | Architecture | Boards | Download |                                                                          

| -- | ------------ | ------ | -------- |

| Raspbian Buster | ARMv6 | All RaspberryPis: Classic, Zero, 2, 3, 4 | [5.4](https://github.com/uraimo/buildSwiftOnARM/releases/download/5.4/swift-5.4-armv6-RPi01234-RaspbianBuster.tgz) |

| Raspbian Bullseye | ARMv6 | All RaspberryPis: Classic, Zero, 2, 3, 4 | [5.4]() |

| Debian Buster | ARMv7 | Every ARMv7 board, RaspberryPis 2/3/4 included | [5.4]() |

| Debian Bullseye | ARMv7 | Every ARMv7 board, RaspberryPis 2/3/4 included | [5.4]() |

| Ubuntu 18.04 | ARMv7 | All versions of RaspberryPi 2/3/4, other ARMv7 boards | [5.4]() |

| Ubuntu 20.04 | ARMv7 | All versions of RaspberryPi 2/3/4, other ARMv7 boards | [5.4]() |

| Ubuntu 16.04/18.04 | aarch64 | All versions of RaspberryPi 3/4, other ARMv7 boards | 5.4.1: [swift-arm64](https://github.com/futurejones/swift-arm64/releases/tag/v5.4.1-RELEASE) |

 

For binaries of older releases, check out the [releases page](https://github.com/uraimo/buildSwiftOnARM/releases).

For alternative ways to install these Swift binaries on your ARM board, check out [Swift on Balena](https://github.com/wlisac/swift-on-balena/) by Will Lisac, Helge Heß's [dockSwiftOnARM](https://github.com/helje5/dockSwiftOnARM), both based on Docker, and the [Swift Deb Repository](https://swift-arm.com/install-swift/) maintained by Neil Jones.

To quickly cross-compile your Swift applications for ARM on a Mac (a time saver) check out the [Swift Cross Compilation Toolchains](https://github.com/CSCIX65G/SwiftCrossCompilers) project built by Van Simmons.

## Usage

When using the Swift Package Manager on one of these boards, that usually have limited memory/cpu, you'll need to use the new `-j` option to reduce the number of threads spawned by the tool and be able to compile.

For example, when building an SPM project most of the times we'll limit the number of jobs to one:

```

    pi@raspberrypi:> swift build -j 1 

```

### Dependencies 

In order to use the provided prebuilt binaries you'll need to install the following dependencies:

**Raspbian Buster, Ubuntu 18.04 and newer**

    sudo apt install clang libicu-dev libcurl4-nss-dev curl

Decompress the archive on the RaspberryPi, you'll find the Swift binaries in `usr/bin/` relative to where you decompressed the archive.

    tar -xzf 

Ensure that the path you decompressed to is in your `PATH` environment variable: `echo $PATH`. If it's not then add it to your path for your shell.

    PATH="$HOME/usr/bin:$PATH"

To permanently add this to your `PATH` variable, you can add the following block of code to the end of your `~/.profile` file:

    if [ -d "$HOME/usr/bin" ] ; then

        PATH="$HOME/usr/bin:$PATH"

    fi

Verify the swift version is setup: 

    $ swift --version

    

    Swift version 5.4 (swift-5.4-RELEASE)

    Target: armv7-unknown-linux-gnueabihf

## Building on ARM

For the latest updates on Swift on ARM, check out my blog [here](https://www.uraimo.com/category/raspberry/).

Check out Helge Heß's project [dockSwiftOnARM](https://github.com/helje5/dockSwiftOnARM) to build Swift in a Docker container or to [build a cross-compiling toolchain](https://github.com/AlwaysRightInstitute/swift-mac2arm-x-compile-toolchain) that will allow you to build arm binaries directly from your Mac using a precompiled swiftc for ARM.

The scripts that buildSwiftOnARM provides:

- clone.sh - Install dependencies and clones the main Swift repository and all the related projects

- checkoutRelease.sh - Resets all repos, updates them, checks out a specific tag (5.4 at the moment) and apply the patches.

- build.sh - Builds Swift producing a tgz archive with the Swift distributions. 

- clean.sh - Cleans all build artifacts, only needed when you want to start again from scratch.

### Step by step instructions

First of all, use a suitably sized sd-card, at least 32Gb in size, but I recommend to use an external USB drive to clone the project and build Swift.

Configure a swap file of at least 2Gb, on Ubuntu:

    sudo fallocate -l 2G swapfile

    sudo chmod 600 swapfile

    sudo mkswap swapfile

    sudo swapon swapfile

    

You'll need to manually enable the swap file with `swapon` *each time you reboot* the RaspberryPi (or the system will just run without swap).

On Raspbian, since the swapfile is already configured, open `/etc/dphys-swapfile` and edit `CONF_SWAPSIZE` to increase the size:

    CONF_SWAPSIZE=2048

    

Save the file and:

    sudo /etc/init.d/dphys-swapfile stop

    sudo /etc/init.d/dphys-swapfile start

    

Now, call the included scripts as follows:

1. Launch `clone.sh` that will install the required dependencies (_git cmake ninja-build clang-3.8 python uuid-dev libicu-dev icu-devtools libbsd-dev libedit-dev libxml2-dev libsqlite3-dev swig libpython-dev libncurses5-dev pkg-config libblocksruntime-dev libcurl4-openssl-dev autoconf libtool systemtap-sdt-dev libcurl4-openssl-dev libz-dev_), fix clang links and clone apple/swift with all its dependecies.

2. Run `checkoutRelease.sh` that will select the current release (5.4) and apply the needed patches.

3. Once done, start the build with `build.sh`.

4. Once the build completes a few hours later, you'll have a `swift-5.4-armv7.tgz` archive containing the whole Swift compiler distribution. Once decompressed you'll find the Swift binaries under `usr/bin`.

I recommend to perform all these operations in a permanent background `tmux` or `screen` session (`CTRL+B d` to detach from the session and `tmux a` to reattach to it when you ssh again into the RaspberryPi).

Additional steps could be required in some cases [check the latest ARM posts on my blog for additional info](https://www.uraimo.com/category/raspberry/).

To build a different release than the one currently configured in the script, open `checkoutRelease.sh` and `build.sh` and modify the variables on top, with the branch name for the release and the release name for the tgz respectively.

### Setup your own build infrastructure

If you need to replicate a setup like the one I use to build all the Swift binaries you can find above, using only a single Raspberry Pi 4 or a similar board ARMv7 board as build machine, check out [buildSwiftOnARMInfra](https://github.com/uraimo/buildSwiftOnARMInfra) with its docker containers.

## GitHub CI on ARM

ARM projects can be tested in an environment simulated through QEMU on GitHub using the [Run-On-Architecture](https://github.com/uraimo/run-on-arch-action) action.

While you will not be able to use hardware interfaces available on real ARM boards, this environment should be more than enough to perform some basic testing or even build your projects and deploy them directly to your target ARM board (with considerable time savings).

## REPL Issues

Since the first releases of Swift on ARM32, the REPL has never been available on this platform, but that doesn't impact the compiler itself. Considering this, as you would expect, launching `swift` without parameters will result in an error instead of the REPL prompt.

## Acknowledgments 

We wouldn't have Swift on ARM and most of the patches included on buildSwiftOnARM without the work done by these developers:

 * [@KittyMac](https://github.com/KittyMac)

 * [@buttaface](https://github.com/buttaface)

 * [@Kaiede](https://github.com/Kaiede)

 * [@chnmrc](https://github.com/chnmrc)

 * [@futurejones](https://github.com/futurejones)

 * [@jasonm128](https://github.com/jasonm128)

 * [@hpux735](https://twitter.com/hpux735)

 * [@iachievedit](https://twitter.com/iachievedit)

 

The community can be reached at the [swift-arm](https://launchpass.com/swift-arm) Slack channel.

## Previous Releases

You can compile old releases checking out the specific tag:

* [Swift 5.1.5](https://github.com/uraimo/buildSwiftOnARM/tree/5.1.5)

* [Swift 5.1.3](https://github.com/uraimo/buildSwiftOnARM/tree/5.1.3)

* [Swift 5.1.2](https://github.com/uraimo/buildSwiftOnARM/tree/5.1.2)

* [Swift 5.1.1](https://github.com/uraimo/buildSwiftOnARM/tree/5.1.1)

* [Swift 5.1](https://github.com/uraimo/buildSwiftOnARM/tree/5.1)

* [Swift 5.0.3](https://github.com/uraimo/buildSwiftOnARM/tree/5.0.3)

* [Swift 5.0.2](https://github.com/uraimo/buildSwiftOnARM/tree/5.0.2)

* [Swift 5.0.1](https://github.com/uraimo/buildSwiftOnARM/tree/5.0.1)

* [Swift 5.0](https://github.com/uraimo/buildSwiftOnARM/tree/5.0)

* [Swift 4.2.3](https://github.com/uraimo/buildSwiftOnARM/tree/4.2.3)

* [Swift 4.2.2](https://github.com/uraimo/buildSwiftOnARM/tree/4.2.2)

* [Swift 4.2.1](https://github.com/uraimo/buildSwiftOnARM/tree/4.2.1)

* [Swift 4.1.3](https://github.com/uraimo/buildSwiftOnARM/tree/4.1.3)

* [Swift 3.1.1](https://github.com/uraimo/buildSwiftOnARM/tree/3.1.1)

* [Swift 3.1](https://github.com/uraimo/buildSwiftOnARM/tree/3.1)

* [Swift 3.0.2](https://github.com/uraimo/buildSwiftOnARM/tree/3.0.2)