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

   1 /*
   2  *
   3  *   record.c -- tape record handling functions
   4  *
   5  *              Kern Sibbald, April MMI
   6  *
   7  *   Version $Id$
   8  *
   9  */
  10 /*
  11    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of
  16    the License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public
  24    License along with this program; if not, write to the Free
  25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  26    MA 02111-1307, USA.
  27
  28  */
  29
  30
  31 #include "bacula.h"
  32 #include "stored.h"
  33
  34 extern int debug_level;
  35
  36 /*
  37  * Convert a FileIndex into a printable
  38  *   ASCII string.  Not reentrant.
  39  * If the FileIndex is negative, it flags the
  40  *   record as a Label, otherwise it is simply
  41  *   the FileIndex of the current file.
  42  */
  43 char *FI_to_ascii(int fi)
  44 {
  45    static char buf[20];
  46    if (fi >= 0) {
  47       sprintf(buf, "%d", fi);
  48       return buf;
  49    }
  50    switch (fi) {
  51    case PRE_LABEL:
  52       return "PRE_LABEL";
  53    case VOL_LABEL:
  54       return "VOL_LABEL";
  55    case EOM_LABEL:
  56       return "EOM_LABEL";
  57    case SOS_LABEL:
  58       return "SOS_LABEL";
  59    case EOS_LABEL:
  60       return "EOS_LABEL";
  61    default:
  62      sprintf(buf, "unknown: %d", fi);
  63      return buf;
  64    }
  65 }
  66
  67
  68 /*
  69  * Convert a Stream ID into a printable
  70  * ASCII string.  Not reentrant.
  71  */
  72 char *stream_to_ascii(int stream)
  73 {
  74     static char buf[20];
  75     switch (stream) {
  76     case STREAM_UNIX_ATTRIBUTES:
  77        return "UATTR";
  78     case STREAM_FILE_DATA:
  79        return "DATA";
  80     case STREAM_MD5_SIGNATURE:
  81        return "MD5";
  82     case STREAM_GZIP_DATA:
  83        return "GZIP";
  84     default:
  85        sprintf(buf, "%d", stream);
  86        return buf;
  87     }
  88 }
  89
  90 /*
  91  * Return a new record entity
  92  */
  93 DEV_RECORD *new_record(void)
  94 {
  95    DEV_RECORD *rec;
  96
  97    rec = (DEV_RECORD *) get_memory(sizeof(DEV_RECORD));
  98    memset(rec, 0, sizeof(DEV_RECORD));
  99    rec->data = get_pool_memory(PM_MESSAGE);
 100    return rec;
 101 }
 102
 103 /*
 104  * Free the record entity
 105  *
 106  */
 107 void free_record(DEV_RECORD *rec)
 108 {
 109    Dmsg0(150, "Enter free_record.\n");
 110    free_pool_memory(rec->data);
 111    Dmsg0(150, "Data buf is freed.\n");
 112    free_pool_memory((POOLMEM *)rec);
 113    Dmsg0(150, "Leave free_record.\n");
 114 }
 115
 116 /*
 117  * Read a record from a block
 118  *   if necessary, read the block from the device without locking
 119  *   if necessary, handle getting a new Volume
 120  *
 121  *  Returns: 0 on failure
 122  *           1 on success
 123  */
 124 int read_record(DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *record)
 125 {
 126    Dmsg2(90, "read_record() dev=%x state=%x\n", dev, dev->state);
 127
 128    while (!read_record_from_block(block, record)) {
 129       Dmsg2(90, "!read_record_from_block data_len=%d rem=%d\n", record->data_len,
 130                 record->remainder);
 131       if (!read_block_from_dev(dev, block)) {
 132          Dmsg0(200, "===== Got read block I/O error ======\n");
 133          return 0;
 134       }
 135    }
 136    Dmsg4(90, "read_record FI=%s SessId=%d Strm=%s len=%d\n",
 137               FI_to_ascii(record->FileIndex), record->VolSessionId,
 138               stream_to_ascii(record->Stream), record->data_len);
 139    record->File = dev->file;
 140    record->Block = dev->block_num;
 141    return 1;
 142 }
 143
 144
 145 /*
 146  * Write a Record to the block
 147  *
 148  *  Returns: 0 on failure (none or partially written)
 149  *           1 on success (all bytes written)
 150  *
 151  *  and remainder returned in packet.
 152  *
 153  *  We require enough room for the header, and we deal with
 154  *  two special cases. 1. Only part of the record may have
 155  *  been transferred the last time (when remainder is
 156  *  non-zero), and 2. The remaining bytes to write may not
 157  *  all fit into the block.
 158  */
 159 int write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
 160 {
 161    ser_declare;
 162    uint32_t remlen;
 163
 164    sm_check(__FILE__, __LINE__, False);
 165    remlen = block->buf_len - block->binbuf;
 166
 167    ASSERT(block->binbuf == (uint32_t) (block->bufp - block->buf));
 168    ASSERT(remlen >= 0);
 169
 170    Dmsg6(190, "write_record_to_block() FI=%s SessId=%d Strm=%s len=%d\n\
 171 rem=%d remainder=%d\n",
 172       FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 173       stream_to_ascii(rec->Stream), rec->data_len,
 174       remlen, rec->remainder);
 175
 176    /*
 177     * If rec->remainder is non-zero, we have been called a
 178     *  second (or subsequent) time to finish writing a record
 179     *  that did not previously fit into the block.
 180     */
 181    if (rec->remainder == 0) {
 182       /* Require enough room to write a full header */
 183       if (remlen >= RECHDR_LENGTH) {
 184          ser_begin(block->bufp, RECHDR_LENGTH);
 185          ser_uint32(rec->VolSessionId);
 186          ser_uint32(rec->VolSessionTime);
 187          ser_int32(rec->FileIndex);
 188          ser_int32(rec->Stream);
 189          ser_uint32(rec->data_len);
 190          ASSERT(ser_length(block->bufp) == RECHDR_LENGTH);
 191
 192          block->bufp += RECHDR_LENGTH;
 193          block->binbuf += RECHDR_LENGTH;
 194          remlen -= RECHDR_LENGTH;
 195          rec->remainder = rec->data_len;
 196       } else {
 197          rec->remainder = rec->data_len + RECHDR_LENGTH;
 198          sm_check(__FILE__, __LINE__, False);
 199          return 0;
 200       }
 201    } else {
 202       /*
 203        * We are here to write unwritten bytes from a previous
 204        * time. Presumably we have a new buffer (possibly
 205        * containing a volume label), so the new header
 206        * should be able to fit in the block -- otherwise we have
 207        * an error.  Note, we may have to continue splitting the
 208        * data record though.
 209        *
 210        * First, write the header, then write as much as
 211        * possible of the data record.
 212        *
 213        * Every time we write a header and it is a continuation
 214        * of a previous partially written record, we store the
 215        * Stream as -Stream in the record header.
 216        */
 217       ser_begin(block->bufp, RECHDR_LENGTH);
 218       ser_uint32(rec->VolSessionId);
 219       ser_uint32(rec->VolSessionTime);
 220       ser_int32(rec->FileIndex);
 221       if (rec->remainder > rec->data_len) {
 222          ser_int32(rec->Stream);      /* normal full header */
 223          ser_uint32(rec->data_len);
 224          rec->remainder = rec->data_len; /* must still do data record */
 225       } else {
 226          ser_int32(-rec->Stream);     /* mark this as a continuation record */
 227          ser_uint32(rec->remainder);  /* bytes to do */
 228       }
 229       ASSERT(ser_length(block->bufp) == RECHDR_LENGTH);
 230
 231       /* Require enough room to write a full header */
 232       ASSERT(remlen >= RECHDR_LENGTH);
 233
 234       block->bufp += RECHDR_LENGTH;
 235       block->binbuf += RECHDR_LENGTH;
 236       remlen -= RECHDR_LENGTH;
 237    }
 238    if (remlen == 0) {
 239       sm_check(__FILE__, __LINE__, False);
 240       return 0;                       /* partial transfer */
 241    }
 242
 243    /*
 244     * Now deal with data record.
 245     * Part of it may have already been transferred, and we
 246     * may not have enough room to transfer the whole this time.
 247     */
 248    if (rec->remainder > 0) {
 249       /* Write as much of data as possible */
 250       if (remlen >= rec->remainder) {
 251          memcpy(block->bufp, rec->data+rec->data_len-rec->remainder,
 252                 rec->remainder);
 253          block->bufp += rec->remainder;
 254          block->binbuf += rec->remainder;
 255       } else {
 256          memcpy(block->bufp, rec->data+rec->data_len-rec->remainder,
 257                 remlen);
 258          if (!sm_check_rtn(__FILE__, __LINE__, False)) {
 259             /* We damaged a buffer */
 260             Dmsg6(0, "Damaged block FI=%s SessId=%d Strm=%s len=%d\n\
 261 rem=%d remainder=%d\n",
 262                FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 263                stream_to_ascii(rec->Stream), rec->data_len,
 264                remlen, rec->remainder);
 265             Dmsg5(0, "Damaged block: bufp=%x binbuf=%d buf_len=%d rem=%d moved=%d\n",
 266                block->bufp, block->binbuf, block->buf_len, block->buf_len-block->binbuf,
 267                remlen);
 268             Dmsg2(0, "Damaged block: buf=%x binbuffrombuf=%d \n",
 269                block->buf, block->bufp-block->buf);
 270
 271                Emsg0(M_ABORT, 0, "Damaged buffer\n");
 272          }
 273
 274          block->bufp += remlen;
 275          block->binbuf += remlen;
 276          rec->remainder -= remlen;
 277          return 0;                    /* did partial transfer */
 278       }
 279    }
 280    rec->remainder = 0;                /* did whole transfer */
 281    sm_check(__FILE__, __LINE__, False);
 282    return 1;
 283 }
 284
 285
 286 /*
 287  * Read a Record from the block
 288  *  Returns: 0 on failure
 289  *           1 on success
 290  */
 291 int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
 292 {
 293    ser_declare;
 294    uint32_t remlen;
 295    uint32_t VolSessionId;
 296    uint32_t VolSessionTime;
 297    int32_t  FileIndex;
 298    int32_t  Stream;
 299    uint32_t data_bytes;
 300
 301    remlen = block->binbuf;
 302
 303    /*
 304     * Get the header. There is always a full header,
 305     * otherwise we find it in the next block.
 306     */
 307    if (remlen >= RECHDR_LENGTH) {
 308       Dmsg3(90, "read_record_block: remlen=%d data_len=%d rem=%d\n",
 309             remlen, rec->data_len, rec->remainder);
 310
 311       unser_begin(block->bufp, RECHDR_LENGTH);
 312       unser_uint32(VolSessionId);
 313       unser_uint32(VolSessionTime);
 314       unser_int32(FileIndex);
 315       unser_int32(Stream);
 316       unser_uint32(data_bytes);
 317
 318       ASSERT(unser_length(block->bufp) == RECHDR_LENGTH);
 319       block->bufp += RECHDR_LENGTH;
 320       block->binbuf -= RECHDR_LENGTH;
 321       remlen -= RECHDR_LENGTH;
 322
 323       /*
 324        * if Stream is negative, it means that this is a continuation
 325        * of a previous partially written record.
 326        */
 327       if (Stream < 0) {               /* continuation record? */
 328          Dmsg1(500, "Got negative Stream => continuation. remainder=%d\n",
 329             rec->remainder);
 330          if (!rec->remainder) {       /* if we didn't read previously */
 331             rec->data_len = 0;        /* return data as if no continuation */
 332          } else if (rec->VolSessionId != VolSessionId ||
 333                     rec->VolSessionTime != VolSessionTime ||
 334                     rec->Stream != -Stream) {
 335             return 0;                 /* This is from some other Session */
 336          }
 337          rec->Stream = -Stream;       /* set correct Stream */
 338       } else {                        /* Regular record */
 339          rec->Stream = Stream;
 340          rec->data_len = 0;           /* transfer to beginning of data */
 341       }
 342       rec->VolSessionId = VolSessionId;
 343       rec->VolSessionTime = VolSessionTime;
 344       rec->FileIndex = FileIndex;
 345
 346       Dmsg6(90, "rd_rec_blk() got FI=%s SessId=%d Strm=%s len=%d\n\
 347 remlen=%d data_len=%d\n",
 348          FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 349          stream_to_ascii(rec->Stream), data_bytes, remlen, rec->data_len);
 350    } else {
 351       /*
 352        * No more records in this block because the number
 353        * of remaining bytes are less than a record header
 354        * length, so return empty handed, but indicate that
 355        * he must read again. By returning, we allow the
 356        * higher level routine to fetch the next block and
 357        * then reread.
 358        */
 359       Dmsg0(90, "read_record_block: nothing\n");
 360       if (!rec->remainder) {
 361          rec->remainder = 1;          /* set to expect continuation */
 362          rec->data_len = 0;           /* no data transferred */
 363       }
 364       return 0;
 365    }
 366
 367    ASSERT(data_bytes < MAX_BLOCK_LENGTH);       /* temp sanity check */
 368
 369    rec->data = check_pool_memory_size(rec->data, rec->data_len+data_bytes);
 370
 371    /*
 372     * At this point, we have read the header, now we
 373     * must transfer as much of the data record as
 374     * possible taking into account: 1. A partial
 375     * data record may have previously been transferred,
 376     * 2. The current block may not contain the whole data
 377     * record.
 378     */
 379    if (remlen >= data_bytes) {
 380       /* Got whole record */
 381       memcpy(rec->data+rec->data_len, block->bufp, data_bytes);
 382       block->bufp += data_bytes;
 383       block->binbuf -= data_bytes;
 384       rec->data_len += data_bytes;
 385    } else {
 386       /* Partial record */
 387       memcpy(rec->data+rec->data_len, block->bufp, remlen);
 388       block->bufp += remlen;
 389       block->binbuf -= remlen;
 390       rec->data_len += remlen;
 391       rec->remainder = 1;             /* partial record transferred */
 392       Dmsg1(90, "read_record_block: partial xfered=%d\n", rec->data_len);
 393       return 0;
 394    }
 395    rec->remainder = 0;
 396    Dmsg4(90, "Rtn full rd_rec_blk FI=%s SessId=%d Strm=%s len=%d\n",
 397       FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 398       stream_to_ascii(rec->Stream), rec->data_len);
 399    return 1;                          /* transferred full record */
 400 }