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
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ cranelift-jit = { version = "0.116", optional = true }
cranelift-module = { version = "0.116", optional = true }
cranelift-native = { version = "0.116", optional = true }
target-lexicon = { version = "0.13", optional = true }
libchdman-rs = { version = "0.287.0-l7", features = ["prebuilt"], optional = true }
libchdman-rs = { version = "0.288.9", features = ["prebuilt"], optional = true }
pcap = { version = "2", optional = true }
shared_memory = { version = "0.12", optional = true }
raw_sync = { version = "0.1", optional = true }
Expand Down
674 changes: 0 additions & 674 deletions LICENSE-GPL3.txt

This file was deleted.

58 changes: 58 additions & 0 deletions LICENSE-libchdman-rs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
Third-party license — CHD disk-image backend
=============================================

The optional `--features chd` build links the `libchdman-rs` crate, a Rust
wrapper around MAME's CHD (Compressed Hunks of Data) core. As of
libchdman-rs 0.288.8 the crate and the CHD core files it vendors are
distributed under the BSD 3-Clause License (the same family as IRIS itself),
so enabling CHD support no longer subjects the combined binary to the GPL.

The MAME project as a whole is distributed under GPL-2.0-or-later, but that is
an aggregate license. The specific CHD core files vendored and compiled by
libchdman-rs each carry an individual `// license:BSD-3-Clause` SPDX header,
and the bundled compression codecs are likewise permissive (zlib and
Zstandard — BSD-3-Clause, libFLAC — BSD-3-Clause, LZMA — Public Domain,
utf8proc — MIT).

--------------------------------------------------------------------------------
libchdman-rs (Rust wrapper + prebuilt static archives)
https://github.com/danifunker/libchdman-rs
https://crates.io/crates/libchdman-rs

BSD 3-Clause License

Copyright (c) 2026 Dani Sarfati (danifunker)

--------------------------------------------------------------------------------
MAME CHD core (vendored and compiled by libchdman-rs)

BSD 3-Clause License

Copyright (c) Aaron Giles and the MAME contributors

--------------------------------------------------------------------------------

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ Without this feature, attempting to mount a `.chd` path returns an
`Unsupported` error; raw images and COW overlays continue to work as
before.

The CHD backend (`libchdman-rs` >= 0.288.8) and the MAME CHD core it vendors
are BSD-3-Clause licensed, so enabling this feature keeps IRIS fully
BSD-3-Clause (see `LICENSE-libchdman-rs.txt`).

See [HELP.md](HELP.md) for the full rundown: serial ports, monitor console,
NVRAM/MAC address setup, disk image prep, and more.

Expand Down Expand Up @@ -427,7 +431,12 @@ first. It'll save you a few days.

## License

BSD 3-Clause
BSD 3-Clause (`LICENSE`).

The optional `--features chd` build links `libchdman-rs` (>= 0.288.8), which —
along with the MAME CHD core it vendors — is also BSD 3-Clause, so CHD builds
stay fully BSD 3-Clause. See `LICENSE-libchdman-rs.txt` for that third-party
notice.

## Whodunnit?

Expand Down
2 changes: 1 addition & 1 deletion docs/cow-chd-sync-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ only the sync *presentation* differs per frontend.
- How MAME does writable CHDs (the model we follow): compressed CHD → read-only,
writes go to an uncompressed differencing CHD (`.dif`) with the original as
parent; never auto-merged. Uncompressed CHD → in place.
- `libchdman-rs` (pinned `0.287.0-l7`, `prebuilt`) already provides everything
- `libchdman-rs` (pinned `0.288.8`, `prebuilt`) already provides everything
in-process (no shelling to `chdman`):
- `HdImage::open(path)` — writable in place; **succeeds only for uncompressed**.
- `HdImage::open_with_diff(parent, diff)` — open parent read-only, create an
Expand Down
4 changes: 2 additions & 2 deletions docs/pcap-release-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ release-wiring work to completion.

The build-pipeline files exist **only** on the fork's `main` branch:
`release.yml`, `appstore.yml`, `sync-upstream.yml`, and vendored build-only files
(e.g. `LICENSE-GPL3.txt`). They are **not** on `add-pcap-builds` and we must
(e.g. the generated `COMBINED-LICENSE.txt`). They are **not** on `add-pcap-builds` and we must
**not** merge `origin/main` to pull them in.

Work therefore splits by file type:
Expand Down Expand Up @@ -218,7 +218,7 @@ can verify locally (build/logic); 🧪 = needs your hands-on test on that OS.

## Licensing summary (clean except Windows-Npcap)

- IRIS core: **BSD-3-Clause** (`LICENSE`; `LICENSE-GPL3.txt` is for the CHD path, orthogonal).
- IRIS core: **BSD-3-Clause** (`LICENSE`). The CHD path (`libchdman-rs` >= 0.288.8 and the MAME CHD core it vendors) is also **BSD-3-Clause** — see `LICENSE-libchdman-rs.txt`. (Earlier `0.287.0-l7` builds were GPL-3.0 via `LICENSE-GPL3.txt`; no longer required.)
- `pcap` crate: **MIT OR Apache-2.0**.
- libpcap (Linux/macOS): **BSD-3-Clause** — bundle in AppImage / depend in deb/rpm; ships in macOS.
- Windows **Npcap**: proprietary, **redistribution forbidden** — never bundle; user installs it.
Expand Down
19 changes: 18 additions & 1 deletion installer/iris-gui.iss
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,24 @@
#define AssetsDir "..\iris-gui\assets\icons"
#endif

; Combined BSD-3 + GPL-3 license file (generated by CI, or pass manually).
; Combined license file (generated by CI, or pass manually). IRIS and the CHD
; backend are both BSD-3-Clause as of libchdman-rs 0.288.8.
#ifndef LicenseFile
#define LicenseFile "..\COMBINED-LICENSE.txt"
#endif

; Target architecture of the bundled iris-gui.exe. CI passes /DTargetArch=x64 or
; /DTargetArch=arm64; the installer then refuses to run on the wrong arch (the
; payload is arch-specific). Maps to the Inno Setup architecture identifiers.
#ifndef TargetArch
#define TargetArch "x64"
#endif
#if TargetArch == "arm64"
#define ArchIdentifier "arm64"
#else
#define ArchIdentifier "x64compatible"
#endif

#define MyAppName "IRIS"
#define MyAppPublisher "Dani Sarfati"
#define MyAppURL "https://github.com/danifunker/iris"
Expand All @@ -40,6 +53,10 @@ AppPublisherURL={#MyAppURL}
AppSupportURL={#MyAppURL}
AppUpdatesURL={#MyAppURL}/releases
LicenseFile={#LicenseFile}
; Restrict to the arch of the bundled binary (x64compatible covers x64 hosts and
; x64-on-arm64 emulation; arm64 is native ARM64). 64-bit install mode either way.
ArchitecturesAllowed={#ArchIdentifier}
ArchitecturesInstallIn64BitMode={#ArchIdentifier}
PrivilegesRequired=lowest
PrivilegesRequiredOverridesAllowed=dialog
; Use the "auto" Program Files constant so the destination follows the install
Expand Down
23 changes: 9 additions & 14 deletions iris-gui/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1423,7 +1423,7 @@ impl App {
ui.separator();
ui.label(RichText::new("Legal").strong());
if ui.button("Licenses…")
.on_hover_text("BSD 3-Clause (IRIS) — plus GPL-3.0 for the CHD backend when built in")
.on_hover_text("BSD 3-Clause (IRIS, and the CHD backend when built in)")
.clicked()
{
self.show_license = true;
Expand Down Expand Up @@ -2443,10 +2443,10 @@ impl App {
/// Paths are relative to this source file (`iris-gui/src/main.rs`).
fn license_window(&mut self, ctx: &egui::Context) {
const LICENSE_BSD: &str = include_str!("../../LICENSE");
// The CHD backend (libchdman-rs) is GPL-3.0, so any CHD build is conveyed
// under GPL-3.0 — mirrors the release pipeline shipping LICENSE-GPL3.txt
// alongside LICENSE. Shown only when CHD support is actually built in.
const LICENSE_GPL3: &str = include_str!("../../LICENSE-GPL3.txt");
// The CHD backend (libchdman-rs >= 0.288.8) is BSD-3-Clause, as is the
// MAME CHD core it vendors, so a CHD build stays fully BSD-3-Clause.
// Shown only when CHD support is actually built in.
const LICENSE_CHD: &str = include_str!("../../LICENSE-libchdman-rs.txt");
if !self.show_license { return; }
let chd = iris::build_features::CHD;
let mut open = true;
Expand All @@ -2461,8 +2461,8 @@ impl App {
if chd {
ui.label(
"This build includes CHD disk support via libchdman-rs, which is licensed \
under the GNU GPL-3.0 — so the combined binary is conveyed under GPL-3.0. \
Both licenses apply and are shown below.");
under the BSD 3-Clause License (as is the MAME CHD core it vendors), so \
the whole binary stays BSD 3-Clause. Its notice is shown below.");
}
ui.add_space(4.0);
ui.horizontal(|ui| {
Expand All @@ -2481,14 +2481,9 @@ impl App {
if chd {
ui.add_space(12.0);
ui.separator();
ui.label(RichText::new("CHD backend (libchdman-rs) — GNU GPL-3.0").strong());
ui.horizontal(|ui| {
ui.label("Full text also at");
ui.hyperlink_to("gnu.org/licenses/gpl-3.0",
"https://www.gnu.org/licenses/gpl-3.0.html");
});
ui.label(RichText::new("CHD backend (libchdman-rs) — BSD 3-Clause").strong());
ui.add_space(2.0);
ui.label(RichText::new(LICENSE_GPL3).monospace());
ui.label(RichText::new(LICENSE_CHD).monospace());
}
});
});
Expand Down
2 changes: 1 addition & 1 deletion src/ci.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ pub fn start_server(
start_tcp_server(server.clone(), &path)?;
} else {
#[cfg(unix)]
start_unix_server(server, &path)?;
start_unix_server(server.clone(), &path)?;
#[cfg(not(unix))]
return Err(format!(
"CI socket path {} requires a Unix domain socket; use host:port on this platform",
Expand Down
2 changes: 2 additions & 0 deletions src/ultra64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ use std::sync::atomic::{AtomicBool, Ordering};
use std::thread::JoinHandle;
use shared_memory::ShmemConf;
use raw_sync::{events::{Event, EventImpl, EventInit, EventState}, Timeout};
// Only used for the POSIX `shm_unlink` stale-cleanup below (itself `cfg(unix)`).
// Windows shared memory is OS-refcounted and released when handles close.
#[cfg(unix)]
use libc;

Expand Down
Loading