-
Notifications
You must be signed in to change notification settings - Fork 256
/
device.c
393 lines (355 loc) · 12 KB
/
device.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2012 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2013 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/*
* Higher Level Device routines.
* Knows about Bareos tape labels and such
*
* NOTE! In general, subroutines that have the word
* "device" in the name do locking. Subroutines
* that have the word "dev" in the name do not
* do locking. Thus if xxx_device() calls
* yyy_dev(), all is OK, but if xxx_device()
* calls yyy_device(), everything will hang.
* Obviously, no zzz_dev() is allowed to call
* a www_device() or everything falls apart.
*
* Concerning the routines dev->r_lock()() and block_device()
* see the end of this module for details. In general,
* blocking a device leaves it in a state where all threads
* other than the current thread block when they attempt to
* lock the device. They remain suspended (blocked) until the device
* is unblocked. So, a device is blocked during an operation
* that takes a long time (initialization, mounting a new
* volume, ...) locking a device is done for an operation
* that takes a short time such as writing data to the
* device.
*
* Kern Sibbald, MM, MMI
*/
#include "bareos.h" /* pull in global headers */
#include "stored.h" /* pull in Storage Deamon headers */
/* Forward referenced functions */
/*
* This is the dreaded moment. We either have an end of
* medium condition or worse, and error condition.
* Attempt to "recover" by obtaining a new Volume.
*
* Here are a few things to know:
* dcr->VolCatInfo contains the info on the "current" tape for this job.
* dev->VolCatInfo contains the info on the tape in the drive.
* The tape in the drive could have changed several times since
* the last time the job used it (jcr->VolCatInfo).
* dcr->VolumeName is the name of the current/desired tape in the drive.
*
* We enter with device locked, and
* exit with device locked.
*
* Note, we are called only from one place in block.c for the daemons.
* The btape utility calls it from btape.c.
*
* Returns: true on success
* false on failure
*/
bool fixup_device_block_write_error(DCR *dcr, int retries)
{
char PrevVolName[MAX_NAME_LENGTH];
DEV_BLOCK *block;
char b1[30], b2[30];
time_t wait_time;
char dt[MAX_TIME_LENGTH];
JCR *jcr = dcr->jcr;
DEVICE *dev = dcr->dev;
int blocked = dev->blocked(); /* save any previous blocked status */
bool ok = false;
wait_time = time(NULL);
Dmsg0(100, "=== Enter fixup_device_block_write_error\n");
/*
* If we are blocked at entry, unblock it, and set our own block status
*/
if (blocked != BST_NOT_BLOCKED) {
unblock_device(dev);
}
block_device(dev, BST_DOING_ACQUIRE);
/* Continue unlocked, but leave BLOCKED */
dev->Unlock();
bstrncpy(PrevVolName, dev->getVolCatName(), sizeof(PrevVolName));
bstrncpy(dev->VolHdr.PrevVolumeName, PrevVolName, sizeof(dev->VolHdr.PrevVolumeName));
/* Save the old block and create a new temporary label block */
block = dcr->block;
dcr->block = new_block(dev);
/* Inform User about end of medium */
Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
bstrftime(dt, sizeof(dt), time(NULL)));
Dmsg1(050, "set_unload dev=%s\n", dev->print_name());
dev->set_unload();
if (!dcr->mount_next_write_volume()) {
free_block(dcr->block);
dcr->block = block;
dev->Lock();
goto bail_out;
}
Dmsg2(050, "must_unload=%d dev=%s\n", dev->must_unload(), dev->print_name());
dev->Lock(); /* lock again */
dev->VolCatInfo.VolCatJobs++; /* increment number of jobs on vol */
dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
/*
* If this is a new tape, the label_blk will contain the
* label, so write it now. If this is a previously
* used tape, mount_next_write_volume() will return an
* empty label_blk, and nothing will be written.
*/
Dmsg0(190, "write label block to dev\n");
if (!dcr->write_block_to_dev()) {
berrno be;
Pmsg1(0, _("write_block_to_device Volume label failed. ERR=%s"),
be.bstrerror(dev->dev_errno));
free_block(dcr->block);
dcr->block = block;
goto bail_out;
}
free_block(dcr->block);
dcr->block = block;
/*
* Walk through all attached jcrs indicating the volume has changed
*/
Dmsg1(100, "Notify vol change. Volume=%s\n", dev->getVolCatName());
DCR *mdcr;
foreach_dlist(mdcr, dev->attached_dcrs) {
JCR *mjcr = mdcr->jcr;
if (mjcr->JobId == 0) {
continue; /* ignore console */
}
mdcr->NewVol = true;
if (jcr != mjcr) {
bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
}
}
/* Clear NewVol now because dir_get_volume_info() already done */
jcr->dcr->NewVol = false;
set_new_volume_parameters(dcr);
jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
/* Write overflow block to device */
Dmsg0(190, "Write overflow block to dev\n");
if (!dcr->write_block_to_dev()) {
berrno be;
Dmsg1(0, _("write_block_to_device overflow block failed. ERR=%s"),
be.bstrerror(dev->dev_errno));
/* Note: recursive call */
if (retries-- <= 0 || !fixup_device_block_write_error(dcr, retries)) {
Jmsg2(jcr, M_FATAL, 0,
_("Catastrophic error. Cannot write overflow block to device %s. ERR=%s"),
dev->print_name(), be.bstrerror(dev->dev_errno));
goto bail_out;
}
}
ok = true;
bail_out:
/*
* At this point, the device is locked and blocked.
* Unblock the device, restore any entry blocked condition, then
* return leaving the device locked (as it was on entry).
*/
unblock_device(dev);
if (blocked != BST_NOT_BLOCKED) {
block_device(dev, blocked);
}
return ok; /* device locked */
}
void set_start_vol_position(DCR *dcr)
{
DEVICE *dev = dcr->dev;
/* Set new start position */
if (dev->is_tape()) {
dcr->StartBlock = dev->block_num;
dcr->StartFile = dev->file;
} else {
dcr->StartBlock = (uint32_t)dev->file_addr;
dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
}
}
/*
* We have a new Volume mounted, so reset the Volume parameters
* concerning this job. The global changes were made earlier
* in the dev structure.
*/
void set_new_volume_parameters(DCR *dcr)
{
JCR *jcr = dcr->jcr;
if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
}
set_new_file_parameters(dcr);
jcr->NumWriteVolumes++;
dcr->NewVol = false;
}
/*
* We are now in a new Volume file, so reset the Volume parameters
* concerning this job. The global changes were made earlier
* in the dev structure.
*/
void set_new_file_parameters(DCR *dcr)
{
set_start_vol_position(dcr);
/* Reset indicies */
dcr->VolFirstIndex = 0;
dcr->VolLastIndex = 0;
dcr->NewFile = false;
dcr->WroteVol = false;
}
/*
* First Open of the device. Expect dev to already be initialized.
*
* This routine is used only when the Storage daemon starts
* and always_open is set, and in the stand-alone utility
* routines such as bextract.
*
* Note, opening of a normal file is deferred to later so
* that we can get the filename; the device_name for
* a file is the directory only.
*
* Returns: false on failure
* true on success
*/
bool first_open_device(DCR *dcr)
{
DEVICE *dev = dcr->dev;
bool ok = true;
Dmsg0(120, "start open_output_device()\n");
if (!dev) {
return false;
}
dev->rLock();
/* Defer opening files */
if (!dev->is_tape()) {
Dmsg0(129, "Device is file, deferring open.\n");
goto bail_out;
}
int mode;
if (dev->has_cap(CAP_STREAM)) {
mode = OPEN_WRITE_ONLY;
} else {
mode = OPEN_READ_ONLY;
}
Dmsg0(129, "Opening device.\n");
if (!dev->open(dcr, mode)) {
Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
ok = false;
goto bail_out;
}
Dmsg1(129, "open dev %s OK\n", dev->print_name());
bail_out:
dev->Unlock();
return ok;
}
/*
* Make sure device is open, if not do so
*/
bool open_device(DCR *dcr)
{
DEVICE *dev = dcr->dev;
/* Open device */
int mode;
if (dev->has_cap(CAP_STREAM)) {
mode = OPEN_WRITE_ONLY;
} else {
mode = OPEN_READ_WRITE;
}
if (!dev->open(dcr, mode)) {
/* If polling, ignore the error */
if (!dev->poll && !dev->is_removable()) {
Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
dev->print_name(), dev->bstrerror());
Pmsg2(000, _("Unable to open archive %s: ERR=%s\n"),
dev->print_name(), dev->bstrerror());
}
return false;
}
return true;
}
/*
* Position to the first file on this volume
*/
BSR *position_device_to_first_file(JCR *jcr, DCR *dcr)
{
BSR *bsr = NULL;
DEVICE *dev = dcr->dev;
uint32_t file, block;
/*
* Now find and position to first file and block
* on this tape.
*/
if (jcr->bsr) {
jcr->bsr->reposition = true; /* force repositioning */
bsr = find_next_bsr(jcr->bsr, dev);
if (get_bsr_start_addr(bsr, &file, &block) > 0) {
Jmsg(jcr, M_INFO, 0, _("Forward spacing Volume \"%s\" to file:block %u:%u.\n"),
dev->VolHdr.VolumeName, file, block);
dev->reposition(dcr, file, block);
}
}
return bsr;
}
/*
* See if we can reposition.
*
* Returns: true if at end of volume
* false otherwise
*/
bool try_device_repositioning(JCR *jcr, DEV_RECORD *rec, DCR *dcr)
{
BSR *bsr;
DEVICE *dev = dcr->dev;
bsr = find_next_bsr(jcr->bsr, dev);
if (bsr == NULL && jcr->bsr->mount_next_volume) {
Dmsg0(500, "Would mount next volume here\n");
Dmsg2(500, "Current postion (file:block) %u:%u\n",
dev->file, dev->block_num);
jcr->bsr->mount_next_volume = false;
if (!dev->at_eot()) {
/* Set EOT flag to force mount of next Volume */
jcr->mount_next_volume = true;
dev->set_eot();
}
rec->Block = 0;
return true;
}
if (bsr) {
/*
* ***FIXME*** gross kludge to make disk seeking work. Remove
* when find_next_bsr() is fixed not to return a bsr already
* completed.
*/
uint32_t block, file;
/* TODO: use dev->file_addr ? */
uint64_t dev_addr = (((uint64_t) dev->file)<<32) | dev->block_num;
uint64_t bsr_addr = get_bsr_start_addr(bsr, &file, &block);
if (dev_addr > bsr_addr) {
return false;
}
Dmsg4(500, "Try_Reposition from (file:block) %u:%u to %u:%u\n",
dev->file, dev->block_num, file, block);
dev->reposition(dcr, file, block);
rec->Block = 0;
}
return false;
}