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 */
32 * Create a new Device Control Record and attach
33 * it to the device (if this is a real job).
35 DCR *new_dcr(JCR *jcr, DEVICE *dev)
37 if (jcr && jcr->dcr) {
40 DCR *dcr = (DCR *)malloc(sizeof(DCR));
41 memset(dcr, 0, sizeof(DCR));
48 dcr->device = dev->device;
50 dcr->block = new_block(dev);
51 dcr->rec = new_record();
53 dcr->max_spool_size = dev->device->max_spool_size;
54 /* Attach this dcr only if dev is initialized */
55 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
56 dev->attached_dcrs->append(dcr);
57 // jcr->dcrs->append(dcr);
63 * Search the dcrs list for the given dcr. If it is found,
64 * as it should be, then remove it. Also zap the jcr pointer
65 * to the dcr if it is the same one.
68 static void remove_dcr_from_dcrs(DCR *dcr)
74 int num = jcr->dcrs->size();
75 for (i=0; i < num; i++) {
76 ldcr = (DCR *)jcr->dcrs->get(i);
79 if (jcr->dcr == dcr) {
89 * Free up all aspects of the given dcr -- i.e. dechain it,
90 * release allocated memory, zap pointers, ...
92 void free_dcr(DCR *dcr)
95 DEVICE *dev = dcr->dev;
98 * If we reserved the device, we must decrement the
101 if (dcr->reserved_device) {
104 if (dev->num_writers < 0) {
105 Jmsg1(dcr->jcr, M_ERROR, 0, _("Hey! num_writers=%d!!!!\n"), dev->num_writers);
106 dev->num_writers = 0;
107 dcr->reserved_device = false;
112 /* Detach this dcr only if the dev is initialized */
113 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
114 dev->attached_dcrs->remove(dcr);
115 // remove_dcr_from_dcrs(dcr);
118 free_block(dcr->block);
121 free_record(dcr->rec);
124 dcr->jcr->dcr = NULL;
131 * We "reserve" the drive by setting the ST_READ bit. No one else
132 * should touch the drive until that is cleared.
133 * This allows the DIR to "reserve" the device before actually
134 * starting the job. If the device is not available, the DIR
135 * can wait (to be implemented 1/05).
137 bool reserve_device_for_read(JCR *jcr, DEVICE *dev)
144 dev->block(BST_DOING_ACQUIRE);
146 Mmsg(jcr->errmsg, _("Device %s is BLOCKED due to user unmount.\n"),
148 for (first=true; device_is_unmounted(dev); first=false) {
150 if (!wait_for_device(dcr, jcr->errmsg, first)) {
153 dev->block(BST_DOING_ACQUIRE);
156 Mmsg2(jcr->errmsg, _("Device %s is busy. Job %d canceled.\n"),
157 dev->print_name(), jcr->JobId);
158 for (first=true; dev->is_busy(); first=false) {
160 if (!wait_for_device(dcr, jcr->errmsg, first)) {
163 dev->block(BST_DOING_ACQUIRE);
173 /*********************************************************************
174 * Acquire device for reading.
175 * The drive should have previously been reserved by calling
176 * reserve_device_for_read(). We read the Volume label from the block and
177 * leave the block pointers just after the label.
179 * Returns: NULL if failed for any reason
182 DCR *acquire_device_for_read(JCR *jcr, DEVICE *dev)
185 bool tape_previously_mounted;
186 bool tape_initially_mounted;
188 bool try_autochanger = true;
191 int vol_label_status;
193 dev->block(BST_DOING_ACQUIRE);
195 init_device_wait_timers(dcr);
197 tape_previously_mounted = dev->can_read() ||
200 tape_initially_mounted = tape_previously_mounted;
202 if (dev->num_writers > 0) {
203 Jmsg2(jcr, M_FATAL, 0, _("Num_writers=%d not zero. Job %d canceled.\n"),
204 dev->num_writers, jcr->JobId);
208 /* Find next Volume, if any */
211 Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
215 for (i=1; i<jcr->CurVolume; i++) {
218 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
220 /* Volume info is always needed because of VolParts */
221 Dmsg0(200, "dir_get_volume_info\n");
222 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
223 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
226 dev->num_parts = dcr->VolCatInfo.VolCatParts;
228 for (i=0; i<5; i++) {
229 dev->clear_labeled(); /* force reread of label */
230 if (job_canceled(jcr)) {
231 Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
232 goto get_out; /* error return */
235 * This code ensures that the device is ready for
236 * reading. If it is a file, it opens it.
237 * If it is a tape, it checks the volume name
239 for ( ; !dev->is_open(); ) {
240 Dmsg1(120, "bstored: open vol=%s\n", dcr->VolumeName);
241 if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
242 if (dev->dev_errno == EIO) { /* no tape loaded */
246 /* If we have a dvd that requires mount,
247 * we need to try to open the label, so the info can be reported
248 * if a wrong volume has been mounted. */
249 if (dev->is_dvd() && (dcr->VolCatInfo.VolCatParts > 0)) {
253 Jmsg(jcr, M_FATAL, 0, _("Open device %s Volume \"%s\" failed: ERR=%s\n"),
254 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
257 Dmsg1(129, "open_dev %s OK\n", dev->print_name());
261 vol_label_status = read_dev_volume_label_guess(dcr, 0);
263 vol_label_status = read_dev_volume_label(dcr);
266 Dmsg0(200, "calling read-vol-label\n");
267 switch (vol_label_status) {
270 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
274 * Send error message generated by read_dev_volume_label()
275 * only we really had a tape mounted. This supresses superfluous
276 * error messages when nothing is mounted.
278 if (tape_previously_mounted) {
279 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
283 if (tape_initially_mounted) {
284 tape_initially_mounted = false;
289 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
291 tape_previously_mounted = true;
293 /* If the device requires mount, close it, so the device can be ejected.
294 * FIXME: This should perhaps be done for all devices. */
295 if (dev_cap(dev, CAP_REQMOUNT)) {
296 force_close_dev(dev);
299 /* Call autochanger only once unless ask_sysop called */
300 if (try_autochanger) {
302 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
303 dcr->VolumeName, dcr->VolCatInfo.Slot);
304 stat = autoload_device(dcr, 0, NULL);
306 try_autochanger = false;
307 continue; /* try reading volume mounted */
311 /* Mount a specific volume and no other */
312 Dmsg0(200, "calling dir_ask_sysop\n");
313 if (!dir_ask_sysop_to_mount_volume(dcr)) {
314 goto get_out; /* error return */
316 try_autochanger = true; /* permit using autochanger again */
317 continue; /* try reading again */
322 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
329 set_jcr_job_status(jcr, JS_Running);
330 dir_send_job_status(jcr);
331 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
332 dcr->VolumeName, dev->print_name());
344 * We reserve the device for appending by incrementing the
345 * reserved_device. We do virtually all the same work that
346 * is done in acquire_device_for_append(), but we do
347 * not attempt to mount the device. This routine allows
348 * the DIR to reserve multiple devices before *really*
349 * starting the job. It also permits the SD to refuse
350 * certain devices (not up, ...).
352 * Note, in reserving a device, if the device is for the
353 * same pool and the same pool type, then it is acceptable.
354 * The Media Type has already been checked. If we are
355 * the first tor reserve the device, we put the pool
356 * name and pool type in the device record.
358 bool reserve_device_for_append(JCR *jcr, DEVICE *dev)
365 dev->block(BST_DOING_ACQUIRE);
366 if (dev->can_read()) {
367 Jmsg(jcr, M_WARNING, 0, _("Device %s is busy reading.\n"), dev->print_name());
370 if (device_is_unmounted(dev)) {
371 Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
375 Dmsg1(190, "reserve_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
377 * First handle the case that the drive is not yet in append mode
379 if (!dev->can_append() && dev->num_writers == 0) {
380 /* Now check if there are any reservations on the drive */
381 if (dev->reserved_device) {
382 /* Yes, now check if we want the same Pool and pool type */
383 if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
384 strcmp(dev->pool_type, dcr->pool_type) == 0) {
385 /* OK, compatible device */
387 /* Drive not suitable for us */
388 Jmsg(jcr, M_WARNING, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
392 /* Device is available but not yet reserved, reserve it for us */
393 bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
394 bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
395 dev->PoolId = dcr->PoolId;
401 * Now check if the device is in append mode
403 if (dev->can_append() || dev->num_writers > 0) {
404 Dmsg0(190, "device already in append.\n");
405 /* Yes, now check if we want the same Pool and pool type */
406 if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
407 strcmp(dev->pool_type, dcr->pool_type) == 0) {
408 /* OK, compatible device */
410 /* Drive not suitable for us */
411 Jmsg(jcr, M_WARNING, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
415 Pmsg0(000, "Logic error!!!! Should not get here.\n");
416 goto bail_out; /* should not get here */
420 dev->reserved_device++;
421 dcr->reserved_device = true;
430 * Acquire device for writing. We permit multiple writers.
431 * If this is the first one, we read the label.
433 * Returns: NULL if failed for any reason
435 * Note, normally reserve_device_for_append() is called
436 * before this routine.
438 DCR *acquire_device_for_append(JCR *jcr, DEVICE *dev)
440 bool release = false;
441 bool recycle = false;
442 bool do_mount = false;
446 dcr = new_dcr(jcr, dev);
448 dev->block(BST_DOING_ACQUIRE);
449 Dmsg1(190, "acquire_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
451 if (dcr->reserved_device) {
452 dev->reserved_device--;
453 dcr->reserved_device = false;
457 * With the reservation system, this should not happen
459 if (dev->can_read()) {
460 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev->print_name());
464 if (dev->can_append()) {
465 Dmsg0(190, "device already in append.\n");
467 * Device already in append mode
469 * Check if we have the right Volume mounted
470 * OK if current volume info OK
471 * OK if next volume matches current volume
472 * otherwise mount desired volume obtained from
473 * dir_find_next_appendable_volume
475 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
476 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
477 !(dir_find_next_appendable_volume(dcr) &&
478 strcmp(dev->VolHdr.VolName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
479 Dmsg0(190, "Wrong tape mounted.\n");
480 if (dev->num_writers != 0 || dev->reserved_device) {
481 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
484 /* Wrong tape mounted, release it, then fall through to get correct one */
485 Dmsg0(190, "Wrong tape mounted, release and try mount.\n");
490 * At this point, the correct tape is already mounted, so
491 * we do not need to do mount_next_write_volume(), unless
492 * we need to recycle the tape.
494 recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
495 Dmsg1(190, "Correct tape mounted. recycle=%d\n", recycle);
496 if (recycle && dev->num_writers != 0) {
497 Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
498 " because it is in use by another job.\n"));
501 if (dev->num_writers == 0) {
502 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
506 /* Not already in append mode, so mount the device */
507 Dmsg0(190, "Not in append mode, try mount.\n");
508 ASSERT(dev->num_writers == 0);
512 if (do_mount || recycle) {
513 Dmsg0(190, "Do mount_next_write_vol\n");
514 bool mounted = mount_next_write_volume(dcr, release);
516 if (!job_canceled(jcr)) {
517 /* Reduce "noise" -- don't print if job canceled */
518 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
525 dev->num_writers++; /* we are now a writer */
526 if (jcr->NumVolumes == 0) {
532 * If we jump here, it is an error return because
533 * rtn_dev will still be NULL
544 * This job is done, so release the device. From a Unix standpoint,
545 * the device remains open.
548 bool release_device(DCR *dcr)
552 DEVICE *dev = dcr->dev;
555 Dmsg1(100, "release_device device is %s\n", dev_is_tape(dev)?"tape":"disk");
557 /* if device is reserved, job never started, so release the reserve here */
558 if (dcr->reserved_device) {
559 dev->reserved_device--;
560 dcr->reserved_device = false;
563 if (dev->can_read()) {
564 dev->clear_read(); /* clear read bit */
565 /* Close if file or !CAP_ALWAYSOPEN */
566 if (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN)) {
567 offline_or_rewind_dev(dev);
570 /******FIXME**** send read volume usage statistics to director */
572 } else if (dev->num_writers > 0) {
574 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
575 if (dev->is_labeled()) {
576 Dmsg0(100, "dir_create_jobmedia_record. Release\n");
577 if (!dir_create_jobmedia_record(dcr)) {
578 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
579 dcr->VolCatInfo.VolCatName, jcr->Job);
582 /* If no more writers, write an EOF */
583 if (!dev->num_writers && dev_can_write(dev)) {
585 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolName);
587 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
588 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
589 /* Note! do volume update before close, which zaps VolCatInfo */
590 Dmsg0(100, "dir_update_vol_info. Release0\n");
591 dir_update_volume_info(dcr, false); /* send Volume info to Director */
592 Dmsg0(100, "==== write ansi eof label \n");
595 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
596 if (dev->num_writers == 0 && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
597 offline_or_rewind_dev(dev);
601 Jmsg2(jcr, M_FATAL, 0, _("BAD ERROR: release_device %s, Volume \"%s\" not in use.\n"),
602 dev->print_name(), NPRT(dcr->VolumeName));
603 Jmsg2(jcr, M_ERROR, 0, _("num_writers=%d state=%x\n"), dev->num_writers, dev->state);
607 /* Fire off Alert command and include any output */
608 if (!job_canceled(jcr) && dcr->device->alert_command) {
612 char line[MAXSTRING];
613 alert = get_pool_memory(PM_FNAME);
614 alert = edit_device_codes(dcr, alert, "");
615 bpipe = open_bpipe(alert, 0, "r");
617 while (fgets(line, sizeof(line), bpipe->rfd)) {
618 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
620 status = close_bpipe(bpipe);
626 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
627 alert, be.strerror(status));
630 Dmsg1(400, "alert status=%d\n", status);
631 free_pool_memory(alert);
636 pthread_cond_broadcast(&wait_device_release);