[pbs-devel] [PATCH proxmox-backup] tape/drive: fix logging when requesting media

Dominik Csapak d.csapak at proxmox.com
Tue Jun 29 11:58:14 CEST 2021


we try to load the correct media in a loop until we find the correct tape.
when encountering an error or wrong tape, we want to log that (and send
an email if one is set) that requests the correct tape.

while trying to avoid printing the same errors more than once in a row,
we had at least one case (starting with an empty tape in the drive)
which would not print/send any tape request.

reworking that code to use a custom 'TapeRequest' enum, which contains
the state + error message, and a helper that prints and sends an email
when the state changes

this reduces the change check/log to a single variable, instead of 4
(tried, last_media_uuid, last_error, failure_reason)

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 src/tape/drive/mod.rs | 138 +++++++++++++++++++++++++-----------------
 1 file changed, 83 insertions(+), 55 deletions(-)

diff --git a/src/tape/drive/mod.rs b/src/tape/drive/mod.rs
index 7bc02f9e..2264ce0c 100644
--- a/src/tape/drive/mod.rs
+++ b/src/tape/drive/mod.rs
@@ -321,6 +321,29 @@ pub fn open_drive(
     }
 }
 
+#[derive(PartialEq, Eq)]
+enum TapeRequest {
+    None,
+    OpenFailed(String),
+    WrongLabel(String),
+    EmptyTape(String),
+    ReadFailed(String),
+}
+
+impl std::fmt::Display for TapeRequest {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let txt = match self {
+            TapeRequest::None => "",
+            TapeRequest::OpenFailed(reason) => reason,
+            TapeRequest::WrongLabel(reason) => reason,
+            TapeRequest::EmptyTape(reason) => reason,
+            TapeRequest::ReadFailed(reason) => reason,
+        };
+
+        write!(f, "{}", txt)
+    }
+}
+
 /// Requests a specific 'media' to be inserted into 'drive'. Within a
 /// loop, this then tries to read the media label and waits until it
 /// finds the requested media.
@@ -388,84 +411,89 @@ pub fn request_and_load_media(
                         return Ok((handle, media_id));
                     }
 
-                    let mut last_media_uuid = None;
-                    let mut last_error = None;
-
-                    let mut tried = false;
-                    let mut failure_reason = None;
+                    let mut request_state = TapeRequest::None;
+
+                    let update_and_log_request_state = |old_state: &mut TapeRequest,
+                                                        new_state: TapeRequest|
+                     -> Result<(), Error> {
+                        if new_state != *old_state {
+                            task_log!(worker, "{}", &new_state);
+                            task_log!(
+                                worker,
+                                "Please insert media '{}' into drive '{}'",
+                                label_text,
+                                drive
+                            );
+                            if let Some(to) = notify_email {
+                                send_load_media_email(
+                                    drive,
+                                    &label_text,
+                                    to,
+                                    Some(new_state.to_string()),
+                                )?;
+                            }
+                            *old_state = new_state;
+                        }
+                        Ok(())
+                    };
 
                     loop {
                         worker.check_abort()?;
 
-                        if tried {
-                            if let Some(reason) = failure_reason {
-                                task_log!(worker, "Please insert media '{}' into drive '{}'", label_text, drive);
-                                if let Some(to) = notify_email {
-                                    send_load_media_email(drive, &label_text, to, Some(reason))?;
-                                }
-                            }
-
-                            failure_reason = None;
-
+                        if request_state != TapeRequest::None {
                             for _ in 0..50 { // delay 5 seconds
                                 worker.check_abort()?;
                                 std::thread::sleep(std::time::Duration::from_millis(100));
                             }
+                        } else {
+                            task_log!(
+                                worker,
+                                "Checking for media '{}' in drive '{}'",
+                                label_text,
+                                drive
+                            );
                         }
 
-                        tried = true;
-
                         let mut handle = match drive_config.open() {
                             Ok(handle) => handle,
                             Err(err) => {
-                                let err = err.to_string();
-                                if Some(err.clone()) != last_error {
-                                    task_log!(worker, "tape open failed - {}", err);
-                                    last_error = Some(err);
-                                    failure_reason = last_error.clone();
-                                }
+                                let err = format!("tape open failed - {}", &err);
+                                update_and_log_request_state(
+                                    &mut request_state,
+                                    TapeRequest::OpenFailed(err),
+                                )?;
                                 continue;
                             }
                         };
 
-                        match handle.read_label() {
+                        let new_state = match handle.read_label() {
+                            Ok((Some(media_id), _)) if media_id.label.uuid == label.uuid => {
+                                task_log!(
+                                    worker,
+                                    "found media label {} ({})",
+                                    media_id.label.label_text,
+                                    media_id.label.uuid.to_string(),
+                                );
+                                return Ok((Box::new(handle), media_id));
+                            }
                             Ok((Some(media_id), _)) => {
-                                if media_id.label.uuid == label.uuid {
-                                    task_log!(
-                                        worker,
-                                        "found media label {} ({})",
-                                        media_id.label.label_text,
-                                        media_id.label.uuid.to_string(),
-                                    );
-                                    return Ok((Box::new(handle), media_id));
-                                } else if Some(media_id.label.uuid.clone()) != last_media_uuid {
-                                    let err = format!(
-                                        "wrong media label {} ({})",
-                                        media_id.label.label_text,
-                                        media_id.label.uuid.to_string(),
-                                    );
-                                    task_log!(worker, "{}", err);
-                                    last_media_uuid = Some(media_id.label.uuid);
-                                    failure_reason = Some(err);
-                                }
+                                let err = format!(
+                                    "wrong media label {} ({})",
+                                    media_id.label.label_text,
+                                    media_id.label.uuid.to_string(),
+                                );
+                                TapeRequest::WrongLabel(err.clone())
                             }
                             Ok((None, _)) => {
-                                if last_media_uuid.is_some() {
-                                    let err = "found empty media without label (please label all tapes first)";
-                                    task_log!(worker, "{}", err);
-                                    last_media_uuid = None;
-                                    failure_reason = Some(err.to_string());
-                                }
+                                let err = "found empty media without label (please label all tapes first)";
+                                TapeRequest::EmptyTape(err.to_string())
                             }
                             Err(err) => {
-                                let err = err.to_string();
-                                if Some(err.clone()) != last_error {
-                                    task_log!(worker, "tape open failed - {}", err);
-                                    last_error = Some(err);
-                                    failure_reason = last_error.clone();
-                                }
+                                TapeRequest::ReadFailed(format!("tape open failed - {}", err))
                             }
-                        }
+                        };
+
+                        update_and_log_request_state(&mut request_state, new_state)?;
                     }
                 }
                 _ => bail!("drive type '{}' not implemented!"),
-- 
2.20.1






More information about the pbs-devel mailing list