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);
41 static bool is_tape_position_ok(JCR *jcr, DEVICE *dev);
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 clean_device(dcr); /* clean up the dcr */
140 * Search for a new device
142 stat = search_res_for_device(rctx);
143 release_reserve_messages(jcr); /* release queued messages */
144 unlock_reservations();
147 dev = dcr->dev; /* get new device pointer */
148 dev->dblock(BST_DOING_ACQUIRE);
149 dcr->VolumeName[0] = 0;
150 Jmsg(jcr, M_INFO, 0, _("Media Type change. New device %s chosen.\n"),
152 Dmsg1(50, "Media Type change. New device %s chosen.\n", dev->print_name());
154 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
155 bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
156 dcr->VolCatInfo.Slot = vol->Slot;
157 bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
158 bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
161 Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
163 Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
169 init_device_wait_timers(dcr);
171 tape_previously_mounted = dev->can_read() || dev->can_append() ||
173 tape_initially_mounted = tape_previously_mounted;
176 /* Volume info is always needed because of VolParts */
177 Dmsg0(200, "dir_get_volume_info\n");
178 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
179 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
183 /* If not polling limit retries */
184 if (!dev->poll && retry++ > 10) {
187 dev->clear_labeled(); /* force reread of label */
188 if (job_canceled(jcr)) {
190 Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
191 Jmsg(jcr, M_INFO, 0, dev->errmsg);
192 goto get_out; /* error return */
195 autoload_device(dcr, 0, NULL);
198 * This code ensures that the device is ready for
199 * reading. If it is a file, it opens it.
200 * If it is a tape, it checks the volume name
202 Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
203 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
204 Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
205 dev->print_name(), dcr->VolumeName, dev->bstrerror());
208 Dmsg1(50, "opened dev %s OK\n", dev->print_name());
210 /* Read Volume Label */
211 Dmsg0(50, "calling read-vol-label\n");
212 vol_label_status = read_dev_volume_label(dcr);
213 switch (vol_label_status) {
216 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
220 * Send error message generated by read_dev_volume_label()
221 * only we really had a tape mounted. This supresses superfluous
222 * error messages when nothing is mounted.
224 if (tape_previously_mounted) {
225 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
229 if (tape_initially_mounted) {
230 tape_initially_mounted = false;
233 /* If polling and got a previous bad name, ignore it */
234 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
237 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
241 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
243 tape_previously_mounted = true;
246 * If the device requires mount, close it, so the device can be ejected.
248 if (dev->requires_mount()) {
252 /* Call autochanger only once unless ask_sysop called */
253 if (try_autochanger) {
255 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
256 dcr->VolumeName, dcr->VolCatInfo.Slot);
257 stat = autoload_device(dcr, 0, NULL);
259 try_autochanger = false;
260 continue; /* try reading volume mounted */
264 /* Mount a specific volume and no other */
265 Dmsg0(200, "calling dir_ask_sysop\n");
266 if (!dir_ask_sysop_to_mount_volume(dcr, ST_READ)) {
267 goto get_out; /* error return */
269 try_autochanger = true; /* permit using autochanger again */
270 continue; /* try reading again */
275 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
282 set_jcr_job_status(jcr, JS_Running);
283 dir_send_job_status(jcr);
284 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
285 dcr->VolumeName, dev->print_name());
289 if (dcr && dcr->reserved_device) {
290 dev->reserved_device--;
291 Dmsg2(50, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
292 dcr->reserved_device = false;
295 * Normally we are blocked, but in at least one error case above
296 * we are not blocked because we unsuccessfully tried changing
299 if (dev->is_blocked()) {
300 dev->dunblock(DEV_LOCKED);
302 Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
308 * Acquire device for writing. We permit multiple writers.
309 * If this is the first one, we read the label.
311 * Returns: NULL if failed for any reason
313 * Note, normally reserve_device_for_append() is called
314 * before this routine.
316 DCR *acquire_device_for_append(DCR *dcr)
318 DEVICE *dev = dcr->dev;
321 init_device_wait_timers(dcr);
323 dev->dblock(BST_DOING_ACQUIRE);
324 Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
325 (dev->is_dvd()?"DVD":"disk"));
328 * With the reservation system, this should not happen
330 if (dev->can_read()) {
331 Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
332 Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
337 * have_vol defines whether or not mount_next_write_volume should
338 * ask the Director again about what Volume to use.
340 if (dev->can_append() && dcr->is_suitable_volume_mounted() &&
341 strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") != 0) {
342 Dmsg0(190, "device already in append.\n");
344 * At this point, the correct tape is already mounted, so
345 * we do not need to do mount_next_write_volume(), unless
346 * we need to recycle the tape.
348 if (dev->num_writers == 0) {
349 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
351 if (!is_tape_position_ok(jcr, dev)) {
355 Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
356 if (!dcr->mount_next_write_volume()) {
357 if (!job_canceled(jcr)) {
358 /* Reduce "noise" -- don't print if job canceled */
359 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
361 Dmsg2(200, "jid=%u Could not ready device %s for append.\n",
362 (uint32_t)jcr->JobId, dev->print_name());
366 Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
369 dev->num_writers++; /* we are now a writer */
370 if (jcr->NumWriteVolumes == 0) {
371 jcr->NumWriteVolumes = 1;
373 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
374 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
376 if (dcr->reserved_device) {
377 dev->reserved_device--;
378 Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
379 dev->reserved_device, dev->print_name());
380 dcr->reserved_device = false;
382 dev->dunblock(DEV_LOCKED);
390 if (dcr->reserved_device) {
391 dev->reserved_device--;
392 Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
393 dev->reserved_device, dev->print_name());
394 dcr->reserved_device = false;
396 dev->dunblock(DEV_LOCKED);
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 static bool is_tape_position_ok(JCR *jcr, DEVICE *dev)
415 if (dev->is_tape() && dev->num_writers == 0) {
416 int32_t file = dev->get_os_tape_file();
417 if (file >= 0 && file != (int32_t)dev->get_file()) {
418 Jmsg(jcr, M_FATAL, 0, _("Invalid tape position on volume \"%s\""
419 " on device %s. Expected %d, got %d\n"),
420 dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
429 * This job is done, so release the device. From a Unix standpoint,
430 * the device remains open.
432 * Note, if we are spooling, we may enter with the device locked.
433 * However, in all cases, unlock the device when leaving.
436 bool release_device(DCR *dcr)
439 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 if (dcr->reserved_device) {
451 dev->reserved_device--;
452 Dmsg2(100, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
453 dcr->reserved_device = false;
456 if (dev->can_read()) {
457 dev->clear_read(); /* clear read bit */
458 Dmsg0(100, "dir_update_vol_info. Release0\n");
459 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
462 } else if (dev->num_writers > 0) {
464 * Note if WEOT is set, we are at the end of the tape
465 * and may not be positioned correctly, so the
466 * job_media_record and update_vol_info have already been
467 * done, which means we skip them here.
470 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
471 if (dev->is_labeled()) {
472 Dmsg2(200, "dir_create_jobmedia. Release vol=%s dev=%s\n",
473 dev->VolCatInfo.VolCatName, dev->print_name());
474 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
475 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
476 dcr->VolCatInfo.VolCatName, jcr->Job);
478 /* If no more writers, and no errors, and wrote something, write an EOF */
479 if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
481 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
483 if (!dev->at_weot()) {
484 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
485 /* Note! do volume update before close, which zaps VolCatInfo */
486 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
487 Dmsg2(200, "dir_update_vol_info. Release vol=%s dev=%s\n",
488 dev->VolCatInfo.VolCatName, dev->print_name());
490 if (!dev->num_writers) { /* if no more writers */
491 volume_unused(dcr); /* we obviously are not using the volume */
497 * If we reach here, it is most likely because the job
498 * has failed, since the device is not in read mode and
499 * there are no writers. It was probably reserved.
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 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
539 pthread_cond_broadcast(&wait_device_release);
542 detach_dcr_from_dev(dcr);
544 if (jcr->read_dcr == dcr) {
545 jcr->read_dcr = NULL;
547 if (jcr->dcr == dcr) {
552 Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
553 (uint32_t)jcr->JobId);
558 * Clean up the device for reuse without freeing the memory
560 bool clean_device(DCR *dcr)
563 dcr->keep_dcr = true; /* do not free the dcr */
564 ok = release_device(dcr);
565 dcr->keep_dcr = false;
570 * Create a new Device Control Record and attach
571 * it to the device (if this is a real job).
572 * Note, this has been updated so that it can be called first
573 * without a DEVICE, then a second or third time with a DEVICE,
574 * and each time, it should cleanup and point to the new device.
575 * This should facilitate switching devices.
576 * Note, each dcr must point to the controlling job (jcr). However,
577 * a job can have multiple dcrs, so we must not store in the jcr's
578 * structure as previously. The higher level routine must store
579 * this dcr in the right place
582 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
585 dcr = (DCR *)malloc(sizeof(DCR));
586 memset(dcr, 0, sizeof(DCR));
587 dcr->tid = pthread_self();
590 dcr->jcr = jcr; /* point back to jcr */
591 /* Set device information, possibly change device */
594 free_block(dcr->block);
596 dcr->block = new_block(dev);
598 free_record(dcr->rec);
600 dcr->rec = new_record();
601 if (dcr->attached_to_dev) {
602 detach_dcr_from_dev(dcr);
604 /* Use job spoolsize prior to device spoolsize */
605 if (jcr->spool_size) {
606 dcr->max_job_spool_size = jcr->spool_size;
608 dcr->max_job_spool_size = dev->device->max_job_spool_size;
610 dcr->device = dev->device;
612 attach_dcr_to_dev(dcr);
618 * Search the dcrs list for the given dcr. If it is found,
619 * as it should be, then remove it. Also zap the jcr pointer
620 * to the dcr if it is the same one.
622 * Note, this code will be turned on when we can write to multiple
623 * dcrs at the same time.
626 static void remove_dcr_from_dcrs(DCR *dcr)
632 int num = jcr->dcrs->size();
633 for (i=0; i < num; i++) {
634 ldcr = (DCR *)jcr->dcrs->get(i);
636 jcr->dcrs->remove(i);
637 if (jcr->dcr == dcr) {
646 static void attach_dcr_to_dev(DCR *dcr)
648 DEVICE *dev = dcr->dev;
651 if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
652 if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
653 dev->attached_dcrs->append(dcr); /* attach dcr to device */
654 dcr->attached_to_dev = true;
655 Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
659 void detach_dcr_from_dev(DCR *dcr)
661 DEVICE *dev = dcr->dev;
662 Dmsg0(500, "Enter detach_dcr_from_dev\n"); /* jcr is NULL in some cases */
664 /* Detach this dcr only if attached */
665 if (dcr->attached_to_dev && dev) {
667 unreserve_device(dcr);
668 dcr->dev->attached_dcrs->remove(dcr); /* detach dcr from device */
669 dcr->attached_to_dev = false;
670 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
676 * Free up all aspects of the given dcr -- i.e. dechain it,
677 * release allocated memory, zap pointers, ...
679 void free_dcr(DCR *dcr)
683 detach_dcr_from_dev(dcr);
686 free_block(dcr->block);
689 free_record(dcr->rec);
691 if (jcr && jcr->dcr == dcr) {