8 Copyright (C) 2000-2004 Kern Sibbald and John Walker
10 This program is free software; you can redistribute it and/or
11 modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 2 of
13 the License, or (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public
21 License along with this program; if not, write to the Free
22 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 uint32_t new_VolSessionId();
31 DCR *acquire_device_for_append(JCR *jcr);
32 DCR *acquire_device_for_read(JCR *jcr);
33 bool release_device(JCR *jcr);
34 DCR *new_dcr(JCR *jcr, DEVICE *dev);
35 void free_dcr(DCR *dcr);
38 enum get_vol_info_rw {
39 GET_VOL_INFO_FOR_WRITE,
42 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
43 bool dir_find_next_appendable_volume(DCR *dcr);
44 bool dir_update_volume_info(DCR *dcr, bool label);
45 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
46 bool dir_ask_sysop_to_mount_volume(DCR *dcr);
47 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
48 bool dir_send_job_status(JCR *jcr);
49 bool dir_create_jobmedia_record(DCR *dcr);
52 int authenticate_director(JCR *jcr);
53 int authenticate_filed(JCR *jcr);
56 void dump_block(DEV_BLOCK *b, const char *msg);
57 DEV_BLOCK *new_block(DEVICE *dev);
58 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
59 void init_block_write(DEV_BLOCK *block);
60 void empty_block(DEV_BLOCK *block);
61 void free_block(DEV_BLOCK *block);
62 bool write_block_to_device(DCR *dcr, DEV_BLOCK *block);
63 bool write_block_to_dev(DCR *dcr, DEV_BLOCK *block);
64 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
65 void ser_block_header(DEV_BLOCK *block);
67 #define CHECK_BLOCK_NUMBERS true
68 #define NO_BLOCK_NUMBER_CHECK false
69 bool read_block_from_device(DCR *dcr, DEV_BLOCK *block, bool check_block_numbers);
70 bool read_block_from_dev(DCR *dcr, DEV_BLOCK *block, bool check_block_numbers);
72 /* From butil.c -- utilities for SD tool programs */
73 void print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
74 JCR *setup_jcr(const char *name, const char * device, BSR *bsr, const char *VolumeName);
75 DEVICE *setup_to_access_device(JCR *jcr, int read_access);
76 void display_tape_error_status(JCR *jcr, DEVICE *dev);
77 DEVRES *find_device_res(char *device_name, int read_access);
81 DEVICE *init_dev(DEVICE *dev, DEVRES *device);
82 int open_dev(DEVICE *dev, char *VolName, int mode);
83 void close_dev(DEVICE *dev);
84 void force_close_dev(DEVICE *dev);
85 bool truncate_dev(DEVICE *dev);
86 void term_dev(DEVICE *dev);
87 char * strerror_dev(DEVICE *dev);
88 void clrerror_dev(DEVICE *dev, int func);
89 bool update_pos_dev(DEVICE *dev);
90 int rewind_dev(DEVICE *dev);
91 bool load_dev(DEVICE *dev);
92 bool offline_dev(DEVICE *dev);
93 int flush_dev(DEVICE *dev);
94 int weof_dev(DEVICE *dev, int num);
95 int write_block(DEVICE *dev);
96 int write_dev(DEVICE *dev, char *buf, size_t len);
97 int read_dev(DEVICE *dev, char *buf, size_t len);
98 uint32_t status_dev(DEVICE *dev);
99 int eod_dev(DEVICE *dev);
100 bool fsf_dev(DEVICE *dev, int num);
101 bool fsr_dev(DEVICE *dev, int num);
102 bool bsf_dev(DEVICE *dev, int num);
103 bool bsr_dev(DEVICE *dev, int num);
104 void attach_jcr_to_device(DEVICE *dev, JCR *jcr);
105 void detach_jcr_from_device(DEVICE *dev, JCR *jcr);
106 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr);
107 bool dev_can_write(DEVICE *dev);
108 int offline_or_rewind_dev(DEVICE *dev);
109 bool reposition_dev(DEVICE *dev, uint32_t file, uint32_t block);
110 void init_dev_wait_timers(DEVICE *dev);
111 bool double_dev_wait_time(DEVICE *dev);
114 /* Get info about device */
115 char * dev_name(DEVICE *dev);
116 char * dev_vol_name(DEVICE *dev);
117 uint32_t dev_block(DEVICE *dev);
118 uint32_t dev_file(DEVICE *dev);
119 bool dev_is_tape(DEVICE *dev);
122 int open_device(JCR *jcr, DEVICE *dev);
123 int first_open_device(DEVICE *dev);
124 bool fixup_device_block_write_error(DCR *dcr, DEV_BLOCK *block);
125 void _lock_device(const char *file, int line, DEVICE *dev);
126 void _unlock_device(const char *file, int line, DEVICE *dev);
127 void _block_device(const char *file, int line, DEVICE *dev, int state);
128 void _unblock_device(const char *file, int line, DEVICE *dev);
129 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
130 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
131 void set_new_volume_parameters(DCR *dcr);
132 void set_new_file_parameters(DCR *dcr);
133 int device_is_unmounted(DEVICE *dev);
134 void dev_lock(DEVICE *dev);
135 void dev_unlock(DEVICE *dev);
138 void *handle_connection_request(void *arg);
142 void run_job(JCR *jcr);
145 void stored_free_jcr(JCR *jcr);
146 void connection_from_filed(void *arg);
147 void handle_filed_connection(BSOCK *fd, char *job_name);
150 int read_dev_volume_label(DCR *dcr, DEV_BLOCK *block);
151 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
152 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName);
153 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName);
154 bool write_session_label(DCR *dcr, DEV_BLOCK *block, int label);
155 bool write_volume_label_to_block(DCR *dcr, DEV_BLOCK *block);
156 void dump_volume_label(DEVICE *dev);
157 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
158 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
159 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
161 /* From match_bsr.c */
162 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
163 SESSION_LABEL *sesrec);
164 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
165 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
166 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
167 bool match_set_eof(BSR *bsr, DEV_RECORD *rec);
170 bool mount_next_write_volume(DCR *dcr, DEV_BLOCK *block, bool release);
171 bool mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
172 void release_volume(JCR *jcr, DEVICE *dev);
173 void mark_volume_in_error(JCR *jcr, DEVICE *dev);
175 /* From autochanger.c */
176 int autoload_device(DCR *dcr, int writing, BSOCK *dir);
177 bool autochanger_list(DCR *dcr, BSOCK *dir);
178 void invalidate_slot_in_catalog(DCR *dcr);
181 /* From parse_bsr.c */
182 BSR *parse_bsr(JCR *jcr, char *lf);
183 void dump_bsr(BSR *bsr, bool recurse);
184 void free_bsr(BSR *bsr);
186 int add_vol(JCR *jcr, VOL_LIST *vol);
187 void free_vol_list(JCR *jcr);
188 void create_vol_list(JCR *jcr);
191 const char *FI_to_ascii(int fi);
192 const char *stream_to_ascii(int stream, int fi);
193 int write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
194 int can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
195 int read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
196 DEV_RECORD *new_record();
197 void free_record(DEV_RECORD *rec);
199 /* From read_record.c */
200 bool read_records(DCR *dcr,
201 bool record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
202 bool mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block));
205 bool begin_data_spool (JCR *jcr);
206 bool discard_data_spool (JCR *jcr);
207 bool commit_data_spool (JCR *jcr);
208 bool are_attributes_spooled (JCR *jcr);
209 bool begin_attribute_spool (JCR *jcr);
210 bool discard_attribute_spool (JCR *jcr);
211 bool commit_attribute_spool (JCR *jcr);
212 bool write_block_to_spool_file (DCR *dcr, DEV_BLOCK *block);
213 void list_spool_stats (BSOCK *bs);