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 if (!mount_cb(jcr, dev, block)) {
67 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
68 block->BlockNumber, rec->remainder);
71 * Create EOT Label so that Media record may
72 * be properly updated because this is the last
75 trec->FileIndex = EOT_LABEL;
76 trec->File = dev->file;
77 trec->Block = rec->Block; /* return block last read */
78 record_cb(jcr, dev, block, trec);
82 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
83 block->BlockNumber, rec->remainder);
85 * We just have a new tape up, now read the label (first record)
86 * and pass it off to the callback routine, then continue
87 * most likely reading the previous record.
89 read_block_from_device(jcr, dev, block, NO_BLOCK_NUMBER_CHECK);
90 read_record_from_block(block, trec);
91 get_session_record(dev, trec, &sessrec);
92 record_cb(jcr, dev, block, trec);
94 goto next_record; /* go read new tape */
96 } else if (dev->state & ST_EOF) {
97 Jmsg(jcr, M_INFO, 0, "Got EOF at file %u on device %s, Volume \"%s\"\n",
98 dev->file, dev_name(dev), jcr->VolumeName);
99 Dmsg0(20, "read_record got eof. try again\n");
101 } else if (dev->state & ST_SHORT) {
102 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
105 /* I/O error or strange end of tape */
106 display_tape_error_status(jcr, dev);
112 Dmsg2(10, "Block: %d blen=%d\n", block->BlockNumber, block->block_len);
117 for (rec->state=0; !is_block_empty(rec); ) {
118 if (!read_record_from_block(block, rec)) {
119 Dmsg3(10, "!read-break. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
120 block->BlockNumber, rec->remainder);
123 Dmsg3(10, "read-OK. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
124 block->BlockNumber, rec->remainder);
126 * At this point, we have at least a record header.
127 * Now decide if we want this record or not, but remember
128 * before accessing the record, we may need to read again to
133 Dmsg6(30, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
134 rec_state_to_str(rec), block->BlockNumber,
135 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
137 if (debug_level >= 30) {
138 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
139 FI_to_ascii(rec->FileIndex),
140 stream_to_ascii(rec->Stream, rec->FileIndex),
144 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
145 Dmsg0(40, "Get EOM LABEL\n");
147 break; /* yes, get out */
150 /* Some sort of label? */
151 if (rec->FileIndex < 0) {
152 get_session_record(dev, rec, &sessrec);
153 record_cb(jcr, dev, block, rec);
155 } /* end if label record */
161 int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
162 if (stat == -1) { /* no more possible matches */
163 done = TRUE; /* all items found, stop */
165 } else if (stat == 0) { /* no match */
167 Dmsg5(10, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
168 record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
172 continue; /* we don't want record, read next one */
175 if (is_partial_record(rec)) {
176 Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
177 rec_state_to_str(rec), block->BlockNumber,
178 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
179 break; /* read second part of record */
181 record_cb(jcr, dev, block, rec);
185 printf("%u files found.\n", num_files);
193 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
196 memset(sessrec, 0, sizeof(sessrec));
197 switch (rec->FileIndex) {
199 rtype = "Fresh Volume Label";
202 rtype = "Volume Label";
203 unser_volume_label(dev, rec);
206 rtype = "Begin Session";
207 unser_session_label(sessrec, rec);
210 rtype = "End Session";
213 rtype = "End of Media";
219 Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
220 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
224 static char *rec_state_to_str(DEV_RECORD *rec)
226 static char buf[200];
228 if (rec->state & REC_NO_HEADER) {
229 strcat(buf, "Nohdr,");
231 if (is_partial_record(rec)) {
232 strcat(buf, "partial,");
234 if (rec->state & REC_BLOCK_EMPTY) {
235 strcat(buf, "empty,");
237 if (rec->state & REC_NO_MATCH) {
238 strcat(buf, "Nomatch,");
240 if (rec->state & REC_CONTINUATION) {
241 strcat(buf, "cont,");
244 buf[strlen(buf)-1] = 0;