2 * Definitions for using the Device functions in Bacula
3 * Tape and File storage access
7 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License as
11 published by the Free Software Foundation; either version 2 of
12 the License, or (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU General Public
20 License along with this program; if not, write to the Free
21 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /* Arguments to open_dev() */
34 /* Generic status bits returned from status_dev() */
35 #define MT_TAPE (1<<0) /* is tape device */
36 #define MT_EOF (1<<1) /* just read EOF */
37 #define MT_BOT (1<<2) /* at beginning of tape */
38 #define MT_EOT (1<<3) /* end of tape reached */
39 #define MT_SM (1<<4) /* DDS setmark */
40 #define MT_EOD (1<<5) /* DDS at end of data */
41 #define MT_WR_PROT (1<<6) /* tape write protected */
42 #define MT_ONLINE (1<<7) /* tape online */
43 #define MT_DR_OPEN (1<<8) /* tape door open */
44 #define MT_IM_REP_EN (1<<9) /* immediate report enabled */
47 /* Bits for device capabilities */
48 #define CAP_EOF 0x001 /* has MTWEOF */
49 #define CAP_BSR 0x002 /* has MTBSR */
50 #define CAP_BSF 0x004 /* has MTBSF */
51 #define CAP_FSR 0x008 /* has MTFSR */
52 #define CAP_FSF 0x010 /* has MTFSF */
53 #define CAP_EOM 0x020 /* has MTEOM */
54 #define CAP_REM 0x040 /* is removable media */
55 #define CAP_RACCESS 0x080 /* is random access device */
56 #define CAP_AUTOMOUNT 0x100 /* Read device at start to see what is there */
57 #define CAP_LABEL 0x200 /* Label blank tapes */
58 #define CAP_ANONVOLS 0x400 /* Mount without knowing volume name */
59 #define CAP_ALWAYSOPEN 0x800 /* always keep device open */
63 #define ST_OPENED 0x001 /* set when device opened */
64 #define ST_TAPE 0x002 /* is a tape device */
65 #define ST_LABEL 0x004 /* label found */
66 #define ST_MALLOC 0x008 /* dev packet malloc'ed in init_dev() */
67 #define ST_APPEND 0x010 /* ready for Bacula append */
68 #define ST_READ 0x020 /* ready for Bacula read */
69 #define ST_EOT 0x040 /* at end of tape */
70 #define ST_WEOT 0x080 /* Got EOT on write */
71 #define ST_EOF 0x100 /* Read EOF i.e. zero bytes */
72 #define ST_NEXTVOL 0x200 /* Start writing on next volume */
73 #define ST_SHORT 0x400 /* Short block read */
75 /* dev_blocked states (mutually exclusive) */
76 #define BST_NOT_BLOCKED 0 /* not blocked */
77 #define BST_UNMOUNTED 1 /* User unmounted device */
78 #define BST_WAITING_FOR_SYSOP 2 /* Waiting for operator to mount tape */
79 #define BST_DOING_ACQUIRE 3 /* Opening/validating/moving tape */
80 #define BST_WRITING_LABEL 4 /* Labeling a tape */
81 #define BST_UNMOUNTED_WAITING_FOR_SYSOP 5 /* Closed by user during mount request */
83 /* Volume Catalog Information structure definition */
84 typedef struct s_volume_catalog_info {
85 /* Media info for the current Volume */
86 uint32_t VolCatJobs; /* number of jobs on this Volume */
87 uint32_t VolCatFiles; /* Number of files */
88 uint32_t VolCatBlocks; /* Number of blocks */
89 uint64_t VolCatBytes; /* Number of bytes written */
90 uint32_t VolCatMounts; /* Number of mounts this volume */
91 uint32_t VolCatErrors; /* Number of errors this volume */
92 uint32_t VolCatWrites; /* Number of writes this volume */
93 uint32_t VolCatReads; /* Number of reads this volume */
94 uint64_t VolCatMaxBytes; /* max bytes to write */
95 uint64_t VolCatCapacityBytes; /* capacity estimate */
96 char VolCatStatus[20]; /* Volume status */
97 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
101 /* Device structure definition */
102 typedef struct s_device {
103 struct s_device *next; /* pointer to next open device */
104 pthread_mutex_t mutex; /* access control */
105 pthread_cond_t wait; /* thread wait variable */
106 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
107 pthread_t no_wait_id; /* this thread must not wait */
108 int dev_blocked; /* set if we must wait (i.e. change tape) */
109 int num_waiting; /* number of threads waiting */
110 int num_writers; /* number of writing threads */
111 int use_count; /* usage count on this device */
112 int fd; /* file descriptor */
113 int capabilities; /* capabilities mask */
114 int state; /* state mask */
115 int dev_errno; /* Our own errno */
116 int mode; /* read/write modes */
117 char *dev_name; /* device name */
118 char *errmsg; /* nicely edited error message */
119 uint32_t block_num; /* current block number base 0 */
120 uint32_t file; /* current file number base 0 */
121 uint32_t LastBlockNumWritten; /* last block written */
122 uint32_t min_block_size; /* min block size */
123 uint32_t max_block_size; /* max block size */
124 uint32_t max_volume_jobs; /* max jobs to put on one volume */
125 int64_t max_volume_files; /* max files to put on one volume */
126 int64_t max_volume_size; /* max bytes to put on one volume */
127 int64_t max_file_size; /* max file size in bytes */
128 int64_t volume_capacity; /* advisory capacity */
129 uint32_t max_rewind_wait; /* max secs to allow for rewind */
130 void *device; /* pointer to Device Resource */
132 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
133 struct Volume_Label VolHdr; /* Actual volume label */
141 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0cbn"
144 #define DEFAULT_TAPE_DRIVE "/dev/rmt0.1"
147 #define DEFAULT_TAPE_DRIVE "/dev/tps0d4nr"
150 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
153 #define DEFAULT_TAPE_DRIVE "/dev/nrmt0"
156 #define DEFAULT_TAPE_DRIVE "/dev/rmt/0hnb"
159 #define DEFAULT_TAPE_DRIVE "/dev/nrst0"
162 /* Default default */
163 #ifndef DEFAULT_TAPE_DRIVE
164 #define DEFAULT_TAPE_DRIVE "/dev/nst0"
167 /* Get some definition of function to position
168 * to the end of the medium in MTEOM. System
169 * dependent. Arrgggg!