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