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