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 plus additions
11 that are listed in the file LICENSE.
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, 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 _lock_device(const char *file, int line, DEVICE *dev);
130 void _unlock_device(const char *file, int line, DEVICE *dev);
131 void _block_device(const char *file, int line, DEVICE *dev, int state);
132 void _unblock_device(const char *file, int line, DEVICE *dev);
133 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
134 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
135 void set_new_volume_parameters(DCR *dcr);
136 void set_new_file_parameters(DCR *dcr);
137 bool is_device_unmounted(DEVICE *dev);
138 uint32_t get_jobid_from_tid();
141 void *handle_connection_request(void *arg);
145 void run_job(JCR *jcr);
146 bool get_bootstrap_file(JCR *jcr, BSOCK *bsock);
147 void do_fd_commands(JCR *jcr);
150 void stored_free_jcr(JCR *jcr);
151 void connection_from_filed(void *arg);
152 void handle_filed_connection(BSOCK *fd, char *job_name);
155 int read_dev_volume_label(DCR *dcr);
156 int read_dvd_volume_label(DCR *dcr, bool write);
157 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
158 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow);
159 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName,
160 const char *PoolName, bool relabel, bool dvdnow);
161 #define ANSI_VOL_LABEL 0
162 #define ANSI_EOF_LABEL 1
163 #define ANSI_EOV_LABEL 2
164 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
165 int read_ansi_ibm_label(DCR *dcr);
166 bool write_session_label(DCR *dcr, int label);
167 bool write_volume_label_to_block(DCR *dcr);
168 bool rewrite_volume_label(DCR *dcr, bool recycle);
169 void dump_volume_label(DEVICE *dev);
170 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
171 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
172 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
174 /* From match_bsr.c */
175 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
176 SESSION_LABEL *sesrec);
177 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
178 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
179 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
180 bool is_this_bsr_done(BSR *bsr, DEV_RECORD *rec);
183 bool mount_next_write_volume(DCR *dcr, bool release);
184 bool mount_next_read_volume(DCR *dcr);
185 void mark_volume_in_error(DCR *dcr);
187 /* From parse_bsr.c */
188 BSR *parse_bsr(JCR *jcr, char *lf);
189 void dump_bsr(BSR *bsr, bool recurse);
190 void free_bsr(BSR *bsr);
191 VOL_LIST *new_restore_volume();
192 int add_restore_volume(JCR *jcr, VOL_LIST *vol);
193 void free_restore_volume_list(JCR *jcr);
194 void create_restore_volume_list(JCR *jcr);
197 const char *FI_to_ascii(char *buf, int fi);
198 const char *stream_to_ascii(char *buf, int stream, int fi);
199 bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
200 bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
201 bool read_record_from_block(DCR *dcr, DEV_BLOCK *block, DEV_RECORD *rec);
202 DEV_RECORD *new_record();
203 void free_record(DEV_RECORD *rec);
204 void empty_record(DEV_RECORD *rec);
206 /* From read_record.c */
207 bool read_records(DCR *dcr,
208 bool record_cb(DCR *dcr, DEV_RECORD *rec),
209 bool mount_cb(DCR *dcr));
212 void init_reservations_lock();
213 void term_reservations_lock();
214 void _lock_reservations();
215 void _unlock_reservations();
216 void release_volume(DCR *dcr);
217 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
218 VOLRES *find_volume(const char *VolumeName);
219 bool free_volume(DEVICE *dev);
220 void unreserve_device(DCR *dcr);
221 bool volume_unused(DCR *dcr);
222 void create_volume_list();
223 void free_volume_list();
224 void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
225 bool is_volume_in_use(DCR *dcr);
226 void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg);
227 bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx);
228 int search_res_for_device(RCTX &rctx);
229 void release_msgs(JCR *jcr);
231 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()); \
238 _lock_reservations(); \
239 Dmsg1(sd_dbglvl, "lock_reservations: got lock JobId=%u\n", \
240 get_jobid_from_tid()); \
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()); \
246 _unlock_reservations(); } while (0)
248 #define lock_reservations() _lock_reservations()
249 #define unlock_reservations() _unlock_reservations()
255 bool begin_data_spool (DCR *dcr);
256 bool discard_data_spool (DCR *dcr);
257 bool commit_data_spool (DCR *dcr);
258 bool are_attributes_spooled (JCR *jcr);
259 bool begin_attribute_spool (JCR *jcr);
260 bool discard_attribute_spool (JCR *jcr);
261 bool commit_attribute_spool (JCR *jcr);
262 bool write_block_to_spool_file (DCR *dcr);
263 void list_spool_stats (void sendit(const char *msg, int len, void *sarg), void *arg);
266 int wait_for_sysop(DCR *dcr);
267 bool wait_for_device(JCR *jcr, bool first);