2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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 */
96 #define dev_state(dev, st_state) ((dev)->state & (st_state))
98 /* Device state bits */
99 #define ST_OPENED (1<<0) /* set when device opened */
100 #define ST_TAPE (1<<1) /* is a tape device */
101 #define ST_FILE (1<<2) /* is a file device */
102 #define ST_FIFO (1<<3) /* is a fifo device */
103 #define ST_PROG (1<<4) /* is a program device */
104 #define ST_LABEL (1<<5) /* label found */
105 #define ST_MALLOC (1<<6) /* dev packet malloc'ed in init_dev() */
106 #define ST_APPEND (1<<7) /* ready for Bacula append */
107 #define ST_READ (1<<8) /* ready for Bacula read */
108 #define ST_EOT (1<<9) /* at end of tape */
109 #define ST_WEOT (1<<10) /* Got EOT on write */
110 #define ST_EOF (1<<11) /* Read EOF i.e. zero bytes */
111 #define ST_NEXTVOL (1<<12) /* Start writing on next volume */
112 #define ST_SHORT (1<<13) /* Short block read */
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 VolCatMounts; /* Number of mounts this volume */
133 uint32_t VolCatErrors; /* Number of errors this volume */
134 uint32_t VolCatWrites; /* Number of writes this volume */
135 uint32_t VolCatReads; /* Number of reads this volume */
136 uint64_t VolCatRBytes; /* Number of bytes read */
137 uint32_t VolCatRecycles; /* Number of recycles this volume */
138 uint32_t EndFile; /* Last file number */
139 uint32_t EndBlock; /* Last block number */
140 int32_t Slot; /* Slot in changer */
141 bool InChanger; /* Set if vol in current magazine */
142 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
143 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
144 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
145 uint64_t VolCatCapacityBytes; /* capacity estimate */
146 uint64_t VolReadTime; /* time spent reading */
147 uint64_t VolWriteTime; /* time spent writing this Volume */
148 char VolCatStatus[20]; /* Volume status */
149 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
153 typedef struct s_steal_lock {
154 pthread_t no_wait_id; /* id of no wait thread */
155 int dev_blocked; /* state */
156 int dev_prev_blocked; /* previous blocked state */
159 struct DEVRES; /* Device resource defined in stored_conf.h */
162 * Device structure definition. There is one of these for
163 * each physical device. Everything here is "global" to
164 * that device and effects all jobs using the device.
168 DEVICE *next; /* pointer to next open device */
169 DEVICE *prev; /* pointer to prev open device */
170 JCR *attached_jcrs; /* attached JCR list */
171 dlist *attached_dcrs; /* attached DCR list */
172 pthread_mutex_t mutex; /* access control */
173 pthread_mutex_t spool_mutex; /* mutex for updating spool_size */
174 pthread_cond_t wait; /* thread wait variable */
175 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
176 pthread_t no_wait_id; /* this thread must not wait */
177 int dev_blocked; /* set if we must wait (i.e. change tape) */
178 int dev_prev_blocked; /* previous blocked state */
179 int num_waiting; /* number of threads waiting */
180 int num_writers; /* number of writing threads */
182 /* New access control in process of being implemented */
183 brwlock_t lock; /* New mutual exclusion lock */
185 int use_count; /* usage count on this device */
186 int fd; /* file descriptor */
187 int capabilities; /* capabilities mask */
188 int state; /* state mask */
189 int dev_errno; /* Our own errno */
190 int mode; /* read/write modes */
191 uint32_t drive_index; /* Autochanger drive index */
192 POOLMEM *dev_name; /* device name */
193 char *errmsg; /* nicely edited error message */
194 uint32_t block_num; /* current block number base 0 */
195 uint32_t file; /* current file number base 0 */
196 uint64_t file_addr; /* Current file read/write address */
197 uint64_t file_size; /* Current file size */
198 uint32_t EndBlock; /* last block written */
199 uint32_t EndFile; /* last file written */
200 uint32_t min_block_size; /* min block size */
201 uint32_t max_block_size; /* max block size */
202 uint64_t max_volume_size; /* max bytes to put on one volume */
203 uint64_t max_file_size; /* max file size to put in one file on volume */
204 uint64_t volume_capacity; /* advisory capacity */
205 uint64_t max_spool_size; /* maximum spool file size */
206 uint64_t spool_size; /* curren spool size */
207 uint32_t max_rewind_wait; /* max secs to allow for rewind */
208 uint32_t max_open_wait; /* max secs to allow for open */
209 uint32_t max_open_vols; /* max simultaneous open volumes */
210 utime_t vol_poll_interval; /* interval between polling Vol mount */
211 DEVRES *device; /* pointer to Device Resource */
212 btimer_t *tid; /* timer id */
214 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
215 VOLUME_LABEL VolHdr; /* Actual volume label */
217 /* Device wait times ***FIXME*** look at durations */
218 char BadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
219 bool poll; /* set to poll Volume */
229 * Device Context (or Control) Record.
230 * There is one of these records for each Job that is using
231 * the device. Items in this record are "local" to the Job and
232 * do not affect other Jobs.
236 dlink dev_link; /* link to attach to dev */
237 JCR *jcr; /* pointer to JCR */
238 DEVICE *dev; /* pointer to device */
239 DEV_BLOCK *block; /* pointer to block */
240 DEV_RECORD *rec; /* pointer to record */
241 int spool_fd; /* fd if spooling */
242 bool spool_data; /* set to spool data */
243 bool spooling; /* set when actually spooling */
244 bool dev_locked; /* set if dev already locked */
245 bool NewVol; /* set if new Volume mounted */
246 bool WroteVol; /* set if Volume written */
247 bool NewFile; /* set when EOF written */
248 uint32_t VolFirstIndex; /* First file index this Volume */
249 uint32_t VolLastIndex; /* Last file index this Volume */
250 uint32_t FileIndex; /* Current File Index */
251 uint32_t EndFile; /* End file written */
252 uint32_t StartFile; /* Start write file */
253 uint32_t StartBlock; /* Start write block */
254 uint32_t EndBlock; /* Ending block written */
255 int64_t spool_size; /* Current spool size */
256 int64_t max_spool_size; /* Max job spool size */
257 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
258 char pool_name[MAX_NAME_LENGTH]; /* pool name */
259 char pool_type[MAX_NAME_LENGTH]; /* pool type */
260 char media_type[MAX_NAME_LENGTH]; /* media type */
261 char dev_name[MAX_NAME_LENGTH]; /* dev name */
262 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
266 /* Get some definition of function to position
267 * to the end of the medium in MTEOM. System
268 * dependent. Arrgggg!