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 bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
104 Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
105 dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
106 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
107 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
108 if (!dir_update_volume_info(dcr, false)) { /* send Volume info to Director */
111 return false; /* device locked */
113 Dmsg0(100, "Back from update_vol_info\n");
115 bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
116 bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
118 label_blk = new_block(dev);
119 dcr->block = label_blk;
121 /* Inform User about end of medium */
122 Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
123 PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
124 edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
125 bstrftime(dt, sizeof(dt), time(NULL)));
127 if (!mount_next_write_volume(dcr, 1)) {
128 free_block(label_blk);
132 return false; /* device locked */
134 P(dev->mutex); /* lock again */
136 Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
137 dcr->VolumeName, dev_name(dev), bstrftime(dt, sizeof(dt), time(NULL)));
140 * If this is a new tape, the label_blk will contain the
141 * label, so write it now. If this is a previously
142 * used tape, mount_next_write_volume() will return an
143 * empty label_blk, and nothing will be written.
145 Dmsg0(190, "write label block to dev\n");
146 if (!write_block_to_dev(dcr)) {
148 Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
149 be.strerror(dev->dev_errno));
150 free_block(label_blk);
153 return false; /* device locked */
155 free_block(label_blk);
159 * Walk through all attached jcrs indicating the volume has changed
161 Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
162 // for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
164 foreach_dlist(mdcr, dev->attached_dcrs) {
165 JCR *mjcr = mdcr->jcr;
166 if (mjcr->JobId == 0) {
167 continue; /* ignore console */
171 bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
175 /* Clear NewVol now because dir_get_volume_info() already done */
176 jcr->dcr->NewVol = false;
177 set_new_volume_parameters(dcr);
179 jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
181 /* Write overflow block to device */
182 Dmsg0(190, "Write overflow block to dev\n");
183 if (!write_block_to_dev(dcr)) {
185 Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
186 be.strerror(dev->dev_errno));
188 return false; /* device locked */
192 return true; /* device locked */
196 * We have a new Volume mounted, so reset the Volume parameters
197 * concerning this job. The global changes were made earlier
198 * in the dev structure.
200 void set_new_volume_parameters(DCR *dcr)
203 DEVICE *dev = dcr->dev;
204 if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
205 Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
207 /* Set new start/end positions */
208 if (dev_state(dev, ST_TAPE)) {
209 dcr->StartBlock = dev->block_num;
210 dcr->StartFile = dev->file;
212 dcr->StartBlock = (uint32_t)dev->file_addr;
213 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
216 dcr->VolFirstIndex = 0;
217 dcr->VolLastIndex = 0;
220 dcr->WroteVol = false;
224 * We are now in a new Volume file, so reset the Volume parameters
225 * concerning this job. The global changes were made earlier
226 * in the dev structure.
228 void set_new_file_parameters(DCR *dcr)
230 DEVICE *dev = dcr->dev;
232 /* Set new start/end positions */
233 if (dev_state(dev, ST_TAPE)) {
234 dcr->StartBlock = dev->block_num;
235 dcr->StartFile = dev->file;
237 dcr->StartBlock = (uint32_t)dev->file_addr;
238 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
241 dcr->VolFirstIndex = 0;
242 dcr->VolLastIndex = 0;
243 dcr->NewFile = false;
244 dcr->WroteVol = false;
250 * First Open of the device. Expect dev to already be initialized.
252 * This routine is used only when the Storage daemon starts
253 * and always_open is set, and in the stand-alone utility
254 * routines such as bextract.
256 * Note, opening of a normal file is deferred to later so
257 * that we can get the filename; the device_name for
258 * a file is the directory only.
260 * Returns: false on failure
263 bool first_open_device(DEVICE *dev)
265 Dmsg0(120, "start open_output_device()\n");
272 /* Defer opening files */
273 if (!dev_is_tape(dev)) {
274 Dmsg0(129, "Device is file, deferring open.\n");
279 if (!(dev->state & ST_OPENED)) {
281 if (dev_cap(dev, CAP_STREAM)) {
282 mode = OPEN_WRITE_ONLY;
284 mode = OPEN_READ_WRITE;
286 Dmsg0(129, "Opening device.\n");
287 if (open_dev(dev, NULL, mode) < 0) {
288 Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
293 Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
300 * Make sure device is open, if not do so
302 bool open_device(DCR *dcr)
304 DEVICE *dev = dcr->dev;
306 if (!(dev_state(dev, ST_OPENED))) {
308 if (dev_cap(dev, CAP_STREAM)) {
309 mode = OPEN_WRITE_ONLY;
311 mode = OPEN_READ_WRITE;
313 if (open_dev(dev, dcr->VolCatInfo.VolCatName, mode) < 0) {
314 /* If polling, ignore the error */
316 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
317 dev_name(dev), strerror_dev(dev));
325 void dev_lock(DEVICE *dev)
328 if ((errstat=rwl_writelock(&dev->lock))) {
329 Emsg1(M_ABORT, 0, "Device write lock failure. ERR=%s\n", strerror(errstat));
333 void dev_unlock(DEVICE *dev)
336 if ((errstat=rwl_writeunlock(&dev->lock))) {
337 Emsg1(M_ABORT, 0, "Device write unlock failure. ERR=%s\n", strerror(errstat));
342 * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
343 * must wait. The no_wait_id thread is out obtaining a new volume
344 * and preparing the label.
346 void _lock_device(const char *file, int line, DEVICE *dev)
349 Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
351 if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
352 dev->num_waiting++; /* indicate that I am waiting */
353 while (dev->dev_blocked) {
354 if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
356 Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
360 dev->num_waiting--; /* no longer waiting */
365 * Check if the device is blocked or not
367 bool device_is_unmounted(DEVICE *dev)
370 int blocked = dev->dev_blocked;
371 stat = (blocked == BST_UNMOUNTED) ||
372 (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
376 const char *edit_blocked_reason(DEVICE *dev)
378 switch (dev->dev_blocked) {
379 case BST_NOT_BLOCKED:
380 return "not blocked";
382 return "user unmounted device";
383 case BST_WAITING_FOR_SYSOP:
384 return "waiting for operator action";
385 case BST_DOING_ACQUIRE:
386 return "opening, validating, or positioning tape";
387 case BST_WRITING_LABEL:
388 return "labeling tape";
389 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
390 return "closed by user during mount request";
392 return "mount request";
394 return "unknown blocked code";
398 void _unlock_device(const char *file, int line, DEVICE *dev)
400 Dmsg2(500, "unlock from %s:%d\n", file, line);
405 * Block all other threads from using the device
406 * Device must already be locked. After this call,
407 * the device is blocked to any thread calling lock_device(),
408 * but the device is not locked (i.e. no P on device). Also,
409 * the current thread can do slip through the lock_device()
410 * calls without blocking.
412 void _block_device(const char *file, int line, DEVICE *dev, int state)
414 Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
415 ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
416 dev->dev_blocked = state; /* make other threads wait */
417 dev->no_wait_id = pthread_self(); /* allow us to continue */
423 * Unblock the device, and wake up anyone who went to sleep.
425 void _unblock_device(const char *file, int line, DEVICE *dev)
427 Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
428 ASSERT(dev->dev_blocked);
429 dev->dev_blocked = BST_NOT_BLOCKED;
431 if (dev->num_waiting > 0) {
432 pthread_cond_broadcast(&dev->wait); /* wake them up */
437 * Enter with device locked and blocked
438 * Exit with device unlocked and blocked by us.
440 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
442 Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
444 hold->dev_blocked = dev->dev_blocked;
445 hold->dev_prev_blocked = dev->dev_prev_blocked;
446 hold->no_wait_id = dev->no_wait_id;
447 dev->dev_blocked = state;
448 dev->no_wait_id = pthread_self();
453 * Enter with device blocked by us but not locked
454 * Exit with device locked, and blocked by previous owner
456 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
458 Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n",
459 dev->dev_blocked, hold->dev_blocked, file, line);
461 dev->dev_blocked = hold->dev_blocked;
462 dev->dev_prev_blocked = hold->dev_prev_blocked;
463 dev->no_wait_id = hold->no_wait_id;
464 if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
465 pthread_cond_broadcast(&dev->wait); /* wake them up */