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, 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 __DEV_H
  30 #define __DEV_H 1
  31
  32 /* #define NEW_LOCK 1 */
  33
  34 #define new_lock_device(dev)             _new_lock_device(__FILE__, __LINE__, (dev))
  35 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
  36 #define new_unlock_device(dev)           _new_unlock_device(__FILE__, __LINE__, (dev))
  37
  38 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
  39 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
  40 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
  41 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
  42 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
  43 #define return_device_lock(d, p) _return_device_lock(__FILE__, __LINE__, (d), (p))
  44
  45 /* Arguments to open_dev() */
  46 #define READ_WRITE 0
  47 #define READ_ONLY  1
  48
  49 /* Generic status bits returned from status_dev() */
  50 #define MT_TAPE      (1<<0)                /* is tape device */
  51 #define MT_EOF       (1<<1)                /* just read EOF */
  52 #define MT_BOT       (1<<2)                /* at beginning of tape */
  53 #define MT_EOT       (1<<3)                /* end of tape reached */
  54 #define MT_SM        (1<<4)                /* DDS setmark */
  55 #define MT_EOD       (1<<5)                /* DDS at end of data */
  56 #define MT_WR_PROT   (1<<6)                /* tape write protected */
  57 #define MT_ONLINE    (1<<7)                /* tape online */
  58 #define MT_DR_OPEN   (1<<8)                /* tape door open */
  59 #define MT_IM_REP_EN (1<<9)                /* immediate report enabled */
  60
  61
  62 /* Bits for device capabilities */
  63 #define CAP_EOF          0x0001       /* has MTWEOF */
  64 #define CAP_BSR          0x0002       /* has MTBSR */
  65 #define CAP_BSF          0x0004       /* has MTBSF */
  66 #define CAP_FSR          0x0008       /* has MTFSR */
  67 #define CAP_FSF          0x0010       /* has MTFSF */
  68 #define CAP_EOM          0x0020       /* has MTEOM */
  69 #define CAP_REM          0x0040       /* is removable media */
  70 #define CAP_RACCESS      0x0080       /* is random access device */
  71 #define CAP_AUTOMOUNT    0x0100       /* Read device at start to see what is there */
  72 #define CAP_LABEL        0x0200       /* Label blank tapes */
  73 #define CAP_ANONVOLS     0x0400       /* Mount without knowing volume name */
  74 #define CAP_ALWAYSOPEN   0x0800       /* always keep device open */
  75 #define CAP_AUTOCHANGER  0x1000       /* AutoChanger */
  76 #define CAP_OFFLINEUNMOUNT 0x2000     /* Offline before unmount */
  77
  78
  79 /* Tape state bits */
  80 #define ST_OPENED    0x001            /* set when device opened */
  81 #define ST_TAPE      0x002            /* is a tape device */
  82 #define ST_LABEL     0x004            /* label found */
  83 #define ST_MALLOC    0x008            /* dev packet malloc'ed in init_dev() */
  84 #define ST_APPEND    0x010            /* ready for Bacula append */
  85 #define ST_READ      0x020            /* ready for Bacula read */
  86 #define ST_EOT       0x040            /* at end of tape */
  87 #define ST_WEOT      0x080            /* Got EOT on write */
  88 #define ST_EOF       0x100            /* Read EOF i.e. zero bytes */
  89 #define ST_NEXTVOL   0x200            /* Start writing on next volume */
  90 #define ST_SHORT     0x400            /* Short block read */
  91
  92 /* dev_blocked states (mutually exclusive) */
  93 #define BST_NOT_BLOCKED       0       /* not blocked */
  94 #define BST_UNMOUNTED         1       /* User unmounted device */
  95 #define BST_WAITING_FOR_SYSOP 2       /* Waiting for operator to mount tape */
  96 #define BST_DOING_ACQUIRE     3       /* Opening/validating/moving tape */
  97 #define BST_WRITING_LABEL     4       /* Labeling a tape */
  98 #define BST_UNMOUNTED_WAITING_FOR_SYSOP 5 /* Closed by user during mount request */
  99
 100 /* Volume Catalog Information structure definition */
 101 typedef struct s_volume_catalog_info {
 102    /* Media info for the current Volume */
 103    uint32_t VolCatJobs;               /* number of jobs on this Volume */
 104    uint32_t VolCatFiles;              /* Number of files */
 105    uint32_t VolCatBlocks;             /* Number of blocks */
 106    uint64_t VolCatBytes;              /* Number of bytes written */
 107    uint32_t VolCatMounts;             /* Number of mounts this volume */
 108    uint32_t VolCatErrors;             /* Number of errors this volume */
 109    uint32_t VolCatWrites;             /* Number of writes this volume */
 110    uint32_t VolCatReads;              /* Number of reads this volume */
 111    uint32_t VolCatRecycles;           /* Number of recycles this volume */
 112    int32_t  Slot;                     /* Slot in changer */
 113    uint64_t VolCatMaxBytes;           /* max bytes to write */
 114    uint64_t VolCatCapacityBytes;      /* capacity estimate */
 115    char VolCatStatus[20];             /* Volume status */
 116    char VolCatName[MAX_NAME_LENGTH];  /* Desired volume to mount */
 117 } VOLUME_CAT_INFO;
 118
 119
 120 typedef struct s_steal_lock {
 121    pthread_t         no_wait_id;      /* id of no wait thread */
 122    int               dev_blocked;     /* state */
 123 } bsteal_lock_t;
 124
 125
 126 /* Device structure definition */
 127 typedef struct s_device {
 128    struct s_device *next;             /* pointer to next open device */
 129    void *attached_jcrs;               /* attached JCR list */
 130 #ifdef NEW_LOCK
 131    brwlock_t lock;                    /* new device locking mechanism */
 132 #endif
 133    pthread_mutex_t mutex;             /* access control */
 134    pthread_cond_t wait;               /* thread wait variable */
 135    pthread_cond_t wait_next_vol;      /* wait for tape to be mounted */
 136    pthread_t no_wait_id;              /* this thread must not wait */
 137    int dev_blocked;                   /* set if we must wait (i.e. change tape) */
 138    int num_waiting;                   /* number of threads waiting */
 139    int num_writers;                   /* number of writing threads */
 140    int use_count;                     /* usage count on this device */
 141    int fd;                            /* file descriptor */
 142    int capabilities;                  /* capabilities mask */
 143    int state;                         /* state mask */
 144    int dev_errno;                     /* Our own errno */
 145    int mode;                          /* read/write modes */
 146    char *dev_name;                    /* device name */
 147    char *errmsg;                      /* nicely edited error message */
 148    uint32_t block_num;                /* current block number base 0 */
 149    uint32_t file;                     /* current file number base 0 */
 150    uint64_t file_bytes;               /* bytes in this file */
 151    uint32_t LastBlockNumWritten;      /* last block written */
 152    uint32_t min_block_size;           /* min block size */
 153    uint32_t max_block_size;           /* max block size */
 154    uint32_t max_volume_jobs;          /* max jobs to put on one volume */
 155    uint64_t max_volume_files;         /* max files to put on one volume */
 156    uint64_t max_volume_size;          /* max bytes to put on one volume */
 157    uint64_t max_file_size;            /* max file size to put in one file on volume */
 158    uint64_t volume_capacity;          /* advisory capacity */
 159    uint32_t max_rewind_wait;          /* max secs to allow for rewind */
 160    uint32_t max_open_wait;            /* max secs to allow for open */
 161    void *device;                      /* pointer to Device Resource */
 162
 163    VOLUME_CAT_INFO VolCatInfo;        /* Volume Catalog Information */
 164    VOLUME_LABEL VolHdr;               /* Actual volume label */
 165
 166 } DEVICE;
 167
 168
 169
 170
 171 #ifdef SunOS
 172 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0cbn"
 173 #endif
 174 #ifdef AIX
 175 #define DEFAULT_TAPE_DRIVE "/dev/rmt0.1"
 176 #endif
 177 #ifdef SGI
 178 #define DEFAULT_TAPE_DRIVE "/dev/tps0d4nr"
 179 #endif
 180 #ifdef Linux
 181 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
 182 #endif
 183 #ifdef OSF
 184 #define DEFAULT_TAPE_DRIVE "/dev/nrmt0"
 185 #endif
 186 #ifdef HPUX
 187 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0hnb"
 188 #endif
 189 #ifdef FreeBSD
 190 #define DEFAULT_TAPE_DRIVE "/dev/nrst0"
 191 #endif
 192
 193 /* Default default */
 194 #ifndef DEFAULT_TAPE_DRIVE
 195 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
 196 #endif
 197
 198 /* Get some definition of function to position
 199  *  to the end of the medium in MTEOM. System
 200  *  dependent. Arrgggg!
 201  */
 202 #ifndef MTEOM
 203 #ifdef  MTSEOD
 204 #define MTEOM MTSEOD
 205 #endif
 206 #ifdef MTEOD
 207 #undef MTEOM
 208 #define MTEOM MTEOD
 209 #endif
 210 #endif
 211
 212 #endif