3 * This routine provides a routine that will handle all
4 * the gory little details of reading a record from a Bacula
5 * archive. It uses a callback to pass you each record in turn,
6 * as well as a callback for mounting the next tape. It takes
7 * care of reading blocks, applying the bsr, ...
9 * Kern E. Sibbald, August MMII
14 Copyright (C) 2000-2004 Kern Sibbald and John Walker
16 This program is free software; you can redistribute it and/or
17 modify it under the terms of the GNU General Public License as
18 published by the Free Software Foundation; either version 2 of
19 the License, or (at your option) any later version.
21 This program is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 General Public License for more details.
26 You should have received a copy of the GNU General Public
27 License along with this program; if not, write to the Free
28 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
36 /* Forward referenced functions */
37 static void handle_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
38 static BSR *position_to_first_file(JCR *jcr, DEVICE *dev);
39 static int try_repositioning(JCR *jcr, DEV_RECORD *rec, DEVICE *dev);
41 static char *rec_state_to_str(DEV_RECORD *rec);
44 bool read_records(DCR *dcr,
45 bool record_cb(DCR *dcr, DEV_RECORD *rec),
46 bool mount_cb(DCR *dcr))
49 DEVICE *dev = dcr->dev;
50 DEV_BLOCK *block = dcr->block;
51 DEV_RECORD *rec = NULL;
55 SESSION_LABEL sessrec;
56 dlist *recs; /* linked list of rec packets open */
58 recs = New(dlist(rec, &rec->link));
59 position_to_first_file(jcr, dev);
61 for ( ; ok && !done; ) {
62 if (job_canceled(jcr)) {
66 if (!read_block_from_device(dcr, CHECK_BLOCK_NUMBERS)) {
67 if (dev_state(dev, ST_EOT)) {
68 DEV_RECORD *trec = new_record();
70 Jmsg(jcr, M_INFO, 0, "End of Volume at file %u on device %s, Volume \"%s\"\n",
71 dev->file, dev_name(dev), dcr->VolumeName);
73 Jmsg(jcr, M_INFO, 0, "End of all volumes.\n");
76 * Create EOT Label so that Media record may
77 * be properly updated because this is the last
80 trec->FileIndex = EOT_LABEL;
81 trec->File = dev->file;
82 ok = record_cb(dcr, trec);
87 * We just have a new tape up, now read the label (first record)
88 * and pass it off to the callback routine, then continue
89 * most likely reading the previous record.
91 read_block_from_device(dcr, NO_BLOCK_NUMBER_CHECK);
92 read_record_from_block(block, trec);
93 handle_session_record(dev, trec, &sessrec);
94 ok = record_cb(dcr, trec);
96 position_to_first_file(jcr, dev);
97 /* After reading label, we must read first data block */
100 } else if (dev_state(dev, ST_EOF)) {
102 Jmsg(jcr, M_INFO, 0, "Got EOF at file %u on device %s, Volume \"%s\"\n",
103 dev->file, dev_name(dev), dcr->VolumeName);
105 Dmsg3(200, "Got EOF at file %u on device %s, Volume \"%s\"\n",
106 dev->file, dev_name(dev), dcr->VolumeName);
108 } else if (dev_state(dev, ST_SHORT)) {
109 Jmsg1(jcr, M_ERROR, 0, "%s", dev->errmsg);
112 /* I/O error or strange end of tape */
113 display_tape_error_status(jcr, dev);
114 if (forge_on || jcr->ignore_label_errors) {
115 fsr_dev(dev, 1); /* try skipping bad record */
116 Dmsg0(000, "Did fsr\n");
117 continue; /* try to continue */
123 Dmsg2(300, "New block at position=(file:block) %d:%d\n", dev->file, dev->block_num);
124 #ifdef if_and_when_FAST_BLOCK_REJECTION_is_working
125 /* this does not stop when file/block are too big */
126 if (!match_bsr_block(jcr->bsr, block)) {
127 if (try_repositioning(jcr, rec, dev)) {
128 break; /* get next volume */
130 continue; /* skip this record */
135 * Get a new record for each Job as defined by
136 * VolSessionId and VolSessionTime
139 foreach_dlist(rec, recs) {
140 if (rec->VolSessionId == block->VolSessionId &&
141 rec->VolSessionTime == block->VolSessionTime) {
149 Dmsg2(300, "New record for SI=%d ST=%d\n",
150 block->VolSessionId, block->VolSessionTime);
153 if (rec->Block != 0 && (rec->Block+1) != block->BlockNumber) {
154 Jmsg(jcr, M_ERROR, 0, _("Invalid block number. Expected %u, got %u\n"),
155 rec->Block+1, block->BlockNumber);
159 Dmsg3(300, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
160 block->BlockNumber, rec->remainder);
163 Dmsg1(300, "Block empty %d\n", is_block_empty(rec));
164 for (rec->state=0; !is_block_empty(rec); ) {
165 if (!read_record_from_block(block, rec)) {
166 Dmsg3(400, "!read-break. state=%s blk=%d rem=%d\n", rec_state_to_str(rec),
167 block->BlockNumber, rec->remainder);
170 Dmsg5(300, "read-OK. state=%s blk=%d rem=%d file:block=%d:%d\n",
171 rec_state_to_str(rec), block->BlockNumber, rec->remainder,
172 dev->file, dev->block_num);
174 * At this point, we have at least a record header.
175 * Now decide if we want this record or not, but remember
176 * before accessing the record, we may need to read again to
180 Dmsg6(300, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
181 rec_state_to_str(rec), block->BlockNumber,
182 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
184 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
185 Dmsg0(40, "Get EOM LABEL\n");
186 break; /* yes, get out */
189 /* Some sort of label? */
190 if (rec->FileIndex < 0) {
191 handle_session_record(dev, rec, &sessrec);
192 ok = record_cb(dcr, rec);
193 if (rec->FileIndex == EOS_LABEL) {
194 Dmsg2(300, "Remove rec. SI=%d ST=%d\n", rec->VolSessionId,
195 rec->VolSessionTime);
200 } /* end if label record */
206 int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
207 if (stat == -1) { /* no more possible matches */
208 done = true; /* all items found, stop */
209 Dmsg2(300, "All done=(file:block) %d:%d\n", dev->file, dev->block_num);
211 } else if (stat == 0) { /* no match */
212 Dmsg4(300, "Clear rem=%d FI=%d before set_eof pos %d:%d\n",
213 rec->remainder, rec->FileIndex, dev->file, dev->block_num);
215 rec->state &= ~REC_PARTIAL_RECORD;
216 if (try_repositioning(jcr, rec, dev)) {
219 continue; /* we don't want record, read next one */
222 if (is_partial_record(rec)) {
223 Dmsg6(300, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
224 rec_state_to_str(rec), block->BlockNumber,
225 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
226 break; /* read second part of record */
228 ok = record_cb(dcr, rec);
229 if (rec->Stream == STREAM_MD5_SIGNATURE || rec->Stream == STREAM_SHA1_SIGNATURE) {
230 Dmsg3(300, "Done FI=%d before set_eof pos %d:%d\n", rec->FileIndex,
231 dev->file, dev->block_num);
232 if (match_set_eof(jcr->bsr, rec) && try_repositioning(jcr, rec, dev)) {
233 Dmsg2(300, "Break after match_set_eof pos %d:%d\n",
234 dev->file, dev->block_num);
237 Dmsg2(300, "After set_eof pos %d:%d\n", dev->file, dev->block_num);
239 } /* end for loop over records */
240 Dmsg2(300, "After end records position=(file:block) %d:%d\n", dev->file, dev->block_num);
241 } /* end for loop over blocks */
242 // Dmsg2(300, "Position=(file:block) %d:%d\n", dev->file, dev->block_num);
244 /* Walk down list and free all remaining allocated recs */
245 while (!recs->empty()) {
246 rec = (DEV_RECORD *)recs->first();
251 print_block_read_errors(jcr, block);
256 * See if we can reposition.
257 * Returns: 1 if at end of volume
260 static int try_repositioning(JCR *jcr, DEV_RECORD *rec, DEVICE *dev)
263 bsr = find_next_bsr(jcr->bsr, dev);
264 if (bsr == NULL && jcr->bsr->mount_next_volume) {
265 Dmsg0(300, "Would mount next volume here\n");
266 Dmsg2(300, "Current postion (file:block) %d:%d\n",
267 dev->file, dev->block_num);
268 jcr->bsr->mount_next_volume = false;
269 dev->state |= ST_EOT;
275 Jmsg(jcr, M_INFO, 0, "Reposition from (file:block) %d:%d to %d:%d\n",
276 dev->file, dev->block_num, bsr->volfile->sfile,
277 bsr->volblock->sblock);
279 Dmsg4(300, "Try_Reposition from (file:block) %d:%d to %d:%d\n",
280 dev->file, dev->block_num, bsr->volfile->sfile,
281 bsr->volblock->sblock);
282 reposition_dev(dev, bsr->volfile->sfile, bsr->volblock->sblock);
289 * Position to the first file on this volume
291 static BSR *position_to_first_file(JCR *jcr, DEVICE *dev)
295 * Now find and position to first file and block
299 jcr->bsr->reposition = true; /* force repositioning */
300 bsr = find_next_bsr(jcr->bsr, dev);
301 if (bsr && (bsr->volfile->sfile != 0 || bsr->volblock->sblock != 0)) {
302 Jmsg(jcr, M_INFO, 0, _("Forward spacing to file:block %u:%u.\n"),
303 bsr->volfile->sfile, bsr->volblock->sblock);
304 Dmsg2(300, "Forward spacing to file:block %u:%u.\n",
305 bsr->volfile->sfile, bsr->volblock->sblock);
306 reposition_dev(dev, bsr->volfile->sfile, bsr->volblock->sblock);
313 static void handle_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
318 memset(sessrec, 0, sizeof(sessrec));
319 switch (rec->FileIndex) {
321 rtype = "Fresh Volume Label";
324 rtype = "Volume Label";
325 unser_volume_label(dev, rec);
328 rtype = "Begin Session";
329 unser_session_label(sessrec, rec);
332 rtype = "End Session";
335 rtype = "End of Media";
338 bsnprintf(buf, sizeof(buf), "Unknown code %d\n", rec->FileIndex);
342 Dmsg5(300, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
343 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
347 static char *rec_state_to_str(DEV_RECORD *rec)
349 static char buf[200];
351 if (rec->state & REC_NO_HEADER) {
352 bstrncat(buf, "Nohdr,", sizeof(buf));
354 if (is_partial_record(rec)) {
355 bstrncat(buf, "partial,", sizeof(buf));
357 if (rec->state & REC_BLOCK_EMPTY) {
358 bstrncat(buf, "empty,", sizeof(buf));
360 if (rec->state & REC_NO_MATCH) {
361 bstrncat(buf, "Nomatch,", sizeof(buf));
363 if (rec->state & REC_CONTINUATION) {
364 bstrncat(buf, "cont,", sizeof(buf));
367 buf[strlen(buf)-1] = 0;