Merge pull request CopperlineHQ#383 from sidick/feat/hostsocket-import

hostsocket: import bundled bsdsocket.library WASM plugin board

Author: LinuxJedi

.github/workflows/ci.yml

@@ -143,6 +143,32 @@ jobs:
           path: target/probe-golden/
           if-no-files-found: ignore
 
+  hostsocket-plugin:
+    name: HostSocket plugin (wasm32)
+    # The bundled bsdsocket.library board (crates/hostsocket-plugin) ships
+    # as a committed artifact (assets/hostsocket/hostsocket_plugin.wasm, the
+    # blob a plain cargo build embeds), so nothing else in CI compiles this
+    # crate at all. This job keeps the source buildable for its real target
+    # and runs its native unit suite. It deliberately does not byte-compare
+    # the artifact against a fresh build: rustc upgrades change wasm output,
+    # and the artifact is only expected to be refreshed when the crate
+    # itself changes (like the guest ROMs under assets/).
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: crates/hostsocket-plugin
+      - name: Build (wasm32-unknown-unknown)
+        working-directory: crates/hostsocket-plugin
+        run: cargo build --release --locked --target wasm32-unknown-unknown
+      - name: Native unit tests
+        working-directory: crates/hostsocket-plugin
+        run: cargo test --locked
+
   diagrom-smoke:
     name: DiagROM boot smoke
     needs: build

.github/workflows/locks.yml

@@ -3,9 +3,11 @@ name: Lockfile sync
 # Verifies every committed Cargo.lock still resolves with --locked, i.e. is
 # in sync with its workspace's manifests. The root lock is already exercised
 # by the --locked builds in ci.yml, but the nested workspaces mostly are not:
-# crates/copperline-web and crates/cputest-runner carry their own committed
-# locks. The web lock pins the sibling `copperline` path package by version;
-# the cputest-runner lock pins its published `m68k` dependency. A manifest
+# crates/copperline-web, crates/cputest-runner, and crates/hostsocket-plugin
+# carry their own committed locks. The web lock pins the sibling `copperline`
+# path package by version; the cputest-runner lock pins its published `m68k`
+# dependency; the hostsocket-plugin lock pins its `smoltcp` dependency (the
+# committed assets/hostsocket/hostsocket_plugin.wasm is built from it). A manifest
 # update without a lock refresh breaks `cargo build --locked` (issue #219:
 # the v0.12.0 tag shipped crates/copperline-web/Cargo.lock still pinning
 # copperline 0.11.0).
@@ -44,3 +46,6 @@ jobs:
       - name: crates/cputest-runner
         working-directory: crates/cputest-runner
         run: cargo tree --locked > /dev/null
+      - name: crates/hostsocket-plugin
+        working-directory: crates/hostsocket-plugin
+        run: cargo tree --locked > /dev/null

.gitignore

@@ -23,6 +23,9 @@
 
 # Standalone cputest runner build output.
 /crates/cputest-runner/target
+# Standalone HostSocket plugin build output (the committed artifact is
+# assets/hostsocket/hostsocket_plugin.wasm).
+/crates/hostsocket-plugin/target
 # CD images (cue/bin) are local assets, never committed.
 *.[Cc][Uu][Ee]
 *.[Bb][Ii][Nn]
@@ -34,6 +37,7 @@
 !/assets/aros/aros-amiga-m68k-rom.bin
 !/assets/aros/aros-amiga-m68k-ext.bin
 !/assets/services/services_rom.bin
+!/assets/hostsocket/hostsocket_rom.bin
 
 # Local run artifacts (screenshots, recordings, save states, input scripts,
 # RTC battery-RAM backing files).

README.md

@@ -58,6 +58,8 @@ against real hardware.
   DrawBridge / Greaseweazle / Supercard Pro via the bundled FloppyBridge,
   `docs/guide/floppybridge.md`), Gayle and A4000 IDE, SCSI (A2091,
   A4091, or the A3000's onboard Super DMAC), CDTV/CD32 CD, A2065 Ethernet,
+  a bundled host-backed `bsdsocket.library` (socket networking for guest
+  applications with no guest TCP/IP stack to boot),
   Z3660 and Picasso II/II+ RTG cards (high-colour Picasso96 screens), the serial
   port bridged to host stdout/TCP/PTY/MIDI, a parallel-port printer capture and
   audio sampler, host directories served live as AmigaDOS volumes, and Zorro
@@ -340,7 +342,7 @@ channel are in
 | Floppy / ADF / DMS / SCP | DF0-DF3 standard DD ADF read/write, read-only ADZ/DMS, UAE extended ADF, initial read-only SCP flux import, track-timed disk DMA, CIA drive lines, index FLAG, DSKLEN/DSKBYTR/DSKSYNC/DSKDAT, per-drive multi-disk playlists with a swap key, and real 3.5" drives through FloppyBridge (DrawBridge / Greaseweazle / Supercard Pro). |
 | Hard disks | Gayle IDE (A600/A1200) and A4000 motherboard IDE; SCSI via the A2091 (Zorro II DMAC + WD33C93A), A4091 (Zorro III 53C710 with SCRIPTS), or A3000 Super DMAC; RDB HDFs, bare partition hardfiles, and host-directory volumes. |
 | Host filesystem | `[[filesys]]` mounts serve host directories live as AmigaDOS volumes (read/write, `.uaem` attribute sidecars, Latin-1 name mapping). |
-| Expansion | Zorro II/III autoconfig chain, TOML-described RAM boards, WASM plugin boards (registers/interrupts/DMA in a sandboxed module), A2065 Ethernet (Am7990 LANCE) with loopback, userspace NAT, and direct host-adapter bridge backends. |
+| Expansion | Zorro II/III autoconfig chain, TOML-described RAM boards, WASM plugin boards (registers/interrupts/DMA in a sandboxed module), A2065 Ethernet (Am7990 LANCE) with loopback, userspace NAT, and direct host-adapter bridge backends, and the bundled HostSocket board (`bsdsocket.library` backed by a host-side TCP/IP stack over the same backends). |
 | Agnus VPOSR / VHPOSR | Beam counters advanced per colour clock; PAL and NTSC timing (including NTSC long/short lines). |
 | Agnus Copper | Beam-scheduled OCS Copper with COP1/COP2 jumps, WAIT, SKIP, DMAEN/COPEN gating, and chip-bus grants. |
 | Agnus blitter | Scheduled per-slot engine: normal/line/fill modes, hardware per-word channel bus sequences (including the area-fill idle C slot), BBUSY/BZERO, BLTPRI "nasty" vs CPU starvation-yield arbitration, blit-done IRQ. |

assets/hostsocket/hostsocket_plugin.wasm

@@ -266,6 +266,33 @@ slow = "512K"
 #                         # copperline --list-net-interfaces
 
 
+# HostSocket: bsdsocket.library backed by a host-side TCP/IP stack -- socket
+# networking for guest applications with no guest TCP/IP stack to install or
+# boot (the library autoboots from the board's ROM). Same net backends as
+# [a2065], but the guest needs no IP configuration at all: "nat" gives
+# applications outbound internet, "loopback" gives deterministic self-talk
+# (127.0.0.1), "none" a dead wire. Don't fit this alongside a real guest
+# TCP/IP stack -- both would add a bsdsocket.library.
+# [hostsocket]
+# net = "nat"
+# interface = "en0"       # required only for net = "bridge"
+# hostname = "amiga"      # gethostname() return value (cosmetic)
+# address = "192.168.1.50/24" # interface address; net = "bridge" only -- the
+#                             # 10.0.2.15/24 default is NAT's own virtual
+#                             # address, meaningless on a real LAN. No DHCP,
+#                             # so pick a static address the same way you
+#                             # would for any other device on that network.
+# gateway = "192.168.1.1"     # default gateway; net = "bridge" only, same
+#                             # reasoning as address above
+# gethostbyname() just works under net = "nat"/"bridge" with no further
+# config: it defaults to asking Copperline's own process to resolve via the
+# host OS resolver on a background thread (rejected under "loopback": it
+# would defeat that backend's whole point of byte-identical determinism).
+# Override only to target a *specific* DNS server instead of the host's:
+# resolver = "dns"        # query dns_server directly instead of the host resolver
+# dns_server = "10.0.2.3" # only used when resolver = "dns"
+
+
 # RTG graphics card: high-resolution, high-colour screens via Picasso96.
 # Z3660 is fitted by default on any machine whose CPU has a 32-bit address bus
 # (stock A3000/A4000, or any profile given a 68020+ full-bus CPU). Picasso II

assets/hostsocket/hostsocket_rom.bin

@@ -0,0 +1,52 @@
+[package]
+name = "hostsocket-plugin"
+version = "0.1.0"
+edition = "2021"
+description = "Bundled Copperline WASM board: bsdsocket.library backed by an embedded smoltcp stack"
+license = "GPL-3.0-or-later"
+publish = false
+
+[lib]
+# "cdylib" is what actually ships (the wasm32-unknown-unknown board). "rlib"
+# is added so `cargo test` (native target) can link a normal test harness
+# against this crate at all -- without it, the native test binary silently
+# exits (status 101, no output) before running anything, since a cdylib-only
+# artifact isn't something a native binary can link against as a library.
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+# default-features disabled: smoltcp's std feature pulls in libc-backed
+# device backends (raw sockets, tuntap) that don't exist on
+# wasm32-unknown-unknown -- we drive it purely through net_send/net_recv
+# instead. socket-udp backs sendto/recvfrom; socket-dns backs gethostbyname
+# (see src/lib.rs's module doc comment for why gethostbyaddr/reverse lookup
+# stays out even with this feature on). socket-icmp + auto-icmp-echo-reply
+# back SOCK_RAW/IPPROTO_ICMP support (do_socket's own comment): socket-icmp
+# is the userspace raw-ICMP socket type a guest ping implementation opens
+# and reads/writes directly; auto-icmp-echo-reply makes the *interface
+# itself* answer incoming echo requests automatically (the same thing a
+# real OS kernel's IP stack does, independent of any userspace ping socket)
+# -- without it, pinging the board's own INTERFACE_ADDR (or 127.0.0.1 under
+# net = "loopback", which bounces the request straight back to this same
+# interface) would never get a reply at all, since nothing else in this
+# plugin ever answers on the stack's behalf.
+smoltcp = { version = "0.13", default-features = false, features = [
+    "alloc",
+    "medium-ethernet",
+    "proto-ipv4",
+    "socket-tcp",
+    "socket-udp",
+    "socket-dns",
+    "socket-icmp",
+    "auto-icmp-echo-reply",
+] }
+
+# The shipped artifact (assets/hostsocket/hostsocket_plugin.wasm) is built
+# with this profile; size matters because the module is embedded in the
+# copperline binary. Mirrors the standalone upstream repo's workspace
+# profile.
+[profile.release]
+opt-level = "z"
+lto = true
+panic = "abort"
+strip = true

copperline.example.toml

@@ -0,0 +1,17 @@
+# Builds the release wasm32 module and installs it as the committed artifact
+# assets/hostsocket/hostsocket_plugin.wasm -- the blob a plain cargo build of
+# the emulator embeds (rebuilding needs the wasm32-unknown-unknown rustup
+# target; nothing else in the repo does). Mirrors guest/hostsocket/Makefile,
+# which installs the companion stub ROM the same way: the committed artifact
+# is refreshed by this install step, never as a side effect of a build.
+
+ARTIFACT = ../../assets/hostsocket/hostsocket_plugin.wasm
+
+all:
+	cargo build --release --locked --target wasm32-unknown-unknown
+	cp target/wasm32-unknown-unknown/release/hostsocket_plugin.wasm $(ARTIFACT)
+
+clean:
+	cargo clean
+
+.PHONY: all clean