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, ...
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
34 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
36 static char *rec_state_to_str(DEV_RECORD *rec);
39 int read_records(JCR *jcr, DEVICE *dev,
40 void record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
41 int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block))
45 uint32_t record, num_files = 0;
49 SESSION_LABEL sessrec;
51 block = new_block(dev);
53 for ( ;ok && !done; ) {
54 if (job_cancelled(jcr)) {
58 if (!read_block_from_device(dev, block)) {
59 Dmsg0(20, "!read_record()\n");
60 if (dev->state & ST_EOT) {
61 DEV_RECORD *trec = new_record();
63 Dmsg3(100, "EOT. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
64 block->BlockNumber, rec->remainder);
65 if (!mount_cb(jcr, dev, block)) {
66 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
67 block->BlockNumber, rec->remainder);
70 * Create EOT Label so that Media record may
71 * be properly updated because this is the last
74 trec->FileIndex = EOT_LABEL;
75 trec->File = dev->file;
76 trec->Block = rec->Block; /* return block last read */
77 record_cb(jcr, dev, block, trec);
81 Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
82 block->BlockNumber, rec->remainder);
84 * We just have a new tape up, now read the label (first record)
85 * and pass it off to the callback routine, then continue
86 * most likely reading the previous record.
88 read_block_from_device(dev, block);
89 read_record_from_block(block, trec);
90 get_session_record(dev, trec, &sessrec);
91 record_cb(jcr, dev, block, trec);
95 if (dev->state & ST_EOF) {
96 Emsg2(M_INFO, 0, "Got EOF on device %s, Volume \"%s\"\n",
97 dev_name(dev), jcr->VolumeName);
98 Dmsg0(20, "read_record got eof. try again\n");
101 if (dev->state & ST_SHORT) {
102 Emsg0(M_INFO, 0, dev->errmsg);
105 // display_error_status();
110 Dmsg2(10, "Block: %d blen=%d\n", block->BlockNumber, block->block_len);
115 for (rec->state=0; !is_block_empty(rec); ) {
116 if (!read_record_from_block(block, rec)) {
117 Dmsg3(10, "!read-break. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
118 block->BlockNumber, rec->remainder);
121 Dmsg3(10, "read-OK. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
122 block->BlockNumber, rec->remainder);
124 * At this point, we have at least a record header.
125 * Now decide if we want this record or not, but remember
126 * before accessing the record, we may need to read again to
131 Dmsg6(30, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
132 rec_state_to_str(rec), block->BlockNumber,
133 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
135 if (debug_level >= 30) {
136 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
137 FI_to_ascii(rec->FileIndex),
138 stream_to_ascii(rec->Stream, rec->FileIndex),
142 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
143 Dmsg0(40, "Get EOM LABEL\n");
145 break; /* yes, get out */
148 /* Some sort of label? */
149 if (rec->FileIndex < 0) {
150 get_session_record(dev, rec, &sessrec);
151 record_cb(jcr, dev, block, rec);
153 } /* end if label record */
159 int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
160 if (stat == -1) { /* no more possible matches */
161 done = TRUE; /* all items found, stop */
163 } else if (stat == 0) { /* no match */
165 Dmsg5(10, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
166 record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
170 continue; /* we don't want record, read next one */
173 if (is_partial_record(rec)) {
174 Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
175 rec_state_to_str(rec), block->BlockNumber,
176 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
177 break; /* read second part of record */
179 record_cb(jcr, dev, block, rec);
183 printf("%u files found.\n", num_files);
191 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
194 memset(sessrec, 0, sizeof(sessrec));
195 switch (rec->FileIndex) {
197 rtype = "Fresh Volume Label";
200 rtype = "Volume Label";
201 unser_volume_label(dev, rec);
204 rtype = "Begin Session";
205 unser_session_label(sessrec, rec);
208 rtype = "End Session";
211 rtype = "End of Media";
217 Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
218 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
222 static char *rec_state_to_str(DEV_RECORD *rec)
224 static char buf[200];
226 if (rec->state & REC_NO_HEADER) {
227 strcat(buf, "Nohdr,");
229 if (is_partial_record(rec)) {
230 strcat(buf, "partial,");
232 if (rec->state & REC_BLOCK_EMPTY) {
233 strcat(buf, "empty,");
235 if (rec->state & REC_NO_MATCH) {
236 strcat(buf, "Nomatch,");
238 if (rec->state & REC_CONTINUATION) {
239 strcat(buf, "cont,");
242 buf[strlen(buf)-1] = 0;