2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 dcr->unload_device = true;
127 if (!dcr->mount_next_write_volume()) {
128 free_block(label_blk);
133 dev->dlock(); /* lock again */
135 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
136 dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
138 Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
139 dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
142 * If this is a new tape, the label_blk will contain the
143 * label, so write it now. If this is a previously
144 * used tape, mount_next_write_volume() will return an
145 * empty label_blk, and nothing will be written.
147 Dmsg0(190, "write label block to dev\n");
148 if (!write_block_to_dev(dcr)) {
150 Pmsg1(0, _("write_block_to_device Volume label failed. ERR=%s"),
151 be.bstrerror(dev->dev_errno));
152 free_block(label_blk);
156 free_block(label_blk);
160 * Walk through all attached jcrs indicating the volume has changed
162 Dmsg1(100, "Notify vol change. Volume=%s\n", dev->VolCatInfo.VolCatName);
164 foreach_dlist(mdcr, dev->attached_dcrs) {
165 JCR *mjcr = mdcr->jcr;
166 if (mjcr->JobId == 0) {
167 continue; /* ignore console */
171 bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
175 /* Clear NewVol now because dir_get_volume_info() already done */
176 jcr->dcr->NewVol = false;
177 set_new_volume_parameters(dcr);
179 jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
181 /* Write overflow block to device */
182 Dmsg0(190, "Write overflow block to dev\n");
183 if (!write_block_to_dev(dcr)) {
185 Pmsg1(0, _("write_block_to_device overflow block failed. ERR=%s"),
186 be.bstrerror(dev->dev_errno));
193 * At this point, the device is locked and blocked.
194 * Unblock the device, restore any entry blocked condition, then
195 * return leaving the device locked (as it was on entry).
198 if (blocked != BST_NOT_BLOCKED) {
199 block_device(dev, blocked);
201 return ok; /* device locked */
204 void set_start_vol_position(DCR *dcr)
206 DEVICE *dev = dcr->dev;
207 /* Set new start position */
208 if (dev->is_tape()) {
209 dcr->StartBlock = dev->block_num;
210 dcr->StartFile = dev->file;
212 dcr->StartBlock = (uint32_t)dev->file_addr;
213 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
218 * We have a new Volume mounted, so reset the Volume parameters
219 * concerning this job. The global changes were made earlier
220 * in the dev structure.
222 void set_new_volume_parameters(DCR *dcr)
225 if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
226 Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
228 set_new_file_parameters(dcr);
229 jcr->NumWriteVolumes++;
234 * We are now in a new Volume file, so reset the Volume parameters
235 * concerning this job. The global changes were made earlier
236 * in the dev structure.
238 void set_new_file_parameters(DCR *dcr)
240 set_start_vol_position(dcr);
243 dcr->VolFirstIndex = 0;
244 dcr->VolLastIndex = 0;
245 dcr->NewFile = false;
246 dcr->WroteVol = false;
252 * First Open of the device. Expect dev to already be initialized.
254 * This routine is used only when the Storage daemon starts
255 * and always_open is set, and in the stand-alone utility
256 * routines such as bextract.
258 * Note, opening of a normal file is deferred to later so
259 * that we can get the filename; the device_name for
260 * a file is the directory only.
262 * Returns: false on failure
265 bool first_open_device(DCR *dcr)
267 DEVICE *dev = dcr->dev;
270 Dmsg0(120, "start open_output_device()\n");
277 /* Defer opening files */
278 if (!dev->is_tape()) {
279 Dmsg0(129, "Device is file, deferring open.\n");
284 if (dev->has_cap(CAP_STREAM)) {
285 mode = OPEN_WRITE_ONLY;
287 mode = OPEN_READ_ONLY;
289 Dmsg0(129, "Opening device.\n");
290 if (dev->open(dcr, mode) < 0) {
291 Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
295 Dmsg1(129, "open dev %s OK\n", dev->print_name());
303 * Make sure device is open, if not do so
305 bool open_device(DCR *dcr)
307 DEVICE *dev = dcr->dev;
310 if (dev->has_cap(CAP_STREAM)) {
311 mode = OPEN_WRITE_ONLY;
313 mode = OPEN_READ_WRITE;
315 if (dev->open(dcr, mode) < 0) {
316 /* If polling, ignore the error */
317 /* If DVD, also ignore the error, very often you cannot open the device
318 * (when there is no DVD, or when the one inserted is a wrong one) */
319 if (!dev->poll && !dev->is_dvd() && !dev->is_removable()) {
320 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
321 dev->print_name(), dev->bstrerror());
322 Pmsg2(000, _("Unable to open archive %s: ERR=%s\n"),
323 dev->print_name(), dev->bstrerror());