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_MEDIA (1<<16) /* Media found in mounted device */
113 #define ST_OFFLINE (1<<17) /* set offline by operator */
115 /* dev_blocked states (mutually exclusive) */
117 BST_NOT_BLOCKED = 0, /* not blocked */
118 BST_UNMOUNTED, /* User unmounted device */
119 BST_WAITING_FOR_SYSOP, /* Waiting for operator to mount tape */
120 BST_DOING_ACQUIRE, /* Opening/validating/moving tape */
121 BST_WRITING_LABEL, /* Labeling a tape */
122 BST_UNMOUNTED_WAITING_FOR_SYSOP, /* Closed by user during mount request */
123 BST_MOUNT /* Mount request */
126 /* Volume Catalog Information structure definition */
127 struct VOLUME_CAT_INFO {
128 /* Media info for the current Volume */
129 uint32_t VolCatJobs; /* number of jobs on this Volume */
130 uint32_t VolCatFiles; /* Number of files */
131 uint32_t VolCatBlocks; /* Number of blocks */
132 uint64_t VolCatBytes; /* Number of bytes written */
133 uint32_t VolCatParts; /* Number of parts written */
134 uint32_t VolCatMounts; /* Number of mounts this volume */
135 uint32_t VolCatErrors; /* Number of errors this volume */
136 uint32_t VolCatWrites; /* Number of writes this volume */
137 uint32_t VolCatReads; /* Number of reads this volume */
138 uint64_t VolCatRBytes; /* Number of bytes read */
139 uint32_t VolCatRecycles; /* Number of recycles this volume */
140 uint32_t EndFile; /* Last file number */
141 uint32_t EndBlock; /* Last block number */
142 int32_t LabelType; /* Bacula/ANSI/IBM */
143 int32_t Slot; /* Slot in changer */
144 bool InChanger; /* Set if vol in current magazine */
145 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
146 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
147 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
148 uint64_t VolCatCapacityBytes; /* capacity estimate */
149 uint64_t VolReadTime; /* time spent reading */
150 uint64_t VolWriteTime; /* time spent writing this Volume */
151 char VolCatStatus[20]; /* Volume status */
152 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
156 typedef struct s_steal_lock {
157 pthread_t no_wait_id; /* id of no wait thread */
158 int dev_blocked; /* state */
159 int dev_prev_blocked; /* previous blocked state */
162 struct DEVRES; /* Device resource defined in stored_conf.h */
163 int weof_dev(DEVICE *dev, int num);
164 bool rewind_dev(DEVICE *dev);
167 * Device structure definition. There is one of these for
168 * each physical device. Everything here is "global" to
169 * that device and effects all jobs using the device.
173 dlist *attached_dcrs; /* attached DCR list */
174 pthread_mutex_t mutex; /* access control */
175 pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
176 pthread_cond_t wait; /* thread wait variable */
177 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
178 pthread_t no_wait_id; /* this thread must not wait */
179 int dev_blocked; /* set if we must wait (i.e. change tape) */
180 int dev_prev_blocked; /* previous blocked state */
181 int num_waiting; /* number of threads waiting */
182 int num_writers; /* number of writing threads */
183 int reserved_device; /* number of device reservations */
185 /* New access control in process of being implemented */
186 brwlock_t lock; /* New mutual exclusion lock */
188 int use_count; /* usage count on this device 0 or 1 */
189 int fd; /* file descriptor */
190 int capabilities; /* capabilities mask */
191 int state; /* state mask */
192 int dev_errno; /* Our own errno */
193 int mode; /* read/write modes */
194 int openmode; /* parameter passed to open_dev (useful to reopen the device) */
195 bool autoselect; /* Autoselect in autochanger */
196 bool open_nowait; /* If set, don t wait on open */
197 int label_type; /* Bacula/ANSI/IBM label types */
198 uint32_t drive_index; /* Autochanger drive index (base 0) */
199 int32_t Slot; /* Slot currently in drive (base 1) */
200 POOLMEM *dev_name; /* Physical device name */
201 POOLMEM *prt_name; /* Name used for display purposes */
202 char *errmsg; /* nicely edited error message */
203 uint32_t block_num; /* current block number base 0 */
204 uint32_t file; /* current file number base 0 */
205 uint64_t file_addr; /* Current file read/write address */
206 uint64_t file_size; /* Current file size */
207 uint32_t EndBlock; /* last block written */
208 uint32_t EndFile; /* last file written */
209 uint32_t min_block_size; /* min block size */
210 uint32_t max_block_size; /* max block size */
211 uint64_t max_volume_size; /* max bytes to put on one volume */
212 uint64_t max_file_size; /* max file size to put in one file on volume */
213 uint64_t volume_capacity; /* advisory capacity */
214 uint64_t max_spool_size; /* maximum spool file size */
215 uint64_t spool_size; /* current spool size for this device */
216 uint32_t max_rewind_wait; /* max secs to allow for rewind */
217 uint32_t max_open_wait; /* max secs to allow for open */
218 uint32_t max_open_vols; /* max simultaneous open volumes */
220 uint64_t max_part_size; /* max part size */
221 uint64_t part_size; /* current part size */
222 uint32_t part; /* current part number */
223 uint64_t part_start; /* current part start address (relative to the whole volume) */
224 uint32_t num_parts; /* number of parts (total) */
225 uint64_t free_space; /* current free space on medium (without the current part) */
226 int free_space_errno; /* indicates:
227 * - free_space_errno == 0: ignore free_space.
228 * - free_space_errno < 0: an error occured.
229 * - free_space_errno > 0: free_space is valid. */
231 utime_t vol_poll_interval; /* interval between polling Vol mount */
232 DEVRES *device; /* pointer to Device Resource */
233 btimer_t *tid; /* timer id */
235 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
236 VOLUME_LABEL VolHdr; /* Actual volume label */
237 char pool_name[MAX_NAME_LENGTH]; /* pool name */
238 char pool_type[MAX_NAME_LENGTH]; /* pool type */
240 /* Device wait times ***FIXME*** look at durations */
241 char BadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
242 bool poll; /* set to poll Volume */
251 int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
252 int is_tape() const { return state & ST_TAPE; }
253 int is_file() const { return state & ST_FILE; }
254 int is_fifo() const { return state & ST_FIFO; }
255 int is_dvd() const { return state & ST_DVD; }
256 int is_open() const { return state & ST_OPENED; }
257 int is_offline() const { return state & ST_OFFLINE; }
258 int is_labeled() const { return state & ST_LABEL; }
259 int is_mounted() const { return state & ST_MOUNTED; }
260 int have_media() const { return state & ST_MEDIA; }
261 int is_short_block() const { return state & ST_SHORT; }
262 int is_busy() const { return state & ST_READ || num_writers || reserved_device; }
263 int at_eof() const { return state & ST_EOF; }
264 int at_eot() const { return state & ST_EOT; }
265 int at_weot() const { return state & ST_WEOT; }
266 int can_append() const { return state & ST_APPEND; }
268 * can_write() is meant for checking at the end of a job to see
269 * if we still have a tape (perhaps not if at end of tape
270 * and the job is canceled).
272 int can_write() const { return is_open() && can_append() &&
273 is_labeled() && !at_weot(); }
274 int can_read() const { return state & ST_READ; }
275 bool can_steal_lock() const { return dev_blocked &&
276 (dev_blocked == BST_UNMOUNTED ||
277 dev_blocked == BST_WAITING_FOR_SYSOP ||
278 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
279 bool waiting_for_mount() const { return
280 (dev_blocked == BST_UNMOUNTED ||
281 dev_blocked == BST_WAITING_FOR_SYSOP ||
282 dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
283 bool weof() { return !weof_dev(this, 1); };
284 bool fsr(int num); /* in dev.c */
285 bool rewind() { return rewind_dev(this); };
286 const char *strerror() const;
287 const char *archive_name() const;
288 const char *name() const;
289 const char *print_name() const; /* Name for display purposes */
290 void set_ateof(); /* in dev.c */
291 void set_ateot(); /* in dev.c */
292 void set_eot() { state |= ST_EOT; };
293 void set_eof() { state |= ST_EOF; };
294 void set_append() { state |= ST_APPEND; };
295 void set_labeled() { state |= ST_LABEL; };
296 void set_read() { state |= ST_READ; };
297 void set_offline() { state |= ST_OFFLINE; };
298 void set_opened() { state |= ST_OPENED; };
299 void set_mounted() { state |= ST_MOUNTED; };
300 void set_media() { state |= ST_MEDIA; };
301 void set_short_block() { state |= ST_SHORT; };
302 void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
303 else state &= ~ST_MOUNTED; };
304 void clear_append() { state &= ~ST_APPEND; };
305 void clear_read() { state &= ~ST_READ; };
306 void clear_labeled() { state &= ~ST_LABEL; };
307 void clear_offline() { state &= ~ST_OFFLINE; };
308 void clear_eot() { state &= ~ST_EOT; };
309 void clear_eof() { state &= ~ST_EOF; };
310 void clear_opened() { state &= ~ST_OPENED; };
311 void clear_mounted() { state &= ~ST_MOUNTED; };
312 void clear_media() { state &= ~ST_MEDIA; };
313 void clear_short_block() { state &= ~ST_SHORT; };
314 void block(int why); /* in dev.c */
315 void unblock(); /* in dev.c */
316 void close(); /* in dev.c */
317 int open(char *VolName, int mode); /* in dev.c */
319 void set_blocked(int block) { dev_blocked = block; };
320 int get_blocked() const { return dev_blocked; };
323 /* Note, these return int not bool! */
324 inline const char *DEVICE::strerror() const { return errmsg; }
325 inline const char *DEVICE::archive_name() const { return dev_name; }
326 inline const char *DEVICE::print_name() const { return prt_name; }
329 * Device Context (or Control) Record.
330 * There is one of these records for each Job that is using
331 * the device. Items in this record are "local" to the Job and
332 * do not affect other Jobs. Note, a job can have multiple
333 * DCRs open, each pointing to a different device.
337 dlink dev_link; /* link to attach to dev */
338 JCR *jcr; /* pointer to JCR */
339 DEVICE *dev; /* pointer to device */
340 DEVRES *device; /* pointer to device resource */
341 DEV_BLOCK *block; /* pointer to block */
342 DEV_RECORD *rec; /* pointer to record */
343 int spool_fd; /* fd if spooling */
344 bool spool_data; /* set to spool data */
345 bool spooling; /* set when actually spooling */
346 bool dev_locked; /* set if dev already locked */
347 bool NewVol; /* set if new Volume mounted */
348 bool WroteVol; /* set if Volume written */
349 bool NewFile; /* set when EOF written */
350 bool reserved_device; /* set if reserve done */
351 uint32_t VolFirstIndex; /* First file index this Volume */
352 uint32_t VolLastIndex; /* Last file index this Volume */
353 uint32_t FileIndex; /* Current File Index */
354 uint32_t EndFile; /* End file written */
355 uint32_t StartFile; /* Start write file */
356 uint32_t StartBlock; /* Start write block */
357 uint32_t EndBlock; /* Ending block written */
358 int64_t job_spool_size; /* Current job spool size */
359 int64_t max_job_spool_size; /* Max job spool size */
360 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
361 char pool_name[MAX_NAME_LENGTH]; /* pool name */
362 char pool_type[MAX_NAME_LENGTH]; /* pool type */
363 char media_type[MAX_NAME_LENGTH]; /* media type */
364 char dev_name[MAX_NAME_LENGTH]; /* dev name */
365 int Copy; /* identical copy number */
366 int Stripe; /* RAIT stripe */
367 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
371 * Volume reservation class -- see reserve.c
381 /* Get some definition of function to position
382 * to the end of the medium in MTEOM. System
383 * dependent. Arrgggg!