]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/dev.c
c0d85f23b27d9294599997a70bda27948994b6d2
[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(100,"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       /*
443        * ***FIXEM*** fix code to handle case that INT16_MAX is
444        *   not large enough.
445        */
446       mt_com.mt_count = INT16_MAX;    /* use big positive number */
447       if (mt_com.mt_count < 0) {
448          mt_com.mt_count = INT16_MAX; /* brain damaged system */
449       }
450    }
451
452    if (dev_cap(dev, CAP_EOM)) {
453       Dmsg0(100,"Using EOM for EOM\n");
454       mt_com.mt_op = MTEOM;
455       mt_com.mt_count = 1;
456    }
457    if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
458       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
459          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
460          clrerror_dev(dev, mt_com.mt_op);
461          update_pos_dev(dev);
462          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
463             dev->dev_name, strerror(dev->dev_errno));
464          return 0;
465       }
466
467       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
468          dev->dev_errno = errno;
469          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
470             dev->dev_name, strerror(dev->dev_errno));
471          return 0;
472       }
473       Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
474       dev->file = mt_stat.mt_fileno;
475
476    /*
477     * Rewind then use FSF until EOT reached
478     */
479    } else {
480 #else
481    {
482 #endif
483       if (!rewind_dev(dev)) {
484          return 0;
485       }
486       /* 
487        * Move file by file to the end of the tape
488        */
489       int file_num;
490       for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
491          Dmsg0(200, "eod_dev: doing fsf 1\n");
492          if (!fsf_dev(dev, 1)) {
493             Dmsg0(200, "fsf_dev error.\n");
494             return 0;
495          }
496          /*
497           * Avoid infinite loop. ***FIXME*** possibly add code
498           *   to set EOD or to turn off CAP_FASTFSF if on.
499           */
500          if (file_num == (int)dev->file) {
501             struct mtget mt_stat;
502             Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
503             if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && 
504                       mt_stat.mt_fileno >= 0) {
505                Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
506                dev->file = mt_stat.mt_fileno;
507             }
508             stat = 0;
509             break;                    /* we are not progressing, bail out */
510          }
511       }
512    }
513    /*
514     * Some drivers leave us after second EOF when doing
515     * MTEOM, so we must backup so that appending overwrites
516     * the second EOF.
517     */
518    if (dev_cap(dev, CAP_BSFATEOM)) {
519       struct mtget mt_stat;
520       /* Backup over EOF */
521       stat = bsf_dev(dev, 1);
522       /* If BSF worked and fileno is known (not -1), set file */
523       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
524          Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
525          dev->file = mt_stat.mt_fileno;
526       } else {
527          dev->file++;                 /* wing it -- not correct on all OSes */
528       }
529    } else {
530       update_pos_dev(dev);                   /* update position */
531       stat = 1;
532    }
533    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
534    return stat;
535 }
536
537 /*
538  * Set the position of the device -- only for files
539  *   For other devices, there is no generic way to do it.
540  *  Returns: 1 on succes
541  *           0 on error
542  */
543 int update_pos_dev(DEVICE *dev)
544 {
545    off_t pos;
546    int stat = 0;
547
548    if (dev->fd < 0) {
549       dev->dev_errno = EBADF;
550       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
551       Emsg0(M_FATAL, 0, dev->errmsg);
552       return 0;
553    }
554
555    /* Find out where we are */
556    if (dev->state & ST_FILE) {
557       dev->file = 0;
558       dev->file_addr = 0;
559       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
560       if (pos < 0) {
561          Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
562          dev->dev_errno = errno;
563          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
564             dev->dev_name, strerror(dev->dev_errno));
565       } else {
566          stat = 1;
567          dev->file_addr = pos;
568       }
569       return stat;
570    }
571    return 1;
572 }
573
574
575 /* 
576  * Return the status of the device.  This was meant
577  * to be a generic routine. Unfortunately, it doesn't
578  * seem possible (at least I do not know how to do it
579  * currently), which means that for the moment, this
580  * routine has very little value.
581  *
582  *   Returns: status
583  */
584 uint32_t status_dev(DEVICE *dev)
585 {
586    struct mtget mt_stat;
587    uint32_t stat = 0;
588
589    if (dev->state & (ST_EOT | ST_WEOT)) {
590       stat |= BMT_EOD;
591       Dmsg0(-20, " EOD");
592    }
593    if (dev->state & ST_EOF) {
594       stat |= BMT_EOF;
595       Dmsg0(-20, " EOF");
596    }
597    if (dev->state & ST_TAPE) {
598       stat |= BMT_TAPE;
599       Dmsg0(-20," Bacula status:");
600       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
601       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
602          dev->dev_errno = errno;
603          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
604             dev->dev_name, strerror(dev->dev_errno));
605          return 0;
606       }
607       Dmsg0(-20, " Device status:");
608
609 #if defined(HAVE_LINUX_OS)
610       if (GMT_EOF(mt_stat.mt_gstat)) {
611          stat |= BMT_EOF;
612          Dmsg0(-20, " EOF");
613       }
614       if (GMT_BOT(mt_stat.mt_gstat)) {
615          stat |= BMT_BOT;
616          Dmsg0(-20, " BOT");
617       }
618       if (GMT_EOT(mt_stat.mt_gstat)) {
619          stat |= BMT_EOT;
620          Dmsg0(-20, " EOT");
621       }
622       if (GMT_SM(mt_stat.mt_gstat)) {
623          stat |= BMT_SM;
624          Dmsg0(-20, " SM");
625       }
626       if (GMT_EOD(mt_stat.mt_gstat)) {
627          stat |= BMT_EOD;
628          Dmsg0(-20, " EOD");
629       }
630       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
631          stat |= BMT_WR_PROT;
632          Dmsg0(-20, " WR_PROT");
633       }
634       if (GMT_ONLINE(mt_stat.mt_gstat)) {
635          stat |= BMT_ONLINE;
636          Dmsg0(-20, " ONLINE");
637       }
638       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
639          stat |= BMT_DR_OPEN;
640          Dmsg0(-20, " DR_OPEN");       
641       }
642       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
643          stat |= BMT_IM_REP_EN;
644          Dmsg0(-20, " IM_REP_EN");
645       }
646 #endif /* !SunOS && !OSF */
647       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
648    } else {
649       stat |= BMT_ONLINE | BMT_BOT;
650    }
651    return stat;
652 }
653
654
655 /*
656  * Load medium in device
657  *  Returns: 1 on success
658  *           0 on failure
659  */
660 int load_dev(DEVICE *dev)
661 {
662 #ifdef MTLOAD
663    struct mtop mt_com;
664 #endif
665
666    if (dev->fd < 0) {
667       dev->dev_errno = EBADF;
668       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
669       Emsg0(M_FATAL, 0, dev->errmsg);
670       return 0;
671    }
672    if (!(dev->state & ST_TAPE)) {
673       return 1;
674    }
675 #ifndef MTLOAD
676    Dmsg0(200, "stored: MTLOAD command not available\n");
677    dev->dev_errno = ENOTTY;           /* function not available */
678    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
679          dev->dev_name, strerror(dev->dev_errno));      return 0;
680    return 0;
681 #else
682
683    dev->block_num = dev->file = 0;
684    dev->file_addr = 0;
685    mt_com.mt_op = MTLOAD;
686    mt_com.mt_count = 1;
687    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
688       dev->dev_errno = errno;
689       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
690          dev->dev_name, strerror(dev->dev_errno));      return 0;
691    }
692    return 1;
693 #endif
694 }
695
696 /*
697  * Rewind device and put it offline
698  *  Returns: 1 on success
699  *           0 on failure
700  */
701 int offline_dev(DEVICE *dev)
702 {
703    struct mtop mt_com;
704
705    if (dev->fd < 0) {
706       dev->dev_errno = EBADF;
707       Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
708       Emsg0(M_FATAL, 0, dev->errmsg);
709       return 0;
710    }
711    if (!(dev->state & ST_TAPE)) {
712       return 1;
713    }
714
715    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
716    dev->block_num = dev->file = 0;
717    dev->file_addr = 0;
718 #ifdef MTUNLOCK
719    mt_com.mt_op = MTUNLOCK;
720    mt_com.mt_count = 1;
721    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
722 #endif
723    mt_com.mt_op = MTOFFL;
724    mt_com.mt_count = 1;
725    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
726       dev->dev_errno = errno;
727       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
728          dev->dev_name, strerror(dev->dev_errno));
729       return 0;
730    }
731    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
732    return 1;
733 }
734
735 int offline_or_rewind_dev(DEVICE *dev)
736 {
737    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
738       return offline_dev(dev);
739    } else {
740    /*            
741     * Note, this rewind probably should not be here (it wasn't
742     *  in prior versions of Bacula), but on FreeBSD, this is
743     *  needed in the case the tape was "frozen" due to an error
744     *  such as backspacing after writing and EOF. If it is not
745     *  done, all future references to the drive get and I/O error.
746     */
747       return rewind_dev(dev);
748    }
749 }
750
751 /* 
752  * Foward space a file  
753  *   Returns: 1 on success
754  *            0 on failure
755  */
756 int
757 fsf_dev(DEVICE *dev, int num)
758
759    struct mtget mt_stat;
760    struct mtop mt_com;
761    int stat = 0;
762
763    if (dev->fd < 0) {
764       dev->dev_errno = EBADF;
765       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
766       Emsg0(M_FATAL, 0, dev->errmsg);
767       return 0;
768    }
769
770    if (!(dev->state & ST_TAPE)) {
771       return 1;
772    }
773    if (dev->state & ST_EOT) {
774       dev->dev_errno = 0;
775       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
776       return 0;
777    }
778    if (dev->state & ST_EOF) {
779       Dmsg0(200, "ST_EOF set on entry to FSF\n");
780    }
781       
782    Dmsg0(29, "fsf_dev\n");
783    dev->block_num = 0;
784    /*
785     * If Fast forward space file is set, then we
786     *  use MTFSF to forward space and MTIOCGET
787     *  to get the file position. We assume that 
788     *  the SCSI driver will ensure that we do not
789     *  forward space over the end of data mark.
790     */
791    if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
792       mt_com.mt_op = MTFSF;
793       mt_com.mt_count = num;
794       stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
795       if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
796          dev->state |= ST_EOT;
797          Dmsg0(200, "Set ST_EOT\n");
798          clrerror_dev(dev, MTFSF);
799          Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
800             dev->dev_name, strerror(dev->dev_errno));
801          Dmsg1(200, "%s", dev->errmsg);
802          return 0;
803       }
804       Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
805       dev->file = mt_stat.mt_fileno;
806       dev->state |= ST_EOF;     /* just read EOF */
807       dev->file_addr = 0;
808       return 1;
809
810    /* 
811     * Here if CAP_FSF is set, and virtually all drives
812     *  these days support it, we read a record, then forward
813     *  space one file. Using this procedure, which is slow,
814     *  is the only way we can be sure that we don't read
815     *  two consecutive EOF marks, which means End of Data.
816     */
817    } else if (dev_cap(dev, CAP_FSF)) {
818       POOLMEM *rbuf;
819       int rbuf_len;
820       Dmsg0(200, "FSF has cap_fsf\n");
821       if (dev->max_block_size == 0) {
822          rbuf_len = DEFAULT_BLOCK_SIZE;
823       } else {
824          rbuf_len = dev->max_block_size;
825       }
826       rbuf = get_memory(rbuf_len);
827       mt_com.mt_op = MTFSF;
828       mt_com.mt_count = 1;
829       while (num-- && !(dev->state & ST_EOT)) {
830          Dmsg0(200, "Doing read before fsf\n");
831          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
832             if (errno == ENOMEM) {     /* tape record exceeds buf len */
833                stat = rbuf_len;        /* This is OK */
834             } else {
835                dev->state |= ST_EOT;
836                clrerror_dev(dev, -1);
837                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
838                   strerror(dev->dev_errno));
839                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
840                   dev->dev_name, strerror(dev->dev_errno));
841                Dmsg1(200, "%s", dev->errmsg);
842                break;
843             }
844          }
845          if (stat == 0) {                /* EOF */
846             update_pos_dev(dev);
847             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
848             /* Two reads of zero means end of tape */
849             if (dev->state & ST_EOF) {
850                dev->state |= ST_EOT;
851                Dmsg0(200, "Set ST_EOT\n");
852                break;
853             } else {
854                dev->state |= ST_EOF;
855                dev->file++;
856                dev->file_addr = 0;
857                continue;
858             }
859          } else {                        /* Got data */
860             dev->state &= ~(ST_EOF|ST_EOT);
861          }
862
863          Dmsg0(200, "Doing MTFSF\n");
864          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
865          if (stat < 0) {                 /* error => EOT */
866             dev->state |= ST_EOT;
867             Dmsg0(200, "Set ST_EOT\n");
868             clrerror_dev(dev, MTFSF);
869             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
870                dev->dev_name, strerror(dev->dev_errno));
871             Dmsg0(200, "Got < 0 for MTFSF\n");
872             Dmsg1(200, "%s", dev->errmsg);
873          } else {
874             dev->state |= ST_EOF;     /* just read EOF */
875             dev->file++;
876             dev->file_addr = 0;
877          }   
878       }
879       free_memory(rbuf);
880    
881    /*
882     * No FSF, so use FSR to simulate it
883     */
884    } else {
885       Dmsg0(200, "Doing FSR for FSF\n");
886       while (num-- && !(dev->state & ST_EOT)) {
887          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
888       }
889       if (dev->state & ST_EOT) {
890          dev->dev_errno = 0;
891          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
892          stat = -1;
893       } else {
894          stat = 0;
895       }
896    }
897    update_pos_dev(dev);
898    Dmsg1(200, "Return %d from FSF\n", stat);
899    if (dev->state & ST_EOF)
900       Dmsg0(200, "ST_EOF set on exit FSF\n");
901    if (dev->state & ST_EOT)
902       Dmsg0(200, "ST_EOT set on exit FSF\n");
903    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
904    return stat == 0 ? 1 : 0;
905 }
906
907 /* 
908  * Backward space a file  
909  *  Returns: 0 on failure
910  *           1 on success
911  */
912 int
913 bsf_dev(DEVICE *dev, int num)
914
915    struct mtop mt_com;
916    int stat;
917
918    if (dev->fd < 0) {
919       dev->dev_errno = EBADF;
920       Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
921       Emsg0(M_FATAL, 0, dev->errmsg);
922       return 0;
923    }
924
925    if (!(dev_state(dev, ST_TAPE))) {
926       Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
927          dev->dev_name);
928       return 0;
929    }
930    Dmsg0(29, "bsf_dev\n");
931    dev->state &= ~(ST_EOT|ST_EOF);
932    dev->file -= num;
933    dev->file_addr = 0;
934    mt_com.mt_op = MTBSF;
935    mt_com.mt_count = num;
936    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
937    if (stat < 0) {
938       clrerror_dev(dev, MTBSF);
939       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
940          dev->dev_name, strerror(dev->dev_errno));
941    }
942    update_pos_dev(dev);
943    return stat == 0 ? 1 : 0;
944 }
945
946
947 /* 
948  * Foward space a record
949  *  Returns: 0 on failure
950  *           1 on success
951  */
952 int
953 fsr_dev(DEVICE *dev, int num)
954
955    struct mtop mt_com;
956    int stat;
957
958    if (dev->fd < 0) {
959       dev->dev_errno = EBADF;
960       Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
961       Emsg0(M_FATAL, 0, dev->errmsg);
962       return 0;
963    }
964
965    if (!(dev_state(dev, ST_TAPE))) {
966       return 0;
967    }
968    Dmsg0(29, "fsr_dev\n");
969    mt_com.mt_op = MTFSR;
970    mt_com.mt_count = num;
971    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
972    if (stat == 0) {
973       dev->state &= ~ST_EOF;
974       dev->block_num += num;
975    } else {
976       struct mtget mt_stat;
977       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
978          Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file, 
979             dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
980          dev->file = mt_stat.mt_fileno;
981          dev->block_num = mt_stat.mt_blkno;
982       } else {
983          if (dev->state & ST_EOF) {
984             dev->state |= ST_EOT;
985          } else {
986             dev->state |= ST_EOF;           /* assume EOF */
987             dev->file++;
988             dev->block_num = 0;
989             dev->file_addr = 0;
990          }
991       }
992       clrerror_dev(dev, MTFSR);
993       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
994          dev->dev_name, strerror(dev->dev_errno));
995    }
996    update_pos_dev(dev);
997    return stat == 0 ? 1 : 0;
998 }
999
1000 /* 
1001  * Backward space a record
1002  *   Returns:  0 on failure
1003  *             1 on success
1004  */
1005 int
1006 bsr_dev(DEVICE *dev, int num)
1007
1008    struct mtop mt_com;
1009    int stat;
1010
1011    if (dev->fd < 0) {
1012       dev->dev_errno = EBADF;
1013       Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1014       Emsg0(M_FATAL, 0, dev->errmsg);
1015       return 0;
1016    }
1017
1018    if (!(dev->state & ST_TAPE)) {
1019       return 0;
1020    }
1021
1022    if (!dev_cap(dev, CAP_BSR)) {
1023       Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
1024          dev->dev_name);
1025       return 0;
1026    }
1027
1028    Dmsg0(29, "bsr_dev\n");
1029    dev->block_num -= num;
1030    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1031    mt_com.mt_op = MTBSR;
1032    mt_com.mt_count = num;
1033    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1034    if (stat < 0) {
1035       clrerror_dev(dev, MTBSR);
1036       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1037          dev->dev_name, strerror(dev->dev_errno));
1038    }
1039    update_pos_dev(dev);
1040    return stat == 0 ? 1 : 0;
1041 }
1042
1043 /* 
1044  * Reposition the device to file, block
1045  * Returns: 0 on failure
1046  *          1 on success
1047  */
1048 int
1049 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1050
1051    if (dev->fd < 0) {
1052       dev->dev_errno = EBADF;
1053       Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1054       Emsg0(M_FATAL, 0, dev->errmsg);
1055       return 0;
1056    }
1057
1058    if (!(dev_state(dev, ST_TAPE))) {
1059       off_t pos = (((off_t)file)<<32) + block;
1060       Dmsg1(100, "===== lseek to %d\n", (int)pos);
1061       if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1062          dev->dev_errno = errno;
1063          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1064             dev->dev_name, strerror(dev->dev_errno));
1065          return 0;
1066       }
1067       dev->file = file;
1068       dev->block_num = block;
1069       dev->file_addr = pos;
1070       return 1;
1071    }
1072    Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n", 
1073       dev->file, dev->block_num, file, block);
1074    if (file < dev->file) {
1075       Dmsg0(100, "Rewind_dev\n");
1076       if (!rewind_dev(dev)) {
1077          return 0;
1078       }
1079    }
1080    if (file > dev->file) {
1081       Dmsg1(100, "fsf %d\n", file-dev->file);
1082       if (!fsf_dev(dev, file-dev->file)) {
1083          return 0;
1084       }
1085    }
1086    if (block < dev->block_num) {
1087       bsf_dev(dev, 1);
1088       fsf_dev(dev, 1);
1089    }
1090    if (block > dev->block_num) {
1091       /* Ignore errors as Bacula can read to the correct block */
1092       Dmsg1(100, "fsr %d\n", block-dev->block_num);
1093       fsr_dev(dev, block-dev->block_num);
1094    }
1095    return 1;
1096 }
1097
1098
1099
1100 /*
1101  * Write an end of file on the device
1102  *   Returns: 0 on success
1103  *            non-zero on failure
1104  */
1105 int 
1106 weof_dev(DEVICE *dev, int num)
1107
1108    struct mtop mt_com;
1109    int stat;
1110
1111    if (dev->fd < 0) {
1112       dev->dev_errno = EBADF;
1113       Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1114       Emsg0(M_FATAL, 0, dev->errmsg);
1115       return -1;
1116    }
1117
1118    if (!(dev_state(dev, ST_TAPE))) {
1119       return 0;
1120    }
1121    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
1122    dev->block_num = 0;
1123    Dmsg0(29, "weof_dev\n");
1124    mt_com.mt_op = MTWEOF;
1125    mt_com.mt_count = num;
1126    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1127    if (stat == 0) {
1128       dev->file += num;
1129       dev->file_addr = 0;
1130    } else {
1131       clrerror_dev(dev, MTWEOF);
1132       if (stat == -1) {
1133          Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1134             dev->dev_name, strerror(dev->dev_errno));
1135        }
1136    }
1137    return stat;
1138 }
1139
1140 /*
1141  * Return string message with last error in English
1142  *  Be careful not to call this routine from within dev.c
1143  *  while editing an Mmsg(&) or you will end up in a recursive
1144  *  loop creating a Segmentation Violation.
1145  */
1146 char *
1147 strerror_dev(DEVICE *dev)
1148 {
1149    return dev->errmsg;
1150 }
1151
1152
1153 /*
1154  * If implemented in system, clear the tape
1155  * error status.
1156  */
1157 void
1158 clrerror_dev(DEVICE *dev, int func)
1159 {
1160    char *msg = NULL;
1161
1162    dev->dev_errno = errno;         /* save errno */
1163    if (errno == EIO) {
1164       dev->VolCatInfo.VolCatErrors++;
1165    }
1166
1167    if (!(dev->state & ST_TAPE)) {
1168       return;
1169    }
1170    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1171       switch (func) {
1172       case -1:
1173          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1174          break;
1175       case MTWEOF:
1176          msg = "WTWEOF";
1177          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1178          break;
1179 #ifdef MTEOM
1180       case MTEOM:
1181          msg = "WTEOM";
1182          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1183          break;
1184 #endif 
1185       case MTFSF:
1186          msg = "MTFSF";
1187          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1188          break;
1189       case MTBSF:
1190          msg = "MTBSF";
1191          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1192          break;
1193       case MTFSR:
1194          msg = "MTFSR";
1195          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1196          break;
1197       case MTBSR:
1198          msg = "MTBSR";
1199          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1200          break;
1201       default:
1202          msg = "Unknown";
1203          break;
1204       }
1205       if (msg != NULL) {
1206          dev->dev_errno = ENOSYS;
1207          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1208          Emsg0(M_ERROR, 0, dev->errmsg);
1209       }
1210    }
1211 /* Found on Linux */
1212 #ifdef MTIOCLRERR
1213 {
1214    struct mtop mt_com;
1215    mt_com.mt_op = MTIOCLRERR;
1216    mt_com.mt_count = 1;
1217    /* Clear any error condition on the tape */
1218    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1219    Dmsg0(200, "Did MTIOCLRERR\n");
1220 }
1221 #endif
1222
1223 /* Typically on FreeBSD */
1224 #ifdef MTIOCERRSTAT
1225 {
1226    /* Read and clear SCSI error status */
1227    union mterrstat mt_errstat;
1228    Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1229       strerror(dev->dev_errno));
1230    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1231 }
1232 #endif
1233 }
1234
1235 /*
1236  * Flush buffer contents
1237  *  No longer used.
1238  */
1239 int flush_dev(DEVICE *dev)
1240 {
1241    return 1;
1242 }
1243
1244 static void do_close(DEVICE *dev)
1245 {
1246
1247    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1248    if (dev->fd >= 0) {
1249       close(dev->fd);
1250    }
1251    /* Clean up device packet so it can be reused */
1252    dev->fd = -1;
1253    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1254    dev->file = dev->block_num = 0;
1255    dev->file_addr = 0;
1256    dev->EndFile = dev->EndBlock = 0;
1257    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1258    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1259    if (dev->tid) {
1260       stop_thread_timer(dev->tid);
1261       dev->tid = 0;
1262    }
1263    dev->use_count = 0;
1264 }
1265
1266 /* 
1267  * Close the device
1268  */
1269 void
1270 close_dev(DEVICE *dev)
1271 {
1272    if (!dev) {
1273       Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1274       Emsg0(M_FATAL, 0, dev->errmsg);
1275       return;
1276    }
1277    if (dev->fd >= 0 && dev->use_count == 1) {
1278       do_close(dev);
1279    } else if (dev->use_count > 0) {
1280       dev->use_count--;
1281    }
1282            
1283 #ifdef FULL_DEBUG
1284    ASSERT(dev->use_count >= 0);
1285 #endif
1286 }
1287
1288 /*
1289  * Used when unmounting the device, ignore use_count
1290  */
1291 void force_close_dev(DEVICE *dev)
1292 {
1293    if (!dev) {
1294       Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1295       Emsg0(M_FATAL, 0, dev->errmsg);
1296       return;
1297    }
1298    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1299    do_close(dev);
1300
1301 #ifdef FULL_DEBUG
1302    ASSERT(dev->use_count >= 0);
1303 #endif
1304 }
1305
1306 int truncate_dev(DEVICE *dev)
1307 {
1308    if (dev->state & ST_TAPE) {
1309       return 1;
1310    }
1311    if (ftruncate(dev->fd, 0) != 0) {
1312       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1313       return 0;
1314    }
1315    return 1;
1316 }
1317
1318 int 
1319 dev_is_tape(DEVICE *dev)
1320 {  
1321    return (dev->state & ST_TAPE) ? 1 : 0;
1322 }
1323
1324
1325 /*
1326  * return 1 if the device is read for write, and 0 otherwise
1327  *   This is meant for checking at the end of a job to see
1328  *   if we still have a tape (perhaps not if at end of tape
1329  *   and the job is canceled).
1330  */
1331 int
1332 dev_can_write(DEVICE *dev)
1333 {
1334    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1335        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1336       return 1;
1337    } else {
1338       return 0;
1339    }
1340 }
1341
1342 char *
1343 dev_name(DEVICE *dev)
1344 {
1345    return dev->dev_name;
1346 }
1347
1348 char *
1349 dev_vol_name(DEVICE *dev)
1350 {
1351    return dev->VolCatInfo.VolCatName;
1352 }
1353
1354 uint32_t dev_block(DEVICE *dev)
1355 {
1356    update_pos_dev(dev);
1357    return dev->block_num;
1358 }
1359
1360 uint32_t dev_file(DEVICE *dev)
1361 {
1362    update_pos_dev(dev);
1363    return dev->file;
1364 }
1365
1366 /* 
1367  * Free memory allocated for the device
1368  */
1369 void
1370 term_dev(DEVICE *dev)
1371 {
1372    if (!dev) {
1373       dev->dev_errno = EBADF;
1374       Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1375       Emsg0(M_FATAL, 0, dev->errmsg);
1376       return;
1377    }
1378    do_close(dev);
1379    Dmsg0(29, "term_dev\n");
1380    if (dev->dev_name) {
1381       free_memory(dev->dev_name);
1382       dev->dev_name = NULL;
1383    }
1384    if (dev->errmsg) {
1385       free_pool_memory(dev->errmsg);
1386       dev->errmsg = NULL;
1387    }
1388    pthread_mutex_destroy(&dev->mutex);
1389    pthread_cond_destroy(&dev->wait);
1390    pthread_cond_destroy(&dev->wait_next_vol);
1391    if (dev->state & ST_MALLOC) {
1392       free_pool_memory((POOLMEM *)dev);
1393    }
1394 }
1395
1396 /*
1397  * We attach a jcr to the device so that when
1398  *   the Volume is full during writing, a  
1399  *   JobMedia record will be created for this 
1400  *   Job.
1401  */
1402 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1403 {
1404    jcr->prev_dev = (JCR *)NULL;
1405    jcr->next_dev = dev->attached_jcrs;
1406    if (dev->attached_jcrs) {
1407       dev->attached_jcrs->prev_dev = jcr;
1408    }
1409    dev->attached_jcrs = jcr;
1410    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1411 }
1412
1413 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1414 {
1415    if (!jcr->prev_dev) {
1416       dev->attached_jcrs = jcr->next_dev;
1417    } else {
1418       jcr->prev_dev->next_dev = jcr->next_dev;
1419    }
1420    if (jcr->next_dev) {
1421       jcr->next_dev->prev_dev = jcr->prev_dev; 
1422    }
1423    jcr->next_dev = jcr->prev_dev = NULL;
1424    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1425 }
1426
1427 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1428 {
1429    if (jcr == (JCR *)NULL) {
1430       return dev->attached_jcrs;
1431    }
1432    return jcr->next_dev;
1433 }
1434
1435 /*
1436  * This routine initializes the device wait timers
1437  */
1438 void init_dev_wait_timers(DEVICE *dev)
1439 {
1440    /* ******FIXME******* put these on config variables */
1441    dev->min_wait = 60 * 60;
1442    dev->max_wait = 24 * 60 * 60;
1443    dev->max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
1444    dev->wait_sec = dev->min_wait;
1445    dev->rem_wait_sec = dev->wait_sec;
1446    dev->num_wait = 0;
1447    dev->poll = false;
1448    dev->BadVolName[0] = 0;
1449 }
1450
1451 /*
1452  * Returns: true if time doubled
1453  *          false if max time expired
1454  */
1455 bool double_dev_wait_time(DEVICE *dev)
1456 {
1457    dev->wait_sec *= 2;               /* double wait time */
1458    if (dev->wait_sec > dev->max_wait) {   /* but not longer than maxtime */
1459       dev->wait_sec = dev->max_wait;
1460    }
1461    dev->num_wait++;
1462    dev->rem_wait_sec = dev->wait_sec;
1463    if (dev->num_wait >= dev->max_num_wait) {
1464       return false;
1465    }
1466    return true;
1467 }