2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Routines to acquire and release a device for read/write
31 * Kern Sibbald, August MMII
36 #include "bacula.h" /* pull in global headers */
37 #include "stored.h" /* pull in Storage Deamon headers */
39 /* Forward referenced functions */
40 static void attach_dcr_to_dev(DCR *dcr);
43 /*********************************************************************
44 * Acquire device for reading.
45 * The drive should have previously been reserved by calling
46 * reserve_device_for_read(). We read the Volume label from the block and
47 * leave the block pointers just after the label.
49 * Returns: NULL if failed for any reason
52 bool acquire_device_for_read(DCR *dcr)
54 DEVICE *dev = dcr->dev;
57 bool tape_previously_mounted;
58 bool tape_initially_mounted;
60 bool try_autochanger = true;
65 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
66 dev->dblock(BST_DOING_ACQUIRE);
68 if (dev->num_writers > 0) {
69 Jmsg2(jcr, M_FATAL, 0, _("Acquire read: num_writers=%d not zero. Job %d canceled.\n"),
70 dev->num_writers, jcr->JobId);
74 /* Find next Volume, if any */
78 Jmsg(jcr, M_FATAL, 0, _("No volumes specified for reading. Job %s canceled.\n"),
79 edit_int64(jcr->JobId, ed1));
83 for (i=1; i<jcr->CurReadVolume; i++) {
87 Jmsg(jcr, M_FATAL, 0, _("Logic error: no next volume to read. Numvol=%d Curvol=%d\n"),
88 jcr->NumReadVolumes, jcr->CurReadVolume);
89 goto get_out; /* should not happen */
92 * Note, if we want to be able to work from a .bsr file only
93 * for disaster recovery, we must "simulate" reading the catalog
95 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
96 bstrncpy(dcr->VolCatInfo.VolCatName, vol->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
97 bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
98 dcr->VolCatInfo.Slot = vol->Slot;
99 dcr->VolCatInfo.InChanger = vol->Slot > 0;
102 * If the MediaType requested for this volume is not the
103 * same as the current drive, we attempt to find the same
104 * device that was used to write the orginal volume. If
105 * found, we switch to using that device.
107 * N.B. A lot of routines rely on the dcr pointer not changing
108 * read_records.c even has multiple dcrs cached, so we take care
109 * here to release all important parts of the dcr and re-acquire
110 * them such as the block pointer (size may change), but we do
111 * not release the dcr.
113 Dmsg2(50, "MediaType dcr=%s dev=%s\n", dcr->media_type, dev->device->media_type);
114 if (dcr->media_type[0] && strcmp(dcr->media_type, dev->device->media_type) != 0) {
119 Jmsg3(jcr, M_INFO, 0, _("Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
121 dcr->media_type, dev->device->media_type, dev->print_name());
122 Dmsg3(50, "Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
124 dcr->media_type, dev->device->media_type, dev->print_name());
126 dev->dunblock(DEV_UNLOCKED);
129 memset(&rctx, 0, sizeof(RCTX));
131 jcr->reserve_msgs = New(alist(10, not_owned_by_alist));
132 rctx.any_drive = true;
133 rctx.device_name = vol->device;
134 store = new DIRSTORE;
135 memset(store, 0, sizeof(DIRSTORE));
136 store->name[0] = 0; /* No dir name */
137 bstrncpy(store->media_type, vol->MediaType, sizeof(store->media_type));
138 bstrncpy(store->pool_name, dcr->pool_name, sizeof(store->pool_name));
139 bstrncpy(store->pool_type, dcr->pool_type, sizeof(store->pool_type));
140 store->append = false;
142 clean_device(dcr); /* clean up the dcr */
145 * Search for a new device
147 stat = search_res_for_device(rctx);
148 release_reserve_messages(jcr); /* release queued messages */
149 unlock_reservations();
152 dev = dcr->dev; /* get new device pointer */
153 dev->dblock(BST_DOING_ACQUIRE);
154 dcr->VolumeName[0] = 0;
155 Jmsg(jcr, M_INFO, 0, _("Media Type change. New device %s chosen.\n"),
157 Dmsg1(50, "Media Type change. New device %s chosen.\n", dev->print_name());
159 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
160 bstrncpy(dcr->VolCatInfo.VolCatName, vol->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
161 bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
162 dcr->VolCatInfo.Slot = vol->Slot;
163 dcr->VolCatInfo.InChanger = vol->Slot > 0;
164 bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
165 bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
168 Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
170 Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
175 if (reserve_volume(dcr, dcr->VolumeName) == NULL) {
176 Dmsg2(100, "Could not reserve volume %s on %s\n", dcr->VolumeName,
177 dcr->dev->print_name());
178 Jmsg2(jcr, M_FATAL, 0, _("Could not reserve volume %s on %s\n"), dcr->VolumeName,
179 dcr->dev->print_name());
182 if (dev->vol && dev->vol->is_swapping()) {
183 dev->vol->set_slot(vol->Slot);
184 Dmsg3(100, "swapping: slot=%d Vol=%s dev=%s\n", dev->vol->get_slot(),
185 dev->vol->vol_name, dev->print_name());
189 init_device_wait_timers(dcr);
191 tape_previously_mounted = dev->can_read() || dev->can_append() ||
193 tape_initially_mounted = tape_previously_mounted;
196 /* Volume info is always needed because of VolParts */
197 Dmsg1(150, "dir_get_volume_info vol=%s\n", dcr->VolumeName);
198 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
199 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
201 dev->set_load(); /* set to load volume */
204 /* If not polling limit retries */
205 if (!dev->poll && retry++ > 10) {
208 dev->clear_labeled(); /* force reread of label */
209 if (job_canceled(jcr)) {
211 Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
212 Jmsg(jcr, M_INFO, 0, dev->errmsg);
213 goto get_out; /* error return */
216 dcr->do_swapping(false/*is_writing*/);
219 * This code ensures that the device is ready for
220 * reading. If it is a file, it opens it.
221 * If it is a tape, it checks the volume name
223 Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
224 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
226 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
227 dev->print_name(), dcr->VolumeName, dev->bstrerror());
231 Dmsg1(50, "opened dev %s OK\n", dev->print_name());
233 /* Read Volume Label */
234 Dmsg0(50, "calling read-vol-label\n");
235 vol_label_status = read_dev_volume_label(dcr);
236 switch (vol_label_status) {
239 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
243 * Send error message generated by read_dev_volume_label()
244 * only we really had a tape mounted. This supresses superfluous
245 * error messages when nothing is mounted.
247 if (tape_previously_mounted) {
248 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
252 if (tape_initially_mounted) {
253 tape_initially_mounted = false;
256 /* If polling and got a previous bad name, ignore it */
257 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
260 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
262 if (!unload_autochanger(dcr, -1)) {
263 /* at least free the device so we can re-open with correct volume */
268 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
270 tape_previously_mounted = true;
273 * If the device requires mount, close it, so the device can be ejected.
275 if (dev->requires_mount()) {
279 /* Call autochanger only once unless ask_sysop called */
280 if (try_autochanger) {
282 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
283 dcr->VolumeName, dcr->VolCatInfo.Slot);
284 stat = autoload_device(dcr, 0, NULL);
286 try_autochanger = false;
287 continue; /* try reading volume mounted */
289 /* Try closing and re-opening */
292 if (dev->open(dcr, OPEN_READ_ONLY) >= 0) {
296 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
297 dev->print_name(), dcr->VolumeName, dev->bstrerror());
301 /* Mount a specific volume and no other */
302 Dmsg0(200, "calling dir_ask_sysop\n");
303 if (!dir_ask_sysop_to_mount_volume(dcr, ST_READ)) {
304 goto get_out; /* error return */
306 try_autochanger = true; /* permit using autochanger again */
307 continue; /* try reading again */
312 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
319 set_jcr_job_status(jcr, JS_Running);
320 dir_send_job_status(jcr);
321 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
322 dcr->VolumeName, dev->print_name());
326 dcr->clear_reserved();
328 * Normally we are blocked, but in at least one error case above
329 * we are not blocked because we unsuccessfully tried changing
332 if (dev->is_blocked()) {
333 dev->dunblock(DEV_LOCKED);
335 dev->dunlock(); /* dunblock() unlock the device too */
337 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
343 * Acquire device for writing. We permit multiple writers.
344 * If this is the first one, we read the label.
346 * Returns: NULL if failed for any reason
348 * Note, normally reserve_device_for_append() is called
349 * before this routine.
351 DCR *acquire_device_for_append(DCR *dcr)
353 DEVICE *dev = dcr->dev;
356 bool have_vol = false;
358 init_device_wait_timers(dcr);
360 dev->dblock(BST_DOING_ACQUIRE);
361 Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
362 (dev->is_dvd()?"DVD":"disk"));
365 * With the reservation system, this should not happen
367 if (dev->can_read()) {
368 Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
369 Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
374 * have_vol defines whether or not mount_next_write_volume should
375 * ask the Director again about what Volume to use.
377 if (dev->can_append() && dcr->is_suitable_volume_mounted() &&
378 strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") != 0) {
379 Dmsg0(190, "device already in append.\n");
381 * At this point, the correct tape is already mounted, so
382 * we do not need to do mount_next_write_volume(), unless
383 * we need to recycle the tape.
385 if (dev->num_writers == 0) {
386 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
388 have_vol = dcr->is_tape_position_ok();
392 Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
393 if (!dcr->mount_next_write_volume()) {
394 if (!job_canceled(jcr)) {
395 /* Reduce "noise" -- don't print if job canceled */
396 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
398 Dmsg1(200, "Could not ready device %s for append.\n",
403 Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
406 dev->num_writers++; /* we are now a writer */
407 if (jcr->NumWriteVolumes == 0) {
408 jcr->NumWriteVolumes = 1;
410 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
411 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
416 dcr->clear_reserved();
417 dev->dunblock(DEV_LOCKED);
418 return ok ? dcr : NULL;
422 * This job is done, so release the device. From a Unix standpoint,
423 * the device remains open.
425 * Note, if we are spooling, we may enter with the device locked.
426 * However, in all cases, unlock the device when leaving.
429 bool release_device(DCR *dcr)
432 DEVICE *dev = dcr->dev;
436 /* lock only if not already locked by this thread */
437 if (!dcr->is_dev_locked()) {
441 Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
443 /* if device is reserved, job never started, so release the reserve here */
444 dcr->clear_reserved();
446 if (dev->can_read()) {
447 dev->clear_read(); /* clear read bit */
448 Dmsg0(100, "dir_update_vol_info. Release0\n");
449 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
452 } else if (dev->num_writers > 0) {
454 * Note if WEOT is set, we are at the end of the tape
455 * and may not be positioned correctly, so the
456 * job_media_record and update_vol_info have already been
457 * done, which means we skip them here.
460 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
461 if (dev->is_labeled()) {
462 Dmsg2(200, "dir_create_jobmedia. Release vol=%s dev=%s\n",
463 dev->VolCatInfo.VolCatName, dev->print_name());
464 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
465 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
466 dcr->VolCatInfo.VolCatName, jcr->Job);
468 /* If no more writers, and no errors, and wrote something, write an EOF */
469 if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
471 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
473 if (!dev->at_weot()) {
474 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
475 /* Note! do volume update before close, which zaps VolCatInfo */
476 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
477 Dmsg2(200, "dir_update_vol_info. Release vol=%s dev=%s\n",
478 dev->VolCatInfo.VolCatName, dev->print_name());
480 if (dev->num_writers == 0) { /* if not being used */
481 volume_unused(dcr); /* we obviously are not using the volume */
487 * If we reach here, it is most likely because the job
488 * has failed, since the device is not in read mode and
489 * there are no writers. It was probably reserved.
494 Dmsg3(100, "%d writers, %d reserve, dev=%s\n", dev->num_writers, dev->num_reserved(),
496 debug_list_volumes("acquire:release_device()");
499 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
500 if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
501 dvd_remove_empty_part(dcr); /* get rid of any empty spool part */
505 /* Fire off Alert command and include any output */
506 if (!job_canceled(jcr) && dcr->device->alert_command) {
510 char line[MAXSTRING];
511 alert = get_pool_memory(PM_FNAME);
512 alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
513 bpipe = open_bpipe(alert, 0, "r");
515 while (fgets(line, sizeof(line), bpipe->rfd)) {
516 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
518 status = close_bpipe(bpipe);
524 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
525 alert, be.bstrerror(status));
528 Dmsg1(400, "alert status=%d\n", status);
529 free_pool_memory(alert);
531 pthread_cond_broadcast(&dev->wait_next_vol);
532 Dmsg2(100, "JobId=%u broadcast wait_device_release at %s\n",
533 (uint32_t)jcr->JobId, bstrftimes(tbuf, sizeof(tbuf), (utime_t)time(NULL)));
534 pthread_cond_broadcast(&wait_device_release);
537 detach_dcr_from_dev(dcr);
539 if (jcr->read_dcr == dcr) {
540 jcr->read_dcr = NULL;
542 if (jcr->dcr == dcr) {
547 Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
548 (uint32_t)jcr->JobId);
553 * Clean up the device for reuse without freeing the memory
555 bool clean_device(DCR *dcr)
558 dcr->keep_dcr = true; /* do not free the dcr */
559 ok = release_device(dcr);
560 dcr->keep_dcr = false;
565 * Create a new Device Control Record and attach
566 * it to the device (if this is a real job).
567 * Note, this has been updated so that it can be called first
568 * without a DEVICE, then a second or third time with a DEVICE,
569 * and each time, it should cleanup and point to the new device.
570 * This should facilitate switching devices.
571 * Note, each dcr must point to the controlling job (jcr). However,
572 * a job can have multiple dcrs, so we must not store in the jcr's
573 * structure as previously. The higher level routine must store
574 * this dcr in the right place
577 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
580 dcr = (DCR *)malloc(sizeof(DCR));
581 memset(dcr, 0, sizeof(DCR));
582 dcr->tid = pthread_self();
585 dcr->jcr = jcr; /* point back to jcr */
586 /* Set device information, possibly change device */
589 free_block(dcr->block);
591 dcr->block = new_block(dev);
593 free_record(dcr->rec);
595 dcr->rec = new_record();
596 if (dcr->attached_to_dev) {
597 detach_dcr_from_dev(dcr);
599 /* Use job spoolsize prior to device spoolsize */
600 if (jcr->spool_size) {
601 dcr->max_job_spool_size = jcr->spool_size;
603 dcr->max_job_spool_size = dev->device->max_job_spool_size;
605 dcr->device = dev->device;
607 attach_dcr_to_dev(dcr);
613 * Search the dcrs list for the given dcr. If it is found,
614 * as it should be, then remove it. Also zap the jcr pointer
615 * to the dcr if it is the same one.
617 * Note, this code will be turned on when we can write to multiple
618 * dcrs at the same time.
621 static void remove_dcr_from_dcrs(DCR *dcr)
627 int num = jcr->dcrs->size();
628 for (i=0; i < num; i++) {
629 ldcr = (DCR *)jcr->dcrs->get(i);
631 jcr->dcrs->remove(i);
632 if (jcr->dcr == dcr) {
641 static void attach_dcr_to_dev(DCR *dcr)
643 DEVICE *dev = dcr->dev;
646 if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
647 if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
648 dev->attached_dcrs->append(dcr); /* attach dcr to device */
649 dcr->attached_to_dev = true;
650 Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
654 void detach_dcr_from_dev(DCR *dcr)
656 DEVICE *dev = dcr->dev;
657 Dmsg0(500, "Enter detach_dcr_from_dev\n"); /* jcr is NULL in some cases */
659 /* Detach this dcr only if attached */
660 if (dcr->attached_to_dev && dev) {
662 dcr->unreserve_device();
663 dcr->dev->attached_dcrs->remove(dcr); /* detach dcr from device */
664 dcr->attached_to_dev = false;
665 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
671 * Free up all aspects of the given dcr -- i.e. dechain it,
672 * release allocated memory, zap pointers, ...
674 void free_dcr(DCR *dcr)
678 detach_dcr_from_dev(dcr);
681 free_block(dcr->block);
684 free_record(dcr->rec);
686 if (jcr && jcr->dcr == dcr) {