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(DEVICE *dev);
  84 int      open_next_part(DEVICE *dev);
  85 int      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 get_filename(DEVICE *dev, char *VolName, POOL_MEM& archive_name);
 122
 123 /* From device.c */
 124 bool     open_device(DCR *dcr);
 125 void     close_device(DEVICE *dev);
 126 void     force_close_device(DEVICE *dev);
 127 bool     first_open_device(DEVICE *dev);
 128 bool     fixup_device_block_write_error(DCR *dcr);
 129 void     _lock_device(const char *file, int line, DEVICE *dev);
 130 void     _unlock_device(const char *file, int line, DEVICE *dev);
 131 void     _block_device(const char *file, int line, DEVICE *dev, int state);
 132 void     _unblock_device(const char *file, int line, DEVICE *dev);
 133 void     _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
 134 void     _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
 135 void     set_new_volume_parameters(DCR *dcr);
 136 void     set_new_file_parameters(DCR *dcr);
 137 bool     device_is_unmounted(DEVICE *dev);
 138 void     dev_lock(DEVICE *dev);
 139 void     dev_unlock(DEVICE *dev);
 140 const char *edit_blocked_reason(DEVICE *dev);
 141
 142 /* From dircmd.c */
 143 void     *handle_connection_request(void *arg);
 144
 145
 146 /* From fd_cmds.c */
 147 void     run_job(JCR *jcr);
 148 bool     bootstrap_cmd(JCR *jcr);
 149
 150 /* From job.c */
 151 void     stored_free_jcr(JCR *jcr);
 152 void     connection_from_filed(void *arg);
 153 void     handle_filed_connection(BSOCK *fd, char *job_name);
 154
 155 /* From label.c */
 156 int      read_dev_volume_label(DCR *dcr);
 157 int      read_dvd_volume_label(DCR *dcr, bool write);
 158 void     create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
 159 void     create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName);
 160 bool     write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName);
 161 #define ANSI_VOL_LABEL 0
 162 #define ANSI_EOF_LABEL 1
 163 #define ANSI_EOV_LABEL 2
 164 bool     write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
 165 int      read_ansi_ibm_label(DCR *dcr);
 166 bool     write_session_label(DCR *dcr, int label);
 167 bool     write_volume_label_to_block(DCR *dcr);
 168 bool     rewrite_volume_label(DCR *dcr, bool recycle);
 169 void     dump_volume_label(DEVICE *dev);
 170 void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
 171 bool     unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
 172 bool     unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
 173
 174 /* From match_bsr.c */
 175 int      match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
 176               SESSION_LABEL *sesrec);
 177 int      match_bsr_block(BSR *bsr, DEV_BLOCK *block);
 178 void     position_bsr_block(BSR *bsr, DEV_BLOCK *block);
 179 BSR     *find_next_bsr(BSR *root_bsr, DEVICE *dev);
 180 bool     match_set_eof(BSR *bsr, DEV_RECORD *rec);
 181
 182 /* From mount.c */
 183 bool     mount_next_write_volume(DCR *dcr, bool release);
 184 bool     mount_next_read_volume(DCR *dcr);
 185 void     mark_volume_in_error(DCR *dcr);
 186
 187 /* From parse_bsr.c */
 188 BSR     *parse_bsr(JCR *jcr, char *lf);
 189 void     dump_bsr(BSR *bsr, bool recurse);
 190 void     free_bsr(BSR *bsr);
 191 VOL_LIST *new_restore_volume();
 192 int      add_restore_volume(JCR *jcr, VOL_LIST *vol);
 193 void     free_restore_volume_list(JCR *jcr);
 194 void     create_restore_volume_list(JCR *jcr);
 195
 196 /* From record.c */
 197 const char *FI_to_ascii(int fi);
 198 const char *stream_to_ascii(int stream, int fi);
 199 bool        write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 200 bool        can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 201 bool        read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
 202 DEV_RECORD *new_record();
 203 void        free_record(DEV_RECORD *rec);
 204 void        empty_record(DEV_RECORD *rec);
 205
 206 /* From read_record.c */
 207 bool read_records(DCR *dcr,
 208        bool record_cb(DCR *dcr, DEV_RECORD *rec),
 209        bool mount_cb(DCR *dcr));
 210
 211 /* From reserve.c */
 212 void    release_volume(DCR *dcr);
 213 VOLRES *new_volume(const char *VolumeName, DEVICE *dev);
 214 VOLRES *find_volume(const char *VolumeName);
 215 bool    free_volume(DEVICE *dev);
 216 void    create_volume_list();
 217 void    free_volume_list();
 218 void    list_volumes(BSOCK *user);
 219 bool    is_volume_in_use(const char *VolumeName);
 220
 221
 222 /* From spool.c */
 223 bool    begin_data_spool          (DCR *dcr);
 224 bool    discard_data_spool        (DCR *dcr);
 225 bool    commit_data_spool         (DCR *dcr);
 226 bool    are_attributes_spooled    (JCR *jcr);
 227 bool    begin_attribute_spool     (JCR *jcr);
 228 bool    discard_attribute_spool   (JCR *jcr);
 229 bool    commit_attribute_spool    (JCR *jcr);
 230 bool    write_block_to_spool_file (DCR *dcr);
 231 void    list_spool_stats          (BSOCK *bs);
 232
 233 /* From wait.c */
 234 int wait_for_sysop(DCR *dcr);
 235 bool wait_for_device(JCR *jcr, bool first);