]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/stored/record.c
- Tweak install chapter of French manual to add new paragraph
[bacula/bacula] / bacula / src / stored / record.c
index 991cc7ad9c062b703a32d8c9f6729fe2dd40a9f3..d3bb44eab6c35b45128c9ffb28bea864a7e15d52 100644 (file)
@@ -3,12 +3,13 @@
  *   record.c -- tape record handling functions
  *
  *             Kern Sibbald, April MMI
+ *               added BB02 format October MMII
  *
  *   Version $Id$
  *
  */
 /*
-   Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+   Copyright (C) 2000-2004 Kern Sibbald and John Walker
 
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
@@ -40,7 +41,7 @@ extern int debug_level;
  *   record as a Label, otherwise it is simply
  *   the FileIndex of the current file.
  */
-char *FI_to_ascii(int fi)
+const char *FI_to_ascii(int fi)
 {
    static char buf[20];
    if (fi >= 0) {
@@ -58,6 +59,9 @@ char *FI_to_ascii(int fi)
       return "SOS_LABEL";
    case EOS_LABEL:
       return "EOS_LABEL";
+   case EOT_LABEL:
+      return "EOT_LABEL";
+      break;
    default:
      sprintf(buf, "unknown: %d", fi);
      return buf;
@@ -68,19 +72,70 @@ char *FI_to_ascii(int fi)
 /* 
  * Convert a Stream ID into a printable
  * ASCII string.  Not reentrant.
+
+ * A negative stream number represents
+ *   stream data that is continued from a
+ *   record in the previous block.
+ * If the FileIndex is negative, we are
+ *   dealing with a Label, hence the
+ *   stream is the JobId.
  */
-char *stream_to_ascii(int stream)
+const char *stream_to_ascii(int stream, int fi)
 {
     static char buf[20];
+    if (fi < 0) {
+       sprintf(buf, "%d", stream);
+       return buf;     
+    }
     switch (stream) {
     case STREAM_UNIX_ATTRIBUTES:
        return "UATTR";
     case STREAM_FILE_DATA:
        return "DATA";
+    case STREAM_WIN32_DATA:
+       return "WIN32-DATA";
+    case STREAM_WIN32_GZIP_DATA:
+       return "WIN32-GZIP";
     case STREAM_MD5_SIGNATURE:
        return "MD5";
+    case STREAM_SHA1_SIGNATURE:
+       return "SHA1";
     case STREAM_GZIP_DATA:
        return "GZIP";
+    case STREAM_UNIX_ATTRIBUTES_EX:
+       return "UNIX-ATTR-EX";
+    case STREAM_SPARSE_DATA:
+       return "SPARSE-DATA";
+    case STREAM_SPARSE_GZIP_DATA:
+       return "SPARSE-GZIP";
+    case STREAM_PROGRAM_NAMES:
+       return "PROG-NAMES";
+    case STREAM_PROGRAM_DATA:
+       return "PROG-DATA";
+    case -STREAM_UNIX_ATTRIBUTES:
+       return "contUATTR";
+    case -STREAM_FILE_DATA:
+       return "contDATA";
+    case -STREAM_WIN32_DATA:
+       return "contWIN32-DATA";
+    case -STREAM_WIN32_GZIP_DATA:
+       return "contWIN32-GZIP";
+    case -STREAM_MD5_SIGNATURE:
+       return "contMD5";
+    case -STREAM_SHA1_SIGNATURE:
+       return "contSHA1";
+    case -STREAM_GZIP_DATA:
+       return "contGZIP";
+    case -STREAM_UNIX_ATTRIBUTES_EX:
+       return "contUNIX-ATTR-EX";
+    case -STREAM_SPARSE_DATA:
+       return "contSPARSE-DATA";
+    case -STREAM_SPARSE_GZIP_DATA:
+       return "contSPARSE-GZIP";
+    case -STREAM_PROGRAM_NAMES:
+       return "contPROG-NAMES";
+    case -STREAM_PROGRAM_DATA:
+       return "contPROG-DATA";
     default:
        sprintf(buf, "%d", stream);
        return buf;     
@@ -94,12 +149,21 @@ DEV_RECORD *new_record(void)
 {
    DEV_RECORD *rec;
 
-   rec = (DEV_RECORD *) get_memory(sizeof(DEV_RECORD));
+   rec = (DEV_RECORD *)get_memory(sizeof(DEV_RECORD));
    memset(rec, 0, sizeof(DEV_RECORD));
    rec->data = get_pool_memory(PM_MESSAGE);
    return rec;
 }
 
+void empty_record(DEV_RECORD *rec)
+{
+   rec->File = rec->Block = 0;
+   rec->VolSessionId = rec->VolSessionTime = 0;
+   rec->FileIndex = rec->Stream = 0;
+   rec->data_len = rec->remainder = 0;
+   rec->state &= ~(REC_PARTIAL_RECORD|REC_BLOCK_EMPTY|REC_NO_MATCH|REC_CONTINUATION);
+}
+
 /*
  * Free the record entity 
  *
@@ -119,8 +183,8 @@ void free_record(DEV_RECORD *rec)
 /*
  * Write a Record to the block
  *
- *  Returns: 0 on failure (none or partially written)
- *          1 on success (all bytes written)
+ *  Returns: false on failure (none or partially written)
+ *          true  on success (all bytes written)
  *
  *  and remainder returned in packet.
  *
@@ -130,21 +194,20 @@ void free_record(DEV_RECORD *rec)
  *  non-zero), and 2. The remaining bytes to write may not
  *  all fit into the block.
  */
-int write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
+bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
 {
    ser_declare;
    uint32_t remlen;
 
-   sm_check(__FILE__, __LINE__, False);
    remlen = block->buf_len - block->binbuf;
 
    ASSERT(block->binbuf == (uint32_t) (block->bufp - block->buf));
-   ASSERT(remlen >= 0);
+   ASSERT(block->buf_len >= block->binbuf);
 
    Dmsg6(190, "write_record_to_block() FI=%s SessId=%d Strm=%s len=%d\n\
 rem=%d remainder=%d\n",
       FI_to_ascii(rec->FileIndex), rec->VolSessionId, 
-      stream_to_ascii(rec->Stream), rec->data_len,
+      stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len,
       remlen, rec->remainder);
 
    /*
@@ -157,8 +220,8 @@ rem=%d remainder=%d\n",
       if (remlen >= WRITE_RECHDR_LENGTH) {
         ser_begin(block->bufp, WRITE_RECHDR_LENGTH);
         if (BLOCK_VER == 1) {
-        ser_uint32(rec->VolSessionId);
-        ser_uint32(rec->VolSessionTime);
+           ser_uint32(rec->VolSessionId);
+           ser_uint32(rec->VolSessionTime);
         } else {
            block->VolSessionId = rec->VolSessionId;
            block->VolSessionTime = rec->VolSessionTime;
@@ -171,10 +234,16 @@ rem=%d remainder=%d\n",
         block->binbuf += WRITE_RECHDR_LENGTH;
         remlen -= WRITE_RECHDR_LENGTH;
         rec->remainder = rec->data_len;
+        if (rec->FileIndex > 0) {
+           /* If data record, update what we have in this block */
+           if (block->FirstIndex == 0) {
+              block->FirstIndex = rec->FileIndex;
+           }
+           block->LastIndex = rec->FileIndex;
+        }
       } else {
         rec->remainder = rec->data_len + WRITE_RECHDR_LENGTH;
-        sm_check(__FILE__, __LINE__, False);
-        return 0;
+        return false;
       }
    } else {
       /* 
@@ -182,8 +251,8 @@ rem=%d remainder=%d\n",
        * time. Presumably we have a new buffer (possibly 
        * containing a volume label), so the new header 
        * should be able to fit in the block -- otherwise we have
-       * an error.  Note, we may have to continue splitting the
-       * data record though.
+       * an error.  Note, we have to continue splitting the
+       * data record if it is longer than the block.
        * 
        * First, write the header, then write as much as 
        * possible of the data record.
@@ -194,8 +263,8 @@ rem=%d remainder=%d\n",
        */
       ser_begin(block->bufp, WRITE_RECHDR_LENGTH);
       if (BLOCK_VER == 1) {
-      ser_uint32(rec->VolSessionId);
-      ser_uint32(rec->VolSessionTime);
+        ser_uint32(rec->VolSessionId);
+        ser_uint32(rec->VolSessionTime);
       } else {
         block->VolSessionId = rec->VolSessionId;
         block->VolSessionTime = rec->VolSessionTime;
@@ -216,10 +285,16 @@ rem=%d remainder=%d\n",
       block->bufp += WRITE_RECHDR_LENGTH;
       block->binbuf += WRITE_RECHDR_LENGTH;
       remlen -= WRITE_RECHDR_LENGTH;
+      if (rec->FileIndex > 0) {
+        /* If data record, update what we have in this block */
+        if (block->FirstIndex == 0) {
+           block->FirstIndex = rec->FileIndex;
+        }
+        block->LastIndex = rec->FileIndex;
+      }
    }
    if (remlen == 0) {
-      sm_check(__FILE__, __LINE__, False);
-      return 0;                      /* partial transfer */
+      return false;                  /* partial transfer */
    }
 
    /*
@@ -237,12 +312,13 @@ rem=%d remainder=%d\n",
       } else {
         memcpy(block->bufp, rec->data+rec->data_len-rec->remainder, 
                remlen);
+#ifdef xxxxxSMCHECK
         if (!sm_check_rtn(__FILE__, __LINE__, False)) {
            /* We damaged a buffer */
             Dmsg6(0, "Damaged block FI=%s SessId=%d Strm=%s len=%d\n\
 rem=%d remainder=%d\n",
               FI_to_ascii(rec->FileIndex), rec->VolSessionId, 
-              stream_to_ascii(rec->Stream), rec->data_len,
+              stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len,
               remlen, rec->remainder);
             Dmsg5(0, "Damaged block: bufp=%x binbuf=%d buf_len=%d rem=%d moved=%d\n",
               block->bufp, block->binbuf, block->buf_len, block->buf_len-block->binbuf,
@@ -252,26 +328,26 @@ rem=%d remainder=%d\n",
 
                Emsg0(M_ABORT, 0, "Damaged buffer\n");
         }
+#endif
 
         block->bufp += remlen;
         block->binbuf += remlen;
         rec->remainder -= remlen;
-        return 0;                    /* did partial transfer */
+        return false;                /* did partial transfer */
       }
    }
    rec->remainder = 0;               /* did whole transfer */
-   sm_check(__FILE__, __LINE__, False);
-   return 1;
+   return true;
 }
 
 
 /*
  * Test if we can write whole record to the block
  *
- *  Returns: 0 on failure 
- *          1 on success (all bytes can be written)
+ *  Returns: false on failure 
+ *          true  on success (all bytes can be written)
  */
-int can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
+bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
 {
    uint32_t remlen;
 
@@ -281,27 +357,27 @@ int can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec)
         remlen -= WRITE_RECHDR_LENGTH;
         rec->remainder = rec->data_len;
       } else {
-        return 0;
+        return false;
       }
    } else {
-      return 0;
+      return false;
    }
    if (rec->remainder > 0 && remlen < rec->remainder) {
-      return 0;
+      return false;
    }
-   return 1;
+   return true;
 }
 
 
 /*
  * Read a Record from the block
- *  Returns: 0 if nothing read or if the continuation record does not match.
- *            In both of these cases, a block read must be done.
- *          1 if at least the record header was read, this 
- *            routine may have to be called again with a new
- *            block if the entire record was not read.
+ *  Returns: false if nothing read or if the continuation record does not match.
+ *                In both of these cases, a block read must be done.
+ *          true  if at least the record header was read, this 
+ *                routine may have to be called again with a new
+ *                block if the entire record was not read.
  */
-int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
+bool read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
 {
    ser_declare;
    uint32_t remlen;
@@ -314,9 +390,14 @@ int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
 
    remlen = block->binbuf;
    rec->Block = block->BlockNumber;
+   rec->File = ((DEVICE *)block->dev)->file;
 
-   /* Clear state flags */
+   /* Clear state flags */      
    rec->state = 0;
+   if (((DEVICE *)block->dev)->state & ST_TAPE) {
+      rec->state |= REC_ISTAPE;
+   }
+
 
    /* 
     * Get the header. There is always a full header,
@@ -335,8 +416,8 @@ int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
 
       unser_begin(block->bufp, WRITE_RECHDR_LENGTH);
       if (block->BlockVer == 1) {
-      unser_uint32(VolSessionId);
-      unser_uint32(VolSessionTime);
+        unser_uint32(VolSessionId);
+        unser_uint32(VolSessionTime);
       } else {
         VolSessionId = block->VolSessionId;
         VolSessionTime = block->VolSessionTime;
@@ -355,7 +436,8 @@ int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
       if (rec->remainder && (rec->VolSessionId != VolSessionId || 
                             rec->VolSessionTime != VolSessionTime)) {
         rec->state |= REC_NO_MATCH;
-        return 0;                 /* This is from some other Session */
+         Dmsg0(500, "remainder and VolSession doesn't match\n");
+        return false;             /* This is from some other Session */
       }
 
       /* if Stream is negative, it means that this is a continuation
@@ -369,7 +451,7 @@ int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
            rec->data_len = 0;        /* return data as if no continuation */
         } else if (rec->Stream != -Stream) {
            rec->state |= REC_NO_MATCH;
-           return 0;                 /* This is from some other Session */
+           return false;             /* This is from some other Session */
         }
         rec->Stream = -Stream;       /* set correct Stream */
       } else {                       /* Regular record */
@@ -379,11 +461,18 @@ int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec)
       rec->VolSessionId = VolSessionId;
       rec->VolSessionTime = VolSessionTime;
       rec->FileIndex = FileIndex;
+      if (FileIndex > 0) {
+        if (block->FirstIndex == 0) {
+           block->FirstIndex = FileIndex;
+        }
+        block->LastIndex = FileIndex;
+      }
 
-      Dmsg6(100, "rd_rec_blk() got FI=%s SessId=%d Strm=%s len=%u\n\
-remlen=%d data_len=%d\n",
+      Dmsg6(100, "rd_rec_blk() got FI=%s SessId=%d Strm=%s len=%u\n"
+                 "remlen=%d data_len=%d\n",
         FI_to_ascii(rec->FileIndex), rec->VolSessionId, 
-        stream_to_ascii(rec->Stream), data_bytes, remlen, rec->data_len);
+        stream_to_ascii(rec->Stream, rec->FileIndex), data_bytes, remlen, 
+        rec->data_len);
    } else {
       /*    
        * No more records in this block because the number   
@@ -401,7 +490,8 @@ remlen=%d data_len=%d\n",
       }
 #endif
       rec->state |= (REC_NO_HEADER | REC_BLOCK_EMPTY);
-      return 0;
+      empty_block(block);                     /* mark block empty */
+      return false;
    }
 
    ASSERT(data_bytes < MAX_BLOCK_LENGTH);      /* temp sanity check */
@@ -436,6 +526,6 @@ remlen=%d data_len=%d\n",
    rec->remainder = 0;
    Dmsg4(90, "Rtn full rd_rec_blk FI=%s SessId=%d Strm=%s len=%d\n",
       FI_to_ascii(rec->FileIndex), rec->VolSessionId, 
-      stream_to_ascii(rec->Stream), rec->data_len);
-   return 1;                         /* transferred full record */
+      stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len);
+   return true;                      /* transferred full record */
 }