]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/dev.c
1aa389c542be8f0168faf3cacf0cb2a381c67fef
[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-2005 Kern Sibbald
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 int mount_dev(DEVICE* dev, int timeout);
86 int unmount_dev(DEVICE* dev, int timeout);
87 int write_part(DEVICE *dev);
88 char *edit_device_codes_dev(DEVICE* dev, char *omsg, const char *imsg);
89 void get_filename(DEVICE *dev, char *VolName, POOL_MEM& archive_name);
90 void update_free_space_dev(DEVICE* dev);
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 device->device_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, DEVRES *device)
105 {
106    struct stat statp;
107    bool tape, fifo;
108    int errstat;
109    DCR *dcr = NULL;
110
111    /* Check that device is available */
112    if (stat(device->device_name, &statp) < 0) {
113       berrno be;
114       if (dev) {
115          dev->dev_errno = errno;
116       }
117       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
118          be.strerror());
119       return NULL;
120    }
121    
122    /* If the device requires mount :
123     * - Check that the mount point is available 
124     * - Check that (un)mount commands are defined
125     */
126    if (device->cap_bits & CAP_REQMOUNT) {
127       if (stat(device->mount_point, &statp) < 0) {
128          berrno be;
129          if (dev) {
130             dev->dev_errno = errno;
131          }
132          Emsg2(M_FATAL, 0, "Unable to stat mount point %s : %s\n", device->mount_point,
133             be.strerror());
134          return NULL;
135       }
136       if (!device->mount_command || !device->unmount_command) {
137          Emsg0(M_FATAL, 0, "Mount and unmount commands must defined for a device which requires mount.\n");
138          return NULL;
139       }
140       if (!device->write_part_command) {
141          Emsg0(M_FATAL, 0, "Write part command must be defined for a device which requires mount.\n");
142          return NULL;
143       }
144    }
145    
146    tape = false;
147    fifo = false;
148    if (S_ISDIR(statp.st_mode)) {
149       tape = false;
150    } else if (S_ISCHR(statp.st_mode)) {
151       tape = true;
152    } else if (S_ISFIFO(statp.st_mode)) {
153       fifo = true;
154    } else {
155       if (dev) {
156          dev->dev_errno = ENODEV;
157       }
158       Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
159          device->device_name, statp.st_mode);
160       return NULL;
161    }
162    if (!dev) {
163       dev = (DEVICE *)get_memory(sizeof(DEVICE));
164       memset(dev, 0, sizeof(DEVICE));
165       dev->state = ST_MALLOC;
166    } else {
167       memset(dev, 0, sizeof(DEVICE));
168    }
169
170    /* Copy user supplied device parameters from Resource */
171    dev->dev_name = get_memory(strlen(device->device_name)+1);
172    strcpy(dev->dev_name, device->device_name);
173    dev->capabilities = device->cap_bits;
174    dev->min_block_size = device->min_block_size;
175    dev->max_block_size = device->max_block_size;
176    dev->max_volume_size = device->max_volume_size;
177    dev->max_file_size = device->max_file_size;
178    dev->volume_capacity = device->volume_capacity;
179    dev->max_rewind_wait = device->max_rewind_wait;
180    dev->max_open_wait = device->max_open_wait;
181    dev->max_open_vols = device->max_open_vols;
182    dev->vol_poll_interval = device->vol_poll_interval;
183    dev->max_spool_size = device->max_spool_size;
184    dev->drive_index = device->drive_index;
185    if (tape) { /* No parts on tapes */
186       dev->max_part_size = 0;
187    }
188    else {
189       dev->max_part_size = device->max_part_size;
190    }
191    /* Sanity check */
192    if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
193       dev->vol_poll_interval = 60;
194    }
195    dev->device = device;
196
197    if (tape) {
198       dev->state |= ST_TAPE;
199    } else if (fifo) {
200       dev->state |= ST_FIFO;
201       dev->capabilities |= CAP_STREAM; /* set stream device */
202    } else {
203       dev->state |= ST_FILE;
204    }
205
206    if (dev->max_block_size > 1000000) {
207       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
208          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
209       dev->max_block_size = 0;
210    }
211    if (dev->max_block_size % TAPE_BSIZE != 0) {
212       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
213          dev->max_block_size, dev->dev_name);
214    }
215
216    dev->errmsg = get_pool_memory(PM_EMSG);
217    *dev->errmsg = 0;
218
219    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
220       berrno be;
221       dev->dev_errno = errstat;
222       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
223       Emsg0(M_FATAL, 0, dev->errmsg);
224    }
225    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
226       berrno be;
227       dev->dev_errno = errstat;
228       Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
229       Emsg0(M_FATAL, 0, dev->errmsg);
230    }
231    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
232       berrno be;
233       dev->dev_errno = errstat;
234       Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
235       Emsg0(M_FATAL, 0, dev->errmsg);
236    }
237    if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
238       berrno be;
239       dev->dev_errno = errstat;
240       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
241       Emsg0(M_FATAL, 0, dev->errmsg);
242    }
243    if ((errstat = rwl_init(&dev->lock)) != 0) {
244       berrno be;
245       dev->dev_errno = errstat;
246       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
247       Emsg0(M_FATAL, 0, dev->errmsg);
248    }
249
250    dev->fd = -1;
251    dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
252    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
253    
254    return dev;
255 }
256
257 /* 
258  * Write the current volume/part filename to archive_name.
259  */
260
261 void get_filename(DEVICE *dev, char *VolName, POOL_MEM& archive_name) {
262    char partnumber[20];
263    
264    if (dev_cap(dev, CAP_REQMOUNT)) {
265          /* If we try to open the last part, just open it from disk, 
266          * otherwise, open it from the spooling directory */
267       if (dev->part < dev->num_parts) {
268          pm_strcpy(archive_name, dev->device->mount_point);
269       }
270       else {
271          /* Use the working directory if spool directory is not defined */
272          if (dev->device->spool_directory) {
273             pm_strcpy(archive_name, dev->device->spool_directory);
274          } else {
275             pm_strcpy(archive_name, working_directory);
276          }
277       }
278    }
279    else {
280       pm_strcpy(archive_name, dev->dev_name);
281    }
282       
283    if (archive_name.c_str()[strlen(archive_name.c_str())-1] != '/') {
284       pm_strcat(archive_name, "/");
285    }
286    pm_strcat(archive_name, VolName);
287    /* if part != 0, append .# to the filename (where # is the part number) */
288    if (dev->part != 0) {
289       pm_strcat(archive_name, ".");
290       bsnprintf(partnumber, sizeof(partnumber), "%d", dev->part);
291       pm_strcat(archive_name, partnumber);
292    }
293 }  
294
295 /* Open the device with the operating system and
296  * initialize buffer pointers.
297  *
298  * Note, for a tape, the VolName is the name we give to the
299  *    volume (not really used here), but for a file, the
300  *    VolName represents the name of the file to be created/opened.
301  *    In the case of a file, the full name is the device name
302  *    (archive_name) with the VolName concatenated.
303  */
304 int
305 open_dev(DEVICE *dev, char *VolName, int mode)
306 {
307    if (dev->state & ST_OPENED) {
308       /*
309        *  *****FIXME***** how to handle two threads wanting
310        *  different volumes mounted???? E.g. one is waiting
311        *  for the next volume to be mounted, and a new job
312        *  starts and snatches up the device.
313        */
314       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
315          return -1;
316       }
317       dev->use_count++;
318       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
319             dev->dev_name, dev->use_count);
320       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
321       return dev->fd;
322    }
323    if (VolName) {
324       bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
325    }
326
327    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
328          dev->dev_name, dev->VolCatInfo.VolCatName);
329    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
330    if (dev->state & (ST_TAPE|ST_FIFO)) {
331       dev->file_size = 0;
332       int timeout;
333       Dmsg0(29, "open_dev: device is tape\n");
334       if (mode == OPEN_READ_WRITE) {
335          dev->mode = O_RDWR | O_BINARY;
336       } else if (mode == OPEN_READ_ONLY) {
337          dev->mode = O_RDONLY | O_BINARY;
338       } else if (mode == OPEN_WRITE_ONLY) {
339          dev->mode = O_WRONLY | O_BINARY;
340       } else {
341          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
342       }
343       timeout = dev->max_open_wait;
344       errno = 0;
345       if (dev->state & ST_FIFO && timeout) {
346          /* Set open timer */
347          dev->tid = start_thread_timer(pthread_self(), timeout);
348       }
349       /* If busy retry each second for max_open_wait seconds */
350       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
351          berrno be;
352          if (errno == EINTR || errno == EAGAIN) {
353             continue;
354          }
355          if (errno == EBUSY && timeout-- > 0) {
356             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, be.strerror());
357             bmicrosleep(1, 0);
358             continue;
359          }
360          dev->dev_errno = errno;
361          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
362                dev->dev_name, be.strerror());
363          /* Stop any open timer we set */
364          if (dev->tid) {
365             stop_thread_timer(dev->tid);
366             dev->tid = 0;
367          }
368          Emsg0(M_FATAL, 0, dev->errmsg);
369          break;
370       }
371       if (dev->fd >= 0) {
372          dev->dev_errno = 0;
373          dev->state |= ST_OPENED;
374          dev->use_count = 1;
375          update_pos_dev(dev);             /* update position */
376          set_os_device_parameters(dev);      /* do system dependent stuff */
377       }
378       /* Stop any open() timer we started */
379       if (dev->tid) {
380          stop_thread_timer(dev->tid);
381          dev->tid = 0;
382       }
383       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
384    } else {
385       POOL_MEM archive_name(PM_FNAME);
386       struct stat filestat;
387       /*
388        * Handle opening of File Archive (not a tape)
389        */     
390       if (dev->part == 0) {
391          dev->file_size = 0;
392       }
393       dev->part_size = 0;
394       
395       /* if num_parts has not been set, but VolCatInfo is available, copy
396        * it from the VolCatInfo.VolCatParts */
397       if (dev->num_parts < dev->VolCatInfo.VolCatParts) {
398          dev->num_parts = dev->VolCatInfo.VolCatParts;
399       }
400       
401       if (VolName == NULL || *VolName == 0) {
402          Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
403             dev->dev_name);
404          return -1;
405       }
406       get_filename(dev, VolName, archive_name);
407
408       if (dev_cap(dev, CAP_REQMOUNT) && (dev->num_parts > 0)) {
409          if (mount_dev(dev, 1) < 0) {
410             Mmsg(dev->errmsg, _("Could not mount device %s.\n"),
411                  dev->dev_name);
412             Emsg0(M_FATAL, 0, dev->errmsg);
413             dev->fd = -1;
414             return dev->fd;
415          }
416       }
417             
418       Dmsg2(29, "open_dev: device is disk %s (mode:%d)\n", archive_name.c_str(), mode);
419       dev->openmode = mode;
420       
421       /* If we are not trying to access the last part, set mode to OPEN_READ_ONLY,
422        * as writing would be an error.
423        */
424       if (dev->part < dev->num_parts) {
425          mode = OPEN_READ_ONLY;
426       }
427       
428       if (mode == OPEN_READ_WRITE) {
429          dev->mode = O_CREAT | O_RDWR | O_BINARY;
430       } else if (mode == OPEN_READ_ONLY) {
431          dev->mode = O_RDONLY | O_BINARY;
432       } else if (mode == OPEN_WRITE_ONLY) {
433          dev->mode = O_WRONLY | O_BINARY;
434       } else {
435          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
436       }
437       /* If creating file, give 0640 permissions */
438       if ((dev->fd = open(archive_name.c_str(), dev->mode, 0640)) < 0) {
439          berrno be;
440          dev->dev_errno = errno;
441          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(), be.strerror());
442          Emsg0(M_FATAL, 0, dev->errmsg);
443       } else {
444          dev->dev_errno = 0;
445          dev->state |= ST_OPENED;
446          dev->use_count = 1;
447          update_pos_dev(dev);                /* update position */
448          if (fstat(dev->fd, &filestat) < 0) {
449             berrno be;
450             dev->dev_errno = errno;
451             Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(), be.strerror());
452             Emsg0(M_FATAL, 0, dev->errmsg);
453          }
454          else {
455             dev->part_size = filestat.st_size;
456          }
457       }
458       Dmsg4(29, "open_dev: disk fd=%d opened, part=%d/%d, part_size=%u\n", dev->fd, dev->part, dev->num_parts, dev->part_size);
459       if ((dev->mode != OPEN_READ_ONLY) && ((dev->free_space_errno == 0) || (dev->num_parts == dev->part))) {
460          update_free_space_dev(dev);
461       }
462    }
463    return dev->fd;
464 }
465
466 /* (Un)mount the device */
467 int do_mount_dev(DEVICE* dev, int mount, int dotimeout) {
468    POOL_MEM ocmd(PM_FNAME);
469    POOLMEM* results;
470    results = get_pool_memory(PM_MESSAGE);
471    char* icmd;
472    int status, timeout;
473    
474    if (mount) {
475       icmd = dev->device->mount_command;
476    }
477    else {
478       icmd = dev->device->unmount_command;
479    }
480    
481    edit_device_codes_dev(dev, ocmd.c_str(), icmd);
482    
483    Dmsg2(29, "do_mount_dev: cmd=%s state=%d\n", ocmd.c_str(), dev->state & ST_MOUNTED);
484
485    if (dotimeout) {
486       /* Try at most 5 times to (un)mount the device. This should perhaps be configurable. */
487       timeout = 5;
488    }
489    else {
490       timeout = 0;
491    }
492    /* If busy retry each second */
493    while ((status = run_program_full_output(ocmd.c_str(), dev->max_open_wait/2, results)) != 0) {
494       if (--timeout > 0) {
495          Dmsg2(40, "Device %s cannot be (un)mounted. Retrying... ERR=%s\n", dev->dev_name, results);
496          /* Sometimes the device cannot be mounted because it is already mounted.
497           * Try to unmount it, then remount it */
498          if (mount) {
499             Dmsg1(40, "Trying to unmount the device %s...\n", dev->dev_name);
500             do_mount_dev(dev, 0, 0);
501          }
502          bmicrosleep(1, 0);
503          continue;
504       }
505       free_pool_memory(results);
506       Dmsg2(40, "Device %s cannot be mounted. ERR=%s\n", dev->dev_name, results);
507       return -1;
508    }
509    
510    if (mount) {
511      dev->state |= ST_MOUNTED;
512    }
513    else {
514      dev->state &= ~ST_MOUNTED;
515    }
516    free_pool_memory(results);
517    
518    Dmsg1(29, "do_mount_dev: end_state=%d\n", dev->state & ST_MOUNTED);
519    return 0;
520 }
521
522 /* Only for devices that requires mount.
523  * Try to find the volume name of the loaded device, and open the
524  * first part of this volume. 
525  *
526  * Returns 0 if read_dev_volume_label can now read the label,
527  * -1 if an error occured, and read_dev_volume_label_guess must abort with an IO_ERROR.
528  *
529  * To guess the device name, it lists all the files on the DVD, and searches for a 
530  * file which has a minimum size (500 bytes). If this file has a numeric extension,
531  * like part files, try to open the file which has no extension (e.g. the first
532  * part file).
533  * So, if the DVD does not contains a Bacula volume, a random file is opened,
534  * and no valid label could be read from this file.
535  */
536 int open_guess_name_dev(DEVICE *dev) {
537    Dmsg1(29, "open_guess_name_dev: dev=%s\n", dev->dev_name);
538    POOL_MEM guessedname(PM_FNAME);
539    DIR* dp;
540    struct dirent *entry, *result;
541    struct stat statp;
542    int index;
543    int name_max;
544    
545    if (!dev_cap(dev, CAP_REQMOUNT)) {
546       Dmsg1(100, "open_guess_name_dev: device does not require mount, returning 0. dev=%s\n", dev->dev_name);
547       return 0;
548    }
549
550 #ifndef HAVE_DIRENT_H
551    Dmsg0(29, "open_guess_name_dev: readdir not available, cannot guess volume name\n");
552    return 0; 
553 #endif
554    
555    update_free_space_dev(dev);
556
557    if (mount_dev(dev, 1) < 0) {
558       /* If the device cannot be mounted, check if it is writable */
559       if (dev->free_space_errno >= 0) {
560          Dmsg1(100, "open_guess_name_dev: device cannot be mounted, but it seems to be writable, returning 0. dev=%s\n", dev->dev_name);
561          return 0;
562       }
563       else {
564          Dmsg1(100, "open_guess_name_dev: device cannot be mounted, and is not writable, returning 0. dev=%s\n", dev->dev_name);
565          /* read_dev_volume_label_guess must now check dev->free_space_errno to understand that the media is not writable. */
566          return 0;
567       }
568    }
569       
570    name_max = pathconf(".", _PC_NAME_MAX);
571    if (name_max < 1024) {
572       name_max = 1024;
573    }
574       
575    if (!(dp = opendir(dev->device->mount_point))) {
576       berrno be;
577       dev->dev_errno = errno;
578       Dmsg3(29, "open_guess_name_dev: failed to open dir %s (dev=%s), ERR=%s\n", dev->device->mount_point, dev->dev_name, be.strerror());
579       return -1;
580    }
581    
582    entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 100);
583    while (1) {
584       if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
585          dev->dev_errno = ENOENT;
586          Dmsg2(29, "open_guess_name_dev: failed to find suitable file in dir %s (dev=%s)\n", dev->device->mount_point, dev->dev_name);
587          closedir(dp);
588          return -1;
589       }
590       
591       ASSERT(name_max+1 > (int)sizeof(struct dirent) + (int)NAMELEN(entry));
592       
593       if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0) {
594          continue;
595       }
596       
597       pm_strcpy(guessedname, dev->device->mount_point);
598       if (guessedname.c_str()[strlen(guessedname.c_str())-1] != '/') {
599          pm_strcat(guessedname, "/");
600       }
601       pm_strcat(guessedname, entry->d_name);
602       
603       if (stat(guessedname.c_str(), &statp) < 0) {
604          berrno be;
605          Dmsg3(29, "open_guess_name_dev: failed to stat %s (dev=%s), ERR=%s\n",
606                guessedname.c_str(), dev->dev_name, be.strerror());
607          continue;
608       }
609       
610       if (!S_ISREG(statp.st_mode) || (statp.st_size < 500)) {
611          Dmsg2(100, "open_guess_name_dev: %s is not a regular file, or less than 500 bytes (dev=%s)\n", 
612                guessedname.c_str(), dev->dev_name);
613          continue;
614       }
615       
616       /* Ok, we found a good file, remove the part extension if possible. */
617       for (index = strlen(guessedname.c_str())-1; index >= 0; index--) {
618          if ((guessedname.c_str()[index] == '/') || 
619              (guessedname.c_str()[index] < '0') || 
620              (guessedname.c_str()[index] > '9')) {
621             break;
622          }
623          if (guessedname.c_str()[index] == '.') {
624             guessedname.c_str()[index] = '\0';
625             break;
626          }
627       }
628       
629       if ((stat(guessedname.c_str(), &statp) < 0) || (statp.st_size < 500)) {
630          /* The file with extension truncated does not exists or is too small, so use it with its extension. */
631          berrno be;
632          Dmsg3(100, "open_guess_name_dev: failed to stat %s (dev=%s), using the file with its extension, ERR=%s\n", 
633                guessedname.c_str(), dev->dev_name, be.strerror());
634          pm_strcpy(guessedname, dev->device->mount_point);
635          if (guessedname.c_str()[strlen(guessedname.c_str())-1] != '/') {
636             pm_strcat(guessedname, "/");
637          }
638          pm_strcat(guessedname, entry->d_name);
639          continue;
640       }
641       break;
642    }
643    
644    closedir(dp);
645    
646    if (dev->fd >= 0) {
647       close(dev->fd);
648    }
649      
650    if ((dev->fd = open(guessedname.c_str(), O_RDONLY | O_BINARY)) < 0) {
651       berrno be;
652       dev->dev_errno = errno;
653       Dmsg3(29, "open_guess_name_dev: failed to open %s (dev=%s), ERR=%s\n", 
654             guessedname.c_str(), dev->dev_name, be.strerror());
655       if (open_first_part(dev) < 0) {
656          berrno be;
657          dev->dev_errno = errno;
658          Mmsg1(&dev->errmsg, _("Could not open_first_part, ERR=%s\n"), be.strerror());
659          Emsg0(M_FATAL, 0, dev->errmsg);         
660       }
661       return -1;
662    }
663    dev->part_start = 0;
664    dev->part_size = statp.st_size;
665    dev->part = 0;
666    dev->state |= ST_OPENED;
667    dev->use_count = 1;
668    
669    Dmsg2(29, "open_guess_name_dev: %s opened (dev=%s)\n", guessedname.c_str(), dev->dev_name);
670    
671    return 0;
672 }
673
674 /* Mount the device.
675  * If timeout, wait until the mount command returns 0.
676  * If !timeout, try to mount the device only once.
677  */
678 int mount_dev(DEVICE* dev, int timeout) {
679    if (dev->state & ST_MOUNTED) {
680       Dmsg0(100, "mount_dev: Device already mounted\n");
681       return 0;
682    }
683    else {
684       return do_mount_dev(dev, 1, timeout);
685    }
686 }
687
688 /* Unmount the device
689  * If timeout, wait until the unmount command returns 0.
690  * If !timeout, try to unmount the device only once.
691  */
692 int unmount_dev(DEVICE* dev, int timeout) {
693    if (dev->state & ST_MOUNTED) {
694       return do_mount_dev(dev, 0, timeout);
695    }
696    else {
697       Dmsg0(100, "mount_dev: Device already unmounted\n");
698       return 0;
699    }
700 }
701
702 /* Update the free space on the device */
703 void update_free_space_dev(DEVICE* dev) {
704    POOL_MEM ocmd(PM_FNAME);
705    POOLMEM* results;
706    char* icmd;
707    int timeout;
708    char* statstr;
709    long long int free;
710    
711    icmd = dev->device->free_space_command;
712    
713    if (!icmd) {
714       dev->free_space = 0;
715       dev->free_space_errno = 0;
716       Dmsg2(29, "update_free_space_dev: free_space=%d, free_space_errno=%d (!icmd)\n", dev->free_space, dev->free_space_errno);
717       return;
718    }
719    
720    edit_device_codes_dev(dev, ocmd.c_str(), icmd);
721    
722    Dmsg1(29, "update_free_space_dev: cmd=%s\n", ocmd.c_str());
723
724    results = get_pool_memory(PM_MESSAGE);
725    
726    /* Try at most 3 times to get the free space on the device. This should perhaps be configurable. */
727    timeout = 3;
728    
729    while (1) {
730       if (run_program_full_output(ocmd.c_str(), dev->max_open_wait/2, results) == 0) {
731          Dmsg1(100, "Free space program run : %s\n", results);
732          /* We also need negatives values, so we can't use dev->free_space, which is unsigned */
733          free = strtoll(results, &statstr, 10);
734          if (results != statstr) { /* Something parsed */
735             if (free >= 0) {
736                dev->free_space = free;
737                dev->free_space_errno = 1;
738                Mmsg0(dev->errmsg, "");
739                break;
740             }
741             else {
742                dev->free_space_errno = free;
743                dev->free_space = 0;
744                if (*statstr == '\n') {
745                   statstr++;
746                }
747                if (statstr[strlen(statstr)-1] == '\n') {
748                   statstr[strlen(statstr)-1] = 0;
749                }
750                Mmsg1(dev->errmsg, "Error while getting free space (%s)", statstr);
751             }
752          }
753          else {
754             dev->free_space = 0;
755             dev->free_space_errno = -EPIPE;
756             Mmsg1(dev->errmsg, "Error while getting free space (output=%s)", results);
757          }
758       }
759       else {
760          dev->free_space = 0;
761          dev->free_space_errno = -EPIPE;
762          Mmsg1(dev->errmsg, "Cannot run free space command (%s)", results);
763       }
764       
765       if (--timeout > 0) {
766          Dmsg4(40, "Cannot get free space on device %s. free_space=%lld, free_space_errno=%d ERR=%s\n", dev->dev_name, 
767                dev->free_space, dev->free_space_errno, dev->errmsg);
768          bmicrosleep(1, 0);
769          continue;
770       }
771
772       dev->dev_errno = -dev->free_space_errno;
773       Dmsg4(40, "Cannot get free space on device %s. free_space=%lld, free_space_errno=%d ERR=%s\n",
774             dev->dev_name, dev->free_space, dev->free_space_errno, dev->errmsg);
775       free_pool_memory(results);
776       return;
777    }
778    
779    free_pool_memory(results);
780    
781    Dmsg2(29, "update_free_space_dev: free_space=%lld, free_space_errno=%d\n", dev->free_space, dev->free_space_errno);
782 }
783
784 int write_part(DEVICE *dev) {
785    Dmsg1(29, "write_part: device is %s\n", dev->dev_name);
786    
787    if (unmount_dev(dev, 1) < 0) {
788       Dmsg0(29, "write_part: unable to unmount the device\n");
789    }
790    
791    POOL_MEM ocmd(PM_FNAME);
792    POOLMEM *results;
793    results = get_pool_memory(PM_MESSAGE);
794    char* icmd;
795    int status;
796    int timeout;
797    
798    icmd = dev->device->write_part_command;
799    
800    edit_device_codes_dev(dev, ocmd.c_str(), icmd);
801       
802    /* Wait at most the time a maximum size part is written in DVD 0.5x speed
803     * FIXME: Minimum speed should be in device configuration 
804     */
805    timeout = dev->max_open_wait + (dev->max_part_size/(1350*1024/2));
806    
807    Dmsg2(29, "write_part: cmd=%s timeout=%d\n", ocmd.c_str(), timeout);
808       
809    status = run_program_full_output(ocmd.c_str(), timeout, results);
810    if (status != 0) {
811       Mmsg1(dev->errmsg, "Error while writing current part to the DVD: %s", results);
812       dev->dev_errno = EIO;
813       free_pool_memory(results);
814       return -1;
815    }
816    else {
817       Dmsg1(29, "write_part: command output=%s\n", results);
818       POOL_MEM archive_name(PM_FNAME);
819       get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
820       unlink(archive_name.c_str());
821       free_pool_memory(results);
822       return 0;
823    }
824 }
825
826 /* Open the next part file.
827  *  - Close the fd
828  *  - Increment part number 
829  *  - Reopen the device
830  */
831 int open_next_part(DEVICE *dev) {
832    int state;
833       
834    Dmsg3(29, "open_next_part %s %s %d\n", dev->dev_name, dev->VolCatInfo.VolCatName, dev->openmode);
835    /* When appending, do not open a new part if the current is empty */
836    if ((dev->state & ST_APPEND) && (dev->part == dev->num_parts) && (dev->part_size == 0)) {
837       Dmsg0(29, "open_next_part exited immediatly (dev->part_size == 0).\n");
838       return dev->fd;
839    }
840    
841    if (dev->fd >= 0) {
842       close(dev->fd);
843    }
844    
845    dev->fd = -1;
846    
847    state = dev->state;
848    dev->state &= ~ST_OPENED;
849    
850    if ((dev_cap(dev, CAP_REQMOUNT)) && (dev->part == dev->num_parts) && (dev->state & ST_APPEND)) {
851       if (write_part(dev) < 0) {
852          return -1;
853       }
854    }
855      
856    dev->part_start += dev->part_size;
857    dev->part++;
858    
859    if ((dev->num_parts < dev->part) && (dev->state & ST_APPEND)) {
860       dev->num_parts = dev->part;
861       
862       /* Check that the next part file does not exists.
863        * If it does, move it away... */
864       POOL_MEM archive_name(PM_FNAME);
865       POOL_MEM archive_bkp_name(PM_FNAME);
866       struct stat buf;
867       
868       get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
869       
870       /* Check if the next part exists. */
871       if ((stat(archive_name.c_str(), &buf) == 0) || (errno != ENOENT)) {
872          Dmsg1(29, "open_next_part %s is in the way, moving it away...\n", archive_name.c_str());
873          pm_strcpy(archive_bkp_name, archive_name.c_str());
874          pm_strcat(archive_bkp_name, ".bak");
875          unlink(archive_bkp_name.c_str()); 
876          
877          /* First try to rename it */
878          if (rename(archive_name.c_str(), archive_bkp_name.c_str()) < 0) {
879             berrno be;
880             Dmsg3(29, "open_next_part can't rename %s to %s, ERR=%s\n", 
881                   archive_name.c_str(), archive_bkp_name.c_str(), be.strerror());
882             /* Then try to unlink it */
883             if (unlink(archive_name.c_str()) < 0) {
884                berrno be;
885                dev->dev_errno = errno;
886                Mmsg2(&dev->errmsg, _("open_next_part can't unlink existing part %s, ERR=%s\n"), 
887                       archive_name.c_str(), be.strerror());
888                Emsg0(M_FATAL, 0, dev->errmsg);
889                return -1;
890             }
891          }
892       }
893    }
894    
895    if (open_dev(dev, dev->VolCatInfo.VolCatName, dev->openmode) < 0) {
896       return -1;
897    }
898    else {
899       dev->state = state;
900       return dev->fd;
901    }
902 }
903
904 /* Open the first part file.
905  *  - Close the fd
906  *  - Reopen the device
907  */
908 int open_first_part(DEVICE *dev) {
909    int state;
910       
911    Dmsg3(29, "open_first_part %s %s %d\n", dev->dev_name, dev->VolCatInfo.VolCatName, dev->openmode);
912    if (dev->fd >= 0) {
913       close(dev->fd);
914    }
915    
916    dev->fd = -1;
917    state = dev->state;
918    dev->state &= ~ST_OPENED;
919    
920    dev->part_start = 0;
921    dev->part = 0;
922    
923    if (open_dev(dev, dev->VolCatInfo.VolCatName, dev->openmode)) {
924       dev->state = state;
925       return dev->fd;
926    }
927    else {
928       return 0;
929    }
930 }
931
932 #ifdef debug_tracing
933 #undef rewind_dev
934 bool _rewind_dev(char *file, int line, DEVICE *dev)
935 {
936    Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
937    return rewind_dev(dev);
938 }
939 #endif
940
941 /* Protected version of lseek, which opens the right part if necessary */
942 off_t lseek_dev(DEVICE *dev, off_t offset, int whence) {
943    int pos, openmode;
944    
945    if (dev->num_parts == 0) { /* If there is only one part, simply call lseek. */
946       return lseek(dev->fd, offset, whence);
947    }
948       
949    switch(whence) {
950       case SEEK_SET:
951          Dmsg1(100, "lseek_dev SEEK_SET called %d\n", offset);
952          if ((uint64_t)offset >= dev->part_start) {
953             if ((uint64_t)(offset - dev->part_start) < dev->part_size) {
954                /* We are staying in the current part, just seek */
955                if ((pos = lseek(dev->fd, (off_t)(offset-dev->part_start), SEEK_SET)) < 0) {
956                   return pos;   
957                }
958                else {
959                   return pos + dev->part_start;
960                }
961             }
962             else {
963                /* Load next part, and start again */
964                if (open_next_part(dev) < 0) {
965                   Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
966                   return -1;
967                }
968                return lseek_dev(dev, offset, SEEK_SET);
969             }
970          }
971          else {
972             /* pos < dev->part_start :
973              * We need to access a previous part, 
974              * so just load the first one, and seek again
975              * until the right one is loaded */
976             if (open_first_part(dev) < 0) {
977                Dmsg0(100, "lseek_dev failed while trying to open the first part\n");
978                return -1;
979             }
980             return lseek_dev(dev, offset, SEEK_SET);
981          }
982          break;
983       case SEEK_CUR:
984          Dmsg1(100, "lseek_dev SEEK_CUR called %d\n", offset);
985          if ((pos = lseek(dev->fd, (off_t)0, SEEK_CUR)) < 0) {
986             return pos;   
987          }
988          pos += dev->part_start;
989          if (offset == 0) {
990             return pos;
991          }
992          else { /* Not used in Bacula, but should work */
993             return lseek_dev(dev, pos, SEEK_SET);
994          }
995          break;
996       case SEEK_END:
997          Dmsg1(100, "lseek_dev SEEK_END called %d\n", offset);
998          if (offset > 0) { /* Not used by bacula */
999             Dmsg1(100, "lseek_dev SEEK_END called with an invalid offset %d\n", offset);
1000             errno = EINVAL;
1001             return -1;
1002          }
1003          
1004          if (dev->part == dev->num_parts) { /* The right part is already loaded */
1005             if ((pos = lseek(dev->fd, (off_t)0, SEEK_END)) < 0) {
1006                return pos;   
1007             }
1008             else {
1009                return pos + dev->part_start;
1010             }
1011          }
1012          else {
1013             /* Load the first part, then load the next until we reach the last one.
1014              * This is the only way to be sure we compute the right file address. */
1015             /* Save previous openmode, and open all but last part read-only (useful for DVDs) */
1016             openmode = dev->openmode;
1017             dev->openmode = OPEN_READ_ONLY;
1018             
1019             /* Works because num_parts > 0. */
1020             if (open_first_part(dev) < 0) {
1021                Dmsg0(100, "lseek_dev failed while trying to open the first part\n");
1022                return -1;
1023             }
1024             while (dev->part < (dev->num_parts-1)) {
1025                if (open_next_part(dev) < 0) {
1026                   Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
1027                   return -1;
1028                }
1029             }
1030             dev->openmode = openmode;
1031             if (open_next_part(dev) < 0) {
1032                Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
1033                return -1;
1034             }
1035             return lseek_dev(dev, 0, SEEK_END);
1036          }
1037          break;
1038       default:
1039          errno = EINVAL;
1040          return -1;
1041    }
1042 }
1043
1044 /*
1045  * Rewind the device.
1046  *  Returns: true  on success
1047  *           false on failure
1048  */
1049 bool rewind_dev(DEVICE *dev)
1050 {
1051    struct mtop mt_com;
1052    unsigned int i;
1053
1054    Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
1055    if (dev->fd < 0) {
1056       dev->dev_errno = EBADF;
1057       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
1058             dev->dev_name);
1059       Emsg0(M_ABORT, 0, dev->errmsg);
1060       return false;
1061    }
1062    dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
1063    dev->block_num = dev->file = 0;
1064    dev->file_size = 0;
1065    dev->file_addr = 0;
1066    if (dev->state & ST_TAPE) {
1067       mt_com.mt_op = MTREW;
1068       mt_com.mt_count = 1;
1069       /* If we get an I/O error on rewind, it is probably because
1070        * the drive is actually busy. We loop for (about 5 minutes)
1071        * retrying every 5 seconds.
1072        */
1073       for (i=dev->max_rewind_wait; ; i -= 5) {
1074          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1075             berrno be;
1076             clrerror_dev(dev, MTREW);
1077             if (i == dev->max_rewind_wait) {
1078                Dmsg1(200, "Rewind error, %s. retrying ...\n", be.strerror());
1079             }
1080             if (dev->dev_errno == EIO && i > 0) {
1081                Dmsg0(200, "Sleeping 5 seconds.\n");
1082                bmicrosleep(5, 0);
1083                continue;
1084             }
1085             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
1086                dev->dev_name, be.strerror());
1087             return false;
1088          }
1089          break;
1090       }
1091    } else if (dev->state & ST_FILE) {      
1092       if (lseek_dev(dev, (off_t)0, SEEK_SET) < 0) {
1093          berrno be;
1094          dev->dev_errno = errno;
1095          Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1096             dev->dev_name, be.strerror());
1097          return false;
1098       }
1099    }
1100    return true;
1101 }
1102
1103 /*
1104  * Position device to end of medium (end of data)
1105  *  Returns: 1 on succes
1106  *           0 on error
1107  */
1108 int
1109 eod_dev(DEVICE *dev)
1110 {
1111    struct mtop mt_com;
1112    struct mtget mt_stat;
1113    int stat = 0;
1114    off_t pos;
1115
1116    Dmsg0(29, "eod_dev\n");
1117    if (dev->state & ST_EOT) {
1118       return 1;
1119    }
1120    dev->state &= ~(ST_EOF);  /* remove EOF flags */
1121    dev->block_num = dev->file = 0;
1122    dev->file_size = 0;
1123    dev->file_addr = 0;
1124    if (dev->state & (ST_FIFO | ST_PROG)) {
1125       return 1;
1126    }
1127    if (!(dev->state & ST_TAPE)) {
1128       pos = lseek_dev(dev, (off_t)0, SEEK_END);
1129 //    Dmsg1(100, "====== Seek to %lld\n", pos);
1130       if (pos >= 0) {
1131          update_pos_dev(dev);
1132          dev->state |= ST_EOT;
1133          return 1;
1134       }
1135       dev->dev_errno = errno;
1136       berrno be;
1137       Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1138              dev->dev_name, be.strerror());
1139       return 0;
1140    }
1141 #ifdef MTEOM
1142
1143    if (dev_cap(dev, CAP_MTIOCGET) && dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
1144       struct mtget mt_stat;
1145       Dmsg0(100,"Using FAST FSF for EOM\n");
1146       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
1147         if (!rewind_dev(dev)) {
1148           return 0;
1149         }
1150       }
1151       mt_com.mt_op = MTFSF;
1152       /*
1153        * ***FIXME*** fix code to handle case that INT16_MAX is
1154        *   not large enough.
1155        */
1156       mt_com.mt_count = INT16_MAX;    /* use big positive number */
1157       if (mt_com.mt_count < 0) {
1158          mt_com.mt_count = INT16_MAX; /* brain damaged system */
1159       }
1160    }
1161
1162    if (dev_cap(dev, CAP_MTIOCGET) && (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM))) {
1163       if (dev_cap(dev, CAP_EOM)) {
1164          Dmsg0(100,"Using EOM for EOM\n");
1165          mt_com.mt_op = MTEOM;
1166          mt_com.mt_count = 1;
1167       }
1168
1169       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
1170          berrno be;
1171          clrerror_dev(dev, mt_com.mt_op);
1172          Dmsg1(50, "ioctl error: %s\n", be.strerror());
1173          update_pos_dev(dev);
1174          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
1175             dev->dev_name, be.strerror());
1176          return 0;
1177       }
1178
1179       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1180          berrno be;
1181          clrerror_dev(dev, -1);
1182          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
1183             dev->dev_name, be.strerror());
1184          return 0;
1185       }
1186       Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1187       dev->file = mt_stat.mt_fileno;
1188
1189    /*
1190     * Rewind then use FSF until EOT reached
1191     */
1192    } else {
1193 #else
1194    {
1195 #endif
1196       if (!rewind_dev(dev)) {
1197          return 0;
1198       }
1199       /*
1200        * Move file by file to the end of the tape
1201        */
1202       int file_num;
1203       for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
1204          Dmsg0(200, "eod_dev: doing fsf 1\n");
1205          if (!fsf_dev(dev, 1)) {
1206             Dmsg0(200, "fsf_dev error.\n");
1207             return 0;
1208          }
1209          /*
1210           * Avoid infinite loop. ***FIXME*** possibly add code
1211           *   to set EOD or to turn off CAP_FASTFSF if on.
1212           */
1213          if (file_num == (int)dev->file) {
1214             struct mtget mt_stat;
1215             Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
1216             if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
1217                       mt_stat.mt_fileno >= 0) {
1218                Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
1219                dev->file = mt_stat.mt_fileno;
1220             }
1221             stat = 0;
1222             break;                    /* we are not progressing, bail out */
1223          }
1224       }
1225    }
1226    /*
1227     * Some drivers leave us after second EOF when doing
1228     * MTEOM, so we must backup so that appending overwrites
1229     * the second EOF.
1230     */
1231    if (dev_cap(dev, CAP_BSFATEOM)) {
1232       struct mtget mt_stat;
1233       /* Backup over EOF */
1234       stat = bsf_dev(dev, 1);
1235       /* If BSF worked and fileno is known (not -1), set file */
1236       if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1237          Dmsg2(100, "BSFATEOF adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
1238          dev->file = mt_stat.mt_fileno;
1239       } else {
1240          dev->file++;                 /* wing it -- not correct on all OSes */
1241       }
1242    } else {
1243       update_pos_dev(dev);                   /* update position */
1244       stat = 1;
1245    }
1246    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
1247    return stat;
1248 }
1249
1250 /*
1251  * Set the position of the device -- only for files
1252  *   For other devices, there is no generic way to do it.
1253  *  Returns: true  on succes
1254  *           false on error
1255  */
1256 bool update_pos_dev(DEVICE *dev)
1257 {
1258    off_t pos;
1259    bool ok = true;
1260
1261    if (dev->fd < 0) {
1262       dev->dev_errno = EBADF;
1263       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
1264       Emsg0(M_FATAL, 0, dev->errmsg);
1265       return false;
1266    }
1267
1268    /* Find out where we are */
1269    if (dev->state & ST_FILE) {
1270       dev->file = 0;
1271       dev->file_addr = 0;
1272       pos = lseek_dev(dev, (off_t)0, SEEK_CUR);
1273       if (pos < 0) {
1274          berrno be;
1275          dev->dev_errno = errno;
1276          Pmsg1(000, "Seek error: ERR=%s\n", be.strerror());
1277          Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1278             dev->dev_name, be.strerror());
1279          ok = false;
1280       } else {
1281          dev->file_addr = pos;
1282       }
1283    }
1284    return ok;
1285 }
1286
1287
1288 /*
1289  * Return the status of the device.  This was meant
1290  * to be a generic routine. Unfortunately, it doesn't
1291  * seem possible (at least I do not know how to do it
1292  * currently), which means that for the moment, this
1293  * routine has very little value.
1294  *
1295  *   Returns: status
1296  */
1297 uint32_t status_dev(DEVICE *dev)
1298 {
1299    struct mtget mt_stat;
1300    uint32_t stat = 0;
1301
1302    if (dev->state & (ST_EOT | ST_WEOT)) {
1303       stat |= BMT_EOD;
1304       Dmsg0(-20, " EOD");
1305    }
1306    if (dev->state & ST_EOF) {
1307       stat |= BMT_EOF;
1308       Dmsg0(-20, " EOF");
1309    }
1310    if (dev->state & ST_TAPE) {
1311       stat |= BMT_TAPE;
1312       Dmsg0(-20," Bacula status:");
1313       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
1314       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1315          berrno be;
1316          dev->dev_errno = errno;
1317          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
1318             dev->dev_name, be.strerror());
1319          return 0;
1320       }
1321       Dmsg0(-20, " Device status:");
1322
1323 #if defined(HAVE_LINUX_OS)
1324       if (GMT_EOF(mt_stat.mt_gstat)) {
1325          stat |= BMT_EOF;
1326          Dmsg0(-20, " EOF");
1327       }
1328       if (GMT_BOT(mt_stat.mt_gstat)) {
1329          stat |= BMT_BOT;
1330          Dmsg0(-20, " BOT");
1331       }
1332       if (GMT_EOT(mt_stat.mt_gstat)) {
1333          stat |= BMT_EOT;
1334          Dmsg0(-20, " EOT");
1335       }
1336       if (GMT_SM(mt_stat.mt_gstat)) {
1337          stat |= BMT_SM;
1338          Dmsg0(-20, " SM");
1339       }
1340       if (GMT_EOD(mt_stat.mt_gstat)) {
1341          stat |= BMT_EOD;
1342          Dmsg0(-20, " EOD");
1343       }
1344       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1345          stat |= BMT_WR_PROT;
1346          Dmsg0(-20, " WR_PROT");
1347       }
1348       if (GMT_ONLINE(mt_stat.mt_gstat)) {
1349          stat |= BMT_ONLINE;
1350          Dmsg0(-20, " ONLINE");
1351       }
1352       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1353          stat |= BMT_DR_OPEN;
1354          Dmsg0(-20, " DR_OPEN");
1355       }
1356       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1357          stat |= BMT_IM_REP_EN;
1358          Dmsg0(-20, " IM_REP_EN");
1359       }
1360 #endif /* !SunOS && !OSF */
1361       if (dev_cap(dev, CAP_MTIOCGET)) {
1362          Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1363       } else {
1364          Dmsg2(-20, " file=%d block=%d\n", -1, -1);
1365       }
1366    } else {
1367       stat |= BMT_ONLINE | BMT_BOT;
1368    }
1369    return stat;
1370 }
1371
1372
1373 /*
1374  * Load medium in device
1375  *  Returns: true  on success
1376  *           false on failure
1377  */
1378 bool load_dev(DEVICE *dev)
1379 {
1380 #ifdef MTLOAD
1381    struct mtop mt_com;
1382 #endif
1383
1384    if (dev->fd < 0) {
1385       dev->dev_errno = EBADF;
1386       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
1387       Emsg0(M_FATAL, 0, dev->errmsg);
1388       return false;
1389    }
1390    if (!(dev->state & ST_TAPE)) {
1391       return true;
1392    }
1393 #ifndef MTLOAD
1394    Dmsg0(200, "stored: MTLOAD command not available\n");
1395    berrno be;
1396    dev->dev_errno = ENOTTY;           /* function not available */
1397    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1398          dev->dev_name, be.strerror());
1399    return false;
1400 #else
1401
1402    dev->block_num = dev->file = 0;
1403    dev->file_size = 0;
1404    dev->file_addr = 0;
1405    mt_com.mt_op = MTLOAD;
1406    mt_com.mt_count = 1;
1407    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1408       berrno be;
1409       dev->dev_errno = errno;
1410       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1411          dev->dev_name, be.strerror());
1412       return false;
1413    }
1414    return true;
1415 #endif
1416 }
1417
1418 /*
1419  * Rewind device and put it offline
1420  *  Returns: true  on success
1421  *           false on failure
1422  */
1423 bool offline_dev(DEVICE *dev)
1424 {
1425    struct mtop mt_com;
1426
1427    if (dev->fd < 0) {
1428       dev->dev_errno = EBADF;
1429       Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
1430       Emsg0(M_FATAL, 0, dev->errmsg);
1431       return false;
1432    }
1433    if (!(dev->state & ST_TAPE)) {
1434       return true;
1435    }
1436
1437    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
1438    dev->block_num = dev->file = 0;
1439    dev->file_size = 0;
1440    dev->file_addr = 0;
1441    dev->part = 0;
1442 #ifdef MTUNLOCK
1443    mt_com.mt_op = MTUNLOCK;
1444    mt_com.mt_count = 1;
1445    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1446 #endif
1447    mt_com.mt_op = MTOFFL;
1448    mt_com.mt_count = 1;
1449    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1450       berrno be;
1451       dev->dev_errno = errno;
1452       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
1453          dev->dev_name, be.strerror());
1454       return false;
1455    }
1456    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
1457    return true;
1458 }
1459
1460 bool offline_or_rewind_dev(DEVICE *dev)
1461 {
1462    if (dev->fd < 0) {
1463       return false;
1464    }
1465    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
1466       return offline_dev(dev);
1467    } else {
1468    /*
1469     * Note, this rewind probably should not be here (it wasn't
1470     *  in prior versions of Bacula), but on FreeBSD, this is
1471     *  needed in the case the tape was "frozen" due to an error
1472     *  such as backspacing after writing and EOF. If it is not
1473     *  done, all future references to the drive get and I/O error.
1474     */
1475       clrerror_dev(dev, MTREW);
1476       return rewind_dev(dev);
1477    }
1478 }
1479
1480 /*
1481  * Foward space a file
1482  *   Returns: true  on success
1483  *            false on failure
1484  */
1485 bool
1486 fsf_dev(DEVICE *dev, int num)
1487 {
1488    struct mtget mt_stat;
1489    struct mtop mt_com;
1490    int stat = 0;
1491
1492    if (dev->fd < 0) {
1493       dev->dev_errno = EBADF;
1494       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1495       Emsg0(M_FATAL, 0, dev->errmsg);
1496       return false;
1497    }
1498
1499    if (!(dev->state & ST_TAPE)) {
1500       return true;
1501    }
1502    if (dev->state & ST_EOT) {
1503       dev->dev_errno = 0;
1504       Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
1505       return false;
1506    }
1507    if (dev->state & ST_EOF) {
1508       Dmsg0(200, "ST_EOF set on entry to FSF\n");
1509    }
1510
1511    Dmsg0(100, "fsf_dev\n");
1512    dev->block_num = 0;
1513    /*
1514     * If Fast forward space file is set, then we
1515     *  use MTFSF to forward space and MTIOCGET
1516     *  to get the file position. We assume that
1517     *  the SCSI driver will ensure that we do not
1518     *  forward space past the end of the medium.
1519     */
1520    if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_MTIOCGET) && dev_cap(dev, CAP_FASTFSF)) {
1521       mt_com.mt_op = MTFSF;
1522       mt_com.mt_count = num;
1523       stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1524       if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1525          berrno be;
1526          dev->state |= ST_EOT;
1527          Dmsg0(200, "Set ST_EOT\n");
1528          clrerror_dev(dev, MTFSF);
1529          Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1530             dev->dev_name, be.strerror());
1531          Dmsg1(200, "%s", dev->errmsg);
1532          return false;
1533       }
1534       Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1535       dev->file = mt_stat.mt_fileno;
1536       dev->state |= ST_EOF;     /* just read EOF */
1537       dev->file_addr = 0;
1538       dev->file_size = 0;
1539       return true;
1540
1541    /*
1542     * Here if CAP_FSF is set, and virtually all drives
1543     *  these days support it, we read a record, then forward
1544     *  space one file. Using this procedure, which is slow,
1545     *  is the only way we can be sure that we don't read
1546     *  two consecutive EOF marks, which means End of Data.
1547     */
1548    } else if (dev_cap(dev, CAP_FSF)) {
1549       POOLMEM *rbuf;
1550       int rbuf_len;
1551       Dmsg0(200, "FSF has cap_fsf\n");
1552       if (dev->max_block_size == 0) {
1553          rbuf_len = DEFAULT_BLOCK_SIZE;
1554       } else {
1555          rbuf_len = dev->max_block_size;
1556       }
1557       rbuf = get_memory(rbuf_len);
1558       mt_com.mt_op = MTFSF;
1559       mt_com.mt_count = 1;
1560       while (num-- && !(dev->state & ST_EOT)) {
1561          Dmsg0(100, "Doing read before fsf\n");
1562          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
1563             if (errno == ENOMEM) {     /* tape record exceeds buf len */
1564                stat = rbuf_len;        /* This is OK */
1565             } else {
1566                berrno be;
1567                dev->state |= ST_EOT;
1568                clrerror_dev(dev, -1);
1569                Dmsg2(100, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
1570                   be.strerror());
1571                Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
1572                   dev->dev_name, be.strerror());
1573                Dmsg1(100, "%s", dev->errmsg);
1574                break;
1575             }
1576          }
1577          if (stat == 0) {                /* EOF */
1578             update_pos_dev(dev);
1579             Dmsg1(100, "End of File mark from read. File=%d\n", dev->file+1);
1580             /* Two reads of zero means end of tape */
1581             if (dev->state & ST_EOF) {
1582                dev->state |= ST_EOT;
1583                Dmsg0(100, "Set ST_EOT\n");
1584                break;
1585             } else {
1586                dev->state |= ST_EOF;
1587                dev->file++;
1588                dev->file_addr = 0;
1589                dev->file_size = 0;
1590                continue;
1591             }
1592          } else {                        /* Got data */
1593             dev->state &= ~(ST_EOF|ST_EOT);
1594          }
1595
1596          Dmsg0(100, "Doing MTFSF\n");
1597          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1598          if (stat < 0) {                 /* error => EOT */
1599             berrno be;
1600             dev->state |= ST_EOT;
1601             Dmsg0(100, "Set ST_EOT\n");
1602             clrerror_dev(dev, MTFSF);
1603             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1604                dev->dev_name, be.strerror());
1605             Dmsg0(100, "Got < 0 for MTFSF\n");
1606             Dmsg1(100, "%s", dev->errmsg);
1607          } else {
1608             dev->state |= ST_EOF;     /* just read EOF */
1609             dev->file++;
1610             dev->file_addr = 0;
1611             dev->file_size = 0;
1612          }
1613       }
1614       free_memory(rbuf);
1615
1616    /*
1617     * No FSF, so use FSR to simulate it
1618     */
1619    } else {
1620       Dmsg0(200, "Doing FSR for FSF\n");
1621       while (num-- && !(dev->state & ST_EOT)) {
1622          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
1623       }
1624       if (dev->state & ST_EOT) {
1625          dev->dev_errno = 0;
1626          Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
1627          stat = -1;
1628       } else {
1629          stat = 0;
1630       }
1631    }
1632    update_pos_dev(dev);
1633    Dmsg1(200, "Return %d from FSF\n", stat);
1634    if (dev->state & ST_EOF)
1635       Dmsg0(200, "ST_EOF set on exit FSF\n");
1636    if (dev->state & ST_EOT)
1637       Dmsg0(200, "ST_EOT set on exit FSF\n");
1638    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
1639    return stat == 0;
1640 }
1641
1642 /*
1643  * Backward space a file
1644  *  Returns: false on failure
1645  *           true  on success
1646  */
1647 bool
1648 bsf_dev(DEVICE *dev, int num)
1649 {
1650    struct mtop mt_com;
1651    int stat;
1652
1653    if (dev->fd < 0) {
1654       dev->dev_errno = EBADF;
1655       Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
1656       Emsg0(M_FATAL, 0, dev->errmsg);
1657       return false;
1658    }
1659
1660    if (!(dev_state(dev, ST_TAPE))) {
1661       Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
1662          dev->dev_name);
1663       return false;
1664    }
1665    Dmsg0(29, "bsf_dev\n");
1666    dev->state &= ~(ST_EOT|ST_EOF);
1667    dev->file -= num;
1668    dev->file_addr = 0;
1669    dev->file_size = 0;
1670    mt_com.mt_op = MTBSF;
1671    mt_com.mt_count = num;
1672    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1673    if (stat < 0) {
1674       berrno be;
1675       clrerror_dev(dev, MTBSF);
1676       Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
1677          dev->dev_name, be.strerror());
1678    }
1679    update_pos_dev(dev);
1680    return stat == 0;
1681 }
1682
1683
1684 /*
1685  * Foward space a record
1686  *  Returns: false on failure
1687  *           true  on success
1688  */
1689 bool
1690 fsr_dev(DEVICE *dev, int num)
1691 {
1692    struct mtop mt_com;
1693    int stat;
1694
1695    if (dev->fd < 0) {
1696       dev->dev_errno = EBADF;
1697       Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
1698       Emsg0(M_FATAL, 0, dev->errmsg);
1699       return false;
1700    }
1701
1702    if (!(dev_state(dev, ST_TAPE))) {
1703       return false;
1704    }
1705    if (!dev_cap(dev, CAP_FSR)) {
1706       Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
1707       return false;
1708    }
1709
1710    Dmsg1(29, "fsr_dev %d\n", num);
1711    mt_com.mt_op = MTFSR;
1712    mt_com.mt_count = num;
1713    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1714    if (stat == 0) {
1715       dev->state &= ~ST_EOF;
1716       dev->block_num += num;
1717    } else {
1718       berrno be;
1719       struct mtget mt_stat;
1720       clrerror_dev(dev, MTFSR);
1721       Dmsg1(100, "FSF fail: ERR=%s\n", be.strerror());
1722       if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1723          Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1724             dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1725          dev->file = mt_stat.mt_fileno;
1726          dev->block_num = mt_stat.mt_blkno;
1727       } else {
1728          if (dev->state & ST_EOF) {
1729             dev->state |= ST_EOT;
1730          } else {
1731             dev->state |= ST_EOF;           /* assume EOF */
1732             dev->file++;
1733             dev->block_num = 0;
1734             dev->file_addr = 0;
1735             dev->file_size = 0;
1736          }
1737       }
1738       Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1739          dev->dev_name, be.strerror());
1740    }
1741    update_pos_dev(dev);
1742    return stat == 0;
1743 }
1744
1745 /*
1746  * Backward space a record
1747  *   Returns:  false on failure
1748  *             true  on success
1749  */
1750 bool
1751 bsr_dev(DEVICE *dev, int num)
1752 {
1753    struct mtop mt_com;
1754    int stat;
1755
1756    if (dev->fd < 0) {
1757       dev->dev_errno = EBADF;
1758       Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1759       Emsg0(M_FATAL, 0, dev->errmsg);
1760       return false;
1761    }
1762
1763    if (!(dev->state & ST_TAPE)) {
1764       return false;
1765    }
1766
1767    if (!dev_cap(dev, CAP_BSR)) {
1768       Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1769       return false;
1770    }
1771
1772    Dmsg0(29, "bsr_dev\n");
1773    dev->block_num -= num;
1774    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1775    mt_com.mt_op = MTBSR;
1776    mt_com.mt_count = num;
1777    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1778    if (stat < 0) {
1779       berrno be;
1780       clrerror_dev(dev, MTBSR);
1781       Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1782          dev->dev_name, be.strerror());
1783    }
1784    update_pos_dev(dev);
1785    return stat == 0;
1786 }
1787
1788 /*
1789  * Reposition the device to file, block
1790  * Returns: false on failure
1791  *          true  on success
1792  */
1793 bool
1794 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1795 {
1796    if (dev->fd < 0) {
1797       dev->dev_errno = EBADF;
1798       Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1799       Emsg0(M_FATAL, 0, dev->errmsg);
1800       return false;
1801    }
1802
1803    if (!(dev_state(dev, ST_TAPE))) {
1804       off_t pos = (((off_t)file)<<32) + block;
1805       Dmsg1(100, "===== lseek_dev to %d\n", (int)pos);
1806       if (lseek_dev(dev, pos, SEEK_SET) == (off_t)-1) {
1807          berrno be;
1808          dev->dev_errno = errno;
1809          Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1810             dev->dev_name, be.strerror());
1811          return false;
1812       }
1813       dev->file = file;
1814       dev->block_num = block;
1815       dev->file_addr = pos;
1816       return true;
1817    }
1818    Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1819       dev->file, dev->block_num, file, block);
1820    if (file < dev->file) {
1821       Dmsg0(100, "Rewind_dev\n");
1822       if (!rewind_dev(dev)) {
1823          return false;
1824       }
1825    }
1826    if (file > dev->file) {
1827       Dmsg1(100, "fsf %d\n", file-dev->file);
1828       if (!fsf_dev(dev, file-dev->file)) {
1829          Dmsg1(100, "fsf failed! ERR=%s\n", strerror_dev(dev));
1830          return false;
1831       }
1832       Dmsg2(100, "wanted_file=%d at_file=%d\n", file, dev->file);
1833    }
1834    if (block < dev->block_num) {
1835       Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1836       Dmsg0(100, "bsf_dev 1\n");
1837       bsf_dev(dev, 1);
1838       Dmsg0(100, "fsf_dev 1\n");
1839       fsf_dev(dev, 1);
1840       Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1841    }
1842    if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1843       /* Ignore errors as Bacula can read to the correct block */
1844       Dmsg1(100, "fsr %d\n", block-dev->block_num);
1845       return fsr_dev(dev, block-dev->block_num);
1846    }
1847    return true;
1848 }
1849
1850
1851
1852 /*
1853  * Write an end of file on the device
1854  *   Returns: 0 on success
1855  *            non-zero on failure
1856  */
1857 int
1858 weof_dev(DEVICE *dev, int num)
1859 {
1860    struct mtop mt_com;
1861    int stat;
1862    Dmsg0(29, "weof_dev\n");
1863    
1864    if (dev->fd < 0) {
1865       dev->dev_errno = EBADF;
1866       Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1867       Emsg0(M_FATAL, 0, dev->errmsg);
1868       return -1;
1869    }
1870    dev->file_size = 0;
1871
1872    if (!(dev_state(dev, ST_TAPE))) {
1873       return 0;
1874    }
1875    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
1876    mt_com.mt_op = MTWEOF;
1877    mt_com.mt_count = num;
1878    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1879    if (stat == 0) {
1880       dev->block_num = 0;
1881       dev->file += num;
1882       dev->file_addr = 0;
1883    } else {
1884       berrno be;
1885       clrerror_dev(dev, MTWEOF);
1886       if (stat == -1) {
1887          Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1888             dev->dev_name, be.strerror());
1889        }
1890    }
1891    return stat;
1892 }
1893
1894 /*
1895  * Return string message with last error in English
1896  *  Be careful not to call this routine from within dev.c
1897  *  while editing an Mmsg() or you will end up in a recursive
1898  *  loop creating a Segmentation Violation.
1899  */
1900 char *
1901 strerror_dev(DEVICE *dev)
1902 {
1903    return dev->errmsg;
1904 }
1905
1906
1907 /*
1908  * If implemented in system, clear the tape
1909  * error status.
1910  */
1911 void
1912 clrerror_dev(DEVICE *dev, int func)
1913 {
1914    const char *msg = NULL;
1915    struct mtget mt_stat;
1916
1917    dev->dev_errno = errno;         /* save errno */
1918    if (errno == EIO) {
1919       dev->VolCatInfo.VolCatErrors++;
1920    }
1921
1922    if (!(dev->state & ST_TAPE)) {
1923       return;
1924    }
1925    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1926       switch (func) {
1927       case -1:
1928          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1929          break;
1930       case MTWEOF:
1931          msg = "WTWEOF";
1932          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1933          break;
1934 #ifdef MTEOM
1935       case MTEOM:
1936          msg = "WTEOM";
1937          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1938          break;
1939 #endif
1940       case MTFSF:
1941          msg = "MTFSF";
1942          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1943          break;
1944       case MTBSF:
1945          msg = "MTBSF";
1946          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1947          break;
1948       case MTFSR:
1949          msg = "MTFSR";
1950          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1951          break;
1952       case MTBSR:
1953          msg = "MTBSR";
1954          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1955          break;
1956       default:
1957          msg = "Unknown";
1958          break;
1959       }
1960       if (msg != NULL) {
1961          dev->dev_errno = ENOSYS;
1962          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1963          Emsg0(M_ERROR, 0, dev->errmsg);
1964       }
1965    }
1966    /* On some systems such as NetBSD, this clears all errors */
1967    ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1968
1969 /* Found on Linux */
1970 #ifdef MTIOCLRERR
1971 {
1972    struct mtop mt_com;
1973    mt_com.mt_op = MTIOCLRERR;
1974    mt_com.mt_count = 1;
1975    /* Clear any error condition on the tape */
1976    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1977    Dmsg0(200, "Did MTIOCLRERR\n");
1978 }
1979 #endif
1980
1981 /* Typically on FreeBSD */
1982 #ifdef MTIOCERRSTAT
1983 {
1984    /* Read and clear SCSI error status */
1985    union mterrstat mt_errstat;
1986    Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1987       strerror(dev->dev_errno));
1988    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1989 }
1990 #endif
1991
1992 /* Clear Subsystem Exception OSF1 */
1993 #ifdef MTCSE
1994 {
1995    struct mtop mt_com;
1996    mt_com.mt_op = MTCSE;
1997    mt_com.mt_count = 1;
1998    /* Clear any error condition on the tape */
1999    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
2000    Dmsg0(200, "Did MTCSE\n");
2001 }
2002 #endif
2003 }
2004
2005 /*
2006  * Flush buffer contents
2007  *  No longer used.
2008  */
2009 int flush_dev(DEVICE *dev)
2010 {
2011    return 1;
2012 }
2013
2014 static void do_close(DEVICE *dev)
2015 {
2016
2017    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
2018    if (dev->fd >= 0) {
2019       close(dev->fd);
2020    }
2021    if (dev_cap(dev, CAP_REQMOUNT)) {
2022       if (unmount_dev(dev, 1) < 0) {
2023          Dmsg1(0, "Cannot unmount device %s.\n", dev->dev_name);
2024       }
2025    }
2026    
2027    /* Remove the last part file if it is empty */
2028    if ((dev->state & ST_APPEND) && (dev->num_parts > 0)) {
2029       struct stat statp;
2030       POOL_MEM archive_name(PM_FNAME);
2031       dev->part = dev->num_parts;
2032       get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
2033       /* Check that the part file is empty */
2034       if ((stat(archive_name.c_str(), &statp) == 0) && (statp.st_size == 0)) {
2035          unlink(archive_name.c_str());
2036       }
2037    }
2038    
2039    /* Clean up device packet so it can be reused */
2040    dev->fd = -1;
2041    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
2042    dev->file = dev->block_num = 0;
2043    dev->file_size = 0;
2044    dev->file_addr = 0;
2045    dev->part = 0;
2046    dev->part_size = 0;
2047    dev->part_start = 0;
2048    dev->EndFile = dev->EndBlock = 0;
2049    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
2050    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
2051    if (dev->tid) {
2052       stop_thread_timer(dev->tid);
2053       dev->tid = 0;
2054    }
2055    dev->use_count = 0;
2056 }
2057
2058 /*
2059  * Close the device
2060  */
2061 void
2062 close_dev(DEVICE *dev)
2063 {
2064    if (!dev) {
2065       Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
2066       Emsg0(M_FATAL, 0, dev->errmsg);
2067       return;
2068    }
2069    /*if (dev->fd >= 0 && dev->use_count == 1) {*/
2070    /* No need to check if dev->fd >= 0: it is checked again
2071     * in do_close, and do_close MUST be called for volumes
2072     * splitted in parts, even if dev->fd == -1. */
2073    if (dev->use_count == 1) {
2074       do_close(dev);
2075    } else if (dev->use_count > 0) {
2076       dev->use_count--;
2077    }
2078
2079 #ifdef FULL_DEBUG
2080    ASSERT(dev->use_count >= 0);
2081 #endif
2082 }
2083
2084 /*
2085  * Used when unmounting the device, ignore use_count
2086  */
2087 void force_close_dev(DEVICE *dev)
2088 {
2089    if (!dev) {
2090       Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
2091       Emsg0(M_FATAL, 0, dev->errmsg);
2092       return;
2093    }
2094    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
2095    do_close(dev);
2096
2097 #ifdef FULL_DEBUG
2098    ASSERT(dev->use_count >= 0);
2099 #endif
2100 }
2101
2102 bool truncate_dev(DEVICE *dev)
2103 {
2104    Dmsg1(100, "truncate_dev %s\n", dev->dev_name);
2105    if (dev->state & ST_TAPE) {
2106       return true;                    /* we don't really truncate tapes */
2107       /* maybe we should rewind and write and eof ???? */
2108    }
2109    
2110    /* If there is more than one part, open the first one, and then truncate it. */
2111    if (dev->num_parts > 0) {
2112       dev->num_parts = 0;
2113       dev->VolCatInfo.VolCatParts = 0;
2114       if (open_first_part(dev) < 0) {
2115          berrno be;
2116          Mmsg1(&dev->errmsg, "Unable to truncate device, because I'm unable to open the first part. ERR=%s\n", be.strerror());
2117       }
2118    }
2119    
2120    if (ftruncate(dev->fd, 0) != 0) {
2121       berrno be;
2122       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), be.strerror());
2123       return false;
2124    }
2125    return true;
2126 }
2127
2128 bool
2129 dev_is_tape(DEVICE *dev)
2130 {
2131    return (dev->state & ST_TAPE) ? true : false;
2132 }
2133
2134
2135 /*
2136  * return 1 if the device is read for write, and 0 otherwise
2137  *   This is meant for checking at the end of a job to see
2138  *   if we still have a tape (perhaps not if at end of tape
2139  *   and the job is canceled).
2140  */
2141 bool
2142 dev_can_write(DEVICE *dev)
2143 {
2144    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
2145        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
2146       return true;
2147    } else {
2148       return false;
2149    }
2150 }
2151
2152 char *
2153 dev_name(DEVICE *dev)
2154 {
2155    return dev->dev_name;
2156 }
2157
2158 char *
2159 dev_vol_name(DEVICE *dev)
2160 {
2161    return dev->VolCatInfo.VolCatName;
2162 }
2163
2164 uint32_t dev_block(DEVICE *dev)
2165 {
2166    update_pos_dev(dev);
2167    return dev->block_num;
2168 }
2169
2170 uint32_t dev_file(DEVICE *dev)
2171 {
2172    update_pos_dev(dev);
2173    return dev->file;
2174 }
2175
2176 /*
2177  * Free memory allocated for the device
2178  */
2179 void
2180 term_dev(DEVICE *dev)
2181 {
2182    if (!dev) {
2183       dev->dev_errno = EBADF;
2184       Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
2185       Emsg0(M_FATAL, 0, dev->errmsg);
2186       return;
2187    }
2188    do_close(dev);
2189    Dmsg0(29, "term_dev\n");
2190    if (dev->dev_name) {
2191       free_memory(dev->dev_name);
2192       dev->dev_name = NULL;
2193    }
2194    if (dev->errmsg) {
2195       free_pool_memory(dev->errmsg);
2196       dev->errmsg = NULL;
2197    }
2198    pthread_mutex_destroy(&dev->mutex);
2199    pthread_cond_destroy(&dev->wait);
2200    pthread_cond_destroy(&dev->wait_next_vol);
2201    pthread_mutex_destroy(&dev->spool_mutex);
2202    rwl_destroy(&dev->lock);
2203    if (dev->attached_dcrs) {
2204       delete dev->attached_dcrs;
2205       dev->attached_dcrs = NULL;
2206    }
2207    if (dev->state & ST_MALLOC) {
2208       free_pool_memory((POOLMEM *)dev);
2209    }
2210 }
2211
2212 /*
2213  * This routine initializes the device wait timers
2214  */
2215 void init_dev_wait_timers(DEVICE *dev)
2216 {
2217    /* ******FIXME******* put these on config variables */
2218    dev->min_wait = 60 * 60;
2219    dev->max_wait = 24 * 60 * 60;
2220    dev->max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
2221    dev->wait_sec = dev->min_wait;
2222    dev->rem_wait_sec = dev->wait_sec;
2223    dev->num_wait = 0;
2224    dev->poll = false;
2225    dev->BadVolName[0] = 0;
2226 }
2227
2228 /*
2229  * Returns: true if time doubled
2230  *          false if max time expired
2231  */
2232 bool double_dev_wait_time(DEVICE *dev)
2233 {
2234    dev->wait_sec *= 2;               /* double wait time */
2235    if (dev->wait_sec > dev->max_wait) {   /* but not longer than maxtime */
2236       dev->wait_sec = dev->max_wait;
2237    }
2238    dev->num_wait++;
2239    dev->rem_wait_sec = dev->wait_sec;
2240    if (dev->num_wait >= dev->max_num_wait) {
2241       return false;
2242    }
2243    return true;
2244 }
2245
2246 void set_os_device_parameters(DEVICE *dev)
2247 {
2248 #ifdef HAVE_LINUX_OS
2249    struct mtop mt_com;
2250    if (dev->min_block_size == dev->max_block_size &&
2251        dev->min_block_size == 0) {    /* variable block mode */
2252       mt_com.mt_op = MTSETBLK;
2253       mt_com.mt_count = 0;
2254       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2255          clrerror_dev(dev, MTSETBLK);
2256       }
2257       mt_com.mt_op = MTSETDRVBUFFER;
2258       mt_com.mt_count = MT_ST_CLEARBOOLEANS;
2259       if (!dev_cap(dev, CAP_TWOEOF)) {
2260          mt_com.mt_count |= MT_ST_TWO_FM;
2261       }
2262       if (dev_cap(dev, CAP_EOM)) {
2263          mt_com.mt_count |= MT_ST_FAST_MTEOM;
2264       }
2265       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2266          clrerror_dev(dev, MTSETBLK);
2267       }
2268    }
2269    return;
2270 #endif
2271
2272 #ifdef HAVE_NETBSD_OS
2273    struct mtop mt_com;
2274    if (dev->min_block_size == dev->max_block_size &&
2275        dev->min_block_size == 0) {    /* variable block mode */
2276       mt_com.mt_op = MTSETBSIZ;
2277       mt_com.mt_count = 0;
2278       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2279          clrerror_dev(dev, MTSETBSIZ);
2280       }
2281       /* Get notified at logical end of tape */
2282       mt_com.mt_op = MTEWARN;
2283       mt_com.mt_count = 1;
2284       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2285          clrerror_dev(dev, MTEWARN);
2286       }
2287    }
2288    return;
2289 #endif
2290
2291 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
2292    struct mtop mt_com;
2293    if (dev->min_block_size == dev->max_block_size &&
2294        dev->min_block_size == 0) {    /* variable block mode */
2295       mt_com.mt_op = MTSETBSIZ;
2296       mt_com.mt_count = 0;
2297       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2298          clrerror_dev(dev, MTSETBSIZ);
2299       }
2300    }
2301    return;
2302 #endif
2303
2304 #ifdef HAVE_SUN_OS
2305    struct mtop mt_com;
2306    if (dev->min_block_size == dev->max_block_size &&
2307        dev->min_block_size == 0) {    /* variable block mode */
2308       mt_com.mt_op = MTSRSZ;
2309       mt_com.mt_count = 0;
2310       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2311          clrerror_dev(dev, MTSRSZ);
2312       }
2313    }
2314    return;
2315 #endif
2316 }
2317
2318 /*
2319  * Edit codes into (Un)MountCommand, Write(First)PartCommand
2320  *  %% = %
2321  *  %a = archive device name
2322  *  %m = mount point
2323  *  %v = last part name
2324  *
2325  *  omsg = edited output message
2326  *  imsg = input string containing edit codes (%x)
2327  *
2328  */
2329 char *edit_device_codes_dev(DEVICE* dev, char *omsg, const char *imsg)
2330 {
2331    const char *p;
2332    const char *str;
2333    char add[20];
2334    
2335    POOL_MEM archive_name(PM_FNAME);
2336    get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
2337
2338    *omsg = 0;
2339    Dmsg1(800, "edit_device_codes: %s\n", imsg);
2340    for (p=imsg; *p; p++) {
2341       if (*p == '%') {
2342          switch (*++p) {
2343             case '%':
2344                str = "%";
2345                break;
2346             case 'n':
2347                bsnprintf(add, sizeof(add), "%d", dev->part);
2348                str = add;
2349                break;
2350             case 'a':
2351                str = dev->dev_name;
2352                break;
2353             case 'm':
2354                str = dev->device->mount_point;
2355                break;
2356             case 'v':
2357                str = archive_name.c_str();
2358                break;
2359             default:
2360                add[0] = '%';
2361                add[1] = *p;
2362                add[2] = 0;
2363                str = add;
2364                break;
2365          }
2366       } else {
2367          add[0] = *p;
2368          add[1] = 0;
2369          str = add;
2370       }
2371       Dmsg1(900, "add_str %s\n", str);
2372       pm_strcat(&omsg, (char *)str);
2373       Dmsg1(800, "omsg=%s\n", omsg);
2374    }
2375    return omsg;
2376 }