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