1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
#[cfg(feature = "libpanda")]
mod qcows;
use crate::PandaArgs;
use std::fmt;
use std::sync::atomic::{AtomicBool, Ordering};
#[cfg(feature = "libpanda")]
use std::{ffi::CString, mem::transmute, os::raw::c_char, sync::Mutex};
#[cfg(feature = "libpanda")]
use crate::{
inventory,
sys::{self, panda_init, panda_run, panda_set_library_mode},
InternalCallback, PPPCallbackSetup,
};
/// Architecture of the guest system
#[allow(non_camel_case_types)]
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum Arch {
i386,
x86_64,
Arm,
Mips,
AArch64,
}
// TODO: tie architecture to architecture being compiled for?
impl fmt::Display for Arch {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"{}",
match self {
Self::i386 => "i386",
Self::x86_64 => "x86_64",
Self::Arm => "arm",
Self::Mips => "mips",
Self::AArch64 => "aarch64",
}
)
}
}
/// Builder for creating PANDA instances. Only for use in libpanda mode.
#[derive(Default)]
#[allow(dead_code)]
pub struct Panda {
expect_prompt: Option<String>,
generic_qcow: Option<String>,
os_version: Option<String>,
qcow: Option<String>,
raw_monitor: bool,
graphics: bool,
os: String,
mem: Option<String>,
arch: Option<Arch>,
extra_args: Vec<String>,
replay: Option<String>,
configurable: bool,
}
static LIBRARY_STARTED: AtomicBool = AtomicBool::new(false);
#[cfg(feature = "libpanda")]
lazy_static::lazy_static! {
static ref AFTER_INIT_FUNCS: Mutex<Vec<Box<dyn FnOnce() + Send + Sync + 'static>>>
= Mutex::new(Vec::new());
}
impl Panda {
/// Get whether or not libpanda has started running yet
fn is_started() -> bool {
LIBRARY_STARTED.load(Ordering::Relaxed)
}
/// Create a new PANDA instance.
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .generic("x86_64")
/// .run();
/// ```
pub fn new() -> Self {
Self {
os: "linux".into(),
..Default::default()
}
}
/// Add an argument for PANDA
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .arg("-nomonitor")
/// .run();
/// ```
pub fn arg<S: Into<String>>(&mut self, arg: S) -> &mut Self {
self.extra_args.push(arg.into());
self
}
/// Add a set of extra arguments for PANDA
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .args(&["-panda", "callstack_instr"])
/// .run();
/// ```
pub fn args<I, S>(&mut self, args: I) -> &mut Self
where
I: IntoIterator<Item = S>,
S: AsRef<str>,
{
for arg in args {
self.arg(arg.as_ref());
}
self
}
/// Sets the architecture of the guest
///
/// ### Example
/// ```rust
/// # use panda::{prelude::*, Arch};
/// Panda::new()
/// .arch(Arch::i386)
/// .run();
/// ```
pub fn arch(&mut self, arch: Arch) -> &mut Self {
self.arch = Some(arch);
self
}
/// Set the machine to PANDA's configurable machine
///
/// ### Example
/// ```rust
/// # use panda::{prelude::*, Arch};
/// Panda::new()
/// .configurable()
/// .run();
/// ```
pub fn configurable(&mut self) -> &mut Self {
self.configurable = true;
self
}
// Don't pass `-nographic` to QEMU, allowing you use to use a monitor
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .enable_graphics()
/// .run();
/// ```
pub fn enable_graphics(&mut self) -> &mut Self {
self.graphics = true;
self
}
/// Regular expression describing the prompt exposed by the guest on a serial console. Used in
/// order to know when running a command has finished with its output.
pub fn expect_prompt<S: Into<String>>(&mut self, prompt_regex: S) -> &mut Self {
self.expect_prompt = Some(prompt_regex.into());
self
}
/// Set the available memory. If restoring from a snapshot or viewing a replay, this must be
/// the same as when the replay/snapshot was taken.
pub fn mem<S: Into<String>>(&mut self, mem: S) -> &mut Self {
self.mem = Some(mem.into());
self
}
/// Use generic PANDA Qcow for run
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .generic("x86_64")
/// .run();
/// ```
pub fn generic<S: Into<String>>(&mut self, generic: S) -> &mut Self {
self.generic_qcow = Some(generic.into());
self
}
/// Run the given replay in the PANDA instance. Equivalent to `-replay [name]` from the PANDA
/// command line.
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .replay("grep_recording")
/// .run();
/// ```
pub fn replay<S: Into<String>>(&mut self, replay: S) -> &mut Self {
self.replay = Some(replay.into());
self
}
/// Load a plugin with args provided by a `PandaArgs` struct.
///
/// ### Example
///
/// ```rust
/// use panda::prelude::*;
///
/// #[derive(PandaArgs)]
/// #[name = "stringsearch"]
/// struct StringSearch {
/// str: String
/// }
///
/// fn main() {
/// Panda::new()
/// .generic("x86_64")
/// .replay("test")
/// .plugin_args(&StringSearch {
/// str: "test".into()
/// })
/// .run();
/// }
/// ```
pub fn plugin_args<T: PandaArgs>(&mut self, args: &T) -> &mut Self {
self.arg("-panda").arg(args.to_panda_args_str())
}
#[cfg(feature = "libpanda")]
fn get_args(&self) -> Vec<String> {
let generic_info = self
.generic_qcow
.as_ref()
.map(|generic| qcows::get_supported_image(generic));
let qcow_path = self.qcow.clone().map(Some).unwrap_or_else(|| {
self.generic_qcow
.as_ref()
.map(|generic| qcows::get_generic_path(generic).display().to_string())
});
let _arch = self
.arch
.or_else(|| generic_info.as_ref().map(|x| x.arch))
.unwrap_or(Arch::x86_64);
let mem = self
.mem
.as_ref()
.map(|x| &x[..])
.or_else(|| generic_info.as_ref().map(|x| x.default_mem))
.unwrap_or("128M")
.to_owned();
let mut args = vec![
"".into(), // filler, argv[0] == path of executable, n/a
"-L".into(),
std::env::var("PANDA_PATH")
.expect("PANDA_PATH not set. Set it to panda's build folder.")
+ "/pc-bios",
"-m".into(),
mem,
];
if let Some(qcow) = qcow_path {
args.push(qcow)
}
if let Some(generic) = generic_info {
args.push("-os".into());
args.push(generic.os.into());
}
if self.configurable {
args.push("-M".into());
args.push("configurable".into());
}
if !self.graphics {
args.push("-nographic".into());
}
if let Some(replay) = &self.replay {
args.push("-replay".into());
args.push(replay.clone());
}
args.extend(self.extra_args.clone().into_iter());
args
}
/// Start the PANDA instance with the given settings. This is a blocking operation.
///
/// ### Example
/// ```rust
/// # use panda::prelude::*;
/// Panda::new()
/// .generic("x86_64")
/// .run();
/// ```
pub fn run(&mut self) {
#[cfg(not(feature = "libpanda"))]
{
panic!("Panda::run cannot be used without the libpanda feature");
}
#[cfg(feature = "libpanda")]
{
let args = self.get_args();
println!("Running with args: {:?}", args);
let args: Vec<_> = args.into_iter().map(|x| CString::new(x).unwrap()).collect();
let args_ptrs: Vec<_> = args.iter().map(|s| s.as_ptr()).collect();
std::env::set_var("PANDA_DIR", std::env::var("PANDA_PATH").unwrap());
let x = &mut 0i8;
let empty = &mut (x as *mut c_char);
unsafe {
for cb in inventory::iter::<InternalCallback> {
sys::panda_register_callback(
self as *mut _ as _,
cb.cb_type,
::core::mem::transmute(cb.fn_pointer),
);
}
if LIBRARY_STARTED.swap(true, Ordering::Relaxed) {
panic!("libpanda cannot be run twice in the same process");
}
panda_set_library_mode(true);
panda_init(args_ptrs.len() as i32, transmute(args_ptrs.as_ptr()), empty);
for cb in inventory::iter::<PPPCallbackSetup> {
cb.0();
}
let mut init_funcs = Vec::new();
core::mem::swap(&mut *AFTER_INIT_FUNCS.lock().unwrap(), &mut init_funcs);
for init_func in init_funcs {
init_func()
}
panda_run();
LIBRARY_STARTED.store(false, Ordering::Relaxed);
}
}
}
/// Queue up a function that should run before libpanda has started but after
/// the libpanda has been initialized. If run under a plugin context (e.g. no
/// libpanda), or libpanda is currently running, then the function will run immediately.
///
/// This is useful for functions that may require waiting until things like arguments
/// or OS has been set, such as setting up an OSI callback.
pub fn run_after_init(func: impl FnOnce() + Send + Sync + 'static) {
if cfg!(feature = "libpanda") && !Panda::is_started() {
#[cfg(feature = "libpanda")]
{
AFTER_INIT_FUNCS.lock().unwrap().push(Box::new(func));
}
} else {
func()
}
}
}