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

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