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