3 * Higher Level Device routines.
4 * Knows about Bacula tape labels and such
6 * NOTE! In general, subroutines that have the word
7 * "device" in the name do locking. Subroutines
8 * that have the word "dev" in the name do not
9 * do locking. Thus if xxx_device() calls
10 * yyy_dev(), all is OK, but if xxx_device()
11 * calls yyy_device(), everything will hang.
12 * Obviously, no zzz_dev() is allowed to call
13 * a www_device() or everything falls apart.
15 * Concerning the routines lock_device() and block_device()
16 * see the end of this module for details. In general,
17 * blocking a device leaves it in a state where all threads
18 * other than the current thread block when they attempt to
19 * lock the device. They remain suspended (blocked) until the device
20 * is unblocked. So, a device is blocked during an operation
21 * that takes a long time (initialization, mounting a new
22 * volume, ...) locking a device is done for an operation
23 * that takes a short time such as writing data to the
27 * Kern Sibbald, MM, MMI
32 Copyright (C) 2000-2004 Kern Sibbald and John Walker
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
51 #include "bacula.h" /* pull in global headers */
52 #include "stored.h" /* pull in Storage Deamon headers */
54 /* Forward referenced functions */
56 extern char my_name[];
57 extern int debug_level;
60 * This is the dreaded moment. We either have an end of
61 * medium condition or worse, and error condition.
62 * Attempt to "recover" by obtaining a new Volume.
64 * Here are a few things to know:
65 * dcr->VolCatInfo contains the info on the "current" tape for this job.
66 * dev->VolCatInfo contains the info on the tape in the drive.
67 * The tape in the drive could have changed several times since
68 * the last time the job used it (jcr->VolCatInfo).
69 * dcr->VolumeName is the name of the current/desired tape in the drive.
71 * We enter with device locked, and
72 * exit with device locked.
74 * Note, we are called only from one place in block.c
76 * Returns: true on success
79 bool fixup_device_block_write_error(DCR *dcr)
82 char PrevVolName[MAX_NAME_LENGTH];
84 DEV_BLOCK *block = dcr->block;
87 char dt[MAX_TIME_LENGTH];
89 DEVICE *dev = dcr->dev;
91 wait_time = time(NULL);
92 stat = status_dev(dev);
93 if (!(stat & BMT_EOD)) {
94 return false; /* this really shouldn't happen */
97 Dmsg0(100, "======= Got EOD ========\n");
99 block_device(dev, BST_DOING_ACQUIRE);
100 /* Unlock, but leave BLOCKED */
103 /* Create a jobmedia record for this job */
104 if (!dir_create_jobmedia_record(dcr)) {
105 Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
106 dcr->VolCatInfo.VolCatName, jcr->Job);
112 bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
113 Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
114 dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
115 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
116 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
117 if (!dir_update_volume_info(dcr, false)) { /* send Volume info to Director */
120 return false; /* device locked */
122 Dmsg0(100, "Back from update_vol_info\n");
124 bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
125 bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
127 label_blk = new_block(dev);
128 dcr->block = label_blk;
130 /* Inform User about end of medium */
131 Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
132 PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
133 edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
134 bstrftime(dt, sizeof(dt), time(NULL)));
136 if (!mount_next_write_volume(dcr, 1)) {
137 free_block(label_blk);
141 return false; /* device locked */
143 P(dev->mutex); /* lock again */
145 Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
146 dcr->VolumeName, dev_name(dev), bstrftime(dt, sizeof(dt), time(NULL)));
149 * If this is a new tape, the label_blk will contain the
150 * label, so write it now. If this is a previously
151 * used tape, mount_next_write_volume() will return an
152 * empty label_blk, and nothing will be written.
154 Dmsg0(190, "write label block to dev\n");
155 if (!write_block_to_dev(dcr)) {
156 Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
158 free_block(label_blk);
161 return false; /* device locked */
163 free_block(label_blk);
167 * Walk through all attached jcrs indicating the volume has changed
169 Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
170 // for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
172 foreach_dlist(mdcr, dev->attached_dcrs) {
173 JCR *mjcr = mdcr->jcr;
174 if (mjcr->JobId == 0) {
175 continue; /* ignore console */
179 bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
183 /* Clear NewVol now because dir_get_volume_info() already done */
184 jcr->dcr->NewVol = false;
185 set_new_volume_parameters(dcr);
187 jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
189 /* Write overflow block to device */
190 Dmsg0(190, "Write overflow block to dev\n");
191 if (!write_block_to_dev(dcr)) {
192 Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
195 return false; /* device locked */
199 return true; /* device locked */
203 * We have a new Volume mounted, so reset the Volume parameters
204 * concerning this job. The global changes were made earlier
205 * in the dev structure.
207 void set_new_volume_parameters(DCR *dcr)
210 DEVICE *dev = dcr->dev;
211 if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
212 Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
214 /* Set new start/end positions */
215 if (dev_state(dev, ST_TAPE)) {
216 dcr->StartBlock = dev->block_num;
217 dcr->StartFile = dev->file;
219 dcr->StartBlock = (uint32_t)dev->file_addr;
220 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
223 dcr->VolFirstIndex = 0;
224 dcr->VolLastIndex = 0;
227 dcr->WroteVol = false;
231 * We are now in a new Volume file, so reset the Volume parameters
232 * concerning this job. The global changes were made earlier
233 * in the dev structure.
235 void set_new_file_parameters(DCR *dcr)
237 DEVICE *dev = dcr->dev;
239 /* Set new start/end positions */
240 if (dev_state(dev, ST_TAPE)) {
241 dcr->StartBlock = dev->block_num;
242 dcr->StartFile = dev->file;
244 dcr->StartBlock = (uint32_t)dev->file_addr;
245 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
248 dcr->VolFirstIndex = 0;
249 dcr->VolLastIndex = 0;
250 dcr->NewFile = false;
251 dcr->WroteVol = false;
257 * First Open of the device. Expect dev to already be initialized.
259 * This routine is used only when the Storage daemon starts
260 * and always_open is set, and in the stand-alone utility
261 * routines such as bextract.
263 * Note, opening of a normal file is deferred to later so
264 * that we can get the filename; the device_name for
265 * a file is the directory only.
267 * Returns: false on failure
270 bool first_open_device(DEVICE *dev)
272 Dmsg0(120, "start open_output_device()\n");
279 /* Defer opening files */
280 if (!dev_is_tape(dev)) {
281 Dmsg0(129, "Device is file, deferring open.\n");
286 if (!(dev->state & ST_OPENED)) {
288 if (dev_cap(dev, CAP_STREAM)) {
289 mode = OPEN_WRITE_ONLY;
291 mode = OPEN_READ_WRITE;
293 Dmsg0(129, "Opening device.\n");
294 if (open_dev(dev, NULL, mode) < 0) {
295 Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
300 Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
307 * Make sure device is open, if not do so
309 bool open_device(DCR *dcr)
311 DEVICE *dev = dcr->dev;
313 if (!(dev_state(dev, ST_OPENED))) {
315 if (dev_cap(dev, CAP_STREAM)) {
316 mode = OPEN_WRITE_ONLY;
318 mode = OPEN_READ_WRITE;
320 if (open_dev(dev, dcr->VolCatInfo.VolCatName, mode) < 0) {
321 /* If polling, ignore the error */
323 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
324 dev_name(dev), strerror_dev(dev));
332 void dev_lock(DEVICE *dev)
335 if ((errstat=rwl_writelock(&dev->lock))) {
336 Emsg1(M_ABORT, 0, "Device write lock failure. ERR=%s\n", strerror(errstat));
340 void dev_unlock(DEVICE *dev)
343 if ((errstat=rwl_writeunlock(&dev->lock))) {
344 Emsg1(M_ABORT, 0, "Device write unlock failure. ERR=%s\n", strerror(errstat));
349 * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
350 * must wait. The no_wait_id thread is out obtaining a new volume
351 * and preparing the label.
353 void _lock_device(const char *file, int line, DEVICE *dev)
356 Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
358 if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
359 dev->num_waiting++; /* indicate that I am waiting */
360 while (dev->dev_blocked) {
361 if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
363 Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
367 dev->num_waiting--; /* no longer waiting */
372 * Check if the device is blocked or not
374 bool device_is_unmounted(DEVICE *dev)
377 int blocked = dev->dev_blocked;
378 stat = (blocked == BST_UNMOUNTED) ||
379 (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
383 const char *edit_blocked_reason(DEVICE *dev)
385 switch (dev->dev_blocked) {
386 case BST_NOT_BLOCKED:
387 return "not blocked";
389 return "user unmounted device";
390 case BST_WAITING_FOR_SYSOP:
391 return "waiting for operator action";
392 case BST_DOING_ACQUIRE:
393 return "opening, validating, or positioning tape";
394 case BST_WRITING_LABEL:
395 return "labeling tape";
396 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
397 return "closed by user during mount request";
399 return "mount request";
401 return "unknown blocked code";
405 void _unlock_device(const char *file, int line, DEVICE *dev)
407 Dmsg2(500, "unlock from %s:%d\n", file, line);
412 * Block all other threads from using the device
413 * Device must already be locked. After this call,
414 * the device is blocked to any thread calling lock_device(),
415 * but the device is not locked (i.e. no P on device). Also,
416 * the current thread can do slip through the lock_device()
417 * calls without blocking.
419 void _block_device(const char *file, int line, DEVICE *dev, int state)
421 Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
422 ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
423 dev->dev_blocked = state; /* make other threads wait */
424 dev->no_wait_id = pthread_self(); /* allow us to continue */
430 * Unblock the device, and wake up anyone who went to sleep.
432 void _unblock_device(const char *file, int line, DEVICE *dev)
434 Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
435 ASSERT(dev->dev_blocked);
436 dev->dev_blocked = BST_NOT_BLOCKED;
438 if (dev->num_waiting > 0) {
439 pthread_cond_broadcast(&dev->wait); /* wake them up */
444 * Enter with device locked and blocked
445 * Exit with device unlocked and blocked by us.
447 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
449 Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
451 hold->dev_blocked = dev->dev_blocked;
452 hold->dev_prev_blocked = dev->dev_prev_blocked;
453 hold->no_wait_id = dev->no_wait_id;
454 dev->dev_blocked = state;
455 dev->no_wait_id = pthread_self();
460 * Enter with device blocked by us but not locked
461 * Exit with device locked, and blocked by previous owner
463 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
465 Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n",
466 dev->dev_blocked, hold->dev_blocked, file, line);
468 dev->dev_blocked = hold->dev_blocked;
469 dev->dev_prev_blocked = hold->dev_prev_blocked;
470 dev->no_wait_id = hold->no_wait_id;
471 if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
472 pthread_cond_broadcast(&dev->wait); /* wake them up */