Merge pull request #1630 from input-output-hk/djo/1614/blst_portable_as_default

Use BLST portable feature to enable runtime ADX instruction set check

Author: Alenar

.github/workflows/ci.yml

@@ -32,8 +32,7 @@ jobs:
       # We separate the build in 2 steps as we want to avoid side effects with Rust feature unification.
       - name: Cargo build - Tooling
         shell: bash
-        run: |
-          cargo build --features portable --release -p mithril-end-to-end
+        run: cargo build --release -p mithril-end-to-end
 
       - name: Build Mithril workspace & publish artifacts
         uses: ./.github/workflows/actions/build-upload-mithril-artifact
@@ -166,7 +165,7 @@ jobs:
 
         include:
           - os: ubuntu-22.04
-            test-args: --features portable,full,unstable --workspace
+            test-args: --features full,unstable --workspace
           # Only test client on windows & mac (since its the only binaries supported for those os for now)
           - os: macos-12
             test-args: --package mithril-client --package mithril-client-cli --features full,unstable

CHANGELOG.md

@@ -17,6 +17,11 @@ As a minor extension, we have adopted a slightly different versioning convention
 
 - Chain observers support the retrieval of the current Cardano chain point.
 
+-  Deprecate `portable` feature of `mithril-stm` and `mithril-client`:
+   - Instead, always enable BLST `portable` feature in `mithril-stm` for runtime check of intel ADX instruction set.
+   - `portable` feature now has no effect and should be removed from crate dependencies.
+   - Removed it from all other crates (including `mithril-common`).
+
 - Crates versions:
 
 |  Crate  |  Version  |

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithrildemo"
-version = "0.1.33"
+version = "0.1.34"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }
@@ -30,6 +30,3 @@ mithril-stm = { path = "../../mithril-stm" }
 mithril-stm = { path = "../../mithril-stm", default-features = false, features = [
     "num-integer-backend",
 ] }
-
-[features]
-portable = ["mithril-common/portable", "mithril-stm/portable"]

demo/protocol-demo/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.4.56"
+version = "0.4.57"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -57,7 +57,4 @@ slog-term = "2.9.0"
 tempfile = "3.9.0"
 
 [features]
-portable = [
-    "mithril-common/portable",
-] # portable feature avoids SIGILL crashes on CPUs not supporting Intel ADX instruction set when built on CPUs that support it
 bundle_openssl = ["dep:openssl", "dep:openssl-probe"]

mithril-aggregator/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.7.8"
+version = "0.7.9"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -53,5 +53,4 @@ tokio = { version = "1.35.1", features = ["full"] }
 mithril-common = { path = "../mithril-common", features = ["test_tools"] }
 
 [features]
-portable = ["mithril-client/portable"]
 bundle_openssl = ["dep:openssl", "dep:openssl-probe"]

mithril-client-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client"
-version = "0.7.1"
+version = "0.7.2"
 description = "Mithril client library"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -76,7 +76,7 @@ full = ["fs"]
 
 # Enable file system releated functionnality, right now that mean ony snapshot download
 fs = ["flate2", "flume", "tar", "tokio/rt", "zstd"]
-portable = ["mithril-common/portable"]
+portable = [] # deprecated, will be removed soon
 unstable = []
 
 [package.metadata.docs.rs]

mithril-client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.3.29"
+version = "0.3.30"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }
@@ -117,9 +117,6 @@ fs = [
     "dep:pallas-traverse",
 ]
 
-# Portable feature avoids SIGILL crashes on CPUs not supporting Intel ADX instruction set when built on CPUs that support it
-portable = ["mithril-stm/portable"]
-
 # Disable signer certification, to be used only for tests
 allow_skip_signer_certification = []
 # Enable all tests tools

mithril-common/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.122"
+version = "0.2.123"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -46,7 +46,4 @@ prometheus-parse = "0.2.5"
 slog-term = "2.9.0"
 
 [features]
-portable = [
-    "mithril-common/portable",
-] # portable feature avoids SIGILL crashes on CPUs not supporting Intel ADX instruction set when built on CPUs that support it
 bundle_openssl = ["dep:openssl", "dep:openssl-probe"]

mithril-signer/Cargo.toml

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.18 (11-04-2024)
+
+- Deprecate `portable` feature:
+    - Instead, always enable BLST `portable` feature for runtime check of intel ADX instruction set.
+    - `portable` feature now has no effect and should be removed from crate dependencies.
+
 ## 0.3.7 (10-10-2023)
 
 ### Added