Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions .github/workflows/build-python-sat.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: MIT
---
# Based on the `build_wheels` job of
# https://github.com/pysathq/pysat/blob/master/.github/workflows/build.yml
# and the test job of
# https://github.com/pysathq/pysat/blob/master/.github/workflows/test.yml
name: Build python-sat wheels (riscv64)

on:
workflow_dispatch:
inputs:
version:
description: 'Version glob to (re)build; empty builds every version of docs/packages/python-sat.yaml not released yet'
required: false
default: ''
pull_request:
branches: [main]
paths:
- '.github/workflows/build-python-sat.yml'
- 'docs/packages/python-sat.yaml'
- 'patches/python-sat/**'
push:
branches: [main]
paths:
- '.github/workflows/build-python-sat.yml'
- 'docs/packages/python-sat.yaml'
- 'patches/python-sat/**'

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

permissions:
contents: read # to fetch code (actions/checkout)

env:
# Upstream pushes no git tag for its releases; this commit sets
# VERSION = (1, 9, 'dev', 15) and its tree is byte-identical to the released
# sdist. Move it together with the version in docs/packages/python-sat.yaml.
PYTHON_SAT_REF: 152884a6d1889f56a61049aaa773be23f0a8d8c1
MANYLINUX_RISCV64_IMAGE: quay.io/pypa/manylinux_2_39_riscv64
MUSLLINUX_RISCV64_IMAGE: quay.io/pypa/musllinux_1_2_riscv64

jobs:
setup:
uses: $/.github/workflows/_setup.yml
with:
package: python-sat
version: ${{ inputs.version }}

build_wheels:
needs: [setup]
if: needs.setup.outputs.versions != '[]'
name: Build python-sat ${{ matrix.version }} ${{ matrix.python }}-${{ matrix.libc }}_riscv64
runs-on: ubuntu-24.04-riscv
timeout-minutes: 150
strategy:
fail-fast: false
matrix:
version: ${{ fromJSON(needs.setup.outputs.versions) }}
python: ["cp312", "cp313", "cp314", "cp314t"]
libc: [manylinux, musllinux]

env:
PYTHON_SAT_VERSION: ${{ matrix.version }}

steps:
- name: Checkout pysat ${{ env.PYTHON_SAT_REF }}
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: pysathq/pysat
ref: ${{ env.PYTHON_SAT_REF }}
persist-credentials: false

- name: Checkout python-wheels
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
path: python-wheels
persist-credentials: false

- name: Patch pysat source
run: git apply python-wheels/patches/python-sat/${{ env.PYTHON_SAT_VERSION }}/*.patch

- name: Build wheels
uses: pypa/cibuildwheel@1828c10ab37f080699c7b81cea34097c684a7074 # v4.2.0
env:
CIBW_ARCHS: riscv64
CIBW_BUILD: ${{ matrix.python }}-${{ matrix.libc }}_riscv64
CIBW_MANYLINUX_RISCV64_IMAGE: ${{ env.MANYLINUX_RISCV64_IMAGE }}
CIBW_MUSLLINUX_RISCV64_IMAGE: ${{ env.MUSLLINUX_RISCV64_IMAGE }}
CIBW_ENVIRONMENT: PIP_EXTRA_INDEX_URL=https://pypi.riseproject.dev/simple/
# pypblib (a test-only requirement of tests/test_encode_pb_conditional.py
# and tests/test_integer.py) has no riscv64 wheel and builds from its
# 0.0.4 sdist (last release, 2019), which has two musl-only C++ breaks:
# - PBParser.h uses the BSD `uint` typedef without including
# <sys/types.h>: glibc's libstdc++ headers pull that in transitively,
# musl's do not ("'uint' was not declared in this scope"). Force-include
# it (musl defines `uint` there under _GNU_SOURCE, which g++ always sets);
# CPPFLAGS reaches both the C and C++ compile lines of build_ext.
# - every PyTypeObject initialiser in Modules/pblib/*.cpp passes NULL in the
# old tp_print slot, which is tp_vectorcall_offset (a Py_ssize_t) since
# CPython 3.8. On glibc NULL is GCC's `__null`, which converts to 0 with a
# warning; musl's headers define NULL as `nullptr` in C++11, which cannot
# initialise an integer ("cannot convert 'std::nullptr_t' to 'Py_ssize_t'").
# Rewrite that one slot to 0 in the unpacked sdist before installing it.
# The python-sat wheel itself builds unchanged on musllinux; only this
# test dependency needs the workaround. Alpine is detected in-container.
CIBW_BEFORE_TEST: >-
if [ -f /etc/alpine-release ]; then
pip download --no-deps --no-binary :all: pypblib==0.0.4 -d /tmp/pypblib &&
tar -xzf /tmp/pypblib/pypblib-0.0.4.tar.gz -C /tmp/pypblib &&
sed -i 's|NULL\(, */\* tp_print \*/\)|0\1|' /tmp/pypblib/pypblib-0.0.4/Modules/pblib/*.cpp &&
CPPFLAGS="-include sys/types.h" pip install /tmp/pypblib/pypblib-0.0.4;
fi &&
pip install -r {project}/requirements.txt
CIBW_TEST_REQUIRES: pytest
CIBW_TEST_SOURCES: tests
CIBW_TEST_COMMAND: >-
python -c "import importlib.metadata as m, pysolvers;
l = [p.name for p in m.files('python-sat') if '.dist-info/licenses/' in str(p)];
assert len(l) == 20 and not hasattr(pysolvers, 'lingeling_new'), l"
&& python -m pytest tests

- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: python-sat-${{ env.PYTHON_SAT_VERSION }}-${{ matrix.python }}-${{ matrix.libc }}_riscv64
path: wheelhouse/*.whl
if-no-files-found: error

publish:
name: Publish python-sat ${{ matrix.version }}
needs: [setup, build_wheels]
if: needs.setup.outputs.versions != '[]'
strategy:
fail-fast: false
matrix:
version: ${{ fromJSON(needs.setup.outputs.versions) }}
permissions:
contents: write
pull-requests: write
uses: $/.github/workflows/_publish-wheel.yml
secrets:
app-private-key: ${{ secrets.RISEPROJECT_APP_PRIVATE_KEY }}
with:
artifact-pattern: python-sat-${{ matrix.version }}-*riscv64
10 changes: 10 additions & 0 deletions docs/packages/python-sat.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package-name: python-sat
source-code: https://github.com/pysathq/pysat
license: MIT
versions:
- version: 1.9.dev15
patched: true
warning: >-
The riscv64 wheel does not include the Lingeling solver: its licence grants use for
evaluation and research only and no right to redistribute it. pysat.solvers.Lingeling
and Solver(name='lingeling') are unavailable; the other eighteen solvers are included.
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
From c2359bfbabe0826799295fb3df2bca120a8c4179 Mon Sep 17 00:00:00 2001
From: Ludovic Henry <git@ludovic.dev>
Date: Sun, 27 Sep 2026 22:08:42 +0000
Subject: [PATCH 1/2] build without the Lingeling solver

Upstream-Status: Inappropriate [licensing: the bundled Lingeling bbc-9230380-160707 licence grants use for evaluation and research only, forbids commercial use and reserves all other rights, so it gives no permission to redistribute it in a binary wheel]

setup.py statically links every solver listed in to_install into the
pysolvers extension. The Lingeling tarball in solvers/lingeling.tar.gz
(lingeling-bbc-9230380-160707/COPYING) is not under the MIT terms that
cover PySAT and the other bundled solvers: it permits use "for
evaluation and research purposes", prohibits use "in a commercial
context" and ends with "All other usage is reserved". A third party
rebuilding and publishing wheels has no grant to redistribute it.

Drop 'lingeling' from to_install. pysolvers.cc guards all Lingeling
code behind WITH_LINGELING, so the extension builds and links without
it; pysat.solvers.Lingeling (and Solver(name='lingeling')) then fails
with an AttributeError on pysolvers.lingeling_new. Remove 'lingeling'
from the solver lists of the three tests that loop over every solver
so that they keep exercising the remaining eighteen.

Signed-off-by: Ludovic Henry <git@ludovic.dev>
---
setup.py | 2 +-
tests/test_accum_stats.py | 1 -
tests/test_cnf.py | 1 -
tests/test_unique_model.py | 1 -
4 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/setup.py b/setup.py
index e487226..e7b2338 100644
--- a/setup.py
+++ b/setup.py
@@ -70,7 +70,7 @@ Details can be found at `https://pysathq.github.io <https://pysathq.github.io>`_
#==============================================================================
to_install = ['cadical103', 'cadical153', 'cadical195', 'cadical300',
'gluecard30', 'gluecard41', 'glucose30', 'glucose41',
- 'glucose421', 'kissat404', 'lingeling', 'maplechrono',
+ 'glucose421', 'kissat404', 'maplechrono',
'maplecm', 'maplesat', 'mergesat3', 'minicard', 'minisat22',
'minisatgh', 'minisatep']

diff --git a/tests/test_accum_stats.py b/tests/test_accum_stats.py
index a71a900..9560e7a 100644
--- a/tests/test_accum_stats.py
+++ b/tests/test_accum_stats.py
@@ -8,7 +8,6 @@ solvers = ['cadical103',
'gluecard41',
'glucose30',
'glucose42',
- 'lingeling',
'maplechrono',
'maplecm',
'maplesat',
diff --git a/tests/test_cnf.py b/tests/test_cnf.py
index c8a53aa..cacacc9 100644
--- a/tests/test_cnf.py
+++ b/tests/test_cnf.py
@@ -12,7 +12,6 @@ solvers = ['cadical103',
'glucose30',
'glucose41',
'glucose42',
- 'lingeling',
'maplechrono',
'maplecm',
'maplesat',
diff --git a/tests/test_unique_model.py b/tests/test_unique_model.py
index 1a4004b..40f4597 100644
--- a/tests/test_unique_model.py
+++ b/tests/test_unique_model.py
@@ -9,7 +9,6 @@ solvers = ['cadical103',
'glucose30',
'glucose41',
'glucose42',
- 'lingeling',
'maplechrono',
'maplecm',
'maplesat',
--
2.43.0

Loading
Loading