version 0.14.1

remove musl builds
build variations in CI to keep track of what works
2025-05-04 13:13:12 +02:00 · 2025-05-04 13:13:12 +02:00 · 2025-05-04 13:13:12 +02:00 · 2025-05-04 13:13:12 +02:00
10 changed files with 151 additions and 102 deletions
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@ -13,32 +13,44 @@ env:
  RUSTFLAGS: "-Dwarnings"

 jobs:
-  build:

+  build-gnu-apt:
    runs-on: ubuntu-latest
-
    steps:
      - uses: actions/checkout@v4

      - name: Update repos
        run: sudo apt-get update -qq
-      - name: Install rust toolchain
-        run: sudo apt-get install -qy cargo rust-clippy
-      - name: install lzma
-        run: sudo apt-get install -qy liblzma-dev
-      - name: install gcc
-        run: sudo apt-get install -qy gcc make
+      - name: Install toolchain
+        run: sudo apt-get install -qy cargo rust-clippy liblzma-dev gcc make pkgconf

      - name: Run Clippy
        run: cargo clippy

+      - name: build
+        run: cargo build
+
      - name: generate bindings
        run: ./generate-binding.sh
      - name: check that generated files did not change
        run: output=$(git status --porcelain) && [ -z "$output" ]

-      - name: build
-        run: cargo build
+      - name: build example -- glibc release
+        run: cd example && make clean && make TARGET=aarch64-unknown-linux-gnu PROFILE=release
+      - name: build example -- glibc debug
+        run: cd example && make clean && make TARGET=aarch64-unknown-linux-gnu PROFILE=debug

-      - name: build example
-        run: cd example && make
+  build-size-gnu-unstable:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update repos
+        run: sudo apt-get update -qq
+      - name: Install toolchain
+        run: sudo apt-get install -qy liblzma-dev gcc make pkgconf rustup
+      - name: install rust targets
+        run: rustup toolchain install nightly -t aarch64-unknown-linux-gnu -c rust-src --no-self-update
+
+      - name: build example -- glibc size-optimized
+        run: cd example && make clean && make TARGET=aarch64-unknown-linux-gnu PROFILE=size-optimized CARGO="rustup run nightly cargo" LTO=1
--- a/Cargo.lock
+++ b/Cargo.lock
@ -430,7 +430,7 @@ dependencies = [

 [[package]]
 name = "servicepoint_binding_c"
-version = "0.13.1"
+version = "0.14.1"
 dependencies = [
 "cbindgen",
 "servicepoint",
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,6 +1,6 @@
 [package]
 name = "servicepoint_binding_c"
-version = "0.13.1"
+version = "0.14.1"
 publish = true
 edition = "2021"
 license = "GPL-3.0-or-later"
--- a/example/Makefile
+++ b/example/Makefile
@ -1,85 +1,118 @@
-CC := gcc
-CARGO := rustup run nightly cargo
+CARGO ?= cargo
+STRIP ?= strip

-TARGET := x86_64-unknown-linux-musl
-PROFILE := size-optimized
-FEATURES := protocol_udp
+FEATURES := ""

 THIS_DIR := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
-REPO_ROOT := $(THIS_DIR)/..
-RUST_TARGET_DIR := $(REPO_ROOT)/target/$(TARGET)/$(PROFILE)
+REPO_ROOT := $(realpath $(THIS_DIR)/..)
 export SERVICEPOINT_HEADER_OUT := $(REPO_ROOT)/include

-RUSTFLAGS := -Zlocation-detail=none \
-	-Zfmt-debug=none \
-	-C linker=musl-gcc \
-	-C link-arg=-s \
-	-C link-arg=--gc-sections \
-	-C link-arg=-z,norelro \
-	-C link-arg=--hash-style=gnu \
-	--crate-type=staticlib \
-	-C panic=abort
+override CFG_MUSL := $(if $(CFG_MUSL),$(CFG_MUSL),$(if $(MUSL),$(MUSL),0))
+override CFG_PROFILE := $(if $(CFG_PROFILE),$(CFG_PROFILE),$(if $(PROFILE),$(PROFILE),release))

-CARGOFLAGS := --manifest-path=$(REPO_ROOT)/Cargo.toml \
-	--profile=$(PROFILE) \
+CCFLAGS += -Wall -fwhole-program -fPIE -pie
+
+STRIPFLAGS := -s --strip-unneeded -R .comment -R .gnu.version -R .note -R .note.gnu.build-id -R .note.ABI-tag
+
+ifeq ($(CFG_MUSL), 1)
+	TARGET ?= x86_64-unknown-linux-musl
+	CC ?= musl-gcc
+	CCFLAGS += -static -lservicepoint_binding_c
+	RUSTFLAGS += --crate-type=staticlib -Ctarget-feature=-crt-static
+else
+	TARGET ?= x86_64-unknown-linux-gnu
+	CC ?= gcc
+	#CCFLAGS += -shared
+	CCFLAGS += -Wl,-Bstatic -lservicepoint_binding_c -Wl,-Bdynamic
+endif
+
+#ifeq ($(CFG_PROFILE), size-optimized)
+#	CCFLAGS += -nodefaultlibs -lc
+#endif
+
+RUST_TARGET_DIR := $(REPO_ROOT)/target/$(TARGET)/$(CFG_PROFILE)
+
+ifeq ($(CFG_PROFILE), size-optimized)
+	CARGO_PROFILE := size-optimized
+	CCFLAGS += -Oz \
+		-fwrapv -fomit-frame-pointer -fno-stack-protector\
+		-fno-unroll-loops \
+		-fno-unwind-tables -fno-asynchronous-unwind-tables \
+		-fmerge-all-constants \
+		-Wl,-z,norelro \
+		-Wl,--hash-style=gnu \
+		-fvisibility=hidden \
+		-Bsymbolic \
+		-Wl,--exclude-libs,ALL \
+		-fno-ident \
+		-fno-exceptions
+	CARGOFLAGS += -Zbuild-std="core,std,alloc,proc_macro,panic_abort" \
+		-Zbuild-std-features="panic_immediate_abort"
+	RUSTFLAGS += -Zlocation-detail=none \
+		-Zfmt-debug=none \
+		-C link-arg=-z,norelro \
+		-C panic=abort
+		#-C link-arg=--hash-style=gnu
+else ifeq ($(CFG_PROFILE), release)
+	CARGO_PROFILE := release
+	CCFLAGS += -O2
+else ifeq ($(CFG_PROFILE), debug)
+	CCFLAGS += -Og
+	CARGO_PROFILE := dev
+else
+	CFG_PROFILE := $(error "PROFILE has to be set to one of: debug, release, size-optimized")
+endif
+
+CARGOFLAGS += --manifest-path=$(REPO_ROOT)/Cargo.toml \
+	--profile=$(CARGO_PROFILE) \
 	--no-default-features \
 	--features=$(FEATURES) \
-	--target=$(TARGET) \
-	-Zbuild-std="core,std,alloc,proc_macro,panic_abort" \
-	-Zbuild-std-features="panic_immediate_abort" \
+	--target=$(TARGET)

-CCFLAGS := -static -Os \
-	-ffunction-sections -fdata-sections \
-	-fwrapv -fomit-frame-pointer -fno-stack-protector\
-	-fwhole-program \
-	-nodefaultlibs -lservicepoint_binding_c -lc \
-	-Wl,--gc-sections \
-	-fno-unroll-loops \
-	-fno-unwind-tables -fno-asynchronous-unwind-tables \
-	-fmerge-all-constants \
-	-Wl,-z,norelro \
-	-Wl,--hash-style=gnu \
-	-fvisibility=hidden \
-	-Bsymbolic \
-	-Wl,--exclude-libs,ALL \
-	-fno-ident \
-	-Wall
-	#-fuse-ld=gold \
-	-fno-exceptions
-	#-Wl,--icf=all \
+ifneq ($(CFG_PROFILE), debug)
+	CCFLAGS += -ffunction-sections -fdata-sections -Wl,--gc-sections
+	RUSTFLAGS += -C link-arg=-s -C link-arg=-Wl,--gc-sections
+endif

-STRIPFLAGS := -s --strip-unneeded -R .comment -R .gnu.version -R .comment -R .note -R .note.gnu.build-id -R .note.ABI-tag
+ifeq ($(LTO), 1)
+	CCFLAGS += -flto
+endif

-_c_src := $(wildcard *.c)
-_programs := $(basename $(_c_src))
+_c_src := $(wildcard ./src/*.c)
+_programs := $(basename $(notdir $(_c_src)))
 _bins := $(addprefix out/, $(_programs))
 _unstripped_bins := $(addsuffix _unstripped, $(_bins))
 _run_programs := $(addprefix run_, $(_programs))
 _rs_src := $(wildcard ../src/**.rs) ../Cargo.lock ../Cargo.toml ../cbindgen.toml
+_sp_artifacts := $(SERVICEPOINT_HEADER_OUT)/servicepoint.h $(RUST_TARGET_DIR)/libservicepoint_binding_c.a $(RUST_TARGET_DIR)/libservicepoint_binding_c.so

 all: $(_bins)

-clean:
+clean: clean-c clean-rust
+
+clean-c:
 	rm -r out || true
-	rm include/servicepoint.h || true
+
+clean-rust:
+	rm $(SERVICEPOINT_HEADER_OUT)/servicepoint.h || true
 	cargo clean

-PHONY: all clean sizes $(_run_programs)
+.PHONY: all clean sizes $(_run_programs) clean-c clean-rust

-$(_unstripped_bins): out/%_unstripped: %.c $(SERVICEPOINT_HEADER_OUT)/servicepoint.h $(RUST_TARGET_DIR)/libservicepoint_binding_c.a
+$(_unstripped_bins): out/%_unstripped: src/%.c $(SERVICEPOINT_HEADER_OUT)/servicepoint.h $(_sp_artifacts)
 	mkdir -p out || true
-	${CC} $^ \
+	${CC} $< \
 		-I $(SERVICEPOINT_HEADER_OUT) \
-		-L $(RUST_TARGET_DIR)\
+		-L $(RUST_TARGET_DIR) \
 		$(CCFLAGS) \
 		-o $@

 $(_bins): out/%: out/%_unstripped
-	strip $(STRIPFLAGS) $^ -o $@
+	$(STRIP) $(STRIPFLAGS) $^ -o $@

-$(SERVICEPOINT_HEADER_OUT)/servicepoint.h $(RUST_TARGET_DIR)/libservicepoint_binding_c.a: $(_rs_src)
-	mkdir -p include || true
-	# generate servicepoint header and binary to link against
+$(_sp_artifacts): $(_rs_src)
+	mkdir -p $(SERVICEPOINT_HEADER_OUT) || true
+	# generate servicepoint header and library to link against
 	${CARGO} rustc $(CARGOFLAGS) -- $(RUSTFLAGS)

 $(_run_programs): run_%: out/% FORCE
@ -88,9 +121,9 @@ $(_run_programs): run_%: out/% FORCE
 sizes: $(_bins)
 	ls -lB out

-#analyze-size: out/example_unstripped
-#	nm --print-size --size-sort --reverse-sort --radix=d --demangle out/example_unstripped \
-#		| awk '{size=$$2+0; print size "\t" $$4}' \
-#		| less
+analyze-size: out/$(BIN)_unstripped
+	nm --print-size --size-sort --reverse-sort --radix=d --demangle out/$(BIN)_unstripped \
+		| awk '{size=$$2+0; print size "\t" $$4}' \
+		| less

 FORCE: ;
--- a/example/src/announce.c
+++ b/example/src/announce.c
@ -1,8 +1,12 @@
+#include <stdio.h>
 #include "servicepoint.h"

+
 int main(void) {
-    //UdpConnection *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342);
-    UdpConnection *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
+    printf("test\n");
+
+    UdpSocket *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342);
+    //UdpSocket *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
    if (connection == NULL)
        return 1;

--- a/example/src/brightness_tester.c
+++ b/example/src/brightness_tester.c
@ -1,8 +1,8 @@
 #include "servicepoint.h"

 int main(void) {
-    // UdpConnection *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342);
-    UdpConnection *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
+    UdpSocket *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342);
+    //UdpSocket *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
    if (connection == NULL)
        return -1;

--- a/example/src/random_stuff.c
+++ b/example/src/random_stuff.c
@ -2,7 +2,7 @@
 #include "servicepoint.h"

 int main(void) {
-    UdpConnection *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
+    UdpSocket *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342);
    if (connection == NULL)
        return 1;

--- a/flake.nix
+++ b/flake.nix
@ -33,16 +33,16 @@
        { pkgs, system }:
        {
          default = pkgs.mkShell rec {
-            buildInputs = with pkgs;[
+            buildInputs = with pkgs; [
              xe
              xz
              libgcc
-              #glibc.static
              musl
              libunwind
-              ];
+              pkgsStatic.musl
+            ];

-            nativeBuildInputs = with pkgs;[
+            nativeBuildInputs = with pkgs; [
              (pkgs.symlinkJoin {
                name = "rust-toolchain";
                paths = with pkgs; [
@ -57,6 +57,8 @@
                ];
              })
              gcc
+              gdb
+              pkgsStatic.gcc
              gnumake
              pkg-config
            ];
--- a/include/servicepoint.h
+++ b/include/servicepoint.h
@ -226,13 +226,9 @@ typedef struct SPBitVec SPBitVec;
 typedef struct TypedCommand TypedCommand;

 /**
- * A connection using the UDP protocol.
- *
- * Use this when sending commands directly to the display.
- *
- * Requires the feature "`protocol_udp`" which is enabled by default.
+ * This is a type only used by cbindgen to have a type for pointers.
 */
-typedef struct UdpConnection UdpConnection;
+typedef struct UdpSocket UdpSocket;

 /**
 * A 2D grid of values.
@ -298,7 +294,7 @@ typedef struct {
 * grid.set(1, 1, Brightness::MIN);
 *
 * # let connection = FakeConnection;
- * connection.send(BrightnessGridCommand {
+ * connection.send_command(BrightnessGridCommand {
 *     origin: Origin::new(3, 7),
 *     grid
 * }).unwrap()
@ -318,7 +314,7 @@ typedef ValueGrid_Brightness BrightnessGrid;
 *
 * let b = Brightness::try_from(7).unwrap();
 * # let connection = FakeConnection;
- * let result = connection.send(GlobalBrightnessCommand::from(b));
+ * let result = connection.send_command(GlobalBrightnessCommand::from(b));
 * ```
 */
 typedef uint8_t Brightness;
@ -347,7 +343,7 @@ typedef uint8_t Brightness;
 *
 * # let connection = FakeConnection;
 * let command = CharGridCommand { origin: Origin::ZERO, grid };
- * connection.send(command).unwrap()
+ * connection.send_command(command).unwrap()
 * ```
 */
 typedef ValueGrid_char CharGrid;
@ -1220,7 +1216,7 @@ bool sp_u16_to_command_code(uint16_t code,
 /**
 * Closes and deallocates a [UdpConnection].
 */
-void sp_udp_free(UdpConnection */*notnull*/ connection);
+void sp_udp_free(UdpSocket */*notnull*/ connection);

 /**
 * Creates a new instance of [UdpConnection].
@ -1235,7 +1231,7 @@ void sp_udp_free(UdpConnection */*notnull*/ connection);
 *     sp_udp_send_command(connection, sp_command_clear());
 * ```
 */
-UdpConnection *sp_udp_open(char */*notnull*/ host);
+UdpSocket *sp_udp_open(char */*notnull*/ host);

 /**
 * Creates a new instance of [UdpConnection].
@ -1250,11 +1246,11 @@ UdpConnection *sp_udp_open(char */*notnull*/ host);
 *     sp_udp_send_command(connection, sp_command_clear());
 * ```
 */
-UdpConnection *sp_udp_open_ipv4(uint8_t ip1,
-                                uint8_t ip2,
-                                uint8_t ip3,
-                                uint8_t ip4,
-                                uint16_t port);
+UdpSocket *sp_udp_open_ipv4(uint8_t ip1,
+                            uint8_t ip2,
+                            uint8_t ip3,
+                            uint8_t ip4,
+                            uint16_t port);

 /**
 * Sends a [TypedCommand] to the display using the [UdpConnection].
@ -1269,7 +1265,7 @@ UdpConnection *sp_udp_open_ipv4(uint8_t ip1,
 * sp_udp_send_command(connection, sp_command_brightness(5));
 * ```
 */
-bool sp_udp_send_command(UdpConnection */*notnull*/ connection,
+bool sp_udp_send_command(UdpSocket */*notnull*/ connection,
                         TypedCommand */*notnull*/ command);

 /**
@ -1283,8 +1279,7 @@ bool sp_udp_send_command(UdpConnection */*notnull*/ connection,
 * sp_udp_send_header(connection, sp_command_brightness(5));
 * ```
 */
-bool sp_udp_send_header(UdpConnection */*notnull*/ udp_connection,
-                        Header header);
+bool sp_udp_send_header(UdpSocket */*notnull*/ udp_connection, Header header);

 /**
 * Sends a [Packet] to the display using the [UdpConnection].
@ -1293,7 +1288,7 @@ bool sp_udp_send_header(UdpConnection */*notnull*/ udp_connection,
 *
 * returns: true in case of success
 */
-bool sp_udp_send_packet(UdpConnection */*notnull*/ connection,
+bool sp_udp_send_packet(UdpSocket */*notnull*/ connection,
                        Packet */*notnull*/ packet);

 #ifdef __cplusplus
--- a/src/lib.rs
+++ b/src/lib.rs
@ -67,3 +67,6 @@ pub(crate) unsafe fn heap_drop<T>(x: NonNull<T>) {
 pub(crate) unsafe fn heap_remove<T>(x: NonNull<T>) -> T {
    unsafe { *Box::from_raw(x.as_ptr()) }
 }
+
+/// This is a type only used by cbindgen to have a type for pointers.
+pub struct UdpSocket;
Author	SHA1	Message	Date
Vinzenz Schroeter	03c328719e	version 0.14.1 All checks were successful Rust / build-gnu-apt (pull_request) Successful in 4m14s Details Rust / build-size-gnu-unstable (pull_request) Successful in 1m12s Details	2025-05-04 13:13:12 +02:00
Vinzenz Schroeter	910e23cdc9	remove musl builds	2025-05-04 13:13:12 +02:00
Vinzenz Schroeter	fec521a5f1	build variations in CI to keep track of what works	2025-05-04 13:13:12 +02:00
Vinzenz Schroeter	e4606ebd0d	a bunch of options for the Makefile	2025-05-04 13:13:12 +02:00