git.sur5r.net Git - bacula/bacula/blob - bacula/src/jcr.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2008 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 Kern Sibbald.
  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  * Bacula JCR Structure definition for Daemons and the Library
  30  *  This definition consists of a "Global" definition common
  31  *  to all daemons and used by the library routines, and a
  32  *  daemon specific part that is enabled with #defines.
  33  *
  34  * Kern Sibbald, Nov MM
  35  *
  36  *   Version $Id$
  37  */
  38
  39
  40 #ifndef __JCR_H_
  41 #define __JCR_H_ 1
  42
  43 /* Backup/Verify level code. These are stored in the DB */
  44 #define L_FULL                   'F'  /* Full backup */
  45 #define L_INCREMENTAL            'I'  /* since last backup */
  46 #define L_DIFFERENTIAL           'D'  /* since last full backup */
  47 #define L_SINCE                  'S'
  48 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
  49 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
  50 #define L_VERIFY_VOLUME_TO_CATALOG 'O'  /* verify Volume to catalog entries */
  51 #define L_VERIFY_DISK_TO_CATALOG 'd'  /* verify Disk attributes to catalog */
  52 #define L_VERIFY_DATA            'A'  /* verify data on volume */
  53 #define L_BASE                   'B'  /* Base level job */
  54 #define L_NONE                   ' '  /* None, for Restore and Admin */
  55 #define L_VIRTUAL_FULL           'f'  /* Virtual full backup */
  56
  57
  58 /* Job Types. These are stored in the DB */
  59 #define JT_BACKUP                'B'  /* Backup Job */
  60 #define JT_MIGRATED_JOB          'M'  /* A previous backup job that was migrated */
  61 #define JT_VERIFY                'V'  /* Verify Job */
  62 #define JT_RESTORE               'R'  /* Restore Job */
  63 #define JT_CONSOLE               'c'  /* console program */
  64 #define JT_SYSTEM                'I'  /* internal system "job" */
  65 #define JT_ADMIN                 'D'  /* admin job */
  66 #define JT_ARCHIVE               'A'  /* Archive Job */
  67 #define JT_COPY                  'C'  /* Copy Job */
  68 #define JT_MIGRATE               'g'  /* Migration Job */
  69 #define JT_SCAN                  'S'  /* Scan Job */
  70
  71 /* Job Status. Some of these are stored in the DB */
  72 #define JS_Created               'C'  /* created but not yet running */
  73 #define JS_Running               'R'  /* running */
  74 #define JS_Blocked               'B'  /* blocked */
  75 #define JS_Terminated            'T'  /* terminated normally */
  76 #define JS_ErrorTerminated       'E'  /* Job terminated in error */
  77 #define JS_Error                 'e'  /* Non-fatal error */
  78 #define JS_FatalError            'f'  /* Fatal error */
  79 #define JS_Differences           'D'  /* Verify differences */
  80 #define JS_Canceled              'A'  /* canceled by user */
  81 #define JS_WaitFD                'F'  /* waiting on File daemon */
  82 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
  83 #define JS_WaitMedia             'm'  /* waiting for new media */
  84 #define JS_WaitMount             'M'  /* waiting for Mount */
  85 #define JS_WaitStoreRes          's'  /* Waiting for storage resource */
  86 #define JS_WaitJobRes            'j'  /* Waiting for job resource */
  87 #define JS_WaitClientRes         'c'  /* Waiting for Client resource */
  88 #define JS_WaitMaxJobs           'd'  /* Waiting for maximum jobs */
  89 #define JS_WaitStartTime         't'  /* Waiting for start time */
  90 #define JS_WaitPriority          'p'  /* Waiting for higher priority jobs to finish */
  91 #define JS_AttrDespooling        'a'  /* SD despooling attributes */
  92 #define JS_AttrInserting         'i'  /* Doing batch insert file records */
  93 #define JS_DataDespooling        'l'  /* Doing data despooling */
  94 #define JS_DataCommitting        'L'  /* Committing data (last despool) */
  95
  96 /* Migration selection types */
  97 enum {
  98    MT_SMALLEST_VOL = 1,
  99    MT_OLDEST_VOL,
 100    MT_POOL_OCCUPANCY,
 101    MT_POOL_TIME,
 102    MT_CLIENT,
 103    MT_VOLUME,
 104    MT_JOB,
 105    MT_SQLQUERY
 106 };
 107
 108 #define job_canceled(jcr) \
 109   (jcr->JobStatus == JS_Canceled || \
 110    jcr->JobStatus == JS_ErrorTerminated || \
 111    jcr->JobStatus == JS_FatalError)
 112
 113 #define job_waiting(jcr) \
 114   (jcr->JobStatus == JS_WaitFD       || \
 115    jcr->JobStatus == JS_WaitSD       || \
 116    jcr->JobStatus == JS_WaitMedia    || \
 117    jcr->JobStatus == JS_WaitMount    || \
 118    jcr->JobStatus == JS_WaitStoreRes || \
 119    jcr->JobStatus == JS_WaitJobRes   || \
 120    jcr->JobStatus == JS_WaitClientRes|| \
 121    jcr->JobStatus == JS_WaitMaxJobs  || \
 122    jcr->JobStatus == JS_WaitPriority || \
 123    jcr->SDJobStatus == JS_WaitMedia  || \
 124    jcr->SDJobStatus == JS_WaitMount  || \
 125    jcr->SDJobStatus == JS_WaitMaxJobs)
 126
 127
 128
 129 #define foreach_jcr(jcr) \
 130    for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
 131
 132 #define endeach_jcr(jcr) jcr_walk_end(jcr)
 133
 134 #define SD_APPEND 1
 135 #define SD_READ   0
 136
 137 /* Forward referenced structures */
 138 class JCR;
 139 struct FF_PKT;
 140 struct B_DB;
 141 struct ATTR_DBR;
 142 struct Plugin;
 143 struct save_pkt;
 144
 145 #ifdef FILE_DAEMON
 146 class htable;
 147
 148 struct CRYPTO_CTX {
 149    bool pki_sign;                     /* Enable PKI Signatures? */
 150    bool pki_encrypt;                  /* Enable PKI Encryption? */
 151    DIGEST *digest;                    /* Last file's digest context */
 152    X509_KEYPAIR *pki_keypair;         /* Encryption key pair */
 153    alist *pki_signers;                /* Trusted Signers */
 154    alist *pki_recipients;             /* Trusted Recipients */
 155    CRYPTO_SESSION *pki_session;       /* PKE Public Keys + Symmetric Session Keys */
 156    POOLMEM *pki_session_encoded;      /* Cached DER-encoded copy of pki_session */
 157    int32_t pki_session_encoded_size;  /* Size of DER-encoded pki_session */
 158    POOLMEM *crypto_buf;               /* Encryption/Decryption buffer */
 159 };
 160 #endif
 161
 162 typedef void (JCR_free_HANDLER)(JCR *jcr);
 163
 164 /* Job Control Record (JCR) */
 165 class JCR {
 166 private:
 167    pthread_mutex_t mutex;             /* jcr mutex */
 168    volatile int32_t _use_count;       /* use count */
 169 public:
 170    void lock() {P(mutex); };
 171    void unlock() {V(mutex); };
 172    void inc_use_count(void) {lock(); _use_count++; unlock(); };
 173    void dec_use_count(void) {lock(); _use_count--; unlock(); };
 174    int32_t use_count() { return _use_count; };
 175    void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
 176    void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
 177    bool is_job_canceled() {return job_canceled(this); };
 178
 179    /* Global part of JCR common to all daemons */
 180    dlink link;                        /* JCR chain link */
 181    pthread_t my_thread_id;            /* id of thread controlling jcr */
 182    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
 183    BSOCK *store_bsock;                /* Storage connection socket */
 184    BSOCK *file_bsock;                 /* File daemon connection socket */
 185    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
 186    dlist *msg_queue;                  /* Queued messages */
 187    alist job_end_push;                /* Job end pushed calls */
 188    bool dequeuing;                    /* dequeuing messages */
 189    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
 190    POOLMEM *errmsg;                   /* edited error message */
 191    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
 192    char event[MAX_NAME_LENGTH];       /* Current event */
 193    uint32_t JobId;                    /* Director's JobId */
 194    uint32_t VolSessionId;
 195    uint32_t VolSessionTime;
 196    uint32_t JobFiles;                 /* Number of files written, this job */
 197    uint32_t JobErrors;                /* */
 198    uint64_t JobBytes;                 /* Number of bytes processed this job */
 199    uint64_t ReadBytes;                /* Bytes read -- before compression */
 200    uint32_t Errors;                   /* Number of non-fatal errors */
 201    volatile int32_t JobStatus;        /* ready, running, blocked, terminated */
 202    int32_t JobType;                   /* backup, restore, verify ... */
 203    int32_t JobLevel;                  /* Job level */
 204    int32_t JobPriority;               /* Job priority */
 205    bool    JobReads;                  /* Set if job reads Volumes */
 206    time_t sched_time;                 /* job schedule time, i.e. when it should start */
 207    time_t start_time;                 /* when job actually started */
 208    time_t run_time;                   /* used for computing speed */
 209    time_t end_time;                   /* job end time */
 210    time_t wait_time;                  /* when job have started to wait */
 211    POOLMEM *client_name;              /* client name */
 212    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
 213    POOLMEM *stime;                    /* start time for incremental/differential */
 214    char *sd_auth_key;                 /* SD auth key */
 215    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
 216    uint32_t ClientId;                 /* Client associated with Job */
 217    char *where;                       /* prefix to restore files to */
 218    char *RegexWhere;                  /* file relocation in restore */
 219    alist *where_bregexp;              /* BREGEXP alist for path manipulation */
 220    int32_t cached_pnl;                /* cached path length */
 221    POOLMEM *cached_path;              /* cached path */
 222    bool prefix_links;                 /* Prefix links with Where path */
 223    bool gui;                          /* set if gui using console */
 224    bool authenticated;                /* set when client authenticated */
 225    void *Python_job;                  /* Python Job Object */
 226    void *Python_events;               /* Python Events Object */
 227
 228    bool cached_attribute;             /* set if attribute is cached */
 229    POOLMEM *attr;                     /* Attribute string from SD */
 230    B_DB *db;                          /* database pointer */
 231    B_DB *db_batch;                    /* database pointer for batch insert */
 232    ATTR_DBR *ar;                      /* DB attribute record */
 233    guid_list *id_list;                /* User/group id to name list */
 234    bool accurate;                     /* true if job is accurate */
 235
 236    void *plugin_ctx_list;             /* list of contexts for plugins */
 237    void *plugin_ctx;                  /* current plugin context */
 238    Plugin *plugin;                    /* plugin instance */
 239    save_pkt *plugin_sp;               /* plugin save packet */
 240    char *plugin_options;              /* user set options for plugin */
 241
 242    /* Daemon specific part of JCR */
 243    /* This should be empty in the library */
 244
 245 #ifdef DIRECTOR_DAEMON
 246    /* Director Daemon specific data part of JCR */
 247    pthread_t SD_msg_chan;             /* Message channel thread id */
 248    pthread_cond_t term_wait;          /* Wait for job termination */
 249    workq_ele_t *work_item;            /* Work queue item if scheduled */
 250    volatile bool sd_msg_thread_done;  /* Set when Storage message thread done */
 251    BSOCK *ua;                         /* User agent */
 252    JOB *job;                          /* Job resource */
 253    JOB *verify_job;                   /* Job resource of verify previous job */
 254    alist *rstorage;                   /* Read storage possibilities */
 255    STORE *rstore;                     /* Selected read storage */
 256    alist *wstorage;                   /* Write storage possibilities */
 257    STORE *wstore;                     /* Selected write storage */
 258    CLIENT *client;                    /* Client resource */
 259    POOL *pool;                        /* Pool resource = write for migration */
 260    POOL *rpool;                       /* Read pool. Used only in migration */
 261    POOL *full_pool;                   /* Full backup pool resource */
 262    POOL *inc_pool;                    /* Incremental backup pool resource */
 263    POOL *diff_pool;                   /* Differential backup pool resource */
 264    bool run_pool_override;
 265    bool run_full_pool_override;
 266    bool run_inc_pool_override;
 267    bool run_diff_pool_override;
 268    FILESET *fileset;                  /* FileSet resource */
 269    CAT *catalog;                      /* Catalog resource */
 270    MSGS *messages;                    /* Default message handler */
 271    uint32_t SDJobFiles;               /* Number of files written, this job */
 272    uint64_t SDJobBytes;               /* Number of bytes processed this job */
 273    uint32_t SDErrors;                 /* Number of non-fatal errors */
 274    volatile int32_t SDJobStatus;      /* Storage Job Status */
 275    volatile int32_t FDJobStatus;      /* File daemon Job Status */
 276    uint32_t ExpectedFiles;            /* Expected restore files */
 277    uint32_t MediaId;                  /* DB record IDs associated with this job */
 278    FileId_t FileId;                   /* Last file id inserted */
 279    uint32_t FileIndex;                /* Last FileIndex processed */
 280    POOLMEM *fname;                    /* name to put into catalog */
 281    JOB_DBR jr;                        /* Job DB record for current job */
 282    JOB_DBR previous_jr;               /* previous job database record */
 283    JOB *previous_job;                 /* Job resource of migration previous job */
 284    JCR *mig_jcr;                      /* JCR for migration/copy job */
 285    char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
 286    char since[MAX_TIME_LENGTH];       /* since time */
 287    union {
 288       JobId_t RestoreJobId;           /* Id specified by UA */
 289       JobId_t MigrateJobId;
 290    };
 291    POOLMEM *client_uname;             /* client uname */
 292    POOLMEM *pool_source;              /* Where pool came from */
 293    POOLMEM *rpool_source;             /* Where migrate read pool came from */
 294    POOLMEM *rstore_source;            /* Where read storage came from */
 295    POOLMEM *wstore_source;            /* Where write storage came from */
 296    POOLMEM *catalog_source;           /* Where catalog came from */
 297    uint32_t replace;                  /* Replace option */
 298    int32_t NumVols;                   /* Number of Volume used in pool */
 299    int32_t reschedule_count;          /* Number of times rescheduled */
 300    int32_t FDVersion;                 /* File daemon version number */
 301    int64_t spool_size;                /* Spool size for this job */
 302    bool spool_data;                   /* Spool data in SD */
 303    bool acquired_resource_locks;      /* set if resource locks acquired */
 304    bool term_wait_inited;             /* Set when cond var inited */
 305    bool fn_printed;                   /* printed filename */
 306    bool write_part_after_job;         /* Write part after job in SD */
 307    bool needs_sd;                     /* set if SD needed by Job */
 308    bool cloned;                       /* set if cloned */
 309    bool unlink_bsr;                   /* Unlink bsr file created */
 310    bool VSS;                          /* VSS used by FD */
 311    bool Encrypt;                      /* Encryption used by FD */
 312    bool stats_enabled;                /* Keep all job records in a table for long term statistics */
 313 #endif /* DIRECTOR_DAEMON */
 314
 315
 316 #ifdef FILE_DAEMON
 317    /* File Daemon specific part of JCR */
 318    uint32_t num_files_examined;       /* files examined this job */
 319    POOLMEM *last_fname;               /* last file saved/verified */
 320    POOLMEM *acl_text;                 /* text of ACL for backup */
 321    int32_t last_type;                 /* type of last file saved/verified */
 322    /*********FIXME********* add missing files and files to be retried */
 323    int incremental;                   /* set if incremental for SINCE */
 324    time_t mtime;                      /* begin time for SINCE */
 325    int listing;                       /* job listing in estimate */
 326    long Ticket;                       /* Ticket */
 327    char *big_buf;                     /* I/O buffer */
 328    POOLMEM *compress_buf;             /* Compression buffer */
 329    int32_t compress_buf_size;         /* Length of compression buffer */
 330    void *pZLIB_compress_workset;      /* zlib compression session data */
 331    int32_t replace;                   /* Replace options */
 332    int32_t buf_size;                  /* length of buffer */
 333    FF_PKT *ff;                        /* Find Files packet */
 334    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
 335    uint32_t StartFile;
 336    uint32_t EndFile;
 337    uint32_t StartBlock;
 338    uint32_t EndBlock;
 339    pthread_t heartbeat_id;            /* id of heartbeat thread */
 340    volatile bool hb_started;          /* heartbeat running */
 341    BSOCK *hb_bsock;                   /* duped SD socket */
 342    BSOCK *hb_dir_bsock;               /* duped DIR socket */
 343    alist *RunScripts;                 /* Commands to run before and after job */
 344    CRYPTO_CTX crypto;                 /* Crypto ctx */
 345    DIRRES* director;                  /* Director resource */
 346    bool VSS;                          /* VSS used by FD */
 347 #ifdef USE_TCADB
 348    TCADB *file_list;                  /* Previous file list (accurate mode) */
 349    POOLMEM *hash_name;
 350 #else
 351    htable *file_list;                 /* Previous file list (accurate mode) */
 352 #endif
 353 #endif /* FILE_DAEMON */
 354
 355
 356 #ifdef STORAGE_DAEMON
 357    /* Storage Daemon specific part of JCR */
 358    JCR *next_dev;                     /* next JCR attached to device */
 359    JCR *prev_dev;                     /* previous JCR attached to device */
 360    char *dir_auth_key;                /* Dir auth key */
 361    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
 362    int32_t type;
 363    DCR *read_dcr;                     /* device context for reading */
 364    DCR *dcr;                          /* device context record */
 365    alist *dcrs;                       /* list of dcrs open */
 366    POOLMEM *job_name;                 /* base Job name (not unique) */
 367    POOLMEM *fileset_name;             /* FileSet */
 368    POOLMEM *fileset_md5;              /* MD5 for FileSet */
 369    VOL_LIST *VolList;                 /* list to read */
 370    int32_t NumWriteVolumes;           /* number of volumes written */
 371    int32_t NumReadVolumes;            /* total number of volumes to read */
 372    int32_t CurReadVolume;             /* current read volume number */
 373    int32_t label_errors;              /* count of label errors */
 374    bool session_opened;
 375    long Ticket;                       /* ticket for this job */
 376    bool ignore_label_errors;          /* ignore Volume label errors */
 377    bool spool_attributes;             /* set if spooling attributes */
 378    bool no_attributes;                /* set if no attributes wanted */
 379    int64_t spool_size;                /* Spool size for this job */
 380    bool spool_data;                   /* set to spool data */
 381    int32_t CurVol;                    /* Current Volume count */
 382    DIRRES* director;                  /* Director resource */
 383    alist *write_store;                /* list of write storage devices sent by DIR */
 384    alist *read_store;                 /* list of read devices sent by DIR */
 385    alist *reserve_msgs;               /* reserve fail messages */
 386    bool write_part_after_job;         /* Set to write part after job */
 387    bool PreferMountedVols;            /* Prefer mounted vols rather than new */
 388
 389    uint32_t FileId;                   /* Last file id inserted */
 390
 391    /* Parmaters for Open Read Session */
 392    BSR *bsr;                          /* Bootstrap record -- has everything */
 393    bool mount_next_volume;            /* set to cause next volume mount */
 394    uint32_t read_VolSessionId;
 395    uint32_t read_VolSessionTime;
 396    uint32_t read_StartFile;
 397    uint32_t read_EndFile;
 398    uint32_t read_StartBlock;
 399    uint32_t read_EndBlock;
 400    /* Device wait times */
 401    int32_t min_wait;
 402    int32_t max_wait;
 403    int32_t max_num_wait;
 404    int32_t wait_sec;
 405    int32_t rem_wait_sec;
 406    int32_t num_wait;
 407 #endif /* STORAGE_DAEMON */
 408
 409 };
 410
 411 /*
 412  * Structure for all daemons that keeps some summary
 413  *  info on the last job run.
 414  */
 415 struct s_last_job {
 416    dlink link;
 417    int32_t Errors;                    /* FD/SD errors */
 418    int32_t JobType;
 419    int32_t JobStatus;
 420    int32_t JobLevel;
 421    uint32_t JobId;
 422    uint32_t VolSessionId;
 423    uint32_t VolSessionTime;
 424    uint32_t JobFiles;
 425    uint64_t JobBytes;
 426    time_t start_time;
 427    time_t end_time;
 428    char Job[MAX_NAME_LENGTH];
 429 };
 430
 431 extern struct s_last_job last_job;
 432 extern DLL_IMP_EXP dlist * last_jobs;
 433
 434
 435 /* The following routines are found in lib/jcr.c */
 436 extern bool init_jcr_subsystem(void);
 437 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 438 extern JCR *get_jcr_by_id(uint32_t JobId);
 439 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
 440 extern JCR *get_jcr_by_partial_name(char *Job);
 441 extern JCR *get_jcr_by_full_name(char *Job);
 442 extern JCR *get_next_jcr(JCR *jcr);
 443 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
 444 extern int DLL_IMP_EXP num_jobs_run;
 445
 446 #ifdef DEBUG
 447 extern void b_free_jcr(const char *file, int line, JCR *jcr);
 448 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
 449 #else
 450 extern void free_jcr(JCR *jcr);
 451 #endif
 452
 453 #endif /* __JCR_H_ */