Skip to main content

libcontainer/
signal.rs

1//! Returns *nix signal enum value from passed string
2
3use std::convert::TryFrom;
4
5use nix::sys::signal::Signal as NixSignal;
6
7/// POSIX Signal
8#[derive(Debug)]
9pub struct Signal(NixSignal);
10
11#[derive(Debug, thiserror::Error)]
12pub enum SignalError<T> {
13    #[error("invalid signal: {0}")]
14    InvalidSignal(T),
15}
16
17impl TryFrom<&str> for Signal {
18    type Error = SignalError<String>;
19
20    fn try_from(s: &str) -> Result<Self, Self::Error> {
21        use NixSignal::*;
22
23        Ok(Signal(match s.to_ascii_uppercase().as_str() {
24            "1" | "HUP" | "SIGHUP" => SIGHUP,
25            "2" | "INT" | "SIGINT" => SIGINT,
26            "3" | "QUIT" | "SIGQUIT" => SIGQUIT,
27            "4" | "ILL" | "SIGILL" => SIGILL,
28            "5" | "BUS" | "SIGBUS" => SIGBUS,
29            "6" | "ABRT" | "IOT" | "SIGABRT" | "SIGIOT" => SIGABRT,
30            "7" | "TRAP" | "SIGTRAP" => SIGTRAP,
31            "8" | "FPE" | "SIGFPE" => SIGFPE,
32            "9" | "KILL" | "SIGKILL" => SIGKILL,
33            "10" | "USR1" | "SIGUSR1" => SIGUSR1,
34            "11" | "SEGV" | "SIGSEGV" => SIGSEGV,
35            "12" | "USR2" | "SIGUSR2" => SIGUSR2,
36            "13" | "PIPE" | "SIGPIPE" => SIGPIPE,
37            "14" | "ALRM" | "SIGALRM" => SIGALRM,
38            "15" | "TERM" | "SIGTERM" => SIGTERM,
39            "16" | "STKFLT" | "SIGSTKFLT" => SIGSTKFLT,
40            "17" | "CHLD" | "SIGCHLD" => SIGCHLD,
41            "18" | "CONT" | "SIGCONT" => SIGCONT,
42            "19" | "STOP" | "SIGSTOP" => SIGSTOP,
43            "20" | "TSTP" | "SIGTSTP" => SIGTSTP,
44            "21" | "TTIN" | "SIGTTIN" => SIGTTIN,
45            "22" | "TTOU" | "SIGTTOU" => SIGTTOU,
46            "23" | "URG" | "SIGURG" => SIGURG,
47            "24" | "XCPU" | "SIGXCPU" => SIGXCPU,
48            "25" | "XFSZ" | "SIGXFSZ" => SIGXFSZ,
49            "26" | "VTALRM" | "SIGVTALRM" => SIGVTALRM,
50            "27" | "PROF" | "SIGPROF" => SIGPROF,
51            "28" | "WINCH" | "SIGWINCH" => SIGWINCH,
52            "29" | "IO" | "SIGIO" => SIGIO,
53            "30" | "PWR" | "SIGPWR" => SIGPWR,
54            "31" | "SYS" | "SIGSYS" => SIGSYS,
55            _ => return Err(SignalError::InvalidSignal(s.to_string())),
56        }))
57    }
58}
59
60impl TryFrom<i32> for Signal {
61    type Error = SignalError<i32>;
62
63    fn try_from(value: i32) -> Result<Self, Self::Error> {
64        NixSignal::try_from(value)
65            .map_err(|_| SignalError::InvalidSignal(value))
66            .map(Signal)
67    }
68}
69
70impl From<NixSignal> for Signal {
71    fn from(s: NixSignal) -> Self {
72        Signal(s)
73    }
74}
75
76impl Signal {
77    pub(crate) fn into_raw(self) -> NixSignal {
78        self.0
79    }
80}
81
82#[cfg(test)]
83mod tests {
84    use std::collections::HashMap;
85
86    use nix::sys::signal::Signal::*;
87
88    use super::*;
89
90    #[test]
91    fn test_conversion_from_string() {
92        let mut test_sets = HashMap::new();
93        test_sets.insert(SIGHUP, vec!["1", "HUP", "SIGHUP"]);
94        test_sets.insert(SIGINT, vec!["2", "INT", "SIGINT"]);
95        test_sets.insert(SIGQUIT, vec!["3", "QUIT", "SIGQUIT"]);
96        test_sets.insert(SIGILL, vec!["4", "ILL", "SIGILL"]);
97        test_sets.insert(SIGBUS, vec!["5", "BUS", "SIGBUS"]);
98        test_sets.insert(SIGABRT, vec!["6", "ABRT", "IOT", "SIGABRT", "SIGIOT"]);
99        test_sets.insert(SIGTRAP, vec!["7", "TRAP", "SIGTRAP"]);
100        test_sets.insert(SIGFPE, vec!["8", "FPE", "SIGFPE"]);
101        test_sets.insert(SIGKILL, vec!["9", "KILL", "SIGKILL"]);
102        test_sets.insert(SIGUSR1, vec!["10", "USR1", "SIGUSR1"]);
103        test_sets.insert(SIGSEGV, vec!["11", "SEGV", "SIGSEGV"]);
104        test_sets.insert(SIGUSR2, vec!["12", "USR2", "SIGUSR2"]);
105        test_sets.insert(SIGPIPE, vec!["13", "PIPE", "SIGPIPE"]);
106        test_sets.insert(SIGALRM, vec!["14", "ALRM", "SIGALRM"]);
107        test_sets.insert(SIGTERM, vec!["15", "TERM", "SIGTERM"]);
108        test_sets.insert(SIGSTKFLT, vec!["16", "STKFLT", "SIGSTKFLT"]);
109        test_sets.insert(SIGCHLD, vec!["17", "CHLD", "SIGCHLD"]);
110        test_sets.insert(SIGCONT, vec!["18", "CONT", "SIGCONT"]);
111        test_sets.insert(SIGSTOP, vec!["19", "STOP", "SIGSTOP"]);
112        test_sets.insert(SIGTSTP, vec!["20", "TSTP", "SIGTSTP"]);
113        test_sets.insert(SIGTTIN, vec!["21", "TTIN", "SIGTTIN"]);
114        test_sets.insert(SIGTTOU, vec!["22", "TTOU", "SIGTTOU"]);
115        test_sets.insert(SIGURG, vec!["23", "URG", "SIGURG"]);
116        test_sets.insert(SIGXCPU, vec!["24", "XCPU", "SIGXCPU"]);
117        test_sets.insert(SIGXFSZ, vec!["25", "XFSZ", "SIGXFSZ"]);
118        test_sets.insert(SIGVTALRM, vec!["26", "VTALRM", "SIGVTALRM"]);
119        test_sets.insert(SIGPROF, vec!["27", "PROF", "SIGPROF"]);
120        test_sets.insert(SIGWINCH, vec!["28", "WINCH", "SIGWINCH"]);
121        test_sets.insert(SIGIO, vec!["29", "IO", "SIGIO"]);
122        test_sets.insert(SIGPWR, vec!["30", "PWR", "SIGPWR"]);
123        test_sets.insert(SIGSYS, vec!["31", "SYS", "SIGSYS"]);
124        for (signal, strings) in test_sets {
125            for s in strings {
126                assert_eq!(signal, Signal::try_from(s).unwrap().into_raw());
127            }
128        }
129    }
130
131    #[test]
132    fn test_conversion_from_string_should_be_failed() {
133        assert!(Signal::try_from("invalid").is_err())
134    }
135}