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

   1 /*
   2  * Protypes for stored
   3  *
   4  *   Version $Id$
   5  */
   6 /*
   7    Copyright (C) 2000-2005 Kern Sibbald
   8
   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 ammended with additional clauses defined in the
  12    file LICENSE in the main source directory.
  13
  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.
  18
  19  */
  20
  21 /* From stored.c */
  22 uint32_t new_VolSessionId();
  23
  24 /* From acquire.c */
  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);
  30
  31 /* From askdir.c */
  32 enum get_vol_info_rw {
  33    GET_VOL_INFO_FOR_WRITE,
  34    GET_VOL_INFO_FOR_READ
  35 };
  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);
  46
  47 /* authenticate.c */
  48 int     authenticate_director(JCR *jcr);
  49 int     authenticate_filed(JCR *jcr);
  50
  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 char    *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
  55
  56 /* From block.c */
  57 void    dump_block(DEV_BLOCK *b, const char *msg);
  58 DEV_BLOCK *new_block(DEVICE *dev);
  59 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
  60 void    init_block_write(DEV_BLOCK *block);
  61 void    empty_block(DEV_BLOCK *block);
  62 void    free_block(DEV_BLOCK *block);
  63 bool    write_block_to_device(DCR *dcr);
  64 bool    write_block_to_dev(DCR *dcr);
  65 void    print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
  66 void    ser_block_header(DEV_BLOCK *block);
  67
  68 #define CHECK_BLOCK_NUMBERS    true
  69 #define NO_BLOCK_NUMBER_CHECK  false
  70 bool    read_block_from_device(DCR *dcr, bool check_block_numbers);
  71 bool    read_block_from_dev(DCR *dcr, bool check_block_numbers);
  72
  73 /* From butil.c -- utilities for SD tool programs */
  74 void    print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
  75 JCR    *setup_jcr(const char *name, char *dev_name, BSR *bsr,
  76                   const char *VolumeName, int mode);
  77 void    display_tape_error_status(JCR *jcr, DEVICE *dev);
  78
  79
  80 /* From dev.c */
  81 DEVICE  *init_dev(JCR *jcr, DEVRES *device);
  82 off_t    lseek_dev(DEVICE *dev, off_t offset, int whence);
  83 int      open_first_part(DCR *dcr, int mode);
  84 int      open_next_part(DCR *dcr);
  85 bool     can_open_mounted_dev(DEVICE *dev);
  86 bool     truncate_dev(DEVICE *dev);
  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);
 110
 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);
 115
 116 /* From dvd.c */
 117 bool dvd_close_job(DCR *dcr);
 118 bool mount_dev(DEVICE* dev, int timeout);
 119 bool unmount_dev(DEVICE* dev, int timeout);
 120 void update_free_space_dev(DEVICE *dev);
 121 void make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
 122 void make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
 123
 124 /* From device.c */
 125 bool     open_device(DCR *dcr);
 126 void     close_device(DEVICE *dev);
 127 void     force_close_device(DEVICE *dev);
 128 bool     first_open_device(DCR *dcr);
 129 bool     fixup_device_block_write_error(DCR *dcr);
 130 void     _lock_device(const char *file, int line, DEVICE *dev);
 131 void     _unlock_device(const char *file, int line, DEVICE *dev);
 132 void     _block_device(const char *file, int line, DEVICE *dev, int state);
 133 void     _unblock_device(const char *file, int line, DEVICE *dev);
 134 void     _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
 135 void     _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
 136 void     set_new_volume_parameters(DCR *dcr);
 137 void     set_new_file_parameters(DCR *dcr);
 138 bool     device_is_unmounted(DEVICE *dev);
 139 void     dev_lock(DEVICE *dev);
 140 void     dev_unlock(DEVICE *dev);
 141 const char *edit_blocked_reason(DEVICE *dev);
 142
 143 /* From dircmd.c */
 144 void     *handle_connection_request(void *arg);
 145
 146
 147 /* From fd_cmds.c */
 148 void     run_job(JCR *jcr);
 149 bool     bootstrap_cmd(JCR *jcr);
 150
 151 /* From job.c */
 152 void     stored_free_jcr(JCR *jcr);
 153 void     connection_from_filed(void *arg);
 154 void     handle_filed_connection(BSOCK *fd, char *job_name);
 155
 156 /* From label.c */
 157 int      read_dev_volume_label(DCR *dcr);
 158 int      read_dvd_volume_label(DCR *dcr, bool write);
 159 void     create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
 160 void     create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName);
 161 bool     write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName);
 162 #define ANSI_VOL_LABEL 0
 163 #define ANSI_EOF_LABEL 1
 164 #define ANSI_EOV_LABEL 2
 165 bool     write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
 166 int      read_ansi_ibm_label(DCR *dcr);
 167 bool     write_session_label(DCR *dcr, int label);
 168 bool     write_volume_label_to_block(DCR *dcr);
 169 bool     rewrite_volume_label(DCR *dcr, bool recycle);
 170 void     dump_volume_label(DEVICE *dev);
 171 void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
 172 bool     unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
 173 bool     unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
 174
 175 /* From match_bsr.c */
 176 int      match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
 177               SESSION_LABEL *sesrec);
 178 int      match_bsr_block(BSR *bsr, DEV_BLOCK *block);
 179 void     position_bsr_block(BSR *bsr, DEV_BLOCK *block);
 180 BSR     *find_next_bsr(BSR *root_bsr, DEVICE *dev);
 181 bool     match_set_eof(BSR *bsr, DEV_RECORD *rec);
 182
 183 /* From mount.c */
 184 bool     mount_next_write_volume(DCR *dcr, bool release);
 185 bool     mount_next_read_volume(DCR *dcr);
 186 void     mark_volume_in_error(DCR *dcr);
 187
 188 /* From parse_bsr.c */
 189 BSR     *parse_bsr(JCR *jcr, char *lf);
 190 void     dump_bsr(BSR *bsr, bool recurse);
 191 void     free_bsr(BSR *bsr);
 192 VOL_LIST *new_restore_volume();
 193 int      add_restore_volume(JCR *jcr, VOL_LIST *vol);
 194 void     free_restore_volume_list(JCR *jcr);
 195 void     create_restore_volume_list(JCR *jcr);
 196
 197 /* From record.c */
 198 const char *FI_to_ascii(int fi);
 199 const char *stream_to_ascii(int stream, int fi);
 200 bool        write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 201 bool        can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 202 bool        read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
 203 DEV_RECORD *new_record();
 204 void        free_record(DEV_RECORD *rec);
 205 void        empty_record(DEV_RECORD *rec);
 206
 207 /* From read_record.c */
 208 bool read_records(DCR *dcr,
 209        bool record_cb(DCR *dcr, DEV_RECORD *rec),
 210        bool mount_cb(DCR *dcr));
 211
 212 /* From reserve.c */
 213 void    release_volume(DCR *dcr);
 214 VOLRES *new_volume(const char *VolumeName, DEVICE *dev);
 215 VOLRES *find_volume(const char *VolumeName);
 216 bool    free_volume(DEVICE *dev);
 217 void    create_volume_list();
 218 void    free_volume_list();
 219 void    list_volumes(BSOCK *user);
 220 bool    is_volume_in_use(const char *VolumeName);
 221
 222
 223 /* From spool.c */
 224 bool    begin_data_spool          (DCR *dcr);
 225 bool    discard_data_spool        (DCR *dcr);
 226 bool    commit_data_spool         (DCR *dcr);
 227 bool    are_attributes_spooled    (JCR *jcr);
 228 bool    begin_attribute_spool     (JCR *jcr);
 229 bool    discard_attribute_spool   (JCR *jcr);
 230 bool    commit_attribute_spool    (JCR *jcr);
 231 bool    write_block_to_spool_file (DCR *dcr);
 232 void    list_spool_stats          (BSOCK *bs);
 233
 234 /* From wait.c */
 235 int wait_for_sysop(DCR *dcr);
 236 bool wait_for_device(JCR *jcr, bool first);