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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Definitions for using the Device functions in Bacula
  30  *  Tape and File storage access
  31  *
  32  * Kern Sibbald, MM
  33  *
  34  *   Version $Id$
  35  *
  36  */
  37
  38 /*
  39  * Some details of how volume and device reservations work
  40  *
  41  * class VOLRES:
  42  *   set_in_use()     volume being used on current drive
  43  *   clear_in_use()   no longer being used.  Can be re-used or moved.
  44  *   set_swapping()   set volume being moved to another drive
  45  *   is_swapping()    volume is being moved to another drive
  46  *   clear_swapping() volume normal
  47  *
  48  * class DEVICE:
  49  *   set_load()       set to load volume
  50  *   needs_load()     volume must be loaded (i.e. set_load done)
  51  *   clear_load()     load done.
  52  *   set_unload()     set to unload volume
  53  *   needs_unload()    volume must be unloaded
  54  *   clear_unload()   volume unloaded
  55  *
  56  *    reservations are temporary until the drive is acquired
  57  *   inc_reserved()   increments num of reservations
  58  *   dec_reserved()   decrements num of reservations
  59  *   num_reserved()   number of reservations
  60  *
  61  * class DCR:
  62  *   set_reserved()   sets local reserve flag and calls dev->inc_reserved()
  63  *   clear_reserved() clears local reserve flag and calls dev->dec_reserved()
  64  *   is_reserved()    returns local reserved flag
  65  *   unreserve_device()  much more complete unreservation
  66  *
  67  */
  68
  69
  70 #ifndef __DEV_H
  71 #define __DEV_H 1
  72
  73 #undef DCR                            /* used by Bacula */
  74
  75 /* Return values from wait_for_sysop() */
  76 enum {
  77    W_ERROR = 1,
  78    W_TIMEOUT,
  79    W_POLL,
  80    W_MOUNT,
  81    W_WAKE
  82 };
  83
  84 /* Arguments to open_dev() */
  85 enum {
  86    CREATE_READ_WRITE = 1,
  87    OPEN_READ_WRITE,
  88    OPEN_READ_ONLY,
  89    OPEN_WRITE_ONLY
  90 };
  91
  92 /* Device types */
  93 enum {
  94    B_FILE_DEV = 1,
  95    B_TAPE_DEV,
  96    B_DVD_DEV,
  97    B_FIFO_DEV,
  98    B_VTL_DEV
  99 };
 100
 101 /* Generic status bits returned from status_dev() */
 102 #define BMT_TAPE           (1<<0)     /* is tape device */
 103 #define BMT_EOF            (1<<1)     /* just read EOF */
 104 #define BMT_BOT            (1<<2)     /* at beginning of tape */
 105 #define BMT_EOT            (1<<3)     /* end of tape reached */
 106 #define BMT_SM             (1<<4)     /* DDS setmark */
 107 #define BMT_EOD            (1<<5)     /* DDS at end of data */
 108 #define BMT_WR_PROT        (1<<6)     /* tape write protected */
 109 #define BMT_ONLINE         (1<<7)     /* tape online */
 110 #define BMT_DR_OPEN        (1<<8)     /* tape door open */
 111 #define BMT_IM_REP_EN      (1<<9)     /* immediate report enabled */
 112
 113
 114 /* Bits for device capabilities */
 115 #define CAP_EOF            (1<<0)     /* has MTWEOF */
 116 #define CAP_BSR            (1<<1)     /* has MTBSR */
 117 #define CAP_BSF            (1<<2)     /* has MTBSF */
 118 #define CAP_FSR            (1<<3)     /* has MTFSR */
 119 #define CAP_FSF            (1<<4)     /* has MTFSF */
 120 #define CAP_EOM            (1<<5)     /* has MTEOM */
 121 #define CAP_REM            (1<<6)     /* is removable media */
 122 #define CAP_RACCESS        (1<<7)     /* is random access device */
 123 #define CAP_AUTOMOUNT      (1<<8)     /* Read device at start to see what is there */
 124 #define CAP_LABEL          (1<<9)     /* Label blank tapes */
 125 #define CAP_ANONVOLS       (1<<10)    /* Mount without knowing volume name */
 126 #define CAP_ALWAYSOPEN     (1<<11)    /* always keep device open */
 127 #define CAP_AUTOCHANGER    (1<<12)    /* AutoChanger */
 128 #define CAP_OFFLINEUNMOUNT (1<<13)    /* Offline before unmount */
 129 #define CAP_STREAM         (1<<14)    /* Stream device */
 130 #define CAP_BSFATEOM       (1<<15)    /* Backspace file at EOM */
 131 #define CAP_FASTFSF        (1<<16)    /* Fast forward space file */
 132 #define CAP_TWOEOF         (1<<17)    /* Write two eofs for EOM */
 133 #define CAP_CLOSEONPOLL    (1<<18)    /* Close device on polling */
 134 #define CAP_POSITIONBLOCKS (1<<19)    /* Use block positioning */
 135 #define CAP_MTIOCGET       (1<<20)    /* Basic support for fileno and blkno */
 136 #define CAP_REQMOUNT       (1<<21)    /* Require mount to read files back (typically: DVD) */
 137 #define CAP_CHECKLABELS    (1<<22)    /* Check for ANSI/IBM labels */
 138
 139 /* Test state */
 140 #define dev_state(dev, st_state) ((dev)->state & (st_state))
 141
 142 /* Device state bits */
 143 #define ST_XXXXXX          (1<<0)     /* was ST_OPENED */
 144 #define ST_XXXXX           (1<<1)     /* was ST_TAPE */
 145 #define ST_XXXX            (1<<2)     /* was ST_FILE */
 146 #define ST_XXX             (1<<3)     /* was ST_FIFO */
 147 #define ST_XX              (1<<4)     /* was ST_DVD */
 148 #define ST_X               (1<<5)     /* was ST_PROG */
 149
 150 #define ST_LABEL           (1<<6)     /* label found */
 151 #define ST_MALLOC          (1<<7)     /* dev packet malloc'ed in init_dev() */
 152 #define ST_APPEND          (1<<8)     /* ready for Bacula append */
 153 #define ST_READ            (1<<9)     /* ready for Bacula read */
 154 #define ST_EOT             (1<<10)    /* at end of tape */
 155 #define ST_WEOT            (1<<11)    /* Got EOT on write */
 156 #define ST_EOF             (1<<12)    /* Read EOF i.e. zero bytes */
 157 #define ST_NEXTVOL         (1<<13)    /* Start writing on next volume */
 158 #define ST_SHORT           (1<<14)    /* Short block read */
 159 #define ST_MOUNTED         (1<<15)    /* the device is mounted to the mount point */
 160 #define ST_MEDIA           (1<<16)    /* Media found in mounted device */
 161 #define ST_OFFLINE         (1<<17)    /* set offline by operator */
 162 #define ST_PART_SPOOLED    (1<<18)    /* spooling part */
 163 #define ST_FREESPACE_OK    (1<<19)    /* Have valid freespace for DVD */
 164
 165
 166 /* Volume Catalog Information structure definition */
 167 struct VOLUME_CAT_INFO {
 168    /* Media info for the current Volume */
 169    uint32_t VolCatJobs;               /* number of jobs on this Volume */
 170    uint32_t VolCatFiles;              /* Number of files */
 171    uint32_t VolCatBlocks;             /* Number of blocks */
 172    uint64_t VolCatBytes;              /* Number of bytes written */
 173    uint32_t VolCatParts;              /* Number of parts written */
 174    uint32_t VolCatMounts;             /* Number of mounts this volume */
 175    uint32_t VolCatErrors;             /* Number of errors this volume */
 176    uint32_t VolCatWrites;             /* Number of writes this volume */
 177    uint32_t VolCatReads;              /* Number of reads this volume */
 178    uint64_t VolCatRBytes;             /* Number of bytes read */
 179    uint32_t VolCatRecycles;           /* Number of recycles this volume */
 180    uint32_t EndFile;                  /* Last file number */
 181    uint32_t EndBlock;                 /* Last block number */
 182    int32_t  LabelType;                /* Bacula/ANSI/IBM */
 183    int32_t  Slot;                     /* >0=Slot loaded, 0=nothing, -1=unknown */
 184    uint32_t VolCatMaxJobs;            /* Maximum Jobs to write to volume */
 185    uint32_t VolCatMaxFiles;           /* Maximum files to write to volume */
 186    uint64_t VolCatMaxBytes;           /* Max bytes to write to volume */
 187    uint64_t VolCatCapacityBytes;      /* capacity estimate */
 188    btime_t  VolReadTime;              /* time spent reading */
 189    btime_t  VolWriteTime;             /* time spent writing this Volume */
 190    int64_t  VolMediaId;               /* MediaId */
 191    utime_t  VolFirstWritten;          /* Time of first write */
 192    utime_t  VolLastWritten;           /* Time of last write */
 193    bool     InChanger;                /* Set if vol in current magazine */
 194    char VolCatStatus[20];             /* Volume status */
 195    char VolCatName[MAX_NAME_LENGTH];  /* Desired volume to mount */
 196 };
 197
 198
 199 class DEVRES;                        /* Device resource defined in stored_conf.h */
 200 class DCR; /* forward reference */
 201 class VOLRES; /* forward reference */
 202
 203 /*
 204  * Device structure definition. There is one of these for
 205  *  each physical device. Everything here is "global" to
 206  *  that device and effects all jobs using the device.
 207  */
 208 class DEVICE {
 209 private:
 210    int m_fd;                          /* file descriptor */
 211    int m_blocked;                     /* set if we must wait (i.e. change tape) */
 212    int m_count;                       /* Mutex use count -- DEBUG only */
 213    pthread_t m_pid;                   /* Thread that locked -- DEBUG only */
 214    bool m_unload;                     /* set when Volume must be unloaded */
 215    bool m_load;                       /* set when Volume must be loaded */
 216    int m_num_reserved;                /* counter of device reservations */
 217    int32_t m_slot;                    /* slot loaded in drive or -1 if none */
 218
 219 public:
 220    DEVICE * volatile swap_dev;        /* Swap vol from this device */
 221    dlist *attached_dcrs;              /* attached DCR list */
 222    pthread_mutex_t m_mutex;           /* access control */
 223    pthread_mutex_t spool_mutex;       /* mutex for updating spool_size */
 224    pthread_cond_t wait;               /* thread wait variable */
 225    pthread_cond_t wait_next_vol;      /* wait for tape to be mounted */
 226    pthread_t no_wait_id;              /* this thread must not wait */
 227    int dev_prev_blocked;              /* previous blocked state */
 228    int num_waiting;                   /* number of threads waiting */
 229    int num_writers;                   /* number of writing threads */
 230    int capabilities;                  /* capabilities mask */
 231    int state;                         /* state mask */
 232    int dev_errno;                     /* Our own errno */
 233    int mode;                          /* read/write modes */
 234    int openmode;                      /* parameter passed to open_dev (useful to reopen the device) */
 235    int dev_type;                      /* device type */
 236    bool autoselect;                   /* Autoselect in autochanger */
 237    bool initiated;                    /* set when init_dev() called */
 238    int label_type;                    /* Bacula/ANSI/IBM label types */
 239    uint32_t drive_index;              /* Autochanger drive index (base 0) */
 240    POOLMEM *dev_name;                 /* Physical device name */
 241    POOLMEM *prt_name;                 /* Name used for display purposes */
 242    char *errmsg;                      /* nicely edited error message */
 243    uint32_t block_num;                /* current block number base 0 */
 244    uint32_t file;                     /* current file number base 0 */
 245    uint64_t file_addr;                /* Current file read/write address */
 246    uint64_t file_size;                /* Current file size */
 247    uint32_t EndBlock;                 /* last block written */
 248    uint32_t EndFile;                  /* last file written */
 249    uint32_t min_block_size;           /* min block size */
 250    uint32_t max_block_size;           /* max block size */
 251    uint64_t max_volume_size;          /* max bytes to put on one volume */
 252    uint64_t max_file_size;            /* max file size to put in one file on volume */
 253    uint64_t volume_capacity;          /* advisory capacity */
 254    uint64_t max_spool_size;           /* maximum spool file size */
 255    uint64_t spool_size;               /* current spool size for this device */
 256    uint32_t max_rewind_wait;          /* max secs to allow for rewind */
 257    uint32_t max_open_wait;            /* max secs to allow for open */
 258    uint32_t max_open_vols;            /* max simultaneous open volumes */
 259
 260    uint64_t max_part_size;            /* max part size */
 261    uint64_t part_size;                /* current part size */
 262    uint32_t part;                     /* current part number (starts at 0) */
 263    uint64_t part_start;               /* current part start address (relative to the whole volume) */
 264    uint32_t num_dvd_parts;            /* number of parts WRITTEN on the DVD */
 265    /* state ST_FREESPACE_OK is set if free_space is valid */
 266    uint64_t free_space;               /* current free space on medium (without the current part) */
 267    int free_space_errno;              /* indicates errno getting freespace */
 268    bool truncating;                   /* if set, we are currently truncating the DVD */
 269    bool blank_dvd;                    /* if set, we have a blank DVD in the drive */
 270
 271
 272    utime_t  vol_poll_interval;        /* interval between polling Vol mount */
 273    DEVRES *device;                    /* pointer to Device Resource */
 274    VOLRES *vol;                       /* Pointer to Volume reservation item */
 275    btimer_t *tid;                     /* timer id */
 276
 277    VOLUME_CAT_INFO VolCatInfo;        /* Volume Catalog Information */
 278    VOLUME_LABEL VolHdr;               /* Actual volume label */
 279    char pool_name[MAX_NAME_LENGTH];   /* pool name */
 280    char pool_type[MAX_NAME_LENGTH];   /* pool type */
 281
 282    char UnloadVolName[MAX_NAME_LENGTH];  /* Last wrong Volume mounted */
 283    bool poll;                         /* set to poll Volume */
 284
 285    /* Device wait times ***FIXME*** look at durations */
 286    int min_wait;
 287    int max_wait;
 288    int max_num_wait;
 289    int wait_sec;
 290    int rem_wait_sec;
 291    int num_wait;
 292
 293    btime_t last_timer;        /* used by read/write/seek to get stats (usec) */
 294    btime_t last_tick;         /* contains last read/write time (usec) */
 295
 296    btime_t  DevReadTime;
 297    btime_t  DevWriteTime;
 298    uint64_t DevWriteBytes;
 299    uint64_t DevReadBytes;
 300
 301    /* Methods */
 302    btime_t get_timer_count();         /* return the last timer interval (ms) */
 303
 304    int has_cap(int cap) const { return capabilities & cap; }
 305    void clear_cap(int cap) { capabilities &= ~cap; }
 306    void set_cap(int cap) { capabilities |= cap; }
 307    int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
 308    int requires_mount() const { return capabilities & CAP_REQMOUNT; }
 309    int is_removable() const { return capabilities & CAP_REM; }
 310    int is_tape() const { return dev_type == B_TAPE_DEV; }
 311    int is_file() const { return dev_type == B_FILE_DEV; }
 312    int is_fifo() const { return dev_type == B_FIFO_DEV; }
 313    int is_dvd() const  { return dev_type == B_DVD_DEV; }
 314    int is_vtl() const  { return dev_type == B_VTL_DEV; }
 315    int is_open() const { return m_fd >= 0; }
 316    int is_offline() const { return state & ST_OFFLINE; }
 317    int is_labeled() const { return state & ST_LABEL; }
 318    int is_mounted() const { return state & ST_MOUNTED; }
 319    int is_unmountable() const { return (is_dvd() || (is_file() && is_removable())); }
 320    int num_reserved() const { return m_num_reserved; };
 321    int is_part_spooled() const { return state & ST_PART_SPOOLED; }
 322    int have_media() const { return state & ST_MEDIA; }
 323    int is_short_block() const { return state & ST_SHORT; }
 324    int is_busy() const { return (state & ST_READ) || num_writers || num_reserved(); }
 325    int at_eof() const { return state & ST_EOF; }
 326    int at_eot() const { return state & ST_EOT; }
 327    int at_weot() const { return state & ST_WEOT; }
 328    int can_append() const { return state & ST_APPEND; }
 329    int is_freespace_ok() const { return state & ST_FREESPACE_OK; }
 330    /*
 331     * can_write() is meant for checking at the end of a job to see
 332     * if we still have a tape (perhaps not if at end of tape
 333     * and the job is canceled).
 334     */
 335    int can_write() const { return is_open() && can_append() &&
 336                             is_labeled() && !at_weot(); }
 337    int can_read() const   { return state & ST_READ; }
 338    bool can_steal_lock() const { return m_blocked &&
 339                     (m_blocked == BST_UNMOUNTED ||
 340                      m_blocked == BST_WAITING_FOR_SYSOP ||
 341                      m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
 342    bool waiting_for_mount() const { return
 343                     (m_blocked == BST_UNMOUNTED ||
 344                      m_blocked == BST_WAITING_FOR_SYSOP ||
 345                      m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
 346    bool must_unload() const { return m_unload; };
 347    bool must_load() const { return m_load; };
 348    const char *strerror() const;
 349    const char *archive_name() const;
 350    const char *name() const;
 351    const char *print_name() const;    /* Name for display purposes */
 352    void set_ateof(); /* in dev.c */
 353    void set_ateot(); /* in dev.c */
 354    void set_eot() { state |= ST_EOT; };
 355    void set_eof() { state |= ST_EOF; };
 356    void set_append() { state |= ST_APPEND; };
 357    void set_labeled() { state |= ST_LABEL; };
 358    inline void set_read() { state |= ST_READ; };
 359    void set_offline() { state |= ST_OFFLINE; };
 360    void set_mounted() { state |= ST_MOUNTED; };
 361    void set_media() { state |= ST_MEDIA; };
 362    void set_short_block() { state |= ST_SHORT; };
 363    void set_freespace_ok() { state |= ST_FREESPACE_OK; }
 364    void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
 365           else state &= ~ST_PART_SPOOLED;
 366    };
 367    bool is_volume_to_unload() const { \
 368       return m_unload && strcmp(VolHdr.VolumeName, UnloadVolName) == 0; };
 369    void set_load() { m_load = true; };
 370    void inc_reserved() { m_num_reserved++; }
 371    void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
 372           else state &= ~ST_MOUNTED; };
 373    void dec_reserved() { m_num_reserved--; ASSERT(m_num_reserved>=0); };
 374    void clear_append() { state &= ~ST_APPEND; };
 375    void clear_read() { state &= ~ST_READ; };
 376    void clear_labeled() { state &= ~ST_LABEL; };
 377    void clear_offline() { state &= ~ST_OFFLINE; };
 378    void clear_eot() { state &= ~ST_EOT; };
 379    void clear_eof() { state &= ~ST_EOF; };
 380    void clear_opened() { m_fd = -1; };
 381    void clear_mounted() { state &= ~ST_MOUNTED; };
 382    void clear_media() { state &= ~ST_MEDIA; };
 383    void clear_short_block() { state &= ~ST_SHORT; };
 384    void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
 385    void clear_unload() { m_unload = false; UnloadVolName[0] = 0; };
 386    void clear_load() { m_load = false; };
 387    char *bstrerror(void) { return errmsg; };
 388    char *print_errmsg() { return errmsg; };
 389    int32_t get_slot() const { return m_slot; };
 390
 391
 392    void set_unload();            /* in dev.c */
 393    void clear_volhdr();          /* in dev.c */
 394    void close();                 /* in dev.c */
 395    void close_part(DCR *dcr);    /* in dev.c */
 396    bool truncate(DCR *dcr);      /* in dev.c */
 397    int open(DCR *dcr, int mode); /* in dev.c */
 398    void term(void);              /* in dev.c */
 399    ssize_t read(void *buf, size_t len); /* in dev.c */
 400    ssize_t write(const void *buf, size_t len);  /* in dev.c */
 401    bool rewind(DCR *dcr);        /* in dev.c */
 402    bool mount(int timeout);      /* in dev.c */
 403    bool unmount(int timeout);    /* in dev.c */
 404    void edit_mount_codes(POOL_MEM &omsg, const char *imsg); /* in dev.c */
 405    bool offline_or_rewind();     /* in dev.c */
 406    bool offline();               /* in dev.c */
 407    bool bsf(int count);          /* in dev.c */
 408    bool eod(DCR *dcr);           /* in dev.c */
 409    bool fsr(int num);            /* in dev.c */
 410    bool fsf(int num);            /* in dev.c */
 411    bool bsr(int num);            /* in dev.c */
 412    bool weof(int num);           /* in dev.c */
 413    void lock_door();             /* in dev.c */
 414    void unlock_door();           /* in dev.c */
 415    int32_t get_os_tape_file();   /* in dev.c */
 416    bool scan_dir_for_volume(DCR *dcr); /* in scan.c */
 417    bool reposition(DCR *dcr, uint32_t rfile, uint32_t rblock); /* in dev.c */
 418    void clrerror(int func);      /* in dev.c */
 419    boffset_t lseek(DCR *dcr, boffset_t offset, int whence); /* in dev.c */
 420    bool update_pos(DCR *dcr);    /* in dev.c */
 421    void set_slot(int32_t slot);  /* in dev.c */
 422    void clear_slot();            /* in dev.c */
 423
 424
 425    bool update_freespace();      /* in dvd.c */
 426
 427    uint32_t get_file() const { return file; };
 428    uint32_t get_block_num() const { return block_num; };
 429    int fd() const { return m_fd; };
 430
 431    /*
 432     * Locking and blocking calls
 433     */
 434 #ifdef  SD_DEBUG_LOCK
 435    void _r_dlock(const char *, int);      /* in lock.c */
 436    void _r_dunlock(const char *, int);    /* in lock.c */
 437    void _dlock(const char *, int);        /* in lock.c */
 438    void _dunlock(const char *, int);      /* in lock.c */
 439 #else
 440    void r_dlock();                        /* in lock.c */
 441    void r_dunlock() { dunlock(); }
 442    void dlock() { P(m_mutex); }
 443    void dunlock() { V(m_mutex); }
 444 #endif
 445    void dblock(int why);                  /* in lock.c */
 446    void dunblock(bool locked=false);      /* in lock.c */
 447    void set_blocked(int block) { m_blocked = block; };
 448    int blocked() const { return m_blocked; };
 449    bool is_blocked() const { return m_blocked != BST_NOT_BLOCKED; };
 450    const char *print_blocked() const;     /* in dev.c */
 451
 452 private:
 453    bool do_mount(int mount, int timeout);      /* in dev.c */
 454    void set_mode(int omode);                   /* in dev.c */
 455    void open_tape_device(DCR *dcr, int omode); /* in dev.c */
 456    void open_file_device(DCR *dcr, int omode); /* in dev.c */
 457    void open_dvd_device(DCR *dcr, int omode);  /* in dev.c */
 458 };
 459
 460 inline const char *DEVICE::strerror() const { return errmsg; }
 461 inline const char *DEVICE::archive_name() const { return dev_name; }
 462 inline const char *DEVICE::print_name() const { return prt_name; }
 463
 464 /*
 465  * Device Context (or Control) Record.
 466  *  There is one of these records for each Job that is using
 467  *  the device. Items in this record are "local" to the Job and
 468  *  do not affect other Jobs. Note, a job can have multiple
 469  *  DCRs open, each pointing to a different device.
 470  */
 471 class DCR {
 472 private:
 473    bool m_dev_locked;                 /* set if dev already locked */
 474    bool m_reserved;                   /* set if reserved device */
 475    bool m_found_in_use;               /* set if a volume found in use */
 476
 477 public:
 478    dlink dev_link;                    /* link to attach to dev */
 479    JCR *jcr;                          /* pointer to JCR */
 480    DEVICE * volatile dev;             /* pointer to device */
 481    DEVRES *device;                    /* pointer to device resource */
 482    DEV_BLOCK *block;                  /* pointer to block */
 483    DEV_RECORD *rec;                   /* pointer to record */
 484    pthread_t tid;                     /* Thread running this dcr */
 485    int spool_fd;                      /* fd if spooling */
 486    bool spool_data;                   /* set to spool data */
 487    bool spooling;                     /* set when actually spooling */
 488    bool despooling;                   /* set when despooling */
 489    bool despool_wait;                 /* waiting for despooling */
 490    bool NewVol;                       /* set if new Volume mounted */
 491    bool WroteVol;                     /* set if Volume written */
 492    bool NewFile;                      /* set when EOF written */
 493    bool reserved_volume;              /* set if we reserved a volume */
 494    bool any_volume;                   /* Any OK for dir_find_next... */
 495    bool attached_to_dev;              /* set when attached to dev */
 496    bool keep_dcr;                     /* do not free dcr in release_dcr */
 497    uint32_t VolFirstIndex;            /* First file index this Volume */
 498    uint32_t VolLastIndex;             /* Last file index this Volume */
 499    uint32_t FileIndex;                /* Current File Index */
 500    uint32_t EndFile;                  /* End file written */
 501    uint32_t StartFile;                /* Start write file */
 502    uint32_t StartBlock;               /* Start write block */
 503    uint32_t EndBlock;                 /* Ending block written */
 504    int64_t  VolMediaId;               /* MediaId */
 505    int64_t job_spool_size;            /* Current job spool size */
 506    int64_t max_job_spool_size;        /* Max job spool size */
 507    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
 508    char pool_name[MAX_NAME_LENGTH];   /* pool name */
 509    char pool_type[MAX_NAME_LENGTH];   /* pool type */
 510    char media_type[MAX_NAME_LENGTH];  /* media type */
 511    char dev_name[MAX_NAME_LENGTH];    /* dev name */
 512    int Copy;                          /* identical copy number */
 513    int Stripe;                        /* RAIT stripe */
 514    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
 515
 516    /* Methods */
 517    bool found_in_use() const { return m_found_in_use; };
 518    void set_found_in_use() { m_found_in_use = true; };
 519    void clear_found_in_use() { m_found_in_use = false; };
 520    bool is_reserved() const { return m_reserved; };
 521    bool is_dev_locked() { return m_dev_locked; }
 522    void dlock() { dev->dlock(); m_dev_locked = true; }
 523    void dunlock() { m_dev_locked = false; dev->dunlock(); }
 524    void dblock(int why) { dev->dblock(why); }
 525
 526
 527    /* Methods in reserve.c */
 528    void clear_reserved();
 529    void set_reserved();
 530    void unreserve_device();
 531    bool can_i_use_volume();
 532
 533    /* Methods in mount.c */
 534    bool mount_next_write_volume();
 535    bool mount_next_read_volume();
 536    void mark_volume_in_error();
 537    void mark_volume_not_inchanger();
 538    int try_autolabel(bool opened);
 539    bool find_a_volume();
 540    bool is_suitable_volume_mounted();
 541    bool is_eod_valid();
 542    int check_volume_label(bool &ask, bool &autochanger);
 543    void release_volume();
 544    void do_swapping(bool is_writing);
 545    bool is_tape_position_ok();
 546 };
 547
 548 /*
 549  * Volume reservation class -- see reserve.c
 550  */
 551 class VOLRES {
 552    bool m_swapping;                   /* set when swapping to another drive */
 553    bool m_in_use;                     /* set when volume reserved or in use */
 554    int32_t m_slot;                    /* slot of swapping volume */
 555 public:
 556    dlink link;
 557    char *vol_name;                    /* Volume name */
 558    DEVICE *dev;                       /* Pointer to device to which we are attached */
 559
 560    bool is_swapping() const { return m_swapping; };
 561    void set_swapping() { m_swapping = true; };
 562    void clear_swapping() { m_swapping = false; };
 563    bool is_in_use() const { return m_in_use; };
 564    void set_in_use() { m_in_use = true; };
 565    void clear_in_use() { m_in_use = false; };
 566    void set_slot(int32_t slot) { m_slot = slot; };
 567    void clear_slot() { m_slot = -1; };
 568    int32_t get_slot() const { return m_slot; };
 569 };
 570
 571
 572 /* Get some definition of function to position
 573  *  to the end of the medium in MTEOM. System
 574  *  dependent. Arrgggg!
 575  */
 576 #ifndef MTEOM
 577 #ifdef  MTSEOD
 578 #define MTEOM MTSEOD
 579 #endif
 580 #ifdef MTEOD
 581 #undef MTEOM
 582 #define MTEOM MTEOD
 583 #endif
 584 #endif
 585
 586 #endif