githubmirror/mdevctl

src/callouts.rs
789 строк25 KB
Jonathon Jongsma
Improve failure message for live update
17 сен 2024, 16:25
17 сен 2024, 16:256227c6e
use anyhow::{anyhow, Context, Result};
use log::{debug, warn};
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::ffi::OsStr;
use std::fmt::{self, Display, Formatter};
use std::io::{ErrorKind, Write};
use std::path::{Path, PathBuf};
use std::process::{Command, Output, Stdio};

use crate::mdev::*;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Event {
    Pre,
    Post,
    Live,
    Notify,
    Get,
    #[serde(skip_serializing)]
    #[serde(other)]
    Unknown, // used for forward compatibility to newer callout scripts
}

fn invocation_failure(path: &PathBuf, code: Option<i32>) -> anyhow::Error {
    anyhow!(
        "Script '{:?}' failed with status '{}'",
        path,
        match code {
            Some(i) => i.to_string(),
            None => "unknown".to_string(),
        }
    )
}

impl Display for Event {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            Event::Pre => write!(f, "pre"),
            Event::Post => write!(f, "post"),
            Event::Live => write!(f, "live"),
            Event::Notify => write!(f, "notify"),
            Event::Get => write!(f, "get"),
            Event::Unknown => write!(f, "unknown"),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Action {
    Start,
    Stop,
    Define,
    Undefine,
    Modify,
    Attributes,
    Capabilities,
    #[serde(skip_serializing)]
    Test, // used for tests only
    #[serde(skip_serializing)]
    #[serde(other)]
    Unknown, // used for forward compatibility to newer callout scripts
}

impl Display for Action {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            Action::Start => write!(f, "start"),
            Action::Stop => write!(f, "stop"),
            Action::Define => write!(f, "define"),
            Action::Undefine => write!(f, "undefine"),
            Action::Modify => write!(f, "modify"),
            Action::Attributes => write!(f, "attributes"),
            Action::Capabilities => write!(f, "capabilities"),
            Action::Test => write!(f, "test"),
            Action::Unknown => write!(f, "unknown"),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub struct CalloutVersion {
    version: Cow<'static, u32>,
    actions: Cow<'static, [Action]>,
    events: Cow<'static, [Event]>,
}

impl CalloutVersion {
    pub const fn new_const(
        version: &'static u32,
        actions: &'static [Action],
        events: &'static [Event],
    ) -> Self {
        Self {
            version: Cow::Borrowed(version),
            actions: Cow::Borrowed(actions),
            events: Cow::Borrowed(events),
        }
    }

    pub const NOT_FOUND: CalloutVersion = CalloutVersion::new_const(&0, &[], &[]);

    pub const V_1: CalloutVersion = CalloutVersion::new_const(
        &1,
        &[
            Action::Start,
            Action::Stop,
            Action::Define,
            Action::Undefine,
            Action::Modify,
            Action::Attributes,
        ],
        &[Event::Pre, Event::Post, Event::Notify, Event::Get],
    );

    #[allow(dead_code)]
    pub const V_2: CalloutVersion = CalloutVersion::new_const(
        &2,
        &[
            Action::Start,
            Action::Stop,
            Action::Define,
            Action::Undefine,
            Action::Modify,
            Action::Attributes,
            Action::Capabilities,
        ],
        &[
            Event::Pre,
            Event::Post,
            Event::Notify,
            Event::Get,
            Event::Live,
        ],
    );

    pub fn has_action(&self, action: Action) -> bool {
        self.actions.contains(&action)
    }

    pub fn has_event(&self, event: Event) -> bool {
        self.events.contains(&event)
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct CalloutVersionProvides {
    provides: Option<CalloutVersion>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct CalloutVersionSupports {
    supports: Option<CalloutVersion>,
}

#[derive(Clone, Copy)]
pub enum State {
    None,
    Success,
    Failure,
}

impl Display for State {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            State::None => write!(f, "none"),
            State::Success => write!(f, "success"),
            State::Failure => write!(f, "failure"),
        }
    }
}

#[derive(Clone, Debug)]
pub struct CalloutScriptInfo {
    path: PathBuf,
    parent: String,
    mdev_type: String,
    supports: CalloutVersion,
}

impl CalloutScriptInfo {
    fn new(
        path: PathBuf,
        parent: String,
        mdev_type: String,
        supports: CalloutVersion,
    ) -> CalloutScriptInfo {
        CalloutScriptInfo {
            path,
            parent,
            mdev_type,
            supports,
        }
    }

    fn supports_event_action(&self, event: Event, action: Action) -> Result<()> {
        if !self.supports.has_action(action) {
            debug!(
                "Callout script {:?} does not support action '{:?}'",
                self.path.clone(),
                action
            );
            return Err(anyhow!(
                "Script {:?} does not support action '{:?}'",
                self.path.clone(),
                action
            ));
        }
        if !self.supports.has_event(event) {
            debug!(
                "Callout script {:?} does not support event '{:?}'",
                self.path.clone(),
                event
            );
            return Err(anyhow!(
                "Script {:?} does not support event '{:?}'",
                self.path.clone(),
                event
            ));
        }
        Ok(())
    }
}

impl AsRef<Path> for CalloutScriptInfo {
    fn as_ref(&self) -> &Path {
        &self.path
    }
}

#[derive(Debug)]
pub struct CalloutScriptCache {
    callouts: Vec<CalloutScriptInfo>,
}

impl CalloutScriptCache {
    pub const fn new() -> Self {
        CalloutScriptCache {
            callouts: Vec::new(),
        }
    }

    fn parse_script_capabilities(output: &Output) -> Option<CalloutVersion> {
        let stdout = String::from_utf8(output.clone().stdout).unwrap();
        match serde_json::from_str::<CalloutVersionSupports>(stdout.trim_end_matches('\0')) {
            Ok(ce) => ce.supports.or_else(|| {
                debug!(" Callout script does not provide version support");
                None
            }),
            Err(e) => {
                debug!(
                    " Callout script has no version support (unparsable stdout): {:?}",
                    e
                );
                None
            }
        }
    }

    fn lookup_cached_script(&self, parent: &str, mdev_type: &str) -> Option<CalloutScriptInfo> {
        self.callouts
            .iter()
            .find(|cs| cs.mdev_type == mdev_type && cs.parent == parent)
            .cloned()
    }

    pub fn find_versioned_script(&mut self, dev: &MDev) -> Option<CalloutScriptInfo> {
        // check already found scripts
        let mut dev = dev.clone();
        let mut callout = match callout(&mut dev) {
            Ok(c) => c,
            Err(e) => {
                debug!(
                    "cannot find a callout script for mdev with uuid {:?}: {:?}",
                    dev.uuid, e
                );
                return None;
            }
        };
        let mdev_type = match callout.dev.mdev_type() {
            Ok(t) => t.clone(),
            Err(_) => {
                debug!("mdev_type is required on device => cannot find a callout script");
                return None;
            }
        };
        let parent = match callout.dev.parent() {
            Ok(p) => p.clone(),
            Err(_) => {
                debug!("parent is required on device => cannot find a callout script");
                return None;
            }
        };
        debug!("Looking up callout script for mdev type '{:?}'", mdev_type);
        match self.lookup_cached_script(&parent, &mdev_type) {
            Some(cs) => {
                debug!(
                    "Callout script lookup for mdev type '{:?}' and parent {:?} successful",
                    mdev_type, parent
                );
                if cs.supports == CalloutVersion::NOT_FOUND && cs.path.as_os_str().is_empty() {
                    debug!("Callout script search returned empty before: no script with versioning available");
                    return None;
                } else {
                    debug!("Callout script looked up: {:?}", cs.path);
                    return Some(cs);
                }
            }
            None => {
                debug!(
                    "Callout script lookup failed. Start searching for mdev type '{:?}' and parent {:?}",
                    mdev_type, parent
                );
            }
        }

        let ce_ver = CalloutVersionProvides {
            provides: Some(CalloutVersion::V_2),
        };
        let json_ce_ver =
            serde_json::to_string(&ce_ver).expect("CalloutVersion JSON could not be generated");

        match callout.callout(
            Event::Get,
            Action::Capabilities,
            Some(&json_ce_ver),
            &CapabilitiesCheckProcessOutput,
        ) {
            Ok(op) => match op {
                Some(_) => {
                    self.callouts.push(callout.script.clone().unwrap());
                    callout.script
                }
                None => {
                    // When lookup and search turned out empty create a did-not-find entry.
                    self.callouts.push(CalloutScriptInfo::new(
                        PathBuf::new(),
                        parent,
                        mdev_type,
                        CalloutVersion::NOT_FOUND,
                    ));
                    None
                }
            },
            Err(_) => None,
        }
    }
}

pub trait CheckProcessOutput {
    fn check(&self, p: PathBuf, o: Output) -> Result<(PathBuf, Output)>;
    fn process(&self, c: &mut Callout<'_>, p: PathBuf, o: Output) -> Result<Option<Output>>;
}

struct DefaultCheckProcessOutput;

impl CheckProcessOutput for DefaultCheckProcessOutput {
    fn check(&self, p: PathBuf, o: Output) -> Result<(PathBuf, Output)> {
        Ok((p, o))
    }

    fn process(&self, c: &mut Callout<'_>, p: PathBuf, o: Output) -> Result<Option<Output>> {
        c.print_err(&o, &p);
        match o.status.code() {
            Some(0) => {
                c.script = Some(CalloutScriptInfo::new(
                    p,
                    c.dev.parent().unwrap().to_string(),
                    c.dev.mdev_type().unwrap().to_string(),
                    CalloutVersion::V_1,
                ));
                Ok(Some(o))
            }
            Some(n) => Err(invocation_failure(&p, Some(n))),
            None => Ok(None),
        }
    }
}

struct CapabilitiesCheckProcessOutput;

impl CheckProcessOutput for CapabilitiesCheckProcessOutput {
    fn check(&self, p: PathBuf, o: Output) -> Result<(PathBuf, Output)> {
        match CalloutScriptCache::parse_script_capabilities(&o) {
            Some(_) => Ok((p, o)),
            None => Err(anyhow!(
                "Output of callout script {:?} is not a valid capabilities XML response",
                p
            )),
        }
    }

    fn process(&self, c: &mut Callout<'_>, p: PathBuf, o: Output) -> Result<Option<Output>> {
        c.print_err(&o, &p);
        match CalloutScriptCache::parse_script_capabilities(&o) {
            Some(cv) => {
                debug!(" Script supports versioning: {:?}", cv);
                if cv.has_action(Action::Unknown) {
                    warn!("Callout script {:?} provides unknown Action type", p);
                }
                if cv.has_event(Event::Unknown) {
                    warn!("Callout script {:?} provides unknown Event type", p);
                }
                c.script = Some(CalloutScriptInfo::new(
                    p,
                    c.dev.parent().unwrap().to_string(),
                    c.dev.mdev_type().unwrap().to_string(),
                    cv,
                ));
                Ok(Some(o))
            }
            None => Ok(None),
        }
    }
}

pub struct Callout<'a> {
    state: State,
    script: Option<CalloutScriptInfo>,
    pub dev: &'a mut MDev,
}

pub fn callout(dev: &mut MDev) -> Result<Callout> {
    Callout::new(dev)
}

impl<'a> Callout<'a> {
    pub fn new(dev: &'a mut MDev) -> Result<Callout<'a>> {
        if dev.mdev_type.is_none() {
            return Err(anyhow!("Device must have a defined mdev_type"));
        }
        Ok(Callout {
            state: State::None,
            script: None,
            dev,
        })
    }

    fn find_callout_script(&self) -> Option<CalloutScriptInfo> {
        self.dev.env.find_script(self.dev)
    }

    pub fn invoke_modify_live(&mut self) -> Result<()> {
        self.script = self.find_callout_script();
        if self.script.is_none() {
            // live is only supported when script with versioning exists
            debug!("No callout script with version support found that supports live modify");
            return Err(anyhow!(
                "Live modification is not supported for this device type. Changing the device configuration requires stopping and restarting the device."
            ));
        }

        let mut res = Ok(());
        let sysfs_data = MDevSysfsData::load_for_mdev(self.dev)?;
        if let Some(sysfs_data) = sysfs_data {
            if Some(sysfs_data.parent) != self.dev.parent {
                debug!("Device exists under different parent - cannot run live update");
                res = Err(anyhow!(
                    "Device exists under different parent - cannot run live update"
                ));
            } else if Some(sysfs_data.mdev_type) != self.dev.mdev_type {
                debug!("Device exists with different type - cannot run live update");
                res = Err(anyhow!(
                    "Device exists with different type - cannot run live update"
                ));
            } else {
                self.script
                    .clone()
                    .unwrap()
                    .supports_event_action(Event::Live, Action::Modify)?;
                let conf = self.dev.to_json(false)?.to_string();
                res = self
                    .callout(
                        Event::Live,
                        Action::Modify,
                        Some(&conf),
                        &DefaultCheckProcessOutput,
                    )
                    .map(|_output| ());
                self.notify(Action::Modify);
            }
        } // else mdev is not active
        res
    }

    pub fn invoke<F>(&mut self, action: Action, force: bool, func: F) -> Result<()>
    where
        F: Fn(&mut Self) -> Result<()>,
    {
        self.script = self.find_callout_script();
        if self.script.is_none() {
            debug!("No callout script with version support found");
        }

        let conf = self.dev.to_json(false)?.to_string();
        let res = self
            .callout(Event::Pre, action, Some(&conf), &DefaultCheckProcessOutput)
            .map(|_output| ()) // can ignore output for general callouts
            .or_else(|e| {
                force
                    .then(|| {
                        warn!(
                            "Forcing operation '{}' despite callout failure. Error was: {}",
                            action, e
                        );
                    })
                    .ok_or(e)
            })
            .and_then(|_| {
                let tmp_res = func(self);
                self.state = match tmp_res {
                    Ok(_) => State::Success,
                    Err(_) => State::Failure,
                };

                let post_res =
                    self.callout(Event::Post, action, Some(&conf), &DefaultCheckProcessOutput);
                if post_res.is_err() {
                    debug!("Error occurred when executing post callout script");
                }

                tmp_res
            });

        self.notify(action);
        res
    }

    pub fn get_attributes(&mut self) -> Result<serde_json::Value> {
        self.script = self.find_callout_script();
        if self.script.is_none() {
            debug!("No callout script with version support found");
        }

        match self.callout(
            Event::Get,
            Action::Attributes,
            None,
            &DefaultCheckProcessOutput,
        )? {
            Some(output) => {
                if output.status.success() {
                    debug!("Get attributes successfully from callout script");
                    let mut st = String::from_utf8_lossy(&output.stdout).to_string();

                    if st.is_empty() {
                        debug!(
                            "Script output for {} is empty",
                            self.dev.uuid.hyphenated().to_string()
                        );
                        return Ok(serde_json::Value::Null);
                    }

                    if &st == "[{}]" {
                        debug!(
                            "Attribute field for {} is empty",
                            self.dev.uuid.hyphenated().to_string()
                        );
                        st = "[]".to_string();
                    }
                    debug!(
                        "Script output for {} is: '{}'",
                        self.dev.uuid.hyphenated().to_string(),
                        st
                    );
                    serde_json::from_str(st.trim_end_matches('\0'))
                        .with_context(|| "Invalid JSON received from callout script")
                } else {
                    let path = &self.script.as_ref().unwrap().path;
                    self.print_err(&output, path);

                    Err(invocation_failure(path, output.status.code()))
                }
            }
            None => {
                debug!(
                    "Script execution for {} returned without error but also without output",
                    self.dev.uuid.hyphenated().to_string()
                );
                Ok(serde_json::Value::Null)
            }
        }
    }

    fn invoke_script<P: AsRef<Path>>(
        &self,
        script: P,
        event: Event,
        action: Action,
        stdin: Option<&str>,
    ) -> Result<Output> {
        debug!(
            "{}-{}: executing {:?}",
            event,
            action,
            script.as_ref().as_os_str()
        );

        let mut cmd = Command::new(script.as_ref().as_os_str());

        cmd.arg("-t")
            .arg(self.dev.mdev_type()?)
            .arg("-e")
            .arg(event.to_string())
            .arg("-a")
            .arg(action.to_string())
            .arg("-s")
            .arg(self.state.to_string())
            .arg("-u")
            .arg(self.dev.uuid.to_string())
            .arg("-p")
            .arg(self.dev.parent()?)
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped());

        let mut child = cmd.spawn()?;

        if let Some(input) = stdin {
            if let Some(mut child_stdin) = child.stdin.take() {
                match child_stdin.write_all(input.as_bytes()) {
                    Ok(_) => (),
                    Err(e) if e.kind() == ErrorKind::BrokenPipe => {
                        debug!(
                            "Callout script {:?} closed stdin before all data was written",
                            script.as_ref().as_os_str()
                        )
                    }
                    Err(e) => Err(e).with_context(|| "Failed to write to stdin of command")?,
                }
            }
        }

        child.wait_with_output().map_err(anyhow::Error::from)
    }

    fn print_err<P: AsRef<Path>>(&self, output: &Output, script: P) {
        let sname = script
            .as_ref()
            .file_name()
            .unwrap_or_else(|| OsStr::new("unknown script name"))
            .to_string_lossy();

        let st = String::from_utf8_lossy(&output.stderr);
        if !st.is_empty() {
            eprint!("{}: {}", &sname, st);
        }
    }

    fn invoke_first_matching_script<P: AsRef<Path> + std::fmt::Debug>(
        &self,
        dir: P,
        event: Event,
        action: Action,
        stdin: Option<&str>,
        check_result_fn: impl Fn(PathBuf, Output) -> Result<(PathBuf, Output)>,
    ) -> Option<(PathBuf, Output)> {
        debug!(
            "{}-{}: looking for a matching callout script for dev type '{}' in {:?}",
            event,
            action,
            self.dev.mdev_type.as_ref()?,
            dir
        );

        let mut sorted_paths = dir
            .as_ref()
            .read_dir()
            .ok()?
            .filter_map(|k| k.ok().map(|e| e.path()))
            .collect::<Vec<_>>();

        sorted_paths.sort();

        for path in sorted_paths {
            match self.invoke_script(&path, event, action, stdin) {
                Ok(res) => {
                    if res.status.code().is_none() {
                        warn!("callout script {:?} was terminated by a signal", path);
                        continue;
                    } else if res.status.code() == Some(2) {
                        debug!(
                            "callout script {:?} does not match device type {:?}",
                            path,
                            self.dev.mdev_type().ok()?
                        );
                    } else {
                        debug!(
                            "found callout script {:?} matching device type {:?}",
                            path,
                            self.dev.mdev_type().ok()?
                        );
                        match check_result_fn(path, res) {
                            Ok((p, r)) => return Some((p, r)),
                            Err(_) => {
                                debug!("found callout script rejected by check_result method");
                                continue;
                            }
                        }
                    }
                }
                Err(e) => {
                    debug!("failed to execute callout script {:?}: {:?}", path, e);
                    continue;
                }
            }
        }
        None
    }

    fn callout(
        &mut self,
        event: Event,
        action: Action,
        stdin: Option<&str>,
        check_process: &dyn CheckProcessOutput,
    ) -> Result<Option<Output>> {
        match self.script {
            Some(ref s) => {
                s.supports_event_action(event, action)?;
                let output = self.invoke_script(s, event, action, stdin)?;
                self.print_err(&output, s);
                match output.status.code() {
                    None | Some(0) => Ok(Some(output)),
                    Some(n) => Err(invocation_failure(&s.path, Some(n))),
                }
            }
            None => {
                let mut res = Ok(None);
                for dir in self.dev.env.callout_dirs() {
                    if !dir.is_dir() {
                        continue;
                    }
                    let r = match self.invoke_first_matching_script(
                        dir,
                        event,
                        action,
                        stdin,
                        |p, o| check_process.check(p, o),
                    ) {
                        Some((p, o)) => match check_process.process(self, p, o)? {
                            Some(o) => Ok(Some(o)),
                            None => continue,
                        },
                        None => continue,
                    };

                    res = r;
                    break;
                }
                res
            }
        }
    }

    fn notify(&mut self, action: Action) {
        let event = Event::Notify;
        let dirs = self.dev.env.notification_dirs();
        debug!(
            "{}-{}: executing notification scripts for device {}",
            event, action, self.dev.uuid
        );

        for dir in dirs {
            if !dir.is_dir() {
                continue;
            }

            if let Ok(readdir) = dir.read_dir() {
                for path in readdir.filter_map(|x| x.ok().map(|y| y.path())) {
                    match self.invoke_script(&path, event, action, None) {
                        Ok(output) => {
                            if !output.status.success() {
                                debug!("Error occurred when executing notify script {:?}", path);
                            }
                        }
                        _ => {
                            debug!("Failed to execute callout script {:?}", path);
                            continue;
                        }
                    }
                }
            }
        }
    }
}