git.sur5r.net Git - bacula/bacula/blob - 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 enum get_vol_info_rw {
  37    GET_VOL_INFO_FOR_WRITE,
  38    GET_VOL_INFO_FOR_READ
  39 };
  40 int     dir_get_volume_info(JCR *jcr, enum get_vol_info_rw);
  41 int     dir_find_next_appendable_volume(JCR *jcr);
  42 int     dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int label);
  43 int     dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev);
  44 int     dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev);
  45 int     dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec);
  46 int     dir_send_job_status(JCR *jcr);
  47 int     dir_create_jobmedia_record(JCR *jcr);
  48
  49 /* authenticate.c */
  50 int     authenticate_director(JCR *jcr);
  51 int     authenticate_filed(JCR *jcr);
  52
  53 /* From block.c */
  54 void    dump_block(DEV_BLOCK *b, char *msg);
  55 DEV_BLOCK *new_block(DEVICE *dev);
  56 void    init_block_write(DEV_BLOCK *block);
  57 void    empty_block(DEV_BLOCK *block);
  58 void    free_block(DEV_BLOCK *block);
  59 int     write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
  60 int     write_block_to_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
  61 void    print_block_errors(JCR *jcr, DEV_BLOCK *block);
  62
  63 #define CHECK_BLOCK_NUMBERS    true
  64 #define NO_BLOCK_NUMBER_CHECK  false
  65 int     read_block_from_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers);
  66 int     read_block_from_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers);
  67
  68 /* From butil.c -- utilities for SD tool programs */
  69 void    print_ls_output(char *fname, char *link, int type, struct stat *statp);
  70 JCR    *setup_jcr(char *name, char *device, BSR *bsr, char *VolumeName);
  71 DEVICE *setup_to_access_device(JCR *jcr, int read_access);
  72 void    display_tape_error_status(JCR *jcr, DEVICE *dev);
  73 DEVRES *find_device_res(char *device_name, int read_access);
  74
  75
  76 /* From dev.c */
  77 DEVICE  *init_dev(DEVICE *dev, DEVRES *device);
  78 int      open_dev(DEVICE *dev, char *VolName, int mode);
  79 void     close_dev(DEVICE *dev);
  80 void     force_close_dev(DEVICE *dev);
  81 int      truncate_dev(DEVICE *dev);
  82 void     term_dev(DEVICE *dev);
  83 char *   strerror_dev(DEVICE *dev);
  84 void     clrerror_dev(DEVICE *dev, int func);
  85 int      update_pos_dev(DEVICE *dev);
  86 int      rewind_dev(DEVICE *dev);
  87 int      load_dev(DEVICE *dev);
  88 int      offline_dev(DEVICE *dev);
  89 int      flush_dev(DEVICE *dev);
  90 int      weof_dev(DEVICE *dev, int num);
  91 int      write_block(DEVICE *dev);
  92 int      write_dev(DEVICE *dev, char *buf, size_t len);
  93 int      read_dev(DEVICE *dev, char *buf, size_t len);
  94 int      status_dev(DEVICE *dev, uint32_t *status);
  95 int      eod_dev(DEVICE *dev);
  96 int      fsf_dev(DEVICE *dev, int num);
  97 int      fsr_dev(DEVICE *dev, int num);
  98 int      bsf_dev(DEVICE *dev, int num);
  99 int      bsr_dev(DEVICE *dev, int num);
 100 void     attach_jcr_to_device(DEVICE *dev, JCR *jcr);
 101 void     detach_jcr_from_device(DEVICE *dev, JCR *jcr);
 102 JCR     *next_attached_jcr(DEVICE *dev, JCR *jcr);
 103 int      dev_can_write(DEVICE *dev);
 104 int      offline_or_rewind_dev(DEVICE *dev);
 105 int      reposition_dev(DEVICE *dev, uint32_t file, uint32_t block);
 106
 107
 108 /* Get info about device */
 109 char *   dev_name(DEVICE *dev);
 110 char *   dev_vol_name(DEVICE *dev);
 111 uint32_t dev_block(DEVICE *dev);
 112 uint32_t dev_file(DEVICE *dev);
 113 int      dev_is_tape(DEVICE *dev);
 114
 115 /* From device.c */
 116 int      open_device(DEVICE *dev);
 117 int      fixup_device_block_write_error(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
 118 void _lock_device(char *file, int line, DEVICE *dev);
 119 void _unlock_device(char *file, int line, DEVICE *dev);
 120 void _block_device(char *file, int line, DEVICE *dev, int state);
 121 void _unblock_device(char *file, int line, DEVICE *dev);
 122 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state);
 123 void _give_back_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold);
 124 void set_new_volume_parameters(JCR *jcr, DEVICE *dev);
 125 void set_new_file_parameters(JCR *jcr, DEVICE *dev);
 126 int  device_is_unmounted(DEVICE *dev);
 127
 128 /* From dircmd.c */
 129 void     *connection_request(void *arg);
 130
 131
 132 /* From fd_cmds.c */
 133 void     run_job(JCR *jcr);
 134
 135 /* From job.c */
 136 void     stored_free_jcr(JCR *jcr);
 137 void     connection_from_filed(void *arg);
 138 void     handle_filed_connection(BSOCK *fd, char *job_name);
 139
 140 /* From label.c */
 141 int      read_dev_volume_label(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
 142 void     create_session_label(JCR *jcr, DEV_RECORD *rec, int label);
 143 void     create_volume_label(DEVICE *dev, char *VolName, char *PoolName);
 144 int      write_volume_label_to_dev(JCR *jcr, DEVRES *device, char *VolName, char *PoolName);
 145 int      write_session_label(JCR *jcr, DEV_BLOCK *block, int label);
 146 int      write_volume_label_to_block(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
 147 void     dump_volume_label(DEVICE *dev);
 148 void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
 149 int      unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
 150 int      unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
 151
 152 /* From match_bsr.c */
 153 int match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
 154               SESSION_LABEL *sesrec);
 155 int match_bsr_block(BSR *bsr, DEV_BLOCK *block);
 156 void position_bsr_block(BSR *bsr, DEV_BLOCK *block);
 157 BSR *find_next_bsr(BSR *root_bsr, DEVICE *dev);
 158
 159 /* From mount.c */
 160 int      mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release);
 161 int      mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block);
 162 void     release_volume(JCR *jcr, DEVICE *dev);
 163
 164 /* From autochanger.c */
 165 int      autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir);
 166 int      autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir);
 167 void     invalidate_slot_in_catalog(JCR *jcr);
 168
 169
 170 /* From parse_bsr.c */
 171 extern BSR *parse_bsr(JCR *jcr, char *lf);
 172 void dump_bsr(BSR *bsr, bool recurse);
 173 extern void free_bsr(BSR *bsr);
 174 extern VOL_LIST *new_vol();
 175 extern int add_vol(JCR *jcr, VOL_LIST *vol);
 176 extern void free_vol_list(JCR *jcr);
 177 extern void create_vol_list(JCR *jcr);
 178
 179 /* From record.c */
 180 char   *FI_to_ascii(int fi);
 181 char   *stream_to_ascii(int stream, int fi);
 182 int     write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 183 int     can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
 184 int     read_record_from_block(DEV_BLOCK *block, DEV_RECORD *rec);
 185 DEV_RECORD *new_record();
 186 void    free_record(DEV_RECORD *rec);
 187
 188 /* From read_record.c */
 189 int read_records(JCR *jcr,  DEVICE *dev,
 190        int record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec),
 191        int mount_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block));