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-2003 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 static void handle_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
38 static char *rec_state_to_str(DEV_RECORD *rec);
41 int read_records(JCR *jcr, DEVICE *dev,
42 int record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
43 int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block))
46 DEV_RECORD *rec = NULL;
50 SESSION_LABEL sessrec;
51 dlist *recs; /* linked list of rec packets open */
53 block = new_block(dev);
54 recs = new dlist(rec, &rec->link);
56 for ( ; ok && !done; ) {
57 if (job_canceled(jcr)) {
61 if (!read_block_from_device(jcr, dev, block, CHECK_BLOCK_NUMBERS)) {
62 Dmsg0(20, "!read_record()\n");
63 if (dev_state(dev, ST_EOT)) {
64 DEV_RECORD *trec = new_record();
66 Dmsg3(100, "EOT. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
67 block->BlockNumber, rec->remainder);
68 Jmsg(jcr, M_INFO, 0, "End of Volume at file %u on device %s, Volume \"%s\"\n",
69 dev->file, dev_name(dev), jcr->VolumeName);
70 if (!mount_cb(jcr, dev, block)) {
71 Jmsg(jcr, M_INFO, 0, "End of all volumes.\n");
72 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
73 block->BlockNumber, rec->remainder);
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 trec->Block = rec->Block; /* return block last read */
83 ok = record_cb(jcr, dev, block, trec);
87 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
88 block->BlockNumber, rec->remainder);
90 * We just have a new tape up, now read the label (first record)
91 * and pass it off to the callback routine, then continue
92 * most likely reading the previous record.
94 read_block_from_device(jcr, dev, block, NO_BLOCK_NUMBER_CHECK);
95 read_record_from_block(block, trec);
96 handle_session_record(dev, trec, &sessrec);
97 ok = record_cb(jcr, dev, block, trec);
100 * Now find and position to first file and block
106 jcr->bsr->reposition = true;
107 bsr = find_next_bsr(jcr->bsr, dev);
109 Jmsg(jcr, M_INFO, 0, _("Forward spacing to file:block %u:%u.\n"),
110 bsr->volfile->sfile, bsr->volblock->sblock);
111 Dmsg4(100, "Reposition new from (file:block) %d:%d to %d:%d\n",
112 dev->file, dev->block_num, bsr->volfile->sfile,
113 bsr->volblock->sblock);
114 reposition_dev(dev, bsr->volfile->sfile, bsr->volblock->sblock);
115 Dmsg2(100, "Now at (file:block) %d:%d\n",
116 dev->file, dev->block_num);
119 /* After reading label, we must read first data block */
122 } else if (dev_state(dev, ST_EOF)) {
123 Jmsg(jcr, M_INFO, 0, "Got EOF at file %u on device %s, Volume \"%s\"\n",
124 dev->file, dev_name(dev), jcr->VolumeName);
125 Dmsg0(20, "read_record got eof. try again\n");
127 } else if (dev_state(dev, ST_SHORT)) {
128 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
131 /* I/O error or strange end of tape */
132 display_tape_error_status(jcr, dev);
137 Dmsg5(100, "Read block: dev=%d blk=%d VI=%u VT=%u blen=%d\n", dev->block_num, block->BlockNumber,
138 block->VolSessionId, block->VolSessionTime, block->block_len);
139 if (!match_bsr_block(jcr->bsr, block)) {
140 Dmsg5(100, "reject Blk=%u blen=%u bVer=%d SessId=%u SessTim=%u\n",
141 block->BlockNumber, block->block_len, block->BlockVer,
142 block->VolSessionId, block->VolSessionTime);
145 Dmsg4(100, "Block: %d VI=%u VT=%u blen=%d\n", block->BlockNumber,
146 block->VolSessionId, block->VolSessionTime, block->block_len);
149 * Get a new record for each Job as defined by
150 * VolSessionId and VolSessionTime
153 for (rec=(DEV_RECORD *)recs->first(); rec; rec=(DEV_RECORD *)recs->next(rec)) {
154 if (rec->VolSessionId == block->VolSessionId &&
155 rec->VolSessionTime == block->VolSessionTime) {
163 Dmsg2(100, "New record for SI=%d ST=%d\n",
164 block->VolSessionId, block->VolSessionTime);
166 if (rec->Block != 0 && (rec->Block+1) != block->BlockNumber) {
167 Jmsg(jcr, M_ERROR, 0, _("Invalid block number. Expected %u, got %u\n"),
168 rec->Block+1, block->BlockNumber);
171 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
172 block->BlockNumber, rec->remainder);
174 for (rec->state=0; !is_block_empty(rec); ) {
175 if (!read_record_from_block(block, rec)) {
176 Dmsg3(10, "!read-break. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
177 block->BlockNumber, rec->remainder);
180 Dmsg5(100, "read-OK. stat=%s blk=%d rem=%d file:block=%d:%d\n",
181 rec_state_to_str(rec), block->BlockNumber, rec->remainder,
182 dev->file, dev->block_num);
184 * At this point, we have at least a record header.
185 * Now decide if we want this record or not, but remember
186 * before accessing the record, we may need to read again to
190 Dmsg6(100, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
191 rec_state_to_str(rec), block->BlockNumber,
192 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
193 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
194 FI_to_ascii(rec->FileIndex),
195 stream_to_ascii(rec->Stream, rec->FileIndex),
198 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
199 Dmsg0(40, "Get EOM LABEL\n");
200 break; /* yes, get out */
203 /* Some sort of label? */
204 if (rec->FileIndex < 0) {
205 handle_session_record(dev, rec, &sessrec);
206 ok = record_cb(jcr, dev, block, rec);
207 if (rec->FileIndex == EOS_LABEL) {
208 Dmsg2(100, "Remove rec. SI=%d ST=%d\n", rec->VolSessionId,
209 rec->VolSessionTime);
214 } /* end if label record */
220 int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
221 if (stat == -1) { /* no more possible matches */
222 done = true; /* all items found, stop */
224 } else if (stat == 0) { /* no match */
226 bsr = find_next_bsr(jcr->bsr, dev);
227 if (bsr == NULL && jcr->bsr->mount_next_volume) {
228 Dmsg0(100, "Would mount next volume here\n");
229 Dmsg2(100, "Current postion (file:block) %d:%d\n",
230 dev->file, dev->block_num);
231 jcr->bsr->mount_next_volume = false;
232 dev->state |= ST_EOT;
237 Dmsg4(100, "Reposition from (file:block) %d:%d to %d:%d\n",
238 dev->file, dev->block_num, bsr->volfile->sfile,
239 bsr->volblock->sblock);
240 reposition_dev(dev, bsr->volfile->sfile, bsr->volblock->sblock);
242 Dmsg2(100, "Now at (file:block) %d:%d\n",
243 dev->file, dev->block_num);
245 Dmsg5(100, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
246 record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
248 continue; /* we don't want record, read next one */
251 if (is_partial_record(rec)) {
252 Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
253 rec_state_to_str(rec), block->BlockNumber,
254 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
255 break; /* read second part of record */
257 ok = record_cb(jcr, dev, block, rec);
258 } /* end for loop over records */
259 } /* end for loop over blocks */
261 /* Walk down list and free all remaining allocated recs */
262 for (rec=(DEV_RECORD *)recs->first(); rec; ) {
263 DEV_RECORD *nrec = (DEV_RECORD *)recs->next(rec);
269 print_block_errors(jcr, block);
275 static void handle_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
279 memset(sessrec, 0, sizeof(sessrec));
280 switch (rec->FileIndex) {
282 rtype = "Fresh Volume Label";
285 rtype = "Volume Label";
286 unser_volume_label(dev, rec);
289 rtype = "Begin Session";
290 unser_session_label(sessrec, rec);
293 rtype = "End Session";
296 rtype = "End of Media";
299 bsnprintf(buf, sizeof(buf), "Unknown code %d\n", rec->FileIndex);
303 Dmsg5(100, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
304 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
308 static char *rec_state_to_str(DEV_RECORD *rec)
310 static char buf[200];
312 if (rec->state & REC_NO_HEADER) {
313 strcat(buf, "Nohdr,");
315 if (is_partial_record(rec)) {
316 strcat(buf, "partial,");
318 if (rec->state & REC_BLOCK_EMPTY) {
319 strcat(buf, "empty,");
321 if (rec->state & REC_NO_MATCH) {
322 strcat(buf, "Nomatch,");
324 if (rec->state & REC_CONTINUATION) {
325 strcat(buf, "cont,");
328 buf[strlen(buf)-1] = 0;