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 pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
33 DCR *new_dcr(JCR *jcr, DEVICE *dev)
35 if (jcr && jcr->dcr) {
38 DCR *dcr = (DCR *)malloc(sizeof(DCR));
39 memset(dcr, 0, sizeof(DCR));
45 dcr->block = new_block(dev);
46 dcr->rec = new_record();
48 dcr->max_spool_size = dev->device->max_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);
56 void free_dcr(DCR *dcr)
59 DEVICE *dev = dcr->dev;
61 /* Detach this dcr only if the dev is initialized */
62 if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
63 dcr->dev->attached_dcrs->remove(dcr);
66 free_block(dcr->block);
69 free_record(dcr->rec);
78 /*********************************************************************
79 * Acquire device for reading. We permit (for the moment)
80 * only one reader. We read the Volume label from the block and
81 * leave the block pointers just after the label.
83 * Returns: NULL if failed for any reason
86 DCR *acquire_device_for_read(JCR *jcr)
89 bool tape_previously_mounted;
90 bool tape_initially_mounted;
92 bool try_autochanger = true;
98 /* Called for each volume */
100 dcr = new_dcr(jcr, jcr->device->dev);
103 if (device_is_unmounted(dev)) {
104 Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
108 block_device(dev, BST_DOING_ACQUIRE);
111 init_dev_wait_timers(dev);
112 if (dev_state(dev, ST_READ) || dev->num_writers > 0) {
113 Jmsg2(jcr, M_FATAL, 0, _("Device %s is busy. Job %d canceled.\n"),
114 dev_name(dev), jcr->JobId);
118 tape_previously_mounted = dev_state(dev, ST_READ) ||
119 dev_state(dev, ST_APPEND) ||
120 dev_state(dev, ST_LABEL);
121 tape_initially_mounted = tape_previously_mounted;
123 /* Find next Volume, if any */
126 Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
130 for (i=1; i<jcr->CurVolume; i++) {
133 bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
135 /* Volume info is always needed because of VolParts */
136 Dmsg0(200, "dir_get_volume_info\n");
137 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
138 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
141 dcr->dev->num_parts = dcr->VolCatInfo.VolCatParts;
143 for (i=0; i<5; i++) {
144 dcr->dev->state &= ~ST_LABEL; /* force reread of label */
145 if (job_canceled(jcr)) {
146 Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
147 goto get_out; /* error return */
150 * This code ensures that the device is ready for
151 * reading. If it is a file, it opens it.
152 * If it is a tape, it checks the volume name
154 for ( ; !(dev->state & ST_OPENED); ) {
155 Dmsg1(120, "bstored: open vol=%s\n", dcr->VolumeName);
156 if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
157 if (dev->dev_errno == EIO) { /* no tape loaded */
161 /* If we have a device that requires mount,
162 * we need to try to open the label, so the info can be reported
163 * if a wrong volume has been mounted. */
164 if (dev_cap(dev, CAP_REQMOUNT) && (dcr->VolCatInfo.VolCatParts > 0)) {
168 Jmsg(jcr, M_FATAL, 0, _("Open device %s volume %s failed, ERR=%s\n"),
169 dev_name(dev), dcr->VolumeName, strerror_dev(dev));
172 Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
175 if (dev_cap(dev, CAP_REQMOUNT)) {
176 vol_label_status = read_dev_volume_label_guess(dcr, 0);
179 vol_label_status = read_dev_volume_label(dcr);
182 /****FIXME***** do not reread label if ioctl() says we are
183 * correctly possitioned. Possibly have way user can turn
184 * this optimization (to be implemented) off.
186 Dmsg0(200, "calling read-vol-label\n");
187 switch (vol_label_status) {
190 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
194 * Send error message generated by read_dev_volume_label()
195 * only we really had a tape mounted. This supresses superfluous
196 * error messages when nothing is mounted.
198 if (tape_previously_mounted) {
199 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
203 if (tape_initially_mounted) {
204 tape_initially_mounted = false;
209 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
211 tape_previously_mounted = true;
213 /* If the device requires mount, close it, so the device can be ejected.
214 * FIXME: This should perhaps be done for all devices. */
215 if (dev_cap(dev, CAP_REQMOUNT)) {
216 force_close_dev(dev);
219 /* Call autochanger only once unless ask_sysop called */
220 if (try_autochanger) {
222 Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
223 dcr->VolumeName, dcr->VolCatInfo.Slot);
224 stat = autoload_device(dcr, 0, NULL);
226 try_autochanger = false;
231 /* Mount a specific volume and no other */
232 Dmsg0(200, "calling dir_ask_sysop\n");
233 if (!dir_ask_sysop_to_mount_volume(dcr)) {
234 goto get_out; /* error return */
236 try_autochanger = true; /* permit using autochanger again */
237 continue; /* try reading again */
242 Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device \"%s\".\n"),
247 dev->state &= ~ST_APPEND; /* clear any previous append mode */
248 dev->state |= ST_READ; /* set read mode */
249 set_jcr_job_status(jcr, JS_Running);
250 dir_send_job_status(jcr);
251 Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
252 dcr->VolumeName, dev_name(dev));
266 * Acquire device for writing. We permit multiple writers.
267 * If this is the first one, we read the label.
269 * Returns: NULL if failed for any reason
270 * dev if successful (may change if new dev opened)
271 * This routine must be single threaded because we may create
272 * multiple devices (for files), thus we have our own mutex
273 * on top of the device mutex.
275 DCR *acquire_device_for_append(JCR *jcr)
277 bool release = false;
278 bool recycle = false;
279 bool do_mount = false;
281 DEVICE *dev = jcr->device->dev;
283 dcr = new_dcr(jcr, dev);
284 if (device_is_unmounted(dev)) {
285 Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
289 block_device(dev, BST_DOING_ACQUIRE);
291 P(mutex); /* lock all devices */
292 Dmsg1(190, "acquire_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
294 if (dev_state(dev, ST_APPEND)) {
295 Dmsg0(190, "device already in append.\n");
297 * Device already in append mode
299 * Check if we have the right Volume mounted
300 * OK if current volume info OK
301 * OK if next volume matches current volume
302 * otherwise mount desired volume obtained from
303 * dir_find_next_appendable_volume
305 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
306 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
307 !(dir_find_next_appendable_volume(dcr) &&
308 strcmp(dev->VolHdr.VolName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
309 Dmsg0(190, "Wrong tape mounted.\n");
310 if (dev->num_writers != 0) {
311 DEVICE *d = ((DEVRES *)dev->device)->dev;
312 uint32_t open_vols = 0;
313 for ( ; d; d=d->next) {
316 if (dev_state(dev, ST_FILE) && dev->max_open_vols > open_vols) {
317 d = init_dev(NULL, (DEVRES *)dev->device); /* init new device */
318 d->prev = dev; /* chain in new device */
321 /* Release old device */
325 free_dcr(dcr); /* release dcr pointing to old dev */
326 /* Make new device current device and lock it */
328 dcr = new_dcr(jcr, dev); /* get new dcr for new device */
330 block_device(dev, BST_DOING_ACQUIRE);
333 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev_name(dev));
337 /* Wrong tape mounted, release it, then fall through to get correct one */
338 Dmsg0(190, "Wrong tape mounted, release and try mount.\n");
343 * At this point, the correct tape is already mounted, so
344 * we do not need to do mount_next_write_volume(), unless
345 * we need to recycle the tape.
347 recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
348 Dmsg1(190, "Correct tape mounted. recycle=%d\n", recycle);
349 if (recycle && dev->num_writers != 0) {
350 Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
351 " because it is in use by another job.\n"));
354 if (dev->num_writers == 0) {
355 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
359 /* Not already in append mode, so mount the device */
360 Dmsg0(190, "Not in append mode, try mount.\n");
361 if (dev_state(dev, ST_READ)) {
362 Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev_name(dev));
365 ASSERT(dev->num_writers == 0);
369 if (do_mount || recycle) {
370 Dmsg0(190, "Do mount_next_write_vol\n");
371 V(mutex); /* don't lock everything during mount */
372 bool mounted = mount_next_write_volume(dcr, release);
373 P(mutex); /* re-lock */
375 if (!job_canceled(jcr)) {
376 /* Reduce "noise" -- don't print if job canceled */
377 Jmsg(jcr, M_FATAL, 0, _("Could not ready device \"%s\" for append.\n"),
385 if (jcr->NumVolumes == 0) {
388 set_jcr_job_status(jcr, JS_Running);
389 dir_send_job_status(jcr);
393 * If we jump here, it is an error return because
394 * rtn_dev will still be NULL
403 V(mutex); /* unlock other threads */
408 * This job is done, so release the device. From a Unix standpoint,
409 * the device remains open.
412 bool release_device(JCR *jcr)
415 DEVICE *dev = dcr->dev;
417 Dmsg1(100, "release_device device is %s\n", dev_is_tape(dev)?"tape":"disk");
418 if (dev_state(dev, ST_READ)) {
419 dev->state &= ~ST_READ; /* clear read bit */
420 if (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN)) {
421 offline_or_rewind_dev(dev);
424 /******FIXME**** send read volume usage statistics to director */
426 } else if (dev->num_writers > 0) {
428 Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
429 if (dev_state(dev, ST_LABEL)) {
430 Dmsg0(100, "dir_create_jobmedia_record. Release\n");
431 if (!dir_create_jobmedia_record(dcr)) {
432 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
433 dcr->VolCatInfo.VolCatName, jcr->Job);
435 /* If no more writers, write an EOF */
436 if (!dev->num_writers && dev_can_write(dev)) {
439 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
440 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
441 /* Note! do volume update before close, which zaps VolCatInfo */
442 Dmsg0(100, "dir_update_vol_info. Release0\n");
443 dir_update_volume_info(dcr, false); /* send Volume info to Director */
446 if (!dev->num_writers && (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
447 offline_or_rewind_dev(dev);
451 Jmsg2(jcr, M_FATAL, 0, _("BAD ERROR: release_device %s, Volume \"%s\" not in use.\n"),
452 dev_name(dev), NPRT(dcr->VolumeName));
453 Jmsg2(jcr, M_ERROR, 0, _("num_writers=%d state=%x\n"), dev->num_writers, dev->state);
456 /* Fire off Alert command and include any output */
457 if (!job_canceled(jcr) && jcr->device->alert_command) {
461 char line[MAXSTRING];
462 alert = get_pool_memory(PM_FNAME);
463 alert = edit_device_codes(jcr, alert, jcr->device->alert_command, "");
464 bpipe = open_bpipe(alert, 0, "r");
466 while (fgets(line, sizeof(line), bpipe->rfd)) {
467 Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
469 status = close_bpipe(bpipe);
475 Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
476 alert, be.strerror(status));
479 Dmsg1(400, "alert status=%d\n", status);
480 free_pool_memory(alert);
482 if (dev->prev && !dev_state(dev, ST_READ) && !dev->num_writers) {
485 dev->prev->next = dev->next; /* dechain */