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

   1 /*
   2  * Definitions for using the Device functions in Bacula
   3  *  Tape and File storage access
   4  *
   5  *   Version $Id$
   6  *
   7  */
   8 /*
   9    Copyright (C) 2000-2004 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 __DEV_H
  30 #define __DEV_H 1
  31
  32 #undef DCR                            /* used by Bacula */
  33
  34 /* #define NEW_LOCK 1 */
  35
  36 #define new_lock_device(dev)             _new_lock_device(__FILE__, __LINE__, (dev))
  37 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
  38 #define new_unlock_device(dev)           _new_unlock_device(__FILE__, __LINE__, (dev))
  39
  40 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
  41 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
  42 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
  43 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
  44 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
  45 #define give_back_device_lock(d, p) _give_back_device_lock(__FILE__, __LINE__, (d), (p))
  46
  47 /* Arguments to open_dev() */
  48 enum {
  49    OPEN_READ_WRITE = 0,
  50    OPEN_READ_ONLY,
  51    OPEN_WRITE_ONLY
  52 };
  53
  54 /* Generic status bits returned from status_dev() */
  55 #define BMT_TAPE           (1<<0)     /* is tape device */
  56 #define BMT_EOF            (1<<1)     /* just read EOF */
  57 #define BMT_BOT            (1<<2)     /* at beginning of tape */
  58 #define BMT_EOT            (1<<3)     /* end of tape reached */
  59 #define BMT_SM             (1<<4)     /* DDS setmark */
  60 #define BMT_EOD            (1<<5)     /* DDS at end of data */
  61 #define BMT_WR_PROT        (1<<6)     /* tape write protected */
  62 #define BMT_ONLINE         (1<<7)     /* tape online */
  63 #define BMT_DR_OPEN        (1<<8)     /* tape door open */
  64 #define BMT_IM_REP_EN      (1<<9)     /* immediate report enabled */
  65
  66
  67 /* Test capabilities */
  68 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
  69
  70 /* Bits for device capabilities */
  71 #define CAP_EOF            (1<<0)     /* has MTWEOF */
  72 #define CAP_BSR            (1<<1)     /* has MTBSR */
  73 #define CAP_BSF            (1<<2)     /* has MTBSF */
  74 #define CAP_FSR            (1<<3)     /* has MTFSR */
  75 #define CAP_FSF            (1<<4)     /* has MTFSF */
  76 #define CAP_EOM            (1<<5)     /* has MTEOM */
  77 #define CAP_REM            (1<<6)     /* is removable media */
  78 #define CAP_RACCESS        (1<<7)     /* is random access device */
  79 #define CAP_AUTOMOUNT      (1<<8)     /* Read device at start to see what is there */
  80 #define CAP_LABEL          (1<<9)     /* Label blank tapes */
  81 #define CAP_ANONVOLS       (1<<10)    /* Mount without knowing volume name */
  82 #define CAP_ALWAYSOPEN     (1<<11)    /* always keep device open */
  83 #define CAP_AUTOCHANGER    (1<<12)    /* AutoChanger */
  84 #define CAP_OFFLINEUNMOUNT (1<<13)    /* Offline before unmount */
  85 #define CAP_STREAM         (1<<14)    /* Stream device */
  86 #define CAP_BSFATEOM       (1<<15)    /* Backspace file at EOM */
  87 #define CAP_FASTFSF        (1<<16)    /* Fast forward space file */
  88 #define CAP_TWOEOF         (1<<17)    /* Write two eofs for EOM */
  89 #define CAP_CLOSEONPOLL    (1<<18)    /* Close device on polling */
  90
  91 /* Test state */
  92 #define dev_state(dev, st_state) ((dev)->state & (st_state))
  93
  94 /* Device state bits */
  95 #define ST_OPENED          (1<<0)     /* set when device opened */
  96 #define ST_TAPE            (1<<1)     /* is a tape device */
  97 #define ST_FILE            (1<<2)     /* is a file device */
  98 #define ST_FIFO            (1<<3)     /* is a fifo device */
  99 #define ST_PROG            (1<<4)     /* is a program device */
 100 #define ST_LABEL           (1<<5)     /* label found */
 101 #define ST_MALLOC          (1<<6)     /* dev packet malloc'ed in init_dev() */
 102 #define ST_APPEND          (1<<7)     /* ready for Bacula append */
 103 #define ST_READ            (1<<8)     /* ready for Bacula read */
 104 #define ST_EOT             (1<<9)     /* at end of tape */
 105 #define ST_WEOT            (1<<10)    /* Got EOT on write */
 106 #define ST_EOF             (1<<11)    /* Read EOF i.e. zero bytes */
 107 #define ST_NEXTVOL         (1<<12)    /* Start writing on next volume */
 108 #define ST_SHORT           (1<<13)    /* Short block read */
 109
 110 /* dev_blocked states (mutually exclusive) */
 111 enum {
 112    BST_NOT_BLOCKED = 0,               /* not blocked */
 113    BST_UNMOUNTED,                     /* User unmounted device */
 114    BST_WAITING_FOR_SYSOP,             /* Waiting for operator to mount tape */
 115    BST_DOING_ACQUIRE,                 /* Opening/validating/moving tape */
 116    BST_WRITING_LABEL,                  /* Labeling a tape */
 117    BST_UNMOUNTED_WAITING_FOR_SYSOP,    /* Closed by user during mount request */
 118    BST_MOUNT                           /* Mount request */
 119 };
 120
 121 /* Volume Catalog Information structure definition */
 122 struct VOLUME_CAT_INFO {
 123    /* Media info for the current Volume */
 124    uint32_t VolCatJobs;               /* number of jobs on this Volume */
 125    uint32_t VolCatFiles;              /* Number of files */
 126    uint32_t VolCatBlocks;             /* Number of blocks */
 127    uint64_t VolCatBytes;              /* Number of bytes written */
 128    uint32_t VolCatMounts;             /* Number of mounts this volume */
 129    uint32_t VolCatErrors;             /* Number of errors this volume */
 130    uint32_t VolCatWrites;             /* Number of writes this volume */
 131    uint32_t VolCatReads;              /* Number of reads this volume */
 132    uint64_t VolCatRBytes;             /* Number of bytes read */
 133    uint32_t VolCatRecycles;           /* Number of recycles this volume */
 134    int32_t  Slot;                     /* Slot in changer */
 135    bool     InChanger;                /* Set if vol in current magazine */
 136    uint32_t VolCatMaxJobs;            /* Maximum Jobs to write to volume */
 137    uint32_t VolCatMaxFiles;           /* Maximum files to write to volume */
 138    uint64_t VolCatMaxBytes;           /* Max bytes to write to volume */
 139    uint64_t VolCatCapacityBytes;      /* capacity estimate */
 140    uint64_t VolReadTime;              /* time spent reading */
 141    uint64_t VolWriteTime;             /* time spent writing this Volume */
 142    char VolCatStatus[20];             /* Volume status */
 143    char VolCatName[MAX_NAME_LENGTH];  /* Desired volume to mount */
 144 };
 145
 146
 147 typedef struct s_steal_lock {
 148    pthread_t  no_wait_id;             /* id of no wait thread */
 149    int        dev_blocked;            /* state */
 150    int        dev_prev_blocked;       /* previous blocked state */
 151 } bsteal_lock_t;
 152
 153 struct DEVRES;                        /* Device resource defined in stored_conf.h */
 154
 155 /*
 156  * Device structure definition. There is one of these for
 157  *  each physical device. Everything here is "global" to
 158  *  that device and effects all jobs using the device.
 159  */
 160 struct DEVICE {
 161 public:
 162    DEVICE *next;                      /* pointer to next open device */
 163    DEVICE *prev;                      /* pointer to prev open device */
 164    JCR *attached_jcrs;                /* attached JCR list */
 165    dlist *attached_dcrs;              /* attached DCR list */
 166    pthread_mutex_t mutex;             /* access control */
 167    pthread_mutex_t spool_mutex;       /* mutex for updating spool_size */
 168    pthread_cond_t wait;               /* thread wait variable */
 169    pthread_cond_t wait_next_vol;      /* wait for tape to be mounted */
 170    pthread_t no_wait_id;              /* this thread must not wait */
 171    int dev_blocked;                   /* set if we must wait (i.e. change tape) */
 172    int dev_prev_blocked;              /* previous blocked state */
 173    int num_waiting;                   /* number of threads waiting */
 174    int num_writers;                   /* number of writing threads */
 175
 176    /* New access control in process of being implemented */
 177    brwlock_t lock;                    /* New mutual exclusion lock */
 178
 179    int use_count;                     /* usage count on this device */
 180    int fd;                            /* file descriptor */
 181    int capabilities;                  /* capabilities mask */
 182    int state;                         /* state mask */
 183    int dev_errno;                     /* Our own errno */
 184    int mode;                          /* read/write modes */
 185    uint32_t drive_index;              /* Autochanger drive index */
 186    POOLMEM *dev_name;                 /* device name */
 187    char *errmsg;                      /* nicely edited error message */
 188    uint32_t block_num;                /* current block number base 0 */
 189    uint32_t file;                     /* current file number base 0 */
 190    uint64_t file_addr;                /* Current file read/write address */
 191    uint64_t file_size;                /* Current file size */
 192    uint32_t EndBlock;                 /* last block written */
 193    uint32_t EndFile;                  /* last file written */
 194    uint32_t min_block_size;           /* min block size */
 195    uint32_t max_block_size;           /* max block size */
 196    uint64_t max_volume_size;          /* max bytes to put on one volume */
 197    uint64_t max_file_size;            /* max file size to put in one file on volume */
 198    uint64_t volume_capacity;          /* advisory capacity */
 199    uint64_t max_spool_size;           /* maximum spool file size */
 200    uint64_t spool_size;               /* curren spool size */
 201    uint32_t max_rewind_wait;          /* max secs to allow for rewind */
 202    uint32_t max_open_wait;            /* max secs to allow for open */
 203    uint32_t max_open_vols;            /* max simultaneous open volumes */
 204    utime_t  vol_poll_interval;        /* interval between polling Vol mount */
 205    DEVRES *device;                    /* pointer to Device Resource */
 206    btimer_t *tid;                     /* timer id */
 207
 208    VOLUME_CAT_INFO VolCatInfo;        /* Volume Catalog Information */
 209    VOLUME_LABEL VolHdr;               /* Actual volume label */
 210
 211    /* Device wait times ***FIXME*** look at durations */
 212    char BadVolName[MAX_NAME_LENGTH];  /* Last wrong Volume mounted */
 213    bool poll;                         /* set to poll Volume */
 214    int min_wait;
 215    int max_wait;
 216    int max_num_wait;
 217    int wait_sec;
 218    int rem_wait_sec;
 219    int num_wait;
 220 };
 221
 222 /*
 223  * Device Context (or Control) Record.
 224  *  There is one of these records for each Job that is using
 225  *  the device. Items in this record are "local" to the Job and
 226  *  do not affect other Jobs.
 227  */
 228 struct DCR {
 229    dlink dev_link;                    /* link to attach to dev */
 230    JCR *jcr;                          /* pointer to JCR */
 231    DEVICE *dev;                       /* pointer to device */
 232    DEV_BLOCK *block;                  /* pointer to block */
 233    DEV_RECORD *rec;                   /* pointer to record */
 234    int spool_fd;                      /* fd if spooling */
 235    bool spool_data;                   /* set to spool data */
 236    bool spooling;                     /* set when actually spooling */
 237    bool dev_locked;                   /* set if dev already locked */
 238    bool NewVol;                       /* set if new Volume mounted */
 239    bool WroteVol;                     /* set if Volume written */
 240    bool NewFile;                      /* set when EOF written */
 241    uint32_t VolFirstIndex;            /* First file index this Volume */
 242    uint32_t VolLastIndex;             /* Last file index this Volume */
 243    uint32_t FileIndex;                /* Current File Index */
 244    uint32_t EndFile;                  /* End file written */
 245    uint32_t StartFile;                /* Start write file */
 246    uint32_t StartBlock;               /* Start write block */
 247    uint32_t EndBlock;                 /* Ending block written */
 248    int64_t spool_size;                /* Current spool size */
 249    int64_t max_spool_size;            /* Max job spool size */
 250    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 251    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
 252 };
 253
 254
 255 /* Get some definition of function to position
 256  *  to the end of the medium in MTEOM. System
 257  *  dependent. Arrgggg!
 258  */
 259 #ifndef MTEOM
 260 #ifdef  MTSEOD
 261 #define MTEOM MTSEOD
 262 #endif
 263 #ifdef MTEOD
 264 #undef MTEOM
 265 #define MTEOM MTEOD
 266 #endif
 267 #endif
 268
 269 #endif