]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/stored/protos.h
Big backport from Enterprise
[bacula/bacula] / bacula / src / stored / protos.h
index f9e98a243cd66f07e32d1988a18e1c4e5c0d3206..cb9ab55d3a739a2ad0458a3f6a84cc055e81f8f6 100644 (file)
@@ -1,34 +1,25 @@
 /*
-   Bacula® - The Network Backup Solution
-
-   Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
-
-   The main author of Bacula is Kern Sibbald, with contributions from
-   many others, a complete list can be found in the file AUTHORS.
-   This program is Free Software; you can redistribute it and/or
-   modify it under the terms of version two of the GNU General Public
-   License as published by the Free Software Foundation and included
-   in the file LICENSE.
-
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-   General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA.
-
-   Bacula® is a registered trademark of John Walker.
-   The licensor of Bacula is the Free Software Foundation Europe
-   (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
-   Switzerland, email:ftf@fsfeurope.org.
+   Bacula(R) - The Network Backup Solution
+
+   Copyright (C) 2000-2017 Kern Sibbald
+
+   The original author of Bacula is Kern Sibbald, with contributions
+   from many others, a complete list can be found in the file AUTHORS.
+
+   You may use this file and others of this release according to the
+   license defined in the LICENSE file, which includes the Affero General
+   Public License, v3.0 ("AGPLv3") and some additional permissions and
+   terms pursuant to its AGPLv3 Section 7.
+
+   This notice must be preserved when any source code is
+   conveyed and/or propagated.
+
+   Bacula(R) is a registered trademark of Kern Sibbald.
 */
 /*
- * Protypes for stored -- Kern Sibbald MM  
+ * Protypes for stored
  *
- *   Version $Id$
+ *   Written by Kern Sibbald, MM
  */
 
 /* From stored.c */
@@ -38,64 +29,107 @@ uint32_t new_VolSessionId();
 DCR     *acquire_device_for_append(DCR *dcr);
 bool     acquire_device_for_read(DCR *dcr);
 bool     release_device(DCR *dcr);
-DCR     *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev);
+bool     clean_device(DCR *dcr);
+DCR     *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev, bool writing=true);
 void     free_dcr(DCR *dcr);
-void     detach_dcr_from_dev(DCR *dcr);
+
+/* From append.c */
+bool send_attrs_to_dir(JCR *jcr, DEV_RECORD *rec);
 
 /* From askdir.c */
 enum get_vol_info_rw {
    GET_VOL_INFO_FOR_WRITE,
    GET_VOL_INFO_FOR_READ
 };
-bool    dir_get_volume_info(DCR *dcr, enum get_vol_info_rw);
+bool    dir_get_volume_info(DCR *dcr, const char *VolumeName, enum get_vol_info_rw);
 bool    dir_find_next_appendable_volume(DCR *dcr);
-bool    dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten);
+bool    dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten,
+           bool use_dcr=false);
 bool    dir_ask_sysop_to_create_appendable_volume(DCR *dcr);
-bool    dir_ask_sysop_to_mount_volume(DCR *dcr);
+bool    dir_ask_sysop_to_mount_volume(DCR *dcr, bool read_access);
 bool    dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec);
 bool    dir_send_job_status(JCR *jcr);
-bool    dir_create_jobmedia_record(DCR *dcr);
+bool    dir_create_jobmedia_record(DCR *dcr, bool zero=false);
+void    create_jobmedia_queue(JCR *jcr);
+bool    flush_jobmedia_queue(JCR *jcr);
 bool    dir_update_device(JCR *jcr, DEVICE *dev);
 bool    dir_update_changer(JCR *jcr, AUTOCHANGER *changer);
 
+/* class AskDirHandler allows btool's utilities to overwrite the functions above
+ * and even to overwrite the functions in their own sub-class like in btape
+ */
+class AskDirHandler
+{
+   /* this class should be an abstract class */
+public:
+   AskDirHandler() {}
+   virtual ~AskDirHandler() {}
+   virtual bool dir_find_next_appendable_volume(DCR *dcr) { return 1;}
+   virtual bool dir_update_volume_info(DCR *dcr, bool relabel, bool update_LastWritten, bool use_dcr) { return 1; }
+   virtual bool dir_create_jobmedia_record(DCR *dcr, bool zero) { return 1; }
+   virtual bool flush_jobmedia_queue(JCR *jcr) { return true; }
+   virtual bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr) { return 1; }
+   virtual bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec) { return 1;}
+   virtual bool dir_send_job_status(JCR *jcr) {return 1;}
+   virtual bool dir_ask_sysop_to_mount_volume(DCR *dcr, bool writing);
+   virtual bool dir_get_volume_info(DCR *dcr, const char *VolumeName, enum get_vol_info_rw writing);
+};
+
+class BtoolsAskDirHandler: public AskDirHandler
+{
+   /* if AskDirHandler was an abstract class, implement the method here */
+public:
+   BtoolsAskDirHandler() {}
+   virtual ~BtoolsAskDirHandler() {}
+};
+
+/* activate the functions provided by the btool's handler */
+AskDirHandler *init_askdir_handler(AskDirHandler *new_askdir_handler);
+
 /* authenticate.c */
-int     authenticate_director(JCR *jcr);
-int     authenticate_filed(JCR *jcr);
+bool    authenticate_director(JCR *jcr);
+int     authenticate_filed(JCR *jcr, BSOCK *fd, int FDVersion);
+bool    authenticate_storagedaemon(JCR *jcr);
 
 /* From autochanger.c */
 bool     init_autochangers();
-int      autoload_device(DCR *dcr, int writing, BSOCK *dir);
+int      autoload_device(DCR *dcr, bool writing, BSOCK *dir);
 bool     autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd);
 bool     unload_autochanger(DCR *dcr, int loaded);
+bool     unload_dev(DCR *dcr, DEVICE *dev);
 char    *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd);
 int      get_autochanger_loaded_slot(DCR *dcr);
 
 /* From block.c */
-void    dump_block(DEV_BLOCK *b, const char *msg);
-DEV_BLOCK *new_block(DEVICE *dev);
+void    dump_block(DEVICE *dev, DEV_BLOCK *b, const char *msg, bool force=false);
 DEV_BLOCK *dup_block(DEV_BLOCK *eblock);
 void    init_block_write(DEV_BLOCK *block);
 void    empty_block(DEV_BLOCK *block);
 void    free_block(DEV_BLOCK *block);
-bool    write_block_to_device(DCR *dcr);
-bool    write_block_to_dev(DCR *dcr);
 void    print_block_read_errors(JCR *jcr, DEV_BLOCK *block);
 void    ser_block_header(DEV_BLOCK *block);
+bool    is_block_empty(DEV_BLOCK *block);
+bool    terminate_writing_volume(DCR *dcr);
+
+/* From block_util.c */
+bool    terminate_writing_volume(DCR *dcr);
+bool    is_user_volume_size_reached(DCR *dcr, bool quiet);
+bool    check_for_newvol_or_newfile(DCR *dcr);
+bool    do_new_file_bookkeeping(DCR *dcr);
+void    reread_last_block(DCR *dcr);
 
-#define CHECK_BLOCK_NUMBERS    true
-#define NO_BLOCK_NUMBER_CHECK  false
-bool    read_block_from_device(DCR *dcr, bool check_block_numbers);
-bool    read_block_from_dev(DCR *dcr, bool check_block_numbers);
 
 /* From butil.c -- utilities for SD tool programs */
+void    setup_me();
 void    print_ls_output(const char *fname, const char *link, int type, struct stat *statp);
 JCR    *setup_jcr(const char *name, char *dev_name, BSR *bsr,
-                  const char *VolumeName, int mode);
+                  const char *VolumeName, bool writing, bool read_dedup_data=true);
 void    display_tape_error_status(JCR *jcr, DEVICE *dev);
 
 
 /* From dev.c */
-DEVICE  *init_dev(JCR *jcr, DEVRES *device);
+void     sd_list_loaded_drivers(alist *list);
+DEVICE  *init_dev(JCR *jcr, DEVRES *device, bool adata=false);
 bool     can_open_mounted_dev(DEVICE *dev);
 bool     load_dev(DEVICE *dev);
 int      write_block(DEVICE *dev);
@@ -107,60 +141,46 @@ void     init_device_wait_timers(DCR *dcr);
 void     init_jcr_device_wait_timers(JCR *jcr);
 bool     double_dev_wait_time(DEVICE *dev);
 
-/* Get info about device */
-char *   dev_vol_name(DEVICE *dev);
-
-/* From dvd.c */
-int     dvd_open_next_part(DCR *dcr);
-bool    dvd_write_part(DCR *dcr); 
-bool    dvd_close_job(DCR *dcr);
-void    make_mounted_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
-void    make_spooled_dvd_filename(DEVICE *dev, POOL_MEM &archive_name);
-bool    truncate_dvd(DCR *dcr);
-bool    check_can_write_on_non_blank_dvd(DCR *dcr);
-int     find_num_dvd_parts(DCR *dcr);
-boffset_t   lseek_dvd(DCR *dcr, boffset_t offset, int whence);
-void    dvd_remove_empty_part(DCR *dcr);
-
 /* From device.c */
-bool     open_device(DCR *dcr);
 bool     first_open_device(DCR *dcr);
-bool     fixup_device_block_write_error(DCR *dcr);
+bool     fixup_device_block_write_error(DCR *dcr, int retries=4);
+void     set_start_vol_position(DCR *dcr);
 void     set_new_volume_parameters(DCR *dcr);
 void     set_new_file_parameters(DCR *dcr);
-bool     is_device_unmounted(DEVICE *dev);
 
 /* From dircmd.c */
 void     *handle_connection_request(void *arg);
-
+extern   int use_new_match_all; /* Temp variable, to be removed when the new code is tested */
 
 /* From fd_cmds.c */
 void     run_job(JCR *jcr);
-bool     get_bootstrap_file(JCR *jcr, BSOCK *bsock);
 void     do_fd_commands(JCR *jcr);
+bool     do_handle_command(JCR *jcr);
+void     do_client_commands(JCR *jcr);
 
 /* From job.c */
 void     stored_free_jcr(JCR *jcr);
-void     connection_from_filed(void *arg);
-void     handle_filed_connection(BSOCK *fd, char *job_name);
+
+/* From hello.c */
+bool     validate_dir_hello(JCR* jcr);
+bool     send_hello_ok(BSOCK *bs);
+bool     send_sorry(BSOCK *bs);
+bool     send_hello_sd(JCR *jcr, char *Job);
+bool     send_hello_client(JCR *jcr, char *Job);
+bool     read_client_hello(JCR *jcr);
+bool     is_client_connection(BSOCK *bs);
+void     handle_client_connection(BSOCK *fd);
 
 /* From label.c */
-int      read_dev_volume_label(DCR *dcr);
-int      read_dvd_volume_label(DCR *dcr, bool write);
 void     create_session_label(DCR *dcr, DEV_RECORD *rec, int label);
-void     create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName, bool dvdnow);
-bool     write_new_volume_label_to_dev(DCR *dcr, const char *VolName, 
-           const char *PoolName, bool relabel, bool dvdnow);
+void     create_volume_header(DEVICE *dev, const char *VolName, const char *PoolName, bool no_prelabel);
 #define ANSI_VOL_LABEL 0
 #define ANSI_EOF_LABEL 1
 #define ANSI_EOV_LABEL 2
 bool     write_ansi_ibm_labels(DCR *dcr, int type, const char *VolName);
 int      read_ansi_ibm_label(DCR *dcr);
 bool     write_session_label(DCR *dcr, int label);
-bool     write_volume_label_to_block(DCR *dcr);
-bool     rewrite_volume_label(DCR *dcr, bool recycle);
-void     dump_volume_label(DEVICE *dev);
-void     dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose);
+int      dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose, bool check_err);
 bool     unser_volume_label(DEVICE *dev, DEV_RECORD *rec);
 bool     unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec);
 
@@ -175,35 +195,40 @@ void     _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_
 
 /* From match_bsr.c */
 int      match_bsr(BSR *bsr, DEV_RECORD *rec, VOLUME_LABEL *volrec,
-              SESSION_LABEL *sesrec);
+              SESSION_LABEL *sesrec, JCR *jcr);
 int      match_bsr_block(BSR *bsr, DEV_BLOCK *block);
 void     position_bsr_block(BSR *bsr, DEV_BLOCK *block);
 BSR     *find_next_bsr(BSR *root_bsr, DEVICE *dev);
-bool     is_this_bsr_done(BSR *bsr, DEV_RECORD *rec);
+bool     is_this_bsr_done(JCR *jcr, BSR *bsr, DEV_RECORD *rec);
+uint64_t get_bsr_start_addr(BSR *bsr);
 
 /* From mount.c */
-bool     mount_next_write_volume(DCR *dcr, bool have_vol, bool release);
 bool     mount_next_read_volume(DCR *dcr);
-void     mark_volume_in_error(DCR *dcr);
 
 /* From parse_bsr.c */
+BSR *new_bsr();
 BSR     *parse_bsr(JCR *jcr, char *lf);
-void     dump_bsr(BSR *bsr, bool recurse);
+void     dump_bsr(DEVICE *dev, BSR *bsr, bool recurse);
 void     free_bsr(BSR *bsr);
-VOL_LIST *new_restore_volume();
-int      add_restore_volume(JCR *jcr, VOL_LIST *vol);
 void     free_restore_volume_list(JCR *jcr);
-void     create_restore_volume_list(JCR *jcr);
+void     create_restore_volume_list(JCR *jcr, bool add_to_read_list);
 
 /* From record.c */
 const char *FI_to_ascii(char *buf, int fi);
 const char *stream_to_ascii(char *buf, int stream, int fi);
-bool        write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
+const char *stream_to_ascii_ex(char *buf, int stream, int fi);
+bool        write_record_to_block(DCR *dcr, DEV_RECORD *rec);
 bool        can_write_record_to_block(DEV_BLOCK *block, DEV_RECORD *rec);
-bool        read_record_from_block(DCR *dcr, DEV_BLOCK *block, DEV_RECORD *rec);
+bool        read_record_from_block(DCR *dcr, DEV_RECORD *rec);
 DEV_RECORD *new_record();
 void        free_record(DEV_RECORD *rec);
 void        empty_record(DEV_RECORD *rec);
+uint64_t    get_record_address(DEV_RECORD *rec);
+uint64_t    get_record_start_address(DEV_RECORD *rec);
+bool        flush_adata_to_device(DCR *dcr);
+
+/* From record_util.c */
+void dump_record(DEV_RECORD *rec);
 
 /* From read_record.c */
 bool read_records(DCR *dcr,
@@ -213,68 +238,34 @@ bool read_records(DCR *dcr,
 /* From reserve.c */
 void    init_reservations_lock();
 void    term_reservations_lock();
-void    _lock_reservations();
-void    _unlock_reservations();
-void    _lock_volumes();
-void    _unlock_volumes();
-void    release_volume(DCR *dcr);
-VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
-VOLRES *find_volume(const char *VolumeName);
-bool    free_volume(DEVICE *dev);
-void    unreserve_device(DCR *dcr);
-bool    volume_unused(DCR *dcr);
-void    create_volume_list();
-void    free_volume_list();
-void    list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
-bool    is_volume_in_use(DCR *dcr);
 void    send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg);
 bool    find_suitable_device_for_job(JCR *jcr, RCTX &rctx);
 int     search_res_for_device(RCTX &rctx);
 void    release_reserve_messages(JCR *jcr);
 
 extern int reservations_lock_count;
-extern int vol_list_lock_count;
-
-#ifdef  SD_DEBUG_LOCK
-
-#define lock_reservations() \
-         do { Dmsg4(sd_dbglvl, "lock_reservations at %s:%d precnt=%d JobId=%u\n", \
-              __FILE__, __LINE__, \
-              reservations_lock_count, get_jobid_from_tid(pthread_self())); \
-              _lock_reservations(); \
-              Dmsg1(sd_dbglvl, "lock_reservations: got lock JobId=%u\n", \
-               get_jobid_from_tid(pthread_self())); \
-         } while (0)
-#define unlock_reservations() \
-         do { Dmsg4(sd_dbglvl, "unlock_reservations at %s:%d precnt=%d JobId=%u\n", \
-              __FILE__, __LINE__, \
-              reservations_lock_count, get_jobid_from_tid(pthread_self())); \
-                   _unlock_reservations(); } while (0)
-
-#define lock_volumes() \
-         do { Dmsg4(sd_dbglvl, "lock_volumes at %s:%d precnt=%d JobId=%u\n", \
-              __FILE__, __LINE__, \
-              vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
-              _lock_volumes(); \
-              Dmsg1(sd_dbglvl, "lock_volumes: got lock JobId=%u\n", \
-               get_jobid_from_tid(pthread_self())); \
-         } while (0)
-
-#define unlock_volumes() \
-         do { Dmsg4(sd_dbglvl, "unlock_volumes at %s:%d precnt=%d JobId=%u\n", \
-              __FILE__, __LINE__, \
-              vol_list_lock_count, get_jobid_from_tid(pthread_self())); \
-                   _unlock_volumes(); } while (0)
-
-#else
-
-#define lock_reservations() _lock_reservations()
-#define unlock_reservations() _unlock_reservations()
-#define lock_volumes() _lock_volumes()
-#define unlock_volumes() _unlock_volumes()
-
-#endif
 
+/* From status.c */
+void    _dbg_list_one_device(DEVICE *dev, const char *f, int l);
+#define dbg_list_one_device(x, dev) if (chk_dbglvl(x))     \
+        _dbg_list_one_device(dev, __FILE__, __LINE__)
+
+/* From vol_mgr.c */
+void    init_vol_list_lock();
+void    term_vol_list_lock();
+VOLRES *reserve_volume(DCR *dcr, const char *VolumeName);
+bool    free_volume(DEVICE *dev);
+bool    is_vol_list_empty();
+dlist  *dup_vol_list(JCR *jcr);
+void    free_temp_vol_list(dlist *temp_vol_list);
+bool    volume_unused(DCR *dcr);
+void    create_volume_lists();
+void    free_volume_lists();
+void    list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg);
+bool    is_volume_in_use(DCR *dcr);
+extern  int vol_list_lock_count;
+void    add_read_volume(JCR *jcr, const char *VolumeName);
+void    remove_read_volume(JCR *jcr, const char *VolumeName);
 
 
 /* From spool.c */
@@ -288,6 +279,21 @@ bool    commit_attribute_spool    (JCR *jcr);
 bool    write_block_to_spool_file (DCR *dcr);
 void    list_spool_stats          (void sendit(const char *msg, int len, void *sarg), void *arg);
 
+/* From tape_alert.c */
+extern void alert_callback(void *ctx, const char *short_msg,
+   const char *long_msg, char *Volume,
+   int severity, int flags, int alertno, utime_t alert_time);
+
 /* From wait.c */
 int wait_for_sysop(DCR *dcr);
-bool wait_for_device(JCR *jcr, int &retries);
+bool wait_for_any_device(JCR *jcr, int &retries);
+bool wait_for_device(DCR *dcr, int &retries);
+
+/* stored_conf.c */
+void store_protocol(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_uri_style(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_truncate(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_upload(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_devtype(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_cloud_driver(LEX *lc, RES_ITEM *item, int index, int pass);
+void store_maxblocksize(LEX *lc, RES_ITEM *item, int index, int pass);