/*
* Copyright (c) 2007-2012 Zmanda, Inc. All Rights Reserved.
* Copyright (c) 2013-2016 Carbonite, Inc. All Rights Reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Contact information: Carbonite Inc., 756 N Pastoria Ave
* Sunnyvale, CA 94085, or: http://www.zmanda.com
*/
#include "amanda.h"
#include "pipespawn.h"
#include <string.h> /* memset() */
#include "amutil.h"
#include "device.h"
#ifdef HAVE_SYS_TAPE_H
# include <sys/tape.h>
#endif
#ifdef HAVE_SYS_MTIO_H
# include <sys/mtio.h>
#endif
#ifdef HAVE_LIMITS_H
# include <limits.h>
#endif
/* This is equal to 2*1024*1024*1024 - 16*1024*1024 - 1, but written
explicitly to avoid overflow issues. */
#define RESETOFS_THRESHOLD (0x7effffff)
/* Largest possible block size on SCSI systems. */
#define LARGEST_BLOCK_ESTIMATE (16 * 1024 * 1024)
/*
* Type checking and casting macros
*/
#define TYPE_TAPE_DEVICE (tape_device_get_type())
#define TAPE_DEVICE(obj) G_TYPE_CHECK_INSTANCE_CAST((obj), tape_device_get_type(), TapeDevice)
#define TAPE_DEVICE_CONST(obj) G_TYPE_CHECK_INSTANCE_CAST((obj), tape_device_get_type(), TapeDevice const)
#define TAPE_DEVICE_CLASS(klass) G_TYPE_CHECK_CLASS_CAST((klass), tape_device_get_type(), TapeDeviceClass)
#define IS_TAPE_DEVICE(obj) G_TYPE_CHECK_INSTANCE_TYPE((obj), tape_device_get_type ())
#define TAPE_DEVICE_GET_CLASS(obj) G_TYPE_INSTANCE_GET_CLASS((obj), tape_device_get_type(), TapeDeviceClass)
GType tape_device_get_type (void);
/*
* Main object structure
*/
typedef struct TapeDevicePrivate_s TapeDevicePrivate;
typedef struct _TapeDevice {
Device __parent__;
/* It should go without saying that all this stuff is
* look-but-don't-touch. */
/* characteristics of the device */
gboolean fsf, bsf, fsr, bsr, eom, bsf_after_eom, broken_gmt_online;
gboolean leom;
gboolean nonblocking_open, fsf_after_filemark;
int final_filemarks;
/* 0 if we opened with O_RDWR; error otherwise. */
gboolean write_open_errno;
int fd;
TapeDevicePrivate * private;
} TapeDevice;
struct TapeDevicePrivate_s {
/* This holds the total number of bytes written to the device,
modulus RESETOFS_THRESHOLD. */
int write_count;
char * device_filename;
gsize read_block_size;
};
/*
* Class definition
*/
typedef struct _TapeDeviceClass TapeDeviceClass;
struct _TapeDeviceClass {
DeviceClass __parent__;
};
void tape_device_register(void);
/* useful callback for tape ops */
void tape_device_set_capabilities(TapeDevice *self,
gboolean fsf, PropertySurety fsf_surety, PropertySource fsf_source,
gboolean fsf_after_filemark, PropertySurety faf_surety, PropertySource faf_source,
gboolean bsf, PropertySurety bsf_surety, PropertySource bsf_source,
gboolean fsr, PropertySurety fsr_surety, PropertySource fsr_source,
gboolean bsr, PropertySurety bsr_surety, PropertySource bsr_source,
gboolean eom, PropertySurety eom_surety, PropertySource eom_source,
gboolean leom, PropertySurety leom_surety, PropertySource leom_source,
gboolean bsf_after_eom, PropertySurety bae_surety, PropertySource bae_source,
guint final_filemarks, PropertySurety ff_surety, PropertySource ff_source);
/* Real Operations (always return FALSE if not implemented) */
gboolean tape_rewind(int fd);
gboolean tape_fsf(int fd, guint count);
gboolean tape_bsf(int fd, guint count);
gboolean tape_fsr(int fd, guint count);
gboolean tape_bsr(int fd, guint count);
gint tape_fileno(int fd);
/* tape_fileno returns tape position file number, or one of these: */
#define TAPE_OP_ERROR -1
#define TAPE_POSITION_UNKNOWN -2
/* Possible (abstracted) results from a system I/O operation. */
typedef enum {
RESULT_SUCCESS,
RESULT_ERROR, /* Undefined error (*errmsg set) */
RESULT_SMALL_BUFFER, /* Tried to read with a buffer that is too
small. */
RESULT_NO_DATA, /* End of File, while reading */
RESULT_NO_SPACE, /* Out of space. Sometimes we don't know if
it was this or I/O error, but this is the
preferred explanation. */
RESULT_MAX
} IoResult;
/* returns a fileno like tape_fileno */
gint tape_eod(int fd);
gboolean tape_weof(int fd, guint8 count);
gboolean tape_setcompression(int fd, gboolean on);
gboolean tape_offl(int fd);
DeviceStatusFlags tape_is_tape_device(int fd);
DeviceStatusFlags get_tape_blocksize(int fd, guint64 *tape_blocksize);
DeviceStatusFlags tape_is_ready(int fd, TapeDevice *t_self);
#define tape_device_read_size(self) \
(((TapeDevice *)(self))->private->read_block_size? \
((TapeDevice *)(self))->private->read_block_size : ((Device *)(self))->block_size)
/*
* Our device-specific properties.
*/
#define PROPERTY_BROKEN_GMT_ONLINE (device_property_broken_gmt_online.ID)
#define PROPERTY_FSF (device_property_fsf.ID)
#define PROPERTY_FSF_AFTER_FILEMARK (device_property_fsf_after_filemark.ID)
#define PROPERTY_BSF (device_property_bsf.ID)
#define PROPERTY_FSR (device_property_fsr.ID)
#define PROPERTY_BSR (device_property_bsr.ID)
#define PROPERTY_EOM (device_property_eom.ID)
#define PROPERTY_BSF_AFTER_EOM (device_property_bsf_after_eom.ID)
#define PROPERTY_NONBLOCKING_OPEN (device_property_nonblocking_open.ID)
#define PROPERTY_FINAL_FILEMARKS (device_property_final_filemarks.ID)
static DevicePropertyBase device_property_broken_gmt_online;
static DevicePropertyBase device_property_fsf;
static DevicePropertyBase device_property_fsf_after_filemark;
static DevicePropertyBase device_property_bsf;
static DevicePropertyBase device_property_fsr;
static DevicePropertyBase device_property_bsr;
static DevicePropertyBase device_property_eom;
static DevicePropertyBase device_property_bsf_after_eom;
static DevicePropertyBase device_property_nonblocking_open;
static DevicePropertyBase device_property_final_filemarks;
static DevicePropertyBase device_property_read_buffer_size; /* old name for READ_BLOCK_SIZE */
/* here are local prototypes */
static void tape_device_init (TapeDevice * o);
static void tape_device_class_init (TapeDeviceClass * c);
static void tape_device_base_init (TapeDeviceClass * c);
static gboolean tape_device_set_feature_property_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source);
static gboolean tape_device_set_final_filemarks_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source);
static gboolean tape_device_set_compression_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source);
static gboolean tape_device_get_read_block_size_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety *surety, PropertySource *source);
static gboolean tape_device_set_read_block_size_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source);
static void tape_device_open_device (Device * self, char * device_name, char * device_type, char * device_node);
static Device * tape_device_factory (char * device_name, char * device_type, char * device_node);
static DeviceStatusFlags tape_device_read_label(Device * self);
static DeviceWriteResult tape_device_write_block(Device * self, guint size,
gpointer data);
static int tape_device_read_block(Device * self, gpointer buf,
int * size_req, int max_block);
static gboolean tape_device_start (Device * self, DeviceAccessMode mode,
char * label, char * timestamp);
static gboolean tape_device_start_file (Device * self, dumpfile_t * ji);
static gboolean tape_device_finish_file (Device * self);
static dumpfile_t * tape_device_seek_file (Device * self, guint file);
static gboolean tape_device_seek_block (Device * self, guint64 block);
static gboolean tape_device_eject (Device * self);
static gboolean tape_device_finish (Device * self);
static gboolean tape_device_check_writable(Device *self);
static IoResult tape_device_robust_read (TapeDevice * self, void * buf,
int * count, char **errmsg);
static IoResult tape_device_robust_write (TapeDevice * self, void * buf, int count, char **errmsg);
static gboolean tape_device_fsf (TapeDevice * self, guint count);
static gboolean tape_device_fsr (TapeDevice * self, guint count);
static gboolean tape_device_bsr (TapeDevice * self, guint count, guint file, guint block);
static gboolean tape_device_eod (TapeDevice * self);
/* pointer to the class of our parent */
static DeviceClass *parent_class = NULL;
GType tape_device_get_type (void)
{
static GType type = 0;
if (G_UNLIKELY(type == 0)) {
static const GTypeInfo info = {
sizeof (TapeDeviceClass),
(GBaseInitFunc) tape_device_base_init,
(GBaseFinalizeFunc) NULL,
(GClassInitFunc) tape_device_class_init,
(GClassFinalizeFunc) NULL,
NULL /* class_data */,
sizeof (TapeDevice),
0 /* n_preallocs */,
(GInstanceInitFunc) tape_device_init,
NULL
};
type = g_type_register_static (TYPE_DEVICE, "TapeDevice",
&info, (GTypeFlags)0);
}
return type;
}
static void
tape_device_init (TapeDevice * self) {
Device * d_self;
GValue response;
d_self = DEVICE(self);
bzero(&response, sizeof(response));
self->private = g_new0(TapeDevicePrivate, 1);
/* Clear all fields. */
d_self->block_size = 32768;
d_self->min_block_size = 32768;
d_self->max_block_size = LARGEST_BLOCK_ESTIMATE;
self->broken_gmt_online = FALSE;
self->fd = -1;
/* set all of the feature properties to an unsure default of FALSE */
self->broken_gmt_online = FALSE;
self->fsf = FALSE;
self->bsf = FALSE;
self->fsr = FALSE;
self->bsr = FALSE;
self->eom = FALSE;
self->leom = FALSE;
self->bsf_after_eom = FALSE;
g_value_init(&response, G_TYPE_BOOLEAN);
g_value_set_boolean(&response, FALSE);
device_set_simple_property(d_self, PROPERTY_BROKEN_GMT_ONLINE,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_FSF,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_FSF_AFTER_FILEMARK,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_BSF,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_FSR,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_BSR,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_EOM,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_LEOM,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
device_set_simple_property(d_self, PROPERTY_BSF_AFTER_EOM,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
#ifdef DEFAULT_TAPE_NON_BLOCKING_OPEN
self->nonblocking_open = TRUE;
#else
self->nonblocking_open = FALSE;
#endif
g_value_set_boolean(&response, self->nonblocking_open);
device_set_simple_property(d_self, PROPERTY_NONBLOCKING_OPEN,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
g_value_unset(&response);
self->final_filemarks = 2;
g_value_init(&response, G_TYPE_UINT);
g_value_set_uint(&response, self->final_filemarks);
device_set_simple_property(d_self, PROPERTY_FINAL_FILEMARKS,
&response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
g_value_unset(&response);
self->private->read_block_size = 0;
g_value_init(&response, G_TYPE_UINT);
g_value_set_uint(&response, self->private->read_block_size);
device_set_simple_property(d_self, PROPERTY_READ_BLOCK_SIZE,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DEFAULT);
g_value_unset(&response);
self->private->write_count = 0;
self->private->device_filename = NULL;
/* Static properites */
g_value_init(&response, CONCURRENCY_PARADIGM_TYPE);
g_value_set_enum(&response, CONCURRENCY_PARADIGM_EXCLUSIVE);
device_set_simple_property(d_self, PROPERTY_CONCURRENCY,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
g_value_init(&response, STREAMING_REQUIREMENT_TYPE);
g_value_set_enum(&response, STREAMING_REQUIREMENT_DESIRED);
device_set_simple_property(d_self, PROPERTY_STREAMING,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
g_value_init(&response, G_TYPE_BOOLEAN);
g_value_set_boolean(&response, TRUE);
device_set_simple_property(d_self, PROPERTY_APPENDABLE,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
g_value_init(&response, G_TYPE_BOOLEAN);
g_value_set_boolean(&response, FALSE);
device_set_simple_property(d_self, PROPERTY_PARTIAL_DELETION,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
g_value_init(&response, G_TYPE_BOOLEAN);
g_value_set_boolean(&response, FALSE);
device_set_simple_property(d_self, PROPERTY_FULL_DELETION,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
g_value_init(&response, MEDIA_ACCESS_MODE_TYPE);
g_value_set_enum(&response, MEDIA_ACCESS_MODE_READ_WRITE);
device_set_simple_property(d_self, PROPERTY_MEDIUM_ACCESS_TYPE,
&response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&response);
}
static void tape_device_finalize(GObject * obj_self) {
TapeDevice * self = TAPE_DEVICE(obj_self);
if(G_OBJECT_CLASS(parent_class)->finalize) \
(* G_OBJECT_CLASS(parent_class)->finalize)(obj_self);
robust_close(self->fd);
self->fd = -1;
amfree(self->private->device_filename);
amfree(self->private);
}
static void
tape_device_class_init (TapeDeviceClass * c)
{
DeviceClass *device_class = (DeviceClass *)c;
GObjectClass *g_object_class = (GObjectClass *)c;
parent_class = g_type_class_ref (TYPE_DEVICE);
device_class->open_device = tape_device_open_device;
device_class->read_label = tape_device_read_label;
device_class->write_block = tape_device_write_block;
device_class->read_block = tape_device_read_block;
device_class->start = tape_device_start;
device_class->start_file = tape_device_start_file;
device_class->finish_file = tape_device_finish_file;
device_class->seek_file = tape_device_seek_file;
device_class->seek_block = tape_device_seek_block;
device_class->eject = tape_device_eject;
device_class->finish = tape_device_finish;
device_class->check_writable = tape_device_check_writable;
g_object_class->finalize = tape_device_finalize;
}
static void
tape_device_base_init (TapeDeviceClass * c)
{
DeviceClass *device_class = (DeviceClass *)c;
device_class_register_property(device_class, PROPERTY_BROKEN_GMT_ONLINE,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_FSF,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_FSF_AFTER_FILEMARK,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_BSF,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_FSR,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_BSR,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_EOM,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_BSF_AFTER_EOM,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_NONBLOCKING_OPEN,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
device_class_register_property(device_class, PROPERTY_FINAL_FILEMARKS,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_final_filemarks_fn);
/* We don't (yet?) support reading the device's compression state, so not
* gettable. */
device_class_register_property(device_class, PROPERTY_COMPRESSION,
PROPERTY_ACCESS_SET_MASK,
NULL,
tape_device_set_compression_fn);
device_class_register_property(device_class, PROPERTY_READ_BLOCK_SIZE,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
tape_device_get_read_block_size_fn,
tape_device_set_read_block_size_fn);
device_class_register_property(device_class, device_property_read_buffer_size.ID,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
tape_device_get_read_block_size_fn,
tape_device_set_read_block_size_fn);
/* add the ability to set LEOM to FALSE, for testing purposes */
device_class_register_property(device_class, PROPERTY_LEOM,
PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
device_simple_property_get_fn,
tape_device_set_feature_property_fn);
}
static gboolean
tape_device_set_feature_property_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source)
{
TapeDevice *self = TAPE_DEVICE(p_self);
GValue old_val;
gboolean old_bool, new_bool;
PropertySurety old_surety;
PropertySource old_source;
new_bool = g_value_get_boolean(val);
/* get the old source and surety and see if we're willing to make this change */
bzero(&old_val, sizeof(old_val));
if (device_get_simple_property(p_self, base->ID, &old_val, &old_surety, &old_source)) {
old_bool = g_value_get_boolean(&old_val);
if (old_surety == PROPERTY_SURETY_GOOD && old_source == PROPERTY_SOURCE_DETECTED) {
if (new_bool != old_bool) {
device_set_error(p_self, g_strdup_printf(_(
"Value for property '%s' was autodetected and cannot be changed"),
base->name),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
} else {
/* pretend we set it, but don't change surety/source */
return TRUE;
}
}
}
/* (note: PROPERTY_* are not constants, so we can't use switch) */
if (base->ID == PROPERTY_BROKEN_GMT_ONLINE)
self->broken_gmt_online = new_bool;
else if (base->ID == PROPERTY_FSF)
self->fsf = new_bool;
else if (base->ID == PROPERTY_FSF_AFTER_FILEMARK)
self->fsf_after_filemark = new_bool;
else if (base->ID == PROPERTY_BSF)
self->bsf = new_bool;
else if (base->ID == PROPERTY_FSR)
self->fsr = new_bool;
else if (base->ID == PROPERTY_BSR)
self->bsr = new_bool;
else if (base->ID == PROPERTY_EOM)
self->eom = new_bool;
else if (base->ID == PROPERTY_BSF_AFTER_EOM)
self->bsf_after_eom = new_bool;
else if (base->ID == PROPERTY_NONBLOCKING_OPEN)
self->nonblocking_open = new_bool;
else if (base->ID == PROPERTY_LEOM)
self->leom = new_bool;
else
return FALSE; /* shouldn't happen */
return device_simple_property_set_fn(p_self, base, val, surety, source);
}
static gboolean
tape_device_set_final_filemarks_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source)
{
TapeDevice *self = TAPE_DEVICE(p_self);
GValue old_val;
gboolean old_int, new_int;
PropertySurety old_surety;
PropertySource old_source;
new_int = g_value_get_uint(val);
/* get the old source and surety and see if we're willing to make this change */
bzero(&old_val, sizeof(old_val));
if (device_get_simple_property(p_self, base->ID, &old_val, &old_surety, &old_source)) {
old_int = g_value_get_uint(&old_val);
if (old_surety == PROPERTY_SURETY_GOOD && old_source == PROPERTY_SOURCE_DETECTED) {
if (new_int != old_int) {
device_set_error(p_self, g_strdup_printf(_(
"Value for property '%s' was autodetected and cannot be changed"),
base->name),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
} else {
/* pretend we set it, but don't change surety/source */
return TRUE;
}
}
}
self->final_filemarks = new_int;
return device_simple_property_set_fn(p_self, base, val, surety, source);
}
static gboolean
tape_device_set_compression_fn(Device *p_self, DevicePropertyBase *base,
GValue *val, PropertySurety surety, PropertySource source)
{
TapeDevice *self = TAPE_DEVICE(p_self);
gboolean request = g_value_get_boolean(val);
/* We allow this property to be set at any time. This is mostly
* because setting compression is a hit-and-miss proposition
* at any time; some drives accept the mode setting but don't
* actually support compression, while others do support
* compression but do it via density settings or some other
* way. Set this property whenever you want, but all we'll do
* is report whether or not the ioctl succeeded. */
if (tape_setcompression(self->fd, request)) {
/* looks good .. let's start the device over, though */
device_clear_volume_details(p_self);
} else {
device_set_error(p_self,
g_strdup("Error setting COMPRESSION property"),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
return device_simple_property_set_fn(p_self, base, val, surety, source);
}
static gboolean
tape_device_get_read_block_size_fn(Device *p_self, DevicePropertyBase *base G_GNUC_UNUSED,
GValue *val, PropertySurety *surety, PropertySource *source)
{
/* use the READ_BLOCK_SIZE, even if we're invoked to get the old READ_BUFFER_SIZE */
return device_simple_property_get_fn(p_self, &device_property_read_block_size,
val, surety, source);
}
static gboolean
tape_device_set_read_block_size_fn(Device *p_self, DevicePropertyBase *base G_GNUC_UNUSED,
GValue *val, PropertySurety surety, PropertySource source)
{
TapeDevice *self = TAPE_DEVICE(p_self);
guint read_block_size = g_value_get_uint(val);
if (read_block_size != 0 &&
((gsize)read_block_size < p_self->block_size ||
(gsize)read_block_size > p_self->max_block_size)) {
device_set_error(p_self,
g_strdup_printf("Error setting READ-BLOCk-SIZE property to '%u', it must be between %zu and %zu", read_block_size, p_self->block_size, p_self->max_block_size),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
self->private->read_block_size = read_block_size;
/* use the READ_BLOCK_SIZE, even if we're invoked to get the old READ_BUFFER_SIZE */
return device_simple_property_set_fn(p_self, &device_property_read_block_size,
val, surety, source);
}
void tape_device_register(void) {
static const char * device_prefix_list[] = { "tape", NULL };
/* First register tape-specific properties */
device_property_fill_and_register(&device_property_broken_gmt_online,
G_TYPE_BOOLEAN, "broken_gmt_online",
"Does this drive support the GMT_ONLINE macro?");
device_property_fill_and_register(&device_property_fsf,
G_TYPE_BOOLEAN, "fsf",
"Does this drive support the MTFSF command?");
device_property_fill_and_register(&device_property_fsf_after_filemark,
G_TYPE_BOOLEAN, "fsf_after_filemark",
"Does this drive needs a FSF if a filemark is already read?");
device_property_fill_and_register(&device_property_bsf,
G_TYPE_BOOLEAN, "bsf",
"Does this drive support the MTBSF command?" );
device_property_fill_and_register(&device_property_fsr,
G_TYPE_BOOLEAN, "fsr",
"Does this drive support the MTFSR command?");
device_property_fill_and_register(&device_property_bsr,
G_TYPE_BOOLEAN, "bsr",
"Does this drive support the MTBSR command?");
device_property_fill_and_register(&device_property_eom,
G_TYPE_BOOLEAN, "eom",
"Does this drive support the MTEOM command?");
device_property_fill_and_register(&device_property_bsf_after_eom,
G_TYPE_BOOLEAN,
"bsf_after_eom",
"Does this drive require an MTBSF after MTEOM in order to append?" );
device_property_fill_and_register(&device_property_nonblocking_open,
G_TYPE_BOOLEAN,
"nonblocking_open",
"Does this drive require a open with O_NONBLOCK?" );
device_property_fill_and_register(&device_property_final_filemarks,
G_TYPE_UINT, "final_filemarks",
"How many filemarks to write after the last tape file?" );
device_property_fill_and_register(&device_property_read_buffer_size,
G_TYPE_UINT, "read_buffer_size",
"(deprecated name for READ_BLOCK_SIZE)");
/* Then the device itself */
register_device(tape_device_factory, device_prefix_list);
}
/* Open the tape device, trying various combinations of O_RDWR and
O_NONBLOCK. Returns -1 and calls device_set_error for errors
On Linux, with O_NONBLOCK, the kernel just checks the state once,
whereas it checks it every second for ST_BLOCK_SECONDS if O_NONBLOCK is
not given. Amanda already have the code to poll, we want open to check
the state only once. */
static int try_open_tape_device(TapeDevice * self, char * device_filename) {
int fd;
int save_errno;
DeviceStatusFlags new_status;
guint64 tape_blocksize;
#ifdef O_NONBLOCK
int nonblocking = 0;
if (self->nonblocking_open) {
nonblocking = O_NONBLOCK;
}
#endif
#ifdef O_NONBLOCK
fd = robust_open(device_filename, O_RDWR | nonblocking, 0);
save_errno = errno;
if (fd < 0 && nonblocking && (save_errno == EWOULDBLOCK || save_errno == EINVAL)) {
/* Maybe we don't support O_NONBLOCK for tape devices. */
fd = robust_open(device_filename, O_RDWR, 0);
save_errno = errno;
}
#else
fd = robust_open(device_filename, O_RDWR, 0);
save_errno = errno;
#endif
if (fd >= 0) {
self->write_open_errno = 0;
} else {
if (errno == EACCES || errno == EPERM
#ifdef EROFS
|| errno == EROFS
#endif
) {
/* Device is write-protected. */
self->write_open_errno = errno;
#ifdef O_NONBLOCK
fd = robust_open(device_filename, O_RDONLY | nonblocking, 0);
save_errno = errno;
if (fd < 0 && nonblocking && (save_errno == EWOULDBLOCK || save_errno == EINVAL)) {
fd = robust_open(device_filename, O_RDONLY, 0);
save_errno = errno;
}
#else
fd = robust_open(device_filename, O_RDONLY, 0);
save_errno = errno;
#endif
}
}
#ifdef O_NONBLOCK
/* Clear O_NONBLOCK for operations from now on. */
if (fd >= 0 && nonblocking) {
int r = fcntl(fd, F_GETFL, 0);
if (r < 0) {
device_set_error(DEVICE(self),
g_strdup_printf("Can't fcntl(F_GETFL) on %s: %s", self->private->device_filename, strerror(errno)),
DEVICE_STATUS_DEVICE_BUSY | DEVICE_STATUS_DEVICE_ERROR);
}
r = fcntl(fd, F_SETFL, r & ~O_NONBLOCK);
if (r < 0) {
device_set_error(DEVICE(self),
g_strdup_printf("Can't fcntl(F_SETFL) on %s: %s", self->private->device_filename, strerror(errno)),
DEVICE_STATUS_DEVICE_BUSY | DEVICE_STATUS_DEVICE_ERROR);
}
}
errno = save_errno;
/* function continues after #endif */
#endif /* O_NONBLOCK */
if (fd < 0) {
DeviceStatusFlags status_flag = 0;
if (errno == EBUSY)
status_flag = DEVICE_STATUS_DEVICE_BUSY;
else
status_flag = DEVICE_STATUS_DEVICE_ERROR;
device_set_error(DEVICE(self),
g_strdup_printf(_("Can't open tape device %s: %s"), self->private->device_filename, strerror(errno)),
status_flag);
return -1;
}
/* Check that this is actually a tape device. */
new_status = tape_is_tape_device(fd);
if (new_status & DEVICE_STATUS_DEVICE_ERROR) {
device_set_error(DEVICE(self),
g_strdup_printf(_("File %s is not a tape device"), self->private->device_filename),
new_status);
robust_close(fd);
return -1;
}
if (new_status & DEVICE_STATUS_VOLUME_MISSING) {
device_set_error(DEVICE(self),
g_strdup_printf(_("Tape device %s is not ready or is empty"), self->private->device_filename),
new_status);
robust_close(fd);
return -1;
}
new_status = tape_is_ready(fd, self);
if (new_status & DEVICE_STATUS_VOLUME_MISSING) {
device_set_error(DEVICE(self),
g_strdup_printf(_("Tape device %s is empty"), self->private->device_filename),
new_status);
robust_close(fd);
return -1;
}
if (new_status != DEVICE_STATUS_SUCCESS) {
device_set_error(DEVICE(self),
g_strdup_printf(_("Tape device %s is not ready or is empty"), self->private->device_filename),
new_status);
robust_close(fd);
return -1;
}
new_status = get_tape_blocksize(fd, &tape_blocksize);
if (new_status != DEVICE_STATUS_SUCCESS) {
device_set_error(DEVICE(self),
g_strdup_printf(_("Can't get the blocksize of the device %s"),
self->private->device_filename),
new_status);
robust_close(fd);
return -1;
}
if (tape_blocksize > 0 && tape_blocksize != tape_device_read_size(self)) {
device_set_error(DEVICE(self),
g_strdup_printf(_("Device %s use fixed block size of %lld and tapetype use %lld"),
self->private->device_filename,
(long long)tape_blocksize,
(long long)tape_device_read_size(self)),
DEVICE_STATUS_VOLUME_ERROR|DEVICE_STATUS_DEVICE_ERROR);
robust_close(fd);
return -1;
}
if (tape_blocksize == 0) {
g_debug("Device is in variable block size");
} else {
g_debug("Device is in fixed block size of %lld", (long long)tape_blocksize);
}
return fd;
}
static void
tape_device_open_device (Device * dself, char * device_name,
char * device_type, char * device_node) {
TapeDevice * self;
GValue val;
self = TAPE_DEVICE(dself);
self->fd = -1;
self->private->device_filename = g_strdup(device_node);
/* Set tape drive/OS info */
bzero(&val, sizeof(val));
g_value_init(&val, G_TYPE_BOOLEAN);
self->fsf = TRUE;
g_value_set_boolean(&val, self->fsf);
device_set_simple_property(dself, PROPERTY_FSF, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->fsf_after_filemark = DEFAULT_FSF_AFTER_FILEMARK;
g_value_set_boolean(&val, self->fsf_after_filemark);
device_set_simple_property(dself, PROPERTY_FSF_AFTER_FILEMARK, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->bsf = TRUE;
g_value_set_boolean(&val, self->bsf);
device_set_simple_property(dself, PROPERTY_BSF, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->fsr = TRUE;
g_value_set_boolean(&val, self->fsr);
device_set_simple_property(dself, PROPERTY_FSR, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->bsr = TRUE;
g_value_set_boolean(&val, self->bsr);
device_set_simple_property(dself, PROPERTY_BSR, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->eom = TRUE;
g_value_set_boolean(&val, self->eom);
device_set_simple_property(dself, PROPERTY_EOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->leom = FALSE;
g_value_set_boolean(&val, self->leom);
device_set_simple_property(dself, PROPERTY_LEOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
self->bsf_after_eom = FALSE;
g_value_set_boolean(&val, self->bsf_after_eom);
device_set_simple_property(dself, PROPERTY_BSF_AFTER_EOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
g_value_unset(&val);
g_value_init(&val, G_TYPE_UINT);
self->final_filemarks = 2;
g_value_set_uint(&val, self->final_filemarks);
device_set_simple_property(dself, PROPERTY_FINAL_FILEMARKS, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
g_value_unset(&val);
/* Chain up */
if (parent_class->open_device) {
parent_class->open_device(dself, device_name, device_type, device_node);
}
}
static DeviceStatusFlags tape_device_read_label(Device * dself) {
TapeDevice * self;
char * header_buffer;
int buffer_len;
IoResult result;
dumpfile_t *header;
DeviceStatusFlags new_status;
char *msg = NULL;
self = TAPE_DEVICE(dself);
amfree(dself->volume_label);
amfree(dself->volume_time);
dumpfile_free(dself->volume_header);
dself->volume_header = NULL;
if (device_in_error(self)) return dself->status;
if (self->fd == -1) {
self->fd = try_open_tape_device(self, self->private->device_filename);
/* if the open failed, then try_open_tape_device already set the
* approppriate error status */
if (self->fd == -1)
return dself->status;
}
/* Rewind it. */
if (!tape_rewind(self->fd)) {
device_set_error(dself,
g_strdup_printf(_("Error rewinding device %s to read label: %s"),
self->private->device_filename, strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR
| DEVICE_STATUS_VOLUME_ERROR);
return dself->status;
}
buffer_len = tape_device_read_size(self);
header_buffer = g_try_malloc(buffer_len);
if (header_buffer == NULL) {
device_set_error(dself,
g_strdup(_("Failed to allocate memory")),
DEVICE_STATUS_DEVICE_ERROR
| DEVICE_STATUS_VOLUME_ERROR);
return dself->status;
}
result = tape_device_robust_read(self, header_buffer, &buffer_len, &msg);
if (result != RESULT_SUCCESS) {
free(header_buffer);
tape_rewind(self->fd);
/* I/O error. */
switch (result) {
case RESULT_NO_DATA:
msg = g_strdup(_("no data"));
new_status = (DEVICE_STATUS_VOLUME_ERROR |
DEVICE_STATUS_VOLUME_UNLABELED);
header = dself->volume_header = g_new(dumpfile_t, 1);
fh_init(header);
break;
case RESULT_SMALL_BUFFER:
msg = g_strdup(_("block size too small"));
new_status = (DEVICE_STATUS_DEVICE_ERROR |
DEVICE_STATUS_VOLUME_ERROR);
header = dself->volume_header = g_new(dumpfile_t, 1);
fh_init(header);
header->type = F_WEIRD;
break;
default:
msg = g_strdup(_("unknown error"));
// fallthrough
case RESULT_ERROR:
new_status = (DEVICE_STATUS_DEVICE_ERROR |
DEVICE_STATUS_VOLUME_ERROR |
DEVICE_STATUS_VOLUME_UNLABELED);
break;
}
device_set_error(dself,
g_strdup_printf(_("Error reading Amanda header: %s"),
msg? msg : _("unknown error")),
new_status);
amfree(msg);
return dself->status;
}
if (buffer_len < 32768) {
device_set_error(dself,
g_strdup_printf(_("header is too small: %d bytes"), buffer_len),
DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
free(header_buffer);
return dself->status;
}
dself->header_block_size = buffer_len;
header = dself->volume_header = g_new(dumpfile_t, 1);
fh_init(header);
parse_file_header(header_buffer, header, buffer_len);
amfree(header_buffer);
if (header->type != F_TAPESTART) {
device_set_error(dself,
g_strdup(_("No tapestart header -- unlabeled device?")),
DEVICE_STATUS_VOLUME_UNLABELED);
return dself->status;
}
dself->volume_label = g_strdup(header->name);
dself->volume_time = g_strdup(header->datestamp);
/* dself->volume_header is already set */
device_set_error(dself, NULL, DEVICE_STATUS_SUCCESS);
return dself->status;
}
static DeviceWriteResult
tape_device_write_block(Device * pself, guint size, gpointer data) {
TapeDevice * self;
char *replacement_buffer = NULL;
IoResult result;
char *msg = NULL;
self = TAPE_DEVICE(pself);
g_assert(self->fd >= 0);
if (device_in_error(self)) return WRITE_FAILED;
/* zero out to the end of a short block -- tape devices only write
* whole blocks. */
if (size < pself->block_size) {
replacement_buffer = g_try_malloc(pself->block_size);
if (replacement_buffer == NULL) {
device_set_error(pself,
g_strdup(_("failed to allocate memory")),
DEVICE_STATUS_DEVICE_ERROR);
return WRITE_FAILED;
}
memcpy(replacement_buffer, data, size);
bzero(replacement_buffer+size, pself->block_size-size);
data = replacement_buffer;
size = pself->block_size;
}
result = tape_device_robust_write(self, data, size, &msg);
amfree(replacement_buffer);
switch (result) {
case RESULT_SUCCESS:
break;
case RESULT_NO_SPACE:
device_set_error(pself,
g_strdup(_("No space left on device")),
DEVICE_STATUS_VOLUME_ERROR);
pself->is_eom = TRUE;
return WRITE_FAILED;
default:
msg = g_strdup(_("unknown error"));
// fallthrough
case RESULT_ERROR:
device_set_error(pself,
g_strdup_printf(_("Error writing block: %s"), msg),
DEVICE_STATUS_DEVICE_ERROR);
amfree(msg);
return WRITE_FAILED;
}
pself->block++;
g_mutex_lock(pself->device_mutex);
pself->bytes_written += size;
g_mutex_unlock(pself->device_mutex);
return WRITE_SUCCEED;
}
static int tape_device_read_block (Device * pself, gpointer buf,
int * size_req, int max_block G_GNUC_UNUSED) {
TapeDevice * self;
int size;
IoResult result;
gssize read_block_size = tape_device_read_size(pself);
char *msg = NULL;
self = TAPE_DEVICE(pself);
g_assert(self->fd >= 0);
if (device_in_error(self)) return -1;
g_assert(read_block_size < INT_MAX); /* data type mismatch */
if (buf == NULL || *size_req < (int)read_block_size) {
/* Just a size query. */
*size_req = (int)read_block_size;
return 0;
}
size = *size_req;
result = tape_device_robust_read(self, buf, &size, &msg);
switch (result) {
case RESULT_SUCCESS:
*size_req = size;
pself->block++;
g_mutex_lock(pself->device_mutex);
pself->bytes_read += size;
g_mutex_unlock(pself->device_mutex);
return size;
case RESULT_SMALL_BUFFER: {
gsize new_size;
GValue newval;
/* If this happens, it means that we have:
* (next block size) > (buffer size) >= (read_block_size)
* The solution is to ask for an even bigger buffer. We also play
* some games to refrain from reading above the SCSI limit or from
* integer overflow. Note that not all devices will tell us about
* this problem -- some will just discard the "extra" data. */
new_size = MIN(INT_MAX/2 - 1, *size_req) * 2;
if (new_size > LARGEST_BLOCK_ESTIMATE &&
*size_req < LARGEST_BLOCK_ESTIMATE) {
new_size = LARGEST_BLOCK_ESTIMATE;
}
g_assert (new_size > (gsize)*size_req);
g_info("Device %s indicated blocksize %zd was too small; using %zd.",
pself->device_name, (gsize)*size_req, new_size);
*size_req = (int)new_size;
self->private->read_block_size = new_size;
bzero(&newval, sizeof(newval));
g_value_init(&newval, G_TYPE_UINT);
g_value_set_uint(&newval, self->private->read_block_size);
device_set_simple_property(pself, PROPERTY_READ_BLOCK_SIZE,
&newval, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
g_value_unset(&newval);
return 0;
}
case RESULT_NO_DATA:
pself->is_eof = TRUE;
g_mutex_lock(pself->device_mutex);
pself->in_file = FALSE;
g_mutex_unlock(pself->device_mutex);
device_set_error(pself,
g_strdup(_("EOF")),
DEVICE_STATUS_SUCCESS);
return -1;
default:
msg = g_strdup(_("unknown error"));
// fallthrough
case RESULT_ERROR:
device_set_error(pself,
g_strdup_printf(_("Error reading from tape device: %s"), msg),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
amfree(msg);
return -1;
}
g_assert_not_reached();
}
/* Just a helper function for tape_device_start(). */
static gboolean write_tapestart_header(TapeDevice * self, char * label,
char * timestamp) {
IoResult result;
dumpfile_t * header;
char * header_buf;
Device * d_self = (Device*)self;
char *msg = NULL;
tape_rewind(self->fd);
header = make_tapestart_header(d_self, label, timestamp);
g_assert(header != NULL);
header_buf = device_build_amanda_header(d_self, header, NULL);
if (header_buf == NULL) {
device_set_error(d_self,
g_strdup(_("Tapestart header won't fit in a single block!")),
DEVICE_STATUS_DEVICE_ERROR);
dumpfile_free(header);
return FALSE;
}
dumpfile_free(d_self->volume_header);
d_self->volume_header = NULL;
result = tape_device_robust_write(self, header_buf, d_self->block_size, &msg);
if (result != RESULT_SUCCESS) {
device_set_error(d_self,
g_strdup_printf(_("Error writing tapestart header: %s"),
(result == RESULT_ERROR)? msg : _("out of space")),
DEVICE_STATUS_DEVICE_ERROR);
if (result == RESULT_NO_SPACE)
d_self->is_eom = TRUE;
amfree(msg);
dumpfile_free(header);
amfree(header_buf);
return FALSE;
}
d_self->header_block_size = d_self->block_size;
amfree(header_buf);
if (!tape_weof(self->fd, 1)) {
device_set_error(d_self,
g_strdup_printf(_("Error writing filemark: %s"),
strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR|DEVICE_STATUS_VOLUME_ERROR);
/* can't tell if this was EOM or not, so assume it is */
d_self->is_eom = TRUE;
dumpfile_free(header);
return FALSE;
}
d_self->volume_header = header;
return TRUE;
}
static gboolean
tape_device_start (Device * d_self, DeviceAccessMode mode, char * label,
char * timestamp) {
TapeDevice * self;
self = TAPE_DEVICE(d_self);
if (device_in_error(self)) return FALSE;
if (self->fd == -1) {
self->fd = try_open_tape_device(self, self->private->device_filename);
/* if the open failed, then try_open_tape_device already set the
* approppriate error status */
if (self->fd == -1)
return FALSE;
}
if (mode != ACCESS_WRITE && d_self->volume_label == NULL) {
/* we need a labeled volume for APPEND and READ */
if (tape_device_read_label(d_self) != DEVICE_STATUS_SUCCESS)
return FALSE;
}
d_self->access_mode = mode;
g_mutex_lock(d_self->device_mutex);
d_self->in_file = FALSE;
g_mutex_unlock(d_self->device_mutex);
if (IS_WRITABLE_ACCESS_MODE(mode)) {
if (self->write_open_errno != 0) {
/* We tried and failed to open the device in write mode. */
device_set_error(d_self,
g_strdup_printf(_("Can't open tape device %s for writing: %s"),
self->private->device_filename, strerror(self->write_open_errno)),
DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
return FALSE;
} else {
if (!tape_device_check_writable(d_self)) {
return FALSE;
}
if (!tape_rewind(self->fd)) {
device_set_error(d_self,
g_strdup_printf(_("Error rewinding device to start: %s"), strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
}
}
/* Position the tape */
switch (mode) {
case ACCESS_APPEND:
if (d_self->volume_label == NULL && device_read_label(d_self) != DEVICE_STATUS_SUCCESS) {
/* device_read_label already set our error message */
return FALSE;
}
if (!tape_device_eod(self)) {
device_set_error(d_self,
g_strdup_printf(_("Couldn't seek to end of tape: %s"), strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
break;
case ACCESS_READ:
if (d_self->volume_label == NULL && device_read_label(d_self) != DEVICE_STATUS_SUCCESS) {
/* device_read_label already set our error message */
return FALSE;
}
if (!tape_rewind(self->fd)) {
device_set_error(d_self,
g_strdup_printf(_("Error rewinding device after reading label: %s"), strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
d_self->file = 0;
break;
case ACCESS_WRITE:
if (!write_tapestart_header(self, label, timestamp)) {
/* write_tapestart_header already set the error status */
return FALSE;
}
g_free(d_self->volume_label);
d_self->volume_label = g_strdup(label);
g_free(d_self->volume_time);
d_self->volume_time = g_strdup(timestamp);
/* unset the VOLUME_UNLABELED flag, if it was set */
device_set_error(d_self, NULL, DEVICE_STATUS_SUCCESS);
d_self->file = 0;
break;
default:
g_assert_not_reached();
}
return TRUE;
}
static gboolean tape_device_start_file(Device * d_self,
dumpfile_t * info) {
TapeDevice * self;
IoResult result;
char * amanda_header;
char *msg = NULL;
self = TAPE_DEVICE(d_self);
g_assert(self->fd >= 0);
if (device_in_error(self)) return FALSE;
/* set the blocksize in the header properly */
info->blocksize = d_self->block_size;
/* Make the Amanda header suitable for writing to the device. */
/* Then write the damn thing. */
amanda_header = device_build_amanda_header(d_self, info, NULL);
if (amanda_header == NULL) {
device_set_error(d_self,
g_strdup(_("Amanda file header won't fit in a single block!")),
DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
result = tape_device_robust_write(self, amanda_header, d_self->block_size, &msg);
if (result != RESULT_SUCCESS) {
device_set_error(d_self,
g_strdup_printf(_("Error writing file header: %s"),
(result == RESULT_ERROR)? msg : _("out of space")),
DEVICE_STATUS_DEVICE_ERROR);
if (result == RESULT_NO_SPACE)
d_self->is_eom = TRUE;
amfree(amanda_header);
amfree(msg);
return FALSE;
}
amfree(amanda_header);
/* arrange the file numbers correctly */
d_self->block = 0;
if (d_self->file >= 0)
d_self->file ++;
g_mutex_lock(d_self->device_mutex);
d_self->in_file = TRUE;
d_self->bytes_written = 0;
g_mutex_unlock(d_self->device_mutex);
return TRUE;
}
static gboolean
tape_device_finish_file (Device * d_self) {
TapeDevice * self;
self = TAPE_DEVICE(d_self);
if (!d_self->in_file)
return TRUE;
g_mutex_lock(d_self->device_mutex);
d_self->in_file = FALSE;
g_mutex_unlock(d_self->device_mutex);
if (device_in_error(d_self)) return FALSE;
if (!tape_weof(self->fd, 1)) {
device_set_error(d_self,
g_strdup_printf(_("Error writing filemark: %s"), strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
/* can't tell if this was EOM or not, so assume it is */
d_self->is_eom = TRUE;
return FALSE;
}
return TRUE;
}
static dumpfile_t *
tape_device_seek_file (Device * d_self, guint file) {
TapeDevice * self;
gint got_file;
int difference;
char * header_buffer;
dumpfile_t * rval;
int buffer_len;
IoResult result;
char *msg;
self = TAPE_DEVICE(d_self);
if (device_in_error(self)) return NULL;
difference = file - d_self->file;
/* Check if we already read a filemark. */
/* If we already read a filemark and the drive automaticaly goes to the
next file, then we must reduce the difference by one. */
if (d_self->is_eof && !self->fsf_after_filemark) {
difference --;
}
d_self->is_eof = FALSE;
d_self->block = 0;
g_mutex_lock(d_self->device_mutex);
d_self->in_file = FALSE;
d_self->bytes_read = 0;
g_mutex_unlock(d_self->device_mutex);
reseek:
if (difference > 0) {
/* Seeking forwards */
if (!tape_device_fsf(self, difference)) {
tape_rewind(self->fd);
device_set_error(d_self,
g_strdup_printf(_("Could not seek forward to file %d"), file),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return NULL;
}
} else { /* (difference <= 0) */
/* Seeking backwards, or to this file itself */
/* if the drive supports bsf, we can do this the fancy way */
if (self->bsf) {
/* bsf one more than the difference */
if (!tape_bsf(self->fd, -difference + 1)) {
tape_rewind(self->fd);
device_set_error(d_self,
g_strdup_printf(_("Could not seek backward to file %d"), file),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return NULL;
}
/* now we are on the BOT side of the desired filemark, so FSF to get to the
* EOT side of it */
if (!tape_device_fsf(self, 1)) {
tape_rewind(self->fd);
device_set_error(d_self,
g_strdup_printf(_("Could not seek forward to file %d"), file),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return NULL;
}
} else {
/* no BSF, so just rewind and seek forward */
if (!tape_rewind(self->fd)) {
device_set_error(d_self,
g_strdup(_("Could not rewind device while emulating BSF")),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
if (!tape_device_fsf(self, file)) {
tape_rewind(self->fd);
device_set_error(d_self,
g_strdup_printf(_("Could not seek forward to file %d"), file),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return NULL;
}
}
}
/* double-check that we're on the right fileno, if possible. This is most
* likely a programming error if it occurs, but could also be due to a weird
* tape drive or driver (and that would *never* happen, right?) */
got_file = tape_fileno(self->fd);
if (got_file >= 0 && (guint)got_file != file) {
device_set_error(d_self,
g_strdup_printf(_("Could not seek to file %d correctly; got %d"),
file, got_file),
DEVICE_STATUS_DEVICE_ERROR);
d_self->file = (guint)got_file;
return NULL;
}
buffer_len = tape_device_read_size(d_self);
header_buffer = g_try_malloc(buffer_len);
if (header_buffer == NULL) {
device_set_error(d_self,
g_strdup(_("failed to allocate memory")),
DEVICE_STATUS_DEVICE_ERROR);
return NULL;
}
d_self->is_eof = FALSE;
result = tape_device_robust_read(self, header_buffer, &buffer_len, &msg);
if (result != RESULT_SUCCESS) {
free(header_buffer);
tape_rewind(self->fd);
switch (result) {
case RESULT_NO_DATA:
/* If we read 0 bytes, that means we encountered a double
* filemark, which indicates end of tape. This should
* work even with QIC tapes on operating systems with
* proper support. */
d_self->file = file; /* other attributes are already correct */
return make_tapeend_header();
case RESULT_SMALL_BUFFER:
msg = g_strdup(_("block size too small"));
break;
default:
msg = g_strdup(_("unknown error"));
case RESULT_ERROR:
break;
}
device_set_error(d_self,
g_strdup_printf(_("Error reading Amanda header: %s"), msg),
DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
amfree(msg);
return NULL;
}
if (buffer_len < 32768) {
device_set_error(d_self,
g_strdup_printf(_("header is too small: %d bytes"), buffer_len),
DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
free(header_buffer);
return NULL;
}
rval = g_new(dumpfile_t, 1);
parse_file_header(header_buffer, rval, buffer_len);
amfree(header_buffer);
switch (rval->type) {
case F_DUMPFILE:
case F_CONT_DUMPFILE:
case F_SPLIT_DUMPFILE:
break;
case F_NOOP:
/* a NOOP is written on QIC tapes to avoid writing two sequential
* filemarks when closing a device in WRITE or APPEND mode. In this
* case, we just seek to the next file. */
amfree(rval);
file++;
difference = 1;
goto reseek;
default:
tape_rewind(self->fd);
device_set_error(d_self,
g_strdup(_("Invalid amanda header while reading file header")),
DEVICE_STATUS_VOLUME_ERROR);
amfree(rval);
return NULL;
}
g_mutex_lock(d_self->device_mutex);
d_self->in_file = TRUE;
g_mutex_unlock(d_self->device_mutex);
d_self->file = file;
return rval;
}
static gboolean
tape_device_seek_block (Device * d_self, guint64 block) {
TapeDevice * self;
int difference;
self = TAPE_DEVICE(d_self);
if (device_in_error(self)) return FALSE;
difference = block - d_self->block;
if (difference > 0) {
if (!tape_device_fsr(self, difference)) {
device_set_error(d_self,
g_strdup_printf(_("Could not seek forward to block %ju: %s"), (uintmax_t)block, strerror(errno)),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
} else if (difference < 0) {
if (!tape_device_bsr(self, difference, d_self->file, d_self->block)) {
device_set_error(d_self,
g_strdup_printf(_("Could not seek backward to block %ju: %s"), (uintmax_t)block, strerror(errno)),
DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
return FALSE;
}
}
d_self->block = block;
return TRUE;
}
static gboolean
tape_device_eject (Device * d_self) {
TapeDevice * self;
gboolean eject_opened_tape = FALSE;
gboolean result = FALSE;
self = TAPE_DEVICE(d_self);
if (device_in_error(self)) return FALSE;
/* Open the device if not already opened */
if (self->fd == -1) {
self->fd = try_open_tape_device(self, self->private->device_filename);
/* if the open failed, then try_open_tape_device already set the
* approppriate error status */
if (self->fd == -1)
return FALSE;
eject_opened_tape = TRUE;
}
/* Rewind it. */
if (!tape_rewind(self->fd)) {
device_set_error(d_self,
g_strdup_printf(_("Error rewinding device %s before ejecting: %s"),
self->private->device_filename, strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR
| DEVICE_STATUS_VOLUME_ERROR);
result = FALSE;
goto eject_finish;
}
if (tape_offl(self->fd)) {
result = TRUE;
goto eject_finish;
}
device_set_error(d_self,
g_strdup_printf(_("Error ejecting device %s: %s\n"),
self->private->device_filename, strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR);
eject_finish:
if (eject_opened_tape) {
device_finish(d_self);
}
return result;
}
static gboolean
tape_device_finish (Device * d_self) {
TapeDevice * self;
char *msg = NULL;
self = TAPE_DEVICE(d_self);
if (device_in_error(self))
goto finish_error;
/* if we're already in ACCESS_NULL, then there are no filemarks or anything
* to worry about, but we need to release the kernel device */
if (d_self->access_mode == ACCESS_NULL) {
robust_close(self->fd);
self->fd = -1;
return TRUE;
}
/* Polish off this file, if relevant. */
g_mutex_lock(d_self->device_mutex);
if (d_self->in_file && IS_WRITABLE_ACCESS_MODE(d_self->access_mode)) {
g_mutex_unlock(d_self->device_mutex);
if (!device_finish_file(d_self)) {
goto finish_error;
}
} else {
g_mutex_unlock(d_self->device_mutex);
}
/* Straighten out the filemarks. We already wrote one in finish_file, and
* the device driver will write another filemark when we rewind. This means
* that, if we do nothing, we'll get two filemarks. If final_filemarks is
* 1, this would be wrong, so in this case we insert a F_NOOP header between
* the two filemarks. */
if (self->final_filemarks == 1 &&
IS_WRITABLE_ACCESS_MODE(d_self->access_mode)) {
dumpfile_t file;
char *header;
int result;
/* write a F_NOOP header */
fh_init(&file);
file.type = F_NOOP;
header = device_build_amanda_header(d_self, &file, NULL);
if (!header) {
device_set_error(d_self,
g_strdup(_("Amanda file header won't fit in a single block!")),
DEVICE_STATUS_DEVICE_ERROR);
goto finish_error;
}
result = tape_device_robust_write(self, header, d_self->block_size, &msg);
if (result != RESULT_SUCCESS) {
device_set_error(d_self,
g_strdup_printf(_("Error writing file header: %s"),
(result == RESULT_ERROR)? msg : _("out of space")),
DEVICE_STATUS_DEVICE_ERROR);
amfree(header);
amfree(msg);
goto finish_error;
}
amfree(header);
}
/* Rewind (the kernel will write a filemark first) */
if (!tape_rewind(self->fd)) {
device_set_error(d_self,
g_strdup_printf(_("Couldn't rewind device to finish: %s"), strerror(errno)),
DEVICE_STATUS_DEVICE_ERROR);
goto finish_error;
}
d_self->is_eof = FALSE;
d_self->access_mode = ACCESS_NULL;
/* release the kernel's device */
robust_close(self->fd);
self->fd = -1;
return TRUE;
finish_error:
d_self->access_mode = ACCESS_NULL;
/* release the kernel's device */
robust_close(self->fd);
self->fd = -1;
return FALSE;
}
static gboolean
tape_device_check_writable(Device * d_self)
{
TapeDevice *self;
#ifdef GMT_WR_PROT
struct mtget get;
#endif
self = TAPE_DEVICE(d_self);
if (device_in_error(self))
return TRUE;
#ifdef GMT_WR_PROT
if (ioctl(self->fd, MTIOCGET, &get) == 0) {
if (GMT_WR_PROT(get.mt_gstat)) {
device_set_error(d_self,
g_strdup_printf("Device '%s' is write protected", self->private->device_filename),
DEVICE_STATUS_VOLUME_ERROR);
return FALSE;
}
} else {
device_set_error(d_self,
g_strdup_printf("ioctl failed on device '%s'", self->private->device_filename),
DEVICE_STATUS_VOLUME_ERROR);
return FALSE;
}
#endif
return TRUE;
}
/* Works just like read(), except for the following:
* 1) Retries on EINTR & friends.
* 2) Stores count in parameter, not return value.
* 3) Provides explicit return result.
* *errmsg is only set on RESULT_ERROR.
*/
static IoResult
tape_device_robust_read (TapeDevice * self, void * buf, int * count, char **errmsg) {
Device * d_self;
int result;
d_self = (Device*)self;
/* Callers should ensure this. */
g_assert(*count >= 0);
for (;;) {
result = read(self->fd, buf, *count);
if (result > 0) {
/* Success. By definition, we read a full block. */
d_self->is_eof = FALSE;
*count = result;
return RESULT_SUCCESS;
} else if (result == 0) {
d_self->is_eof = TRUE;
return RESULT_NO_DATA;
} else {
if (0
#ifdef EAGAIN
|| errno == EAGAIN
#endif
#ifdef EWOULDBLOCK
|| errno == EWOULDBLOCK
#endif
#ifdef EINTR
|| errno == EINTR
#endif
) {
/* Interrupted system call */
continue;
} else if ((0
#ifdef ENOMEM
|| errno == ENOMEM /* bad user-space buffer */
#endif
#ifdef EOVERFLOW
|| errno == EOVERFLOW /* bad kernel-space buffer */
#endif
#ifdef EINVAL
|| errno == EINVAL /* ??? */
#endif
)) {
/* Buffer too small. */
g_warning("Buffer is too small (%d bytes) from %s: %s",
*count, self->private->device_filename, strerror(errno));
return RESULT_SMALL_BUFFER;
} else {
*errmsg = g_strdup_printf(_("Error reading %d bytes from %s: %s"),
*count, self->private->device_filename, strerror(errno));
return RESULT_ERROR;
}
}
}
g_assert_not_reached();
}
/* Kernel workaround: If needed, poke the kernel so it doesn't fail.
at the 2GB boundry. Parameters are G_GNUC_UNUSED in case NEED_RESETOFS
is not defined. */
static void check_resetofs(TapeDevice * self G_GNUC_UNUSED,
int count G_GNUC_UNUSED) {
#ifdef NEED_RESETOFS
Device * d_self;
int result;
d_self = (Device*)self;
self->private->write_count += count;
if (self->private->write_count < RESETOFS_THRESHOLD) {
return;
}
result = lseek(self->fd, 0, SEEK_SET);
if (result < 0) {
g_warning(_("lseek() failed during kernel 2GB workaround: %s"),
strerror(errno));
}
#endif
}
/* *errmsg is only set on RESULT_ERROR */
static IoResult
tape_device_robust_write (TapeDevice * self, void * buf, int count, char **errmsg) {
Device * d_self;
int result;
gboolean retry = FALSE;
d_self = (Device*)self;
check_resetofs(self, count);
for (;;) {
result = write(self->fd, buf, count);
/* Success. */
if (result == count)
return RESULT_SUCCESS;
if (result > 0) {
/* write() returned a short count. This should not happen if the block sizes
* are properly aligned. */
*errmsg = g_strdup_printf("Short write on tape device: Tried %d, got %d. Is "
"the drive using a block size smaller than %d bytes?",
count, result, count);
return RESULT_ERROR;
}
/* Detect LEOM (early warning) and handle properly
*
* FreeBSD: 0-length write; next write will succeed
* http://lists.freebsd.org/pipermail/freebsd-scsi/2010-June/004414.html
*
* Solaris: 0-length write; next write will succeed
* (from Matthew Jacob on FreeBSD thread)
*
* Linux: -1/ENOSPC; next write will succeed
* http://www.mjmwired.net/kernel/Documentation/scsi/st.txt
*
* HP/UX: -1/ENOSPC; next write will succeed
* http://www.adssasia.com/Manual/IBM%203581%20tape%20autoloader.pdf
*/
if (result == 0
#ifdef ENOSPC
|| (result < 0 && errno == ENOSPC)
#endif
) {
/* if we've retried once already, then we're probably really out of space */
if (retry || !self->leom)
return RESULT_NO_SPACE;
retry = TRUE;
d_self->is_eom = TRUE;
g_debug("empty write to tape; treating as LEOM early warning and retrying");
continue;
}
/* at this point result < 0, so an error occurred - sort out what */
if (0
#ifdef EAGAIN
|| errno == EAGAIN
#endif
#ifdef EWOULDBLOCK
|| errno == EWOULDBLOCK
#endif
#ifdef EINTR
|| errno == EINTR
#endif
) {
/* Interrupted system call */
continue;
} else if (0
#ifdef ENOSPC
|| errno == ENOSPC
#endif
#ifdef EIO
|| errno == EIO
#endif
) {
/* Probably EOT. Print a message if we got EIO. */
#ifdef EIO
if (errno == EIO) {
g_warning(_("Got EIO on %s, assuming end of tape"),
self->private->device_filename);
}
#endif
return RESULT_NO_SPACE;
} else if (errno == EPERM) {
*errmsg = g_strdup_printf("write to the '%s' device failed: %s, maybe the tab on the tape is set at the read-only possition?",
self->private->device_filename, strerror(errno));
return RESULT_ERROR;
} else {
/* WTF */
*errmsg = g_strdup_printf("write to the '%s' device failed: %s",
strerror(errno), self->private->device_filename);
return RESULT_ERROR;
}
}
g_assert_not_reached();
}
/* Reads some number of tape blocks into the bit-bucket. If the count
is negative, then we read the rest of the entire file. Returns the
number of blocks read, or -1 if an error occured. If we encounter
EOF (as opposed to some other error) we return the number of blocks
actually read. */
static int drain_tape_blocks(TapeDevice * self, int count) {
char * buffer;
gsize buffer_size;
int i;
buffer_size = tape_device_read_size(self);
buffer = malloc(buffer_size);
for (i = 0; i < count || count < 0;) {
int result;
result = read(self->fd, buffer, buffer_size);
if (result > 0) {
i ++;
continue;
} else if (result == 0) {
amfree(buffer);
return i;
} else {
/* First check for interrupted system call. */
if (0
#ifdef EAGAIN
|| errno == EAGAIN
#endif
#ifdef EWOULDBLOCK
|| errno == EWOULDBLOCK
#endif
#ifdef EINTR
|| errno == EINTR
#endif
) {
/* Interrupted system call */
continue;
} else if (0
#ifdef ENOSPC
|| errno == ENOSPC /* bad user-space buffer */
#endif
#ifdef EOVERFLOW
|| errno == EOVERFLOW /* bad kernel-space buffer */
#endif
#ifdef EINVAL
|| errno == EINVAL /* ??? */
#endif
) {
/* The buffer may not be big enough. But the OS is not
100% clear. We double the buffer and try again, but
in no case allow a buffer bigger than 32 MB. */
buffer_size *= 2;
if (buffer_size > 32*1024*1024) {
amfree(buffer);
return -1;
} else {
char *new_buffer = realloc(buffer, buffer_size);
if (new_buffer == NULL) {
amfree(buffer);
return -1;
}
buffer = new_buffer;
continue;
}
}
}
}
amfree(buffer);
return count;
}
static gboolean
tape_device_fsf (TapeDevice * self, guint count) {
if (self->fsf) {
return tape_fsf(self->fd, count);
} else {
guint i;
for (i = 0; i < count; i ++) {
if (drain_tape_blocks(self, -1) < 0)
return FALSE;
}
return TRUE;
}
}
static gboolean
tape_device_fsr (TapeDevice * self, guint count) {
if (self->fsr) {
return tape_fsr(self->fd, count);
} else {
int result = drain_tape_blocks(self, count);
return result > 0 && (int)count == result;
}
}
/* Seek back the given number of blocks to block number block within
* the current file, numbered file. */
static gboolean
tape_device_bsr (TapeDevice * self, guint count, guint file, guint block) {
if (self->bsr) {
return tape_bsr(self->fd, count);
} else if (self->bsf && self->fsf) {
/* BSF, FSF to the right side of the filemark, and then FSR. */
if (!tape_bsf(self->fd, 1))
return FALSE;
if (!tape_fsf(self->fd, 1))
return FALSE;
return tape_device_fsr(self, block);
} else {
/* rewind, FSF, and FSR */
if (!tape_rewind(self->fd))
return FALSE;
if (!tape_device_fsf(self, file))
return FALSE;
return tape_device_fsr(self, block);
}
g_assert_not_reached();
}
/* Go to the right place to write more data, and update the file
number if possible. */
static gboolean
tape_device_eod (TapeDevice * self) {
Device * d_self;
int count;
d_self = (Device*)self;
if (self->eom) {
int result;
result = tape_eod(self->fd);
if (result == TAPE_OP_ERROR) {
return FALSE;
} else if (result != TAPE_POSITION_UNKNOWN) {
/* great - we just fast-forwarded to EOD, but don't know where we are, so
* now we have to rewind and drain all of that data. Warn the user so that
* we can skip the fast-forward-rewind stage on the next run */
g_warning("Seek to end of tape does not give an accurate tape position; set "
"the EOM property to 0 to avoid useless tape movement.");
/* and set the property so that next time *this* object is opened for
* append, we skip this stage */
self->eom = FALSE;
/* fall through to draining blocks, below */
} else {
/* We drop by 1 because Device will increment the first
time the user does start_file. */
d_self->file = result - 1;
return TRUE;
}
}
if (!tape_rewind(self->fd))
return FALSE;
count = 0;
for (;;) {
/* We alternately read a block and FSF. If the read is
successful, then we are not there yet and should FSF
again. */
int result;
result = drain_tape_blocks(self, 1);
if (result == 1) {
/* More data, FSF. */
tape_device_fsf(self, 1);
count ++;
} else if (result == 0) {
/* Finished. */
d_self->file = count - 1;
return TRUE;
} else {
return FALSE;
}
}
}
static Device *
tape_device_factory (char * device_name, char * device_type, char * device_node) {
Device * rval;
g_assert(g_str_equal(device_type, "tape"));
rval = DEVICE(g_object_new(TYPE_TAPE_DEVICE, NULL));
device_open_device(rval, device_name, device_type, device_node);
return rval;
}
/*
* Tape Operations using the POSIX interface
*/
/* Having one name for every operation would be too easy. */
#if !defined(MTCOMPRESSION) && defined(MTCOMP)
# define MTCOMPRESSION MTCOMP
#endif
#if !defined(MTSETBLK) && defined(MTSETBSIZ)
# define MTSETBLK MTSETBSIZ
#endif
#if !defined(MTEOM) && defined(MTEOD)
# define MTEOM MTEOD
#endif
gboolean tape_rewind(int fd) {
int count = 5;
time_t stop_time;
/* We will retry this for up to 30 seconds or 5 retries,
whichever is less, because some hardware/software combinations
(notably EXB-8200 on FreeBSD) can fail to rewind. */
stop_time = time(NULL) + 30;
while (--count >= 0 && time(NULL) < stop_time) {
struct mtop mt;
mt.mt_op = MTREW;
mt.mt_count = 1;
if (0 == ioctl(fd, MTIOCTOP, &mt))
return TRUE;
sleep(3);
}
return FALSE;
}
gboolean tape_fsf(int fd, guint count) {
struct mtop mt;
mt.mt_op = MTFSF;
mt.mt_count = count;
return 0 == ioctl(fd, MTIOCTOP, &mt);
}
gboolean tape_bsf(int fd, guint count) {
struct mtop mt;
mt.mt_op = MTBSF;
mt.mt_count = count;
return 0 == ioctl(fd, MTIOCTOP, &mt);
}
gboolean tape_fsr(int fd, guint count) {
struct mtop mt;
mt.mt_op = MTFSR;
mt.mt_count = count;
return 0 == ioctl(fd, MTIOCTOP, &mt);
}
gboolean tape_bsr(int fd, guint count) {
struct mtop mt;
mt.mt_op = MTBSR;
mt.mt_count = count;
return 0 == ioctl(fd, MTIOCTOP, &mt);
}
gint tape_fileno(int fd) {
struct mtget get;
if (0 != ioctl(fd, MTIOCGET, &get))
return TAPE_POSITION_UNKNOWN;
if (get.mt_fileno < 0)
return TAPE_POSITION_UNKNOWN;
else
return get.mt_fileno;
}
gint tape_eod(int fd) {
struct mtop mt;
struct mtget get;
mt.mt_op = MTEOM;
mt.mt_count = 1;
if (0 != ioctl(fd, MTIOCTOP, &mt))
return TAPE_OP_ERROR;
/* Ignored result. This is just to flush buffers. */
mt.mt_op = MTNOP;
(void)ioctl(fd, MTIOCTOP, &mt);
if (0 != ioctl(fd, MTIOCGET, &get))
return TAPE_POSITION_UNKNOWN;
if (get.mt_fileno < 0)
return TAPE_POSITION_UNKNOWN;
else
return get.mt_fileno;
}
gboolean tape_weof(int fd, guint8 count) {
struct mtop mt;
mt.mt_op = MTWEOF;
mt.mt_count = count;
return 0 == ioctl(fd, MTIOCTOP, &mt);
}
gboolean tape_setcompression(int fd G_GNUC_UNUSED,
gboolean on G_GNUC_UNUSED) {
#ifdef MTCOMPRESSION
struct mtop mt;
mt.mt_op = MTCOMPRESSION;
mt.mt_count = on;
return 0 == ioctl(fd, MTIOCTOP, &mt);
#else
return 0;
#endif
}
gboolean tape_offl(int fd) {
struct mtop mt;
int safe_errno;
mt.mt_op = MTOFFL;
mt.mt_count = 1;
if (0 == ioctl(fd, MTIOCTOP, &mt))
return TRUE;
safe_errno = errno;
g_debug("tape_off: ioctl(MTIOCTOP/MTOFFL) failed: %s", strerror(errno));
errno = safe_errno;
return FALSE;
}
DeviceStatusFlags tape_is_tape_device(int fd) {
struct mtop mt;
mt.mt_op = MTNOP;
mt.mt_count = 1;
if (0 == ioctl(fd, MTIOCTOP, &mt)) {
return DEVICE_STATUS_SUCCESS;
#ifdef ENOMEDIUM
} else if (errno == ENOMEDIUM) {
return DEVICE_STATUS_VOLUME_MISSING;
#endif
} else {
g_debug("tape_is_tape_device: ioctl(MTIOCTOP/MTNOP) failed: %s",
strerror(errno));
if (errno == EIO) {
/* some devices return EIO while the drive is busy loading */
return DEVICE_STATUS_DEVICE_ERROR|DEVICE_STATUS_DEVICE_BUSY;
} else {
return DEVICE_STATUS_DEVICE_ERROR;
}
}
}
DeviceStatusFlags get_tape_blocksize(int fd, guint64 *tape_blocksize) {
struct mtget status;
if (ioctl(fd, MTIOCGET, (char *)&status) < 0) {
g_debug("get_tape_blocksize: ioctl(MTIOCGET) failed: %s",
strerror(errno));
*tape_blocksize = -1;
return DEVICE_STATUS_DEVICE_ERROR;
}
*tape_blocksize = 0;
#if defined MT_ST_BLKSIZE_MASK && defined MT_ST_BLKSIZE_SHIFT
if (
#ifdef MT_ISSCSI1
status.mt_type == MT_ISSCSI1 ||
#endif
#ifdef MT_ISSCSI2
status.mt_type == MT_ISSCSI2 ||
#endif
0) {
*tape_blocksize = ((status.mt_dsreg & MT_ST_BLKSIZE_MASK) >> MT_ST_BLKSIZE_SHIFT);
}
#endif
return DEVICE_STATUS_SUCCESS;
}
DeviceStatusFlags tape_is_ready(int fd, TapeDevice *t_self G_GNUC_UNUSED) {
struct mtget get;
if (0 == ioctl(fd, MTIOCGET, &get)) {
#if defined(GMT_ONLINE) || defined(GMT_DR_OPEN)
if (1
#ifdef GMT_ONLINE
&& (t_self->broken_gmt_online || GMT_ONLINE(get.mt_gstat))
#endif
#ifdef GMT_DR_OPEN
&& !GMT_DR_OPEN(get.mt_gstat)
#endif
) {
return DEVICE_STATUS_SUCCESS;
} else {
return DEVICE_STATUS_VOLUME_MISSING;
}
#else /* Neither macro is defined. */
return DEVICE_STATUS_SUCCESS;
#endif
} else {
return DEVICE_STATUS_VOLUME_ERROR;
}
}