2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 John Walker.
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 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev);
42 void free_dcr(DCR *dcr);
43 void detach_dcr_from_dev(DCR *dcr);
46 enum get_vol_info_rw {
47 GET_VOL_INFO_FOR_WRITE,
50 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
51 bool dir_find_next_appendable_volume(DCR *dcr);
52 bool dir_update_volume_info(DCR *dcr, bool label);
53 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
54 bool dir_ask_sysop_to_mount_volume(DCR *dcr);
55 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
56 bool dir_send_job_status(JCR *jcr);
57 bool dir_create_jobmedia_record(DCR *dcr);
58 bool dir_update_device(JCR *jcr, DEVICE *dev);
59 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer);
62 int authenticate_director(JCR *jcr);
63 int authenticate_filed(JCR *jcr);
65 /* From autochanger.c */
66 bool init_autochangers();
67 int autoload_device(DCR *dcr, int writing, BSOCK *dir);
68 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
69 bool unload_autochanger(DCR *dcr, int loaded);
70 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
71 int get_autochanger_loaded_slot(DCR *dcr);
74 void dump_block(DEV_BLOCK *b, const char *msg);
75 DEV_BLOCK *new_block(DEVICE *dev);
76 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
77 void init_block_write(DEV_BLOCK *block);
78 void empty_block(DEV_BLOCK *block);
79 void free_block(DEV_BLOCK *block);
80 bool write_block_to_device(DCR *dcr);
81 bool write_block_to_dev(DCR *dcr);
82 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
83 void ser_block_header(DEV_BLOCK *block);
85 #define CHECK_BLOCK_NUMBERS true
86 #define NO_BLOCK_NUMBER_CHECK false
87 bool read_block_from_device(DCR *dcr, bool check_block_numbers);
88 bool read_block_from_dev(DCR *dcr, bool check_block_numbers);
90 /* From butil.c -- utilities for SD tool programs */
91 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
92 JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr,
93 const char *VolumeName, int mode);
94 void display_tape_error_status(JCR *jcr, DEVICE *dev);
98 DEVICE *init_dev(JCR *jcr, DEVRES *device);
99 bool can_open_mounted_dev(DEVICE *dev);
100 bool load_dev(DEVICE *dev);
101 int write_block(DEVICE *dev);
102 uint32_t status_dev(DEVICE *dev);
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 void init_device_wait_timers(DCR *dcr);
107 void init_jcr_device_wait_timers(JCR *jcr);
108 bool double_dev_wait_time(DEVICE *dev);
110 /* Get info about device */
111 char * dev_vol_name(DEVICE *dev);
114 int dvd_open_next_part(DCR *dcr);
115 bool dvd_write_part(DCR *dcr);
116 bool dvd_close_job(DCR *dcr);
117 void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
118 void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
119 bool truncate_dvd(DCR *dcr);
120 bool check_can_write_on_non_blank_dvd(DCR *dcr);
121 int find_num_dvd_parts(DCR *dcr);
122 boffset_t lseek_dvd(DCR *dcr, boffset_t offset, int whence);
123 void dvd_remove_empty_part(DCR *dcr);
126 bool open_device(DCR *dcr);
127 bool first_open_device(DCR *dcr);
128 bool fixup_device_block_write_error(DCR *dcr);
129 void set_new_volume_parameters(DCR *dcr);
130 void set_new_file_parameters(DCR *dcr);
131 bool is_device_unmounted(DEVICE *dev);
134 void *handle_connection_request(void *arg);
138 void run_job(JCR *jcr);
139 bool get_bootstrap_file(JCR *jcr, BSOCK *bsock);
140 void do_fd_commands(JCR *jcr);
143 void stored_free_jcr(JCR *jcr);
144 void connection_from_filed(void *arg);
145 void handle_filed_connection(BSOCK *fd, char *job_name);
148 int read_dev_volume_label(DCR *dcr);
149 int read_dvd_volume_label(DCR *dcr, bool write);
150 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
151 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow);
152 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName,
153 const char *PoolName, bool relabel, bool dvdnow);
154 #define ANSI_VOL_LABEL 0
155 #define ANSI_EOF_LABEL 1
156 #define ANSI_EOV_LABEL 2
157 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
158 int read_ansi_ibm_label(DCR *dcr);
159 bool write_session_label(DCR *dcr, int label);
160 bool write_volume_label_to_block(DCR *dcr);
161 bool rewrite_volume_label(DCR *dcr, bool recycle);
162 void dump_volume_label(DEVICE *dev);
163 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
164 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
165 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
168 void _lock_device(const char *file, int line, DEVICE *dev);
169 void _unlock_device(const char *file, int line, DEVICE *dev);
170 void _block_device(const char *file, int line, DEVICE *dev, int state);
171 void _unblock_device(const char *file, int line, DEVICE *dev);
172 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
173 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
176 /* From match_bsr.c */
177 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
178 SESSION_LABEL *sesrec);
179 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
180 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
181 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
182 bool is_this_bsr_done(BSR *bsr, DEV_RECORD *rec);
185 bool mount_next_write_volume(DCR *dcr, bool release);
186 bool mount_next_read_volume(DCR *dcr);
187 void mark_volume_in_error(DCR *dcr);
189 /* From parse_bsr.c */
190 BSR *parse_bsr(JCR *jcr, char *lf);
191 void dump_bsr(BSR *bsr, bool recurse);
192 void free_bsr(BSR *bsr);
193 VOL_LIST *new_restore_volume();
194 int add_restore_volume(JCR *jcr, VOL_LIST *vol);
195 void free_restore_volume_list(JCR *jcr);
196 void create_restore_volume_list(JCR *jcr);
199 const char *FI_to_ascii(char *buf, int fi);
200 const char *stream_to_ascii(char *buf, int stream, int fi);
201 bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
202 bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
203 bool read_record_from_block(DCR *dcr, DEV_BLOCK *block, DEV_RECORD *rec);
204 DEV_RECORD *new_record();
205 void free_record(DEV_RECORD *rec);
206 void empty_record(DEV_RECORD *rec);
208 /* From read_record.c */
209 bool read_records(DCR *dcr,
210 bool record_cb(DCR *dcr, DEV_RECORD *rec),
211 bool mount_cb(DCR *dcr));
214 void init_reservations_lock();
215 void term_reservations_lock();
216 void _lock_reservations();
217 void _unlock_reservations();
218 void _lock_volumes();
219 void _unlock_volumes();
220 void release_volume(DCR *dcr);
221 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
222 VOLRES *find_volume(const char *VolumeName);
223 bool free_volume(DEVICE *dev);
224 void unreserve_device(DCR *dcr);
225 bool volume_unused(DCR *dcr);
226 void create_volume_list();
227 void free_volume_list();
228 void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
229 bool is_volume_in_use(DCR *dcr);
230 void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg);
231 bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx);
232 int search_res_for_device(RCTX &rctx);
233 void release_reserve_messages(JCR *jcr);
235 extern int reservations_lock_count;
236 extern int vol_list_lock_count;
240 #define lock_reservations() \
241 do { Dmsg4(sd_dbglvl, "lock_reservations at %s:%d precnt=%d JobId=%u\n", \
242 __FILE__, __LINE__, \
243 reservations_lock_count, get_jobid_from_tid(pthread_self())); \
244 _lock_reservations(); \
245 Dmsg1(sd_dbglvl, "lock_reservations: got lock JobId=%u\n", \
246 get_jobid_from_tid(pthread_self())); \
248 #define unlock_reservations() \
249 do { Dmsg4(sd_dbglvl, "unlock_reservations at %s:%d precnt=%d JobId=%u\n", \
250 __FILE__, __LINE__, \
251 reservations_lock_count, get_jobid_from_tid(pthread_self())); \
252 _unlock_reservations(); } while (0)
254 #define lock_volumes() \
255 do { Dmsg4(sd_dbglvl, "lock_volumes at %s:%d precnt=%d JobId=%u\n", \
256 __FILE__, __LINE__, \
257 vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
259 Dmsg1(sd_dbglvl, "lock_volumes: got lock JobId=%u\n", \
260 get_jobid_from_tid(pthread_self())); \
263 #define unlock_volumes() \
264 do { Dmsg4(sd_dbglvl, "unlock_volumes at %s:%d precnt=%d JobId=%u\n", \
265 __FILE__, __LINE__, \
266 vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
267 _unlock_volumes(); } while (0)
271 #define lock_reservations() _lock_reservations()
272 #define unlock_reservations() _unlock_reservations()
273 #define lock_volumes() _lock_volumes()
274 #define unlock_volumes() _unlock_volumes()
281 bool begin_data_spool (DCR *dcr);
282 bool discard_data_spool (DCR *dcr);
283 bool commit_data_spool (DCR *dcr);
284 bool are_attributes_spooled (JCR *jcr);
285 bool begin_attribute_spool (JCR *jcr);
286 bool discard_attribute_spool (JCR *jcr);
287 bool commit_attribute_spool (JCR *jcr);
288 bool write_block_to_spool_file (DCR *dcr);
289 void list_spool_stats (void sendit(const char *msg, int len, void *sarg), void *arg);
292 int wait_for_sysop(DCR *dcr);
293 bool wait_for_device(JCR *jcr, int &retries);