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