mirror of
https://github.com/sigp/lighthouse.git
synced 2026-05-08 01:05:47 +00:00
Make portable the default in Lighthouse book and Makefile, update workflows (#6247)
* Remove portable in book * Add back modern in docker.md * Update Makefile * Update release.yml * Update docker.yml * Update book * Minor revision * delete portable tarballs * delete portable in Make command * Fix link in book * mdlint * Remove modernity in docker * Merge branch 'unstable' into update-book-portable * Merge branch 'unstable' into update-book-portable * Remove `-dev` docker images * Merge remote-tracking branch 'origin/unstable' into update-book-portable
This commit is contained in:
chonghe
@@ -15,18 +15,10 @@ project.
|
||||
|
||||
### Targets
|
||||
|
||||
The `Makefile` in the project contains four targets for cross-compiling:
|
||||
The `Makefile` in the project contains two targets for cross-compiling:
|
||||
|
||||
- `build-x86_64`: builds an optimized version for x86_64 processors (suitable for most users).
|
||||
- `build-x86_64-portable`: builds a version for x86_64 processors which avoids using some modern CPU
|
||||
instructions that are incompatible with older CPUs.
|
||||
- `build-aarch64`: builds an optimized version for 64-bit ARM processors (suitable for Raspberry Pi 4).
|
||||
- `build-aarch64-portable`: builds a version for 64-bit ARM processors which avoids using some
|
||||
modern CPU instructions. In practice, very few ARM processors lack the instructions necessary to
|
||||
run the faster non-portable build.
|
||||
|
||||
For more information about optimized vs portable builds see
|
||||
[Portability](./installation-binaries.md#portability).
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -35,28 +35,23 @@ Lighthouse vx.x.xx-xxxxxxxxx
|
||||
BLS Library: xxxx-xxxxxxx
|
||||
```
|
||||
|
||||
> Pro tip: try the `latest-modern` image for a 20-30% speed-up! See [Available Docker
|
||||
> Images](#available-docker-images) below.
|
||||
|
||||
### Available Docker Images
|
||||
|
||||
There are several images available on Docker Hub.
|
||||
|
||||
Most users should use the `latest-modern` tag, which corresponds to the latest stable release of
|
||||
Lighthouse with optimizations enabled. If you are running on older hardware then the default
|
||||
`latest` image bundles a _portable_ version of Lighthouse which is slower but with better hardware
|
||||
compatibility (see [Portability](./installation-binaries.md#portability)).
|
||||
Most users should use the `latest` tag, which corresponds to the latest stable release of
|
||||
Lighthouse with optimizations enabled.
|
||||
|
||||
To install a specific tag (in this case `latest-modern`), add the tag name to your `docker` commands:
|
||||
To install a specific tag (in this case `latest`), add the tag name to your `docker` commands:
|
||||
|
||||
```bash
|
||||
docker pull sigp/lighthouse:latest-modern
|
||||
docker pull sigp/lighthouse:latest
|
||||
```
|
||||
|
||||
Image tags follow this format:
|
||||
|
||||
```text
|
||||
${version}${arch}${stability}${modernity}${features}
|
||||
${version}${arch}${stability}
|
||||
```
|
||||
|
||||
The `version` is:
|
||||
@@ -75,19 +70,9 @@ The `stability` is:
|
||||
* `-unstable` for the `unstable` branch
|
||||
* empty for a tagged release or the `stable` branch
|
||||
|
||||
The `modernity` is:
|
||||
|
||||
* `-modern` for optimized builds
|
||||
* empty for a `portable` unoptimized build
|
||||
|
||||
The `features` is:
|
||||
|
||||
* `-dev` for a development build with `minimal` preset enabled (`spec-minimal` feature).
|
||||
* empty for a standard build with no custom feature enabled.
|
||||
|
||||
Examples:
|
||||
|
||||
* `latest-unstable-modern`: most recent `unstable` build for all modern CPUs (x86_64 or ARM)
|
||||
* `latest-unstable`: most recent `unstable` build
|
||||
* `latest-amd64`: most recent Lighthouse release for older x86_64 CPUs
|
||||
* `latest-amd64-unstable`: most recent `unstable` build for older x86_64 CPUs
|
||||
|
||||
|
||||
@@ -13,13 +13,6 @@ Binaries are supplied for four platforms:
|
||||
- `x86_64-apple-darwin`: macOS with Intel chips
|
||||
- `x86_64-windows`: Windows with 64-bit processors
|
||||
|
||||
Additionally there is also a `-portable` suffix which indicates if the `portable` feature is used:
|
||||
|
||||
- Without `portable`: uses modern CPU instructions to provide the fastest signature verification times (may cause `Illegal instruction` error on older CPUs)
|
||||
- With `portable`: approx. 20% slower, but should work on all modern 64-bit processors.
|
||||
|
||||
For details, see [Portability](#portability).
|
||||
|
||||
## Usage
|
||||
|
||||
Each binary is contained in a `.tar.gz` archive. For this example, lets assume the user needs
|
||||
@@ -41,30 +34,3 @@ a `x86_64` binary.
|
||||
1. (Optional) Move the `lighthouse` binary to a location in your `PATH`, so the `lighthouse` command can be called from anywhere. For example, to copy `lighthouse` from the current directory to `usr/bin`, run `sudo cp lighthouse /usr/bin`.
|
||||
|
||||
> Windows users will need to execute the commands in Step 2 from PowerShell.
|
||||
|
||||
## Portability
|
||||
|
||||
Portable builds of Lighthouse are designed to run on the widest range of hardware possible, but
|
||||
sacrifice the ability to make use of modern CPU instructions.
|
||||
|
||||
If you have a modern CPU then you should try running a non-portable build to get a 20-30% speed up.
|
||||
|
||||
- For **x86_64**, any CPU supporting the [ADX](https://en.wikipedia.org/wiki/Intel_ADX) instruction set
|
||||
extension is compatible with the optimized build. This includes Intel Broadwell (2014)
|
||||
and newer, and AMD Ryzen (2017) and newer.
|
||||
- For **ARMv8**, most CPUs are compatible with the optimized build, including the Cortex-A72 used by
|
||||
the Raspberry Pi 4.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you get a SIGILL (exit code 132), then your CPU is incompatible with the optimized build
|
||||
of Lighthouse and you should switch to the `-portable` build. In this case, you will see a
|
||||
warning like this on start-up:
|
||||
|
||||
```
|
||||
WARN CPU seems incompatible with optimized Lighthouse build, advice: If you get a SIGILL, please try Lighthouse portable build
|
||||
```
|
||||
|
||||
On some VPS providers, the virtualization can make it appear as if CPU features are not available,
|
||||
even when they are. In this case you might see the warning above, but so long as the client
|
||||
continues to function, it's nothing to worry about.
|
||||
|
||||
@@ -160,8 +160,7 @@ FEATURES=gnosis,slasher-lmdb make
|
||||
Commonly used features include:
|
||||
|
||||
- `gnosis`: support for the Gnosis Beacon Chain.
|
||||
- `portable`: support for legacy hardware.
|
||||
- `modern`: support for exclusively modern hardware.
|
||||
- `portable`: the default feature as Lighthouse now uses runtime detection of hardware CPU features.
|
||||
- `slasher-lmdb`: support for the LMDB slasher backend. Enabled by default.
|
||||
- `slasher-mdbx`: support for the MDBX slasher backend.
|
||||
- `jemalloc`: use [`jemalloc`][jemalloc] to allocate memory. Enabled by default on Linux and macOS.
|
||||
|
||||
Reference in New Issue
Block a user