2 * Copyright (c) 2007, 2008, 2009, 2010 Zmanda, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published
6 * by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
10 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 * Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
18 * Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
22 #include "pipespawn.h"
23 #include <string.h> /* memset() */
27 #ifdef HAVE_SYS_TAPE_H
28 # include <sys/tape.h>
30 #ifdef HAVE_SYS_MTIO_H
31 # include <sys/mtio.h>
37 /* This is equal to 2*1024*1024*1024 - 16*1024*1024 - 1, but written
38 explicitly to avoid overflow issues. */
39 #define RESETOFS_THRESHOLD (0x7effffff)
41 /* Largest possible block size on SCSI systems. */
42 #define LARGEST_BLOCK_ESTIMATE (16 * 1024 * 1024)
45 * Type checking and casting macros
48 #define TYPE_TAPE_DEVICE (tape_device_get_type())
49 #define TAPE_DEVICE(obj) G_TYPE_CHECK_INSTANCE_CAST((obj), tape_device_get_type(), TapeDevice)
50 #define TAPE_DEVICE_CONST(obj) G_TYPE_CHECK_INSTANCE_CAST((obj), tape_device_get_type(), TapeDevice const)
51 #define TAPE_DEVICE_CLASS(klass) G_TYPE_CHECK_CLASS_CAST((klass), tape_device_get_type(), TapeDeviceClass)
52 #define IS_TAPE_DEVICE(obj) G_TYPE_CHECK_INSTANCE_TYPE((obj), tape_device_get_type ())
53 #define TAPE_DEVICE_GET_CLASS(obj) G_TYPE_INSTANCE_GET_CLASS((obj), tape_device_get_type(), TapeDeviceClass)
54 GType tape_device_get_type (void);
57 * Main object structure
59 typedef struct TapeDevicePrivate_s TapeDevicePrivate;
60 typedef struct _TapeDevice {
63 /* It should go without saying that all this stuff is
64 * look-but-don't-touch. */
66 /* characteristics of the device */
67 gboolean fsf, bsf, fsr, bsr, eom, bsf_after_eom, broken_gmt_online;
69 gboolean nonblocking_open, fsf_after_filemark;
72 /* 0 if we opened with O_RDWR; error otherwise. */
73 gboolean write_open_errno;
76 TapeDevicePrivate * private;
79 struct TapeDevicePrivate_s {
80 /* This holds the total number of bytes written to the device,
81 modulus RESETOFS_THRESHOLD. */
83 char * device_filename;
84 gsize read_block_size;
91 typedef struct _TapeDeviceClass TapeDeviceClass;
92 struct _TapeDeviceClass {
93 DeviceClass __parent__;
96 void tape_device_register(void);
98 /* useful callback for tape ops */
99 void tape_device_set_capabilities(TapeDevice *self,
100 gboolean fsf, PropertySurety fsf_surety, PropertySource fsf_source,
101 gboolean fsf_after_filemark, PropertySurety faf_surety, PropertySource faf_source,
102 gboolean bsf, PropertySurety bsf_surety, PropertySource bsf_source,
103 gboolean fsr, PropertySurety fsr_surety, PropertySource fsr_source,
104 gboolean bsr, PropertySurety bsr_surety, PropertySource bsr_source,
105 gboolean eom, PropertySurety eom_surety, PropertySource eom_source,
106 gboolean leom, PropertySurety leom_surety, PropertySource leom_source,
107 gboolean bsf_after_eom, PropertySurety bae_surety, PropertySource bae_source,
108 guint final_filemarks, PropertySurety ff_surety, PropertySource ff_source);
110 /* Real Operations (always return FALSE if not implemented) */
111 gboolean tape_rewind(int fd);
112 gboolean tape_fsf(int fd, guint count);
113 gboolean tape_bsf(int fd, guint count);
114 gboolean tape_fsr(int fd, guint count);
115 gboolean tape_bsr(int fd, guint count);
116 gint tape_fileno(int fd);
118 /* tape_fileno returns tape position file number, or one of these: */
119 #define TAPE_OP_ERROR -1
120 #define TAPE_POSITION_UNKNOWN -2
122 /* Possible (abstracted) results from a system I/O operation. */
125 RESULT_ERROR, /* Undefined error (*errmsg set) */
126 RESULT_SMALL_BUFFER, /* Tried to read with a buffer that is too
128 RESULT_NO_DATA, /* End of File, while reading */
129 RESULT_NO_SPACE, /* Out of space. Sometimes we don't know if
130 it was this or I/O error, but this is the
131 preferred explanation. */
135 /* returns a fileno like tape_fileno */
136 gint tape_eod(int fd);
138 gboolean tape_weof(int fd, guint8 count);
139 gboolean tape_setcompression(int fd, gboolean on);
141 gboolean tape_offl(int fd);
143 DeviceStatusFlags tape_is_tape_device(int fd);
144 DeviceStatusFlags tape_is_ready(int fd, TapeDevice *t_self);
146 #define tape_device_read_size(self) \
147 (((TapeDevice *)(self))->private->read_block_size? \
148 ((TapeDevice *)(self))->private->read_block_size : ((Device *)(self))->block_size)
151 * Our device-specific properties.
154 #define PROPERTY_BROKEN_GMT_ONLINE (device_property_broken_gmt_online.ID)
155 #define PROPERTY_FSF (device_property_fsf.ID)
156 #define PROPERTY_FSF_AFTER_FILEMARK (device_property_fsf_after_filemark.ID)
157 #define PROPERTY_BSF (device_property_bsf.ID)
158 #define PROPERTY_FSR (device_property_fsr.ID)
159 #define PROPERTY_BSR (device_property_bsr.ID)
160 #define PROPERTY_EOM (device_property_eom.ID)
161 #define PROPERTY_BSF_AFTER_EOM (device_property_bsf_after_eom.ID)
162 #define PROPERTY_NONBLOCKING_OPEN (device_property_nonblocking_open.ID)
163 #define PROPERTY_FINAL_FILEMARKS (device_property_final_filemarks.ID)
165 static DevicePropertyBase device_property_broken_gmt_online;
166 static DevicePropertyBase device_property_fsf;
167 static DevicePropertyBase device_property_fsf_after_filemark;
168 static DevicePropertyBase device_property_bsf;
169 static DevicePropertyBase device_property_fsr;
170 static DevicePropertyBase device_property_bsr;
171 static DevicePropertyBase device_property_eom;
172 static DevicePropertyBase device_property_bsf_after_eom;
173 static DevicePropertyBase device_property_nonblocking_open;
174 static DevicePropertyBase device_property_final_filemarks;
175 static DevicePropertyBase device_property_read_buffer_size; /* old name for READ_BLOCK_SIZE */
177 /* here are local prototypes */
178 static void tape_device_init (TapeDevice * o);
179 static void tape_device_class_init (TapeDeviceClass * c);
180 static void tape_device_base_init (TapeDeviceClass * c);
181 static gboolean tape_device_set_feature_property_fn(Device *p_self, DevicePropertyBase *base,
182 GValue *val, PropertySurety surety, PropertySource source);
183 static gboolean tape_device_set_final_filemarks_fn(Device *p_self, DevicePropertyBase *base,
184 GValue *val, PropertySurety surety, PropertySource source);
185 static gboolean tape_device_set_compression_fn(Device *p_self, DevicePropertyBase *base,
186 GValue *val, PropertySurety surety, PropertySource source);
187 static gboolean tape_device_get_read_block_size_fn(Device *p_self, DevicePropertyBase *base,
188 GValue *val, PropertySurety *surety, PropertySource *source);
189 static gboolean tape_device_set_read_block_size_fn(Device *p_self, DevicePropertyBase *base,
190 GValue *val, PropertySurety surety, PropertySource source);
191 static void tape_device_open_device (Device * self, char * device_name, char * device_type, char * device_node);
192 static Device * tape_device_factory (char * device_name, char * device_type, char * device_node);
193 static DeviceStatusFlags tape_device_read_label(Device * self);
194 static gboolean tape_device_write_block(Device * self, guint size, gpointer data);
195 static int tape_device_read_block(Device * self, gpointer buf,
197 static gboolean tape_device_start (Device * self, DeviceAccessMode mode,
198 char * label, char * timestamp);
199 static gboolean tape_device_start_file (Device * self, dumpfile_t * ji);
200 static gboolean tape_device_finish_file (Device * self);
201 static dumpfile_t * tape_device_seek_file (Device * self, guint file);
202 static gboolean tape_device_seek_block (Device * self, guint64 block);
203 static gboolean tape_device_eject (Device * self);
204 static gboolean tape_device_finish (Device * self);
205 static IoResult tape_device_robust_read (TapeDevice * self, void * buf,
206 int * count, char **errmsg);
207 static IoResult tape_device_robust_write (TapeDevice * self, void * buf, int count, char **errmsg);
208 static gboolean tape_device_fsf (TapeDevice * self, guint count);
209 static gboolean tape_device_fsr (TapeDevice * self, guint count);
210 static gboolean tape_device_bsr (TapeDevice * self, guint count, guint file, guint block);
211 static gboolean tape_device_eod (TapeDevice * self);
213 /* pointer to the class of our parent */
214 static DeviceClass *parent_class = NULL;
216 GType tape_device_get_type (void)
218 static GType type = 0;
220 if G_UNLIKELY(type == 0) {
221 static const GTypeInfo info = {
222 sizeof (TapeDeviceClass),
223 (GBaseInitFunc) tape_device_base_init,
224 (GBaseFinalizeFunc) NULL,
225 (GClassInitFunc) tape_device_class_init,
226 (GClassFinalizeFunc) NULL,
227 NULL /* class_data */,
230 (GInstanceInitFunc) tape_device_init,
234 type = g_type_register_static (TYPE_DEVICE, "TapeDevice",
235 &info, (GTypeFlags)0);
242 tape_device_init (TapeDevice * self) {
246 d_self = DEVICE(self);
247 bzero(&response, sizeof(response));
249 self->private = g_new0(TapeDevicePrivate, 1);
251 /* Clear all fields. */
252 d_self->block_size = 32768;
253 d_self->min_block_size = 32768;
254 d_self->max_block_size = LARGEST_BLOCK_ESTIMATE;
255 self->broken_gmt_online = FALSE;
259 /* set all of the feature properties to an unsure default of FALSE */
260 self->broken_gmt_online = FALSE;
267 self->bsf_after_eom = FALSE;
269 g_value_init(&response, G_TYPE_BOOLEAN);
270 g_value_set_boolean(&response, FALSE);
271 device_set_simple_property(d_self, PROPERTY_BROKEN_GMT_ONLINE,
272 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
273 device_set_simple_property(d_self, PROPERTY_FSF,
274 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
275 device_set_simple_property(d_self, PROPERTY_FSF_AFTER_FILEMARK,
276 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
277 device_set_simple_property(d_self, PROPERTY_BSF,
278 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
279 device_set_simple_property(d_self, PROPERTY_FSR,
280 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
281 device_set_simple_property(d_self, PROPERTY_BSR,
282 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
283 device_set_simple_property(d_self, PROPERTY_EOM,
284 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
285 device_set_simple_property(d_self, PROPERTY_LEOM,
286 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
287 device_set_simple_property(d_self, PROPERTY_BSF_AFTER_EOM,
288 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
290 #ifdef DEFAULT_TAPE_NON_BLOCKING_OPEN
291 self->nonblocking_open = TRUE;
293 self->nonblocking_open = FALSE;
295 g_value_set_boolean(&response, self->nonblocking_open);
296 device_set_simple_property(d_self, PROPERTY_NONBLOCKING_OPEN,
297 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
298 g_value_unset(&response);
300 self->final_filemarks = 2;
301 g_value_init(&response, G_TYPE_UINT);
302 g_value_set_uint(&response, self->final_filemarks);
303 device_set_simple_property(d_self, PROPERTY_FINAL_FILEMARKS,
304 &response, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
305 g_value_unset(&response);
307 self->private->read_block_size = 0;
308 g_value_init(&response, G_TYPE_UINT);
309 g_value_set_uint(&response, self->private->read_block_size);
310 device_set_simple_property(d_self, PROPERTY_READ_BLOCK_SIZE,
311 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DEFAULT);
312 g_value_unset(&response);
314 self->private->write_count = 0;
315 self->private->device_filename = NULL;
317 /* Static properites */
318 g_value_init(&response, CONCURRENCY_PARADIGM_TYPE);
319 g_value_set_enum(&response, CONCURRENCY_PARADIGM_EXCLUSIVE);
320 device_set_simple_property(d_self, PROPERTY_CONCURRENCY,
321 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
322 g_value_unset(&response);
324 g_value_init(&response, STREAMING_REQUIREMENT_TYPE);
325 g_value_set_enum(&response, STREAMING_REQUIREMENT_DESIRED);
326 device_set_simple_property(d_self, PROPERTY_STREAMING,
327 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
328 g_value_unset(&response);
330 g_value_init(&response, G_TYPE_BOOLEAN);
331 g_value_set_boolean(&response, TRUE);
332 device_set_simple_property(d_self, PROPERTY_APPENDABLE,
333 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
334 g_value_unset(&response);
336 g_value_init(&response, G_TYPE_BOOLEAN);
337 g_value_set_boolean(&response, FALSE);
338 device_set_simple_property(d_self, PROPERTY_PARTIAL_DELETION,
339 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
340 g_value_unset(&response);
342 g_value_init(&response, G_TYPE_BOOLEAN);
343 g_value_set_boolean(&response, FALSE);
344 device_set_simple_property(d_self, PROPERTY_FULL_DELETION,
345 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
346 g_value_unset(&response);
348 g_value_init(&response, MEDIA_ACCESS_MODE_TYPE);
349 g_value_set_enum(&response, MEDIA_ACCESS_MODE_READ_WRITE);
350 device_set_simple_property(d_self, PROPERTY_MEDIUM_ACCESS_TYPE,
351 &response, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
352 g_value_unset(&response);
355 static void tape_device_finalize(GObject * obj_self) {
356 TapeDevice * self = TAPE_DEVICE(obj_self);
358 if(G_OBJECT_CLASS(parent_class)->finalize) \
359 (* G_OBJECT_CLASS(parent_class)->finalize)(obj_self);
361 robust_close(self->fd);
363 amfree(self->private->device_filename);
364 amfree(self->private);
368 tape_device_class_init (TapeDeviceClass * c)
370 DeviceClass *device_class = (DeviceClass *)c;
371 GObjectClass *g_object_class = (GObjectClass *)c;
373 parent_class = g_type_class_ref (TYPE_DEVICE);
375 device_class->open_device = tape_device_open_device;
376 device_class->read_label = tape_device_read_label;
377 device_class->write_block = tape_device_write_block;
378 device_class->read_block = tape_device_read_block;
379 device_class->start = tape_device_start;
380 device_class->start_file = tape_device_start_file;
381 device_class->finish_file = tape_device_finish_file;
382 device_class->seek_file = tape_device_seek_file;
383 device_class->seek_block = tape_device_seek_block;
384 device_class->eject = tape_device_eject;
385 device_class->finish = tape_device_finish;
387 g_object_class->finalize = tape_device_finalize;
391 tape_device_base_init (TapeDeviceClass * c)
393 DeviceClass *device_class = (DeviceClass *)c;
395 device_class_register_property(device_class, PROPERTY_BROKEN_GMT_ONLINE,
396 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
397 device_simple_property_get_fn,
398 tape_device_set_feature_property_fn);
400 device_class_register_property(device_class, PROPERTY_FSF,
401 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
402 device_simple_property_get_fn,
403 tape_device_set_feature_property_fn);
405 device_class_register_property(device_class, PROPERTY_FSF_AFTER_FILEMARK,
406 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
407 device_simple_property_get_fn,
408 tape_device_set_feature_property_fn);
410 device_class_register_property(device_class, PROPERTY_BSF,
411 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
412 device_simple_property_get_fn,
413 tape_device_set_feature_property_fn);
415 device_class_register_property(device_class, PROPERTY_FSR,
416 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
417 device_simple_property_get_fn,
418 tape_device_set_feature_property_fn);
420 device_class_register_property(device_class, PROPERTY_BSR,
421 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
422 device_simple_property_get_fn,
423 tape_device_set_feature_property_fn);
425 device_class_register_property(device_class, PROPERTY_EOM,
426 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
427 device_simple_property_get_fn,
428 tape_device_set_feature_property_fn);
430 device_class_register_property(device_class, PROPERTY_BSF_AFTER_EOM,
431 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
432 device_simple_property_get_fn,
433 tape_device_set_feature_property_fn);
435 device_class_register_property(device_class, PROPERTY_NONBLOCKING_OPEN,
436 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
437 device_simple_property_get_fn,
438 tape_device_set_feature_property_fn);
440 device_class_register_property(device_class, PROPERTY_FINAL_FILEMARKS,
441 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
442 device_simple_property_get_fn,
443 tape_device_set_final_filemarks_fn);
445 /* We don't (yet?) support reading the device's compression state, so not
447 device_class_register_property(device_class, PROPERTY_COMPRESSION,
448 PROPERTY_ACCESS_SET_MASK,
450 tape_device_set_compression_fn);
452 device_class_register_property(device_class, PROPERTY_READ_BLOCK_SIZE,
453 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
454 tape_device_get_read_block_size_fn,
455 tape_device_set_read_block_size_fn);
457 device_class_register_property(device_class, device_property_read_buffer_size.ID,
458 PROPERTY_ACCESS_GET_MASK | PROPERTY_ACCESS_SET_BEFORE_START,
459 tape_device_get_read_block_size_fn,
460 tape_device_set_read_block_size_fn);
464 tape_device_set_feature_property_fn(Device *p_self, DevicePropertyBase *base,
465 GValue *val, PropertySurety surety, PropertySource source)
467 TapeDevice *self = TAPE_DEVICE(p_self);
469 gboolean old_bool, new_bool;
470 PropertySurety old_surety;
471 PropertySource old_source;
473 new_bool = g_value_get_boolean(val);
475 /* get the old source and surety and see if we're willing to make this change */
476 bzero(&old_val, sizeof(old_val));
477 if (device_get_simple_property(p_self, base->ID, &old_val, &old_surety, &old_source)) {
478 old_bool = g_value_get_boolean(&old_val);
480 if (old_surety == PROPERTY_SURETY_GOOD && old_source == PROPERTY_SOURCE_DETECTED) {
481 if (new_bool != old_bool) {
482 device_set_error(p_self, vstrallocf(_(
483 "Value for property '%s' was autodetected and cannot be changed"),
485 DEVICE_STATUS_DEVICE_ERROR);
488 /* pretend we set it, but don't change surety/source */
494 /* (note: PROPERTY_* are not constants, so we can't use switch) */
495 if (base->ID == PROPERTY_BROKEN_GMT_ONLINE)
496 self->broken_gmt_online = new_bool;
497 else if (base->ID == PROPERTY_FSF)
498 self->fsf = new_bool;
499 else if (base->ID == PROPERTY_FSF_AFTER_FILEMARK)
500 self->fsf_after_filemark = new_bool;
501 else if (base->ID == PROPERTY_BSF)
502 self->bsf = new_bool;
503 else if (base->ID == PROPERTY_FSR)
504 self->fsr = new_bool;
505 else if (base->ID == PROPERTY_BSR)
506 self->bsr = new_bool;
507 else if (base->ID == PROPERTY_EOM)
508 self->eom = new_bool;
509 else if (base->ID == PROPERTY_BSF_AFTER_EOM)
510 self->bsf_after_eom = new_bool;
511 else if (base->ID == PROPERTY_NONBLOCKING_OPEN)
512 self->nonblocking_open = new_bool;
514 return FALSE; /* shouldn't happen */
516 return device_simple_property_set_fn(p_self, base, val, surety, source);
520 tape_device_set_final_filemarks_fn(Device *p_self, DevicePropertyBase *base,
521 GValue *val, PropertySurety surety, PropertySource source)
523 TapeDevice *self = TAPE_DEVICE(p_self);
525 gboolean old_int, new_int;
526 PropertySurety old_surety;
527 PropertySource old_source;
529 new_int = g_value_get_uint(val);
531 /* get the old source and surety and see if we're willing to make this change */
532 bzero(&old_val, sizeof(old_val));
533 if (device_get_simple_property(p_self, base->ID, &old_val, &old_surety, &old_source)) {
534 old_int = g_value_get_uint(&old_val);
536 if (old_surety == PROPERTY_SURETY_GOOD && old_source == PROPERTY_SOURCE_DETECTED) {
537 if (new_int != old_int) {
538 device_set_error(p_self, vstrallocf(_(
539 "Value for property '%s' was autodetected and cannot be changed"),
541 DEVICE_STATUS_DEVICE_ERROR);
544 /* pretend we set it, but don't change surety/source */
550 self->final_filemarks = new_int;
552 return device_simple_property_set_fn(p_self, base, val, surety, source);
556 tape_device_set_compression_fn(Device *p_self, DevicePropertyBase *base,
557 GValue *val, PropertySurety surety, PropertySource source)
559 TapeDevice *self = TAPE_DEVICE(p_self);
560 gboolean request = g_value_get_boolean(val);
562 /* We allow this property to be set at any time. This is mostly
563 * because setting compression is a hit-and-miss proposition
564 * at any time; some drives accept the mode setting but don't
565 * actually support compression, while others do support
566 * compression but do it via density settings or some other
567 * way. Set this property whenever you want, but all we'll do
568 * is report whether or not the ioctl succeeded. */
569 if (tape_setcompression(self->fd, request)) {
570 /* looks good .. let's start the device over, though */
571 device_clear_volume_details(p_self);
576 return device_simple_property_set_fn(p_self, base, val, surety, source);
580 tape_device_get_read_block_size_fn(Device *p_self, DevicePropertyBase *base G_GNUC_UNUSED,
581 GValue *val, PropertySurety *surety, PropertySource *source)
583 /* use the READ_BLOCK_SIZE, even if we're invoked to get the old READ_BUFFER_SIZE */
584 return device_simple_property_get_fn(p_self, &device_property_read_block_size,
585 val, surety, source);
589 tape_device_set_read_block_size_fn(Device *p_self, DevicePropertyBase *base G_GNUC_UNUSED,
590 GValue *val, PropertySurety surety, PropertySource source)
592 TapeDevice *self = TAPE_DEVICE(p_self);
593 guint read_block_size = g_value_get_uint(val);
595 if (read_block_size != 0 &&
596 ((gsize)read_block_size < p_self->block_size ||
597 (gsize)read_block_size > p_self->max_block_size))
600 self->private->read_block_size = read_block_size;
602 /* use the READ_BLOCK_SIZE, even if we're invoked to get the old READ_BUFFER_SIZE */
603 return device_simple_property_set_fn(p_self, &device_property_read_block_size,
604 val, surety, source);
607 void tape_device_register(void) {
608 static const char * device_prefix_list[] = { "tape", NULL };
610 /* First register tape-specific properties */
611 device_property_fill_and_register(&device_property_broken_gmt_online,
612 G_TYPE_BOOLEAN, "broken_gmt_online",
613 "Does this drive support the GMT_ONLINE macro?");
615 device_property_fill_and_register(&device_property_fsf,
616 G_TYPE_BOOLEAN, "fsf",
617 "Does this drive support the MTFSF command?");
619 device_property_fill_and_register(&device_property_fsf_after_filemark,
620 G_TYPE_BOOLEAN, "fsf_after_filemark",
621 "Does this drive needs a FSF if a filemark is already read?");
623 device_property_fill_and_register(&device_property_bsf,
624 G_TYPE_BOOLEAN, "bsf",
625 "Does this drive support the MTBSF command?" );
627 device_property_fill_and_register(&device_property_fsr,
628 G_TYPE_BOOLEAN, "fsr",
629 "Does this drive support the MTFSR command?");
631 device_property_fill_and_register(&device_property_bsr,
632 G_TYPE_BOOLEAN, "bsr",
633 "Does this drive support the MTBSR command?");
635 device_property_fill_and_register(&device_property_eom,
636 G_TYPE_BOOLEAN, "eom",
637 "Does this drive support the MTEOM command?");
639 device_property_fill_and_register(&device_property_bsf_after_eom,
642 "Does this drive require an MTBSF after MTEOM in order to append?" );
644 device_property_fill_and_register(&device_property_nonblocking_open,
647 "Does this drive require a open with O_NONBLOCK?" );
649 device_property_fill_and_register(&device_property_final_filemarks,
650 G_TYPE_UINT, "final_filemarks",
651 "How many filemarks to write after the last tape file?" );
653 device_property_fill_and_register(&device_property_read_buffer_size,
654 G_TYPE_UINT, "read_buffer_size",
655 "(deprecated name for READ_BLOCK_SIZE)");
657 /* Then the device itself */
658 register_device(tape_device_factory, device_prefix_list);
661 /* Open the tape device, trying various combinations of O_RDWR and
662 O_NONBLOCK. Returns -1 and calls device_set_error for errors
663 On Linux, with O_NONBLOCK, the kernel just checks the state once,
664 whereas it checks it every second for ST_BLOCK_SECONDS if O_NONBLOCK is
665 not given. Amanda already have the code to poll, we want open to check
666 the state only once. */
668 static int try_open_tape_device(TapeDevice * self, char * device_filename) {
671 DeviceStatusFlags new_status;
676 if (self->nonblocking_open) {
677 nonblocking = O_NONBLOCK;
682 fd = robust_open(device_filename, O_RDWR | nonblocking, 0);
684 if (fd < 0 && nonblocking && (save_errno == EWOULDBLOCK || save_errno == EINVAL)) {
685 /* Maybe we don't support O_NONBLOCK for tape devices. */
686 fd = robust_open(device_filename, O_RDWR, 0);
690 fd = robust_open(device_filename, O_RDWR, 0);
694 self->write_open_errno = 0;
696 if (errno == EACCES || errno == EPERM
701 /* Device is write-protected. */
702 self->write_open_errno = errno;
704 fd = robust_open(device_filename, O_RDONLY | nonblocking, 0);
706 if (fd < 0 && nonblocking && (save_errno == EWOULDBLOCK || save_errno == EINVAL)) {
707 fd = robust_open(device_filename, O_RDONLY, 0);
711 fd = robust_open(device_filename, O_RDONLY, 0);
717 /* Clear O_NONBLOCK for operations from now on. */
718 if (fd >= 0 && nonblocking)
719 fcntl(fd, F_SETFL, fcntl(fd, F_GETFL, 0) & ~O_NONBLOCK);
721 /* function continues after #endif */
723 #endif /* O_NONBLOCK */
726 DeviceStatusFlags status_flag = 0;
728 status_flag = DEVICE_STATUS_DEVICE_BUSY;
730 status_flag = DEVICE_STATUS_DEVICE_ERROR;
731 device_set_error(DEVICE(self),
732 vstrallocf(_("Can't open tape device %s: %s"), self->private->device_filename, strerror(errno)),
737 /* Check that this is actually a tape device. */
738 new_status = tape_is_tape_device(fd);
739 if (new_status & DEVICE_STATUS_DEVICE_ERROR) {
740 device_set_error(DEVICE(self),
741 vstrallocf(_("File %s is not a tape device"), self->private->device_filename),
746 if (new_status & DEVICE_STATUS_VOLUME_MISSING) {
747 device_set_error(DEVICE(self),
748 vstrallocf(_("Tape device %s is not ready or is empty"), self->private->device_filename),
754 new_status = tape_is_ready(fd, self);
755 if (new_status & DEVICE_STATUS_VOLUME_MISSING) {
756 device_set_error(DEVICE(self),
757 vstrallocf(_("Tape device %s is empty"), self->private->device_filename),
762 if (new_status != DEVICE_STATUS_SUCCESS) {
763 device_set_error(DEVICE(self),
764 vstrallocf(_("Tape device %s is not ready or is empty"), self->private->device_filename),
774 tape_device_open_device (Device * dself, char * device_name,
775 char * device_type, char * device_node) {
779 self = TAPE_DEVICE(dself);
782 self->private->device_filename = stralloc(device_node);
784 /* Set tape drive/OS info */
785 bzero(&val, sizeof(val));
786 g_value_init(&val, G_TYPE_BOOLEAN);
789 g_value_set_boolean(&val, self->fsf);
790 device_set_simple_property(dself, PROPERTY_FSF, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
792 self->fsf_after_filemark = DEFAULT_FSF_AFTER_FILEMARK;
793 g_value_set_boolean(&val, self->fsf_after_filemark);
794 device_set_simple_property(dself, PROPERTY_FSF_AFTER_FILEMARK, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
797 g_value_set_boolean(&val, self->bsf);
798 device_set_simple_property(dself, PROPERTY_BSF, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
801 g_value_set_boolean(&val, self->fsr);
802 device_set_simple_property(dself, PROPERTY_FSR, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
805 g_value_set_boolean(&val, self->bsr);
806 device_set_simple_property(dself, PROPERTY_BSR, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
809 g_value_set_boolean(&val, self->eom);
810 device_set_simple_property(dself, PROPERTY_EOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
813 g_value_set_boolean(&val, self->leom);
814 device_set_simple_property(dself, PROPERTY_LEOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
816 self->bsf_after_eom = FALSE;
817 g_value_set_boolean(&val, self->bsf_after_eom);
818 device_set_simple_property(dself, PROPERTY_BSF_AFTER_EOM, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
821 g_value_init(&val, G_TYPE_UINT);
823 self->final_filemarks = 2;
824 g_value_set_uint(&val, self->final_filemarks);
825 device_set_simple_property(dself, PROPERTY_FINAL_FILEMARKS, &val, PROPERTY_SURETY_BAD, PROPERTY_SOURCE_DEFAULT);
830 if (parent_class->open_device) {
831 parent_class->open_device(dself, device_name, device_type, device_node);
836 static DeviceStatusFlags tape_device_read_label(Device * dself) {
838 char * header_buffer;
842 DeviceStatusFlags new_status;
845 self = TAPE_DEVICE(dself);
847 amfree(dself->volume_label);
848 amfree(dself->volume_time);
849 dumpfile_free(dself->volume_header);
850 dself->volume_header = NULL;
852 if (device_in_error(self)) return dself->status;
854 if (self->fd == -1) {
855 self->fd = try_open_tape_device(self, self->private->device_filename);
856 /* if the open failed, then try_open_tape_device already set the
857 * approppriate error status */
859 return dself->status;
863 if (!tape_rewind(self->fd)) {
864 device_set_error(dself,
865 vstrallocf(_("Error rewinding device %s to read label: %s"),
866 self->private->device_filename, strerror(errno)),
867 DEVICE_STATUS_DEVICE_ERROR
868 | DEVICE_STATUS_VOLUME_ERROR);
869 return dself->status;
872 buffer_len = tape_device_read_size(self);
873 header_buffer = malloc(buffer_len);
874 result = tape_device_robust_read(self, header_buffer, &buffer_len, &msg);
876 if (result != RESULT_SUCCESS) {
878 tape_rewind(self->fd);
882 msg = stralloc(_("no data"));
883 new_status = (DEVICE_STATUS_VOLUME_ERROR |
884 DEVICE_STATUS_VOLUME_UNLABELED);
885 header = dself->volume_header = g_new(dumpfile_t, 1);
889 case RESULT_SMALL_BUFFER:
890 msg = stralloc(_("block size too small"));
891 new_status = (DEVICE_STATUS_DEVICE_ERROR |
892 DEVICE_STATUS_VOLUME_ERROR);
893 header = dself->volume_header = g_new(dumpfile_t, 1);
895 header->type = F_WEIRD;
899 msg = stralloc(_("unknown error"));
901 new_status = (DEVICE_STATUS_DEVICE_ERROR |
902 DEVICE_STATUS_VOLUME_ERROR |
903 DEVICE_STATUS_VOLUME_UNLABELED);
906 device_set_error(dself,
907 g_strdup_printf(_("Error reading Amanda header: %s"),
908 msg? msg : _("unknown error")),
911 return dself->status;
914 header = dself->volume_header = g_new(dumpfile_t, 1);
917 parse_file_header(header_buffer, header, buffer_len);
918 amfree(header_buffer);
919 if (header->type != F_TAPESTART) {
920 device_set_error(dself,
921 stralloc(_("No tapestart header -- unlabeled device?")),
922 DEVICE_STATUS_VOLUME_UNLABELED);
923 return dself->status;
926 dself->volume_label = g_strdup(header->name);
927 dself->volume_time = g_strdup(header->datestamp);
928 /* dself->volume_header is already set */
930 device_set_error(dself, NULL, DEVICE_STATUS_SUCCESS);
932 return dself->status;
936 tape_device_write_block(Device * pself, guint size, gpointer data) {
938 char *replacement_buffer = NULL;
942 self = TAPE_DEVICE(pself);
944 g_assert(self->fd >= 0);
945 if (device_in_error(self)) return FALSE;
947 /* zero out to the end of a short block -- tape devices only write
949 if (size < pself->block_size) {
950 replacement_buffer = malloc(pself->block_size);
951 memcpy(replacement_buffer, data, size);
952 bzero(replacement_buffer+size, pself->block_size-size);
954 data = replacement_buffer;
955 size = pself->block_size;
958 result = tape_device_robust_write(self, data, size, &msg);
959 amfree(replacement_buffer);
965 case RESULT_NO_SPACE:
966 device_set_error(pself,
967 stralloc(_("No space left on device")),
968 DEVICE_STATUS_VOLUME_ERROR);
969 pself->is_eom = TRUE;
973 msg = stralloc(_("unknown error"));
975 device_set_error(pself,
976 g_strdup_printf(_("Error writing block: %s"), msg),
977 DEVICE_STATUS_DEVICE_ERROR);
987 static int tape_device_read_block (Device * pself, gpointer buf,
992 gssize read_block_size = tape_device_read_size(pself);
995 self = TAPE_DEVICE(pself);
997 g_assert(self->fd >= 0);
998 if (device_in_error(self)) return -1;
1000 g_assert(read_block_size < INT_MAX); /* data type mismatch */
1001 if (buf == NULL || *size_req < (int)read_block_size) {
1002 /* Just a size query. */
1003 *size_req = (int)read_block_size;
1008 result = tape_device_robust_read(self, buf, &size, &msg);
1010 case RESULT_SUCCESS:
1014 case RESULT_SMALL_BUFFER: {
1018 /* If this happens, it means that we have:
1019 * (next block size) > (buffer size) >= (read_block_size)
1020 * The solution is to ask for an even bigger buffer. We also play
1021 * some games to refrain from reading above the SCSI limit or from
1022 * integer overflow. Note that not all devices will tell us about
1023 * this problem -- some will just discard the "extra" data. */
1024 new_size = MIN(INT_MAX/2 - 1, *size_req) * 2;
1025 if (new_size > LARGEST_BLOCK_ESTIMATE &&
1026 *size_req < LARGEST_BLOCK_ESTIMATE) {
1027 new_size = LARGEST_BLOCK_ESTIMATE;
1029 g_assert (new_size > (gsize)*size_req);
1031 g_info("Device %s indicated blocksize %zd was too small; using %zd.",
1032 pself->device_name, (gsize)*size_req, new_size);
1033 *size_req = (int)new_size;
1034 self->private->read_block_size = new_size;
1036 bzero(&newval, sizeof(newval));
1037 g_value_init(&newval, G_TYPE_UINT);
1038 g_value_set_uint(&newval, self->private->read_block_size);
1039 device_set_simple_property(pself, PROPERTY_READ_BLOCK_SIZE,
1040 &newval, PROPERTY_SURETY_GOOD, PROPERTY_SOURCE_DETECTED);
1041 g_value_unset(&newval);
1045 case RESULT_NO_DATA:
1046 pself->is_eof = TRUE;
1047 pself->in_file = FALSE;
1048 device_set_error(pself,
1050 DEVICE_STATUS_SUCCESS);
1054 msg = stralloc(_("unknown error"));
1056 device_set_error(pself,
1057 vstrallocf(_("Error reading from tape device: %s"), msg),
1058 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1063 g_assert_not_reached();
1066 /* Just a helper function for tape_device_start(). */
1067 static gboolean write_tapestart_header(TapeDevice * self, char * label,
1070 dumpfile_t * header;
1072 Device * d_self = (Device*)self;
1075 tape_rewind(self->fd);
1077 header = make_tapestart_header(d_self, label, timestamp);
1078 g_assert(header != NULL);
1079 header_buf = device_build_amanda_header(d_self, header, NULL);
1080 if (header_buf == NULL) {
1081 device_set_error(d_self,
1082 stralloc(_("Tapestart header won't fit in a single block!")),
1083 DEVICE_STATUS_DEVICE_ERROR);
1084 dumpfile_free(header);
1087 dumpfile_free(d_self->volume_header);
1088 d_self->volume_header = NULL;
1090 result = tape_device_robust_write(self, header_buf, d_self->block_size, &msg);
1091 if (result != RESULT_SUCCESS) {
1092 device_set_error(d_self,
1093 g_strdup_printf(_("Error writing tapestart header: %s"),
1094 (result == RESULT_ERROR)? msg : _("out of space")),
1095 DEVICE_STATUS_DEVICE_ERROR);
1097 if (result == RESULT_NO_SPACE)
1098 d_self->is_eom = TRUE;
1101 dumpfile_free(header);
1108 if (!tape_weof(self->fd, 1)) {
1109 device_set_error(d_self,
1110 vstrallocf(_("Error writing filemark: %s"),
1112 DEVICE_STATUS_DEVICE_ERROR|DEVICE_STATUS_VOLUME_ERROR);
1113 /* can't tell if this was EOM or not, so assume it is */
1114 d_self->is_eom = TRUE;
1115 dumpfile_free(header);
1119 d_self->volume_header = header;
1124 tape_device_start (Device * d_self, DeviceAccessMode mode, char * label,
1128 self = TAPE_DEVICE(d_self);
1130 if (device_in_error(self)) return FALSE;
1132 if (self->fd == -1) {
1133 self->fd = try_open_tape_device(self, self->private->device_filename);
1134 /* if the open failed, then try_open_tape_device already set the
1135 * approppriate error status */
1140 if (mode != ACCESS_WRITE && d_self->volume_label == NULL) {
1141 /* we need a labeled volume for APPEND and READ */
1142 if (tape_device_read_label(d_self) != DEVICE_STATUS_SUCCESS)
1146 d_self->access_mode = mode;
1147 d_self->in_file = FALSE;
1149 if (IS_WRITABLE_ACCESS_MODE(mode)) {
1150 if (self->write_open_errno != 0) {
1151 /* We tried and failed to open the device in write mode. */
1152 device_set_error(d_self,
1153 vstrallocf(_("Can't open tape device %s for writing: %s"),
1154 self->private->device_filename, strerror(self->write_open_errno)),
1155 DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
1157 } else if (!tape_rewind(self->fd)) {
1158 device_set_error(d_self,
1159 vstrallocf(_("Error rewinding device to start: %s"), strerror(errno)),
1160 DEVICE_STATUS_DEVICE_ERROR);
1165 /* Position the tape */
1168 if (d_self->volume_label == NULL && device_read_label(d_self) != DEVICE_STATUS_SUCCESS) {
1169 /* device_read_label already set our error message */
1173 if (!tape_device_eod(self)) {
1174 device_set_error(d_self,
1175 vstrallocf(_("Couldn't seek to end of tape: %s"), strerror(errno)),
1176 DEVICE_STATUS_DEVICE_ERROR);
1182 if (d_self->volume_label == NULL && device_read_label(d_self) != DEVICE_STATUS_SUCCESS) {
1183 /* device_read_label already set our error message */
1187 if (!tape_rewind(self->fd)) {
1188 device_set_error(d_self,
1189 vstrallocf(_("Error rewinding device after reading label: %s"), strerror(errno)),
1190 DEVICE_STATUS_DEVICE_ERROR);
1197 if (!write_tapestart_header(self, label, timestamp)) {
1198 /* write_tapestart_header already set the error status */
1202 d_self->volume_label = newstralloc(d_self->volume_label, label);
1203 d_self->volume_time = newstralloc(d_self->volume_time, timestamp);
1205 /* unset the VOLUME_UNLABELED flag, if it was set */
1206 device_set_error(d_self, NULL, DEVICE_STATUS_SUCCESS);
1211 g_assert_not_reached();
1217 static gboolean tape_device_start_file(Device * d_self,
1218 dumpfile_t * info) {
1221 char * amanda_header;
1224 self = TAPE_DEVICE(d_self);
1226 g_assert(self->fd >= 0);
1227 if (device_in_error(self)) return FALSE;
1229 /* set the blocksize in the header properly */
1230 info->blocksize = d_self->block_size;
1232 /* Make the Amanda header suitable for writing to the device. */
1233 /* Then write the damn thing. */
1234 amanda_header = device_build_amanda_header(d_self, info, NULL);
1235 if (amanda_header == NULL) {
1236 device_set_error(d_self,
1237 stralloc(_("Amanda file header won't fit in a single block!")),
1238 DEVICE_STATUS_DEVICE_ERROR);
1242 result = tape_device_robust_write(self, amanda_header, d_self->block_size, &msg);
1243 if (result != RESULT_SUCCESS) {
1244 device_set_error(d_self,
1245 vstrallocf(_("Error writing file header: %s"),
1246 (result == RESULT_ERROR)? msg : _("out of space")),
1247 DEVICE_STATUS_DEVICE_ERROR);
1249 if (result == RESULT_NO_SPACE)
1250 d_self->is_eom = TRUE;
1252 amfree(amanda_header);
1256 amfree(amanda_header);
1258 /* arrange the file numbers correctly */
1259 d_self->in_file = TRUE;
1261 if (d_self->file >= 0)
1267 tape_device_finish_file (Device * d_self) {
1270 self = TAPE_DEVICE(d_self);
1271 if (device_in_error(d_self)) return FALSE;
1273 if (!tape_weof(self->fd, 1)) {
1274 device_set_error(d_self,
1275 vstrallocf(_("Error writing filemark: %s"), strerror(errno)),
1276 DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
1277 /* can't tell if this was EOM or not, so assume it is */
1278 d_self->is_eom = TRUE;
1282 d_self->in_file = FALSE;
1287 tape_device_seek_file (Device * d_self, guint file) {
1291 char * header_buffer;
1297 self = TAPE_DEVICE(d_self);
1299 if (device_in_error(self)) return NULL;
1301 difference = file - d_self->file;
1303 /* Check if we already read a filemark. */
1304 /* If we already read a filemark and the drive automaticaly goes to the
1305 next file, then we must reduce the difference by one. */
1306 if (d_self->is_eof && !self->fsf_after_filemark) {
1310 d_self->in_file = FALSE;
1311 d_self->is_eof = FALSE;
1315 if (difference > 0) {
1316 /* Seeking forwards */
1317 if (!tape_device_fsf(self, difference)) {
1318 tape_rewind(self->fd);
1319 device_set_error(d_self,
1320 vstrallocf(_("Could not seek forward to file %d"), file),
1321 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1324 } else { /* (difference <= 0) */
1325 /* Seeking backwards, or to this file itself */
1327 /* if the drive supports bsf, we can do this the fancy way */
1329 /* bsf one more than the difference */
1330 if (!tape_bsf(self->fd, -difference + 1)) {
1331 tape_rewind(self->fd);
1332 device_set_error(d_self,
1333 vstrallocf(_("Could not seek backward to file %d"), file),
1334 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1338 /* now we are on the BOT side of the desired filemark, so FSF to get to the
1340 if (!tape_device_fsf(self, 1)) {
1341 tape_rewind(self->fd);
1342 device_set_error(d_self,
1343 vstrallocf(_("Could not seek forward to file %d"), file),
1344 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1348 /* no BSF, so just rewind and seek forward */
1349 if (!tape_rewind(self->fd)) {
1350 device_set_error(d_self,
1351 vstrallocf(_("Could not rewind device while emulating BSF")),
1352 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1356 if (!tape_device_fsf(self, file)) {
1357 tape_rewind(self->fd);
1358 device_set_error(d_self,
1359 vstrallocf(_("Could not seek forward to file %d"), file),
1360 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1366 /* double-check that we're on the right fileno, if possible. This is most
1367 * likely a programming error if it occurs, but could also be due to a weird
1368 * tape drive or driver (and that would *never* happen, right?) */
1369 got_file = tape_fileno(self->fd);
1370 if (got_file >= 0 && (guint)got_file != file) {
1371 device_set_error(d_self,
1372 vstrallocf(_("Could not seek to file %d correctly; got %d"),
1374 DEVICE_STATUS_DEVICE_ERROR);
1375 d_self->file = (guint)got_file;
1379 buffer_len = tape_device_read_size(d_self);
1380 header_buffer = malloc(buffer_len);
1381 d_self->is_eof = FALSE;
1382 result = tape_device_robust_read(self, header_buffer, &buffer_len, &msg);
1384 if (result != RESULT_SUCCESS) {
1385 free(header_buffer);
1386 tape_rewind(self->fd);
1388 case RESULT_NO_DATA:
1389 /* If we read 0 bytes, that means we encountered a double
1390 * filemark, which indicates end of tape. This should
1391 * work even with QIC tapes on operating systems with
1392 * proper support. */
1393 d_self->file = file; /* other attributes are already correct */
1394 return make_tapeend_header();
1396 case RESULT_SMALL_BUFFER:
1397 msg = stralloc(_("block size too small"));
1401 msg = stralloc(_("unknown error"));
1405 device_set_error(d_self,
1406 g_strdup_printf(_("Error reading Amanda header: %s"), msg),
1407 DEVICE_STATUS_DEVICE_ERROR | DEVICE_STATUS_VOLUME_ERROR);
1412 rval = g_new(dumpfile_t, 1);
1413 parse_file_header(header_buffer, rval, buffer_len);
1414 amfree(header_buffer);
1415 switch (rval->type) {
1417 case F_CONT_DUMPFILE:
1418 case F_SPLIT_DUMPFILE:
1422 /* a NOOP is written on QIC tapes to avoid writing two sequential
1423 * filemarks when closing a device in WRITE or APPEND mode. In this
1424 * case, we just seek to the next file. */
1431 tape_rewind(self->fd);
1432 device_set_error(d_self,
1433 stralloc(_("Invalid amanda header while reading file header")),
1434 DEVICE_STATUS_VOLUME_ERROR);
1439 d_self->in_file = TRUE;
1440 d_self->file = file;
1446 tape_device_seek_block (Device * d_self, guint64 block) {
1450 self = TAPE_DEVICE(d_self);
1452 if (device_in_error(self)) return FALSE;
1454 difference = block - d_self->block;
1456 if (difference > 0) {
1457 if (!tape_device_fsr(self, difference)) {
1458 device_set_error(d_self,
1459 vstrallocf(_("Could not seek forward to block %ju: %s"), (uintmax_t)block, strerror(errno)),
1460 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1463 } else if (difference < 0) {
1464 if (!tape_device_bsr(self, difference, d_self->file, d_self->block)) {
1465 device_set_error(d_self,
1466 vstrallocf(_("Could not seek backward to block %ju: %s"), (uintmax_t)block, strerror(errno)),
1467 DEVICE_STATUS_VOLUME_ERROR | DEVICE_STATUS_DEVICE_ERROR);
1472 d_self->block = block;
1477 tape_device_eject (Device * d_self) {
1480 self = TAPE_DEVICE(d_self);
1482 if (device_in_error(self)) return FALSE;
1484 /* Open the device if not already opened */
1485 if (self->fd == -1) {
1486 self->fd = try_open_tape_device(self, self->private->device_filename);
1487 /* if the open failed, then try_open_tape_device already set the
1488 * approppriate error status */
1494 if (!tape_rewind(self->fd)) {
1495 device_set_error(d_self,
1496 vstrallocf(_("Error rewinding device %s before ejecting: %s"),
1497 self->private->device_filename, strerror(errno)),
1498 DEVICE_STATUS_DEVICE_ERROR
1499 | DEVICE_STATUS_VOLUME_ERROR);
1503 if (tape_offl(self->fd))
1506 device_set_error(d_self,
1507 vstrallocf(_("Error ejecting device %s: %s\n"),
1508 self->private->device_filename, strerror(errno)),
1509 DEVICE_STATUS_DEVICE_ERROR);
1515 tape_device_finish (Device * d_self) {
1519 self = TAPE_DEVICE(d_self);
1521 if (device_in_error(self))
1524 /* if we're already in ACCESS_NULL, then there are no filemarks or anything
1525 * to worry about, but we need to release the kernel device */
1526 if (d_self->access_mode == ACCESS_NULL) {
1527 robust_close(self->fd);
1532 /* Polish off this file, if relevant. */
1533 if (d_self->in_file && IS_WRITABLE_ACCESS_MODE(d_self->access_mode)) {
1534 if (!device_finish_file(d_self))
1538 /* Straighten out the filemarks. We already wrote one in finish_file, and
1539 * the device driver will write another filemark when we rewind. This means
1540 * that, if we do nothing, we'll get two filemarks. If final_filemarks is
1541 * 1, this would be wrong, so in this case we insert a F_NOOP header between
1542 * the two filemarks. */
1543 if (self->final_filemarks == 1 &&
1544 IS_WRITABLE_ACCESS_MODE(d_self->access_mode)) {
1549 /* write a F_NOOP header */
1552 header = device_build_amanda_header(d_self, &file, NULL);
1554 device_set_error(d_self,
1555 stralloc(_("Amanda file header won't fit in a single block!")),
1556 DEVICE_STATUS_DEVICE_ERROR);
1560 result = tape_device_robust_write(self, header, d_self->block_size, &msg);
1561 if (result != RESULT_SUCCESS) {
1562 device_set_error(d_self,
1563 vstrallocf(_("Error writing file header: %s"),
1564 (result == RESULT_ERROR)? msg : _("out of space")),
1565 DEVICE_STATUS_DEVICE_ERROR);
1573 /* Rewind (the kernel will write a filemark first) */
1574 if (!tape_rewind(self->fd)) {
1575 device_set_error(d_self,
1576 vstrallocf(_("Couldn't rewind device to finish: %s"), strerror(errno)),
1577 DEVICE_STATUS_DEVICE_ERROR);
1581 d_self->is_eof = FALSE;
1582 d_self->access_mode = ACCESS_NULL;
1584 /* release the kernel's device */
1585 robust_close(self->fd);
1591 d_self->access_mode = ACCESS_NULL;
1593 /* release the kernel's device */
1594 robust_close(self->fd);
1600 /* Works just like read(), except for the following:
1601 * 1) Retries on EINTR & friends.
1602 * 2) Stores count in parameter, not return value.
1603 * 3) Provides explicit return result.
1604 * *errmsg is only set on RESULT_ERROR.
1607 tape_device_robust_read (TapeDevice * self, void * buf, int * count, char **errmsg) {
1611 d_self = (Device*)self;
1613 /* Callers should ensure this. */
1614 g_assert(*count >= 0);
1617 result = read(self->fd, buf, *count);
1619 /* Success. By definition, we read a full block. */
1620 d_self->is_eof = FALSE;
1622 return RESULT_SUCCESS;
1623 } else if (result == 0) {
1624 d_self->is_eof = TRUE;
1625 return RESULT_NO_DATA;
1632 || errno == EWOULDBLOCK
1638 /* Interrupted system call */
1642 || errno == ENOMEM /* bad user-space buffer */
1645 || errno == EOVERFLOW /* bad kernel-space buffer */
1648 || errno == EINVAL /* ??? */
1651 /* Buffer too small. */
1652 g_warning("Buffer is too small (%d bytes) from %s: %s",
1653 *count, self->private->device_filename, strerror(errno));
1654 return RESULT_SMALL_BUFFER;
1656 *errmsg = g_strdup_printf(_("Error reading %d bytes from %s: %s"),
1657 *count, self->private->device_filename, strerror(errno));
1658 return RESULT_ERROR;
1663 g_assert_not_reached();
1666 /* Kernel workaround: If needed, poke the kernel so it doesn't fail.
1667 at the 2GB boundry. Parameters are G_GNUC_UNUSED in case NEED_RESETOFS
1669 static void check_resetofs(TapeDevice * self G_GNUC_UNUSED,
1670 int count G_GNUC_UNUSED) {
1671 #ifdef NEED_RESETOFS
1675 d_self = (Device*)self;
1677 self->private->write_count += count;
1678 if (self->private->write_count < RESETOFS_THRESHOLD) {
1682 result = lseek(self->fd, 0, SEEK_SET);
1684 g_warning(_("lseek() failed during kernel 2GB workaround: %s"),
1690 /* *errmsg is only set on RESULT_ERROR */
1692 tape_device_robust_write (TapeDevice * self, void * buf, int count, char **errmsg) {
1695 gboolean retry = FALSE;
1697 d_self = (Device*)self;
1699 check_resetofs(self, count);
1702 result = write(self->fd, buf, count);
1705 if (result == count)
1706 return RESULT_SUCCESS;
1709 /* write() returned a short count. This should not happen if the block sizes
1710 * are properly aligned. */
1711 *errmsg = g_strdup_printf("Short write on tape device: Tried %d, got %d. Is "
1712 "the drive using a block size smaller than %d bytes?",
1713 count, result, count);
1714 return RESULT_ERROR;
1717 /* Detect LEOM (early warning) and handle properly
1719 * FreeBSD: 0-length write; next write will succeed
1720 * http://lists.freebsd.org/pipermail/freebsd-scsi/2010-June/004414.html
1722 * Solaris: 0-length write; next write will succeed
1723 * (from Matthew Jacob on FreeBSD thread)
1725 * Linux: -1/ENOSPC; next write will succeed
1726 * http://www.mjmwired.net/kernel/Documentation/scsi/st.txt
1728 * HP/UX: -1/ENOSPC; next write will succeed
1729 * http://www.adssasia.com/Manual/IBM%203581%20tape%20autoloader.pdf
1733 || (result < 0 && errno == ENOSPC)
1736 /* if we've retried once already, then we're probably really out of space */
1738 return RESULT_NO_SPACE;
1740 d_self->is_eom = TRUE;
1742 g_debug("empty write to tape; treating as LEOM early warning and retrying");
1746 /* at this point result < 0, so an error occurred - sort out what */
1753 || errno == EWOULDBLOCK
1759 /* Interrupted system call */
1769 /* Probably EOT. Print a message if we got EIO. */
1772 g_warning(_("Got EIO on %s, assuming end of tape"),
1773 self->private->device_filename);
1776 return RESULT_NO_SPACE;
1779 *errmsg = vstrallocf(_("Kernel gave unexpected write() result of \"%s\" on device %s"),
1780 strerror(errno), self->private->device_filename);
1781 return RESULT_ERROR;
1785 g_assert_not_reached();
1788 /* Reads some number of tape blocks into the bit-bucket. If the count
1789 is negative, then we read the rest of the entire file. Returns the
1790 number of blocks read, or -1 if an error occured. If we encounter
1791 EOF (as opposed to some other error) we return the number of blocks
1793 static int drain_tape_blocks(TapeDevice * self, int count) {
1798 buffer_size = tape_device_read_size(self);
1800 buffer = malloc(buffer_size);
1802 for (i = 0; i < count || count < 0;) {
1805 result = read(self->fd, buffer, buffer_size);
1809 } else if (result == 0) {
1813 /* First check for interrupted system call. */
1819 || errno == EWOULDBLOCK
1825 /* Interrupted system call */
1829 || errno == ENOSPC /* bad user-space buffer */
1832 || errno == EOVERFLOW /* bad kernel-space buffer */
1835 || errno == EINVAL /* ??? */
1838 /* The buffer may not be big enough. But the OS is not
1839 100% clear. We double the buffer and try again, but
1840 in no case allow a buffer bigger than 32 MB. */
1843 if (buffer_size > 32*1024*1024) {
1847 buffer = realloc(buffer, buffer_size);
1859 tape_device_fsf (TapeDevice * self, guint count) {
1861 return tape_fsf(self->fd, count);
1864 for (i = 0; i < count; i ++) {
1865 if (drain_tape_blocks(self, -1) < 0)
1874 tape_device_fsr (TapeDevice * self, guint count) {
1876 return tape_fsr(self->fd, count);
1878 int result = drain_tape_blocks(self, count);
1879 return result > 0 && (int)count == result;
1883 /* Seek back the given number of blocks to block number block within
1884 * the current file, numbered file. */
1887 tape_device_bsr (TapeDevice * self, guint count, guint file, guint block) {
1889 return tape_bsr(self->fd, count);
1890 } else if (self->bsf && self->fsf) {
1891 /* BSF, FSF to the right side of the filemark, and then FSR. */
1892 if (!tape_bsf(self->fd, 1))
1895 if (!tape_fsf(self->fd, 1))
1898 return tape_device_fsr(self, block);
1900 /* rewind, FSF, and FSR */
1901 if (!tape_rewind(self->fd))
1904 if (!tape_device_fsf(self, file))
1907 return tape_device_fsr(self, block);
1909 g_assert_not_reached();
1912 /* Go to the right place to write more data, and update the file
1913 number if possible. */
1915 tape_device_eod (TapeDevice * self) {
1919 d_self = (Device*)self;
1923 result = tape_eod(self->fd);
1924 if (result == TAPE_OP_ERROR) {
1926 } else if (result != TAPE_POSITION_UNKNOWN) {
1927 /* great - we just fast-forwarded to EOD, but don't know where we are, so
1928 * now we have to rewind and drain all of that data. Warn the user so that
1929 * we can skip the fast-forward-rewind stage on the next run */
1930 g_warning("Seek to end of tape does not give an accurate tape position; set "
1931 "the EOM property to 0 to avoid useless tape movement.");
1932 /* and set the property so that next time *this* object is opened for
1933 * append, we skip this stage */
1935 /* fall through to draining blocks, below */
1937 /* We drop by 1 because Device will increment the first
1938 time the user does start_file. */
1939 d_self->file = result - 1;
1944 if (!tape_rewind(self->fd))
1949 /* We alternately read a block and FSF. If the read is
1950 successful, then we are not there yet and should FSF
1953 result = drain_tape_blocks(self, 1);
1955 /* More data, FSF. */
1956 tape_device_fsf(self, 1);
1958 } else if (result == 0) {
1960 d_self->file = count - 1;
1969 tape_device_factory (char * device_name, char * device_type, char * device_node) {
1971 g_assert(0 == strcmp(device_type, "tape"));
1972 rval = DEVICE(g_object_new(TYPE_TAPE_DEVICE, NULL));
1973 device_open_device(rval, device_name, device_type, device_node);
1978 * Tape Operations using the POSIX interface
1981 /* Having one name for every operation would be too easy. */
1982 #if !defined(MTCOMPRESSION) && defined(MTCOMP)
1983 # define MTCOMPRESSION MTCOMP
1986 #if !defined(MTSETBLK) && defined(MTSETBSIZ)
1987 # define MTSETBLK MTSETBSIZ
1990 #if !defined(MTEOM) && defined(MTEOD)
1991 # define MTEOM MTEOD
1994 gboolean tape_rewind(int fd) {
1998 /* We will retry this for up to 30 seconds or 5 retries,
1999 whichever is less, because some hardware/software combinations
2000 (notably EXB-8200 on FreeBSD) can fail to rewind. */
2001 stop_time = time(NULL) + 30;
2003 while (--count >= 0 && time(NULL) < stop_time) {
2008 if (0 == ioctl(fd, MTIOCTOP, &mt))
2017 gboolean tape_fsf(int fd, guint count) {
2020 mt.mt_count = count;
2021 return 0 == ioctl(fd, MTIOCTOP, &mt);
2024 gboolean tape_bsf(int fd, guint count) {
2027 mt.mt_count = count;
2028 return 0 == ioctl(fd, MTIOCTOP, &mt);
2031 gboolean tape_fsr(int fd, guint count) {
2034 mt.mt_count = count;
2035 return 0 == ioctl(fd, MTIOCTOP, &mt);
2038 gboolean tape_bsr(int fd, guint count) {
2041 mt.mt_count = count;
2042 return 0 == ioctl(fd, MTIOCTOP, &mt);
2045 gint tape_fileno(int fd) {
2048 if (0 != ioctl(fd, MTIOCGET, &get))
2049 return TAPE_POSITION_UNKNOWN;
2050 if (get.mt_fileno < 0)
2051 return TAPE_POSITION_UNKNOWN;
2053 return get.mt_fileno;
2056 gint tape_eod(int fd) {
2061 if (0 != ioctl(fd, MTIOCTOP, &mt))
2062 return TAPE_OP_ERROR;
2064 /* Ignored result. This is just to flush buffers. */
2066 ioctl(fd, MTIOCTOP, &mt);
2068 if (0 != ioctl(fd, MTIOCGET, &get))
2069 return TAPE_POSITION_UNKNOWN;
2070 if (get.mt_fileno < 0)
2071 return TAPE_POSITION_UNKNOWN;
2073 return get.mt_fileno;
2076 gboolean tape_weof(int fd, guint8 count) {
2079 mt.mt_count = count;
2080 return 0 == ioctl(fd, MTIOCTOP, &mt);
2083 gboolean tape_setcompression(int fd G_GNUC_UNUSED,
2084 gboolean on G_GNUC_UNUSED) {
2085 #ifdef MTCOMPRESSION
2087 mt.mt_op = MTCOMPRESSION;
2089 return 0 == ioctl(fd, MTIOCTOP, &mt);
2095 gboolean tape_offl(int fd) {
2101 if (0 == ioctl(fd, MTIOCTOP, &mt))
2105 g_debug("tape_off: ioctl(MTIOCTOP/MTOFFL) failed: %s", strerror(errno));
2111 DeviceStatusFlags tape_is_tape_device(int fd) {
2115 if (0 == ioctl(fd, MTIOCTOP, &mt)) {
2116 return DEVICE_STATUS_SUCCESS;
2118 } else if (errno == ENOMEDIUM) {
2119 return DEVICE_STATUS_VOLUME_MISSING;
2122 g_debug("tape_is_tape_device: ioctl(MTIOCTOP/MTNOP) failed: %s",
2125 /* some devices return EIO while the drive is busy loading */
2126 return DEVICE_STATUS_DEVICE_ERROR|DEVICE_STATUS_DEVICE_BUSY;
2128 return DEVICE_STATUS_DEVICE_ERROR;
2133 DeviceStatusFlags tape_is_ready(int fd, TapeDevice *t_self G_GNUC_UNUSED) {
2135 if (0 == ioctl(fd, MTIOCGET, &get)) {
2136 #if defined(GMT_ONLINE) || defined(GMT_DR_OPEN)
2139 && (t_self->broken_gmt_online || GMT_ONLINE(get.mt_gstat))
2142 && !GMT_DR_OPEN(get.mt_gstat)
2145 return DEVICE_STATUS_SUCCESS;
2147 return DEVICE_STATUS_VOLUME_MISSING;
2149 #else /* Neither macro is defined. */
2150 return DEVICE_STATUS_SUCCESS;
2153 return DEVICE_STATUS_VOLUME_ERROR;