2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
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
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.
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
23 Bacula® is a registered trademark of Kern Sibbald.
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.
29 * Definitions for using the Device functions in Bacula
30 * Tape and File storage access
37 * Some details of how volume and device reservations work
40 * set_in_use() volume being used on current drive
41 * clear_in_use() no longer being used. Can be re-used or moved.
42 * set_swapping() set volume being moved to another drive
43 * is_swapping() volume is being moved to another drive
44 * clear_swapping() volume normal
47 * set_load() set to load volume
48 * needs_load() volume must be loaded (i.e. set_load done)
49 * clear_load() load done.
50 * set_unload() set to unload volume
51 * needs_unload() volume must be unloaded
52 * clear_unload() volume unloaded
54 * reservations are temporary until the drive is acquired
55 * inc_reserved() increments num of reservations
56 * dec_reserved() decrements num of reservations
57 * num_reserved() number of reservations
60 * set_reserved() sets local reserve flag and calls dev->inc_reserved()
61 * clear_reserved() clears local reserve flag and calls dev->dec_reserved()
62 * is_reserved() returns local reserved flag
63 * unreserve_device() much more complete unreservation
71 #undef DCR /* used by Bacula */
73 /* Return values from wait_for_sysop() */
82 /* Arguments to open_dev() */
84 CREATE_READ_WRITE = 1,
96 B_VTAPE_DEV, /* change to B_TAPE_DEV after init */
100 /* Generic status bits returned from status_dev() */
101 #define BMT_TAPE (1<<0) /* is tape device */
102 #define BMT_EOF (1<<1) /* just read EOF */
103 #define BMT_BOT (1<<2) /* at beginning of tape */
104 #define BMT_EOT (1<<3) /* end of tape reached */
105 #define BMT_SM (1<<4) /* DDS setmark */
106 #define BMT_EOD (1<<5) /* DDS at end of data */
107 #define BMT_WR_PROT (1<<6) /* tape write protected */
108 #define BMT_ONLINE (1<<7) /* tape online */
109 #define BMT_DR_OPEN (1<<8) /* tape door open */
110 #define BMT_IM_REP_EN (1<<9) /* immediate report enabled */
113 /* Bits for device capabilities */
114 #define CAP_EOF (1<<0) /* has MTWEOF */
115 #define CAP_BSR (1<<1) /* has MTBSR */
116 #define CAP_BSF (1<<2) /* has MTBSF */
117 #define CAP_FSR (1<<3) /* has MTFSR */
118 #define CAP_FSF (1<<4) /* has MTFSF */
119 #define CAP_EOM (1<<5) /* has MTEOM */
120 #define CAP_REM (1<<6) /* is removable media */
121 #define CAP_RACCESS (1<<7) /* is random access device */
122 #define CAP_AUTOMOUNT (1<<8) /* Read device at start to see what is there */
123 #define CAP_LABEL (1<<9) /* Label blank tapes */
124 #define CAP_ANONVOLS (1<<10) /* Mount without knowing volume name */
125 #define CAP_ALWAYSOPEN (1<<11) /* always keep device open */
126 #define CAP_AUTOCHANGER (1<<12) /* AutoChanger */
127 #define CAP_OFFLINEUNMOUNT (1<<13) /* Offline before unmount */
128 #define CAP_STREAM (1<<14) /* Stream device */
129 #define CAP_BSFATEOM (1<<15) /* Backspace file at EOM */
130 #define CAP_FASTFSF (1<<16) /* Fast forward space file */
131 #define CAP_TWOEOF (1<<17) /* Write two eofs for EOM */
132 #define CAP_CLOSEONPOLL (1<<18) /* Close device on polling */
133 #define CAP_POSITIONBLOCKS (1<<19) /* Use block positioning */
134 #define CAP_MTIOCGET (1<<20) /* Basic support for fileno and blkno */
135 #define CAP_REQMOUNT (1<<21) /* Require mount/unmount */
136 #define CAP_CHECKLABELS (1<<22) /* Check for ANSI/IBM labels */
137 #define CAP_BLOCKCHECKSUM (1<<23) /* Create/test block checksum */
140 #define dev_state(dev, st_state) ((dev)->state & (st_state))
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 */
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 */
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 bool is_valid; /* set if this data is valid */
195 char VolCatStatus[20]; /* Volume status */
196 char VolCatName[MAX_NAME_LENGTH]; /* Desired volume to mount */
200 class DEVRES; /* Device resource defined in stored_conf.h */
201 class DCR; /* forward reference */
202 class VOLRES; /* forward reference */
205 * Device structure definition. There is one of these for
206 * each physical device. Everything here is "global" to
207 * that device and effects all jobs using the device.
211 int m_fd; /* file descriptor */
212 int m_blocked; /* set if we must wait (i.e. change tape) */
213 int m_count; /* Mutex use count -- DEBUG only */
214 int m_num_reserved; /* counter of device reservations */
215 int32_t m_slot; /* slot loaded in drive or -1 if none */
216 pthread_t m_pid; /* Thread that locked -- DEBUG only */
217 bool m_unload; /* set when Volume must be unloaded */
218 bool m_load; /* set when Volume must be loaded */
221 DEVICE * volatile swap_dev; /* Swap vol from this device */
222 dlist *attached_dcrs; /* attached DCR list */
223 bthread_mutex_t m_mutex; /* access control */
224 bthread_mutex_t spool_mutex; /* mutex for updating spool_size */
225 bthread_mutex_t acquire_mutex; /* mutex for acquire code */
226 pthread_cond_t wait; /* thread wait variable */
227 pthread_cond_t wait_next_vol; /* wait for tape to be mounted */
228 pthread_t no_wait_id; /* this thread must not wait */
229 int dev_prev_blocked; /* previous blocked state */
230 int num_waiting; /* number of threads waiting */
231 int num_writers; /* number of writing threads */
232 int capabilities; /* capabilities mask */
233 int state; /* state mask */
234 int dev_errno; /* Our own errno */
235 int mode; /* read/write modes */
236 int openmode; /* parameter passed to open_dev (useful to reopen the device) */
237 int dev_type; /* device type */
238 bool autoselect; /* Autoselect in autochanger */
239 bool initiated; /* set when init_dev() called */
240 int label_type; /* Bacula/ANSI/IBM label types */
241 uint32_t drive_index; /* Autochanger drive index (base 0) */
242 POOLMEM *dev_name; /* Physical device name */
243 POOLMEM *prt_name; /* Name used for display purposes */
244 char *errmsg; /* nicely edited error message */
245 uint32_t block_num; /* current block number base 0 */
246 uint32_t LastBlock; /* last DEV_BLOCK number written to Volume */
247 uint32_t file; /* current file number base 0 */
248 uint64_t file_addr; /* Current file read/write address */
249 uint64_t file_size; /* Current file size */
250 uint32_t EndBlock; /* last block written */
251 uint32_t EndFile; /* last file written */
252 uint32_t min_block_size; /* min block size */
253 uint32_t max_block_size; /* max block size */
254 uint64_t max_volume_size; /* max bytes to put on one volume */
255 uint64_t max_file_size; /* max file size to put in one file on volume */
256 uint64_t max_concurrent_jobs; /* maximum simultaneous jobs this drive */
257 uint64_t volume_capacity; /* advisory capacity */
258 uint64_t max_spool_size; /* maximum spool file size */
259 uint64_t spool_size; /* current spool size for this device */
260 uint32_t max_rewind_wait; /* max secs to allow for rewind */
261 uint32_t max_open_wait; /* max secs to allow for open */
262 uint32_t max_open_vols; /* max simultaneous open volumes */
264 uint64_t max_part_size; /* max part size */
265 uint64_t part_size; /* current part size */
266 uint32_t part; /* current part number (starts at 0) */
267 uint64_t part_start; /* current part start address (relative to the whole volume) */
268 uint32_t num_dvd_parts; /* number of parts WRITTEN on the DVD */
269 /* state ST_FREESPACE_OK is set if free_space is valid */
270 uint64_t free_space; /* current free space on medium (without the current part) */
271 int free_space_errno; /* indicates errno getting freespace */
272 bool truncating; /* if set, we are currently truncating the DVD */
273 bool blank_dvd; /* if set, we have a blank DVD in the drive */
276 utime_t vol_poll_interval; /* interval between polling Vol mount */
277 DEVRES *device; /* pointer to Device Resource */
278 VOLRES *vol; /* Pointer to Volume reservation item */
279 btimer_t *tid; /* timer id */
281 VOLUME_CAT_INFO VolCatInfo; /* Volume Catalog Information */
282 VOLUME_LABEL VolHdr; /* Actual volume label */
283 char pool_name[MAX_NAME_LENGTH]; /* pool name */
284 char pool_type[MAX_NAME_LENGTH]; /* pool type */
286 char UnloadVolName[MAX_NAME_LENGTH]; /* Last wrong Volume mounted */
287 bool poll; /* set to poll Volume */
288 /* Device wait times ***FIXME*** look at durations */
296 btime_t last_timer; /* used by read/write/seek to get stats (usec) */
297 btime_t last_tick; /* contains last read/write time (usec) */
300 btime_t DevWriteTime;
301 uint64_t DevWriteBytes;
302 uint64_t DevReadBytes;
305 btime_t get_timer_count(); /* return the last timer interval (ms) */
307 int has_cap(int cap) const { return capabilities & cap; }
308 void clear_cap(int cap) { capabilities &= ~cap; }
309 void set_cap(int cap) { capabilities |= cap; }
310 bool do_checksum() const { return (capabilities & CAP_BLOCKCHECKSUM) != 0; }
311 int is_autochanger() const { return capabilities & CAP_AUTOCHANGER; }
312 int requires_mount() const { return capabilities & CAP_REQMOUNT; }
313 int is_removable() const { return capabilities & CAP_REM; }
314 int is_tape() const { return (dev_type == B_TAPE_DEV ||
315 dev_type == B_VTAPE_DEV); }
316 int is_file() const { return dev_type == B_FILE_DEV; }
317 int is_fifo() const { return dev_type == B_FIFO_DEV; }
318 int is_dvd() const { return dev_type == B_DVD_DEV; }
319 int is_vtl() const { return dev_type == B_VTL_DEV; }
320 int is_vtape() const { return dev_type == B_VTAPE_DEV; }
321 int is_open() const { return m_fd >= 0; }
322 int is_offline() const { return state & ST_OFFLINE; }
323 int is_labeled() const { return state & ST_LABEL; }
324 int is_mounted() const { return state & ST_MOUNTED; }
325 int is_unmountable() const { return (is_dvd() || (is_file() && is_removable())); }
326 int num_reserved() const { return m_num_reserved; };
327 int is_part_spooled() const { return state & ST_PART_SPOOLED; }
328 int have_media() const { return state & ST_MEDIA; }
329 int is_short_block() const { return state & ST_SHORT; }
330 int is_busy() const { return (state & ST_READ) || num_writers || num_reserved(); }
331 int at_eof() const { return state & ST_EOF; }
332 int at_eot() const { return state & ST_EOT; }
333 int at_weot() const { return state & ST_WEOT; }
334 int can_append() const { return state & ST_APPEND; }
335 int is_freespace_ok() const { return state & ST_FREESPACE_OK; }
337 * can_write() is meant for checking at the end of a job to see
338 * if we still have a tape (perhaps not if at end of tape
339 * and the job is canceled).
341 int can_write() const { return is_open() && can_append() &&
342 is_labeled() && !at_weot(); }
343 int can_read() const { return state & ST_READ; }
344 bool can_steal_lock() const { return m_blocked &&
345 (m_blocked == BST_UNMOUNTED ||
346 m_blocked == BST_WAITING_FOR_SYSOP ||
347 m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
348 bool waiting_for_mount() const { return
349 (m_blocked == BST_UNMOUNTED ||
350 m_blocked == BST_WAITING_FOR_SYSOP ||
351 m_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP); };
352 bool must_unload() const { return m_unload; };
353 bool must_load() const { return m_load; };
354 const char *strerror() const;
355 const char *archive_name() const;
356 const char *name() const;
357 const char *print_name() const; /* Name for display purposes */
358 void set_ateof(); /* in dev.c */
359 void set_ateot(); /* in dev.c */
360 void set_eot() { state |= ST_EOT; };
361 void set_eof() { state |= ST_EOF; };
362 void set_append() { state |= ST_APPEND; };
363 void set_labeled() { state |= ST_LABEL; };
364 inline void set_read() { state |= ST_READ; };
365 void set_offline() { state |= ST_OFFLINE; };
366 void set_mounted() { state |= ST_MOUNTED; };
367 void set_media() { state |= ST_MEDIA; };
368 void set_short_block() { state |= ST_SHORT; };
369 void set_freespace_ok() { state |= ST_FREESPACE_OK; }
370 void set_part_spooled(int val) { if (val) state |= ST_PART_SPOOLED; \
371 else state &= ~ST_PART_SPOOLED;
373 bool is_volume_to_unload() const { \
374 return m_unload && strcmp(VolHdr.VolumeName, UnloadVolName) == 0; };
375 void set_load() { m_load = true; };
376 void inc_reserved() { m_num_reserved++; }
377 void set_mounted(int val) { if (val) state |= ST_MOUNTED; \
378 else state &= ~ST_MOUNTED; };
379 void dec_reserved() { m_num_reserved--; ASSERT(m_num_reserved>=0); };
380 void clear_append() { state &= ~ST_APPEND; };
381 void clear_read() { state &= ~ST_READ; };
382 void clear_labeled() { state &= ~ST_LABEL; };
383 void clear_offline() { state &= ~ST_OFFLINE; };
384 void clear_eot() { state &= ~ST_EOT; };
385 void clear_eof() { state &= ~ST_EOF; };
386 void clear_opened() { m_fd = -1; };
387 void clear_mounted() { state &= ~ST_MOUNTED; };
388 void clear_media() { state &= ~ST_MEDIA; };
389 void clear_short_block() { state &= ~ST_SHORT; };
390 void clear_freespace_ok() { state &= ~ST_FREESPACE_OK; };
391 void clear_unload() { m_unload = false; UnloadVolName[0] = 0; };
392 void clear_load() { m_load = false; };
393 char *bstrerror(void) { return errmsg; };
394 char *print_errmsg() { return errmsg; };
395 int32_t get_slot() const { return m_slot; };
396 void setVolCatInfo(bool valid) { VolCatInfo.is_valid = valid; };
397 bool haveVolCatInfo() const { return VolCatInfo.is_valid; };
398 void setVolCatName(const char *name) {
399 bstrncpy(VolCatInfo.VolCatName, name, sizeof(VolCatInfo.VolCatName));
400 setVolCatInfo(false);
402 char *getVolCatName() { return VolCatInfo.VolCatName; };
404 void set_unload(); /* in dev.c */
405 void clear_volhdr(); /* in dev.c */
406 void close(); /* in dev.c */
407 void close_part(DCR *dcr); /* in dev.c */
408 bool truncate(DCR *dcr); /* in dev.c */
409 int open(DCR *dcr, int mode); /* in dev.c */
410 void term(void); /* in dev.c */
411 ssize_t read(void *buf, size_t len); /* in dev.c */
412 ssize_t write(const void *buf, size_t len); /* in dev.c */
413 bool rewind(DCR *dcr); /* in dev.c */
414 bool mount(int timeout); /* in dev.c */
415 bool unmount(int timeout); /* in dev.c */
416 void edit_mount_codes(POOL_MEM &omsg, const char *imsg); /* in dev.c */
417 bool offline_or_rewind(); /* in dev.c */
418 bool offline(); /* in dev.c */
419 bool bsf(int count); /* in dev.c */
420 bool eod(DCR *dcr); /* in dev.c */
421 bool fsr(int num); /* in dev.c */
422 bool fsf(int num); /* in dev.c */
423 bool bsr(int num); /* in dev.c */
424 bool weof(int num); /* in dev.c */
425 void lock_door(); /* in dev.c */
426 void unlock_door(); /* in dev.c */
427 int32_t get_os_tape_file(); /* in dev.c */
428 bool scan_dir_for_volume(DCR *dcr); /* in scan.c */
429 bool reposition(DCR *dcr, uint32_t rfile, uint32_t rblock); /* in dev.c */
430 void clrerror(int func); /* in dev.c */
431 boffset_t lseek(DCR *dcr, boffset_t offset, int whence); /* in dev.c */
432 bool update_pos(DCR *dcr); /* in dev.c */
433 void set_slot(int32_t slot); /* in dev.c */
434 void clear_slot(); /* in dev.c */
437 bool update_freespace(); /* in dvd.c */
439 uint32_t get_file() const { return file; };
440 uint32_t get_block_num() const { return block_num; };
441 int fd() const { return m_fd; };
443 /* low level operations */
445 int (*d_open)(const char *pathname, int flags, ...);
446 int (*d_close)(int fd);
447 int (*d_ioctl)(int fd, ioctl_req_t request, ...);
448 ssize_t (*d_read)(int fd, void *buffer, size_t count);
449 ssize_t (*d_write)(int fd, const void *buffer, size_t count);
452 * Locking and blocking calls
455 void _r_dlock(const char *, int, bool locked=false); /* in lock.c */
456 void _r_dunlock(const char *, int); /* in lock.c */
457 void _dlock(const char *, int); /* in lock.c */
458 void _dunlock(const char *, int); /* in lock.c */
460 void r_dlock(bool locked=false); /* in lock.c */
461 void r_dunlock() { dunlock(); }
462 void dlock() { P(m_mutex); }
463 void dunlock() { V(m_mutex); }
465 void dblock(int why); /* in lock.c */
466 void dunblock(bool locked=false); /* in lock.c */
467 bool is_device_unmounted(); /* in lock.c */
468 void set_blocked(int block) { m_blocked = block; };
469 int blocked() const { return m_blocked; };
470 bool is_blocked() const { return m_blocked != BST_NOT_BLOCKED; };
471 const char *print_blocked() const; /* in dev.c */
474 bool do_tape_mount(int mount, int dotimeout); /* in dev.c */
475 bool do_file_mount(int mount, int dotimeout); /* in dev.c */
476 void set_mode(int omode); /* in dev.c */
477 void open_tape_device(DCR *dcr, int omode); /* in dev.c */
478 void open_file_device(DCR *dcr, int omode); /* in dev.c */
479 void open_dvd_device(DCR *dcr, int omode); /* in dev.c */
482 inline const char *DEVICE::strerror() const { return errmsg; }
483 inline const char *DEVICE::archive_name() const { return dev_name; }
484 inline const char *DEVICE::print_name() const { return prt_name; }
487 * Device Context (or Control) Record.
488 * There is one of these records for each Job that is using
489 * the device. Items in this record are "local" to the Job and
490 * do not affect other Jobs. Note, a job can have multiple
491 * DCRs open, each pointing to a different device.
492 * Normally, there is only one JCR thread per DCR. However, the
493 * big and important exception to this is when a Job is being
494 * canceled. At that time, there may be two threads using the
495 * same DCR. Consequently, when creating/attaching/detaching
496 * and freeing the DCR we must lock it (m_mutex).
500 bool m_dev_locked; /* set if dev already locked */
501 bool m_reserved; /* set if reserved device */
502 bool m_found_in_use; /* set if a volume found in use */
505 dlink dev_link; /* link to attach to dev */
506 JCR *jcr; /* pointer to JCR */
507 bthread_mutex_t m_mutex; /* access control */
508 DEVICE * volatile dev; /* pointer to device */
509 DEVRES *device; /* pointer to device resource */
510 DEV_BLOCK *block; /* pointer to block */
511 DEV_RECORD *rec; /* pointer to record */
512 pthread_t tid; /* Thread running this dcr */
513 int spool_fd; /* fd if spooling */
514 bool spool_data; /* set to spool data */
515 bool spooling; /* set when actually spooling */
516 bool despooling; /* set when despooling */
517 bool despool_wait; /* waiting for despooling */
518 bool NewVol; /* set if new Volume mounted */
519 bool WroteVol; /* set if Volume written */
520 bool NewFile; /* set when EOF written */
521 bool reserved_volume; /* set if we reserved a volume */
522 bool any_volume; /* Any OK for dir_find_next... */
523 bool attached_to_dev; /* set when attached to dev */
524 bool keep_dcr; /* do not free dcr in release_dcr */
525 uint32_t VolFirstIndex; /* First file index this Volume */
526 uint32_t VolLastIndex; /* Last file index this Volume */
527 uint32_t FileIndex; /* Current File Index */
528 uint32_t EndFile; /* End file written */
529 uint32_t StartFile; /* Start write file */
530 uint32_t StartBlock; /* Start write block */
531 uint32_t EndBlock; /* Ending block written */
532 int64_t VolMediaId; /* MediaId */
533 int64_t job_spool_size; /* Current job spool size */
534 int64_t max_job_spool_size; /* Max job spool size */
535 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
536 char pool_name[MAX_NAME_LENGTH]; /* pool name */
537 char pool_type[MAX_NAME_LENGTH]; /* pool type */
538 char media_type[MAX_NAME_LENGTH]; /* media type */
539 char dev_name[MAX_NAME_LENGTH]; /* dev name */
540 int Copy; /* identical copy number */
541 int Stripe; /* RAIT stripe */
542 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
545 bool found_in_use() const { return m_found_in_use; };
546 void set_found_in_use() { m_found_in_use = true; };
547 void clear_found_in_use() { m_found_in_use = false; };
548 bool is_reserved() const { return m_reserved; };
549 bool is_dev_locked() { return m_dev_locked; }
551 void _dlock(const char *, int); /* in lock.c */
552 void _dunlock(const char *, int); /* in lock.c */
554 void dlock() { dev->dlock(); m_dev_locked = true; }
555 void dunlock() { m_dev_locked = false; dev->dunlock(); }
557 void dblock(int why) { dev->dblock(why); }
558 void setVolCatInfo(bool valid) { VolCatInfo.is_valid = valid; };
559 bool haveVolCatInfo() const { return VolCatInfo.is_valid; };
560 void setVolCatName(const char *name) {
561 bstrncpy(VolCatInfo.VolCatName, name, sizeof(VolCatInfo.VolCatName));
562 setVolCatInfo(false);
564 char *getVolCatName() { return VolCatInfo.VolCatName; };
567 /* Methods in reserve.c */
568 void clear_reserved();
570 void unreserve_device();
572 /* Methods in vol_mgr.c */
573 bool can_i_use_volume();
574 bool can_i_write_volume();
576 /* Methods in mount.c */
577 bool mount_next_write_volume();
578 bool mount_next_read_volume();
579 void mark_volume_in_error();
580 void mark_volume_not_inchanger();
581 int try_autolabel(bool opened);
582 bool find_a_volume();
583 bool is_suitable_volume_mounted();
585 int check_volume_label(bool &ask, bool &autochanger);
586 void release_volume();
587 void do_swapping(bool is_writing);
589 bool do_load(bool is_writing);
590 bool is_tape_position_ok();
594 * Volume reservation class -- see reserve.c
597 bool m_swapping; /* set when swapping to another drive */
598 bool m_in_use; /* set when volume reserved or in use */
599 int32_t m_slot; /* slot of swapping volume */
600 uint32_t m_JobId; /* JobId for read volumes */
603 char *vol_name; /* Volume name */
604 DEVICE *dev; /* Pointer to device to which we are attached */
606 bool is_swapping() const { return m_swapping; };
607 void set_swapping() { m_swapping = true; };
608 void clear_swapping() { m_swapping = false; };
609 bool is_in_use() const { return m_in_use; };
610 void set_in_use() { m_in_use = true; };
611 void clear_in_use() { m_in_use = false; };
612 void set_slot(int32_t slot) { m_slot = slot; };
613 void clear_slot() { m_slot = -1; };
614 int32_t get_slot() const { return m_slot; };
615 uint32_t get_jobid() const { return m_JobId; };
616 void set_jobid(uint32_t JobId) { m_JobId = JobId; };
620 /* Get some definition of function to position
621 * to the end of the medium in MTEOM. System
622 * dependent. Arrgggg!