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  * Kern Sibbald, MM
   6  *
   7  *   Version $Id$
   8  *
   9  */
  10 /*
  11    Copyright (C) 2000-2005 Kern Sibbald
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License
  15    version 2 as ammended with additional clauses defined in the
  16    file LICENSE in the main source directory.
  17
  18    This program is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21    the file LICENSE for additional details.
  22
  23  */
  24
  25
  26 #ifndef __DEV_H
  27 #define __DEV_H 1
  28
  29 #undef DCR                            /* used by Bacula */
  30
  31 /* #define NEW_LOCK 1 */
  32
  33 #define new_lock_device(dev)             _new_lock_device(__FILE__, __LINE__, (dev))
  34 #define new_lock_device_state(dev,state) _new_lock_device(__FILE__, __LINE__, (dev), (state))
  35 #define new_unlock_device(dev)           _new_unlock_device(__FILE__, __LINE__, (dev))
  36
  37 #define lock_device(d) _lock_device(__FILE__, __LINE__, (d))
  38 #define unlock_device(d) _unlock_device(__FILE__, __LINE__, (d))
  39 #define block_device(d, s) _block_device(__FILE__, __LINE__, (d), s)
  40 #define unblock_device(d) _unblock_device(__FILE__, __LINE__, (d))
  41 #define steal_device_lock(d, p, s) _steal_device_lock(__FILE__, __LINE__, (d), (p), s)
  42 #define give_back_device_lock(d, p) _give_back_device_lock(__FILE__, __LINE__, (d), (p))
  43
  44 /* Arguments to open_dev() */
  45 enum {
  46    CREATE_READ_WRITE = 1,
  47    OPEN_READ_WRITE,
  48    OPEN_READ_ONLY,
  49    OPEN_WRITE_ONLY
  50 };
  51
  52 /* Generic status bits returned from status_dev() */
  53 #define BMT_TAPE           (1<<0)     /* is tape device */
  54 #define BMT_EOF            (1<<1)     /* just read EOF */
  55 #define BMT_BOT            (1<<2)     /* at beginning of tape */
  56 #define BMT_EOT            (1<<3)     /* end of tape reached */
  57 #define BMT_SM             (1<<4)     /* DDS setmark */
  58 #define BMT_EOD            (1<<5)     /* DDS at end of data */
  59 #define BMT_WR_PROT        (1<<6)     /* tape write protected */
  60 #define BMT_ONLINE         (1<<7)     /* tape online */
  61 #define BMT_DR_OPEN        (1<<8)     /* tape door open */
  62 #define BMT_IM_REP_EN      (1<<9)     /* immediate report enabled */
  63
  64
  65 /* Test capabilities */
  66 #define dev_cap(dev, cap) ((dev)->capabilities & (cap))
  67
  68 /* Bits for device capabilities */
  69 #define CAP_EOF            (1<<0)     /* has MTWEOF */
  70 #define CAP_BSR            (1<<1)     /* has MTBSR */
  71 #define CAP_BSF            (1<<2)     /* has MTBSF */
  72 #define CAP_FSR            (1<<3)     /* has MTFSR */
  73 #define CAP_FSF            (1<<4)     /* has MTFSF */
  74 #define CAP_EOM            (1<<5)     /* has MTEOM */
  75 #define CAP_REM            (1<<6)     /* is removable media */
  76 #define CAP_RACCESS        (1<<7)     /* is random access device */
  77 #define CAP_AUTOMOUNT      (1<<8)     /* Read device at start to see what is there */
  78 #define CAP_LABEL          (1<<9)     /* Label blank tapes */
  79 #define CAP_ANONVOLS       (1<<10)    /* Mount without knowing volume name */
  80 #define CAP_ALWAYSOPEN     (1<<11)    /* always keep device open */
  81 #define CAP_AUTOCHANGER    (1<<12)    /* AutoChanger */
  82 #define CAP_OFFLINEUNMOUNT (1<<13)    /* Offline before unmount */
  83 #define CAP_STREAM         (1<<14)    /* Stream device */
  84 #define CAP_BSFATEOM       (1<<15)    /* Backspace file at EOM */
  85 #define CAP_FASTFSF        (1<<16)    /* Fast forward space file */
  86 #define CAP_TWOEOF         (1<<17)    /* Write two eofs for EOM */
  87 #define CAP_CLOSEONPOLL    (1<<18)    /* Close device on polling */
  88 #define CAP_POSITIONBLOCKS (1<<19)    /* Use block positioning */
  89 #define CAP_MTIOCGET       (1<<20)    /* Basic support for fileno and blkno */
  90 #define CAP_REQMOUNT       (1<<21)    /* Require mount to read files back (typically: DVD) */
  91 #define CAP_CHECKLABELS    (1<<22)    /* Check for ANSI/IBM labels */
  92
  93 /* Test state */
  94 #define dev_state(dev, st_state) ((dev)->state & (st_state))
  95
  96 /* Device state bits */
  97 #define ST_OPENED          (1<<0)     /* set when device opened */
  98 #define ST_TAPE            (1<<1)     /* is a tape device */
  99 #define ST_FILE            (1<<2)     /* is a file device */
 100 #define ST_FIFO            (1<<3)     /* is a fifo device */
 101 #define ST_DVD             (1<<4)     /* is a DVD device */
 102 #define ST_PROG            (1<<5)     /* is a program device */
 103 #define ST_LABEL           (1<<6)     /* label found */
 104 #define ST_MALLOC          (1<<7)     /* dev packet malloc'ed in init_dev() */
 105 #define ST_APPEND          (1<<8)     /* ready for Bacula append */
 106 #define ST_READ            (1<<9)     /* ready for Bacula read */
 107 #define ST_EOT             (1<<10)    /* at end of tape */
 108 #define ST_WEOT            (1<<11)    /* Got EOT on write */
 109 #define ST_EOF             (1<<12)    /* Read EOF i.e. zero bytes */
 110 #define ST_NEXTVOL         (1<<13)    /* Start writing on next volume */
 111 #define ST_SHORT           (1<<14)    /* Short block read */
 112 #define ST_MOUNTED         (1<<15)    /* the device is mounted to the mount point */
 113 #define ST_MEDIA           (1<<16)    /* Media found in mounted device */
 114 #define ST_OFFLINE         (1<<17)    /* set offline by operator */
 115
 116 /* dev_blocked states (mutually exclusive) */
 117 enum {
 118    BST_NOT_BLOCKED = 0,               /* not blocked */
 119    BST_UNMOUNTED,                     /* User unmounted device */
 120    BST_WAITING_FOR_SYSOP,             /* Waiting for operator to mount tape */
 121    BST_DOING_ACQUIRE,                 /* Opening/validating/moving tape */
 122    BST_WRITING_LABEL,                  /* Labeling a tape */
 123    BST_UNMOUNTED_WAITING_FOR_SYSOP,    /* Closed by user during mount request */
 124    BST_MOUNT                           /* Mount request */
 125 };
 126
 127 /* Volume Catalog Information structure definition */
 128 struct VOLUME_CAT_INFO {
 129    /* Media info for the current Volume */
 130    uint32_t VolCatJobs;               /* number of jobs on this Volume */
 131    uint32_t VolCatFiles;              /* Number of files */
 132    uint32_t VolCatBlocks;             /* Number of blocks */
 133    uint64_t VolCatBytes;              /* Number of bytes written */
 134    uint32_t VolCatParts;              /* Number of parts written */
 135    uint32_t VolCatMounts;             /* Number of mounts this volume */
 136    uint32_t VolCatErrors;             /* Number of errors this volume */
 137    uint32_t VolCatWrites;             /* Number of writes this volume */
 138    uint32_t VolCatReads;              /* Number of reads this volume */
 139    uint64_t VolCatRBytes;             /* Number of bytes read */
 140    uint32_t VolCatRecycles;           /* Number of recycles this volume */
 141    uint32_t EndFile;                  /* Last file number */
 142    uint32_t EndBlock;                 /* Last block number */
 143    int32_t  LabelType;                /* Bacula/ANSI/IBM */
 144    int32_t  Slot;                     /* Slot in changer */
 145    bool     InChanger;                /* Set if vol in current magazine */
 146    uint32_t VolCatMaxJobs;            /* Maximum Jobs to write to volume */
 147    uint32_t VolCatMaxFiles;           /* Maximum files to write to volume */
 148    uint64_t VolCatMaxBytes;           /* Max bytes to write to volume */
 149    uint64_t VolCatCapacityBytes;      /* capacity estimate */
 150    uint64_t VolReadTime;              /* time spent reading */
 151    uint64_t VolWriteTime;             /* time spent writing this Volume */
 152    char VolCatStatus[20];             /* Volume status */
 153    char VolCatName[MAX_NAME_LENGTH];  /* Desired volume to mount */
 154 };
 155
 156
 157 typedef struct s_steal_lock {
 158    pthread_t  no_wait_id;             /* id of no wait thread */
 159    int        dev_blocked;            /* state */
 160    int        dev_prev_blocked;       /* previous blocked state */
 161 } bsteal_lock_t;
 162
 163 struct DEVRES;                        /* Device resource defined in stored_conf.h */
 164 int      weof_dev(DEVICE *dev, int num);
 165 bool     rewind_dev(DEVICE *dev);
 166
 167 class DCR; /* forward reference */
 168 /*
 169  * Device structure definition. There is one of these for
 170  *  each physical device. Everything here is "global" to
 171  *  that device and effects all jobs using the device.
 172  */
 173 class DEVICE {
 174 public:
 175    dlist *attached_dcrs;              /* attached DCR list */
 176    pthread_mutex_t mutex;             /* access control */
 177    pthread_mutex_t spool_mutex;       /* mutex for updating spool_size */
 178    pthread_cond_t wait;               /* thread wait variable */
 179    pthread_cond_t wait_next_vol;      /* wait for tape to be mounted */
 180    pthread_t no_wait_id;              /* this thread must not wait */
 181    int dev_blocked;                   /* set if we must wait (i.e. change tape) */
 182    int dev_prev_blocked;              /* previous blocked state */
 183    int num_waiting;                   /* number of threads waiting */
 184    int num_writers;                   /* number of writing threads */
 185    int reserved_device;               /* number of device reservations */
 186
 187    /* New access control in process of being implemented */
 188    brwlock_t lock;                    /* New mutual exclusion lock */
 189
 190    int use_count;                     /* usage count on this device 0 or 1 */
 191    int fd;                            /* file descriptor */
 192    int capabilities;                  /* capabilities mask */
 193    int state;                         /* state mask */
 194    int dev_errno;                     /* Our own errno */
 195    int mode;                          /* read/write modes */
 196    int openmode;                      /* parameter passed to open_dev (useful to reopen the device) */
 197    bool autoselect;                   /* Autoselect in autochanger */
 198    bool open_nowait;                  /* If set, don t wait on open */
 199    int label_type;                    /* Bacula/ANSI/IBM label types */
 200    uint32_t drive_index;              /* Autochanger drive index (base 0) */
 201    int32_t  Slot;                     /* Slot currently in drive (base 1) */
 202    POOLMEM *dev_name;                 /* Physical device name */
 203    POOLMEM *prt_name;                 /* Name used for display purposes */
 204    char *errmsg;                      /* nicely edited error message */
 205    uint32_t block_num;                /* current block number base 0 */
 206    uint32_t file;                     /* current file number base 0 */
 207    uint64_t file_addr;                /* Current file read/write address */
 208    uint64_t file_size;                /* Current file size */
 209    uint32_t EndBlock;                 /* last block written */
 210    uint32_t EndFile;                  /* last file written */
 211    uint32_t min_block_size;           /* min block size */
 212    uint32_t max_block_size;           /* max block size */
 213    uint64_t max_volume_size;          /* max bytes to put on one volume */
 214    uint64_t max_file_size;            /* max file size to put in one file on volume */
 215    uint64_t volume_capacity;          /* advisory capacity */
 216    uint64_t max_spool_size;           /* maximum spool file size */
 217    uint64_t spool_size;               /* current spool size for this device */
 218    uint32_t max_rewind_wait;          /* max secs to allow for rewind */
 219    uint32_t max_open_wait;            /* max secs to allow for open */
 220    uint32_t max_open_vols;            /* max simultaneous open volumes */
 221
 222    uint64_t max_part_size;            /* max part size */
 223    uint64_t part_size;                /* current part size */
 224    uint32_t part;                     /* current part number */
 225    uint64_t part_start;               /* current part start address (relative to the whole volume) */
 226    uint32_t num_parts;                /* number of parts (total) */
 227    uint64_t free_space;               /* current free space on medium (without the current part) */
 228    int free_space_errno;              /* indicates:
 229                                        * - free_space_errno == 0: ignore free_space.
 230                                        * - free_space_errno < 0: an error occured.
 231                                        * - free_space_errno > 0: free_space is valid. */
 232
 233    utime_t  vol_poll_interval;        /* interval between polling Vol mount */
 234    DEVRES *device;                    /* pointer to Device Resource */
 235    btimer_t *tid;                     /* timer id */
 236
 237    VOLUME_CAT_INFO VolCatInfo;        /* Volume Catalog Information */
 238    VOLUME_LABEL VolHdr;               /* Actual volume label */
 239    char pool_name[MAX_NAME_LENGTH];   /* pool name */
 240    char pool_type[MAX_NAME_LENGTH];   /* pool type */
 241
 242    /* Device wait times ***FIXME*** look at durations */
 243    char BadVolName[MAX_NAME_LENGTH];  /* Last wrong Volume mounted */
 244    bool poll;                         /* set to poll Volume */
 245    int min_wait;
 246    int max_wait;
 247    int max_num_wait;
 248    int wait_sec;
 249    int rem_wait_sec;
 250    int num_wait;
 251
 252    /* Methods */
 253    int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
 254    int requires_mount() const { return capabilities & CAP_REQMOUNT; }
 255    int is_tape() const { return state & ST_TAPE; }
 256    int is_file() const { return state & ST_FILE; }
 257    int is_fifo() const { return state & ST_FIFO; }
 258    int is_dvd() const  { return state & ST_DVD; }
 259    int is_open() const { return state & ST_OPENED; }
 260    int is_offline() const { return state & ST_OFFLINE; }
 261    int is_labeled() const { return state & ST_LABEL; }
 262    int is_mounted() const { return state & ST_MOUNTED; }
 263    int have_media() const { return state & ST_MEDIA; }
 264    int is_short_block() const { return state & ST_SHORT; }
 265    int is_busy() const { return (state & ST_READ) || num_writers || reserved_device; }
 266    int at_eof() const { return state & ST_EOF; }
 267    int at_eot() const { return state & ST_EOT; }
 268    int at_weot() const { return state & ST_WEOT; }
 269    int can_append() const { return state & ST_APPEND; }
 270    /*
 271     * can_write() is meant for checking at the end of a job to see
 272     * if we still have a tape (perhaps not if at end of tape
 273     * and the job is canceled).
 274     */
 275    int can_write() const { return is_open() && can_append() &&
 276                             is_labeled() && !at_weot(); }
 277    int can_read() const   { return state & ST_READ; }
 278    bool can_steal_lock() const { return dev_blocked &&
 279                     (dev_blocked == BST_UNMOUNTED ||
 280                      dev_blocked == BST_WAITING_FOR_SYSOP ||
 281                      dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
 282    bool waiting_for_mount() const { return
 283                     (dev_blocked == BST_UNMOUNTED ||
 284                      dev_blocked == BST_WAITING_FOR_SYSOP ||
 285                      dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
 286    bool weof() { return !weof_dev(this, 1); };
 287    bool fsr(int num);   /* in dev.c */
 288    bool rewind() { return rewind_dev(this); };
 289    const char *strerror() const;
 290    const char *archive_name() const;
 291    const char *name() const;
 292    const char *print_name() const;    /* Name for display purposes */
 293    void set_ateof(); /* in dev.c */
 294    void set_ateot(); /* in dev.c */
 295    void set_eot() { state |= ST_EOT; };
 296    void set_eof() { state |= ST_EOF; };
 297    void set_append() { state |= ST_APPEND; };
 298    void set_labeled() { state |= ST_LABEL; };
 299    void set_read() { state |= ST_READ; };
 300    void set_offline() { state |= ST_OFFLINE; };
 301    void set_opened() { state |= ST_OPENED; };
 302    void set_mounted() { state |= ST_MOUNTED; };
 303    void set_media() { state |= ST_MEDIA; };
 304    void set_short_block() { state |= ST_SHORT; };
 305    void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
 306           else state &= ~ST_MOUNTED; };
 307    void clear_append() { state &= ~ST_APPEND; };
 308    void clear_read() { state &= ~ST_READ; };
 309    void clear_labeled() { state &= ~ST_LABEL; };
 310    void clear_offline() { state &= ~ST_OFFLINE; };
 311    void clear_eot() { state &= ~ST_EOT; };
 312    void clear_eof() { state &= ~ST_EOF; };
 313    void clear_opened() { state &= ~ST_OPENED; };
 314    void clear_mounted() { state &= ~ST_MOUNTED; };
 315    void clear_media() { state &= ~ST_MEDIA; };
 316    void clear_short_block() { state &= ~ST_SHORT; };
 317
 318    void block(int why); /* in dev.c */
 319    void unblock();      /* in dev.c */
 320    void close();        /* in dev.c */
 321    int open(DCR *dcr, int mode); /* in dev.c */
 322    void set_mode(int mode); /* in dev.c */
 323
 324    void set_blocked(int block) { dev_blocked = block; };
 325    int  get_blocked() const { return dev_blocked; };
 326    const char *print_blocked() const; /* in dev.c */
 327    bool is_blocked() const { return dev_blocked != BST_NOT_BLOCKED; };
 328 };
 329
 330 /* Note, these return int not bool! */
 331 inline const char *DEVICE::strerror() const { return errmsg; }
 332 inline const char *DEVICE::archive_name() const { return dev_name; }
 333 inline const char *DEVICE::print_name() const { return prt_name; }
 334
 335 /*
 336  * Device Context (or Control) Record.
 337  *  There is one of these records for each Job that is using
 338  *  the device. Items in this record are "local" to the Job and
 339  *  do not affect other Jobs. Note, a job can have multiple
 340  *  DCRs open, each pointing to a different device.
 341  */
 342 class DCR {
 343 public:
 344    dlink dev_link;                    /* link to attach to dev */
 345    JCR *jcr;                          /* pointer to JCR */
 346    DEVICE *dev;                       /* pointer to device */
 347    DEVRES *device;                    /* pointer to device resource */
 348    DEV_BLOCK *block;                  /* pointer to block */
 349    DEV_RECORD *rec;                   /* pointer to record */
 350    int spool_fd;                      /* fd if spooling */
 351    bool spool_data;                   /* set to spool data */
 352    bool spooling;                     /* set when actually spooling */
 353    bool dev_locked;                   /* set if dev already locked */
 354    bool NewVol;                       /* set if new Volume mounted */
 355    bool WroteVol;                     /* set if Volume written */
 356    bool NewFile;                      /* set when EOF written */
 357    bool reserved_device;              /* set if reserve done */
 358    uint32_t VolFirstIndex;            /* First file index this Volume */
 359    uint32_t VolLastIndex;             /* Last file index this Volume */
 360    uint32_t FileIndex;                /* Current File Index */
 361    uint32_t EndFile;                  /* End file written */
 362    uint32_t StartFile;                /* Start write file */
 363    uint32_t StartBlock;               /* Start write block */
 364    uint32_t EndBlock;                 /* Ending block written */
 365    int64_t job_spool_size;            /* Current job spool size */
 366    int64_t max_job_spool_size;        /* Max job spool size */
 367    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 368    char pool_name[MAX_NAME_LENGTH];   /* pool name */
 369    char pool_type[MAX_NAME_LENGTH];   /* pool type */
 370    char media_type[MAX_NAME_LENGTH];  /* media type */
 371    char dev_name[MAX_NAME_LENGTH];    /* dev name */
 372    int Copy;                          /* identical copy number */
 373    int Stripe;                        /* RAIT stripe */
 374    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
 375 };
 376
 377 /*
 378  * Volume reservation class -- see reserve.c
 379  */
 380 class VOLRES {
 381 public:
 382    dlink link;
 383    char *vol_name;
 384    DEVICE *dev;
 385    DCR *dcr;
 386 };
 387
 388
 389 /* Get some definition of function to position
 390  *  to the end of the medium in MTEOM. System
 391  *  dependent. Arrgggg!
 392  */
 393 #ifndef MTEOM
 394 #ifdef  MTSEOD
 395 #define MTEOM MTSEOD
 396 #endif
 397 #ifdef MTEOD
 398 #undef MTEOM
 399 #define MTEOM MTEOD
 400 #endif
 401 #endif
 402
 403 #endif