2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
9 Copyright (C) 2000-2003 Kern Sibbald and John Walker
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of
14 the License, or (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public
22 License along with this program; if not, write to the Free
23 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* #define NEW_LOCK 1 */
34 #define new_lock_device(dev) _new_lock_device(__FILE__, __LINE__, (dev))
35 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
36 #define new_unlock_device(dev) _new_unlock_device(__FILE__, __LINE__, (dev))
38 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
39 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
40 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
41 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
42 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
43 #define give_back_device_lock(d, p) _give_back_device_lock(__FILE__, __LINE__, (d), (p))
45 /* Arguments to open_dev() */
48 #define OPEN_READ_WRITE 0
49 #define OPEN_READ_ONLY 1
50 #define OPEN_WRITE_ONLY 2
52 /* Generic status bits returned from status_dev() */
53 #define BMT_TAPE (1<<0) /* is tape device */
54 #define BMT_EOF (1<<1) /* just read EOF */
55 #define BMT_BOT (1<<2) /* at beginning of tape */
56 #define BMT_EOT (1<<3) /* end of tape reached */
57 #define BMT_SM (1<<4) /* DDS setmark */
58 #define BMT_EOD (1<<5) /* DDS at end of data */
59 #define BMT_WR_PROT (1<<6) /* tape write protected */
60 #define BMT_ONLINE (1<<7) /* tape online */
61 #define BMT_DR_OPEN (1<<8) /* tape door open */
62 #define BMT_IM_REP_EN (1<<9) /* immediate report enabled */
65 /* Test capabilities */
66 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
68 /* Bits for device capabilities */
69 #define CAP_EOF (1<<0) /* has MTWEOF */
70 #define CAP_BSR (1<<1) /* has MTBSR */
71 #define CAP_BSF (1<<2) /* has MTBSF */
72 #define CAP_FSR (1<<3) /* has MTFSR */
73 #define CAP_FSF (1<<4) /* has MTFSF */
74 #define CAP_EOM (1<<5) /* has MTEOM */
75 #define CAP_REM (1<<6) /* is removable media */
76 #define CAP_RACCESS (1<<7) /* is random access device */
77 #define CAP_AUTOMOUNT (1<<8) /* Read device at start to see what is there */
78 #define CAP_LABEL (1<<9) /* Label blank tapes */
79 #define CAP_ANONVOLS (1<<10) /* Mount without knowing volume name */
80 #define CAP_ALWAYSOPEN (1<<11) /* always keep device open */
81 #define CAP_AUTOCHANGER (1<<12) /* AutoChanger */
82 #define CAP_OFFLINEUNMOUNT (1<<13) /* Offline before unmount */
83 #define CAP_STREAM (1<<14) /* Stream device */
84 #define CAP_BSFATEOM (1<<15) /* Backspace file at EOM */
85 #define CAP_FASTFSF (1<<16) /* Fast forward space file */
86 #define CAP_TWOEOF (1<<17) /* Write two eofs for EOM */
89 #define dev_state(dev, st_state) ((dev)->state & (st_state))
91 /* Device state bits */
92 #define ST_OPENED (1<<0) /* set when device opened */
93 #define ST_TAPE (1<<1) /* is a tape device */
94 #define ST_FILE (1<<2) /* is a file device */
95 #define ST_FIFO (1<<3) /* is a fifo device */
96 #define ST_PROG (1<<4) /* is a program device */
97 #define ST_LABEL (1<<5) /* label found */
98 #define ST_MALLOC (1<<6) /* dev packet malloc'ed in init_dev() */
99 #define ST_APPEND (1<<7) /* ready for Bacula append */
100 #define ST_READ (1<<8) /* ready for Bacula read */
101 #define ST_EOT (1<<9) /* at end of tape */
102 #define ST_WEOT (1<<10) /* Got EOT on write */
103 #define ST_EOF (1<<11) /* Read EOF i.e. zero bytes */
104 #define ST_NEXTVOL (1<<12) /* Start writing on next volume */
105 #define ST_SHORT (1<<13) /* Short block read */
107 /* dev_blocked states (mutually exclusive) */
108 #define BST_NOT_BLOCKED 0 /* not blocked */
109 #define BST_UNMOUNTED 1 /* User unmounted device */
110 #define BST_WAITING_FOR_SYSOP 2 /* Waiting for operator to mount tape */
111 #define BST_DOING_ACQUIRE 3 /* Opening/validating/moving tape */
112 #define BST_WRITING_LABEL 4 /* Labeling a tape */
113 #define BST_UNMOUNTED_WAITING_FOR_SYSOP 5 /* Closed by user during mount request */
114 #define BST_MOUNT 6 /* Mount request */
116 /* Volume Catalog Information structure definition */
117 struct VOLUME_CAT_INFO {
118 /* Media info for the current Volume */
119 uint32_t VolCatJobs; /* number of jobs on this Volume */
120 uint32_t VolCatFiles; /* Number of files */
121 uint32_t VolCatBlocks; /* Number of blocks */
122 uint64_t VolCatBytes; /* Number of bytes written */
123 uint32_t VolCatMounts; /* Number of mounts this volume */
124 uint32_t VolCatErrors; /* Number of errors this volume */
125 uint32_t VolCatWrites; /* Number of writes this volume */
126 uint32_t VolCatReads; /* Number of reads this volume */
127 uint64_t VolCatRBytes; /* Number of bytes read */
128 uint32_t VolCatRecycles; /* Number of recycles this volume */
129 int32_t Slot; /* Slot in changer */
130 int32_t Drive; /* Changer drive */
131 bool InChanger; /* Set if vol in current magazine */
132 uint32_t VolCatMaxJobs; /* Maximum Jobs to write to volume */
133 uint32_t VolCatMaxFiles; /* Maximum files to write to volume */
134 uint64_t VolCatMaxBytes; /* Max bytes to write to volume */
135 uint64_t VolCatCapacityBytes; /* capacity estimate */
136 char VolCatStatus[20]; /* Volume status */
137 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
141 typedef struct s_steal_lock {
142 pthread_t no_wait_id; /* id of no wait thread */
143 int dev_blocked; /* state */
146 struct DEVRES; /* Device resource defined in stored_conf.h */
148 /* Device structure definition */
151 DEVICE *next; /* pointer to next open device */
152 DEVICE *prev; /* pointer to prev open device */
153 JCR *attached_jcrs; /* attached JCR list */
154 pthread_mutex_t mutex; /* access control */
155 pthread_cond_t wait; /* thread wait variable */
156 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
157 pthread_t no_wait_id; /* this thread must not wait */
158 int dev_blocked; /* set if we must wait (i.e. change tape) */
159 int num_waiting; /* number of threads waiting */
160 int num_writers; /* number of writing threads */
161 int use_count; /* usage count on this device */
162 int fd; /* file descriptor */
163 int capabilities; /* capabilities mask */
164 int state; /* state mask */
165 int dev_errno; /* Our own errno */
166 int mode; /* read/write modes */
167 char *dev_name; /* device name */
168 char *errmsg; /* nicely edited error message */
169 uint32_t block_num; /* current block number base 0 */
170 uint32_t file; /* current file number base 0 */
171 uint64_t file_addr; /* Current file read/write address */
172 uint32_t EndBlock; /* last block written */
173 uint32_t EndFile; /* last file written */
174 uint32_t min_block_size; /* min block size */
175 uint32_t max_block_size; /* max block size */
176 uint64_t max_volume_size; /* max bytes to put on one volume */
177 uint64_t max_file_size; /* max file size to put in one file on volume */
178 uint64_t volume_capacity; /* advisory capacity */
179 uint32_t max_rewind_wait; /* max secs to allow for rewind */
180 uint32_t max_open_wait; /* max secs to allow for open */
181 uint32_t max_open_vols; /* max simultaneous open volumes */
182 DEVRES *device; /* pointer to Device Resource */
183 btimer_id tid; /* timer id */
185 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
186 VOLUME_LABEL VolHdr; /* Actual volume label */
191 /* Get some definition of function to position
192 * to the end of the medium in MTEOM. System
193 * dependent. Arrgggg!