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.

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

rt: use signal driver handle via scheduler::Handle #5135

Merged
merged 3 commits into from Oct 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 0 additions & 17 deletions tokio/src/runtime/context.rs
Expand Up @@ -24,23 +24,6 @@ pub(crate) fn current() -> Handle {
}
}

cfg_signal_internal! {
#[cfg(unix)]
pub(crate) fn signal_handle() -> crate::runtime::driver::SignalHandle {
match CONTEXT.try_with(|ctx| {
let ctx = ctx.borrow();
ctx.as_ref()
.expect(crate::util::error::CONTEXT_MISSING_ERROR)
.inner
.signal()
.clone()
}) {
Ok(signal_handle) => signal_handle,
Err(_) => panic!("{}", crate::util::error::THREAD_LOCAL_DESTROYED_ERROR),
}
}
}

cfg_time! {
cfg_test_util! {
pub(crate) fn clock() -> Option<crate::runtime::driver::Clock> {
Expand Down
9 changes: 9 additions & 0 deletions tokio/src/runtime/driver.rs
Expand Up @@ -90,6 +90,15 @@ impl Handle {
}
}

cfg_signal_internal_and_unix! {
#[track_caller]
pub(crate) fn signal(&self) -> &crate::runtime::signal::Handle {
self.signal
.as_ref()
.expect("there is no signal driver running, must be called from the context of Tokio runtime")
}
}

cfg_time! {
/// Returns a reference to the time driver handle.
///
Expand Down
7 changes: 0 additions & 7 deletions tokio/src/runtime/scheduler/mod.rs
Expand Up @@ -113,13 +113,6 @@ cfg_rt! {
Handle::MultiThread(h) => &h.seed_generator,
}
}

#[cfg(unix)]
cfg_signal_internal! {
pub(crate) fn signal(&self) -> &driver::SignalHandle {
&self.driver().signal
}
}
}

cfg_metrics! {
Expand Down
50 changes: 9 additions & 41 deletions tokio/src/runtime/signal/mod.rs
Expand Up @@ -23,18 +23,19 @@ pub(crate) struct Driver {
/// A pipe for receiving wake events from the signal handler
receiver: UnixStream,

/// Shared state
inner: Arc<Inner>,
/// Shared state. The driver keeps a strong ref and the handle keeps a weak
/// ref. The weak ref is used to check if the driver is still active before
/// trying to register a signal handler.
inner: Arc<()>,
}

#[derive(Clone, Debug, Default)]
#[derive(Debug, Default)]
pub(crate) struct Handle {
inner: Weak<Inner>,
/// Paired w/ the `Arc` above and is used to check if the driver is still
/// around before attempting to register a signal handler.
inner: Weak<()>,
carllerche marked this conversation as resolved.
Show resolved Hide resolved
}

#[derive(Debug)]
pub(super) struct Inner(());

// ===== impl Driver =====

impl Driver {
Expand Down Expand Up @@ -75,7 +76,7 @@ impl Driver {
Ok(Self {
io,
receiver,
inner: Arc::new(Inner(())),
inner: Arc::new(()),
})
}

Expand Down Expand Up @@ -139,36 +140,3 @@ impl Handle {
}
}
}

cfg_rt! {
impl Handle {
/// Returns a handle to the current driver
///
/// # Panics
///
/// This function panics if there is no current signal driver set.
#[track_caller]
pub(crate) fn current() -> Self {
crate::runtime::context::signal_handle().expect(
"there is no signal driver running, must be called from the context of Tokio runtime",
)
}
}
}

cfg_not_rt! {
impl Handle {
/// Returns a handle to the current driver
///
/// # Panics
///
/// This function panics if there is no current signal driver set.
#[track_caller]
pub(crate) fn current() -> Self {
panic!(
"there is no signal driver running, must be called from the context of Tokio runtime or with\
`rt` enabled.",
)
}
}
}
4 changes: 3 additions & 1 deletion tokio/src/signal/unix.rs
Expand Up @@ -6,6 +6,7 @@
#![cfg(unix)]
#![cfg_attr(docsrs, doc(cfg(all(unix, feature = "signal"))))]

use crate::runtime::scheduler;
use crate::runtime::signal::Handle;
use crate::signal::registry::{globals, EventId, EventInfo, Globals, Init, Storage};
use crate::signal::RxFuture;
Expand Down Expand Up @@ -389,7 +390,8 @@ pub struct Signal {
/// feature flag is not enabled.
#[track_caller]
pub fn signal(kind: SignalKind) -> io::Result<Signal> {
let rx = signal_with_handle(kind, &Handle::current())?;
let handle = scheduler::Handle::current();
let rx = signal_with_handle(kind, handle.driver().signal())?;

Ok(Signal {
inner: RxFuture::new(rx),
Expand Down