2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Higher Level Device routines.
31 * Knows about Bacula tape labels and such
33 * NOTE! In general, subroutines that have the word
34 * "device" in the name do locking. Subroutines
35 * that have the word "dev" in the name do not
36 * do locking. Thus if xxx_device() calls
37 * yyy_dev(), all is OK, but if xxx_device()
38 * calls yyy_device(), everything will hang.
39 * Obviously, no zzz_dev() is allowed to call
40 * a www_device() or everything falls apart.
42 * Concerning the routines dev->r_lock()() and block_device()
43 * see the end of this module for details. In general,
44 * blocking a device leaves it in a state where all threads
45 * other than the current thread block when they attempt to
46 * lock the device. They remain suspended (blocked) until the device
47 * is unblocked. So, a device is blocked during an operation
48 * that takes a long time (initialization, mounting a new
49 * volume, ...) locking a device is done for an operation
50 * that takes a short time such as writing data to the
54 * Kern Sibbald, MM, MMI
59 #include "bacula.h" /* pull in global headers */
60 #include "stored.h" /* pull in Storage Deamon headers */
62 /* Forward referenced functions */
65 * This is the dreaded moment. We either have an end of
66 * medium condition or worse, and error condition.
67 * Attempt to "recover" by obtaining a new Volume.
69 * Here are a few things to know:
70 * dcr->VolCatInfo contains the info on the "current" tape for this job.
71 * dev->VolCatInfo contains the info on the tape in the drive.
72 * The tape in the drive could have changed several times since
73 * the last time the job used it (jcr->VolCatInfo).
74 * dcr->VolumeName is the name of the current/desired tape in the drive.
76 * We enter with device locked, and
77 * exit with device locked.
79 * Note, we are called only from one place in block.c for the daemons.
80 * The btape utility calls it from btape.c.
82 * Returns: true on success
85 bool fixup_device_block_write_error(DCR *dcr)
87 char PrevVolName[MAX_NAME_LENGTH];
89 DEV_BLOCK *block = dcr->block;
92 char dt[MAX_TIME_LENGTH];
94 DEVICE *dev = dcr->dev;
95 int blocked = dev->blocked(); /* save any previous blocked status */
98 wait_time = time(NULL);
100 Dmsg0(100, "Enter fixup_device_block_write_error\n");
103 * If we are blocked at entry, unblock it, and set our own block status
105 if (blocked != BST_NOT_BLOCKED) {
108 block_device(dev, BST_DOING_ACQUIRE);
110 /* Continue unlocked, but leave BLOCKED */
113 bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
114 bstrncpy(dev->VolHdr.PrevVolumeName, PrevVolName, sizeof(dev->VolHdr.PrevVolumeName));
116 label_blk = new_block(dev);
117 dcr->block = label_blk;
119 /* Inform User about end of medium */
120 Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
121 PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
122 edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
123 bstrftime(dt, sizeof(dt), time(NULL)));
125 /* Called with have_vol=false, release=true */
126 if (!mount_next_write_volume(dcr, false, true)) {
127 free_block(label_blk);
132 dev->dlock(); /* lock again */
134 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
135 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
137 Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
138 dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
141 * If this is a new tape, the label_blk will contain the
142 * label, so write it now. If this is a previously
143 * used tape, mount_next_write_volume() will return an
144 * empty label_blk, and nothing will be written.
146 Dmsg0(190, "write label block to dev\n");
147 if (!write_block_to_dev(dcr)) {
149 Pmsg1(0, _("write_block_to_device Volume label failed. ERR=%s"),
150 be.bstrerror(dev->dev_errno));
151 free_block(label_blk);
155 free_block(label_blk);
159 * Walk through all attached jcrs indicating the volume has changed
161 Dmsg1(100, "Walk attached dcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
163 foreach_dlist(mdcr, dev->attached_dcrs) {
164 JCR *mjcr = mdcr->jcr;
165 if (mjcr->JobId == 0) {
166 continue; /* ignore console */
170 bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
174 /* Clear NewVol now because dir_get_volume_info() already done */
175 jcr->dcr->NewVol = false;
176 set_new_volume_parameters(dcr);
178 jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
180 /* Write overflow block to device */
181 Dmsg0(190, "Write overflow block to dev\n");
182 if (!write_block_to_dev(dcr)) {
184 Pmsg1(0, _("write_block_to_device overflow block failed. ERR=%s"),
185 be.bstrerror(dev->dev_errno));
192 * At this point, the device is locked and blocked.
193 * Unblock the device, restore any entry blocked condition, then
194 * return leaving the device locked (as it was on entry).
197 if (blocked != BST_NOT_BLOCKED) {
198 block_device(dev, blocked);
200 return ok; /* device locked */
203 void set_start_vol_position(DCR *dcr)
205 DEVICE *dev = dcr->dev;
206 /* Set new start position */
207 if (dev->is_tape()) {
208 dcr->StartBlock = dev->block_num;
209 dcr->StartFile = dev->file;
211 dcr->StartBlock = (uint32_t)dev->file_addr;
212 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
217 * We have a new Volume mounted, so reset the Volume parameters
218 * concerning this job. The global changes were made earlier
219 * in the dev structure.
221 void set_new_volume_parameters(DCR *dcr)
224 if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
225 Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
227 set_new_file_parameters(dcr);
228 jcr->NumWriteVolumes++;
233 * We are now in a new Volume file, so reset the Volume parameters
234 * concerning this job. The global changes were made earlier
235 * in the dev structure.
237 void set_new_file_parameters(DCR *dcr)
239 set_start_vol_position(dcr);
242 dcr->VolFirstIndex = 0;
243 dcr->VolLastIndex = 0;
244 dcr->NewFile = false;
245 dcr->WroteVol = false;
251 * First Open of the device. Expect dev to already be initialized.
253 * This routine is used only when the Storage daemon starts
254 * and always_open is set, and in the stand-alone utility
255 * routines such as bextract.
257 * Note, opening of a normal file is deferred to later so
258 * that we can get the filename; the device_name for
259 * a file is the directory only.
261 * Returns: false on failure
264 bool first_open_device(DCR *dcr)
266 DEVICE *dev = dcr->dev;
269 Dmsg0(120, "start open_output_device()\n");
276 /* Defer opening files */
277 if (!dev->is_tape()) {
278 Dmsg0(129, "Device is file, deferring open.\n");
283 if (dev->has_cap(CAP_STREAM)) {
284 mode = OPEN_WRITE_ONLY;
286 mode = OPEN_READ_ONLY;
288 Dmsg0(129, "Opening device.\n");
289 if (dev->open(dcr, mode) < 0) {
290 Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
294 Dmsg1(129, "open dev %s OK\n", dev->print_name());
302 * Make sure device is open, if not do so
304 bool open_device(DCR *dcr)
306 DEVICE *dev = dcr->dev;
309 if (dev->has_cap(CAP_STREAM)) {
310 mode = OPEN_WRITE_ONLY;
312 mode = OPEN_READ_WRITE;
314 if (dev->open(dcr, mode) < 0) {
315 /* If polling, ignore the error */
316 /* If DVD, also ignore the error, very often you cannot open the device
317 * (when there is no DVD, or when the one inserted is a wrong one) */
318 if (!dev->poll && !dev->is_dvd() && !dev->is_removable()) {
319 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
320 dev->print_name(), dev->bstrerror());
321 Pmsg2(000, _("Unable to open archive %s: ERR=%s\n"),
322 dev->print_name(), dev->bstrerror());