git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/read_record.c

   1 /*
   2  *
   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, ...
   8  *
   9  *   Version $Id$
  10  */
  11 /*
  12    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  13
  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.
  18
  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.
  23
  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,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31 #include "bacula.h"
  32 #include "stored.h"
  33
  34 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
  35 static char *rec_state_to_str(DEV_RECORD *rec);
  36
  37
  38 int read_records(JCR *jcr,  DEVICE *dev,
  39        void record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
  40        int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block))
  41 {
  42    DEV_BLOCK *block;
  43    DEV_RECORD *rec;
  44    uint32_t record, num_files = 0;
  45    int verbose = FALSE;
  46    int ok = TRUE;
  47    int done = FALSE;
  48    SESSION_LABEL sessrec;
  49
  50    block = new_block(dev);
  51    rec = new_record();
  52    for ( ;ok && !done; ) {
  53       if (job_cancelled(jcr)) {
  54          ok = FALSE;
  55          break;
  56       }
  57       if (!read_block_from_device(dev, block)) {
  58          Dmsg0(20, "!read_record()\n");
  59          if (dev->state & ST_EOT) {
  60             DEV_RECORD *trec = new_record();
  61
  62             Dmsg3(100, "EOT. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
  63                   block->BlockNumber, rec->remainder);
  64             if (!mount_cb(jcr, dev, block)) {
  65                Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
  66                   block->BlockNumber, rec->remainder);
  67                ok = FALSE;
  68                /*
  69                 * Create EOT Label so that Media record may
  70                 *  be properly updated because this is the last
  71                 *  tape.
  72                 */
  73                trec->FileIndex = EOT_LABEL;
  74                trec->File = dev->file;
  75                trec->Block = rec->Block; /* return block last read */
  76                record_cb(jcr, dev, block, trec);
  77                free_record(trec);
  78                break;
  79             }
  80             Dmsg3(100, "After mount next vol. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
  81                   block->BlockNumber, rec->remainder);
  82             /*
  83              * We just have a new tape up, now read the label (first record)
  84              *  and pass it off to the callback routine, then continue
  85              *  most likely reading the previous record.
  86              */
  87             read_block_from_device(dev, block);
  88             read_record_from_block(block, trec);
  89             get_session_record(dev, trec, &sessrec);
  90             trec->File = dev->file;
  91             record_cb(jcr, dev, block, trec);
  92             free_record(trec);
  93             goto next_record;
  94          }
  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");
  99             continue;
 100          }
 101          if (dev->state & ST_SHORT) {
 102             Emsg0(M_INFO, 0, dev->errmsg);
 103             continue;
 104          }
 105 //       display_error_status();
 106          ok = FALSE;
 107          break;
 108       }
 109       if (verbose) {
 110          Dmsg2(10, "Block: %d blen=%d\n", block->BlockNumber, block->block_len);
 111       }
 112
 113 next_record:
 114       record = 0;
 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);
 119             break;
 120          }
 121          rec->File = dev->file;
 122          Dmsg3(10, "read-OK. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
 123                   block->BlockNumber, rec->remainder);
 124          /*
 125           * At this point, we have at least a record header.
 126           *  Now decide if we want this record or not, but remember
 127           *  before accessing the record, we may need to read again to
 128           *  get all the data.
 129           */
 130          record++;
 131          if (verbose) {
 132             Dmsg6(30, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
 133                rec_state_to_str(rec), block->BlockNumber,
 134                rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
 135          }
 136          if (debug_level >= 30) {
 137             Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
 138                   FI_to_ascii(rec->FileIndex),
 139                   stream_to_ascii(rec->Stream, rec->FileIndex),
 140                   rec->data_len);
 141          }
 142
 143          if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
 144             Dmsg0(40, "Get EOM LABEL\n");
 145             rec->remainder = 0;
 146             break;                         /* yes, get out */
 147          }
 148
 149          /* Some sort of label? */
 150          if (rec->FileIndex < 0) {
 151             get_session_record(dev, rec, &sessrec);
 152             record_cb(jcr, dev, block, rec);
 153             continue;
 154          } /* end if label record */
 155
 156          /*
 157           * Apply BSR filter
 158           */
 159          if (jcr->bsr) {
 160             int stat = match_bsr(jcr->bsr, rec, &dev->VolHdr, &sessrec);
 161             if (stat == -1) { /* no more possible matches */
 162                done = TRUE;   /* all items found, stop */
 163                break;
 164             } else if (stat == 0) {  /* no match */
 165                if (verbose) {
 166                   Dmsg5(10, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
 167                      record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
 168                      rec->FileIndex);
 169                }
 170                rec->remainder = 0;
 171                continue;              /* we don't want record, read next one */
 172             }
 173          }
 174          if (is_partial_record(rec)) {
 175             Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
 176                rec_state_to_str(rec), block->BlockNumber,
 177                rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
 178             break;                    /* read second part of record */
 179          }
 180          record_cb(jcr, dev, block, rec);
 181       }
 182    }
 183    if (verbose) {
 184       printf("%u files found.\n", num_files);
 185    }
 186    free_record(rec);
 187    free_block(block);
 188    return ok;
 189 }
 190
 191
 192 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
 193 {
 194    char *rtype;
 195    memset(sessrec, 0, sizeof(sessrec));
 196    switch (rec->FileIndex) {
 197       case PRE_LABEL:
 198          rtype = "Fresh Volume Label";
 199          break;
 200       case VOL_LABEL:
 201          rtype = "Volume Label";
 202          unser_volume_label(dev, rec);
 203          break;
 204       case SOS_LABEL:
 205          rtype = "Begin Session";
 206          unser_session_label(sessrec, rec);
 207          break;
 208       case EOS_LABEL:
 209          rtype = "End Session";
 210          break;
 211       case EOM_LABEL:
 212          rtype = "End of Media";
 213          break;
 214       default:
 215          rtype = "Unknown";
 216          break;
 217    }
 218    Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
 219          rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
 220 }
 221
 222 static char *rec_state_to_str(DEV_RECORD *rec)
 223 {
 224    static char buf[200];
 225    buf[0] = 0;
 226    if (rec->state & REC_NO_HEADER) {
 227       strcat(buf, "Nohdr,");
 228    }
 229    if (is_partial_record(rec)) {
 230       strcat(buf, "partial,");
 231    }
 232    if (rec->state & REC_BLOCK_EMPTY) {
 233       strcat(buf, "empty,");
 234    }
 235    if (rec->state & REC_NO_MATCH) {
 236       strcat(buf, "Nomatch,");
 237    }
 238    if (rec->state & REC_CONTINUATION) {
 239       strcat(buf, "cont,");
 240    }
 241    if (buf[0]) {
 242       buf[strlen(buf)-1] = 0;
 243    }
 244    return buf;
 245 }