2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
11 Bacula® - The Network Backup Solution
13 Copyright (C) 2000-2006 Free Software Foundation Europe e.V.
15 The main author of Bacula is Kern Sibbald, with contributions from
16 many others, a complete list can be found in the file AUTHORS.
17 This program is Free Software; you can redistribute it and/or
18 modify it under the terms of version two of the GNU General Public
19 License as published by the Free Software Foundation plus additions
20 that are listed in the file LICENSE.
22 This program is distributed in the hope that it will be useful, but
23 WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 General Public License for more details.
27 You should have received a copy of the GNU General Public License
28 along with this program; if not, write to the Free Software
29 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
32 Bacula® is a registered trademark of John Walker.
33 The licensor of Bacula is the Free Software Foundation Europe
34 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
35 Switzerland, email:ftf@fsfeurope.org.
42 #undef DCR /* used by Bacula */
44 /* #define NEW_LOCK 1 */
46 #define new_lock_device(dev) _new_lock_device(__FILE__, __LINE__, (dev))
47 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
48 #define new_unlock_device(dev) _new_unlock_device(__FILE__, __LINE__, (dev))
50 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
51 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
52 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
53 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
54 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
55 #define give_back_device_lock(d, p) _give_back_device_lock(__FILE__, __LINE__, (d), (p))
57 /* Return values from wait_for_sysop() */
66 /* Arguments to open_dev() */
68 CREATE_READ_WRITE = 1,
83 /* Generic status bits returned from status_dev() */
84 #define BMT_TAPE (1<<0) /* is tape device */
85 #define BMT_EOF (1<<1) /* just read EOF */
86 #define BMT_BOT (1<<2) /* at beginning of tape */
87 #define BMT_EOT (1<<3) /* end of tape reached */
88 #define BMT_SM (1<<4) /* DDS setmark */
89 #define BMT_EOD (1<<5) /* DDS at end of data */
90 #define BMT_WR_PROT (1<<6) /* tape write protected */
91 #define BMT_ONLINE (1<<7) /* tape online */
92 #define BMT_DR_OPEN (1<<8) /* tape door open */
93 #define BMT_IM_REP_EN (1<<9) /* immediate report enabled */
96 /* Test capabilities */
97 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
99 /* Bits for device capabilities */
100 #define CAP_EOF (1<<0) /* has MTWEOF */
101 #define CAP_BSR (1<<1) /* has MTBSR */
102 #define CAP_BSF (1<<2) /* has MTBSF */
103 #define CAP_FSR (1<<3) /* has MTFSR */
104 #define CAP_FSF (1<<4) /* has MTFSF */
105 #define CAP_EOM (1<<5) /* has MTEOM */
106 #define CAP_REM (1<<6) /* is removable media */
107 #define CAP_RACCESS (1<<7) /* is random access device */
108 #define CAP_AUTOMOUNT (1<<8) /* Read device at start to see what is there */
109 #define CAP_LABEL (1<<9) /* Label blank tapes */
110 #define CAP_ANONVOLS (1<<10) /* Mount without knowing volume name */
111 #define CAP_ALWAYSOPEN (1<<11) /* always keep device open */
112 #define CAP_AUTOCHANGER (1<<12) /* AutoChanger */
113 #define CAP_OFFLINEUNMOUNT (1<<13) /* Offline before unmount */
114 #define CAP_STREAM (1<<14) /* Stream device */
115 #define CAP_BSFATEOM (1<<15) /* Backspace file at EOM */
116 #define CAP_FASTFSF (1<<16) /* Fast forward space file */
117 #define CAP_TWOEOF (1<<17) /* Write two eofs for EOM */
118 #define CAP_CLOSEONPOLL (1<<18) /* Close device on polling */
119 #define CAP_POSITIONBLOCKS (1<<19) /* Use block positioning */
120 #define CAP_MTIOCGET (1<<20) /* Basic support for fileno and blkno */
121 #define CAP_REQMOUNT (1<<21) /* Require mount to read files back (typically: DVD) */
122 #define CAP_CHECKLABELS (1<<22) /* Check for ANSI/IBM labels */
125 #define dev_state(dev, st_state) ((dev)->state & (st_state))
127 /* Device state bits */
128 #define ST_XXXXXX (1<<0) /* was ST_OPENED */
129 #define ST_XXXXX (1<<1) /* was ST_TAPE */
130 #define ST_XXXX (1<<2) /* was ST_FILE */
131 #define ST_XXX (1<<3) /* was ST_FIFO */
132 #define ST_XX (1<<4) /* was ST_DVD */
133 #define ST_X (1<<5) /* was ST_PROG */
135 #define ST_LABEL (1<<6) /* label found */
136 #define ST_MALLOC (1<<7) /* dev packet malloc'ed in init_dev() */
137 #define ST_APPEND (1<<8) /* ready for Bacula append */
138 #define ST_READ (1<<9) /* ready for Bacula read */
139 #define ST_EOT (1<<10) /* at end of tape */
140 #define ST_WEOT (1<<11) /* Got EOT on write */
141 #define ST_EOF (1<<12) /* Read EOF i.e. zero bytes */
142 #define ST_NEXTVOL (1<<13) /* Start writing on next volume */
143 #define ST_SHORT (1<<14) /* Short block read */
144 #define ST_MOUNTED (1<<15) /* the device is mounted to the mount point */
145 #define ST_MEDIA (1<<16) /* Media found in mounted device */
146 #define ST_OFFLINE (1<<17) /* set offline by operator */
147 #define ST_PART_SPOOLED (1<<18) /* spooling part */
148 #define ST_FREESPACE_OK (1<<19) /* Have valid freespace for DVD */
150 /* dev_blocked states (mutually exclusive) */
152 BST_NOT_BLOCKED = 0, /* not blocked */
153 BST_UNMOUNTED, /* User unmounted device */
154 BST_WAITING_FOR_SYSOP, /* Waiting for operator to mount tape */
155 BST_DOING_ACQUIRE, /* Opening/validating/moving tape */
156 BST_WRITING_LABEL, /* Labeling a tape */
157 BST_UNMOUNTED_WAITING_FOR_SYSOP, /* User unmounted during wait for op */
158 BST_MOUNT /* Mount request */
161 /* Volume Catalog Information structure definition */
162 struct VOLUME_CAT_INFO {
163 /* Media info for the current Volume */
164 uint32_t VolCatJobs; /* number of jobs on this Volume */
165 uint32_t VolCatFiles; /* Number of files */
166 uint32_t VolCatBlocks; /* Number of blocks */
167 uint64_t VolCatBytes; /* Number of bytes written */
168 uint32_t VolCatParts; /* Number of parts written */
169 uint32_t VolCatMounts; /* Number of mounts this volume */
170 uint32_t VolCatErrors; /* Number of errors this volume */
171 uint32_t VolCatWrites; /* Number of writes this volume */
172 uint32_t VolCatReads; /* Number of reads this volume */
173 uint64_t VolCatRBytes; /* Number of bytes read */
174 uint32_t VolCatRecycles; /* Number of recycles this volume */
175 uint32_t EndFile; /* Last file number */
176 uint32_t EndBlock; /* Last block number */
177 int32_t LabelType; /* Bacula/ANSI/IBM */
178 int32_t Slot; /* >0=Slot loaded, 0=nothing, -1=unknown */
179 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
180 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
181 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
182 uint64_t VolCatCapacityBytes; /* capacity estimate */
183 uint64_t VolReadTime; /* time spent reading */
184 uint64_t VolWriteTime; /* time spent writing this Volume */
185 int64_t VolMediaId; /* MediaId */
186 utime_t VolFirstWritten; /* Time of first write */
187 bool InChanger; /* Set if vol in current magazine */
188 char VolCatStatus[20]; /* Volume status */
189 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
193 typedef struct s_steal_lock {
194 pthread_t no_wait_id; /* id of no wait thread */
195 int dev_blocked; /* state */
196 int dev_prev_blocked; /* previous blocked state */
199 class DEVRES; /* Device resource defined in stored_conf.h */
201 class DCR; /* forward reference */
203 * Device structure definition. There is one of these for
204 * each physical device. Everything here is "global" to
205 * that device and effects all jobs using the device.
209 dlist *attached_dcrs; /* attached DCR list */
210 pthread_mutex_t mutex; /* access control */
211 pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
212 pthread_cond_t wait; /* thread wait variable */
213 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
214 pthread_t no_wait_id; /* this thread must not wait */
215 int dev_blocked; /* set if we must wait (i.e. change tape) */
216 int dev_prev_blocked; /* previous blocked state */
217 int num_waiting; /* number of threads waiting */
218 int num_writers; /* number of writing threads */
219 int reserved_device; /* number of device reservations */
221 /* New access control in process of being implemented */
222 brwlock_t lock; /* New mutual exclusion lock */
224 int fd; /* file descriptor */
225 int capabilities; /* capabilities mask */
226 int state; /* state mask */
227 int dev_errno; /* Our own errno */
228 int mode; /* read/write modes */
229 int openmode; /* parameter passed to open_dev (useful to reopen the device) */
230 int dev_type; /* device type */
231 bool autoselect; /* Autoselect in autochanger */
232 int label_type; /* Bacula/ANSI/IBM label types */
233 uint32_t drive_index; /* Autochanger drive index (base 0) */
234 int32_t Slot; /* Slot currently in drive (base 1) */
235 POOLMEM *dev_name; /* Physical device name */
236 POOLMEM *prt_name; /* Name used for display purposes */
237 char *errmsg; /* nicely edited error message */
238 uint32_t block_num; /* current block number base 0 */
239 uint32_t file; /* current file number base 0 */
240 uint64_t file_addr; /* Current file read/write address */
241 uint64_t file_size; /* Current file size */
242 uint32_t EndBlock; /* last block written */
243 uint32_t EndFile; /* last file written */
244 uint32_t min_block_size; /* min block size */
245 uint32_t max_block_size; /* max block size */
246 uint64_t max_volume_size; /* max bytes to put on one volume */
247 uint64_t max_file_size; /* max file size to put in one file on volume */
248 uint64_t volume_capacity; /* advisory capacity */
249 uint64_t max_spool_size; /* maximum spool file size */
250 uint64_t spool_size; /* current spool size for this device */
251 uint32_t max_rewind_wait; /* max secs to allow for rewind */
252 uint32_t max_open_wait; /* max secs to allow for open */
253 uint32_t max_open_vols; /* max simultaneous open volumes */
255 uint64_t max_part_size; /* max part size */
256 uint64_t part_size; /* current part size */
257 uint32_t part; /* current part number (starts at 0) */
258 uint64_t part_start; /* current part start address (relative to the whole volume) */
259 uint32_t num_dvd_parts; /* number of parts WRITTEN on the DVD */
260 /* state ST_FREESPACE_OK is set if free_space is valid */
261 uint64_t free_space; /* current free space on medium (without the current part) */
262 int free_space_errno; /* indicates errno getting freespace */
263 bool truncating; /* if set, we are currently truncating the DVD */
264 bool blank_dvd; /* if set, we have a blank DVD in the drive */
267 utime_t vol_poll_interval; /* interval between polling Vol mount */
268 DEVRES *device; /* pointer to Device Resource */
269 btimer_t *tid; /* timer id */
271 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
272 VOLUME_LABEL VolHdr; /* Actual volume label */
273 char pool_name[MAX_NAME_LENGTH]; /* pool name */
274 char pool_type[MAX_NAME_LENGTH]; /* pool type */
276 /* Device wait times ***FIXME*** look at durations */
277 char BadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
278 bool poll; /* set to poll Volume */
287 int has_cap(int cap) const { return capabilities & cap; }
288 int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
289 int requires_mount() const { return capabilities & CAP_REQMOUNT; }
290 int is_removable() const { return capabilities & CAP_REM; }
291 int is_tape() const { return dev_type == B_TAPE_DEV; }
292 int is_file() const { return dev_type == B_FILE_DEV; }
293 int is_fifo() const { return dev_type == B_FIFO_DEV; }
294 int is_dvd() const { return dev_type == B_DVD_DEV; }
295 int is_prog() const { return dev_type == B_PROG_DEV; }
296 int is_open() const { return fd >= 0; }
297 int is_offline() const { return state & ST_OFFLINE; }
298 int is_labeled() const { return state & ST_LABEL; }
299 int is_mounted() const { return state & ST_MOUNTED; }
300 int is_part_spooled() const { return state & ST_PART_SPOOLED; }
301 int have_media() const { return state & ST_MEDIA; }
302 int is_short_block() const { return state & ST_SHORT; }
303 int is_busy() const { return (state & ST_READ) || num_writers || reserved_device; }
304 int at_eof() const { return state & ST_EOF; }
305 int at_eot() const { return state & ST_EOT; }
306 int at_weot() const { return state & ST_WEOT; }
307 int can_append() const { return state & ST_APPEND; }
308 int is_freespace_ok() const { return state & ST_FREESPACE_OK; }
310 * can_write() is meant for checking at the end of a job to see
311 * if we still have a tape (perhaps not if at end of tape
312 * and the job is canceled).
314 int can_write() const { return is_open() && can_append() &&
315 is_labeled() && !at_weot(); }
316 int can_read() const { return state & ST_READ; }
317 bool can_steal_lock() const { return dev_blocked &&
318 (dev_blocked == BST_UNMOUNTED ||
319 dev_blocked == BST_WAITING_FOR_SYSOP ||
320 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
321 bool waiting_for_mount() const { return
322 (dev_blocked == BST_UNMOUNTED ||
323 dev_blocked == BST_WAITING_FOR_SYSOP ||
324 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
325 const char *strerror() const;
326 const char *archive_name() const;
327 const char *name() const;
328 const char *print_name() const; /* Name for display purposes */
329 void set_ateof(); /* in dev.c */
330 void set_ateot(); /* in dev.c */
331 void set_eot() { state |= ST_EOT; };
332 void set_eof() { state |= ST_EOF; };
333 void set_append() { state |= ST_APPEND; };
334 void set_labeled() { state |= ST_LABEL; };
335 inline void set_read() { state |= ST_READ; };
336 void set_offline() { state |= ST_OFFLINE; };
337 void set_mounted() { state |= ST_MOUNTED; };
338 void set_media() { state |= ST_MEDIA; };
339 void set_short_block() { state |= ST_SHORT; };
340 void set_freespace_ok() { state |= ST_FREESPACE_OK; }
341 void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
342 else state &= ~ST_PART_SPOOLED;
344 void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
345 else state &= ~ST_MOUNTED; };
346 void clear_append() { state &= ~ST_APPEND; };
347 void clear_read() { state &= ~ST_READ; };
348 void clear_labeled() { state &= ~ST_LABEL; };
349 void clear_offline() { state &= ~ST_OFFLINE; };
350 void clear_eot() { state &= ~ST_EOT; };
351 void clear_eof() { state &= ~ST_EOF; };
352 void clear_opened() { fd = -1; };
353 void clear_mounted() { state &= ~ST_MOUNTED; };
354 void clear_media() { state &= ~ST_MEDIA; };
355 void clear_short_block() { state &= ~ST_SHORT; };
356 void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
357 char *bstrerror(void) { return errmsg; };
358 char *print_errmsg() { return errmsg; };
360 void block(int why); /* in dev.c */
361 void unblock(); /* in dev.c */
362 void close(); /* in dev.c */
363 void close_part(DCR *dcr); /* in dev.c */
364 bool truncate(DCR *dcr); /* in dev.c */
365 int open(DCR *dcr, int mode); /* in dev.c */
366 void term(void); /* in dev.c */
367 bool rewind(DCR *dcr); /* in dev.c */
368 bool mount(int timeout); /* in dev.c */
369 bool unmount(int timeout); /* in dev.c */
370 void edit_mount_codes(POOL_MEM &omsg, const char *imsg); /* in dev.c */
371 bool offline_or_rewind(); /* in dev.c */
372 bool offline(); /* in dev.c */
373 bool bsf(int count); /* in dev.c */
374 bool eod(DCR *dcr); /* in dev.c */
375 bool fsr(int num); /* in dev.c */
376 bool fsf(int num); /* in dev.c */
377 bool bsr(int num); /* in dev.c */
378 bool weof(int num); /* in dev.c */
379 void lock_door(); /* in dev.c */
380 void unlock_door(); /* in dev.c */
381 bool scan_dir_for_volume(DCR *dcr); /* in scan.c */
382 bool reposition(DCR *dcr, uint32_t rfile, uint32_t rblock); /* in dev.c */
383 void clrerror(int func); /* in dev.c */
384 boffset_t lseek(DCR *dcr, boffset_t offset, int whence); /* in dev.c */
385 bool update_pos(DCR *dcr); /* in dev.c */
386 bool update_freespace(); /* in dvd.c */
388 void set_blocked(int block) { dev_blocked = block; };
389 int get_blocked() const { return dev_blocked; };
390 uint32_t get_file() const { return file; };
391 uint32_t get_block() const { return block_num; };
392 const char *print_blocked() const; /* in dev.c */
393 bool is_blocked() const { return dev_blocked != BST_NOT_BLOCKED; };
396 bool do_mount(int mount, int timeout); /* in dev.c */
397 void set_mode(int omode); /* in dev.c */
398 void open_tape_device(DCR *dcr, int omode); /* in dev.c */
399 void open_file_device(DCR *dcr, int omode); /* in dev.c */
400 void open_dvd_device(DCR *dcr, int omode); /* in dev.c */
403 /* Note, these return int not bool! */
404 inline const char *DEVICE::strerror() const { return errmsg; }
405 inline const char *DEVICE::archive_name() const { return dev_name; }
406 inline const char *DEVICE::print_name() const { return prt_name; }
409 * Device Context (or Control) Record.
410 * There is one of these records for each Job that is using
411 * the device. Items in this record are "local" to the Job and
412 * do not affect other Jobs. Note, a job can have multiple
413 * DCRs open, each pointing to a different device.
417 dlink dev_link; /* link to attach to dev */
418 JCR *jcr; /* pointer to JCR */
419 DEVICE *dev; /* pointer to device */
420 DEVRES *device; /* pointer to device resource */
421 DEV_BLOCK *block; /* pointer to block */
422 DEV_RECORD *rec; /* pointer to record */
423 int spool_fd; /* fd if spooling */
424 bool spool_data; /* set to spool data */
425 bool spooling; /* set when actually spooling */
426 bool despooling; /* set when despooling */
427 bool despool_wait; /* waiting for despooling */
428 bool dev_locked; /* set if dev already locked */
429 bool NewVol; /* set if new Volume mounted */
430 bool WroteVol; /* set if Volume written */
431 bool NewFile; /* set when EOF written */
432 bool reserved_device; /* set if reserve done */
433 bool any_volume; /* Any OK for dir_find_next... */
434 bool attached_to_dev; /* set when attached to dev */
435 uint32_t VolFirstIndex; /* First file index this Volume */
436 uint32_t VolLastIndex; /* Last file index this Volume */
437 uint32_t FileIndex; /* Current File Index */
438 uint32_t EndFile; /* End file written */
439 uint32_t StartFile; /* Start write file */
440 uint32_t StartBlock; /* Start write block */
441 uint32_t EndBlock; /* Ending block written */
442 int64_t job_spool_size; /* Current job spool size */
443 int64_t max_job_spool_size; /* Max job spool size */
444 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
445 char pool_name[MAX_NAME_LENGTH]; /* pool name */
446 char pool_type[MAX_NAME_LENGTH]; /* pool type */
447 char media_type[MAX_NAME_LENGTH]; /* media type */
448 char dev_name[MAX_NAME_LENGTH]; /* dev name */
449 int Copy; /* identical copy number */
450 int Stripe; /* RAIT stripe */
451 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
455 * Volume reservation class -- see reserve.c
466 /* Get some definition of function to position
467 * to the end of the medium in MTEOM. System
468 * dependent. Arrgggg!