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

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