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