/*
Bacula® - The Network Backup Solution
- Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
+ Copyright (C) 2000-2010 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.
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
- Bacula® is a registered trademark of John Walker.
+ Bacula® is a registered trademark of Kern Sibbald.
The licensor of Bacula is the Free Software Foundation Europe
(FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
Switzerland, email:ftf@fsfeurope.org.
*
* Kern Sibbald, MM
*
- * Version $Id$
+ */
+
+/*
+ * Some details of how volume and device reservations work
+ *
+ * class VOLRES:
+ * set_in_use() volume being used on current drive
+ * clear_in_use() no longer being used. Can be re-used or moved.
+ * set_swapping() set volume being moved to another drive
+ * is_swapping() volume is being moved to another drive
+ * clear_swapping() volume normal
+ *
+ * class DEVICE:
+ * set_load() set to load volume
+ * needs_load() volume must be loaded (i.e. set_load done)
+ * clear_load() load done.
+ * set_unload() set to unload volume
+ * needs_unload() volume must be unloaded
+ * clear_unload() volume unloaded
+ *
+ * reservations are temporary until the drive is acquired
+ * inc_reserved() increments num of reservations
+ * dec_reserved() decrements num of reservations
+ * num_reserved() number of reservations
+ *
+ * class DCR:
+ * set_reserved() sets local reserve flag and calls dev->inc_reserved()
+ * clear_reserved() clears local reserve flag and calls dev->dec_reserved()
+ * is_reserved() returns local reserved flag
+ * unreserve_device() much more complete unreservation
*
*/
B_TAPE_DEV,
B_DVD_DEV,
B_FIFO_DEV,
- B_VTL_DEV
+ B_VTAPE_DEV, /* change to B_TAPE_DEV after init */
+ B_VTL_DEV
};
/* Generic status bits returned from status_dev() */
#define CAP_CLOSEONPOLL (1<<18) /* Close device on polling */
#define CAP_POSITIONBLOCKS (1<<19) /* Use block positioning */
#define CAP_MTIOCGET (1<<20) /* Basic support for fileno and blkno */
-#define CAP_REQMOUNT (1<<21) /* Require mount to read files back (typically: DVD) */
+#define CAP_REQMOUNT (1<<21) /* Require mount/unmount */
#define CAP_CHECKLABELS (1<<22) /* Check for ANSI/IBM labels */
+#define CAP_BLOCKCHECKSUM (1<<23) /* Create/test block checksum */
/* Test state */
#define dev_state(dev, st_state) ((dev)->state & (st_state))
utime_t VolFirstWritten; /* Time of first write */
utime_t VolLastWritten; /* Time of last write */
bool InChanger; /* Set if vol in current magazine */
+ bool is_valid; /* set if this data is valid */
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 */
-
/*
* Device structure definition. There is one of these for
* each physical device. Everything here is "global" to
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 */
+ int m_num_reserved; /* counter of device reservations */
+ int32_t m_slot; /* slot loaded in drive or -1 if none */
pthread_t m_pid; /* Thread that locked -- DEBUG only */
+ bool m_unload; /* set when Volume must be unloaded */
+ bool m_load; /* set when Volume must be loaded */
+
public:
+ DEVICE * volatile swap_dev; /* Swap vol from this device */
dlist *attached_dcrs; /* attached DCR list */
- pthread_mutex_t m_mutex; /* access control */
- pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
+ bthread_mutex_t m_mutex; /* access control */
+ bthread_mutex_t spool_mutex; /* mutex for updating spool_size */
+ bthread_mutex_t acquire_mutex; /* mutex for acquire code */
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_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 */
int capabilities; /* capabilities mask */
int state; /* state mask */
int dev_errno; /* Our own errno */
bool initiated; /* set when init_dev() called */
int label_type; /* Bacula/ANSI/IBM label types */
uint32_t drive_index; /* Autochanger drive index (base 0) */
- int32_t Slot; /* Slot currently in drive (base 1) */
POOLMEM *dev_name; /* Physical device name */
POOLMEM *prt_name; /* Name used for display purposes */
char *errmsg; /* nicely edited error message */
uint32_t block_num; /* current block number base 0 */
+ uint32_t LastBlock; /* last DEV_BLOCK number written to Volume */
uint32_t file; /* current file number base 0 */
uint64_t file_addr; /* Current file read/write address */
uint64_t file_size; /* Current file size */
uint32_t EndFile; /* last file written */
uint32_t min_block_size; /* min block size */
uint32_t max_block_size; /* max block size */
+ uint32_t max_concurrent_jobs; /* maximum simultaneous jobs this drive */
uint64_t max_volume_size; /* max bytes to put on one volume */
uint64_t max_file_size; /* max file size to put in one file on volume */
uint64_t volume_capacity; /* advisory capacity */
char pool_name[MAX_NAME_LENGTH]; /* pool name */
char pool_type[MAX_NAME_LENGTH]; /* pool type */
- /* Device wait times ***FIXME*** look at durations */
- char BadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
+ char UnloadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
bool poll; /* set to poll Volume */
+ /* Device wait times ***FIXME*** look at durations */
int min_wait;
int max_wait;
int max_num_wait;
int has_cap(int cap) const { return capabilities & cap; }
void clear_cap(int cap) { capabilities &= ~cap; }
void set_cap(int cap) { capabilities |= cap; }
+ bool do_checksum() const { return (capabilities & CAP_BLOCKCHECKSUM) != 0; }
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_tape() const { return dev_type == B_TAPE_DEV; }
+ int is_tape() const { return (dev_type == B_TAPE_DEV ||
+ dev_type == B_VTAPE_DEV); }
int is_file() const { return dev_type == B_FILE_DEV; }
int is_fifo() const { return dev_type == B_FIFO_DEV; }
int is_dvd() const { return dev_type == B_DVD_DEV; }
int is_vtl() const { return dev_type == B_VTL_DEV; }
+ int is_vtape() const { return dev_type == B_VTAPE_DEV; }
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 is_unmountable() const { return (is_dvd() || (is_file() && is_removable())); }
+ int num_reserved() const { return m_num_reserved; };
int is_part_spooled() const { return state & ST_PART_SPOOLED; }
int have_media() const { return state & ST_MEDIA; }
int is_short_block() const { return state & ST_SHORT; }
- int is_busy() const { return (state & ST_READ) || num_writers || reserved_device; }
+ int is_busy() const { return (state & ST_READ) || num_writers || num_reserved(); }
int at_eof() const { return state & ST_EOF; }
int at_eot() const { return state & ST_EOT; }
int at_weot() const { return state & ST_WEOT; }
(m_blocked == BST_UNMOUNTED ||
m_blocked == BST_WAITING_FOR_SYSOP ||
m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
+ bool must_unload() const { return m_unload; };
+ bool must_load() const { return m_load; };
const char *strerror() const;
const char *archive_name() const;
const char *name() const;
void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
else state &= ~ST_PART_SPOOLED;
};
+ bool is_volume_to_unload() const { \
+ return m_unload && strcmp(VolHdr.VolumeName, UnloadVolName) == 0; };
+ void set_load() { m_load = true; };
+ void inc_reserved() { m_num_reserved++; }
void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
else state &= ~ST_MOUNTED; };
+ void dec_reserved() { m_num_reserved--; ASSERT(m_num_reserved>=0); };
void clear_append() { state &= ~ST_APPEND; };
void clear_read() { state &= ~ST_READ; };
void clear_labeled() { state &= ~ST_LABEL; };
void clear_media() { state &= ~ST_MEDIA; };
void clear_short_block() { state &= ~ST_SHORT; };
void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
+ void clear_unload() { m_unload = false; UnloadVolName[0] = 0; };
+ void clear_load() { m_load = false; };
char *bstrerror(void) { return errmsg; };
char *print_errmsg() { return errmsg; };
+ int32_t get_slot() const { return m_slot; };
+ void setVolCatInfo(bool valid) { VolCatInfo.is_valid = valid; };
+ bool haveVolCatInfo() const { return VolCatInfo.is_valid; };
+ void setVolCatName(const char *name) {
+ bstrncpy(VolCatInfo.VolCatName, name, sizeof(VolCatInfo.VolCatName));
+ setVolCatInfo(false);
+ };
+ char *getVolCatName() { return VolCatInfo.VolCatName; };
-
+ void set_unload(); /* in dev.c */
void clear_volhdr(); /* in dev.c */
void close(); /* in dev.c */
void close_part(DCR *dcr); /* 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 */
+ void set_slot(int32_t slot); /* in dev.c */
+ void clear_slot(); /* in dev.c */
+
+
bool update_freespace(); /* in dvd.c */
uint32_t get_file() const { return file; };
uint32_t get_block_num() const { return block_num; };
int fd() const { return m_fd; };
+ /* low level operations */
+ void init_backend();
+ int (*d_open)(const char *pathname, int flags, ...);
+ int (*d_close)(int fd);
+ int (*d_ioctl)(int fd, ioctl_req_t request, ...);
+ ssize_t (*d_read)(int fd, void *buffer, size_t count);
+ ssize_t (*d_write)(int fd, const void *buffer, size_t count);
+
/*
* Locking and blocking calls
*/
#ifdef SD_DEBUG_LOCK
- void _r_dlock(const char *, int); /* in lock.c */
+ void _r_dlock(const char *, int, bool locked=false); /* in lock.c */
void _r_dunlock(const char *, int); /* in lock.c */
void _dlock(const char *, int); /* in lock.c */
void _dunlock(const char *, int); /* in lock.c */
#else
- void r_dlock(); /* in lock.c */
+ void r_dlock(bool locked=false); /* in lock.c */
void r_dunlock() { dunlock(); }
void dlock() { P(m_mutex); }
void dunlock() { V(m_mutex); }
#endif
void dblock(int why); /* in lock.c */
void dunblock(bool locked=false); /* in lock.c */
+ bool is_device_unmounted(); /* in lock.c */
void set_blocked(int block) { m_blocked = block; };
int blocked() const { return m_blocked; };
bool is_blocked() const { return m_blocked != BST_NOT_BLOCKED; };
const char *print_blocked() const; /* in dev.c */
private:
- bool do_mount(int mount, int timeout); /* in dev.c */
- void set_mode(int omode); /* 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 */
+ bool do_tape_mount(int mount, int dotimeout); /* in dev.c */
+ bool do_file_mount(int mount, int dotimeout); /* in dev.c */
+ void set_mode(int omode); /* 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 */
};
inline const char *DEVICE::strerror() const { return errmsg; }
* the device. Items in this record are "local" to the Job and
* do not affect other Jobs. Note, a job can have multiple
* DCRs open, each pointing to a different device.
+ * Normally, there is only one JCR thread per DCR. However, the
+ * big and important exception to this is when a Job is being
+ * canceled. At that time, there may be two threads using the
+ * same DCR. Consequently, when creating/attaching/detaching
+ * and freeing the DCR we must lock it (m_mutex).
*/
class DCR {
private:
bool m_dev_locked; /* set if dev already locked */
+ bool m_reserved; /* set if reserved device */
+ bool m_found_in_use; /* set if a volume found in use */
public:
dlink dev_link; /* link to attach to dev */
JCR *jcr; /* pointer to JCR */
+ bthread_mutex_t m_mutex; /* access control */
DEVICE * volatile dev; /* pointer to device */
DEVRES *device; /* pointer to device resource */
DEV_BLOCK *block; /* pointer to block */
bool NewVol; /* set if new Volume mounted */
bool WroteVol; /* set if Volume written */
bool NewFile; /* set when EOF written */
- bool reserved_device; /* set if reserve done */
bool reserved_volume; /* set if we reserved a volume */
bool any_volume; /* Any OK for dir_find_next... */
bool attached_to_dev; /* set when attached to dev */
- bool volume_in_use; /* set in dir_find_next_appendable_volume() */
bool keep_dcr; /* do not free dcr in release_dcr */
uint32_t VolFirstIndex; /* First file index this Volume */
uint32_t VolLastIndex; /* Last file index this Volume */
VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
/* Methods */
+ bool found_in_use() const { return m_found_in_use; };
+ void set_found_in_use() { m_found_in_use = true; };
+ void clear_found_in_use() { m_found_in_use = false; };
+ bool is_reserved() const { return m_reserved; };
bool is_dev_locked() { return m_dev_locked; }
+#ifdef SD_DEBUG_LOCK
+ void _dlock(const char *, int); /* in lock.c */
+ void _dunlock(const char *, int); /* in lock.c */
+#else
void dlock() { dev->dlock(); m_dev_locked = true; }
void dunlock() { m_dev_locked = false; dev->dunlock(); }
+#endif
void dblock(int why) { dev->dblock(why); }
-
+ void setVolCatInfo(bool valid) { VolCatInfo.is_valid = valid; };
+ bool haveVolCatInfo() const { return VolCatInfo.is_valid; };
+ void setVolCatName(const char *name) {
+ bstrncpy(VolCatInfo.VolCatName, name, sizeof(VolCatInfo.VolCatName));
+ setVolCatInfo(false);
+ };
+ char *getVolCatName() { return VolCatInfo.VolCatName; };
+
+
+ /* Methods in reserve.c */
+ void clear_reserved();
+ void set_reserved();
+ void unreserve_device();
+
+ /* Methods in vol_mgr.c */
+ bool can_i_use_volume();
+ bool can_i_write_volume();
+
+ /* Methods in mount.c */
+ bool mount_next_write_volume();
+ bool mount_next_read_volume();
+ void mark_volume_in_error();
+ void mark_volume_not_inchanger();
+ int try_autolabel(bool opened);
+ bool find_a_volume();
+ bool is_suitable_volume_mounted();
+ bool is_eod_valid();
+ int check_volume_label(bool &ask, bool &autochanger);
+ void release_volume();
+ void do_swapping(bool is_writing);
+ bool do_unload();
+ bool do_load(bool is_writing);
+ bool is_tape_position_ok();
};
/*
* Volume reservation class -- see reserve.c
*/
class VOLRES {
+ bool m_swapping; /* set when swapping to another drive */
+ bool m_in_use; /* set when volume reserved or in use */
+ int32_t m_slot; /* slot of swapping volume */
+ uint32_t m_JobId; /* JobId for read volumes */
public:
dlink link;
char *vol_name; /* Volume name */
DEVICE *dev; /* Pointer to device to which we are attached */
- bool released; /* set when the Volume can be released */
+
+ bool is_swapping() const { return m_swapping; };
+ void set_swapping() { m_swapping = true; };
+ void clear_swapping() { m_swapping = false; };
+ bool is_in_use() const { return m_in_use; };
+ void set_in_use() { m_in_use = true; };
+ void clear_in_use() { m_in_use = false; };
+ void set_slot(int32_t slot) { m_slot = slot; };
+ void clear_slot() { m_slot = -1; };
+ int32_t get_slot() const { return m_slot; };
+ uint32_t get_jobid() const { return m_JobId; };
+ void set_jobid(uint32_t JobId) { m_JobId = JobId; };
};
projects / bacula / bacula / blobdiff