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);
177 if (reserve_volume(dcr, dcr->VolumeName) == NULL) {
178 Dmsg2(100, "Could not reserve volume %s on %s\n", dcr->VolumeName,
179 dcr->dev->print_name());
180 Jmsg2(jcr, M_FATAL, 0, _("Could not reserve volume %s on %s\n"), dcr->VolumeName,
181 dcr->dev->print_name());
184 if (dev->vol && dev->vol->is_swapping()) {
185 dev->vol->set_slot(vol->Slot);
186 Dmsg3(100, "swapping: slot=%d Vol=%s dev=%s\n", dev->vol->get_slot(),
187 dev->vol->vol_name, dev->print_name());
191 init_device_wait_timers(dcr);
193 tape_previously_mounted = dev->can_read() || dev->can_append() ||
195 tape_initially_mounted = tape_previously_mounted;
198 /* Volume info is always needed because of VolParts */
199 Dmsg1(150, "dir_get_volume_info vol=%s\n", dcr->VolumeName);
200 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
201 Dmsg2(150, "dir_get_vol_info failed for vol=%s: %s\n",
202 dcr->VolumeName, jcr->errmsg);
203 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
205 dev->set_load(); /* set to load volume */
208 /* If not polling limit retries */
209 if (!dev->poll && retry++ > 10) {
212 dev->clear_labeled(); /* force reread of label */
213 if (job_canceled(jcr)) {
215 Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
216 Jmsg(jcr, M_INFO, 0, dev->errmsg);
217 goto get_out; /* error return */
220 dcr->do_swapping(false/*is_writing*/);
223 * This code ensures that the device is ready for
224 * reading. If it is a file, it opens it.
225 * If it is a tape, it checks the volume name
227 Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
228 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
230 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
231 dev->print_name(), dcr->VolumeName, dev->bstrerror());
235 Dmsg1(50, "opened dev %s OK\n", dev->print_name());
237 /* Read Volume Label */
238 Dmsg0(50, "calling read-vol-label\n");
239 vol_label_status = read_dev_volume_label(dcr);
240 switch (vol_label_status) {
243 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
247 * Send error message generated by read_dev_volume_label()
248 * only we really had a tape mounted. This supresses superfluous
249 * error messages when nothing is mounted.
251 if (tape_previously_mounted) {
252 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
256 if (dev->is_volume_to_unload()) {
259 // if (tape_initially_mounted) {
260 tape_initially_mounted = false;
261 // goto default_path;
263 dev->set_unload(); /* force unload of unwanted tape */
264 if (!unload_autochanger(dcr, -1)) {
265 /* at least free the device so we can re-open with correct volume */
272 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
274 tape_previously_mounted = true;
277 * If the device requires mount, close it, so the device can be ejected.
279 if (dev->requires_mount()) {
283 /* Call autochanger only once unless ask_sysop called */
284 if (try_autochanger) {
286 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
287 dcr->VolumeName, dcr->VolCatInfo.Slot);
288 stat = autoload_device(dcr, 0, NULL);
290 try_autochanger = false;
291 continue; /* try reading volume mounted */
293 /* Try closing and re-opening */
295 if (dev->open(dcr, OPEN_READ_ONLY) >= 0) {
299 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
300 dev->print_name(), dcr->VolumeName, dev->bstrerror());
304 /* Mount a specific volume and no other */
305 Dmsg0(200, "calling dir_ask_sysop\n");
306 if (!dir_ask_sysop_to_mount_volume(dcr, ST_READ)) {
307 goto get_out; /* error return */
309 try_autochanger = true; /* permit using autochanger again */
310 continue; /* try reading again */
316 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
323 set_jcr_job_status(jcr, JS_Running);
324 dir_send_job_status(jcr);
325 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
326 dcr->VolumeName, dev->print_name());
330 dcr->clear_reserved();
332 * Normally we are blocked, but in at least one error case above
333 * we are not blocked because we unsuccessfully tried changing
336 if (dev->is_blocked()) {
337 dev->dunblock(DEV_LOCKED);
339 dev->dunlock(); /* dunblock() unlock the device too */
341 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
347 * Acquire device for writing. We permit multiple writers.
348 * If this is the first one, we read the label.
350 * Returns: NULL if failed for any reason
352 * Note, normally reserve_device_for_append() is called
353 * before this routine.
355 DCR *acquire_device_for_append(DCR *dcr)
357 DEVICE *dev = dcr->dev;
360 bool have_vol = false;
362 init_device_wait_timers(dcr);
364 dev->dblock(BST_DOING_ACQUIRE);
365 Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
366 (dev->is_dvd()?"DVD":"disk"));
369 * With the reservation system, this should not happen
371 if (dev->can_read()) {
372 Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
373 Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
380 * have_vol defines whether or not mount_next_write_volume should
381 * ask the Director again about what Volume to use.
383 if (dev->can_append() && dcr->is_suitable_volume_mounted() &&
384 strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") != 0) {
385 Dmsg0(190, "device already in append.\n");
387 * At this point, the correct tape is already mounted, so
388 * we do not need to do mount_next_write_volume(), unless
389 * we need to recycle the tape.
391 if (dev->num_writers == 0) {
392 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
394 have_vol = dcr->is_tape_position_ok();
398 Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
399 if (!dcr->mount_next_write_volume()) {
400 if (!job_canceled(jcr)) {
401 /* Reduce "noise" -- don't print if job canceled */
402 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
404 Dmsg1(200, "Could not ready device %s for append.\n",
409 Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
412 dev->num_writers++; /* we are now a writer */
413 if (jcr->NumWriteVolumes == 0) {
414 jcr->NumWriteVolumes = 1;
416 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
417 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
422 dcr->clear_reserved();
423 dev->dunblock(DEV_LOCKED);
424 return ok ? dcr : NULL;
428 * This job is done, so release the device. From a Unix standpoint,
429 * the device remains open.
431 * Note, if we are spooling, we may enter with the device locked.
432 * However, in all cases, unlock the device when leaving.
435 bool release_device(DCR *dcr)
438 DEVICE *dev = dcr->dev;
442 /* lock only if not already locked by this thread */
443 if (!dcr->is_dev_locked()) {
447 Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
449 /* if device is reserved, job never started, so release the reserve here */
450 dcr->clear_reserved();
452 if (dev->can_read()) {
453 dev->clear_read(); /* clear read bit */
454 Dmsg0(100, "dir_update_vol_info. Release0\n");
455 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
458 } else if (dev->num_writers > 0) {
460 * Note if WEOT is set, we are at the end of the tape
461 * and may not be positioned correctly, so the
462 * job_media_record and update_vol_info have already been
463 * done, which means we skip them here.
466 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
467 if (dev->is_labeled()) {
468 Dmsg2(200, "dir_create_jobmedia. Release vol=%s dev=%s\n",
469 dev->VolCatInfo.VolCatName, dev->print_name());
470 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
471 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
472 dcr->VolCatInfo.VolCatName, jcr->Job);
474 /* If no more writers, and no errors, and wrote something, write an EOF */
475 if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
477 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
479 if (!dev->at_weot()) {
480 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
481 /* Note! do volume update before close, which zaps VolCatInfo */
482 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
483 Dmsg2(200, "dir_update_vol_info. Release vol=%s dev=%s\n",
484 dev->VolCatInfo.VolCatName, dev->print_name());
486 if (dev->num_writers == 0) { /* if not being used */
487 volume_unused(dcr); /* we obviously are not using the volume */
493 * If we reach here, it is most likely because the job
494 * has failed, since the device is not in read mode and
495 * there are no writers. It was probably reserved.
500 Dmsg3(100, "%d writers, %d reserve, dev=%s\n", dev->num_writers, dev->num_reserved(),
502 debug_list_volumes("acquire:release_device()");
505 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
506 if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
507 dvd_remove_empty_part(dcr); /* get rid of any empty spool part */
511 /* Fire off Alert command and include any output */
512 if (!job_canceled(jcr) && dcr->device->alert_command) {
516 char line[MAXSTRING];
517 alert = get_pool_memory(PM_FNAME);
518 alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
519 bpipe = open_bpipe(alert, 0, "r");
521 while (fgets(line, sizeof(line), bpipe->rfd)) {
522 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
524 status = close_bpipe(bpipe);
530 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
531 alert, be.bstrerror(status));
534 Dmsg1(400, "alert status=%d\n", status);
535 free_pool_memory(alert);
537 pthread_cond_broadcast(&dev->wait_next_vol);
538 Dmsg2(100, "JobId=%u broadcast wait_device_release at %s\n",
539 (uint32_t)jcr->JobId, bstrftimes(tbuf, sizeof(tbuf), (utime_t)time(NULL)));
540 pthread_cond_broadcast(&wait_device_release);
543 detach_dcr_from_dev(dcr);
545 if (jcr->read_dcr == dcr) {
546 jcr->read_dcr = NULL;
548 if (jcr->dcr == dcr) {
553 Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
554 (uint32_t)jcr->JobId);
559 * Clean up the device for reuse without freeing the memory
561 bool clean_device(DCR *dcr)
564 dcr->keep_dcr = true; /* do not free the dcr */
565 ok = release_device(dcr);
566 dcr->keep_dcr = false;
571 * Create a new Device Control Record and attach
572 * it to the device (if this is a real job).
573 * Note, this has been updated so that it can be called first
574 * without a DEVICE, then a second or third time with a DEVICE,
575 * and each time, it should cleanup and point to the new device.
576 * This should facilitate switching devices.
577 * Note, each dcr must point to the controlling job (jcr). However,
578 * a job can have multiple dcrs, so we must not store in the jcr's
579 * structure as previously. The higher level routine must store
580 * this dcr in the right place
583 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
586 dcr = (DCR *)malloc(sizeof(DCR));
587 memset(dcr, 0, sizeof(DCR));
588 dcr->tid = pthread_self();
591 dcr->jcr = jcr; /* point back to jcr */
592 /* Set device information, possibly change device */
595 free_block(dcr->block);
597 dcr->block = new_block(dev);
599 free_record(dcr->rec);
601 dcr->rec = new_record();
602 if (dcr->attached_to_dev) {
603 detach_dcr_from_dev(dcr);
605 /* Use job spoolsize prior to device spoolsize */
606 if (jcr->spool_size) {
607 dcr->max_job_spool_size = jcr->spool_size;
609 dcr->max_job_spool_size = dev->device->max_job_spool_size;
611 dcr->device = dev->device;
613 attach_dcr_to_dev(dcr);
619 * Search the dcrs list for the given dcr. If it is found,
620 * as it should be, then remove it. Also zap the jcr pointer
621 * to the dcr if it is the same one.
623 * Note, this code will be turned on when we can write to multiple
624 * dcrs at the same time.
627 static void remove_dcr_from_dcrs(DCR *dcr)
633 int num = jcr->dcrs->size();
634 for (i=0; i < num; i++) {
635 ldcr = (DCR *)jcr->dcrs->get(i);
637 jcr->dcrs->remove(i);
638 if (jcr->dcr == dcr) {
647 static void attach_dcr_to_dev(DCR *dcr)
649 DEVICE *dev = dcr->dev;
652 if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
653 if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
654 dev->attached_dcrs->append(dcr); /* attach dcr to device */
655 dcr->attached_to_dev = true;
656 Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
660 void detach_dcr_from_dev(DCR *dcr)
662 DEVICE *dev = dcr->dev;
663 Dmsg0(500, "Enter detach_dcr_from_dev\n"); /* jcr is NULL in some cases */
665 /* Detach this dcr only if attached */
666 if (dcr->attached_to_dev && dev) {
668 dcr->unreserve_device();
669 dcr->dev->attached_dcrs->remove(dcr); /* detach dcr from device */
670 dcr->attached_to_dev = false;
671 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
677 * Free up all aspects of the given dcr -- i.e. dechain it,
678 * release allocated memory, zap pointers, ...
680 void free_dcr(DCR *dcr)
684 detach_dcr_from_dev(dcr);
687 free_block(dcr->block);
690 free_record(dcr->rec);
692 if (jcr && jcr->dcr == dcr) {