git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/protos.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
   5
   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 and included
  11    in the file LICENSE.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  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.
  27 */
  28 /*
  29  * Protypes for stored -- Kern Sibbald MM
  30  *
  31  */
  32
  33 /* From stored.c */
  34 uint32_t new_VolSessionId();
  35
  36 /* From acquire.c */
  37 DCR     *acquire_device_for_append(DCR *dcr);
  38 bool     acquire_device_for_read(DCR *dcr);
  39 bool     release_device(DCR *dcr);
  40 bool     clean_device(DCR *dcr);
  41 DCR     *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev);
  42 void     free_dcr(DCR *dcr);
  43
  44 /* From append.c */
  45 bool send_attrs_to_dir(JCR *jcr, DEV_RECORD *rec);
  46
  47 /* From askdir.c */
  48 enum get_vol_info_rw {
  49    GET_VOL_INFO_FOR_WRITE,
  50    GET_VOL_INFO_FOR_READ
  51 };
  52 bool    dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
  53 bool    dir_find_next_appendable_volume(DCR *dcr);
  54 bool    dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten);
  55 bool    dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
  56 bool    dir_ask_sysop_to_mount_volume(DCR *dcr, int mode);
  57 bool    dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
  58 bool    dir_send_job_status(JCR *jcr);
  59 bool    dir_create_jobmedia_record(DCR *dcr, bool zero=false);
  60 bool    dir_update_device(JCR *jcr, DEVICE *dev);
  61 bool    dir_update_changer(JCR *jcr, AUTOCHANGER *changer);
  62
  63 /* authenticate.c */
  64 int     authenticate_director(JCR *jcr);
  65 int     authenticate_filed(JCR *jcr);
  66
  67 /* From autochanger.c */
  68 bool     init_autochangers();
  69 int      autoload_device(DCR *dcr, int writing, BSOCK *dir);
  70 bool     autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
  71 bool     unload_autochanger(DCR *dcr, int loaded);
  72 bool     unload_dev(DCR *dcr, DEVICE *dev);
  73 char    *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
  74 int      get_autochanger_loaded_slot(DCR *dcr);
  75
  76 /* From block.c */
  77 void    dump_block(DEV_BLOCK *b, const char *msg);
  78 DEV_BLOCK *new_block(DEVICE *dev);
  79 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
  80 void    init_block_write(DEV_BLOCK *block);
  81 void    empty_block(DEV_BLOCK *block);
  82 void    free_block(DEV_BLOCK *block);
  83 bool    write_block_to_device(DCR *dcr);
  84 bool    write_block_to_dev(DCR *dcr);
  85 void    print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
  86 void    ser_block_header(DEV_BLOCK *block);
  87
  88 #define CHECK_BLOCK_NUMBERS    true
  89 #define NO_BLOCK_NUMBER_CHECK  false
  90 bool    read_block_from_device(DCR *dcr, bool check_block_numbers);
  91 bool    read_block_from_dev(DCR *dcr, bool check_block_numbers);
  92
  93 /* From butil.c -- utilities for SD tool programs */
  94 void    print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
  95 JCR    *setup_jcr(const char *name, char *dev_name, BSR *bsr,
  96                   const char *VolumeName, int mode);
  97 void    display_tape_error_status(JCR *jcr, DEVICE *dev);
  98
  99
 100 /* From dev.c */
 101 DEVICE  *init_dev(JCR *jcr, DEVRES *device);
 102 bool     can_open_mounted_dev(DEVICE *dev);
 103 bool     load_dev(DEVICE *dev);
 104 int      write_block(DEVICE *dev);
 105 uint32_t status_dev(DEVICE *dev);
 106 void     attach_jcr_to_device(DEVICE *dev, JCR *jcr);
 107 void     detach_jcr_from_device(DEVICE *dev, JCR *jcr);
 108 JCR     *next_attached_jcr(DEVICE *dev, JCR *jcr);
 109 void     init_device_wait_timers(DCR *dcr);
 110 void     init_jcr_device_wait_timers(JCR *jcr);
 111 bool     double_dev_wait_time(DEVICE *dev);
 112
 113 /* Get info about device */
 114 char *   dev_vol_name(DEVICE *dev);
 115
 116 /* From dvd.c */
 117 int     dvd_open_next_part(DCR *dcr);
 118 bool    dvd_write_part(DCR *dcr);
 119 bool    dvd_close_job(DCR *dcr);
 120 void    make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
 121 void    make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
 122 bool    truncate_dvd(DCR *dcr);
 123 bool    check_can_write_on_non_blank_dvd(DCR *dcr);
 124 int     find_num_dvd_parts(DCR *dcr);
 125 boffset_t   lseek_dvd(DCR *dcr, boffset_t offset, int whence);
 126 void    dvd_remove_empty_part(DCR *dcr);
 127
 128 /* From device.c */
 129 bool     open_device(DCR *dcr);
 130 bool     first_open_device(DCR *dcr);
 131 bool     fixup_device_block_write_error(DCR *dcr, int retries=4);
 132 void     set_start_vol_position(DCR *dcr);
 133 void     set_new_volume_parameters(DCR *dcr);
 134 void     set_new_file_parameters(DCR *dcr);
 135
 136 /* From dircmd.c */
 137 void     *handle_connection_request(void *arg);
 138
 139
 140 /* From fd_cmds.c */
 141 void     run_job(JCR *jcr);
 142 void     do_fd_commands(JCR *jcr);
 143
 144 /* From job.c */
 145 void     stored_free_jcr(JCR *jcr);
 146 void     connection_from_filed(void *arg);
 147 void     handle_filed_connection(BSOCK *fd, char *job_name);
 148
 149 /* From label.c */
 150 int      read_dev_volume_label(DCR *dcr);
 151 int      read_dvd_volume_label(DCR *dcr, bool write);
 152 void     create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
 153 void     create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow);
 154 bool     write_new_volume_label_to_dev(DCR *dcr, const char *VolName,
 155            const char *PoolName, bool relabel, bool dvdnow);
 156 #define ANSI_VOL_LABEL 0
 157 #define ANSI_EOF_LABEL 1
 158 #define ANSI_EOV_LABEL 2
 159 bool     write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
 160 int      read_ansi_ibm_label(DCR *dcr);
 161 bool     write_session_label(DCR *dcr, int label);
 162 bool     write_volume_label_to_block(DCR *dcr);
 163 bool     rewrite_volume_label(DCR *dcr, bool recycle);
 164 void     dump_volume_label(DEVICE *dev);
 165 void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
 166 bool     unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
 167 bool     unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
 168
 169 /* From locks.c */
 170 void     _lock_device(const char *file, int line, DEVICE *dev);
 171 void     _unlock_device(const char *file, int line, DEVICE *dev);
 172 void     _block_device(const char *file, int line, DEVICE *dev, int state);
 173 void     _unblock_device(const char *file, int line, DEVICE *dev);
 174 void     _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
 175 void     _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
 176
 177
 178 /* From match_bsr.c */
 179 int      match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
 180               SESSION_LABEL *sesrec, JCR *jcr);
 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     is_this_bsr_done(BSR *bsr, DEV_RECORD *rec);
 185 uint64_t get_bsr_start_addr(BSR *bsr,
 186                             uint32_t *file=NULL,
 187                             uint32_t *block=NULL);
 188
 189
 190 /* From mount.c */
 191 bool     mount_next_read_volume(DCR *dcr);
 192
 193 /* From parse_bsr.c */
 194 BSR     *parse_bsr(JCR *jcr, char *lf);
 195 void     dump_bsr(BSR *bsr, bool recurse);
 196 void     free_bsr(BSR *bsr);
 197 void     free_restore_volume_list(JCR *jcr);
 198 void     create_restore_volume_list(JCR *jcr);
 199
 200 /* From record.c */
 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(DCR *dcr, 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);
 209 uint64_t get_record_address(DEV_RECORD *rec);
 210
 211 /* From read_record.c */
 212 bool read_records(DCR *dcr,
 213        bool record_cb(DCR *dcr, DEV_RECORD *rec),
 214        bool mount_cb(DCR *dcr));
 215
 216 /* From reserve.c */
 217 void    init_reservations_lock();
 218 void    term_reservations_lock();
 219 void    _lock_reservations(const char *file="**Unknown**", int line=0);
 220 void    _unlock_reservations();
 221 void    _lock_volumes(const char *file="**Unknown**", int line=0);
 222 void    _unlock_volumes();
 223 void    unreserve_device(DCR *dcr);
 224 void    send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg);
 225 bool    find_suitable_device_for_job(JCR *jcr, RCTX &rctx);
 226 int     search_res_for_device(RCTX &rctx);
 227 void    release_reserve_messages(JCR *jcr);
 228
 229 extern int reservations_lock_count;
 230
 231 #ifdef  SD_DEBUG_LOCK
 232
 233 #define lock_reservations() \
 234          do { Dmsg3(sd_dbglvl, "lock_reservations at %s:%d precnt=%d\n", \
 235               __FILE__, __LINE__, \
 236               reservations_lock_count); \
 237               _lock_reservations(__FILE__, __LINE__); \
 238               Dmsg0(sd_dbglvl, "lock_reservations: got lock\n"); \
 239          } while (0)
 240 #define unlock_reservations() \
 241          do { Dmsg3(sd_dbglvl, "unlock_reservations at %s:%d precnt=%d\n", \
 242               __FILE__, __LINE__, \
 243               reservations_lock_count); \
 244                    _unlock_reservations(); } while (0)
 245
 246 #define lock_volumes() \
 247          do { Dmsg3(sd_dbglvl, "lock_volumes at %s:%d precnt=%d\n", \
 248               __FILE__, __LINE__, \
 249               vol_list_lock_count); \
 250               _lock_volumes(__FILE__, __LINE__); \
 251               Dmsg0(sd_dbglvl, "lock_volumes: got lock\n"); \
 252          } while (0)
 253
 254 #define unlock_volumes() \
 255          do { Dmsg3(sd_dbglvl, "unlock_volumes at %s:%d precnt=%d\n", \
 256               __FILE__, __LINE__, \
 257               vol_list_lock_count); \
 258                    _unlock_volumes(); } while (0)
 259
 260 #else
 261
 262 #define lock_reservations() _lock_reservations(__FILE__, __LINE__)
 263 #define unlock_reservations() _unlock_reservations()
 264 #define lock_volumes() _lock_volumes(__FILE__, __LINE__)
 265 #define unlock_volumes() _unlock_volumes()
 266
 267 #endif
 268
 269 /* From vol_mgr.c */
 270 void    init_vol_list_lock();
 271 void    term_vol_list_lock();
 272 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
 273 VOLRES *find_volume(const char *VolumeName);
 274 bool    free_volume(DEVICE *dev);
 275 bool    is_vol_list_empty();
 276 dlist  *dup_vol_list(JCR *jcr);
 277 void    free_temp_vol_list(dlist *temp_vol_list);
 278 bool    volume_unused(DCR *dcr);
 279 void    create_volume_lists();
 280 void    free_volume_lists();
 281 void    list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
 282 bool    is_volume_in_use(DCR *dcr);
 283 extern  int vol_list_lock_count;
 284 void    add_read_volume(JCR *jcr, const char *VolumeName);
 285 void    remove_read_volume(JCR *jcr, const char *VolumeName);
 286
 287
 288 /* From spool.c */
 289 bool    begin_data_spool          (DCR *dcr);
 290 bool    discard_data_spool        (DCR *dcr);
 291 bool    commit_data_spool         (DCR *dcr);
 292 bool    are_attributes_spooled    (JCR *jcr);
 293 bool    begin_attribute_spool     (JCR *jcr);
 294 bool    discard_attribute_spool   (JCR *jcr);
 295 bool    commit_attribute_spool    (JCR *jcr);
 296 bool    write_block_to_spool_file (DCR *dcr);
 297 void    list_spool_stats          (void sendit(const char *msg, int len, void *sarg), void *arg);
 298
 299 /* From wait.c */
 300 int wait_for_sysop(DCR *dcr);
 301 bool wait_for_device(JCR *jcr, int &retries);