src/server/worker_task.rs

   1 use std::collections::{HashMap, VecDeque};
   2 use std::fs::File;
   3 use std::io::{Read, Write, BufRead, BufReader};
   4 use std::panic::UnwindSafe;
   5 use std::sync::atomic::{AtomicBool, Ordering};
   6 use std::sync::{Arc, Mutex};
   7
   8 use anyhow::{bail, format_err, Error};
   9 use futures::*;
  10 use lazy_static::lazy_static;
  11 use serde_json::{json, Value};
  12 use serde::{Serialize, Deserialize};
  13 use tokio::sync::oneshot;
  14
  15 use proxmox::sys::linux::procfs;
  16 use proxmox::try_block;
  17 use proxmox::tools::fs::{create_path, open_file_locked, replace_file, CreateOptions};
  18
  19 use super::UPID;
  20
  21 use crate::buildcfg;
  22 use crate::server;
  23 use crate::tools::logrotate::{LogRotate, LogRotateFiles};
  24 use crate::tools::{FileLogger, FileLogOptions};
  25 use crate::api2::types::{Authid, TaskStateType};
  26
  27 macro_rules! taskdir {
  28     ($subdir:expr) => (concat!(PROXMOX_BACKUP_LOG_DIR_M!(), "/tasks", $subdir))
  29 }
  30 pub const PROXMOX_BACKUP_TASK_DIR: &str = taskdir!("/");
  31 pub const PROXMOX_BACKUP_TASK_LOCK_FN: &str = taskdir!("/.active.lock");
  32 pub const PROXMOX_BACKUP_ACTIVE_TASK_FN: &str = taskdir!("/active");
  33 pub const PROXMOX_BACKUP_INDEX_TASK_FN: &str = taskdir!("/index");
  34 pub const PROXMOX_BACKUP_ARCHIVE_TASK_FN: &str = taskdir!("/archive");
  35
  36 lazy_static! {
  37     static ref WORKER_TASK_LIST: Mutex<HashMap<usize, Arc<WorkerTask>>> = Mutex::new(HashMap::new());
  38 }
  39
  40 /// checks if the task UPID refers to a worker from this process
  41 fn is_local_worker(upid: &UPID) -> bool {
  42     upid.pid == server::pid() && upid.pstart == server::pstart()
  43 }
  44
  45 /// Test if the task is still running
  46 pub async fn worker_is_active(upid: &UPID) -> Result<bool, Error> {
  47     if is_local_worker(upid) {
  48         return Ok(WORKER_TASK_LIST.lock().unwrap().contains_key(&upid.task_id));
  49     }
  50
  51     if !procfs::check_process_running_pstart(upid.pid, upid.pstart).is_some() {
  52         return Ok(false);
  53     }
  54
  55     let sock = server::ctrl_sock_from_pid(upid.pid);
  56     let cmd = json!({
  57         "command": "worker-task-status",
  58         "args": {
  59             "upid": upid.to_string(),
  60         },
  61     });
  62     let status = super::send_command(sock, cmd).await?;
  63
  64     if let Some(active) = status.as_bool() {
  65         Ok(active)
  66     } else {
  67         bail!("got unexpected result {:?} (expected bool)", status);
  68     }
  69 }
  70
  71 /// Test if the task is still running (fast but inaccurate implementation)
  72 ///
  73 /// If the task is spawned from a different process, we simply return if
  74 /// that process is still running. This information is good enough to detect
  75 /// stale tasks...
  76 pub fn worker_is_active_local(upid: &UPID) -> bool {
  77     if is_local_worker(upid) {
  78         WORKER_TASK_LIST.lock().unwrap().contains_key(&upid.task_id)
  79     } else {
  80         procfs::check_process_running_pstart(upid.pid, upid.pstart).is_some()
  81     }
  82 }
  83
  84 pub fn register_task_control_commands(
  85     commando_sock: &mut super::CommandoSocket,
  86 ) -> Result<(), Error> {
  87     fn get_upid(args: Option<&Value>) -> Result<UPID, Error> {
  88         let args = if let Some(args) = args { args } else { bail!("missing args") };
  89         let upid = match args.get("upid") {
  90             Some(Value::String(upid)) => upid.parse::<UPID>()?,
  91             None => bail!("no upid in args"),
  92             _ => bail!("unable to parse upid"),
  93         };
  94         if !is_local_worker(&upid) {
  95             bail!("upid does not belong to this process");
  96         }
  97         Ok(upid)
  98     }
  99
 100     commando_sock.register_command("worker-task-abort".into(), move |args| {
 101         let upid = get_upid(args)?;
 102
 103         if let Some(ref worker) = WORKER_TASK_LIST.lock().unwrap().get(&upid.task_id) {
 104             worker.request_abort();
 105         }
 106         Ok(Value::Null)
 107     })?;
 108     commando_sock.register_command("worker-task-status".into(), move |args| {
 109         let upid = get_upid(args)?;
 110
 111         let active = WORKER_TASK_LIST.lock().unwrap().contains_key(&upid.task_id);
 112
 113         Ok(active.into())
 114     })?;
 115
 116     Ok(())
 117 }
 118
 119 pub fn abort_worker_async(upid: UPID) {
 120     tokio::spawn(async move {
 121         if let Err(err) = abort_worker(upid).await {
 122             eprintln!("abort worker failed - {}", err);
 123         }
 124     });
 125 }
 126
 127 pub async fn abort_worker(upid: UPID) -> Result<(), Error> {
 128
 129     let sock = server::ctrl_sock_from_pid(upid.pid);
 130     let cmd = json!({
 131         "command": "worker-task-abort",
 132         "args": {
 133             "upid": upid.to_string(),
 134         },
 135     });
 136     super::send_command(sock, cmd).map_ok(|_| ()).await
 137 }
 138
 139 fn parse_worker_status_line(line: &str) -> Result<(String, UPID, Option<TaskState>), Error> {
 140
 141     let data = line.splitn(3, ' ').collect::<Vec<&str>>();
 142
 143     let len = data.len();
 144
 145     match len {
 146         1 => Ok((data[0].to_owned(), data[0].parse::<UPID>()?, None)),
 147         3 => {
 148             let endtime = i64::from_str_radix(data[1], 16)?;
 149             let state = TaskState::from_endtime_and_message(endtime, data[2])?;
 150             Ok((data[0].to_owned(), data[0].parse::<UPID>()?, Some(state)))
 151         }
 152         _ => bail!("wrong number of components"),
 153     }
 154 }
 155
 156 /// Create task log directory with correct permissions
 157 pub fn create_task_log_dirs() -> Result<(), Error> {
 158
 159     try_block!({
 160         let backup_user = crate::backup::backup_user()?;
 161         let opts = CreateOptions::new()
 162             .owner(backup_user.uid)
 163             .group(backup_user.gid);
 164
 165         create_path(buildcfg::PROXMOX_BACKUP_LOG_DIR, None, Some(opts.clone()))?;
 166         create_path(PROXMOX_BACKUP_TASK_DIR, None, Some(opts.clone()))?;
 167         create_path(buildcfg::PROXMOX_BACKUP_RUN_DIR, None, Some(opts))?;
 168         Ok(())
 169     }).map_err(|err: Error| format_err!("unable to create task log dir - {}", err))?;
 170
 171     Ok(())
 172 }
 173
 174 /// Read endtime (time of last log line) and exitstatus from task log file
 175 /// If there is not a single line with at valid datetime, we assume the
 176 /// starttime to be the endtime
 177 pub fn upid_read_status(upid: &UPID) -> Result<TaskState, Error> {
 178
 179     let mut status = TaskState::Unknown { endtime: upid.starttime };
 180
 181     let path = upid.log_path();
 182
 183     let mut file = File::open(path)?;
 184
 185     /// speedup - only read tail
 186     use std::io::Seek;
 187     use std::io::SeekFrom;
 188     let _ = file.seek(SeekFrom::End(-8192)); // ignore errors
 189
 190     let mut data = Vec::with_capacity(8192);
 191     file.read_to_end(&mut data)?;
 192
 193     // task logs should end with newline, we do not want it here
 194     if data.len() > 0 && data[data.len()-1] == b'\n' {
 195         data.pop();
 196     }
 197
 198     let last_line = {
 199         let mut start = 0;
 200         for pos in (0..data.len()).rev() {
 201             if data[pos] == b'\n' {
 202                 start = data.len().min(pos + 1);
 203                 break;
 204             }
 205         }
 206         &data[start..]
 207     };
 208
 209     let last_line = std::str::from_utf8(last_line)
 210         .map_err(|err| format_err!("upid_read_status: utf8 parse failed: {}", err))?;
 211
 212     let mut iter = last_line.splitn(2, ": ");
 213     if let Some(time_str) = iter.next() {
 214         if let Ok(endtime) = proxmox::tools::time::parse_rfc3339(time_str) {
 215             if let Some(rest) = iter.next().and_then(|rest| rest.strip_prefix("TASK ")) {
 216                 if let Ok(state) = TaskState::from_endtime_and_message(endtime, rest) {
 217                     status = state;
 218                 }
 219             }
 220         }
 221     }
 222
 223     Ok(status)
 224 }
 225
 226 /// Task State
 227 #[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
 228 pub enum TaskState {
 229     /// The Task ended with an undefined state
 230     Unknown { endtime: i64 },
 231     /// The Task ended and there were no errors or warnings
 232     OK { endtime: i64 },
 233     /// The Task had 'count' amount of warnings and no errors
 234     Warning { count: u64, endtime: i64 },
 235     /// The Task ended with the error described in 'message'
 236     Error { message: String, endtime: i64 },
 237 }
 238
 239 impl TaskState {
 240     pub fn endtime(&self) -> i64 {
 241         match *self {
 242             TaskState::Unknown { endtime } => endtime,
 243             TaskState::OK { endtime } => endtime,
 244             TaskState::Warning { endtime, .. } => endtime,
 245             TaskState::Error { endtime, .. } => endtime,
 246         }
 247     }
 248
 249     pub fn tasktype(&self) -> TaskStateType {
 250         match self {
 251             TaskState::OK { .. } => TaskStateType::OK,
 252             TaskState::Unknown { .. } => TaskStateType::Unknown,
 253             TaskState::Error { .. } => TaskStateType::Error,
 254             TaskState::Warning { .. } => TaskStateType::Warning,
 255         }
 256     }
 257
 258     fn result_text(&self) -> String {
 259         match self {
 260             TaskState::Error { message, .. } => format!("TASK ERROR: {}", message),
 261             other => format!("TASK {}", other),
 262         }
 263     }
 264
 265     fn from_endtime_and_message(endtime: i64, s: &str) -> Result<Self, Error> {
 266         if s == "unknown" {
 267             Ok(TaskState::Unknown { endtime })
 268         } else if s == "OK" {
 269             Ok(TaskState::OK { endtime })
 270         } else if s.starts_with("WARNINGS: ") {
 271             let count: u64 = s[10..].parse()?;
 272             Ok(TaskState::Warning{ count, endtime })
 273         } else if s.len() > 0 {
 274             let message = if s.starts_with("ERROR: ") { &s[7..] } else { s }.to_string();
 275             Ok(TaskState::Error{ message, endtime })
 276         } else {
 277             bail!("unable to parse Task Status '{}'", s);
 278         }
 279     }
 280 }
 281
 282 impl std::cmp::PartialOrd for TaskState {
 283     fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
 284         Some(self.endtime().cmp(&other.endtime()))
 285     }
 286 }
 287
 288 impl std::cmp::Ord for TaskState {
 289     fn cmp(&self, other: &Self) -> std::cmp::Ordering {
 290         self.endtime().cmp(&other.endtime())
 291     }
 292 }
 293
 294 impl std::fmt::Display for TaskState {
 295     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 296         match self {
 297             TaskState::Unknown { .. } => write!(f, "unknown"),
 298             TaskState::OK { .. }=> write!(f, "OK"),
 299             TaskState::Warning { count, .. } => write!(f, "WARNINGS: {}", count),
 300             TaskState::Error { message, .. } => write!(f, "{}", message),
 301         }
 302     }
 303 }
 304
 305 /// Task details including parsed UPID
 306 ///
 307 /// If there is no `state`, the task is still running.
 308 #[derive(Debug)]
 309 pub struct TaskListInfo {
 310     /// The parsed UPID
 311     pub upid: UPID,
 312     /// UPID string representation
 313     pub upid_str: String,
 314     /// Task `(endtime, status)` if already finished
 315     pub state: Option<TaskState>, // endtime, status
 316 }
 317
 318 fn lock_task_list_files(exclusive: bool) -> Result<std::fs::File, Error> {
 319     let backup_user = crate::backup::backup_user()?;
 320
 321     let lock = open_file_locked(PROXMOX_BACKUP_TASK_LOCK_FN, std::time::Duration::new(10, 0), exclusive)?;
 322     nix::unistd::chown(PROXMOX_BACKUP_TASK_LOCK_FN, Some(backup_user.uid), Some(backup_user.gid))?;
 323
 324     Ok(lock)
 325 }
 326
 327 /// checks if the Task Archive is bigger that 'size_threshold' bytes, and
 328 /// rotates it if it is
 329 pub fn rotate_task_log_archive(size_threshold: u64, compress: bool, max_files: Option<usize>) -> Result<bool, Error> {
 330     let _lock = lock_task_list_files(true)?;
 331
 332     let mut logrotate = LogRotate::new(PROXMOX_BACKUP_ARCHIVE_TASK_FN, compress)
 333         .ok_or(format_err!("could not get archive file names"))?;
 334
 335     logrotate.rotate(size_threshold, None, max_files)
 336 }
 337
 338 // atomically read/update the task list, update status of finished tasks
 339 // new_upid is added to the list when specified.
 340 fn update_active_workers(new_upid: Option<&UPID>) -> Result<(), Error> {
 341
 342     let backup_user = crate::backup::backup_user()?;
 343
 344     let lock = lock_task_list_files(true)?;
 345
 346     // TODO remove with 1.x
 347     let mut finish_list: Vec<TaskListInfo> = read_task_file_from_path(PROXMOX_BACKUP_INDEX_TASK_FN)?;
 348     let had_index_file = !finish_list.is_empty();
 349
 350     // We use filter_map because one negative case wants to *move* the data into `finish_list`,
 351     // clippy doesn't quite catch this!
 352     #[allow(clippy::unnecessary_filter_map)]
 353     let mut active_list: Vec<TaskListInfo> = read_task_file_from_path(PROXMOX_BACKUP_ACTIVE_TASK_FN)?
 354         .into_iter()
 355         .filter_map(|info| {
 356             if info.state.is_some() {
 357                 // this can happen when the active file still includes finished tasks
 358                 finish_list.push(info);
 359                 return None;
 360             }
 361
 362             if !worker_is_active_local(&info.upid) {
 363                 // println!("Detected stopped task '{}'", &info.upid_str);
 364                 let now = proxmox::tools::time::epoch_i64();
 365                 let status = upid_read_status(&info.upid)
 366                     .unwrap_or_else(|_| TaskState::Unknown { endtime: now });
 367                 finish_list.push(TaskListInfo {
 368                     upid: info.upid,
 369                     upid_str: info.upid_str,
 370                     state: Some(status)
 371                 });
 372                 return None;
 373             }
 374
 375             Some(info)
 376         }).collect();
 377
 378     if let Some(upid) = new_upid {
 379         active_list.push(TaskListInfo { upid: upid.clone(), upid_str: upid.to_string(), state: None });
 380     }
 381
 382     let active_raw = render_task_list(&active_list);
 383
 384     replace_file(
 385         PROXMOX_BACKUP_ACTIVE_TASK_FN,
 386         active_raw.as_bytes(),
 387         CreateOptions::new()
 388             .owner(backup_user.uid)
 389             .group(backup_user.gid),
 390     )?;
 391
 392     finish_list.sort_unstable_by(|a, b| {
 393         match (&a.state, &b.state) {
 394             (Some(s1), Some(s2)) => s1.cmp(&s2),
 395             (Some(_), None) => std::cmp::Ordering::Less,
 396             (None, Some(_)) => std::cmp::Ordering::Greater,
 397             _ => a.upid.starttime.cmp(&b.upid.starttime),
 398         }
 399     });
 400
 401     if !finish_list.is_empty() {
 402         match std::fs::OpenOptions::new().append(true).create(true).open(PROXMOX_BACKUP_ARCHIVE_TASK_FN) {
 403             Ok(mut writer) => {
 404                 for info in &finish_list {
 405                     writer.write_all(render_task_line(&info).as_bytes())?;
 406                 }
 407             },
 408             Err(err) => bail!("could not write task archive - {}", err),
 409         }
 410
 411         nix::unistd::chown(PROXMOX_BACKUP_ARCHIVE_TASK_FN, Some(backup_user.uid), Some(backup_user.gid))?;
 412     }
 413
 414     // TODO Remove with 1.x
 415     // for compatibility, if we had an INDEX file, we do not need it anymore
 416     if had_index_file {
 417         let _ = nix::unistd::unlink(PROXMOX_BACKUP_INDEX_TASK_FN);
 418     }
 419
 420     drop(lock);
 421
 422     Ok(())
 423 }
 424
 425 fn render_task_line(info: &TaskListInfo) -> String {
 426     let mut raw = String::new();
 427     if let Some(status) = &info.state {
 428         raw.push_str(&format!("{} {:08X} {}\n", info.upid_str, status.endtime(), status));
 429     } else {
 430         raw.push_str(&info.upid_str);
 431         raw.push('\n');
 432     }
 433
 434     raw
 435 }
 436
 437 fn render_task_list(list: &[TaskListInfo]) -> String {
 438     let mut raw = String::new();
 439     for info in list {
 440         raw.push_str(&render_task_line(&info));
 441     }
 442     raw
 443 }
 444
 445 // note this is not locked, caller has to make sure it is
 446 // this will skip (and log) lines that are not valid status lines
 447 fn read_task_file<R: Read>(reader: R) -> Result<Vec<TaskListInfo>, Error>
 448 {
 449     let reader = BufReader::new(reader);
 450     let mut list = Vec::new();
 451     for line in reader.lines() {
 452         let line = line?;
 453         match parse_worker_status_line(&line) {
 454             Ok((upid_str, upid, state)) => list.push(TaskListInfo {
 455                 upid_str,
 456                 upid,
 457                 state
 458             }),
 459             Err(err) => {
 460                 eprintln!("unable to parse worker status '{}' - {}", line, err);
 461                 continue;
 462             }
 463         };
 464     }
 465
 466     Ok(list)
 467 }
 468
 469 // note this is not locked, caller has to make sure it is
 470 fn read_task_file_from_path<P>(path: P) -> Result<Vec<TaskListInfo>, Error>
 471 where
 472     P: AsRef<std::path::Path> + std::fmt::Debug,
 473 {
 474     let file = match File::open(&path) {
 475         Ok(f) => f,
 476         Err(err) if err.kind() == std::io::ErrorKind::NotFound => return Ok(Vec::new()),
 477         Err(err) => bail!("unable to open task list {:?} - {}", path, err),
 478     };
 479
 480     read_task_file(file)
 481 }
 482
 483 pub struct TaskListInfoIterator {
 484     list: VecDeque<TaskListInfo>,
 485     end: bool,
 486     archive: Option<LogRotateFiles>,
 487     lock: Option<File>,
 488 }
 489
 490 impl TaskListInfoIterator {
 491     pub fn new(active_only: bool) -> Result<Self, Error> {
 492         let (read_lock, active_list) = {
 493             let lock = lock_task_list_files(false)?;
 494             let active_list = read_task_file_from_path(PROXMOX_BACKUP_ACTIVE_TASK_FN)?;
 495
 496             let needs_update = active_list
 497                 .iter()
 498                 .any(|info| info.state.is_some() || !worker_is_active_local(&info.upid));
 499
 500             // TODO remove with 1.x
 501             let index_exists = std::path::Path::new(PROXMOX_BACKUP_INDEX_TASK_FN).is_file();
 502
 503             if needs_update || index_exists {
 504                 drop(lock);
 505                 update_active_workers(None)?;
 506                 let lock = lock_task_list_files(false)?;
 507                 let active_list = read_task_file_from_path(PROXMOX_BACKUP_ACTIVE_TASK_FN)?;
 508                 (lock, active_list)
 509             } else {
 510                 (lock, active_list)
 511             }
 512         };
 513
 514         let archive = if active_only {
 515             None
 516         } else {
 517             let logrotate = LogRotate::new(PROXMOX_BACKUP_ARCHIVE_TASK_FN, true)
 518                 .ok_or_else(|| format_err!("could not get archive file names"))?;
 519             Some(logrotate.files())
 520         };
 521
 522         let lock = if active_only { None } else { Some(read_lock) };
 523
 524         Ok(Self {
 525             list: active_list.into(),
 526             end: active_only,
 527             archive,
 528             lock,
 529         })
 530     }
 531 }
 532
 533 impl Iterator for TaskListInfoIterator {
 534     type Item = Result<TaskListInfo, Error>;
 535
 536     fn next(&mut self) -> Option<Self::Item> {
 537         loop {
 538             if let Some(element) = self.list.pop_back() {
 539                 return Some(Ok(element));
 540             } else if self.end {
 541                     return None;
 542             } else {
 543                 if let Some(mut archive) = self.archive.take() {
 544                     if let Some(file) = archive.next() {
 545                         let list = match read_task_file(file) {
 546                             Ok(list) => list,
 547                             Err(err) => return Some(Err(err)),
 548                         };
 549                         self.list.append(&mut list.into());
 550                         self.archive = Some(archive);
 551                         continue;
 552                     }
 553                 }
 554
 555                 self.end = true;
 556                 self.lock.take();
 557             }
 558         }
 559     }
 560 }
 561
 562 /// Launch long running worker tasks.
 563 ///
 564 /// A worker task can either be a whole thread, or a simply tokio
 565 /// task/future. Each task can `log()` messages, which are stored
 566 /// persistently to files. Task should poll the `abort_requested`
 567 /// flag, and stop execution when requested.
 568 #[derive(Debug)]
 569 pub struct WorkerTask {
 570     upid: UPID,
 571     data: Mutex<WorkerTaskData>,
 572     abort_requested: AtomicBool,
 573 }
 574
 575 impl std::fmt::Display for WorkerTask {
 576
 577     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
 578         self.upid.fmt(f)
 579     }
 580 }
 581
 582 #[derive(Debug)]
 583 struct WorkerTaskData {
 584     logger: FileLogger,
 585     progress: f64, // 0..1
 586     warn_count: u64,
 587     pub abort_listeners: Vec<oneshot::Sender<()>>,
 588 }
 589
 590 impl WorkerTask {
 591
 592     pub fn new(worker_type: &str, worker_id: Option<String>, auth_id: Authid, to_stdout: bool) -> Result<Arc<Self>, Error> {
 593         let upid = UPID::new(worker_type, worker_id, auth_id)?;
 594         let task_id = upid.task_id;
 595
 596         let mut path = std::path::PathBuf::from(PROXMOX_BACKUP_TASK_DIR);
 597
 598         path.push(format!("{:02X}", upid.pstart & 255));
 599
 600         let backup_user = crate::backup::backup_user()?;
 601
 602         create_path(&path, None, Some(CreateOptions::new().owner(backup_user.uid).group(backup_user.gid)))?;
 603
 604         path.push(upid.to_string());
 605
 606         let logger_options = FileLogOptions {
 607             to_stdout,
 608             exclusive: true,
 609             prefix_time: true,
 610             read: true,
 611             ..Default::default()
 612         };
 613         let logger = FileLogger::new(&path, logger_options)?;
 614         nix::unistd::chown(&path, Some(backup_user.uid), Some(backup_user.gid))?;
 615
 616         let worker = Arc::new(Self {
 617             upid: upid.clone(),
 618             abort_requested: AtomicBool::new(false),
 619             data: Mutex::new(WorkerTaskData {
 620                 logger,
 621                 progress: 0.0,
 622                 warn_count: 0,
 623                 abort_listeners: vec![],
 624             }),
 625         });
 626
 627         // scope to drop the lock again after inserting
 628         {
 629             let mut hash = WORKER_TASK_LIST.lock().unwrap();
 630             hash.insert(task_id, worker.clone());
 631             super::set_worker_count(hash.len());
 632         }
 633
 634         update_active_workers(Some(&upid))?;
 635
 636         Ok(worker)
 637     }
 638
 639     /// Spawn a new tokio task/future.
 640     pub fn spawn<F, T>(
 641         worker_type: &str,
 642         worker_id: Option<String>,
 643         auth_id: Authid,
 644         to_stdout: bool,
 645         f: F,
 646     ) -> Result<String, Error>
 647         where F: Send + 'static + FnOnce(Arc<WorkerTask>) -> T,
 648               T: Send + 'static + Future<Output = Result<(), Error>>,
 649     {
 650         let worker = WorkerTask::new(worker_type, worker_id, auth_id, to_stdout)?;
 651         let upid_str = worker.upid.to_string();
 652         let f = f(worker.clone());
 653         tokio::spawn(async move {
 654             let result = f.await;
 655             worker.log_result(&result);
 656         });
 657
 658         Ok(upid_str)
 659     }
 660
 661     /// Create a new worker thread.
 662     pub fn new_thread<F>(
 663         worker_type: &str,
 664         worker_id: Option<String>,
 665         auth_id: Authid,
 666         to_stdout: bool,
 667         f: F,
 668     ) -> Result<String, Error>
 669         where F: Send + UnwindSafe + 'static + FnOnce(Arc<WorkerTask>) -> Result<(), Error>
 670     {
 671         let worker = WorkerTask::new(worker_type, worker_id, auth_id, to_stdout)?;
 672         let upid_str = worker.upid.to_string();
 673
 674         let _child = std::thread::Builder::new().name(upid_str.clone()).spawn(move || {
 675             let worker1 = worker.clone();
 676             let result = match std::panic::catch_unwind(move || f(worker1)) {
 677                 Ok(r) => r,
 678                 Err(panic) => {
 679                     match panic.downcast::<&str>() {
 680                         Ok(panic_msg) => {
 681                             Err(format_err!("worker panicked: {}", panic_msg))
 682                         }
 683                         Err(_) => {
 684                             Err(format_err!("worker panicked: unknown type."))
 685                         }
 686                     }
 687                 }
 688             };
 689
 690             worker.log_result(&result);
 691         });
 692
 693         Ok(upid_str)
 694     }
 695
 696     /// create state from self and a result
 697     pub fn create_state(&self, result: &Result<(), Error>) -> TaskState {
 698         let warn_count = self.data.lock().unwrap().warn_count;
 699
 700         let endtime = proxmox::tools::time::epoch_i64();
 701
 702         if let Err(err) = result {
 703             TaskState::Error { message: err.to_string(), endtime }
 704         } else if warn_count > 0 {
 705             TaskState::Warning { count: warn_count, endtime }
 706         } else {
 707             TaskState::OK { endtime }
 708         }
 709     }
 710
 711     /// Log task result, remove task from running list
 712     pub fn log_result(&self, result: &Result<(), Error>) {
 713         let state = self.create_state(result);
 714         self.log(state.result_text());
 715
 716         WORKER_TASK_LIST.lock().unwrap().remove(&self.upid.task_id);
 717         let _ = update_active_workers(None);
 718         super::set_worker_count(WORKER_TASK_LIST.lock().unwrap().len());
 719     }
 720
 721     /// Log a message.
 722     pub fn log<S: AsRef<str>>(&self, msg: S) {
 723         let mut data = self.data.lock().unwrap();
 724         data.logger.log(msg);
 725     }
 726
 727     /// Log a message as warning.
 728     pub fn warn<S: AsRef<str>>(&self, msg: S) {
 729         let mut data = self.data.lock().unwrap();
 730         data.logger.log(format!("WARN: {}", msg.as_ref()));
 731         data.warn_count += 1;
 732     }
 733
 734     /// Set progress indicator
 735     pub fn progress(&self, progress: f64) {
 736         if progress >= 0.0 && progress <= 1.0 {
 737             let mut data = self.data.lock().unwrap();
 738             data.progress = progress;
 739         } else {
 740            // fixme:  log!("task '{}': ignoring strange value for progress '{}'", self.upid, progress);
 741         }
 742     }
 743
 744     /// Request abort
 745     pub fn request_abort(&self) {
 746         eprintln!("set abort flag for worker {}", self.upid);
 747         self.abort_requested.store(true, Ordering::SeqCst);
 748         // noitify listeners
 749         let mut data = self.data.lock().unwrap();
 750         loop {
 751             match data.abort_listeners.pop() {
 752                 None => { break; },
 753                 Some(ch) => {
 754                     let _ = ch.send(()); // ignore erros here
 755                 },
 756             }
 757         }
 758     }
 759
 760     /// Test if abort was requested.
 761     pub fn abort_requested(&self) -> bool {
 762         self.abort_requested.load(Ordering::SeqCst)
 763     }
 764
 765     /// Fail if abort was requested.
 766     pub fn fail_on_abort(&self) -> Result<(), Error> {
 767         if self.abort_requested() {
 768             bail!("abort requested - aborting task");
 769         }
 770         Ok(())
 771     }
 772
 773     /// Get a future which resolves on task abort
 774     pub fn abort_future(&self) ->  oneshot::Receiver<()> {
 775         let (tx, rx) = oneshot::channel::<()>();
 776
 777         let mut data = self.data.lock().unwrap();
 778         if self.abort_requested() {
 779             let _ = tx.send(());
 780         } else {
 781             data.abort_listeners.push(tx);
 782         }
 783         rx
 784     }
 785
 786     pub fn upid(&self) -> &UPID {
 787         &self.upid
 788     }
 789 }
 790
 791 impl crate::task::TaskState for WorkerTask {
 792     fn check_abort(&self) -> Result<(), Error> {
 793         self.fail_on_abort()
 794     }
 795
 796     fn log(&self, level: log::Level, message: &std::fmt::Arguments) {
 797         match level {
 798             log::Level::Error => self.warn(&message.to_string()),
 799             log::Level::Warn => self.warn(&message.to_string()),
 800             log::Level::Info => self.log(&message.to_string()),
 801             log::Level::Debug => self.log(&format!("DEBUG: {}", message)),
 802             log::Level::Trace => self.log(&format!("TRACE: {}", message)),
 803         }
 804     }
 805 }