use std::path::Path;
-use std::sync::Arc;
+use std::sync::{Mutex, Arc};
use anyhow::{bail, format_err, Error};
use serde_json::Value;
-use proxmox::{
- api::{
- api,
- RpcEnvironment,
- RpcEnvironmentType,
- Router,
- Permission,
- },
+use proxmox_lang::try_block;
+use proxmox_router::{Permission, Router, RpcEnvironment, RpcEnvironmentType};
+use proxmox_schema::api;
+use proxmox_sys::{task_log, task_warn, WorkerTaskContext};
+
+use pbs_api_types::{
+ Authid, Userid, TapeBackupJobConfig, TapeBackupJobSetup, TapeBackupJobStatus, MediaPoolConfig,
+ UPID_SCHEMA, JOB_ID_SCHEMA, PRIV_DATASTORE_READ, PRIV_TAPE_AUDIT, PRIV_TAPE_WRITE,
+ GroupFilter,
};
+use pbs_datastore::{DataStore, StoreProgress, SnapshotReader};
+use pbs_datastore::backup_info::{BackupDir, BackupInfo, BackupGroup};
+use pbs_config::CachedUserInfo;
+use proxmox_rest_server::WorkerTask;
+
use crate::{
- task_log,
- config::{
- self,
- cached_user_info::CachedUserInfo,
- acl::{
- PRIV_DATASTORE_READ,
- PRIV_TAPE_AUDIT,
- PRIV_TAPE_WRITE,
- },
- tape_job::{
- TapeBackupJobConfig,
- TapeBackupJobSetup,
- TapeBackupJobStatus,
- },
- },
server::{
lookup_user_email,
+ TapeBackupJobSummary,
jobstate::{
Job,
JobState,
compute_schedule_status,
},
},
- backup::{
- DataStore,
- BackupDir,
- BackupInfo,
- },
- api2::types::{
- Authid,
- UPID_SCHEMA,
- JOB_ID_SCHEMA,
- MediaPoolConfig,
- Userid,
- },
- server::WorkerTask,
- task::TaskState,
tape::{
TAPE_STATUS_DIR,
Inventory,
PoolWriter,
MediaPool,
- SnapshotReader,
drive::{
media_changer,
lock_tape_device,
+ TapeLockError,
set_tape_device_state,
},
changer::update_changer_online_status,
let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
let user_info = CachedUserInfo::new()?;
- let (config, digest) = config::tape_job::config()?;
+ let (job_config, digest) = pbs_config::tape_job::config()?;
+ let (pool_config, _pool_digest) = pbs_config::media_pool::config()?;
+ let (drive_config, _digest) = pbs_config::drive::config()?;
- let job_list_iter = config
+ let job_list_iter = job_config
.convert_to_typed_array("backup")?
.into_iter()
.filter(|_job: &TapeBackupJobConfig| {
});
let mut list = Vec::new();
+ let status_path = Path::new(TAPE_STATUS_DIR);
+ let current_time = proxmox_time::epoch_i64();
for job in job_list_iter {
let privs = user_info.lookup_privs(&auth_id, &["tape", "job", &job.id]);
let status = compute_schedule_status(&last_state, job.schedule.as_deref())?;
- list.push(TapeBackupJobStatus { config: job, status });
+ let next_run = status.next_run.unwrap_or(current_time);
+
+ let mut next_media_label = None;
+
+ if let Ok(pool) = pool_config.lookup::<MediaPoolConfig>("pool", &job.setup.pool) {
+ let mut changer_name = None;
+ if let Ok(Some((_, name))) = media_changer(&drive_config, &job.setup.drive) {
+ changer_name = Some(name);
+ }
+ if let Ok(mut pool) = MediaPool::with_config(status_path, &pool, changer_name, true) {
+ if pool.start_write_session(next_run, false).is_ok() {
+ if let Ok(media_id) = pool.guess_next_writable_media(next_run) {
+ next_media_label = Some(media_id.label.label_text);
+ }
+ }
+ }
+ }
+
+ list.push(TapeBackupJobStatus { config: job, status, next_media_label });
}
- rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into();
+ rpcenv["digest"] = hex::encode(&digest).into();
Ok(list)
}
setup: TapeBackupJobSetup,
auth_id: &Authid,
schedule: Option<String>,
+ to_stdout: bool,
) -> Result<String, Error> {
let job_id = format!("{}:{}:{}:{}",
let datastore = DataStore::lookup_datastore(&setup.store)?;
- let (config, _digest) = config::media_pool::config()?;
+ let (config, _digest) = pbs_config::media_pool::config()?;
let pool_config: MediaPoolConfig = config.lookup("pool", &setup.pool)?;
- let (drive_config, _digest) = config::drive::config()?;
+ let (drive_config, _digest) = pbs_config::drive::config()?;
- // early check/lock before starting worker
- let drive_lock = lock_tape_device(&drive_config, &setup.drive)?;
+ // for scheduled jobs we acquire the lock later in the worker
+ let drive_lock = if schedule.is_some() {
+ None
+ } else {
+ Some(lock_tape_device(&drive_config, &setup.drive)?)
+ };
+
+ let notify_user = setup.notify_user.as_ref().unwrap_or_else(|| Userid::root_userid());
+ let email = lookup_user_email(notify_user);
let upid_str = WorkerTask::new_thread(
&worker_type,
Some(job_id.clone()),
- auth_id.clone(),
- false,
+ auth_id.to_string(),
+ to_stdout,
move |worker| {
- let _drive_lock = drive_lock; // keep lock guard
-
- set_tape_device_state(&setup.drive, &worker.upid().to_string())?;
job.start(&worker.upid().to_string())?;
+ let mut drive_lock = drive_lock;
+
+ let mut summary = Default::default();
+ let job_result = try_block!({
+ if schedule.is_some() {
+ // for scheduled tape backup jobs, we wait indefinitely for the lock
+ task_log!(worker, "waiting for drive lock...");
+ loop {
+ worker.check_abort()?;
+ match lock_tape_device(&drive_config, &setup.drive) {
+ Ok(lock) => {
+ drive_lock = Some(lock);
+ break;
+ }
+ Err(TapeLockError::TimeOut) => continue,
+ Err(TapeLockError::Other(err)) => return Err(err),
+ }
+ }
+ }
+ set_tape_device_state(&setup.drive, &worker.upid().to_string())?;
- task_log!(worker,"Starting tape backup job '{}'", job_id);
- if let Some(event_str) = schedule {
- task_log!(worker,"task triggered by schedule '{}'", event_str);
- }
+ task_log!(worker,"Starting tape backup job '{}'", job_id);
+ if let Some(event_str) = schedule {
+ task_log!(worker,"task triggered by schedule '{}'", event_str);
+ }
- let notify_user = setup.notify_user.as_ref().unwrap_or_else(|| &Userid::root_userid());
- let email = lookup_user_email(notify_user);
- let job_result = backup_worker(
- &worker,
- datastore,
- &pool_config,
- &setup,
- email.clone(),
- );
+ backup_worker(
+ &worker,
+ datastore,
+ &pool_config,
+ &setup,
+ email.clone(),
+ &mut summary,
+ false,
+ )
+ });
let status = worker.create_state(&job_result);
Some(job.jobname()),
&setup,
&job_result,
+ summary,
) {
eprintln!("send tape backup notification failed: {}", err);
}
) -> Result<String, Error> {
let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
- let (config, _digest) = config::tape_job::config()?;
+ let (config, _digest) = pbs_config::tape_job::config()?;
let backup_job: TapeBackupJobConfig = config.lookup("backup", &id)?;
check_backup_permission(
let job = Job::new("tape-backup-job", &id)?;
- let upid_str = do_tape_backup_job(job, backup_job.setup, &auth_id, None)?;
+ let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI;
+
+ let upid_str = do_tape_backup_job(job, backup_job.setup, &auth_id, None, to_stdout)?;
Ok(upid_str)
}
type: TapeBackupJobSetup,
flatten: true,
},
+ "force-media-set": {
+ description: "Ignore the allocation policy and start a new media-set.",
+ optional: true,
+ type: bool,
+ default: false,
+ },
},
},
returns: {
/// Backup datastore to tape media pool
pub fn backup(
setup: TapeBackupJobSetup,
+ force_media_set: bool,
rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
let datastore = DataStore::lookup_datastore(&setup.store)?;
- let (config, _digest) = config::media_pool::config()?;
+ let (config, _digest) = pbs_config::media_pool::config()?;
let pool_config: MediaPoolConfig = config.lookup("pool", &setup.pool)?;
- let (drive_config, _digest) = config::drive::config()?;
+ let (drive_config, _digest) = pbs_config::drive::config()?;
// early check/lock before starting worker
let drive_lock = lock_tape_device(&drive_config, &setup.drive)?;
let job_id = format!("{}:{}:{}", setup.store, setup.pool, setup.drive);
- let notify_user = setup.notify_user.as_ref().unwrap_or_else(|| &Userid::root_userid());
+ let notify_user = setup.notify_user.as_ref().unwrap_or_else(|| Userid::root_userid());
let email = lookup_user_email(notify_user);
let upid_str = WorkerTask::new_thread(
"tape-backup",
Some(job_id),
- auth_id,
+ auth_id.to_string(),
to_stdout,
move |worker| {
let _drive_lock = drive_lock; // keep lock guard
set_tape_device_state(&setup.drive, &worker.upid().to_string())?;
+
+ let mut summary = Default::default();
let job_result = backup_worker(
&worker,
datastore,
&pool_config,
&setup,
email.clone(),
+ &mut summary,
+ force_media_set,
);
if let Some(email) = email {
None,
&setup,
&job_result,
+ summary,
) {
eprintln!("send tape backup notification failed: {}", err);
}
pool_config: &MediaPoolConfig,
setup: &TapeBackupJobSetup,
email: Option<String>,
+ summary: &mut TapeBackupJobSummary,
+ force_media_set: bool,
) -> Result<(), Error> {
let status_path = Path::new(TAPE_STATUS_DIR);
-
- let _lock = MediaPool::lock(status_path, &pool_config.name)?;
+ let start = std::time::Instant::now();
task_log!(worker, "update media online status");
let changer_name = update_media_online_status(&setup.drive)?;
- let pool = MediaPool::with_config(status_path, &pool_config, changer_name)?;
+ let pool = MediaPool::with_config(status_path, pool_config, changer_name, false)?;
- let mut pool_writer = PoolWriter::new(pool, &setup.drive, worker, email)?;
+ let mut pool_writer = PoolWriter::new(
+ pool,
+ &setup.drive,
+ worker,
+ email,
+ force_media_set
+ )?;
let mut group_list = BackupInfo::list_backup_groups(&datastore.base_path())?;
group_list.sort_unstable();
+ let (group_list, group_count) = if let Some(group_filters) = &setup.group_filter {
+ let filter_fn = |group: &BackupGroup, group_filters: &[GroupFilter]| {
+ group_filters.iter().any(|filter| group.matches(filter))
+ };
+
+ let group_count_full = group_list.len();
+ let list: Vec<BackupGroup> = group_list.into_iter().filter(|group| filter_fn(group, group_filters)).collect();
+ let group_count = list.len();
+ task_log!(worker, "found {} groups (out of {} total)", group_count, group_count_full);
+ (list, group_count)
+ } else {
+ let group_count = group_list.len();
+ task_log!(worker, "found {} groups", group_count);
+ (group_list, group_count)
+ };
+
+ let mut progress = StoreProgress::new(group_count as u64);
+
let latest_only = setup.latest_only.unwrap_or(false);
if latest_only {
task_log!(worker, "latest-only: true (only considering latest snapshots)");
}
- for group in group_list {
- let mut snapshot_list = group.list_backups(&datastore.base_path())?;
+ let datastore_name = datastore.name();
+
+ let mut errors = false;
+
+ let mut need_catalog = false; // avoid writing catalog for empty jobs
+
+ for (group_number, group) in group_list.into_iter().enumerate() {
+ progress.done_groups = group_number as u64;
+ progress.done_snapshots = 0;
+ progress.group_snapshots = 0;
+
+ let snapshot_list = group.list_backups(&datastore.base_path())?;
+
+ // filter out unfinished backups
+ let mut snapshot_list: Vec<_> = snapshot_list
+ .into_iter()
+ .filter(|item| item.is_finished())
+ .collect();
+
+ if snapshot_list.is_empty() {
+ task_log!(worker, "group {} was empty", group);
+ continue;
+ }
BackupInfo::sort_list(&mut snapshot_list, true); // oldest first
if latest_only {
+ progress.group_snapshots = 1;
if let Some(info) = snapshot_list.pop() {
- if pool_writer.contains_snapshot(&info.backup_dir.to_string()) {
+ if pool_writer.contains_snapshot(datastore_name, &info.backup_dir.to_string()) {
+ task_log!(worker, "skip snapshot {}", info.backup_dir);
continue;
}
- task_log!(worker, "backup snapshot {}", info.backup_dir);
- backup_snapshot(worker, &mut pool_writer, datastore.clone(), info.backup_dir)?;
+
+ need_catalog = true;
+
+ let snapshot_name = info.backup_dir.to_string();
+ if !backup_snapshot(worker, &mut pool_writer, datastore.clone(), info.backup_dir)? {
+ errors = true;
+ } else {
+ summary.snapshot_list.push(snapshot_name);
+ }
+ progress.done_snapshots = 1;
+ task_log!(
+ worker,
+ "percentage done: {}",
+ progress
+ );
}
} else {
- for info in snapshot_list {
- if pool_writer.contains_snapshot(&info.backup_dir.to_string()) {
+ progress.group_snapshots = snapshot_list.len() as u64;
+ for (snapshot_number, info) in snapshot_list.into_iter().enumerate() {
+ if pool_writer.contains_snapshot(datastore_name, &info.backup_dir.to_string()) {
+ task_log!(worker, "skip snapshot {}", info.backup_dir);
continue;
}
- task_log!(worker, "backup snapshot {}", info.backup_dir);
- backup_snapshot(worker, &mut pool_writer, datastore.clone(), info.backup_dir)?;
+
+ need_catalog = true;
+
+ let snapshot_name = info.backup_dir.to_string();
+ if !backup_snapshot(worker, &mut pool_writer, datastore.clone(), info.backup_dir)? {
+ errors = true;
+ } else {
+ summary.snapshot_list.push(snapshot_name);
+ }
+ progress.done_snapshots = snapshot_number as u64 + 1;
+ task_log!(
+ worker,
+ "percentage done: {}",
+ progress
+ );
}
}
}
pool_writer.commit()?;
+ if need_catalog {
+ task_log!(worker, "append media catalog");
+
+ let uuid = pool_writer.load_writable_media(worker)?;
+ let done = pool_writer.append_catalog_archive(worker)?;
+ if !done {
+ task_log!(worker, "catalog does not fit on tape, writing to next volume");
+ pool_writer.set_media_status_full(&uuid)?;
+ pool_writer.load_writable_media(worker)?;
+ let done = pool_writer.append_catalog_archive(worker)?;
+ if !done {
+ bail!("write_catalog_archive failed on second media");
+ }
+ }
+ }
+
if setup.export_media_set.unwrap_or(false) {
pool_writer.export_media_set(worker)?;
} else if setup.eject_media.unwrap_or(false) {
pool_writer.eject_media(worker)?;
}
+ if errors {
+ bail!("Tape backup finished with some errors. Please check the task log.");
+ }
+
+ summary.duration = start.elapsed();
+
Ok(())
}
// Try to update the the media online status
fn update_media_online_status(drive: &str) -> Result<Option<String>, Error> {
- let (config, _digest) = config::drive::config()?;
+ let (config, _digest) = pbs_config::drive::config()?;
if let Ok(Some((mut changer, changer_name))) = media_changer(&config, drive) {
pool_writer: &mut PoolWriter,
datastore: Arc<DataStore>,
snapshot: BackupDir,
-) -> Result<(), Error> {
+) -> Result<bool, Error> {
+
+ task_log!(worker, "backup snapshot {}", snapshot);
+
+ let snapshot_reader = match SnapshotReader::new(datastore.clone(), snapshot.clone()) {
+ Ok(reader) => reader,
+ Err(err) => {
+ // ignore missing snapshots and continue
+ task_warn!(worker, "failed opening snapshot '{}': {}", snapshot, err);
+ return Ok(false);
+ }
+ };
- task_log!(worker, "start backup {}:{}", datastore.name(), snapshot);
+ let snapshot_reader = Arc::new(Mutex::new(snapshot_reader));
- let snapshot_reader = SnapshotReader::new(datastore.clone(), snapshot.clone())?;
+ let (reader_thread, chunk_iter) = pool_writer.spawn_chunk_reader_thread(
+ datastore.clone(),
+ snapshot_reader.clone(),
+ )?;
- let mut chunk_iter = snapshot_reader.chunk_iterator()?.peekable();
+ let mut chunk_iter = chunk_iter.peekable();
loop {
worker.check_abort()?;
// test is we have remaining chunks
- if chunk_iter.peek().is_none() {
- break;
+ match chunk_iter.peek() {
+ None => break,
+ Some(Ok(_)) => { /* Ok */ },
+ Some(Err(err)) => bail!("{}", err),
}
let uuid = pool_writer.load_writable_media(worker)?;
worker.check_abort()?;
- let (leom, _bytes) = pool_writer.append_chunk_archive(worker, &datastore, &mut chunk_iter)?;
+ let (leom, _bytes) = pool_writer.append_chunk_archive(worker, &mut chunk_iter, datastore.name())?;
if leom {
pool_writer.set_media_status_full(&uuid)?;
}
}
+ if let Err(_) = reader_thread.join() {
+ bail!("chunk reader thread failed");
+ }
+
worker.check_abort()?;
let uuid = pool_writer.load_writable_media(worker)?;
worker.check_abort()?;
+ let snapshot_reader = snapshot_reader.lock().unwrap();
+
let (done, _bytes) = pool_writer.append_snapshot_archive(worker, &snapshot_reader)?;
if !done {
task_log!(worker, "end backup {}:{}", datastore.name(), snapshot);
- Ok(())
+ Ok(true)
}