/*
*
- * Higher Level Device routines.
- * Knows about Bacula tape labels and such
+ * Higher Level Device routines.
+ * Knows about Bacula tape labels and such
*
* NOTE! In general, subroutines that have the word
* "device" in the name do locking. Subroutines
* yyy_dev(), all is OK, but if xxx_device()
* calls yyy_device(), everything will hang.
* Obviously, no zzz_dev() is allowed to call
- * a www_device() or everything falls apart.
+ * a www_device() or everything falls apart.
*
* Concerning the routines lock_device() and block_device()
* see the end of this module for details. In general,
* blocking a device leaves it in a state where all threads
- * other than the current thread block when they attempt to
+ * other than the current thread block when they attempt to
* lock the device. They remain suspended (blocked) until the device
* is unblocked. So, a device is blocked during an operation
* that takes a long time (initialization, mounting a new
* volume, ...) locking a device is done for an operation
- * that takes a short time such as writing data to the
+ * that takes a short time such as writing data to the
* device.
*
*
* Kern Sibbald, MM, MMI
- *
+ *
* Version $Id$
*/
/*
- Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+ Copyright (C) 2000-2004 Kern Sibbald and John Walker
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
* medium condition or worse, and error condition.
* Attempt to "recover" by obtaining a new Volume.
*
- * We enter with device locked, and
+ * Here are a few things to know:
+ * dcr->VolCatInfo contains the info on the "current" tape for this job.
+ * dev->VolCatInfo contains the info on the tape in the drive.
+ * The tape in the drive could have changed several times since
+ * the last time the job used it (jcr->VolCatInfo).
+ * dcr->VolumeName is the name of the current/desired tape in the drive.
+ *
+ * We enter with device locked, and
* exit with device locked.
*
* Note, we are called only from one place in block.c
*
- * Returns: 1 on success
- * 0 on failure
+ * Returns: true on success
+ * false on failure
*/
-int fixup_device_block_write_error(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
+bool fixup_device_block_write_error(DCR *dcr)
{
- uint32_t stat = 0;
+ uint32_t stat;
char PrevVolName[MAX_NAME_LENGTH];
- DEV_BLOCK *label_blk = NULL;
+ DEV_BLOCK *label_blk;
+ DEV_BLOCK *block = dcr->block;
char b1[30], b2[30];
time_t wait_time;
+ char dt[MAX_TIME_LENGTH];
+ JCR *jcr = dcr->jcr;
+ DEVICE *dev = dcr->dev;
wait_time = time(NULL);
- status_dev(dev, &stat);
- if (stat & MT_EOD) {
- Dmsg0(190, "======= Got EOD ========\n");
-
- block_device(dev, BST_DOING_ACQUIRE);
-
- /*
- * Walk through all attached jcrs creating a jobmedia_record()
- */
- Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
- for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
- Dmsg1(100, "create JobMedia for Job %s\n", mjcr->Job);
- mjcr->end_block = dev->block_num;
- mjcr->end_file = dev->file;
- if (!dir_create_jobmedia_record(mjcr)) {
- Jmsg(mjcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=%s Job=%s\n"),
- dev->VolCatInfo.VolCatName, mjcr->Job);
- return 0;
- }
- }
-
- strcpy(dev->VolCatInfo.VolCatStatus, "Full");
- Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
- dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
- if (!dir_update_volume_info(jcr, &dev->VolCatInfo, 0)) { /* send Volume info to Director */
- Jmsg(jcr, M_ERROR, 0, _("Could not update Volume info Volume=%s Job=%s\n"),
- dev->VolCatInfo.VolCatName, jcr->Job);
- return 0; /* device locked */
- }
- Dmsg0(190, "Back from update_vol_info\n");
+ stat = status_dev(dev);
+ if (!(stat & BMT_EOD)) {
+ return false; /* this really shouldn't happen */
+ }
- strcpy(PrevVolName, dev->VolCatInfo.VolCatName);
- strcpy(dev->VolHdr.PrevVolName, PrevVolName);
+ Dmsg0(100, "======= Got EOD ========\n");
- label_blk = new_block(dev);
+ block_device(dev, BST_DOING_ACQUIRE);
+ /* Unlock, but leave BLOCKED */
+ unlock_device(dev);
- /* Inform User about end of media */
- Jmsg(jcr, M_INFO, 0, _("End of media on Volume %s Bytes=%s Blocks=%s.\n"),
- PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
- edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2));
+ bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
+ Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
+ dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
+ dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
+ dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
+ if (!dir_update_volume_info(dcr, false)) { /* send Volume info to Director */
+ P(dev->mutex);
+ unblock_device(dev);
+ return false; /* device locked */
+ }
+ Dmsg0(100, "Back from update_vol_info\n");
- /* Unlock, but leave BLOCKED */
- unlock_device(dev);
- if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
- P(dev->mutex);
- unblock_device(dev);
- return 0; /* device locked */
- }
+ bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
+ bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
- P(dev->mutex); /* lock again */
-
- Jmsg(jcr, M_INFO, 0, _("New volume %s mounted on device %s\n"),
- jcr->VolumeName, dev_name(dev));
-
- /*
- * If this is a new tape, the label_blk will contain the
- * label, so write it now. If this is a previously
- * used tape, mount_next_write_volume() will return an
- * empty label_blk, and nothing will be written.
- */
- Dmsg0(190, "write label block to dev\n");
- if (!write_block_to_dev(dev, label_blk)) {
- Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
- strerror_dev(dev));
- free_block(label_blk);
- unblock_device(dev);
- return 0; /* device locked */
- }
+ label_blk = new_block(dev);
+ dcr->block = label_blk;
- /* Write overflow block to tape */
- Dmsg0(190, "Write overflow block to dev\n");
- if (!write_block_to_dev(dev, block)) {
- Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
- strerror_dev(dev));
- free_block(label_blk);
- unblock_device(dev);
- return 0; /* device locked */
- }
+ /* Inform User about end of medium */
+ Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
+ PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
+ edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
+ bstrftime(dt, sizeof(dt), time(NULL)));
- jcr->NumVolumes++;
- Dmsg0(190, "Wake up any waiting threads.\n");
+ if (!mount_next_write_volume(dcr, 1)) {
free_block(label_blk);
- for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
- /* Set new start/end positions */
- mjcr->start_block = dev->block_num;
- mjcr->start_file = dev->file;
- mjcr->VolFirstFile = mjcr->JobFiles;
- mjcr->run_time += time(NULL) - wait_time; /* correct run time */
- }
+ dcr->block = block;
+ P(dev->mutex);
unblock_device(dev);
- return 1; /* device locked */
+ return false; /* device locked */
}
- if (label_blk) {
+ P(dev->mutex); /* lock again */
+
+ Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
+ dcr->VolumeName, dev_name(dev), bstrftime(dt, sizeof(dt), time(NULL)));
+
+ /*
+ * If this is a new tape, the label_blk will contain the
+ * label, so write it now. If this is a previously
+ * used tape, mount_next_write_volume() will return an
+ * empty label_blk, and nothing will be written.
+ */
+ Dmsg0(190, "write label block to dev\n");
+ if (!write_block_to_dev(dcr)) {
+ berrno be;
+ Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
+ be.strerror(dev->dev_errno));
free_block(label_blk);
+ dcr->block = block;
+ unblock_device(dev);
+ return false; /* device locked */
+ }
+ free_block(label_blk);
+ dcr->block = block;
+
+ /*
+ * Walk through all attached jcrs indicating the volume has changed
+ */
+ Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
+// for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
+ DCR *mdcr;
+ foreach_dlist(mdcr, dev->attached_dcrs) {
+ JCR *mjcr = mdcr->jcr;
+ if (mjcr->JobId == 0) {
+ continue; /* ignore console */
+ }
+ mdcr->NewVol = true;
+ if (jcr != mjcr) {
+ bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
+ }
+ }
+
+ /* Clear NewVol now because dir_get_volume_info() already done */
+ jcr->dcr->NewVol = false;
+ set_new_volume_parameters(dcr);
+
+ jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
+
+ /* Write overflow block to device */
+ Dmsg0(190, "Write overflow block to dev\n");
+ if (!write_block_to_dev(dcr)) {
+ berrno be;
+ Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
+ be.strerror(dev->dev_errno));
+ unblock_device(dev);
+ return false; /* device locked */
+ }
+
+ unblock_device(dev);
+ return true; /* device locked */
+}
+
+/*
+ * We have a new Volume mounted, so reset the Volume parameters
+ * concerning this job. The global changes were made earlier
+ * in the dev structure.
+ */
+void set_new_volume_parameters(DCR *dcr)
+{
+ JCR *jcr = dcr->jcr;
+ DEVICE *dev = dcr->dev;
+ if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
+ Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
+ }
+ /* Set new start/end positions */
+ if (dev_state(dev, ST_TAPE)) {
+ dcr->StartBlock = dev->block_num;
+ dcr->StartFile = dev->file;
+ } else {
+ dcr->StartBlock = (uint32_t)dev->file_addr;
+ dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
+ }
+ /* Reset indicies */
+ dcr->VolFirstIndex = 0;
+ dcr->VolLastIndex = 0;
+ jcr->NumVolumes++;
+ dcr->NewVol = false;
+ dcr->WroteVol = false;
+}
+
+/*
+ * We are now in a new Volume file, so reset the Volume parameters
+ * concerning this job. The global changes were made earlier
+ * in the dev structure.
+ */
+void set_new_file_parameters(DCR *dcr)
+{
+ DEVICE *dev = dcr->dev;
+
+ /* Set new start/end positions */
+ if (dev_state(dev, ST_TAPE)) {
+ dcr->StartBlock = dev->block_num;
+ dcr->StartFile = dev->file;
+ } else {
+ dcr->StartBlock = (uint32_t)dev->file_addr;
+ dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
}
- return 0; /* device locked */
+ /* Reset indicies */
+ dcr->VolFirstIndex = 0;
+ dcr->VolLastIndex = 0;
+ dcr->NewFile = false;
+ dcr->WroteVol = false;
}
+
/*
- * Open the device. Expect dev to already be initialized.
+ * First Open of the device. Expect dev to already be initialized.
*
- * This routine is used only when the Storage daemon starts
+ * This routine is used only when the Storage daemon starts
* and always_open is set, and in the stand-alone utility
* routines such as bextract.
*
* Note, opening of a normal file is deferred to later so
* that we can get the filename; the device_name for
- * a file is the directory only.
+ * a file is the directory only.
*
- * Retuns: 0 on failure
- * 1 on success
+ * Returns: false on failure
+ * true on success
*/
-int open_device(DEVICE *dev)
+bool first_open_device(DEVICE *dev)
{
Dmsg0(120, "start open_output_device()\n");
if (!dev) {
- return 0;
+ return false;
}
lock_device(dev);
if (!dev_is_tape(dev)) {
Dmsg0(129, "Device is file, deferring open.\n");
unlock_device(dev);
- return 1;
+ return true;
}
if (!(dev->state & ST_OPENED)) {
+ int mode;
+ if (dev_cap(dev, CAP_STREAM)) {
+ mode = OPEN_WRITE_ONLY;
+ } else {
+ mode = OPEN_READ_WRITE;
+ }
Dmsg0(129, "Opening device.\n");
- if (open_dev(dev, NULL, READ_WRITE) < 0) {
- Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
+ if (open_dev(dev, NULL, mode) < 0) {
+ Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
unlock_device(dev);
- return 0;
+ return false;
}
}
Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
unlock_device(dev);
- return 1;
+ return true;
+}
+
+/*
+ * Make sure device is open, if not do so
+ */
+bool open_device(DCR *dcr)
+{
+ DEVICE *dev = dcr->dev;
+ /* Open device */
+ if (!(dev_state(dev, ST_OPENED))) {
+ int mode;
+ if (dev_cap(dev, CAP_STREAM)) {
+ mode = OPEN_WRITE_ONLY;
+ } else {
+ mode = OPEN_READ_WRITE;
+ }
+ if (open_dev(dev, dcr->VolCatInfo.VolCatName, mode) < 0) {
+ /* If polling, ignore the error */
+ if (!dev->poll) {
+ Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
+ dev_name(dev), strerror_dev(dev));
+ }
+ return false;
+ }
+ }
+ return true;
}
+void dev_lock(DEVICE *dev)
+{
+ int errstat;
+ if ((errstat=rwl_writelock(&dev->lock))) {
+ Emsg1(M_ABORT, 0, "Device write lock failure. ERR=%s\n", strerror(errstat));
+ }
+}
+
+void dev_unlock(DEVICE *dev)
+{
+ int errstat;
+ if ((errstat=rwl_writeunlock(&dev->lock))) {
+ Emsg1(M_ABORT, 0, "Device write unlock failure. ERR=%s\n", strerror(errstat));
+ }
+}
-/*
+/*
* When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
* must wait. The no_wait_id thread is out obtaining a new volume
* and preparing the label.
*/
-void lock_device(DEVICE *dev)
+void _lock_device(const char *file, int line, DEVICE *dev)
{
int stat;
-
- Dmsg1(190, "lock %d\n", dev->dev_blocked);
+ Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
P(dev->mutex);
if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
dev->num_waiting++; /* indicate that I am waiting */
while (dev->dev_blocked) {
if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
V(dev->mutex);
- Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
+ Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
strerror(stat));
}
}
}
}
-void unlock_device(DEVICE *dev)
+/*
+ * Check if the device is blocked or not
+ */
+bool device_is_unmounted(DEVICE *dev)
+{
+ bool stat;
+ int blocked = dev->dev_blocked;
+ stat = (blocked == BST_UNMOUNTED) ||
+ (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
+ return stat;
+}
+
+const char *edit_blocked_reason(DEVICE *dev)
+{
+ switch (dev->dev_blocked) {
+ case BST_NOT_BLOCKED:
+ return "not blocked";
+ case BST_UNMOUNTED:
+ return "user unmounted device";
+ case BST_WAITING_FOR_SYSOP:
+ return "waiting for operator action";
+ case BST_DOING_ACQUIRE:
+ return "opening, validating, or positioning tape";
+ case BST_WRITING_LABEL:
+ return "labeling tape";
+ case BST_UNMOUNTED_WAITING_FOR_SYSOP:
+ return "closed by user during mount request";
+ case BST_MOUNT:
+ return "mount request";
+ default:
+ return "unknown blocked code";
+ }
+}
+
+void _unlock_device(const char *file, int line, DEVICE *dev)
{
- Dmsg0(190, "unlock\n");
+ Dmsg2(500, "unlock from %s:%d\n", file, line);
V(dev->mutex);
}
-/*
+/*
* Block all other threads from using the device
* Device must already be locked. After this call,
* the device is blocked to any thread calling lock_device(),
* the current thread can do slip through the lock_device()
* calls without blocking.
*/
-void block_device(DEVICE *dev, int state)
+void _block_device(const char *file, int line, DEVICE *dev, int state)
{
- Dmsg1(190, "block set %d\n", state);
+ Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
dev->dev_blocked = state; /* make other threads wait */
dev->no_wait_id = pthread_self(); /* allow us to continue */
}
+
+
/*
* Unblock the device, and wake up anyone who went to sleep.
*/
-void unblock_device(DEVICE *dev)
+void _unblock_device(const char *file, int line, DEVICE *dev)
{
- Dmsg1(190, "unblock %d\n", dev->dev_blocked);
+ Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
ASSERT(dev->dev_blocked);
dev->dev_blocked = BST_NOT_BLOCKED;
+ dev->no_wait_id = 0;
if (dev->num_waiting > 0) {
pthread_cond_broadcast(&dev->wait); /* wake them up */
}
}
+
+/*
+ * Enter with device locked and blocked
+ * Exit with device unlocked and blocked by us.
+ */
+void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
+{
+ Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
+ file, line);
+ hold->dev_blocked = dev->dev_blocked;
+ hold->dev_prev_blocked = dev->dev_prev_blocked;
+ hold->no_wait_id = dev->no_wait_id;
+ dev->dev_blocked = state;
+ dev->no_wait_id = pthread_self();
+ V(dev->mutex);
+}
+
+/*
+ * Enter with device blocked by us but not locked
+ * Exit with device locked, and blocked by previous owner
+ */
+void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
+{
+ Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n",
+ dev->dev_blocked, hold->dev_blocked, file, line);
+ P(dev->mutex);
+ dev->dev_blocked = hold->dev_blocked;
+ dev->dev_prev_blocked = hold->dev_prev_blocked;
+ dev->no_wait_id = hold->no_wait_id;
+ if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
+ pthread_cond_broadcast(&dev->wait); /* wake them up */
+ }
+}
projects / bacula / bacula / blobdiff