2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
11 Copyright (C) 2000-2005 Kern Sibbald
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
34 #undef DCR /* used by Bacula */
36 /* #define NEW_LOCK 1 */
38 #define new_lock_device(dev) _new_lock_device(__FILE__, __LINE__, (dev))
39 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
40 #define new_unlock_device(dev) _new_unlock_device(__FILE__, __LINE__, (dev))
42 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
43 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
44 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
45 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
46 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
47 #define give_back_device_lock(d, p) _give_back_device_lock(__FILE__, __LINE__, (d), (p))
49 /* Arguments to open_dev() */
56 /* Generic status bits returned from status_dev() */
57 #define BMT_TAPE (1<<0) /* is tape device */
58 #define BMT_EOF (1<<1) /* just read EOF */
59 #define BMT_BOT (1<<2) /* at beginning of tape */
60 #define BMT_EOT (1<<3) /* end of tape reached */
61 #define BMT_SM (1<<4) /* DDS setmark */
62 #define BMT_EOD (1<<5) /* DDS at end of data */
63 #define BMT_WR_PROT (1<<6) /* tape write protected */
64 #define BMT_ONLINE (1<<7) /* tape online */
65 #define BMT_DR_OPEN (1<<8) /* tape door open */
66 #define BMT_IM_REP_EN (1<<9) /* immediate report enabled */
69 /* Test capabilities */
70 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
72 /* Bits for device capabilities */
73 #define CAP_EOF (1<<0) /* has MTWEOF */
74 #define CAP_BSR (1<<1) /* has MTBSR */
75 #define CAP_BSF (1<<2) /* has MTBSF */
76 #define CAP_FSR (1<<3) /* has MTFSR */
77 #define CAP_FSF (1<<4) /* has MTFSF */
78 #define CAP_EOM (1<<5) /* has MTEOM */
79 #define CAP_REM (1<<6) /* is removable media */
80 #define CAP_RACCESS (1<<7) /* is random access device */
81 #define CAP_AUTOMOUNT (1<<8) /* Read device at start to see what is there */
82 #define CAP_LABEL (1<<9) /* Label blank tapes */
83 #define CAP_ANONVOLS (1<<10) /* Mount without knowing volume name */
84 #define CAP_ALWAYSOPEN (1<<11) /* always keep device open */
85 #define CAP_AUTOCHANGER (1<<12) /* AutoChanger */
86 #define CAP_OFFLINEUNMOUNT (1<<13) /* Offline before unmount */
87 #define CAP_STREAM (1<<14) /* Stream device */
88 #define CAP_BSFATEOM (1<<15) /* Backspace file at EOM */
89 #define CAP_FASTFSF (1<<16) /* Fast forward space file */
90 #define CAP_TWOEOF (1<<17) /* Write two eofs for EOM */
91 #define CAP_CLOSEONPOLL (1<<18) /* Close device on polling */
92 #define CAP_POSITIONBLOCKS (1<<19) /* Use block positioning */
93 #define CAP_MTIOCGET (1<<20) /* Basic support for fileno and blkno */
94 #define CAP_REQMOUNT (1<<21) /* Require mount to read files back (typically: DVD) */
95 #define CAP_CHECKLABELS (1<<22) /* Check for ANSI/IBM labels */
98 #define dev_state(dev, st_state) ((dev)->state & (st_state))
100 /* Device state bits */
101 #define ST_OPENED (1<<0) /* set when device opened */
102 #define ST_TAPE (1<<1) /* is a tape device */
103 #define ST_FILE (1<<2) /* is a file device */
104 #define ST_FIFO (1<<3) /* is a fifo device */
105 #define ST_DVD (1<<4) /* is a DVD device */
106 #define ST_PROG (1<<5) /* is a program device */
107 #define ST_LABEL (1<<6) /* label found */
108 #define ST_MALLOC (1<<7) /* dev packet malloc'ed in init_dev() */
109 #define ST_APPEND (1<<8) /* ready for Bacula append */
110 #define ST_READ (1<<9) /* ready for Bacula read */
111 #define ST_EOT (1<<10) /* at end of tape */
112 #define ST_WEOT (1<<11) /* Got EOT on write */
113 #define ST_EOF (1<<12) /* Read EOF i.e. zero bytes */
114 #define ST_NEXTVOL (1<<13) /* Start writing on next volume */
115 #define ST_SHORT (1<<14) /* Short block read */
116 #define ST_MOUNTED (1<<15) /* the device is mounted to the mount point */
117 #define ST_OFFLINE (1<<16) /* set offline by operator */
119 /* dev_blocked states (mutually exclusive) */
121 BST_NOT_BLOCKED = 0, /* not blocked */
122 BST_UNMOUNTED, /* User unmounted device */
123 BST_WAITING_FOR_SYSOP, /* Waiting for operator to mount tape */
124 BST_DOING_ACQUIRE, /* Opening/validating/moving tape */
125 BST_WRITING_LABEL, /* Labeling a tape */
126 BST_UNMOUNTED_WAITING_FOR_SYSOP, /* Closed by user during mount request */
127 BST_MOUNT /* Mount request */
130 /* Volume Catalog Information structure definition */
131 struct VOLUME_CAT_INFO {
132 /* Media info for the current Volume */
133 uint32_t VolCatJobs; /* number of jobs on this Volume */
134 uint32_t VolCatFiles; /* Number of files */
135 uint32_t VolCatBlocks; /* Number of blocks */
136 uint64_t VolCatBytes; /* Number of bytes written */
137 uint32_t VolCatParts; /* Number of parts written */
138 uint32_t VolCatMounts; /* Number of mounts this volume */
139 uint32_t VolCatErrors; /* Number of errors this volume */
140 uint32_t VolCatWrites; /* Number of writes this volume */
141 uint32_t VolCatReads; /* Number of reads this volume */
142 uint64_t VolCatRBytes; /* Number of bytes read */
143 uint32_t VolCatRecycles; /* Number of recycles this volume */
144 uint32_t EndFile; /* Last file number */
145 uint32_t EndBlock; /* Last block number */
146 int32_t LabelType; /* Bacula/ANSI/IBM */
147 int32_t Slot; /* Slot in changer */
148 bool InChanger; /* Set if vol in current magazine */
149 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
150 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
151 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
152 uint64_t VolCatCapacityBytes; /* capacity estimate */
153 uint64_t VolReadTime; /* time spent reading */
154 uint64_t VolWriteTime; /* time spent writing this Volume */
155 char VolCatStatus[20]; /* Volume status */
156 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
160 typedef struct s_steal_lock {
161 pthread_t no_wait_id; /* id of no wait thread */
162 int dev_blocked; /* state */
163 int dev_prev_blocked; /* previous blocked state */
166 struct DEVRES; /* Device resource defined in stored_conf.h */
167 int weof_dev(DEVICE *dev, int num);
168 bool rewind_dev(DEVICE *dev);
171 * Device structure definition. There is one of these for
172 * each physical device. Everything here is "global" to
173 * that device and effects all jobs using the device.
177 dlist *attached_dcrs; /* attached DCR list */
178 pthread_mutex_t mutex; /* access control */
179 pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
180 pthread_cond_t wait; /* thread wait variable */
181 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
182 pthread_t no_wait_id; /* this thread must not wait */
183 int dev_blocked; /* set if we must wait (i.e. change tape) */
184 int dev_prev_blocked; /* previous blocked state */
185 int num_waiting; /* number of threads waiting */
186 int num_writers; /* number of writing threads */
187 int reserved_device; /* number of device reservations */
189 /* New access control in process of being implemented */
190 brwlock_t lock; /* New mutual exclusion lock */
192 int use_count; /* usage count on this device 0 or 1 */
193 int fd; /* file descriptor */
194 int capabilities; /* capabilities mask */
195 int state; /* state mask */
196 int dev_errno; /* Our own errno */
197 int mode; /* read/write modes */
198 int openmode; /* parameter passed to open_dev (useful to reopen the device) */
199 bool autoselect; /* Autoselect in autochanger */
200 bool open_nowait; /* If set, don t wait on open */
201 int label_type; /* Bacula/ANSI/IBM label types */
202 uint32_t drive_index; /* Autochanger drive index */
203 POOLMEM *dev_name; /* Physical device name */
204 POOLMEM *prt_name; /* Name used for display purposes */
205 char *errmsg; /* nicely edited error message */
206 uint32_t block_num; /* current block number base 0 */
207 uint32_t file; /* current file number base 0 */
208 uint64_t file_addr; /* Current file read/write address */
209 uint64_t file_size; /* Current file size */
210 uint32_t EndBlock; /* last block written */
211 uint32_t EndFile; /* last file written */
212 uint32_t min_block_size; /* min block size */
213 uint32_t max_block_size; /* max block size */
214 uint64_t max_volume_size; /* max bytes to put on one volume */
215 uint64_t max_file_size; /* max file size to put in one file on volume */
216 uint64_t volume_capacity; /* advisory capacity */
217 uint64_t max_spool_size; /* maximum spool file size */
218 uint64_t spool_size; /* current spool size for this device */
219 uint32_t max_rewind_wait; /* max secs to allow for rewind */
220 uint32_t max_open_wait; /* max secs to allow for open */
221 uint32_t max_open_vols; /* max simultaneous open volumes */
223 uint64_t max_part_size; /* max part size */
224 uint64_t part_size; /* current part size */
225 uint32_t part; /* current part number */
226 uint64_t part_start; /* current part start address (relative to the whole volume) */
227 uint32_t num_parts; /* number of parts (total) */
228 uint64_t free_space; /* current free space on medium (without the current part) */
229 int free_space_errno; /* indicates:
230 * - free_space_errno == 0: ignore free_space.
231 * - free_space_errno < 0: an error occured.
232 * - free_space_errno > 0: free_space is valid. */
234 utime_t vol_poll_interval; /* interval between polling Vol mount */
235 DEVRES *device; /* pointer to Device Resource */
236 btimer_t *tid; /* timer id */
238 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
239 VOLUME_LABEL VolHdr; /* Actual volume label */
240 char pool_name[MAX_NAME_LENGTH]; /* pool name */
241 char pool_type[MAX_NAME_LENGTH]; /* pool type */
247 /* Device wait times ***FIXME*** look at durations */
248 char BadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
249 bool poll; /* set to poll Volume */
258 int is_tape() const { return state & ST_TAPE; }
259 int is_file() const { return state & ST_FILE; }
260 int is_fifo() const { return state & ST_FIFO; }
261 int is_dvd() const { return state & ST_DVD; }
262 int is_open() const { return state & ST_OPENED; }
263 int is_offline() const { return state & ST_OFFLINE; }
264 int is_labeled() const { return state & ST_LABEL; }
265 int is_busy() const; /* either reading or writing */
266 int at_eof() const { return state & ST_EOF; }
267 int at_eot() const { return state & ST_EOT; }
268 int at_weot() const { return state & ST_WEOT; }
269 int can_append() const { return state & ST_APPEND; }
271 * can_write() is meant for checking at the end of a job to see
272 * if we still have a tape (perhaps not if at end of tape
273 * and the job is canceled).
275 int can_write() const { return is_open() && can_append() &&
276 is_labeled() && !at_weot(); }
277 int can_read() const { return state & ST_READ; }
278 bool can_steal_lock() const { return dev_blocked &&
279 (dev_blocked == BST_UNMOUNTED ||
280 dev_blocked == BST_WAITING_FOR_SYSOP ||
281 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
282 bool waiting_for_mount() const { return
283 (dev_blocked == BST_UNMOUNTED ||
284 dev_blocked == BST_WAITING_FOR_SYSOP ||
285 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
286 bool weof() { return !weof_dev(this, 1); };
287 bool fsr(int num); /* in dev.c */
288 bool rewind() { return rewind_dev(this); };
289 const char *strerror() const;
290 const char *archive_name() const;
291 const char *name() const;
292 const char *print_name() const; /* Name for display purposes */
293 void set_eof(); /* in dev.c */
294 void set_eot(); /* in dev.c */
295 void set_append() { state |= ST_APPEND; };
296 void set_labeled() { state |= ST_LABEL; };
297 void set_read() { state |= ST_READ; };
298 void set_offline() { state |= ST_OFFLINE; };
299 void clear_append() { state &= ~ST_APPEND; };
300 void clear_read() { state &= ~ST_READ; };
301 void clear_labeled() { state &= ~ST_LABEL; };
302 void clear_offline() { state &= ~ST_OFFLINE; };
303 void clear_eot() { state &= ~ST_EOT; };
304 void clear_eof() { state &= ~ST_EOF; };
305 void block(int why); /* in dev.c */
306 void unblock(); /* in dev.c */
309 /* Note, these return int not bool! */
310 inline int DEVICE::is_busy() const { return state & ST_READ || num_writers || reserved_device; }
311 inline const char *DEVICE::strerror() const { return errmsg; }
312 inline const char *DEVICE::archive_name() const { return dev_name; }
313 inline const char *DEVICE::print_name() const { return prt_name; }
316 * Device Context (or Control) Record.
317 * There is one of these records for each Job that is using
318 * the device. Items in this record are "local" to the Job and
319 * do not affect other Jobs. Note, a job can have multiple
320 * DCRs open, each pointing to a different device.
324 dlink dev_link; /* link to attach to dev */
325 JCR *jcr; /* pointer to JCR */
326 DEVICE *dev; /* pointer to device */
327 DEVRES *device; /* pointer to device resource */
328 DEV_BLOCK *block; /* pointer to block */
329 DEV_RECORD *rec; /* pointer to record */
330 int spool_fd; /* fd if spooling */
331 bool spool_data; /* set to spool data */
332 bool spooling; /* set when actually spooling */
333 bool dev_locked; /* set if dev already locked */
334 bool NewVol; /* set if new Volume mounted */
335 bool WroteVol; /* set if Volume written */
336 bool NewFile; /* set when EOF written */
337 bool reserved_device; /* set if reserve done */
338 uint32_t VolFirstIndex; /* First file index this Volume */
339 uint32_t VolLastIndex; /* Last file index this Volume */
340 uint32_t FileIndex; /* Current File Index */
341 uint32_t EndFile; /* End file written */
342 uint32_t StartFile; /* Start write file */
343 uint32_t StartBlock; /* Start write block */
344 uint32_t EndBlock; /* Ending block written */
345 int64_t job_spool_size; /* Current job spool size */
346 int64_t max_job_spool_size; /* Max job spool size */
347 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
348 char pool_name[MAX_NAME_LENGTH]; /* pool name */
349 char pool_type[MAX_NAME_LENGTH]; /* pool type */
350 char media_type[MAX_NAME_LENGTH]; /* media type */
351 char dev_name[MAX_NAME_LENGTH]; /* dev name */
352 int Copy; /* identical copy number */
353 int Stripe; /* RAIT stripe */
354 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
358 /* Get some definition of function to position
359 * to the end of the medium in MTEOM. System
360 * dependent. Arrgggg!