7 Copyright (C) 2000-2005 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 int autoload_device(DCR *dcr, int writing, BSOCK *dir);
53 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
54 bool unload_autochanger(DCR *dcr, int loaded);
55 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
56 int get_autochanger_loaded_slot(DCR *dcr);
59 void dump_block(DEV_BLOCK *b, const char *msg);
60 DEV_BLOCK *new_block(DEVICE *dev);
61 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
62 void init_block_write(DEV_BLOCK *block);
63 void empty_block(DEV_BLOCK *block);
64 void free_block(DEV_BLOCK *block);
65 bool write_block_to_device(DCR *dcr);
66 bool write_block_to_dev(DCR *dcr);
67 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
68 void ser_block_header(DEV_BLOCK *block);
70 #define CHECK_BLOCK_NUMBERS true
71 #define NO_BLOCK_NUMBER_CHECK false
72 bool read_block_from_device(DCR *dcr, bool check_block_numbers);
73 bool read_block_from_dev(DCR *dcr, bool check_block_numbers);
75 /* From butil.c -- utilities for SD tool programs */
76 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
77 JCR *setup_jcr(const char *name, char *dev_name, BSR *bsr,
78 const char *VolumeName, int mode);
79 void display_tape_error_status(JCR *jcr, DEVICE *dev);
83 DEVICE *init_dev(JCR *jcr, DEVRES *device);
84 off_t lseek_dev(DEVICE *dev, off_t offset, int whence);
85 bool can_open_mounted_dev(DEVICE *dev);
86 bool truncate_dev(DCR *dcr);
87 void term_dev(DEVICE *dev);
88 char * strerror_dev(DEVICE *dev);
89 void clrerror_dev(DEVICE *dev, int func);
90 bool update_pos_dev(DEVICE *dev);
91 bool rewind_dev(DEVICE *dev);
92 bool load_dev(DEVICE *dev);
93 bool offline_dev(DEVICE *dev);
94 int flush_dev(DEVICE *dev);
95 int weof_dev(DEVICE *dev, int num);
96 int write_block(DEVICE *dev);
97 uint32_t status_dev(DEVICE *dev);
98 bool eod_dev(DEVICE *dev);
99 bool fsf_dev(DEVICE *dev, int num);
100 bool bsf_dev(DEVICE *dev, int num);
101 bool bsr_dev(DEVICE *dev, int num);
102 void attach_jcr_to_device(DEVICE *dev, JCR *jcr);
103 void detach_jcr_from_device(DEVICE *dev, JCR *jcr);
104 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr);
105 bool offline_or_rewind_dev(DEVICE *dev);
106 bool reposition_dev(DEVICE *dev, uint32_t file, uint32_t block);
107 void init_device_wait_timers(DCR *dcr);
108 void init_jcr_device_wait_timers(JCR *jcr);
109 bool double_dev_wait_time(DEVICE *dev);
111 /* Get info about device */
112 char * dev_vol_name(DEVICE *dev);
113 uint32_t dev_block(DEVICE *dev);
114 uint32_t dev_file(DEVICE *dev);
117 int dvd_open_next_part(DCR *dcr);
118 bool dvd_write_part(DCR *dcr);
119 bool dvd_close_job(DCR *dcr);
120 bool mount_dev(DEVICE* dev, int timeout);
121 bool unmount_dev(DEVICE* dev, int timeout);
122 void update_free_space_dev(DEVICE *dev);
123 void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
124 void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
125 bool truncate_dvd_dev(DCR *dcr);
126 bool check_can_write_on_non_blank_dvd(DCR *dcr);
129 bool open_device(DCR *dcr);
130 void close_device(DEVICE *dev);
131 void force_close_device(DEVICE *dev);
132 bool first_open_device(DCR *dcr);
133 bool fixup_device_block_write_error(DCR *dcr);
134 void _lock_device(const char *file, int line, DEVICE *dev);
135 void _unlock_device(const char *file, int line, DEVICE *dev);
136 void _block_device(const char *file, int line, DEVICE *dev, int state);
137 void _unblock_device(const char *file, int line, DEVICE *dev);
138 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
139 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
140 void set_new_volume_parameters(DCR *dcr);
141 void set_new_file_parameters(DCR *dcr);
142 bool is_device_unmounted(DEVICE *dev);
143 void dev_lock(DEVICE *dev);
144 void dev_unlock(DEVICE *dev);
147 void *handle_connection_request(void *arg);
151 void run_job(JCR *jcr);
152 bool bootstrap_cmd(JCR *jcr);
155 void stored_free_jcr(JCR *jcr);
156 void connection_from_filed(void *arg);
157 void handle_filed_connection(BSOCK *fd, char *job_name);
160 int read_dev_volume_label(DCR *dcr);
161 int read_dvd_volume_label(DCR *dcr, bool write);
162 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
163 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName);
164 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName);
165 #define ANSI_VOL_LABEL 0
166 #define ANSI_EOF_LABEL 1
167 #define ANSI_EOV_LABEL 2
168 bool write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
169 int read_ansi_ibm_label(DCR *dcr);
170 bool write_session_label(DCR *dcr, int label);
171 bool write_volume_label_to_block(DCR *dcr);
172 bool rewrite_volume_label(DCR *dcr, bool recycle);
173 void dump_volume_label(DEVICE *dev);
174 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
175 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
176 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
178 /* From match_bsr.c */
179 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
180 SESSION_LABEL *sesrec);
181 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
182 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
183 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
184 bool match_set_eof(BSR *bsr, DEV_RECORD *rec);
187 bool mount_next_write_volume(DCR *dcr, bool release);
188 bool mount_next_read_volume(DCR *dcr);
189 void mark_volume_in_error(DCR *dcr);
191 /* From parse_bsr.c */
192 BSR *parse_bsr(JCR *jcr, char *lf);
193 void dump_bsr(BSR *bsr, bool recurse);
194 void free_bsr(BSR *bsr);
195 VOL_LIST *new_restore_volume();
196 int add_restore_volume(JCR *jcr, VOL_LIST *vol);
197 void free_restore_volume_list(JCR *jcr);
198 void create_restore_volume_list(JCR *jcr);
201 const char *FI_to_ascii(char *buf, int fi);
202 const char *stream_to_ascii(char *buf, int stream, int fi);
203 bool write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
204 bool can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
205 bool read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
206 DEV_RECORD *new_record();
207 void free_record(DEV_RECORD *rec);
208 void empty_record(DEV_RECORD *rec);
210 /* From read_record.c */
211 bool read_records(DCR *dcr,
212 bool record_cb(DCR *dcr, DEV_RECORD *rec),
213 bool mount_cb(DCR *dcr));
216 void release_volume(DCR *dcr);
217 VOLRES *new_volume(DCR *dcr, const char *VolumeName);
218 VOLRES *find_volume(const char *VolumeName);
219 bool free_volume(DEVICE *dev);
220 void free_unused_volume(DCR *dcr);
221 void create_volume_list();
222 void free_volume_list();
223 void list_volumes(BSOCK *user);
224 bool is_volume_in_use(DCR *dcr);
228 bool begin_data_spool (DCR *dcr);
229 bool discard_data_spool (DCR *dcr);
230 bool commit_data_spool (DCR *dcr);
231 bool are_attributes_spooled (JCR *jcr);
232 bool begin_attribute_spool (JCR *jcr);
233 bool discard_attribute_spool (JCR *jcr);
234 bool commit_attribute_spool (JCR *jcr);
235 bool write_block_to_spool_file (DCR *dcr);
236 void list_spool_stats (BSOCK *bs);
239 int wait_for_sysop(DCR *dcr);
240 bool wait_for_device(JCR *jcr, bool first);