|
| 1 | +//! External processor support |
| 2 | +//! |
| 3 | +//! Via the command line argument `--processors` you can instruct espflash to run external executables to pre-process |
| 4 | +//! the logs received from the target. Multiple processors are supported by separating them via `,`. Processors are executed in the specified order. |
| 5 | +//! |
| 6 | +//! You can use full-qualified paths or run an executable which is already in the search path. |
| 7 | +//! |
| 8 | +//! A processors reads from stdin and output to stdout. Be aware this runs before further processing by espflash. |
| 9 | +//! i.e. addresses are not resolved and when using `defmt` you will see encoded data. |
| 10 | +//! |
| 11 | +//! Additionally be aware that you might receive chunked data which is not always split at valid UTF character boundaries. |
| 12 | +//! |
| 13 | +//! The executable will get the path of the ELF file as the first argument if available. |
| 14 | +//! |
| 15 | +//! Example processor which turns some letters into uppercase |
| 16 | +//! ```rust,no-run |
| 17 | +//! use std::io::{stdin, stdout, Read, Write}; |
| 18 | +//! |
| 19 | +//! fn main() { |
| 20 | +//! let args: Vec<String> = std::env::args().collect(); |
| 21 | +//! println!("ELF file: {:?}", args[1]); |
| 22 | +//! |
| 23 | +//! let mut buf = [0u8; 1024]; |
| 24 | +//! loop { |
| 25 | +//! if let Ok(len) = stdin().read(&mut buf) { |
| 26 | +//! for b in &mut buf[..len] { |
| 27 | +//! *b = if b"abdfeo".contains(b) { |
| 28 | +//! b.to_ascii_uppercase() |
| 29 | +//! } else { |
| 30 | +//! *b |
| 31 | +//! }; |
| 32 | +//! } |
| 33 | +//! |
| 34 | +//! stdout().write(&buf[..len]).unwrap(); |
| 35 | +//! stdout().flush().unwrap(); |
| 36 | +//! } else { |
| 37 | +//! // ignored |
| 38 | +//! } |
| 39 | +//! } |
| 40 | +//! } |
| 41 | +//! ``` |
| 42 | +
|
| 43 | +use std::{ |
| 44 | + fmt::Display, |
| 45 | + io::{Read, Write}, |
| 46 | + path::PathBuf, |
| 47 | + process::{Child, ChildStdin, Stdio}, |
| 48 | + sync::mpsc, |
| 49 | +}; |
| 50 | + |
| 51 | +use miette::Diagnostic; |
| 52 | + |
| 53 | +#[derive(Debug)] |
| 54 | +pub struct Error { |
| 55 | + executable: String, |
| 56 | +} |
| 57 | + |
| 58 | +impl Display for Error { |
| 59 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 60 | + write!(f, "Failed to launch '{}'", self.executable) |
| 61 | + } |
| 62 | +} |
| 63 | + |
| 64 | +impl std::error::Error for Error {} |
| 65 | + |
| 66 | +impl Diagnostic for Error {} |
| 67 | + |
| 68 | +struct Processor { |
| 69 | + rx: mpsc::Receiver<u8>, |
| 70 | + stdin: ChildStdin, |
| 71 | + child: Child, |
| 72 | +} |
| 73 | + |
| 74 | +impl Processor { |
| 75 | + pub fn new(child: Child) -> Self { |
| 76 | + let mut child = child; |
| 77 | + let (tx, rx) = mpsc::channel::<u8>(); |
| 78 | + |
| 79 | + let mut stdout = child.stdout.take().unwrap(); |
| 80 | + let stdin = child.stdin.take().unwrap(); |
| 81 | + |
| 82 | + std::thread::spawn(move || { |
| 83 | + let mut buffer = [0u8; 1024]; |
| 84 | + loop { |
| 85 | + if let Ok(len) = stdout.read(&mut buffer) { |
| 86 | + for b in &buffer[..len] { |
| 87 | + if tx.send(*b).is_err() { |
| 88 | + break; |
| 89 | + } |
| 90 | + } |
| 91 | + } |
| 92 | + } |
| 93 | + }); |
| 94 | + |
| 95 | + Self { rx, stdin, child } |
| 96 | + } |
| 97 | + |
| 98 | + pub fn try_receive(&mut self) -> Vec<u8> { |
| 99 | + let mut res = Vec::new(); |
| 100 | + while let Ok(b) = self.rx.try_recv() { |
| 101 | + res.push(b); |
| 102 | + } |
| 103 | + res |
| 104 | + } |
| 105 | + |
| 106 | + pub fn send(&mut self, data: Vec<u8>) { |
| 107 | + self.stdin.write(&data).ok(); |
| 108 | + } |
| 109 | +} |
| 110 | + |
| 111 | +impl Drop for Processor { |
| 112 | + fn drop(&mut self) { |
| 113 | + self.child.kill().unwrap(); |
| 114 | + } |
| 115 | +} |
| 116 | + |
| 117 | +pub struct ExternalProcessors { |
| 118 | + processors: Vec<Processor>, |
| 119 | +} |
| 120 | + |
| 121 | +impl ExternalProcessors { |
| 122 | + pub fn new(processors: Option<String>, elf: Option<PathBuf>) -> Result<Self, Error> { |
| 123 | + let mut args = Vec::new(); |
| 124 | + |
| 125 | + if let Some(elf) = elf { |
| 126 | + args.push(elf.as_os_str().to_str().unwrap().to_string()); |
| 127 | + }; |
| 128 | + |
| 129 | + let mut spawned = Vec::new(); |
| 130 | + if let Some(processors) = processors { |
| 131 | + for processor in processors.split(",").into_iter() { |
| 132 | + let processor = std::process::Command::new(processor) |
| 133 | + .args(args.clone()) |
| 134 | + .stdin(Stdio::piped()) |
| 135 | + .stdout(Stdio::piped()) |
| 136 | + .stderr(Stdio::inherit()) |
| 137 | + .spawn() |
| 138 | + .map_err(|_| Error { |
| 139 | + executable: processor.to_string(), |
| 140 | + })?; |
| 141 | + spawned.push(Processor::new(processor)); |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + Ok(Self { |
| 146 | + processors: spawned, |
| 147 | + }) |
| 148 | + } |
| 149 | + |
| 150 | + pub fn process(&mut self, read: &[u8]) -> Vec<u8> { |
| 151 | + let mut buffer = Vec::new(); |
| 152 | + buffer.extend_from_slice(read); |
| 153 | + |
| 154 | + for processor in &mut self.processors { |
| 155 | + processor.send(buffer); |
| 156 | + buffer = processor.try_receive(); |
| 157 | + } |
| 158 | + |
| 159 | + buffer |
| 160 | + } |
| 161 | +} |
0 commit comments