]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/acquire.c
Change set_label() to set_labeled() -- a bit clearer
[bacula/bacula] / bacula / src / stored / acquire.c
1 /*
2  *  Routines to acquire and release a device for read/write
3  *
4  *   Kern Sibbald, August MMII
5  *
6  *   Version $Id$
7  */
8 /*
9    Copyright (C) 2002-2005 Kern Sibbald
10
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.
15
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.
20
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,
24    MA 02111-1307, USA.
25
26  */
27
28 #include "bacula.h"                   /* pull in global headers */
29 #include "stored.h"                   /* pull in Storage Deamon headers */
30
31 /*
32  * Create a new Device Control Record and attach
33  *   it to the device (if this is a real job).
34  */
35 DCR *new_dcr(JCR *jcr, DEVICE *dev)
36 {
37    if (jcr && jcr->dcr) {
38       return jcr->dcr;
39    }
40    DCR *dcr = (DCR *)malloc(sizeof(DCR));
41    memset(dcr, 0, sizeof(DCR));
42    if (jcr) {
43       jcr->dcr = dcr;
44    }
45    dcr->jcr = jcr;
46    dcr->dev = dev;
47    if (dev) {
48       dcr->device = dev->device;
49    }
50    dcr->block = new_block(dev);
51    dcr->rec = new_record();
52    dcr->spool_fd = -1;
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);
58    }
59    return dcr;
60 }
61
62 /*
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.
66  */
67 #ifdef needed
68 static void remove_dcr_from_dcrs(DCR *dcr)
69 {
70    JCR *jcr = dcr->jcr;
71    if (jcr->dcrs) {
72       int i = 0;
73       DCR *ldcr;
74       int num = jcr->dcrs->size();
75       for (i=0; i < num; i++) {
76          ldcr = (DCR *)jcr->dcrs->get(i);
77          if (ldcr == dcr) {
78             jcr->dcrs->remove(i);
79             if (jcr->dcr == dcr) {
80                jcr->dcr = NULL;
81             }
82          }
83       }
84    }
85 }
86 #endif
87
88 /*
89  * Free up all aspects of the given dcr -- i.e. dechain it,
90  *  release allocated memory, zap pointers, ...
91  */
92 void free_dcr(DCR *dcr)
93 {
94    JCR *jcr = dcr->jcr;
95    DEVICE *dev = dcr->dev;
96
97    /*
98     * If we reserved the device, we must decrement the
99     *  number of writers.
100     */
101    if (dcr->reserved_device) {
102       lock_device(dev);
103       dev->num_writers--;
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;
108       }
109       unlock_device(dev);
110    }
111
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);
116    }
117    if (dcr->block) {
118       free_block(dcr->block);
119    }
120    if (dcr->rec) {
121       free_record(dcr->rec);
122    }
123    if (dcr->jcr) {
124       dcr->jcr->dcr = NULL;
125    }
126    free(dcr);
127 }
128
129
130 /*
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).
136  */
137 bool reserve_device_for_read(JCR *jcr, DEVICE *dev)
138 {
139    DCR *dcr = jcr->dcr;
140    bool ok = false;
141
142    ASSERT(dcr);
143    if (device_is_unmounted(dev)) {
144       Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
145          dev->print_name());
146       return false;
147    }
148    lock_device(dev);
149    block_device(dev, BST_DOING_ACQUIRE);
150    unlock_device(dev);
151
152    if (dev->is_busy()) {
153       Jmsg2(jcr, M_FATAL, 0, _("Device %s is busy. Job %d canceled.\n"),
154             dev->print_name(), jcr->JobId);
155       goto get_out;
156    }
157    if (!dcr) {
158       dcr = new_dcr(jcr, dev);
159    }
160    dev->clear_append();
161    dev->set_read();
162    ok = true;
163
164 get_out:
165    P(dev->mutex);
166    unblock_device(dev);
167    V(dev->mutex);
168    return ok;
169 }
170
171
172 /*********************************************************************
173  * Acquire device for reading. 
174  *  The drive should have previously been reserved by calling 
175  *  reserve_device_for_read(). We read the Volume label from the block and
176  *  leave the block pointers just after the label.
177  *
178  *  Returns: NULL if failed for any reason
179  *           dcr  if successful
180  */
181 DCR *acquire_device_for_read(JCR *jcr, DEVICE *dev)
182 {
183    bool vol_ok = false;
184    bool tape_previously_mounted;
185    bool tape_initially_mounted;
186    VOL_LIST *vol;
187    bool try_autochanger = true;
188    int i;
189    DCR *dcr = jcr->dcr;
190    int vol_label_status;
191    
192    lock_device(dev);
193    block_device(dev, BST_DOING_ACQUIRE);
194    unlock_device(dev);
195
196    init_dev_wait_timers(dev);
197
198    tape_previously_mounted = dev->can_read() ||
199                              dev->can_append() ||
200                              dev->is_labeled();
201    tape_initially_mounted = tape_previously_mounted;
202
203    if (dev->num_writers > 0) {
204       Jmsg2(jcr, M_FATAL, 0, _("Num_writers=%d not zero. Job %d canceled.\n"), 
205          dev->num_writers, jcr->JobId);
206       goto get_out;
207    }
208
209    /* Find next Volume, if any */
210    vol = jcr->VolList;
211    if (!vol) {
212       Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
213       goto get_out;
214    }
215    jcr->CurVolume++;
216    for (i=1; i<jcr->CurVolume; i++) {
217       vol = vol->next;
218    }
219    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
220
221    /* Volume info is always needed because of VolParts */
222    Dmsg0(200, "dir_get_volume_info\n");
223    if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
224       Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
225    }
226    
227    dev->num_parts = dcr->VolCatInfo.VolCatParts;
228    
229    for (i=0; i<5; i++) {
230       dev->clear_labeled();              /* force reread of label */
231       if (job_canceled(jcr)) {
232          Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
233          goto get_out;                /* error return */
234       }
235       /*
236        * This code ensures that the device is ready for
237        * reading. If it is a file, it opens it.
238        * If it is a tape, it checks the volume name
239        */
240       for ( ; !dev->is_open(); ) {
241          Dmsg1(120, "bstored: open vol=%s\n", dcr->VolumeName);
242          if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
243             if (dev->dev_errno == EIO) {   /* no tape loaded */
244                goto default_path;
245             }
246             
247             /* If we have a dvd that requires mount, 
248              * we need to try to open the label, so the info can be reported
249              * if a wrong volume has been mounted. */
250             if (dev->is_dvd() && (dcr->VolCatInfo.VolCatParts > 0)) {
251                break;
252             }
253             
254             Jmsg(jcr, M_FATAL, 0, _("Open device %s Volume \"%s\" failed: ERR=%s\n"),
255                 dev->print_name(), dcr->VolumeName, strerror_dev(dev));
256             goto get_out;
257          }
258          Dmsg1(129, "open_dev %s OK\n", dev->print_name());
259       }
260       
261       if (dev->is_dvd()) {
262          vol_label_status = read_dev_volume_label_guess(dcr, 0);
263       } else {
264          vol_label_status = read_dev_volume_label(dcr);
265       }
266       
267       Dmsg0(200, "calling read-vol-label\n");
268       switch (vol_label_status) {
269       case VOL_OK:
270          vol_ok = true;
271          memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
272          break;                    /* got it */
273       case VOL_IO_ERROR:
274          /*
275           * Send error message generated by read_dev_volume_label()
276           *  only we really had a tape mounted. This supresses superfluous
277           *  error messages when nothing is mounted.
278           */
279          if (tape_previously_mounted) {
280             Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
281          }
282          goto default_path;
283       case VOL_NAME_ERROR:
284          if (tape_initially_mounted) {
285             tape_initially_mounted = false;
286             goto default_path;
287          }
288          /* Fall through */
289       default:
290          Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
291 default_path:
292          tape_previously_mounted = true;
293          
294          /* If the device requires mount, close it, so the device can be ejected.
295           * FIXME: This should perhaps be done for all devices. */
296          if (dev_cap(dev, CAP_REQMOUNT)) {
297             force_close_dev(dev);
298          }
299          
300          /* Call autochanger only once unless ask_sysop called */
301          if (try_autochanger) {
302             int stat;
303             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
304                dcr->VolumeName, dcr->VolCatInfo.Slot);
305             stat = autoload_device(dcr, 0, NULL);
306             if (stat > 0) {
307                try_autochanger = false;
308                continue;              /* try reading volume mounted */
309             }
310          }
311          
312          /* Mount a specific volume and no other */
313          Dmsg0(200, "calling dir_ask_sysop\n");
314          if (!dir_ask_sysop_to_mount_volume(dcr)) {
315             goto get_out;             /* error return */
316          }
317          try_autochanger = true;      /* permit using autochanger again */
318          continue;                    /* try reading again */
319       } /* end switch */
320       break;
321    } /* end for loop */
322    if (!vol_ok) {
323       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
324             dev->print_name());
325       goto get_out;
326    }
327
328    dev->clear_append();
329    dev->set_read();
330    set_jcr_job_status(jcr, JS_Running);
331    dir_send_job_status(jcr);
332    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
333       dcr->VolumeName, dev->print_name());
334
335 get_out:
336    P(dev->mutex);
337    unblock_device(dev);
338    V(dev->mutex);
339    if (!vol_ok) {
340       free_dcr(dcr);
341       dcr = NULL;
342    }
343    return dcr;
344 }
345
346 /*
347  * We reserve the device for appending by incrementing the 
348  *  reserved_device. We do virtually all the same work that
349  *  is done in acquire_device_for_append(), but we do
350  *  not attempt to mount the device. This routine allows
351  *  the DIR to reserve multiple devices before *really* 
352  *  starting the job. It also permits the SD to refuse 
353  *  certain devices (not up, ...).
354  *
355  * Note, in reserving a device, if the device is for the
356  *  same pool and the same pool type, then it is acceptable.
357  *  The Media Type has already been checked. If we are
358  *  the first tor reserve the device, we put the pool
359  *  name and pool type in the device record.
360  */
361 bool reserve_device_for_append(JCR *jcr, DEVICE *dev)
362 {
363    DCR *dcr = jcr->dcr;
364    bool ok = false;
365
366    ASSERT(dcr);
367
368    lock_device(dev);
369    block_device(dev, BST_DOING_ACQUIRE);
370    unlock_device(dev);
371    if (dev->can_read()) {
372       Jmsg(jcr, M_WARNING, 0, _("Device %s is busy reading.\n"), dev->print_name());
373       goto bail_out;
374    }
375    if (device_is_unmounted(dev)) {
376       Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
377          dev->print_name());
378       goto bail_out;
379    }
380    Dmsg1(190, "reserve_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
381    /*
382     * First handle the case that the drive is not yet in append mode
383     */
384    if (!dev->can_append() && dev->num_writers == 0) {
385       /* Now check if there are any reservations on the drive */
386       if (dev->reserved_device) {           
387          /* Yes, now check if we want the same Pool and pool type */
388          if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
389              strcmp(dev->pool_type, dcr->pool_type) == 0) {
390             /* OK, compatible device */
391          } else {
392             /* Drive not suitable for us */
393             Jmsg(jcr, M_WARNING, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
394             goto bail_out;
395          }
396       } else {
397          /* Device is available but not yet reserved, reserve it for us */
398          bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
399          bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
400          dev->PoolId = dcr->PoolId;
401       }
402       goto do_reserve;
403    }
404
405    /*
406     * Now check if the device is in append mode 
407     */
408    if (dev->can_append() || dev->num_writers > 0) {
409       Dmsg0(190, "device already in append.\n");
410       /* Yes, now check if we want the same Pool and pool type */
411       if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
412           strcmp(dev->pool_type, dcr->pool_type) == 0) {
413          /* OK, compatible device */
414       } else {
415          /* Drive not suitable for us */
416          Jmsg(jcr, M_WARNING, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
417          goto bail_out;
418       }
419    } else {
420       Pmsg0(000, "Logic error!!!! Should not get here.\n");
421       goto bail_out;                  /* should not get here */
422    }
423
424 do_reserve:
425    dev->reserved_device++;
426    dcr->reserved_device = true;
427    ok = true;
428
429 bail_out:
430    P(dev->mutex);
431    unblock_device(dev);
432    V(dev->mutex);
433    return ok;
434 }
435
436 /*
437  * Acquire device for writing. We permit multiple writers.
438  *  If this is the first one, we read the label.
439  *
440  *  Returns: NULL if failed for any reason
441  *           dcr if successful.
442  *   Note, normally reserve_device_for_append() is called
443  *   before this routine.
444  */
445 DCR *acquire_device_for_append(JCR *jcr, DEVICE *dev)
446 {
447    bool release = false;
448    bool recycle = false;
449    bool do_mount = false;
450    DCR *dcr = jcr->dcr;
451
452    if (!dcr) {
453       dcr = new_dcr(jcr, dev);
454    }
455    lock_device(dev);
456    block_device(dev, BST_DOING_ACQUIRE);
457    unlock_device(dev);
458    Dmsg1(190, "acquire_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
459
460    if (dcr->reserved_device) {
461       dev->reserved_device--;
462       dcr->reserved_device = false;
463    }
464
465    /*
466     * With the reservation system, this should not happen
467     */
468    if (dev->can_read()) {
469       Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev->print_name());
470       goto get_out;
471    }
472
473    if (dev->can_append()) {
474       Dmsg0(190, "device already in append.\n");
475       /*
476        * Device already in append mode
477        *
478        * Check if we have the right Volume mounted
479        *   OK if current volume info OK
480        *   OK if next volume matches current volume
481        *   otherwise mount desired volume obtained from
482        *    dir_find_next_appendable_volume
483        */
484       bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
485       if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
486           !(dir_find_next_appendable_volume(dcr) &&
487             strcmp(dev->VolHdr.VolName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
488          Dmsg0(190, "Wrong tape mounted.\n");
489          if (dev->num_writers != 0 || dev->reserved_device) {
490             Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev->print_name());
491             goto get_out;
492          }
493          /* Wrong tape mounted, release it, then fall through to get correct one */
494          Dmsg0(190, "Wrong tape mounted, release and try mount.\n");
495          release = true;
496          do_mount = true;
497       } else {
498          /*
499           * At this point, the correct tape is already mounted, so
500           *   we do not need to do mount_next_write_volume(), unless
501           *   we need to recycle the tape.
502           */
503           recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
504           Dmsg1(190, "Correct tape mounted. recycle=%d\n", recycle);
505           if (recycle && dev->num_writers != 0) {
506              Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
507                   " because it is in use by another job.\n"));
508              goto get_out;
509           }
510           if (dev->num_writers == 0) {
511              memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
512           }
513        }
514    } else {
515       /* Not already in append mode, so mount the device */
516       Dmsg0(190, "Not in append mode, try mount.\n");
517       ASSERT(dev->num_writers == 0);
518       do_mount = true;
519    }
520
521    if (do_mount || recycle) {
522       Dmsg0(190, "Do mount_next_write_vol\n");
523       bool mounted = mount_next_write_volume(dcr, release);
524       if (!mounted) {
525          if (!job_canceled(jcr)) {
526             /* Reduce "noise" -- don't print if job canceled */
527             Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
528                dev->print_name());
529          }
530          goto get_out;
531       }
532    }
533
534    dev->num_writers++;                /* we are now a writer */
535    if (jcr->NumVolumes == 0) {
536       jcr->NumVolumes = 1;
537    }
538    goto ok_out;
539
540 /*
541  * If we jump here, it is an error return because
542  *  rtn_dev will still be NULL
543  */
544 get_out:
545    free_dcr(dcr);
546    dcr = NULL;
547 ok_out:
548    P(dev->mutex);
549    unblock_device(dev);
550    V(dev->mutex);
551    return dcr;
552 }
553
554 /*
555  * This job is done, so release the device. From a Unix standpoint,
556  *  the device remains open.
557  *
558  */
559 bool release_device(DCR *dcr)
560 {
561    bool ok = true;
562    JCR *jcr = dcr->jcr;
563    DEVICE *dev = dcr->dev;
564
565    lock_device(dev);
566    Dmsg1(100, "release_device device is %s\n", dev_is_tape(dev)?"tape":"disk");
567
568    /* if device is reserved, job never started, so release the reserve here */
569    if (dcr->reserved_device) {
570       dev->reserved_device--;
571       dcr->reserved_device = false;
572    }
573
574    if (dev->can_read()) {
575       dev->clear_read();              /* clear read bit */
576       /* Close if file or !CAP_ALWAYSOPEN */
577       if (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN)) {
578          offline_or_rewind_dev(dev);
579          close_dev(dev);
580       }
581       /******FIXME**** send read volume usage statistics to director */
582
583    } else if (dev->num_writers > 0) {
584       dev->num_writers--;
585       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
586       if (dev->is_labeled()) {
587          Dmsg0(100, "dir_create_jobmedia_record. Release\n");
588          if (!dir_create_jobmedia_record(dcr)) {
589             Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
590                dcr->VolCatInfo.VolCatName, jcr->Job);
591             ok = false;
592          }
593          /* If no more writers, write an EOF */
594          if (!dev->num_writers && dev_can_write(dev)) {
595             weof_dev(dev, 1);
596             write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolName);
597          }
598          dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
599          dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
600          /* Note! do volume update before close, which zaps VolCatInfo */
601          Dmsg0(100, "dir_update_vol_info. Release0\n");
602          dir_update_volume_info(dcr, false); /* send Volume info to Director */
603          Dmsg0(100, "==== write ansi eof label \n");
604       }
605
606       /* If no writers, close if file or !CAP_ALWAYS_OPEN */
607       if (dev->num_writers == 0 && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
608          offline_or_rewind_dev(dev);
609          close_dev(dev);
610       }
611    } else {
612       Jmsg2(jcr, M_FATAL, 0, _("BAD ERROR: release_device %s, Volume \"%s\" not in use.\n"),
613             dev->print_name(), NPRT(dcr->VolumeName));
614       Jmsg2(jcr, M_ERROR, 0, _("num_writers=%d state=%x\n"), dev->num_writers, dev->state);
615       ok = false;
616    }
617
618    /* Fire off Alert command and include any output */
619    if (!job_canceled(jcr) && dcr->device->alert_command) {
620       POOLMEM *alert;
621       int status = 1;
622       BPIPE *bpipe;
623       char line[MAXSTRING];
624       alert = get_pool_memory(PM_FNAME);
625       alert = edit_device_codes(dcr, alert, "");
626       bpipe = open_bpipe(alert, 0, "r");
627       if (bpipe) {
628          while (fgets(line, sizeof(line), bpipe->rfd)) {
629             Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
630          }
631          status = close_bpipe(bpipe);
632       } else {
633          status = errno;
634       }
635       if (status != 0) {
636          berrno be;
637          Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
638               alert, be.strerror(status));
639       }
640
641       Dmsg1(400, "alert status=%d\n", status);
642       free_pool_memory(alert);
643    }
644    unlock_device(dev);
645    free_dcr(dcr);
646    jcr->dcr = NULL;
647    return ok;
648 }