2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 * Protypes for stored -- Kern Sibbald MM
35 uint32_t new_VolSessionId();
38 DCR *acquire_device_for_append(DCR *dcr);
39 bool acquire_device_for_read(DCR *dcr);
40 bool release_device(DCR *dcr);
41 bool clean_device(DCR *dcr);
42 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev);
43 void free_dcr(DCR *dcr);
44 void detach_dcr_from_dev(DCR *dcr);
47 enum get_vol_info_rw {
48 GET_VOL_INFO_FOR_WRITE,
51 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
52 bool dir_find_next_appendable_volume(DCR *dcr);
53 bool dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten);
54 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
55 bool dir_ask_sysop_to_mount_volume(DCR *dcr, int mode);
56 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
57 bool dir_send_job_status(JCR *jcr);
58 bool dir_create_jobmedia_record(DCR *dcr, bool zero=false);
59 bool dir_update_device(JCR *jcr, DEVICE *dev);
60 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer);
63 int authenticate_director(JCR *jcr);
64 int authenticate_filed(JCR *jcr);
66 /* From autochanger.c */
67 bool init_autochangers();
68 int autoload_device(DCR *dcr, int writing, BSOCK *dir);
69 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
70 bool unload_autochanger(DCR *dcr, int loaded);
71 bool unload_dev(DCR *dcr, DEVICE *dev);
72 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
73 int get_autochanger_loaded_slot(DCR *dcr);
76 void dump_block(DEV_BLOCK *b, const char *msg);
77 DEV_BLOCK *new_block(DEVICE *dev);
78 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
79 void init_block_write(DEV_BLOCK *block);
80 void empty_block(DEV_BLOCK *block);
81 void free_block(DEV_BLOCK *block);
82 bool write_block_to_device(DCR *dcr);
83 bool write_block_to_dev(DCR *dcr);
84 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
85 void ser_block_header(DEV_BLOCK *block);
87 #define CHECK_BLOCK_NUMBERS true
88 #define NO_BLOCK_NUMBER_CHECK false
89 bool read_block_from_device(DCR *dcr, bool check_block_numbers);
90 bool read_block_from_dev(DCR *dcr, bool check_block_numbers);
92 /* From butil.c -- utilities for SD tool programs */
93 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
94 JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr,
95 const char *VolumeName, int mode);
96 void display_tape_error_status(JCR *jcr, DEVICE *dev);
100 DEVICE *init_dev(JCR *jcr, DEVRES *device);
101 bool can_open_mounted_dev(DEVICE *dev);
102 bool load_dev(DEVICE *dev);
103 int write_block(DEVICE *dev);
104 uint32_t status_dev(DEVICE *dev);
105 void attach_jcr_to_device(DEVICE *dev, JCR *jcr);
106 void detach_jcr_from_device(DEVICE *dev, JCR *jcr);
107 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr);
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);
116 int dvd_open_next_part(DCR *dcr);
117 bool dvd_write_part(DCR *dcr);
118 bool dvd_close_job(DCR *dcr);
119 void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
120 void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
121 bool truncate_dvd(DCR *dcr);
122 bool check_can_write_on_non_blank_dvd(DCR *dcr);
123 int find_num_dvd_parts(DCR *dcr);
124 boffset_t lseek_dvd(DCR *dcr, boffset_t offset, int whence);
125 void dvd_remove_empty_part(DCR *dcr);
128 bool open_device(DCR *dcr);
129 bool first_open_device(DCR *dcr);
130 bool fixup_device_block_write_error(DCR *dcr);
131 void set_start_vol_position(DCR *dcr);
132 void set_new_volume_parameters(DCR *dcr);
133 void set_new_file_parameters(DCR *dcr);
134 bool is_device_unmounted(DEVICE *dev);
137 void *handle_connection_request(void *arg);
141 void run_job(JCR *jcr);
142 bool get_bootstrap_file(JCR *jcr, BSOCK *bsock);
143 void do_fd_commands(JCR *jcr);
146 void stored_free_jcr(JCR *jcr);
147 void connection_from_filed(void *arg);
148 void handle_filed_connection(BSOCK *fd, char *job_name);
151 int read_dev_volume_label(DCR *dcr);
152 int read_dvd_volume_label(DCR *dcr, bool write);
153 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
154 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow);
155 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName,
156 const char *PoolName, bool relabel, bool dvdnow);
157 #define ANSI_VOL_LABEL 0
158 #define ANSI_EOF_LABEL 1
159 #define ANSI_EOV_LABEL 2
160 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
161 int read_ansi_ibm_label(DCR *dcr);
162 bool write_session_label(DCR *dcr, int label);
163 bool write_volume_label_to_block(DCR *dcr);
164 bool rewrite_volume_label(DCR *dcr, bool recycle);
165 void dump_volume_label(DEVICE *dev);
166 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
167 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
168 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
171 void _lock_device(const char *file, int line, DEVICE *dev);
172 void _unlock_device(const char *file, int line, DEVICE *dev);
173 void _block_device(const char *file, int line, DEVICE *dev, int state);
174 void _unblock_device(const char *file, int line, DEVICE *dev);
175 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
176 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
179 /* From match_bsr.c */
180 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
181 SESSION_LABEL *sesrec, JCR *jcr);
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 is_this_bsr_done(BSR *bsr, DEV_RECORD *rec);
186 uint64_t get_bsr_start_addr(BSR *bsr,
188 uint32_t *block=NULL);
192 bool mount_next_read_volume(DCR *dcr);
194 /* From parse_bsr.c */
195 BSR *parse_bsr(JCR *jcr, char *lf);
196 void dump_bsr(BSR *bsr, bool recurse);
197 void free_bsr(BSR *bsr);
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(DCR *dcr, 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);
210 uint64_t get_record_address(DEV_RECORD *rec);
212 /* From read_record.c */
213 bool read_records(DCR *dcr,
214 bool record_cb(DCR *dcr, DEV_RECORD *rec),
215 bool mount_cb(DCR *dcr));
218 void init_reservations_lock();
219 void term_reservations_lock();
220 void _lock_reservations();
221 void _unlock_reservations();
222 void _lock_volumes();
223 void _unlock_volumes();
224 void unreserve_device(DCR *dcr);
225 void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg);
226 bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx);
227 int search_res_for_device(RCTX &rctx);
228 void release_reserve_messages(JCR *jcr);
230 extern int reservations_lock_count;
234 #define lock_reservations() \
235 do { Dmsg4(sd_dbglvl, "lock_reservations at %s:%d precnt=%d JobId=%u\n", \
236 __FILE__, __LINE__, \
237 reservations_lock_count, get_jobid_from_tid(pthread_self())); \
238 _lock_reservations(); \
239 Dmsg1(sd_dbglvl, "lock_reservations: got lock JobId=%u\n", \
240 get_jobid_from_tid(pthread_self())); \
242 #define unlock_reservations() \
243 do { Dmsg4(sd_dbglvl, "unlock_reservations at %s:%d precnt=%d JobId=%u\n", \
244 __FILE__, __LINE__, \
245 reservations_lock_count, get_jobid_from_tid(pthread_self())); \
246 _unlock_reservations(); } while (0)
248 #define lock_volumes() \
249 do { Dmsg4(sd_dbglvl, "lock_volumes at %s:%d precnt=%d JobId=%u\n", \
250 __FILE__, __LINE__, \
251 vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
253 Dmsg1(sd_dbglvl, "lock_volumes: got lock JobId=%u\n", \
254 get_jobid_from_tid(pthread_self())); \
257 #define unlock_volumes() \
258 do { Dmsg4(sd_dbglvl, "unlock_volumes at %s:%d precnt=%d JobId=%u\n", \
259 __FILE__, __LINE__, \
260 vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
261 _unlock_volumes(); } while (0)
265 #define lock_reservations() _lock_reservations()
266 #define unlock_reservations() _unlock_reservations()
267 #define lock_volumes() _lock_volumes()
268 #define unlock_volumes() _unlock_volumes()
273 void init_vol_list_lock();
274 void term_vol_list_lock();
275 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
276 VOLRES *find_volume(const char *VolumeName);
277 bool free_volume(DEVICE *dev);
278 bool is_vol_list_empty();
279 dlist *dup_vol_list(JCR *jcr);
280 void free_temp_vol_list(dlist *temp_vol_list);
281 bool volume_unused(DCR *dcr);
282 void create_volume_lists();
283 void free_volume_lists();
284 void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
285 bool is_volume_in_use(DCR *dcr);
286 void debug_list_volumes(const char *imsg);
287 extern int vol_list_lock_count;
288 void add_read_volume(JCR *jcr, const char *VolumeName);
289 void remove_read_volume(JCR *jcr, const char *VolumeName);
293 bool begin_data_spool (DCR *dcr);
294 bool discard_data_spool (DCR *dcr);
295 bool commit_data_spool (DCR *dcr);
296 bool are_attributes_spooled (JCR *jcr);
297 bool begin_attribute_spool (JCR *jcr);
298 bool discard_attribute_spool (JCR *jcr);
299 bool commit_attribute_spool (JCR *jcr);
300 bool write_block_to_spool_file (DCR *dcr);
301 void list_spool_stats (void sendit(const char *msg, int len, void *sarg), void *arg);
304 int wait_for_sysop(DCR *dcr);
305 bool wait_for_device(JCR *jcr, int &retries);