1 /* 2 Bacula(R) - The Network Backup Solution 3 4 Copyright (C) 2000-2020 Kern Sibbald 5 6 The original author of Bacula is Kern Sibbald, with contributions 7 from many others, a complete list can be found in the file AUTHORS. 8 9 You may use this file and others of this release according to the 10 license defined in the LICENSE file, which includes the Affero General 11 Public License, v3.0 ("AGPLv3") and some additional permissions and 12 terms pursuant to its AGPLv3 Section 7. 13 14 This notice must be preserved when any source code is 15 conveyed and/or propagated. 16 17 Bacula(R) is a registered trademark of Kern Sibbald. 18 */ 19 /* 20 * Protypes for stored 21 * 22 * Written by Kern Sibbald, MM 23 */ 24 25 /* From stored.c */ 26 uint32_t new_VolSessionId(); 27 28 /* From acquire.c */ 29 DCR *acquire_device_for_append(DCR *dcr); 30 bool acquire_device_for_read(DCR *dcr); 31 bool release_device(DCR *dcr); 32 bool clean_device(DCR *dcr); 33 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev, bool writing=true); 34 void free_dcr(DCR *dcr); 35 36 /* From append.c */ 37 bool send_attrs_to_dir(JCR *jcr, DEV_RECORD *rec); 38 39 /* From askdir.c */ 40 enum get_vol_info_rw { 41 GET_VOL_INFO_FOR_WRITE, 42 GET_VOL_INFO_FOR_READ 43 }; 44 bool dir_get_volume_info(DCR *dcr, const char *VolumeName, enum get_vol_info_rw); 45 bool dir_find_next_appendable_volume(DCR *dcr); 46 bool dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten, 47 bool use_dcr=false); 48 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr); 49 bool dir_ask_sysop_to_mount_volume(DCR *dcr, bool read_access); 50 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec); 51 bool dir_send_job_status(JCR *jcr); 52 bool dir_create_jobmedia_record(DCR *dcr, bool zero=false); 53 void create_jobmedia_queue(JCR *jcr); 54 bool flush_jobmedia_queue(JCR *jcr); 55 bool dir_update_device(JCR *jcr, DEVICE *dev); 56 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer); 57 58 /* class AskDirHandler allows btool's utilities to overwrite the functions above 59 * and even to overwrite the functions in their own sub-class like in btape 60 */ 61 class AskDirHandler 62 { 63 /* this class should be an abstract class */ 64 public: AskDirHandler()65 AskDirHandler() {} ~AskDirHandler()66 virtual ~AskDirHandler() {} dir_find_next_appendable_volume(DCR * dcr)67 virtual bool dir_find_next_appendable_volume(DCR *dcr) { return 1;} dir_update_volume_info(DCR * dcr,bool relabel,bool update_LastWritten,bool use_dcr)68 virtual bool dir_update_volume_info(DCR *dcr, bool relabel, bool update_LastWritten, bool use_dcr) { return 1; } dir_create_jobmedia_record(DCR * dcr,bool zero)69 virtual bool dir_create_jobmedia_record(DCR *dcr, bool zero) { return 1; } flush_jobmedia_queue(JCR * jcr)70 virtual bool flush_jobmedia_queue(JCR *jcr) { return true; } dir_ask_sysop_to_create_appendable_volume(DCR * dcr)71 virtual bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr) { return 1; } dir_update_file_attributes(DCR * dcr,DEV_RECORD * rec)72 virtual bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec) { return 1;} dir_send_job_status(JCR * jcr)73 virtual bool dir_send_job_status(JCR *jcr) {return 1;} 74 virtual bool dir_ask_sysop_to_mount_volume(DCR *dcr, bool writing); 75 virtual bool dir_get_volume_info(DCR *dcr, const char *VolumeName, enum get_vol_info_rw writing); 76 }; 77 78 class BtoolsAskDirHandler: public AskDirHandler 79 { 80 /* if AskDirHandler was an abstract class, implement the method here */ 81 public: BtoolsAskDirHandler()82 BtoolsAskDirHandler() {} ~BtoolsAskDirHandler()83 virtual ~BtoolsAskDirHandler() {} 84 }; 85 86 /* activate the functions provided by the btool's handler */ 87 AskDirHandler *init_askdir_handler(AskDirHandler *new_askdir_handler); 88 89 /* authenticate.c */ 90 bool authenticate_director(JCR *jcr); 91 int authenticate_filed(JCR *jcr, BSOCK *fd, int FDVersion); 92 bool authenticate_storagedaemon(JCR *jcr); 93 94 /* From autochanger.c */ 95 bool init_autochangers(); 96 int autoload_device(DCR *dcr, bool writing, BSOCK *dir); 97 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd); 98 bool unload_autochanger(DCR *dcr, int loaded); 99 bool unload_dev(DCR *dcr, DEVICE *dev); 100 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd); 101 int get_autochanger_loaded_slot(DCR *dcr); 102 103 /* From block.c */ 104 void dump_block(DEVICE *dev, DEV_BLOCK *b, const char *msg, bool force=false); 105 DEV_BLOCK *dup_block(DEV_BLOCK *eblock); 106 void init_block_write(DEV_BLOCK *block); 107 void empty_block(DEV_BLOCK *block); 108 void free_block(DEV_BLOCK *block); 109 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block); 110 void ser_block_header(DEV_BLOCK *block); 111 bool is_block_empty(DEV_BLOCK *block); 112 bool terminate_writing_volume(DCR *dcr); 113 114 /* From block_util.c */ 115 bool terminate_writing_volume(DCR *dcr); 116 bool is_user_volume_size_reached(DCR *dcr, bool quiet); 117 bool check_for_newvol_or_newfile(DCR *dcr); 118 bool do_new_file_bookkeeping(DCR *dcr); 119 void reread_last_block(DCR *dcr); 120 121 122 /* From butil.c -- utilities for SD tool programs */ 123 void setup_me(); 124 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp); 125 JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr, 126 const char *VolumeName, bool writing, bool read_dedup_data=true); 127 void display_tape_error_status(JCR *jcr, DEVICE *dev); 128 129 130 /* From dev.c */ 131 void sd_list_loaded_drivers(alist *list); 132 DEVICE *init_dev(JCR *jcr, DEVRES *device, bool adata=false, bstatcollect *statcollector=NULL); 133 bool can_open_mounted_dev(DEVICE *dev); 134 bool load_dev(DEVICE *dev); 135 int write_block(DEVICE *dev); 136 uint32_t status_dev(DEVICE *dev); 137 void attach_jcr_to_device(DEVICE *dev, JCR *jcr); 138 void detach_jcr_from_device(DEVICE *dev, JCR *jcr); 139 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr); 140 void init_device_wait_timers(DCR *dcr); 141 void init_jcr_device_wait_timers(JCR *jcr); 142 bool double_dev_wait_time(DEVICE *dev); 143 144 /* From device.c */ 145 bool first_open_device(DCR *dcr); 146 bool fixup_device_block_write_error(DCR *dcr, int retries=4); 147 void set_start_vol_position(DCR *dcr); 148 void set_new_volume_parameters(DCR *dcr); 149 void set_new_file_parameters(DCR *dcr); 150 151 /* From dircmd.c */ 152 void *handle_connection_request(void *arg); 153 extern int use_new_match_all; /* Temp variable, to be removed when the new code is tested */ 154 155 /* From fd_cmds.c */ 156 void run_job(JCR *jcr); 157 void do_fd_commands(JCR *jcr); 158 bool do_handle_command(JCR *jcr); 159 void do_client_commands(JCR *jcr); 160 161 /* From job.c */ 162 void stored_free_jcr(JCR *jcr); 163 164 /* From hello.c */ 165 bool validate_dir_hello(JCR* jcr); 166 bool send_hello_ok(BSOCK *bs); 167 bool send_sorry(BSOCK *bs); 168 bool send_hello_sd(JCR *jcr, char *Job); 169 bool send_hello_client(JCR *jcr, char *Job); 170 bool read_client_hello(JCR *jcr); 171 bool is_client_connection(BSOCK *bs); 172 void handle_client_connection(BSOCK *fd); 173 174 /* From label.c */ 175 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label); 176 void create_volume_header(DEVICE *dev, const char *VolName, const char *PoolName, bool no_prelabel); 177 #define ANSI_VOL_LABEL 0 178 #define ANSI_EOF_LABEL 1 179 #define ANSI_EOV_LABEL 2 180 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName); 181 int read_ansi_ibm_label(DCR *dcr); 182 bool write_session_label(DCR *dcr, int label); 183 int dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose, bool check_err); 184 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec); 185 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec); 186 187 /* From locks.c */ 188 void _lock_device(const char *file, int line, DEVICE *dev); 189 void _unlock_device(const char *file, int line, DEVICE *dev); 190 void _block_device(const char *file, int line, DEVICE *dev, int state); 191 void _unblock_device(const char *file, int line, DEVICE *dev); 192 void _give_back_device_block(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold); 193 194 195 /* From match_bsr.c */ 196 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec, 197 SESSION_LABEL *sesrec, JCR *jcr); 198 int match_bsr_block(BSR *bsr, DEV_BLOCK *block); 199 void position_bsr_block(BSR *bsr, DEV_BLOCK *block); 200 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev); 201 bool is_this_bsr_done(JCR *jcr, BSR *bsr, DEV_RECORD *rec); 202 uint64_t get_bsr_start_addr(BSR *bsr); 203 204 /* From mount.c */ 205 bool mount_next_read_volume(DCR *dcr); 206 207 /* From parse_bsr.c */ 208 BSR *new_bsr(); 209 BSR *parse_bsr(JCR *jcr, char *lf); 210 void dump_bsr(DEVICE *dev, BSR *bsr, bool recurse); 211 void free_bsr(BSR *bsr); 212 void free_restore_volume_list(JCR *jcr); 213 void create_restore_volume_list(JCR *jcr, bool add_to_read_list); 214 215 /* From record.c */ 216 const char *FI_to_ascii(char *buf, int fi); 217 const char *stream_to_ascii(char *buf, int stream, int fi); 218 const char *stream_to_ascii_ex(char *buf, int stream, int fi); 219 bool write_record_to_block(DCR *dcr, DEV_RECORD *rec); 220 bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec); 221 bool read_record_from_block(DCR *dcr, DEV_RECORD *rec); 222 DEV_RECORD *new_record(); 223 void free_record(DEV_RECORD *rec); 224 void empty_record(DEV_RECORD *rec); 225 uint64_t get_record_address(DEV_RECORD *rec); 226 uint64_t get_record_start_address(DEV_RECORD *rec); 227 bool flush_adata_to_device(DCR *dcr); 228 229 /* From record_util.c */ 230 void dump_record(DEV_RECORD *rec); 231 232 /* From read_record.c */ 233 bool read_records(DCR *dcr, 234 bool record_cb(DCR *dcr, DEV_RECORD *rec), 235 bool mount_cb(DCR *dcr)); 236 237 /* From reserve.c */ 238 void init_reservations_lock(); 239 void term_reservations_lock(); 240 void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg); 241 bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx); 242 int search_res_for_device(RCTX &rctx); 243 void release_reserve_messages(JCR *jcr); 244 245 extern int reservations_lock_count; 246 247 /* From status.c */ 248 void _dbg_list_one_device(DEVICE *dev, const char *f, int l); 249 #define dbg_list_one_device(x, dev) if (chk_dbglvl(x)) \ 250 _dbg_list_one_device(dev, __FILE__, __LINE__) 251 252 /* From vol_mgr.c */ 253 void init_vol_list_lock(); 254 void term_vol_list_lock(); 255 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName); 256 bool free_volume(DEVICE *dev); 257 bool is_vol_list_empty(); 258 dlist *dup_vol_list(JCR *jcr); 259 void free_temp_vol_list(dlist *temp_vol_list); 260 bool volume_unused(DCR *dcr); 261 void create_volume_lists(); 262 void free_volume_lists(); 263 void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg); 264 bool is_volume_in_use(DCR *dcr); 265 extern int vol_list_lock_count; 266 void add_read_volume(JCR *jcr, const char *VolumeName); 267 void remove_read_volume(JCR *jcr, const char *VolumeName); 268 269 270 /* From spool.c */ 271 bool begin_data_spool (DCR *dcr); 272 bool discard_data_spool (DCR *dcr); 273 bool commit_data_spool (DCR *dcr); 274 bool are_attributes_spooled (JCR *jcr); 275 bool begin_attribute_spool (JCR *jcr); 276 bool discard_attribute_spool (JCR *jcr); 277 bool commit_attribute_spool (JCR *jcr); 278 bool write_block_to_spool_file (DCR *dcr); 279 void list_spool_stats (void sendit(const char *msg, int len, void *sarg), void *arg); 280 281 /* From tape_alert.c */ 282 extern void alert_callback(void *ctx, const char *short_msg, 283 const char *long_msg, char *Volume, 284 int severity, int flags, int alertno, utime_t alert_time); 285 286 /* From wait.c */ 287 int wait_for_sysop(DCR *dcr); 288 bool wait_for_any_device(JCR *jcr, int &retries); 289 bool wait_for_device(DCR *dcr, int &retries); 290 291 /* stored_conf.c */ 292 void store_protocol(LEX *lc, RES_ITEM *item, int index, int pass); 293 void store_uri_style(LEX *lc, RES_ITEM *item, int index, int pass); 294 void store_truncate(LEX *lc, RES_ITEM *item, int index, int pass); 295 void store_upload(LEX *lc, RES_ITEM *item, int index, int pass); 296 void store_devtype(LEX *lc, RES_ITEM *item, int index, int pass); 297 void store_cloud_driver(LEX *lc, RES_ITEM *item, int index, int pass); 298 void store_maxblocksize(LEX *lc, RES_ITEM *item, int index, int pass); 299 300 /* from sdcollect.c */ 301 bool update_permanent_stats(void *data); 302 void initialize_statcollector(); 303 void start_collector_threads(); 304 void terminate_collector_threads(); 305