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