]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/dev.c
kes15Jun02
[bacula/bacula] / bacula / src / stored / dev.c
1 /*
2  *
3  *   dev.c  -- low level operations on device (storage device)
4  *
5  *              Kern Sibbald
6  *
7  *     NOTE!!!! None of these routines are reentrant. You must
8  *        use lock_device() and unlock_device() at a higher level,
9  *        or use the xxx_device() equivalents.  By moving the
10  *        thread synchronization to a higher level, we permit
11  *        the higher level routines to "seize" the device and 
12  *        to carry out operations without worrying about who
13  *        set what lock (i.e. race conditions).
14  *
15  *     Note, this is the device dependent code, and my have
16  *           to be modified for each system, but is meant to
17  *           be as "generic" as possible.
18  * 
19  *     The purpose of this code is to develop a SIMPLE Storage
20  *     daemon. More complicated coding (double buffering, writer
21  *     thread, ...) is left for a later version.
22  *
23  *     Unfortunately, I have had to add more and more complication
24  *     to this code. This was not foreseen as noted above, and as
25  *     a consequence has lead to something more contored 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, 2001, 2002 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 is a bit tricky.
53  * This is how it is currently done when writting.
54  * On either an I/O error or end of tape,
55  * we will stop writing on the physical device (no I/O recovery is
56  * attempted at least in this daemon). The state flag will be sent
57  * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58  * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59  * cleared only when the problem goes away.  Now when ST_WEOT
60  * is set all calls to write_dev() are handled as usual. However,
61  * in write_block() instead of attempting to write the block to
62  * the physical device, it is chained into a list of blocks written
63  * after the EOT condition.  In addition, all threads are blocked
64  * from writing on the tape by calling lock(), and thread other
65  * than the first thread to hit the EOT will block on a condition
66  * variable. The first thread to hit the EOT will continue to
67  * be able to read and write the tape (he sort of tunnels through
68  * the locking mechanism -- see lock() for details).
69  *
70  * Now presumably somewhere higher in the chain of command 
71  * (device.c), someone will notice the EOT condition and 
72  * get a new tape up, get the tape label read, and mark 
73  * the label for rewriting. Then this higher level routine 
74  * will write the unwritten buffer to the new volume.
75  * Finally, he will release
76  * any blocked threads by doing a broadcast on the condition
77  * variable.  At that point, we should be totally back in 
78  * business with no lost data.
79  */
80
81
82 #include "bacula.h"
83 #include "stored.h"
84
85 /* Forward referenced functions */
86 int dev_is_tape(DEVICE *dev);
87 void clrerror_dev(DEVICE *dev, int func);
88 int fsr_dev(DEVICE *dev, int num);
89
90 extern int debug_level;
91
92 /* 
93  * Allocate and initialize the DEVICE structure
94  * Note, if dev is non-NULL, it is already allocated,
95  * thus we neither allocate it nor free it. This allows
96  * the caller to put the packet in shared memory.
97  *
98  *  Note, for a tape, the dev_name is the device name
99  *     (e.g. /dev/nst0), and for a file, the device name
100  *     is the directory in which the file will be placed.
101  *
102  */
103 DEVICE *
104 init_dev(DEVICE *dev, char *dev_name)
105 {
106    struct stat statp;
107    int tape;
108    int errstat;
109
110    /* Check that device is available */
111    if (stat(dev_name, &statp) < 0) {
112       if (dev) {
113          dev->dev_errno = errno;
114       } 
115       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", dev_name, strerror(errno));
116       return NULL;
117    }
118    tape = FALSE;
119    if (S_ISDIR(statp.st_mode)) {
120       tape = FALSE;
121    } else if (S_ISCHR(statp.st_mode)) {
122       tape = 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          dev_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    if (tape) {
139       dev->state |= ST_TAPE;
140    }
141    dev->dev_name = (char *) get_memory(strlen(dev_name)+1);
142    strcpy(dev->dev_name, dev_name);
143
144    dev->errmsg = (char *) get_pool_memory(PM_EMSG);
145    *dev->errmsg = 0;
146
147    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
148       dev->dev_errno = errstat;
149       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
150       Emsg0(M_FATAL, 0, dev->errmsg);
151    }
152    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
153       dev->dev_errno = errstat;
154       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
155       Emsg0(M_FATAL, 0, dev->errmsg);
156    }
157    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
158       dev->dev_errno = errstat;
159       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
160       Emsg0(M_FATAL, 0, dev->errmsg);
161    }
162    dev->fd = -1;
163    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
164    return dev;
165 }
166
167 /* Open the device with the operating system and
168  * initialize buffer pointers.
169  *
170  * Note, for a tape, the VolName is the name we give to the
171  *    volume (not really used here), but for a file, the
172  *    VolName represents the name of the file to be created/opened.
173  *    In the case of a file, the full name is the device name
174  *    (archive_name) with the VolName concatenated.
175  */
176 int
177 open_dev(DEVICE *dev, char *VolName, int mode)
178 {
179    char *archive_name;
180
181    if (dev->state & ST_OPENED) {
182       /*
183        *  *****FIXME***** how to handle two threads wanting
184        *  different volumes mounted???? E.g. one is waiting
185        *  for the next volume to be mounted, and a new job
186        *  starts and snatches up the device.
187        */
188       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
189          return -1;
190       }
191       dev->use_count++;
192       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"), 
193             dev->dev_name, dev->use_count);
194       Emsg0(M_WARNING, 0, dev->errmsg);
195       return dev->fd;
196    }
197    if (VolName) {
198       strcpy(dev->VolCatInfo.VolCatName, VolName);
199    }
200
201    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev), 
202          dev->dev_name, dev->VolCatInfo.VolCatName);
203    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
204    if (dev->state & ST_TAPE) {
205       Dmsg0(29, "open_dev: device is tape\n");
206       if (mode == READ_WRITE) {
207          dev->mode = O_RDWR | O_BINARY;
208       } else {
209          dev->mode = O_RDONLY | O_BINARY;
210       }
211       if ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
212          dev->dev_errno = errno;
213          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"), 
214                dev->dev_name, strerror(dev->dev_errno));
215          Emsg0(M_FATAL, 0, dev->errmsg);
216       } else {
217          dev->dev_errno = 0;
218          dev->state |= ST_OPENED;
219          dev->use_count++;
220          update_pos_dev(dev);             /* update position */
221       }
222       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
223    } else {
224       archive_name = (char *) get_pool_memory(PM_FNAME);
225       strcpy(archive_name, dev->dev_name);
226       if (archive_name[strlen(archive_name)] != '/') {
227          strcat(archive_name, "/");
228       }
229       strcat(archive_name, VolName);
230       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
231       if (mode == READ_WRITE) {
232          dev->mode = O_CREAT | O_RDWR | O_BINARY;
233       } else {
234          dev->mode = O_RDONLY | O_BINARY;
235       }
236       if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
237          dev->dev_errno = errno;
238          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
239          Emsg0(M_FATAL, 0, dev->errmsg);
240       } else {
241          dev->dev_errno = 0;
242          dev->state |= ST_OPENED;
243          dev->use_count++;
244          update_pos_dev(dev);                /* update position */
245       }
246       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
247       free_pool_memory(archive_name);
248    }
249    return dev->fd;
250 }
251
252 /*
253  * Rewind the device.
254  *  Returns: 1 on success
255  *           0 on failure
256  */
257 int rewind_dev(DEVICE *dev)
258 {
259    struct mtop mt_com;
260    unsigned int i;
261
262    Dmsg0(29, "rewind_dev\n");
263    if (dev->fd < 0) {
264       dev->dev_errno = EBADF;
265       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
266             dev->dev_name);
267       Emsg0(M_ABORT, 0, dev->errmsg);
268       return 0;
269    }
270    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT);  /* remove EOF/EOT flags */
271    dev->block_num = dev->file = 0;
272    dev->file_bytes = 0;
273    if (dev->state & ST_TAPE) {
274       mt_com.mt_op = MTREW;
275       mt_com.mt_count = 1;
276       /* If we get an I/O error on rewind, it is probably because
277        * the drive is actually busy. We loop for (about 5 minutes)
278        * retrying every 5 seconds.
279        */
280       for (i=dev->max_rewind_wait; ; i -= 5) {
281          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
282             if (i == dev->max_rewind_wait) {
283                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
284             }
285             clrerror_dev(dev, MTREW);
286             if (dev->dev_errno == EIO && i > 0) {
287                Dmsg0(200, "Sleeping 5 seconds.\n");
288                sleep(5);
289                continue;
290             }
291             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
292                dev->dev_name, strerror(dev->dev_errno));
293             return 0;
294          }
295          break;
296       }
297    } else {
298       if (lseek(dev->fd, 0, SEEK_SET) < 0) {
299          dev->dev_errno = errno;
300          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
301             dev->dev_name, strerror(dev->dev_errno));
302          return 0;
303       }
304    }
305    return 1;
306 }
307
308 /* 
309  * Position device to end of medium (end of data)
310  *  Returns: 1 on succes
311  *           0 on error
312  */
313 int 
314 eod_dev(DEVICE *dev)
315 {
316    struct mtop mt_com;
317    struct mtget mt_stat;
318    int stat = 0;
319    int32_t pos;
320
321    Dmsg0(29, "eod_dev\n");
322    if (dev->state & ST_EOT) {
323       return 1;
324    }
325    dev->state &= ~(ST_EOF);  /* remove EOF flags */
326    dev->block_num = dev->file = 0;
327    dev->file_bytes = 0;
328    if (!(dev->state & ST_TAPE)) {
329       pos = lseek(dev->fd, 0, SEEK_END);
330       if (pos > 0) {
331          update_pos_dev(dev);
332          dev->state |= ST_EOT;
333          return 1;
334       }
335       return 0;
336    }
337    if (dev->capabilities & CAP_EOM) {
338       mt_com.mt_op = MTEOM;
339       mt_com.mt_count = 1;
340       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
341          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
342          clrerror_dev(dev, mt_com.mt_op);
343          update_pos_dev(dev);
344          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
345             dev->dev_name, strerror(dev->dev_errno));
346          return 0;
347       }
348       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
349          dev->dev_errno = errno;
350          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
351             dev->dev_name, strerror(dev->dev_errno));
352          return 0;
353       }
354       Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
355       dev->file = mt_stat.mt_fileno;
356
357    /*
358     * Rewind then use FSF until EOT reached
359     */
360    } else {
361       if (!rewind_dev(dev)) {
362          return 0;
363       }
364       while (!(dev->state & ST_EOT)) {
365          Dmsg0(200, "Do fsf 1\n");
366          if (fsf_dev(dev, 1) < 0) {
367             Dmsg0(200, "fsf_dev return < 0\n");
368             return 0;
369          }
370       }
371    }
372    update_pos_dev(dev);                      /* update position */
373    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
374    return 1;
375 }
376
377 /*
378  * Set the position of the device.
379  *  Returns: 1 on succes
380  *           0 on error
381  */
382 int update_pos_dev(DEVICE *dev)
383 {
384 #ifdef xxxx
385    struct mtget mt_stat;
386 #endif
387    int32_t pos;
388    int stat = 0;
389
390    if (dev->fd < 0) {
391       dev->dev_errno = EBADF;
392       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
393       Emsg0(M_FATAL, 0, dev->errmsg);
394       return 0;
395    }
396
397    /* Find out where we are */
398    if (!(dev->state & ST_TAPE)) {
399       dev->file = 0;
400       dev->file_bytes = 0;
401       pos = lseek(dev->fd, 0, SEEK_CUR);
402       if (pos < 0) {
403          Dmsg1(200, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
404          pos = 0;
405          dev->dev_errno = errno;
406          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
407             dev->dev_name, strerror(dev->dev_errno));
408       } else {
409          stat = 1;
410       }
411       return stat;
412    }
413
414 #ifdef REALLY_IMPLEMENTED
415    if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
416       Dmsg1(50, "MTIOCGET error: %s\n", strerror(dev->dev_errno));
417       dev->dev_errno = errno;
418       Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
419          dev->dev_name, strerror(dev->dev_errno));
420    } else {
421       stat = 1;
422    }
423    return stat;
424 #endif
425    return 1;
426 }
427
428
429 /* 
430  * Return the status of the device.  This was meant
431  * to be a generic routine. Unfortunately, it doesn't
432  * seem possible (at least I do not know how to do it
433  * currently), which means that for the moment, this
434  * routine has very little value.
435  *
436  *   Returns: 1 on success
437  *            0 on error
438  */
439 int
440 status_dev(DEVICE *dev, uint32_t *status)
441 {
442    struct mtget mt_stat;
443    uint32_t stat = 0;
444
445    if (dev->state & (ST_EOT | ST_WEOT)) {
446       stat |= MT_EOD;
447       Dmsg0(-20, " EOD");
448    }
449    if (dev->state & ST_EOF) {
450       stat |= MT_EOF;
451       Dmsg0(-20, " EOF");
452    }
453    if (dev->state & ST_TAPE) {
454       stat |= MT_TAPE;
455       Dmsg0(-20," Driver status:");
456       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
457       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
458          dev->dev_errno = errno;
459          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
460             dev->dev_name, strerror(dev->dev_errno));
461          return 0;
462       }
463       Dmsg0(-20, " Device status:");
464
465 #if defined(HAVE_LINUX_OS)
466       if (GMT_EOF(mt_stat.mt_gstat)) {
467          stat |= MT_EOF;
468          Dmsg0(-20, " EOF");
469       }
470       if (GMT_BOT(mt_stat.mt_gstat)) {
471          stat |= MT_BOT;
472          Dmsg0(-20, " BOT");
473       }
474       if (GMT_EOT(mt_stat.mt_gstat)) {
475          stat |= MT_EOT;
476          Dmsg0(-20, " EOT");
477       }
478       if (GMT_SM(mt_stat.mt_gstat)) {
479          stat |= MT_SM;
480          Dmsg0(-20, " SM");
481       }
482       if (GMT_EOD(mt_stat.mt_gstat)) {
483          stat |= MT_EOD;
484          Dmsg0(-20, " EOD");
485       }
486       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
487          stat |= MT_WR_PROT;
488          Dmsg0(-20, " WR_PROT");
489       }
490       if (GMT_ONLINE(mt_stat.mt_gstat)) {
491          stat |= MT_ONLINE;
492          Dmsg0(-20, " ONLINE");
493       }
494       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
495          stat |= MT_DR_OPEN;
496          Dmsg0(-20, " DR_OPEN");       
497       }
498       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
499          stat |= MT_IM_REP_EN;
500          Dmsg0(-20, " IM_REP_EN");
501       }
502 #endif /* !SunOS && !OSF */
503       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
504    } else {
505       stat |= MT_ONLINE | MT_BOT;
506    }
507    *status = stat; 
508    return 1;
509 }
510
511
512 /*
513  * Load medium in device
514  *  Returns: 1 on success
515  *           0 on failure
516  */
517 int load_dev(DEVICE *dev)
518 {
519 #ifdef MTLOAD
520    struct mtop mt_com;
521 #endif
522
523    if (dev->fd < 0) {
524       dev->dev_errno = EBADF;
525       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
526       Emsg0(M_FATAL, 0, dev->errmsg);
527       return 0;
528    }
529    if (!(dev->state & ST_TAPE)) {
530       return 1;
531    }
532 #ifndef MTLOAD
533    Dmsg0(200, "stored: MTLOAD command not available\n");
534    dev->dev_errno = ENOTTY;           /* function not available */
535    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
536          dev->dev_name, strerror(dev->dev_errno));      return 0;
537    return 0;
538 #else
539
540    dev->block_num = dev->file = 0;
541    dev->file_bytes = 0;
542    mt_com.mt_op = MTLOAD;
543    mt_com.mt_count = 1;
544    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
545       dev->dev_errno = errno;
546       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
547          dev->dev_name, strerror(dev->dev_errno));      return 0;
548    }
549    return 1;
550 #endif
551 }
552
553 /*
554  * Rewind device and put it offline
555  *  Returns: 1 on success
556  *           0 on failure
557  */
558 int offline_dev(DEVICE *dev)
559 {
560    struct mtop mt_com;
561
562    if (dev->fd < 0) {
563       dev->dev_errno = EBADF;
564       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
565       Emsg0(M_FATAL, 0, dev->errmsg);
566       return 0;
567    }
568    if (!(dev->state & ST_TAPE)) {
569       return 1;
570    }
571
572    dev->block_num = dev->file = 0;
573    dev->file_bytes = 0;
574    mt_com.mt_op = MTOFFL;
575    mt_com.mt_count = 1;
576    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
577       dev->dev_errno = errno;
578       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
579          dev->dev_name, strerror(dev->dev_errno));
580       return 0;
581    }
582    return 1;
583 }
584
585
586 /* 
587  * Foward space a file  
588  */
589 int
590 fsf_dev(DEVICE *dev, int num)
591
592    struct mtop mt_com;
593    int stat;
594    char rbuf[1024];
595
596    if (dev->fd < 0) {
597       dev->dev_errno = EBADF;
598       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
599       Emsg0(M_FATAL, 0, dev->errmsg);
600       return -1;
601    }
602
603    if (!(dev->state & ST_TAPE)) {
604       return 0;
605    }
606    if (dev->state & ST_EOT) {
607       dev->dev_errno = 0;
608       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
609       return -1;
610    }
611    if (dev->state & ST_EOF)
612       Dmsg0(200, "ST_EOF set on entry to FSF\n");
613    if (dev->state & ST_EOT)
614       Dmsg0(200, "ST_EOT set on entry to FSF\n");
615       
616    Dmsg0(29, "fsf_dev\n");
617    dev->block_num = 0;
618    if (dev->capabilities & CAP_FSF) {
619       Dmsg0(200, "FSF has cap_fsf\n");
620       mt_com.mt_op = MTFSF;
621       mt_com.mt_count = 1;
622       while (num-- && !(dev->state & ST_EOT)) {
623          Dmsg0(200, "Doing read for fsf\n");
624          if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
625             if (errno == ENOMEM) {     /* tape record exceeds buf len */
626                stat = sizeof(rbuf);   /* This is OK */
627             } else {
628                dev->state |= ST_EOT;
629                clrerror_dev(dev, -1);
630                Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
631                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
632                   dev->dev_name, strerror(dev->dev_errno));
633                Dmsg1(200, "%s", dev->errmsg);
634                break;
635             }
636          }
637          if (stat == 0) {                /* EOF */
638             update_pos_dev(dev);
639             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
640             /* Two reads of zero means end of tape */
641             if (dev->state & ST_EOF) {
642                dev->state |= ST_EOT;
643                Dmsg0(200, "Set ST_EOT\n");
644                break;
645             } else {
646                dev->state |= ST_EOF;
647                dev->file++;
648                dev->file_bytes = 0;
649                continue;
650             }
651          } else {                        /* Got data */
652             dev->state &= ~(ST_EOF|ST_EOT);
653          }
654
655          Dmsg0(200, "Doing MT_FSF\n");
656          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
657          if (stat < 0) {                 /* error => EOT */
658             dev->state |= ST_EOT;
659             Dmsg0(200, "Set ST_EOT\n");
660             clrerror_dev(dev, MTFSF);
661             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
662                dev->dev_name, strerror(dev->dev_errno));
663             Dmsg0(200, "Got < 0 for MT_FSF\n");
664             Dmsg1(200, "%s", dev->errmsg);
665          } else {
666             dev->state |= ST_EOF;     /* just read EOF */
667             dev->file++;
668             dev->file_bytes = 0;
669          }   
670       }
671    
672    /*
673     * No FSF, so use FSR to simulate it
674     */
675    } else {
676       Dmsg0(200, "Doing FSR for FSF\n");
677       while (num-- && !(dev->state & ST_EOT)) {
678          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
679       }
680       if (dev->state & ST_EOT) {
681          dev->dev_errno = 0;
682          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
683          stat = -1;
684       } else {
685          stat = 0;
686       }
687    }
688    update_pos_dev(dev);
689    Dmsg1(200, "Return %d from FSF\n", stat);
690    if (dev->state & ST_EOF)
691       Dmsg0(200, "ST_EOF set on exit FSF\n");
692    if (dev->state & ST_EOT)
693       Dmsg0(200, "ST_EOT set on exit FSF\n");
694    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
695    return stat;
696 }
697
698 /* 
699  * Backward space a file  
700  */
701 int
702 bsf_dev(DEVICE *dev, int num)
703
704    struct mtop mt_com;
705    int stat;
706
707    if (dev->fd < 0) {
708       dev->dev_errno = EBADF;
709       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
710       Emsg0(M_FATAL, 0, dev->errmsg);
711       return -1;
712    }
713
714    if (!(dev->state & ST_TAPE)) {
715       return 0;
716    }
717    Dmsg0(29, "bsf_dev\n");
718    dev->state &= ~(ST_EOT|ST_EOF);
719    dev->file -= num;
720    dev->file_bytes = 0;
721    mt_com.mt_op = MTBSF;
722    mt_com.mt_count = num;
723    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
724    if (stat < 0) {
725       clrerror_dev(dev, MTBSF);
726       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
727          dev->dev_name, strerror(dev->dev_errno));
728    }
729    update_pos_dev(dev);
730    return stat;
731 }
732
733
734 /* 
735  * Foward space a record
736  */
737 int
738 fsr_dev(DEVICE *dev, int num)
739
740    struct mtop mt_com;
741    int stat;
742
743    if (dev->fd < 0) {
744       dev->dev_errno = EBADF;
745       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
746       Emsg0(M_FATAL, 0, dev->errmsg);
747       return -1;
748    }
749
750    if (!(dev->state & ST_TAPE)) {
751       return 0;
752    }
753    Dmsg0(29, "fsr_dev\n");
754    dev->block_num += num;
755    mt_com.mt_op = MTFSR;
756    mt_com.mt_count = num;
757    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
758    if (stat == 0) {
759       dev->state &= ~ST_EOF;
760    } else {
761       if (dev->state & ST_EOF) {
762          dev->state |= ST_EOT;
763       } else {
764          dev->state |= ST_EOF;           /* assume EOF */
765          dev->file++;
766          dev->file_bytes = 0;
767       }
768       clrerror_dev(dev, MTFSR);
769       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
770          dev->dev_name, strerror(dev->dev_errno));
771    }
772    update_pos_dev(dev);
773    return stat;
774 }
775
776 /* 
777  * Backward space a record
778  */
779 int
780 bsr_dev(DEVICE *dev, int num)
781
782    struct mtop mt_com;
783    int stat;
784
785    if (dev->fd < 0) {
786       dev->dev_errno = EBADF;
787       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
788       Emsg0(M_FATAL, 0, dev->errmsg);
789       return -1;
790    }
791
792    if (!(dev->state & ST_TAPE)) {
793       return 0;
794    }
795    Dmsg0(29, "bsr_dev\n");
796    dev->block_num -= num;
797    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
798    mt_com.mt_op = MTBSR;
799    mt_com.mt_count = num;
800    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
801    if (stat < 0) {
802       clrerror_dev(dev, MTBSR);
803       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
804          dev->dev_name, strerror(dev->dev_errno));
805    }
806    update_pos_dev(dev);
807    return stat;
808 }
809
810
811
812 /*
813  * Write an end of file on the device
814  */
815 int 
816 weof_dev(DEVICE *dev, int num)
817
818    struct mtop mt_com;
819    int stat;
820
821    if (dev->fd < 0) {
822       dev->dev_errno = EBADF;
823       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
824       Emsg0(M_FATAL, 0, dev->errmsg);
825       return -1;
826    }
827
828    if (!(dev->state & ST_TAPE)) {
829       return 0;
830    }
831    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
832    dev->block_num = 0;
833    Dmsg0(29, "weof_dev\n");
834    mt_com.mt_op = MTWEOF;
835    mt_com.mt_count = num;
836    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
837    if (stat == 0) {
838       dev->file++;
839       dev->file_bytes = 0;
840    } else {
841       clrerror_dev(dev, MTWEOF);
842       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
843          dev->dev_name, strerror(dev->dev_errno));
844    }
845    return stat;
846 }
847
848 /*
849  * Return string message with last error in English
850  *  Be careful not to call this routine from within dev.c
851  *  while editing an Mmsg(&) or you will end up in a recursive
852  *  loop creating a Segmentation Violation.
853  */
854 char *
855 strerror_dev(DEVICE *dev)
856 {
857    return dev->errmsg;
858 }
859
860
861 /*
862  * If implemented in system, clear the tape
863  * error status.
864  */
865 void
866 clrerror_dev(DEVICE *dev, int func)
867 {
868    char *msg = NULL;
869
870    dev->dev_errno = errno;         /* save errno */
871    if (errno == EIO) {
872       dev->VolCatInfo.VolCatErrors++;
873    }
874
875    if (!(dev->state & ST_TAPE)) {
876       return;
877    }
878    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
879       switch (func) {
880          case -1:
881             Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
882             break;
883          case MTWEOF:
884             msg = "WTWEOF";
885             dev->capabilities &= ~CAP_EOF; /* turn off feature */
886             break;
887          case MTEOM:
888             msg = "WTEOM";
889             dev->capabilities &= ~CAP_EOM; /* turn off feature */
890             break;
891          case MTFSF:
892             msg = "MTFSF";
893             dev->capabilities &= ~CAP_FSF; /* turn off feature */
894             break;
895          case MTBSF:
896             msg = "MTBSF";
897             dev->capabilities &= ~CAP_BSF; /* turn off feature */
898             break;
899          case MTFSR:
900             msg = "MTFSR";
901             dev->capabilities &= ~CAP_FSR; /* turn off feature */
902             break;
903          case MTBSR:
904             msg = "MTBSR";
905             dev->capabilities &= ~CAP_BSR; /* turn off feature */
906             break;
907          default:
908             msg = "Unknown";
909             break;
910       }
911       if (msg != NULL) {
912          dev->dev_errno = ENOSYS;
913          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
914          Emsg0(M_ERROR, 0, dev->errmsg);
915       }
916    }
917 #ifdef MTIOCLRERR
918 {
919    struct mtop mt_com;
920    int stat;
921    mt_com.mt_op = MTIOCLRERR;
922    mt_com.mt_count = 1;
923    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
924    Dmsg0(200, "Did MTIOCLRERR\n");
925 }
926 #endif
927 }
928
929 /*
930  * Flush buffer contents
931  *  No longer used.
932  */
933 int flush_dev(DEVICE *dev)
934 {
935    return 1;
936 }
937
938 static void do_close(DEVICE *dev)
939 {
940    Dmsg0(29, "really close_dev\n");
941    close(dev->fd);
942    /* Clean up device packet so it can be reused */
943    dev->fd = -1;
944    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
945    dev->block_num = 0;
946    dev->file = 0;
947    dev->file_bytes = 0;
948    dev->LastBlockNumWritten = 0;
949    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
950    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
951 }
952
953 /* 
954  * Close the device
955  */
956 void
957 close_dev(DEVICE *dev)
958 {
959    if (!dev) {
960       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
961       Emsg0(M_FATAL, 0, dev->errmsg);
962       return;
963    }
964    if (dev->fd >= 0 && dev->use_count == 1) {
965       do_close(dev);
966    } else {    
967       Dmsg0(29, "close_dev but in use so leave open.\n");
968    }
969    dev->use_count--;
970 }
971
972 void force_close_dev(DEVICE *dev)
973 {
974    if (!dev) {
975       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
976       Emsg0(M_FATAL, 0, dev->errmsg);
977       return;
978    }
979    Dmsg0(29, "really close_dev\n");
980    do_close(dev);
981    dev->use_count--;
982 }
983
984 int truncate_dev(DEVICE *dev)
985 {
986    if (dev->state & ST_TAPE) {
987       return 1;
988    }
989    if (ftruncate(dev->fd, 0) != 0) {
990       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
991       return 0;
992    }
993    return 1;
994 }
995
996 int 
997 dev_is_tape(DEVICE *dev)
998 {  
999    return (dev->state & ST_TAPE) ? 1 : 0;
1000 }
1001
1002 char *
1003 dev_name(DEVICE *dev)
1004 {
1005    return dev->dev_name;
1006 }
1007
1008 char *
1009 dev_vol_name(DEVICE *dev)
1010 {
1011    return dev->VolCatInfo.VolCatName;
1012 }
1013
1014 uint32_t dev_block(DEVICE *dev)
1015 {
1016    update_pos_dev(dev);
1017    return dev->block_num;
1018 }
1019
1020 uint32_t dev_file(DEVICE *dev)
1021 {
1022    update_pos_dev(dev);
1023    return dev->file;
1024 }
1025
1026 /* 
1027  * Free memory allocated for the device
1028  */
1029 void
1030 term_dev(DEVICE *dev)
1031 {
1032    if (!dev) {
1033       dev->dev_errno = EBADF;
1034       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1035       Emsg0(M_FATAL, 0, dev->errmsg);
1036       return;
1037    }
1038    close_dev(dev);
1039    Dmsg0(29, "term_dev\n");
1040    if (dev->dev_name) {
1041       free_memory(dev->dev_name);
1042       dev->dev_name = NULL;
1043    }
1044    if (dev->errmsg) {
1045       free_pool_memory(dev->errmsg);
1046       dev->errmsg = NULL;
1047    }
1048    pthread_mutex_destroy(&dev->mutex);
1049    pthread_cond_destroy(&dev->wait);
1050    pthread_cond_destroy(&dev->wait_next_vol);
1051    if (dev->state & ST_MALLOC) {
1052       free_pool_memory((POOLMEM *)dev);
1053    }
1054 }