]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/protos.h
See kes-1.31
[bacula/bacula] / bacula / src / stored / protos.h
1 /*
2  * Protypes for stored
3  *
4  *   Version $Id$
5  */
6
7 /*
8    Copyright (C) 2000-2003 Kern Sibbald and John Walker
9
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.
14
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.
19
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,
23    MA 02111-1307, USA.
24
25  */
26    
27 /* From stored.c */
28 uint32_t new_VolSessionId();
29
30 /* From acquire.c */
31 DEVICE  *acquire_device_for_append(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
32 int      acquire_device_for_read(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
33 int      release_device(JCR *jcr, DEVICE *dev);
34
35 /* From askdir.c */
36 int     dir_get_volume_info(JCR *jcr, int writing);
37 int     dir_find_next_appendable_volume(JCR *jcr);
38 int     dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int relabel);
39 int     dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev);
40 int     dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev);
41 int     dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec);
42 int     dir_send_job_status(JCR *jcr);
43 int     dir_create_jobmedia_record(JCR *jcr);
44
45 /* authenticate.c */
46 int     authenticate_director(JCR *jcr);
47 int     authenticate_filed(JCR *jcr);
48
49 /* From block.c */
50 void    dump_block(DEV_BLOCK *b, char *msg);
51 DEV_BLOCK *new_block(DEVICE *dev);
52 void    init_block_write(DEV_BLOCK *block);
53 void    empty_block(DEV_BLOCK *block);
54 void    free_block(DEV_BLOCK *block);
55 int     write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
56 int     write_block_to_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
57
58 #define CHECK_BLOCK_NUMBERS    true
59 #define NO_BLOCK_NUMBER_CHECK  false
60 int     read_block_from_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers);
61 int     read_block_from_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers);
62
63 /* From butil.c -- utilities for SD tool programs */
64 void    print_ls_output(char *fname, char *link, int type, struct stat *statp);
65 JCR    *setup_jcr(char *name, char *device, BSR *bsr, char *VolumeName);
66 DEVICE *setup_to_access_device(JCR *jcr, int read_access);
67 void    display_tape_error_status(JCR *jcr, DEVICE *dev);
68 DEVRES *find_device_res(char *device_name, int read_access);
69
70
71 /* From dev.c */
72 DEVICE  *init_dev(DEVICE *dev, DEVRES *device);
73 int      open_dev(DEVICE *dev, char *VolName, int mode);
74 void     close_dev(DEVICE *dev);
75 void     force_close_dev(DEVICE *dev);
76 int      truncate_dev(DEVICE *dev);
77 void     term_dev(DEVICE *dev);
78 char *   strerror_dev(DEVICE *dev);
79 void     clrerror_dev(DEVICE *dev, int func);
80 int      update_pos_dev(DEVICE *dev);
81 int      rewind_dev(DEVICE *dev);
82 int      load_dev(DEVICE *dev);
83 int      offline_dev(DEVICE *dev);
84 int      flush_dev(DEVICE *dev);
85 int      weof_dev(DEVICE *dev, int num);
86 int      write_block(DEVICE *dev);
87 int      write_dev(DEVICE *dev, char *buf, size_t len);
88 int      read_dev(DEVICE *dev, char *buf, size_t len);
89 int      status_dev(DEVICE *dev, uint32_t *status);
90 int      eod_dev(DEVICE *dev);
91 int      fsf_dev(DEVICE *dev, int num);
92 int      fsr_dev(DEVICE *dev, int num);
93 int      bsf_dev(DEVICE *dev, int num);
94 int      bsr_dev(DEVICE *dev, int num);
95 void     attach_jcr_to_device(DEVICE *dev, JCR *jcr);
96 void     detach_jcr_from_device(DEVICE *dev, JCR *jcr);
97 JCR     *next_attached_jcr(DEVICE *dev, JCR *jcr);
98 int     dev_can_write(DEVICE *dev);
99 int     offline_or_rewind_dev(DEVICE *dev);
100
101
102 /* Get info about device */
103 char *   dev_name(DEVICE *dev);
104 char *   dev_vol_name(DEVICE *dev);
105 uint32_t dev_block(DEVICE *dev);
106 uint32_t dev_file(DEVICE *dev);
107 int      dev_is_tape(DEVICE *dev);
108
109 /* From device.c */
110 int      open_device(DEVICE *dev);
111 int      fixup_device_block_write_error(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
112 void _lock_device(char *file, int line, DEVICE *dev);
113 void _unlock_device(char *file, int line, DEVICE *dev);
114 void _block_device(char *file, int line, DEVICE *dev, int state);
115 void _unblock_device(char *file, int line, DEVICE *dev);
116 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
117 void _return_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
118
119 /* don't use */
120 void _new_lock_device(char *file, int line, DEVICE *dev);
121 void _new_lock_device(char *file, int line, DEVICE *dev, int state);
122 void _new_unlock_device(char *file, int line, DEVICE *dev);
123 void  new_steal_device_lock(DEVICE *dev, brwsteal_t *hold, int state);
124 void  new_return_device_lock(DEVICE *dev, brwsteal_t *hold);
125
126 /* From dircmd.c */
127 void     *connection_request(void *arg); 
128
129
130 /* From fd_cmds.c */
131 void     run_job(JCR *jcr);
132
133 /* From job.c */
134 void     stored_free_jcr(JCR *jcr);
135 void     connection_from_filed(void *arg);     
136 void     handle_filed_connection(BSOCK *fd, char *job_name);
137
138 /* From label.c */
139 int      read_dev_volume_label(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
140 void     create_session_label(JCR *jcr, DEV_RECORD *rec, int label);
141 void     create_volume_label(DEVICE *dev, char *VolName);
142 int      write_volume_label_to_dev(JCR *jcr, DEVRES *device, char *VolName, char *PoolName);
143 int      write_session_label(JCR *jcr, DEV_BLOCK *block, int label);
144 int      write_volume_label_to_block(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
145 void     dump_volume_label(DEVICE *dev);
146 void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
147 int      unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
148 int      unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
149
150 /* From match_bsr.c */
151 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec, 
152               SESSION_LABEL *sesrec);
153
154 /* From mount.c */
155 int      mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release);
156 int      mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
157
158 /* From autochanger.c */
159 int      autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir);
160 int      autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir);
161 void     invalidate_slot_in_catalog(JCR *jcr);
162
163
164 /* From parse_bsr.c */
165 extern BSR *parse_bsr(JCR *jcr, char *lf);
166 extern void dump_bsr(BSR *bsr);
167 extern void free_bsr(BSR *bsr);
168 extern VOL_LIST *new_vol();
169 extern int add_vol(JCR *jcr, VOL_LIST *vol);
170 extern void free_vol_list(JCR *jcr);
171 extern void create_vol_list(JCR *jcr);
172
173 /* From record.c */
174 char   *FI_to_ascii(int fi);
175 char   *stream_to_ascii(int stream, int fi);
176 int     write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
177 int     can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
178 int     read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec); 
179 DEV_RECORD *new_record();
180 void    free_record(DEV_RECORD *rec);
181
182 /* From read_record.c */
183 int read_records(JCR *jcr,  DEVICE *dev, 
184        void record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
185        int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block));