2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2007 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);
41 static bool is_suitable_volume_mounted(DCR *dcr);
44 /*********************************************************************
45 * Acquire device for reading.
46 * The drive should have previously been reserved by calling
47 * reserve_device_for_read(). We read the Volume label from the block and
48 * leave the block pointers just after the label.
50 * Returns: NULL if failed for any reason
53 bool acquire_device_for_read(DCR *dcr)
55 DEVICE *dev = dcr->dev;
58 bool tape_previously_mounted;
59 bool tape_initially_mounted;
61 bool try_autochanger = true;
66 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
67 dev->dblock(BST_DOING_ACQUIRE);
69 if (dev->num_writers > 0) {
70 Jmsg2(jcr, M_FATAL, 0, _("Acquire read: num_writers=%d not zero. Job %d canceled.\n"),
71 dev->num_writers, jcr->JobId);
75 /* Find next Volume, if any */
79 Jmsg(jcr, M_FATAL, 0, _("No volumes specified for reading. Job %s canceled.\n"),
80 edit_int64(jcr->JobId, ed1));
84 for (i=1; i<jcr->CurReadVolume; i++) {
88 Jmsg(jcr, M_FATAL, 0, _("Logic error: no next volume to read. Numvol=%d Curvol=%d\n"),
89 jcr->NumReadVolumes, jcr->CurReadVolume);
90 goto get_out; /* should not happen */
92 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
93 bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
94 dcr->VolCatInfo.Slot = vol->Slot;
97 * If the MediaType requested for this volume is not the
98 * same as the current drive, we attempt to find the same
99 * device that was used to write the orginal volume. If
100 * found, we switch to using that device.
102 * N.B. A lot of routines rely on the dcr pointer not changing
103 * read_records.c even has multiple dcrs cached, so we take care
104 * here to release all important parts of the dcr and re-acquire
105 * them such as the block pointer (size may change), but we do
106 * not release the dcr.
108 Dmsg2(50, "MediaType dcr=%s dev=%s\n", dcr->media_type, dev->device->media_type);
109 if (dcr->media_type[0] && strcmp(dcr->media_type, dev->device->media_type) != 0) {
114 Jmsg3(jcr, M_INFO, 0, _("Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
116 dcr->media_type, dev->device->media_type, dev->print_name());
117 Dmsg3(50, "Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
119 dcr->media_type, dev->device->media_type, dev->print_name());
121 dev->dunblock(DEV_UNLOCKED);
124 memset(&rctx, 0, sizeof(RCTX));
126 jcr->reserve_msgs = New(alist(10, not_owned_by_alist));
127 rctx.any_drive = true;
128 rctx.device_name = vol->device;
129 store = new DIRSTORE;
130 memset(store, 0, sizeof(DIRSTORE));
131 store->name[0] = 0; /* No dir name */
132 bstrncpy(store->media_type, vol->MediaType, sizeof(store->media_type));
133 bstrncpy(store->pool_name, dcr->pool_name, sizeof(store->pool_name));
134 bstrncpy(store->pool_type, dcr->pool_type, sizeof(store->pool_type));
135 store->append = false;
137 dcr->keep_dcr = true; /* do not free the dcr */
139 dcr->keep_dcr = false;
142 * Search for a new device
144 stat = search_res_for_device(rctx);
145 release_reserve_messages(jcr); /* release queued messages */
146 unlock_reservations();
149 dev = dcr->dev; /* get new device pointer */
150 dev->dblock(BST_DOING_ACQUIRE);
151 dcr->VolumeName[0] = 0;
152 Jmsg(jcr, M_INFO, 0, _("Media Type change. New device %s chosen.\n"),
154 Dmsg1(50, "Media Type change. New device %s chosen.\n", dev->print_name());
156 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
157 bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
158 dcr->VolCatInfo.Slot = vol->Slot;
159 bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
160 bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
163 Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
165 Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
171 init_device_wait_timers(dcr);
173 tape_previously_mounted = dev->can_read() || dev->can_append() ||
175 tape_initially_mounted = tape_previously_mounted;
178 /* Volume info is always needed because of VolParts */
179 Dmsg0(200, "dir_get_volume_info\n");
180 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
181 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
185 /* If not polling limit retries */
186 if (!dev->poll && retry++ > 10) {
189 dev->clear_labeled(); /* force reread of label */
190 if (job_canceled(jcr)) {
192 Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
193 Jmsg(jcr, M_INFO, 0, dev->errmsg);
194 goto get_out; /* error return */
197 autoload_device(dcr, 0, NULL);
200 * This code ensures that the device is ready for
201 * reading. If it is a file, it opens it.
202 * If it is a tape, it checks the volume name
204 Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
205 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
206 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
207 dev->print_name(), dcr->VolumeName, dev->bstrerror());
210 Dmsg1(50, "opened dev %s OK\n", dev->print_name());
212 /* Read Volume Label */
213 Dmsg0(50, "calling read-vol-label\n");
214 vol_label_status = read_dev_volume_label(dcr);
215 switch (vol_label_status) {
218 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
222 * Send error message generated by read_dev_volume_label()
223 * only we really had a tape mounted. This supresses superfluous
224 * error messages when nothing is mounted.
226 if (tape_previously_mounted) {
227 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
231 if (tape_initially_mounted) {
232 tape_initially_mounted = false;
235 /* If polling and got a previous bad name, ignore it */
236 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
239 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
243 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
245 tape_previously_mounted = true;
248 * If the device requires mount, close it, so the device can be ejected.
250 if (dev->requires_mount()) {
254 /* Call autochanger only once unless ask_sysop called */
255 if (try_autochanger) {
257 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
258 dcr->VolumeName, dcr->VolCatInfo.Slot);
259 stat = autoload_device(dcr, 0, NULL);
261 try_autochanger = false;
262 continue; /* try reading volume mounted */
266 /* Mount a specific volume and no other */
267 Dmsg0(200, "calling dir_ask_sysop\n");
268 if (!dir_ask_sysop_to_mount_volume(dcr)) {
269 goto get_out; /* error return */
271 try_autochanger = true; /* permit using autochanger again */
272 continue; /* try reading again */
277 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
284 set_jcr_job_status(jcr, JS_Running);
285 dir_send_job_status(jcr);
286 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
287 dcr->VolumeName, dev->print_name());
291 if (dcr && dcr->reserved_device) {
292 dev->reserved_device--;
293 Dmsg2(50, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
294 dcr->reserved_device = false;
297 * Normally we are blocked, but in at least one error case above
298 * we are not blocked because we unsuccessfully tried changing
301 if (dev->is_blocked()) {
302 dev->dunblock(DEV_LOCKED);
304 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
310 * Acquire device for writing. We permit multiple writers.
311 * If this is the first one, we read the label.
313 * Returns: NULL if failed for any reason
315 * Note, normally reserve_device_for_append() is called
316 * before this routine.
318 DCR *acquire_device_for_append(DCR *dcr)
320 bool do_mount = false;
321 bool release = false;
323 DEVICE *dev = dcr->dev;
326 init_device_wait_timers(dcr);
328 dev->dblock(BST_DOING_ACQUIRE);
329 Dmsg1(190, "acquire_append device is %s\n", dev->is_tape()?"tape":
330 (dev->is_dvd()?"DVD":"disk"));
333 * With the reservation system, this should not happen
335 if (dev->can_read()) {
336 Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
337 Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
342 * find defines whether or not mount_next_write_volume should
343 * as the Director again about what Volume to use.
345 have_vol = is_suitable_volume_mounted(dcr);
346 if (dev->can_append()) {
347 Dmsg0(190, "device already in append.\n");
349 * Device already in append mode
351 * Check if we have the right Volume mounted
352 * OK if current volume info OK
353 * OK if next volume matches current volume
354 * otherwise mount desired volume obtained from
355 * dir_find_next_appendable_volume
356 * dev->VolHdr.VolumeName is what is in the drive
357 * dcr->VolumeName is what we pass into the routines, or
358 * get back from the subroutines.
361 !(dir_find_next_appendable_volume(dcr) &&
362 strcmp(dev->VolHdr.VolumeName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
363 Dmsg2(190, "Wrong tape mounted: %s. wants:%s\n", dev->VolHdr.VolumeName,
365 if (dev->num_writers != 0) {
366 Jmsg3(jcr, M_FATAL, 0, _("Wanted to append to Volume \"%s\", but device %s is busy writing on \"%s\" .\n"),
367 dcr->VolumeName, dev->print_name(), dev->VolHdr.VolumeName);
368 Dmsg3(200, "Wanted to append to Volume \"%s\", but device %s is busy writing on \"%s\" .\n",
369 dcr->VolumeName, dev->print_name(), dev->VolHdr.VolumeName);
370 /* Release volume reserved by dir_find_next_appendable_volume() */
371 if (dcr->VolumeName[0]) {
376 /* Wrong tape mounted, release it, then fall through to get correct one */
377 Dmsg1(190, "jid=%u Wrong tape mounted, release and try mount.\n",
378 (uint32_t)jcr->JobId);
383 * At this point, the correct tape is already mounted, so
384 * we do not need to do mount_next_write_volume(), unless
385 * we need to recycle the tape.
387 do_mount = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
388 Dmsg2(190, "jid=%u Correct tape mounted. recycle=%d\n",
389 (uint32_t)jcr->JobId, do_mount);
390 if (do_mount && dev->num_writers != 0) {
391 Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
392 " on device %s because it is in use by another job.\n"),
393 dev->VolHdr.VolumeName, dev->print_name());
396 if (dev->num_writers == 0) {
397 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
403 * Check to see if the tape position as defined by the OS is
404 * the same as our concept. If it is not, we bail out, because
405 * it means the user has probably manually rewound the tape.
406 * Note, we check only if num_writers == 0, but this code will
407 * also work fine for any number of writers. If num_writers > 0,
408 * we probably should cancel all jobs using this device, or
409 * perhaps even abort the SD, or at a minimum, mark the tape
410 * in error. Another strategy with num_writers == 0, would be
411 * to rewind the tape and do a new eod() request.
413 if (dev->is_tape() && dev->num_writers == 0) {
414 int32_t file = dev->get_os_tape_file();
415 if (file >= 0 && file != (int32_t)dev->get_file()) {
416 Jmsg(jcr, M_FATAL, 0, _("Invalid tape position on volume \"%s\""
417 " on device %s. Expected %d, got %d\n"),
418 dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
424 /* Not already in append mode, so mount the device */
425 Dmsg2(190, "jid=%u Not in append mode, try mount have_vol=%d\n",
426 (uint32_t)jcr->JobId, have_vol);
428 ASSERT(dev->num_writers == 0);
432 if (do_mount || !have_vol) {
433 Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
434 bool mounted = mount_next_write_volume(dcr, have_vol, release);
436 if (!job_canceled(jcr)) {
437 /* Reduce "noise" -- don't print if job canceled */
438 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
440 Dmsg2(200, "jid=%u Could not ready device %s for append.\n",
441 (uint32_t)jcr->JobId, dev->print_name());
445 Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
448 dev->num_writers++; /* we are now a writer */
449 if (jcr->NumWriteVolumes == 0) {
450 jcr->NumWriteVolumes = 1;
452 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
453 dir_update_volume_info(dcr, false); /* send Volume info to Director */
455 if (dcr->reserved_device) {
456 dev->reserved_device--;
457 Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
458 dev->reserved_device, dev->print_name());
459 dcr->reserved_device = false;
461 dev->dunblock(DEV_LOCKED);
469 if (dcr->reserved_device) {
470 dev->reserved_device--;
471 Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
472 dev->reserved_device, dev->print_name());
473 dcr->reserved_device = false;
475 dev->dunblock(DEV_LOCKED);
480 static bool is_suitable_volume_mounted(DCR *dcr)
482 DEVICE *dev = dcr->dev;
484 /* Volume mounted? */
485 if (dev->VolHdr.VolumeName[0] == 0) {
486 return false; /* no */
488 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
489 return dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE);
493 * This job is done, so release the device. From a Unix standpoint,
494 * the device remains open.
496 * Note, if we are spooling, we may enter with the device locked.
497 * However, in all cases, unlock the device when leaving.
500 bool release_device(DCR *dcr)
503 DEVICE *dev = dcr->dev;
506 /* lock only if not already locked by this thread */
507 if (!dcr->is_dev_locked()) {
510 Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
512 /* if device is reserved, job never started, so release the reserve here */
513 if (dcr->reserved_device) {
514 dev->reserved_device--;
515 Dmsg2(100, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
516 dcr->reserved_device = false;
519 if (dev->can_read()) {
520 dev->clear_read(); /* clear read bit */
521 Dmsg0(100, "dir_update_vol_info. Release0\n");
522 dir_update_volume_info(dcr, false); /* send Volume info to Director */
524 } else if (dev->num_writers > 0) {
526 * Note if WEOT is set, we are at the end of the tape
527 * and may not be positioned correctly, so the
528 * job_media_record and update_vol_info have already been
529 * done, which means we skip them here.
532 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
533 if (dev->is_labeled()) {
534 Dmsg0(100, "dir_create_jobmedia_record. Release\n");
535 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
536 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
537 dcr->VolCatInfo.VolCatName, jcr->Job);
539 /* If no more writers, write an EOF */
540 if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
542 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
544 if (!dev->at_weot()) {
545 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
546 /* Note! do volume update before close, which zaps VolCatInfo */
547 Dmsg0(100, "dir_update_vol_info. Release0\n");
548 dir_update_volume_info(dcr, false); /* send Volume info to Director */
554 * If we reach here, it is most likely because the job
555 * has failed, since the device is not in read mode and
556 * there are no writers. It was probably reserved.
560 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
561 if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
562 dvd_remove_empty_part(dcr); /* get rid of any empty spool part */
566 /* Fire off Alert command and include any output */
567 if (!job_canceled(jcr) && dcr->device->alert_command) {
571 char line[MAXSTRING];
572 alert = get_pool_memory(PM_FNAME);
573 alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
574 bpipe = open_bpipe(alert, 0, "r");
576 while (fgets(line, sizeof(line), bpipe->rfd)) {
577 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
579 status = close_bpipe(bpipe);
585 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
586 alert, be.bstrerror(status));
589 Dmsg1(400, "alert status=%d\n", status);
590 free_pool_memory(alert);
592 pthread_cond_broadcast(&dev->wait_next_vol);
593 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
594 pthread_cond_broadcast(&wait_device_release);
597 detach_dcr_from_dev(dcr);
599 if (jcr->read_dcr == dcr) {
600 jcr->read_dcr = NULL;
602 if (jcr->dcr == dcr) {
607 Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
608 (uint32_t)jcr->JobId);
613 * Create a new Device Control Record and attach
614 * it to the device (if this is a real job).
615 * Note, this has been updated so that it can be called first
616 * without a DEVICE, then a second or third time with a DEVICE,
617 * and each time, it should cleanup and point to the new device.
618 * This should facilitate switching devices.
619 * Note, each dcr must point to the controlling job (jcr). However,
620 * a job can have multiple dcrs, so we must not store in the jcr's
621 * structure as previously. The higher level routine must store
622 * this dcr in the right place
625 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
628 dcr = (DCR *)malloc(sizeof(DCR));
629 memset(dcr, 0, sizeof(DCR));
630 dcr->tid = pthread_self();
633 dcr->jcr = jcr; /* point back to jcr */
634 /* Set device information, possibly change device */
637 free_block(dcr->block);
639 dcr->block = new_block(dev);
641 free_record(dcr->rec);
643 dcr->rec = new_record();
644 if (dcr->attached_to_dev) {
645 detach_dcr_from_dev(dcr);
647 /* Use job spoolsize prior to device spoolsize */
648 if (jcr->spool_size) {
649 dcr->max_job_spool_size = jcr->spool_size;
651 dcr->max_job_spool_size = dev->device->max_job_spool_size;
653 dcr->device = dev->device;
655 attach_dcr_to_dev(dcr);
661 * Search the dcrs list for the given dcr. If it is found,
662 * as it should be, then remove it. Also zap the jcr pointer
663 * to the dcr if it is the same one.
665 * Note, this code will be turned on when we can write to multiple
666 * dcrs at the same time.
669 static void remove_dcr_from_dcrs(DCR *dcr)
675 int num = jcr->dcrs->size();
676 for (i=0; i < num; i++) {
677 ldcr = (DCR *)jcr->dcrs->get(i);
679 jcr->dcrs->remove(i);
680 if (jcr->dcr == dcr) {
689 static void attach_dcr_to_dev(DCR *dcr)
691 DEVICE *dev = dcr->dev;
694 if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
695 if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
696 dev->attached_dcrs->append(dcr); /* attach dcr to device */
697 dcr->attached_to_dev = true;
698 Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
702 void detach_dcr_from_dev(DCR *dcr)
704 DEVICE *dev = dcr->dev;
705 Dmsg1(500, "JobId=%u enter detach_dcr_from_dev\n", (uint32_t)dcr->jcr->JobId);
707 /* Detach this dcr only if attached */
708 if (dcr->attached_to_dev && dev) {
710 unreserve_device(dcr);
711 dcr->dev->attached_dcrs->remove(dcr); /* detach dcr from device */
712 dcr->attached_to_dev = false;
713 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
719 * Free up all aspects of the given dcr -- i.e. dechain it,
720 * release allocated memory, zap pointers, ...
722 void free_dcr(DCR *dcr)
726 detach_dcr_from_dev(dcr);
729 free_block(dcr->block);
732 free_record(dcr->rec);
734 if (jcr && jcr->dcr == dcr) {