2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
9 Copyright (C) 2000-2003 Kern Sibbald and John Walker
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of
14 the License, or (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public
22 License along with this program; if not, write to the Free
23 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* #define NEW_LOCK 1 */
34 #define new_lock_device(dev) _new_lock_device(__FILE__, __LINE__, (dev))
35 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
36 #define new_unlock_device(dev) _new_unlock_device(__FILE__, __LINE__, (dev))
38 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
39 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
40 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
41 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
42 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
43 #define return_device_lock(d, p) _return_device_lock(__FILE__, __LINE__, (d), (p))
45 /* Arguments to open_dev() */
48 #define OPEN_READ_WRITE 0
49 #define OPEN_READ_ONLY 1
50 #define OPEN_WRITE_ONLY 2
52 /* Generic status bits returned from status_dev() */
53 #define MT_TAPE (1<<0) /* is tape device */
54 #define MT_EOF (1<<1) /* just read EOF */
55 #define MT_BOT (1<<2) /* at beginning of tape */
56 #define MT_EOT (1<<3) /* end of tape reached */
57 #define MT_SM (1<<4) /* DDS setmark */
58 #define MT_EOD (1<<5) /* DDS at end of data */
59 #define MT_WR_PROT (1<<6) /* tape write protected */
60 #define MT_ONLINE (1<<7) /* tape online */
61 #define MT_DR_OPEN (1<<8) /* tape door open */
62 #define MT_IM_REP_EN (1<<9) /* immediate report enabled */
65 /* Test capabilities */
66 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
68 /* Bits for device capabilities */
69 #define CAP_EOF 0x0001 /* has MTWEOF */
70 #define CAP_BSR 0x0002 /* has MTBSR */
71 #define CAP_BSF 0x0004 /* has MTBSF */
72 #define CAP_FSR 0x0008 /* has MTFSR */
73 #define CAP_FSF 0x0010 /* has MTFSF */
74 #define CAP_EOM 0x0020 /* has MTEOM */
75 #define CAP_REM 0x0040 /* is removable media */
76 #define CAP_RACCESS 0x0080 /* is random access device */
77 #define CAP_AUTOMOUNT 0x0100 /* Read device at start to see what is there */
78 #define CAP_LABEL 0x0200 /* Label blank tapes */
79 #define CAP_ANONVOLS 0x0400 /* Mount without knowing volume name */
80 #define CAP_ALWAYSOPEN 0x0800 /* always keep device open */
81 #define CAP_AUTOCHANGER 0x1000 /* AutoChanger */
82 #define CAP_OFFLINEUNMOUNT 0x2000 /* Offline before unmount */
83 #define CAP_STREAM 0x4000 /* Stream device */
84 #define CAP_BSFATEOM 0x8000 /* Backspace file at EOM */
87 #define dev_state(dev, state) ((dev)->state & (state))
89 /* Device state bits */
90 #define ST_OPENED 0x0001 /* set when device opened */
91 #define ST_TAPE 0x0002 /* is a tape device */
92 #define ST_FILE 0x0004 /* is a file device */
93 #define ST_FIFO 0x0008 /* is a fifo device */
94 #define ST_PROG 0x0010 /* is a program device */
95 #define ST_LABEL 0x0020 /* label found */
96 #define ST_MALLOC 0x0040 /* dev packet malloc'ed in init_dev() */
97 #define ST_APPEND 0x0080 /* ready for Bacula append */
98 #define ST_READ 0x0100 /* ready for Bacula read */
99 #define ST_EOT 0x0200 /* at end of tape */
100 #define ST_WEOT 0x0400 /* Got EOT on write */
101 #define ST_EOF 0x0800 /* Read EOF i.e. zero bytes */
102 #define ST_NEXTVOL 0x1000 /* Start writing on next volume */
103 #define ST_SHORT 0x2000 /* Short block read */
105 /* dev_blocked states (mutually exclusive) */
106 #define BST_NOT_BLOCKED 0 /* not blocked */
107 #define BST_UNMOUNTED 1 /* User unmounted device */
108 #define BST_WAITING_FOR_SYSOP 2 /* Waiting for operator to mount tape */
109 #define BST_DOING_ACQUIRE 3 /* Opening/validating/moving tape */
110 #define BST_WRITING_LABEL 4 /* Labeling a tape */
111 #define BST_UNMOUNTED_WAITING_FOR_SYSOP 5 /* Closed by user during mount request */
113 /* Volume Catalog Information structure definition */
114 typedef struct s_volume_catalog_info {
115 /* Media info for the current Volume */
116 uint32_t VolCatJobs; /* number of jobs on this Volume */
117 uint32_t VolCatFiles; /* Number of files */
118 uint32_t VolCatBlocks; /* Number of blocks */
119 uint64_t VolCatBytes; /* Number of bytes written */
120 uint32_t VolCatMounts; /* Number of mounts this volume */
121 uint32_t VolCatErrors; /* Number of errors this volume */
122 uint32_t VolCatWrites; /* Number of writes this volume */
123 uint32_t VolCatReads; /* Number of reads this volume */
124 uint32_t VolCatRecycles; /* Number of recycles this volume */
125 int32_t Slot; /* Slot in changer */
126 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
127 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
128 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
129 uint64_t VolCatCapacityBytes; /* capacity estimate */
130 char VolCatStatus[20]; /* Volume status */
131 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
135 typedef struct s_steal_lock {
136 pthread_t no_wait_id; /* id of no wait thread */
137 int dev_blocked; /* state */
141 /* Device structure definition */
142 typedef struct s_device {
143 struct s_device *next; /* pointer to next open device */
144 struct s_device *prev; /* pointer to prev open device */
145 void *attached_jcrs; /* attached JCR list */
146 pthread_mutex_t mutex; /* access control */
147 pthread_cond_t wait; /* thread wait variable */
148 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
149 pthread_t no_wait_id; /* this thread must not wait */
150 int dev_blocked; /* set if we must wait (i.e. change tape) */
151 int num_waiting; /* number of threads waiting */
152 int num_writers; /* number of writing threads */
153 int use_count; /* usage count on this device */
154 int fd; /* file descriptor */
155 int capabilities; /* capabilities mask */
156 int state; /* state mask */
157 int dev_errno; /* Our own errno */
158 int mode; /* read/write modes */
159 char *dev_name; /* device name */
160 char *errmsg; /* nicely edited error message */
161 uint32_t block_num; /* current block number base 0 */
162 uint32_t file; /* current file number base 0 */
163 uint64_t file_addr; /* Current file read/write address */
164 uint32_t EndBlock; /* last block written */
165 uint32_t EndFile; /* last file written */
166 uint32_t min_block_size; /* min block size */
167 uint32_t max_block_size; /* max block size */
168 uint64_t max_volume_size; /* max bytes to put on one volume */
169 uint64_t max_file_size; /* max file size to put in one file on volume */
170 uint64_t volume_capacity; /* advisory capacity */
171 uint32_t max_rewind_wait; /* max secs to allow for rewind */
172 uint32_t max_open_wait; /* max secs to allow for open */
173 uint32_t max_open_vols; /* max simultaneous open volumes */
174 void *device; /* pointer to Device Resource */
175 btimer_id tid; /* timer id */
177 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
178 VOLUME_LABEL VolHdr; /* Actual volume label */
186 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0cbn"
189 #define DEFAULT_TAPE_DRIVE "/dev/rmt0.1"
192 #define DEFAULT_TAPE_DRIVE "/dev/tps0d4nr"
195 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
198 #define DEFAULT_TAPE_DRIVE "/dev/nrmt0"
201 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0hnb"
204 #define DEFAULT_TAPE_DRIVE "/dev/nrst0"
207 /* Default default */
208 #ifndef DEFAULT_TAPE_DRIVE
209 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
212 /* Get some definition of function to position
213 * to the end of the medium in MTEOM. System
214 * dependent. Arrgggg!