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