+/*
+ Bacula® - The Network Backup Solution
+
+ Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
+
+ The main author of Bacula is Kern Sibbald, with contributions from
+ many others, a complete list can be found in the file AUTHORS.
+ This program is Free Software; you can redistribute it and/or
+ modify it under the terms of version two of the GNU General Public
+ License as published by the Free Software Foundation plus additions
+ that are listed in the file LICENSE.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+
+ Bacula® is a registered trademark of John Walker.
+ The licensor of Bacula is the Free Software Foundation Europe
+ (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+ Switzerland, email:ftf@fsfeurope.org.
+*/
/*
*
- * 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
* that have the word "dev" in the name do not
- * do locking. Thus if xxx_device() calls
- * 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.
+ * do locking. Thus if xxx_device() calls
+ * 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.
*
- * Concerning the routines lock_device() and block_device()
+ * Concerning the routines dev->r_lock()() 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-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
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public
- License along with this program; if not, write to the Free
- Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- MA 02111-1307, USA.
-
- */
#include "bacula.h" /* pull in global headers */
#include "stored.h" /* pull in Storage Deamon headers */
-/* Forward referenced functions */
+#ifdef SD_DEBUG_LOCK
+const int dbglvl = 0;
+#else
+const int dbglvl = 500;
+#endif
-extern char my_name[];
-extern int debug_level;
+
+/* Forward referenced functions */
/*
* This is the dreaded moment. We either have an end of
* 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 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
+ * We enter with device locked, and
* exit with device locked.
*
- * Note, we are called only from one place in block.c
+ * Note, we are called only from one place in block.c for the daemons.
+ * The btape utility calls it from btape.c.
*
* Returns: true on success
- * false on failure
+ * false on failure
*/
bool fixup_device_block_write_error(DCR *dcr)
{
- uint32_t stat;
char PrevVolName[MAX_NAME_LENGTH];
DEV_BLOCK *label_blk;
DEV_BLOCK *block = dcr->block;
DEVICE *dev = dcr->dev;
wait_time = time(NULL);
- stat = status_dev(dev);
- if (!(stat & BMT_EOD)) {
- return false; /* this really shouldn't happen */
- }
- Dmsg0(100, "======= Got EOD ========\n");
+ Dmsg0(100, "Enter fixup_device_block_write_error\n");
block_device(dev, BST_DOING_ACQUIRE);
/* Unlock, but leave BLOCKED */
- unlock_device(dev);
-
- /* Create a jobmedia record for this job */
- if (!dir_create_jobmedia_record(dcr)) {
- Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
- dcr->VolCatInfo.VolCatName, jcr->Job);
- P(dev->mutex);
- unblock_device(dev);
- return false;
- }
-
- 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");
+ dev->dunlock();
bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
- bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
+ bstrncpy(dev->VolHdr.PrevVolumeName, PrevVolName, sizeof(dev->VolHdr.PrevVolumeName));
label_blk = new_block(dev);
dcr->block = label_blk;
/* 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)));
+ 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)));
if (!mount_next_write_volume(dcr, 1)) {
free_block(label_blk);
dcr->block = block;
- P(dev->mutex);
+ dev->dlock();
unblock_device(dev);
- return false; /* device locked */
+ return false; /* device locked */
}
- P(dev->mutex); /* lock again */
+ dev->dlock(); /* lock again */
+
+ dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
+ dir_update_volume_info(dcr, false); /* send Volume info to Director */
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)));
+ dcr->VolumeName, dev->print_name(), 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
*/
Dmsg0(190, "write label block to dev\n");
if (!write_block_to_dev(dcr)) {
- Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
- strerror_dev(dev));
+ 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 */
+ return false; /* device locked */
}
free_block(label_blk);
dcr->block = block;
- /*
- * Walk through all attached jcrs indicating the volume has changed
+ /*
+ * 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)); ) {
+ Dmsg1(100, "Walk attached dcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
DCR *mdcr;
foreach_dlist(mdcr, dev->attached_dcrs) {
JCR *mjcr = mdcr->jcr;
if (mjcr->JobId == 0) {
- continue; /* ignore console */
+ continue; /* ignore console */
}
mdcr->NewVol = true;
if (jcr != mjcr) {
- bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
+ bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
}
}
/* Write overflow block to device */
Dmsg0(190, "Write overflow block to dev\n");
if (!write_block_to_dev(dcr)) {
- Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
- strerror_dev(dev));
+ 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 */
+ return false; /* device locked */
}
unblock_device(dev);
- return true; /* device locked */
+ return true; /* device locked */
}
/*
Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
}
/* Set new start/end positions */
- if (dev_state(dev, ST_TAPE)) {
+ if (dev->is_tape()) {
dcr->StartBlock = dev->block_num;
dcr->StartFile = dev->file;
} else {
/* Reset indicies */
dcr->VolFirstIndex = 0;
dcr->VolLastIndex = 0;
- jcr->NumVolumes++;
+ jcr->NumWriteVolumes++;
dcr->NewVol = false;
dcr->WroteVol = false;
}
void set_new_file_parameters(DCR *dcr)
{
DEVICE *dev = dcr->dev;
-
+
/* Set new start/end positions */
- if (dev_state(dev, ST_TAPE)) {
+ if (dev->is_tape()) {
dcr->StartBlock = dev->block_num;
dcr->StartFile = dev->file;
} else {
/*
- * First Open of 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.
*
* Returns: false on failure
- * true on success
+ * true on success
*/
-bool first_open_device(DEVICE *dev)
+bool first_open_device(DCR *dcr)
{
+ DEVICE *dev = dcr->dev;
+ bool ok = true;
+
Dmsg0(120, "start open_output_device()\n");
if (!dev) {
return false;
}
- lock_device(dev);
+ dev->r_dlock();
/* Defer opening files */
- if (!dev_is_tape(dev)) {
+ if (!dev->is_tape()) {
Dmsg0(129, "Device is file, deferring open.\n");
- unlock_device(dev);
- return true;
+ goto bail_out;
}
- 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, mode) < 0) {
- Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
- unlock_device(dev);
- return false;
- }
+ int mode;
+ if (dev->has_cap(CAP_STREAM)) {
+ mode = OPEN_WRITE_ONLY;
+ } else {
+ mode = OPEN_READ_ONLY;
+ }
+ Dmsg0(129, "Opening device.\n");
+ if (dev->open(dcr, mode) < 0) {
+ Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
+ ok = false;
+ goto bail_out;
}
- Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
+ Dmsg1(129, "open dev %s OK\n", dev->print_name());
- unlock_device(dev);
- return true;
+bail_out:
+ dev->dunlock();
+ return ok;
}
-/*
- * Make sure device is open, if not do so
+/*
+ * 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));
+ int mode;
+ if (dev->has_cap(CAP_STREAM)) {
+ mode = OPEN_WRITE_ONLY;
+ } else {
+ mode = OPEN_READ_WRITE;
}
-}
-
-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));
+ if (dev->open(dcr, mode) < 0) {
+ /* If polling, ignore the error */
+ /* If DVD, also ignore the error, very often you cannot open the device
+ * (when there is no DVD, or when the one inserted is a wrong one) */
+ if (!dev->poll && !dev->is_dvd() && !dev->is_removable()) {
+ Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
+ dev->print_name(), dev->bstrerror());
+ Pmsg2(000, _("Unable to open archive %s: ERR=%s\n"),
+ dev->print_name(), dev->bstrerror());
+ }
+ return false;
}
+ return true;
}
-/*
- * 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.
+/*
+ * Find which JobId corresponds to the current thread
*/
-void _lock_device(const char *file, int line, DEVICE *dev)
+uint32_t get_jobid_from_tid()
{
- int stat;
- 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"),
- strerror(stat));
- }
+ JCR *jcr;
+ uint32_t JobId = 0;
+ foreach_jcr(jcr) {
+ if (pthread_equal(jcr->my_thread_id, pthread_self())) {
+ JobId = (uint32_t)jcr->JobId;
+ break;
}
- dev->num_waiting--; /* no longer waiting */
}
+ endeach_jcr(jcr);
+ return JobId;
}
/*
* Check if the device is blocked or not
*/
-bool device_is_unmounted(DEVICE *dev)
+bool is_device_unmounted(DEVICE *dev)
{
bool stat;
- int blocked = dev->dev_blocked;
+ int blocked = dev->blocked();
stat = (blocked == BST_UNMOUNTED) ||
- (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
+ (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
return stat;
}
-const char *edit_blocked_reason(DEVICE *dev)
+#ifdef SD_DEBUG_LOCK
+void DEVICE::_dlock(const char *file, int line)
{
- 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";
+ Dmsg4(sd_dbglvl, "dlock from %s:%d precnt=%d JobId=%u\n", file, line,
+ m_count, get_jobid_from_tid());
+ /* Note, this *really* should be protected by a mutex, but
+ * since it is only debug code we don't worry too much.
+ */
+ if (m_count > 0 && pthread_equal(m_pid, pthread_self())) {
+ Dmsg2(sd_dbglvl, "DEADLOCK !!!!!!!!!! from %s:%d\n", file, line);
}
+ P(m_mutex);
+ m_pid = pthread_self();
+ m_count++;
+}
+
+void DEVICE::_dunlock(const char *file, int line)
+{
+ m_count--;
+ Dmsg4(sd_dbglvl, "dunlock from %s:%d postcnt=%d JobId=%u\n", file, line,
+ m_count, get_jobid_from_tid());
+ V(m_mutex);
+}
+
+void DEVICE::_r_dunlock(const char *file, int line)
+{
+ this->_dunlock(file, line);
}
-void _unlock_device(const char *file, int line, DEVICE *dev)
+#endif
+
+
+/*
+ * This is a recursive lock that checks if the device is blocked.
+ *
+ * When 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.
+ */
+#ifdef SD_DEBUG_LOCK
+void DEVICE::_r_dlock(const char *file, int line)
+#else
+void DEVICE::r_dlock()
+#endif
{
- Dmsg2(500, "unlock from %s:%d\n", file, line);
- V(dev->mutex);
+ int stat;
+#ifdef SD_DEBUG_LOCK
+ Dmsg4(sd_dbglvl, "r_dlock blked=%s from %s:%d JobId=%u\n", this->print_blocked(),
+ file, line, get_jobid_from_tid());
+#else
+ Dmsg1(sd_dbglvl, "reclock blked=%s\n", this->print_blocked());
+#endif
+ this->dlock();
+ if (this->blocked() && !pthread_equal(this->no_wait_id, pthread_self())) {
+ this->num_waiting++; /* indicate that I am waiting */
+ while (this->blocked()) {
+ Dmsg3(sd_dbglvl, "r_dlock blked=%s no_wait=%p me=%p\n", this->print_blocked(),
+ this->no_wait_id, pthread_self());
+ if ((stat = pthread_cond_wait(&this->wait, &m_mutex)) != 0) {
+ berrno be;
+ this->dunlock();
+ Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
+ be.strerror(stat));
+ }
+ }
+ this->num_waiting--; /* no longer waiting */
+ }
}
-/*
+/*
* 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 device is blocked to any thread calling dev->r_lock(),
* but the device is not locked (i.e. no P on device). Also,
- * the current thread can do slip through the lock_device()
+ * the current thread can do slip through the dev->r_lock()
* calls without blocking.
*/
void _block_device(const char *file, int line, DEVICE *dev, int 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 */
+ ASSERT(dev->blocked() == BST_NOT_BLOCKED);
+ dev->set_blocked(state); /* make other threads wait */
dev->no_wait_id = pthread_self(); /* allow us to continue */
+ Dmsg3(sd_dbglvl, "set blocked=%s from %s:%d\n", dev->print_blocked(), file, line);
}
-
-
/*
* Unblock the device, and wake up anyone who went to sleep.
+ * Enter: device locked
+ * Exit: device locked
*/
void _unblock_device(const char *file, int line, DEVICE *dev)
{
- Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
- ASSERT(dev->dev_blocked);
- dev->dev_blocked = BST_NOT_BLOCKED;
+ Dmsg3(sd_dbglvl, "unblock %s from %s:%d\n", dev->print_blocked(), file, line);
+ ASSERT(dev->blocked());
+ dev->set_blocked(BST_NOT_BLOCKED);
dev->no_wait_id = 0;
if (dev->num_waiting > 0) {
pthread_cond_broadcast(&dev->wait); /* wake them up */
*/
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,
+
+ Dmsg3(sd_dbglvl, "steal lock. old=%s from %s:%d\n", dev->print_blocked(),
file, line);
- hold->dev_blocked = dev->dev_blocked;
+ hold->dev_blocked = dev->blocked();
hold->dev_prev_blocked = dev->dev_prev_blocked;
hold->no_wait_id = dev->no_wait_id;
- dev->dev_blocked = state;
+ dev->set_blocked(state);
+ Dmsg1(sd_dbglvl, "steal lock. new=%s\n", dev->print_blocked());
dev->no_wait_id = pthread_self();
- V(dev->mutex);
+ dev->dunlock();
}
/*
* Enter with device blocked by us but not locked
- * Exit with device locked, and blocked by previous owner
+ * 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)
+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;
+ Dmsg3(sd_dbglvl, "return lock. old=%s from %s:%d\n",
+ dev->print_blocked(), file, line);
+ dev->dlock();
+ dev->set_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) {
+ Dmsg1(sd_dbglvl, "return lock. new=%s\n", dev->print_blocked());
+ if (dev->num_waiting > 0) {
pthread_cond_broadcast(&dev->wait); /* wake them up */
}
}