zerodds-c-api 1.0.0-rc.1

ZeroDDS C-FFI: extern "C" runtime hub for C++/C#/TypeScript bindings + Apex.AI plugin + ROS-2 RMW
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 ZeroDDS Contributors

//! ZeroDDS C-FFI — Cross-Language-Hub.
//!
//! Crate `zerodds-c-api`. Safety classification: **STANDARD**.
//!
//! Diese Crate exportiert eine `extern "C"` Schicht ueber die ZeroDDS-
//! DCPS-Runtime, sodass Nicht-Rust-Sprachen (C++, C#, TypeScript, C)
//! ueber einen einheitlichen Binary-Interface auf ZeroDDS zugreifen.
//!
//! Die generierte `include/zerodds.h` (via cbindgen build-script) ist
//! das Vertragsdokument fuer alle Konsumenten.
//!
//! # Type-Modell — bewusst untyped
//!
//! Das C-FFI ist **byte-orientiert**: ein `Topic` traegt einen
//! `topic_name` + `type_name`-String, ein `write` nimmt einen
//! `(*const u8, len)`-Buffer mit der bereits CDR-encodeten Sample-Bytes,
//! ein `take` liefert die rohen Wire-Bytes. Die CDR-Encode/Decode-Logik
//! lebt in den Sprach-Bindings (idl-cpp emittiert C++-Encoder, idl-csharp
//! C#-Encoder, etc.) — das C-FFI ist neutral.
//!
//! Vorteile:
//! * Keine Generic-Type-Akrobatik durch FFI.
//! * Wire-Drift-Tests sind transparent: jeder Bytes-Buffer geht 1:1.
//! * Apex.AI-Plugin und ROS-2-RMW koennen ihre eigenen Marshaling-Pfade
//!   beibehalten.
//!
//! # Handle-Modell
//!
//! Alle Objekte sind als opaque-Pointer exponiert. Caller muessen
//! `*_destroy()` paaren. Memory-Ownership ist explizit:
//! * `zerodds_runtime_create()` -> Caller besitzt; `zerodds_runtime_destroy()`.
//! * `zerodds_writer_create()` -> Caller besitzt; muss vor Runtime-destroy.
//! * `zerodds_reader_take()` -> die `out_buf`-Bytes muessen mit
//!   `zerodds_buffer_free()` freigegeben werden.
//!
//! # Was NICHT durch das C-FFI geht
//!
//! * Java + Python — eigene Bruecken (jni-rs / pyo3). Direkter
//!   Rust↔Sprache-Pfad ohne C-Zwischenschicht.
//! * QoS-Builder mit komplexen Default-Logiken — vereinfachte Knobs
//!   im FFI; vollstaendige QoS-Kontrolle nur ueber Rust-API.

#![warn(missing_docs)]
// FFI-Modul braucht `unsafe`-Code, daher kein `#![deny(unsafe_code)]`.
// Stattdessen pro `unsafe`-Block ein SAFETY-Kommentar.
#![allow(clippy::missing_safety_doc)]
// FFI-Boundary: Pointer-Args sind by design Caller-Pflicht; interne
// Helper-Funktionen die `*mut`-Args nehmen sind als `pub fn` ausgelegt
// (nicht `unsafe fn`) damit ihre Aufrufer aus FFI-Funktionen sie ohne
// Re-Wrapping in `unsafe`-Bloecke nutzen koennen — der `unsafe`-Block
// liegt am FFI-extern-Funktions-Niveau.
#![allow(clippy::not_unsafe_ptr_arg_deref)]
// Listener-Callback-Pfad nutzt `cb.unwrap()` nach `cb.is_some()`-Check.
#![allow(clippy::unwrap_used)]
// Manche QoS-Field-Assignments folgen Builder-Pattern statt struct-init.
#![allow(clippy::field_reassign_with_default)]
// Lifetime-elision in `unsafe fn cstr_to_str<'a>` ist an der FFI-Kante
// notwendig fuer borrow-Lifetimes des Caller-Strings.
#![allow(clippy::needless_lifetimes)]
// Pub-Fields in opaque-FFI-Wrapper-Strukturen sind dokumentiert auf
// Struktur-Ebene; pro-Field-Doc ist redundant.
#![allow(missing_docs)]
// QoS-Policies wie DeadlineQosPolicy implementieren Copy, sind aber in
// generischen `Clone`-basierten Foreach-Patterns konsistenter mit
// `.clone()` zu lesen.
#![allow(clippy::clone_on_copy)]
// `arr.lock().map(|g| g.clone()).unwrap_or_default()` ist klarer als
// `.map_or_else(Default::default, |g| g.clone())`.
#![allow(clippy::map_unwrap_or)]

extern crate alloc;

pub mod builtin_ffi;
pub mod condition_ffi;
pub mod entities;
pub mod extra_ffi;
pub mod factory_ffi;
pub mod listener_ffi;
pub mod participant_ffi;
pub mod publisher_ffi;
pub mod qos_ffi;
pub mod subscriber_ffi;
pub mod topic_ffi;

/// XCDR2 TypeSupport-FFI — implementiert `zerodds-xcdr2-c-1.0` Vendor-Spec.
pub mod xcdr2;

use core::ffi::{c_char, c_int};
use core::ptr;
use core::slice;
use std::ffi::CStr;
use std::sync::{Arc, Mutex, mpsc};
use std::time::Duration;

use zerodds_dcps::runtime::{DcpsRuntime, RuntimeConfig, UserReaderConfig, UserWriterConfig};
use zerodds_qos::{
    DeadlineQosPolicy, DurabilityKind, LifespanQosPolicy, LivelinessKind, LivelinessQosPolicy,
    OwnershipKind,
};
use zerodds_rtps::wire_types::{EntityId, GuidPrefix};

pub(crate) fn random_guid_prefix() -> GuidPrefix {
    use std::sync::atomic::{AtomicU32, Ordering};
    static COUNTER: AtomicU32 = AtomicU32::new(0);
    let pid = std::process::id();
    let t = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_nanos() as u64)
        .unwrap_or(0);
    let c = COUNTER.fetch_add(1, Ordering::Relaxed);
    let mut bytes = [0u8; 12];
    bytes[0..4].copy_from_slice(&pid.to_le_bytes());
    bytes[4..12].copy_from_slice(&(t.wrapping_add(u64::from(c))).to_le_bytes());
    GuidPrefix::from_bytes(bytes)
}

// ============================================================================
// Status-Codes
// ============================================================================

/// FFI-Statuscodes. 0 = OK, negative Werte = Fehler.
#[repr(i32)]
#[derive(Debug, Clone, Copy)]
pub enum ZeroDdsStatus {
    /// Operation erfolgreich.
    Ok = 0,
    /// Generischer Fehler (Details in `zerodds_last_error()`).
    Error = -1,
    /// NULL-Pointer wo nicht erlaubt.
    BadHandle = -2,
    /// Ungültiger UTF-8-String.
    InvalidUtf8 = -3,
    /// Operation blockierte und Timeout lief ab.
    Timeout = -4,
    /// Pre-Condition nicht erfüllt (z.B. Reader/Writer schon zerstört).
    PreconditionNotMet = -5,
    /// Ungueltiger Parameter-Wert (z.B. len=0, negative size).
    BadParameter = -6,
    /// Operation lieferte keine Daten (z.B. take() auf leerem Reader).
    NoData = -7,
    /// Resource-Limit erreicht.
    OutOfResources = -8,
    /// Entity nicht enabled.
    NotEnabled = -9,
    /// QoS-Policy ist immutable.
    ImmutablePolicy = -10,
    /// QoS-Policies inkonsistent.
    InconsistentPolicy = -11,
    /// Entity bereits geloescht.
    AlreadyDeleted = -12,
    /// Operation nicht unterstuetzt (Profile/Stretch-Goals).
    Unsupported = -13,
    /// Aufruf in inkompatiblem Kontext.
    IllegalOperation = -14,
}

// ============================================================================
// Opaque handles
// ============================================================================

/// Opaque Runtime-Handle. Hält die DcpsRuntime + spawned threads.
pub struct ZeroDdsRuntime {
    rt: Arc<DcpsRuntime>,
    /// Track Spawned Worker-Thread(s) für sauberes Shutdown.
    _shutdown: (),
}

/// Opaque Writer-Handle.
pub struct ZeroDdsWriter {
    rt: Arc<DcpsRuntime>,
    eid: EntityId,
}

/// Opaque Reader-Handle.
pub struct ZeroDdsReader {
    rt: Arc<DcpsRuntime>,
    eid: EntityId,
    rx: Mutex<mpsc::Receiver<zerodds_dcps::runtime::UserSample>>,
}

// ============================================================================
// Lifecycle — Runtime
// ============================================================================

/// Erzeugt eine neue ZeroDDS-Runtime auf der gegebenen Domain-ID.
///
/// # Safety
/// Der Rückgabewert ist ein Heap-allokierter Pointer; der Aufrufer muss
/// ihn mit `zerodds_runtime_destroy` freigeben.
///
/// Liefert `NULL` bei Fehler.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_runtime_create(domain_id: u32) -> *mut ZeroDdsRuntime {
    let cfg = RuntimeConfig::default();
    let rt = match DcpsRuntime::start(domain_id as i32, random_guid_prefix(), cfg) {
        Ok(r) => r,
        Err(_) => return ptr::null_mut(),
    };
    // `DcpsRuntime::start` liefert bereits ein `Arc<DcpsRuntime>` zurueck.
    let handle = Box::new(ZeroDdsRuntime { rt, _shutdown: () });
    Box::into_raw(handle)
}

/// Zerstört eine Runtime. NULL-safe.
///
/// # Safety
/// `runtime` muss aus `zerodds_runtime_create` stammen oder NULL sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_runtime_destroy(runtime: *mut ZeroDdsRuntime) {
    if runtime.is_null() {
        return;
    }
    // SAFETY: `runtime` ist ein Box<ZeroDdsRuntime>-Pointer aus `Box::into_raw`.
    let _ = unsafe { Box::from_raw(runtime) };
}

/// Wartet bis SPDP mindestens `min_count` Remote-Participants entdeckt
/// hat. Returnt 0 (Ok) bei Erfolg, -4 (Timeout) wenn die Zahl in
/// `timeout_ms` nicht erreicht wird.
///
/// **Optional, nicht zwingend.** SEDP ist reliable + behaelt History,
/// also wird ein zu frueh registrierter Endpoint sich nach 600-720 ms
/// (empirisch llvm-Linux) selbst heilen sobald SPDP den Peer sieht
/// und der Heartbeat-Replay durchlaeuft. Dieser Helper ist nuetzlich
/// wenn man deterministisches Test-Setup will oder einen langen
/// Publish-Loop vermeiden moechte.
///
/// # Safety
/// `runtime` muss aus `zerodds_runtime_create` stammen oder NULL sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_runtime_wait_for_peers(
    runtime: *mut ZeroDdsRuntime,
    min_count: c_int,
    timeout_ms: u64,
) -> c_int {
    if runtime.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: NULL-Check oben.
    let r = unsafe { &*runtime };
    let deadline = std::time::Instant::now() + Duration::from_millis(timeout_ms);
    loop {
        let n = r.rt.discovered_participants().len();
        if (n as c_int) >= min_count {
            return ZeroDdsStatus::Ok as c_int;
        }
        if std::time::Instant::now() >= deadline {
            return ZeroDdsStatus::Timeout as c_int;
        }
        std::thread::sleep(Duration::from_millis(50));
    }
}

// ============================================================================
// Writer
// ============================================================================

/// Erzeugt einen DataWriter auf einem Topic. Topic + Type werden by-name
/// identifiziert (DDS-Spec §2.2.2).
///
/// # Safety
/// `runtime` muss valide sein. `topic_name` und `type_name` müssen
/// NUL-terminierte UTF-8-Strings sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_create(
    runtime: *mut ZeroDdsRuntime,
    topic_name: *const c_char,
    type_name: *const c_char,
    reliable: c_int,
) -> *mut ZeroDdsWriter {
    if runtime.is_null() || topic_name.is_null() || type_name.is_null() {
        return ptr::null_mut();
    }
    // SAFETY: NULL-Check oben; CStr setzt UTF-8-Validität voraus, wir
    // returnen `null_mut` bei InvalidUtf8.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let rt = unsafe { &*runtime };
    // SAFETY: topic_name NULL-checked oben; caller-Kontrakt verlangt
    // NUL-terminierten C-String.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let topic = match unsafe { CStr::from_ptr(topic_name) }.to_str() {
        Ok(s) => s.to_string(),
        Err(_) => return ptr::null_mut(),
    };
    // SAFETY: type_name NULL-checked oben; caller-Kontrakt verlangt
    // NUL-terminierten C-String.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let typ = match unsafe { CStr::from_ptr(type_name) }.to_str() {
        Ok(s) => s.to_string(),
        Err(_) => return ptr::null_mut(),
    };

    let cfg = UserWriterConfig {
        topic_name: topic,
        type_name: typ,
        reliable: reliable != 0,
        durability: DurabilityKind::Volatile,
        deadline: DeadlineQosPolicy::default(),
        lifespan: LifespanQosPolicy::default(),
        liveliness: LivelinessQosPolicy {
            kind: LivelinessKind::Automatic,
            ..Default::default()
        },
        ownership: OwnershipKind::Shared,
        ownership_strength: 0,
        partition: Vec::new(),
        user_data: Vec::new(),
        topic_data: Vec::new(),
        group_data: Vec::new(),
        // F-TYPES-3: C-FFI ist byte-orientiert (kein typed Topic-Type),
        // also kein TypeIdentifier verfügbar.
        type_identifier: zerodds_types::TypeIdentifier::None,
        data_representation_offer: None,
    };
    let eid = match rt.rt.register_user_writer(cfg) {
        Ok(e) => e,
        Err(_) => return ptr::null_mut(),
    };
    Box::into_raw(Box::new(ZeroDdsWriter {
        rt: rt.rt.clone(),
        eid,
    }))
}

/// Schreibt einen Sample. `payload` zeigt auf bereits-CDR-encodete Bytes.
///
/// # Safety
/// `writer` und `payload` muessen valide sein, `len` <= Buffergröße.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_write(
    writer: *mut ZeroDdsWriter,
    payload: *const u8,
    len: usize,
) -> c_int {
    if writer.is_null() || (payload.is_null() && len > 0) {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: NULL-Check; len bezieht sich auf den Caller-Buffer.
    let w = unsafe { &*writer };
    let bytes = if len == 0 {
        Vec::new()
    } else {
        // SAFETY: payload + len kommen aus dem Caller; oben NULL/0-checked.
        // pub unsafe fn # Safety verlangt valide [u8;len]-Provenance.
        // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
        unsafe { slice::from_raw_parts(payload, len) }.to_vec()
    };
    match w.rt.write_user_sample(w.eid, bytes) {
        Ok(()) => ZeroDdsStatus::Ok as c_int,
        Err(_) => ZeroDdsStatus::Error as c_int,
    }
}

/// Wartet bis mindestens `min_count` Subscriptions gematcht haben oder
/// Timeout abläuft. `timeout_ms` = 0 -> non-blocking poll.
///
/// # Safety
/// `writer` muss valide sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_wait_for_matched(
    writer: *mut ZeroDdsWriter,
    min_count: c_int,
    timeout_ms: u64,
) -> c_int {
    if writer.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: NULL-Check.
    let w = unsafe { &*writer };
    let deadline = std::time::Instant::now() + Duration::from_millis(timeout_ms);
    loop {
        let n = w.rt.user_writer_matched_count(w.eid);
        if (n as c_int) >= min_count {
            return ZeroDdsStatus::Ok as c_int;
        }
        if std::time::Instant::now() >= deadline {
            return ZeroDdsStatus::Timeout as c_int;
        }
        std::thread::sleep(Duration::from_millis(10));
    }
}

/// Sendet einen Lifecycle-Marker (Spec §9.6.3.9 PID_STATUS_INFO):
/// `dispose` setzt das DISPOSED-Bit, sodass Remote-Reader die Instanz
/// als NotAliveDisposed klassifizieren. Der Caller muss den 16-byte
/// Key-Hash der Instanz uebergeben (PLAIN_CDR2-BE-Encoding mit Zero-
/// Padding bzw. MD5 falls > 16 byte).
///
/// # Safety
/// `writer` und `key_hash` muessen valide sein; `key_hash` muss auf
/// genau 16 byte zeigen.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_dispose(
    writer: *mut ZeroDdsWriter,
    key_hash: *const u8,
) -> c_int {
    if writer.is_null() || key_hash.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: writer NULL-checked oben; pub unsafe fn # Safety verlangt
    // valide ZeroDdsWriter-Box-Provenance.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let w = unsafe { &*writer };
    let mut kh = [0u8; 16];
    // SAFETY: key_hash NULL-checked oben; caller-Kontrakt aus # Safety
    // verlangt 16-byte readability.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    unsafe {
        std::ptr::copy_nonoverlapping(key_hash, kh.as_mut_ptr(), 16);
    }
    match w
        .rt
        .write_user_lifecycle(w.eid, kh, zerodds_rtps::inline_qos::status_info::DISPOSED)
    {
        Ok(()) => ZeroDdsStatus::Ok as c_int,
        Err(_) => ZeroDdsStatus::Error as c_int,
    }
}

/// Sendet einen UNREGISTER-Marker (Spec §2.2.2.4.2.7). Setzt nur das
/// UNREGISTERED-Bit (kein autodispose). Caller, der Spec-Default-
/// Verhalten will (autodispose=true), soll stattdessen
/// `zerodds_writer_unregister_with_dispose` nutzen.
///
/// # Safety
/// Wie [`zerodds_writer_dispose`].
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_unregister(
    writer: *mut ZeroDdsWriter,
    key_hash: *const u8,
) -> c_int {
    if writer.is_null() || key_hash.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: writer NULL-checked; caller-Kontrakt # Safety.
    let w = unsafe { &*writer };
    let mut kh = [0u8; 16];
    // SAFETY: key_hash NULL-checked + 16-byte readability per Caller.
    unsafe {
        std::ptr::copy_nonoverlapping(key_hash, kh.as_mut_ptr(), 16);
    }
    match w.rt.write_user_lifecycle(
        w.eid,
        kh,
        zerodds_rtps::inline_qos::status_info::UNREGISTERED,
    ) {
        Ok(()) => ZeroDdsStatus::Ok as c_int,
        Err(_) => ZeroDdsStatus::Error as c_int,
    }
}

/// Sendet kombinierten DISPOSE+UNREGISTER-Marker (Spec §2.2.3.21 mit
/// `autodispose_unregistered_instances=true`). Reader sieht sowohl
/// NotAliveDisposed als auch NotAliveNoWriters.
///
/// # Safety
/// Wie [`zerodds_writer_dispose`].
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_unregister_with_dispose(
    writer: *mut ZeroDdsWriter,
    key_hash: *const u8,
) -> c_int {
    if writer.is_null() || key_hash.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: writer NULL-checked; caller-Kontrakt # Safety.
    let w = unsafe { &*writer };
    let mut kh = [0u8; 16];
    // SAFETY: key_hash NULL-checked + 16-byte readability per Caller.
    unsafe {
        std::ptr::copy_nonoverlapping(key_hash, kh.as_mut_ptr(), 16);
    }
    let bits = zerodds_rtps::inline_qos::status_info::DISPOSED
        | zerodds_rtps::inline_qos::status_info::UNREGISTERED;
    match w.rt.write_user_lifecycle(w.eid, kh, bits) {
        Ok(()) => ZeroDdsStatus::Ok as c_int,
        Err(_) => ZeroDdsStatus::Error as c_int,
    }
}

/// Zerstört einen Writer. NULL-safe.
///
/// # Safety
/// `writer` muss aus `zerodds_writer_create` stammen oder NULL sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_destroy(writer: *mut ZeroDdsWriter) {
    if writer.is_null() {
        return;
    }
    // SAFETY: Box-Pointer wie aus Box::into_raw.
    let _ = unsafe { Box::from_raw(writer) };
}

// ============================================================================
// Reader
// ============================================================================

/// Erzeugt einen DataReader auf einem Topic.
///
/// # Safety
/// Wie `zerodds_writer_create`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_reader_create(
    runtime: *mut ZeroDdsRuntime,
    topic_name: *const c_char,
    type_name: *const c_char,
    reliable: c_int,
) -> *mut ZeroDdsReader {
    if runtime.is_null() || topic_name.is_null() || type_name.is_null() {
        return ptr::null_mut();
    }
    // SAFETY: runtime NULL-checked; pub unsafe fn # Safety verlangt
    // valide ZeroDdsRuntime-Box-Provenance.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let rt = unsafe { &*runtime };
    // SAFETY: topic_name NULL-checked; caller-Kontrakt: NUL-terminierter
    // C-String.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let topic = match unsafe { CStr::from_ptr(topic_name) }.to_str() {
        Ok(s) => s.to_string(),
        Err(_) => return ptr::null_mut(),
    };
    // SAFETY: type_name NULL-checked oben; caller-Kontrakt aus
    // # Safety verlangt NUL-terminierten C-String.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let typ = match unsafe { CStr::from_ptr(type_name) }.to_str() {
        Ok(s) => s.to_string(),
        Err(_) => return ptr::null_mut(),
    };

    let cfg = UserReaderConfig {
        topic_name: topic,
        type_name: typ,
        reliable: reliable != 0,
        durability: DurabilityKind::Volatile,
        deadline: DeadlineQosPolicy::default(),
        liveliness: LivelinessQosPolicy {
            kind: LivelinessKind::Automatic,
            ..Default::default()
        },
        ownership: OwnershipKind::Shared,
        partition: Vec::new(),
        user_data: Vec::new(),
        topic_data: Vec::new(),
        group_data: Vec::new(),
        // F-TYPES-3: C-FFI ist byte-orientiert.
        type_identifier: zerodds_types::TypeIdentifier::None,
        type_consistency: zerodds_types::qos::TypeConsistencyEnforcement::default(),
        data_representation_offer: None,
    };
    let (eid, rx) = match rt.rt.register_user_reader(cfg) {
        Ok(p) => p,
        Err(_) => return ptr::null_mut(),
    };
    Box::into_raw(Box::new(ZeroDdsReader {
        rt: rt.rt.clone(),
        eid,
        rx: Mutex::new(rx),
    }))
}

/// Versucht einen Sample zu lesen.
/// * Bei Erfolg: schreibt allocierten Buffer in `*out_buf`, dessen
///   Länge in `*out_len`. Caller MUSS `zerodds_buffer_free(*out_buf)`.
/// * Bei keinem Sample: `*out_buf = NULL`, `*out_len = 0`, return Ok.
/// * Bei Fehler: negativer Statuscode.
///
/// # Safety
/// Pointers müssen valide sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_reader_take(
    reader: *mut ZeroDdsReader,
    out_buf: *mut *mut u8,
    out_len: *mut usize,
) -> c_int {
    if reader.is_null() || out_buf.is_null() || out_len.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: NULL-Checks. Reader-Lock geht über Mutex.
    let r = unsafe { &*reader };
    // C-API liefert nur Alive-Samples; Lifecycle-Marker werden hier
    // bewusst verworfen, damit der C-FFI-Konsument unveraenderte Bytes
    // sieht. (Caller-Layer kann das spaeter ueber separate API holen.)
    let bytes = match r.rx.lock() {
        Ok(rx) => loop {
            match rx.try_recv().ok() {
                Some(zerodds_dcps::runtime::UserSample::Alive { payload: b, .. }) => break Some(b),
                Some(zerodds_dcps::runtime::UserSample::Lifecycle { .. }) => continue,
                None => break None,
            }
        },
        Err(_) => {
            // SAFETY: out_buf/out_len NULL-checked oben; caller-Kontrakt
            // verlangt valide *mut-Pointer (siehe pub unsafe fn # Safety).
            // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
            unsafe {
                *out_buf = ptr::null_mut();
                *out_len = 0;
            }
            return ZeroDdsStatus::PreconditionNotMet as c_int;
        }
    };
    match bytes {
        Some(bs) => {
            // Heap-Buffer übergeben — Caller free't via `zerodds_buffer_free`.
            let mut boxed = bs.into_boxed_slice();
            // SAFETY: out_buf/out_len wurden oben NULL-geprueft; boxed
            // bleibt durch Box::into_raw unten alive bis zum Caller-free.
            // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
            unsafe {
                *out_buf = boxed.as_mut_ptr();
                *out_len = boxed.len();
            }
            // Leak — Caller hat jetzt Ownership.
            let _ = Box::into_raw(boxed);
        }
        // SAFETY: NULL-write in vom Caller vorgehaltene out-Pointer.
        None => unsafe {
            *out_buf = ptr::null_mut();
            *out_len = 0;
        },
    }
    ZeroDdsStatus::Ok as c_int
}

/// Wartet bis mindestens `min_count` Publications gematcht haben.
///
/// # Safety
/// `reader` muss valide sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_reader_wait_for_matched(
    reader: *mut ZeroDdsReader,
    min_count: c_int,
    timeout_ms: u64,
) -> c_int {
    if reader.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: reader NULL-checked; pub unsafe fn # Safety verlangt
    // valide ZeroDdsReader-Box-Provenance.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let r = unsafe { &*reader };
    let deadline = std::time::Instant::now() + Duration::from_millis(timeout_ms);
    loop {
        let matched = r.rt.user_reader_matched_count(r.eid) as c_int;
        if matched >= min_count {
            return ZeroDdsStatus::Ok as c_int;
        }
        if std::time::Instant::now() >= deadline {
            return ZeroDdsStatus::Timeout as c_int;
        }
        std::thread::sleep(Duration::from_millis(10));
    }
}

/// Zerstört einen Reader. NULL-safe.
///
/// # Safety
/// Wie `zerodds_writer_destroy`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_reader_destroy(reader: *mut ZeroDdsReader) {
    if reader.is_null() {
        return;
    }
    // Vor Destroy einen ev. registrierten Data-Callback loeschen
    // (sonst wuerde der Recv-Thread mit einem Dangling-Listener
    // weiterfeuern, bis der Reader-Slot aus dem Runtime-Index
    // entfernt wird).
    // SAFETY: reader NULL-checked.
    let r = unsafe { &*reader };
    r.rt.set_user_reader_listener(r.eid, None);
    // SAFETY: reader NULL-checked; pub unsafe fn # Safety verlangt
    // valide Box-Provenance.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    let _ = unsafe { Box::from_raw(reader) };
}

/// Data-Available-Callback fuer Alive-Samples (Latenz-Optimierung).
///
/// Registriert einen synchronen Callback, der vom Recv-Thread des
/// Runtimes direkt nach Sample-Arrival aufgerufen wird. Eliminiert
/// die Polling-Latenz von `zerodds_reader_take()` (~50-100 µs raus).
///
/// `callback = NULL` loescht einen vorhandenen Listener.
///
/// **Vertrag**:
/// * Callback laeuft im Recv-Thread, NICHT im User-Thread.
/// * Kurz und nicht-blockierend.
/// * Keine ZeroDDS-API-Aufrufe rein (Recursion-Risiko).
/// * `payload` zeigt auf den CDR-Payload (ohne Encapsulation-Header).
///   Lifetime nur fuer die Dauer des Callbacks; kopieren wenn ueber
///   den Call hinaus benoetigt.
/// * Disposed-/Unregistered-Lifecycle-Events feuern den Callback
///   NICHT.
///
/// # Safety
/// `reader` muss valider Pointer aus `zerodds_reader_create` sein.
/// `user_data` ist opaque; muss durch User selbst sicher gehalten
/// werden bis der Listener mit NULL geloescht wird.
pub type ZeroDdsDataCallback =
    extern "C" fn(user_data: *mut core::ffi::c_void, payload: *const u8, payload_len: usize);

#[unsafe(no_mangle)]
// SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
pub unsafe extern "C" fn zerodds_reader_set_data_callback(
    reader: *mut ZeroDdsReader,
    callback: Option<ZeroDdsDataCallback>,
    user_data: *mut core::ffi::c_void,
) -> c_int {
    if reader.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: NULL-Check oben.
    let r = unsafe { &*reader };
    let listener: Option<zerodds_dcps::runtime::UserReaderListener> = match callback {
        Some(cb) => {
            // user_data als usize speichern, weil *mut c_void nicht
            // Send ist; im Closure casten wir zurueck. Der Caller
            // muss laut Contract user_data lebendig halten.
            let ud_addr = user_data as usize;
            Some(Box::new(move |bytes: &[u8]| {
                cb(
                    ud_addr as *mut core::ffi::c_void,
                    bytes.as_ptr(),
                    bytes.len(),
                );
            }))
        }
        None => None,
    };
    if r.rt.set_user_reader_listener(r.eid, listener) {
        ZeroDdsStatus::Ok as c_int
    } else {
        ZeroDdsStatus::BadHandle as c_int
    }
}

// ============================================================================
// Buffer-Free (für from-take)
// ============================================================================

/// Gibt einen Buffer frei, den ein vorheriges `zerodds_reader_take`
/// alloziert hat. NULL-safe.
///
/// # Safety
/// `buf` muss aus `zerodds_reader_take` stammen oder NULL sein.
/// `len` muss exakt der zu dem Buffer gehörige Wert sein.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_buffer_free(buf: *mut u8, len: usize) {
    if buf.is_null() || len == 0 {
        return;
    }
    // SAFETY: rebuild the boxed slice von raw + len, dann drop.
    let _ = unsafe { Box::from_raw(slice::from_raw_parts_mut(buf, len)) };
}

// ============================================================================
// Loaning
// ============================================================================
//
// Heap-Backed Loans als Standard-Pfad. Bei aktiviertem SHM-Transport
// (siehe `zerodds-flatdata-1.0` Vendor-Spec) wird der Speicher-Pfad
// intern transparent durch SHM-Buffer-Pool-Lookup ersetzt — die
// FFI-Signaturen bleiben stabil.

/// Reserviert einen Output-Buffer beim Writer fuer Zero-Copy-Publish.
/// Caller schreibt den Sample in den zurueckgegebenen Pointer und
/// commit'd ihn dann via [`zerodds_writer_commit_loan`].
///
/// Returnt 0 (Ok) bei Erfolg + befuellt `*out_ptr` und `*out_len`.
/// Beim heutigen malloc-backed Pfad ist `*out_len = len`; bei
/// SHM-backed Loans kann `*out_len > len` sein (Slot-Boundary).
///
/// # Safety
/// `writer` valid; `out_ptr`/`out_len` non-null.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_loan_message(
    writer: *mut ZeroDdsWriter,
    len: usize,
    out_ptr: *mut *mut u8,
    out_len: *mut usize,
) -> c_int {
    if writer.is_null() || out_ptr.is_null() || out_len.is_null() {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    if len == 0 {
        return ZeroDdsStatus::BadParameter as c_int;
    }
    // Phase-C: heap-allokierter Buffer. Phase-D: SHM-Slot-Lookup.
    let mut v = alloc::vec![0u8; len].into_boxed_slice();
    let ptr = v.as_mut_ptr();
    // Leak — Caller besitzt jetzt das Buffer-Eigentum.
    let _ = Box::into_raw(v);
    // SAFETY: out_ptr/out_len NULL-checked.
    unsafe {
        *out_ptr = ptr;
        *out_len = len;
    }
    ZeroDdsStatus::Ok as c_int
}

/// Commit-Pfad: schreibt den geliehenen Buffer als Sample und gibt
/// ihn frei. Caller darf den Pointer danach nicht mehr lesen.
///
/// # Safety
/// `writer` aus `zerodds_writer_create`; `ptr` aus
/// `zerodds_writer_loan_message`; `len` der gleiche Wert wie in
/// `out_len` zurueckgegeben.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_commit_loan(
    writer: *mut ZeroDdsWriter,
    ptr: *mut u8,
    len: usize,
) -> c_int {
    if writer.is_null() || ptr.is_null() || len == 0 {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: Pass-through zum normalen write; danach Buffer freigeben.
    let rc = unsafe { zerodds_writer_write(writer, ptr, len) };
    // SAFETY: ptr+len stammen aus zerodds_writer_loan_message
    // (Box::into_raw); rebuild + drop ist konform.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    unsafe {
        let _ = Box::from_raw(slice::from_raw_parts_mut(ptr, len));
    }
    rc
}

/// Verwirft einen Loan ohne ihn zu publishen. Buffer wird freigegeben.
///
/// # Safety
/// Wie `zerodds_writer_commit_loan`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn zerodds_writer_discard_loan(
    _writer: *mut ZeroDdsWriter,
    ptr: *mut u8,
    len: usize,
) -> c_int {
    if ptr.is_null() || len == 0 {
        return ZeroDdsStatus::BadHandle as c_int;
    }
    // SAFETY: Buffer aus zerodds_writer_loan_message stammt aus
    // Box::into_raw; rebuild + drop ist konform.
    // SAFETY: FFI-boundary; pointer validity is the caller's contract per crate-level docs.
    unsafe {
        let _ = Box::from_raw(slice::from_raw_parts_mut(ptr, len));
    }
    ZeroDdsStatus::Ok as c_int
}

// ============================================================================
// Version-Info
// ============================================================================

/// Version-String des C-FFI. Statisch, nicht freizugeben.
#[unsafe(no_mangle)]
pub extern "C" fn zerodds_version() -> *const c_char {
    static VERSION: &str = concat!(env!("CARGO_PKG_VERSION"), "\0");
    VERSION.as_ptr() as *const c_char
}