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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Record, and label definitions for Bacula
  30  *  media data format.
  31  *
  32  *   Kern Sibbald, MM
  33  *
  34  *   Version $Id$
  35  *
  36  */
  37
  38
  39 #ifndef __RECORD_H
  40 #define __RECORD_H 1
  41
  42 /* Return codes from read_device_volume_label() */
  43 enum {
  44    VOL_NOT_READ = 1,                      /* Volume label not read */
  45    VOL_OK,                                /* volume name OK */
  46    VOL_NO_LABEL,                          /* volume not labeled */
  47    VOL_IO_ERROR,                          /* volume I/O error */
  48    VOL_NAME_ERROR,                        /* Volume name mismatch */
  49    VOL_CREATE_ERROR,                      /* Error creating label */
  50    VOL_VERSION_ERROR,                     /* Bacula version error */
  51    VOL_LABEL_ERROR,                       /* Bad label type */
  52    VOL_NO_MEDIA                           /* Hard error -- no media present */
  53 };
  54
  55
  56 /*  See block.h for RECHDR_LENGTH */
  57
  58 /*
  59  * This is the Media structure for a record header.
  60  *  NB: when it is written it is serialized.
  61
  62    uint32_t VolSessionId;
  63    uint32_t VolSessionTime;
  64
  65  * The above 8 bytes are only written in a BB01 block, BB02
  66  *  and later blocks contain these values in the block header
  67  *  rather than the record header.
  68
  69    int32_t  FileIndex;
  70    int32_t  Stream;
  71    uint32_t data_len;
  72
  73  */
  74
  75 /* Record state bit definitions */
  76 #define REC_NO_HEADER        (1<<0)   /* No header read */
  77 #define REC_PARTIAL_RECORD   (1<<1)   /* returning partial record */
  78 #define REC_BLOCK_EMPTY      (1<<2)   /* not enough data in block */
  79 #define REC_NO_MATCH         (1<<3)   /* No match on continuation data */
  80 #define REC_CONTINUATION     (1<<4)   /* Continuation record found */
  81 #define REC_ISTAPE           (1<<5)   /* Set if device is tape */
  82
  83 #define is_partial_record(r) ((r)->state & REC_PARTIAL_RECORD)
  84 #define is_block_empty(r)    ((r)->state & REC_BLOCK_EMPTY)
  85
  86 /*
  87  * DEV_RECORD for reading and writing records.
  88  * It consists of a Record Header, and the Record Data
  89  *
  90  *  This is the memory structure for the record header.
  91  */
  92 struct BSR;                           /* satisfy forward reference */
  93 struct DEV_RECORD {
  94    dlink link;                        /* link for chaining in read_record.c */
  95    /* File and Block are always returned during reading
  96     *  and writing records.
  97     */
  98    uint32_t File;                     /* File number */
  99    uint32_t Block;                    /* Block number */
 100    uint32_t VolSessionId;             /* sequential id within this session */
 101    uint32_t VolSessionTime;           /* session start time */
 102    int32_t  FileIndex;                /* sequential file number */
 103    int32_t  Stream;                   /* stream number */
 104    uint32_t data_len;                 /* current record length */
 105    uint32_t remainder;                /* remaining bytes to read/write */
 106    uint32_t state;                    /* state bits */
 107    BSR *bsr;                          /* pointer to bsr that matched */
 108    uint8_t  ser_buf[WRITE_RECHDR_LENGTH];   /* serialized record header goes here */
 109    POOLMEM *data;                     /* Record data. This MUST be a memory pool item */
 110    int32_t match_stat;                /* bsr match status */
 111    uint32_t last_VolSessionId;        /* used in sequencing FI for Vbackup */
 112    uint32_t last_VolSessionTime;
 113    int32_t  last_FileIndex;
 114 };
 115
 116
 117 /*
 118  * Values for LabelType that are put into the FileIndex field
 119  * Note, these values are negative to distinguish them
 120  * from user records where the FileIndex is forced positive.
 121  */
 122 #define PRE_LABEL   -1                /* Vol label on unwritten tape */
 123 #define VOL_LABEL   -2                /* Volume label first file */
 124 #define EOM_LABEL   -3                /* Writen at end of tape */
 125 #define SOS_LABEL   -4                /* Start of Session */
 126 #define EOS_LABEL   -5                /* End of Session */
 127 #define EOT_LABEL   -6                /* End of physical tape (2 eofs) */
 128 #define SOB_LABEL   -7                /* Start of object -- file/directory */
 129 #define EOB_LABEL   -8                /* End of object (after all streams) */
 130
 131 /*
 132  *   Volume Label Record.  This is the in-memory definition. The
 133  *     tape definition is defined in the serialization code itself
 134  *     ser_volume_label() and unser_volume_label() and is slightly different.
 135  */
 136
 137
 138 struct Volume_Label {
 139   /*
 140    * The first items in this structure are saved
 141    * in the DEVICE buffer, but are not actually written
 142    * to the tape.
 143    */
 144   int32_t LabelType;                  /* This is written in header only */
 145   uint32_t LabelSize;                 /* length of serialized label */
 146   /*
 147    * The items below this line are stored on
 148    * the tape
 149    */
 150   char Id[32];                        /* Bacula Immortal ... */
 151
 152   uint32_t VerNum;                    /* Label version number */
 153
 154   /* VerNum <= 10 */
 155   float64_t label_date;               /* Date tape labeled */
 156   float64_t label_time;               /* Time tape labeled */
 157
 158   /* VerNum >= 11 */
 159   btime_t   label_btime;              /* tdate tape labeled */
 160   btime_t   write_btime;              /* tdate tape written */
 161
 162   /* Unused with VerNum >= 11 */
 163   float64_t write_date;               /* Date this label written */
 164   float64_t write_time;               /* Time this label written */
 165
 166   char VolumeName[MAX_NAME_LENGTH];   /* Volume name */
 167   char PrevVolumeName[MAX_NAME_LENGTH]; /* Previous Volume Name */
 168   char PoolName[MAX_NAME_LENGTH];     /* Pool name */
 169   char PoolType[MAX_NAME_LENGTH];     /* Pool type */
 170   char MediaType[MAX_NAME_LENGTH];    /* Type of this media */
 171
 172   char HostName[MAX_NAME_LENGTH];     /* Host name of writing computer */
 173   char LabelProg[50];                 /* Label program name */
 174   char ProgVersion[50];               /* Program version */
 175   char ProgDate[50];                  /* Program build date/time */
 176 };
 177
 178 #define SER_LENGTH_Volume_Label 1024   /* max serialised length of volume label */
 179 #define SER_LENGTH_Session_Label 1024  /* max serialised length of session label */
 180
 181 typedef struct Volume_Label VOLUME_LABEL;
 182
 183 /*
 184  * Session Start/End Label
 185  *  This record is at the beginning and end of each session
 186  */
 187 struct Session_Label {
 188   char Id[32];                        /* Bacula Immortal ... */
 189
 190   uint32_t VerNum;                    /* Label version number */
 191
 192   uint32_t JobId;                     /* Job id */
 193   uint32_t VolumeIndex;               /* Sequence no of volume for this job */
 194
 195   /* VerNum >= 11 */
 196   btime_t   write_btime;              /* Tdate this label written */
 197
 198   /* VerNum < 11 */
 199   float64_t write_date;               /* Date this label written */
 200
 201   /* Unused VerNum >= 11 */
 202   float64_t write_time;               /* Time this label written */
 203
 204   char PoolName[MAX_NAME_LENGTH];     /* Pool name */
 205   char PoolType[MAX_NAME_LENGTH];     /* Pool type */
 206   char JobName[MAX_NAME_LENGTH];      /* base Job name */
 207   char ClientName[MAX_NAME_LENGTH];
 208   char Job[MAX_NAME_LENGTH];          /* Unique name of this Job */
 209   char FileSetName[MAX_NAME_LENGTH];
 210   char FileSetMD5[MAX_NAME_LENGTH];
 211   uint32_t JobType;
 212   uint32_t JobLevel;
 213   /* The remainder are part of EOS label only */
 214   uint32_t JobFiles;
 215   uint64_t JobBytes;
 216   uint32_t StartBlock;
 217   uint32_t EndBlock;
 218   uint32_t StartFile;
 219   uint32_t EndFile;
 220   uint32_t JobErrors;
 221   uint32_t JobStatus;                 /* Job status */
 222
 223 };
 224 typedef struct Session_Label SESSION_LABEL;
 225
 226 #define SERIAL_BUFSIZE  1024          /* volume serialisation buffer size */
 227
 228 #endif