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