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