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