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

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