]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/dev.c
554a5f4831397222234ad024b513cd6f3bcc80a4
[bacula/bacula] / bacula / src / stored / dev.c
1 /*
2  *
3  *   dev.c  -- low level operations on device (storage device)
4  *
5  *              Kern Sibbald, MM 
6  *
7  *     NOTE!!!! None of these routines are reentrant. You must
8  *        use lock_device() and unlock_device() at a higher level,
9  *        or use the xxx_device() equivalents.  By moving the
10  *        thread synchronization to a higher level, we permit
11  *        the higher level routines to "seize" the device and 
12  *        to carry out operations without worrying about who
13  *        set what lock (i.e. race conditions).
14  *
15  *     Note, this is the device dependent code, and my have
16  *           to be modified for each system, but is meant to
17  *           be as "generic" as possible.
18  * 
19  *     The purpose of this code is to develop a SIMPLE Storage
20  *     daemon. More complicated coding (double buffering, writer
21  *     thread, ...) is left for a later version.
22  *
23  *     Unfortunately, I have had to add more and more complication
24  *     to this code. This was not foreseen as noted above, and as
25  *     a consequence has lead to something more contorted than is
26  *     really necessary -- KES.  Note, this contortion has been
27  *     corrected to a large extent by a rewrite (Apr MMI).
28  *
29  *   Version $Id$
30  */
31 /*
32    Copyright (C) 2000-2004 Kern Sibbald and John Walker
33
34    This program is free software; you can redistribute it and/or
35    modify it under the terms of the GNU General Public License as
36    published by the Free Software Foundation; either version 2 of
37    the License, or (at your option) any later version.
38
39    This program is distributed in the hope that it will be useful,
40    but WITHOUT ANY WARRANTY; without even the implied warranty of
41    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42    General Public License for more details.
43
44    You should have received a copy of the GNU General Public
45    License along with this program; if not, write to the Free
46    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
47    MA 02111-1307, USA.
48
49  */
50
51 /*
52  * Handling I/O errors and end of tape conditions are a bit tricky.
53  * This is how it is currently done when writting.
54  * On either an I/O error or end of tape,
55  * we will stop writing on the physical device (no I/O recovery is
56  * attempted at least in this daemon). The state flag will be sent
57  * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58  * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59  * cleared only when the problem goes away.  Now when ST_WEOT
60  * is set all calls to write_block_to_device() call the fix_up
61  * routine. In addition, all threads are blocked
62  * from writing on the tape by calling lock_dev(), and thread other
63  * than the first thread to hit the EOT will block on a condition
64  * variable. The first thread to hit the EOT will continue to
65  * be able to read and write the tape (he sort of tunnels through
66  * the locking mechanism -- see lock_dev() for details).
67  *
68  * Now presumably somewhere higher in the chain of command 
69  * (device.c), someone will notice the EOT condition and 
70  * get a new tape up, get the tape label read, and mark 
71  * the label for rewriting. Then this higher level routine 
72  * will write the unwritten buffer to the new volume.
73  * Finally, he will release
74  * any blocked threads by doing a broadcast on the condition
75  * variable.  At that point, we should be totally back in 
76  * business with no lost data.
77  */
78
79
80 #include "bacula.h"
81 #include "stored.h"
82
83 /* Forward referenced functions */
84
85 /* 
86  * Allocate and initialize the DEVICE structure
87  * Note, if dev is non-NULL, it is already allocated,
88  * thus we neither allocate it nor free it. This allows
89  * the caller to put the packet in shared memory.
90  *
91  *  Note, for a tape, the device->device_name is the device name
92  *     (e.g. /dev/nst0), and for a file, the device name
93  *     is the directory in which the file will be placed.
94  *
95  */
96 DEVICE *
97 init_dev(DEVICE *dev, DEVRES *device)
98 {
99    struct stat statp;
100    bool tape, fifo;
101    int errstat;
102    DCR *dcr = NULL;
103
104    /* Check that device is available */
105    if (stat(device->device_name, &statp) < 0) {
106       if (dev) {
107          dev->dev_errno = errno;
108       } 
109       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name, 
110             strerror(errno));
111       return NULL;
112    }
113    tape = false;
114    fifo = false;
115    if (S_ISDIR(statp.st_mode)) {
116       tape = false;
117    } else if (S_ISCHR(statp.st_mode)) {
118       tape = true;
119    } else if (S_ISFIFO(statp.st_mode)) {
120       fifo = true;
121    } else {
122       if (dev) {
123          dev->dev_errno = ENODEV;
124       }
125       Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
126          device->device_name, statp.st_mode);
127       return NULL;
128    }
129    if (!dev) {
130       dev = (DEVICE *)get_memory(sizeof(DEVICE));
131       memset(dev, 0, sizeof(DEVICE));
132       dev->state = ST_MALLOC;
133    } else {
134       memset(dev, 0, sizeof(DEVICE));
135    }
136
137    /* Copy user supplied device parameters from Resource */
138    dev->dev_name = get_memory(strlen(device->device_name)+1);
139    strcpy(dev->dev_name, device->device_name);
140    dev->capabilities = device->cap_bits;
141    dev->min_block_size = device->min_block_size;
142    dev->max_block_size = device->max_block_size;
143    dev->max_volume_size = device->max_volume_size;
144    dev->max_file_size = device->max_file_size;
145    dev->volume_capacity = device->volume_capacity;
146    dev->max_rewind_wait = device->max_rewind_wait;
147    dev->max_open_wait = device->max_open_wait;
148    dev->max_open_vols = device->max_open_vols;
149    dev->vol_poll_interval = device->vol_poll_interval;
150    dev->max_spool_size = device->max_spool_size;
151    dev->drive_index = device->drive_index;
152    /* Sanity check */
153    if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
154       dev->vol_poll_interval = 60;
155    }
156    dev->device = device;
157
158    if (tape) {
159       dev->state |= ST_TAPE;
160    } else if (fifo) {
161       dev->state |= ST_FIFO;
162       dev->capabilities |= CAP_STREAM; /* set stream device */
163    } else {
164       dev->state |= ST_FILE;
165    }
166
167    if (dev->max_block_size > 1000000) {
168       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"), 
169          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
170       dev->max_block_size = 0;
171    }
172    if (dev->max_block_size % TAPE_BSIZE != 0) {
173       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
174          dev->max_block_size, dev->dev_name);
175    }   
176          
177    dev->errmsg = get_pool_memory(PM_EMSG);
178    *dev->errmsg = 0;
179
180    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
181       dev->dev_errno = errstat;
182       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
183       Emsg0(M_FATAL, 0, dev->errmsg);
184    }
185    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
186       dev->dev_errno = errstat;
187       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
188       Emsg0(M_FATAL, 0, dev->errmsg);
189    }
190    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
191       dev->dev_errno = errstat;
192       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
193       Emsg0(M_FATAL, 0, dev->errmsg);
194    }
195    if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
196       dev->dev_errno = errstat;
197       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
198       Emsg0(M_FATAL, 0, dev->errmsg);
199    }
200    dev->fd = -1;
201    dev->attached_dcrs = new dlist(dcr, &dcr->dev_link);
202    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
203
204    return dev;
205 }
206
207 /* Open the device with the operating system and
208  * initialize buffer pointers.
209  *
210  * Note, for a tape, the VolName is the name we give to the
211  *    volume (not really used here), but for a file, the
212  *    VolName represents the name of the file to be created/opened.
213  *    In the case of a file, the full name is the device name
214  *    (archive_name) with the VolName concatenated.
215  */
216 int
217 open_dev(DEVICE *dev, char *VolName, int mode)
218 {
219    POOLMEM *archive_name;
220
221    if (dev->state & ST_OPENED) {
222       /*
223        *  *****FIXME***** how to handle two threads wanting
224        *  different volumes mounted???? E.g. one is waiting
225        *  for the next volume to be mounted, and a new job
226        *  starts and snatches up the device.
227        */
228       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
229          return -1;
230       }
231       dev->use_count++;
232       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"), 
233             dev->dev_name, dev->use_count);
234       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
235       return dev->fd;
236    }
237    if (VolName) {
238       bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
239    }
240
241    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev), 
242          dev->dev_name, dev->VolCatInfo.VolCatName);
243    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
244    if (dev->state & (ST_TAPE|ST_FIFO)) {
245       int timeout;
246       Dmsg0(29, "open_dev: device is tape\n");
247       if (mode == OPEN_READ_WRITE) {
248          dev->mode = O_RDWR | O_BINARY;
249       } else if (mode == OPEN_READ_ONLY) {
250          dev->mode = O_RDONLY | O_BINARY;
251       } else if (mode == OPEN_WRITE_ONLY) {
252          dev->mode = O_WRONLY | O_BINARY;
253       } else {
254          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n")); 
255       }
256       timeout = dev->max_open_wait;
257       errno = 0;
258       if (dev->state & ST_FIFO && timeout) {
259          /* Set open timer */
260          dev->tid = start_thread_timer(pthread_self(), timeout);
261       }
262       /* If busy retry each second for max_open_wait seconds */
263       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
264          if (errno == EINTR || errno == EAGAIN) {
265             continue;
266          }
267          if (errno == EBUSY && timeout-- > 0) {
268             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
269             bmicrosleep(1, 0);
270             continue;
271          }
272          dev->dev_errno = errno;
273          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"), 
274                dev->dev_name, strerror(dev->dev_errno));
275          /* Stop any open timer we set */
276          if (dev->tid) {
277             stop_thread_timer(dev->tid);
278             dev->tid = 0;
279          }
280          Emsg0(M_FATAL, 0, dev->errmsg);
281          break;
282       }
283       if (dev->fd >= 0) {
284          dev->dev_errno = 0;
285          dev->state |= ST_OPENED;
286          dev->use_count = 1;
287          update_pos_dev(dev);             /* update position */
288       }
289       /* Stop any open() timer we started */
290       if (dev->tid) {
291          stop_thread_timer(dev->tid);
292          dev->tid = 0;
293       }
294       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
295    } else {
296       /*
297        * Handle opening of File Archive (not a tape)
298        */
299       if (VolName == NULL || *VolName == 0) {
300          Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
301             dev->dev_name);
302          return -1;
303       }
304       archive_name = get_pool_memory(PM_FNAME);
305       pm_strcpy(&archive_name, dev->dev_name);
306       if (archive_name[strlen(archive_name)] != '/') {
307          pm_strcat(&archive_name, "/");
308       }
309       pm_strcat(&archive_name, VolName);
310       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
311       if (mode == OPEN_READ_WRITE) {
312          dev->mode = O_CREAT | O_RDWR | O_BINARY;
313       } else if (mode == OPEN_READ_ONLY) {
314          dev->mode = O_RDONLY | O_BINARY;
315       } else if (mode == OPEN_WRITE_ONLY) {
316          dev->mode = O_WRONLY | O_BINARY;
317       } else {
318          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n")); 
319       }
320       /* If creating file, give 0640 permissions */
321       if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
322          dev->dev_errno = errno;
323          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
324          Emsg0(M_FATAL, 0, dev->errmsg);
325       } else {
326          dev->dev_errno = 0;
327          dev->state |= ST_OPENED;
328          dev->use_count = 1;
329          update_pos_dev(dev);                /* update position */
330       }
331       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
332       free_pool_memory(archive_name);
333    }
334    return dev->fd;
335 }
336
337 #ifdef debug_tracing
338 #undef rewind_dev
339 int _rewind_dev(char *file, int line, DEVICE *dev)
340 {
341    Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
342    return rewind_dev(dev);
343 }
344 #endif
345
346
347 /*
348  * Rewind the device.
349  *  Returns: 1 on success
350  *           0 on failure
351  */
352 int rewind_dev(DEVICE *dev)
353 {
354    struct mtop mt_com;
355    unsigned int i;
356
357    Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
358    if (dev->fd < 0) {
359       dev->dev_errno = EBADF;
360       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
361             dev->dev_name);
362       Emsg0(M_FATAL, 0, dev->errmsg);
363       return 0;
364    }
365    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
366    dev->block_num = dev->file = 0;
367    dev->file_addr = 0;
368    if (dev->state & ST_TAPE) {
369       mt_com.mt_op = MTREW;
370       mt_com.mt_count = 1;
371       /* If we get an I/O error on rewind, it is probably because
372        * the drive is actually busy. We loop for (about 5 minutes)
373        * retrying every 5 seconds.
374        */
375       for (i=dev->max_rewind_wait; ; i -= 5) {
376          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
377             if (i == dev->max_rewind_wait) {
378                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
379             }
380             clrerror_dev(dev, MTREW);
381             if (dev->dev_errno == EIO && i > 0) {
382                Dmsg0(200, "Sleeping 5 seconds.\n");
383                bmicrosleep(5, 0);
384                continue;
385             }
386             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
387                dev->dev_name, strerror(dev->dev_errno));
388             return 0;
389          }
390          break;
391       }
392    } else if (dev->state & ST_FILE) {
393       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
394          dev->dev_errno = errno;
395          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
396             dev->dev_name, strerror(dev->dev_errno));
397          return 0;
398       }
399    }
400    return 1;
401 }
402
403 /* 
404  * Position device to end of medium (end of data)
405  *  Returns: 1 on succes
406  *           0 on error
407  */
408 int 
409 eod_dev(DEVICE *dev)
410 {
411    struct mtop mt_com;
412    struct mtget mt_stat;
413    int stat = 0;
414    off_t pos;
415
416    Dmsg0(29, "eod_dev\n");
417    if (dev->state & ST_EOT) {
418       return 1;
419    }
420    dev->state &= ~(ST_EOF);  /* remove EOF flags */
421    dev->block_num = dev->file = 0;
422    dev->file_addr = 0;
423    if (dev->state & (ST_FIFO | ST_PROG)) {
424       return 1;
425    }
426    if (!(dev->state & ST_TAPE)) {
427       pos = lseek(dev->fd, (off_t)0, SEEK_END);
428 //    Dmsg1(100, "====== Seek to %lld\n", pos);
429       if (pos >= 0) {
430          update_pos_dev(dev);
431          dev->state |= ST_EOT;
432          return 1;
433       }
434       dev->dev_errno = errno;
435       Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
436              dev->dev_name, strerror(dev->dev_errno));
437       return 0;
438    }
439 #ifdef MTEOM
440
441    if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
442       struct mtget mt_stat;
443       Dmsg0(100,"Using FAST FSF for EOM\n");
444       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
445         if (!rewind_dev(dev)) {
446           return 0;
447         }
448       }
449       mt_com.mt_op = MTFSF;
450       /*
451        * ***FIXEM*** fix code to handle case that INT16_MAX is
452        *   not large enough.
453        */
454       mt_com.mt_count = INT16_MAX;    /* use big positive number */
455       if (mt_com.mt_count < 0) {
456          mt_com.mt_count = INT16_MAX; /* brain damaged system */
457       }
458    }
459
460    if (dev_cap(dev, CAP_EOM)) {
461       Dmsg0(100,"Using EOM for EOM\n");
462       mt_com.mt_op = MTEOM;
463       mt_com.mt_count = 1;
464    }
465    if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
466       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
467          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
468          clrerror_dev(dev, mt_com.mt_op);
469          update_pos_dev(dev);
470          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
471             dev->dev_name, strerror(dev->dev_errno));
472          return 0;
473       }
474
475       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
476          dev->dev_errno = errno;
477          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
478             dev->dev_name, strerror(dev->dev_errno));
479          return 0;
480       }
481       Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
482       dev->file = mt_stat.mt_fileno;
483
484    /*
485     * Rewind then use FSF until EOT reached
486     */
487    } else {
488 #else
489    {
490 #endif
491       if (!rewind_dev(dev)) {
492          return 0;
493       }
494       /* 
495        * Move file by file to the end of the tape
496        */
497       int file_num;
498       for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
499          Dmsg0(200, "eod_dev: doing fsf 1\n");
500          if (!fsf_dev(dev, 1)) {
501             Dmsg0(200, "fsf_dev error.\n");
502             return 0;
503          }
504          /*
505           * Avoid infinite loop. ***FIXME*** possibly add code
506           *   to set EOD or to turn off CAP_FASTFSF if on.
507           */
508          if (file_num == (int)dev->file) {
509             struct mtget mt_stat;
510             Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
511             if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && 
512                       mt_stat.mt_fileno >= 0) {
513                Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
514                dev->file = mt_stat.mt_fileno;
515             }
516             stat = 0;
517             break;                    /* we are not progressing, bail out */
518          }
519       }
520    }
521    /*
522     * Some drivers leave us after second EOF when doing
523     * MTEOM, so we must backup so that appending overwrites
524     * the second EOF.
525     */
526    if (dev_cap(dev, CAP_BSFATEOM)) {
527       struct mtget mt_stat;
528       /* Backup over EOF */
529       stat = bsf_dev(dev, 1);
530       /* If BSF worked and fileno is known (not -1), set file */
531       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
532          Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
533          dev->file = mt_stat.mt_fileno;
534       } else {
535          dev->file++;                 /* wing it -- not correct on all OSes */
536       }
537    } else {
538       update_pos_dev(dev);                   /* update position */
539       stat = 1;
540    }
541    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
542    return stat;
543 }
544
545 /*
546  * Set the position of the device -- only for files
547  *   For other devices, there is no generic way to do it.
548  *  Returns: 1 on succes
549  *           0 on error
550  */
551 int update_pos_dev(DEVICE *dev)
552 {
553    off_t pos;
554    int stat = 0;
555
556    if (dev->fd < 0) {
557       dev->dev_errno = EBADF;
558       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
559       Emsg0(M_FATAL, 0, dev->errmsg);
560       return 0;
561    }
562
563    /* Find out where we are */
564    if (dev->state & ST_FILE) {
565       dev->file = 0;
566       dev->file_addr = 0;
567       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
568       if (pos < 0) {
569          Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
570          dev->dev_errno = errno;
571          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
572             dev->dev_name, strerror(dev->dev_errno));
573       } else {
574          stat = 1;
575          dev->file_addr = pos;
576       }
577       return stat;
578    }
579    return 1;
580 }
581
582
583 /* 
584  * Return the status of the device.  This was meant
585  * to be a generic routine. Unfortunately, it doesn't
586  * seem possible (at least I do not know how to do it
587  * currently), which means that for the moment, this
588  * routine has very little value.
589  *
590  *   Returns: status
591  */
592 uint32_t status_dev(DEVICE *dev)
593 {
594    struct mtget mt_stat;
595    uint32_t stat = 0;
596
597    if (dev->state & (ST_EOT | ST_WEOT)) {
598       stat |= BMT_EOD;
599       Dmsg0(-20, " EOD");
600    }
601    if (dev->state & ST_EOF) {
602       stat |= BMT_EOF;
603       Dmsg0(-20, " EOF");
604    }
605    if (dev->state & ST_TAPE) {
606       stat |= BMT_TAPE;
607       Dmsg0(-20," Bacula status:");
608       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
609       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
610          dev->dev_errno = errno;
611          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
612             dev->dev_name, strerror(dev->dev_errno));
613          return 0;
614       }
615       Dmsg0(-20, " Device status:");
616
617 #if defined(HAVE_LINUX_OS)
618       if (GMT_EOF(mt_stat.mt_gstat)) {
619          stat |= BMT_EOF;
620          Dmsg0(-20, " EOF");
621       }
622       if (GMT_BOT(mt_stat.mt_gstat)) {
623          stat |= BMT_BOT;
624          Dmsg0(-20, " BOT");
625       }
626       if (GMT_EOT(mt_stat.mt_gstat)) {
627          stat |= BMT_EOT;
628          Dmsg0(-20, " EOT");
629       }
630       if (GMT_SM(mt_stat.mt_gstat)) {
631          stat |= BMT_SM;
632          Dmsg0(-20, " SM");
633       }
634       if (GMT_EOD(mt_stat.mt_gstat)) {
635          stat |= BMT_EOD;
636          Dmsg0(-20, " EOD");
637       }
638       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
639          stat |= BMT_WR_PROT;
640          Dmsg0(-20, " WR_PROT");
641       }
642       if (GMT_ONLINE(mt_stat.mt_gstat)) {
643          stat |= BMT_ONLINE;
644          Dmsg0(-20, " ONLINE");
645       }
646       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
647          stat |= BMT_DR_OPEN;
648          Dmsg0(-20, " DR_OPEN");       
649       }
650       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
651          stat |= BMT_IM_REP_EN;
652          Dmsg0(-20, " IM_REP_EN");
653       }
654 #endif /* !SunOS && !OSF */
655       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
656    } else {
657       stat |= BMT_ONLINE | BMT_BOT;
658    }
659    return stat;
660 }
661
662
663 /*
664  * Load medium in device
665  *  Returns: 1 on success
666  *           0 on failure
667  */
668 int load_dev(DEVICE *dev)
669 {
670 #ifdef MTLOAD
671    struct mtop mt_com;
672 #endif
673
674    if (dev->fd < 0) {
675       dev->dev_errno = EBADF;
676       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
677       Emsg0(M_FATAL, 0, dev->errmsg);
678       return 0;
679    }
680    if (!(dev->state & ST_TAPE)) {
681       return 1;
682    }
683 #ifndef MTLOAD
684    Dmsg0(200, "stored: MTLOAD command not available\n");
685    dev->dev_errno = ENOTTY;           /* function not available */
686    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
687          dev->dev_name, strerror(dev->dev_errno));      return 0;
688    return 0;
689 #else
690
691    dev->block_num = dev->file = 0;
692    dev->file_addr = 0;
693    mt_com.mt_op = MTLOAD;
694    mt_com.mt_count = 1;
695    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
696       dev->dev_errno = errno;
697       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
698          dev->dev_name, strerror(dev->dev_errno));      return 0;
699    }
700    return 1;
701 #endif
702 }
703
704 /*
705  * Rewind device and put it offline
706  *  Returns: 1 on success
707  *           0 on failure
708  */
709 int offline_dev(DEVICE *dev)
710 {
711    struct mtop mt_com;
712
713    if (dev->fd < 0) {
714       dev->dev_errno = EBADF;
715       Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
716       Emsg0(M_FATAL, 0, dev->errmsg);
717       return 0;
718    }
719    if (!(dev->state & ST_TAPE)) {
720       return 1;
721    }
722
723    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
724    dev->block_num = dev->file = 0;
725    dev->file_addr = 0;
726 #ifdef MTUNLOCK
727    mt_com.mt_op = MTUNLOCK;
728    mt_com.mt_count = 1;
729    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
730 #endif
731    mt_com.mt_op = MTOFFL;
732    mt_com.mt_count = 1;
733    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
734       dev->dev_errno = errno;
735       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
736          dev->dev_name, strerror(dev->dev_errno));
737       return 0;
738    }
739    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
740    return 1;
741 }
742
743 int offline_or_rewind_dev(DEVICE *dev)
744 {
745    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
746       return offline_dev(dev);
747    } else {
748    /*            
749     * Note, this rewind probably should not be here (it wasn't
750     *  in prior versions of Bacula), but on FreeBSD, this is
751     *  needed in the case the tape was "frozen" due to an error
752     *  such as backspacing after writing and EOF. If it is not
753     *  done, all future references to the drive get and I/O error.
754     */
755       return rewind_dev(dev);
756    }
757 }
758
759 /* 
760  * Foward space a file  
761  *   Returns: 1 on success
762  *            0 on failure
763  */
764 int
765 fsf_dev(DEVICE *dev, int num)
766
767    struct mtget mt_stat;
768    struct mtop mt_com;
769    int stat = 0;
770
771    if (dev->fd < 0) {
772       dev->dev_errno = EBADF;
773       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
774       Emsg0(M_FATAL, 0, dev->errmsg);
775       return 0;
776    }
777
778    if (!(dev->state & ST_TAPE)) {
779       return 1;
780    }
781    if (dev->state & ST_EOT) {
782       dev->dev_errno = 0;
783       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
784       return 0;
785    }
786    if (dev->state & ST_EOF) {
787       Dmsg0(200, "ST_EOF set on entry to FSF\n");
788    }
789       
790    Dmsg0(29, "fsf_dev\n");
791    dev->block_num = 0;
792    /*
793     * If Fast forward space file is set, then we
794     *  use MTFSF to forward space and MTIOCGET
795     *  to get the file position. We assume that 
796     *  the SCSI driver will ensure that we do not
797     *  forward space over the end of data mark.
798     */
799    if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
800       mt_com.mt_op = MTFSF;
801       mt_com.mt_count = num;
802       stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
803       if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
804          dev->state |= ST_EOT;
805          Dmsg0(200, "Set ST_EOT\n");
806          clrerror_dev(dev, MTFSF);
807          Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
808             dev->dev_name, strerror(dev->dev_errno));
809          Dmsg1(200, "%s", dev->errmsg);
810          return 0;
811       }
812       Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
813       dev->file = mt_stat.mt_fileno;
814       dev->state |= ST_EOF;     /* just read EOF */
815       dev->file_addr = 0;
816       return 1;
817
818    /* 
819     * Here if CAP_FSF is set, and virtually all drives
820     *  these days support it, we read a record, then forward
821     *  space one file. Using this procedure, which is slow,
822     *  is the only way we can be sure that we don't read
823     *  two consecutive EOF marks, which means End of Data.
824     */
825    } else if (dev_cap(dev, CAP_FSF)) {
826       POOLMEM *rbuf;
827       int rbuf_len;
828       Dmsg0(200, "FSF has cap_fsf\n");
829       if (dev->max_block_size == 0) {
830          rbuf_len = DEFAULT_BLOCK_SIZE;
831       } else {
832          rbuf_len = dev->max_block_size;
833       }
834       rbuf = get_memory(rbuf_len);
835       mt_com.mt_op = MTFSF;
836       mt_com.mt_count = 1;
837       while (num-- && !(dev->state & ST_EOT)) {
838          Dmsg0(200, "Doing read before fsf\n");
839          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
840             if (errno == ENOMEM) {     /* tape record exceeds buf len */
841                stat = rbuf_len;        /* This is OK */
842             } else {
843                dev->state |= ST_EOT;
844                clrerror_dev(dev, -1);
845                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
846                   strerror(dev->dev_errno));
847                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
848                   dev->dev_name, strerror(dev->dev_errno));
849                Dmsg1(200, "%s", dev->errmsg);
850                break;
851             }
852          }
853          if (stat == 0) {                /* EOF */
854             update_pos_dev(dev);
855             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
856             /* Two reads of zero means end of tape */
857             if (dev->state & ST_EOF) {
858                dev->state |= ST_EOT;
859                Dmsg0(200, "Set ST_EOT\n");
860                break;
861             } else {
862                dev->state |= ST_EOF;
863                dev->file++;
864                dev->file_addr = 0;
865                continue;
866             }
867          } else {                        /* Got data */
868             dev->state &= ~(ST_EOF|ST_EOT);
869          }
870
871          Dmsg0(200, "Doing MTFSF\n");
872          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
873          if (stat < 0) {                 /* error => EOT */
874             dev->state |= ST_EOT;
875             Dmsg0(200, "Set ST_EOT\n");
876             clrerror_dev(dev, MTFSF);
877             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
878                dev->dev_name, strerror(dev->dev_errno));
879             Dmsg0(200, "Got < 0 for MTFSF\n");
880             Dmsg1(200, "%s", dev->errmsg);
881          } else {
882             dev->state |= ST_EOF;     /* just read EOF */
883             dev->file++;
884             dev->file_addr = 0;
885          }   
886       }
887       free_memory(rbuf);
888    
889    /*
890     * No FSF, so use FSR to simulate it
891     */
892    } else {
893       Dmsg0(200, "Doing FSR for FSF\n");
894       while (num-- && !(dev->state & ST_EOT)) {
895          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
896       }
897       if (dev->state & ST_EOT) {
898          dev->dev_errno = 0;
899          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
900          stat = -1;
901       } else {
902          stat = 0;
903       }
904    }
905    update_pos_dev(dev);
906    Dmsg1(200, "Return %d from FSF\n", stat);
907    if (dev->state & ST_EOF)
908       Dmsg0(200, "ST_EOF set on exit FSF\n");
909    if (dev->state & ST_EOT)
910       Dmsg0(200, "ST_EOT set on exit FSF\n");
911    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
912    return stat == 0 ? 1 : 0;
913 }
914
915 /* 
916  * Backward space a file  
917  *  Returns: 0 on failure
918  *           1 on success
919  */
920 int
921 bsf_dev(DEVICE *dev, int num)
922
923    struct mtop mt_com;
924    int stat;
925
926    if (dev->fd < 0) {
927       dev->dev_errno = EBADF;
928       Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
929       Emsg0(M_FATAL, 0, dev->errmsg);
930       return 0;
931    }
932
933    if (!(dev_state(dev, ST_TAPE))) {
934       Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
935          dev->dev_name);
936       return 0;
937    }
938    Dmsg0(29, "bsf_dev\n");
939    dev->state &= ~(ST_EOT|ST_EOF);
940    dev->file -= num;
941    dev->file_addr = 0;
942    mt_com.mt_op = MTBSF;
943    mt_com.mt_count = num;
944    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
945    if (stat < 0) {
946       clrerror_dev(dev, MTBSF);
947       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
948          dev->dev_name, strerror(dev->dev_errno));
949    }
950    update_pos_dev(dev);
951    return stat == 0 ? 1 : 0;
952 }
953
954
955 /* 
956  * Foward space a record
957  *  Returns: 0 on failure
958  *           1 on success
959  */
960 int
961 fsr_dev(DEVICE *dev, int num)
962
963    struct mtop mt_com;
964    int stat;
965
966    if (dev->fd < 0) {
967       dev->dev_errno = EBADF;
968       Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
969       Emsg0(M_FATAL, 0, dev->errmsg);
970       return 0;
971    }
972
973    if (!(dev_state(dev, ST_TAPE))) {
974       return 0;
975    }
976    Dmsg0(29, "fsr_dev\n");
977    mt_com.mt_op = MTFSR;
978    mt_com.mt_count = num;
979    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
980    if (stat == 0) {
981       dev->state &= ~ST_EOF;
982       dev->block_num += num;
983    } else {
984       struct mtget mt_stat;
985       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
986          Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file, 
987             dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
988          dev->file = mt_stat.mt_fileno;
989          dev->block_num = mt_stat.mt_blkno;
990       } else {
991          if (dev->state & ST_EOF) {
992             dev->state |= ST_EOT;
993          } else {
994             dev->state |= ST_EOF;           /* assume EOF */
995             dev->file++;
996             dev->block_num = 0;
997             dev->file_addr = 0;
998          }
999       }
1000       clrerror_dev(dev, MTFSR);
1001       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1002          dev->dev_name, strerror(dev->dev_errno));
1003    }
1004    update_pos_dev(dev);
1005    return stat == 0 ? 1 : 0;
1006 }
1007
1008 /* 
1009  * Backward space a record
1010  *   Returns:  0 on failure
1011  *             1 on success
1012  */
1013 int
1014 bsr_dev(DEVICE *dev, int num)
1015
1016    struct mtop mt_com;
1017    int stat;
1018
1019    if (dev->fd < 0) {
1020       dev->dev_errno = EBADF;
1021       Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1022       Emsg0(M_FATAL, 0, dev->errmsg);
1023       return 0;
1024    }
1025
1026    if (!(dev->state & ST_TAPE)) {
1027       return 0;
1028    }
1029
1030    if (!dev_cap(dev, CAP_BSR)) {
1031       Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
1032          dev->dev_name);
1033       return 0;
1034    }
1035
1036    Dmsg0(29, "bsr_dev\n");
1037    dev->block_num -= num;
1038    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1039    mt_com.mt_op = MTBSR;
1040    mt_com.mt_count = num;
1041    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1042    if (stat < 0) {
1043       clrerror_dev(dev, MTBSR);
1044       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1045          dev->dev_name, strerror(dev->dev_errno));
1046    }
1047    update_pos_dev(dev);
1048    return stat == 0 ? 1 : 0;
1049 }
1050
1051 /* 
1052  * Reposition the device to file, block
1053  * Returns: 0 on failure
1054  *          1 on success
1055  */
1056 int
1057 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1058
1059    if (dev->fd < 0) {
1060       dev->dev_errno = EBADF;
1061       Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1062       Emsg0(M_FATAL, 0, dev->errmsg);
1063       return 0;
1064    }
1065
1066    if (!(dev_state(dev, ST_TAPE))) {
1067       off_t pos = (((off_t)file)<<32) + block;
1068       Dmsg1(100, "===== lseek to %d\n", (int)pos);
1069       if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1070          dev->dev_errno = errno;
1071          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1072             dev->dev_name, strerror(dev->dev_errno));
1073          return 0;
1074       }
1075       dev->file = file;
1076       dev->block_num = block;
1077       dev->file_addr = pos;
1078       return 1;
1079    }
1080    Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n", 
1081       dev->file, dev->block_num, file, block);
1082    if (file < dev->file) {
1083       Dmsg0(100, "Rewind_dev\n");
1084       if (!rewind_dev(dev)) {
1085          return 0;
1086       }
1087    }
1088    if (file > dev->file) {
1089       Dmsg1(100, "fsf %d\n", file-dev->file);
1090       if (!fsf_dev(dev, file-dev->file)) {
1091          return 0;
1092       }
1093    }
1094    if (block < dev->block_num) {
1095       bsf_dev(dev, 1);
1096       fsf_dev(dev, 1);
1097    }
1098    if (block > dev->block_num) {
1099       /* Ignore errors as Bacula can read to the correct block */
1100       Dmsg1(100, "fsr %d\n", block-dev->block_num);
1101       fsr_dev(dev, block-dev->block_num);
1102    }
1103    return 1;
1104 }
1105
1106
1107
1108 /*
1109  * Write an end of file on the device
1110  *   Returns: 0 on success
1111  *            non-zero on failure
1112  */
1113 int 
1114 weof_dev(DEVICE *dev, int num)
1115
1116    struct mtop mt_com;
1117    int stat;
1118
1119    if (dev->fd < 0) {
1120       dev->dev_errno = EBADF;
1121       Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1122       Emsg0(M_FATAL, 0, dev->errmsg);
1123       return -1;
1124    }
1125
1126    if (!(dev_state(dev, ST_TAPE))) {
1127       return 0;
1128    }
1129    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
1130    dev->block_num = 0;
1131    Dmsg0(29, "weof_dev\n");
1132    mt_com.mt_op = MTWEOF;
1133    mt_com.mt_count = num;
1134    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1135    if (stat == 0) {
1136       dev->file += num;
1137       dev->file_addr = 0;
1138    } else {
1139       clrerror_dev(dev, MTWEOF);
1140       if (stat == -1) {
1141          Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1142             dev->dev_name, strerror(dev->dev_errno));
1143        }
1144    }
1145    return stat;
1146 }
1147
1148 /*
1149  * Return string message with last error in English
1150  *  Be careful not to call this routine from within dev.c
1151  *  while editing an Mmsg(&) or you will end up in a recursive
1152  *  loop creating a Segmentation Violation.
1153  */
1154 char *
1155 strerror_dev(DEVICE *dev)
1156 {
1157    return dev->errmsg;
1158 }
1159
1160
1161 /*
1162  * If implemented in system, clear the tape
1163  * error status.
1164  */
1165 void
1166 clrerror_dev(DEVICE *dev, int func)
1167 {
1168    const char *msg = NULL;
1169
1170    dev->dev_errno = errno;         /* save errno */
1171    if (errno == EIO) {
1172       dev->VolCatInfo.VolCatErrors++;
1173    }
1174
1175    if (!(dev->state & ST_TAPE)) {
1176       return;
1177    }
1178    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1179       switch (func) {
1180       case -1:
1181          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1182          break;
1183       case MTWEOF:
1184          msg = "WTWEOF";
1185          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1186          break;
1187 #ifdef MTEOM
1188       case MTEOM:
1189          msg = "WTEOM";
1190          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1191          break;
1192 #endif 
1193       case MTFSF:
1194          msg = "MTFSF";
1195          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1196          break;
1197       case MTBSF:
1198          msg = "MTBSF";
1199          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1200          break;
1201       case MTFSR:
1202          msg = "MTFSR";
1203          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1204          break;
1205       case MTBSR:
1206          msg = "MTBSR";
1207          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1208          break;
1209       default:
1210          msg = "Unknown";
1211          break;
1212       }
1213       if (msg != NULL) {
1214          dev->dev_errno = ENOSYS;
1215          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1216          Emsg0(M_ERROR, 0, dev->errmsg);
1217       }
1218    }
1219 /* Found on Linux */
1220 #ifdef MTIOCLRERR
1221 {
1222    struct mtop mt_com;
1223    mt_com.mt_op = MTIOCLRERR;
1224    mt_com.mt_count = 1;
1225    /* Clear any error condition on the tape */
1226    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1227    Dmsg0(200, "Did MTIOCLRERR\n");
1228 }
1229 #endif
1230
1231 /* Typically on FreeBSD */
1232 #ifdef MTIOCERRSTAT
1233 {
1234    /* Read and clear SCSI error status */
1235    union mterrstat mt_errstat;
1236    Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1237       strerror(dev->dev_errno));
1238    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1239 }
1240 #endif
1241 }
1242
1243 /*
1244  * Flush buffer contents
1245  *  No longer used.
1246  */
1247 int flush_dev(DEVICE *dev)
1248 {
1249    return 1;
1250 }
1251
1252 static void do_close(DEVICE *dev)
1253 {
1254
1255    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1256    if (dev->fd >= 0) {
1257       close(dev->fd);
1258    }
1259    /* Clean up device packet so it can be reused */
1260    dev->fd = -1;
1261    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1262    dev->file = dev->block_num = 0;
1263    dev->file_addr = 0;
1264    dev->EndFile = dev->EndBlock = 0;
1265    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1266    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1267    if (dev->tid) {
1268       stop_thread_timer(dev->tid);
1269       dev->tid = 0;
1270    }
1271    dev->use_count = 0;
1272 }
1273
1274 /* 
1275  * Close the device
1276  */
1277 void
1278 close_dev(DEVICE *dev)
1279 {
1280    if (!dev) {
1281       Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1282       Emsg0(M_FATAL, 0, dev->errmsg);
1283       return;
1284    }
1285    if (dev->fd >= 0 && dev->use_count == 1) {
1286       do_close(dev);
1287    } else if (dev->use_count > 0) {
1288       dev->use_count--;
1289    }
1290            
1291 #ifdef FULL_DEBUG
1292    ASSERT(dev->use_count >= 0);
1293 #endif
1294 }
1295
1296 /*
1297  * Used when unmounting the device, ignore use_count
1298  */
1299 void force_close_dev(DEVICE *dev)
1300 {
1301    if (!dev) {
1302       Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1303       Emsg0(M_FATAL, 0, dev->errmsg);
1304       return;
1305    }
1306    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1307    do_close(dev);
1308
1309 #ifdef FULL_DEBUG
1310    ASSERT(dev->use_count >= 0);
1311 #endif
1312 }
1313
1314 int truncate_dev(DEVICE *dev)
1315 {
1316    if (dev->state & ST_TAPE) {
1317       return 1;
1318    }
1319    if (ftruncate(dev->fd, 0) != 0) {
1320       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1321       return 0;
1322    }
1323    return 1;
1324 }
1325
1326 int 
1327 dev_is_tape(DEVICE *dev)
1328 {  
1329    return (dev->state & ST_TAPE) ? 1 : 0;
1330 }
1331
1332
1333 /*
1334  * return 1 if the device is read for write, and 0 otherwise
1335  *   This is meant for checking at the end of a job to see
1336  *   if we still have a tape (perhaps not if at end of tape
1337  *   and the job is canceled).
1338  */
1339 int
1340 dev_can_write(DEVICE *dev)
1341 {
1342    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1343        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1344       return 1;
1345    } else {
1346       return 0;
1347    }
1348 }
1349
1350 char *
1351 dev_name(DEVICE *dev)
1352 {
1353    return dev->dev_name;
1354 }
1355
1356 char *
1357 dev_vol_name(DEVICE *dev)
1358 {
1359    return dev->VolCatInfo.VolCatName;
1360 }
1361
1362 uint32_t dev_block(DEVICE *dev)
1363 {
1364    update_pos_dev(dev);
1365    return dev->block_num;
1366 }
1367
1368 uint32_t dev_file(DEVICE *dev)
1369 {
1370    update_pos_dev(dev);
1371    return dev->file;
1372 }
1373
1374 /* 
1375  * Free memory allocated for the device
1376  */
1377 void
1378 term_dev(DEVICE *dev)
1379 {
1380    if (!dev) {
1381       dev->dev_errno = EBADF;
1382       Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1383       Emsg0(M_FATAL, 0, dev->errmsg);
1384       return;
1385    }
1386    do_close(dev);
1387    Dmsg0(29, "term_dev\n");
1388    if (dev->dev_name) {
1389       free_memory(dev->dev_name);
1390       dev->dev_name = NULL;
1391    }
1392    if (dev->errmsg) {
1393       free_pool_memory(dev->errmsg);
1394       dev->errmsg = NULL;
1395    }
1396    pthread_mutex_destroy(&dev->mutex);
1397    pthread_cond_destroy(&dev->wait);
1398    pthread_cond_destroy(&dev->wait_next_vol);
1399    pthread_mutex_destroy(&dev->spool_mutex);
1400    if (dev->attached_dcrs) {
1401       delete dev->attached_dcrs;
1402       dev->attached_dcrs = NULL;
1403    }
1404    if (dev->state & ST_MALLOC) {
1405       free_pool_memory((POOLMEM *)dev);
1406    }
1407 }
1408
1409 /*
1410  * We attach a jcr to the device so that when
1411  *   the Volume is full during writing, a  
1412  *   JobMedia record will be created for this 
1413  *   Job.
1414  */
1415 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1416 {
1417    jcr->prev_dev = (JCR *)NULL;
1418    jcr->next_dev = dev->attached_jcrs;
1419    if (dev->attached_jcrs) {
1420       dev->attached_jcrs->prev_dev = jcr;
1421    }
1422    dev->attached_jcrs = jcr;
1423    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1424 }
1425
1426 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1427 {
1428    if (!jcr->prev_dev) {
1429       dev->attached_jcrs = jcr->next_dev;
1430    } else {
1431       jcr->prev_dev->next_dev = jcr->next_dev;
1432    }
1433    if (jcr->next_dev) {
1434       jcr->next_dev->prev_dev = jcr->prev_dev; 
1435    }
1436    jcr->next_dev = jcr->prev_dev = NULL;
1437    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1438 }
1439
1440 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1441 {
1442    if (jcr == (JCR *)NULL) {
1443       return dev->attached_jcrs;
1444    }
1445    return jcr->next_dev;
1446 }
1447
1448 /*
1449  * This routine initializes the device wait timers
1450  */
1451 void init_dev_wait_timers(DEVICE *dev)
1452 {
1453    /* ******FIXME******* put these on config variables */
1454    dev->min_wait = 60 * 60;
1455    dev->max_wait = 24 * 60 * 60;
1456    dev->max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
1457    dev->wait_sec = dev->min_wait;
1458    dev->rem_wait_sec = dev->wait_sec;
1459    dev->num_wait = 0;
1460    dev->poll = false;
1461    dev->BadVolName[0] = 0;
1462 }
1463
1464 /*
1465  * Returns: true if time doubled
1466  *          false if max time expired
1467  */
1468 bool double_dev_wait_time(DEVICE *dev)
1469 {
1470    dev->wait_sec *= 2;               /* double wait time */
1471    if (dev->wait_sec > dev->max_wait) {   /* but not longer than maxtime */
1472       dev->wait_sec = dev->max_wait;
1473    }
1474    dev->num_wait++;
1475    dev->rem_wait_sec = dev->wait_sec;
1476    if (dev->num_wait >= dev->max_num_wait) {
1477       return false;
1478    }
1479    return true;
1480 }