zenrc 0.1.0

High-level DDS publish/subscribe and service framework
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
use std::collections::HashMap;
use std::ffi::CString;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex};
use std::thread;

use zenrc_dds::{dds_attach_t, dds_domainid_t, dds_entity_t, RawMessageBridge, DDS_ANY_STATE};

use crate::dds::service;

use super::error::{check_entity, check_ret, DdsError, Result};
use super::publisher::Publisher;
use super::qos::Qos;
use super::subscriber::Subscription;
use super::topic::Topic;

// ─── 常量 ─────────────────────────────────────────────────────────────────────

/// 让 CycloneDDS 自动选择域 ID(等同于 `DDS_DOMAIN_DEFAULT = UINT32_MAX`)
pub const DOMAIN_DEFAULT: u32 = u32::MAX;

// ─── DomainParticipant ────────────────────────────────────────────────────────

/// DDS 域参与者(Domain Participant),是创建 Publisher 和 Subscription 的工厂。
///
/// 内部使用 [`Arc`] 共享,保证在所有派生对象销毁之前不会删除底层 DDS 实体。
/// 通常通过 [`DdsContext::new`] 隐式创建,可通过 `ctx.participant` 访问。
#[derive(Clone)]
pub struct DomainParticipant {
    entity: dds_entity_t,
}

impl DomainParticipant {
    /// 使用默认 QoS 创建域参与者
    pub fn new(domain_id: u32) -> Result<Self> {
        Self::new_with_qos(domain_id, None)
    }

    /// 使用指定 QoS 创建域参与者
    pub fn new_with_qos(domain_id: u32, qos: Option<&Qos>) -> Result<Self> {
        let qos_ptr = qos.map(|q| q.raw as *const _).unwrap_or(std::ptr::null());
        let entity = unsafe {
            zenrc_dds::dds_create_participant(domain_id as dds_domainid_t, qos_ptr, std::ptr::null())
        };
        let entity = check_entity(entity)?;
        Ok(Self {
            entity
        })
    }

    /// 获取域 ID
    pub fn domain_id(&self) -> Result<u32> {
        let mut id: dds_domainid_t = 0;
        super::error::check_ret(unsafe {
            zenrc_dds::dds_get_domainid(self.entity, &mut id)
        })?;
        Ok(id)
    }

    /// 创建带默认 QoS 的 Topic
    pub fn create_topic<T: RawMessageBridge>(&self, name: &str) -> Result<Topic<T>> {
        self.create_topic_with_qos(name, &Qos::default())
    }

    /// 创建带自定义 QoS 的 Topic
    pub fn create_topic_with_qos<T: RawMessageBridge>(
        &self,
        name: &str,
        qos: &Qos,
    ) -> Result<Topic<T>> {
        let c_name = CString::new(name)?;
        let entity = unsafe {
            zenrc_dds::dds_create_topic(
                self.entity,
                T::descriptor(),
                c_name.as_ptr(),
                qos.raw as *const _,
                std::ptr::null(),
            )
        };
        let entity = check_entity(entity)?;
        Ok(Topic::from_entity(entity))
    }

    /// 创建发布者(自动创建 Topic,不附加到任何 WaitSet)
    pub fn create_publisher<T: RawMessageBridge>(
        &self,
        topic_name: &str,
        qos: Qos,
    ) -> Result<Publisher<T>> {
        let topic = self.create_topic_with_qos::<T>(topic_name, &qos)?;
        let writer = unsafe {
            zenrc_dds::dds_create_writer(
                self.entity,
                topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        };
        let writer = check_entity(writer)?;
        Ok(Publisher::new(writer, topic))
    }

    /// 创建订阅者(自动创建 Topic,不附加到任何 WaitSet)
    pub fn create_subscriber<T: RawMessageBridge>(
        &self,
        topic_name: &str,
        qos: Qos,
    ) -> Result<Subscription<T>> {
        let topic = self.create_topic_with_qos::<T>(topic_name, &qos)?;
        let sub = unsafe {
            zenrc_dds::dds_create_subscriber(
                self.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        };
        let reader = unsafe {
            zenrc_dds::dds_create_reader(
                sub,
                topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        };
        let reader = check_entity(reader)?;
        Ok(Subscription::new(reader, topic))
    }

    /// 返回底层 DDS 参与者实体句柄
    pub fn entity(&self) -> dds_entity_t {
        self.entity
    }

    /// 查找同域内的所有参与者实体
    pub fn lookup_participants(domain_id: u32) -> Result<Vec<dds_entity_t>> {
        const MAX: usize = 64;
        let mut buf = vec![0i32; MAX];
        let ret = unsafe {
            zenrc_dds::dds_lookup_participant(domain_id as dds_domainid_t, buf.as_mut_ptr(), MAX)
        };
        let n = super::error::check_entity(ret)? as usize;
        buf.truncate(n);
        Ok(buf)
    }

}

// ─── 内部常量 ──────────────────────────────────────────────────────────────────

/// 守护条件 attach token,用于唤醒/停止后台线程
const WAKE_TOKEN: dds_attach_t = 0;

/// 每次 dds_waitset_wait 的超时(100 ms),兜底检测 running 标志
const POLL_TIMEOUT_NS: i64 = 100_000_000;

/// WaitSet 单次最大触发条件数
const MAX_TRIGGERS: usize = 64;

// ─── 内部结构 ──────────────────────────────────────────────────────────────────

struct ReaderEntry {
    /// 已附加到 WaitSet 的 ReadCondition 实体句柄
    readcond: dds_entity_t,
    /// 数据到达时唤醒等待方的通知句柄
    notify: Arc<tokio::sync::Notify>,
}



// ─── DdsContext ────────────────────────────────────────────────────────────────

/// DDS 上下文(RAII),包含 [`DomainParticipant`] 和后台 WaitSet 轮询线程。
///
/// 调用 [`DdsContext::new`] 同时创建域参与者和共享 WaitSet。
/// 通过 [`DdsContext::create_subscriber`] 创建的订阅者会自动将 ReadCondition
/// 附加到本实例的 WaitSet,数据到达时后台线程通过 [`tokio::sync::Notify`]
/// 唤醒等待中的异步 API。
///
/// `DdsContext` 被 drop 时,后台线程优雅退出(设置 `running = false` → 触发守护
/// 条件 → `join`)。
///
/// # 示例
/// ```ignore
/// use crate::dds::context::DdsContext;
/// use crate::dds::qos::Qos;
///
/// let ctx = DdsContext::new(0)?;
/// let publisher = ctx.create_publisher::<MyMsg>("chatter", Qos::sensor_data())?;
/// let subscriber = ctx.create_subscriber::<MyMsg>("chatter", Qos::sensor_data())?;
/// ```
pub struct DdsContext {
    /// 域参与者;也可直接用于同步操作(创建的 Subscription 不会附加到 WaitSet)
    participant: DomainParticipant,
    waitset: dds_entity_t,
    guard: dds_entity_t,
    running: Arc<AtomicBool>,
    pending: Arc<Mutex<Vec<(dds_entity_t, Arc<tokio::sync::Notify>)>>>,
    thread: Option<thread::JoinHandle<()>>,
}

unsafe impl Send for DdsContext {}
unsafe impl Sync for DdsContext {}

impl DdsContext {
    /// 使用默认 QoS 创建上下文,同时创建域参与者和后台 WaitSet 轮询线程
    ///
    /// # 参数
    /// - `domain_id`:域 ID,使用 [`DOMAIN_DEFAULT`] 让系统自动选择
    pub fn new(domain_id: u32) -> Result<Self> {
        Self::new_with_qos(domain_id, None)
    }

    /// 使用指定 QoS 创建上下文
    pub fn new_with_qos(domain_id: u32, qos: Option<&Qos>) -> Result<Self> {
        let participant = DomainParticipant::new_with_qos(domain_id, qos)?;
        let participant_entity = participant.entity();

        // 创建 WaitSet
        let ws = check_entity(unsafe { zenrc_dds::dds_create_waitset(participant_entity) })?;

        // 创建守护条件(用于唤醒/停止后台线程)
        let guard = match check_entity(unsafe {
            zenrc_dds::dds_create_guardcondition(participant_entity)
        }) {
            Ok(g) => g,
            Err(e) => {
                unsafe { zenrc_dds::dds_delete(ws) };
                return Err(e);
            }
        };

        // 将守护条件附加到 WaitSet(token = WAKE_TOKEN = 0)
        if let Err(e) = check_ret(unsafe {
            zenrc_dds::dds_waitset_attach(ws, guard, WAKE_TOKEN)
        }) {
            unsafe { zenrc_dds::dds_delete(guard) };
            unsafe { zenrc_dds::dds_delete(ws) };
            return Err(e);
        }

        let running = Arc::new(AtomicBool::new(true));
        let pending = Arc::new(Mutex::new(Vec::<(dds_entity_t, Arc<tokio::sync::Notify>)>::new()));

        let handle = {
            let running = Arc::clone(&running);
            let pending = Arc::clone(&pending);
            thread::Builder::new()
                .name("dds-context".into())
                .spawn(move || {
                    context_loop(
                        ws,
                        guard,
                        running,
                        pending,
                    )
                })
                .map_err(|e| DdsError::RetCode(-1, format!("创建上下文线程失败: {e}")))?
        };

        Ok(Self {
            participant,
            waitset: ws,
            guard,
            running,
            pending,
            thread: Some(handle),
        })
    }

    // ── 域管理 ──────────────────────────────────────────────────────────────

    /// 获取域 ID
    pub fn domain_id(&self) -> Result<u32> {
        self.participant.domain_id()
    }

    /// 返回底层 DDS 参与者实体句柄(用于高级场景)
    pub fn entity(&self) -> dds_entity_t {
        self.participant.entity()
    }

    /// 查找同域内的所有参与者实体
    pub fn lookup_participants(domain_id: u32) -> Result<Vec<dds_entity_t>> {
        DomainParticipant::lookup_participants(domain_id)
    }

    // ── Topic 工厂 ─────────────────────────────────────────────────────────

    /// 创建带默认 QoS 的 Topic
    pub fn create_topic<T: RawMessageBridge>(&self, name: &str) -> Result<Topic<T>> {
        self.participant.create_topic(name)
    }

    /// 创建带自定义 QoS 的 Topic
    pub fn create_topic_with_qos<T: RawMessageBridge>(
        &self,
        name: &str,
        qos: &Qos,
    ) -> Result<Topic<T>> {
        self.participant.create_topic_with_qos(name, qos)
    }

    // ── Publisher 工厂 ─────────────────────────────────────────────────────

    /// 创建发布者(自动创建 Topic)
    ///
    /// # 泛型参数
    /// - `T`:安全的 Rust 消息类型,必须实现 [`RawMessageBridge`]
    pub fn create_publisher<T: RawMessageBridge>(
        &self,
        topic_name: &str,
        qos: Qos,
    ) -> Result<Publisher<T>> {
        self.participant.create_publisher(topic_name, qos)
    }

    // ── Subscription 工厂 ─────────────────────────────────────────────────

    /// 创建订阅者(自动创建 Topic),并将 ReadCondition 附加到本上下文的 WaitSet。
    ///
    /// 通过此方法创建的 `Subscription` 支持 `set_event` 事件回调。
    /// 若只需同步访问,可直接使用 `ctx.participant.create_subscriber()`。
    ///
    /// # 泛型参数
    /// - `T`:安全的 Rust 消息类型,必须实现 [`RawMessageBridge`]
    pub fn create_subscriber<T: RawMessageBridge>(
        &self,
        topic_name: &str,
        qos: Qos,
    ) -> Result<Subscription<T>> {
        let topic = self.participant.create_topic_with_qos::<T>(topic_name, &qos)?;
        let sub = unsafe {
            zenrc_dds::dds_create_subscriber(
                self.participant.entity(),
                qos.raw as *const _,
                std::ptr::null(),
            )
        };
        let reader = check_entity(unsafe {
            zenrc_dds::dds_create_reader(
                sub,
                topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        })?;
        let mut subscription = Subscription::new(reader, topic);
        subscription.with_context(self);
        Ok(subscription)
    }

    /// 创建服务端(ServiceServer)
    ///
    /// 遵循 ROS2 DDS 主题命名约定:
    /// 请求主题:`rq/<service_name>Request`,应答主题:`rr/<service_name>Reply`。
    /// 这使得 `ros2 service list` 能够发现该服务。
    ///
    /// reader 自动注册到本上下文的共享 WaitSet,用户调用
    /// [`ServiceServer::set_event`](super::service::ServiceServer::set_event) 注册事件回调。
    pub fn create_service<Req, Res>(
        &self,
        service_name: &str,
        qos: Qos,
    ) -> Result<super::service::ServiceServer<Req, Res>>
    where
        Req: RawMessageBridge,
        Res: RawMessageBridge,
    {
        let participant_entity = self.participant.entity;
        let bare = service_name.trim_start_matches('/');
        let req_name = format!("rq/{}Request", bare);
        let res_name = format!("rr/{}Reply", bare);
        let req_topic = self.create_topic_with_qos::<Req>(&req_name, &qos)?;
        let res_topic = self.create_topic_with_qos::<Res>(&res_name, &qos)?;
        let reader = check_entity(unsafe {
            zenrc_dds::dds_create_reader(
                participant_entity,
                req_topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        })?;
        let writer = check_entity(unsafe {
            zenrc_dds::dds_create_writer(
                participant_entity,
                res_topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        })?;
        let mut service = service::ServiceServer::new(reader, writer, req_topic, res_topic);
        service.with_context(self);
        Ok(service)
    }

    /// 创建服务客户端(ServiceClient)
    ///
    /// 遵循 ROS2 DDS 主题命名约定:
    /// 请求主题:`rq/<service_name>Request`,应答主题:`rr/<service_name>Reply`。
    pub fn create_client<Req: RawMessageBridge, Res: RawMessageBridge>(
        &self,
        service_name: &str,
        qos: Qos,
    ) -> Result<super::service::ServiceClient<Req, Res>> {
        let participant_entity = self.participant.entity();
        let bare = service_name.trim_start_matches('/');
        let req_name = format!("rq/{}Request", bare);
        let res_name = format!("rr/{}Reply", bare);
        let req_topic = self.create_topic_with_qos::<Req>(&req_name, &qos)?;
        let res_topic = self.create_topic_with_qos::<Res>(&res_name, &qos)?;
        let writer = check_entity(unsafe {
            zenrc_dds::dds_create_writer(
                participant_entity,
                req_topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        })?;
        let reader = check_entity(unsafe {
            zenrc_dds::dds_create_reader(
                participant_entity,
                res_topic.entity,
                qos.raw as *const _,
                std::ptr::null(),
            )
        })?;
        Ok(super::service::ServiceClient::new(
            writer,
            reader,
            participant_entity,
            req_topic,
            res_topic,
        ))
    }

    /// 将 reader 加入待处理队列,由后台线程在下一轮循环创建 ReadCondition 并附加到 WaitSet。
    ///
    /// 由 [`DdsContext::create_subscriber`] 在构造 [`Subscription`] 时自动调用。
    pub(crate) fn attach(&self, reader: dds_entity_t) -> Arc<tokio::sync::Notify> {
        let notify = Arc::new(tokio::sync::Notify::new());
        self.pending.lock().unwrap().push((reader, Arc::clone(&notify)));
        // 唤醒后台线程,使其尽快处理新增 reader
        unsafe { zenrc_dds::dds_set_guardcondition(self.guard, true) };
        notify
    }
}

impl Drop for DdsContext {
    fn drop(&mut self) {
        self.running.store(false, Ordering::Release);
        // 唤醒阻塞中的 dds_waitset_wait,使后台线程尽快检测到退出标志
        unsafe { zenrc_dds::dds_set_guardcondition(self.guard, true) };
        if let Some(handle) = self.thread.take() {
            let _ = handle.join();
        }
        // 后台线程已退出,安全清理 DDS 资源
        unsafe { zenrc_dds::dds_delete(self.waitset) };
        unsafe { zenrc_dds::dds_delete(self.guard) };
    }
}

// ─── 后台轮询 ─────────────────────────────────────────────────────────────────

/// 在后台 OS 线程中持续轮询 WaitSet,有条件触发时唤醒对应订阅者的 Notify。
fn context_loop(
    waitset: dds_entity_t,
    guard: dds_entity_t,
    running: Arc<AtomicBool>,
    pending: Arc<Mutex<Vec<(dds_entity_t, Arc<tokio::sync::Notify>)>>>,
) {
    let mut readers: HashMap<isize, ReaderEntry> = HashMap::new();

    while running.load(Ordering::Acquire) {
        // ── 处理新增 reader:创建 ReadCondition 并附加到 WaitSet ───────────────
        {
            let new_readers: Vec<_> = pending.lock().unwrap().drain(..).collect();
            for (reader, notify) in new_readers {
                let token = reader as isize;
                let readcond = match check_entity(unsafe {
                    zenrc_dds::dds_create_readcondition(reader, DDS_ANY_STATE)
                }) {
                    Ok(rc) => rc,
                    Err(_) => continue,
                };
                if check_ret(unsafe {
                    zenrc_dds::dds_waitset_attach(waitset, readcond, token)
                })
                .is_err()
                {
                    unsafe { zenrc_dds::dds_delete(readcond) };
                    continue;
                }
                readers.insert(token, ReaderEntry { readcond, notify });
            }
        }

        // ── 每次循环先扫描已失效的订阅者,更新 WaitSet ─────────────────────────
        {
            // 收集 reader 实体已被删除的条目(dds_get_parent 返回负值表示实体无效)
            let stale: Vec<isize> = readers
                .iter()
                .filter(|&(&token, _)| unsafe {
                    zenrc_dds::dds_get_parent(token as dds_entity_t) < 0
                })
                .map(|(&token, _)| token)
                .collect();
            for token in stale {
                if let Some(entry) = readers.remove(&token) {
                    // 从 WaitSet 移除对应 ReadCondition 并释放
                    unsafe { zenrc_dds::dds_waitset_detach(waitset, entry.readcond) };
                    unsafe { zenrc_dds::dds_delete(entry.readcond) };
                }
            }
        }

        let mut xs: Vec<dds_attach_t> = vec![0; MAX_TRIGGERS];
        let n = unsafe {
            zenrc_dds::dds_waitset_wait(
                waitset,
                xs.as_mut_ptr(),
                MAX_TRIGGERS,
                POLL_TIMEOUT_NS,
            )
        };

        if n < 0 {
            // WaitSet 出错(实体已被删除等),退出循环
            break;
        }

        // n == 0:超时,无条件触发,继续检测 running 标志
        xs.truncate(n as usize);

        for token in xs {
            if token == WAKE_TOKEN {
                // 重置守护条件,避免持续触发
                unsafe { zenrc_dds::dds_set_guardcondition(guard, false) };
                continue;
            }

            // 唤醒对应订阅者:取 Arc<Notify> 后在锁外调用,防止死锁
            {
                let notify = readers.get(&token).map(|e| Arc::clone(&e.notify));
                if let Some(n) = notify {
                    // notify_one 存储一个 permit,即使当前无等待方也不丢失
                    n.notify_one();
                }
            }
        }
    }

    // 后台线程退出前清理所有 ReadCondition
    for entry in readers.values() {
        unsafe { zenrc_dds::dds_delete(entry.readcond) };
    }
}