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 /*
 118  * Write a Record to the block
 119  *
 120  *  Returns: 0 on failure (none or partially written)
 121  *           1 on success (all bytes written)
 122  *
 123  *  and remainder returned in packet.
 124  *
 125  *  We require enough room for the header, and we deal with
 126  *  two special cases. 1. Only part of the record may have
 127  *  been transferred the last time (when remainder is
 128  *  non-zero), and 2. The remaining bytes to write may not
 129  *  all fit into the block.
 130  */
 131 int write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
 132 {
 133    ser_declare;
 134    uint32_t remlen;
 135
 136    sm_check(__FILE__, __LINE__, False);
 137    remlen = block->buf_len - block->binbuf;
 138
 139    ASSERT(block->binbuf == (uint32_t) (block->bufp - block->buf));
 140    ASSERT(remlen >= 0);
 141
 142    Dmsg6(190, "write_record_to_block() FI=%s SessId=%d Strm=%s len=%d\n\
 143 rem=%d remainder=%d\n",
 144       FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 145       stream_to_ascii(rec->Stream), rec->data_len,
 146       remlen, rec->remainder);
 147
 148    /*
 149     * If rec->remainder is non-zero, we have been called a
 150     *  second (or subsequent) time to finish writing a record
 151     *  that did not previously fit into the block.
 152     */
 153    if (rec->remainder == 0) {
 154       /* Require enough room to write a full header */
 155       if (remlen >= RECHDR_LENGTH) {
 156          ser_begin(block->bufp, RECHDR_LENGTH);
 157          ser_uint32(rec->VolSessionId);
 158          ser_uint32(rec->VolSessionTime);
 159          ser_int32(rec->FileIndex);
 160          ser_int32(rec->Stream);
 161          ser_uint32(rec->data_len);
 162          ASSERT(ser_length(block->bufp) == RECHDR_LENGTH);
 163
 164          block->bufp += RECHDR_LENGTH;
 165          block->binbuf += RECHDR_LENGTH;
 166          remlen -= RECHDR_LENGTH;
 167          rec->remainder = rec->data_len;
 168       } else {
 169          rec->remainder = rec->data_len + RECHDR_LENGTH;
 170          sm_check(__FILE__, __LINE__, False);
 171          return 0;
 172       }
 173    } else {
 174       /*
 175        * We are here to write unwritten bytes from a previous
 176        * time. Presumably we have a new buffer (possibly
 177        * containing a volume label), so the new header
 178        * should be able to fit in the block -- otherwise we have
 179        * an error.  Note, we may have to continue splitting the
 180        * data record though.
 181        *
 182        * First, write the header, then write as much as
 183        * possible of the data record.
 184        *
 185        * Every time we write a header and it is a continuation
 186        * of a previous partially written record, we store the
 187        * Stream as -Stream in the record header.
 188        */
 189       ser_begin(block->bufp, RECHDR_LENGTH);
 190       ser_uint32(rec->VolSessionId);
 191       ser_uint32(rec->VolSessionTime);
 192       ser_int32(rec->FileIndex);
 193       if (rec->remainder > rec->data_len) {
 194          ser_int32(rec->Stream);      /* normal full header */
 195          ser_uint32(rec->data_len);
 196          rec->remainder = rec->data_len; /* must still do data record */
 197       } else {
 198          ser_int32(-rec->Stream);     /* mark this as a continuation record */
 199          ser_uint32(rec->remainder);  /* bytes to do */
 200       }
 201       ASSERT(ser_length(block->bufp) == RECHDR_LENGTH);
 202
 203       /* Require enough room to write a full header */
 204       ASSERT(remlen >= RECHDR_LENGTH);
 205
 206       block->bufp += RECHDR_LENGTH;
 207       block->binbuf += RECHDR_LENGTH;
 208       remlen -= RECHDR_LENGTH;
 209    }
 210    if (remlen == 0) {
 211       sm_check(__FILE__, __LINE__, False);
 212       return 0;                       /* partial transfer */
 213    }
 214
 215    /*
 216     * Now deal with data record.
 217     * Part of it may have already been transferred, and we
 218     * may not have enough room to transfer the whole this time.
 219     */
 220    if (rec->remainder > 0) {
 221       /* Write as much of data as possible */
 222       if (remlen >= rec->remainder) {
 223          memcpy(block->bufp, rec->data+rec->data_len-rec->remainder,
 224                 rec->remainder);
 225          block->bufp += rec->remainder;
 226          block->binbuf += rec->remainder;
 227       } else {
 228          memcpy(block->bufp, rec->data+rec->data_len-rec->remainder,
 229                 remlen);
 230          if (!sm_check_rtn(__FILE__, __LINE__, False)) {
 231             /* We damaged a buffer */
 232             Dmsg6(0, "Damaged block FI=%s SessId=%d Strm=%s len=%d\n\
 233 rem=%d remainder=%d\n",
 234                FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 235                stream_to_ascii(rec->Stream), rec->data_len,
 236                remlen, rec->remainder);
 237             Dmsg5(0, "Damaged block: bufp=%x binbuf=%d buf_len=%d rem=%d moved=%d\n",
 238                block->bufp, block->binbuf, block->buf_len, block->buf_len-block->binbuf,
 239                remlen);
 240             Dmsg2(0, "Damaged block: buf=%x binbuffrombuf=%d \n",
 241                block->buf, block->bufp-block->buf);
 242
 243                Emsg0(M_ABORT, 0, "Damaged buffer\n");
 244          }
 245
 246          block->bufp += remlen;
 247          block->binbuf += remlen;
 248          rec->remainder -= remlen;
 249          return 0;                    /* did partial transfer */
 250       }
 251    }
 252    rec->remainder = 0;                /* did whole transfer */
 253    sm_check(__FILE__, __LINE__, False);
 254    return 1;
 255 }
 256
 257
 258 /*
 259  * Test if we can write whole record to the block
 260  *
 261  *  Returns: 0 on failure
 262  *           1 on success (all bytes can be written)
 263  */
 264 int can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
 265 {
 266    uint32_t remlen;
 267
 268    remlen = block->buf_len - block->binbuf;
 269    if (rec->remainder == 0) {
 270       if (remlen >= RECHDR_LENGTH) {
 271          remlen -= RECHDR_LENGTH;
 272          rec->remainder = rec->data_len;
 273       } else {
 274          return 0;
 275       }
 276    } else {
 277       return 0;
 278    }
 279    if (rec->remainder > 0 && remlen < rec->remainder) {
 280       return 0;
 281    }
 282    return 1;
 283 }
 284
 285
 286 /*
 287  * Read a Record from the block
 288  *  Returns: 0 if nothing read or if the continuation record does not match.
 289  *             In both of these cases, a block read must be done.
 290  *           1 if at least the record header was read, this
 291  *             routine may have to be called again with a new
 292  *             block if the entire record was not read.
 293  */
 294 int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
 295 {
 296    ser_declare;
 297    uint32_t remlen;
 298    uint32_t VolSessionId;
 299    uint32_t VolSessionTime;
 300    int32_t  FileIndex;
 301    int32_t  Stream;
 302    uint32_t data_bytes;
 303
 304    remlen = block->binbuf;
 305
 306    /* Clear state flags */
 307    rec->state = 0;
 308
 309    /*
 310     * Get the header. There is always a full header,
 311     * otherwise we find it in the next block.
 312     */
 313    if (remlen >= RECHDR_LENGTH) {
 314       Dmsg3(90, "read_record_block: remlen=%d data_len=%d rem=%d\n",
 315             remlen, rec->data_len, rec->remainder);
 316
 317       unser_begin(block->bufp, RECHDR_LENGTH);
 318       unser_uint32(VolSessionId);
 319       unser_uint32(VolSessionTime);
 320       unser_int32(FileIndex);
 321       unser_int32(Stream);
 322       unser_uint32(data_bytes);
 323
 324       ASSERT(unser_length(block->bufp) == RECHDR_LENGTH);
 325       block->bufp += RECHDR_LENGTH;
 326       block->binbuf -= RECHDR_LENGTH;
 327       remlen -= RECHDR_LENGTH;
 328
 329       /*
 330        * if Stream is negative, it means that this is a continuation
 331        * of a previous partially written record.
 332        */
 333       if (Stream < 0) {               /* continuation record? */
 334          Dmsg1(500, "Got negative Stream => continuation. remainder=%d\n",
 335             rec->remainder);
 336          rec->state |= REC_CONTINUATION;
 337          if (!rec->remainder) {       /* if we didn't read previously */
 338             rec->data_len = 0;        /* return data as if no continuation */
 339          } else if (rec->VolSessionId != VolSessionId ||
 340                     rec->VolSessionTime != VolSessionTime ||
 341                     rec->Stream != -Stream) {
 342             rec->state |= REC_NO_MATCH;
 343             return 0;                 /* This is from some other Session */
 344          }
 345          rec->Stream = -Stream;       /* set correct Stream */
 346       } else {                        /* Regular record */
 347          rec->Stream = Stream;
 348          rec->data_len = 0;           /* transfer to beginning of data */
 349       }
 350       rec->VolSessionId = VolSessionId;
 351       rec->VolSessionTime = VolSessionTime;
 352       rec->FileIndex = FileIndex;
 353
 354       Dmsg6(90, "rd_rec_blk() got FI=%s SessId=%d Strm=%s len=%d\n\
 355 remlen=%d data_len=%d\n",
 356          FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 357          stream_to_ascii(rec->Stream), data_bytes, remlen, rec->data_len);
 358    } else {
 359       /*
 360        * No more records in this block because the number
 361        * of remaining bytes are less than a record header
 362        * length, so return empty handed, but indicate that
 363        * he must read again. By returning, we allow the
 364        * higher level routine to fetch the next block and
 365        * then reread.
 366        */
 367       Dmsg0(90, "read_record_block: nothing\n");
 368       if (!rec->remainder) {
 369          rec->remainder = 1;          /* set to expect continuation */
 370          rec->data_len = 0;           /* no data transferred */
 371       }
 372       rec->state |= (REC_NO_HEADER | REC_BLOCK_EMPTY);
 373       return 0;
 374    }
 375
 376    ASSERT(data_bytes < MAX_BLOCK_LENGTH);       /* temp sanity check */
 377
 378    rec->data = check_pool_memory_size(rec->data, rec->data_len+data_bytes);
 379
 380    /*
 381     * At this point, we have read the header, now we
 382     * must transfer as much of the data record as
 383     * possible taking into account: 1. A partial
 384     * data record may have previously been transferred,
 385     * 2. The current block may not contain the whole data
 386     * record.
 387     */
 388    if (remlen >= data_bytes) {
 389       /* Got whole record */
 390       memcpy(rec->data+rec->data_len, block->bufp, data_bytes);
 391       block->bufp += data_bytes;
 392       block->binbuf -= data_bytes;
 393       rec->data_len += data_bytes;
 394    } else {
 395       /* Partial record */
 396       memcpy(rec->data+rec->data_len, block->bufp, remlen);
 397       block->bufp += remlen;
 398       block->binbuf -= remlen;
 399       rec->data_len += remlen;
 400       rec->remainder = 1;             /* partial record transferred */
 401       Dmsg1(90, "read_record_block: partial xfered=%d\n", rec->data_len);
 402       rec->state |= (REC_PARTIAL_RECORD | REC_BLOCK_EMPTY);
 403       return 1;
 404    }
 405    rec->remainder = 0;
 406    Dmsg4(90, "Rtn full rd_rec_blk FI=%s SessId=%d Strm=%s len=%d\n",
 407       FI_to_ascii(rec->FileIndex), rec->VolSessionId,
 408       stream_to_ascii(rec->Stream), rec->data_len);
 409    return 1;                          /* transferred full record */
 410 }