3 * Higher Level Device routines.
4 * Knows about Bacula tape labels and such
6 * NOTE! In general, subroutines that have the word
7 * "device" in the name do locking. Subroutines
8 * that have the word "dev" in the name do not
9 * do locking. Thus if xxx_device() calls
10 * yyy_dev(), all is OK, but if xxx_device()
11 * calls yyy_device(), everything will hang.
12 * Obviously, no zzz_dev() is allowed to call
13 * a www_device() or everything falls apart.
15 * Concerning the routines lock_device() and block_device()
16 * see the end of this module for details. In general,
17 * blocking a device leaves it in a state where all threads
18 * other than the current thread block when they attempt to
19 * lock the device. They remain suspended (blocked) until the device
20 * is unblocked. So, a device is blocked during an operation
21 * that takes a long time (initialization, mounting a new
22 * volume, ...) locking a device is done for an operation
23 * that takes a short time such as writing data to the
27 * Kern Sibbald, MM, MMI
32 Copyright (C) 2000-2003 Kern Sibbald and John Walker
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
51 #include "bacula.h" /* pull in global headers */
52 #include "stored.h" /* pull in Storage Deamon headers */
54 /* Forward referenced functions */
56 extern char my_name[];
57 extern int debug_level;
60 * This is the dreaded moment. We either have an end of
61 * medium condition or worse, and error condition.
62 * Attempt to "recover" by obtaining a new Volume.
64 * We enter with device locked, and
65 * exit with device locked.
67 * Note, we are called only from one place in block.c
69 * Returns: 1 on success
72 int fixup_device_block_write_error(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
75 char PrevVolName[MAX_NAME_LENGTH];
76 DEV_BLOCK *label_blk = NULL;
80 wait_time = time(NULL);
81 status_dev(dev, &stat);
83 Dmsg0(100, "======= Got EOD ========\n");
85 block_device(dev, BST_DOING_ACQUIRE);
86 /* Unlock, but leave BLOCKED */
90 * Walk through all attached jcrs creating a jobmedia_record()
92 Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
93 for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
94 if (mjcr->JobId == 0) {
95 continue; /* ignore console */
97 Dmsg1(100, "create JobMedia for Job %s\n", mjcr->Job);
98 if (dev->state & ST_TAPE) {
99 mjcr->EndBlock = dev->EndBlock;
100 mjcr->EndFile = dev->EndFile;
101 Dmsg2(200, "Fixup EndFile=%u EndBlock=%u\n", mjcr->EndFile, mjcr->EndBlock);
103 mjcr->EndBlock = (uint32_t)dev->file_addr;
104 mjcr->EndFile = (uint32_t)(dev->file_addr >> 32);
106 if (!dir_create_jobmedia_record(mjcr)) {
107 Jmsg(mjcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=%s Job=%s\n"),
108 dev->VolCatInfo.VolCatName, mjcr->Job);
113 mjcr->VolFirstIndex = 0; /* prevent writing jobmedia second time */
116 strcpy(dev->VolCatInfo.VolCatStatus, "Full");
117 Dmsg2(200, "Call update_vol_info Stat=%s Vol=%s\n",
118 dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
119 if (!dir_update_volume_info(jcr, &dev->VolCatInfo, 0)) { /* send Volume info to Director */
122 return 0; /* device locked */
124 Dmsg0(100, "Back from update_vol_info\n");
126 bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
127 bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
129 label_blk = new_block(dev);
131 /* Inform User about end of medium */
132 Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s.\n"),
133 PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
134 edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2));
136 if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
139 return 0; /* device locked */
141 P(dev->mutex); /* lock again */
143 Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s\n"),
144 jcr->VolumeName, dev_name(dev));
147 * If this is a new tape, the label_blk will contain the
148 * label, so write it now. If this is a previously
149 * used tape, mount_next_write_volume() will return an
150 * empty label_blk, and nothing will be written.
152 Dmsg0(190, "write label block to dev\n");
153 if (!write_block_to_dev(jcr, dev, label_blk)) {
154 Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
156 free_block(label_blk);
158 return 0; /* device locked */
161 /* Write overflow block to tape */
162 Dmsg0(190, "Write overflow block to dev\n");
163 if (!write_block_to_dev(jcr, dev, block)) {
164 Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
166 free_block(label_blk);
168 return 0; /* device locked */
172 Dmsg0(190, "Wake up any waiting threads.\n");
173 free_block(label_blk);
174 for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
175 /* Set new start/end positions */
176 if (dev->state & ST_TAPE) {
177 mjcr->StartBlock = dev->block_num;
178 mjcr->StartFile = dev->file;
180 mjcr->StartBlock = (uint32_t)dev->file_addr;
181 mjcr->StartFile = (uint32_t)(dev->file_addr >> 32);
183 /* Set first FirstIndex for new Volume */
184 mjcr->VolFirstIndex = mjcr->JobFiles;
185 mjcr->run_time += time(NULL) - wait_time; /* correct run time */
188 return 1; /* device locked */
191 free_block(label_blk);
193 return 0; /* device locked */
198 * Open the device. Expect dev to already be initialized.
200 * This routine is used only when the Storage daemon starts
201 * and always_open is set, and in the stand-alone utility
202 * routines such as bextract.
204 * Note, opening of a normal file is deferred to later so
205 * that we can get the filename; the device_name for
206 * a file is the directory only.
208 * Retuns: 0 on failure
211 int open_device(DEVICE *dev)
213 Dmsg0(120, "start open_output_device()\n");
220 /* Defer opening files */
221 if (!dev_is_tape(dev)) {
222 Dmsg0(129, "Device is file, deferring open.\n");
227 if (!(dev->state & ST_OPENED)) {
228 Dmsg0(129, "Opening device.\n");
229 if (open_dev(dev, NULL, READ_WRITE) < 0) {
230 Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
235 Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
242 * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
243 * must wait. The no_wait_id thread is out obtaining a new volume
244 * and preparing the label.
246 void _lock_device(char *file, int line, DEVICE *dev)
249 Dmsg3(100, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
251 if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
252 dev->num_waiting++; /* indicate that I am waiting */
253 while (dev->dev_blocked) {
254 if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
256 Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
260 dev->num_waiting--; /* no longer waiting */
264 void _unlock_device(char *file, int line, DEVICE *dev)
266 Dmsg2(100, "unlock from %s:%d\n", file, line);
271 * Block all other threads from using the device
272 * Device must already be locked. After this call,
273 * the device is blocked to any thread calling lock_device(),
274 * but the device is not locked (i.e. no P on device). Also,
275 * the current thread can do slip through the lock_device()
276 * calls without blocking.
278 void _block_device(char *file, int line, DEVICE *dev, int state)
280 Dmsg3(100, "block set %d from %s:%d\n", state, file, line);
281 ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
282 dev->dev_blocked = state; /* make other threads wait */
283 dev->no_wait_id = pthread_self(); /* allow us to continue */
289 * Unblock the device, and wake up anyone who went to sleep.
291 void _unblock_device(char *file, int line, DEVICE *dev)
293 Dmsg3(100, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
294 ASSERT(dev->dev_blocked);
295 dev->dev_blocked = BST_NOT_BLOCKED;
296 if (dev->num_waiting > 0) {
297 pthread_cond_broadcast(&dev->wait); /* wake them up */
301 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
303 Dmsg4(100, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
305 hold->dev_blocked = dev->dev_blocked;
306 hold->no_wait_id = dev->no_wait_id;
307 dev->dev_blocked = state;
308 dev->no_wait_id = pthread_self();
312 void _return_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
314 Dmsg4(100, "return lock. old=%d new=%d from %s:%d\n",
315 dev->dev_blocked, hold->dev_blocked, file, line);
317 dev->dev_blocked = hold->dev_blocked;
318 dev->no_wait_id = hold->no_wait_id;
323 /* ==================================================================
324 * New device locking code. It is not currently used.
325 * ==================================================================
329 * New device locking scheme
331 void _new_lock_device(char *file, int line, DEVICE *dev)
335 if ((errstat=rwl_writelock(&dev->lock)) != 0) {
336 e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
342 void _new_lock_device(char *file, int line, DEVICE *dev, int state)
346 if ((errstat=rwl_writelock(&dev->lock)) != 0) {
347 e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
350 dev->dev_blocked = state;
354 void _new_unlock_device(char *file, int line, DEVICE *dev)
358 if (dev->lock.w_active == 1) {
359 dev->dev_blocked = BST_NOT_BLOCKED;
361 if ((errstat=rwl_writeunlock(&dev->lock)) != 0) {
362 e_msg(file, line, M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
368 void new_steal_device_lock(DEVICE *dev, brwsteal_t *hold, int state)
371 hold->state = dev->dev_blocked;
372 hold->writer_id = dev->lock.writer_id;
373 dev->dev_blocked = state;
374 dev->lock.writer_id = pthread_self();
379 void new_return_device_lock(DEVICE *dev, brwsteal_t *hold)
383 dev->dev_blocked = hold->state;
384 dev->lock.writer_id = hold->writer_id;