+/*
+ Bacula® - The Network Backup Solution
+
+ Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
+
+ The main author of Bacula is Kern Sibbald, with contributions from
+ many others, a complete list can be found in the file AUTHORS.
+ This program is Free Software; you can redistribute it and/or
+ modify it under the terms of version two of the GNU General Public
+ License as published by the Free Software Foundation plus additions
+ that are listed in the file LICENSE.
+
+ 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+
+ Bacula® is a registered trademark of John Walker.
+ The licensor of Bacula is the Free Software Foundation Europe
+ (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+ Switzerland, email:ftf@fsfeurope.org.
+*/
/*
* Definitions for using the Device functions in Bacula
* Tape and File storage access
* Version $Id$
*
*/
-/*
- Copyright (C) 2000-2006 Kern Sibbald
-
- This program is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License
- version 2 as amended with additional clauses defined in the
- file LICENSE in the main source directory.
-
- 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
- the file LICENSE for additional details.
-
- */
#ifndef __DEV_H
#define __DEV_H 1
-#undef DCR /* used by Bacula */
-
-/* #define NEW_LOCK 1 */
+#ifdef SD_DEBUG_LOCK
+#define r_dlock() _r_dlock(__FILE__, __LINE__); /* in device.c */
+#define r_dunlock() _r_dunlock(__FILE__, __LINE__); /* in device.c */
+#define dlock() _dlock(__FILE__, __LINE__); /* in device.c */
+#define dunlock() _dunlock(__FILE__, __LINE__); /* in device.c */
+#endif
-#define new_lock_device(dev) _new_lock_device(__FILE__, __LINE__, (dev))
-#define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
-#define new_unlock_device(dev) _new_unlock_device(__FILE__, __LINE__, (dev))
+#undef DCR /* used by Bacula */
-#define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
-#define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
#define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
#define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
#define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
#define BMT_IM_REP_EN (1<<9) /* immediate report enabled */
-/* Test capabilities */
-#define dev_cap(dev, cap) ((dev)->capabilities & (cap))
-
/* Bits for device capabilities */
#define CAP_EOF (1<<0) /* has MTWEOF */
#define CAP_BSR (1<<1) /* has MTBSR */
#define ST_PART_SPOOLED (1<<18) /* spooling part */
#define ST_FREESPACE_OK (1<<19) /* Have valid freespace for DVD */
-/* dev_blocked states (mutually exclusive) */
+/* m_blocked states (mutually exclusive) */
enum {
BST_NOT_BLOCKED = 0, /* not blocked */
BST_UNMOUNTED, /* User unmounted device */
uint32_t EndFile; /* Last file number */
uint32_t EndBlock; /* Last block number */
int32_t LabelType; /* Bacula/ANSI/IBM */
- int32_t Slot; /* Slot in changer */
- bool InChanger; /* Set if vol in current magazine */
+ int32_t Slot; /* >0=Slot loaded, 0=nothing, -1=unknown */
uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
uint64_t VolCatCapacityBytes; /* capacity estimate */
- uint64_t VolReadTime; /* time spent reading */
- uint64_t VolWriteTime; /* time spent writing this Volume */
+ btime_t VolReadTime; /* time spent reading */
+ btime_t VolWriteTime; /* time spent writing this Volume */
+ int64_t VolMediaId; /* MediaId */
+ utime_t VolFirstWritten; /* Time of first write */
+ bool InChanger; /* Set if vol in current magazine */
char VolCatStatus[20]; /* Volume status */
char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
};
class DEVRES; /* Device resource defined in stored_conf.h */
class DCR; /* forward reference */
+class VOLRES; /* forward reference */
+
+/*
+ * Used in unblock() call
+ */
+enum {
+ dev_locked = true,
+ dev_unlocked = false
+};
+
/*
* Device structure definition. There is one of these for
* each physical device. Everything here is "global" to
* that device and effects all jobs using the device.
*/
class DEVICE {
+private:
+ int m_fd; /* file descriptor */
+ int m_blocked; /* set if we must wait (i.e. change tape) */
+ int m_count; /* Mutex use count -- DEBUG only */
+ pthread_t m_pid; /* Thread that locked -- DEBUG only */
public:
dlist *attached_dcrs; /* attached DCR list */
- pthread_mutex_t mutex; /* access control */
+ pthread_mutex_t m_mutex; /* access control */
pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
pthread_cond_t wait; /* thread wait variable */
pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
pthread_t no_wait_id; /* this thread must not wait */
- int dev_blocked; /* set if we must wait (i.e. change tape) */
int dev_prev_blocked; /* previous blocked state */
int num_waiting; /* number of threads waiting */
int num_writers; /* number of writing threads */
int reserved_device; /* number of device reservations */
/* New access control in process of being implemented */
- brwlock_t lock; /* New mutual exclusion lock */
+// brwlock_t xlock; /* New mutual exclusion lock */
- int fd; /* file descriptor */
int capabilities; /* capabilities mask */
int state; /* state mask */
int dev_errno; /* Our own errno */
uint64_t part_size; /* current part size */
uint32_t part; /* current part number (starts at 0) */
uint64_t part_start; /* current part start address (relative to the whole volume) */
- uint32_t num_parts; /* number of parts WRITTEN on the DVD */
+ uint32_t num_dvd_parts; /* number of parts WRITTEN on the DVD */
/* state ST_FREESPACE_OK is set if free_space is valid */
uint64_t free_space; /* current free space on medium (without the current part) */
int free_space_errno; /* indicates errno getting freespace */
bool truncating; /* if set, we are currently truncating the DVD */
+ bool blank_dvd; /* if set, we have a blank DVD in the drive */
utime_t vol_poll_interval; /* interval between polling Vol mount */
DEVRES *device; /* pointer to Device Resource */
+ VOLRES *vol; /* Pointer to Volume reservation item */
btimer_t *tid; /* timer id */
VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
int rem_wait_sec;
int num_wait;
+ btime_t last_timer; /* used by read/write/seek to get stats (usec) */
+ btime_t last_tick; /* contains last read/write time (usec) */
+
+ btime_t DevReadTime;
+ btime_t DevWriteTime;
+ uint64_t DevWriteBytes;
+ uint64_t DevReadBytes;
+
/* Methods */
+ btime_t get_timer_count(); /* return the last timer interval (ms) */
+
int has_cap(int cap) const { return capabilities & cap; }
+ void clear_cap(int cap) { capabilities &= ~cap; }
+ void set_cap(int cap) { capabilities |= cap; }
int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
int requires_mount() const { return capabilities & CAP_REQMOUNT; }
int is_removable() const { return capabilities & CAP_REM; }
int is_fifo() const { return dev_type == B_FIFO_DEV; }
int is_dvd() const { return dev_type == B_DVD_DEV; }
int is_prog() const { return dev_type == B_PROG_DEV; }
- int is_open() const { return fd >= 0; }
+ int is_open() const { return m_fd >= 0; }
int is_offline() const { return state & ST_OFFLINE; }
int is_labeled() const { return state & ST_LABEL; }
int is_mounted() const { return state & ST_MOUNTED; }
int can_write() const { return is_open() && can_append() &&
is_labeled() && !at_weot(); }
int can_read() const { return state & ST_READ; }
- bool can_steal_lock() const { return dev_blocked &&
- (dev_blocked == BST_UNMOUNTED ||
- dev_blocked == BST_WAITING_FOR_SYSOP ||
- dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
+ bool can_steal_lock() const { return m_blocked &&
+ (m_blocked == BST_UNMOUNTED ||
+ m_blocked == BST_WAITING_FOR_SYSOP ||
+ m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
bool waiting_for_mount() const { return
- (dev_blocked == BST_UNMOUNTED ||
- dev_blocked == BST_WAITING_FOR_SYSOP ||
- dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
+ (m_blocked == BST_UNMOUNTED ||
+ m_blocked == BST_WAITING_FOR_SYSOP ||
+ m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
const char *strerror() const;
const char *archive_name() const;
const char *name() const;
void set_short_block() { state |= ST_SHORT; };
void set_freespace_ok() { state |= ST_FREESPACE_OK; }
void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
- else state &= ~ST_PART_SPOOLED; };
+ else state &= ~ST_PART_SPOOLED;
+ };
void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
else state &= ~ST_MOUNTED; };
void clear_append() { state &= ~ST_APPEND; };
void clear_offline() { state &= ~ST_OFFLINE; };
void clear_eot() { state &= ~ST_EOT; };
void clear_eof() { state &= ~ST_EOF; };
- void clear_opened() { fd = -1; };
+ void clear_opened() { m_fd = -1; };
void clear_mounted() { state &= ~ST_MOUNTED; };
void clear_media() { state &= ~ST_MEDIA; };
void clear_short_block() { state &= ~ST_SHORT; };
void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
char *bstrerror(void) { return errmsg; };
+ char *print_errmsg() { return errmsg; };
+
+#ifdef SD_DEBUG_LOCK
+ void _r_dlock(const char *, int); /* in device.c */
+ void _r_dunlock(const char *, int); /* in device.c */
+ void _dlock(const char *, int); /* in device.c */
+ void _dunlock(const char *, int); /* in device.c */
+#else
+ void r_dlock(); /* in device.c */
+ void r_dunlock(); /* in device.c */
+ void dlock() { P(m_mutex); }
+ void dunlock() { V(m_mutex); }
+#endif
+ void clear_volhdr(); /* in dev.c */
void block(int why); /* in dev.c */
- void unblock(); /* in dev.c */
+ void unblock(bool locked=false); /* in dev.c */
void close(); /* in dev.c */
+ void close_part(DCR *dcr); /* in dev.c */
bool truncate(DCR *dcr); /* in dev.c */
int open(DCR *dcr, int mode); /* in dev.c */
void term(void); /* in dev.c */
+ ssize_t read(void *buf, size_t len); /* in dev.c */
+ ssize_t write(const void *buf, size_t len); /* in dev.c */
bool rewind(DCR *dcr); /* in dev.c */
bool mount(int timeout); /* in dev.c */
bool unmount(int timeout); /* in dev.c */
bool offline_or_rewind(); /* in dev.c */
bool offline(); /* in dev.c */
bool bsf(int count); /* in dev.c */
- bool eod(); /* in dev.c */
+ bool eod(DCR *dcr); /* in dev.c */
bool fsr(int num); /* in dev.c */
bool fsf(int num); /* in dev.c */
bool bsr(int num); /* in dev.c */
bool weof(int num); /* in dev.c */
+ void lock_door(); /* in dev.c */
+ void unlock_door(); /* in dev.c */
+ int32_t get_os_tape_file(); /* in dev.c */
bool scan_dir_for_volume(DCR *dcr); /* in scan.c */
- bool reposition(uint32_t rfile, uint32_t rblock); /* in dev.c */
- void clrerror(int func); /* in dev.c */
-
- void set_blocked(int block) { dev_blocked = block; };
- int get_blocked() const { return dev_blocked; };
+ bool reposition(DCR *dcr, uint32_t rfile, uint32_t rblock); /* in dev.c */
+ void clrerror(int func); /* in dev.c */
+ boffset_t lseek(DCR *dcr, boffset_t offset, int whence); /* in dev.c */
+ bool update_pos(DCR *dcr); /* in dev.c */
+ bool update_freespace(); /* in dvd.c */
+
+ void set_blocked(int block) { m_blocked = block; };
+ int blocked() const { return m_blocked; };
+ uint32_t get_file() const { return file; };
+ uint32_t get_block() const { return block_num; };
const char *print_blocked() const; /* in dev.c */
- bool is_blocked() const { return dev_blocked != BST_NOT_BLOCKED; };
+ bool is_blocked() const { return m_blocked != BST_NOT_BLOCKED; };
+ int fd() const { return m_fd; };
private:
bool do_mount(int mount, int timeout); /* in dev.c */
void open_tape_device(DCR *dcr, int omode); /* in dev.c */
void open_file_device(DCR *dcr, int omode); /* in dev.c */
void open_dvd_device(DCR *dcr, int omode); /* in dev.c */
- void set_blocking(); /* in dev.c */
-
};
-/* Note, these return int not bool! */
inline const char *DEVICE::strerror() const { return errmsg; }
inline const char *DEVICE::archive_name() const { return dev_name; }
inline const char *DEVICE::print_name() const { return prt_name; }
DEVRES *device; /* pointer to device resource */
DEV_BLOCK *block; /* pointer to block */
DEV_RECORD *rec; /* pointer to record */
+ pthread_t tid; /* Thread running this dcr */
int spool_fd; /* fd if spooling */
bool spool_data; /* set to spool data */
bool spooling; /* set when actually spooling */
bool NewFile; /* set when EOF written */
bool reserved_device; /* set if reserve done */
bool any_volume; /* Any OK for dir_find_next... */
+ bool attached_to_dev; /* set when attached to dev */
uint32_t VolFirstIndex; /* First file index this Volume */
uint32_t VolLastIndex; /* Last file index this Volume */
uint32_t FileIndex; /* Current File Index */
dlink link;
char *vol_name;
DEVICE *dev;
- DCR *dcr;
};