use std::sync::OnceLock;
use reverie::Guest;
use crate::Detcore;
use crate::record_or_replay::RecordOrReplay;
pub type RefusedSignalControls = (u64, bool);
static SOURCE: OnceLock<fn() -> RefusedSignalControls> = OnceLock::new();
pub fn install(source: fn() -> RefusedSignalControls) -> bool {
SOURCE.set(source).is_ok()
}
fn take() -> RefusedSignalControls {
SOURCE.get().map_or((0, false), |source| source())
}
pub(crate) async fn report<G, T>(guest: &mut G)
where
G: Guest<Detcore<T>>,
T: RecordOrReplay,
{
let (actions, alternate_stack) = take();
if actions == 0 && !alternate_stack {
return;
}
crate::tool_global::announce_refused_signal_controls(guest, actions, alternate_stack).await;
}
pub(crate) fn handler_refused_warning(signum: i32) -> String {
let name = signal_name(signum);
format!(
"HERMIT_SIGNAL_HANDLER_REFUSED signum={signum} ({name}): the guest asked for a new \
action for it (a handler, or any action for a signal the in-guest runtime keeps for \
itself) and received EPERM, so the handler was not installed: in-guest signal \
handlers are unsupported until A5 step 3c (https://github.com/rrnewton/hermit/issues/4485). \
A {name} the guest receives takes the action it had before."
)
}
pub(crate) fn alternate_stack_refused_warning() -> String {
"HERMIT_SIGNAL_ALTSTACK_REFUSED: the guest asked to set or change its alternate signal \
stack and received EPERM, so it was not installed: in-guest signal handlers are \
unsupported until A5 step 3c (https://github.com/rrnewton/hermit/issues/4485)."
.to_string()
}
fn signal_name(signum: i32) -> String {
match nix::sys::signal::Signal::try_from(signum) {
Ok(signal) => signal.as_str().to_string(),
Err(_) => format!("realtime signal {signum}"),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_warnings_name_the_signal_the_errno_and_why() {
let usr1 = handler_refused_warning(libc::SIGUSR1);
assert!(usr1.starts_with("HERMIT_SIGNAL_HANDLER_REFUSED signum=10 (SIGUSR1): "));
let stack = alternate_stack_refused_warning();
assert!(stack.starts_with("HERMIT_SIGNAL_ALTSTACK_REFUSED: "));
for text in [&usr1, &stack] {
assert!(text.contains("received EPERM"), "{text}");
assert!(text.contains("was not installed"), "{text}");
assert!(
text.contains("in-guest signal handlers are unsupported until A5 step 3c"),
"{text}"
);
}
assert!(handler_refused_warning(36).contains("(realtime signal 36)"));
for text in [usr1, stack] {
for backend in ["liteinst", "LiteInst", "in-guest-trap", "sabre", "SaBRe"] {
assert!(!text.contains(backend), "{text}");
}
}
}
}