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 get_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 void record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
43 int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block))
47 uint32_t record, num_files = 0;
50 SESSION_LABEL sessrec;
52 block = new_block(dev);
54 for ( ; ok && !done; ) {
55 if (job_canceled(jcr)) {
59 if (!read_block_from_device(jcr, dev, block, CHECK_BLOCK_NUMBERS)) {
60 Dmsg0(20, "!read_record()\n");
61 if (dev->state & ST_EOT) {
62 DEV_RECORD *trec = new_record();
64 Dmsg3(100, "EOT. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
65 block->BlockNumber, rec->remainder);
66 Jmsg(jcr, M_INFO, 0, "Got EOM at file %u on device %s, Volume \"%s\"\n",
67 dev->file, dev_name(dev), jcr->VolumeName);
68 if (!mount_cb(jcr, dev, block)) {
69 Jmsg(jcr, M_INFO, 0, "End of all volumes.\n");
70 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
71 block->BlockNumber, rec->remainder);
74 * Create EOT Label so that Media record may
75 * be properly updated because this is the last
78 trec->FileIndex = EOT_LABEL;
79 trec->File = dev->file;
80 trec->Block = rec->Block; /* return block last read */
81 record_cb(jcr, dev, block, trec);
85 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
86 block->BlockNumber, rec->remainder);
88 * We just have a new tape up, now read the label (first record)
89 * and pass it off to the callback routine, then continue
90 * most likely reading the previous record.
92 read_block_from_device(jcr, dev, block, NO_BLOCK_NUMBER_CHECK);
93 read_record_from_block(block, trec);
94 get_session_record(dev, trec, &sessrec);
95 record_cb(jcr, dev, block, trec);
97 goto next_record; /* go read new tape */
99 } else if (dev->state & ST_EOF) {
100 Jmsg(jcr, M_INFO, 0, "Got EOF at file %u on device %s, Volume \"%s\"\n",
101 dev->file, dev_name(dev), jcr->VolumeName);
102 Dmsg0(20, "read_record got eof. try again\n");
104 } else if (dev->state & ST_SHORT) {
105 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
108 /* I/O error or strange end of tape */
109 display_tape_error_status(jcr, dev);
114 if (!match_bsr_block(jcr->bsr, block)) {
115 Dmsg5(100, "reject Blk=%u blen=%u bVer=%d SessId=%u SessTim=%u\n",
116 block->BlockNumber, block->block_len, block->BlockVer,
117 block->VolSessionId, block->VolSessionTime);
121 Dmsg4(000, "Block: %d VI=%u VT=%u blen=%d\n", block->BlockNumber,
122 block->VolSessionId, block->VolSessionTime, block->block_len);
127 for (rec->state=0; !is_block_empty(rec); ) {
128 if (!read_record_from_block(block, rec)) {
129 Dmsg3(10, "!read-break. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
130 block->BlockNumber, rec->remainder);
133 Dmsg3(10, "read-OK. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
134 block->BlockNumber, rec->remainder);
136 * At this point, we have at least a record header.
137 * Now decide if we want this record or not, but remember
138 * before accessing the record, we may need to read again to
143 Dmsg6(30, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
144 rec_state_to_str(rec), block->BlockNumber,
145 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
147 if (debug_level >= 30) {
148 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
149 FI_to_ascii(rec->FileIndex),
150 stream_to_ascii(rec->Stream, rec->FileIndex),
154 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
155 Dmsg0(40, "Get EOM LABEL\n");
157 break; /* yes, get out */
160 /* Some sort of label? */
161 if (rec->FileIndex < 0) {
162 get_session_record(dev, rec, &sessrec);
163 record_cb(jcr, dev, block, rec);
165 } /* end if label record */
171 int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
172 if (stat == -1) { /* no more possible matches */
173 done = TRUE; /* all items found, stop */
175 } else if (stat == 0) { /* no match */
177 Dmsg5(10, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
178 record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
182 continue; /* we don't want record, read next one */
185 if (is_partial_record(rec)) {
186 Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
187 rec_state_to_str(rec), block->BlockNumber,
188 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
189 break; /* read second part of record */
191 record_cb(jcr, dev, block, rec);
195 printf("%u files found.\n", num_files);
203 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
206 memset(sessrec, 0, sizeof(sessrec));
207 switch (rec->FileIndex) {
209 rtype = "Fresh Volume Label";
212 rtype = "Volume Label";
213 unser_volume_label(dev, rec);
216 rtype = "Begin Session";
217 unser_session_label(sessrec, rec);
220 rtype = "End Session";
223 rtype = "End of Media";
229 Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
230 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
234 static char *rec_state_to_str(DEV_RECORD *rec)
236 static char buf[200];
238 if (rec->state & REC_NO_HEADER) {
239 strcat(buf, "Nohdr,");
241 if (is_partial_record(rec)) {
242 strcat(buf, "partial,");
244 if (rec->state & REC_BLOCK_EMPTY) {
245 strcat(buf, "empty,");
247 if (rec->state & REC_NO_MATCH) {
248 strcat(buf, "Nomatch,");
250 if (rec->state & REC_CONTINUATION) {
251 strcat(buf, "cont,");
254 buf[strlen(buf)-1] = 0;