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

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