2 * Routines to acquire and release a device for read/write
4 * Kern Sibbald, August MMII
9 Copyright (C) 2002-2005 Kern Sibbald
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of
14 the License, or (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public
22 License along with this program; if not, write to the Free
23 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 #include "bacula.h" /* pull in global headers */
29 #include "stored.h" /* pull in Storage Deamon headers */
31 static int can_reserve_drive(DCR *dcr);
34 * Create a new Device Control Record and attach
35 * it to the device (if this is a real job).
37 DCR *new_dcr(JCR *jcr, DEVICE *dev)
39 if (jcr && jcr->dcr) {
42 DCR *dcr = (DCR *)malloc(sizeof(DCR));
43 memset(dcr, 0, sizeof(DCR));
50 dcr->device = dev->device;
52 dcr->block = new_block(dev);
53 dcr->rec = new_record();
55 dcr->max_spool_size = dev->device->max_spool_size;
56 /* Attach this dcr only if dev is initialized */
57 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
58 dev->attached_dcrs->append(dcr); /* attach dcr to device */
59 // jcr->dcrs->append(dcr); /* put dcr in list for Job */
65 * Search the dcrs list for the given dcr. If it is found,
66 * as it should be, then remove it. Also zap the jcr pointer
67 * to the dcr if it is the same one.
70 static void remove_dcr_from_dcrs(DCR *dcr)
76 int num = jcr->dcrs->size();
77 for (i=0; i < num; i++) {
78 ldcr = (DCR *)jcr->dcrs->get(i);
81 if (jcr->dcr == dcr) {
91 * Free up all aspects of the given dcr -- i.e. dechain it,
92 * release allocated memory, zap pointers, ...
94 void free_dcr(DCR *dcr)
97 DEVICE *dev = dcr->dev;
100 * If we reserved the device, we must decrement the
103 if (dcr->reserved_device) {
106 if (dev->num_writers < 0) {
107 Jmsg1(dcr->jcr, M_ERROR, 0, _("Hey! num_writers=%d!!!!\n"), dev->num_writers);
108 dev->num_writers = 0;
109 dcr->reserved_device = false;
114 /* Detach this dcr only if the dev is initialized */
115 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
116 dev->attached_dcrs->remove(dcr); /* detach dcr from device */
117 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
120 free_block(dcr->block);
123 free_record(dcr->rec);
126 dcr->jcr->dcr = NULL;
133 * We "reserve" the drive by setting the ST_READ bit. No one else
134 * should touch the drive until that is cleared.
135 * This allows the DIR to "reserve" the device before actually
138 bool reserve_device_for_read(DCR *dcr)
140 DEVICE *dev = dcr->dev;
146 dev->block(BST_DOING_ACQUIRE);
148 if (device_is_unmounted(dev)) {
149 Mmsg(jcr->errmsg, _("Device %s is BLOCKED due to user unmount.\n"),
154 if (dev->is_busy()) {
155 Mmsg1(jcr->errmsg, _("Device %s is busy.\n"),
170 /*********************************************************************
171 * Acquire device for reading.
172 * The drive should have previously been reserved by calling
173 * reserve_device_for_read(). We read the Volume label from the block and
174 * leave the block pointers just after the label.
176 * Returns: NULL if failed for any reason
179 DCR *acquire_device_for_read(DCR *dcr)
181 DEVICE *dev = dcr->dev;
184 bool tape_previously_mounted;
185 bool tape_initially_mounted;
187 bool try_autochanger = true;
189 int vol_label_status;
191 dev->block(BST_DOING_ACQUIRE);
193 if (dev->num_writers > 0) {
194 Jmsg2(jcr, M_FATAL, 0, _("Num_writers=%d not zero. Job %d canceled.\n"),
195 dev->num_writers, jcr->JobId);
199 /* Find next Volume, if any */
202 Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
206 for (i=1; i<jcr->CurVolume; i++) {
210 goto get_out; /* should not happen */
212 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
214 init_device_wait_timers(dcr);
216 tape_previously_mounted = dev->can_read() ||
219 tape_initially_mounted = tape_previously_mounted;
222 /* Volume info is always needed because of VolParts */
223 Dmsg0(200, "dir_get_volume_info\n");
224 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
225 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
228 dev->num_parts = dcr->VolCatInfo.VolCatParts;
230 for (i=0; i<5; i++) {
231 dev->clear_labeled(); /* force reread of label */
232 if (job_canceled(jcr)) {
233 Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
234 goto get_out; /* error return */
237 * This code ensures that the device is ready for
238 * reading. If it is a file, it opens it.
239 * If it is a tape, it checks the volume name
241 for ( ; !dev->is_open(); ) {
242 Dmsg1(120, "bstored: open vol=%s\n", dcr->VolumeName);
243 if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
244 if (dev->dev_errno == EIO) { /* no tape loaded */
245 Jmsg3(jcr, M_WARNING, 0, _("Open device %s Volume \"%s\" failed: ERR=%s\n"),
246 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
250 /* If we have a dvd that requires mount,
251 * we need to try to open the label, so the info can be reported
252 * if a wrong volume has been mounted. */
253 if (dev->is_dvd() && (dcr->VolCatInfo.VolCatParts > 0)) {
257 Jmsg3(jcr, M_FATAL, 0, _("Open device %s Volume \"%s\" failed: ERR=%s\n"),
258 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
261 Dmsg1(129, "open_dev %s OK\n", dev->print_name());
265 vol_label_status = read_dev_volume_label_guess(dcr, 0);
267 vol_label_status = read_dev_volume_label(dcr);
270 Dmsg0(200, "calling read-vol-label\n");
271 switch (vol_label_status) {
274 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
278 * Send error message generated by read_dev_volume_label()
279 * only we really had a tape mounted. This supresses superfluous
280 * error messages when nothing is mounted.
282 if (tape_previously_mounted) {
283 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
287 if (tape_initially_mounted) {
288 tape_initially_mounted = false;
293 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
295 tape_previously_mounted = true;
297 /* If the device requires mount, close it, so the device can be ejected.
298 * FIXME: This should perhaps be done for all devices. */
299 if (dev_cap(dev, CAP_REQMOUNT)) {
300 force_close_dev(dev);
303 /* Call autochanger only once unless ask_sysop called */
304 if (try_autochanger) {
306 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
307 dcr->VolumeName, dcr->VolCatInfo.Slot);
308 stat = autoload_device(dcr, 0, NULL);
310 try_autochanger = false;
311 continue; /* try reading volume mounted */
315 /* Mount a specific volume and no other */
316 Dmsg0(200, "calling dir_ask_sysop\n");
317 if (!dir_ask_sysop_to_mount_volume(dcr)) {
318 goto get_out; /* error return */
320 try_autochanger = true; /* permit using autochanger again */
321 continue; /* try reading again */
326 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
333 set_jcr_job_status(jcr, JS_Running);
334 dir_send_job_status(jcr);
335 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
336 dcr->VolumeName, dev->print_name());
348 * We reserve the device for appending by incrementing the
349 * reserved_device. We do virtually all the same work that
350 * is done in acquire_device_for_append(), but we do
351 * not attempt to mount the device. This routine allows
352 * the DIR to reserve multiple devices before *really*
353 * starting the job. It also permits the SD to refuse
354 * certain devices (not up, ...).
356 * Note, in reserving a device, if the device is for the
357 * same pool and the same pool type, then it is acceptable.
358 * The Media Type has already been checked. If we are
359 * the first tor reserve the device, we put the pool
360 * name and pool type in the device record.
362 bool reserve_device_for_append(DCR *dcr)
365 DEVICE *dev = dcr->dev;
370 dev->block(BST_DOING_ACQUIRE);
372 if (dev->can_read()) {
373 Mmsg1(jcr->errmsg, _("Device %s is busy reading.\n"), dev->print_name());
377 if (device_is_unmounted(dev)) {
378 Mmsg(jcr->errmsg, _("Device %s is BLOCKED due to user unmount.\n"), dev->print_name());
382 Dmsg1(190, "reserve_append device is %s\n", dev->is_tape()?"tape":"disk");
384 if (can_reserve_drive(dcr) != 1) {
385 Mmsg1(jcr->errmsg, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
389 dev->reserved_device++;
390 dcr->reserved_device = true;
399 * Returns: 1 if drive can be reserved
400 * 0 if we should wait
403 static int can_reserve_drive(DCR *dcr)
405 DEVICE *dev = dcr->dev;
408 * First handle the case that the drive is not yet in append mode
410 if (!dev->can_append() && dev->num_writers == 0) {
411 /* Now check if there are any reservations on the drive */
412 if (dev->reserved_device) {
413 /* Yes, now check if we want the same Pool and pool type */
414 if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
415 strcmp(dev->pool_type, dcr->pool_type) == 0) {
416 /* OK, compatible device */
418 /* Drive not suitable for us */
422 /* Device is available but not yet reserved, reserve it for us */
423 bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
424 bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
426 return 1; /* reserve drive */
430 * Check if device in append mode with no writers (i.e. available)
432 if (dev->can_append() && dev->num_writers == 0) {
433 /* Device is available but not yet reserved, reserve it for us */
434 bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
435 bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
440 * Now check if the device is in append mode with writers (i.e.
441 * available if pool is the same).
443 if (dev->can_append() || dev->num_writers > 0) {
444 Dmsg0(190, "device already in append.\n");
445 /* Yes, now check if we want the same Pool and pool type */
446 if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
447 strcmp(dev->pool_type, dcr->pool_type) == 0) {
448 /* OK, compatible device */
450 /* Drive not suitable for us */
451 Jmsg(jcr, M_WARNING, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
455 Pmsg0(000, "Logic error!!!! Should not get here.\n");
456 Jmsg0(jcr, M_FATAL, 0, _("Logic error!!!! Should not get here.\n"));
457 return -1; /* error, should not get here */
459 return 1; /* reserve drive */
463 * Acquire device for writing. We permit multiple writers.
464 * If this is the first one, we read the label.
466 * Returns: NULL if failed for any reason
468 * Note, normally reserve_device_for_append() is called
469 * before this routine.
471 DCR *acquire_device_for_append(DCR *dcr)
473 bool release = false;
474 bool recycle = false;
475 bool do_mount = false;
476 DEVICE *dev = dcr->dev;
479 init_device_wait_timers(dcr);
481 dev->block(BST_DOING_ACQUIRE);
482 Dmsg1(190, "acquire_append device is %s\n", dev->is_tape()?"tape":"disk");
484 if (dcr->reserved_device) {
485 dev->reserved_device--;
486 dcr->reserved_device = false;
490 * With the reservation system, this should not happen
492 if (dev->can_read()) {
493 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev->print_name());
497 if (dev->can_append()) {
498 Dmsg0(190, "device already in append.\n");
500 * Device already in append mode
502 * Check if we have the right Volume mounted
503 * OK if current volume info OK
504 * OK if next volume matches current volume
505 * otherwise mount desired volume obtained from
506 * dir_find_next_appendable_volume
508 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
509 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
510 !(dir_find_next_appendable_volume(dcr) &&
511 strcmp(dev->VolHdr.VolName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
512 Dmsg0(190, "Wrong tape mounted.\n");
513 if (dev->num_writers != 0 || dev->reserved_device) {
514 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
517 /* Wrong tape mounted, release it, then fall through to get correct one */
518 Dmsg0(190, "Wrong tape mounted, release and try mount.\n");
523 * At this point, the correct tape is already mounted, so
524 * we do not need to do mount_next_write_volume(), unless
525 * we need to recycle the tape.
527 recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
528 Dmsg1(190, "Correct tape mounted. recycle=%d\n", recycle);
529 if (recycle && dev->num_writers != 0) {
530 Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
531 " on device %s because it is in use by another job.\n"),
532 dev->VolHdr.VolName, dev->print_name());
535 if (dev->num_writers == 0) {
536 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
540 /* Not already in append mode, so mount the device */
541 Dmsg0(190, "Not in append mode, try mount.\n");
542 ASSERT(dev->num_writers == 0);
546 if (do_mount || recycle) {
547 Dmsg0(190, "Do mount_next_write_vol\n");
548 bool mounted = mount_next_write_volume(dcr, release);
550 if (!job_canceled(jcr)) {
551 /* Reduce "noise" -- don't print if job canceled */
552 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
559 dev->num_writers++; /* we are now a writer */
560 if (jcr->NumVolumes == 0) {
566 * If we jump here, it is an error return because
567 * rtn_dev will still be NULL
578 * This job is done, so release the device. From a Unix standpoint,
579 * the device remains open.
582 bool release_device(DCR *dcr)
585 DEVICE *dev = dcr->dev;
589 Dmsg1(100, "release_device device is %s\n", dev->is_tape()?"tape":"disk");
591 /* if device is reserved, job never started, so release the reserve here */
592 if (dcr->reserved_device) {
593 dev->reserved_device--;
594 dcr->reserved_device = false;
597 if (dev->can_read()) {
598 dev->clear_read(); /* clear read bit */
600 /******FIXME**** send read volume usage statistics to director */
602 } else if (dev->num_writers > 0) {
604 * Note if WEOT is set, we are at the end of the tape
605 * and may not be positioned correctly, so the
606 * job_media_record and update_vol_info have already been
607 * done, which means we skip them here.
610 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
611 if (dev->is_labeled()) {
612 Dmsg0(100, "dir_create_jobmedia_record. Release\n");
613 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
614 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
615 dcr->VolCatInfo.VolCatName, jcr->Job);
617 /* If no more writers, write an EOF */
618 if (!dev->num_writers && dev->can_write()) {
620 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolName);
622 if (!dev->at_weot()) {
623 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
624 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
625 /* Note! do volume update before close, which zaps VolCatInfo */
626 Dmsg0(100, "dir_update_vol_info. Release0\n");
627 dir_update_volume_info(dcr, false); /* send Volume info to Director */
633 * If we reach here, it is most likely because the job
634 * has failed, since the device is not in read mode and
635 * there are no writers. It was probably reserved.
639 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
640 if (dev->num_writers == 0 && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
641 offline_or_rewind_dev(dev);
645 /* Fire off Alert command and include any output */
646 if (!job_canceled(jcr) && dcr->device->alert_command) {
650 char line[MAXSTRING];
651 alert = get_pool_memory(PM_FNAME);
652 alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
653 bpipe = open_bpipe(alert, 0, "r");
655 while (fgets(line, sizeof(line), bpipe->rfd)) {
656 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
658 status = close_bpipe(bpipe);
664 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
665 alert, be.strerror(status));
668 Dmsg1(400, "alert status=%d\n", status);
669 free_pool_memory(alert);
674 pthread_cond_broadcast(&wait_device_release);