Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

eventloop: various registration management fixes #48133

Merged
merged 2 commits into from
Feb 24, 2025
Merged

eventloop: various registration management fixes #48133

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed1e6b4
eventloop: various registration management fixes
jkarneges Feb 22, 2025
d34f09d
nit
jkarneges Feb 24, 2025
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 src/core/eventloop.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ int EventLoop::registerTimer(int timeout, void (*cb)(void *), void *ctx)

void EventLoop::deregister(int id)
{
ffi::event_loop_deregister(inner_, id);
assert(ffi::event_loop_deregister(inner_, id) == 0);
}

EventLoop *EventLoop::instance()
Expand Down
103 changes: 84 additions & 19 deletions src/core/eventloop.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ impl Evented {
}

struct Registration<C> {
_evented: Evented,
evented: Evented,
activated: bool,
callback: Option<C>,
}
Expand Down Expand Up @@ -111,10 +111,11 @@ impl<C: Callback> Registrations<C> {
let entry = data.nodes.vacant_entry();
let nkey = entry.key();

evented.registration().set_waker_persistent(true);
evented.registration().set_waker(&get_waker(nkey), interest);

let reg = Registration {
_evented: evented,
evented,
activated: false,
callback: Some(callback),
};
Expand All @@ -124,13 +125,19 @@ impl<C: Callback> Registrations<C> {
Ok(nkey)
}

fn remove(&self, reg_id: usize) {
fn remove(&self, reg_id: usize) -> Result<(), RegistrationsError> {
let nkey = reg_id;

let data = &mut *self.data.borrow_mut();

if !data.nodes.contains(nkey) {
return Err(RegistrationsError);
}

data.activated.remove(&mut data.nodes, nkey);
data.nodes.remove(nkey);

Ok(())
}

fn activate(&self, reg_id: usize) {
Expand Down Expand Up @@ -179,23 +186,38 @@ impl<C: Callback> Registrations<C> {
};

let reg = &mut data.nodes[nkey].value;
reg.activated = false;

let callback = reg
.callback
.take()
.expect("registration should have a callback");

let nkey = if let Evented::Timer(_) = &reg.evented {
// remove timer registrations after activation
data.nodes.remove(nkey);

None
} else {
reg.activated = false;
reg.evented
.registration()
.clear_readiness(mio::Interest::READABLE | mio::Interest::WRITABLE);

Some(nkey)
};

(nkey, callback)
};

callback.call();

let data = &mut *self.data.borrow_mut();
if let Some(nkey) = nkey {
let data = &mut *self.data.borrow_mut();

let reg = &mut data.nodes[nkey].value;
let reg = &mut data.nodes[nkey].value;

reg.callback = Some(callback);
reg.callback = Some(callback);
}
}
}

Expand Down Expand Up @@ -338,8 +360,11 @@ impl<C: Callback> EventLoop<C> {
.expect("slab should have capacity"))
}

pub fn deregister(&self, id: usize) {
self.regs.remove(id);
pub fn deregister(&self, id: usize) -> Result<(), EventLoopError> {
match self.regs.remove(id) {
Ok(()) => Ok(()),
Err(_) => Err(EventLoopError),
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be simplified down since we're just throwing away the error:

Suggested change
match self.regs.remove(id) {
Ok(()) => Ok(()),
Err(_) => Err(EventLoopError),
}
self.regs.remove(id).map_err(|_| EventLoopError)

}

fn poll_and_dispatch(&self, timeout: Option<Duration>) -> Option<i32> {
Expand Down Expand Up @@ -504,10 +529,17 @@ mod ffi {

#[allow(clippy::missing_safety_doc)]
#[no_mangle]
pub unsafe extern "C" fn event_loop_deregister(l: *mut EventLoopRaw, id: libc::size_t) {
pub unsafe extern "C" fn event_loop_deregister(
l: *mut EventLoopRaw,
id: libc::size_t,
) -> libc::c_int {
let l = l.as_mut().unwrap();

l.deregister(id);
if l.deregister(id).is_err() {
return -1;
}

0
}
}

Expand All @@ -516,8 +548,11 @@ mod tests {
use super::*;
use crate::core::executor::Executor;
use crate::core::reactor::Reactor;
use std::cell::Cell;
use std::io;
use std::os::fd::AsRawFd;
use std::rc::Rc;
use std::thread;

struct NoopCallback;

Expand Down Expand Up @@ -552,24 +587,51 @@ mod tests {
let addr = listener.local_addr().unwrap();
let fd = listener.as_raw_fd();

let count = Rc::new(Cell::new(0));

let cb = {
let l = Rc::clone(&l);
let listener = Rc::clone(&listener);
let count = Rc::clone(&count);

Box::new(FnCallback(move || {
let _stream = listener.accept().unwrap();
l.exit(0);

let e = listener.accept().unwrap_err();
assert_eq!(e.kind(), io::ErrorKind::WouldBlock);

count.set(count.get() + 1);
if count.get() == 2 {
l.exit(0);
}
}))
};

let id = l.register_fd(fd, READABLE, cb).unwrap();

// non-blocking connect attempt to trigger listener
let _stream = mio::net::TcpStream::connect(addr);
{
// non-blocking connect attempt to trigger listener
let _stream = mio::net::TcpStream::connect(addr);

while count.get() < 1 {
l.step();
thread::sleep(Duration::from_millis(10));
}
}

{
// non-blocking connect attempt to trigger listener
let _stream = mio::net::TcpStream::connect(addr);

while count.get() < 2 {
l.step();
thread::sleep(Duration::from_millis(10));
}
}

assert_eq!(l.exec(), 0);

l.deregister(id);
l.deregister(id).unwrap();
}

#[test]
Expand All @@ -591,11 +653,14 @@ mod tests {

assert_eq!(l.exec(), 0);

l.deregister(id);
// activated timers automatically deregister
l.deregister(id).unwrap_err();

assert!(l
let id = l
.register_timer(Duration::from_millis(0), Box::new(NoopCallback))
.is_ok());
.unwrap();

l.deregister(id).unwrap();
}

#[test]
Expand Down Expand Up @@ -630,7 +695,7 @@ mod tests {

assert_eq!(l.exec_async().await, 0);

l.deregister(id);
l.deregister(id).unwrap();
})
.unwrap();

Expand Down
Loading