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
13 version 2 as amended with additional clauses defined in the
14 file LICENSE in the main source directory.
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
19 the file LICENSE for additional details.
23 #include "bacula.h" /* pull in global headers */
24 #include "stored.h" /* pull in Storage Deamon headers */
27 * Create a new Device Control Record and attach
28 * it to the device (if this is a real job).
30 DCR *new_dcr(JCR *jcr, DEVICE *dev)
32 if (jcr && jcr->dcr) {
35 DCR *dcr = (DCR *)malloc(sizeof(DCR));
36 memset(dcr, 0, sizeof(DCR));
43 dcr->device = dev->device;
45 dcr->block = new_block(dev);
46 dcr->rec = new_record();
48 dcr->max_job_spool_size = dev->device->max_job_spool_size;
49 /* Attach this dcr only if dev is initialized */
50 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
51 dev->attached_dcrs->append(dcr); /* attach dcr to device */
52 // jcr->dcrs->append(dcr); /* put dcr in list for Job */
58 * Search the dcrs list for the given dcr. If it is found,
59 * as it should be, then remove it. Also zap the jcr pointer
60 * to the dcr if it is the same one.
63 static void remove_dcr_from_dcrs(DCR *dcr)
69 int num = jcr->dcrs->size();
70 for (i=0; i < num; i++) {
71 ldcr = (DCR *)jcr->dcrs->get(i);
74 if (jcr->dcr == dcr) {
84 * Free up all aspects of the given dcr -- i.e. dechain it,
85 * release allocated memory, zap pointers, ...
87 void free_dcr(DCR *dcr)
90 DEVICE *dev = dcr->dev;
92 if (dcr->reserved_device) {
94 dev->reserved_device--;
95 Dmsg1(200, "Dec reserve=%d\n", dev->reserved_device);
96 dcr->reserved_device = false;
97 if (dev->num_writers < 0) {
98 Jmsg1(dcr->jcr, M_ERROR, 0, _("Hey! num_writers=%d!!!!\n"), dev->num_writers);
104 /* Detach this dcr only if the dev is initialized */
105 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
106 dev->attached_dcrs->remove(dcr); /* detach dcr from device */
107 // remove_dcr_from_dcrs(dcr); /* remove dcr from jcr list */
110 free_block(dcr->block);
113 free_record(dcr->rec);
116 dcr->jcr->dcr = NULL;
118 free_unused_volume(dcr); /* free unused vols attached to this dcr */
122 /*********************************************************************
123 * Acquire device for reading.
124 * The drive should have previously been reserved by calling
125 * reserve_device_for_read(). We read the Volume label from the block and
126 * leave the block pointers just after the label.
128 * Returns: NULL if failed for any reason
131 DCR *acquire_device_for_read(DCR *dcr)
133 DEVICE *dev = dcr->dev;
136 bool tape_previously_mounted;
137 bool tape_initially_mounted;
139 bool try_autochanger = true;
141 int vol_label_status;
143 dev->block(BST_DOING_ACQUIRE);
145 if (dev->num_writers > 0) {
146 Jmsg2(jcr, M_FATAL, 0, _("Num_writers=%d not zero. Job %d canceled.\n"),
147 dev->num_writers, jcr->JobId);
151 /* Find next Volume, if any */
154 Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
158 for (i=1; i<jcr->CurVolume; i++) {
162 goto get_out; /* should not happen */
164 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
166 init_device_wait_timers(dcr);
168 tape_previously_mounted = dev->can_read() || dev->can_append() ||
170 tape_initially_mounted = tape_previously_mounted;
173 /* Volume info is always needed because of VolParts */
174 Dmsg0(200, "dir_get_volume_info\n");
175 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
176 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
179 for (i=0; i<5; i++) {
180 dev->clear_labeled(); /* force reread of label */
181 if (job_canceled(jcr)) {
182 Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
183 goto get_out; /* error return */
186 * This code ensures that the device is ready for
187 * reading. If it is a file, it opens it.
188 * If it is a tape, it checks the volume name
190 for ( ; !dev->is_open(); ) {
191 Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
192 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
193 if (dev->dev_errno == EIO) { /* no tape loaded */
194 Jmsg3(jcr, M_WARNING, 0, _("Open device %s Volume \"%s\" failed (EIO): ERR=%s\n"),
195 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
200 /* If we have a dvd that requires mount,
201 * we need to try to open the label, so the info can be reported
202 * if a wrong volume has been mounted.
204 if (dev->is_dvd() && (dcr->VolCatInfo.VolCatParts > 0)) {
209 Jmsg3(jcr, M_FATAL, 0, _("Open device %s Volume \"%s\" failed: ERR=%s\n"),
210 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
213 Dmsg1(100, "opened dev %s OK\n", dev->print_name());
216 /* Read Volume Label */
218 Dmsg0(200, "calling read-vol-label\n");
219 vol_label_status = read_dev_volume_label(dcr);
220 switch (vol_label_status) {
223 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
227 * Send error message generated by read_dev_volume_label()
228 * only we really had a tape mounted. This supresses superfluous
229 * error messages when nothing is mounted.
231 if (tape_previously_mounted) {
232 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
236 if (tape_initially_mounted) {
237 tape_initially_mounted = false;
242 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
244 tape_previously_mounted = true;
246 /* If the device requires mount, close it, so the device can be ejected.
247 * FIXME: This should perhaps be done for all devices. */
248 if (dev->requires_mount()) {
249 force_close_device(dev);
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)) {
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.\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());
298 * Acquire device for writing. We permit multiple writers.
299 * If this is the first one, we read the label.
301 * Returns: NULL if failed for any reason
303 * Note, normally reserve_device_for_append() is called
304 * before this routine.
306 DCR *acquire_device_for_append(DCR *dcr)
308 bool release = false;
309 bool recycle = false;
310 bool do_mount = false;
311 DEVICE *dev = dcr->dev;
314 init_device_wait_timers(dcr);
316 dev->block(BST_DOING_ACQUIRE);
317 Dmsg1(190, "acquire_append device is %s\n", dev->is_tape()?"tape":
318 (dev->is_dvd()?"DVD":"disk"));
320 if (dcr->reserved_device) {
321 dev->reserved_device--;
322 Dmsg1(200, "Dec reserve=%d\n", dev->reserved_device);
323 dcr->reserved_device = false;
327 * With the reservation system, this should not happen
329 if (dev->can_read()) {
330 Jmsg1(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev->print_name());
334 if (dev->can_append()) {
335 Dmsg0(190, "device already in append.\n");
337 * Device already in append mode
339 * Check if we have the right Volume mounted
340 * OK if current volume info OK
341 * OK if next volume matches current volume
342 * otherwise mount desired volume obtained from
343 * dir_find_next_appendable_volume
344 * dev->VolHdr.VolumeName is what is in the drive
345 * dcr->VolumeName is what we pass into the routines, or
346 * get back from the subroutines.
348 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
349 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
350 !(dir_find_next_appendable_volume(dcr) &&
351 strcmp(dev->VolHdr.VolumeName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
352 Dmsg2(190, "Wrong tape mounted: %s. wants:%s\n", dev->VolHdr.VolumeName,
354 /* Release volume reserved by dir_find_next_appendable_volume() */
355 if (dcr->VolumeName[0]) {
356 free_unused_volume(dcr);
358 if (dev->num_writers != 0 || dev->reserved_device) {
359 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
362 /* Wrong tape mounted, release it, then fall through to get correct one */
363 Dmsg0(190, "Wrong tape mounted, release and try mount.\n");
368 * At this point, the correct tape is already mounted, so
369 * we do not need to do mount_next_write_volume(), unless
370 * we need to recycle the tape.
372 recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
373 Dmsg1(190, "Correct tape mounted. recycle=%d\n", recycle);
374 if (recycle && dev->num_writers != 0) {
375 Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
376 " on device %s because it is in use by another job.\n"),
377 dev->VolHdr.VolumeName, dev->print_name());
380 if (dev->num_writers == 0) {
381 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
385 /* Not already in append mode, so mount the device */
386 Dmsg0(190, "Not in append mode, try mount.\n");
387 ASSERT(dev->num_writers == 0);
391 if (do_mount || recycle) {
392 Dmsg0(190, "Do mount_next_write_vol\n");
393 bool mounted = mount_next_write_volume(dcr, release);
395 if (!job_canceled(jcr)) {
396 /* Reduce "noise" -- don't print if job canceled */
397 Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
404 dev->num_writers++; /* we are now a writer */
405 if (jcr->NumVolumes == 0) {
411 * If we jump here, it is an error return because
412 * rtn_dev will still be NULL
423 * This job is done, so release the device. From a Unix standpoint,
424 * the device remains open.
427 bool release_device(DCR *dcr)
430 DEVICE *dev = dcr->dev;
434 Dmsg1(100, "release_device device is %s\n", dev->is_tape()?"tape":"disk");
436 /* if device is reserved, job never started, so release the reserve here */
437 if (dcr->reserved_device) {
438 dev->reserved_device--;
439 Dmsg1(200, "Dec reserve=%d\n", dev->reserved_device);
440 dcr->reserved_device = false;
443 if (dev->can_read()) {
444 dev->clear_read(); /* clear read bit */
446 /******FIXME**** send read volume usage statistics to director */
448 } else if (dev->num_writers > 0) {
450 * Note if WEOT is set, we are at the end of the tape
451 * and may not be positioned correctly, so the
452 * job_media_record and update_vol_info have already been
453 * done, which means we skip them here.
456 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
457 if (dev->is_labeled()) {
458 Dmsg0(100, "dir_create_jobmedia_record. Release\n");
459 if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
460 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
461 dcr->VolCatInfo.VolCatName, jcr->Job);
463 /* If no more writers, write an EOF */
464 if (!dev->num_writers && dev->can_write()) {
466 write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
468 if (!dev->at_weot()) {
469 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
470 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
471 /* Note! do volume update before close, which zaps VolCatInfo */
472 Dmsg0(100, "dir_update_vol_info. Release0\n");
473 dir_update_volume_info(dcr, false); /* send Volume info to Director */
479 * If we reach here, it is most likely because the job
480 * has failed, since the device is not in read mode and
481 * there are no writers. It was probably reserved.
485 /* If no writers, close if file or !CAP_ALWAYS_OPEN */
486 if (dev->num_writers == 0 && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
487 offline_or_rewind_dev(dev);
491 /* Fire off Alert command and include any output */
492 if (!job_canceled(jcr) && dcr->device->alert_command) {
496 char line[MAXSTRING];
497 alert = get_pool_memory(PM_FNAME);
498 alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
499 bpipe = open_bpipe(alert, 0, "r");
501 while (fgets(line, sizeof(line), bpipe->rfd)) {
502 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
504 status = close_bpipe(bpipe);
510 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
511 alert, be.strerror(status));
514 Dmsg1(400, "alert status=%d\n", status);
515 free_pool_memory(alert);
520 pthread_cond_broadcast(&wait_device_release);