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