]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/dev.h
29Jun07
[bacula/bacula] / bacula / src / stored / dev.h
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2000-2007 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 #ifndef __DEV_H
40 #define __DEV_H 1
41
42 #undef DCR                            /* used by Bacula */
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 /* Device types */
62 enum {
63    B_FILE_DEV = 1,
64    B_TAPE_DEV,
65    B_DVD_DEV,
66    B_FIFO_DEV,
67    B_PROG_DEV
68 };
69
70 /* Generic status bits returned from status_dev() */
71 #define BMT_TAPE           (1<<0)     /* is tape device */
72 #define BMT_EOF            (1<<1)     /* just read EOF */
73 #define BMT_BOT            (1<<2)     /* at beginning of tape */
74 #define BMT_EOT            (1<<3)     /* end of tape reached */
75 #define BMT_SM             (1<<4)     /* DDS setmark */
76 #define BMT_EOD            (1<<5)     /* DDS at end of data */
77 #define BMT_WR_PROT        (1<<6)     /* tape write protected */
78 #define BMT_ONLINE         (1<<7)     /* tape online */
79 #define BMT_DR_OPEN        (1<<8)     /* tape door open */
80 #define BMT_IM_REP_EN      (1<<9)     /* immediate report enabled */
81
82
83 /* Bits for device capabilities */
84 #define CAP_EOF            (1<<0)     /* has MTWEOF */
85 #define CAP_BSR            (1<<1)     /* has MTBSR */
86 #define CAP_BSF            (1<<2)     /* has MTBSF */
87 #define CAP_FSR            (1<<3)     /* has MTFSR */
88 #define CAP_FSF            (1<<4)     /* has MTFSF */
89 #define CAP_EOM            (1<<5)     /* has MTEOM */
90 #define CAP_REM            (1<<6)     /* is removable media */
91 #define CAP_RACCESS        (1<<7)     /* is random access device */
92 #define CAP_AUTOMOUNT      (1<<8)     /* Read device at start to see what is there */
93 #define CAP_LABEL          (1<<9)     /* Label blank tapes */
94 #define CAP_ANONVOLS       (1<<10)    /* Mount without knowing volume name */
95 #define CAP_ALWAYSOPEN     (1<<11)    /* always keep device open */
96 #define CAP_AUTOCHANGER    (1<<12)    /* AutoChanger */
97 #define CAP_OFFLINEUNMOUNT (1<<13)    /* Offline before unmount */
98 #define CAP_STREAM         (1<<14)    /* Stream device */
99 #define CAP_BSFATEOM       (1<<15)    /* Backspace file at EOM */
100 #define CAP_FASTFSF        (1<<16)    /* Fast forward space file */
101 #define CAP_TWOEOF         (1<<17)    /* Write two eofs for EOM */
102 #define CAP_CLOSEONPOLL    (1<<18)    /* Close device on polling */
103 #define CAP_POSITIONBLOCKS (1<<19)    /* Use block positioning */
104 #define CAP_MTIOCGET       (1<<20)    /* Basic support for fileno and blkno */
105 #define CAP_REQMOUNT       (1<<21)    /* Require mount to read files back (typically: DVD) */
106 #define CAP_CHECKLABELS    (1<<22)    /* Check for ANSI/IBM labels */
107
108 /* Test state */
109 #define dev_state(dev, st_state) ((dev)->state & (st_state))
110
111 /* Device state bits */
112 #define ST_XXXXXX          (1<<0)     /* was ST_OPENED */
113 #define ST_XXXXX           (1<<1)     /* was ST_TAPE */
114 #define ST_XXXX            (1<<2)     /* was ST_FILE */
115 #define ST_XXX             (1<<3)     /* was ST_FIFO */
116 #define ST_XX              (1<<4)     /* was ST_DVD */
117 #define ST_X               (1<<5)     /* was ST_PROG */
118
119 #define ST_LABEL           (1<<6)     /* label found */
120 #define ST_MALLOC          (1<<7)     /* dev packet malloc'ed in init_dev() */
121 #define ST_APPEND          (1<<8)     /* ready for Bacula append */
122 #define ST_READ            (1<<9)     /* ready for Bacula read */
123 #define ST_EOT             (1<<10)    /* at end of tape */
124 #define ST_WEOT            (1<<11)    /* Got EOT on write */
125 #define ST_EOF             (1<<12)    /* Read EOF i.e. zero bytes */
126 #define ST_NEXTVOL         (1<<13)    /* Start writing on next volume */
127 #define ST_SHORT           (1<<14)    /* Short block read */
128 #define ST_MOUNTED         (1<<15)    /* the device is mounted to the mount point */
129 #define ST_MEDIA           (1<<16)    /* Media found in mounted device */
130 #define ST_OFFLINE         (1<<17)    /* set offline by operator */
131 #define ST_PART_SPOOLED    (1<<18)    /* spooling part */
132 #define ST_FREESPACE_OK    (1<<19)    /* Have valid freespace for DVD */
133
134
135 /* Volume Catalog Information structure definition */
136 struct VOLUME_CAT_INFO {
137    /* Media info for the current Volume */
138    uint32_t VolCatJobs;               /* number of jobs on this Volume */
139    uint32_t VolCatFiles;              /* Number of files */
140    uint32_t VolCatBlocks;             /* Number of blocks */
141    uint64_t VolCatBytes;              /* Number of bytes written */
142    uint32_t VolCatParts;              /* Number of parts written */
143    uint32_t VolCatMounts;             /* Number of mounts this volume */
144    uint32_t VolCatErrors;             /* Number of errors this volume */
145    uint32_t VolCatWrites;             /* Number of writes this volume */
146    uint32_t VolCatReads;              /* Number of reads this volume */
147    uint64_t VolCatRBytes;             /* Number of bytes read */
148    uint32_t VolCatRecycles;           /* Number of recycles this volume */
149    uint32_t EndFile;                  /* Last file number */
150    uint32_t EndBlock;                 /* Last block number */
151    int32_t  LabelType;                /* Bacula/ANSI/IBM */
152    int32_t  Slot;                     /* >0=Slot loaded, 0=nothing, -1=unknown */
153    uint32_t VolCatMaxJobs;            /* Maximum Jobs to write to volume */
154    uint32_t VolCatMaxFiles;           /* Maximum files to write to volume */
155    uint64_t VolCatMaxBytes;           /* Max bytes to write to volume */
156    uint64_t VolCatCapacityBytes;      /* capacity estimate */
157    btime_t  VolReadTime;              /* time spent reading */
158    btime_t  VolWriteTime;             /* time spent writing this Volume */
159    int64_t  VolMediaId;               /* MediaId */
160    utime_t  VolFirstWritten;          /* Time of first write */
161    bool     InChanger;                /* Set if vol in current magazine */
162    char VolCatStatus[20];             /* Volume status */
163    char VolCatName[MAX_NAME_LENGTH];  /* Desired volume to mount */
164 };
165
166
167 class DEVRES;                        /* Device resource defined in stored_conf.h */
168
169 class DCR; /* forward reference */
170 class VOLRES; /* forward reference */
171
172
173 /*
174  * Device structure definition. There is one of these for
175  *  each physical device. Everything here is "global" to
176  *  that device and effects all jobs using the device.
177  */
178 class DEVICE {
179 private:
180    int m_fd;                          /* file descriptor */
181    int m_blocked;                     /* set if we must wait (i.e. change tape) */
182    int m_count;                       /* Mutex use count -- DEBUG only */
183    pthread_t m_pid;                   /* Thread that locked -- DEBUG only */
184 public:
185    dlist *attached_dcrs;              /* attached DCR list */
186    pthread_mutex_t m_mutex;           /* access control */
187    pthread_mutex_t spool_mutex;       /* mutex for updating spool_size */
188    pthread_cond_t wait;               /* thread wait variable */
189    pthread_cond_t wait_next_vol;      /* wait for tape to be mounted */
190    pthread_t no_wait_id;              /* this thread must not wait */
191    int dev_prev_blocked;              /* previous blocked state */
192    int num_waiting;                   /* number of threads waiting */
193    int num_writers;                   /* number of writing threads */
194    int reserved_device;               /* number of device reservations */
195    int capabilities;                  /* capabilities mask */
196    int state;                         /* state mask */
197    int dev_errno;                     /* Our own errno */
198    int mode;                          /* read/write modes */
199    int openmode;                      /* parameter passed to open_dev (useful to reopen the device) */
200    int dev_type;                      /* device type */
201    bool autoselect;                   /* Autoselect in autochanger */
202    bool initiated;                    /* set when init_dev() called */
203    int label_type;                    /* Bacula/ANSI/IBM label types */
204    uint32_t drive_index;              /* Autochanger drive index (base 0) */
205    int32_t  Slot;                     /* Slot currently in drive (base 1) */
206    POOLMEM *dev_name;                 /* Physical device name */
207    POOLMEM *prt_name;                 /* Name used for display purposes */
208    char *errmsg;                      /* nicely edited error message */
209    uint32_t block_num;                /* current block number base 0 */
210    uint32_t file;                     /* current file number base 0 */
211    uint64_t file_addr;                /* Current file read/write address */
212    uint64_t file_size;                /* Current file size */
213    uint32_t EndBlock;                 /* last block written */
214    uint32_t EndFile;                  /* last file written */
215    uint32_t min_block_size;           /* min block size */
216    uint32_t max_block_size;           /* max block size */
217    uint64_t max_volume_size;          /* max bytes to put on one volume */
218    uint64_t max_file_size;            /* max file size to put in one file on volume */
219    uint64_t volume_capacity;          /* advisory capacity */
220    uint64_t max_spool_size;           /* maximum spool file size */
221    uint64_t spool_size;               /* current spool size for this device */
222    uint32_t max_rewind_wait;          /* max secs to allow for rewind */
223    uint32_t max_open_wait;            /* max secs to allow for open */
224    uint32_t max_open_vols;            /* max simultaneous open volumes */
225    
226    uint64_t max_part_size;            /* max part size */
227    uint64_t part_size;                /* current part size */
228    uint32_t part;                     /* current part number (starts at 0) */
229    uint64_t part_start;               /* current part start address (relative to the whole volume) */
230    uint32_t num_dvd_parts;            /* number of parts WRITTEN on the DVD */
231    /* state ST_FREESPACE_OK is set if free_space is valid */
232    uint64_t free_space;               /* current free space on medium (without the current part) */
233    int free_space_errno;              /* indicates errno getting freespace */
234    bool truncating;                   /* if set, we are currently truncating the DVD */
235    bool blank_dvd;                    /* if set, we have a blank DVD in the drive */
236    
237    
238    utime_t  vol_poll_interval;        /* interval between polling Vol mount */
239    DEVRES *device;                    /* pointer to Device Resource */
240    VOLRES *vol;                       /* Pointer to Volume reservation item */
241    btimer_t *tid;                     /* timer id */
242
243    VOLUME_CAT_INFO VolCatInfo;        /* Volume Catalog Information */
244    VOLUME_LABEL VolHdr;               /* Actual volume label */
245    char pool_name[MAX_NAME_LENGTH];   /* pool name */
246    char pool_type[MAX_NAME_LENGTH];   /* pool type */
247
248    /* Device wait times ***FIXME*** look at durations */
249    char BadVolName[MAX_NAME_LENGTH];  /* Last wrong Volume mounted */
250    bool poll;                         /* set to poll Volume */
251    int min_wait;
252    int max_wait;
253    int max_num_wait;
254    int wait_sec;
255    int rem_wait_sec;
256    int num_wait;
257
258    btime_t last_timer;        /* used by read/write/seek to get stats (usec) */
259    btime_t last_tick;         /* contains last read/write time (usec) */
260
261    btime_t  DevReadTime;
262    btime_t  DevWriteTime;
263    uint64_t DevWriteBytes;
264    uint64_t DevReadBytes;
265
266    /* Methods */
267    btime_t get_timer_count();         /* return the last timer interval (ms) */
268
269    int has_cap(int cap) const { return capabilities & cap; }
270    void clear_cap(int cap) { capabilities &= ~cap; }
271    void set_cap(int cap) { capabilities |= cap; }
272    int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
273    int requires_mount() const { return capabilities & CAP_REQMOUNT; }
274    int is_removable() const { return capabilities & CAP_REM; }
275    int is_tape() const { return dev_type == B_TAPE_DEV; }
276    int is_file() const { return dev_type == B_FILE_DEV; }
277    int is_fifo() const { return dev_type == B_FIFO_DEV; }
278    int is_dvd() const  { return dev_type == B_DVD_DEV; }
279    int is_prog() const  { return dev_type == B_PROG_DEV; }
280    int is_open() const { return m_fd >= 0; }
281    int is_offline() const { return state & ST_OFFLINE; }
282    int is_labeled() const { return state & ST_LABEL; }
283    int is_mounted() const { return state & ST_MOUNTED; }
284    int is_part_spooled() const { return state & ST_PART_SPOOLED; }
285    int have_media() const { return state & ST_MEDIA; }
286    int is_short_block() const { return state & ST_SHORT; }
287    int is_busy() const { return (state & ST_READ) || num_writers || reserved_device; }
288    int at_eof() const { return state & ST_EOF; }
289    int at_eot() const { return state & ST_EOT; }
290    int at_weot() const { return state & ST_WEOT; }
291    int can_append() const { return state & ST_APPEND; }
292    int is_freespace_ok() const { return state & ST_FREESPACE_OK; }
293    /*
294     * can_write() is meant for checking at the end of a job to see
295     * if we still have a tape (perhaps not if at end of tape
296     * and the job is canceled).
297     */
298    int can_write() const { return is_open() && can_append() &&
299                             is_labeled() && !at_weot(); }
300    int can_read() const   { return state & ST_READ; }
301    bool can_steal_lock() const { return m_blocked &&
302                     (m_blocked == BST_UNMOUNTED ||
303                      m_blocked == BST_WAITING_FOR_SYSOP ||
304                      m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
305    bool waiting_for_mount() const { return 
306                     (m_blocked == BST_UNMOUNTED ||
307                      m_blocked == BST_WAITING_FOR_SYSOP ||
308                      m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
309    const char *strerror() const;
310    const char *archive_name() const;
311    const char *name() const;
312    const char *print_name() const;    /* Name for display purposes */
313    void set_ateof(); /* in dev.c */
314    void set_ateot(); /* in dev.c */
315    void set_eot() { state |= ST_EOT; };
316    void set_eof() { state |= ST_EOF; };
317    void set_append() { state |= ST_APPEND; };
318    void set_labeled() { state |= ST_LABEL; };
319    inline void set_read() { state |= ST_READ; };
320    void set_offline() { state |= ST_OFFLINE; };
321    void set_mounted() { state |= ST_MOUNTED; };
322    void set_media() { state |= ST_MEDIA; };
323    void set_short_block() { state |= ST_SHORT; };
324    void set_freespace_ok() { state |= ST_FREESPACE_OK; }
325    void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
326           else state &= ~ST_PART_SPOOLED;
327    };
328    void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
329           else state &= ~ST_MOUNTED; };
330    void clear_append() { state &= ~ST_APPEND; };
331    void clear_read() { state &= ~ST_READ; };
332    void clear_labeled() { state &= ~ST_LABEL; };
333    void clear_offline() { state &= ~ST_OFFLINE; };
334    void clear_eot() { state &= ~ST_EOT; };
335    void clear_eof() { state &= ~ST_EOF; };
336    void clear_opened() { m_fd = -1; };
337    void clear_mounted() { state &= ~ST_MOUNTED; };
338    void clear_media() { state &= ~ST_MEDIA; };
339    void clear_short_block() { state &= ~ST_SHORT; };
340    void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
341    char *bstrerror(void) { return errmsg; };
342    char *print_errmsg() { return errmsg; };
343
344
345    void clear_volhdr();          /* in dev.c */
346    void close();                 /* in dev.c */
347    void close_part(DCR *dcr);    /* in dev.c */
348    bool truncate(DCR *dcr);      /* in dev.c */
349    int open(DCR *dcr, int mode); /* in dev.c */
350    void term(void);              /* in dev.c */
351    ssize_t read(void *buf, size_t len); /* in dev.c */
352    ssize_t write(const void *buf, size_t len);  /* in dev.c */
353    bool rewind(DCR *dcr);        /* in dev.c */
354    bool mount(int timeout);      /* in dev.c */
355    bool unmount(int timeout);    /* in dev.c */
356    void edit_mount_codes(POOL_MEM &omsg, const char *imsg); /* in dev.c */
357    bool offline_or_rewind();     /* in dev.c */
358    bool offline();               /* in dev.c */
359    bool bsf(int count);          /* in dev.c */
360    bool eod(DCR *dcr);           /* in dev.c */
361    bool fsr(int num);            /* in dev.c */
362    bool fsf(int num);            /* in dev.c */
363    bool bsr(int num);            /* in dev.c */
364    bool weof(int num);           /* in dev.c */
365    void lock_door();             /* in dev.c */
366    void unlock_door();           /* in dev.c */
367    int32_t get_os_tape_file();   /* in dev.c */
368    bool scan_dir_for_volume(DCR *dcr); /* in scan.c */
369    bool reposition(DCR *dcr, uint32_t rfile, uint32_t rblock); /* in dev.c */
370    void clrerror(int func);      /* in dev.c */
371    boffset_t lseek(DCR *dcr, boffset_t offset, int whence); /* in dev.c */
372    bool update_pos(DCR *dcr);    /* in dev.c */
373    bool update_freespace();      /* in dvd.c */
374
375    uint32_t get_file() const { return file; };
376    uint32_t get_block_num() const { return block_num; };
377    int fd() const { return m_fd; };
378
379    /* 
380     * Locking and blocking calls
381     */
382 #ifdef  SD_DEBUG_LOCK
383    void _r_dlock(const char *, int);      /* in lock.c */
384    void _r_dunlock(const char *, int);    /* in lock.c */
385    void _dlock(const char *, int);        /* in lock.c */
386    void _dunlock(const char *, int);      /* in lock.c */
387 #else
388    void r_dlock();                        /* in lock.c */
389    void r_dunlock() { dunlock(); }
390    void dlock() { P(m_mutex); } 
391    void dunlock() { V(m_mutex); } 
392 #endif
393    void dblock(int why);                  /* in lock.c */
394    void dunblock(bool locked=false);      /* in lock.c */
395    void set_blocked(int block) { m_blocked = block; };
396    int blocked() const { return m_blocked; };
397    bool is_blocked() const { return m_blocked != BST_NOT_BLOCKED; };
398    const char *print_blocked() const;     /* in dev.c */
399
400 private:
401    bool do_mount(int mount, int timeout);      /* in dev.c */
402    void set_mode(int omode);                   /* in dev.c */
403    void open_tape_device(DCR *dcr, int omode); /* in dev.c */
404    void open_file_device(DCR *dcr, int omode); /* in dev.c */
405    void open_dvd_device(DCR *dcr, int omode);  /* in dev.c */
406 };
407
408 inline const char *DEVICE::strerror() const { return errmsg; }
409 inline const char *DEVICE::archive_name() const { return dev_name; }
410 inline const char *DEVICE::print_name() const { return prt_name; }
411
412 /*
413  * Device Context (or Control) Record.
414  *  There is one of these records for each Job that is using
415  *  the device. Items in this record are "local" to the Job and
416  *  do not affect other Jobs. Note, a job can have multiple
417  *  DCRs open, each pointing to a different device. 
418  */
419 class DCR {
420 public:
421    dlink dev_link;                    /* link to attach to dev */
422    JCR *jcr;                          /* pointer to JCR */
423    DEVICE *dev;                       /* pointer to device */
424    DEVRES *device;                    /* pointer to device resource */
425    DEV_BLOCK *block;                  /* pointer to block */
426    DEV_RECORD *rec;                   /* pointer to record */
427    pthread_t tid;                     /* Thread running this dcr */
428    int spool_fd;                      /* fd if spooling */
429    bool spool_data;                   /* set to spool data */
430    bool spooling;                     /* set when actually spooling */
431    bool despooling;                   /* set when despooling */
432    bool despool_wait;                 /* waiting for despooling */
433    bool m_dev_locked;                 /* set if dev already locked */
434    bool NewVol;                       /* set if new Volume mounted */
435    bool WroteVol;                     /* set if Volume written */
436    bool NewFile;                      /* set when EOF written */
437    bool reserved_device;              /* set if reserve done */
438    bool any_volume;                   /* Any OK for dir_find_next... */
439    bool attached_to_dev;              /* set when attached to dev */
440    bool volume_in_use;                /* set in dir_find_next_appendable_volume() */
441    uint32_t VolFirstIndex;            /* First file index this Volume */
442    uint32_t VolLastIndex;             /* Last file index this Volume */
443    uint32_t FileIndex;                /* Current File Index */
444    uint32_t EndFile;                  /* End file written */
445    uint32_t StartFile;                /* Start write file */
446    uint32_t StartBlock;               /* Start write block */
447    uint32_t EndBlock;                 /* Ending block written */
448    int64_t job_spool_size;            /* Current job spool size */
449    int64_t max_job_spool_size;        /* Max job spool size */
450    char VolumeName[MAX_NAME_LENGTH];  /* Volume name */
451    char pool_name[MAX_NAME_LENGTH];   /* pool name */
452    char pool_type[MAX_NAME_LENGTH];   /* pool type */
453    char media_type[MAX_NAME_LENGTH];  /* media type */
454    char dev_name[MAX_NAME_LENGTH];    /* dev name */
455    int Copy;                          /* identical copy number */
456    int Stripe;                        /* RAIT stripe */
457    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
458
459    /* Methods */
460    bool is_dev_locked() { return m_dev_locked; }
461    void dlock() { dev->dlock(); m_dev_locked = true; }
462    void dunlock() { dev->dunlock(); m_dev_locked = false;}
463    void dblock(int why) { dev->dblock(why); }
464
465 };
466
467 /*
468  * Volume reservation class -- see reserve.c
469  */
470 class VOLRES { 
471 public:
472    dlink link;
473    char *vol_name;
474    DEVICE *dev;
475 };
476
477
478 /* Get some definition of function to position
479  *  to the end of the medium in MTEOM. System
480  *  dependent. Arrgggg!
481  */
482 #ifndef MTEOM
483 #ifdef  MTSEOD
484 #define MTEOM MTSEOD
485 #endif
486 #ifdef MTEOD
487 #undef MTEOM
488 #define MTEOM MTEOD
489 #endif
490 #endif
491
492 #endif