feat: Support IORING_TIMEOUT_MULTISHOT flag (#332)

Author: pchaseh

io-uring-test/src/main.rs

@@ -115,6 +115,7 @@ fn test<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
     tests::timeout::test_timeout_cancel(&mut ring, &test)?;
     tests::timeout::test_timeout_abs(&mut ring, &test)?;
     tests::timeout::test_timeout_submit_args(&mut ring, &test)?;
+    tests::timeout::test_timeout_multishot(&mut ring, &test)?;
 
     // net
     tests::net::test_tcp_write_read(&mut ring, &test)?;

io-uring-test/src/tests/timeout.rs

@@ -381,3 +381,54 @@ pub fn test_timeout_submit_args<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
 
     Ok(())
 }
+
+pub fn test_timeout_multishot<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
+    ring: &mut IoUring<S, C>,
+    test: &Test,
+) -> anyhow::Result<()> {
+    require!(
+        test;
+        test.probe.is_supported(opcode::Timeout::CODE);
+    );
+
+    println!("test timeout_multishot");
+
+    let ts = types::Timespec::new().sec(1);
+    let timeout_e = opcode::Timeout::new(&ts)
+        .flags(types::TimeoutFlags::MULTISHOT)
+        .count(2);
+
+    unsafe {
+        let mut queue = ring.submission();
+        queue
+            .push(&timeout_e.build().user_data(0x0c).into())
+            .expect("queue is full");
+    }
+
+    let start = Instant::now();
+    ring.submit_and_wait(1)?;
+
+    assert_eq!(start.elapsed().as_secs(), 1);
+
+    let mut cqes: Vec<cqueue::Entry> = ring.completion().map(Into::into).collect();
+    cqes.sort_by_key(|cqe| cqe.user_data());
+
+    assert_eq!(cqes.len(), 1);
+    assert_eq!(cqes[0].user_data(), 0x0c);
+    assert_eq!(cqes[0].result(), -libc::ETIME);
+    assert!(cqueue::more(cqes[0].flags()));
+
+    ring.submit_and_wait(1)?;
+
+    assert_eq!(start.elapsed().as_secs(), 2);
+
+    let mut cqes: Vec<cqueue::Entry> = ring.completion().map(Into::into).collect();
+    cqes.sort_by_key(|cqe| cqe.user_data());
+
+    assert_eq!(cqes.len(), 1);
+    assert_eq!(cqes[0].user_data(), 0x0c);
+    assert_eq!(cqes[0].result(), -libc::ETIME);
+    assert!(!cqueue::more(cqes[0].flags()));
+
+    Ok(())
+}

src/opcode.rs

@@ -543,9 +543,10 @@ opcode! {
         timespec: { *const types::Timespec },
         ;;
         /// `count` may contain a completion event count.
+        /// If [`TimeoutFlags::TIMEOUT`] is set in `flags`, this is the number of repeats. A value of 0 means the timeout is
+        /// indefinite and can only be stopped by a removal request.
         count: u32 = 0,
 
-        /// `flags` may contain [types::TimeoutFlags::ABS] for an absolute timeout value, or 0 for a relative timeout.
         flags: types::TimeoutFlags = types::TimeoutFlags::empty()
     }
 

src/types.rs

@@ -99,6 +99,8 @@ bitflags! {
         const LINK_TIMEOUT_UPDATE = sys::IORING_LINK_TIMEOUT_UPDATE;
 
         const ETIME_SUCCESS = sys::IORING_TIMEOUT_ETIME_SUCCESS;
+
+        const MULTISHOT = sys::IORING_TIMEOUT_MULTISHOT;
     }
 }