honker 0.1.2 → 0.3.0

data/ext/honker/honker-core/src/shm_watcher.rs

@@ -0,0 +1,250 @@
+//! Optional `-shm` fast path (feature = `shm-fast-path`).
+//!
+//! **Experimental.** Weaker correctness contract than the polling
+//! backend, in exchange for sub-millisecond wake latency.
+//!
+//! # Contract
+//!
+//! `on_change()` fires when the `iChange` counter at byte offset 8 of
+//! the WAL index header (`-shm` file) advances. **There is no `PRAGMA
+//! data_version` verification, no safety-net poll, no inode re-mmap.**
+//! This means:
+//!
+//! - **WAL mode required.** No `-shm` exists in DELETE/TRUNCATE/
+//!   PERSIST modes. If the file isn't present at startup the backend
+//!   logs to stderr and exits — no wakes ever fire.
+//!
+//! - **Trusts the on-disk shm layout.** Reads `iChange` at a fixed
+//!   offset and assumes it tracks `PRAGMA data_version`. Verified by
+//!   the equivalence test (`shm_fast_path_equivalence_with_pragma_baseline`)
+//!   on every supported SQLite version. If a future SQLite version
+//!   changes the layout, this breaks silently.
+//!
+//! - **WAL reset / db replacement: watcher death.** If `-shm` or the db
+//!   file is deleted and recreated mid-flight (cross-process close+reopen,
+//!   atomic rename, litestream restore), the watcher panics with a
+//!   "Restart required" message. Same dead-man's-switch shape as the
+//!   polling backend — louder failure than silent missed wakes. The file
+//!   is read with bounded positional reads instead of mmap so SQLite file
+//!   churn cannot SIGBUS the host process.
+//!
+//! Tests assert that wakes fire with sub-millisecond latency in WAL
+//! mode. If a test fails, the backend is broken — not "fall back to
+//! polling and pretend it worked".
+
+use crate::stat_identity;
+use rusqlite::{Connection, OpenFlags};
+use std::fs::File;
+use std::io::{Read, Seek, SeekFrom};
+use std::path::PathBuf;
+use std::sync::Arc;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::time::{Duration, Instant};
+
+const WALINDEX_MAX_VERSION: u32 = 3_007_000;
+const ICHANGE_OFFSET: usize = 8;
+/// Same cadence as the polling backend. Shm reads are nearly free; the
+/// win over polling is "PRAGMA -> memory load" (~3.5 us -> ns), not
+/// "1 ms -> 100 us". Going faster would just burn extra sleep syscalls
+/// for latency nobody can perceive.
+const POLL_INTERVAL_MS: u64 = 1;
+/// Cadence for the dead-man's switch (db / -shm replacement detection).
+/// Same wall-clock interval as the polling and kernel backends. Tracked
+/// via Instant — tick counting drifts on Windows where 1 ms sleeps round
+/// up to ~15 ms.
+const IDENTITY_CHECK_INTERVAL: Duration = Duration::from_millis(100);
+
+pub(crate) fn run_shm_fast_path_loop<F>(
+    db_path: PathBuf,
+    on_change: F,
+    stop: Arc<AtomicBool>,
+    ready: std::sync::mpsc::SyncSender<()>,
+) where
+    F: Fn() + Send + 'static,
+{
+    if cfg!(target_endian = "big") {
+        eprintln!("honker: shm-fast-path requires little-endian platform. Backend disabled.");
+        return;
+    }
+    let shm_path = PathBuf::from(format!("{}-shm", db_path.display()));
+    // Keep a quiet SQLite read connection open for the lifetime of the
+    // watcher so normal cross-process open/close churn does not reap or
+    // truncate the WAL-index file underneath the fast path. Do not apply
+    // the default PRAGMAs here: the application connection already set
+    // WAL mode before the watcher is opened, and this connection should
+    // not participate in journal-mode setup or checkpoints.
+    let _keeper = match Connection::open_with_flags(
+        &db_path,
+        OpenFlags::SQLITE_OPEN_READ_ONLY | OpenFlags::SQLITE_OPEN_NO_MUTEX,
+    ) {
+        Ok(conn) => Some(conn),
+        Err(e) => {
+            eprintln!("honker: shm-fast-path keeper connection failed: {e}");
+            None
+        }
+    };
+    let (mut f, header, mut initial_shm_id) = match wait_for_initial_shm_header(&shm_path, &stop) {
+        Some(parts) => parts,
+        None => {
+            let _ = ready.send(());
+            return;
+        }
+    };
+    // Sanity: WAL index version we know how to read. A future SQLite
+    // that bumps this fails the check instead of reading garbage.
+    let iversion = u32::from_ne_bytes(header[0..4].try_into().unwrap());
+    if iversion != WALINDEX_MAX_VERSION {
+        eprintln!(
+            "honker: shm-fast-path disabled: WAL index version {iversion} != {WALINDEX_MAX_VERSION}."
+        );
+        return;
+    }
+
+    let mut last = read_ichange_from_header(&header);
+
+    // Dead-man's switch: snapshot db + -shm inodes; panic on change.
+    // Without this the mmap silently sits on a dead -shm inode.
+    let initial_db_id = match stat_identity(&db_path) {
+        Ok(id) => id,
+        Err(e) => {
+            eprintln!("honker: failed to stat database for identity check: {e}");
+            (0, 0)
+        }
+    };
+    let mut next_identity_check = Instant::now() + IDENTITY_CHECK_INTERVAL;
+    // Baseline captured; signal the spawner that it's safe to return.
+    let _ = ready.send(());
+    drop(ready);
+
+    while !stop.load(Ordering::Acquire) {
+        std::thread::sleep(Duration::from_millis(POLL_INTERVAL_MS));
+        let current = match read_wal_index_header(&mut f) {
+            Ok(header) => read_ichange_from_header(&header),
+            Err(e) => {
+                if let Some((new_file, new_header, new_id)) = reopen_shm_header(&shm_path) {
+                    f = new_file;
+                    initial_shm_id = new_id;
+                    last = read_ichange_from_header(&new_header);
+                    on_change();
+                    continue;
+                }
+                eprintln!("honker: shm-fast-path read failed: {e}");
+                on_change();
+                std::thread::sleep(Duration::from_millis(10));
+                continue;
+            }
+        };
+        if current != last {
+            last = current;
+            on_change();
+        }
+        let now = Instant::now();
+        if now >= next_identity_check {
+            next_identity_check = now + IDENTITY_CHECK_INTERVAL;
+            let db_stat_err = check_db_identity(&db_path, initial_db_id);
+            match stat_identity(&shm_path) {
+                Ok(current_id) if current_id != initial_shm_id => {
+                    if let Some((new_file, new_header, new_id)) = reopen_shm_header(&shm_path) {
+                        f = new_file;
+                        initial_shm_id = new_id;
+                        last = read_ichange_from_header(&new_header);
+                    }
+                    on_change();
+                }
+                Ok(_) => {}
+                Err(e) => {
+                    eprintln!("honker: stat identity check failed for -shm file: {e}");
+                    on_change();
+                }
+            }
+            if db_stat_err {
+                on_change();
+            }
+        }
+    }
+}
+
+fn read_wal_index_header(file: &mut File) -> std::io::Result<[u8; 12]> {
+    let mut header = [0_u8; 12];
+    file.seek(SeekFrom::Start(0))?;
+    file.read_exact(&mut header)?;
+    Ok(header)
+}
+
+fn read_ichange_from_header(header: &[u8; 12]) -> u32 {
+    u32::from_ne_bytes(
+        header[ICHANGE_OFFSET..ICHANGE_OFFSET + 4]
+            .try_into()
+            .unwrap(),
+    )
+}
+
+fn reopen_shm_header(path: &std::path::Path) -> Option<(File, [u8; 12], (u64, u64))> {
+    let mut file = File::open(path).ok()?;
+    let header = read_wal_index_header(&mut file).ok()?;
+    let id = stat_identity(path).ok()?;
+    Some((file, header, id))
+}
+
+fn wait_for_initial_shm_header(
+    path: &std::path::Path,
+    stop: &AtomicBool,
+) -> Option<(File, [u8; 12], (u64, u64))> {
+    for _ in 0..200 {
+        if stop.load(Ordering::Acquire) {
+            return None;
+        }
+        if let Some(parts) = reopen_shm_header(path) {
+            return Some(parts);
+        }
+        std::thread::sleep(Duration::from_millis(10));
+    }
+    eprintln!("honker: shm-fast-path disabled: failed to read stable -shm header.");
+    None
+}
+
+/// Panics if the database has been replaced since startup. Returns
+/// `true` on stat error so caller can fire a conservative wake. The
+/// `-shm` file is intentionally not fatal: SQLite can truncate/recreate
+/// it during normal WAL lifecycle churn, and the fast path can recover
+/// by reopening the current file and rebasing `iChange`.
+fn check_db_identity(db_path: &std::path::Path, initial: (u64, u64)) -> bool {
+    match stat_identity(db_path) {
+        Ok(current) => {
+            if current != initial {
+                panic!(
+                    "honker: database file replaced: \
+                     expected (dev={}, ino={}), found (dev={}, ino={}) at {:?}. \
+                     The watcher cannot recover; \
+                     close the Database and reopen with honker.open().",
+                    initial.0, initial.1, current.0, current.1, db_path
+                );
+            }
+            false
+        }
+        Err(e) => {
+            eprintln!("honker: stat identity check failed for database file: {e}");
+            true
+        }
+    }
+}
+
+/// Probe at `honker.open()` so a misconfigured backend errors
+/// immediately instead of silently producing no wakes.
+pub(crate) fn probe(db_path: &std::path::Path) -> Result<(), String> {
+    if cfg!(target_endian = "big") {
+        return Err("shm-fast-path requires little-endian platform".into());
+    }
+    let shm = format!("{}-shm", db_path.display());
+    let mut f = File::open(&shm)
+        .map_err(|e| format!("-shm unavailable ({e}). WAL mode + open connection required."))?;
+    let header =
+        read_wal_index_header(&mut f).map_err(|e| format!("-shm too small or unreadable: {e}"))?;
+    let iv = u32::from_ne_bytes(header[0..4].try_into().unwrap());
+    if iv != WALINDEX_MAX_VERSION {
+        return Err(format!(
+            "WAL index version {iv} != {WALINDEX_MAX_VERSION} (unsupported SQLite layout)"
+        ));
+    }
+    Ok(())
+}

data/ext/honker/honker-extension/Cargo.toml

@@ -0,0 +1,36 @@
+[package]
+name = "honker-extension"
+version = "0.2.3"
+edition = "2024"
+description = "SQLite loadable extension for Honker. Adds honker_* SQL functions (queues, streams, scheduler, pub/sub) to any SQLite client."
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/russellromney/honker"
+homepage = "https://honker.dev"
+readme = "README.md"
+keywords = ["sqlite", "queue", "pubsub", "notify", "honker"]
+categories = ["database", "concurrency"]
+
+# Output file is `libhonker_ext.dylib` / `.so`. Users load with:
+#     SELECT load_extension('/path/to/libhonker_ext');
+# The crate name differs from the PyO3 `honker` cdylib because both
+# would otherwise try to write `target/release/libhonker.dylib` and
+# clobber each other.
+[lib]
+name = "honker_ext"
+crate-type = ["cdylib"]
+
+[dependencies]
+# Using both `path` and `version` lets Cargo publish this crate to
+# crates.io referencing the real honker-core = "0.2" while still
+# using the in-tree source for local builds.
+honker-core = { path = "../honker-core", version = "0.2.3", default-features = false }
+# "loadable_extension" feature makes rusqlite usable from inside a
+# sqlite3_extension_init entry point.
+rusqlite = { version = "0.39.0", features = ["functions", "hooks", "loadable_extension"] }
+
+[features]
+default = []
+kernel-watcher = ["honker-core/kernel-watcher"]
+shm-fast-path = ["honker-core/shm-fast-path"]
+
+[workspace]

data/ext/honker/honker-extension/LICENSE

@@ -0,0 +1,6 @@
+Honker is licensed under either of:
+
+* Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
+* MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
+
+at your option.

data/ext/honker/honker-extension/LICENSE-APACHE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/ext/honker/honker-extension/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Russell Romney
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/ext/honker/honker-extension/README.md

@@ -0,0 +1,41 @@
+# honker-extension
+
+SQLite loadable extension for [Honker](https://honker.dev). Adds every `honker_*` SQL scalar function (queues, streams, scheduler, pub/sub, rate limits, locks, results) to any SQLite 3.9+ client.
+
+## Install
+
+From crates.io (builds `libhonker_ext.dylib` / `.so` for your platform):
+
+```bash
+cargo install honker-extension
+# or build from source:
+cargo build --release -p honker-extension
+# → target/release/libhonker_ext.{dylib,so}
+```
+
+Prebuilt binaries per platform are available at [GitHub releases](https://github.com/russellromney/honker/releases/latest).
+
+## Use
+
+```sql
+.load ./libhonker_ext
+SELECT honker_bootstrap();
+
+-- Queues
+SELECT honker_enqueue('emails', '{"to":"alice"}', NULL, NULL, 0, 3, NULL);
+SELECT honker_claim_batch('emails', 'worker-1', 32, 300);
+SELECT honker_ack_batch('[1,2,3]', 'worker-1');
+
+-- Streams (durable pub/sub)
+SELECT honker_stream_publish('orders', 'k', '{"id":42}');
+SELECT honker_stream_read_since('orders', 0, 1000);
+
+-- pg_notify-style pub/sub
+SELECT notify('orders', '{"id":42}');
+```
+
+Full SQL reference: [honker.dev/reference/extension](https://honker.dev/reference/extension/).
+
+## License
+
+Apache-2.0.