7 Copyright (C) 2000-2006 Kern Sibbald
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License
11 version 2 as amended with additional clauses defined in the
12 file LICENSE in the main source directory.
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
17 the file LICENSE for additional details.
22 uint32_t new_VolSessionId();
25 DCR *acquire_device_for_append(DCR *dcr);
26 DCR *acquire_device_for_read(DCR *dcr);
27 bool release_device(DCR *dcr);
28 DCR *new_dcr(JCR *jcr, DEVICE *dev);
29 void free_dcr(DCR *dcr);
32 enum get_vol_info_rw {
33 GET_VOL_INFO_FOR_WRITE,
36 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
37 bool dir_find_next_appendable_volume(DCR *dcr);
38 bool dir_update_volume_info(DCR *dcr, bool label);
39 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
40 bool dir_ask_sysop_to_mount_volume(DCR *dcr);
41 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
42 bool dir_send_job_status(JCR *jcr);
43 bool dir_create_jobmedia_record(DCR *dcr);
44 bool dir_update_device(JCR *jcr, DEVICE *dev);
45 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer);
48 int authenticate_director(JCR *jcr);
49 int authenticate_filed(JCR *jcr);
51 /* From autochanger.c */
52 bool init_autochangers();
53 int autoload_device(DCR *dcr, int writing, BSOCK *dir);
54 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
55 bool unload_autochanger(DCR *dcr, int loaded);
56 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
57 int get_autochanger_loaded_slot(DCR *dcr);
60 void dump_block(DEV_BLOCK *b, const char *msg);
61 DEV_BLOCK *new_block(DEVICE *dev);
62 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
63 void init_block_write(DEV_BLOCK *block);
64 void empty_block(DEV_BLOCK *block);
65 void free_block(DEV_BLOCK *block);
66 bool write_block_to_device(DCR *dcr);
67 bool write_block_to_dev(DCR *dcr);
68 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
69 void ser_block_header(DEV_BLOCK *block);
71 #define CHECK_BLOCK_NUMBERS true
72 #define NO_BLOCK_NUMBER_CHECK false
73 bool read_block_from_device(DCR *dcr, bool check_block_numbers);
74 bool read_block_from_dev(DCR *dcr, bool check_block_numbers);
76 /* From butil.c -- utilities for SD tool programs */
77 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
78 JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr,
79 const char *VolumeName, int mode);
80 void display_tape_error_status(JCR *jcr, DEVICE *dev);
84 DEVICE *init_dev(JCR *jcr, DEVRES *device);
85 off_t lseek_dev(DEVICE *dev, off_t offset, int whence);
86 bool can_open_mounted_dev(DEVICE *dev);
87 bool truncate_dev(DCR *dcr);
88 void term_dev(DEVICE *dev);
89 char * strerror_dev(DEVICE *dev);
90 void clrerror_dev(DEVICE *dev, int func);
91 bool update_pos_dev(DEVICE *dev);
92 bool rewind_dev(DEVICE *dev);
93 bool load_dev(DEVICE *dev);
94 bool offline_dev(DEVICE *dev);
95 int flush_dev(DEVICE *dev);
96 int weof_dev(DEVICE *dev, int num);
97 int write_block(DEVICE *dev);
98 uint32_t status_dev(DEVICE *dev);
99 bool eod_dev(DEVICE *dev);
100 bool fsf_dev(DEVICE *dev, int num);
101 bool bsf_dev(DEVICE *dev, int num);
102 bool bsr_dev(DEVICE *dev, int num);
103 void attach_jcr_to_device(DEVICE *dev, JCR *jcr);
104 void detach_jcr_from_device(DEVICE *dev, JCR *jcr);
105 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr);
106 bool offline_or_rewind_dev(DEVICE *dev);
107 bool reposition_dev(DEVICE *dev, uint32_t file, uint32_t block);
108 void init_device_wait_timers(DCR *dcr);
109 void init_jcr_device_wait_timers(JCR *jcr);
110 bool double_dev_wait_time(DEVICE *dev);
112 /* Get info about device */
113 char * dev_vol_name(DEVICE *dev);
114 uint32_t dev_block(DEVICE *dev);
115 uint32_t dev_file(DEVICE *dev);
118 int dvd_open_next_part(DCR *dcr);
119 bool dvd_write_part(DCR *dcr);
120 bool dvd_close_job(DCR *dcr);
121 bool mount_dev(DEVICE* dev, int timeout);
122 bool unmount_dev(DEVICE* dev, int timeout);
123 void update_free_space_dev(DEVICE *dev);
124 void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
125 void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
126 bool truncate_dvd_dev(DCR *dcr);
127 bool check_can_write_on_non_blank_dvd(DCR *dcr);
130 bool open_device(DCR *dcr);
131 void close_device(DEVICE *dev);
132 void force_close_device(DEVICE *dev);
133 bool first_open_device(DCR *dcr);
134 bool fixup_device_block_write_error(DCR *dcr);
135 void _lock_device(const char *file, int line, DEVICE *dev);
136 void _unlock_device(const char *file, int line, DEVICE *dev);
137 void _block_device(const char *file, int line, DEVICE *dev, int state);
138 void _unblock_device(const char *file, int line, DEVICE *dev);
139 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
140 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
141 void set_new_volume_parameters(DCR *dcr);
142 void set_new_file_parameters(DCR *dcr);
143 bool is_device_unmounted(DEVICE *dev);
144 void dev_lock(DEVICE *dev);
145 void dev_unlock(DEVICE *dev);
148 void *handle_connection_request(void *arg);
152 void run_job(JCR *jcr);
153 bool bootstrap_cmd(JCR *jcr);
156 void stored_free_jcr(JCR *jcr);
157 void connection_from_filed(void *arg);
158 void handle_filed_connection(BSOCK *fd, char *job_name);
161 int read_dev_volume_label(DCR *dcr);
162 int read_dvd_volume_label(DCR *dcr, bool write);
163 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
164 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName);
165 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName);
166 #define ANSI_VOL_LABEL 0
167 #define ANSI_EOF_LABEL 1
168 #define ANSI_EOV_LABEL 2
169 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
170 int read_ansi_ibm_label(DCR *dcr);
171 bool write_session_label(DCR *dcr, int label);
172 bool write_volume_label_to_block(DCR *dcr);
173 bool rewrite_volume_label(DCR *dcr, bool recycle);
174 void dump_volume_label(DEVICE *dev);
175 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
176 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
177 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
179 /* From match_bsr.c */
180 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
181 SESSION_LABEL *sesrec);
182 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
183 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
184 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
185 bool match_set_eof(BSR *bsr, DEV_RECORD *rec);
188 bool mount_next_write_volume(DCR *dcr, bool release);
189 bool mount_next_read_volume(DCR *dcr);
190 void mark_volume_in_error(DCR *dcr);
192 /* From parse_bsr.c */
193 BSR *parse_bsr(JCR *jcr, char *lf);
194 void dump_bsr(BSR *bsr, bool recurse);
195 void free_bsr(BSR *bsr);
196 VOL_LIST *new_restore_volume();
197 int add_restore_volume(JCR *jcr, VOL_LIST *vol);
198 void free_restore_volume_list(JCR *jcr);
199 void create_restore_volume_list(JCR *jcr);
202 const char *FI_to_ascii(char *buf, int fi);
203 const char *stream_to_ascii(char *buf, int stream, int fi);
204 bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
205 bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
206 bool read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
207 DEV_RECORD *new_record();
208 void free_record(DEV_RECORD *rec);
209 void empty_record(DEV_RECORD *rec);
211 /* From read_record.c */
212 bool read_records(DCR *dcr,
213 bool record_cb(DCR *dcr, DEV_RECORD *rec),
214 bool mount_cb(DCR *dcr));
217 void release_volume(DCR *dcr);
218 VOLRES *new_volume(DCR *dcr, const char *VolumeName);
219 VOLRES *find_volume(const char *VolumeName);
220 bool free_volume(DEVICE *dev);
221 void free_unused_volume(DCR *dcr);
222 void create_volume_list();
223 void free_volume_list();
224 void list_volumes(BSOCK *user);
225 bool is_volume_in_use(DCR *dcr);
226 void send_drive_reserve_messages(JCR *jcr, BSOCK *user);
230 bool begin_data_spool (DCR *dcr);
231 bool discard_data_spool (DCR *dcr);
232 bool commit_data_spool (DCR *dcr);
233 bool are_attributes_spooled (JCR *jcr);
234 bool begin_attribute_spool (JCR *jcr);
235 bool discard_attribute_spool (JCR *jcr);
236 bool commit_attribute_spool (JCR *jcr);
237 bool write_block_to_spool_file (DCR *dcr);
238 void list_spool_stats (BSOCK *bs);
241 int wait_for_sysop(DCR *dcr);
242 bool wait_for_device(JCR *jcr, bool first);