X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=bacula%2Fsrc%2Fstored%2Fprotos.h;h=c25b1f8d81fa75c932d7cec5ecf709cb5a28de4b;hb=bc9b9b481e86991abd879d30aa03b64b4c68d578;hp=6898968a29311199d8f2627c68c9e2d6e6c16dc3;hpb=59590d7772cb9bd8167ef526a0d3ef9bb10b1111;p=bacula%2Fbacula diff --git a/bacula/src/stored/protos.h b/bacula/src/stored/protos.h index 6898968a29..c25b1f8d81 100644 --- a/bacula/src/stored/protos.h +++ b/bacula/src/stored/protos.h @@ -1,38 +1,47 @@ /* - * Protypes for stored - * - * Version $Id$ - */ + Bacula® - The Network Backup Solution -/* - Copyright (C) 2000-2004 Kern Sibbald and John Walker + Copyright (C) 2000-2007 Free Software Foundation Europe e.V. - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of - the License, or (at your option) any later version. + The main author of Bacula is Kern Sibbald, with contributions from + many others, a complete list can be found in the file AUTHORS. + This program is Free Software; you can redistribute it and/or + modify it under the terms of version two of the GNU General Public + License as published by the Free Software Foundation and included + in the file LICENSE. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - You should have received a copy of the GNU General Public - License along with this program; if not, write to the Free - Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, - MA 02111-1307, USA. + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301, USA. + Bacula® is a registered trademark of John Walker. + The licensor of Bacula is the Free Software Foundation Europe + (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich, + Switzerland, email:ftf@fsfeurope.org. +*/ +/* + * Protypes for stored -- Kern Sibbald MM + * + * Version $Id$ */ - + /* From stored.c */ uint32_t new_VolSessionId(); /* From acquire.c */ -DCR *acquire_device_for_append(JCR *jcr); -DCR *acquire_device_for_read(JCR *jcr); -bool release_device(JCR *jcr); -DCR *new_dcr(JCR *jcr, DEVICE *dev); +DCR *acquire_device_for_append(DCR *dcr); +bool acquire_device_for_read(DCR *dcr); +bool release_device(DCR *dcr); +bool clean_device(DCR *dcr); +DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev); void free_dcr(DCR *dcr); +void detach_dcr_from_dev(DCR *dcr); /* From askdir.c */ enum get_vol_info_rw { @@ -41,17 +50,27 @@ enum get_vol_info_rw { }; bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw); bool dir_find_next_appendable_volume(DCR *dcr); -bool dir_update_volume_info(DCR *dcr, bool label); +bool dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten); bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr); -bool dir_ask_sysop_to_mount_volume(DCR *dcr); +bool dir_ask_sysop_to_mount_volume(DCR *dcr, int mode); bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec); bool dir_send_job_status(JCR *jcr); bool dir_create_jobmedia_record(DCR *dcr); +bool dir_update_device(JCR *jcr, DEVICE *dev); +bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer); /* authenticate.c */ int authenticate_director(JCR *jcr); int authenticate_filed(JCR *jcr); +/* From autochanger.c */ +bool init_autochangers(); +int autoload_device(DCR *dcr, int writing, BSOCK *dir); +bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd); +bool unload_autochanger(DCR *dcr, int loaded); +char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd); +int get_autochanger_loaded_slot(DCR *dcr); + /* From block.c */ void dump_block(DEV_BLOCK *b, const char *msg); DEV_BLOCK *new_block(DEVICE *dev); @@ -59,157 +78,218 @@ DEV_BLOCK *dup_block(DEV_BLOCK *eblock); void init_block_write(DEV_BLOCK *block); void empty_block(DEV_BLOCK *block); void free_block(DEV_BLOCK *block); -bool write_block_to_device(DCR *dcr, DEV_BLOCK *block); -bool write_block_to_dev(DCR *dcr, DEV_BLOCK *block); +bool write_block_to_device(DCR *dcr); +bool write_block_to_dev(DCR *dcr); void print_block_read_errors(JCR *jcr, DEV_BLOCK *block); void ser_block_header(DEV_BLOCK *block); #define CHECK_BLOCK_NUMBERS true #define NO_BLOCK_NUMBER_CHECK false -bool read_block_from_device(DCR *dcr, DEV_BLOCK *block, bool check_block_numbers); -bool read_block_from_dev(DCR *dcr, DEV_BLOCK *block, bool check_block_numbers); +bool read_block_from_device(DCR *dcr, bool check_block_numbers); +bool read_block_from_dev(DCR *dcr, bool check_block_numbers); /* From butil.c -- utilities for SD tool programs */ void print_ls_output(const char *fname, const char *link, int type, struct stat *statp); -JCR *setup_jcr(const char *name, const char * device, BSR *bsr, const char *VolumeName); -DEVICE *setup_to_access_device(JCR *jcr, int read_access); +JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr, + const char *VolumeName, int mode); void display_tape_error_status(JCR *jcr, DEVICE *dev); -DEVRES *find_device_res(char *device_name, int read_access); /* From dev.c */ -DEVICE *init_dev(DEVICE *dev, DEVRES *device); -int open_dev(DEVICE *dev, char *VolName, int mode); -void close_dev(DEVICE *dev); -void force_close_dev(DEVICE *dev); -bool truncate_dev(DEVICE *dev); -void term_dev(DEVICE *dev); -char * strerror_dev(DEVICE *dev); -void clrerror_dev(DEVICE *dev, int func); -bool update_pos_dev(DEVICE *dev); -int rewind_dev(DEVICE *dev); +DEVICE *init_dev(JCR *jcr, DEVRES *device); +bool can_open_mounted_dev(DEVICE *dev); bool load_dev(DEVICE *dev); -bool offline_dev(DEVICE *dev); -int flush_dev(DEVICE *dev); -int weof_dev(DEVICE *dev, int num); int write_block(DEVICE *dev); -int write_dev(DEVICE *dev, char *buf, size_t len); -int read_dev(DEVICE *dev, char *buf, size_t len); uint32_t status_dev(DEVICE *dev); -int eod_dev(DEVICE *dev); -bool fsf_dev(DEVICE *dev, int num); -bool fsr_dev(DEVICE *dev, int num); -bool bsf_dev(DEVICE *dev, int num); -bool bsr_dev(DEVICE *dev, int num); void attach_jcr_to_device(DEVICE *dev, JCR *jcr); void detach_jcr_from_device(DEVICE *dev, JCR *jcr); JCR *next_attached_jcr(DEVICE *dev, JCR *jcr); -bool dev_can_write(DEVICE *dev); -int offline_or_rewind_dev(DEVICE *dev); -bool reposition_dev(DEVICE *dev, uint32_t file, uint32_t block); -void init_dev_wait_timers(DEVICE *dev); +void init_device_wait_timers(DCR *dcr); +void init_jcr_device_wait_timers(JCR *jcr); bool double_dev_wait_time(DEVICE *dev); - /* Get info about device */ -char * dev_name(DEVICE *dev); char * dev_vol_name(DEVICE *dev); -uint32_t dev_block(DEVICE *dev); -uint32_t dev_file(DEVICE *dev); -bool dev_is_tape(DEVICE *dev); + +/* From dvd.c */ +int dvd_open_next_part(DCR *dcr); +bool dvd_write_part(DCR *dcr); +bool dvd_close_job(DCR *dcr); +void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name); +void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name); +bool truncate_dvd(DCR *dcr); +bool check_can_write_on_non_blank_dvd(DCR *dcr); +int find_num_dvd_parts(DCR *dcr); +boffset_t lseek_dvd(DCR *dcr, boffset_t offset, int whence); +void dvd_remove_empty_part(DCR *dcr); /* From device.c */ -bool open_device(JCR *jcr, DEVICE *dev); -bool first_open_device(DEVICE *dev); -bool fixup_device_block_write_error(DCR *dcr, DEV_BLOCK *block); -void _lock_device(const char *file, int line, DEVICE *dev); -void _unlock_device(const char *file, int line, DEVICE *dev); -void _block_device(const char *file, int line, DEVICE *dev, int state); -void _unblock_device(const char *file, int line, DEVICE *dev); -void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state); -void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold); +bool open_device(DCR *dcr); +bool first_open_device(DCR *dcr); +bool fixup_device_block_write_error(DCR *dcr); +void set_start_vol_position(DCR *dcr); void set_new_volume_parameters(DCR *dcr); void set_new_file_parameters(DCR *dcr); -bool device_is_unmounted(DEVICE *dev); -void dev_lock(DEVICE *dev); -void dev_unlock(DEVICE *dev); -const char *edit_blocked_reason(DEVICE *dev); +bool is_device_unmounted(DEVICE *dev); /* From dircmd.c */ -void *handle_connection_request(void *arg); +void *handle_connection_request(void *arg); /* From fd_cmds.c */ void run_job(JCR *jcr); +bool get_bootstrap_file(JCR *jcr, BSOCK *bsock); +void do_fd_commands(JCR *jcr); /* From job.c */ void stored_free_jcr(JCR *jcr); -void connection_from_filed(void *arg); +void connection_from_filed(void *arg); void handle_filed_connection(BSOCK *fd, char *job_name); /* From label.c */ -int read_dev_volume_label(DCR *dcr, DEV_BLOCK *block); +int read_dev_volume_label(DCR *dcr); +int read_dvd_volume_label(DCR *dcr, bool write); void create_session_label(DCR *dcr, DEV_RECORD *rec, int label); -void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName); -bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName); -bool write_session_label(DCR *dcr, DEV_BLOCK *block, int label); -bool write_volume_label_to_block(DCR *dcr, DEV_BLOCK *block); +void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow); +bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, + const char *PoolName, bool relabel, bool dvdnow); +#define ANSI_VOL_LABEL 0 +#define ANSI_EOF_LABEL 1 +#define ANSI_EOV_LABEL 2 +bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName); +int read_ansi_ibm_label(DCR *dcr); +bool write_session_label(DCR *dcr, int label); +bool write_volume_label_to_block(DCR *dcr); +bool rewrite_volume_label(DCR *dcr, bool recycle); void dump_volume_label(DEVICE *dev); void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose); bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec); bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec); +/* From locks.c */ +void _lock_device(const char *file, int line, DEVICE *dev); +void _unlock_device(const char *file, int line, DEVICE *dev); +void _block_device(const char *file, int line, DEVICE *dev, int state); +void _unblock_device(const char *file, int line, DEVICE *dev); +void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state); +void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold); + + /* From match_bsr.c */ -int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec, +int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec, SESSION_LABEL *sesrec); int match_bsr_block(BSR *bsr, DEV_BLOCK *block); void position_bsr_block(BSR *bsr, DEV_BLOCK *block); BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev); -bool match_set_eof(BSR *bsr, DEV_RECORD *rec); +bool is_this_bsr_done(BSR *bsr, DEV_RECORD *rec); /* From mount.c */ -bool mount_next_write_volume(DCR *dcr, DEV_BLOCK *block, bool release); -bool mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block); -void release_volume(JCR *jcr, DEVICE *dev); -void mark_volume_in_error(JCR *jcr, DEVICE *dev); - -/* From autochanger.c */ -int autoload_device(DCR *dcr, int writing, BSOCK *dir); -bool autochanger_list(DCR *dcr, BSOCK *dir); -void invalidate_slot_in_catalog(DCR *dcr); -char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd); - +bool mount_next_write_volume(DCR *dcr, bool have_vol, bool release); +bool mount_next_read_volume(DCR *dcr); +void mark_volume_in_error(DCR *dcr); /* From parse_bsr.c */ BSR *parse_bsr(JCR *jcr, char *lf); void dump_bsr(BSR *bsr, bool recurse); void free_bsr(BSR *bsr); -VOL_LIST *new_vol(); -int add_vol(JCR *jcr, VOL_LIST *vol); -void free_vol_list(JCR *jcr); -void create_vol_list(JCR *jcr); +VOL_LIST *new_restore_volume(); +int add_restore_volume(JCR *jcr, VOL_LIST *vol); +void free_restore_volume_list(JCR *jcr); +void create_restore_volume_list(JCR *jcr); /* From record.c */ -const char *FI_to_ascii(int fi); -const char *stream_to_ascii(int stream, int fi); -int write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec); -int can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec); -int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec); +const char *FI_to_ascii(char *buf, int fi); +const char *stream_to_ascii(char *buf, int stream, int fi); +bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec); +bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec); +bool read_record_from_block(DCR *dcr, DEV_BLOCK *block, DEV_RECORD *rec); DEV_RECORD *new_record(); -void free_record(DEV_RECORD *rec); +void free_record(DEV_RECORD *rec); +void empty_record(DEV_RECORD *rec); /* From read_record.c */ bool read_records(DCR *dcr, - bool record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec), - bool mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)); + bool record_cb(DCR *dcr, DEV_RECORD *rec), + bool mount_cb(DCR *dcr)); + +/* From reserve.c */ +void init_reservations_lock(); +void term_reservations_lock(); +void _lock_reservations(); +void _unlock_reservations(); +void _lock_volumes(); +void _unlock_volumes(); +void release_volume(DCR *dcr); +VOLRES *reserve_volume(DCR *dcr, const char *VolumeName); +VOLRES *find_volume(const char *VolumeName); +bool free_volume(DEVICE *dev); +void unreserve_device(DCR *dcr); +bool volume_unused(DCR *dcr); +void create_volume_list(); +void free_volume_list(); +void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg); +bool is_volume_in_use(DCR *dcr); +void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg); +bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx); +int search_res_for_device(RCTX &rctx); +void release_reserve_messages(JCR *jcr); + +extern int reservations_lock_count; +extern int vol_list_lock_count; + +#ifdef SD_DEBUG_LOCK + +#define lock_reservations() \ + do { Dmsg4(sd_dbglvl, "lock_reservations at %s:%d precnt=%d JobId=%u\n", \ + __FILE__, __LINE__, \ + reservations_lock_count, get_jobid_from_tid(pthread_self())); \ + _lock_reservations(); \ + Dmsg1(sd_dbglvl, "lock_reservations: got lock JobId=%u\n", \ + get_jobid_from_tid(pthread_self())); \ + } while (0) +#define unlock_reservations() \ + do { Dmsg4(sd_dbglvl, "unlock_reservations at %s:%d precnt=%d JobId=%u\n", \ + __FILE__, __LINE__, \ + reservations_lock_count, get_jobid_from_tid(pthread_self())); \ + _unlock_reservations(); } while (0) + +#define lock_volumes() \ + do { Dmsg4(sd_dbglvl, "lock_volumes at %s:%d precnt=%d JobId=%u\n", \ + __FILE__, __LINE__, \ + vol_list_lock_count, get_jobid_from_tid(pthread_self())); \ + _lock_volumes(); \ + Dmsg1(sd_dbglvl, "lock_volumes: got lock JobId=%u\n", \ + get_jobid_from_tid(pthread_self())); \ + } while (0) + +#define unlock_volumes() \ + do { Dmsg4(sd_dbglvl, "unlock_volumes at %s:%d precnt=%d JobId=%u\n", \ + __FILE__, __LINE__, \ + vol_list_lock_count, get_jobid_from_tid(pthread_self())); \ + _unlock_volumes(); } while (0) + +#else + +#define lock_reservations() _lock_reservations() +#define unlock_reservations() _unlock_reservations() +#define lock_volumes() _lock_volumes() +#define unlock_volumes() _unlock_volumes() + +#endif + + /* From spool.c */ -bool begin_data_spool (JCR *jcr); -bool discard_data_spool (JCR *jcr); -bool commit_data_spool (JCR *jcr); +bool begin_data_spool (DCR *dcr); +bool discard_data_spool (DCR *dcr); +bool commit_data_spool (DCR *dcr); bool are_attributes_spooled (JCR *jcr); bool begin_attribute_spool (JCR *jcr); bool discard_attribute_spool (JCR *jcr); bool commit_attribute_spool (JCR *jcr); -bool write_block_to_spool_file (DCR *dcr, DEV_BLOCK *block); -void list_spool_stats (BSOCK *bs); +bool write_block_to_spool_file (DCR *dcr); +void list_spool_stats (void sendit(const char *msg, int len, void *sarg), void *arg); + +/* From wait.c */ +int wait_for_sysop(DCR *dcr); +bool wait_for_device(JCR *jcr, int &retries);